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"list.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#include <zlib.h> 20typedefstruct git_zstream { 21 z_stream z; 22unsigned long avail_in; 23unsigned long avail_out; 24unsigned long total_in; 25unsigned long total_out; 26unsigned char*next_in; 27unsigned char*next_out; 28} git_zstream; 29 30voidgit_inflate_init(git_zstream *); 31voidgit_inflate_init_gzip_only(git_zstream *); 32voidgit_inflate_end(git_zstream *); 33intgit_inflate(git_zstream *,int flush); 34 35voidgit_deflate_init(git_zstream *,int level); 36voidgit_deflate_init_gzip(git_zstream *,int level); 37voidgit_deflate_init_raw(git_zstream *,int level); 38voidgit_deflate_end(git_zstream *); 39intgit_deflate_abort(git_zstream *); 40intgit_deflate_end_gently(git_zstream *); 41intgit_deflate(git_zstream *,int flush); 42unsigned longgit_deflate_bound(git_zstream *,unsigned long); 43 44/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 45#define GIT_SHA1_RAWSZ 20 46#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 47 48/* The length in byte and in hex digits of the largest possible hash value. */ 49#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 50#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 51 52struct object_id { 53unsigned char hash[GIT_MAX_RAWSZ]; 54}; 55 56#define the_hash_algo the_repository->hash_algo 57 58#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 59#define DTYPE(de) ((de)->d_type) 60#else 61#undef DT_UNKNOWN 62#undef DT_DIR 63#undef DT_REG 64#undef DT_LNK 65#define DT_UNKNOWN 0 66#define DT_DIR 1 67#define DT_REG 2 68#define DT_LNK 3 69#define DTYPE(de) DT_UNKNOWN 70#endif 71 72/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 73#define S_IFINVALID 0030000 74 75/* 76 * A "directory link" is a link to another git directory. 77 * 78 * The value 0160000 is not normally a valid mode, and 79 * also just happens to be S_IFDIR + S_IFLNK 80 */ 81#define S_IFGITLINK 0160000 82#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 83 84/* 85 * Some mode bits are also used internally for computations. 86 * 87 * They *must* not overlap with any valid modes, and they *must* not be emitted 88 * to outside world - i.e. appear on disk or network. In other words, it's just 89 * temporary fields, which we internally use, but they have to stay in-house. 90 * 91 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 92 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 93 */ 94 95/* used internally in tree-diff */ 96#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 97 98 99/* 100 * Intensive research over the course of many years has shown that 101 * port 9418 is totally unused by anything else. Or 102 * 103 * Your search - "port 9418" - did not match any documents. 104 * 105 * as www.google.com puts it. 106 * 107 * This port has been properly assigned for git use by IANA: 108 * git (Assigned-9418) [I06-050728-0001]. 109 * 110 * git 9418/tcp git pack transfer service 111 * git 9418/udp git pack transfer service 112 * 113 * with Linus Torvalds <torvalds@osdl.org> as the point of 114 * contact. September 2005. 115 * 116 * See http://www.iana.org/assignments/port-numbers 117 */ 118#define DEFAULT_GIT_PORT 9418 119 120/* 121 * Basic data structures for the directory cache 122 */ 123 124#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 125struct cache_header { 126uint32_t hdr_signature; 127uint32_t hdr_version; 128uint32_t hdr_entries; 129}; 130 131#define INDEX_FORMAT_LB 2 132#define INDEX_FORMAT_UB 4 133 134/* 135 * The "cache_time" is just the low 32 bits of the 136 * time. It doesn't matter if it overflows - we only 137 * check it for equality in the 32 bits we save. 138 */ 139struct cache_time { 140uint32_t sec; 141uint32_t nsec; 142}; 143 144struct stat_data { 145struct cache_time sd_ctime; 146struct cache_time sd_mtime; 147unsigned int sd_dev; 148unsigned int sd_ino; 149unsigned int sd_uid; 150unsigned int sd_gid; 151unsigned int sd_size; 152}; 153 154struct cache_entry { 155struct hashmap_entry ent; 156struct stat_data ce_stat_data; 157unsigned int ce_mode; 158unsigned int ce_flags; 159unsigned int ce_namelen; 160unsigned int index;/* for link extension */ 161struct object_id oid; 162char name[FLEX_ARRAY];/* more */ 163}; 164 165#define CE_STAGEMASK (0x3000) 166#define CE_EXTENDED (0x4000) 167#define CE_VALID (0x8000) 168#define CE_STAGESHIFT 12 169 170/* 171 * Range 0xFFFF0FFF in ce_flags is divided into 172 * two parts: in-memory flags and on-disk ones. 173 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 174 * if you want to save a new flag, add it in 175 * CE_EXTENDED_FLAGS 176 * 177 * In-memory only flags 178 */ 179#define CE_UPDATE (1 << 16) 180#define CE_REMOVE (1 << 17) 181#define CE_UPTODATE (1 << 18) 182#define CE_ADDED (1 << 19) 183 184#define CE_HASHED (1 << 20) 185#define CE_FSMONITOR_VALID (1 << 21) 186#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 187#define CE_CONFLICTED (1 << 23) 188 189#define CE_UNPACKED (1 << 24) 190#define CE_NEW_SKIP_WORKTREE (1 << 25) 191 192/* used to temporarily mark paths matched by pathspecs */ 193#define CE_MATCHED (1 << 26) 194 195#define CE_UPDATE_IN_BASE (1 << 27) 196#define CE_STRIP_NAME (1 << 28) 197 198/* 199 * Extended on-disk flags 200 */ 201#define CE_INTENT_TO_ADD (1 << 29) 202#define CE_SKIP_WORKTREE (1 << 30) 203/* CE_EXTENDED2 is for future extension */ 204#define CE_EXTENDED2 (1U << 31) 205 206#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 207 208/* 209 * Safeguard to avoid saving wrong flags: 210 * - CE_EXTENDED2 won't get saved until its semantic is known 211 * - Bits in 0x0000FFFF have been saved in ce_flags already 212 * - Bits in 0x003F0000 are currently in-memory flags 213 */ 214#if CE_EXTENDED_FLAGS & 0x803FFFFF 215#error"CE_EXTENDED_FLAGS out of range" 216#endif 217 218/* Forward structure decls */ 219struct pathspec; 220struct child_process; 221struct tree; 222 223/* 224 * Copy the sha1 and stat state of a cache entry from one to 225 * another. But we never change the name, or the hash state! 226 */ 227staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 228const struct cache_entry *src) 229{ 230unsigned int state = dst->ce_flags & CE_HASHED; 231 232/* Don't copy hash chain and name */ 233memcpy(&dst->ce_stat_data, &src->ce_stat_data, 234offsetof(struct cache_entry, name) - 235offsetof(struct cache_entry, ce_stat_data)); 236 237/* Restore the hash state */ 238 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 239} 240 241staticinlineunsignedcreate_ce_flags(unsigned stage) 242{ 243return(stage << CE_STAGESHIFT); 244} 245 246#define ce_namelen(ce) ((ce)->ce_namelen) 247#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 248#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 249#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 250#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 251#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 252#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 253 254#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 255staticinlineunsigned intcreate_ce_mode(unsigned int mode) 256{ 257if(S_ISLNK(mode)) 258return S_IFLNK; 259if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 260return S_IFGITLINK; 261return S_IFREG |ce_permissions(mode); 262} 263staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 264unsigned int mode) 265{ 266externint trust_executable_bit, has_symlinks; 267if(!has_symlinks &&S_ISREG(mode) && 268 ce &&S_ISLNK(ce->ce_mode)) 269return ce->ce_mode; 270if(!trust_executable_bit &&S_ISREG(mode)) { 271if(ce &&S_ISREG(ce->ce_mode)) 272return ce->ce_mode; 273returncreate_ce_mode(0666); 274} 275returncreate_ce_mode(mode); 276} 277staticinlineintce_to_dtype(const struct cache_entry *ce) 278{ 279unsigned ce_mode =ntohl(ce->ce_mode); 280if(S_ISREG(ce_mode)) 281return DT_REG; 282else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 283return DT_DIR; 284else if(S_ISLNK(ce_mode)) 285return DT_LNK; 286else 287return DT_UNKNOWN; 288} 289staticinlineunsigned intcanon_mode(unsigned int mode) 290{ 291if(S_ISREG(mode)) 292return S_IFREG |ce_permissions(mode); 293if(S_ISLNK(mode)) 294return S_IFLNK; 295if(S_ISDIR(mode)) 296return S_IFDIR; 297return S_IFGITLINK; 298} 299 300#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 301 302#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 303#define CE_ENTRY_CHANGED (1 << 1) 304#define CE_ENTRY_REMOVED (1 << 2) 305#define CE_ENTRY_ADDED (1 << 3) 306#define RESOLVE_UNDO_CHANGED (1 << 4) 307#define CACHE_TREE_CHANGED (1 << 5) 308#define SPLIT_INDEX_ORDERED (1 << 6) 309#define UNTRACKED_CHANGED (1 << 7) 310#define FSMONITOR_CHANGED (1 << 8) 311 312struct split_index; 313struct untracked_cache; 314 315struct index_state { 316struct cache_entry **cache; 317unsigned int version; 318unsigned int cache_nr, cache_alloc, cache_changed; 319struct string_list *resolve_undo; 320struct cache_tree *cache_tree; 321struct split_index *split_index; 322struct cache_time timestamp; 323unsigned name_hash_initialized :1, 324 initialized :1, 325 drop_cache_tree :1; 326struct hashmap name_hash; 327struct hashmap dir_hash; 328unsigned char sha1[20]; 329struct untracked_cache *untracked; 330uint64_t fsmonitor_last_update; 331struct ewah_bitmap *fsmonitor_dirty; 332}; 333 334externstruct index_state the_index; 335 336/* Name hashing */ 337externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 338externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 339externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 340externvoidfree_name_hash(struct index_state *istate); 341 342 343#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 344#define active_cache (the_index.cache) 345#define active_nr (the_index.cache_nr) 346#define active_alloc (the_index.cache_alloc) 347#define active_cache_changed (the_index.cache_changed) 348#define active_cache_tree (the_index.cache_tree) 349 350#define read_cache() read_index(&the_index) 351#define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir())) 352#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 353#define is_cache_unborn() is_index_unborn(&the_index) 354#define read_cache_unmerged() read_index_unmerged(&the_index) 355#define discard_cache() discard_index(&the_index) 356#define unmerged_cache() unmerged_index(&the_index) 357#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 358#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 359#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 360#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 361#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 362#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 363#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 364#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 365#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 366#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 367#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 368#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 369#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 370#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 371#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 372#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 373#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 374#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 375#endif 376 377enum object_type { 378 OBJ_BAD = -1, 379 OBJ_NONE =0, 380 OBJ_COMMIT =1, 381 OBJ_TREE =2, 382 OBJ_BLOB =3, 383 OBJ_TAG =4, 384/* 5 for future expansion */ 385 OBJ_OFS_DELTA =6, 386 OBJ_REF_DELTA =7, 387 OBJ_ANY, 388 OBJ_MAX 389}; 390 391staticinlineenum object_type object_type(unsigned int mode) 392{ 393returnS_ISDIR(mode) ? OBJ_TREE : 394S_ISGITLINK(mode) ? OBJ_COMMIT : 395 OBJ_BLOB; 396} 397 398/* Double-check local_repo_env below if you add to this list. */ 399#define GIT_DIR_ENVIRONMENT"GIT_DIR" 400#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 401#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 402#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 403#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 404#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 405#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 406#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 407#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 408#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 409#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 410#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 411#define CONFIG_ENVIRONMENT"GIT_CONFIG" 412#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 413#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 414#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 415#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 416#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 417#define GITATTRIBUTES_FILE".gitattributes" 418#define INFOATTRIBUTES_FILE"info/attributes" 419#define ATTRIBUTE_MACRO_PREFIX"[attr]" 420#define GITMODULES_FILE".gitmodules" 421#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 422#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 423#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 424#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 425#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 426#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 427#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 428#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 429#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 430#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 431#define GIT_OPTIONAL_LOCKS_ENVIRONMENT"GIT_OPTIONAL_LOCKS" 432 433/* 434 * Environment variable used in handshaking the wire protocol. 435 * Contains a colon ':' separated list of keys with optional values 436 * 'key[=value]'. Presence of unknown keys and values must be 437 * ignored. 438 */ 439#define GIT_PROTOCOL_ENVIRONMENT"GIT_PROTOCOL" 440/* HTTP header used to handshake the wire protocol */ 441#define GIT_PROTOCOL_HEADER"Git-Protocol" 442 443/* 444 * This environment variable is expected to contain a boolean indicating 445 * whether we should or should not treat: 446 * 447 * GIT_DIR=foo.git git ... 448 * 449 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 450 * of this, but we use it internally to communicate to sub-processes that we 451 * are in a bare repo. If not set, defaults to true. 452 */ 453#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 454 455/* 456 * Repository-local GIT_* environment variables; these will be cleared 457 * when git spawns a sub-process that runs inside another repository. 458 * The array is NULL-terminated, which makes it easy to pass in the "env" 459 * parameter of a run-command invocation, or to do a simple walk. 460 */ 461externconst char*const local_repo_env[]; 462 463externvoidsetup_git_env(void); 464 465/* 466 * Returns true iff we have a configured git repository (either via 467 * setup_git_directory, or in the environment via $GIT_DIR). 468 */ 469inthave_git_dir(void); 470 471externint is_bare_repository_cfg; 472externintis_bare_repository(void); 473externintis_inside_git_dir(void); 474externchar*git_work_tree_cfg; 475externintis_inside_work_tree(void); 476externconst char*get_git_dir(void); 477externconst char*get_git_common_dir(void); 478externchar*get_object_directory(void); 479externchar*get_index_file(void); 480externchar*get_graft_file(void); 481externintset_git_dir(const char*path); 482externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 483externintget_common_dir(struct strbuf *sb,const char*gitdir); 484externconst char*get_git_namespace(void); 485externconst char*strip_namespace(const char*namespaced_ref); 486externconst char*get_super_prefix(void); 487externconst char*get_git_work_tree(void); 488 489/* 490 * Return true if the given path is a git directory; note that this _just_ 491 * looks at the directory itself. If you want to know whether "foo/.git" 492 * is a repository, you must feed that path, not just "foo". 493 */ 494externintis_git_directory(const char*path); 495 496/* 497 * Return 1 if the given path is the root of a git repository or 498 * submodule, else 0. Will not return 1 for bare repositories with the 499 * exception of creating a bare repository in "foo/.git" and calling 500 * is_git_repository("foo"). 501 * 502 * If we run into read errors, we err on the side of saying "yes, it is", 503 * as we usually consider sub-repos precious, and would prefer to err on the 504 * side of not disrupting or deleting them. 505 */ 506externintis_nonbare_repository_dir(struct strbuf *path); 507 508#define READ_GITFILE_ERR_STAT_FAILED 1 509#define READ_GITFILE_ERR_NOT_A_FILE 2 510#define READ_GITFILE_ERR_OPEN_FAILED 3 511#define READ_GITFILE_ERR_READ_FAILED 4 512#define READ_GITFILE_ERR_INVALID_FORMAT 5 513#define READ_GITFILE_ERR_NO_PATH 6 514#define READ_GITFILE_ERR_NOT_A_REPO 7 515#define READ_GITFILE_ERR_TOO_LARGE 8 516externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 517externconst char*read_gitfile_gently(const char*path,int*return_error_code); 518#define read_gitfile(path) read_gitfile_gently((path), NULL) 519externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 520#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 521 522externvoidset_git_work_tree(const char*tree); 523 524#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 525 526externvoidsetup_work_tree(void); 527/* 528 * Find the commondir and gitdir of the repository that contains the current 529 * working directory, without changing the working directory or other global 530 * state. The result is appended to commondir and gitdir. If the discovered 531 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 532 * both have the same result appended to the buffer. The return value is 533 * either 0 upon success and non-zero if no repository was found. 534 */ 535externintdiscover_git_directory(struct strbuf *commondir, 536struct strbuf *gitdir); 537externconst char*setup_git_directory_gently(int*); 538externconst char*setup_git_directory(void); 539externchar*prefix_path(const char*prefix,int len,const char*path); 540externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 541 542/* 543 * Concatenate "prefix" (if len is non-zero) and "path", with no 544 * connecting characters (so "prefix" should end with a "/"). 545 * Unlike prefix_path, this should be used if the named file does 546 * not have to interact with index entry; i.e. name of a random file 547 * on the filesystem. 548 * 549 * The return value is always a newly allocated string (even if the 550 * prefix was empty). 551 */ 552externchar*prefix_filename(const char*prefix,const char*path); 553 554externintcheck_filename(const char*prefix,const char*name); 555externvoidverify_filename(const char*prefix, 556const char*name, 557int diagnose_misspelt_rev); 558externvoidverify_non_filename(const char*prefix,const char*name); 559externintpath_inside_repo(const char*prefix,const char*path); 560 561#define INIT_DB_QUIET 0x0001 562#define INIT_DB_EXIST_OK 0x0002 563 564externintinit_db(const char*git_dir,const char*real_git_dir, 565const char*template_dir,unsigned int flags); 566 567externvoidsanitize_stdfds(void); 568externintdaemonize(void); 569 570#define alloc_nr(x) (((x)+16)*3/2) 571 572/* 573 * Realloc the buffer pointed at by variable 'x' so that it can hold 574 * at least 'nr' entries; the number of entries currently allocated 575 * is 'alloc', using the standard growing factor alloc_nr() macro. 576 * 577 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 578 */ 579#define ALLOC_GROW(x, nr, alloc) \ 580 do { \ 581 if ((nr) > alloc) { \ 582 if (alloc_nr(alloc) < (nr)) \ 583 alloc = (nr); \ 584 else \ 585 alloc = alloc_nr(alloc); \ 586 REALLOC_ARRAY(x, alloc); \ 587 } \ 588 } while (0) 589 590/* Initialize and use the cache information */ 591struct lock_file; 592externintread_index(struct index_state *); 593externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 594externintdo_read_index(struct index_state *istate,const char*path, 595int must_exist);/* for testting only! */ 596externintread_index_from(struct index_state *,const char*path, 597const char*gitdir); 598externintis_index_unborn(struct index_state *); 599externintread_index_unmerged(struct index_state *); 600 601/* For use with `write_locked_index()`. */ 602#define COMMIT_LOCK (1 << 0) 603#define SKIP_IF_UNCHANGED (1 << 1) 604 605/* 606 * Write the index while holding an already-taken lock. Close the lock, 607 * and if `COMMIT_LOCK` is given, commit it. 608 * 609 * Unless a split index is in use, write the index into the lockfile. 610 * 611 * With a split index, write the shared index to a temporary file, 612 * adjust its permissions and rename it into place, then write the 613 * split index to the lockfile. If the temporary file for the shared 614 * index cannot be created, fall back to the behavior described in 615 * the previous paragraph. 616 * 617 * With `COMMIT_LOCK`, the lock is always committed or rolled back. 618 * Without it, the lock is closed, but neither committed nor rolled 619 * back. 620 * 621 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing 622 * is written (and the lock is rolled back if `COMMIT_LOCK` is given). 623 */ 624externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 625 626externintdiscard_index(struct index_state *); 627externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 628externintunmerged_index(const struct index_state *); 629 630/** 631 * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL, 632 * compares istate to HEAD. If tree is NULL and on an unborn branch, 633 * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is 634 * provided, the space-separated list of files that differ will be appended 635 * to it. 636 */ 637externintindex_has_changes(const struct index_state *istate, 638struct tree *tree, 639struct strbuf *sb); 640 641externintverify_path(const char*path,unsigned mode); 642externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 643externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 644externvoidadjust_dirname_case(struct index_state *istate,char*name); 645externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 646 647/* 648 * Searches for an entry defined by name and namelen in the given index. 649 * If the return value is positive (including 0) it is the position of an 650 * exact match. If the return value is negative, the negated value minus 1 651 * is the position where the entry would be inserted. 652 * Example: The current index consists of these files and its stages: 653 * 654 * b#0, d#0, f#1, f#3 655 * 656 * index_name_pos(&index, "a", 1) -> -1 657 * index_name_pos(&index, "b", 1) -> 0 658 * index_name_pos(&index, "c", 1) -> -2 659 * index_name_pos(&index, "d", 1) -> 1 660 * index_name_pos(&index, "e", 1) -> -3 661 * index_name_pos(&index, "f", 1) -> -3 662 * index_name_pos(&index, "g", 1) -> -5 663 */ 664externintindex_name_pos(const struct index_state *,const char*name,int namelen); 665 666#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 667#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 668#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 669#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 670#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 671#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 672externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 673externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 674 675/* Remove entry, return true if there are more entries to go. */ 676externintremove_index_entry_at(struct index_state *,int pos); 677 678externvoidremove_marked_cache_entries(struct index_state *istate); 679externintremove_file_from_index(struct index_state *,const char*path); 680#define ADD_CACHE_VERBOSE 1 681#define ADD_CACHE_PRETEND 2 682#define ADD_CACHE_IGNORE_ERRORS 4 683#define ADD_CACHE_IGNORE_REMOVAL 8 684#define ADD_CACHE_INTENT 16 685/* 686 * These two are used to add the contents of the file at path 687 * to the index, marking the working tree up-to-date by storing 688 * the cached stat info in the resulting cache entry. A caller 689 * that has already run lstat(2) on the path can call 690 * add_to_index(), and all others can call add_file_to_index(); 691 * the latter will do necessary lstat(2) internally before 692 * calling the former. 693 */ 694externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 695externintadd_file_to_index(struct index_state *,const char*path,int flags); 696 697externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 698externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 699externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 700externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 701externintindex_name_is_other(const struct index_state *,const char*,int); 702externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 703 704/* do stat comparison even if CE_VALID is true */ 705#define CE_MATCH_IGNORE_VALID 01 706/* do not check the contents but report dirty on racily-clean entries */ 707#define CE_MATCH_RACY_IS_DIRTY 02 708/* do stat comparison even if CE_SKIP_WORKTREE is true */ 709#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 710/* ignore non-existent files during stat update */ 711#define CE_MATCH_IGNORE_MISSING 0x08 712/* enable stat refresh */ 713#define CE_MATCH_REFRESH 0x10 714/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */ 715#define CE_MATCH_IGNORE_FSMONITOR 0X20 716externintie_match_stat(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 717externintie_modified(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 718 719#define HASH_WRITE_OBJECT 1 720#define HASH_FORMAT_CHECK 2 721#define HASH_RENORMALIZE 4 722externintindex_fd(struct object_id *oid,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 723externintindex_path(struct object_id *oid,const char*path,struct stat *st,unsigned flags); 724 725/* 726 * Record to sd the data from st that we use to check whether a file 727 * might have changed. 728 */ 729externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 730 731/* 732 * Return 0 if st is consistent with a file not having been changed 733 * since sd was filled. If there are differences, return a 734 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 735 * INODE_CHANGED, and DATA_CHANGED. 736 */ 737externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 738externintmatch_stat_data_racy(const struct index_state *istate, 739const struct stat_data *sd,struct stat *st); 740 741externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 742 743#define REFRESH_REALLY 0x0001/* ignore_valid */ 744#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 745#define REFRESH_QUIET 0x0004/* be quiet about it */ 746#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 747#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 748#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 749externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 750externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 751 752/* 753 * Opportunistically update the index but do not complain if we can't. 754 * The lockfile is always committed or rolled back. 755 */ 756externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 757 758externinthold_locked_index(struct lock_file *,int); 759externvoidset_alternate_index_output(const char*); 760 761externint verify_index_checksum; 762externint verify_ce_order; 763 764/* Environment bits from configuration mechanism */ 765externint trust_executable_bit; 766externint trust_ctime; 767externint check_stat; 768externint quote_path_fully; 769externint has_symlinks; 770externint minimum_abbrev, default_abbrev; 771externint ignore_case; 772externint assume_unchanged; 773externint prefer_symlink_refs; 774externint warn_ambiguous_refs; 775externint warn_on_object_refname_ambiguity; 776externconst char*apply_default_whitespace; 777externconst char*apply_default_ignorewhitespace; 778externconst char*git_attributes_file; 779externconst char*git_hooks_path; 780externint zlib_compression_level; 781externint core_compression_level; 782externint pack_compression_level; 783externsize_t packed_git_window_size; 784externsize_t packed_git_limit; 785externsize_t delta_base_cache_limit; 786externunsigned long big_file_threshold; 787externunsigned long pack_size_limit_cfg; 788 789/* 790 * Accessors for the core.sharedrepository config which lazy-load the value 791 * from the config (if not already set). The "reset" function can be 792 * used to unset "set" or cached value, meaning that the value will be loaded 793 * fresh from the config file on the next call to get_shared_repository(). 794 */ 795voidset_shared_repository(int value); 796intget_shared_repository(void); 797voidreset_shared_repository(void); 798 799/* 800 * Do replace refs need to be checked this run? This variable is 801 * initialized to true unless --no-replace-object is used or 802 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 803 * commands that do not want replace references to be active. As an 804 * optimization it is also set to false if replace references have 805 * been sought but there were none. 806 */ 807externint check_replace_refs; 808externchar*git_replace_ref_base; 809 810externint fsync_object_files; 811externint core_preload_index; 812externint core_apply_sparse_checkout; 813externint precomposed_unicode; 814externint protect_hfs; 815externint protect_ntfs; 816externconst char*core_fsmonitor; 817 818/* 819 * Include broken refs in all ref iterations, which will 820 * generally choke dangerous operations rather than letting 821 * them silently proceed without taking the broken ref into 822 * account. 823 */ 824externint ref_paranoia; 825 826/* 827 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value). 828 */ 829intuse_optional_locks(void); 830 831/* 832 * The character that begins a commented line in user-editable file 833 * that is subject to stripspace. 834 */ 835externchar comment_line_char; 836externint auto_comment_line_char; 837 838/* Windows only */ 839enum hide_dotfiles_type { 840 HIDE_DOTFILES_FALSE =0, 841 HIDE_DOTFILES_TRUE, 842 HIDE_DOTFILES_DOTGITONLY 843}; 844externenum hide_dotfiles_type hide_dotfiles; 845 846enum log_refs_config { 847 LOG_REFS_UNSET = -1, 848 LOG_REFS_NONE =0, 849 LOG_REFS_NORMAL, 850 LOG_REFS_ALWAYS 851}; 852externenum log_refs_config log_all_ref_updates; 853 854enum branch_track { 855 BRANCH_TRACK_UNSPECIFIED = -1, 856 BRANCH_TRACK_NEVER =0, 857 BRANCH_TRACK_REMOTE, 858 BRANCH_TRACK_ALWAYS, 859 BRANCH_TRACK_EXPLICIT, 860 BRANCH_TRACK_OVERRIDE 861}; 862 863enum rebase_setup_type { 864 AUTOREBASE_NEVER =0, 865 AUTOREBASE_LOCAL, 866 AUTOREBASE_REMOTE, 867 AUTOREBASE_ALWAYS 868}; 869 870enum push_default_type { 871 PUSH_DEFAULT_NOTHING =0, 872 PUSH_DEFAULT_MATCHING, 873 PUSH_DEFAULT_SIMPLE, 874 PUSH_DEFAULT_UPSTREAM, 875 PUSH_DEFAULT_CURRENT, 876 PUSH_DEFAULT_UNSPECIFIED 877}; 878 879externenum branch_track git_branch_track; 880externenum rebase_setup_type autorebase; 881externenum push_default_type push_default; 882 883enum object_creation_mode { 884 OBJECT_CREATION_USES_HARDLINKS =0, 885 OBJECT_CREATION_USES_RENAMES =1 886}; 887 888externenum object_creation_mode object_creation_mode; 889 890externchar*notes_ref_name; 891 892externint grafts_replace_parents; 893 894/* 895 * GIT_REPO_VERSION is the version we write by default. The 896 * _READ variant is the highest number we know how to 897 * handle. 898 */ 899#define GIT_REPO_VERSION 0 900#define GIT_REPO_VERSION_READ 1 901externint repository_format_precious_objects; 902externchar*repository_format_partial_clone; 903externconst char*core_partial_clone_filter_default; 904 905struct repository_format { 906int version; 907int precious_objects; 908char*partial_clone;/* value of extensions.partialclone */ 909int is_bare; 910int hash_algo; 911char*work_tree; 912struct string_list unknown_extensions; 913}; 914 915/* 916 * Read the repository format characteristics from the config file "path" into 917 * "format" struct. Returns the numeric version. On error, -1 is returned, 918 * format->version is set to -1, and all other fields in the struct are 919 * undefined. 920 */ 921intread_repository_format(struct repository_format *format,const char*path); 922 923/* 924 * Verify that the repository described by repository_format is something we 925 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 926 * any errors encountered. 927 */ 928intverify_repository_format(const struct repository_format *format, 929struct strbuf *err); 930 931/* 932 * Check the repository format version in the path found in get_git_dir(), 933 * and die if it is a version we don't understand. Generally one would 934 * set_git_dir() before calling this, and use it only for "are we in a valid 935 * repo?". 936 */ 937externvoidcheck_repository_format(void); 938 939#define MTIME_CHANGED 0x0001 940#define CTIME_CHANGED 0x0002 941#define OWNER_CHANGED 0x0004 942#define MODE_CHANGED 0x0008 943#define INODE_CHANGED 0x0010 944#define DATA_CHANGED 0x0020 945#define TYPE_CHANGED 0x0040 946 947/* 948 * Put in `buf` the name of the file in the local object database that 949 * would be used to store a loose object with the specified sha1. 950 */ 951externvoidsha1_file_name(struct strbuf *buf,const unsigned char*sha1); 952 953/* 954 * Return an abbreviated sha1 unique within this repository's object database. 955 * The result will be at least `len` characters long, and will be NUL 956 * terminated. 957 * 958 * The non-`_r` version returns a static buffer which remains valid until 4 959 * more calls to find_unique_abbrev are made. 960 * 961 * The `_r` variant writes to a buffer supplied by the caller, which must be at 962 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 963 * written (excluding the NUL terminator). 964 * 965 * Note that while this version avoids the static buffer, it is not fully 966 * reentrant, as it calls into other non-reentrant git code. 967 */ 968externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 969externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 970 971externconst unsigned char null_sha1[GIT_MAX_RAWSZ]; 972externconst struct object_id null_oid; 973 974staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 975{ 976returnmemcmp(sha1, sha2, GIT_SHA1_RAWSZ); 977} 978 979staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 980{ 981returnhashcmp(oid1->hash, oid2->hash); 982} 983 984staticinlineintis_null_sha1(const unsigned char*sha1) 985{ 986return!hashcmp(sha1, null_sha1); 987} 988 989staticinlineintis_null_oid(const struct object_id *oid) 990{ 991return!hashcmp(oid->hash, null_sha1); 992} 993 994staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src) 995{ 996memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 997} 998 999staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src)1000{1001hashcpy(dst->hash, src->hash);1002}10031004staticinlinestruct object_id *oiddup(const struct object_id *src)1005{1006struct object_id *dst =xmalloc(sizeof(struct object_id));1007oidcpy(dst, src);1008return dst;1009}10101011staticinlinevoidhashclr(unsigned char*hash)1012{1013memset(hash,0, GIT_SHA1_RAWSZ);1014}10151016staticinlinevoidoidclr(struct object_id *oid)1017{1018memset(oid->hash,0, GIT_MAX_RAWSZ);1019}102010211022#define EMPTY_TREE_SHA1_HEX \1023"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1024#define EMPTY_TREE_SHA1_BIN_LITERAL \1025"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1026"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1027externconst struct object_id empty_tree_oid;1028#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10291030#define EMPTY_BLOB_SHA1_HEX \1031"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1032#define EMPTY_BLOB_SHA1_BIN_LITERAL \1033"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1034"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1035externconst struct object_id empty_blob_oid;10361037staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1038{1039return!hashcmp(sha1, the_hash_algo->empty_blob->hash);1040}10411042staticinlineintis_empty_blob_oid(const struct object_id *oid)1043{1044return!oidcmp(oid, the_hash_algo->empty_blob);1045}10461047staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1048{1049return!hashcmp(sha1, the_hash_algo->empty_tree->hash);1050}10511052staticinlineintis_empty_tree_oid(const struct object_id *oid)1053{1054return!oidcmp(oid, the_hash_algo->empty_tree);1055}10561057/* set default permissions by passing mode arguments to open(2) */1058intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1059intgit_mkstemp_mode(char*pattern,int mode);10601061/*1062 * NOTE NOTE NOTE!!1063 *1064 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1065 * not be changed. Old repositories have core.sharedrepository written in1066 * numeric format, and therefore these values are preserved for compatibility1067 * reasons.1068 */1069enum sharedrepo {1070 PERM_UMASK =0,1071 OLD_PERM_GROUP =1,1072 OLD_PERM_EVERYBODY =2,1073 PERM_GROUP =0660,1074 PERM_EVERYBODY =06641075};1076intgit_config_perm(const char*var,const char*value);1077intadjust_shared_perm(const char*path);10781079/*1080 * Create the directory containing the named path, using care to be1081 * somewhat safe against races. Return one of the scld_error values to1082 * indicate success/failure. On error, set errno to describe the1083 * problem.1084 *1085 * SCLD_VANISHED indicates that one of the ancestor directories of the1086 * path existed at one point during the function call and then1087 * suddenly vanished, probably because another process pruned the1088 * directory while we were working. To be robust against this kind of1089 * race, callers might want to try invoking the function again when it1090 * returns SCLD_VANISHED.1091 *1092 * safe_create_leading_directories() temporarily changes path while it1093 * is working but restores it before returning.1094 * safe_create_leading_directories_const() doesn't modify path, even1095 * temporarily.1096 */1097enum scld_error {1098 SCLD_OK =0,1099 SCLD_FAILED = -1,1100 SCLD_PERMS = -2,1101 SCLD_EXISTS = -3,1102 SCLD_VANISHED = -41103};1104enum scld_error safe_create_leading_directories(char*path);1105enum scld_error safe_create_leading_directories_const(const char*path);11061107/*1108 * Callback function for raceproof_create_file(). This function is1109 * expected to do something that makes dirname(path) permanent despite1110 * the fact that other processes might be cleaning up empty1111 * directories at the same time. Usually it will create a file named1112 * path, but alternatively it could create another file in that1113 * directory, or even chdir() into that directory. The function should1114 * return 0 if the action was completed successfully. On error, it1115 * should return a nonzero result and set errno.1116 * raceproof_create_file() treats two errno values specially:1117 *1118 * - ENOENT -- dirname(path) does not exist. In this case,1119 * raceproof_create_file() tries creating dirname(path)1120 * (and any parent directories, if necessary) and calls1121 * the function again.1122 *1123 * - EISDIR -- the file already exists and is a directory. In this1124 * case, raceproof_create_file() removes the directory if1125 * it is empty (and recursively any empty directories that1126 * it contains) and calls the function again.1127 *1128 * Any other errno causes raceproof_create_file() to fail with the1129 * callback's return value and errno.1130 *1131 * Obviously, this function should be OK with being called again if it1132 * fails with ENOENT or EISDIR. In other scenarios it will not be1133 * called again.1134 */1135typedefintcreate_file_fn(const char*path,void*cb);11361137/*1138 * Create a file in dirname(path) by calling fn, creating leading1139 * directories if necessary. Retry a few times in case we are racing1140 * with another process that is trying to clean up the directory that1141 * contains path. See the documentation for create_file_fn for more1142 * details.1143 *1144 * Return the value and set the errno that resulted from the most1145 * recent call of fn. fn is always called at least once, and will be1146 * called more than once if it returns ENOENT or EISDIR.1147 */1148intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11491150intmkdir_in_gitdir(const char*path);1151externchar*expand_user_path(const char*path,int real_home);1152const char*enter_repo(const char*path,int strict);1153staticinlineintis_absolute_path(const char*path)1154{1155returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1156}1157intis_directory(const char*);1158char*strbuf_realpath(struct strbuf *resolved,const char*path,1159int die_on_error);1160const char*real_path(const char*path);1161const char*real_path_if_valid(const char*path);1162char*real_pathdup(const char*path,int die_on_error);1163const char*absolute_path(const char*path);1164char*absolute_pathdup(const char*path);1165const char*remove_leading_path(const char*in,const char*prefix);1166const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1167intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1168intnormalize_path_copy(char*dst,const char*src);1169intlongest_ancestor_length(const char*path,struct string_list *prefixes);1170char*strip_path_suffix(const char*path,const char*suffix);1171intdaemon_avoid_alias(const char*path);11721173/*1174 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for1175 * details.1176 */1177intis_ntfs_dotgit(const char*name);1178intis_ntfs_dotgitmodules(const char*name);1179intis_ntfs_dotgitignore(const char*name);1180intis_ntfs_dotgitattributes(const char*name);11811182/*1183 * Returns true iff "str" could be confused as a command-line option when1184 * passed to a sub-program like "ssh". Note that this has nothing to do with1185 * shell-quoting, which should be handled separately; we're assuming here that1186 * the string makes it verbatim to the sub-program.1187 */1188intlooks_like_command_line_option(const char*str);11891190/**1191 * Return a newly allocated string with the evaluation of1192 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1193 * "$HOME/.config/git/$filename". Return NULL upon error.1194 */1195externchar*xdg_config_home(const char*filename);11961197/**1198 * Return a newly allocated string with the evaluation of1199 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1200 * "$HOME/.cache/git/$filename". Return NULL upon error.1201 */1202externchar*xdg_cache_home(const char*filename);12031204externvoid*read_sha1_file_extended(const unsigned char*sha1,1205enum object_type *type,1206unsigned long*size,int lookup_replace);1207staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1208{1209returnread_sha1_file_extended(sha1, type, size,1);1210}12111212/*1213 * This internal function is only declared here for the benefit of1214 * lookup_replace_object(). Please do not call it directly.1215 */1216externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);12171218/*1219 * If object sha1 should be replaced, return the replacement object's1220 * name (replaced recursively, if necessary). The return value is1221 * either sha1 or a pointer to a permanently-allocated value. When1222 * object replacement is suppressed, always return sha1.1223 */1224staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1225{1226if(!check_replace_refs)1227return sha1;1228returndo_lookup_replace_object(sha1);1229}12301231/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1232externintsha1_object_info(const unsigned char*,unsigned long*);12331234externinthash_object_file(const void*buf,unsigned long len,1235const char*type,struct object_id *oid);12361237externintwrite_object_file(const void*buf,unsigned long len,1238const char*type,struct object_id *oid);12391240externinthash_object_file_literally(const void*buf,unsigned long len,1241const char*type,struct object_id *oid,1242unsigned flags);12431244externintpretend_object_file(void*,unsigned long,enum object_type,1245struct object_id *oid);12461247externintforce_object_loose(const struct object_id *oid,time_t mtime);12481249externintgit_open_cloexec(const char*name,int flags);1250#define git_open(name) git_open_cloexec(name, O_RDONLY)1251externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1252externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1253externintparse_sha1_header(const char*hdr,unsigned long*sizep);12541255externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);12561257externintfinalize_object_file(const char*tmpfile,const char*filename);12581259/*1260 * Open the loose object at path, check its sha1, and return the contents,1261 * type, and size. If the object is a blob, then "contents" may return NULL,1262 * to allow streaming of large blobs.1263 *1264 * Returns 0 on success, negative on error (details may be written to stderr).1265 */1266intread_loose_object(const char*path,1267const unsigned char*expected_sha1,1268enum object_type *type,1269unsigned long*size,1270void**contents);12711272/*1273 * Convenience for sha1_object_info_extended() with a NULL struct1274 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass1275 * nonzero flags to also set other flags.1276 */1277externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1278staticinlineinthas_sha1_file(const unsigned char*sha1)1279{1280returnhas_sha1_file_with_flags(sha1,0);1281}12821283/* Same as the above, except for struct object_id. */1284externinthas_object_file(const struct object_id *oid);1285externinthas_object_file_with_flags(const struct object_id *oid,int flags);12861287/*1288 * Return true iff an alternate object database has a loose object1289 * with the specified name. This function does not respect replace1290 * references.1291 */1292externinthas_loose_object_nonlocal(const unsigned char*sha1);12931294externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);12951296/* Helper to check and "touch" a file */1297externintcheck_and_freshen_file(const char*fn,int freshen);12981299externconst signed char hexval_table[256];1300staticinlineunsigned inthexval(unsigned char c)1301{1302return hexval_table[c];1303}13041305/*1306 * Convert two consecutive hexadecimal digits into a char. Return a1307 * negative value on error. Don't run over the end of short strings.1308 */1309staticinlineinthex2chr(const char*s)1310{1311unsigned int val =hexval(s[0]);1312return(val & ~0xf) ? val : (val <<4) |hexval(s[1]);1313}13141315/* Convert to/from hex/sha1 representation */1316#define MINIMUM_ABBREV minimum_abbrev1317#define DEFAULT_ABBREV default_abbrev13181319/* used when the code does not know or care what the default abbrev is */1320#define FALLBACK_DEFAULT_ABBREV 713211322struct object_context {1323unsigned char tree[20];1324unsigned mode;1325/*1326 * symlink_path is only used by get_tree_entry_follow_symlinks,1327 * and only for symlinks that point outside the repository.1328 */1329struct strbuf symlink_path;1330/*1331 * If GET_OID_RECORD_PATH is set, this will record path (if any)1332 * found when resolving the name. The caller is responsible for1333 * releasing the memory.1334 */1335char*path;1336};13371338#define GET_OID_QUIETLY 011339#define GET_OID_COMMIT 021340#define GET_OID_COMMITTISH 041341#define GET_OID_TREE 0101342#define GET_OID_TREEISH 0201343#define GET_OID_BLOB 0401344#define GET_OID_FOLLOW_SYMLINKS 01001345#define GET_OID_RECORD_PATH 02001346#define GET_OID_ONLY_TO_DIE 0400013471348#define GET_OID_DISAMBIGUATORS \1349 (GET_OID_COMMIT | GET_OID_COMMITTISH | \1350 GET_OID_TREE | GET_OID_TREEISH | \1351 GET_OID_BLOB)13521353externintget_oid(const char*str,struct object_id *oid);1354externintget_oid_commit(const char*str,struct object_id *oid);1355externintget_oid_committish(const char*str,struct object_id *oid);1356externintget_oid_tree(const char*str,struct object_id *oid);1357externintget_oid_treeish(const char*str,struct object_id *oid);1358externintget_oid_blob(const char*str,struct object_id *oid);1359externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1360externintget_oid_with_context(const char*str,unsigned flags,struct object_id *oid,struct object_context *oc);136113621363typedefinteach_abbrev_fn(const struct object_id *oid,void*);1364externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13651366externintset_disambiguate_hint_config(const char*var,const char*value);13671368/*1369 * Try to read a SHA1 in hexadecimal format from the 40 characters1370 * starting at hex. Write the 20-byte result to sha1 in binary form.1371 * Return 0 on success. Reading stops if a NUL is encountered in the1372 * input, so it is safe to pass this function an arbitrary1373 * null-terminated string.1374 */1375externintget_sha1_hex(const char*hex,unsigned char*sha1);1376externintget_oid_hex(const char*hex,struct object_id *sha1);13771378/*1379 * Read `len` pairs of hexadecimal digits from `hex` and write the1380 * values to `binary` as `len` bytes. Return 0 on success, or -1 if1381 * the input does not consist of hex digits).1382 */1383externinthex_to_bytes(unsigned char*binary,const char*hex,size_t len);13841385/*1386 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1387 * and writes the NUL-terminated output to the buffer `out`, which must be at1388 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1389 * convenience.1390 *1391 * The non-`_r` variant returns a static buffer, but uses a ring of 41392 * buffers, making it safe to make multiple calls for a single statement, like:1393 *1394 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1395 */1396externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1397externchar*oid_to_hex_r(char*out,const struct object_id *oid);1398externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1399externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */14001401/*1402 * Parse a 40-character hexadecimal object ID starting from hex, updating the1403 * pointer specified by end when parsing stops. The resulting object ID is1404 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1405 * other invalid character. end is only updated on success; otherwise, it is1406 * unmodified.1407 */1408externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);14091410/*1411 * This reads short-hand syntax that not only evaluates to a commit1412 * object name, but also can act as if the end user spelled the name1413 * of the branch from the command line.1414 *1415 * - "@{-N}" finds the name of the Nth previous branch we were on, and1416 * places the name of the branch in the given buf and returns the1417 * number of characters parsed if successful.1418 *1419 * - "<branch>@{upstream}" finds the name of the other ref that1420 * <branch> is configured to merge with (missing <branch> defaults1421 * to the current branch), and places the name of the branch in the1422 * given buf and returns the number of characters parsed if1423 * successful.1424 *1425 * If the input is not of the accepted format, it returns a negative1426 * number to signal an error.1427 *1428 * If the input was ok but there are not N branch switches in the1429 * reflog, it returns 0.1430 *1431 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1432 * expansions: local branches ("refs/heads/"), remote branches1433 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1434 * allowed, even ones to refs outside of those namespaces.1435 */1436#define INTERPRET_BRANCH_LOCAL (1<<0)1437#define INTERPRET_BRANCH_REMOTE (1<<1)1438#define INTERPRET_BRANCH_HEAD (1<<2)1439externintinterpret_branch_name(const char*str,int len,struct strbuf *,1440unsigned allowed);1441externintget_oid_mb(const char*str,struct object_id *oid);14421443externintvalidate_headref(const char*ref);14441445externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1446externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1447externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1448externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);14491450externvoid*read_object_with_reference(const unsigned char*sha1,1451const char*required_type,1452unsigned long*size,1453unsigned char*sha1_ret);14541455externstruct object *peel_to_type(const char*name,int namelen,1456struct object *o,enum object_type);14571458struct date_mode {1459enum date_mode_type {1460 DATE_NORMAL =0,1461 DATE_RELATIVE,1462 DATE_SHORT,1463 DATE_ISO8601,1464 DATE_ISO8601_STRICT,1465 DATE_RFC2822,1466 DATE_STRFTIME,1467 DATE_RAW,1468 DATE_UNIX1469} type;1470const char*strftime_fmt;1471int local;1472};14731474/*1475 * Convenience helper for passing a constant type, like:1476 *1477 * show_date(t, tz, DATE_MODE(NORMAL));1478 */1479#define DATE_MODE(t) date_mode_from_type(DATE_##t)1480struct date_mode *date_mode_from_type(enum date_mode_type type);14811482const char*show_date(timestamp_t time,int timezone,const struct date_mode *mode);1483voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1484struct strbuf *timebuf);1485intparse_date(const char*date,struct strbuf *out);1486intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1487intparse_expiry_date(const char*date, timestamp_t *timestamp);1488voiddatestamp(struct strbuf *out);1489#define approxidate(s) approxidate_careful((s), NULL)1490timestamp_t approxidate_careful(const char*,int*);1491timestamp_t approxidate_relative(const char*date,const struct timeval *now);1492voidparse_date_format(const char*format,struct date_mode *mode);1493intdate_overflows(timestamp_t date);14941495#define IDENT_STRICT 11496#define IDENT_NO_DATE 21497#define IDENT_NO_NAME 41498externconst char*git_author_info(int);1499externconst char*git_committer_info(int);1500externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1501externconst char*fmt_name(const char*name,const char*email);1502externconst char*ident_default_name(void);1503externconst char*ident_default_email(void);1504externconst char*git_editor(void);1505externconst char*git_pager(int stdout_is_tty);1506externintis_terminal_dumb(void);1507externintgit_ident_config(const char*,const char*,void*);1508externvoidreset_ident_date(void);15091510struct ident_split {1511const char*name_begin;1512const char*name_end;1513const char*mail_begin;1514const char*mail_end;1515const char*date_begin;1516const char*date_end;1517const char*tz_begin;1518const char*tz_end;1519};1520/*1521 * Signals an success with 0, but time part of the result may be NULL1522 * if the input lacks timestamp and zone1523 */1524externintsplit_ident_line(struct ident_split *,const char*,int);15251526/*1527 * Like show_date, but pull the timestamp and tz parameters from1528 * the ident_split. It will also sanity-check the values and produce1529 * a well-known sentinel date if they appear bogus.1530 */1531const char*show_ident_date(const struct ident_split *id,1532const struct date_mode *mode);15331534/*1535 * Compare split idents for equality or strict ordering. Note that we1536 * compare only the ident part of the line, ignoring any timestamp.1537 *1538 * Because there are two fields, we must choose one as the primary key; we1539 * currently arbitrarily pick the email.1540 */1541externintident_cmp(const struct ident_split *,const struct ident_split *);15421543struct checkout {1544struct index_state *istate;1545const char*base_dir;1546int base_dir_len;1547struct delayed_checkout *delayed_checkout;1548unsigned force:1,1549 quiet:1,1550 not_new:1,1551 refresh_cache:1;1552};1553#define CHECKOUT_INIT { NULL,"" }15541555#define TEMPORARY_FILENAME_LENGTH 251556externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);1557externvoidenable_delayed_checkout(struct checkout *state);1558externintfinish_delayed_checkout(struct checkout *state);15591560struct cache_def {1561struct strbuf path;1562int flags;1563int track_flags;1564int prefix_len_stat_func;1565};1566#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1567staticinlinevoidcache_def_clear(struct cache_def *cache)1568{1569strbuf_release(&cache->path);1570}15711572externinthas_symlink_leading_path(const char*name,int len);1573externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1574externintcheck_leading_path(const char*name,int len);1575externinthas_dirs_only_path(const char*name,int len,int prefix_len);1576externvoidschedule_dir_for_removal(const char*name,int len);1577externvoidremove_scheduled_dirs(void);15781579externstruct alternate_object_database {1580struct alternate_object_database *next;15811582/* see alt_scratch_buf() */1583struct strbuf scratch;1584size_t base_len;15851586/*1587 * Used to store the results of readdir(3) calls when searching1588 * for unique abbreviated hashes. This cache is never1589 * invalidated, thus it's racy and not necessarily accurate.1590 * That's fine for its purpose; don't use it for tasks requiring1591 * greater accuracy!1592 */1593char loose_objects_subdir_seen[256];1594struct oid_array loose_objects_cache;15951596char path[FLEX_ARRAY];1597} *alt_odb_list;1598externvoidprepare_alt_odb(void);1599externchar*compute_alternate_path(const char*path,struct strbuf *err);1600typedefintalt_odb_fn(struct alternate_object_database *,void*);1601externintforeach_alt_odb(alt_odb_fn,void*);16021603/*1604 * Allocate a "struct alternate_object_database" but do _not_ actually1605 * add it to the list of alternates.1606 */1607struct alternate_object_database *alloc_alt_odb(const char*dir);16081609/*1610 * Add the directory to the on-disk alternates file; the new entry will also1611 * take effect in the current process.1612 */1613externvoidadd_to_alternates_file(const char*dir);16141615/*1616 * Add the directory to the in-memory list of alternates (along with any1617 * recursive alternates it points to), but do not modify the on-disk alternates1618 * file.1619 */1620externvoidadd_to_alternates_memory(const char*dir);16211622/*1623 * Returns a scratch strbuf pre-filled with the alternate object directory,1624 * including a trailing slash, which can be used to access paths in the1625 * alternate. Always use this over direct access to alt->scratch, as it1626 * cleans up any previous use of the scratch buffer.1627 */1628externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);16291630struct pack_window {1631struct pack_window *next;1632unsigned char*base;1633 off_t offset;1634size_t len;1635unsigned int last_used;1636unsigned int inuse_cnt;1637};16381639externstruct packed_git {1640struct packed_git *next;1641struct list_head mru;1642struct pack_window *windows;1643 off_t pack_size;1644const void*index_data;1645size_t index_size;1646uint32_t num_objects;1647uint32_t num_bad_objects;1648unsigned char*bad_object_sha1;1649int index_version;1650time_t mtime;1651int pack_fd;1652unsigned pack_local:1,1653 pack_keep:1,1654 freshened:1,1655 do_not_close:1,1656 pack_promisor:1;1657unsigned char sha1[20];1658struct revindex_entry *revindex;1659/* something like ".git/objects/pack/xxxxx.pack" */1660char pack_name[FLEX_ARRAY];/* more */1661} *packed_git;16621663/*1664 * A most-recently-used ordered version of the packed_git list.1665 */1666externstruct list_head packed_git_mru;16671668struct pack_entry {1669 off_t offset;1670unsigned char sha1[20];1671struct packed_git *p;1672};16731674/*1675 * Create a temporary file rooted in the object database directory, or1676 * die on failure. The filename is taken from "pattern", which should have the1677 * usual "XXXXXX" trailer, and the resulting filename is written into the1678 * "template" buffer. Returns the open descriptor.1679 */1680externintodb_mkstemp(struct strbuf *temp_filename,const char*pattern);16811682/*1683 * Create a pack .keep file named "name" (which should generally be the output1684 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1685 * error.1686 */1687externintodb_pack_keep(const char*name);16881689/*1690 * Iterate over the files in the loose-object parts of the object1691 * directory "path", triggering the following callbacks:1692 *1693 * - loose_object is called for each loose object we find.1694 *1695 * - loose_cruft is called for any files that do not appear to be1696 * loose objects. Note that we only look in the loose object1697 * directories "objects/[0-9a-f]{2}/", so we will not report1698 * "objects/foobar" as cruft.1699 *1700 * - loose_subdir is called for each top-level hashed subdirectory1701 * of the object directory (e.g., "$OBJDIR/f0"). It is called1702 * after the objects in the directory are processed.1703 *1704 * Any callback that is NULL will be ignored. Callbacks returning non-zero1705 * will end the iteration.1706 *1707 * In the "buf" variant, "path" is a strbuf which will also be used as a1708 * scratch buffer, but restored to its original contents before1709 * the function returns.1710 */1711typedefinteach_loose_object_fn(const struct object_id *oid,1712const char*path,1713void*data);1714typedefinteach_loose_cruft_fn(const char*basename,1715const char*path,1716void*data);1717typedefinteach_loose_subdir_fn(unsigned int nr,1718const char*path,1719void*data);1720intfor_each_file_in_obj_subdir(unsigned int subdir_nr,1721struct strbuf *path,1722 each_loose_object_fn obj_cb,1723 each_loose_cruft_fn cruft_cb,1724 each_loose_subdir_fn subdir_cb,1725void*data);1726intfor_each_loose_file_in_objdir(const char*path,1727 each_loose_object_fn obj_cb,1728 each_loose_cruft_fn cruft_cb,1729 each_loose_subdir_fn subdir_cb,1730void*data);1731intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1732 each_loose_object_fn obj_cb,1733 each_loose_cruft_fn cruft_cb,1734 each_loose_subdir_fn subdir_cb,1735void*data);17361737/*1738 * Iterate over loose objects in both the local1739 * repository and any alternates repositories (unless the1740 * LOCAL_ONLY flag is set).1741 */1742#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11743externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);17441745struct object_info {1746/* Request */1747enum object_type *typep;1748unsigned long*sizep;1749 off_t *disk_sizep;1750unsigned char*delta_base_sha1;1751struct strbuf *type_name;1752void**contentp;17531754/* Response */1755enum{1756 OI_CACHED,1757 OI_LOOSE,1758 OI_PACKED,1759 OI_DBCACHED1760} whence;1761union{1762/*1763 * struct {1764 * ... Nothing to expose in this case1765 * } cached;1766 * struct {1767 * ... Nothing to expose in this case1768 * } loose;1769 */1770struct{1771struct packed_git *pack;1772 off_t offset;1773unsigned int is_delta;1774} packed;1775} u;1776};17771778/*1779 * Initializer for a "struct object_info" that wants no items. You may1780 * also memset() the memory to all-zeroes.1781 */1782#define OBJECT_INFO_INIT {NULL}17831784/* Invoke lookup_replace_object() on the given hash */1785#define OBJECT_INFO_LOOKUP_REPLACE 11786/* Allow reading from a loose object file of unknown/bogus type */1787#define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 21788/* Do not check cached storage */1789#define OBJECT_INFO_SKIP_CACHED 41790/* Do not retry packed storage after checking packed and loose storage */1791#define OBJECT_INFO_QUICK 81792externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);17931794/*1795 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing1796 * blobs. This has a difference only if extensions.partialClone is set.1797 *1798 * Its default value is 1.1799 */1800externint fetch_if_missing;18011802/* Dumb servers support */1803externintupdate_server_info(int);18041805externconst char*get_log_output_encoding(void);1806externconst char*get_commit_output_encoding(void);18071808/*1809 * This is a hack for test programs like test-dump-untracked-cache to1810 * ensure that they do not modify the untracked cache when reading it.1811 * Do not use it otherwise!1812 */1813externint ignore_untracked_cache_config;18141815externintcommitter_ident_sufficiently_given(void);1816externintauthor_ident_sufficiently_given(void);18171818externconst char*git_commit_encoding;1819externconst char*git_log_output_encoding;1820externconst char*git_mailmap_file;1821externconst char*git_mailmap_blob;18221823/* IO helper functions */1824externvoidmaybe_flush_or_die(FILE*,const char*);1825__attribute__((format(printf,2,3)))1826externvoidfprintf_or_die(FILE*,const char*fmt, ...);18271828#define COPY_READ_ERROR (-2)1829#define COPY_WRITE_ERROR (-3)1830externintcopy_fd(int ifd,int ofd);1831externintcopy_file(const char*dst,const char*src,int mode);1832externintcopy_file_with_time(const char*dst,const char*src,int mode);18331834externvoidwrite_or_die(int fd,const void*buf,size_t count);1835externvoidfsync_or_die(int fd,const char*);18361837extern ssize_t read_in_full(int fd,void*buf,size_t count);1838extern ssize_t write_in_full(int fd,const void*buf,size_t count);1839extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);18401841staticinline ssize_t write_str_in_full(int fd,const char*str)1842{1843returnwrite_in_full(fd, str,strlen(str));1844}18451846/**1847 * Open (and truncate) the file at path, write the contents of buf to it,1848 * and close it. Dies if any errors are encountered.1849 */1850externvoidwrite_file_buf(const char*path,const char*buf,size_t len);18511852/**1853 * Like write_file_buf(), but format the contents into a buffer first.1854 * Additionally, write_file() will append a newline if one is not already1855 * present, making it convenient to write text files:1856 *1857 * write_file(path, "counter: %d", ctr);1858 */1859__attribute__((format(printf,2,3)))1860externvoidwrite_file(const char*path,const char*fmt, ...);18611862/* pager.c */1863externvoidsetup_pager(void);1864externintpager_in_use(void);1865externint pager_use_color;1866externintterm_columns(void);1867externintdecimal_width(uintmax_t);1868externintcheck_pager_config(const char*cmd);1869externvoidprepare_pager_args(struct child_process *,const char*pager);18701871externconst char*editor_program;1872externconst char*askpass_program;1873externconst char*excludes_file;18741875/* base85 */1876intdecode_85(char*dst,const char*line,int linelen);1877voidencode_85(char*buf,const unsigned char*data,int bytes);18781879/* alloc.c */1880externvoid*alloc_blob_node(void);1881externvoid*alloc_tree_node(void);1882externvoid*alloc_commit_node(void);1883externvoid*alloc_tag_node(void);1884externvoid*alloc_object_node(void);1885externvoidalloc_report(void);1886externunsigned intalloc_commit_index(void);18871888/* pkt-line.c */1889voidpacket_trace_identity(const char*prog);18901891/* add */1892/*1893 * return 0 if success, 1 - if addition of a file failed and1894 * ADD_FILES_IGNORE_ERRORS was specified in flags1895 */1896intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);18971898/* diff.c */1899externint diff_auto_refresh_index;19001901/* match-trees.c */1902voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1903voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);19041905/*1906 * whitespace rules.1907 * used by both diff and apply1908 * last two digits are tab width1909 */1910#define WS_BLANK_AT_EOL 01001911#define WS_SPACE_BEFORE_TAB 02001912#define WS_INDENT_WITH_NON_TAB 04001913#define WS_CR_AT_EOL 010001914#define WS_BLANK_AT_EOF 020001915#define WS_TAB_IN_INDENT 040001916#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1917#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1918#define WS_TAB_WIDTH_MASK 0771919/* All WS_* -- when extended, adapt diff.c emit_symbol */1920#define WS_RULE_MASK 077771921externunsigned whitespace_rule_cfg;1922externunsignedwhitespace_rule(const char*);1923externunsignedparse_whitespace_rule(const char*);1924externunsignedws_check(const char*line,int len,unsigned ws_rule);1925externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1926externchar*whitespace_error_string(unsigned ws);1927externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1928externintws_blank_line(const char*line,int len,unsigned ws_rule);1929#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)19301931/* ls-files */1932voidoverlay_tree_on_index(struct index_state *istate,1933const char*tree_name,const char*prefix);19341935char*alias_lookup(const char*alias);1936intsplit_cmdline(char*cmdline,const char***argv);1937/* Takes a negative value returned by split_cmdline */1938const char*split_cmdline_strerror(int cmdline_errno);19391940/* setup.c */1941struct startup_info {1942int have_repository;1943const char*prefix;1944};1945externstruct startup_info *startup_info;19461947/* merge.c */1948struct commit_list;1949inttry_merge_command(const char*strategy,size_t xopts_nr,1950const char**xopts,struct commit_list *common,1951const char*head_arg,struct commit_list *remotes);1952intcheckout_fast_forward(const struct object_id *from,1953const struct object_id *to,1954int overwrite_ignore);195519561957intsane_execvp(const char*file,char*const argv[]);19581959/*1960 * A struct to encapsulate the concept of whether a file has changed1961 * since we last checked it. This uses criteria similar to those used1962 * for the index.1963 */1964struct stat_validity {1965struct stat_data *sd;1966};19671968voidstat_validity_clear(struct stat_validity *sv);19691970/*1971 * Returns 1 if the path is a regular file (or a symlink to a regular1972 * file) and matches the saved stat_validity, 0 otherwise. A missing1973 * or inaccessible file is considered a match if the struct was just1974 * initialized, or if the previous update found an inaccessible file.1975 */1976intstat_validity_check(struct stat_validity *sv,const char*path);19771978/*1979 * Update the stat_validity from a file opened at descriptor fd. If1980 * the file is missing, inaccessible, or not a regular file, then1981 * future calls to stat_validity_check will match iff one of those1982 * conditions continues to be true.1983 */1984voidstat_validity_update(struct stat_validity *sv,int fd);19851986intversioncmp(const char*s1,const char*s2);1987voidsleep_millisec(int millisec);19881989/*1990 * Create a directory and (if share is nonzero) adjust its permissions1991 * according to the shared_repository setting. Only use this for1992 * directories under $GIT_DIR. Don't use it for working tree1993 * directories.1994 */1995voidsafe_create_dir(const char*dir,int share);19961997/*1998 * Should we print an ellipsis after an abbreviated SHA-1 value1999 * when doing diff-raw output or indicating a detached HEAD?2000 */2001externintprint_sha1_ellipsis(void);20022003#endif/* CACHE_H */