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/* The block size of SHA-1. */ 49#define GIT_SHA1_BLKSZ 64 50 51/* The length in bytes and in hex digits of an object name (SHA-256 value). */ 52#define GIT_SHA256_RAWSZ 32 53#define GIT_SHA256_HEXSZ (2 * GIT_SHA256_RAWSZ) 54/* The block size of SHA-256. */ 55#define GIT_SHA256_BLKSZ 64 56 57/* The length in byte and in hex digits of the largest possible hash value. */ 58#define GIT_MAX_RAWSZ GIT_SHA256_RAWSZ 59#define GIT_MAX_HEXSZ GIT_SHA256_HEXSZ 60/* The largest possible block size for any supported hash. */ 61#define GIT_MAX_BLKSZ GIT_SHA256_BLKSZ 62 63struct object_id { 64unsigned char hash[GIT_MAX_RAWSZ]; 65}; 66 67#define the_hash_algo the_repository->hash_algo 68 69#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 70#define DTYPE(de) ((de)->d_type) 71#else 72#undef DT_UNKNOWN 73#undef DT_DIR 74#undef DT_REG 75#undef DT_LNK 76#define DT_UNKNOWN 0 77#define DT_DIR 1 78#define DT_REG 2 79#define DT_LNK 3 80#define DTYPE(de) DT_UNKNOWN 81#endif 82 83/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 84#define S_IFINVALID 0030000 85 86/* 87 * A "directory link" is a link to another git directory. 88 * 89 * The value 0160000 is not normally a valid mode, and 90 * also just happens to be S_IFDIR + S_IFLNK 91 */ 92#define S_IFGITLINK 0160000 93#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 94 95/* 96 * Some mode bits are also used internally for computations. 97 * 98 * They *must* not overlap with any valid modes, and they *must* not be emitted 99 * to outside world - i.e. appear on disk or network. In other words, it's just 100 * temporary fields, which we internally use, but they have to stay in-house. 101 * 102 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 103 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 104 */ 105 106/* used internally in tree-diff */ 107#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 108 109 110/* 111 * Intensive research over the course of many years has shown that 112 * port 9418 is totally unused by anything else. Or 113 * 114 * Your search - "port 9418" - did not match any documents. 115 * 116 * as www.google.com puts it. 117 * 118 * This port has been properly assigned for git use by IANA: 119 * git (Assigned-9418) [I06-050728-0001]. 120 * 121 * git 9418/tcp git pack transfer service 122 * git 9418/udp git pack transfer service 123 * 124 * with Linus Torvalds <torvalds@osdl.org> as the point of 125 * contact. September 2005. 126 * 127 * See http://www.iana.org/assignments/port-numbers 128 */ 129#define DEFAULT_GIT_PORT 9418 130 131/* 132 * Basic data structures for the directory cache 133 */ 134 135#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 136struct cache_header { 137uint32_t hdr_signature; 138uint32_t hdr_version; 139uint32_t hdr_entries; 140}; 141 142#define INDEX_FORMAT_LB 2 143#define INDEX_FORMAT_UB 4 144 145/* 146 * The "cache_time" is just the low 32 bits of the 147 * time. It doesn't matter if it overflows - we only 148 * check it for equality in the 32 bits we save. 149 */ 150struct cache_time { 151uint32_t sec; 152uint32_t nsec; 153}; 154 155struct stat_data { 156struct cache_time sd_ctime; 157struct cache_time sd_mtime; 158unsigned int sd_dev; 159unsigned int sd_ino; 160unsigned int sd_uid; 161unsigned int sd_gid; 162unsigned int sd_size; 163}; 164 165struct cache_entry { 166struct hashmap_entry ent; 167struct stat_data ce_stat_data; 168unsigned int ce_mode; 169unsigned int ce_flags; 170unsigned int mem_pool_allocated; 171unsigned int ce_namelen; 172unsigned int index;/* for link extension */ 173struct object_id oid; 174char name[FLEX_ARRAY];/* more */ 175}; 176 177#define CE_STAGEMASK (0x3000) 178#define CE_EXTENDED (0x4000) 179#define CE_VALID (0x8000) 180#define CE_STAGESHIFT 12 181 182/* 183 * Range 0xFFFF0FFF in ce_flags is divided into 184 * two parts: in-memory flags and on-disk ones. 185 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 186 * if you want to save a new flag, add it in 187 * CE_EXTENDED_FLAGS 188 * 189 * In-memory only flags 190 */ 191#define CE_UPDATE (1 << 16) 192#define CE_REMOVE (1 << 17) 193#define CE_UPTODATE (1 << 18) 194#define CE_ADDED (1 << 19) 195 196#define CE_HASHED (1 << 20) 197#define CE_FSMONITOR_VALID (1 << 21) 198#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 199#define CE_CONFLICTED (1 << 23) 200 201#define CE_UNPACKED (1 << 24) 202#define CE_NEW_SKIP_WORKTREE (1 << 25) 203 204/* used to temporarily mark paths matched by pathspecs */ 205#define CE_MATCHED (1 << 26) 206 207#define CE_UPDATE_IN_BASE (1 << 27) 208#define CE_STRIP_NAME (1 << 28) 209 210/* 211 * Extended on-disk flags 212 */ 213#define CE_INTENT_TO_ADD (1 << 29) 214#define CE_SKIP_WORKTREE (1 << 30) 215/* CE_EXTENDED2 is for future extension */ 216#define CE_EXTENDED2 (1U << 31) 217 218#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 219 220/* 221 * Safeguard to avoid saving wrong flags: 222 * - CE_EXTENDED2 won't get saved until its semantic is known 223 * - Bits in 0x0000FFFF have been saved in ce_flags already 224 * - Bits in 0x003F0000 are currently in-memory flags 225 */ 226#if CE_EXTENDED_FLAGS & 0x803FFFFF 227#error"CE_EXTENDED_FLAGS out of range" 228#endif 229 230/* Forward structure decls */ 231struct pathspec; 232struct child_process; 233struct tree; 234 235/* 236 * Copy the sha1 and stat state of a cache entry from one to 237 * another. But we never change the name, or the hash state! 238 */ 239staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 240const struct cache_entry *src) 241{ 242unsigned int state = dst->ce_flags & CE_HASHED; 243int mem_pool_allocated = dst->mem_pool_allocated; 244 245/* Don't copy hash chain and name */ 246memcpy(&dst->ce_stat_data, &src->ce_stat_data, 247offsetof(struct cache_entry, name) - 248offsetof(struct cache_entry, ce_stat_data)); 249 250/* Restore the hash state */ 251 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 252 253/* Restore the mem_pool_allocated flag */ 254 dst->mem_pool_allocated = mem_pool_allocated; 255} 256 257staticinlineunsignedcreate_ce_flags(unsigned stage) 258{ 259return(stage << CE_STAGESHIFT); 260} 261 262#define ce_namelen(ce) ((ce)->ce_namelen) 263#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 264#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 265#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 266#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 267#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 268#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 269 270#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 271staticinlineunsigned intcreate_ce_mode(unsigned int mode) 272{ 273if(S_ISLNK(mode)) 274return S_IFLNK; 275if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 276return S_IFGITLINK; 277return S_IFREG |ce_permissions(mode); 278} 279staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 280unsigned int mode) 281{ 282externint trust_executable_bit, has_symlinks; 283if(!has_symlinks &&S_ISREG(mode) && 284 ce &&S_ISLNK(ce->ce_mode)) 285return ce->ce_mode; 286if(!trust_executable_bit &&S_ISREG(mode)) { 287if(ce &&S_ISREG(ce->ce_mode)) 288return ce->ce_mode; 289returncreate_ce_mode(0666); 290} 291returncreate_ce_mode(mode); 292} 293staticinlineintce_to_dtype(const struct cache_entry *ce) 294{ 295unsigned ce_mode =ntohl(ce->ce_mode); 296if(S_ISREG(ce_mode)) 297return DT_REG; 298else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 299return DT_DIR; 300else if(S_ISLNK(ce_mode)) 301return DT_LNK; 302else 303return DT_UNKNOWN; 304} 305staticinlineunsigned intcanon_mode(unsigned int mode) 306{ 307if(S_ISREG(mode)) 308return S_IFREG |ce_permissions(mode); 309if(S_ISLNK(mode)) 310return S_IFLNK; 311if(S_ISDIR(mode)) 312return S_IFDIR; 313return S_IFGITLINK; 314} 315 316#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 317 318#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 319#define CE_ENTRY_CHANGED (1 << 1) 320#define CE_ENTRY_REMOVED (1 << 2) 321#define CE_ENTRY_ADDED (1 << 3) 322#define RESOLVE_UNDO_CHANGED (1 << 4) 323#define CACHE_TREE_CHANGED (1 << 5) 324#define SPLIT_INDEX_ORDERED (1 << 6) 325#define UNTRACKED_CHANGED (1 << 7) 326#define FSMONITOR_CHANGED (1 << 8) 327 328struct split_index; 329struct untracked_cache; 330 331struct index_state { 332struct cache_entry **cache; 333unsigned int version; 334unsigned int cache_nr, cache_alloc, cache_changed; 335struct string_list *resolve_undo; 336struct cache_tree *cache_tree; 337struct split_index *split_index; 338struct cache_time timestamp; 339unsigned name_hash_initialized :1, 340 initialized :1, 341 drop_cache_tree :1; 342struct hashmap name_hash; 343struct hashmap dir_hash; 344struct object_id oid; 345struct untracked_cache *untracked; 346uint64_t fsmonitor_last_update; 347struct ewah_bitmap *fsmonitor_dirty; 348struct mem_pool *ce_mem_pool; 349}; 350 351externstruct index_state the_index; 352 353/* Name hashing */ 354externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 355externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 356externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 357externvoidfree_name_hash(struct index_state *istate); 358 359 360/* Cache entry creation and cleanup */ 361 362/* 363 * Create cache_entry intended for use in the specified index. Caller 364 * is responsible for discarding the cache_entry with 365 * `discard_cache_entry`. 366 */ 367struct cache_entry *make_cache_entry(struct index_state *istate, 368unsigned int mode, 369const struct object_id *oid, 370const char*path, 371int stage, 372unsigned int refresh_options); 373 374struct cache_entry *make_empty_cache_entry(struct index_state *istate, 375size_t name_len); 376 377/* 378 * Create a cache_entry that is not intended to be added to an index. 379 * Caller is responsible for discarding the cache_entry 380 * with `discard_cache_entry`. 381 */ 382struct cache_entry *make_transient_cache_entry(unsigned int mode, 383const struct object_id *oid, 384const char*path, 385int stage); 386 387struct cache_entry *make_empty_transient_cache_entry(size_t name_len); 388 389/* 390 * Discard cache entry. 391 */ 392voiddiscard_cache_entry(struct cache_entry *ce); 393 394/* 395 * Check configuration if we should perform extra validation on cache 396 * entries. 397 */ 398intshould_validate_cache_entries(void); 399 400/* 401 * Duplicate a cache_entry. Allocate memory for the new entry from a 402 * memory_pool. Takes into account cache_entry fields that are meant 403 * for managing the underlying memory allocation of the cache_entry. 404 */ 405struct cache_entry *dup_cache_entry(const struct cache_entry *ce,struct index_state *istate); 406 407/* 408 * Validate the cache entries in the index. This is an internal 409 * consistency check that the cache_entry structs are allocated from 410 * the expected memory pool. 411 */ 412voidvalidate_cache_entries(const struct index_state *istate); 413 414#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 415#define active_cache (the_index.cache) 416#define active_nr (the_index.cache_nr) 417#define active_alloc (the_index.cache_alloc) 418#define active_cache_changed (the_index.cache_changed) 419#define active_cache_tree (the_index.cache_tree) 420 421#define read_cache() read_index(&the_index) 422#define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir())) 423#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec), 0) 424#define is_cache_unborn() is_index_unborn(&the_index) 425#define read_cache_unmerged() read_index_unmerged(&the_index) 426#define discard_cache() discard_index(&the_index) 427#define unmerged_cache() unmerged_index(&the_index) 428#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 429#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 430#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 431#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 432#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 433#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 434#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 435#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 436#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 437#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 438#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 439#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 440#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 441#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 442#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 443#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 444#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 445#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 446#endif 447 448#define TYPE_BITS 3 449 450/* 451 * Values in this enum (except those outside the 3 bit range) are part 452 * of pack file format. See Documentation/technical/pack-format.txt 453 * for more information. 454 */ 455enum object_type { 456 OBJ_BAD = -1, 457 OBJ_NONE =0, 458 OBJ_COMMIT =1, 459 OBJ_TREE =2, 460 OBJ_BLOB =3, 461 OBJ_TAG =4, 462/* 5 for future expansion */ 463 OBJ_OFS_DELTA =6, 464 OBJ_REF_DELTA =7, 465 OBJ_ANY, 466 OBJ_MAX 467}; 468 469staticinlineenum object_type object_type(unsigned int mode) 470{ 471returnS_ISDIR(mode) ? OBJ_TREE : 472S_ISGITLINK(mode) ? OBJ_COMMIT : 473 OBJ_BLOB; 474} 475 476/* Double-check local_repo_env below if you add to this list. */ 477#define GIT_DIR_ENVIRONMENT"GIT_DIR" 478#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 479#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 480#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 481#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 482#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 483#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 484#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 485#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 486#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 487#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 488#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 489#define CONFIG_ENVIRONMENT"GIT_CONFIG" 490#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 491#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 492#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 493#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 494#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 495#define GITATTRIBUTES_FILE".gitattributes" 496#define INFOATTRIBUTES_FILE"info/attributes" 497#define ATTRIBUTE_MACRO_PREFIX"[attr]" 498#define GITMODULES_FILE".gitmodules" 499#define GITMODULES_INDEX":.gitmodules" 500#define GITMODULES_HEAD"HEAD:.gitmodules" 501#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 502#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 503#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 504#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 505#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 506#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 507#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 508#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 509#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 510#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 511#define GIT_OPTIONAL_LOCKS_ENVIRONMENT"GIT_OPTIONAL_LOCKS" 512#define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT"GIT_TEXTDOMAINDIR" 513 514/* 515 * Environment variable used in handshaking the wire protocol. 516 * Contains a colon ':' separated list of keys with optional values 517 * 'key[=value]'. Presence of unknown keys and values must be 518 * ignored. 519 */ 520#define GIT_PROTOCOL_ENVIRONMENT"GIT_PROTOCOL" 521/* HTTP header used to handshake the wire protocol */ 522#define GIT_PROTOCOL_HEADER"Git-Protocol" 523 524/* 525 * This environment variable is expected to contain a boolean indicating 526 * whether we should or should not treat: 527 * 528 * GIT_DIR=foo.git git ... 529 * 530 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 531 * of this, but we use it internally to communicate to sub-processes that we 532 * are in a bare repo. If not set, defaults to true. 533 */ 534#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 535 536/* 537 * Repository-local GIT_* environment variables; these will be cleared 538 * when git spawns a sub-process that runs inside another repository. 539 * The array is NULL-terminated, which makes it easy to pass in the "env" 540 * parameter of a run-command invocation, or to do a simple walk. 541 */ 542externconst char*const local_repo_env[]; 543 544externvoidsetup_git_env(const char*git_dir); 545 546/* 547 * Returns true iff we have a configured git repository (either via 548 * setup_git_directory, or in the environment via $GIT_DIR). 549 */ 550inthave_git_dir(void); 551 552externint is_bare_repository_cfg; 553externintis_bare_repository(void); 554externintis_inside_git_dir(void); 555externchar*git_work_tree_cfg; 556externintis_inside_work_tree(void); 557externconst char*get_git_dir(void); 558externconst char*get_git_common_dir(void); 559externchar*get_object_directory(void); 560externchar*get_index_file(void); 561externchar*get_graft_file(struct repository *r); 562externvoidset_git_dir(const char*path); 563externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 564externintget_common_dir(struct strbuf *sb,const char*gitdir); 565externconst char*get_git_namespace(void); 566externconst char*strip_namespace(const char*namespaced_ref); 567externconst char*get_super_prefix(void); 568externconst char*get_git_work_tree(void); 569 570/* 571 * Return true if the given path is a git directory; note that this _just_ 572 * looks at the directory itself. If you want to know whether "foo/.git" 573 * is a repository, you must feed that path, not just "foo". 574 */ 575externintis_git_directory(const char*path); 576 577/* 578 * Return 1 if the given path is the root of a git repository or 579 * submodule, else 0. Will not return 1 for bare repositories with the 580 * exception of creating a bare repository in "foo/.git" and calling 581 * is_git_repository("foo"). 582 * 583 * If we run into read errors, we err on the side of saying "yes, it is", 584 * as we usually consider sub-repos precious, and would prefer to err on the 585 * side of not disrupting or deleting them. 586 */ 587externintis_nonbare_repository_dir(struct strbuf *path); 588 589#define READ_GITFILE_ERR_STAT_FAILED 1 590#define READ_GITFILE_ERR_NOT_A_FILE 2 591#define READ_GITFILE_ERR_OPEN_FAILED 3 592#define READ_GITFILE_ERR_READ_FAILED 4 593#define READ_GITFILE_ERR_INVALID_FORMAT 5 594#define READ_GITFILE_ERR_NO_PATH 6 595#define READ_GITFILE_ERR_NOT_A_REPO 7 596#define READ_GITFILE_ERR_TOO_LARGE 8 597externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 598externconst char*read_gitfile_gently(const char*path,int*return_error_code); 599#define read_gitfile(path) read_gitfile_gently((path), NULL) 600externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 601#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 602 603externvoidset_git_work_tree(const char*tree); 604 605#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 606 607externvoidsetup_work_tree(void); 608/* 609 * Find the commondir and gitdir of the repository that contains the current 610 * working directory, without changing the working directory or other global 611 * state. The result is appended to commondir and gitdir. If the discovered 612 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 613 * both have the same result appended to the buffer. The return value is 614 * either 0 upon success and non-zero if no repository was found. 615 */ 616externintdiscover_git_directory(struct strbuf *commondir, 617struct strbuf *gitdir); 618externconst char*setup_git_directory_gently(int*); 619externconst char*setup_git_directory(void); 620externchar*prefix_path(const char*prefix,int len,const char*path); 621externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 622 623/* 624 * Concatenate "prefix" (if len is non-zero) and "path", with no 625 * connecting characters (so "prefix" should end with a "/"). 626 * Unlike prefix_path, this should be used if the named file does 627 * not have to interact with index entry; i.e. name of a random file 628 * on the filesystem. 629 * 630 * The return value is always a newly allocated string (even if the 631 * prefix was empty). 632 */ 633externchar*prefix_filename(const char*prefix,const char*path); 634 635externintcheck_filename(const char*prefix,const char*name); 636externvoidverify_filename(const char*prefix, 637const char*name, 638int diagnose_misspelt_rev); 639externvoidverify_non_filename(const char*prefix,const char*name); 640externintpath_inside_repo(const char*prefix,const char*path); 641 642#define INIT_DB_QUIET 0x0001 643#define INIT_DB_EXIST_OK 0x0002 644 645externintinit_db(const char*git_dir,const char*real_git_dir, 646const char*template_dir,unsigned int flags); 647 648externvoidsanitize_stdfds(void); 649externintdaemonize(void); 650 651#define alloc_nr(x) (((x)+16)*3/2) 652 653/* 654 * Realloc the buffer pointed at by variable 'x' so that it can hold 655 * at least 'nr' entries; the number of entries currently allocated 656 * is 'alloc', using the standard growing factor alloc_nr() macro. 657 * 658 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 659 */ 660#define ALLOC_GROW(x, nr, alloc) \ 661 do { \ 662 if ((nr) > alloc) { \ 663 if (alloc_nr(alloc) < (nr)) \ 664 alloc = (nr); \ 665 else \ 666 alloc = alloc_nr(alloc); \ 667 REALLOC_ARRAY(x, alloc); \ 668 } \ 669 } while (0) 670 671/* Initialize and use the cache information */ 672struct lock_file; 673externintread_index(struct index_state *); 674externvoidpreload_index(struct index_state *index, 675const struct pathspec *pathspec, 676unsigned int refresh_flags); 677externintread_index_preload(struct index_state *, 678const struct pathspec *pathspec, 679unsigned int refresh_flags); 680externintdo_read_index(struct index_state *istate,const char*path, 681int must_exist);/* for testting only! */ 682externintread_index_from(struct index_state *,const char*path, 683const char*gitdir); 684externintis_index_unborn(struct index_state *); 685externintread_index_unmerged(struct index_state *); 686 687/* For use with `write_locked_index()`. */ 688#define COMMIT_LOCK (1 << 0) 689#define SKIP_IF_UNCHANGED (1 << 1) 690 691/* 692 * Write the index while holding an already-taken lock. Close the lock, 693 * and if `COMMIT_LOCK` is given, commit it. 694 * 695 * Unless a split index is in use, write the index into the lockfile. 696 * 697 * With a split index, write the shared index to a temporary file, 698 * adjust its permissions and rename it into place, then write the 699 * split index to the lockfile. If the temporary file for the shared 700 * index cannot be created, fall back to the behavior described in 701 * the previous paragraph. 702 * 703 * With `COMMIT_LOCK`, the lock is always committed or rolled back. 704 * Without it, the lock is closed, but neither committed nor rolled 705 * back. 706 * 707 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing 708 * is written (and the lock is rolled back if `COMMIT_LOCK` is given). 709 */ 710externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 711 712externintdiscard_index(struct index_state *); 713externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 714externintunmerged_index(const struct index_state *); 715 716/** 717 * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL, 718 * compares istate to HEAD. If tree is NULL and on an unborn branch, 719 * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is 720 * provided, the space-separated list of files that differ will be appended 721 * to it. 722 */ 723externintindex_has_changes(struct index_state *istate, 724struct tree *tree, 725struct strbuf *sb); 726 727externintverify_path(const char*path,unsigned mode); 728externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 729externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 730externvoidadjust_dirname_case(struct index_state *istate,char*name); 731externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 732 733/* 734 * Searches for an entry defined by name and namelen in the given index. 735 * If the return value is positive (including 0) it is the position of an 736 * exact match. If the return value is negative, the negated value minus 1 737 * is the position where the entry would be inserted. 738 * Example: The current index consists of these files and its stages: 739 * 740 * b#0, d#0, f#1, f#3 741 * 742 * index_name_pos(&index, "a", 1) -> -1 743 * index_name_pos(&index, "b", 1) -> 0 744 * index_name_pos(&index, "c", 1) -> -2 745 * index_name_pos(&index, "d", 1) -> 1 746 * index_name_pos(&index, "e", 1) -> -3 747 * index_name_pos(&index, "f", 1) -> -3 748 * index_name_pos(&index, "g", 1) -> -5 749 */ 750externintindex_name_pos(const struct index_state *,const char*name,int namelen); 751 752#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 753#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 754#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 755#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 756#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 757#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 758#define ADD_CACHE_RENORMALIZE 64/* Pass along HASH_RENORMALIZE */ 759externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 760externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 761 762/* Remove entry, return true if there are more entries to go. */ 763externintremove_index_entry_at(struct index_state *,int pos); 764 765externvoidremove_marked_cache_entries(struct index_state *istate); 766externintremove_file_from_index(struct index_state *,const char*path); 767#define ADD_CACHE_VERBOSE 1 768#define ADD_CACHE_PRETEND 2 769#define ADD_CACHE_IGNORE_ERRORS 4 770#define ADD_CACHE_IGNORE_REMOVAL 8 771#define ADD_CACHE_INTENT 16 772/* 773 * These two are used to add the contents of the file at path 774 * to the index, marking the working tree up-to-date by storing 775 * the cached stat info in the resulting cache entry. A caller 776 * that has already run lstat(2) on the path can call 777 * add_to_index(), and all others can call add_file_to_index(); 778 * the latter will do necessary lstat(2) internally before 779 * calling the former. 780 */ 781externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 782externintadd_file_to_index(struct index_state *,const char*path,int flags); 783 784externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 785externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 786externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 787externintindex_name_is_other(const struct index_state *,const char*,int); 788externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 789 790/* do stat comparison even if CE_VALID is true */ 791#define CE_MATCH_IGNORE_VALID 01 792/* do not check the contents but report dirty on racily-clean entries */ 793#define CE_MATCH_RACY_IS_DIRTY 02 794/* do stat comparison even if CE_SKIP_WORKTREE is true */ 795#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 796/* ignore non-existent files during stat update */ 797#define CE_MATCH_IGNORE_MISSING 0x08 798/* enable stat refresh */ 799#define CE_MATCH_REFRESH 0x10 800/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */ 801#define CE_MATCH_IGNORE_FSMONITOR 0X20 802externintis_racy_timestamp(const struct index_state *istate, 803const struct cache_entry *ce); 804externintie_match_stat(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 805externintie_modified(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 806 807#define HASH_WRITE_OBJECT 1 808#define HASH_FORMAT_CHECK 2 809#define HASH_RENORMALIZE 4 810externintindex_fd(struct index_state *istate,struct object_id *oid,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 811externintindex_path(struct index_state *istate,struct object_id *oid,const char*path,struct stat *st,unsigned flags); 812 813/* 814 * Record to sd the data from st that we use to check whether a file 815 * might have changed. 816 */ 817externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 818 819/* 820 * Return 0 if st is consistent with a file not having been changed 821 * since sd was filled. If there are differences, return a 822 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 823 * INODE_CHANGED, and DATA_CHANGED. 824 */ 825externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 826externintmatch_stat_data_racy(const struct index_state *istate, 827const struct stat_data *sd,struct stat *st); 828 829externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 830 831#define REFRESH_REALLY 0x0001/* ignore_valid */ 832#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 833#define REFRESH_QUIET 0x0004/* be quiet about it */ 834#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 835#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 836#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 837#define REFRESH_PROGRESS 0x0040/* show progress bar if stderr is tty */ 838externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 839externstruct cache_entry *refresh_cache_entry(struct index_state *,struct cache_entry *,unsigned int); 840 841/* 842 * Opportunistically update the index but do not complain if we can't. 843 * The lockfile is always committed or rolled back. 844 */ 845externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 846 847externinthold_locked_index(struct lock_file *,int); 848externvoidset_alternate_index_output(const char*); 849 850externint verify_index_checksum; 851externint verify_ce_order; 852 853/* Environment bits from configuration mechanism */ 854externint trust_executable_bit; 855externint trust_ctime; 856externint check_stat; 857externint quote_path_fully; 858externint has_symlinks; 859externint minimum_abbrev, default_abbrev; 860externint ignore_case; 861externint assume_unchanged; 862externint prefer_symlink_refs; 863externint warn_ambiguous_refs; 864externint warn_on_object_refname_ambiguity; 865externconst char*apply_default_whitespace; 866externconst char*apply_default_ignorewhitespace; 867externconst char*git_attributes_file; 868externconst char*git_hooks_path; 869externint zlib_compression_level; 870externint core_compression_level; 871externint pack_compression_level; 872externsize_t packed_git_window_size; 873externsize_t packed_git_limit; 874externsize_t delta_base_cache_limit; 875externunsigned long big_file_threshold; 876externunsigned long pack_size_limit_cfg; 877 878/* 879 * Accessors for the core.sharedrepository config which lazy-load the value 880 * from the config (if not already set). The "reset" function can be 881 * used to unset "set" or cached value, meaning that the value will be loaded 882 * fresh from the config file on the next call to get_shared_repository(). 883 */ 884voidset_shared_repository(int value); 885intget_shared_repository(void); 886voidreset_shared_repository(void); 887 888/* 889 * Do replace refs need to be checked this run? This variable is 890 * initialized to true unless --no-replace-object is used or 891 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 892 * commands that do not want replace references to be active. 893 */ 894externint read_replace_refs; 895externchar*git_replace_ref_base; 896 897externint fsync_object_files; 898externint core_preload_index; 899externint core_apply_sparse_checkout; 900externint precomposed_unicode; 901externint protect_hfs; 902externint protect_ntfs; 903externconst char*core_fsmonitor; 904 905/* 906 * Include broken refs in all ref iterations, which will 907 * generally choke dangerous operations rather than letting 908 * them silently proceed without taking the broken ref into 909 * account. 910 */ 911externint ref_paranoia; 912 913/* 914 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value). 915 */ 916intuse_optional_locks(void); 917 918/* 919 * The character that begins a commented line in user-editable file 920 * that is subject to stripspace. 921 */ 922externchar comment_line_char; 923externint auto_comment_line_char; 924 925enum log_refs_config { 926 LOG_REFS_UNSET = -1, 927 LOG_REFS_NONE =0, 928 LOG_REFS_NORMAL, 929 LOG_REFS_ALWAYS 930}; 931externenum log_refs_config log_all_ref_updates; 932 933enum rebase_setup_type { 934 AUTOREBASE_NEVER =0, 935 AUTOREBASE_LOCAL, 936 AUTOREBASE_REMOTE, 937 AUTOREBASE_ALWAYS 938}; 939 940enum push_default_type { 941 PUSH_DEFAULT_NOTHING =0, 942 PUSH_DEFAULT_MATCHING, 943 PUSH_DEFAULT_SIMPLE, 944 PUSH_DEFAULT_UPSTREAM, 945 PUSH_DEFAULT_CURRENT, 946 PUSH_DEFAULT_UNSPECIFIED 947}; 948 949externenum rebase_setup_type autorebase; 950externenum push_default_type push_default; 951 952enum object_creation_mode { 953 OBJECT_CREATION_USES_HARDLINKS =0, 954 OBJECT_CREATION_USES_RENAMES =1 955}; 956 957externenum object_creation_mode object_creation_mode; 958 959externchar*notes_ref_name; 960 961externint grafts_replace_parents; 962 963/* 964 * GIT_REPO_VERSION is the version we write by default. The 965 * _READ variant is the highest number we know how to 966 * handle. 967 */ 968#define GIT_REPO_VERSION 0 969#define GIT_REPO_VERSION_READ 1 970externint repository_format_precious_objects; 971externchar*repository_format_partial_clone; 972externconst char*core_partial_clone_filter_default; 973externint repository_format_worktree_config; 974 975struct repository_format { 976int version; 977int precious_objects; 978char*partial_clone;/* value of extensions.partialclone */ 979int worktree_config; 980int is_bare; 981int hash_algo; 982char*work_tree; 983struct string_list unknown_extensions; 984}; 985 986/* 987 * Read the repository format characteristics from the config file "path" into 988 * "format" struct. Returns the numeric version. On error, -1 is returned, 989 * format->version is set to -1, and all other fields in the struct are 990 * undefined. 991 */ 992intread_repository_format(struct repository_format *format,const char*path); 993 994/* 995 * Verify that the repository described by repository_format is something we 996 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 997 * any errors encountered. 998 */ 999intverify_repository_format(const struct repository_format *format,1000struct strbuf *err);10011002/*1003 * Check the repository format version in the path found in get_git_dir(),1004 * and die if it is a version we don't understand. Generally one would1005 * set_git_dir() before calling this, and use it only for "are we in a valid1006 * repo?".1007 */1008externvoidcheck_repository_format(void);10091010#define MTIME_CHANGED 0x00011011#define CTIME_CHANGED 0x00021012#define OWNER_CHANGED 0x00041013#define MODE_CHANGED 0x00081014#define INODE_CHANGED 0x00101015#define DATA_CHANGED 0x00201016#define TYPE_CHANGED 0x004010171018/*1019 * Return an abbreviated sha1 unique within this repository's object database.1020 * The result will be at least `len` characters long, and will be NUL1021 * terminated.1022 *1023 * The non-`_r` version returns a static buffer which remains valid until 41024 * more calls to find_unique_abbrev are made.1025 *1026 * The `_r` variant writes to a buffer supplied by the caller, which must be at1027 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes1028 * written (excluding the NUL terminator).1029 *1030 * Note that while this version avoids the static buffer, it is not fully1031 * reentrant, as it calls into other non-reentrant git code.1032 */1033externconst char*find_unique_abbrev(const struct object_id *oid,int len);1034externintfind_unique_abbrev_r(char*hex,const struct object_id *oid,int len);10351036externconst unsigned char null_sha1[GIT_MAX_RAWSZ];1037externconst struct object_id null_oid;10381039staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2)1040{1041/*1042 * Teach the compiler that there are only two possibilities of hash size1043 * here, so that it can optimize for this case as much as possible.1044 */1045if(the_hash_algo->rawsz == GIT_MAX_RAWSZ)1046returnmemcmp(sha1, sha2, GIT_MAX_RAWSZ);1047returnmemcmp(sha1, sha2, GIT_SHA1_RAWSZ);1048}10491050staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2)1051{1052returnhashcmp(oid1->hash, oid2->hash);1053}10541055staticinlineinthasheq(const unsigned char*sha1,const unsigned char*sha2)1056{1057/*1058 * We write this here instead of deferring to hashcmp so that the1059 * compiler can properly inline it and avoid calling memcmp.1060 */1061if(the_hash_algo->rawsz == GIT_MAX_RAWSZ)1062return!memcmp(sha1, sha2, GIT_MAX_RAWSZ);1063return!memcmp(sha1, sha2, GIT_SHA1_RAWSZ);1064}10651066staticinlineintoideq(const struct object_id *oid1,const struct object_id *oid2)1067{1068returnhasheq(oid1->hash, oid2->hash);1069}10701071staticinlineintis_null_sha1(const unsigned char*sha1)1072{1073returnhasheq(sha1, null_sha1);1074}10751076staticinlineintis_null_oid(const struct object_id *oid)1077{1078returnhasheq(oid->hash, null_sha1);1079}10801081staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src)1082{1083memcpy(sha_dst, sha_src, the_hash_algo->rawsz);1084}10851086staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src)1087{1088memcpy(dst->hash, src->hash, GIT_MAX_RAWSZ);1089}10901091staticinlinestruct object_id *oiddup(const struct object_id *src)1092{1093struct object_id *dst =xmalloc(sizeof(struct object_id));1094oidcpy(dst, src);1095return dst;1096}10971098staticinlinevoidhashclr(unsigned char*hash)1099{1100memset(hash,0, the_hash_algo->rawsz);1101}11021103staticinlinevoidoidclr(struct object_id *oid)1104{1105memset(oid->hash,0, GIT_MAX_RAWSZ);1106}11071108staticinlinevoidoidread(struct object_id *oid,const unsigned char*hash)1109{1110memcpy(oid->hash, hash, the_hash_algo->rawsz);1111}11121113staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1114{1115returnhasheq(sha1, the_hash_algo->empty_blob->hash);1116}11171118staticinlineintis_empty_blob_oid(const struct object_id *oid)1119{1120returnoideq(oid, the_hash_algo->empty_blob);1121}11221123staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1124{1125returnhasheq(sha1, the_hash_algo->empty_tree->hash);1126}11271128staticinlineintis_empty_tree_oid(const struct object_id *oid)1129{1130returnoideq(oid, the_hash_algo->empty_tree);1131}11321133const char*empty_tree_oid_hex(void);1134const char*empty_blob_oid_hex(void);11351136/* set default permissions by passing mode arguments to open(2) */1137intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1138intgit_mkstemp_mode(char*pattern,int mode);11391140/*1141 * NOTE NOTE NOTE!!1142 *1143 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1144 * not be changed. Old repositories have core.sharedrepository written in1145 * numeric format, and therefore these values are preserved for compatibility1146 * reasons.1147 */1148enum sharedrepo {1149 PERM_UMASK =0,1150 OLD_PERM_GROUP =1,1151 OLD_PERM_EVERYBODY =2,1152 PERM_GROUP =0660,1153 PERM_EVERYBODY =06641154};1155intgit_config_perm(const char*var,const char*value);1156intadjust_shared_perm(const char*path);11571158/*1159 * Create the directory containing the named path, using care to be1160 * somewhat safe against races. Return one of the scld_error values to1161 * indicate success/failure. On error, set errno to describe the1162 * problem.1163 *1164 * SCLD_VANISHED indicates that one of the ancestor directories of the1165 * path existed at one point during the function call and then1166 * suddenly vanished, probably because another process pruned the1167 * directory while we were working. To be robust against this kind of1168 * race, callers might want to try invoking the function again when it1169 * returns SCLD_VANISHED.1170 *1171 * safe_create_leading_directories() temporarily changes path while it1172 * is working but restores it before returning.1173 * safe_create_leading_directories_const() doesn't modify path, even1174 * temporarily.1175 */1176enum scld_error {1177 SCLD_OK =0,1178 SCLD_FAILED = -1,1179 SCLD_PERMS = -2,1180 SCLD_EXISTS = -3,1181 SCLD_VANISHED = -41182};1183enum scld_error safe_create_leading_directories(char*path);1184enum scld_error safe_create_leading_directories_const(const char*path);11851186/*1187 * Callback function for raceproof_create_file(). This function is1188 * expected to do something that makes dirname(path) permanent despite1189 * the fact that other processes might be cleaning up empty1190 * directories at the same time. Usually it will create a file named1191 * path, but alternatively it could create another file in that1192 * directory, or even chdir() into that directory. The function should1193 * return 0 if the action was completed successfully. On error, it1194 * should return a nonzero result and set errno.1195 * raceproof_create_file() treats two errno values specially:1196 *1197 * - ENOENT -- dirname(path) does not exist. In this case,1198 * raceproof_create_file() tries creating dirname(path)1199 * (and any parent directories, if necessary) and calls1200 * the function again.1201 *1202 * - EISDIR -- the file already exists and is a directory. In this1203 * case, raceproof_create_file() removes the directory if1204 * it is empty (and recursively any empty directories that1205 * it contains) and calls the function again.1206 *1207 * Any other errno causes raceproof_create_file() to fail with the1208 * callback's return value and errno.1209 *1210 * Obviously, this function should be OK with being called again if it1211 * fails with ENOENT or EISDIR. In other scenarios it will not be1212 * called again.1213 */1214typedefintcreate_file_fn(const char*path,void*cb);12151216/*1217 * Create a file in dirname(path) by calling fn, creating leading1218 * directories if necessary. Retry a few times in case we are racing1219 * with another process that is trying to clean up the directory that1220 * contains path. See the documentation for create_file_fn for more1221 * details.1222 *1223 * Return the value and set the errno that resulted from the most1224 * recent call of fn. fn is always called at least once, and will be1225 * called more than once if it returns ENOENT or EISDIR.1226 */1227intraceproof_create_file(const char*path, create_file_fn fn,void*cb);12281229intmkdir_in_gitdir(const char*path);1230externchar*expand_user_path(const char*path,int real_home);1231const char*enter_repo(const char*path,int strict);1232staticinlineintis_absolute_path(const char*path)1233{1234returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1235}1236intis_directory(const char*);1237char*strbuf_realpath(struct strbuf *resolved,const char*path,1238int die_on_error);1239const char*real_path(const char*path);1240const char*real_path_if_valid(const char*path);1241char*real_pathdup(const char*path,int die_on_error);1242const char*absolute_path(const char*path);1243char*absolute_pathdup(const char*path);1244const char*remove_leading_path(const char*in,const char*prefix);1245const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1246intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1247intnormalize_path_copy(char*dst,const char*src);1248intlongest_ancestor_length(const char*path,struct string_list *prefixes);1249char*strip_path_suffix(const char*path,const char*suffix);1250intdaemon_avoid_alias(const char*path);12511252/*1253 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for1254 * details.1255 */1256intis_ntfs_dotgit(const char*name);1257intis_ntfs_dotgitmodules(const char*name);1258intis_ntfs_dotgitignore(const char*name);1259intis_ntfs_dotgitattributes(const char*name);12601261/*1262 * Returns true iff "str" could be confused as a command-line option when1263 * passed to a sub-program like "ssh". Note that this has nothing to do with1264 * shell-quoting, which should be handled separately; we're assuming here that1265 * the string makes it verbatim to the sub-program.1266 */1267intlooks_like_command_line_option(const char*str);12681269/**1270 * Return a newly allocated string with the evaluation of1271 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1272 * "$HOME/.config/git/$filename". Return NULL upon error.1273 */1274externchar*xdg_config_home(const char*filename);12751276/**1277 * Return a newly allocated string with the evaluation of1278 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1279 * "$HOME/.cache/git/$filename". Return NULL upon error.1280 */1281externchar*xdg_cache_home(const char*filename);12821283externintgit_open_cloexec(const char*name,int flags);1284#define git_open(name) git_open_cloexec(name, O_RDONLY)1285externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1286externintparse_sha1_header(const char*hdr,unsigned long*sizep);12871288externintcheck_object_signature(const struct object_id *oid,void*buf,unsigned long size,const char*type);12891290externintfinalize_object_file(const char*tmpfile,const char*filename);12911292/* Helper to check and "touch" a file */1293externintcheck_and_freshen_file(const char*fn,int freshen);12941295externconst signed char hexval_table[256];1296staticinlineunsigned inthexval(unsigned char c)1297{1298return hexval_table[c];1299}13001301/*1302 * Convert two consecutive hexadecimal digits into a char. Return a1303 * negative value on error. Don't run over the end of short strings.1304 */1305staticinlineinthex2chr(const char*s)1306{1307unsigned int val =hexval(s[0]);1308return(val & ~0xf) ? val : (val <<4) |hexval(s[1]);1309}13101311/* Convert to/from hex/sha1 representation */1312#define MINIMUM_ABBREV minimum_abbrev1313#define DEFAULT_ABBREV default_abbrev13141315/* used when the code does not know or care what the default abbrev is */1316#define FALLBACK_DEFAULT_ABBREV 713171318struct object_context {1319unsigned mode;1320/*1321 * symlink_path is only used by get_tree_entry_follow_symlinks,1322 * and only for symlinks that point outside the repository.1323 */1324struct strbuf symlink_path;1325/*1326 * If GET_OID_RECORD_PATH is set, this will record path (if any)1327 * found when resolving the name. The caller is responsible for1328 * releasing the memory.1329 */1330char*path;1331};13321333#define GET_OID_QUIETLY 011334#define GET_OID_COMMIT 021335#define GET_OID_COMMITTISH 041336#define GET_OID_TREE 0101337#define GET_OID_TREEISH 0201338#define GET_OID_BLOB 0401339#define GET_OID_FOLLOW_SYMLINKS 01001340#define GET_OID_RECORD_PATH 02001341#define GET_OID_ONLY_TO_DIE 0400013421343#define GET_OID_DISAMBIGUATORS \1344 (GET_OID_COMMIT | GET_OID_COMMITTISH | \1345 GET_OID_TREE | GET_OID_TREEISH | \1346 GET_OID_BLOB)13471348externintget_oid(const char*str,struct object_id *oid);1349externintget_oid_commit(const char*str,struct object_id *oid);1350externintget_oid_committish(const char*str,struct object_id *oid);1351externintget_oid_tree(const char*str,struct object_id *oid);1352externintget_oid_treeish(const char*str,struct object_id *oid);1353externintget_oid_blob(const char*str,struct object_id *oid);1354externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1355externintget_oid_with_context(const char*str,unsigned flags,struct object_id *oid,struct object_context *oc);135613571358typedefinteach_abbrev_fn(const struct object_id *oid,void*);1359externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13601361externintset_disambiguate_hint_config(const char*var,const char*value);13621363/*1364 * Try to read a SHA1 in hexadecimal format from the 40 characters1365 * starting at hex. Write the 20-byte result to sha1 in binary form.1366 * Return 0 on success. Reading stops if a NUL is encountered in the1367 * input, so it is safe to pass this function an arbitrary1368 * null-terminated string.1369 */1370externintget_sha1_hex(const char*hex,unsigned char*sha1);1371externintget_oid_hex(const char*hex,struct object_id *sha1);13721373/*1374 * Read `len` pairs of hexadecimal digits from `hex` and write the1375 * values to `binary` as `len` bytes. Return 0 on success, or -1 if1376 * the input does not consist of hex digits).1377 */1378externinthex_to_bytes(unsigned char*binary,const char*hex,size_t len);13791380/*1381 * Convert a binary hash to its hex equivalent. The `_r` variant is reentrant,1382 * and writes the NUL-terminated output to the buffer `out`, which must be at1383 * least `GIT_MAX_HEXSZ + 1` bytes, and returns a pointer to out for1384 * convenience.1385 *1386 * The non-`_r` variant returns a static buffer, but uses a ring of 41387 * buffers, making it safe to make multiple calls for a single statement, like:1388 *1389 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1390 */1391char*hash_to_hex_algop_r(char*buffer,const unsigned char*hash,const struct git_hash_algo *);1392char*sha1_to_hex_r(char*out,const unsigned char*sha1);1393char*oid_to_hex_r(char*out,const struct object_id *oid);1394char*hash_to_hex_algop(const unsigned char*hash,const struct git_hash_algo *);/* static buffer result! */1395char*sha1_to_hex(const unsigned char*sha1);/* same static buffer */1396char*hash_to_hex(const unsigned char*hash);/* same static buffer */1397char*oid_to_hex(const struct object_id *oid);/* same static buffer */13981399/*1400 * Parse a 40-character hexadecimal object ID starting from hex, updating the1401 * pointer specified by end when parsing stops. The resulting object ID is1402 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1403 * other invalid character. end is only updated on success; otherwise, it is1404 * unmodified.1405 */1406externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);14071408/*1409 * This reads short-hand syntax that not only evaluates to a commit1410 * object name, but also can act as if the end user spelled the name1411 * of the branch from the command line.1412 *1413 * - "@{-N}" finds the name of the Nth previous branch we were on, and1414 * places the name of the branch in the given buf and returns the1415 * number of characters parsed if successful.1416 *1417 * - "<branch>@{upstream}" finds the name of the other ref that1418 * <branch> is configured to merge with (missing <branch> defaults1419 * to the current branch), and places the name of the branch in the1420 * given buf and returns the number of characters parsed if1421 * successful.1422 *1423 * If the input is not of the accepted format, it returns a negative1424 * number to signal an error.1425 *1426 * If the input was ok but there are not N branch switches in the1427 * reflog, it returns 0.1428 *1429 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1430 * expansions: local branches ("refs/heads/"), remote branches1431 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1432 * allowed, even ones to refs outside of those namespaces.1433 */1434#define INTERPRET_BRANCH_LOCAL (1<<0)1435#define INTERPRET_BRANCH_REMOTE (1<<1)1436#define INTERPRET_BRANCH_HEAD (1<<2)1437externintinterpret_branch_name(const char*str,int len,struct strbuf *,1438unsigned allowed);1439externintget_oid_mb(const char*str,struct object_id *oid);14401441externintvalidate_headref(const char*ref);14421443externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1444externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1445externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1446externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);14471448externvoid*read_object_with_reference(const struct object_id *oid,1449const char*required_type,1450unsigned long*size,1451struct object_id *oid_ret);14521453externstruct object *peel_to_type(const char*name,int namelen,1454struct object *o,enum object_type);14551456enum date_mode_type {1457 DATE_NORMAL =0,1458 DATE_RELATIVE,1459 DATE_SHORT,1460 DATE_ISO8601,1461 DATE_ISO8601_STRICT,1462 DATE_RFC2822,1463 DATE_STRFTIME,1464 DATE_RAW,1465 DATE_UNIX1466};14671468struct date_mode {1469enum date_mode_type type;1470const char*strftime_fmt;1471int local;1472};14731474/*1475 * Convenience helper for passing a constant type, like:1476 *1477 * show_date(t, tz, DATE_MODE(NORMAL));1478 */1479#define DATE_MODE(t) date_mode_from_type(DATE_##t)1480struct date_mode *date_mode_from_type(enum date_mode_type type);14811482const char*show_date(timestamp_t time,int timezone,const struct date_mode *mode);1483voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1484struct strbuf *timebuf);1485intparse_date(const char*date,struct strbuf *out);1486intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1487intparse_expiry_date(const char*date, timestamp_t *timestamp);1488voiddatestamp(struct strbuf *out);1489#define approxidate(s) approxidate_careful((s), NULL)1490timestamp_t approxidate_careful(const char*,int*);1491timestamp_t approxidate_relative(const char*date,const struct timeval *now);1492voidparse_date_format(const char*format,struct date_mode *mode);1493intdate_overflows(timestamp_t date);14941495#define IDENT_STRICT 11496#define IDENT_NO_DATE 21497#define IDENT_NO_NAME 41498externconst char*git_author_info(int);1499externconst char*git_committer_info(int);1500externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1501externconst char*fmt_name(const char*name,const char*email);1502externconst char*ident_default_name(void);1503externconst char*ident_default_email(void);1504externconst char*git_editor(void);1505externconst char*git_sequence_editor(void);1506externconst char*git_pager(int stdout_is_tty);1507externintis_terminal_dumb(void);1508externintgit_ident_config(const char*,const char*,void*);1509externvoidreset_ident_date(void);15101511struct ident_split {1512const char*name_begin;1513const char*name_end;1514const char*mail_begin;1515const char*mail_end;1516const char*date_begin;1517const char*date_end;1518const char*tz_begin;1519const char*tz_end;1520};1521/*1522 * Signals an success with 0, but time part of the result may be NULL1523 * if the input lacks timestamp and zone1524 */1525externintsplit_ident_line(struct ident_split *,const char*,int);15261527/*1528 * Like show_date, but pull the timestamp and tz parameters from1529 * the ident_split. It will also sanity-check the values and produce1530 * a well-known sentinel date if they appear bogus.1531 */1532const char*show_ident_date(const struct ident_split *id,1533const struct date_mode *mode);15341535/*1536 * Compare split idents for equality or strict ordering. Note that we1537 * compare only the ident part of the line, ignoring any timestamp.1538 *1539 * Because there are two fields, we must choose one as the primary key; we1540 * currently arbitrarily pick the email.1541 */1542externintident_cmp(const struct ident_split *,const struct ident_split *);15431544struct checkout {1545struct index_state *istate;1546const char*base_dir;1547int base_dir_len;1548struct delayed_checkout *delayed_checkout;1549unsigned force:1,1550 quiet:1,1551 not_new:1,1552 clone:1,1553 refresh_cache:1;1554};1555#define CHECKOUT_INIT { NULL,"" }15561557#define TEMPORARY_FILENAME_LENGTH 251558externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath,int*nr_checkouts);1559externvoidenable_delayed_checkout(struct checkout *state);1560externintfinish_delayed_checkout(struct checkout *state,int*nr_checkouts);15611562struct cache_def {1563struct strbuf path;1564int flags;1565int track_flags;1566int prefix_len_stat_func;1567};1568#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1569staticinlinevoidcache_def_clear(struct cache_def *cache)1570{1571strbuf_release(&cache->path);1572}15731574externinthas_symlink_leading_path(const char*name,int len);1575externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1576externintcheck_leading_path(const char*name,int len);1577externinthas_dirs_only_path(const char*name,int len,int prefix_len);1578externvoidschedule_dir_for_removal(const char*name,int len);1579externvoidremove_scheduled_dirs(void);15801581struct pack_window {1582struct pack_window *next;1583unsigned char*base;1584 off_t offset;1585size_t len;1586unsigned int last_used;1587unsigned int inuse_cnt;1588};15891590struct pack_entry {1591 off_t offset;1592struct packed_git *p;1593};15941595/*1596 * Create a temporary file rooted in the object database directory, or1597 * die on failure. The filename is taken from "pattern", which should have the1598 * usual "XXXXXX" trailer, and the resulting filename is written into the1599 * "template" buffer. Returns the open descriptor.1600 */1601externintodb_mkstemp(struct strbuf *temp_filename,const char*pattern);16021603/*1604 * Create a pack .keep file named "name" (which should generally be the output1605 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1606 * error.1607 */1608externintodb_pack_keep(const char*name);16091610/*1611 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing1612 * blobs. This has a difference only if extensions.partialClone is set.1613 *1614 * Its default value is 1.1615 */1616externint fetch_if_missing;16171618/* Dumb servers support */1619externintupdate_server_info(int);16201621externconst char*get_log_output_encoding(void);1622externconst char*get_commit_output_encoding(void);16231624/*1625 * This is a hack for test programs like test-dump-untracked-cache to1626 * ensure that they do not modify the untracked cache when reading it.1627 * Do not use it otherwise!1628 */1629externint ignore_untracked_cache_config;16301631externintcommitter_ident_sufficiently_given(void);1632externintauthor_ident_sufficiently_given(void);16331634externconst char*git_commit_encoding;1635externconst char*git_log_output_encoding;1636externconst char*git_mailmap_file;1637externconst char*git_mailmap_blob;16381639/* IO helper functions */1640externvoidmaybe_flush_or_die(FILE*,const char*);1641__attribute__((format(printf,2,3)))1642externvoidfprintf_or_die(FILE*,const char*fmt, ...);16431644#define COPY_READ_ERROR (-2)1645#define COPY_WRITE_ERROR (-3)1646externintcopy_fd(int ifd,int ofd);1647externintcopy_file(const char*dst,const char*src,int mode);1648externintcopy_file_with_time(const char*dst,const char*src,int mode);16491650externvoidwrite_or_die(int fd,const void*buf,size_t count);1651externvoidfsync_or_die(int fd,const char*);16521653extern ssize_t read_in_full(int fd,void*buf,size_t count);1654extern ssize_t write_in_full(int fd,const void*buf,size_t count);1655extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);16561657staticinline ssize_t write_str_in_full(int fd,const char*str)1658{1659returnwrite_in_full(fd, str,strlen(str));1660}16611662/**1663 * Open (and truncate) the file at path, write the contents of buf to it,1664 * and close it. Dies if any errors are encountered.1665 */1666externvoidwrite_file_buf(const char*path,const char*buf,size_t len);16671668/**1669 * Like write_file_buf(), but format the contents into a buffer first.1670 * Additionally, write_file() will append a newline if one is not already1671 * present, making it convenient to write text files:1672 *1673 * write_file(path, "counter: %d", ctr);1674 */1675__attribute__((format(printf,2,3)))1676externvoidwrite_file(const char*path,const char*fmt, ...);16771678/* pager.c */1679externvoidsetup_pager(void);1680externintpager_in_use(void);1681externint pager_use_color;1682externintterm_columns(void);1683externintdecimal_width(uintmax_t);1684externintcheck_pager_config(const char*cmd);1685externvoidprepare_pager_args(struct child_process *,const char*pager);16861687externconst char*editor_program;1688externconst char*askpass_program;1689externconst char*excludes_file;16901691/* base85 */1692intdecode_85(char*dst,const char*line,int linelen);1693voidencode_85(char*buf,const unsigned char*data,int bytes);16941695/* pkt-line.c */1696voidpacket_trace_identity(const char*prog);16971698/* add */1699/*1700 * return 0 if success, 1 - if addition of a file failed and1701 * ADD_FILES_IGNORE_ERRORS was specified in flags1702 */1703intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);17041705/* diff.c */1706externint diff_auto_refresh_index;17071708/* match-trees.c */1709voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1710voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);17111712/*1713 * whitespace rules.1714 * used by both diff and apply1715 * last two digits are tab width1716 */1717#define WS_BLANK_AT_EOL 01001718#define WS_SPACE_BEFORE_TAB 02001719#define WS_INDENT_WITH_NON_TAB 04001720#define WS_CR_AT_EOL 010001721#define WS_BLANK_AT_EOF 020001722#define WS_TAB_IN_INDENT 040001723#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1724#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1725#define WS_TAB_WIDTH_MASK 0771726/* All WS_* -- when extended, adapt diff.c emit_symbol */1727#define WS_RULE_MASK 077771728externunsigned whitespace_rule_cfg;1729externunsignedwhitespace_rule(struct index_state *,const char*);1730externunsignedparse_whitespace_rule(const char*);1731externunsignedws_check(const char*line,int len,unsigned ws_rule);1732externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1733externchar*whitespace_error_string(unsigned ws);1734externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1735externintws_blank_line(const char*line,int len,unsigned ws_rule);1736#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)17371738/* ls-files */1739voidoverlay_tree_on_index(struct index_state *istate,1740const char*tree_name,const char*prefix);17411742/* setup.c */1743struct startup_info {1744int have_repository;1745const char*prefix;1746};1747externstruct startup_info *startup_info;17481749/* merge.c */1750struct commit_list;1751inttry_merge_command(struct repository *r,1752const char*strategy,size_t xopts_nr,1753const char**xopts,struct commit_list *common,1754const char*head_arg,struct commit_list *remotes);1755intcheckout_fast_forward(struct repository *r,1756const struct object_id *from,1757const struct object_id *to,1758int overwrite_ignore);175917601761intsane_execvp(const char*file,char*const argv[]);17621763/*1764 * A struct to encapsulate the concept of whether a file has changed1765 * since we last checked it. This uses criteria similar to those used1766 * for the index.1767 */1768struct stat_validity {1769struct stat_data *sd;1770};17711772voidstat_validity_clear(struct stat_validity *sv);17731774/*1775 * Returns 1 if the path is a regular file (or a symlink to a regular1776 * file) and matches the saved stat_validity, 0 otherwise. A missing1777 * or inaccessible file is considered a match if the struct was just1778 * initialized, or if the previous update found an inaccessible file.1779 */1780intstat_validity_check(struct stat_validity *sv,const char*path);17811782/*1783 * Update the stat_validity from a file opened at descriptor fd. If1784 * the file is missing, inaccessible, or not a regular file, then1785 * future calls to stat_validity_check will match iff one of those1786 * conditions continues to be true.1787 */1788voidstat_validity_update(struct stat_validity *sv,int fd);17891790intversioncmp(const char*s1,const char*s2);1791voidsleep_millisec(int millisec);17921793/*1794 * Create a directory and (if share is nonzero) adjust its permissions1795 * according to the shared_repository setting. Only use this for1796 * directories under $GIT_DIR. Don't use it for working tree1797 * directories.1798 */1799voidsafe_create_dir(const char*dir,int share);18001801/*1802 * Should we print an ellipsis after an abbreviated SHA-1 value1803 * when doing diff-raw output or indicating a detached HEAD?1804 */1805externintprint_sha1_ellipsis(void);18061807#endif/* CACHE_H */