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#include"repository.h" 18 19#ifndef platform_SHA_CTX 20/* 21 * platform's underlying implementation of SHA-1; could be OpenSSL, 22 * blk_SHA, Apple CommonCrypto, etc... Note that including 23 * SHA1_HEADER may have already defined platform_SHA_CTX for our 24 * own implementations like block-sha1 and ppc-sha1, so we list 25 * the default for OpenSSL compatible SHA-1 implementations here. 26 */ 27#define platform_SHA_CTX SHA_CTX 28#define platform_SHA1_Init SHA1_Init 29#define platform_SHA1_Update SHA1_Update 30#define platform_SHA1_Final SHA1_Final 31#endif 32 33#define git_SHA_CTX platform_SHA_CTX 34#define git_SHA1_Init platform_SHA1_Init 35#define git_SHA1_Update platform_SHA1_Update 36#define git_SHA1_Final platform_SHA1_Final 37 38#ifdef SHA1_MAX_BLOCK_SIZE 39#include"compat/sha1-chunked.h" 40#undef git_SHA1_Update 41#define git_SHA1_Update git_SHA1_Update_Chunked 42#endif 43 44#include <zlib.h> 45typedefstruct git_zstream { 46 z_stream z; 47unsigned long avail_in; 48unsigned long avail_out; 49unsigned long total_in; 50unsigned long total_out; 51unsigned char*next_in; 52unsigned char*next_out; 53} git_zstream; 54 55voidgit_inflate_init(git_zstream *); 56voidgit_inflate_init_gzip_only(git_zstream *); 57voidgit_inflate_end(git_zstream *); 58intgit_inflate(git_zstream *,int flush); 59 60voidgit_deflate_init(git_zstream *,int level); 61voidgit_deflate_init_gzip(git_zstream *,int level); 62voidgit_deflate_init_raw(git_zstream *,int level); 63voidgit_deflate_end(git_zstream *); 64intgit_deflate_abort(git_zstream *); 65intgit_deflate_end_gently(git_zstream *); 66intgit_deflate(git_zstream *,int flush); 67unsigned longgit_deflate_bound(git_zstream *,unsigned long); 68 69/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 70#define GIT_SHA1_RAWSZ 20 71#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 72 73/* The length in byte and in hex digits of the largest possible hash value. */ 74#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 75#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 76 77struct object_id { 78unsigned char hash[GIT_MAX_RAWSZ]; 79}; 80 81#define the_hash_algo the_repository->hash_algo 82 83#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 84#define DTYPE(de) ((de)->d_type) 85#else 86#undef DT_UNKNOWN 87#undef DT_DIR 88#undef DT_REG 89#undef DT_LNK 90#define DT_UNKNOWN 0 91#define DT_DIR 1 92#define DT_REG 2 93#define DT_LNK 3 94#define DTYPE(de) DT_UNKNOWN 95#endif 96 97/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 98#define S_IFINVALID 0030000 99 100/* 101 * A "directory link" is a link to another git directory. 102 * 103 * The value 0160000 is not normally a valid mode, and 104 * also just happens to be S_IFDIR + S_IFLNK 105 */ 106#define S_IFGITLINK 0160000 107#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 108 109/* 110 * Some mode bits are also used internally for computations. 111 * 112 * They *must* not overlap with any valid modes, and they *must* not be emitted 113 * to outside world - i.e. appear on disk or network. In other words, it's just 114 * temporary fields, which we internally use, but they have to stay in-house. 115 * 116 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 117 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 118 */ 119 120/* used internally in tree-diff */ 121#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 122 123 124/* 125 * Intensive research over the course of many years has shown that 126 * port 9418 is totally unused by anything else. Or 127 * 128 * Your search - "port 9418" - did not match any documents. 129 * 130 * as www.google.com puts it. 131 * 132 * This port has been properly assigned for git use by IANA: 133 * git (Assigned-9418) [I06-050728-0001]. 134 * 135 * git 9418/tcp git pack transfer service 136 * git 9418/udp git pack transfer service 137 * 138 * with Linus Torvalds <torvalds@osdl.org> as the point of 139 * contact. September 2005. 140 * 141 * See http://www.iana.org/assignments/port-numbers 142 */ 143#define DEFAULT_GIT_PORT 9418 144 145/* 146 * Basic data structures for the directory cache 147 */ 148 149#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 150struct cache_header { 151uint32_t hdr_signature; 152uint32_t hdr_version; 153uint32_t hdr_entries; 154}; 155 156#define INDEX_FORMAT_LB 2 157#define INDEX_FORMAT_UB 4 158 159/* 160 * The "cache_time" is just the low 32 bits of the 161 * time. It doesn't matter if it overflows - we only 162 * check it for equality in the 32 bits we save. 163 */ 164struct cache_time { 165uint32_t sec; 166uint32_t nsec; 167}; 168 169struct stat_data { 170struct cache_time sd_ctime; 171struct cache_time sd_mtime; 172unsigned int sd_dev; 173unsigned int sd_ino; 174unsigned int sd_uid; 175unsigned int sd_gid; 176unsigned int sd_size; 177}; 178 179struct cache_entry { 180struct hashmap_entry ent; 181struct stat_data ce_stat_data; 182unsigned int ce_mode; 183unsigned int ce_flags; 184unsigned int ce_namelen; 185unsigned int index;/* for link extension */ 186struct object_id oid; 187char name[FLEX_ARRAY];/* more */ 188}; 189 190#define CE_STAGEMASK (0x3000) 191#define CE_EXTENDED (0x4000) 192#define CE_VALID (0x8000) 193#define CE_STAGESHIFT 12 194 195/* 196 * Range 0xFFFF0FFF in ce_flags is divided into 197 * two parts: in-memory flags and on-disk ones. 198 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 199 * if you want to save a new flag, add it in 200 * CE_EXTENDED_FLAGS 201 * 202 * In-memory only flags 203 */ 204#define CE_UPDATE (1 << 16) 205#define CE_REMOVE (1 << 17) 206#define CE_UPTODATE (1 << 18) 207#define CE_ADDED (1 << 19) 208 209#define CE_HASHED (1 << 20) 210#define CE_FSMONITOR_VALID (1 << 21) 211#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 212#define CE_CONFLICTED (1 << 23) 213 214#define CE_UNPACKED (1 << 24) 215#define CE_NEW_SKIP_WORKTREE (1 << 25) 216 217/* used to temporarily mark paths matched by pathspecs */ 218#define CE_MATCHED (1 << 26) 219 220#define CE_UPDATE_IN_BASE (1 << 27) 221#define CE_STRIP_NAME (1 << 28) 222 223/* 224 * Extended on-disk flags 225 */ 226#define CE_INTENT_TO_ADD (1 << 29) 227#define CE_SKIP_WORKTREE (1 << 30) 228/* CE_EXTENDED2 is for future extension */ 229#define CE_EXTENDED2 (1U << 31) 230 231#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 232 233/* 234 * Safeguard to avoid saving wrong flags: 235 * - CE_EXTENDED2 won't get saved until its semantic is known 236 * - Bits in 0x0000FFFF have been saved in ce_flags already 237 * - Bits in 0x003F0000 are currently in-memory flags 238 */ 239#if CE_EXTENDED_FLAGS & 0x803FFFFF 240#error"CE_EXTENDED_FLAGS out of range" 241#endif 242 243/* Forward structure decls */ 244struct pathspec; 245struct child_process; 246 247/* 248 * Copy the sha1 and stat state of a cache entry from one to 249 * another. But we never change the name, or the hash state! 250 */ 251staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 252const struct cache_entry *src) 253{ 254unsigned int state = dst->ce_flags & CE_HASHED; 255 256/* Don't copy hash chain and name */ 257memcpy(&dst->ce_stat_data, &src->ce_stat_data, 258offsetof(struct cache_entry, name) - 259offsetof(struct cache_entry, ce_stat_data)); 260 261/* Restore the hash state */ 262 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 263} 264 265staticinlineunsignedcreate_ce_flags(unsigned stage) 266{ 267return(stage << CE_STAGESHIFT); 268} 269 270#define ce_namelen(ce) ((ce)->ce_namelen) 271#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 272#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 273#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 274#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 275#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 276#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 277 278#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 279staticinlineunsigned intcreate_ce_mode(unsigned int mode) 280{ 281if(S_ISLNK(mode)) 282return S_IFLNK; 283if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 284return S_IFGITLINK; 285return S_IFREG |ce_permissions(mode); 286} 287staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 288unsigned int mode) 289{ 290externint trust_executable_bit, has_symlinks; 291if(!has_symlinks &&S_ISREG(mode) && 292 ce &&S_ISLNK(ce->ce_mode)) 293return ce->ce_mode; 294if(!trust_executable_bit &&S_ISREG(mode)) { 295if(ce &&S_ISREG(ce->ce_mode)) 296return ce->ce_mode; 297returncreate_ce_mode(0666); 298} 299returncreate_ce_mode(mode); 300} 301staticinlineintce_to_dtype(const struct cache_entry *ce) 302{ 303unsigned ce_mode =ntohl(ce->ce_mode); 304if(S_ISREG(ce_mode)) 305return DT_REG; 306else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 307return DT_DIR; 308else if(S_ISLNK(ce_mode)) 309return DT_LNK; 310else 311return DT_UNKNOWN; 312} 313staticinlineunsigned intcanon_mode(unsigned int mode) 314{ 315if(S_ISREG(mode)) 316return S_IFREG |ce_permissions(mode); 317if(S_ISLNK(mode)) 318return S_IFLNK; 319if(S_ISDIR(mode)) 320return S_IFDIR; 321return S_IFGITLINK; 322} 323 324#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 325 326#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 327#define CE_ENTRY_CHANGED (1 << 1) 328#define CE_ENTRY_REMOVED (1 << 2) 329#define CE_ENTRY_ADDED (1 << 3) 330#define RESOLVE_UNDO_CHANGED (1 << 4) 331#define CACHE_TREE_CHANGED (1 << 5) 332#define SPLIT_INDEX_ORDERED (1 << 6) 333#define UNTRACKED_CHANGED (1 << 7) 334#define FSMONITOR_CHANGED (1 << 8) 335 336struct split_index; 337struct untracked_cache; 338 339struct index_state { 340struct cache_entry **cache; 341unsigned int version; 342unsigned int cache_nr, cache_alloc, cache_changed; 343struct string_list *resolve_undo; 344struct cache_tree *cache_tree; 345struct split_index *split_index; 346struct cache_time timestamp; 347unsigned name_hash_initialized :1, 348 initialized :1; 349struct hashmap name_hash; 350struct hashmap dir_hash; 351unsigned char sha1[20]; 352struct untracked_cache *untracked; 353uint64_t fsmonitor_last_update; 354struct ewah_bitmap *fsmonitor_dirty; 355}; 356 357externstruct index_state the_index; 358 359/* Name hashing */ 360externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 361externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 362externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 363externvoidfree_name_hash(struct index_state *istate); 364 365 366#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 367#define active_cache (the_index.cache) 368#define active_nr (the_index.cache_nr) 369#define active_alloc (the_index.cache_alloc) 370#define active_cache_changed (the_index.cache_changed) 371#define active_cache_tree (the_index.cache_tree) 372 373#define read_cache() read_index(&the_index) 374#define read_cache_from(path) read_index_from(&the_index, (path)) 375#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 376#define is_cache_unborn() is_index_unborn(&the_index) 377#define read_cache_unmerged() read_index_unmerged(&the_index) 378#define discard_cache() discard_index(&the_index) 379#define unmerged_cache() unmerged_index(&the_index) 380#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 381#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 382#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 383#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 384#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 385#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 386#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 387#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 388#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 389#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 390#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 391#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 392#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 393#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 394#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 395#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 396#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 397#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 398#endif 399 400enum object_type { 401 OBJ_BAD = -1, 402 OBJ_NONE =0, 403 OBJ_COMMIT =1, 404 OBJ_TREE =2, 405 OBJ_BLOB =3, 406 OBJ_TAG =4, 407/* 5 for future expansion */ 408 OBJ_OFS_DELTA =6, 409 OBJ_REF_DELTA =7, 410 OBJ_ANY, 411 OBJ_MAX 412}; 413 414staticinlineenum object_type object_type(unsigned int mode) 415{ 416returnS_ISDIR(mode) ? OBJ_TREE : 417S_ISGITLINK(mode) ? OBJ_COMMIT : 418 OBJ_BLOB; 419} 420 421/* Double-check local_repo_env below if you add to this list. */ 422#define GIT_DIR_ENVIRONMENT"GIT_DIR" 423#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 424#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 425#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 426#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 427#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 428#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 429#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 430#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 431#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 432#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 433#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 434#define CONFIG_ENVIRONMENT"GIT_CONFIG" 435#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 436#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 437#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 438#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 439#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 440#define GITATTRIBUTES_FILE".gitattributes" 441#define INFOATTRIBUTES_FILE"info/attributes" 442#define ATTRIBUTE_MACRO_PREFIX"[attr]" 443#define GITMODULES_FILE".gitmodules" 444#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 445#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 446#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 447#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 448#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 449#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 450#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 451#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 452#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 453#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 454#define GIT_OPTIONAL_LOCKS_ENVIRONMENT"GIT_OPTIONAL_LOCKS" 455 456/* 457 * Environment variable used in handshaking the wire protocol. 458 * Contains a colon ':' separated list of keys with optional values 459 * 'key[=value]'. Presence of unknown keys and values must be 460 * ignored. 461 */ 462#define GIT_PROTOCOL_ENVIRONMENT"GIT_PROTOCOL" 463/* HTTP header used to handshake the wire protocol */ 464#define GIT_PROTOCOL_HEADER"Git-Protocol" 465 466/* 467 * This environment variable is expected to contain a boolean indicating 468 * whether we should or should not treat: 469 * 470 * GIT_DIR=foo.git git ... 471 * 472 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 473 * of this, but we use it internally to communicate to sub-processes that we 474 * are in a bare repo. If not set, defaults to true. 475 */ 476#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 477 478/* 479 * Repository-local GIT_* environment variables; these will be cleared 480 * when git spawns a sub-process that runs inside another repository. 481 * The array is NULL-terminated, which makes it easy to pass in the "env" 482 * parameter of a run-command invocation, or to do a simple walk. 483 */ 484externconst char*const local_repo_env[]; 485 486externvoidsetup_git_env(void); 487 488/* 489 * Returns true iff we have a configured git repository (either via 490 * setup_git_directory, or in the environment via $GIT_DIR). 491 */ 492inthave_git_dir(void); 493 494externint is_bare_repository_cfg; 495externintis_bare_repository(void); 496externintis_inside_git_dir(void); 497externchar*git_work_tree_cfg; 498externintis_inside_work_tree(void); 499externconst char*get_git_dir(void); 500externconst char*get_git_common_dir(void); 501externchar*get_object_directory(void); 502externchar*get_index_file(void); 503externchar*get_graft_file(void); 504externintset_git_dir(const char*path); 505externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 506externintget_common_dir(struct strbuf *sb,const char*gitdir); 507externconst char*get_git_namespace(void); 508externconst char*strip_namespace(const char*namespaced_ref); 509externconst char*get_super_prefix(void); 510externconst char*get_git_work_tree(void); 511 512/* 513 * Return true if the given path is a git directory; note that this _just_ 514 * looks at the directory itself. If you want to know whether "foo/.git" 515 * is a repository, you must feed that path, not just "foo". 516 */ 517externintis_git_directory(const char*path); 518 519/* 520 * Return 1 if the given path is the root of a git repository or 521 * submodule, else 0. Will not return 1 for bare repositories with the 522 * exception of creating a bare repository in "foo/.git" and calling 523 * is_git_repository("foo"). 524 * 525 * If we run into read errors, we err on the side of saying "yes, it is", 526 * as we usually consider sub-repos precious, and would prefer to err on the 527 * side of not disrupting or deleting them. 528 */ 529externintis_nonbare_repository_dir(struct strbuf *path); 530 531#define READ_GITFILE_ERR_STAT_FAILED 1 532#define READ_GITFILE_ERR_NOT_A_FILE 2 533#define READ_GITFILE_ERR_OPEN_FAILED 3 534#define READ_GITFILE_ERR_READ_FAILED 4 535#define READ_GITFILE_ERR_INVALID_FORMAT 5 536#define READ_GITFILE_ERR_NO_PATH 6 537#define READ_GITFILE_ERR_NOT_A_REPO 7 538#define READ_GITFILE_ERR_TOO_LARGE 8 539externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 540externconst char*read_gitfile_gently(const char*path,int*return_error_code); 541#define read_gitfile(path) read_gitfile_gently((path), NULL) 542externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 543#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 544 545externvoidset_git_work_tree(const char*tree); 546 547#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 548 549externvoidsetup_work_tree(void); 550/* 551 * Find the commondir and gitdir of the repository that contains the current 552 * working directory, without changing the working directory or other global 553 * state. The result is appended to commondir and gitdir. If the discovered 554 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 555 * both have the same result appended to the buffer. The return value is 556 * either 0 upon success and non-zero if no repository was found. 557 */ 558externintdiscover_git_directory(struct strbuf *commondir, 559struct strbuf *gitdir); 560externconst char*setup_git_directory_gently(int*); 561externconst char*setup_git_directory(void); 562externchar*prefix_path(const char*prefix,int len,const char*path); 563externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 564 565/* 566 * Concatenate "prefix" (if len is non-zero) and "path", with no 567 * connecting characters (so "prefix" should end with a "/"). 568 * Unlike prefix_path, this should be used if the named file does 569 * not have to interact with index entry; i.e. name of a random file 570 * on the filesystem. 571 * 572 * The return value is always a newly allocated string (even if the 573 * prefix was empty). 574 */ 575externchar*prefix_filename(const char*prefix,const char*path); 576 577externintcheck_filename(const char*prefix,const char*name); 578externvoidverify_filename(const char*prefix, 579const char*name, 580int diagnose_misspelt_rev); 581externvoidverify_non_filename(const char*prefix,const char*name); 582externintpath_inside_repo(const char*prefix,const char*path); 583 584#define INIT_DB_QUIET 0x0001 585#define INIT_DB_EXIST_OK 0x0002 586 587externintinit_db(const char*git_dir,const char*real_git_dir, 588const char*template_dir,unsigned int flags); 589 590externvoidsanitize_stdfds(void); 591externintdaemonize(void); 592 593#define alloc_nr(x) (((x)+16)*3/2) 594 595/* 596 * Realloc the buffer pointed at by variable 'x' so that it can hold 597 * at least 'nr' entries; the number of entries currently allocated 598 * is 'alloc', using the standard growing factor alloc_nr() macro. 599 * 600 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 601 */ 602#define ALLOC_GROW(x, nr, alloc) \ 603 do { \ 604 if ((nr) > alloc) { \ 605 if (alloc_nr(alloc) < (nr)) \ 606 alloc = (nr); \ 607 else \ 608 alloc = alloc_nr(alloc); \ 609 REALLOC_ARRAY(x, alloc); \ 610 } \ 611 } while (0) 612 613/* Initialize and use the cache information */ 614struct lock_file; 615externintread_index(struct index_state *); 616externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 617externintdo_read_index(struct index_state *istate,const char*path, 618int must_exist);/* for testting only! */ 619externintread_index_from(struct index_state *,const char*path); 620externintis_index_unborn(struct index_state *); 621externintread_index_unmerged(struct index_state *); 622 623/* For use with `write_locked_index()`. */ 624#define COMMIT_LOCK (1 << 0) 625 626/* 627 * Write the index while holding an already-taken lock. Close the lock, 628 * and if `COMMIT_LOCK` is given, commit it. 629 * 630 * Unless a split index is in use, write the index into the lockfile. 631 * 632 * With a split index, write the shared index to a temporary file, 633 * adjust its permissions and rename it into place, then write the 634 * split index to the lockfile. If the temporary file for the shared 635 * index cannot be created, fall back to the behavior described in 636 * the previous paragraph. 637 * 638 * With `COMMIT_LOCK`, the lock is always committed or rolled back. 639 * Without it, the lock is closed, but neither committed nor rolled 640 * back. 641 */ 642externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 643 644externintdiscard_index(struct index_state *); 645externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 646externintunmerged_index(const struct index_state *); 647 648/** 649 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn 650 * branch, returns 1 if there are entries in the index, 0 otherwise. If an 651 * strbuf is provided, the space-separated list of files that differ will be 652 * appended to it. 653 */ 654externintindex_has_changes(struct strbuf *sb); 655 656externintverify_path(const char*path); 657externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 658externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 659externvoidadjust_dirname_case(struct index_state *istate,char*name); 660externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 661 662/* 663 * Searches for an entry defined by name and namelen in the given index. 664 * If the return value is positive (including 0) it is the position of an 665 * exact match. If the return value is negative, the negated value minus 1 666 * is the position where the entry would be inserted. 667 * Example: The current index consists of these files and its stages: 668 * 669 * b#0, d#0, f#1, f#3 670 * 671 * index_name_pos(&index, "a", 1) -> -1 672 * index_name_pos(&index, "b", 1) -> 0 673 * index_name_pos(&index, "c", 1) -> -2 674 * index_name_pos(&index, "d", 1) -> 1 675 * index_name_pos(&index, "e", 1) -> -3 676 * index_name_pos(&index, "f", 1) -> -3 677 * index_name_pos(&index, "g", 1) -> -5 678 */ 679externintindex_name_pos(const struct index_state *,const char*name,int namelen); 680 681#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 682#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 683#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 684#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 685#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 686#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 687externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 688externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 689 690/* Remove entry, return true if there are more entries to go. */ 691externintremove_index_entry_at(struct index_state *,int pos); 692 693externvoidremove_marked_cache_entries(struct index_state *istate); 694externintremove_file_from_index(struct index_state *,const char*path); 695#define ADD_CACHE_VERBOSE 1 696#define ADD_CACHE_PRETEND 2 697#define ADD_CACHE_IGNORE_ERRORS 4 698#define ADD_CACHE_IGNORE_REMOVAL 8 699#define ADD_CACHE_INTENT 16 700/* 701 * These two are used to add the contents of the file at path 702 * to the index, marking the working tree up-to-date by storing 703 * the cached stat info in the resulting cache entry. A caller 704 * that has already run lstat(2) on the path can call 705 * add_to_index(), and all others can call add_file_to_index(); 706 * the latter will do necessary lstat(2) internally before 707 * calling the former. 708 */ 709externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 710externintadd_file_to_index(struct index_state *,const char*path,int flags); 711 712externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 713externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 714externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 715externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 716externintindex_name_is_other(const struct index_state *,const char*,int); 717externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 718 719/* do stat comparison even if CE_VALID is true */ 720#define CE_MATCH_IGNORE_VALID 01 721/* do not check the contents but report dirty on racily-clean entries */ 722#define CE_MATCH_RACY_IS_DIRTY 02 723/* do stat comparison even if CE_SKIP_WORKTREE is true */ 724#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 725/* ignore non-existent files during stat update */ 726#define CE_MATCH_IGNORE_MISSING 0x08 727/* enable stat refresh */ 728#define CE_MATCH_REFRESH 0x10 729/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */ 730#define CE_MATCH_IGNORE_FSMONITOR 0X20 731externintie_match_stat(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 732externintie_modified(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 733 734#define HASH_WRITE_OBJECT 1 735#define HASH_FORMAT_CHECK 2 736#define HASH_RENORMALIZE 4 737externintindex_fd(struct object_id *oid,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 738externintindex_path(struct object_id *oid,const char*path,struct stat *st,unsigned flags); 739 740/* 741 * Record to sd the data from st that we use to check whether a file 742 * might have changed. 743 */ 744externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 745 746/* 747 * Return 0 if st is consistent with a file not having been changed 748 * since sd was filled. If there are differences, return a 749 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 750 * INODE_CHANGED, and DATA_CHANGED. 751 */ 752externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 753externintmatch_stat_data_racy(const struct index_state *istate, 754const struct stat_data *sd,struct stat *st); 755 756externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 757 758#define REFRESH_REALLY 0x0001/* ignore_valid */ 759#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 760#define REFRESH_QUIET 0x0004/* be quiet about it */ 761#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 762#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 763#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 764externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 765externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 766 767/* 768 * Opportunistically update the index but do not complain if we can't. 769 * The lockfile is always committed or rolled back. 770 */ 771externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 772 773externinthold_locked_index(struct lock_file *,int); 774externvoidset_alternate_index_output(const char*); 775 776externint verify_index_checksum; 777externint verify_ce_order; 778 779/* Environment bits from configuration mechanism */ 780externint trust_executable_bit; 781externint trust_ctime; 782externint check_stat; 783externint quote_path_fully; 784externint has_symlinks; 785externint minimum_abbrev, default_abbrev; 786externint ignore_case; 787externint assume_unchanged; 788externint prefer_symlink_refs; 789externint warn_ambiguous_refs; 790externint warn_on_object_refname_ambiguity; 791externconst char*apply_default_whitespace; 792externconst char*apply_default_ignorewhitespace; 793externconst char*git_attributes_file; 794externconst char*git_hooks_path; 795externint zlib_compression_level; 796externint core_compression_level; 797externint pack_compression_level; 798externsize_t packed_git_window_size; 799externsize_t packed_git_limit; 800externsize_t delta_base_cache_limit; 801externunsigned long big_file_threshold; 802externunsigned long pack_size_limit_cfg; 803 804/* 805 * Accessors for the core.sharedrepository config which lazy-load the value 806 * from the config (if not already set). The "reset" function can be 807 * used to unset "set" or cached value, meaning that the value will be loaded 808 * fresh from the config file on the next call to get_shared_repository(). 809 */ 810voidset_shared_repository(int value); 811intget_shared_repository(void); 812voidreset_shared_repository(void); 813 814/* 815 * Do replace refs need to be checked this run? This variable is 816 * initialized to true unless --no-replace-object is used or 817 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 818 * commands that do not want replace references to be active. As an 819 * optimization it is also set to false if replace references have 820 * been sought but there were none. 821 */ 822externint check_replace_refs; 823externchar*git_replace_ref_base; 824 825externint fsync_object_files; 826externint core_preload_index; 827externint core_apply_sparse_checkout; 828externint precomposed_unicode; 829externint protect_hfs; 830externint protect_ntfs; 831externconst char*core_fsmonitor; 832 833/* 834 * Include broken refs in all ref iterations, which will 835 * generally choke dangerous operations rather than letting 836 * them silently proceed without taking the broken ref into 837 * account. 838 */ 839externint ref_paranoia; 840 841/* 842 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value). 843 */ 844intuse_optional_locks(void); 845 846/* 847 * The character that begins a commented line in user-editable file 848 * that is subject to stripspace. 849 */ 850externchar comment_line_char; 851externint auto_comment_line_char; 852 853/* Windows only */ 854enum hide_dotfiles_type { 855 HIDE_DOTFILES_FALSE =0, 856 HIDE_DOTFILES_TRUE, 857 HIDE_DOTFILES_DOTGITONLY 858}; 859externenum hide_dotfiles_type hide_dotfiles; 860 861enum log_refs_config { 862 LOG_REFS_UNSET = -1, 863 LOG_REFS_NONE =0, 864 LOG_REFS_NORMAL, 865 LOG_REFS_ALWAYS 866}; 867externenum log_refs_config log_all_ref_updates; 868 869enum branch_track { 870 BRANCH_TRACK_UNSPECIFIED = -1, 871 BRANCH_TRACK_NEVER =0, 872 BRANCH_TRACK_REMOTE, 873 BRANCH_TRACK_ALWAYS, 874 BRANCH_TRACK_EXPLICIT, 875 BRANCH_TRACK_OVERRIDE 876}; 877 878enum rebase_setup_type { 879 AUTOREBASE_NEVER =0, 880 AUTOREBASE_LOCAL, 881 AUTOREBASE_REMOTE, 882 AUTOREBASE_ALWAYS 883}; 884 885enum push_default_type { 886 PUSH_DEFAULT_NOTHING =0, 887 PUSH_DEFAULT_MATCHING, 888 PUSH_DEFAULT_SIMPLE, 889 PUSH_DEFAULT_UPSTREAM, 890 PUSH_DEFAULT_CURRENT, 891 PUSH_DEFAULT_UNSPECIFIED 892}; 893 894externenum branch_track git_branch_track; 895externenum rebase_setup_type autorebase; 896externenum push_default_type push_default; 897 898enum object_creation_mode { 899 OBJECT_CREATION_USES_HARDLINKS =0, 900 OBJECT_CREATION_USES_RENAMES =1 901}; 902 903externenum object_creation_mode object_creation_mode; 904 905externchar*notes_ref_name; 906 907externint grafts_replace_parents; 908 909/* 910 * GIT_REPO_VERSION is the version we write by default. The 911 * _READ variant is the highest number we know how to 912 * handle. 913 */ 914#define GIT_REPO_VERSION 0 915#define GIT_REPO_VERSION_READ 1 916externint repository_format_precious_objects; 917 918struct repository_format { 919int version; 920int precious_objects; 921int is_bare; 922int hash_algo; 923char*work_tree; 924struct string_list unknown_extensions; 925}; 926 927/* 928 * Read the repository format characteristics from the config file "path" into 929 * "format" struct. Returns the numeric version. On error, -1 is returned, 930 * format->version is set to -1, and all other fields in the struct are 931 * undefined. 932 */ 933intread_repository_format(struct repository_format *format,const char*path); 934 935/* 936 * Verify that the repository described by repository_format is something we 937 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 938 * any errors encountered. 939 */ 940intverify_repository_format(const struct repository_format *format, 941struct strbuf *err); 942 943/* 944 * Check the repository format version in the path found in get_git_dir(), 945 * and die if it is a version we don't understand. Generally one would 946 * set_git_dir() before calling this, and use it only for "are we in a valid 947 * repo?". 948 */ 949externvoidcheck_repository_format(void); 950 951#define MTIME_CHANGED 0x0001 952#define CTIME_CHANGED 0x0002 953#define OWNER_CHANGED 0x0004 954#define MODE_CHANGED 0x0008 955#define INODE_CHANGED 0x0010 956#define DATA_CHANGED 0x0020 957#define TYPE_CHANGED 0x0040 958 959/* 960 * Return the name of the file in the local object database that would 961 * be used to store a loose object with the specified sha1. The 962 * return value is a pointer to a statically allocated buffer that is 963 * overwritten each time the function is called. 964 */ 965externconst char*sha1_file_name(const unsigned char*sha1); 966 967/* 968 * Return an abbreviated sha1 unique within this repository's object database. 969 * The result will be at least `len` characters long, and will be NUL 970 * terminated. 971 * 972 * The non-`_r` version returns a static buffer which remains valid until 4 973 * more calls to find_unique_abbrev are made. 974 * 975 * The `_r` variant writes to a buffer supplied by the caller, which must be at 976 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 977 * written (excluding the NUL terminator). 978 * 979 * Note that while this version avoids the static buffer, it is not fully 980 * reentrant, as it calls into other non-reentrant git code. 981 */ 982externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 983externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 984 985externconst unsigned char null_sha1[GIT_MAX_RAWSZ]; 986externconst struct object_id null_oid; 987 988staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 989{ 990returnmemcmp(sha1, sha2, GIT_SHA1_RAWSZ); 991} 992 993staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 994{ 995returnhashcmp(oid1->hash, oid2->hash); 996} 997 998staticinlineintis_null_sha1(const unsigned char*sha1) 999{1000return!hashcmp(sha1, null_sha1);1001}10021003staticinlineintis_null_oid(const struct object_id *oid)1004{1005return!hashcmp(oid->hash, null_sha1);1006}10071008staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src)1009{1010memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);1011}10121013staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src)1014{1015hashcpy(dst->hash, src->hash);1016}10171018staticinlinestruct object_id *oiddup(const struct object_id *src)1019{1020struct object_id *dst =xmalloc(sizeof(struct object_id));1021oidcpy(dst, src);1022return dst;1023}10241025staticinlinevoidhashclr(unsigned char*hash)1026{1027memset(hash,0, GIT_SHA1_RAWSZ);1028}10291030staticinlinevoidoidclr(struct object_id *oid)1031{1032memset(oid->hash,0, GIT_MAX_RAWSZ);1033}103410351036#define EMPTY_TREE_SHA1_HEX \1037"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1038#define EMPTY_TREE_SHA1_BIN_LITERAL \1039"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1040"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1041externconst struct object_id empty_tree_oid;1042#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10431044#define EMPTY_BLOB_SHA1_HEX \1045"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1046#define EMPTY_BLOB_SHA1_BIN_LITERAL \1047"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1048"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1049externconst struct object_id empty_blob_oid;10501051staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1052{1053return!hashcmp(sha1, the_hash_algo->empty_blob->hash);1054}10551056staticinlineintis_empty_blob_oid(const struct object_id *oid)1057{1058return!oidcmp(oid, the_hash_algo->empty_blob);1059}10601061staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1062{1063return!hashcmp(sha1, the_hash_algo->empty_tree->hash);1064}10651066staticinlineintis_empty_tree_oid(const struct object_id *oid)1067{1068return!oidcmp(oid, the_hash_algo->empty_tree);1069}10701071/* set default permissions by passing mode arguments to open(2) */1072intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1073intgit_mkstemp_mode(char*pattern,int mode);10741075/*1076 * NOTE NOTE NOTE!!1077 *1078 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1079 * not be changed. Old repositories have core.sharedrepository written in1080 * numeric format, and therefore these values are preserved for compatibility1081 * reasons.1082 */1083enum sharedrepo {1084 PERM_UMASK =0,1085 OLD_PERM_GROUP =1,1086 OLD_PERM_EVERYBODY =2,1087 PERM_GROUP =0660,1088 PERM_EVERYBODY =06641089};1090intgit_config_perm(const char*var,const char*value);1091intadjust_shared_perm(const char*path);10921093/*1094 * Create the directory containing the named path, using care to be1095 * somewhat safe against races. Return one of the scld_error values to1096 * indicate success/failure. On error, set errno to describe the1097 * problem.1098 *1099 * SCLD_VANISHED indicates that one of the ancestor directories of the1100 * path existed at one point during the function call and then1101 * suddenly vanished, probably because another process pruned the1102 * directory while we were working. To be robust against this kind of1103 * race, callers might want to try invoking the function again when it1104 * returns SCLD_VANISHED.1105 *1106 * safe_create_leading_directories() temporarily changes path while it1107 * is working but restores it before returning.1108 * safe_create_leading_directories_const() doesn't modify path, even1109 * temporarily.1110 */1111enum scld_error {1112 SCLD_OK =0,1113 SCLD_FAILED = -1,1114 SCLD_PERMS = -2,1115 SCLD_EXISTS = -3,1116 SCLD_VANISHED = -41117};1118enum scld_error safe_create_leading_directories(char*path);1119enum scld_error safe_create_leading_directories_const(const char*path);11201121/*1122 * Callback function for raceproof_create_file(). This function is1123 * expected to do something that makes dirname(path) permanent despite1124 * the fact that other processes might be cleaning up empty1125 * directories at the same time. Usually it will create a file named1126 * path, but alternatively it could create another file in that1127 * directory, or even chdir() into that directory. The function should1128 * return 0 if the action was completed successfully. On error, it1129 * should return a nonzero result and set errno.1130 * raceproof_create_file() treats two errno values specially:1131 *1132 * - ENOENT -- dirname(path) does not exist. In this case,1133 * raceproof_create_file() tries creating dirname(path)1134 * (and any parent directories, if necessary) and calls1135 * the function again.1136 *1137 * - EISDIR -- the file already exists and is a directory. In this1138 * case, raceproof_create_file() removes the directory if1139 * it is empty (and recursively any empty directories that1140 * it contains) and calls the function again.1141 *1142 * Any other errno causes raceproof_create_file() to fail with the1143 * callback's return value and errno.1144 *1145 * Obviously, this function should be OK with being called again if it1146 * fails with ENOENT or EISDIR. In other scenarios it will not be1147 * called again.1148 */1149typedefintcreate_file_fn(const char*path,void*cb);11501151/*1152 * Create a file in dirname(path) by calling fn, creating leading1153 * directories if necessary. Retry a few times in case we are racing1154 * with another process that is trying to clean up the directory that1155 * contains path. See the documentation for create_file_fn for more1156 * details.1157 *1158 * Return the value and set the errno that resulted from the most1159 * recent call of fn. fn is always called at least once, and will be1160 * called more than once if it returns ENOENT or EISDIR.1161 */1162intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11631164intmkdir_in_gitdir(const char*path);1165externchar*expand_user_path(const char*path,int real_home);1166const char*enter_repo(const char*path,int strict);1167staticinlineintis_absolute_path(const char*path)1168{1169returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1170}1171intis_directory(const char*);1172char*strbuf_realpath(struct strbuf *resolved,const char*path,1173int die_on_error);1174const char*real_path(const char*path);1175const char*real_path_if_valid(const char*path);1176char*real_pathdup(const char*path,int die_on_error);1177const char*absolute_path(const char*path);1178char*absolute_pathdup(const char*path);1179const char*remove_leading_path(const char*in,const char*prefix);1180const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1181intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1182intnormalize_path_copy(char*dst,const char*src);1183intlongest_ancestor_length(const char*path,struct string_list *prefixes);1184char*strip_path_suffix(const char*path,const char*suffix);1185intdaemon_avoid_alias(const char*path);1186externintis_ntfs_dotgit(const char*name);11871188/*1189 * Returns true iff "str" could be confused as a command-line option when1190 * passed to a sub-program like "ssh". Note that this has nothing to do with1191 * shell-quoting, which should be handled separately; we're assuming here that1192 * the string makes it verbatim to the sub-program.1193 */1194intlooks_like_command_line_option(const char*str);11951196/**1197 * Return a newly allocated string with the evaluation of1198 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1199 * "$HOME/.config/git/$filename". Return NULL upon error.1200 */1201externchar*xdg_config_home(const char*filename);12021203/**1204 * Return a newly allocated string with the evaluation of1205 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1206 * "$HOME/.cache/git/$filename". Return NULL upon error.1207 */1208externchar*xdg_cache_home(const char*filename);12091210externvoid*read_sha1_file_extended(const unsigned char*sha1,1211enum object_type *type,1212unsigned long*size,int lookup_replace);1213staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1214{1215returnread_sha1_file_extended(sha1, type, size,1);1216}12171218/*1219 * This internal function is only declared here for the benefit of1220 * lookup_replace_object(). Please do not call it directly.1221 */1222externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);12231224/*1225 * If object sha1 should be replaced, return the replacement object's1226 * name (replaced recursively, if necessary). The return value is1227 * either sha1 or a pointer to a permanently-allocated value. When1228 * object replacement is suppressed, always return sha1.1229 */1230staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1231{1232if(!check_replace_refs)1233return sha1;1234returndo_lookup_replace_object(sha1);1235}12361237/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1238externintsha1_object_info(const unsigned char*,unsigned long*);12391240externinthash_object_file(const void*buf,unsigned long len,1241const char*type,struct object_id *oid);12421243externintwrite_object_file(const void*buf,unsigned long len,1244const char*type,struct object_id *oid);12451246externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,struct object_id *oid,unsigned flags);12471248externintpretend_object_file(void*,unsigned long,enum object_type,1249struct object_id *oid);12501251externintforce_object_loose(const struct object_id *oid,time_t mtime);12521253externintgit_open_cloexec(const char*name,int flags);1254#define git_open(name) git_open_cloexec(name, O_RDONLY)1255externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1256externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1257externintparse_sha1_header(const char*hdr,unsigned long*sizep);12581259externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);12601261externintfinalize_object_file(const char*tmpfile,const char*filename);12621263/*1264 * Open the loose object at path, check its sha1, and return the contents,1265 * type, and size. If the object is a blob, then "contents" may return NULL,1266 * to allow streaming of large blobs.1267 *1268 * Returns 0 on success, negative on error (details may be written to stderr).1269 */1270intread_loose_object(const char*path,1271const unsigned char*expected_sha1,1272enum object_type *type,1273unsigned long*size,1274void**contents);12751276/*1277 * Convenience for sha1_object_info_extended() with a NULL struct1278 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass1279 * nonzero flags to also set other flags.1280 */1281externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1282staticinlineinthas_sha1_file(const unsigned char*sha1)1283{1284returnhas_sha1_file_with_flags(sha1,0);1285}12861287/* Same as the above, except for struct object_id. */1288externinthas_object_file(const struct object_id *oid);1289externinthas_object_file_with_flags(const struct object_id *oid,int flags);12901291/*1292 * Return true iff an alternate object database has a loose object1293 * with the specified name. This function does not respect replace1294 * references.1295 */1296externinthas_loose_object_nonlocal(const unsigned char*sha1);12971298externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);12991300/* Helper to check and "touch" a file */1301externintcheck_and_freshen_file(const char*fn,int freshen);13021303externconst signed char hexval_table[256];1304staticinlineunsigned inthexval(unsigned char c)1305{1306return hexval_table[c];1307}13081309/*1310 * Convert two consecutive hexadecimal digits into a char. Return a1311 * negative value on error. Don't run over the end of short strings.1312 */1313staticinlineinthex2chr(const char*s)1314{1315unsigned int val =hexval(s[0]);1316return(val & ~0xf) ? val : (val <<4) |hexval(s[1]);1317}13181319/* Convert to/from hex/sha1 representation */1320#define MINIMUM_ABBREV minimum_abbrev1321#define DEFAULT_ABBREV default_abbrev13221323/* used when the code does not know or care what the default abbrev is */1324#define FALLBACK_DEFAULT_ABBREV 713251326struct object_context {1327unsigned char tree[20];1328unsigned mode;1329/*1330 * symlink_path is only used by get_tree_entry_follow_symlinks,1331 * and only for symlinks that point outside the repository.1332 */1333struct strbuf symlink_path;1334/*1335 * If GET_OID_RECORD_PATH is set, this will record path (if any)1336 * found when resolving the name. The caller is responsible for1337 * releasing the memory.1338 */1339char*path;1340};13411342#define GET_OID_QUIETLY 011343#define GET_OID_COMMIT 021344#define GET_OID_COMMITTISH 041345#define GET_OID_TREE 0101346#define GET_OID_TREEISH 0201347#define GET_OID_BLOB 0401348#define GET_OID_FOLLOW_SYMLINKS 01001349#define GET_OID_RECORD_PATH 02001350#define GET_OID_ONLY_TO_DIE 0400013511352#define GET_OID_DISAMBIGUATORS \1353 (GET_OID_COMMIT | GET_OID_COMMITTISH | \1354 GET_OID_TREE | GET_OID_TREEISH | \1355 GET_OID_BLOB)13561357externintget_oid(const char*str,struct object_id *oid);1358externintget_oid_commit(const char*str,struct object_id *oid);1359externintget_oid_committish(const char*str,struct object_id *oid);1360externintget_oid_tree(const char*str,struct object_id *oid);1361externintget_oid_treeish(const char*str,struct object_id *oid);1362externintget_oid_blob(const char*str,struct object_id *oid);1363externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1364externintget_oid_with_context(const char*str,unsigned flags,struct object_id *oid,struct object_context *oc);136513661367typedefinteach_abbrev_fn(const struct object_id *oid,void*);1368externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13691370externintset_disambiguate_hint_config(const char*var,const char*value);13711372/*1373 * Try to read a SHA1 in hexadecimal format from the 40 characters1374 * starting at hex. Write the 20-byte result to sha1 in binary form.1375 * Return 0 on success. Reading stops if a NUL is encountered in the1376 * input, so it is safe to pass this function an arbitrary1377 * null-terminated string.1378 */1379externintget_sha1_hex(const char*hex,unsigned char*sha1);1380externintget_oid_hex(const char*hex,struct object_id *sha1);13811382/*1383 * Read `len` pairs of hexadecimal digits from `hex` and write the1384 * values to `binary` as `len` bytes. Return 0 on success, or -1 if1385 * the input does not consist of hex digits).1386 */1387externinthex_to_bytes(unsigned char*binary,const char*hex,size_t len);13881389/*1390 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1391 * and writes the NUL-terminated output to the buffer `out`, which must be at1392 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1393 * convenience.1394 *1395 * The non-`_r` variant returns a static buffer, but uses a ring of 41396 * buffers, making it safe to make multiple calls for a single statement, like:1397 *1398 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1399 */1400externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1401externchar*oid_to_hex_r(char*out,const struct object_id *oid);1402externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1403externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */14041405/*1406 * Parse a 40-character hexadecimal object ID starting from hex, updating the1407 * pointer specified by end when parsing stops. The resulting object ID is1408 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1409 * other invalid character. end is only updated on success; otherwise, it is1410 * unmodified.1411 */1412externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);14131414/*1415 * This reads short-hand syntax that not only evaluates to a commit1416 * object name, but also can act as if the end user spelled the name1417 * of the branch from the command line.1418 *1419 * - "@{-N}" finds the name of the Nth previous branch we were on, and1420 * places the name of the branch in the given buf and returns the1421 * number of characters parsed if successful.1422 *1423 * - "<branch>@{upstream}" finds the name of the other ref that1424 * <branch> is configured to merge with (missing <branch> defaults1425 * to the current branch), and places the name of the branch in the1426 * given buf and returns the number of characters parsed if1427 * successful.1428 *1429 * If the input is not of the accepted format, it returns a negative1430 * number to signal an error.1431 *1432 * If the input was ok but there are not N branch switches in the1433 * reflog, it returns 0.1434 *1435 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1436 * expansions: local branches ("refs/heads/"), remote branches1437 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1438 * allowed, even ones to refs outside of those namespaces.1439 */1440#define INTERPRET_BRANCH_LOCAL (1<<0)1441#define INTERPRET_BRANCH_REMOTE (1<<1)1442#define INTERPRET_BRANCH_HEAD (1<<2)1443externintinterpret_branch_name(const char*str,int len,struct strbuf *,1444unsigned allowed);1445externintget_oid_mb(const char*str,struct object_id *oid);14461447externintvalidate_headref(const char*ref);14481449externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1450externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1451externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1452externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);14531454externvoid*read_object_with_reference(const unsigned char*sha1,1455const char*required_type,1456unsigned long*size,1457unsigned char*sha1_ret);14581459externstruct object *peel_to_type(const char*name,int namelen,1460struct object *o,enum object_type);14611462struct date_mode {1463enum date_mode_type {1464 DATE_NORMAL =0,1465 DATE_RELATIVE,1466 DATE_SHORT,1467 DATE_ISO8601,1468 DATE_ISO8601_STRICT,1469 DATE_RFC2822,1470 DATE_STRFTIME,1471 DATE_RAW,1472 DATE_UNIX1473} type;1474const char*strftime_fmt;1475int local;1476};14771478/*1479 * Convenience helper for passing a constant type, like:1480 *1481 * show_date(t, tz, DATE_MODE(NORMAL));1482 */1483#define DATE_MODE(t) date_mode_from_type(DATE_##t)1484struct date_mode *date_mode_from_type(enum date_mode_type type);14851486const char*show_date(timestamp_t time,int timezone,const struct date_mode *mode);1487voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1488struct strbuf *timebuf);1489intparse_date(const char*date,struct strbuf *out);1490intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1491intparse_expiry_date(const char*date, timestamp_t *timestamp);1492voiddatestamp(struct strbuf *out);1493#define approxidate(s) approxidate_careful((s), NULL)1494timestamp_t approxidate_careful(const char*,int*);1495timestamp_t approxidate_relative(const char*date,const struct timeval *now);1496voidparse_date_format(const char*format,struct date_mode *mode);1497intdate_overflows(timestamp_t date);14981499#define IDENT_STRICT 11500#define IDENT_NO_DATE 21501#define IDENT_NO_NAME 41502externconst char*git_author_info(int);1503externconst char*git_committer_info(int);1504externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1505externconst char*fmt_name(const char*name,const char*email);1506externconst char*ident_default_name(void);1507externconst char*ident_default_email(void);1508externconst char*git_editor(void);1509externconst char*git_pager(int stdout_is_tty);1510externintis_terminal_dumb(void);1511externintgit_ident_config(const char*,const char*,void*);1512externvoidreset_ident_date(void);15131514struct ident_split {1515const char*name_begin;1516const char*name_end;1517const char*mail_begin;1518const char*mail_end;1519const char*date_begin;1520const char*date_end;1521const char*tz_begin;1522const char*tz_end;1523};1524/*1525 * Signals an success with 0, but time part of the result may be NULL1526 * if the input lacks timestamp and zone1527 */1528externintsplit_ident_line(struct ident_split *,const char*,int);15291530/*1531 * Like show_date, but pull the timestamp and tz parameters from1532 * the ident_split. It will also sanity-check the values and produce1533 * a well-known sentinel date if they appear bogus.1534 */1535const char*show_ident_date(const struct ident_split *id,1536const struct date_mode *mode);15371538/*1539 * Compare split idents for equality or strict ordering. Note that we1540 * compare only the ident part of the line, ignoring any timestamp.1541 *1542 * Because there are two fields, we must choose one as the primary key; we1543 * currently arbitrarily pick the email.1544 */1545externintident_cmp(const struct ident_split *,const struct ident_split *);15461547struct checkout {1548struct index_state *istate;1549const char*base_dir;1550int base_dir_len;1551struct delayed_checkout *delayed_checkout;1552unsigned force:1,1553 quiet:1,1554 not_new:1,1555 refresh_cache:1;1556};1557#define CHECKOUT_INIT { NULL,"" }15581559#define TEMPORARY_FILENAME_LENGTH 251560externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);1561externvoidenable_delayed_checkout(struct checkout *state);1562externintfinish_delayed_checkout(struct checkout *state);15631564struct cache_def {1565struct strbuf path;1566int flags;1567int track_flags;1568int prefix_len_stat_func;1569};1570#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1571staticinlinevoidcache_def_clear(struct cache_def *cache)1572{1573strbuf_release(&cache->path);1574}15751576externinthas_symlink_leading_path(const char*name,int len);1577externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1578externintcheck_leading_path(const char*name,int len);1579externinthas_dirs_only_path(const char*name,int len,int prefix_len);1580externvoidschedule_dir_for_removal(const char*name,int len);1581externvoidremove_scheduled_dirs(void);15821583externstruct alternate_object_database {1584struct alternate_object_database *next;15851586/* see alt_scratch_buf() */1587struct strbuf scratch;1588size_t base_len;15891590/*1591 * Used to store the results of readdir(3) calls when searching1592 * for unique abbreviated hashes. This cache is never1593 * invalidated, thus it's racy and not necessarily accurate.1594 * That's fine for its purpose; don't use it for tasks requiring1595 * greater accuracy!1596 */1597char loose_objects_subdir_seen[256];1598struct oid_array loose_objects_cache;15991600char path[FLEX_ARRAY];1601} *alt_odb_list;1602externvoidprepare_alt_odb(void);1603externchar*compute_alternate_path(const char*path,struct strbuf *err);1604typedefintalt_odb_fn(struct alternate_object_database *,void*);1605externintforeach_alt_odb(alt_odb_fn,void*);16061607/*1608 * Allocate a "struct alternate_object_database" but do _not_ actually1609 * add it to the list of alternates.1610 */1611struct alternate_object_database *alloc_alt_odb(const char*dir);16121613/*1614 * Add the directory to the on-disk alternates file; the new entry will also1615 * take effect in the current process.1616 */1617externvoidadd_to_alternates_file(const char*dir);16181619/*1620 * Add the directory to the in-memory list of alternates (along with any1621 * recursive alternates it points to), but do not modify the on-disk alternates1622 * file.1623 */1624externvoidadd_to_alternates_memory(const char*dir);16251626/*1627 * Returns a scratch strbuf pre-filled with the alternate object directory,1628 * including a trailing slash, which can be used to access paths in the1629 * alternate. Always use this over direct access to alt->scratch, as it1630 * cleans up any previous use of the scratch buffer.1631 */1632externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);16331634struct pack_window {1635struct pack_window *next;1636unsigned char*base;1637 off_t offset;1638size_t len;1639unsigned int last_used;1640unsigned int inuse_cnt;1641};16421643externstruct packed_git {1644struct packed_git *next;1645struct pack_window *windows;1646 off_t pack_size;1647const void*index_data;1648size_t index_size;1649uint32_t num_objects;1650uint32_t num_bad_objects;1651unsigned char*bad_object_sha1;1652int index_version;1653time_t mtime;1654int pack_fd;1655unsigned pack_local:1,1656 pack_keep:1,1657 freshened:1,1658 do_not_close:1;1659unsigned char sha1[20];1660struct revindex_entry *revindex;1661/* something like ".git/objects/pack/xxxxx.pack" */1662char pack_name[FLEX_ARRAY];/* more */1663} *packed_git;16641665/*1666 * A most-recently-used ordered version of the packed_git list, which can1667 * be iterated instead of packed_git (and marked via mru_mark).1668 */1669externstruct mru packed_git_mru;16701671struct pack_entry {1672 off_t offset;1673unsigned char sha1[20];1674struct packed_git *p;1675};16761677/*1678 * Create a temporary file rooted in the object database directory, or1679 * die on failure. The filename is taken from "pattern", which should have the1680 * usual "XXXXXX" trailer, and the resulting filename is written into the1681 * "template" buffer. Returns the open descriptor.1682 */1683externintodb_mkstemp(struct strbuf *template,const char*pattern);16841685/*1686 * Create a pack .keep file named "name" (which should generally be the output1687 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1688 * error.1689 */1690externintodb_pack_keep(const char*name);16911692/*1693 * Iterate over the files in the loose-object parts of the object1694 * directory "path", triggering the following callbacks:1695 *1696 * - loose_object is called for each loose object we find.1697 *1698 * - loose_cruft is called for any files that do not appear to be1699 * loose objects. Note that we only look in the loose object1700 * directories "objects/[0-9a-f]{2}/", so we will not report1701 * "objects/foobar" as cruft.1702 *1703 * - loose_subdir is called for each top-level hashed subdirectory1704 * of the object directory (e.g., "$OBJDIR/f0"). It is called1705 * after the objects in the directory are processed.1706 *1707 * Any callback that is NULL will be ignored. Callbacks returning non-zero1708 * will end the iteration.1709 *1710 * In the "buf" variant, "path" is a strbuf which will also be used as a1711 * scratch buffer, but restored to its original contents before1712 * the function returns.1713 */1714typedefinteach_loose_object_fn(const struct object_id *oid,1715const char*path,1716void*data);1717typedefinteach_loose_cruft_fn(const char*basename,1718const char*path,1719void*data);1720typedefinteach_loose_subdir_fn(unsigned int nr,1721const char*path,1722void*data);1723intfor_each_file_in_obj_subdir(unsigned int subdir_nr,1724struct strbuf *path,1725 each_loose_object_fn obj_cb,1726 each_loose_cruft_fn cruft_cb,1727 each_loose_subdir_fn subdir_cb,1728void*data);1729intfor_each_loose_file_in_objdir(const char*path,1730 each_loose_object_fn obj_cb,1731 each_loose_cruft_fn cruft_cb,1732 each_loose_subdir_fn subdir_cb,1733void*data);1734intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1735 each_loose_object_fn obj_cb,1736 each_loose_cruft_fn cruft_cb,1737 each_loose_subdir_fn subdir_cb,1738void*data);17391740/*1741 * Iterate over loose objects in both the local1742 * repository and any alternates repositories (unless the1743 * LOCAL_ONLY flag is set).1744 */1745#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11746externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);17471748struct object_info {1749/* Request */1750enum object_type *typep;1751unsigned long*sizep;1752 off_t *disk_sizep;1753unsigned char*delta_base_sha1;1754struct strbuf *typename;1755void**contentp;17561757/* Response */1758enum{1759 OI_CACHED,1760 OI_LOOSE,1761 OI_PACKED,1762 OI_DBCACHED1763} whence;1764union{1765/*1766 * struct {1767 * ... Nothing to expose in this case1768 * } cached;1769 * struct {1770 * ... Nothing to expose in this case1771 * } loose;1772 */1773struct{1774struct packed_git *pack;1775 off_t offset;1776unsigned int is_delta;1777} packed;1778} u;1779};17801781/*1782 * Initializer for a "struct object_info" that wants no items. You may1783 * also memset() the memory to all-zeroes.1784 */1785#define OBJECT_INFO_INIT {NULL}17861787/* Invoke lookup_replace_object() on the given hash */1788#define OBJECT_INFO_LOOKUP_REPLACE 11789/* Allow reading from a loose object file of unknown/bogus type */1790#define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 21791/* Do not check cached storage */1792#define OBJECT_INFO_SKIP_CACHED 41793/* Do not retry packed storage after checking packed and loose storage */1794#define OBJECT_INFO_QUICK 81795externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);17961797/* Dumb servers support */1798externintupdate_server_info(int);17991800externconst char*get_log_output_encoding(void);1801externconst char*get_commit_output_encoding(void);18021803/*1804 * This is a hack for test programs like test-dump-untracked-cache to1805 * ensure that they do not modify the untracked cache when reading it.1806 * Do not use it otherwise!1807 */1808externint ignore_untracked_cache_config;18091810externintcommitter_ident_sufficiently_given(void);1811externintauthor_ident_sufficiently_given(void);18121813externconst char*git_commit_encoding;1814externconst char*git_log_output_encoding;1815externconst char*git_mailmap_file;1816externconst char*git_mailmap_blob;18171818/* IO helper functions */1819externvoidmaybe_flush_or_die(FILE*,const char*);1820__attribute__((format(printf,2,3)))1821externvoidfprintf_or_die(FILE*,const char*fmt, ...);18221823#define COPY_READ_ERROR (-2)1824#define COPY_WRITE_ERROR (-3)1825externintcopy_fd(int ifd,int ofd);1826externintcopy_file(const char*dst,const char*src,int mode);1827externintcopy_file_with_time(const char*dst,const char*src,int mode);18281829externvoidwrite_or_die(int fd,const void*buf,size_t count);1830externvoidfsync_or_die(int fd,const char*);18311832extern ssize_t read_in_full(int fd,void*buf,size_t count);1833extern ssize_t write_in_full(int fd,const void*buf,size_t count);1834extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);18351836staticinline ssize_t write_str_in_full(int fd,const char*str)1837{1838returnwrite_in_full(fd, str,strlen(str));1839}18401841/**1842 * Open (and truncate) the file at path, write the contents of buf to it,1843 * and close it. Dies if any errors are encountered.1844 */1845externvoidwrite_file_buf(const char*path,const char*buf,size_t len);18461847/**1848 * Like write_file_buf(), but format the contents into a buffer first.1849 * Additionally, write_file() will append a newline if one is not already1850 * present, making it convenient to write text files:1851 *1852 * write_file(path, "counter: %d", ctr);1853 */1854__attribute__((format(printf,2,3)))1855externvoidwrite_file(const char*path,const char*fmt, ...);18561857/* pager.c */1858externvoidsetup_pager(void);1859externintpager_in_use(void);1860externint pager_use_color;1861externintterm_columns(void);1862externintdecimal_width(uintmax_t);1863externintcheck_pager_config(const char*cmd);1864externvoidprepare_pager_args(struct child_process *,const char*pager);18651866externconst char*editor_program;1867externconst char*askpass_program;1868externconst char*excludes_file;18691870/* base85 */1871intdecode_85(char*dst,const char*line,int linelen);1872voidencode_85(char*buf,const unsigned char*data,int bytes);18731874/* alloc.c */1875externvoid*alloc_blob_node(void);1876externvoid*alloc_tree_node(void);1877externvoid*alloc_commit_node(void);1878externvoid*alloc_tag_node(void);1879externvoid*alloc_object_node(void);1880externvoidalloc_report(void);1881externunsigned intalloc_commit_index(void);18821883/* pkt-line.c */1884voidpacket_trace_identity(const char*prog);18851886/* add */1887/*1888 * return 0 if success, 1 - if addition of a file failed and1889 * ADD_FILES_IGNORE_ERRORS was specified in flags1890 */1891intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);18921893/* diff.c */1894externint diff_auto_refresh_index;18951896/* match-trees.c */1897voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1898voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);18991900/*1901 * whitespace rules.1902 * used by both diff and apply1903 * last two digits are tab width1904 */1905#define WS_BLANK_AT_EOL 01001906#define WS_SPACE_BEFORE_TAB 02001907#define WS_INDENT_WITH_NON_TAB 04001908#define WS_CR_AT_EOL 010001909#define WS_BLANK_AT_EOF 020001910#define WS_TAB_IN_INDENT 040001911#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1912#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1913#define WS_TAB_WIDTH_MASK 0771914/* All WS_* -- when extended, adapt diff.c emit_symbol */1915#define WS_RULE_MASK 077771916externunsigned whitespace_rule_cfg;1917externunsignedwhitespace_rule(const char*);1918externunsignedparse_whitespace_rule(const char*);1919externunsignedws_check(const char*line,int len,unsigned ws_rule);1920externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1921externchar*whitespace_error_string(unsigned ws);1922externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1923externintws_blank_line(const char*line,int len,unsigned ws_rule);1924#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)19251926/* ls-files */1927voidoverlay_tree_on_index(struct index_state *istate,1928const char*tree_name,const char*prefix);19291930char*alias_lookup(const char*alias);1931intsplit_cmdline(char*cmdline,const char***argv);1932/* Takes a negative value returned by split_cmdline */1933const char*split_cmdline_strerror(int cmdline_errno);19341935/* setup.c */1936struct startup_info {1937int have_repository;1938const char*prefix;1939};1940externstruct startup_info *startup_info;19411942/* merge.c */1943struct commit_list;1944inttry_merge_command(const char*strategy,size_t xopts_nr,1945const char**xopts,struct commit_list *common,1946const char*head_arg,struct commit_list *remotes);1947intcheckout_fast_forward(const struct object_id *from,1948const struct object_id *to,1949int overwrite_ignore);195019511952intsane_execvp(const char*file,char*const argv[]);19531954/*1955 * A struct to encapsulate the concept of whether a file has changed1956 * since we last checked it. This uses criteria similar to those used1957 * for the index.1958 */1959struct stat_validity {1960struct stat_data *sd;1961};19621963voidstat_validity_clear(struct stat_validity *sv);19641965/*1966 * Returns 1 if the path is a regular file (or a symlink to a regular1967 * file) and matches the saved stat_validity, 0 otherwise. A missing1968 * or inaccessible file is considered a match if the struct was just1969 * initialized, or if the previous update found an inaccessible file.1970 */1971intstat_validity_check(struct stat_validity *sv,const char*path);19721973/*1974 * Update the stat_validity from a file opened at descriptor fd. If1975 * the file is missing, inaccessible, or not a regular file, then1976 * future calls to stat_validity_check will match iff one of those1977 * conditions continues to be true.1978 */1979voidstat_validity_update(struct stat_validity *sv,int fd);19801981intversioncmp(const char*s1,const char*s2);1982voidsleep_millisec(int millisec);19831984/*1985 * Create a directory and (if share is nonzero) adjust its permissions1986 * according to the shared_repository setting. Only use this for1987 * directories under $GIT_DIR. Don't use it for working tree1988 * directories.1989 */1990voidsafe_create_dir(const char*dir,int share);19911992/*1993 * Should we print an ellipsis after an abbreviated SHA-1 value1994 * when doing diff-raw output or indicating a detached HEAD?1995 */1996externintprint_sha1_ellipsis(void);19971998#endif/* CACHE_H */