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"mru.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 18#ifndef platform_SHA_CTX 19/* 20 * platform's underlying implementation of SHA-1; could be OpenSSL, 21 * blk_SHA, Apple CommonCrypto, etc... Note that including 22 * SHA1_HEADER may have already defined platform_SHA_CTX for our 23 * own implementations like block-sha1 and ppc-sha1, so we list 24 * the default for OpenSSL compatible SHA-1 implementations here. 25 */ 26#define platform_SHA_CTX SHA_CTX 27#define platform_SHA1_Init SHA1_Init 28#define platform_SHA1_Update SHA1_Update 29#define platform_SHA1_Final SHA1_Final 30#endif 31 32#define git_SHA_CTX platform_SHA_CTX 33#define git_SHA1_Init platform_SHA1_Init 34#define git_SHA1_Update platform_SHA1_Update 35#define git_SHA1_Final platform_SHA1_Final 36 37#ifdef SHA1_MAX_BLOCK_SIZE 38#include"compat/sha1-chunked.h" 39#undef git_SHA1_Update 40#define git_SHA1_Update git_SHA1_Update_Chunked 41#endif 42 43#include <zlib.h> 44typedefstruct git_zstream { 45 z_stream z; 46unsigned long avail_in; 47unsigned long avail_out; 48unsigned long total_in; 49unsigned long total_out; 50unsigned char*next_in; 51unsigned char*next_out; 52} git_zstream; 53 54voidgit_inflate_init(git_zstream *); 55voidgit_inflate_init_gzip_only(git_zstream *); 56voidgit_inflate_end(git_zstream *); 57intgit_inflate(git_zstream *,int flush); 58 59voidgit_deflate_init(git_zstream *,int level); 60voidgit_deflate_init_gzip(git_zstream *,int level); 61voidgit_deflate_init_raw(git_zstream *,int level); 62voidgit_deflate_end(git_zstream *); 63intgit_deflate_abort(git_zstream *); 64intgit_deflate_end_gently(git_zstream *); 65intgit_deflate(git_zstream *,int flush); 66unsigned longgit_deflate_bound(git_zstream *,unsigned long); 67 68/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 69#define GIT_SHA1_RAWSZ 20 70#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 71 72/* The length in byte and in hex digits of the largest possible hash value. */ 73#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 74#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 75 76struct object_id { 77unsigned char hash[GIT_MAX_RAWSZ]; 78}; 79 80#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 81#define DTYPE(de) ((de)->d_type) 82#else 83#undef DT_UNKNOWN 84#undef DT_DIR 85#undef DT_REG 86#undef DT_LNK 87#define DT_UNKNOWN 0 88#define DT_DIR 1 89#define DT_REG 2 90#define DT_LNK 3 91#define DTYPE(de) DT_UNKNOWN 92#endif 93 94/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 95#define S_IFINVALID 0030000 96 97/* 98 * A "directory link" is a link to another git directory. 99 * 100 * The value 0160000 is not normally a valid mode, and 101 * also just happens to be S_IFDIR + S_IFLNK 102 */ 103#define S_IFGITLINK 0160000 104#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 105 106/* 107 * Some mode bits are also used internally for computations. 108 * 109 * They *must* not overlap with any valid modes, and they *must* not be emitted 110 * to outside world - i.e. appear on disk or network. In other words, it's just 111 * temporary fields, which we internally use, but they have to stay in-house. 112 * 113 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 114 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 115 */ 116 117/* used internally in tree-diff */ 118#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 119 120 121/* 122 * Intensive research over the course of many years has shown that 123 * port 9418 is totally unused by anything else. Or 124 * 125 * Your search - "port 9418" - did not match any documents. 126 * 127 * as www.google.com puts it. 128 * 129 * This port has been properly assigned for git use by IANA: 130 * git (Assigned-9418) [I06-050728-0001]. 131 * 132 * git 9418/tcp git pack transfer service 133 * git 9418/udp git pack transfer service 134 * 135 * with Linus Torvalds <torvalds@osdl.org> as the point of 136 * contact. September 2005. 137 * 138 * See http://www.iana.org/assignments/port-numbers 139 */ 140#define DEFAULT_GIT_PORT 9418 141 142/* 143 * Basic data structures for the directory cache 144 */ 145 146#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 147struct cache_header { 148uint32_t hdr_signature; 149uint32_t hdr_version; 150uint32_t hdr_entries; 151}; 152 153#define INDEX_FORMAT_LB 2 154#define INDEX_FORMAT_UB 4 155 156/* 157 * The "cache_time" is just the low 32 bits of the 158 * time. It doesn't matter if it overflows - we only 159 * check it for equality in the 32 bits we save. 160 */ 161struct cache_time { 162uint32_t sec; 163uint32_t nsec; 164}; 165 166struct stat_data { 167struct cache_time sd_ctime; 168struct cache_time sd_mtime; 169unsigned int sd_dev; 170unsigned int sd_ino; 171unsigned int sd_uid; 172unsigned int sd_gid; 173unsigned int sd_size; 174}; 175 176struct cache_entry { 177struct hashmap_entry ent; 178struct stat_data ce_stat_data; 179unsigned int ce_mode; 180unsigned int ce_flags; 181unsigned int ce_namelen; 182unsigned int index;/* for link extension */ 183struct object_id oid; 184char name[FLEX_ARRAY];/* more */ 185}; 186 187#define CE_STAGEMASK (0x3000) 188#define CE_EXTENDED (0x4000) 189#define CE_VALID (0x8000) 190#define CE_STAGESHIFT 12 191 192/* 193 * Range 0xFFFF0FFF in ce_flags is divided into 194 * two parts: in-memory flags and on-disk ones. 195 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 196 * if you want to save a new flag, add it in 197 * CE_EXTENDED_FLAGS 198 * 199 * In-memory only flags 200 */ 201#define CE_UPDATE (1 << 16) 202#define CE_REMOVE (1 << 17) 203#define CE_UPTODATE (1 << 18) 204#define CE_ADDED (1 << 19) 205 206#define CE_HASHED (1 << 20) 207#define CE_FSMONITOR_VALID (1 << 21) 208#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 209#define CE_CONFLICTED (1 << 23) 210 211#define CE_UNPACKED (1 << 24) 212#define CE_NEW_SKIP_WORKTREE (1 << 25) 213 214/* used to temporarily mark paths matched by pathspecs */ 215#define CE_MATCHED (1 << 26) 216 217#define CE_UPDATE_IN_BASE (1 << 27) 218#define CE_STRIP_NAME (1 << 28) 219 220/* 221 * Extended on-disk flags 222 */ 223#define CE_INTENT_TO_ADD (1 << 29) 224#define CE_SKIP_WORKTREE (1 << 30) 225/* CE_EXTENDED2 is for future extension */ 226#define CE_EXTENDED2 (1U << 31) 227 228#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 229 230/* 231 * Safeguard to avoid saving wrong flags: 232 * - CE_EXTENDED2 won't get saved until its semantic is known 233 * - Bits in 0x0000FFFF have been saved in ce_flags already 234 * - Bits in 0x003F0000 are currently in-memory flags 235 */ 236#if CE_EXTENDED_FLAGS & 0x803FFFFF 237#error"CE_EXTENDED_FLAGS out of range" 238#endif 239 240/* Forward structure decls */ 241struct pathspec; 242struct child_process; 243 244/* 245 * Copy the sha1 and stat state of a cache entry from one to 246 * another. But we never change the name, or the hash state! 247 */ 248staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 249const struct cache_entry *src) 250{ 251unsigned int state = dst->ce_flags & CE_HASHED; 252 253/* Don't copy hash chain and name */ 254memcpy(&dst->ce_stat_data, &src->ce_stat_data, 255offsetof(struct cache_entry, name) - 256offsetof(struct cache_entry, ce_stat_data)); 257 258/* Restore the hash state */ 259 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 260} 261 262staticinlineunsignedcreate_ce_flags(unsigned stage) 263{ 264return(stage << CE_STAGESHIFT); 265} 266 267#define ce_namelen(ce) ((ce)->ce_namelen) 268#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 269#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 270#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 271#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 272#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 273#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 274 275#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 276staticinlineunsigned intcreate_ce_mode(unsigned int mode) 277{ 278if(S_ISLNK(mode)) 279return S_IFLNK; 280if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 281return S_IFGITLINK; 282return S_IFREG |ce_permissions(mode); 283} 284staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 285unsigned int mode) 286{ 287externint trust_executable_bit, has_symlinks; 288if(!has_symlinks &&S_ISREG(mode) && 289 ce &&S_ISLNK(ce->ce_mode)) 290return ce->ce_mode; 291if(!trust_executable_bit &&S_ISREG(mode)) { 292if(ce &&S_ISREG(ce->ce_mode)) 293return ce->ce_mode; 294returncreate_ce_mode(0666); 295} 296returncreate_ce_mode(mode); 297} 298staticinlineintce_to_dtype(const struct cache_entry *ce) 299{ 300unsigned ce_mode =ntohl(ce->ce_mode); 301if(S_ISREG(ce_mode)) 302return DT_REG; 303else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 304return DT_DIR; 305else if(S_ISLNK(ce_mode)) 306return DT_LNK; 307else 308return DT_UNKNOWN; 309} 310staticinlineunsigned intcanon_mode(unsigned int mode) 311{ 312if(S_ISREG(mode)) 313return S_IFREG |ce_permissions(mode); 314if(S_ISLNK(mode)) 315return S_IFLNK; 316if(S_ISDIR(mode)) 317return S_IFDIR; 318return S_IFGITLINK; 319} 320 321#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 322 323#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 324#define CE_ENTRY_CHANGED (1 << 1) 325#define CE_ENTRY_REMOVED (1 << 2) 326#define CE_ENTRY_ADDED (1 << 3) 327#define RESOLVE_UNDO_CHANGED (1 << 4) 328#define CACHE_TREE_CHANGED (1 << 5) 329#define SPLIT_INDEX_ORDERED (1 << 6) 330#define UNTRACKED_CHANGED (1 << 7) 331#define FSMONITOR_CHANGED (1 << 8) 332 333struct split_index; 334struct untracked_cache; 335 336struct index_state { 337struct cache_entry **cache; 338unsigned int version; 339unsigned int cache_nr, cache_alloc, cache_changed; 340struct string_list *resolve_undo; 341struct cache_tree *cache_tree; 342struct split_index *split_index; 343struct cache_time timestamp; 344unsigned name_hash_initialized :1, 345 initialized :1; 346struct hashmap name_hash; 347struct hashmap dir_hash; 348unsigned char sha1[20]; 349struct untracked_cache *untracked; 350uint64_t fsmonitor_last_update; 351struct ewah_bitmap *fsmonitor_dirty; 352}; 353 354externstruct index_state the_index; 355 356/* Name hashing */ 357externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 358externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 359externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 360externvoidfree_name_hash(struct index_state *istate); 361 362 363#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 364#define active_cache (the_index.cache) 365#define active_nr (the_index.cache_nr) 366#define active_alloc (the_index.cache_alloc) 367#define active_cache_changed (the_index.cache_changed) 368#define active_cache_tree (the_index.cache_tree) 369 370#define read_cache() read_index(&the_index) 371#define read_cache_from(path) read_index_from(&the_index, (path)) 372#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 373#define is_cache_unborn() is_index_unborn(&the_index) 374#define read_cache_unmerged() read_index_unmerged(&the_index) 375#define discard_cache() discard_index(&the_index) 376#define unmerged_cache() unmerged_index(&the_index) 377#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 378#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 379#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 380#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 381#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 382#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 383#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 384#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 385#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 386#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 387#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 388#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 389#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 390#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 391#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 392#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 393#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 394#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 395#endif 396 397enum object_type { 398 OBJ_BAD = -1, 399 OBJ_NONE =0, 400 OBJ_COMMIT =1, 401 OBJ_TREE =2, 402 OBJ_BLOB =3, 403 OBJ_TAG =4, 404/* 5 for future expansion */ 405 OBJ_OFS_DELTA =6, 406 OBJ_REF_DELTA =7, 407 OBJ_ANY, 408 OBJ_MAX 409}; 410 411staticinlineenum object_type object_type(unsigned int mode) 412{ 413returnS_ISDIR(mode) ? OBJ_TREE : 414S_ISGITLINK(mode) ? OBJ_COMMIT : 415 OBJ_BLOB; 416} 417 418/* Double-check local_repo_env below if you add to this list. */ 419#define GIT_DIR_ENVIRONMENT"GIT_DIR" 420#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 421#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 422#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 423#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 424#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 425#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 426#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 427#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 428#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 429#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 430#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 431#define CONFIG_ENVIRONMENT"GIT_CONFIG" 432#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 433#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 434#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 435#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 436#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 437#define GITATTRIBUTES_FILE".gitattributes" 438#define INFOATTRIBUTES_FILE"info/attributes" 439#define ATTRIBUTE_MACRO_PREFIX"[attr]" 440#define GITMODULES_FILE".gitmodules" 441#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 442#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 443#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 444#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 445#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 446#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 447#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 448#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 449#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 450#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 451#define GIT_OPTIONAL_LOCKS_ENVIRONMENT"GIT_OPTIONAL_LOCKS" 452 453/* 454 * This environment variable is expected to contain a boolean indicating 455 * whether we should or should not treat: 456 * 457 * GIT_DIR=foo.git git ... 458 * 459 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 460 * of this, but we use it internally to communicate to sub-processes that we 461 * are in a bare repo. If not set, defaults to true. 462 */ 463#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 464 465/* 466 * Repository-local GIT_* environment variables; these will be cleared 467 * when git spawns a sub-process that runs inside another repository. 468 * The array is NULL-terminated, which makes it easy to pass in the "env" 469 * parameter of a run-command invocation, or to do a simple walk. 470 */ 471externconst char*const local_repo_env[]; 472 473externvoidsetup_git_env(void); 474 475/* 476 * Returns true iff we have a configured git repository (either via 477 * setup_git_directory, or in the environment via $GIT_DIR). 478 */ 479inthave_git_dir(void); 480 481externint is_bare_repository_cfg; 482externintis_bare_repository(void); 483externintis_inside_git_dir(void); 484externchar*git_work_tree_cfg; 485externintis_inside_work_tree(void); 486externconst char*get_git_dir(void); 487externconst char*get_git_common_dir(void); 488externchar*get_object_directory(void); 489externchar*get_index_file(void); 490externchar*get_graft_file(void); 491externintset_git_dir(const char*path); 492externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 493externintget_common_dir(struct strbuf *sb,const char*gitdir); 494externconst char*get_git_namespace(void); 495externconst char*strip_namespace(const char*namespaced_ref); 496externconst char*get_super_prefix(void); 497externconst char*get_git_work_tree(void); 498 499/* 500 * Return true if the given path is a git directory; note that this _just_ 501 * looks at the directory itself. If you want to know whether "foo/.git" 502 * is a repository, you must feed that path, not just "foo". 503 */ 504externintis_git_directory(const char*path); 505 506/* 507 * Return 1 if the given path is the root of a git repository or 508 * submodule, else 0. Will not return 1 for bare repositories with the 509 * exception of creating a bare repository in "foo/.git" and calling 510 * is_git_repository("foo"). 511 * 512 * If we run into read errors, we err on the side of saying "yes, it is", 513 * as we usually consider sub-repos precious, and would prefer to err on the 514 * side of not disrupting or deleting them. 515 */ 516externintis_nonbare_repository_dir(struct strbuf *path); 517 518#define READ_GITFILE_ERR_STAT_FAILED 1 519#define READ_GITFILE_ERR_NOT_A_FILE 2 520#define READ_GITFILE_ERR_OPEN_FAILED 3 521#define READ_GITFILE_ERR_READ_FAILED 4 522#define READ_GITFILE_ERR_INVALID_FORMAT 5 523#define READ_GITFILE_ERR_NO_PATH 6 524#define READ_GITFILE_ERR_NOT_A_REPO 7 525#define READ_GITFILE_ERR_TOO_LARGE 8 526externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 527externconst char*read_gitfile_gently(const char*path,int*return_error_code); 528#define read_gitfile(path) read_gitfile_gently((path), NULL) 529externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 530#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 531 532externvoidset_git_work_tree(const char*tree); 533 534#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 535 536externvoidsetup_work_tree(void); 537/* 538 * Find the commondir and gitdir of the repository that contains the current 539 * working directory, without changing the working directory or other global 540 * state. The result is appended to commondir and gitdir. If the discovered 541 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 542 * both have the same result appended to the buffer. The return value is 543 * either 0 upon success and non-zero if no repository was found. 544 */ 545externintdiscover_git_directory(struct strbuf *commondir, 546struct strbuf *gitdir); 547externconst char*setup_git_directory_gently(int*); 548externconst char*setup_git_directory(void); 549externchar*prefix_path(const char*prefix,int len,const char*path); 550externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 551 552/* 553 * Concatenate "prefix" (if len is non-zero) and "path", with no 554 * connecting characters (so "prefix" should end with a "/"). 555 * Unlike prefix_path, this should be used if the named file does 556 * not have to interact with index entry; i.e. name of a random file 557 * on the filesystem. 558 * 559 * The return value is always a newly allocated string (even if the 560 * prefix was empty). 561 */ 562externchar*prefix_filename(const char*prefix,const char*path); 563 564externintcheck_filename(const char*prefix,const char*name); 565externvoidverify_filename(const char*prefix, 566const char*name, 567int diagnose_misspelt_rev); 568externvoidverify_non_filename(const char*prefix,const char*name); 569externintpath_inside_repo(const char*prefix,const char*path); 570 571#define INIT_DB_QUIET 0x0001 572#define INIT_DB_EXIST_OK 0x0002 573 574externintinit_db(const char*git_dir,const char*real_git_dir, 575const char*template_dir,unsigned int flags); 576 577externvoidsanitize_stdfds(void); 578externintdaemonize(void); 579 580#define alloc_nr(x) (((x)+16)*3/2) 581 582/* 583 * Realloc the buffer pointed at by variable 'x' so that it can hold 584 * at least 'nr' entries; the number of entries currently allocated 585 * is 'alloc', using the standard growing factor alloc_nr() macro. 586 * 587 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 588 */ 589#define ALLOC_GROW(x, nr, alloc) \ 590 do { \ 591 if ((nr) > alloc) { \ 592 if (alloc_nr(alloc) < (nr)) \ 593 alloc = (nr); \ 594 else \ 595 alloc = alloc_nr(alloc); \ 596 REALLOC_ARRAY(x, alloc); \ 597 } \ 598 } while (0) 599 600/* Initialize and use the cache information */ 601struct lock_file; 602externintread_index(struct index_state *); 603externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 604externintdo_read_index(struct index_state *istate,const char*path, 605int must_exist);/* for testting only! */ 606externintread_index_from(struct index_state *,const char*path); 607externintis_index_unborn(struct index_state *); 608externintread_index_unmerged(struct index_state *); 609 610/* For use with `write_locked_index()`. */ 611#define COMMIT_LOCK (1 << 0) 612 613/* 614 * Write the index while holding an already-taken lock. Close the lock, 615 * and if `COMMIT_LOCK` is given, commit it. 616 * 617 * Unless a split index is in use, write the index into the lockfile. 618 * 619 * With a split index, write the shared index to a temporary file, 620 * adjust its permissions and rename it into place, then write the 621 * split index to the lockfile. If the temporary file for the shared 622 * index cannot be created, fall back to the behavior described in 623 * the previous paragraph. 624 * 625 * With `COMMIT_LOCK`, the lock is always committed or rolled back. 626 * Without it, the lock is closed, but neither committed nor rolled 627 * back. 628 */ 629externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 630 631externintdiscard_index(struct index_state *); 632externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 633externintunmerged_index(const struct index_state *); 634externintverify_path(const char*path); 635externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 636externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 637externvoidadjust_dirname_case(struct index_state *istate,char*name); 638externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 639 640/* 641 * Searches for an entry defined by name and namelen in the given index. 642 * If the return value is positive (including 0) it is the position of an 643 * exact match. If the return value is negative, the negated value minus 1 644 * is the position where the entry would be inserted. 645 * Example: The current index consists of these files and its stages: 646 * 647 * b#0, d#0, f#1, f#3 648 * 649 * index_name_pos(&index, "a", 1) -> -1 650 * index_name_pos(&index, "b", 1) -> 0 651 * index_name_pos(&index, "c", 1) -> -2 652 * index_name_pos(&index, "d", 1) -> 1 653 * index_name_pos(&index, "e", 1) -> -3 654 * index_name_pos(&index, "f", 1) -> -3 655 * index_name_pos(&index, "g", 1) -> -5 656 */ 657externintindex_name_pos(const struct index_state *,const char*name,int namelen); 658 659#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 660#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 661#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 662#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 663#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 664#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 665externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 666externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 667 668/* Remove entry, return true if there are more entries to go. */ 669externintremove_index_entry_at(struct index_state *,int pos); 670 671externvoidremove_marked_cache_entries(struct index_state *istate); 672externintremove_file_from_index(struct index_state *,const char*path); 673#define ADD_CACHE_VERBOSE 1 674#define ADD_CACHE_PRETEND 2 675#define ADD_CACHE_IGNORE_ERRORS 4 676#define ADD_CACHE_IGNORE_REMOVAL 8 677#define ADD_CACHE_INTENT 16 678/* 679 * These two are used to add the contents of the file at path 680 * to the index, marking the working tree up-to-date by storing 681 * the cached stat info in the resulting cache entry. A caller 682 * that has already run lstat(2) on the path can call 683 * add_to_index(), and all others can call add_file_to_index(); 684 * the latter will do necessary lstat(2) internally before 685 * calling the former. 686 */ 687externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 688externintadd_file_to_index(struct index_state *,const char*path,int flags); 689 690externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 691externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 692externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 693externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 694externintindex_name_is_other(const struct index_state *,const char*,int); 695externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 696 697/* do stat comparison even if CE_VALID is true */ 698#define CE_MATCH_IGNORE_VALID 01 699/* do not check the contents but report dirty on racily-clean entries */ 700#define CE_MATCH_RACY_IS_DIRTY 02 701/* do stat comparison even if CE_SKIP_WORKTREE is true */ 702#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 703/* ignore non-existent files during stat update */ 704#define CE_MATCH_IGNORE_MISSING 0x08 705/* enable stat refresh */ 706#define CE_MATCH_REFRESH 0x10 707/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */ 708#define CE_MATCH_IGNORE_FSMONITOR 0X20 709externintie_match_stat(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 710externintie_modified(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 711 712#define HASH_WRITE_OBJECT 1 713#define HASH_FORMAT_CHECK 2 714#define HASH_RENORMALIZE 4 715externintindex_fd(struct object_id *oid,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 716externintindex_path(struct object_id *oid,const char*path,struct stat *st,unsigned flags); 717 718/* 719 * Record to sd the data from st that we use to check whether a file 720 * might have changed. 721 */ 722externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 723 724/* 725 * Return 0 if st is consistent with a file not having been changed 726 * since sd was filled. If there are differences, return a 727 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 728 * INODE_CHANGED, and DATA_CHANGED. 729 */ 730externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 731externintmatch_stat_data_racy(const struct index_state *istate, 732const struct stat_data *sd,struct stat *st); 733 734externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 735 736#define REFRESH_REALLY 0x0001/* ignore_valid */ 737#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 738#define REFRESH_QUIET 0x0004/* be quiet about it */ 739#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 740#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 741#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 742externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 743externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 744 745/* 746 * Opportunistically update the index but do not complain if we can't. 747 * The lockfile is always committed or rolled back. 748 */ 749externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 750 751externinthold_locked_index(struct lock_file *,int); 752externvoidset_alternate_index_output(const char*); 753 754externint verify_index_checksum; 755externint verify_ce_order; 756 757/* Environment bits from configuration mechanism */ 758externint trust_executable_bit; 759externint trust_ctime; 760externint check_stat; 761externint quote_path_fully; 762externint has_symlinks; 763externint minimum_abbrev, default_abbrev; 764externint ignore_case; 765externint assume_unchanged; 766externint prefer_symlink_refs; 767externint warn_ambiguous_refs; 768externint warn_on_object_refname_ambiguity; 769externconst char*apply_default_whitespace; 770externconst char*apply_default_ignorewhitespace; 771externconst char*git_attributes_file; 772externconst char*git_hooks_path; 773externint zlib_compression_level; 774externint core_compression_level; 775externint pack_compression_level; 776externsize_t packed_git_window_size; 777externsize_t packed_git_limit; 778externsize_t delta_base_cache_limit; 779externunsigned long big_file_threshold; 780externunsigned long pack_size_limit_cfg; 781 782/* 783 * Accessors for the core.sharedrepository config which lazy-load the value 784 * from the config (if not already set). The "reset" function can be 785 * used to unset "set" or cached value, meaning that the value will be loaded 786 * fresh from the config file on the next call to get_shared_repository(). 787 */ 788voidset_shared_repository(int value); 789intget_shared_repository(void); 790voidreset_shared_repository(void); 791 792/* 793 * Do replace refs need to be checked this run? This variable is 794 * initialized to true unless --no-replace-object is used or 795 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 796 * commands that do not want replace references to be active. As an 797 * optimization it is also set to false if replace references have 798 * been sought but there were none. 799 */ 800externint check_replace_refs; 801externchar*git_replace_ref_base; 802 803externint fsync_object_files; 804externint core_preload_index; 805externint core_apply_sparse_checkout; 806externint precomposed_unicode; 807externint protect_hfs; 808externint protect_ntfs; 809externconst char*core_fsmonitor; 810 811/* 812 * Include broken refs in all ref iterations, which will 813 * generally choke dangerous operations rather than letting 814 * them silently proceed without taking the broken ref into 815 * account. 816 */ 817externint ref_paranoia; 818 819/* 820 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value). 821 */ 822intuse_optional_locks(void); 823 824/* 825 * The character that begins a commented line in user-editable file 826 * that is subject to stripspace. 827 */ 828externchar comment_line_char; 829externint auto_comment_line_char; 830 831/* Windows only */ 832enum hide_dotfiles_type { 833 HIDE_DOTFILES_FALSE =0, 834 HIDE_DOTFILES_TRUE, 835 HIDE_DOTFILES_DOTGITONLY 836}; 837externenum hide_dotfiles_type hide_dotfiles; 838 839enum log_refs_config { 840 LOG_REFS_UNSET = -1, 841 LOG_REFS_NONE =0, 842 LOG_REFS_NORMAL, 843 LOG_REFS_ALWAYS 844}; 845externenum log_refs_config log_all_ref_updates; 846 847enum branch_track { 848 BRANCH_TRACK_UNSPECIFIED = -1, 849 BRANCH_TRACK_NEVER =0, 850 BRANCH_TRACK_REMOTE, 851 BRANCH_TRACK_ALWAYS, 852 BRANCH_TRACK_EXPLICIT, 853 BRANCH_TRACK_OVERRIDE 854}; 855 856enum rebase_setup_type { 857 AUTOREBASE_NEVER =0, 858 AUTOREBASE_LOCAL, 859 AUTOREBASE_REMOTE, 860 AUTOREBASE_ALWAYS 861}; 862 863enum push_default_type { 864 PUSH_DEFAULT_NOTHING =0, 865 PUSH_DEFAULT_MATCHING, 866 PUSH_DEFAULT_SIMPLE, 867 PUSH_DEFAULT_UPSTREAM, 868 PUSH_DEFAULT_CURRENT, 869 PUSH_DEFAULT_UNSPECIFIED 870}; 871 872externenum branch_track git_branch_track; 873externenum rebase_setup_type autorebase; 874externenum push_default_type push_default; 875 876enum object_creation_mode { 877 OBJECT_CREATION_USES_HARDLINKS =0, 878 OBJECT_CREATION_USES_RENAMES =1 879}; 880 881externenum object_creation_mode object_creation_mode; 882 883externchar*notes_ref_name; 884 885externint grafts_replace_parents; 886 887/* 888 * GIT_REPO_VERSION is the version we write by default. The 889 * _READ variant is the highest number we know how to 890 * handle. 891 */ 892#define GIT_REPO_VERSION 0 893#define GIT_REPO_VERSION_READ 1 894externint repository_format_precious_objects; 895 896struct repository_format { 897int version; 898int precious_objects; 899int is_bare; 900char*work_tree; 901struct string_list unknown_extensions; 902}; 903 904/* 905 * Read the repository format characteristics from the config file "path" into 906 * "format" struct. Returns the numeric version. On error, -1 is returned, 907 * format->version is set to -1, and all other fields in the struct are 908 * undefined. 909 */ 910intread_repository_format(struct repository_format *format,const char*path); 911 912/* 913 * Verify that the repository described by repository_format is something we 914 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 915 * any errors encountered. 916 */ 917intverify_repository_format(const struct repository_format *format, 918struct strbuf *err); 919 920/* 921 * Check the repository format version in the path found in get_git_dir(), 922 * and die if it is a version we don't understand. Generally one would 923 * set_git_dir() before calling this, and use it only for "are we in a valid 924 * repo?". 925 */ 926externvoidcheck_repository_format(void); 927 928#define MTIME_CHANGED 0x0001 929#define CTIME_CHANGED 0x0002 930#define OWNER_CHANGED 0x0004 931#define MODE_CHANGED 0x0008 932#define INODE_CHANGED 0x0010 933#define DATA_CHANGED 0x0020 934#define TYPE_CHANGED 0x0040 935 936/* 937 * Return the name of the file in the local object database that would 938 * be used to store a loose object with the specified sha1. The 939 * return value is a pointer to a statically allocated buffer that is 940 * overwritten each time the function is called. 941 */ 942externconst char*sha1_file_name(const unsigned char*sha1); 943 944/* 945 * Return an abbreviated sha1 unique within this repository's object database. 946 * The result will be at least `len` characters long, and will be NUL 947 * terminated. 948 * 949 * The non-`_r` version returns a static buffer which remains valid until 4 950 * more calls to find_unique_abbrev are made. 951 * 952 * The `_r` variant writes to a buffer supplied by the caller, which must be at 953 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 954 * written (excluding the NUL terminator). 955 * 956 * Note that while this version avoids the static buffer, it is not fully 957 * reentrant, as it calls into other non-reentrant git code. 958 */ 959externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 960externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 961 962externconst unsigned char null_sha1[GIT_MAX_RAWSZ]; 963externconst struct object_id null_oid; 964 965staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 966{ 967returnmemcmp(sha1, sha2, GIT_SHA1_RAWSZ); 968} 969 970staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 971{ 972returnhashcmp(oid1->hash, oid2->hash); 973} 974 975staticinlineintis_null_sha1(const unsigned char*sha1) 976{ 977return!hashcmp(sha1, null_sha1); 978} 979 980staticinlineintis_null_oid(const struct object_id *oid) 981{ 982return!hashcmp(oid->hash, null_sha1); 983} 984 985staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src) 986{ 987memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 988} 989 990staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src) 991{ 992hashcpy(dst->hash, src->hash); 993} 994 995staticinlinestruct object_id *oiddup(const struct object_id *src) 996{ 997struct object_id *dst =xmalloc(sizeof(struct object_id)); 998oidcpy(dst, src); 999return dst;1000}10011002staticinlinevoidhashclr(unsigned char*hash)1003{1004memset(hash,0, GIT_SHA1_RAWSZ);1005}10061007staticinlinevoidoidclr(struct object_id *oid)1008{1009hashclr(oid->hash);1010}101110121013#define EMPTY_TREE_SHA1_HEX \1014"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1015#define EMPTY_TREE_SHA1_BIN_LITERAL \1016"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1017"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1018externconst struct object_id empty_tree_oid;1019#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10201021#define EMPTY_BLOB_SHA1_HEX \1022"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1023#define EMPTY_BLOB_SHA1_BIN_LITERAL \1024"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1025"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1026externconst struct object_id empty_blob_oid;1027#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)102810291030staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1031{1032return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1033}10341035staticinlineintis_empty_blob_oid(const struct object_id *oid)1036{1037return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1038}10391040staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1041{1042return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1043}10441045staticinlineintis_empty_tree_oid(const struct object_id *oid)1046{1047return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1048}10491050/* set default permissions by passing mode arguments to open(2) */1051intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1052intgit_mkstemp_mode(char*pattern,int mode);10531054/*1055 * NOTE NOTE NOTE!!1056 *1057 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1058 * not be changed. Old repositories have core.sharedrepository written in1059 * numeric format, and therefore these values are preserved for compatibility1060 * reasons.1061 */1062enum sharedrepo {1063 PERM_UMASK =0,1064 OLD_PERM_GROUP =1,1065 OLD_PERM_EVERYBODY =2,1066 PERM_GROUP =0660,1067 PERM_EVERYBODY =06641068};1069intgit_config_perm(const char*var,const char*value);1070intadjust_shared_perm(const char*path);10711072/*1073 * Create the directory containing the named path, using care to be1074 * somewhat safe against races. Return one of the scld_error values to1075 * indicate success/failure. On error, set errno to describe the1076 * problem.1077 *1078 * SCLD_VANISHED indicates that one of the ancestor directories of the1079 * path existed at one point during the function call and then1080 * suddenly vanished, probably because another process pruned the1081 * directory while we were working. To be robust against this kind of1082 * race, callers might want to try invoking the function again when it1083 * returns SCLD_VANISHED.1084 *1085 * safe_create_leading_directories() temporarily changes path while it1086 * is working but restores it before returning.1087 * safe_create_leading_directories_const() doesn't modify path, even1088 * temporarily.1089 */1090enum scld_error {1091 SCLD_OK =0,1092 SCLD_FAILED = -1,1093 SCLD_PERMS = -2,1094 SCLD_EXISTS = -3,1095 SCLD_VANISHED = -41096};1097enum scld_error safe_create_leading_directories(char*path);1098enum scld_error safe_create_leading_directories_const(const char*path);10991100/*1101 * Callback function for raceproof_create_file(). This function is1102 * expected to do something that makes dirname(path) permanent despite1103 * the fact that other processes might be cleaning up empty1104 * directories at the same time. Usually it will create a file named1105 * path, but alternatively it could create another file in that1106 * directory, or even chdir() into that directory. The function should1107 * return 0 if the action was completed successfully. On error, it1108 * should return a nonzero result and set errno.1109 * raceproof_create_file() treats two errno values specially:1110 *1111 * - ENOENT -- dirname(path) does not exist. In this case,1112 * raceproof_create_file() tries creating dirname(path)1113 * (and any parent directories, if necessary) and calls1114 * the function again.1115 *1116 * - EISDIR -- the file already exists and is a directory. In this1117 * case, raceproof_create_file() removes the directory if1118 * it is empty (and recursively any empty directories that1119 * it contains) and calls the function again.1120 *1121 * Any other errno causes raceproof_create_file() to fail with the1122 * callback's return value and errno.1123 *1124 * Obviously, this function should be OK with being called again if it1125 * fails with ENOENT or EISDIR. In other scenarios it will not be1126 * called again.1127 */1128typedefintcreate_file_fn(const char*path,void*cb);11291130/*1131 * Create a file in dirname(path) by calling fn, creating leading1132 * directories if necessary. Retry a few times in case we are racing1133 * with another process that is trying to clean up the directory that1134 * contains path. See the documentation for create_file_fn for more1135 * details.1136 *1137 * Return the value and set the errno that resulted from the most1138 * recent call of fn. fn is always called at least once, and will be1139 * called more than once if it returns ENOENT or EISDIR.1140 */1141intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11421143intmkdir_in_gitdir(const char*path);1144externchar*expand_user_path(const char*path,int real_home);1145const char*enter_repo(const char*path,int strict);1146staticinlineintis_absolute_path(const char*path)1147{1148returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1149}1150intis_directory(const char*);1151char*strbuf_realpath(struct strbuf *resolved,const char*path,1152int die_on_error);1153const char*real_path(const char*path);1154const char*real_path_if_valid(const char*path);1155char*real_pathdup(const char*path,int die_on_error);1156const char*absolute_path(const char*path);1157char*absolute_pathdup(const char*path);1158const char*remove_leading_path(const char*in,const char*prefix);1159const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1160intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1161intnormalize_path_copy(char*dst,const char*src);1162intlongest_ancestor_length(const char*path,struct string_list *prefixes);1163char*strip_path_suffix(const char*path,const char*suffix);1164intdaemon_avoid_alias(const char*path);1165externintis_ntfs_dotgit(const char*name);11661167/*1168 * Returns true iff "str" could be confused as a command-line option when1169 * passed to a sub-program like "ssh". Note that this has nothing to do with1170 * shell-quoting, which should be handled separately; we're assuming here that1171 * the string makes it verbatim to the sub-program.1172 */1173intlooks_like_command_line_option(const char*str);11741175/**1176 * Return a newly allocated string with the evaluation of1177 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1178 * "$HOME/.config/git/$filename". Return NULL upon error.1179 */1180externchar*xdg_config_home(const char*filename);11811182/**1183 * Return a newly allocated string with the evaluation of1184 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1185 * "$HOME/.cache/git/$filename". Return NULL upon error.1186 */1187externchar*xdg_cache_home(const char*filename);11881189externvoid*read_sha1_file_extended(const unsigned char*sha1,1190enum object_type *type,1191unsigned long*size,int lookup_replace);1192staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1193{1194returnread_sha1_file_extended(sha1, type, size,1);1195}11961197/*1198 * This internal function is only declared here for the benefit of1199 * lookup_replace_object(). Please do not call it directly.1200 */1201externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);12021203/*1204 * If object sha1 should be replaced, return the replacement object's1205 * name (replaced recursively, if necessary). The return value is1206 * either sha1 or a pointer to a permanently-allocated value. When1207 * object replacement is suppressed, always return sha1.1208 */1209staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1210{1211if(!check_replace_refs)1212return sha1;1213returndo_lookup_replace_object(sha1);1214}12151216/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1217externintsha1_object_info(const unsigned char*,unsigned long*);1218externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1);1219externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1);1220externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,struct object_id *oid,unsigned flags);1221externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*);1222externintforce_object_loose(const unsigned char*sha1,time_t mtime);1223externintgit_open_cloexec(const char*name,int flags);1224#define git_open(name) git_open_cloexec(name, O_RDONLY)1225externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1226externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1227externintparse_sha1_header(const char*hdr,unsigned long*sizep);12281229externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);12301231externintfinalize_object_file(const char*tmpfile,const char*filename);12321233/*1234 * Open the loose object at path, check its sha1, and return the contents,1235 * type, and size. If the object is a blob, then "contents" may return NULL,1236 * to allow streaming of large blobs.1237 *1238 * Returns 0 on success, negative on error (details may be written to stderr).1239 */1240intread_loose_object(const char*path,1241const unsigned char*expected_sha1,1242enum object_type *type,1243unsigned long*size,1244void**contents);12451246/*1247 * Convenience for sha1_object_info_extended() with a NULL struct1248 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass1249 * nonzero flags to also set other flags.1250 */1251externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1252staticinlineinthas_sha1_file(const unsigned char*sha1)1253{1254returnhas_sha1_file_with_flags(sha1,0);1255}12561257/* Same as the above, except for struct object_id. */1258externinthas_object_file(const struct object_id *oid);1259externinthas_object_file_with_flags(const struct object_id *oid,int flags);12601261/*1262 * Return true iff an alternate object database has a loose object1263 * with the specified name. This function does not respect replace1264 * references.1265 */1266externinthas_loose_object_nonlocal(const unsigned char*sha1);12671268externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);12691270/* Helper to check and "touch" a file */1271externintcheck_and_freshen_file(const char*fn,int freshen);12721273externconst signed char hexval_table[256];1274staticinlineunsigned inthexval(unsigned char c)1275{1276return hexval_table[c];1277}12781279/*1280 * Convert two consecutive hexadecimal digits into a char. Return a1281 * negative value on error. Don't run over the end of short strings.1282 */1283staticinlineinthex2chr(const char*s)1284{1285unsigned int val =hexval(s[0]);1286return(val & ~0xf) ? val : (val <<4) |hexval(s[1]);1287}12881289/* Convert to/from hex/sha1 representation */1290#define MINIMUM_ABBREV minimum_abbrev1291#define DEFAULT_ABBREV default_abbrev12921293/* used when the code does not know or care what the default abbrev is */1294#define FALLBACK_DEFAULT_ABBREV 712951296struct object_context {1297unsigned char tree[20];1298unsigned mode;1299/*1300 * symlink_path is only used by get_tree_entry_follow_symlinks,1301 * and only for symlinks that point outside the repository.1302 */1303struct strbuf symlink_path;1304/*1305 * If GET_OID_RECORD_PATH is set, this will record path (if any)1306 * found when resolving the name. The caller is responsible for1307 * releasing the memory.1308 */1309char*path;1310};13111312#define GET_OID_QUIETLY 011313#define GET_OID_COMMIT 021314#define GET_OID_COMMITTISH 041315#define GET_OID_TREE 0101316#define GET_OID_TREEISH 0201317#define GET_OID_BLOB 0401318#define GET_OID_FOLLOW_SYMLINKS 01001319#define GET_OID_RECORD_PATH 02001320#define GET_OID_ONLY_TO_DIE 0400013211322#define GET_OID_DISAMBIGUATORS \1323 (GET_OID_COMMIT | GET_OID_COMMITTISH | \1324 GET_OID_TREE | GET_OID_TREEISH | \1325 GET_OID_BLOB)13261327externintget_oid(const char*str,struct object_id *oid);1328externintget_oid_commit(const char*str,struct object_id *oid);1329externintget_oid_committish(const char*str,struct object_id *oid);1330externintget_oid_tree(const char*str,struct object_id *oid);1331externintget_oid_treeish(const char*str,struct object_id *oid);1332externintget_oid_blob(const char*str,struct object_id *oid);1333externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1334externintget_oid_with_context(const char*str,unsigned flags,struct object_id *oid,struct object_context *oc);133513361337typedefinteach_abbrev_fn(const struct object_id *oid,void*);1338externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13391340externintset_disambiguate_hint_config(const char*var,const char*value);13411342/*1343 * Try to read a SHA1 in hexadecimal format from the 40 characters1344 * starting at hex. Write the 20-byte result to sha1 in binary form.1345 * Return 0 on success. Reading stops if a NUL is encountered in the1346 * input, so it is safe to pass this function an arbitrary1347 * null-terminated string.1348 */1349externintget_sha1_hex(const char*hex,unsigned char*sha1);1350externintget_oid_hex(const char*hex,struct object_id *sha1);13511352/*1353 * Read `len` pairs of hexadecimal digits from `hex` and write the1354 * values to `binary` as `len` bytes. Return 0 on success, or -1 if1355 * the input does not consist of hex digits).1356 */1357externinthex_to_bytes(unsigned char*binary,const char*hex,size_t len);13581359/*1360 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1361 * and writes the NUL-terminated output to the buffer `out`, which must be at1362 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1363 * convenience.1364 *1365 * The non-`_r` variant returns a static buffer, but uses a ring of 41366 * buffers, making it safe to make multiple calls for a single statement, like:1367 *1368 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1369 */1370externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1371externchar*oid_to_hex_r(char*out,const struct object_id *oid);1372externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1373externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */13741375/*1376 * Parse a 40-character hexadecimal object ID starting from hex, updating the1377 * pointer specified by end when parsing stops. The resulting object ID is1378 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1379 * other invalid character. end is only updated on success; otherwise, it is1380 * unmodified.1381 */1382externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);13831384/*1385 * This reads short-hand syntax that not only evaluates to a commit1386 * object name, but also can act as if the end user spelled the name1387 * of the branch from the command line.1388 *1389 * - "@{-N}" finds the name of the Nth previous branch we were on, and1390 * places the name of the branch in the given buf and returns the1391 * number of characters parsed if successful.1392 *1393 * - "<branch>@{upstream}" finds the name of the other ref that1394 * <branch> is configured to merge with (missing <branch> defaults1395 * to the current branch), and places the name of the branch in the1396 * given buf and returns the number of characters parsed if1397 * successful.1398 *1399 * If the input is not of the accepted format, it returns a negative1400 * number to signal an error.1401 *1402 * If the input was ok but there are not N branch switches in the1403 * reflog, it returns 0.1404 *1405 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1406 * expansions: local branches ("refs/heads/"), remote branches1407 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1408 * allowed, even ones to refs outside of those namespaces.1409 */1410#define INTERPRET_BRANCH_LOCAL (1<<0)1411#define INTERPRET_BRANCH_REMOTE (1<<1)1412#define INTERPRET_BRANCH_HEAD (1<<2)1413externintinterpret_branch_name(const char*str,int len,struct strbuf *,1414unsigned allowed);1415externintget_oid_mb(const char*str,struct object_id *oid);14161417externintvalidate_headref(const char*ref);14181419externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1420externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1421externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1422externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);14231424externvoid*read_object_with_reference(const unsigned char*sha1,1425const char*required_type,1426unsigned long*size,1427unsigned char*sha1_ret);14281429externstruct object *peel_to_type(const char*name,int namelen,1430struct object *o,enum object_type);14311432struct date_mode {1433enum date_mode_type {1434 DATE_NORMAL =0,1435 DATE_RELATIVE,1436 DATE_SHORT,1437 DATE_ISO8601,1438 DATE_ISO8601_STRICT,1439 DATE_RFC2822,1440 DATE_STRFTIME,1441 DATE_RAW,1442 DATE_UNIX1443} type;1444const char*strftime_fmt;1445int local;1446};14471448/*1449 * Convenience helper for passing a constant type, like:1450 *1451 * show_date(t, tz, DATE_MODE(NORMAL));1452 */1453#define DATE_MODE(t) date_mode_from_type(DATE_##t)1454struct date_mode *date_mode_from_type(enum date_mode_type type);14551456const char*show_date(timestamp_t time,int timezone,const struct date_mode *mode);1457voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1458struct strbuf *timebuf);1459intparse_date(const char*date,struct strbuf *out);1460intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1461intparse_expiry_date(const char*date, timestamp_t *timestamp);1462voiddatestamp(struct strbuf *out);1463#define approxidate(s) approxidate_careful((s), NULL)1464timestamp_t approxidate_careful(const char*,int*);1465timestamp_t approxidate_relative(const char*date,const struct timeval *now);1466voidparse_date_format(const char*format,struct date_mode *mode);1467intdate_overflows(timestamp_t date);14681469#define IDENT_STRICT 11470#define IDENT_NO_DATE 21471#define IDENT_NO_NAME 41472externconst char*git_author_info(int);1473externconst char*git_committer_info(int);1474externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1475externconst char*fmt_name(const char*name,const char*email);1476externconst char*ident_default_name(void);1477externconst char*ident_default_email(void);1478externconst char*git_editor(void);1479externconst char*git_pager(int stdout_is_tty);1480externintgit_ident_config(const char*,const char*,void*);1481externvoidreset_ident_date(void);14821483struct ident_split {1484const char*name_begin;1485const char*name_end;1486const char*mail_begin;1487const char*mail_end;1488const char*date_begin;1489const char*date_end;1490const char*tz_begin;1491const char*tz_end;1492};1493/*1494 * Signals an success with 0, but time part of the result may be NULL1495 * if the input lacks timestamp and zone1496 */1497externintsplit_ident_line(struct ident_split *,const char*,int);14981499/*1500 * Like show_date, but pull the timestamp and tz parameters from1501 * the ident_split. It will also sanity-check the values and produce1502 * a well-known sentinel date if they appear bogus.1503 */1504const char*show_ident_date(const struct ident_split *id,1505const struct date_mode *mode);15061507/*1508 * Compare split idents for equality or strict ordering. Note that we1509 * compare only the ident part of the line, ignoring any timestamp.1510 *1511 * Because there are two fields, we must choose one as the primary key; we1512 * currently arbitrarily pick the email.1513 */1514externintident_cmp(const struct ident_split *,const struct ident_split *);15151516struct checkout {1517struct index_state *istate;1518const char*base_dir;1519int base_dir_len;1520struct delayed_checkout *delayed_checkout;1521unsigned force:1,1522 quiet:1,1523 not_new:1,1524 refresh_cache:1;1525};1526#define CHECKOUT_INIT { NULL,"" }15271528#define TEMPORARY_FILENAME_LENGTH 251529externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);1530externvoidenable_delayed_checkout(struct checkout *state);1531externintfinish_delayed_checkout(struct checkout *state);15321533struct cache_def {1534struct strbuf path;1535int flags;1536int track_flags;1537int prefix_len_stat_func;1538};1539#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1540staticinlinevoidcache_def_clear(struct cache_def *cache)1541{1542strbuf_release(&cache->path);1543}15441545externinthas_symlink_leading_path(const char*name,int len);1546externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1547externintcheck_leading_path(const char*name,int len);1548externinthas_dirs_only_path(const char*name,int len,int prefix_len);1549externvoidschedule_dir_for_removal(const char*name,int len);1550externvoidremove_scheduled_dirs(void);15511552externstruct alternate_object_database {1553struct alternate_object_database *next;15541555/* see alt_scratch_buf() */1556struct strbuf scratch;1557size_t base_len;15581559/*1560 * Used to store the results of readdir(3) calls when searching1561 * for unique abbreviated hashes. This cache is never1562 * invalidated, thus it's racy and not necessarily accurate.1563 * That's fine for its purpose; don't use it for tasks requiring1564 * greater accuracy!1565 */1566char loose_objects_subdir_seen[256];1567struct oid_array loose_objects_cache;15681569char path[FLEX_ARRAY];1570} *alt_odb_list;1571externvoidprepare_alt_odb(void);1572externchar*compute_alternate_path(const char*path,struct strbuf *err);1573typedefintalt_odb_fn(struct alternate_object_database *,void*);1574externintforeach_alt_odb(alt_odb_fn,void*);15751576/*1577 * Allocate a "struct alternate_object_database" but do _not_ actually1578 * add it to the list of alternates.1579 */1580struct alternate_object_database *alloc_alt_odb(const char*dir);15811582/*1583 * Add the directory to the on-disk alternates file; the new entry will also1584 * take effect in the current process.1585 */1586externvoidadd_to_alternates_file(const char*dir);15871588/*1589 * Add the directory to the in-memory list of alternates (along with any1590 * recursive alternates it points to), but do not modify the on-disk alternates1591 * file.1592 */1593externvoidadd_to_alternates_memory(const char*dir);15941595/*1596 * Returns a scratch strbuf pre-filled with the alternate object directory,1597 * including a trailing slash, which can be used to access paths in the1598 * alternate. Always use this over direct access to alt->scratch, as it1599 * cleans up any previous use of the scratch buffer.1600 */1601externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);16021603struct pack_window {1604struct pack_window *next;1605unsigned char*base;1606 off_t offset;1607size_t len;1608unsigned int last_used;1609unsigned int inuse_cnt;1610};16111612externstruct packed_git {1613struct packed_git *next;1614struct pack_window *windows;1615 off_t pack_size;1616const void*index_data;1617size_t index_size;1618uint32_t num_objects;1619uint32_t num_bad_objects;1620unsigned char*bad_object_sha1;1621int index_version;1622time_t mtime;1623int pack_fd;1624unsigned pack_local:1,1625 pack_keep:1,1626 freshened:1,1627 do_not_close:1;1628unsigned char sha1[20];1629struct revindex_entry *revindex;1630/* something like ".git/objects/pack/xxxxx.pack" */1631char pack_name[FLEX_ARRAY];/* more */1632} *packed_git;16331634/*1635 * A most-recently-used ordered version of the packed_git list, which can1636 * be iterated instead of packed_git (and marked via mru_mark).1637 */1638externstruct mru packed_git_mru;16391640struct pack_entry {1641 off_t offset;1642unsigned char sha1[20];1643struct packed_git *p;1644};16451646/*1647 * Create a temporary file rooted in the object database directory, or1648 * die on failure. The filename is taken from "pattern", which should have the1649 * usual "XXXXXX" trailer, and the resulting filename is written into the1650 * "template" buffer. Returns the open descriptor.1651 */1652externintodb_mkstemp(struct strbuf *template,const char*pattern);16531654/*1655 * Create a pack .keep file named "name" (which should generally be the output1656 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1657 * error.1658 */1659externintodb_pack_keep(const char*name);16601661/*1662 * Iterate over the files in the loose-object parts of the object1663 * directory "path", triggering the following callbacks:1664 *1665 * - loose_object is called for each loose object we find.1666 *1667 * - loose_cruft is called for any files that do not appear to be1668 * loose objects. Note that we only look in the loose object1669 * directories "objects/[0-9a-f]{2}/", so we will not report1670 * "objects/foobar" as cruft.1671 *1672 * - loose_subdir is called for each top-level hashed subdirectory1673 * of the object directory (e.g., "$OBJDIR/f0"). It is called1674 * after the objects in the directory are processed.1675 *1676 * Any callback that is NULL will be ignored. Callbacks returning non-zero1677 * will end the iteration.1678 *1679 * In the "buf" variant, "path" is a strbuf which will also be used as a1680 * scratch buffer, but restored to its original contents before1681 * the function returns.1682 */1683typedefinteach_loose_object_fn(const struct object_id *oid,1684const char*path,1685void*data);1686typedefinteach_loose_cruft_fn(const char*basename,1687const char*path,1688void*data);1689typedefinteach_loose_subdir_fn(unsigned int nr,1690const char*path,1691void*data);1692intfor_each_file_in_obj_subdir(unsigned int subdir_nr,1693struct strbuf *path,1694 each_loose_object_fn obj_cb,1695 each_loose_cruft_fn cruft_cb,1696 each_loose_subdir_fn subdir_cb,1697void*data);1698intfor_each_loose_file_in_objdir(const char*path,1699 each_loose_object_fn obj_cb,1700 each_loose_cruft_fn cruft_cb,1701 each_loose_subdir_fn subdir_cb,1702void*data);1703intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1704 each_loose_object_fn obj_cb,1705 each_loose_cruft_fn cruft_cb,1706 each_loose_subdir_fn subdir_cb,1707void*data);17081709/*1710 * Iterate over loose objects in both the local1711 * repository and any alternates repositories (unless the1712 * LOCAL_ONLY flag is set).1713 */1714#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11715externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);17161717struct object_info {1718/* Request */1719enum object_type *typep;1720unsigned long*sizep;1721 off_t *disk_sizep;1722unsigned char*delta_base_sha1;1723struct strbuf *typename;1724void**contentp;17251726/* Response */1727enum{1728 OI_CACHED,1729 OI_LOOSE,1730 OI_PACKED,1731 OI_DBCACHED1732} whence;1733union{1734/*1735 * struct {1736 * ... Nothing to expose in this case1737 * } cached;1738 * struct {1739 * ... Nothing to expose in this case1740 * } loose;1741 */1742struct{1743struct packed_git *pack;1744 off_t offset;1745unsigned int is_delta;1746} packed;1747} u;1748};17491750/*1751 * Initializer for a "struct object_info" that wants no items. You may1752 * also memset() the memory to all-zeroes.1753 */1754#define OBJECT_INFO_INIT {NULL}17551756/* Invoke lookup_replace_object() on the given hash */1757#define OBJECT_INFO_LOOKUP_REPLACE 11758/* Allow reading from a loose object file of unknown/bogus type */1759#define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 21760/* Do not check cached storage */1761#define OBJECT_INFO_SKIP_CACHED 41762/* Do not retry packed storage after checking packed and loose storage */1763#define OBJECT_INFO_QUICK 81764externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);17651766/* Dumb servers support */1767externintupdate_server_info(int);17681769externconst char*get_log_output_encoding(void);1770externconst char*get_commit_output_encoding(void);17711772/*1773 * This is a hack for test programs like test-dump-untracked-cache to1774 * ensure that they do not modify the untracked cache when reading it.1775 * Do not use it otherwise!1776 */1777externint ignore_untracked_cache_config;17781779externintcommitter_ident_sufficiently_given(void);1780externintauthor_ident_sufficiently_given(void);17811782externconst char*git_commit_encoding;1783externconst char*git_log_output_encoding;1784externconst char*git_mailmap_file;1785externconst char*git_mailmap_blob;17861787/* IO helper functions */1788externvoidmaybe_flush_or_die(FILE*,const char*);1789__attribute__((format(printf,2,3)))1790externvoidfprintf_or_die(FILE*,const char*fmt, ...);17911792#define COPY_READ_ERROR (-2)1793#define COPY_WRITE_ERROR (-3)1794externintcopy_fd(int ifd,int ofd);1795externintcopy_file(const char*dst,const char*src,int mode);1796externintcopy_file_with_time(const char*dst,const char*src,int mode);17971798externvoidwrite_or_die(int fd,const void*buf,size_t count);1799externvoidfsync_or_die(int fd,const char*);18001801extern ssize_t read_in_full(int fd,void*buf,size_t count);1802extern ssize_t write_in_full(int fd,const void*buf,size_t count);1803extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);18041805staticinline ssize_t write_str_in_full(int fd,const char*str)1806{1807returnwrite_in_full(fd, str,strlen(str));1808}18091810/**1811 * Open (and truncate) the file at path, write the contents of buf to it,1812 * and close it. Dies if any errors are encountered.1813 */1814externvoidwrite_file_buf(const char*path,const char*buf,size_t len);18151816/**1817 * Like write_file_buf(), but format the contents into a buffer first.1818 * Additionally, write_file() will append a newline if one is not already1819 * present, making it convenient to write text files:1820 *1821 * write_file(path, "counter: %d", ctr);1822 */1823__attribute__((format(printf,2,3)))1824externvoidwrite_file(const char*path,const char*fmt, ...);18251826/* pager.c */1827externvoidsetup_pager(void);1828externintpager_in_use(void);1829externint pager_use_color;1830externintterm_columns(void);1831externintdecimal_width(uintmax_t);1832externintcheck_pager_config(const char*cmd);1833externvoidprepare_pager_args(struct child_process *,const char*pager);18341835externconst char*editor_program;1836externconst char*askpass_program;1837externconst char*excludes_file;18381839/* base85 */1840intdecode_85(char*dst,const char*line,int linelen);1841voidencode_85(char*buf,const unsigned char*data,int bytes);18421843/* alloc.c */1844externvoid*alloc_blob_node(void);1845externvoid*alloc_tree_node(void);1846externvoid*alloc_commit_node(void);1847externvoid*alloc_tag_node(void);1848externvoid*alloc_object_node(void);1849externvoidalloc_report(void);1850externunsigned intalloc_commit_index(void);18511852/* pkt-line.c */1853voidpacket_trace_identity(const char*prog);18541855/* add */1856/*1857 * return 0 if success, 1 - if addition of a file failed and1858 * ADD_FILES_IGNORE_ERRORS was specified in flags1859 */1860intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);18611862/* diff.c */1863externint diff_auto_refresh_index;18641865/* match-trees.c */1866voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1867voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);18681869/*1870 * whitespace rules.1871 * used by both diff and apply1872 * last two digits are tab width1873 */1874#define WS_BLANK_AT_EOL 01001875#define WS_SPACE_BEFORE_TAB 02001876#define WS_INDENT_WITH_NON_TAB 04001877#define WS_CR_AT_EOL 010001878#define WS_BLANK_AT_EOF 020001879#define WS_TAB_IN_INDENT 040001880#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1881#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1882#define WS_TAB_WIDTH_MASK 0771883/* All WS_* -- when extended, adapt diff.c emit_symbol */1884#define WS_RULE_MASK 077771885externunsigned whitespace_rule_cfg;1886externunsignedwhitespace_rule(const char*);1887externunsignedparse_whitespace_rule(const char*);1888externunsignedws_check(const char*line,int len,unsigned ws_rule);1889externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1890externchar*whitespace_error_string(unsigned ws);1891externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1892externintws_blank_line(const char*line,int len,unsigned ws_rule);1893#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)18941895/* ls-files */1896voidoverlay_tree_on_index(struct index_state *istate,1897const char*tree_name,const char*prefix);18981899char*alias_lookup(const char*alias);1900intsplit_cmdline(char*cmdline,const char***argv);1901/* Takes a negative value returned by split_cmdline */1902const char*split_cmdline_strerror(int cmdline_errno);19031904/* setup.c */1905struct startup_info {1906int have_repository;1907const char*prefix;1908};1909externstruct startup_info *startup_info;19101911/* merge.c */1912struct commit_list;1913inttry_merge_command(const char*strategy,size_t xopts_nr,1914const char**xopts,struct commit_list *common,1915const char*head_arg,struct commit_list *remotes);1916intcheckout_fast_forward(const struct object_id *from,1917const struct object_id *to,1918int overwrite_ignore);191919201921intsane_execvp(const char*file,char*const argv[]);19221923/*1924 * A struct to encapsulate the concept of whether a file has changed1925 * since we last checked it. This uses criteria similar to those used1926 * for the index.1927 */1928struct stat_validity {1929struct stat_data *sd;1930};19311932voidstat_validity_clear(struct stat_validity *sv);19331934/*1935 * Returns 1 if the path is a regular file (or a symlink to a regular1936 * file) and matches the saved stat_validity, 0 otherwise. A missing1937 * or inaccessible file is considered a match if the struct was just1938 * initialized, or if the previous update found an inaccessible file.1939 */1940intstat_validity_check(struct stat_validity *sv,const char*path);19411942/*1943 * Update the stat_validity from a file opened at descriptor fd. If1944 * the file is missing, inaccessible, or not a regular file, then1945 * future calls to stat_validity_check will match iff one of those1946 * conditions continues to be true.1947 */1948voidstat_validity_update(struct stat_validity *sv,int fd);19491950intversioncmp(const char*s1,const char*s2);1951voidsleep_millisec(int millisec);19521953/*1954 * Create a directory and (if share is nonzero) adjust its permissions1955 * according to the shared_repository setting. Only use this for1956 * directories under $GIT_DIR. Don't use it for working tree1957 * directories.1958 */1959voidsafe_create_dir(const char*dir,int share);19601961#endif/* CACHE_H */