1#ifndef CACHE_H 2#define CACHE_H 3 4#include"git-compat-util.h" 5#include"strbuf.h" 6#include"hashmap.h" 7#include"advice.h" 8#include"gettext.h" 9#include"convert.h" 10#include"trace.h" 11#include"string-list.h" 12#include"pack-revindex.h" 13#include"hash.h" 14#include"path.h" 15#include"sha1-array.h" 16 17#ifndef platform_SHA_CTX 18/* 19 * platform's underlying implementation of SHA-1; could be OpenSSL, 20 * blk_SHA, Apple CommonCrypto, etc... Note that including 21 * SHA1_HEADER may have already defined platform_SHA_CTX for our 22 * own implementations like block-sha1 and ppc-sha1, so we list 23 * the default for OpenSSL compatible SHA-1 implementations here. 24 */ 25#define platform_SHA_CTX SHA_CTX 26#define platform_SHA1_Init SHA1_Init 27#define platform_SHA1_Update SHA1_Update 28#define platform_SHA1_Final SHA1_Final 29#endif 30 31#define git_SHA_CTX platform_SHA_CTX 32#define git_SHA1_Init platform_SHA1_Init 33#define git_SHA1_Update platform_SHA1_Update 34#define git_SHA1_Final platform_SHA1_Final 35 36#ifdef SHA1_MAX_BLOCK_SIZE 37#include"compat/sha1-chunked.h" 38#undef git_SHA1_Update 39#define git_SHA1_Update git_SHA1_Update_Chunked 40#endif 41 42#include <zlib.h> 43typedefstruct git_zstream { 44 z_stream z; 45unsigned long avail_in; 46unsigned long avail_out; 47unsigned long total_in; 48unsigned long total_out; 49unsigned char*next_in; 50unsigned char*next_out; 51} git_zstream; 52 53voidgit_inflate_init(git_zstream *); 54voidgit_inflate_init_gzip_only(git_zstream *); 55voidgit_inflate_end(git_zstream *); 56intgit_inflate(git_zstream *,int flush); 57 58voidgit_deflate_init(git_zstream *,int level); 59voidgit_deflate_init_gzip(git_zstream *,int level); 60voidgit_deflate_init_raw(git_zstream *,int level); 61voidgit_deflate_end(git_zstream *); 62intgit_deflate_abort(git_zstream *); 63intgit_deflate_end_gently(git_zstream *); 64intgit_deflate(git_zstream *,int flush); 65unsigned longgit_deflate_bound(git_zstream *,unsigned long); 66 67/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 68#define GIT_SHA1_RAWSZ 20 69#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 70 71/* The length in byte and in hex digits of the largest possible hash value. */ 72#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 73#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 74 75struct object_id { 76unsigned char hash[GIT_MAX_RAWSZ]; 77}; 78 79#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 80#define DTYPE(de) ((de)->d_type) 81#else 82#undef DT_UNKNOWN 83#undef DT_DIR 84#undef DT_REG 85#undef DT_LNK 86#define DT_UNKNOWN 0 87#define DT_DIR 1 88#define DT_REG 2 89#define DT_LNK 3 90#define DTYPE(de) DT_UNKNOWN 91#endif 92 93/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 94#define S_IFINVALID 0030000 95 96/* 97 * A "directory link" is a link to another git directory. 98 * 99 * The value 0160000 is not normally a valid mode, and 100 * also just happens to be S_IFDIR + S_IFLNK 101 */ 102#define S_IFGITLINK 0160000 103#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 104 105/* 106 * Some mode bits are also used internally for computations. 107 * 108 * They *must* not overlap with any valid modes, and they *must* not be emitted 109 * to outside world - i.e. appear on disk or network. In other words, it's just 110 * temporary fields, which we internally use, but they have to stay in-house. 111 * 112 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 113 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 114 */ 115 116/* used internally in tree-diff */ 117#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 118 119 120/* 121 * Intensive research over the course of many years has shown that 122 * port 9418 is totally unused by anything else. Or 123 * 124 * Your search - "port 9418" - did not match any documents. 125 * 126 * as www.google.com puts it. 127 * 128 * This port has been properly assigned for git use by IANA: 129 * git (Assigned-9418) [I06-050728-0001]. 130 * 131 * git 9418/tcp git pack transfer service 132 * git 9418/udp git pack transfer service 133 * 134 * with Linus Torvalds <torvalds@osdl.org> as the point of 135 * contact. September 2005. 136 * 137 * See http://www.iana.org/assignments/port-numbers 138 */ 139#define DEFAULT_GIT_PORT 9418 140 141/* 142 * Basic data structures for the directory cache 143 */ 144 145#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 146struct cache_header { 147uint32_t hdr_signature; 148uint32_t hdr_version; 149uint32_t hdr_entries; 150}; 151 152#define INDEX_FORMAT_LB 2 153#define INDEX_FORMAT_UB 4 154 155/* 156 * The "cache_time" is just the low 32 bits of the 157 * time. It doesn't matter if it overflows - we only 158 * check it for equality in the 32 bits we save. 159 */ 160struct cache_time { 161uint32_t sec; 162uint32_t nsec; 163}; 164 165struct stat_data { 166struct cache_time sd_ctime; 167struct cache_time sd_mtime; 168unsigned int sd_dev; 169unsigned int sd_ino; 170unsigned int sd_uid; 171unsigned int sd_gid; 172unsigned int sd_size; 173}; 174 175struct cache_entry { 176struct hashmap_entry ent; 177struct stat_data ce_stat_data; 178unsigned int ce_mode; 179unsigned int ce_flags; 180unsigned int ce_namelen; 181unsigned int index;/* for link extension */ 182struct object_id oid; 183char name[FLEX_ARRAY];/* more */ 184}; 185 186#define CE_STAGEMASK (0x3000) 187#define CE_EXTENDED (0x4000) 188#define CE_VALID (0x8000) 189#define CE_STAGESHIFT 12 190 191/* 192 * Range 0xFFFF0FFF in ce_flags is divided into 193 * two parts: in-memory flags and on-disk ones. 194 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 195 * if you want to save a new flag, add it in 196 * CE_EXTENDED_FLAGS 197 * 198 * In-memory only flags 199 */ 200#define CE_UPDATE (1 << 16) 201#define CE_REMOVE (1 << 17) 202#define CE_UPTODATE (1 << 18) 203#define CE_ADDED (1 << 19) 204 205#define CE_HASHED (1 << 20) 206#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 207#define CE_CONFLICTED (1 << 23) 208 209#define CE_UNPACKED (1 << 24) 210#define CE_NEW_SKIP_WORKTREE (1 << 25) 211 212/* used to temporarily mark paths matched by pathspecs */ 213#define CE_MATCHED (1 << 26) 214 215#define CE_UPDATE_IN_BASE (1 << 27) 216#define CE_STRIP_NAME (1 << 28) 217 218/* 219 * Extended on-disk flags 220 */ 221#define CE_INTENT_TO_ADD (1 << 29) 222#define CE_SKIP_WORKTREE (1 << 30) 223/* CE_EXTENDED2 is for future extension */ 224#define CE_EXTENDED2 (1U << 31) 225 226#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 227 228/* 229 * Safeguard to avoid saving wrong flags: 230 * - CE_EXTENDED2 won't get saved until its semantic is known 231 * - Bits in 0x0000FFFF have been saved in ce_flags already 232 * - Bits in 0x003F0000 are currently in-memory flags 233 */ 234#if CE_EXTENDED_FLAGS & 0x803FFFFF 235#error"CE_EXTENDED_FLAGS out of range" 236#endif 237 238/* Forward structure decls */ 239struct pathspec; 240struct child_process; 241 242/* 243 * Copy the sha1 and stat state of a cache entry from one to 244 * another. But we never change the name, or the hash state! 245 */ 246staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 247const struct cache_entry *src) 248{ 249unsigned int state = dst->ce_flags & CE_HASHED; 250 251/* Don't copy hash chain and name */ 252memcpy(&dst->ce_stat_data, &src->ce_stat_data, 253offsetof(struct cache_entry, name) - 254offsetof(struct cache_entry, ce_stat_data)); 255 256/* Restore the hash state */ 257 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 258} 259 260staticinlineunsignedcreate_ce_flags(unsigned stage) 261{ 262return(stage << CE_STAGESHIFT); 263} 264 265#define ce_namelen(ce) ((ce)->ce_namelen) 266#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 267#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 268#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 269#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 270#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 271#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 272 273#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 274staticinlineunsigned intcreate_ce_mode(unsigned int mode) 275{ 276if(S_ISLNK(mode)) 277return S_IFLNK; 278if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 279return S_IFGITLINK; 280return S_IFREG |ce_permissions(mode); 281} 282staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 283unsigned int mode) 284{ 285externint trust_executable_bit, has_symlinks; 286if(!has_symlinks &&S_ISREG(mode) && 287 ce &&S_ISLNK(ce->ce_mode)) 288return ce->ce_mode; 289if(!trust_executable_bit &&S_ISREG(mode)) { 290if(ce &&S_ISREG(ce->ce_mode)) 291return ce->ce_mode; 292returncreate_ce_mode(0666); 293} 294returncreate_ce_mode(mode); 295} 296staticinlineintce_to_dtype(const struct cache_entry *ce) 297{ 298unsigned ce_mode =ntohl(ce->ce_mode); 299if(S_ISREG(ce_mode)) 300return DT_REG; 301else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 302return DT_DIR; 303else if(S_ISLNK(ce_mode)) 304return DT_LNK; 305else 306return DT_UNKNOWN; 307} 308staticinlineunsigned intcanon_mode(unsigned int mode) 309{ 310if(S_ISREG(mode)) 311return S_IFREG |ce_permissions(mode); 312if(S_ISLNK(mode)) 313return S_IFLNK; 314if(S_ISDIR(mode)) 315return S_IFDIR; 316return S_IFGITLINK; 317} 318 319#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 320 321#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 322#define CE_ENTRY_CHANGED (1 << 1) 323#define CE_ENTRY_REMOVED (1 << 2) 324#define CE_ENTRY_ADDED (1 << 3) 325#define RESOLVE_UNDO_CHANGED (1 << 4) 326#define CACHE_TREE_CHANGED (1 << 5) 327#define SPLIT_INDEX_ORDERED (1 << 6) 328#define UNTRACKED_CHANGED (1 << 7) 329 330struct split_index; 331struct untracked_cache; 332 333struct index_state { 334struct cache_entry **cache; 335unsigned int version; 336unsigned int cache_nr, cache_alloc, cache_changed; 337struct string_list *resolve_undo; 338struct cache_tree *cache_tree; 339struct split_index *split_index; 340struct cache_time timestamp; 341unsigned name_hash_initialized :1, 342 initialized :1; 343struct hashmap name_hash; 344struct hashmap dir_hash; 345unsigned char sha1[20]; 346struct untracked_cache *untracked; 347}; 348 349externstruct index_state the_index; 350 351/* Name hashing */ 352externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 353externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 354externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 355externvoidfree_name_hash(struct index_state *istate); 356 357 358#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 359#define active_cache (the_index.cache) 360#define active_nr (the_index.cache_nr) 361#define active_alloc (the_index.cache_alloc) 362#define active_cache_changed (the_index.cache_changed) 363#define active_cache_tree (the_index.cache_tree) 364 365#define read_cache() read_index(&the_index) 366#define read_cache_from(path) read_index_from(&the_index, (path)) 367#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 368#define is_cache_unborn() is_index_unborn(&the_index) 369#define read_cache_unmerged() read_index_unmerged(&the_index) 370#define discard_cache() discard_index(&the_index) 371#define unmerged_cache() unmerged_index(&the_index) 372#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 373#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 374#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 375#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 376#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 377#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 378#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 379#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 380#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 381#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 382#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 383#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 384#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 385#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 386#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 387#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 388#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 389#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 390#endif 391 392enum object_type { 393 OBJ_BAD = -1, 394 OBJ_NONE =0, 395 OBJ_COMMIT =1, 396 OBJ_TREE =2, 397 OBJ_BLOB =3, 398 OBJ_TAG =4, 399/* 5 for future expansion */ 400 OBJ_OFS_DELTA =6, 401 OBJ_REF_DELTA =7, 402 OBJ_ANY, 403 OBJ_MAX 404}; 405 406staticinlineenum object_type object_type(unsigned int mode) 407{ 408returnS_ISDIR(mode) ? OBJ_TREE : 409S_ISGITLINK(mode) ? OBJ_COMMIT : 410 OBJ_BLOB; 411} 412 413/* Double-check local_repo_env below if you add to this list. */ 414#define GIT_DIR_ENVIRONMENT"GIT_DIR" 415#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 416#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 417#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 418#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 419#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 420#define GIT_TOPLEVEL_PREFIX_ENVIRONMENT"GIT_INTERNAL_TOPLEVEL_PREFIX" 421#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 422#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 423#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 424#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 425#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 426#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 427#define CONFIG_ENVIRONMENT"GIT_CONFIG" 428#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 429#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 430#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 431#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 432#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 433#define GITATTRIBUTES_FILE".gitattributes" 434#define INFOATTRIBUTES_FILE"info/attributes" 435#define ATTRIBUTE_MACRO_PREFIX"[attr]" 436#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 437#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 438#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 439#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 440#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 441#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 442#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 443#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 444#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 445#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 446 447/* 448 * This environment variable is expected to contain a boolean indicating 449 * whether we should or should not treat: 450 * 451 * GIT_DIR=foo.git git ... 452 * 453 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 454 * of this, but we use it internally to communicate to sub-processes that we 455 * are in a bare repo. If not set, defaults to true. 456 */ 457#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 458 459/* 460 * Repository-local GIT_* environment variables; these will be cleared 461 * when git spawns a sub-process that runs inside another repository. 462 * The array is NULL-terminated, which makes it easy to pass in the "env" 463 * parameter of a run-command invocation, or to do a simple walk. 464 */ 465externconst char*const local_repo_env[]; 466 467externvoidsetup_git_env(void); 468 469/* 470 * Returns true iff we have a configured git repository (either via 471 * setup_git_directory, or in the environment via $GIT_DIR). 472 */ 473inthave_git_dir(void); 474 475externint is_bare_repository_cfg; 476externintis_bare_repository(void); 477externintis_inside_git_dir(void); 478externchar*git_work_tree_cfg; 479externintis_inside_work_tree(void); 480externconst char*get_git_dir(void); 481externconst char*get_git_common_dir(void); 482externchar*get_object_directory(void); 483externchar*get_index_file(void); 484externchar*get_graft_file(void); 485externintset_git_dir(const char*path); 486externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 487externintget_common_dir(struct strbuf *sb,const char*gitdir); 488externconst char*get_git_namespace(void); 489externconst char*strip_namespace(const char*namespaced_ref); 490externconst char*get_super_prefix(void); 491externconst char*get_git_work_tree(void); 492 493/* 494 * Return true if the given path is a git directory; note that this _just_ 495 * looks at the directory itself. If you want to know whether "foo/.git" 496 * is a repository, you must feed that path, not just "foo". 497 */ 498externintis_git_directory(const char*path); 499 500/* 501 * Return 1 if the given path is the root of a git repository or 502 * submodule, else 0. Will not return 1 for bare repositories with the 503 * exception of creating a bare repository in "foo/.git" and calling 504 * is_git_repository("foo"). 505 * 506 * If we run into read errors, we err on the side of saying "yes, it is", 507 * as we usually consider sub-repos precious, and would prefer to err on the 508 * side of not disrupting or deleting them. 509 */ 510externintis_nonbare_repository_dir(struct strbuf *path); 511 512#define READ_GITFILE_ERR_STAT_FAILED 1 513#define READ_GITFILE_ERR_NOT_A_FILE 2 514#define READ_GITFILE_ERR_OPEN_FAILED 3 515#define READ_GITFILE_ERR_READ_FAILED 4 516#define READ_GITFILE_ERR_INVALID_FORMAT 5 517#define READ_GITFILE_ERR_NO_PATH 6 518#define READ_GITFILE_ERR_NOT_A_REPO 7 519#define READ_GITFILE_ERR_TOO_LARGE 8 520externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 521externconst char*read_gitfile_gently(const char*path,int*return_error_code); 522#define read_gitfile(path) read_gitfile_gently((path), NULL) 523externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 524#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 525 526externvoidset_git_work_tree(const char*tree); 527 528#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 529 530externvoidsetup_work_tree(void); 531/* 532 * Find the commondir and gitdir of the repository that contains the current 533 * working directory, without changing the working directory or other global 534 * state. The result is appended to commondir and gitdir. If the discovered 535 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 536 * both have the same result appended to the buffer. The return value is 537 * either 0 upon success and non-zero if no repository was found. 538 */ 539externintdiscover_git_directory(struct strbuf *commondir, 540struct strbuf *gitdir); 541externconst char*setup_git_directory_gently(int*); 542externconst char*setup_git_directory(void); 543externchar*prefix_path(const char*prefix,int len,const char*path); 544externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 545 546/* 547 * Concatenate "prefix" (if len is non-zero) and "path", with no 548 * connecting characters (so "prefix" should end with a "/"). 549 * Unlike prefix_path, this should be used if the named file does 550 * not have to interact with index entry; i.e. name of a random file 551 * on the filesystem. 552 * 553 * The return value is always a newly allocated string (even if the 554 * prefix was empty). 555 */ 556externchar*prefix_filename(const char*prefix,const char*path); 557 558externintcheck_filename(const char*prefix,const char*name); 559externvoidverify_filename(const char*prefix, 560const char*name, 561int diagnose_misspelt_rev); 562externvoidverify_non_filename(const char*prefix,const char*name); 563externintpath_inside_repo(const char*prefix,const char*path); 564 565#define INIT_DB_QUIET 0x0001 566#define INIT_DB_EXIST_OK 0x0002 567 568externintinit_db(const char*git_dir,const char*real_git_dir, 569const char*template_dir,unsigned int flags); 570 571externvoidsanitize_stdfds(void); 572externintdaemonize(void); 573 574#define alloc_nr(x) (((x)+16)*3/2) 575 576/* 577 * Realloc the buffer pointed at by variable 'x' so that it can hold 578 * at least 'nr' entries; the number of entries currently allocated 579 * is 'alloc', using the standard growing factor alloc_nr() macro. 580 * 581 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 582 */ 583#define ALLOC_GROW(x, nr, alloc) \ 584 do { \ 585 if ((nr) > alloc) { \ 586 if (alloc_nr(alloc) < (nr)) \ 587 alloc = (nr); \ 588 else \ 589 alloc = alloc_nr(alloc); \ 590 REALLOC_ARRAY(x, alloc); \ 591 } \ 592 } while (0) 593 594/* Initialize and use the cache information */ 595struct lock_file; 596externintread_index(struct index_state *); 597externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 598externintdo_read_index(struct index_state *istate,const char*path, 599int must_exist);/* for testting only! */ 600externintread_index_from(struct index_state *,const char*path); 601externintis_index_unborn(struct index_state *); 602externintread_index_unmerged(struct index_state *); 603#define COMMIT_LOCK (1 << 0) 604#define CLOSE_LOCK (1 << 1) 605externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 606externintdiscard_index(struct index_state *); 607externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 608externintunmerged_index(const struct index_state *); 609externintverify_path(const char*path); 610externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 611externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 612externvoidadjust_dirname_case(struct index_state *istate,char*name); 613externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 614 615/* 616 * Searches for an entry defined by name and namelen in the given index. 617 * If the return value is positive (including 0) it is the position of an 618 * exact match. If the return value is negative, the negated value minus 1 619 * is the position where the entry would be inserted. 620 * Example: The current index consists of these files and its stages: 621 * 622 * b#0, d#0, f#1, f#3 623 * 624 * index_name_pos(&index, "a", 1) -> -1 625 * index_name_pos(&index, "b", 1) -> 0 626 * index_name_pos(&index, "c", 1) -> -2 627 * index_name_pos(&index, "d", 1) -> 1 628 * index_name_pos(&index, "e", 1) -> -3 629 * index_name_pos(&index, "f", 1) -> -3 630 * index_name_pos(&index, "g", 1) -> -5 631 */ 632externintindex_name_pos(const struct index_state *,const char*name,int namelen); 633 634#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 635#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 636#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 637#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 638#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 639#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 640externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 641externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 642 643/* Remove entry, return true if there are more entries to go. */ 644externintremove_index_entry_at(struct index_state *,int pos); 645 646externvoidremove_marked_cache_entries(struct index_state *istate); 647externintremove_file_from_index(struct index_state *,const char*path); 648#define ADD_CACHE_VERBOSE 1 649#define ADD_CACHE_PRETEND 2 650#define ADD_CACHE_IGNORE_ERRORS 4 651#define ADD_CACHE_IGNORE_REMOVAL 8 652#define ADD_CACHE_INTENT 16 653/* 654 * These two are used to add the contents of the file at path 655 * to the index, marking the working tree up-to-date by storing 656 * the cached stat info in the resulting cache entry. A caller 657 * that has already run lstat(2) on the path can call 658 * add_to_index(), and all others can call add_file_to_index(); 659 * the latter will do necessary lstat(2) internally before 660 * calling the former. 661 */ 662externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 663externintadd_file_to_index(struct index_state *,const char*path,int flags); 664 665externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 666externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 667externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 668externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 669externintindex_name_is_other(const struct index_state *,const char*,int); 670externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 671 672/* do stat comparison even if CE_VALID is true */ 673#define CE_MATCH_IGNORE_VALID 01 674/* do not check the contents but report dirty on racily-clean entries */ 675#define CE_MATCH_RACY_IS_DIRTY 02 676/* do stat comparison even if CE_SKIP_WORKTREE is true */ 677#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 678/* ignore non-existent files during stat update */ 679#define CE_MATCH_IGNORE_MISSING 0x08 680/* enable stat refresh */ 681#define CE_MATCH_REFRESH 0x10 682externintie_match_stat(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 683externintie_modified(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 684 685#define HASH_WRITE_OBJECT 1 686#define HASH_FORMAT_CHECK 2 687externintindex_fd(unsigned char*sha1,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 688externintindex_path(unsigned char*sha1,const char*path,struct stat *st,unsigned flags); 689 690/* 691 * Record to sd the data from st that we use to check whether a file 692 * might have changed. 693 */ 694externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 695 696/* 697 * Return 0 if st is consistent with a file not having been changed 698 * since sd was filled. If there are differences, return a 699 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 700 * INODE_CHANGED, and DATA_CHANGED. 701 */ 702externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 703externintmatch_stat_data_racy(const struct index_state *istate, 704const struct stat_data *sd,struct stat *st); 705 706externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 707 708#define REFRESH_REALLY 0x0001/* ignore_valid */ 709#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 710#define REFRESH_QUIET 0x0004/* be quiet about it */ 711#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 712#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 713#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 714externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 715externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 716 717externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 718 719externinthold_locked_index(struct lock_file *,int); 720externvoidset_alternate_index_output(const char*); 721 722externint verify_index_checksum; 723 724/* Environment bits from configuration mechanism */ 725externint trust_executable_bit; 726externint trust_ctime; 727externint check_stat; 728externint quote_path_fully; 729externint has_symlinks; 730externint minimum_abbrev, default_abbrev; 731externint ignore_case; 732externint assume_unchanged; 733externint prefer_symlink_refs; 734externint warn_ambiguous_refs; 735externint warn_on_object_refname_ambiguity; 736externconst char*apply_default_whitespace; 737externconst char*apply_default_ignorewhitespace; 738externconst char*git_attributes_file; 739externconst char*git_hooks_path; 740externint zlib_compression_level; 741externint core_compression_level; 742externint pack_compression_level; 743externsize_t packed_git_window_size; 744externsize_t packed_git_limit; 745externsize_t delta_base_cache_limit; 746externunsigned long big_file_threshold; 747externunsigned long pack_size_limit_cfg; 748 749/* 750 * Accessors for the core.sharedrepository config which lazy-load the value 751 * from the config (if not already set). The "reset" function can be 752 * used to unset "set" or cached value, meaning that the value will be loaded 753 * fresh from the config file on the next call to get_shared_repository(). 754 */ 755voidset_shared_repository(int value); 756intget_shared_repository(void); 757voidreset_shared_repository(void); 758 759/* 760 * Do replace refs need to be checked this run? This variable is 761 * initialized to true unless --no-replace-object is used or 762 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 763 * commands that do not want replace references to be active. As an 764 * optimization it is also set to false if replace references have 765 * been sought but there were none. 766 */ 767externint check_replace_refs; 768externchar*git_replace_ref_base; 769 770externint fsync_object_files; 771externint core_preload_index; 772externint core_apply_sparse_checkout; 773externint precomposed_unicode; 774externint protect_hfs; 775externint protect_ntfs; 776 777/* 778 * Include broken refs in all ref iterations, which will 779 * generally choke dangerous operations rather than letting 780 * them silently proceed without taking the broken ref into 781 * account. 782 */ 783externint ref_paranoia; 784 785/* 786 * The character that begins a commented line in user-editable file 787 * that is subject to stripspace. 788 */ 789externchar comment_line_char; 790externint auto_comment_line_char; 791 792/* Windows only */ 793enum hide_dotfiles_type { 794 HIDE_DOTFILES_FALSE =0, 795 HIDE_DOTFILES_TRUE, 796 HIDE_DOTFILES_DOTGITONLY 797}; 798externenum hide_dotfiles_type hide_dotfiles; 799 800enum log_refs_config { 801 LOG_REFS_UNSET = -1, 802 LOG_REFS_NONE =0, 803 LOG_REFS_NORMAL, 804 LOG_REFS_ALWAYS 805}; 806externenum log_refs_config log_all_ref_updates; 807 808enum branch_track { 809 BRANCH_TRACK_UNSPECIFIED = -1, 810 BRANCH_TRACK_NEVER =0, 811 BRANCH_TRACK_REMOTE, 812 BRANCH_TRACK_ALWAYS, 813 BRANCH_TRACK_EXPLICIT, 814 BRANCH_TRACK_OVERRIDE 815}; 816 817enum rebase_setup_type { 818 AUTOREBASE_NEVER =0, 819 AUTOREBASE_LOCAL, 820 AUTOREBASE_REMOTE, 821 AUTOREBASE_ALWAYS 822}; 823 824enum push_default_type { 825 PUSH_DEFAULT_NOTHING =0, 826 PUSH_DEFAULT_MATCHING, 827 PUSH_DEFAULT_SIMPLE, 828 PUSH_DEFAULT_UPSTREAM, 829 PUSH_DEFAULT_CURRENT, 830 PUSH_DEFAULT_UNSPECIFIED 831}; 832 833externenum branch_track git_branch_track; 834externenum rebase_setup_type autorebase; 835externenum push_default_type push_default; 836 837enum object_creation_mode { 838 OBJECT_CREATION_USES_HARDLINKS =0, 839 OBJECT_CREATION_USES_RENAMES =1 840}; 841 842externenum object_creation_mode object_creation_mode; 843 844externchar*notes_ref_name; 845 846externint grafts_replace_parents; 847 848/* 849 * GIT_REPO_VERSION is the version we write by default. The 850 * _READ variant is the highest number we know how to 851 * handle. 852 */ 853#define GIT_REPO_VERSION 0 854#define GIT_REPO_VERSION_READ 1 855externint repository_format_precious_objects; 856 857struct repository_format { 858int version; 859int precious_objects; 860int is_bare; 861char*work_tree; 862struct string_list unknown_extensions; 863}; 864 865/* 866 * Read the repository format characteristics from the config file "path" into 867 * "format" struct. Returns the numeric version. On error, -1 is returned, 868 * format->version is set to -1, and all other fields in the struct are 869 * undefined. 870 */ 871intread_repository_format(struct repository_format *format,const char*path); 872 873/* 874 * Verify that the repository described by repository_format is something we 875 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 876 * any errors encountered. 877 */ 878intverify_repository_format(const struct repository_format *format, 879struct strbuf *err); 880 881/* 882 * Check the repository format version in the path found in get_git_dir(), 883 * and die if it is a version we don't understand. Generally one would 884 * set_git_dir() before calling this, and use it only for "are we in a valid 885 * repo?". 886 */ 887externvoidcheck_repository_format(void); 888 889#define MTIME_CHANGED 0x0001 890#define CTIME_CHANGED 0x0002 891#define OWNER_CHANGED 0x0004 892#define MODE_CHANGED 0x0008 893#define INODE_CHANGED 0x0010 894#define DATA_CHANGED 0x0020 895#define TYPE_CHANGED 0x0040 896 897/* 898 * Return the name of the file in the local object database that would 899 * be used to store a loose object with the specified sha1. The 900 * return value is a pointer to a statically allocated buffer that is 901 * overwritten each time the function is called. 902 */ 903externconst char*sha1_file_name(const unsigned char*sha1); 904 905/* 906 * Return the name of the (local) packfile with the specified sha1 in 907 * its name. The return value is a pointer to memory that is 908 * overwritten each time this function is called. 909 */ 910externchar*sha1_pack_name(const unsigned char*sha1); 911 912/* 913 * Return the name of the (local) pack index file with the specified 914 * sha1 in its name. The return value is a pointer to memory that is 915 * overwritten each time this function is called. 916 */ 917externchar*sha1_pack_index_name(const unsigned char*sha1); 918 919/* 920 * Return an abbreviated sha1 unique within this repository's object database. 921 * The result will be at least `len` characters long, and will be NUL 922 * terminated. 923 * 924 * The non-`_r` version returns a static buffer which remains valid until 4 925 * more calls to find_unique_abbrev are made. 926 * 927 * The `_r` variant writes to a buffer supplied by the caller, which must be at 928 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 929 * written (excluding the NUL terminator). 930 * 931 * Note that while this version avoids the static buffer, it is not fully 932 * reentrant, as it calls into other non-reentrant git code. 933 */ 934externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 935externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 936 937externconst unsigned char null_sha1[GIT_MAX_RAWSZ]; 938externconst struct object_id null_oid; 939 940staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 941{ 942int i; 943 944for(i =0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 945if(*sha1 != *sha2) 946return*sha1 - *sha2; 947} 948 949return0; 950} 951 952staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 953{ 954returnhashcmp(oid1->hash, oid2->hash); 955} 956 957staticinlineintis_null_sha1(const unsigned char*sha1) 958{ 959return!hashcmp(sha1, null_sha1); 960} 961 962staticinlineintis_null_oid(const struct object_id *oid) 963{ 964return!hashcmp(oid->hash, null_sha1); 965} 966 967staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src) 968{ 969memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 970} 971 972staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src) 973{ 974hashcpy(dst->hash, src->hash); 975} 976 977staticinlinestruct object_id *oiddup(const struct object_id *src) 978{ 979struct object_id *dst =xmalloc(sizeof(struct object_id)); 980oidcpy(dst, src); 981return dst; 982} 983 984staticinlinevoidhashclr(unsigned char*hash) 985{ 986memset(hash,0, GIT_SHA1_RAWSZ); 987} 988 989staticinlinevoidoidclr(struct object_id *oid) 990{ 991hashclr(oid->hash); 992} 993 994 995#define EMPTY_TREE_SHA1_HEX \ 996"4b825dc642cb6eb9a060e54bf8d69288fbee4904" 997#define EMPTY_TREE_SHA1_BIN_LITERAL \ 998"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \ 999"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1000externconst struct object_id empty_tree_oid;1001#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10021003#define EMPTY_BLOB_SHA1_HEX \1004"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1005#define EMPTY_BLOB_SHA1_BIN_LITERAL \1006"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1007"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1008externconst struct object_id empty_blob_oid;1009#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)101010111012staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1013{1014return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1015}10161017staticinlineintis_empty_blob_oid(const struct object_id *oid)1018{1019return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1020}10211022staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1023{1024return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1025}10261027staticinlineintis_empty_tree_oid(const struct object_id *oid)1028{1029return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1030}10311032/* set default permissions by passing mode arguments to open(2) */1033intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1034intgit_mkstemp_mode(char*pattern,int mode);10351036/*1037 * NOTE NOTE NOTE!!1038 *1039 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1040 * not be changed. Old repositories have core.sharedrepository written in1041 * numeric format, and therefore these values are preserved for compatibility1042 * reasons.1043 */1044enum sharedrepo {1045 PERM_UMASK =0,1046 OLD_PERM_GROUP =1,1047 OLD_PERM_EVERYBODY =2,1048 PERM_GROUP =0660,1049 PERM_EVERYBODY =06641050};1051intgit_config_perm(const char*var,const char*value);1052intadjust_shared_perm(const char*path);10531054/*1055 * Create the directory containing the named path, using care to be1056 * somewhat safe against races. Return one of the scld_error values to1057 * indicate success/failure. On error, set errno to describe the1058 * problem.1059 *1060 * SCLD_VANISHED indicates that one of the ancestor directories of the1061 * path existed at one point during the function call and then1062 * suddenly vanished, probably because another process pruned the1063 * directory while we were working. To be robust against this kind of1064 * race, callers might want to try invoking the function again when it1065 * returns SCLD_VANISHED.1066 *1067 * safe_create_leading_directories() temporarily changes path while it1068 * is working but restores it before returning.1069 * safe_create_leading_directories_const() doesn't modify path, even1070 * temporarily.1071 */1072enum scld_error {1073 SCLD_OK =0,1074 SCLD_FAILED = -1,1075 SCLD_PERMS = -2,1076 SCLD_EXISTS = -3,1077 SCLD_VANISHED = -41078};1079enum scld_error safe_create_leading_directories(char*path);1080enum scld_error safe_create_leading_directories_const(const char*path);10811082/*1083 * Callback function for raceproof_create_file(). This function is1084 * expected to do something that makes dirname(path) permanent despite1085 * the fact that other processes might be cleaning up empty1086 * directories at the same time. Usually it will create a file named1087 * path, but alternatively it could create another file in that1088 * directory, or even chdir() into that directory. The function should1089 * return 0 if the action was completed successfully. On error, it1090 * should return a nonzero result and set errno.1091 * raceproof_create_file() treats two errno values specially:1092 *1093 * - ENOENT -- dirname(path) does not exist. In this case,1094 * raceproof_create_file() tries creating dirname(path)1095 * (and any parent directories, if necessary) and calls1096 * the function again.1097 *1098 * - EISDIR -- the file already exists and is a directory. In this1099 * case, raceproof_create_file() removes the directory if1100 * it is empty (and recursively any empty directories that1101 * it contains) and calls the function again.1102 *1103 * Any other errno causes raceproof_create_file() to fail with the1104 * callback's return value and errno.1105 *1106 * Obviously, this function should be OK with being called again if it1107 * fails with ENOENT or EISDIR. In other scenarios it will not be1108 * called again.1109 */1110typedefintcreate_file_fn(const char*path,void*cb);11111112/*1113 * Create a file in dirname(path) by calling fn, creating leading1114 * directories if necessary. Retry a few times in case we are racing1115 * with another process that is trying to clean up the directory that1116 * contains path. See the documentation for create_file_fn for more1117 * details.1118 *1119 * Return the value and set the errno that resulted from the most1120 * recent call of fn. fn is always called at least once, and will be1121 * called more than once if it returns ENOENT or EISDIR.1122 */1123intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11241125intmkdir_in_gitdir(const char*path);1126externchar*expand_user_path(const char*path,int real_home);1127const char*enter_repo(const char*path,int strict);1128staticinlineintis_absolute_path(const char*path)1129{1130returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1131}1132intis_directory(const char*);1133char*strbuf_realpath(struct strbuf *resolved,const char*path,1134int die_on_error);1135const char*real_path(const char*path);1136const char*real_path_if_valid(const char*path);1137char*real_pathdup(const char*path,int die_on_error);1138const char*absolute_path(const char*path);1139char*absolute_pathdup(const char*path);1140const char*remove_leading_path(const char*in,const char*prefix);1141const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1142intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1143intnormalize_path_copy(char*dst,const char*src);1144intlongest_ancestor_length(const char*path,struct string_list *prefixes);1145char*strip_path_suffix(const char*path,const char*suffix);1146intdaemon_avoid_alias(const char*path);1147externintis_ntfs_dotgit(const char*name);11481149/**1150 * Return a newly allocated string with the evaluation of1151 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1152 * "$HOME/.config/git/$filename". Return NULL upon error.1153 */1154externchar*xdg_config_home(const char*filename);11551156/**1157 * Return a newly allocated string with the evaluation of1158 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1159 * "$HOME/.cache/git/$filename". Return NULL upon error.1160 */1161externchar*xdg_cache_home(const char*filename);11621163externvoid*read_sha1_file_extended(const unsigned char*sha1,1164enum object_type *type,1165unsigned long*size,int lookup_replace);1166staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1167{1168returnread_sha1_file_extended(sha1, type, size,1);1169}11701171/*1172 * This internal function is only declared here for the benefit of1173 * lookup_replace_object(). Please do not call it directly.1174 */1175externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);11761177/*1178 * If object sha1 should be replaced, return the replacement object's1179 * name (replaced recursively, if necessary). The return value is1180 * either sha1 or a pointer to a permanently-allocated value. When1181 * object replacement is suppressed, always return sha1.1182 */1183staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1184{1185if(!check_replace_refs)1186return sha1;1187returndo_lookup_replace_object(sha1);1188}11891190/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1191externintsha1_object_info(const unsigned char*,unsigned long*);1192externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1);1193externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1);1194externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,unsigned char*sha1,unsigned flags);1195externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*);1196externintforce_object_loose(const unsigned char*sha1,time_t mtime);1197externintgit_open_cloexec(const char*name,int flags);1198#define git_open(name) git_open_cloexec(name, O_RDONLY)1199externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1200externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1201externintparse_sha1_header(const char*hdr,unsigned long*sizep);12021203/* global flag to enable extra checks when accessing packed objects */1204externint do_check_packed_object_crc;12051206externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);12071208externintfinalize_object_file(const char*tmpfile,const char*filename);12091210externinthas_sha1_pack(const unsigned char*sha1);12111212/*1213 * Open the loose object at path, check its sha1, and return the contents,1214 * type, and size. If the object is a blob, then "contents" may return NULL,1215 * to allow streaming of large blobs.1216 *1217 * Returns 0 on success, negative on error (details may be written to stderr).1218 */1219intread_loose_object(const char*path,1220const unsigned char*expected_sha1,1221enum object_type *type,1222unsigned long*size,1223void**contents);12241225/*1226 * Convenience for sha1_object_info_extended() with a NULL struct1227 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass1228 * nonzero flags to also set other flags.1229 */1230externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1231staticinlineinthas_sha1_file(const unsigned char*sha1)1232{1233returnhas_sha1_file_with_flags(sha1,0);1234}12351236/* Same as the above, except for struct object_id. */1237externinthas_object_file(const struct object_id *oid);1238externinthas_object_file_with_flags(const struct object_id *oid,int flags);12391240/*1241 * Return true iff an alternate object database has a loose object1242 * with the specified name. This function does not respect replace1243 * references.1244 */1245externinthas_loose_object_nonlocal(const unsigned char*sha1);12461247externinthas_pack_index(const unsigned char*sha1);12481249externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);12501251/* Helper to check and "touch" a file */1252externintcheck_and_freshen_file(const char*fn,int freshen);12531254externconst signed char hexval_table[256];1255staticinlineunsigned inthexval(unsigned char c)1256{1257return hexval_table[c];1258}12591260/*1261 * Convert two consecutive hexadecimal digits into a char. Return a1262 * negative value on error. Don't run over the end of short strings.1263 */1264staticinlineinthex2chr(const char*s)1265{1266int val =hexval(s[0]);1267return(val <0) ? val : (val <<4) |hexval(s[1]);1268}12691270/* Convert to/from hex/sha1 representation */1271#define MINIMUM_ABBREV minimum_abbrev1272#define DEFAULT_ABBREV default_abbrev12731274/* used when the code does not know or care what the default abbrev is */1275#define FALLBACK_DEFAULT_ABBREV 712761277struct object_context {1278unsigned char tree[20];1279unsigned mode;1280/*1281 * symlink_path is only used by get_tree_entry_follow_symlinks,1282 * and only for symlinks that point outside the repository.1283 */1284struct strbuf symlink_path;1285/*1286 * If GET_SHA1_RECORD_PATH is set, this will record path (if any)1287 * found when resolving the name. The caller is responsible for1288 * releasing the memory.1289 */1290char*path;1291};12921293#define GET_SHA1_QUIETLY 011294#define GET_SHA1_COMMIT 021295#define GET_SHA1_COMMITTISH 041296#define GET_SHA1_TREE 0101297#define GET_SHA1_TREEISH 0201298#define GET_SHA1_BLOB 0401299#define GET_SHA1_FOLLOW_SYMLINKS 01001300#define GET_SHA1_RECORD_PATH 02001301#define GET_SHA1_ONLY_TO_DIE 0400013021303#define GET_SHA1_DISAMBIGUATORS \1304 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \1305 GET_SHA1_TREE | GET_SHA1_TREEISH | \1306 GET_SHA1_BLOB)13071308externintget_sha1(const char*str,unsigned char*sha1);1309externintget_sha1_commit(const char*str,unsigned char*sha1);1310externintget_sha1_committish(const char*str,unsigned char*sha1);1311externintget_sha1_tree(const char*str,unsigned char*sha1);1312externintget_sha1_treeish(const char*str,unsigned char*sha1);1313externintget_sha1_blob(const char*str,unsigned char*sha1);1314externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1315externintget_sha1_with_context(const char*str,unsigned flags,unsigned char*sha1,struct object_context *oc);13161317externintget_oid(const char*str,struct object_id *oid);13181319typedefinteach_abbrev_fn(const struct object_id *oid,void*);1320externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13211322externintset_disambiguate_hint_config(const char*var,const char*value);13231324/*1325 * Try to read a SHA1 in hexadecimal format from the 40 characters1326 * starting at hex. Write the 20-byte result to sha1 in binary form.1327 * Return 0 on success. Reading stops if a NUL is encountered in the1328 * input, so it is safe to pass this function an arbitrary1329 * null-terminated string.1330 */1331externintget_sha1_hex(const char*hex,unsigned char*sha1);1332externintget_oid_hex(const char*hex,struct object_id *sha1);13331334/*1335 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1336 * and writes the NUL-terminated output to the buffer `out`, which must be at1337 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1338 * convenience.1339 *1340 * The non-`_r` variant returns a static buffer, but uses a ring of 41341 * buffers, making it safe to make multiple calls for a single statement, like:1342 *1343 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1344 */1345externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1346externchar*oid_to_hex_r(char*out,const struct object_id *oid);1347externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1348externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */13491350/*1351 * Parse a 40-character hexadecimal object ID starting from hex, updating the1352 * pointer specified by end when parsing stops. The resulting object ID is1353 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1354 * other invalid character. end is only updated on success; otherwise, it is1355 * unmodified.1356 */1357externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);13581359/*1360 * This reads short-hand syntax that not only evaluates to a commit1361 * object name, but also can act as if the end user spelled the name1362 * of the branch from the command line.1363 *1364 * - "@{-N}" finds the name of the Nth previous branch we were on, and1365 * places the name of the branch in the given buf and returns the1366 * number of characters parsed if successful.1367 *1368 * - "<branch>@{upstream}" finds the name of the other ref that1369 * <branch> is configured to merge with (missing <branch> defaults1370 * to the current branch), and places the name of the branch in the1371 * given buf and returns the number of characters parsed if1372 * successful.1373 *1374 * If the input is not of the accepted format, it returns a negative1375 * number to signal an error.1376 *1377 * If the input was ok but there are not N branch switches in the1378 * reflog, it returns 0.1379 *1380 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1381 * expansions: local branches ("refs/heads/"), remote branches1382 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1383 * allowed, even ones to refs outside of those namespaces.1384 */1385#define INTERPRET_BRANCH_LOCAL (1<<0)1386#define INTERPRET_BRANCH_REMOTE (1<<1)1387#define INTERPRET_BRANCH_HEAD (1<<2)1388externintinterpret_branch_name(const char*str,int len,struct strbuf *,1389unsigned allowed);1390externintget_oid_mb(const char*str,struct object_id *oid);13911392externintvalidate_headref(const char*ref);13931394externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1395externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1396externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1397externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);13981399externvoid*read_object_with_reference(const unsigned char*sha1,1400const char*required_type,1401unsigned long*size,1402unsigned char*sha1_ret);14031404externstruct object *peel_to_type(const char*name,int namelen,1405struct object *o,enum object_type);14061407struct date_mode {1408enum date_mode_type {1409 DATE_NORMAL =0,1410 DATE_RELATIVE,1411 DATE_SHORT,1412 DATE_ISO8601,1413 DATE_ISO8601_STRICT,1414 DATE_RFC2822,1415 DATE_STRFTIME,1416 DATE_RAW,1417 DATE_UNIX1418} type;1419const char*strftime_fmt;1420int local;1421};14221423/*1424 * Convenience helper for passing a constant type, like:1425 *1426 * show_date(t, tz, DATE_MODE(NORMAL));1427 */1428#define DATE_MODE(t) date_mode_from_type(DATE_##t)1429struct date_mode *date_mode_from_type(enum date_mode_type type);14301431const char*show_date(timestamp_t time,int timezone,const struct date_mode *mode);1432voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1433struct strbuf *timebuf);1434intparse_date(const char*date,struct strbuf *out);1435intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1436intparse_expiry_date(const char*date, timestamp_t *timestamp);1437voiddatestamp(struct strbuf *out);1438#define approxidate(s) approxidate_careful((s), NULL)1439timestamp_t approxidate_careful(const char*,int*);1440timestamp_t approxidate_relative(const char*date,const struct timeval *now);1441voidparse_date_format(const char*format,struct date_mode *mode);1442intdate_overflows(timestamp_t date);14431444#define IDENT_STRICT 11445#define IDENT_NO_DATE 21446#define IDENT_NO_NAME 41447externconst char*git_author_info(int);1448externconst char*git_committer_info(int);1449externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1450externconst char*fmt_name(const char*name,const char*email);1451externconst char*ident_default_name(void);1452externconst char*ident_default_email(void);1453externconst char*git_editor(void);1454externconst char*git_pager(int stdout_is_tty);1455externintgit_ident_config(const char*,const char*,void*);1456externvoidreset_ident_date(void);14571458struct ident_split {1459const char*name_begin;1460const char*name_end;1461const char*mail_begin;1462const char*mail_end;1463const char*date_begin;1464const char*date_end;1465const char*tz_begin;1466const char*tz_end;1467};1468/*1469 * Signals an success with 0, but time part of the result may be NULL1470 * if the input lacks timestamp and zone1471 */1472externintsplit_ident_line(struct ident_split *,const char*,int);14731474/*1475 * Like show_date, but pull the timestamp and tz parameters from1476 * the ident_split. It will also sanity-check the values and produce1477 * a well-known sentinel date if they appear bogus.1478 */1479const char*show_ident_date(const struct ident_split *id,1480const struct date_mode *mode);14811482/*1483 * Compare split idents for equality or strict ordering. Note that we1484 * compare only the ident part of the line, ignoring any timestamp.1485 *1486 * Because there are two fields, we must choose one as the primary key; we1487 * currently arbitrarily pick the email.1488 */1489externintident_cmp(const struct ident_split *,const struct ident_split *);14901491struct checkout {1492struct index_state *istate;1493const char*base_dir;1494int base_dir_len;1495unsigned force:1,1496 quiet:1,1497 not_new:1,1498 refresh_cache:1;1499};1500#define CHECKOUT_INIT { NULL,"" }15011502#define TEMPORARY_FILENAME_LENGTH 251503externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);15041505struct cache_def {1506struct strbuf path;1507int flags;1508int track_flags;1509int prefix_len_stat_func;1510};1511#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1512staticinlinevoidcache_def_clear(struct cache_def *cache)1513{1514strbuf_release(&cache->path);1515}15161517externinthas_symlink_leading_path(const char*name,int len);1518externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1519externintcheck_leading_path(const char*name,int len);1520externinthas_dirs_only_path(const char*name,int len,int prefix_len);1521externvoidschedule_dir_for_removal(const char*name,int len);1522externvoidremove_scheduled_dirs(void);15231524externstruct alternate_object_database {1525struct alternate_object_database *next;15261527/* see alt_scratch_buf() */1528struct strbuf scratch;1529size_t base_len;15301531/*1532 * Used to store the results of readdir(3) calls when searching1533 * for unique abbreviated hashes. This cache is never1534 * invalidated, thus it's racy and not necessarily accurate.1535 * That's fine for its purpose; don't use it for tasks requiring1536 * greater accuracy!1537 */1538char loose_objects_subdir_seen[256];1539struct oid_array loose_objects_cache;15401541char path[FLEX_ARRAY];1542} *alt_odb_list;1543externvoidprepare_alt_odb(void);1544externvoidread_info_alternates(const char* relative_base,int depth);1545externchar*compute_alternate_path(const char*path,struct strbuf *err);1546typedefintalt_odb_fn(struct alternate_object_database *,void*);1547externintforeach_alt_odb(alt_odb_fn,void*);15481549/*1550 * Allocate a "struct alternate_object_database" but do _not_ actually1551 * add it to the list of alternates.1552 */1553struct alternate_object_database *alloc_alt_odb(const char*dir);15541555/*1556 * Add the directory to the on-disk alternates file; the new entry will also1557 * take effect in the current process.1558 */1559externvoidadd_to_alternates_file(const char*dir);15601561/*1562 * Add the directory to the in-memory list of alternates (along with any1563 * recursive alternates it points to), but do not modify the on-disk alternates1564 * file.1565 */1566externvoidadd_to_alternates_memory(const char*dir);15671568/*1569 * Returns a scratch strbuf pre-filled with the alternate object directory,1570 * including a trailing slash, which can be used to access paths in the1571 * alternate. Always use this over direct access to alt->scratch, as it1572 * cleans up any previous use of the scratch buffer.1573 */1574externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);15751576struct pack_window {1577struct pack_window *next;1578unsigned char*base;1579 off_t offset;1580size_t len;1581unsigned int last_used;1582unsigned int inuse_cnt;1583};15841585externstruct packed_git {1586struct packed_git *next;1587struct pack_window *windows;1588 off_t pack_size;1589const void*index_data;1590size_t index_size;1591uint32_t num_objects;1592uint32_t num_bad_objects;1593unsigned char*bad_object_sha1;1594int index_version;1595time_t mtime;1596int pack_fd;1597unsigned pack_local:1,1598 pack_keep:1,1599 freshened:1,1600 do_not_close:1;1601unsigned char sha1[20];1602struct revindex_entry *revindex;1603/* something like ".git/objects/pack/xxxxx.pack" */1604char pack_name[FLEX_ARRAY];/* more */1605} *packed_git;16061607/*1608 * A most-recently-used ordered version of the packed_git list, which can1609 * be iterated instead of packed_git (and marked via mru_mark).1610 */1611struct mru;1612externstruct mru *packed_git_mru;16131614struct pack_entry {1615 off_t offset;1616unsigned char sha1[20];1617struct packed_git *p;1618};16191620externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path);16211622/* A hook to report invalid files in pack directory */1623#define PACKDIR_FILE_PACK 11624#define PACKDIR_FILE_IDX 21625#define PACKDIR_FILE_GARBAGE 41626externvoid(*report_garbage)(unsigned seen_bits,const char*path);16271628externvoidprepare_packed_git(void);1629externvoidreprepare_packed_git(void);1630externvoidinstall_packed_git(struct packed_git *pack);16311632/*1633 * Give a rough count of objects in the repository. This sacrifices accuracy1634 * for speed.1635 */1636unsigned longapproximate_object_count(void);16371638externstruct packed_git *find_sha1_pack(const unsigned char*sha1,1639struct packed_git *packs);16401641externvoidpack_report(void);16421643/*1644 * Create a temporary file rooted in the object database directory, or1645 * die on failure. The filename is taken from "pattern", which should have the1646 * usual "XXXXXX" trailer, and the resulting filename is written into the1647 * "template" buffer. Returns the open descriptor.1648 */1649externintodb_mkstemp(struct strbuf *template,const char*pattern);16501651/*1652 * Generate the filename to be used for a pack file with checksum "sha1" and1653 * extension "ext". The result is written into the strbuf "buf", overwriting1654 * any existing contents. A pointer to buf->buf is returned as a convenience.1655 *1656 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"1657 */1658externchar*odb_pack_name(struct strbuf *buf,const unsigned char*sha1,const char*ext);16591660/*1661 * Create a pack .keep file named "name" (which should generally be the output1662 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1663 * error.1664 */1665externintodb_pack_keep(const char*name);16661667/*1668 * mmap the index file for the specified packfile (if it is not1669 * already mmapped). Return 0 on success.1670 */1671externintopen_pack_index(struct packed_git *);16721673/*1674 * munmap the index file for the specified packfile (if it is1675 * currently mmapped).1676 */1677externvoidclose_pack_index(struct packed_git *);16781679externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*);1680externvoidclose_pack_windows(struct packed_git *);1681externvoidclose_all_packs(void);1682externvoidunuse_pack(struct pack_window **);1683externvoidclear_delta_base_cache(void);1684externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local);16851686/*1687 * Make sure that a pointer access into an mmap'd index file is within bounds,1688 * and can provide at least 8 bytes of data.1689 *1690 * Note that this is only necessary for variable-length segments of the file1691 * (like the 64-bit extended offset table), as we compare the size to the1692 * fixed-length parts when we open the file.1693 */1694externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr);16951696/*1697 * Return the SHA-1 of the nth object within the specified packfile.1698 * Open the index if it is not already open. The return value points1699 * at the SHA-1 within the mmapped index. Return NULL if there is an1700 * error.1701 */1702externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n);1703/*1704 * Like nth_packed_object_sha1, but write the data into the object specified by1705 * the the first argument. Returns the first argument on success, and NULL on1706 * error.1707 */1708externconst struct object_id *nth_packed_object_oid(struct object_id *,struct packed_git *,uint32_t n);17091710/*1711 * Return the offset of the nth object within the specified packfile.1712 * The index must already be opened.1713 */1714extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n);17151716/*1717 * If the object named sha1 is present in the specified packfile,1718 * return its offset within the packfile; otherwise, return 0.1719 */1720extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *);17211722externintis_pack_valid(struct packed_git *);1723externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*);1724externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep);1725externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t);1726externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*);17271728/*1729 * Iterate over the files in the loose-object parts of the object1730 * directory "path", triggering the following callbacks:1731 *1732 * - loose_object is called for each loose object we find.1733 *1734 * - loose_cruft is called for any files that do not appear to be1735 * loose objects. Note that we only look in the loose object1736 * directories "objects/[0-9a-f]{2}/", so we will not report1737 * "objects/foobar" as cruft.1738 *1739 * - loose_subdir is called for each top-level hashed subdirectory1740 * of the object directory (e.g., "$OBJDIR/f0"). It is called1741 * after the objects in the directory are processed.1742 *1743 * Any callback that is NULL will be ignored. Callbacks returning non-zero1744 * will end the iteration.1745 *1746 * In the "buf" variant, "path" is a strbuf which will also be used as a1747 * scratch buffer, but restored to its original contents before1748 * the function returns.1749 */1750typedefinteach_loose_object_fn(const struct object_id *oid,1751const char*path,1752void*data);1753typedefinteach_loose_cruft_fn(const char*basename,1754const char*path,1755void*data);1756typedefinteach_loose_subdir_fn(unsigned int nr,1757const char*path,1758void*data);1759intfor_each_file_in_obj_subdir(unsigned int subdir_nr,1760struct strbuf *path,1761 each_loose_object_fn obj_cb,1762 each_loose_cruft_fn cruft_cb,1763 each_loose_subdir_fn subdir_cb,1764void*data);1765intfor_each_loose_file_in_objdir(const char*path,1766 each_loose_object_fn obj_cb,1767 each_loose_cruft_fn cruft_cb,1768 each_loose_subdir_fn subdir_cb,1769void*data);1770intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1771 each_loose_object_fn obj_cb,1772 each_loose_cruft_fn cruft_cb,1773 each_loose_subdir_fn subdir_cb,1774void*data);17751776/*1777 * Iterate over loose and packed objects in both the local1778 * repository and any alternates repositories (unless the1779 * LOCAL_ONLY flag is set).1780 */1781#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11782typedefinteach_packed_object_fn(const struct object_id *oid,1783struct packed_git *pack,1784uint32_t pos,1785void*data);1786externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);1787externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags);17881789struct object_info {1790/* Request */1791enum object_type *typep;1792unsigned long*sizep;1793 off_t *disk_sizep;1794unsigned char*delta_base_sha1;1795struct strbuf *typename;1796void**contentp;17971798/* Response */1799enum{1800 OI_CACHED,1801 OI_LOOSE,1802 OI_PACKED,1803 OI_DBCACHED1804} whence;1805union{1806/*1807 * struct {1808 * ... Nothing to expose in this case1809 * } cached;1810 * struct {1811 * ... Nothing to expose in this case1812 * } loose;1813 */1814struct{1815struct packed_git *pack;1816 off_t offset;1817unsigned int is_delta;1818} packed;1819} u;1820};18211822/*1823 * Initializer for a "struct object_info" that wants no items. You may1824 * also memset() the memory to all-zeroes.1825 */1826#define OBJECT_INFO_INIT {NULL}18271828/* Invoke lookup_replace_object() on the given hash */1829#define OBJECT_INFO_LOOKUP_REPLACE 11830/* Allow reading from a loose object file of unknown/bogus type */1831#define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 21832/* Do not check cached storage */1833#define OBJECT_INFO_SKIP_CACHED 41834/* Do not retry packed storage after checking packed and loose storage */1835#define OBJECT_INFO_QUICK 81836externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);1837externintpacked_object_info(struct packed_git *pack, off_t offset,struct object_info *);18381839/* Dumb servers support */1840externintupdate_server_info(int);18411842externconst char*get_log_output_encoding(void);1843externconst char*get_commit_output_encoding(void);18441845/*1846 * This is a hack for test programs like test-dump-untracked-cache to1847 * ensure that they do not modify the untracked cache when reading it.1848 * Do not use it otherwise!1849 */1850externint ignore_untracked_cache_config;18511852externintcommitter_ident_sufficiently_given(void);1853externintauthor_ident_sufficiently_given(void);18541855externconst char*git_commit_encoding;1856externconst char*git_log_output_encoding;1857externconst char*git_mailmap_file;1858externconst char*git_mailmap_blob;18591860/* IO helper functions */1861externvoidmaybe_flush_or_die(FILE*,const char*);1862__attribute__((format(printf,2,3)))1863externvoidfprintf_or_die(FILE*,const char*fmt, ...);18641865#define COPY_READ_ERROR (-2)1866#define COPY_WRITE_ERROR (-3)1867externintcopy_fd(int ifd,int ofd);1868externintcopy_file(const char*dst,const char*src,int mode);1869externintcopy_file_with_time(const char*dst,const char*src,int mode);18701871externvoidwrite_or_die(int fd,const void*buf,size_t count);1872externvoidfsync_or_die(int fd,const char*);18731874extern ssize_t read_in_full(int fd,void*buf,size_t count);1875extern ssize_t write_in_full(int fd,const void*buf,size_t count);1876extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);18771878staticinline ssize_t write_str_in_full(int fd,const char*str)1879{1880returnwrite_in_full(fd, str,strlen(str));1881}18821883/**1884 * Open (and truncate) the file at path, write the contents of buf to it,1885 * and close it. Dies if any errors are encountered.1886 */1887externvoidwrite_file_buf(const char*path,const char*buf,size_t len);18881889/**1890 * Like write_file_buf(), but format the contents into a buffer first.1891 * Additionally, write_file() will append a newline if one is not already1892 * present, making it convenient to write text files:1893 *1894 * write_file(path, "counter: %d", ctr);1895 */1896__attribute__((format(printf,2,3)))1897externvoidwrite_file(const char*path,const char*fmt, ...);18981899/* pager.c */1900externvoidsetup_pager(void);1901externintpager_in_use(void);1902externint pager_use_color;1903externintterm_columns(void);1904externintdecimal_width(uintmax_t);1905externintcheck_pager_config(const char*cmd);1906externvoidprepare_pager_args(struct child_process *,const char*pager);19071908externconst char*editor_program;1909externconst char*askpass_program;1910externconst char*excludes_file;19111912/* base85 */1913intdecode_85(char*dst,const char*line,int linelen);1914voidencode_85(char*buf,const unsigned char*data,int bytes);19151916/* alloc.c */1917externvoid*alloc_blob_node(void);1918externvoid*alloc_tree_node(void);1919externvoid*alloc_commit_node(void);1920externvoid*alloc_tag_node(void);1921externvoid*alloc_object_node(void);1922externvoidalloc_report(void);1923externunsigned intalloc_commit_index(void);19241925/* pkt-line.c */1926voidpacket_trace_identity(const char*prog);19271928/* add */1929/*1930 * return 0 if success, 1 - if addition of a file failed and1931 * ADD_FILES_IGNORE_ERRORS was specified in flags1932 */1933intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);19341935/* diff.c */1936externint diff_auto_refresh_index;19371938/* match-trees.c */1939voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1940voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);19411942/*1943 * whitespace rules.1944 * used by both diff and apply1945 * last two digits are tab width1946 */1947#define WS_BLANK_AT_EOL 01001948#define WS_SPACE_BEFORE_TAB 02001949#define WS_INDENT_WITH_NON_TAB 04001950#define WS_CR_AT_EOL 010001951#define WS_BLANK_AT_EOF 020001952#define WS_TAB_IN_INDENT 040001953#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1954#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1955#define WS_TAB_WIDTH_MASK 0771956externunsigned whitespace_rule_cfg;1957externunsignedwhitespace_rule(const char*);1958externunsignedparse_whitespace_rule(const char*);1959externunsignedws_check(const char*line,int len,unsigned ws_rule);1960externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1961externchar*whitespace_error_string(unsigned ws);1962externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1963externintws_blank_line(const char*line,int len,unsigned ws_rule);1964#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)19651966/* ls-files */1967voidoverlay_tree_on_index(struct index_state *istate,1968const char*tree_name,const char*prefix);19691970char*alias_lookup(const char*alias);1971intsplit_cmdline(char*cmdline,const char***argv);1972/* Takes a negative value returned by split_cmdline */1973const char*split_cmdline_strerror(int cmdline_errno);19741975/* setup.c */1976struct startup_info {1977int have_repository;1978const char*prefix;1979};1980externstruct startup_info *startup_info;19811982/* merge.c */1983struct commit_list;1984inttry_merge_command(const char*strategy,size_t xopts_nr,1985const char**xopts,struct commit_list *common,1986const char*head_arg,struct commit_list *remotes);1987intcheckout_fast_forward(const struct object_id *from,1988const struct object_id *to,1989int overwrite_ignore);199019911992intsane_execvp(const char*file,char*const argv[]);19931994/*1995 * A struct to encapsulate the concept of whether a file has changed1996 * since we last checked it. This uses criteria similar to those used1997 * for the index.1998 */1999struct stat_validity {2000struct stat_data *sd;2001};20022003voidstat_validity_clear(struct stat_validity *sv);20042005/*2006 * Returns 1 if the path is a regular file (or a symlink to a regular2007 * file) and matches the saved stat_validity, 0 otherwise. A missing2008 * or inaccessible file is considered a match if the struct was just2009 * initialized, or if the previous update found an inaccessible file.2010 */2011intstat_validity_check(struct stat_validity *sv,const char*path);20122013/*2014 * Update the stat_validity from a file opened at descriptor fd. If2015 * the file is missing, inaccessible, or not a regular file, then2016 * future calls to stat_validity_check will match iff one of those2017 * conditions continues to be true.2018 */2019voidstat_validity_update(struct stat_validity *sv,int fd);20202021intversioncmp(const char*s1,const char*s2);2022voidsleep_millisec(int millisec);20232024/*2025 * Create a directory and (if share is nonzero) adjust its permissions2026 * according to the shared_repository setting. Only use this for2027 * directories under $GIT_DIR. Don't use it for working tree2028 * directories.2029 */2030voidsafe_create_dir(const char*dir,int share);20312032#endif/* CACHE_H */