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 15#ifndef platform_SHA_CTX 16/* 17 * platform's underlying implementation of SHA-1; could be OpenSSL, 18 * blk_SHA, Apple CommonCrypto, etc... Note that including 19 * SHA1_HEADER may have already defined platform_SHA_CTX for our 20 * own implementations like block-sha1 and ppc-sha1, so we list 21 * the default for OpenSSL compatible SHA-1 implementations here. 22 */ 23#define platform_SHA_CTX SHA_CTX 24#define platform_SHA1_Init SHA1_Init 25#define platform_SHA1_Update SHA1_Update 26#define platform_SHA1_Final SHA1_Final 27#endif 28 29#define git_SHA_CTX platform_SHA_CTX 30#define git_SHA1_Init platform_SHA1_Init 31#define git_SHA1_Update platform_SHA1_Update 32#define git_SHA1_Final platform_SHA1_Final 33 34#ifdef SHA1_MAX_BLOCK_SIZE 35#include"compat/sha1-chunked.h" 36#undef git_SHA1_Update 37#define git_SHA1_Update git_SHA1_Update_Chunked 38#endif 39 40#include <zlib.h> 41typedefstruct git_zstream { 42 z_stream z; 43unsigned long avail_in; 44unsigned long avail_out; 45unsigned long total_in; 46unsigned long total_out; 47unsigned char*next_in; 48unsigned char*next_out; 49} git_zstream; 50 51voidgit_inflate_init(git_zstream *); 52voidgit_inflate_init_gzip_only(git_zstream *); 53voidgit_inflate_end(git_zstream *); 54intgit_inflate(git_zstream *,int flush); 55 56voidgit_deflate_init(git_zstream *,int level); 57voidgit_deflate_init_gzip(git_zstream *,int level); 58voidgit_deflate_init_raw(git_zstream *,int level); 59voidgit_deflate_end(git_zstream *); 60intgit_deflate_abort(git_zstream *); 61intgit_deflate_end_gently(git_zstream *); 62intgit_deflate(git_zstream *,int flush); 63unsigned longgit_deflate_bound(git_zstream *,unsigned long); 64 65/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 66#define GIT_SHA1_RAWSZ 20 67#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 68 69/* The length in byte and in hex digits of the largest possible hash value. */ 70#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 71#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 72 73struct object_id { 74unsigned char hash[GIT_MAX_RAWSZ]; 75}; 76 77#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 78#define DTYPE(de) ((de)->d_type) 79#else 80#undef DT_UNKNOWN 81#undef DT_DIR 82#undef DT_REG 83#undef DT_LNK 84#define DT_UNKNOWN 0 85#define DT_DIR 1 86#define DT_REG 2 87#define DT_LNK 3 88#define DTYPE(de) DT_UNKNOWN 89#endif 90 91/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 92#define S_IFINVALID 0030000 93 94/* 95 * A "directory link" is a link to another git directory. 96 * 97 * The value 0160000 is not normally a valid mode, and 98 * also just happens to be S_IFDIR + S_IFLNK 99 */ 100#define S_IFGITLINK 0160000 101#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 102 103/* 104 * Some mode bits are also used internally for computations. 105 * 106 * They *must* not overlap with any valid modes, and they *must* not be emitted 107 * to outside world - i.e. appear on disk or network. In other words, it's just 108 * temporary fields, which we internally use, but they have to stay in-house. 109 * 110 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 111 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 112 */ 113 114/* used internally in tree-diff */ 115#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 116 117 118/* 119 * Intensive research over the course of many years has shown that 120 * port 9418 is totally unused by anything else. Or 121 * 122 * Your search - "port 9418" - did not match any documents. 123 * 124 * as www.google.com puts it. 125 * 126 * This port has been properly assigned for git use by IANA: 127 * git (Assigned-9418) [I06-050728-0001]. 128 * 129 * git 9418/tcp git pack transfer service 130 * git 9418/udp git pack transfer service 131 * 132 * with Linus Torvalds <torvalds@osdl.org> as the point of 133 * contact. September 2005. 134 * 135 * See http://www.iana.org/assignments/port-numbers 136 */ 137#define DEFAULT_GIT_PORT 9418 138 139/* 140 * Basic data structures for the directory cache 141 */ 142 143#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 144struct cache_header { 145uint32_t hdr_signature; 146uint32_t hdr_version; 147uint32_t hdr_entries; 148}; 149 150#define INDEX_FORMAT_LB 2 151#define INDEX_FORMAT_UB 4 152 153/* 154 * The "cache_time" is just the low 32 bits of the 155 * time. It doesn't matter if it overflows - we only 156 * check it for equality in the 32 bits we save. 157 */ 158struct cache_time { 159uint32_t sec; 160uint32_t nsec; 161}; 162 163struct stat_data { 164struct cache_time sd_ctime; 165struct cache_time sd_mtime; 166unsigned int sd_dev; 167unsigned int sd_ino; 168unsigned int sd_uid; 169unsigned int sd_gid; 170unsigned int sd_size; 171}; 172 173struct cache_entry { 174struct hashmap_entry ent; 175struct stat_data ce_stat_data; 176unsigned int ce_mode; 177unsigned int ce_flags; 178unsigned int ce_namelen; 179unsigned int index;/* for link extension */ 180struct object_id oid; 181char name[FLEX_ARRAY];/* more */ 182}; 183 184#define CE_STAGEMASK (0x3000) 185#define CE_EXTENDED (0x4000) 186#define CE_VALID (0x8000) 187#define CE_STAGESHIFT 12 188 189/* 190 * Range 0xFFFF0FFF in ce_flags is divided into 191 * two parts: in-memory flags and on-disk ones. 192 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 193 * if you want to save a new flag, add it in 194 * CE_EXTENDED_FLAGS 195 * 196 * In-memory only flags 197 */ 198#define CE_UPDATE (1 << 16) 199#define CE_REMOVE (1 << 17) 200#define CE_UPTODATE (1 << 18) 201#define CE_ADDED (1 << 19) 202 203#define CE_HASHED (1 << 20) 204#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 205#define CE_CONFLICTED (1 << 23) 206 207#define CE_UNPACKED (1 << 24) 208#define CE_NEW_SKIP_WORKTREE (1 << 25) 209 210/* used to temporarily mark paths matched by pathspecs */ 211#define CE_MATCHED (1 << 26) 212 213#define CE_UPDATE_IN_BASE (1 << 27) 214#define CE_STRIP_NAME (1 << 28) 215 216/* 217 * Extended on-disk flags 218 */ 219#define CE_INTENT_TO_ADD (1 << 29) 220#define CE_SKIP_WORKTREE (1 << 30) 221/* CE_EXTENDED2 is for future extension */ 222#define CE_EXTENDED2 (1U << 31) 223 224#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 225 226/* 227 * Safeguard to avoid saving wrong flags: 228 * - CE_EXTENDED2 won't get saved until its semantic is known 229 * - Bits in 0x0000FFFF have been saved in ce_flags already 230 * - Bits in 0x003F0000 are currently in-memory flags 231 */ 232#if CE_EXTENDED_FLAGS & 0x803FFFFF 233#error"CE_EXTENDED_FLAGS out of range" 234#endif 235 236/* Forward structure decls */ 237struct pathspec; 238struct child_process; 239 240/* 241 * Copy the sha1 and stat state of a cache entry from one to 242 * another. But we never change the name, or the hash state! 243 */ 244staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 245const struct cache_entry *src) 246{ 247unsigned int state = dst->ce_flags & CE_HASHED; 248 249/* Don't copy hash chain and name */ 250memcpy(&dst->ce_stat_data, &src->ce_stat_data, 251offsetof(struct cache_entry, name) - 252offsetof(struct cache_entry, ce_stat_data)); 253 254/* Restore the hash state */ 255 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 256} 257 258staticinlineunsignedcreate_ce_flags(unsigned stage) 259{ 260return(stage << CE_STAGESHIFT); 261} 262 263#define ce_namelen(ce) ((ce)->ce_namelen) 264#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 265#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 266#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 267#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 268#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 269#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 270 271#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 272staticinlineunsigned intcreate_ce_mode(unsigned int mode) 273{ 274if(S_ISLNK(mode)) 275return S_IFLNK; 276if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 277return S_IFGITLINK; 278return S_IFREG |ce_permissions(mode); 279} 280staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 281unsigned int mode) 282{ 283externint trust_executable_bit, has_symlinks; 284if(!has_symlinks &&S_ISREG(mode) && 285 ce &&S_ISLNK(ce->ce_mode)) 286return ce->ce_mode; 287if(!trust_executable_bit &&S_ISREG(mode)) { 288if(ce &&S_ISREG(ce->ce_mode)) 289return ce->ce_mode; 290returncreate_ce_mode(0666); 291} 292returncreate_ce_mode(mode); 293} 294staticinlineintce_to_dtype(const struct cache_entry *ce) 295{ 296unsigned ce_mode =ntohl(ce->ce_mode); 297if(S_ISREG(ce_mode)) 298return DT_REG; 299else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 300return DT_DIR; 301else if(S_ISLNK(ce_mode)) 302return DT_LNK; 303else 304return DT_UNKNOWN; 305} 306staticinlineunsigned intcanon_mode(unsigned int mode) 307{ 308if(S_ISREG(mode)) 309return S_IFREG |ce_permissions(mode); 310if(S_ISLNK(mode)) 311return S_IFLNK; 312if(S_ISDIR(mode)) 313return S_IFDIR; 314return S_IFGITLINK; 315} 316 317#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 318 319#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 320#define CE_ENTRY_CHANGED (1 << 1) 321#define CE_ENTRY_REMOVED (1 << 2) 322#define CE_ENTRY_ADDED (1 << 3) 323#define RESOLVE_UNDO_CHANGED (1 << 4) 324#define CACHE_TREE_CHANGED (1 << 5) 325#define SPLIT_INDEX_ORDERED (1 << 6) 326#define UNTRACKED_CHANGED (1 << 7) 327 328struct split_index; 329struct untracked_cache; 330 331struct index_state { 332struct cache_entry **cache; 333unsigned int version; 334unsigned int cache_nr, cache_alloc, cache_changed; 335struct string_list *resolve_undo; 336struct cache_tree *cache_tree; 337struct split_index *split_index; 338struct cache_time timestamp; 339unsigned name_hash_initialized :1, 340 initialized :1; 341struct hashmap name_hash; 342struct hashmap dir_hash; 343unsigned char sha1[20]; 344struct untracked_cache *untracked; 345}; 346 347externstruct index_state the_index; 348 349/* Name hashing */ 350externinttest_lazy_init_name_hash(struct index_state *istate,int try_threaded); 351externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 352externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 353externvoidfree_name_hash(struct index_state *istate); 354 355 356#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 357#define active_cache (the_index.cache) 358#define active_nr (the_index.cache_nr) 359#define active_alloc (the_index.cache_alloc) 360#define active_cache_changed (the_index.cache_changed) 361#define active_cache_tree (the_index.cache_tree) 362 363#define read_cache() read_index(&the_index) 364#define read_cache_from(path) read_index_from(&the_index, (path)) 365#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 366#define is_cache_unborn() is_index_unborn(&the_index) 367#define read_cache_unmerged() read_index_unmerged(&the_index) 368#define discard_cache() discard_index(&the_index) 369#define unmerged_cache() unmerged_index(&the_index) 370#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 371#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 372#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 373#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 374#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 375#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 376#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 377#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 378#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 379#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 380#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 381#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 382#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 383#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 384#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 385#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 386#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 387#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 388#endif 389 390enum object_type { 391 OBJ_BAD = -1, 392 OBJ_NONE =0, 393 OBJ_COMMIT =1, 394 OBJ_TREE =2, 395 OBJ_BLOB =3, 396 OBJ_TAG =4, 397/* 5 for future expansion */ 398 OBJ_OFS_DELTA =6, 399 OBJ_REF_DELTA =7, 400 OBJ_ANY, 401 OBJ_MAX 402}; 403 404staticinlineenum object_type object_type(unsigned int mode) 405{ 406returnS_ISDIR(mode) ? OBJ_TREE : 407S_ISGITLINK(mode) ? OBJ_COMMIT : 408 OBJ_BLOB; 409} 410 411/* Double-check local_repo_env below if you add to this list. */ 412#define GIT_DIR_ENVIRONMENT"GIT_DIR" 413#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 414#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 415#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 416#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 417#define GIT_SUPER_PREFIX_ENVIRONMENT"GIT_INTERNAL_SUPER_PREFIX" 418#define GIT_TOPLEVEL_PREFIX_ENVIRONMENT"GIT_INTERNAL_TOPLEVEL_PREFIX" 419#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 420#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 421#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 422#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 423#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 424#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 425#define CONFIG_ENVIRONMENT"GIT_CONFIG" 426#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 427#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 428#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 429#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 430#define GIT_REPLACE_REF_BASE_ENVIRONMENT"GIT_REPLACE_REF_BASE" 431#define GITATTRIBUTES_FILE".gitattributes" 432#define INFOATTRIBUTES_FILE"info/attributes" 433#define ATTRIBUTE_MACRO_PREFIX"[attr]" 434#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 435#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 436#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 437#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 438#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 439#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 440#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 441#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 442#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 443#define GIT_QUARANTINE_ENVIRONMENT"GIT_QUARANTINE_PATH" 444 445/* 446 * This environment variable is expected to contain a boolean indicating 447 * whether we should or should not treat: 448 * 449 * GIT_DIR=foo.git git ... 450 * 451 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 452 * of this, but we use it internally to communicate to sub-processes that we 453 * are in a bare repo. If not set, defaults to true. 454 */ 455#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 456 457/* 458 * Repository-local GIT_* environment variables; these will be cleared 459 * when git spawns a sub-process that runs inside another repository. 460 * The array is NULL-terminated, which makes it easy to pass in the "env" 461 * parameter of a run-command invocation, or to do a simple walk. 462 */ 463externconst char*const local_repo_env[]; 464 465/* 466 * Returns true iff we have a configured git repository (either via 467 * setup_git_directory, or in the environment via $GIT_DIR). 468 */ 469inthave_git_dir(void); 470 471externint is_bare_repository_cfg; 472externintis_bare_repository(void); 473externintis_inside_git_dir(void); 474externchar*git_work_tree_cfg; 475externintis_inside_work_tree(void); 476externconst char*get_git_dir(void); 477externconst char*get_git_common_dir(void); 478externchar*get_object_directory(void); 479externchar*get_index_file(void); 480externchar*get_graft_file(void); 481externintset_git_dir(const char*path); 482externintget_common_dir_noenv(struct strbuf *sb,const char*gitdir); 483externintget_common_dir(struct strbuf *sb,const char*gitdir); 484externconst char*get_git_namespace(void); 485externconst char*strip_namespace(const char*namespaced_ref); 486externconst char*get_super_prefix(void); 487externconst char*get_git_work_tree(void); 488 489/* 490 * Return true if the given path is a git directory; note that this _just_ 491 * looks at the directory itself. If you want to know whether "foo/.git" 492 * is a repository, you must feed that path, not just "foo". 493 */ 494externintis_git_directory(const char*path); 495 496/* 497 * Return 1 if the given path is the root of a git repository or 498 * submodule, else 0. Will not return 1 for bare repositories with the 499 * exception of creating a bare repository in "foo/.git" and calling 500 * is_git_repository("foo"). 501 * 502 * If we run into read errors, we err on the side of saying "yes, it is", 503 * as we usually consider sub-repos precious, and would prefer to err on the 504 * side of not disrupting or deleting them. 505 */ 506externintis_nonbare_repository_dir(struct strbuf *path); 507 508#define READ_GITFILE_ERR_STAT_FAILED 1 509#define READ_GITFILE_ERR_NOT_A_FILE 2 510#define READ_GITFILE_ERR_OPEN_FAILED 3 511#define READ_GITFILE_ERR_READ_FAILED 4 512#define READ_GITFILE_ERR_INVALID_FORMAT 5 513#define READ_GITFILE_ERR_NO_PATH 6 514#define READ_GITFILE_ERR_NOT_A_REPO 7 515#define READ_GITFILE_ERR_TOO_LARGE 8 516externvoidread_gitfile_error_die(int error_code,const char*path,const char*dir); 517externconst char*read_gitfile_gently(const char*path,int*return_error_code); 518#define read_gitfile(path) read_gitfile_gently((path), NULL) 519externconst char*resolve_gitdir_gently(const char*suspect,int*return_error_code); 520#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 521 522externvoidset_git_work_tree(const char*tree); 523 524#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 525 526externvoidsetup_work_tree(void); 527/* 528 * Find the commondir and gitdir of the repository that contains the current 529 * working directory, without changing the working directory or other global 530 * state. The result is appended to commondir and gitdir. If the discovered 531 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 532 * both have the same result appended to the buffer. The return value is 533 * either 0 upon success and non-zero if no repository was found. 534 */ 535externintdiscover_git_directory(struct strbuf *commondir, 536struct strbuf *gitdir); 537externconst char*setup_git_directory_gently(int*); 538externconst char*setup_git_directory(void); 539externchar*prefix_path(const char*prefix,int len,const char*path); 540externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 541 542/* 543 * Concatenate "prefix" (if len is non-zero) and "path", with no 544 * connecting characters (so "prefix" should end with a "/"). 545 * Unlike prefix_path, this should be used if the named file does 546 * not have to interact with index entry; i.e. name of a random file 547 * on the filesystem. 548 * 549 * The return value is always a newly allocated string (even if the 550 * prefix was empty). 551 */ 552externchar*prefix_filename(const char*prefix,const char*path); 553 554externintcheck_filename(const char*prefix,const char*name); 555externvoidverify_filename(const char*prefix, 556const char*name, 557int diagnose_misspelt_rev); 558externvoidverify_non_filename(const char*prefix,const char*name); 559externintpath_inside_repo(const char*prefix,const char*path); 560 561#define INIT_DB_QUIET 0x0001 562#define INIT_DB_EXIST_OK 0x0002 563 564externintinit_db(const char*git_dir,const char*real_git_dir, 565const char*template_dir,unsigned int flags); 566 567externvoidsanitize_stdfds(void); 568externintdaemonize(void); 569 570#define alloc_nr(x) (((x)+16)*3/2) 571 572/* 573 * Realloc the buffer pointed at by variable 'x' so that it can hold 574 * at least 'nr' entries; the number of entries currently allocated 575 * is 'alloc', using the standard growing factor alloc_nr() macro. 576 * 577 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 578 */ 579#define ALLOC_GROW(x, nr, alloc) \ 580 do { \ 581 if ((nr) > alloc) { \ 582 if (alloc_nr(alloc) < (nr)) \ 583 alloc = (nr); \ 584 else \ 585 alloc = alloc_nr(alloc); \ 586 REALLOC_ARRAY(x, alloc); \ 587 } \ 588 } while (0) 589 590/* Initialize and use the cache information */ 591struct lock_file; 592externintread_index(struct index_state *); 593externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 594externintdo_read_index(struct index_state *istate,const char*path, 595int must_exist);/* for testting only! */ 596externintread_index_from(struct index_state *,const char*path); 597externintis_index_unborn(struct index_state *); 598externintread_index_unmerged(struct index_state *); 599#define COMMIT_LOCK (1 << 0) 600#define CLOSE_LOCK (1 << 1) 601externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 602externintdiscard_index(struct index_state *); 603externintunmerged_index(const struct index_state *); 604externintverify_path(const char*path); 605externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 606externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 607externvoidadjust_dirname_case(struct index_state *istate,char*name); 608externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 609 610/* 611 * Searches for an entry defined by name and namelen in the given index. 612 * If the return value is positive (including 0) it is the position of an 613 * exact match. If the return value is negative, the negated value minus 1 614 * is the position where the entry would be inserted. 615 * Example: The current index consists of these files and its stages: 616 * 617 * b#0, d#0, f#1, f#3 618 * 619 * index_name_pos(&index, "a", 1) -> -1 620 * index_name_pos(&index, "b", 1) -> 0 621 * index_name_pos(&index, "c", 1) -> -2 622 * index_name_pos(&index, "d", 1) -> 1 623 * index_name_pos(&index, "e", 1) -> -3 624 * index_name_pos(&index, "f", 1) -> -3 625 * index_name_pos(&index, "g", 1) -> -5 626 */ 627externintindex_name_pos(const struct index_state *,const char*name,int namelen); 628 629#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 630#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 631#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 632#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 633#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 634#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 635externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 636externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 637 638/* Remove entry, return true if there are more entries to go. */ 639externintremove_index_entry_at(struct index_state *,int pos); 640 641externvoidremove_marked_cache_entries(struct index_state *istate); 642externintremove_file_from_index(struct index_state *,const char*path); 643#define ADD_CACHE_VERBOSE 1 644#define ADD_CACHE_PRETEND 2 645#define ADD_CACHE_IGNORE_ERRORS 4 646#define ADD_CACHE_IGNORE_REMOVAL 8 647#define ADD_CACHE_INTENT 16 648/* 649 * These two are used to add the contents of the file at path 650 * to the index, marking the working tree up-to-date by storing 651 * the cached stat info in the resulting cache entry. A caller 652 * that has already run lstat(2) on the path can call 653 * add_to_index(), and all others can call add_file_to_index(); 654 * the latter will do necessary lstat(2) internally before 655 * calling the former. 656 */ 657externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 658externintadd_file_to_index(struct index_state *,const char*path,int flags); 659 660externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 661externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 662externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 663externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 664externintindex_name_is_other(const struct index_state *,const char*,int); 665externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 666 667/* do stat comparison even if CE_VALID is true */ 668#define CE_MATCH_IGNORE_VALID 01 669/* do not check the contents but report dirty on racily-clean entries */ 670#define CE_MATCH_RACY_IS_DIRTY 02 671/* do stat comparison even if CE_SKIP_WORKTREE is true */ 672#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 673/* ignore non-existent files during stat update */ 674#define CE_MATCH_IGNORE_MISSING 0x08 675/* enable stat refresh */ 676#define CE_MATCH_REFRESH 0x10 677externintie_match_stat(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 678externintie_modified(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 679 680#define HASH_WRITE_OBJECT 1 681#define HASH_FORMAT_CHECK 2 682externintindex_fd(unsigned char*sha1,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 683externintindex_path(unsigned char*sha1,const char*path,struct stat *st,unsigned flags); 684 685/* 686 * Record to sd the data from st that we use to check whether a file 687 * might have changed. 688 */ 689externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 690 691/* 692 * Return 0 if st is consistent with a file not having been changed 693 * since sd was filled. If there are differences, return a 694 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 695 * INODE_CHANGED, and DATA_CHANGED. 696 */ 697externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 698externintmatch_stat_data_racy(const struct index_state *istate, 699const struct stat_data *sd,struct stat *st); 700 701externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 702 703#define REFRESH_REALLY 0x0001/* ignore_valid */ 704#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 705#define REFRESH_QUIET 0x0004/* be quiet about it */ 706#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 707#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 708#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 709externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 710externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 711 712externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 713 714externinthold_locked_index(struct lock_file *,int); 715externvoidset_alternate_index_output(const char*); 716 717externint verify_index_checksum; 718 719/* Environment bits from configuration mechanism */ 720externint trust_executable_bit; 721externint trust_ctime; 722externint check_stat; 723externint quote_path_fully; 724externint has_symlinks; 725externint minimum_abbrev, default_abbrev; 726externint ignore_case; 727externint assume_unchanged; 728externint prefer_symlink_refs; 729externint warn_ambiguous_refs; 730externint warn_on_object_refname_ambiguity; 731externconst char*apply_default_whitespace; 732externconst char*apply_default_ignorewhitespace; 733externconst char*git_attributes_file; 734externconst char*git_hooks_path; 735externint zlib_compression_level; 736externint core_compression_level; 737externint pack_compression_level; 738externsize_t packed_git_window_size; 739externsize_t packed_git_limit; 740externsize_t delta_base_cache_limit; 741externunsigned long big_file_threshold; 742externunsigned long pack_size_limit_cfg; 743 744/* 745 * Accessors for the core.sharedrepository config which lazy-load the value 746 * from the config (if not already set). The "reset" function can be 747 * used to unset "set" or cached value, meaning that the value will be loaded 748 * fresh from the config file on the next call to get_shared_repository(). 749 */ 750voidset_shared_repository(int value); 751intget_shared_repository(void); 752voidreset_shared_repository(void); 753 754/* 755 * Do replace refs need to be checked this run? This variable is 756 * initialized to true unless --no-replace-object is used or 757 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 758 * commands that do not want replace references to be active. As an 759 * optimization it is also set to false if replace references have 760 * been sought but there were none. 761 */ 762externint check_replace_refs; 763externchar*git_replace_ref_base; 764 765externint fsync_object_files; 766externint core_preload_index; 767externint core_apply_sparse_checkout; 768externint precomposed_unicode; 769externint protect_hfs; 770externint protect_ntfs; 771externint git_db_env, git_index_env, git_graft_env, git_common_dir_env; 772 773/* 774 * Include broken refs in all ref iterations, which will 775 * generally choke dangerous operations rather than letting 776 * them silently proceed without taking the broken ref into 777 * account. 778 */ 779externint ref_paranoia; 780 781/* 782 * The character that begins a commented line in user-editable file 783 * that is subject to stripspace. 784 */ 785externchar comment_line_char; 786externint auto_comment_line_char; 787 788/* Windows only */ 789enum hide_dotfiles_type { 790 HIDE_DOTFILES_FALSE =0, 791 HIDE_DOTFILES_TRUE, 792 HIDE_DOTFILES_DOTGITONLY 793}; 794externenum hide_dotfiles_type hide_dotfiles; 795 796enum log_refs_config { 797 LOG_REFS_UNSET = -1, 798 LOG_REFS_NONE =0, 799 LOG_REFS_NORMAL, 800 LOG_REFS_ALWAYS 801}; 802externenum log_refs_config log_all_ref_updates; 803 804enum branch_track { 805 BRANCH_TRACK_UNSPECIFIED = -1, 806 BRANCH_TRACK_NEVER =0, 807 BRANCH_TRACK_REMOTE, 808 BRANCH_TRACK_ALWAYS, 809 BRANCH_TRACK_EXPLICIT, 810 BRANCH_TRACK_OVERRIDE 811}; 812 813enum rebase_setup_type { 814 AUTOREBASE_NEVER =0, 815 AUTOREBASE_LOCAL, 816 AUTOREBASE_REMOTE, 817 AUTOREBASE_ALWAYS 818}; 819 820enum push_default_type { 821 PUSH_DEFAULT_NOTHING =0, 822 PUSH_DEFAULT_MATCHING, 823 PUSH_DEFAULT_SIMPLE, 824 PUSH_DEFAULT_UPSTREAM, 825 PUSH_DEFAULT_CURRENT, 826 PUSH_DEFAULT_UNSPECIFIED 827}; 828 829externenum branch_track git_branch_track; 830externenum rebase_setup_type autorebase; 831externenum push_default_type push_default; 832 833enum object_creation_mode { 834 OBJECT_CREATION_USES_HARDLINKS =0, 835 OBJECT_CREATION_USES_RENAMES =1 836}; 837 838externenum object_creation_mode object_creation_mode; 839 840externchar*notes_ref_name; 841 842externint grafts_replace_parents; 843 844/* 845 * GIT_REPO_VERSION is the version we write by default. The 846 * _READ variant is the highest number we know how to 847 * handle. 848 */ 849#define GIT_REPO_VERSION 0 850#define GIT_REPO_VERSION_READ 1 851externint repository_format_precious_objects; 852 853struct repository_format { 854int version; 855int precious_objects; 856int is_bare; 857char*work_tree; 858struct string_list unknown_extensions; 859}; 860 861/* 862 * Read the repository format characteristics from the config file "path" into 863 * "format" struct. Returns the numeric version. On error, -1 is returned, 864 * format->version is set to -1, and all other fields in the struct are 865 * undefined. 866 */ 867intread_repository_format(struct repository_format *format,const char*path); 868 869/* 870 * Verify that the repository described by repository_format is something we 871 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 872 * any errors encountered. 873 */ 874intverify_repository_format(const struct repository_format *format, 875struct strbuf *err); 876 877/* 878 * Check the repository format version in the path found in get_git_dir(), 879 * and die if it is a version we don't understand. Generally one would 880 * set_git_dir() before calling this, and use it only for "are we in a valid 881 * repo?". 882 */ 883externvoidcheck_repository_format(void); 884 885#define MTIME_CHANGED 0x0001 886#define CTIME_CHANGED 0x0002 887#define OWNER_CHANGED 0x0004 888#define MODE_CHANGED 0x0008 889#define INODE_CHANGED 0x0010 890#define DATA_CHANGED 0x0020 891#define TYPE_CHANGED 0x0040 892 893/* 894 * Return a statically allocated filename, either generically (mkpath), in 895 * the repository directory (git_path), or in a submodule's repository 896 * directory (git_path_submodule). In all cases, note that the result 897 * may be overwritten by another call to _any_ of the functions. Consider 898 * using the safer "dup" or "strbuf" formats below (in some cases, the 899 * unsafe versions have already been removed). 900 */ 901externconst char*mkpath(const char*fmt, ...)__attribute__((format(printf,1,2))); 902externconst char*git_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 903externconst char*git_common_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 904 905externchar*mksnpath(char*buf,size_t n,const char*fmt, ...) 906__attribute__((format(printf,3,4))); 907externvoidstrbuf_git_path(struct strbuf *sb,const char*fmt, ...) 908__attribute__((format(printf,2,3))); 909externvoidstrbuf_git_common_path(struct strbuf *sb,const char*fmt, ...) 910__attribute__((format(printf,2,3))); 911externchar*git_path_buf(struct strbuf *buf,const char*fmt, ...) 912__attribute__((format(printf,2,3))); 913externintstrbuf_git_path_submodule(struct strbuf *sb,const char*path, 914const char*fmt, ...) 915__attribute__((format(printf,3,4))); 916externchar*git_pathdup(const char*fmt, ...) 917__attribute__((format(printf,1,2))); 918externchar*mkpathdup(const char*fmt, ...) 919__attribute__((format(printf,1,2))); 920externchar*git_pathdup_submodule(const char*path,const char*fmt, ...) 921__attribute__((format(printf,2,3))); 922 923externvoidreport_linked_checkout_garbage(void); 924 925/* 926 * You can define a static memoized git path like: 927 * 928 * static GIT_PATH_FUNC(git_path_foo, "FOO"); 929 * 930 * or use one of the global ones below. 931 */ 932#define GIT_PATH_FUNC(func, filename) \ 933 const char *func(void) \ 934 { \ 935 static char *ret; \ 936 if (!ret) \ 937 ret = git_pathdup(filename); \ 938 return ret; \ 939 } 940 941const char*git_path_cherry_pick_head(void); 942const char*git_path_revert_head(void); 943const char*git_path_squash_msg(void); 944const char*git_path_merge_msg(void); 945const char*git_path_merge_rr(void); 946const char*git_path_merge_mode(void); 947const char*git_path_merge_head(void); 948const char*git_path_fetch_head(void); 949const char*git_path_shallow(void); 950 951/* 952 * Return the name of the file in the local object database that would 953 * be used to store a loose object with the specified sha1. The 954 * return value is a pointer to a statically allocated buffer that is 955 * overwritten each time the function is called. 956 */ 957externconst char*sha1_file_name(const unsigned char*sha1); 958 959/* 960 * Return the name of the (local) packfile with the specified sha1 in 961 * its name. The return value is a pointer to memory that is 962 * overwritten each time this function is called. 963 */ 964externchar*sha1_pack_name(const unsigned char*sha1); 965 966/* 967 * Return the name of the (local) pack index file with the specified 968 * sha1 in its name. The return value is a pointer to memory that is 969 * overwritten each time this function is called. 970 */ 971externchar*sha1_pack_index_name(const unsigned char*sha1); 972 973/* 974 * Return an abbreviated sha1 unique within this repository's object database. 975 * The result will be at least `len` characters long, and will be NUL 976 * terminated. 977 * 978 * The non-`_r` version returns a static buffer which remains valid until 4 979 * more calls to find_unique_abbrev are made. 980 * 981 * The `_r` variant writes to a buffer supplied by the caller, which must be at 982 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 983 * written (excluding the NUL terminator). 984 * 985 * Note that while this version avoids the static buffer, it is not fully 986 * reentrant, as it calls into other non-reentrant git code. 987 */ 988externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 989externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 990 991externconst unsigned char null_sha1[GIT_MAX_RAWSZ]; 992externconst struct object_id null_oid; 993 994staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 995{ 996int i; 997 998for(i =0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 999if(*sha1 != *sha2)1000return*sha1 - *sha2;1001}10021003return0;1004}10051006staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2)1007{1008returnhashcmp(oid1->hash, oid2->hash);1009}10101011staticinlineintis_null_sha1(const unsigned char*sha1)1012{1013return!hashcmp(sha1, null_sha1);1014}10151016staticinlineintis_null_oid(const struct object_id *oid)1017{1018return!hashcmp(oid->hash, null_sha1);1019}10201021staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src)1022{1023memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);1024}10251026staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src)1027{1028hashcpy(dst->hash, src->hash);1029}10301031staticinlinevoidhashclr(unsigned char*hash)1032{1033memset(hash,0, GIT_SHA1_RAWSZ);1034}10351036staticinlinevoidoidclr(struct object_id *oid)1037{1038hashclr(oid->hash);1039}104010411042#define EMPTY_TREE_SHA1_HEX \1043"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1044#define EMPTY_TREE_SHA1_BIN_LITERAL \1045"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1046"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1047externconst struct object_id empty_tree_oid;1048#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10491050#define EMPTY_BLOB_SHA1_HEX \1051"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1052#define EMPTY_BLOB_SHA1_BIN_LITERAL \1053"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1054"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1055externconst struct object_id empty_blob_oid;1056#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)105710581059staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1060{1061return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1062}10631064staticinlineintis_empty_blob_oid(const struct object_id *oid)1065{1066return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1067}10681069staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1070{1071return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1072}10731074staticinlineintis_empty_tree_oid(const struct object_id *oid)1075{1076return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1077}10781079/* set default permissions by passing mode arguments to open(2) */1080intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1081intgit_mkstemp_mode(char*pattern,int mode);10821083/*1084 * NOTE NOTE NOTE!!1085 *1086 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1087 * not be changed. Old repositories have core.sharedrepository written in1088 * numeric format, and therefore these values are preserved for compatibility1089 * reasons.1090 */1091enum sharedrepo {1092 PERM_UMASK =0,1093 OLD_PERM_GROUP =1,1094 OLD_PERM_EVERYBODY =2,1095 PERM_GROUP =0660,1096 PERM_EVERYBODY =06641097};1098intgit_config_perm(const char*var,const char*value);1099intadjust_shared_perm(const char*path);11001101/*1102 * Create the directory containing the named path, using care to be1103 * somewhat safe against races. Return one of the scld_error values to1104 * indicate success/failure. On error, set errno to describe the1105 * problem.1106 *1107 * SCLD_VANISHED indicates that one of the ancestor directories of the1108 * path existed at one point during the function call and then1109 * suddenly vanished, probably because another process pruned the1110 * directory while we were working. To be robust against this kind of1111 * race, callers might want to try invoking the function again when it1112 * returns SCLD_VANISHED.1113 *1114 * safe_create_leading_directories() temporarily changes path while it1115 * is working but restores it before returning.1116 * safe_create_leading_directories_const() doesn't modify path, even1117 * temporarily.1118 */1119enum scld_error {1120 SCLD_OK =0,1121 SCLD_FAILED = -1,1122 SCLD_PERMS = -2,1123 SCLD_EXISTS = -3,1124 SCLD_VANISHED = -41125};1126enum scld_error safe_create_leading_directories(char*path);1127enum scld_error safe_create_leading_directories_const(const char*path);11281129/*1130 * Callback function for raceproof_create_file(). This function is1131 * expected to do something that makes dirname(path) permanent despite1132 * the fact that other processes might be cleaning up empty1133 * directories at the same time. Usually it will create a file named1134 * path, but alternatively it could create another file in that1135 * directory, or even chdir() into that directory. The function should1136 * return 0 if the action was completed successfully. On error, it1137 * should return a nonzero result and set errno.1138 * raceproof_create_file() treats two errno values specially:1139 *1140 * - ENOENT -- dirname(path) does not exist. In this case,1141 * raceproof_create_file() tries creating dirname(path)1142 * (and any parent directories, if necessary) and calls1143 * the function again.1144 *1145 * - EISDIR -- the file already exists and is a directory. In this1146 * case, raceproof_create_file() removes the directory if1147 * it is empty (and recursively any empty directories that1148 * it contains) and calls the function again.1149 *1150 * Any other errno causes raceproof_create_file() to fail with the1151 * callback's return value and errno.1152 *1153 * Obviously, this function should be OK with being called again if it1154 * fails with ENOENT or EISDIR. In other scenarios it will not be1155 * called again.1156 */1157typedefintcreate_file_fn(const char*path,void*cb);11581159/*1160 * Create a file in dirname(path) by calling fn, creating leading1161 * directories if necessary. Retry a few times in case we are racing1162 * with another process that is trying to clean up the directory that1163 * contains path. See the documentation for create_file_fn for more1164 * details.1165 *1166 * Return the value and set the errno that resulted from the most1167 * recent call of fn. fn is always called at least once, and will be1168 * called more than once if it returns ENOENT or EISDIR.1169 */1170intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11711172intmkdir_in_gitdir(const char*path);1173externchar*expand_user_path(const char*path,int real_home);1174const char*enter_repo(const char*path,int strict);1175staticinlineintis_absolute_path(const char*path)1176{1177returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1178}1179intis_directory(const char*);1180char*strbuf_realpath(struct strbuf *resolved,const char*path,1181int die_on_error);1182const char*real_path(const char*path);1183const char*real_path_if_valid(const char*path);1184char*real_pathdup(const char*path,int die_on_error);1185const char*absolute_path(const char*path);1186char*absolute_pathdup(const char*path);1187const char*remove_leading_path(const char*in,const char*prefix);1188const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1189intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1190intnormalize_path_copy(char*dst,const char*src);1191intlongest_ancestor_length(const char*path,struct string_list *prefixes);1192char*strip_path_suffix(const char*path,const char*suffix);1193intdaemon_avoid_alias(const char*path);1194externintis_ntfs_dotgit(const char*name);11951196/**1197 * Return a newly allocated string with the evaluation of1198 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1199 * "$HOME/.config/git/$filename". Return NULL upon error.1200 */1201externchar*xdg_config_home(const char*filename);12021203/**1204 * Return a newly allocated string with the evaluation of1205 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1206 * "$HOME/.cache/git/$filename". Return NULL upon error.1207 */1208externchar*xdg_cache_home(const char*filename);12091210/* object replacement */1211#define LOOKUP_REPLACE_OBJECT 11212#define LOOKUP_UNKNOWN_OBJECT 21213externvoid*read_sha1_file_extended(const unsigned char*sha1,enum object_type *type,unsigned long*size,unsigned flag);1214staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1215{1216returnread_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);1217}12181219/*1220 * This internal function is only declared here for the benefit of1221 * lookup_replace_object(). Please do not call it directly.1222 */1223externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);12241225/*1226 * If object sha1 should be replaced, return the replacement object's1227 * name (replaced recursively, if necessary). The return value is1228 * either sha1 or a pointer to a permanently-allocated value. When1229 * object replacement is suppressed, always return sha1.1230 */1231staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1232{1233if(!check_replace_refs)1234return sha1;1235returndo_lookup_replace_object(sha1);1236}12371238staticinlineconst unsigned char*lookup_replace_object_extended(const unsigned char*sha1,unsigned flag)1239{1240if(!(flag & LOOKUP_REPLACE_OBJECT))1241return sha1;1242returnlookup_replace_object(sha1);1243}12441245/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1246externintsha1_object_info(const unsigned char*,unsigned long*);1247externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1);1248externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1);1249externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,unsigned char*sha1,unsigned flags);1250externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*);1251externintforce_object_loose(const unsigned char*sha1,time_t mtime);1252externintgit_open_cloexec(const char*name,int flags);1253#define git_open(name) git_open_cloexec(name, O_RDONLY)1254externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1255externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1256externintparse_sha1_header(const char*hdr,unsigned long*sizep);12571258/* global flag to enable extra checks when accessing packed objects */1259externint do_check_packed_object_crc;12601261externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);12621263externintfinalize_object_file(const char*tmpfile,const char*filename);12641265externinthas_sha1_pack(const unsigned char*sha1);12661267/*1268 * Open the loose object at path, check its sha1, and return the contents,1269 * type, and size. If the object is a blob, then "contents" may return NULL,1270 * to allow streaming of large blobs.1271 *1272 * Returns 0 on success, negative on error (details may be written to stderr).1273 */1274intread_loose_object(const char*path,1275const unsigned char*expected_sha1,1276enum object_type *type,1277unsigned long*size,1278void**contents);12791280/*1281 * Return true iff we have an object named sha1, whether local or in1282 * an alternate object database, and whether packed or loose. This1283 * function does not respect replace references.1284 *1285 * If the QUICK flag is set, do not re-check the pack directory1286 * when we cannot find the object (this means we may give a false1287 * negative answer if another process is simultaneously repacking).1288 */1289#define HAS_SHA1_QUICK 0x11290externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1291staticinlineinthas_sha1_file(const unsigned char*sha1)1292{1293returnhas_sha1_file_with_flags(sha1,0);1294}12951296/* Same as the above, except for struct object_id. */1297externinthas_object_file(const struct object_id *oid);1298externinthas_object_file_with_flags(const struct object_id *oid,int flags);12991300/*1301 * Return true iff an alternate object database has a loose object1302 * with the specified name. This function does not respect replace1303 * references.1304 */1305externinthas_loose_object_nonlocal(const unsigned char*sha1);13061307externinthas_pack_index(const unsigned char*sha1);13081309externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);13101311/* Helper to check and "touch" a file */1312externintcheck_and_freshen_file(const char*fn,int freshen);13131314externconst signed char hexval_table[256];1315staticinlineunsigned inthexval(unsigned char c)1316{1317return hexval_table[c];1318}13191320/*1321 * Convert two consecutive hexadecimal digits into a char. Return a1322 * negative value on error. Don't run over the end of short strings.1323 */1324staticinlineinthex2chr(const char*s)1325{1326int val =hexval(s[0]);1327return(val <0) ? val : (val <<4) |hexval(s[1]);1328}13291330/* Convert to/from hex/sha1 representation */1331#define MINIMUM_ABBREV minimum_abbrev1332#define DEFAULT_ABBREV default_abbrev13331334/* used when the code does not know or care what the default abbrev is */1335#define FALLBACK_DEFAULT_ABBREV 713361337struct object_context {1338unsigned char tree[20];1339char path[PATH_MAX];1340unsigned mode;1341/*1342 * symlink_path is only used by get_tree_entry_follow_symlinks,1343 * and only for symlinks that point outside the repository.1344 */1345struct strbuf symlink_path;1346};13471348#define GET_SHA1_QUIETLY 011349#define GET_SHA1_COMMIT 021350#define GET_SHA1_COMMITTISH 041351#define GET_SHA1_TREE 0101352#define GET_SHA1_TREEISH 0201353#define GET_SHA1_BLOB 0401354#define GET_SHA1_FOLLOW_SYMLINKS 01001355#define GET_SHA1_ONLY_TO_DIE 0400013561357#define GET_SHA1_DISAMBIGUATORS \1358 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \1359 GET_SHA1_TREE | GET_SHA1_TREEISH | \1360 GET_SHA1_BLOB)13611362externintget_sha1(const char*str,unsigned char*sha1);1363externintget_sha1_commit(const char*str,unsigned char*sha1);1364externintget_sha1_committish(const char*str,unsigned char*sha1);1365externintget_sha1_tree(const char*str,unsigned char*sha1);1366externintget_sha1_treeish(const char*str,unsigned char*sha1);1367externintget_sha1_blob(const char*str,unsigned char*sha1);1368externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1369externintget_sha1_with_context(const char*str,unsigned flags,unsigned char*sha1,struct object_context *orc);13701371externintget_oid(const char*str,struct object_id *oid);13721373typedefinteach_abbrev_fn(const struct object_id *oid,void*);1374externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13751376externintset_disambiguate_hint_config(const char*var,const char*value);13771378/*1379 * Try to read a SHA1 in hexadecimal format from the 40 characters1380 * starting at hex. Write the 20-byte result to sha1 in binary form.1381 * Return 0 on success. Reading stops if a NUL is encountered in the1382 * input, so it is safe to pass this function an arbitrary1383 * null-terminated string.1384 */1385externintget_sha1_hex(const char*hex,unsigned char*sha1);1386externintget_oid_hex(const char*hex,struct object_id *sha1);13871388/*1389 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1390 * and writes the NUL-terminated output to the buffer `out`, which must be at1391 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1392 * convenience.1393 *1394 * The non-`_r` variant returns a static buffer, but uses a ring of 41395 * buffers, making it safe to make multiple calls for a single statement, like:1396 *1397 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1398 */1399externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1400externchar*oid_to_hex_r(char*out,const struct object_id *oid);1401externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1402externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */14031404/*1405 * Parse a 40-character hexadecimal object ID starting from hex, updating the1406 * pointer specified by end when parsing stops. The resulting object ID is1407 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1408 * other invalid character. end is only updated on success; otherwise, it is1409 * unmodified.1410 */1411externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);14121413/*1414 * This reads short-hand syntax that not only evaluates to a commit1415 * object name, but also can act as if the end user spelled the name1416 * of the branch from the command line.1417 *1418 * - "@{-N}" finds the name of the Nth previous branch we were on, and1419 * places the name of the branch in the given buf and returns the1420 * number of characters parsed if successful.1421 *1422 * - "<branch>@{upstream}" finds the name of the other ref that1423 * <branch> is configured to merge with (missing <branch> defaults1424 * to the current branch), and places the name of the branch in the1425 * given buf and returns the number of characters parsed if1426 * successful.1427 *1428 * If the input is not of the accepted format, it returns a negative1429 * number to signal an error.1430 *1431 * If the input was ok but there are not N branch switches in the1432 * reflog, it returns 0.1433 *1434 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1435 * expansions: local branches ("refs/heads/"), remote branches1436 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1437 * allowed, even ones to refs outside of those namespaces.1438 */1439#define INTERPRET_BRANCH_LOCAL (1<<0)1440#define INTERPRET_BRANCH_REMOTE (1<<1)1441#define INTERPRET_BRANCH_HEAD (1<<2)1442externintinterpret_branch_name(const char*str,int len,struct strbuf *,1443unsigned allowed);1444externintget_oid_mb(const char*str,struct object_id *oid);14451446externintvalidate_headref(const char*ref);14471448externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1449externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1450externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1451externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);14521453externvoid*read_object_with_reference(const unsigned char*sha1,1454const char*required_type,1455unsigned long*size,1456unsigned char*sha1_ret);14571458externstruct object *peel_to_type(const char*name,int namelen,1459struct object *o,enum object_type);14601461struct date_mode {1462enum date_mode_type {1463 DATE_NORMAL =0,1464 DATE_RELATIVE,1465 DATE_SHORT,1466 DATE_ISO8601,1467 DATE_ISO8601_STRICT,1468 DATE_RFC2822,1469 DATE_STRFTIME,1470 DATE_RAW,1471 DATE_UNIX1472} type;1473const char*strftime_fmt;1474int local;1475};14761477/*1478 * Convenience helper for passing a constant type, like:1479 *1480 * show_date(t, tz, DATE_MODE(NORMAL));1481 */1482#define DATE_MODE(t) date_mode_from_type(DATE_##t)1483struct date_mode *date_mode_from_type(enum date_mode_type type);14841485const char*show_date(unsigned long time,int timezone,const struct date_mode *mode);1486voidshow_date_relative(unsigned long time,int tz,const struct timeval *now,1487struct strbuf *timebuf);1488intparse_date(const char*date,struct strbuf *out);1489intparse_date_basic(const char*date,unsigned long*timestamp,int*offset);1490intparse_expiry_date(const char*date,unsigned long*timestamp);1491voiddatestamp(struct strbuf *out);1492#define approxidate(s) approxidate_careful((s), NULL)1493unsigned longapproxidate_careful(const char*,int*);1494unsigned longapproxidate_relative(const char*date,const struct timeval *now);1495voidparse_date_format(const char*format,struct date_mode *mode);1496intdate_overflows(unsigned long date);14971498#define IDENT_STRICT 11499#define IDENT_NO_DATE 21500#define IDENT_NO_NAME 41501externconst char*git_author_info(int);1502externconst char*git_committer_info(int);1503externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1504externconst char*fmt_name(const char*name,const char*email);1505externconst char*ident_default_name(void);1506externconst char*ident_default_email(void);1507externconst char*git_editor(void);1508externconst char*git_pager(int stdout_is_tty);1509externintgit_ident_config(const char*,const char*,void*);1510externvoidreset_ident_date(void);15111512struct ident_split {1513const char*name_begin;1514const char*name_end;1515const char*mail_begin;1516const char*mail_end;1517const char*date_begin;1518const char*date_end;1519const char*tz_begin;1520const char*tz_end;1521};1522/*1523 * Signals an success with 0, but time part of the result may be NULL1524 * if the input lacks timestamp and zone1525 */1526externintsplit_ident_line(struct ident_split *,const char*,int);15271528/*1529 * Like show_date, but pull the timestamp and tz parameters from1530 * the ident_split. It will also sanity-check the values and produce1531 * a well-known sentinel date if they appear bogus.1532 */1533const char*show_ident_date(const struct ident_split *id,1534const struct date_mode *mode);15351536/*1537 * Compare split idents for equality or strict ordering. Note that we1538 * compare only the ident part of the line, ignoring any timestamp.1539 *1540 * Because there are two fields, we must choose one as the primary key; we1541 * currently arbitrarily pick the email.1542 */1543externintident_cmp(const struct ident_split *,const struct ident_split *);15441545struct checkout {1546struct index_state *istate;1547const char*base_dir;1548int base_dir_len;1549unsigned force:1,1550 quiet:1,1551 not_new:1,1552 refresh_cache:1;1553};1554#define CHECKOUT_INIT { NULL,"" }15551556#define TEMPORARY_FILENAME_LENGTH 251557externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);15581559struct cache_def {1560struct strbuf path;1561int flags;1562int track_flags;1563int prefix_len_stat_func;1564};1565#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1566staticinlinevoidcache_def_clear(struct cache_def *cache)1567{1568strbuf_release(&cache->path);1569}15701571externinthas_symlink_leading_path(const char*name,int len);1572externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1573externintcheck_leading_path(const char*name,int len);1574externinthas_dirs_only_path(const char*name,int len,int prefix_len);1575externvoidschedule_dir_for_removal(const char*name,int len);1576externvoidremove_scheduled_dirs(void);15771578externstruct alternate_object_database {1579struct alternate_object_database *next;15801581/* see alt_scratch_buf() */1582struct strbuf scratch;1583size_t base_len;15841585char path[FLEX_ARRAY];1586} *alt_odb_list;1587externvoidprepare_alt_odb(void);1588externvoidread_info_alternates(const char* relative_base,int depth);1589externchar*compute_alternate_path(const char*path,struct strbuf *err);1590typedefintalt_odb_fn(struct alternate_object_database *,void*);1591externintforeach_alt_odb(alt_odb_fn,void*);15921593/*1594 * Allocate a "struct alternate_object_database" but do _not_ actually1595 * add it to the list of alternates.1596 */1597struct alternate_object_database *alloc_alt_odb(const char*dir);15981599/*1600 * Add the directory to the on-disk alternates file; the new entry will also1601 * take effect in the current process.1602 */1603externvoidadd_to_alternates_file(const char*dir);16041605/*1606 * Add the directory to the in-memory list of alternates (along with any1607 * recursive alternates it points to), but do not modify the on-disk alternates1608 * file.1609 */1610externvoidadd_to_alternates_memory(const char*dir);16111612/*1613 * Returns a scratch strbuf pre-filled with the alternate object directory,1614 * including a trailing slash, which can be used to access paths in the1615 * alternate. Always use this over direct access to alt->scratch, as it1616 * cleans up any previous use of the scratch buffer.1617 */1618externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);16191620struct pack_window {1621struct pack_window *next;1622unsigned char*base;1623 off_t offset;1624size_t len;1625unsigned int last_used;1626unsigned int inuse_cnt;1627};16281629externstruct packed_git {1630struct packed_git *next;1631struct pack_window *windows;1632 off_t pack_size;1633const void*index_data;1634size_t index_size;1635uint32_t num_objects;1636uint32_t num_bad_objects;1637unsigned char*bad_object_sha1;1638int index_version;1639time_t mtime;1640int pack_fd;1641unsigned pack_local:1,1642 pack_keep:1,1643 freshened:1,1644 do_not_close:1;1645unsigned char sha1[20];1646struct revindex_entry *revindex;1647/* something like ".git/objects/pack/xxxxx.pack" */1648char pack_name[FLEX_ARRAY];/* more */1649} *packed_git;16501651/*1652 * A most-recently-used ordered version of the packed_git list, which can1653 * be iterated instead of packed_git (and marked via mru_mark).1654 */1655struct mru;1656externstruct mru *packed_git_mru;16571658struct pack_entry {1659 off_t offset;1660unsigned char sha1[20];1661struct packed_git *p;1662};16631664externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path);16651666/* A hook to report invalid files in pack directory */1667#define PACKDIR_FILE_PACK 11668#define PACKDIR_FILE_IDX 21669#define PACKDIR_FILE_GARBAGE 41670externvoid(*report_garbage)(unsigned seen_bits,const char*path);16711672externvoidprepare_packed_git(void);1673externvoidreprepare_packed_git(void);1674externvoidinstall_packed_git(struct packed_git *pack);16751676/*1677 * Give a rough count of objects in the repository. This sacrifices accuracy1678 * for speed.1679 */1680unsigned longapproximate_object_count(void);16811682externstruct packed_git *find_sha1_pack(const unsigned char*sha1,1683struct packed_git *packs);16841685externvoidpack_report(void);16861687/*1688 * Create a temporary file rooted in the object database directory, or1689 * die on failure. The filename is taken from "pattern", which should have the1690 * usual "XXXXXX" trailer, and the resulting filename is written into the1691 * "template" buffer. Returns the open descriptor.1692 */1693externintodb_mkstemp(struct strbuf *template,const char*pattern);16941695/*1696 * Generate the filename to be used for a pack file with checksum "sha1" and1697 * extension "ext". The result is written into the strbuf "buf", overwriting1698 * any existing contents. A pointer to buf->buf is returned as a convenience.1699 *1700 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"1701 */1702externchar*odb_pack_name(struct strbuf *buf,const unsigned char*sha1,const char*ext);17031704/*1705 * Create a pack .keep file named "name" (which should generally be the output1706 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1707 * error.1708 */1709externintodb_pack_keep(const char*name);17101711/*1712 * mmap the index file for the specified packfile (if it is not1713 * already mmapped). Return 0 on success.1714 */1715externintopen_pack_index(struct packed_git *);17161717/*1718 * munmap the index file for the specified packfile (if it is1719 * currently mmapped).1720 */1721externvoidclose_pack_index(struct packed_git *);17221723externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*);1724externvoidclose_pack_windows(struct packed_git *);1725externvoidclose_all_packs(void);1726externvoidunuse_pack(struct pack_window **);1727externvoidclear_delta_base_cache(void);1728externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local);17291730/*1731 * Make sure that a pointer access into an mmap'd index file is within bounds,1732 * and can provide at least 8 bytes of data.1733 *1734 * Note that this is only necessary for variable-length segments of the file1735 * (like the 64-bit extended offset table), as we compare the size to the1736 * fixed-length parts when we open the file.1737 */1738externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr);17391740/*1741 * Return the SHA-1 of the nth object within the specified packfile.1742 * Open the index if it is not already open. The return value points1743 * at the SHA-1 within the mmapped index. Return NULL if there is an1744 * error.1745 */1746externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n);1747/*1748 * Like nth_packed_object_sha1, but write the data into the object specified by1749 * the the first argument. Returns the first argument on success, and NULL on1750 * error.1751 */1752externconst struct object_id *nth_packed_object_oid(struct object_id *,struct packed_git *,uint32_t n);17531754/*1755 * Return the offset of the nth object within the specified packfile.1756 * The index must already be opened.1757 */1758extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n);17591760/*1761 * If the object named sha1 is present in the specified packfile,1762 * return its offset within the packfile; otherwise, return 0.1763 */1764extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *);17651766externintis_pack_valid(struct packed_git *);1767externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*);1768externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep);1769externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t);1770externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*);17711772/*1773 * Iterate over the files in the loose-object parts of the object1774 * directory "path", triggering the following callbacks:1775 *1776 * - loose_object is called for each loose object we find.1777 *1778 * - loose_cruft is called for any files that do not appear to be1779 * loose objects. Note that we only look in the loose object1780 * directories "objects/[0-9a-f]{2}/", so we will not report1781 * "objects/foobar" as cruft.1782 *1783 * - loose_subdir is called for each top-level hashed subdirectory1784 * of the object directory (e.g., "$OBJDIR/f0"). It is called1785 * after the objects in the directory are processed.1786 *1787 * Any callback that is NULL will be ignored. Callbacks returning non-zero1788 * will end the iteration.1789 *1790 * In the "buf" variant, "path" is a strbuf which will also be used as a1791 * scratch buffer, but restored to its original contents before1792 * the function returns.1793 */1794typedefinteach_loose_object_fn(const struct object_id *oid,1795const char*path,1796void*data);1797typedefinteach_loose_cruft_fn(const char*basename,1798const char*path,1799void*data);1800typedefinteach_loose_subdir_fn(int nr,1801const char*path,1802void*data);1803intfor_each_loose_file_in_objdir(const char*path,1804 each_loose_object_fn obj_cb,1805 each_loose_cruft_fn cruft_cb,1806 each_loose_subdir_fn subdir_cb,1807void*data);1808intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1809 each_loose_object_fn obj_cb,1810 each_loose_cruft_fn cruft_cb,1811 each_loose_subdir_fn subdir_cb,1812void*data);18131814/*1815 * Iterate over loose and packed objects in both the local1816 * repository and any alternates repositories (unless the1817 * LOCAL_ONLY flag is set).1818 */1819#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11820typedefinteach_packed_object_fn(const struct object_id *oid,1821struct packed_git *pack,1822uint32_t pos,1823void*data);1824externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);1825externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags);18261827struct object_info {1828/* Request */1829enum object_type *typep;1830unsigned long*sizep;1831 off_t *disk_sizep;1832unsigned char*delta_base_sha1;1833struct strbuf *typename;18341835/* Response */1836enum{1837 OI_CACHED,1838 OI_LOOSE,1839 OI_PACKED,1840 OI_DBCACHED1841} whence;1842union{1843/*1844 * struct {1845 * ... Nothing to expose in this case1846 * } cached;1847 * struct {1848 * ... Nothing to expose in this case1849 * } loose;1850 */1851struct{1852struct packed_git *pack;1853 off_t offset;1854unsigned int is_delta;1855} packed;1856} u;1857};18581859/*1860 * Initializer for a "struct object_info" that wants no items. You may1861 * also memset() the memory to all-zeroes.1862 */1863#define OBJECT_INFO_INIT {NULL}18641865externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);1866externintpacked_object_info(struct packed_git *pack, off_t offset,struct object_info *);18671868/* Dumb servers support */1869externintupdate_server_info(int);18701871externconst char*get_log_output_encoding(void);1872externconst char*get_commit_output_encoding(void);18731874/*1875 * This is a hack for test programs like test-dump-untracked-cache to1876 * ensure that they do not modify the untracked cache when reading it.1877 * Do not use it otherwise!1878 */1879externint ignore_untracked_cache_config;18801881externintcommitter_ident_sufficiently_given(void);1882externintauthor_ident_sufficiently_given(void);18831884externconst char*git_commit_encoding;1885externconst char*git_log_output_encoding;1886externconst char*git_mailmap_file;1887externconst char*git_mailmap_blob;18881889/* IO helper functions */1890externvoidmaybe_flush_or_die(FILE*,const char*);1891__attribute__((format(printf,2,3)))1892externvoidfprintf_or_die(FILE*,const char*fmt, ...);18931894#define COPY_READ_ERROR (-2)1895#define COPY_WRITE_ERROR (-3)1896externintcopy_fd(int ifd,int ofd);1897externintcopy_file(const char*dst,const char*src,int mode);1898externintcopy_file_with_time(const char*dst,const char*src,int mode);18991900externvoidwrite_or_die(int fd,const void*buf,size_t count);1901externvoidfsync_or_die(int fd,const char*);19021903extern ssize_t read_in_full(int fd,void*buf,size_t count);1904extern ssize_t write_in_full(int fd,const void*buf,size_t count);1905extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);19061907staticinline ssize_t write_str_in_full(int fd,const char*str)1908{1909returnwrite_in_full(fd, str,strlen(str));1910}19111912/**1913 * Open (and truncate) the file at path, write the contents of buf to it,1914 * and close it. Dies if any errors are encountered.1915 */1916externvoidwrite_file_buf(const char*path,const char*buf,size_t len);19171918/**1919 * Like write_file_buf(), but format the contents into a buffer first.1920 * Additionally, write_file() will append a newline if one is not already1921 * present, making it convenient to write text files:1922 *1923 * write_file(path, "counter: %d", ctr);1924 */1925__attribute__((format(printf,2,3)))1926externvoidwrite_file(const char*path,const char*fmt, ...);19271928/* pager.c */1929externvoidsetup_pager(void);1930externintpager_in_use(void);1931externint pager_use_color;1932externintterm_columns(void);1933externintdecimal_width(uintmax_t);1934externintcheck_pager_config(const char*cmd);1935externvoidprepare_pager_args(struct child_process *,const char*pager);19361937externconst char*editor_program;1938externconst char*askpass_program;1939externconst char*excludes_file;19401941/* base85 */1942intdecode_85(char*dst,const char*line,int linelen);1943voidencode_85(char*buf,const unsigned char*data,int bytes);19441945/* alloc.c */1946externvoid*alloc_blob_node(void);1947externvoid*alloc_tree_node(void);1948externvoid*alloc_commit_node(void);1949externvoid*alloc_tag_node(void);1950externvoid*alloc_object_node(void);1951externvoidalloc_report(void);1952externunsigned intalloc_commit_index(void);19531954/* pkt-line.c */1955voidpacket_trace_identity(const char*prog);19561957/* add */1958/*1959 * return 0 if success, 1 - if addition of a file failed and1960 * ADD_FILES_IGNORE_ERRORS was specified in flags1961 */1962intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);19631964/* diff.c */1965externint diff_auto_refresh_index;19661967/* match-trees.c */1968voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);1969voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);19701971/*1972 * whitespace rules.1973 * used by both diff and apply1974 * last two digits are tab width1975 */1976#define WS_BLANK_AT_EOL 01001977#define WS_SPACE_BEFORE_TAB 02001978#define WS_INDENT_WITH_NON_TAB 04001979#define WS_CR_AT_EOL 010001980#define WS_BLANK_AT_EOF 020001981#define WS_TAB_IN_INDENT 040001982#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1983#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1984#define WS_TAB_WIDTH_MASK 0771985externunsigned whitespace_rule_cfg;1986externunsignedwhitespace_rule(const char*);1987externunsignedparse_whitespace_rule(const char*);1988externunsignedws_check(const char*line,int len,unsigned ws_rule);1989externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1990externchar*whitespace_error_string(unsigned ws);1991externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1992externintws_blank_line(const char*line,int len,unsigned ws_rule);1993#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)19941995/* ls-files */1996voidoverlay_tree_on_cache(const char*tree_name,const char*prefix);19971998char*alias_lookup(const char*alias);1999intsplit_cmdline(char*cmdline,const char***argv);2000/* Takes a negative value returned by split_cmdline */2001const char*split_cmdline_strerror(int cmdline_errno);20022003/* setup.c */2004struct startup_info {2005int have_repository;2006const char*prefix;2007};2008externstruct startup_info *startup_info;20092010/* merge.c */2011struct commit_list;2012inttry_merge_command(const char*strategy,size_t xopts_nr,2013const char**xopts,struct commit_list *common,2014const char*head_arg,struct commit_list *remotes);2015intcheckout_fast_forward(const unsigned char*from,2016const unsigned char*to,2017int overwrite_ignore);201820192020intsane_execvp(const char*file,char*const argv[]);20212022/*2023 * A struct to encapsulate the concept of whether a file has changed2024 * since we last checked it. This uses criteria similar to those used2025 * for the index.2026 */2027struct stat_validity {2028struct stat_data *sd;2029};20302031voidstat_validity_clear(struct stat_validity *sv);20322033/*2034 * Returns 1 if the path is a regular file (or a symlink to a regular2035 * file) and matches the saved stat_validity, 0 otherwise. A missing2036 * or inaccessible file is considered a match if the struct was just2037 * initialized, or if the previous update found an inaccessible file.2038 */2039intstat_validity_check(struct stat_validity *sv,const char*path);20402041/*2042 * Update the stat_validity from a file opened at descriptor fd. If2043 * the file is missing, inaccessible, or not a regular file, then2044 * future calls to stat_validity_check will match iff one of those2045 * conditions continues to be true.2046 */2047voidstat_validity_update(struct stat_validity *sv,int fd);20482049intversioncmp(const char*s1,const char*s2);2050voidsleep_millisec(int millisec);20512052/*2053 * Create a directory and (if share is nonzero) adjust its permissions2054 * according to the shared_repository setting. Only use this for2055 * directories under $GIT_DIR. Don't use it for working tree2056 * directories.2057 */2058voidsafe_create_dir(const char*dir,int share);20592060#endif/* CACHE_H */