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#include "mem-pool.h" 19 20#include <zlib.h> 21typedef struct git_zstream { 22 z_stream z; 23 unsigned long avail_in; 24 unsigned long avail_out; 25 unsigned long total_in; 26 unsigned long total_out; 27 unsigned char *next_in; 28 unsigned char *next_out; 29} git_zstream; 30 31void git_inflate_init(git_zstream *); 32void git_inflate_init_gzip_only(git_zstream *); 33void git_inflate_end(git_zstream *); 34int git_inflate(git_zstream *, int flush); 35 36void git_deflate_init(git_zstream *, int level); 37void git_deflate_init_gzip(git_zstream *, int level); 38void git_deflate_init_raw(git_zstream *, int level); 39void git_deflate_end(git_zstream *); 40int git_deflate_abort(git_zstream *); 41int git_deflate_end_gently(git_zstream *); 42int git_deflate(git_zstream *, int flush); 43unsigned long git_deflate_bound(git_zstream *, unsigned long); 44 45/* The length in bytes and in hex digits of an object name (SHA-1 value). */ 46#define GIT_SHA1_RAWSZ 20 47#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ) 48 49/* The length in byte and in hex digits of the largest possible hash value. */ 50#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ 51#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ 52 53struct object_id { 54 unsigned char hash[GIT_MAX_RAWSZ]; 55}; 56 57#define the_hash_algo the_repository->hash_algo 58 59#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 60#define DTYPE(de) ((de)->d_type) 61#else 62#undef DT_UNKNOWN 63#undef DT_DIR 64#undef DT_REG 65#undef DT_LNK 66#define DT_UNKNOWN 0 67#define DT_DIR 1 68#define DT_REG 2 69#define DT_LNK 3 70#define DTYPE(de) DT_UNKNOWN 71#endif 72 73/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 74#define S_IFINVALID 0030000 75 76/* 77 * A "directory link" is a link to another git directory. 78 * 79 * The value 0160000 is not normally a valid mode, and 80 * also just happens to be S_IFDIR + S_IFLNK 81 */ 82#define S_IFGITLINK 0160000 83#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 84 85/* 86 * Some mode bits are also used internally for computations. 87 * 88 * They *must* not overlap with any valid modes, and they *must* not be emitted 89 * to outside world - i.e. appear on disk or network. In other words, it's just 90 * temporary fields, which we internally use, but they have to stay in-house. 91 * 92 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 93 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 94 */ 95 96/* used internally in tree-diff */ 97#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 98 99 100/* 101 * Intensive research over the course of many years has shown that 102 * port 9418 is totally unused by anything else. Or 103 * 104 * Your search - "port 9418" - did not match any documents. 105 * 106 * as www.google.com puts it. 107 * 108 * This port has been properly assigned for git use by IANA: 109 * git (Assigned-9418) [I06-050728-0001]. 110 * 111 * git 9418/tcp git pack transfer service 112 * git 9418/udp git pack transfer service 113 * 114 * with Linus Torvalds <torvalds@osdl.org> as the point of 115 * contact. September 2005. 116 * 117 * See http://www.iana.org/assignments/port-numbers 118 */ 119#define DEFAULT_GIT_PORT 9418 120 121/* 122 * Basic data structures for the directory cache 123 */ 124 125#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */ 126struct cache_header { 127 uint32_t hdr_signature; 128 uint32_t hdr_version; 129 uint32_t hdr_entries; 130}; 131 132#define INDEX_FORMAT_LB 2 133#define INDEX_FORMAT_UB 4 134 135/* 136 * The "cache_time" is just the low 32 bits of the 137 * time. It doesn't matter if it overflows - we only 138 * check it for equality in the 32 bits we save. 139 */ 140struct cache_time { 141 uint32_t sec; 142 uint32_t nsec; 143}; 144 145struct stat_data { 146 struct cache_time sd_ctime; 147 struct cache_time sd_mtime; 148 unsigned int sd_dev; 149 unsigned int sd_ino; 150 unsigned int sd_uid; 151 unsigned int sd_gid; 152 unsigned int sd_size; 153}; 154 155struct cache_entry { 156 struct hashmap_entry ent; 157 struct stat_data ce_stat_data; 158 unsigned int ce_mode; 159 unsigned int ce_flags; 160 unsigned int mem_pool_allocated; 161 unsigned int ce_namelen; 162 unsigned int index; /* for link extension */ 163 struct object_id oid; 164 char name[FLEX_ARRAY]; /* more */ 165}; 166 167#define CE_STAGEMASK (0x3000) 168#define CE_EXTENDED (0x4000) 169#define CE_VALID (0x8000) 170#define CE_STAGESHIFT 12 171 172/* 173 * Range 0xFFFF0FFF in ce_flags is divided into 174 * two parts: in-memory flags and on-disk ones. 175 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 176 * if you want to save a new flag, add it in 177 * CE_EXTENDED_FLAGS 178 * 179 * In-memory only flags 180 */ 181#define CE_UPDATE (1 << 16) 182#define CE_REMOVE (1 << 17) 183#define CE_UPTODATE (1 << 18) 184#define CE_ADDED (1 << 19) 185 186#define CE_HASHED (1 << 20) 187#define CE_FSMONITOR_VALID (1 << 21) 188#define CE_WT_REMOVE (1 << 22) /* remove in work directory */ 189#define CE_CONFLICTED (1 << 23) 190 191#define CE_UNPACKED (1 << 24) 192#define CE_NEW_SKIP_WORKTREE (1 << 25) 193 194/* used to temporarily mark paths matched by pathspecs */ 195#define CE_MATCHED (1 << 26) 196 197#define CE_UPDATE_IN_BASE (1 << 27) 198#define CE_STRIP_NAME (1 << 28) 199 200/* 201 * Extended on-disk flags 202 */ 203#define CE_INTENT_TO_ADD (1 << 29) 204#define CE_SKIP_WORKTREE (1 << 30) 205/* CE_EXTENDED2 is for future extension */ 206#define CE_EXTENDED2 (1U << 31) 207 208#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 209 210/* 211 * Safeguard to avoid saving wrong flags: 212 * - CE_EXTENDED2 won't get saved until its semantic is known 213 * - Bits in 0x0000FFFF have been saved in ce_flags already 214 * - Bits in 0x003F0000 are currently in-memory flags 215 */ 216#if CE_EXTENDED_FLAGS & 0x803FFFFF 217#error "CE_EXTENDED_FLAGS out of range" 218#endif 219 220/* Forward structure decls */ 221struct pathspec; 222struct child_process; 223struct tree; 224 225/* 226 * Copy the sha1 and stat state of a cache entry from one to 227 * another. But we never change the name, or the hash state! 228 */ 229static inline void copy_cache_entry(struct cache_entry *dst, 230 const struct cache_entry *src) 231{ 232 unsigned int state = dst->ce_flags & CE_HASHED; 233 int mem_pool_allocated = dst->mem_pool_allocated; 234 235 /* Don't copy hash chain and name */ 236 memcpy(&dst->ce_stat_data, &src->ce_stat_data, 237 offsetof(struct cache_entry, name) - 238 offsetof(struct cache_entry, ce_stat_data)); 239 240 /* Restore the hash state */ 241 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 242 243 /* Restore the mem_pool_allocated flag */ 244 dst->mem_pool_allocated = mem_pool_allocated; 245} 246 247static inline unsigned create_ce_flags(unsigned stage) 248{ 249 return (stage << CE_STAGESHIFT); 250} 251 252#define ce_namelen(ce) ((ce)->ce_namelen) 253#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 254#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 255#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 256#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 257#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 258#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD) 259 260#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 261static inline unsigned int create_ce_mode(unsigned int mode) 262{ 263 if (S_ISLNK(mode)) 264 return S_IFLNK; 265 if (S_ISDIR(mode) || S_ISGITLINK(mode)) 266 return S_IFGITLINK; 267 return S_IFREG | ce_permissions(mode); 268} 269static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce, 270 unsigned int mode) 271{ 272 extern int trust_executable_bit, has_symlinks; 273 if (!has_symlinks && S_ISREG(mode) && 274 ce && S_ISLNK(ce->ce_mode)) 275 return ce->ce_mode; 276 if (!trust_executable_bit && S_ISREG(mode)) { 277 if (ce && S_ISREG(ce->ce_mode)) 278 return ce->ce_mode; 279 return create_ce_mode(0666); 280 } 281 return create_ce_mode(mode); 282} 283static inline int ce_to_dtype(const struct cache_entry *ce) 284{ 285 unsigned ce_mode = ntohl(ce->ce_mode); 286 if (S_ISREG(ce_mode)) 287 return DT_REG; 288 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode)) 289 return DT_DIR; 290 else if (S_ISLNK(ce_mode)) 291 return DT_LNK; 292 else 293 return DT_UNKNOWN; 294} 295static inline unsigned int canon_mode(unsigned int mode) 296{ 297 if (S_ISREG(mode)) 298 return S_IFREG | ce_permissions(mode); 299 if (S_ISLNK(mode)) 300 return S_IFLNK; 301 if (S_ISDIR(mode)) 302 return S_IFDIR; 303 return S_IFGITLINK; 304} 305 306#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 307 308#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */ 309#define CE_ENTRY_CHANGED (1 << 1) 310#define CE_ENTRY_REMOVED (1 << 2) 311#define CE_ENTRY_ADDED (1 << 3) 312#define RESOLVE_UNDO_CHANGED (1 << 4) 313#define CACHE_TREE_CHANGED (1 << 5) 314#define SPLIT_INDEX_ORDERED (1 << 6) 315#define UNTRACKED_CHANGED (1 << 7) 316#define FSMONITOR_CHANGED (1 << 8) 317 318struct split_index; 319struct untracked_cache; 320 321struct index_state { 322 struct cache_entry **cache; 323 unsigned int version; 324 unsigned int cache_nr, cache_alloc, cache_changed; 325 struct string_list *resolve_undo; 326 struct cache_tree *cache_tree; 327 struct split_index *split_index; 328 struct cache_time timestamp; 329 unsigned name_hash_initialized : 1, 330 initialized : 1, 331 drop_cache_tree : 1; 332 struct hashmap name_hash; 333 struct hashmap dir_hash; 334 struct object_id oid; 335 struct untracked_cache *untracked; 336 uint64_t fsmonitor_last_update; 337 struct ewah_bitmap *fsmonitor_dirty; 338 struct mem_pool *ce_mem_pool; 339}; 340 341extern struct index_state the_index; 342 343/* Name hashing */ 344extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded); 345extern void add_name_hash(struct index_state *istate, struct cache_entry *ce); 346extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce); 347extern void free_name_hash(struct index_state *istate); 348 349 350/* Cache entry creation and cleanup */ 351 352/* 353 * Create cache_entry intended for use in the specified index. Caller 354 * is responsible for discarding the cache_entry with 355 * `discard_cache_entry`. 356 */ 357struct cache_entry *make_cache_entry(struct index_state *istate, 358 unsigned int mode, 359 const struct object_id *oid, 360 const char *path, 361 int stage, 362 unsigned int refresh_options); 363 364struct cache_entry *make_empty_cache_entry(struct index_state *istate, 365 size_t name_len); 366 367/* 368 * Create a cache_entry that is not intended to be added to an index. 369 * Caller is responsible for discarding the cache_entry 370 * with `discard_cache_entry`. 371 */ 372struct cache_entry *make_transient_cache_entry(unsigned int mode, 373 const struct object_id *oid, 374 const char *path, 375 int stage); 376 377struct cache_entry *make_empty_transient_cache_entry(size_t name_len); 378 379/* 380 * Discard cache entry. 381 */ 382void discard_cache_entry(struct cache_entry *ce); 383 384/* 385 * Check configuration if we should perform extra validation on cache 386 * entries. 387 */ 388int should_validate_cache_entries(void); 389 390/* 391 * Duplicate a cache_entry. Allocate memory for the new entry from a 392 * memory_pool. Takes into account cache_entry fields that are meant 393 * for managing the underlying memory allocation of the cache_entry. 394 */ 395struct cache_entry *dup_cache_entry(const struct cache_entry *ce, struct index_state *istate); 396 397/* 398 * Validate the cache entries in the index. This is an internal 399 * consistency check that the cache_entry structs are allocated from 400 * the expected memory pool. 401 */ 402void validate_cache_entries(const struct index_state *istate); 403 404#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 405#define active_cache (the_index.cache) 406#define active_nr (the_index.cache_nr) 407#define active_alloc (the_index.cache_alloc) 408#define active_cache_changed (the_index.cache_changed) 409#define active_cache_tree (the_index.cache_tree) 410 411#define read_cache() read_index(&the_index) 412#define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir())) 413#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 414#define is_cache_unborn() is_index_unborn(&the_index) 415#define read_cache_unmerged() read_index_unmerged(&the_index) 416#define discard_cache() discard_index(&the_index) 417#define unmerged_cache() unmerged_index(&the_index) 418#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 419#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 420#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 421#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 422#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 423#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 424#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 425#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip)) 426#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 427#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 428#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 429#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 430#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 431#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 432#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 433#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 434#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 435#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 436#endif 437 438#define TYPE_BITS 3 439 440/* 441 * Values in this enum (except those outside the 3 bit range) are part 442 * of pack file format. See Documentation/technical/pack-format.txt 443 * for more information. 444 */ 445enum object_type { 446 OBJ_BAD = -1, 447 OBJ_NONE = 0, 448 OBJ_COMMIT = 1, 449 OBJ_TREE = 2, 450 OBJ_BLOB = 3, 451 OBJ_TAG = 4, 452 /* 5 for future expansion */ 453 OBJ_OFS_DELTA = 6, 454 OBJ_REF_DELTA = 7, 455 OBJ_ANY, 456 OBJ_MAX 457}; 458 459static inline enum object_type object_type(unsigned int mode) 460{ 461 return S_ISDIR(mode) ? OBJ_TREE : 462 S_ISGITLINK(mode) ? OBJ_COMMIT : 463 OBJ_BLOB; 464} 465 466/* Double-check local_repo_env below if you add to this list. */ 467#define GIT_DIR_ENVIRONMENT "GIT_DIR" 468#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR" 469#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE" 470#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE" 471#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX" 472#define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX" 473#define DEFAULT_GIT_DIR_ENVIRONMENT ".git" 474#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY" 475#define INDEX_ENVIRONMENT "GIT_INDEX_FILE" 476#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE" 477#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE" 478#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" 479#define CONFIG_ENVIRONMENT "GIT_CONFIG" 480#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS" 481#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH" 482#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES" 483#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS" 484#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE" 485#define GITATTRIBUTES_FILE ".gitattributes" 486#define INFOATTRIBUTES_FILE "info/attributes" 487#define ATTRIBUTE_MACRO_PREFIX "[attr]" 488#define GITMODULES_FILE ".gitmodules" 489#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF" 490#define GIT_NOTES_DEFAULT_REF "refs/notes/commits" 491#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF" 492#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF" 493#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE" 494#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS" 495#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS" 496#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS" 497#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS" 498#define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH" 499#define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS" 500#define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT "GIT_TEXTDOMAINDIR" 501 502/* 503 * Environment variable used in handshaking the wire protocol. 504 * Contains a colon ':' separated list of keys with optional values 505 * 'key[=value]'. Presence of unknown keys and values must be 506 * ignored. 507 */ 508#define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL" 509/* HTTP header used to handshake the wire protocol */ 510#define GIT_PROTOCOL_HEADER "Git-Protocol" 511 512/* 513 * This environment variable is expected to contain a boolean indicating 514 * whether we should or should not treat: 515 * 516 * GIT_DIR=foo.git git ... 517 * 518 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 519 * of this, but we use it internally to communicate to sub-processes that we 520 * are in a bare repo. If not set, defaults to true. 521 */ 522#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE" 523 524/* 525 * Repository-local GIT_* environment variables; these will be cleared 526 * when git spawns a sub-process that runs inside another repository. 527 * The array is NULL-terminated, which makes it easy to pass in the "env" 528 * parameter of a run-command invocation, or to do a simple walk. 529 */ 530extern const char * const local_repo_env[]; 531 532extern void setup_git_env(const char *git_dir); 533 534/* 535 * Returns true iff we have a configured git repository (either via 536 * setup_git_directory, or in the environment via $GIT_DIR). 537 */ 538int have_git_dir(void); 539 540extern int is_bare_repository_cfg; 541extern int is_bare_repository(void); 542extern int is_inside_git_dir(void); 543extern char *git_work_tree_cfg; 544extern int is_inside_work_tree(void); 545extern const char *get_git_dir(void); 546extern const char *get_git_common_dir(void); 547extern char *get_object_directory(void); 548extern char *get_index_file(void); 549extern char *get_graft_file(struct repository *r); 550extern void set_git_dir(const char *path); 551extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir); 552extern int get_common_dir(struct strbuf *sb, const char *gitdir); 553extern const char *get_git_namespace(void); 554extern const char *strip_namespace(const char *namespaced_ref); 555extern const char *get_super_prefix(void); 556extern const char *get_git_work_tree(void); 557 558/* 559 * Return true if the given path is a git directory; note that this _just_ 560 * looks at the directory itself. If you want to know whether "foo/.git" 561 * is a repository, you must feed that path, not just "foo". 562 */ 563extern int is_git_directory(const char *path); 564 565/* 566 * Return 1 if the given path is the root of a git repository or 567 * submodule, else 0. Will not return 1 for bare repositories with the 568 * exception of creating a bare repository in "foo/.git" and calling 569 * is_git_repository("foo"). 570 * 571 * If we run into read errors, we err on the side of saying "yes, it is", 572 * as we usually consider sub-repos precious, and would prefer to err on the 573 * side of not disrupting or deleting them. 574 */ 575extern int is_nonbare_repository_dir(struct strbuf *path); 576 577#define READ_GITFILE_ERR_STAT_FAILED 1 578#define READ_GITFILE_ERR_NOT_A_FILE 2 579#define READ_GITFILE_ERR_OPEN_FAILED 3 580#define READ_GITFILE_ERR_READ_FAILED 4 581#define READ_GITFILE_ERR_INVALID_FORMAT 5 582#define READ_GITFILE_ERR_NO_PATH 6 583#define READ_GITFILE_ERR_NOT_A_REPO 7 584#define READ_GITFILE_ERR_TOO_LARGE 8 585extern void read_gitfile_error_die(int error_code, const char *path, const char *dir); 586extern const char *read_gitfile_gently(const char *path, int *return_error_code); 587#define read_gitfile(path) read_gitfile_gently((path), NULL) 588extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code); 589#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL) 590 591extern void set_git_work_tree(const char *tree); 592 593#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES" 594 595extern void setup_work_tree(void); 596/* 597 * Find the commondir and gitdir of the repository that contains the current 598 * working directory, without changing the working directory or other global 599 * state. The result is appended to commondir and gitdir. If the discovered 600 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will 601 * both have the same result appended to the buffer. The return value is 602 * either 0 upon success and non-zero if no repository was found. 603 */ 604extern int discover_git_directory(struct strbuf *commondir, 605 struct strbuf *gitdir); 606extern const char *setup_git_directory_gently(int *); 607extern const char *setup_git_directory(void); 608extern char *prefix_path(const char *prefix, int len, const char *path); 609extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path); 610 611/* 612 * Concatenate "prefix" (if len is non-zero) and "path", with no 613 * connecting characters (so "prefix" should end with a "/"). 614 * Unlike prefix_path, this should be used if the named file does 615 * not have to interact with index entry; i.e. name of a random file 616 * on the filesystem. 617 * 618 * The return value is always a newly allocated string (even if the 619 * prefix was empty). 620 */ 621extern char *prefix_filename(const char *prefix, const char *path); 622 623extern int check_filename(const char *prefix, const char *name); 624extern void verify_filename(const char *prefix, 625 const char *name, 626 int diagnose_misspelt_rev); 627extern void verify_non_filename(const char *prefix, const char *name); 628extern int path_inside_repo(const char *prefix, const char *path); 629 630#define INIT_DB_QUIET 0x0001 631#define INIT_DB_EXIST_OK 0x0002 632 633extern int init_db(const char *git_dir, const char *real_git_dir, 634 const char *template_dir, unsigned int flags); 635 636extern void sanitize_stdfds(void); 637extern int daemonize(void); 638 639#define alloc_nr(x) (((x)+16)*3/2) 640 641/* 642 * Realloc the buffer pointed at by variable 'x' so that it can hold 643 * at least 'nr' entries; the number of entries currently allocated 644 * is 'alloc', using the standard growing factor alloc_nr() macro. 645 * 646 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 647 */ 648#define ALLOC_GROW(x, nr, alloc) \ 649 do { \ 650 if ((nr) > alloc) { \ 651 if (alloc_nr(alloc) < (nr)) \ 652 alloc = (nr); \ 653 else \ 654 alloc = alloc_nr(alloc); \ 655 REALLOC_ARRAY(x, alloc); \ 656 } \ 657 } while (0) 658 659/* Initialize and use the cache information */ 660struct lock_file; 661extern int read_index(struct index_state *); 662extern int read_index_preload(struct index_state *, const struct pathspec *pathspec); 663extern int do_read_index(struct index_state *istate, const char *path, 664 int must_exist); /* for testting only! */ 665extern int read_index_from(struct index_state *, const char *path, 666 const char *gitdir); 667extern int is_index_unborn(struct index_state *); 668extern int read_index_unmerged(struct index_state *); 669 670/* For use with `write_locked_index()`. */ 671#define COMMIT_LOCK (1 << 0) 672#define SKIP_IF_UNCHANGED (1 << 1) 673 674/* 675 * Write the index while holding an already-taken lock. Close the lock, 676 * and if `COMMIT_LOCK` is given, commit it. 677 * 678 * Unless a split index is in use, write the index into the lockfile. 679 * 680 * With a split index, write the shared index to a temporary file, 681 * adjust its permissions and rename it into place, then write the 682 * split index to the lockfile. If the temporary file for the shared 683 * index cannot be created, fall back to the behavior described in 684 * the previous paragraph. 685 * 686 * With `COMMIT_LOCK`, the lock is always committed or rolled back. 687 * Without it, the lock is closed, but neither committed nor rolled 688 * back. 689 * 690 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing 691 * is written (and the lock is rolled back if `COMMIT_LOCK` is given). 692 */ 693extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags); 694 695extern int discard_index(struct index_state *); 696extern void move_index_extensions(struct index_state *dst, struct index_state *src); 697extern int unmerged_index(const struct index_state *); 698 699/** 700 * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL, 701 * compares istate to HEAD. If tree is NULL and on an unborn branch, 702 * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is 703 * provided, the space-separated list of files that differ will be appended 704 * to it. 705 */ 706extern int index_has_changes(const struct index_state *istate, 707 struct tree *tree, 708 struct strbuf *sb); 709 710extern int verify_path(const char *path, unsigned mode); 711extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change); 712extern int index_dir_exists(struct index_state *istate, const char *name, int namelen); 713extern void adjust_dirname_case(struct index_state *istate, char *name); 714extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase); 715 716/* 717 * Searches for an entry defined by name and namelen in the given index. 718 * If the return value is positive (including 0) it is the position of an 719 * exact match. If the return value is negative, the negated value minus 1 720 * is the position where the entry would be inserted. 721 * Example: The current index consists of these files and its stages: 722 * 723 * b#0, d#0, f#1, f#3 724 * 725 * index_name_pos(&index, "a", 1) -> -1 726 * index_name_pos(&index, "b", 1) -> 0 727 * index_name_pos(&index, "c", 1) -> -2 728 * index_name_pos(&index, "d", 1) -> 1 729 * index_name_pos(&index, "e", 1) -> -3 730 * index_name_pos(&index, "f", 1) -> -3 731 * index_name_pos(&index, "g", 1) -> -5 732 */ 733extern int index_name_pos(const struct index_state *, const char *name, int namelen); 734 735#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */ 736#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */ 737#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */ 738#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */ 739#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */ 740#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */ 741extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option); 742extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name); 743 744/* Remove entry, return true if there are more entries to go. */ 745extern int remove_index_entry_at(struct index_state *, int pos); 746 747extern void remove_marked_cache_entries(struct index_state *istate); 748extern int remove_file_from_index(struct index_state *, const char *path); 749#define ADD_CACHE_VERBOSE 1 750#define ADD_CACHE_PRETEND 2 751#define ADD_CACHE_IGNORE_ERRORS 4 752#define ADD_CACHE_IGNORE_REMOVAL 8 753#define ADD_CACHE_INTENT 16 754/* 755 * These two are used to add the contents of the file at path 756 * to the index, marking the working tree up-to-date by storing 757 * the cached stat info in the resulting cache entry. A caller 758 * that has already run lstat(2) on the path can call 759 * add_to_index(), and all others can call add_file_to_index(); 760 * the latter will do necessary lstat(2) internally before 761 * calling the former. 762 */ 763extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags); 764extern int add_file_to_index(struct index_state *, const char *path, int flags); 765 766extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip); 767extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b); 768extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce); 769extern int index_name_is_other(const struct index_state *, const char *, int); 770extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *); 771 772/* do stat comparison even if CE_VALID is true */ 773#define CE_MATCH_IGNORE_VALID 01 774/* do not check the contents but report dirty on racily-clean entries */ 775#define CE_MATCH_RACY_IS_DIRTY 02 776/* do stat comparison even if CE_SKIP_WORKTREE is true */ 777#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 778/* ignore non-existent files during stat update */ 779#define CE_MATCH_IGNORE_MISSING 0x08 780/* enable stat refresh */ 781#define CE_MATCH_REFRESH 0x10 782/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */ 783#define CE_MATCH_IGNORE_FSMONITOR 0X20 784extern int ie_match_stat(struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 785extern int ie_modified(struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 786 787#define HASH_WRITE_OBJECT 1 788#define HASH_FORMAT_CHECK 2 789#define HASH_RENORMALIZE 4 790extern int index_fd(struct object_id *oid, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags); 791extern int index_path(struct object_id *oid, const char *path, struct stat *st, unsigned flags); 792 793/* 794 * Record to sd the data from st that we use to check whether a file 795 * might have changed. 796 */ 797extern void fill_stat_data(struct stat_data *sd, struct stat *st); 798 799/* 800 * Return 0 if st is consistent with a file not having been changed 801 * since sd was filled. If there are differences, return a 802 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 803 * INODE_CHANGED, and DATA_CHANGED. 804 */ 805extern int match_stat_data(const struct stat_data *sd, struct stat *st); 806extern int match_stat_data_racy(const struct index_state *istate, 807 const struct stat_data *sd, struct stat *st); 808 809extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st); 810 811#define REFRESH_REALLY 0x0001 /* ignore_valid */ 812#define REFRESH_UNMERGED 0x0002 /* allow unmerged */ 813#define REFRESH_QUIET 0x0004 /* be quiet about it */ 814#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */ 815#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */ 816#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */ 817extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg); 818extern struct cache_entry *refresh_cache_entry(struct index_state *, struct cache_entry *, unsigned int); 819 820/* 821 * Opportunistically update the index but do not complain if we can't. 822 * The lockfile is always committed or rolled back. 823 */ 824extern void update_index_if_able(struct index_state *, struct lock_file *); 825 826extern int hold_locked_index(struct lock_file *, int); 827extern void set_alternate_index_output(const char *); 828 829extern int verify_index_checksum; 830extern int verify_ce_order; 831 832/* Environment bits from configuration mechanism */ 833extern int trust_executable_bit; 834extern int trust_ctime; 835extern int check_stat; 836extern int quote_path_fully; 837extern int has_symlinks; 838extern int minimum_abbrev, default_abbrev; 839extern int ignore_case; 840extern int assume_unchanged; 841extern int prefer_symlink_refs; 842extern int warn_ambiguous_refs; 843extern int warn_on_object_refname_ambiguity; 844extern const char *apply_default_whitespace; 845extern const char *apply_default_ignorewhitespace; 846extern const char *git_attributes_file; 847extern const char *git_hooks_path; 848extern int zlib_compression_level; 849extern int core_compression_level; 850extern int pack_compression_level; 851extern size_t packed_git_window_size; 852extern size_t packed_git_limit; 853extern size_t delta_base_cache_limit; 854extern unsigned long big_file_threshold; 855extern unsigned long pack_size_limit_cfg; 856 857/* 858 * Accessors for the core.sharedrepository config which lazy-load the value 859 * from the config (if not already set). The "reset" function can be 860 * used to unset "set" or cached value, meaning that the value will be loaded 861 * fresh from the config file on the next call to get_shared_repository(). 862 */ 863void set_shared_repository(int value); 864int get_shared_repository(void); 865void reset_shared_repository(void); 866 867/* 868 * Do replace refs need to be checked this run? This variable is 869 * initialized to true unless --no-replace-object is used or 870 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 871 * commands that do not want replace references to be active. 872 */ 873extern int read_replace_refs; 874extern char *git_replace_ref_base; 875 876extern int fsync_object_files; 877extern int core_preload_index; 878extern int core_apply_sparse_checkout; 879extern int precomposed_unicode; 880extern int protect_hfs; 881extern int protect_ntfs; 882extern const char *core_fsmonitor; 883 884/* 885 * Include broken refs in all ref iterations, which will 886 * generally choke dangerous operations rather than letting 887 * them silently proceed without taking the broken ref into 888 * account. 889 */ 890extern int ref_paranoia; 891 892/* 893 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value). 894 */ 895int use_optional_locks(void); 896 897/* 898 * The character that begins a commented line in user-editable file 899 * that is subject to stripspace. 900 */ 901extern char comment_line_char; 902extern int auto_comment_line_char; 903 904/* Windows only */ 905enum hide_dotfiles_type { 906 HIDE_DOTFILES_FALSE = 0, 907 HIDE_DOTFILES_TRUE, 908 HIDE_DOTFILES_DOTGITONLY 909}; 910extern enum hide_dotfiles_type hide_dotfiles; 911 912enum log_refs_config { 913 LOG_REFS_UNSET = -1, 914 LOG_REFS_NONE = 0, 915 LOG_REFS_NORMAL, 916 LOG_REFS_ALWAYS 917}; 918extern enum log_refs_config log_all_ref_updates; 919 920enum rebase_setup_type { 921 AUTOREBASE_NEVER = 0, 922 AUTOREBASE_LOCAL, 923 AUTOREBASE_REMOTE, 924 AUTOREBASE_ALWAYS 925}; 926 927enum push_default_type { 928 PUSH_DEFAULT_NOTHING = 0, 929 PUSH_DEFAULT_MATCHING, 930 PUSH_DEFAULT_SIMPLE, 931 PUSH_DEFAULT_UPSTREAM, 932 PUSH_DEFAULT_CURRENT, 933 PUSH_DEFAULT_UNSPECIFIED 934}; 935 936extern enum rebase_setup_type autorebase; 937extern enum push_default_type push_default; 938 939enum object_creation_mode { 940 OBJECT_CREATION_USES_HARDLINKS = 0, 941 OBJECT_CREATION_USES_RENAMES = 1 942}; 943 944extern enum object_creation_mode object_creation_mode; 945 946extern char *notes_ref_name; 947 948extern int grafts_replace_parents; 949 950/* 951 * GIT_REPO_VERSION is the version we write by default. The 952 * _READ variant is the highest number we know how to 953 * handle. 954 */ 955#define GIT_REPO_VERSION 0 956#define GIT_REPO_VERSION_READ 1 957extern int repository_format_precious_objects; 958extern char *repository_format_partial_clone; 959extern const char *core_partial_clone_filter_default; 960 961struct repository_format { 962 int version; 963 int precious_objects; 964 char *partial_clone; /* value of extensions.partialclone */ 965 int is_bare; 966 int hash_algo; 967 char *work_tree; 968 struct string_list unknown_extensions; 969}; 970 971/* 972 * Read the repository format characteristics from the config file "path" into 973 * "format" struct. Returns the numeric version. On error, -1 is returned, 974 * format->version is set to -1, and all other fields in the struct are 975 * undefined. 976 */ 977int read_repository_format(struct repository_format *format, const char *path); 978 979/* 980 * Verify that the repository described by repository_format is something we 981 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe 982 * any errors encountered. 983 */ 984int verify_repository_format(const struct repository_format *format, 985 struct strbuf *err); 986 987/* 988 * Check the repository format version in the path found in get_git_dir(), 989 * and die if it is a version we don't understand. Generally one would 990 * set_git_dir() before calling this, and use it only for "are we in a valid 991 * repo?". 992 */ 993extern void check_repository_format(void); 994 995#define MTIME_CHANGED 0x0001 996#define CTIME_CHANGED 0x0002 997#define OWNER_CHANGED 0x0004 998#define MODE_CHANGED 0x0008 999#define INODE_CHANGED 0x00101000#define DATA_CHANGED 0x00201001#define TYPE_CHANGED 0x004010021003/*1004 * Return an abbreviated sha1 unique within this repository's object database.1005 * The result will be at least `len` characters long, and will be NUL1006 * terminated.1007 *1008 * The non-`_r` version returns a static buffer which remains valid until 41009 * more calls to find_unique_abbrev are made.1010 *1011 * The `_r` variant writes to a buffer supplied by the caller, which must be at1012 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes1013 * written (excluding the NUL terminator).1014 *1015 * Note that while this version avoids the static buffer, it is not fully1016 * reentrant, as it calls into other non-reentrant git code.1017 */1018extern const char *find_unique_abbrev(const struct object_id *oid, int len);1019extern int find_unique_abbrev_r(char *hex, const struct object_id *oid, int len);10201021extern const unsigned char null_sha1[GIT_MAX_RAWSZ];1022extern const struct object_id null_oid;10231024static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)1025{1026 return memcmp(sha1, sha2, the_hash_algo->rawsz);1027}10281029static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)1030{1031 return hashcmp(oid1->hash, oid2->hash);1032}10331034static inline int is_null_sha1(const unsigned char *sha1)1035{1036 return !hashcmp(sha1, null_sha1);1037}10381039static inline int is_null_oid(const struct object_id *oid)1040{1041 return !hashcmp(oid->hash, null_sha1);1042}10431044static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)1045{1046 memcpy(sha_dst, sha_src, the_hash_algo->rawsz);1047}10481049static inline void oidcpy(struct object_id *dst, const struct object_id *src)1050{1051 hashcpy(dst->hash, src->hash);1052}10531054static inline struct object_id *oiddup(const struct object_id *src)1055{1056 struct object_id *dst = xmalloc(sizeof(struct object_id));1057 oidcpy(dst, src);1058 return dst;1059}10601061static inline void hashclr(unsigned char *hash)1062{1063 memset(hash, 0, the_hash_algo->rawsz);1064}10651066static inline void oidclr(struct object_id *oid)1067{1068 memset(oid->hash, 0, GIT_MAX_RAWSZ);1069}10701071static inline void oidread(struct object_id *oid, const unsigned char *hash)1072{1073 memcpy(oid->hash, hash, the_hash_algo->rawsz);1074}10751076static inline int is_empty_blob_sha1(const unsigned char *sha1)1077{1078 return !hashcmp(sha1, the_hash_algo->empty_blob->hash);1079}10801081static inline int is_empty_blob_oid(const struct object_id *oid)1082{1083 return !oidcmp(oid, the_hash_algo->empty_blob);1084}10851086static inline int is_empty_tree_sha1(const unsigned char *sha1)1087{1088 return !hashcmp(sha1, the_hash_algo->empty_tree->hash);1089}10901091static inline int is_empty_tree_oid(const struct object_id *oid)1092{1093 return !oidcmp(oid, the_hash_algo->empty_tree);1094}10951096const char *empty_tree_oid_hex(void);1097const char *empty_blob_oid_hex(void);10981099/* set default permissions by passing mode arguments to open(2) */1100int git_mkstemps_mode(char *pattern, int suffix_len, int mode);1101int git_mkstemp_mode(char *pattern, int mode);11021103/*1104 * NOTE NOTE NOTE!!1105 *1106 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must1107 * not be changed. Old repositories have core.sharedrepository written in1108 * numeric format, and therefore these values are preserved for compatibility1109 * reasons.1110 */1111enum sharedrepo {1112 PERM_UMASK = 0,1113 OLD_PERM_GROUP = 1,1114 OLD_PERM_EVERYBODY = 2,1115 PERM_GROUP = 0660,1116 PERM_EVERYBODY = 06641117};1118int git_config_perm(const char *var, const char *value);1119int adjust_shared_perm(const char *path);11201121/*1122 * Create the directory containing the named path, using care to be1123 * somewhat safe against races. Return one of the scld_error values to1124 * indicate success/failure. On error, set errno to describe the1125 * problem.1126 *1127 * SCLD_VANISHED indicates that one of the ancestor directories of the1128 * path existed at one point during the function call and then1129 * suddenly vanished, probably because another process pruned the1130 * directory while we were working. To be robust against this kind of1131 * race, callers might want to try invoking the function again when it1132 * returns SCLD_VANISHED.1133 *1134 * safe_create_leading_directories() temporarily changes path while it1135 * is working but restores it before returning.1136 * safe_create_leading_directories_const() doesn't modify path, even1137 * temporarily.1138 */1139enum scld_error {1140 SCLD_OK = 0,1141 SCLD_FAILED = -1,1142 SCLD_PERMS = -2,1143 SCLD_EXISTS = -3,1144 SCLD_VANISHED = -41145};1146enum scld_error safe_create_leading_directories(char *path);1147enum scld_error safe_create_leading_directories_const(const char *path);11481149/*1150 * Callback function for raceproof_create_file(). This function is1151 * expected to do something that makes dirname(path) permanent despite1152 * the fact that other processes might be cleaning up empty1153 * directories at the same time. Usually it will create a file named1154 * path, but alternatively it could create another file in that1155 * directory, or even chdir() into that directory. The function should1156 * return 0 if the action was completed successfully. On error, it1157 * should return a nonzero result and set errno.1158 * raceproof_create_file() treats two errno values specially:1159 *1160 * - ENOENT -- dirname(path) does not exist. In this case,1161 * raceproof_create_file() tries creating dirname(path)1162 * (and any parent directories, if necessary) and calls1163 * the function again.1164 *1165 * - EISDIR -- the file already exists and is a directory. In this1166 * case, raceproof_create_file() removes the directory if1167 * it is empty (and recursively any empty directories that1168 * it contains) and calls the function again.1169 *1170 * Any other errno causes raceproof_create_file() to fail with the1171 * callback's return value and errno.1172 *1173 * Obviously, this function should be OK with being called again if it1174 * fails with ENOENT or EISDIR. In other scenarios it will not be1175 * called again.1176 */1177typedef int create_file_fn(const char *path, void *cb);11781179/*1180 * Create a file in dirname(path) by calling fn, creating leading1181 * directories if necessary. Retry a few times in case we are racing1182 * with another process that is trying to clean up the directory that1183 * contains path. See the documentation for create_file_fn for more1184 * details.1185 *1186 * Return the value and set the errno that resulted from the most1187 * recent call of fn. fn is always called at least once, and will be1188 * called more than once if it returns ENOENT or EISDIR.1189 */1190int raceproof_create_file(const char *path, create_file_fn fn, void *cb);11911192int mkdir_in_gitdir(const char *path);1193extern char *expand_user_path(const char *path, int real_home);1194const char *enter_repo(const char *path, int strict);1195static inline int is_absolute_path(const char *path)1196{1197 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);1198}1199int is_directory(const char *);1200char *strbuf_realpath(struct strbuf *resolved, const char *path,1201 int die_on_error);1202const char *real_path(const char *path);1203const char *real_path_if_valid(const char *path);1204char *real_pathdup(const char *path, int die_on_error);1205const char *absolute_path(const char *path);1206char *absolute_pathdup(const char *path);1207const char *remove_leading_path(const char *in, const char *prefix);1208const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);1209int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);1210int normalize_path_copy(char *dst, const char *src);1211int longest_ancestor_length(const char *path, struct string_list *prefixes);1212char *strip_path_suffix(const char *path, const char *suffix);1213int daemon_avoid_alias(const char *path);12141215/*1216 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for1217 * details.1218 */1219int is_ntfs_dotgit(const char *name);1220int is_ntfs_dotgitmodules(const char *name);1221int is_ntfs_dotgitignore(const char *name);1222int is_ntfs_dotgitattributes(const char *name);12231224/*1225 * Returns true iff "str" could be confused as a command-line option when1226 * passed to a sub-program like "ssh". Note that this has nothing to do with1227 * shell-quoting, which should be handled separately; we're assuming here that1228 * the string makes it verbatim to the sub-program.1229 */1230int looks_like_command_line_option(const char *str);12311232/**1233 * Return a newly allocated string with the evaluation of1234 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise1235 * "$HOME/.config/git/$filename". Return NULL upon error.1236 */1237extern char *xdg_config_home(const char *filename);12381239/**1240 * Return a newly allocated string with the evaluation of1241 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise1242 * "$HOME/.cache/git/$filename". Return NULL upon error.1243 */1244extern char *xdg_cache_home(const char *filename);12451246extern int git_open_cloexec(const char *name, int flags);1247#define git_open(name) git_open_cloexec(name, O_RDONLY)1248extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);1249extern int parse_sha1_header(const char *hdr, unsigned long *sizep);12501251extern int check_object_signature(const struct object_id *oid, void *buf, unsigned long size, const char *type);12521253extern int finalize_object_file(const char *tmpfile, const char *filename);12541255/* Helper to check and "touch" a file */1256extern int check_and_freshen_file(const char *fn, int freshen);12571258extern const signed char hexval_table[256];1259static inline unsigned int hexval(unsigned char c)1260{1261 return hexval_table[c];1262}12631264/*1265 * Convert two consecutive hexadecimal digits into a char. Return a1266 * negative value on error. Don't run over the end of short strings.1267 */1268static inline int hex2chr(const char *s)1269{1270 unsigned int val = hexval(s[0]);1271 return (val & ~0xf) ? val : (val << 4) | hexval(s[1]);1272}12731274/* Convert to/from hex/sha1 representation */1275#define MINIMUM_ABBREV minimum_abbrev1276#define DEFAULT_ABBREV default_abbrev12771278/* used when the code does not know or care what the default abbrev is */1279#define FALLBACK_DEFAULT_ABBREV 712801281struct object_context {1282 unsigned mode;1283 /*1284 * symlink_path is only used by get_tree_entry_follow_symlinks,1285 * and only for symlinks that point outside the repository.1286 */1287 struct strbuf symlink_path;1288 /*1289 * If GET_OID_RECORD_PATH is set, this will record path (if any)1290 * found when resolving the name. The caller is responsible for1291 * releasing the memory.1292 */1293 char *path;1294};12951296#define GET_OID_QUIETLY 011297#define GET_OID_COMMIT 021298#define GET_OID_COMMITTISH 041299#define GET_OID_TREE 0101300#define GET_OID_TREEISH 0201301#define GET_OID_BLOB 0401302#define GET_OID_FOLLOW_SYMLINKS 01001303#define GET_OID_RECORD_PATH 02001304#define GET_OID_ONLY_TO_DIE 0400013051306#define GET_OID_DISAMBIGUATORS \1307 (GET_OID_COMMIT | GET_OID_COMMITTISH | \1308 GET_OID_TREE | GET_OID_TREEISH | \1309 GET_OID_BLOB)13101311extern int get_oid(const char *str, struct object_id *oid);1312extern int get_oid_commit(const char *str, struct object_id *oid);1313extern int get_oid_committish(const char *str, struct object_id *oid);1314extern int get_oid_tree(const char *str, struct object_id *oid);1315extern int get_oid_treeish(const char *str, struct object_id *oid);1316extern int get_oid_blob(const char *str, struct object_id *oid);1317extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);1318extern int get_oid_with_context(const char *str, unsigned flags, struct object_id *oid, struct object_context *oc);131913201321typedef int each_abbrev_fn(const struct object_id *oid, void *);1322extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);13231324extern int set_disambiguate_hint_config(const char *var, const char *value);13251326/*1327 * Try to read a SHA1 in hexadecimal format from the 40 characters1328 * starting at hex. Write the 20-byte result to sha1 in binary form.1329 * Return 0 on success. Reading stops if a NUL is encountered in the1330 * input, so it is safe to pass this function an arbitrary1331 * null-terminated string.1332 */1333extern int get_sha1_hex(const char *hex, unsigned char *sha1);1334extern int get_oid_hex(const char *hex, struct object_id *sha1);13351336/*1337 * Read `len` pairs of hexadecimal digits from `hex` and write the1338 * values to `binary` as `len` bytes. Return 0 on success, or -1 if1339 * the input does not consist of hex digits).1340 */1341extern int hex_to_bytes(unsigned char *binary, const char *hex, size_t len);13421343/*1344 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,1345 * and writes the NUL-terminated output to the buffer `out`, which must be at1346 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for1347 * convenience.1348 *1349 * The non-`_r` variant returns a static buffer, but uses a ring of 41350 * buffers, making it safe to make multiple calls for a single statement, like:1351 *1352 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));1353 */1354extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);1355extern char *oid_to_hex_r(char *out, const struct object_id *oid);1356extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */1357extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */13581359/*1360 * Parse a 40-character hexadecimal object ID starting from hex, updating the1361 * pointer specified by end when parsing stops. The resulting object ID is1362 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or1363 * other invalid character. end is only updated on success; otherwise, it is1364 * unmodified.1365 */1366extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);13671368/*1369 * This reads short-hand syntax that not only evaluates to a commit1370 * object name, but also can act as if the end user spelled the name1371 * of the branch from the command line.1372 *1373 * - "@{-N}" finds the name of the Nth previous branch we were on, and1374 * places the name of the branch in the given buf and returns the1375 * number of characters parsed if successful.1376 *1377 * - "<branch>@{upstream}" finds the name of the other ref that1378 * <branch> is configured to merge with (missing <branch> defaults1379 * to the current branch), and places the name of the branch in the1380 * given buf and returns the number of characters parsed if1381 * successful.1382 *1383 * If the input is not of the accepted format, it returns a negative1384 * number to signal an error.1385 *1386 * If the input was ok but there are not N branch switches in the1387 * reflog, it returns 0.1388 *1389 * If "allowed" is non-zero, it is a treated as a bitfield of allowable1390 * expansions: local branches ("refs/heads/"), remote branches1391 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is1392 * allowed, even ones to refs outside of those namespaces.1393 */1394#define INTERPRET_BRANCH_LOCAL (1<<0)1395#define INTERPRET_BRANCH_REMOTE (1<<1)1396#define INTERPRET_BRANCH_HEAD (1<<2)1397extern int interpret_branch_name(const char *str, int len, struct strbuf *,1398 unsigned allowed);1399extern int get_oid_mb(const char *str, struct object_id *oid);14001401extern int validate_headref(const char *ref);14021403extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1404extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1405extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);1406extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);14071408extern void *read_object_with_reference(const struct object_id *oid,1409 const char *required_type,1410 unsigned long *size,1411 struct object_id *oid_ret);14121413extern struct object *peel_to_type(const char *name, int namelen,1414 struct object *o, enum object_type);14151416enum date_mode_type {1417 DATE_NORMAL = 0,1418 DATE_RELATIVE,1419 DATE_SHORT,1420 DATE_ISO8601,1421 DATE_ISO8601_STRICT,1422 DATE_RFC2822,1423 DATE_STRFTIME,1424 DATE_RAW,1425 DATE_UNIX1426};14271428struct date_mode {1429 enum date_mode_type type;1430 const char *strftime_fmt;1431 int local;1432};14331434/*1435 * Convenience helper for passing a constant type, like:1436 *1437 * show_date(t, tz, DATE_MODE(NORMAL));1438 */1439#define DATE_MODE(t) date_mode_from_type(DATE_##t)1440struct date_mode *date_mode_from_type(enum date_mode_type type);14411442const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);1443void show_date_relative(timestamp_t time, int tz, const struct timeval *now,1444 struct strbuf *timebuf);1445int parse_date(const char *date, struct strbuf *out);1446int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);1447int parse_expiry_date(const char *date, timestamp_t *timestamp);1448void datestamp(struct strbuf *out);1449#define approxidate(s) approxidate_careful((s), NULL)1450timestamp_t approxidate_careful(const char *, int *);1451timestamp_t approxidate_relative(const char *date, const struct timeval *now);1452void parse_date_format(const char *format, struct date_mode *mode);1453int date_overflows(timestamp_t date);14541455#define IDENT_STRICT 11456#define IDENT_NO_DATE 21457#define IDENT_NO_NAME 41458extern const char *git_author_info(int);1459extern const char *git_committer_info(int);1460extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);1461extern const char *fmt_name(const char *name, const char *email);1462extern const char *ident_default_name(void);1463extern const char *ident_default_email(void);1464extern const char *git_editor(void);1465extern const char *git_pager(int stdout_is_tty);1466extern int is_terminal_dumb(void);1467extern int git_ident_config(const char *, const char *, void *);1468extern void reset_ident_date(void);14691470struct ident_split {1471 const char *name_begin;1472 const char *name_end;1473 const char *mail_begin;1474 const char *mail_end;1475 const char *date_begin;1476 const char *date_end;1477 const char *tz_begin;1478 const char *tz_end;1479};1480/*1481 * Signals an success with 0, but time part of the result may be NULL1482 * if the input lacks timestamp and zone1483 */1484extern int split_ident_line(struct ident_split *, const char *, int);14851486/*1487 * Like show_date, but pull the timestamp and tz parameters from1488 * the ident_split. It will also sanity-check the values and produce1489 * a well-known sentinel date if they appear bogus.1490 */1491const char *show_ident_date(const struct ident_split *id,1492 const struct date_mode *mode);14931494/*1495 * Compare split idents for equality or strict ordering. Note that we1496 * compare only the ident part of the line, ignoring any timestamp.1497 *1498 * Because there are two fields, we must choose one as the primary key; we1499 * currently arbitrarily pick the email.1500 */1501extern int ident_cmp(const struct ident_split *, const struct ident_split *);15021503struct checkout {1504 struct index_state *istate;1505 const char *base_dir;1506 int base_dir_len;1507 struct delayed_checkout *delayed_checkout;1508 unsigned force:1,1509 quiet:1,1510 not_new:1,1511 refresh_cache:1;1512};1513#define CHECKOUT_INIT { NULL, "" }15141515#define TEMPORARY_FILENAME_LENGTH 251516extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);1517extern void enable_delayed_checkout(struct checkout *state);1518extern int finish_delayed_checkout(struct checkout *state);15191520struct cache_def {1521 struct strbuf path;1522 int flags;1523 int track_flags;1524 int prefix_len_stat_func;1525};1526#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1527static inline void cache_def_clear(struct cache_def *cache)1528{1529 strbuf_release(&cache->path);1530}15311532extern int has_symlink_leading_path(const char *name, int len);1533extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);1534extern int check_leading_path(const char *name, int len);1535extern int has_dirs_only_path(const char *name, int len, int prefix_len);1536extern void schedule_dir_for_removal(const char *name, int len);1537extern void remove_scheduled_dirs(void);15381539struct pack_window {1540 struct pack_window *next;1541 unsigned char *base;1542 off_t offset;1543 size_t len;1544 unsigned int last_used;1545 unsigned int inuse_cnt;1546};15471548struct pack_entry {1549 off_t offset;1550 struct packed_git *p;1551};15521553/*1554 * Create a temporary file rooted in the object database directory, or1555 * die on failure. The filename is taken from "pattern", which should have the1556 * usual "XXXXXX" trailer, and the resulting filename is written into the1557 * "template" buffer. Returns the open descriptor.1558 */1559extern int odb_mkstemp(struct strbuf *temp_filename, const char *pattern);15601561/*1562 * Create a pack .keep file named "name" (which should generally be the output1563 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on1564 * error.1565 */1566extern int odb_pack_keep(const char *name);15671568/*1569 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing1570 * blobs. This has a difference only if extensions.partialClone is set.1571 *1572 * Its default value is 1.1573 */1574extern int fetch_if_missing;15751576/* Dumb servers support */1577extern int update_server_info(int);15781579extern const char *get_log_output_encoding(void);1580extern const char *get_commit_output_encoding(void);15811582/*1583 * This is a hack for test programs like test-dump-untracked-cache to1584 * ensure that they do not modify the untracked cache when reading it.1585 * Do not use it otherwise!1586 */1587extern int ignore_untracked_cache_config;15881589extern int committer_ident_sufficiently_given(void);1590extern int author_ident_sufficiently_given(void);15911592extern const char *git_commit_encoding;1593extern const char *git_log_output_encoding;1594extern const char *git_mailmap_file;1595extern const char *git_mailmap_blob;15961597/* IO helper functions */1598extern void maybe_flush_or_die(FILE *, const char *);1599__attribute__((format (printf, 2, 3)))1600extern void fprintf_or_die(FILE *, const char *fmt, ...);16011602#define COPY_READ_ERROR (-2)1603#define COPY_WRITE_ERROR (-3)1604extern int copy_fd(int ifd, int ofd);1605extern int copy_file(const char *dst, const char *src, int mode);1606extern int copy_file_with_time(const char *dst, const char *src, int mode);16071608extern void write_or_die(int fd, const void *buf, size_t count);1609extern void fsync_or_die(int fd, const char *);16101611extern ssize_t read_in_full(int fd, void *buf, size_t count);1612extern ssize_t write_in_full(int fd, const void *buf, size_t count);1613extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);16141615static inline ssize_t write_str_in_full(int fd, const char *str)1616{1617 return write_in_full(fd, str, strlen(str));1618}16191620/**1621 * Open (and truncate) the file at path, write the contents of buf to it,1622 * and close it. Dies if any errors are encountered.1623 */1624extern void write_file_buf(const char *path, const char *buf, size_t len);16251626/**1627 * Like write_file_buf(), but format the contents into a buffer first.1628 * Additionally, write_file() will append a newline if one is not already1629 * present, making it convenient to write text files:1630 *1631 * write_file(path, "counter: %d", ctr);1632 */1633__attribute__((format (printf, 2, 3)))1634extern void write_file(const char *path, const char *fmt, ...);16351636/* pager.c */1637extern void setup_pager(void);1638extern int pager_in_use(void);1639extern int pager_use_color;1640extern int term_columns(void);1641extern int decimal_width(uintmax_t);1642extern int check_pager_config(const char *cmd);1643extern void prepare_pager_args(struct child_process *, const char *pager);16441645extern const char *editor_program;1646extern const char *askpass_program;1647extern const char *excludes_file;16481649/* base85 */1650int decode_85(char *dst, const char *line, int linelen);1651void encode_85(char *buf, const unsigned char *data, int bytes);16521653/* pkt-line.c */1654void packet_trace_identity(const char *prog);16551656/* add */1657/*1658 * return 0 if success, 1 - if addition of a file failed and1659 * ADD_FILES_IGNORE_ERRORS was specified in flags1660 */1661int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);16621663/* diff.c */1664extern int diff_auto_refresh_index;16651666/* match-trees.c */1667void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);1668void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);16691670/*1671 * whitespace rules.1672 * used by both diff and apply1673 * last two digits are tab width1674 */1675#define WS_BLANK_AT_EOL 01001676#define WS_SPACE_BEFORE_TAB 02001677#define WS_INDENT_WITH_NON_TAB 04001678#define WS_CR_AT_EOL 010001679#define WS_BLANK_AT_EOF 020001680#define WS_TAB_IN_INDENT 040001681#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1682#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1683#define WS_TAB_WIDTH_MASK 0771684/* All WS_* -- when extended, adapt diff.c emit_symbol */1685#define WS_RULE_MASK 077771686extern unsigned whitespace_rule_cfg;1687extern unsigned whitespace_rule(const char *);1688extern unsigned parse_whitespace_rule(const char *);1689extern unsigned ws_check(const char *line, int len, unsigned ws_rule);1690extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);1691extern char *whitespace_error_string(unsigned ws);1692extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);1693extern int ws_blank_line(const char *line, int len, unsigned ws_rule);1694#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)16951696/* ls-files */1697void overlay_tree_on_index(struct index_state *istate,1698 const char *tree_name, const char *prefix);16991700/* setup.c */1701struct startup_info {1702 int have_repository;1703 const char *prefix;1704};1705extern struct startup_info *startup_info;17061707/* merge.c */1708struct commit_list;1709int try_merge_command(const char *strategy, size_t xopts_nr,1710 const char **xopts, struct commit_list *common,1711 const char *head_arg, struct commit_list *remotes);1712int checkout_fast_forward(const struct object_id *from,1713 const struct object_id *to,1714 int overwrite_ignore);171517161717int sane_execvp(const char *file, char *const argv[]);17181719/*1720 * A struct to encapsulate the concept of whether a file has changed1721 * since we last checked it. This uses criteria similar to those used1722 * for the index.1723 */1724struct stat_validity {1725 struct stat_data *sd;1726};17271728void stat_validity_clear(struct stat_validity *sv);17291730/*1731 * Returns 1 if the path is a regular file (or a symlink to a regular1732 * file) and matches the saved stat_validity, 0 otherwise. A missing1733 * or inaccessible file is considered a match if the struct was just1734 * initialized, or if the previous update found an inaccessible file.1735 */1736int stat_validity_check(struct stat_validity *sv, const char *path);17371738/*1739 * Update the stat_validity from a file opened at descriptor fd. If1740 * the file is missing, inaccessible, or not a regular file, then1741 * future calls to stat_validity_check will match iff one of those1742 * conditions continues to be true.1743 */1744void stat_validity_update(struct stat_validity *sv, int fd);17451746int versioncmp(const char *s1, const char *s2);1747void sleep_millisec(int millisec);17481749/*1750 * Create a directory and (if share is nonzero) adjust its permissions1751 * according to the shared_repository setting. Only use this for1752 * directories under $GIT_DIR. Don't use it for working tree1753 * directories.1754 */1755void safe_create_dir(const char *dir, int share);17561757/*1758 * Should we print an ellipsis after an abbreviated SHA-1 value1759 * when doing diff-raw output or indicating a detached HEAD?1760 */1761extern int print_sha1_ellipsis(void);17621763#endif /* CACHE_H */