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 GIT_DIR of the repository that contains the current working directory, 529 * without changing the working directory or other global state. The result is 530 * appended to gitdir. The return value is either NULL if no repository was 531 * found, or pointing to the path inside gitdir's buffer. 532 */ 533externconst char*discover_git_directory(struct strbuf *gitdir); 534externconst char*setup_git_directory_gently(int*); 535externconst char*setup_git_directory(void); 536externchar*prefix_path(const char*prefix,int len,const char*path); 537externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 538 539/* 540 * Concatenate "prefix" (if len is non-zero) and "path", with no 541 * connecting characters (so "prefix" should end with a "/"). 542 * Unlike prefix_path, this should be used if the named file does 543 * not have to interact with index entry; i.e. name of a random file 544 * on the filesystem. 545 * 546 * The return value is always a newly allocated string (even if the 547 * prefix was empty). 548 */ 549externchar*prefix_filename(const char*prefix,const char*path); 550 551externintcheck_filename(const char*prefix,const char*name); 552externvoidverify_filename(const char*prefix, 553const char*name, 554int diagnose_misspelt_rev); 555externvoidverify_non_filename(const char*prefix,const char*name); 556externintpath_inside_repo(const char*prefix,const char*path); 557 558#define INIT_DB_QUIET 0x0001 559#define INIT_DB_EXIST_OK 0x0002 560 561externintinit_db(const char*git_dir,const char*real_git_dir, 562const char*template_dir,unsigned int flags); 563 564externvoidsanitize_stdfds(void); 565externintdaemonize(void); 566 567#define alloc_nr(x) (((x)+16)*3/2) 568 569/* 570 * Realloc the buffer pointed at by variable 'x' so that it can hold 571 * at least 'nr' entries; the number of entries currently allocated 572 * is 'alloc', using the standard growing factor alloc_nr() macro. 573 * 574 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 575 */ 576#define ALLOC_GROW(x, nr, alloc) \ 577 do { \ 578 if ((nr) > alloc) { \ 579 if (alloc_nr(alloc) < (nr)) \ 580 alloc = (nr); \ 581 else \ 582 alloc = alloc_nr(alloc); \ 583 REALLOC_ARRAY(x, alloc); \ 584 } \ 585 } while (0) 586 587/* Initialize and use the cache information */ 588struct lock_file; 589externintread_index(struct index_state *); 590externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 591externintdo_read_index(struct index_state *istate,const char*path, 592int must_exist);/* for testting only! */ 593externintread_index_from(struct index_state *,const char*path); 594externintis_index_unborn(struct index_state *); 595externintread_index_unmerged(struct index_state *); 596#define COMMIT_LOCK (1 << 0) 597#define CLOSE_LOCK (1 << 1) 598externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 599externintdiscard_index(struct index_state *); 600externvoidmove_index_extensions(struct index_state *dst,struct index_state *src); 601externintunmerged_index(const struct index_state *); 602externintverify_path(const char*path); 603externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 604externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 605externvoidadjust_dirname_case(struct index_state *istate,char*name); 606externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 607 608/* 609 * Searches for an entry defined by name and namelen in the given index. 610 * If the return value is positive (including 0) it is the position of an 611 * exact match. If the return value is negative, the negated value minus 1 612 * is the position where the entry would be inserted. 613 * Example: The current index consists of these files and its stages: 614 * 615 * b#0, d#0, f#1, f#3 616 * 617 * index_name_pos(&index, "a", 1) -> -1 618 * index_name_pos(&index, "b", 1) -> 0 619 * index_name_pos(&index, "c", 1) -> -2 620 * index_name_pos(&index, "d", 1) -> 1 621 * index_name_pos(&index, "e", 1) -> -3 622 * index_name_pos(&index, "f", 1) -> -3 623 * index_name_pos(&index, "g", 1) -> -5 624 */ 625externintindex_name_pos(const struct index_state *,const char*name,int namelen); 626 627#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 628#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 629#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 630#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 631#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 632#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 633externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 634externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 635 636/* Remove entry, return true if there are more entries to go. */ 637externintremove_index_entry_at(struct index_state *,int pos); 638 639externvoidremove_marked_cache_entries(struct index_state *istate); 640externintremove_file_from_index(struct index_state *,const char*path); 641#define ADD_CACHE_VERBOSE 1 642#define ADD_CACHE_PRETEND 2 643#define ADD_CACHE_IGNORE_ERRORS 4 644#define ADD_CACHE_IGNORE_REMOVAL 8 645#define ADD_CACHE_INTENT 16 646/* 647 * These two are used to add the contents of the file at path 648 * to the index, marking the working tree up-to-date by storing 649 * the cached stat info in the resulting cache entry. A caller 650 * that has already run lstat(2) on the path can call 651 * add_to_index(), and all others can call add_file_to_index(); 652 * the latter will do necessary lstat(2) internally before 653 * calling the former. 654 */ 655externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 656externintadd_file_to_index(struct index_state *,const char*path,int flags); 657 658externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 659externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 660externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 661externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 662externintindex_name_is_other(const struct index_state *,const char*,int); 663externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 664 665/* do stat comparison even if CE_VALID is true */ 666#define CE_MATCH_IGNORE_VALID 01 667/* do not check the contents but report dirty on racily-clean entries */ 668#define CE_MATCH_RACY_IS_DIRTY 02 669/* do stat comparison even if CE_SKIP_WORKTREE is true */ 670#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 671/* ignore non-existent files during stat update */ 672#define CE_MATCH_IGNORE_MISSING 0x08 673/* enable stat refresh */ 674#define CE_MATCH_REFRESH 0x10 675externintie_match_stat(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 676externintie_modified(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 677 678#define HASH_WRITE_OBJECT 1 679#define HASH_FORMAT_CHECK 2 680externintindex_fd(unsigned char*sha1,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 681externintindex_path(unsigned char*sha1,const char*path,struct stat *st,unsigned flags); 682 683/* 684 * Record to sd the data from st that we use to check whether a file 685 * might have changed. 686 */ 687externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 688 689/* 690 * Return 0 if st is consistent with a file not having been changed 691 * since sd was filled. If there are differences, return a 692 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 693 * INODE_CHANGED, and DATA_CHANGED. 694 */ 695externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 696externintmatch_stat_data_racy(const struct index_state *istate, 697const struct stat_data *sd,struct stat *st); 698 699externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 700 701#define REFRESH_REALLY 0x0001/* ignore_valid */ 702#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 703#define REFRESH_QUIET 0x0004/* be quiet about it */ 704#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 705#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 706#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 707externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 708externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 709 710externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 711 712externinthold_locked_index(struct lock_file *,int); 713externvoidset_alternate_index_output(const char*); 714 715externint verify_index_checksum; 716 717/* Environment bits from configuration mechanism */ 718externint trust_executable_bit; 719externint trust_ctime; 720externint check_stat; 721externint quote_path_fully; 722externint has_symlinks; 723externint minimum_abbrev, default_abbrev; 724externint ignore_case; 725externint assume_unchanged; 726externint prefer_symlink_refs; 727externint warn_ambiguous_refs; 728externint warn_on_object_refname_ambiguity; 729externconst char*apply_default_whitespace; 730externconst char*apply_default_ignorewhitespace; 731externconst char*git_attributes_file; 732externconst char*git_hooks_path; 733externint zlib_compression_level; 734externint core_compression_level; 735externint pack_compression_level; 736externsize_t packed_git_window_size; 737externsize_t packed_git_limit; 738externsize_t delta_base_cache_limit; 739externunsigned long big_file_threshold; 740externunsigned long pack_size_limit_cfg; 741 742/* 743 * Accessors for the core.sharedrepository config which lazy-load the value 744 * from the config (if not already set). The "reset" function can be 745 * used to unset "set" or cached value, meaning that the value will be loaded 746 * fresh from the config file on the next call to get_shared_repository(). 747 */ 748voidset_shared_repository(int value); 749intget_shared_repository(void); 750voidreset_shared_repository(void); 751 752/* 753 * Do replace refs need to be checked this run? This variable is 754 * initialized to true unless --no-replace-object is used or 755 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 756 * commands that do not want replace references to be active. As an 757 * optimization it is also set to false if replace references have 758 * been sought but there were none. 759 */ 760externint check_replace_refs; 761externchar*git_replace_ref_base; 762 763externint fsync_object_files; 764externint core_preload_index; 765externint core_apply_sparse_checkout; 766externint precomposed_unicode; 767externint protect_hfs; 768externint protect_ntfs; 769externint git_db_env, git_index_env, git_graft_env, git_common_dir_env; 770 771/* 772 * Include broken refs in all ref iterations, which will 773 * generally choke dangerous operations rather than letting 774 * them silently proceed without taking the broken ref into 775 * account. 776 */ 777externint ref_paranoia; 778 779/* 780 * The character that begins a commented line in user-editable file 781 * that is subject to stripspace. 782 */ 783externchar comment_line_char; 784externint auto_comment_line_char; 785 786/* Windows only */ 787enum hide_dotfiles_type { 788 HIDE_DOTFILES_FALSE =0, 789 HIDE_DOTFILES_TRUE, 790 HIDE_DOTFILES_DOTGITONLY 791}; 792externenum hide_dotfiles_type hide_dotfiles; 793 794enum log_refs_config { 795 LOG_REFS_UNSET = -1, 796 LOG_REFS_NONE =0, 797 LOG_REFS_NORMAL, 798 LOG_REFS_ALWAYS 799}; 800externenum log_refs_config log_all_ref_updates; 801 802enum branch_track { 803 BRANCH_TRACK_UNSPECIFIED = -1, 804 BRANCH_TRACK_NEVER =0, 805 BRANCH_TRACK_REMOTE, 806 BRANCH_TRACK_ALWAYS, 807 BRANCH_TRACK_EXPLICIT, 808 BRANCH_TRACK_OVERRIDE 809}; 810 811enum rebase_setup_type { 812 AUTOREBASE_NEVER =0, 813 AUTOREBASE_LOCAL, 814 AUTOREBASE_REMOTE, 815 AUTOREBASE_ALWAYS 816}; 817 818enum push_default_type { 819 PUSH_DEFAULT_NOTHING =0, 820 PUSH_DEFAULT_MATCHING, 821 PUSH_DEFAULT_SIMPLE, 822 PUSH_DEFAULT_UPSTREAM, 823 PUSH_DEFAULT_CURRENT, 824 PUSH_DEFAULT_UNSPECIFIED 825}; 826 827externenum branch_track git_branch_track; 828externenum rebase_setup_type autorebase; 829externenum push_default_type push_default; 830 831enum object_creation_mode { 832 OBJECT_CREATION_USES_HARDLINKS =0, 833 OBJECT_CREATION_USES_RENAMES =1 834}; 835 836externenum object_creation_mode object_creation_mode; 837 838externchar*notes_ref_name; 839 840externint grafts_replace_parents; 841 842/* 843 * GIT_REPO_VERSION is the version we write by default. The 844 * _READ variant is the highest number we know how to 845 * handle. 846 */ 847#define GIT_REPO_VERSION 0 848#define GIT_REPO_VERSION_READ 1 849externint repository_format_precious_objects; 850 851struct repository_format { 852int version; 853int precious_objects; 854int is_bare; 855char*work_tree; 856struct string_list unknown_extensions; 857}; 858 859/* 860 * Read the repository format characteristics from the config file "path" into 861 * "format" struct. Returns the numeric version. On error, -1 is returned, 862 * format->version is set to -1, and all other fields in the struct are 863 * undefined. 864 */ 865intread_repository_format(struct repository_format *format,const char*path); 866 867/* 868 * Verify that the repository described by repository_format is something we 869 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 870 * any errors encountered. 871 */ 872intverify_repository_format(const struct repository_format *format, 873struct strbuf *err); 874 875/* 876 * Check the repository format version in the path found in get_git_dir(), 877 * and die if it is a version we don't understand. Generally one would 878 * set_git_dir() before calling this, and use it only for "are we in a valid 879 * repo?". 880 */ 881externvoidcheck_repository_format(void); 882 883#define MTIME_CHANGED 0x0001 884#define CTIME_CHANGED 0x0002 885#define OWNER_CHANGED 0x0004 886#define MODE_CHANGED 0x0008 887#define INODE_CHANGED 0x0010 888#define DATA_CHANGED 0x0020 889#define TYPE_CHANGED 0x0040 890 891/* 892 * Return a statically allocated filename, either generically (mkpath), in 893 * the repository directory (git_path), or in a submodule's repository 894 * directory (git_path_submodule). In all cases, note that the result 895 * may be overwritten by another call to _any_ of the functions. Consider 896 * using the safer "dup" or "strbuf" formats below (in some cases, the 897 * unsafe versions have already been removed). 898 */ 899externconst char*mkpath(const char*fmt, ...)__attribute__((format(printf,1,2))); 900externconst char*git_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 901externconst char*git_common_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 902 903externchar*mksnpath(char*buf,size_t n,const char*fmt, ...) 904__attribute__((format(printf,3,4))); 905externvoidstrbuf_git_path(struct strbuf *sb,const char*fmt, ...) 906__attribute__((format(printf,2,3))); 907externvoidstrbuf_git_common_path(struct strbuf *sb,const char*fmt, ...) 908__attribute__((format(printf,2,3))); 909externchar*git_path_buf(struct strbuf *buf,const char*fmt, ...) 910__attribute__((format(printf,2,3))); 911externintstrbuf_git_path_submodule(struct strbuf *sb,const char*path, 912const char*fmt, ...) 913__attribute__((format(printf,3,4))); 914externchar*git_pathdup(const char*fmt, ...) 915__attribute__((format(printf,1,2))); 916externchar*mkpathdup(const char*fmt, ...) 917__attribute__((format(printf,1,2))); 918externchar*git_pathdup_submodule(const char*path,const char*fmt, ...) 919__attribute__((format(printf,2,3))); 920 921externvoidreport_linked_checkout_garbage(void); 922 923/* 924 * You can define a static memoized git path like: 925 * 926 * static GIT_PATH_FUNC(git_path_foo, "FOO"); 927 * 928 * or use one of the global ones below. 929 */ 930#define GIT_PATH_FUNC(func, filename) \ 931 const char *func(void) \ 932 { \ 933 static char *ret; \ 934 if (!ret) \ 935 ret = git_pathdup(filename); \ 936 return ret; \ 937 } 938 939const char*git_path_cherry_pick_head(void); 940const char*git_path_revert_head(void); 941const char*git_path_squash_msg(void); 942const char*git_path_merge_msg(void); 943const char*git_path_merge_rr(void); 944const char*git_path_merge_mode(void); 945const char*git_path_merge_head(void); 946const char*git_path_fetch_head(void); 947const char*git_path_shallow(void); 948 949/* 950 * Return the name of the file in the local object database that would 951 * be used to store a loose object with the specified sha1. The 952 * return value is a pointer to a statically allocated buffer that is 953 * overwritten each time the function is called. 954 */ 955externconst char*sha1_file_name(const unsigned char*sha1); 956 957/* 958 * Return the name of the (local) packfile with the specified sha1 in 959 * its name. The return value is a pointer to memory that is 960 * overwritten each time this function is called. 961 */ 962externchar*sha1_pack_name(const unsigned char*sha1); 963 964/* 965 * Return the name of the (local) pack index file with the specified 966 * sha1 in its name. The return value is a pointer to memory that is 967 * overwritten each time this function is called. 968 */ 969externchar*sha1_pack_index_name(const unsigned char*sha1); 970 971/* 972 * Return an abbreviated sha1 unique within this repository's object database. 973 * The result will be at least `len` characters long, and will be NUL 974 * terminated. 975 * 976 * The non-`_r` version returns a static buffer which remains valid until 4 977 * more calls to find_unique_abbrev are made. 978 * 979 * The `_r` variant writes to a buffer supplied by the caller, which must be at 980 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 981 * written (excluding the NUL terminator). 982 * 983 * Note that while this version avoids the static buffer, it is not fully 984 * reentrant, as it calls into other non-reentrant git code. 985 */ 986externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 987externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 988 989externconst unsigned char null_sha1[GIT_MAX_RAWSZ]; 990externconst struct object_id null_oid; 991 992staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 993{ 994int i; 995 996for(i =0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 997if(*sha1 != *sha2) 998return*sha1 - *sha2; 999}10001001return0;1002}10031004staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2)1005{1006returnhashcmp(oid1->hash, oid2->hash);1007}10081009staticinlineintis_null_sha1(const unsigned char*sha1)1010{1011return!hashcmp(sha1, null_sha1);1012}10131014staticinlineintis_null_oid(const struct object_id *oid)1015{1016return!hashcmp(oid->hash, null_sha1);1017}10181019staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src)1020{1021memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);1022}10231024staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src)1025{1026hashcpy(dst->hash, src->hash);1027}10281029staticinlinestruct object_id *oiddup(const struct object_id *src)1030{1031struct object_id *dst =xmalloc(sizeof(struct object_id));1032oidcpy(dst, src);1033return dst;1034}10351036staticinlinevoidhashclr(unsigned char*hash)1037{1038memset(hash,0, GIT_SHA1_RAWSZ);1039}10401041staticinlinevoidoidclr(struct object_id *oid)1042{1043hashclr(oid->hash);1044}104510461047#define EMPTY_TREE_SHA1_HEX \1048"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1049#define EMPTY_TREE_SHA1_BIN_LITERAL \1050"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1051"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1052externconst struct object_id empty_tree_oid;1053#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10541055#define EMPTY_BLOB_SHA1_HEX \1056"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1057#define EMPTY_BLOB_SHA1_BIN_LITERAL \1058"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1059"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1060externconst struct object_id empty_blob_oid;1061#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)106210631064staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1065{1066return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1067}10681069staticinlineintis_empty_blob_oid(const struct object_id *oid)1070{1071return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1072}10731074staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1075{1076return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1077}10781079staticinlineintis_empty_tree_oid(const struct object_id *oid)1080{1081return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1082}10831084/* set default permissions by passing mode arguments to open(2) */1085intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1086intgit_mkstemp_mode(char*pattern,int mode);10871088/*1089 * NOTE NOTE NOTE!!1090 *1091 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1092 * not be changed. Old repositories have core.sharedrepository written in1093 * numeric format, and therefore these values are preserved for compatibility1094 * reasons.1095 */1096enum sharedrepo {1097 PERM_UMASK =0,1098 OLD_PERM_GROUP =1,1099 OLD_PERM_EVERYBODY =2,1100 PERM_GROUP =0660,1101 PERM_EVERYBODY =06641102};1103intgit_config_perm(const char*var,const char*value);1104intadjust_shared_perm(const char*path);11051106/*1107 * Create the directory containing the named path, using care to be1108 * somewhat safe against races. Return one of the scld_error values to1109 * indicate success/failure. On error, set errno to describe the1110 * problem.1111 *1112 * SCLD_VANISHED indicates that one of the ancestor directories of the1113 * path existed at one point during the function call and then1114 * suddenly vanished, probably because another process pruned the1115 * directory while we were working. To be robust against this kind of1116 * race, callers might want to try invoking the function again when it1117 * returns SCLD_VANISHED.1118 *1119 * safe_create_leading_directories() temporarily changes path while it1120 * is working but restores it before returning.1121 * safe_create_leading_directories_const() doesn't modify path, even1122 * temporarily.1123 */1124enum scld_error {1125 SCLD_OK =0,1126 SCLD_FAILED = -1,1127 SCLD_PERMS = -2,1128 SCLD_EXISTS = -3,1129 SCLD_VANISHED = -41130};1131enum scld_error safe_create_leading_directories(char*path);1132enum scld_error safe_create_leading_directories_const(const char*path);11331134/*1135 * Callback function for raceproof_create_file(). This function is1136 * expected to do something that makes dirname(path) permanent despite1137 * the fact that other processes might be cleaning up empty1138 * directories at the same time. Usually it will create a file named1139 * path, but alternatively it could create another file in that1140 * directory, or even chdir() into that directory. The function should1141 * return 0 if the action was completed successfully. On error, it1142 * should return a nonzero result and set errno.1143 * raceproof_create_file() treats two errno values specially:1144 *1145 * - ENOENT -- dirname(path) does not exist. In this case,1146 * raceproof_create_file() tries creating dirname(path)1147 * (and any parent directories, if necessary) and calls1148 * the function again.1149 *1150 * - EISDIR -- the file already exists and is a directory. In this1151 * case, raceproof_create_file() removes the directory if1152 * it is empty (and recursively any empty directories that1153 * it contains) and calls the function again.1154 *1155 * Any other errno causes raceproof_create_file() to fail with the1156 * callback's return value and errno.1157 *1158 * Obviously, this function should be OK with being called again if it1159 * fails with ENOENT or EISDIR. In other scenarios it will not be1160 * called again.1161 */1162typedefintcreate_file_fn(const char*path,void*cb);11631164/*1165 * Create a file in dirname(path) by calling fn, creating leading1166 * directories if necessary. Retry a few times in case we are racing1167 * with another process that is trying to clean up the directory that1168 * contains path. See the documentation for create_file_fn for more1169 * details.1170 *1171 * Return the value and set the errno that resulted from the most1172 * recent call of fn. fn is always called at least once, and will be1173 * called more than once if it returns ENOENT or EISDIR.1174 */1175intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11761177intmkdir_in_gitdir(const char*path);1178externchar*expand_user_path(const char*path,int real_home);1179const char*enter_repo(const char*path,int strict);1180staticinlineintis_absolute_path(const char*path)1181{1182returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1183}1184intis_directory(const char*);1185char*strbuf_realpath(struct strbuf *resolved,const char*path,1186int die_on_error);1187const char*real_path(const char*path);1188const char*real_path_if_valid(const char*path);1189char*real_pathdup(const char*path,int die_on_error);1190const char*absolute_path(const char*path);1191char*absolute_pathdup(const char*path);1192const char*remove_leading_path(const char*in,const char*prefix);1193const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1194intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1195intnormalize_path_copy(char*dst,const char*src);1196intlongest_ancestor_length(const char*path,struct string_list *prefixes);1197char*strip_path_suffix(const char*path,const char*suffix);1198intdaemon_avoid_alias(const char*path);1199externintis_ntfs_dotgit(const char*name);12001201/**1202 * Return a newly allocated string with the evaluation of1203 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1204 * "$HOME/.config/git/$filename". Return NULL upon error.1205 */1206externchar*xdg_config_home(const char*filename);12071208/**1209 * Return a newly allocated string with the evaluation of1210 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1211 * "$HOME/.cache/git/$filename". Return NULL upon error.1212 */1213externchar*xdg_cache_home(const char*filename);12141215/* object replacement */1216#define LOOKUP_REPLACE_OBJECT 11217#define LOOKUP_UNKNOWN_OBJECT 21218externvoid*read_sha1_file_extended(const unsigned char*sha1,enum object_type *type,unsigned long*size,unsigned flag);1219staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1220{1221returnread_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);1222}12231224/*1225 * This internal function is only declared here for the benefit of1226 * lookup_replace_object(). Please do not call it directly.1227 */1228externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);12291230/*1231 * If object sha1 should be replaced, return the replacement object's1232 * name (replaced recursively, if necessary). The return value is1233 * either sha1 or a pointer to a permanently-allocated value. When1234 * object replacement is suppressed, always return sha1.1235 */1236staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1237{1238if(!check_replace_refs)1239return sha1;1240returndo_lookup_replace_object(sha1);1241}12421243staticinlineconst unsigned char*lookup_replace_object_extended(const unsigned char*sha1,unsigned flag)1244{1245if(!(flag & LOOKUP_REPLACE_OBJECT))1246return sha1;1247returnlookup_replace_object(sha1);1248}12491250/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1251externintsha1_object_info(const unsigned char*,unsigned long*);1252externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1);1253externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1);1254externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,unsigned char*sha1,unsigned flags);1255externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*);1256externintforce_object_loose(const unsigned char*sha1,time_t mtime);1257externintgit_open_cloexec(const char*name,int flags);1258#define git_open(name) git_open_cloexec(name, O_RDONLY)1259externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1260externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1261externintparse_sha1_header(const char*hdr,unsigned long*sizep);12621263/* global flag to enable extra checks when accessing packed objects */1264externint do_check_packed_object_crc;12651266externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);12671268externintfinalize_object_file(const char*tmpfile,const char*filename);12691270externinthas_sha1_pack(const unsigned char*sha1);12711272/*1273 * Open the loose object at path, check its sha1, and return the contents,1274 * type, and size. If the object is a blob, then "contents" may return NULL,1275 * to allow streaming of large blobs.1276 *1277 * Returns 0 on success, negative on error (details may be written to stderr).1278 */1279intread_loose_object(const char*path,1280const unsigned char*expected_sha1,1281enum object_type *type,1282unsigned long*size,1283void**contents);12841285/*1286 * Return true iff we have an object named sha1, whether local or in1287 * an alternate object database, and whether packed or loose. This1288 * function does not respect replace references.1289 *1290 * If the QUICK flag is set, do not re-check the pack directory1291 * when we cannot find the object (this means we may give a false1292 * negative answer if another process is simultaneously repacking).1293 */1294#define HAS_SHA1_QUICK 0x11295externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1296staticinlineinthas_sha1_file(const unsigned char*sha1)1297{1298returnhas_sha1_file_with_flags(sha1,0);1299}13001301/* Same as the above, except for struct object_id. */1302externinthas_object_file(const struct object_id *oid);1303externinthas_object_file_with_flags(const struct object_id *oid,int flags);13041305/*1306 * Return true iff an alternate object database has a loose object1307 * with the specified name. This function does not respect replace1308 * references.1309 */1310externinthas_loose_object_nonlocal(const unsigned char*sha1);13111312externinthas_pack_index(const unsigned char*sha1);13131314externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);13151316/* Helper to check and "touch" a file */1317externintcheck_and_freshen_file(const char*fn,int freshen);13181319externconst signed char hexval_table[256];1320staticinlineunsigned inthexval(unsigned char c)1321{1322return hexval_table[c];1323}13241325/*1326 * Convert two consecutive hexadecimal digits into a char. Return a1327 * negative value on error. Don't run over the end of short strings.1328 */1329staticinlineinthex2chr(const char*s)1330{1331int val =hexval(s[0]);1332return(val <0) ? val : (val <<4) |hexval(s[1]);1333}13341335/* Convert to/from hex/sha1 representation */1336#define MINIMUM_ABBREV minimum_abbrev1337#define DEFAULT_ABBREV default_abbrev13381339/* used when the code does not know or care what the default abbrev is */1340#define FALLBACK_DEFAULT_ABBREV 713411342struct object_context {1343unsigned char tree[20];1344char path[PATH_MAX];1345unsigned mode;1346/*1347 * symlink_path is only used by get_tree_entry_follow_symlinks,1348 * and only for symlinks that point outside the repository.1349 */1350struct strbuf symlink_path;1351};13521353#define GET_SHA1_QUIETLY 011354#define GET_SHA1_COMMIT 021355#define GET_SHA1_COMMITTISH 041356#define GET_SHA1_TREE 0101357#define GET_SHA1_TREEISH 0201358#define GET_SHA1_BLOB 0401359#define GET_SHA1_FOLLOW_SYMLINKS 01001360#define GET_SHA1_ONLY_TO_DIE 0400013611362#define GET_SHA1_DISAMBIGUATORS \1363 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \1364 GET_SHA1_TREE | GET_SHA1_TREEISH | \1365 GET_SHA1_BLOB)13661367externintget_sha1(const char*str,unsigned char*sha1);1368externintget_sha1_commit(const char*str,unsigned char*sha1);1369externintget_sha1_committish(const char*str,unsigned char*sha1);1370externintget_sha1_tree(const char*str,unsigned char*sha1);1371externintget_sha1_treeish(const char*str,unsigned char*sha1);1372externintget_sha1_blob(const char*str,unsigned char*sha1);1373externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1374externintget_sha1_with_context(const char*str,unsigned flags,unsigned char*sha1,struct object_context *orc);13751376externintget_oid(const char*str,struct object_id *oid);13771378typedefinteach_abbrev_fn(const struct object_id *oid,void*);1379externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13801381externintset_disambiguate_hint_config(const char*var,const char*value);13821383/*1384 * Try to read a SHA1 in hexadecimal format from the 40 characters1385 * starting at hex. Write the 20-byte result to sha1 in binary form.1386 * Return 0 on success. Reading stops if a NUL is encountered in the1387 * input, so it is safe to pass this function an arbitrary1388 * null-terminated string.1389 */1390externintget_sha1_hex(const char*hex,unsigned char*sha1);1391externintget_oid_hex(const char*hex,struct object_id *sha1);13921393/*1394 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1395 * and writes the NUL-terminated output to the buffer `out`, which must be at1396 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1397 * convenience.1398 *1399 * The non-`_r` variant returns a static buffer, but uses a ring of 41400 * buffers, making it safe to make multiple calls for a single statement, like:1401 *1402 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1403 */1404externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1405externchar*oid_to_hex_r(char*out,const struct object_id *oid);1406externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1407externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */14081409/*1410 * Parse a 40-character hexadecimal object ID starting from hex, updating the1411 * pointer specified by end when parsing stops. The resulting object ID is1412 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1413 * other invalid character. end is only updated on success; otherwise, it is1414 * unmodified.1415 */1416externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);14171418/*1419 * This reads short-hand syntax that not only evaluates to a commit1420 * object name, but also can act as if the end user spelled the name1421 * of the branch from the command line.1422 *1423 * - "@{-N}" finds the name of the Nth previous branch we were on, and1424 * places the name of the branch in the given buf and returns the1425 * number of characters parsed if successful.1426 *1427 * - "<branch>@{upstream}" finds the name of the other ref that1428 * <branch> is configured to merge with (missing <branch> defaults1429 * to the current branch), and places the name of the branch in the1430 * given buf and returns the number of characters parsed if1431 * successful.1432 *1433 * If the input is not of the accepted format, it returns a negative1434 * number to signal an error.1435 *1436 * If the input was ok but there are not N branch switches in the1437 * reflog, it returns 0.1438 *1439 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1440 * expansions: local branches ("refs/heads/"), remote branches1441 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1442 * allowed, even ones to refs outside of those namespaces.1443 */1444#define INTERPRET_BRANCH_LOCAL (1<<0)1445#define INTERPRET_BRANCH_REMOTE (1<<1)1446#define INTERPRET_BRANCH_HEAD (1<<2)1447externintinterpret_branch_name(const char*str,int len,struct strbuf *,1448unsigned allowed);1449externintget_oid_mb(const char*str,struct object_id *oid);14501451externintvalidate_headref(const char*ref);14521453externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1454externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1455externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1456externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);14571458externvoid*read_object_with_reference(const unsigned char*sha1,1459const char*required_type,1460unsigned long*size,1461unsigned char*sha1_ret);14621463externstruct object *peel_to_type(const char*name,int namelen,1464struct object *o,enum object_type);14651466struct date_mode {1467enum date_mode_type {1468 DATE_NORMAL =0,1469 DATE_RELATIVE,1470 DATE_SHORT,1471 DATE_ISO8601,1472 DATE_ISO8601_STRICT,1473 DATE_RFC2822,1474 DATE_STRFTIME,1475 DATE_RAW,1476 DATE_UNIX1477} type;1478const char*strftime_fmt;1479int local;1480};14811482/*1483 * Convenience helper for passing a constant type, like:1484 *1485 * show_date(t, tz, DATE_MODE(NORMAL));1486 */1487#define DATE_MODE(t) date_mode_from_type(DATE_##t)1488struct date_mode *date_mode_from_type(enum date_mode_type type);14891490const char*show_date(timestamp_t time,int timezone,const struct date_mode *mode);1491voidshow_date_relative(timestamp_t time,int tz,const struct timeval *now,1492struct strbuf *timebuf);1493intparse_date(const char*date,struct strbuf *out);1494intparse_date_basic(const char*date, timestamp_t *timestamp,int*offset);1495intparse_expiry_date(const char*date, timestamp_t *timestamp);1496voiddatestamp(struct strbuf *out);1497#define approxidate(s) approxidate_careful((s), NULL)1498timestamp_t approxidate_careful(const char*,int*);1499timestamp_t approxidate_relative(const char*date,const struct timeval *now);1500voidparse_date_format(const char*format,struct date_mode *mode);1501intdate_overflows(timestamp_t date);15021503#define IDENT_STRICT 11504#define IDENT_NO_DATE 21505#define IDENT_NO_NAME 41506externconst char*git_author_info(int);1507externconst char*git_committer_info(int);1508externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1509externconst char*fmt_name(const char*name,const char*email);1510externconst char*ident_default_name(void);1511externconst char*ident_default_email(void);1512externconst char*git_editor(void);1513externconst char*git_pager(int stdout_is_tty);1514externintgit_ident_config(const char*,const char*,void*);1515externvoidreset_ident_date(void);15161517struct ident_split {1518const char*name_begin;1519const char*name_end;1520const char*mail_begin;1521const char*mail_end;1522const char*date_begin;1523const char*date_end;1524const char*tz_begin;1525const char*tz_end;1526};1527/*1528 * Signals an success with 0, but time part of the result may be NULL1529 * if the input lacks timestamp and zone1530 */1531externintsplit_ident_line(struct ident_split *,const char*,int);15321533/*1534 * Like show_date, but pull the timestamp and tz parameters from1535 * the ident_split. It will also sanity-check the values and produce1536 * a well-known sentinel date if they appear bogus.1537 */1538const char*show_ident_date(const struct ident_split *id,1539const struct date_mode *mode);15401541/*1542 * Compare split idents for equality or strict ordering. Note that we1543 * compare only the ident part of the line, ignoring any timestamp.1544 *1545 * Because there are two fields, we must choose one as the primary key; we1546 * currently arbitrarily pick the email.1547 */1548externintident_cmp(const struct ident_split *,const struct ident_split *);15491550struct checkout {1551struct index_state *istate;1552const char*base_dir;1553int base_dir_len;1554unsigned force:1,1555 quiet:1,1556 not_new:1,1557 refresh_cache:1;1558};1559#define CHECKOUT_INIT { NULL,"" }15601561#define TEMPORARY_FILENAME_LENGTH 251562externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);15631564struct cache_def {1565struct strbuf path;1566int flags;1567int track_flags;1568int prefix_len_stat_func;1569};1570#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1571staticinlinevoidcache_def_clear(struct cache_def *cache)1572{1573strbuf_release(&cache->path);1574}15751576externinthas_symlink_leading_path(const char*name,int len);1577externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1578externintcheck_leading_path(const char*name,int len);1579externinthas_dirs_only_path(const char*name,int len,int prefix_len);1580externvoidschedule_dir_for_removal(const char*name,int len);1581externvoidremove_scheduled_dirs(void);15821583externstruct alternate_object_database {1584struct alternate_object_database *next;15851586/* see alt_scratch_buf() */1587struct strbuf scratch;1588size_t base_len;15891590char path[FLEX_ARRAY];1591} *alt_odb_list;1592externvoidprepare_alt_odb(void);1593externvoidread_info_alternates(const char* relative_base,int depth);1594externchar*compute_alternate_path(const char*path,struct strbuf *err);1595typedefintalt_odb_fn(struct alternate_object_database *,void*);1596externintforeach_alt_odb(alt_odb_fn,void*);15971598/*1599 * Allocate a "struct alternate_object_database" but do _not_ actually1600 * add it to the list of alternates.1601 */1602struct alternate_object_database *alloc_alt_odb(const char*dir);16031604/*1605 * Add the directory to the on-disk alternates file; the new entry will also1606 * take effect in the current process.1607 */1608externvoidadd_to_alternates_file(const char*dir);16091610/*1611 * Add the directory to the in-memory list of alternates (along with any1612 * recursive alternates it points to), but do not modify the on-disk alternates1613 * file.1614 */1615externvoidadd_to_alternates_memory(const char*dir);16161617/*1618 * Returns a scratch strbuf pre-filled with the alternate object directory,1619 * including a trailing slash, which can be used to access paths in the1620 * alternate. Always use this over direct access to alt->scratch, as it1621 * cleans up any previous use of the scratch buffer.1622 */1623externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);16241625struct pack_window {1626struct pack_window *next;1627unsigned char*base;1628 off_t offset;1629size_t len;1630unsigned int last_used;1631unsigned int inuse_cnt;1632};16331634externstruct packed_git {1635struct packed_git *next;1636struct pack_window *windows;1637 off_t pack_size;1638const void*index_data;1639size_t index_size;1640uint32_t num_objects;1641uint32_t num_bad_objects;1642unsigned char*bad_object_sha1;1643int index_version;1644time_t mtime;1645int pack_fd;1646unsigned pack_local:1,1647 pack_keep:1,1648 freshened:1,1649 do_not_close:1;1650unsigned char sha1[20];1651struct revindex_entry *revindex;1652/* something like ".git/objects/pack/xxxxx.pack" */1653char pack_name[FLEX_ARRAY];/* more */1654} *packed_git;16551656/*1657 * A most-recently-used ordered version of the packed_git list, which can1658 * be iterated instead of packed_git (and marked via mru_mark).1659 */1660struct mru;1661externstruct mru *packed_git_mru;16621663struct pack_entry {1664 off_t offset;1665unsigned char sha1[20];1666struct packed_git *p;1667};16681669externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path);16701671/* A hook to report invalid files in pack directory */1672#define PACKDIR_FILE_PACK 11673#define PACKDIR_FILE_IDX 21674#define PACKDIR_FILE_GARBAGE 41675externvoid(*report_garbage)(unsigned seen_bits,const char*path);16761677externvoidprepare_packed_git(void);1678externvoidreprepare_packed_git(void);1679externvoidinstall_packed_git(struct packed_git *pack);16801681/*1682 * Give a rough count of objects in the repository. This sacrifices accuracy1683 * for speed.1684 */1685unsigned longapproximate_object_count(void);16861687externstruct packed_git *find_sha1_pack(const unsigned char*sha1,1688struct packed_git *packs);16891690externvoidpack_report(void);16911692/*1693 * Create a temporary file rooted in the object database directory, or1694 * die on failure. The filename is taken from "pattern", which should have the1695 * usual "XXXXXX" trailer, and the resulting filename is written into the1696 * "template" buffer. Returns the open descriptor.1697 */1698externintodb_mkstemp(struct strbuf *template,const char*pattern);16991700/*1701 * Generate the filename to be used for a pack file with checksum "sha1" and1702 * extension "ext". The result is written into the strbuf "buf", overwriting1703 * any existing contents. A pointer to buf->buf is returned as a convenience.1704 *1705 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"1706 */1707externchar*odb_pack_name(struct strbuf *buf,const unsigned char*sha1,const char*ext);17081709/*1710 * Create a pack .keep file named "name" (which should generally be the output1711 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1712 * error.1713 */1714externintodb_pack_keep(const char*name);17151716/*1717 * mmap the index file for the specified packfile (if it is not1718 * already mmapped). Return 0 on success.1719 */1720externintopen_pack_index(struct packed_git *);17211722/*1723 * munmap the index file for the specified packfile (if it is1724 * currently mmapped).1725 */1726externvoidclose_pack_index(struct packed_git *);17271728externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*);1729externvoidclose_pack_windows(struct packed_git *);1730externvoidclose_all_packs(void);1731externvoidunuse_pack(struct pack_window **);1732externvoidclear_delta_base_cache(void);1733externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local);17341735/*1736 * Make sure that a pointer access into an mmap'd index file is within bounds,1737 * and can provide at least 8 bytes of data.1738 *1739 * Note that this is only necessary for variable-length segments of the file1740 * (like the 64-bit extended offset table), as we compare the size to the1741 * fixed-length parts when we open the file.1742 */1743externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr);17441745/*1746 * Return the SHA-1 of the nth object within the specified packfile.1747 * Open the index if it is not already open. The return value points1748 * at the SHA-1 within the mmapped index. Return NULL if there is an1749 * error.1750 */1751externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n);1752/*1753 * Like nth_packed_object_sha1, but write the data into the object specified by1754 * the the first argument. Returns the first argument on success, and NULL on1755 * error.1756 */1757externconst struct object_id *nth_packed_object_oid(struct object_id *,struct packed_git *,uint32_t n);17581759/*1760 * Return the offset of the nth object within the specified packfile.1761 * The index must already be opened.1762 */1763extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n);17641765/*1766 * If the object named sha1 is present in the specified packfile,1767 * return its offset within the packfile; otherwise, return 0.1768 */1769extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *);17701771externintis_pack_valid(struct packed_git *);1772externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*);1773externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep);1774externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t);1775externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*);17761777/*1778 * Iterate over the files in the loose-object parts of the object1779 * directory "path", triggering the following callbacks:1780 *1781 * - loose_object is called for each loose object we find.1782 *1783 * - loose_cruft is called for any files that do not appear to be1784 * loose objects. Note that we only look in the loose object1785 * directories "objects/[0-9a-f]{2}/", so we will not report1786 * "objects/foobar" as cruft.1787 *1788 * - loose_subdir is called for each top-level hashed subdirectory1789 * of the object directory (e.g., "$OBJDIR/f0"). It is called1790 * after the objects in the directory are processed.1791 *1792 * Any callback that is NULL will be ignored. Callbacks returning non-zero1793 * will end the iteration.1794 *1795 * In the "buf" variant, "path" is a strbuf which will also be used as a1796 * scratch buffer, but restored to its original contents before1797 * the function returns.1798 */1799typedefinteach_loose_object_fn(const struct object_id *oid,1800const char*path,1801void*data);1802typedefinteach_loose_cruft_fn(const char*basename,1803const char*path,1804void*data);1805typedefinteach_loose_subdir_fn(int nr,1806const char*path,1807void*data);1808intfor_each_loose_file_in_objdir(const char*path,1809 each_loose_object_fn obj_cb,1810 each_loose_cruft_fn cruft_cb,1811 each_loose_subdir_fn subdir_cb,1812void*data);1813intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1814 each_loose_object_fn obj_cb,1815 each_loose_cruft_fn cruft_cb,1816 each_loose_subdir_fn subdir_cb,1817void*data);18181819/*1820 * Iterate over loose and packed objects in both the local1821 * repository and any alternates repositories (unless the1822 * LOCAL_ONLY flag is set).1823 */1824#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11825typedefinteach_packed_object_fn(const struct object_id *oid,1826struct packed_git *pack,1827uint32_t pos,1828void*data);1829externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);1830externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags);18311832struct object_info {1833/* Request */1834enum object_type *typep;1835unsigned long*sizep;1836 off_t *disk_sizep;1837unsigned char*delta_base_sha1;1838struct strbuf *typename;18391840/* Response */1841enum{1842 OI_CACHED,1843 OI_LOOSE,1844 OI_PACKED,1845 OI_DBCACHED1846} whence;1847union{1848/*1849 * struct {1850 * ... Nothing to expose in this case1851 * } cached;1852 * struct {1853 * ... Nothing to expose in this case1854 * } loose;1855 */1856struct{1857struct packed_git *pack;1858 off_t offset;1859unsigned int is_delta;1860} packed;1861} u;1862};18631864/*1865 * Initializer for a "struct object_info" that wants no items. You may1866 * also memset() the memory to all-zeroes.1867 */1868#define OBJECT_INFO_INIT {NULL}18691870externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);1871externintpacked_object_info(struct packed_git *pack, off_t offset,struct object_info *);18721873/* Dumb servers support */1874externintupdate_server_info(int);18751876/* git_config_parse_key() returns these negated: */1877#define CONFIG_INVALID_KEY 11878#define CONFIG_NO_SECTION_OR_NAME 21879/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */1880#define CONFIG_NO_LOCK -11881#define CONFIG_INVALID_FILE 31882#define CONFIG_NO_WRITE 41883#define CONFIG_NOTHING_SET 51884#define CONFIG_INVALID_PATTERN 61885#define CONFIG_GENERIC_ERROR 718861887#define CONFIG_REGEX_NONE ((void *)1)18881889struct git_config_source {1890unsigned int use_stdin:1;1891const char*file;1892const char*blob;1893};18941895enum config_origin_type {1896 CONFIG_ORIGIN_BLOB,1897 CONFIG_ORIGIN_FILE,1898 CONFIG_ORIGIN_STDIN,1899 CONFIG_ORIGIN_SUBMODULE_BLOB,1900 CONFIG_ORIGIN_CMDLINE1901};19021903struct config_options {1904unsigned int respect_includes :1;1905const char*git_dir;1906};19071908typedefint(*config_fn_t)(const char*,const char*,void*);1909externintgit_default_config(const char*,const char*,void*);1910externintgit_config_from_file(config_fn_t fn,const char*,void*);1911externintgit_config_from_mem(config_fn_t fn,const enum config_origin_type,1912const char*name,const char*buf,size_t len,void*data);1913externintgit_config_from_blob_sha1(config_fn_t fn,const char*name,1914const unsigned char*sha1,void*data);1915externvoidgit_config_push_parameter(const char*text);1916externintgit_config_from_parameters(config_fn_t fn,void*data);1917externvoidread_early_config(config_fn_t cb,void*data);1918externvoidgit_config(config_fn_t fn,void*);1919externintgit_config_with_options(config_fn_t fn,void*,1920struct git_config_source *config_source,1921const struct config_options *opts);1922externintgit_parse_ulong(const char*,unsigned long*);1923externintgit_parse_maybe_bool(const char*);1924externintgit_config_int(const char*,const char*);1925externint64_tgit_config_int64(const char*,const char*);1926externunsigned longgit_config_ulong(const char*,const char*);1927extern ssize_t git_config_ssize_t(const char*,const char*);1928externintgit_config_bool_or_int(const char*,const char*,int*);1929externintgit_config_bool(const char*,const char*);1930externintgit_config_maybe_bool(const char*,const char*);1931externintgit_config_string(const char**,const char*,const char*);1932externintgit_config_pathname(const char**,const char*,const char*);1933externintgit_config_set_in_file_gently(const char*,const char*,const char*);1934externvoidgit_config_set_in_file(const char*,const char*,const char*);1935externintgit_config_set_gently(const char*,const char*);1936externvoidgit_config_set(const char*,const char*);1937externintgit_config_parse_key(const char*,char**,int*);1938externintgit_config_key_is_valid(const char*key);1939externintgit_config_set_multivar_gently(const char*,const char*,const char*,int);1940externvoidgit_config_set_multivar(const char*,const char*,const char*,int);1941externintgit_config_set_multivar_in_file_gently(const char*,const char*,const char*,const char*,int);1942externvoidgit_config_set_multivar_in_file(const char*,const char*,const char*,const char*,int);1943externintgit_config_rename_section(const char*,const char*);1944externintgit_config_rename_section_in_file(const char*,const char*,const char*);1945externconst char*git_etc_gitconfig(void);1946externintgit_env_bool(const char*,int);1947externunsigned longgit_env_ulong(const char*,unsigned long);1948externintgit_config_system(void);1949externintconfig_error_nonbool(const char*);1950#if defined(__GNUC__)1951#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1952#endif1953externconst char*get_log_output_encoding(void);1954externconst char*get_commit_output_encoding(void);19551956externintgit_config_parse_parameter(const char*, config_fn_t fn,void*data);19571958enum config_scope {1959 CONFIG_SCOPE_UNKNOWN =0,1960 CONFIG_SCOPE_SYSTEM,1961 CONFIG_SCOPE_GLOBAL,1962 CONFIG_SCOPE_REPO,1963 CONFIG_SCOPE_CMDLINE,1964};19651966externenum config_scope current_config_scope(void);1967externconst char*current_config_origin_type(void);1968externconst char*current_config_name(void);19691970struct config_include_data {1971int depth;1972 config_fn_t fn;1973void*data;1974const struct config_options *opts;1975};1976#define CONFIG_INCLUDE_INIT { 0 }1977externintgit_config_include(const char*name,const char*value,void*data);19781979/*1980 * Match and parse a config key of the form:1981 *1982 * section.(subsection.)?key1983 *1984 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1985 * we return -1 if it does not match, 0 otherwise. The subsection and key1986 * out-parameters are filled by the function (and *subsection is NULL if it is1987 * missing).1988 *1989 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if1990 * there is no subsection at all.1991 */1992externintparse_config_key(const char*var,1993const char*section,1994const char**subsection,int*subsection_len,1995const char**key);19961997struct config_set_element {1998struct hashmap_entry ent;1999char*key;2000struct string_list value_list;2001};20022003struct configset_list_item {2004struct config_set_element *e;2005int value_index;2006};20072008/*2009 * the contents of the list are ordered according to their2010 * position in the config files and order of parsing the files.2011 * (i.e. key-value pair at the last position of .git/config will2012 * be at the last item of the list)2013 */2014struct configset_list {2015struct configset_list_item *items;2016unsigned int nr, alloc;2017};20182019struct config_set {2020struct hashmap config_hash;2021int hash_initialized;2022struct configset_list list;2023};20242025externvoidgit_configset_init(struct config_set *cs);2026externintgit_configset_add_file(struct config_set *cs,const char*filename);2027externintgit_configset_get_value(struct config_set *cs,const char*key,const char**value);2028externconst struct string_list *git_configset_get_value_multi(struct config_set *cs,const char*key);2029externvoidgit_configset_clear(struct config_set *cs);2030externintgit_configset_get_string_const(struct config_set *cs,const char*key,const char**dest);2031externintgit_configset_get_string(struct config_set *cs,const char*key,char**dest);2032externintgit_configset_get_int(struct config_set *cs,const char*key,int*dest);2033externintgit_configset_get_ulong(struct config_set *cs,const char*key,unsigned long*dest);2034externintgit_configset_get_bool(struct config_set *cs,const char*key,int*dest);2035externintgit_configset_get_bool_or_int(struct config_set *cs,const char*key,int*is_bool,int*dest);2036externintgit_configset_get_maybe_bool(struct config_set *cs,const char*key,int*dest);2037externintgit_configset_get_pathname(struct config_set *cs,const char*key,const char**dest);20382039externintgit_config_get_value(const char*key,const char**value);2040externconst struct string_list *git_config_get_value_multi(const char*key);2041externvoidgit_config_clear(void);2042externvoidgit_config_iter(config_fn_t fn,void*data);2043externintgit_config_get_string_const(const char*key,const char**dest);2044externintgit_config_get_string(const char*key,char**dest);2045externintgit_config_get_int(const char*key,int*dest);2046externintgit_config_get_ulong(const char*key,unsigned long*dest);2047externintgit_config_get_bool(const char*key,int*dest);2048externintgit_config_get_bool_or_int(const char*key,int*is_bool,int*dest);2049externintgit_config_get_maybe_bool(const char*key,int*dest);2050externintgit_config_get_pathname(const char*key,const char**dest);2051externintgit_config_get_untracked_cache(void);2052externintgit_config_get_split_index(void);2053externintgit_config_get_max_percent_split_change(void);20542055/* This dies if the configured or default date is in the future */2056externintgit_config_get_expiry(const char*key,const char**output);20572058/*2059 * This is a hack for test programs like test-dump-untracked-cache to2060 * ensure that they do not modify the untracked cache when reading it.2061 * Do not use it otherwise!2062 */2063externint ignore_untracked_cache_config;20642065struct key_value_info {2066const char*filename;2067int linenr;2068enum config_origin_type origin_type;2069enum config_scope scope;2070};20712072extern NORETURN voidgit_die_config(const char*key,const char*err, ...)__attribute__((format(printf,2,3)));2073extern NORETURN voidgit_die_config_linenr(const char*key,const char*filename,int linenr);20742075externintcommitter_ident_sufficiently_given(void);2076externintauthor_ident_sufficiently_given(void);20772078externconst char*git_commit_encoding;2079externconst char*git_log_output_encoding;2080externconst char*git_mailmap_file;2081externconst char*git_mailmap_blob;20822083/* IO helper functions */2084externvoidmaybe_flush_or_die(FILE*,const char*);2085__attribute__((format(printf,2,3)))2086externvoidfprintf_or_die(FILE*,const char*fmt, ...);20872088#define COPY_READ_ERROR (-2)2089#define COPY_WRITE_ERROR (-3)2090externintcopy_fd(int ifd,int ofd);2091externintcopy_file(const char*dst,const char*src,int mode);2092externintcopy_file_with_time(const char*dst,const char*src,int mode);20932094externvoidwrite_or_die(int fd,const void*buf,size_t count);2095externvoidfsync_or_die(int fd,const char*);20962097extern ssize_t read_in_full(int fd,void*buf,size_t count);2098extern ssize_t write_in_full(int fd,const void*buf,size_t count);2099extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);21002101staticinline ssize_t write_str_in_full(int fd,const char*str)2102{2103returnwrite_in_full(fd, str,strlen(str));2104}21052106/**2107 * Open (and truncate) the file at path, write the contents of buf to it,2108 * and close it. Dies if any errors are encountered.2109 */2110externvoidwrite_file_buf(const char*path,const char*buf,size_t len);21112112/**2113 * Like write_file_buf(), but format the contents into a buffer first.2114 * Additionally, write_file() will append a newline if one is not already2115 * present, making it convenient to write text files:2116 *2117 * write_file(path, "counter: %d", ctr);2118 */2119__attribute__((format(printf,2,3)))2120externvoidwrite_file(const char*path,const char*fmt, ...);21212122/* pager.c */2123externvoidsetup_pager(void);2124externintpager_in_use(void);2125externint pager_use_color;2126externintterm_columns(void);2127externintdecimal_width(uintmax_t);2128externintcheck_pager_config(const char*cmd);2129externvoidprepare_pager_args(struct child_process *,const char*pager);21302131externconst char*editor_program;2132externconst char*askpass_program;2133externconst char*excludes_file;21342135/* base85 */2136intdecode_85(char*dst,const char*line,int linelen);2137voidencode_85(char*buf,const unsigned char*data,int bytes);21382139/* alloc.c */2140externvoid*alloc_blob_node(void);2141externvoid*alloc_tree_node(void);2142externvoid*alloc_commit_node(void);2143externvoid*alloc_tag_node(void);2144externvoid*alloc_object_node(void);2145externvoidalloc_report(void);2146externunsigned intalloc_commit_index(void);21472148/* pkt-line.c */2149voidpacket_trace_identity(const char*prog);21502151/* add */2152/*2153 * return 0 if success, 1 - if addition of a file failed and2154 * ADD_FILES_IGNORE_ERRORS was specified in flags2155 */2156intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);21572158/* diff.c */2159externint diff_auto_refresh_index;21602161/* match-trees.c */2162voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);2163voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);21642165/*2166 * whitespace rules.2167 * used by both diff and apply2168 * last two digits are tab width2169 */2170#define WS_BLANK_AT_EOL 01002171#define WS_SPACE_BEFORE_TAB 02002172#define WS_INDENT_WITH_NON_TAB 04002173#define WS_CR_AT_EOL 010002174#define WS_BLANK_AT_EOF 020002175#define WS_TAB_IN_INDENT 040002176#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)2177#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)2178#define WS_TAB_WIDTH_MASK 0772179externunsigned whitespace_rule_cfg;2180externunsignedwhitespace_rule(const char*);2181externunsignedparse_whitespace_rule(const char*);2182externunsignedws_check(const char*line,int len,unsigned ws_rule);2183externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);2184externchar*whitespace_error_string(unsigned ws);2185externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);2186externintws_blank_line(const char*line,int len,unsigned ws_rule);2187#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)21882189/* ls-files */2190voidoverlay_tree_on_cache(const char*tree_name,const char*prefix);21912192char*alias_lookup(const char*alias);2193intsplit_cmdline(char*cmdline,const char***argv);2194/* Takes a negative value returned by split_cmdline */2195const char*split_cmdline_strerror(int cmdline_errno);21962197/* setup.c */2198struct startup_info {2199int have_repository;2200const char*prefix;2201};2202externstruct startup_info *startup_info;22032204/* merge.c */2205struct commit_list;2206inttry_merge_command(const char*strategy,size_t xopts_nr,2207const char**xopts,struct commit_list *common,2208const char*head_arg,struct commit_list *remotes);2209intcheckout_fast_forward(const struct object_id *from,2210const struct object_id *to,2211int overwrite_ignore);221222132214intsane_execvp(const char*file,char*const argv[]);22152216/*2217 * A struct to encapsulate the concept of whether a file has changed2218 * since we last checked it. This uses criteria similar to those used2219 * for the index.2220 */2221struct stat_validity {2222struct stat_data *sd;2223};22242225voidstat_validity_clear(struct stat_validity *sv);22262227/*2228 * Returns 1 if the path is a regular file (or a symlink to a regular2229 * file) and matches the saved stat_validity, 0 otherwise. A missing2230 * or inaccessible file is considered a match if the struct was just2231 * initialized, or if the previous update found an inaccessible file.2232 */2233intstat_validity_check(struct stat_validity *sv,const char*path);22342235/*2236 * Update the stat_validity from a file opened at descriptor fd. If2237 * the file is missing, inaccessible, or not a regular file, then2238 * future calls to stat_validity_check will match iff one of those2239 * conditions continues to be true.2240 */2241voidstat_validity_update(struct stat_validity *sv,int fd);22422243intversioncmp(const char*s1,const char*s2);2244voidsleep_millisec(int millisec);22452246/*2247 * Create a directory and (if share is nonzero) adjust its permissions2248 * according to the shared_repository setting. Only use this for2249 * directories under $GIT_DIR. Don't use it for working tree2250 * directories.2251 */2252voidsafe_create_dir(const char*dir,int share);22532254#endif/* CACHE_H */