1#ifndef CACHE_H 2#define CACHE_H 3 4#include "git-compat-util.h" 5#include "strbuf.h" 6#include "hashmap.h" 7#include "advice.h" 8#include "gettext.h" 9#include "convert.h" 10#include "trace.h" 11#include "string-list.h" 12#include "pack-revindex.h" 13 14#include SHA1_HEADER 15#ifndef platform_SHA_CTX 16/* 17 * platform's underlying implementation of SHA-1; could be OpenSSL, 18 * blk_SHA, Apple CommonCrypto, etc... Note that including 19 * SHA1_HEADER may have already defined platform_SHA_CTX for our 20 * own implementations like block-sha1 and ppc-sha1, so we list 21 * the default for OpenSSL compatible SHA-1 implementations here. 22 */ 23#define platform_SHA_CTX SHA_CTX 24#define platform_SHA1_Init SHA1_Init 25#define platform_SHA1_Update SHA1_Update 26#define platform_SHA1_Final SHA1_Final 27#endif 28 29#define git_SHA_CTX platform_SHA_CTX 30#define git_SHA1_Init platform_SHA1_Init 31#define git_SHA1_Update platform_SHA1_Update 32#define git_SHA1_Final platform_SHA1_Final 33 34#ifdef SHA1_MAX_BLOCK_SIZE 35#include "compat/sha1-chunked.h" 36#undef git_SHA1_Update 37#define git_SHA1_Update git_SHA1_Update_Chunked 38#endif 39 40#include <zlib.h> 41typedef struct git_zstream { 42 z_stream z; 43 unsigned long avail_in; 44 unsigned long avail_out; 45 unsigned long total_in; 46 unsigned long total_out; 47 unsigned char *next_in; 48 unsigned char *next_out; 49} git_zstream; 50 51void git_inflate_init(git_zstream *); 52void git_inflate_init_gzip_only(git_zstream *); 53void git_inflate_end(git_zstream *); 54int git_inflate(git_zstream *, int flush); 55 56void git_deflate_init(git_zstream *, int level); 57void git_deflate_init_gzip(git_zstream *, int level); 58void git_deflate_init_raw(git_zstream *, int level); 59void git_deflate_end(git_zstream *); 60int git_deflate_abort(git_zstream *); 61int git_deflate_end_gently(git_zstream *); 62int git_deflate(git_zstream *, int flush); 63unsigned long git_deflate_bound(git_zstream *, unsigned long); 64 65/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 66#define GIT_SHA1_RAWSZ 20 67#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 68 69struct object_id { 70 unsigned char hash[GIT_SHA1_RAWSZ]; 71}; 72 73#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 74#define DTYPE(de) ((de)->d_type) 75#else 76#undef DT_UNKNOWN 77#undef DT_DIR 78#undef DT_REG 79#undef DT_LNK 80#define DT_UNKNOWN 0 81#define DT_DIR 1 82#define DT_REG 2 83#define DT_LNK 3 84#define DTYPE(de) DT_UNKNOWN 85#endif 86 87/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 88#define S_IFINVALID 0030000 89 90/* 91 * A "directory link" is a link to another git directory. 92 * 93 * The value 0160000 is not normally a valid mode, and 94 * also just happens to be S_IFDIR + S_IFLNK 95 */ 96#define S_IFGITLINK 0160000 97#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 98 99/* 100 * Some mode bits are also used internally for computations. 101 * 102 * They *must* not overlap with any valid modes, and they *must* not be emitted 103 * to outside world - i.e. appear on disk or network. In other words, it's just 104 * temporary fields, which we internally use, but they have to stay in-house. 105 * 106 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 107 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 108 */ 109 110/* used internally in tree-diff */ 111#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 112 113 114/* 115 * Intensive research over the course of many years has shown that 116 * port 9418 is totally unused by anything else. Or 117 * 118 * Your search - "port 9418" - did not match any documents. 119 * 120 * as www.google.com puts it. 121 * 122 * This port has been properly assigned for git use by IANA: 123 * git (Assigned-9418) [I06-050728-0001]. 124 * 125 * git 9418/tcp git pack transfer service 126 * git 9418/udp git pack transfer service 127 * 128 * with Linus Torvalds <torvalds@osdl.org> as the point of 129 * contact. September 2005. 130 * 131 * See http://www.iana.org/assignments/port-numbers 132 */ 133#define DEFAULT_GIT_PORT 9418 134 135/* 136 * Basic data structures for the directory cache 137 */ 138 139#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */ 140struct cache_header { 141 uint32_t hdr_signature; 142 uint32_t hdr_version; 143 uint32_t hdr_entries; 144}; 145 146#define INDEX_FORMAT_LB 2 147#define INDEX_FORMAT_UB 4 148 149/* 150 * The "cache_time" is just the low 32 bits of the 151 * time. It doesn't matter if it overflows - we only 152 * check it for equality in the 32 bits we save. 153 */ 154struct cache_time { 155 uint32_t sec; 156 uint32_t nsec; 157}; 158 159struct stat_data { 160 struct cache_time sd_ctime; 161 struct cache_time sd_mtime; 162 unsigned int sd_dev; 163 unsigned int sd_ino; 164 unsigned int sd_uid; 165 unsigned int sd_gid; 166 unsigned int sd_size; 167}; 168 169struct cache_entry { 170 struct hashmap_entry ent; 171 struct stat_data ce_stat_data; 172 unsigned int ce_mode; 173 unsigned int ce_flags; 174 unsigned int ce_namelen; 175 unsigned int index; /* for link extension */ 176 struct object_id oid; 177 char name[FLEX_ARRAY]; /* more */ 178}; 179 180#define CE_STAGEMASK (0x3000) 181#define CE_EXTENDED (0x4000) 182#define CE_VALID (0x8000) 183#define CE_STAGESHIFT 12 184 185/* 186 * Range 0xFFFF0FFF in ce_flags is divided into 187 * two parts: in-memory flags and on-disk ones. 188 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 189 * if you want to save a new flag, add it in 190 * CE_EXTENDED_FLAGS 191 * 192 * In-memory only flags 193 */ 194#define CE_UPDATE (1 << 16) 195#define CE_REMOVE (1 << 17) 196#define CE_UPTODATE (1 << 18) 197#define CE_ADDED (1 << 19) 198 199#define CE_HASHED (1 << 20) 200#define CE_WT_REMOVE (1 << 22) /* remove in work directory */ 201#define CE_CONFLICTED (1 << 23) 202 203#define CE_UNPACKED (1 << 24) 204#define CE_NEW_SKIP_WORKTREE (1 << 25) 205 206/* used to temporarily mark paths matched by pathspecs */ 207#define CE_MATCHED (1 << 26) 208 209#define CE_UPDATE_IN_BASE (1 << 27) 210#define CE_STRIP_NAME (1 << 28) 211 212/* 213 * Extended on-disk flags 214 */ 215#define CE_INTENT_TO_ADD (1 << 29) 216#define CE_SKIP_WORKTREE (1 << 30) 217/* CE_EXTENDED2 is for future extension */ 218#define CE_EXTENDED2 (1U << 31) 219 220#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 221 222/* 223 * Safeguard to avoid saving wrong flags: 224 * - CE_EXTENDED2 won't get saved until its semantic is known 225 * - Bits in 0x0000FFFF have been saved in ce_flags already 226 * - Bits in 0x003F0000 are currently in-memory flags 227 */ 228#if CE_EXTENDED_FLAGS & 0x803FFFFF 229#error "CE_EXTENDED_FLAGS out of range" 230#endif 231 232/* Forward structure decls */ 233struct pathspec; 234struct child_process; 235 236/* 237 * Copy the sha1 and stat state of a cache entry from one to 238 * another. But we never change the name, or the hash state! 239 */ 240static inline void copy_cache_entry(struct cache_entry *dst, 241 const struct cache_entry *src) 242{ 243 unsigned int state = dst->ce_flags & CE_HASHED; 244 245 /* Don't copy hash chain and name */ 246 memcpy(&dst->ce_stat_data, &src->ce_stat_data, 247 offsetof(struct cache_entry, name) - 248 offsetof(struct cache_entry, ce_stat_data)); 249 250 /* Restore the hash state */ 251 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 252} 253 254static inline unsigned create_ce_flags(unsigned stage) 255{ 256 return (stage << CE_STAGESHIFT); 257} 258 259#define ce_namelen(ce) ((ce)->ce_namelen) 260#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 261#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 262#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 263#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 264#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 265#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 266 267#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 268static inline unsigned int create_ce_mode(unsigned int mode) 269{ 270 if (S_ISLNK(mode)) 271 return S_IFLNK; 272 if (S_ISDIR(mode) || S_ISGITLINK(mode)) 273 return S_IFGITLINK; 274 return S_IFREG | ce_permissions(mode); 275} 276static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce, 277 unsigned int mode) 278{ 279 extern int trust_executable_bit, has_symlinks; 280 if (!has_symlinks && S_ISREG(mode) && 281 ce && S_ISLNK(ce->ce_mode)) 282 return ce->ce_mode; 283 if (!trust_executable_bit && S_ISREG(mode)) { 284 if (ce && S_ISREG(ce->ce_mode)) 285 return ce->ce_mode; 286 return create_ce_mode(0666); 287 } 288 return create_ce_mode(mode); 289} 290static inline int ce_to_dtype(const struct cache_entry *ce) 291{ 292 unsigned ce_mode = ntohl(ce->ce_mode); 293 if (S_ISREG(ce_mode)) 294 return DT_REG; 295 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode)) 296 return DT_DIR; 297 else if (S_ISLNK(ce_mode)) 298 return DT_LNK; 299 else 300 return DT_UNKNOWN; 301} 302static inline unsigned int canon_mode(unsigned int mode) 303{ 304 if (S_ISREG(mode)) 305 return S_IFREG | ce_permissions(mode); 306 if (S_ISLNK(mode)) 307 return S_IFLNK; 308 if (S_ISDIR(mode)) 309 return S_IFDIR; 310 return S_IFGITLINK; 311} 312 313#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 314 315#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */ 316#define CE_ENTRY_CHANGED (1 << 1) 317#define CE_ENTRY_REMOVED (1 << 2) 318#define CE_ENTRY_ADDED (1 << 3) 319#define RESOLVE_UNDO_CHANGED (1 << 4) 320#define CACHE_TREE_CHANGED (1 << 5) 321#define SPLIT_INDEX_ORDERED (1 << 6) 322#define UNTRACKED_CHANGED (1 << 7) 323 324struct split_index; 325struct untracked_cache; 326 327struct index_state { 328 struct cache_entry **cache; 329 unsigned int version; 330 unsigned int cache_nr, cache_alloc, cache_changed; 331 struct string_list *resolve_undo; 332 struct cache_tree *cache_tree; 333 struct split_index *split_index; 334 struct cache_time timestamp; 335 unsigned name_hash_initialized : 1, 336 initialized : 1; 337 struct hashmap name_hash; 338 struct hashmap dir_hash; 339 unsigned char sha1[20]; 340 struct untracked_cache *untracked; 341}; 342 343extern struct index_state the_index; 344 345/* Name hashing */ 346extern void add_name_hash(struct index_state *istate, struct cache_entry *ce); 347extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce); 348extern void free_name_hash(struct index_state *istate); 349 350 351#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 352#define active_cache (the_index.cache) 353#define active_nr (the_index.cache_nr) 354#define active_alloc (the_index.cache_alloc) 355#define active_cache_changed (the_index.cache_changed) 356#define active_cache_tree (the_index.cache_tree) 357 358#define read_cache() read_index(&the_index) 359#define read_cache_from(path) read_index_from(&the_index, (path)) 360#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 361#define is_cache_unborn() is_index_unborn(&the_index) 362#define read_cache_unmerged() read_index_unmerged(&the_index) 363#define discard_cache() discard_index(&the_index) 364#define unmerged_cache() unmerged_index(&the_index) 365#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 366#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 367#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 368#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 369#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 370#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 371#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 372#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 373#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 374#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 375#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 376#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 377#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 378#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 379#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 380#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 381#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 382#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 383#endif 384 385enum object_type { 386 OBJ_BAD = -1, 387 OBJ_NONE = 0, 388 OBJ_COMMIT = 1, 389 OBJ_TREE = 2, 390 OBJ_BLOB = 3, 391 OBJ_TAG = 4, 392 /* 5 for future expansion */ 393 OBJ_OFS_DELTA = 6, 394 OBJ_REF_DELTA = 7, 395 OBJ_ANY, 396 OBJ_MAX 397}; 398 399static inline enum object_type object_type(unsigned int mode) 400{ 401 return S_ISDIR(mode) ? OBJ_TREE : 402 S_ISGITLINK(mode) ? OBJ_COMMIT : 403 OBJ_BLOB; 404} 405 406/* Double-check local_repo_env below if you add to this list. */ 407#define GIT_DIR_ENVIRONMENT "GIT_DIR" 408#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR" 409#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE" 410#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE" 411#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX" 412#define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX" 413#define DEFAULT_GIT_DIR_ENVIRONMENT ".git" 414#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY" 415#define INDEX_ENVIRONMENT "GIT_INDEX_FILE" 416#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE" 417#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE" 418#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" 419#define CONFIG_ENVIRONMENT "GIT_CONFIG" 420#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS" 421#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH" 422#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES" 423#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS" 424#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE" 425#define GITATTRIBUTES_FILE ".gitattributes" 426#define INFOATTRIBUTES_FILE "info/attributes" 427#define ATTRIBUTE_MACRO_PREFIX "[attr]" 428#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF" 429#define GIT_NOTES_DEFAULT_REF "refs/notes/commits" 430#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF" 431#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF" 432#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE" 433#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS" 434#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS" 435#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS" 436#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS" 437#define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH" 438 439/* 440 * This environment variable is expected to contain a boolean indicating 441 * whether we should or should not treat: 442 * 443 * GIT_DIR=foo.git git ... 444 * 445 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 446 * of this, but we use it internally to communicate to sub-processes that we 447 * are in a bare repo. If not set, defaults to true. 448 */ 449#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE" 450 451/* 452 * Repository-local GIT_* environment variables; these will be cleared 453 * when git spawns a sub-process that runs inside another repository. 454 * The array is NULL-terminated, which makes it easy to pass in the "env" 455 * parameter of a run-command invocation, or to do a simple walk. 456 */ 457extern const char * const local_repo_env[]; 458 459/* 460 * Returns true iff we have a configured git repository (either via 461 * setup_git_directory, or in the environment via $GIT_DIR). 462 */ 463int have_git_dir(void); 464 465extern int is_bare_repository_cfg; 466extern int is_bare_repository(void); 467extern int is_inside_git_dir(void); 468extern char *git_work_tree_cfg; 469extern int is_inside_work_tree(void); 470extern const char *get_git_dir(void); 471extern const char *get_git_common_dir(void); 472extern char *get_object_directory(void); 473extern char *get_index_file(void); 474extern char *get_graft_file(void); 475extern int set_git_dir(const char *path); 476extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir); 477extern int get_common_dir(struct strbuf *sb, const char *gitdir); 478extern const char *get_git_namespace(void); 479extern const char *strip_namespace(const char *namespaced_ref); 480extern const char *get_super_prefix(void); 481extern const char *get_git_work_tree(void); 482 483/* 484 * Return true if the given path is a git directory; note that this _just_ 485 * looks at the directory itself. If you want to know whether "foo/.git" 486 * is a repository, you must feed that path, not just "foo". 487 */ 488extern int is_git_directory(const char *path); 489 490/* 491 * Return 1 if the given path is the root of a git repository or 492 * submodule, else 0. Will not return 1 for bare repositories with the 493 * exception of creating a bare repository in "foo/.git" and calling 494 * is_git_repository("foo"). 495 * 496 * If we run into read errors, we err on the side of saying "yes, it is", 497 * as we usually consider sub-repos precious, and would prefer to err on the 498 * side of not disrupting or deleting them. 499 */ 500extern int is_nonbare_repository_dir(struct strbuf *path); 501 502#define READ_GITFILE_ERR_STAT_FAILED 1 503#define READ_GITFILE_ERR_NOT_A_FILE 2 504#define READ_GITFILE_ERR_OPEN_FAILED 3 505#define READ_GITFILE_ERR_READ_FAILED 4 506#define READ_GITFILE_ERR_INVALID_FORMAT 5 507#define READ_GITFILE_ERR_NO_PATH 6 508#define READ_GITFILE_ERR_NOT_A_REPO 7 509#define READ_GITFILE_ERR_TOO_LARGE 8 510extern const char *read_gitfile_gently(const char *path, int *return_error_code); 511#define read_gitfile(path) read_gitfile_gently((path), NULL) 512extern const char *resolve_gitdir(const char *suspect); 513extern void set_git_work_tree(const char *tree); 514 515#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES" 516 517extern const char **get_pathspec(const char *prefix, const char **pathspec); 518extern void setup_work_tree(void); 519extern const char *setup_git_directory_gently(int *); 520extern const char *setup_git_directory(void); 521extern char *prefix_path(const char *prefix, int len, const char *path); 522extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path); 523extern const char *prefix_filename(const char *prefix, int len, const char *path); 524extern int check_filename(const char *prefix, const char *name); 525extern void verify_filename(const char *prefix, 526 const char *name, 527 int diagnose_misspelt_rev); 528extern void verify_non_filename(const char *prefix, const char *name); 529extern int path_inside_repo(const char *prefix, const char *path); 530 531#define INIT_DB_QUIET 0x0001 532#define INIT_DB_EXIST_OK 0x0002 533 534extern int init_db(const char *git_dir, const char *real_git_dir, 535 const char *template_dir, unsigned int flags); 536 537extern void sanitize_stdfds(void); 538extern int daemonize(void); 539 540#define alloc_nr(x) (((x)+16)*3/2) 541 542/* 543 * Realloc the buffer pointed at by variable 'x' so that it can hold 544 * at least 'nr' entries; the number of entries currently allocated 545 * is 'alloc', using the standard growing factor alloc_nr() macro. 546 * 547 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 548 */ 549#define ALLOC_GROW(x, nr, alloc) \ 550 do { \ 551 if ((nr) > alloc) { \ 552 if (alloc_nr(alloc) < (nr)) \ 553 alloc = (nr); \ 554 else \ 555 alloc = alloc_nr(alloc); \ 556 REALLOC_ARRAY(x, alloc); \ 557 } \ 558 } while (0) 559 560/* Initialize and use the cache information */ 561struct lock_file; 562extern int read_index(struct index_state *); 563extern int read_index_preload(struct index_state *, const struct pathspec *pathspec); 564extern int do_read_index(struct index_state *istate, const char *path, 565 int must_exist); /* for testting only! */ 566extern int read_index_from(struct index_state *, const char *path); 567extern int is_index_unborn(struct index_state *); 568extern int read_index_unmerged(struct index_state *); 569#define COMMIT_LOCK (1 << 0) 570#define CLOSE_LOCK (1 << 1) 571extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags); 572extern int discard_index(struct index_state *); 573extern int unmerged_index(const struct index_state *); 574extern int verify_path(const char *path); 575extern int index_dir_exists(struct index_state *istate, const char *name, int namelen); 576extern void adjust_dirname_case(struct index_state *istate, char *name); 577extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase); 578 579/* 580 * Searches for an entry defined by name and namelen in the given index. 581 * If the return value is positive (including 0) it is the position of an 582 * exact match. If the return value is negative, the negated value minus 1 583 * is the position where the entry would be inserted. 584 * Example: The current index consists of these files and its stages: 585 * 586 * b#0, d#0, f#1, f#3 587 * 588 * index_name_pos(&index, "a", 1) -> -1 589 * index_name_pos(&index, "b", 1) -> 0 590 * index_name_pos(&index, "c", 1) -> -2 591 * index_name_pos(&index, "d", 1) -> 1 592 * index_name_pos(&index, "e", 1) -> -3 593 * index_name_pos(&index, "f", 1) -> -3 594 * index_name_pos(&index, "g", 1) -> -5 595 */ 596extern int index_name_pos(const struct index_state *, const char *name, int namelen); 597 598#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */ 599#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */ 600#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */ 601#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */ 602#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */ 603#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */ 604extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option); 605extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name); 606extern int remove_index_entry_at(struct index_state *, int pos); 607extern void remove_marked_cache_entries(struct index_state *istate); 608extern int remove_file_from_index(struct index_state *, const char *path); 609#define ADD_CACHE_VERBOSE 1 610#define ADD_CACHE_PRETEND 2 611#define ADD_CACHE_IGNORE_ERRORS 4 612#define ADD_CACHE_IGNORE_REMOVAL 8 613#define ADD_CACHE_INTENT 16 614extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags); 615extern int add_file_to_index(struct index_state *, const char *path, int flags); 616extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options); 617extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip); 618extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b); 619extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce); 620extern int index_name_is_other(const struct index_state *, const char *, int); 621extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *); 622 623/* do stat comparison even if CE_VALID is true */ 624#define CE_MATCH_IGNORE_VALID 01 625/* do not check the contents but report dirty on racily-clean entries */ 626#define CE_MATCH_RACY_IS_DIRTY 02 627/* do stat comparison even if CE_SKIP_WORKTREE is true */ 628#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 629/* ignore non-existent files during stat update */ 630#define CE_MATCH_IGNORE_MISSING 0x08 631/* enable stat refresh */ 632#define CE_MATCH_REFRESH 0x10 633extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 634extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 635 636#define HASH_WRITE_OBJECT 1 637#define HASH_FORMAT_CHECK 2 638extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags); 639extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags); 640 641/* 642 * Record to sd the data from st that we use to check whether a file 643 * might have changed. 644 */ 645extern void fill_stat_data(struct stat_data *sd, struct stat *st); 646 647/* 648 * Return 0 if st is consistent with a file not having been changed 649 * since sd was filled. If there are differences, return a 650 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 651 * INODE_CHANGED, and DATA_CHANGED. 652 */ 653extern int match_stat_data(const struct stat_data *sd, struct stat *st); 654extern int match_stat_data_racy(const struct index_state *istate, 655 const struct stat_data *sd, struct stat *st); 656 657extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st); 658 659#define REFRESH_REALLY 0x0001 /* ignore_valid */ 660#define REFRESH_UNMERGED 0x0002 /* allow unmerged */ 661#define REFRESH_QUIET 0x0004 /* be quiet about it */ 662#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */ 663#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */ 664#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */ 665extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg); 666extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int); 667 668extern void update_index_if_able(struct index_state *, struct lock_file *); 669 670extern int hold_locked_index(struct lock_file *, int); 671extern void set_alternate_index_output(const char *); 672 673/* Environment bits from configuration mechanism */ 674extern int trust_executable_bit; 675extern int trust_ctime; 676extern int check_stat; 677extern int quote_path_fully; 678extern int has_symlinks; 679extern int minimum_abbrev, default_abbrev; 680extern int ignore_case; 681extern int assume_unchanged; 682extern int prefer_symlink_refs; 683extern int log_all_ref_updates; 684extern int warn_ambiguous_refs; 685extern int warn_on_object_refname_ambiguity; 686extern const char *apply_default_whitespace; 687extern const char *apply_default_ignorewhitespace; 688extern const char *git_attributes_file; 689extern const char *git_hooks_path; 690extern int zlib_compression_level; 691extern int core_compression_level; 692extern int core_compression_seen; 693extern size_t packed_git_window_size; 694extern size_t packed_git_limit; 695extern size_t delta_base_cache_limit; 696extern unsigned long big_file_threshold; 697extern unsigned long pack_size_limit_cfg; 698 699/* 700 * Accessors for the core.sharedrepository config which lazy-load the value 701 * from the config (if not already set). The "reset" function can be 702 * used to unset "set" or cached value, meaning that the value will be loaded 703 * fresh from the config file on the next call to get_shared_repository(). 704 */ 705void set_shared_repository(int value); 706int get_shared_repository(void); 707void reset_shared_repository(void); 708 709/* 710 * Do replace refs need to be checked this run? This variable is 711 * initialized to true unless --no-replace-object is used or 712 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 713 * commands that do not want replace references to be active. As an 714 * optimization it is also set to false if replace references have 715 * been sought but there were none. 716 */ 717extern int check_replace_refs; 718extern char *git_replace_ref_base; 719 720extern int fsync_object_files; 721extern int core_preload_index; 722extern int core_apply_sparse_checkout; 723extern int precomposed_unicode; 724extern int protect_hfs; 725extern int protect_ntfs; 726extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env; 727 728/* 729 * Include broken refs in all ref iterations, which will 730 * generally choke dangerous operations rather than letting 731 * them silently proceed without taking the broken ref into 732 * account. 733 */ 734extern int ref_paranoia; 735 736/* 737 * The character that begins a commented line in user-editable file 738 * that is subject to stripspace. 739 */ 740extern char comment_line_char; 741extern int auto_comment_line_char; 742 743/* Windows only */ 744enum hide_dotfiles_type { 745 HIDE_DOTFILES_FALSE = 0, 746 HIDE_DOTFILES_TRUE, 747 HIDE_DOTFILES_DOTGITONLY 748}; 749extern enum hide_dotfiles_type hide_dotfiles; 750 751enum branch_track { 752 BRANCH_TRACK_UNSPECIFIED = -1, 753 BRANCH_TRACK_NEVER = 0, 754 BRANCH_TRACK_REMOTE, 755 BRANCH_TRACK_ALWAYS, 756 BRANCH_TRACK_EXPLICIT, 757 BRANCH_TRACK_OVERRIDE 758}; 759 760enum rebase_setup_type { 761 AUTOREBASE_NEVER = 0, 762 AUTOREBASE_LOCAL, 763 AUTOREBASE_REMOTE, 764 AUTOREBASE_ALWAYS 765}; 766 767enum push_default_type { 768 PUSH_DEFAULT_NOTHING = 0, 769 PUSH_DEFAULT_MATCHING, 770 PUSH_DEFAULT_SIMPLE, 771 PUSH_DEFAULT_UPSTREAM, 772 PUSH_DEFAULT_CURRENT, 773 PUSH_DEFAULT_UNSPECIFIED 774}; 775 776extern enum branch_track git_branch_track; 777extern enum rebase_setup_type autorebase; 778extern enum push_default_type push_default; 779 780enum object_creation_mode { 781 OBJECT_CREATION_USES_HARDLINKS = 0, 782 OBJECT_CREATION_USES_RENAMES = 1 783}; 784 785extern enum object_creation_mode object_creation_mode; 786 787extern char *notes_ref_name; 788 789extern int grafts_replace_parents; 790 791/* 792 * GIT_REPO_VERSION is the version we write by default. The 793 * _READ variant is the highest number we know how to 794 * handle. 795 */ 796#define GIT_REPO_VERSION 0 797#define GIT_REPO_VERSION_READ 1 798extern int repository_format_precious_objects; 799 800struct repository_format { 801 int version; 802 int precious_objects; 803 int is_bare; 804 char *work_tree; 805 struct string_list unknown_extensions; 806}; 807 808/* 809 * Read the repository format characteristics from the config file "path" into 810 * "format" struct. Returns the numeric version. On error, -1 is returned, 811 * format->version is set to -1, and all other fields in the struct are 812 * undefined. 813 */ 814int read_repository_format(struct repository_format *format, const char *path); 815 816/* 817 * Verify that the repository described by repository_format is something we 818 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 819 * any errors encountered. 820 */ 821int verify_repository_format(const struct repository_format *format, 822 struct strbuf *err); 823 824/* 825 * Check the repository format version in the path found in get_git_dir(), 826 * and die if it is a version we don't understand. Generally one would 827 * set_git_dir() before calling this, and use it only for "are we in a valid 828 * repo?". 829 */ 830extern void check_repository_format(void); 831 832#define MTIME_CHANGED 0x0001 833#define CTIME_CHANGED 0x0002 834#define OWNER_CHANGED 0x0004 835#define MODE_CHANGED 0x0008 836#define INODE_CHANGED 0x0010 837#define DATA_CHANGED 0x0020 838#define TYPE_CHANGED 0x0040 839 840/* 841 * Return a statically allocated filename, either generically (mkpath), in 842 * the repository directory (git_path), or in a submodule's repository 843 * directory (git_path_submodule). In all cases, note that the result 844 * may be overwritten by another call to _any_ of the functions. Consider 845 * using the safer "dup" or "strbuf" formats below (in some cases, the 846 * unsafe versions have already been removed). 847 */ 848extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 849extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 850extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 851 852extern char *mksnpath(char *buf, size_t n, const char *fmt, ...) 853 __attribute__((format (printf, 3, 4))); 854extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...) 855 __attribute__((format (printf, 2, 3))); 856extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...) 857 __attribute__((format (printf, 2, 3))); 858extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...) 859 __attribute__((format (printf, 2, 3))); 860extern int strbuf_git_path_submodule(struct strbuf *sb, const char *path, 861 const char *fmt, ...) 862 __attribute__((format (printf, 3, 4))); 863extern char *git_pathdup(const char *fmt, ...) 864 __attribute__((format (printf, 1, 2))); 865extern char *mkpathdup(const char *fmt, ...) 866 __attribute__((format (printf, 1, 2))); 867extern char *git_pathdup_submodule(const char *path, const char *fmt, ...) 868 __attribute__((format (printf, 2, 3))); 869 870extern void report_linked_checkout_garbage(void); 871 872/* 873 * You can define a static memoized git path like: 874 * 875 * static GIT_PATH_FUNC(git_path_foo, "FOO"); 876 * 877 * or use one of the global ones below. 878 */ 879#define GIT_PATH_FUNC(func, filename) \ 880 const char *func(void) \ 881 { \ 882 static char *ret; \ 883 if (!ret) \ 884 ret = git_pathdup(filename); \ 885 return ret; \ 886 } 887 888const char *git_path_cherry_pick_head(void); 889const char *git_path_revert_head(void); 890const char *git_path_squash_msg(void); 891const char *git_path_merge_msg(void); 892const char *git_path_merge_rr(void); 893const char *git_path_merge_mode(void); 894const char *git_path_merge_head(void); 895const char *git_path_fetch_head(void); 896const char *git_path_shallow(void); 897 898/* 899 * Return the name of the file in the local object database that would 900 * be used to store a loose object with the specified sha1. The 901 * return value is a pointer to a statically allocated buffer that is 902 * overwritten each time the function is called. 903 */ 904extern const char *sha1_file_name(const unsigned char *sha1); 905 906/* 907 * Return the name of the (local) packfile with the specified sha1 in 908 * its name. The return value is a pointer to memory that is 909 * overwritten each time this function is called. 910 */ 911extern char *sha1_pack_name(const unsigned char *sha1); 912 913/* 914 * Return the name of the (local) pack index file with the specified 915 * sha1 in its name. The return value is a pointer to memory that is 916 * overwritten each time this function is called. 917 */ 918extern char *sha1_pack_index_name(const unsigned char *sha1); 919 920/* 921 * Return an abbreviated sha1 unique within this repository's object database. 922 * The result will be at least `len` characters long, and will be NUL 923 * terminated. 924 * 925 * The non-`_r` version returns a static buffer which remains valid until 4 926 * more calls to find_unique_abbrev are made. 927 * 928 * The `_r` variant writes to a buffer supplied by the caller, which must be at 929 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes 930 * written (excluding the NUL terminator). 931 * 932 * Note that while this version avoids the static buffer, it is not fully 933 * reentrant, as it calls into other non-reentrant git code. 934 */ 935extern const char *find_unique_abbrev(const unsigned char *sha1, int len); 936extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len); 937 938extern const unsigned char null_sha1[GIT_SHA1_RAWSZ]; 939extern const struct object_id null_oid; 940 941static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2) 942{ 943 int i; 944 945 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) { 946 if (*sha1 != *sha2) 947 return *sha1 - *sha2; 948 } 949 950 return 0; 951} 952 953static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2) 954{ 955 return hashcmp(oid1->hash, oid2->hash); 956} 957 958static inline int is_null_sha1(const unsigned char *sha1) 959{ 960 return !hashcmp(sha1, null_sha1); 961} 962 963static inline int is_null_oid(const struct object_id *oid) 964{ 965 return !hashcmp(oid->hash, null_sha1); 966} 967 968static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src) 969{ 970 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ); 971} 972 973static inline void oidcpy(struct object_id *dst, const struct object_id *src) 974{ 975 hashcpy(dst->hash, src->hash); 976} 977 978static inline void hashclr(unsigned char *hash) 979{ 980 memset(hash, 0, GIT_SHA1_RAWSZ); 981} 982 983static inline void oidclr(struct object_id *oid) 984{ 985 hashclr(oid->hash); 986} 987 988 989#define EMPTY_TREE_SHA1_HEX \ 990 "4b825dc642cb6eb9a060e54bf8d69288fbee4904" 991#define EMPTY_TREE_SHA1_BIN_LITERAL \ 992 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \ 993 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04" 994extern const struct object_id empty_tree_oid; 995#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash) 996 997#define EMPTY_BLOB_SHA1_HEX \ 998 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391" 999#define EMPTY_BLOB_SHA1_BIN_LITERAL \1000 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \1001 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"1002extern const struct object_id empty_blob_oid;1003#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)100410051006static inline int is_empty_blob_sha1(const unsigned char *sha1)1007{1008 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);1009}10101011static inline int is_empty_blob_oid(const struct object_id *oid)1012{1013 return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);1014}10151016static inline int is_empty_tree_sha1(const unsigned char *sha1)1017{1018 return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN);1019}10201021static inline int is_empty_tree_oid(const struct object_id *oid)1022{1023 return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);1024}102510261027int git_mkstemp(char *path, size_t n, const char *template);10281029/* set default permissions by passing mode arguments to open(2) */1030int git_mkstemps_mode(char *pattern, int suffix_len, int mode);1031int git_mkstemp_mode(char *pattern, int mode);10321033/*1034 * NOTE NOTE NOTE!!1035 *1036 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1037 * not be changed. Old repositories have core.sharedrepository written in1038 * numeric format, and therefore these values are preserved for compatibility1039 * reasons.1040 */1041enum sharedrepo {1042 PERM_UMASK = 0,1043 OLD_PERM_GROUP = 1,1044 OLD_PERM_EVERYBODY = 2,1045 PERM_GROUP = 0660,1046 PERM_EVERYBODY = 06641047};1048int git_config_perm(const char *var, const char *value);1049int adjust_shared_perm(const char *path);10501051/*1052 * Create the directory containing the named path, using care to be1053 * somewhat safe against races. Return one of the scld_error values1054 * to indicate success/failure.1055 *1056 * SCLD_VANISHED indicates that one of the ancestor directories of the1057 * path existed at one point during the function call and then1058 * suddenly vanished, probably because another process pruned the1059 * directory while we were working. To be robust against this kind of1060 * race, callers might want to try invoking the function again when it1061 * returns SCLD_VANISHED.1062 *1063 * safe_create_leading_directories() temporarily changes path while it1064 * is working but restores it before returning.1065 * safe_create_leading_directories_const() doesn't modify path, even1066 * temporarily.1067 */1068enum scld_error {1069 SCLD_OK = 0,1070 SCLD_FAILED = -1,1071 SCLD_PERMS = -2,1072 SCLD_EXISTS = -3,1073 SCLD_VANISHED = -41074};1075enum scld_error safe_create_leading_directories(char *path);1076enum scld_error safe_create_leading_directories_const(const char *path);10771078int mkdir_in_gitdir(const char *path);1079extern char *expand_user_path(const char *path);1080const char *enter_repo(const char *path, int strict);1081static inline int is_absolute_path(const char *path)1082{1083 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);1084}1085int is_directory(const char *);1086const char *real_path(const char *path);1087const char *real_path_if_valid(const char *path);1088const char *absolute_path(const char *path);1089const char *remove_leading_path(const char *in, const char *prefix);1090const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);1091int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);1092int normalize_path_copy(char *dst, const char *src);1093int longest_ancestor_length(const char *path, struct string_list *prefixes);1094char *strip_path_suffix(const char *path, const char *suffix);1095int daemon_avoid_alias(const char *path);1096extern int is_ntfs_dotgit(const char *name);10971098/**1099 * Return a newly allocated string with the evaluation of1100 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1101 * "$HOME/.config/git/$filename". Return NULL upon error.1102 */1103extern char *xdg_config_home(const char *filename);11041105/* object replacement */1106#define LOOKUP_REPLACE_OBJECT 11107#define LOOKUP_UNKNOWN_OBJECT 21108extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);1109static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)1110{1111 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);1112}11131114/*1115 * This internal function is only declared here for the benefit of1116 * lookup_replace_object(). Please do not call it directly.1117 */1118extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);11191120/*1121 * If object sha1 should be replaced, return the replacement object's1122 * name (replaced recursively, if necessary). The return value is1123 * either sha1 or a pointer to a permanently-allocated value. When1124 * object replacement is suppressed, always return sha1.1125 */1126static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)1127{1128 if (!check_replace_refs)1129 return sha1;1130 return do_lookup_replace_object(sha1);1131}11321133static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)1134{1135 if (!(flag & LOOKUP_REPLACE_OBJECT))1136 return sha1;1137 return lookup_replace_object(sha1);1138}11391140/* Read and unpack a sha1 file into memory, write memory to a sha1 file */1141extern int sha1_object_info(const unsigned char *, unsigned long *);1142extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);1143extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);1144extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);1145extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);1146extern int force_object_loose(const unsigned char *sha1, time_t mtime);1147extern int git_open(const char *name);1148extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);1149extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);1150extern int parse_sha1_header(const char *hdr, unsigned long *sizep);11511152/* global flag to enable extra checks when accessing packed objects */1153extern int do_check_packed_object_crc;11541155extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);11561157extern int finalize_object_file(const char *tmpfile, const char *filename);11581159extern int has_sha1_pack(const unsigned char *sha1);11601161/*1162 * Return true iff we have an object named sha1, whether local or in1163 * an alternate object database, and whether packed or loose. This1164 * function does not respect replace references.1165 *1166 * If the QUICK flag is set, do not re-check the pack directory1167 * when we cannot find the object (this means we may give a false1168 * negative answer if another process is simultaneously repacking).1169 */1170#define HAS_SHA1_QUICK 0x11171extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);1172static inline int has_sha1_file(const unsigned char *sha1)1173{1174 return has_sha1_file_with_flags(sha1, 0);1175}11761177/* Same as the above, except for struct object_id. */1178extern int has_object_file(const struct object_id *oid);1179extern int has_object_file_with_flags(const struct object_id *oid, int flags);11801181/*1182 * Return true iff an alternate object database has a loose object1183 * with the specified name. This function does not respect replace1184 * references.1185 */1186extern int has_loose_object_nonlocal(const unsigned char *sha1);11871188extern int has_pack_index(const unsigned char *sha1);11891190extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);11911192extern const signed char hexval_table[256];1193static inline unsigned int hexval(unsigned char c)1194{1195 return hexval_table[c];1196}11971198/*1199 * Convert two consecutive hexadecimal digits into a char. Return a1200 * negative value on error. Don't run over the end of short strings.1201 */1202static inline int hex2chr(const char *s)1203{1204 int val = hexval(s[0]);1205 return (val < 0) ? val : (val << 4) | hexval(s[1]);1206}12071208/* Convert to/from hex/sha1 representation */1209#define MINIMUM_ABBREV minimum_abbrev1210#define DEFAULT_ABBREV default_abbrev12111212/* used when the code does not know or care what the default abbrev is */1213#define FALLBACK_DEFAULT_ABBREV 712141215struct object_context {1216 unsigned char tree[20];1217 char path[PATH_MAX];1218 unsigned mode;1219 /*1220 * symlink_path is only used by get_tree_entry_follow_symlinks,1221 * and only for symlinks that point outside the repository.1222 */1223 struct strbuf symlink_path;1224};12251226#define GET_SHA1_QUIETLY 011227#define GET_SHA1_COMMIT 021228#define GET_SHA1_COMMITTISH 041229#define GET_SHA1_TREE 0101230#define GET_SHA1_TREEISH 0201231#define GET_SHA1_BLOB 0401232#define GET_SHA1_FOLLOW_SYMLINKS 01001233#define GET_SHA1_ONLY_TO_DIE 0400012341235#define GET_SHA1_DISAMBIGUATORS \1236 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \1237 GET_SHA1_TREE | GET_SHA1_TREEISH | \1238 GET_SHA1_BLOB)12391240extern int get_sha1(const char *str, unsigned char *sha1);1241extern int get_sha1_commit(const char *str, unsigned char *sha1);1242extern int get_sha1_committish(const char *str, unsigned char *sha1);1243extern int get_sha1_tree(const char *str, unsigned char *sha1);1244extern int get_sha1_treeish(const char *str, unsigned char *sha1);1245extern int get_sha1_blob(const char *str, unsigned char *sha1);1246extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);1247extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);12481249extern int get_oid(const char *str, struct object_id *oid);12501251typedef int each_abbrev_fn(const unsigned char *sha1, void *);1252extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);12531254extern int set_disambiguate_hint_config(const char *var, const char *value);12551256/*1257 * Try to read a SHA1 in hexadecimal format from the 40 characters1258 * starting at hex. Write the 20-byte result to sha1 in binary form.1259 * Return 0 on success. Reading stops if a NUL is encountered in the1260 * input, so it is safe to pass this function an arbitrary1261 * null-terminated string.1262 */1263extern int get_sha1_hex(const char *hex, unsigned char *sha1);1264extern int get_oid_hex(const char *hex, struct object_id *sha1);12651266/*1267 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1268 * and writes the NUL-terminated output to the buffer `out`, which must be at1269 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1270 * convenience.1271 *1272 * The non-`_r` variant returns a static buffer, but uses a ring of 41273 * buffers, making it safe to make multiple calls for a single statement, like:1274 *1275 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1276 */1277extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);1278extern char *oid_to_hex_r(char *out, const struct object_id *oid);1279extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */1280extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */12811282extern int interpret_branch_name(const char *str, int len, struct strbuf *);1283extern int get_oid_mb(const char *str, struct object_id *oid);12841285extern int validate_headref(const char *ref);12861287extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1288extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1289extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);1290extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);12911292extern void *read_object_with_reference(const unsigned char *sha1,1293 const char *required_type,1294 unsigned long *size,1295 unsigned char *sha1_ret);12961297extern struct object *peel_to_type(const char *name, int namelen,1298 struct object *o, enum object_type);12991300struct date_mode {1301 enum date_mode_type {1302 DATE_NORMAL = 0,1303 DATE_RELATIVE,1304 DATE_SHORT,1305 DATE_ISO8601,1306 DATE_ISO8601_STRICT,1307 DATE_RFC2822,1308 DATE_STRFTIME,1309 DATE_RAW,1310 DATE_UNIX1311 } type;1312 const char *strftime_fmt;1313 int local;1314};13151316/*1317 * Convenience helper for passing a constant type, like:1318 *1319 * show_date(t, tz, DATE_MODE(NORMAL));1320 */1321#define DATE_MODE(t) date_mode_from_type(DATE_##t)1322struct date_mode *date_mode_from_type(enum date_mode_type type);13231324const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);1325void show_date_relative(unsigned long time, int tz, const struct timeval *now,1326 struct strbuf *timebuf);1327int parse_date(const char *date, struct strbuf *out);1328int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);1329int parse_expiry_date(const char *date, unsigned long *timestamp);1330void datestamp(struct strbuf *out);1331#define approxidate(s) approxidate_careful((s), NULL)1332unsigned long approxidate_careful(const char *, int *);1333unsigned long approxidate_relative(const char *date, const struct timeval *now);1334void parse_date_format(const char *format, struct date_mode *mode);1335int date_overflows(unsigned long date);13361337#define IDENT_STRICT 11338#define IDENT_NO_DATE 21339#define IDENT_NO_NAME 41340extern const char *git_author_info(int);1341extern const char *git_committer_info(int);1342extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);1343extern const char *fmt_name(const char *name, const char *email);1344extern const char *ident_default_name(void);1345extern const char *ident_default_email(void);1346extern const char *git_editor(void);1347extern const char *git_pager(int stdout_is_tty);1348extern int git_ident_config(const char *, const char *, void *);1349extern void reset_ident_date(void);13501351struct ident_split {1352 const char *name_begin;1353 const char *name_end;1354 const char *mail_begin;1355 const char *mail_end;1356 const char *date_begin;1357 const char *date_end;1358 const char *tz_begin;1359 const char *tz_end;1360};1361/*1362 * Signals an success with 0, but time part of the result may be NULL1363 * if the input lacks timestamp and zone1364 */1365extern int split_ident_line(struct ident_split *, const char *, int);13661367/*1368 * Like show_date, but pull the timestamp and tz parameters from1369 * the ident_split. It will also sanity-check the values and produce1370 * a well-known sentinel date if they appear bogus.1371 */1372const char *show_ident_date(const struct ident_split *id,1373 const struct date_mode *mode);13741375/*1376 * Compare split idents for equality or strict ordering. Note that we1377 * compare only the ident part of the line, ignoring any timestamp.1378 *1379 * Because there are two fields, we must choose one as the primary key; we1380 * currently arbitrarily pick the email.1381 */1382extern int ident_cmp(const struct ident_split *, const struct ident_split *);13831384struct checkout {1385 struct index_state *istate;1386 const char *base_dir;1387 int base_dir_len;1388 unsigned force:1,1389 quiet:1,1390 not_new:1,1391 refresh_cache:1;1392};1393#define CHECKOUT_INIT { NULL, "" }13941395#define TEMPORARY_FILENAME_LENGTH 251396extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);13971398struct cache_def {1399 struct strbuf path;1400 int flags;1401 int track_flags;1402 int prefix_len_stat_func;1403};1404#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1405static inline void cache_def_clear(struct cache_def *cache)1406{1407 strbuf_release(&cache->path);1408}14091410extern int has_symlink_leading_path(const char *name, int len);1411extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);1412extern int check_leading_path(const char *name, int len);1413extern int has_dirs_only_path(const char *name, int len, int prefix_len);1414extern void schedule_dir_for_removal(const char *name, int len);1415extern void remove_scheduled_dirs(void);14161417extern struct alternate_object_database {1418 struct alternate_object_database *next;14191420 /* see alt_scratch_buf() */1421 struct strbuf scratch;1422 size_t base_len;14231424 char path[FLEX_ARRAY];1425} *alt_odb_list;1426extern void prepare_alt_odb(void);1427extern void read_info_alternates(const char * relative_base, int depth);1428extern char *compute_alternate_path(const char *path, struct strbuf *err);1429typedef int alt_odb_fn(struct alternate_object_database *, void *);1430extern int foreach_alt_odb(alt_odb_fn, void*);14311432/*1433 * Allocate a "struct alternate_object_database" but do _not_ actually1434 * add it to the list of alternates.1435 */1436struct alternate_object_database *alloc_alt_odb(const char *dir);14371438/*1439 * Add the directory to the on-disk alternates file; the new entry will also1440 * take effect in the current process.1441 */1442extern void add_to_alternates_file(const char *dir);14431444/*1445 * Add the directory to the in-memory list of alternates (along with any1446 * recursive alternates it points to), but do not modify the on-disk alternates1447 * file.1448 */1449extern void add_to_alternates_memory(const char *dir);14501451/*1452 * Returns a scratch strbuf pre-filled with the alternate object directory,1453 * including a trailing slash, which can be used to access paths in the1454 * alternate. Always use this over direct access to alt->scratch, as it1455 * cleans up any previous use of the scratch buffer.1456 */1457extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);14581459struct pack_window {1460 struct pack_window *next;1461 unsigned char *base;1462 off_t offset;1463 size_t len;1464 unsigned int last_used;1465 unsigned int inuse_cnt;1466};14671468extern struct packed_git {1469 struct packed_git *next;1470 struct pack_window *windows;1471 off_t pack_size;1472 const void *index_data;1473 size_t index_size;1474 uint32_t num_objects;1475 uint32_t num_bad_objects;1476 unsigned char *bad_object_sha1;1477 int index_version;1478 time_t mtime;1479 int pack_fd;1480 unsigned pack_local:1,1481 pack_keep:1,1482 freshened:1,1483 do_not_close:1;1484 unsigned char sha1[20];1485 struct revindex_entry *revindex;1486 /* something like ".git/objects/pack/xxxxx.pack" */1487 char pack_name[FLEX_ARRAY]; /* more */1488} *packed_git;14891490/*1491 * A most-recently-used ordered version of the packed_git list, which can1492 * be iterated instead of packed_git (and marked via mru_mark).1493 */1494struct mru;1495extern struct mru *packed_git_mru;14961497struct pack_entry {1498 off_t offset;1499 unsigned char sha1[20];1500 struct packed_git *p;1501};15021503extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);15041505/* A hook to report invalid files in pack directory */1506#define PACKDIR_FILE_PACK 11507#define PACKDIR_FILE_IDX 21508#define PACKDIR_FILE_GARBAGE 41509extern void (*report_garbage)(unsigned seen_bits, const char *path);15101511extern void prepare_packed_git(void);1512extern void reprepare_packed_git(void);1513extern void install_packed_git(struct packed_git *pack);15141515/*1516 * Give a rough count of objects in the repository. This sacrifices accuracy1517 * for speed.1518 */1519unsigned long approximate_object_count(void);15201521extern struct packed_git *find_sha1_pack(const unsigned char *sha1,1522 struct packed_git *packs);15231524extern void pack_report(void);15251526/*1527 * mmap the index file for the specified packfile (if it is not1528 * already mmapped). Return 0 on success.1529 */1530extern int open_pack_index(struct packed_git *);15311532/*1533 * munmap the index file for the specified packfile (if it is1534 * currently mmapped).1535 */1536extern void close_pack_index(struct packed_git *);15371538extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);1539extern void close_pack_windows(struct packed_git *);1540extern void close_all_packs(void);1541extern void unuse_pack(struct pack_window **);1542extern void clear_delta_base_cache(void);1543extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);15441545/*1546 * Make sure that a pointer access into an mmap'd index file is within bounds,1547 * and can provide at least 8 bytes of data.1548 *1549 * Note that this is only necessary for variable-length segments of the file1550 * (like the 64-bit extended offset table), as we compare the size to the1551 * fixed-length parts when we open the file.1552 */1553extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);15541555/*1556 * Return the SHA-1 of the nth object within the specified packfile.1557 * Open the index if it is not already open. The return value points1558 * at the SHA-1 within the mmapped index. Return NULL if there is an1559 * error.1560 */1561extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);15621563/*1564 * Return the offset of the nth object within the specified packfile.1565 * The index must already be opened.1566 */1567extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);15681569/*1570 * If the object named sha1 is present in the specified packfile,1571 * return its offset within the packfile; otherwise, return 0.1572 */1573extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);15741575extern int is_pack_valid(struct packed_git *);1576extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);1577extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);1578extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);1579extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);15801581/*1582 * Iterate over the files in the loose-object parts of the object1583 * directory "path", triggering the following callbacks:1584 *1585 * - loose_object is called for each loose object we find.1586 *1587 * - loose_cruft is called for any files that do not appear to be1588 * loose objects. Note that we only look in the loose object1589 * directories "objects/[0-9a-f]{2}/", so we will not report1590 * "objects/foobar" as cruft.1591 *1592 * - loose_subdir is called for each top-level hashed subdirectory1593 * of the object directory (e.g., "$OBJDIR/f0"). It is called1594 * after the objects in the directory are processed.1595 *1596 * Any callback that is NULL will be ignored. Callbacks returning non-zero1597 * will end the iteration.1598 *1599 * In the "buf" variant, "path" is a strbuf which will also be used as a1600 * scratch buffer, but restored to its original contents before1601 * the function returns.1602 */1603typedef int each_loose_object_fn(const unsigned char *sha1,1604 const char *path,1605 void *data);1606typedef int each_loose_cruft_fn(const char *basename,1607 const char *path,1608 void *data);1609typedef int each_loose_subdir_fn(int nr,1610 const char *path,1611 void *data);1612int for_each_loose_file_in_objdir(const char *path,1613 each_loose_object_fn obj_cb,1614 each_loose_cruft_fn cruft_cb,1615 each_loose_subdir_fn subdir_cb,1616 void *data);1617int for_each_loose_file_in_objdir_buf(struct strbuf *path,1618 each_loose_object_fn obj_cb,1619 each_loose_cruft_fn cruft_cb,1620 each_loose_subdir_fn subdir_cb,1621 void *data);16221623/*1624 * Iterate over loose and packed objects in both the local1625 * repository and any alternates repositories (unless the1626 * LOCAL_ONLY flag is set).1627 */1628#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11629typedef int each_packed_object_fn(const unsigned char *sha1,1630 struct packed_git *pack,1631 uint32_t pos,1632 void *data);1633extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);1634extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);16351636struct object_info {1637 /* Request */1638 enum object_type *typep;1639 unsigned long *sizep;1640 off_t *disk_sizep;1641 unsigned char *delta_base_sha1;1642 struct strbuf *typename;16431644 /* Response */1645 enum {1646 OI_CACHED,1647 OI_LOOSE,1648 OI_PACKED,1649 OI_DBCACHED1650 } whence;1651 union {1652 /*1653 * struct {1654 * ... Nothing to expose in this case1655 * } cached;1656 * struct {1657 * ... Nothing to expose in this case1658 * } loose;1659 */1660 struct {1661 struct packed_git *pack;1662 off_t offset;1663 unsigned int is_delta;1664 } packed;1665 } u;1666};16671668/*1669 * Initializer for a "struct object_info" that wants no items. You may1670 * also memset() the memory to all-zeroes.1671 */1672#define OBJECT_INFO_INIT {NULL}16731674extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);1675extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);16761677/* Dumb servers support */1678extern int update_server_info(int);16791680/* git_config_parse_key() returns these negated: */1681#define CONFIG_INVALID_KEY 11682#define CONFIG_NO_SECTION_OR_NAME 21683/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */1684#define CONFIG_NO_LOCK -11685#define CONFIG_INVALID_FILE 31686#define CONFIG_NO_WRITE 41687#define CONFIG_NOTHING_SET 51688#define CONFIG_INVALID_PATTERN 61689#define CONFIG_GENERIC_ERROR 716901691#define CONFIG_REGEX_NONE ((void *)1)16921693struct git_config_source {1694 unsigned int use_stdin:1;1695 const char *file;1696 const char *blob;1697};16981699enum config_origin_type {1700 CONFIG_ORIGIN_BLOB,1701 CONFIG_ORIGIN_FILE,1702 CONFIG_ORIGIN_STDIN,1703 CONFIG_ORIGIN_SUBMODULE_BLOB,1704 CONFIG_ORIGIN_CMDLINE1705};17061707typedef int (*config_fn_t)(const char *, const char *, void *);1708extern int git_default_config(const char *, const char *, void *);1709extern int git_config_from_file(config_fn_t fn, const char *, void *);1710extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,1711 const char *name, const char *buf, size_t len, void *data);1712extern void git_config_push_parameter(const char *text);1713extern int git_config_from_parameters(config_fn_t fn, void *data);1714extern void git_config(config_fn_t fn, void *);1715extern int git_config_with_options(config_fn_t fn, void *,1716 struct git_config_source *config_source,1717 int respect_includes);1718extern int git_parse_ulong(const char *, unsigned long *);1719extern int git_parse_maybe_bool(const char *);1720extern int git_config_int(const char *, const char *);1721extern int64_t git_config_int64(const char *, const char *);1722extern unsigned long git_config_ulong(const char *, const char *);1723extern int git_config_bool_or_int(const char *, const char *, int *);1724extern int git_config_bool(const char *, const char *);1725extern int git_config_maybe_bool(const char *, const char *);1726extern int git_config_string(const char **, const char *, const char *);1727extern int git_config_pathname(const char **, const char *, const char *);1728extern int git_config_set_in_file_gently(const char *, const char *, const char *);1729extern void git_config_set_in_file(const char *, const char *, const char *);1730extern int git_config_set_gently(const char *, const char *);1731extern void git_config_set(const char *, const char *);1732extern int git_config_parse_key(const char *, char **, int *);1733extern int git_config_key_is_valid(const char *key);1734extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);1735extern void git_config_set_multivar(const char *, const char *, const char *, int);1736extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);1737extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);1738extern int git_config_rename_section(const char *, const char *);1739extern int git_config_rename_section_in_file(const char *, const char *, const char *);1740extern const char *git_etc_gitconfig(void);1741extern int git_env_bool(const char *, int);1742extern unsigned long git_env_ulong(const char *, unsigned long);1743extern int git_config_system(void);1744extern int config_error_nonbool(const char *);1745#if defined(__GNUC__)1746#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1747#endif1748extern const char *get_log_output_encoding(void);1749extern const char *get_commit_output_encoding(void);17501751extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);17521753enum config_scope {1754 CONFIG_SCOPE_UNKNOWN = 0,1755 CONFIG_SCOPE_SYSTEM,1756 CONFIG_SCOPE_GLOBAL,1757 CONFIG_SCOPE_REPO,1758 CONFIG_SCOPE_CMDLINE,1759};17601761extern enum config_scope current_config_scope(void);1762extern const char *current_config_origin_type(void);1763extern const char *current_config_name(void);17641765struct config_include_data {1766 int depth;1767 config_fn_t fn;1768 void *data;1769};1770#define CONFIG_INCLUDE_INIT { 0 }1771extern int git_config_include(const char *name, const char *value, void *data);17721773/*1774 * Match and parse a config key of the form:1775 *1776 * section.(subsection.)?key1777 *1778 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1779 * we return -1 if it does not match, 0 otherwise. The subsection and key1780 * out-parameters are filled by the function (and subsection is NULL if it is1781 * missing).1782 */1783extern int parse_config_key(const char *var,1784 const char *section,1785 const char **subsection, int *subsection_len,1786 const char **key);17871788struct config_set_element {1789 struct hashmap_entry ent;1790 char *key;1791 struct string_list value_list;1792};17931794struct configset_list_item {1795 struct config_set_element *e;1796 int value_index;1797};17981799/*1800 * the contents of the list are ordered according to their1801 * position in the config files and order of parsing the files.1802 * (i.e. key-value pair at the last position of .git/config will1803 * be at the last item of the list)1804 */1805struct configset_list {1806 struct configset_list_item *items;1807 unsigned int nr, alloc;1808};18091810struct config_set {1811 struct hashmap config_hash;1812 int hash_initialized;1813 struct configset_list list;1814};18151816extern void git_configset_init(struct config_set *cs);1817extern int git_configset_add_file(struct config_set *cs, const char *filename);1818extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);1819extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);1820extern void git_configset_clear(struct config_set *cs);1821extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);1822extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);1823extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);1824extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);1825extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);1826extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);1827extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);1828extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);18291830extern int git_config_get_value(const char *key, const char **value);1831extern const struct string_list *git_config_get_value_multi(const char *key);1832extern void git_config_clear(void);1833extern void git_config_iter(config_fn_t fn, void *data);1834extern int git_config_get_string_const(const char *key, const char **dest);1835extern int git_config_get_string(const char *key, char **dest);1836extern int git_config_get_int(const char *key, int *dest);1837extern int git_config_get_ulong(const char *key, unsigned long *dest);1838extern int git_config_get_bool(const char *key, int *dest);1839extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);1840extern int git_config_get_maybe_bool(const char *key, int *dest);1841extern int git_config_get_pathname(const char *key, const char **dest);1842extern int git_config_get_untracked_cache(void);18431844/*1845 * This is a hack for test programs like test-dump-untracked-cache to1846 * ensure that they do not modify the untracked cache when reading it.1847 * Do not use it otherwise!1848 */1849extern int ignore_untracked_cache_config;18501851struct key_value_info {1852 const char *filename;1853 int linenr;1854 enum config_origin_type origin_type;1855 enum config_scope scope;1856};18571858extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));1859extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);18601861extern int committer_ident_sufficiently_given(void);1862extern int author_ident_sufficiently_given(void);18631864extern const char *git_commit_encoding;1865extern const char *git_log_output_encoding;1866extern const char *git_mailmap_file;1867extern const char *git_mailmap_blob;18681869/* IO helper functions */1870extern void maybe_flush_or_die(FILE *, const char *);1871__attribute__((format (printf, 2, 3)))1872extern void fprintf_or_die(FILE *, const char *fmt, ...);18731874#define COPY_READ_ERROR (-2)1875#define COPY_WRITE_ERROR (-3)1876extern int copy_fd(int ifd, int ofd);1877extern int copy_file(const char *dst, const char *src, int mode);1878extern int copy_file_with_time(const char *dst, const char *src, int mode);18791880extern void write_or_die(int fd, const void *buf, size_t count);1881extern void fsync_or_die(int fd, const char *);18821883extern ssize_t read_in_full(int fd, void *buf, size_t count);1884extern ssize_t write_in_full(int fd, const void *buf, size_t count);1885extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);18861887static inline ssize_t write_str_in_full(int fd, const char *str)1888{1889 return write_in_full(fd, str, strlen(str));1890}18911892/**1893 * Open (and truncate) the file at path, write the contents of buf to it,1894 * and close it. Dies if any errors are encountered.1895 */1896extern void write_file_buf(const char *path, const char *buf, size_t len);18971898/**1899 * Like write_file_buf(), but format the contents into a buffer first.1900 * Additionally, write_file() will append a newline if one is not already1901 * present, making it convenient to write text files:1902 *1903 * write_file(path, "counter: %d", ctr);1904 */1905__attribute__((format (printf, 2, 3)))1906extern void write_file(const char *path, const char *fmt, ...);19071908/* pager.c */1909extern void setup_pager(void);1910extern int pager_in_use(void);1911extern int pager_use_color;1912extern int term_columns(void);1913extern int decimal_width(uintmax_t);1914extern int check_pager_config(const char *cmd);1915extern void prepare_pager_args(struct child_process *, const char *pager);19161917extern const char *editor_program;1918extern const char *askpass_program;1919extern const char *excludes_file;19201921/* base85 */1922int decode_85(char *dst, const char *line, int linelen);1923void encode_85(char *buf, const unsigned char *data, int bytes);19241925/* alloc.c */1926extern void *alloc_blob_node(void);1927extern void *alloc_tree_node(void);1928extern void *alloc_commit_node(void);1929extern void *alloc_tag_node(void);1930extern void *alloc_object_node(void);1931extern void alloc_report(void);1932extern unsigned int alloc_commit_index(void);19331934/* pkt-line.c */1935void packet_trace_identity(const char *prog);19361937/* add */1938/*1939 * return 0 if success, 1 - if addition of a file failed and1940 * ADD_FILES_IGNORE_ERRORS was specified in flags1941 */1942int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);19431944/* diff.c */1945extern int diff_auto_refresh_index;19461947/* match-trees.c */1948void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);1949void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);19501951/*1952 * whitespace rules.1953 * used by both diff and apply1954 * last two digits are tab width1955 */1956#define WS_BLANK_AT_EOL 01001957#define WS_SPACE_BEFORE_TAB 02001958#define WS_INDENT_WITH_NON_TAB 04001959#define WS_CR_AT_EOL 010001960#define WS_BLANK_AT_EOF 020001961#define WS_TAB_IN_INDENT 040001962#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1963#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1964#define WS_TAB_WIDTH_MASK 0771965extern unsigned whitespace_rule_cfg;1966extern unsigned whitespace_rule(const char *);1967extern unsigned parse_whitespace_rule(const char *);1968extern unsigned ws_check(const char *line, int len, unsigned ws_rule);1969extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);1970extern char *whitespace_error_string(unsigned ws);1971extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);1972extern int ws_blank_line(const char *line, int len, unsigned ws_rule);1973#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)19741975/* ls-files */1976void overlay_tree_on_cache(const char *tree_name, const char *prefix);19771978char *alias_lookup(const char *alias);1979int split_cmdline(char *cmdline, const char ***argv);1980/* Takes a negative value returned by split_cmdline */1981const char *split_cmdline_strerror(int cmdline_errno);19821983/* setup.c */1984struct startup_info {1985 int have_repository;1986 const char *prefix;1987};1988extern struct startup_info *startup_info;19891990/* merge.c */1991struct commit_list;1992int try_merge_command(const char *strategy, size_t xopts_nr,1993 const char **xopts, struct commit_list *common,1994 const char *head_arg, struct commit_list *remotes);1995int checkout_fast_forward(const unsigned char *from,1996 const unsigned char *to,1997 int overwrite_ignore);199819992000int sane_execvp(const char *file, char *const argv[]);20012002/*2003 * A struct to encapsulate the concept of whether a file has changed2004 * since we last checked it. This uses criteria similar to those used2005 * for the index.2006 */2007struct stat_validity {2008 struct stat_data *sd;2009};20102011void stat_validity_clear(struct stat_validity *sv);20122013/*2014 * Returns 1 if the path is a regular file (or a symlink to a regular2015 * file) and matches the saved stat_validity, 0 otherwise. A missing2016 * or inaccessible file is considered a match if the struct was just2017 * initialized, or if the previous update found an inaccessible file.2018 */2019int stat_validity_check(struct stat_validity *sv, const char *path);20202021/*2022 * Update the stat_validity from a file opened at descriptor fd. If2023 * the file is missing, inaccessible, or not a regular file, then2024 * future calls to stat_validity_check will match iff one of those2025 * conditions continues to be true.2026 */2027void stat_validity_update(struct stat_validity *sv, int fd);20282029int versioncmp(const char *s1, const char *s2);2030void sleep_millisec(int millisec);20312032/*2033 * Create a directory and (if share is nonzero) adjust its permissions2034 * according to the shared_repository setting. Only use this for2035 * directories under $GIT_DIR. Don't use it for working tree2036 * directories.2037 */2038void safe_create_dir(const char *dir, int share);20392040#endif /* CACHE_H */