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 * NOTE! We *really* shouldn't depend on the S_IFxxx macros 70 * always having the same values everywhere. We should use 71 * our internal git values for these things, and then we can 72 * translate that to the OS-specific value. It just so 73 * happens that everybody shares the same bit representation 74 * in the UNIX world (and apparently wider too..) 75 */ 76#define S_IFGITLINK 0160000 77#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) 78 79/* 80 * Some mode bits are also used internally for computations. 81 * 82 * They *must* not overlap with any valid modes, and they *must* not be emitted 83 * to outside world - i.e. appear on disk or network. In other words, it's just 84 * temporary fields, which we internally use, but they have to stay in-house. 85 * 86 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git 87 * codebase mode is `unsigned int` which is assumed to be at least 32 bits ) 88 */ 89 90/* used internally in tree-diff */ 91#define S_DIFFTREE_IFXMIN_NEQ 0x80000000 92 93 94/* 95 * Intensive research over the course of many years has shown that 96 * port 9418 is totally unused by anything else. Or 97 * 98 * Your search - "port 9418" - did not match any documents. 99 * 100 * as www.google.com puts it. 101 * 102 * This port has been properly assigned for git use by IANA: 103 * git (Assigned-9418) [I06-050728-0001]. 104 * 105 * git 9418/tcp git pack transfer service 106 * git 9418/udp git pack transfer service 107 * 108 * with Linus Torvalds <torvalds@osdl.org> as the point of 109 * contact. September 2005. 110 * 111 * See http://www.iana.org/assignments/port-numbers 112 */ 113#define DEFAULT_GIT_PORT 9418 114 115/* 116 * Basic data structures for the directory cache 117 */ 118 119#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */ 120struct cache_header { 121 uint32_t hdr_signature; 122 uint32_t hdr_version; 123 uint32_t hdr_entries; 124}; 125 126#define INDEX_FORMAT_LB 2 127#define INDEX_FORMAT_UB 4 128 129/* 130 * The "cache_time" is just the low 32 bits of the 131 * time. It doesn't matter if it overflows - we only 132 * check it for equality in the 32 bits we save. 133 */ 134struct cache_time { 135 uint32_t sec; 136 uint32_t nsec; 137}; 138 139struct stat_data { 140 struct cache_time sd_ctime; 141 struct cache_time sd_mtime; 142 unsigned int sd_dev; 143 unsigned int sd_ino; 144 unsigned int sd_uid; 145 unsigned int sd_gid; 146 unsigned int sd_size; 147}; 148 149struct cache_entry { 150 struct hashmap_entry ent; 151 struct stat_data ce_stat_data; 152 unsigned int ce_mode; 153 unsigned int ce_flags; 154 unsigned int ce_namelen; 155 unsigned int index; /* for link extension */ 156 unsigned char sha1[20]; 157 char name[FLEX_ARRAY]; /* more */ 158}; 159 160#define CE_STAGEMASK (0x3000) 161#define CE_EXTENDED (0x4000) 162#define CE_VALID (0x8000) 163#define CE_STAGESHIFT 12 164 165/* 166 * Range 0xFFFF0FFF in ce_flags is divided into 167 * two parts: in-memory flags and on-disk ones. 168 * Flags in CE_EXTENDED_FLAGS will get saved on-disk 169 * if you want to save a new flag, add it in 170 * CE_EXTENDED_FLAGS 171 * 172 * In-memory only flags 173 */ 174#define CE_UPDATE (1 << 16) 175#define CE_REMOVE (1 << 17) 176#define CE_UPTODATE (1 << 18) 177#define CE_ADDED (1 << 19) 178 179#define CE_HASHED (1 << 20) 180#define CE_WT_REMOVE (1 << 22) /* remove in work directory */ 181#define CE_CONFLICTED (1 << 23) 182 183#define CE_UNPACKED (1 << 24) 184#define CE_NEW_SKIP_WORKTREE (1 << 25) 185 186/* used to temporarily mark paths matched by pathspecs */ 187#define CE_MATCHED (1 << 26) 188 189#define CE_UPDATE_IN_BASE (1 << 27) 190#define CE_STRIP_NAME (1 << 28) 191 192/* 193 * Extended on-disk flags 194 */ 195#define CE_INTENT_TO_ADD (1 << 29) 196#define CE_SKIP_WORKTREE (1 << 30) 197/* CE_EXTENDED2 is for future extension */ 198#define CE_EXTENDED2 (1 << 31) 199 200#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE) 201 202/* 203 * Safeguard to avoid saving wrong flags: 204 * - CE_EXTENDED2 won't get saved until its semantic is known 205 * - Bits in 0x0000FFFF have been saved in ce_flags already 206 * - Bits in 0x003F0000 are currently in-memory flags 207 */ 208#if CE_EXTENDED_FLAGS & 0x803FFFFF 209#error "CE_EXTENDED_FLAGS out of range" 210#endif 211 212struct pathspec; 213 214/* 215 * Copy the sha1 and stat state of a cache entry from one to 216 * another. But we never change the name, or the hash state! 217 */ 218static inline void copy_cache_entry(struct cache_entry *dst, 219 const struct cache_entry *src) 220{ 221 unsigned int state = dst->ce_flags & CE_HASHED; 222 223 /* Don't copy hash chain and name */ 224 memcpy(&dst->ce_stat_data, &src->ce_stat_data, 225 offsetof(struct cache_entry, name) - 226 offsetof(struct cache_entry, ce_stat_data)); 227 228 /* Restore the hash state */ 229 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state; 230} 231 232static inline unsigned create_ce_flags(unsigned stage) 233{ 234 return (stage << CE_STAGESHIFT); 235} 236 237#define ce_namelen(ce) ((ce)->ce_namelen) 238#define ce_size(ce) cache_entry_size(ce_namelen(ce)) 239#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT) 240#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE) 241#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE) 242#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE) 243 244#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) 245static inline unsigned int create_ce_mode(unsigned int mode) 246{ 247 if (S_ISLNK(mode)) 248 return S_IFLNK; 249 if (S_ISDIR(mode) || S_ISGITLINK(mode)) 250 return S_IFGITLINK; 251 return S_IFREG | ce_permissions(mode); 252} 253static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce, 254 unsigned int mode) 255{ 256 extern int trust_executable_bit, has_symlinks; 257 if (!has_symlinks && S_ISREG(mode) && 258 ce && S_ISLNK(ce->ce_mode)) 259 return ce->ce_mode; 260 if (!trust_executable_bit && S_ISREG(mode)) { 261 if (ce && S_ISREG(ce->ce_mode)) 262 return ce->ce_mode; 263 return create_ce_mode(0666); 264 } 265 return create_ce_mode(mode); 266} 267static inline int ce_to_dtype(const struct cache_entry *ce) 268{ 269 unsigned ce_mode = ntohl(ce->ce_mode); 270 if (S_ISREG(ce_mode)) 271 return DT_REG; 272 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode)) 273 return DT_DIR; 274 else if (S_ISLNK(ce_mode)) 275 return DT_LNK; 276 else 277 return DT_UNKNOWN; 278} 279static inline unsigned int canon_mode(unsigned int mode) 280{ 281 if (S_ISREG(mode)) 282 return S_IFREG | ce_permissions(mode); 283 if (S_ISLNK(mode)) 284 return S_IFLNK; 285 if (S_ISDIR(mode)) 286 return S_IFDIR; 287 return S_IFGITLINK; 288} 289 290#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1) 291 292#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */ 293#define CE_ENTRY_CHANGED (1 << 1) 294#define CE_ENTRY_REMOVED (1 << 2) 295#define CE_ENTRY_ADDED (1 << 3) 296#define RESOLVE_UNDO_CHANGED (1 << 4) 297#define CACHE_TREE_CHANGED (1 << 5) 298#define SPLIT_INDEX_ORDERED (1 << 6) 299 300struct split_index; 301struct index_state { 302 struct cache_entry **cache; 303 unsigned int version; 304 unsigned int cache_nr, cache_alloc, cache_changed; 305 struct string_list *resolve_undo; 306 struct cache_tree *cache_tree; 307 struct split_index *split_index; 308 struct cache_time timestamp; 309 unsigned name_hash_initialized : 1, 310 initialized : 1; 311 struct hashmap name_hash; 312 struct hashmap dir_hash; 313 unsigned char sha1[20]; 314}; 315 316extern struct index_state the_index; 317 318/* Name hashing */ 319extern void add_name_hash(struct index_state *istate, struct cache_entry *ce); 320extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce); 321extern void free_name_hash(struct index_state *istate); 322 323 324#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS 325#define active_cache (the_index.cache) 326#define active_nr (the_index.cache_nr) 327#define active_alloc (the_index.cache_alloc) 328#define active_cache_changed (the_index.cache_changed) 329#define active_cache_tree (the_index.cache_tree) 330 331#define read_cache() read_index(&the_index) 332#define read_cache_from(path) read_index_from(&the_index, (path)) 333#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec)) 334#define is_cache_unborn() is_index_unborn(&the_index) 335#define read_cache_unmerged() read_index_unmerged(&the_index) 336#define discard_cache() discard_index(&the_index) 337#define unmerged_cache() unmerged_index(&the_index) 338#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen)) 339#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option)) 340#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name)) 341#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos)) 342#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path)) 343#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags)) 344#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags)) 345#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL) 346#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options)) 347#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options)) 348#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen)) 349#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase)) 350#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen)) 351#define resolve_undo_clear() resolve_undo_clear_index(&the_index) 352#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at) 353#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec) 354#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz)) 355#endif 356 357enum object_type { 358 OBJ_BAD = -1, 359 OBJ_NONE = 0, 360 OBJ_COMMIT = 1, 361 OBJ_TREE = 2, 362 OBJ_BLOB = 3, 363 OBJ_TAG = 4, 364 /* 5 for future expansion */ 365 OBJ_OFS_DELTA = 6, 366 OBJ_REF_DELTA = 7, 367 OBJ_ANY, 368 OBJ_MAX 369}; 370 371static inline enum object_type object_type(unsigned int mode) 372{ 373 return S_ISDIR(mode) ? OBJ_TREE : 374 S_ISGITLINK(mode) ? OBJ_COMMIT : 375 OBJ_BLOB; 376} 377 378/* Double-check local_repo_env below if you add to this list. */ 379#define GIT_DIR_ENVIRONMENT "GIT_DIR" 380#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR" 381#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE" 382#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE" 383#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX" 384#define DEFAULT_GIT_DIR_ENVIRONMENT ".git" 385#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY" 386#define INDEX_ENVIRONMENT "GIT_INDEX_FILE" 387#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE" 388#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE" 389#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" 390#define CONFIG_ENVIRONMENT "GIT_CONFIG" 391#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS" 392#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH" 393#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES" 394#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS" 395#define GITATTRIBUTES_FILE ".gitattributes" 396#define INFOATTRIBUTES_FILE "info/attributes" 397#define ATTRIBUTE_MACRO_PREFIX "[attr]" 398#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF" 399#define GIT_NOTES_DEFAULT_REF "refs/notes/commits" 400#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF" 401#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF" 402#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE" 403#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS" 404#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS" 405#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS" 406#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS" 407 408/* 409 * This environment variable is expected to contain a boolean indicating 410 * whether we should or should not treat: 411 * 412 * GIT_DIR=foo.git git ... 413 * 414 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use 415 * of this, but we use it internally to communicate to sub-processes that we 416 * are in a bare repo. If not set, defaults to true. 417 */ 418#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE" 419 420/* 421 * Repository-local GIT_* environment variables; these will be cleared 422 * when git spawns a sub-process that runs inside another repository. 423 * The array is NULL-terminated, which makes it easy to pass in the "env" 424 * parameter of a run-command invocation, or to do a simple walk. 425 */ 426extern const char * const local_repo_env[]; 427 428extern int is_bare_repository_cfg; 429extern int is_bare_repository(void); 430extern int is_inside_git_dir(void); 431extern char *git_work_tree_cfg; 432extern int is_inside_work_tree(void); 433extern const char *get_git_dir(void); 434extern const char *get_git_common_dir(void); 435extern int is_git_directory(const char *path); 436extern char *get_object_directory(void); 437extern char *get_index_file(void); 438extern char *get_graft_file(void); 439extern int set_git_dir(const char *path); 440extern int get_common_dir(struct strbuf *sb, const char *gitdir); 441extern const char *get_git_namespace(void); 442extern const char *strip_namespace(const char *namespaced_ref); 443extern const char *get_git_work_tree(void); 444extern const char *read_gitfile(const char *path); 445extern const char *resolve_gitdir(const char *suspect); 446extern void set_git_work_tree(const char *tree); 447 448#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES" 449 450extern const char **get_pathspec(const char *prefix, const char **pathspec); 451extern void setup_work_tree(void); 452extern const char *setup_git_directory_gently(int *); 453extern const char *setup_git_directory(void); 454extern char *prefix_path(const char *prefix, int len, const char *path); 455extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path); 456extern const char *prefix_filename(const char *prefix, int len, const char *path); 457extern int check_filename(const char *prefix, const char *name); 458extern void verify_filename(const char *prefix, 459 const char *name, 460 int diagnose_misspelt_rev); 461extern void verify_non_filename(const char *prefix, const char *name); 462extern int path_inside_repo(const char *prefix, const char *path); 463 464#define INIT_DB_QUIET 0x0001 465 466extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int); 467extern int init_db(const char *template_dir, unsigned int flags); 468 469extern void sanitize_stdfds(void); 470extern int daemonize(void); 471 472#define alloc_nr(x) (((x)+16)*3/2) 473 474/* 475 * Realloc the buffer pointed at by variable 'x' so that it can hold 476 * at least 'nr' entries; the number of entries currently allocated 477 * is 'alloc', using the standard growing factor alloc_nr() macro. 478 * 479 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'. 480 */ 481#define ALLOC_GROW(x, nr, alloc) \ 482 do { \ 483 if ((nr) > alloc) { \ 484 if (alloc_nr(alloc) < (nr)) \ 485 alloc = (nr); \ 486 else \ 487 alloc = alloc_nr(alloc); \ 488 REALLOC_ARRAY(x, alloc); \ 489 } \ 490 } while (0) 491 492/* Initialize and use the cache information */ 493struct lock_file; 494extern int read_index(struct index_state *); 495extern int read_index_preload(struct index_state *, const struct pathspec *pathspec); 496extern int do_read_index(struct index_state *istate, const char *path, 497 int must_exist); /* for testting only! */ 498extern int read_index_from(struct index_state *, const char *path); 499extern int is_index_unborn(struct index_state *); 500extern int read_index_unmerged(struct index_state *); 501#define COMMIT_LOCK (1 << 0) 502#define CLOSE_LOCK (1 << 1) 503extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags); 504extern int discard_index(struct index_state *); 505extern int unmerged_index(const struct index_state *); 506extern int verify_path(const char *path); 507extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen); 508extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase); 509extern int index_name_pos(const struct index_state *, const char *name, int namelen); 510#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */ 511#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */ 512#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */ 513#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */ 514#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */ 515#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */ 516extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option); 517extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name); 518extern int remove_index_entry_at(struct index_state *, int pos); 519extern void remove_marked_cache_entries(struct index_state *istate); 520extern int remove_file_from_index(struct index_state *, const char *path); 521#define ADD_CACHE_VERBOSE 1 522#define ADD_CACHE_PRETEND 2 523#define ADD_CACHE_IGNORE_ERRORS 4 524#define ADD_CACHE_IGNORE_REMOVAL 8 525#define ADD_CACHE_INTENT 16 526extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags); 527extern int add_file_to_index(struct index_state *, const char *path, int flags); 528extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options); 529extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b); 530extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce); 531extern int index_name_is_other(const struct index_state *, const char *, int); 532extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *); 533 534/* do stat comparison even if CE_VALID is true */ 535#define CE_MATCH_IGNORE_VALID 01 536/* do not check the contents but report dirty on racily-clean entries */ 537#define CE_MATCH_RACY_IS_DIRTY 02 538/* do stat comparison even if CE_SKIP_WORKTREE is true */ 539#define CE_MATCH_IGNORE_SKIP_WORKTREE 04 540/* ignore non-existent files during stat update */ 541#define CE_MATCH_IGNORE_MISSING 0x08 542/* enable stat refresh */ 543#define CE_MATCH_REFRESH 0x10 544extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 545extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int); 546 547#define HASH_WRITE_OBJECT 1 548#define HASH_FORMAT_CHECK 2 549extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags); 550extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags); 551 552/* 553 * Record to sd the data from st that we use to check whether a file 554 * might have changed. 555 */ 556extern void fill_stat_data(struct stat_data *sd, struct stat *st); 557 558/* 559 * Return 0 if st is consistent with a file not having been changed 560 * since sd was filled. If there are differences, return a 561 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED, 562 * INODE_CHANGED, and DATA_CHANGED. 563 */ 564extern int match_stat_data(const struct stat_data *sd, struct stat *st); 565 566extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st); 567 568#define REFRESH_REALLY 0x0001 /* ignore_valid */ 569#define REFRESH_UNMERGED 0x0002 /* allow unmerged */ 570#define REFRESH_QUIET 0x0004 /* be quiet about it */ 571#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */ 572#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */ 573#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */ 574extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg); 575 576extern void update_index_if_able(struct index_state *, struct lock_file *); 577 578extern int hold_locked_index(struct lock_file *, int); 579extern void set_alternate_index_output(const char *); 580 581extern int delete_ref(const char *, const unsigned char *sha1, int delopt); 582 583/* Environment bits from configuration mechanism */ 584extern int trust_executable_bit; 585extern int trust_ctime; 586extern int check_stat; 587extern int quote_path_fully; 588extern int has_symlinks; 589extern int minimum_abbrev, default_abbrev; 590extern int ignore_case; 591extern int assume_unchanged; 592extern int prefer_symlink_refs; 593extern int log_all_ref_updates; 594extern int warn_ambiguous_refs; 595extern int warn_on_object_refname_ambiguity; 596extern int shared_repository; 597extern const char *apply_default_whitespace; 598extern const char *apply_default_ignorewhitespace; 599extern const char *git_attributes_file; 600extern int zlib_compression_level; 601extern int core_compression_level; 602extern int core_compression_seen; 603extern size_t packed_git_window_size; 604extern size_t packed_git_limit; 605extern size_t delta_base_cache_limit; 606extern unsigned long big_file_threshold; 607extern unsigned long pack_size_limit_cfg; 608 609/* 610 * Do replace refs need to be checked this run? This variable is 611 * initialized to true unless --no-replace-object is used or 612 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some 613 * commands that do not want replace references to be active. As an 614 * optimization it is also set to false if replace references have 615 * been sought but there were none. 616 */ 617extern int check_replace_refs; 618 619extern int fsync_object_files; 620extern int core_preload_index; 621extern int core_apply_sparse_checkout; 622extern int precomposed_unicode; 623extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env; 624 625/* 626 * The character that begins a commented line in user-editable file 627 * that is subject to stripspace. 628 */ 629extern char comment_line_char; 630extern int auto_comment_line_char; 631 632enum branch_track { 633 BRANCH_TRACK_UNSPECIFIED = -1, 634 BRANCH_TRACK_NEVER = 0, 635 BRANCH_TRACK_REMOTE, 636 BRANCH_TRACK_ALWAYS, 637 BRANCH_TRACK_EXPLICIT, 638 BRANCH_TRACK_OVERRIDE 639}; 640 641enum rebase_setup_type { 642 AUTOREBASE_NEVER = 0, 643 AUTOREBASE_LOCAL, 644 AUTOREBASE_REMOTE, 645 AUTOREBASE_ALWAYS 646}; 647 648enum push_default_type { 649 PUSH_DEFAULT_NOTHING = 0, 650 PUSH_DEFAULT_MATCHING, 651 PUSH_DEFAULT_SIMPLE, 652 PUSH_DEFAULT_UPSTREAM, 653 PUSH_DEFAULT_CURRENT, 654 PUSH_DEFAULT_UNSPECIFIED 655}; 656 657extern enum branch_track git_branch_track; 658extern enum rebase_setup_type autorebase; 659extern enum push_default_type push_default; 660 661enum object_creation_mode { 662 OBJECT_CREATION_USES_HARDLINKS = 0, 663 OBJECT_CREATION_USES_RENAMES = 1 664}; 665 666extern enum object_creation_mode object_creation_mode; 667 668extern char *notes_ref_name; 669 670extern int grafts_replace_parents; 671 672#define GIT_REPO_VERSION 0 673extern int repository_format_version; 674extern int check_repository_format(void); 675 676#define MTIME_CHANGED 0x0001 677#define CTIME_CHANGED 0x0002 678#define OWNER_CHANGED 0x0004 679#define MODE_CHANGED 0x0008 680#define INODE_CHANGED 0x0010 681#define DATA_CHANGED 0x0020 682#define TYPE_CHANGED 0x0040 683 684extern char *mksnpath(char *buf, size_t n, const char *fmt, ...) 685 __attribute__((format (printf, 3, 4))); 686extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...) 687 __attribute__((format (printf, 2, 3))); 688extern char *git_pathdup(const char *fmt, ...) 689 __attribute__((format (printf, 1, 2))); 690extern char *mkpathdup(const char *fmt, ...) 691 __attribute__((format (printf, 1, 2))); 692 693/* Return a statically allocated filename matching the sha1 signature */ 694extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 695extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2))); 696extern const char *git_path_submodule(const char *path, const char *fmt, ...) 697 __attribute__((format (printf, 2, 3))); 698 699/* 700 * Return the name of the file in the local object database that would 701 * be used to store a loose object with the specified sha1. The 702 * return value is a pointer to a statically allocated buffer that is 703 * overwritten each time the function is called. 704 */ 705extern const char *sha1_file_name(const unsigned char *sha1); 706 707/* 708 * Return the name of the (local) packfile with the specified sha1 in 709 * its name. The return value is a pointer to memory that is 710 * overwritten each time this function is called. 711 */ 712extern char *sha1_pack_name(const unsigned char *sha1); 713 714/* 715 * Return the name of the (local) pack index file with the specified 716 * sha1 in its name. The return value is a pointer to memory that is 717 * overwritten each time this function is called. 718 */ 719extern char *sha1_pack_index_name(const unsigned char *sha1); 720 721extern const char *find_unique_abbrev(const unsigned char *sha1, int); 722extern const unsigned char null_sha1[20]; 723 724static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2) 725{ 726 int i; 727 728 for (i = 0; i < 20; i++, sha1++, sha2++) { 729 if (*sha1 != *sha2) 730 return *sha1 - *sha2; 731 } 732 733 return 0; 734} 735 736static inline int is_null_sha1(const unsigned char *sha1) 737{ 738 return !hashcmp(sha1, null_sha1); 739} 740 741static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src) 742{ 743 memcpy(sha_dst, sha_src, 20); 744} 745static inline void hashclr(unsigned char *hash) 746{ 747 memset(hash, 0, 20); 748} 749 750#define EMPTY_TREE_SHA1_HEX \ 751 "4b825dc642cb6eb9a060e54bf8d69288fbee4904" 752#define EMPTY_TREE_SHA1_BIN_LITERAL \ 753 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \ 754 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04" 755#define EMPTY_TREE_SHA1_BIN \ 756 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL) 757 758#define EMPTY_BLOB_SHA1_HEX \ 759 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391" 760#define EMPTY_BLOB_SHA1_BIN_LITERAL \ 761 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \ 762 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91" 763#define EMPTY_BLOB_SHA1_BIN \ 764 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL) 765 766static inline int is_empty_blob_sha1(const unsigned char *sha1) 767{ 768 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN); 769} 770 771int git_mkstemp(char *path, size_t n, const char *template); 772 773int git_mkstemps(char *path, size_t n, const char *template, int suffix_len); 774 775/* set default permissions by passing mode arguments to open(2) */ 776int git_mkstemps_mode(char *pattern, int suffix_len, int mode); 777int git_mkstemp_mode(char *pattern, int mode); 778 779/* 780 * NOTE NOTE NOTE!! 781 * 782 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must 783 * not be changed. Old repositories have core.sharedrepository written in 784 * numeric format, and therefore these values are preserved for compatibility 785 * reasons. 786 */ 787enum sharedrepo { 788 PERM_UMASK = 0, 789 OLD_PERM_GROUP = 1, 790 OLD_PERM_EVERYBODY = 2, 791 PERM_GROUP = 0660, 792 PERM_EVERYBODY = 0664 793}; 794int git_config_perm(const char *var, const char *value); 795int adjust_shared_perm(const char *path); 796 797/* 798 * Create the directory containing the named path, using care to be 799 * somewhat safe against races. Return one of the scld_error values 800 * to indicate success/failure. 801 * 802 * SCLD_VANISHED indicates that one of the ancestor directories of the 803 * path existed at one point during the function call and then 804 * suddenly vanished, probably because another process pruned the 805 * directory while we were working. To be robust against this kind of 806 * race, callers might want to try invoking the function again when it 807 * returns SCLD_VANISHED. 808 */ 809enum scld_error { 810 SCLD_OK = 0, 811 SCLD_FAILED = -1, 812 SCLD_PERMS = -2, 813 SCLD_EXISTS = -3, 814 SCLD_VANISHED = -4 815}; 816enum scld_error safe_create_leading_directories(char *path); 817enum scld_error safe_create_leading_directories_const(const char *path); 818 819int mkdir_in_gitdir(const char *path); 820extern void home_config_paths(char **global, char **xdg, char *file); 821extern char *expand_user_path(const char *path); 822const char *enter_repo(const char *path, int strict); 823static inline int is_absolute_path(const char *path) 824{ 825 return is_dir_sep(path[0]) || has_dos_drive_prefix(path); 826} 827int is_directory(const char *); 828const char *real_path(const char *path); 829const char *real_path_if_valid(const char *path); 830const char *absolute_path(const char *path); 831const char *remove_leading_path(const char *in, const char *prefix); 832const char *relative_path(const char *in, const char *prefix, struct strbuf *sb); 833int normalize_path_copy_len(char *dst, const char *src, int *prefix_len); 834int normalize_path_copy(char *dst, const char *src); 835int longest_ancestor_length(const char *path, struct string_list *prefixes); 836char *strip_path_suffix(const char *path, const char *suffix); 837int daemon_avoid_alias(const char *path); 838 839/* object replacement */ 840#define LOOKUP_REPLACE_OBJECT 1 841extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag); 842static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size) 843{ 844 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT); 845} 846 847/* 848 * This internal function is only declared here for the benefit of 849 * lookup_replace_object(). Please do not call it directly. 850 */ 851extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1); 852 853/* 854 * If object sha1 should be replaced, return the replacement object's 855 * name (replaced recursively, if necessary). The return value is 856 * either sha1 or a pointer to a permanently-allocated value. When 857 * object replacement is suppressed, always return sha1. 858 */ 859static inline const unsigned char *lookup_replace_object(const unsigned char *sha1) 860{ 861 if (!check_replace_refs) 862 return sha1; 863 return do_lookup_replace_object(sha1); 864} 865 866static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag) 867{ 868 if (!(flag & LOOKUP_REPLACE_OBJECT)) 869 return sha1; 870 return lookup_replace_object(sha1); 871} 872 873/* Read and unpack a sha1 file into memory, write memory to a sha1 file */ 874extern int sha1_object_info(const unsigned char *, unsigned long *); 875extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1); 876extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1); 877extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *); 878extern int force_object_loose(const unsigned char *sha1, time_t mtime); 879extern int git_open_noatime(const char *name); 880extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size); 881extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz); 882extern int parse_sha1_header(const char *hdr, unsigned long *sizep); 883 884/* global flag to enable extra checks when accessing packed objects */ 885extern int do_check_packed_object_crc; 886 887extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type); 888 889extern int move_temp_to_file(const char *tmpfile, const char *filename); 890 891extern int has_sha1_pack(const unsigned char *sha1); 892 893/* 894 * Return true iff we have an object named sha1, whether local or in 895 * an alternate object database, and whether packed or loose. This 896 * function does not respect replace references. 897 */ 898extern int has_sha1_file(const unsigned char *sha1); 899 900/* 901 * Return true iff an alternate object database has a loose object 902 * with the specified name. This function does not respect replace 903 * references. 904 */ 905extern int has_loose_object_nonlocal(const unsigned char *sha1); 906 907extern int has_pack_index(const unsigned char *sha1); 908 909extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect); 910 911extern const signed char hexval_table[256]; 912static inline unsigned int hexval(unsigned char c) 913{ 914 return hexval_table[c]; 915} 916 917/* Convert to/from hex/sha1 representation */ 918#define MINIMUM_ABBREV minimum_abbrev 919#define DEFAULT_ABBREV default_abbrev 920 921struct object_context { 922 unsigned char tree[20]; 923 char path[PATH_MAX]; 924 unsigned mode; 925}; 926 927#define GET_SHA1_QUIETLY 01 928#define GET_SHA1_COMMIT 02 929#define GET_SHA1_COMMITTISH 04 930#define GET_SHA1_TREE 010 931#define GET_SHA1_TREEISH 020 932#define GET_SHA1_BLOB 040 933#define GET_SHA1_ONLY_TO_DIE 04000 934 935extern int get_sha1(const char *str, unsigned char *sha1); 936extern int get_sha1_commit(const char *str, unsigned char *sha1); 937extern int get_sha1_committish(const char *str, unsigned char *sha1); 938extern int get_sha1_tree(const char *str, unsigned char *sha1); 939extern int get_sha1_treeish(const char *str, unsigned char *sha1); 940extern int get_sha1_blob(const char *str, unsigned char *sha1); 941extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix); 942extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc); 943 944typedef int each_abbrev_fn(const unsigned char *sha1, void *); 945extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *); 946 947/* 948 * Try to read a SHA1 in hexadecimal format from the 40 characters 949 * starting at hex. Write the 20-byte result to sha1 in binary form. 950 * Return 0 on success. Reading stops if a NUL is encountered in the 951 * input, so it is safe to pass this function an arbitrary 952 * null-terminated string. 953 */ 954extern int get_sha1_hex(const char *hex, unsigned char *sha1); 955 956extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */ 957extern int read_ref_full(const char *refname, int resolve_flags, 958 unsigned char *sha1, int *flags); 959extern int read_ref(const char *refname, unsigned char *sha1); 960 961/* 962 * Resolve a reference, recursively following symbolic refererences. 963 * 964 * Store the referred-to object's name in sha1 and return the name of 965 * the non-symbolic reference that ultimately pointed at it. The 966 * return value, if not NULL, is a pointer into either a static buffer 967 * or the input ref. 968 * 969 * If the reference cannot be resolved to an object, the behavior 970 * depends on the RESOLVE_REF_READING flag: 971 * 972 * - If RESOLVE_REF_READING is set, return NULL. 973 * 974 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of 975 * the last reference name in the chain, which will either be a non-symbolic 976 * reference or an undefined reference. If this is a prelude to 977 * "writing" to the ref, the return value is the name of the ref 978 * that will actually be created or changed. 979 * 980 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one 981 * level of symbolic reference. The value stored in sha1 for a symbolic 982 * reference will always be null_sha1 in this case, and the return 983 * value is the reference that the symref refers to directly. 984 * 985 * If flags is non-NULL, set the value that it points to the 986 * combination of REF_ISPACKED (if the reference was found among the 987 * packed references), REF_ISSYMREF (if the initial reference was a 988 * symbolic reference), REF_BAD_NAME (if the reference name is ill 989 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN 990 * (if the ref is malformed or has a bad name). See refs.h for more detail 991 * on each flag. 992 * 993 * If ref is not a properly-formatted, normalized reference, return 994 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed, 995 * give up and return NULL. 996 * 997 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their 998 * name is invalid according to git-check-ref-format(1). If the name 999 * is bad then the value stored in sha1 will be null_sha1 and the two1000 * flags REF_ISBROKEN and REF_BAD_NAME will be set.1001 *1002 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/1003 * directory and do not consist of all caps and underscores cannot be1004 * resolved. The function returns NULL for such ref names.1005 * Caps and underscores refers to the special refs, such as HEAD,1006 * FETCH_HEAD and friends, that all live outside of the refs/ directory.1007 */1008#define RESOLVE_REF_READING 0x011009#define RESOLVE_REF_NO_RECURSE 0x021010#define RESOLVE_REF_ALLOW_BAD_NAME 0x041011extern const char *resolve_ref_unsafe(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);1012extern char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);10131014extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);1015extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);1016extern int interpret_branch_name(const char *str, int len, struct strbuf *);1017extern int get_sha1_mb(const char *str, unsigned char *sha1);10181019/*1020 * Return true iff abbrev_name is a possible abbreviation for1021 * full_name according to the rules defined by ref_rev_parse_rules in1022 * refs.c.1023 */1024extern int refname_match(const char *abbrev_name, const char *full_name);10251026extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);1027extern int validate_headref(const char *ref);10281029extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1030extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);1031extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);1032extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);10331034extern void *read_object_with_reference(const unsigned char *sha1,1035 const char *required_type,1036 unsigned long *size,1037 unsigned char *sha1_ret);10381039extern struct object *peel_to_type(const char *name, int namelen,1040 struct object *o, enum object_type);10411042enum date_mode {1043 DATE_NORMAL = 0,1044 DATE_RELATIVE,1045 DATE_SHORT,1046 DATE_LOCAL,1047 DATE_ISO8601,1048 DATE_ISO8601_STRICT,1049 DATE_RFC2822,1050 DATE_RAW1051};10521053const char *show_date(unsigned long time, int timezone, enum date_mode mode);1054void show_date_relative(unsigned long time, int tz, const struct timeval *now,1055 struct strbuf *timebuf);1056int parse_date(const char *date, struct strbuf *out);1057int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);1058int parse_expiry_date(const char *date, unsigned long *timestamp);1059void datestamp(struct strbuf *out);1060#define approxidate(s) approxidate_careful((s), NULL)1061unsigned long approxidate_careful(const char *, int *);1062unsigned long approxidate_relative(const char *date, const struct timeval *now);1063enum date_mode parse_date_format(const char *format);1064int date_overflows(unsigned long date);10651066#define IDENT_STRICT 11067#define IDENT_NO_DATE 21068#define IDENT_NO_NAME 41069extern const char *git_author_info(int);1070extern const char *git_committer_info(int);1071extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);1072extern const char *fmt_name(const char *name, const char *email);1073extern const char *ident_default_name(void);1074extern const char *ident_default_email(void);1075extern const char *git_editor(void);1076extern const char *git_pager(int stdout_is_tty);1077extern int git_ident_config(const char *, const char *, void *);10781079struct ident_split {1080 const char *name_begin;1081 const char *name_end;1082 const char *mail_begin;1083 const char *mail_end;1084 const char *date_begin;1085 const char *date_end;1086 const char *tz_begin;1087 const char *tz_end;1088};1089/*1090 * Signals an success with 0, but time part of the result may be NULL1091 * if the input lacks timestamp and zone1092 */1093extern int split_ident_line(struct ident_split *, const char *, int);10941095/*1096 * Like show_date, but pull the timestamp and tz parameters from1097 * the ident_split. It will also sanity-check the values and produce1098 * a well-known sentinel date if they appear bogus.1099 */1100const char *show_ident_date(const struct ident_split *id, enum date_mode mode);11011102/*1103 * Compare split idents for equality or strict ordering. Note that we1104 * compare only the ident part of the line, ignoring any timestamp.1105 *1106 * Because there are two fields, we must choose one as the primary key; we1107 * currently arbitrarily pick the email.1108 */1109extern int ident_cmp(const struct ident_split *, const struct ident_split *);11101111struct checkout {1112 struct index_state *istate;1113 const char *base_dir;1114 int base_dir_len;1115 unsigned force:1,1116 quiet:1,1117 not_new:1,1118 refresh_cache:1;1119};11201121#define TEMPORARY_FILENAME_LENGTH 251122extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);11231124struct cache_def {1125 struct strbuf path;1126 int flags;1127 int track_flags;1128 int prefix_len_stat_func;1129};1130#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }1131static inline void cache_def_clear(struct cache_def *cache)1132{1133 strbuf_release(&cache->path);1134}11351136extern int has_symlink_leading_path(const char *name, int len);1137extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);1138extern int check_leading_path(const char *name, int len);1139extern int has_dirs_only_path(const char *name, int len, int prefix_len);1140extern void schedule_dir_for_removal(const char *name, int len);1141extern void remove_scheduled_dirs(void);11421143extern struct alternate_object_database {1144 struct alternate_object_database *next;1145 char *name;1146 char base[FLEX_ARRAY]; /* more */1147} *alt_odb_list;1148extern void prepare_alt_odb(void);1149extern void read_info_alternates(const char * relative_base, int depth);1150extern void add_to_alternates_file(const char *reference);1151typedef int alt_odb_fn(struct alternate_object_database *, void *);1152extern int foreach_alt_odb(alt_odb_fn, void*);11531154struct pack_window {1155 struct pack_window *next;1156 unsigned char *base;1157 off_t offset;1158 size_t len;1159 unsigned int last_used;1160 unsigned int inuse_cnt;1161};11621163extern struct packed_git {1164 struct packed_git *next;1165 struct pack_window *windows;1166 off_t pack_size;1167 const void *index_data;1168 size_t index_size;1169 uint32_t num_objects;1170 uint32_t num_bad_objects;1171 unsigned char *bad_object_sha1;1172 int index_version;1173 time_t mtime;1174 int pack_fd;1175 unsigned pack_local:1,1176 pack_keep:1,1177 do_not_close:1;1178 unsigned char sha1[20];1179 /* something like ".git/objects/pack/xxxxx.pack" */1180 char pack_name[FLEX_ARRAY]; /* more */1181} *packed_git;11821183struct pack_entry {1184 off_t offset;1185 unsigned char sha1[20];1186 struct packed_git *p;1187};11881189extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);11901191/* A hook for count-objects to report invalid files in pack directory */1192extern void (*report_garbage)(const char *desc, const char *path);11931194extern void prepare_packed_git(void);1195extern void reprepare_packed_git(void);1196extern void install_packed_git(struct packed_git *pack);11971198extern struct packed_git *find_sha1_pack(const unsigned char *sha1,1199 struct packed_git *packs);12001201extern void pack_report(void);12021203/*1204 * mmap the index file for the specified packfile (if it is not1205 * already mmapped). Return 0 on success.1206 */1207extern int open_pack_index(struct packed_git *);12081209/*1210 * munmap the index file for the specified packfile (if it is1211 * currently mmapped).1212 */1213extern void close_pack_index(struct packed_git *);12141215extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);1216extern void close_pack_windows(struct packed_git *);1217extern void unuse_pack(struct pack_window **);1218extern void free_pack_by_name(const char *);1219extern void clear_delta_base_cache(void);1220extern struct packed_git *add_packed_git(const char *, int, int);12211222/*1223 * Return the SHA-1 of the nth object within the specified packfile.1224 * Open the index if it is not already open. The return value points1225 * at the SHA-1 within the mmapped index. Return NULL if there is an1226 * error.1227 */1228extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);12291230/*1231 * Return the offset of the nth object within the specified packfile.1232 * The index must already be opened.1233 */1234extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);12351236/*1237 * If the object named sha1 is present in the specified packfile,1238 * return its offset within the packfile; otherwise, return 0.1239 */1240extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);12411242extern int is_pack_valid(struct packed_git *);1243extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);1244extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);1245extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);1246extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);12471248/*1249 * Iterate over the files in the loose-object parts of the object1250 * directory "path", triggering the following callbacks:1251 *1252 * - loose_object is called for each loose object we find.1253 *1254 * - loose_cruft is called for any files that do not appear to be1255 * loose objects. Note that we only look in the loose object1256 * directories "objects/[0-9a-f]{2}/", so we will not report1257 * "objects/foobar" as cruft.1258 *1259 * - loose_subdir is called for each top-level hashed subdirectory1260 * of the object directory (e.g., "$OBJDIR/f0"). It is called1261 * after the objects in the directory are processed.1262 *1263 * Any callback that is NULL will be ignored. Callbacks returning non-zero1264 * will end the iteration.1265 */1266typedef int each_loose_object_fn(const unsigned char *sha1,1267 const char *path,1268 void *data);1269typedef int each_loose_cruft_fn(const char *basename,1270 const char *path,1271 void *data);1272typedef int each_loose_subdir_fn(int nr,1273 const char *path,1274 void *data);1275int for_each_loose_file_in_objdir(const char *path,1276 each_loose_object_fn obj_cb,1277 each_loose_cruft_fn cruft_cb,1278 each_loose_subdir_fn subdir_cb,1279 void *data);12801281/*1282 * Iterate over loose and packed objects in both the local1283 * repository and any alternates repositories.1284 */1285typedef int each_packed_object_fn(const unsigned char *sha1,1286 struct packed_git *pack,1287 uint32_t pos,1288 void *data);1289extern int for_each_loose_object(each_loose_object_fn, void *);1290extern int for_each_packed_object(each_packed_object_fn, void *);12911292struct object_info {1293 /* Request */1294 enum object_type *typep;1295 unsigned long *sizep;1296 unsigned long *disk_sizep;1297 unsigned char *delta_base_sha1;12981299 /* Response */1300 enum {1301 OI_CACHED,1302 OI_LOOSE,1303 OI_PACKED,1304 OI_DBCACHED1305 } whence;1306 union {1307 /*1308 * struct {1309 * ... Nothing to expose in this case1310 * } cached;1311 * struct {1312 * ... Nothing to expose in this case1313 * } loose;1314 */1315 struct {1316 struct packed_git *pack;1317 off_t offset;1318 unsigned int is_delta;1319 } packed;1320 } u;1321};1322extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);13231324/* Dumb servers support */1325extern int update_server_info(int);13261327/* git_config_parse_key() returns these negated: */1328#define CONFIG_INVALID_KEY 11329#define CONFIG_NO_SECTION_OR_NAME 21330/* git_config_set(), git_config_set_multivar() return the above or these: */1331#define CONFIG_NO_LOCK -11332#define CONFIG_INVALID_FILE 31333#define CONFIG_NO_WRITE 41334#define CONFIG_NOTHING_SET 51335#define CONFIG_INVALID_PATTERN 61336#define CONFIG_GENERIC_ERROR 713371338#define CONFIG_REGEX_NONE ((void *)1)13391340struct git_config_source {1341 unsigned int use_stdin:1;1342 const char *file;1343 const char *blob;1344};13451346typedef int (*config_fn_t)(const char *, const char *, void *);1347extern int git_default_config(const char *, const char *, void *);1348extern int git_config_from_file(config_fn_t fn, const char *, void *);1349extern int git_config_from_buf(config_fn_t fn, const char *name,1350 const char *buf, size_t len, void *data);1351extern void git_config_push_parameter(const char *text);1352extern int git_config_from_parameters(config_fn_t fn, void *data);1353extern void git_config(config_fn_t fn, void *);1354extern int git_config_with_options(config_fn_t fn, void *,1355 struct git_config_source *config_source,1356 int respect_includes);1357extern int git_config_early(config_fn_t fn, void *, const char *repo_config);1358extern int git_parse_ulong(const char *, unsigned long *);1359extern int git_config_int(const char *, const char *);1360extern int64_t git_config_int64(const char *, const char *);1361extern unsigned long git_config_ulong(const char *, const char *);1362extern int git_config_bool_or_int(const char *, const char *, int *);1363extern int git_config_bool(const char *, const char *);1364extern int git_config_maybe_bool(const char *, const char *);1365extern int git_config_string(const char **, const char *, const char *);1366extern int git_config_pathname(const char **, const char *, const char *);1367extern int git_config_set_in_file(const char *, const char *, const char *);1368extern int git_config_set(const char *, const char *);1369extern int git_config_parse_key(const char *, char **, int *);1370extern int git_config_set_multivar(const char *, const char *, const char *, int);1371extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);1372extern int git_config_rename_section(const char *, const char *);1373extern int git_config_rename_section_in_file(const char *, const char *, const char *);1374extern const char *git_etc_gitconfig(void);1375extern int check_repository_format_version(const char *var, const char *value, void *cb);1376extern int git_env_bool(const char *, int);1377extern unsigned long git_env_ulong(const char *, unsigned long);1378extern int git_config_system(void);1379extern int config_error_nonbool(const char *);1380#if defined(__GNUC__)1381#define config_error_nonbool(s) (config_error_nonbool(s), const_error())1382#endif1383extern const char *get_log_output_encoding(void);1384extern const char *get_commit_output_encoding(void);13851386extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);13871388struct config_include_data {1389 int depth;1390 config_fn_t fn;1391 void *data;1392};1393#define CONFIG_INCLUDE_INIT { 0 }1394extern int git_config_include(const char *name, const char *value, void *data);13951396/*1397 * Match and parse a config key of the form:1398 *1399 * section.(subsection.)?key1400 *1401 * (i.e., what gets handed to a config_fn_t). The caller provides the section;1402 * we return -1 if it does not match, 0 otherwise. The subsection and key1403 * out-parameters are filled by the function (and subsection is NULL if it is1404 * missing).1405 */1406extern int parse_config_key(const char *var,1407 const char *section,1408 const char **subsection, int *subsection_len,1409 const char **key);14101411struct config_set_element {1412 struct hashmap_entry ent;1413 char *key;1414 struct string_list value_list;1415};14161417struct configset_list_item {1418 struct config_set_element *e;1419 int value_index;1420};14211422/*1423 * the contents of the list are ordered according to their1424 * position in the config files and order of parsing the files.1425 * (i.e. key-value pair at the last position of .git/config will1426 * be at the last item of the list)1427 */1428struct configset_list {1429 struct configset_list_item *items;1430 unsigned int nr, alloc;1431};14321433struct config_set {1434 struct hashmap config_hash;1435 int hash_initialized;1436 struct configset_list list;1437};14381439extern void git_configset_init(struct config_set *cs);1440extern int git_configset_add_file(struct config_set *cs, const char *filename);1441extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);1442extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);1443extern void git_configset_clear(struct config_set *cs);1444extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);1445extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);1446extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);1447extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);1448extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);1449extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);1450extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);1451extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);14521453extern int git_config_get_value(const char *key, const char **value);1454extern const struct string_list *git_config_get_value_multi(const char *key);1455extern void git_config_clear(void);1456extern void git_config_iter(config_fn_t fn, void *data);1457extern int git_config_get_string_const(const char *key, const char **dest);1458extern int git_config_get_string(const char *key, char **dest);1459extern int git_config_get_int(const char *key, int *dest);1460extern int git_config_get_ulong(const char *key, unsigned long *dest);1461extern int git_config_get_bool(const char *key, int *dest);1462extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);1463extern int git_config_get_maybe_bool(const char *key, int *dest);1464extern int git_config_get_pathname(const char *key, const char **dest);14651466struct key_value_info {1467 const char *filename;1468 int linenr;1469};14701471extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));1472extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);14731474extern int committer_ident_sufficiently_given(void);1475extern int author_ident_sufficiently_given(void);14761477extern const char *git_commit_encoding;1478extern const char *git_log_output_encoding;1479extern const char *git_mailmap_file;1480extern const char *git_mailmap_blob;14811482/* IO helper functions */1483extern void maybe_flush_or_die(FILE *, const char *);1484__attribute__((format (printf, 2, 3)))1485extern void fprintf_or_die(FILE *, const char *fmt, ...);1486extern int copy_fd(int ifd, int ofd);1487extern int copy_file(const char *dst, const char *src, int mode);1488extern int copy_file_with_time(const char *dst, const char *src, int mode);1489extern void write_or_die(int fd, const void *buf, size_t count);1490extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);1491extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);1492extern void fsync_or_die(int fd, const char *);14931494extern ssize_t read_in_full(int fd, void *buf, size_t count);1495extern ssize_t write_in_full(int fd, const void *buf, size_t count);1496extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);14971498static inline ssize_t write_str_in_full(int fd, const char *str)1499{1500 return write_in_full(fd, str, strlen(str));1501}15021503/* pager.c */1504extern void setup_pager(void);1505extern const char *pager_program;1506extern int pager_in_use(void);1507extern int pager_use_color;1508extern int term_columns(void);1509extern int decimal_width(int);1510extern int check_pager_config(const char *cmd);15111512extern const char *editor_program;1513extern const char *askpass_program;1514extern const char *excludes_file;15151516/* base85 */1517int decode_85(char *dst, const char *line, int linelen);1518void encode_85(char *buf, const unsigned char *data, int bytes);15191520/* alloc.c */1521extern void *alloc_blob_node(void);1522extern void *alloc_tree_node(void);1523extern void *alloc_commit_node(void);1524extern void *alloc_tag_node(void);1525extern void *alloc_object_node(void);1526extern void alloc_report(void);1527extern unsigned int alloc_commit_index(void);15281529/* pkt-line.c */1530void packet_trace_identity(const char *prog);15311532/* add */1533/*1534 * return 0 if success, 1 - if addition of a file failed and1535 * ADD_FILES_IGNORE_ERRORS was specified in flags1536 */1537int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);15381539/* diff.c */1540extern int diff_auto_refresh_index;15411542/* match-trees.c */1543void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);1544void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);15451546/*1547 * whitespace rules.1548 * used by both diff and apply1549 * last two digits are tab width1550 */1551#define WS_BLANK_AT_EOL 01001552#define WS_SPACE_BEFORE_TAB 02001553#define WS_INDENT_WITH_NON_TAB 04001554#define WS_CR_AT_EOL 010001555#define WS_BLANK_AT_EOF 020001556#define WS_TAB_IN_INDENT 040001557#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)1558#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)1559#define WS_TAB_WIDTH_MASK 0771560extern unsigned whitespace_rule_cfg;1561extern unsigned whitespace_rule(const char *);1562extern unsigned parse_whitespace_rule(const char *);1563extern unsigned ws_check(const char *line, int len, unsigned ws_rule);1564extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);1565extern char *whitespace_error_string(unsigned ws);1566extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);1567extern int ws_blank_line(const char *line, int len, unsigned ws_rule);1568#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)15691570/* ls-files */1571int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);1572void overlay_tree_on_cache(const char *tree_name, const char *prefix);15731574char *alias_lookup(const char *alias);1575int split_cmdline(char *cmdline, const char ***argv);1576/* Takes a negative value returned by split_cmdline */1577const char *split_cmdline_strerror(int cmdline_errno);15781579/* git.c */1580struct startup_info {1581 int have_repository;1582 const char *prefix;1583};1584extern struct startup_info *startup_info;15851586/* merge.c */1587struct commit_list;1588int try_merge_command(const char *strategy, size_t xopts_nr,1589 const char **xopts, struct commit_list *common,1590 const char *head_arg, struct commit_list *remotes);1591int checkout_fast_forward(const unsigned char *from,1592 const unsigned char *to,1593 int overwrite_ignore);159415951596int sane_execvp(const char *file, char *const argv[]);15971598/*1599 * A struct to encapsulate the concept of whether a file has changed1600 * since we last checked it. This uses criteria similar to those used1601 * for the index.1602 */1603struct stat_validity {1604 struct stat_data *sd;1605};16061607void stat_validity_clear(struct stat_validity *sv);16081609/*1610 * Returns 1 if the path is a regular file (or a symlink to a regular1611 * file) and matches the saved stat_validity, 0 otherwise. A missing1612 * or inaccessible file is considered a match if the struct was just1613 * initialized, or if the previous update found an inaccessible file.1614 */1615int stat_validity_check(struct stat_validity *sv, const char *path);16161617/*1618 * Update the stat_validity from a file opened at descriptor fd. If1619 * the file is missing, inaccessible, or not a regular file, then1620 * future calls to stat_validity_check will match iff one of those1621 * conditions continues to be true.1622 */1623void stat_validity_update(struct stat_validity *sv, int fd);16241625int versioncmp(const char *s1, const char *s2);16261627#endif /* CACHE_H */