4 #include "git-compat-util.h"
11 #include "string-list.h"
14 #ifndef platform_SHA_CTX
16 * platform's underlying implementation of SHA-1; could be OpenSSL,
17 * blk_SHA, Apple CommonCrypto, etc... Note that including
18 * SHA1_HEADER may have already defined platform_SHA_CTX for our
19 * own implementations like block-sha1 and ppc-sha1, so we list
20 * the default for OpenSSL compatible SHA-1 implementations here.
22 #define platform_SHA_CTX SHA_CTX
23 #define platform_SHA1_Init SHA1_Init
24 #define platform_SHA1_Update SHA1_Update
25 #define platform_SHA1_Final SHA1_Final
28 #define git_SHA_CTX platform_SHA_CTX
29 #define git_SHA1_Init platform_SHA1_Init
30 #define git_SHA1_Update platform_SHA1_Update
31 #define git_SHA1_Final platform_SHA1_Final
33 #ifdef SHA1_MAX_BLOCK_SIZE
34 #include "compat/sha1-chunked.h"
35 #undef git_SHA1_Update
36 #define git_SHA1_Update git_SHA1_Update_Chunked
40 typedef struct git_zstream {
42 unsigned long avail_in;
43 unsigned long avail_out;
44 unsigned long total_in;
45 unsigned long total_out;
46 unsigned char *next_in;
47 unsigned char *next_out;
50 void git_inflate_init(git_zstream *);
51 void git_inflate_init_gzip_only(git_zstream *);
52 void git_inflate_end(git_zstream *);
53 int git_inflate(git_zstream *, int flush);
55 void git_deflate_init(git_zstream *, int level);
56 void git_deflate_init_gzip(git_zstream *, int level);
57 void git_deflate_init_raw(git_zstream *, int level);
58 void git_deflate_end(git_zstream *);
59 int git_deflate_abort(git_zstream *);
60 int git_deflate_end_gently(git_zstream *);
61 int git_deflate(git_zstream *, int flush);
62 unsigned long git_deflate_bound(git_zstream *, unsigned long);
64 /* The length in bytes and in hex digits of an object name (SHA-1 value). */
65 #define GIT_SHA1_RAWSZ 20
66 #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
69 unsigned char hash[GIT_SHA1_RAWSZ];
72 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
73 #define DTYPE(de) ((de)->d_type)
83 #define DTYPE(de) DT_UNKNOWN
86 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
87 #define S_IFINVALID 0030000
90 * A "directory link" is a link to another git directory.
92 * The value 0160000 is not normally a valid mode, and
93 * also just happens to be S_IFDIR + S_IFLNK
95 #define S_IFGITLINK 0160000
96 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
99 * Some mode bits are also used internally for computations.
101 * They *must* not overlap with any valid modes, and they *must* not be emitted
102 * to outside world - i.e. appear on disk or network. In other words, it's just
103 * temporary fields, which we internally use, but they have to stay in-house.
105 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
106 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
109 /* used internally in tree-diff */
110 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
114 * Intensive research over the course of many years has shown that
115 * port 9418 is totally unused by anything else. Or
117 * Your search - "port 9418" - did not match any documents.
119 * as www.google.com puts it.
121 * This port has been properly assigned for git use by IANA:
122 * git (Assigned-9418) [I06-050728-0001].
124 * git 9418/tcp git pack transfer service
125 * git 9418/udp git pack transfer service
127 * with Linus Torvalds <torvalds@osdl.org> as the point of
128 * contact. September 2005.
130 * See http://www.iana.org/assignments/port-numbers
132 #define DEFAULT_GIT_PORT 9418
135 * Basic data structures for the directory cache
138 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
139 struct cache_header {
140 uint32_t hdr_signature;
141 uint32_t hdr_version;
142 uint32_t hdr_entries;
145 #define INDEX_FORMAT_LB 2
146 #define INDEX_FORMAT_UB 4
149 * The "cache_time" is just the low 32 bits of the
150 * time. It doesn't matter if it overflows - we only
151 * check it for equality in the 32 bits we save.
159 struct cache_time sd_ctime;
160 struct cache_time sd_mtime;
165 unsigned int sd_size;
169 struct hashmap_entry ent;
170 struct stat_data ce_stat_data;
171 unsigned int ce_mode;
172 unsigned int ce_flags;
173 unsigned int ce_namelen;
174 unsigned int index; /* for link extension */
175 unsigned char sha1[20];
176 char name[FLEX_ARRAY]; /* more */
179 #define CE_STAGEMASK (0x3000)
180 #define CE_EXTENDED (0x4000)
181 #define CE_VALID (0x8000)
182 #define CE_STAGESHIFT 12
185 * Range 0xFFFF0FFF in ce_flags is divided into
186 * two parts: in-memory flags and on-disk ones.
187 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
188 * if you want to save a new flag, add it in
191 * In-memory only flags
193 #define CE_UPDATE (1 << 16)
194 #define CE_REMOVE (1 << 17)
195 #define CE_UPTODATE (1 << 18)
196 #define CE_ADDED (1 << 19)
198 #define CE_HASHED (1 << 20)
199 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
200 #define CE_CONFLICTED (1 << 23)
202 #define CE_UNPACKED (1 << 24)
203 #define CE_NEW_SKIP_WORKTREE (1 << 25)
205 /* used to temporarily mark paths matched by pathspecs */
206 #define CE_MATCHED (1 << 26)
208 #define CE_UPDATE_IN_BASE (1 << 27)
209 #define CE_STRIP_NAME (1 << 28)
212 * Extended on-disk flags
214 #define CE_INTENT_TO_ADD (1 << 29)
215 #define CE_SKIP_WORKTREE (1 << 30)
216 /* CE_EXTENDED2 is for future extension */
217 #define CE_EXTENDED2 (1U << 31)
219 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
222 * Safeguard to avoid saving wrong flags:
223 * - CE_EXTENDED2 won't get saved until its semantic is known
224 * - Bits in 0x0000FFFF have been saved in ce_flags already
225 * - Bits in 0x003F0000 are currently in-memory flags
227 #if CE_EXTENDED_FLAGS & 0x803FFFFF
228 #error "CE_EXTENDED_FLAGS out of range"
231 /* Forward structure decls */
233 struct child_process;
236 * Copy the sha1 and stat state of a cache entry from one to
237 * another. But we never change the name, or the hash state!
239 static inline void copy_cache_entry(struct cache_entry *dst,
240 const struct cache_entry *src)
242 unsigned int state = dst->ce_flags & CE_HASHED;
244 /* Don't copy hash chain and name */
245 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
246 offsetof(struct cache_entry, name) -
247 offsetof(struct cache_entry, ce_stat_data));
249 /* Restore the hash state */
250 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
253 static inline unsigned create_ce_flags(unsigned stage)
255 return (stage << CE_STAGESHIFT);
258 #define ce_namelen(ce) ((ce)->ce_namelen)
259 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
260 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
261 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
262 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
263 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
264 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
266 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
267 static inline unsigned int create_ce_mode(unsigned int mode)
271 if (S_ISDIR(mode) || S_ISGITLINK(mode))
273 return S_IFREG | ce_permissions(mode);
275 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
278 extern int trust_executable_bit, has_symlinks;
279 if (!has_symlinks && S_ISREG(mode) &&
280 ce && S_ISLNK(ce->ce_mode))
282 if (!trust_executable_bit && S_ISREG(mode)) {
283 if (ce && S_ISREG(ce->ce_mode))
285 return create_ce_mode(0666);
287 return create_ce_mode(mode);
289 static inline int ce_to_dtype(const struct cache_entry *ce)
291 unsigned ce_mode = ntohl(ce->ce_mode);
292 if (S_ISREG(ce_mode))
294 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
296 else if (S_ISLNK(ce_mode))
301 static inline unsigned int canon_mode(unsigned int mode)
304 return S_IFREG | ce_permissions(mode);
312 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
314 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
315 #define CE_ENTRY_CHANGED (1 << 1)
316 #define CE_ENTRY_REMOVED (1 << 2)
317 #define CE_ENTRY_ADDED (1 << 3)
318 #define RESOLVE_UNDO_CHANGED (1 << 4)
319 #define CACHE_TREE_CHANGED (1 << 5)
320 #define SPLIT_INDEX_ORDERED (1 << 6)
321 #define UNTRACKED_CHANGED (1 << 7)
324 struct untracked_cache;
327 struct cache_entry **cache;
328 unsigned int version;
329 unsigned int cache_nr, cache_alloc, cache_changed;
330 struct string_list *resolve_undo;
331 struct cache_tree *cache_tree;
332 struct split_index *split_index;
333 struct cache_time timestamp;
334 unsigned name_hash_initialized : 1,
336 struct hashmap name_hash;
337 struct hashmap dir_hash;
338 unsigned char sha1[20];
339 struct untracked_cache *untracked;
342 extern struct index_state the_index;
345 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
346 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
347 extern void free_name_hash(struct index_state *istate);
350 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
351 #define active_cache (the_index.cache)
352 #define active_nr (the_index.cache_nr)
353 #define active_alloc (the_index.cache_alloc)
354 #define active_cache_changed (the_index.cache_changed)
355 #define active_cache_tree (the_index.cache_tree)
357 #define read_cache() read_index(&the_index)
358 #define read_cache_from(path) read_index_from(&the_index, (path))
359 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
360 #define is_cache_unborn() is_index_unborn(&the_index)
361 #define read_cache_unmerged() read_index_unmerged(&the_index)
362 #define discard_cache() discard_index(&the_index)
363 #define unmerged_cache() unmerged_index(&the_index)
364 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
365 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
366 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
367 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
368 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
369 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
370 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
371 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
372 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
373 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
374 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
375 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
376 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
377 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
378 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
379 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
380 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
390 /* 5 for future expansion */
397 static inline enum object_type object_type(unsigned int mode)
399 return S_ISDIR(mode) ? OBJ_TREE :
400 S_ISGITLINK(mode) ? OBJ_COMMIT :
404 /* Double-check local_repo_env below if you add to this list. */
405 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
406 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
407 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
408 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
409 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
410 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
411 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
412 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
413 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
414 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
415 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
416 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
417 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
418 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
419 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
420 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
421 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
422 #define GITATTRIBUTES_FILE ".gitattributes"
423 #define INFOATTRIBUTES_FILE "info/attributes"
424 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
425 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
426 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
427 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
428 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
429 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
430 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
431 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
432 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
433 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
436 * This environment variable is expected to contain a boolean indicating
437 * whether we should or should not treat:
439 * GIT_DIR=foo.git git ...
441 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
442 * of this, but we use it internally to communicate to sub-processes that we
443 * are in a bare repo. If not set, defaults to true.
445 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
448 * Repository-local GIT_* environment variables; these will be cleared
449 * when git spawns a sub-process that runs inside another repository.
450 * The array is NULL-terminated, which makes it easy to pass in the "env"
451 * parameter of a run-command invocation, or to do a simple walk.
453 extern const char * const local_repo_env[];
455 extern int is_bare_repository_cfg;
456 extern int is_bare_repository(void);
457 extern int is_inside_git_dir(void);
458 extern char *git_work_tree_cfg;
459 extern int is_inside_work_tree(void);
460 extern const char *get_git_dir(void);
461 extern const char *get_git_common_dir(void);
462 extern char *get_object_directory(void);
463 extern char *get_index_file(void);
464 extern char *get_graft_file(void);
465 extern int set_git_dir(const char *path);
466 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
467 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
468 extern const char *get_git_namespace(void);
469 extern const char *strip_namespace(const char *namespaced_ref);
470 extern const char *get_git_work_tree(void);
473 * Return true if the given path is a git directory; note that this _just_
474 * looks at the directory itself. If you want to know whether "foo/.git"
475 * is a repository, you must feed that path, not just "foo".
477 extern int is_git_directory(const char *path);
480 * Return 1 if the given path is the root of a git repository or
481 * submodule, else 0. Will not return 1 for bare repositories with the
482 * exception of creating a bare repository in "foo/.git" and calling
483 * is_git_repository("foo").
485 * If we run into read errors, we err on the side of saying "yes, it is",
486 * as we usually consider sub-repos precious, and would prefer to err on the
487 * side of not disrupting or deleting them.
489 extern int is_nonbare_repository_dir(struct strbuf *path);
491 #define READ_GITFILE_ERR_STAT_FAILED 1
492 #define READ_GITFILE_ERR_NOT_A_FILE 2
493 #define READ_GITFILE_ERR_OPEN_FAILED 3
494 #define READ_GITFILE_ERR_READ_FAILED 4
495 #define READ_GITFILE_ERR_INVALID_FORMAT 5
496 #define READ_GITFILE_ERR_NO_PATH 6
497 #define READ_GITFILE_ERR_NOT_A_REPO 7
498 #define READ_GITFILE_ERR_TOO_LARGE 8
499 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
500 #define read_gitfile(path) read_gitfile_gently((path), NULL)
501 extern const char *resolve_gitdir(const char *suspect);
502 extern void set_git_work_tree(const char *tree);
504 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
506 extern const char **get_pathspec(const char *prefix, const char **pathspec);
507 extern void setup_work_tree(void);
508 extern const char *setup_git_directory_gently(int *);
509 extern const char *setup_git_directory(void);
510 extern char *prefix_path(const char *prefix, int len, const char *path);
511 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
512 extern const char *prefix_filename(const char *prefix, int len, const char *path);
513 extern int check_filename(const char *prefix, const char *name);
514 extern void verify_filename(const char *prefix,
516 int diagnose_misspelt_rev);
517 extern void verify_non_filename(const char *prefix, const char *name);
518 extern int path_inside_repo(const char *prefix, const char *path);
520 #define INIT_DB_QUIET 0x0001
522 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
523 extern int init_db(const char *template_dir, unsigned int flags);
525 extern void sanitize_stdfds(void);
526 extern int daemonize(void);
528 #define alloc_nr(x) (((x)+16)*3/2)
531 * Realloc the buffer pointed at by variable 'x' so that it can hold
532 * at least 'nr' entries; the number of entries currently allocated
533 * is 'alloc', using the standard growing factor alloc_nr() macro.
535 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
537 #define ALLOC_GROW(x, nr, alloc) \
539 if ((nr) > alloc) { \
540 if (alloc_nr(alloc) < (nr)) \
543 alloc = alloc_nr(alloc); \
544 REALLOC_ARRAY(x, alloc); \
548 /* Initialize and use the cache information */
550 extern int read_index(struct index_state *);
551 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
552 extern int do_read_index(struct index_state *istate, const char *path,
553 int must_exist); /* for testting only! */
554 extern int read_index_from(struct index_state *, const char *path);
555 extern int is_index_unborn(struct index_state *);
556 extern int read_index_unmerged(struct index_state *);
557 #define COMMIT_LOCK (1 << 0)
558 #define CLOSE_LOCK (1 << 1)
559 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
560 extern int discard_index(struct index_state *);
561 extern int unmerged_index(const struct index_state *);
562 extern int verify_path(const char *path);
563 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
564 extern void adjust_dirname_case(struct index_state *istate, char *name);
565 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
566 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
567 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
568 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
569 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
570 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
571 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
572 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
573 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
574 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
575 extern int remove_index_entry_at(struct index_state *, int pos);
576 extern void remove_marked_cache_entries(struct index_state *istate);
577 extern int remove_file_from_index(struct index_state *, const char *path);
578 #define ADD_CACHE_VERBOSE 1
579 #define ADD_CACHE_PRETEND 2
580 #define ADD_CACHE_IGNORE_ERRORS 4
581 #define ADD_CACHE_IGNORE_REMOVAL 8
582 #define ADD_CACHE_INTENT 16
583 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
584 extern int add_file_to_index(struct index_state *, const char *path, int flags);
585 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
586 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
587 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
588 extern int index_name_is_other(const struct index_state *, const char *, int);
589 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
591 /* do stat comparison even if CE_VALID is true */
592 #define CE_MATCH_IGNORE_VALID 01
593 /* do not check the contents but report dirty on racily-clean entries */
594 #define CE_MATCH_RACY_IS_DIRTY 02
595 /* do stat comparison even if CE_SKIP_WORKTREE is true */
596 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
597 /* ignore non-existent files during stat update */
598 #define CE_MATCH_IGNORE_MISSING 0x08
599 /* enable stat refresh */
600 #define CE_MATCH_REFRESH 0x10
601 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
602 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
604 #define HASH_WRITE_OBJECT 1
605 #define HASH_FORMAT_CHECK 2
606 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
607 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
610 * Record to sd the data from st that we use to check whether a file
611 * might have changed.
613 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
616 * Return 0 if st is consistent with a file not having been changed
617 * since sd was filled. If there are differences, return a
618 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
619 * INODE_CHANGED, and DATA_CHANGED.
621 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
622 extern int match_stat_data_racy(const struct index_state *istate,
623 const struct stat_data *sd, struct stat *st);
625 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
627 #define REFRESH_REALLY 0x0001 /* ignore_valid */
628 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
629 #define REFRESH_QUIET 0x0004 /* be quiet about it */
630 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
631 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
632 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
633 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
635 extern void update_index_if_able(struct index_state *, struct lock_file *);
637 extern int hold_locked_index(struct lock_file *, int);
638 extern void set_alternate_index_output(const char *);
640 /* Environment bits from configuration mechanism */
641 extern int trust_executable_bit;
642 extern int trust_ctime;
643 extern int check_stat;
644 extern int quote_path_fully;
645 extern int has_symlinks;
646 extern int minimum_abbrev, default_abbrev;
647 extern int ignore_case;
648 extern int assume_unchanged;
649 extern int prefer_symlink_refs;
650 extern int log_all_ref_updates;
651 extern int warn_ambiguous_refs;
652 extern int warn_on_object_refname_ambiguity;
653 extern int shared_repository;
654 extern const char *apply_default_whitespace;
655 extern const char *apply_default_ignorewhitespace;
656 extern const char *git_attributes_file;
657 extern int zlib_compression_level;
658 extern int core_compression_level;
659 extern int core_compression_seen;
660 extern size_t packed_git_window_size;
661 extern size_t packed_git_limit;
662 extern size_t delta_base_cache_limit;
663 extern unsigned long big_file_threshold;
664 extern unsigned long pack_size_limit_cfg;
667 * Do replace refs need to be checked this run? This variable is
668 * initialized to true unless --no-replace-object is used or
669 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
670 * commands that do not want replace references to be active. As an
671 * optimization it is also set to false if replace references have
672 * been sought but there were none.
674 extern int check_replace_refs;
675 extern char *git_replace_ref_base;
677 extern int fsync_object_files;
678 extern int core_preload_index;
679 extern int core_apply_sparse_checkout;
680 extern int precomposed_unicode;
681 extern int protect_hfs;
682 extern int protect_ntfs;
683 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
686 * Include broken refs in all ref iterations, which will
687 * generally choke dangerous operations rather than letting
688 * them silently proceed without taking the broken ref into
691 extern int ref_paranoia;
694 * The character that begins a commented line in user-editable file
695 * that is subject to stripspace.
697 extern char comment_line_char;
698 extern int auto_comment_line_char;
701 BRANCH_TRACK_UNSPECIFIED = -1,
702 BRANCH_TRACK_NEVER = 0,
705 BRANCH_TRACK_EXPLICIT,
706 BRANCH_TRACK_OVERRIDE
709 enum rebase_setup_type {
710 AUTOREBASE_NEVER = 0,
716 enum push_default_type {
717 PUSH_DEFAULT_NOTHING = 0,
718 PUSH_DEFAULT_MATCHING,
720 PUSH_DEFAULT_UPSTREAM,
721 PUSH_DEFAULT_CURRENT,
722 PUSH_DEFAULT_UNSPECIFIED
725 extern enum branch_track git_branch_track;
726 extern enum rebase_setup_type autorebase;
727 extern enum push_default_type push_default;
729 enum object_creation_mode {
730 OBJECT_CREATION_USES_HARDLINKS = 0,
731 OBJECT_CREATION_USES_RENAMES = 1
734 extern enum object_creation_mode object_creation_mode;
736 extern char *notes_ref_name;
738 extern int grafts_replace_parents;
741 * GIT_REPO_VERSION is the version we write by default. The
742 * _READ variant is the highest number we know how to
745 #define GIT_REPO_VERSION 0
746 #define GIT_REPO_VERSION_READ 1
747 extern int repository_format_version;
748 extern int repository_format_precious_objects;
749 extern int check_repository_format(void);
751 #define MTIME_CHANGED 0x0001
752 #define CTIME_CHANGED 0x0002
753 #define OWNER_CHANGED 0x0004
754 #define MODE_CHANGED 0x0008
755 #define INODE_CHANGED 0x0010
756 #define DATA_CHANGED 0x0020
757 #define TYPE_CHANGED 0x0040
760 * Return a statically allocated filename, either generically (mkpath), in
761 * the repository directory (git_path), or in a submodule's repository
762 * directory (git_path_submodule). In all cases, note that the result
763 * may be overwritten by another call to _any_ of the functions. Consider
764 * using the safer "dup" or "strbuf" formats below (in some cases, the
765 * unsafe versions have already been removed).
767 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
768 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
770 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
771 __attribute__((format (printf, 3, 4)));
772 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
773 __attribute__((format (printf, 2, 3)));
774 extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
775 __attribute__((format (printf, 2, 3)));
776 extern void strbuf_git_path_submodule(struct strbuf *sb, const char *path,
777 const char *fmt, ...)
778 __attribute__((format (printf, 3, 4)));
779 extern char *git_pathdup(const char *fmt, ...)
780 __attribute__((format (printf, 1, 2)));
781 extern char *mkpathdup(const char *fmt, ...)
782 __attribute__((format (printf, 1, 2)));
783 extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
784 __attribute__((format (printf, 2, 3)));
786 extern void report_linked_checkout_garbage(void);
789 * You can define a static memoized git path like:
791 * static GIT_PATH_FUNC(git_path_foo, "FOO");
793 * or use one of the global ones below.
795 #define GIT_PATH_FUNC(func, filename) \
796 const char *func(void) \
800 ret = git_pathdup(filename); \
804 const char *git_path_cherry_pick_head(void);
805 const char *git_path_revert_head(void);
806 const char *git_path_squash_msg(void);
807 const char *git_path_merge_msg(void);
808 const char *git_path_merge_rr(void);
809 const char *git_path_merge_mode(void);
810 const char *git_path_merge_head(void);
811 const char *git_path_fetch_head(void);
812 const char *git_path_shallow(void);
815 * Return the name of the file in the local object database that would
816 * be used to store a loose object with the specified sha1. The
817 * return value is a pointer to a statically allocated buffer that is
818 * overwritten each time the function is called.
820 extern const char *sha1_file_name(const unsigned char *sha1);
823 * Return the name of the (local) packfile with the specified sha1 in
824 * its name. The return value is a pointer to memory that is
825 * overwritten each time this function is called.
827 extern char *sha1_pack_name(const unsigned char *sha1);
830 * Return the name of the (local) pack index file with the specified
831 * sha1 in its name. The return value is a pointer to memory that is
832 * overwritten each time this function is called.
834 extern char *sha1_pack_index_name(const unsigned char *sha1);
837 * Return an abbreviated sha1 unique within this repository's object database.
838 * The result will be at least `len` characters long, and will be NUL
841 * The non-`_r` version returns a static buffer which will be overwritten by
844 * The `_r` variant writes to a buffer supplied by the caller, which must be at
845 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
846 * written (excluding the NUL terminator).
848 * Note that while this version avoids the static buffer, it is not fully
849 * reentrant, as it calls into other non-reentrant git code.
851 extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
852 extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
854 extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
855 extern const struct object_id null_oid;
857 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
861 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
863 return *sha1 - *sha2;
869 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
871 return hashcmp(oid1->hash, oid2->hash);
874 static inline int is_null_sha1(const unsigned char *sha1)
876 return !hashcmp(sha1, null_sha1);
879 static inline int is_null_oid(const struct object_id *oid)
881 return !hashcmp(oid->hash, null_sha1);
884 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
886 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
889 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
891 hashcpy(dst->hash, src->hash);
894 static inline void hashclr(unsigned char *hash)
896 memset(hash, 0, GIT_SHA1_RAWSZ);
899 static inline void oidclr(struct object_id *oid)
905 #define EMPTY_TREE_SHA1_HEX \
906 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
907 #define EMPTY_TREE_SHA1_BIN_LITERAL \
908 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
909 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
910 #define EMPTY_TREE_SHA1_BIN \
911 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
913 #define EMPTY_BLOB_SHA1_HEX \
914 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
915 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
916 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
917 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
918 #define EMPTY_BLOB_SHA1_BIN \
919 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
921 static inline int is_empty_blob_sha1(const unsigned char *sha1)
923 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
926 int git_mkstemp(char *path, size_t n, const char *template);
928 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
930 /* set default permissions by passing mode arguments to open(2) */
931 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
932 int git_mkstemp_mode(char *pattern, int mode);
937 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
938 * not be changed. Old repositories have core.sharedrepository written in
939 * numeric format, and therefore these values are preserved for compatibility
945 OLD_PERM_EVERYBODY = 2,
947 PERM_EVERYBODY = 0664
949 int git_config_perm(const char *var, const char *value);
950 int adjust_shared_perm(const char *path);
953 * Create the directory containing the named path, using care to be
954 * somewhat safe against races. Return one of the scld_error values
955 * to indicate success/failure.
957 * SCLD_VANISHED indicates that one of the ancestor directories of the
958 * path existed at one point during the function call and then
959 * suddenly vanished, probably because another process pruned the
960 * directory while we were working. To be robust against this kind of
961 * race, callers might want to try invoking the function again when it
962 * returns SCLD_VANISHED.
971 enum scld_error safe_create_leading_directories(char *path);
972 enum scld_error safe_create_leading_directories_const(const char *path);
974 int mkdir_in_gitdir(const char *path);
975 extern char *expand_user_path(const char *path);
976 const char *enter_repo(const char *path, int strict);
977 static inline int is_absolute_path(const char *path)
979 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
981 int is_directory(const char *);
982 const char *real_path(const char *path);
983 const char *real_path_if_valid(const char *path);
984 const char *absolute_path(const char *path);
985 const char *remove_leading_path(const char *in, const char *prefix);
986 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
987 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
988 int normalize_path_copy(char *dst, const char *src);
989 int longest_ancestor_length(const char *path, struct string_list *prefixes);
990 char *strip_path_suffix(const char *path, const char *suffix);
991 int daemon_avoid_alias(const char *path);
992 extern int is_ntfs_dotgit(const char *name);
995 * Return a newly allocated string with the evaluation of
996 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
997 * "$HOME/.config/git/$filename". Return NULL upon error.
999 extern char *xdg_config_home(const char *filename);
1001 /* object replacement */
1002 #define LOOKUP_REPLACE_OBJECT 1
1003 #define LOOKUP_UNKNOWN_OBJECT 2
1004 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
1005 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1007 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
1011 * This internal function is only declared here for the benefit of
1012 * lookup_replace_object(). Please do not call it directly.
1014 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1017 * If object sha1 should be replaced, return the replacement object's
1018 * name (replaced recursively, if necessary). The return value is
1019 * either sha1 or a pointer to a permanently-allocated value. When
1020 * object replacement is suppressed, always return sha1.
1022 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1024 if (!check_replace_refs)
1026 return do_lookup_replace_object(sha1);
1029 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1031 if (!(flag & LOOKUP_REPLACE_OBJECT))
1033 return lookup_replace_object(sha1);
1036 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1037 extern int sha1_object_info(const unsigned char *, unsigned long *);
1038 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1039 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1040 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
1041 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1042 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1043 extern int git_open_noatime(const char *name);
1044 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1045 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1046 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1048 /* global flag to enable extra checks when accessing packed objects */
1049 extern int do_check_packed_object_crc;
1051 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1053 extern int finalize_object_file(const char *tmpfile, const char *filename);
1055 extern int has_sha1_pack(const unsigned char *sha1);
1058 * Return true iff we have an object named sha1, whether local or in
1059 * an alternate object database, and whether packed or loose. This
1060 * function does not respect replace references.
1062 * If the QUICK flag is set, do not re-check the pack directory
1063 * when we cannot find the object (this means we may give a false
1064 * negative answer if another process is simultaneously repacking).
1066 #define HAS_SHA1_QUICK 0x1
1067 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1068 static inline int has_sha1_file(const unsigned char *sha1)
1070 return has_sha1_file_with_flags(sha1, 0);
1073 /* Same as the above, except for struct object_id. */
1074 extern int has_object_file(const struct object_id *oid);
1077 * Return true iff an alternate object database has a loose object
1078 * with the specified name. This function does not respect replace
1081 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1083 extern int has_pack_index(const unsigned char *sha1);
1085 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1087 extern const signed char hexval_table[256];
1088 static inline unsigned int hexval(unsigned char c)
1090 return hexval_table[c];
1093 /* Convert to/from hex/sha1 representation */
1094 #define MINIMUM_ABBREV minimum_abbrev
1095 #define DEFAULT_ABBREV default_abbrev
1097 struct object_context {
1098 unsigned char tree[20];
1099 char path[PATH_MAX];
1102 * symlink_path is only used by get_tree_entry_follow_symlinks,
1103 * and only for symlinks that point outside the repository.
1105 struct strbuf symlink_path;
1108 #define GET_SHA1_QUIETLY 01
1109 #define GET_SHA1_COMMIT 02
1110 #define GET_SHA1_COMMITTISH 04
1111 #define GET_SHA1_TREE 010
1112 #define GET_SHA1_TREEISH 020
1113 #define GET_SHA1_BLOB 040
1114 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1115 #define GET_SHA1_ONLY_TO_DIE 04000
1117 extern int get_sha1(const char *str, unsigned char *sha1);
1118 extern int get_sha1_commit(const char *str, unsigned char *sha1);
1119 extern int get_sha1_committish(const char *str, unsigned char *sha1);
1120 extern int get_sha1_tree(const char *str, unsigned char *sha1);
1121 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1122 extern int get_sha1_blob(const char *str, unsigned char *sha1);
1123 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1124 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
1126 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1127 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1130 * Try to read a SHA1 in hexadecimal format from the 40 characters
1131 * starting at hex. Write the 20-byte result to sha1 in binary form.
1132 * Return 0 on success. Reading stops if a NUL is encountered in the
1133 * input, so it is safe to pass this function an arbitrary
1134 * null-terminated string.
1136 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1137 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1140 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1141 * and writes the NUL-terminated output to the buffer `out`, which must be at
1142 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1145 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1146 * buffers, making it safe to make multiple calls for a single statement, like:
1148 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1150 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1151 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1152 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1154 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1155 extern int get_sha1_mb(const char *str, unsigned char *sha1);
1157 extern int validate_headref(const char *ref);
1159 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1160 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1161 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1162 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1164 extern void *read_object_with_reference(const unsigned char *sha1,
1165 const char *required_type,
1166 unsigned long *size,
1167 unsigned char *sha1_ret);
1169 extern struct object *peel_to_type(const char *name, int namelen,
1170 struct object *o, enum object_type);
1173 enum date_mode_type {
1178 DATE_ISO8601_STRICT,
1183 const char *strftime_fmt;
1188 * Convenience helper for passing a constant type, like:
1190 * show_date(t, tz, DATE_MODE(NORMAL));
1192 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1193 struct date_mode *date_mode_from_type(enum date_mode_type type);
1195 const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
1196 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1197 struct strbuf *timebuf);
1198 int parse_date(const char *date, struct strbuf *out);
1199 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1200 int parse_expiry_date(const char *date, unsigned long *timestamp);
1201 void datestamp(struct strbuf *out);
1202 #define approxidate(s) approxidate_careful((s), NULL)
1203 unsigned long approxidate_careful(const char *, int *);
1204 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1205 void parse_date_format(const char *format, struct date_mode *mode);
1206 int date_overflows(unsigned long date);
1208 #define IDENT_STRICT 1
1209 #define IDENT_NO_DATE 2
1210 #define IDENT_NO_NAME 4
1211 extern const char *git_author_info(int);
1212 extern const char *git_committer_info(int);
1213 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1214 extern const char *fmt_name(const char *name, const char *email);
1215 extern const char *ident_default_name(void);
1216 extern const char *ident_default_email(void);
1217 extern const char *git_editor(void);
1218 extern const char *git_pager(int stdout_is_tty);
1219 extern int git_ident_config(const char *, const char *, void *);
1221 struct ident_split {
1222 const char *name_begin;
1223 const char *name_end;
1224 const char *mail_begin;
1225 const char *mail_end;
1226 const char *date_begin;
1227 const char *date_end;
1228 const char *tz_begin;
1232 * Signals an success with 0, but time part of the result may be NULL
1233 * if the input lacks timestamp and zone
1235 extern int split_ident_line(struct ident_split *, const char *, int);
1238 * Like show_date, but pull the timestamp and tz parameters from
1239 * the ident_split. It will also sanity-check the values and produce
1240 * a well-known sentinel date if they appear bogus.
1242 const char *show_ident_date(const struct ident_split *id,
1243 const struct date_mode *mode);
1246 * Compare split idents for equality or strict ordering. Note that we
1247 * compare only the ident part of the line, ignoring any timestamp.
1249 * Because there are two fields, we must choose one as the primary key; we
1250 * currently arbitrarily pick the email.
1252 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1255 struct index_state *istate;
1256 const char *base_dir;
1264 #define TEMPORARY_FILENAME_LENGTH 25
1265 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1271 int prefix_len_stat_func;
1273 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1274 static inline void cache_def_clear(struct cache_def *cache)
1276 strbuf_release(&cache->path);
1279 extern int has_symlink_leading_path(const char *name, int len);
1280 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1281 extern int check_leading_path(const char *name, int len);
1282 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1283 extern void schedule_dir_for_removal(const char *name, int len);
1284 extern void remove_scheduled_dirs(void);
1286 extern struct alternate_object_database {
1287 struct alternate_object_database *next;
1289 char base[FLEX_ARRAY]; /* more */
1291 extern void prepare_alt_odb(void);
1292 extern void read_info_alternates(const char * relative_base, int depth);
1293 extern void add_to_alternates_file(const char *reference);
1294 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1295 extern int foreach_alt_odb(alt_odb_fn, void*);
1297 struct pack_window {
1298 struct pack_window *next;
1299 unsigned char *base;
1302 unsigned int last_used;
1303 unsigned int inuse_cnt;
1306 extern struct packed_git {
1307 struct packed_git *next;
1308 struct pack_window *windows;
1310 const void *index_data;
1312 uint32_t num_objects;
1313 uint32_t num_bad_objects;
1314 unsigned char *bad_object_sha1;
1318 unsigned pack_local:1,
1322 unsigned char sha1[20];
1323 /* something like ".git/objects/pack/xxxxx.pack" */
1324 char pack_name[FLEX_ARRAY]; /* more */
1329 unsigned char sha1[20];
1330 struct packed_git *p;
1333 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1335 /* A hook to report invalid files in pack directory */
1336 #define PACKDIR_FILE_PACK 1
1337 #define PACKDIR_FILE_IDX 2
1338 #define PACKDIR_FILE_GARBAGE 4
1339 extern void (*report_garbage)(unsigned seen_bits, const char *path);
1341 extern void prepare_packed_git(void);
1342 extern void reprepare_packed_git(void);
1343 extern void install_packed_git(struct packed_git *pack);
1345 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1346 struct packed_git *packs);
1348 extern void pack_report(void);
1351 * mmap the index file for the specified packfile (if it is not
1352 * already mmapped). Return 0 on success.
1354 extern int open_pack_index(struct packed_git *);
1357 * munmap the index file for the specified packfile (if it is
1358 * currently mmapped).
1360 extern void close_pack_index(struct packed_git *);
1362 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1363 extern void close_pack_windows(struct packed_git *);
1364 extern void close_all_packs(void);
1365 extern void unuse_pack(struct pack_window **);
1366 extern void free_pack_by_name(const char *);
1367 extern void clear_delta_base_cache(void);
1368 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
1371 * Make sure that a pointer access into an mmap'd index file is within bounds,
1372 * and can provide at least 8 bytes of data.
1374 * Note that this is only necessary for variable-length segments of the file
1375 * (like the 64-bit extended offset table), as we compare the size to the
1376 * fixed-length parts when we open the file.
1378 extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
1381 * Return the SHA-1 of the nth object within the specified packfile.
1382 * Open the index if it is not already open. The return value points
1383 * at the SHA-1 within the mmapped index. Return NULL if there is an
1386 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1389 * Return the offset of the nth object within the specified packfile.
1390 * The index must already be opened.
1392 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1395 * If the object named sha1 is present in the specified packfile,
1396 * return its offset within the packfile; otherwise, return 0.
1398 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1400 extern int is_pack_valid(struct packed_git *);
1401 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1402 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1403 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1404 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1407 * Iterate over the files in the loose-object parts of the object
1408 * directory "path", triggering the following callbacks:
1410 * - loose_object is called for each loose object we find.
1412 * - loose_cruft is called for any files that do not appear to be
1413 * loose objects. Note that we only look in the loose object
1414 * directories "objects/[0-9a-f]{2}/", so we will not report
1415 * "objects/foobar" as cruft.
1417 * - loose_subdir is called for each top-level hashed subdirectory
1418 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1419 * after the objects in the directory are processed.
1421 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1422 * will end the iteration.
1424 * In the "buf" variant, "path" is a strbuf which will also be used as a
1425 * scratch buffer, but restored to its original contents before
1426 * the function returns.
1428 typedef int each_loose_object_fn(const unsigned char *sha1,
1431 typedef int each_loose_cruft_fn(const char *basename,
1434 typedef int each_loose_subdir_fn(int nr,
1437 int for_each_loose_file_in_objdir(const char *path,
1438 each_loose_object_fn obj_cb,
1439 each_loose_cruft_fn cruft_cb,
1440 each_loose_subdir_fn subdir_cb,
1442 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1443 each_loose_object_fn obj_cb,
1444 each_loose_cruft_fn cruft_cb,
1445 each_loose_subdir_fn subdir_cb,
1449 * Iterate over loose and packed objects in both the local
1450 * repository and any alternates repositories (unless the
1451 * LOCAL_ONLY flag is set).
1453 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1454 typedef int each_packed_object_fn(const unsigned char *sha1,
1455 struct packed_git *pack,
1458 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1459 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1461 struct object_info {
1463 enum object_type *typep;
1464 unsigned long *sizep;
1465 unsigned long *disk_sizep;
1466 unsigned char *delta_base_sha1;
1467 struct strbuf *typename;
1479 * ... Nothing to expose in this case
1482 * ... Nothing to expose in this case
1486 struct packed_git *pack;
1488 unsigned int is_delta;
1492 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1494 /* Dumb servers support */
1495 extern int update_server_info(int);
1497 /* git_config_parse_key() returns these negated: */
1498 #define CONFIG_INVALID_KEY 1
1499 #define CONFIG_NO_SECTION_OR_NAME 2
1500 /* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
1501 #define CONFIG_NO_LOCK -1
1502 #define CONFIG_INVALID_FILE 3
1503 #define CONFIG_NO_WRITE 4
1504 #define CONFIG_NOTHING_SET 5
1505 #define CONFIG_INVALID_PATTERN 6
1506 #define CONFIG_GENERIC_ERROR 7
1508 #define CONFIG_REGEX_NONE ((void *)1)
1510 struct git_config_source {
1511 unsigned int use_stdin:1;
1516 typedef int (*config_fn_t)(const char *, const char *, void *);
1517 extern int git_default_config(const char *, const char *, void *);
1518 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1519 extern int git_config_from_buf(config_fn_t fn, const char *name,
1520 const char *buf, size_t len, void *data);
1521 extern void git_config_push_parameter(const char *text);
1522 extern int git_config_from_parameters(config_fn_t fn, void *data);
1523 extern void git_config(config_fn_t fn, void *);
1524 extern int git_config_with_options(config_fn_t fn, void *,
1525 struct git_config_source *config_source,
1526 int respect_includes);
1527 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1528 extern int git_parse_ulong(const char *, unsigned long *);
1529 extern int git_parse_maybe_bool(const char *);
1530 extern int git_config_int(const char *, const char *);
1531 extern int64_t git_config_int64(const char *, const char *);
1532 extern unsigned long git_config_ulong(const char *, const char *);
1533 extern int git_config_bool_or_int(const char *, const char *, int *);
1534 extern int git_config_bool(const char *, const char *);
1535 extern int git_config_maybe_bool(const char *, const char *);
1536 extern int git_config_string(const char **, const char *, const char *);
1537 extern int git_config_pathname(const char **, const char *, const char *);
1538 extern int git_config_set_in_file_gently(const char *, const char *, const char *);
1539 extern void git_config_set_in_file(const char *, const char *, const char *);
1540 extern int git_config_set_gently(const char *, const char *);
1541 extern void git_config_set(const char *, const char *);
1542 extern int git_config_parse_key(const char *, char **, int *);
1543 extern int git_config_key_is_valid(const char *key);
1544 extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
1545 extern void git_config_set_multivar(const char *, const char *, const char *, int);
1546 extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
1547 extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1548 extern int git_config_rename_section(const char *, const char *);
1549 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1550 extern const char *git_etc_gitconfig(void);
1551 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1552 extern int git_env_bool(const char *, int);
1553 extern unsigned long git_env_ulong(const char *, unsigned long);
1554 extern int git_config_system(void);
1555 extern int config_error_nonbool(const char *);
1556 #if defined(__GNUC__)
1557 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1559 extern const char *get_log_output_encoding(void);
1560 extern const char *get_commit_output_encoding(void);
1562 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1564 struct config_include_data {
1569 #define CONFIG_INCLUDE_INIT { 0 }
1570 extern int git_config_include(const char *name, const char *value, void *data);
1573 * Match and parse a config key of the form:
1575 * section.(subsection.)?key
1577 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1578 * we return -1 if it does not match, 0 otherwise. The subsection and key
1579 * out-parameters are filled by the function (and subsection is NULL if it is
1582 extern int parse_config_key(const char *var,
1583 const char *section,
1584 const char **subsection, int *subsection_len,
1587 struct config_set_element {
1588 struct hashmap_entry ent;
1590 struct string_list value_list;
1593 struct configset_list_item {
1594 struct config_set_element *e;
1599 * the contents of the list are ordered according to their
1600 * position in the config files and order of parsing the files.
1601 * (i.e. key-value pair at the last position of .git/config will
1602 * be at the last item of the list)
1604 struct configset_list {
1605 struct configset_list_item *items;
1606 unsigned int nr, alloc;
1610 struct hashmap config_hash;
1611 int hash_initialized;
1612 struct configset_list list;
1615 extern void git_configset_init(struct config_set *cs);
1616 extern int git_configset_add_file(struct config_set *cs, const char *filename);
1617 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1618 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1619 extern void git_configset_clear(struct config_set *cs);
1620 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1621 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1622 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1623 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1624 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1625 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1626 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1627 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1629 extern int git_config_get_value(const char *key, const char **value);
1630 extern const struct string_list *git_config_get_value_multi(const char *key);
1631 extern void git_config_clear(void);
1632 extern void git_config_iter(config_fn_t fn, void *data);
1633 extern int git_config_get_string_const(const char *key, const char **dest);
1634 extern int git_config_get_string(const char *key, char **dest);
1635 extern int git_config_get_int(const char *key, int *dest);
1636 extern int git_config_get_ulong(const char *key, unsigned long *dest);
1637 extern int git_config_get_bool(const char *key, int *dest);
1638 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1639 extern int git_config_get_maybe_bool(const char *key, int *dest);
1640 extern int git_config_get_pathname(const char *key, const char **dest);
1642 struct key_value_info {
1643 const char *filename;
1647 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1648 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1650 extern int committer_ident_sufficiently_given(void);
1651 extern int author_ident_sufficiently_given(void);
1653 extern const char *git_commit_encoding;
1654 extern const char *git_log_output_encoding;
1655 extern const char *git_mailmap_file;
1656 extern const char *git_mailmap_blob;
1658 /* IO helper functions */
1659 extern void maybe_flush_or_die(FILE *, const char *);
1660 __attribute__((format (printf, 2, 3)))
1661 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1663 #define COPY_READ_ERROR (-2)
1664 #define COPY_WRITE_ERROR (-3)
1665 extern int copy_fd(int ifd, int ofd);
1666 extern int copy_file(const char *dst, const char *src, int mode);
1667 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1669 extern void write_or_die(int fd, const void *buf, size_t count);
1670 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1671 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1672 extern void fsync_or_die(int fd, const char *);
1674 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1675 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1676 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1678 static inline ssize_t write_str_in_full(int fd, const char *str)
1680 return write_in_full(fd, str, strlen(str));
1683 extern int write_file(const char *path, const char *fmt, ...);
1684 extern int write_file_gently(const char *path, const char *fmt, ...);
1687 extern void setup_pager(void);
1688 extern const char *pager_program;
1689 extern int pager_in_use(void);
1690 extern int pager_use_color;
1691 extern int term_columns(void);
1692 extern int decimal_width(uintmax_t);
1693 extern int check_pager_config(const char *cmd);
1694 extern void prepare_pager_args(struct child_process *, const char *pager);
1696 extern const char *editor_program;
1697 extern const char *askpass_program;
1698 extern const char *excludes_file;
1701 int decode_85(char *dst, const char *line, int linelen);
1702 void encode_85(char *buf, const unsigned char *data, int bytes);
1705 extern void *alloc_blob_node(void);
1706 extern void *alloc_tree_node(void);
1707 extern void *alloc_commit_node(void);
1708 extern void *alloc_tag_node(void);
1709 extern void *alloc_object_node(void);
1710 extern void alloc_report(void);
1711 extern unsigned int alloc_commit_index(void);
1714 void packet_trace_identity(const char *prog);
1718 * return 0 if success, 1 - if addition of a file failed and
1719 * ADD_FILES_IGNORE_ERRORS was specified in flags
1721 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1724 extern int diff_auto_refresh_index;
1727 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1728 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1732 * used by both diff and apply
1733 * last two digits are tab width
1735 #define WS_BLANK_AT_EOL 0100
1736 #define WS_SPACE_BEFORE_TAB 0200
1737 #define WS_INDENT_WITH_NON_TAB 0400
1738 #define WS_CR_AT_EOL 01000
1739 #define WS_BLANK_AT_EOF 02000
1740 #define WS_TAB_IN_INDENT 04000
1741 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1742 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1743 #define WS_TAB_WIDTH_MASK 077
1744 extern unsigned whitespace_rule_cfg;
1745 extern unsigned whitespace_rule(const char *);
1746 extern unsigned parse_whitespace_rule(const char *);
1747 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1748 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1749 extern char *whitespace_error_string(unsigned ws);
1750 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1751 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1752 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1755 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1757 char *alias_lookup(const char *alias);
1758 int split_cmdline(char *cmdline, const char ***argv);
1759 /* Takes a negative value returned by split_cmdline */
1760 const char *split_cmdline_strerror(int cmdline_errno);
1763 struct startup_info {
1764 int have_repository;
1767 extern struct startup_info *startup_info;
1771 int try_merge_command(const char *strategy, size_t xopts_nr,
1772 const char **xopts, struct commit_list *common,
1773 const char *head_arg, struct commit_list *remotes);
1774 int checkout_fast_forward(const unsigned char *from,
1775 const unsigned char *to,
1776 int overwrite_ignore);
1779 int sane_execvp(const char *file, char *const argv[]);
1782 * A struct to encapsulate the concept of whether a file has changed
1783 * since we last checked it. This uses criteria similar to those used
1786 struct stat_validity {
1787 struct stat_data *sd;
1790 void stat_validity_clear(struct stat_validity *sv);
1793 * Returns 1 if the path is a regular file (or a symlink to a regular
1794 * file) and matches the saved stat_validity, 0 otherwise. A missing
1795 * or inaccessible file is considered a match if the struct was just
1796 * initialized, or if the previous update found an inaccessible file.
1798 int stat_validity_check(struct stat_validity *sv, const char *path);
1801 * Update the stat_validity from a file opened at descriptor fd. If
1802 * the file is missing, inaccessible, or not a regular file, then
1803 * future calls to stat_validity_check will match iff one of those
1804 * conditions continues to be true.
1806 void stat_validity_update(struct stat_validity *sv, int fd);
1808 int versioncmp(const char *s1, const char *s2);
1809 void sleep_millisec(int millisec);
1812 * Create a directory and (if share is nonzero) adjust its permissions
1813 * according to the shared_repository setting. Only use this for
1814 * directories under $GIT_DIR. Don't use it for working tree
1817 void safe_create_dir(const char *dir, int share);
1819 #endif /* CACHE_H */