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 "list.h" 8#include "advice.h" 9#include "gettext.h" 10#include "convert.h" 11#include "trace.h" 12#include "string-list.h" 13#include "pack-revindex.h" 14#include "hash.h" 15#include "path.h" 16#include "sha1-array.h" 17#include "repository.h" 18 19#include <zlib.h> 20typedef struct git_zstream { 21 z_stream z; 22 unsigned long avail_in; 23 unsigned long avail_out; 24 unsigned long total_in; 25 unsigned long total_out; 26 unsigned char *next_in; 27 unsigned char *next_out; 28} git_zstream; 29 30void git_inflate_init(git_zstream *); 31void git_inflate_init_gzip_only(git_zstream *); 32void git_inflate_end(git_zstream *); 33int git_inflate(git_zstream *, int flush); 34 35void git_deflate_init(git_zstream *, int level); 36void git_deflate_init_gzip(git_zstream *, int level); 37void git_deflate_init_raw(git_zstream *, int level); 38void git_deflate_end(git_zstream *); 39int git_deflate_abort(git_zstream *); 40int git_deflate_end_gently(git_zstream *); 41int git_deflate(git_zstream *, int flush); 42unsigned long git_deflate_bound(git_zstream *, unsigned long); 43 44/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 45#define GIT_SHA1_RAWSZ 20 46#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 47 48/* The length in byte and in hex digits of the largest possible hash value. */ 49#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 50#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 51 52struct object_id { 53 unsigned char hash[GIT_MAX_RAWSZ]; 54}; 55 56#define the_hash_algo the_repository->hash_algo 57 58#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 59#define DTYPE(de) ((de)->d_type) 60#else 61#undef DT_UNKNOWN 62#undef DT_DIR 63#undef DT_REG 64#undef DT_LNK 65#define DT_UNKNOWN 0 66#define DT_DIR 1 67#define DT_REG 2 68#define DT_LNK 3 69#define DTYPE(de) DT_UNKNOWN 70#endif 71 72/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 73#define S_IFINVALID 0030000 74 75/* 76 * A "directory link" is a link to another git directory. 77 * 78 * The value 0160000 is not normally a valid mode, and 79 * also just happens to be S_IFDIR + S_IFLNK 80 */ 81#define S_IFGITLINK 0160000 82#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 83 84/* 85 * Some mode bits are also used internally for computations. 86 * 87 * They *must* not overlap with any valid modes, and they *must* not be emitted 88 * to outside world - i.e. appear on disk or network. In other words, it's just 89 * temporary fields, which we internally use, but they have to stay in-house. 90 * 91 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 92 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 93 */ 94 95/* used internally in tree-diff */ 96#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 97 98 99/* 100 * Intensive research over the course of many years has shown that 101 * port 9418 is totally unused by anything else. Or 102 * 103 * Your search - "port 9418" - did not match any documents. 104 * 105 * as www.google.com puts it. 106 * 107 * This port has been properly assigned for git use by IANA: 108 * git (Assigned-9418) [I06-050728-0001]. 109 * 110 * git 9418/tcp git pack transfer service 111 * git 9418/udp git pack transfer service 112 * 113 * with Linus Torvalds <torvalds@osdl.org> as the point of 114 * contact. September 2005. 115 * 116 * See http://www.iana.org/assignments/port-numbers 117 */ 118#define DEFAULT_GIT_PORT 9418 119 120/* 121 * Basic data structures for the directory cache 122 */ 123 124#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */ 125struct cache_header { 126 uint32_t hdr_signature; 127 uint32_t hdr_version; 128 uint32_t hdr_entries; 129}; 130 131#define INDEX_FORMAT_LB 2 132#define INDEX_FORMAT_UB 4 133 134/* 135 * The "cache_time" is just the low 32 bits of the 136 * time. It doesn't matter if it overflows - we only 137 * check it for equality in the 32 bits we save. 138 */ 139struct cache_time { 140 uint32_t sec; 141 uint32_t nsec; 142}; 143 144struct stat_data { 145 struct cache_time sd_ctime; 146 struct cache_time sd_mtime; 147 unsigned int sd_dev; 148 unsigned int sd_ino; 149 unsigned int sd_uid; 150 unsigned int sd_gid; 151 unsigned int sd_size; 152}; 153 154struct cache_entry { 155 struct hashmap_entry ent; 156 struct stat_data ce_stat_data; 157 unsigned int ce_mode; 158 unsigned int ce_flags; 159 unsigned int ce_namelen; 160 unsigned int index; /* for link extension */ 161 struct object_id oid; 162 char name[FLEX_ARRAY]; /* more */ 163}; 164 165#define CE_STAGEMASK (0x3000) 166#define CE_EXTENDED (0x4000) 167#define CE_VALID (0x8000) 168#define CE_STAGESHIFT 12 169 170/* 171 * Range 0xFFFF0FFF in ce_flags is divided into 172 * two parts: in-memory flags and on-disk ones. 173 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 174 * if you want to save a new flag, add it in 175 * CE_EXTENDED_FLAGS 176 * 177 * In-memory only flags 178 */ 179#define CE_UPDATE (1 << 16) 180#define CE_REMOVE (1 << 17) 181#define CE_UPTODATE (1 << 18) 182#define CE_ADDED (1 << 19) 183 184#define CE_HASHED (1 << 20) 185#define CE_FSMONITOR_VALID (1 << 21) 186#define CE_WT_REMOVE (1 << 22) /* remove in work directory */ 187#define CE_CONFLICTED (1 << 23) 188 189#define CE_UNPACKED (1 << 24) 190#define CE_NEW_SKIP_WORKTREE (1 << 25) 191 192/* used to temporarily mark paths matched by pathspecs */ 193#define CE_MATCHED (1 << 26) 194 195#define CE_UPDATE_IN_BASE (1 << 27) 196#define CE_STRIP_NAME (1 << 28) 197 198/* 199 * Extended on-disk flags 200 */ 201#define CE_INTENT_TO_ADD (1 << 29) 202#define CE_SKIP_WORKTREE (1 << 30) 203/* CE_EXTENDED2 is for future extension */ 204#define CE_EXTENDED2 (1U << 31) 205 206#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 207 208/* 209 * Safeguard to avoid saving wrong flags: 210 * - CE_EXTENDED2 won't get saved until its semantic is known 211 * - Bits in 0x0000FFFF have been saved in ce_flags already 212 * - Bits in 0x003F0000 are currently in-memory flags 213 */ 214#if CE_EXTENDED_FLAGS & 0x803FFFFF 215#error "CE_EXTENDED_FLAGS out of range" 216#endif 217 218/* Forward structure decls */ 219struct pathspec; 220struct child_process; 221 222/* 223 * Copy the sha1 and stat state of a cache entry from one to 224 * another. But we never change the name, or the hash state! 225 */ 226static inline void copy_cache_entry(struct cache_entry *dst, 227 const struct cache_entry *src) 228{ 229 unsigned int state = dst->ce_flags & CE_HASHED; 230 231 /* Don't copy hash chain and name */ 232 memcpy(&dst->ce_stat_data, &src->ce_stat_data, 233 offsetof(struct cache_entry, name) - 234 offsetof(struct cache_entry, ce_stat_data)); 235 236 /* Restore the hash state */ 237 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 238} 239 240static inline unsigned create_ce_flags(unsigned stage) 241{ 242 return (stage << CE_STAGESHIFT); 243} 244 245#define ce_namelen(ce) ((ce)->ce_namelen) 246#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 247#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 248#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 249#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 250#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 251#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 252 253#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 254static inline unsigned int create_ce_mode(unsigned int mode) 255{ 256 if (S_ISLNK(mode)) 257 return S_IFLNK; 258 if (S_ISDIR(mode) || S_ISGITLINK(mode)) 259 return S_IFGITLINK; 260 return S_IFREG | ce_permissions(mode); 261} 262static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce, 263 unsigned int mode) 264{ 265 extern int trust_executable_bit, has_symlinks; 266 if (!has_symlinks && S_ISREG(mode) && 267 ce && S_ISLNK(ce->ce_mode)) 268 return ce->ce_mode; 269 if (!trust_executable_bit && S_ISREG(mode)) { 270 if (ce && S_ISREG(ce->ce_mode)) 271 return ce->ce_mode; 272 return create_ce_mode(0666); 273 } 274 return create_ce_mode(mode); 275} 276static inline int ce_to_dtype(const struct cache_entry *ce) 277{ 278 unsigned ce_mode = ntohl(ce->ce_mode); 279 if (S_ISREG(ce_mode)) 280 return DT_REG; 281 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode)) 282 return DT_DIR; 283 else if (S_ISLNK(ce_mode)) 284 return DT_LNK; 285 else 286 return DT_UNKNOWN; 287} 288static inline unsigned int canon_mode(unsigned int mode) 289{ 290 if (S_ISREG(mode)) 291 return S_IFREG | ce_permissions(mode); 292 if (S_ISLNK(mode)) 293 return S_IFLNK; 294 if (S_ISDIR(mode)) 295 return S_IFDIR; 296 return S_IFGITLINK; 297} 298 299#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 300 301#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */ 302#define CE_ENTRY_CHANGED (1 << 1) 303#define CE_ENTRY_REMOVED (1 << 2) 304#define CE_ENTRY_ADDED (1 << 3) 305#define RESOLVE_UNDO_CHANGED (1 << 4) 306#define CACHE_TREE_CHANGED (1 << 5) 307#define SPLIT_INDEX_ORDERED (1 << 6) 308#define UNTRACKED_CHANGED (1 << 7) 309#define FSMONITOR_CHANGED (1 << 8) 310 311struct split_index; 312struct untracked_cache; 313 314struct index_state { 315 struct cache_entry **cache; 316 unsigned int version; 317 unsigned int cache_nr, cache_alloc, cache_changed; 318 struct string_list *resolve_undo; 319 struct cache_tree *cache_tree; 320 struct split_index *split_index; 321 struct cache_time timestamp; 322 unsigned name_hash_initialized : 1, 323 initialized : 1, 324 drop_cache_tree : 1; 325 struct hashmap name_hash; 326 struct hashmap dir_hash; 327 struct object_id oid; 328 struct untracked_cache *untracked; 329 uint64_t fsmonitor_last_update; 330 struct ewah_bitmap *fsmonitor_dirty; 331}; 332 333extern struct index_state the_index; 334 335/* Name hashing */ 336extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded); 337extern void add_name_hash(struct index_state *istate, struct cache_entry *ce); 338extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce); 339extern void free_name_hash(struct index_state *istate); 340 341 342#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 343#define active_cache (the_index.cache) 344#define active_nr (the_index.cache_nr) 345#define active_alloc (the_index.cache_alloc) 346#define active_cache_changed (the_index.cache_changed) 347#define active_cache_tree (the_index.cache_tree) 348 349#define read_cache() read_index(&the_index) 350#define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir())) 351#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 352#define is_cache_unborn() is_index_unborn(&the_index) 353#define read_cache_unmerged() read_index_unmerged(&the_index) 354#define discard_cache() discard_index(&the_index) 355#define unmerged_cache() unmerged_index(&the_index) 356#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 357#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 358#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 359#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 360#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 361#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 362#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 363#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 364#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 365#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 366#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 367#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 368#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 369#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 370#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 371#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 372#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 373#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 374#endif 375 376#define TYPE_BITS 3 377 378/* 379 * Values in this enum (except those outside the 3 bit range) are part 380 * of pack file format. See Documentation/technical/pack-format.txt 381 * for more information. 382 */ 383enum object_type { 384 OBJ_BAD = -1, 385 OBJ_NONE = 0, 386 OBJ_COMMIT = 1, 387 OBJ_TREE = 2, 388 OBJ_BLOB = 3, 389 OBJ_TAG = 4, 390 /* 5 for future expansion */ 391 OBJ_OFS_DELTA = 6, 392 OBJ_REF_DELTA = 7, 393 OBJ_ANY, 394 OBJ_MAX 395}; 396 397static inline enum object_type object_type(unsigned int mode) 398{ 399 return S_ISDIR(mode) ? OBJ_TREE : 400 S_ISGITLINK(mode) ? OBJ_COMMIT : 401 OBJ_BLOB; 402} 403 404/* Double-check local_repo_env below if you add to this list. */ 405#define GIT_DIR_ENVIRONMENT "GIT_DIR" 406#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR" 407#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE" 408#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE" 409#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX" 410#define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX" 411#define DEFAULT_GIT_DIR_ENVIRONMENT ".git" 412#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY" 413#define INDEX_ENVIRONMENT "GIT_INDEX_FILE" 414#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE" 415#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE" 416#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" 417#define CONFIG_ENVIRONMENT "GIT_CONFIG" 418#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS" 419#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH" 420#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES" 421#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS" 422#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE" 423#define GITATTRIBUTES_FILE ".gitattributes" 424#define INFOATTRIBUTES_FILE "info/attributes" 425#define ATTRIBUTE_MACRO_PREFIX "[attr]" 426#define GITMODULES_FILE ".gitmodules" 427#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF" 428#define GIT_NOTES_DEFAULT_REF "refs/notes/commits" 429#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF" 430#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF" 431#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE" 432#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS" 433#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS" 434#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS" 435#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS" 436#define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH" 437#define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS" 438#define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT "GIT_TEXTDOMAINDIR" 439 440/* 441 * Environment variable used in handshaking the wire protocol. 442 * Contains a colon ':' separated list of keys with optional values 443 * 'key[=value]'. Presence of unknown keys and values must be 444 * ignored. 445 */ 446#define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL" 447/* HTTP header used to handshake the wire protocol */ 448#define GIT_PROTOCOL_HEADER "Git-Protocol" 449 450/* 451 * This environment variable is expected to contain a boolean indicating 452 * whether we should or should not treat: 453 * 454 * GIT_DIR=foo.git git ... 455 * 456 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 457 * of this, but we use it internally to communicate to sub-processes that we 458 * are in a bare repo. If not set, defaults to true. 459 */ 460#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE" 461 462/* 463 * Repository-local GIT_* environment variables; these will be cleared 464 * when git spawns a sub-process that runs inside another repository. 465 * The array is NULL-terminated, which makes it easy to pass in the "env" 466 * parameter of a run-command invocation, or to do a simple walk. 467 */ 468extern const char * const local_repo_env[]; 469 470extern void setup_git_env(const char *git_dir); 471 472/* 473 * Returns true iff we have a configured git repository (either via 474 * setup_git_directory, or in the environment via $GIT_DIR). 475 */ 476int have_git_dir(void); 477 478extern int is_bare_repository_cfg; 479extern int is_bare_repository(void); 480extern int is_inside_git_dir(void); 481extern char *git_work_tree_cfg; 482extern int is_inside_work_tree(void); 483extern const char *get_git_dir(void); 484extern const char *get_git_common_dir(void); 485extern char *get_object_directory(void); 486extern char *get_index_file(void); 487extern char *get_graft_file(struct repository *r); 488extern void set_git_dir(const char *path); 489extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir); 490extern int get_common_dir(struct strbuf *sb, const char *gitdir); 491extern const char *get_git_namespace(void); 492extern const char *strip_namespace(const char *namespaced_ref); 493extern const char *get_super_prefix(void); 494extern const char *get_git_work_tree(void); 495 496/* 497 * Return true if the given path is a git directory; note that this _just_ 498 * looks at the directory itself. If you want to know whether "foo/.git" 499 * is a repository, you must feed that path, not just "foo". 500 */ 501extern int is_git_directory(const char *path); 502 503/* 504 * Return 1 if the given path is the root of a git repository or 505 * submodule, else 0. Will not return 1 for bare repositories with the 506 * exception of creating a bare repository in "foo/.git" and calling 507 * is_git_repository("foo"). 508 * 509 * If we run into read errors, we err on the side of saying "yes, it is", 510 * as we usually consider sub-repos precious, and would prefer to err on the 511 * side of not disrupting or deleting them. 512 */ 513extern int is_nonbare_repository_dir(struct strbuf *path); 514 515#define READ_GITFILE_ERR_STAT_FAILED 1 516#define READ_GITFILE_ERR_NOT_A_FILE 2 517#define READ_GITFILE_ERR_OPEN_FAILED 3 518#define READ_GITFILE_ERR_READ_FAILED 4 519#define READ_GITFILE_ERR_INVALID_FORMAT 5 520#define READ_GITFILE_ERR_NO_PATH 6 521#define READ_GITFILE_ERR_NOT_A_REPO 7 522#define READ_GITFILE_ERR_TOO_LARGE 8 523extern void read_gitfile_error_die(int error_code, const char *path, const char *dir); 524extern const char *read_gitfile_gently(const char *path, int *return_error_code); 525#define read_gitfile(path) read_gitfile_gently((path), NULL) 526extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code); 527#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 528 529extern void set_git_work_tree(const char *tree); 530 531#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES" 532 533extern void setup_work_tree(void); 534/* 535 * Find the commondir and gitdir of the repository that contains the current 536 * working directory, without changing the working directory or other global 537 * state. The result is appended to commondir and gitdir. If the discovered 538 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 539 * both have the same result appended to the buffer. The return value is 540 * either 0 upon success and non-zero if no repository was found. 541 */ 542extern int discover_git_directory(struct strbuf *commondir, 543 struct strbuf *gitdir); 544extern const char *setup_git_directory_gently(int *); 545extern const char *setup_git_directory(void); 546extern char *prefix_path(const char *prefix, int len, const char *path); 547extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path); 548 549/* 550 * Concatenate "prefix" (if len is non-zero) and "path", with no 551 * connecting characters (so "prefix" should end with a "/"). 552 * Unlike prefix_path, this should be used if the named file does 553 * not have to interact with index entry; i.e. name of a random file 554 * on the filesystem. 555 * 556 * The return value is always a newly allocated string (even if the 557 * prefix was empty). 558 */ 559extern char *prefix_filename(const char *prefix, const char *path); 560 561extern int check_filename(const char *prefix, const char *name); 562extern void verify_filename(const char *prefix, 563 const char *name, 564 int diagnose_misspelt_rev); 565extern void verify_non_filename(const char *prefix, const char *name); 566extern int path_inside_repo(const char *prefix, const char *path); 567 568#define INIT_DB_QUIET 0x0001 569#define INIT_DB_EXIST_OK 0x0002 570 571extern int init_db(const char *git_dir, const char *real_git_dir, 572 const char *template_dir, unsigned int flags); 573 574extern void sanitize_stdfds(void); 575extern int daemonize(void); 576 577#define alloc_nr(x) (((x)+16)*3/2) 578 579/* 580 * Realloc the buffer pointed at by variable 'x' so that it can hold 581 * at least 'nr' entries; the number of entries currently allocated 582 * is 'alloc', using the standard growing factor alloc_nr() macro. 583 * 584 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 585 */ 586#define ALLOC_GROW(x, nr, alloc) \ 587 do { \ 588 if ((nr) > alloc) { \ 589 if (alloc_nr(alloc) < (nr)) \ 590 alloc = (nr); \ 591 else \ 592 alloc = alloc_nr(alloc); \ 593 REALLOC_ARRAY(x, alloc); \ 594 } \ 595 } while (0) 596 597/* Initialize and use the cache information */ 598struct lock_file; 599extern int read_index(struct index_state *); 600extern int read_index_preload(struct index_state *, const struct pathspec *pathspec); 601extern int do_read_index(struct index_state *istate, const char *path, 602 int must_exist); /* for testting only! */ 603extern int read_index_from(struct index_state *, const char *path, 604 const char *gitdir); 605extern int is_index_unborn(struct index_state *); 606extern int read_index_unmerged(struct index_state *); 607 608/* For use with `write_locked_index()`. */ 609#define COMMIT_LOCK (1 << 0) 610#define SKIP_IF_UNCHANGED (1 << 1) 611 612/* 613 * Write the index while holding an already-taken lock. Close the lock, 614 * and if `COMMIT_LOCK` is given, commit it. 615 * 616 * Unless a split index is in use, write the index into the lockfile. 617 * 618 * With a split index, write the shared index to a temporary file, 619 * adjust its permissions and rename it into place, then write the 620 * split index to the lockfile. If the temporary file for the shared 621 * index cannot be created, fall back to the behavior described in 622 * the previous paragraph. 623 * 624 * With `COMMIT_LOCK`, the lock is always committed or rolled back. 625 * Without it, the lock is closed, but neither committed nor rolled 626 * back. 627 * 628 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing 629 * is written (and the lock is rolled back if `COMMIT_LOCK` is given). 630 */ 631extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags); 632 633extern int discard_index(struct index_state *); 634extern void move_index_extensions(struct index_state *dst, struct index_state *src); 635extern int unmerged_index(const struct index_state *); 636 637/** 638 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn 639 * branch, returns 1 if there are entries in the index, 0 otherwise. If an 640 * strbuf is provided, the space-separated list of files that differ will be 641 * appended to it. 642 */ 643extern int index_has_changes(struct strbuf *sb); 644 645extern int verify_path(const char *path, unsigned mode); 646extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change); 647extern int index_dir_exists(struct index_state *istate, const char *name, int namelen); 648extern void adjust_dirname_case(struct index_state *istate, char *name); 649extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase); 650 651/* 652 * Searches for an entry defined by name and namelen in the given index. 653 * If the return value is positive (including 0) it is the position of an 654 * exact match. If the return value is negative, the negated value minus 1 655 * is the position where the entry would be inserted. 656 * Example: The current index consists of these files and its stages: 657 * 658 * b#0, d#0, f#1, f#3 659 * 660 * index_name_pos(&index, "a", 1) -> -1 661 * index_name_pos(&index, "b", 1) -> 0 662 * index_name_pos(&index, "c", 1) -> -2 663 * index_name_pos(&index, "d", 1) -> 1 664 * index_name_pos(&index, "e", 1) -> -3 665 * index_name_pos(&index, "f", 1) -> -3 666 * index_name_pos(&index, "g", 1) -> -5 667 */ 668extern int index_name_pos(const struct index_state *, const char *name, int namelen); 669 670#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */ 671#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */ 672#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */ 673#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */ 674#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */ 675#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */ 676extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option); 677extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name); 678 679/* Remove entry, return true if there are more entries to go. */ 680extern int remove_index_entry_at(struct index_state *, int pos); 681 682extern void remove_marked_cache_entries(struct index_state *istate); 683extern int remove_file_from_index(struct index_state *, const char *path); 684#define ADD_CACHE_VERBOSE 1 685#define ADD_CACHE_PRETEND 2 686#define ADD_CACHE_IGNORE_ERRORS 4 687#define ADD_CACHE_IGNORE_REMOVAL 8 688#define ADD_CACHE_INTENT 16 689/* 690 * These two are used to add the contents of the file at path 691 * to the index, marking the working tree up-to-date by storing 692 * the cached stat info in the resulting cache entry. A caller 693 * that has already run lstat(2) on the path can call 694 * add_to_index(), and all others can call add_file_to_index(); 695 * the latter will do necessary lstat(2) internally before 696 * calling the former. 697 */ 698extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags); 699extern int add_file_to_index(struct index_state *, const char *path, int flags); 700 701extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options); 702extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip); 703extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b); 704extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce); 705extern int index_name_is_other(const struct index_state *, const char *, int); 706extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *); 707 708/* do stat comparison even if CE_VALID is true */ 709#define CE_MATCH_IGNORE_VALID 01 710/* do not check the contents but report dirty on racily-clean entries */ 711#define CE_MATCH_RACY_IS_DIRTY 02 712/* do stat comparison even if CE_SKIP_WORKTREE is true */ 713#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 714/* ignore non-existent files during stat update */ 715#define CE_MATCH_IGNORE_MISSING 0x08 716/* enable stat refresh */ 717#define CE_MATCH_REFRESH 0x10 718/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */ 719#define CE_MATCH_IGNORE_FSMONITOR 0X20 720extern int ie_match_stat(struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 721extern int ie_modified(struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 722 723#define HASH_WRITE_OBJECT 1 724#define HASH_FORMAT_CHECK 2 725#define HASH_RENORMALIZE 4 726extern int index_fd(struct object_id *oid, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags); 727extern int index_path(struct object_id *oid, const char *path, struct stat *st, unsigned flags); 728 729/* 730 * Record to sd the data from st that we use to check whether a file 731 * might have changed. 732 */ 733extern void fill_stat_data(struct stat_data *sd, struct stat *st); 734 735/* 736 * Return 0 if st is consistent with a file not having been changed 737 * since sd was filled. If there are differences, return a 738 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 739 * INODE_CHANGED, and DATA_CHANGED. 740 */ 741extern int match_stat_data(const struct stat_data *sd, struct stat *st); 742extern int match_stat_data_racy(const struct index_state *istate, 743 const struct stat_data *sd, struct stat *st); 744 745extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st); 746 747#define REFRESH_REALLY 0x0001 /* ignore_valid */ 748#define REFRESH_UNMERGED 0x0002 /* allow unmerged */ 749#define REFRESH_QUIET 0x0004 /* be quiet about it */ 750#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */ 751#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */ 752#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */ 753extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg); 754extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int); 755 756/* 757 * Opportunistically update the index but do not complain if we can't. 758 * The lockfile is always committed or rolled back. 759 */ 760extern void update_index_if_able(struct index_state *, struct lock_file *); 761 762extern int hold_locked_index(struct lock_file *, int); 763extern void set_alternate_index_output(const char *); 764 765extern int verify_index_checksum; 766extern int verify_ce_order; 767 768/* Environment bits from configuration mechanism */ 769extern int trust_executable_bit; 770extern int trust_ctime; 771extern int check_stat; 772extern int quote_path_fully; 773extern int has_symlinks; 774extern int minimum_abbrev, default_abbrev; 775extern int ignore_case; 776extern int assume_unchanged; 777extern int prefer_symlink_refs; 778extern int warn_ambiguous_refs; 779extern int warn_on_object_refname_ambiguity; 780extern const char *apply_default_whitespace; 781extern const char *apply_default_ignorewhitespace; 782extern const char *git_attributes_file; 783extern const char *git_hooks_path; 784extern int zlib_compression_level; 785extern int core_compression_level; 786extern int pack_compression_level; 787extern size_t packed_git_window_size; 788extern size_t packed_git_limit; 789extern size_t delta_base_cache_limit; 790extern unsigned long big_file_threshold; 791extern unsigned long pack_size_limit_cfg; 792 793/* 794 * Accessors for the core.sharedrepository config which lazy-load the value 795 * from the config (if not already set). The "reset" function can be 796 * used to unset "set" or cached value, meaning that the value will be loaded 797 * fresh from the config file on the next call to get_shared_repository(). 798 */ 799void set_shared_repository(int value); 800int get_shared_repository(void); 801void reset_shared_repository(void); 802 803/* 804 * Do replace refs need to be checked this run? This variable is 805 * initialized to true unless --no-replace-object is used or 806 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 807 * commands that do not want replace references to be active. As an 808 * optimization it is also set to false if replace references have 809 * been sought but there were none. 810 */ 811extern int check_replace_refs; 812extern char *git_replace_ref_base; 813 814extern int fsync_object_files; 815extern int core_preload_index; 816extern int core_commit_graph; 817extern int core_apply_sparse_checkout; 818extern int precomposed_unicode; 819extern int protect_hfs; 820extern int protect_ntfs; 821extern const char *core_fsmonitor; 822 823/* 824 * Include broken refs in all ref iterations, which will 825 * generally choke dangerous operations rather than letting 826 * them silently proceed without taking the broken ref into 827 * account. 828 */ 829extern int ref_paranoia; 830 831/* 832 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value). 833 */ 834int use_optional_locks(void); 835 836/* 837 * The character that begins a commented line in user-editable file 838 * that is subject to stripspace. 839 */ 840extern char comment_line_char; 841extern int auto_comment_line_char; 842 843/* Windows only */ 844enum hide_dotfiles_type { 845 HIDE_DOTFILES_FALSE = 0, 846 HIDE_DOTFILES_TRUE, 847 HIDE_DOTFILES_DOTGITONLY 848}; 849extern enum hide_dotfiles_type hide_dotfiles; 850 851enum log_refs_config { 852 LOG_REFS_UNSET = -1, 853 LOG_REFS_NONE = 0, 854 LOG_REFS_NORMAL, 855 LOG_REFS_ALWAYS 856}; 857extern enum log_refs_config log_all_ref_updates; 858 859enum branch_track { 860 BRANCH_TRACK_UNSPECIFIED = -1, 861 BRANCH_TRACK_NEVER = 0, 862 BRANCH_TRACK_REMOTE, 863 BRANCH_TRACK_ALWAYS, 864 BRANCH_TRACK_EXPLICIT, 865 BRANCH_TRACK_OVERRIDE 866}; 867 868enum rebase_setup_type { 869 AUTOREBASE_NEVER = 0, 870 AUTOREBASE_LOCAL, 871 AUTOREBASE_REMOTE, 872 AUTOREBASE_ALWAYS 873}; 874 875enum push_default_type { 876 PUSH_DEFAULT_NOTHING = 0, 877 PUSH_DEFAULT_MATCHING, 878 PUSH_DEFAULT_SIMPLE, 879 PUSH_DEFAULT_UPSTREAM, 880 PUSH_DEFAULT_CURRENT, 881 PUSH_DEFAULT_UNSPECIFIED 882}; 883 884extern enum branch_track git_branch_track; 885extern enum rebase_setup_type autorebase; 886extern enum push_default_type push_default; 887 888enum object_creation_mode { 889 OBJECT_CREATION_USES_HARDLINKS = 0, 890 OBJECT_CREATION_USES_RENAMES = 1 891}; 892 893extern enum object_creation_mode object_creation_mode; 894 895extern char *notes_ref_name; 896 897extern int grafts_replace_parents; 898 899/* 900 * GIT_REPO_VERSION is the version we write by default. The 901 * _READ variant is the highest number we know how to 902 * handle. 903 */ 904#define GIT_REPO_VERSION 0 905#define GIT_REPO_VERSION_READ 1 906extern int repository_format_precious_objects; 907extern char *repository_format_partial_clone; 908extern const char *core_partial_clone_filter_default; 909 910struct repository_format { 911 int version; 912 int precious_objects; 913 char *partial_clone; /* value of extensions.partialclone */ 914 int is_bare; 915 int hash_algo; 916 char *work_tree; 917 struct string_list unknown_extensions; 918}; 919 920/* 921 * Read the repository format characteristics from the config file "path" into 922 * "format" struct. Returns the numeric version. On error, -1 is returned, 923 * format->version is set to -1, and all other fields in the struct are 924 * undefined. 925 */ 926int read_repository_format(struct repository_format *format, const char *path); 927 928/* 929 * Verify that the repository described by repository_format is something we 930 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 931 * any errors encountered. 932 */ 933int verify_repository_format(const struct repository_format *format, 934 struct strbuf *err); 935 936/* 937 * Check the repository format version in the path found in get_git_dir(), 938 * and die if it is a version we don't understand. Generally one would 939 * set_git_dir() before calling this, and use it only for "are we in a valid 940 * repo?". 941 */ 942extern void check_repository_format(void); 943 944#define MTIME_CHANGED 0x0001 945#define CTIME_CHANGED 0x0002 946#define OWNER_CHANGED 0x0004 947#define MODE_CHANGED 0x0008 948#define INODE_CHANGED 0x0010 949#define DATA_CHANGED 0x0020 950#define TYPE_CHANGED 0x0040 951 952/* 953 * Return an abbreviated sha1 unique within this repository's object database. 954 * The result will be at least `len` characters long, and will be NUL 955 * terminated. 956 * 957 * The non-`_r` version returns a static buffer which remains valid until 4 958 * more calls to find_unique_abbrev are made. 959 * 960 * The `_r` variant writes to a buffer supplied by the caller, which must be at 961 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes 962 * written (excluding the NUL terminator). 963 * 964 * Note that while this version avoids the static buffer, it is not fully 965 * reentrant, as it calls into other non-reentrant git code. 966 */ 967extern const char *find_unique_abbrev(const struct object_id *oid, int len); 968extern int find_unique_abbrev_r(char *hex, const struct object_id *oid, int len); 969 970extern const unsigned char null_sha1[GIT_MAX_RAWSZ]; 971extern const struct object_id null_oid; 972 973static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2) 974{ 975 return memcmp(sha1, sha2, GIT_SHA1_RAWSZ); 976} 977 978static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2) 979{ 980 return hashcmp(oid1->hash, oid2->hash); 981} 982 983static inline int is_null_sha1(const unsigned char *sha1) 984{ 985 return !hashcmp(sha1, null_sha1); 986} 987 988static inline int is_null_oid(const struct object_id *oid) 989{ 990 return !hashcmp(oid->hash, null_sha1); 991} 992 993static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src) 994{ 995 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 996} 997 998static inline void oidcpy(struct object_id *dst, const struct object_id *src) 999{1000 hashcpy(dst->hash, src->hash);1001}10021003static inline struct object_id *oiddup(const struct object_id *src)1004{1005 struct object_id *dst = xmalloc(sizeof(struct object_id));1006 oidcpy(dst, src);1007 return dst;1008}10091010static inline void hashclr(unsigned char *hash)1011{1012 memset(hash, 0, GIT_SHA1_RAWSZ);1013}10141015static inline void oidclr(struct object_id *oid)1016{1017 memset(oid->hash, 0, GIT_MAX_RAWSZ);1018}10191020static inline void oidread(struct object_id *oid, const unsigned char *hash)1021{1022 memcpy(oid->hash, hash, the_hash_algo->rawsz);1023}10241025static inline int is_empty_blob_sha1(const unsigned char *sha1)1026{1027 return !hashcmp(sha1, the_hash_algo->empty_blob->hash);1028}10291030static inline int is_empty_blob_oid(const struct object_id *oid)1031{1032 return !oidcmp(oid, the_hash_algo->empty_blob);1033}10341035static inline int is_empty_tree_sha1(const unsigned char *sha1)1036{1037 return !hashcmp(sha1, the_hash_algo->empty_tree->hash);1038}10391040static inline int is_empty_tree_oid(const struct object_id *oid)1041{1042 return !oidcmp(oid, the_hash_algo->empty_tree);1043}10441045const char *empty_tree_oid_hex(void);1046const char *empty_blob_oid_hex(void);10471048/* set default permissions by passing mode arguments to open(2) */1049int git_mkstemps_mode(char *pattern, int suffix_len, int mode);1050int git_mkstemp_mode(char *pattern, int mode);10511052/*1053 * NOTE NOTE NOTE!!1054 *1055 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1056 * not be changed. Old repositories have core.sharedrepository written in1057 * numeric format, and therefore these values are preserved for compatibility1058 * reasons.1059 */1060enum sharedrepo {1061 PERM_UMASK = 0,1062 OLD_PERM_GROUP = 1,1063 OLD_PERM_EVERYBODY = 2,1064 PERM_GROUP = 0660,1065 PERM_EVERYBODY = 06641066};1067int git_config_perm(const char *var, const char *value);1068int adjust_shared_perm(const char *path);10691070/*1071 * Create the directory containing the named path, using care to be1072 * somewhat safe against races. Return one of the scld_error values to1073 * indicate success/failure. On error, set errno to describe the1074 * problem.1075 *1076 * SCLD_VANISHED indicates that one of the ancestor directories of the1077 * path existed at one point during the function call and then1078 * suddenly vanished, probably because another process pruned the1079 * directory while we were working. To be robust against this kind of1080 * race, callers might want to try invoking the function again when it1081 * returns SCLD_VANISHED.1082 *1083 * safe_create_leading_directories() temporarily changes path while it1084 * is working but restores it before returning.1085 * safe_create_leading_directories_const() doesn't modify path, even1086 * temporarily.1087 */1088enum scld_error {1089 SCLD_OK = 0,1090 SCLD_FAILED = -1,1091 SCLD_PERMS = -2,1092 SCLD_EXISTS = -3,1093 SCLD_VANISHED = -41094};1095enum scld_error safe_create_leading_directories(char *path);1096enum scld_error safe_create_leading_directories_const(const char *path);10971098/*1099 * Callback function for raceproof_create_file(). This function is1100 * expected to do something that makes dirname(path) permanent despite1101 * the fact that other processes might be cleaning up empty1102 * directories at the same time. Usually it will create a file named1103 * path, but alternatively it could create another file in that1104 * directory, or even chdir() into that directory. The function should1105 * return 0 if the action was completed successfully. On error, it1106 * should return a nonzero result and set errno.1107 * raceproof_create_file() treats two errno values specially:1108 *1109 * - ENOENT -- dirname(path) does not exist. In this case,1110 * raceproof_create_file() tries creating dirname(path)1111 * (and any parent directories, if necessary) and calls1112 * the function again.1113 *1114 * - EISDIR -- the file already exists and is a directory. In this1115 * case, raceproof_create_file() removes the directory if1116 * it is empty (and recursively any empty directories that1117 * it contains) and calls the function again.1118 *1119 * Any other errno causes raceproof_create_file() to fail with the1120 * callback's return value and errno.1121 *1122 * Obviously, this function should be OK with being called again if it1123 * fails with ENOENT or EISDIR. In other scenarios it will not be1124 * called again.1125 */1126typedef int create_file_fn(const char *path, void *cb);11271128/*1129 * Create a file in dirname(path) by calling fn, creating leading1130 * directories if necessary. Retry a few times in case we are racing1131 * with another process that is trying to clean up the directory that1132 * contains path. See the documentation for create_file_fn for more1133 * details.1134 *1135 * Return the value and set the errno that resulted from the most1136 * recent call of fn. fn is always called at least once, and will be1137 * called more than once if it returns ENOENT or EISDIR.1138 */1139int raceproof_create_file(const char *path, create_file_fn fn, void *cb);11401141int mkdir_in_gitdir(const char *path);1142extern char *expand_user_path(const char *path, int real_home);1143const char *enter_repo(const char *path, int strict);1144static inline int is_absolute_path(const char *path)1145{1146 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);1147}1148int is_directory(const char *);1149char *strbuf_realpath(struct strbuf *resolved, const char *path,1150 int die_on_error);1151const char *real_path(const char *path);1152const char *real_path_if_valid(const char *path);1153char *real_pathdup(const char *path, int die_on_error);1154const char *absolute_path(const char *path);1155char *absolute_pathdup(const char *path);1156const char *remove_leading_path(const char *in, const char *prefix);1157const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);1158int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);1159int normalize_path_copy(char *dst, const char *src);1160int longest_ancestor_length(const char *path, struct string_list *prefixes);1161char *strip_path_suffix(const char *path, const char *suffix);1162int daemon_avoid_alias(const char *path);11631164/*1165 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for1166 * details.1167 */1168int is_ntfs_dotgit(const char *name);1169int is_ntfs_dotgitmodules(const char *name);1170int is_ntfs_dotgitignore(const char *name);1171int is_ntfs_dotgitattributes(const char *name);11721173/*1174 * Returns true iff "str" could be confused as a command-line option when1175 * passed to a sub-program like "ssh". Note that this has nothing to do with1176 * shell-quoting, which should be handled separately; we're assuming here that1177 * the string makes it verbatim to the sub-program.1178 */1179int looks_like_command_line_option(const char *str);11801181/**1182 * Return a newly allocated string with the evaluation of1183 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1184 * "$HOME/.config/git/$filename". Return NULL upon error.1185 */1186extern char *xdg_config_home(const char *filename);11871188/**1189 * Return a newly allocated string with the evaluation of1190 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1191 * "$HOME/.cache/git/$filename". Return NULL upon error.1192 */1193extern char *xdg_cache_home(const char *filename);11941195extern int git_open_cloexec(const char *name, int flags);1196#define git_open(name) git_open_cloexec(name, O_RDONLY)1197extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);1198extern int parse_sha1_header(const char *hdr, unsigned long *sizep);11991200extern int check_object_signature(const struct object_id *oid, void *buf, unsigned long size, const char *type);12011202extern int finalize_object_file(const char *tmpfile, const char *filename);12031204/* Helper to check and "touch" a file */1205extern int check_and_freshen_file(const char *fn, int freshen);12061207extern const signed char hexval_table[256];1208static inline unsigned int hexval(unsigned char c)1209{1210 return hexval_table[c];1211}12121213/*1214 * Convert two consecutive hexadecimal digits into a char. Return a1215 * negative value on error. Don't run over the end of short strings.1216 */1217static inline int hex2chr(const char *s)1218{1219 unsigned int val = hexval(s[0]);1220 return (val & ~0xf) ? val : (val << 4) | hexval(s[1]);1221}12221223/* Convert to/from hex/sha1 representation */1224#define MINIMUM_ABBREV minimum_abbrev1225#define DEFAULT_ABBREV default_abbrev12261227/* used when the code does not know or care what the default abbrev is */1228#define FALLBACK_DEFAULT_ABBREV 712291230struct object_context {1231 unsigned mode;1232 /*1233 * symlink_path is only used by get_tree_entry_follow_symlinks,1234 * and only for symlinks that point outside the repository.1235 */1236 struct strbuf symlink_path;1237 /*1238 * If GET_OID_RECORD_PATH is set, this will record path (if any)1239 * found when resolving the name. The caller is responsible for1240 * releasing the memory.1241 */1242 char *path;1243};12441245#define GET_OID_QUIETLY 011246#define GET_OID_COMMIT 021247#define GET_OID_COMMITTISH 041248#define GET_OID_TREE 0101249#define GET_OID_TREEISH 0201250#define GET_OID_BLOB 0401251#define GET_OID_FOLLOW_SYMLINKS 01001252#define GET_OID_RECORD_PATH 02001253#define GET_OID_ONLY_TO_DIE 0400012541255#define GET_OID_DISAMBIGUATORS \1256 (GET_OID_COMMIT | GET_OID_COMMITTISH | \1257 GET_OID_TREE | GET_OID_TREEISH | \1258 GET_OID_BLOB)12591260extern int get_oid(const char *str, struct object_id *oid);1261extern int get_oid_commit(const char *str, struct object_id *oid);1262extern int get_oid_committish(const char *str, struct object_id *oid);1263extern int get_oid_tree(const char *str, struct object_id *oid);1264extern int get_oid_treeish(const char *str, struct object_id *oid);1265extern int get_oid_blob(const char *str, struct object_id *oid);1266extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);1267extern int get_oid_with_context(const char *str, unsigned flags, struct object_id *oid, struct object_context *oc);126812691270typedef int each_abbrev_fn(const struct object_id *oid, void *);1271extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);12721273extern int set_disambiguate_hint_config(const char *var, const char *value);12741275/*1276 * Try to read a SHA1 in hexadecimal format from the 40 characters1277 * starting at hex. Write the 20-byte result to sha1 in binary form.1278 * Return 0 on success. Reading stops if a NUL is encountered in the1279 * input, so it is safe to pass this function an arbitrary1280 * null-terminated string.1281 */1282extern int get_sha1_hex(const char *hex, unsigned char *sha1);1283extern int get_oid_hex(const char *hex, struct object_id *sha1);12841285/*1286 * Read `len` pairs of hexadecimal digits from `hex` and write the1287 * values to `binary` as `len` bytes. Return 0 on success, or -1 if1288 * the input does not consist of hex digits).1289 */1290extern int hex_to_bytes(unsigned char *binary, const char *hex, size_t len);12911292/*1293 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1294 * and writes the NUL-terminated output to the buffer `out`, which must be at1295 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1296 * convenience.1297 *1298 * The non-`_r` variant returns a static buffer, but uses a ring of 41299 * buffers, making it safe to make multiple calls for a single statement, like:1300 *1301 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1302 */1303extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);1304extern char *oid_to_hex_r(char *out, const struct object_id *oid);1305extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */1306extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */13071308/*1309 * Parse a 40-character hexadecimal object ID starting from hex, updating the1310 * pointer specified by end when parsing stops. The resulting object ID is1311 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1312 * other invalid character. end is only updated on success; otherwise, it is1313 * unmodified.1314 */1315extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);13161317/*1318 * This reads short-hand syntax that not only evaluates to a commit1319 * object name, but also can act as if the end user spelled the name1320 * of the branch from the command line.1321 *1322 * - "@{-N}" finds the name of the Nth previous branch we were on, and1323 * places the name of the branch in the given buf and returns the1324 * number of characters parsed if successful.1325 *1326 * - "<branch>@{upstream}" finds the name of the other ref that1327 * <branch> is configured to merge with (missing <branch> defaults1328 * to the current branch), and places the name of the branch in the1329 * given buf and returns the number of characters parsed if1330 * successful.1331 *1332 * If the input is not of the accepted format, it returns a negative1333 * number to signal an error.1334 *1335 * If the input was ok but there are not N branch switches in the1336 * reflog, it returns 0.1337 *1338 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1339 * expansions: local branches ("refs/heads/"), remote branches1340 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1341 * allowed, even ones to refs outside of those namespaces.1342 */1343#define INTERPRET_BRANCH_LOCAL (1<<0)1344#define INTERPRET_BRANCH_REMOTE (1<<1)1345#define INTERPRET_BRANCH_HEAD (1<<2)1346extern int interpret_branch_name(const char *str, int len, struct strbuf *,1347 unsigned allowed);1348extern int get_oid_mb(const char *str, struct object_id *oid);13491350extern int validate_headref(const char *ref);13511352extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1353extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1354extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);1355extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);13561357extern void *read_object_with_reference(const struct object_id *oid,1358 const char *required_type,1359 unsigned long *size,1360 struct object_id *oid_ret);13611362extern struct object *peel_to_type(const char *name, int namelen,1363 struct object *o, enum object_type);13641365struct date_mode {1366 enum date_mode_type {1367 DATE_NORMAL = 0,1368 DATE_RELATIVE,1369 DATE_SHORT,1370 DATE_ISO8601,1371 DATE_ISO8601_STRICT,1372 DATE_RFC2822,1373 DATE_STRFTIME,1374 DATE_RAW,1375 DATE_UNIX1376 } type;1377 const char *strftime_fmt;1378 int local;1379};13801381/*1382 * Convenience helper for passing a constant type, like:1383 *1384 * show_date(t, tz, DATE_MODE(NORMAL));1385 */1386#define DATE_MODE(t) date_mode_from_type(DATE_##t)1387struct date_mode *date_mode_from_type(enum date_mode_type type);13881389const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);1390void show_date_relative(timestamp_t time, int tz, const struct timeval *now,1391 struct strbuf *timebuf);1392int parse_date(const char *date, struct strbuf *out);1393int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);1394int parse_expiry_date(const char *date, timestamp_t *timestamp);1395void datestamp(struct strbuf *out);1396#define approxidate(s) approxidate_careful((s), NULL)1397timestamp_t approxidate_careful(const char *, int *);1398timestamp_t approxidate_relative(const char *date, const struct timeval *now);1399void parse_date_format(const char *format, struct date_mode *mode);1400int date_overflows(timestamp_t date);14011402#define IDENT_STRICT 11403#define IDENT_NO_DATE 21404#define IDENT_NO_NAME 41405extern const char *git_author_info(int);1406extern const char *git_committer_info(int);1407extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);1408extern const char *fmt_name(const char *name, const char *email);1409extern const char *ident_default_name(void);1410extern const char *ident_default_email(void);1411extern const char *git_editor(void);1412extern const char *git_pager(int stdout_is_tty);1413extern int is_terminal_dumb(void);1414extern int git_ident_config(const char *, const char *, void *);1415extern void reset_ident_date(void);14161417struct ident_split {1418 const char *name_begin;1419 const char *name_end;1420 const char *mail_begin;1421 const char *mail_end;1422 const char *date_begin;1423 const char *date_end;1424 const char *tz_begin;1425 const char *tz_end;1426};1427/*1428 * Signals an success with 0, but time part of the result may be NULL1429 * if the input lacks timestamp and zone1430 */1431extern int split_ident_line(struct ident_split *, const char *, int);14321433/*1434 * Like show_date, but pull the timestamp and tz parameters from1435 * the ident_split. It will also sanity-check the values and produce1436 * a well-known sentinel date if they appear bogus.1437 */1438const char *show_ident_date(const struct ident_split *id,1439 const struct date_mode *mode);14401441/*1442 * Compare split idents for equality or strict ordering. Note that we1443 * compare only the ident part of the line, ignoring any timestamp.1444 *1445 * Because there are two fields, we must choose one as the primary key; we1446 * currently arbitrarily pick the email.1447 */1448extern int ident_cmp(const struct ident_split *, const struct ident_split *);14491450struct checkout {1451 struct index_state *istate;1452 const char *base_dir;1453 int base_dir_len;1454 struct delayed_checkout *delayed_checkout;1455 unsigned force:1,1456 quiet:1,1457 not_new:1,1458 refresh_cache:1;1459};1460#define CHECKOUT_INIT { NULL, "" }14611462#define TEMPORARY_FILENAME_LENGTH 251463extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);1464extern void enable_delayed_checkout(struct checkout *state);1465extern int finish_delayed_checkout(struct checkout *state);14661467struct cache_def {1468 struct strbuf path;1469 int flags;1470 int track_flags;1471 int prefix_len_stat_func;1472};1473#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1474static inline void cache_def_clear(struct cache_def *cache)1475{1476 strbuf_release(&cache->path);1477}14781479extern int has_symlink_leading_path(const char *name, int len);1480extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);1481extern int check_leading_path(const char *name, int len);1482extern int has_dirs_only_path(const char *name, int len, int prefix_len);1483extern void schedule_dir_for_removal(const char *name, int len);1484extern void remove_scheduled_dirs(void);14851486struct pack_window {1487 struct pack_window *next;1488 unsigned char *base;1489 off_t offset;1490 size_t len;1491 unsigned int last_used;1492 unsigned int inuse_cnt;1493};14941495struct pack_entry {1496 off_t offset;1497 struct packed_git *p;1498};14991500/*1501 * Create a temporary file rooted in the object database directory, or1502 * die on failure. The filename is taken from "pattern", which should have the1503 * usual "XXXXXX" trailer, and the resulting filename is written into the1504 * "template" buffer. Returns the open descriptor.1505 */1506extern int odb_mkstemp(struct strbuf *temp_filename, const char *pattern);15071508/*1509 * Create a pack .keep file named "name" (which should generally be the output1510 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1511 * error.1512 */1513extern int odb_pack_keep(const char *name);15141515/*1516 * Iterate over the files in the loose-object parts of the object1517 * directory "path", triggering the following callbacks:1518 *1519 * - loose_object is called for each loose object we find.1520 *1521 * - loose_cruft is called for any files that do not appear to be1522 * loose objects. Note that we only look in the loose object1523 * directories "objects/[0-9a-f]{2}/", so we will not report1524 * "objects/foobar" as cruft.1525 *1526 * - loose_subdir is called for each top-level hashed subdirectory1527 * of the object directory (e.g., "$OBJDIR/f0"). It is called1528 * after the objects in the directory are processed.1529 *1530 * Any callback that is NULL will be ignored. Callbacks returning non-zero1531 * will end the iteration.1532 *1533 * In the "buf" variant, "path" is a strbuf which will also be used as a1534 * scratch buffer, but restored to its original contents before1535 * the function returns.1536 */1537typedef int each_loose_object_fn(const struct object_id *oid,1538 const char *path,1539 void *data);1540typedef int each_loose_cruft_fn(const char *basename,1541 const char *path,1542 void *data);1543typedef int each_loose_subdir_fn(unsigned int nr,1544 const char *path,1545 void *data);1546int for_each_file_in_obj_subdir(unsigned int subdir_nr,1547 struct strbuf *path,1548 each_loose_object_fn obj_cb,1549 each_loose_cruft_fn cruft_cb,1550 each_loose_subdir_fn subdir_cb,1551 void *data);1552int for_each_loose_file_in_objdir(const char *path,1553 each_loose_object_fn obj_cb,1554 each_loose_cruft_fn cruft_cb,1555 each_loose_subdir_fn subdir_cb,1556 void *data);1557int for_each_loose_file_in_objdir_buf(struct strbuf *path,1558 each_loose_object_fn obj_cb,1559 each_loose_cruft_fn cruft_cb,1560 each_loose_subdir_fn subdir_cb,1561 void *data);15621563/*1564 * Iterate over loose objects in both the local1565 * repository and any alternates repositories (unless the1566 * LOCAL_ONLY flag is set).1567 */1568#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11569extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);15701571/*1572 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing1573 * blobs. This has a difference only if extensions.partialClone is set.1574 *1575 * Its default value is 1.1576 */1577extern int fetch_if_missing;15781579/* Dumb servers support */1580extern int update_server_info(int);15811582extern const char *get_log_output_encoding(void);1583extern const char *get_commit_output_encoding(void);15841585/*1586 * This is a hack for test programs like test-dump-untracked-cache to1587 * ensure that they do not modify the untracked cache when reading it.1588 * Do not use it otherwise!1589 */1590extern int ignore_untracked_cache_config;15911592extern int committer_ident_sufficiently_given(void);1593extern int author_ident_sufficiently_given(void);15941595extern const char *git_commit_encoding;1596extern const char *git_log_output_encoding;1597extern const char *git_mailmap_file;1598extern const char *git_mailmap_blob;15991600/* IO helper functions */1601extern void maybe_flush_or_die(FILE *, const char *);1602__attribute__((format (printf, 2, 3)))1603extern void fprintf_or_die(FILE *, const char *fmt, ...);16041605#define COPY_READ_ERROR (-2)1606#define COPY_WRITE_ERROR (-3)1607extern int copy_fd(int ifd, int ofd);1608extern int copy_file(const char *dst, const char *src, int mode);1609extern int copy_file_with_time(const char *dst, const char *src, int mode);16101611extern void write_or_die(int fd, const void *buf, size_t count);1612extern void fsync_or_die(int fd, const char *);16131614extern ssize_t read_in_full(int fd, void *buf, size_t count);1615extern ssize_t write_in_full(int fd, const void *buf, size_t count);1616extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);16171618static inline ssize_t write_str_in_full(int fd, const char *str)1619{1620 return write_in_full(fd, str, strlen(str));1621}16221623/**1624 * Open (and truncate) the file at path, write the contents of buf to it,1625 * and close it. Dies if any errors are encountered.1626 */1627extern void write_file_buf(const char *path, const char *buf, size_t len);16281629/**1630 * Like write_file_buf(), but format the contents into a buffer first.1631 * Additionally, write_file() will append a newline if one is not already1632 * present, making it convenient to write text files:1633 *1634 * write_file(path, "counter: %d", ctr);1635 */1636__attribute__((format (printf, 2, 3)))1637extern void write_file(const char *path, const char *fmt, ...);16381639/* pager.c */1640extern void setup_pager(void);1641extern int pager_in_use(void);1642extern int pager_use_color;1643extern int term_columns(void);1644extern int decimal_width(uintmax_t);1645extern int check_pager_config(const char *cmd);1646extern void prepare_pager_args(struct child_process *, const char *pager);16471648extern const char *editor_program;1649extern const char *askpass_program;1650extern const char *excludes_file;16511652/* base85 */1653int decode_85(char *dst, const char *line, int linelen);1654void encode_85(char *buf, const unsigned char *data, int bytes);16551656/* pkt-line.c */1657void packet_trace_identity(const char *prog);16581659/* add */1660/*1661 * return 0 if success, 1 - if addition of a file failed and1662 * ADD_FILES_IGNORE_ERRORS was specified in flags1663 */1664int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);16651666/* diff.c */1667extern int diff_auto_refresh_index;16681669/* match-trees.c */1670void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);1671void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);16721673/*1674 * whitespace rules.1675 * used by both diff and apply1676 * last two digits are tab width1677 */1678#define WS_BLANK_AT_EOL 01001679#define WS_SPACE_BEFORE_TAB 02001680#define WS_INDENT_WITH_NON_TAB 04001681#define WS_CR_AT_EOL 010001682#define WS_BLANK_AT_EOF 020001683#define WS_TAB_IN_INDENT 040001684#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1685#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1686#define WS_TAB_WIDTH_MASK 0771687/* All WS_* -- when extended, adapt diff.c emit_symbol */1688#define WS_RULE_MASK 077771689extern unsigned whitespace_rule_cfg;1690extern unsigned whitespace_rule(const char *);1691extern unsigned parse_whitespace_rule(const char *);1692extern unsigned ws_check(const char *line, int len, unsigned ws_rule);1693extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);1694extern char *whitespace_error_string(unsigned ws);1695extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);1696extern int ws_blank_line(const char *line, int len, unsigned ws_rule);1697#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)16981699/* ls-files */1700void overlay_tree_on_index(struct index_state *istate,1701 const char *tree_name, const char *prefix);17021703/* setup.c */1704struct startup_info {1705 int have_repository;1706 const char *prefix;1707};1708extern struct startup_info *startup_info;17091710/* merge.c */1711struct commit_list;1712int try_merge_command(const char *strategy, size_t xopts_nr,1713 const char **xopts, struct commit_list *common,1714 const char *head_arg, struct commit_list *remotes);1715int checkout_fast_forward(const struct object_id *from,1716 const struct object_id *to,1717 int overwrite_ignore);171817191720int sane_execvp(const char *file, char *const argv[]);17211722/*1723 * A struct to encapsulate the concept of whether a file has changed1724 * since we last checked it. This uses criteria similar to those used1725 * for the index.1726 */1727struct stat_validity {1728 struct stat_data *sd;1729};17301731void stat_validity_clear(struct stat_validity *sv);17321733/*1734 * Returns 1 if the path is a regular file (or a symlink to a regular1735 * file) and matches the saved stat_validity, 0 otherwise. A missing1736 * or inaccessible file is considered a match if the struct was just1737 * initialized, or if the previous update found an inaccessible file.1738 */1739int stat_validity_check(struct stat_validity *sv, const char *path);17401741/*1742 * Update the stat_validity from a file opened at descriptor fd. If1743 * the file is missing, inaccessible, or not a regular file, then1744 * future calls to stat_validity_check will match iff one of those1745 * conditions continues to be true.1746 */1747void stat_validity_update(struct stat_validity *sv, int fd);17481749int versioncmp(const char *s1, const char *s2);1750void sleep_millisec(int millisec);17511752/*1753 * Create a directory and (if share is nonzero) adjust its permissions1754 * according to the shared_repository setting. Only use this for1755 * directories under $GIT_DIR. Don't use it for working tree1756 * directories.1757 */1758void safe_create_dir(const char *dir, int share);17591760/*1761 * Should we print an ellipsis after an abbreviated SHA-1 value1762 * when doing diff-raw output or indicating a detached HEAD?1763 */1764extern int print_sha1_ellipsis(void);17651766#endif /* CACHE_H */