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 14#include SHA1_HEADER 15#ifndef platform_SHA_CTX 16/* 17 * platform's underlying implementation of SHA-1; could be OpenSSL, 18 * blk_SHA, Apple CommonCrypto, etc... Note that including 19 * SHA1_HEADER may have already defined platform_SHA_CTX for our 20 * own implementations like block-sha1 and ppc-sha1, so we list 21 * the default for OpenSSL compatible SHA-1 implementations here. 22 */ 23#define platform_SHA_CTX SHA_CTX 24#define platform_SHA1_Init SHA1_Init 25#define platform_SHA1_Update SHA1_Update 26#define platform_SHA1_Final SHA1_Final 27#endif 28 29#define git_SHA_CTX platform_SHA_CTX 30#define git_SHA1_Init platform_SHA1_Init 31#define git_SHA1_Update platform_SHA1_Update 32#define git_SHA1_Final platform_SHA1_Final 33 34#ifdef SHA1_MAX_BLOCK_SIZE 35#include"compat/sha1-chunked.h" 36#undef git_SHA1_Update 37#define git_SHA1_Update git_SHA1_Update_Chunked 38#endif 39 40#include <zlib.h> 41typedefstruct git_zstream { 42 z_stream z; 43unsigned long avail_in; 44unsigned long avail_out; 45unsigned long total_in; 46unsigned long total_out; 47unsigned char*next_in; 48unsigned char*next_out; 49} git_zstream; 50 51voidgit_inflate_init(git_zstream *); 52voidgit_inflate_init_gzip_only(git_zstream *); 53voidgit_inflate_end(git_zstream *); 54intgit_inflate(git_zstream *,int flush); 55 56voidgit_deflate_init(git_zstream *,int level); 57voidgit_deflate_init_gzip(git_zstream *,int level); 58voidgit_deflate_init_raw(git_zstream *,int level); 59voidgit_deflate_end(git_zstream *); 60intgit_deflate_abort(git_zstream *); 61intgit_deflate_end_gently(git_zstream *); 62intgit_deflate(git_zstream *,int flush); 63unsigned longgit_deflate_bound(git_zstream *,unsigned long); 64 65/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 66#define GIT_SHA1_RAWSZ 20 67#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 68 69struct object_id { 70unsigned char hash[GIT_SHA1_RAWSZ]; 71}; 72 73#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 74#define DTYPE(de) ((de)->d_type) 75#else 76#undef DT_UNKNOWN 77#undef DT_DIR 78#undef DT_REG 79#undef DT_LNK 80#define DT_UNKNOWN 0 81#define DT_DIR 1 82#define DT_REG 2 83#define DT_LNK 3 84#define DTYPE(de) DT_UNKNOWN 85#endif 86 87/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 88#define S_IFINVALID 0030000 89 90/* 91 * A "directory link" is a link to another git directory. 92 * 93 * The value 0160000 is not normally a valid mode, and 94 * also just happens to be S_IFDIR + S_IFLNK 95 */ 96#define S_IFGITLINK 0160000 97#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 98 99/* 100 * Some mode bits are also used internally for computations. 101 * 102 * They *must* not overlap with any valid modes, and they *must* not be emitted 103 * to outside world - i.e. appear on disk or network. In other words, it's just 104 * temporary fields, which we internally use, but they have to stay in-house. 105 * 106 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 107 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 108 */ 109 110/* used internally in tree-diff */ 111#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 112 113 114/* 115 * Intensive research over the course of many years has shown that 116 * port 9418 is totally unused by anything else. Or 117 * 118 * Your search - "port 9418" - did not match any documents. 119 * 120 * as www.google.com puts it. 121 * 122 * This port has been properly assigned for git use by IANA: 123 * git (Assigned-9418) [I06-050728-0001]. 124 * 125 * git 9418/tcp git pack transfer service 126 * git 9418/udp git pack transfer service 127 * 128 * with Linus Torvalds <torvalds@osdl.org> as the point of 129 * contact. September 2005. 130 * 131 * See http://www.iana.org/assignments/port-numbers 132 */ 133#define DEFAULT_GIT_PORT 9418 134 135/* 136 * Basic data structures for the directory cache 137 */ 138 139#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 140struct cache_header { 141uint32_t hdr_signature; 142uint32_t hdr_version; 143uint32_t hdr_entries; 144}; 145 146#define INDEX_FORMAT_LB 2 147#define INDEX_FORMAT_UB 4 148 149/* 150 * The "cache_time" is just the low 32 bits of the 151 * time. It doesn't matter if it overflows - we only 152 * check it for equality in the 32 bits we save. 153 */ 154struct cache_time { 155uint32_t sec; 156uint32_t nsec; 157}; 158 159struct stat_data { 160struct cache_time sd_ctime; 161struct cache_time sd_mtime; 162unsigned int sd_dev; 163unsigned int sd_ino; 164unsigned int sd_uid; 165unsigned int sd_gid; 166unsigned int sd_size; 167}; 168 169struct cache_entry { 170struct hashmap_entry ent; 171struct stat_data ce_stat_data; 172unsigned int ce_mode; 173unsigned int ce_flags; 174unsigned int ce_namelen; 175unsigned int index;/* for link extension */ 176struct object_id oid; 177char name[FLEX_ARRAY];/* more */ 178}; 179 180#define CE_STAGEMASK (0x3000) 181#define CE_EXTENDED (0x4000) 182#define CE_VALID (0x8000) 183#define CE_STAGESHIFT 12 184 185/* 186 * Range 0xFFFF0FFF in ce_flags is divided into 187 * two parts: in-memory flags and on-disk ones. 188 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 189 * if you want to save a new flag, add it in 190 * CE_EXTENDED_FLAGS 191 * 192 * In-memory only flags 193 */ 194#define CE_UPDATE (1 << 16) 195#define CE_REMOVE (1 << 17) 196#define CE_UPTODATE (1 << 18) 197#define CE_ADDED (1 << 19) 198 199#define CE_HASHED (1 << 20) 200#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 201#define CE_CONFLICTED (1 << 23) 202 203#define CE_UNPACKED (1 << 24) 204#define CE_NEW_SKIP_WORKTREE (1 << 25) 205 206/* used to temporarily mark paths matched by pathspecs */ 207#define CE_MATCHED (1 << 26) 208 209#define CE_UPDATE_IN_BASE (1 << 27) 210#define CE_STRIP_NAME (1 << 28) 211 212/* 213 * Extended on-disk flags 214 */ 215#define CE_INTENT_TO_ADD (1 << 29) 216#define CE_SKIP_WORKTREE (1 << 30) 217/* CE_EXTENDED2 is for future extension */ 218#define CE_EXTENDED2 (1U << 31) 219 220#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 221 222/* 223 * Safeguard to avoid saving wrong flags: 224 * - CE_EXTENDED2 won't get saved until its semantic is known 225 * - Bits in 0x0000FFFF have been saved in ce_flags already 226 * - Bits in 0x003F0000 are currently in-memory flags 227 */ 228#if CE_EXTENDED_FLAGS & 0x803FFFFF 229#error"CE_EXTENDED_FLAGS out of range" 230#endif 231 232/* Forward structure decls */ 233struct pathspec; 234struct child_process; 235 236/* 237 * Copy the sha1 and stat state of a cache entry from one to 238 * another. But we never change the name, or the hash state! 239 */ 240staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 241const struct cache_entry *src) 242{ 243unsigned int state = dst->ce_flags & CE_HASHED; 244 245/* Don't copy hash chain and name */ 246memcpy(&dst->ce_stat_data, &src->ce_stat_data, 247offsetof(struct cache_entry, name) - 248offsetof(struct cache_entry, ce_stat_data)); 249 250/* Restore the hash state */ 251 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 252} 253 254staticinlineunsignedcreate_ce_flags(unsigned stage) 255{ 256return(stage << CE_STAGESHIFT); 257} 258 259#define ce_namelen(ce) ((ce)->ce_namelen) 260#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 261#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 262#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 263#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 264#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 265#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 266 267#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 268staticinlineunsigned intcreate_ce_mode(unsigned int mode) 269{ 270if(S_ISLNK(mode)) 271return S_IFLNK; 272if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 273return S_IFGITLINK; 274return S_IFREG |ce_permissions(mode); 275} 276staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 277unsigned int mode) 278{ 279externint trust_executable_bit, has_symlinks; 280if(!has_symlinks &&S_ISREG(mode) && 281 ce &&S_ISLNK(ce->ce_mode)) 282return ce->ce_mode; 283if(!trust_executable_bit &&S_ISREG(mode)) { 284if(ce &&S_ISREG(ce->ce_mode)) 285return ce->ce_mode; 286returncreate_ce_mode(0666); 287} 288returncreate_ce_mode(mode); 289} 290staticinlineintce_to_dtype(const struct cache_entry *ce) 291{ 292unsigned ce_mode =ntohl(ce->ce_mode); 293if(S_ISREG(ce_mode)) 294return DT_REG; 295else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 296return DT_DIR; 297else if(S_ISLNK(ce_mode)) 298return DT_LNK; 299else 300return DT_UNKNOWN; 301} 302staticinlineunsigned intcanon_mode(unsigned int mode) 303{ 304if(S_ISREG(mode)) 305return S_IFREG |ce_permissions(mode); 306if(S_ISLNK(mode)) 307return S_IFLNK; 308if(S_ISDIR(mode)) 309return S_IFDIR; 310return S_IFGITLINK; 311} 312 313#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 314 315#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 316#define CE_ENTRY_CHANGED (1 << 1) 317#define CE_ENTRY_REMOVED (1 << 2) 318#define CE_ENTRY_ADDED (1 << 3) 319#define RESOLVE_UNDO_CHANGED (1 << 4) 320#define CACHE_TREE_CHANGED (1 << 5) 321#define SPLIT_INDEX_ORDERED (1 << 6) 322#define UNTRACKED_CHANGED (1 << 7) 323 324struct split_index; 325struct untracked_cache; 326 327struct index_state { 328struct cache_entry **cache; 329unsigned int version; 330unsigned int cache_nr, cache_alloc, cache_changed; 331struct string_list *resolve_undo; 332struct cache_tree *cache_tree; 333struct split_index *split_index; 334struct cache_time timestamp; 335unsigned name_hash_initialized :1, 336 initialized :1; 337struct hashmap name_hash; 338struct hashmap dir_hash; 339unsigned char sha1[20]; 340struct untracked_cache *untracked; 341}; 342 343externstruct index_state the_index; 344 345/* Name hashing */ 346externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 347externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 348externvoidfree_name_hash(struct index_state *istate); 349 350 351#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 352#define active_cache (the_index.cache) 353#define active_nr (the_index.cache_nr) 354#define active_alloc (the_index.cache_alloc) 355#define active_cache_changed (the_index.cache_changed) 356#define active_cache_tree (the_index.cache_tree) 357 358#define read_cache() read_index(&the_index) 359#define read_cache_from(path) read_index_from(&the_index, (path)) 360#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 361#define is_cache_unborn() is_index_unborn(&the_index) 362#define read_cache_unmerged() read_index_unmerged(&the_index) 363#define discard_cache() discard_index(&the_index) 364#define unmerged_cache() unmerged_index(&the_index) 365#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 366#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 367#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 368#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 369#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 370#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 371#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 372#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 373#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 374#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 375#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 376#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 377#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 378#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 379#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 380#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 381#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 382#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 383#endif 384 385enum object_type { 386 OBJ_BAD = -1, 387 OBJ_NONE =0, 388 OBJ_COMMIT =1, 389 OBJ_TREE =2, 390 OBJ_BLOB =3, 391 OBJ_TAG =4, 392/* 5 for future expansion */ 393 OBJ_OFS_DELTA =6, 394 OBJ_REF_DELTA =7, 395 OBJ_ANY, 396 OBJ_MAX 397}; 398 399staticinlineenum object_type object_type(unsigned int mode) 400{ 401returnS_ISDIR(mode) ? OBJ_TREE : 402S_ISGITLINK(mode) ? OBJ_COMMIT : 403 OBJ_BLOB; 404} 405 406/* Double-check local_repo_env below if you add to this list. */ 407#define GIT_DIR_ENVIRONMENT"GIT_DIR" 408#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 409#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 410#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 411#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 412#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 413#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 414#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 415#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 416#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 417#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 418#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 419#define CONFIG_ENVIRONMENT"GIT_CONFIG" 420#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 421#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 422#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 423#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 424#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 425#define GITATTRIBUTES_FILE".gitattributes" 426#define INFOATTRIBUTES_FILE"info/attributes" 427#define ATTRIBUTE_MACRO_PREFIX"[attr]" 428#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 429#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 430#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 431#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 432#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 433#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 434#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 435#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 436#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 437#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 438 439/* 440 * This environment variable is expected to contain a boolean indicating 441 * whether we should or should not treat: 442 * 443 * GIT_DIR=foo.git git ... 444 * 445 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 446 * of this, but we use it internally to communicate to sub-processes that we 447 * are in a bare repo. If not set, defaults to true. 448 */ 449#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 450 451/* 452 * Repository-local GIT_* environment variables; these will be cleared 453 * when git spawns a sub-process that runs inside another repository. 454 * The array is NULL-terminated, which makes it easy to pass in the "env" 455 * parameter of a run-command invocation, or to do a simple walk. 456 */ 457externconst char*const local_repo_env[]; 458 459/* 460 * Returns true iff we have a configured git repository (either via 461 * setup_git_directory, or in the environment via $GIT_DIR). 462 */ 463inthave_git_dir(void); 464 465externint is_bare_repository_cfg; 466externintis_bare_repository(void); 467externintis_inside_git_dir(void); 468externchar*git_work_tree_cfg; 469externintis_inside_work_tree(void); 470externconst char*get_git_dir(void); 471externconst char*get_git_common_dir(void); 472externchar*get_object_directory(void); 473externchar*get_index_file(void); 474externchar*get_graft_file(void); 475externintset_git_dir(const char*path); 476externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 477externintget_common_dir(struct strbuf *sb,const char*gitdir); 478externconst char*get_git_namespace(void); 479externconst char*strip_namespace(const char*namespaced_ref); 480externconst char*get_super_prefix(void); 481externconst char*get_git_work_tree(void); 482 483/* 484 * Return true if the given path is a git directory; note that this _just_ 485 * looks at the directory itself. If you want to know whether "foo/.git" 486 * is a repository, you must feed that path, not just "foo". 487 */ 488externintis_git_directory(const char*path); 489 490/* 491 * Return 1 if the given path is the root of a git repository or 492 * submodule, else 0. Will not return 1 for bare repositories with the 493 * exception of creating a bare repository in "foo/.git" and calling 494 * is_git_repository("foo"). 495 * 496 * If we run into read errors, we err on the side of saying "yes, it is", 497 * as we usually consider sub-repos precious, and would prefer to err on the 498 * side of not disrupting or deleting them. 499 */ 500externintis_nonbare_repository_dir(struct strbuf *path); 501 502#define READ_GITFILE_ERR_STAT_FAILED 1 503#define READ_GITFILE_ERR_NOT_A_FILE 2 504#define READ_GITFILE_ERR_OPEN_FAILED 3 505#define READ_GITFILE_ERR_READ_FAILED 4 506#define READ_GITFILE_ERR_INVALID_FORMAT 5 507#define READ_GITFILE_ERR_NO_PATH 6 508#define READ_GITFILE_ERR_NOT_A_REPO 7 509#define READ_GITFILE_ERR_TOO_LARGE 8 510externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 511externconst char*read_gitfile_gently(const char*path,int*return_error_code); 512#define read_gitfile(path) read_gitfile_gently((path), NULL) 513externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 514#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 515 516externvoidset_git_work_tree(const char*tree); 517 518#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 519 520externvoidsetup_work_tree(void); 521externconst char*setup_git_directory_gently(int*); 522externconst char*setup_git_directory(void); 523externchar*prefix_path(const char*prefix,int len,const char*path); 524externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 525externconst char*prefix_filename(const char*prefix,int len,const char*path); 526externintcheck_filename(const char*prefix,const char*name); 527externvoidverify_filename(const char*prefix, 528const char*name, 529int diagnose_misspelt_rev); 530externvoidverify_non_filename(const char*prefix,const char*name); 531externintpath_inside_repo(const char*prefix,const char*path); 532 533#define INIT_DB_QUIET 0x0001 534#define INIT_DB_EXIST_OK 0x0002 535 536externintinit_db(const char*git_dir,const char*real_git_dir, 537const char*template_dir,unsigned int flags); 538 539externvoidsanitize_stdfds(void); 540externintdaemonize(void); 541 542#define alloc_nr(x) (((x)+16)*3/2) 543 544/* 545 * Realloc the buffer pointed at by variable 'x' so that it can hold 546 * at least 'nr' entries; the number of entries currently allocated 547 * is 'alloc', using the standard growing factor alloc_nr() macro. 548 * 549 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 550 */ 551#define ALLOC_GROW(x, nr, alloc) \ 552 do { \ 553 if ((nr) > alloc) { \ 554 if (alloc_nr(alloc) < (nr)) \ 555 alloc = (nr); \ 556 else \ 557 alloc = alloc_nr(alloc); \ 558 REALLOC_ARRAY(x, alloc); \ 559 } \ 560 } while (0) 561 562/* Initialize and use the cache information */ 563struct lock_file; 564externintread_index(struct index_state *); 565externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 566externintdo_read_index(struct index_state *istate,const char*path, 567int must_exist);/* for testting only! */ 568externintread_index_from(struct index_state *,const char*path); 569externintis_index_unborn(struct index_state *); 570externintread_index_unmerged(struct index_state *); 571#define COMMIT_LOCK (1 << 0) 572#define CLOSE_LOCK (1 << 1) 573externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 574externintdiscard_index(struct index_state *); 575externintunmerged_index(const struct index_state *); 576externintverify_path(const char*path); 577externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 578externvoidadjust_dirname_case(struct index_state *istate,char*name); 579externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 580 581/* 582 * Searches for an entry defined by name and namelen in the given index. 583 * If the return value is positive (including 0) it is the position of an 584 * exact match. If the return value is negative, the negated value minus 1 585 * is the position where the entry would be inserted. 586 * Example: The current index consists of these files and its stages: 587 * 588 * b#0, d#0, f#1, f#3 589 * 590 * index_name_pos(&index, "a", 1) -> -1 591 * index_name_pos(&index, "b", 1) -> 0 592 * index_name_pos(&index, "c", 1) -> -2 593 * index_name_pos(&index, "d", 1) -> 1 594 * index_name_pos(&index, "e", 1) -> -3 595 * index_name_pos(&index, "f", 1) -> -3 596 * index_name_pos(&index, "g", 1) -> -5 597 */ 598externintindex_name_pos(const struct index_state *,const char*name,int namelen); 599 600#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 601#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 602#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 603#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 604#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 605#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 606externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 607externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 608 609/* Remove entry, return true if there are more entries to go. */ 610externintremove_index_entry_at(struct index_state *,int pos); 611 612externvoidremove_marked_cache_entries(struct index_state *istate); 613externintremove_file_from_index(struct index_state *,const char*path); 614#define ADD_CACHE_VERBOSE 1 615#define ADD_CACHE_PRETEND 2 616#define ADD_CACHE_IGNORE_ERRORS 4 617#define ADD_CACHE_IGNORE_REMOVAL 8 618#define ADD_CACHE_INTENT 16 619/* 620 * These two are used to add the contents of the file at path 621 * to the index, marking the working tree up-to-date by storing 622 * the cached stat info in the resulting cache entry. A caller 623 * that has already run lstat(2) on the path can call 624 * add_to_index(), and all others can call add_file_to_index(); 625 * the latter will do necessary lstat(2) internally before 626 * calling the former. 627 */ 628externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 629externintadd_file_to_index(struct index_state *,const char*path,int flags); 630 631externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 632externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 633externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 634externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 635externintindex_name_is_other(const struct index_state *,const char*,int); 636externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 637 638/* do stat comparison even if CE_VALID is true */ 639#define CE_MATCH_IGNORE_VALID 01 640/* do not check the contents but report dirty on racily-clean entries */ 641#define CE_MATCH_RACY_IS_DIRTY 02 642/* do stat comparison even if CE_SKIP_WORKTREE is true */ 643#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 644/* ignore non-existent files during stat update */ 645#define CE_MATCH_IGNORE_MISSING 0x08 646/* enable stat refresh */ 647#define CE_MATCH_REFRESH 0x10 648externintie_match_stat(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 649externintie_modified(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 650 651#define HASH_WRITE_OBJECT 1 652#define HASH_FORMAT_CHECK 2 653externintindex_fd(unsigned char*sha1,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 654externintindex_path(unsigned char*sha1,const char*path,struct stat *st,unsigned flags); 655 656/* 657 * Record to sd the data from st that we use to check whether a file 658 * might have changed. 659 */ 660externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 661 662/* 663 * Return 0 if st is consistent with a file not having been changed 664 * since sd was filled. If there are differences, return a 665 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 666 * INODE_CHANGED, and DATA_CHANGED. 667 */ 668externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 669externintmatch_stat_data_racy(const struct index_state *istate, 670const struct stat_data *sd,struct stat *st); 671 672externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 673 674#define REFRESH_REALLY 0x0001/* ignore_valid */ 675#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 676#define REFRESH_QUIET 0x0004/* be quiet about it */ 677#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 678#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 679#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 680externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 681externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 682 683externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 684 685externinthold_locked_index(struct lock_file *,int); 686externvoidset_alternate_index_output(const char*); 687 688/* Environment bits from configuration mechanism */ 689externint trust_executable_bit; 690externint trust_ctime; 691externint check_stat; 692externint quote_path_fully; 693externint has_symlinks; 694externint minimum_abbrev, default_abbrev; 695externint ignore_case; 696externint assume_unchanged; 697externint prefer_symlink_refs; 698externint log_all_ref_updates; 699externint warn_ambiguous_refs; 700externint warn_on_object_refname_ambiguity; 701externconst char*apply_default_whitespace; 702externconst char*apply_default_ignorewhitespace; 703externconst char*git_attributes_file; 704externconst char*git_hooks_path; 705externint zlib_compression_level; 706externint core_compression_level; 707externint pack_compression_level; 708externsize_t packed_git_window_size; 709externsize_t packed_git_limit; 710externsize_t delta_base_cache_limit; 711externunsigned long big_file_threshold; 712externunsigned long pack_size_limit_cfg; 713 714/* 715 * Accessors for the core.sharedrepository config which lazy-load the value 716 * from the config (if not already set). The "reset" function can be 717 * used to unset "set" or cached value, meaning that the value will be loaded 718 * fresh from the config file on the next call to get_shared_repository(). 719 */ 720voidset_shared_repository(int value); 721intget_shared_repository(void); 722voidreset_shared_repository(void); 723 724/* 725 * Do replace refs need to be checked this run? This variable is 726 * initialized to true unless --no-replace-object is used or 727 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 728 * commands that do not want replace references to be active. As an 729 * optimization it is also set to false if replace references have 730 * been sought but there were none. 731 */ 732externint check_replace_refs; 733externchar*git_replace_ref_base; 734 735externint fsync_object_files; 736externint core_preload_index; 737externint core_apply_sparse_checkout; 738externint precomposed_unicode; 739externint protect_hfs; 740externint protect_ntfs; 741externint git_db_env, git_index_env, git_graft_env, git_common_dir_env; 742 743/* 744 * Include broken refs in all ref iterations, which will 745 * generally choke dangerous operations rather than letting 746 * them silently proceed without taking the broken ref into 747 * account. 748 */ 749externint ref_paranoia; 750 751/* 752 * The character that begins a commented line in user-editable file 753 * that is subject to stripspace. 754 */ 755externchar comment_line_char; 756externint auto_comment_line_char; 757 758/* Windows only */ 759enum hide_dotfiles_type { 760 HIDE_DOTFILES_FALSE =0, 761 HIDE_DOTFILES_TRUE, 762 HIDE_DOTFILES_DOTGITONLY 763}; 764externenum hide_dotfiles_type hide_dotfiles; 765 766enum branch_track { 767 BRANCH_TRACK_UNSPECIFIED = -1, 768 BRANCH_TRACK_NEVER =0, 769 BRANCH_TRACK_REMOTE, 770 BRANCH_TRACK_ALWAYS, 771 BRANCH_TRACK_EXPLICIT, 772 BRANCH_TRACK_OVERRIDE 773}; 774 775enum rebase_setup_type { 776 AUTOREBASE_NEVER =0, 777 AUTOREBASE_LOCAL, 778 AUTOREBASE_REMOTE, 779 AUTOREBASE_ALWAYS 780}; 781 782enum push_default_type { 783 PUSH_DEFAULT_NOTHING =0, 784 PUSH_DEFAULT_MATCHING, 785 PUSH_DEFAULT_SIMPLE, 786 PUSH_DEFAULT_UPSTREAM, 787 PUSH_DEFAULT_CURRENT, 788 PUSH_DEFAULT_UNSPECIFIED 789}; 790 791externenum branch_track git_branch_track; 792externenum rebase_setup_type autorebase; 793externenum push_default_type push_default; 794 795enum object_creation_mode { 796 OBJECT_CREATION_USES_HARDLINKS =0, 797 OBJECT_CREATION_USES_RENAMES =1 798}; 799 800externenum object_creation_mode object_creation_mode; 801 802externchar*notes_ref_name; 803 804externint grafts_replace_parents; 805 806/* 807 * GIT_REPO_VERSION is the version we write by default. The 808 * _READ variant is the highest number we know how to 809 * handle. 810 */ 811#define GIT_REPO_VERSION 0 812#define GIT_REPO_VERSION_READ 1 813externint repository_format_precious_objects; 814 815struct repository_format { 816int version; 817int precious_objects; 818int is_bare; 819char*work_tree; 820struct string_list unknown_extensions; 821}; 822 823/* 824 * Read the repository format characteristics from the config file "path" into 825 * "format" struct. Returns the numeric version. On error, -1 is returned, 826 * format->version is set to -1, and all other fields in the struct are 827 * undefined. 828 */ 829intread_repository_format(struct repository_format *format,const char*path); 830 831/* 832 * Verify that the repository described by repository_format is something we 833 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 834 * any errors encountered. 835 */ 836intverify_repository_format(const struct repository_format *format, 837struct strbuf *err); 838 839/* 840 * Check the repository format version in the path found in get_git_dir(), 841 * and die if it is a version we don't understand. Generally one would 842 * set_git_dir() before calling this, and use it only for "are we in a valid 843 * repo?". 844 */ 845externvoidcheck_repository_format(void); 846 847#define MTIME_CHANGED 0x0001 848#define CTIME_CHANGED 0x0002 849#define OWNER_CHANGED 0x0004 850#define MODE_CHANGED 0x0008 851#define INODE_CHANGED 0x0010 852#define DATA_CHANGED 0x0020 853#define TYPE_CHANGED 0x0040 854 855/* 856 * Return a statically allocated filename, either generically (mkpath), in 857 * the repository directory (git_path), or in a submodule's repository 858 * directory (git_path_submodule). In all cases, note that the result 859 * may be overwritten by another call to _any_ of the functions. Consider 860 * using the safer "dup" or "strbuf" formats below (in some cases, the 861 * unsafe versions have already been removed). 862 */ 863externconst char*mkpath(const char*fmt, ...)__attribute__((format(printf,1,2))); 864externconst char*git_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 865externconst char*git_common_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 866 867externchar*mksnpath(char*buf,size_t n,const char*fmt, ...) 868__attribute__((format(printf,3,4))); 869externvoidstrbuf_git_path(struct strbuf *sb,const char*fmt, ...) 870__attribute__((format(printf,2,3))); 871externvoidstrbuf_git_common_path(struct strbuf *sb,const char*fmt, ...) 872__attribute__((format(printf,2,3))); 873externchar*git_path_buf(struct strbuf *buf,const char*fmt, ...) 874__attribute__((format(printf,2,3))); 875externintstrbuf_git_path_submodule(struct strbuf *sb,const char*path, 876const char*fmt, ...) 877__attribute__((format(printf,3,4))); 878externchar*git_pathdup(const char*fmt, ...) 879__attribute__((format(printf,1,2))); 880externchar*mkpathdup(const char*fmt, ...) 881__attribute__((format(printf,1,2))); 882externchar*git_pathdup_submodule(const char*path,const char*fmt, ...) 883__attribute__((format(printf,2,3))); 884 885externvoidreport_linked_checkout_garbage(void); 886 887/* 888 * You can define a static memoized git path like: 889 * 890 * static GIT_PATH_FUNC(git_path_foo, "FOO"); 891 * 892 * or use one of the global ones below. 893 */ 894#define GIT_PATH_FUNC(func, filename) \ 895 const char *func(void) \ 896 { \ 897 static char *ret; \ 898 if (!ret) \ 899 ret = git_pathdup(filename); \ 900 return ret; \ 901 } 902 903const char*git_path_cherry_pick_head(void); 904const char*git_path_revert_head(void); 905const char*git_path_squash_msg(void); 906const char*git_path_merge_msg(void); 907const char*git_path_merge_rr(void); 908const char*git_path_merge_mode(void); 909const char*git_path_merge_head(void); 910const char*git_path_fetch_head(void); 911const char*git_path_shallow(void); 912 913/* 914 * Return the name of the file in the local object database that would 915 * be used to store a loose object with the specified sha1. The 916 * return value is a pointer to a statically allocated buffer that is 917 * overwritten each time the function is called. 918 */ 919externconst char*sha1_file_name(const unsigned char*sha1); 920 921/* 922 * Return the name of the (local) packfile with the specified sha1 in 923 * its name. The return value is a pointer to memory that is 924 * overwritten each time this function is called. 925 */ 926externchar*sha1_pack_name(const unsigned char*sha1); 927 928/* 929 * Return the name of the (local) pack index file with the specified 930 * sha1 in its name. The return value is a pointer to memory that is 931 * overwritten each time this function is called. 932 */ 933externchar*sha1_pack_index_name(const unsigned char*sha1); 934 935/* 936 * Return an abbreviated sha1 unique within this repository's object database. 937 * The result will be at least `len` characters long, and will be NUL 938 * terminated. 939 * 940 * The non-`_r` version returns a static buffer which remains valid until 4 941 * more calls to find_unique_abbrev are made. 942 * 943 * The `_r` variant writes to a buffer supplied by the caller, which must be at 944 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 945 * written (excluding the NUL terminator). 946 * 947 * Note that while this version avoids the static buffer, it is not fully 948 * reentrant, as it calls into other non-reentrant git code. 949 */ 950externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 951externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 952 953externconst unsigned char null_sha1[GIT_SHA1_RAWSZ]; 954externconst struct object_id null_oid; 955 956staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 957{ 958int i; 959 960for(i =0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 961if(*sha1 != *sha2) 962return*sha1 - *sha2; 963} 964 965return0; 966} 967 968staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 969{ 970returnhashcmp(oid1->hash, oid2->hash); 971} 972 973staticinlineintis_null_sha1(const unsigned char*sha1) 974{ 975return!hashcmp(sha1, null_sha1); 976} 977 978staticinlineintis_null_oid(const struct object_id *oid) 979{ 980return!hashcmp(oid->hash, null_sha1); 981} 982 983staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src) 984{ 985memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 986} 987 988staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src) 989{ 990hashcpy(dst->hash, src->hash); 991} 992 993staticinlinevoidhashclr(unsigned char*hash) 994{ 995memset(hash,0, GIT_SHA1_RAWSZ); 996} 997 998staticinlinevoidoidclr(struct object_id *oid) 999{1000hashclr(oid->hash);1001}100210031004#define EMPTY_TREE_SHA1_HEX \1005"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1006#define EMPTY_TREE_SHA1_BIN_LITERAL \1007"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1008"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1009externconst struct object_id empty_tree_oid;1010#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10111012#define EMPTY_BLOB_SHA1_HEX \1013"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1014#define EMPTY_BLOB_SHA1_BIN_LITERAL \1015"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1016"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1017externconst struct object_id empty_blob_oid;1018#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)101910201021staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1022{1023return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1024}10251026staticinlineintis_empty_blob_oid(const struct object_id *oid)1027{1028return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1029}10301031staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1032{1033return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1034}10351036staticinlineintis_empty_tree_oid(const struct object_id *oid)1037{1038return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1039}104010411042intgit_mkstemp(char*path,size_t n,const char*template);10431044/* set default permissions by passing mode arguments to open(2) */1045intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1046intgit_mkstemp_mode(char*pattern,int mode);10471048/*1049 * NOTE NOTE NOTE!!1050 *1051 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1052 * not be changed. Old repositories have core.sharedrepository written in1053 * numeric format, and therefore these values are preserved for compatibility1054 * reasons.1055 */1056enum sharedrepo {1057 PERM_UMASK =0,1058 OLD_PERM_GROUP =1,1059 OLD_PERM_EVERYBODY =2,1060 PERM_GROUP =0660,1061 PERM_EVERYBODY =06641062};1063intgit_config_perm(const char*var,const char*value);1064intadjust_shared_perm(const char*path);10651066/*1067 * Create the directory containing the named path, using care to be1068 * somewhat safe against races. Return one of the scld_error values1069 * to indicate success/failure.1070 *1071 * SCLD_VANISHED indicates that one of the ancestor directories of the1072 * path existed at one point during the function call and then1073 * suddenly vanished, probably because another process pruned the1074 * directory while we were working. To be robust against this kind of1075 * race, callers might want to try invoking the function again when it1076 * returns SCLD_VANISHED.1077 *1078 * safe_create_leading_directories() temporarily changes path while it1079 * is working but restores it before returning.1080 * safe_create_leading_directories_const() doesn't modify path, even1081 * temporarily.1082 */1083enum scld_error {1084 SCLD_OK =0,1085 SCLD_FAILED = -1,1086 SCLD_PERMS = -2,1087 SCLD_EXISTS = -3,1088 SCLD_VANISHED = -41089};1090enum scld_error safe_create_leading_directories(char*path);1091enum scld_error safe_create_leading_directories_const(const char*path);10921093intmkdir_in_gitdir(const char*path);1094externchar*expand_user_path(const char*path);1095const char*enter_repo(const char*path,int strict);1096staticinlineintis_absolute_path(const char*path)1097{1098returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1099}1100intis_directory(const char*);1101char*strbuf_realpath(struct strbuf *resolved,const char*path,1102int die_on_error);1103const char*real_path(const char*path);1104const char*real_path_if_valid(const char*path);1105char*real_pathdup(const char*path);1106const char*absolute_path(const char*path);1107char*absolute_pathdup(const char*path);1108const char*remove_leading_path(const char*in,const char*prefix);1109const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1110intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1111intnormalize_path_copy(char*dst,const char*src);1112intlongest_ancestor_length(const char*path,struct string_list *prefixes);1113char*strip_path_suffix(const char*path,const char*suffix);1114intdaemon_avoid_alias(const char*path);1115externintis_ntfs_dotgit(const char*name);11161117/**1118 * Return a newly allocated string with the evaluation of1119 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1120 * "$HOME/.config/git/$filename". Return NULL upon error.1121 */1122externchar*xdg_config_home(const char*filename);11231124/* object replacement */1125#define LOOKUP_REPLACE_OBJECT 11126#define LOOKUP_UNKNOWN_OBJECT 21127externvoid*read_sha1_file_extended(const unsigned char*sha1,enum object_type *type,unsigned long*size,unsigned flag);1128staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1129{1130returnread_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);1131}11321133/*1134 * This internal function is only declared here for the benefit of1135 * lookup_replace_object(). Please do not call it directly.1136 */1137externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);11381139/*1140 * If object sha1 should be replaced, return the replacement object's1141 * name (replaced recursively, if necessary). The return value is1142 * either sha1 or a pointer to a permanently-allocated value. When1143 * object replacement is suppressed, always return sha1.1144 */1145staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1146{1147if(!check_replace_refs)1148return sha1;1149returndo_lookup_replace_object(sha1);1150}11511152staticinlineconst unsigned char*lookup_replace_object_extended(const unsigned char*sha1,unsigned flag)1153{1154if(!(flag & LOOKUP_REPLACE_OBJECT))1155return sha1;1156returnlookup_replace_object(sha1);1157}11581159/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1160externintsha1_object_info(const unsigned char*,unsigned long*);1161externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1);1162externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1);1163externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,unsigned char*sha1,unsigned flags);1164externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*);1165externintforce_object_loose(const unsigned char*sha1,time_t mtime);1166externintgit_open_cloexec(const char*name,int flags);1167#define git_open(name) git_open_cloexec(name, O_RDONLY)1168externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1169externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1170externintparse_sha1_header(const char*hdr,unsigned long*sizep);11711172/* global flag to enable extra checks when accessing packed objects */1173externint do_check_packed_object_crc;11741175externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);11761177externintfinalize_object_file(const char*tmpfile,const char*filename);11781179externinthas_sha1_pack(const unsigned char*sha1);11801181/*1182 * Open the loose object at path, check its sha1, and return the contents,1183 * type, and size. If the object is a blob, then "contents" may return NULL,1184 * to allow streaming of large blobs.1185 *1186 * Returns 0 on success, negative on error (details may be written to stderr).1187 */1188intread_loose_object(const char*path,1189const unsigned char*expected_sha1,1190enum object_type *type,1191unsigned long*size,1192void**contents);11931194/*1195 * Return true iff we have an object named sha1, whether local or in1196 * an alternate object database, and whether packed or loose. This1197 * function does not respect replace references.1198 *1199 * If the QUICK flag is set, do not re-check the pack directory1200 * when we cannot find the object (this means we may give a false1201 * negative answer if another process is simultaneously repacking).1202 */1203#define HAS_SHA1_QUICK 0x11204externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1205staticinlineinthas_sha1_file(const unsigned char*sha1)1206{1207returnhas_sha1_file_with_flags(sha1,0);1208}12091210/* Same as the above, except for struct object_id. */1211externinthas_object_file(const struct object_id *oid);1212externinthas_object_file_with_flags(const struct object_id *oid,int flags);12131214/*1215 * Return true iff an alternate object database has a loose object1216 * with the specified name. This function does not respect replace1217 * references.1218 */1219externinthas_loose_object_nonlocal(const unsigned char*sha1);12201221externinthas_pack_index(const unsigned char*sha1);12221223externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);12241225externconst signed char hexval_table[256];1226staticinlineunsigned inthexval(unsigned char c)1227{1228return hexval_table[c];1229}12301231/*1232 * Convert two consecutive hexadecimal digits into a char. Return a1233 * negative value on error. Don't run over the end of short strings.1234 */1235staticinlineinthex2chr(const char*s)1236{1237int val =hexval(s[0]);1238return(val <0) ? val : (val <<4) |hexval(s[1]);1239}12401241/* Convert to/from hex/sha1 representation */1242#define MINIMUM_ABBREV minimum_abbrev1243#define DEFAULT_ABBREV default_abbrev12441245/* used when the code does not know or care what the default abbrev is */1246#define FALLBACK_DEFAULT_ABBREV 712471248struct object_context {1249unsigned char tree[20];1250char path[PATH_MAX];1251unsigned mode;1252/*1253 * symlink_path is only used by get_tree_entry_follow_symlinks,1254 * and only for symlinks that point outside the repository.1255 */1256struct strbuf symlink_path;1257};12581259#define GET_SHA1_QUIETLY 011260#define GET_SHA1_COMMIT 021261#define GET_SHA1_COMMITTISH 041262#define GET_SHA1_TREE 0101263#define GET_SHA1_TREEISH 0201264#define GET_SHA1_BLOB 0401265#define GET_SHA1_FOLLOW_SYMLINKS 01001266#define GET_SHA1_ONLY_TO_DIE 0400012671268#define GET_SHA1_DISAMBIGUATORS \1269 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \1270 GET_SHA1_TREE | GET_SHA1_TREEISH | \1271 GET_SHA1_BLOB)12721273externintget_sha1(const char*str,unsigned char*sha1);1274externintget_sha1_commit(const char*str,unsigned char*sha1);1275externintget_sha1_committish(const char*str,unsigned char*sha1);1276externintget_sha1_tree(const char*str,unsigned char*sha1);1277externintget_sha1_treeish(const char*str,unsigned char*sha1);1278externintget_sha1_blob(const char*str,unsigned char*sha1);1279externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1280externintget_sha1_with_context(const char*str,unsigned flags,unsigned char*sha1,struct object_context *orc);12811282externintget_oid(const char*str,struct object_id *oid);12831284typedefinteach_abbrev_fn(const unsigned char*sha1,void*);1285externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);12861287externintset_disambiguate_hint_config(const char*var,const char*value);12881289/*1290 * Try to read a SHA1 in hexadecimal format from the 40 characters1291 * starting at hex. Write the 20-byte result to sha1 in binary form.1292 * Return 0 on success. Reading stops if a NUL is encountered in the1293 * input, so it is safe to pass this function an arbitrary1294 * null-terminated string.1295 */1296externintget_sha1_hex(const char*hex,unsigned char*sha1);1297externintget_oid_hex(const char*hex,struct object_id *sha1);12981299/*1300 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1301 * and writes the NUL-terminated output to the buffer `out`, which must be at1302 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1303 * convenience.1304 *1305 * The non-`_r` variant returns a static buffer, but uses a ring of 41306 * buffers, making it safe to make multiple calls for a single statement, like:1307 *1308 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1309 */1310externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1311externchar*oid_to_hex_r(char*out,const struct object_id *oid);1312externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1313externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */13141315externintinterpret_branch_name(const char*str,int len,struct strbuf *);1316externintget_oid_mb(const char*str,struct object_id *oid);13171318externintvalidate_headref(const char*ref);13191320externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1321externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1322externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1323externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);13241325externvoid*read_object_with_reference(const unsigned char*sha1,1326const char*required_type,1327unsigned long*size,1328unsigned char*sha1_ret);13291330externstruct object *peel_to_type(const char*name,int namelen,1331struct object *o,enum object_type);13321333struct date_mode {1334enum date_mode_type {1335 DATE_NORMAL =0,1336 DATE_RELATIVE,1337 DATE_SHORT,1338 DATE_ISO8601,1339 DATE_ISO8601_STRICT,1340 DATE_RFC2822,1341 DATE_STRFTIME,1342 DATE_RAW,1343 DATE_UNIX1344} type;1345const char*strftime_fmt;1346int local;1347};13481349/*1350 * Convenience helper for passing a constant type, like:1351 *1352 * show_date(t, tz, DATE_MODE(NORMAL));1353 */1354#define DATE_MODE(t) date_mode_from_type(DATE_##t)1355struct date_mode *date_mode_from_type(enum date_mode_type type);13561357const char*show_date(unsigned long time,int timezone,const struct date_mode *mode);1358voidshow_date_relative(unsigned long time,int tz,const struct timeval *now,1359struct strbuf *timebuf);1360intparse_date(const char*date,struct strbuf *out);1361intparse_date_basic(const char*date,unsigned long*timestamp,int*offset);1362intparse_expiry_date(const char*date,unsigned long*timestamp);1363voiddatestamp(struct strbuf *out);1364#define approxidate(s) approxidate_careful((s), NULL)1365unsigned longapproxidate_careful(const char*,int*);1366unsigned longapproxidate_relative(const char*date,const struct timeval *now);1367voidparse_date_format(const char*format,struct date_mode *mode);1368intdate_overflows(unsigned long date);13691370#define IDENT_STRICT 11371#define IDENT_NO_DATE 21372#define IDENT_NO_NAME 41373externconst char*git_author_info(int);1374externconst char*git_committer_info(int);1375externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1376externconst char*fmt_name(const char*name,const char*email);1377externconst char*ident_default_name(void);1378externconst char*ident_default_email(void);1379externconst char*git_editor(void);1380externconst char*git_pager(int stdout_is_tty);1381externintgit_ident_config(const char*,const char*,void*);1382externvoidreset_ident_date(void);13831384struct ident_split {1385const char*name_begin;1386const char*name_end;1387const char*mail_begin;1388const char*mail_end;1389const char*date_begin;1390const char*date_end;1391const char*tz_begin;1392const char*tz_end;1393};1394/*1395 * Signals an success with 0, but time part of the result may be NULL1396 * if the input lacks timestamp and zone1397 */1398externintsplit_ident_line(struct ident_split *,const char*,int);13991400/*1401 * Like show_date, but pull the timestamp and tz parameters from1402 * the ident_split. It will also sanity-check the values and produce1403 * a well-known sentinel date if they appear bogus.1404 */1405const char*show_ident_date(const struct ident_split *id,1406const struct date_mode *mode);14071408/*1409 * Compare split idents for equality or strict ordering. Note that we1410 * compare only the ident part of the line, ignoring any timestamp.1411 *1412 * Because there are two fields, we must choose one as the primary key; we1413 * currently arbitrarily pick the email.1414 */1415externintident_cmp(const struct ident_split *,const struct ident_split *);14161417struct checkout {1418struct index_state *istate;1419const char*base_dir;1420int base_dir_len;1421unsigned force:1,1422 quiet:1,1423 not_new:1,1424 refresh_cache:1;1425};1426#define CHECKOUT_INIT { NULL,"" }14271428#define TEMPORARY_FILENAME_LENGTH 251429externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);14301431struct cache_def {1432struct strbuf path;1433int flags;1434int track_flags;1435int prefix_len_stat_func;1436};1437#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1438staticinlinevoidcache_def_clear(struct cache_def *cache)1439{1440strbuf_release(&cache->path);1441}14421443externinthas_symlink_leading_path(const char*name,int len);1444externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1445externintcheck_leading_path(const char*name,int len);1446externinthas_dirs_only_path(const char*name,int len,int prefix_len);1447externvoidschedule_dir_for_removal(const char*name,int len);1448externvoidremove_scheduled_dirs(void);14491450externstruct alternate_object_database {1451struct alternate_object_database *next;14521453/* see alt_scratch_buf() */1454struct strbuf scratch;1455size_t base_len;14561457char path[FLEX_ARRAY];1458} *alt_odb_list;1459externvoidprepare_alt_odb(void);1460externvoidread_info_alternates(const char* relative_base,int depth);1461externchar*compute_alternate_path(const char*path,struct strbuf *err);1462typedefintalt_odb_fn(struct alternate_object_database *,void*);1463externintforeach_alt_odb(alt_odb_fn,void*);14641465/*1466 * Allocate a "struct alternate_object_database" but do _not_ actually1467 * add it to the list of alternates.1468 */1469struct alternate_object_database *alloc_alt_odb(const char*dir);14701471/*1472 * Add the directory to the on-disk alternates file; the new entry will also1473 * take effect in the current process.1474 */1475externvoidadd_to_alternates_file(const char*dir);14761477/*1478 * Add the directory to the in-memory list of alternates (along with any1479 * recursive alternates it points to), but do not modify the on-disk alternates1480 * file.1481 */1482externvoidadd_to_alternates_memory(const char*dir);14831484/*1485 * Returns a scratch strbuf pre-filled with the alternate object directory,1486 * including a trailing slash, which can be used to access paths in the1487 * alternate. Always use this over direct access to alt->scratch, as it1488 * cleans up any previous use of the scratch buffer.1489 */1490externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);14911492struct pack_window {1493struct pack_window *next;1494unsigned char*base;1495 off_t offset;1496size_t len;1497unsigned int last_used;1498unsigned int inuse_cnt;1499};15001501externstruct packed_git {1502struct packed_git *next;1503struct pack_window *windows;1504 off_t pack_size;1505const void*index_data;1506size_t index_size;1507uint32_t num_objects;1508uint32_t num_bad_objects;1509unsigned char*bad_object_sha1;1510int index_version;1511time_t mtime;1512int pack_fd;1513unsigned pack_local:1,1514 pack_keep:1,1515 freshened:1,1516 do_not_close:1;1517unsigned char sha1[20];1518struct revindex_entry *revindex;1519/* something like ".git/objects/pack/xxxxx.pack" */1520char pack_name[FLEX_ARRAY];/* more */1521} *packed_git;15221523/*1524 * A most-recently-used ordered version of the packed_git list, which can1525 * be iterated instead of packed_git (and marked via mru_mark).1526 */1527struct mru;1528externstruct mru *packed_git_mru;15291530struct pack_entry {1531 off_t offset;1532unsigned char sha1[20];1533struct packed_git *p;1534};15351536externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path);15371538/* A hook to report invalid files in pack directory */1539#define PACKDIR_FILE_PACK 11540#define PACKDIR_FILE_IDX 21541#define PACKDIR_FILE_GARBAGE 41542externvoid(*report_garbage)(unsigned seen_bits,const char*path);15431544externvoidprepare_packed_git(void);1545externvoidreprepare_packed_git(void);1546externvoidinstall_packed_git(struct packed_git *pack);15471548/*1549 * Give a rough count of objects in the repository. This sacrifices accuracy1550 * for speed.1551 */1552unsigned longapproximate_object_count(void);15531554externstruct packed_git *find_sha1_pack(const unsigned char*sha1,1555struct packed_git *packs);15561557externvoidpack_report(void);15581559/*1560 * mmap the index file for the specified packfile (if it is not1561 * already mmapped). Return 0 on success.1562 */1563externintopen_pack_index(struct packed_git *);15641565/*1566 * munmap the index file for the specified packfile (if it is1567 * currently mmapped).1568 */1569externvoidclose_pack_index(struct packed_git *);15701571externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*);1572externvoidclose_pack_windows(struct packed_git *);1573externvoidclose_all_packs(void);1574externvoidunuse_pack(struct pack_window **);1575externvoidclear_delta_base_cache(void);1576externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local);15771578/*1579 * Make sure that a pointer access into an mmap'd index file is within bounds,1580 * and can provide at least 8 bytes of data.1581 *1582 * Note that this is only necessary for variable-length segments of the file1583 * (like the 64-bit extended offset table), as we compare the size to the1584 * fixed-length parts when we open the file.1585 */1586externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr);15871588/*1589 * Return the SHA-1 of the nth object within the specified packfile.1590 * Open the index if it is not already open. The return value points1591 * at the SHA-1 within the mmapped index. Return NULL if there is an1592 * error.1593 */1594externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n);15951596/*1597 * Return the offset of the nth object within the specified packfile.1598 * The index must already be opened.1599 */1600extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n);16011602/*1603 * If the object named sha1 is present in the specified packfile,1604 * return its offset within the packfile; otherwise, return 0.1605 */1606extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *);16071608externintis_pack_valid(struct packed_git *);1609externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*);1610externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep);1611externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t);1612externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*);16131614/*1615 * Iterate over the files in the loose-object parts of the object1616 * directory "path", triggering the following callbacks:1617 *1618 * - loose_object is called for each loose object we find.1619 *1620 * - loose_cruft is called for any files that do not appear to be1621 * loose objects. Note that we only look in the loose object1622 * directories "objects/[0-9a-f]{2}/", so we will not report1623 * "objects/foobar" as cruft.1624 *1625 * - loose_subdir is called for each top-level hashed subdirectory1626 * of the object directory (e.g., "$OBJDIR/f0"). It is called1627 * after the objects in the directory are processed.1628 *1629 * Any callback that is NULL will be ignored. Callbacks returning non-zero1630 * will end the iteration.1631 *1632 * In the "buf" variant, "path" is a strbuf which will also be used as a1633 * scratch buffer, but restored to its original contents before1634 * the function returns.1635 */1636typedefinteach_loose_object_fn(const unsigned char*sha1,1637const char*path,1638void*data);1639typedefinteach_loose_cruft_fn(const char*basename,1640const char*path,1641void*data);1642typedefinteach_loose_subdir_fn(int nr,1643const char*path,1644void*data);1645intfor_each_loose_file_in_objdir(const char*path,1646 each_loose_object_fn obj_cb,1647 each_loose_cruft_fn cruft_cb,1648 each_loose_subdir_fn subdir_cb,1649void*data);1650intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1651 each_loose_object_fn obj_cb,1652 each_loose_cruft_fn cruft_cb,1653 each_loose_subdir_fn subdir_cb,1654void*data);16551656/*1657 * Iterate over loose and packed objects in both the local1658 * repository and any alternates repositories (unless the1659 * LOCAL_ONLY flag is set).1660 */1661#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11662typedefinteach_packed_object_fn(const unsigned char*sha1,1663struct packed_git *pack,1664uint32_t pos,1665void*data);1666externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);1667externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags);16681669struct object_info {1670/* Request */1671enum object_type *typep;1672unsigned long*sizep;1673 off_t *disk_sizep;1674unsigned char*delta_base_sha1;1675struct strbuf *typename;16761677/* Response */1678enum{1679 OI_CACHED,1680 OI_LOOSE,1681 OI_PACKED,1682 OI_DBCACHED1683} whence;1684union{1685/*1686 * struct {1687 * ... Nothing to expose in this case1688 * } cached;1689 * struct {1690 * ... Nothing to expose in this case1691 * } loose;1692 */1693struct{1694struct packed_git *pack;1695 off_t offset;1696unsigned int is_delta;1697} packed;1698} u;1699};17001701/*1702 * Initializer for a "struct object_info" that wants no items. You may1703 * also memset() the memory to all-zeroes.1704 */1705#define OBJECT_INFO_INIT {NULL}17061707externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);1708externintpacked_object_info(struct packed_git *pack, off_t offset,struct object_info *);17091710/* Dumb servers support */1711externintupdate_server_info(int);17121713/* git_config_parse_key() returns these negated: */1714#define CONFIG_INVALID_KEY 11715#define CONFIG_NO_SECTION_OR_NAME 21716/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */1717#define CONFIG_NO_LOCK -11718#define CONFIG_INVALID_FILE 31719#define CONFIG_NO_WRITE 41720#define CONFIG_NOTHING_SET 51721#define CONFIG_INVALID_PATTERN 61722#define CONFIG_GENERIC_ERROR 717231724#define CONFIG_REGEX_NONE ((void *)1)17251726struct git_config_source {1727unsigned int use_stdin:1;1728const char*file;1729const char*blob;1730};17311732enum config_origin_type {1733 CONFIG_ORIGIN_BLOB,1734 CONFIG_ORIGIN_FILE,1735 CONFIG_ORIGIN_STDIN,1736 CONFIG_ORIGIN_SUBMODULE_BLOB,1737 CONFIG_ORIGIN_CMDLINE1738};17391740typedefint(*config_fn_t)(const char*,const char*,void*);1741externintgit_default_config(const char*,const char*,void*);1742externintgit_config_from_file(config_fn_t fn,const char*,void*);1743externintgit_config_from_mem(config_fn_t fn,const enum config_origin_type,1744const char*name,const char*buf,size_t len,void*data);1745externintgit_config_from_blob_sha1(config_fn_t fn,const char*name,1746const unsigned char*sha1,void*data);1747externvoidgit_config_push_parameter(const char*text);1748externintgit_config_from_parameters(config_fn_t fn,void*data);1749externvoidgit_config(config_fn_t fn,void*);1750externintgit_config_with_options(config_fn_t fn,void*,1751struct git_config_source *config_source,1752int respect_includes);1753externintgit_parse_ulong(const char*,unsigned long*);1754externintgit_parse_maybe_bool(const char*);1755externintgit_config_int(const char*,const char*);1756externint64_tgit_config_int64(const char*,const char*);1757externunsigned longgit_config_ulong(const char*,const char*);1758externintgit_config_bool_or_int(const char*,const char*,int*);1759externintgit_config_bool(const char*,const char*);1760externintgit_config_maybe_bool(const char*,const char*);1761externintgit_config_string(const char**,const char*,const char*);1762externintgit_config_pathname(const char**,const char*,const char*);1763externintgit_config_set_in_file_gently(const char*,const char*,const char*);1764externvoidgit_config_set_in_file(const char*,const char*,const char*);1765externintgit_config_set_gently(const char*,const char*);1766externvoidgit_config_set(const char*,const char*);1767externintgit_config_parse_key(const char*,char**,int*);1768externintgit_config_key_is_valid(const char*key);1769externintgit_config_set_multivar_gently(const char*,const char*,const char*,int);1770externvoidgit_config_set_multivar(const char*,const char*,const char*,int);1771externintgit_config_set_multivar_in_file_gently(const char*,const char*,const char*,const char*,int);1772externvoidgit_config_set_multivar_in_file(const char*,const char*,const char*,const char*,int);1773externintgit_config_rename_section(const char*,const char*);1774externintgit_config_rename_section_in_file(const char*,const char*,const char*);1775externconst char*git_etc_gitconfig(void);1776externintgit_env_bool(const char*,int);1777externunsigned longgit_env_ulong(const char*,unsigned long);1778externintgit_config_system(void);1779externintconfig_error_nonbool(const char*);1780#if defined(__GNUC__)1781#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1782#endif1783externconst char*get_log_output_encoding(void);1784externconst char*get_commit_output_encoding(void);17851786externintgit_config_parse_parameter(const char*, config_fn_t fn,void*data);17871788enum config_scope {1789 CONFIG_SCOPE_UNKNOWN =0,1790 CONFIG_SCOPE_SYSTEM,1791 CONFIG_SCOPE_GLOBAL,1792 CONFIG_SCOPE_REPO,1793 CONFIG_SCOPE_CMDLINE,1794};17951796externenum config_scope current_config_scope(void);1797externconst char*current_config_origin_type(void);1798externconst char*current_config_name(void);17991800struct config_include_data {1801int depth;1802 config_fn_t fn;1803void*data;1804};1805#define CONFIG_INCLUDE_INIT { 0 }1806externintgit_config_include(const char*name,const char*value,void*data);18071808/*1809 * Match and parse a config key of the form:1810 *1811 * section.(subsection.)?key1812 *1813 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1814 * we return -1 if it does not match, 0 otherwise. The subsection and key1815 * out-parameters are filled by the function (and subsection is NULL if it is1816 * missing).1817 */1818externintparse_config_key(const char*var,1819const char*section,1820const char**subsection,int*subsection_len,1821const char**key);18221823struct config_set_element {1824struct hashmap_entry ent;1825char*key;1826struct string_list value_list;1827};18281829struct configset_list_item {1830struct config_set_element *e;1831int value_index;1832};18331834/*1835 * the contents of the list are ordered according to their1836 * position in the config files and order of parsing the files.1837 * (i.e. key-value pair at the last position of .git/config will1838 * be at the last item of the list)1839 */1840struct configset_list {1841struct configset_list_item *items;1842unsigned int nr, alloc;1843};18441845struct config_set {1846struct hashmap config_hash;1847int hash_initialized;1848struct configset_list list;1849};18501851externvoidgit_configset_init(struct config_set *cs);1852externintgit_configset_add_file(struct config_set *cs,const char*filename);1853externintgit_configset_get_value(struct config_set *cs,const char*key,const char**value);1854externconst struct string_list *git_configset_get_value_multi(struct config_set *cs,const char*key);1855externvoidgit_configset_clear(struct config_set *cs);1856externintgit_configset_get_string_const(struct config_set *cs,const char*key,const char**dest);1857externintgit_configset_get_string(struct config_set *cs,const char*key,char**dest);1858externintgit_configset_get_int(struct config_set *cs,const char*key,int*dest);1859externintgit_configset_get_ulong(struct config_set *cs,const char*key,unsigned long*dest);1860externintgit_configset_get_bool(struct config_set *cs,const char*key,int*dest);1861externintgit_configset_get_bool_or_int(struct config_set *cs,const char*key,int*is_bool,int*dest);1862externintgit_configset_get_maybe_bool(struct config_set *cs,const char*key,int*dest);1863externintgit_configset_get_pathname(struct config_set *cs,const char*key,const char**dest);18641865externintgit_config_get_value(const char*key,const char**value);1866externconst struct string_list *git_config_get_value_multi(const char*key);1867externvoidgit_config_clear(void);1868externvoidgit_config_iter(config_fn_t fn,void*data);1869externintgit_config_get_string_const(const char*key,const char**dest);1870externintgit_config_get_string(const char*key,char**dest);1871externintgit_config_get_int(const char*key,int*dest);1872externintgit_config_get_ulong(const char*key,unsigned long*dest);1873externintgit_config_get_bool(const char*key,int*dest);1874externintgit_config_get_bool_or_int(const char*key,int*is_bool,int*dest);1875externintgit_config_get_maybe_bool(const char*key,int*dest);1876externintgit_config_get_pathname(const char*key,const char**dest);1877externintgit_config_get_untracked_cache(void);18781879/*1880 * This is a hack for test programs like test-dump-untracked-cache to1881 * ensure that they do not modify the untracked cache when reading it.1882 * Do not use it otherwise!1883 */1884externint ignore_untracked_cache_config;18851886struct key_value_info {1887const char*filename;1888int linenr;1889enum config_origin_type origin_type;1890enum config_scope scope;1891};18921893extern NORETURN voidgit_die_config(const char*key,const char*err, ...)__attribute__((format(printf,2,3)));1894extern NORETURN voidgit_die_config_linenr(const char*key,const char*filename,int linenr);18951896externintcommitter_ident_sufficiently_given(void);1897externintauthor_ident_sufficiently_given(void);18981899externconst char*git_commit_encoding;1900externconst char*git_log_output_encoding;1901externconst char*git_mailmap_file;1902externconst char*git_mailmap_blob;19031904/* IO helper functions */1905externvoidmaybe_flush_or_die(FILE*,const char*);1906__attribute__((format(printf,2,3)))1907externvoidfprintf_or_die(FILE*,const char*fmt, ...);19081909#define COPY_READ_ERROR (-2)1910#define COPY_WRITE_ERROR (-3)1911externintcopy_fd(int ifd,int ofd);1912externintcopy_file(const char*dst,const char*src,int mode);1913externintcopy_file_with_time(const char*dst,const char*src,int mode);19141915externvoidwrite_or_die(int fd,const void*buf,size_t count);1916externvoidfsync_or_die(int fd,const char*);19171918extern ssize_t read_in_full(int fd,void*buf,size_t count);1919extern ssize_t write_in_full(int fd,const void*buf,size_t count);1920extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);19211922staticinline ssize_t write_str_in_full(int fd,const char*str)1923{1924returnwrite_in_full(fd, str,strlen(str));1925}19261927/**1928 * Open (and truncate) the file at path, write the contents of buf to it,1929 * and close it. Dies if any errors are encountered.1930 */1931externvoidwrite_file_buf(const char*path,const char*buf,size_t len);19321933/**1934 * Like write_file_buf(), but format the contents into a buffer first.1935 * Additionally, write_file() will append a newline if one is not already1936 * present, making it convenient to write text files:1937 *1938 * write_file(path, "counter: %d", ctr);1939 */1940__attribute__((format(printf,2,3)))1941externvoidwrite_file(const char*path,const char*fmt, ...);19421943/* pager.c */1944externvoidsetup_pager(void);1945externintpager_in_use(void);1946externint pager_use_color;1947externintterm_columns(void);1948externintdecimal_width(uintmax_t);1949externintcheck_pager_config(const char*cmd);1950externvoidprepare_pager_args(struct child_process *,const char*pager);19511952externconst char*editor_program;1953externconst char*askpass_program;1954externconst char*excludes_file;19551956/* base85 */1957intdecode_85(char*dst,const char*line,int linelen);1958voidencode_85(char*buf,const unsigned char*data,int bytes);19591960/* alloc.c */1961externvoid*alloc_blob_node(void);1962externvoid*alloc_tree_node(void);1963externvoid*alloc_commit_node(void);1964externvoid*alloc_tag_node(void);1965externvoid*alloc_object_node(void);1966externvoidalloc_report(void);1967externunsigned intalloc_commit_index(void);19681969/* pkt-line.c */1970voidpacket_trace_identity(const char*prog);19711972/* add */1973/*1974 * return 0 if success, 1 - if addition of a file failed and1975 * ADD_FILES_IGNORE_ERRORS was specified in flags1976 */1977intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);19781979/* diff.c */1980externint diff_auto_refresh_index;19811982/* match-trees.c */1983voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1984voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);19851986/*1987 * whitespace rules.1988 * used by both diff and apply1989 * last two digits are tab width1990 */1991#define WS_BLANK_AT_EOL 01001992#define WS_SPACE_BEFORE_TAB 02001993#define WS_INDENT_WITH_NON_TAB 04001994#define WS_CR_AT_EOL 010001995#define WS_BLANK_AT_EOF 020001996#define WS_TAB_IN_INDENT 040001997#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1998#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1999#define WS_TAB_WIDTH_MASK 0772000externunsigned whitespace_rule_cfg;2001externunsignedwhitespace_rule(const char*);2002externunsignedparse_whitespace_rule(const char*);2003externunsignedws_check(const char*line,int len,unsigned ws_rule);2004externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);2005externchar*whitespace_error_string(unsigned ws);2006externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);2007externintws_blank_line(const char*line,int len,unsigned ws_rule);2008#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)20092010/* ls-files */2011voidoverlay_tree_on_cache(const char*tree_name,const char*prefix);20122013char*alias_lookup(const char*alias);2014intsplit_cmdline(char*cmdline,const char***argv);2015/* Takes a negative value returned by split_cmdline */2016const char*split_cmdline_strerror(int cmdline_errno);20172018/* setup.c */2019struct startup_info {2020int have_repository;2021const char*prefix;2022};2023externstruct startup_info *startup_info;20242025/* merge.c */2026struct commit_list;2027inttry_merge_command(const char*strategy,size_t xopts_nr,2028const char**xopts,struct commit_list *common,2029const char*head_arg,struct commit_list *remotes);2030intcheckout_fast_forward(const unsigned char*from,2031const unsigned char*to,2032int overwrite_ignore);203320342035intsane_execvp(const char*file,char*const argv[]);20362037/*2038 * A struct to encapsulate the concept of whether a file has changed2039 * since we last checked it. This uses criteria similar to those used2040 * for the index.2041 */2042struct stat_validity {2043struct stat_data *sd;2044};20452046voidstat_validity_clear(struct stat_validity *sv);20472048/*2049 * Returns 1 if the path is a regular file (or a symlink to a regular2050 * file) and matches the saved stat_validity, 0 otherwise. A missing2051 * or inaccessible file is considered a match if the struct was just2052 * initialized, or if the previous update found an inaccessible file.2053 */2054intstat_validity_check(struct stat_validity *sv,const char*path);20552056/*2057 * Update the stat_validity from a file opened at descriptor fd. If2058 * the file is missing, inaccessible, or not a regular file, then2059 * future calls to stat_validity_check will match iff one of those2060 * conditions continues to be true.2061 */2062voidstat_validity_update(struct stat_validity *sv,int fd);20632064intversioncmp(const char*s1,const char*s2);2065voidsleep_millisec(int millisec);20662067/*2068 * Create a directory and (if share is nonzero) adjust its permissions2069 * according to the shared_repository setting. Only use this for2070 * directories under $GIT_DIR. Don't use it for working tree2071 * directories.2072 */2073voidsafe_create_dir(const char*dir,int share);20742075#endif/* CACHE_H */