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 byte and in hex digits of the largest possible hash value. */ 52#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 53#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 54/* The largest possible block size for any supported hash. */ 55#define GIT_MAX_BLKSZ GIT_SHA1_BLKSZ 56 57struct object_id { 58unsigned char hash[GIT_MAX_RAWSZ]; 59}; 60 61#define the_hash_algo the_repository->hash_algo 62 63#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 64#define DTYPE(de) ((de)->d_type) 65#else 66#undef DT_UNKNOWN 67#undef DT_DIR 68#undef DT_REG 69#undef DT_LNK 70#define DT_UNKNOWN 0 71#define DT_DIR 1 72#define DT_REG 2 73#define DT_LNK 3 74#define DTYPE(de) DT_UNKNOWN 75#endif 76 77/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 78#define S_IFINVALID 0030000 79 80/* 81 * A "directory link" is a link to another git directory. 82 * 83 * The value 0160000 is not normally a valid mode, and 84 * also just happens to be S_IFDIR + S_IFLNK 85 */ 86#define S_IFGITLINK 0160000 87#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 88 89/* 90 * Some mode bits are also used internally for computations. 91 * 92 * They *must* not overlap with any valid modes, and they *must* not be emitted 93 * to outside world - i.e. appear on disk or network. In other words, it's just 94 * temporary fields, which we internally use, but they have to stay in-house. 95 * 96 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 97 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 98 */ 99 100/* used internally in tree-diff */ 101#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 102 103 104/* 105 * Intensive research over the course of many years has shown that 106 * port 9418 is totally unused by anything else. Or 107 * 108 * Your search - "port 9418" - did not match any documents. 109 * 110 * as www.google.com puts it. 111 * 112 * This port has been properly assigned for git use by IANA: 113 * git (Assigned-9418) [I06-050728-0001]. 114 * 115 * git 9418/tcp git pack transfer service 116 * git 9418/udp git pack transfer service 117 * 118 * with Linus Torvalds <torvalds@osdl.org> as the point of 119 * contact. September 2005. 120 * 121 * See http://www.iana.org/assignments/port-numbers 122 */ 123#define DEFAULT_GIT_PORT 9418 124 125/* 126 * Basic data structures for the directory cache 127 */ 128 129#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 130struct cache_header { 131uint32_t hdr_signature; 132uint32_t hdr_version; 133uint32_t hdr_entries; 134}; 135 136#define INDEX_FORMAT_LB 2 137#define INDEX_FORMAT_UB 4 138 139/* 140 * The "cache_time" is just the low 32 bits of the 141 * time. It doesn't matter if it overflows - we only 142 * check it for equality in the 32 bits we save. 143 */ 144struct cache_time { 145uint32_t sec; 146uint32_t nsec; 147}; 148 149struct stat_data { 150struct cache_time sd_ctime; 151struct cache_time sd_mtime; 152unsigned int sd_dev; 153unsigned int sd_ino; 154unsigned int sd_uid; 155unsigned int sd_gid; 156unsigned int sd_size; 157}; 158 159struct cache_entry { 160struct hashmap_entry ent; 161struct stat_data ce_stat_data; 162unsigned int ce_mode; 163unsigned int ce_flags; 164unsigned int mem_pool_allocated; 165unsigned int ce_namelen; 166unsigned int index;/* for link extension */ 167struct object_id oid; 168char name[FLEX_ARRAY];/* more */ 169}; 170 171#define CE_STAGEMASK (0x3000) 172#define CE_EXTENDED (0x4000) 173#define CE_VALID (0x8000) 174#define CE_STAGESHIFT 12 175 176/* 177 * Range 0xFFFF0FFF in ce_flags is divided into 178 * two parts: in-memory flags and on-disk ones. 179 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 180 * if you want to save a new flag, add it in 181 * CE_EXTENDED_FLAGS 182 * 183 * In-memory only flags 184 */ 185#define CE_UPDATE (1 << 16) 186#define CE_REMOVE (1 << 17) 187#define CE_UPTODATE (1 << 18) 188#define CE_ADDED (1 << 19) 189 190#define CE_HASHED (1 << 20) 191#define CE_FSMONITOR_VALID (1 << 21) 192#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 193#define CE_CONFLICTED (1 << 23) 194 195#define CE_UNPACKED (1 << 24) 196#define CE_NEW_SKIP_WORKTREE (1 << 25) 197 198/* used to temporarily mark paths matched by pathspecs */ 199#define CE_MATCHED (1 << 26) 200 201#define CE_UPDATE_IN_BASE (1 << 27) 202#define CE_STRIP_NAME (1 << 28) 203 204/* 205 * Extended on-disk flags 206 */ 207#define CE_INTENT_TO_ADD (1 << 29) 208#define CE_SKIP_WORKTREE (1 << 30) 209/* CE_EXTENDED2 is for future extension */ 210#define CE_EXTENDED2 (1U << 31) 211 212#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 213 214/* 215 * Safeguard to avoid saving wrong flags: 216 * - CE_EXTENDED2 won't get saved until its semantic is known 217 * - Bits in 0x0000FFFF have been saved in ce_flags already 218 * - Bits in 0x003F0000 are currently in-memory flags 219 */ 220#if CE_EXTENDED_FLAGS & 0x803FFFFF 221#error"CE_EXTENDED_FLAGS out of range" 222#endif 223 224/* Forward structure decls */ 225struct pathspec; 226struct child_process; 227struct tree; 228 229/* 230 * Copy the sha1 and stat state of a cache entry from one to 231 * another. But we never change the name, or the hash state! 232 */ 233staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 234const struct cache_entry *src) 235{ 236unsigned int state = dst->ce_flags & CE_HASHED; 237int mem_pool_allocated = dst->mem_pool_allocated; 238 239/* Don't copy hash chain and name */ 240memcpy(&dst->ce_stat_data, &src->ce_stat_data, 241offsetof(struct cache_entry, name) - 242offsetof(struct cache_entry, ce_stat_data)); 243 244/* Restore the hash state */ 245 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 246 247/* Restore the mem_pool_allocated flag */ 248 dst->mem_pool_allocated = mem_pool_allocated; 249} 250 251staticinlineunsignedcreate_ce_flags(unsigned stage) 252{ 253return(stage << CE_STAGESHIFT); 254} 255 256#define ce_namelen(ce) ((ce)->ce_namelen) 257#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 258#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 259#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 260#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 261#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 262#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 263 264#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 265staticinlineunsigned intcreate_ce_mode(unsigned int mode) 266{ 267if(S_ISLNK(mode)) 268return S_IFLNK; 269if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 270return S_IFGITLINK; 271return S_IFREG |ce_permissions(mode); 272} 273staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 274unsigned int mode) 275{ 276externint trust_executable_bit, has_symlinks; 277if(!has_symlinks &&S_ISREG(mode) && 278 ce &&S_ISLNK(ce->ce_mode)) 279return ce->ce_mode; 280if(!trust_executable_bit &&S_ISREG(mode)) { 281if(ce &&S_ISREG(ce->ce_mode)) 282return ce->ce_mode; 283returncreate_ce_mode(0666); 284} 285returncreate_ce_mode(mode); 286} 287staticinlineintce_to_dtype(const struct cache_entry *ce) 288{ 289unsigned ce_mode =ntohl(ce->ce_mode); 290if(S_ISREG(ce_mode)) 291return DT_REG; 292else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 293return DT_DIR; 294else if(S_ISLNK(ce_mode)) 295return DT_LNK; 296else 297return DT_UNKNOWN; 298} 299staticinlineunsigned intcanon_mode(unsigned int mode) 300{ 301if(S_ISREG(mode)) 302return S_IFREG |ce_permissions(mode); 303if(S_ISLNK(mode)) 304return S_IFLNK; 305if(S_ISDIR(mode)) 306return S_IFDIR; 307return S_IFGITLINK; 308} 309 310#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 311 312#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 313#define CE_ENTRY_CHANGED (1 << 1) 314#define CE_ENTRY_REMOVED (1 << 2) 315#define CE_ENTRY_ADDED (1 << 3) 316#define RESOLVE_UNDO_CHANGED (1 << 4) 317#define CACHE_TREE_CHANGED (1 << 5) 318#define SPLIT_INDEX_ORDERED (1 << 6) 319#define UNTRACKED_CHANGED (1 << 7) 320#define FSMONITOR_CHANGED (1 << 8) 321 322struct split_index; 323struct untracked_cache; 324 325struct index_state { 326struct cache_entry **cache; 327unsigned int version; 328unsigned int cache_nr, cache_alloc, cache_changed; 329struct string_list *resolve_undo; 330struct cache_tree *cache_tree; 331struct split_index *split_index; 332struct cache_time timestamp; 333unsigned name_hash_initialized :1, 334 initialized :1, 335 drop_cache_tree :1; 336struct hashmap name_hash; 337struct hashmap dir_hash; 338struct object_id oid; 339struct untracked_cache *untracked; 340uint64_t fsmonitor_last_update; 341struct ewah_bitmap *fsmonitor_dirty; 342struct mem_pool *ce_mem_pool; 343}; 344 345externstruct index_state the_index; 346 347/* Name hashing */ 348externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 349externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 350externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 351externvoidfree_name_hash(struct index_state *istate); 352 353 354/* Cache entry creation and cleanup */ 355 356/* 357 * Create cache_entry intended for use in the specified index. Caller 358 * is responsible for discarding the cache_entry with 359 * `discard_cache_entry`. 360 */ 361struct cache_entry *make_cache_entry(struct index_state *istate, 362unsigned int mode, 363const struct object_id *oid, 364const char*path, 365int stage, 366unsigned int refresh_options); 367 368struct cache_entry *make_empty_cache_entry(struct index_state *istate, 369size_t name_len); 370 371/* 372 * Create a cache_entry that is not intended to be added to an index. 373 * Caller is responsible for discarding the cache_entry 374 * with `discard_cache_entry`. 375 */ 376struct cache_entry *make_transient_cache_entry(unsigned int mode, 377const struct object_id *oid, 378const char*path, 379int stage); 380 381struct cache_entry *make_empty_transient_cache_entry(size_t name_len); 382 383/* 384 * Discard cache entry. 385 */ 386voiddiscard_cache_entry(struct cache_entry *ce); 387 388/* 389 * Check configuration if we should perform extra validation on cache 390 * entries. 391 */ 392intshould_validate_cache_entries(void); 393 394/* 395 * Duplicate a cache_entry. Allocate memory for the new entry from a 396 * memory_pool. Takes into account cache_entry fields that are meant 397 * for managing the underlying memory allocation of the cache_entry. 398 */ 399struct cache_entry *dup_cache_entry(const struct cache_entry *ce,struct index_state *istate); 400 401/* 402 * Validate the cache entries in the index. This is an internal 403 * consistency check that the cache_entry structs are allocated from 404 * the expected memory pool. 405 */ 406voidvalidate_cache_entries(const struct index_state *istate); 407 408#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 409#define active_cache (the_index.cache) 410#define active_nr (the_index.cache_nr) 411#define active_alloc (the_index.cache_alloc) 412#define active_cache_changed (the_index.cache_changed) 413#define active_cache_tree (the_index.cache_tree) 414 415#define read_cache() read_index(&the_index) 416#define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir())) 417#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 418#define is_cache_unborn() is_index_unborn(&the_index) 419#define read_cache_unmerged() read_index_unmerged(&the_index) 420#define discard_cache() discard_index(&the_index) 421#define unmerged_cache() unmerged_index(&the_index) 422#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 423#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 424#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 425#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 426#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 427#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 428#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 429#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 430#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 431#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 432#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 433#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 434#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 435#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 436#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 437#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 438#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 439#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 440#endif 441 442#define TYPE_BITS 3 443 444/* 445 * Values in this enum (except those outside the 3 bit range) are part 446 * of pack file format. See Documentation/technical/pack-format.txt 447 * for more information. 448 */ 449enum object_type { 450 OBJ_BAD = -1, 451 OBJ_NONE =0, 452 OBJ_COMMIT =1, 453 OBJ_TREE =2, 454 OBJ_BLOB =3, 455 OBJ_TAG =4, 456/* 5 for future expansion */ 457 OBJ_OFS_DELTA =6, 458 OBJ_REF_DELTA =7, 459 OBJ_ANY, 460 OBJ_MAX 461}; 462 463staticinlineenum object_type object_type(unsigned int mode) 464{ 465returnS_ISDIR(mode) ? OBJ_TREE : 466S_ISGITLINK(mode) ? OBJ_COMMIT : 467 OBJ_BLOB; 468} 469 470/* Double-check local_repo_env below if you add to this list. */ 471#define GIT_DIR_ENVIRONMENT"GIT_DIR" 472#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 473#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 474#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 475#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 476#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 477#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 478#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 479#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 480#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 481#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 482#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 483#define CONFIG_ENVIRONMENT"GIT_CONFIG" 484#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 485#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 486#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 487#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 488#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 489#define GITATTRIBUTES_FILE".gitattributes" 490#define INFOATTRIBUTES_FILE"info/attributes" 491#define ATTRIBUTE_MACRO_PREFIX"[attr]" 492#define GITMODULES_FILE".gitmodules" 493#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 494#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 495#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 496#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 497#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 498#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 499#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 500#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 501#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 502#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 503#define GIT_OPTIONAL_LOCKS_ENVIRONMENT"GIT_OPTIONAL_LOCKS" 504#define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT"GIT_TEXTDOMAINDIR" 505 506/* 507 * Environment variable used in handshaking the wire protocol. 508 * Contains a colon ':' separated list of keys with optional values 509 * 'key[=value]'. Presence of unknown keys and values must be 510 * ignored. 511 */ 512#define GIT_PROTOCOL_ENVIRONMENT"GIT_PROTOCOL" 513/* HTTP header used to handshake the wire protocol */ 514#define GIT_PROTOCOL_HEADER"Git-Protocol" 515 516/* 517 * This environment variable is expected to contain a boolean indicating 518 * whether we should or should not treat: 519 * 520 * GIT_DIR=foo.git git ... 521 * 522 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 523 * of this, but we use it internally to communicate to sub-processes that we 524 * are in a bare repo. If not set, defaults to true. 525 */ 526#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 527 528/* 529 * Repository-local GIT_* environment variables; these will be cleared 530 * when git spawns a sub-process that runs inside another repository. 531 * The array is NULL-terminated, which makes it easy to pass in the "env" 532 * parameter of a run-command invocation, or to do a simple walk. 533 */ 534externconst char*const local_repo_env[]; 535 536externvoidsetup_git_env(const char*git_dir); 537 538/* 539 * Returns true iff we have a configured git repository (either via 540 * setup_git_directory, or in the environment via $GIT_DIR). 541 */ 542inthave_git_dir(void); 543 544externint is_bare_repository_cfg; 545externintis_bare_repository(void); 546externintis_inside_git_dir(void); 547externchar*git_work_tree_cfg; 548externintis_inside_work_tree(void); 549externconst char*get_git_dir(void); 550externconst char*get_git_common_dir(void); 551externchar*get_object_directory(void); 552externchar*get_index_file(void); 553externchar*get_graft_file(struct repository *r); 554externvoidset_git_dir(const char*path); 555externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 556externintget_common_dir(struct strbuf *sb,const char*gitdir); 557externconst char*get_git_namespace(void); 558externconst char*strip_namespace(const char*namespaced_ref); 559externconst char*get_super_prefix(void); 560externconst char*get_git_work_tree(void); 561 562/* 563 * Return true if the given path is a git directory; note that this _just_ 564 * looks at the directory itself. If you want to know whether "foo/.git" 565 * is a repository, you must feed that path, not just "foo". 566 */ 567externintis_git_directory(const char*path); 568 569/* 570 * Return 1 if the given path is the root of a git repository or 571 * submodule, else 0. Will not return 1 for bare repositories with the 572 * exception of creating a bare repository in "foo/.git" and calling 573 * is_git_repository("foo"). 574 * 575 * If we run into read errors, we err on the side of saying "yes, it is", 576 * as we usually consider sub-repos precious, and would prefer to err on the 577 * side of not disrupting or deleting them. 578 */ 579externintis_nonbare_repository_dir(struct strbuf *path); 580 581#define READ_GITFILE_ERR_STAT_FAILED 1 582#define READ_GITFILE_ERR_NOT_A_FILE 2 583#define READ_GITFILE_ERR_OPEN_FAILED 3 584#define READ_GITFILE_ERR_READ_FAILED 4 585#define READ_GITFILE_ERR_INVALID_FORMAT 5 586#define READ_GITFILE_ERR_NO_PATH 6 587#define READ_GITFILE_ERR_NOT_A_REPO 7 588#define READ_GITFILE_ERR_TOO_LARGE 8 589externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 590externconst char*read_gitfile_gently(const char*path,int*return_error_code); 591#define read_gitfile(path) read_gitfile_gently((path), NULL) 592externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 593#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 594 595externvoidset_git_work_tree(const char*tree); 596 597#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 598 599externvoidsetup_work_tree(void); 600/* 601 * Find the commondir and gitdir of the repository that contains the current 602 * working directory, without changing the working directory or other global 603 * state. The result is appended to commondir and gitdir. If the discovered 604 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 605 * both have the same result appended to the buffer. The return value is 606 * either 0 upon success and non-zero if no repository was found. 607 */ 608externintdiscover_git_directory(struct strbuf *commondir, 609struct strbuf *gitdir); 610externconst char*setup_git_directory_gently(int*); 611externconst char*setup_git_directory(void); 612externchar*prefix_path(const char*prefix,int len,const char*path); 613externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 614 615/* 616 * Concatenate "prefix" (if len is non-zero) and "path", with no 617 * connecting characters (so "prefix" should end with a "/"). 618 * Unlike prefix_path, this should be used if the named file does 619 * not have to interact with index entry; i.e. name of a random file 620 * on the filesystem. 621 * 622 * The return value is always a newly allocated string (even if the 623 * prefix was empty). 624 */ 625externchar*prefix_filename(const char*prefix,const char*path); 626 627externintcheck_filename(const char*prefix,const char*name); 628externvoidverify_filename(const char*prefix, 629const char*name, 630int diagnose_misspelt_rev); 631externvoidverify_non_filename(const char*prefix,const char*name); 632externintpath_inside_repo(const char*prefix,const char*path); 633 634#define INIT_DB_QUIET 0x0001 635#define INIT_DB_EXIST_OK 0x0002 636 637externintinit_db(const char*git_dir,const char*real_git_dir, 638const char*template_dir,unsigned int flags); 639 640externvoidsanitize_stdfds(void); 641externintdaemonize(void); 642 643#define alloc_nr(x) (((x)+16)*3/2) 644 645/* 646 * Realloc the buffer pointed at by variable 'x' so that it can hold 647 * at least 'nr' entries; the number of entries currently allocated 648 * is 'alloc', using the standard growing factor alloc_nr() macro. 649 * 650 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 651 */ 652#define ALLOC_GROW(x, nr, alloc) \ 653 do { \ 654 if ((nr) > alloc) { \ 655 if (alloc_nr(alloc) < (nr)) \ 656 alloc = (nr); \ 657 else \ 658 alloc = alloc_nr(alloc); \ 659 REALLOC_ARRAY(x, alloc); \ 660 } \ 661 } while (0) 662 663/* Initialize and use the cache information */ 664struct lock_file; 665externintread_index(struct index_state *); 666externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 667externintdo_read_index(struct index_state *istate,const char*path, 668int must_exist);/* for testting only! */ 669externintread_index_from(struct index_state *,const char*path, 670const char*gitdir); 671externintis_index_unborn(struct index_state *); 672externintread_index_unmerged(struct index_state *); 673 674/* For use with `write_locked_index()`. */ 675#define COMMIT_LOCK (1 << 0) 676#define SKIP_IF_UNCHANGED (1 << 1) 677 678/* 679 * Write the index while holding an already-taken lock. Close the lock, 680 * and if `COMMIT_LOCK` is given, commit it. 681 * 682 * Unless a split index is in use, write the index into the lockfile. 683 * 684 * With a split index, write the shared index to a temporary file, 685 * adjust its permissions and rename it into place, then write the 686 * split index to the lockfile. If the temporary file for the shared 687 * index cannot be created, fall back to the behavior described in 688 * the previous paragraph. 689 * 690 * With `COMMIT_LOCK`, the lock is always committed or rolled back. 691 * Without it, the lock is closed, but neither committed nor rolled 692 * back. 693 * 694 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing 695 * is written (and the lock is rolled back if `COMMIT_LOCK` is given). 696 */ 697externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 698 699externintdiscard_index(struct index_state *); 700externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 701externintunmerged_index(const struct index_state *); 702 703/** 704 * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL, 705 * compares istate to HEAD. If tree is NULL and on an unborn branch, 706 * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is 707 * provided, the space-separated list of files that differ will be appended 708 * to it. 709 */ 710externintindex_has_changes(const struct index_state *istate, 711struct tree *tree, 712struct strbuf *sb); 713 714externintverify_path(const char*path,unsigned mode); 715externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 716externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 717externvoidadjust_dirname_case(struct index_state *istate,char*name); 718externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 719 720/* 721 * Searches for an entry defined by name and namelen in the given index. 722 * If the return value is positive (including 0) it is the position of an 723 * exact match. If the return value is negative, the negated value minus 1 724 * is the position where the entry would be inserted. 725 * Example: The current index consists of these files and its stages: 726 * 727 * b#0, d#0, f#1, f#3 728 * 729 * index_name_pos(&index, "a", 1) -> -1 730 * index_name_pos(&index, "b", 1) -> 0 731 * index_name_pos(&index, "c", 1) -> -2 732 * index_name_pos(&index, "d", 1) -> 1 733 * index_name_pos(&index, "e", 1) -> -3 734 * index_name_pos(&index, "f", 1) -> -3 735 * index_name_pos(&index, "g", 1) -> -5 736 */ 737externintindex_name_pos(const struct index_state *,const char*name,int namelen); 738 739#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 740#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 741#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 742#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 743#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 744#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 745externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 746externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 747 748/* Remove entry, return true if there are more entries to go. */ 749externintremove_index_entry_at(struct index_state *,int pos); 750 751externvoidremove_marked_cache_entries(struct index_state *istate); 752externintremove_file_from_index(struct index_state *,const char*path); 753#define ADD_CACHE_VERBOSE 1 754#define ADD_CACHE_PRETEND 2 755#define ADD_CACHE_IGNORE_ERRORS 4 756#define ADD_CACHE_IGNORE_REMOVAL 8 757#define ADD_CACHE_INTENT 16 758/* 759 * These two are used to add the contents of the file at path 760 * to the index, marking the working tree up-to-date by storing 761 * the cached stat info in the resulting cache entry. A caller 762 * that has already run lstat(2) on the path can call 763 * add_to_index(), and all others can call add_file_to_index(); 764 * the latter will do necessary lstat(2) internally before 765 * calling the former. 766 */ 767externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 768externintadd_file_to_index(struct index_state *,const char*path,int flags); 769 770externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 771externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 772externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 773externintindex_name_is_other(const struct index_state *,const char*,int); 774externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 775 776/* do stat comparison even if CE_VALID is true */ 777#define CE_MATCH_IGNORE_VALID 01 778/* do not check the contents but report dirty on racily-clean entries */ 779#define CE_MATCH_RACY_IS_DIRTY 02 780/* do stat comparison even if CE_SKIP_WORKTREE is true */ 781#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 782/* ignore non-existent files during stat update */ 783#define CE_MATCH_IGNORE_MISSING 0x08 784/* enable stat refresh */ 785#define CE_MATCH_REFRESH 0x10 786/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */ 787#define CE_MATCH_IGNORE_FSMONITOR 0X20 788externintie_match_stat(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 789externintie_modified(struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 790 791#define HASH_WRITE_OBJECT 1 792#define HASH_FORMAT_CHECK 2 793#define HASH_RENORMALIZE 4 794externintindex_fd(struct object_id *oid,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 795externintindex_path(struct object_id *oid,const char*path,struct stat *st,unsigned flags); 796 797/* 798 * Record to sd the data from st that we use to check whether a file 799 * might have changed. 800 */ 801externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 802 803/* 804 * Return 0 if st is consistent with a file not having been changed 805 * since sd was filled. If there are differences, return a 806 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 807 * INODE_CHANGED, and DATA_CHANGED. 808 */ 809externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 810externintmatch_stat_data_racy(const struct index_state *istate, 811const struct stat_data *sd,struct stat *st); 812 813externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 814 815#define REFRESH_REALLY 0x0001/* ignore_valid */ 816#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 817#define REFRESH_QUIET 0x0004/* be quiet about it */ 818#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 819#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 820#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 821externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 822externstruct cache_entry *refresh_cache_entry(struct index_state *,struct cache_entry *,unsigned int); 823 824/* 825 * Opportunistically update the index but do not complain if we can't. 826 * The lockfile is always committed or rolled back. 827 */ 828externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 829 830externinthold_locked_index(struct lock_file *,int); 831externvoidset_alternate_index_output(const char*); 832 833externint verify_index_checksum; 834externint verify_ce_order; 835 836/* Environment bits from configuration mechanism */ 837externint trust_executable_bit; 838externint trust_ctime; 839externint check_stat; 840externint quote_path_fully; 841externint has_symlinks; 842externint minimum_abbrev, default_abbrev; 843externint ignore_case; 844externint assume_unchanged; 845externint prefer_symlink_refs; 846externint warn_ambiguous_refs; 847externint warn_on_object_refname_ambiguity; 848externconst char*apply_default_whitespace; 849externconst char*apply_default_ignorewhitespace; 850externconst char*git_attributes_file; 851externconst char*git_hooks_path; 852externint zlib_compression_level; 853externint core_compression_level; 854externint pack_compression_level; 855externsize_t packed_git_window_size; 856externsize_t packed_git_limit; 857externsize_t delta_base_cache_limit; 858externunsigned long big_file_threshold; 859externunsigned long pack_size_limit_cfg; 860 861/* 862 * Accessors for the core.sharedrepository config which lazy-load the value 863 * from the config (if not already set). The "reset" function can be 864 * used to unset "set" or cached value, meaning that the value will be loaded 865 * fresh from the config file on the next call to get_shared_repository(). 866 */ 867voidset_shared_repository(int value); 868intget_shared_repository(void); 869voidreset_shared_repository(void); 870 871/* 872 * Do replace refs need to be checked this run? This variable is 873 * initialized to true unless --no-replace-object is used or 874 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 875 * commands that do not want replace references to be active. 876 */ 877externint read_replace_refs; 878externchar*git_replace_ref_base; 879 880externint fsync_object_files; 881externint core_preload_index; 882externint core_apply_sparse_checkout; 883externint precomposed_unicode; 884externint protect_hfs; 885externint protect_ntfs; 886externconst char*core_fsmonitor; 887 888/* 889 * Include broken refs in all ref iterations, which will 890 * generally choke dangerous operations rather than letting 891 * them silently proceed without taking the broken ref into 892 * account. 893 */ 894externint ref_paranoia; 895 896/* 897 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value). 898 */ 899intuse_optional_locks(void); 900 901/* 902 * The character that begins a commented line in user-editable file 903 * that is subject to stripspace. 904 */ 905externchar comment_line_char; 906externint auto_comment_line_char; 907 908/* Windows only */ 909enum hide_dotfiles_type { 910 HIDE_DOTFILES_FALSE =0, 911 HIDE_DOTFILES_TRUE, 912 HIDE_DOTFILES_DOTGITONLY 913}; 914externenum hide_dotfiles_type hide_dotfiles; 915 916enum log_refs_config { 917 LOG_REFS_UNSET = -1, 918 LOG_REFS_NONE =0, 919 LOG_REFS_NORMAL, 920 LOG_REFS_ALWAYS 921}; 922externenum log_refs_config log_all_ref_updates; 923 924enum rebase_setup_type { 925 AUTOREBASE_NEVER =0, 926 AUTOREBASE_LOCAL, 927 AUTOREBASE_REMOTE, 928 AUTOREBASE_ALWAYS 929}; 930 931enum push_default_type { 932 PUSH_DEFAULT_NOTHING =0, 933 PUSH_DEFAULT_MATCHING, 934 PUSH_DEFAULT_SIMPLE, 935 PUSH_DEFAULT_UPSTREAM, 936 PUSH_DEFAULT_CURRENT, 937 PUSH_DEFAULT_UNSPECIFIED 938}; 939 940externenum rebase_setup_type autorebase; 941externenum push_default_type push_default; 942 943enum object_creation_mode { 944 OBJECT_CREATION_USES_HARDLINKS =0, 945 OBJECT_CREATION_USES_RENAMES =1 946}; 947 948externenum object_creation_mode object_creation_mode; 949 950externchar*notes_ref_name; 951 952externint grafts_replace_parents; 953 954/* 955 * GIT_REPO_VERSION is the version we write by default. The 956 * _READ variant is the highest number we know how to 957 * handle. 958 */ 959#define GIT_REPO_VERSION 0 960#define GIT_REPO_VERSION_READ 1 961externint repository_format_precious_objects; 962externchar*repository_format_partial_clone; 963externconst char*core_partial_clone_filter_default; 964 965struct repository_format { 966int version; 967int precious_objects; 968char*partial_clone;/* value of extensions.partialclone */ 969int is_bare; 970int hash_algo; 971char*work_tree; 972struct string_list unknown_extensions; 973}; 974 975/* 976 * Read the repository format characteristics from the config file "path" into 977 * "format" struct. Returns the numeric version. On error, -1 is returned, 978 * format->version is set to -1, and all other fields in the struct are 979 * undefined. 980 */ 981intread_repository_format(struct repository_format *format,const char*path); 982 983/* 984 * Verify that the repository described by repository_format is something we 985 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 986 * any errors encountered. 987 */ 988intverify_repository_format(const struct repository_format *format, 989struct strbuf *err); 990 991/* 992 * Check the repository format version in the path found in get_git_dir(), 993 * and die if it is a version we don't understand. Generally one would 994 * set_git_dir() before calling this, and use it only for "are we in a valid 995 * repo?". 996 */ 997externvoidcheck_repository_format(void); 998 999#define MTIME_CHANGED 0x00011000#define CTIME_CHANGED 0x00021001#define OWNER_CHANGED 0x00041002#define MODE_CHANGED 0x00081003#define INODE_CHANGED 0x00101004#define DATA_CHANGED 0x00201005#define TYPE_CHANGED 0x004010061007/*1008 * Return an abbreviated sha1 unique within this repository's object database.1009 * The result will be at least `len` characters long, and will be NUL1010 * terminated.1011 *1012 * The non-`_r` version returns a static buffer which remains valid until 41013 * more calls to find_unique_abbrev are made.1014 *1015 * The `_r` variant writes to a buffer supplied by the caller, which must be at1016 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes1017 * written (excluding the NUL terminator).1018 *1019 * Note that while this version avoids the static buffer, it is not fully1020 * reentrant, as it calls into other non-reentrant git code.1021 */1022externconst char*find_unique_abbrev(const struct object_id *oid,int len);1023externintfind_unique_abbrev_r(char*hex,const struct object_id *oid,int len);10241025externconst unsigned char null_sha1[GIT_MAX_RAWSZ];1026externconst struct object_id null_oid;10271028staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2)1029{1030/*1031 * Teach the compiler that there are only two possibilities of hash size1032 * here, so that it can optimize for this case as much as possible.1033 */1034if(the_hash_algo->rawsz == GIT_MAX_RAWSZ)1035returnmemcmp(sha1, sha2, GIT_MAX_RAWSZ);1036returnmemcmp(sha1, sha2, GIT_SHA1_RAWSZ);1037}10381039staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2)1040{1041returnhashcmp(oid1->hash, oid2->hash);1042}10431044staticinlineinthasheq(const unsigned char*sha1,const unsigned char*sha2)1045{1046/*1047 * We write this here instead of deferring to hashcmp so that the1048 * compiler can properly inline it and avoid calling memcmp.1049 */1050if(the_hash_algo->rawsz == GIT_MAX_RAWSZ)1051return!memcmp(sha1, sha2, GIT_MAX_RAWSZ);1052return!memcmp(sha1, sha2, GIT_SHA1_RAWSZ);1053}10541055staticinlineintoideq(const struct object_id *oid1,const struct object_id *oid2)1056{1057returnhasheq(oid1->hash, oid2->hash);1058}10591060staticinlineintis_null_sha1(const unsigned char*sha1)1061{1062returnhasheq(sha1, null_sha1);1063}10641065staticinlineintis_null_oid(const struct object_id *oid)1066{1067returnhasheq(oid->hash, null_sha1);1068}10691070staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src)1071{1072memcpy(sha_dst, sha_src, the_hash_algo->rawsz);1073}10741075staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src)1076{1077hashcpy(dst->hash, src->hash);1078}10791080staticinlinestruct object_id *oiddup(const struct object_id *src)1081{1082struct object_id *dst =xmalloc(sizeof(struct object_id));1083oidcpy(dst, src);1084return dst;1085}10861087staticinlinevoidhashclr(unsigned char*hash)1088{1089memset(hash,0, the_hash_algo->rawsz);1090}10911092staticinlinevoidoidclr(struct object_id *oid)1093{1094memset(oid->hash,0, GIT_MAX_RAWSZ);1095}10961097staticinlinevoidoidread(struct object_id *oid,const unsigned char*hash)1098{1099memcpy(oid->hash, hash, the_hash_algo->rawsz);1100}11011102staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1103{1104returnhasheq(sha1, the_hash_algo->empty_blob->hash);1105}11061107staticinlineintis_empty_blob_oid(const struct object_id *oid)1108{1109returnoideq(oid, the_hash_algo->empty_blob);1110}11111112staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1113{1114returnhasheq(sha1, the_hash_algo->empty_tree->hash);1115}11161117staticinlineintis_empty_tree_oid(const struct object_id *oid)1118{1119returnoideq(oid, the_hash_algo->empty_tree);1120}11211122const char*empty_tree_oid_hex(void);1123const char*empty_blob_oid_hex(void);11241125/* set default permissions by passing mode arguments to open(2) */1126intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1127intgit_mkstemp_mode(char*pattern,int mode);11281129/*1130 * NOTE NOTE NOTE!!1131 *1132 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1133 * not be changed. Old repositories have core.sharedrepository written in1134 * numeric format, and therefore these values are preserved for compatibility1135 * reasons.1136 */1137enum sharedrepo {1138 PERM_UMASK =0,1139 OLD_PERM_GROUP =1,1140 OLD_PERM_EVERYBODY =2,1141 PERM_GROUP =0660,1142 PERM_EVERYBODY =06641143};1144intgit_config_perm(const char*var,const char*value);1145intadjust_shared_perm(const char*path);11461147/*1148 * Create the directory containing the named path, using care to be1149 * somewhat safe against races. Return one of the scld_error values to1150 * indicate success/failure. On error, set errno to describe the1151 * problem.1152 *1153 * SCLD_VANISHED indicates that one of the ancestor directories of the1154 * path existed at one point during the function call and then1155 * suddenly vanished, probably because another process pruned the1156 * directory while we were working. To be robust against this kind of1157 * race, callers might want to try invoking the function again when it1158 * returns SCLD_VANISHED.1159 *1160 * safe_create_leading_directories() temporarily changes path while it1161 * is working but restores it before returning.1162 * safe_create_leading_directories_const() doesn't modify path, even1163 * temporarily.1164 */1165enum scld_error {1166 SCLD_OK =0,1167 SCLD_FAILED = -1,1168 SCLD_PERMS = -2,1169 SCLD_EXISTS = -3,1170 SCLD_VANISHED = -41171};1172enum scld_error safe_create_leading_directories(char*path);1173enum scld_error safe_create_leading_directories_const(const char*path);11741175/*1176 * Callback function for raceproof_create_file(). This function is1177 * expected to do something that makes dirname(path) permanent despite1178 * the fact that other processes might be cleaning up empty1179 * directories at the same time. Usually it will create a file named1180 * path, but alternatively it could create another file in that1181 * directory, or even chdir() into that directory. The function should1182 * return 0 if the action was completed successfully. On error, it1183 * should return a nonzero result and set errno.1184 * raceproof_create_file() treats two errno values specially:1185 *1186 * - ENOENT -- dirname(path) does not exist. In this case,1187 * raceproof_create_file() tries creating dirname(path)1188 * (and any parent directories, if necessary) and calls1189 * the function again.1190 *1191 * - EISDIR -- the file already exists and is a directory. In this1192 * case, raceproof_create_file() removes the directory if1193 * it is empty (and recursively any empty directories that1194 * it contains) and calls the function again.1195 *1196 * Any other errno causes raceproof_create_file() to fail with the1197 * callback's return value and errno.1198 *1199 * Obviously, this function should be OK with being called again if it1200 * fails with ENOENT or EISDIR. In other scenarios it will not be1201 * called again.1202 */1203typedefintcreate_file_fn(const char*path,void*cb);12041205/*1206 * Create a file in dirname(path) by calling fn, creating leading1207 * directories if necessary. Retry a few times in case we are racing1208 * with another process that is trying to clean up the directory that1209 * contains path. See the documentation for create_file_fn for more1210 * details.1211 *1212 * Return the value and set the errno that resulted from the most1213 * recent call of fn. fn is always called at least once, and will be1214 * called more than once if it returns ENOENT or EISDIR.1215 */1216intraceproof_create_file(const char*path, create_file_fn fn,void*cb);12171218intmkdir_in_gitdir(const char*path);1219externchar*expand_user_path(const char*path,int real_home);1220const char*enter_repo(const char*path,int strict);1221staticinlineintis_absolute_path(const char*path)1222{1223returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1224}1225intis_directory(const char*);1226char*strbuf_realpath(struct strbuf *resolved,const char*path,1227int die_on_error);1228const char*real_path(const char*path);1229const char*real_path_if_valid(const char*path);1230char*real_pathdup(const char*path,int die_on_error);1231const char*absolute_path(const char*path);1232char*absolute_pathdup(const char*path);1233const char*remove_leading_path(const char*in,const char*prefix);1234const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1235intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1236intnormalize_path_copy(char*dst,const char*src);1237intlongest_ancestor_length(const char*path,struct string_list *prefixes);1238char*strip_path_suffix(const char*path,const char*suffix);1239intdaemon_avoid_alias(const char*path);12401241/*1242 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for1243 * details.1244 */1245intis_ntfs_dotgit(const char*name);1246intis_ntfs_dotgitmodules(const char*name);1247intis_ntfs_dotgitignore(const char*name);1248intis_ntfs_dotgitattributes(const char*name);12491250/*1251 * Returns true iff "str" could be confused as a command-line option when1252 * passed to a sub-program like "ssh". Note that this has nothing to do with1253 * shell-quoting, which should be handled separately; we're assuming here that1254 * the string makes it verbatim to the sub-program.1255 */1256intlooks_like_command_line_option(const char*str);12571258/**1259 * Return a newly allocated string with the evaluation of1260 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1261 * "$HOME/.config/git/$filename". Return NULL upon error.1262 */1263externchar*xdg_config_home(const char*filename);12641265/**1266 * Return a newly allocated string with the evaluation of1267 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1268 * "$HOME/.cache/git/$filename". Return NULL upon error.1269 */1270externchar*xdg_cache_home(const char*filename);12711272externintgit_open_cloexec(const char*name,int flags);1273#define git_open(name) git_open_cloexec(name, O_RDONLY)1274externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1275externintparse_sha1_header(const char*hdr,unsigned long*sizep);12761277externintcheck_object_signature(const struct object_id *oid,void*buf,unsigned long size,const char*type);12781279externintfinalize_object_file(const char*tmpfile,const char*filename);12801281/* Helper to check and "touch" a file */1282externintcheck_and_freshen_file(const char*fn,int freshen);12831284externconst signed char hexval_table[256];1285staticinlineunsigned inthexval(unsigned char c)1286{1287return hexval_table[c];1288}12891290/*1291 * Convert two consecutive hexadecimal digits into a char. Return a1292 * negative value on error. Don't run over the end of short strings.1293 */1294staticinlineinthex2chr(const char*s)1295{1296unsigned int val =hexval(s[0]);1297return(val & ~0xf) ? val : (val <<4) |hexval(s[1]);1298}12991300/* Convert to/from hex/sha1 representation */1301#define MINIMUM_ABBREV minimum_abbrev1302#define DEFAULT_ABBREV default_abbrev13031304/* used when the code does not know or care what the default abbrev is */1305#define FALLBACK_DEFAULT_ABBREV 713061307struct object_context {1308unsigned mode;1309/*1310 * symlink_path is only used by get_tree_entry_follow_symlinks,1311 * and only for symlinks that point outside the repository.1312 */1313struct strbuf symlink_path;1314/*1315 * If GET_OID_RECORD_PATH is set, this will record path (if any)1316 * found when resolving the name. The caller is responsible for1317 * releasing the memory.1318 */1319char*path;1320};13211322#define GET_OID_QUIETLY 011323#define GET_OID_COMMIT 021324#define GET_OID_COMMITTISH 041325#define GET_OID_TREE 0101326#define GET_OID_TREEISH 0201327#define GET_OID_BLOB 0401328#define GET_OID_FOLLOW_SYMLINKS 01001329#define GET_OID_RECORD_PATH 02001330#define GET_OID_ONLY_TO_DIE 0400013311332#define GET_OID_DISAMBIGUATORS \1333 (GET_OID_COMMIT | GET_OID_COMMITTISH | \1334 GET_OID_TREE | GET_OID_TREEISH | \1335 GET_OID_BLOB)13361337externintget_oid(const char*str,struct object_id *oid);1338externintget_oid_commit(const char*str,struct object_id *oid);1339externintget_oid_committish(const char*str,struct object_id *oid);1340externintget_oid_tree(const char*str,struct object_id *oid);1341externintget_oid_treeish(const char*str,struct object_id *oid);1342externintget_oid_blob(const char*str,struct object_id *oid);1343externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1344externintget_oid_with_context(const char*str,unsigned flags,struct object_id *oid,struct object_context *oc);134513461347typedefinteach_abbrev_fn(const struct object_id *oid,void*);1348externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13491350externintset_disambiguate_hint_config(const char*var,const char*value);13511352/*1353 * Try to read a SHA1 in hexadecimal format from the 40 characters1354 * starting at hex. Write the 20-byte result to sha1 in binary form.1355 * Return 0 on success. Reading stops if a NUL is encountered in the1356 * input, so it is safe to pass this function an arbitrary1357 * null-terminated string.1358 */1359externintget_sha1_hex(const char*hex,unsigned char*sha1);1360externintget_oid_hex(const char*hex,struct object_id *sha1);13611362/*1363 * Read `len` pairs of hexadecimal digits from `hex` and write the1364 * values to `binary` as `len` bytes. Return 0 on success, or -1 if1365 * the input does not consist of hex digits).1366 */1367externinthex_to_bytes(unsigned char*binary,const char*hex,size_t len);13681369/*1370 * Convert a binary hash to its hex equivalent. The `_r` variant is reentrant,1371 * and writes the NUL-terminated output to the buffer `out`, which must be at1372 * least `GIT_MAX_HEXSZ + 1` bytes, and returns a pointer to out for1373 * convenience.1374 *1375 * The non-`_r` variant returns a static buffer, but uses a ring of 41376 * buffers, making it safe to make multiple calls for a single statement, like:1377 *1378 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1379 */1380char*hash_to_hex_algop_r(char*buffer,const unsigned char*hash,const struct git_hash_algo *);1381char*sha1_to_hex_r(char*out,const unsigned char*sha1);1382char*oid_to_hex_r(char*out,const struct object_id *oid);1383char*hash_to_hex_algop(const unsigned char*hash,const struct git_hash_algo *);/* static buffer result! */1384char*sha1_to_hex(const unsigned char*sha1);/* same static buffer */1385char*hash_to_hex(const unsigned char*hash);/* same static buffer */1386char*oid_to_hex(const struct object_id *oid);/* same static buffer */13871388/*1389 * Parse a 40-character hexadecimal object ID starting from hex, updating the1390 * pointer specified by end when parsing stops. The resulting object ID is1391 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1392 * other invalid character. end is only updated on success; otherwise, it is1393 * unmodified.1394 */1395externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);13961397/*1398 * This reads short-hand syntax that not only evaluates to a commit1399 * object name, but also can act as if the end user spelled the name1400 * of the branch from the command line.1401 *1402 * - "@{-N}" finds the name of the Nth previous branch we were on, and1403 * places the name of the branch in the given buf and returns the1404 * number of characters parsed if successful.1405 *1406 * - "<branch>@{upstream}" finds the name of the other ref that1407 * <branch> is configured to merge with (missing <branch> defaults1408 * to the current branch), and places the name of the branch in the1409 * given buf and returns the number of characters parsed if1410 * successful.1411 *1412 * If the input is not of the accepted format, it returns a negative1413 * number to signal an error.1414 *1415 * If the input was ok but there are not N branch switches in the1416 * reflog, it returns 0.1417 *1418 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1419 * expansions: local branches ("refs/heads/"), remote branches1420 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1421 * allowed, even ones to refs outside of those namespaces.1422 */1423#define INTERPRET_BRANCH_LOCAL (1<<0)1424#define INTERPRET_BRANCH_REMOTE (1<<1)1425#define INTERPRET_BRANCH_HEAD (1<<2)1426externintinterpret_branch_name(const char*str,int len,struct strbuf *,1427unsigned allowed);1428externintget_oid_mb(const char*str,struct object_id *oid);14291430externintvalidate_headref(const char*ref);14311432externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1433externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1434externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1435externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);14361437externvoid*read_object_with_reference(const struct object_id *oid,1438const char*required_type,1439unsigned long*size,1440struct object_id *oid_ret);14411442externstruct object *peel_to_type(const char*name,int namelen,1443struct object *o,enum object_type);14441445enum date_mode_type {1446 DATE_NORMAL =0,1447 DATE_RELATIVE,1448 DATE_SHORT,1449 DATE_ISO8601,1450 DATE_ISO8601_STRICT,1451 DATE_RFC2822,1452 DATE_STRFTIME,1453 DATE_RAW,1454 DATE_UNIX1455};14561457struct date_mode {1458enum date_mode_type type;1459const char*strftime_fmt;1460int local;1461};14621463/*1464 * Convenience helper for passing a constant type, like:1465 *1466 * show_date(t, tz, DATE_MODE(NORMAL));1467 */1468#define DATE_MODE(t) date_mode_from_type(DATE_##t)1469struct date_mode *date_mode_from_type(enum date_mode_type type);14701471const char*show_date(timestamp_t time,int timezone,const struct date_mode *mode);1472voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1473struct strbuf *timebuf);1474intparse_date(const char*date,struct strbuf *out);1475intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1476intparse_expiry_date(const char*date, timestamp_t *timestamp);1477voiddatestamp(struct strbuf *out);1478#define approxidate(s) approxidate_careful((s), NULL)1479timestamp_t approxidate_careful(const char*,int*);1480timestamp_t approxidate_relative(const char*date,const struct timeval *now);1481voidparse_date_format(const char*format,struct date_mode *mode);1482intdate_overflows(timestamp_t date);14831484#define IDENT_STRICT 11485#define IDENT_NO_DATE 21486#define IDENT_NO_NAME 41487externconst char*git_author_info(int);1488externconst char*git_committer_info(int);1489externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1490externconst char*fmt_name(const char*name,const char*email);1491externconst char*ident_default_name(void);1492externconst char*ident_default_email(void);1493externconst char*git_editor(void);1494externconst char*git_pager(int stdout_is_tty);1495externintis_terminal_dumb(void);1496externintgit_ident_config(const char*,const char*,void*);1497externvoidreset_ident_date(void);14981499struct ident_split {1500const char*name_begin;1501const char*name_end;1502const char*mail_begin;1503const char*mail_end;1504const char*date_begin;1505const char*date_end;1506const char*tz_begin;1507const char*tz_end;1508};1509/*1510 * Signals an success with 0, but time part of the result may be NULL1511 * if the input lacks timestamp and zone1512 */1513externintsplit_ident_line(struct ident_split *,const char*,int);15141515/*1516 * Like show_date, but pull the timestamp and tz parameters from1517 * the ident_split. It will also sanity-check the values and produce1518 * a well-known sentinel date if they appear bogus.1519 */1520const char*show_ident_date(const struct ident_split *id,1521const struct date_mode *mode);15221523/*1524 * Compare split idents for equality or strict ordering. Note that we1525 * compare only the ident part of the line, ignoring any timestamp.1526 *1527 * Because there are two fields, we must choose one as the primary key; we1528 * currently arbitrarily pick the email.1529 */1530externintident_cmp(const struct ident_split *,const struct ident_split *);15311532struct checkout {1533struct index_state *istate;1534const char*base_dir;1535int base_dir_len;1536struct delayed_checkout *delayed_checkout;1537unsigned force:1,1538 quiet:1,1539 not_new:1,1540 clone:1,1541 refresh_cache:1;1542};1543#define CHECKOUT_INIT { NULL,"" }15441545#define TEMPORARY_FILENAME_LENGTH 251546externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);1547externvoidenable_delayed_checkout(struct checkout *state);1548externintfinish_delayed_checkout(struct checkout *state);15491550struct cache_def {1551struct strbuf path;1552int flags;1553int track_flags;1554int prefix_len_stat_func;1555};1556#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1557staticinlinevoidcache_def_clear(struct cache_def *cache)1558{1559strbuf_release(&cache->path);1560}15611562externinthas_symlink_leading_path(const char*name,int len);1563externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1564externintcheck_leading_path(const char*name,int len);1565externinthas_dirs_only_path(const char*name,int len,int prefix_len);1566externvoidschedule_dir_for_removal(const char*name,int len);1567externvoidremove_scheduled_dirs(void);15681569struct pack_window {1570struct pack_window *next;1571unsigned char*base;1572 off_t offset;1573size_t len;1574unsigned int last_used;1575unsigned int inuse_cnt;1576};15771578struct pack_entry {1579 off_t offset;1580struct packed_git *p;1581};15821583/*1584 * Create a temporary file rooted in the object database directory, or1585 * die on failure. The filename is taken from "pattern", which should have the1586 * usual "XXXXXX" trailer, and the resulting filename is written into the1587 * "template" buffer. Returns the open descriptor.1588 */1589externintodb_mkstemp(struct strbuf *temp_filename,const char*pattern);15901591/*1592 * Create a pack .keep file named "name" (which should generally be the output1593 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1594 * error.1595 */1596externintodb_pack_keep(const char*name);15971598/*1599 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing1600 * blobs. This has a difference only if extensions.partialClone is set.1601 *1602 * Its default value is 1.1603 */1604externint fetch_if_missing;16051606/* Dumb servers support */1607externintupdate_server_info(int);16081609externconst char*get_log_output_encoding(void);1610externconst char*get_commit_output_encoding(void);16111612/*1613 * This is a hack for test programs like test-dump-untracked-cache to1614 * ensure that they do not modify the untracked cache when reading it.1615 * Do not use it otherwise!1616 */1617externint ignore_untracked_cache_config;16181619externintcommitter_ident_sufficiently_given(void);1620externintauthor_ident_sufficiently_given(void);16211622externconst char*git_commit_encoding;1623externconst char*git_log_output_encoding;1624externconst char*git_mailmap_file;1625externconst char*git_mailmap_blob;16261627/* IO helper functions */1628externvoidmaybe_flush_or_die(FILE*,const char*);1629__attribute__((format(printf,2,3)))1630externvoidfprintf_or_die(FILE*,const char*fmt, ...);16311632#define COPY_READ_ERROR (-2)1633#define COPY_WRITE_ERROR (-3)1634externintcopy_fd(int ifd,int ofd);1635externintcopy_file(const char*dst,const char*src,int mode);1636externintcopy_file_with_time(const char*dst,const char*src,int mode);16371638externvoidwrite_or_die(int fd,const void*buf,size_t count);1639externvoidfsync_or_die(int fd,const char*);16401641extern ssize_t read_in_full(int fd,void*buf,size_t count);1642extern ssize_t write_in_full(int fd,const void*buf,size_t count);1643extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);16441645staticinline ssize_t write_str_in_full(int fd,const char*str)1646{1647returnwrite_in_full(fd, str,strlen(str));1648}16491650/**1651 * Open (and truncate) the file at path, write the contents of buf to it,1652 * and close it. Dies if any errors are encountered.1653 */1654externvoidwrite_file_buf(const char*path,const char*buf,size_t len);16551656/**1657 * Like write_file_buf(), but format the contents into a buffer first.1658 * Additionally, write_file() will append a newline if one is not already1659 * present, making it convenient to write text files:1660 *1661 * write_file(path, "counter: %d", ctr);1662 */1663__attribute__((format(printf,2,3)))1664externvoidwrite_file(const char*path,const char*fmt, ...);16651666/* pager.c */1667externvoidsetup_pager(void);1668externintpager_in_use(void);1669externint pager_use_color;1670externintterm_columns(void);1671externintdecimal_width(uintmax_t);1672externintcheck_pager_config(const char*cmd);1673externvoidprepare_pager_args(struct child_process *,const char*pager);16741675externconst char*editor_program;1676externconst char*askpass_program;1677externconst char*excludes_file;16781679/* base85 */1680intdecode_85(char*dst,const char*line,int linelen);1681voidencode_85(char*buf,const unsigned char*data,int bytes);16821683/* pkt-line.c */1684voidpacket_trace_identity(const char*prog);16851686/* add */1687/*1688 * return 0 if success, 1 - if addition of a file failed and1689 * ADD_FILES_IGNORE_ERRORS was specified in flags1690 */1691intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);16921693/* diff.c */1694externint diff_auto_refresh_index;16951696/* match-trees.c */1697voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1698voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);16991700/*1701 * whitespace rules.1702 * used by both diff and apply1703 * last two digits are tab width1704 */1705#define WS_BLANK_AT_EOL 01001706#define WS_SPACE_BEFORE_TAB 02001707#define WS_INDENT_WITH_NON_TAB 04001708#define WS_CR_AT_EOL 010001709#define WS_BLANK_AT_EOF 020001710#define WS_TAB_IN_INDENT 040001711#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1712#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1713#define WS_TAB_WIDTH_MASK 0771714/* All WS_* -- when extended, adapt diff.c emit_symbol */1715#define WS_RULE_MASK 077771716externunsigned whitespace_rule_cfg;1717externunsignedwhitespace_rule(const char*);1718externunsignedparse_whitespace_rule(const char*);1719externunsignedws_check(const char*line,int len,unsigned ws_rule);1720externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1721externchar*whitespace_error_string(unsigned ws);1722externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1723externintws_blank_line(const char*line,int len,unsigned ws_rule);1724#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)17251726/* ls-files */1727voidoverlay_tree_on_index(struct index_state *istate,1728const char*tree_name,const char*prefix);17291730/* setup.c */1731struct startup_info {1732int have_repository;1733const char*prefix;1734};1735externstruct startup_info *startup_info;17361737/* merge.c */1738struct commit_list;1739inttry_merge_command(const char*strategy,size_t xopts_nr,1740const char**xopts,struct commit_list *common,1741const char*head_arg,struct commit_list *remotes);1742intcheckout_fast_forward(const struct object_id *from,1743const struct object_id *to,1744int overwrite_ignore);174517461747intsane_execvp(const char*file,char*const argv[]);17481749/*1750 * A struct to encapsulate the concept of whether a file has changed1751 * since we last checked it. This uses criteria similar to those used1752 * for the index.1753 */1754struct stat_validity {1755struct stat_data *sd;1756};17571758voidstat_validity_clear(struct stat_validity *sv);17591760/*1761 * Returns 1 if the path is a regular file (or a symlink to a regular1762 * file) and matches the saved stat_validity, 0 otherwise. A missing1763 * or inaccessible file is considered a match if the struct was just1764 * initialized, or if the previous update found an inaccessible file.1765 */1766intstat_validity_check(struct stat_validity *sv,const char*path);17671768/*1769 * Update the stat_validity from a file opened at descriptor fd. If1770 * the file is missing, inaccessible, or not a regular file, then1771 * future calls to stat_validity_check will match iff one of those1772 * conditions continues to be true.1773 */1774voidstat_validity_update(struct stat_validity *sv,int fd);17751776intversioncmp(const char*s1,const char*s2);1777voidsleep_millisec(int millisec);17781779/*1780 * Create a directory and (if share is nonzero) adjust its permissions1781 * according to the shared_repository setting. Only use this for1782 * directories under $GIT_DIR. Don't use it for working tree1783 * directories.1784 */1785voidsafe_create_dir(const char*dir,int share);17861787/*1788 * Should we print an ellipsis after an abbreviated SHA-1 value1789 * when doing diff-raw output or indicating a detached HEAD?1790 */1791externintprint_sha1_ellipsis(void);17921793#endif/* CACHE_H */