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"list.h" 8#include"advice.h" 9#include"gettext.h" 10#include"convert.h" 11#include"trace.h" 12#include"string-list.h" 13#include"pack-revindex.h" 14#include"hash.h" 15#include"path.h" 16#include"sha1-array.h" 17#include"repository.h" 18 19#include <zlib.h> 20typedefstruct git_zstream { 21 z_stream z; 22unsigned long avail_in; 23unsigned long avail_out; 24unsigned long total_in; 25unsigned long total_out; 26unsigned char*next_in; 27unsigned char*next_out; 28} git_zstream; 29 30voidgit_inflate_init(git_zstream *); 31voidgit_inflate_init_gzip_only(git_zstream *); 32voidgit_inflate_end(git_zstream *); 33intgit_inflate(git_zstream *,int flush); 34 35voidgit_deflate_init(git_zstream *,int level); 36voidgit_deflate_init_gzip(git_zstream *,int level); 37voidgit_deflate_init_raw(git_zstream *,int level); 38voidgit_deflate_end(git_zstream *); 39intgit_deflate_abort(git_zstream *); 40intgit_deflate_end_gently(git_zstream *); 41intgit_deflate(git_zstream *,int flush); 42unsigned longgit_deflate_bound(git_zstream *,unsigned long); 43 44/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 45#define GIT_SHA1_RAWSZ 20 46#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 47 48/* The length in byte and in hex digits of the largest possible hash value. */ 49#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 50#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 51 52struct object_id { 53unsigned char hash[GIT_MAX_RAWSZ]; 54}; 55 56#define the_hash_algo the_repository->hash_algo 57 58#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 59#define DTYPE(de) ((de)->d_type) 60#else 61#undef DT_UNKNOWN 62#undef DT_DIR 63#undef DT_REG 64#undef DT_LNK 65#define DT_UNKNOWN 0 66#define DT_DIR 1 67#define DT_REG 2 68#define DT_LNK 3 69#define DTYPE(de) DT_UNKNOWN 70#endif 71 72/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 73#define S_IFINVALID 0030000 74 75/* 76 * A "directory link" is a link to another git directory. 77 * 78 * The value 0160000 is not normally a valid mode, and 79 * also just happens to be S_IFDIR + S_IFLNK 80 */ 81#define S_IFGITLINK 0160000 82#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 83 84/* 85 * Some mode bits are also used internally for computations. 86 * 87 * They *must* not overlap with any valid modes, and they *must* not be emitted 88 * to outside world - i.e. appear on disk or network. In other words, it's just 89 * temporary fields, which we internally use, but they have to stay in-house. 90 * 91 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 92 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 93 */ 94 95/* used internally in tree-diff */ 96#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 97 98 99/* 100 * Intensive research over the course of many years has shown that 101 * port 9418 is totally unused by anything else. Or 102 * 103 * Your search - "port 9418" - did not match any documents. 104 * 105 * as www.google.com puts it. 106 * 107 * This port has been properly assigned for git use by IANA: 108 * git (Assigned-9418) [I06-050728-0001]. 109 * 110 * git 9418/tcp git pack transfer service 111 * git 9418/udp git pack transfer service 112 * 113 * with Linus Torvalds <torvalds@osdl.org> as the point of 114 * contact. September 2005. 115 * 116 * See http://www.iana.org/assignments/port-numbers 117 */ 118#define DEFAULT_GIT_PORT 9418 119 120/* 121 * Basic data structures for the directory cache 122 */ 123 124#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 125struct cache_header { 126uint32_t hdr_signature; 127uint32_t hdr_version; 128uint32_t hdr_entries; 129}; 130 131#define INDEX_FORMAT_LB 2 132#define INDEX_FORMAT_UB 4 133 134/* 135 * The "cache_time" is just the low 32 bits of the 136 * time. It doesn't matter if it overflows - we only 137 * check it for equality in the 32 bits we save. 138 */ 139struct cache_time { 140uint32_t sec; 141uint32_t nsec; 142}; 143 144struct stat_data { 145struct cache_time sd_ctime; 146struct cache_time sd_mtime; 147unsigned int sd_dev; 148unsigned int sd_ino; 149unsigned int sd_uid; 150unsigned int sd_gid; 151unsigned int sd_size; 152}; 153 154struct cache_entry { 155struct hashmap_entry ent; 156struct stat_data ce_stat_data; 157unsigned int ce_mode; 158unsigned int ce_flags; 159unsigned int ce_namelen; 160unsigned int index;/* for link extension */ 161struct object_id oid; 162char name[FLEX_ARRAY];/* more */ 163}; 164 165#define CE_STAGEMASK (0x3000) 166#define CE_EXTENDED (0x4000) 167#define CE_VALID (0x8000) 168#define CE_STAGESHIFT 12 169 170/* 171 * Range 0xFFFF0FFF in ce_flags is divided into 172 * two parts: in-memory flags and on-disk ones. 173 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 174 * if you want to save a new flag, add it in 175 * CE_EXTENDED_FLAGS 176 * 177 * In-memory only flags 178 */ 179#define CE_UPDATE (1 << 16) 180#define CE_REMOVE (1 << 17) 181#define CE_UPTODATE (1 << 18) 182#define CE_ADDED (1 << 19) 183 184#define CE_HASHED (1 << 20) 185#define CE_FSMONITOR_VALID (1 << 21) 186#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 187#define CE_CONFLICTED (1 << 23) 188 189#define CE_UNPACKED (1 << 24) 190#define CE_NEW_SKIP_WORKTREE (1 << 25) 191 192/* used to temporarily mark paths matched by pathspecs */ 193#define CE_MATCHED (1 << 26) 194 195#define CE_UPDATE_IN_BASE (1 << 27) 196#define CE_STRIP_NAME (1 << 28) 197 198/* 199 * Extended on-disk flags 200 */ 201#define CE_INTENT_TO_ADD (1 << 29) 202#define CE_SKIP_WORKTREE (1 << 30) 203/* CE_EXTENDED2 is for future extension */ 204#define CE_EXTENDED2 (1U << 31) 205 206#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 207 208/* 209 * Safeguard to avoid saving wrong flags: 210 * - CE_EXTENDED2 won't get saved until its semantic is known 211 * - Bits in 0x0000FFFF have been saved in ce_flags already 212 * - Bits in 0x003F0000 are currently in-memory flags 213 */ 214#if CE_EXTENDED_FLAGS & 0x803FFFFF 215#error"CE_EXTENDED_FLAGS out of range" 216#endif 217 218/* Forward structure decls */ 219struct pathspec; 220struct child_process; 221 222/* 223 * Copy the sha1 and stat state of a cache entry from one to 224 * another. But we never change the name, or the hash state! 225 */ 226staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 227const struct cache_entry *src) 228{ 229unsigned int state = dst->ce_flags & CE_HASHED; 230 231/* Don't copy hash chain and name */ 232memcpy(&dst->ce_stat_data, &src->ce_stat_data, 233offsetof(struct cache_entry, name) - 234offsetof(struct cache_entry, ce_stat_data)); 235 236/* Restore the hash state */ 237 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 238} 239 240staticinlineunsignedcreate_ce_flags(unsigned stage) 241{ 242return(stage << CE_STAGESHIFT); 243} 244 245#define ce_namelen(ce) ((ce)->ce_namelen) 246#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 247#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 248#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 249#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 250#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 251#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 252 253#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 254staticinlineunsigned intcreate_ce_mode(unsigned int mode) 255{ 256if(S_ISLNK(mode)) 257return S_IFLNK; 258if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 259return S_IFGITLINK; 260return S_IFREG |ce_permissions(mode); 261} 262staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 263unsigned int mode) 264{ 265externint trust_executable_bit, has_symlinks; 266if(!has_symlinks &&S_ISREG(mode) && 267 ce &&S_ISLNK(ce->ce_mode)) 268return ce->ce_mode; 269if(!trust_executable_bit &&S_ISREG(mode)) { 270if(ce &&S_ISREG(ce->ce_mode)) 271return ce->ce_mode; 272returncreate_ce_mode(0666); 273} 274returncreate_ce_mode(mode); 275} 276staticinlineintce_to_dtype(const struct cache_entry *ce) 277{ 278unsigned ce_mode =ntohl(ce->ce_mode); 279if(S_ISREG(ce_mode)) 280return DT_REG; 281else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 282return DT_DIR; 283else if(S_ISLNK(ce_mode)) 284return DT_LNK; 285else 286return DT_UNKNOWN; 287} 288staticinlineunsigned intcanon_mode(unsigned int mode) 289{ 290if(S_ISREG(mode)) 291return S_IFREG |ce_permissions(mode); 292if(S_ISLNK(mode)) 293return S_IFLNK; 294if(S_ISDIR(mode)) 295return S_IFDIR; 296return S_IFGITLINK; 297} 298 299#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 300 301#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 302#define CE_ENTRY_CHANGED (1 << 1) 303#define CE_ENTRY_REMOVED (1 << 2) 304#define CE_ENTRY_ADDED (1 << 3) 305#define RESOLVE_UNDO_CHANGED (1 << 4) 306#define CACHE_TREE_CHANGED (1 << 5) 307#define SPLIT_INDEX_ORDERED (1 << 6) 308#define UNTRACKED_CHANGED (1 << 7) 309#define FSMONITOR_CHANGED (1 << 8) 310 311struct split_index; 312struct untracked_cache; 313 314struct index_state { 315struct cache_entry **cache; 316unsigned int version; 317unsigned int cache_nr, cache_alloc, cache_changed; 318struct string_list *resolve_undo; 319struct cache_tree *cache_tree; 320struct split_index *split_index; 321struct cache_time timestamp; 322unsigned name_hash_initialized :1, 323 initialized :1, 324 drop_cache_tree :1; 325struct hashmap name_hash; 326struct hashmap dir_hash; 327unsigned char sha1[20]; 328struct untracked_cache *untracked; 329uint64_t fsmonitor_last_update; 330struct ewah_bitmap *fsmonitor_dirty; 331}; 332 333externstruct index_state the_index; 334 335/* Name hashing */ 336externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 337externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 338externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 339externvoidfree_name_hash(struct index_state *istate); 340 341 342#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 343#define active_cache (the_index.cache) 344#define active_nr (the_index.cache_nr) 345#define active_alloc (the_index.cache_alloc) 346#define active_cache_changed (the_index.cache_changed) 347#define active_cache_tree (the_index.cache_tree) 348 349#define read_cache() read_index(&the_index) 350#define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir())) 351#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 352#define is_cache_unborn() is_index_unborn(&the_index) 353#define read_cache_unmerged() read_index_unmerged(&the_index) 354#define discard_cache() discard_index(&the_index) 355#define unmerged_cache() unmerged_index(&the_index) 356#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 357#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 358#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 359#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 360#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 361#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 362#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 363#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 364#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 365#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 366#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 367#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 368#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 369#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 370#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 371#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 372#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 373#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 374#endif 375 376enum object_type { 377 OBJ_BAD = -1, 378 OBJ_NONE =0, 379 OBJ_COMMIT =1, 380 OBJ_TREE =2, 381 OBJ_BLOB =3, 382 OBJ_TAG =4, 383/* 5 for future expansion */ 384 OBJ_OFS_DELTA =6, 385 OBJ_REF_DELTA =7, 386 OBJ_ANY, 387 OBJ_MAX 388}; 389 390staticinlineenum object_type object_type(unsigned int mode) 391{ 392returnS_ISDIR(mode) ? OBJ_TREE : 393S_ISGITLINK(mode) ? OBJ_COMMIT : 394 OBJ_BLOB; 395} 396 397/* Double-check local_repo_env below if you add to this list. */ 398#define GIT_DIR_ENVIRONMENT"GIT_DIR" 399#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 400#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 401#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 402#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 403#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 404#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 405#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 406#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 407#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 408#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 409#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 410#define CONFIG_ENVIRONMENT"GIT_CONFIG" 411#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 412#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 413#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 414#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 415#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 416#define GITATTRIBUTES_FILE".gitattributes" 417#define INFOATTRIBUTES_FILE"info/attributes" 418#define ATTRIBUTE_MACRO_PREFIX"[attr]" 419#define GITMODULES_FILE".gitmodules" 420#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 421#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 422#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 423#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 424#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 425#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 426#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 427#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 428#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 429#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 430#define GIT_OPTIONAL_LOCKS_ENVIRONMENT"GIT_OPTIONAL_LOCKS" 431 432/* 433 * Environment variable used in handshaking the wire protocol. 434 * Contains a colon ':' separated list of keys with optional values 435 * 'key[=value]'. Presence of unknown keys and values must be 436 * ignored. 437 */ 438#define GIT_PROTOCOL_ENVIRONMENT"GIT_PROTOCOL" 439/* HTTP header used to handshake the wire protocol */ 440#define GIT_PROTOCOL_HEADER"Git-Protocol" 441 442/* 443 * This environment variable is expected to contain a boolean indicating 444 * whether we should or should not treat: 445 * 446 * GIT_DIR=foo.git git ... 447 * 448 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 449 * of this, but we use it internally to communicate to sub-processes that we 450 * are in a bare repo. If not set, defaults to true. 451 */ 452#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 453 454/* 455 * Repository-local GIT_* environment variables; these will be cleared 456 * when git spawns a sub-process that runs inside another repository. 457 * The array is NULL-terminated, which makes it easy to pass in the "env" 458 * parameter of a run-command invocation, or to do a simple walk. 459 */ 460externconst char*const local_repo_env[]; 461 462externvoidsetup_git_env(const char*git_dir); 463 464/* 465 * Returns true iff we have a configured git repository (either via 466 * setup_git_directory, or in the environment via $GIT_DIR). 467 */ 468inthave_git_dir(void); 469 470externint is_bare_repository_cfg; 471externintis_bare_repository(void); 472externintis_inside_git_dir(void); 473externchar*git_work_tree_cfg; 474externintis_inside_work_tree(void); 475externconst char*get_git_dir(void); 476externconst char*get_git_common_dir(void); 477externchar*get_object_directory(void); 478externchar*get_index_file(void); 479externchar*get_graft_file(struct repository *r); 480externintset_git_dir(const char*path); 481externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 482externintget_common_dir(struct strbuf *sb,const char*gitdir); 483externconst char*get_git_namespace(void); 484externconst char*strip_namespace(const char*namespaced_ref); 485externconst char*get_super_prefix(void); 486externconst char*get_git_work_tree(void); 487 488/* 489 * Return true if the given path is a git directory; note that this _just_ 490 * looks at the directory itself. If you want to know whether "foo/.git" 491 * is a repository, you must feed that path, not just "foo". 492 */ 493externintis_git_directory(const char*path); 494 495/* 496 * Return 1 if the given path is the root of a git repository or 497 * submodule, else 0. Will not return 1 for bare repositories with the 498 * exception of creating a bare repository in "foo/.git" and calling 499 * is_git_repository("foo"). 500 * 501 * If we run into read errors, we err on the side of saying "yes, it is", 502 * as we usually consider sub-repos precious, and would prefer to err on the 503 * side of not disrupting or deleting them. 504 */ 505externintis_nonbare_repository_dir(struct strbuf *path); 506 507#define READ_GITFILE_ERR_STAT_FAILED 1 508#define READ_GITFILE_ERR_NOT_A_FILE 2 509#define READ_GITFILE_ERR_OPEN_FAILED 3 510#define READ_GITFILE_ERR_READ_FAILED 4 511#define READ_GITFILE_ERR_INVALID_FORMAT 5 512#define READ_GITFILE_ERR_NO_PATH 6 513#define READ_GITFILE_ERR_NOT_A_REPO 7 514#define READ_GITFILE_ERR_TOO_LARGE 8 515externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 516externconst char*read_gitfile_gently(const char*path,int*return_error_code); 517#define read_gitfile(path) read_gitfile_gently((path), NULL) 518externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 519#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 520 521externvoidset_git_work_tree(const char*tree); 522 523#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 524 525externvoidsetup_work_tree(void); 526/* 527 * Find the commondir and gitdir of the repository that contains the current 528 * working directory, without changing the working directory or other global 529 * state. The result is appended to commondir and gitdir. If the discovered 530 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 531 * both have the same result appended to the buffer. The return value is 532 * either 0 upon success and non-zero if no repository was found. 533 */ 534externintdiscover_git_directory(struct strbuf *commondir, 535struct strbuf *gitdir); 536externconst char*setup_git_directory_gently(int*); 537externconst char*setup_git_directory(void); 538externchar*prefix_path(const char*prefix,int len,const char*path); 539externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 540 541/* 542 * Concatenate "prefix" (if len is non-zero) and "path", with no 543 * connecting characters (so "prefix" should end with a "/"). 544 * Unlike prefix_path, this should be used if the named file does 545 * not have to interact with index entry; i.e. name of a random file 546 * on the filesystem. 547 * 548 * The return value is always a newly allocated string (even if the 549 * prefix was empty). 550 */ 551externchar*prefix_filename(const char*prefix,const char*path); 552 553externintcheck_filename(const char*prefix,const char*name); 554externvoidverify_filename(const char*prefix, 555const char*name, 556int diagnose_misspelt_rev); 557externvoidverify_non_filename(const char*prefix,const char*name); 558externintpath_inside_repo(const char*prefix,const char*path); 559 560#define INIT_DB_QUIET 0x0001 561#define INIT_DB_EXIST_OK 0x0002 562 563externintinit_db(const char*git_dir,const char*real_git_dir, 564const char*template_dir,unsigned int flags); 565 566externvoidsanitize_stdfds(void); 567externintdaemonize(void); 568 569#define alloc_nr(x) (((x)+16)*3/2) 570 571/* 572 * Realloc the buffer pointed at by variable 'x' so that it can hold 573 * at least 'nr' entries; the number of entries currently allocated 574 * is 'alloc', using the standard growing factor alloc_nr() macro. 575 * 576 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 577 */ 578#define ALLOC_GROW(x, nr, alloc) \ 579 do { \ 580 if ((nr) > alloc) { \ 581 if (alloc_nr(alloc) < (nr)) \ 582 alloc = (nr); \ 583 else \ 584 alloc = alloc_nr(alloc); \ 585 REALLOC_ARRAY(x, alloc); \ 586 } \ 587 } while (0) 588 589/* Initialize and use the cache information */ 590struct lock_file; 591externintread_index(struct index_state *); 592externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 593externintdo_read_index(struct index_state *istate,const char*path, 594int must_exist);/* for testting only! */ 595externintread_index_from(struct index_state *,const char*path, 596const char*gitdir); 597externintis_index_unborn(struct index_state *); 598externintread_index_unmerged(struct index_state *); 599 600/* For use with `write_locked_index()`. */ 601#define COMMIT_LOCK (1 << 0) 602#define SKIP_IF_UNCHANGED (1 << 1) 603 604/* 605 * Write the index while holding an already-taken lock. Close the lock, 606 * and if `COMMIT_LOCK` is given, commit it. 607 * 608 * Unless a split index is in use, write the index into the lockfile. 609 * 610 * With a split index, write the shared index to a temporary file, 611 * adjust its permissions and rename it into place, then write the 612 * split index to the lockfile. If the temporary file for the shared 613 * index cannot be created, fall back to the behavior described in 614 * the previous paragraph. 615 * 616 * With `COMMIT_LOCK`, the lock is always committed or rolled back. 617 * Without it, the lock is closed, but neither committed nor rolled 618 * back. 619 * 620 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing 621 * is written (and the lock is rolled back if `COMMIT_LOCK` is given). 622 */ 623externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 624 625externintdiscard_index(struct index_state *); 626externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 627externintunmerged_index(const struct index_state *); 628 629/** 630 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn 631 * branch, returns 1 if there are entries in the index, 0 otherwise. If an 632 * strbuf is provided, the space-separated list of files that differ will be 633 * appended to it. 634 */ 635externintindex_has_changes(struct strbuf *sb); 636 637externintverify_path(const char*path); 638externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 639externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 640externvoidadjust_dirname_case(struct index_state *istate,char*name); 641externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 642 643/* 644 * Searches for an entry defined by name and namelen in the given index. 645 * If the return value is positive (including 0) it is the position of an 646 * exact match. If the return value is negative, the negated value minus 1 647 * is the position where the entry would be inserted. 648 * Example: The current index consists of these files and its stages: 649 * 650 * b#0, d#0, f#1, f#3 651 * 652 * index_name_pos(&index, "a", 1) -> -1 653 * index_name_pos(&index, "b", 1) -> 0 654 * index_name_pos(&index, "c", 1) -> -2 655 * index_name_pos(&index, "d", 1) -> 1 656 * index_name_pos(&index, "e", 1) -> -3 657 * index_name_pos(&index, "f", 1) -> -3 658 * index_name_pos(&index, "g", 1) -> -5 659 */ 660externintindex_name_pos(const struct index_state *,const char*name,int namelen); 661 662#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 663#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 664#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 665#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 666#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 667#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 668externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 669externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 670 671/* Remove entry, return true if there are more entries to go. */ 672externintremove_index_entry_at(struct index_state *,int pos); 673 674externvoidremove_marked_cache_entries(struct index_state *istate); 675externintremove_file_from_index(struct index_state *,const char*path); 676#define ADD_CACHE_VERBOSE 1 677#define ADD_CACHE_PRETEND 2 678#define ADD_CACHE_IGNORE_ERRORS 4 679#define ADD_CACHE_IGNORE_REMOVAL 8 680#define ADD_CACHE_INTENT 16 681/* 682 * These two are used to add the contents of the file at path 683 * to the index, marking the working tree up-to-date by storing 684 * the cached stat info in the resulting cache entry. A caller 685 * that has already run lstat(2) on the path can call 686 * add_to_index(), and all others can call add_file_to_index(); 687 * the latter will do necessary lstat(2) internally before 688 * calling the former. 689 */ 690externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 691externintadd_file_to_index(struct index_state *,const char*path,int flags); 692 693externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 694externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 695externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 696externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 697externintindex_name_is_other(const struct index_state *,const char*,int); 698externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 699 700/* do stat comparison even if CE_VALID is true */ 701#define CE_MATCH_IGNORE_VALID 01 702/* do not check the contents but report dirty on racily-clean entries */ 703#define CE_MATCH_RACY_IS_DIRTY 02 704/* do stat comparison even if CE_SKIP_WORKTREE is true */ 705#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 706/* ignore non-existent files during stat update */ 707#define CE_MATCH_IGNORE_MISSING 0x08 708/* enable stat refresh */ 709#define CE_MATCH_REFRESH 0x10 710/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */ 711#define CE_MATCH_IGNORE_FSMONITOR 0X20 712externintie_match_stat(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 713externintie_modified(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 714 715#define HASH_WRITE_OBJECT 1 716#define HASH_FORMAT_CHECK 2 717#define HASH_RENORMALIZE 4 718externintindex_fd(struct object_id *oid,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 719externintindex_path(struct object_id *oid,const char*path,struct stat *st,unsigned flags); 720 721/* 722 * Record to sd the data from st that we use to check whether a file 723 * might have changed. 724 */ 725externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 726 727/* 728 * Return 0 if st is consistent with a file not having been changed 729 * since sd was filled. If there are differences, return a 730 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 731 * INODE_CHANGED, and DATA_CHANGED. 732 */ 733externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 734externintmatch_stat_data_racy(const struct index_state *istate, 735const struct stat_data *sd,struct stat *st); 736 737externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 738 739#define REFRESH_REALLY 0x0001/* ignore_valid */ 740#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 741#define REFRESH_QUIET 0x0004/* be quiet about it */ 742#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 743#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 744#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 745externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 746externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 747 748/* 749 * Opportunistically update the index but do not complain if we can't. 750 * The lockfile is always committed or rolled back. 751 */ 752externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 753 754externinthold_locked_index(struct lock_file *,int); 755externvoidset_alternate_index_output(const char*); 756 757externint verify_index_checksum; 758externint verify_ce_order; 759 760/* Environment bits from configuration mechanism */ 761externint trust_executable_bit; 762externint trust_ctime; 763externint check_stat; 764externint quote_path_fully; 765externint has_symlinks; 766externint minimum_abbrev, default_abbrev; 767externint ignore_case; 768externint assume_unchanged; 769externint prefer_symlink_refs; 770externint warn_ambiguous_refs; 771externint warn_on_object_refname_ambiguity; 772externconst char*apply_default_whitespace; 773externconst char*apply_default_ignorewhitespace; 774externconst char*git_attributes_file; 775externconst char*git_hooks_path; 776externint zlib_compression_level; 777externint core_compression_level; 778externint pack_compression_level; 779externsize_t packed_git_window_size; 780externsize_t packed_git_limit; 781externsize_t delta_base_cache_limit; 782externunsigned long big_file_threshold; 783externunsigned long pack_size_limit_cfg; 784 785/* 786 * Accessors for the core.sharedrepository config which lazy-load the value 787 * from the config (if not already set). The "reset" function can be 788 * used to unset "set" or cached value, meaning that the value will be loaded 789 * fresh from the config file on the next call to get_shared_repository(). 790 */ 791voidset_shared_repository(int value); 792intget_shared_repository(void); 793voidreset_shared_repository(void); 794 795/* 796 * Do replace refs need to be checked this run? This variable is 797 * initialized to true unless --no-replace-object is used or 798 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 799 * commands that do not want replace references to be active. As an 800 * optimization it is also set to false if replace references have 801 * been sought but there were none. 802 */ 803externint check_replace_refs; 804externchar*git_replace_ref_base; 805 806externint fsync_object_files; 807externint core_preload_index; 808externint core_apply_sparse_checkout; 809externint precomposed_unicode; 810externint protect_hfs; 811externint protect_ntfs; 812externconst char*core_fsmonitor; 813 814/* 815 * Include broken refs in all ref iterations, which will 816 * generally choke dangerous operations rather than letting 817 * them silently proceed without taking the broken ref into 818 * account. 819 */ 820externint ref_paranoia; 821 822/* 823 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value). 824 */ 825intuse_optional_locks(void); 826 827/* 828 * The character that begins a commented line in user-editable file 829 * that is subject to stripspace. 830 */ 831externchar comment_line_char; 832externint auto_comment_line_char; 833 834/* Windows only */ 835enum hide_dotfiles_type { 836 HIDE_DOTFILES_FALSE =0, 837 HIDE_DOTFILES_TRUE, 838 HIDE_DOTFILES_DOTGITONLY 839}; 840externenum hide_dotfiles_type hide_dotfiles; 841 842enum log_refs_config { 843 LOG_REFS_UNSET = -1, 844 LOG_REFS_NONE =0, 845 LOG_REFS_NORMAL, 846 LOG_REFS_ALWAYS 847}; 848externenum log_refs_config log_all_ref_updates; 849 850enum branch_track { 851 BRANCH_TRACK_UNSPECIFIED = -1, 852 BRANCH_TRACK_NEVER =0, 853 BRANCH_TRACK_REMOTE, 854 BRANCH_TRACK_ALWAYS, 855 BRANCH_TRACK_EXPLICIT, 856 BRANCH_TRACK_OVERRIDE 857}; 858 859enum rebase_setup_type { 860 AUTOREBASE_NEVER =0, 861 AUTOREBASE_LOCAL, 862 AUTOREBASE_REMOTE, 863 AUTOREBASE_ALWAYS 864}; 865 866enum push_default_type { 867 PUSH_DEFAULT_NOTHING =0, 868 PUSH_DEFAULT_MATCHING, 869 PUSH_DEFAULT_SIMPLE, 870 PUSH_DEFAULT_UPSTREAM, 871 PUSH_DEFAULT_CURRENT, 872 PUSH_DEFAULT_UNSPECIFIED 873}; 874 875externenum branch_track git_branch_track; 876externenum rebase_setup_type autorebase; 877externenum push_default_type push_default; 878 879enum object_creation_mode { 880 OBJECT_CREATION_USES_HARDLINKS =0, 881 OBJECT_CREATION_USES_RENAMES =1 882}; 883 884externenum object_creation_mode object_creation_mode; 885 886externchar*notes_ref_name; 887 888externint grafts_replace_parents; 889 890/* 891 * GIT_REPO_VERSION is the version we write by default. The 892 * _READ variant is the highest number we know how to 893 * handle. 894 */ 895#define GIT_REPO_VERSION 0 896#define GIT_REPO_VERSION_READ 1 897externint repository_format_precious_objects; 898externchar*repository_format_partial_clone; 899externconst char*core_partial_clone_filter_default; 900 901struct repository_format { 902int version; 903int precious_objects; 904char*partial_clone;/* value of extensions.partialclone */ 905int is_bare; 906int hash_algo; 907char*work_tree; 908struct string_list unknown_extensions; 909}; 910 911/* 912 * Read the repository format characteristics from the config file "path" into 913 * "format" struct. Returns the numeric version. On error, -1 is returned, 914 * format->version is set to -1, and all other fields in the struct are 915 * undefined. 916 */ 917intread_repository_format(struct repository_format *format,const char*path); 918 919/* 920 * Verify that the repository described by repository_format is something we 921 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 922 * any errors encountered. 923 */ 924intverify_repository_format(const struct repository_format *format, 925struct strbuf *err); 926 927/* 928 * Check the repository format version in the path found in get_git_dir(), 929 * and die if it is a version we don't understand. Generally one would 930 * set_git_dir() before calling this, and use it only for "are we in a valid 931 * repo?". 932 */ 933externvoidcheck_repository_format(void); 934 935#define MTIME_CHANGED 0x0001 936#define CTIME_CHANGED 0x0002 937#define OWNER_CHANGED 0x0004 938#define MODE_CHANGED 0x0008 939#define INODE_CHANGED 0x0010 940#define DATA_CHANGED 0x0020 941#define TYPE_CHANGED 0x0040 942 943/* 944 * Return an abbreviated sha1 unique within this repository's object database. 945 * The result will be at least `len` characters long, and will be NUL 946 * terminated. 947 * 948 * The non-`_r` version returns a static buffer which remains valid until 4 949 * more calls to find_unique_abbrev are made. 950 * 951 * The `_r` variant writes to a buffer supplied by the caller, which must be at 952 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes 953 * written (excluding the NUL terminator). 954 * 955 * Note that while this version avoids the static buffer, it is not fully 956 * reentrant, as it calls into other non-reentrant git code. 957 */ 958externconst char*find_unique_abbrev(const struct object_id *oid,int len); 959externintfind_unique_abbrev_r(char*hex,const struct object_id *oid,int len); 960 961externconst unsigned char null_sha1[GIT_MAX_RAWSZ]; 962externconst struct object_id null_oid; 963 964staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 965{ 966returnmemcmp(sha1, sha2, GIT_SHA1_RAWSZ); 967} 968 969staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 970{ 971returnhashcmp(oid1->hash, oid2->hash); 972} 973 974staticinlineintis_null_sha1(const unsigned char*sha1) 975{ 976return!hashcmp(sha1, null_sha1); 977} 978 979staticinlineintis_null_oid(const struct object_id *oid) 980{ 981return!hashcmp(oid->hash, null_sha1); 982} 983 984staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src) 985{ 986memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 987} 988 989staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src) 990{ 991hashcpy(dst->hash, src->hash); 992} 993 994staticinlinestruct object_id *oiddup(const struct object_id *src) 995{ 996struct object_id *dst =xmalloc(sizeof(struct object_id)); 997oidcpy(dst, src); 998return dst; 999}10001001staticinlinevoidhashclr(unsigned char*hash)1002{1003memset(hash,0, GIT_SHA1_RAWSZ);1004}10051006staticinlinevoidoidclr(struct object_id *oid)1007{1008memset(oid->hash,0, GIT_MAX_RAWSZ);1009}101010111012#define EMPTY_TREE_SHA1_HEX \1013"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1014#define EMPTY_TREE_SHA1_BIN_LITERAL \1015"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1016"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1017externconst struct object_id empty_tree_oid;1018#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10191020#define EMPTY_BLOB_SHA1_HEX \1021"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1022#define EMPTY_BLOB_SHA1_BIN_LITERAL \1023"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1024"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1025externconst struct object_id empty_blob_oid;10261027staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1028{1029return!hashcmp(sha1, the_hash_algo->empty_blob->hash);1030}10311032staticinlineintis_empty_blob_oid(const struct object_id *oid)1033{1034return!oidcmp(oid, the_hash_algo->empty_blob);1035}10361037staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1038{1039return!hashcmp(sha1, the_hash_algo->empty_tree->hash);1040}10411042staticinlineintis_empty_tree_oid(const struct object_id *oid)1043{1044return!oidcmp(oid, the_hash_algo->empty_tree);1045}10461047/* set default permissions by passing mode arguments to open(2) */1048intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1049intgit_mkstemp_mode(char*pattern,int mode);10501051/*1052 * NOTE NOTE NOTE!!1053 *1054 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1055 * not be changed. Old repositories have core.sharedrepository written in1056 * numeric format, and therefore these values are preserved for compatibility1057 * reasons.1058 */1059enum sharedrepo {1060 PERM_UMASK =0,1061 OLD_PERM_GROUP =1,1062 OLD_PERM_EVERYBODY =2,1063 PERM_GROUP =0660,1064 PERM_EVERYBODY =06641065};1066intgit_config_perm(const char*var,const char*value);1067intadjust_shared_perm(const char*path);10681069/*1070 * Create the directory containing the named path, using care to be1071 * somewhat safe against races. Return one of the scld_error values to1072 * indicate success/failure. On error, set errno to describe the1073 * problem.1074 *1075 * SCLD_VANISHED indicates that one of the ancestor directories of the1076 * path existed at one point during the function call and then1077 * suddenly vanished, probably because another process pruned the1078 * directory while we were working. To be robust against this kind of1079 * race, callers might want to try invoking the function again when it1080 * returns SCLD_VANISHED.1081 *1082 * safe_create_leading_directories() temporarily changes path while it1083 * is working but restores it before returning.1084 * safe_create_leading_directories_const() doesn't modify path, even1085 * temporarily.1086 */1087enum scld_error {1088 SCLD_OK =0,1089 SCLD_FAILED = -1,1090 SCLD_PERMS = -2,1091 SCLD_EXISTS = -3,1092 SCLD_VANISHED = -41093};1094enum scld_error safe_create_leading_directories(char*path);1095enum scld_error safe_create_leading_directories_const(const char*path);10961097/*1098 * Callback function for raceproof_create_file(). This function is1099 * expected to do something that makes dirname(path) permanent despite1100 * the fact that other processes might be cleaning up empty1101 * directories at the same time. Usually it will create a file named1102 * path, but alternatively it could create another file in that1103 * directory, or even chdir() into that directory. The function should1104 * return 0 if the action was completed successfully. On error, it1105 * should return a nonzero result and set errno.1106 * raceproof_create_file() treats two errno values specially:1107 *1108 * - ENOENT -- dirname(path) does not exist. In this case,1109 * raceproof_create_file() tries creating dirname(path)1110 * (and any parent directories, if necessary) and calls1111 * the function again.1112 *1113 * - EISDIR -- the file already exists and is a directory. In this1114 * case, raceproof_create_file() removes the directory if1115 * it is empty (and recursively any empty directories that1116 * it contains) and calls the function again.1117 *1118 * Any other errno causes raceproof_create_file() to fail with the1119 * callback's return value and errno.1120 *1121 * Obviously, this function should be OK with being called again if it1122 * fails with ENOENT or EISDIR. In other scenarios it will not be1123 * called again.1124 */1125typedefintcreate_file_fn(const char*path,void*cb);11261127/*1128 * Create a file in dirname(path) by calling fn, creating leading1129 * directories if necessary. Retry a few times in case we are racing1130 * with another process that is trying to clean up the directory that1131 * contains path. See the documentation for create_file_fn for more1132 * details.1133 *1134 * Return the value and set the errno that resulted from the most1135 * recent call of fn. fn is always called at least once, and will be1136 * called more than once if it returns ENOENT or EISDIR.1137 */1138intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11391140intmkdir_in_gitdir(const char*path);1141externchar*expand_user_path(const char*path,int real_home);1142const char*enter_repo(const char*path,int strict);1143staticinlineintis_absolute_path(const char*path)1144{1145returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1146}1147intis_directory(const char*);1148char*strbuf_realpath(struct strbuf *resolved,const char*path,1149int die_on_error);1150const char*real_path(const char*path);1151const char*real_path_if_valid(const char*path);1152char*real_pathdup(const char*path,int die_on_error);1153const char*absolute_path(const char*path);1154char*absolute_pathdup(const char*path);1155const char*remove_leading_path(const char*in,const char*prefix);1156const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1157intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1158intnormalize_path_copy(char*dst,const char*src);1159intlongest_ancestor_length(const char*path,struct string_list *prefixes);1160char*strip_path_suffix(const char*path,const char*suffix);1161intdaemon_avoid_alias(const char*path);1162externintis_ntfs_dotgit(const char*name);11631164/*1165 * Returns true iff "str" could be confused as a command-line option when1166 * passed to a sub-program like "ssh". Note that this has nothing to do with1167 * shell-quoting, which should be handled separately; we're assuming here that1168 * the string makes it verbatim to the sub-program.1169 */1170intlooks_like_command_line_option(const char*str);11711172/**1173 * Return a newly allocated string with the evaluation of1174 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1175 * "$HOME/.config/git/$filename". Return NULL upon error.1176 */1177externchar*xdg_config_home(const char*filename);11781179/**1180 * Return a newly allocated string with the evaluation of1181 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1182 * "$HOME/.cache/git/$filename". Return NULL upon error.1183 */1184externchar*xdg_cache_home(const char*filename);11851186externintgit_open_cloexec(const char*name,int flags);1187#define git_open(name) git_open_cloexec(name, O_RDONLY)1188externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1189externintparse_sha1_header(const char*hdr,unsigned long*sizep);11901191externintcheck_object_signature(const struct object_id *oid,void*buf,unsigned long size,const char*type);11921193externintfinalize_object_file(const char*tmpfile,const char*filename);11941195/* Helper to check and "touch" a file */1196externintcheck_and_freshen_file(const char*fn,int freshen);11971198externconst signed char hexval_table[256];1199staticinlineunsigned inthexval(unsigned char c)1200{1201return hexval_table[c];1202}12031204/*1205 * Convert two consecutive hexadecimal digits into a char. Return a1206 * negative value on error. Don't run over the end of short strings.1207 */1208staticinlineinthex2chr(const char*s)1209{1210unsigned int val =hexval(s[0]);1211return(val & ~0xf) ? val : (val <<4) |hexval(s[1]);1212}12131214/* Convert to/from hex/sha1 representation */1215#define MINIMUM_ABBREV minimum_abbrev1216#define DEFAULT_ABBREV default_abbrev12171218/* used when the code does not know or care what the default abbrev is */1219#define FALLBACK_DEFAULT_ABBREV 712201221struct object_context {1222unsigned char tree[20];1223unsigned mode;1224/*1225 * symlink_path is only used by get_tree_entry_follow_symlinks,1226 * and only for symlinks that point outside the repository.1227 */1228struct strbuf symlink_path;1229/*1230 * If GET_OID_RECORD_PATH is set, this will record path (if any)1231 * found when resolving the name. The caller is responsible for1232 * releasing the memory.1233 */1234char*path;1235};12361237#define GET_OID_QUIETLY 011238#define GET_OID_COMMIT 021239#define GET_OID_COMMITTISH 041240#define GET_OID_TREE 0101241#define GET_OID_TREEISH 0201242#define GET_OID_BLOB 0401243#define GET_OID_FOLLOW_SYMLINKS 01001244#define GET_OID_RECORD_PATH 02001245#define GET_OID_ONLY_TO_DIE 0400012461247#define GET_OID_DISAMBIGUATORS \1248 (GET_OID_COMMIT | GET_OID_COMMITTISH | \1249 GET_OID_TREE | GET_OID_TREEISH | \1250 GET_OID_BLOB)12511252externintget_oid(const char*str,struct object_id *oid);1253externintget_oid_commit(const char*str,struct object_id *oid);1254externintget_oid_committish(const char*str,struct object_id *oid);1255externintget_oid_tree(const char*str,struct object_id *oid);1256externintget_oid_treeish(const char*str,struct object_id *oid);1257externintget_oid_blob(const char*str,struct object_id *oid);1258externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1259externintget_oid_with_context(const char*str,unsigned flags,struct object_id *oid,struct object_context *oc);126012611262typedefinteach_abbrev_fn(const struct object_id *oid,void*);1263externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);12641265externintset_disambiguate_hint_config(const char*var,const char*value);12661267/*1268 * Try to read a SHA1 in hexadecimal format from the 40 characters1269 * starting at hex. Write the 20-byte result to sha1 in binary form.1270 * Return 0 on success. Reading stops if a NUL is encountered in the1271 * input, so it is safe to pass this function an arbitrary1272 * null-terminated string.1273 */1274externintget_sha1_hex(const char*hex,unsigned char*sha1);1275externintget_oid_hex(const char*hex,struct object_id *sha1);12761277/*1278 * Read `len` pairs of hexadecimal digits from `hex` and write the1279 * values to `binary` as `len` bytes. Return 0 on success, or -1 if1280 * the input does not consist of hex digits).1281 */1282externinthex_to_bytes(unsigned char*binary,const char*hex,size_t len);12831284/*1285 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1286 * and writes the NUL-terminated output to the buffer `out`, which must be at1287 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1288 * convenience.1289 *1290 * The non-`_r` variant returns a static buffer, but uses a ring of 41291 * buffers, making it safe to make multiple calls for a single statement, like:1292 *1293 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1294 */1295externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1296externchar*oid_to_hex_r(char*out,const struct object_id *oid);1297externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1298externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */12991300/*1301 * Parse a 40-character hexadecimal object ID starting from hex, updating the1302 * pointer specified by end when parsing stops. The resulting object ID is1303 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1304 * other invalid character. end is only updated on success; otherwise, it is1305 * unmodified.1306 */1307externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);13081309/*1310 * This reads short-hand syntax that not only evaluates to a commit1311 * object name, but also can act as if the end user spelled the name1312 * of the branch from the command line.1313 *1314 * - "@{-N}" finds the name of the Nth previous branch we were on, and1315 * places the name of the branch in the given buf and returns the1316 * number of characters parsed if successful.1317 *1318 * - "<branch>@{upstream}" finds the name of the other ref that1319 * <branch> is configured to merge with (missing <branch> defaults1320 * to the current branch), and places the name of the branch in the1321 * given buf and returns the number of characters parsed if1322 * successful.1323 *1324 * If the input is not of the accepted format, it returns a negative1325 * number to signal an error.1326 *1327 * If the input was ok but there are not N branch switches in the1328 * reflog, it returns 0.1329 *1330 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1331 * expansions: local branches ("refs/heads/"), remote branches1332 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1333 * allowed, even ones to refs outside of those namespaces.1334 */1335#define INTERPRET_BRANCH_LOCAL (1<<0)1336#define INTERPRET_BRANCH_REMOTE (1<<1)1337#define INTERPRET_BRANCH_HEAD (1<<2)1338externintinterpret_branch_name(const char*str,int len,struct strbuf *,1339unsigned allowed);1340externintget_oid_mb(const char*str,struct object_id *oid);13411342externintvalidate_headref(const char*ref);13431344externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1345externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1346externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1347externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);13481349externvoid*read_object_with_reference(const struct object_id *oid,1350const char*required_type,1351unsigned long*size,1352struct object_id *oid_ret);13531354externstruct object *peel_to_type(const char*name,int namelen,1355struct object *o,enum object_type);13561357struct date_mode {1358enum date_mode_type {1359 DATE_NORMAL =0,1360 DATE_RELATIVE,1361 DATE_SHORT,1362 DATE_ISO8601,1363 DATE_ISO8601_STRICT,1364 DATE_RFC2822,1365 DATE_STRFTIME,1366 DATE_RAW,1367 DATE_UNIX1368} type;1369const char*strftime_fmt;1370int local;1371};13721373/*1374 * Convenience helper for passing a constant type, like:1375 *1376 * show_date(t, tz, DATE_MODE(NORMAL));1377 */1378#define DATE_MODE(t) date_mode_from_type(DATE_##t)1379struct date_mode *date_mode_from_type(enum date_mode_type type);13801381const char*show_date(timestamp_t time,int timezone,const struct date_mode *mode);1382voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1383struct strbuf *timebuf);1384intparse_date(const char*date,struct strbuf *out);1385intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1386intparse_expiry_date(const char*date, timestamp_t *timestamp);1387voiddatestamp(struct strbuf *out);1388#define approxidate(s) approxidate_careful((s), NULL)1389timestamp_t approxidate_careful(const char*,int*);1390timestamp_t approxidate_relative(const char*date,const struct timeval *now);1391voidparse_date_format(const char*format,struct date_mode *mode);1392intdate_overflows(timestamp_t date);13931394#define IDENT_STRICT 11395#define IDENT_NO_DATE 21396#define IDENT_NO_NAME 41397externconst char*git_author_info(int);1398externconst char*git_committer_info(int);1399externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1400externconst char*fmt_name(const char*name,const char*email);1401externconst char*ident_default_name(void);1402externconst char*ident_default_email(void);1403externconst char*git_editor(void);1404externconst char*git_pager(int stdout_is_tty);1405externintis_terminal_dumb(void);1406externintgit_ident_config(const char*,const char*,void*);1407externvoidreset_ident_date(void);14081409struct ident_split {1410const char*name_begin;1411const char*name_end;1412const char*mail_begin;1413const char*mail_end;1414const char*date_begin;1415const char*date_end;1416const char*tz_begin;1417const char*tz_end;1418};1419/*1420 * Signals an success with 0, but time part of the result may be NULL1421 * if the input lacks timestamp and zone1422 */1423externintsplit_ident_line(struct ident_split *,const char*,int);14241425/*1426 * Like show_date, but pull the timestamp and tz parameters from1427 * the ident_split. It will also sanity-check the values and produce1428 * a well-known sentinel date if they appear bogus.1429 */1430const char*show_ident_date(const struct ident_split *id,1431const struct date_mode *mode);14321433/*1434 * Compare split idents for equality or strict ordering. Note that we1435 * compare only the ident part of the line, ignoring any timestamp.1436 *1437 * Because there are two fields, we must choose one as the primary key; we1438 * currently arbitrarily pick the email.1439 */1440externintident_cmp(const struct ident_split *,const struct ident_split *);14411442struct checkout {1443struct index_state *istate;1444const char*base_dir;1445int base_dir_len;1446struct delayed_checkout *delayed_checkout;1447unsigned force:1,1448 quiet:1,1449 not_new:1,1450 refresh_cache:1;1451};1452#define CHECKOUT_INIT { NULL,"" }14531454#define TEMPORARY_FILENAME_LENGTH 251455externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);1456externvoidenable_delayed_checkout(struct checkout *state);1457externintfinish_delayed_checkout(struct checkout *state);14581459struct cache_def {1460struct strbuf path;1461int flags;1462int track_flags;1463int prefix_len_stat_func;1464};1465#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1466staticinlinevoidcache_def_clear(struct cache_def *cache)1467{1468strbuf_release(&cache->path);1469}14701471externinthas_symlink_leading_path(const char*name,int len);1472externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1473externintcheck_leading_path(const char*name,int len);1474externinthas_dirs_only_path(const char*name,int len,int prefix_len);1475externvoidschedule_dir_for_removal(const char*name,int len);1476externvoidremove_scheduled_dirs(void);14771478struct pack_window {1479struct pack_window *next;1480unsigned char*base;1481 off_t offset;1482size_t len;1483unsigned int last_used;1484unsigned int inuse_cnt;1485};14861487struct pack_entry {1488 off_t offset;1489unsigned char sha1[20];1490struct packed_git *p;1491};14921493/*1494 * Create a temporary file rooted in the object database directory, or1495 * die on failure. The filename is taken from "pattern", which should have the1496 * usual "XXXXXX" trailer, and the resulting filename is written into the1497 * "template" buffer. Returns the open descriptor.1498 */1499externintodb_mkstemp(struct strbuf *temp_filename,const char*pattern);15001501/*1502 * Create a pack .keep file named "name" (which should generally be the output1503 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1504 * error.1505 */1506externintodb_pack_keep(const char*name);15071508/*1509 * Iterate over the files in the loose-object parts of the object1510 * directory "path", triggering the following callbacks:1511 *1512 * - loose_object is called for each loose object we find.1513 *1514 * - loose_cruft is called for any files that do not appear to be1515 * loose objects. Note that we only look in the loose object1516 * directories "objects/[0-9a-f]{2}/", so we will not report1517 * "objects/foobar" as cruft.1518 *1519 * - loose_subdir is called for each top-level hashed subdirectory1520 * of the object directory (e.g., "$OBJDIR/f0"). It is called1521 * after the objects in the directory are processed.1522 *1523 * Any callback that is NULL will be ignored. Callbacks returning non-zero1524 * will end the iteration.1525 *1526 * In the "buf" variant, "path" is a strbuf which will also be used as a1527 * scratch buffer, but restored to its original contents before1528 * the function returns.1529 */1530typedefinteach_loose_object_fn(const struct object_id *oid,1531const char*path,1532void*data);1533typedefinteach_loose_cruft_fn(const char*basename,1534const char*path,1535void*data);1536typedefinteach_loose_subdir_fn(unsigned int nr,1537const char*path,1538void*data);1539intfor_each_file_in_obj_subdir(unsigned int subdir_nr,1540struct strbuf *path,1541 each_loose_object_fn obj_cb,1542 each_loose_cruft_fn cruft_cb,1543 each_loose_subdir_fn subdir_cb,1544void*data);1545intfor_each_loose_file_in_objdir(const char*path,1546 each_loose_object_fn obj_cb,1547 each_loose_cruft_fn cruft_cb,1548 each_loose_subdir_fn subdir_cb,1549void*data);1550intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1551 each_loose_object_fn obj_cb,1552 each_loose_cruft_fn cruft_cb,1553 each_loose_subdir_fn subdir_cb,1554void*data);15551556/*1557 * Iterate over loose objects in both the local1558 * repository and any alternates repositories (unless the1559 * LOCAL_ONLY flag is set).1560 */1561#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11562externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);15631564/*1565 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing1566 * blobs. This has a difference only if extensions.partialClone is set.1567 *1568 * Its default value is 1.1569 */1570externint fetch_if_missing;15711572/* Dumb servers support */1573externintupdate_server_info(int);15741575externconst char*get_log_output_encoding(void);1576externconst char*get_commit_output_encoding(void);15771578/*1579 * This is a hack for test programs like test-dump-untracked-cache to1580 * ensure that they do not modify the untracked cache when reading it.1581 * Do not use it otherwise!1582 */1583externint ignore_untracked_cache_config;15841585externintcommitter_ident_sufficiently_given(void);1586externintauthor_ident_sufficiently_given(void);15871588externconst char*git_commit_encoding;1589externconst char*git_log_output_encoding;1590externconst char*git_mailmap_file;1591externconst char*git_mailmap_blob;15921593/* IO helper functions */1594externvoidmaybe_flush_or_die(FILE*,const char*);1595__attribute__((format(printf,2,3)))1596externvoidfprintf_or_die(FILE*,const char*fmt, ...);15971598#define COPY_READ_ERROR (-2)1599#define COPY_WRITE_ERROR (-3)1600externintcopy_fd(int ifd,int ofd);1601externintcopy_file(const char*dst,const char*src,int mode);1602externintcopy_file_with_time(const char*dst,const char*src,int mode);16031604externvoidwrite_or_die(int fd,const void*buf,size_t count);1605externvoidfsync_or_die(int fd,const char*);16061607extern ssize_t read_in_full(int fd,void*buf,size_t count);1608extern ssize_t write_in_full(int fd,const void*buf,size_t count);1609extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);16101611staticinline ssize_t write_str_in_full(int fd,const char*str)1612{1613returnwrite_in_full(fd, str,strlen(str));1614}16151616/**1617 * Open (and truncate) the file at path, write the contents of buf to it,1618 * and close it. Dies if any errors are encountered.1619 */1620externvoidwrite_file_buf(const char*path,const char*buf,size_t len);16211622/**1623 * Like write_file_buf(), but format the contents into a buffer first.1624 * Additionally, write_file() will append a newline if one is not already1625 * present, making it convenient to write text files:1626 *1627 * write_file(path, "counter: %d", ctr);1628 */1629__attribute__((format(printf,2,3)))1630externvoidwrite_file(const char*path,const char*fmt, ...);16311632/* pager.c */1633externvoidsetup_pager(void);1634externintpager_in_use(void);1635externint pager_use_color;1636externintterm_columns(void);1637externintdecimal_width(uintmax_t);1638externintcheck_pager_config(const char*cmd);1639externvoidprepare_pager_args(struct child_process *,const char*pager);16401641externconst char*editor_program;1642externconst char*askpass_program;1643externconst char*excludes_file;16441645/* base85 */1646intdecode_85(char*dst,const char*line,int linelen);1647voidencode_85(char*buf,const unsigned char*data,int bytes);16481649/* pkt-line.c */1650voidpacket_trace_identity(const char*prog);16511652/* add */1653/*1654 * return 0 if success, 1 - if addition of a file failed and1655 * ADD_FILES_IGNORE_ERRORS was specified in flags1656 */1657intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);16581659/* diff.c */1660externint diff_auto_refresh_index;16611662/* match-trees.c */1663voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1664voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);16651666/*1667 * whitespace rules.1668 * used by both diff and apply1669 * last two digits are tab width1670 */1671#define WS_BLANK_AT_EOL 01001672#define WS_SPACE_BEFORE_TAB 02001673#define WS_INDENT_WITH_NON_TAB 04001674#define WS_CR_AT_EOL 010001675#define WS_BLANK_AT_EOF 020001676#define WS_TAB_IN_INDENT 040001677#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1678#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1679#define WS_TAB_WIDTH_MASK 0771680/* All WS_* -- when extended, adapt diff.c emit_symbol */1681#define WS_RULE_MASK 077771682externunsigned whitespace_rule_cfg;1683externunsignedwhitespace_rule(const char*);1684externunsignedparse_whitespace_rule(const char*);1685externunsignedws_check(const char*line,int len,unsigned ws_rule);1686externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1687externchar*whitespace_error_string(unsigned ws);1688externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1689externintws_blank_line(const char*line,int len,unsigned ws_rule);1690#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)16911692/* ls-files */1693voidoverlay_tree_on_index(struct index_state *istate,1694const char*tree_name,const char*prefix);16951696char*alias_lookup(const char*alias);1697intsplit_cmdline(char*cmdline,const char***argv);1698/* Takes a negative value returned by split_cmdline */1699const char*split_cmdline_strerror(int cmdline_errno);17001701/* setup.c */1702struct startup_info {1703int have_repository;1704const char*prefix;1705};1706externstruct startup_info *startup_info;17071708/* merge.c */1709struct commit_list;1710inttry_merge_command(const char*strategy,size_t xopts_nr,1711const char**xopts,struct commit_list *common,1712const char*head_arg,struct commit_list *remotes);1713intcheckout_fast_forward(const struct object_id *from,1714const struct object_id *to,1715int overwrite_ignore);171617171718intsane_execvp(const char*file,char*const argv[]);17191720/*1721 * A struct to encapsulate the concept of whether a file has changed1722 * since we last checked it. This uses criteria similar to those used1723 * for the index.1724 */1725struct stat_validity {1726struct stat_data *sd;1727};17281729voidstat_validity_clear(struct stat_validity *sv);17301731/*1732 * Returns 1 if the path is a regular file (or a symlink to a regular1733 * file) and matches the saved stat_validity, 0 otherwise. A missing1734 * or inaccessible file is considered a match if the struct was just1735 * initialized, or if the previous update found an inaccessible file.1736 */1737intstat_validity_check(struct stat_validity *sv,const char*path);17381739/*1740 * Update the stat_validity from a file opened at descriptor fd. If1741 * the file is missing, inaccessible, or not a regular file, then1742 * future calls to stat_validity_check will match iff one of those1743 * conditions continues to be true.1744 */1745voidstat_validity_update(struct stat_validity *sv,int fd);17461747intversioncmp(const char*s1,const char*s2);1748voidsleep_millisec(int millisec);17491750/*1751 * Create a directory and (if share is nonzero) adjust its permissions1752 * according to the shared_repository setting. Only use this for1753 * directories under $GIT_DIR. Don't use it for working tree1754 * directories.1755 */1756voidsafe_create_dir(const char*dir,int share);17571758/*1759 * Should we print an ellipsis after an abbreviated SHA-1 value1760 * when doing diff-raw output or indicating a detached HEAD?1761 */1762externintprint_sha1_ellipsis(void);17631764#endif/* CACHE_H */