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#include"mem-pool.h" 19 20#include <zlib.h> 21typedefstruct git_zstream { 22 z_stream z; 23unsigned long avail_in; 24unsigned long avail_out; 25unsigned long total_in; 26unsigned long total_out; 27unsigned char*next_in; 28unsigned char*next_out; 29} git_zstream; 30 31voidgit_inflate_init(git_zstream *); 32voidgit_inflate_init_gzip_only(git_zstream *); 33voidgit_inflate_end(git_zstream *); 34intgit_inflate(git_zstream *,int flush); 35 36voidgit_deflate_init(git_zstream *,int level); 37voidgit_deflate_init_gzip(git_zstream *,int level); 38voidgit_deflate_init_raw(git_zstream *,int level); 39voidgit_deflate_end(git_zstream *); 40intgit_deflate_abort(git_zstream *); 41intgit_deflate_end_gently(git_zstream *); 42intgit_deflate(git_zstream *,int flush); 43unsigned longgit_deflate_bound(git_zstream *,unsigned long); 44 45/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 46#define GIT_SHA1_RAWSZ 20 47#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 48 49/* The length in byte and in hex digits of the largest possible hash value. */ 50#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 51#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 52 53struct object_id { 54unsigned char hash[GIT_MAX_RAWSZ]; 55}; 56 57#define the_hash_algo the_repository->hash_algo 58 59#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 60#define DTYPE(de) ((de)->d_type) 61#else 62#undef DT_UNKNOWN 63#undef DT_DIR 64#undef DT_REG 65#undef DT_LNK 66#define DT_UNKNOWN 0 67#define DT_DIR 1 68#define DT_REG 2 69#define DT_LNK 3 70#define DTYPE(de) DT_UNKNOWN 71#endif 72 73/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 74#define S_IFINVALID 0030000 75 76/* 77 * A "directory link" is a link to another git directory. 78 * 79 * The value 0160000 is not normally a valid mode, and 80 * also just happens to be S_IFDIR + S_IFLNK 81 */ 82#define S_IFGITLINK 0160000 83#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 84 85/* 86 * Some mode bits are also used internally for computations. 87 * 88 * They *must* not overlap with any valid modes, and they *must* not be emitted 89 * to outside world - i.e. appear on disk or network. In other words, it's just 90 * temporary fields, which we internally use, but they have to stay in-house. 91 * 92 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 93 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 94 */ 95 96/* used internally in tree-diff */ 97#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 98 99 100/* 101 * Intensive research over the course of many years has shown that 102 * port 9418 is totally unused by anything else. Or 103 * 104 * Your search - "port 9418" - did not match any documents. 105 * 106 * as www.google.com puts it. 107 * 108 * This port has been properly assigned for git use by IANA: 109 * git (Assigned-9418) [I06-050728-0001]. 110 * 111 * git 9418/tcp git pack transfer service 112 * git 9418/udp git pack transfer service 113 * 114 * with Linus Torvalds <torvalds@osdl.org> as the point of 115 * contact. September 2005. 116 * 117 * See http://www.iana.org/assignments/port-numbers 118 */ 119#define DEFAULT_GIT_PORT 9418 120 121/* 122 * Basic data structures for the directory cache 123 */ 124 125#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 126struct cache_header { 127uint32_t hdr_signature; 128uint32_t hdr_version; 129uint32_t hdr_entries; 130}; 131 132#define INDEX_FORMAT_LB 2 133#define INDEX_FORMAT_UB 4 134 135/* 136 * The "cache_time" is just the low 32 bits of the 137 * time. It doesn't matter if it overflows - we only 138 * check it for equality in the 32 bits we save. 139 */ 140struct cache_time { 141uint32_t sec; 142uint32_t nsec; 143}; 144 145struct stat_data { 146struct cache_time sd_ctime; 147struct cache_time sd_mtime; 148unsigned int sd_dev; 149unsigned int sd_ino; 150unsigned int sd_uid; 151unsigned int sd_gid; 152unsigned int sd_size; 153}; 154 155struct cache_entry { 156struct hashmap_entry ent; 157struct stat_data ce_stat_data; 158unsigned int ce_mode; 159unsigned int ce_flags; 160unsigned int mem_pool_allocated; 161unsigned int ce_namelen; 162unsigned int index;/* for link extension */ 163struct object_id oid; 164char name[FLEX_ARRAY];/* more */ 165}; 166 167#define CE_STAGEMASK (0x3000) 168#define CE_EXTENDED (0x4000) 169#define CE_VALID (0x8000) 170#define CE_STAGESHIFT 12 171 172/* 173 * Range 0xFFFF0FFF in ce_flags is divided into 174 * two parts: in-memory flags and on-disk ones. 175 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 176 * if you want to save a new flag, add it in 177 * CE_EXTENDED_FLAGS 178 * 179 * In-memory only flags 180 */ 181#define CE_UPDATE (1 << 16) 182#define CE_REMOVE (1 << 17) 183#define CE_UPTODATE (1 << 18) 184#define CE_ADDED (1 << 19) 185 186#define CE_HASHED (1 << 20) 187#define CE_FSMONITOR_VALID (1 << 21) 188#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 189#define CE_CONFLICTED (1 << 23) 190 191#define CE_UNPACKED (1 << 24) 192#define CE_NEW_SKIP_WORKTREE (1 << 25) 193 194/* used to temporarily mark paths matched by pathspecs */ 195#define CE_MATCHED (1 << 26) 196 197#define CE_UPDATE_IN_BASE (1 << 27) 198#define CE_STRIP_NAME (1 << 28) 199 200/* 201 * Extended on-disk flags 202 */ 203#define CE_INTENT_TO_ADD (1 << 29) 204#define CE_SKIP_WORKTREE (1 << 30) 205/* CE_EXTENDED2 is for future extension */ 206#define CE_EXTENDED2 (1U << 31) 207 208#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 209 210/* 211 * Safeguard to avoid saving wrong flags: 212 * - CE_EXTENDED2 won't get saved until its semantic is known 213 * - Bits in 0x0000FFFF have been saved in ce_flags already 214 * - Bits in 0x003F0000 are currently in-memory flags 215 */ 216#if CE_EXTENDED_FLAGS & 0x803FFFFF 217#error"CE_EXTENDED_FLAGS out of range" 218#endif 219 220/* Forward structure decls */ 221struct pathspec; 222struct child_process; 223 224/* 225 * Copy the sha1 and stat state of a cache entry from one to 226 * another. But we never change the name, or the hash state! 227 */ 228staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 229const struct cache_entry *src) 230{ 231unsigned int state = dst->ce_flags & CE_HASHED; 232int mem_pool_allocated = dst->mem_pool_allocated; 233 234/* Don't copy hash chain and name */ 235memcpy(&dst->ce_stat_data, &src->ce_stat_data, 236offsetof(struct cache_entry, name) - 237offsetof(struct cache_entry, ce_stat_data)); 238 239/* Restore the hash state */ 240 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 241 242/* Restore the mem_pool_allocated flag */ 243 dst->mem_pool_allocated = mem_pool_allocated; 244} 245 246staticinlineunsignedcreate_ce_flags(unsigned stage) 247{ 248return(stage << CE_STAGESHIFT); 249} 250 251#define ce_namelen(ce) ((ce)->ce_namelen) 252#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 253#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 254#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 255#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 256#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 257#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 258 259#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 260staticinlineunsigned intcreate_ce_mode(unsigned int mode) 261{ 262if(S_ISLNK(mode)) 263return S_IFLNK; 264if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 265return S_IFGITLINK; 266return S_IFREG |ce_permissions(mode); 267} 268staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 269unsigned int mode) 270{ 271externint trust_executable_bit, has_symlinks; 272if(!has_symlinks &&S_ISREG(mode) && 273 ce &&S_ISLNK(ce->ce_mode)) 274return ce->ce_mode; 275if(!trust_executable_bit &&S_ISREG(mode)) { 276if(ce &&S_ISREG(ce->ce_mode)) 277return ce->ce_mode; 278returncreate_ce_mode(0666); 279} 280returncreate_ce_mode(mode); 281} 282staticinlineintce_to_dtype(const struct cache_entry *ce) 283{ 284unsigned ce_mode =ntohl(ce->ce_mode); 285if(S_ISREG(ce_mode)) 286return DT_REG; 287else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 288return DT_DIR; 289else if(S_ISLNK(ce_mode)) 290return DT_LNK; 291else 292return DT_UNKNOWN; 293} 294staticinlineunsigned intcanon_mode(unsigned int mode) 295{ 296if(S_ISREG(mode)) 297return S_IFREG |ce_permissions(mode); 298if(S_ISLNK(mode)) 299return S_IFLNK; 300if(S_ISDIR(mode)) 301return S_IFDIR; 302return S_IFGITLINK; 303} 304 305#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 306 307#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 308#define CE_ENTRY_CHANGED (1 << 1) 309#define CE_ENTRY_REMOVED (1 << 2) 310#define CE_ENTRY_ADDED (1 << 3) 311#define RESOLVE_UNDO_CHANGED (1 << 4) 312#define CACHE_TREE_CHANGED (1 << 5) 313#define SPLIT_INDEX_ORDERED (1 << 6) 314#define UNTRACKED_CHANGED (1 << 7) 315#define FSMONITOR_CHANGED (1 << 8) 316 317struct split_index; 318struct untracked_cache; 319 320struct index_state { 321struct cache_entry **cache; 322unsigned int version; 323unsigned int cache_nr, cache_alloc, cache_changed; 324struct string_list *resolve_undo; 325struct cache_tree *cache_tree; 326struct split_index *split_index; 327struct cache_time timestamp; 328unsigned name_hash_initialized :1, 329 initialized :1, 330 drop_cache_tree :1; 331struct hashmap name_hash; 332struct hashmap dir_hash; 333struct object_id oid; 334struct untracked_cache *untracked; 335uint64_t fsmonitor_last_update; 336struct ewah_bitmap *fsmonitor_dirty; 337struct mem_pool *ce_mem_pool; 338}; 339 340externstruct index_state the_index; 341 342/* Name hashing */ 343externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 344externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 345externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 346externvoidfree_name_hash(struct index_state *istate); 347 348 349/* Cache entry creation and cleanup */ 350 351/* 352 * Create cache_entry intended for use in the specified index. Caller 353 * is responsible for discarding the cache_entry with 354 * `discard_cache_entry`. 355 */ 356struct cache_entry *make_cache_entry(struct index_state *istate, 357unsigned int mode, 358const struct object_id *oid, 359const char*path, 360int stage, 361unsigned int refresh_options); 362 363struct cache_entry *make_empty_cache_entry(struct index_state *istate, 364size_t name_len); 365 366/* 367 * Create a cache_entry that is not intended to be added to an index. 368 * Caller is responsible for discarding the cache_entry 369 * with `discard_cache_entry`. 370 */ 371struct cache_entry *make_transient_cache_entry(unsigned int mode, 372const struct object_id *oid, 373const char*path, 374int stage); 375 376struct cache_entry *make_empty_transient_cache_entry(size_t name_len); 377 378/* 379 * Discard cache entry. 380 */ 381voiddiscard_cache_entry(struct cache_entry *ce); 382 383/* 384 * Check configuration if we should perform extra validation on cache 385 * entries. 386 */ 387intshould_validate_cache_entries(void); 388 389/* 390 * Duplicate a cache_entry. Allocate memory for the new entry from a 391 * memory_pool. Takes into account cache_entry fields that are meant 392 * for managing the underlying memory allocation of the cache_entry. 393 */ 394struct cache_entry *dup_cache_entry(const struct cache_entry *ce,struct index_state *istate); 395 396/* 397 * Validate the cache entries in the index. This is an internal 398 * consistency check that the cache_entry structs are allocated from 399 * the expected memory pool. 400 */ 401voidvalidate_cache_entries(const struct index_state *istate); 402 403#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 404#define active_cache (the_index.cache) 405#define active_nr (the_index.cache_nr) 406#define active_alloc (the_index.cache_alloc) 407#define active_cache_changed (the_index.cache_changed) 408#define active_cache_tree (the_index.cache_tree) 409 410#define read_cache() read_index(&the_index) 411#define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir())) 412#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 413#define is_cache_unborn() is_index_unborn(&the_index) 414#define read_cache_unmerged() read_index_unmerged(&the_index) 415#define discard_cache() discard_index(&the_index) 416#define unmerged_cache() unmerged_index(&the_index) 417#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 418#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 419#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 420#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 421#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 422#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 423#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 424#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 425#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 426#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 427#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 428#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 429#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 430#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 431#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 432#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 433#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 434#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 435#endif 436 437#define TYPE_BITS 3 438 439/* 440 * Values in this enum (except those outside the 3 bit range) are part 441 * of pack file format. See Documentation/technical/pack-format.txt 442 * for more information. 443 */ 444enum object_type { 445 OBJ_BAD = -1, 446 OBJ_NONE =0, 447 OBJ_COMMIT =1, 448 OBJ_TREE =2, 449 OBJ_BLOB =3, 450 OBJ_TAG =4, 451/* 5 for future expansion */ 452 OBJ_OFS_DELTA =6, 453 OBJ_REF_DELTA =7, 454 OBJ_ANY, 455 OBJ_MAX 456}; 457 458staticinlineenum object_type object_type(unsigned int mode) 459{ 460returnS_ISDIR(mode) ? OBJ_TREE : 461S_ISGITLINK(mode) ? OBJ_COMMIT : 462 OBJ_BLOB; 463} 464 465/* Double-check local_repo_env below if you add to this list. */ 466#define GIT_DIR_ENVIRONMENT"GIT_DIR" 467#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 468#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 469#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 470#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 471#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 472#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 473#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 474#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 475#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 476#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 477#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 478#define CONFIG_ENVIRONMENT"GIT_CONFIG" 479#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 480#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 481#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 482#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 483#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 484#define GITATTRIBUTES_FILE".gitattributes" 485#define INFOATTRIBUTES_FILE"info/attributes" 486#define ATTRIBUTE_MACRO_PREFIX"[attr]" 487#define GITMODULES_FILE".gitmodules" 488#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 489#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 490#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 491#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 492#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 493#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 494#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 495#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 496#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 497#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 498#define GIT_OPTIONAL_LOCKS_ENVIRONMENT"GIT_OPTIONAL_LOCKS" 499#define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT"GIT_TEXTDOMAINDIR" 500 501/* 502 * Environment variable used in handshaking the wire protocol. 503 * Contains a colon ':' separated list of keys with optional values 504 * 'key[=value]'. Presence of unknown keys and values must be 505 * ignored. 506 */ 507#define GIT_PROTOCOL_ENVIRONMENT"GIT_PROTOCOL" 508/* HTTP header used to handshake the wire protocol */ 509#define GIT_PROTOCOL_HEADER"Git-Protocol" 510 511/* 512 * This environment variable is expected to contain a boolean indicating 513 * whether we should or should not treat: 514 * 515 * GIT_DIR=foo.git git ... 516 * 517 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 518 * of this, but we use it internally to communicate to sub-processes that we 519 * are in a bare repo. If not set, defaults to true. 520 */ 521#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 522 523/* 524 * Repository-local GIT_* environment variables; these will be cleared 525 * when git spawns a sub-process that runs inside another repository. 526 * The array is NULL-terminated, which makes it easy to pass in the "env" 527 * parameter of a run-command invocation, or to do a simple walk. 528 */ 529externconst char*const local_repo_env[]; 530 531externvoidsetup_git_env(const char*git_dir); 532 533/* 534 * Returns true iff we have a configured git repository (either via 535 * setup_git_directory, or in the environment via $GIT_DIR). 536 */ 537inthave_git_dir(void); 538 539externint is_bare_repository_cfg; 540externintis_bare_repository(void); 541externintis_inside_git_dir(void); 542externchar*git_work_tree_cfg; 543externintis_inside_work_tree(void); 544externconst char*get_git_dir(void); 545externconst char*get_git_common_dir(void); 546externchar*get_object_directory(void); 547externchar*get_index_file(void); 548externchar*get_graft_file(void); 549externvoidset_git_dir(const char*path); 550externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 551externintget_common_dir(struct strbuf *sb,const char*gitdir); 552externconst char*get_git_namespace(void); 553externconst char*strip_namespace(const char*namespaced_ref); 554externconst char*get_super_prefix(void); 555externconst char*get_git_work_tree(void); 556 557/* 558 * Return true if the given path is a git directory; note that this _just_ 559 * looks at the directory itself. If you want to know whether "foo/.git" 560 * is a repository, you must feed that path, not just "foo". 561 */ 562externintis_git_directory(const char*path); 563 564/* 565 * Return 1 if the given path is the root of a git repository or 566 * submodule, else 0. Will not return 1 for bare repositories with the 567 * exception of creating a bare repository in "foo/.git" and calling 568 * is_git_repository("foo"). 569 * 570 * If we run into read errors, we err on the side of saying "yes, it is", 571 * as we usually consider sub-repos precious, and would prefer to err on the 572 * side of not disrupting or deleting them. 573 */ 574externintis_nonbare_repository_dir(struct strbuf *path); 575 576#define READ_GITFILE_ERR_STAT_FAILED 1 577#define READ_GITFILE_ERR_NOT_A_FILE 2 578#define READ_GITFILE_ERR_OPEN_FAILED 3 579#define READ_GITFILE_ERR_READ_FAILED 4 580#define READ_GITFILE_ERR_INVALID_FORMAT 5 581#define READ_GITFILE_ERR_NO_PATH 6 582#define READ_GITFILE_ERR_NOT_A_REPO 7 583#define READ_GITFILE_ERR_TOO_LARGE 8 584externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 585externconst char*read_gitfile_gently(const char*path,int*return_error_code); 586#define read_gitfile(path) read_gitfile_gently((path), NULL) 587externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 588#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 589 590externvoidset_git_work_tree(const char*tree); 591 592#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 593 594externvoidsetup_work_tree(void); 595/* 596 * Find the commondir and gitdir of the repository that contains the current 597 * working directory, without changing the working directory or other global 598 * state. The result is appended to commondir and gitdir. If the discovered 599 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 600 * both have the same result appended to the buffer. The return value is 601 * either 0 upon success and non-zero if no repository was found. 602 */ 603externintdiscover_git_directory(struct strbuf *commondir, 604struct strbuf *gitdir); 605externconst char*setup_git_directory_gently(int*); 606externconst char*setup_git_directory(void); 607externchar*prefix_path(const char*prefix,int len,const char*path); 608externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 609 610/* 611 * Concatenate "prefix" (if len is non-zero) and "path", with no 612 * connecting characters (so "prefix" should end with a "/"). 613 * Unlike prefix_path, this should be used if the named file does 614 * not have to interact with index entry; i.e. name of a random file 615 * on the filesystem. 616 * 617 * The return value is always a newly allocated string (even if the 618 * prefix was empty). 619 */ 620externchar*prefix_filename(const char*prefix,const char*path); 621 622externintcheck_filename(const char*prefix,const char*name); 623externvoidverify_filename(const char*prefix, 624const char*name, 625int diagnose_misspelt_rev); 626externvoidverify_non_filename(const char*prefix,const char*name); 627externintpath_inside_repo(const char*prefix,const char*path); 628 629#define INIT_DB_QUIET 0x0001 630#define INIT_DB_EXIST_OK 0x0002 631 632externintinit_db(const char*git_dir,const char*real_git_dir, 633const char*template_dir,unsigned int flags); 634 635externvoidsanitize_stdfds(void); 636externintdaemonize(void); 637 638#define alloc_nr(x) (((x)+16)*3/2) 639 640/* 641 * Realloc the buffer pointed at by variable 'x' so that it can hold 642 * at least 'nr' entries; the number of entries currently allocated 643 * is 'alloc', using the standard growing factor alloc_nr() macro. 644 * 645 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 646 */ 647#define ALLOC_GROW(x, nr, alloc) \ 648 do { \ 649 if ((nr) > alloc) { \ 650 if (alloc_nr(alloc) < (nr)) \ 651 alloc = (nr); \ 652 else \ 653 alloc = alloc_nr(alloc); \ 654 REALLOC_ARRAY(x, alloc); \ 655 } \ 656 } while (0) 657 658/* Initialize and use the cache information */ 659struct lock_file; 660externintread_index(struct index_state *); 661externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 662externintdo_read_index(struct index_state *istate,const char*path, 663int must_exist);/* for testting only! */ 664externintread_index_from(struct index_state *,const char*path, 665const char*gitdir); 666externintis_index_unborn(struct index_state *); 667externintread_index_unmerged(struct index_state *); 668 669/* For use with `write_locked_index()`. */ 670#define COMMIT_LOCK (1 << 0) 671#define SKIP_IF_UNCHANGED (1 << 1) 672 673/* 674 * Write the index while holding an already-taken lock. Close the lock, 675 * and if `COMMIT_LOCK` is given, commit it. 676 * 677 * Unless a split index is in use, write the index into the lockfile. 678 * 679 * With a split index, write the shared index to a temporary file, 680 * adjust its permissions and rename it into place, then write the 681 * split index to the lockfile. If the temporary file for the shared 682 * index cannot be created, fall back to the behavior described in 683 * the previous paragraph. 684 * 685 * With `COMMIT_LOCK`, the lock is always committed or rolled back. 686 * Without it, the lock is closed, but neither committed nor rolled 687 * back. 688 * 689 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing 690 * is written (and the lock is rolled back if `COMMIT_LOCK` is given). 691 */ 692externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 693 694externintdiscard_index(struct index_state *); 695externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 696externintunmerged_index(const struct index_state *); 697 698/** 699 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn 700 * branch, returns 1 if there are entries in the index, 0 otherwise. If an 701 * strbuf is provided, the space-separated list of files that differ will be 702 * appended to it. 703 */ 704externintindex_has_changes(struct strbuf *sb); 705 706externintverify_path(const char*path,unsigned mode); 707externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 708externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 709externvoidadjust_dirname_case(struct index_state *istate,char*name); 710externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 711 712/* 713 * Searches for an entry defined by name and namelen in the given index. 714 * If the return value is positive (including 0) it is the position of an 715 * exact match. If the return value is negative, the negated value minus 1 716 * is the position where the entry would be inserted. 717 * Example: The current index consists of these files and its stages: 718 * 719 * b#0, d#0, f#1, f#3 720 * 721 * index_name_pos(&index, "a", 1) -> -1 722 * index_name_pos(&index, "b", 1) -> 0 723 * index_name_pos(&index, "c", 1) -> -2 724 * index_name_pos(&index, "d", 1) -> 1 725 * index_name_pos(&index, "e", 1) -> -3 726 * index_name_pos(&index, "f", 1) -> -3 727 * index_name_pos(&index, "g", 1) -> -5 728 */ 729externintindex_name_pos(const struct index_state *,const char*name,int namelen); 730 731#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 732#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 733#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 734#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 735#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 736#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 737externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 738externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 739 740/* Remove entry, return true if there are more entries to go. */ 741externintremove_index_entry_at(struct index_state *,int pos); 742 743externvoidremove_marked_cache_entries(struct index_state *istate); 744externintremove_file_from_index(struct index_state *,const char*path); 745#define ADD_CACHE_VERBOSE 1 746#define ADD_CACHE_PRETEND 2 747#define ADD_CACHE_IGNORE_ERRORS 4 748#define ADD_CACHE_IGNORE_REMOVAL 8 749#define ADD_CACHE_INTENT 16 750/* 751 * These two are used to add the contents of the file at path 752 * to the index, marking the working tree up-to-date by storing 753 * the cached stat info in the resulting cache entry. A caller 754 * that has already run lstat(2) on the path can call 755 * add_to_index(), and all others can call add_file_to_index(); 756 * the latter will do necessary lstat(2) internally before 757 * calling the former. 758 */ 759externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 760externintadd_file_to_index(struct index_state *,const char*path,int flags); 761 762externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 763externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 764externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 765externintindex_name_is_other(const struct index_state *,const char*,int); 766externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 767 768/* do stat comparison even if CE_VALID is true */ 769#define CE_MATCH_IGNORE_VALID 01 770/* do not check the contents but report dirty on racily-clean entries */ 771#define CE_MATCH_RACY_IS_DIRTY 02 772/* do stat comparison even if CE_SKIP_WORKTREE is true */ 773#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 774/* ignore non-existent files during stat update */ 775#define CE_MATCH_IGNORE_MISSING 0x08 776/* enable stat refresh */ 777#define CE_MATCH_REFRESH 0x10 778/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */ 779#define CE_MATCH_IGNORE_FSMONITOR 0X20 780externintie_match_stat(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 781externintie_modified(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 782 783#define HASH_WRITE_OBJECT 1 784#define HASH_FORMAT_CHECK 2 785#define HASH_RENORMALIZE 4 786externintindex_fd(struct object_id *oid,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 787externintindex_path(struct object_id *oid,const char*path,struct stat *st,unsigned flags); 788 789/* 790 * Record to sd the data from st that we use to check whether a file 791 * might have changed. 792 */ 793externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 794 795/* 796 * Return 0 if st is consistent with a file not having been changed 797 * since sd was filled. If there are differences, return a 798 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 799 * INODE_CHANGED, and DATA_CHANGED. 800 */ 801externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 802externintmatch_stat_data_racy(const struct index_state *istate, 803const struct stat_data *sd,struct stat *st); 804 805externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 806 807#define REFRESH_REALLY 0x0001/* ignore_valid */ 808#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 809#define REFRESH_QUIET 0x0004/* be quiet about it */ 810#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 811#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 812#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 813externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 814externstruct cache_entry *refresh_cache_entry(struct index_state *,struct cache_entry *,unsigned int); 815 816/* 817 * Opportunistically update the index but do not complain if we can't. 818 * The lockfile is always committed or rolled back. 819 */ 820externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 821 822externinthold_locked_index(struct lock_file *,int); 823externvoidset_alternate_index_output(const char*); 824 825externint verify_index_checksum; 826externint verify_ce_order; 827 828/* Environment bits from configuration mechanism */ 829externint trust_executable_bit; 830externint trust_ctime; 831externint check_stat; 832externint quote_path_fully; 833externint has_symlinks; 834externint minimum_abbrev, default_abbrev; 835externint ignore_case; 836externint assume_unchanged; 837externint prefer_symlink_refs; 838externint warn_ambiguous_refs; 839externint warn_on_object_refname_ambiguity; 840externconst char*apply_default_whitespace; 841externconst char*apply_default_ignorewhitespace; 842externconst char*git_attributes_file; 843externconst char*git_hooks_path; 844externint zlib_compression_level; 845externint core_compression_level; 846externint pack_compression_level; 847externsize_t packed_git_window_size; 848externsize_t packed_git_limit; 849externsize_t delta_base_cache_limit; 850externunsigned long big_file_threshold; 851externunsigned long pack_size_limit_cfg; 852 853/* 854 * Accessors for the core.sharedrepository config which lazy-load the value 855 * from the config (if not already set). The "reset" function can be 856 * used to unset "set" or cached value, meaning that the value will be loaded 857 * fresh from the config file on the next call to get_shared_repository(). 858 */ 859voidset_shared_repository(int value); 860intget_shared_repository(void); 861voidreset_shared_repository(void); 862 863/* 864 * Do replace refs need to be checked this run? This variable is 865 * initialized to true unless --no-replace-object is used or 866 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 867 * commands that do not want replace references to be active. As an 868 * optimization it is also set to false if replace references have 869 * been sought but there were none. 870 */ 871externint check_replace_refs; 872externchar*git_replace_ref_base; 873 874externint fsync_object_files; 875externint core_preload_index; 876externint core_commit_graph; 877externint core_apply_sparse_checkout; 878externint precomposed_unicode; 879externint protect_hfs; 880externint protect_ntfs; 881externconst char*core_fsmonitor; 882 883/* 884 * Include broken refs in all ref iterations, which will 885 * generally choke dangerous operations rather than letting 886 * them silently proceed without taking the broken ref into 887 * account. 888 */ 889externint ref_paranoia; 890 891/* 892 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value). 893 */ 894intuse_optional_locks(void); 895 896/* 897 * The character that begins a commented line in user-editable file 898 * that is subject to stripspace. 899 */ 900externchar comment_line_char; 901externint auto_comment_line_char; 902 903/* Windows only */ 904enum hide_dotfiles_type { 905 HIDE_DOTFILES_FALSE =0, 906 HIDE_DOTFILES_TRUE, 907 HIDE_DOTFILES_DOTGITONLY 908}; 909externenum hide_dotfiles_type hide_dotfiles; 910 911enum log_refs_config { 912 LOG_REFS_UNSET = -1, 913 LOG_REFS_NONE =0, 914 LOG_REFS_NORMAL, 915 LOG_REFS_ALWAYS 916}; 917externenum log_refs_config log_all_ref_updates; 918 919enum branch_track { 920 BRANCH_TRACK_UNSPECIFIED = -1, 921 BRANCH_TRACK_NEVER =0, 922 BRANCH_TRACK_REMOTE, 923 BRANCH_TRACK_ALWAYS, 924 BRANCH_TRACK_EXPLICIT, 925 BRANCH_TRACK_OVERRIDE 926}; 927 928enum rebase_setup_type { 929 AUTOREBASE_NEVER =0, 930 AUTOREBASE_LOCAL, 931 AUTOREBASE_REMOTE, 932 AUTOREBASE_ALWAYS 933}; 934 935enum push_default_type { 936 PUSH_DEFAULT_NOTHING =0, 937 PUSH_DEFAULT_MATCHING, 938 PUSH_DEFAULT_SIMPLE, 939 PUSH_DEFAULT_UPSTREAM, 940 PUSH_DEFAULT_CURRENT, 941 PUSH_DEFAULT_UNSPECIFIED 942}; 943 944externenum branch_track git_branch_track; 945externenum rebase_setup_type autorebase; 946externenum push_default_type push_default; 947 948enum object_creation_mode { 949 OBJECT_CREATION_USES_HARDLINKS =0, 950 OBJECT_CREATION_USES_RENAMES =1 951}; 952 953externenum object_creation_mode object_creation_mode; 954 955externchar*notes_ref_name; 956 957externint grafts_replace_parents; 958 959/* 960 * GIT_REPO_VERSION is the version we write by default. The 961 * _READ variant is the highest number we know how to 962 * handle. 963 */ 964#define GIT_REPO_VERSION 0 965#define GIT_REPO_VERSION_READ 1 966externint repository_format_precious_objects; 967externchar*repository_format_partial_clone; 968externconst char*core_partial_clone_filter_default; 969 970struct repository_format { 971int version; 972int precious_objects; 973char*partial_clone;/* value of extensions.partialclone */ 974int is_bare; 975int hash_algo; 976char*work_tree; 977struct string_list unknown_extensions; 978}; 979 980/* 981 * Read the repository format characteristics from the config file "path" into 982 * "format" struct. Returns the numeric version. On error, -1 is returned, 983 * format->version is set to -1, and all other fields in the struct are 984 * undefined. 985 */ 986intread_repository_format(struct repository_format *format,const char*path); 987 988/* 989 * Verify that the repository described by repository_format is something we 990 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 991 * any errors encountered. 992 */ 993intverify_repository_format(const struct repository_format *format, 994struct strbuf *err); 995 996/* 997 * Check the repository format version in the path found in get_git_dir(), 998 * and die if it is a version we don't understand. Generally one would 999 * set_git_dir() before calling this, and use it only for "are we in a valid1000 * repo?".1001 */1002externvoidcheck_repository_format(void);10031004#define MTIME_CHANGED 0x00011005#define CTIME_CHANGED 0x00021006#define OWNER_CHANGED 0x00041007#define MODE_CHANGED 0x00081008#define INODE_CHANGED 0x00101009#define DATA_CHANGED 0x00201010#define TYPE_CHANGED 0x004010111012/*1013 * Return an abbreviated sha1 unique within this repository's object database.1014 * The result will be at least `len` characters long, and will be NUL1015 * terminated.1016 *1017 * The non-`_r` version returns a static buffer which remains valid until 41018 * more calls to find_unique_abbrev are made.1019 *1020 * The `_r` variant writes to a buffer supplied by the caller, which must be at1021 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes1022 * written (excluding the NUL terminator).1023 *1024 * Note that while this version avoids the static buffer, it is not fully1025 * reentrant, as it calls into other non-reentrant git code.1026 */1027externconst char*find_unique_abbrev(const struct object_id *oid,int len);1028externintfind_unique_abbrev_r(char*hex,const struct object_id *oid,int len);10291030externconst unsigned char null_sha1[GIT_MAX_RAWSZ];1031externconst struct object_id null_oid;10321033staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2)1034{1035returnmemcmp(sha1, sha2, GIT_SHA1_RAWSZ);1036}10371038staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2)1039{1040returnhashcmp(oid1->hash, oid2->hash);1041}10421043staticinlineintis_null_sha1(const unsigned char*sha1)1044{1045return!hashcmp(sha1, null_sha1);1046}10471048staticinlineintis_null_oid(const struct object_id *oid)1049{1050return!hashcmp(oid->hash, null_sha1);1051}10521053staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src)1054{1055memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);1056}10571058staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src)1059{1060hashcpy(dst->hash, src->hash);1061}10621063staticinlinestruct object_id *oiddup(const struct object_id *src)1064{1065struct object_id *dst =xmalloc(sizeof(struct object_id));1066oidcpy(dst, src);1067return dst;1068}10691070staticinlinevoidhashclr(unsigned char*hash)1071{1072memset(hash,0, GIT_SHA1_RAWSZ);1073}10741075staticinlinevoidoidclr(struct object_id *oid)1076{1077memset(oid->hash,0, GIT_MAX_RAWSZ);1078}10791080staticinlinevoidoidread(struct object_id *oid,const unsigned char*hash)1081{1082memcpy(oid->hash, hash, the_hash_algo->rawsz);1083}10841085staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1086{1087return!hashcmp(sha1, the_hash_algo->empty_blob->hash);1088}10891090staticinlineintis_empty_blob_oid(const struct object_id *oid)1091{1092return!oidcmp(oid, the_hash_algo->empty_blob);1093}10941095staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1096{1097return!hashcmp(sha1, the_hash_algo->empty_tree->hash);1098}10991100staticinlineintis_empty_tree_oid(const struct object_id *oid)1101{1102return!oidcmp(oid, the_hash_algo->empty_tree);1103}11041105const char*empty_tree_oid_hex(void);1106const char*empty_blob_oid_hex(void);11071108/* set default permissions by passing mode arguments to open(2) */1109intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1110intgit_mkstemp_mode(char*pattern,int mode);11111112/*1113 * NOTE NOTE NOTE!!1114 *1115 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1116 * not be changed. Old repositories have core.sharedrepository written in1117 * numeric format, and therefore these values are preserved for compatibility1118 * reasons.1119 */1120enum sharedrepo {1121 PERM_UMASK =0,1122 OLD_PERM_GROUP =1,1123 OLD_PERM_EVERYBODY =2,1124 PERM_GROUP =0660,1125 PERM_EVERYBODY =06641126};1127intgit_config_perm(const char*var,const char*value);1128intadjust_shared_perm(const char*path);11291130/*1131 * Create the directory containing the named path, using care to be1132 * somewhat safe against races. Return one of the scld_error values to1133 * indicate success/failure. On error, set errno to describe the1134 * problem.1135 *1136 * SCLD_VANISHED indicates that one of the ancestor directories of the1137 * path existed at one point during the function call and then1138 * suddenly vanished, probably because another process pruned the1139 * directory while we were working. To be robust against this kind of1140 * race, callers might want to try invoking the function again when it1141 * returns SCLD_VANISHED.1142 *1143 * safe_create_leading_directories() temporarily changes path while it1144 * is working but restores it before returning.1145 * safe_create_leading_directories_const() doesn't modify path, even1146 * temporarily.1147 */1148enum scld_error {1149 SCLD_OK =0,1150 SCLD_FAILED = -1,1151 SCLD_PERMS = -2,1152 SCLD_EXISTS = -3,1153 SCLD_VANISHED = -41154};1155enum scld_error safe_create_leading_directories(char*path);1156enum scld_error safe_create_leading_directories_const(const char*path);11571158/*1159 * Callback function for raceproof_create_file(). This function is1160 * expected to do something that makes dirname(path) permanent despite1161 * the fact that other processes might be cleaning up empty1162 * directories at the same time. Usually it will create a file named1163 * path, but alternatively it could create another file in that1164 * directory, or even chdir() into that directory. The function should1165 * return 0 if the action was completed successfully. On error, it1166 * should return a nonzero result and set errno.1167 * raceproof_create_file() treats two errno values specially:1168 *1169 * - ENOENT -- dirname(path) does not exist. In this case,1170 * raceproof_create_file() tries creating dirname(path)1171 * (and any parent directories, if necessary) and calls1172 * the function again.1173 *1174 * - EISDIR -- the file already exists and is a directory. In this1175 * case, raceproof_create_file() removes the directory if1176 * it is empty (and recursively any empty directories that1177 * it contains) and calls the function again.1178 *1179 * Any other errno causes raceproof_create_file() to fail with the1180 * callback's return value and errno.1181 *1182 * Obviously, this function should be OK with being called again if it1183 * fails with ENOENT or EISDIR. In other scenarios it will not be1184 * called again.1185 */1186typedefintcreate_file_fn(const char*path,void*cb);11871188/*1189 * Create a file in dirname(path) by calling fn, creating leading1190 * directories if necessary. Retry a few times in case we are racing1191 * with another process that is trying to clean up the directory that1192 * contains path. See the documentation for create_file_fn for more1193 * details.1194 *1195 * Return the value and set the errno that resulted from the most1196 * recent call of fn. fn is always called at least once, and will be1197 * called more than once if it returns ENOENT or EISDIR.1198 */1199intraceproof_create_file(const char*path, create_file_fn fn,void*cb);12001201intmkdir_in_gitdir(const char*path);1202externchar*expand_user_path(const char*path,int real_home);1203const char*enter_repo(const char*path,int strict);1204staticinlineintis_absolute_path(const char*path)1205{1206returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1207}1208intis_directory(const char*);1209char*strbuf_realpath(struct strbuf *resolved,const char*path,1210int die_on_error);1211const char*real_path(const char*path);1212const char*real_path_if_valid(const char*path);1213char*real_pathdup(const char*path,int die_on_error);1214const char*absolute_path(const char*path);1215char*absolute_pathdup(const char*path);1216const char*remove_leading_path(const char*in,const char*prefix);1217const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1218intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1219intnormalize_path_copy(char*dst,const char*src);1220intlongest_ancestor_length(const char*path,struct string_list *prefixes);1221char*strip_path_suffix(const char*path,const char*suffix);1222intdaemon_avoid_alias(const char*path);12231224/*1225 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for1226 * details.1227 */1228intis_ntfs_dotgit(const char*name);1229intis_ntfs_dotgitmodules(const char*name);1230intis_ntfs_dotgitignore(const char*name);1231intis_ntfs_dotgitattributes(const char*name);12321233/*1234 * Returns true iff "str" could be confused as a command-line option when1235 * passed to a sub-program like "ssh". Note that this has nothing to do with1236 * shell-quoting, which should be handled separately; we're assuming here that1237 * the string makes it verbatim to the sub-program.1238 */1239intlooks_like_command_line_option(const char*str);12401241/**1242 * Return a newly allocated string with the evaluation of1243 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1244 * "$HOME/.config/git/$filename". Return NULL upon error.1245 */1246externchar*xdg_config_home(const char*filename);12471248/**1249 * Return a newly allocated string with the evaluation of1250 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1251 * "$HOME/.cache/git/$filename". Return NULL upon error.1252 */1253externchar*xdg_cache_home(const char*filename);12541255externvoid*read_object_file_extended(const struct object_id *oid,1256enum object_type *type,1257unsigned long*size,int lookup_replace);1258staticinlinevoid*read_object_file(const struct object_id *oid,enum object_type *type,unsigned long*size)1259{1260returnread_object_file_extended(oid, type, size,1);1261}12621263/* Read and unpack an object file into memory, write memory to an object file */1264intoid_object_info(struct repository *r,const struct object_id *,unsigned long*);12651266externinthash_object_file(const void*buf,unsigned long len,1267const char*type,struct object_id *oid);12681269externintwrite_object_file(const void*buf,unsigned long len,1270const char*type,struct object_id *oid);12711272externinthash_object_file_literally(const void*buf,unsigned long len,1273const char*type,struct object_id *oid,1274unsigned flags);12751276externintpretend_object_file(void*,unsigned long,enum object_type,1277struct object_id *oid);12781279externintforce_object_loose(const struct object_id *oid,time_t mtime);12801281externintgit_open_cloexec(const char*name,int flags);1282#define git_open(name) git_open_cloexec(name, O_RDONLY)1283externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1284externintparse_sha1_header(const char*hdr,unsigned long*sizep);12851286externintcheck_object_signature(const struct object_id *oid,void*buf,unsigned long size,const char*type);12871288externintfinalize_object_file(const char*tmpfile,const char*filename);12891290/*1291 * Open the loose object at path, check its hash, and return the contents,1292 * type, and size. If the object is a blob, then "contents" may return NULL,1293 * to allow streaming of large blobs.1294 *1295 * Returns 0 on success, negative on error (details may be written to stderr).1296 */1297intread_loose_object(const char*path,1298const struct object_id *expected_oid,1299enum object_type *type,1300unsigned long*size,1301void**contents);13021303/*1304 * Convenience for sha1_object_info_extended() with a NULL struct1305 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass1306 * nonzero flags to also set other flags.1307 */1308externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1309staticinlineinthas_sha1_file(const unsigned char*sha1)1310{1311returnhas_sha1_file_with_flags(sha1,0);1312}13131314/* Same as the above, except for struct object_id. */1315externinthas_object_file(const struct object_id *oid);1316externinthas_object_file_with_flags(const struct object_id *oid,int flags);13171318/*1319 * Return true iff an alternate object database has a loose object1320 * with the specified name. This function does not respect replace1321 * references.1322 */1323externinthas_loose_object_nonlocal(const struct object_id *oid);13241325externvoidassert_oid_type(const struct object_id *oid,enum object_type expect);13261327/* Helper to check and "touch" a file */1328externintcheck_and_freshen_file(const char*fn,int freshen);13291330externconst signed char hexval_table[256];1331staticinlineunsigned inthexval(unsigned char c)1332{1333return hexval_table[c];1334}13351336/*1337 * Convert two consecutive hexadecimal digits into a char. Return a1338 * negative value on error. Don't run over the end of short strings.1339 */1340staticinlineinthex2chr(const char*s)1341{1342unsigned int val =hexval(s[0]);1343return(val & ~0xf) ? val : (val <<4) |hexval(s[1]);1344}13451346/* Convert to/from hex/sha1 representation */1347#define MINIMUM_ABBREV minimum_abbrev1348#define DEFAULT_ABBREV default_abbrev13491350/* used when the code does not know or care what the default abbrev is */1351#define FALLBACK_DEFAULT_ABBREV 713521353struct object_context {1354unsigned mode;1355/*1356 * symlink_path is only used by get_tree_entry_follow_symlinks,1357 * and only for symlinks that point outside the repository.1358 */1359struct strbuf symlink_path;1360/*1361 * If GET_OID_RECORD_PATH is set, this will record path (if any)1362 * found when resolving the name. The caller is responsible for1363 * releasing the memory.1364 */1365char*path;1366};13671368#define GET_OID_QUIETLY 011369#define GET_OID_COMMIT 021370#define GET_OID_COMMITTISH 041371#define GET_OID_TREE 0101372#define GET_OID_TREEISH 0201373#define GET_OID_BLOB 0401374#define GET_OID_FOLLOW_SYMLINKS 01001375#define GET_OID_RECORD_PATH 02001376#define GET_OID_ONLY_TO_DIE 0400013771378#define GET_OID_DISAMBIGUATORS \1379 (GET_OID_COMMIT | GET_OID_COMMITTISH | \1380 GET_OID_TREE | GET_OID_TREEISH | \1381 GET_OID_BLOB)13821383externintget_oid(const char*str,struct object_id *oid);1384externintget_oid_commit(const char*str,struct object_id *oid);1385externintget_oid_committish(const char*str,struct object_id *oid);1386externintget_oid_tree(const char*str,struct object_id *oid);1387externintget_oid_treeish(const char*str,struct object_id *oid);1388externintget_oid_blob(const char*str,struct object_id *oid);1389externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1390externintget_oid_with_context(const char*str,unsigned flags,struct object_id *oid,struct object_context *oc);139113921393typedefinteach_abbrev_fn(const struct object_id *oid,void*);1394externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13951396externintset_disambiguate_hint_config(const char*var,const char*value);13971398/*1399 * Try to read a SHA1 in hexadecimal format from the 40 characters1400 * starting at hex. Write the 20-byte result to sha1 in binary form.1401 * Return 0 on success. Reading stops if a NUL is encountered in the1402 * input, so it is safe to pass this function an arbitrary1403 * null-terminated string.1404 */1405externintget_sha1_hex(const char*hex,unsigned char*sha1);1406externintget_oid_hex(const char*hex,struct object_id *sha1);14071408/*1409 * Read `len` pairs of hexadecimal digits from `hex` and write the1410 * values to `binary` as `len` bytes. Return 0 on success, or -1 if1411 * the input does not consist of hex digits).1412 */1413externinthex_to_bytes(unsigned char*binary,const char*hex,size_t len);14141415/*1416 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1417 * and writes the NUL-terminated output to the buffer `out`, which must be at1418 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1419 * convenience.1420 *1421 * The non-`_r` variant returns a static buffer, but uses a ring of 41422 * buffers, making it safe to make multiple calls for a single statement, like:1423 *1424 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1425 */1426externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1427externchar*oid_to_hex_r(char*out,const struct object_id *oid);1428externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1429externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */14301431/*1432 * Parse a 40-character hexadecimal object ID starting from hex, updating the1433 * pointer specified by end when parsing stops. The resulting object ID is1434 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1435 * other invalid character. end is only updated on success; otherwise, it is1436 * unmodified.1437 */1438externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);14391440/*1441 * This reads short-hand syntax that not only evaluates to a commit1442 * object name, but also can act as if the end user spelled the name1443 * of the branch from the command line.1444 *1445 * - "@{-N}" finds the name of the Nth previous branch we were on, and1446 * places the name of the branch in the given buf and returns the1447 * number of characters parsed if successful.1448 *1449 * - "<branch>@{upstream}" finds the name of the other ref that1450 * <branch> is configured to merge with (missing <branch> defaults1451 * to the current branch), and places the name of the branch in the1452 * given buf and returns the number of characters parsed if1453 * successful.1454 *1455 * If the input is not of the accepted format, it returns a negative1456 * number to signal an error.1457 *1458 * If the input was ok but there are not N branch switches in the1459 * reflog, it returns 0.1460 *1461 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1462 * expansions: local branches ("refs/heads/"), remote branches1463 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1464 * allowed, even ones to refs outside of those namespaces.1465 */1466#define INTERPRET_BRANCH_LOCAL (1<<0)1467#define INTERPRET_BRANCH_REMOTE (1<<1)1468#define INTERPRET_BRANCH_HEAD (1<<2)1469externintinterpret_branch_name(const char*str,int len,struct strbuf *,1470unsigned allowed);1471externintget_oid_mb(const char*str,struct object_id *oid);14721473externintvalidate_headref(const char*ref);14741475externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1476externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1477externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1478externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);14791480externvoid*read_object_with_reference(const struct object_id *oid,1481const char*required_type,1482unsigned long*size,1483struct object_id *oid_ret);14841485externstruct object *peel_to_type(const char*name,int namelen,1486struct object *o,enum object_type);14871488struct date_mode {1489enum date_mode_type {1490 DATE_NORMAL =0,1491 DATE_RELATIVE,1492 DATE_SHORT,1493 DATE_ISO8601,1494 DATE_ISO8601_STRICT,1495 DATE_RFC2822,1496 DATE_STRFTIME,1497 DATE_RAW,1498 DATE_UNIX1499} type;1500const char*strftime_fmt;1501int local;1502};15031504/*1505 * Convenience helper for passing a constant type, like:1506 *1507 * show_date(t, tz, DATE_MODE(NORMAL));1508 */1509#define DATE_MODE(t) date_mode_from_type(DATE_##t)1510struct date_mode *date_mode_from_type(enum date_mode_type type);15111512const char*show_date(timestamp_t time,int timezone,const struct date_mode *mode);1513voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1514struct strbuf *timebuf);1515intparse_date(const char*date,struct strbuf *out);1516intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1517intparse_expiry_date(const char*date, timestamp_t *timestamp);1518voiddatestamp(struct strbuf *out);1519#define approxidate(s) approxidate_careful((s), NULL)1520timestamp_t approxidate_careful(const char*,int*);1521timestamp_t approxidate_relative(const char*date,const struct timeval *now);1522voidparse_date_format(const char*format,struct date_mode *mode);1523intdate_overflows(timestamp_t date);15241525#define IDENT_STRICT 11526#define IDENT_NO_DATE 21527#define IDENT_NO_NAME 41528externconst char*git_author_info(int);1529externconst char*git_committer_info(int);1530externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1531externconst char*fmt_name(const char*name,const char*email);1532externconst char*ident_default_name(void);1533externconst char*ident_default_email(void);1534externconst char*git_editor(void);1535externconst char*git_pager(int stdout_is_tty);1536externintis_terminal_dumb(void);1537externintgit_ident_config(const char*,const char*,void*);1538externvoidreset_ident_date(void);15391540struct ident_split {1541const char*name_begin;1542const char*name_end;1543const char*mail_begin;1544const char*mail_end;1545const char*date_begin;1546const char*date_end;1547const char*tz_begin;1548const char*tz_end;1549};1550/*1551 * Signals an success with 0, but time part of the result may be NULL1552 * if the input lacks timestamp and zone1553 */1554externintsplit_ident_line(struct ident_split *,const char*,int);15551556/*1557 * Like show_date, but pull the timestamp and tz parameters from1558 * the ident_split. It will also sanity-check the values and produce1559 * a well-known sentinel date if they appear bogus.1560 */1561const char*show_ident_date(const struct ident_split *id,1562const struct date_mode *mode);15631564/*1565 * Compare split idents for equality or strict ordering. Note that we1566 * compare only the ident part of the line, ignoring any timestamp.1567 *1568 * Because there are two fields, we must choose one as the primary key; we1569 * currently arbitrarily pick the email.1570 */1571externintident_cmp(const struct ident_split *,const struct ident_split *);15721573struct checkout {1574struct index_state *istate;1575const char*base_dir;1576int base_dir_len;1577struct delayed_checkout *delayed_checkout;1578unsigned force:1,1579 quiet:1,1580 not_new:1,1581 refresh_cache:1;1582};1583#define CHECKOUT_INIT { NULL,"" }15841585#define TEMPORARY_FILENAME_LENGTH 251586externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);1587externvoidenable_delayed_checkout(struct checkout *state);1588externintfinish_delayed_checkout(struct checkout *state);15891590struct cache_def {1591struct strbuf path;1592int flags;1593int track_flags;1594int prefix_len_stat_func;1595};1596#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1597staticinlinevoidcache_def_clear(struct cache_def *cache)1598{1599strbuf_release(&cache->path);1600}16011602externinthas_symlink_leading_path(const char*name,int len);1603externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1604externintcheck_leading_path(const char*name,int len);1605externinthas_dirs_only_path(const char*name,int len,int prefix_len);1606externvoidschedule_dir_for_removal(const char*name,int len);1607externvoidremove_scheduled_dirs(void);16081609struct pack_window {1610struct pack_window *next;1611unsigned char*base;1612 off_t offset;1613size_t len;1614unsigned int last_used;1615unsigned int inuse_cnt;1616};16171618struct pack_entry {1619 off_t offset;1620struct packed_git *p;1621};16221623/*1624 * Create a temporary file rooted in the object database directory, or1625 * die on failure. The filename is taken from "pattern", which should have the1626 * usual "XXXXXX" trailer, and the resulting filename is written into the1627 * "template" buffer. Returns the open descriptor.1628 */1629externintodb_mkstemp(struct strbuf *temp_filename,const char*pattern);16301631/*1632 * Create a pack .keep file named "name" (which should generally be the output1633 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1634 * error.1635 */1636externintodb_pack_keep(const char*name);16371638/*1639 * Iterate over the files in the loose-object parts of the object1640 * directory "path", triggering the following callbacks:1641 *1642 * - loose_object is called for each loose object we find.1643 *1644 * - loose_cruft is called for any files that do not appear to be1645 * loose objects. Note that we only look in the loose object1646 * directories "objects/[0-9a-f]{2}/", so we will not report1647 * "objects/foobar" as cruft.1648 *1649 * - loose_subdir is called for each top-level hashed subdirectory1650 * of the object directory (e.g., "$OBJDIR/f0"). It is called1651 * after the objects in the directory are processed.1652 *1653 * Any callback that is NULL will be ignored. Callbacks returning non-zero1654 * will end the iteration.1655 *1656 * In the "buf" variant, "path" is a strbuf which will also be used as a1657 * scratch buffer, but restored to its original contents before1658 * the function returns.1659 */1660typedefinteach_loose_object_fn(const struct object_id *oid,1661const char*path,1662void*data);1663typedefinteach_loose_cruft_fn(const char*basename,1664const char*path,1665void*data);1666typedefinteach_loose_subdir_fn(unsigned int nr,1667const char*path,1668void*data);1669intfor_each_file_in_obj_subdir(unsigned int subdir_nr,1670struct strbuf *path,1671 each_loose_object_fn obj_cb,1672 each_loose_cruft_fn cruft_cb,1673 each_loose_subdir_fn subdir_cb,1674void*data);1675intfor_each_loose_file_in_objdir(const char*path,1676 each_loose_object_fn obj_cb,1677 each_loose_cruft_fn cruft_cb,1678 each_loose_subdir_fn subdir_cb,1679void*data);1680intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1681 each_loose_object_fn obj_cb,1682 each_loose_cruft_fn cruft_cb,1683 each_loose_subdir_fn subdir_cb,1684void*data);16851686/*1687 * Iterate over loose objects in both the local1688 * repository and any alternates repositories (unless the1689 * LOCAL_ONLY flag is set).1690 */1691#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11692externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);16931694struct object_info {1695/* Request */1696enum object_type *typep;1697unsigned long*sizep;1698 off_t *disk_sizep;1699unsigned char*delta_base_sha1;1700struct strbuf *type_name;1701void**contentp;17021703/* Response */1704enum{1705 OI_CACHED,1706 OI_LOOSE,1707 OI_PACKED,1708 OI_DBCACHED1709} whence;1710union{1711/*1712 * struct {1713 * ... Nothing to expose in this case1714 * } cached;1715 * struct {1716 * ... Nothing to expose in this case1717 * } loose;1718 */1719struct{1720struct packed_git *pack;1721 off_t offset;1722unsigned int is_delta;1723} packed;1724} u;1725};17261727/*1728 * Initializer for a "struct object_info" that wants no items. You may1729 * also memset() the memory to all-zeroes.1730 */1731#define OBJECT_INFO_INIT {NULL}17321733/* Invoke lookup_replace_object() on the given hash */1734#define OBJECT_INFO_LOOKUP_REPLACE 11735/* Allow reading from a loose object file of unknown/bogus type */1736#define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 21737/* Do not check cached storage */1738#define OBJECT_INFO_SKIP_CACHED 41739/* Do not retry packed storage after checking packed and loose storage */1740#define OBJECT_INFO_QUICK 81741/* Do not check loose object */1742#define OBJECT_INFO_IGNORE_LOOSE 1617431744intoid_object_info_extended(struct repository *r,1745const struct object_id *,1746struct object_info *,unsigned flags);17471748/*1749 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing1750 * blobs. This has a difference only if extensions.partialClone is set.1751 *1752 * Its default value is 1.1753 */1754externint fetch_if_missing;17551756/* Dumb servers support */1757externintupdate_server_info(int);17581759externconst char*get_log_output_encoding(void);1760externconst char*get_commit_output_encoding(void);17611762/*1763 * This is a hack for test programs like test-dump-untracked-cache to1764 * ensure that they do not modify the untracked cache when reading it.1765 * Do not use it otherwise!1766 */1767externint ignore_untracked_cache_config;17681769externintcommitter_ident_sufficiently_given(void);1770externintauthor_ident_sufficiently_given(void);17711772externconst char*git_commit_encoding;1773externconst char*git_log_output_encoding;1774externconst char*git_mailmap_file;1775externconst char*git_mailmap_blob;17761777/* IO helper functions */1778externvoidmaybe_flush_or_die(FILE*,const char*);1779__attribute__((format(printf,2,3)))1780externvoidfprintf_or_die(FILE*,const char*fmt, ...);17811782#define COPY_READ_ERROR (-2)1783#define COPY_WRITE_ERROR (-3)1784externintcopy_fd(int ifd,int ofd);1785externintcopy_file(const char*dst,const char*src,int mode);1786externintcopy_file_with_time(const char*dst,const char*src,int mode);17871788externvoidwrite_or_die(int fd,const void*buf,size_t count);1789externvoidfsync_or_die(int fd,const char*);17901791extern ssize_t read_in_full(int fd,void*buf,size_t count);1792extern ssize_t write_in_full(int fd,const void*buf,size_t count);1793extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);17941795staticinline ssize_t write_str_in_full(int fd,const char*str)1796{1797returnwrite_in_full(fd, str,strlen(str));1798}17991800/**1801 * Open (and truncate) the file at path, write the contents of buf to it,1802 * and close it. Dies if any errors are encountered.1803 */1804externvoidwrite_file_buf(const char*path,const char*buf,size_t len);18051806/**1807 * Like write_file_buf(), but format the contents into a buffer first.1808 * Additionally, write_file() will append a newline if one is not already1809 * present, making it convenient to write text files:1810 *1811 * write_file(path, "counter: %d", ctr);1812 */1813__attribute__((format(printf,2,3)))1814externvoidwrite_file(const char*path,const char*fmt, ...);18151816/* pager.c */1817externvoidsetup_pager(void);1818externintpager_in_use(void);1819externint pager_use_color;1820externintterm_columns(void);1821externintdecimal_width(uintmax_t);1822externintcheck_pager_config(const char*cmd);1823externvoidprepare_pager_args(struct child_process *,const char*pager);18241825externconst char*editor_program;1826externconst char*askpass_program;1827externconst char*excludes_file;18281829/* base85 */1830intdecode_85(char*dst,const char*line,int linelen);1831voidencode_85(char*buf,const unsigned char*data,int bytes);18321833/* alloc.c */1834externvoid*alloc_blob_node(void);1835externvoid*alloc_tree_node(void);1836externvoid*alloc_commit_node(void);1837externvoid*alloc_tag_node(void);1838externvoid*alloc_object_node(void);1839externvoidalloc_report(void);1840externunsigned intalloc_commit_index(void);18411842/* pkt-line.c */1843voidpacket_trace_identity(const char*prog);18441845/* add */1846/*1847 * return 0 if success, 1 - if addition of a file failed and1848 * ADD_FILES_IGNORE_ERRORS was specified in flags1849 */1850intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);18511852/* diff.c */1853externint diff_auto_refresh_index;18541855/* match-trees.c */1856voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1857voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);18581859/*1860 * whitespace rules.1861 * used by both diff and apply1862 * last two digits are tab width1863 */1864#define WS_BLANK_AT_EOL 01001865#define WS_SPACE_BEFORE_TAB 02001866#define WS_INDENT_WITH_NON_TAB 04001867#define WS_CR_AT_EOL 010001868#define WS_BLANK_AT_EOF 020001869#define WS_TAB_IN_INDENT 040001870#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1871#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1872#define WS_TAB_WIDTH_MASK 0771873/* All WS_* -- when extended, adapt diff.c emit_symbol */1874#define WS_RULE_MASK 077771875externunsigned whitespace_rule_cfg;1876externunsignedwhitespace_rule(const char*);1877externunsignedparse_whitespace_rule(const char*);1878externunsignedws_check(const char*line,int len,unsigned ws_rule);1879externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1880externchar*whitespace_error_string(unsigned ws);1881externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1882externintws_blank_line(const char*line,int len,unsigned ws_rule);1883#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)18841885/* ls-files */1886voidoverlay_tree_on_index(struct index_state *istate,1887const char*tree_name,const char*prefix);18881889/* setup.c */1890struct startup_info {1891int have_repository;1892const char*prefix;1893};1894externstruct startup_info *startup_info;18951896/* merge.c */1897struct commit_list;1898inttry_merge_command(const char*strategy,size_t xopts_nr,1899const char**xopts,struct commit_list *common,1900const char*head_arg,struct commit_list *remotes);1901intcheckout_fast_forward(const struct object_id *from,1902const struct object_id *to,1903int overwrite_ignore);190419051906intsane_execvp(const char*file,char*const argv[]);19071908/*1909 * A struct to encapsulate the concept of whether a file has changed1910 * since we last checked it. This uses criteria similar to those used1911 * for the index.1912 */1913struct stat_validity {1914struct stat_data *sd;1915};19161917voidstat_validity_clear(struct stat_validity *sv);19181919/*1920 * Returns 1 if the path is a regular file (or a symlink to a regular1921 * file) and matches the saved stat_validity, 0 otherwise. A missing1922 * or inaccessible file is considered a match if the struct was just1923 * initialized, or if the previous update found an inaccessible file.1924 */1925intstat_validity_check(struct stat_validity *sv,const char*path);19261927/*1928 * Update the stat_validity from a file opened at descriptor fd. If1929 * the file is missing, inaccessible, or not a regular file, then1930 * future calls to stat_validity_check will match iff one of those1931 * conditions continues to be true.1932 */1933voidstat_validity_update(struct stat_validity *sv,int fd);19341935intversioncmp(const char*s1,const char*s2);1936voidsleep_millisec(int millisec);19371938/*1939 * Create a directory and (if share is nonzero) adjust its permissions1940 * according to the shared_repository setting. Only use this for1941 * directories under $GIT_DIR. Don't use it for working tree1942 * directories.1943 */1944voidsafe_create_dir(const char*dir,int share);19451946/*1947 * Should we print an ellipsis after an abbreviated SHA-1 value1948 * when doing diff-raw output or indicating a detached HEAD?1949 */1950externintprint_sha1_ellipsis(void);19511952#endif/* CACHE_H */