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 *); 600externintunmerged_index(const struct index_state *); 601externintverify_path(const char*path); 602externintstrcmp_offset(const char*s1,const char*s2,size_t*first_change); 603externintindex_dir_exists(struct index_state *istate,const char*name,int namelen); 604externvoidadjust_dirname_case(struct index_state *istate,char*name); 605externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 606 607/* 608 * Searches for an entry defined by name and namelen in the given index. 609 * If the return value is positive (including 0) it is the position of an 610 * exact match. If the return value is negative, the negated value minus 1 611 * is the position where the entry would be inserted. 612 * Example: The current index consists of these files and its stages: 613 * 614 * b#0, d#0, f#1, f#3 615 * 616 * index_name_pos(&index, "a", 1) -> -1 617 * index_name_pos(&index, "b", 1) -> 0 618 * index_name_pos(&index, "c", 1) -> -2 619 * index_name_pos(&index, "d", 1) -> 1 620 * index_name_pos(&index, "e", 1) -> -3 621 * index_name_pos(&index, "f", 1) -> -3 622 * index_name_pos(&index, "g", 1) -> -5 623 */ 624externintindex_name_pos(const struct index_state *,const char*name,int namelen); 625 626#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 627#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 628#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 629#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 630#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 631#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 632externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 633externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 634 635/* Remove entry, return true if there are more entries to go. */ 636externintremove_index_entry_at(struct index_state *,int pos); 637 638externvoidremove_marked_cache_entries(struct index_state *istate); 639externintremove_file_from_index(struct index_state *,const char*path); 640#define ADD_CACHE_VERBOSE 1 641#define ADD_CACHE_PRETEND 2 642#define ADD_CACHE_IGNORE_ERRORS 4 643#define ADD_CACHE_IGNORE_REMOVAL 8 644#define ADD_CACHE_INTENT 16 645/* 646 * These two are used to add the contents of the file at path 647 * to the index, marking the working tree up-to-date by storing 648 * the cached stat info in the resulting cache entry. A caller 649 * that has already run lstat(2) on the path can call 650 * add_to_index(), and all others can call add_file_to_index(); 651 * the latter will do necessary lstat(2) internally before 652 * calling the former. 653 */ 654externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 655externintadd_file_to_index(struct index_state *,const char*path,int flags); 656 657externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 658externintchmod_index_entry(struct index_state *,struct cache_entry *ce,char flip); 659externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 660externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 661externintindex_name_is_other(const struct index_state *,const char*,int); 662externvoid*read_blob_data_from_index(const struct index_state *,const char*,unsigned long*); 663 664/* do stat comparison even if CE_VALID is true */ 665#define CE_MATCH_IGNORE_VALID 01 666/* do not check the contents but report dirty on racily-clean entries */ 667#define CE_MATCH_RACY_IS_DIRTY 02 668/* do stat comparison even if CE_SKIP_WORKTREE is true */ 669#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 670/* ignore non-existent files during stat update */ 671#define CE_MATCH_IGNORE_MISSING 0x08 672/* enable stat refresh */ 673#define CE_MATCH_REFRESH 0x10 674externintie_match_stat(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 675externintie_modified(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 676 677#define HASH_WRITE_OBJECT 1 678#define HASH_FORMAT_CHECK 2 679externintindex_fd(unsigned char*sha1,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 680externintindex_path(unsigned char*sha1,const char*path,struct stat *st,unsigned flags); 681 682/* 683 * Record to sd the data from st that we use to check whether a file 684 * might have changed. 685 */ 686externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 687 688/* 689 * Return 0 if st is consistent with a file not having been changed 690 * since sd was filled. If there are differences, return a 691 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 692 * INODE_CHANGED, and DATA_CHANGED. 693 */ 694externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 695externintmatch_stat_data_racy(const struct index_state *istate, 696const struct stat_data *sd,struct stat *st); 697 698externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 699 700#define REFRESH_REALLY 0x0001/* ignore_valid */ 701#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 702#define REFRESH_QUIET 0x0004/* be quiet about it */ 703#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 704#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 705#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 706externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 707externstruct cache_entry *refresh_cache_entry(struct cache_entry *,unsigned int); 708 709externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 710 711externinthold_locked_index(struct lock_file *,int); 712externvoidset_alternate_index_output(const char*); 713 714externint verify_index_checksum; 715 716/* Environment bits from configuration mechanism */ 717externint trust_executable_bit; 718externint trust_ctime; 719externint check_stat; 720externint quote_path_fully; 721externint has_symlinks; 722externint minimum_abbrev, default_abbrev; 723externint ignore_case; 724externint assume_unchanged; 725externint prefer_symlink_refs; 726externint warn_ambiguous_refs; 727externint warn_on_object_refname_ambiguity; 728externconst char*apply_default_whitespace; 729externconst char*apply_default_ignorewhitespace; 730externconst char*git_attributes_file; 731externconst char*git_hooks_path; 732externint zlib_compression_level; 733externint core_compression_level; 734externint pack_compression_level; 735externsize_t packed_git_window_size; 736externsize_t packed_git_limit; 737externsize_t delta_base_cache_limit; 738externunsigned long big_file_threshold; 739externunsigned long pack_size_limit_cfg; 740 741/* 742 * Accessors for the core.sharedrepository config which lazy-load the value 743 * from the config (if not already set). The "reset" function can be 744 * used to unset "set" or cached value, meaning that the value will be loaded 745 * fresh from the config file on the next call to get_shared_repository(). 746 */ 747voidset_shared_repository(int value); 748intget_shared_repository(void); 749voidreset_shared_repository(void); 750 751/* 752 * Do replace refs need to be checked this run? This variable is 753 * initialized to true unless --no-replace-object is used or 754 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 755 * commands that do not want replace references to be active. As an 756 * optimization it is also set to false if replace references have 757 * been sought but there were none. 758 */ 759externint check_replace_refs; 760externchar*git_replace_ref_base; 761 762externint fsync_object_files; 763externint core_preload_index; 764externint core_apply_sparse_checkout; 765externint precomposed_unicode; 766externint protect_hfs; 767externint protect_ntfs; 768externint git_db_env, git_index_env, git_graft_env, git_common_dir_env; 769 770/* 771 * Include broken refs in all ref iterations, which will 772 * generally choke dangerous operations rather than letting 773 * them silently proceed without taking the broken ref into 774 * account. 775 */ 776externint ref_paranoia; 777 778/* 779 * The character that begins a commented line in user-editable file 780 * that is subject to stripspace. 781 */ 782externchar comment_line_char; 783externint auto_comment_line_char; 784 785/* Windows only */ 786enum hide_dotfiles_type { 787 HIDE_DOTFILES_FALSE =0, 788 HIDE_DOTFILES_TRUE, 789 HIDE_DOTFILES_DOTGITONLY 790}; 791externenum hide_dotfiles_type hide_dotfiles; 792 793enum log_refs_config { 794 LOG_REFS_UNSET = -1, 795 LOG_REFS_NONE =0, 796 LOG_REFS_NORMAL, 797 LOG_REFS_ALWAYS 798}; 799externenum log_refs_config log_all_ref_updates; 800 801enum branch_track { 802 BRANCH_TRACK_UNSPECIFIED = -1, 803 BRANCH_TRACK_NEVER =0, 804 BRANCH_TRACK_REMOTE, 805 BRANCH_TRACK_ALWAYS, 806 BRANCH_TRACK_EXPLICIT, 807 BRANCH_TRACK_OVERRIDE 808}; 809 810enum rebase_setup_type { 811 AUTOREBASE_NEVER =0, 812 AUTOREBASE_LOCAL, 813 AUTOREBASE_REMOTE, 814 AUTOREBASE_ALWAYS 815}; 816 817enum push_default_type { 818 PUSH_DEFAULT_NOTHING =0, 819 PUSH_DEFAULT_MATCHING, 820 PUSH_DEFAULT_SIMPLE, 821 PUSH_DEFAULT_UPSTREAM, 822 PUSH_DEFAULT_CURRENT, 823 PUSH_DEFAULT_UNSPECIFIED 824}; 825 826externenum branch_track git_branch_track; 827externenum rebase_setup_type autorebase; 828externenum push_default_type push_default; 829 830enum object_creation_mode { 831 OBJECT_CREATION_USES_HARDLINKS =0, 832 OBJECT_CREATION_USES_RENAMES =1 833}; 834 835externenum object_creation_mode object_creation_mode; 836 837externchar*notes_ref_name; 838 839externint grafts_replace_parents; 840 841/* 842 * GIT_REPO_VERSION is the version we write by default. The 843 * _READ variant is the highest number we know how to 844 * handle. 845 */ 846#define GIT_REPO_VERSION 0 847#define GIT_REPO_VERSION_READ 1 848externint repository_format_precious_objects; 849 850struct repository_format { 851int version; 852int precious_objects; 853int is_bare; 854char*work_tree; 855struct string_list unknown_extensions; 856}; 857 858/* 859 * Read the repository format characteristics from the config file "path" into 860 * "format" struct. Returns the numeric version. On error, -1 is returned, 861 * format->version is set to -1, and all other fields in the struct are 862 * undefined. 863 */ 864intread_repository_format(struct repository_format *format,const char*path); 865 866/* 867 * Verify that the repository described by repository_format is something we 868 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 869 * any errors encountered. 870 */ 871intverify_repository_format(const struct repository_format *format, 872struct strbuf *err); 873 874/* 875 * Check the repository format version in the path found in get_git_dir(), 876 * and die if it is a version we don't understand. Generally one would 877 * set_git_dir() before calling this, and use it only for "are we in a valid 878 * repo?". 879 */ 880externvoidcheck_repository_format(void); 881 882#define MTIME_CHANGED 0x0001 883#define CTIME_CHANGED 0x0002 884#define OWNER_CHANGED 0x0004 885#define MODE_CHANGED 0x0008 886#define INODE_CHANGED 0x0010 887#define DATA_CHANGED 0x0020 888#define TYPE_CHANGED 0x0040 889 890/* 891 * Return a statically allocated filename, either generically (mkpath), in 892 * the repository directory (git_path), or in a submodule's repository 893 * directory (git_path_submodule). In all cases, note that the result 894 * may be overwritten by another call to _any_ of the functions. Consider 895 * using the safer "dup" or "strbuf" formats below (in some cases, the 896 * unsafe versions have already been removed). 897 */ 898externconst char*mkpath(const char*fmt, ...)__attribute__((format(printf,1,2))); 899externconst char*git_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 900externconst char*git_common_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 901 902externchar*mksnpath(char*buf,size_t n,const char*fmt, ...) 903__attribute__((format(printf,3,4))); 904externvoidstrbuf_git_path(struct strbuf *sb,const char*fmt, ...) 905__attribute__((format(printf,2,3))); 906externvoidstrbuf_git_common_path(struct strbuf *sb,const char*fmt, ...) 907__attribute__((format(printf,2,3))); 908externchar*git_path_buf(struct strbuf *buf,const char*fmt, ...) 909__attribute__((format(printf,2,3))); 910externintstrbuf_git_path_submodule(struct strbuf *sb,const char*path, 911const char*fmt, ...) 912__attribute__((format(printf,3,4))); 913externchar*git_pathdup(const char*fmt, ...) 914__attribute__((format(printf,1,2))); 915externchar*mkpathdup(const char*fmt, ...) 916__attribute__((format(printf,1,2))); 917externchar*git_pathdup_submodule(const char*path,const char*fmt, ...) 918__attribute__((format(printf,2,3))); 919 920externvoidreport_linked_checkout_garbage(void); 921 922/* 923 * You can define a static memoized git path like: 924 * 925 * static GIT_PATH_FUNC(git_path_foo, "FOO"); 926 * 927 * or use one of the global ones below. 928 */ 929#define GIT_PATH_FUNC(func, filename) \ 930 const char *func(void) \ 931 { \ 932 static char *ret; \ 933 if (!ret) \ 934 ret = git_pathdup(filename); \ 935 return ret; \ 936 } 937 938const char*git_path_cherry_pick_head(void); 939const char*git_path_revert_head(void); 940const char*git_path_squash_msg(void); 941const char*git_path_merge_msg(void); 942const char*git_path_merge_rr(void); 943const char*git_path_merge_mode(void); 944const char*git_path_merge_head(void); 945const char*git_path_fetch_head(void); 946const char*git_path_shallow(void); 947 948/* 949 * Return the name of the file in the local object database that would 950 * be used to store a loose object with the specified sha1. The 951 * return value is a pointer to a statically allocated buffer that is 952 * overwritten each time the function is called. 953 */ 954externconst char*sha1_file_name(const unsigned char*sha1); 955 956/* 957 * Return the name of the (local) packfile with the specified sha1 in 958 * its name. The return value is a pointer to memory that is 959 * overwritten each time this function is called. 960 */ 961externchar*sha1_pack_name(const unsigned char*sha1); 962 963/* 964 * Return the name of the (local) pack index file with the specified 965 * sha1 in its name. The return value is a pointer to memory that is 966 * overwritten each time this function is called. 967 */ 968externchar*sha1_pack_index_name(const unsigned char*sha1); 969 970/* 971 * Return an abbreviated sha1 unique within this repository's object database. 972 * The result will be at least `len` characters long, and will be NUL 973 * terminated. 974 * 975 * The non-`_r` version returns a static buffer which remains valid until 4 976 * more calls to find_unique_abbrev are made. 977 * 978 * The `_r` variant writes to a buffer supplied by the caller, which must be at 979 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 980 * written (excluding the NUL terminator). 981 * 982 * Note that while this version avoids the static buffer, it is not fully 983 * reentrant, as it calls into other non-reentrant git code. 984 */ 985externconst char*find_unique_abbrev(const unsigned char*sha1,int len); 986externintfind_unique_abbrev_r(char*hex,const unsigned char*sha1,int len); 987 988externconst unsigned char null_sha1[GIT_MAX_RAWSZ]; 989externconst struct object_id null_oid; 990 991staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 992{ 993int i; 994 995for(i =0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 996if(*sha1 != *sha2) 997return*sha1 - *sha2; 998} 9991000return0;1001}10021003staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2)1004{1005returnhashcmp(oid1->hash, oid2->hash);1006}10071008staticinlineintis_null_sha1(const unsigned char*sha1)1009{1010return!hashcmp(sha1, null_sha1);1011}10121013staticinlineintis_null_oid(const struct object_id *oid)1014{1015return!hashcmp(oid->hash, null_sha1);1016}10171018staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src)1019{1020memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);1021}10221023staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src)1024{1025hashcpy(dst->hash, src->hash);1026}10271028staticinlinevoidhashclr(unsigned char*hash)1029{1030memset(hash,0, GIT_SHA1_RAWSZ);1031}10321033staticinlinevoidoidclr(struct object_id *oid)1034{1035hashclr(oid->hash);1036}103710381039#define EMPTY_TREE_SHA1_HEX \1040"4b825dc642cb6eb9a060e54bf8d69288fbee4904"1041#define EMPTY_TREE_SHA1_BIN_LITERAL \1042"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \1043"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"1044externconst struct object_id empty_tree_oid;1045#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)10461047#define EMPTY_BLOB_SHA1_HEX \1048"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"1049#define EMPTY_BLOB_SHA1_BIN_LITERAL \1050"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1051"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1052externconst struct object_id empty_blob_oid;1053#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)105410551056staticinlineintis_empty_blob_sha1(const unsigned char*sha1)1057{1058return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1059}10601061staticinlineintis_empty_blob_oid(const struct object_id *oid)1062{1063return!hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1064}10651066staticinlineintis_empty_tree_sha1(const unsigned char*sha1)1067{1068return!hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1069}10701071staticinlineintis_empty_tree_oid(const struct object_id *oid)1072{1073return!hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1074}10751076/* set default permissions by passing mode arguments to open(2) */1077intgit_mkstemps_mode(char*pattern,int suffix_len,int mode);1078intgit_mkstemp_mode(char*pattern,int mode);10791080/*1081 * NOTE NOTE NOTE!!1082 *1083 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1084 * not be changed. Old repositories have core.sharedrepository written in1085 * numeric format, and therefore these values are preserved for compatibility1086 * reasons.1087 */1088enum sharedrepo {1089 PERM_UMASK =0,1090 OLD_PERM_GROUP =1,1091 OLD_PERM_EVERYBODY =2,1092 PERM_GROUP =0660,1093 PERM_EVERYBODY =06641094};1095intgit_config_perm(const char*var,const char*value);1096intadjust_shared_perm(const char*path);10971098/*1099 * Create the directory containing the named path, using care to be1100 * somewhat safe against races. Return one of the scld_error values to1101 * indicate success/failure. On error, set errno to describe the1102 * problem.1103 *1104 * SCLD_VANISHED indicates that one of the ancestor directories of the1105 * path existed at one point during the function call and then1106 * suddenly vanished, probably because another process pruned the1107 * directory while we were working. To be robust against this kind of1108 * race, callers might want to try invoking the function again when it1109 * returns SCLD_VANISHED.1110 *1111 * safe_create_leading_directories() temporarily changes path while it1112 * is working but restores it before returning.1113 * safe_create_leading_directories_const() doesn't modify path, even1114 * temporarily.1115 */1116enum scld_error {1117 SCLD_OK =0,1118 SCLD_FAILED = -1,1119 SCLD_PERMS = -2,1120 SCLD_EXISTS = -3,1121 SCLD_VANISHED = -41122};1123enum scld_error safe_create_leading_directories(char*path);1124enum scld_error safe_create_leading_directories_const(const char*path);11251126/*1127 * Callback function for raceproof_create_file(). This function is1128 * expected to do something that makes dirname(path) permanent despite1129 * the fact that other processes might be cleaning up empty1130 * directories at the same time. Usually it will create a file named1131 * path, but alternatively it could create another file in that1132 * directory, or even chdir() into that directory. The function should1133 * return 0 if the action was completed successfully. On error, it1134 * should return a nonzero result and set errno.1135 * raceproof_create_file() treats two errno values specially:1136 *1137 * - ENOENT -- dirname(path) does not exist. In this case,1138 * raceproof_create_file() tries creating dirname(path)1139 * (and any parent directories, if necessary) and calls1140 * the function again.1141 *1142 * - EISDIR -- the file already exists and is a directory. In this1143 * case, raceproof_create_file() removes the directory if1144 * it is empty (and recursively any empty directories that1145 * it contains) and calls the function again.1146 *1147 * Any other errno causes raceproof_create_file() to fail with the1148 * callback's return value and errno.1149 *1150 * Obviously, this function should be OK with being called again if it1151 * fails with ENOENT or EISDIR. In other scenarios it will not be1152 * called again.1153 */1154typedefintcreate_file_fn(const char*path,void*cb);11551156/*1157 * Create a file in dirname(path) by calling fn, creating leading1158 * directories if necessary. Retry a few times in case we are racing1159 * with another process that is trying to clean up the directory that1160 * contains path. See the documentation for create_file_fn for more1161 * details.1162 *1163 * Return the value and set the errno that resulted from the most1164 * recent call of fn. fn is always called at least once, and will be1165 * called more than once if it returns ENOENT or EISDIR.1166 */1167intraceproof_create_file(const char*path, create_file_fn fn,void*cb);11681169intmkdir_in_gitdir(const char*path);1170externchar*expand_user_path(const char*path,int real_home);1171const char*enter_repo(const char*path,int strict);1172staticinlineintis_absolute_path(const char*path)1173{1174returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path);1175}1176intis_directory(const char*);1177char*strbuf_realpath(struct strbuf *resolved,const char*path,1178int die_on_error);1179const char*real_path(const char*path);1180const char*real_path_if_valid(const char*path);1181char*real_pathdup(const char*path,int die_on_error);1182const char*absolute_path(const char*path);1183char*absolute_pathdup(const char*path);1184const char*remove_leading_path(const char*in,const char*prefix);1185const char*relative_path(const char*in,const char*prefix,struct strbuf *sb);1186intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len);1187intnormalize_path_copy(char*dst,const char*src);1188intlongest_ancestor_length(const char*path,struct string_list *prefixes);1189char*strip_path_suffix(const char*path,const char*suffix);1190intdaemon_avoid_alias(const char*path);1191externintis_ntfs_dotgit(const char*name);11921193/**1194 * Return a newly allocated string with the evaluation of1195 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1196 * "$HOME/.config/git/$filename". Return NULL upon error.1197 */1198externchar*xdg_config_home(const char*filename);11991200/**1201 * Return a newly allocated string with the evaluation of1202 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1203 * "$HOME/.cache/git/$filename". Return NULL upon error.1204 */1205externchar*xdg_cache_home(const char*filename);12061207/* object replacement */1208#define LOOKUP_REPLACE_OBJECT 11209#define LOOKUP_UNKNOWN_OBJECT 21210externvoid*read_sha1_file_extended(const unsigned char*sha1,enum object_type *type,unsigned long*size,unsigned flag);1211staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size)1212{1213returnread_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);1214}12151216/*1217 * This internal function is only declared here for the benefit of1218 * lookup_replace_object(). Please do not call it directly.1219 */1220externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1);12211222/*1223 * If object sha1 should be replaced, return the replacement object's1224 * name (replaced recursively, if necessary). The return value is1225 * either sha1 or a pointer to a permanently-allocated value. When1226 * object replacement is suppressed, always return sha1.1227 */1228staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1)1229{1230if(!check_replace_refs)1231return sha1;1232returndo_lookup_replace_object(sha1);1233}12341235staticinlineconst unsigned char*lookup_replace_object_extended(const unsigned char*sha1,unsigned flag)1236{1237if(!(flag & LOOKUP_REPLACE_OBJECT))1238return sha1;1239returnlookup_replace_object(sha1);1240}12411242/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1243externintsha1_object_info(const unsigned char*,unsigned long*);1244externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1);1245externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1);1246externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,unsigned char*sha1,unsigned flags);1247externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*);1248externintforce_object_loose(const unsigned char*sha1,time_t mtime);1249externintgit_open_cloexec(const char*name,int flags);1250#define git_open(name) git_open_cloexec(name, O_RDONLY)1251externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size);1252externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz);1253externintparse_sha1_header(const char*hdr,unsigned long*sizep);12541255/* global flag to enable extra checks when accessing packed objects */1256externint do_check_packed_object_crc;12571258externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type);12591260externintfinalize_object_file(const char*tmpfile,const char*filename);12611262externinthas_sha1_pack(const unsigned char*sha1);12631264/*1265 * Open the loose object at path, check its sha1, and return the contents,1266 * type, and size. If the object is a blob, then "contents" may return NULL,1267 * to allow streaming of large blobs.1268 *1269 * Returns 0 on success, negative on error (details may be written to stderr).1270 */1271intread_loose_object(const char*path,1272const unsigned char*expected_sha1,1273enum object_type *type,1274unsigned long*size,1275void**contents);12761277/*1278 * Return true iff we have an object named sha1, whether local or in1279 * an alternate object database, and whether packed or loose. This1280 * function does not respect replace references.1281 *1282 * If the QUICK flag is set, do not re-check the pack directory1283 * when we cannot find the object (this means we may give a false1284 * negative answer if another process is simultaneously repacking).1285 */1286#define HAS_SHA1_QUICK 0x11287externinthas_sha1_file_with_flags(const unsigned char*sha1,int flags);1288staticinlineinthas_sha1_file(const unsigned char*sha1)1289{1290returnhas_sha1_file_with_flags(sha1,0);1291}12921293/* Same as the above, except for struct object_id. */1294externinthas_object_file(const struct object_id *oid);1295externinthas_object_file_with_flags(const struct object_id *oid,int flags);12961297/*1298 * Return true iff an alternate object database has a loose object1299 * with the specified name. This function does not respect replace1300 * references.1301 */1302externinthas_loose_object_nonlocal(const unsigned char*sha1);13031304externinthas_pack_index(const unsigned char*sha1);13051306externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect);13071308/* Helper to check and "touch" a file */1309externintcheck_and_freshen_file(const char*fn,int freshen);13101311externconst signed char hexval_table[256];1312staticinlineunsigned inthexval(unsigned char c)1313{1314return hexval_table[c];1315}13161317/*1318 * Convert two consecutive hexadecimal digits into a char. Return a1319 * negative value on error. Don't run over the end of short strings.1320 */1321staticinlineinthex2chr(const char*s)1322{1323int val =hexval(s[0]);1324return(val <0) ? val : (val <<4) |hexval(s[1]);1325}13261327/* Convert to/from hex/sha1 representation */1328#define MINIMUM_ABBREV minimum_abbrev1329#define DEFAULT_ABBREV default_abbrev13301331/* used when the code does not know or care what the default abbrev is */1332#define FALLBACK_DEFAULT_ABBREV 713331334struct object_context {1335unsigned char tree[20];1336char path[PATH_MAX];1337unsigned mode;1338/*1339 * symlink_path is only used by get_tree_entry_follow_symlinks,1340 * and only for symlinks that point outside the repository.1341 */1342struct strbuf symlink_path;1343};13441345#define GET_SHA1_QUIETLY 011346#define GET_SHA1_COMMIT 021347#define GET_SHA1_COMMITTISH 041348#define GET_SHA1_TREE 0101349#define GET_SHA1_TREEISH 0201350#define GET_SHA1_BLOB 0401351#define GET_SHA1_FOLLOW_SYMLINKS 01001352#define GET_SHA1_ONLY_TO_DIE 0400013531354#define GET_SHA1_DISAMBIGUATORS \1355 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \1356 GET_SHA1_TREE | GET_SHA1_TREEISH | \1357 GET_SHA1_BLOB)13581359externintget_sha1(const char*str,unsigned char*sha1);1360externintget_sha1_commit(const char*str,unsigned char*sha1);1361externintget_sha1_committish(const char*str,unsigned char*sha1);1362externintget_sha1_tree(const char*str,unsigned char*sha1);1363externintget_sha1_treeish(const char*str,unsigned char*sha1);1364externintget_sha1_blob(const char*str,unsigned char*sha1);1365externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix);1366externintget_sha1_with_context(const char*str,unsigned flags,unsigned char*sha1,struct object_context *orc);13671368externintget_oid(const char*str,struct object_id *oid);13691370typedefinteach_abbrev_fn(const struct object_id *oid,void*);1371externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*);13721373externintset_disambiguate_hint_config(const char*var,const char*value);13741375/*1376 * Try to read a SHA1 in hexadecimal format from the 40 characters1377 * starting at hex. Write the 20-byte result to sha1 in binary form.1378 * Return 0 on success. Reading stops if a NUL is encountered in the1379 * input, so it is safe to pass this function an arbitrary1380 * null-terminated string.1381 */1382externintget_sha1_hex(const char*hex,unsigned char*sha1);1383externintget_oid_hex(const char*hex,struct object_id *sha1);13841385/*1386 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1387 * and writes the NUL-terminated output to the buffer `out`, which must be at1388 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1389 * convenience.1390 *1391 * The non-`_r` variant returns a static buffer, but uses a ring of 41392 * buffers, making it safe to make multiple calls for a single statement, like:1393 *1394 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1395 */1396externchar*sha1_to_hex_r(char*out,const unsigned char*sha1);1397externchar*oid_to_hex_r(char*out,const struct object_id *oid);1398externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1399externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */14001401/*1402 * Parse a 40-character hexadecimal object ID starting from hex, updating the1403 * pointer specified by end when parsing stops. The resulting object ID is1404 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1405 * other invalid character. end is only updated on success; otherwise, it is1406 * unmodified.1407 */1408externintparse_oid_hex(const char*hex,struct object_id *oid,const char**end);14091410/*1411 * This reads short-hand syntax that not only evaluates to a commit1412 * object name, but also can act as if the end user spelled the name1413 * of the branch from the command line.1414 *1415 * - "@{-N}" finds the name of the Nth previous branch we were on, and1416 * places the name of the branch in the given buf and returns the1417 * number of characters parsed if successful.1418 *1419 * - "<branch>@{upstream}" finds the name of the other ref that1420 * <branch> is configured to merge with (missing <branch> defaults1421 * to the current branch), and places the name of the branch in the1422 * given buf and returns the number of characters parsed if1423 * successful.1424 *1425 * If the input is not of the accepted format, it returns a negative1426 * number to signal an error.1427 *1428 * If the input was ok but there are not N branch switches in the1429 * reflog, it returns 0.1430 *1431 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1432 * expansions: local branches ("refs/heads/"), remote branches1433 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1434 * allowed, even ones to refs outside of those namespaces.1435 */1436#define INTERPRET_BRANCH_LOCAL (1<<0)1437#define INTERPRET_BRANCH_REMOTE (1<<1)1438#define INTERPRET_BRANCH_HEAD (1<<2)1439externintinterpret_branch_name(const char*str,int len,struct strbuf *,1440unsigned allowed);1441externintget_oid_mb(const char*str,struct object_id *oid);14421443externintvalidate_headref(const char*ref);14441445externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1446externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1447externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1448externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);14491450externvoid*read_object_with_reference(const unsigned char*sha1,1451const char*required_type,1452unsigned long*size,1453unsigned char*sha1_ret);14541455externstruct object *peel_to_type(const char*name,int namelen,1456struct object *o,enum object_type);14571458struct date_mode {1459enum date_mode_type {1460 DATE_NORMAL =0,1461 DATE_RELATIVE,1462 DATE_SHORT,1463 DATE_ISO8601,1464 DATE_ISO8601_STRICT,1465 DATE_RFC2822,1466 DATE_STRFTIME,1467 DATE_RAW,1468 DATE_UNIX1469} type;1470const char*strftime_fmt;1471int local;1472};14731474/*1475 * Convenience helper for passing a constant type, like:1476 *1477 * show_date(t, tz, DATE_MODE(NORMAL));1478 */1479#define DATE_MODE(t) date_mode_from_type(DATE_##t)1480struct date_mode *date_mode_from_type(enum date_mode_type type);14811482const char*show_date(unsigned long time,int timezone,const struct date_mode *mode);1483voidshow_date_relative(unsigned long time,int tz,const struct timeval *now,1484struct strbuf *timebuf);1485intparse_date(const char*date,struct strbuf *out);1486intparse_date_basic(const char*date,unsigned long*timestamp,int*offset);1487intparse_expiry_date(const char*date,unsigned long*timestamp);1488voiddatestamp(struct strbuf *out);1489#define approxidate(s) approxidate_careful((s), NULL)1490unsigned longapproxidate_careful(const char*,int*);1491unsigned longapproxidate_relative(const char*date,const struct timeval *now);1492voidparse_date_format(const char*format,struct date_mode *mode);1493intdate_overflows(unsigned long date);14941495#define IDENT_STRICT 11496#define IDENT_NO_DATE 21497#define IDENT_NO_NAME 41498externconst char*git_author_info(int);1499externconst char*git_committer_info(int);1500externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1501externconst char*fmt_name(const char*name,const char*email);1502externconst char*ident_default_name(void);1503externconst char*ident_default_email(void);1504externconst char*git_editor(void);1505externconst char*git_pager(int stdout_is_tty);1506externintgit_ident_config(const char*,const char*,void*);1507externvoidreset_ident_date(void);15081509struct ident_split {1510const char*name_begin;1511const char*name_end;1512const char*mail_begin;1513const char*mail_end;1514const char*date_begin;1515const char*date_end;1516const char*tz_begin;1517const char*tz_end;1518};1519/*1520 * Signals an success with 0, but time part of the result may be NULL1521 * if the input lacks timestamp and zone1522 */1523externintsplit_ident_line(struct ident_split *,const char*,int);15241525/*1526 * Like show_date, but pull the timestamp and tz parameters from1527 * the ident_split. It will also sanity-check the values and produce1528 * a well-known sentinel date if they appear bogus.1529 */1530const char*show_ident_date(const struct ident_split *id,1531const struct date_mode *mode);15321533/*1534 * Compare split idents for equality or strict ordering. Note that we1535 * compare only the ident part of the line, ignoring any timestamp.1536 *1537 * Because there are two fields, we must choose one as the primary key; we1538 * currently arbitrarily pick the email.1539 */1540externintident_cmp(const struct ident_split *,const struct ident_split *);15411542struct checkout {1543struct index_state *istate;1544const char*base_dir;1545int base_dir_len;1546unsigned force:1,1547 quiet:1,1548 not_new:1,1549 refresh_cache:1;1550};1551#define CHECKOUT_INIT { NULL,"" }15521553#define TEMPORARY_FILENAME_LENGTH 251554externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);15551556struct cache_def {1557struct strbuf path;1558int flags;1559int track_flags;1560int prefix_len_stat_func;1561};1562#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1563staticinlinevoidcache_def_clear(struct cache_def *cache)1564{1565strbuf_release(&cache->path);1566}15671568externinthas_symlink_leading_path(const char*name,int len);1569externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1570externintcheck_leading_path(const char*name,int len);1571externinthas_dirs_only_path(const char*name,int len,int prefix_len);1572externvoidschedule_dir_for_removal(const char*name,int len);1573externvoidremove_scheduled_dirs(void);15741575externstruct alternate_object_database {1576struct alternate_object_database *next;15771578/* see alt_scratch_buf() */1579struct strbuf scratch;1580size_t base_len;15811582char path[FLEX_ARRAY];1583} *alt_odb_list;1584externvoidprepare_alt_odb(void);1585externvoidread_info_alternates(const char* relative_base,int depth);1586externchar*compute_alternate_path(const char*path,struct strbuf *err);1587typedefintalt_odb_fn(struct alternate_object_database *,void*);1588externintforeach_alt_odb(alt_odb_fn,void*);15891590/*1591 * Allocate a "struct alternate_object_database" but do _not_ actually1592 * add it to the list of alternates.1593 */1594struct alternate_object_database *alloc_alt_odb(const char*dir);15951596/*1597 * Add the directory to the on-disk alternates file; the new entry will also1598 * take effect in the current process.1599 */1600externvoidadd_to_alternates_file(const char*dir);16011602/*1603 * Add the directory to the in-memory list of alternates (along with any1604 * recursive alternates it points to), but do not modify the on-disk alternates1605 * file.1606 */1607externvoidadd_to_alternates_memory(const char*dir);16081609/*1610 * Returns a scratch strbuf pre-filled with the alternate object directory,1611 * including a trailing slash, which can be used to access paths in the1612 * alternate. Always use this over direct access to alt->scratch, as it1613 * cleans up any previous use of the scratch buffer.1614 */1615externstruct strbuf *alt_scratch_buf(struct alternate_object_database *alt);16161617struct pack_window {1618struct pack_window *next;1619unsigned char*base;1620 off_t offset;1621size_t len;1622unsigned int last_used;1623unsigned int inuse_cnt;1624};16251626externstruct packed_git {1627struct packed_git *next;1628struct pack_window *windows;1629 off_t pack_size;1630const void*index_data;1631size_t index_size;1632uint32_t num_objects;1633uint32_t num_bad_objects;1634unsigned char*bad_object_sha1;1635int index_version;1636time_t mtime;1637int pack_fd;1638unsigned pack_local:1,1639 pack_keep:1,1640 freshened:1,1641 do_not_close:1;1642unsigned char sha1[20];1643struct revindex_entry *revindex;1644/* something like ".git/objects/pack/xxxxx.pack" */1645char pack_name[FLEX_ARRAY];/* more */1646} *packed_git;16471648/*1649 * A most-recently-used ordered version of the packed_git list, which can1650 * be iterated instead of packed_git (and marked via mru_mark).1651 */1652struct mru;1653externstruct mru *packed_git_mru;16541655struct pack_entry {1656 off_t offset;1657unsigned char sha1[20];1658struct packed_git *p;1659};16601661externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path);16621663/* A hook to report invalid files in pack directory */1664#define PACKDIR_FILE_PACK 11665#define PACKDIR_FILE_IDX 21666#define PACKDIR_FILE_GARBAGE 41667externvoid(*report_garbage)(unsigned seen_bits,const char*path);16681669externvoidprepare_packed_git(void);1670externvoidreprepare_packed_git(void);1671externvoidinstall_packed_git(struct packed_git *pack);16721673/*1674 * Give a rough count of objects in the repository. This sacrifices accuracy1675 * for speed.1676 */1677unsigned longapproximate_object_count(void);16781679externstruct packed_git *find_sha1_pack(const unsigned char*sha1,1680struct packed_git *packs);16811682externvoidpack_report(void);16831684/*1685 * Create a temporary file rooted in the object database directory, or1686 * die on failure. The filename is taken from "pattern", which should have the1687 * usual "XXXXXX" trailer, and the resulting filename is written into the1688 * "template" buffer. Returns the open descriptor.1689 */1690externintodb_mkstemp(struct strbuf *template,const char*pattern);16911692/*1693 * Generate the filename to be used for a pack file with checksum "sha1" and1694 * extension "ext". The result is written into the strbuf "buf", overwriting1695 * any existing contents. A pointer to buf->buf is returned as a convenience.1696 *1697 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"1698 */1699externchar*odb_pack_name(struct strbuf *buf,const unsigned char*sha1,const char*ext);17001701/*1702 * Create a pack .keep file named "name" (which should generally be the output1703 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1704 * error.1705 */1706externintodb_pack_keep(const char*name);17071708/*1709 * mmap the index file for the specified packfile (if it is not1710 * already mmapped). Return 0 on success.1711 */1712externintopen_pack_index(struct packed_git *);17131714/*1715 * munmap the index file for the specified packfile (if it is1716 * currently mmapped).1717 */1718externvoidclose_pack_index(struct packed_git *);17191720externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*);1721externvoidclose_pack_windows(struct packed_git *);1722externvoidclose_all_packs(void);1723externvoidunuse_pack(struct pack_window **);1724externvoidclear_delta_base_cache(void);1725externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local);17261727/*1728 * Make sure that a pointer access into an mmap'd index file is within bounds,1729 * and can provide at least 8 bytes of data.1730 *1731 * Note that this is only necessary for variable-length segments of the file1732 * (like the 64-bit extended offset table), as we compare the size to the1733 * fixed-length parts when we open the file.1734 */1735externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr);17361737/*1738 * Return the SHA-1 of the nth object within the specified packfile.1739 * Open the index if it is not already open. The return value points1740 * at the SHA-1 within the mmapped index. Return NULL if there is an1741 * error.1742 */1743externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n);1744/*1745 * Like nth_packed_object_sha1, but write the data into the object specified by1746 * the the first argument. Returns the first argument on success, and NULL on1747 * error.1748 */1749externconst struct object_id *nth_packed_object_oid(struct object_id *,struct packed_git *,uint32_t n);17501751/*1752 * Return the offset of the nth object within the specified packfile.1753 * The index must already be opened.1754 */1755extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n);17561757/*1758 * If the object named sha1 is present in the specified packfile,1759 * return its offset within the packfile; otherwise, return 0.1760 */1761extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *);17621763externintis_pack_valid(struct packed_git *);1764externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*);1765externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep);1766externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t);1767externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*);17681769/*1770 * Iterate over the files in the loose-object parts of the object1771 * directory "path", triggering the following callbacks:1772 *1773 * - loose_object is called for each loose object we find.1774 *1775 * - loose_cruft is called for any files that do not appear to be1776 * loose objects. Note that we only look in the loose object1777 * directories "objects/[0-9a-f]{2}/", so we will not report1778 * "objects/foobar" as cruft.1779 *1780 * - loose_subdir is called for each top-level hashed subdirectory1781 * of the object directory (e.g., "$OBJDIR/f0"). It is called1782 * after the objects in the directory are processed.1783 *1784 * Any callback that is NULL will be ignored. Callbacks returning non-zero1785 * will end the iteration.1786 *1787 * In the "buf" variant, "path" is a strbuf which will also be used as a1788 * scratch buffer, but restored to its original contents before1789 * the function returns.1790 */1791typedefinteach_loose_object_fn(const struct object_id *oid,1792const char*path,1793void*data);1794typedefinteach_loose_cruft_fn(const char*basename,1795const char*path,1796void*data);1797typedefinteach_loose_subdir_fn(int nr,1798const char*path,1799void*data);1800intfor_each_loose_file_in_objdir(const char*path,1801 each_loose_object_fn obj_cb,1802 each_loose_cruft_fn cruft_cb,1803 each_loose_subdir_fn subdir_cb,1804void*data);1805intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1806 each_loose_object_fn obj_cb,1807 each_loose_cruft_fn cruft_cb,1808 each_loose_subdir_fn subdir_cb,1809void*data);18101811/*1812 * Iterate over loose and packed objects in both the local1813 * repository and any alternates repositories (unless the1814 * LOCAL_ONLY flag is set).1815 */1816#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11817typedefinteach_packed_object_fn(const struct object_id *oid,1818struct packed_git *pack,1819uint32_t pos,1820void*data);1821externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);1822externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags);18231824struct object_info {1825/* Request */1826enum object_type *typep;1827unsigned long*sizep;1828 off_t *disk_sizep;1829unsigned char*delta_base_sha1;1830struct strbuf *typename;18311832/* Response */1833enum{1834 OI_CACHED,1835 OI_LOOSE,1836 OI_PACKED,1837 OI_DBCACHED1838} whence;1839union{1840/*1841 * struct {1842 * ... Nothing to expose in this case1843 * } cached;1844 * struct {1845 * ... Nothing to expose in this case1846 * } loose;1847 */1848struct{1849struct packed_git *pack;1850 off_t offset;1851unsigned int is_delta;1852} packed;1853} u;1854};18551856/*1857 * Initializer for a "struct object_info" that wants no items. You may1858 * also memset() the memory to all-zeroes.1859 */1860#define OBJECT_INFO_INIT {NULL}18611862externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);1863externintpacked_object_info(struct packed_git *pack, off_t offset,struct object_info *);18641865/* Dumb servers support */1866externintupdate_server_info(int);18671868/* git_config_parse_key() returns these negated: */1869#define CONFIG_INVALID_KEY 11870#define CONFIG_NO_SECTION_OR_NAME 21871/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */1872#define CONFIG_NO_LOCK -11873#define CONFIG_INVALID_FILE 31874#define CONFIG_NO_WRITE 41875#define CONFIG_NOTHING_SET 51876#define CONFIG_INVALID_PATTERN 61877#define CONFIG_GENERIC_ERROR 718781879#define CONFIG_REGEX_NONE ((void *)1)18801881struct git_config_source {1882unsigned int use_stdin:1;1883const char*file;1884const char*blob;1885};18861887enum config_origin_type {1888 CONFIG_ORIGIN_BLOB,1889 CONFIG_ORIGIN_FILE,1890 CONFIG_ORIGIN_STDIN,1891 CONFIG_ORIGIN_SUBMODULE_BLOB,1892 CONFIG_ORIGIN_CMDLINE1893};18941895struct config_options {1896unsigned int respect_includes :1;1897const char*git_dir;1898};18991900typedefint(*config_fn_t)(const char*,const char*,void*);1901externintgit_default_config(const char*,const char*,void*);1902externintgit_config_from_file(config_fn_t fn,const char*,void*);1903externintgit_config_from_mem(config_fn_t fn,const enum config_origin_type,1904const char*name,const char*buf,size_t len,void*data);1905externintgit_config_from_blob_sha1(config_fn_t fn,const char*name,1906const unsigned char*sha1,void*data);1907externvoidgit_config_push_parameter(const char*text);1908externintgit_config_from_parameters(config_fn_t fn,void*data);1909externvoidread_early_config(config_fn_t cb,void*data);1910externvoidgit_config(config_fn_t fn,void*);1911externintgit_config_with_options(config_fn_t fn,void*,1912struct git_config_source *config_source,1913const struct config_options *opts);1914externintgit_parse_ulong(const char*,unsigned long*);1915externintgit_parse_maybe_bool(const char*);1916externintgit_config_int(const char*,const char*);1917externint64_tgit_config_int64(const char*,const char*);1918externunsigned longgit_config_ulong(const char*,const char*);1919extern ssize_t git_config_ssize_t(const char*,const char*);1920externintgit_config_bool_or_int(const char*,const char*,int*);1921externintgit_config_bool(const char*,const char*);1922externintgit_config_maybe_bool(const char*,const char*);1923externintgit_config_string(const char**,const char*,const char*);1924externintgit_config_pathname(const char**,const char*,const char*);1925externintgit_config_set_in_file_gently(const char*,const char*,const char*);1926externvoidgit_config_set_in_file(const char*,const char*,const char*);1927externintgit_config_set_gently(const char*,const char*);1928externvoidgit_config_set(const char*,const char*);1929externintgit_config_parse_key(const char*,char**,int*);1930externintgit_config_key_is_valid(const char*key);1931externintgit_config_set_multivar_gently(const char*,const char*,const char*,int);1932externvoidgit_config_set_multivar(const char*,const char*,const char*,int);1933externintgit_config_set_multivar_in_file_gently(const char*,const char*,const char*,const char*,int);1934externvoidgit_config_set_multivar_in_file(const char*,const char*,const char*,const char*,int);1935externintgit_config_rename_section(const char*,const char*);1936externintgit_config_rename_section_in_file(const char*,const char*,const char*);1937externconst char*git_etc_gitconfig(void);1938externintgit_env_bool(const char*,int);1939externunsigned longgit_env_ulong(const char*,unsigned long);1940externintgit_config_system(void);1941externintconfig_error_nonbool(const char*);1942#if defined(__GNUC__)1943#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1944#endif1945externconst char*get_log_output_encoding(void);1946externconst char*get_commit_output_encoding(void);19471948externintgit_config_parse_parameter(const char*, config_fn_t fn,void*data);19491950enum config_scope {1951 CONFIG_SCOPE_UNKNOWN =0,1952 CONFIG_SCOPE_SYSTEM,1953 CONFIG_SCOPE_GLOBAL,1954 CONFIG_SCOPE_REPO,1955 CONFIG_SCOPE_CMDLINE,1956};19571958externenum config_scope current_config_scope(void);1959externconst char*current_config_origin_type(void);1960externconst char*current_config_name(void);19611962struct config_include_data {1963int depth;1964 config_fn_t fn;1965void*data;1966const struct config_options *opts;1967};1968#define CONFIG_INCLUDE_INIT { 0 }1969externintgit_config_include(const char*name,const char*value,void*data);19701971/*1972 * Match and parse a config key of the form:1973 *1974 * section.(subsection.)?key1975 *1976 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1977 * we return -1 if it does not match, 0 otherwise. The subsection and key1978 * out-parameters are filled by the function (and *subsection is NULL if it is1979 * missing).1980 *1981 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if1982 * there is no subsection at all.1983 */1984externintparse_config_key(const char*var,1985const char*section,1986const char**subsection,int*subsection_len,1987const char**key);19881989struct config_set_element {1990struct hashmap_entry ent;1991char*key;1992struct string_list value_list;1993};19941995struct configset_list_item {1996struct config_set_element *e;1997int value_index;1998};19992000/*2001 * the contents of the list are ordered according to their2002 * position in the config files and order of parsing the files.2003 * (i.e. key-value pair at the last position of .git/config will2004 * be at the last item of the list)2005 */2006struct configset_list {2007struct configset_list_item *items;2008unsigned int nr, alloc;2009};20102011struct config_set {2012struct hashmap config_hash;2013int hash_initialized;2014struct configset_list list;2015};20162017externvoidgit_configset_init(struct config_set *cs);2018externintgit_configset_add_file(struct config_set *cs,const char*filename);2019externintgit_configset_get_value(struct config_set *cs,const char*key,const char**value);2020externconst struct string_list *git_configset_get_value_multi(struct config_set *cs,const char*key);2021externvoidgit_configset_clear(struct config_set *cs);2022externintgit_configset_get_string_const(struct config_set *cs,const char*key,const char**dest);2023externintgit_configset_get_string(struct config_set *cs,const char*key,char**dest);2024externintgit_configset_get_int(struct config_set *cs,const char*key,int*dest);2025externintgit_configset_get_ulong(struct config_set *cs,const char*key,unsigned long*dest);2026externintgit_configset_get_bool(struct config_set *cs,const char*key,int*dest);2027externintgit_configset_get_bool_or_int(struct config_set *cs,const char*key,int*is_bool,int*dest);2028externintgit_configset_get_maybe_bool(struct config_set *cs,const char*key,int*dest);2029externintgit_configset_get_pathname(struct config_set *cs,const char*key,const char**dest);20302031externintgit_config_get_value(const char*key,const char**value);2032externconst struct string_list *git_config_get_value_multi(const char*key);2033externvoidgit_config_clear(void);2034externvoidgit_config_iter(config_fn_t fn,void*data);2035externintgit_config_get_string_const(const char*key,const char**dest);2036externintgit_config_get_string(const char*key,char**dest);2037externintgit_config_get_int(const char*key,int*dest);2038externintgit_config_get_ulong(const char*key,unsigned long*dest);2039externintgit_config_get_bool(const char*key,int*dest);2040externintgit_config_get_bool_or_int(const char*key,int*is_bool,int*dest);2041externintgit_config_get_maybe_bool(const char*key,int*dest);2042externintgit_config_get_pathname(const char*key,const char**dest);2043externintgit_config_get_untracked_cache(void);2044externintgit_config_get_split_index(void);2045externintgit_config_get_max_percent_split_change(void);20462047/* This dies if the configured or default date is in the future */2048externintgit_config_get_expiry(const char*key,const char**output);20492050/*2051 * This is a hack for test programs like test-dump-untracked-cache to2052 * ensure that they do not modify the untracked cache when reading it.2053 * Do not use it otherwise!2054 */2055externint ignore_untracked_cache_config;20562057struct key_value_info {2058const char*filename;2059int linenr;2060enum config_origin_type origin_type;2061enum config_scope scope;2062};20632064extern NORETURN voidgit_die_config(const char*key,const char*err, ...)__attribute__((format(printf,2,3)));2065extern NORETURN voidgit_die_config_linenr(const char*key,const char*filename,int linenr);20662067externintcommitter_ident_sufficiently_given(void);2068externintauthor_ident_sufficiently_given(void);20692070externconst char*git_commit_encoding;2071externconst char*git_log_output_encoding;2072externconst char*git_mailmap_file;2073externconst char*git_mailmap_blob;20742075/* IO helper functions */2076externvoidmaybe_flush_or_die(FILE*,const char*);2077__attribute__((format(printf,2,3)))2078externvoidfprintf_or_die(FILE*,const char*fmt, ...);20792080#define COPY_READ_ERROR (-2)2081#define COPY_WRITE_ERROR (-3)2082externintcopy_fd(int ifd,int ofd);2083externintcopy_file(const char*dst,const char*src,int mode);2084externintcopy_file_with_time(const char*dst,const char*src,int mode);20852086externvoidwrite_or_die(int fd,const void*buf,size_t count);2087externvoidfsync_or_die(int fd,const char*);20882089extern ssize_t read_in_full(int fd,void*buf,size_t count);2090extern ssize_t write_in_full(int fd,const void*buf,size_t count);2091extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);20922093staticinline ssize_t write_str_in_full(int fd,const char*str)2094{2095returnwrite_in_full(fd, str,strlen(str));2096}20972098/**2099 * Open (and truncate) the file at path, write the contents of buf to it,2100 * and close it. Dies if any errors are encountered.2101 */2102externvoidwrite_file_buf(const char*path,const char*buf,size_t len);21032104/**2105 * Like write_file_buf(), but format the contents into a buffer first.2106 * Additionally, write_file() will append a newline if one is not already2107 * present, making it convenient to write text files:2108 *2109 * write_file(path, "counter: %d", ctr);2110 */2111__attribute__((format(printf,2,3)))2112externvoidwrite_file(const char*path,const char*fmt, ...);21132114/* pager.c */2115externvoidsetup_pager(void);2116externintpager_in_use(void);2117externint pager_use_color;2118externintterm_columns(void);2119externintdecimal_width(uintmax_t);2120externintcheck_pager_config(const char*cmd);2121externvoidprepare_pager_args(struct child_process *,const char*pager);21222123externconst char*editor_program;2124externconst char*askpass_program;2125externconst char*excludes_file;21262127/* base85 */2128intdecode_85(char*dst,const char*line,int linelen);2129voidencode_85(char*buf,const unsigned char*data,int bytes);21302131/* alloc.c */2132externvoid*alloc_blob_node(void);2133externvoid*alloc_tree_node(void);2134externvoid*alloc_commit_node(void);2135externvoid*alloc_tag_node(void);2136externvoid*alloc_object_node(void);2137externvoidalloc_report(void);2138externunsigned intalloc_commit_index(void);21392140/* pkt-line.c */2141voidpacket_trace_identity(const char*prog);21422143/* add */2144/*2145 * return 0 if success, 1 - if addition of a file failed and2146 * ADD_FILES_IGNORE_ERRORS was specified in flags2147 */2148intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);21492150/* diff.c */2151externint diff_auto_refresh_index;21522153/* match-trees.c */2154voidshift_tree(const struct object_id *,const struct object_id *,struct object_id *,int);2155voidshift_tree_by(const struct object_id *,const struct object_id *,struct object_id *,const char*);21562157/*2158 * whitespace rules.2159 * used by both diff and apply2160 * last two digits are tab width2161 */2162#define WS_BLANK_AT_EOL 01002163#define WS_SPACE_BEFORE_TAB 02002164#define WS_INDENT_WITH_NON_TAB 04002165#define WS_CR_AT_EOL 010002166#define WS_BLANK_AT_EOF 020002167#define WS_TAB_IN_INDENT 040002168#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)2169#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)2170#define WS_TAB_WIDTH_MASK 0772171externunsigned whitespace_rule_cfg;2172externunsignedwhitespace_rule(const char*);2173externunsignedparse_whitespace_rule(const char*);2174externunsignedws_check(const char*line,int len,unsigned ws_rule);2175externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);2176externchar*whitespace_error_string(unsigned ws);2177externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);2178externintws_blank_line(const char*line,int len,unsigned ws_rule);2179#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)21802181/* ls-files */2182voidoverlay_tree_on_cache(const char*tree_name,const char*prefix);21832184char*alias_lookup(const char*alias);2185intsplit_cmdline(char*cmdline,const char***argv);2186/* Takes a negative value returned by split_cmdline */2187const char*split_cmdline_strerror(int cmdline_errno);21882189/* setup.c */2190struct startup_info {2191int have_repository;2192const char*prefix;2193};2194externstruct startup_info *startup_info;21952196/* merge.c */2197struct commit_list;2198inttry_merge_command(const char*strategy,size_t xopts_nr,2199const char**xopts,struct commit_list *common,2200const char*head_arg,struct commit_list *remotes);2201intcheckout_fast_forward(const unsigned char*from,2202const unsigned char*to,2203int overwrite_ignore);220422052206intsane_execvp(const char*file,char*const argv[]);22072208/*2209 * A struct to encapsulate the concept of whether a file has changed2210 * since we last checked it. This uses criteria similar to those used2211 * for the index.2212 */2213struct stat_validity {2214struct stat_data *sd;2215};22162217voidstat_validity_clear(struct stat_validity *sv);22182219/*2220 * Returns 1 if the path is a regular file (or a symlink to a regular2221 * file) and matches the saved stat_validity, 0 otherwise. A missing2222 * or inaccessible file is considered a match if the struct was just2223 * initialized, or if the previous update found an inaccessible file.2224 */2225intstat_validity_check(struct stat_validity *sv,const char*path);22262227/*2228 * Update the stat_validity from a file opened at descriptor fd. If2229 * the file is missing, inaccessible, or not a regular file, then2230 * future calls to stat_validity_check will match iff one of those2231 * conditions continues to be true.2232 */2233voidstat_validity_update(struct stat_validity *sv,int fd);22342235intversioncmp(const char*s1,const char*s2);2236voidsleep_millisec(int millisec);22372238/*2239 * Create a directory and (if share is nonzero) adjust its permissions2240 * according to the shared_repository setting. Only use this for2241 * directories under $GIT_DIR. Don't use it for working tree2242 * directories.2243 */2244voidsafe_create_dir(const char*dir,int share);22452246#endif/* CACHE_H */