1#ifndef CACHE_H 2#define CACHE_H 3 4#include"git-compat-util.h" 5#include"strbuf.h" 6#include"hashmap.h" 7#include"advice.h" 8#include"gettext.h" 9#include"convert.h" 10#include"trace.h" 11#include"string-list.h" 12#include"pack-revindex.h" 13 14#include SHA1_HEADER 15#ifndef platform_SHA_CTX 16/* 17 * platform's underlying implementation of SHA-1; could be OpenSSL, 18 * blk_SHA, Apple CommonCrypto, etc... Note that including 19 * SHA1_HEADER may have already defined platform_SHA_CTX for our 20 * own implementations like block-sha1 and ppc-sha1, so we list 21 * the default for OpenSSL compatible SHA-1 implementations here. 22 */ 23#define platform_SHA_CTX SHA_CTX 24#define platform_SHA1_Init SHA1_Init 25#define platform_SHA1_Update SHA1_Update 26#define platform_SHA1_Final SHA1_Final 27#endif 28 29#define git_SHA_CTX platform_SHA_CTX 30#define git_SHA1_Init platform_SHA1_Init 31#define git_SHA1_Update platform_SHA1_Update 32#define git_SHA1_Final platform_SHA1_Final 33 34#ifdef SHA1_MAX_BLOCK_SIZE 35#include"compat/sha1-chunked.h" 36#undef git_SHA1_Update 37#define git_SHA1_Update git_SHA1_Update_Chunked 38#endif 39 40#include <zlib.h> 41typedefstruct git_zstream { 42 z_stream z; 43unsigned long avail_in; 44unsigned long avail_out; 45unsigned long total_in; 46unsigned long total_out; 47unsigned char*next_in; 48unsigned char*next_out; 49} git_zstream; 50 51voidgit_inflate_init(git_zstream *); 52voidgit_inflate_init_gzip_only(git_zstream *); 53voidgit_inflate_end(git_zstream *); 54intgit_inflate(git_zstream *,int flush); 55 56voidgit_deflate_init(git_zstream *,int level); 57voidgit_deflate_init_gzip(git_zstream *,int level); 58voidgit_deflate_init_raw(git_zstream *,int level); 59voidgit_deflate_end(git_zstream *); 60intgit_deflate_abort(git_zstream *); 61intgit_deflate_end_gently(git_zstream *); 62intgit_deflate(git_zstream *,int flush); 63unsigned longgit_deflate_bound(git_zstream *,unsigned long); 64 65/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 66#define GIT_SHA1_RAWSZ 20 67#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 68 69struct object_id { 70unsigned char hash[GIT_SHA1_RAWSZ]; 71}; 72 73#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 74#define DTYPE(de) ((de)->d_type) 75#else 76#undef DT_UNKNOWN 77#undef DT_DIR 78#undef DT_REG 79#undef DT_LNK 80#define DT_UNKNOWN 0 81#define DT_DIR 1 82#define DT_REG 2 83#define DT_LNK 3 84#define DTYPE(de) DT_UNKNOWN 85#endif 86 87/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 88#define S_IFINVALID 0030000 89 90/* 91 * A "directory link" is a link to another git directory. 92 * 93 * The value 0160000 is not normally a valid mode, and 94 * also just happens to be S_IFDIR + S_IFLNK 95 */ 96#define S_IFGITLINK 0160000 97#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 98 99/* 100 * Some mode bits are also used internally for computations. 101 * 102 * They *must* not overlap with any valid modes, and they *must* not be emitted 103 * to outside world - i.e. appear on disk or network. In other words, it's just 104 * temporary fields, which we internally use, but they have to stay in-house. 105 * 106 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 107 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 108 */ 109 110/* used internally in tree-diff */ 111#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 112 113 114/* 115 * Intensive research over the course of many years has shown that 116 * port 9418 is totally unused by anything else. Or 117 * 118 * Your search - "port 9418" - did not match any documents. 119 * 120 * as www.google.com puts it. 121 * 122 * This port has been properly assigned for git use by IANA: 123 * git (Assigned-9418) [I06-050728-0001]. 124 * 125 * git 9418/tcp git pack transfer service 126 * git 9418/udp git pack transfer service 127 * 128 * with Linus Torvalds <torvalds@osdl.org> as the point of 129 * contact. September 2005. 130 * 131 * See http://www.iana.org/assignments/port-numbers 132 */ 133#define DEFAULT_GIT_PORT 9418 134 135/* 136 * Basic data structures for the directory cache 137 */ 138 139#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 140struct cache_header { 141uint32_t hdr_signature; 142uint32_t hdr_version; 143uint32_t hdr_entries; 144}; 145 146#define INDEX_FORMAT_LB 2 147#define INDEX_FORMAT_UB 4 148 149/* 150 * The "cache_time" is just the low 32 bits of the 151 * time. It doesn't matter if it overflows - we only 152 * check it for equality in the 32 bits we save. 153 */ 154struct cache_time { 155uint32_t sec; 156uint32_t nsec; 157}; 158 159struct stat_data { 160struct cache_time sd_ctime; 161struct cache_time sd_mtime; 162unsigned int sd_dev; 163unsigned int sd_ino; 164unsigned int sd_uid; 165unsigned int sd_gid; 166unsigned int sd_size; 167}; 168 169struct cache_entry { 170struct hashmap_entry ent; 171struct stat_data ce_stat_data; 172unsigned int ce_mode; 173unsigned int ce_flags; 174unsigned int ce_namelen; 175unsigned int index;/* for link extension */ 176struct object_id oid; 177char name[FLEX_ARRAY];/* more */ 178}; 179 180#define CE_STAGEMASK (0x3000) 181#define CE_EXTENDED (0x4000) 182#define CE_VALID (0x8000) 183#define CE_STAGESHIFT 12 184 185/* 186 * Range 0xFFFF0FFF in ce_flags is divided into 187 * two parts: in-memory flags and on-disk ones. 188 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 189 * if you want to save a new flag, add it in 190 * CE_EXTENDED_FLAGS 191 * 192 * In-memory only flags 193 */ 194#define CE_UPDATE (1 << 16) 195#define CE_REMOVE (1 << 17) 196#define CE_UPTODATE (1 << 18) 197#define CE_ADDED (1 << 19) 198 199#define CE_HASHED (1 << 20) 200#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 201#define CE_CONFLICTED (1 << 23) 202 203#define CE_UNPACKED (1 << 24) 204#define CE_NEW_SKIP_WORKTREE (1 << 25) 205 206/* used to temporarily mark paths matched by pathspecs */ 207#define CE_MATCHED (1 << 26) 208 209#define CE_UPDATE_IN_BASE (1 << 27) 210#define CE_STRIP_NAME (1 << 28) 211 212/* 213 * Extended on-disk flags 214 */ 215#define CE_INTENT_TO_ADD (1 << 29) 216#define CE_SKIP_WORKTREE (1 << 30) 217/* CE_EXTENDED2 is for future extension */ 218#define CE_EXTENDED2 (1U << 31) 219 220#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 221 222/* 223 * Safeguard to avoid saving wrong flags: 224 * - CE_EXTENDED2 won't get saved until its semantic is known 225 * - Bits in 0x0000FFFF have been saved in ce_flags already 226 * - Bits in 0x003F0000 are currently in-memory flags 227 */ 228#if CE_EXTENDED_FLAGS & 0x803FFFFF 229#error"CE_EXTENDED_FLAGS out of range" 230#endif 231 232/* Forward structure decls */ 233struct pathspec; 234struct child_process; 235 236/* 237 * Copy the sha1 and stat state of a cache entry from one to 238 * another. But we never change the name, or the hash state! 239 */ 240staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 241const struct cache_entry *src) 242{ 243unsigned int state = dst->ce_flags & CE_HASHED; 244 245/* Don't copy hash chain and name */ 246memcpy(&dst->ce_stat_data, &src->ce_stat_data, 247offsetof(struct cache_entry, name) - 248offsetof(struct cache_entry, ce_stat_data)); 249 250/* Restore the hash state */ 251 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 252} 253 254staticinlineunsignedcreate_ce_flags(unsigned stage) 255{ 256return(stage << CE_STAGESHIFT); 257} 258 259#define ce_namelen(ce) ((ce)->ce_namelen) 260#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 261#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 262#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 263#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 264#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 265#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 266 267#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 268staticinlineunsigned intcreate_ce_mode(unsigned int mode) 269{ 270if(S_ISLNK(mode)) 271return S_IFLNK; 272if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 273return S_IFGITLINK; 274return S_IFREG |ce_permissions(mode); 275} 276staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 277unsigned int mode) 278{ 279externint trust_executable_bit, has_symlinks; 280if(!has_symlinks &&S_ISREG(mode) && 281 ce &&S_ISLNK(ce->ce_mode)) 282return ce->ce_mode; 283if(!trust_executable_bit &&S_ISREG(mode)) { 284if(ce &&S_ISREG(ce->ce_mode)) 285return ce->ce_mode; 286returncreate_ce_mode(0666); 287} 288returncreate_ce_mode(mode); 289} 290staticinlineintce_to_dtype(const struct cache_entry *ce) 291{ 292unsigned ce_mode =ntohl(ce->ce_mode); 293if(S_ISREG(ce_mode)) 294return DT_REG; 295else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 296return DT_DIR; 297else if(S_ISLNK(ce_mode)) 298return DT_LNK; 299else 300return DT_UNKNOWN; 301} 302staticinlineunsigned intcanon_mode(unsigned int mode) 303{ 304if(S_ISREG(mode)) 305return S_IFREG |ce_permissions(mode); 306if(S_ISLNK(mode)) 307return S_IFLNK; 308if(S_ISDIR(mode)) 309return S_IFDIR; 310return S_IFGITLINK; 311} 312 313#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 314 315#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 316#define CE_ENTRY_CHANGED (1 << 1) 317#define CE_ENTRY_REMOVED (1 << 2) 318#define CE_ENTRY_ADDED (1 << 3) 319#define RESOLVE_UNDO_CHANGED (1 << 4) 320#define CACHE_TREE_CHANGED (1 << 5) 321#define SPLIT_INDEX_ORDERED (1 << 6) 322#define UNTRACKED_CHANGED (1 << 7) 323 324struct split_index; 325struct untracked_cache; 326 327struct index_state { 328struct cache_entry **cache; 329unsigned int version; 330unsigned int cache_nr, cache_alloc, cache_changed; 331struct string_list *resolve_undo; 332struct cache_tree *cache_tree; 333struct split_index *split_index; 334struct cache_time timestamp; 335unsigned name_hash_initialized :1, 336 initialized :1; 337struct hashmap name_hash; 338struct hashmap dir_hash; 339unsigned char sha1[20]; 340struct untracked_cache *untracked; 341}; 342 343externstruct index_state the_index; 344 345/* Name hashing */ 346externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 347externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 348externvoidfree_name_hash(struct index_state *istate); 349 350 351#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 352#define active_cache (the_index.cache) 353#define active_nr (the_index.cache_nr) 354#define active_alloc (the_index.cache_alloc) 355#define active_cache_changed (the_index.cache_changed) 356#define active_cache_tree (the_index.cache_tree) 357 358#define read_cache() read_index(&the_index) 359#define read_cache_from(path) read_index_from(&the_index, (path)) 360#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 361#define is_cache_unborn() is_index_unborn(&the_index) 362#define read_cache_unmerged() read_index_unmerged(&the_index) 363#define discard_cache() discard_index(&the_index) 364#define unmerged_cache() unmerged_index(&the_index) 365#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 366#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 367#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 368#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 369#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 370#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 371#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 372#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 373#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 374#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 375#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 376#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 377#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 378#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 379#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 380#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 381#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 382#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 383#endif 384 385enum object_type { 386 OBJ_BAD = -1, 387 OBJ_NONE =0, 388 OBJ_COMMIT =1, 389 OBJ_TREE =2, 390 OBJ_BLOB =3, 391 OBJ_TAG =4, 392/* 5 for future expansion */ 393 OBJ_OFS_DELTA =6, 394 OBJ_REF_DELTA =7, 395 OBJ_ANY, 396 OBJ_MAX 397}; 398 399staticinlineenum object_type object_type(unsigned int mode) 400{ 401returnS_ISDIR(mode) ? OBJ_TREE : 402S_ISGITLINK(mode) ? OBJ_COMMIT : 403 OBJ_BLOB; 404} 405 406/* Double-check local_repo_env below if you add to this list. */ 407#define GIT_DIR_ENVIRONMENT"GIT_DIR" 408#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 409#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 410#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 411#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 412#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 413#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 414#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 415#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 416#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 417#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 418#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 419#define CONFIG_ENVIRONMENT"GIT_CONFIG" 420#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 421#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 422#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 423#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 424#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 425#define GITATTRIBUTES_FILE".gitattributes" 426#define INFOATTRIBUTES_FILE"info/attributes" 427#define ATTRIBUTE_MACRO_PREFIX"[attr]" 428#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 429#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 430#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 431#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 432#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 433#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 434#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 435#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 436#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 437#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 438 439/* 440 * This environment variable is expected to contain a boolean indicating 441 * whether we should or should not treat: 442 * 443 * GIT_DIR=foo.git git ... 444 * 445 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 446 * of this, but we use it internally to communicate to sub-processes that we 447 * are in a bare repo. If not set, defaults to true. 448 */ 449#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 450 451/* 452 * Repository-local GIT_* environment variables; these will be cleared 453 * when git spawns a sub-process that runs inside another repository. 454 * The array is NULL-terminated, which makes it easy to pass in the "env" 455 * parameter of a run-command invocation, or to do a simple walk. 456 */ 457externconst char*const local_repo_env[]; 458 459/* 460 * Returns true iff we have a configured git repository (either via 461 * setup_git_directory, or in the environment via $GIT_DIR). 462 */ 463inthave_git_dir(void); 464 465externint is_bare_repository_cfg; 466externintis_bare_repository(void); 467externintis_inside_git_dir(void); 468externchar*git_work_tree_cfg; 469externintis_inside_work_tree(void); 470externconst char*get_git_dir(void); 471externconst char*get_git_common_dir(void); 472externchar*get_object_directory(void); 473externchar*get_index_file(void); 474externchar*get_graft_file(void); 475externintset_git_dir(const char*path); 476externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 477externintget_common_dir(struct strbuf *sb,const char*gitdir); 478externconst char*get_git_namespace(void); 479externconst char*strip_namespace(const char*namespaced_ref); 480externconst char*get_super_prefix(void); 481externconst char*get_git_work_tree(void); 482 483/* 484 * Return true if the given path is a git directory; note that this _just_ 485 * looks at the directory itself. If you want to know whether "foo/.git" 486 * is a repository, you must feed that path, not just "foo". 487 */ 488externintis_git_directory(const char*path); 489 490/* 491 * Return 1 if the given path is the root of a git repository or 492 * submodule, else 0. Will not return 1 for bare repositories with the 493 * exception of creating a bare repository in "foo/.git" and calling 494 * is_git_repository("foo"). 495 * 496 * If we run into read errors, we err on the side of saying "yes, it is", 497 * as we usually consider sub-repos precious, and would prefer to err on the 498 * side of not disrupting or deleting them. 499 */ 500externintis_nonbare_repository_dir(struct strbuf *path); 501 502#define READ_GITFILE_ERR_STAT_FAILED 1 503#define READ_GITFILE_ERR_NOT_A_FILE 2 504#define READ_GITFILE_ERR_OPEN_FAILED 3 505#define READ_GITFILE_ERR_READ_FAILED 4 506#define READ_GITFILE_ERR_INVALID_FORMAT 5 507#define READ_GITFILE_ERR_NO_PATH 6 508#define READ_GITFILE_ERR_NOT_A_REPO 7 509#define READ_GITFILE_ERR_TOO_LARGE 8 510externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 511externconst char*read_gitfile_gently(const char*path,int*return_error_code); 512#define read_gitfile(path) read_gitfile_gently((path), NULL) 513externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 514#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 515 516externvoidset_git_work_tree(const char*tree); 517 518#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 519 520externvoidsetup_work_tree(void); 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); 532externconst char*prefix_filename(const char*prefix,int len,const char*path); 533externintcheck_filename(const char*prefix,const char*name); 534externvoidverify_filename(const char*prefix, 535const char*name, 536int diagnose_misspelt_rev); 537externvoidverify_non_filename(const char*prefix,const char*name); 538externintpath_inside_repo(const char*prefix,const char*path); 539 540#define INIT_DB_QUIET 0x0001 541#define INIT_DB_EXIST_OK 0x0002 542 543externintinit_db(const char*git_dir,const char*real_git_dir, 544const char*template_dir,unsigned int flags); 545 546externvoidsanitize_stdfds(void); 547externintdaemonize(void); 548 549#define alloc_nr(x) (((x)+16)*3/2) 550 551/* 552 * Realloc the buffer pointed at by variable 'x' so that it can hold 553 * at least 'nr' entries; the number of entries currently allocated 554 * is 'alloc', using the standard growing factor alloc_nr() macro. 555 * 556 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 557 */ 558#define ALLOC_GROW(x, nr, alloc) \ 559 do { \ 560 if ((nr) > alloc) { \ 561 if (alloc_nr(alloc) < (nr)) \ 562 alloc = (nr); \ 563 else \ 564 alloc = alloc_nr(alloc); \ 565 REALLOC_ARRAY(x, alloc); \ 566 } \ 567 } while (0) 568 569/* Initialize and use the cache information */ 570struct lock_file; 571externintread_index(struct index_state *); 572externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 573externintdo_read_index(struct index_state *istate,const char*path, 574int must_exist);/* for testting only! */ 575externintread_index_from(struct index_state *,const char*path); 576externintis_index_unborn(struct index_state *); 577externintread_index_unmerged(struct index_state *); 578#define COMMIT_LOCK (1 << 0) 579#define CLOSE_LOCK (1 << 1) 580externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 581externintdiscard_index(struct index_state *); 582externintunmerged_index(const struct index_state *); 583externintverify_path(const char*path); 584externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 585externvoidadjust_dirname_case(struct index_state *istate,char*name); 586externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 587 588/* 589 * Searches for an entry defined by name and namelen in the given index. 590 * If the return value is positive (including 0) it is the position of an 591 * exact match. If the return value is negative, the negated value minus 1 592 * is the position where the entry would be inserted. 593 * Example: The current index consists of these files and its stages: 594 * 595 * b#0, d#0, f#1, f#3 596 * 597 * index_name_pos(&index, "a", 1) -> -1 598 * index_name_pos(&index, "b", 1) -> 0 599 * index_name_pos(&index, "c", 1) -> -2 600 * index_name_pos(&index, "d", 1) -> 1 601 * index_name_pos(&index, "e", 1) -> -3 602 * index_name_pos(&index, "f", 1) -> -3 603 * index_name_pos(&index, "g", 1) -> -5 604 */ 605externintindex_name_pos(const struct index_state *,const char*name,int namelen); 606 607#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 608#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 609#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 610#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 611#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 612#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 613externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 614externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 615 616/* Remove entry, return true if there are more entries to go. */ 617externintremove_index_entry_at(struct index_state *,int pos); 618 619externvoidremove_marked_cache_entries(struct index_state *istate); 620externintremove_file_from_index(struct index_state *,const char*path); 621#define ADD_CACHE_VERBOSE 1 622#define ADD_CACHE_PRETEND 2 623#define ADD_CACHE_IGNORE_ERRORS 4 624#define ADD_CACHE_IGNORE_REMOVAL 8 625#define ADD_CACHE_INTENT 16 626/* 627 * These two are used to add the contents of the file at path 628 * to the index, marking the working tree up-to-date by storing 629 * the cached stat info in the resulting cache entry. A caller 630 * that has already run lstat(2) on the path can call 631 * add_to_index(), and all others can call add_file_to_index(); 632 * the latter will do necessary lstat(2) internally before 633 * calling the former. 634 */ 635externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 636externintadd_file_to_index(struct index_state *,const char*path,int flags); 637 638externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 639externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 640externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 641externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 642externintindex_name_is_other(const struct index_state *,const char*,int); 643externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 644 645/* do stat comparison even if CE_VALID is true */ 646#define CE_MATCH_IGNORE_VALID 01 647/* do not check the contents but report dirty on racily-clean entries */ 648#define CE_MATCH_RACY_IS_DIRTY 02 649/* do stat comparison even if CE_SKIP_WORKTREE is true */ 650#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 651/* ignore non-existent files during stat update */ 652#define CE_MATCH_IGNORE_MISSING 0x08 653/* enable stat refresh */ 654#define CE_MATCH_REFRESH 0x10 655externintie_match_stat(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 656externintie_modified(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 657 658#define HASH_WRITE_OBJECT 1 659#define HASH_FORMAT_CHECK 2 660externintindex_fd(unsigned char*sha1,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 661externintindex_path(unsigned char*sha1,const char*path,struct stat *st,unsigned flags); 662 663/* 664 * Record to sd the data from st that we use to check whether a file 665 * might have changed. 666 */ 667externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 668 669/* 670 * Return 0 if st is consistent with a file not having been changed 671 * since sd was filled. If there are differences, return a 672 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 673 * INODE_CHANGED, and DATA_CHANGED. 674 */ 675externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 676externintmatch_stat_data_racy(const struct index_state *istate, 677const struct stat_data *sd,struct stat *st); 678 679externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 680 681#define REFRESH_REALLY 0x0001/* ignore_valid */ 682#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 683#define REFRESH_QUIET 0x0004/* be quiet about it */ 684#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 685#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 686#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 687externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 688externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 689 690externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 691 692externinthold_locked_index(struct lock_file *,int); 693externvoidset_alternate_index_output(const char*); 694 695/* Environment bits from configuration mechanism */ 696externint trust_executable_bit; 697externint trust_ctime; 698externint check_stat; 699externint quote_path_fully; 700externint has_symlinks; 701externint minimum_abbrev, default_abbrev; 702externint ignore_case; 703externint assume_unchanged; 704externint prefer_symlink_refs; 705externint warn_ambiguous_refs; 706externint warn_on_object_refname_ambiguity; 707externconst char*apply_default_whitespace; 708externconst char*apply_default_ignorewhitespace; 709externconst char*git_attributes_file; 710externconst char*git_hooks_path; 711externint zlib_compression_level; 712externint core_compression_level; 713externint pack_compression_level; 714externsize_t packed_git_window_size; 715externsize_t packed_git_limit; 716externsize_t delta_base_cache_limit; 717externunsigned long big_file_threshold; 718externunsigned long pack_size_limit_cfg; 719 720/* 721 * Accessors for the core.sharedrepository config which lazy-load the value 722 * from the config (if not already set). The "reset" function can be 723 * used to unset "set" or cached value, meaning that the value will be loaded 724 * fresh from the config file on the next call to get_shared_repository(). 725 */ 726voidset_shared_repository(int value); 727intget_shared_repository(void); 728voidreset_shared_repository(void); 729 730/* 731 * Do replace refs need to be checked this run? This variable is 732 * initialized to true unless --no-replace-object is used or 733 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 734 * commands that do not want replace references to be active. As an 735 * optimization it is also set to false if replace references have 736 * been sought but there were none. 737 */ 738externint check_replace_refs; 739externchar*git_replace_ref_base; 740 741externint fsync_object_files; 742externint core_preload_index; 743externint core_apply_sparse_checkout; 744externint precomposed_unicode; 745externint protect_hfs; 746externint protect_ntfs; 747externint git_db_env, git_index_env, git_graft_env, git_common_dir_env; 748 749/* 750 * Include broken refs in all ref iterations, which will 751 * generally choke dangerous operations rather than letting 752 * them silently proceed without taking the broken ref into 753 * account. 754 */ 755externint ref_paranoia; 756 757/* 758 * The character that begins a commented line in user-editable file 759 * that is subject to stripspace. 760 */ 761externchar comment_line_char; 762externint auto_comment_line_char; 763 764/* Windows only */ 765enum hide_dotfiles_type { 766 HIDE_DOTFILES_FALSE =0, 767 HIDE_DOTFILES_TRUE, 768 HIDE_DOTFILES_DOTGITONLY 769}; 770externenum hide_dotfiles_type hide_dotfiles; 771 772enum log_refs_config { 773 LOG_REFS_UNSET = -1, 774 LOG_REFS_NONE =0, 775 LOG_REFS_NORMAL, 776 LOG_REFS_ALWAYS 777}; 778externenum log_refs_config log_all_ref_updates; 779 780enum branch_track { 781 BRANCH_TRACK_UNSPECIFIED = -1, 782 BRANCH_TRACK_NEVER =0, 783 BRANCH_TRACK_REMOTE, 784 BRANCH_TRACK_ALWAYS, 785 BRANCH_TRACK_EXPLICIT, 786 BRANCH_TRACK_OVERRIDE 787}; 788 789enum rebase_setup_type { 790 AUTOREBASE_NEVER =0, 791 AUTOREBASE_LOCAL, 792 AUTOREBASE_REMOTE, 793 AUTOREBASE_ALWAYS 794}; 795 796enum push_default_type { 797 PUSH_DEFAULT_NOTHING =0, 798 PUSH_DEFAULT_MATCHING, 799 PUSH_DEFAULT_SIMPLE, 800 PUSH_DEFAULT_UPSTREAM, 801 PUSH_DEFAULT_CURRENT, 802 PUSH_DEFAULT_UNSPECIFIED 803}; 804 805externenum branch_track git_branch_track; 806externenum rebase_setup_type autorebase; 807externenum push_default_type push_default; 808 809enum object_creation_mode { 810 OBJECT_CREATION_USES_HARDLINKS =0, 811 OBJECT_CREATION_USES_RENAMES =1 812}; 813 814externenum object_creation_mode object_creation_mode; 815 816externchar*notes_ref_name; 817 818externint grafts_replace_parents; 819 820/* 821 * GIT_REPO_VERSION is the version we write by default. The 822 * _READ variant is the highest number we know how to 823 * handle. 824 */ 825#define GIT_REPO_VERSION 0 826#define GIT_REPO_VERSION_READ 1 827externint repository_format_precious_objects; 828 829struct repository_format { 830int version; 831int precious_objects; 832int is_bare; 833char*work_tree; 834struct string_list unknown_extensions; 835}; 836 837/* 838 * Read the repository format characteristics from the config file "path" into 839 * "format" struct. Returns the numeric version. On error, -1 is returned, 840 * format->version is set to -1, and all other fields in the struct are 841 * undefined. 842 */ 843intread_repository_format(struct repository_format *format,const char*path); 844 845/* 846 * Verify that the repository described by repository_format is something we 847 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 848 * any errors encountered. 849 */ 850intverify_repository_format(const struct repository_format *format, 851struct strbuf *err); 852 853/* 854 * Check the repository format version in the path found in get_git_dir(), 855 * and die if it is a version we don't understand. Generally one would 856 * set_git_dir() before calling this, and use it only for "are we in a valid 857 * repo?". 858 */ 859externvoidcheck_repository_format(void); 860 861#define MTIME_CHANGED 0x0001 862#define CTIME_CHANGED 0x0002 863#define OWNER_CHANGED 0x0004 864#define MODE_CHANGED 0x0008 865#define INODE_CHANGED 0x0010 866#define DATA_CHANGED 0x0020 867#define TYPE_CHANGED 0x0040 868 869/* 870 * Return a statically allocated filename, either generically (mkpath), in 871 * the repository directory (git_path), or in a submodule's repository 872 * directory (git_path_submodule). In all cases, note that the result 873 * may be overwritten by another call to _any_ of the functions. Consider 874 * using the safer "dup" or "strbuf" formats below (in some cases, the 875 * unsafe versions have already been removed). 876 */ 877externconst char*mkpath(const char*fmt, ...)__attribute__((format(printf,1,2))); 878externconst char*git_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 879externconst char*git_common_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 880 881externchar*mksnpath(char*buf,size_t n,const char*fmt, ...) 882__attribute__((format(printf,3,4))); 883externvoidstrbuf_git_path(struct strbuf *sb,const char*fmt, ...) 884__attribute__((format(printf,2,3))); 885externvoidstrbuf_git_common_path(struct strbuf *sb,const char*fmt, ...) 886__attribute__((format(printf,2,3))); 887externchar*git_path_buf(struct strbuf *buf,const char*fmt, ...) 888__attribute__((format(printf,2,3))); 889externintstrbuf_git_path_submodule(struct strbuf *sb,const char*path, 890const char*fmt, ...) 891__attribute__((format(printf,3,4))); 892externchar*git_pathdup(const char*fmt, ...) 893__attribute__((format(printf,1,2))); 894externchar*mkpathdup(const char*fmt, ...) 895__attribute__((format(printf,1,2))); 896externchar*git_pathdup_submodule(const char*path,const char*fmt, ...) 897__attribute__((format(printf,2,3))); 898 899externvoidreport_linked_checkout_garbage(void); 900 901/* 902 * You can define a static memoized git path like: 903 * 904 * static GIT_PATH_FUNC(git_path_foo, "FOO"); 905 * 906 * or use one of the global ones below. 907 */ 908#define GIT_PATH_FUNC(func, filename) \ 909 const char *func(void) \ 910 { \ 911 static char *ret; \ 912 if (!ret) \ 913 ret = git_pathdup(filename); \ 914 return ret; \ 915 } 916 917const char*git_path_cherry_pick_head(void); 918const char*git_path_revert_head(void); 919const char*git_path_squash_msg(void); 920const char*git_path_merge_msg(void); 921const char*git_path_merge_rr(void); 922const char*git_path_merge_mode(void); 923const char*git_path_merge_head(void); 924const char*git_path_fetch_head(void); 925const char*git_path_shallow(void); 926 927/* 928 * Return the name of the file in the local object database that would 929 * be used to store a loose object with the specified sha1. The 930 * return value is a pointer to a statically allocated buffer that is 931 * overwritten each time the function is called. 932 */ 933externconst char*sha1_file_name(const unsigned char*sha1); 934 935/* 936 * Return the name of the (local) packfile with the specified sha1 in 937 * its name. The return value is a pointer to memory that is 938 * overwritten each time this function is called. 939 */ 940externchar*sha1_pack_name(const unsigned char*sha1); 941 942/* 943 * Return the name of the (local) pack index file with the specified 944 * sha1 in its name. The return value is a pointer to memory that is 945 * overwritten each time this function is called. 946 */ 947externchar*sha1_pack_index_name(const unsigned char*sha1); 948 949/* 950 * Return an abbreviated sha1 unique within this repository's object database. 951 * The result will be at least `len` characters long, and will be NUL 952 * terminated. 953 * 954 * The non-`_r` version returns a static buffer which remains valid until 4 955 * more calls to find_unique_abbrev are made. 956 * 957 * The `_r` variant writes to a buffer supplied by the caller, which must be at 958 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 959 * written (excluding the NUL terminator). 960 * 961 * Note that while this version avoids the static buffer, it is not fully 962 * reentrant, as it calls into other non-reentrant git code. 963 */ 964externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 965externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 966 967externconst unsigned char null_sha1[GIT_SHA1_RAWSZ]; 968externconst struct object_id null_oid; 969 970staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 971{ 972int i; 973 974for(i =0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 975if(*sha1 != *sha2) 976return*sha1 - *sha2; 977} 978 979return0; 980} 981 982staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 983{ 984returnhashcmp(oid1->hash, oid2->hash); 985} 986 987staticinlineintis_null_sha1(const unsigned char*sha1) 988{ 989return!hashcmp(sha1, null_sha1); 990} 991 992staticinlineintis_null_oid(const struct object_id *oid) 993{ 994return!hashcmp(oid->hash, null_sha1); 995} 996 997staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src) 998{ 999memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);1000}10011002staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src)1003{1004hashcpy(dst->hash, src->hash);1005}10061007staticinlinevoidhashclr(unsigned char*hash)1008{1009memset(hash,0, GIT_SHA1_RAWSZ);1010}10111012staticinlinevoidoidclr(struct object_id *oid)1013{1014hashclr(oid->hash);1015}101610171018#define EMPTY_TREE_SHA1_HEX \1019"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1020#define EMPTY_TREE_SHA1_BIN_LITERAL \1021"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1022"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1023externconst struct object_id empty_tree_oid;1024#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10251026#define EMPTY_BLOB_SHA1_HEX \1027"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1028#define EMPTY_BLOB_SHA1_BIN_LITERAL \1029"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1030"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1031externconst struct object_id empty_blob_oid;1032#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)103310341035staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1036{1037return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1038}10391040staticinlineintis_empty_blob_oid(const struct object_id *oid)1041{1042return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1043}10441045staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1046{1047return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1048}10491050staticinlineintis_empty_tree_oid(const struct object_id *oid)1051{1052return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1053}105410551056intgit_mkstemp(char*path,size_t n,const char*template);10571058/* set default permissions by passing mode arguments to open(2) */1059intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1060intgit_mkstemp_mode(char*pattern,int mode);10611062/*1063 * NOTE NOTE NOTE!!1064 *1065 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1066 * not be changed. Old repositories have core.sharedrepository written in1067 * numeric format, and therefore these values are preserved for compatibility1068 * reasons.1069 */1070enum sharedrepo {1071 PERM_UMASK =0,1072 OLD_PERM_GROUP =1,1073 OLD_PERM_EVERYBODY =2,1074 PERM_GROUP =0660,1075 PERM_EVERYBODY =06641076};1077intgit_config_perm(const char*var,const char*value);1078intadjust_shared_perm(const char*path);10791080/*1081 * Create the directory containing the named path, using care to be1082 * somewhat safe against races. Return one of the scld_error values1083 * to indicate success/failure.1084 *1085 * SCLD_VANISHED indicates that one of the ancestor directories of the1086 * path existed at one point during the function call and then1087 * suddenly vanished, probably because another process pruned the1088 * directory while we were working. To be robust against this kind of1089 * race, callers might want to try invoking the function again when it1090 * returns SCLD_VANISHED.1091 *1092 * safe_create_leading_directories() temporarily changes path while it1093 * is working but restores it before returning.1094 * safe_create_leading_directories_const() doesn't modify path, even1095 * temporarily.1096 */1097enum scld_error {1098 SCLD_OK =0,1099 SCLD_FAILED = -1,1100 SCLD_PERMS = -2,1101 SCLD_EXISTS = -3,1102 SCLD_VANISHED = -41103};1104enum scld_error safe_create_leading_directories(char*path);1105enum scld_error safe_create_leading_directories_const(const char*path);11061107intmkdir_in_gitdir(const char*path);1108externchar*expand_user_path(const char*path);1109const char*enter_repo(const char*path,int strict);1110staticinlineintis_absolute_path(const char*path)1111{1112returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1113}1114intis_directory(const char*);1115char*strbuf_realpath(struct strbuf *resolved,const char*path,1116int die_on_error);1117const char*real_path(const char*path);1118const char*real_path_if_valid(const char*path);1119char*real_pathdup(const char*path);1120const char*absolute_path(const char*path);1121char*absolute_pathdup(const char*path);1122const char*remove_leading_path(const char*in,const char*prefix);1123const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1124intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1125intnormalize_path_copy(char*dst,const char*src);1126intlongest_ancestor_length(const char*path,struct string_list *prefixes);1127char*strip_path_suffix(const char*path,const char*suffix);1128intdaemon_avoid_alias(const char*path);1129externintis_ntfs_dotgit(const char*name);11301131/**1132 * Return a newly allocated string with the evaluation of1133 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1134 * "$HOME/.config/git/$filename". Return NULL upon error.1135 */1136externchar*xdg_config_home(const char*filename);11371138/* object replacement */1139#define LOOKUP_REPLACE_OBJECT 11140#define LOOKUP_UNKNOWN_OBJECT 21141externvoid*read_sha1_file_extended(const unsigned char*sha1,enum object_type *type,unsigned long*size,unsigned flag);1142staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1143{1144returnread_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);1145}11461147/*1148 * This internal function is only declared here for the benefit of1149 * lookup_replace_object(). Please do not call it directly.1150 */1151externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);11521153/*1154 * If object sha1 should be replaced, return the replacement object's1155 * name (replaced recursively, if necessary). The return value is1156 * either sha1 or a pointer to a permanently-allocated value. When1157 * object replacement is suppressed, always return sha1.1158 */1159staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1160{1161if(!check_replace_refs)1162return sha1;1163returndo_lookup_replace_object(sha1);1164}11651166staticinlineconst unsigned char*lookup_replace_object_extended(const unsigned char*sha1,unsigned flag)1167{1168if(!(flag & LOOKUP_REPLACE_OBJECT))1169return sha1;1170returnlookup_replace_object(sha1);1171}11721173/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1174externintsha1_object_info(const unsigned char*,unsigned long*);1175externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1);1176externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1);1177externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,unsigned char*sha1,unsigned flags);1178externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*);1179externintforce_object_loose(const unsigned char*sha1,time_t mtime);1180externintgit_open_cloexec(const char*name,int flags);1181#define git_open(name) git_open_cloexec(name, O_RDONLY)1182externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1183externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1184externintparse_sha1_header(const char*hdr,unsigned long*sizep);11851186/* global flag to enable extra checks when accessing packed objects */1187externint do_check_packed_object_crc;11881189externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);11901191externintfinalize_object_file(const char*tmpfile,const char*filename);11921193externinthas_sha1_pack(const unsigned char*sha1);11941195/*1196 * Open the loose object at path, check its sha1, and return the contents,1197 * type, and size. If the object is a blob, then "contents" may return NULL,1198 * to allow streaming of large blobs.1199 *1200 * Returns 0 on success, negative on error (details may be written to stderr).1201 */1202intread_loose_object(const char*path,1203const unsigned char*expected_sha1,1204enum object_type *type,1205unsigned long*size,1206void**contents);12071208/*1209 * Return true iff we have an object named sha1, whether local or in1210 * an alternate object database, and whether packed or loose. This1211 * function does not respect replace references.1212 *1213 * If the QUICK flag is set, do not re-check the pack directory1214 * when we cannot find the object (this means we may give a false1215 * negative answer if another process is simultaneously repacking).1216 */1217#define HAS_SHA1_QUICK 0x11218externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1219staticinlineinthas_sha1_file(const unsigned char*sha1)1220{1221returnhas_sha1_file_with_flags(sha1,0);1222}12231224/* Same as the above, except for struct object_id. */1225externinthas_object_file(const struct object_id *oid);1226externinthas_object_file_with_flags(const struct object_id *oid,int flags);12271228/*1229 * Return true iff an alternate object database has a loose object1230 * with the specified name. This function does not respect replace1231 * references.1232 */1233externinthas_loose_object_nonlocal(const unsigned char*sha1);12341235externinthas_pack_index(const unsigned char*sha1);12361237externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);12381239externconst signed char hexval_table[256];1240staticinlineunsigned inthexval(unsigned char c)1241{1242return hexval_table[c];1243}12441245/*1246 * Convert two consecutive hexadecimal digits into a char. Return a1247 * negative value on error. Don't run over the end of short strings.1248 */1249staticinlineinthex2chr(const char*s)1250{1251int val =hexval(s[0]);1252return(val <0) ? val : (val <<4) |hexval(s[1]);1253}12541255/* Convert to/from hex/sha1 representation */1256#define MINIMUM_ABBREV minimum_abbrev1257#define DEFAULT_ABBREV default_abbrev12581259/* used when the code does not know or care what the default abbrev is */1260#define FALLBACK_DEFAULT_ABBREV 712611262struct object_context {1263unsigned char tree[20];1264char path[PATH_MAX];1265unsigned mode;1266/*1267 * symlink_path is only used by get_tree_entry_follow_symlinks,1268 * and only for symlinks that point outside the repository.1269 */1270struct strbuf symlink_path;1271};12721273#define GET_SHA1_QUIETLY 011274#define GET_SHA1_COMMIT 021275#define GET_SHA1_COMMITTISH 041276#define GET_SHA1_TREE 0101277#define GET_SHA1_TREEISH 0201278#define GET_SHA1_BLOB 0401279#define GET_SHA1_FOLLOW_SYMLINKS 01001280#define GET_SHA1_ONLY_TO_DIE 0400012811282#define GET_SHA1_DISAMBIGUATORS \1283 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \1284 GET_SHA1_TREE | GET_SHA1_TREEISH | \1285 GET_SHA1_BLOB)12861287externintget_sha1(const char*str,unsigned char*sha1);1288externintget_sha1_commit(const char*str,unsigned char*sha1);1289externintget_sha1_committish(const char*str,unsigned char*sha1);1290externintget_sha1_tree(const char*str,unsigned char*sha1);1291externintget_sha1_treeish(const char*str,unsigned char*sha1);1292externintget_sha1_blob(const char*str,unsigned char*sha1);1293externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1294externintget_sha1_with_context(const char*str,unsigned flags,unsigned char*sha1,struct object_context *orc);12951296externintget_oid(const char*str,struct object_id *oid);12971298typedefinteach_abbrev_fn(const unsigned char*sha1,void*);1299externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13001301externintset_disambiguate_hint_config(const char*var,const char*value);13021303/*1304 * Try to read a SHA1 in hexadecimal format from the 40 characters1305 * starting at hex. Write the 20-byte result to sha1 in binary form.1306 * Return 0 on success. Reading stops if a NUL is encountered in the1307 * input, so it is safe to pass this function an arbitrary1308 * null-terminated string.1309 */1310externintget_sha1_hex(const char*hex,unsigned char*sha1);1311externintget_oid_hex(const char*hex,struct object_id *sha1);13121313/*1314 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1315 * and writes the NUL-terminated output to the buffer `out`, which must be at1316 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1317 * convenience.1318 *1319 * The non-`_r` variant returns a static buffer, but uses a ring of 41320 * buffers, making it safe to make multiple calls for a single statement, like:1321 *1322 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1323 */1324externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1325externchar*oid_to_hex_r(char*out,const struct object_id *oid);1326externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1327externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */13281329externintinterpret_branch_name(const char*str,int len,struct strbuf *);1330externintget_oid_mb(const char*str,struct object_id *oid);13311332externintvalidate_headref(const char*ref);13331334externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1335externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1336externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1337externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);13381339externvoid*read_object_with_reference(const unsigned char*sha1,1340const char*required_type,1341unsigned long*size,1342unsigned char*sha1_ret);13431344externstruct object *peel_to_type(const char*name,int namelen,1345struct object *o,enum object_type);13461347struct date_mode {1348enum date_mode_type {1349 DATE_NORMAL =0,1350 DATE_RELATIVE,1351 DATE_SHORT,1352 DATE_ISO8601,1353 DATE_ISO8601_STRICT,1354 DATE_RFC2822,1355 DATE_STRFTIME,1356 DATE_RAW,1357 DATE_UNIX1358} type;1359const char*strftime_fmt;1360int local;1361};13621363/*1364 * Convenience helper for passing a constant type, like:1365 *1366 * show_date(t, tz, DATE_MODE(NORMAL));1367 */1368#define DATE_MODE(t) date_mode_from_type(DATE_##t)1369struct date_mode *date_mode_from_type(enum date_mode_type type);13701371const char*show_date(unsigned long time,int timezone,const struct date_mode *mode);1372voidshow_date_relative(unsigned long time,int tz,const struct timeval *now,1373struct strbuf *timebuf);1374intparse_date(const char*date,struct strbuf *out);1375intparse_date_basic(const char*date,unsigned long*timestamp,int*offset);1376intparse_expiry_date(const char*date,unsigned long*timestamp);1377voiddatestamp(struct strbuf *out);1378#define approxidate(s) approxidate_careful((s), NULL)1379unsigned longapproxidate_careful(const char*,int*);1380unsigned longapproxidate_relative(const char*date,const struct timeval *now);1381voidparse_date_format(const char*format,struct date_mode *mode);1382intdate_overflows(unsigned long date);13831384#define IDENT_STRICT 11385#define IDENT_NO_DATE 21386#define IDENT_NO_NAME 41387externconst char*git_author_info(int);1388externconst char*git_committer_info(int);1389externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1390externconst char*fmt_name(const char*name,const char*email);1391externconst char*ident_default_name(void);1392externconst char*ident_default_email(void);1393externconst char*git_editor(void);1394externconst char*git_pager(int stdout_is_tty);1395externintgit_ident_config(const char*,const char*,void*);1396externvoidreset_ident_date(void);13971398struct ident_split {1399const char*name_begin;1400const char*name_end;1401const char*mail_begin;1402const char*mail_end;1403const char*date_begin;1404const char*date_end;1405const char*tz_begin;1406const char*tz_end;1407};1408/*1409 * Signals an success with 0, but time part of the result may be NULL1410 * if the input lacks timestamp and zone1411 */1412externintsplit_ident_line(struct ident_split *,const char*,int);14131414/*1415 * Like show_date, but pull the timestamp and tz parameters from1416 * the ident_split. It will also sanity-check the values and produce1417 * a well-known sentinel date if they appear bogus.1418 */1419const char*show_ident_date(const struct ident_split *id,1420const struct date_mode *mode);14211422/*1423 * Compare split idents for equality or strict ordering. Note that we1424 * compare only the ident part of the line, ignoring any timestamp.1425 *1426 * Because there are two fields, we must choose one as the primary key; we1427 * currently arbitrarily pick the email.1428 */1429externintident_cmp(const struct ident_split *,const struct ident_split *);14301431struct checkout {1432struct index_state *istate;1433const char*base_dir;1434int base_dir_len;1435unsigned force:1,1436 quiet:1,1437 not_new:1,1438 refresh_cache:1;1439};1440#define CHECKOUT_INIT { NULL,"" }14411442#define TEMPORARY_FILENAME_LENGTH 251443externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);14441445struct cache_def {1446struct strbuf path;1447int flags;1448int track_flags;1449int prefix_len_stat_func;1450};1451#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1452staticinlinevoidcache_def_clear(struct cache_def *cache)1453{1454strbuf_release(&cache->path);1455}14561457externinthas_symlink_leading_path(const char*name,int len);1458externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1459externintcheck_leading_path(const char*name,int len);1460externinthas_dirs_only_path(const char*name,int len,int prefix_len);1461externvoidschedule_dir_for_removal(const char*name,int len);1462externvoidremove_scheduled_dirs(void);14631464externstruct alternate_object_database {1465struct alternate_object_database *next;14661467/* see alt_scratch_buf() */1468struct strbuf scratch;1469size_t base_len;14701471char path[FLEX_ARRAY];1472} *alt_odb_list;1473externvoidprepare_alt_odb(void);1474externvoidread_info_alternates(const char* relative_base,int depth);1475externchar*compute_alternate_path(const char*path,struct strbuf *err);1476typedefintalt_odb_fn(struct alternate_object_database *,void*);1477externintforeach_alt_odb(alt_odb_fn,void*);14781479/*1480 * Allocate a "struct alternate_object_database" but do _not_ actually1481 * add it to the list of alternates.1482 */1483struct alternate_object_database *alloc_alt_odb(const char*dir);14841485/*1486 * Add the directory to the on-disk alternates file; the new entry will also1487 * take effect in the current process.1488 */1489externvoidadd_to_alternates_file(const char*dir);14901491/*1492 * Add the directory to the in-memory list of alternates (along with any1493 * recursive alternates it points to), but do not modify the on-disk alternates1494 * file.1495 */1496externvoidadd_to_alternates_memory(const char*dir);14971498/*1499 * Returns a scratch strbuf pre-filled with the alternate object directory,1500 * including a trailing slash, which can be used to access paths in the1501 * alternate. Always use this over direct access to alt->scratch, as it1502 * cleans up any previous use of the scratch buffer.1503 */1504externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);15051506struct pack_window {1507struct pack_window *next;1508unsigned char*base;1509 off_t offset;1510size_t len;1511unsigned int last_used;1512unsigned int inuse_cnt;1513};15141515externstruct packed_git {1516struct packed_git *next;1517struct pack_window *windows;1518 off_t pack_size;1519const void*index_data;1520size_t index_size;1521uint32_t num_objects;1522uint32_t num_bad_objects;1523unsigned char*bad_object_sha1;1524int index_version;1525time_t mtime;1526int pack_fd;1527unsigned pack_local:1,1528 pack_keep:1,1529 freshened:1,1530 do_not_close:1;1531unsigned char sha1[20];1532struct revindex_entry *revindex;1533/* something like ".git/objects/pack/xxxxx.pack" */1534char pack_name[FLEX_ARRAY];/* more */1535} *packed_git;15361537/*1538 * A most-recently-used ordered version of the packed_git list, which can1539 * be iterated instead of packed_git (and marked via mru_mark).1540 */1541struct mru;1542externstruct mru *packed_git_mru;15431544struct pack_entry {1545 off_t offset;1546unsigned char sha1[20];1547struct packed_git *p;1548};15491550externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path);15511552/* A hook to report invalid files in pack directory */1553#define PACKDIR_FILE_PACK 11554#define PACKDIR_FILE_IDX 21555#define PACKDIR_FILE_GARBAGE 41556externvoid(*report_garbage)(unsigned seen_bits,const char*path);15571558externvoidprepare_packed_git(void);1559externvoidreprepare_packed_git(void);1560externvoidinstall_packed_git(struct packed_git *pack);15611562/*1563 * Give a rough count of objects in the repository. This sacrifices accuracy1564 * for speed.1565 */1566unsigned longapproximate_object_count(void);15671568externstruct packed_git *find_sha1_pack(const unsigned char*sha1,1569struct packed_git *packs);15701571externvoidpack_report(void);15721573/*1574 * mmap the index file for the specified packfile (if it is not1575 * already mmapped). Return 0 on success.1576 */1577externintopen_pack_index(struct packed_git *);15781579/*1580 * munmap the index file for the specified packfile (if it is1581 * currently mmapped).1582 */1583externvoidclose_pack_index(struct packed_git *);15841585externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*);1586externvoidclose_pack_windows(struct packed_git *);1587externvoidclose_all_packs(void);1588externvoidunuse_pack(struct pack_window **);1589externvoidclear_delta_base_cache(void);1590externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local);15911592/*1593 * Make sure that a pointer access into an mmap'd index file is within bounds,1594 * and can provide at least 8 bytes of data.1595 *1596 * Note that this is only necessary for variable-length segments of the file1597 * (like the 64-bit extended offset table), as we compare the size to the1598 * fixed-length parts when we open the file.1599 */1600externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr);16011602/*1603 * Return the SHA-1 of the nth object within the specified packfile.1604 * Open the index if it is not already open. The return value points1605 * at the SHA-1 within the mmapped index. Return NULL if there is an1606 * error.1607 */1608externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n);16091610/*1611 * Return the offset of the nth object within the specified packfile.1612 * The index must already be opened.1613 */1614extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n);16151616/*1617 * If the object named sha1 is present in the specified packfile,1618 * return its offset within the packfile; otherwise, return 0.1619 */1620extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *);16211622externintis_pack_valid(struct packed_git *);1623externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*);1624externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep);1625externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t);1626externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*);16271628/*1629 * Iterate over the files in the loose-object parts of the object1630 * directory "path", triggering the following callbacks:1631 *1632 * - loose_object is called for each loose object we find.1633 *1634 * - loose_cruft is called for any files that do not appear to be1635 * loose objects. Note that we only look in the loose object1636 * directories "objects/[0-9a-f]{2}/", so we will not report1637 * "objects/foobar" as cruft.1638 *1639 * - loose_subdir is called for each top-level hashed subdirectory1640 * of the object directory (e.g., "$OBJDIR/f0"). It is called1641 * after the objects in the directory are processed.1642 *1643 * Any callback that is NULL will be ignored. Callbacks returning non-zero1644 * will end the iteration.1645 *1646 * In the "buf" variant, "path" is a strbuf which will also be used as a1647 * scratch buffer, but restored to its original contents before1648 * the function returns.1649 */1650typedefinteach_loose_object_fn(const unsigned char*sha1,1651const char*path,1652void*data);1653typedefinteach_loose_cruft_fn(const char*basename,1654const char*path,1655void*data);1656typedefinteach_loose_subdir_fn(int nr,1657const char*path,1658void*data);1659intfor_each_loose_file_in_objdir(const char*path,1660 each_loose_object_fn obj_cb,1661 each_loose_cruft_fn cruft_cb,1662 each_loose_subdir_fn subdir_cb,1663void*data);1664intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1665 each_loose_object_fn obj_cb,1666 each_loose_cruft_fn cruft_cb,1667 each_loose_subdir_fn subdir_cb,1668void*data);16691670/*1671 * Iterate over loose and packed objects in both the local1672 * repository and any alternates repositories (unless the1673 * LOCAL_ONLY flag is set).1674 */1675#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11676typedefinteach_packed_object_fn(const unsigned char*sha1,1677struct packed_git *pack,1678uint32_t pos,1679void*data);1680externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);1681externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags);16821683struct object_info {1684/* Request */1685enum object_type *typep;1686unsigned long*sizep;1687 off_t *disk_sizep;1688unsigned char*delta_base_sha1;1689struct strbuf *typename;16901691/* Response */1692enum{1693 OI_CACHED,1694 OI_LOOSE,1695 OI_PACKED,1696 OI_DBCACHED1697} whence;1698union{1699/*1700 * struct {1701 * ... Nothing to expose in this case1702 * } cached;1703 * struct {1704 * ... Nothing to expose in this case1705 * } loose;1706 */1707struct{1708struct packed_git *pack;1709 off_t offset;1710unsigned int is_delta;1711} packed;1712} u;1713};17141715/*1716 * Initializer for a "struct object_info" that wants no items. You may1717 * also memset() the memory to all-zeroes.1718 */1719#define OBJECT_INFO_INIT {NULL}17201721externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);1722externintpacked_object_info(struct packed_git *pack, off_t offset,struct object_info *);17231724/* Dumb servers support */1725externintupdate_server_info(int);17261727/* git_config_parse_key() returns these negated: */1728#define CONFIG_INVALID_KEY 11729#define CONFIG_NO_SECTION_OR_NAME 21730/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */1731#define CONFIG_NO_LOCK -11732#define CONFIG_INVALID_FILE 31733#define CONFIG_NO_WRITE 41734#define CONFIG_NOTHING_SET 51735#define CONFIG_INVALID_PATTERN 61736#define CONFIG_GENERIC_ERROR 717371738#define CONFIG_REGEX_NONE ((void *)1)17391740struct git_config_source {1741unsigned int use_stdin:1;1742const char*file;1743const char*blob;1744};17451746enum config_origin_type {1747 CONFIG_ORIGIN_BLOB,1748 CONFIG_ORIGIN_FILE,1749 CONFIG_ORIGIN_STDIN,1750 CONFIG_ORIGIN_SUBMODULE_BLOB,1751 CONFIG_ORIGIN_CMDLINE1752};17531754typedefint(*config_fn_t)(const char*,const char*,void*);1755externintgit_default_config(const char*,const char*,void*);1756externintgit_config_from_file(config_fn_t fn,const char*,void*);1757externintgit_config_from_mem(config_fn_t fn,const enum config_origin_type,1758const char*name,const char*buf,size_t len,void*data);1759externintgit_config_from_blob_sha1(config_fn_t fn,const char*name,1760const unsigned char*sha1,void*data);1761externvoidgit_config_push_parameter(const char*text);1762externintgit_config_from_parameters(config_fn_t fn,void*data);1763externvoidread_early_config(config_fn_t cb,void*data);1764externvoidgit_config(config_fn_t fn,void*);1765externintgit_config_with_options(config_fn_t fn,void*,1766struct git_config_source *config_source,1767int respect_includes);1768externintgit_parse_ulong(const char*,unsigned long*);1769externintgit_parse_maybe_bool(const char*);1770externintgit_config_int(const char*,const char*);1771externint64_tgit_config_int64(const char*,const char*);1772externunsigned longgit_config_ulong(const char*,const char*);1773externintgit_config_bool_or_int(const char*,const char*,int*);1774externintgit_config_bool(const char*,const char*);1775externintgit_config_maybe_bool(const char*,const char*);1776externintgit_config_string(const char**,const char*,const char*);1777externintgit_config_pathname(const char**,const char*,const char*);1778externintgit_config_set_in_file_gently(const char*,const char*,const char*);1779externvoidgit_config_set_in_file(const char*,const char*,const char*);1780externintgit_config_set_gently(const char*,const char*);1781externvoidgit_config_set(const char*,const char*);1782externintgit_config_parse_key(const char*,char**,int*);1783externintgit_config_key_is_valid(const char*key);1784externintgit_config_set_multivar_gently(const char*,const char*,const char*,int);1785externvoidgit_config_set_multivar(const char*,const char*,const char*,int);1786externintgit_config_set_multivar_in_file_gently(const char*,const char*,const char*,const char*,int);1787externvoidgit_config_set_multivar_in_file(const char*,const char*,const char*,const char*,int);1788externintgit_config_rename_section(const char*,const char*);1789externintgit_config_rename_section_in_file(const char*,const char*,const char*);1790externconst char*git_etc_gitconfig(void);1791externintgit_env_bool(const char*,int);1792externunsigned longgit_env_ulong(const char*,unsigned long);1793externintgit_config_system(void);1794externintconfig_error_nonbool(const char*);1795#if defined(__GNUC__)1796#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1797#endif1798externconst char*get_log_output_encoding(void);1799externconst char*get_commit_output_encoding(void);18001801externintgit_config_parse_parameter(const char*, config_fn_t fn,void*data);18021803enum config_scope {1804 CONFIG_SCOPE_UNKNOWN =0,1805 CONFIG_SCOPE_SYSTEM,1806 CONFIG_SCOPE_GLOBAL,1807 CONFIG_SCOPE_REPO,1808 CONFIG_SCOPE_CMDLINE,1809};18101811externenum config_scope current_config_scope(void);1812externconst char*current_config_origin_type(void);1813externconst char*current_config_name(void);18141815struct config_include_data {1816int depth;1817 config_fn_t fn;1818void*data;1819};1820#define CONFIG_INCLUDE_INIT { 0 }1821externintgit_config_include(const char*name,const char*value,void*data);18221823/*1824 * Match and parse a config key of the form:1825 *1826 * section.(subsection.)?key1827 *1828 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1829 * we return -1 if it does not match, 0 otherwise. The subsection and key1830 * out-parameters are filled by the function (and subsection is NULL if it is1831 * missing).1832 */1833externintparse_config_key(const char*var,1834const char*section,1835const char**subsection,int*subsection_len,1836const char**key);18371838struct config_set_element {1839struct hashmap_entry ent;1840char*key;1841struct string_list value_list;1842};18431844struct configset_list_item {1845struct config_set_element *e;1846int value_index;1847};18481849/*1850 * the contents of the list are ordered according to their1851 * position in the config files and order of parsing the files.1852 * (i.e. key-value pair at the last position of .git/config will1853 * be at the last item of the list)1854 */1855struct configset_list {1856struct configset_list_item *items;1857unsigned int nr, alloc;1858};18591860struct config_set {1861struct hashmap config_hash;1862int hash_initialized;1863struct configset_list list;1864};18651866externvoidgit_configset_init(struct config_set *cs);1867externintgit_configset_add_file(struct config_set *cs,const char*filename);1868externintgit_configset_get_value(struct config_set *cs,const char*key,const char**value);1869externconst struct string_list *git_configset_get_value_multi(struct config_set *cs,const char*key);1870externvoidgit_configset_clear(struct config_set *cs);1871externintgit_configset_get_string_const(struct config_set *cs,const char*key,const char**dest);1872externintgit_configset_get_string(struct config_set *cs,const char*key,char**dest);1873externintgit_configset_get_int(struct config_set *cs,const char*key,int*dest);1874externintgit_configset_get_ulong(struct config_set *cs,const char*key,unsigned long*dest);1875externintgit_configset_get_bool(struct config_set *cs,const char*key,int*dest);1876externintgit_configset_get_bool_or_int(struct config_set *cs,const char*key,int*is_bool,int*dest);1877externintgit_configset_get_maybe_bool(struct config_set *cs,const char*key,int*dest);1878externintgit_configset_get_pathname(struct config_set *cs,const char*key,const char**dest);18791880externintgit_config_get_value(const char*key,const char**value);1881externconst struct string_list *git_config_get_value_multi(const char*key);1882externvoidgit_config_clear(void);1883externvoidgit_config_iter(config_fn_t fn,void*data);1884externintgit_config_get_string_const(const char*key,const char**dest);1885externintgit_config_get_string(const char*key,char**dest);1886externintgit_config_get_int(const char*key,int*dest);1887externintgit_config_get_ulong(const char*key,unsigned long*dest);1888externintgit_config_get_bool(const char*key,int*dest);1889externintgit_config_get_bool_or_int(const char*key,int*is_bool,int*dest);1890externintgit_config_get_maybe_bool(const char*key,int*dest);1891externintgit_config_get_pathname(const char*key,const char**dest);1892externintgit_config_get_untracked_cache(void);18931894/*1895 * This is a hack for test programs like test-dump-untracked-cache to1896 * ensure that they do not modify the untracked cache when reading it.1897 * Do not use it otherwise!1898 */1899externint ignore_untracked_cache_config;19001901struct key_value_info {1902const char*filename;1903int linenr;1904enum config_origin_type origin_type;1905enum config_scope scope;1906};19071908extern NORETURN voidgit_die_config(const char*key,const char*err, ...)__attribute__((format(printf,2,3)));1909extern NORETURN voidgit_die_config_linenr(const char*key,const char*filename,int linenr);19101911externintcommitter_ident_sufficiently_given(void);1912externintauthor_ident_sufficiently_given(void);19131914externconst char*git_commit_encoding;1915externconst char*git_log_output_encoding;1916externconst char*git_mailmap_file;1917externconst char*git_mailmap_blob;19181919/* IO helper functions */1920externvoidmaybe_flush_or_die(FILE*,const char*);1921__attribute__((format(printf,2,3)))1922externvoidfprintf_or_die(FILE*,const char*fmt, ...);19231924#define COPY_READ_ERROR (-2)1925#define COPY_WRITE_ERROR (-3)1926externintcopy_fd(int ifd,int ofd);1927externintcopy_file(const char*dst,const char*src,int mode);1928externintcopy_file_with_time(const char*dst,const char*src,int mode);19291930externvoidwrite_or_die(int fd,const void*buf,size_t count);1931externvoidfsync_or_die(int fd,const char*);19321933extern ssize_t read_in_full(int fd,void*buf,size_t count);1934extern ssize_t write_in_full(int fd,const void*buf,size_t count);1935extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);19361937staticinline ssize_t write_str_in_full(int fd,const char*str)1938{1939returnwrite_in_full(fd, str,strlen(str));1940}19411942/**1943 * Open (and truncate) the file at path, write the contents of buf to it,1944 * and close it. Dies if any errors are encountered.1945 */1946externvoidwrite_file_buf(const char*path,const char*buf,size_t len);19471948/**1949 * Like write_file_buf(), but format the contents into a buffer first.1950 * Additionally, write_file() will append a newline if one is not already1951 * present, making it convenient to write text files:1952 *1953 * write_file(path, "counter: %d", ctr);1954 */1955__attribute__((format(printf,2,3)))1956externvoidwrite_file(const char*path,const char*fmt, ...);19571958/* pager.c */1959externvoidsetup_pager(void);1960externintpager_in_use(void);1961externint pager_use_color;1962externintterm_columns(void);1963externintdecimal_width(uintmax_t);1964externintcheck_pager_config(const char*cmd);1965externvoidprepare_pager_args(struct child_process *,const char*pager);19661967externconst char*editor_program;1968externconst char*askpass_program;1969externconst char*excludes_file;19701971/* base85 */1972intdecode_85(char*dst,const char*line,int linelen);1973voidencode_85(char*buf,const unsigned char*data,int bytes);19741975/* alloc.c */1976externvoid*alloc_blob_node(void);1977externvoid*alloc_tree_node(void);1978externvoid*alloc_commit_node(void);1979externvoid*alloc_tag_node(void);1980externvoid*alloc_object_node(void);1981externvoidalloc_report(void);1982externunsigned intalloc_commit_index(void);19831984/* pkt-line.c */1985voidpacket_trace_identity(const char*prog);19861987/* add */1988/*1989 * return 0 if success, 1 - if addition of a file failed and1990 * ADD_FILES_IGNORE_ERRORS was specified in flags1991 */1992intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);19931994/* diff.c */1995externint diff_auto_refresh_index;19961997/* match-trees.c */1998voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1999voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);20002001/*2002 * whitespace rules.2003 * used by both diff and apply2004 * last two digits are tab width2005 */2006#define WS_BLANK_AT_EOL 01002007#define WS_SPACE_BEFORE_TAB 02002008#define WS_INDENT_WITH_NON_TAB 04002009#define WS_CR_AT_EOL 010002010#define WS_BLANK_AT_EOF 020002011#define WS_TAB_IN_INDENT 040002012#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)2013#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)2014#define WS_TAB_WIDTH_MASK 0772015externunsigned whitespace_rule_cfg;2016externunsignedwhitespace_rule(const char*);2017externunsignedparse_whitespace_rule(const char*);2018externunsignedws_check(const char*line,int len,unsigned ws_rule);2019externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);2020externchar*whitespace_error_string(unsigned ws);2021externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);2022externintws_blank_line(const char*line,int len,unsigned ws_rule);2023#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)20242025/* ls-files */2026voidoverlay_tree_on_cache(const char*tree_name,const char*prefix);20272028char*alias_lookup(const char*alias);2029intsplit_cmdline(char*cmdline,const char***argv);2030/* Takes a negative value returned by split_cmdline */2031const char*split_cmdline_strerror(int cmdline_errno);20322033/* setup.c */2034struct startup_info {2035int have_repository;2036const char*prefix;2037};2038externstruct startup_info *startup_info;20392040/* merge.c */2041struct commit_list;2042inttry_merge_command(const char*strategy,size_t xopts_nr,2043const char**xopts,struct commit_list *common,2044const char*head_arg,struct commit_list *remotes);2045intcheckout_fast_forward(const unsigned char*from,2046const unsigned char*to,2047int overwrite_ignore);204820492050intsane_execvp(const char*file,char*const argv[]);20512052/*2053 * A struct to encapsulate the concept of whether a file has changed2054 * since we last checked it. This uses criteria similar to those used2055 * for the index.2056 */2057struct stat_validity {2058struct stat_data *sd;2059};20602061voidstat_validity_clear(struct stat_validity *sv);20622063/*2064 * Returns 1 if the path is a regular file (or a symlink to a regular2065 * file) and matches the saved stat_validity, 0 otherwise. A missing2066 * or inaccessible file is considered a match if the struct was just2067 * initialized, or if the previous update found an inaccessible file.2068 */2069intstat_validity_check(struct stat_validity *sv,const char*path);20702071/*2072 * Update the stat_validity from a file opened at descriptor fd. If2073 * the file is missing, inaccessible, or not a regular file, then2074 * future calls to stat_validity_check will match iff one of those2075 * conditions continues to be true.2076 */2077voidstat_validity_update(struct stat_validity *sv,int fd);20782079intversioncmp(const char*s1,const char*s2);2080voidsleep_millisec(int millisec);20812082/*2083 * Create a directory and (if share is nonzero) adjust its permissions2084 * according to the shared_repository setting. Only use this for2085 * directories under $GIT_DIR. Don't use it for working tree2086 * directories.2087 */2088voidsafe_create_dir(const char*dir,int share);20892090#endif/* CACHE_H */