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"mru.h" 8#include"advice.h" 9#include"gettext.h" 10#include"convert.h" 11#include"trace.h" 12#include"string-list.h" 13#include"pack-revindex.h" 14#include"hash.h" 15#include"path.h" 16#include"sha1-array.h" 17 18#ifndef platform_SHA_CTX 19/* 20 * platform's underlying implementation of SHA-1; could be OpenSSL, 21 * blk_SHA, Apple CommonCrypto, etc... Note that including 22 * SHA1_HEADER may have already defined platform_SHA_CTX for our 23 * own implementations like block-sha1 and ppc-sha1, so we list 24 * the default for OpenSSL compatible SHA-1 implementations here. 25 */ 26#define platform_SHA_CTX SHA_CTX 27#define platform_SHA1_Init SHA1_Init 28#define platform_SHA1_Update SHA1_Update 29#define platform_SHA1_Final SHA1_Final 30#endif 31 32#define git_SHA_CTX platform_SHA_CTX 33#define git_SHA1_Init platform_SHA1_Init 34#define git_SHA1_Update platform_SHA1_Update 35#define git_SHA1_Final platform_SHA1_Final 36 37#ifdef SHA1_MAX_BLOCK_SIZE 38#include"compat/sha1-chunked.h" 39#undef git_SHA1_Update 40#define git_SHA1_Update git_SHA1_Update_Chunked 41#endif 42 43#include <zlib.h> 44typedefstruct git_zstream { 45 z_stream z; 46unsigned long avail_in; 47unsigned long avail_out; 48unsigned long total_in; 49unsigned long total_out; 50unsigned char*next_in; 51unsigned char*next_out; 52} git_zstream; 53 54voidgit_inflate_init(git_zstream *); 55voidgit_inflate_init_gzip_only(git_zstream *); 56voidgit_inflate_end(git_zstream *); 57intgit_inflate(git_zstream *,int flush); 58 59voidgit_deflate_init(git_zstream *,int level); 60voidgit_deflate_init_gzip(git_zstream *,int level); 61voidgit_deflate_init_raw(git_zstream *,int level); 62voidgit_deflate_end(git_zstream *); 63intgit_deflate_abort(git_zstream *); 64intgit_deflate_end_gently(git_zstream *); 65intgit_deflate(git_zstream *,int flush); 66unsigned longgit_deflate_bound(git_zstream *,unsigned long); 67 68/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 69#define GIT_SHA1_RAWSZ 20 70#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 71 72/* The length in byte and in hex digits of the largest possible hash value. */ 73#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 74#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 75 76struct object_id { 77unsigned char hash[GIT_MAX_RAWSZ]; 78}; 79 80#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 81#define DTYPE(de) ((de)->d_type) 82#else 83#undef DT_UNKNOWN 84#undef DT_DIR 85#undef DT_REG 86#undef DT_LNK 87#define DT_UNKNOWN 0 88#define DT_DIR 1 89#define DT_REG 2 90#define DT_LNK 3 91#define DTYPE(de) DT_UNKNOWN 92#endif 93 94/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 95#define S_IFINVALID 0030000 96 97/* 98 * A "directory link" is a link to another git directory. 99 * 100 * The value 0160000 is not normally a valid mode, and 101 * also just happens to be S_IFDIR + S_IFLNK 102 */ 103#define S_IFGITLINK 0160000 104#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 105 106/* 107 * Some mode bits are also used internally for computations. 108 * 109 * They *must* not overlap with any valid modes, and they *must* not be emitted 110 * to outside world - i.e. appear on disk or network. In other words, it's just 111 * temporary fields, which we internally use, but they have to stay in-house. 112 * 113 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 114 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 115 */ 116 117/* used internally in tree-diff */ 118#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 119 120 121/* 122 * Intensive research over the course of many years has shown that 123 * port 9418 is totally unused by anything else. Or 124 * 125 * Your search - "port 9418" - did not match any documents. 126 * 127 * as www.google.com puts it. 128 * 129 * This port has been properly assigned for git use by IANA: 130 * git (Assigned-9418) [I06-050728-0001]. 131 * 132 * git 9418/tcp git pack transfer service 133 * git 9418/udp git pack transfer service 134 * 135 * with Linus Torvalds <torvalds@osdl.org> as the point of 136 * contact. September 2005. 137 * 138 * See http://www.iana.org/assignments/port-numbers 139 */ 140#define DEFAULT_GIT_PORT 9418 141 142/* 143 * Basic data structures for the directory cache 144 */ 145 146#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 147struct cache_header { 148uint32_t hdr_signature; 149uint32_t hdr_version; 150uint32_t hdr_entries; 151}; 152 153#define INDEX_FORMAT_LB 2 154#define INDEX_FORMAT_UB 4 155 156/* 157 * The "cache_time" is just the low 32 bits of the 158 * time. It doesn't matter if it overflows - we only 159 * check it for equality in the 32 bits we save. 160 */ 161struct cache_time { 162uint32_t sec; 163uint32_t nsec; 164}; 165 166struct stat_data { 167struct cache_time sd_ctime; 168struct cache_time sd_mtime; 169unsigned int sd_dev; 170unsigned int sd_ino; 171unsigned int sd_uid; 172unsigned int sd_gid; 173unsigned int sd_size; 174}; 175 176struct cache_entry { 177struct hashmap_entry ent; 178struct stat_data ce_stat_data; 179unsigned int ce_mode; 180unsigned int ce_flags; 181unsigned int ce_namelen; 182unsigned int index;/* for link extension */ 183struct object_id oid; 184char name[FLEX_ARRAY];/* more */ 185}; 186 187#define CE_STAGEMASK (0x3000) 188#define CE_EXTENDED (0x4000) 189#define CE_VALID (0x8000) 190#define CE_STAGESHIFT 12 191 192/* 193 * Range 0xFFFF0FFF in ce_flags is divided into 194 * two parts: in-memory flags and on-disk ones. 195 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 196 * if you want to save a new flag, add it in 197 * CE_EXTENDED_FLAGS 198 * 199 * In-memory only flags 200 */ 201#define CE_UPDATE (1 << 16) 202#define CE_REMOVE (1 << 17) 203#define CE_UPTODATE (1 << 18) 204#define CE_ADDED (1 << 19) 205 206#define CE_HASHED (1 << 20) 207#define CE_FSMONITOR_VALID (1 << 21) 208#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 209#define CE_CONFLICTED (1 << 23) 210 211#define CE_UNPACKED (1 << 24) 212#define CE_NEW_SKIP_WORKTREE (1 << 25) 213 214/* used to temporarily mark paths matched by pathspecs */ 215#define CE_MATCHED (1 << 26) 216 217#define CE_UPDATE_IN_BASE (1 << 27) 218#define CE_STRIP_NAME (1 << 28) 219 220/* 221 * Extended on-disk flags 222 */ 223#define CE_INTENT_TO_ADD (1 << 29) 224#define CE_SKIP_WORKTREE (1 << 30) 225/* CE_EXTENDED2 is for future extension */ 226#define CE_EXTENDED2 (1U << 31) 227 228#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 229 230/* 231 * Safeguard to avoid saving wrong flags: 232 * - CE_EXTENDED2 won't get saved until its semantic is known 233 * - Bits in 0x0000FFFF have been saved in ce_flags already 234 * - Bits in 0x003F0000 are currently in-memory flags 235 */ 236#if CE_EXTENDED_FLAGS & 0x803FFFFF 237#error"CE_EXTENDED_FLAGS out of range" 238#endif 239 240/* Forward structure decls */ 241struct pathspec; 242struct child_process; 243 244/* 245 * Copy the sha1 and stat state of a cache entry from one to 246 * another. But we never change the name, or the hash state! 247 */ 248staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 249const struct cache_entry *src) 250{ 251unsigned int state = dst->ce_flags & CE_HASHED; 252 253/* Don't copy hash chain and name */ 254memcpy(&dst->ce_stat_data, &src->ce_stat_data, 255offsetof(struct cache_entry, name) - 256offsetof(struct cache_entry, ce_stat_data)); 257 258/* Restore the hash state */ 259 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 260} 261 262staticinlineunsignedcreate_ce_flags(unsigned stage) 263{ 264return(stage << CE_STAGESHIFT); 265} 266 267#define ce_namelen(ce) ((ce)->ce_namelen) 268#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 269#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 270#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 271#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 272#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 273#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 274 275#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 276staticinlineunsigned intcreate_ce_mode(unsigned int mode) 277{ 278if(S_ISLNK(mode)) 279return S_IFLNK; 280if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 281return S_IFGITLINK; 282return S_IFREG |ce_permissions(mode); 283} 284staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 285unsigned int mode) 286{ 287externint trust_executable_bit, has_symlinks; 288if(!has_symlinks &&S_ISREG(mode) && 289 ce &&S_ISLNK(ce->ce_mode)) 290return ce->ce_mode; 291if(!trust_executable_bit &&S_ISREG(mode)) { 292if(ce &&S_ISREG(ce->ce_mode)) 293return ce->ce_mode; 294returncreate_ce_mode(0666); 295} 296returncreate_ce_mode(mode); 297} 298staticinlineintce_to_dtype(const struct cache_entry *ce) 299{ 300unsigned ce_mode =ntohl(ce->ce_mode); 301if(S_ISREG(ce_mode)) 302return DT_REG; 303else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 304return DT_DIR; 305else if(S_ISLNK(ce_mode)) 306return DT_LNK; 307else 308return DT_UNKNOWN; 309} 310staticinlineunsigned intcanon_mode(unsigned int mode) 311{ 312if(S_ISREG(mode)) 313return S_IFREG |ce_permissions(mode); 314if(S_ISLNK(mode)) 315return S_IFLNK; 316if(S_ISDIR(mode)) 317return S_IFDIR; 318return S_IFGITLINK; 319} 320 321#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 322 323#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 324#define CE_ENTRY_CHANGED (1 << 1) 325#define CE_ENTRY_REMOVED (1 << 2) 326#define CE_ENTRY_ADDED (1 << 3) 327#define RESOLVE_UNDO_CHANGED (1 << 4) 328#define CACHE_TREE_CHANGED (1 << 5) 329#define SPLIT_INDEX_ORDERED (1 << 6) 330#define UNTRACKED_CHANGED (1 << 7) 331#define FSMONITOR_CHANGED (1 << 8) 332 333struct split_index; 334struct untracked_cache; 335 336struct index_state { 337struct cache_entry **cache; 338unsigned int version; 339unsigned int cache_nr, cache_alloc, cache_changed; 340struct string_list *resolve_undo; 341struct cache_tree *cache_tree; 342struct split_index *split_index; 343struct cache_time timestamp; 344unsigned name_hash_initialized :1, 345 initialized :1; 346struct hashmap name_hash; 347struct hashmap dir_hash; 348unsigned char sha1[20]; 349struct untracked_cache *untracked; 350uint64_t fsmonitor_last_update; 351struct ewah_bitmap *fsmonitor_dirty; 352}; 353 354externstruct index_state the_index; 355 356/* Name hashing */ 357externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 358externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 359externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 360externvoidfree_name_hash(struct index_state *istate); 361 362 363#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 364#define active_cache (the_index.cache) 365#define active_nr (the_index.cache_nr) 366#define active_alloc (the_index.cache_alloc) 367#define active_cache_changed (the_index.cache_changed) 368#define active_cache_tree (the_index.cache_tree) 369 370#define read_cache() read_index(&the_index) 371#define read_cache_from(path) read_index_from(&the_index, (path)) 372#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 373#define is_cache_unborn() is_index_unborn(&the_index) 374#define read_cache_unmerged() read_index_unmerged(&the_index) 375#define discard_cache() discard_index(&the_index) 376#define unmerged_cache() unmerged_index(&the_index) 377#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 378#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 379#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 380#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 381#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 382#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 383#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 384#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 385#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 386#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 387#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 388#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 389#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 390#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 391#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 392#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 393#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 394#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 395#endif 396 397enum object_type { 398 OBJ_BAD = -1, 399 OBJ_NONE =0, 400 OBJ_COMMIT =1, 401 OBJ_TREE =2, 402 OBJ_BLOB =3, 403 OBJ_TAG =4, 404/* 5 for future expansion */ 405 OBJ_OFS_DELTA =6, 406 OBJ_REF_DELTA =7, 407 OBJ_ANY, 408 OBJ_MAX 409}; 410 411staticinlineenum object_type object_type(unsigned int mode) 412{ 413returnS_ISDIR(mode) ? OBJ_TREE : 414S_ISGITLINK(mode) ? OBJ_COMMIT : 415 OBJ_BLOB; 416} 417 418/* Double-check local_repo_env below if you add to this list. */ 419#define GIT_DIR_ENVIRONMENT"GIT_DIR" 420#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 421#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 422#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 423#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 424#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 425#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 426#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 427#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 428#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 429#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 430#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 431#define CONFIG_ENVIRONMENT"GIT_CONFIG" 432#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 433#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 434#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 435#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 436#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 437#define GITATTRIBUTES_FILE".gitattributes" 438#define INFOATTRIBUTES_FILE"info/attributes" 439#define ATTRIBUTE_MACRO_PREFIX"[attr]" 440#define GITMODULES_FILE".gitmodules" 441#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 442#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 443#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 444#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 445#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 446#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 447#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 448#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 449#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 450#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 451#define GIT_OPTIONAL_LOCKS_ENVIRONMENT"GIT_OPTIONAL_LOCKS" 452 453/* 454 * Environment variable used in handshaking the wire protocol. 455 * Contains a colon ':' separated list of keys with optional values 456 * 'key[=value]'. Presence of unknown keys and values must be 457 * ignored. 458 */ 459#define GIT_PROTOCOL_ENVIRONMENT"GIT_PROTOCOL" 460/* HTTP header used to handshake the wire protocol */ 461#define GIT_PROTOCOL_HEADER"Git-Protocol" 462 463/* 464 * This environment variable is expected to contain a boolean indicating 465 * whether we should or should not treat: 466 * 467 * GIT_DIR=foo.git git ... 468 * 469 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 470 * of this, but we use it internally to communicate to sub-processes that we 471 * are in a bare repo. If not set, defaults to true. 472 */ 473#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 474 475/* 476 * Repository-local GIT_* environment variables; these will be cleared 477 * when git spawns a sub-process that runs inside another repository. 478 * The array is NULL-terminated, which makes it easy to pass in the "env" 479 * parameter of a run-command invocation, or to do a simple walk. 480 */ 481externconst char*const local_repo_env[]; 482 483externvoidsetup_git_env(void); 484 485/* 486 * Returns true iff we have a configured git repository (either via 487 * setup_git_directory, or in the environment via $GIT_DIR). 488 */ 489inthave_git_dir(void); 490 491externint is_bare_repository_cfg; 492externintis_bare_repository(void); 493externintis_inside_git_dir(void); 494externchar*git_work_tree_cfg; 495externintis_inside_work_tree(void); 496externconst char*get_git_dir(void); 497externconst char*get_git_common_dir(void); 498externchar*get_object_directory(void); 499externchar*get_index_file(void); 500externchar*get_graft_file(void); 501externintset_git_dir(const char*path); 502externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 503externintget_common_dir(struct strbuf *sb,const char*gitdir); 504externconst char*get_git_namespace(void); 505externconst char*strip_namespace(const char*namespaced_ref); 506externconst char*get_super_prefix(void); 507externconst char*get_git_work_tree(void); 508 509/* 510 * Return true if the given path is a git directory; note that this _just_ 511 * looks at the directory itself. If you want to know whether "foo/.git" 512 * is a repository, you must feed that path, not just "foo". 513 */ 514externintis_git_directory(const char*path); 515 516/* 517 * Return 1 if the given path is the root of a git repository or 518 * submodule, else 0. Will not return 1 for bare repositories with the 519 * exception of creating a bare repository in "foo/.git" and calling 520 * is_git_repository("foo"). 521 * 522 * If we run into read errors, we err on the side of saying "yes, it is", 523 * as we usually consider sub-repos precious, and would prefer to err on the 524 * side of not disrupting or deleting them. 525 */ 526externintis_nonbare_repository_dir(struct strbuf *path); 527 528#define READ_GITFILE_ERR_STAT_FAILED 1 529#define READ_GITFILE_ERR_NOT_A_FILE 2 530#define READ_GITFILE_ERR_OPEN_FAILED 3 531#define READ_GITFILE_ERR_READ_FAILED 4 532#define READ_GITFILE_ERR_INVALID_FORMAT 5 533#define READ_GITFILE_ERR_NO_PATH 6 534#define READ_GITFILE_ERR_NOT_A_REPO 7 535#define READ_GITFILE_ERR_TOO_LARGE 8 536externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 537externconst char*read_gitfile_gently(const char*path,int*return_error_code); 538#define read_gitfile(path) read_gitfile_gently((path), NULL) 539externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 540#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 541 542externvoidset_git_work_tree(const char*tree); 543 544#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 545 546externvoidsetup_work_tree(void); 547/* 548 * Find the commondir and gitdir of the repository that contains the current 549 * working directory, without changing the working directory or other global 550 * state. The result is appended to commondir and gitdir. If the discovered 551 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 552 * both have the same result appended to the buffer. The return value is 553 * either 0 upon success and non-zero if no repository was found. 554 */ 555externintdiscover_git_directory(struct strbuf *commondir, 556struct strbuf *gitdir); 557externconst char*setup_git_directory_gently(int*); 558externconst char*setup_git_directory(void); 559externchar*prefix_path(const char*prefix,int len,const char*path); 560externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 561 562/* 563 * Concatenate "prefix" (if len is non-zero) and "path", with no 564 * connecting characters (so "prefix" should end with a "/"). 565 * Unlike prefix_path, this should be used if the named file does 566 * not have to interact with index entry; i.e. name of a random file 567 * on the filesystem. 568 * 569 * The return value is always a newly allocated string (even if the 570 * prefix was empty). 571 */ 572externchar*prefix_filename(const char*prefix,const char*path); 573 574externintcheck_filename(const char*prefix,const char*name); 575externvoidverify_filename(const char*prefix, 576const char*name, 577int diagnose_misspelt_rev); 578externvoidverify_non_filename(const char*prefix,const char*name); 579externintpath_inside_repo(const char*prefix,const char*path); 580 581#define INIT_DB_QUIET 0x0001 582#define INIT_DB_EXIST_OK 0x0002 583 584externintinit_db(const char*git_dir,const char*real_git_dir, 585const char*template_dir,unsigned int flags); 586 587externvoidsanitize_stdfds(void); 588externintdaemonize(void); 589 590#define alloc_nr(x) (((x)+16)*3/2) 591 592/* 593 * Realloc the buffer pointed at by variable 'x' so that it can hold 594 * at least 'nr' entries; the number of entries currently allocated 595 * is 'alloc', using the standard growing factor alloc_nr() macro. 596 * 597 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 598 */ 599#define ALLOC_GROW(x, nr, alloc) \ 600 do { \ 601 if ((nr) > alloc) { \ 602 if (alloc_nr(alloc) < (nr)) \ 603 alloc = (nr); \ 604 else \ 605 alloc = alloc_nr(alloc); \ 606 REALLOC_ARRAY(x, alloc); \ 607 } \ 608 } while (0) 609 610/* Initialize and use the cache information */ 611struct lock_file; 612externintread_index(struct index_state *); 613externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 614externintdo_read_index(struct index_state *istate,const char*path, 615int must_exist);/* for testting only! */ 616externintread_index_from(struct index_state *,const char*path); 617externintis_index_unborn(struct index_state *); 618externintread_index_unmerged(struct index_state *); 619 620/* For use with `write_locked_index()`. */ 621#define COMMIT_LOCK (1 << 0) 622 623/* 624 * Write the index while holding an already-taken lock. Close the lock, 625 * and if `COMMIT_LOCK` is given, commit it. 626 * 627 * Unless a split index is in use, write the index into the lockfile. 628 * 629 * With a split index, write the shared index to a temporary file, 630 * adjust its permissions and rename it into place, then write the 631 * split index to the lockfile. If the temporary file for the shared 632 * index cannot be created, fall back to the behavior described in 633 * the previous paragraph. 634 * 635 * With `COMMIT_LOCK`, the lock is always committed or rolled back. 636 * Without it, the lock is closed, but neither committed nor rolled 637 * back. 638 */ 639externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 640 641externintdiscard_index(struct index_state *); 642externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 643externintunmerged_index(const struct index_state *); 644externintverify_path(const char*path); 645externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 646externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 647externvoidadjust_dirname_case(struct index_state *istate,char*name); 648externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 649 650/* 651 * Searches for an entry defined by name and namelen in the given index. 652 * If the return value is positive (including 0) it is the position of an 653 * exact match. If the return value is negative, the negated value minus 1 654 * is the position where the entry would be inserted. 655 * Example: The current index consists of these files and its stages: 656 * 657 * b#0, d#0, f#1, f#3 658 * 659 * index_name_pos(&index, "a", 1) -> -1 660 * index_name_pos(&index, "b", 1) -> 0 661 * index_name_pos(&index, "c", 1) -> -2 662 * index_name_pos(&index, "d", 1) -> 1 663 * index_name_pos(&index, "e", 1) -> -3 664 * index_name_pos(&index, "f", 1) -> -3 665 * index_name_pos(&index, "g", 1) -> -5 666 */ 667externintindex_name_pos(const struct index_state *,const char*name,int namelen); 668 669#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 670#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 671#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 672#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 673#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 674#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 675externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 676externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 677 678/* Remove entry, return true if there are more entries to go. */ 679externintremove_index_entry_at(struct index_state *,int pos); 680 681externvoidremove_marked_cache_entries(struct index_state *istate); 682externintremove_file_from_index(struct index_state *,const char*path); 683#define ADD_CACHE_VERBOSE 1 684#define ADD_CACHE_PRETEND 2 685#define ADD_CACHE_IGNORE_ERRORS 4 686#define ADD_CACHE_IGNORE_REMOVAL 8 687#define ADD_CACHE_INTENT 16 688/* 689 * These two are used to add the contents of the file at path 690 * to the index, marking the working tree up-to-date by storing 691 * the cached stat info in the resulting cache entry. A caller 692 * that has already run lstat(2) on the path can call 693 * add_to_index(), and all others can call add_file_to_index(); 694 * the latter will do necessary lstat(2) internally before 695 * calling the former. 696 */ 697externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 698externintadd_file_to_index(struct index_state *,const char*path,int flags); 699 700externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 701externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 702externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 703externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 704externintindex_name_is_other(const struct index_state *,const char*,int); 705externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 706 707/* do stat comparison even if CE_VALID is true */ 708#define CE_MATCH_IGNORE_VALID 01 709/* do not check the contents but report dirty on racily-clean entries */ 710#define CE_MATCH_RACY_IS_DIRTY 02 711/* do stat comparison even if CE_SKIP_WORKTREE is true */ 712#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 713/* ignore non-existent files during stat update */ 714#define CE_MATCH_IGNORE_MISSING 0x08 715/* enable stat refresh */ 716#define CE_MATCH_REFRESH 0x10 717/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */ 718#define CE_MATCH_IGNORE_FSMONITOR 0X20 719externintie_match_stat(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 720externintie_modified(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 721 722#define HASH_WRITE_OBJECT 1 723#define HASH_FORMAT_CHECK 2 724#define HASH_RENORMALIZE 4 725externintindex_fd(struct object_id *oid,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 726externintindex_path(struct object_id *oid,const char*path,struct stat *st,unsigned flags); 727 728/* 729 * Record to sd the data from st that we use to check whether a file 730 * might have changed. 731 */ 732externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 733 734/* 735 * Return 0 if st is consistent with a file not having been changed 736 * since sd was filled. If there are differences, return a 737 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 738 * INODE_CHANGED, and DATA_CHANGED. 739 */ 740externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 741externintmatch_stat_data_racy(const struct index_state *istate, 742const struct stat_data *sd,struct stat *st); 743 744externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 745 746#define REFRESH_REALLY 0x0001/* ignore_valid */ 747#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 748#define REFRESH_QUIET 0x0004/* be quiet about it */ 749#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 750#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 751#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 752externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 753externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 754 755/* 756 * Opportunistically update the index but do not complain if we can't. 757 * The lockfile is always committed or rolled back. 758 */ 759externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 760 761externinthold_locked_index(struct lock_file *,int); 762externvoidset_alternate_index_output(const char*); 763 764externint verify_index_checksum; 765externint verify_ce_order; 766 767/* Environment bits from configuration mechanism */ 768externint trust_executable_bit; 769externint trust_ctime; 770externint check_stat; 771externint quote_path_fully; 772externint has_symlinks; 773externint minimum_abbrev, default_abbrev; 774externint ignore_case; 775externint assume_unchanged; 776externint prefer_symlink_refs; 777externint warn_ambiguous_refs; 778externint warn_on_object_refname_ambiguity; 779externconst char*apply_default_whitespace; 780externconst char*apply_default_ignorewhitespace; 781externconst char*git_attributes_file; 782externconst char*git_hooks_path; 783externint zlib_compression_level; 784externint core_compression_level; 785externint pack_compression_level; 786externsize_t packed_git_window_size; 787externsize_t packed_git_limit; 788externsize_t delta_base_cache_limit; 789externunsigned long big_file_threshold; 790externunsigned long pack_size_limit_cfg; 791 792/* 793 * Accessors for the core.sharedrepository config which lazy-load the value 794 * from the config (if not already set). The "reset" function can be 795 * used to unset "set" or cached value, meaning that the value will be loaded 796 * fresh from the config file on the next call to get_shared_repository(). 797 */ 798voidset_shared_repository(int value); 799intget_shared_repository(void); 800voidreset_shared_repository(void); 801 802/* 803 * Do replace refs need to be checked this run? This variable is 804 * initialized to true unless --no-replace-object is used or 805 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 806 * commands that do not want replace references to be active. As an 807 * optimization it is also set to false if replace references have 808 * been sought but there were none. 809 */ 810externint check_replace_refs; 811externchar*git_replace_ref_base; 812 813externint fsync_object_files; 814externint core_preload_index; 815externint core_apply_sparse_checkout; 816externint precomposed_unicode; 817externint protect_hfs; 818externint protect_ntfs; 819externconst char*core_fsmonitor; 820 821/* 822 * Include broken refs in all ref iterations, which will 823 * generally choke dangerous operations rather than letting 824 * them silently proceed without taking the broken ref into 825 * account. 826 */ 827externint ref_paranoia; 828 829/* 830 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value). 831 */ 832intuse_optional_locks(void); 833 834/* 835 * The character that begins a commented line in user-editable file 836 * that is subject to stripspace. 837 */ 838externchar comment_line_char; 839externint auto_comment_line_char; 840 841/* Windows only */ 842enum hide_dotfiles_type { 843 HIDE_DOTFILES_FALSE =0, 844 HIDE_DOTFILES_TRUE, 845 HIDE_DOTFILES_DOTGITONLY 846}; 847externenum hide_dotfiles_type hide_dotfiles; 848 849enum log_refs_config { 850 LOG_REFS_UNSET = -1, 851 LOG_REFS_NONE =0, 852 LOG_REFS_NORMAL, 853 LOG_REFS_ALWAYS 854}; 855externenum log_refs_config log_all_ref_updates; 856 857enum branch_track { 858 BRANCH_TRACK_UNSPECIFIED = -1, 859 BRANCH_TRACK_NEVER =0, 860 BRANCH_TRACK_REMOTE, 861 BRANCH_TRACK_ALWAYS, 862 BRANCH_TRACK_EXPLICIT, 863 BRANCH_TRACK_OVERRIDE 864}; 865 866enum rebase_setup_type { 867 AUTOREBASE_NEVER =0, 868 AUTOREBASE_LOCAL, 869 AUTOREBASE_REMOTE, 870 AUTOREBASE_ALWAYS 871}; 872 873enum push_default_type { 874 PUSH_DEFAULT_NOTHING =0, 875 PUSH_DEFAULT_MATCHING, 876 PUSH_DEFAULT_SIMPLE, 877 PUSH_DEFAULT_UPSTREAM, 878 PUSH_DEFAULT_CURRENT, 879 PUSH_DEFAULT_UNSPECIFIED 880}; 881 882externenum branch_track git_branch_track; 883externenum rebase_setup_type autorebase; 884externenum push_default_type push_default; 885 886enum object_creation_mode { 887 OBJECT_CREATION_USES_HARDLINKS =0, 888 OBJECT_CREATION_USES_RENAMES =1 889}; 890 891externenum object_creation_mode object_creation_mode; 892 893externchar*notes_ref_name; 894 895externint grafts_replace_parents; 896 897/* 898 * GIT_REPO_VERSION is the version we write by default. The 899 * _READ variant is the highest number we know how to 900 * handle. 901 */ 902#define GIT_REPO_VERSION 0 903#define GIT_REPO_VERSION_READ 1 904externint repository_format_precious_objects; 905 906struct repository_format { 907int version; 908int precious_objects; 909int is_bare; 910char*work_tree; 911struct string_list unknown_extensions; 912}; 913 914/* 915 * Read the repository format characteristics from the config file "path" into 916 * "format" struct. Returns the numeric version. On error, -1 is returned, 917 * format->version is set to -1, and all other fields in the struct are 918 * undefined. 919 */ 920intread_repository_format(struct repository_format *format,const char*path); 921 922/* 923 * Verify that the repository described by repository_format is something we 924 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 925 * any errors encountered. 926 */ 927intverify_repository_format(const struct repository_format *format, 928struct strbuf *err); 929 930/* 931 * Check the repository format version in the path found in get_git_dir(), 932 * and die if it is a version we don't understand. Generally one would 933 * set_git_dir() before calling this, and use it only for "are we in a valid 934 * repo?". 935 */ 936externvoidcheck_repository_format(void); 937 938#define MTIME_CHANGED 0x0001 939#define CTIME_CHANGED 0x0002 940#define OWNER_CHANGED 0x0004 941#define MODE_CHANGED 0x0008 942#define INODE_CHANGED 0x0010 943#define DATA_CHANGED 0x0020 944#define TYPE_CHANGED 0x0040 945 946/* 947 * Return the name of the file in the local object database that would 948 * be used to store a loose object with the specified sha1. The 949 * return value is a pointer to a statically allocated buffer that is 950 * overwritten each time the function is called. 951 */ 952externconst char*sha1_file_name(const unsigned char*sha1); 953 954/* 955 * Return an abbreviated sha1 unique within this repository's object database. 956 * The result will be at least `len` characters long, and will be NUL 957 * terminated. 958 * 959 * The non-`_r` version returns a static buffer which remains valid until 4 960 * more calls to find_unique_abbrev are made. 961 * 962 * The `_r` variant writes to a buffer supplied by the caller, which must be at 963 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 964 * written (excluding the NUL terminator). 965 * 966 * Note that while this version avoids the static buffer, it is not fully 967 * reentrant, as it calls into other non-reentrant git code. 968 */ 969externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 970externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 971 972externconst unsigned char null_sha1[GIT_MAX_RAWSZ]; 973externconst struct object_id null_oid; 974 975staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 976{ 977returnmemcmp(sha1, sha2, GIT_SHA1_RAWSZ); 978} 979 980staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 981{ 982returnhashcmp(oid1->hash, oid2->hash); 983} 984 985staticinlineintis_null_sha1(const unsigned char*sha1) 986{ 987return!hashcmp(sha1, null_sha1); 988} 989 990staticinlineintis_null_oid(const struct object_id *oid) 991{ 992return!hashcmp(oid->hash, null_sha1); 993} 994 995staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src) 996{ 997memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 998} 9991000staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src)1001{1002hashcpy(dst->hash, src->hash);1003}10041005staticinlinestruct object_id *oiddup(const struct object_id *src)1006{1007struct object_id *dst =xmalloc(sizeof(struct object_id));1008oidcpy(dst, src);1009return dst;1010}10111012staticinlinevoidhashclr(unsigned char*hash)1013{1014memset(hash,0, GIT_SHA1_RAWSZ);1015}10161017staticinlinevoidoidclr(struct object_id *oid)1018{1019hashclr(oid->hash);1020}102110221023#define EMPTY_TREE_SHA1_HEX \1024"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1025#define EMPTY_TREE_SHA1_BIN_LITERAL \1026"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1027"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1028externconst struct object_id empty_tree_oid;1029#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10301031#define EMPTY_BLOB_SHA1_HEX \1032"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1033#define EMPTY_BLOB_SHA1_BIN_LITERAL \1034"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1035"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1036externconst struct object_id empty_blob_oid;1037#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)103810391040staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1041{1042return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1043}10441045staticinlineintis_empty_blob_oid(const struct object_id *oid)1046{1047return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1048}10491050staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1051{1052return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1053}10541055staticinlineintis_empty_tree_oid(const struct object_id *oid)1056{1057return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1058}10591060/* set default permissions by passing mode arguments to open(2) */1061intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1062intgit_mkstemp_mode(char*pattern,int mode);10631064/*1065 * NOTE NOTE NOTE!!1066 *1067 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1068 * not be changed. Old repositories have core.sharedrepository written in1069 * numeric format, and therefore these values are preserved for compatibility1070 * reasons.1071 */1072enum sharedrepo {1073 PERM_UMASK =0,1074 OLD_PERM_GROUP =1,1075 OLD_PERM_EVERYBODY =2,1076 PERM_GROUP =0660,1077 PERM_EVERYBODY =06641078};1079intgit_config_perm(const char*var,const char*value);1080intadjust_shared_perm(const char*path);10811082/*1083 * Create the directory containing the named path, using care to be1084 * somewhat safe against races. Return one of the scld_error values to1085 * indicate success/failure. On error, set errno to describe the1086 * problem.1087 *1088 * SCLD_VANISHED indicates that one of the ancestor directories of the1089 * path existed at one point during the function call and then1090 * suddenly vanished, probably because another process pruned the1091 * directory while we were working. To be robust against this kind of1092 * race, callers might want to try invoking the function again when it1093 * returns SCLD_VANISHED.1094 *1095 * safe_create_leading_directories() temporarily changes path while it1096 * is working but restores it before returning.1097 * safe_create_leading_directories_const() doesn't modify path, even1098 * temporarily.1099 */1100enum scld_error {1101 SCLD_OK =0,1102 SCLD_FAILED = -1,1103 SCLD_PERMS = -2,1104 SCLD_EXISTS = -3,1105 SCLD_VANISHED = -41106};1107enum scld_error safe_create_leading_directories(char*path);1108enum scld_error safe_create_leading_directories_const(const char*path);11091110/*1111 * Callback function for raceproof_create_file(). This function is1112 * expected to do something that makes dirname(path) permanent despite1113 * the fact that other processes might be cleaning up empty1114 * directories at the same time. Usually it will create a file named1115 * path, but alternatively it could create another file in that1116 * directory, or even chdir() into that directory. The function should1117 * return 0 if the action was completed successfully. On error, it1118 * should return a nonzero result and set errno.1119 * raceproof_create_file() treats two errno values specially:1120 *1121 * - ENOENT -- dirname(path) does not exist. In this case,1122 * raceproof_create_file() tries creating dirname(path)1123 * (and any parent directories, if necessary) and calls1124 * the function again.1125 *1126 * - EISDIR -- the file already exists and is a directory. In this1127 * case, raceproof_create_file() removes the directory if1128 * it is empty (and recursively any empty directories that1129 * it contains) and calls the function again.1130 *1131 * Any other errno causes raceproof_create_file() to fail with the1132 * callback's return value and errno.1133 *1134 * Obviously, this function should be OK with being called again if it1135 * fails with ENOENT or EISDIR. In other scenarios it will not be1136 * called again.1137 */1138typedefintcreate_file_fn(const char*path,void*cb);11391140/*1141 * Create a file in dirname(path) by calling fn, creating leading1142 * directories if necessary. Retry a few times in case we are racing1143 * with another process that is trying to clean up the directory that1144 * contains path. See the documentation for create_file_fn for more1145 * details.1146 *1147 * Return the value and set the errno that resulted from the most1148 * recent call of fn. fn is always called at least once, and will be1149 * called more than once if it returns ENOENT or EISDIR.1150 */1151intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11521153intmkdir_in_gitdir(const char*path);1154externchar*expand_user_path(const char*path,int real_home);1155const char*enter_repo(const char*path,int strict);1156staticinlineintis_absolute_path(const char*path)1157{1158returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1159}1160intis_directory(const char*);1161char*strbuf_realpath(struct strbuf *resolved,const char*path,1162int die_on_error);1163const char*real_path(const char*path);1164const char*real_path_if_valid(const char*path);1165char*real_pathdup(const char*path,int die_on_error);1166const char*absolute_path(const char*path);1167char*absolute_pathdup(const char*path);1168const char*remove_leading_path(const char*in,const char*prefix);1169const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1170intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1171intnormalize_path_copy(char*dst,const char*src);1172intlongest_ancestor_length(const char*path,struct string_list *prefixes);1173char*strip_path_suffix(const char*path,const char*suffix);1174intdaemon_avoid_alias(const char*path);1175externintis_ntfs_dotgit(const char*name);11761177/*1178 * Returns true iff "str" could be confused as a command-line option when1179 * passed to a sub-program like "ssh". Note that this has nothing to do with1180 * shell-quoting, which should be handled separately; we're assuming here that1181 * the string makes it verbatim to the sub-program.1182 */1183intlooks_like_command_line_option(const char*str);11841185/**1186 * Return a newly allocated string with the evaluation of1187 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1188 * "$HOME/.config/git/$filename". Return NULL upon error.1189 */1190externchar*xdg_config_home(const char*filename);11911192/**1193 * Return a newly allocated string with the evaluation of1194 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1195 * "$HOME/.cache/git/$filename". Return NULL upon error.1196 */1197externchar*xdg_cache_home(const char*filename);11981199externvoid*read_sha1_file_extended(const unsigned char*sha1,1200enum object_type *type,1201unsigned long*size,int lookup_replace);1202staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1203{1204returnread_sha1_file_extended(sha1, type, size,1);1205}12061207/*1208 * This internal function is only declared here for the benefit of1209 * lookup_replace_object(). Please do not call it directly.1210 */1211externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);12121213/*1214 * If object sha1 should be replaced, return the replacement object's1215 * name (replaced recursively, if necessary). The return value is1216 * either sha1 or a pointer to a permanently-allocated value. When1217 * object replacement is suppressed, always return sha1.1218 */1219staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1220{1221if(!check_replace_refs)1222return sha1;1223returndo_lookup_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,struct object_id *oid,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);12381239externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);12401241externintfinalize_object_file(const char*tmpfile,const char*filename);12421243/*1244 * Open the loose object at path, check its sha1, and return the contents,1245 * type, and size. If the object is a blob, then "contents" may return NULL,1246 * to allow streaming of large blobs.1247 *1248 * Returns 0 on success, negative on error (details may be written to stderr).1249 */1250intread_loose_object(const char*path,1251const unsigned char*expected_sha1,1252enum object_type *type,1253unsigned long*size,1254void**contents);12551256/*1257 * Convenience for sha1_object_info_extended() with a NULL struct1258 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass1259 * nonzero flags to also set other flags.1260 */1261externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1262staticinlineinthas_sha1_file(const unsigned char*sha1)1263{1264returnhas_sha1_file_with_flags(sha1,0);1265}12661267/* Same as the above, except for struct object_id. */1268externinthas_object_file(const struct object_id *oid);1269externinthas_object_file_with_flags(const struct object_id *oid,int flags);12701271/*1272 * Return true iff an alternate object database has a loose object1273 * with the specified name. This function does not respect replace1274 * references.1275 */1276externinthas_loose_object_nonlocal(const unsigned char*sha1);12771278externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);12791280/* Helper to check and "touch" a file */1281externintcheck_and_freshen_file(const char*fn,int freshen);12821283externconst signed char hexval_table[256];1284staticinlineunsigned inthexval(unsigned char c)1285{1286return hexval_table[c];1287}12881289/*1290 * Convert two consecutive hexadecimal digits into a char. Return a1291 * negative value on error. Don't run over the end of short strings.1292 */1293staticinlineinthex2chr(const char*s)1294{1295unsigned int val =hexval(s[0]);1296return(val & ~0xf) ? val : (val <<4) |hexval(s[1]);1297}12981299/* Convert to/from hex/sha1 representation */1300#define MINIMUM_ABBREV minimum_abbrev1301#define DEFAULT_ABBREV default_abbrev13021303/* used when the code does not know or care what the default abbrev is */1304#define FALLBACK_DEFAULT_ABBREV 713051306struct object_context {1307unsigned char tree[20];1308unsigned mode;1309/*1310 * symlink_path is only used by get_tree_entry_follow_symlinks,1311 * and only for symlinks that point outside the repository.1312 */1313struct strbuf symlink_path;1314/*1315 * If GET_OID_RECORD_PATH is set, this will record path (if any)1316 * found when resolving the name. The caller is responsible for1317 * releasing the memory.1318 */1319char*path;1320};13211322#define GET_OID_QUIETLY 011323#define GET_OID_COMMIT 021324#define GET_OID_COMMITTISH 041325#define GET_OID_TREE 0101326#define GET_OID_TREEISH 0201327#define GET_OID_BLOB 0401328#define GET_OID_FOLLOW_SYMLINKS 01001329#define GET_OID_RECORD_PATH 02001330#define GET_OID_ONLY_TO_DIE 0400013311332#define GET_OID_DISAMBIGUATORS \1333 (GET_OID_COMMIT | GET_OID_COMMITTISH | \1334 GET_OID_TREE | GET_OID_TREEISH | \1335 GET_OID_BLOB)13361337externintget_oid(const char*str,struct object_id *oid);1338externintget_oid_commit(const char*str,struct object_id *oid);1339externintget_oid_committish(const char*str,struct object_id *oid);1340externintget_oid_tree(const char*str,struct object_id *oid);1341externintget_oid_treeish(const char*str,struct object_id *oid);1342externintget_oid_blob(const char*str,struct object_id *oid);1343externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1344externintget_oid_with_context(const char*str,unsigned flags,struct object_id *oid,struct object_context *oc);134513461347typedefinteach_abbrev_fn(const struct object_id *oid,void*);1348externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13491350externintset_disambiguate_hint_config(const char*var,const char*value);13511352/*1353 * Try to read a SHA1 in hexadecimal format from the 40 characters1354 * starting at hex. Write the 20-byte result to sha1 in binary form.1355 * Return 0 on success. Reading stops if a NUL is encountered in the1356 * input, so it is safe to pass this function an arbitrary1357 * null-terminated string.1358 */1359externintget_sha1_hex(const char*hex,unsigned char*sha1);1360externintget_oid_hex(const char*hex,struct object_id *sha1);13611362/*1363 * Read `len` pairs of hexadecimal digits from `hex` and write the1364 * values to `binary` as `len` bytes. Return 0 on success, or -1 if1365 * the input does not consist of hex digits).1366 */1367externinthex_to_bytes(unsigned char*binary,const char*hex,size_t len);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(timestamp_t time,int timezone,const struct date_mode *mode);1467voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1468struct strbuf *timebuf);1469intparse_date(const char*date,struct strbuf *out);1470intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1471intparse_expiry_date(const char*date, timestamp_t *timestamp);1472voiddatestamp(struct strbuf *out);1473#define approxidate(s) approxidate_careful((s), NULL)1474timestamp_t approxidate_careful(const char*,int*);1475timestamp_t approxidate_relative(const char*date,const struct timeval *now);1476voidparse_date_format(const char*format,struct date_mode *mode);1477intdate_overflows(timestamp_t 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;1530struct delayed_checkout *delayed_checkout;1531unsigned force:1,1532 quiet:1,1533 not_new:1,1534 refresh_cache:1;1535};1536#define CHECKOUT_INIT { NULL,"" }15371538#define TEMPORARY_FILENAME_LENGTH 251539externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);1540externvoidenable_delayed_checkout(struct checkout *state);1541externintfinish_delayed_checkout(struct checkout *state);15421543struct cache_def {1544struct strbuf path;1545int flags;1546int track_flags;1547int prefix_len_stat_func;1548};1549#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1550staticinlinevoidcache_def_clear(struct cache_def *cache)1551{1552strbuf_release(&cache->path);1553}15541555externinthas_symlink_leading_path(const char*name,int len);1556externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1557externintcheck_leading_path(const char*name,int len);1558externinthas_dirs_only_path(const char*name,int len,int prefix_len);1559externvoidschedule_dir_for_removal(const char*name,int len);1560externvoidremove_scheduled_dirs(void);15611562externstruct alternate_object_database {1563struct alternate_object_database *next;15641565/* see alt_scratch_buf() */1566struct strbuf scratch;1567size_t base_len;15681569/*1570 * Used to store the results of readdir(3) calls when searching1571 * for unique abbreviated hashes. This cache is never1572 * invalidated, thus it's racy and not necessarily accurate.1573 * That's fine for its purpose; don't use it for tasks requiring1574 * greater accuracy!1575 */1576char loose_objects_subdir_seen[256];1577struct oid_array loose_objects_cache;15781579char path[FLEX_ARRAY];1580} *alt_odb_list;1581externvoidprepare_alt_odb(void);1582externchar*compute_alternate_path(const char*path,struct strbuf *err);1583typedefintalt_odb_fn(struct alternate_object_database *,void*);1584externintforeach_alt_odb(alt_odb_fn,void*);15851586/*1587 * Allocate a "struct alternate_object_database" but do _not_ actually1588 * add it to the list of alternates.1589 */1590struct alternate_object_database *alloc_alt_odb(const char*dir);15911592/*1593 * Add the directory to the on-disk alternates file; the new entry will also1594 * take effect in the current process.1595 */1596externvoidadd_to_alternates_file(const char*dir);15971598/*1599 * Add the directory to the in-memory list of alternates (along with any1600 * recursive alternates it points to), but do not modify the on-disk alternates1601 * file.1602 */1603externvoidadd_to_alternates_memory(const char*dir);16041605/*1606 * Returns a scratch strbuf pre-filled with the alternate object directory,1607 * including a trailing slash, which can be used to access paths in the1608 * alternate. Always use this over direct access to alt->scratch, as it1609 * cleans up any previous use of the scratch buffer.1610 */1611externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);16121613struct pack_window {1614struct pack_window *next;1615unsigned char*base;1616 off_t offset;1617size_t len;1618unsigned int last_used;1619unsigned int inuse_cnt;1620};16211622externstruct packed_git {1623struct packed_git *next;1624struct pack_window *windows;1625 off_t pack_size;1626const void*index_data;1627size_t index_size;1628uint32_t num_objects;1629uint32_t num_bad_objects;1630unsigned char*bad_object_sha1;1631int index_version;1632time_t mtime;1633int pack_fd;1634unsigned pack_local:1,1635 pack_keep:1,1636 freshened:1,1637 do_not_close:1;1638unsigned char sha1[20];1639struct revindex_entry *revindex;1640/* something like ".git/objects/pack/xxxxx.pack" */1641char pack_name[FLEX_ARRAY];/* more */1642} *packed_git;16431644/*1645 * A most-recently-used ordered version of the packed_git list, which can1646 * be iterated instead of packed_git (and marked via mru_mark).1647 */1648externstruct mru packed_git_mru;16491650struct pack_entry {1651 off_t offset;1652unsigned char sha1[20];1653struct packed_git *p;1654};16551656/*1657 * Create a temporary file rooted in the object database directory, or1658 * die on failure. The filename is taken from "pattern", which should have the1659 * usual "XXXXXX" trailer, and the resulting filename is written into the1660 * "template" buffer. Returns the open descriptor.1661 */1662externintodb_mkstemp(struct strbuf *template,const char*pattern);16631664/*1665 * Create a pack .keep file named "name" (which should generally be the output1666 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1667 * error.1668 */1669externintodb_pack_keep(const char*name);16701671/*1672 * Iterate over the files in the loose-object parts of the object1673 * directory "path", triggering the following callbacks:1674 *1675 * - loose_object is called for each loose object we find.1676 *1677 * - loose_cruft is called for any files that do not appear to be1678 * loose objects. Note that we only look in the loose object1679 * directories "objects/[0-9a-f]{2}/", so we will not report1680 * "objects/foobar" as cruft.1681 *1682 * - loose_subdir is called for each top-level hashed subdirectory1683 * of the object directory (e.g., "$OBJDIR/f0"). It is called1684 * after the objects in the directory are processed.1685 *1686 * Any callback that is NULL will be ignored. Callbacks returning non-zero1687 * will end the iteration.1688 *1689 * In the "buf" variant, "path" is a strbuf which will also be used as a1690 * scratch buffer, but restored to its original contents before1691 * the function returns.1692 */1693typedefinteach_loose_object_fn(const struct object_id *oid,1694const char*path,1695void*data);1696typedefinteach_loose_cruft_fn(const char*basename,1697const char*path,1698void*data);1699typedefinteach_loose_subdir_fn(unsigned int nr,1700const char*path,1701void*data);1702intfor_each_file_in_obj_subdir(unsigned int subdir_nr,1703struct strbuf *path,1704 each_loose_object_fn obj_cb,1705 each_loose_cruft_fn cruft_cb,1706 each_loose_subdir_fn subdir_cb,1707void*data);1708intfor_each_loose_file_in_objdir(const char*path,1709 each_loose_object_fn obj_cb,1710 each_loose_cruft_fn cruft_cb,1711 each_loose_subdir_fn subdir_cb,1712void*data);1713intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1714 each_loose_object_fn obj_cb,1715 each_loose_cruft_fn cruft_cb,1716 each_loose_subdir_fn subdir_cb,1717void*data);17181719/*1720 * Iterate over loose objects in both the local1721 * repository and any alternates repositories (unless the1722 * LOCAL_ONLY flag is set).1723 */1724#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11725externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);17261727struct object_info {1728/* Request */1729enum object_type *typep;1730unsigned long*sizep;1731 off_t *disk_sizep;1732unsigned char*delta_base_sha1;1733struct strbuf *typename;1734void**contentp;17351736/* Response */1737enum{1738 OI_CACHED,1739 OI_LOOSE,1740 OI_PACKED,1741 OI_DBCACHED1742} whence;1743union{1744/*1745 * struct {1746 * ... Nothing to expose in this case1747 * } cached;1748 * struct {1749 * ... Nothing to expose in this case1750 * } loose;1751 */1752struct{1753struct packed_git *pack;1754 off_t offset;1755unsigned int is_delta;1756} packed;1757} u;1758};17591760/*1761 * Initializer for a "struct object_info" that wants no items. You may1762 * also memset() the memory to all-zeroes.1763 */1764#define OBJECT_INFO_INIT {NULL}17651766/* Invoke lookup_replace_object() on the given hash */1767#define OBJECT_INFO_LOOKUP_REPLACE 11768/* Allow reading from a loose object file of unknown/bogus type */1769#define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 21770/* Do not check cached storage */1771#define OBJECT_INFO_SKIP_CACHED 41772/* Do not retry packed storage after checking packed and loose storage */1773#define OBJECT_INFO_QUICK 81774externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);17751776/* Dumb servers support */1777externintupdate_server_info(int);17781779externconst char*get_log_output_encoding(void);1780externconst char*get_commit_output_encoding(void);17811782/*1783 * This is a hack for test programs like test-dump-untracked-cache to1784 * ensure that they do not modify the untracked cache when reading it.1785 * Do not use it otherwise!1786 */1787externint ignore_untracked_cache_config;17881789externintcommitter_ident_sufficiently_given(void);1790externintauthor_ident_sufficiently_given(void);17911792externconst char*git_commit_encoding;1793externconst char*git_log_output_encoding;1794externconst char*git_mailmap_file;1795externconst char*git_mailmap_blob;17961797/* IO helper functions */1798externvoidmaybe_flush_or_die(FILE*,const char*);1799__attribute__((format(printf,2,3)))1800externvoidfprintf_or_die(FILE*,const char*fmt, ...);18011802#define COPY_READ_ERROR (-2)1803#define COPY_WRITE_ERROR (-3)1804externintcopy_fd(int ifd,int ofd);1805externintcopy_file(const char*dst,const char*src,int mode);1806externintcopy_file_with_time(const char*dst,const char*src,int mode);18071808externvoidwrite_or_die(int fd,const void*buf,size_t count);1809externvoidfsync_or_die(int fd,const char*);18101811extern ssize_t read_in_full(int fd,void*buf,size_t count);1812extern ssize_t write_in_full(int fd,const void*buf,size_t count);1813extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);18141815staticinline ssize_t write_str_in_full(int fd,const char*str)1816{1817returnwrite_in_full(fd, str,strlen(str));1818}18191820/**1821 * Open (and truncate) the file at path, write the contents of buf to it,1822 * and close it. Dies if any errors are encountered.1823 */1824externvoidwrite_file_buf(const char*path,const char*buf,size_t len);18251826/**1827 * Like write_file_buf(), but format the contents into a buffer first.1828 * Additionally, write_file() will append a newline if one is not already1829 * present, making it convenient to write text files:1830 *1831 * write_file(path, "counter: %d", ctr);1832 */1833__attribute__((format(printf,2,3)))1834externvoidwrite_file(const char*path,const char*fmt, ...);18351836/* pager.c */1837externvoidsetup_pager(void);1838externintpager_in_use(void);1839externint pager_use_color;1840externintterm_columns(void);1841externintdecimal_width(uintmax_t);1842externintcheck_pager_config(const char*cmd);1843externvoidprepare_pager_args(struct child_process *,const char*pager);18441845externconst char*editor_program;1846externconst char*askpass_program;1847externconst char*excludes_file;18481849/* base85 */1850intdecode_85(char*dst,const char*line,int linelen);1851voidencode_85(char*buf,const unsigned char*data,int bytes);18521853/* alloc.c */1854externvoid*alloc_blob_node(void);1855externvoid*alloc_tree_node(void);1856externvoid*alloc_commit_node(void);1857externvoid*alloc_tag_node(void);1858externvoid*alloc_object_node(void);1859externvoidalloc_report(void);1860externunsigned intalloc_commit_index(void);18611862/* pkt-line.c */1863voidpacket_trace_identity(const char*prog);18641865/* add */1866/*1867 * return 0 if success, 1 - if addition of a file failed and1868 * ADD_FILES_IGNORE_ERRORS was specified in flags1869 */1870intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);18711872/* diff.c */1873externint diff_auto_refresh_index;18741875/* match-trees.c */1876voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1877voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);18781879/*1880 * whitespace rules.1881 * used by both diff and apply1882 * last two digits are tab width1883 */1884#define WS_BLANK_AT_EOL 01001885#define WS_SPACE_BEFORE_TAB 02001886#define WS_INDENT_WITH_NON_TAB 04001887#define WS_CR_AT_EOL 010001888#define WS_BLANK_AT_EOF 020001889#define WS_TAB_IN_INDENT 040001890#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1891#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1892#define WS_TAB_WIDTH_MASK 0771893/* All WS_* -- when extended, adapt diff.c emit_symbol */1894#define WS_RULE_MASK 077771895externunsigned whitespace_rule_cfg;1896externunsignedwhitespace_rule(const char*);1897externunsignedparse_whitespace_rule(const char*);1898externunsignedws_check(const char*line,int len,unsigned ws_rule);1899externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1900externchar*whitespace_error_string(unsigned ws);1901externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1902externintws_blank_line(const char*line,int len,unsigned ws_rule);1903#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)19041905/* ls-files */1906voidoverlay_tree_on_index(struct index_state *istate,1907const char*tree_name,const char*prefix);19081909char*alias_lookup(const char*alias);1910intsplit_cmdline(char*cmdline,const char***argv);1911/* Takes a negative value returned by split_cmdline */1912const char*split_cmdline_strerror(int cmdline_errno);19131914/* setup.c */1915struct startup_info {1916int have_repository;1917const char*prefix;1918};1919externstruct startup_info *startup_info;19201921/* merge.c */1922struct commit_list;1923inttry_merge_command(const char*strategy,size_t xopts_nr,1924const char**xopts,struct commit_list *common,1925const char*head_arg,struct commit_list *remotes);1926intcheckout_fast_forward(const struct object_id *from,1927const struct object_id *to,1928int overwrite_ignore);192919301931intsane_execvp(const char*file,char*const argv[]);19321933/*1934 * A struct to encapsulate the concept of whether a file has changed1935 * since we last checked it. This uses criteria similar to those used1936 * for the index.1937 */1938struct stat_validity {1939struct stat_data *sd;1940};19411942voidstat_validity_clear(struct stat_validity *sv);19431944/*1945 * Returns 1 if the path is a regular file (or a symlink to a regular1946 * file) and matches the saved stat_validity, 0 otherwise. A missing1947 * or inaccessible file is considered a match if the struct was just1948 * initialized, or if the previous update found an inaccessible file.1949 */1950intstat_validity_check(struct stat_validity *sv,const char*path);19511952/*1953 * Update the stat_validity from a file opened at descriptor fd. If1954 * the file is missing, inaccessible, or not a regular file, then1955 * future calls to stat_validity_check will match iff one of those1956 * conditions continues to be true.1957 */1958voidstat_validity_update(struct stat_validity *sv,int fd);19591960intversioncmp(const char*s1,const char*s2);1961voidsleep_millisec(int millisec);19621963/*1964 * Create a directory and (if share is nonzero) adjust its permissions1965 * according to the shared_repository setting. Only use this for1966 * directories under $GIT_DIR. Don't use it for working tree1967 * directories.1968 */1969voidsafe_create_dir(const char*dir,int share);19701971#endif/* CACHE_H */