1#ifndef CACHE_H 2#define CACHE_H 3 4#include"git-compat-util.h" 5#include"strbuf.h" 6#include"hashmap.h" 7#include"advice.h" 8#include"gettext.h" 9#include"convert.h" 10#include"trace.h" 11#include"string-list.h" 12#include"pack-revindex.h" 13#include"hash.h" 14#include"path.h" 15 16#ifndef platform_SHA_CTX 17/* 18 * platform's underlying implementation of SHA-1; could be OpenSSL, 19 * blk_SHA, Apple CommonCrypto, etc... Note that including 20 * SHA1_HEADER may have already defined platform_SHA_CTX for our 21 * own implementations like block-sha1 and ppc-sha1, so we list 22 * the default for OpenSSL compatible SHA-1 implementations here. 23 */ 24#define platform_SHA_CTX SHA_CTX 25#define platform_SHA1_Init SHA1_Init 26#define platform_SHA1_Update SHA1_Update 27#define platform_SHA1_Final SHA1_Final 28#endif 29 30#define git_SHA_CTX platform_SHA_CTX 31#define git_SHA1_Init platform_SHA1_Init 32#define git_SHA1_Update platform_SHA1_Update 33#define git_SHA1_Final platform_SHA1_Final 34 35#ifdef SHA1_MAX_BLOCK_SIZE 36#include"compat/sha1-chunked.h" 37#undef git_SHA1_Update 38#define git_SHA1_Update git_SHA1_Update_Chunked 39#endif 40 41#include <zlib.h> 42typedefstruct git_zstream { 43 z_stream z; 44unsigned long avail_in; 45unsigned long avail_out; 46unsigned long total_in; 47unsigned long total_out; 48unsigned char*next_in; 49unsigned char*next_out; 50} git_zstream; 51 52voidgit_inflate_init(git_zstream *); 53voidgit_inflate_init_gzip_only(git_zstream *); 54voidgit_inflate_end(git_zstream *); 55intgit_inflate(git_zstream *,int flush); 56 57voidgit_deflate_init(git_zstream *,int level); 58voidgit_deflate_init_gzip(git_zstream *,int level); 59voidgit_deflate_init_raw(git_zstream *,int level); 60voidgit_deflate_end(git_zstream *); 61intgit_deflate_abort(git_zstream *); 62intgit_deflate_end_gently(git_zstream *); 63intgit_deflate(git_zstream *,int flush); 64unsigned longgit_deflate_bound(git_zstream *,unsigned long); 65 66/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 67#define GIT_SHA1_RAWSZ 20 68#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 69 70/* The length in byte and in hex digits of the largest possible hash value. */ 71#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 72#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 73 74struct object_id { 75unsigned char hash[GIT_MAX_RAWSZ]; 76}; 77 78#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 79#define DTYPE(de) ((de)->d_type) 80#else 81#undef DT_UNKNOWN 82#undef DT_DIR 83#undef DT_REG 84#undef DT_LNK 85#define DT_UNKNOWN 0 86#define DT_DIR 1 87#define DT_REG 2 88#define DT_LNK 3 89#define DTYPE(de) DT_UNKNOWN 90#endif 91 92/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 93#define S_IFINVALID 0030000 94 95/* 96 * A "directory link" is a link to another git directory. 97 * 98 * The value 0160000 is not normally a valid mode, and 99 * also just happens to be S_IFDIR + S_IFLNK 100 */ 101#define S_IFGITLINK 0160000 102#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 103 104/* 105 * Some mode bits are also used internally for computations. 106 * 107 * They *must* not overlap with any valid modes, and they *must* not be emitted 108 * to outside world - i.e. appear on disk or network. In other words, it's just 109 * temporary fields, which we internally use, but they have to stay in-house. 110 * 111 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 112 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 113 */ 114 115/* used internally in tree-diff */ 116#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 117 118 119/* 120 * Intensive research over the course of many years has shown that 121 * port 9418 is totally unused by anything else. Or 122 * 123 * Your search - "port 9418" - did not match any documents. 124 * 125 * as www.google.com puts it. 126 * 127 * This port has been properly assigned for git use by IANA: 128 * git (Assigned-9418) [I06-050728-0001]. 129 * 130 * git 9418/tcp git pack transfer service 131 * git 9418/udp git pack transfer service 132 * 133 * with Linus Torvalds <torvalds@osdl.org> as the point of 134 * contact. September 2005. 135 * 136 * See http://www.iana.org/assignments/port-numbers 137 */ 138#define DEFAULT_GIT_PORT 9418 139 140/* 141 * Basic data structures for the directory cache 142 */ 143 144#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 145struct cache_header { 146uint32_t hdr_signature; 147uint32_t hdr_version; 148uint32_t hdr_entries; 149}; 150 151#define INDEX_FORMAT_LB 2 152#define INDEX_FORMAT_UB 4 153 154/* 155 * The "cache_time" is just the low 32 bits of the 156 * time. It doesn't matter if it overflows - we only 157 * check it for equality in the 32 bits we save. 158 */ 159struct cache_time { 160uint32_t sec; 161uint32_t nsec; 162}; 163 164struct stat_data { 165struct cache_time sd_ctime; 166struct cache_time sd_mtime; 167unsigned int sd_dev; 168unsigned int sd_ino; 169unsigned int sd_uid; 170unsigned int sd_gid; 171unsigned int sd_size; 172}; 173 174struct cache_entry { 175struct hashmap_entry ent; 176struct stat_data ce_stat_data; 177unsigned int ce_mode; 178unsigned int ce_flags; 179unsigned int ce_namelen; 180unsigned int index;/* for link extension */ 181struct object_id oid; 182char name[FLEX_ARRAY];/* more */ 183}; 184 185#define CE_STAGEMASK (0x3000) 186#define CE_EXTENDED (0x4000) 187#define CE_VALID (0x8000) 188#define CE_STAGESHIFT 12 189 190/* 191 * Range 0xFFFF0FFF in ce_flags is divided into 192 * two parts: in-memory flags and on-disk ones. 193 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 194 * if you want to save a new flag, add it in 195 * CE_EXTENDED_FLAGS 196 * 197 * In-memory only flags 198 */ 199#define CE_UPDATE (1 << 16) 200#define CE_REMOVE (1 << 17) 201#define CE_UPTODATE (1 << 18) 202#define CE_ADDED (1 << 19) 203 204#define CE_HASHED (1 << 20) 205#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 206#define CE_CONFLICTED (1 << 23) 207 208#define CE_UNPACKED (1 << 24) 209#define CE_NEW_SKIP_WORKTREE (1 << 25) 210 211/* used to temporarily mark paths matched by pathspecs */ 212#define CE_MATCHED (1 << 26) 213 214#define CE_UPDATE_IN_BASE (1 << 27) 215#define CE_STRIP_NAME (1 << 28) 216 217/* 218 * Extended on-disk flags 219 */ 220#define CE_INTENT_TO_ADD (1 << 29) 221#define CE_SKIP_WORKTREE (1 << 30) 222/* CE_EXTENDED2 is for future extension */ 223#define CE_EXTENDED2 (1U << 31) 224 225#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 226 227/* 228 * Safeguard to avoid saving wrong flags: 229 * - CE_EXTENDED2 won't get saved until its semantic is known 230 * - Bits in 0x0000FFFF have been saved in ce_flags already 231 * - Bits in 0x003F0000 are currently in-memory flags 232 */ 233#if CE_EXTENDED_FLAGS & 0x803FFFFF 234#error"CE_EXTENDED_FLAGS out of range" 235#endif 236 237/* Forward structure decls */ 238struct pathspec; 239struct child_process; 240 241/* 242 * Copy the sha1 and stat state of a cache entry from one to 243 * another. But we never change the name, or the hash state! 244 */ 245staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 246const struct cache_entry *src) 247{ 248unsigned int state = dst->ce_flags & CE_HASHED; 249 250/* Don't copy hash chain and name */ 251memcpy(&dst->ce_stat_data, &src->ce_stat_data, 252offsetof(struct cache_entry, name) - 253offsetof(struct cache_entry, ce_stat_data)); 254 255/* Restore the hash state */ 256 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 257} 258 259staticinlineunsignedcreate_ce_flags(unsigned stage) 260{ 261return(stage << CE_STAGESHIFT); 262} 263 264#define ce_namelen(ce) ((ce)->ce_namelen) 265#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 266#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 267#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 268#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 269#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 270#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 271 272#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 273staticinlineunsigned intcreate_ce_mode(unsigned int mode) 274{ 275if(S_ISLNK(mode)) 276return S_IFLNK; 277if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 278return S_IFGITLINK; 279return S_IFREG |ce_permissions(mode); 280} 281staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 282unsigned int mode) 283{ 284externint trust_executable_bit, has_symlinks; 285if(!has_symlinks &&S_ISREG(mode) && 286 ce &&S_ISLNK(ce->ce_mode)) 287return ce->ce_mode; 288if(!trust_executable_bit &&S_ISREG(mode)) { 289if(ce &&S_ISREG(ce->ce_mode)) 290return ce->ce_mode; 291returncreate_ce_mode(0666); 292} 293returncreate_ce_mode(mode); 294} 295staticinlineintce_to_dtype(const struct cache_entry *ce) 296{ 297unsigned ce_mode =ntohl(ce->ce_mode); 298if(S_ISREG(ce_mode)) 299return DT_REG; 300else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 301return DT_DIR; 302else if(S_ISLNK(ce_mode)) 303return DT_LNK; 304else 305return DT_UNKNOWN; 306} 307staticinlineunsigned intcanon_mode(unsigned int mode) 308{ 309if(S_ISREG(mode)) 310return S_IFREG |ce_permissions(mode); 311if(S_ISLNK(mode)) 312return S_IFLNK; 313if(S_ISDIR(mode)) 314return S_IFDIR; 315return S_IFGITLINK; 316} 317 318#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 319 320#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 321#define CE_ENTRY_CHANGED (1 << 1) 322#define CE_ENTRY_REMOVED (1 << 2) 323#define CE_ENTRY_ADDED (1 << 3) 324#define RESOLVE_UNDO_CHANGED (1 << 4) 325#define CACHE_TREE_CHANGED (1 << 5) 326#define SPLIT_INDEX_ORDERED (1 << 6) 327#define UNTRACKED_CHANGED (1 << 7) 328 329struct split_index; 330struct untracked_cache; 331 332struct index_state { 333struct cache_entry **cache; 334unsigned int version; 335unsigned int cache_nr, cache_alloc, cache_changed; 336struct string_list *resolve_undo; 337struct cache_tree *cache_tree; 338struct split_index *split_index; 339struct cache_time timestamp; 340unsigned name_hash_initialized :1, 341 initialized :1; 342struct hashmap name_hash; 343struct hashmap dir_hash; 344unsigned char sha1[20]; 345struct untracked_cache *untracked; 346}; 347 348externstruct index_state the_index; 349 350/* Name hashing */ 351externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 352externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 353externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 354externvoidfree_name_hash(struct index_state *istate); 355 356 357#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 358#define active_cache (the_index.cache) 359#define active_nr (the_index.cache_nr) 360#define active_alloc (the_index.cache_alloc) 361#define active_cache_changed (the_index.cache_changed) 362#define active_cache_tree (the_index.cache_tree) 363 364#define read_cache() read_index(&the_index) 365#define read_cache_from(path) read_index_from(&the_index, (path)) 366#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 367#define is_cache_unborn() is_index_unborn(&the_index) 368#define read_cache_unmerged() read_index_unmerged(&the_index) 369#define discard_cache() discard_index(&the_index) 370#define unmerged_cache() unmerged_index(&the_index) 371#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 372#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 373#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 374#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 375#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 376#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 377#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 378#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 379#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 380#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 381#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 382#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 383#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 384#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 385#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 386#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 387#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 388#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 389#endif 390 391enum object_type { 392 OBJ_BAD = -1, 393 OBJ_NONE =0, 394 OBJ_COMMIT =1, 395 OBJ_TREE =2, 396 OBJ_BLOB =3, 397 OBJ_TAG =4, 398/* 5 for future expansion */ 399 OBJ_OFS_DELTA =6, 400 OBJ_REF_DELTA =7, 401 OBJ_ANY, 402 OBJ_MAX 403}; 404 405staticinlineenum object_type object_type(unsigned int mode) 406{ 407returnS_ISDIR(mode) ? OBJ_TREE : 408S_ISGITLINK(mode) ? OBJ_COMMIT : 409 OBJ_BLOB; 410} 411 412/* Double-check local_repo_env below if you add to this list. */ 413#define GIT_DIR_ENVIRONMENT"GIT_DIR" 414#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 415#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 416#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 417#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 418#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 419#define GIT_TOPLEVEL_PREFIX_ENVIRONMENT"GIT_INTERNAL_TOPLEVEL_PREFIX" 420#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 421#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 422#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 423#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 424#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 425#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 426#define CONFIG_ENVIRONMENT"GIT_CONFIG" 427#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 428#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 429#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 430#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 431#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 432#define GITATTRIBUTES_FILE".gitattributes" 433#define INFOATTRIBUTES_FILE"info/attributes" 434#define ATTRIBUTE_MACRO_PREFIX"[attr]" 435#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 436#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 437#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 438#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 439#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 440#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 441#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 442#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 443#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 444#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 445 446/* 447 * This environment variable is expected to contain a boolean indicating 448 * whether we should or should not treat: 449 * 450 * GIT_DIR=foo.git git ... 451 * 452 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 453 * of this, but we use it internally to communicate to sub-processes that we 454 * are in a bare repo. If not set, defaults to true. 455 */ 456#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 457 458/* 459 * Repository-local GIT_* environment variables; these will be cleared 460 * when git spawns a sub-process that runs inside another repository. 461 * The array is NULL-terminated, which makes it easy to pass in the "env" 462 * parameter of a run-command invocation, or to do a simple walk. 463 */ 464externconst char*const local_repo_env[]; 465 466externvoidsetup_git_env(void); 467 468/* 469 * Returns true iff we have a configured git repository (either via 470 * setup_git_directory, or in the environment via $GIT_DIR). 471 */ 472inthave_git_dir(void); 473 474externint is_bare_repository_cfg; 475externintis_bare_repository(void); 476externintis_inside_git_dir(void); 477externchar*git_work_tree_cfg; 478externintis_inside_work_tree(void); 479externconst char*get_git_dir(void); 480externconst char*get_git_common_dir(void); 481externchar*get_object_directory(void); 482externchar*get_index_file(void); 483externchar*get_graft_file(void); 484externintset_git_dir(const char*path); 485externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 486externintget_common_dir(struct strbuf *sb,const char*gitdir); 487externconst char*get_git_namespace(void); 488externconst char*strip_namespace(const char*namespaced_ref); 489externconst char*get_super_prefix(void); 490externconst char*get_git_work_tree(void); 491 492/* 493 * Return true if the given path is a git directory; note that this _just_ 494 * looks at the directory itself. If you want to know whether "foo/.git" 495 * is a repository, you must feed that path, not just "foo". 496 */ 497externintis_git_directory(const char*path); 498 499/* 500 * Return 1 if the given path is the root of a git repository or 501 * submodule, else 0. Will not return 1 for bare repositories with the 502 * exception of creating a bare repository in "foo/.git" and calling 503 * is_git_repository("foo"). 504 * 505 * If we run into read errors, we err on the side of saying "yes, it is", 506 * as we usually consider sub-repos precious, and would prefer to err on the 507 * side of not disrupting or deleting them. 508 */ 509externintis_nonbare_repository_dir(struct strbuf *path); 510 511#define READ_GITFILE_ERR_STAT_FAILED 1 512#define READ_GITFILE_ERR_NOT_A_FILE 2 513#define READ_GITFILE_ERR_OPEN_FAILED 3 514#define READ_GITFILE_ERR_READ_FAILED 4 515#define READ_GITFILE_ERR_INVALID_FORMAT 5 516#define READ_GITFILE_ERR_NO_PATH 6 517#define READ_GITFILE_ERR_NOT_A_REPO 7 518#define READ_GITFILE_ERR_TOO_LARGE 8 519externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 520externconst char*read_gitfile_gently(const char*path,int*return_error_code); 521#define read_gitfile(path) read_gitfile_gently((path), NULL) 522externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 523#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 524 525externvoidset_git_work_tree(const char*tree); 526 527#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 528 529externvoidsetup_work_tree(void); 530/* 531 * Find the commondir and gitdir of the repository that contains the current 532 * working directory, without changing the working directory or other global 533 * state. The result is appended to commondir and gitdir. If the discovered 534 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 535 * both have the same result appended to the buffer. The return value is 536 * either 0 upon success and non-zero if no repository was found. 537 */ 538externintdiscover_git_directory(struct strbuf *commondir, 539struct strbuf *gitdir); 540externconst char*setup_git_directory_gently(int*); 541externconst char*setup_git_directory(void); 542externchar*prefix_path(const char*prefix,int len,const char*path); 543externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 544 545/* 546 * Concatenate "prefix" (if len is non-zero) and "path", with no 547 * connecting characters (so "prefix" should end with a "/"). 548 * Unlike prefix_path, this should be used if the named file does 549 * not have to interact with index entry; i.e. name of a random file 550 * on the filesystem. 551 * 552 * The return value is always a newly allocated string (even if the 553 * prefix was empty). 554 */ 555externchar*prefix_filename(const char*prefix,const char*path); 556 557externintcheck_filename(const char*prefix,const char*name); 558externvoidverify_filename(const char*prefix, 559const char*name, 560int diagnose_misspelt_rev); 561externvoidverify_non_filename(const char*prefix,const char*name); 562externintpath_inside_repo(const char*prefix,const char*path); 563 564#define INIT_DB_QUIET 0x0001 565#define INIT_DB_EXIST_OK 0x0002 566 567externintinit_db(const char*git_dir,const char*real_git_dir, 568const char*template_dir,unsigned int flags); 569 570externvoidsanitize_stdfds(void); 571externintdaemonize(void); 572 573#define alloc_nr(x) (((x)+16)*3/2) 574 575/* 576 * Realloc the buffer pointed at by variable 'x' so that it can hold 577 * at least 'nr' entries; the number of entries currently allocated 578 * is 'alloc', using the standard growing factor alloc_nr() macro. 579 * 580 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 581 */ 582#define ALLOC_GROW(x, nr, alloc) \ 583 do { \ 584 if ((nr) > alloc) { \ 585 if (alloc_nr(alloc) < (nr)) \ 586 alloc = (nr); \ 587 else \ 588 alloc = alloc_nr(alloc); \ 589 REALLOC_ARRAY(x, alloc); \ 590 } \ 591 } while (0) 592 593/* Initialize and use the cache information */ 594struct lock_file; 595externintread_index(struct index_state *); 596externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 597externintdo_read_index(struct index_state *istate,const char*path, 598int must_exist);/* for testting only! */ 599externintread_index_from(struct index_state *,const char*path); 600externintis_index_unborn(struct index_state *); 601externintread_index_unmerged(struct index_state *); 602#define COMMIT_LOCK (1 << 0) 603#define CLOSE_LOCK (1 << 1) 604externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 605externintdiscard_index(struct index_state *); 606externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 607externintunmerged_index(const struct index_state *); 608externintverify_path(const char*path); 609externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 610externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 611externvoidadjust_dirname_case(struct index_state *istate,char*name); 612externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 613 614/* 615 * Searches for an entry defined by name and namelen in the given index. 616 * If the return value is positive (including 0) it is the position of an 617 * exact match. If the return value is negative, the negated value minus 1 618 * is the position where the entry would be inserted. 619 * Example: The current index consists of these files and its stages: 620 * 621 * b#0, d#0, f#1, f#3 622 * 623 * index_name_pos(&index, "a", 1) -> -1 624 * index_name_pos(&index, "b", 1) -> 0 625 * index_name_pos(&index, "c", 1) -> -2 626 * index_name_pos(&index, "d", 1) -> 1 627 * index_name_pos(&index, "e", 1) -> -3 628 * index_name_pos(&index, "f", 1) -> -3 629 * index_name_pos(&index, "g", 1) -> -5 630 */ 631externintindex_name_pos(const struct index_state *,const char*name,int namelen); 632 633#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 634#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 635#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 636#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 637#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 638#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 639externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 640externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 641 642/* Remove entry, return true if there are more entries to go. */ 643externintremove_index_entry_at(struct index_state *,int pos); 644 645externvoidremove_marked_cache_entries(struct index_state *istate); 646externintremove_file_from_index(struct index_state *,const char*path); 647#define ADD_CACHE_VERBOSE 1 648#define ADD_CACHE_PRETEND 2 649#define ADD_CACHE_IGNORE_ERRORS 4 650#define ADD_CACHE_IGNORE_REMOVAL 8 651#define ADD_CACHE_INTENT 16 652/* 653 * These two are used to add the contents of the file at path 654 * to the index, marking the working tree up-to-date by storing 655 * the cached stat info in the resulting cache entry. A caller 656 * that has already run lstat(2) on the path can call 657 * add_to_index(), and all others can call add_file_to_index(); 658 * the latter will do necessary lstat(2) internally before 659 * calling the former. 660 */ 661externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 662externintadd_file_to_index(struct index_state *,const char*path,int flags); 663 664externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 665externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 666externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 667externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 668externintindex_name_is_other(const struct index_state *,const char*,int); 669externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 670 671/* do stat comparison even if CE_VALID is true */ 672#define CE_MATCH_IGNORE_VALID 01 673/* do not check the contents but report dirty on racily-clean entries */ 674#define CE_MATCH_RACY_IS_DIRTY 02 675/* do stat comparison even if CE_SKIP_WORKTREE is true */ 676#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 677/* ignore non-existent files during stat update */ 678#define CE_MATCH_IGNORE_MISSING 0x08 679/* enable stat refresh */ 680#define CE_MATCH_REFRESH 0x10 681externintie_match_stat(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 682externintie_modified(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 683 684#define HASH_WRITE_OBJECT 1 685#define HASH_FORMAT_CHECK 2 686externintindex_fd(unsigned char*sha1,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 687externintindex_path(unsigned char*sha1,const char*path,struct stat *st,unsigned flags); 688 689/* 690 * Record to sd the data from st that we use to check whether a file 691 * might have changed. 692 */ 693externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 694 695/* 696 * Return 0 if st is consistent with a file not having been changed 697 * since sd was filled. If there are differences, return a 698 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 699 * INODE_CHANGED, and DATA_CHANGED. 700 */ 701externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 702externintmatch_stat_data_racy(const struct index_state *istate, 703const struct stat_data *sd,struct stat *st); 704 705externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 706 707#define REFRESH_REALLY 0x0001/* ignore_valid */ 708#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 709#define REFRESH_QUIET 0x0004/* be quiet about it */ 710#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 711#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 712#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 713externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 714externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 715 716externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 717 718externinthold_locked_index(struct lock_file *,int); 719externvoidset_alternate_index_output(const char*); 720 721externint verify_index_checksum; 722 723/* Environment bits from configuration mechanism */ 724externint trust_executable_bit; 725externint trust_ctime; 726externint check_stat; 727externint quote_path_fully; 728externint has_symlinks; 729externint minimum_abbrev, default_abbrev; 730externint ignore_case; 731externint assume_unchanged; 732externint prefer_symlink_refs; 733externint warn_ambiguous_refs; 734externint warn_on_object_refname_ambiguity; 735externconst char*apply_default_whitespace; 736externconst char*apply_default_ignorewhitespace; 737externconst char*git_attributes_file; 738externconst char*git_hooks_path; 739externint zlib_compression_level; 740externint core_compression_level; 741externint pack_compression_level; 742externsize_t packed_git_window_size; 743externsize_t packed_git_limit; 744externsize_t delta_base_cache_limit; 745externunsigned long big_file_threshold; 746externunsigned long pack_size_limit_cfg; 747 748/* 749 * Accessors for the core.sharedrepository config which lazy-load the value 750 * from the config (if not already set). The "reset" function can be 751 * used to unset "set" or cached value, meaning that the value will be loaded 752 * fresh from the config file on the next call to get_shared_repository(). 753 */ 754voidset_shared_repository(int value); 755intget_shared_repository(void); 756voidreset_shared_repository(void); 757 758/* 759 * Do replace refs need to be checked this run? This variable is 760 * initialized to true unless --no-replace-object is used or 761 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 762 * commands that do not want replace references to be active. As an 763 * optimization it is also set to false if replace references have 764 * been sought but there were none. 765 */ 766externint check_replace_refs; 767externchar*git_replace_ref_base; 768 769externint fsync_object_files; 770externint core_preload_index; 771externint core_apply_sparse_checkout; 772externint precomposed_unicode; 773externint protect_hfs; 774externint protect_ntfs; 775 776/* 777 * Include broken refs in all ref iterations, which will 778 * generally choke dangerous operations rather than letting 779 * them silently proceed without taking the broken ref into 780 * account. 781 */ 782externint ref_paranoia; 783 784/* 785 * The character that begins a commented line in user-editable file 786 * that is subject to stripspace. 787 */ 788externchar comment_line_char; 789externint auto_comment_line_char; 790 791/* Windows only */ 792enum hide_dotfiles_type { 793 HIDE_DOTFILES_FALSE =0, 794 HIDE_DOTFILES_TRUE, 795 HIDE_DOTFILES_DOTGITONLY 796}; 797externenum hide_dotfiles_type hide_dotfiles; 798 799enum log_refs_config { 800 LOG_REFS_UNSET = -1, 801 LOG_REFS_NONE =0, 802 LOG_REFS_NORMAL, 803 LOG_REFS_ALWAYS 804}; 805externenum log_refs_config log_all_ref_updates; 806 807enum branch_track { 808 BRANCH_TRACK_UNSPECIFIED = -1, 809 BRANCH_TRACK_NEVER =0, 810 BRANCH_TRACK_REMOTE, 811 BRANCH_TRACK_ALWAYS, 812 BRANCH_TRACK_EXPLICIT, 813 BRANCH_TRACK_OVERRIDE 814}; 815 816enum rebase_setup_type { 817 AUTOREBASE_NEVER =0, 818 AUTOREBASE_LOCAL, 819 AUTOREBASE_REMOTE, 820 AUTOREBASE_ALWAYS 821}; 822 823enum push_default_type { 824 PUSH_DEFAULT_NOTHING =0, 825 PUSH_DEFAULT_MATCHING, 826 PUSH_DEFAULT_SIMPLE, 827 PUSH_DEFAULT_UPSTREAM, 828 PUSH_DEFAULT_CURRENT, 829 PUSH_DEFAULT_UNSPECIFIED 830}; 831 832externenum branch_track git_branch_track; 833externenum rebase_setup_type autorebase; 834externenum push_default_type push_default; 835 836enum object_creation_mode { 837 OBJECT_CREATION_USES_HARDLINKS =0, 838 OBJECT_CREATION_USES_RENAMES =1 839}; 840 841externenum object_creation_mode object_creation_mode; 842 843externchar*notes_ref_name; 844 845externint grafts_replace_parents; 846 847/* 848 * GIT_REPO_VERSION is the version we write by default. The 849 * _READ variant is the highest number we know how to 850 * handle. 851 */ 852#define GIT_REPO_VERSION 0 853#define GIT_REPO_VERSION_READ 1 854externint repository_format_precious_objects; 855 856struct repository_format { 857int version; 858int precious_objects; 859int is_bare; 860char*work_tree; 861struct string_list unknown_extensions; 862}; 863 864/* 865 * Read the repository format characteristics from the config file "path" into 866 * "format" struct. Returns the numeric version. On error, -1 is returned, 867 * format->version is set to -1, and all other fields in the struct are 868 * undefined. 869 */ 870intread_repository_format(struct repository_format *format,const char*path); 871 872/* 873 * Verify that the repository described by repository_format is something we 874 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 875 * any errors encountered. 876 */ 877intverify_repository_format(const struct repository_format *format, 878struct strbuf *err); 879 880/* 881 * Check the repository format version in the path found in get_git_dir(), 882 * and die if it is a version we don't understand. Generally one would 883 * set_git_dir() before calling this, and use it only for "are we in a valid 884 * repo?". 885 */ 886externvoidcheck_repository_format(void); 887 888#define MTIME_CHANGED 0x0001 889#define CTIME_CHANGED 0x0002 890#define OWNER_CHANGED 0x0004 891#define MODE_CHANGED 0x0008 892#define INODE_CHANGED 0x0010 893#define DATA_CHANGED 0x0020 894#define TYPE_CHANGED 0x0040 895 896/* 897 * Return the name of the file in the local object database that would 898 * be used to store a loose object with the specified sha1. The 899 * return value is a pointer to a statically allocated buffer that is 900 * overwritten each time the function is called. 901 */ 902externconst char*sha1_file_name(const unsigned char*sha1); 903 904/* 905 * Return the name of the (local) packfile with the specified sha1 in 906 * its name. The return value is a pointer to memory that is 907 * overwritten each time this function is called. 908 */ 909externchar*sha1_pack_name(const unsigned char*sha1); 910 911/* 912 * Return the name of the (local) pack index file with the specified 913 * sha1 in its name. The return value is a pointer to memory that is 914 * overwritten each time this function is called. 915 */ 916externchar*sha1_pack_index_name(const unsigned char*sha1); 917 918/* 919 * Return an abbreviated sha1 unique within this repository's object database. 920 * The result will be at least `len` characters long, and will be NUL 921 * terminated. 922 * 923 * The non-`_r` version returns a static buffer which remains valid until 4 924 * more calls to find_unique_abbrev are made. 925 * 926 * The `_r` variant writes to a buffer supplied by the caller, which must be at 927 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 928 * written (excluding the NUL terminator). 929 * 930 * Note that while this version avoids the static buffer, it is not fully 931 * reentrant, as it calls into other non-reentrant git code. 932 */ 933externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 934externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 935 936externconst unsigned char null_sha1[GIT_MAX_RAWSZ]; 937externconst struct object_id null_oid; 938 939staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 940{ 941int i; 942 943for(i =0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 944if(*sha1 != *sha2) 945return*sha1 - *sha2; 946} 947 948return0; 949} 950 951staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 952{ 953returnhashcmp(oid1->hash, oid2->hash); 954} 955 956staticinlineintis_null_sha1(const unsigned char*sha1) 957{ 958return!hashcmp(sha1, null_sha1); 959} 960 961staticinlineintis_null_oid(const struct object_id *oid) 962{ 963return!hashcmp(oid->hash, null_sha1); 964} 965 966staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src) 967{ 968memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 969} 970 971staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src) 972{ 973hashcpy(dst->hash, src->hash); 974} 975 976staticinlinestruct object_id *oiddup(const struct object_id *src) 977{ 978struct object_id *dst =xmalloc(sizeof(struct object_id)); 979oidcpy(dst, src); 980return dst; 981} 982 983staticinlinevoidhashclr(unsigned char*hash) 984{ 985memset(hash,0, GIT_SHA1_RAWSZ); 986} 987 988staticinlinevoidoidclr(struct object_id *oid) 989{ 990hashclr(oid->hash); 991} 992 993 994#define EMPTY_TREE_SHA1_HEX \ 995"4b825dc642cb6eb9a060e54bf8d69288fbee4904" 996#define EMPTY_TREE_SHA1_BIN_LITERAL \ 997"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \ 998"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04" 999externconst struct object_id empty_tree_oid;1000#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10011002#define EMPTY_BLOB_SHA1_HEX \1003"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1004#define EMPTY_BLOB_SHA1_BIN_LITERAL \1005"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1006"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1007externconst struct object_id empty_blob_oid;1008#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)100910101011staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1012{1013return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1014}10151016staticinlineintis_empty_blob_oid(const struct object_id *oid)1017{1018return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1019}10201021staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1022{1023return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1024}10251026staticinlineintis_empty_tree_oid(const struct object_id *oid)1027{1028return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1029}10301031/* set default permissions by passing mode arguments to open(2) */1032intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1033intgit_mkstemp_mode(char*pattern,int mode);10341035/*1036 * NOTE NOTE NOTE!!1037 *1038 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1039 * not be changed. Old repositories have core.sharedrepository written in1040 * numeric format, and therefore these values are preserved for compatibility1041 * reasons.1042 */1043enum sharedrepo {1044 PERM_UMASK =0,1045 OLD_PERM_GROUP =1,1046 OLD_PERM_EVERYBODY =2,1047 PERM_GROUP =0660,1048 PERM_EVERYBODY =06641049};1050intgit_config_perm(const char*var,const char*value);1051intadjust_shared_perm(const char*path);10521053/*1054 * Create the directory containing the named path, using care to be1055 * somewhat safe against races. Return one of the scld_error values to1056 * indicate success/failure. On error, set errno to describe the1057 * problem.1058 *1059 * SCLD_VANISHED indicates that one of the ancestor directories of the1060 * path existed at one point during the function call and then1061 * suddenly vanished, probably because another process pruned the1062 * directory while we were working. To be robust against this kind of1063 * race, callers might want to try invoking the function again when it1064 * returns SCLD_VANISHED.1065 *1066 * safe_create_leading_directories() temporarily changes path while it1067 * is working but restores it before returning.1068 * safe_create_leading_directories_const() doesn't modify path, even1069 * temporarily.1070 */1071enum scld_error {1072 SCLD_OK =0,1073 SCLD_FAILED = -1,1074 SCLD_PERMS = -2,1075 SCLD_EXISTS = -3,1076 SCLD_VANISHED = -41077};1078enum scld_error safe_create_leading_directories(char*path);1079enum scld_error safe_create_leading_directories_const(const char*path);10801081/*1082 * Callback function for raceproof_create_file(). This function is1083 * expected to do something that makes dirname(path) permanent despite1084 * the fact that other processes might be cleaning up empty1085 * directories at the same time. Usually it will create a file named1086 * path, but alternatively it could create another file in that1087 * directory, or even chdir() into that directory. The function should1088 * return 0 if the action was completed successfully. On error, it1089 * should return a nonzero result and set errno.1090 * raceproof_create_file() treats two errno values specially:1091 *1092 * - ENOENT -- dirname(path) does not exist. In this case,1093 * raceproof_create_file() tries creating dirname(path)1094 * (and any parent directories, if necessary) and calls1095 * the function again.1096 *1097 * - EISDIR -- the file already exists and is a directory. In this1098 * case, raceproof_create_file() removes the directory if1099 * it is empty (and recursively any empty directories that1100 * it contains) and calls the function again.1101 *1102 * Any other errno causes raceproof_create_file() to fail with the1103 * callback's return value and errno.1104 *1105 * Obviously, this function should be OK with being called again if it1106 * fails with ENOENT or EISDIR. In other scenarios it will not be1107 * called again.1108 */1109typedefintcreate_file_fn(const char*path,void*cb);11101111/*1112 * Create a file in dirname(path) by calling fn, creating leading1113 * directories if necessary. Retry a few times in case we are racing1114 * with another process that is trying to clean up the directory that1115 * contains path. See the documentation for create_file_fn for more1116 * details.1117 *1118 * Return the value and set the errno that resulted from the most1119 * recent call of fn. fn is always called at least once, and will be1120 * called more than once if it returns ENOENT or EISDIR.1121 */1122intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11231124intmkdir_in_gitdir(const char*path);1125externchar*expand_user_path(const char*path,int real_home);1126const char*enter_repo(const char*path,int strict);1127staticinlineintis_absolute_path(const char*path)1128{1129returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1130}1131intis_directory(const char*);1132char*strbuf_realpath(struct strbuf *resolved,const char*path,1133int die_on_error);1134const char*real_path(const char*path);1135const char*real_path_if_valid(const char*path);1136char*real_pathdup(const char*path,int die_on_error);1137const char*absolute_path(const char*path);1138char*absolute_pathdup(const char*path);1139const char*remove_leading_path(const char*in,const char*prefix);1140const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1141intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1142intnormalize_path_copy(char*dst,const char*src);1143intlongest_ancestor_length(const char*path,struct string_list *prefixes);1144char*strip_path_suffix(const char*path,const char*suffix);1145intdaemon_avoid_alias(const char*path);1146externintis_ntfs_dotgit(const char*name);11471148/**1149 * Return a newly allocated string with the evaluation of1150 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1151 * "$HOME/.config/git/$filename". Return NULL upon error.1152 */1153externchar*xdg_config_home(const char*filename);11541155/**1156 * Return a newly allocated string with the evaluation of1157 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1158 * "$HOME/.cache/git/$filename". Return NULL upon error.1159 */1160externchar*xdg_cache_home(const char*filename);11611162/* object replacement */1163#define LOOKUP_REPLACE_OBJECT 11164#define LOOKUP_UNKNOWN_OBJECT 21165externvoid*read_sha1_file_extended(const unsigned char*sha1,enum object_type *type,unsigned long*size,unsigned flag);1166staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1167{1168returnread_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);1169}11701171/*1172 * This internal function is only declared here for the benefit of1173 * lookup_replace_object(). Please do not call it directly.1174 */1175externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);11761177/*1178 * If object sha1 should be replaced, return the replacement object's1179 * name (replaced recursively, if necessary). The return value is1180 * either sha1 or a pointer to a permanently-allocated value. When1181 * object replacement is suppressed, always return sha1.1182 */1183staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1184{1185if(!check_replace_refs)1186return sha1;1187returndo_lookup_replace_object(sha1);1188}11891190staticinlineconst unsigned char*lookup_replace_object_extended(const unsigned char*sha1,unsigned flag)1191{1192if(!(flag & LOOKUP_REPLACE_OBJECT))1193return sha1;1194returnlookup_replace_object(sha1);1195}11961197/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1198externintsha1_object_info(const unsigned char*,unsigned long*);1199externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1);1200externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1);1201externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,unsigned char*sha1,unsigned flags);1202externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*);1203externintforce_object_loose(const unsigned char*sha1,time_t mtime);1204externintgit_open_cloexec(const char*name,int flags);1205#define git_open(name) git_open_cloexec(name, O_RDONLY)1206externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1207externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1208externintparse_sha1_header(const char*hdr,unsigned long*sizep);12091210/* global flag to enable extra checks when accessing packed objects */1211externint do_check_packed_object_crc;12121213externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);12141215externintfinalize_object_file(const char*tmpfile,const char*filename);12161217externinthas_sha1_pack(const unsigned char*sha1);12181219/*1220 * Open the loose object at path, check its sha1, and return the contents,1221 * type, and size. If the object is a blob, then "contents" may return NULL,1222 * to allow streaming of large blobs.1223 *1224 * Returns 0 on success, negative on error (details may be written to stderr).1225 */1226intread_loose_object(const char*path,1227const unsigned char*expected_sha1,1228enum object_type *type,1229unsigned long*size,1230void**contents);12311232/*1233 * Return true iff we have an object named sha1, whether local or in1234 * an alternate object database, and whether packed or loose. This1235 * function does not respect replace references.1236 *1237 * If the QUICK flag is set, do not re-check the pack directory1238 * when we cannot find the object (this means we may give a false1239 * negative answer if another process is simultaneously repacking).1240 */1241#define HAS_SHA1_QUICK 0x11242externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1243staticinlineinthas_sha1_file(const unsigned char*sha1)1244{1245returnhas_sha1_file_with_flags(sha1,0);1246}12471248/* Same as the above, except for struct object_id. */1249externinthas_object_file(const struct object_id *oid);1250externinthas_object_file_with_flags(const struct object_id *oid,int flags);12511252/*1253 * Return true iff an alternate object database has a loose object1254 * with the specified name. This function does not respect replace1255 * references.1256 */1257externinthas_loose_object_nonlocal(const unsigned char*sha1);12581259externinthas_pack_index(const unsigned char*sha1);12601261externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);12621263/* Helper to check and "touch" a file */1264externintcheck_and_freshen_file(const char*fn,int freshen);12651266externconst signed char hexval_table[256];1267staticinlineunsigned inthexval(unsigned char c)1268{1269return hexval_table[c];1270}12711272/*1273 * Convert two consecutive hexadecimal digits into a char. Return a1274 * negative value on error. Don't run over the end of short strings.1275 */1276staticinlineinthex2chr(const char*s)1277{1278int val =hexval(s[0]);1279return(val <0) ? val : (val <<4) |hexval(s[1]);1280}12811282/* Convert to/from hex/sha1 representation */1283#define MINIMUM_ABBREV minimum_abbrev1284#define DEFAULT_ABBREV default_abbrev12851286/* used when the code does not know or care what the default abbrev is */1287#define FALLBACK_DEFAULT_ABBREV 712881289struct object_context {1290unsigned char tree[20];1291unsigned mode;1292/*1293 * symlink_path is only used by get_tree_entry_follow_symlinks,1294 * and only for symlinks that point outside the repository.1295 */1296struct strbuf symlink_path;1297/*1298 * If GET_SHA1_RECORD_PATH is set, this will record path (if any)1299 * found when resolving the name. The caller is responsible for1300 * releasing the memory.1301 */1302char*path;1303};13041305#define GET_SHA1_QUIETLY 011306#define GET_SHA1_COMMIT 021307#define GET_SHA1_COMMITTISH 041308#define GET_SHA1_TREE 0101309#define GET_SHA1_TREEISH 0201310#define GET_SHA1_BLOB 0401311#define GET_SHA1_FOLLOW_SYMLINKS 01001312#define GET_SHA1_RECORD_PATH 02001313#define GET_SHA1_ONLY_TO_DIE 0400013141315#define GET_SHA1_DISAMBIGUATORS \1316 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \1317 GET_SHA1_TREE | GET_SHA1_TREEISH | \1318 GET_SHA1_BLOB)13191320externintget_sha1(const char*str,unsigned char*sha1);1321externintget_sha1_commit(const char*str,unsigned char*sha1);1322externintget_sha1_committish(const char*str,unsigned char*sha1);1323externintget_sha1_tree(const char*str,unsigned char*sha1);1324externintget_sha1_treeish(const char*str,unsigned char*sha1);1325externintget_sha1_blob(const char*str,unsigned char*sha1);1326externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1327externintget_sha1_with_context(const char*str,unsigned flags,unsigned char*sha1,struct object_context *oc);13281329externintget_oid(const char*str,struct object_id *oid);13301331typedefinteach_abbrev_fn(const struct object_id *oid,void*);1332externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13331334externintset_disambiguate_hint_config(const char*var,const char*value);13351336/*1337 * Try to read a SHA1 in hexadecimal format from the 40 characters1338 * starting at hex. Write the 20-byte result to sha1 in binary form.1339 * Return 0 on success. Reading stops if a NUL is encountered in the1340 * input, so it is safe to pass this function an arbitrary1341 * null-terminated string.1342 */1343externintget_sha1_hex(const char*hex,unsigned char*sha1);1344externintget_oid_hex(const char*hex,struct object_id *sha1);13451346/*1347 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1348 * and writes the NUL-terminated output to the buffer `out`, which must be at1349 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1350 * convenience.1351 *1352 * The non-`_r` variant returns a static buffer, but uses a ring of 41353 * buffers, making it safe to make multiple calls for a single statement, like:1354 *1355 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1356 */1357externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1358externchar*oid_to_hex_r(char*out,const struct object_id *oid);1359externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1360externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */13611362/*1363 * Parse a 40-character hexadecimal object ID starting from hex, updating the1364 * pointer specified by end when parsing stops. The resulting object ID is1365 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1366 * other invalid character. end is only updated on success; otherwise, it is1367 * unmodified.1368 */1369externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);13701371/*1372 * This reads short-hand syntax that not only evaluates to a commit1373 * object name, but also can act as if the end user spelled the name1374 * of the branch from the command line.1375 *1376 * - "@{-N}" finds the name of the Nth previous branch we were on, and1377 * places the name of the branch in the given buf and returns the1378 * number of characters parsed if successful.1379 *1380 * - "<branch>@{upstream}" finds the name of the other ref that1381 * <branch> is configured to merge with (missing <branch> defaults1382 * to the current branch), and places the name of the branch in the1383 * given buf and returns the number of characters parsed if1384 * successful.1385 *1386 * If the input is not of the accepted format, it returns a negative1387 * number to signal an error.1388 *1389 * If the input was ok but there are not N branch switches in the1390 * reflog, it returns 0.1391 *1392 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1393 * expansions: local branches ("refs/heads/"), remote branches1394 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1395 * allowed, even ones to refs outside of those namespaces.1396 */1397#define INTERPRET_BRANCH_LOCAL (1<<0)1398#define INTERPRET_BRANCH_REMOTE (1<<1)1399#define INTERPRET_BRANCH_HEAD (1<<2)1400externintinterpret_branch_name(const char*str,int len,struct strbuf *,1401unsigned allowed);1402externintget_oid_mb(const char*str,struct object_id *oid);14031404externintvalidate_headref(const char*ref);14051406externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1407externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1408externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1409externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);14101411externvoid*read_object_with_reference(const unsigned char*sha1,1412const char*required_type,1413unsigned long*size,1414unsigned char*sha1_ret);14151416externstruct object *peel_to_type(const char*name,int namelen,1417struct object *o,enum object_type);14181419struct date_mode {1420enum date_mode_type {1421 DATE_NORMAL =0,1422 DATE_RELATIVE,1423 DATE_SHORT,1424 DATE_ISO8601,1425 DATE_ISO8601_STRICT,1426 DATE_RFC2822,1427 DATE_STRFTIME,1428 DATE_RAW,1429 DATE_UNIX1430} type;1431const char*strftime_fmt;1432int local;1433};14341435/*1436 * Convenience helper for passing a constant type, like:1437 *1438 * show_date(t, tz, DATE_MODE(NORMAL));1439 */1440#define DATE_MODE(t) date_mode_from_type(DATE_##t)1441struct date_mode *date_mode_from_type(enum date_mode_type type);14421443const char*show_date(timestamp_t time,int timezone,const struct date_mode *mode);1444voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1445struct strbuf *timebuf);1446intparse_date(const char*date,struct strbuf *out);1447intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1448intparse_expiry_date(const char*date, timestamp_t *timestamp);1449voiddatestamp(struct strbuf *out);1450#define approxidate(s) approxidate_careful((s), NULL)1451timestamp_t approxidate_careful(const char*,int*);1452timestamp_t approxidate_relative(const char*date,const struct timeval *now);1453voidparse_date_format(const char*format,struct date_mode *mode);1454intdate_overflows(timestamp_t date);14551456#define IDENT_STRICT 11457#define IDENT_NO_DATE 21458#define IDENT_NO_NAME 41459externconst char*git_author_info(int);1460externconst char*git_committer_info(int);1461externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1462externconst char*fmt_name(const char*name,const char*email);1463externconst char*ident_default_name(void);1464externconst char*ident_default_email(void);1465externconst char*git_editor(void);1466externconst char*git_pager(int stdout_is_tty);1467externintgit_ident_config(const char*,const char*,void*);1468externvoidreset_ident_date(void);14691470struct ident_split {1471const char*name_begin;1472const char*name_end;1473const char*mail_begin;1474const char*mail_end;1475const char*date_begin;1476const char*date_end;1477const char*tz_begin;1478const char*tz_end;1479};1480/*1481 * Signals an success with 0, but time part of the result may be NULL1482 * if the input lacks timestamp and zone1483 */1484externintsplit_ident_line(struct ident_split *,const char*,int);14851486/*1487 * Like show_date, but pull the timestamp and tz parameters from1488 * the ident_split. It will also sanity-check the values and produce1489 * a well-known sentinel date if they appear bogus.1490 */1491const char*show_ident_date(const struct ident_split *id,1492const struct date_mode *mode);14931494/*1495 * Compare split idents for equality or strict ordering. Note that we1496 * compare only the ident part of the line, ignoring any timestamp.1497 *1498 * Because there are two fields, we must choose one as the primary key; we1499 * currently arbitrarily pick the email.1500 */1501externintident_cmp(const struct ident_split *,const struct ident_split *);15021503struct checkout {1504struct index_state *istate;1505const char*base_dir;1506int base_dir_len;1507unsigned force:1,1508 quiet:1,1509 not_new:1,1510 refresh_cache:1;1511};1512#define CHECKOUT_INIT { NULL,"" }15131514#define TEMPORARY_FILENAME_LENGTH 251515externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);15161517struct cache_def {1518struct strbuf path;1519int flags;1520int track_flags;1521int prefix_len_stat_func;1522};1523#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1524staticinlinevoidcache_def_clear(struct cache_def *cache)1525{1526strbuf_release(&cache->path);1527}15281529externinthas_symlink_leading_path(const char*name,int len);1530externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1531externintcheck_leading_path(const char*name,int len);1532externinthas_dirs_only_path(const char*name,int len,int prefix_len);1533externvoidschedule_dir_for_removal(const char*name,int len);1534externvoidremove_scheduled_dirs(void);15351536externstruct alternate_object_database {1537struct alternate_object_database *next;15381539/* see alt_scratch_buf() */1540struct strbuf scratch;1541size_t base_len;15421543char path[FLEX_ARRAY];1544} *alt_odb_list;1545externvoidprepare_alt_odb(void);1546externvoidread_info_alternates(const char* relative_base,int depth);1547externchar*compute_alternate_path(const char*path,struct strbuf *err);1548typedefintalt_odb_fn(struct alternate_object_database *,void*);1549externintforeach_alt_odb(alt_odb_fn,void*);15501551/*1552 * Allocate a "struct alternate_object_database" but do _not_ actually1553 * add it to the list of alternates.1554 */1555struct alternate_object_database *alloc_alt_odb(const char*dir);15561557/*1558 * Add the directory to the on-disk alternates file; the new entry will also1559 * take effect in the current process.1560 */1561externvoidadd_to_alternates_file(const char*dir);15621563/*1564 * Add the directory to the in-memory list of alternates (along with any1565 * recursive alternates it points to), but do not modify the on-disk alternates1566 * file.1567 */1568externvoidadd_to_alternates_memory(const char*dir);15691570/*1571 * Returns a scratch strbuf pre-filled with the alternate object directory,1572 * including a trailing slash, which can be used to access paths in the1573 * alternate. Always use this over direct access to alt->scratch, as it1574 * cleans up any previous use of the scratch buffer.1575 */1576externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);15771578struct pack_window {1579struct pack_window *next;1580unsigned char*base;1581 off_t offset;1582size_t len;1583unsigned int last_used;1584unsigned int inuse_cnt;1585};15861587externstruct packed_git {1588struct packed_git *next;1589struct pack_window *windows;1590 off_t pack_size;1591const void*index_data;1592size_t index_size;1593uint32_t num_objects;1594uint32_t num_bad_objects;1595unsigned char*bad_object_sha1;1596int index_version;1597time_t mtime;1598int pack_fd;1599unsigned pack_local:1,1600 pack_keep:1,1601 freshened:1,1602 do_not_close:1;1603unsigned char sha1[20];1604struct revindex_entry *revindex;1605/* something like ".git/objects/pack/xxxxx.pack" */1606char pack_name[FLEX_ARRAY];/* more */1607} *packed_git;16081609/*1610 * A most-recently-used ordered version of the packed_git list, which can1611 * be iterated instead of packed_git (and marked via mru_mark).1612 */1613struct mru;1614externstruct mru *packed_git_mru;16151616struct pack_entry {1617 off_t offset;1618unsigned char sha1[20];1619struct packed_git *p;1620};16211622externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path);16231624/* A hook to report invalid files in pack directory */1625#define PACKDIR_FILE_PACK 11626#define PACKDIR_FILE_IDX 21627#define PACKDIR_FILE_GARBAGE 41628externvoid(*report_garbage)(unsigned seen_bits,const char*path);16291630externvoidprepare_packed_git(void);1631externvoidreprepare_packed_git(void);1632externvoidinstall_packed_git(struct packed_git *pack);16331634/*1635 * Give a rough count of objects in the repository. This sacrifices accuracy1636 * for speed.1637 */1638unsigned longapproximate_object_count(void);16391640externstruct packed_git *find_sha1_pack(const unsigned char*sha1,1641struct packed_git *packs);16421643externvoidpack_report(void);16441645/*1646 * Create a temporary file rooted in the object database directory, or1647 * die on failure. The filename is taken from "pattern", which should have the1648 * usual "XXXXXX" trailer, and the resulting filename is written into the1649 * "template" buffer. Returns the open descriptor.1650 */1651externintodb_mkstemp(struct strbuf *template,const char*pattern);16521653/*1654 * Generate the filename to be used for a pack file with checksum "sha1" and1655 * extension "ext". The result is written into the strbuf "buf", overwriting1656 * any existing contents. A pointer to buf->buf is returned as a convenience.1657 *1658 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"1659 */1660externchar*odb_pack_name(struct strbuf *buf,const unsigned char*sha1,const char*ext);16611662/*1663 * Create a pack .keep file named "name" (which should generally be the output1664 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1665 * error.1666 */1667externintodb_pack_keep(const char*name);16681669/*1670 * mmap the index file for the specified packfile (if it is not1671 * already mmapped). Return 0 on success.1672 */1673externintopen_pack_index(struct packed_git *);16741675/*1676 * munmap the index file for the specified packfile (if it is1677 * currently mmapped).1678 */1679externvoidclose_pack_index(struct packed_git *);16801681externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*);1682externvoidclose_pack_windows(struct packed_git *);1683externvoidclose_all_packs(void);1684externvoidunuse_pack(struct pack_window **);1685externvoidclear_delta_base_cache(void);1686externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local);16871688/*1689 * Make sure that a pointer access into an mmap'd index file is within bounds,1690 * and can provide at least 8 bytes of data.1691 *1692 * Note that this is only necessary for variable-length segments of the file1693 * (like the 64-bit extended offset table), as we compare the size to the1694 * fixed-length parts when we open the file.1695 */1696externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr);16971698/*1699 * Return the SHA-1 of the nth object within the specified packfile.1700 * Open the index if it is not already open. The return value points1701 * at the SHA-1 within the mmapped index. Return NULL if there is an1702 * error.1703 */1704externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n);1705/*1706 * Like nth_packed_object_sha1, but write the data into the object specified by1707 * the the first argument. Returns the first argument on success, and NULL on1708 * error.1709 */1710externconst struct object_id *nth_packed_object_oid(struct object_id *,struct packed_git *,uint32_t n);17111712/*1713 * Return the offset of the nth object within the specified packfile.1714 * The index must already be opened.1715 */1716extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n);17171718/*1719 * If the object named sha1 is present in the specified packfile,1720 * return its offset within the packfile; otherwise, return 0.1721 */1722extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *);17231724externintis_pack_valid(struct packed_git *);1725externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*);1726externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep);1727externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t);1728externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*);17291730/*1731 * Iterate over the files in the loose-object parts of the object1732 * directory "path", triggering the following callbacks:1733 *1734 * - loose_object is called for each loose object we find.1735 *1736 * - loose_cruft is called for any files that do not appear to be1737 * loose objects. Note that we only look in the loose object1738 * directories "objects/[0-9a-f]{2}/", so we will not report1739 * "objects/foobar" as cruft.1740 *1741 * - loose_subdir is called for each top-level hashed subdirectory1742 * of the object directory (e.g., "$OBJDIR/f0"). It is called1743 * after the objects in the directory are processed.1744 *1745 * Any callback that is NULL will be ignored. Callbacks returning non-zero1746 * will end the iteration.1747 *1748 * In the "buf" variant, "path" is a strbuf which will also be used as a1749 * scratch buffer, but restored to its original contents before1750 * the function returns.1751 */1752typedefinteach_loose_object_fn(const struct object_id *oid,1753const char*path,1754void*data);1755typedefinteach_loose_cruft_fn(const char*basename,1756const char*path,1757void*data);1758typedefinteach_loose_subdir_fn(int nr,1759const char*path,1760void*data);1761intfor_each_loose_file_in_objdir(const char*path,1762 each_loose_object_fn obj_cb,1763 each_loose_cruft_fn cruft_cb,1764 each_loose_subdir_fn subdir_cb,1765void*data);1766intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1767 each_loose_object_fn obj_cb,1768 each_loose_cruft_fn cruft_cb,1769 each_loose_subdir_fn subdir_cb,1770void*data);17711772/*1773 * Iterate over loose and packed objects in both the local1774 * repository and any alternates repositories (unless the1775 * LOCAL_ONLY flag is set).1776 */1777#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11778typedefinteach_packed_object_fn(const struct object_id *oid,1779struct packed_git *pack,1780uint32_t pos,1781void*data);1782externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);1783externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags);17841785struct object_info {1786/* Request */1787enum object_type *typep;1788unsigned long*sizep;1789 off_t *disk_sizep;1790unsigned char*delta_base_sha1;1791struct strbuf *typename;17921793/* Response */1794enum{1795 OI_CACHED,1796 OI_LOOSE,1797 OI_PACKED,1798 OI_DBCACHED1799} whence;1800union{1801/*1802 * struct {1803 * ... Nothing to expose in this case1804 * } cached;1805 * struct {1806 * ... Nothing to expose in this case1807 * } loose;1808 */1809struct{1810struct packed_git *pack;1811 off_t offset;1812unsigned int is_delta;1813} packed;1814} u;1815};18161817/*1818 * Initializer for a "struct object_info" that wants no items. You may1819 * also memset() the memory to all-zeroes.1820 */1821#define OBJECT_INFO_INIT {NULL}18221823externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);1824externintpacked_object_info(struct packed_git *pack, off_t offset,struct object_info *);18251826/* Dumb servers support */1827externintupdate_server_info(int);18281829externconst char*get_log_output_encoding(void);1830externconst char*get_commit_output_encoding(void);18311832/*1833 * This is a hack for test programs like test-dump-untracked-cache to1834 * ensure that they do not modify the untracked cache when reading it.1835 * Do not use it otherwise!1836 */1837externint ignore_untracked_cache_config;18381839externintcommitter_ident_sufficiently_given(void);1840externintauthor_ident_sufficiently_given(void);18411842externconst char*git_commit_encoding;1843externconst char*git_log_output_encoding;1844externconst char*git_mailmap_file;1845externconst char*git_mailmap_blob;18461847/* IO helper functions */1848externvoidmaybe_flush_or_die(FILE*,const char*);1849__attribute__((format(printf,2,3)))1850externvoidfprintf_or_die(FILE*,const char*fmt, ...);18511852#define COPY_READ_ERROR (-2)1853#define COPY_WRITE_ERROR (-3)1854externintcopy_fd(int ifd,int ofd);1855externintcopy_file(const char*dst,const char*src,int mode);1856externintcopy_file_with_time(const char*dst,const char*src,int mode);18571858externvoidwrite_or_die(int fd,const void*buf,size_t count);1859externvoidfsync_or_die(int fd,const char*);18601861extern ssize_t read_in_full(int fd,void*buf,size_t count);1862extern ssize_t write_in_full(int fd,const void*buf,size_t count);1863extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);18641865staticinline ssize_t write_str_in_full(int fd,const char*str)1866{1867returnwrite_in_full(fd, str,strlen(str));1868}18691870/**1871 * Open (and truncate) the file at path, write the contents of buf to it,1872 * and close it. Dies if any errors are encountered.1873 */1874externvoidwrite_file_buf(const char*path,const char*buf,size_t len);18751876/**1877 * Like write_file_buf(), but format the contents into a buffer first.1878 * Additionally, write_file() will append a newline if one is not already1879 * present, making it convenient to write text files:1880 *1881 * write_file(path, "counter: %d", ctr);1882 */1883__attribute__((format(printf,2,3)))1884externvoidwrite_file(const char*path,const char*fmt, ...);18851886/* pager.c */1887externvoidsetup_pager(void);1888externintpager_in_use(void);1889externint pager_use_color;1890externintterm_columns(void);1891externintdecimal_width(uintmax_t);1892externintcheck_pager_config(const char*cmd);1893externvoidprepare_pager_args(struct child_process *,const char*pager);18941895externconst char*editor_program;1896externconst char*askpass_program;1897externconst char*excludes_file;18981899/* base85 */1900intdecode_85(char*dst,const char*line,int linelen);1901voidencode_85(char*buf,const unsigned char*data,int bytes);19021903/* alloc.c */1904externvoid*alloc_blob_node(void);1905externvoid*alloc_tree_node(void);1906externvoid*alloc_commit_node(void);1907externvoid*alloc_tag_node(void);1908externvoid*alloc_object_node(void);1909externvoidalloc_report(void);1910externunsigned intalloc_commit_index(void);19111912/* pkt-line.c */1913voidpacket_trace_identity(const char*prog);19141915/* add */1916/*1917 * return 0 if success, 1 - if addition of a file failed and1918 * ADD_FILES_IGNORE_ERRORS was specified in flags1919 */1920intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);19211922/* diff.c */1923externint diff_auto_refresh_index;19241925/* match-trees.c */1926voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1927voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);19281929/*1930 * whitespace rules.1931 * used by both diff and apply1932 * last two digits are tab width1933 */1934#define WS_BLANK_AT_EOL 01001935#define WS_SPACE_BEFORE_TAB 02001936#define WS_INDENT_WITH_NON_TAB 04001937#define WS_CR_AT_EOL 010001938#define WS_BLANK_AT_EOF 020001939#define WS_TAB_IN_INDENT 040001940#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1941#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1942#define WS_TAB_WIDTH_MASK 0771943externunsigned whitespace_rule_cfg;1944externunsignedwhitespace_rule(const char*);1945externunsignedparse_whitespace_rule(const char*);1946externunsignedws_check(const char*line,int len,unsigned ws_rule);1947externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1948externchar*whitespace_error_string(unsigned ws);1949externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1950externintws_blank_line(const char*line,int len,unsigned ws_rule);1951#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)19521953/* ls-files */1954voidoverlay_tree_on_index(struct index_state *istate,1955const char*tree_name,const char*prefix);19561957char*alias_lookup(const char*alias);1958intsplit_cmdline(char*cmdline,const char***argv);1959/* Takes a negative value returned by split_cmdline */1960const char*split_cmdline_strerror(int cmdline_errno);19611962/* setup.c */1963struct startup_info {1964int have_repository;1965const char*prefix;1966};1967externstruct startup_info *startup_info;19681969/* merge.c */1970struct commit_list;1971inttry_merge_command(const char*strategy,size_t xopts_nr,1972const char**xopts,struct commit_list *common,1973const char*head_arg,struct commit_list *remotes);1974intcheckout_fast_forward(const struct object_id *from,1975const struct object_id *to,1976int overwrite_ignore);197719781979intsane_execvp(const char*file,char*const argv[]);19801981/*1982 * A struct to encapsulate the concept of whether a file has changed1983 * since we last checked it. This uses criteria similar to those used1984 * for the index.1985 */1986struct stat_validity {1987struct stat_data *sd;1988};19891990voidstat_validity_clear(struct stat_validity *sv);19911992/*1993 * Returns 1 if the path is a regular file (or a symlink to a regular1994 * file) and matches the saved stat_validity, 0 otherwise. A missing1995 * or inaccessible file is considered a match if the struct was just1996 * initialized, or if the previous update found an inaccessible file.1997 */1998intstat_validity_check(struct stat_validity *sv,const char*path);19992000/*2001 * Update the stat_validity from a file opened at descriptor fd. If2002 * the file is missing, inaccessible, or not a regular file, then2003 * future calls to stat_validity_check will match iff one of those2004 * conditions continues to be true.2005 */2006voidstat_validity_update(struct stat_validity *sv,int fd);20072008intversioncmp(const char*s1,const char*s2);2009voidsleep_millisec(int millisec);20102011/*2012 * Create a directory and (if share is nonzero) adjust its permissions2013 * according to the shared_repository setting. Only use this for2014 * directories under $GIT_DIR. Don't use it for working tree2015 * directories.2016 */2017voidsafe_create_dir(const char*dir,int share);20182019#endif/* CACHE_H */