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 13#include SHA1_HEADER 14#ifndef git_SHA_CTX 15#define git_SHA_CTX SHA_CTX 16#define git_SHA1_Init SHA1_Init 17#define git_SHA1_Update SHA1_Update 18#define git_SHA1_Final SHA1_Final 19#endif 20 21#include <zlib.h> 22typedefstruct git_zstream { 23 z_stream z; 24unsigned long avail_in; 25unsigned long avail_out; 26unsigned long total_in; 27unsigned long total_out; 28unsigned char*next_in; 29unsigned char*next_out; 30} git_zstream; 31 32voidgit_inflate_init(git_zstream *); 33voidgit_inflate_init_gzip_only(git_zstream *); 34voidgit_inflate_end(git_zstream *); 35intgit_inflate(git_zstream *,int flush); 36 37voidgit_deflate_init(git_zstream *,int level); 38voidgit_deflate_init_gzip(git_zstream *,int level); 39voidgit_deflate_init_raw(git_zstream *,int level); 40voidgit_deflate_end(git_zstream *); 41intgit_deflate_abort(git_zstream *); 42intgit_deflate_end_gently(git_zstream *); 43intgit_deflate(git_zstream *,int flush); 44unsigned longgit_deflate_bound(git_zstream *,unsigned long); 45 46/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 47#define GIT_SHA1_RAWSZ 20 48#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 49 50struct object_id { 51unsigned char hash[GIT_SHA1_RAWSZ]; 52}; 53 54#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 55#define DTYPE(de) ((de)->d_type) 56#else 57#undef DT_UNKNOWN 58#undef DT_DIR 59#undef DT_REG 60#undef DT_LNK 61#define DT_UNKNOWN 0 62#define DT_DIR 1 63#define DT_REG 2 64#define DT_LNK 3 65#define DTYPE(de) DT_UNKNOWN 66#endif 67 68/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 69#define S_IFINVALID 0030000 70 71/* 72 * A "directory link" is a link to another git directory. 73 * 74 * The value 0160000 is not normally a valid mode, and 75 * also just happens to be S_IFDIR + S_IFLNK 76 */ 77#define S_IFGITLINK 0160000 78#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 79 80/* 81 * Some mode bits are also used internally for computations. 82 * 83 * They *must* not overlap with any valid modes, and they *must* not be emitted 84 * to outside world - i.e. appear on disk or network. In other words, it's just 85 * temporary fields, which we internally use, but they have to stay in-house. 86 * 87 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 88 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 89 */ 90 91/* used internally in tree-diff */ 92#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 93 94 95/* 96 * Intensive research over the course of many years has shown that 97 * port 9418 is totally unused by anything else. Or 98 * 99 * Your search - "port 9418" - did not match any documents. 100 * 101 * as www.google.com puts it. 102 * 103 * This port has been properly assigned for git use by IANA: 104 * git (Assigned-9418) [I06-050728-0001]. 105 * 106 * git 9418/tcp git pack transfer service 107 * git 9418/udp git pack transfer service 108 * 109 * with Linus Torvalds <torvalds@osdl.org> as the point of 110 * contact. September 2005. 111 * 112 * See http://www.iana.org/assignments/port-numbers 113 */ 114#define DEFAULT_GIT_PORT 9418 115 116/* 117 * Basic data structures for the directory cache 118 */ 119 120#define CACHE_SIGNATURE 0x44495243/* "DIRC" */ 121struct cache_header { 122uint32_t hdr_signature; 123uint32_t hdr_version; 124uint32_t hdr_entries; 125}; 126 127#define INDEX_FORMAT_LB 2 128#define INDEX_FORMAT_UB 4 129 130/* 131 * The "cache_time" is just the low 32 bits of the 132 * time. It doesn't matter if it overflows - we only 133 * check it for equality in the 32 bits we save. 134 */ 135struct cache_time { 136uint32_t sec; 137uint32_t nsec; 138}; 139 140struct stat_data { 141struct cache_time sd_ctime; 142struct cache_time sd_mtime; 143unsigned int sd_dev; 144unsigned int sd_ino; 145unsigned int sd_uid; 146unsigned int sd_gid; 147unsigned int sd_size; 148}; 149 150struct cache_entry { 151struct hashmap_entry ent; 152struct stat_data ce_stat_data; 153unsigned int ce_mode; 154unsigned int ce_flags; 155unsigned int ce_namelen; 156unsigned int index;/* for link extension */ 157unsigned char sha1[20]; 158char name[FLEX_ARRAY];/* more */ 159}; 160 161#define CE_STAGEMASK (0x3000) 162#define CE_EXTENDED (0x4000) 163#define CE_VALID (0x8000) 164#define CE_STAGESHIFT 12 165 166/* 167 * Range 0xFFFF0FFF in ce_flags is divided into 168 * two parts: in-memory flags and on-disk ones. 169 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 170 * if you want to save a new flag, add it in 171 * CE_EXTENDED_FLAGS 172 * 173 * In-memory only flags 174 */ 175#define CE_UPDATE (1 << 16) 176#define CE_REMOVE (1 << 17) 177#define CE_UPTODATE (1 << 18) 178#define CE_ADDED (1 << 19) 179 180#define CE_HASHED (1 << 20) 181#define CE_WT_REMOVE (1 << 22)/* remove in work directory */ 182#define CE_CONFLICTED (1 << 23) 183 184#define CE_UNPACKED (1 << 24) 185#define CE_NEW_SKIP_WORKTREE (1 << 25) 186 187/* used to temporarily mark paths matched by pathspecs */ 188#define CE_MATCHED (1 << 26) 189 190#define CE_UPDATE_IN_BASE (1 << 27) 191#define CE_STRIP_NAME (1 << 28) 192 193/* 194 * Extended on-disk flags 195 */ 196#define CE_INTENT_TO_ADD (1 << 29) 197#define CE_SKIP_WORKTREE (1 << 30) 198/* CE_EXTENDED2 is for future extension */ 199#define CE_EXTENDED2 (1 << 31) 200 201#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 202 203/* 204 * Safeguard to avoid saving wrong flags: 205 * - CE_EXTENDED2 won't get saved until its semantic is known 206 * - Bits in 0x0000FFFF have been saved in ce_flags already 207 * - Bits in 0x003F0000 are currently in-memory flags 208 */ 209#if CE_EXTENDED_FLAGS & 0x803FFFFF 210#error"CE_EXTENDED_FLAGS out of range" 211#endif 212 213struct pathspec; 214 215/* 216 * Copy the sha1 and stat state of a cache entry from one to 217 * another. But we never change the name, or the hash state! 218 */ 219staticinlinevoidcopy_cache_entry(struct cache_entry *dst, 220const struct cache_entry *src) 221{ 222unsigned int state = dst->ce_flags & CE_HASHED; 223 224/* Don't copy hash chain and name */ 225memcpy(&dst->ce_stat_data, &src->ce_stat_data, 226offsetof(struct cache_entry, name) - 227offsetof(struct cache_entry, ce_stat_data)); 228 229/* Restore the hash state */ 230 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 231} 232 233staticinlineunsignedcreate_ce_flags(unsigned stage) 234{ 235return(stage << CE_STAGESHIFT); 236} 237 238#define ce_namelen(ce) ((ce)->ce_namelen) 239#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 240#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 241#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 242#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 243#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 244 245#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 246staticinlineunsigned intcreate_ce_mode(unsigned int mode) 247{ 248if(S_ISLNK(mode)) 249return S_IFLNK; 250if(S_ISDIR(mode) ||S_ISGITLINK(mode)) 251return S_IFGITLINK; 252return S_IFREG |ce_permissions(mode); 253} 254staticinlineunsigned intce_mode_from_stat(const struct cache_entry *ce, 255unsigned int mode) 256{ 257externint trust_executable_bit, has_symlinks; 258if(!has_symlinks &&S_ISREG(mode) && 259 ce &&S_ISLNK(ce->ce_mode)) 260return ce->ce_mode; 261if(!trust_executable_bit &&S_ISREG(mode)) { 262if(ce &&S_ISREG(ce->ce_mode)) 263return ce->ce_mode; 264returncreate_ce_mode(0666); 265} 266returncreate_ce_mode(mode); 267} 268staticinlineintce_to_dtype(const struct cache_entry *ce) 269{ 270unsigned ce_mode =ntohl(ce->ce_mode); 271if(S_ISREG(ce_mode)) 272return DT_REG; 273else if(S_ISDIR(ce_mode) ||S_ISGITLINK(ce_mode)) 274return DT_DIR; 275else if(S_ISLNK(ce_mode)) 276return DT_LNK; 277else 278return DT_UNKNOWN; 279} 280staticinlineunsigned intcanon_mode(unsigned int mode) 281{ 282if(S_ISREG(mode)) 283return S_IFREG |ce_permissions(mode); 284if(S_ISLNK(mode)) 285return S_IFLNK; 286if(S_ISDIR(mode)) 287return S_IFDIR; 288return S_IFGITLINK; 289} 290 291#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 292 293#define SOMETHING_CHANGED (1 << 0)/* unclassified changes go here */ 294#define CE_ENTRY_CHANGED (1 << 1) 295#define CE_ENTRY_REMOVED (1 << 2) 296#define CE_ENTRY_ADDED (1 << 3) 297#define RESOLVE_UNDO_CHANGED (1 << 4) 298#define CACHE_TREE_CHANGED (1 << 5) 299#define SPLIT_INDEX_ORDERED (1 << 6) 300 301struct split_index; 302struct index_state { 303struct cache_entry **cache; 304unsigned int version; 305unsigned int cache_nr, cache_alloc, cache_changed; 306struct string_list *resolve_undo; 307struct cache_tree *cache_tree; 308struct split_index *split_index; 309struct cache_time timestamp; 310unsigned name_hash_initialized :1, 311 initialized :1; 312struct hashmap name_hash; 313struct hashmap dir_hash; 314unsigned char sha1[20]; 315}; 316 317externstruct index_state the_index; 318 319/* Name hashing */ 320externvoidadd_name_hash(struct index_state *istate,struct cache_entry *ce); 321externvoidremove_name_hash(struct index_state *istate,struct cache_entry *ce); 322externvoidfree_name_hash(struct index_state *istate); 323 324 325#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 326#define active_cache (the_index.cache) 327#define active_nr (the_index.cache_nr) 328#define active_alloc (the_index.cache_alloc) 329#define active_cache_changed (the_index.cache_changed) 330#define active_cache_tree (the_index.cache_tree) 331 332#define read_cache() read_index(&the_index) 333#define read_cache_from(path) read_index_from(&the_index, (path)) 334#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 335#define is_cache_unborn() is_index_unborn(&the_index) 336#define read_cache_unmerged() read_index_unmerged(&the_index) 337#define discard_cache() discard_index(&the_index) 338#define unmerged_cache() unmerged_index(&the_index) 339#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 340#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 341#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 342#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 343#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 344#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 345#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 346#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 347#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 348#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 349#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 350#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 351#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 352#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 353#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 354#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 355#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 356#endif 357 358enum object_type { 359 OBJ_BAD = -1, 360 OBJ_NONE =0, 361 OBJ_COMMIT =1, 362 OBJ_TREE =2, 363 OBJ_BLOB =3, 364 OBJ_TAG =4, 365/* 5 for future expansion */ 366 OBJ_OFS_DELTA =6, 367 OBJ_REF_DELTA =7, 368 OBJ_ANY, 369 OBJ_MAX 370}; 371 372staticinlineenum object_type object_type(unsigned int mode) 373{ 374returnS_ISDIR(mode) ? OBJ_TREE : 375S_ISGITLINK(mode) ? OBJ_COMMIT : 376 OBJ_BLOB; 377} 378 379/* Double-check local_repo_env below if you add to this list. */ 380#define GIT_DIR_ENVIRONMENT"GIT_DIR" 381#define GIT_COMMON_DIR_ENVIRONMENT"GIT_COMMON_DIR" 382#define GIT_NAMESPACE_ENVIRONMENT"GIT_NAMESPACE" 383#define GIT_WORK_TREE_ENVIRONMENT"GIT_WORK_TREE" 384#define GIT_PREFIX_ENVIRONMENT"GIT_PREFIX" 385#define DEFAULT_GIT_DIR_ENVIRONMENT".git" 386#define DB_ENVIRONMENT"GIT_OBJECT_DIRECTORY" 387#define INDEX_ENVIRONMENT"GIT_INDEX_FILE" 388#define GRAFT_ENVIRONMENT"GIT_GRAFT_FILE" 389#define GIT_SHALLOW_FILE_ENVIRONMENT"GIT_SHALLOW_FILE" 390#define TEMPLATE_DIR_ENVIRONMENT"GIT_TEMPLATE_DIR" 391#define CONFIG_ENVIRONMENT"GIT_CONFIG" 392#define CONFIG_DATA_ENVIRONMENT"GIT_CONFIG_PARAMETERS" 393#define EXEC_PATH_ENVIRONMENT"GIT_EXEC_PATH" 394#define CEILING_DIRECTORIES_ENVIRONMENT"GIT_CEILING_DIRECTORIES" 395#define NO_REPLACE_OBJECTS_ENVIRONMENT"GIT_NO_REPLACE_OBJECTS" 396#define GITATTRIBUTES_FILE".gitattributes" 397#define INFOATTRIBUTES_FILE"info/attributes" 398#define ATTRIBUTE_MACRO_PREFIX"[attr]" 399#define GIT_NOTES_REF_ENVIRONMENT"GIT_NOTES_REF" 400#define GIT_NOTES_DEFAULT_REF"refs/notes/commits" 401#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT"GIT_NOTES_DISPLAY_REF" 402#define GIT_NOTES_REWRITE_REF_ENVIRONMENT"GIT_NOTES_REWRITE_REF" 403#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT"GIT_NOTES_REWRITE_MODE" 404#define GIT_LITERAL_PATHSPECS_ENVIRONMENT"GIT_LITERAL_PATHSPECS" 405#define GIT_GLOB_PATHSPECS_ENVIRONMENT"GIT_GLOB_PATHSPECS" 406#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT"GIT_NOGLOB_PATHSPECS" 407#define GIT_ICASE_PATHSPECS_ENVIRONMENT"GIT_ICASE_PATHSPECS" 408 409/* 410 * This environment variable is expected to contain a boolean indicating 411 * whether we should or should not treat: 412 * 413 * GIT_DIR=foo.git git ... 414 * 415 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 416 * of this, but we use it internally to communicate to sub-processes that we 417 * are in a bare repo. If not set, defaults to true. 418 */ 419#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT"GIT_IMPLICIT_WORK_TREE" 420 421/* 422 * Repository-local GIT_* environment variables; these will be cleared 423 * when git spawns a sub-process that runs inside another repository. 424 * The array is NULL-terminated, which makes it easy to pass in the "env" 425 * parameter of a run-command invocation, or to do a simple walk. 426 */ 427externconst char*const local_repo_env[]; 428 429externint is_bare_repository_cfg; 430externintis_bare_repository(void); 431externintis_inside_git_dir(void); 432externchar*git_work_tree_cfg; 433externintis_inside_work_tree(void); 434externconst char*get_git_dir(void); 435externconst char*get_git_common_dir(void); 436externintis_git_directory(const char*path); 437externchar*get_object_directory(void); 438externchar*get_index_file(void); 439externchar*get_graft_file(void); 440externintset_git_dir(const char*path); 441externintget_common_dir(struct strbuf *sb,const char*gitdir); 442externconst char*get_git_namespace(void); 443externconst char*strip_namespace(const char*namespaced_ref); 444externconst char*get_git_work_tree(void); 445externconst char*read_gitfile(const char*path); 446externconst char*resolve_gitdir(const char*suspect); 447externvoidset_git_work_tree(const char*tree); 448 449#define ALTERNATE_DB_ENVIRONMENT"GIT_ALTERNATE_OBJECT_DIRECTORIES" 450 451externconst char**get_pathspec(const char*prefix,const char**pathspec); 452externvoidsetup_work_tree(void); 453externconst char*setup_git_directory_gently(int*); 454externconst char*setup_git_directory(void); 455externchar*prefix_path(const char*prefix,int len,const char*path); 456externchar*prefix_path_gently(const char*prefix,int len,int*remaining,const char*path); 457externconst char*prefix_filename(const char*prefix,int len,const char*path); 458externintcheck_filename(const char*prefix,const char*name); 459externvoidverify_filename(const char*prefix, 460const char*name, 461int diagnose_misspelt_rev); 462externvoidverify_non_filename(const char*prefix,const char*name); 463externintpath_inside_repo(const char*prefix,const char*path); 464 465#define INIT_DB_QUIET 0x0001 466 467externintset_git_dir_init(const char*git_dir,const char*real_git_dir,int); 468externintinit_db(const char*template_dir,unsigned int flags); 469 470externvoidsanitize_stdfds(void); 471externintdaemonize(void); 472 473#define alloc_nr(x) (((x)+16)*3/2) 474 475/* 476 * Realloc the buffer pointed at by variable 'x' so that it can hold 477 * at least 'nr' entries; the number of entries currently allocated 478 * is 'alloc', using the standard growing factor alloc_nr() macro. 479 * 480 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 481 */ 482#define ALLOC_GROW(x, nr, alloc) \ 483 do { \ 484 if ((nr) > alloc) { \ 485 if (alloc_nr(alloc) < (nr)) \ 486 alloc = (nr); \ 487 else \ 488 alloc = alloc_nr(alloc); \ 489 REALLOC_ARRAY(x, alloc); \ 490 } \ 491 } while (0) 492 493/* Initialize and use the cache information */ 494struct lock_file; 495externintread_index(struct index_state *); 496externintread_index_preload(struct index_state *,const struct pathspec *pathspec); 497externintdo_read_index(struct index_state *istate,const char*path, 498int must_exist);/* for testting only! */ 499externintread_index_from(struct index_state *,const char*path); 500externintis_index_unborn(struct index_state *); 501externintread_index_unmerged(struct index_state *); 502#define COMMIT_LOCK (1 << 0) 503#define CLOSE_LOCK (1 << 1) 504externintwrite_locked_index(struct index_state *,struct lock_file *lock,unsigned flags); 505externintdiscard_index(struct index_state *); 506externintunmerged_index(const struct index_state *); 507externintverify_path(const char*path); 508externstruct cache_entry *index_dir_exists(struct index_state *istate,const char*name,int namelen); 509externstruct cache_entry *index_file_exists(struct index_state *istate,const char*name,int namelen,int igncase); 510externintindex_name_pos(const struct index_state *,const char*name,int namelen); 511#define ADD_CACHE_OK_TO_ADD 1/* Ok to add */ 512#define ADD_CACHE_OK_TO_REPLACE 2/* Ok to replace file/directory */ 513#define ADD_CACHE_SKIP_DFCHECK 4/* Ok to skip DF conflict checks */ 514#define ADD_CACHE_JUST_APPEND 8/* Append only; tree.c::read_tree() */ 515#define ADD_CACHE_NEW_ONLY 16/* Do not replace existing ones */ 516#define ADD_CACHE_KEEP_CACHE_TREE 32/* Do not invalidate cache-tree */ 517externintadd_index_entry(struct index_state *,struct cache_entry *ce,int option); 518externvoidrename_index_entry_at(struct index_state *,int pos,const char*new_name); 519externintremove_index_entry_at(struct index_state *,int pos); 520externvoidremove_marked_cache_entries(struct index_state *istate); 521externintremove_file_from_index(struct index_state *,const char*path); 522#define ADD_CACHE_VERBOSE 1 523#define ADD_CACHE_PRETEND 2 524#define ADD_CACHE_IGNORE_ERRORS 4 525#define ADD_CACHE_IGNORE_REMOVAL 8 526#define ADD_CACHE_INTENT 16 527externintadd_to_index(struct index_state *,const char*path,struct stat *,int flags); 528externintadd_file_to_index(struct index_state *,const char*path,int flags); 529externstruct cache_entry *make_cache_entry(unsigned int mode,const unsigned char*sha1,const char*path,int stage,unsigned int refresh_options); 530externintce_same_name(const struct cache_entry *a,const struct cache_entry *b); 531externvoidset_object_name_for_intent_to_add_entry(struct cache_entry *ce); 532externintindex_name_is_other(const struct index_state *,const char*,int); 533externvoid*read_blob_data_from_index(struct index_state *,const char*,unsigned long*); 534 535/* do stat comparison even if CE_VALID is true */ 536#define CE_MATCH_IGNORE_VALID 01 537/* do not check the contents but report dirty on racily-clean entries */ 538#define CE_MATCH_RACY_IS_DIRTY 02 539/* do stat comparison even if CE_SKIP_WORKTREE is true */ 540#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 541/* ignore non-existent files during stat update */ 542#define CE_MATCH_IGNORE_MISSING 0x08 543/* enable stat refresh */ 544#define CE_MATCH_REFRESH 0x10 545externintie_match_stat(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 546externintie_modified(const struct index_state *,const struct cache_entry *,struct stat *,unsigned int); 547 548#define HASH_WRITE_OBJECT 1 549#define HASH_FORMAT_CHECK 2 550externintindex_fd(unsigned char*sha1,int fd,struct stat *st,enum object_type type,const char*path,unsigned flags); 551externintindex_path(unsigned char*sha1,const char*path,struct stat *st,unsigned flags); 552 553/* 554 * Record to sd the data from st that we use to check whether a file 555 * might have changed. 556 */ 557externvoidfill_stat_data(struct stat_data *sd,struct stat *st); 558 559/* 560 * Return 0 if st is consistent with a file not having been changed 561 * since sd was filled. If there are differences, return a 562 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 563 * INODE_CHANGED, and DATA_CHANGED. 564 */ 565externintmatch_stat_data(const struct stat_data *sd,struct stat *st); 566 567externvoidfill_stat_cache_info(struct cache_entry *ce,struct stat *st); 568 569#define REFRESH_REALLY 0x0001/* ignore_valid */ 570#define REFRESH_UNMERGED 0x0002/* allow unmerged */ 571#define REFRESH_QUIET 0x0004/* be quiet about it */ 572#define REFRESH_IGNORE_MISSING 0x0008/* ignore non-existent */ 573#define REFRESH_IGNORE_SUBMODULES 0x0010/* ignore submodules */ 574#define REFRESH_IN_PORCELAIN 0x0020/* user friendly output, not "needs update" */ 575externintrefresh_index(struct index_state *,unsigned int flags,const struct pathspec *pathspec,char*seen,const char*header_msg); 576 577externvoidupdate_index_if_able(struct index_state *,struct lock_file *); 578 579externinthold_locked_index(struct lock_file *,int); 580externvoidset_alternate_index_output(const char*); 581 582externintdelete_ref(const char*,const unsigned char*sha1,unsigned int flags); 583 584/* Environment bits from configuration mechanism */ 585externint trust_executable_bit; 586externint trust_ctime; 587externint check_stat; 588externint quote_path_fully; 589externint has_symlinks; 590externint minimum_abbrev, default_abbrev; 591externint ignore_case; 592externint assume_unchanged; 593externint prefer_symlink_refs; 594externint log_all_ref_updates; 595externint warn_ambiguous_refs; 596externint warn_on_object_refname_ambiguity; 597externint shared_repository; 598externconst char*apply_default_whitespace; 599externconst char*apply_default_ignorewhitespace; 600externconst char*git_attributes_file; 601externint zlib_compression_level; 602externint core_compression_level; 603externint core_compression_seen; 604externsize_t packed_git_window_size; 605externsize_t packed_git_limit; 606externsize_t delta_base_cache_limit; 607externunsigned long big_file_threshold; 608externunsigned long pack_size_limit_cfg; 609 610/* 611 * Do replace refs need to be checked this run? This variable is 612 * initialized to true unless --no-replace-object is used or 613 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 614 * commands that do not want replace references to be active. As an 615 * optimization it is also set to false if replace references have 616 * been sought but there were none. 617 */ 618externint check_replace_refs; 619 620externint fsync_object_files; 621externint core_preload_index; 622externint core_apply_sparse_checkout; 623externint precomposed_unicode; 624externint protect_hfs; 625externint protect_ntfs; 626externint git_db_env, git_index_env, git_graft_env, git_common_dir_env; 627 628/* 629 * Include broken refs in all ref iterations, which will 630 * generally choke dangerous operations rather than letting 631 * them silently proceed without taking the broken ref into 632 * account. 633 */ 634externint ref_paranoia; 635 636/* 637 * The character that begins a commented line in user-editable file 638 * that is subject to stripspace. 639 */ 640externchar comment_line_char; 641externint auto_comment_line_char; 642 643enum branch_track { 644 BRANCH_TRACK_UNSPECIFIED = -1, 645 BRANCH_TRACK_NEVER =0, 646 BRANCH_TRACK_REMOTE, 647 BRANCH_TRACK_ALWAYS, 648 BRANCH_TRACK_EXPLICIT, 649 BRANCH_TRACK_OVERRIDE 650}; 651 652enum rebase_setup_type { 653 AUTOREBASE_NEVER =0, 654 AUTOREBASE_LOCAL, 655 AUTOREBASE_REMOTE, 656 AUTOREBASE_ALWAYS 657}; 658 659enum push_default_type { 660 PUSH_DEFAULT_NOTHING =0, 661 PUSH_DEFAULT_MATCHING, 662 PUSH_DEFAULT_SIMPLE, 663 PUSH_DEFAULT_UPSTREAM, 664 PUSH_DEFAULT_CURRENT, 665 PUSH_DEFAULT_UNSPECIFIED 666}; 667 668externenum branch_track git_branch_track; 669externenum rebase_setup_type autorebase; 670externenum push_default_type push_default; 671 672enum object_creation_mode { 673 OBJECT_CREATION_USES_HARDLINKS =0, 674 OBJECT_CREATION_USES_RENAMES =1 675}; 676 677externenum object_creation_mode object_creation_mode; 678 679externchar*notes_ref_name; 680 681externint grafts_replace_parents; 682 683#define GIT_REPO_VERSION 0 684externint repository_format_version; 685externintcheck_repository_format(void); 686 687#define MTIME_CHANGED 0x0001 688#define CTIME_CHANGED 0x0002 689#define OWNER_CHANGED 0x0004 690#define MODE_CHANGED 0x0008 691#define INODE_CHANGED 0x0010 692#define DATA_CHANGED 0x0020 693#define TYPE_CHANGED 0x0040 694 695externchar*mksnpath(char*buf,size_t n,const char*fmt, ...) 696__attribute__((format(printf,3,4))); 697externvoidstrbuf_git_path(struct strbuf *sb,const char*fmt, ...) 698__attribute__((format(printf,2,3))); 699externchar*git_pathdup(const char*fmt, ...) 700__attribute__((format(printf,1,2))); 701externchar*mkpathdup(const char*fmt, ...) 702__attribute__((format(printf,1,2))); 703 704/* Return a statically allocated filename matching the sha1 signature */ 705externconst char*mkpath(const char*fmt, ...)__attribute__((format(printf,1,2))); 706externconst char*git_path(const char*fmt, ...)__attribute__((format(printf,1,2))); 707externconst char*git_path_submodule(const char*path,const char*fmt, ...) 708__attribute__((format(printf,2,3))); 709externvoidreport_linked_checkout_garbage(void); 710 711/* 712 * Return the name of the file in the local object database that would 713 * be used to store a loose object with the specified sha1. The 714 * return value is a pointer to a statically allocated buffer that is 715 * overwritten each time the function is called. 716 */ 717externconst char*sha1_file_name(const unsigned char*sha1); 718 719/* 720 * Return the name of the (local) packfile with the specified sha1 in 721 * its name. The return value is a pointer to memory that is 722 * overwritten each time this function is called. 723 */ 724externchar*sha1_pack_name(const unsigned char*sha1); 725 726/* 727 * Return the name of the (local) pack index file with the specified 728 * sha1 in its name. The return value is a pointer to memory that is 729 * overwritten each time this function is called. 730 */ 731externchar*sha1_pack_index_name(const unsigned char*sha1); 732 733externconst char*find_unique_abbrev(const unsigned char*sha1,int); 734externconst unsigned char null_sha1[GIT_SHA1_RAWSZ]; 735 736staticinlineinthashcmp(const unsigned char*sha1,const unsigned char*sha2) 737{ 738int i; 739 740for(i =0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 741if(*sha1 != *sha2) 742return*sha1 - *sha2; 743} 744 745return0; 746} 747 748staticinlineintoidcmp(const struct object_id *oid1,const struct object_id *oid2) 749{ 750returnhashcmp(oid1->hash, oid2->hash); 751} 752 753staticinlineintis_null_sha1(const unsigned char*sha1) 754{ 755return!hashcmp(sha1, null_sha1); 756} 757 758staticinlineintis_null_oid(const struct object_id *oid) 759{ 760return!hashcmp(oid->hash, null_sha1); 761} 762 763staticinlinevoidhashcpy(unsigned char*sha_dst,const unsigned char*sha_src) 764{ 765memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 766} 767 768staticinlinevoidoidcpy(struct object_id *dst,const struct object_id *src) 769{ 770hashcpy(dst->hash, src->hash); 771} 772 773staticinlinevoidhashclr(unsigned char*hash) 774{ 775memset(hash,0, GIT_SHA1_RAWSZ); 776} 777 778staticinlinevoidoidclr(struct object_id *oid) 779{ 780hashclr(oid->hash); 781} 782 783 784#define EMPTY_TREE_SHA1_HEX \ 785"4b825dc642cb6eb9a060e54bf8d69288fbee4904" 786#define EMPTY_TREE_SHA1_BIN_LITERAL \ 787"\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \ 788"\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04" 789#define EMPTY_TREE_SHA1_BIN \ 790 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL) 791 792#define EMPTY_BLOB_SHA1_HEX \ 793"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391" 794#define EMPTY_BLOB_SHA1_BIN_LITERAL \ 795"\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \ 796"\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91" 797#define EMPTY_BLOB_SHA1_BIN \ 798 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL) 799 800staticinlineintis_empty_blob_sha1(const unsigned char*sha1) 801{ 802return!hashcmp(sha1, EMPTY_BLOB_SHA1_BIN); 803} 804 805intgit_mkstemp(char*path,size_t n,const char*template); 806 807intgit_mkstemps(char*path,size_t n,const char*template,int suffix_len); 808 809/* set default permissions by passing mode arguments to open(2) */ 810intgit_mkstemps_mode(char*pattern,int suffix_len,int mode); 811intgit_mkstemp_mode(char*pattern,int mode); 812 813/* 814 * NOTE NOTE NOTE!! 815 * 816 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must 817 * not be changed. Old repositories have core.sharedrepository written in 818 * numeric format, and therefore these values are preserved for compatibility 819 * reasons. 820 */ 821enum sharedrepo { 822 PERM_UMASK =0, 823 OLD_PERM_GROUP =1, 824 OLD_PERM_EVERYBODY =2, 825 PERM_GROUP =0660, 826 PERM_EVERYBODY =0664 827}; 828intgit_config_perm(const char*var,const char*value); 829intadjust_shared_perm(const char*path); 830 831/* 832 * Create the directory containing the named path, using care to be 833 * somewhat safe against races. Return one of the scld_error values 834 * to indicate success/failure. 835 * 836 * SCLD_VANISHED indicates that one of the ancestor directories of the 837 * path existed at one point during the function call and then 838 * suddenly vanished, probably because another process pruned the 839 * directory while we were working. To be robust against this kind of 840 * race, callers might want to try invoking the function again when it 841 * returns SCLD_VANISHED. 842 */ 843enum scld_error { 844 SCLD_OK =0, 845 SCLD_FAILED = -1, 846 SCLD_PERMS = -2, 847 SCLD_EXISTS = -3, 848 SCLD_VANISHED = -4 849}; 850enum scld_error safe_create_leading_directories(char*path); 851enum scld_error safe_create_leading_directories_const(const char*path); 852 853intmkdir_in_gitdir(const char*path); 854externchar*expand_user_path(const char*path); 855const char*enter_repo(const char*path,int strict); 856staticinlineintis_absolute_path(const char*path) 857{ 858returnis_dir_sep(path[0]) ||has_dos_drive_prefix(path); 859} 860intis_directory(const char*); 861const char*real_path(const char*path); 862const char*real_path_if_valid(const char*path); 863const char*absolute_path(const char*path); 864const char*remove_leading_path(const char*in,const char*prefix); 865const char*relative_path(const char*in,const char*prefix,struct strbuf *sb); 866intnormalize_path_copy_len(char*dst,const char*src,int*prefix_len); 867intnormalize_path_copy(char*dst,const char*src); 868intlongest_ancestor_length(const char*path,struct string_list *prefixes); 869char*strip_path_suffix(const char*path,const char*suffix); 870intdaemon_avoid_alias(const char*path); 871externintis_ntfs_dotgit(const char*name); 872 873/** 874 * Return a newly allocated string with the evaluation of 875 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise 876 * "$HOME/.config/git/$filename". Return NULL upon error. 877 */ 878externchar*xdg_config_home(const char*filename); 879 880/* object replacement */ 881#define LOOKUP_REPLACE_OBJECT 1 882#define LOOKUP_UNKNOWN_OBJECT 2 883externvoid*read_sha1_file_extended(const unsigned char*sha1,enum object_type *type,unsigned long*size,unsigned flag); 884staticinlinevoid*read_sha1_file(const unsigned char*sha1,enum object_type *type,unsigned long*size) 885{ 886returnread_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT); 887} 888 889/* 890 * This internal function is only declared here for the benefit of 891 * lookup_replace_object(). Please do not call it directly. 892 */ 893externconst unsigned char*do_lookup_replace_object(const unsigned char*sha1); 894 895/* 896 * If object sha1 should be replaced, return the replacement object's 897 * name (replaced recursively, if necessary). The return value is 898 * either sha1 or a pointer to a permanently-allocated value. When 899 * object replacement is suppressed, always return sha1. 900 */ 901staticinlineconst unsigned char*lookup_replace_object(const unsigned char*sha1) 902{ 903if(!check_replace_refs) 904return sha1; 905returndo_lookup_replace_object(sha1); 906} 907 908staticinlineconst unsigned char*lookup_replace_object_extended(const unsigned char*sha1,unsigned flag) 909{ 910if(!(flag & LOOKUP_REPLACE_OBJECT)) 911return sha1; 912returnlookup_replace_object(sha1); 913} 914 915/* Read and unpack a sha1 file into memory, write memory to a sha1 file */ 916externintsha1_object_info(const unsigned char*,unsigned long*); 917externinthash_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*sha1); 918externintwrite_sha1_file(const void*buf,unsigned long len,const char*type,unsigned char*return_sha1); 919externinthash_sha1_file_literally(const void*buf,unsigned long len,const char*type,unsigned char*sha1,unsigned flags); 920externintpretend_sha1_file(void*,unsigned long,enum object_type,unsigned char*); 921externintforce_object_loose(const unsigned char*sha1,time_t mtime); 922externintgit_open_noatime(const char*name); 923externvoid*map_sha1_file(const unsigned char*sha1,unsigned long*size); 924externintunpack_sha1_header(git_zstream *stream,unsigned char*map,unsigned long mapsize,void*buffer,unsigned long bufsiz); 925externintparse_sha1_header(const char*hdr,unsigned long*sizep); 926 927/* global flag to enable extra checks when accessing packed objects */ 928externint do_check_packed_object_crc; 929 930externintcheck_sha1_signature(const unsigned char*sha1,void*buf,unsigned long size,const char*type); 931 932externintmove_temp_to_file(const char*tmpfile,const char*filename); 933 934externinthas_sha1_pack(const unsigned char*sha1); 935 936/* 937 * Return true iff we have an object named sha1, whether local or in 938 * an alternate object database, and whether packed or loose. This 939 * function does not respect replace references. 940 */ 941externinthas_sha1_file(const unsigned char*sha1); 942 943/* 944 * Return true iff an alternate object database has a loose object 945 * with the specified name. This function does not respect replace 946 * references. 947 */ 948externinthas_loose_object_nonlocal(const unsigned char*sha1); 949 950externinthas_pack_index(const unsigned char*sha1); 951 952externvoidassert_sha1_type(const unsigned char*sha1,enum object_type expect); 953 954externconst signed char hexval_table[256]; 955staticinlineunsigned inthexval(unsigned char c) 956{ 957return hexval_table[c]; 958} 959 960/* Convert to/from hex/sha1 representation */ 961#define MINIMUM_ABBREV minimum_abbrev 962#define DEFAULT_ABBREV default_abbrev 963 964struct object_context { 965unsigned char tree[20]; 966char path[PATH_MAX]; 967unsigned mode; 968}; 969 970#define GET_SHA1_QUIETLY 01 971#define GET_SHA1_COMMIT 02 972#define GET_SHA1_COMMITTISH 04 973#define GET_SHA1_TREE 010 974#define GET_SHA1_TREEISH 020 975#define GET_SHA1_BLOB 040 976#define GET_SHA1_ONLY_TO_DIE 04000 977 978externintget_sha1(const char*str,unsigned char*sha1); 979externintget_sha1_commit(const char*str,unsigned char*sha1); 980externintget_sha1_committish(const char*str,unsigned char*sha1); 981externintget_sha1_tree(const char*str,unsigned char*sha1); 982externintget_sha1_treeish(const char*str,unsigned char*sha1); 983externintget_sha1_blob(const char*str,unsigned char*sha1); 984externvoidmaybe_die_on_misspelt_object_name(const char*name,const char*prefix); 985externintget_sha1_with_context(const char*str,unsigned flags,unsigned char*sha1,struct object_context *orc); 986 987typedefinteach_abbrev_fn(const unsigned char*sha1,void*); 988externintfor_each_abbrev(const char*prefix, each_abbrev_fn,void*); 989 990/* 991 * Try to read a SHA1 in hexadecimal format from the 40 characters 992 * starting at hex. Write the 20-byte result to sha1 in binary form. 993 * Return 0 on success. Reading stops if a NUL is encountered in the 994 * input, so it is safe to pass this function an arbitrary 995 * null-terminated string. 996 */ 997externintget_sha1_hex(const char*hex,unsigned char*sha1); 998externintget_oid_hex(const char*hex,struct object_id *sha1); 9991000externchar*sha1_to_hex(const unsigned char*sha1);/* static buffer result! */1001externchar*oid_to_hex(const struct object_id *oid);/* same static buffer as sha1_to_hex */1002externintread_ref_full(const char*refname,int resolve_flags,1003unsigned char*sha1,int*flags);1004externintread_ref(const char*refname,unsigned char*sha1);10051006/*1007 * Resolve a reference, recursively following symbolic refererences.1008 *1009 * Store the referred-to object's name in sha1 and return the name of1010 * the non-symbolic reference that ultimately pointed at it. The1011 * return value, if not NULL, is a pointer into either a static buffer1012 * or the input ref.1013 *1014 * If the reference cannot be resolved to an object, the behavior1015 * depends on the RESOLVE_REF_READING flag:1016 *1017 * - If RESOLVE_REF_READING is set, return NULL.1018 *1019 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of1020 * the last reference name in the chain, which will either be a non-symbolic1021 * reference or an undefined reference. If this is a prelude to1022 * "writing" to the ref, the return value is the name of the ref1023 * that will actually be created or changed.1024 *1025 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one1026 * level of symbolic reference. The value stored in sha1 for a symbolic1027 * reference will always be null_sha1 in this case, and the return1028 * value is the reference that the symref refers to directly.1029 *1030 * If flags is non-NULL, set the value that it points to the1031 * combination of REF_ISPACKED (if the reference was found among the1032 * packed references), REF_ISSYMREF (if the initial reference was a1033 * symbolic reference), REF_BAD_NAME (if the reference name is ill1034 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN1035 * (if the ref is malformed or has a bad name). See refs.h for more detail1036 * on each flag.1037 *1038 * If ref is not a properly-formatted, normalized reference, return1039 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,1040 * give up and return NULL.1041 *1042 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their1043 * name is invalid according to git-check-ref-format(1). If the name1044 * is bad then the value stored in sha1 will be null_sha1 and the two1045 * flags REF_ISBROKEN and REF_BAD_NAME will be set.1046 *1047 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/1048 * directory and do not consist of all caps and underscores cannot be1049 * resolved. The function returns NULL for such ref names.1050 * Caps and underscores refers to the special refs, such as HEAD,1051 * FETCH_HEAD and friends, that all live outside of the refs/ directory.1052 */1053#define RESOLVE_REF_READING 0x011054#define RESOLVE_REF_NO_RECURSE 0x021055#define RESOLVE_REF_ALLOW_BAD_NAME 0x041056externconst char*resolve_ref_unsafe(const char*ref,int resolve_flags,unsigned char*sha1,int*flags);1057externchar*resolve_refdup(const char*ref,int resolve_flags,unsigned char*sha1,int*flags);10581059externintdwim_ref(const char*str,int len,unsigned char*sha1,char**ref);1060externintdwim_log(const char*str,int len,unsigned char*sha1,char**ref);1061externintinterpret_branch_name(const char*str,int len,struct strbuf *);1062externintget_sha1_mb(const char*str,unsigned char*sha1);10631064/*1065 * Return true iff abbrev_name is a possible abbreviation for1066 * full_name according to the rules defined by ref_rev_parse_rules in1067 * refs.c.1068 */1069externintrefname_match(const char*abbrev_name,const char*full_name);10701071externintcreate_symref(const char*ref,const char*refs_heads_master,const char*logmsg);1072externintvalidate_headref(const char*ref);10731074externintbase_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1075externintdf_name_compare(const char*name1,int len1,int mode1,const char*name2,int len2,int mode2);1076externintname_compare(const char*name1,size_t len1,const char*name2,size_t len2);1077externintcache_name_stage_compare(const char*name1,int len1,int stage1,const char*name2,int len2,int stage2);10781079externvoid*read_object_with_reference(const unsigned char*sha1,1080const char*required_type,1081unsigned long*size,1082unsigned char*sha1_ret);10831084externstruct object *peel_to_type(const char*name,int namelen,1085struct object *o,enum object_type);10861087enum date_mode {1088 DATE_NORMAL =0,1089 DATE_RELATIVE,1090 DATE_SHORT,1091 DATE_LOCAL,1092 DATE_ISO8601,1093 DATE_ISO8601_STRICT,1094 DATE_RFC2822,1095 DATE_RAW1096};10971098const char*show_date(unsigned long time,int timezone,enum date_mode mode);1099voidshow_date_relative(unsigned long time,int tz,const struct timeval *now,1100struct strbuf *timebuf);1101intparse_date(const char*date,struct strbuf *out);1102intparse_date_basic(const char*date,unsigned long*timestamp,int*offset);1103intparse_expiry_date(const char*date,unsigned long*timestamp);1104voiddatestamp(struct strbuf *out);1105#define approxidate(s) approxidate_careful((s), NULL)1106unsigned longapproxidate_careful(const char*,int*);1107unsigned longapproxidate_relative(const char*date,const struct timeval *now);1108enum date_mode parse_date_format(const char*format);1109intdate_overflows(unsigned long date);11101111#define IDENT_STRICT 11112#define IDENT_NO_DATE 21113#define IDENT_NO_NAME 41114externconst char*git_author_info(int);1115externconst char*git_committer_info(int);1116externconst char*fmt_ident(const char*name,const char*email,const char*date_str,int);1117externconst char*fmt_name(const char*name,const char*email);1118externconst char*ident_default_name(void);1119externconst char*ident_default_email(void);1120externconst char*git_editor(void);1121externconst char*git_pager(int stdout_is_tty);1122externintgit_ident_config(const char*,const char*,void*);11231124struct ident_split {1125const char*name_begin;1126const char*name_end;1127const char*mail_begin;1128const char*mail_end;1129const char*date_begin;1130const char*date_end;1131const char*tz_begin;1132const char*tz_end;1133};1134/*1135 * Signals an success with 0, but time part of the result may be NULL1136 * if the input lacks timestamp and zone1137 */1138externintsplit_ident_line(struct ident_split *,const char*,int);11391140/*1141 * Like show_date, but pull the timestamp and tz parameters from1142 * the ident_split. It will also sanity-check the values and produce1143 * a well-known sentinel date if they appear bogus.1144 */1145const char*show_ident_date(const struct ident_split *id,enum date_mode mode);11461147/*1148 * Compare split idents for equality or strict ordering. Note that we1149 * compare only the ident part of the line, ignoring any timestamp.1150 *1151 * Because there are two fields, we must choose one as the primary key; we1152 * currently arbitrarily pick the email.1153 */1154externintident_cmp(const struct ident_split *,const struct ident_split *);11551156struct checkout {1157struct index_state *istate;1158const char*base_dir;1159int base_dir_len;1160unsigned force:1,1161 quiet:1,1162 not_new:1,1163 refresh_cache:1;1164};11651166#define TEMPORARY_FILENAME_LENGTH 251167externintcheckout_entry(struct cache_entry *ce,const struct checkout *state,char*topath);11681169struct cache_def {1170struct strbuf path;1171int flags;1172int track_flags;1173int prefix_len_stat_func;1174};1175#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1176staticinlinevoidcache_def_clear(struct cache_def *cache)1177{1178strbuf_release(&cache->path);1179}11801181externinthas_symlink_leading_path(const char*name,int len);1182externintthreaded_has_symlink_leading_path(struct cache_def *,const char*,int);1183externintcheck_leading_path(const char*name,int len);1184externinthas_dirs_only_path(const char*name,int len,int prefix_len);1185externvoidschedule_dir_for_removal(const char*name,int len);1186externvoidremove_scheduled_dirs(void);11871188externstruct alternate_object_database {1189struct alternate_object_database *next;1190char*name;1191char base[FLEX_ARRAY];/* more */1192} *alt_odb_list;1193externvoidprepare_alt_odb(void);1194externvoidread_info_alternates(const char* relative_base,int depth);1195externvoidadd_to_alternates_file(const char*reference);1196typedefintalt_odb_fn(struct alternate_object_database *,void*);1197externintforeach_alt_odb(alt_odb_fn,void*);11981199struct pack_window {1200struct pack_window *next;1201unsigned char*base;1202 off_t offset;1203size_t len;1204unsigned int last_used;1205unsigned int inuse_cnt;1206};12071208externstruct packed_git {1209struct packed_git *next;1210struct pack_window *windows;1211 off_t pack_size;1212const void*index_data;1213size_t index_size;1214uint32_t num_objects;1215uint32_t num_bad_objects;1216unsigned char*bad_object_sha1;1217int index_version;1218time_t mtime;1219int pack_fd;1220unsigned pack_local:1,1221 pack_keep:1,1222 freshened:1,1223 do_not_close:1;1224unsigned char sha1[20];1225/* something like ".git/objects/pack/xxxxx.pack" */1226char pack_name[FLEX_ARRAY];/* more */1227} *packed_git;12281229struct pack_entry {1230 off_t offset;1231unsigned char sha1[20];1232struct packed_git *p;1233};12341235externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path);12361237/* A hook for count-objects to report invalid files in pack directory */1238externvoid(*report_garbage)(const char*desc,const char*path);12391240externvoidprepare_packed_git(void);1241externvoidreprepare_packed_git(void);1242externvoidinstall_packed_git(struct packed_git *pack);12431244externstruct packed_git *find_sha1_pack(const unsigned char*sha1,1245struct packed_git *packs);12461247externvoidpack_report(void);12481249/*1250 * mmap the index file for the specified packfile (if it is not1251 * already mmapped). Return 0 on success.1252 */1253externintopen_pack_index(struct packed_git *);12541255/*1256 * munmap the index file for the specified packfile (if it is1257 * currently mmapped).1258 */1259externvoidclose_pack_index(struct packed_git *);12601261externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*);1262externvoidclose_pack_windows(struct packed_git *);1263externvoidunuse_pack(struct pack_window **);1264externvoidfree_pack_by_name(const char*);1265externvoidclear_delta_base_cache(void);1266externstruct packed_git *add_packed_git(const char*,int,int);12671268/*1269 * Return the SHA-1 of the nth object within the specified packfile.1270 * Open the index if it is not already open. The return value points1271 * at the SHA-1 within the mmapped index. Return NULL if there is an1272 * error.1273 */1274externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n);12751276/*1277 * Return the offset of the nth object within the specified packfile.1278 * The index must already be opened.1279 */1280extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n);12811282/*1283 * If the object named sha1 is present in the specified packfile,1284 * return its offset within the packfile; otherwise, return 0.1285 */1286extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *);12871288externintis_pack_valid(struct packed_git *);1289externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*);1290externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep);1291externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t);1292externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*);12931294/*1295 * Iterate over the files in the loose-object parts of the object1296 * directory "path", triggering the following callbacks:1297 *1298 * - loose_object is called for each loose object we find.1299 *1300 * - loose_cruft is called for any files that do not appear to be1301 * loose objects. Note that we only look in the loose object1302 * directories "objects/[0-9a-f]{2}/", so we will not report1303 * "objects/foobar" as cruft.1304 *1305 * - loose_subdir is called for each top-level hashed subdirectory1306 * of the object directory (e.g., "$OBJDIR/f0"). It is called1307 * after the objects in the directory are processed.1308 *1309 * Any callback that is NULL will be ignored. Callbacks returning non-zero1310 * will end the iteration.1311 *1312 * In the "buf" variant, "path" is a strbuf which will also be used as a1313 * scratch buffer, but restored to its original contents before1314 * the function returns.1315 */1316typedefinteach_loose_object_fn(const unsigned char*sha1,1317const char*path,1318void*data);1319typedefinteach_loose_cruft_fn(const char*basename,1320const char*path,1321void*data);1322typedefinteach_loose_subdir_fn(int nr,1323const char*path,1324void*data);1325intfor_each_loose_file_in_objdir(const char*path,1326 each_loose_object_fn obj_cb,1327 each_loose_cruft_fn cruft_cb,1328 each_loose_subdir_fn subdir_cb,1329void*data);1330intfor_each_loose_file_in_objdir_buf(struct strbuf *path,1331 each_loose_object_fn obj_cb,1332 each_loose_cruft_fn cruft_cb,1333 each_loose_subdir_fn subdir_cb,1334void*data);13351336/*1337 * Iterate over loose and packed objects in both the local1338 * repository and any alternates repositories (unless the1339 * LOCAL_ONLY flag is set).1340 */1341#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11342typedefinteach_packed_object_fn(const unsigned char*sha1,1343struct packed_git *pack,1344uint32_t pos,1345void*data);1346externintfor_each_loose_object(each_loose_object_fn,void*,unsigned flags);1347externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags);13481349struct object_info {1350/* Request */1351enum object_type *typep;1352unsigned long*sizep;1353unsigned long*disk_sizep;1354unsigned char*delta_base_sha1;1355struct strbuf *typename;13561357/* Response */1358enum{1359 OI_CACHED,1360 OI_LOOSE,1361 OI_PACKED,1362 OI_DBCACHED1363} whence;1364union{1365/*1366 * struct {1367 * ... Nothing to expose in this case1368 * } cached;1369 * struct {1370 * ... Nothing to expose in this case1371 * } loose;1372 */1373struct{1374struct packed_git *pack;1375 off_t offset;1376unsigned int is_delta;1377} packed;1378} u;1379};1380externintsha1_object_info_extended(const unsigned char*,struct object_info *,unsigned flags);13811382/* Dumb servers support */1383externintupdate_server_info(int);13841385/* git_config_parse_key() returns these negated: */1386#define CONFIG_INVALID_KEY 11387#define CONFIG_NO_SECTION_OR_NAME 21388/* git_config_set(), git_config_set_multivar() return the above or these: */1389#define CONFIG_NO_LOCK -11390#define CONFIG_INVALID_FILE 31391#define CONFIG_NO_WRITE 41392#define CONFIG_NOTHING_SET 51393#define CONFIG_INVALID_PATTERN 61394#define CONFIG_GENERIC_ERROR 713951396#define CONFIG_REGEX_NONE ((void *)1)13971398struct git_config_source {1399unsigned int use_stdin:1;1400const char*file;1401const char*blob;1402};14031404typedefint(*config_fn_t)(const char*,const char*,void*);1405externintgit_default_config(const char*,const char*,void*);1406externintgit_config_from_file(config_fn_t fn,const char*,void*);1407externintgit_config_from_buf(config_fn_t fn,const char*name,1408const char*buf,size_t len,void*data);1409externvoidgit_config_push_parameter(const char*text);1410externintgit_config_from_parameters(config_fn_t fn,void*data);1411externvoidgit_config(config_fn_t fn,void*);1412externintgit_config_with_options(config_fn_t fn,void*,1413struct git_config_source *config_source,1414int respect_includes);1415externintgit_config_early(config_fn_t fn,void*,const char*repo_config);1416externintgit_parse_ulong(const char*,unsigned long*);1417externintgit_config_int(const char*,const char*);1418externint64_tgit_config_int64(const char*,const char*);1419externunsigned longgit_config_ulong(const char*,const char*);1420externintgit_config_bool_or_int(const char*,const char*,int*);1421externintgit_config_bool(const char*,const char*);1422externintgit_config_maybe_bool(const char*,const char*);1423externintgit_config_string(const char**,const char*,const char*);1424externintgit_config_pathname(const char**,const char*,const char*);1425externintgit_config_set_in_file(const char*,const char*,const char*);1426externintgit_config_set(const char*,const char*);1427externintgit_config_parse_key(const char*,char**,int*);1428externintgit_config_set_multivar(const char*,const char*,const char*,int);1429externintgit_config_set_multivar_in_file(const char*,const char*,const char*,const char*,int);1430externintgit_config_rename_section(const char*,const char*);1431externintgit_config_rename_section_in_file(const char*,const char*,const char*);1432externconst char*git_etc_gitconfig(void);1433externintcheck_repository_format_version(const char*var,const char*value,void*cb);1434externintgit_env_bool(const char*,int);1435externunsigned longgit_env_ulong(const char*,unsigned long);1436externintgit_config_system(void);1437externintconfig_error_nonbool(const char*);1438#if defined(__GNUC__)1439#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1440#endif1441externconst char*get_log_output_encoding(void);1442externconst char*get_commit_output_encoding(void);14431444externintgit_config_parse_parameter(const char*, config_fn_t fn,void*data);14451446struct config_include_data {1447int depth;1448 config_fn_t fn;1449void*data;1450};1451#define CONFIG_INCLUDE_INIT { 0 }1452externintgit_config_include(const char*name,const char*value,void*data);14531454/*1455 * Match and parse a config key of the form:1456 *1457 * section.(subsection.)?key1458 *1459 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1460 * we return -1 if it does not match, 0 otherwise. The subsection and key1461 * out-parameters are filled by the function (and subsection is NULL if it is1462 * missing).1463 */1464externintparse_config_key(const char*var,1465const char*section,1466const char**subsection,int*subsection_len,1467const char**key);14681469struct config_set_element {1470struct hashmap_entry ent;1471char*key;1472struct string_list value_list;1473};14741475struct configset_list_item {1476struct config_set_element *e;1477int value_index;1478};14791480/*1481 * the contents of the list are ordered according to their1482 * position in the config files and order of parsing the files.1483 * (i.e. key-value pair at the last position of .git/config will1484 * be at the last item of the list)1485 */1486struct configset_list {1487struct configset_list_item *items;1488unsigned int nr, alloc;1489};14901491struct config_set {1492struct hashmap config_hash;1493int hash_initialized;1494struct configset_list list;1495};14961497externvoidgit_configset_init(struct config_set *cs);1498externintgit_configset_add_file(struct config_set *cs,const char*filename);1499externintgit_configset_get_value(struct config_set *cs,const char*key,const char**value);1500externconst struct string_list *git_configset_get_value_multi(struct config_set *cs,const char*key);1501externvoidgit_configset_clear(struct config_set *cs);1502externintgit_configset_get_string_const(struct config_set *cs,const char*key,const char**dest);1503externintgit_configset_get_string(struct config_set *cs,const char*key,char**dest);1504externintgit_configset_get_int(struct config_set *cs,const char*key,int*dest);1505externintgit_configset_get_ulong(struct config_set *cs,const char*key,unsigned long*dest);1506externintgit_configset_get_bool(struct config_set *cs,const char*key,int*dest);1507externintgit_configset_get_bool_or_int(struct config_set *cs,const char*key,int*is_bool,int*dest);1508externintgit_configset_get_maybe_bool(struct config_set *cs,const char*key,int*dest);1509externintgit_configset_get_pathname(struct config_set *cs,const char*key,const char**dest);15101511externintgit_config_get_value(const char*key,const char**value);1512externconst struct string_list *git_config_get_value_multi(const char*key);1513externvoidgit_config_clear(void);1514externvoidgit_config_iter(config_fn_t fn,void*data);1515externintgit_config_get_string_const(const char*key,const char**dest);1516externintgit_config_get_string(const char*key,char**dest);1517externintgit_config_get_int(const char*key,int*dest);1518externintgit_config_get_ulong(const char*key,unsigned long*dest);1519externintgit_config_get_bool(const char*key,int*dest);1520externintgit_config_get_bool_or_int(const char*key,int*is_bool,int*dest);1521externintgit_config_get_maybe_bool(const char*key,int*dest);1522externintgit_config_get_pathname(const char*key,const char**dest);15231524struct key_value_info {1525const char*filename;1526int linenr;1527};15281529extern NORETURN voidgit_die_config(const char*key,const char*err, ...)__attribute__((format(printf,2,3)));1530extern NORETURN voidgit_die_config_linenr(const char*key,const char*filename,int linenr);15311532externintcommitter_ident_sufficiently_given(void);1533externintauthor_ident_sufficiently_given(void);15341535externconst char*git_commit_encoding;1536externconst char*git_log_output_encoding;1537externconst char*git_mailmap_file;1538externconst char*git_mailmap_blob;15391540/* IO helper functions */1541externvoidmaybe_flush_or_die(FILE*,const char*);1542__attribute__((format(printf,2,3)))1543externvoidfprintf_or_die(FILE*,const char*fmt, ...);1544externintcopy_fd(int ifd,int ofd);1545externintcopy_file(const char*dst,const char*src,int mode);1546externintcopy_file_with_time(const char*dst,const char*src,int mode);1547externvoidwrite_or_die(int fd,const void*buf,size_t count);1548externintwrite_or_whine(int fd,const void*buf,size_t count,const char*msg);1549externintwrite_or_whine_pipe(int fd,const void*buf,size_t count,const char*msg);1550externvoidfsync_or_die(int fd,const char*);15511552extern ssize_t read_in_full(int fd,void*buf,size_t count);1553extern ssize_t write_in_full(int fd,const void*buf,size_t count);1554extern ssize_t pread_in_full(int fd,void*buf,size_t count, off_t offset);15551556staticinline ssize_t write_str_in_full(int fd,const char*str)1557{1558returnwrite_in_full(fd, str,strlen(str));1559}1560__attribute__((format(printf,3,4)))1561externintwrite_file(const char*path,int fatal,const char*fmt, ...);15621563/* pager.c */1564externvoidsetup_pager(void);1565externconst char*pager_program;1566externintpager_in_use(void);1567externint pager_use_color;1568externintterm_columns(void);1569externintdecimal_width(uintmax_t);1570externintcheck_pager_config(const char*cmd);15711572externconst char*editor_program;1573externconst char*askpass_program;1574externconst char*excludes_file;15751576/* base85 */1577intdecode_85(char*dst,const char*line,int linelen);1578voidencode_85(char*buf,const unsigned char*data,int bytes);15791580/* alloc.c */1581externvoid*alloc_blob_node(void);1582externvoid*alloc_tree_node(void);1583externvoid*alloc_commit_node(void);1584externvoid*alloc_tag_node(void);1585externvoid*alloc_object_node(void);1586externvoidalloc_report(void);1587externunsigned intalloc_commit_index(void);15881589/* pkt-line.c */1590voidpacket_trace_identity(const char*prog);15911592/* add */1593/*1594 * return 0 if success, 1 - if addition of a file failed and1595 * ADD_FILES_IGNORE_ERRORS was specified in flags1596 */1597intadd_files_to_cache(const char*prefix,const struct pathspec *pathspec,int flags);15981599/* diff.c */1600externint diff_auto_refresh_index;16011602/* match-trees.c */1603voidshift_tree(const unsigned char*,const unsigned char*,unsigned char*,int);1604voidshift_tree_by(const unsigned char*,const unsigned char*,unsigned char*,const char*);16051606/*1607 * whitespace rules.1608 * used by both diff and apply1609 * last two digits are tab width1610 */1611#define WS_BLANK_AT_EOL 01001612#define WS_SPACE_BEFORE_TAB 02001613#define WS_INDENT_WITH_NON_TAB 04001614#define WS_CR_AT_EOL 010001615#define WS_BLANK_AT_EOF 020001616#define WS_TAB_IN_INDENT 040001617#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1618#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1619#define WS_TAB_WIDTH_MASK 0771620externunsigned whitespace_rule_cfg;1621externunsignedwhitespace_rule(const char*);1622externunsignedparse_whitespace_rule(const char*);1623externunsignedws_check(const char*line,int len,unsigned ws_rule);1624externvoidws_check_emit(const char*line,int len,unsigned ws_rule,FILE*stream,const char*set,const char*reset,const char*ws);1625externchar*whitespace_error_string(unsigned ws);1626externvoidws_fix_copy(struct strbuf *,const char*,int,unsigned,int*);1627externintws_blank_line(const char*line,int len,unsigned ws_rule);1628#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)16291630/* ls-files */1631voidoverlay_tree_on_cache(const char*tree_name,const char*prefix);16321633char*alias_lookup(const char*alias);1634intsplit_cmdline(char*cmdline,const char***argv);1635/* Takes a negative value returned by split_cmdline */1636const char*split_cmdline_strerror(int cmdline_errno);16371638/* git.c */1639struct startup_info {1640int have_repository;1641const char*prefix;1642};1643externstruct startup_info *startup_info;16441645/* merge.c */1646struct commit_list;1647inttry_merge_command(const char*strategy,size_t xopts_nr,1648const char**xopts,struct commit_list *common,1649const char*head_arg,struct commit_list *remotes);1650intcheckout_fast_forward(const unsigned char*from,1651const unsigned char*to,1652int overwrite_ignore);165316541655intsane_execvp(const char*file,char*const argv[]);16561657/*1658 * A struct to encapsulate the concept of whether a file has changed1659 * since we last checked it. This uses criteria similar to those used1660 * for the index.1661 */1662struct stat_validity {1663struct stat_data *sd;1664};16651666voidstat_validity_clear(struct stat_validity *sv);16671668/*1669 * Returns 1 if the path is a regular file (or a symlink to a regular1670 * file) and matches the saved stat_validity, 0 otherwise. A missing1671 * or inaccessible file is considered a match if the struct was just1672 * initialized, or if the previous update found an inaccessible file.1673 */1674intstat_validity_check(struct stat_validity *sv,const char*path);16751676/*1677 * Update the stat_validity from a file opened at descriptor fd. If1678 * the file is missing, inaccessible, or not a regular file, then1679 * future calls to stat_validity_check will match iff one of those1680 * conditions continues to be true.1681 */1682voidstat_validity_update(struct stat_validity *sv,int fd);16831684intversioncmp(const char*s1,const char*s2);16851686#endif/* CACHE_H */