1#ifndef CACHE_H 2#define CACHE_H 3 4#include "git-compat-util.h" 5#include "strbuf.h" 6#include "hashmap.h" 7#include "advice.h" 8#include "gettext.h" 9#include "convert.h" 10#include "trace.h" 11#include "string-list.h" 12#include "pack-revindex.h" 13#include "hash.h" 14 15#ifndef platform_SHA_CTX 16/* 17 * platform's underlying implementation of SHA-1; could be OpenSSL, 18 * blk_SHA, Apple CommonCrypto, etc... Note that including 19 * SHA1_HEADER may have already defined platform_SHA_CTX for our 20 * own implementations like block-sha1 and ppc-sha1, so we list 21 * the default for OpenSSL compatible SHA-1 implementations here. 22 */ 23#define platform_SHA_CTX SHA_CTX 24#define platform_SHA1_Init SHA1_Init 25#define platform_SHA1_Update SHA1_Update 26#define platform_SHA1_Final SHA1_Final 27#endif 28 29#define git_SHA_CTX platform_SHA_CTX 30#define git_SHA1_Init platform_SHA1_Init 31#define git_SHA1_Update platform_SHA1_Update 32#define git_SHA1_Final platform_SHA1_Final 33 34#ifdef SHA1_MAX_BLOCK_SIZE 35#include "compat/sha1-chunked.h" 36#undef git_SHA1_Update 37#define git_SHA1_Update git_SHA1_Update_Chunked 38#endif 39 40#include <zlib.h> 41typedef struct git_zstream { 42 z_stream z; 43 unsigned long avail_in; 44 unsigned long avail_out; 45 unsigned long total_in; 46 unsigned long total_out; 47 unsigned char *next_in; 48 unsigned char *next_out; 49} git_zstream; 50 51void git_inflate_init(git_zstream *); 52void git_inflate_init_gzip_only(git_zstream *); 53void git_inflate_end(git_zstream *); 54int git_inflate(git_zstream *, int flush); 55 56void git_deflate_init(git_zstream *, int level); 57void git_deflate_init_gzip(git_zstream *, int level); 58void git_deflate_init_raw(git_zstream *, int level); 59void git_deflate_end(git_zstream *); 60int git_deflate_abort(git_zstream *); 61int git_deflate_end_gently(git_zstream *); 62int git_deflate(git_zstream *, int flush); 63unsigned long git_deflate_bound(git_zstream *, unsigned long); 64 65/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 66#define GIT_SHA1_RAWSZ 20 67#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 68 69/* The length in byte and in hex digits of the largest possible hash value. */ 70#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 71#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 72 73struct object_id { 74 unsigned char hash[GIT_MAX_RAWSZ]; 75}; 76 77#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 78#define DTYPE(de) ((de)->d_type) 79#else 80#undef DT_UNKNOWN 81#undef DT_DIR 82#undef DT_REG 83#undef DT_LNK 84#define DT_UNKNOWN 0 85#define DT_DIR 1 86#define DT_REG 2 87#define DT_LNK 3 88#define DTYPE(de) DT_UNKNOWN 89#endif 90 91/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 92#define S_IFINVALID 0030000 93 94/* 95 * A "directory link" is a link to another git directory. 96 * 97 * The value 0160000 is not normally a valid mode, and 98 * also just happens to be S_IFDIR + S_IFLNK 99 */ 100#define S_IFGITLINK 0160000 101#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 102 103/* 104 * Some mode bits are also used internally for computations. 105 * 106 * They *must* not overlap with any valid modes, and they *must* not be emitted 107 * to outside world - i.e. appear on disk or network. In other words, it's just 108 * temporary fields, which we internally use, but they have to stay in-house. 109 * 110 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 111 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 112 */ 113 114/* used internally in tree-diff */ 115#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 116 117 118/* 119 * Intensive research over the course of many years has shown that 120 * port 9418 is totally unused by anything else. Or 121 * 122 * Your search - "port 9418" - did not match any documents. 123 * 124 * as www.google.com puts it. 125 * 126 * This port has been properly assigned for git use by IANA: 127 * git (Assigned-9418) [I06-050728-0001]. 128 * 129 * git 9418/tcp git pack transfer service 130 * git 9418/udp git pack transfer service 131 * 132 * with Linus Torvalds <torvalds@osdl.org> as the point of 133 * contact. September 2005. 134 * 135 * See http://www.iana.org/assignments/port-numbers 136 */ 137#define DEFAULT_GIT_PORT 9418 138 139/* 140 * Basic data structures for the directory cache 141 */ 142 143#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */ 144struct cache_header { 145 uint32_t hdr_signature; 146 uint32_t hdr_version; 147 uint32_t hdr_entries; 148}; 149 150#define INDEX_FORMAT_LB 2 151#define INDEX_FORMAT_UB 4 152 153/* 154 * The "cache_time" is just the low 32 bits of the 155 * time. It doesn't matter if it overflows - we only 156 * check it for equality in the 32 bits we save. 157 */ 158struct cache_time { 159 uint32_t sec; 160 uint32_t nsec; 161}; 162 163struct stat_data { 164 struct cache_time sd_ctime; 165 struct cache_time sd_mtime; 166 unsigned int sd_dev; 167 unsigned int sd_ino; 168 unsigned int sd_uid; 169 unsigned int sd_gid; 170 unsigned int sd_size; 171}; 172 173struct cache_entry { 174 struct hashmap_entry ent; 175 struct stat_data ce_stat_data; 176 unsigned int ce_mode; 177 unsigned int ce_flags; 178 unsigned int ce_namelen; 179 unsigned int index; /* for link extension */ 180 struct object_id oid; 181 char name[FLEX_ARRAY]; /* more */ 182}; 183 184#define CE_STAGEMASK (0x3000) 185#define CE_EXTENDED (0x4000) 186#define CE_VALID (0x8000) 187#define CE_STAGESHIFT 12 188 189/* 190 * Range 0xFFFF0FFF in ce_flags is divided into 191 * two parts: in-memory flags and on-disk ones. 192 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 193 * if you want to save a new flag, add it in 194 * CE_EXTENDED_FLAGS 195 * 196 * In-memory only flags 197 */ 198#define CE_UPDATE (1 << 16) 199#define CE_REMOVE (1 << 17) 200#define CE_UPTODATE (1 << 18) 201#define CE_ADDED (1 << 19) 202 203#define CE_HASHED (1 << 20) 204#define CE_WT_REMOVE (1 << 22) /* remove in work directory */ 205#define CE_CONFLICTED (1 << 23) 206 207#define CE_UNPACKED (1 << 24) 208#define CE_NEW_SKIP_WORKTREE (1 << 25) 209 210/* used to temporarily mark paths matched by pathspecs */ 211#define CE_MATCHED (1 << 26) 212 213#define CE_UPDATE_IN_BASE (1 << 27) 214#define CE_STRIP_NAME (1 << 28) 215 216/* 217 * Extended on-disk flags 218 */ 219#define CE_INTENT_TO_ADD (1 << 29) 220#define CE_SKIP_WORKTREE (1 << 30) 221/* CE_EXTENDED2 is for future extension */ 222#define CE_EXTENDED2 (1U << 31) 223 224#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 225 226/* 227 * Safeguard to avoid saving wrong flags: 228 * - CE_EXTENDED2 won't get saved until its semantic is known 229 * - Bits in 0x0000FFFF have been saved in ce_flags already 230 * - Bits in 0x003F0000 are currently in-memory flags 231 */ 232#if CE_EXTENDED_FLAGS & 0x803FFFFF 233#error "CE_EXTENDED_FLAGS out of range" 234#endif 235 236/* Forward structure decls */ 237struct pathspec; 238struct child_process; 239 240/* 241 * Copy the sha1 and stat state of a cache entry from one to 242 * another. But we never change the name, or the hash state! 243 */ 244static inline void copy_cache_entry(struct cache_entry *dst, 245 const struct cache_entry *src) 246{ 247 unsigned int state = dst->ce_flags & CE_HASHED; 248 249 /* Don't copy hash chain and name */ 250 memcpy(&dst->ce_stat_data, &src->ce_stat_data, 251 offsetof(struct cache_entry, name) - 252 offsetof(struct cache_entry, ce_stat_data)); 253 254 /* Restore the hash state */ 255 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 256} 257 258static inline unsigned create_ce_flags(unsigned stage) 259{ 260 return (stage << CE_STAGESHIFT); 261} 262 263#define ce_namelen(ce) ((ce)->ce_namelen) 264#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 265#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 266#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 267#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 268#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 269#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 270 271#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 272static inline unsigned int create_ce_mode(unsigned int mode) 273{ 274 if (S_ISLNK(mode)) 275 return S_IFLNK; 276 if (S_ISDIR(mode) || S_ISGITLINK(mode)) 277 return S_IFGITLINK; 278 return S_IFREG | ce_permissions(mode); 279} 280static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce, 281 unsigned int mode) 282{ 283 extern int trust_executable_bit, has_symlinks; 284 if (!has_symlinks && S_ISREG(mode) && 285 ce && S_ISLNK(ce->ce_mode)) 286 return ce->ce_mode; 287 if (!trust_executable_bit && S_ISREG(mode)) { 288 if (ce && S_ISREG(ce->ce_mode)) 289 return ce->ce_mode; 290 return create_ce_mode(0666); 291 } 292 return create_ce_mode(mode); 293} 294static inline int ce_to_dtype(const struct cache_entry *ce) 295{ 296 unsigned ce_mode = ntohl(ce->ce_mode); 297 if (S_ISREG(ce_mode)) 298 return DT_REG; 299 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode)) 300 return DT_DIR; 301 else if (S_ISLNK(ce_mode)) 302 return DT_LNK; 303 else 304 return DT_UNKNOWN; 305} 306static inline unsigned int canon_mode(unsigned int mode) 307{ 308 if (S_ISREG(mode)) 309 return S_IFREG | ce_permissions(mode); 310 if (S_ISLNK(mode)) 311 return S_IFLNK; 312 if (S_ISDIR(mode)) 313 return S_IFDIR; 314 return S_IFGITLINK; 315} 316 317#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 318 319#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */ 320#define CE_ENTRY_CHANGED (1 << 1) 321#define CE_ENTRY_REMOVED (1 << 2) 322#define CE_ENTRY_ADDED (1 << 3) 323#define RESOLVE_UNDO_CHANGED (1 << 4) 324#define CACHE_TREE_CHANGED (1 << 5) 325#define SPLIT_INDEX_ORDERED (1 << 6) 326#define UNTRACKED_CHANGED (1 << 7) 327 328struct split_index; 329struct untracked_cache; 330 331struct index_state { 332 struct cache_entry **cache; 333 unsigned int version; 334 unsigned int cache_nr, cache_alloc, cache_changed; 335 struct string_list *resolve_undo; 336 struct cache_tree *cache_tree; 337 struct split_index *split_index; 338 struct cache_time timestamp; 339 unsigned name_hash_initialized : 1, 340 initialized : 1; 341 struct hashmap name_hash; 342 struct hashmap dir_hash; 343 unsigned char sha1[20]; 344 struct untracked_cache *untracked; 345}; 346 347extern struct index_state the_index; 348 349/* Name hashing */ 350extern void add_name_hash(struct index_state *istate, struct cache_entry *ce); 351extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce); 352extern void free_name_hash(struct index_state *istate); 353 354 355#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 356#define active_cache (the_index.cache) 357#define active_nr (the_index.cache_nr) 358#define active_alloc (the_index.cache_alloc) 359#define active_cache_changed (the_index.cache_changed) 360#define active_cache_tree (the_index.cache_tree) 361 362#define read_cache() read_index(&the_index) 363#define read_cache_from(path) read_index_from(&the_index, (path)) 364#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 365#define is_cache_unborn() is_index_unborn(&the_index) 366#define read_cache_unmerged() read_index_unmerged(&the_index) 367#define discard_cache() discard_index(&the_index) 368#define unmerged_cache() unmerged_index(&the_index) 369#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 370#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 371#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 372#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 373#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 374#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 375#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 376#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 377#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 378#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 379#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 380#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 381#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 382#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 383#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 384#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 385#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 386#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 387#endif 388 389enum object_type { 390 OBJ_BAD = -1, 391 OBJ_NONE = 0, 392 OBJ_COMMIT = 1, 393 OBJ_TREE = 2, 394 OBJ_BLOB = 3, 395 OBJ_TAG = 4, 396 /* 5 for future expansion */ 397 OBJ_OFS_DELTA = 6, 398 OBJ_REF_DELTA = 7, 399 OBJ_ANY, 400 OBJ_MAX 401}; 402 403static inline enum object_type object_type(unsigned int mode) 404{ 405 return S_ISDIR(mode) ? OBJ_TREE : 406 S_ISGITLINK(mode) ? OBJ_COMMIT : 407 OBJ_BLOB; 408} 409 410/* Double-check local_repo_env below if you add to this list. */ 411#define GIT_DIR_ENVIRONMENT "GIT_DIR" 412#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR" 413#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE" 414#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE" 415#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX" 416#define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX" 417#define DEFAULT_GIT_DIR_ENVIRONMENT ".git" 418#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY" 419#define INDEX_ENVIRONMENT "GIT_INDEX_FILE" 420#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE" 421#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE" 422#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" 423#define CONFIG_ENVIRONMENT "GIT_CONFIG" 424#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS" 425#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH" 426#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES" 427#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS" 428#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE" 429#define GITATTRIBUTES_FILE ".gitattributes" 430#define INFOATTRIBUTES_FILE "info/attributes" 431#define ATTRIBUTE_MACRO_PREFIX "[attr]" 432#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF" 433#define GIT_NOTES_DEFAULT_REF "refs/notes/commits" 434#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF" 435#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF" 436#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE" 437#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS" 438#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS" 439#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS" 440#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS" 441#define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH" 442 443/* 444 * This environment variable is expected to contain a boolean indicating 445 * whether we should or should not treat: 446 * 447 * GIT_DIR=foo.git git ... 448 * 449 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 450 * of this, but we use it internally to communicate to sub-processes that we 451 * are in a bare repo. If not set, defaults to true. 452 */ 453#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE" 454 455/* 456 * Repository-local GIT_* environment variables; these will be cleared 457 * when git spawns a sub-process that runs inside another repository. 458 * The array is NULL-terminated, which makes it easy to pass in the "env" 459 * parameter of a run-command invocation, or to do a simple walk. 460 */ 461extern const char * const local_repo_env[]; 462 463/* 464 * Returns true iff we have a configured git repository (either via 465 * setup_git_directory, or in the environment via $GIT_DIR). 466 */ 467int have_git_dir(void); 468 469extern int is_bare_repository_cfg; 470extern int is_bare_repository(void); 471extern int is_inside_git_dir(void); 472extern char *git_work_tree_cfg; 473extern int is_inside_work_tree(void); 474extern const char *get_git_dir(void); 475extern const char *get_git_common_dir(void); 476extern char *get_object_directory(void); 477extern char *get_index_file(void); 478extern char *get_graft_file(void); 479extern int set_git_dir(const char *path); 480extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir); 481extern int get_common_dir(struct strbuf *sb, const char *gitdir); 482extern const char *get_git_namespace(void); 483extern const char *strip_namespace(const char *namespaced_ref); 484extern const char *get_super_prefix(void); 485extern const char *get_git_work_tree(void); 486 487/* 488 * Return true if the given path is a git directory; note that this _just_ 489 * looks at the directory itself. If you want to know whether "foo/.git" 490 * is a repository, you must feed that path, not just "foo". 491 */ 492extern int is_git_directory(const char *path); 493 494/* 495 * Return 1 if the given path is the root of a git repository or 496 * submodule, else 0. Will not return 1 for bare repositories with the 497 * exception of creating a bare repository in "foo/.git" and calling 498 * is_git_repository("foo"). 499 * 500 * If we run into read errors, we err on the side of saying "yes, it is", 501 * as we usually consider sub-repos precious, and would prefer to err on the 502 * side of not disrupting or deleting them. 503 */ 504extern int is_nonbare_repository_dir(struct strbuf *path); 505 506#define READ_GITFILE_ERR_STAT_FAILED 1 507#define READ_GITFILE_ERR_NOT_A_FILE 2 508#define READ_GITFILE_ERR_OPEN_FAILED 3 509#define READ_GITFILE_ERR_READ_FAILED 4 510#define READ_GITFILE_ERR_INVALID_FORMAT 5 511#define READ_GITFILE_ERR_NO_PATH 6 512#define READ_GITFILE_ERR_NOT_A_REPO 7 513#define READ_GITFILE_ERR_TOO_LARGE 8 514extern void read_gitfile_error_die(int error_code, const char *path, const char *dir); 515extern const char *read_gitfile_gently(const char *path, int *return_error_code); 516#define read_gitfile(path) read_gitfile_gently((path), NULL) 517extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code); 518#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 519 520extern void set_git_work_tree(const char *tree); 521 522#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES" 523 524extern void setup_work_tree(void); 525/* 526 * Find GIT_DIR of the repository that contains the current working directory, 527 * without changing the working directory or other global state. The result is 528 * appended to gitdir. The return value is either NULL if no repository was 529 * found, or pointing to the path inside gitdir's buffer. 530 */ 531extern const char *discover_git_directory(struct strbuf *gitdir); 532extern const char *setup_git_directory_gently(int *); 533extern const char *setup_git_directory(void); 534extern char *prefix_path(const char *prefix, int len, const char *path); 535extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path); 536extern const char *prefix_filename(const char *prefix, int len, const char *path); 537extern int check_filename(const char *prefix, const char *name); 538extern void verify_filename(const char *prefix, 539 const char *name, 540 int diagnose_misspelt_rev); 541extern void verify_non_filename(const char *prefix, const char *name); 542extern int path_inside_repo(const char *prefix, const char *path); 543 544#define INIT_DB_QUIET 0x0001 545#define INIT_DB_EXIST_OK 0x0002 546 547extern int init_db(const char *git_dir, const char *real_git_dir, 548 const char *template_dir, unsigned int flags); 549 550extern void sanitize_stdfds(void); 551extern int daemonize(void); 552 553#define alloc_nr(x) (((x)+16)*3/2) 554 555/* 556 * Realloc the buffer pointed at by variable 'x' so that it can hold 557 * at least 'nr' entries; the number of entries currently allocated 558 * is 'alloc', using the standard growing factor alloc_nr() macro. 559 * 560 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 561 */ 562#define ALLOC_GROW(x, nr, alloc) \ 563 do { \ 564 if ((nr) > alloc) { \ 565 if (alloc_nr(alloc) < (nr)) \ 566 alloc = (nr); \ 567 else \ 568 alloc = alloc_nr(alloc); \ 569 REALLOC_ARRAY(x, alloc); \ 570 } \ 571 } while (0) 572 573/* Initialize and use the cache information */ 574struct lock_file; 575extern int read_index(struct index_state *); 576extern int read_index_preload(struct index_state *, const struct pathspec *pathspec); 577extern int do_read_index(struct index_state *istate, const char *path, 578 int must_exist); /* for testting only! */ 579extern int read_index_from(struct index_state *, const char *path); 580extern int is_index_unborn(struct index_state *); 581extern int read_index_unmerged(struct index_state *); 582#define COMMIT_LOCK (1 << 0) 583#define CLOSE_LOCK (1 << 1) 584extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags); 585extern int discard_index(struct index_state *); 586extern int unmerged_index(const struct index_state *); 587extern int verify_path(const char *path); 588extern int index_dir_exists(struct index_state *istate, const char *name, int namelen); 589extern void adjust_dirname_case(struct index_state *istate, char *name); 590extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase); 591 592/* 593 * Searches for an entry defined by name and namelen in the given index. 594 * If the return value is positive (including 0) it is the position of an 595 * exact match. If the return value is negative, the negated value minus 1 596 * is the position where the entry would be inserted. 597 * Example: The current index consists of these files and its stages: 598 * 599 * b#0, d#0, f#1, f#3 600 * 601 * index_name_pos(&index, "a", 1) -> -1 602 * index_name_pos(&index, "b", 1) -> 0 603 * index_name_pos(&index, "c", 1) -> -2 604 * index_name_pos(&index, "d", 1) -> 1 605 * index_name_pos(&index, "e", 1) -> -3 606 * index_name_pos(&index, "f", 1) -> -3 607 * index_name_pos(&index, "g", 1) -> -5 608 */ 609extern int index_name_pos(const struct index_state *, const char *name, int namelen); 610 611#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */ 612#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */ 613#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */ 614#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */ 615#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */ 616#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */ 617extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option); 618extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name); 619 620/* Remove entry, return true if there are more entries to go. */ 621extern int remove_index_entry_at(struct index_state *, int pos); 622 623extern void remove_marked_cache_entries(struct index_state *istate); 624extern int remove_file_from_index(struct index_state *, const char *path); 625#define ADD_CACHE_VERBOSE 1 626#define ADD_CACHE_PRETEND 2 627#define ADD_CACHE_IGNORE_ERRORS 4 628#define ADD_CACHE_IGNORE_REMOVAL 8 629#define ADD_CACHE_INTENT 16 630/* 631 * These two are used to add the contents of the file at path 632 * to the index, marking the working tree up-to-date by storing 633 * the cached stat info in the resulting cache entry. A caller 634 * that has already run lstat(2) on the path can call 635 * add_to_index(), and all others can call add_file_to_index(); 636 * the latter will do necessary lstat(2) internally before 637 * calling the former. 638 */ 639extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags); 640extern int add_file_to_index(struct index_state *, const char *path, int flags); 641 642extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options); 643extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip); 644extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b); 645extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce); 646extern int index_name_is_other(const struct index_state *, const char *, int); 647extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *); 648 649/* do stat comparison even if CE_VALID is true */ 650#define CE_MATCH_IGNORE_VALID 01 651/* do not check the contents but report dirty on racily-clean entries */ 652#define CE_MATCH_RACY_IS_DIRTY 02 653/* do stat comparison even if CE_SKIP_WORKTREE is true */ 654#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 655/* ignore non-existent files during stat update */ 656#define CE_MATCH_IGNORE_MISSING 0x08 657/* enable stat refresh */ 658#define CE_MATCH_REFRESH 0x10 659extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 660extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 661 662#define HASH_WRITE_OBJECT 1 663#define HASH_FORMAT_CHECK 2 664extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags); 665extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags); 666 667/* 668 * Record to sd the data from st that we use to check whether a file 669 * might have changed. 670 */ 671extern void fill_stat_data(struct stat_data *sd, struct stat *st); 672 673/* 674 * Return 0 if st is consistent with a file not having been changed 675 * since sd was filled. If there are differences, return a 676 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 677 * INODE_CHANGED, and DATA_CHANGED. 678 */ 679extern int match_stat_data(const struct stat_data *sd, struct stat *st); 680extern int match_stat_data_racy(const struct index_state *istate, 681 const struct stat_data *sd, struct stat *st); 682 683extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st); 684 685#define REFRESH_REALLY 0x0001 /* ignore_valid */ 686#define REFRESH_UNMERGED 0x0002 /* allow unmerged */ 687#define REFRESH_QUIET 0x0004 /* be quiet about it */ 688#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */ 689#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */ 690#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */ 691extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg); 692extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int); 693 694extern void update_index_if_able(struct index_state *, struct lock_file *); 695 696extern int hold_locked_index(struct lock_file *, int); 697extern void set_alternate_index_output(const char *); 698 699/* Environment bits from configuration mechanism */ 700extern int trust_executable_bit; 701extern int trust_ctime; 702extern int check_stat; 703extern int quote_path_fully; 704extern int has_symlinks; 705extern int minimum_abbrev, default_abbrev; 706extern int ignore_case; 707extern int assume_unchanged; 708extern int prefer_symlink_refs; 709extern int warn_ambiguous_refs; 710extern int warn_on_object_refname_ambiguity; 711extern const char *apply_default_whitespace; 712extern const char *apply_default_ignorewhitespace; 713extern const char *git_attributes_file; 714extern const char *git_hooks_path; 715extern int zlib_compression_level; 716extern int core_compression_level; 717extern int pack_compression_level; 718extern size_t packed_git_window_size; 719extern size_t packed_git_limit; 720extern size_t delta_base_cache_limit; 721extern unsigned long big_file_threshold; 722extern unsigned long pack_size_limit_cfg; 723 724/* 725 * Accessors for the core.sharedrepository config which lazy-load the value 726 * from the config (if not already set). The "reset" function can be 727 * used to unset "set" or cached value, meaning that the value will be loaded 728 * fresh from the config file on the next call to get_shared_repository(). 729 */ 730void set_shared_repository(int value); 731int get_shared_repository(void); 732void reset_shared_repository(void); 733 734/* 735 * Do replace refs need to be checked this run? This variable is 736 * initialized to true unless --no-replace-object is used or 737 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 738 * commands that do not want replace references to be active. As an 739 * optimization it is also set to false if replace references have 740 * been sought but there were none. 741 */ 742extern int check_replace_refs; 743extern char *git_replace_ref_base; 744 745extern int fsync_object_files; 746extern int core_preload_index; 747extern int core_apply_sparse_checkout; 748extern int precomposed_unicode; 749extern int protect_hfs; 750extern int protect_ntfs; 751extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env; 752 753/* 754 * Include broken refs in all ref iterations, which will 755 * generally choke dangerous operations rather than letting 756 * them silently proceed without taking the broken ref into 757 * account. 758 */ 759extern int ref_paranoia; 760 761/* 762 * The character that begins a commented line in user-editable file 763 * that is subject to stripspace. 764 */ 765extern char comment_line_char; 766extern int auto_comment_line_char; 767 768/* Windows only */ 769enum hide_dotfiles_type { 770 HIDE_DOTFILES_FALSE = 0, 771 HIDE_DOTFILES_TRUE, 772 HIDE_DOTFILES_DOTGITONLY 773}; 774extern enum hide_dotfiles_type hide_dotfiles; 775 776enum log_refs_config { 777 LOG_REFS_UNSET = -1, 778 LOG_REFS_NONE = 0, 779 LOG_REFS_NORMAL, 780 LOG_REFS_ALWAYS 781}; 782extern enum log_refs_config log_all_ref_updates; 783 784enum branch_track { 785 BRANCH_TRACK_UNSPECIFIED = -1, 786 BRANCH_TRACK_NEVER = 0, 787 BRANCH_TRACK_REMOTE, 788 BRANCH_TRACK_ALWAYS, 789 BRANCH_TRACK_EXPLICIT, 790 BRANCH_TRACK_OVERRIDE 791}; 792 793enum rebase_setup_type { 794 AUTOREBASE_NEVER = 0, 795 AUTOREBASE_LOCAL, 796 AUTOREBASE_REMOTE, 797 AUTOREBASE_ALWAYS 798}; 799 800enum push_default_type { 801 PUSH_DEFAULT_NOTHING = 0, 802 PUSH_DEFAULT_MATCHING, 803 PUSH_DEFAULT_SIMPLE, 804 PUSH_DEFAULT_UPSTREAM, 805 PUSH_DEFAULT_CURRENT, 806 PUSH_DEFAULT_UNSPECIFIED 807}; 808 809extern enum branch_track git_branch_track; 810extern enum rebase_setup_type autorebase; 811extern enum push_default_type push_default; 812 813enum object_creation_mode { 814 OBJECT_CREATION_USES_HARDLINKS = 0, 815 OBJECT_CREATION_USES_RENAMES = 1 816}; 817 818extern enum object_creation_mode object_creation_mode; 819 820extern char *notes_ref_name; 821 822extern int grafts_replace_parents; 823 824/* 825 * GIT_REPO_VERSION is the version we write by default. The 826 * _READ variant is the highest number we know how to 827 * handle. 828 */ 829#define GIT_REPO_VERSION 0 830#define GIT_REPO_VERSION_READ 1 831extern int repository_format_precious_objects; 832 833struct repository_format { 834 int version; 835 int precious_objects; 836 int is_bare; 837 char *work_tree; 838 struct string_list unknown_extensions; 839}; 840 841/* 842 * Read the repository format characteristics from the config file "path" into 843 * "format" struct. Returns the numeric version. On error, -1 is returned, 844 * format->version is set to -1, and all other fields in the struct are 845 * undefined. 846 */ 847int read_repository_format(struct repository_format *format, const char *path); 848 849/* 850 * Verify that the repository described by repository_format is something we 851 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 852 * any errors encountered. 853 */ 854int verify_repository_format(const struct repository_format *format, 855 struct strbuf *err); 856 857/* 858 * Check the repository format version in the path found in get_git_dir(), 859 * and die if it is a version we don't understand. Generally one would 860 * set_git_dir() before calling this, and use it only for "are we in a valid 861 * repo?". 862 */ 863extern void check_repository_format(void); 864 865#define MTIME_CHANGED 0x0001 866#define CTIME_CHANGED 0x0002 867#define OWNER_CHANGED 0x0004 868#define MODE_CHANGED 0x0008 869#define INODE_CHANGED 0x0010 870#define DATA_CHANGED 0x0020 871#define TYPE_CHANGED 0x0040 872 873/* 874 * Return a statically allocated filename, either generically (mkpath), in 875 * the repository directory (git_path), or in a submodule's repository 876 * directory (git_path_submodule). In all cases, note that the result 877 * may be overwritten by another call to _any_ of the functions. Consider 878 * using the safer "dup" or "strbuf" formats below (in some cases, the 879 * unsafe versions have already been removed). 880 */ 881extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 882extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 883extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 884 885extern char *mksnpath(char *buf, size_t n, const char *fmt, ...) 886 __attribute__((format (printf, 3, 4))); 887extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...) 888 __attribute__((format (printf, 2, 3))); 889extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...) 890 __attribute__((format (printf, 2, 3))); 891extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...) 892 __attribute__((format (printf, 2, 3))); 893extern int strbuf_git_path_submodule(struct strbuf *sb, const char *path, 894 const char *fmt, ...) 895 __attribute__((format (printf, 3, 4))); 896extern char *git_pathdup(const char *fmt, ...) 897 __attribute__((format (printf, 1, 2))); 898extern char *mkpathdup(const char *fmt, ...) 899 __attribute__((format (printf, 1, 2))); 900extern char *git_pathdup_submodule(const char *path, const char *fmt, ...) 901 __attribute__((format (printf, 2, 3))); 902 903extern void report_linked_checkout_garbage(void); 904 905/* 906 * You can define a static memoized git path like: 907 * 908 * static GIT_PATH_FUNC(git_path_foo, "FOO"); 909 * 910 * or use one of the global ones below. 911 */ 912#define GIT_PATH_FUNC(func, filename) \ 913 const char *func(void) \ 914 { \ 915 static char *ret; \ 916 if (!ret) \ 917 ret = git_pathdup(filename); \ 918 return ret; \ 919 } 920 921const char *git_path_cherry_pick_head(void); 922const char *git_path_revert_head(void); 923const char *git_path_squash_msg(void); 924const char *git_path_merge_msg(void); 925const char *git_path_merge_rr(void); 926const char *git_path_merge_mode(void); 927const char *git_path_merge_head(void); 928const char *git_path_fetch_head(void); 929const char *git_path_shallow(void); 930 931/* 932 * Return the name of the file in the local object database that would 933 * be used to store a loose object with the specified sha1. The 934 * return value is a pointer to a statically allocated buffer that is 935 * overwritten each time the function is called. 936 */ 937extern const char *sha1_file_name(const unsigned char *sha1); 938 939/* 940 * Return the name of the (local) packfile with the specified sha1 in 941 * its name. The return value is a pointer to memory that is 942 * overwritten each time this function is called. 943 */ 944extern char *sha1_pack_name(const unsigned char *sha1); 945 946/* 947 * Return the name of the (local) pack index file with the specified 948 * sha1 in its name. The return value is a pointer to memory that is 949 * overwritten each time this function is called. 950 */ 951extern char *sha1_pack_index_name(const unsigned char *sha1); 952 953/* 954 * Return an abbreviated sha1 unique within this repository's object database. 955 * The result will be at least `len` characters long, and will be NUL 956 * terminated. 957 * 958 * The non-`_r` version returns a static buffer which remains valid until 4 959 * more calls to find_unique_abbrev are made. 960 * 961 * The `_r` variant writes to a buffer supplied by the caller, which must be at 962 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 963 * written (excluding the NUL terminator). 964 * 965 * Note that while this version avoids the static buffer, it is not fully 966 * reentrant, as it calls into other non-reentrant git code. 967 */ 968extern const char *find_unique_abbrev(const unsigned char *sha1, int len); 969extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len); 970 971extern const unsigned char null_sha1[GIT_MAX_RAWSZ]; 972extern const struct object_id null_oid; 973 974static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2) 975{ 976 int i; 977 978 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 979 if (*sha1 != *sha2) 980 return *sha1 - *sha2; 981 } 982 983 return 0; 984} 985 986static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2) 987{ 988 return hashcmp(oid1->hash, oid2->hash); 989} 990 991static inline int is_null_sha1(const unsigned char *sha1) 992{ 993 return !hashcmp(sha1, null_sha1); 994} 995 996static inline int is_null_oid(const struct object_id *oid) 997{ 998 return !hashcmp(oid->hash, null_sha1); 999}10001001static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)1002{1003 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);1004}10051006static inline void oidcpy(struct object_id *dst, const struct object_id *src)1007{1008 hashcpy(dst->hash, src->hash);1009}10101011static inline void hashclr(unsigned char *hash)1012{1013 memset(hash, 0, GIT_SHA1_RAWSZ);1014}10151016static inline void oidclr(struct object_id *oid)1017{1018 hashclr(oid->hash);1019}102010211022#define EMPTY_TREE_SHA1_HEX \1023 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"1024#define EMPTY_TREE_SHA1_BIN_LITERAL \1025 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1026 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1027extern const struct object_id empty_tree_oid;1028#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10291030#define EMPTY_BLOB_SHA1_HEX \1031 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1032#define EMPTY_BLOB_SHA1_BIN_LITERAL \1033 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1034 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1035extern const struct object_id empty_blob_oid;1036#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)103710381039static inline int is_empty_blob_sha1(const unsigned char *sha1)1040{1041 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1042}10431044static inline int is_empty_blob_oid(const struct object_id *oid)1045{1046 return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1047}10481049static inline int is_empty_tree_sha1(const unsigned char *sha1)1050{1051 return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1052}10531054static inline int is_empty_tree_oid(const struct object_id *oid)1055{1056 return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1057}10581059/* set default permissions by passing mode arguments to open(2) */1060int git_mkstemps_mode(char *pattern, int suffix_len, int mode);1061int git_mkstemp_mode(char *pattern, int mode);10621063/*1064 * NOTE NOTE NOTE!!1065 *1066 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1067 * not be changed. Old repositories have core.sharedrepository written in1068 * numeric format, and therefore these values are preserved for compatibility1069 * reasons.1070 */1071enum sharedrepo {1072 PERM_UMASK = 0,1073 OLD_PERM_GROUP = 1,1074 OLD_PERM_EVERYBODY = 2,1075 PERM_GROUP = 0660,1076 PERM_EVERYBODY = 06641077};1078int git_config_perm(const char *var, const char *value);1079int adjust_shared_perm(const char *path);10801081/*1082 * Create the directory containing the named path, using care to be1083 * somewhat safe against races. Return one of the scld_error values to1084 * indicate success/failure. On error, set errno to describe the1085 * problem.1086 *1087 * SCLD_VANISHED indicates that one of the ancestor directories of the1088 * path existed at one point during the function call and then1089 * suddenly vanished, probably because another process pruned the1090 * directory while we were working. To be robust against this kind of1091 * race, callers might want to try invoking the function again when it1092 * returns SCLD_VANISHED.1093 *1094 * safe_create_leading_directories() temporarily changes path while it1095 * is working but restores it before returning.1096 * safe_create_leading_directories_const() doesn't modify path, even1097 * temporarily.1098 */1099enum scld_error {1100 SCLD_OK = 0,1101 SCLD_FAILED = -1,1102 SCLD_PERMS = -2,1103 SCLD_EXISTS = -3,1104 SCLD_VANISHED = -41105};1106enum scld_error safe_create_leading_directories(char *path);1107enum scld_error safe_create_leading_directories_const(const char *path);11081109/*1110 * Callback function for raceproof_create_file(). This function is1111 * expected to do something that makes dirname(path) permanent despite1112 * the fact that other processes might be cleaning up empty1113 * directories at the same time. Usually it will create a file named1114 * path, but alternatively it could create another file in that1115 * directory, or even chdir() into that directory. The function should1116 * return 0 if the action was completed successfully. On error, it1117 * should return a nonzero result and set errno.1118 * raceproof_create_file() treats two errno values specially:1119 *1120 * - ENOENT -- dirname(path) does not exist. In this case,1121 * raceproof_create_file() tries creating dirname(path)1122 * (and any parent directories, if necessary) and calls1123 * the function again.1124 *1125 * - EISDIR -- the file already exists and is a directory. In this1126 * case, raceproof_create_file() removes the directory if1127 * it is empty (and recursively any empty directories that1128 * it contains) and calls the function again.1129 *1130 * Any other errno causes raceproof_create_file() to fail with the1131 * callback's return value and errno.1132 *1133 * Obviously, this function should be OK with being called again if it1134 * fails with ENOENT or EISDIR. In other scenarios it will not be1135 * called again.1136 */1137typedef int create_file_fn(const char *path, void *cb);11381139/*1140 * Create a file in dirname(path) by calling fn, creating leading1141 * directories if necessary. Retry a few times in case we are racing1142 * with another process that is trying to clean up the directory that1143 * contains path. See the documentation for create_file_fn for more1144 * details.1145 *1146 * Return the value and set the errno that resulted from the most1147 * recent call of fn. fn is always called at least once, and will be1148 * called more than once if it returns ENOENT or EISDIR.1149 */1150int raceproof_create_file(const char *path, create_file_fn fn, void *cb);11511152int mkdir_in_gitdir(const char *path);1153extern char *expand_user_path(const char *path);1154const char *enter_repo(const char *path, int strict);1155static inline int is_absolute_path(const char *path)1156{1157 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);1158}1159int is_directory(const char *);1160char *strbuf_realpath(struct strbuf *resolved, const char *path,1161 int die_on_error);1162const char *real_path(const char *path);1163const char *real_path_if_valid(const char *path);1164char *real_pathdup(const char *path, int die_on_error);1165const char *absolute_path(const char *path);1166char *absolute_pathdup(const char *path);1167const char *remove_leading_path(const char *in, const char *prefix);1168const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);1169int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);1170int normalize_path_copy(char *dst, const char *src);1171int longest_ancestor_length(const char *path, struct string_list *prefixes);1172char *strip_path_suffix(const char *path, const char *suffix);1173int daemon_avoid_alias(const char *path);1174extern int is_ntfs_dotgit(const char *name);11751176/**1177 * Return a newly allocated string with the evaluation of1178 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1179 * "$HOME/.config/git/$filename". Return NULL upon error.1180 */1181extern char *xdg_config_home(const char *filename);11821183/**1184 * Return a newly allocated string with the evaluation of1185 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1186 * "$HOME/.cache/git/$filename". Return NULL upon error.1187 */1188extern char *xdg_cache_home(const char *filename);11891190/* object replacement */1191#define LOOKUP_REPLACE_OBJECT 11192#define LOOKUP_UNKNOWN_OBJECT 21193extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);1194static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)1195{1196 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);1197}11981199/*1200 * This internal function is only declared here for the benefit of1201 * lookup_replace_object(). Please do not call it directly.1202 */1203extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);12041205/*1206 * If object sha1 should be replaced, return the replacement object's1207 * name (replaced recursively, if necessary). The return value is1208 * either sha1 or a pointer to a permanently-allocated value. When1209 * object replacement is suppressed, always return sha1.1210 */1211static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)1212{1213 if (!check_replace_refs)1214 return sha1;1215 return do_lookup_replace_object(sha1);1216}12171218static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)1219{1220 if (!(flag & LOOKUP_REPLACE_OBJECT))1221 return sha1;1222 return lookup_replace_object(sha1);1223}12241225/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1226extern int sha1_object_info(const unsigned char *, unsigned long *);1227extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);1228extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);1229extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);1230extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);1231extern int force_object_loose(const unsigned char *sha1, time_t mtime);1232extern int git_open_cloexec(const char *name, int flags);1233#define git_open(name) git_open_cloexec(name, O_RDONLY)1234extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);1235extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);1236extern int parse_sha1_header(const char *hdr, unsigned long *sizep);12371238/* global flag to enable extra checks when accessing packed objects */1239extern int do_check_packed_object_crc;12401241extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);12421243extern int finalize_object_file(const char *tmpfile, const char *filename);12441245extern int has_sha1_pack(const unsigned char *sha1);12461247/*1248 * Open the loose object at path, check its sha1, and return the contents,1249 * type, and size. If the object is a blob, then "contents" may return NULL,1250 * to allow streaming of large blobs.1251 *1252 * Returns 0 on success, negative on error (details may be written to stderr).1253 */1254int read_loose_object(const char *path,1255 const unsigned char *expected_sha1,1256 enum object_type *type,1257 unsigned long *size,1258 void **contents);12591260/*1261 * Return true iff we have an object named sha1, whether local or in1262 * an alternate object database, and whether packed or loose. This1263 * function does not respect replace references.1264 *1265 * If the QUICK flag is set, do not re-check the pack directory1266 * when we cannot find the object (this means we may give a false1267 * negative answer if another process is simultaneously repacking).1268 */1269#define HAS_SHA1_QUICK 0x11270extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);1271static inline int has_sha1_file(const unsigned char *sha1)1272{1273 return has_sha1_file_with_flags(sha1, 0);1274}12751276/* Same as the above, except for struct object_id. */1277extern int has_object_file(const struct object_id *oid);1278extern int has_object_file_with_flags(const struct object_id *oid, int flags);12791280/*1281 * Return true iff an alternate object database has a loose object1282 * with the specified name. This function does not respect replace1283 * references.1284 */1285extern int has_loose_object_nonlocal(const unsigned char *sha1);12861287extern int has_pack_index(const unsigned char *sha1);12881289extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);12901291/* Helper to check and "touch" a file */1292extern int check_and_freshen_file(const char *fn, int freshen);12931294extern const signed char hexval_table[256];1295static inline unsigned int hexval(unsigned char c)1296{1297 return hexval_table[c];1298}12991300/*1301 * Convert two consecutive hexadecimal digits into a char. Return a1302 * negative value on error. Don't run over the end of short strings.1303 */1304static inline int hex2chr(const char *s)1305{1306 int val = hexval(s[0]);1307 return (val < 0) ? val : (val << 4) | hexval(s[1]);1308}13091310/* Convert to/from hex/sha1 representation */1311#define MINIMUM_ABBREV minimum_abbrev1312#define DEFAULT_ABBREV default_abbrev13131314/* used when the code does not know or care what the default abbrev is */1315#define FALLBACK_DEFAULT_ABBREV 713161317struct object_context {1318 unsigned char tree[20];1319 char path[PATH_MAX];1320 unsigned mode;1321 /*1322 * symlink_path is only used by get_tree_entry_follow_symlinks,1323 * and only for symlinks that point outside the repository.1324 */1325 struct strbuf symlink_path;1326};13271328#define GET_SHA1_QUIETLY 011329#define GET_SHA1_COMMIT 021330#define GET_SHA1_COMMITTISH 041331#define GET_SHA1_TREE 0101332#define GET_SHA1_TREEISH 0201333#define GET_SHA1_BLOB 0401334#define GET_SHA1_FOLLOW_SYMLINKS 01001335#define GET_SHA1_ONLY_TO_DIE 0400013361337#define GET_SHA1_DISAMBIGUATORS \1338 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \1339 GET_SHA1_TREE | GET_SHA1_TREEISH | \1340 GET_SHA1_BLOB)13411342extern int get_sha1(const char *str, unsigned char *sha1);1343extern int get_sha1_commit(const char *str, unsigned char *sha1);1344extern int get_sha1_committish(const char *str, unsigned char *sha1);1345extern int get_sha1_tree(const char *str, unsigned char *sha1);1346extern int get_sha1_treeish(const char *str, unsigned char *sha1);1347extern int get_sha1_blob(const char *str, unsigned char *sha1);1348extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);1349extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);13501351extern int get_oid(const char *str, struct object_id *oid);13521353typedef int each_abbrev_fn(const unsigned char *sha1, void *);1354extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);13551356extern int set_disambiguate_hint_config(const char *var, const char *value);13571358/*1359 * Try to read a SHA1 in hexadecimal format from the 40 characters1360 * starting at hex. Write the 20-byte result to sha1 in binary form.1361 * Return 0 on success. Reading stops if a NUL is encountered in the1362 * input, so it is safe to pass this function an arbitrary1363 * null-terminated string.1364 */1365extern int get_sha1_hex(const char *hex, unsigned char *sha1);1366extern int get_oid_hex(const char *hex, struct object_id *sha1);13671368/*1369 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1370 * and writes the NUL-terminated output to the buffer `out`, which must be at1371 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1372 * convenience.1373 *1374 * The non-`_r` variant returns a static buffer, but uses a ring of 41375 * buffers, making it safe to make multiple calls for a single statement, like:1376 *1377 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1378 */1379extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);1380extern char *oid_to_hex_r(char *out, const struct object_id *oid);1381extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */1382extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */13831384/*1385 * Parse a 40-character hexadecimal object ID starting from hex, updating the1386 * pointer specified by end when parsing stops. The resulting object ID is1387 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1388 * other invalid character. end is only updated on success; otherwise, it is1389 * unmodified.1390 */1391extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);13921393/*1394 * This reads short-hand syntax that not only evaluates to a commit1395 * object name, but also can act as if the end user spelled the name1396 * of the branch from the command line.1397 *1398 * - "@{-N}" finds the name of the Nth previous branch we were on, and1399 * places the name of the branch in the given buf and returns the1400 * number of characters parsed if successful.1401 *1402 * - "<branch>@{upstream}" finds the name of the other ref that1403 * <branch> is configured to merge with (missing <branch> defaults1404 * to the current branch), and places the name of the branch in the1405 * given buf and returns the number of characters parsed if1406 * successful.1407 *1408 * If the input is not of the accepted format, it returns a negative1409 * number to signal an error.1410 *1411 * If the input was ok but there are not N branch switches in the1412 * reflog, it returns 0.1413 *1414 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1415 * expansions: local branches ("refs/heads/"), remote branches1416 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1417 * allowed, even ones to refs outside of those namespaces.1418 */1419#define INTERPRET_BRANCH_LOCAL (1<<0)1420#define INTERPRET_BRANCH_REMOTE (1<<1)1421#define INTERPRET_BRANCH_HEAD (1<<2)1422extern int interpret_branch_name(const char *str, int len, struct strbuf *,1423 unsigned allowed);1424extern int get_oid_mb(const char *str, struct object_id *oid);14251426extern int validate_headref(const char *ref);14271428extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1429extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1430extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);1431extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);14321433extern void *read_object_with_reference(const unsigned char *sha1,1434 const char *required_type,1435 unsigned long *size,1436 unsigned char *sha1_ret);14371438extern struct object *peel_to_type(const char *name, int namelen,1439 struct object *o, enum object_type);14401441struct date_mode {1442 enum date_mode_type {1443 DATE_NORMAL = 0,1444 DATE_RELATIVE,1445 DATE_SHORT,1446 DATE_ISO8601,1447 DATE_ISO8601_STRICT,1448 DATE_RFC2822,1449 DATE_STRFTIME,1450 DATE_RAW,1451 DATE_UNIX1452 } type;1453 const char *strftime_fmt;1454 int local;1455};14561457/*1458 * Convenience helper for passing a constant type, like:1459 *1460 * show_date(t, tz, DATE_MODE(NORMAL));1461 */1462#define DATE_MODE(t) date_mode_from_type(DATE_##t)1463struct date_mode *date_mode_from_type(enum date_mode_type type);14641465const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);1466void show_date_relative(unsigned long time, int tz, const struct timeval *now,1467 struct strbuf *timebuf);1468int parse_date(const char *date, struct strbuf *out);1469int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);1470int parse_expiry_date(const char *date, unsigned long *timestamp);1471void datestamp(struct strbuf *out);1472#define approxidate(s) approxidate_careful((s), NULL)1473unsigned long approxidate_careful(const char *, int *);1474unsigned long approxidate_relative(const char *date, const struct timeval *now);1475void parse_date_format(const char *format, struct date_mode *mode);1476int date_overflows(unsigned long date);14771478#define IDENT_STRICT 11479#define IDENT_NO_DATE 21480#define IDENT_NO_NAME 41481extern const char *git_author_info(int);1482extern const char *git_committer_info(int);1483extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);1484extern const char *fmt_name(const char *name, const char *email);1485extern const char *ident_default_name(void);1486extern const char *ident_default_email(void);1487extern const char *git_editor(void);1488extern const char *git_pager(int stdout_is_tty);1489extern int git_ident_config(const char *, const char *, void *);1490extern void reset_ident_date(void);14911492struct ident_split {1493 const char *name_begin;1494 const char *name_end;1495 const char *mail_begin;1496 const char *mail_end;1497 const char *date_begin;1498 const char *date_end;1499 const char *tz_begin;1500 const char *tz_end;1501};1502/*1503 * Signals an success with 0, but time part of the result may be NULL1504 * if the input lacks timestamp and zone1505 */1506extern int split_ident_line(struct ident_split *, const char *, int);15071508/*1509 * Like show_date, but pull the timestamp and tz parameters from1510 * the ident_split. It will also sanity-check the values and produce1511 * a well-known sentinel date if they appear bogus.1512 */1513const char *show_ident_date(const struct ident_split *id,1514 const struct date_mode *mode);15151516/*1517 * Compare split idents for equality or strict ordering. Note that we1518 * compare only the ident part of the line, ignoring any timestamp.1519 *1520 * Because there are two fields, we must choose one as the primary key; we1521 * currently arbitrarily pick the email.1522 */1523extern int ident_cmp(const struct ident_split *, const struct ident_split *);15241525struct checkout {1526 struct index_state *istate;1527 const char *base_dir;1528 int base_dir_len;1529 unsigned force:1,1530 quiet:1,1531 not_new:1,1532 refresh_cache:1;1533};1534#define CHECKOUT_INIT { NULL, "" }15351536#define TEMPORARY_FILENAME_LENGTH 251537extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);15381539struct cache_def {1540 struct strbuf path;1541 int flags;1542 int track_flags;1543 int prefix_len_stat_func;1544};1545#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1546static inline void cache_def_clear(struct cache_def *cache)1547{1548 strbuf_release(&cache->path);1549}15501551extern int has_symlink_leading_path(const char *name, int len);1552extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);1553extern int check_leading_path(const char *name, int len);1554extern int has_dirs_only_path(const char *name, int len, int prefix_len);1555extern void schedule_dir_for_removal(const char *name, int len);1556extern void remove_scheduled_dirs(void);15571558extern struct alternate_object_database {1559 struct alternate_object_database *next;15601561 /* see alt_scratch_buf() */1562 struct strbuf scratch;1563 size_t base_len;15641565 char path[FLEX_ARRAY];1566} *alt_odb_list;1567extern void prepare_alt_odb(void);1568extern void read_info_alternates(const char * relative_base, int depth);1569extern char *compute_alternate_path(const char *path, struct strbuf *err);1570typedef int alt_odb_fn(struct alternate_object_database *, void *);1571extern int foreach_alt_odb(alt_odb_fn, void*);15721573/*1574 * Allocate a "struct alternate_object_database" but do _not_ actually1575 * add it to the list of alternates.1576 */1577struct alternate_object_database *alloc_alt_odb(const char *dir);15781579/*1580 * Add the directory to the on-disk alternates file; the new entry will also1581 * take effect in the current process.1582 */1583extern void add_to_alternates_file(const char *dir);15841585/*1586 * Add the directory to the in-memory list of alternates (along with any1587 * recursive alternates it points to), but do not modify the on-disk alternates1588 * file.1589 */1590extern void add_to_alternates_memory(const char *dir);15911592/*1593 * Returns a scratch strbuf pre-filled with the alternate object directory,1594 * including a trailing slash, which can be used to access paths in the1595 * alternate. Always use this over direct access to alt->scratch, as it1596 * cleans up any previous use of the scratch buffer.1597 */1598extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);15991600struct pack_window {1601 struct pack_window *next;1602 unsigned char *base;1603 off_t offset;1604 size_t len;1605 unsigned int last_used;1606 unsigned int inuse_cnt;1607};16081609extern struct packed_git {1610 struct packed_git *next;1611 struct pack_window *windows;1612 off_t pack_size;1613 const void *index_data;1614 size_t index_size;1615 uint32_t num_objects;1616 uint32_t num_bad_objects;1617 unsigned char *bad_object_sha1;1618 int index_version;1619 time_t mtime;1620 int pack_fd;1621 unsigned pack_local:1,1622 pack_keep:1,1623 freshened:1,1624 do_not_close:1;1625 unsigned char sha1[20];1626 struct revindex_entry *revindex;1627 /* something like ".git/objects/pack/xxxxx.pack" */1628 char pack_name[FLEX_ARRAY]; /* more */1629} *packed_git;16301631/*1632 * A most-recently-used ordered version of the packed_git list, which can1633 * be iterated instead of packed_git (and marked via mru_mark).1634 */1635struct mru;1636extern struct mru *packed_git_mru;16371638struct pack_entry {1639 off_t offset;1640 unsigned char sha1[20];1641 struct packed_git *p;1642};16431644extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);16451646/* A hook to report invalid files in pack directory */1647#define PACKDIR_FILE_PACK 11648#define PACKDIR_FILE_IDX 21649#define PACKDIR_FILE_GARBAGE 41650extern void (*report_garbage)(unsigned seen_bits, const char *path);16511652extern void prepare_packed_git(void);1653extern void reprepare_packed_git(void);1654extern void install_packed_git(struct packed_git *pack);16551656/*1657 * Give a rough count of objects in the repository. This sacrifices accuracy1658 * for speed.1659 */1660unsigned long approximate_object_count(void);16611662extern struct packed_git *find_sha1_pack(const unsigned char *sha1,1663 struct packed_git *packs);16641665extern void pack_report(void);16661667/*1668 * Create a temporary file rooted in the object database directory.1669 */1670extern int odb_mkstemp(char *template, size_t limit, const char *pattern);16711672/*1673 * Generate the filename to be used for a pack file with checksum "sha1" and1674 * extension "ext". The result is written into the strbuf "buf", overwriting1675 * any existing contents. A pointer to buf->buf is returned as a convenience.1676 *1677 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"1678 */1679extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);16801681/*1682 * Create a pack .keep file named "name" (which should generally be the output1683 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1684 * error.1685 */1686extern int odb_pack_keep(const char *name);16871688/*1689 * mmap the index file for the specified packfile (if it is not1690 * already mmapped). Return 0 on success.1691 */1692extern int open_pack_index(struct packed_git *);16931694/*1695 * munmap the index file for the specified packfile (if it is1696 * currently mmapped).1697 */1698extern void close_pack_index(struct packed_git *);16991700extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);1701extern void close_pack_windows(struct packed_git *);1702extern void close_all_packs(void);1703extern void unuse_pack(struct pack_window **);1704extern void clear_delta_base_cache(void);1705extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);17061707/*1708 * Make sure that a pointer access into an mmap'd index file is within bounds,1709 * and can provide at least 8 bytes of data.1710 *1711 * Note that this is only necessary for variable-length segments of the file1712 * (like the 64-bit extended offset table), as we compare the size to the1713 * fixed-length parts when we open the file.1714 */1715extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);17161717/*1718 * Return the SHA-1 of the nth object within the specified packfile.1719 * Open the index if it is not already open. The return value points1720 * at the SHA-1 within the mmapped index. Return NULL if there is an1721 * error.1722 */1723extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);1724/*1725 * Like nth_packed_object_sha1, but write the data into the object specified by1726 * the the first argument. Returns the first argument on success, and NULL on1727 * error.1728 */1729extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);17301731/*1732 * Return the offset of the nth object within the specified packfile.1733 * The index must already be opened.1734 */1735extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);17361737/*1738 * If the object named sha1 is present in the specified packfile,1739 * return its offset within the packfile; otherwise, return 0.1740 */1741extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);17421743extern int is_pack_valid(struct packed_git *);1744extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);1745extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);1746extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);1747extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);17481749/*1750 * Iterate over the files in the loose-object parts of the object1751 * directory "path", triggering the following callbacks:1752 *1753 * - loose_object is called for each loose object we find.1754 *1755 * - loose_cruft is called for any files that do not appear to be1756 * loose objects. Note that we only look in the loose object1757 * directories "objects/[0-9a-f]{2}/", so we will not report1758 * "objects/foobar" as cruft.1759 *1760 * - loose_subdir is called for each top-level hashed subdirectory1761 * of the object directory (e.g., "$OBJDIR/f0"). It is called1762 * after the objects in the directory are processed.1763 *1764 * Any callback that is NULL will be ignored. Callbacks returning non-zero1765 * will end the iteration.1766 *1767 * In the "buf" variant, "path" is a strbuf which will also be used as a1768 * scratch buffer, but restored to its original contents before1769 * the function returns.1770 */1771typedef int each_loose_object_fn(const struct object_id *oid,1772 const char *path,1773 void *data);1774typedef int each_loose_cruft_fn(const char *basename,1775 const char *path,1776 void *data);1777typedef int each_loose_subdir_fn(int nr,1778 const char *path,1779 void *data);1780int for_each_loose_file_in_objdir(const char *path,1781 each_loose_object_fn obj_cb,1782 each_loose_cruft_fn cruft_cb,1783 each_loose_subdir_fn subdir_cb,1784 void *data);1785int for_each_loose_file_in_objdir_buf(struct strbuf *path,1786 each_loose_object_fn obj_cb,1787 each_loose_cruft_fn cruft_cb,1788 each_loose_subdir_fn subdir_cb,1789 void *data);17901791/*1792 * Iterate over loose and packed objects in both the local1793 * repository and any alternates repositories (unless the1794 * LOCAL_ONLY flag is set).1795 */1796#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11797typedef int each_packed_object_fn(const struct object_id *oid,1798 struct packed_git *pack,1799 uint32_t pos,1800 void *data);1801extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);1802extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);18031804struct object_info {1805 /* Request */1806 enum object_type *typep;1807 unsigned long *sizep;1808 off_t *disk_sizep;1809 unsigned char *delta_base_sha1;1810 struct strbuf *typename;18111812 /* Response */1813 enum {1814 OI_CACHED,1815 OI_LOOSE,1816 OI_PACKED,1817 OI_DBCACHED1818 } whence;1819 union {1820 /*1821 * struct {1822 * ... Nothing to expose in this case1823 * } cached;1824 * struct {1825 * ... Nothing to expose in this case1826 * } loose;1827 */1828 struct {1829 struct packed_git *pack;1830 off_t offset;1831 unsigned int is_delta;1832 } packed;1833 } u;1834};18351836/*1837 * Initializer for a "struct object_info" that wants no items. You may1838 * also memset() the memory to all-zeroes.1839 */1840#define OBJECT_INFO_INIT {NULL}18411842extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);1843extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);18441845/* Dumb servers support */1846extern int update_server_info(int);18471848/* git_config_parse_key() returns these negated: */1849#define CONFIG_INVALID_KEY 11850#define CONFIG_NO_SECTION_OR_NAME 21851/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */1852#define CONFIG_NO_LOCK -11853#define CONFIG_INVALID_FILE 31854#define CONFIG_NO_WRITE 41855#define CONFIG_NOTHING_SET 51856#define CONFIG_INVALID_PATTERN 61857#define CONFIG_GENERIC_ERROR 718581859#define CONFIG_REGEX_NONE ((void *)1)18601861struct git_config_source {1862 unsigned int use_stdin:1;1863 const char *file;1864 const char *blob;1865};18661867enum config_origin_type {1868 CONFIG_ORIGIN_BLOB,1869 CONFIG_ORIGIN_FILE,1870 CONFIG_ORIGIN_STDIN,1871 CONFIG_ORIGIN_SUBMODULE_BLOB,1872 CONFIG_ORIGIN_CMDLINE1873};18741875typedef int (*config_fn_t)(const char *, const char *, void *);1876extern int git_default_config(const char *, const char *, void *);1877extern int git_config_from_file(config_fn_t fn, const char *, void *);1878extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,1879 const char *name, const char *buf, size_t len, void *data);1880extern int git_config_from_blob_sha1(config_fn_t fn, const char *name,1881 const unsigned char *sha1, void *data);1882extern void git_config_push_parameter(const char *text);1883extern int git_config_from_parameters(config_fn_t fn, void *data);1884extern void read_early_config(config_fn_t cb, void *data);1885extern void git_config(config_fn_t fn, void *);1886extern int git_config_with_options(config_fn_t fn, void *,1887 struct git_config_source *config_source,1888 int respect_includes);1889extern int git_parse_ulong(const char *, unsigned long *);1890extern int git_parse_maybe_bool(const char *);1891extern int git_config_int(const char *, const char *);1892extern int64_t git_config_int64(const char *, const char *);1893extern unsigned long git_config_ulong(const char *, const char *);1894extern int git_config_bool_or_int(const char *, const char *, int *);1895extern int git_config_bool(const char *, const char *);1896extern int git_config_maybe_bool(const char *, const char *);1897extern int git_config_string(const char **, const char *, const char *);1898extern int git_config_pathname(const char **, const char *, const char *);1899extern int git_config_set_in_file_gently(const char *, const char *, const char *);1900extern void git_config_set_in_file(const char *, const char *, const char *);1901extern int git_config_set_gently(const char *, const char *);1902extern void git_config_set(const char *, const char *);1903extern int git_config_parse_key(const char *, char **, int *);1904extern int git_config_key_is_valid(const char *key);1905extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);1906extern void git_config_set_multivar(const char *, const char *, const char *, int);1907extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);1908extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);1909extern int git_config_rename_section(const char *, const char *);1910extern int git_config_rename_section_in_file(const char *, const char *, const char *);1911extern const char *git_etc_gitconfig(void);1912extern int git_env_bool(const char *, int);1913extern unsigned long git_env_ulong(const char *, unsigned long);1914extern int git_config_system(void);1915extern int config_error_nonbool(const char *);1916#if defined(__GNUC__)1917#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1918#endif1919extern const char *get_log_output_encoding(void);1920extern const char *get_commit_output_encoding(void);19211922extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);19231924enum config_scope {1925 CONFIG_SCOPE_UNKNOWN = 0,1926 CONFIG_SCOPE_SYSTEM,1927 CONFIG_SCOPE_GLOBAL,1928 CONFIG_SCOPE_REPO,1929 CONFIG_SCOPE_CMDLINE,1930};19311932extern enum config_scope current_config_scope(void);1933extern const char *current_config_origin_type(void);1934extern const char *current_config_name(void);19351936struct config_include_data {1937 int depth;1938 config_fn_t fn;1939 void *data;1940};1941#define CONFIG_INCLUDE_INIT { 0 }1942extern int git_config_include(const char *name, const char *value, void *data);19431944/*1945 * Match and parse a config key of the form:1946 *1947 * section.(subsection.)?key1948 *1949 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1950 * we return -1 if it does not match, 0 otherwise. The subsection and key1951 * out-parameters are filled by the function (and *subsection is NULL if it is1952 * missing).1953 *1954 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if1955 * there is no subsection at all.1956 */1957extern int parse_config_key(const char *var,1958 const char *section,1959 const char **subsection, int *subsection_len,1960 const char **key);19611962struct config_set_element {1963 struct hashmap_entry ent;1964 char *key;1965 struct string_list value_list;1966};19671968struct configset_list_item {1969 struct config_set_element *e;1970 int value_index;1971};19721973/*1974 * the contents of the list are ordered according to their1975 * position in the config files and order of parsing the files.1976 * (i.e. key-value pair at the last position of .git/config will1977 * be at the last item of the list)1978 */1979struct configset_list {1980 struct configset_list_item *items;1981 unsigned int nr, alloc;1982};19831984struct config_set {1985 struct hashmap config_hash;1986 int hash_initialized;1987 struct configset_list list;1988};19891990extern void git_configset_init(struct config_set *cs);1991extern int git_configset_add_file(struct config_set *cs, const char *filename);1992extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);1993extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);1994extern void git_configset_clear(struct config_set *cs);1995extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);1996extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);1997extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);1998extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);1999extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);2000extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);2001extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);2002extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);20032004extern int git_config_get_value(const char *key, const char **value);2005extern const struct string_list *git_config_get_value_multi(const char *key);2006extern void git_config_clear(void);2007extern void git_config_iter(config_fn_t fn, void *data);2008extern int git_config_get_string_const(const char *key, const char **dest);2009extern int git_config_get_string(const char *key, char **dest);2010extern int git_config_get_int(const char *key, int *dest);2011extern int git_config_get_ulong(const char *key, unsigned long *dest);2012extern int git_config_get_bool(const char *key, int *dest);2013extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);2014extern int git_config_get_maybe_bool(const char *key, int *dest);2015extern int git_config_get_pathname(const char *key, const char **dest);2016extern int git_config_get_untracked_cache(void);2017extern int git_config_get_split_index(void);2018extern int git_config_get_max_percent_split_change(void);20192020/* This dies if the configured or default date is in the future */2021extern int git_config_get_expiry(const char *key, const char **output);20222023/*2024 * This is a hack for test programs like test-dump-untracked-cache to2025 * ensure that they do not modify the untracked cache when reading it.2026 * Do not use it otherwise!2027 */2028extern int ignore_untracked_cache_config;20292030struct key_value_info {2031 const char *filename;2032 int linenr;2033 enum config_origin_type origin_type;2034 enum config_scope scope;2035};20362037extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));2038extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);20392040extern int committer_ident_sufficiently_given(void);2041extern int author_ident_sufficiently_given(void);20422043extern const char *git_commit_encoding;2044extern const char *git_log_output_encoding;2045extern const char *git_mailmap_file;2046extern const char *git_mailmap_blob;20472048/* IO helper functions */2049extern void maybe_flush_or_die(FILE *, const char *);2050__attribute__((format (printf, 2, 3)))2051extern void fprintf_or_die(FILE *, const char *fmt, ...);20522053#define COPY_READ_ERROR (-2)2054#define COPY_WRITE_ERROR (-3)2055extern int copy_fd(int ifd, int ofd);2056extern int copy_file(const char *dst, const char *src, int mode);2057extern int copy_file_with_time(const char *dst, const char *src, int mode);20582059extern void write_or_die(int fd, const void *buf, size_t count);2060extern void fsync_or_die(int fd, const char *);20612062extern ssize_t read_in_full(int fd, void *buf, size_t count);2063extern ssize_t write_in_full(int fd, const void *buf, size_t count);2064extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);20652066static inline ssize_t write_str_in_full(int fd, const char *str)2067{2068 return write_in_full(fd, str, strlen(str));2069}20702071/**2072 * Open (and truncate) the file at path, write the contents of buf to it,2073 * and close it. Dies if any errors are encountered.2074 */2075extern void write_file_buf(const char *path, const char *buf, size_t len);20762077/**2078 * Like write_file_buf(), but format the contents into a buffer first.2079 * Additionally, write_file() will append a newline if one is not already2080 * present, making it convenient to write text files:2081 *2082 * write_file(path, "counter: %d", ctr);2083 */2084__attribute__((format (printf, 2, 3)))2085extern void write_file(const char *path, const char *fmt, ...);20862087/* pager.c */2088extern void setup_pager(void);2089extern int pager_in_use(void);2090extern int pager_use_color;2091extern int term_columns(void);2092extern int decimal_width(uintmax_t);2093extern int check_pager_config(const char *cmd);2094extern void prepare_pager_args(struct child_process *, const char *pager);20952096extern const char *editor_program;2097extern const char *askpass_program;2098extern const char *excludes_file;20992100/* base85 */2101int decode_85(char *dst, const char *line, int linelen);2102void encode_85(char *buf, const unsigned char *data, int bytes);21032104/* alloc.c */2105extern void *alloc_blob_node(void);2106extern void *alloc_tree_node(void);2107extern void *alloc_commit_node(void);2108extern void *alloc_tag_node(void);2109extern void *alloc_object_node(void);2110extern void alloc_report(void);2111extern unsigned int alloc_commit_index(void);21122113/* pkt-line.c */2114void packet_trace_identity(const char *prog);21152116/* add */2117/*2118 * return 0 if success, 1 - if addition of a file failed and2119 * ADD_FILES_IGNORE_ERRORS was specified in flags2120 */2121int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);21222123/* diff.c */2124extern int diff_auto_refresh_index;21252126/* match-trees.c */2127void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);2128void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);21292130/*2131 * whitespace rules.2132 * used by both diff and apply2133 * last two digits are tab width2134 */2135#define WS_BLANK_AT_EOL 01002136#define WS_SPACE_BEFORE_TAB 02002137#define WS_INDENT_WITH_NON_TAB 04002138#define WS_CR_AT_EOL 010002139#define WS_BLANK_AT_EOF 020002140#define WS_TAB_IN_INDENT 040002141#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)2142#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)2143#define WS_TAB_WIDTH_MASK 0772144extern unsigned whitespace_rule_cfg;2145extern unsigned whitespace_rule(const char *);2146extern unsigned parse_whitespace_rule(const char *);2147extern unsigned ws_check(const char *line, int len, unsigned ws_rule);2148extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);2149extern char *whitespace_error_string(unsigned ws);2150extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);2151extern int ws_blank_line(const char *line, int len, unsigned ws_rule);2152#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)21532154/* ls-files */2155void overlay_tree_on_cache(const char *tree_name, const char *prefix);21562157char *alias_lookup(const char *alias);2158int split_cmdline(char *cmdline, const char ***argv);2159/* Takes a negative value returned by split_cmdline */2160const char *split_cmdline_strerror(int cmdline_errno);21612162/* setup.c */2163struct startup_info {2164 int have_repository;2165 const char *prefix;2166};2167extern struct startup_info *startup_info;21682169/* merge.c */2170struct commit_list;2171int try_merge_command(const char *strategy, size_t xopts_nr,2172 const char **xopts, struct commit_list *common,2173 const char *head_arg, struct commit_list *remotes);2174int checkout_fast_forward(const unsigned char *from,2175 const unsigned char *to,2176 int overwrite_ignore);217721782179int sane_execvp(const char *file, char *const argv[]);21802181/*2182 * A struct to encapsulate the concept of whether a file has changed2183 * since we last checked it. This uses criteria similar to those used2184 * for the index.2185 */2186struct stat_validity {2187 struct stat_data *sd;2188};21892190void stat_validity_clear(struct stat_validity *sv);21912192/*2193 * Returns 1 if the path is a regular file (or a symlink to a regular2194 * file) and matches the saved stat_validity, 0 otherwise. A missing2195 * or inaccessible file is considered a match if the struct was just2196 * initialized, or if the previous update found an inaccessible file.2197 */2198int stat_validity_check(struct stat_validity *sv, const char *path);21992200/*2201 * Update the stat_validity from a file opened at descriptor fd. If2202 * the file is missing, inaccessible, or not a regular file, then2203 * future calls to stat_validity_check will match iff one of those2204 * conditions continues to be true.2205 */2206void stat_validity_update(struct stat_validity *sv, int fd);22072208int versioncmp(const char *s1, const char *s2);2209void sleep_millisec(int millisec);22102211/*2212 * Create a directory and (if share is nonzero) adjust its permissions2213 * according to the shared_repository setting. Only use this for2214 * directories under $GIT_DIR. Don't use it for working tree2215 * directories.2216 */2217void safe_create_dir(const char *dir, int share);22182219#endif /* CACHE_H */