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> 22typedef struct git_zstream { 23 z_stream z; 24 unsigned long avail_in; 25 unsigned long avail_out; 26 unsigned long total_in; 27 unsigned long total_out; 28 unsigned char *next_in; 29 unsigned char *next_out; 30} git_zstream; 31 32void git_inflate_init(git_zstream *); 33void git_inflate_init_gzip_only(git_zstream *); 34void git_inflate_end(git_zstream *); 35int git_inflate(git_zstream *, int flush); 36 37void git_deflate_init(git_zstream *, int level); 38void git_deflate_init_gzip(git_zstream *, int level); 39void git_deflate_init_raw(git_zstream *, int level); 40void git_deflate_end(git_zstream *); 41int git_deflate_abort(git_zstream *); 42int git_deflate_end_gently(git_zstream *); 43int git_deflate(git_zstream *, int flush); 44unsigned long git_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 { 51 unsigned 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 { 122 uint32_t hdr_signature; 123 uint32_t hdr_version; 124 uint32_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 { 136 uint32_t sec; 137 uint32_t nsec; 138}; 139 140struct stat_data { 141 struct cache_time sd_ctime; 142 struct cache_time sd_mtime; 143 unsigned int sd_dev; 144 unsigned int sd_ino; 145 unsigned int sd_uid; 146 unsigned int sd_gid; 147 unsigned int sd_size; 148}; 149 150struct cache_entry { 151 struct hashmap_entry ent; 152 struct stat_data ce_stat_data; 153 unsigned int ce_mode; 154 unsigned int ce_flags; 155 unsigned int ce_namelen; 156 unsigned int index; /* for link extension */ 157 unsigned char sha1[20]; 158 char 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 */ 219static inline void copy_cache_entry(struct cache_entry *dst, 220 const struct cache_entry *src) 221{ 222 unsigned int state = dst->ce_flags & CE_HASHED; 223 224 /* Don't copy hash chain and name */ 225 memcpy(&dst->ce_stat_data, &src->ce_stat_data, 226 offsetof(struct cache_entry, name) - 227 offsetof(struct cache_entry, ce_stat_data)); 228 229 /* Restore the hash state */ 230 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 231} 232 233static inline unsigned create_ce_flags(unsigned stage) 234{ 235 return (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) 246static inline unsigned int create_ce_mode(unsigned int mode) 247{ 248 if (S_ISLNK(mode)) 249 return S_IFLNK; 250 if (S_ISDIR(mode) || S_ISGITLINK(mode)) 251 return S_IFGITLINK; 252 return S_IFREG | ce_permissions(mode); 253} 254static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce, 255 unsigned int mode) 256{ 257 extern int trust_executable_bit, has_symlinks; 258 if (!has_symlinks && S_ISREG(mode) && 259 ce && S_ISLNK(ce->ce_mode)) 260 return ce->ce_mode; 261 if (!trust_executable_bit && S_ISREG(mode)) { 262 if (ce && S_ISREG(ce->ce_mode)) 263 return ce->ce_mode; 264 return create_ce_mode(0666); 265 } 266 return create_ce_mode(mode); 267} 268static inline int ce_to_dtype(const struct cache_entry *ce) 269{ 270 unsigned ce_mode = ntohl(ce->ce_mode); 271 if (S_ISREG(ce_mode)) 272 return DT_REG; 273 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode)) 274 return DT_DIR; 275 else if (S_ISLNK(ce_mode)) 276 return DT_LNK; 277 else 278 return DT_UNKNOWN; 279} 280static inline unsigned int canon_mode(unsigned int mode) 281{ 282 if (S_ISREG(mode)) 283 return S_IFREG | ce_permissions(mode); 284 if (S_ISLNK(mode)) 285 return S_IFLNK; 286 if (S_ISDIR(mode)) 287 return S_IFDIR; 288 return 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#define UNTRACKED_CHANGED (1 << 7) 301 302struct split_index; 303struct untracked_cache; 304 305struct index_state { 306 struct cache_entry **cache; 307 unsigned int version; 308 unsigned int cache_nr, cache_alloc, cache_changed; 309 struct string_list *resolve_undo; 310 struct cache_tree *cache_tree; 311 struct split_index *split_index; 312 struct cache_time timestamp; 313 unsigned name_hash_initialized : 1, 314 initialized : 1; 315 struct hashmap name_hash; 316 struct hashmap dir_hash; 317 unsigned char sha1[20]; 318 struct untracked_cache *untracked; 319}; 320 321extern struct index_state the_index; 322 323/* Name hashing */ 324extern void add_name_hash(struct index_state *istate, struct cache_entry *ce); 325extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce); 326extern void free_name_hash(struct index_state *istate); 327 328 329#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 330#define active_cache (the_index.cache) 331#define active_nr (the_index.cache_nr) 332#define active_alloc (the_index.cache_alloc) 333#define active_cache_changed (the_index.cache_changed) 334#define active_cache_tree (the_index.cache_tree) 335 336#define read_cache() read_index(&the_index) 337#define read_cache_from(path) read_index_from(&the_index, (path)) 338#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 339#define is_cache_unborn() is_index_unborn(&the_index) 340#define read_cache_unmerged() read_index_unmerged(&the_index) 341#define discard_cache() discard_index(&the_index) 342#define unmerged_cache() unmerged_index(&the_index) 343#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 344#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 345#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 346#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 347#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 348#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 349#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 350#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 351#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 352#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 353#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 354#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 355#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 356#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 357#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 358#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 359#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 360#endif 361 362enum object_type { 363 OBJ_BAD = -1, 364 OBJ_NONE = 0, 365 OBJ_COMMIT = 1, 366 OBJ_TREE = 2, 367 OBJ_BLOB = 3, 368 OBJ_TAG = 4, 369 /* 5 for future expansion */ 370 OBJ_OFS_DELTA = 6, 371 OBJ_REF_DELTA = 7, 372 OBJ_ANY, 373 OBJ_MAX 374}; 375 376static inline enum object_type object_type(unsigned int mode) 377{ 378 return S_ISDIR(mode) ? OBJ_TREE : 379 S_ISGITLINK(mode) ? OBJ_COMMIT : 380 OBJ_BLOB; 381} 382 383/* Double-check local_repo_env below if you add to this list. */ 384#define GIT_DIR_ENVIRONMENT "GIT_DIR" 385#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR" 386#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE" 387#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE" 388#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX" 389#define DEFAULT_GIT_DIR_ENVIRONMENT ".git" 390#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY" 391#define INDEX_ENVIRONMENT "GIT_INDEX_FILE" 392#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE" 393#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE" 394#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" 395#define CONFIG_ENVIRONMENT "GIT_CONFIG" 396#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS" 397#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH" 398#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES" 399#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS" 400#define GITATTRIBUTES_FILE ".gitattributes" 401#define INFOATTRIBUTES_FILE "info/attributes" 402#define ATTRIBUTE_MACRO_PREFIX "[attr]" 403#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF" 404#define GIT_NOTES_DEFAULT_REF "refs/notes/commits" 405#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF" 406#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF" 407#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE" 408#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS" 409#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS" 410#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS" 411#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS" 412 413/* 414 * This environment variable is expected to contain a boolean indicating 415 * whether we should or should not treat: 416 * 417 * GIT_DIR=foo.git git ... 418 * 419 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 420 * of this, but we use it internally to communicate to sub-processes that we 421 * are in a bare repo. If not set, defaults to true. 422 */ 423#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE" 424 425/* 426 * Repository-local GIT_* environment variables; these will be cleared 427 * when git spawns a sub-process that runs inside another repository. 428 * The array is NULL-terminated, which makes it easy to pass in the "env" 429 * parameter of a run-command invocation, or to do a simple walk. 430 */ 431extern const char * const local_repo_env[]; 432 433extern int is_bare_repository_cfg; 434extern int is_bare_repository(void); 435extern int is_inside_git_dir(void); 436extern char *git_work_tree_cfg; 437extern int is_inside_work_tree(void); 438extern const char *get_git_dir(void); 439extern const char *get_git_common_dir(void); 440extern int is_git_directory(const char *path); 441extern char *get_object_directory(void); 442extern char *get_index_file(void); 443extern char *get_graft_file(void); 444extern int set_git_dir(const char *path); 445extern int get_common_dir(struct strbuf *sb, const char *gitdir); 446extern const char *get_git_namespace(void); 447extern const char *strip_namespace(const char *namespaced_ref); 448extern const char *get_git_work_tree(void); 449extern const char *read_gitfile(const char *path); 450extern const char *resolve_gitdir(const char *suspect); 451extern void set_git_work_tree(const char *tree); 452 453#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES" 454 455extern const char **get_pathspec(const char *prefix, const char **pathspec); 456extern void setup_work_tree(void); 457extern const char *setup_git_directory_gently(int *); 458extern const char *setup_git_directory(void); 459extern char *prefix_path(const char *prefix, int len, const char *path); 460extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path); 461extern const char *prefix_filename(const char *prefix, int len, const char *path); 462extern int check_filename(const char *prefix, const char *name); 463extern void verify_filename(const char *prefix, 464 const char *name, 465 int diagnose_misspelt_rev); 466extern void verify_non_filename(const char *prefix, const char *name); 467extern int path_inside_repo(const char *prefix, const char *path); 468 469#define INIT_DB_QUIET 0x0001 470 471extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int); 472extern int init_db(const char *template_dir, unsigned int flags); 473 474extern void sanitize_stdfds(void); 475extern int daemonize(void); 476 477#define alloc_nr(x) (((x)+16)*3/2) 478 479/* 480 * Realloc the buffer pointed at by variable 'x' so that it can hold 481 * at least 'nr' entries; the number of entries currently allocated 482 * is 'alloc', using the standard growing factor alloc_nr() macro. 483 * 484 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 485 */ 486#define ALLOC_GROW(x, nr, alloc) \ 487 do { \ 488 if ((nr) > alloc) { \ 489 if (alloc_nr(alloc) < (nr)) \ 490 alloc = (nr); \ 491 else \ 492 alloc = alloc_nr(alloc); \ 493 REALLOC_ARRAY(x, alloc); \ 494 } \ 495 } while (0) 496 497/* Initialize and use the cache information */ 498struct lock_file; 499extern int read_index(struct index_state *); 500extern int read_index_preload(struct index_state *, const struct pathspec *pathspec); 501extern int do_read_index(struct index_state *istate, const char *path, 502 int must_exist); /* for testting only! */ 503extern int read_index_from(struct index_state *, const char *path); 504extern int is_index_unborn(struct index_state *); 505extern int read_index_unmerged(struct index_state *); 506#define COMMIT_LOCK (1 << 0) 507#define CLOSE_LOCK (1 << 1) 508extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags); 509extern int discard_index(struct index_state *); 510extern int unmerged_index(const struct index_state *); 511extern int verify_path(const char *path); 512extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen); 513extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase); 514extern int index_name_pos(const struct index_state *, const char *name, int namelen); 515#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */ 516#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */ 517#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */ 518#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */ 519#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */ 520#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */ 521extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option); 522extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name); 523extern int remove_index_entry_at(struct index_state *, int pos); 524extern void remove_marked_cache_entries(struct index_state *istate); 525extern int remove_file_from_index(struct index_state *, const char *path); 526#define ADD_CACHE_VERBOSE 1 527#define ADD_CACHE_PRETEND 2 528#define ADD_CACHE_IGNORE_ERRORS 4 529#define ADD_CACHE_IGNORE_REMOVAL 8 530#define ADD_CACHE_INTENT 16 531extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags); 532extern int add_file_to_index(struct index_state *, const char *path, int flags); 533extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options); 534extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b); 535extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce); 536extern int index_name_is_other(const struct index_state *, const char *, int); 537extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *); 538 539/* do stat comparison even if CE_VALID is true */ 540#define CE_MATCH_IGNORE_VALID 01 541/* do not check the contents but report dirty on racily-clean entries */ 542#define CE_MATCH_RACY_IS_DIRTY 02 543/* do stat comparison even if CE_SKIP_WORKTREE is true */ 544#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 545/* ignore non-existent files during stat update */ 546#define CE_MATCH_IGNORE_MISSING 0x08 547/* enable stat refresh */ 548#define CE_MATCH_REFRESH 0x10 549extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 550extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 551 552#define HASH_WRITE_OBJECT 1 553#define HASH_FORMAT_CHECK 2 554extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags); 555extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags); 556 557/* 558 * Record to sd the data from st that we use to check whether a file 559 * might have changed. 560 */ 561extern void fill_stat_data(struct stat_data *sd, struct stat *st); 562 563/* 564 * Return 0 if st is consistent with a file not having been changed 565 * since sd was filled. If there are differences, return a 566 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 567 * INODE_CHANGED, and DATA_CHANGED. 568 */ 569extern int match_stat_data(const struct stat_data *sd, struct stat *st); 570extern int match_stat_data_racy(const struct index_state *istate, 571 const struct stat_data *sd, struct stat *st); 572 573extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st); 574 575#define REFRESH_REALLY 0x0001 /* ignore_valid */ 576#define REFRESH_UNMERGED 0x0002 /* allow unmerged */ 577#define REFRESH_QUIET 0x0004 /* be quiet about it */ 578#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */ 579#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */ 580#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */ 581extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg); 582 583extern void update_index_if_able(struct index_state *, struct lock_file *); 584 585extern int hold_locked_index(struct lock_file *, int); 586extern void set_alternate_index_output(const char *); 587 588extern int delete_ref(const char *, const unsigned char *sha1, unsigned int flags); 589 590/* Environment bits from configuration mechanism */ 591extern int trust_executable_bit; 592extern int trust_ctime; 593extern int check_stat; 594extern int quote_path_fully; 595extern int has_symlinks; 596extern int minimum_abbrev, default_abbrev; 597extern int ignore_case; 598extern int assume_unchanged; 599extern int prefer_symlink_refs; 600extern int log_all_ref_updates; 601extern int warn_ambiguous_refs; 602extern int warn_on_object_refname_ambiguity; 603extern int shared_repository; 604extern const char *apply_default_whitespace; 605extern const char *apply_default_ignorewhitespace; 606extern const char *git_attributes_file; 607extern int zlib_compression_level; 608extern int core_compression_level; 609extern int core_compression_seen; 610extern size_t packed_git_window_size; 611extern size_t packed_git_limit; 612extern size_t delta_base_cache_limit; 613extern unsigned long big_file_threshold; 614extern unsigned long pack_size_limit_cfg; 615 616/* 617 * Do replace refs need to be checked this run? This variable is 618 * initialized to true unless --no-replace-object is used or 619 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 620 * commands that do not want replace references to be active. As an 621 * optimization it is also set to false if replace references have 622 * been sought but there were none. 623 */ 624extern int check_replace_refs; 625 626extern int fsync_object_files; 627extern int core_preload_index; 628extern int core_apply_sparse_checkout; 629extern int precomposed_unicode; 630extern int protect_hfs; 631extern int protect_ntfs; 632extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env; 633 634/* 635 * Include broken refs in all ref iterations, which will 636 * generally choke dangerous operations rather than letting 637 * them silently proceed without taking the broken ref into 638 * account. 639 */ 640extern int ref_paranoia; 641 642/* 643 * The character that begins a commented line in user-editable file 644 * that is subject to stripspace. 645 */ 646extern char comment_line_char; 647extern int auto_comment_line_char; 648 649enum branch_track { 650 BRANCH_TRACK_UNSPECIFIED = -1, 651 BRANCH_TRACK_NEVER = 0, 652 BRANCH_TRACK_REMOTE, 653 BRANCH_TRACK_ALWAYS, 654 BRANCH_TRACK_EXPLICIT, 655 BRANCH_TRACK_OVERRIDE 656}; 657 658enum rebase_setup_type { 659 AUTOREBASE_NEVER = 0, 660 AUTOREBASE_LOCAL, 661 AUTOREBASE_REMOTE, 662 AUTOREBASE_ALWAYS 663}; 664 665enum push_default_type { 666 PUSH_DEFAULT_NOTHING = 0, 667 PUSH_DEFAULT_MATCHING, 668 PUSH_DEFAULT_SIMPLE, 669 PUSH_DEFAULT_UPSTREAM, 670 PUSH_DEFAULT_CURRENT, 671 PUSH_DEFAULT_UNSPECIFIED 672}; 673 674extern enum branch_track git_branch_track; 675extern enum rebase_setup_type autorebase; 676extern enum push_default_type push_default; 677 678enum object_creation_mode { 679 OBJECT_CREATION_USES_HARDLINKS = 0, 680 OBJECT_CREATION_USES_RENAMES = 1 681}; 682 683extern enum object_creation_mode object_creation_mode; 684 685extern char *notes_ref_name; 686 687extern int grafts_replace_parents; 688 689#define GIT_REPO_VERSION 0 690extern int repository_format_version; 691extern int check_repository_format(void); 692 693#define MTIME_CHANGED 0x0001 694#define CTIME_CHANGED 0x0002 695#define OWNER_CHANGED 0x0004 696#define MODE_CHANGED 0x0008 697#define INODE_CHANGED 0x0010 698#define DATA_CHANGED 0x0020 699#define TYPE_CHANGED 0x0040 700 701extern char *mksnpath(char *buf, size_t n, const char *fmt, ...) 702 __attribute__((format (printf, 3, 4))); 703extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...) 704 __attribute__((format (printf, 2, 3))); 705extern char *git_pathdup(const char *fmt, ...) 706 __attribute__((format (printf, 1, 2))); 707extern char *mkpathdup(const char *fmt, ...) 708 __attribute__((format (printf, 1, 2))); 709 710/* Return a statically allocated filename matching the sha1 signature */ 711extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 712extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 713extern const char *git_path_submodule(const char *path, const char *fmt, ...) 714 __attribute__((format (printf, 2, 3))); 715extern void report_linked_checkout_garbage(void); 716 717/* 718 * Return the name of the file in the local object database that would 719 * be used to store a loose object with the specified sha1. The 720 * return value is a pointer to a statically allocated buffer that is 721 * overwritten each time the function is called. 722 */ 723extern const char *sha1_file_name(const unsigned char *sha1); 724 725/* 726 * Return the name of the (local) packfile with the specified sha1 in 727 * its name. The return value is a pointer to memory that is 728 * overwritten each time this function is called. 729 */ 730extern char *sha1_pack_name(const unsigned char *sha1); 731 732/* 733 * Return the name of the (local) pack index file with the specified 734 * sha1 in its name. The return value is a pointer to memory that is 735 * overwritten each time this function is called. 736 */ 737extern char *sha1_pack_index_name(const unsigned char *sha1); 738 739extern const char *find_unique_abbrev(const unsigned char *sha1, int); 740extern const unsigned char null_sha1[GIT_SHA1_RAWSZ]; 741 742static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2) 743{ 744 int i; 745 746 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 747 if (*sha1 != *sha2) 748 return *sha1 - *sha2; 749 } 750 751 return 0; 752} 753 754static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2) 755{ 756 return hashcmp(oid1->hash, oid2->hash); 757} 758 759static inline int is_null_sha1(const unsigned char *sha1) 760{ 761 return !hashcmp(sha1, null_sha1); 762} 763 764static inline int is_null_oid(const struct object_id *oid) 765{ 766 return !hashcmp(oid->hash, null_sha1); 767} 768 769static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src) 770{ 771 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 772} 773 774static inline void oidcpy(struct object_id *dst, const struct object_id *src) 775{ 776 hashcpy(dst->hash, src->hash); 777} 778 779static inline void hashclr(unsigned char *hash) 780{ 781 memset(hash, 0, GIT_SHA1_RAWSZ); 782} 783 784static inline void oidclr(struct object_id *oid) 785{ 786 hashclr(oid->hash); 787} 788 789 790#define EMPTY_TREE_SHA1_HEX \ 791 "4b825dc642cb6eb9a060e54bf8d69288fbee4904" 792#define EMPTY_TREE_SHA1_BIN_LITERAL \ 793 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \ 794 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04" 795#define EMPTY_TREE_SHA1_BIN \ 796 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL) 797 798#define EMPTY_BLOB_SHA1_HEX \ 799 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391" 800#define EMPTY_BLOB_SHA1_BIN_LITERAL \ 801 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \ 802 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91" 803#define EMPTY_BLOB_SHA1_BIN \ 804 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL) 805 806static inline int is_empty_blob_sha1(const unsigned char *sha1) 807{ 808 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN); 809} 810 811int git_mkstemp(char *path, size_t n, const char *template); 812 813int git_mkstemps(char *path, size_t n, const char *template, int suffix_len); 814 815/* set default permissions by passing mode arguments to open(2) */ 816int git_mkstemps_mode(char *pattern, int suffix_len, int mode); 817int git_mkstemp_mode(char *pattern, int mode); 818 819/* 820 * NOTE NOTE NOTE!! 821 * 822 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must 823 * not be changed. Old repositories have core.sharedrepository written in 824 * numeric format, and therefore these values are preserved for compatibility 825 * reasons. 826 */ 827enum sharedrepo { 828 PERM_UMASK = 0, 829 OLD_PERM_GROUP = 1, 830 OLD_PERM_EVERYBODY = 2, 831 PERM_GROUP = 0660, 832 PERM_EVERYBODY = 0664 833}; 834int git_config_perm(const char *var, const char *value); 835int adjust_shared_perm(const char *path); 836 837/* 838 * Create the directory containing the named path, using care to be 839 * somewhat safe against races. Return one of the scld_error values 840 * to indicate success/failure. 841 * 842 * SCLD_VANISHED indicates that one of the ancestor directories of the 843 * path existed at one point during the function call and then 844 * suddenly vanished, probably because another process pruned the 845 * directory while we were working. To be robust against this kind of 846 * race, callers might want to try invoking the function again when it 847 * returns SCLD_VANISHED. 848 */ 849enum scld_error { 850 SCLD_OK = 0, 851 SCLD_FAILED = -1, 852 SCLD_PERMS = -2, 853 SCLD_EXISTS = -3, 854 SCLD_VANISHED = -4 855}; 856enum scld_error safe_create_leading_directories(char *path); 857enum scld_error safe_create_leading_directories_const(const char *path); 858 859int mkdir_in_gitdir(const char *path); 860extern char *expand_user_path(const char *path); 861const char *enter_repo(const char *path, int strict); 862static inline int is_absolute_path(const char *path) 863{ 864 return is_dir_sep(path[0]) || has_dos_drive_prefix(path); 865} 866int is_directory(const char *); 867const char *real_path(const char *path); 868const char *real_path_if_valid(const char *path); 869const char *absolute_path(const char *path); 870const char *remove_leading_path(const char *in, const char *prefix); 871const char *relative_path(const char *in, const char *prefix, struct strbuf *sb); 872int normalize_path_copy_len(char *dst, const char *src, int *prefix_len); 873int normalize_path_copy(char *dst, const char *src); 874int longest_ancestor_length(const char *path, struct string_list *prefixes); 875char *strip_path_suffix(const char *path, const char *suffix); 876int daemon_avoid_alias(const char *path); 877extern int is_ntfs_dotgit(const char *name); 878 879/** 880 * Return a newly allocated string with the evaluation of 881 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise 882 * "$HOME/.config/git/$filename". Return NULL upon error. 883 */ 884extern char *xdg_config_home(const char *filename); 885 886/* object replacement */ 887#define LOOKUP_REPLACE_OBJECT 1 888#define LOOKUP_UNKNOWN_OBJECT 2 889extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag); 890static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size) 891{ 892 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT); 893} 894 895/* 896 * This internal function is only declared here for the benefit of 897 * lookup_replace_object(). Please do not call it directly. 898 */ 899extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1); 900 901/* 902 * If object sha1 should be replaced, return the replacement object's 903 * name (replaced recursively, if necessary). The return value is 904 * either sha1 or a pointer to a permanently-allocated value. When 905 * object replacement is suppressed, always return sha1. 906 */ 907static inline const unsigned char *lookup_replace_object(const unsigned char *sha1) 908{ 909 if (!check_replace_refs) 910 return sha1; 911 return do_lookup_replace_object(sha1); 912} 913 914static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag) 915{ 916 if (!(flag & LOOKUP_REPLACE_OBJECT)) 917 return sha1; 918 return lookup_replace_object(sha1); 919} 920 921/* Read and unpack a sha1 file into memory, write memory to a sha1 file */ 922extern int sha1_object_info(const unsigned char *, unsigned long *); 923extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1); 924extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1); 925extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags); 926extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *); 927extern int force_object_loose(const unsigned char *sha1, time_t mtime); 928extern int git_open_noatime(const char *name); 929extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size); 930extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz); 931extern int parse_sha1_header(const char *hdr, unsigned long *sizep); 932 933/* global flag to enable extra checks when accessing packed objects */ 934extern int do_check_packed_object_crc; 935 936extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type); 937 938extern int move_temp_to_file(const char *tmpfile, const char *filename); 939 940extern int has_sha1_pack(const unsigned char *sha1); 941 942/* 943 * Return true iff we have an object named sha1, whether local or in 944 * an alternate object database, and whether packed or loose. This 945 * function does not respect replace references. 946 * 947 * If the QUICK flag is set, do not re-check the pack directory 948 * when we cannot find the object (this means we may give a false 949 * negative answer if another process is simultaneously repacking). 950 */ 951#define HAS_SHA1_QUICK 0x1 952extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags); 953static inline int has_sha1_file(const unsigned char *sha1) 954{ 955 return has_sha1_file_with_flags(sha1, 0); 956} 957 958/* 959 * Return true iff an alternate object database has a loose object 960 * with the specified name. This function does not respect replace 961 * references. 962 */ 963extern int has_loose_object_nonlocal(const unsigned char *sha1); 964 965extern int has_pack_index(const unsigned char *sha1); 966 967extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect); 968 969extern const signed char hexval_table[256]; 970static inline unsigned int hexval(unsigned char c) 971{ 972 return hexval_table[c]; 973} 974 975/* Convert to/from hex/sha1 representation */ 976#define MINIMUM_ABBREV minimum_abbrev 977#define DEFAULT_ABBREV default_abbrev 978 979struct object_context { 980 unsigned char tree[20]; 981 char path[PATH_MAX]; 982 unsigned mode; 983 /* 984 * symlink_path is only used by get_tree_entry_follow_symlinks, 985 * and only for symlinks that point outside the repository. 986 */ 987 struct strbuf symlink_path; 988}; 989 990#define GET_SHA1_QUIETLY 01 991#define GET_SHA1_COMMIT 02 992#define GET_SHA1_COMMITTISH 04 993#define GET_SHA1_TREE 010 994#define GET_SHA1_TREEISH 020 995#define GET_SHA1_BLOB 040 996#define GET_SHA1_FOLLOW_SYMLINKS 0100 997#define GET_SHA1_ONLY_TO_DIE 04000 998 999extern int get_sha1(const char *str, unsigned char *sha1);1000extern int get_sha1_commit(const char *str, unsigned char *sha1);1001extern int get_sha1_committish(const char *str, unsigned char *sha1);1002extern int get_sha1_tree(const char *str, unsigned char *sha1);1003extern int get_sha1_treeish(const char *str, unsigned char *sha1);1004extern int get_sha1_blob(const char *str, unsigned char *sha1);1005extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);1006extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);10071008typedef int each_abbrev_fn(const unsigned char *sha1, void *);1009extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);10101011/*1012 * Try to read a SHA1 in hexadecimal format from the 40 characters1013 * starting at hex. Write the 20-byte result to sha1 in binary form.1014 * Return 0 on success. Reading stops if a NUL is encountered in the1015 * input, so it is safe to pass this function an arbitrary1016 * null-terminated string.1017 */1018extern int get_sha1_hex(const char *hex, unsigned char *sha1);1019extern int get_oid_hex(const char *hex, struct object_id *sha1);10201021extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */1022extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */1023extern int read_ref_full(const char *refname, int resolve_flags,1024 unsigned char *sha1, int *flags);1025extern int read_ref(const char *refname, unsigned char *sha1);10261027/*1028 * Resolve a reference, recursively following symbolic refererences.1029 *1030 * Store the referred-to object's name in sha1 and return the name of1031 * the non-symbolic reference that ultimately pointed at it. The1032 * return value, if not NULL, is a pointer into either a static buffer1033 * or the input ref.1034 *1035 * If the reference cannot be resolved to an object, the behavior1036 * depends on the RESOLVE_REF_READING flag:1037 *1038 * - If RESOLVE_REF_READING is set, return NULL.1039 *1040 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of1041 * the last reference name in the chain, which will either be a non-symbolic1042 * reference or an undefined reference. If this is a prelude to1043 * "writing" to the ref, the return value is the name of the ref1044 * that will actually be created or changed.1045 *1046 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one1047 * level of symbolic reference. The value stored in sha1 for a symbolic1048 * reference will always be null_sha1 in this case, and the return1049 * value is the reference that the symref refers to directly.1050 *1051 * If flags is non-NULL, set the value that it points to the1052 * combination of REF_ISPACKED (if the reference was found among the1053 * packed references), REF_ISSYMREF (if the initial reference was a1054 * symbolic reference), REF_BAD_NAME (if the reference name is ill1055 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN1056 * (if the ref is malformed or has a bad name). See refs.h for more detail1057 * on each flag.1058 *1059 * If ref is not a properly-formatted, normalized reference, return1060 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,1061 * give up and return NULL.1062 *1063 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their1064 * name is invalid according to git-check-ref-format(1). If the name1065 * is bad then the value stored in sha1 will be null_sha1 and the two1066 * flags REF_ISBROKEN and REF_BAD_NAME will be set.1067 *1068 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/1069 * directory and do not consist of all caps and underscores cannot be1070 * resolved. The function returns NULL for such ref names.1071 * Caps and underscores refers to the special refs, such as HEAD,1072 * FETCH_HEAD and friends, that all live outside of the refs/ directory.1073 */1074#define RESOLVE_REF_READING 0x011075#define RESOLVE_REF_NO_RECURSE 0x021076#define RESOLVE_REF_ALLOW_BAD_NAME 0x041077extern const char *resolve_ref_unsafe(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);1078extern char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);10791080extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);1081extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);1082extern int interpret_branch_name(const char *str, int len, struct strbuf *);1083extern int get_sha1_mb(const char *str, unsigned char *sha1);10841085/*1086 * Return true iff abbrev_name is a possible abbreviation for1087 * full_name according to the rules defined by ref_rev_parse_rules in1088 * refs.c.1089 */1090extern int refname_match(const char *abbrev_name, const char *full_name);10911092extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);1093extern int validate_headref(const char *ref);10941095extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1096extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1097extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);1098extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);10991100extern void *read_object_with_reference(const unsigned char *sha1,1101 const char *required_type,1102 unsigned long *size,1103 unsigned char *sha1_ret);11041105extern struct object *peel_to_type(const char *name, int namelen,1106 struct object *o, enum object_type);11071108enum date_mode {1109 DATE_NORMAL = 0,1110 DATE_RELATIVE,1111 DATE_SHORT,1112 DATE_LOCAL,1113 DATE_ISO8601,1114 DATE_ISO8601_STRICT,1115 DATE_RFC2822,1116 DATE_RAW1117};11181119const char *show_date(unsigned long time, int timezone, enum date_mode mode);1120void show_date_relative(unsigned long time, int tz, const struct timeval *now,1121 struct strbuf *timebuf);1122int parse_date(const char *date, struct strbuf *out);1123int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);1124int parse_expiry_date(const char *date, unsigned long *timestamp);1125void datestamp(struct strbuf *out);1126#define approxidate(s) approxidate_careful((s), NULL)1127unsigned long approxidate_careful(const char *, int *);1128unsigned long approxidate_relative(const char *date, const struct timeval *now);1129enum date_mode parse_date_format(const char *format);1130int date_overflows(unsigned long date);11311132#define IDENT_STRICT 11133#define IDENT_NO_DATE 21134#define IDENT_NO_NAME 41135extern const char *git_author_info(int);1136extern const char *git_committer_info(int);1137extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);1138extern const char *fmt_name(const char *name, const char *email);1139extern const char *ident_default_name(void);1140extern const char *ident_default_email(void);1141extern const char *git_editor(void);1142extern const char *git_pager(int stdout_is_tty);1143extern int git_ident_config(const char *, const char *, void *);11441145struct ident_split {1146 const char *name_begin;1147 const char *name_end;1148 const char *mail_begin;1149 const char *mail_end;1150 const char *date_begin;1151 const char *date_end;1152 const char *tz_begin;1153 const char *tz_end;1154};1155/*1156 * Signals an success with 0, but time part of the result may be NULL1157 * if the input lacks timestamp and zone1158 */1159extern int split_ident_line(struct ident_split *, const char *, int);11601161/*1162 * Like show_date, but pull the timestamp and tz parameters from1163 * the ident_split. It will also sanity-check the values and produce1164 * a well-known sentinel date if they appear bogus.1165 */1166const char *show_ident_date(const struct ident_split *id, enum date_mode mode);11671168/*1169 * Compare split idents for equality or strict ordering. Note that we1170 * compare only the ident part of the line, ignoring any timestamp.1171 *1172 * Because there are two fields, we must choose one as the primary key; we1173 * currently arbitrarily pick the email.1174 */1175extern int ident_cmp(const struct ident_split *, const struct ident_split *);11761177struct checkout {1178 struct index_state *istate;1179 const char *base_dir;1180 int base_dir_len;1181 unsigned force:1,1182 quiet:1,1183 not_new:1,1184 refresh_cache:1;1185};11861187#define TEMPORARY_FILENAME_LENGTH 251188extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);11891190struct cache_def {1191 struct strbuf path;1192 int flags;1193 int track_flags;1194 int prefix_len_stat_func;1195};1196#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1197static inline void cache_def_clear(struct cache_def *cache)1198{1199 strbuf_release(&cache->path);1200}12011202extern int has_symlink_leading_path(const char *name, int len);1203extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);1204extern int check_leading_path(const char *name, int len);1205extern int has_dirs_only_path(const char *name, int len, int prefix_len);1206extern void schedule_dir_for_removal(const char *name, int len);1207extern void remove_scheduled_dirs(void);12081209extern struct alternate_object_database {1210 struct alternate_object_database *next;1211 char *name;1212 char base[FLEX_ARRAY]; /* more */1213} *alt_odb_list;1214extern void prepare_alt_odb(void);1215extern void read_info_alternates(const char * relative_base, int depth);1216extern void add_to_alternates_file(const char *reference);1217typedef int alt_odb_fn(struct alternate_object_database *, void *);1218extern int foreach_alt_odb(alt_odb_fn, void*);12191220struct pack_window {1221 struct pack_window *next;1222 unsigned char *base;1223 off_t offset;1224 size_t len;1225 unsigned int last_used;1226 unsigned int inuse_cnt;1227};12281229extern struct packed_git {1230 struct packed_git *next;1231 struct pack_window *windows;1232 off_t pack_size;1233 const void *index_data;1234 size_t index_size;1235 uint32_t num_objects;1236 uint32_t num_bad_objects;1237 unsigned char *bad_object_sha1;1238 int index_version;1239 time_t mtime;1240 int pack_fd;1241 unsigned pack_local:1,1242 pack_keep:1,1243 freshened:1,1244 do_not_close:1;1245 unsigned char sha1[20];1246 /* something like ".git/objects/pack/xxxxx.pack" */1247 char pack_name[FLEX_ARRAY]; /* more */1248} *packed_git;12491250struct pack_entry {1251 off_t offset;1252 unsigned char sha1[20];1253 struct packed_git *p;1254};12551256extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);12571258/* A hook for count-objects to report invalid files in pack directory */1259extern void (*report_garbage)(const char *desc, const char *path);12601261extern void prepare_packed_git(void);1262extern void reprepare_packed_git(void);1263extern void install_packed_git(struct packed_git *pack);12641265extern struct packed_git *find_sha1_pack(const unsigned char *sha1,1266 struct packed_git *packs);12671268extern void pack_report(void);12691270/*1271 * mmap the index file for the specified packfile (if it is not1272 * already mmapped). Return 0 on success.1273 */1274extern int open_pack_index(struct packed_git *);12751276/*1277 * munmap the index file for the specified packfile (if it is1278 * currently mmapped).1279 */1280extern void close_pack_index(struct packed_git *);12811282extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);1283extern void close_pack_windows(struct packed_git *);1284extern void unuse_pack(struct pack_window **);1285extern void free_pack_by_name(const char *);1286extern void clear_delta_base_cache(void);1287extern struct packed_git *add_packed_git(const char *, int, int);12881289/*1290 * Return the SHA-1 of the nth object within the specified packfile.1291 * Open the index if it is not already open. The return value points1292 * at the SHA-1 within the mmapped index. Return NULL if there is an1293 * error.1294 */1295extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);12961297/*1298 * Return the offset of the nth object within the specified packfile.1299 * The index must already be opened.1300 */1301extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);13021303/*1304 * If the object named sha1 is present in the specified packfile,1305 * return its offset within the packfile; otherwise, return 0.1306 */1307extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);13081309extern int is_pack_valid(struct packed_git *);1310extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);1311extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);1312extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);1313extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);13141315/*1316 * Iterate over the files in the loose-object parts of the object1317 * directory "path", triggering the following callbacks:1318 *1319 * - loose_object is called for each loose object we find.1320 *1321 * - loose_cruft is called for any files that do not appear to be1322 * loose objects. Note that we only look in the loose object1323 * directories "objects/[0-9a-f]{2}/", so we will not report1324 * "objects/foobar" as cruft.1325 *1326 * - loose_subdir is called for each top-level hashed subdirectory1327 * of the object directory (e.g., "$OBJDIR/f0"). It is called1328 * after the objects in the directory are processed.1329 *1330 * Any callback that is NULL will be ignored. Callbacks returning non-zero1331 * will end the iteration.1332 *1333 * In the "buf" variant, "path" is a strbuf which will also be used as a1334 * scratch buffer, but restored to its original contents before1335 * the function returns.1336 */1337typedef int each_loose_object_fn(const unsigned char *sha1,1338 const char *path,1339 void *data);1340typedef int each_loose_cruft_fn(const char *basename,1341 const char *path,1342 void *data);1343typedef int each_loose_subdir_fn(int nr,1344 const char *path,1345 void *data);1346int for_each_loose_file_in_objdir(const char *path,1347 each_loose_object_fn obj_cb,1348 each_loose_cruft_fn cruft_cb,1349 each_loose_subdir_fn subdir_cb,1350 void *data);1351int for_each_loose_file_in_objdir_buf(struct strbuf *path,1352 each_loose_object_fn obj_cb,1353 each_loose_cruft_fn cruft_cb,1354 each_loose_subdir_fn subdir_cb,1355 void *data);13561357/*1358 * Iterate over loose and packed objects in both the local1359 * repository and any alternates repositories (unless the1360 * LOCAL_ONLY flag is set).1361 */1362#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11363typedef int each_packed_object_fn(const unsigned char *sha1,1364 struct packed_git *pack,1365 uint32_t pos,1366 void *data);1367extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);1368extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);13691370struct object_info {1371 /* Request */1372 enum object_type *typep;1373 unsigned long *sizep;1374 unsigned long *disk_sizep;1375 unsigned char *delta_base_sha1;1376 struct strbuf *typename;13771378 /* Response */1379 enum {1380 OI_CACHED,1381 OI_LOOSE,1382 OI_PACKED,1383 OI_DBCACHED1384 } whence;1385 union {1386 /*1387 * struct {1388 * ... Nothing to expose in this case1389 * } cached;1390 * struct {1391 * ... Nothing to expose in this case1392 * } loose;1393 */1394 struct {1395 struct packed_git *pack;1396 off_t offset;1397 unsigned int is_delta;1398 } packed;1399 } u;1400};1401extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);14021403/* Dumb servers support */1404extern int update_server_info(int);14051406/* git_config_parse_key() returns these negated: */1407#define CONFIG_INVALID_KEY 11408#define CONFIG_NO_SECTION_OR_NAME 21409/* git_config_set(), git_config_set_multivar() return the above or these: */1410#define CONFIG_NO_LOCK -11411#define CONFIG_INVALID_FILE 31412#define CONFIG_NO_WRITE 41413#define CONFIG_NOTHING_SET 51414#define CONFIG_INVALID_PATTERN 61415#define CONFIG_GENERIC_ERROR 714161417#define CONFIG_REGEX_NONE ((void *)1)14181419struct git_config_source {1420 unsigned int use_stdin:1;1421 const char *file;1422 const char *blob;1423};14241425typedef int (*config_fn_t)(const char *, const char *, void *);1426extern int git_default_config(const char *, const char *, void *);1427extern int git_config_from_file(config_fn_t fn, const char *, void *);1428extern int git_config_from_buf(config_fn_t fn, const char *name,1429 const char *buf, size_t len, void *data);1430extern void git_config_push_parameter(const char *text);1431extern int git_config_from_parameters(config_fn_t fn, void *data);1432extern void git_config(config_fn_t fn, void *);1433extern int git_config_with_options(config_fn_t fn, void *,1434 struct git_config_source *config_source,1435 int respect_includes);1436extern int git_config_early(config_fn_t fn, void *, const char *repo_config);1437extern int git_parse_ulong(const char *, unsigned long *);1438extern int git_config_int(const char *, const char *);1439extern int64_t git_config_int64(const char *, const char *);1440extern unsigned long git_config_ulong(const char *, const char *);1441extern int git_config_bool_or_int(const char *, const char *, int *);1442extern int git_config_bool(const char *, const char *);1443extern int git_config_maybe_bool(const char *, const char *);1444extern int git_config_string(const char **, const char *, const char *);1445extern int git_config_pathname(const char **, const char *, const char *);1446extern int git_config_set_in_file(const char *, const char *, const char *);1447extern int git_config_set(const char *, const char *);1448extern int git_config_parse_key(const char *, char **, int *);1449extern int git_config_set_multivar(const char *, const char *, const char *, int);1450extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);1451extern int git_config_rename_section(const char *, const char *);1452extern int git_config_rename_section_in_file(const char *, const char *, const char *);1453extern const char *git_etc_gitconfig(void);1454extern int check_repository_format_version(const char *var, const char *value, void *cb);1455extern int git_env_bool(const char *, int);1456extern unsigned long git_env_ulong(const char *, unsigned long);1457extern int git_config_system(void);1458extern int config_error_nonbool(const char *);1459#if defined(__GNUC__)1460#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1461#endif1462extern const char *get_log_output_encoding(void);1463extern const char *get_commit_output_encoding(void);14641465extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);14661467struct config_include_data {1468 int depth;1469 config_fn_t fn;1470 void *data;1471};1472#define CONFIG_INCLUDE_INIT { 0 }1473extern int git_config_include(const char *name, const char *value, void *data);14741475/*1476 * Match and parse a config key of the form:1477 *1478 * section.(subsection.)?key1479 *1480 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1481 * we return -1 if it does not match, 0 otherwise. The subsection and key1482 * out-parameters are filled by the function (and subsection is NULL if it is1483 * missing).1484 */1485extern int parse_config_key(const char *var,1486 const char *section,1487 const char **subsection, int *subsection_len,1488 const char **key);14891490struct config_set_element {1491 struct hashmap_entry ent;1492 char *key;1493 struct string_list value_list;1494};14951496struct configset_list_item {1497 struct config_set_element *e;1498 int value_index;1499};15001501/*1502 * the contents of the list are ordered according to their1503 * position in the config files and order of parsing the files.1504 * (i.e. key-value pair at the last position of .git/config will1505 * be at the last item of the list)1506 */1507struct configset_list {1508 struct configset_list_item *items;1509 unsigned int nr, alloc;1510};15111512struct config_set {1513 struct hashmap config_hash;1514 int hash_initialized;1515 struct configset_list list;1516};15171518extern void git_configset_init(struct config_set *cs);1519extern int git_configset_add_file(struct config_set *cs, const char *filename);1520extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);1521extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);1522extern void git_configset_clear(struct config_set *cs);1523extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);1524extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);1525extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);1526extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);1527extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);1528extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);1529extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);1530extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);15311532extern int git_config_get_value(const char *key, const char **value);1533extern const struct string_list *git_config_get_value_multi(const char *key);1534extern void git_config_clear(void);1535extern void git_config_iter(config_fn_t fn, void *data);1536extern int git_config_get_string_const(const char *key, const char **dest);1537extern int git_config_get_string(const char *key, char **dest);1538extern int git_config_get_int(const char *key, int *dest);1539extern int git_config_get_ulong(const char *key, unsigned long *dest);1540extern int git_config_get_bool(const char *key, int *dest);1541extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);1542extern int git_config_get_maybe_bool(const char *key, int *dest);1543extern int git_config_get_pathname(const char *key, const char **dest);15441545struct key_value_info {1546 const char *filename;1547 int linenr;1548};15491550extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));1551extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);15521553extern int committer_ident_sufficiently_given(void);1554extern int author_ident_sufficiently_given(void);15551556extern const char *git_commit_encoding;1557extern const char *git_log_output_encoding;1558extern const char *git_mailmap_file;1559extern const char *git_mailmap_blob;15601561/* IO helper functions */1562extern void maybe_flush_or_die(FILE *, const char *);1563__attribute__((format (printf, 2, 3)))1564extern void fprintf_or_die(FILE *, const char *fmt, ...);15651566#define COPY_READ_ERROR (-2)1567#define COPY_WRITE_ERROR (-3)1568extern int copy_fd(int ifd, int ofd);1569extern int copy_file(const char *dst, const char *src, int mode);1570extern int copy_file_with_time(const char *dst, const char *src, int mode);15711572extern void write_or_die(int fd, const void *buf, size_t count);1573extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);1574extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);1575extern void fsync_or_die(int fd, const char *);15761577extern ssize_t read_in_full(int fd, void *buf, size_t count);1578extern ssize_t write_in_full(int fd, const void *buf, size_t count);1579extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);15801581static inline ssize_t write_str_in_full(int fd, const char *str)1582{1583 return write_in_full(fd, str, strlen(str));1584}1585__attribute__((format (printf, 3, 4)))1586extern int write_file(const char *path, int fatal, const char *fmt, ...);15871588/* pager.c */1589extern void setup_pager(void);1590extern const char *pager_program;1591extern int pager_in_use(void);1592extern int pager_use_color;1593extern int term_columns(void);1594extern int decimal_width(uintmax_t);1595extern int check_pager_config(const char *cmd);15961597extern const char *editor_program;1598extern const char *askpass_program;1599extern const char *excludes_file;16001601/* base85 */1602int decode_85(char *dst, const char *line, int linelen);1603void encode_85(char *buf, const unsigned char *data, int bytes);16041605/* alloc.c */1606extern void *alloc_blob_node(void);1607extern void *alloc_tree_node(void);1608extern void *alloc_commit_node(void);1609extern void *alloc_tag_node(void);1610extern void *alloc_object_node(void);1611extern void alloc_report(void);1612extern unsigned int alloc_commit_index(void);16131614/* pkt-line.c */1615void packet_trace_identity(const char *prog);16161617/* add */1618/*1619 * return 0 if success, 1 - if addition of a file failed and1620 * ADD_FILES_IGNORE_ERRORS was specified in flags1621 */1622int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);16231624/* diff.c */1625extern int diff_auto_refresh_index;16261627/* match-trees.c */1628void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);1629void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);16301631/*1632 * whitespace rules.1633 * used by both diff and apply1634 * last two digits are tab width1635 */1636#define WS_BLANK_AT_EOL 01001637#define WS_SPACE_BEFORE_TAB 02001638#define WS_INDENT_WITH_NON_TAB 04001639#define WS_CR_AT_EOL 010001640#define WS_BLANK_AT_EOF 020001641#define WS_TAB_IN_INDENT 040001642#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1643#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1644#define WS_TAB_WIDTH_MASK 0771645extern unsigned whitespace_rule_cfg;1646extern unsigned whitespace_rule(const char *);1647extern unsigned parse_whitespace_rule(const char *);1648extern unsigned ws_check(const char *line, int len, unsigned ws_rule);1649extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);1650extern char *whitespace_error_string(unsigned ws);1651extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);1652extern int ws_blank_line(const char *line, int len, unsigned ws_rule);1653#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)16541655/* ls-files */1656void overlay_tree_on_cache(const char *tree_name, const char *prefix);16571658char *alias_lookup(const char *alias);1659int split_cmdline(char *cmdline, const char ***argv);1660/* Takes a negative value returned by split_cmdline */1661const char *split_cmdline_strerror(int cmdline_errno);16621663/* git.c */1664struct startup_info {1665 int have_repository;1666 const char *prefix;1667};1668extern struct startup_info *startup_info;16691670/* merge.c */1671struct commit_list;1672int try_merge_command(const char *strategy, size_t xopts_nr,1673 const char **xopts, struct commit_list *common,1674 const char *head_arg, struct commit_list *remotes);1675int checkout_fast_forward(const unsigned char *from,1676 const unsigned char *to,1677 int overwrite_ignore);167816791680int sane_execvp(const char *file, char *const argv[]);16811682/*1683 * A struct to encapsulate the concept of whether a file has changed1684 * since we last checked it. This uses criteria similar to those used1685 * for the index.1686 */1687struct stat_validity {1688 struct stat_data *sd;1689};16901691void stat_validity_clear(struct stat_validity *sv);16921693/*1694 * Returns 1 if the path is a regular file (or a symlink to a regular1695 * file) and matches the saved stat_validity, 0 otherwise. A missing1696 * or inaccessible file is considered a match if the struct was just1697 * initialized, or if the previous update found an inaccessible file.1698 */1699int stat_validity_check(struct stat_validity *sv, const char *path);17001701/*1702 * Update the stat_validity from a file opened at descriptor fd. If1703 * the file is missing, inaccessible, or not a regular file, then1704 * future calls to stat_validity_check will match iff one of those1705 * conditions continues to be true.1706 */1707void stat_validity_update(struct stat_validity *sv, int fd);17081709int versioncmp(const char *s1, const char *s2);1710void sleep_millisec(int millisec);17111712#endif /* CACHE_H */