1#ifndef CACHE_H 2#define CACHE_H 3 4#include"git-compat-util.h" 5#include"strbuf.h" 6#include"hashmap.h" 7#include"advice.h" 8#include"gettext.h" 9#include"convert.h" 10#include"trace.h" 11#include"string-list.h" 12#include"pack-revindex.h" 13#include"hash.h" 14#include"path.h" 15#include"sha1-array.h" 16 17#ifndef platform_SHA_CTX 18/* 19 * platform's underlying implementation of SHA-1; could be OpenSSL, 20 * blk_SHA, Apple CommonCrypto, etc... Note that including 21 * SHA1_HEADER may have already defined platform_SHA_CTX for our 22 * own implementations like block-sha1 and ppc-sha1, so we list 23 * the default for OpenSSL compatible SHA-1 implementations here. 24 */ 25#define platform_SHA_CTX SHA_CTX 26#define platform_SHA1_Init SHA1_Init 27#define platform_SHA1_Update SHA1_Update 28#define platform_SHA1_Final SHA1_Final 29#endif 30 31#define git_SHA_CTX platform_SHA_CTX 32#define git_SHA1_Init platform_SHA1_Init 33#define git_SHA1_Update platform_SHA1_Update 34#define git_SHA1_Final platform_SHA1_Final 35 36#ifdef SHA1_MAX_BLOCK_SIZE 37#include"compat/sha1-chunked.h" 38#undef git_SHA1_Update 39#define git_SHA1_Update git_SHA1_Update_Chunked 40#endif 41 42#include <zlib.h> 43typedefstruct git_zstream { 44 z_stream z; 45unsigned long avail_in; 46unsigned long avail_out; 47unsigned long total_in; 48unsigned long total_out; 49unsigned char*next_in; 50unsigned char*next_out; 51} git_zstream; 52 53voidgit_inflate_init(git_zstream *); 54voidgit_inflate_init_gzip_only(git_zstream *); 55voidgit_inflate_end(git_zstream *); 56intgit_inflate(git_zstream *,int flush); 57 58voidgit_deflate_init(git_zstream *,int level); 59voidgit_deflate_init_gzip(git_zstream *,int level); 60voidgit_deflate_init_raw(git_zstream *,int level); 61voidgit_deflate_end(git_zstream *); 62intgit_deflate_abort(git_zstream *); 63intgit_deflate_end_gently(git_zstream *); 64intgit_deflate(git_zstream *,int flush); 65unsigned longgit_deflate_bound(git_zstream *,unsigned long); 66 67/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 68#define GIT_SHA1_RAWSZ 20 69#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 70 71/* The length in byte and in hex digits of the largest possible hash value. */ 72#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 73#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 74 75struct object_id { 76unsigned char hash[GIT_MAX_RAWSZ]; 77}; 78 79#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 80#define DTYPE(de) ((de)->d_type) 81#else 82#undef DT_UNKNOWN 83#undef DT_DIR 84#undef DT_REG 85#undef DT_LNK 86#define DT_UNKNOWN 0 87#define DT_DIR 1 88#define DT_REG 2 89#define DT_LNK 3 90#define DTYPE(de) DT_UNKNOWN 91#endif 92 93/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 94#define S_IFINVALID 0030000 95 96/* 97 * A "directory link" is a link to another git directory. 98 * 99 * The value 0160000 is not normally a valid mode, and 100 * also just happens to be S_IFDIR + S_IFLNK 101 */ 102#define S_IFGITLINK 0160000 103#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 104 105/* 106 * Some mode bits are also used internally for computations. 107 * 108 * They *must* not overlap with any valid modes, and they *must* not be emitted 109 * to outside world - i.e. appear on disk or network. In other words, it's just 110 * temporary fields, which we internally use, but they have to stay in-house. 111 * 112 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 113 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 114 */ 115 116/* used internally in tree-diff */ 117#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 118 119 120/* 121 * Intensive research over the course of many years has shown that 122 * port 9418 is totally unused by anything else. Or 123 * 124 * Your search - "port 9418" - did not match any documents. 125 * 126 * as www.google.com puts it. 127 * 128 * This port has been properly assigned for git use by IANA: 129 * git (Assigned-9418) [I06-050728-0001]. 130 * 131 * git 9418/tcp git pack transfer service 132 * git 9418/udp git pack transfer service 133 * 134 * with Linus Torvalds <torvalds@osdl.org> as the point of 135 * contact. September 2005. 136 * 137 * See http://www.iana.org/assignments/port-numbers 138 */ 139#define DEFAULT_GIT_PORT 9418 140 141/* 142 * Basic data structures for the directory cache 143 */ 144 145#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 146struct cache_header { 147uint32_t hdr_signature; 148uint32_t hdr_version; 149uint32_t hdr_entries; 150}; 151 152#define INDEX_FORMAT_LB 2 153#define INDEX_FORMAT_UB 4 154 155/* 156 * The "cache_time" is just the low 32 bits of the 157 * time. It doesn't matter if it overflows - we only 158 * check it for equality in the 32 bits we save. 159 */ 160struct cache_time { 161uint32_t sec; 162uint32_t nsec; 163}; 164 165struct stat_data { 166struct cache_time sd_ctime; 167struct cache_time sd_mtime; 168unsigned int sd_dev; 169unsigned int sd_ino; 170unsigned int sd_uid; 171unsigned int sd_gid; 172unsigned int sd_size; 173}; 174 175struct cache_entry { 176struct hashmap_entry ent; 177struct stat_data ce_stat_data; 178unsigned int ce_mode; 179unsigned int ce_flags; 180unsigned int ce_namelen; 181unsigned int index;/* for link extension */ 182struct object_id oid; 183char name[FLEX_ARRAY];/* more */ 184}; 185 186#define CE_STAGEMASK (0x3000) 187#define CE_EXTENDED (0x4000) 188#define CE_VALID (0x8000) 189#define CE_STAGESHIFT 12 190 191/* 192 * Range 0xFFFF0FFF in ce_flags is divided into 193 * two parts: in-memory flags and on-disk ones. 194 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 195 * if you want to save a new flag, add it in 196 * CE_EXTENDED_FLAGS 197 * 198 * In-memory only flags 199 */ 200#define CE_UPDATE (1 << 16) 201#define CE_REMOVE (1 << 17) 202#define CE_UPTODATE (1 << 18) 203#define CE_ADDED (1 << 19) 204 205#define CE_HASHED (1 << 20) 206#define CE_FSMONITOR_VALID (1 << 21) 207#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 208#define CE_CONFLICTED (1 << 23) 209 210#define CE_UNPACKED (1 << 24) 211#define CE_NEW_SKIP_WORKTREE (1 << 25) 212 213/* used to temporarily mark paths matched by pathspecs */ 214#define CE_MATCHED (1 << 26) 215 216#define CE_UPDATE_IN_BASE (1 << 27) 217#define CE_STRIP_NAME (1 << 28) 218 219/* 220 * Extended on-disk flags 221 */ 222#define CE_INTENT_TO_ADD (1 << 29) 223#define CE_SKIP_WORKTREE (1 << 30) 224/* CE_EXTENDED2 is for future extension */ 225#define CE_EXTENDED2 (1U << 31) 226 227#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 228 229/* 230 * Safeguard to avoid saving wrong flags: 231 * - CE_EXTENDED2 won't get saved until its semantic is known 232 * - Bits in 0x0000FFFF have been saved in ce_flags already 233 * - Bits in 0x003F0000 are currently in-memory flags 234 */ 235#if CE_EXTENDED_FLAGS & 0x803FFFFF 236#error"CE_EXTENDED_FLAGS out of range" 237#endif 238 239/* Forward structure decls */ 240struct pathspec; 241struct child_process; 242 243/* 244 * Copy the sha1 and stat state of a cache entry from one to 245 * another. But we never change the name, or the hash state! 246 */ 247staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 248const struct cache_entry *src) 249{ 250unsigned int state = dst->ce_flags & CE_HASHED; 251 252/* Don't copy hash chain and name */ 253memcpy(&dst->ce_stat_data, &src->ce_stat_data, 254offsetof(struct cache_entry, name) - 255offsetof(struct cache_entry, ce_stat_data)); 256 257/* Restore the hash state */ 258 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 259} 260 261staticinlineunsignedcreate_ce_flags(unsigned stage) 262{ 263return(stage << CE_STAGESHIFT); 264} 265 266#define ce_namelen(ce) ((ce)->ce_namelen) 267#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 268#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 269#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 270#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 271#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 272#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 273 274#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 275staticinlineunsigned intcreate_ce_mode(unsigned int mode) 276{ 277if(S_ISLNK(mode)) 278return S_IFLNK; 279if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 280return S_IFGITLINK; 281return S_IFREG |ce_permissions(mode); 282} 283staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 284unsigned int mode) 285{ 286externint trust_executable_bit, has_symlinks; 287if(!has_symlinks &&S_ISREG(mode) && 288 ce &&S_ISLNK(ce->ce_mode)) 289return ce->ce_mode; 290if(!trust_executable_bit &&S_ISREG(mode)) { 291if(ce &&S_ISREG(ce->ce_mode)) 292return ce->ce_mode; 293returncreate_ce_mode(0666); 294} 295returncreate_ce_mode(mode); 296} 297staticinlineintce_to_dtype(const struct cache_entry *ce) 298{ 299unsigned ce_mode =ntohl(ce->ce_mode); 300if(S_ISREG(ce_mode)) 301return DT_REG; 302else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 303return DT_DIR; 304else if(S_ISLNK(ce_mode)) 305return DT_LNK; 306else 307return DT_UNKNOWN; 308} 309staticinlineunsigned intcanon_mode(unsigned int mode) 310{ 311if(S_ISREG(mode)) 312return S_IFREG |ce_permissions(mode); 313if(S_ISLNK(mode)) 314return S_IFLNK; 315if(S_ISDIR(mode)) 316return S_IFDIR; 317return S_IFGITLINK; 318} 319 320#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 321 322#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 323#define CE_ENTRY_CHANGED (1 << 1) 324#define CE_ENTRY_REMOVED (1 << 2) 325#define CE_ENTRY_ADDED (1 << 3) 326#define RESOLVE_UNDO_CHANGED (1 << 4) 327#define CACHE_TREE_CHANGED (1 << 5) 328#define SPLIT_INDEX_ORDERED (1 << 6) 329#define UNTRACKED_CHANGED (1 << 7) 330#define FSMONITOR_CHANGED (1 << 8) 331 332struct split_index; 333struct untracked_cache; 334 335struct index_state { 336struct cache_entry **cache; 337unsigned int version; 338unsigned int cache_nr, cache_alloc, cache_changed; 339struct string_list *resolve_undo; 340struct cache_tree *cache_tree; 341struct split_index *split_index; 342struct cache_time timestamp; 343unsigned name_hash_initialized :1, 344 initialized :1; 345struct hashmap name_hash; 346struct hashmap dir_hash; 347unsigned char sha1[20]; 348struct untracked_cache *untracked; 349uint64_t fsmonitor_last_update; 350struct ewah_bitmap *fsmonitor_dirty; 351}; 352 353externstruct index_state the_index; 354 355/* Name hashing */ 356externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 357externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 358externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 359externvoidfree_name_hash(struct index_state *istate); 360 361 362#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 363#define active_cache (the_index.cache) 364#define active_nr (the_index.cache_nr) 365#define active_alloc (the_index.cache_alloc) 366#define active_cache_changed (the_index.cache_changed) 367#define active_cache_tree (the_index.cache_tree) 368 369#define read_cache() read_index(&the_index) 370#define read_cache_from(path) read_index_from(&the_index, (path)) 371#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 372#define is_cache_unborn() is_index_unborn(&the_index) 373#define read_cache_unmerged() read_index_unmerged(&the_index) 374#define discard_cache() discard_index(&the_index) 375#define unmerged_cache() unmerged_index(&the_index) 376#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 377#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 378#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 379#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 380#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 381#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 382#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 383#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 384#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 385#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 386#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 387#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 388#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 389#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 390#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 391#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 392#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 393#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 394#endif 395 396enum object_type { 397 OBJ_BAD = -1, 398 OBJ_NONE =0, 399 OBJ_COMMIT =1, 400 OBJ_TREE =2, 401 OBJ_BLOB =3, 402 OBJ_TAG =4, 403/* 5 for future expansion */ 404 OBJ_OFS_DELTA =6, 405 OBJ_REF_DELTA =7, 406 OBJ_ANY, 407 OBJ_MAX 408}; 409 410staticinlineenum object_type object_type(unsigned int mode) 411{ 412returnS_ISDIR(mode) ? OBJ_TREE : 413S_ISGITLINK(mode) ? OBJ_COMMIT : 414 OBJ_BLOB; 415} 416 417/* Double-check local_repo_env below if you add to this list. */ 418#define GIT_DIR_ENVIRONMENT"GIT_DIR" 419#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 420#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 421#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 422#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 423#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 424#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 425#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 426#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 427#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 428#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 429#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 430#define CONFIG_ENVIRONMENT"GIT_CONFIG" 431#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 432#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 433#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 434#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 435#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 436#define GITATTRIBUTES_FILE".gitattributes" 437#define INFOATTRIBUTES_FILE"info/attributes" 438#define ATTRIBUTE_MACRO_PREFIX"[attr]" 439#define GITMODULES_FILE".gitmodules" 440#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 441#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 442#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 443#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 444#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 445#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 446#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 447#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 448#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 449#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 450 451/* 452 * This environment variable is expected to contain a boolean indicating 453 * whether we should or should not treat: 454 * 455 * GIT_DIR=foo.git git ... 456 * 457 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 458 * of this, but we use it internally to communicate to sub-processes that we 459 * are in a bare repo. If not set, defaults to true. 460 */ 461#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 462 463/* 464 * Repository-local GIT_* environment variables; these will be cleared 465 * when git spawns a sub-process that runs inside another repository. 466 * The array is NULL-terminated, which makes it easy to pass in the "env" 467 * parameter of a run-command invocation, or to do a simple walk. 468 */ 469externconst char*const local_repo_env[]; 470 471externvoidsetup_git_env(void); 472 473/* 474 * Returns true iff we have a configured git repository (either via 475 * setup_git_directory, or in the environment via $GIT_DIR). 476 */ 477inthave_git_dir(void); 478 479externint is_bare_repository_cfg; 480externintis_bare_repository(void); 481externintis_inside_git_dir(void); 482externchar*git_work_tree_cfg; 483externintis_inside_work_tree(void); 484externconst char*get_git_dir(void); 485externconst char*get_git_common_dir(void); 486externchar*get_object_directory(void); 487externchar*get_index_file(void); 488externchar*get_graft_file(void); 489externintset_git_dir(const char*path); 490externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 491externintget_common_dir(struct strbuf *sb,const char*gitdir); 492externconst char*get_git_namespace(void); 493externconst char*strip_namespace(const char*namespaced_ref); 494externconst char*get_super_prefix(void); 495externconst char*get_git_work_tree(void); 496 497/* 498 * Return true if the given path is a git directory; note that this _just_ 499 * looks at the directory itself. If you want to know whether "foo/.git" 500 * is a repository, you must feed that path, not just "foo". 501 */ 502externintis_git_directory(const char*path); 503 504/* 505 * Return 1 if the given path is the root of a git repository or 506 * submodule, else 0. Will not return 1 for bare repositories with the 507 * exception of creating a bare repository in "foo/.git" and calling 508 * is_git_repository("foo"). 509 * 510 * If we run into read errors, we err on the side of saying "yes, it is", 511 * as we usually consider sub-repos precious, and would prefer to err on the 512 * side of not disrupting or deleting them. 513 */ 514externintis_nonbare_repository_dir(struct strbuf *path); 515 516#define READ_GITFILE_ERR_STAT_FAILED 1 517#define READ_GITFILE_ERR_NOT_A_FILE 2 518#define READ_GITFILE_ERR_OPEN_FAILED 3 519#define READ_GITFILE_ERR_READ_FAILED 4 520#define READ_GITFILE_ERR_INVALID_FORMAT 5 521#define READ_GITFILE_ERR_NO_PATH 6 522#define READ_GITFILE_ERR_NOT_A_REPO 7 523#define READ_GITFILE_ERR_TOO_LARGE 8 524externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 525externconst char*read_gitfile_gently(const char*path,int*return_error_code); 526#define read_gitfile(path) read_gitfile_gently((path), NULL) 527externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 528#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 529 530externvoidset_git_work_tree(const char*tree); 531 532#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 533 534externvoidsetup_work_tree(void); 535/* 536 * Find the commondir and gitdir of the repository that contains the current 537 * working directory, without changing the working directory or other global 538 * state. The result is appended to commondir and gitdir. If the discovered 539 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 540 * both have the same result appended to the buffer. The return value is 541 * either 0 upon success and non-zero if no repository was found. 542 */ 543externintdiscover_git_directory(struct strbuf *commondir, 544struct strbuf *gitdir); 545externconst char*setup_git_directory_gently(int*); 546externconst char*setup_git_directory(void); 547externchar*prefix_path(const char*prefix,int len,const char*path); 548externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 549 550/* 551 * Concatenate "prefix" (if len is non-zero) and "path", with no 552 * connecting characters (so "prefix" should end with a "/"). 553 * Unlike prefix_path, this should be used if the named file does 554 * not have to interact with index entry; i.e. name of a random file 555 * on the filesystem. 556 * 557 * The return value is always a newly allocated string (even if the 558 * prefix was empty). 559 */ 560externchar*prefix_filename(const char*prefix,const char*path); 561 562externintcheck_filename(const char*prefix,const char*name); 563externvoidverify_filename(const char*prefix, 564const char*name, 565int diagnose_misspelt_rev); 566externvoidverify_non_filename(const char*prefix,const char*name); 567externintpath_inside_repo(const char*prefix,const char*path); 568 569#define INIT_DB_QUIET 0x0001 570#define INIT_DB_EXIST_OK 0x0002 571 572externintinit_db(const char*git_dir,const char*real_git_dir, 573const char*template_dir,unsigned int flags); 574 575externvoidsanitize_stdfds(void); 576externintdaemonize(void); 577 578#define alloc_nr(x) (((x)+16)*3/2) 579 580/* 581 * Realloc the buffer pointed at by variable 'x' so that it can hold 582 * at least 'nr' entries; the number of entries currently allocated 583 * is 'alloc', using the standard growing factor alloc_nr() macro. 584 * 585 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 586 */ 587#define ALLOC_GROW(x, nr, alloc) \ 588 do { \ 589 if ((nr) > alloc) { \ 590 if (alloc_nr(alloc) < (nr)) \ 591 alloc = (nr); \ 592 else \ 593 alloc = alloc_nr(alloc); \ 594 REALLOC_ARRAY(x, alloc); \ 595 } \ 596 } while (0) 597 598/* Initialize and use the cache information */ 599struct lock_file; 600externintread_index(struct index_state *); 601externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 602externintdo_read_index(struct index_state *istate,const char*path, 603int must_exist);/* for testting only! */ 604externintread_index_from(struct index_state *,const char*path); 605externintis_index_unborn(struct index_state *); 606externintread_index_unmerged(struct index_state *); 607#define COMMIT_LOCK (1 << 0) 608#define CLOSE_LOCK (1 << 1) 609externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 610externintdiscard_index(struct index_state *); 611externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 612externintunmerged_index(const struct index_state *); 613externintverify_path(const char*path); 614externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 615externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 616externvoidadjust_dirname_case(struct index_state *istate,char*name); 617externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 618 619/* 620 * Searches for an entry defined by name and namelen in the given index. 621 * If the return value is positive (including 0) it is the position of an 622 * exact match. If the return value is negative, the negated value minus 1 623 * is the position where the entry would be inserted. 624 * Example: The current index consists of these files and its stages: 625 * 626 * b#0, d#0, f#1, f#3 627 * 628 * index_name_pos(&index, "a", 1) -> -1 629 * index_name_pos(&index, "b", 1) -> 0 630 * index_name_pos(&index, "c", 1) -> -2 631 * index_name_pos(&index, "d", 1) -> 1 632 * index_name_pos(&index, "e", 1) -> -3 633 * index_name_pos(&index, "f", 1) -> -3 634 * index_name_pos(&index, "g", 1) -> -5 635 */ 636externintindex_name_pos(const struct index_state *,const char*name,int namelen); 637 638#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 639#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 640#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 641#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 642#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 643#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 644externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 645externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 646 647/* Remove entry, return true if there are more entries to go. */ 648externintremove_index_entry_at(struct index_state *,int pos); 649 650externvoidremove_marked_cache_entries(struct index_state *istate); 651externintremove_file_from_index(struct index_state *,const char*path); 652#define ADD_CACHE_VERBOSE 1 653#define ADD_CACHE_PRETEND 2 654#define ADD_CACHE_IGNORE_ERRORS 4 655#define ADD_CACHE_IGNORE_REMOVAL 8 656#define ADD_CACHE_INTENT 16 657/* 658 * These two are used to add the contents of the file at path 659 * to the index, marking the working tree up-to-date by storing 660 * the cached stat info in the resulting cache entry. A caller 661 * that has already run lstat(2) on the path can call 662 * add_to_index(), and all others can call add_file_to_index(); 663 * the latter will do necessary lstat(2) internally before 664 * calling the former. 665 */ 666externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 667externintadd_file_to_index(struct index_state *,const char*path,int flags); 668 669externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 670externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 671externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 672externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 673externintindex_name_is_other(const struct index_state *,const char*,int); 674externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 675 676/* do stat comparison even if CE_VALID is true */ 677#define CE_MATCH_IGNORE_VALID 01 678/* do not check the contents but report dirty on racily-clean entries */ 679#define CE_MATCH_RACY_IS_DIRTY 02 680/* do stat comparison even if CE_SKIP_WORKTREE is true */ 681#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 682/* ignore non-existent files during stat update */ 683#define CE_MATCH_IGNORE_MISSING 0x08 684/* enable stat refresh */ 685#define CE_MATCH_REFRESH 0x10 686/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */ 687#define CE_MATCH_IGNORE_FSMONITOR 0X20 688externintie_match_stat(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 689externintie_modified(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 690 691#define HASH_WRITE_OBJECT 1 692#define HASH_FORMAT_CHECK 2 693externintindex_fd(struct object_id *oid,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 694externintindex_path(struct object_id *oid,const char*path,struct stat *st,unsigned flags); 695 696/* 697 * Record to sd the data from st that we use to check whether a file 698 * might have changed. 699 */ 700externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 701 702/* 703 * Return 0 if st is consistent with a file not having been changed 704 * since sd was filled. If there are differences, return a 705 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 706 * INODE_CHANGED, and DATA_CHANGED. 707 */ 708externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 709externintmatch_stat_data_racy(const struct index_state *istate, 710const struct stat_data *sd,struct stat *st); 711 712externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 713 714#define REFRESH_REALLY 0x0001/* ignore_valid */ 715#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 716#define REFRESH_QUIET 0x0004/* be quiet about it */ 717#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 718#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 719#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 720externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 721externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 722 723externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 724 725externinthold_locked_index(struct lock_file *,int); 726externvoidset_alternate_index_output(const char*); 727 728externint verify_index_checksum; 729 730/* Environment bits from configuration mechanism */ 731externint trust_executable_bit; 732externint trust_ctime; 733externint check_stat; 734externint quote_path_fully; 735externint has_symlinks; 736externint minimum_abbrev, default_abbrev; 737externint ignore_case; 738externint assume_unchanged; 739externint prefer_symlink_refs; 740externint warn_ambiguous_refs; 741externint warn_on_object_refname_ambiguity; 742externconst char*apply_default_whitespace; 743externconst char*apply_default_ignorewhitespace; 744externconst char*git_attributes_file; 745externconst char*git_hooks_path; 746externint zlib_compression_level; 747externint core_compression_level; 748externint pack_compression_level; 749externsize_t packed_git_window_size; 750externsize_t packed_git_limit; 751externsize_t delta_base_cache_limit; 752externunsigned long big_file_threshold; 753externunsigned long pack_size_limit_cfg; 754 755/* 756 * Accessors for the core.sharedrepository config which lazy-load the value 757 * from the config (if not already set). The "reset" function can be 758 * used to unset "set" or cached value, meaning that the value will be loaded 759 * fresh from the config file on the next call to get_shared_repository(). 760 */ 761voidset_shared_repository(int value); 762intget_shared_repository(void); 763voidreset_shared_repository(void); 764 765/* 766 * Do replace refs need to be checked this run? This variable is 767 * initialized to true unless --no-replace-object is used or 768 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 769 * commands that do not want replace references to be active. As an 770 * optimization it is also set to false if replace references have 771 * been sought but there were none. 772 */ 773externint check_replace_refs; 774externchar*git_replace_ref_base; 775 776externint fsync_object_files; 777externint core_preload_index; 778externint core_apply_sparse_checkout; 779externint precomposed_unicode; 780externint protect_hfs; 781externint protect_ntfs; 782externconst char*core_fsmonitor; 783 784/* 785 * Include broken refs in all ref iterations, which will 786 * generally choke dangerous operations rather than letting 787 * them silently proceed without taking the broken ref into 788 * account. 789 */ 790externint ref_paranoia; 791 792/* 793 * The character that begins a commented line in user-editable file 794 * that is subject to stripspace. 795 */ 796externchar comment_line_char; 797externint auto_comment_line_char; 798 799/* Windows only */ 800enum hide_dotfiles_type { 801 HIDE_DOTFILES_FALSE =0, 802 HIDE_DOTFILES_TRUE, 803 HIDE_DOTFILES_DOTGITONLY 804}; 805externenum hide_dotfiles_type hide_dotfiles; 806 807enum log_refs_config { 808 LOG_REFS_UNSET = -1, 809 LOG_REFS_NONE =0, 810 LOG_REFS_NORMAL, 811 LOG_REFS_ALWAYS 812}; 813externenum log_refs_config log_all_ref_updates; 814 815enum branch_track { 816 BRANCH_TRACK_UNSPECIFIED = -1, 817 BRANCH_TRACK_NEVER =0, 818 BRANCH_TRACK_REMOTE, 819 BRANCH_TRACK_ALWAYS, 820 BRANCH_TRACK_EXPLICIT, 821 BRANCH_TRACK_OVERRIDE 822}; 823 824enum rebase_setup_type { 825 AUTOREBASE_NEVER =0, 826 AUTOREBASE_LOCAL, 827 AUTOREBASE_REMOTE, 828 AUTOREBASE_ALWAYS 829}; 830 831enum push_default_type { 832 PUSH_DEFAULT_NOTHING =0, 833 PUSH_DEFAULT_MATCHING, 834 PUSH_DEFAULT_SIMPLE, 835 PUSH_DEFAULT_UPSTREAM, 836 PUSH_DEFAULT_CURRENT, 837 PUSH_DEFAULT_UNSPECIFIED 838}; 839 840externenum branch_track git_branch_track; 841externenum rebase_setup_type autorebase; 842externenum push_default_type push_default; 843 844enum object_creation_mode { 845 OBJECT_CREATION_USES_HARDLINKS =0, 846 OBJECT_CREATION_USES_RENAMES =1 847}; 848 849externenum object_creation_mode object_creation_mode; 850 851externchar*notes_ref_name; 852 853externint grafts_replace_parents; 854 855/* 856 * GIT_REPO_VERSION is the version we write by default. The 857 * _READ variant is the highest number we know how to 858 * handle. 859 */ 860#define GIT_REPO_VERSION 0 861#define GIT_REPO_VERSION_READ 1 862externint repository_format_precious_objects; 863 864struct repository_format { 865int version; 866int precious_objects; 867int is_bare; 868char*work_tree; 869struct string_list unknown_extensions; 870}; 871 872/* 873 * Read the repository format characteristics from the config file "path" into 874 * "format" struct. Returns the numeric version. On error, -1 is returned, 875 * format->version is set to -1, and all other fields in the struct are 876 * undefined. 877 */ 878intread_repository_format(struct repository_format *format,const char*path); 879 880/* 881 * Verify that the repository described by repository_format is something we 882 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 883 * any errors encountered. 884 */ 885intverify_repository_format(const struct repository_format *format, 886struct strbuf *err); 887 888/* 889 * Check the repository format version in the path found in get_git_dir(), 890 * and die if it is a version we don't understand. Generally one would 891 * set_git_dir() before calling this, and use it only for "are we in a valid 892 * repo?". 893 */ 894externvoidcheck_repository_format(void); 895 896#define MTIME_CHANGED 0x0001 897#define CTIME_CHANGED 0x0002 898#define OWNER_CHANGED 0x0004 899#define MODE_CHANGED 0x0008 900#define INODE_CHANGED 0x0010 901#define DATA_CHANGED 0x0020 902#define TYPE_CHANGED 0x0040 903 904/* 905 * Return the name of the file in the local object database that would 906 * be used to store a loose object with the specified sha1. The 907 * return value is a pointer to a statically allocated buffer that is 908 * overwritten each time the function is called. 909 */ 910externconst char*sha1_file_name(const unsigned char*sha1); 911 912/* 913 * Return an abbreviated sha1 unique within this repository's object database. 914 * The result will be at least `len` characters long, and will be NUL 915 * terminated. 916 * 917 * The non-`_r` version returns a static buffer which remains valid until 4 918 * more calls to find_unique_abbrev are made. 919 * 920 * The `_r` variant writes to a buffer supplied by the caller, which must be at 921 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 922 * written (excluding the NUL terminator). 923 * 924 * Note that while this version avoids the static buffer, it is not fully 925 * reentrant, as it calls into other non-reentrant git code. 926 */ 927externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 928externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 929 930externconst unsigned char null_sha1[GIT_MAX_RAWSZ]; 931externconst struct object_id null_oid; 932 933staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 934{ 935returnmemcmp(sha1, sha2, GIT_SHA1_RAWSZ); 936} 937 938staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 939{ 940returnhashcmp(oid1->hash, oid2->hash); 941} 942 943staticinlineintis_null_sha1(const unsigned char*sha1) 944{ 945return!hashcmp(sha1, null_sha1); 946} 947 948staticinlineintis_null_oid(const struct object_id *oid) 949{ 950return!hashcmp(oid->hash, null_sha1); 951} 952 953staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src) 954{ 955memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 956} 957 958staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src) 959{ 960hashcpy(dst->hash, src->hash); 961} 962 963staticinlinestruct object_id *oiddup(const struct object_id *src) 964{ 965struct object_id *dst =xmalloc(sizeof(struct object_id)); 966oidcpy(dst, src); 967return dst; 968} 969 970staticinlinevoidhashclr(unsigned char*hash) 971{ 972memset(hash,0, GIT_SHA1_RAWSZ); 973} 974 975staticinlinevoidoidclr(struct object_id *oid) 976{ 977hashclr(oid->hash); 978} 979 980 981#define EMPTY_TREE_SHA1_HEX \ 982"4b825dc642cb6eb9a060e54bf8d69288fbee4904" 983#define EMPTY_TREE_SHA1_BIN_LITERAL \ 984"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \ 985"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04" 986externconst struct object_id empty_tree_oid; 987#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash) 988 989#define EMPTY_BLOB_SHA1_HEX \ 990"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391" 991#define EMPTY_BLOB_SHA1_BIN_LITERAL \ 992"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \ 993"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91" 994externconst struct object_id empty_blob_oid; 995#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash) 996 997 998staticinlineintis_empty_blob_sha1(const unsigned char*sha1) 999{1000return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1001}10021003staticinlineintis_empty_blob_oid(const struct object_id *oid)1004{1005return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1006}10071008staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1009{1010return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1011}10121013staticinlineintis_empty_tree_oid(const struct object_id *oid)1014{1015return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1016}10171018/* set default permissions by passing mode arguments to open(2) */1019intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1020intgit_mkstemp_mode(char*pattern,int mode);10211022/*1023 * NOTE NOTE NOTE!!1024 *1025 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1026 * not be changed. Old repositories have core.sharedrepository written in1027 * numeric format, and therefore these values are preserved for compatibility1028 * reasons.1029 */1030enum sharedrepo {1031 PERM_UMASK =0,1032 OLD_PERM_GROUP =1,1033 OLD_PERM_EVERYBODY =2,1034 PERM_GROUP =0660,1035 PERM_EVERYBODY =06641036};1037intgit_config_perm(const char*var,const char*value);1038intadjust_shared_perm(const char*path);10391040/*1041 * Create the directory containing the named path, using care to be1042 * somewhat safe against races. Return one of the scld_error values to1043 * indicate success/failure. On error, set errno to describe the1044 * problem.1045 *1046 * SCLD_VANISHED indicates that one of the ancestor directories of the1047 * path existed at one point during the function call and then1048 * suddenly vanished, probably because another process pruned the1049 * directory while we were working. To be robust against this kind of1050 * race, callers might want to try invoking the function again when it1051 * returns SCLD_VANISHED.1052 *1053 * safe_create_leading_directories() temporarily changes path while it1054 * is working but restores it before returning.1055 * safe_create_leading_directories_const() doesn't modify path, even1056 * temporarily.1057 */1058enum scld_error {1059 SCLD_OK =0,1060 SCLD_FAILED = -1,1061 SCLD_PERMS = -2,1062 SCLD_EXISTS = -3,1063 SCLD_VANISHED = -41064};1065enum scld_error safe_create_leading_directories(char*path);1066enum scld_error safe_create_leading_directories_const(const char*path);10671068/*1069 * Callback function for raceproof_create_file(). This function is1070 * expected to do something that makes dirname(path) permanent despite1071 * the fact that other processes might be cleaning up empty1072 * directories at the same time. Usually it will create a file named1073 * path, but alternatively it could create another file in that1074 * directory, or even chdir() into that directory. The function should1075 * return 0 if the action was completed successfully. On error, it1076 * should return a nonzero result and set errno.1077 * raceproof_create_file() treats two errno values specially:1078 *1079 * - ENOENT -- dirname(path) does not exist. In this case,1080 * raceproof_create_file() tries creating dirname(path)1081 * (and any parent directories, if necessary) and calls1082 * the function again.1083 *1084 * - EISDIR -- the file already exists and is a directory. In this1085 * case, raceproof_create_file() removes the directory if1086 * it is empty (and recursively any empty directories that1087 * it contains) and calls the function again.1088 *1089 * Any other errno causes raceproof_create_file() to fail with the1090 * callback's return value and errno.1091 *1092 * Obviously, this function should be OK with being called again if it1093 * fails with ENOENT or EISDIR. In other scenarios it will not be1094 * called again.1095 */1096typedefintcreate_file_fn(const char*path,void*cb);10971098/*1099 * Create a file in dirname(path) by calling fn, creating leading1100 * directories if necessary. Retry a few times in case we are racing1101 * with another process that is trying to clean up the directory that1102 * contains path. See the documentation for create_file_fn for more1103 * details.1104 *1105 * Return the value and set the errno that resulted from the most1106 * recent call of fn. fn is always called at least once, and will be1107 * called more than once if it returns ENOENT or EISDIR.1108 */1109intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11101111intmkdir_in_gitdir(const char*path);1112externchar*expand_user_path(const char*path,int real_home);1113const char*enter_repo(const char*path,int strict);1114staticinlineintis_absolute_path(const char*path)1115{1116returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1117}1118intis_directory(const char*);1119char*strbuf_realpath(struct strbuf *resolved,const char*path,1120int die_on_error);1121const char*real_path(const char*path);1122const char*real_path_if_valid(const char*path);1123char*real_pathdup(const char*path,int die_on_error);1124const char*absolute_path(const char*path);1125char*absolute_pathdup(const char*path);1126const char*remove_leading_path(const char*in,const char*prefix);1127const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1128intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1129intnormalize_path_copy(char*dst,const char*src);1130intlongest_ancestor_length(const char*path,struct string_list *prefixes);1131char*strip_path_suffix(const char*path,const char*suffix);1132intdaemon_avoid_alias(const char*path);1133externintis_ntfs_dotgit(const char*name);11341135/*1136 * Returns true iff "str" could be confused as a command-line option when1137 * passed to a sub-program like "ssh". Note that this has nothing to do with1138 * shell-quoting, which should be handled separately; we're assuming here that1139 * the string makes it verbatim to the sub-program.1140 */1141intlooks_like_command_line_option(const char*str);11421143/**1144 * Return a newly allocated string with the evaluation of1145 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1146 * "$HOME/.config/git/$filename". Return NULL upon error.1147 */1148externchar*xdg_config_home(const char*filename);11491150/**1151 * Return a newly allocated string with the evaluation of1152 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1153 * "$HOME/.cache/git/$filename". Return NULL upon error.1154 */1155externchar*xdg_cache_home(const char*filename);11561157externvoid*read_sha1_file_extended(const unsigned char*sha1,1158enum object_type *type,1159unsigned long*size,int lookup_replace);1160staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1161{1162returnread_sha1_file_extended(sha1, type, size,1);1163}11641165/*1166 * This internal function is only declared here for the benefit of1167 * lookup_replace_object(). Please do not call it directly.1168 */1169externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);11701171/*1172 * If object sha1 should be replaced, return the replacement object's1173 * name (replaced recursively, if necessary). The return value is1174 * either sha1 or a pointer to a permanently-allocated value. When1175 * object replacement is suppressed, always return sha1.1176 */1177staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1178{1179if(!check_replace_refs)1180return sha1;1181returndo_lookup_replace_object(sha1);1182}11831184/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1185externintsha1_object_info(const unsigned char*,unsigned long*);1186externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1);1187externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1);1188externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,struct object_id *oid,unsigned flags);1189externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*);1190externintforce_object_loose(const unsigned char*sha1,time_t mtime);1191externintgit_open_cloexec(const char*name,int flags);1192#define git_open(name) git_open_cloexec(name, O_RDONLY)1193externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1194externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1195externintparse_sha1_header(const char*hdr,unsigned long*sizep);11961197externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);11981199externintfinalize_object_file(const char*tmpfile,const char*filename);12001201/*1202 * Open the loose object at path, check its sha1, and return the contents,1203 * type, and size. If the object is a blob, then "contents" may return NULL,1204 * to allow streaming of large blobs.1205 *1206 * Returns 0 on success, negative on error (details may be written to stderr).1207 */1208intread_loose_object(const char*path,1209const unsigned char*expected_sha1,1210enum object_type *type,1211unsigned long*size,1212void**contents);12131214/*1215 * Convenience for sha1_object_info_extended() with a NULL struct1216 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass1217 * nonzero flags to also set other flags.1218 */1219externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1220staticinlineinthas_sha1_file(const unsigned char*sha1)1221{1222returnhas_sha1_file_with_flags(sha1,0);1223}12241225/* Same as the above, except for struct object_id. */1226externinthas_object_file(const struct object_id *oid);1227externinthas_object_file_with_flags(const struct object_id *oid,int flags);12281229/*1230 * Return true iff an alternate object database has a loose object1231 * with the specified name. This function does not respect replace1232 * references.1233 */1234externinthas_loose_object_nonlocal(const unsigned char*sha1);12351236externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);12371238/* Helper to check and "touch" a file */1239externintcheck_and_freshen_file(const char*fn,int freshen);12401241externconst signed char hexval_table[256];1242staticinlineunsigned inthexval(unsigned char c)1243{1244return hexval_table[c];1245}12461247/*1248 * Convert two consecutive hexadecimal digits into a char. Return a1249 * negative value on error. Don't run over the end of short strings.1250 */1251staticinlineinthex2chr(const char*s)1252{1253int val =hexval(s[0]);1254return(val <0) ? val : (val <<4) |hexval(s[1]);1255}12561257/* Convert to/from hex/sha1 representation */1258#define MINIMUM_ABBREV minimum_abbrev1259#define DEFAULT_ABBREV default_abbrev12601261/* used when the code does not know or care what the default abbrev is */1262#define FALLBACK_DEFAULT_ABBREV 712631264struct object_context {1265unsigned char tree[20];1266unsigned mode;1267/*1268 * symlink_path is only used by get_tree_entry_follow_symlinks,1269 * and only for symlinks that point outside the repository.1270 */1271struct strbuf symlink_path;1272/*1273 * If GET_OID_RECORD_PATH is set, this will record path (if any)1274 * found when resolving the name. The caller is responsible for1275 * releasing the memory.1276 */1277char*path;1278};12791280#define GET_OID_QUIETLY 011281#define GET_OID_COMMIT 021282#define GET_OID_COMMITTISH 041283#define GET_OID_TREE 0101284#define GET_OID_TREEISH 0201285#define GET_OID_BLOB 0401286#define GET_OID_FOLLOW_SYMLINKS 01001287#define GET_OID_RECORD_PATH 02001288#define GET_OID_ONLY_TO_DIE 0400012891290#define GET_OID_DISAMBIGUATORS \1291 (GET_OID_COMMIT | GET_OID_COMMITTISH | \1292 GET_OID_TREE | GET_OID_TREEISH | \1293 GET_OID_BLOB)12941295externintget_oid(const char*str,struct object_id *oid);1296externintget_oid_commit(const char*str,struct object_id *oid);1297externintget_oid_committish(const char*str,struct object_id *oid);1298externintget_oid_tree(const char*str,struct object_id *oid);1299externintget_oid_treeish(const char*str,struct object_id *oid);1300externintget_oid_blob(const char*str,struct object_id *oid);1301externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1302externintget_oid_with_context(const char*str,unsigned flags,struct object_id *oid,struct object_context *oc);130313041305typedefinteach_abbrev_fn(const struct object_id *oid,void*);1306externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13071308externintset_disambiguate_hint_config(const char*var,const char*value);13091310/*1311 * Try to read a SHA1 in hexadecimal format from the 40 characters1312 * starting at hex. Write the 20-byte result to sha1 in binary form.1313 * Return 0 on success. Reading stops if a NUL is encountered in the1314 * input, so it is safe to pass this function an arbitrary1315 * null-terminated string.1316 */1317externintget_sha1_hex(const char*hex,unsigned char*sha1);1318externintget_oid_hex(const char*hex,struct object_id *sha1);13191320/*1321 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1322 * and writes the NUL-terminated output to the buffer `out`, which must be at1323 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1324 * convenience.1325 *1326 * The non-`_r` variant returns a static buffer, but uses a ring of 41327 * buffers, making it safe to make multiple calls for a single statement, like:1328 *1329 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1330 */1331externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1332externchar*oid_to_hex_r(char*out,const struct object_id *oid);1333externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1334externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */13351336/*1337 * Parse a 40-character hexadecimal object ID starting from hex, updating the1338 * pointer specified by end when parsing stops. The resulting object ID is1339 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1340 * other invalid character. end is only updated on success; otherwise, it is1341 * unmodified.1342 */1343externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);13441345/*1346 * This reads short-hand syntax that not only evaluates to a commit1347 * object name, but also can act as if the end user spelled the name1348 * of the branch from the command line.1349 *1350 * - "@{-N}" finds the name of the Nth previous branch we were on, and1351 * places the name of the branch in the given buf and returns the1352 * number of characters parsed if successful.1353 *1354 * - "<branch>@{upstream}" finds the name of the other ref that1355 * <branch> is configured to merge with (missing <branch> defaults1356 * to the current branch), and places the name of the branch in the1357 * given buf and returns the number of characters parsed if1358 * successful.1359 *1360 * If the input is not of the accepted format, it returns a negative1361 * number to signal an error.1362 *1363 * If the input was ok but there are not N branch switches in the1364 * reflog, it returns 0.1365 *1366 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1367 * expansions: local branches ("refs/heads/"), remote branches1368 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1369 * allowed, even ones to refs outside of those namespaces.1370 */1371#define INTERPRET_BRANCH_LOCAL (1<<0)1372#define INTERPRET_BRANCH_REMOTE (1<<1)1373#define INTERPRET_BRANCH_HEAD (1<<2)1374externintinterpret_branch_name(const char*str,int len,struct strbuf *,1375unsigned allowed);1376externintget_oid_mb(const char*str,struct object_id *oid);13771378externintvalidate_headref(const char*ref);13791380externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1381externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1382externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1383externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);13841385externvoid*read_object_with_reference(const unsigned char*sha1,1386const char*required_type,1387unsigned long*size,1388unsigned char*sha1_ret);13891390externstruct object *peel_to_type(const char*name,int namelen,1391struct object *o,enum object_type);13921393struct date_mode {1394enum date_mode_type {1395 DATE_NORMAL =0,1396 DATE_RELATIVE,1397 DATE_SHORT,1398 DATE_ISO8601,1399 DATE_ISO8601_STRICT,1400 DATE_RFC2822,1401 DATE_STRFTIME,1402 DATE_RAW,1403 DATE_UNIX1404} type;1405const char*strftime_fmt;1406int local;1407};14081409/*1410 * Convenience helper for passing a constant type, like:1411 *1412 * show_date(t, tz, DATE_MODE(NORMAL));1413 */1414#define DATE_MODE(t) date_mode_from_type(DATE_##t)1415struct date_mode *date_mode_from_type(enum date_mode_type type);14161417const char*show_date(timestamp_t time,int timezone,const struct date_mode *mode);1418voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1419struct strbuf *timebuf);1420intparse_date(const char*date,struct strbuf *out);1421intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1422intparse_expiry_date(const char*date, timestamp_t *timestamp);1423voiddatestamp(struct strbuf *out);1424#define approxidate(s) approxidate_careful((s), NULL)1425timestamp_t approxidate_careful(const char*,int*);1426timestamp_t approxidate_relative(const char*date,const struct timeval *now);1427voidparse_date_format(const char*format,struct date_mode *mode);1428intdate_overflows(timestamp_t date);14291430#define IDENT_STRICT 11431#define IDENT_NO_DATE 21432#define IDENT_NO_NAME 41433externconst char*git_author_info(int);1434externconst char*git_committer_info(int);1435externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1436externconst char*fmt_name(const char*name,const char*email);1437externconst char*ident_default_name(void);1438externconst char*ident_default_email(void);1439externconst char*git_editor(void);1440externconst char*git_pager(int stdout_is_tty);1441externintgit_ident_config(const char*,const char*,void*);1442externvoidreset_ident_date(void);14431444struct ident_split {1445const char*name_begin;1446const char*name_end;1447const char*mail_begin;1448const char*mail_end;1449const char*date_begin;1450const char*date_end;1451const char*tz_begin;1452const char*tz_end;1453};1454/*1455 * Signals an success with 0, but time part of the result may be NULL1456 * if the input lacks timestamp and zone1457 */1458externintsplit_ident_line(struct ident_split *,const char*,int);14591460/*1461 * Like show_date, but pull the timestamp and tz parameters from1462 * the ident_split. It will also sanity-check the values and produce1463 * a well-known sentinel date if they appear bogus.1464 */1465const char*show_ident_date(const struct ident_split *id,1466const struct date_mode *mode);14671468/*1469 * Compare split idents for equality or strict ordering. Note that we1470 * compare only the ident part of the line, ignoring any timestamp.1471 *1472 * Because there are two fields, we must choose one as the primary key; we1473 * currently arbitrarily pick the email.1474 */1475externintident_cmp(const struct ident_split *,const struct ident_split *);14761477struct checkout {1478struct index_state *istate;1479const char*base_dir;1480int base_dir_len;1481struct delayed_checkout *delayed_checkout;1482unsigned force:1,1483 quiet:1,1484 not_new:1,1485 refresh_cache:1;1486};1487#define CHECKOUT_INIT { NULL,"" }14881489#define TEMPORARY_FILENAME_LENGTH 251490externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);1491externvoidenable_delayed_checkout(struct checkout *state);1492externintfinish_delayed_checkout(struct checkout *state);14931494struct cache_def {1495struct strbuf path;1496int flags;1497int track_flags;1498int prefix_len_stat_func;1499};1500#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1501staticinlinevoidcache_def_clear(struct cache_def *cache)1502{1503strbuf_release(&cache->path);1504}15051506externinthas_symlink_leading_path(const char*name,int len);1507externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1508externintcheck_leading_path(const char*name,int len);1509externinthas_dirs_only_path(const char*name,int len,int prefix_len);1510externvoidschedule_dir_for_removal(const char*name,int len);1511externvoidremove_scheduled_dirs(void);15121513externstruct alternate_object_database {1514struct alternate_object_database *next;15151516/* see alt_scratch_buf() */1517struct strbuf scratch;1518size_t base_len;15191520/*1521 * Used to store the results of readdir(3) calls when searching1522 * for unique abbreviated hashes. This cache is never1523 * invalidated, thus it's racy and not necessarily accurate.1524 * That's fine for its purpose; don't use it for tasks requiring1525 * greater accuracy!1526 */1527char loose_objects_subdir_seen[256];1528struct oid_array loose_objects_cache;15291530char path[FLEX_ARRAY];1531} *alt_odb_list;1532externvoidprepare_alt_odb(void);1533externchar*compute_alternate_path(const char*path,struct strbuf *err);1534typedefintalt_odb_fn(struct alternate_object_database *,void*);1535externintforeach_alt_odb(alt_odb_fn,void*);15361537/*1538 * Allocate a "struct alternate_object_database" but do _not_ actually1539 * add it to the list of alternates.1540 */1541struct alternate_object_database *alloc_alt_odb(const char*dir);15421543/*1544 * Add the directory to the on-disk alternates file; the new entry will also1545 * take effect in the current process.1546 */1547externvoidadd_to_alternates_file(const char*dir);15481549/*1550 * Add the directory to the in-memory list of alternates (along with any1551 * recursive alternates it points to), but do not modify the on-disk alternates1552 * file.1553 */1554externvoidadd_to_alternates_memory(const char*dir);15551556/*1557 * Returns a scratch strbuf pre-filled with the alternate object directory,1558 * including a trailing slash, which can be used to access paths in the1559 * alternate. Always use this over direct access to alt->scratch, as it1560 * cleans up any previous use of the scratch buffer.1561 */1562externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);15631564struct pack_window {1565struct pack_window *next;1566unsigned char*base;1567 off_t offset;1568size_t len;1569unsigned int last_used;1570unsigned int inuse_cnt;1571};15721573externstruct packed_git {1574struct packed_git *next;1575struct pack_window *windows;1576 off_t pack_size;1577const void*index_data;1578size_t index_size;1579uint32_t num_objects;1580uint32_t num_bad_objects;1581unsigned char*bad_object_sha1;1582int index_version;1583time_t mtime;1584int pack_fd;1585unsigned pack_local:1,1586 pack_keep:1,1587 freshened:1,1588 do_not_close:1;1589unsigned char sha1[20];1590struct revindex_entry *revindex;1591/* something like ".git/objects/pack/xxxxx.pack" */1592char pack_name[FLEX_ARRAY];/* more */1593} *packed_git;15941595/*1596 * A most-recently-used ordered version of the packed_git list, which can1597 * be iterated instead of packed_git (and marked via mru_mark).1598 */1599struct mru;1600externstruct mru *packed_git_mru;16011602struct pack_entry {1603 off_t offset;1604unsigned char sha1[20];1605struct packed_git *p;1606};16071608/*1609 * Create a temporary file rooted in the object database directory, or1610 * die on failure. The filename is taken from "pattern", which should have the1611 * usual "XXXXXX" trailer, and the resulting filename is written into the1612 * "template" buffer. Returns the open descriptor.1613 */1614externintodb_mkstemp(struct strbuf *template,const char*pattern);16151616/*1617 * Create a pack .keep file named "name" (which should generally be the output1618 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1619 * error.1620 */1621externintodb_pack_keep(const char*name);16221623/*1624 * Iterate over the files in the loose-object parts of the object1625 * directory "path", triggering the following callbacks:1626 *1627 * - loose_object is called for each loose object we find.1628 *1629 * - loose_cruft is called for any files that do not appear to be1630 * loose objects. Note that we only look in the loose object1631 * directories "objects/[0-9a-f]{2}/", so we will not report1632 * "objects/foobar" as cruft.1633 *1634 * - loose_subdir is called for each top-level hashed subdirectory1635 * of the object directory (e.g., "$OBJDIR/f0"). It is called1636 * after the objects in the directory are processed.1637 *1638 * Any callback that is NULL will be ignored. Callbacks returning non-zero1639 * will end the iteration.1640 *1641 * In the "buf" variant, "path" is a strbuf which will also be used as a1642 * scratch buffer, but restored to its original contents before1643 * the function returns.1644 */1645typedefinteach_loose_object_fn(const struct object_id *oid,1646const char*path,1647void*data);1648typedefinteach_loose_cruft_fn(const char*basename,1649const char*path,1650void*data);1651typedefinteach_loose_subdir_fn(unsigned int nr,1652const char*path,1653void*data);1654intfor_each_file_in_obj_subdir(unsigned int subdir_nr,1655struct strbuf *path,1656 each_loose_object_fn obj_cb,1657 each_loose_cruft_fn cruft_cb,1658 each_loose_subdir_fn subdir_cb,1659void*data);1660intfor_each_loose_file_in_objdir(const char*path,1661 each_loose_object_fn obj_cb,1662 each_loose_cruft_fn cruft_cb,1663 each_loose_subdir_fn subdir_cb,1664void*data);1665intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1666 each_loose_object_fn obj_cb,1667 each_loose_cruft_fn cruft_cb,1668 each_loose_subdir_fn subdir_cb,1669void*data);16701671/*1672 * Iterate over loose objects in both the local1673 * repository and any alternates repositories (unless the1674 * LOCAL_ONLY flag is set).1675 */1676#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11677externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);16781679struct object_info {1680/* Request */1681enum object_type *typep;1682unsigned long*sizep;1683 off_t *disk_sizep;1684unsigned char*delta_base_sha1;1685struct strbuf *typename;1686void**contentp;16871688/* Response */1689enum{1690 OI_CACHED,1691 OI_LOOSE,1692 OI_PACKED,1693 OI_DBCACHED1694} whence;1695union{1696/*1697 * struct {1698 * ... Nothing to expose in this case1699 * } cached;1700 * struct {1701 * ... Nothing to expose in this case1702 * } loose;1703 */1704struct{1705struct packed_git *pack;1706 off_t offset;1707unsigned int is_delta;1708} packed;1709} u;1710};17111712/*1713 * Initializer for a "struct object_info" that wants no items. You may1714 * also memset() the memory to all-zeroes.1715 */1716#define OBJECT_INFO_INIT {NULL}17171718/* Invoke lookup_replace_object() on the given hash */1719#define OBJECT_INFO_LOOKUP_REPLACE 11720/* Allow reading from a loose object file of unknown/bogus type */1721#define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 21722/* Do not check cached storage */1723#define OBJECT_INFO_SKIP_CACHED 41724/* Do not retry packed storage after checking packed and loose storage */1725#define OBJECT_INFO_QUICK 81726externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);17271728/* Dumb servers support */1729externintupdate_server_info(int);17301731externconst char*get_log_output_encoding(void);1732externconst char*get_commit_output_encoding(void);17331734/*1735 * This is a hack for test programs like test-dump-untracked-cache to1736 * ensure that they do not modify the untracked cache when reading it.1737 * Do not use it otherwise!1738 */1739externint ignore_untracked_cache_config;17401741externintcommitter_ident_sufficiently_given(void);1742externintauthor_ident_sufficiently_given(void);17431744externconst char*git_commit_encoding;1745externconst char*git_log_output_encoding;1746externconst char*git_mailmap_file;1747externconst char*git_mailmap_blob;17481749/* IO helper functions */1750externvoidmaybe_flush_or_die(FILE*,const char*);1751__attribute__((format(printf,2,3)))1752externvoidfprintf_or_die(FILE*,const char*fmt, ...);17531754#define COPY_READ_ERROR (-2)1755#define COPY_WRITE_ERROR (-3)1756externintcopy_fd(int ifd,int ofd);1757externintcopy_file(const char*dst,const char*src,int mode);1758externintcopy_file_with_time(const char*dst,const char*src,int mode);17591760externvoidwrite_or_die(int fd,const void*buf,size_t count);1761externvoidfsync_or_die(int fd,const char*);17621763extern ssize_t read_in_full(int fd,void*buf,size_t count);1764extern ssize_t write_in_full(int fd,const void*buf,size_t count);1765extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);17661767staticinline ssize_t write_str_in_full(int fd,const char*str)1768{1769returnwrite_in_full(fd, str,strlen(str));1770}17711772/**1773 * Open (and truncate) the file at path, write the contents of buf to it,1774 * and close it. Dies if any errors are encountered.1775 */1776externvoidwrite_file_buf(const char*path,const char*buf,size_t len);17771778/**1779 * Like write_file_buf(), but format the contents into a buffer first.1780 * Additionally, write_file() will append a newline if one is not already1781 * present, making it convenient to write text files:1782 *1783 * write_file(path, "counter: %d", ctr);1784 */1785__attribute__((format(printf,2,3)))1786externvoidwrite_file(const char*path,const char*fmt, ...);17871788/* pager.c */1789externvoidsetup_pager(void);1790externintpager_in_use(void);1791externint pager_use_color;1792externintterm_columns(void);1793externintdecimal_width(uintmax_t);1794externintcheck_pager_config(const char*cmd);1795externvoidprepare_pager_args(struct child_process *,const char*pager);17961797externconst char*editor_program;1798externconst char*askpass_program;1799externconst char*excludes_file;18001801/* base85 */1802intdecode_85(char*dst,const char*line,int linelen);1803voidencode_85(char*buf,const unsigned char*data,int bytes);18041805/* alloc.c */1806externvoid*alloc_blob_node(void);1807externvoid*alloc_tree_node(void);1808externvoid*alloc_commit_node(void);1809externvoid*alloc_tag_node(void);1810externvoid*alloc_object_node(void);1811externvoidalloc_report(void);1812externunsigned intalloc_commit_index(void);18131814/* pkt-line.c */1815voidpacket_trace_identity(const char*prog);18161817/* add */1818/*1819 * return 0 if success, 1 - if addition of a file failed and1820 * ADD_FILES_IGNORE_ERRORS was specified in flags1821 */1822intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);18231824/* diff.c */1825externint diff_auto_refresh_index;18261827/* match-trees.c */1828voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1829voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);18301831/*1832 * whitespace rules.1833 * used by both diff and apply1834 * last two digits are tab width1835 */1836#define WS_BLANK_AT_EOL 01001837#define WS_SPACE_BEFORE_TAB 02001838#define WS_INDENT_WITH_NON_TAB 04001839#define WS_CR_AT_EOL 010001840#define WS_BLANK_AT_EOF 020001841#define WS_TAB_IN_INDENT 040001842#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1843#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1844#define WS_TAB_WIDTH_MASK 0771845/* All WS_* -- when extended, adapt diff.c emit_symbol */1846#define WS_RULE_MASK 077771847externunsigned whitespace_rule_cfg;1848externunsignedwhitespace_rule(const char*);1849externunsignedparse_whitespace_rule(const char*);1850externunsignedws_check(const char*line,int len,unsigned ws_rule);1851externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1852externchar*whitespace_error_string(unsigned ws);1853externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1854externintws_blank_line(const char*line,int len,unsigned ws_rule);1855#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)18561857/* ls-files */1858voidoverlay_tree_on_index(struct index_state *istate,1859const char*tree_name,const char*prefix);18601861char*alias_lookup(const char*alias);1862intsplit_cmdline(char*cmdline,const char***argv);1863/* Takes a negative value returned by split_cmdline */1864const char*split_cmdline_strerror(int cmdline_errno);18651866/* setup.c */1867struct startup_info {1868int have_repository;1869const char*prefix;1870};1871externstruct startup_info *startup_info;18721873/* merge.c */1874struct commit_list;1875inttry_merge_command(const char*strategy,size_t xopts_nr,1876const char**xopts,struct commit_list *common,1877const char*head_arg,struct commit_list *remotes);1878intcheckout_fast_forward(const struct object_id *from,1879const struct object_id *to,1880int overwrite_ignore);188118821883intsane_execvp(const char*file,char*const argv[]);18841885/*1886 * A struct to encapsulate the concept of whether a file has changed1887 * since we last checked it. This uses criteria similar to those used1888 * for the index.1889 */1890struct stat_validity {1891struct stat_data *sd;1892};18931894voidstat_validity_clear(struct stat_validity *sv);18951896/*1897 * Returns 1 if the path is a regular file (or a symlink to a regular1898 * file) and matches the saved stat_validity, 0 otherwise. A missing1899 * or inaccessible file is considered a match if the struct was just1900 * initialized, or if the previous update found an inaccessible file.1901 */1902intstat_validity_check(struct stat_validity *sv,const char*path);19031904/*1905 * Update the stat_validity from a file opened at descriptor fd. If1906 * the file is missing, inaccessible, or not a regular file, then1907 * future calls to stat_validity_check will match iff one of those1908 * conditions continues to be true.1909 */1910voidstat_validity_update(struct stat_validity *sv,int fd);19111912intversioncmp(const char*s1,const char*s2);1913voidsleep_millisec(int millisec);19141915/*1916 * Create a directory and (if share is nonzero) adjust its permissions1917 * according to the shared_repository setting. Only use this for1918 * directories under $GIT_DIR. Don't use it for working tree1919 * directories.1920 */1921voidsafe_create_dir(const char*dir,int share);19221923#endif/* CACHE_H */