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 510externconst char*read_gitfile_gently(const char*path,int*return_error_code); 511#define read_gitfile(path) read_gitfile_gently((path), NULL) 512externconst char*resolve_gitdir(const char*suspect); 513externvoidset_git_work_tree(const char*tree); 514 515#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 516 517externconst char**get_pathspec(const char*prefix,const char**pathspec); 518externvoidsetup_work_tree(void); 519externconst char*setup_git_directory_gently(int*); 520externconst char*setup_git_directory(void); 521externchar*prefix_path(const char*prefix,int len,const char*path); 522externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 523externconst char*prefix_filename(const char*prefix,int len,const char*path); 524externintcheck_filename(const char*prefix,const char*name); 525externvoidverify_filename(const char*prefix, 526const char*name, 527int diagnose_misspelt_rev); 528externvoidverify_non_filename(const char*prefix,const char*name); 529externintpath_inside_repo(const char*prefix,const char*path); 530 531#define INIT_DB_QUIET 0x0001 532#define INIT_DB_EXIST_OK 0x0002 533 534externintinit_db(const char*git_dir,const char*real_git_dir, 535const char*template_dir,unsigned int flags); 536 537externvoidsanitize_stdfds(void); 538externintdaemonize(void); 539 540#define alloc_nr(x) (((x)+16)*3/2) 541 542/* 543 * Realloc the buffer pointed at by variable 'x' so that it can hold 544 * at least 'nr' entries; the number of entries currently allocated 545 * is 'alloc', using the standard growing factor alloc_nr() macro. 546 * 547 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 548 */ 549#define ALLOC_GROW(x, nr, alloc) \ 550 do { \ 551 if ((nr) > alloc) { \ 552 if (alloc_nr(alloc) < (nr)) \ 553 alloc = (nr); \ 554 else \ 555 alloc = alloc_nr(alloc); \ 556 REALLOC_ARRAY(x, alloc); \ 557 } \ 558 } while (0) 559 560/* Initialize and use the cache information */ 561struct lock_file; 562externintread_index(struct index_state *); 563externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 564externintdo_read_index(struct index_state *istate,const char*path, 565int must_exist);/* for testting only! */ 566externintread_index_from(struct index_state *,const char*path); 567externintis_index_unborn(struct index_state *); 568externintread_index_unmerged(struct index_state *); 569#define COMMIT_LOCK (1 << 0) 570#define CLOSE_LOCK (1 << 1) 571externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 572externintdiscard_index(struct index_state *); 573externintunmerged_index(const struct index_state *); 574externintverify_path(const char*path); 575externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 576externvoidadjust_dirname_case(struct index_state *istate,char*name); 577externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 578 579/* 580 * Searches for an entry defined by name and namelen in the given index. 581 * If the return value is positive (including 0) it is the position of an 582 * exact match. If the return value is negative, the negated value minus 1 583 * is the position where the entry would be inserted. 584 * Example: The current index consists of these files and its stages: 585 * 586 * b#0, d#0, f#1, f#3 587 * 588 * index_name_pos(&index, "a", 1) -> -1 589 * index_name_pos(&index, "b", 1) -> 0 590 * index_name_pos(&index, "c", 1) -> -2 591 * index_name_pos(&index, "d", 1) -> 1 592 * index_name_pos(&index, "e", 1) -> -3 593 * index_name_pos(&index, "f", 1) -> -3 594 * index_name_pos(&index, "g", 1) -> -5 595 */ 596externintindex_name_pos(const struct index_state *,const char*name,int namelen); 597 598#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 599#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 600#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 601#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 602#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 603#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 604externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 605externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 606 607/* Remove entry, return true if there are more entries to go. */ 608externintremove_index_entry_at(struct index_state *,int pos); 609 610externvoidremove_marked_cache_entries(struct index_state *istate); 611externintremove_file_from_index(struct index_state *,const char*path); 612#define ADD_CACHE_VERBOSE 1 613#define ADD_CACHE_PRETEND 2 614#define ADD_CACHE_IGNORE_ERRORS 4 615#define ADD_CACHE_IGNORE_REMOVAL 8 616#define ADD_CACHE_INTENT 16 617/* 618 * These two are used to add the contents of the file at path 619 * to the index, marking the working tree up-to-date by storing 620 * the cached stat info in the resulting cache entry. A caller 621 * that has already run lstat(2) on the path can call 622 * add_to_index(), and all others can call add_file_to_index(); 623 * the latter will do necessary lstat(2) internally before 624 * calling the former. 625 */ 626externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 627externintadd_file_to_index(struct index_state *,const char*path,int flags); 628 629externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 630externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 631externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 632externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 633externintindex_name_is_other(const struct index_state *,const char*,int); 634externvoid*read_blob_data_from_index(struct index_state *,const char*,unsigned long*); 635 636/* do stat comparison even if CE_VALID is true */ 637#define CE_MATCH_IGNORE_VALID 01 638/* do not check the contents but report dirty on racily-clean entries */ 639#define CE_MATCH_RACY_IS_DIRTY 02 640/* do stat comparison even if CE_SKIP_WORKTREE is true */ 641#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 642/* ignore non-existent files during stat update */ 643#define CE_MATCH_IGNORE_MISSING 0x08 644/* enable stat refresh */ 645#define CE_MATCH_REFRESH 0x10 646externintie_match_stat(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 647externintie_modified(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 648 649#define HASH_WRITE_OBJECT 1 650#define HASH_FORMAT_CHECK 2 651externintindex_fd(unsigned char*sha1,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 652externintindex_path(unsigned char*sha1,const char*path,struct stat *st,unsigned flags); 653 654/* 655 * Record to sd the data from st that we use to check whether a file 656 * might have changed. 657 */ 658externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 659 660/* 661 * Return 0 if st is consistent with a file not having been changed 662 * since sd was filled. If there are differences, return a 663 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 664 * INODE_CHANGED, and DATA_CHANGED. 665 */ 666externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 667externintmatch_stat_data_racy(const struct index_state *istate, 668const struct stat_data *sd,struct stat *st); 669 670externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 671 672#define REFRESH_REALLY 0x0001/* ignore_valid */ 673#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 674#define REFRESH_QUIET 0x0004/* be quiet about it */ 675#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 676#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 677#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 678externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 679externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 680 681externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 682 683externinthold_locked_index(struct lock_file *,int); 684externvoidset_alternate_index_output(const char*); 685 686/* Environment bits from configuration mechanism */ 687externint trust_executable_bit; 688externint trust_ctime; 689externint check_stat; 690externint quote_path_fully; 691externint has_symlinks; 692externint minimum_abbrev, default_abbrev; 693externint ignore_case; 694externint assume_unchanged; 695externint prefer_symlink_refs; 696externint log_all_ref_updates; 697externint warn_ambiguous_refs; 698externint warn_on_object_refname_ambiguity; 699externconst char*apply_default_whitespace; 700externconst char*apply_default_ignorewhitespace; 701externconst char*git_attributes_file; 702externconst char*git_hooks_path; 703externint zlib_compression_level; 704externint core_compression_level; 705externint pack_compression_level; 706externsize_t packed_git_window_size; 707externsize_t packed_git_limit; 708externsize_t delta_base_cache_limit; 709externunsigned long big_file_threshold; 710externunsigned long pack_size_limit_cfg; 711 712/* 713 * Accessors for the core.sharedrepository config which lazy-load the value 714 * from the config (if not already set). The "reset" function can be 715 * used to unset "set" or cached value, meaning that the value will be loaded 716 * fresh from the config file on the next call to get_shared_repository(). 717 */ 718voidset_shared_repository(int value); 719intget_shared_repository(void); 720voidreset_shared_repository(void); 721 722/* 723 * Do replace refs need to be checked this run? This variable is 724 * initialized to true unless --no-replace-object is used or 725 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 726 * commands that do not want replace references to be active. As an 727 * optimization it is also set to false if replace references have 728 * been sought but there were none. 729 */ 730externint check_replace_refs; 731externchar*git_replace_ref_base; 732 733externint fsync_object_files; 734externint core_preload_index; 735externint core_apply_sparse_checkout; 736externint precomposed_unicode; 737externint protect_hfs; 738externint protect_ntfs; 739externint git_db_env, git_index_env, git_graft_env, git_common_dir_env; 740 741/* 742 * Include broken refs in all ref iterations, which will 743 * generally choke dangerous operations rather than letting 744 * them silently proceed without taking the broken ref into 745 * account. 746 */ 747externint ref_paranoia; 748 749/* 750 * The character that begins a commented line in user-editable file 751 * that is subject to stripspace. 752 */ 753externchar comment_line_char; 754externint auto_comment_line_char; 755 756/* Windows only */ 757enum hide_dotfiles_type { 758 HIDE_DOTFILES_FALSE =0, 759 HIDE_DOTFILES_TRUE, 760 HIDE_DOTFILES_DOTGITONLY 761}; 762externenum hide_dotfiles_type hide_dotfiles; 763 764enum branch_track { 765 BRANCH_TRACK_UNSPECIFIED = -1, 766 BRANCH_TRACK_NEVER =0, 767 BRANCH_TRACK_REMOTE, 768 BRANCH_TRACK_ALWAYS, 769 BRANCH_TRACK_EXPLICIT, 770 BRANCH_TRACK_OVERRIDE 771}; 772 773enum rebase_setup_type { 774 AUTOREBASE_NEVER =0, 775 AUTOREBASE_LOCAL, 776 AUTOREBASE_REMOTE, 777 AUTOREBASE_ALWAYS 778}; 779 780enum push_default_type { 781 PUSH_DEFAULT_NOTHING =0, 782 PUSH_DEFAULT_MATCHING, 783 PUSH_DEFAULT_SIMPLE, 784 PUSH_DEFAULT_UPSTREAM, 785 PUSH_DEFAULT_CURRENT, 786 PUSH_DEFAULT_UNSPECIFIED 787}; 788 789externenum branch_track git_branch_track; 790externenum rebase_setup_type autorebase; 791externenum push_default_type push_default; 792 793enum object_creation_mode { 794 OBJECT_CREATION_USES_HARDLINKS =0, 795 OBJECT_CREATION_USES_RENAMES =1 796}; 797 798externenum object_creation_mode object_creation_mode; 799 800externchar*notes_ref_name; 801 802externint grafts_replace_parents; 803 804/* 805 * GIT_REPO_VERSION is the version we write by default. The 806 * _READ variant is the highest number we know how to 807 * handle. 808 */ 809#define GIT_REPO_VERSION 0 810#define GIT_REPO_VERSION_READ 1 811externint repository_format_precious_objects; 812 813struct repository_format { 814int version; 815int precious_objects; 816int is_bare; 817char*work_tree; 818struct string_list unknown_extensions; 819}; 820 821/* 822 * Read the repository format characteristics from the config file "path" into 823 * "format" struct. Returns the numeric version. On error, -1 is returned, 824 * format->version is set to -1, and all other fields in the struct are 825 * undefined. 826 */ 827intread_repository_format(struct repository_format *format,const char*path); 828 829/* 830 * Verify that the repository described by repository_format is something we 831 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 832 * any errors encountered. 833 */ 834intverify_repository_format(const struct repository_format *format, 835struct strbuf *err); 836 837/* 838 * Check the repository format version in the path found in get_git_dir(), 839 * and die if it is a version we don't understand. Generally one would 840 * set_git_dir() before calling this, and use it only for "are we in a valid 841 * repo?". 842 */ 843externvoidcheck_repository_format(void); 844 845#define MTIME_CHANGED 0x0001 846#define CTIME_CHANGED 0x0002 847#define OWNER_CHANGED 0x0004 848#define MODE_CHANGED 0x0008 849#define INODE_CHANGED 0x0010 850#define DATA_CHANGED 0x0020 851#define TYPE_CHANGED 0x0040 852 853/* 854 * Return a statically allocated filename, either generically (mkpath), in 855 * the repository directory (git_path), or in a submodule's repository 856 * directory (git_path_submodule). In all cases, note that the result 857 * may be overwritten by another call to _any_ of the functions. Consider 858 * using the safer "dup" or "strbuf" formats below (in some cases, the 859 * unsafe versions have already been removed). 860 */ 861externconst char*mkpath(const char*fmt, ...)__attribute__((format(printf,1,2))); 862externconst char*git_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 863externconst char*git_common_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 864 865externchar*mksnpath(char*buf,size_t n,const char*fmt, ...) 866__attribute__((format(printf,3,4))); 867externvoidstrbuf_git_path(struct strbuf *sb,const char*fmt, ...) 868__attribute__((format(printf,2,3))); 869externvoidstrbuf_git_common_path(struct strbuf *sb,const char*fmt, ...) 870__attribute__((format(printf,2,3))); 871externchar*git_path_buf(struct strbuf *buf,const char*fmt, ...) 872__attribute__((format(printf,2,3))); 873externintstrbuf_git_path_submodule(struct strbuf *sb,const char*path, 874const char*fmt, ...) 875__attribute__((format(printf,3,4))); 876externchar*git_pathdup(const char*fmt, ...) 877__attribute__((format(printf,1,2))); 878externchar*mkpathdup(const char*fmt, ...) 879__attribute__((format(printf,1,2))); 880externchar*git_pathdup_submodule(const char*path,const char*fmt, ...) 881__attribute__((format(printf,2,3))); 882 883externvoidreport_linked_checkout_garbage(void); 884 885/* 886 * You can define a static memoized git path like: 887 * 888 * static GIT_PATH_FUNC(git_path_foo, "FOO"); 889 * 890 * or use one of the global ones below. 891 */ 892#define GIT_PATH_FUNC(func, filename) \ 893 const char *func(void) \ 894 { \ 895 static char *ret; \ 896 if (!ret) \ 897 ret = git_pathdup(filename); \ 898 return ret; \ 899 } 900 901const char*git_path_cherry_pick_head(void); 902const char*git_path_revert_head(void); 903const char*git_path_squash_msg(void); 904const char*git_path_merge_msg(void); 905const char*git_path_merge_rr(void); 906const char*git_path_merge_mode(void); 907const char*git_path_merge_head(void); 908const char*git_path_fetch_head(void); 909const char*git_path_shallow(void); 910 911/* 912 * Return the name of the file in the local object database that would 913 * be used to store a loose object with the specified sha1. The 914 * return value is a pointer to a statically allocated buffer that is 915 * overwritten each time the function is called. 916 */ 917externconst char*sha1_file_name(const unsigned char*sha1); 918 919/* 920 * Return the name of the (local) packfile with the specified sha1 in 921 * its name. The return value is a pointer to memory that is 922 * overwritten each time this function is called. 923 */ 924externchar*sha1_pack_name(const unsigned char*sha1); 925 926/* 927 * Return the name of the (local) pack index file with the specified 928 * sha1 in its name. The return value is a pointer to memory that is 929 * overwritten each time this function is called. 930 */ 931externchar*sha1_pack_index_name(const unsigned char*sha1); 932 933/* 934 * Return an abbreviated sha1 unique within this repository's object database. 935 * The result will be at least `len` characters long, and will be NUL 936 * terminated. 937 * 938 * The non-`_r` version returns a static buffer which remains valid until 4 939 * more calls to find_unique_abbrev are made. 940 * 941 * The `_r` variant writes to a buffer supplied by the caller, which must be at 942 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 943 * written (excluding the NUL terminator). 944 * 945 * Note that while this version avoids the static buffer, it is not fully 946 * reentrant, as it calls into other non-reentrant git code. 947 */ 948externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 949externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 950 951externconst unsigned char null_sha1[GIT_SHA1_RAWSZ]; 952externconst struct object_id null_oid; 953 954staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 955{ 956int i; 957 958for(i =0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 959if(*sha1 != *sha2) 960return*sha1 - *sha2; 961} 962 963return0; 964} 965 966staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 967{ 968returnhashcmp(oid1->hash, oid2->hash); 969} 970 971staticinlineintis_null_sha1(const unsigned char*sha1) 972{ 973return!hashcmp(sha1, null_sha1); 974} 975 976staticinlineintis_null_oid(const struct object_id *oid) 977{ 978return!hashcmp(oid->hash, null_sha1); 979} 980 981staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src) 982{ 983memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 984} 985 986staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src) 987{ 988hashcpy(dst->hash, src->hash); 989} 990 991staticinlinevoidhashclr(unsigned char*hash) 992{ 993memset(hash,0, GIT_SHA1_RAWSZ); 994} 995 996staticinlinevoidoidclr(struct object_id *oid) 997{ 998hashclr(oid->hash); 999}100010011002#define EMPTY_TREE_SHA1_HEX \1003"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1004#define EMPTY_TREE_SHA1_BIN_LITERAL \1005"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1006"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1007externconst struct object_id empty_tree_oid;1008#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10091010#define EMPTY_BLOB_SHA1_HEX \1011"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1012#define EMPTY_BLOB_SHA1_BIN_LITERAL \1013"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1014"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1015externconst struct object_id empty_blob_oid;1016#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)101710181019staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1020{1021return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1022}10231024staticinlineintis_empty_blob_oid(const struct object_id *oid)1025{1026return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1027}10281029staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1030{1031return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1032}10331034staticinlineintis_empty_tree_oid(const struct object_id *oid)1035{1036return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1037}103810391040intgit_mkstemp(char*path,size_t n,const char*template);10411042/* set default permissions by passing mode arguments to open(2) */1043intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1044intgit_mkstemp_mode(char*pattern,int mode);10451046/*1047 * NOTE NOTE NOTE!!1048 *1049 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1050 * not be changed. Old repositories have core.sharedrepository written in1051 * numeric format, and therefore these values are preserved for compatibility1052 * reasons.1053 */1054enum sharedrepo {1055 PERM_UMASK =0,1056 OLD_PERM_GROUP =1,1057 OLD_PERM_EVERYBODY =2,1058 PERM_GROUP =0660,1059 PERM_EVERYBODY =06641060};1061intgit_config_perm(const char*var,const char*value);1062intadjust_shared_perm(const char*path);10631064/*1065 * Create the directory containing the named path, using care to be1066 * somewhat safe against races. Return one of the scld_error values1067 * to indicate success/failure.1068 *1069 * SCLD_VANISHED indicates that one of the ancestor directories of the1070 * path existed at one point during the function call and then1071 * suddenly vanished, probably because another process pruned the1072 * directory while we were working. To be robust against this kind of1073 * race, callers might want to try invoking the function again when it1074 * returns SCLD_VANISHED.1075 *1076 * safe_create_leading_directories() temporarily changes path while it1077 * is working but restores it before returning.1078 * safe_create_leading_directories_const() doesn't modify path, even1079 * temporarily.1080 */1081enum scld_error {1082 SCLD_OK =0,1083 SCLD_FAILED = -1,1084 SCLD_PERMS = -2,1085 SCLD_EXISTS = -3,1086 SCLD_VANISHED = -41087};1088enum scld_error safe_create_leading_directories(char*path);1089enum scld_error safe_create_leading_directories_const(const char*path);10901091intmkdir_in_gitdir(const char*path);1092externchar*expand_user_path(const char*path);1093const char*enter_repo(const char*path,int strict);1094staticinlineintis_absolute_path(const char*path)1095{1096returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1097}1098intis_directory(const char*);1099const char*real_path(const char*path);1100const char*real_path_if_valid(const char*path);1101const char*absolute_path(const char*path);1102const char*remove_leading_path(const char*in,const char*prefix);1103const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1104intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1105intnormalize_path_copy(char*dst,const char*src);1106intlongest_ancestor_length(const char*path,struct string_list *prefixes);1107char*strip_path_suffix(const char*path,const char*suffix);1108intdaemon_avoid_alias(const char*path);1109externintis_ntfs_dotgit(const char*name);11101111/**1112 * Return a newly allocated string with the evaluation of1113 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1114 * "$HOME/.config/git/$filename". Return NULL upon error.1115 */1116externchar*xdg_config_home(const char*filename);11171118/* object replacement */1119#define LOOKUP_REPLACE_OBJECT 11120#define LOOKUP_UNKNOWN_OBJECT 21121externvoid*read_sha1_file_extended(const unsigned char*sha1,enum object_type *type,unsigned long*size,unsigned flag);1122staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1123{1124returnread_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);1125}11261127/*1128 * This internal function is only declared here for the benefit of1129 * lookup_replace_object(). Please do not call it directly.1130 */1131externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);11321133/*1134 * If object sha1 should be replaced, return the replacement object's1135 * name (replaced recursively, if necessary). The return value is1136 * either sha1 or a pointer to a permanently-allocated value. When1137 * object replacement is suppressed, always return sha1.1138 */1139staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1140{1141if(!check_replace_refs)1142return sha1;1143returndo_lookup_replace_object(sha1);1144}11451146staticinlineconst unsigned char*lookup_replace_object_extended(const unsigned char*sha1,unsigned flag)1147{1148if(!(flag & LOOKUP_REPLACE_OBJECT))1149return sha1;1150returnlookup_replace_object(sha1);1151}11521153/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1154externintsha1_object_info(const unsigned char*,unsigned long*);1155externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1);1156externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1);1157externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,unsigned char*sha1,unsigned flags);1158externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*);1159externintforce_object_loose(const unsigned char*sha1,time_t mtime);1160externintgit_open(const char*name);1161externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1162externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1163externintparse_sha1_header(const char*hdr,unsigned long*sizep);11641165/* global flag to enable extra checks when accessing packed objects */1166externint do_check_packed_object_crc;11671168externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);11691170externintfinalize_object_file(const char*tmpfile,const char*filename);11711172externinthas_sha1_pack(const unsigned char*sha1);11731174/*1175 * Return true iff we have an object named sha1, whether local or in1176 * an alternate object database, and whether packed or loose. This1177 * function does not respect replace references.1178 *1179 * If the QUICK flag is set, do not re-check the pack directory1180 * when we cannot find the object (this means we may give a false1181 * negative answer if another process is simultaneously repacking).1182 */1183#define HAS_SHA1_QUICK 0x11184externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1185staticinlineinthas_sha1_file(const unsigned char*sha1)1186{1187returnhas_sha1_file_with_flags(sha1,0);1188}11891190/* Same as the above, except for struct object_id. */1191externinthas_object_file(const struct object_id *oid);1192externinthas_object_file_with_flags(const struct object_id *oid,int flags);11931194/*1195 * Return true iff an alternate object database has a loose object1196 * with the specified name. This function does not respect replace1197 * references.1198 */1199externinthas_loose_object_nonlocal(const unsigned char*sha1);12001201externinthas_pack_index(const unsigned char*sha1);12021203externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);12041205externconst signed char hexval_table[256];1206staticinlineunsigned inthexval(unsigned char c)1207{1208return hexval_table[c];1209}12101211/*1212 * Convert two consecutive hexadecimal digits into a char. Return a1213 * negative value on error. Don't run over the end of short strings.1214 */1215staticinlineinthex2chr(const char*s)1216{1217int val =hexval(s[0]);1218return(val <0) ? val : (val <<4) |hexval(s[1]);1219}12201221/* Convert to/from hex/sha1 representation */1222#define MINIMUM_ABBREV minimum_abbrev1223#define DEFAULT_ABBREV default_abbrev12241225/* used when the code does not know or care what the default abbrev is */1226#define FALLBACK_DEFAULT_ABBREV 712271228struct object_context {1229unsigned char tree[20];1230char path[PATH_MAX];1231unsigned mode;1232/*1233 * symlink_path is only used by get_tree_entry_follow_symlinks,1234 * and only for symlinks that point outside the repository.1235 */1236struct strbuf symlink_path;1237};12381239#define GET_SHA1_QUIETLY 011240#define GET_SHA1_COMMIT 021241#define GET_SHA1_COMMITTISH 041242#define GET_SHA1_TREE 0101243#define GET_SHA1_TREEISH 0201244#define GET_SHA1_BLOB 0401245#define GET_SHA1_FOLLOW_SYMLINKS 01001246#define GET_SHA1_ONLY_TO_DIE 0400012471248#define GET_SHA1_DISAMBIGUATORS \1249 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \1250 GET_SHA1_TREE | GET_SHA1_TREEISH | \1251 GET_SHA1_BLOB)12521253externintget_sha1(const char*str,unsigned char*sha1);1254externintget_sha1_commit(const char*str,unsigned char*sha1);1255externintget_sha1_committish(const char*str,unsigned char*sha1);1256externintget_sha1_tree(const char*str,unsigned char*sha1);1257externintget_sha1_treeish(const char*str,unsigned char*sha1);1258externintget_sha1_blob(const char*str,unsigned char*sha1);1259externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1260externintget_sha1_with_context(const char*str,unsigned flags,unsigned char*sha1,struct object_context *orc);12611262externintget_oid(const char*str,struct object_id *oid);12631264typedefinteach_abbrev_fn(const unsigned char*sha1,void*);1265externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);12661267externintset_disambiguate_hint_config(const char*var,const char*value);12681269/*1270 * Try to read a SHA1 in hexadecimal format from the 40 characters1271 * starting at hex. Write the 20-byte result to sha1 in binary form.1272 * Return 0 on success. Reading stops if a NUL is encountered in the1273 * input, so it is safe to pass this function an arbitrary1274 * null-terminated string.1275 */1276externintget_sha1_hex(const char*hex,unsigned char*sha1);1277externintget_oid_hex(const char*hex,struct object_id *sha1);12781279/*1280 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1281 * and writes the NUL-terminated output to the buffer `out`, which must be at1282 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1283 * convenience.1284 *1285 * The non-`_r` variant returns a static buffer, but uses a ring of 41286 * buffers, making it safe to make multiple calls for a single statement, like:1287 *1288 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1289 */1290externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1291externchar*oid_to_hex_r(char*out,const struct object_id *oid);1292externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1293externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */12941295/*1296 * This reads short-hand syntax that not only evaluates to a commit1297 * object name, but also can act as if the end user spelled the name1298 * of the branch from the command line.1299 *1300 * - "@{-N}" finds the name of the Nth previous branch we were on, and1301 * places the name of the branch in the given buf and returns the1302 * number of characters parsed if successful.1303 *1304 * - "<branch>@{upstream}" finds the name of the other ref that1305 * <branch> is configured to merge with (missing <branch> defaults1306 * to the current branch), and places the name of the branch in the1307 * given buf and returns the number of characters parsed if1308 * successful.1309 *1310 * If the input is not of the accepted format, it returns a negative1311 * number to signal an error.1312 *1313 * If the input was ok but there are not N branch switches in the1314 * reflog, it returns 0.1315 *1316 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1317 * expansions: local branches ("refs/heads/"), remote branches1318 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1319 * allowed, even ones to refs outside of those namespaces.1320 */1321#define INTERPRET_BRANCH_LOCAL (1<<0)1322#define INTERPRET_BRANCH_REMOTE (1<<1)1323#define INTERPRET_BRANCH_HEAD (1<<2)1324externintinterpret_branch_name(const char*str,int len,struct strbuf *,1325unsigned allowed);1326externintget_oid_mb(const char*str,struct object_id *oid);13271328externintvalidate_headref(const char*ref);13291330externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1331externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1332externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1333externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);13341335externvoid*read_object_with_reference(const unsigned char*sha1,1336const char*required_type,1337unsigned long*size,1338unsigned char*sha1_ret);13391340externstruct object *peel_to_type(const char*name,int namelen,1341struct object *o,enum object_type);13421343struct date_mode {1344enum date_mode_type {1345 DATE_NORMAL =0,1346 DATE_RELATIVE,1347 DATE_SHORT,1348 DATE_ISO8601,1349 DATE_ISO8601_STRICT,1350 DATE_RFC2822,1351 DATE_STRFTIME,1352 DATE_RAW,1353 DATE_UNIX1354} type;1355const char*strftime_fmt;1356int local;1357};13581359/*1360 * Convenience helper for passing a constant type, like:1361 *1362 * show_date(t, tz, DATE_MODE(NORMAL));1363 */1364#define DATE_MODE(t) date_mode_from_type(DATE_##t)1365struct date_mode *date_mode_from_type(enum date_mode_type type);13661367const char*show_date(unsigned long time,int timezone,const struct date_mode *mode);1368voidshow_date_relative(unsigned long time,int tz,const struct timeval *now,1369struct strbuf *timebuf);1370intparse_date(const char*date,struct strbuf *out);1371intparse_date_basic(const char*date,unsigned long*timestamp,int*offset);1372intparse_expiry_date(const char*date,unsigned long*timestamp);1373voiddatestamp(struct strbuf *out);1374#define approxidate(s) approxidate_careful((s), NULL)1375unsigned longapproxidate_careful(const char*,int*);1376unsigned longapproxidate_relative(const char*date,const struct timeval *now);1377voidparse_date_format(const char*format,struct date_mode *mode);1378intdate_overflows(unsigned long date);13791380#define IDENT_STRICT 11381#define IDENT_NO_DATE 21382#define IDENT_NO_NAME 41383externconst char*git_author_info(int);1384externconst char*git_committer_info(int);1385externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1386externconst char*fmt_name(const char*name,const char*email);1387externconst char*ident_default_name(void);1388externconst char*ident_default_email(void);1389externconst char*git_editor(void);1390externconst char*git_pager(int stdout_is_tty);1391externintgit_ident_config(const char*,const char*,void*);1392externvoidreset_ident_date(void);13931394struct ident_split {1395const char*name_begin;1396const char*name_end;1397const char*mail_begin;1398const char*mail_end;1399const char*date_begin;1400const char*date_end;1401const char*tz_begin;1402const char*tz_end;1403};1404/*1405 * Signals an success with 0, but time part of the result may be NULL1406 * if the input lacks timestamp and zone1407 */1408externintsplit_ident_line(struct ident_split *,const char*,int);14091410/*1411 * Like show_date, but pull the timestamp and tz parameters from1412 * the ident_split. It will also sanity-check the values and produce1413 * a well-known sentinel date if they appear bogus.1414 */1415const char*show_ident_date(const struct ident_split *id,1416const struct date_mode *mode);14171418/*1419 * Compare split idents for equality or strict ordering. Note that we1420 * compare only the ident part of the line, ignoring any timestamp.1421 *1422 * Because there are two fields, we must choose one as the primary key; we1423 * currently arbitrarily pick the email.1424 */1425externintident_cmp(const struct ident_split *,const struct ident_split *);14261427struct checkout {1428struct index_state *istate;1429const char*base_dir;1430int base_dir_len;1431unsigned force:1,1432 quiet:1,1433 not_new:1,1434 refresh_cache:1;1435};1436#define CHECKOUT_INIT { NULL,"" }14371438#define TEMPORARY_FILENAME_LENGTH 251439externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);14401441struct cache_def {1442struct strbuf path;1443int flags;1444int track_flags;1445int prefix_len_stat_func;1446};1447#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1448staticinlinevoidcache_def_clear(struct cache_def *cache)1449{1450strbuf_release(&cache->path);1451}14521453externinthas_symlink_leading_path(const char*name,int len);1454externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1455externintcheck_leading_path(const char*name,int len);1456externinthas_dirs_only_path(const char*name,int len,int prefix_len);1457externvoidschedule_dir_for_removal(const char*name,int len);1458externvoidremove_scheduled_dirs(void);14591460externstruct alternate_object_database {1461struct alternate_object_database *next;14621463/* see alt_scratch_buf() */1464struct strbuf scratch;1465size_t base_len;14661467char path[FLEX_ARRAY];1468} *alt_odb_list;1469externvoidprepare_alt_odb(void);1470externvoidread_info_alternates(const char* relative_base,int depth);1471externchar*compute_alternate_path(const char*path,struct strbuf *err);1472typedefintalt_odb_fn(struct alternate_object_database *,void*);1473externintforeach_alt_odb(alt_odb_fn,void*);14741475/*1476 * Allocate a "struct alternate_object_database" but do _not_ actually1477 * add it to the list of alternates.1478 */1479struct alternate_object_database *alloc_alt_odb(const char*dir);14801481/*1482 * Add the directory to the on-disk alternates file; the new entry will also1483 * take effect in the current process.1484 */1485externvoidadd_to_alternates_file(const char*dir);14861487/*1488 * Add the directory to the in-memory list of alternates (along with any1489 * recursive alternates it points to), but do not modify the on-disk alternates1490 * file.1491 */1492externvoidadd_to_alternates_memory(const char*dir);14931494/*1495 * Returns a scratch strbuf pre-filled with the alternate object directory,1496 * including a trailing slash, which can be used to access paths in the1497 * alternate. Always use this over direct access to alt->scratch, as it1498 * cleans up any previous use of the scratch buffer.1499 */1500externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);15011502struct pack_window {1503struct pack_window *next;1504unsigned char*base;1505 off_t offset;1506size_t len;1507unsigned int last_used;1508unsigned int inuse_cnt;1509};15101511externstruct packed_git {1512struct packed_git *next;1513struct pack_window *windows;1514 off_t pack_size;1515const void*index_data;1516size_t index_size;1517uint32_t num_objects;1518uint32_t num_bad_objects;1519unsigned char*bad_object_sha1;1520int index_version;1521time_t mtime;1522int pack_fd;1523unsigned pack_local:1,1524 pack_keep:1,1525 freshened:1,1526 do_not_close:1;1527unsigned char sha1[20];1528struct revindex_entry *revindex;1529/* something like ".git/objects/pack/xxxxx.pack" */1530char pack_name[FLEX_ARRAY];/* more */1531} *packed_git;15321533/*1534 * A most-recently-used ordered version of the packed_git list, which can1535 * be iterated instead of packed_git (and marked via mru_mark).1536 */1537struct mru;1538externstruct mru *packed_git_mru;15391540struct pack_entry {1541 off_t offset;1542unsigned char sha1[20];1543struct packed_git *p;1544};15451546externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path);15471548/* A hook to report invalid files in pack directory */1549#define PACKDIR_FILE_PACK 11550#define PACKDIR_FILE_IDX 21551#define PACKDIR_FILE_GARBAGE 41552externvoid(*report_garbage)(unsigned seen_bits,const char*path);15531554externvoidprepare_packed_git(void);1555externvoidreprepare_packed_git(void);1556externvoidinstall_packed_git(struct packed_git *pack);15571558/*1559 * Give a rough count of objects in the repository. This sacrifices accuracy1560 * for speed.1561 */1562unsigned longapproximate_object_count(void);15631564externstruct packed_git *find_sha1_pack(const unsigned char*sha1,1565struct packed_git *packs);15661567externvoidpack_report(void);15681569/*1570 * mmap the index file for the specified packfile (if it is not1571 * already mmapped). Return 0 on success.1572 */1573externintopen_pack_index(struct packed_git *);15741575/*1576 * munmap the index file for the specified packfile (if it is1577 * currently mmapped).1578 */1579externvoidclose_pack_index(struct packed_git *);15801581externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*);1582externvoidclose_pack_windows(struct packed_git *);1583externvoidclose_all_packs(void);1584externvoidunuse_pack(struct pack_window **);1585externvoidclear_delta_base_cache(void);1586externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local);15871588/*1589 * Make sure that a pointer access into an mmap'd index file is within bounds,1590 * and can provide at least 8 bytes of data.1591 *1592 * Note that this is only necessary for variable-length segments of the file1593 * (like the 64-bit extended offset table), as we compare the size to the1594 * fixed-length parts when we open the file.1595 */1596externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr);15971598/*1599 * Return the SHA-1 of the nth object within the specified packfile.1600 * Open the index if it is not already open. The return value points1601 * at the SHA-1 within the mmapped index. Return NULL if there is an1602 * error.1603 */1604externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n);16051606/*1607 * Return the offset of the nth object within the specified packfile.1608 * The index must already be opened.1609 */1610extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n);16111612/*1613 * If the object named sha1 is present in the specified packfile,1614 * return its offset within the packfile; otherwise, return 0.1615 */1616extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *);16171618externintis_pack_valid(struct packed_git *);1619externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*);1620externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep);1621externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t);1622externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*);16231624/*1625 * Iterate over the files in the loose-object parts of the object1626 * directory "path", triggering the following callbacks:1627 *1628 * - loose_object is called for each loose object we find.1629 *1630 * - loose_cruft is called for any files that do not appear to be1631 * loose objects. Note that we only look in the loose object1632 * directories "objects/[0-9a-f]{2}/", so we will not report1633 * "objects/foobar" as cruft.1634 *1635 * - loose_subdir is called for each top-level hashed subdirectory1636 * of the object directory (e.g., "$OBJDIR/f0"). It is called1637 * after the objects in the directory are processed.1638 *1639 * Any callback that is NULL will be ignored. Callbacks returning non-zero1640 * will end the iteration.1641 *1642 * In the "buf" variant, "path" is a strbuf which will also be used as a1643 * scratch buffer, but restored to its original contents before1644 * the function returns.1645 */1646typedefinteach_loose_object_fn(const unsigned char*sha1,1647const char*path,1648void*data);1649typedefinteach_loose_cruft_fn(const char*basename,1650const char*path,1651void*data);1652typedefinteach_loose_subdir_fn(int nr,1653const char*path,1654void*data);1655intfor_each_loose_file_in_objdir(const char*path,1656 each_loose_object_fn obj_cb,1657 each_loose_cruft_fn cruft_cb,1658 each_loose_subdir_fn subdir_cb,1659void*data);1660intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1661 each_loose_object_fn obj_cb,1662 each_loose_cruft_fn cruft_cb,1663 each_loose_subdir_fn subdir_cb,1664void*data);16651666/*1667 * Iterate over loose and packed objects in both the local1668 * repository and any alternates repositories (unless the1669 * LOCAL_ONLY flag is set).1670 */1671#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11672typedefinteach_packed_object_fn(const unsigned char*sha1,1673struct packed_git *pack,1674uint32_t pos,1675void*data);1676externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);1677externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags);16781679struct object_info {1680/* Request */1681enum object_type *typep;1682unsigned long*sizep;1683 off_t *disk_sizep;1684unsigned char*delta_base_sha1;1685struct strbuf *typename;16861687/* Response */1688enum{1689 OI_CACHED,1690 OI_LOOSE,1691 OI_PACKED,1692 OI_DBCACHED1693} whence;1694union{1695/*1696 * struct {1697 * ... Nothing to expose in this case1698 * } cached;1699 * struct {1700 * ... Nothing to expose in this case1701 * } loose;1702 */1703struct{1704struct packed_git *pack;1705 off_t offset;1706unsigned int is_delta;1707} packed;1708} u;1709};17101711/*1712 * Initializer for a "struct object_info" that wants no items. You may1713 * also memset() the memory to all-zeroes.1714 */1715#define OBJECT_INFO_INIT {NULL}17161717externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);1718externintpacked_object_info(struct packed_git *pack, off_t offset,struct object_info *);17191720/* Dumb servers support */1721externintupdate_server_info(int);17221723/* git_config_parse_key() returns these negated: */1724#define CONFIG_INVALID_KEY 11725#define CONFIG_NO_SECTION_OR_NAME 21726/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */1727#define CONFIG_NO_LOCK -11728#define CONFIG_INVALID_FILE 31729#define CONFIG_NO_WRITE 41730#define CONFIG_NOTHING_SET 51731#define CONFIG_INVALID_PATTERN 61732#define CONFIG_GENERIC_ERROR 717331734#define CONFIG_REGEX_NONE ((void *)1)17351736struct git_config_source {1737unsigned int use_stdin:1;1738const char*file;1739const char*blob;1740};17411742enum config_origin_type {1743 CONFIG_ORIGIN_BLOB,1744 CONFIG_ORIGIN_FILE,1745 CONFIG_ORIGIN_STDIN,1746 CONFIG_ORIGIN_SUBMODULE_BLOB,1747 CONFIG_ORIGIN_CMDLINE1748};17491750typedefint(*config_fn_t)(const char*,const char*,void*);1751externintgit_default_config(const char*,const char*,void*);1752externintgit_config_from_file(config_fn_t fn,const char*,void*);1753externintgit_config_from_mem(config_fn_t fn,const enum config_origin_type,1754const char*name,const char*buf,size_t len,void*data);1755externvoidgit_config_push_parameter(const char*text);1756externintgit_config_from_parameters(config_fn_t fn,void*data);1757externvoidgit_config(config_fn_t fn,void*);1758externintgit_config_with_options(config_fn_t fn,void*,1759struct git_config_source *config_source,1760int respect_includes);1761externintgit_parse_ulong(const char*,unsigned long*);1762externintgit_parse_maybe_bool(const char*);1763externintgit_config_int(const char*,const char*);1764externint64_tgit_config_int64(const char*,const char*);1765externunsigned longgit_config_ulong(const char*,const char*);1766externintgit_config_bool_or_int(const char*,const char*,int*);1767externintgit_config_bool(const char*,const char*);1768externintgit_config_maybe_bool(const char*,const char*);1769externintgit_config_string(const char**,const char*,const char*);1770externintgit_config_pathname(const char**,const char*,const char*);1771externintgit_config_set_in_file_gently(const char*,const char*,const char*);1772externvoidgit_config_set_in_file(const char*,const char*,const char*);1773externintgit_config_set_gently(const char*,const char*);1774externvoidgit_config_set(const char*,const char*);1775externintgit_config_parse_key(const char*,char**,int*);1776externintgit_config_key_is_valid(const char*key);1777externintgit_config_set_multivar_gently(const char*,const char*,const char*,int);1778externvoidgit_config_set_multivar(const char*,const char*,const char*,int);1779externintgit_config_set_multivar_in_file_gently(const char*,const char*,const char*,const char*,int);1780externvoidgit_config_set_multivar_in_file(const char*,const char*,const char*,const char*,int);1781externintgit_config_rename_section(const char*,const char*);1782externintgit_config_rename_section_in_file(const char*,const char*,const char*);1783externconst char*git_etc_gitconfig(void);1784externintgit_env_bool(const char*,int);1785externunsigned longgit_env_ulong(const char*,unsigned long);1786externintgit_config_system(void);1787externintconfig_error_nonbool(const char*);1788#if defined(__GNUC__)1789#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1790#endif1791externconst char*get_log_output_encoding(void);1792externconst char*get_commit_output_encoding(void);17931794externintgit_config_parse_parameter(const char*, config_fn_t fn,void*data);17951796enum config_scope {1797 CONFIG_SCOPE_UNKNOWN =0,1798 CONFIG_SCOPE_SYSTEM,1799 CONFIG_SCOPE_GLOBAL,1800 CONFIG_SCOPE_REPO,1801 CONFIG_SCOPE_CMDLINE,1802};18031804externenum config_scope current_config_scope(void);1805externconst char*current_config_origin_type(void);1806externconst char*current_config_name(void);18071808struct config_include_data {1809int depth;1810 config_fn_t fn;1811void*data;1812};1813#define CONFIG_INCLUDE_INIT { 0 }1814externintgit_config_include(const char*name,const char*value,void*data);18151816/*1817 * Match and parse a config key of the form:1818 *1819 * section.(subsection.)?key1820 *1821 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1822 * we return -1 if it does not match, 0 otherwise. The subsection and key1823 * out-parameters are filled by the function (and subsection is NULL if it is1824 * missing).1825 */1826externintparse_config_key(const char*var,1827const char*section,1828const char**subsection,int*subsection_len,1829const char**key);18301831struct config_set_element {1832struct hashmap_entry ent;1833char*key;1834struct string_list value_list;1835};18361837struct configset_list_item {1838struct config_set_element *e;1839int value_index;1840};18411842/*1843 * the contents of the list are ordered according to their1844 * position in the config files and order of parsing the files.1845 * (i.e. key-value pair at the last position of .git/config will1846 * be at the last item of the list)1847 */1848struct configset_list {1849struct configset_list_item *items;1850unsigned int nr, alloc;1851};18521853struct config_set {1854struct hashmap config_hash;1855int hash_initialized;1856struct configset_list list;1857};18581859externvoidgit_configset_init(struct config_set *cs);1860externintgit_configset_add_file(struct config_set *cs,const char*filename);1861externintgit_configset_get_value(struct config_set *cs,const char*key,const char**value);1862externconst struct string_list *git_configset_get_value_multi(struct config_set *cs,const char*key);1863externvoidgit_configset_clear(struct config_set *cs);1864externintgit_configset_get_string_const(struct config_set *cs,const char*key,const char**dest);1865externintgit_configset_get_string(struct config_set *cs,const char*key,char**dest);1866externintgit_configset_get_int(struct config_set *cs,const char*key,int*dest);1867externintgit_configset_get_ulong(struct config_set *cs,const char*key,unsigned long*dest);1868externintgit_configset_get_bool(struct config_set *cs,const char*key,int*dest);1869externintgit_configset_get_bool_or_int(struct config_set *cs,const char*key,int*is_bool,int*dest);1870externintgit_configset_get_maybe_bool(struct config_set *cs,const char*key,int*dest);1871externintgit_configset_get_pathname(struct config_set *cs,const char*key,const char**dest);18721873externintgit_config_get_value(const char*key,const char**value);1874externconst struct string_list *git_config_get_value_multi(const char*key);1875externvoidgit_config_clear(void);1876externvoidgit_config_iter(config_fn_t fn,void*data);1877externintgit_config_get_string_const(const char*key,const char**dest);1878externintgit_config_get_string(const char*key,char**dest);1879externintgit_config_get_int(const char*key,int*dest);1880externintgit_config_get_ulong(const char*key,unsigned long*dest);1881externintgit_config_get_bool(const char*key,int*dest);1882externintgit_config_get_bool_or_int(const char*key,int*is_bool,int*dest);1883externintgit_config_get_maybe_bool(const char*key,int*dest);1884externintgit_config_get_pathname(const char*key,const char**dest);1885externintgit_config_get_untracked_cache(void);18861887/*1888 * This is a hack for test programs like test-dump-untracked-cache to1889 * ensure that they do not modify the untracked cache when reading it.1890 * Do not use it otherwise!1891 */1892externint ignore_untracked_cache_config;18931894struct key_value_info {1895const char*filename;1896int linenr;1897enum config_origin_type origin_type;1898enum config_scope scope;1899};19001901extern NORETURN voidgit_die_config(const char*key,const char*err, ...)__attribute__((format(printf,2,3)));1902extern NORETURN voidgit_die_config_linenr(const char*key,const char*filename,int linenr);19031904externintcommitter_ident_sufficiently_given(void);1905externintauthor_ident_sufficiently_given(void);19061907externconst char*git_commit_encoding;1908externconst char*git_log_output_encoding;1909externconst char*git_mailmap_file;1910externconst char*git_mailmap_blob;19111912/* IO helper functions */1913externvoidmaybe_flush_or_die(FILE*,const char*);1914__attribute__((format(printf,2,3)))1915externvoidfprintf_or_die(FILE*,const char*fmt, ...);19161917#define COPY_READ_ERROR (-2)1918#define COPY_WRITE_ERROR (-3)1919externintcopy_fd(int ifd,int ofd);1920externintcopy_file(const char*dst,const char*src,int mode);1921externintcopy_file_with_time(const char*dst,const char*src,int mode);19221923externvoidwrite_or_die(int fd,const void*buf,size_t count);1924externvoidfsync_or_die(int fd,const char*);19251926extern ssize_t read_in_full(int fd,void*buf,size_t count);1927extern ssize_t write_in_full(int fd,const void*buf,size_t count);1928extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);19291930staticinline ssize_t write_str_in_full(int fd,const char*str)1931{1932returnwrite_in_full(fd, str,strlen(str));1933}19341935/**1936 * Open (and truncate) the file at path, write the contents of buf to it,1937 * and close it. Dies if any errors are encountered.1938 */1939externvoidwrite_file_buf(const char*path,const char*buf,size_t len);19401941/**1942 * Like write_file_buf(), but format the contents into a buffer first.1943 * Additionally, write_file() will append a newline if one is not already1944 * present, making it convenient to write text files:1945 *1946 * write_file(path, "counter: %d", ctr);1947 */1948__attribute__((format(printf,2,3)))1949externvoidwrite_file(const char*path,const char*fmt, ...);19501951/* pager.c */1952externvoidsetup_pager(void);1953externintpager_in_use(void);1954externint pager_use_color;1955externintterm_columns(void);1956externintdecimal_width(uintmax_t);1957externintcheck_pager_config(const char*cmd);1958externvoidprepare_pager_args(struct child_process *,const char*pager);19591960externconst char*editor_program;1961externconst char*askpass_program;1962externconst char*excludes_file;19631964/* base85 */1965intdecode_85(char*dst,const char*line,int linelen);1966voidencode_85(char*buf,const unsigned char*data,int bytes);19671968/* alloc.c */1969externvoid*alloc_blob_node(void);1970externvoid*alloc_tree_node(void);1971externvoid*alloc_commit_node(void);1972externvoid*alloc_tag_node(void);1973externvoid*alloc_object_node(void);1974externvoidalloc_report(void);1975externunsigned intalloc_commit_index(void);19761977/* pkt-line.c */1978voidpacket_trace_identity(const char*prog);19791980/* add */1981/*1982 * return 0 if success, 1 - if addition of a file failed and1983 * ADD_FILES_IGNORE_ERRORS was specified in flags1984 */1985intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);19861987/* diff.c */1988externint diff_auto_refresh_index;19891990/* match-trees.c */1991voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1992voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);19931994/*1995 * whitespace rules.1996 * used by both diff and apply1997 * last two digits are tab width1998 */1999#define WS_BLANK_AT_EOL 01002000#define WS_SPACE_BEFORE_TAB 02002001#define WS_INDENT_WITH_NON_TAB 04002002#define WS_CR_AT_EOL 010002003#define WS_BLANK_AT_EOF 020002004#define WS_TAB_IN_INDENT 040002005#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)2006#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)2007#define WS_TAB_WIDTH_MASK 0772008externunsigned whitespace_rule_cfg;2009externunsignedwhitespace_rule(const char*);2010externunsignedparse_whitespace_rule(const char*);2011externunsignedws_check(const char*line,int len,unsigned ws_rule);2012externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);2013externchar*whitespace_error_string(unsigned ws);2014externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);2015externintws_blank_line(const char*line,int len,unsigned ws_rule);2016#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)20172018/* ls-files */2019voidoverlay_tree_on_cache(const char*tree_name,const char*prefix);20202021char*alias_lookup(const char*alias);2022intsplit_cmdline(char*cmdline,const char***argv);2023/* Takes a negative value returned by split_cmdline */2024const char*split_cmdline_strerror(int cmdline_errno);20252026/* setup.c */2027struct startup_info {2028int have_repository;2029const char*prefix;2030};2031externstruct startup_info *startup_info;20322033/* merge.c */2034struct commit_list;2035inttry_merge_command(const char*strategy,size_t xopts_nr,2036const char**xopts,struct commit_list *common,2037const char*head_arg,struct commit_list *remotes);2038intcheckout_fast_forward(const unsigned char*from,2039const unsigned char*to,2040int overwrite_ignore);204120422043intsane_execvp(const char*file,char*const argv[]);20442045/*2046 * A struct to encapsulate the concept of whether a file has changed2047 * since we last checked it. This uses criteria similar to those used2048 * for the index.2049 */2050struct stat_validity {2051struct stat_data *sd;2052};20532054voidstat_validity_clear(struct stat_validity *sv);20552056/*2057 * Returns 1 if the path is a regular file (or a symlink to a regular2058 * file) and matches the saved stat_validity, 0 otherwise. A missing2059 * or inaccessible file is considered a match if the struct was just2060 * initialized, or if the previous update found an inaccessible file.2061 */2062intstat_validity_check(struct stat_validity *sv,const char*path);20632064/*2065 * Update the stat_validity from a file opened at descriptor fd. If2066 * the file is missing, inaccessible, or not a regular file, then2067 * future calls to stat_validity_check will match iff one of those2068 * conditions continues to be true.2069 */2070voidstat_validity_update(struct stat_validity *sv,int fd);20712072intversioncmp(const char*s1,const char*s2);2073voidsleep_millisec(int millisec);20742075/*2076 * Create a directory and (if share is nonzero) adjust its permissions2077 * according to the shared_repository setting. Only use this for2078 * directories under $GIT_DIR. Don't use it for working tree2079 * directories.2080 */2081voidsafe_create_dir(const char*dir,int share);20822083#endif/* CACHE_H */