1#ifndef CACHE_H 2#define CACHE_H 3 4#include "git-compat-util.h" 5#include "strbuf.h" 6#include "hashmap.h" 7#include "advice.h" 8#include "gettext.h" 9#include "convert.h" 10#include "trace.h" 11#include "string-list.h" 12 13#include SHA1_HEADER 14#ifndef git_SHA_CTX 15#define git_SHA_CTX SHA_CTX 16#define git_SHA1_Init SHA1_Init 17#define git_SHA1_Update SHA1_Update 18#define git_SHA1_Final SHA1_Final 19#endif 20 21#include <zlib.h> 22typedef struct git_zstream { 23 z_stream z; 24 unsigned long avail_in; 25 unsigned long avail_out; 26 unsigned long total_in; 27 unsigned long total_out; 28 unsigned char *next_in; 29 unsigned char *next_out; 30} git_zstream; 31 32void git_inflate_init(git_zstream *); 33void git_inflate_init_gzip_only(git_zstream *); 34void git_inflate_end(git_zstream *); 35int git_inflate(git_zstream *, int flush); 36 37void git_deflate_init(git_zstream *, int level); 38void git_deflate_init_gzip(git_zstream *, int level); 39void git_deflate_init_raw(git_zstream *, int level); 40void git_deflate_end(git_zstream *); 41int git_deflate_abort(git_zstream *); 42int git_deflate_end_gently(git_zstream *); 43int git_deflate(git_zstream *, int flush); 44unsigned long git_deflate_bound(git_zstream *, unsigned long); 45 46#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT) 47#define DTYPE(de) ((de)->d_type) 48#else 49#undef DT_UNKNOWN 50#undef DT_DIR 51#undef DT_REG 52#undef DT_LNK 53#define DT_UNKNOWN 0 54#define DT_DIR 1 55#define DT_REG 2 56#define DT_LNK 3 57#define DTYPE(de) DT_UNKNOWN 58#endif 59 60/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ 61#define S_IFINVALID 0030000 62 63/* 64 * A "directory link" is a link to another git directory. 65 * 66 * The value 0160000 is not normally a valid mode, and 67 * also just happens to be S_IFDIR + S_IFLNK 68 */ 69#define S_IFGITLINK 0160000 70#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 71 72/* 73 * Some mode bits are also used internally for computations. 74 * 75 * They *must* not overlap with any valid modes, and they *must* not be emitted 76 * to outside world - i.e. appear on disk or network. In other words, it's just 77 * temporary fields, which we internally use, but they have to stay in-house. 78 * 79 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 80 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 81 */ 82 83/* used internally in tree-diff */ 84#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 85 86 87/* 88 * Intensive research over the course of many years has shown that 89 * port 9418 is totally unused by anything else. Or 90 * 91 * Your search - "port 9418" - did not match any documents. 92 * 93 * as www.google.com puts it. 94 * 95 * This port has been properly assigned for git use by IANA: 96 * git (Assigned-9418) [I06-050728-0001]. 97 * 98 * git 9418/tcp git pack transfer service 99 * git 9418/udp git pack transfer service 100 * 101 * with Linus Torvalds <torvalds@osdl.org> as the point of 102 * contact. September 2005. 103 * 104 * See http://www.iana.org/assignments/port-numbers 105 */ 106#define DEFAULT_GIT_PORT 9418 107 108/* 109 * Basic data structures for the directory cache 110 */ 111 112#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */ 113struct cache_header { 114 uint32_t hdr_signature; 115 uint32_t hdr_version; 116 uint32_t hdr_entries; 117}; 118 119#define INDEX_FORMAT_LB 2 120#define INDEX_FORMAT_UB 4 121 122/* 123 * The "cache_time" is just the low 32 bits of the 124 * time. It doesn't matter if it overflows - we only 125 * check it for equality in the 32 bits we save. 126 */ 127struct cache_time { 128 uint32_t sec; 129 uint32_t nsec; 130}; 131 132struct stat_data { 133 struct cache_time sd_ctime; 134 struct cache_time sd_mtime; 135 unsigned int sd_dev; 136 unsigned int sd_ino; 137 unsigned int sd_uid; 138 unsigned int sd_gid; 139 unsigned int sd_size; 140}; 141 142struct cache_entry { 143 struct hashmap_entry ent; 144 struct stat_data ce_stat_data; 145 unsigned int ce_mode; 146 unsigned int ce_flags; 147 unsigned int ce_namelen; 148 unsigned int index; /* for link extension */ 149 unsigned char sha1[20]; 150 char name[FLEX_ARRAY]; /* more */ 151}; 152 153#define CE_STAGEMASK (0x3000) 154#define CE_EXTENDED (0x4000) 155#define CE_VALID (0x8000) 156#define CE_STAGESHIFT 12 157 158/* 159 * Range 0xFFFF0FFF in ce_flags is divided into 160 * two parts: in-memory flags and on-disk ones. 161 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 162 * if you want to save a new flag, add it in 163 * CE_EXTENDED_FLAGS 164 * 165 * In-memory only flags 166 */ 167#define CE_UPDATE (1 << 16) 168#define CE_REMOVE (1 << 17) 169#define CE_UPTODATE (1 << 18) 170#define CE_ADDED (1 << 19) 171 172#define CE_HASHED (1 << 20) 173#define CE_WT_REMOVE (1 << 22) /* remove in work directory */ 174#define CE_CONFLICTED (1 << 23) 175 176#define CE_UNPACKED (1 << 24) 177#define CE_NEW_SKIP_WORKTREE (1 << 25) 178 179/* used to temporarily mark paths matched by pathspecs */ 180#define CE_MATCHED (1 << 26) 181 182#define CE_UPDATE_IN_BASE (1 << 27) 183#define CE_STRIP_NAME (1 << 28) 184 185/* 186 * Extended on-disk flags 187 */ 188#define CE_INTENT_TO_ADD (1 << 29) 189#define CE_SKIP_WORKTREE (1 << 30) 190/* CE_EXTENDED2 is for future extension */ 191#define CE_EXTENDED2 (1 << 31) 192 193#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 194 195/* 196 * Safeguard to avoid saving wrong flags: 197 * - CE_EXTENDED2 won't get saved until its semantic is known 198 * - Bits in 0x0000FFFF have been saved in ce_flags already 199 * - Bits in 0x003F0000 are currently in-memory flags 200 */ 201#if CE_EXTENDED_FLAGS & 0x803FFFFF 202#error "CE_EXTENDED_FLAGS out of range" 203#endif 204 205struct pathspec; 206 207/* 208 * Copy the sha1 and stat state of a cache entry from one to 209 * another. But we never change the name, or the hash state! 210 */ 211static inline void copy_cache_entry(struct cache_entry *dst, 212 const struct cache_entry *src) 213{ 214 unsigned int state = dst->ce_flags & CE_HASHED; 215 216 /* Don't copy hash chain and name */ 217 memcpy(&dst->ce_stat_data, &src->ce_stat_data, 218 offsetof(struct cache_entry, name) - 219 offsetof(struct cache_entry, ce_stat_data)); 220 221 /* Restore the hash state */ 222 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 223} 224 225static inline unsigned create_ce_flags(unsigned stage) 226{ 227 return (stage << CE_STAGESHIFT); 228} 229 230#define ce_namelen(ce) ((ce)->ce_namelen) 231#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 232#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 233#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 234#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 235#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 236 237#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 238static inline unsigned int create_ce_mode(unsigned int mode) 239{ 240 if (S_ISLNK(mode)) 241 return S_IFLNK; 242 if (S_ISDIR(mode) || S_ISGITLINK(mode)) 243 return S_IFGITLINK; 244 return S_IFREG | ce_permissions(mode); 245} 246static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce, 247 unsigned int mode) 248{ 249 extern int trust_executable_bit, has_symlinks; 250 if (!has_symlinks && S_ISREG(mode) && 251 ce && S_ISLNK(ce->ce_mode)) 252 return ce->ce_mode; 253 if (!trust_executable_bit && S_ISREG(mode)) { 254 if (ce && S_ISREG(ce->ce_mode)) 255 return ce->ce_mode; 256 return create_ce_mode(0666); 257 } 258 return create_ce_mode(mode); 259} 260static inline int ce_to_dtype(const struct cache_entry *ce) 261{ 262 unsigned ce_mode = ntohl(ce->ce_mode); 263 if (S_ISREG(ce_mode)) 264 return DT_REG; 265 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode)) 266 return DT_DIR; 267 else if (S_ISLNK(ce_mode)) 268 return DT_LNK; 269 else 270 return DT_UNKNOWN; 271} 272static inline unsigned int canon_mode(unsigned int mode) 273{ 274 if (S_ISREG(mode)) 275 return S_IFREG | ce_permissions(mode); 276 if (S_ISLNK(mode)) 277 return S_IFLNK; 278 if (S_ISDIR(mode)) 279 return S_IFDIR; 280 return S_IFGITLINK; 281} 282 283#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 284 285#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */ 286#define CE_ENTRY_CHANGED (1 << 1) 287#define CE_ENTRY_REMOVED (1 << 2) 288#define CE_ENTRY_ADDED (1 << 3) 289#define RESOLVE_UNDO_CHANGED (1 << 4) 290#define CACHE_TREE_CHANGED (1 << 5) 291#define SPLIT_INDEX_ORDERED (1 << 6) 292 293struct split_index; 294struct index_state { 295 struct cache_entry **cache; 296 unsigned int version; 297 unsigned int cache_nr, cache_alloc, cache_changed; 298 struct string_list *resolve_undo; 299 struct cache_tree *cache_tree; 300 struct split_index *split_index; 301 struct cache_time timestamp; 302 unsigned name_hash_initialized : 1, 303 initialized : 1; 304 struct hashmap name_hash; 305 struct hashmap dir_hash; 306 unsigned char sha1[20]; 307}; 308 309extern struct index_state the_index; 310 311/* Name hashing */ 312extern void add_name_hash(struct index_state *istate, struct cache_entry *ce); 313extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce); 314extern void free_name_hash(struct index_state *istate); 315 316 317#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 318#define active_cache (the_index.cache) 319#define active_nr (the_index.cache_nr) 320#define active_alloc (the_index.cache_alloc) 321#define active_cache_changed (the_index.cache_changed) 322#define active_cache_tree (the_index.cache_tree) 323 324#define read_cache() read_index(&the_index) 325#define read_cache_from(path) read_index_from(&the_index, (path)) 326#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 327#define is_cache_unborn() is_index_unborn(&the_index) 328#define read_cache_unmerged() read_index_unmerged(&the_index) 329#define discard_cache() discard_index(&the_index) 330#define unmerged_cache() unmerged_index(&the_index) 331#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 332#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 333#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 334#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 335#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 336#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 337#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 338#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 339#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 340#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 341#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 342#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 343#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 344#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 345#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 346#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 347#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 348#endif 349 350enum object_type { 351 OBJ_BAD = -1, 352 OBJ_NONE = 0, 353 OBJ_COMMIT = 1, 354 OBJ_TREE = 2, 355 OBJ_BLOB = 3, 356 OBJ_TAG = 4, 357 /* 5 for future expansion */ 358 OBJ_OFS_DELTA = 6, 359 OBJ_REF_DELTA = 7, 360 OBJ_ANY, 361 OBJ_MAX 362}; 363 364static inline enum object_type object_type(unsigned int mode) 365{ 366 return S_ISDIR(mode) ? OBJ_TREE : 367 S_ISGITLINK(mode) ? OBJ_COMMIT : 368 OBJ_BLOB; 369} 370 371/* Double-check local_repo_env below if you add to this list. */ 372#define GIT_DIR_ENVIRONMENT "GIT_DIR" 373#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE" 374#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE" 375#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX" 376#define DEFAULT_GIT_DIR_ENVIRONMENT ".git" 377#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY" 378#define INDEX_ENVIRONMENT "GIT_INDEX_FILE" 379#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE" 380#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE" 381#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" 382#define CONFIG_ENVIRONMENT "GIT_CONFIG" 383#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS" 384#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH" 385#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES" 386#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS" 387#define GITATTRIBUTES_FILE ".gitattributes" 388#define INFOATTRIBUTES_FILE "info/attributes" 389#define ATTRIBUTE_MACRO_PREFIX "[attr]" 390#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF" 391#define GIT_NOTES_DEFAULT_REF "refs/notes/commits" 392#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF" 393#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF" 394#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE" 395#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS" 396#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS" 397#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS" 398#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS" 399 400/* 401 * This environment variable is expected to contain a boolean indicating 402 * whether we should or should not treat: 403 * 404 * GIT_DIR=foo.git git ... 405 * 406 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 407 * of this, but we use it internally to communicate to sub-processes that we 408 * are in a bare repo. If not set, defaults to true. 409 */ 410#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE" 411 412/* 413 * Repository-local GIT_* environment variables; these will be cleared 414 * when git spawns a sub-process that runs inside another repository. 415 * The array is NULL-terminated, which makes it easy to pass in the "env" 416 * parameter of a run-command invocation, or to do a simple walk. 417 */ 418extern const char * const local_repo_env[]; 419 420extern int is_bare_repository_cfg; 421extern int is_bare_repository(void); 422extern int is_inside_git_dir(void); 423extern char *git_work_tree_cfg; 424extern int is_inside_work_tree(void); 425extern const char *get_git_dir(void); 426extern int is_git_directory(const char *path); 427extern char *get_object_directory(void); 428extern char *get_index_file(void); 429extern char *get_graft_file(void); 430extern int set_git_dir(const char *path); 431extern const char *get_git_namespace(void); 432extern const char *strip_namespace(const char *namespaced_ref); 433extern const char *get_git_work_tree(void); 434extern const char *read_gitfile(const char *path); 435extern const char *resolve_gitdir(const char *suspect); 436extern void set_git_work_tree(const char *tree); 437 438#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES" 439 440extern const char **get_pathspec(const char *prefix, const char **pathspec); 441extern void setup_work_tree(void); 442extern const char *setup_git_directory_gently(int *); 443extern const char *setup_git_directory(void); 444extern char *prefix_path(const char *prefix, int len, const char *path); 445extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path); 446extern const char *prefix_filename(const char *prefix, int len, const char *path); 447extern int check_filename(const char *prefix, const char *name); 448extern void verify_filename(const char *prefix, 449 const char *name, 450 int diagnose_misspelt_rev); 451extern void verify_non_filename(const char *prefix, const char *name); 452extern int path_inside_repo(const char *prefix, const char *path); 453 454#define INIT_DB_QUIET 0x0001 455 456extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int); 457extern int init_db(const char *template_dir, unsigned int flags); 458 459extern void sanitize_stdfds(void); 460extern int daemonize(void); 461 462#define alloc_nr(x) (((x)+16)*3/2) 463 464/* 465 * Realloc the buffer pointed at by variable 'x' so that it can hold 466 * at least 'nr' entries; the number of entries currently allocated 467 * is 'alloc', using the standard growing factor alloc_nr() macro. 468 * 469 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 470 */ 471#define ALLOC_GROW(x, nr, alloc) \ 472 do { \ 473 if ((nr) > alloc) { \ 474 if (alloc_nr(alloc) < (nr)) \ 475 alloc = (nr); \ 476 else \ 477 alloc = alloc_nr(alloc); \ 478 REALLOC_ARRAY(x, alloc); \ 479 } \ 480 } while (0) 481 482/* Initialize and use the cache information */ 483struct lock_file; 484extern int read_index(struct index_state *); 485extern int read_index_preload(struct index_state *, const struct pathspec *pathspec); 486extern int do_read_index(struct index_state *istate, const char *path, 487 int must_exist); /* for testting only! */ 488extern int read_index_from(struct index_state *, const char *path); 489extern int is_index_unborn(struct index_state *); 490extern int read_index_unmerged(struct index_state *); 491#define COMMIT_LOCK (1 << 0) 492#define CLOSE_LOCK (1 << 1) 493extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags); 494extern int discard_index(struct index_state *); 495extern int unmerged_index(const struct index_state *); 496extern int verify_path(const char *path); 497extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen); 498extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase); 499extern int index_name_pos(const struct index_state *, const char *name, int namelen); 500#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */ 501#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */ 502#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */ 503#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */ 504#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */ 505#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */ 506extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option); 507extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name); 508extern int remove_index_entry_at(struct index_state *, int pos); 509extern void remove_marked_cache_entries(struct index_state *istate); 510extern int remove_file_from_index(struct index_state *, const char *path); 511#define ADD_CACHE_VERBOSE 1 512#define ADD_CACHE_PRETEND 2 513#define ADD_CACHE_IGNORE_ERRORS 4 514#define ADD_CACHE_IGNORE_REMOVAL 8 515#define ADD_CACHE_INTENT 16 516extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags); 517extern int add_file_to_index(struct index_state *, const char *path, int flags); 518extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options); 519extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b); 520extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce); 521extern int index_name_is_other(const struct index_state *, const char *, int); 522extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *); 523 524/* do stat comparison even if CE_VALID is true */ 525#define CE_MATCH_IGNORE_VALID 01 526/* do not check the contents but report dirty on racily-clean entries */ 527#define CE_MATCH_RACY_IS_DIRTY 02 528/* do stat comparison even if CE_SKIP_WORKTREE is true */ 529#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 530/* ignore non-existent files during stat update */ 531#define CE_MATCH_IGNORE_MISSING 0x08 532/* enable stat refresh */ 533#define CE_MATCH_REFRESH 0x10 534extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 535extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 536 537#define HASH_WRITE_OBJECT 1 538#define HASH_FORMAT_CHECK 2 539extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags); 540extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags); 541 542/* 543 * Record to sd the data from st that we use to check whether a file 544 * might have changed. 545 */ 546extern void fill_stat_data(struct stat_data *sd, struct stat *st); 547 548/* 549 * Return 0 if st is consistent with a file not having been changed 550 * since sd was filled. If there are differences, return a 551 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 552 * INODE_CHANGED, and DATA_CHANGED. 553 */ 554extern int match_stat_data(const struct stat_data *sd, struct stat *st); 555 556extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st); 557 558#define REFRESH_REALLY 0x0001 /* ignore_valid */ 559#define REFRESH_UNMERGED 0x0002 /* allow unmerged */ 560#define REFRESH_QUIET 0x0004 /* be quiet about it */ 561#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */ 562#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */ 563#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */ 564extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg); 565 566extern void update_index_if_able(struct index_state *, struct lock_file *); 567 568extern int hold_locked_index(struct lock_file *, int); 569extern void set_alternate_index_output(const char *); 570 571extern int delete_ref(const char *, const unsigned char *sha1, unsigned int flags); 572 573/* Environment bits from configuration mechanism */ 574extern int trust_executable_bit; 575extern int trust_ctime; 576extern int check_stat; 577extern int quote_path_fully; 578extern int has_symlinks; 579extern int minimum_abbrev, default_abbrev; 580extern int ignore_case; 581extern int assume_unchanged; 582extern int prefer_symlink_refs; 583extern int log_all_ref_updates; 584extern int warn_ambiguous_refs; 585extern int warn_on_object_refname_ambiguity; 586extern int shared_repository; 587extern const char *apply_default_whitespace; 588extern const char *apply_default_ignorewhitespace; 589extern const char *git_attributes_file; 590extern int zlib_compression_level; 591extern int core_compression_level; 592extern int core_compression_seen; 593extern size_t packed_git_window_size; 594extern size_t packed_git_limit; 595extern size_t delta_base_cache_limit; 596extern unsigned long big_file_threshold; 597extern unsigned long pack_size_limit_cfg; 598 599/* 600 * Do replace refs need to be checked this run? This variable is 601 * initialized to true unless --no-replace-object is used or 602 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 603 * commands that do not want replace references to be active. As an 604 * optimization it is also set to false if replace references have 605 * been sought but there were none. 606 */ 607extern int check_replace_refs; 608 609extern int fsync_object_files; 610extern int core_preload_index; 611extern int core_apply_sparse_checkout; 612extern int precomposed_unicode; 613extern int protect_hfs; 614extern int protect_ntfs; 615 616/* 617 * Include broken refs in all ref iterations, which will 618 * generally choke dangerous operations rather than letting 619 * them silently proceed without taking the broken ref into 620 * account. 621 */ 622extern int ref_paranoia; 623 624/* 625 * The character that begins a commented line in user-editable file 626 * that is subject to stripspace. 627 */ 628extern char comment_line_char; 629extern int auto_comment_line_char; 630 631enum branch_track { 632 BRANCH_TRACK_UNSPECIFIED = -1, 633 BRANCH_TRACK_NEVER = 0, 634 BRANCH_TRACK_REMOTE, 635 BRANCH_TRACK_ALWAYS, 636 BRANCH_TRACK_EXPLICIT, 637 BRANCH_TRACK_OVERRIDE 638}; 639 640enum rebase_setup_type { 641 AUTOREBASE_NEVER = 0, 642 AUTOREBASE_LOCAL, 643 AUTOREBASE_REMOTE, 644 AUTOREBASE_ALWAYS 645}; 646 647enum push_default_type { 648 PUSH_DEFAULT_NOTHING = 0, 649 PUSH_DEFAULT_MATCHING, 650 PUSH_DEFAULT_SIMPLE, 651 PUSH_DEFAULT_UPSTREAM, 652 PUSH_DEFAULT_CURRENT, 653 PUSH_DEFAULT_UNSPECIFIED 654}; 655 656extern enum branch_track git_branch_track; 657extern enum rebase_setup_type autorebase; 658extern enum push_default_type push_default; 659 660enum object_creation_mode { 661 OBJECT_CREATION_USES_HARDLINKS = 0, 662 OBJECT_CREATION_USES_RENAMES = 1 663}; 664 665extern enum object_creation_mode object_creation_mode; 666 667extern char *notes_ref_name; 668 669extern int grafts_replace_parents; 670 671#define GIT_REPO_VERSION 0 672extern int repository_format_version; 673extern int check_repository_format(void); 674 675#define MTIME_CHANGED 0x0001 676#define CTIME_CHANGED 0x0002 677#define OWNER_CHANGED 0x0004 678#define MODE_CHANGED 0x0008 679#define INODE_CHANGED 0x0010 680#define DATA_CHANGED 0x0020 681#define TYPE_CHANGED 0x0040 682 683extern char *mksnpath(char *buf, size_t n, const char *fmt, ...) 684 __attribute__((format (printf, 3, 4))); 685extern char *git_snpath(char *buf, size_t n, const char *fmt, ...) 686 __attribute__((format (printf, 3, 4))); 687extern char *git_pathdup(const char *fmt, ...) 688 __attribute__((format (printf, 1, 2))); 689extern char *mkpathdup(const char *fmt, ...) 690 __attribute__((format (printf, 1, 2))); 691 692/* Return a statically allocated filename matching the sha1 signature */ 693extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 694extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 695extern char *git_path_submodule(const char *path, const char *fmt, ...) 696 __attribute__((format (printf, 2, 3))); 697 698/* 699 * Return the name of the file in the local object database that would 700 * be used to store a loose object with the specified sha1. The 701 * return value is a pointer to a statically allocated buffer that is 702 * overwritten each time the function is called. 703 */ 704extern const char *sha1_file_name(const unsigned char *sha1); 705 706/* 707 * Return the name of the (local) packfile with the specified sha1 in 708 * its name. The return value is a pointer to memory that is 709 * overwritten each time this function is called. 710 */ 711extern char *sha1_pack_name(const unsigned char *sha1); 712 713/* 714 * Return the name of the (local) pack index file with the specified 715 * sha1 in its name. The return value is a pointer to memory that is 716 * overwritten each time this function is called. 717 */ 718extern char *sha1_pack_index_name(const unsigned char *sha1); 719 720extern const char *find_unique_abbrev(const unsigned char *sha1, int); 721extern const unsigned char null_sha1[20]; 722 723static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2) 724{ 725 int i; 726 727 for (i = 0; i < 20; i++, sha1++, sha2++) { 728 if (*sha1 != *sha2) 729 return *sha1 - *sha2; 730 } 731 732 return 0; 733} 734 735static inline int is_null_sha1(const unsigned char *sha1) 736{ 737 return !hashcmp(sha1, null_sha1); 738} 739 740static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src) 741{ 742 memcpy(sha_dst, sha_src, 20); 743} 744static inline void hashclr(unsigned char *hash) 745{ 746 memset(hash, 0, 20); 747} 748 749#define EMPTY_TREE_SHA1_HEX \ 750 "4b825dc642cb6eb9a060e54bf8d69288fbee4904" 751#define EMPTY_TREE_SHA1_BIN_LITERAL \ 752 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \ 753 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04" 754#define EMPTY_TREE_SHA1_BIN \ 755 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL) 756 757#define EMPTY_BLOB_SHA1_HEX \ 758 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391" 759#define EMPTY_BLOB_SHA1_BIN_LITERAL \ 760 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \ 761 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91" 762#define EMPTY_BLOB_SHA1_BIN \ 763 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL) 764 765static inline int is_empty_blob_sha1(const unsigned char *sha1) 766{ 767 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN); 768} 769 770int git_mkstemp(char *path, size_t n, const char *template); 771 772int git_mkstemps(char *path, size_t n, const char *template, int suffix_len); 773 774/* set default permissions by passing mode arguments to open(2) */ 775int git_mkstemps_mode(char *pattern, int suffix_len, int mode); 776int git_mkstemp_mode(char *pattern, int mode); 777 778/* 779 * NOTE NOTE NOTE!! 780 * 781 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must 782 * not be changed. Old repositories have core.sharedrepository written in 783 * numeric format, and therefore these values are preserved for compatibility 784 * reasons. 785 */ 786enum sharedrepo { 787 PERM_UMASK = 0, 788 OLD_PERM_GROUP = 1, 789 OLD_PERM_EVERYBODY = 2, 790 PERM_GROUP = 0660, 791 PERM_EVERYBODY = 0664 792}; 793int git_config_perm(const char *var, const char *value); 794int adjust_shared_perm(const char *path); 795 796/* 797 * Create the directory containing the named path, using care to be 798 * somewhat safe against races. Return one of the scld_error values 799 * to indicate success/failure. 800 * 801 * SCLD_VANISHED indicates that one of the ancestor directories of the 802 * path existed at one point during the function call and then 803 * suddenly vanished, probably because another process pruned the 804 * directory while we were working. To be robust against this kind of 805 * race, callers might want to try invoking the function again when it 806 * returns SCLD_VANISHED. 807 */ 808enum scld_error { 809 SCLD_OK = 0, 810 SCLD_FAILED = -1, 811 SCLD_PERMS = -2, 812 SCLD_EXISTS = -3, 813 SCLD_VANISHED = -4 814}; 815enum scld_error safe_create_leading_directories(char *path); 816enum scld_error safe_create_leading_directories_const(const char *path); 817 818int mkdir_in_gitdir(const char *path); 819extern char *expand_user_path(const char *path); 820const char *enter_repo(const char *path, int strict); 821static inline int is_absolute_path(const char *path) 822{ 823 return is_dir_sep(path[0]) || has_dos_drive_prefix(path); 824} 825int is_directory(const char *); 826const char *real_path(const char *path); 827const char *real_path_if_valid(const char *path); 828const char *absolute_path(const char *path); 829const char *remove_leading_path(const char *in, const char *prefix); 830const char *relative_path(const char *in, const char *prefix, struct strbuf *sb); 831int normalize_path_copy_len(char *dst, const char *src, int *prefix_len); 832int normalize_path_copy(char *dst, const char *src); 833int longest_ancestor_length(const char *path, struct string_list *prefixes); 834char *strip_path_suffix(const char *path, const char *suffix); 835int daemon_avoid_alias(const char *path); 836extern int is_ntfs_dotgit(const char *name); 837 838/** 839 * Return a newly allocated string with the evaluation of 840 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise 841 * "$HOME/.config/git/$filename". Return NULL upon error. 842 */ 843extern char *xdg_config_home(const char *filename); 844 845/* object replacement */ 846#define LOOKUP_REPLACE_OBJECT 1 847extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag); 848static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size) 849{ 850 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT); 851} 852 853/* 854 * This internal function is only declared here for the benefit of 855 * lookup_replace_object(). Please do not call it directly. 856 */ 857extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1); 858 859/* 860 * If object sha1 should be replaced, return the replacement object's 861 * name (replaced recursively, if necessary). The return value is 862 * either sha1 or a pointer to a permanently-allocated value. When 863 * object replacement is suppressed, always return sha1. 864 */ 865static inline const unsigned char *lookup_replace_object(const unsigned char *sha1) 866{ 867 if (!check_replace_refs) 868 return sha1; 869 return do_lookup_replace_object(sha1); 870} 871 872static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag) 873{ 874 if (!(flag & LOOKUP_REPLACE_OBJECT)) 875 return sha1; 876 return lookup_replace_object(sha1); 877} 878 879/* Read and unpack a sha1 file into memory, write memory to a sha1 file */ 880extern int sha1_object_info(const unsigned char *, unsigned long *); 881extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1); 882extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1); 883extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags); 884extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *); 885extern int force_object_loose(const unsigned char *sha1, time_t mtime); 886extern int git_open_noatime(const char *name); 887extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size); 888extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz); 889extern int parse_sha1_header(const char *hdr, unsigned long *sizep); 890 891/* global flag to enable extra checks when accessing packed objects */ 892extern int do_check_packed_object_crc; 893 894extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type); 895 896extern int move_temp_to_file(const char *tmpfile, const char *filename); 897 898extern int has_sha1_pack(const unsigned char *sha1); 899 900/* 901 * Return true iff we have an object named sha1, whether local or in 902 * an alternate object database, and whether packed or loose. This 903 * function does not respect replace references. 904 * 905 * If the QUICK flag is set, do not re-check the pack directory 906 * when we cannot find the object (this means we may give a false 907 * negative answer if another process is simultaneously repacking). 908 */ 909#define HAS_SHA1_QUICK 0x1 910extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags); 911static inline int has_sha1_file(const unsigned char *sha1) 912{ 913 return has_sha1_file_with_flags(sha1, 0); 914} 915 916/* 917 * Return true iff an alternate object database has a loose object 918 * with the specified name. This function does not respect replace 919 * references. 920 */ 921extern int has_loose_object_nonlocal(const unsigned char *sha1); 922 923extern int has_pack_index(const unsigned char *sha1); 924 925extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect); 926 927extern const signed char hexval_table[256]; 928static inline unsigned int hexval(unsigned char c) 929{ 930 return hexval_table[c]; 931} 932 933/* Convert to/from hex/sha1 representation */ 934#define MINIMUM_ABBREV minimum_abbrev 935#define DEFAULT_ABBREV default_abbrev 936 937struct object_context { 938 unsigned char tree[20]; 939 char path[PATH_MAX]; 940 unsigned mode; 941}; 942 943#define GET_SHA1_QUIETLY 01 944#define GET_SHA1_COMMIT 02 945#define GET_SHA1_COMMITTISH 04 946#define GET_SHA1_TREE 010 947#define GET_SHA1_TREEISH 020 948#define GET_SHA1_BLOB 040 949#define GET_SHA1_ONLY_TO_DIE 04000 950 951extern int get_sha1(const char *str, unsigned char *sha1); 952extern int get_sha1_commit(const char *str, unsigned char *sha1); 953extern int get_sha1_committish(const char *str, unsigned char *sha1); 954extern int get_sha1_tree(const char *str, unsigned char *sha1); 955extern int get_sha1_treeish(const char *str, unsigned char *sha1); 956extern int get_sha1_blob(const char *str, unsigned char *sha1); 957extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix); 958extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc); 959 960typedef int each_abbrev_fn(const unsigned char *sha1, void *); 961extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *); 962 963/* 964 * Try to read a SHA1 in hexadecimal format from the 40 characters 965 * starting at hex. Write the 20-byte result to sha1 in binary form. 966 * Return 0 on success. Reading stops if a NUL is encountered in the 967 * input, so it is safe to pass this function an arbitrary 968 * null-terminated string. 969 */ 970extern int get_sha1_hex(const char *hex, unsigned char *sha1); 971 972extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */ 973extern int read_ref_full(const char *refname, int resolve_flags, 974 unsigned char *sha1, int *flags); 975extern int read_ref(const char *refname, unsigned char *sha1); 976 977/* 978 * Resolve a reference, recursively following symbolic refererences. 979 * 980 * Store the referred-to object's name in sha1 and return the name of 981 * the non-symbolic reference that ultimately pointed at it. The 982 * return value, if not NULL, is a pointer into either a static buffer 983 * or the input ref. 984 * 985 * If the reference cannot be resolved to an object, the behavior 986 * depends on the RESOLVE_REF_READING flag: 987 * 988 * - If RESOLVE_REF_READING is set, return NULL. 989 * 990 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of 991 * the last reference name in the chain, which will either be a non-symbolic 992 * reference or an undefined reference. If this is a prelude to 993 * "writing" to the ref, the return value is the name of the ref 994 * that will actually be created or changed. 995 * 996 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one 997 * level of symbolic reference. The value stored in sha1 for a symbolic 998 * reference will always be null_sha1 in this case, and the return 999 * value is the reference that the symref refers to directly.1000 *1001 * If flags is non-NULL, set the value that it points to the1002 * combination of REF_ISPACKED (if the reference was found among the1003 * packed references), REF_ISSYMREF (if the initial reference was a1004 * symbolic reference), REF_BAD_NAME (if the reference name is ill1005 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN1006 * (if the ref is malformed or has a bad name). See refs.h for more detail1007 * on each flag.1008 *1009 * If ref is not a properly-formatted, normalized reference, return1010 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,1011 * give up and return NULL.1012 *1013 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their1014 * name is invalid according to git-check-ref-format(1). If the name1015 * is bad then the value stored in sha1 will be null_sha1 and the two1016 * flags REF_ISBROKEN and REF_BAD_NAME will be set.1017 *1018 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/1019 * directory and do not consist of all caps and underscores cannot be1020 * resolved. The function returns NULL for such ref names.1021 * Caps and underscores refers to the special refs, such as HEAD,1022 * FETCH_HEAD and friends, that all live outside of the refs/ directory.1023 */1024#define RESOLVE_REF_READING 0x011025#define RESOLVE_REF_NO_RECURSE 0x021026#define RESOLVE_REF_ALLOW_BAD_NAME 0x041027extern const char *resolve_ref_unsafe(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);1028extern char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);10291030extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);1031extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);1032extern int interpret_branch_name(const char *str, int len, struct strbuf *);1033extern int get_sha1_mb(const char *str, unsigned char *sha1);10341035/*1036 * Return true iff abbrev_name is a possible abbreviation for1037 * full_name according to the rules defined by ref_rev_parse_rules in1038 * refs.c.1039 */1040extern int refname_match(const char *abbrev_name, const char *full_name);10411042extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);1043extern int validate_headref(const char *ref);10441045extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1046extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1047extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);1048extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);10491050extern void *read_object_with_reference(const unsigned char *sha1,1051 const char *required_type,1052 unsigned long *size,1053 unsigned char *sha1_ret);10541055extern struct object *peel_to_type(const char *name, int namelen,1056 struct object *o, enum object_type);10571058enum date_mode {1059 DATE_NORMAL = 0,1060 DATE_RELATIVE,1061 DATE_SHORT,1062 DATE_LOCAL,1063 DATE_ISO8601,1064 DATE_ISO8601_STRICT,1065 DATE_RFC2822,1066 DATE_RAW1067};10681069const char *show_date(unsigned long time, int timezone, enum date_mode mode);1070void show_date_relative(unsigned long time, int tz, const struct timeval *now,1071 struct strbuf *timebuf);1072int parse_date(const char *date, struct strbuf *out);1073int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);1074int parse_expiry_date(const char *date, unsigned long *timestamp);1075void datestamp(struct strbuf *out);1076#define approxidate(s) approxidate_careful((s), NULL)1077unsigned long approxidate_careful(const char *, int *);1078unsigned long approxidate_relative(const char *date, const struct timeval *now);1079enum date_mode parse_date_format(const char *format);1080int date_overflows(unsigned long date);10811082#define IDENT_STRICT 11083#define IDENT_NO_DATE 21084#define IDENT_NO_NAME 41085extern const char *git_author_info(int);1086extern const char *git_committer_info(int);1087extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);1088extern const char *fmt_name(const char *name, const char *email);1089extern const char *ident_default_name(void);1090extern const char *ident_default_email(void);1091extern const char *git_editor(void);1092extern const char *git_pager(int stdout_is_tty);1093extern int git_ident_config(const char *, const char *, void *);10941095struct ident_split {1096 const char *name_begin;1097 const char *name_end;1098 const char *mail_begin;1099 const char *mail_end;1100 const char *date_begin;1101 const char *date_end;1102 const char *tz_begin;1103 const char *tz_end;1104};1105/*1106 * Signals an success with 0, but time part of the result may be NULL1107 * if the input lacks timestamp and zone1108 */1109extern int split_ident_line(struct ident_split *, const char *, int);11101111/*1112 * Like show_date, but pull the timestamp and tz parameters from1113 * the ident_split. It will also sanity-check the values and produce1114 * a well-known sentinel date if they appear bogus.1115 */1116const char *show_ident_date(const struct ident_split *id, enum date_mode mode);11171118/*1119 * Compare split idents for equality or strict ordering. Note that we1120 * compare only the ident part of the line, ignoring any timestamp.1121 *1122 * Because there are two fields, we must choose one as the primary key; we1123 * currently arbitrarily pick the email.1124 */1125extern int ident_cmp(const struct ident_split *, const struct ident_split *);11261127struct checkout {1128 struct index_state *istate;1129 const char *base_dir;1130 int base_dir_len;1131 unsigned force:1,1132 quiet:1,1133 not_new:1,1134 refresh_cache:1;1135};11361137#define TEMPORARY_FILENAME_LENGTH 251138extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);11391140struct cache_def {1141 struct strbuf path;1142 int flags;1143 int track_flags;1144 int prefix_len_stat_func;1145};1146#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1147static inline void cache_def_clear(struct cache_def *cache)1148{1149 strbuf_release(&cache->path);1150}11511152extern int has_symlink_leading_path(const char *name, int len);1153extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);1154extern int check_leading_path(const char *name, int len);1155extern int has_dirs_only_path(const char *name, int len, int prefix_len);1156extern void schedule_dir_for_removal(const char *name, int len);1157extern void remove_scheduled_dirs(void);11581159extern struct alternate_object_database {1160 struct alternate_object_database *next;1161 char *name;1162 char base[FLEX_ARRAY]; /* more */1163} *alt_odb_list;1164extern void prepare_alt_odb(void);1165extern void read_info_alternates(const char * relative_base, int depth);1166extern void add_to_alternates_file(const char *reference);1167typedef int alt_odb_fn(struct alternate_object_database *, void *);1168extern int foreach_alt_odb(alt_odb_fn, void*);11691170struct pack_window {1171 struct pack_window *next;1172 unsigned char *base;1173 off_t offset;1174 size_t len;1175 unsigned int last_used;1176 unsigned int inuse_cnt;1177};11781179extern struct packed_git {1180 struct packed_git *next;1181 struct pack_window *windows;1182 off_t pack_size;1183 const void *index_data;1184 size_t index_size;1185 uint32_t num_objects;1186 uint32_t num_bad_objects;1187 unsigned char *bad_object_sha1;1188 int index_version;1189 time_t mtime;1190 int pack_fd;1191 unsigned pack_local:1,1192 pack_keep:1,1193 freshened:1,1194 do_not_close:1;1195 unsigned char sha1[20];1196 /* something like ".git/objects/pack/xxxxx.pack" */1197 char pack_name[FLEX_ARRAY]; /* more */1198} *packed_git;11991200struct pack_entry {1201 off_t offset;1202 unsigned char sha1[20];1203 struct packed_git *p;1204};12051206extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);12071208/* A hook for count-objects to report invalid files in pack directory */1209extern void (*report_garbage)(const char *desc, const char *path);12101211extern void prepare_packed_git(void);1212extern void reprepare_packed_git(void);1213extern void install_packed_git(struct packed_git *pack);12141215extern struct packed_git *find_sha1_pack(const unsigned char *sha1,1216 struct packed_git *packs);12171218extern void pack_report(void);12191220/*1221 * mmap the index file for the specified packfile (if it is not1222 * already mmapped). Return 0 on success.1223 */1224extern int open_pack_index(struct packed_git *);12251226/*1227 * munmap the index file for the specified packfile (if it is1228 * currently mmapped).1229 */1230extern void close_pack_index(struct packed_git *);12311232extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);1233extern void close_pack_windows(struct packed_git *);1234extern void unuse_pack(struct pack_window **);1235extern void free_pack_by_name(const char *);1236extern void clear_delta_base_cache(void);1237extern struct packed_git *add_packed_git(const char *, int, int);12381239/*1240 * Return the SHA-1 of the nth object within the specified packfile.1241 * Open the index if it is not already open. The return value points1242 * at the SHA-1 within the mmapped index. Return NULL if there is an1243 * error.1244 */1245extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);12461247/*1248 * Return the offset of the nth object within the specified packfile.1249 * The index must already be opened.1250 */1251extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);12521253/*1254 * If the object named sha1 is present in the specified packfile,1255 * return its offset within the packfile; otherwise, return 0.1256 */1257extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);12581259extern int is_pack_valid(struct packed_git *);1260extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);1261extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);1262extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);1263extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);12641265/*1266 * Iterate over the files in the loose-object parts of the object1267 * directory "path", triggering the following callbacks:1268 *1269 * - loose_object is called for each loose object we find.1270 *1271 * - loose_cruft is called for any files that do not appear to be1272 * loose objects. Note that we only look in the loose object1273 * directories "objects/[0-9a-f]{2}/", so we will not report1274 * "objects/foobar" as cruft.1275 *1276 * - loose_subdir is called for each top-level hashed subdirectory1277 * of the object directory (e.g., "$OBJDIR/f0"). It is called1278 * after the objects in the directory are processed.1279 *1280 * Any callback that is NULL will be ignored. Callbacks returning non-zero1281 * will end the iteration.1282 *1283 * In the "buf" variant, "path" is a strbuf which will also be used as a1284 * scratch buffer, but restored to its original contents before1285 * the function returns.1286 */1287typedef int each_loose_object_fn(const unsigned char *sha1,1288 const char *path,1289 void *data);1290typedef int each_loose_cruft_fn(const char *basename,1291 const char *path,1292 void *data);1293typedef int each_loose_subdir_fn(int nr,1294 const char *path,1295 void *data);1296int for_each_loose_file_in_objdir(const char *path,1297 each_loose_object_fn obj_cb,1298 each_loose_cruft_fn cruft_cb,1299 each_loose_subdir_fn subdir_cb,1300 void *data);1301int for_each_loose_file_in_objdir_buf(struct strbuf *path,1302 each_loose_object_fn obj_cb,1303 each_loose_cruft_fn cruft_cb,1304 each_loose_subdir_fn subdir_cb,1305 void *data);13061307/*1308 * Iterate over loose and packed objects in both the local1309 * repository and any alternates repositories (unless the1310 * LOCAL_ONLY flag is set).1311 */1312#define FOR_EACH_OBJECT_LOCAL_ONLY 0x11313typedef int each_packed_object_fn(const unsigned char *sha1,1314 struct packed_git *pack,1315 uint32_t pos,1316 void *data);1317extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);1318extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);13191320struct object_info {1321 /* Request */1322 enum object_type *typep;1323 unsigned long *sizep;1324 unsigned long *disk_sizep;1325 unsigned char *delta_base_sha1;13261327 /* Response */1328 enum {1329 OI_CACHED,1330 OI_LOOSE,1331 OI_PACKED,1332 OI_DBCACHED1333 } whence;1334 union {1335 /*1336 * struct {1337 * ... Nothing to expose in this case1338 * } cached;1339 * struct {1340 * ... Nothing to expose in this case1341 * } loose;1342 */1343 struct {1344 struct packed_git *pack;1345 off_t offset;1346 unsigned int is_delta;1347 } packed;1348 } u;1349};1350extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);13511352/* Dumb servers support */1353extern int update_server_info(int);13541355/* git_config_parse_key() returns these negated: */1356#define CONFIG_INVALID_KEY 11357#define CONFIG_NO_SECTION_OR_NAME 21358/* git_config_set(), git_config_set_multivar() return the above or these: */1359#define CONFIG_NO_LOCK -11360#define CONFIG_INVALID_FILE 31361#define CONFIG_NO_WRITE 41362#define CONFIG_NOTHING_SET 51363#define CONFIG_INVALID_PATTERN 61364#define CONFIG_GENERIC_ERROR 713651366#define CONFIG_REGEX_NONE ((void *)1)13671368struct git_config_source {1369 unsigned int use_stdin:1;1370 const char *file;1371 const char *blob;1372};13731374typedef int (*config_fn_t)(const char *, const char *, void *);1375extern int git_default_config(const char *, const char *, void *);1376extern int git_config_from_file(config_fn_t fn, const char *, void *);1377extern int git_config_from_buf(config_fn_t fn, const char *name,1378 const char *buf, size_t len, void *data);1379extern void git_config_push_parameter(const char *text);1380extern int git_config_from_parameters(config_fn_t fn, void *data);1381extern void git_config(config_fn_t fn, void *);1382extern int git_config_with_options(config_fn_t fn, void *,1383 struct git_config_source *config_source,1384 int respect_includes);1385extern int git_config_early(config_fn_t fn, void *, const char *repo_config);1386extern int git_parse_ulong(const char *, unsigned long *);1387extern int git_config_int(const char *, const char *);1388extern int64_t git_config_int64(const char *, const char *);1389extern unsigned long git_config_ulong(const char *, const char *);1390extern int git_config_bool_or_int(const char *, const char *, int *);1391extern int git_config_bool(const char *, const char *);1392extern int git_config_maybe_bool(const char *, const char *);1393extern int git_config_string(const char **, const char *, const char *);1394extern int git_config_pathname(const char **, const char *, const char *);1395extern int git_config_set_in_file(const char *, const char *, const char *);1396extern int git_config_set(const char *, const char *);1397extern int git_config_parse_key(const char *, char **, int *);1398extern int git_config_set_multivar(const char *, const char *, const char *, int);1399extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);1400extern int git_config_rename_section(const char *, const char *);1401extern int git_config_rename_section_in_file(const char *, const char *, const char *);1402extern const char *git_etc_gitconfig(void);1403extern int check_repository_format_version(const char *var, const char *value, void *cb);1404extern int git_env_bool(const char *, int);1405extern unsigned long git_env_ulong(const char *, unsigned long);1406extern int git_config_system(void);1407extern int config_error_nonbool(const char *);1408#if defined(__GNUC__)1409#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1410#endif1411extern const char *get_log_output_encoding(void);1412extern const char *get_commit_output_encoding(void);14131414extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);14151416struct config_include_data {1417 int depth;1418 config_fn_t fn;1419 void *data;1420};1421#define CONFIG_INCLUDE_INIT { 0 }1422extern int git_config_include(const char *name, const char *value, void *data);14231424/*1425 * Match and parse a config key of the form:1426 *1427 * section.(subsection.)?key1428 *1429 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1430 * we return -1 if it does not match, 0 otherwise. The subsection and key1431 * out-parameters are filled by the function (and subsection is NULL if it is1432 * missing).1433 */1434extern int parse_config_key(const char *var,1435 const char *section,1436 const char **subsection, int *subsection_len,1437 const char **key);14381439struct config_set_element {1440 struct hashmap_entry ent;1441 char *key;1442 struct string_list value_list;1443};14441445struct configset_list_item {1446 struct config_set_element *e;1447 int value_index;1448};14491450/*1451 * the contents of the list are ordered according to their1452 * position in the config files and order of parsing the files.1453 * (i.e. key-value pair at the last position of .git/config will1454 * be at the last item of the list)1455 */1456struct configset_list {1457 struct configset_list_item *items;1458 unsigned int nr, alloc;1459};14601461struct config_set {1462 struct hashmap config_hash;1463 int hash_initialized;1464 struct configset_list list;1465};14661467extern void git_configset_init(struct config_set *cs);1468extern int git_configset_add_file(struct config_set *cs, const char *filename);1469extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);1470extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);1471extern void git_configset_clear(struct config_set *cs);1472extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);1473extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);1474extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);1475extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);1476extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);1477extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);1478extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);1479extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);14801481extern int git_config_get_value(const char *key, const char **value);1482extern const struct string_list *git_config_get_value_multi(const char *key);1483extern void git_config_clear(void);1484extern void git_config_iter(config_fn_t fn, void *data);1485extern int git_config_get_string_const(const char *key, const char **dest);1486extern int git_config_get_string(const char *key, char **dest);1487extern int git_config_get_int(const char *key, int *dest);1488extern int git_config_get_ulong(const char *key, unsigned long *dest);1489extern int git_config_get_bool(const char *key, int *dest);1490extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);1491extern int git_config_get_maybe_bool(const char *key, int *dest);1492extern int git_config_get_pathname(const char *key, const char **dest);14931494struct key_value_info {1495 const char *filename;1496 int linenr;1497};14981499extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));1500extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);15011502extern int committer_ident_sufficiently_given(void);1503extern int author_ident_sufficiently_given(void);15041505extern const char *git_commit_encoding;1506extern const char *git_log_output_encoding;1507extern const char *git_mailmap_file;1508extern const char *git_mailmap_blob;15091510/* IO helper functions */1511extern void maybe_flush_or_die(FILE *, const char *);1512__attribute__((format (printf, 2, 3)))1513extern void fprintf_or_die(FILE *, const char *fmt, ...);1514extern int copy_fd(int ifd, int ofd);1515extern int copy_file(const char *dst, const char *src, int mode);1516extern int copy_file_with_time(const char *dst, const char *src, int mode);1517extern void write_or_die(int fd, const void *buf, size_t count);1518extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);1519extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);1520extern void fsync_or_die(int fd, const char *);15211522extern ssize_t read_in_full(int fd, void *buf, size_t count);1523extern ssize_t write_in_full(int fd, const void *buf, size_t count);1524extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);15251526static inline ssize_t write_str_in_full(int fd, const char *str)1527{1528 return write_in_full(fd, str, strlen(str));1529}15301531/* pager.c */1532extern void setup_pager(void);1533extern const char *pager_program;1534extern int pager_in_use(void);1535extern int pager_use_color;1536extern int term_columns(void);1537extern int decimal_width(uintmax_t);1538extern int check_pager_config(const char *cmd);15391540extern const char *editor_program;1541extern const char *askpass_program;1542extern const char *excludes_file;15431544/* base85 */1545int decode_85(char *dst, const char *line, int linelen);1546void encode_85(char *buf, const unsigned char *data, int bytes);15471548/* alloc.c */1549extern void *alloc_blob_node(void);1550extern void *alloc_tree_node(void);1551extern void *alloc_commit_node(void);1552extern void *alloc_tag_node(void);1553extern void *alloc_object_node(void);1554extern void alloc_report(void);1555extern unsigned int alloc_commit_index(void);15561557/* pkt-line.c */1558void packet_trace_identity(const char *prog);15591560/* add */1561/*1562 * return 0 if success, 1 - if addition of a file failed and1563 * ADD_FILES_IGNORE_ERRORS was specified in flags1564 */1565int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);15661567/* diff.c */1568extern int diff_auto_refresh_index;15691570/* match-trees.c */1571void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);1572void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);15731574/*1575 * whitespace rules.1576 * used by both diff and apply1577 * last two digits are tab width1578 */1579#define WS_BLANK_AT_EOL 01001580#define WS_SPACE_BEFORE_TAB 02001581#define WS_INDENT_WITH_NON_TAB 04001582#define WS_CR_AT_EOL 010001583#define WS_BLANK_AT_EOF 020001584#define WS_TAB_IN_INDENT 040001585#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1586#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1587#define WS_TAB_WIDTH_MASK 0771588extern unsigned whitespace_rule_cfg;1589extern unsigned whitespace_rule(const char *);1590extern unsigned parse_whitespace_rule(const char *);1591extern unsigned ws_check(const char *line, int len, unsigned ws_rule);1592extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);1593extern char *whitespace_error_string(unsigned ws);1594extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);1595extern int ws_blank_line(const char *line, int len, unsigned ws_rule);1596#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)15971598/* ls-files */1599void overlay_tree_on_cache(const char *tree_name, const char *prefix);16001601char *alias_lookup(const char *alias);1602int split_cmdline(char *cmdline, const char ***argv);1603/* Takes a negative value returned by split_cmdline */1604const char *split_cmdline_strerror(int cmdline_errno);16051606/* git.c */1607struct startup_info {1608 int have_repository;1609 const char *prefix;1610};1611extern struct startup_info *startup_info;16121613/* merge.c */1614struct commit_list;1615int try_merge_command(const char *strategy, size_t xopts_nr,1616 const char **xopts, struct commit_list *common,1617 const char *head_arg, struct commit_list *remotes);1618int checkout_fast_forward(const unsigned char *from,1619 const unsigned char *to,1620 int overwrite_ignore);162116221623int sane_execvp(const char *file, char *const argv[]);16241625/*1626 * A struct to encapsulate the concept of whether a file has changed1627 * since we last checked it. This uses criteria similar to those used1628 * for the index.1629 */1630struct stat_validity {1631 struct stat_data *sd;1632};16331634void stat_validity_clear(struct stat_validity *sv);16351636/*1637 * Returns 1 if the path is a regular file (or a symlink to a regular1638 * file) and matches the saved stat_validity, 0 otherwise. A missing1639 * or inaccessible file is considered a match if the struct was just1640 * initialized, or if the previous update found an inaccessible file.1641 */1642int stat_validity_check(struct stat_validity *sv, const char *path);16431644/*1645 * Update the stat_validity from a file opened at descriptor fd. If1646 * the file is missing, inaccessible, or not a regular file, then1647 * future calls to stat_validity_check will match iff one of those1648 * conditions continues to be true.1649 */1650void stat_validity_update(struct stat_validity *sv, int fd);16511652int versioncmp(const char *s1, const char *s2);16531654#endif /* CACHE_H */