1#ifndef CACHE_H 2#define CACHE_H 3 4#include"git-compat-util.h" 5#include"strbuf.h" 6#include"hashmap.h" 7#include"advice.h" 8#include"gettext.h" 9#include"convert.h" 10#include"trace.h" 11#include"string-list.h" 12#include"pack-revindex.h" 13#include"hash.h" 14 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); 521/* 522 * Find GIT_DIR of the repository that contains the current working directory, 523 * without changing the working directory or other global state. The result is 524 * appended to gitdir. The return value is either NULL if no repository was 525 * found, or pointing to the path inside gitdir's buffer. 526 */ 527externconst char*discover_git_directory(struct strbuf *gitdir); 528externconst char*setup_git_directory_gently(int*); 529externconst char*setup_git_directory(void); 530externchar*prefix_path(const char*prefix,int len,const char*path); 531externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 532 533/* 534 * Concatenate "prefix" (if len is non-zero) and "path", with no 535 * connecting characters (so "prefix" should end with a "/"). 536 * Unlike prefix_path, this should be used if the named file does 537 * not have to interact with index entry; i.e. name of a random file 538 * on the filesystem. 539 * 540 * The return value is always a newly allocated string (even if the 541 * prefix was empty). 542 */ 543externchar*prefix_filename(const char*prefix,const char*path); 544 545externintcheck_filename(const char*prefix,const char*name); 546externvoidverify_filename(const char*prefix, 547const char*name, 548int diagnose_misspelt_rev); 549externvoidverify_non_filename(const char*prefix,const char*name); 550externintpath_inside_repo(const char*prefix,const char*path); 551 552#define INIT_DB_QUIET 0x0001 553#define INIT_DB_EXIST_OK 0x0002 554 555externintinit_db(const char*git_dir,const char*real_git_dir, 556const char*template_dir,unsigned int flags); 557 558externvoidsanitize_stdfds(void); 559externintdaemonize(void); 560 561#define alloc_nr(x) (((x)+16)*3/2) 562 563/* 564 * Realloc the buffer pointed at by variable 'x' so that it can hold 565 * at least 'nr' entries; the number of entries currently allocated 566 * is 'alloc', using the standard growing factor alloc_nr() macro. 567 * 568 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 569 */ 570#define ALLOC_GROW(x, nr, alloc) \ 571 do { \ 572 if ((nr) > alloc) { \ 573 if (alloc_nr(alloc) < (nr)) \ 574 alloc = (nr); \ 575 else \ 576 alloc = alloc_nr(alloc); \ 577 REALLOC_ARRAY(x, alloc); \ 578 } \ 579 } while (0) 580 581/* Initialize and use the cache information */ 582struct lock_file; 583externintread_index(struct index_state *); 584externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 585externintdo_read_index(struct index_state *istate,const char*path, 586int must_exist);/* for testting only! */ 587externintread_index_from(struct index_state *,const char*path); 588externintis_index_unborn(struct index_state *); 589externintread_index_unmerged(struct index_state *); 590#define COMMIT_LOCK (1 << 0) 591#define CLOSE_LOCK (1 << 1) 592externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 593externintdiscard_index(struct index_state *); 594externintunmerged_index(const struct index_state *); 595externintverify_path(const char*path); 596externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 597externvoidadjust_dirname_case(struct index_state *istate,char*name); 598externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 599 600/* 601 * Searches for an entry defined by name and namelen in the given index. 602 * If the return value is positive (including 0) it is the position of an 603 * exact match. If the return value is negative, the negated value minus 1 604 * is the position where the entry would be inserted. 605 * Example: The current index consists of these files and its stages: 606 * 607 * b#0, d#0, f#1, f#3 608 * 609 * index_name_pos(&index, "a", 1) -> -1 610 * index_name_pos(&index, "b", 1) -> 0 611 * index_name_pos(&index, "c", 1) -> -2 612 * index_name_pos(&index, "d", 1) -> 1 613 * index_name_pos(&index, "e", 1) -> -3 614 * index_name_pos(&index, "f", 1) -> -3 615 * index_name_pos(&index, "g", 1) -> -5 616 */ 617externintindex_name_pos(const struct index_state *,const char*name,int namelen); 618 619#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 620#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 621#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 622#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 623#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 624#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 625externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 626externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 627 628/* Remove entry, return true if there are more entries to go. */ 629externintremove_index_entry_at(struct index_state *,int pos); 630 631externvoidremove_marked_cache_entries(struct index_state *istate); 632externintremove_file_from_index(struct index_state *,const char*path); 633#define ADD_CACHE_VERBOSE 1 634#define ADD_CACHE_PRETEND 2 635#define ADD_CACHE_IGNORE_ERRORS 4 636#define ADD_CACHE_IGNORE_REMOVAL 8 637#define ADD_CACHE_INTENT 16 638/* 639 * These two are used to add the contents of the file at path 640 * to the index, marking the working tree up-to-date by storing 641 * the cached stat info in the resulting cache entry. A caller 642 * that has already run lstat(2) on the path can call 643 * add_to_index(), and all others can call add_file_to_index(); 644 * the latter will do necessary lstat(2) internally before 645 * calling the former. 646 */ 647externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 648externintadd_file_to_index(struct index_state *,const char*path,int flags); 649 650externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 651externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 652externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 653externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 654externintindex_name_is_other(const struct index_state *,const char*,int); 655externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 656 657/* do stat comparison even if CE_VALID is true */ 658#define CE_MATCH_IGNORE_VALID 01 659/* do not check the contents but report dirty on racily-clean entries */ 660#define CE_MATCH_RACY_IS_DIRTY 02 661/* do stat comparison even if CE_SKIP_WORKTREE is true */ 662#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 663/* ignore non-existent files during stat update */ 664#define CE_MATCH_IGNORE_MISSING 0x08 665/* enable stat refresh */ 666#define CE_MATCH_REFRESH 0x10 667externintie_match_stat(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 668externintie_modified(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 669 670#define HASH_WRITE_OBJECT 1 671#define HASH_FORMAT_CHECK 2 672externintindex_fd(unsigned char*sha1,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 673externintindex_path(unsigned char*sha1,const char*path,struct stat *st,unsigned flags); 674 675/* 676 * Record to sd the data from st that we use to check whether a file 677 * might have changed. 678 */ 679externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 680 681/* 682 * Return 0 if st is consistent with a file not having been changed 683 * since sd was filled. If there are differences, return a 684 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 685 * INODE_CHANGED, and DATA_CHANGED. 686 */ 687externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 688externintmatch_stat_data_racy(const struct index_state *istate, 689const struct stat_data *sd,struct stat *st); 690 691externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 692 693#define REFRESH_REALLY 0x0001/* ignore_valid */ 694#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 695#define REFRESH_QUIET 0x0004/* be quiet about it */ 696#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 697#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 698#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 699externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 700externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 701 702externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 703 704externinthold_locked_index(struct lock_file *,int); 705externvoidset_alternate_index_output(const char*); 706 707/* Environment bits from configuration mechanism */ 708externint trust_executable_bit; 709externint trust_ctime; 710externint check_stat; 711externint quote_path_fully; 712externint has_symlinks; 713externint minimum_abbrev, default_abbrev; 714externint ignore_case; 715externint assume_unchanged; 716externint prefer_symlink_refs; 717externint warn_ambiguous_refs; 718externint warn_on_object_refname_ambiguity; 719externconst char*apply_default_whitespace; 720externconst char*apply_default_ignorewhitespace; 721externconst char*git_attributes_file; 722externconst char*git_hooks_path; 723externint zlib_compression_level; 724externint core_compression_level; 725externint pack_compression_level; 726externsize_t packed_git_window_size; 727externsize_t packed_git_limit; 728externsize_t delta_base_cache_limit; 729externunsigned long big_file_threshold; 730externunsigned long pack_size_limit_cfg; 731 732/* 733 * Accessors for the core.sharedrepository config which lazy-load the value 734 * from the config (if not already set). The "reset" function can be 735 * used to unset "set" or cached value, meaning that the value will be loaded 736 * fresh from the config file on the next call to get_shared_repository(). 737 */ 738voidset_shared_repository(int value); 739intget_shared_repository(void); 740voidreset_shared_repository(void); 741 742/* 743 * Do replace refs need to be checked this run? This variable is 744 * initialized to true unless --no-replace-object is used or 745 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 746 * commands that do not want replace references to be active. As an 747 * optimization it is also set to false if replace references have 748 * been sought but there were none. 749 */ 750externint check_replace_refs; 751externchar*git_replace_ref_base; 752 753externint fsync_object_files; 754externint core_preload_index; 755externint core_apply_sparse_checkout; 756externint precomposed_unicode; 757externint protect_hfs; 758externint protect_ntfs; 759externint git_db_env, git_index_env, git_graft_env, git_common_dir_env; 760 761/* 762 * Include broken refs in all ref iterations, which will 763 * generally choke dangerous operations rather than letting 764 * them silently proceed without taking the broken ref into 765 * account. 766 */ 767externint ref_paranoia; 768 769/* 770 * The character that begins a commented line in user-editable file 771 * that is subject to stripspace. 772 */ 773externchar comment_line_char; 774externint auto_comment_line_char; 775 776/* Windows only */ 777enum hide_dotfiles_type { 778 HIDE_DOTFILES_FALSE =0, 779 HIDE_DOTFILES_TRUE, 780 HIDE_DOTFILES_DOTGITONLY 781}; 782externenum hide_dotfiles_type hide_dotfiles; 783 784enum log_refs_config { 785 LOG_REFS_UNSET = -1, 786 LOG_REFS_NONE =0, 787 LOG_REFS_NORMAL, 788 LOG_REFS_ALWAYS 789}; 790externenum log_refs_config log_all_ref_updates; 791 792enum branch_track { 793 BRANCH_TRACK_UNSPECIFIED = -1, 794 BRANCH_TRACK_NEVER =0, 795 BRANCH_TRACK_REMOTE, 796 BRANCH_TRACK_ALWAYS, 797 BRANCH_TRACK_EXPLICIT, 798 BRANCH_TRACK_OVERRIDE 799}; 800 801enum rebase_setup_type { 802 AUTOREBASE_NEVER =0, 803 AUTOREBASE_LOCAL, 804 AUTOREBASE_REMOTE, 805 AUTOREBASE_ALWAYS 806}; 807 808enum push_default_type { 809 PUSH_DEFAULT_NOTHING =0, 810 PUSH_DEFAULT_MATCHING, 811 PUSH_DEFAULT_SIMPLE, 812 PUSH_DEFAULT_UPSTREAM, 813 PUSH_DEFAULT_CURRENT, 814 PUSH_DEFAULT_UNSPECIFIED 815}; 816 817externenum branch_track git_branch_track; 818externenum rebase_setup_type autorebase; 819externenum push_default_type push_default; 820 821enum object_creation_mode { 822 OBJECT_CREATION_USES_HARDLINKS =0, 823 OBJECT_CREATION_USES_RENAMES =1 824}; 825 826externenum object_creation_mode object_creation_mode; 827 828externchar*notes_ref_name; 829 830externint grafts_replace_parents; 831 832/* 833 * GIT_REPO_VERSION is the version we write by default. The 834 * _READ variant is the highest number we know how to 835 * handle. 836 */ 837#define GIT_REPO_VERSION 0 838#define GIT_REPO_VERSION_READ 1 839externint repository_format_precious_objects; 840 841struct repository_format { 842int version; 843int precious_objects; 844int is_bare; 845char*work_tree; 846struct string_list unknown_extensions; 847}; 848 849/* 850 * Read the repository format characteristics from the config file "path" into 851 * "format" struct. Returns the numeric version. On error, -1 is returned, 852 * format->version is set to -1, and all other fields in the struct are 853 * undefined. 854 */ 855intread_repository_format(struct repository_format *format,const char*path); 856 857/* 858 * Verify that the repository described by repository_format is something we 859 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 860 * any errors encountered. 861 */ 862intverify_repository_format(const struct repository_format *format, 863struct strbuf *err); 864 865/* 866 * Check the repository format version in the path found in get_git_dir(), 867 * and die if it is a version we don't understand. Generally one would 868 * set_git_dir() before calling this, and use it only for "are we in a valid 869 * repo?". 870 */ 871externvoidcheck_repository_format(void); 872 873#define MTIME_CHANGED 0x0001 874#define CTIME_CHANGED 0x0002 875#define OWNER_CHANGED 0x0004 876#define MODE_CHANGED 0x0008 877#define INODE_CHANGED 0x0010 878#define DATA_CHANGED 0x0020 879#define TYPE_CHANGED 0x0040 880 881/* 882 * Return a statically allocated filename, either generically (mkpath), in 883 * the repository directory (git_path), or in a submodule's repository 884 * directory (git_path_submodule). In all cases, note that the result 885 * may be overwritten by another call to _any_ of the functions. Consider 886 * using the safer "dup" or "strbuf" formats below (in some cases, the 887 * unsafe versions have already been removed). 888 */ 889externconst char*mkpath(const char*fmt, ...)__attribute__((format(printf,1,2))); 890externconst char*git_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 891externconst char*git_common_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 892 893externchar*mksnpath(char*buf,size_t n,const char*fmt, ...) 894__attribute__((format(printf,3,4))); 895externvoidstrbuf_git_path(struct strbuf *sb,const char*fmt, ...) 896__attribute__((format(printf,2,3))); 897externvoidstrbuf_git_common_path(struct strbuf *sb,const char*fmt, ...) 898__attribute__((format(printf,2,3))); 899externchar*git_path_buf(struct strbuf *buf,const char*fmt, ...) 900__attribute__((format(printf,2,3))); 901externintstrbuf_git_path_submodule(struct strbuf *sb,const char*path, 902const char*fmt, ...) 903__attribute__((format(printf,3,4))); 904externchar*git_pathdup(const char*fmt, ...) 905__attribute__((format(printf,1,2))); 906externchar*mkpathdup(const char*fmt, ...) 907__attribute__((format(printf,1,2))); 908externchar*git_pathdup_submodule(const char*path,const char*fmt, ...) 909__attribute__((format(printf,2,3))); 910 911externvoidreport_linked_checkout_garbage(void); 912 913/* 914 * You can define a static memoized git path like: 915 * 916 * static GIT_PATH_FUNC(git_path_foo, "FOO"); 917 * 918 * or use one of the global ones below. 919 */ 920#define GIT_PATH_FUNC(func, filename) \ 921 const char *func(void) \ 922 { \ 923 static char *ret; \ 924 if (!ret) \ 925 ret = git_pathdup(filename); \ 926 return ret; \ 927 } 928 929const char*git_path_cherry_pick_head(void); 930const char*git_path_revert_head(void); 931const char*git_path_squash_msg(void); 932const char*git_path_merge_msg(void); 933const char*git_path_merge_rr(void); 934const char*git_path_merge_mode(void); 935const char*git_path_merge_head(void); 936const char*git_path_fetch_head(void); 937const char*git_path_shallow(void); 938 939/* 940 * Return the name of the file in the local object database that would 941 * be used to store a loose object with the specified sha1. The 942 * return value is a pointer to a statically allocated buffer that is 943 * overwritten each time the function is called. 944 */ 945externconst char*sha1_file_name(const unsigned char*sha1); 946 947/* 948 * Return the name of the (local) packfile with the specified sha1 in 949 * its name. The return value is a pointer to memory that is 950 * overwritten each time this function is called. 951 */ 952externchar*sha1_pack_name(const unsigned char*sha1); 953 954/* 955 * Return the name of the (local) pack index file with the specified 956 * sha1 in its name. The return value is a pointer to memory that is 957 * overwritten each time this function is called. 958 */ 959externchar*sha1_pack_index_name(const unsigned char*sha1); 960 961/* 962 * Return an abbreviated sha1 unique within this repository's object database. 963 * The result will be at least `len` characters long, and will be NUL 964 * terminated. 965 * 966 * The non-`_r` version returns a static buffer which remains valid until 4 967 * more calls to find_unique_abbrev are made. 968 * 969 * The `_r` variant writes to a buffer supplied by the caller, which must be at 970 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 971 * written (excluding the NUL terminator). 972 * 973 * Note that while this version avoids the static buffer, it is not fully 974 * reentrant, as it calls into other non-reentrant git code. 975 */ 976externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 977externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 978 979externconst unsigned char null_sha1[GIT_SHA1_RAWSZ]; 980externconst struct object_id null_oid; 981 982staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 983{ 984int i; 985 986for(i =0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 987if(*sha1 != *sha2) 988return*sha1 - *sha2; 989} 990 991return0; 992} 993 994staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 995{ 996returnhashcmp(oid1->hash, oid2->hash); 997} 998 999staticinlineintis_null_sha1(const unsigned char*sha1)1000{1001return!hashcmp(sha1, null_sha1);1002}10031004staticinlineintis_null_oid(const struct object_id *oid)1005{1006return!hashcmp(oid->hash, null_sha1);1007}10081009staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src)1010{1011memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);1012}10131014staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src)1015{1016hashcpy(dst->hash, src->hash);1017}10181019staticinlinevoidhashclr(unsigned char*hash)1020{1021memset(hash,0, GIT_SHA1_RAWSZ);1022}10231024staticinlinevoidoidclr(struct object_id *oid)1025{1026hashclr(oid->hash);1027}102810291030#define EMPTY_TREE_SHA1_HEX \1031"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1032#define EMPTY_TREE_SHA1_BIN_LITERAL \1033"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1034"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1035externconst struct object_id empty_tree_oid;1036#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10371038#define EMPTY_BLOB_SHA1_HEX \1039"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1040#define EMPTY_BLOB_SHA1_BIN_LITERAL \1041"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1042"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1043externconst struct object_id empty_blob_oid;1044#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)104510461047staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1048{1049return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1050}10511052staticinlineintis_empty_blob_oid(const struct object_id *oid)1053{1054return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1055}10561057staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1058{1059return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1060}10611062staticinlineintis_empty_tree_oid(const struct object_id *oid)1063{1064return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1065}10661067/* set default permissions by passing mode arguments to open(2) */1068intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1069intgit_mkstemp_mode(char*pattern,int mode);10701071/*1072 * NOTE NOTE NOTE!!1073 *1074 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1075 * not be changed. Old repositories have core.sharedrepository written in1076 * numeric format, and therefore these values are preserved for compatibility1077 * reasons.1078 */1079enum sharedrepo {1080 PERM_UMASK =0,1081 OLD_PERM_GROUP =1,1082 OLD_PERM_EVERYBODY =2,1083 PERM_GROUP =0660,1084 PERM_EVERYBODY =06641085};1086intgit_config_perm(const char*var,const char*value);1087intadjust_shared_perm(const char*path);10881089/*1090 * Create the directory containing the named path, using care to be1091 * somewhat safe against races. Return one of the scld_error values to1092 * indicate success/failure. On error, set errno to describe the1093 * problem.1094 *1095 * SCLD_VANISHED indicates that one of the ancestor directories of the1096 * path existed at one point during the function call and then1097 * suddenly vanished, probably because another process pruned the1098 * directory while we were working. To be robust against this kind of1099 * race, callers might want to try invoking the function again when it1100 * returns SCLD_VANISHED.1101 *1102 * safe_create_leading_directories() temporarily changes path while it1103 * is working but restores it before returning.1104 * safe_create_leading_directories_const() doesn't modify path, even1105 * temporarily.1106 */1107enum scld_error {1108 SCLD_OK =0,1109 SCLD_FAILED = -1,1110 SCLD_PERMS = -2,1111 SCLD_EXISTS = -3,1112 SCLD_VANISHED = -41113};1114enum scld_error safe_create_leading_directories(char*path);1115enum scld_error safe_create_leading_directories_const(const char*path);11161117/*1118 * Callback function for raceproof_create_file(). This function is1119 * expected to do something that makes dirname(path) permanent despite1120 * the fact that other processes might be cleaning up empty1121 * directories at the same time. Usually it will create a file named1122 * path, but alternatively it could create another file in that1123 * directory, or even chdir() into that directory. The function should1124 * return 0 if the action was completed successfully. On error, it1125 * should return a nonzero result and set errno.1126 * raceproof_create_file() treats two errno values specially:1127 *1128 * - ENOENT -- dirname(path) does not exist. In this case,1129 * raceproof_create_file() tries creating dirname(path)1130 * (and any parent directories, if necessary) and calls1131 * the function again.1132 *1133 * - EISDIR -- the file already exists and is a directory. In this1134 * case, raceproof_create_file() removes the directory if1135 * it is empty (and recursively any empty directories that1136 * it contains) and calls the function again.1137 *1138 * Any other errno causes raceproof_create_file() to fail with the1139 * callback's return value and errno.1140 *1141 * Obviously, this function should be OK with being called again if it1142 * fails with ENOENT or EISDIR. In other scenarios it will not be1143 * called again.1144 */1145typedefintcreate_file_fn(const char*path,void*cb);11461147/*1148 * Create a file in dirname(path) by calling fn, creating leading1149 * directories if necessary. Retry a few times in case we are racing1150 * with another process that is trying to clean up the directory that1151 * contains path. See the documentation for create_file_fn for more1152 * details.1153 *1154 * Return the value and set the errno that resulted from the most1155 * recent call of fn. fn is always called at least once, and will be1156 * called more than once if it returns ENOENT or EISDIR.1157 */1158intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11591160intmkdir_in_gitdir(const char*path);1161externchar*expand_user_path(const char*path);1162const char*enter_repo(const char*path,int strict);1163staticinlineintis_absolute_path(const char*path)1164{1165returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1166}1167intis_directory(const char*);1168char*strbuf_realpath(struct strbuf *resolved,const char*path,1169int die_on_error);1170const char*real_path(const char*path);1171const char*real_path_if_valid(const char*path);1172char*real_pathdup(const char*path,int die_on_error);1173const char*absolute_path(const char*path);1174char*absolute_pathdup(const char*path);1175const char*remove_leading_path(const char*in,const char*prefix);1176const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1177intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1178intnormalize_path_copy(char*dst,const char*src);1179intlongest_ancestor_length(const char*path,struct string_list *prefixes);1180char*strip_path_suffix(const char*path,const char*suffix);1181intdaemon_avoid_alias(const char*path);1182externintis_ntfs_dotgit(const char*name);11831184/**1185 * Return a newly allocated string with the evaluation of1186 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1187 * "$HOME/.config/git/$filename". Return NULL upon error.1188 */1189externchar*xdg_config_home(const char*filename);11901191/* object replacement */1192#define LOOKUP_REPLACE_OBJECT 11193#define LOOKUP_UNKNOWN_OBJECT 21194externvoid*read_sha1_file_extended(const unsigned char*sha1,enum object_type *type,unsigned long*size,unsigned flag);1195staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1196{1197returnread_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);1198}11991200/*1201 * This internal function is only declared here for the benefit of1202 * lookup_replace_object(). Please do not call it directly.1203 */1204externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);12051206/*1207 * If object sha1 should be replaced, return the replacement object's1208 * name (replaced recursively, if necessary). The return value is1209 * either sha1 or a pointer to a permanently-allocated value. When1210 * object replacement is suppressed, always return sha1.1211 */1212staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1213{1214if(!check_replace_refs)1215return sha1;1216returndo_lookup_replace_object(sha1);1217}12181219staticinlineconst unsigned char*lookup_replace_object_extended(const unsigned char*sha1,unsigned flag)1220{1221if(!(flag & LOOKUP_REPLACE_OBJECT))1222return sha1;1223returnlookup_replace_object(sha1);1224}12251226/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1227externintsha1_object_info(const unsigned char*,unsigned long*);1228externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1);1229externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1);1230externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,unsigned char*sha1,unsigned flags);1231externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*);1232externintforce_object_loose(const unsigned char*sha1,time_t mtime);1233externintgit_open_cloexec(const char*name,int flags);1234#define git_open(name) git_open_cloexec(name, O_RDONLY)1235externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1236externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1237externintparse_sha1_header(const char*hdr,unsigned long*sizep);12381239/* global flag to enable extra checks when accessing packed objects */1240externint do_check_packed_object_crc;12411242externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);12431244externintfinalize_object_file(const char*tmpfile,const char*filename);12451246externinthas_sha1_pack(const unsigned char*sha1);12471248/*1249 * Open the loose object at path, check its sha1, and return the contents,1250 * type, and size. If the object is a blob, then "contents" may return NULL,1251 * to allow streaming of large blobs.1252 *1253 * Returns 0 on success, negative on error (details may be written to stderr).1254 */1255intread_loose_object(const char*path,1256const unsigned char*expected_sha1,1257enum object_type *type,1258unsigned long*size,1259void**contents);12601261/*1262 * Return true iff we have an object named sha1, whether local or in1263 * an alternate object database, and whether packed or loose. This1264 * function does not respect replace references.1265 *1266 * If the QUICK flag is set, do not re-check the pack directory1267 * when we cannot find the object (this means we may give a false1268 * negative answer if another process is simultaneously repacking).1269 */1270#define HAS_SHA1_QUICK 0x11271externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1272staticinlineinthas_sha1_file(const unsigned char*sha1)1273{1274returnhas_sha1_file_with_flags(sha1,0);1275}12761277/* Same as the above, except for struct object_id. */1278externinthas_object_file(const struct object_id *oid);1279externinthas_object_file_with_flags(const struct object_id *oid,int flags);12801281/*1282 * Return true iff an alternate object database has a loose object1283 * with the specified name. This function does not respect replace1284 * references.1285 */1286externinthas_loose_object_nonlocal(const unsigned char*sha1);12871288externinthas_pack_index(const unsigned char*sha1);12891290externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);12911292/* Helper to check and "touch" a file */1293externintcheck_and_freshen_file(const char*fn,int freshen);12941295externconst signed char hexval_table[256];1296staticinlineunsigned inthexval(unsigned char c)1297{1298return hexval_table[c];1299}13001301/*1302 * Convert two consecutive hexadecimal digits into a char. Return a1303 * negative value on error. Don't run over the end of short strings.1304 */1305staticinlineinthex2chr(const char*s)1306{1307int val =hexval(s[0]);1308return(val <0) ? val : (val <<4) |hexval(s[1]);1309}13101311/* Convert to/from hex/sha1 representation */1312#define MINIMUM_ABBREV minimum_abbrev1313#define DEFAULT_ABBREV default_abbrev13141315/* used when the code does not know or care what the default abbrev is */1316#define FALLBACK_DEFAULT_ABBREV 713171318struct object_context {1319unsigned char tree[20];1320char path[PATH_MAX];1321unsigned mode;1322/*1323 * symlink_path is only used by get_tree_entry_follow_symlinks,1324 * and only for symlinks that point outside the repository.1325 */1326struct strbuf symlink_path;1327};13281329#define GET_SHA1_QUIETLY 011330#define GET_SHA1_COMMIT 021331#define GET_SHA1_COMMITTISH 041332#define GET_SHA1_TREE 0101333#define GET_SHA1_TREEISH 0201334#define GET_SHA1_BLOB 0401335#define GET_SHA1_FOLLOW_SYMLINKS 01001336#define GET_SHA1_ONLY_TO_DIE 0400013371338#define GET_SHA1_DISAMBIGUATORS \1339 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \1340 GET_SHA1_TREE | GET_SHA1_TREEISH | \1341 GET_SHA1_BLOB)13421343externintget_sha1(const char*str,unsigned char*sha1);1344externintget_sha1_commit(const char*str,unsigned char*sha1);1345externintget_sha1_committish(const char*str,unsigned char*sha1);1346externintget_sha1_tree(const char*str,unsigned char*sha1);1347externintget_sha1_treeish(const char*str,unsigned char*sha1);1348externintget_sha1_blob(const char*str,unsigned char*sha1);1349externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1350externintget_sha1_with_context(const char*str,unsigned flags,unsigned char*sha1,struct object_context *orc);13511352externintget_oid(const char*str,struct object_id *oid);13531354typedefinteach_abbrev_fn(const unsigned char*sha1,void*);1355externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13561357externintset_disambiguate_hint_config(const char*var,const char*value);13581359/*1360 * Try to read a SHA1 in hexadecimal format from the 40 characters1361 * starting at hex. Write the 20-byte result to sha1 in binary form.1362 * Return 0 on success. Reading stops if a NUL is encountered in the1363 * input, so it is safe to pass this function an arbitrary1364 * null-terminated string.1365 */1366externintget_sha1_hex(const char*hex,unsigned char*sha1);1367externintget_oid_hex(const char*hex,struct object_id *sha1);13681369/*1370 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1371 * and writes the NUL-terminated output to the buffer `out`, which must be at1372 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1373 * convenience.1374 *1375 * The non-`_r` variant returns a static buffer, but uses a ring of 41376 * buffers, making it safe to make multiple calls for a single statement, like:1377 *1378 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1379 */1380externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1381externchar*oid_to_hex_r(char*out,const struct object_id *oid);1382externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1383externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */13841385/*1386 * Parse a 40-character hexadecimal object ID starting from hex, updating the1387 * pointer specified by end when parsing stops. The resulting object ID is1388 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1389 * other invalid character. end is only updated on success; otherwise, it is1390 * unmodified.1391 */1392externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);13931394/*1395 * This reads short-hand syntax that not only evaluates to a commit1396 * object name, but also can act as if the end user spelled the name1397 * of the branch from the command line.1398 *1399 * - "@{-N}" finds the name of the Nth previous branch we were on, and1400 * places the name of the branch in the given buf and returns the1401 * number of characters parsed if successful.1402 *1403 * - "<branch>@{upstream}" finds the name of the other ref that1404 * <branch> is configured to merge with (missing <branch> defaults1405 * to the current branch), and places the name of the branch in the1406 * given buf and returns the number of characters parsed if1407 * successful.1408 *1409 * If the input is not of the accepted format, it returns a negative1410 * number to signal an error.1411 *1412 * If the input was ok but there are not N branch switches in the1413 * reflog, it returns 0.1414 *1415 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1416 * expansions: local branches ("refs/heads/"), remote branches1417 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1418 * allowed, even ones to refs outside of those namespaces.1419 */1420#define INTERPRET_BRANCH_LOCAL (1<<0)1421#define INTERPRET_BRANCH_REMOTE (1<<1)1422#define INTERPRET_BRANCH_HEAD (1<<2)1423externintinterpret_branch_name(const char*str,int len,struct strbuf *,1424unsigned allowed);1425externintget_oid_mb(const char*str,struct object_id *oid);14261427externintvalidate_headref(const char*ref);14281429externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1430externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1431externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1432externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);14331434externvoid*read_object_with_reference(const unsigned char*sha1,1435const char*required_type,1436unsigned long*size,1437unsigned char*sha1_ret);14381439externstruct object *peel_to_type(const char*name,int namelen,1440struct object *o,enum object_type);14411442struct date_mode {1443enum date_mode_type {1444 DATE_NORMAL =0,1445 DATE_RELATIVE,1446 DATE_SHORT,1447 DATE_ISO8601,1448 DATE_ISO8601_STRICT,1449 DATE_RFC2822,1450 DATE_STRFTIME,1451 DATE_RAW,1452 DATE_UNIX1453} type;1454const char*strftime_fmt;1455int local;1456};14571458/*1459 * Convenience helper for passing a constant type, like:1460 *1461 * show_date(t, tz, DATE_MODE(NORMAL));1462 */1463#define DATE_MODE(t) date_mode_from_type(DATE_##t)1464struct date_mode *date_mode_from_type(enum date_mode_type type);14651466const char*show_date(unsigned long time,int timezone,const struct date_mode *mode);1467voidshow_date_relative(unsigned long time,int tz,const struct timeval *now,1468struct strbuf *timebuf);1469intparse_date(const char*date,struct strbuf *out);1470intparse_date_basic(const char*date,unsigned long*timestamp,int*offset);1471intparse_expiry_date(const char*date,unsigned long*timestamp);1472voiddatestamp(struct strbuf *out);1473#define approxidate(s) approxidate_careful((s), NULL)1474unsigned longapproxidate_careful(const char*,int*);1475unsigned longapproxidate_relative(const char*date,const struct timeval *now);1476voidparse_date_format(const char*format,struct date_mode *mode);1477intdate_overflows(unsigned long date);14781479#define IDENT_STRICT 11480#define IDENT_NO_DATE 21481#define IDENT_NO_NAME 41482externconst char*git_author_info(int);1483externconst char*git_committer_info(int);1484externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1485externconst char*fmt_name(const char*name,const char*email);1486externconst char*ident_default_name(void);1487externconst char*ident_default_email(void);1488externconst char*git_editor(void);1489externconst char*git_pager(int stdout_is_tty);1490externintgit_ident_config(const char*,const char*,void*);1491externvoidreset_ident_date(void);14921493struct ident_split {1494const char*name_begin;1495const char*name_end;1496const char*mail_begin;1497const char*mail_end;1498const char*date_begin;1499const char*date_end;1500const char*tz_begin;1501const char*tz_end;1502};1503/*1504 * Signals an success with 0, but time part of the result may be NULL1505 * if the input lacks timestamp and zone1506 */1507externintsplit_ident_line(struct ident_split *,const char*,int);15081509/*1510 * Like show_date, but pull the timestamp and tz parameters from1511 * the ident_split. It will also sanity-check the values and produce1512 * a well-known sentinel date if they appear bogus.1513 */1514const char*show_ident_date(const struct ident_split *id,1515const struct date_mode *mode);15161517/*1518 * Compare split idents for equality or strict ordering. Note that we1519 * compare only the ident part of the line, ignoring any timestamp.1520 *1521 * Because there are two fields, we must choose one as the primary key; we1522 * currently arbitrarily pick the email.1523 */1524externintident_cmp(const struct ident_split *,const struct ident_split *);15251526struct checkout {1527struct index_state *istate;1528const char*base_dir;1529int base_dir_len;1530unsigned force:1,1531 quiet:1,1532 not_new:1,1533 refresh_cache:1;1534};1535#define CHECKOUT_INIT { NULL,"" }15361537#define TEMPORARY_FILENAME_LENGTH 251538externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);15391540struct cache_def {1541struct strbuf path;1542int flags;1543int track_flags;1544int prefix_len_stat_func;1545};1546#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1547staticinlinevoidcache_def_clear(struct cache_def *cache)1548{1549strbuf_release(&cache->path);1550}15511552externinthas_symlink_leading_path(const char*name,int len);1553externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1554externintcheck_leading_path(const char*name,int len);1555externinthas_dirs_only_path(const char*name,int len,int prefix_len);1556externvoidschedule_dir_for_removal(const char*name,int len);1557externvoidremove_scheduled_dirs(void);15581559externstruct alternate_object_database {1560struct alternate_object_database *next;15611562/* see alt_scratch_buf() */1563struct strbuf scratch;1564size_t base_len;15651566char path[FLEX_ARRAY];1567} *alt_odb_list;1568externvoidprepare_alt_odb(void);1569externvoidread_info_alternates(const char* relative_base,int depth);1570externchar*compute_alternate_path(const char*path,struct strbuf *err);1571typedefintalt_odb_fn(struct alternate_object_database *,void*);1572externintforeach_alt_odb(alt_odb_fn,void*);15731574/*1575 * Allocate a "struct alternate_object_database" but do _not_ actually1576 * add it to the list of alternates.1577 */1578struct alternate_object_database *alloc_alt_odb(const char*dir);15791580/*1581 * Add the directory to the on-disk alternates file; the new entry will also1582 * take effect in the current process.1583 */1584externvoidadd_to_alternates_file(const char*dir);15851586/*1587 * Add the directory to the in-memory list of alternates (along with any1588 * recursive alternates it points to), but do not modify the on-disk alternates1589 * file.1590 */1591externvoidadd_to_alternates_memory(const char*dir);15921593/*1594 * Returns a scratch strbuf pre-filled with the alternate object directory,1595 * including a trailing slash, which can be used to access paths in the1596 * alternate. Always use this over direct access to alt->scratch, as it1597 * cleans up any previous use of the scratch buffer.1598 */1599externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);16001601struct pack_window {1602struct pack_window *next;1603unsigned char*base;1604 off_t offset;1605size_t len;1606unsigned int last_used;1607unsigned int inuse_cnt;1608};16091610externstruct packed_git {1611struct packed_git *next;1612struct pack_window *windows;1613 off_t pack_size;1614const void*index_data;1615size_t index_size;1616uint32_t num_objects;1617uint32_t num_bad_objects;1618unsigned char*bad_object_sha1;1619int index_version;1620time_t mtime;1621int pack_fd;1622unsigned pack_local:1,1623 pack_keep:1,1624 freshened:1,1625 do_not_close:1;1626unsigned char sha1[20];1627struct revindex_entry *revindex;1628/* something like ".git/objects/pack/xxxxx.pack" */1629char pack_name[FLEX_ARRAY];/* more */1630} *packed_git;16311632/*1633 * A most-recently-used ordered version of the packed_git list, which can1634 * be iterated instead of packed_git (and marked via mru_mark).1635 */1636struct mru;1637externstruct mru *packed_git_mru;16381639struct pack_entry {1640 off_t offset;1641unsigned char sha1[20];1642struct packed_git *p;1643};16441645externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path);16461647/* A hook to report invalid files in pack directory */1648#define PACKDIR_FILE_PACK 11649#define PACKDIR_FILE_IDX 21650#define PACKDIR_FILE_GARBAGE 41651externvoid(*report_garbage)(unsigned seen_bits,const char*path);16521653externvoidprepare_packed_git(void);1654externvoidreprepare_packed_git(void);1655externvoidinstall_packed_git(struct packed_git *pack);16561657/*1658 * Give a rough count of objects in the repository. This sacrifices accuracy1659 * for speed.1660 */1661unsigned longapproximate_object_count(void);16621663externstruct packed_git *find_sha1_pack(const unsigned char*sha1,1664struct packed_git *packs);16651666externvoidpack_report(void);16671668/*1669 * mmap the index file for the specified packfile (if it is not1670 * already mmapped). Return 0 on success.1671 */1672externintopen_pack_index(struct packed_git *);16731674/*1675 * munmap the index file for the specified packfile (if it is1676 * currently mmapped).1677 */1678externvoidclose_pack_index(struct packed_git *);16791680externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*);1681externvoidclose_pack_windows(struct packed_git *);1682externvoidclose_all_packs(void);1683externvoidunuse_pack(struct pack_window **);1684externvoidclear_delta_base_cache(void);1685externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local);16861687/*1688 * Make sure that a pointer access into an mmap'd index file is within bounds,1689 * and can provide at least 8 bytes of data.1690 *1691 * Note that this is only necessary for variable-length segments of the file1692 * (like the 64-bit extended offset table), as we compare the size to the1693 * fixed-length parts when we open the file.1694 */1695externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr);16961697/*1698 * Return the SHA-1 of the nth object within the specified packfile.1699 * Open the index if it is not already open. The return value points1700 * at the SHA-1 within the mmapped index. Return NULL if there is an1701 * error.1702 */1703externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n);1704/*1705 * Like nth_packed_object_sha1, but write the data into the object specified by1706 * the the first argument. Returns the first argument on success, and NULL on1707 * error.1708 */1709externconst struct object_id *nth_packed_object_oid(struct object_id *,struct packed_git *,uint32_t n);17101711/*1712 * Return the offset of the nth object within the specified packfile.1713 * The index must already be opened.1714 */1715extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n);17161717/*1718 * If the object named sha1 is present in the specified packfile,1719 * return its offset within the packfile; otherwise, return 0.1720 */1721extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *);17221723externintis_pack_valid(struct packed_git *);1724externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*);1725externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep);1726externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t);1727externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*);17281729/*1730 * Iterate over the files in the loose-object parts of the object1731 * directory "path", triggering the following callbacks:1732 *1733 * - loose_object is called for each loose object we find.1734 *1735 * - loose_cruft is called for any files that do not appear to be1736 * loose objects. Note that we only look in the loose object1737 * directories "objects/[0-9a-f]{2}/", so we will not report1738 * "objects/foobar" as cruft.1739 *1740 * - loose_subdir is called for each top-level hashed subdirectory1741 * of the object directory (e.g., "$OBJDIR/f0"). It is called1742 * after the objects in the directory are processed.1743 *1744 * Any callback that is NULL will be ignored. Callbacks returning non-zero1745 * will end the iteration.1746 *1747 * In the "buf" variant, "path" is a strbuf which will also be used as a1748 * scratch buffer, but restored to its original contents before1749 * the function returns.1750 */1751typedefinteach_loose_object_fn(const struct object_id *oid,1752const char*path,1753void*data);1754typedefinteach_loose_cruft_fn(const char*basename,1755const char*path,1756void*data);1757typedefinteach_loose_subdir_fn(int nr,1758const char*path,1759void*data);1760intfor_each_loose_file_in_objdir(const char*path,1761 each_loose_object_fn obj_cb,1762 each_loose_cruft_fn cruft_cb,1763 each_loose_subdir_fn subdir_cb,1764void*data);1765intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1766 each_loose_object_fn obj_cb,1767 each_loose_cruft_fn cruft_cb,1768 each_loose_subdir_fn subdir_cb,1769void*data);17701771/*1772 * Iterate over loose and packed objects in both the local1773 * repository and any alternates repositories (unless the1774 * LOCAL_ONLY flag is set).1775 */1776#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11777typedefinteach_packed_object_fn(const struct object_id *oid,1778struct packed_git *pack,1779uint32_t pos,1780void*data);1781externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);1782externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags);17831784struct object_info {1785/* Request */1786enum object_type *typep;1787unsigned long*sizep;1788 off_t *disk_sizep;1789unsigned char*delta_base_sha1;1790struct strbuf *typename;17911792/* Response */1793enum{1794 OI_CACHED,1795 OI_LOOSE,1796 OI_PACKED,1797 OI_DBCACHED1798} whence;1799union{1800/*1801 * struct {1802 * ... Nothing to expose in this case1803 * } cached;1804 * struct {1805 * ... Nothing to expose in this case1806 * } loose;1807 */1808struct{1809struct packed_git *pack;1810 off_t offset;1811unsigned int is_delta;1812} packed;1813} u;1814};18151816/*1817 * Initializer for a "struct object_info" that wants no items. You may1818 * also memset() the memory to all-zeroes.1819 */1820#define OBJECT_INFO_INIT {NULL}18211822externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);1823externintpacked_object_info(struct packed_git *pack, off_t offset,struct object_info *);18241825/* Dumb servers support */1826externintupdate_server_info(int);18271828/* git_config_parse_key() returns these negated: */1829#define CONFIG_INVALID_KEY 11830#define CONFIG_NO_SECTION_OR_NAME 21831/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */1832#define CONFIG_NO_LOCK -11833#define CONFIG_INVALID_FILE 31834#define CONFIG_NO_WRITE 41835#define CONFIG_NOTHING_SET 51836#define CONFIG_INVALID_PATTERN 61837#define CONFIG_GENERIC_ERROR 718381839#define CONFIG_REGEX_NONE ((void *)1)18401841struct git_config_source {1842unsigned int use_stdin:1;1843const char*file;1844const char*blob;1845};18461847enum config_origin_type {1848 CONFIG_ORIGIN_BLOB,1849 CONFIG_ORIGIN_FILE,1850 CONFIG_ORIGIN_STDIN,1851 CONFIG_ORIGIN_SUBMODULE_BLOB,1852 CONFIG_ORIGIN_CMDLINE1853};18541855typedefint(*config_fn_t)(const char*,const char*,void*);1856externintgit_default_config(const char*,const char*,void*);1857externintgit_config_from_file(config_fn_t fn,const char*,void*);1858externintgit_config_from_mem(config_fn_t fn,const enum config_origin_type,1859const char*name,const char*buf,size_t len,void*data);1860externintgit_config_from_blob_sha1(config_fn_t fn,const char*name,1861const unsigned char*sha1,void*data);1862externvoidgit_config_push_parameter(const char*text);1863externintgit_config_from_parameters(config_fn_t fn,void*data);1864externvoidread_early_config(config_fn_t cb,void*data);1865externvoidgit_config(config_fn_t fn,void*);1866externintgit_config_with_options(config_fn_t fn,void*,1867struct git_config_source *config_source,1868int respect_includes);1869externintgit_parse_ulong(const char*,unsigned long*);1870externintgit_parse_maybe_bool(const char*);1871externintgit_config_int(const char*,const char*);1872externint64_tgit_config_int64(const char*,const char*);1873externunsigned longgit_config_ulong(const char*,const char*);1874externintgit_config_bool_or_int(const char*,const char*,int*);1875externintgit_config_bool(const char*,const char*);1876externintgit_config_maybe_bool(const char*,const char*);1877externintgit_config_string(const char**,const char*,const char*);1878externintgit_config_pathname(const char**,const char*,const char*);1879externintgit_config_set_in_file_gently(const char*,const char*,const char*);1880externvoidgit_config_set_in_file(const char*,const char*,const char*);1881externintgit_config_set_gently(const char*,const char*);1882externvoidgit_config_set(const char*,const char*);1883externintgit_config_parse_key(const char*,char**,int*);1884externintgit_config_key_is_valid(const char*key);1885externintgit_config_set_multivar_gently(const char*,const char*,const char*,int);1886externvoidgit_config_set_multivar(const char*,const char*,const char*,int);1887externintgit_config_set_multivar_in_file_gently(const char*,const char*,const char*,const char*,int);1888externvoidgit_config_set_multivar_in_file(const char*,const char*,const char*,const char*,int);1889externintgit_config_rename_section(const char*,const char*);1890externintgit_config_rename_section_in_file(const char*,const char*,const char*);1891externconst char*git_etc_gitconfig(void);1892externintgit_env_bool(const char*,int);1893externunsigned longgit_env_ulong(const char*,unsigned long);1894externintgit_config_system(void);1895externintconfig_error_nonbool(const char*);1896#if defined(__GNUC__)1897#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1898#endif1899externconst char*get_log_output_encoding(void);1900externconst char*get_commit_output_encoding(void);19011902externintgit_config_parse_parameter(const char*, config_fn_t fn,void*data);19031904enum config_scope {1905 CONFIG_SCOPE_UNKNOWN =0,1906 CONFIG_SCOPE_SYSTEM,1907 CONFIG_SCOPE_GLOBAL,1908 CONFIG_SCOPE_REPO,1909 CONFIG_SCOPE_CMDLINE,1910};19111912externenum config_scope current_config_scope(void);1913externconst char*current_config_origin_type(void);1914externconst char*current_config_name(void);19151916struct config_include_data {1917int depth;1918 config_fn_t fn;1919void*data;1920};1921#define CONFIG_INCLUDE_INIT { 0 }1922externintgit_config_include(const char*name,const char*value,void*data);19231924/*1925 * Match and parse a config key of the form:1926 *1927 * section.(subsection.)?key1928 *1929 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1930 * we return -1 if it does not match, 0 otherwise. The subsection and key1931 * out-parameters are filled by the function (and *subsection is NULL if it is1932 * missing).1933 *1934 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if1935 * there is no subsection at all.1936 */1937externintparse_config_key(const char*var,1938const char*section,1939const char**subsection,int*subsection_len,1940const char**key);19411942struct config_set_element {1943struct hashmap_entry ent;1944char*key;1945struct string_list value_list;1946};19471948struct configset_list_item {1949struct config_set_element *e;1950int value_index;1951};19521953/*1954 * the contents of the list are ordered according to their1955 * position in the config files and order of parsing the files.1956 * (i.e. key-value pair at the last position of .git/config will1957 * be at the last item of the list)1958 */1959struct configset_list {1960struct configset_list_item *items;1961unsigned int nr, alloc;1962};19631964struct config_set {1965struct hashmap config_hash;1966int hash_initialized;1967struct configset_list list;1968};19691970externvoidgit_configset_init(struct config_set *cs);1971externintgit_configset_add_file(struct config_set *cs,const char*filename);1972externintgit_configset_get_value(struct config_set *cs,const char*key,const char**value);1973externconst struct string_list *git_configset_get_value_multi(struct config_set *cs,const char*key);1974externvoidgit_configset_clear(struct config_set *cs);1975externintgit_configset_get_string_const(struct config_set *cs,const char*key,const char**dest);1976externintgit_configset_get_string(struct config_set *cs,const char*key,char**dest);1977externintgit_configset_get_int(struct config_set *cs,const char*key,int*dest);1978externintgit_configset_get_ulong(struct config_set *cs,const char*key,unsigned long*dest);1979externintgit_configset_get_bool(struct config_set *cs,const char*key,int*dest);1980externintgit_configset_get_bool_or_int(struct config_set *cs,const char*key,int*is_bool,int*dest);1981externintgit_configset_get_maybe_bool(struct config_set *cs,const char*key,int*dest);1982externintgit_configset_get_pathname(struct config_set *cs,const char*key,const char**dest);19831984externintgit_config_get_value(const char*key,const char**value);1985externconst struct string_list *git_config_get_value_multi(const char*key);1986externvoidgit_config_clear(void);1987externvoidgit_config_iter(config_fn_t fn,void*data);1988externintgit_config_get_string_const(const char*key,const char**dest);1989externintgit_config_get_string(const char*key,char**dest);1990externintgit_config_get_int(const char*key,int*dest);1991externintgit_config_get_ulong(const char*key,unsigned long*dest);1992externintgit_config_get_bool(const char*key,int*dest);1993externintgit_config_get_bool_or_int(const char*key,int*is_bool,int*dest);1994externintgit_config_get_maybe_bool(const char*key,int*dest);1995externintgit_config_get_pathname(const char*key,const char**dest);1996externintgit_config_get_untracked_cache(void);1997externintgit_config_get_split_index(void);1998externintgit_config_get_max_percent_split_change(void);19992000/* This dies if the configured or default date is in the future */2001externintgit_config_get_expiry(const char*key,const char**output);20022003/*2004 * This is a hack for test programs like test-dump-untracked-cache to2005 * ensure that they do not modify the untracked cache when reading it.2006 * Do not use it otherwise!2007 */2008externint ignore_untracked_cache_config;20092010struct key_value_info {2011const char*filename;2012int linenr;2013enum config_origin_type origin_type;2014enum config_scope scope;2015};20162017extern NORETURN voidgit_die_config(const char*key,const char*err, ...)__attribute__((format(printf,2,3)));2018extern NORETURN voidgit_die_config_linenr(const char*key,const char*filename,int linenr);20192020externintcommitter_ident_sufficiently_given(void);2021externintauthor_ident_sufficiently_given(void);20222023externconst char*git_commit_encoding;2024externconst char*git_log_output_encoding;2025externconst char*git_mailmap_file;2026externconst char*git_mailmap_blob;20272028/* IO helper functions */2029externvoidmaybe_flush_or_die(FILE*,const char*);2030__attribute__((format(printf,2,3)))2031externvoidfprintf_or_die(FILE*,const char*fmt, ...);20322033#define COPY_READ_ERROR (-2)2034#define COPY_WRITE_ERROR (-3)2035externintcopy_fd(int ifd,int ofd);2036externintcopy_file(const char*dst,const char*src,int mode);2037externintcopy_file_with_time(const char*dst,const char*src,int mode);20382039externvoidwrite_or_die(int fd,const void*buf,size_t count);2040externvoidfsync_or_die(int fd,const char*);20412042extern ssize_t read_in_full(int fd,void*buf,size_t count);2043extern ssize_t write_in_full(int fd,const void*buf,size_t count);2044extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);20452046staticinline ssize_t write_str_in_full(int fd,const char*str)2047{2048returnwrite_in_full(fd, str,strlen(str));2049}20502051/**2052 * Open (and truncate) the file at path, write the contents of buf to it,2053 * and close it. Dies if any errors are encountered.2054 */2055externvoidwrite_file_buf(const char*path,const char*buf,size_t len);20562057/**2058 * Like write_file_buf(), but format the contents into a buffer first.2059 * Additionally, write_file() will append a newline if one is not already2060 * present, making it convenient to write text files:2061 *2062 * write_file(path, "counter: %d", ctr);2063 */2064__attribute__((format(printf,2,3)))2065externvoidwrite_file(const char*path,const char*fmt, ...);20662067/* pager.c */2068externvoidsetup_pager(void);2069externintpager_in_use(void);2070externint pager_use_color;2071externintterm_columns(void);2072externintdecimal_width(uintmax_t);2073externintcheck_pager_config(const char*cmd);2074externvoidprepare_pager_args(struct child_process *,const char*pager);20752076externconst char*editor_program;2077externconst char*askpass_program;2078externconst char*excludes_file;20792080/* base85 */2081intdecode_85(char*dst,const char*line,int linelen);2082voidencode_85(char*buf,const unsigned char*data,int bytes);20832084/* alloc.c */2085externvoid*alloc_blob_node(void);2086externvoid*alloc_tree_node(void);2087externvoid*alloc_commit_node(void);2088externvoid*alloc_tag_node(void);2089externvoid*alloc_object_node(void);2090externvoidalloc_report(void);2091externunsigned intalloc_commit_index(void);20922093/* pkt-line.c */2094voidpacket_trace_identity(const char*prog);20952096/* add */2097/*2098 * return 0 if success, 1 - if addition of a file failed and2099 * ADD_FILES_IGNORE_ERRORS was specified in flags2100 */2101intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);21022103/* diff.c */2104externint diff_auto_refresh_index;21052106/* match-trees.c */2107voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);2108voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);21092110/*2111 * whitespace rules.2112 * used by both diff and apply2113 * last two digits are tab width2114 */2115#define WS_BLANK_AT_EOL 01002116#define WS_SPACE_BEFORE_TAB 02002117#define WS_INDENT_WITH_NON_TAB 04002118#define WS_CR_AT_EOL 010002119#define WS_BLANK_AT_EOF 020002120#define WS_TAB_IN_INDENT 040002121#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)2122#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)2123#define WS_TAB_WIDTH_MASK 0772124externunsigned whitespace_rule_cfg;2125externunsignedwhitespace_rule(const char*);2126externunsignedparse_whitespace_rule(const char*);2127externunsignedws_check(const char*line,int len,unsigned ws_rule);2128externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);2129externchar*whitespace_error_string(unsigned ws);2130externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);2131externintws_blank_line(const char*line,int len,unsigned ws_rule);2132#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)21332134/* ls-files */2135voidoverlay_tree_on_cache(const char*tree_name,const char*prefix);21362137char*alias_lookup(const char*alias);2138intsplit_cmdline(char*cmdline,const char***argv);2139/* Takes a negative value returned by split_cmdline */2140const char*split_cmdline_strerror(int cmdline_errno);21412142/* setup.c */2143struct startup_info {2144int have_repository;2145const char*prefix;2146};2147externstruct startup_info *startup_info;21482149/* merge.c */2150struct commit_list;2151inttry_merge_command(const char*strategy,size_t xopts_nr,2152const char**xopts,struct commit_list *common,2153const char*head_arg,struct commit_list *remotes);2154intcheckout_fast_forward(const unsigned char*from,2155const unsigned char*to,2156int overwrite_ignore);215721582159intsane_execvp(const char*file,char*const argv[]);21602161/*2162 * A struct to encapsulate the concept of whether a file has changed2163 * since we last checked it. This uses criteria similar to those used2164 * for the index.2165 */2166struct stat_validity {2167struct stat_data *sd;2168};21692170voidstat_validity_clear(struct stat_validity *sv);21712172/*2173 * Returns 1 if the path is a regular file (or a symlink to a regular2174 * file) and matches the saved stat_validity, 0 otherwise. A missing2175 * or inaccessible file is considered a match if the struct was just2176 * initialized, or if the previous update found an inaccessible file.2177 */2178intstat_validity_check(struct stat_validity *sv,const char*path);21792180/*2181 * Update the stat_validity from a file opened at descriptor fd. If2182 * the file is missing, inaccessible, or not a regular file, then2183 * future calls to stat_validity_check will match iff one of those2184 * conditions continues to be true.2185 */2186voidstat_validity_update(struct stat_validity *sv,int fd);21872188intversioncmp(const char*s1,const char*s2);2189voidsleep_millisec(int millisec);21902191/*2192 * Create a directory and (if share is nonzero) adjust its permissions2193 * according to the shared_repository setting. Only use this for2194 * directories under $GIT_DIR. Don't use it for working tree2195 * directories.2196 */2197voidsafe_create_dir(const char*dir,int share);21982199#endif/* CACHE_H */