4 #include "git-compat-util.h"
11 #include "string-list.h"
12 #include "pack-revindex.h"
15 #ifndef platform_SHA_CTX
17 * platform's underlying implementation of SHA-1; could be OpenSSL,
18 * blk_SHA, Apple CommonCrypto, etc... Note that including
19 * SHA1_HEADER may have already defined platform_SHA_CTX for our
20 * own implementations like block-sha1 and ppc-sha1, so we list
21 * the default for OpenSSL compatible SHA-1 implementations here.
23 #define platform_SHA_CTX SHA_CTX
24 #define platform_SHA1_Init SHA1_Init
25 #define platform_SHA1_Update SHA1_Update
26 #define platform_SHA1_Final SHA1_Final
29 #define git_SHA_CTX platform_SHA_CTX
30 #define git_SHA1_Init platform_SHA1_Init
31 #define git_SHA1_Update platform_SHA1_Update
32 #define git_SHA1_Final platform_SHA1_Final
34 #ifdef SHA1_MAX_BLOCK_SIZE
35 #include "compat/sha1-chunked.h"
36 #undef git_SHA1_Update
37 #define git_SHA1_Update git_SHA1_Update_Chunked
41 typedef struct git_zstream {
43 unsigned long avail_in;
44 unsigned long avail_out;
45 unsigned long total_in;
46 unsigned long total_out;
47 unsigned char *next_in;
48 unsigned char *next_out;
51 void git_inflate_init(git_zstream *);
52 void git_inflate_init_gzip_only(git_zstream *);
53 void git_inflate_end(git_zstream *);
54 int git_inflate(git_zstream *, int flush);
56 void git_deflate_init(git_zstream *, int level);
57 void git_deflate_init_gzip(git_zstream *, int level);
58 void git_deflate_init_raw(git_zstream *, int level);
59 void git_deflate_end(git_zstream *);
60 int git_deflate_abort(git_zstream *);
61 int git_deflate_end_gently(git_zstream *);
62 int git_deflate(git_zstream *, int flush);
63 unsigned long git_deflate_bound(git_zstream *, unsigned long);
65 /* The length in bytes and in hex digits of an object name (SHA-1 value). */
66 #define GIT_SHA1_RAWSZ 20
67 #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
69 /* The length in byte and in hex digits of the largest possible hash value. */
70 #define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ
71 #define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ
74 unsigned char hash[GIT_MAX_RAWSZ];
77 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
78 #define DTYPE(de) ((de)->d_type)
88 #define DTYPE(de) DT_UNKNOWN
91 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
92 #define S_IFINVALID 0030000
95 * A "directory link" is a link to another git directory.
97 * The value 0160000 is not normally a valid mode, and
98 * also just happens to be S_IFDIR + S_IFLNK
100 #define S_IFGITLINK 0160000
101 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
104 * Some mode bits are also used internally for computations.
106 * They *must* not overlap with any valid modes, and they *must* not be emitted
107 * to outside world - i.e. appear on disk or network. In other words, it's just
108 * temporary fields, which we internally use, but they have to stay in-house.
110 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
111 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
114 /* used internally in tree-diff */
115 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
119 * Intensive research over the course of many years has shown that
120 * port 9418 is totally unused by anything else. Or
122 * Your search - "port 9418" - did not match any documents.
124 * as www.google.com puts it.
126 * This port has been properly assigned for git use by IANA:
127 * git (Assigned-9418) [I06-050728-0001].
129 * git 9418/tcp git pack transfer service
130 * git 9418/udp git pack transfer service
132 * with Linus Torvalds <torvalds@osdl.org> as the point of
133 * contact. September 2005.
135 * See http://www.iana.org/assignments/port-numbers
137 #define DEFAULT_GIT_PORT 9418
140 * Basic data structures for the directory cache
143 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
144 struct cache_header {
145 uint32_t hdr_signature;
146 uint32_t hdr_version;
147 uint32_t hdr_entries;
150 #define INDEX_FORMAT_LB 2
151 #define INDEX_FORMAT_UB 4
154 * The "cache_time" is just the low 32 bits of the
155 * time. It doesn't matter if it overflows - we only
156 * check it for equality in the 32 bits we save.
164 struct cache_time sd_ctime;
165 struct cache_time sd_mtime;
170 unsigned int sd_size;
174 struct hashmap_entry ent;
175 struct stat_data ce_stat_data;
176 unsigned int ce_mode;
177 unsigned int ce_flags;
178 unsigned int ce_namelen;
179 unsigned int index; /* for link extension */
180 struct object_id oid;
181 char name[FLEX_ARRAY]; /* more */
184 #define CE_STAGEMASK (0x3000)
185 #define CE_EXTENDED (0x4000)
186 #define CE_VALID (0x8000)
187 #define CE_STAGESHIFT 12
190 * Range 0xFFFF0FFF in ce_flags is divided into
191 * two parts: in-memory flags and on-disk ones.
192 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
193 * if you want to save a new flag, add it in
196 * In-memory only flags
198 #define CE_UPDATE (1 << 16)
199 #define CE_REMOVE (1 << 17)
200 #define CE_UPTODATE (1 << 18)
201 #define CE_ADDED (1 << 19)
203 #define CE_HASHED (1 << 20)
204 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
205 #define CE_CONFLICTED (1 << 23)
207 #define CE_UNPACKED (1 << 24)
208 #define CE_NEW_SKIP_WORKTREE (1 << 25)
210 /* used to temporarily mark paths matched by pathspecs */
211 #define CE_MATCHED (1 << 26)
213 #define CE_UPDATE_IN_BASE (1 << 27)
214 #define CE_STRIP_NAME (1 << 28)
217 * Extended on-disk flags
219 #define CE_INTENT_TO_ADD (1 << 29)
220 #define CE_SKIP_WORKTREE (1 << 30)
221 /* CE_EXTENDED2 is for future extension */
222 #define CE_EXTENDED2 (1U << 31)
224 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
227 * Safeguard to avoid saving wrong flags:
228 * - CE_EXTENDED2 won't get saved until its semantic is known
229 * - Bits in 0x0000FFFF have been saved in ce_flags already
230 * - Bits in 0x003F0000 are currently in-memory flags
232 #if CE_EXTENDED_FLAGS & 0x803FFFFF
233 #error "CE_EXTENDED_FLAGS out of range"
236 /* Forward structure decls */
238 struct child_process;
241 * Copy the sha1 and stat state of a cache entry from one to
242 * another. But we never change the name, or the hash state!
244 static inline void copy_cache_entry(struct cache_entry *dst,
245 const struct cache_entry *src)
247 unsigned int state = dst->ce_flags & CE_HASHED;
249 /* Don't copy hash chain and name */
250 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
251 offsetof(struct cache_entry, name) -
252 offsetof(struct cache_entry, ce_stat_data));
254 /* Restore the hash state */
255 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
258 static inline unsigned create_ce_flags(unsigned stage)
260 return (stage << CE_STAGESHIFT);
263 #define ce_namelen(ce) ((ce)->ce_namelen)
264 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
265 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
266 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
267 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
268 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
269 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
271 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
272 static inline unsigned int create_ce_mode(unsigned int mode)
276 if (S_ISDIR(mode) || S_ISGITLINK(mode))
278 return S_IFREG | ce_permissions(mode);
280 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
283 extern int trust_executable_bit, has_symlinks;
284 if (!has_symlinks && S_ISREG(mode) &&
285 ce && S_ISLNK(ce->ce_mode))
287 if (!trust_executable_bit && S_ISREG(mode)) {
288 if (ce && S_ISREG(ce->ce_mode))
290 return create_ce_mode(0666);
292 return create_ce_mode(mode);
294 static inline int ce_to_dtype(const struct cache_entry *ce)
296 unsigned ce_mode = ntohl(ce->ce_mode);
297 if (S_ISREG(ce_mode))
299 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
301 else if (S_ISLNK(ce_mode))
306 static inline unsigned int canon_mode(unsigned int mode)
309 return S_IFREG | ce_permissions(mode);
317 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
319 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
320 #define CE_ENTRY_CHANGED (1 << 1)
321 #define CE_ENTRY_REMOVED (1 << 2)
322 #define CE_ENTRY_ADDED (1 << 3)
323 #define RESOLVE_UNDO_CHANGED (1 << 4)
324 #define CACHE_TREE_CHANGED (1 << 5)
325 #define SPLIT_INDEX_ORDERED (1 << 6)
326 #define UNTRACKED_CHANGED (1 << 7)
329 struct untracked_cache;
332 struct cache_entry **cache;
333 unsigned int version;
334 unsigned int cache_nr, cache_alloc, cache_changed;
335 struct string_list *resolve_undo;
336 struct cache_tree *cache_tree;
337 struct split_index *split_index;
338 struct cache_time timestamp;
339 unsigned name_hash_initialized : 1,
341 struct hashmap name_hash;
342 struct hashmap dir_hash;
343 unsigned char sha1[20];
344 struct untracked_cache *untracked;
347 extern struct index_state the_index;
350 extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
351 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
352 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
353 extern void free_name_hash(struct index_state *istate);
356 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
357 #define active_cache (the_index.cache)
358 #define active_nr (the_index.cache_nr)
359 #define active_alloc (the_index.cache_alloc)
360 #define active_cache_changed (the_index.cache_changed)
361 #define active_cache_tree (the_index.cache_tree)
363 #define read_cache() read_index(&the_index)
364 #define read_cache_from(path) read_index_from(&the_index, (path))
365 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
366 #define is_cache_unborn() is_index_unborn(&the_index)
367 #define read_cache_unmerged() read_index_unmerged(&the_index)
368 #define discard_cache() discard_index(&the_index)
369 #define unmerged_cache() unmerged_index(&the_index)
370 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
371 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
372 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
373 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
374 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
375 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
376 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
377 #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
378 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
379 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
380 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
381 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
382 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
383 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
384 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
385 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
386 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
387 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
397 /* 5 for future expansion */
404 static inline enum object_type object_type(unsigned int mode)
406 return S_ISDIR(mode) ? OBJ_TREE :
407 S_ISGITLINK(mode) ? OBJ_COMMIT :
411 /* Double-check local_repo_env below if you add to this list. */
412 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
413 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
414 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
415 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
416 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
417 #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
418 #define GIT_TOPLEVEL_PREFIX_ENVIRONMENT "GIT_INTERNAL_TOPLEVEL_PREFIX"
419 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
420 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
421 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
422 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
423 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
424 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
425 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
426 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
427 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
428 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
429 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
430 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
431 #define GITATTRIBUTES_FILE ".gitattributes"
432 #define INFOATTRIBUTES_FILE "info/attributes"
433 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
434 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
435 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
436 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
437 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
438 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
439 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
440 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
441 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
442 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
443 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
446 * This environment variable is expected to contain a boolean indicating
447 * whether we should or should not treat:
449 * GIT_DIR=foo.git git ...
451 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
452 * of this, but we use it internally to communicate to sub-processes that we
453 * are in a bare repo. If not set, defaults to true.
455 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
458 * Repository-local GIT_* environment variables; these will be cleared
459 * when git spawns a sub-process that runs inside another repository.
460 * The array is NULL-terminated, which makes it easy to pass in the "env"
461 * parameter of a run-command invocation, or to do a simple walk.
463 extern const char * const local_repo_env[];
466 * Returns true iff we have a configured git repository (either via
467 * setup_git_directory, or in the environment via $GIT_DIR).
469 int have_git_dir(void);
471 extern int is_bare_repository_cfg;
472 extern int is_bare_repository(void);
473 extern int is_inside_git_dir(void);
474 extern char *git_work_tree_cfg;
475 extern int is_inside_work_tree(void);
476 extern const char *get_git_dir(void);
477 extern const char *get_git_common_dir(void);
478 extern char *get_object_directory(void);
479 extern char *get_index_file(void);
480 extern char *get_graft_file(void);
481 extern int set_git_dir(const char *path);
482 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
483 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
484 extern const char *get_git_namespace(void);
485 extern const char *strip_namespace(const char *namespaced_ref);
486 extern const char *get_super_prefix(void);
487 extern const char *get_git_work_tree(void);
490 * Return true if the given path is a git directory; note that this _just_
491 * looks at the directory itself. If you want to know whether "foo/.git"
492 * is a repository, you must feed that path, not just "foo".
494 extern int is_git_directory(const char *path);
497 * Return 1 if the given path is the root of a git repository or
498 * submodule, else 0. Will not return 1 for bare repositories with the
499 * exception of creating a bare repository in "foo/.git" and calling
500 * is_git_repository("foo").
502 * If we run into read errors, we err on the side of saying "yes, it is",
503 * as we usually consider sub-repos precious, and would prefer to err on the
504 * side of not disrupting or deleting them.
506 extern int is_nonbare_repository_dir(struct strbuf *path);
508 #define READ_GITFILE_ERR_STAT_FAILED 1
509 #define READ_GITFILE_ERR_NOT_A_FILE 2
510 #define READ_GITFILE_ERR_OPEN_FAILED 3
511 #define READ_GITFILE_ERR_READ_FAILED 4
512 #define READ_GITFILE_ERR_INVALID_FORMAT 5
513 #define READ_GITFILE_ERR_NO_PATH 6
514 #define READ_GITFILE_ERR_NOT_A_REPO 7
515 #define READ_GITFILE_ERR_TOO_LARGE 8
516 extern void read_gitfile_error_die(int error_code, const char *path, const char *dir);
517 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
518 #define read_gitfile(path) read_gitfile_gently((path), NULL)
519 extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
520 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
522 extern void set_git_work_tree(const char *tree);
524 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
526 extern void setup_work_tree(void);
528 * Find GIT_DIR of the repository that contains the current working directory,
529 * without changing the working directory or other global state. The result is
530 * appended to gitdir. The return value is either NULL if no repository was
531 * found, or pointing to the path inside gitdir's buffer.
533 extern const char *discover_git_directory(struct strbuf *gitdir);
534 extern const char *setup_git_directory_gently(int *);
535 extern const char *setup_git_directory(void);
536 extern char *prefix_path(const char *prefix, int len, const char *path);
537 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
540 * Concatenate "prefix" (if len is non-zero) and "path", with no
541 * connecting characters (so "prefix" should end with a "/").
542 * Unlike prefix_path, this should be used if the named file does
543 * not have to interact with index entry; i.e. name of a random file
546 * The return value is always a newly allocated string (even if the
549 extern char *prefix_filename(const char *prefix, const char *path);
551 extern int check_filename(const char *prefix, const char *name);
552 extern void verify_filename(const char *prefix,
554 int diagnose_misspelt_rev);
555 extern void verify_non_filename(const char *prefix, const char *name);
556 extern int path_inside_repo(const char *prefix, const char *path);
558 #define INIT_DB_QUIET 0x0001
559 #define INIT_DB_EXIST_OK 0x0002
561 extern int init_db(const char *git_dir, const char *real_git_dir,
562 const char *template_dir, unsigned int flags);
564 extern void sanitize_stdfds(void);
565 extern int daemonize(void);
567 #define alloc_nr(x) (((x)+16)*3/2)
570 * Realloc the buffer pointed at by variable 'x' so that it can hold
571 * at least 'nr' entries; the number of entries currently allocated
572 * is 'alloc', using the standard growing factor alloc_nr() macro.
574 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
576 #define ALLOC_GROW(x, nr, alloc) \
578 if ((nr) > alloc) { \
579 if (alloc_nr(alloc) < (nr)) \
582 alloc = alloc_nr(alloc); \
583 REALLOC_ARRAY(x, alloc); \
587 /* Initialize and use the cache information */
589 extern int read_index(struct index_state *);
590 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
591 extern int do_read_index(struct index_state *istate, const char *path,
592 int must_exist); /* for testting only! */
593 extern int read_index_from(struct index_state *, const char *path);
594 extern int is_index_unborn(struct index_state *);
595 extern int read_index_unmerged(struct index_state *);
596 #define COMMIT_LOCK (1 << 0)
597 #define CLOSE_LOCK (1 << 1)
598 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
599 extern int discard_index(struct index_state *);
600 extern void move_index_extensions(struct index_state *dst, struct index_state *src);
601 extern int unmerged_index(const struct index_state *);
602 extern int verify_path(const char *path);
603 extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change);
604 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
605 extern void adjust_dirname_case(struct index_state *istate, char *name);
606 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
609 * Searches for an entry defined by name and namelen in the given index.
610 * If the return value is positive (including 0) it is the position of an
611 * exact match. If the return value is negative, the negated value minus 1
612 * is the position where the entry would be inserted.
613 * Example: The current index consists of these files and its stages:
617 * index_name_pos(&index, "a", 1) -> -1
618 * index_name_pos(&index, "b", 1) -> 0
619 * index_name_pos(&index, "c", 1) -> -2
620 * index_name_pos(&index, "d", 1) -> 1
621 * index_name_pos(&index, "e", 1) -> -3
622 * index_name_pos(&index, "f", 1) -> -3
623 * index_name_pos(&index, "g", 1) -> -5
625 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
627 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
628 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
629 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
630 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
631 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
632 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
633 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
634 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
636 /* Remove entry, return true if there are more entries to go. */
637 extern int remove_index_entry_at(struct index_state *, int pos);
639 extern void remove_marked_cache_entries(struct index_state *istate);
640 extern int remove_file_from_index(struct index_state *, const char *path);
641 #define ADD_CACHE_VERBOSE 1
642 #define ADD_CACHE_PRETEND 2
643 #define ADD_CACHE_IGNORE_ERRORS 4
644 #define ADD_CACHE_IGNORE_REMOVAL 8
645 #define ADD_CACHE_INTENT 16
647 * These two are used to add the contents of the file at path
648 * to the index, marking the working tree up-to-date by storing
649 * the cached stat info in the resulting cache entry. A caller
650 * that has already run lstat(2) on the path can call
651 * add_to_index(), and all others can call add_file_to_index();
652 * the latter will do necessary lstat(2) internally before
653 * calling the former.
655 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
656 extern int add_file_to_index(struct index_state *, const char *path, int flags);
658 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
659 extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
660 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
661 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
662 extern int index_name_is_other(const struct index_state *, const char *, int);
663 extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
665 /* do stat comparison even if CE_VALID is true */
666 #define CE_MATCH_IGNORE_VALID 01
667 /* do not check the contents but report dirty on racily-clean entries */
668 #define CE_MATCH_RACY_IS_DIRTY 02
669 /* do stat comparison even if CE_SKIP_WORKTREE is true */
670 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
671 /* ignore non-existent files during stat update */
672 #define CE_MATCH_IGNORE_MISSING 0x08
673 /* enable stat refresh */
674 #define CE_MATCH_REFRESH 0x10
675 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
676 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
678 #define HASH_WRITE_OBJECT 1
679 #define HASH_FORMAT_CHECK 2
680 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
681 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
684 * Record to sd the data from st that we use to check whether a file
685 * might have changed.
687 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
690 * Return 0 if st is consistent with a file not having been changed
691 * since sd was filled. If there are differences, return a
692 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
693 * INODE_CHANGED, and DATA_CHANGED.
695 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
696 extern int match_stat_data_racy(const struct index_state *istate,
697 const struct stat_data *sd, struct stat *st);
699 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
701 #define REFRESH_REALLY 0x0001 /* ignore_valid */
702 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
703 #define REFRESH_QUIET 0x0004 /* be quiet about it */
704 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
705 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
706 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
707 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
708 extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
710 extern void update_index_if_able(struct index_state *, struct lock_file *);
712 extern int hold_locked_index(struct lock_file *, int);
713 extern void set_alternate_index_output(const char *);
715 extern int verify_index_checksum;
717 /* Environment bits from configuration mechanism */
718 extern int trust_executable_bit;
719 extern int trust_ctime;
720 extern int check_stat;
721 extern int quote_path_fully;
722 extern int has_symlinks;
723 extern int minimum_abbrev, default_abbrev;
724 extern int ignore_case;
725 extern int assume_unchanged;
726 extern int prefer_symlink_refs;
727 extern int warn_ambiguous_refs;
728 extern int warn_on_object_refname_ambiguity;
729 extern const char *apply_default_whitespace;
730 extern const char *apply_default_ignorewhitespace;
731 extern const char *git_attributes_file;
732 extern const char *git_hooks_path;
733 extern int zlib_compression_level;
734 extern int core_compression_level;
735 extern int pack_compression_level;
736 extern size_t packed_git_window_size;
737 extern size_t packed_git_limit;
738 extern size_t delta_base_cache_limit;
739 extern unsigned long big_file_threshold;
740 extern unsigned long pack_size_limit_cfg;
743 * Accessors for the core.sharedrepository config which lazy-load the value
744 * from the config (if not already set). The "reset" function can be
745 * used to unset "set" or cached value, meaning that the value will be loaded
746 * fresh from the config file on the next call to get_shared_repository().
748 void set_shared_repository(int value);
749 int get_shared_repository(void);
750 void reset_shared_repository(void);
753 * Do replace refs need to be checked this run? This variable is
754 * initialized to true unless --no-replace-object is used or
755 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
756 * commands that do not want replace references to be active. As an
757 * optimization it is also set to false if replace references have
758 * been sought but there were none.
760 extern int check_replace_refs;
761 extern char *git_replace_ref_base;
763 extern int fsync_object_files;
764 extern int core_preload_index;
765 extern int core_apply_sparse_checkout;
766 extern int precomposed_unicode;
767 extern int protect_hfs;
768 extern int protect_ntfs;
769 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
772 * Include broken refs in all ref iterations, which will
773 * generally choke dangerous operations rather than letting
774 * them silently proceed without taking the broken ref into
777 extern int ref_paranoia;
780 * The character that begins a commented line in user-editable file
781 * that is subject to stripspace.
783 extern char comment_line_char;
784 extern int auto_comment_line_char;
787 enum hide_dotfiles_type {
788 HIDE_DOTFILES_FALSE = 0,
790 HIDE_DOTFILES_DOTGITONLY
792 extern enum hide_dotfiles_type hide_dotfiles;
794 enum log_refs_config {
800 extern enum log_refs_config log_all_ref_updates;
803 BRANCH_TRACK_UNSPECIFIED = -1,
804 BRANCH_TRACK_NEVER = 0,
807 BRANCH_TRACK_EXPLICIT,
808 BRANCH_TRACK_OVERRIDE
811 enum rebase_setup_type {
812 AUTOREBASE_NEVER = 0,
818 enum push_default_type {
819 PUSH_DEFAULT_NOTHING = 0,
820 PUSH_DEFAULT_MATCHING,
822 PUSH_DEFAULT_UPSTREAM,
823 PUSH_DEFAULT_CURRENT,
824 PUSH_DEFAULT_UNSPECIFIED
827 extern enum branch_track git_branch_track;
828 extern enum rebase_setup_type autorebase;
829 extern enum push_default_type push_default;
831 enum object_creation_mode {
832 OBJECT_CREATION_USES_HARDLINKS = 0,
833 OBJECT_CREATION_USES_RENAMES = 1
836 extern enum object_creation_mode object_creation_mode;
838 extern char *notes_ref_name;
840 extern int grafts_replace_parents;
843 * GIT_REPO_VERSION is the version we write by default. The
844 * _READ variant is the highest number we know how to
847 #define GIT_REPO_VERSION 0
848 #define GIT_REPO_VERSION_READ 1
849 extern int repository_format_precious_objects;
851 struct repository_format {
853 int precious_objects;
856 struct string_list unknown_extensions;
860 * Read the repository format characteristics from the config file "path" into
861 * "format" struct. Returns the numeric version. On error, -1 is returned,
862 * format->version is set to -1, and all other fields in the struct are
865 int read_repository_format(struct repository_format *format, const char *path);
868 * Verify that the repository described by repository_format is something we
869 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
870 * any errors encountered.
872 int verify_repository_format(const struct repository_format *format,
876 * Check the repository format version in the path found in get_git_dir(),
877 * and die if it is a version we don't understand. Generally one would
878 * set_git_dir() before calling this, and use it only for "are we in a valid
881 extern void check_repository_format(void);
883 #define MTIME_CHANGED 0x0001
884 #define CTIME_CHANGED 0x0002
885 #define OWNER_CHANGED 0x0004
886 #define MODE_CHANGED 0x0008
887 #define INODE_CHANGED 0x0010
888 #define DATA_CHANGED 0x0020
889 #define TYPE_CHANGED 0x0040
892 * Return a statically allocated filename, either generically (mkpath), in
893 * the repository directory (git_path), or in a submodule's repository
894 * directory (git_path_submodule). In all cases, note that the result
895 * may be overwritten by another call to _any_ of the functions. Consider
896 * using the safer "dup" or "strbuf" formats below (in some cases, the
897 * unsafe versions have already been removed).
899 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
900 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
901 extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
903 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
904 __attribute__((format (printf, 3, 4)));
905 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
906 __attribute__((format (printf, 2, 3)));
907 extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...)
908 __attribute__((format (printf, 2, 3)));
909 extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
910 __attribute__((format (printf, 2, 3)));
911 extern int strbuf_git_path_submodule(struct strbuf *sb, const char *path,
912 const char *fmt, ...)
913 __attribute__((format (printf, 3, 4)));
914 extern char *git_pathdup(const char *fmt, ...)
915 __attribute__((format (printf, 1, 2)));
916 extern char *mkpathdup(const char *fmt, ...)
917 __attribute__((format (printf, 1, 2)));
918 extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
919 __attribute__((format (printf, 2, 3)));
921 extern void report_linked_checkout_garbage(void);
924 * You can define a static memoized git path like:
926 * static GIT_PATH_FUNC(git_path_foo, "FOO");
928 * or use one of the global ones below.
930 #define GIT_PATH_FUNC(func, filename) \
931 const char *func(void) \
935 ret = git_pathdup(filename); \
939 const char *git_path_cherry_pick_head(void);
940 const char *git_path_revert_head(void);
941 const char *git_path_squash_msg(void);
942 const char *git_path_merge_msg(void);
943 const char *git_path_merge_rr(void);
944 const char *git_path_merge_mode(void);
945 const char *git_path_merge_head(void);
946 const char *git_path_fetch_head(void);
947 const char *git_path_shallow(void);
950 * Return the name of the file in the local object database that would
951 * be used to store a loose object with the specified sha1. The
952 * return value is a pointer to a statically allocated buffer that is
953 * overwritten each time the function is called.
955 extern const char *sha1_file_name(const unsigned char *sha1);
958 * Return the name of the (local) packfile with the specified sha1 in
959 * its name. The return value is a pointer to memory that is
960 * overwritten each time this function is called.
962 extern char *sha1_pack_name(const unsigned char *sha1);
965 * Return the name of the (local) pack index file with the specified
966 * sha1 in its name. The return value is a pointer to memory that is
967 * overwritten each time this function is called.
969 extern char *sha1_pack_index_name(const unsigned char *sha1);
972 * Return an abbreviated sha1 unique within this repository's object database.
973 * The result will be at least `len` characters long, and will be NUL
976 * The non-`_r` version returns a static buffer which remains valid until 4
977 * more calls to find_unique_abbrev are made.
979 * The `_r` variant writes to a buffer supplied by the caller, which must be at
980 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
981 * written (excluding the NUL terminator).
983 * Note that while this version avoids the static buffer, it is not fully
984 * reentrant, as it calls into other non-reentrant git code.
986 extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
987 extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
989 extern const unsigned char null_sha1[GIT_MAX_RAWSZ];
990 extern const struct object_id null_oid;
992 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
996 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
998 return *sha1 - *sha2;
1004 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
1006 return hashcmp(oid1->hash, oid2->hash);
1009 static inline int is_null_sha1(const unsigned char *sha1)
1011 return !hashcmp(sha1, null_sha1);
1014 static inline int is_null_oid(const struct object_id *oid)
1016 return !hashcmp(oid->hash, null_sha1);
1019 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
1021 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
1024 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
1026 hashcpy(dst->hash, src->hash);
1029 static inline struct object_id *oiddup(const struct object_id *src)
1031 struct object_id *dst = xmalloc(sizeof(struct object_id));
1036 static inline void hashclr(unsigned char *hash)
1038 memset(hash, 0, GIT_SHA1_RAWSZ);
1041 static inline void oidclr(struct object_id *oid)
1047 #define EMPTY_TREE_SHA1_HEX \
1048 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
1049 #define EMPTY_TREE_SHA1_BIN_LITERAL \
1050 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
1051 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
1052 extern const struct object_id empty_tree_oid;
1053 #define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)
1055 #define EMPTY_BLOB_SHA1_HEX \
1056 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
1057 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
1058 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
1059 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
1060 extern const struct object_id empty_blob_oid;
1061 #define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)
1064 static inline int is_empty_blob_sha1(const unsigned char *sha1)
1066 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
1069 static inline int is_empty_blob_oid(const struct object_id *oid)
1071 return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);
1074 static inline int is_empty_tree_sha1(const unsigned char *sha1)
1076 return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN);
1079 static inline int is_empty_tree_oid(const struct object_id *oid)
1081 return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);
1084 /* set default permissions by passing mode arguments to open(2) */
1085 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1086 int git_mkstemp_mode(char *pattern, int mode);
1091 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1092 * not be changed. Old repositories have core.sharedrepository written in
1093 * numeric format, and therefore these values are preserved for compatibility
1099 OLD_PERM_EVERYBODY = 2,
1101 PERM_EVERYBODY = 0664
1103 int git_config_perm(const char *var, const char *value);
1104 int adjust_shared_perm(const char *path);
1107 * Create the directory containing the named path, using care to be
1108 * somewhat safe against races. Return one of the scld_error values to
1109 * indicate success/failure. On error, set errno to describe the
1112 * SCLD_VANISHED indicates that one of the ancestor directories of the
1113 * path existed at one point during the function call and then
1114 * suddenly vanished, probably because another process pruned the
1115 * directory while we were working. To be robust against this kind of
1116 * race, callers might want to try invoking the function again when it
1117 * returns SCLD_VANISHED.
1119 * safe_create_leading_directories() temporarily changes path while it
1120 * is working but restores it before returning.
1121 * safe_create_leading_directories_const() doesn't modify path, even
1131 enum scld_error safe_create_leading_directories(char *path);
1132 enum scld_error safe_create_leading_directories_const(const char *path);
1135 * Callback function for raceproof_create_file(). This function is
1136 * expected to do something that makes dirname(path) permanent despite
1137 * the fact that other processes might be cleaning up empty
1138 * directories at the same time. Usually it will create a file named
1139 * path, but alternatively it could create another file in that
1140 * directory, or even chdir() into that directory. The function should
1141 * return 0 if the action was completed successfully. On error, it
1142 * should return a nonzero result and set errno.
1143 * raceproof_create_file() treats two errno values specially:
1145 * - ENOENT -- dirname(path) does not exist. In this case,
1146 * raceproof_create_file() tries creating dirname(path)
1147 * (and any parent directories, if necessary) and calls
1148 * the function again.
1150 * - EISDIR -- the file already exists and is a directory. In this
1151 * case, raceproof_create_file() removes the directory if
1152 * it is empty (and recursively any empty directories that
1153 * it contains) and calls the function again.
1155 * Any other errno causes raceproof_create_file() to fail with the
1156 * callback's return value and errno.
1158 * Obviously, this function should be OK with being called again if it
1159 * fails with ENOENT or EISDIR. In other scenarios it will not be
1162 typedef int create_file_fn(const char *path, void *cb);
1165 * Create a file in dirname(path) by calling fn, creating leading
1166 * directories if necessary. Retry a few times in case we are racing
1167 * with another process that is trying to clean up the directory that
1168 * contains path. See the documentation for create_file_fn for more
1171 * Return the value and set the errno that resulted from the most
1172 * recent call of fn. fn is always called at least once, and will be
1173 * called more than once if it returns ENOENT or EISDIR.
1175 int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
1177 int mkdir_in_gitdir(const char *path);
1178 extern char *expand_user_path(const char *path, int real_home);
1179 const char *enter_repo(const char *path, int strict);
1180 static inline int is_absolute_path(const char *path)
1182 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
1184 int is_directory(const char *);
1185 char *strbuf_realpath(struct strbuf *resolved, const char *path,
1187 const char *real_path(const char *path);
1188 const char *real_path_if_valid(const char *path);
1189 char *real_pathdup(const char *path, int die_on_error);
1190 const char *absolute_path(const char *path);
1191 char *absolute_pathdup(const char *path);
1192 const char *remove_leading_path(const char *in, const char *prefix);
1193 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
1194 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
1195 int normalize_path_copy(char *dst, const char *src);
1196 int longest_ancestor_length(const char *path, struct string_list *prefixes);
1197 char *strip_path_suffix(const char *path, const char *suffix);
1198 int daemon_avoid_alias(const char *path);
1199 extern int is_ntfs_dotgit(const char *name);
1202 * Return a newly allocated string with the evaluation of
1203 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1204 * "$HOME/.config/git/$filename". Return NULL upon error.
1206 extern char *xdg_config_home(const char *filename);
1209 * Return a newly allocated string with the evaluation of
1210 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1211 * "$HOME/.cache/git/$filename". Return NULL upon error.
1213 extern char *xdg_cache_home(const char *filename);
1215 /* object replacement */
1216 #define LOOKUP_REPLACE_OBJECT 1
1217 #define LOOKUP_UNKNOWN_OBJECT 2
1218 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
1219 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1221 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
1225 * This internal function is only declared here for the benefit of
1226 * lookup_replace_object(). Please do not call it directly.
1228 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1231 * If object sha1 should be replaced, return the replacement object's
1232 * name (replaced recursively, if necessary). The return value is
1233 * either sha1 or a pointer to a permanently-allocated value. When
1234 * object replacement is suppressed, always return sha1.
1236 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1238 if (!check_replace_refs)
1240 return do_lookup_replace_object(sha1);
1243 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1245 if (!(flag & LOOKUP_REPLACE_OBJECT))
1247 return lookup_replace_object(sha1);
1250 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1251 extern int sha1_object_info(const unsigned char *, unsigned long *);
1252 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1253 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1254 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
1255 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1256 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1257 extern int git_open_cloexec(const char *name, int flags);
1258 #define git_open(name) git_open_cloexec(name, O_RDONLY)
1259 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1260 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1261 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1263 /* global flag to enable extra checks when accessing packed objects */
1264 extern int do_check_packed_object_crc;
1266 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1268 extern int finalize_object_file(const char *tmpfile, const char *filename);
1270 extern int has_sha1_pack(const unsigned char *sha1);
1273 * Open the loose object at path, check its sha1, and return the contents,
1274 * type, and size. If the object is a blob, then "contents" may return NULL,
1275 * to allow streaming of large blobs.
1277 * Returns 0 on success, negative on error (details may be written to stderr).
1279 int read_loose_object(const char *path,
1280 const unsigned char *expected_sha1,
1281 enum object_type *type,
1282 unsigned long *size,
1286 * Return true iff we have an object named sha1, whether local or in
1287 * an alternate object database, and whether packed or loose. This
1288 * function does not respect replace references.
1290 * If the QUICK flag is set, do not re-check the pack directory
1291 * when we cannot find the object (this means we may give a false
1292 * negative answer if another process is simultaneously repacking).
1294 #define HAS_SHA1_QUICK 0x1
1295 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1296 static inline int has_sha1_file(const unsigned char *sha1)
1298 return has_sha1_file_with_flags(sha1, 0);
1301 /* Same as the above, except for struct object_id. */
1302 extern int has_object_file(const struct object_id *oid);
1303 extern int has_object_file_with_flags(const struct object_id *oid, int flags);
1306 * Return true iff an alternate object database has a loose object
1307 * with the specified name. This function does not respect replace
1310 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1312 extern int has_pack_index(const unsigned char *sha1);
1314 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1316 /* Helper to check and "touch" a file */
1317 extern int check_and_freshen_file(const char *fn, int freshen);
1319 extern const signed char hexval_table[256];
1320 static inline unsigned int hexval(unsigned char c)
1322 return hexval_table[c];
1326 * Convert two consecutive hexadecimal digits into a char. Return a
1327 * negative value on error. Don't run over the end of short strings.
1329 static inline int hex2chr(const char *s)
1331 int val = hexval(s[0]);
1332 return (val < 0) ? val : (val << 4) | hexval(s[1]);
1335 /* Convert to/from hex/sha1 representation */
1336 #define MINIMUM_ABBREV minimum_abbrev
1337 #define DEFAULT_ABBREV default_abbrev
1339 /* used when the code does not know or care what the default abbrev is */
1340 #define FALLBACK_DEFAULT_ABBREV 7
1342 struct object_context {
1343 unsigned char tree[20];
1346 * symlink_path is only used by get_tree_entry_follow_symlinks,
1347 * and only for symlinks that point outside the repository.
1349 struct strbuf symlink_path;
1351 * If GET_SHA1_RECORD_PATH is set, this will record path (if any)
1352 * found when resolving the name. The caller is responsible for
1353 * releasing the memory.
1358 #define GET_SHA1_QUIETLY 01
1359 #define GET_SHA1_COMMIT 02
1360 #define GET_SHA1_COMMITTISH 04
1361 #define GET_SHA1_TREE 010
1362 #define GET_SHA1_TREEISH 020
1363 #define GET_SHA1_BLOB 040
1364 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1365 #define GET_SHA1_RECORD_PATH 0200
1366 #define GET_SHA1_ONLY_TO_DIE 04000
1368 #define GET_SHA1_DISAMBIGUATORS \
1369 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \
1370 GET_SHA1_TREE | GET_SHA1_TREEISH | \
1373 extern int get_sha1(const char *str, unsigned char *sha1);
1374 extern int get_sha1_commit(const char *str, unsigned char *sha1);
1375 extern int get_sha1_committish(const char *str, unsigned char *sha1);
1376 extern int get_sha1_tree(const char *str, unsigned char *sha1);
1377 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1378 extern int get_sha1_blob(const char *str, unsigned char *sha1);
1379 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1380 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *oc);
1382 extern int get_oid(const char *str, struct object_id *oid);
1384 typedef int each_abbrev_fn(const struct object_id *oid, void *);
1385 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1387 extern int set_disambiguate_hint_config(const char *var, const char *value);
1390 * Try to read a SHA1 in hexadecimal format from the 40 characters
1391 * starting at hex. Write the 20-byte result to sha1 in binary form.
1392 * Return 0 on success. Reading stops if a NUL is encountered in the
1393 * input, so it is safe to pass this function an arbitrary
1394 * null-terminated string.
1396 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1397 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1400 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1401 * and writes the NUL-terminated output to the buffer `out`, which must be at
1402 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1405 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1406 * buffers, making it safe to make multiple calls for a single statement, like:
1408 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1410 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1411 extern char *oid_to_hex_r(char *out, const struct object_id *oid);
1412 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1413 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1416 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1417 * pointer specified by end when parsing stops. The resulting object ID is
1418 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1419 * other invalid character. end is only updated on success; otherwise, it is
1422 extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
1425 * This reads short-hand syntax that not only evaluates to a commit
1426 * object name, but also can act as if the end user spelled the name
1427 * of the branch from the command line.
1429 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1430 * places the name of the branch in the given buf and returns the
1431 * number of characters parsed if successful.
1433 * - "<branch>@{upstream}" finds the name of the other ref that
1434 * <branch> is configured to merge with (missing <branch> defaults
1435 * to the current branch), and places the name of the branch in the
1436 * given buf and returns the number of characters parsed if
1439 * If the input is not of the accepted format, it returns a negative
1440 * number to signal an error.
1442 * If the input was ok but there are not N branch switches in the
1443 * reflog, it returns 0.
1445 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1446 * expansions: local branches ("refs/heads/"), remote branches
1447 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1448 * allowed, even ones to refs outside of those namespaces.
1450 #define INTERPRET_BRANCH_LOCAL (1<<0)
1451 #define INTERPRET_BRANCH_REMOTE (1<<1)
1452 #define INTERPRET_BRANCH_HEAD (1<<2)
1453 extern int interpret_branch_name(const char *str, int len, struct strbuf *,
1455 extern int get_oid_mb(const char *str, struct object_id *oid);
1457 extern int validate_headref(const char *ref);
1459 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1460 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1461 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1462 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1464 extern void *read_object_with_reference(const unsigned char *sha1,
1465 const char *required_type,
1466 unsigned long *size,
1467 unsigned char *sha1_ret);
1469 extern struct object *peel_to_type(const char *name, int namelen,
1470 struct object *o, enum object_type);
1473 enum date_mode_type {
1478 DATE_ISO8601_STRICT,
1484 const char *strftime_fmt;
1489 * Convenience helper for passing a constant type, like:
1491 * show_date(t, tz, DATE_MODE(NORMAL));
1493 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1494 struct date_mode *date_mode_from_type(enum date_mode_type type);
1496 const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);
1497 void show_date_relative(timestamp_t time, int tz, const struct timeval *now,
1498 struct strbuf *timebuf);
1499 int parse_date(const char *date, struct strbuf *out);
1500 int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);
1501 int parse_expiry_date(const char *date, timestamp_t *timestamp);
1502 void datestamp(struct strbuf *out);
1503 #define approxidate(s) approxidate_careful((s), NULL)
1504 timestamp_t approxidate_careful(const char *, int *);
1505 timestamp_t approxidate_relative(const char *date, const struct timeval *now);
1506 void parse_date_format(const char *format, struct date_mode *mode);
1507 int date_overflows(timestamp_t date);
1509 #define IDENT_STRICT 1
1510 #define IDENT_NO_DATE 2
1511 #define IDENT_NO_NAME 4
1512 extern const char *git_author_info(int);
1513 extern const char *git_committer_info(int);
1514 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1515 extern const char *fmt_name(const char *name, const char *email);
1516 extern const char *ident_default_name(void);
1517 extern const char *ident_default_email(void);
1518 extern const char *git_editor(void);
1519 extern const char *git_pager(int stdout_is_tty);
1520 extern int git_ident_config(const char *, const char *, void *);
1521 extern void reset_ident_date(void);
1523 struct ident_split {
1524 const char *name_begin;
1525 const char *name_end;
1526 const char *mail_begin;
1527 const char *mail_end;
1528 const char *date_begin;
1529 const char *date_end;
1530 const char *tz_begin;
1534 * Signals an success with 0, but time part of the result may be NULL
1535 * if the input lacks timestamp and zone
1537 extern int split_ident_line(struct ident_split *, const char *, int);
1540 * Like show_date, but pull the timestamp and tz parameters from
1541 * the ident_split. It will also sanity-check the values and produce
1542 * a well-known sentinel date if they appear bogus.
1544 const char *show_ident_date(const struct ident_split *id,
1545 const struct date_mode *mode);
1548 * Compare split idents for equality or strict ordering. Note that we
1549 * compare only the ident part of the line, ignoring any timestamp.
1551 * Because there are two fields, we must choose one as the primary key; we
1552 * currently arbitrarily pick the email.
1554 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1557 struct index_state *istate;
1558 const char *base_dir;
1565 #define CHECKOUT_INIT { NULL, "" }
1567 #define TEMPORARY_FILENAME_LENGTH 25
1568 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1574 int prefix_len_stat_func;
1576 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1577 static inline void cache_def_clear(struct cache_def *cache)
1579 strbuf_release(&cache->path);
1582 extern int has_symlink_leading_path(const char *name, int len);
1583 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1584 extern int check_leading_path(const char *name, int len);
1585 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1586 extern void schedule_dir_for_removal(const char *name, int len);
1587 extern void remove_scheduled_dirs(void);
1589 extern struct alternate_object_database {
1590 struct alternate_object_database *next;
1592 /* see alt_scratch_buf() */
1593 struct strbuf scratch;
1596 char path[FLEX_ARRAY];
1598 extern void prepare_alt_odb(void);
1599 extern void read_info_alternates(const char * relative_base, int depth);
1600 extern char *compute_alternate_path(const char *path, struct strbuf *err);
1601 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1602 extern int foreach_alt_odb(alt_odb_fn, void*);
1605 * Allocate a "struct alternate_object_database" but do _not_ actually
1606 * add it to the list of alternates.
1608 struct alternate_object_database *alloc_alt_odb(const char *dir);
1611 * Add the directory to the on-disk alternates file; the new entry will also
1612 * take effect in the current process.
1614 extern void add_to_alternates_file(const char *dir);
1617 * Add the directory to the in-memory list of alternates (along with any
1618 * recursive alternates it points to), but do not modify the on-disk alternates
1621 extern void add_to_alternates_memory(const char *dir);
1624 * Returns a scratch strbuf pre-filled with the alternate object directory,
1625 * including a trailing slash, which can be used to access paths in the
1626 * alternate. Always use this over direct access to alt->scratch, as it
1627 * cleans up any previous use of the scratch buffer.
1629 extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
1631 struct pack_window {
1632 struct pack_window *next;
1633 unsigned char *base;
1636 unsigned int last_used;
1637 unsigned int inuse_cnt;
1640 extern struct packed_git {
1641 struct packed_git *next;
1642 struct pack_window *windows;
1644 const void *index_data;
1646 uint32_t num_objects;
1647 uint32_t num_bad_objects;
1648 unsigned char *bad_object_sha1;
1652 unsigned pack_local:1,
1656 unsigned char sha1[20];
1657 struct revindex_entry *revindex;
1658 /* something like ".git/objects/pack/xxxxx.pack" */
1659 char pack_name[FLEX_ARRAY]; /* more */
1663 * A most-recently-used ordered version of the packed_git list, which can
1664 * be iterated instead of packed_git (and marked via mru_mark).
1667 extern struct mru *packed_git_mru;
1671 unsigned char sha1[20];
1672 struct packed_git *p;
1675 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1677 /* A hook to report invalid files in pack directory */
1678 #define PACKDIR_FILE_PACK 1
1679 #define PACKDIR_FILE_IDX 2
1680 #define PACKDIR_FILE_GARBAGE 4
1681 extern void (*report_garbage)(unsigned seen_bits, const char *path);
1683 extern void prepare_packed_git(void);
1684 extern void reprepare_packed_git(void);
1685 extern void install_packed_git(struct packed_git *pack);
1688 * Give a rough count of objects in the repository. This sacrifices accuracy
1691 unsigned long approximate_object_count(void);
1693 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1694 struct packed_git *packs);
1696 extern void pack_report(void);
1699 * Create a temporary file rooted in the object database directory, or
1700 * die on failure. The filename is taken from "pattern", which should have the
1701 * usual "XXXXXX" trailer, and the resulting filename is written into the
1702 * "template" buffer. Returns the open descriptor.
1704 extern int odb_mkstemp(struct strbuf *template, const char *pattern);
1707 * Generate the filename to be used for a pack file with checksum "sha1" and
1708 * extension "ext". The result is written into the strbuf "buf", overwriting
1709 * any existing contents. A pointer to buf->buf is returned as a convenience.
1711 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"
1713 extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);
1716 * Create a pack .keep file named "name" (which should generally be the output
1717 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1720 extern int odb_pack_keep(const char *name);
1723 * mmap the index file for the specified packfile (if it is not
1724 * already mmapped). Return 0 on success.
1726 extern int open_pack_index(struct packed_git *);
1729 * munmap the index file for the specified packfile (if it is
1730 * currently mmapped).
1732 extern void close_pack_index(struct packed_git *);
1734 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1735 extern void close_pack_windows(struct packed_git *);
1736 extern void close_all_packs(void);
1737 extern void unuse_pack(struct pack_window **);
1738 extern void clear_delta_base_cache(void);
1739 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
1742 * Make sure that a pointer access into an mmap'd index file is within bounds,
1743 * and can provide at least 8 bytes of data.
1745 * Note that this is only necessary for variable-length segments of the file
1746 * (like the 64-bit extended offset table), as we compare the size to the
1747 * fixed-length parts when we open the file.
1749 extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
1752 * Return the SHA-1 of the nth object within the specified packfile.
1753 * Open the index if it is not already open. The return value points
1754 * at the SHA-1 within the mmapped index. Return NULL if there is an
1757 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1759 * Like nth_packed_object_sha1, but write the data into the object specified by
1760 * the the first argument. Returns the first argument on success, and NULL on
1763 extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
1766 * Return the offset of the nth object within the specified packfile.
1767 * The index must already be opened.
1769 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1772 * If the object named sha1 is present in the specified packfile,
1773 * return its offset within the packfile; otherwise, return 0.
1775 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1777 extern int is_pack_valid(struct packed_git *);
1778 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1779 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1780 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1781 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1784 * Iterate over the files in the loose-object parts of the object
1785 * directory "path", triggering the following callbacks:
1787 * - loose_object is called for each loose object we find.
1789 * - loose_cruft is called for any files that do not appear to be
1790 * loose objects. Note that we only look in the loose object
1791 * directories "objects/[0-9a-f]{2}/", so we will not report
1792 * "objects/foobar" as cruft.
1794 * - loose_subdir is called for each top-level hashed subdirectory
1795 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1796 * after the objects in the directory are processed.
1798 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1799 * will end the iteration.
1801 * In the "buf" variant, "path" is a strbuf which will also be used as a
1802 * scratch buffer, but restored to its original contents before
1803 * the function returns.
1805 typedef int each_loose_object_fn(const struct object_id *oid,
1808 typedef int each_loose_cruft_fn(const char *basename,
1811 typedef int each_loose_subdir_fn(int nr,
1814 int for_each_loose_file_in_objdir(const char *path,
1815 each_loose_object_fn obj_cb,
1816 each_loose_cruft_fn cruft_cb,
1817 each_loose_subdir_fn subdir_cb,
1819 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1820 each_loose_object_fn obj_cb,
1821 each_loose_cruft_fn cruft_cb,
1822 each_loose_subdir_fn subdir_cb,
1826 * Iterate over loose and packed objects in both the local
1827 * repository and any alternates repositories (unless the
1828 * LOCAL_ONLY flag is set).
1830 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1831 typedef int each_packed_object_fn(const struct object_id *oid,
1832 struct packed_git *pack,
1835 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1836 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1838 struct object_info {
1840 enum object_type *typep;
1841 unsigned long *sizep;
1843 unsigned char *delta_base_sha1;
1844 struct strbuf *typename;
1856 * ... Nothing to expose in this case
1859 * ... Nothing to expose in this case
1863 struct packed_git *pack;
1865 unsigned int is_delta;
1871 * Initializer for a "struct object_info" that wants no items. You may
1872 * also memset() the memory to all-zeroes.
1874 #define OBJECT_INFO_INIT {NULL}
1876 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1877 extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
1879 /* Dumb servers support */
1880 extern int update_server_info(int);
1882 /* git_config_parse_key() returns these negated: */
1883 #define CONFIG_INVALID_KEY 1
1884 #define CONFIG_NO_SECTION_OR_NAME 2
1885 /* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
1886 #define CONFIG_NO_LOCK -1
1887 #define CONFIG_INVALID_FILE 3
1888 #define CONFIG_NO_WRITE 4
1889 #define CONFIG_NOTHING_SET 5
1890 #define CONFIG_INVALID_PATTERN 6
1891 #define CONFIG_GENERIC_ERROR 7
1893 #define CONFIG_REGEX_NONE ((void *)1)
1895 struct git_config_source {
1896 unsigned int use_stdin:1;
1901 enum config_origin_type {
1904 CONFIG_ORIGIN_STDIN,
1905 CONFIG_ORIGIN_SUBMODULE_BLOB,
1906 CONFIG_ORIGIN_CMDLINE
1909 struct config_options {
1910 unsigned int respect_includes : 1;
1911 const char *git_dir;
1914 typedef int (*config_fn_t)(const char *, const char *, void *);
1915 extern int git_default_config(const char *, const char *, void *);
1916 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1917 extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,
1918 const char *name, const char *buf, size_t len, void *data);
1919 extern int git_config_from_blob_sha1(config_fn_t fn, const char *name,
1920 const unsigned char *sha1, void *data);
1921 extern void git_config_push_parameter(const char *text);
1922 extern int git_config_from_parameters(config_fn_t fn, void *data);
1923 extern void read_early_config(config_fn_t cb, void *data);
1924 extern void git_config(config_fn_t fn, void *);
1925 extern int git_config_with_options(config_fn_t fn, void *,
1926 struct git_config_source *config_source,
1927 const struct config_options *opts);
1928 extern int git_parse_ulong(const char *, unsigned long *);
1929 extern int git_parse_maybe_bool(const char *);
1930 extern int git_config_int(const char *, const char *);
1931 extern int64_t git_config_int64(const char *, const char *);
1932 extern unsigned long git_config_ulong(const char *, const char *);
1933 extern ssize_t git_config_ssize_t(const char *, const char *);
1934 extern int git_config_bool_or_int(const char *, const char *, int *);
1935 extern int git_config_bool(const char *, const char *);
1936 extern int git_config_maybe_bool(const char *, const char *);
1937 extern int git_config_string(const char **, const char *, const char *);
1938 extern int git_config_pathname(const char **, const char *, const char *);
1939 extern int git_config_set_in_file_gently(const char *, const char *, const char *);
1940 extern void git_config_set_in_file(const char *, const char *, const char *);
1941 extern int git_config_set_gently(const char *, const char *);
1942 extern void git_config_set(const char *, const char *);
1943 extern int git_config_parse_key(const char *, char **, int *);
1944 extern int git_config_key_is_valid(const char *key);
1945 extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
1946 extern void git_config_set_multivar(const char *, const char *, const char *, int);
1947 extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
1948 extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1949 extern int git_config_rename_section(const char *, const char *);
1950 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1951 extern const char *git_etc_gitconfig(void);
1952 extern int git_env_bool(const char *, int);
1953 extern unsigned long git_env_ulong(const char *, unsigned long);
1954 extern int git_config_system(void);
1955 extern int config_error_nonbool(const char *);
1956 #if defined(__GNUC__)
1957 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1959 extern const char *get_log_output_encoding(void);
1960 extern const char *get_commit_output_encoding(void);
1962 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1965 CONFIG_SCOPE_UNKNOWN = 0,
1966 CONFIG_SCOPE_SYSTEM,
1967 CONFIG_SCOPE_GLOBAL,
1969 CONFIG_SCOPE_CMDLINE,
1972 extern enum config_scope current_config_scope(void);
1973 extern const char *current_config_origin_type(void);
1974 extern const char *current_config_name(void);
1976 struct config_include_data {
1980 const struct config_options *opts;
1982 #define CONFIG_INCLUDE_INIT { 0 }
1983 extern int git_config_include(const char *name, const char *value, void *data);
1986 * Match and parse a config key of the form:
1988 * section.(subsection.)?key
1990 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1991 * we return -1 if it does not match, 0 otherwise. The subsection and key
1992 * out-parameters are filled by the function (and *subsection is NULL if it is
1995 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
1996 * there is no subsection at all.
1998 extern int parse_config_key(const char *var,
1999 const char *section,
2000 const char **subsection, int *subsection_len,
2003 struct config_set_element {
2004 struct hashmap_entry ent;
2006 struct string_list value_list;
2009 struct configset_list_item {
2010 struct config_set_element *e;
2015 * the contents of the list are ordered according to their
2016 * position in the config files and order of parsing the files.
2017 * (i.e. key-value pair at the last position of .git/config will
2018 * be at the last item of the list)
2020 struct configset_list {
2021 struct configset_list_item *items;
2022 unsigned int nr, alloc;
2026 struct hashmap config_hash;
2027 int hash_initialized;
2028 struct configset_list list;
2031 extern void git_configset_init(struct config_set *cs);
2032 extern int git_configset_add_file(struct config_set *cs, const char *filename);
2033 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
2034 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
2035 extern void git_configset_clear(struct config_set *cs);
2036 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
2037 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
2038 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
2039 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
2040 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
2041 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
2042 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
2043 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
2045 extern int git_config_get_value(const char *key, const char **value);
2046 extern const struct string_list *git_config_get_value_multi(const char *key);
2047 extern void git_config_clear(void);
2048 extern void git_config_iter(config_fn_t fn, void *data);
2049 extern int git_config_get_string_const(const char *key, const char **dest);
2050 extern int git_config_get_string(const char *key, char **dest);
2051 extern int git_config_get_int(const char *key, int *dest);
2052 extern int git_config_get_ulong(const char *key, unsigned long *dest);
2053 extern int git_config_get_bool(const char *key, int *dest);
2054 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
2055 extern int git_config_get_maybe_bool(const char *key, int *dest);
2056 extern int git_config_get_pathname(const char *key, const char **dest);
2057 extern int git_config_get_untracked_cache(void);
2058 extern int git_config_get_split_index(void);
2059 extern int git_config_get_max_percent_split_change(void);
2061 /* This dies if the configured or default date is in the future */
2062 extern int git_config_get_expiry(const char *key, const char **output);
2065 * This is a hack for test programs like test-dump-untracked-cache to
2066 * ensure that they do not modify the untracked cache when reading it.
2067 * Do not use it otherwise!
2069 extern int ignore_untracked_cache_config;
2071 struct key_value_info {
2072 const char *filename;
2074 enum config_origin_type origin_type;
2075 enum config_scope scope;
2078 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
2079 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
2081 extern int committer_ident_sufficiently_given(void);
2082 extern int author_ident_sufficiently_given(void);
2084 extern const char *git_commit_encoding;
2085 extern const char *git_log_output_encoding;
2086 extern const char *git_mailmap_file;
2087 extern const char *git_mailmap_blob;
2089 /* IO helper functions */
2090 extern void maybe_flush_or_die(FILE *, const char *);
2091 __attribute__((format (printf, 2, 3)))
2092 extern void fprintf_or_die(FILE *, const char *fmt, ...);
2094 #define COPY_READ_ERROR (-2)
2095 #define COPY_WRITE_ERROR (-3)
2096 extern int copy_fd(int ifd, int ofd);
2097 extern int copy_file(const char *dst, const char *src, int mode);
2098 extern int copy_file_with_time(const char *dst, const char *src, int mode);
2100 extern void write_or_die(int fd, const void *buf, size_t count);
2101 extern void fsync_or_die(int fd, const char *);
2103 extern ssize_t read_in_full(int fd, void *buf, size_t count);
2104 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
2105 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
2107 static inline ssize_t write_str_in_full(int fd, const char *str)
2109 return write_in_full(fd, str, strlen(str));
2113 * Open (and truncate) the file at path, write the contents of buf to it,
2114 * and close it. Dies if any errors are encountered.
2116 extern void write_file_buf(const char *path, const char *buf, size_t len);
2119 * Like write_file_buf(), but format the contents into a buffer first.
2120 * Additionally, write_file() will append a newline if one is not already
2121 * present, making it convenient to write text files:
2123 * write_file(path, "counter: %d", ctr);
2125 __attribute__((format (printf, 2, 3)))
2126 extern void write_file(const char *path, const char *fmt, ...);
2129 extern void setup_pager(void);
2130 extern int pager_in_use(void);
2131 extern int pager_use_color;
2132 extern int term_columns(void);
2133 extern int decimal_width(uintmax_t);
2134 extern int check_pager_config(const char *cmd);
2135 extern void prepare_pager_args(struct child_process *, const char *pager);
2137 extern const char *editor_program;
2138 extern const char *askpass_program;
2139 extern const char *excludes_file;
2142 int decode_85(char *dst, const char *line, int linelen);
2143 void encode_85(char *buf, const unsigned char *data, int bytes);
2146 extern void *alloc_blob_node(void);
2147 extern void *alloc_tree_node(void);
2148 extern void *alloc_commit_node(void);
2149 extern void *alloc_tag_node(void);
2150 extern void *alloc_object_node(void);
2151 extern void alloc_report(void);
2152 extern unsigned int alloc_commit_index(void);
2155 void packet_trace_identity(const char *prog);
2159 * return 0 if success, 1 - if addition of a file failed and
2160 * ADD_FILES_IGNORE_ERRORS was specified in flags
2162 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
2165 extern int diff_auto_refresh_index;
2168 void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
2169 void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
2173 * used by both diff and apply
2174 * last two digits are tab width
2176 #define WS_BLANK_AT_EOL 0100
2177 #define WS_SPACE_BEFORE_TAB 0200
2178 #define WS_INDENT_WITH_NON_TAB 0400
2179 #define WS_CR_AT_EOL 01000
2180 #define WS_BLANK_AT_EOF 02000
2181 #define WS_TAB_IN_INDENT 04000
2182 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
2183 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
2184 #define WS_TAB_WIDTH_MASK 077
2185 extern unsigned whitespace_rule_cfg;
2186 extern unsigned whitespace_rule(const char *);
2187 extern unsigned parse_whitespace_rule(const char *);
2188 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
2189 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
2190 extern char *whitespace_error_string(unsigned ws);
2191 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
2192 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
2193 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
2196 void overlay_tree_on_index(struct index_state *istate,
2197 const char *tree_name, const char *prefix);
2199 char *alias_lookup(const char *alias);
2200 int split_cmdline(char *cmdline, const char ***argv);
2201 /* Takes a negative value returned by split_cmdline */
2202 const char *split_cmdline_strerror(int cmdline_errno);
2205 struct startup_info {
2206 int have_repository;
2209 extern struct startup_info *startup_info;
2213 int try_merge_command(const char *strategy, size_t xopts_nr,
2214 const char **xopts, struct commit_list *common,
2215 const char *head_arg, struct commit_list *remotes);
2216 int checkout_fast_forward(const struct object_id *from,
2217 const struct object_id *to,
2218 int overwrite_ignore);
2221 int sane_execvp(const char *file, char *const argv[]);
2224 * A struct to encapsulate the concept of whether a file has changed
2225 * since we last checked it. This uses criteria similar to those used
2228 struct stat_validity {
2229 struct stat_data *sd;
2232 void stat_validity_clear(struct stat_validity *sv);
2235 * Returns 1 if the path is a regular file (or a symlink to a regular
2236 * file) and matches the saved stat_validity, 0 otherwise. A missing
2237 * or inaccessible file is considered a match if the struct was just
2238 * initialized, or if the previous update found an inaccessible file.
2240 int stat_validity_check(struct stat_validity *sv, const char *path);
2243 * Update the stat_validity from a file opened at descriptor fd. If
2244 * the file is missing, inaccessible, or not a regular file, then
2245 * future calls to stat_validity_check will match iff one of those
2246 * conditions continues to be true.
2248 void stat_validity_update(struct stat_validity *sv, int fd);
2250 int versioncmp(const char *s1, const char *s2);
2251 void sleep_millisec(int millisec);
2254 * Create a directory and (if share is nonzero) adjust its permissions
2255 * according to the shared_repository setting. Only use this for
2256 * directories under $GIT_DIR. Don't use it for working tree
2259 void safe_create_dir(const char *dir, int share);
2261 #endif /* CACHE_H */