4 #include "git-compat-util.h"
13 #include "string-list.h"
14 #include "pack-revindex.h"
17 #include "oid-array.h"
18 #include "repository.h"
22 typedef struct git_zstream {
24 unsigned long avail_in;
25 unsigned long avail_out;
26 unsigned long total_in;
27 unsigned long total_out;
28 unsigned char *next_in;
29 unsigned char *next_out;
32 void git_inflate_init(git_zstream *);
33 void git_inflate_init_gzip_only(git_zstream *);
34 void git_inflate_end(git_zstream *);
35 int git_inflate(git_zstream *, int flush);
37 void git_deflate_init(git_zstream *, int level);
38 void git_deflate_init_gzip(git_zstream *, int level);
39 void git_deflate_init_raw(git_zstream *, int level);
40 void git_deflate_end(git_zstream *);
41 int git_deflate_abort(git_zstream *);
42 int git_deflate_end_gently(git_zstream *);
43 int git_deflate(git_zstream *, int flush);
44 unsigned long git_deflate_bound(git_zstream *, unsigned long);
46 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
47 #define DTYPE(de) ((de)->d_type)
57 #define DTYPE(de) DT_UNKNOWN
60 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
61 #define S_IFINVALID 0030000
64 * A "directory link" is a link to another git directory.
66 * The value 0160000 is not normally a valid mode, and
67 * also just happens to be S_IFDIR + S_IFLNK
69 #define S_IFGITLINK 0160000
70 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
73 * Some mode bits are also used internally for computations.
75 * They *must* not overlap with any valid modes, and they *must* not be emitted
76 * to outside world - i.e. appear on disk or network. In other words, it's just
77 * temporary fields, which we internally use, but they have to stay in-house.
79 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
80 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
83 /* used internally in tree-diff */
84 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
88 * Intensive research over the course of many years has shown that
89 * port 9418 is totally unused by anything else. Or
91 * Your search - "port 9418" - did not match any documents.
93 * as www.google.com puts it.
95 * This port has been properly assigned for git use by IANA:
96 * git (Assigned-9418) [I06-050728-0001].
98 * git 9418/tcp git pack transfer service
99 * git 9418/udp git pack transfer service
101 * with Linus Torvalds <torvalds@osdl.org> as the point of
102 * contact. September 2005.
104 * See http://www.iana.org/assignments/port-numbers
106 #define DEFAULT_GIT_PORT 9418
109 * Basic data structures for the directory cache
112 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
113 struct cache_header {
114 uint32_t hdr_signature;
115 uint32_t hdr_version;
116 uint32_t hdr_entries;
119 #define INDEX_FORMAT_LB 2
120 #define INDEX_FORMAT_UB 4
123 * The "cache_time" is just the low 32 bits of the
124 * time. It doesn't matter if it overflows - we only
125 * check it for equality in the 32 bits we save.
133 struct cache_time sd_ctime;
134 struct cache_time sd_mtime;
139 unsigned int sd_size;
143 struct hashmap_entry ent;
144 struct stat_data ce_stat_data;
145 unsigned int ce_mode;
146 unsigned int ce_flags;
147 unsigned int mem_pool_allocated;
148 unsigned int ce_namelen;
149 unsigned int index; /* for link extension */
150 struct object_id oid;
151 char name[FLEX_ARRAY]; /* more */
154 #define CE_STAGEMASK (0x3000)
155 #define CE_EXTENDED (0x4000)
156 #define CE_VALID (0x8000)
157 #define CE_STAGESHIFT 12
160 * Range 0xFFFF0FFF in ce_flags is divided into
161 * two parts: in-memory flags and on-disk ones.
162 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
163 * if you want to save a new flag, add it in
166 * In-memory only flags
168 #define CE_UPDATE (1 << 16)
169 #define CE_REMOVE (1 << 17)
170 #define CE_UPTODATE (1 << 18)
171 #define CE_ADDED (1 << 19)
173 #define CE_HASHED (1 << 20)
174 #define CE_FSMONITOR_VALID (1 << 21)
175 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
176 #define CE_CONFLICTED (1 << 23)
178 #define CE_UNPACKED (1 << 24)
179 #define CE_NEW_SKIP_WORKTREE (1 << 25)
181 /* used to temporarily mark paths matched by pathspecs */
182 #define CE_MATCHED (1 << 26)
184 #define CE_UPDATE_IN_BASE (1 << 27)
185 #define CE_STRIP_NAME (1 << 28)
188 * Extended on-disk flags
190 #define CE_INTENT_TO_ADD (1 << 29)
191 #define CE_SKIP_WORKTREE (1 << 30)
192 /* CE_EXTENDED2 is for future extension */
193 #define CE_EXTENDED2 (1U << 31)
195 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
198 * Safeguard to avoid saving wrong flags:
199 * - CE_EXTENDED2 won't get saved until its semantic is known
200 * - Bits in 0x0000FFFF have been saved in ce_flags already
201 * - Bits in 0x003F0000 are currently in-memory flags
203 #if CE_EXTENDED_FLAGS & 0x803FFFFF
204 #error "CE_EXTENDED_FLAGS out of range"
207 #define S_ISSPARSEDIR(m) ((m) == S_IFDIR)
209 /* Forward structure decls */
211 struct child_process;
215 * Copy the sha1 and stat state of a cache entry from one to
216 * another. But we never change the name, or the hash state!
218 static inline void copy_cache_entry(struct cache_entry *dst,
219 const struct cache_entry *src)
221 unsigned int state = dst->ce_flags & CE_HASHED;
222 int mem_pool_allocated = dst->mem_pool_allocated;
224 /* Don't copy hash chain and name */
225 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
226 offsetof(struct cache_entry, name) -
227 offsetof(struct cache_entry, ce_stat_data));
229 /* Restore the hash state */
230 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
232 /* Restore the mem_pool_allocated flag */
233 dst->mem_pool_allocated = mem_pool_allocated;
236 static inline unsigned create_ce_flags(unsigned stage)
238 return (stage << CE_STAGESHIFT);
241 #define ce_namelen(ce) ((ce)->ce_namelen)
242 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
243 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
244 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
245 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
246 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
247 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
249 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
250 static inline unsigned int create_ce_mode(unsigned int mode)
254 if (S_ISDIR(mode) || S_ISGITLINK(mode))
256 return S_IFREG | ce_permissions(mode);
258 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
261 extern int trust_executable_bit, has_symlinks;
262 if (!has_symlinks && S_ISREG(mode) &&
263 ce && S_ISLNK(ce->ce_mode))
265 if (!trust_executable_bit && S_ISREG(mode)) {
266 if (ce && S_ISREG(ce->ce_mode))
268 return create_ce_mode(0666);
270 return create_ce_mode(mode);
272 static inline int ce_to_dtype(const struct cache_entry *ce)
274 unsigned ce_mode = ntohl(ce->ce_mode);
275 if (S_ISREG(ce_mode))
277 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
279 else if (S_ISLNK(ce_mode))
284 static inline unsigned int canon_mode(unsigned int mode)
287 return S_IFREG | ce_permissions(mode);
295 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
297 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
298 #define CE_ENTRY_CHANGED (1 << 1)
299 #define CE_ENTRY_REMOVED (1 << 2)
300 #define CE_ENTRY_ADDED (1 << 3)
301 #define RESOLVE_UNDO_CHANGED (1 << 4)
302 #define CACHE_TREE_CHANGED (1 << 5)
303 #define SPLIT_INDEX_ORDERED (1 << 6)
304 #define UNTRACKED_CHANGED (1 << 7)
305 #define FSMONITOR_CHANGED (1 << 8)
308 struct untracked_cache;
312 struct cache_entry **cache;
313 unsigned int version;
314 unsigned int cache_nr, cache_alloc, cache_changed;
315 struct string_list *resolve_undo;
316 struct cache_tree *cache_tree;
317 struct split_index *split_index;
318 struct cache_time timestamp;
319 unsigned name_hash_initialized : 1,
323 updated_skipworktree : 1,
324 fsmonitor_has_run_once : 1,
327 * sparse_index == 1 when sparse-directory
328 * entries exist. Requires sparse-checkout
332 struct hashmap name_hash;
333 struct hashmap dir_hash;
334 struct object_id oid;
335 struct untracked_cache *untracked;
336 char *fsmonitor_last_update;
337 struct ewah_bitmap *fsmonitor_dirty;
338 struct mem_pool *ce_mem_pool;
339 struct progress *progress;
340 struct repository *repo;
344 int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
345 void add_name_hash(struct index_state *istate, struct cache_entry *ce);
346 void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
347 void free_name_hash(struct index_state *istate);
350 /* Cache entry creation and cleanup */
353 * Create cache_entry intended for use in the specified index. Caller
354 * is responsible for discarding the cache_entry with
355 * `discard_cache_entry`.
357 struct cache_entry *make_cache_entry(struct index_state *istate,
359 const struct object_id *oid,
362 unsigned int refresh_options);
364 struct cache_entry *make_empty_cache_entry(struct index_state *istate,
368 * Create a cache_entry that is not intended to be added to an index.
369 * Caller is responsible for discarding the cache_entry
370 * with `discard_cache_entry`.
372 struct cache_entry *make_transient_cache_entry(unsigned int mode,
373 const struct object_id *oid,
377 struct cache_entry *make_empty_transient_cache_entry(size_t name_len);
380 * Discard cache entry.
382 void discard_cache_entry(struct cache_entry *ce);
385 * Check configuration if we should perform extra validation on cache
388 int should_validate_cache_entries(void);
391 * Duplicate a cache_entry. Allocate memory for the new entry from a
392 * memory_pool. Takes into account cache_entry fields that are meant
393 * for managing the underlying memory allocation of the cache_entry.
395 struct cache_entry *dup_cache_entry(const struct cache_entry *ce, struct index_state *istate);
398 * Validate the cache entries in the index. This is an internal
399 * consistency check that the cache_entry structs are allocated from
400 * the expected memory pool.
402 void validate_cache_entries(const struct index_state *istate);
404 #ifdef USE_THE_INDEX_COMPATIBILITY_MACROS
405 extern struct index_state the_index;
407 #define active_cache (the_index.cache)
408 #define active_nr (the_index.cache_nr)
409 #define active_alloc (the_index.cache_alloc)
410 #define active_cache_changed (the_index.cache_changed)
411 #define active_cache_tree (the_index.cache_tree)
413 #define read_cache() repo_read_index(the_repository)
414 #define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir()))
415 #define read_cache_preload(pathspec) repo_read_index_preload(the_repository, (pathspec), 0)
416 #define is_cache_unborn() is_index_unborn(&the_index)
417 #define read_cache_unmerged() repo_read_index_unmerged(the_repository)
418 #define discard_cache() discard_index(&the_index)
419 #define unmerged_cache() unmerged_index(&the_index)
420 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
421 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
422 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
423 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
424 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
425 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
426 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
427 #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
428 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
429 #define refresh_and_write_cache(refresh_flags, write_flags, gentle) repo_refresh_and_write_index(the_repository, (refresh_flags), (write_flags), (gentle), NULL, NULL, NULL)
430 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
431 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
432 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
433 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
434 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
435 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
436 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
437 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
438 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
439 #define hold_locked_index(lock_file, flags) repo_hold_locked_index(the_repository, (lock_file), (flags))
445 * Values in this enum (except those outside the 3 bit range) are part
446 * of pack file format. See Documentation/technical/pack-format.txt
447 * for more information.
456 /* 5 for future expansion */
463 static inline enum object_type object_type(unsigned int mode)
465 return S_ISDIR(mode) ? OBJ_TREE :
466 S_ISGITLINK(mode) ? OBJ_COMMIT :
470 /* Double-check local_repo_env below if you add to this list. */
471 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
472 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
473 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
474 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
475 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
476 #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
477 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
478 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
479 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
480 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
481 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
482 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
483 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
484 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
485 #define CONFIG_COUNT_ENVIRONMENT "GIT_CONFIG_COUNT"
486 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
487 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
488 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
489 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
490 #define GITATTRIBUTES_FILE ".gitattributes"
491 #define INFOATTRIBUTES_FILE "info/attributes"
492 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
493 #define GITMODULES_FILE ".gitmodules"
494 #define GITMODULES_INDEX ":.gitmodules"
495 #define GITMODULES_HEAD "HEAD:.gitmodules"
496 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
497 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
498 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
499 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
500 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
501 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
502 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
503 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
504 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
505 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
506 #define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
507 #define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT "GIT_TEXTDOMAINDIR"
510 * Environment variable used in handshaking the wire protocol.
511 * Contains a colon ':' separated list of keys with optional values
512 * 'key[=value]'. Presence of unknown keys and values must be
515 #define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
516 /* HTTP header used to handshake the wire protocol */
517 #define GIT_PROTOCOL_HEADER "Git-Protocol"
520 * This environment variable is expected to contain a boolean indicating
521 * whether we should or should not treat:
523 * GIT_DIR=foo.git git ...
525 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
526 * of this, but we use it internally to communicate to sub-processes that we
527 * are in a bare repo. If not set, defaults to true.
529 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
532 * Repository-local GIT_* environment variables; these will be cleared
533 * when git spawns a sub-process that runs inside another repository.
534 * The array is NULL-terminated, which makes it easy to pass in the "env"
535 * parameter of a run-command invocation, or to do a simple walk.
537 extern const char * const local_repo_env[];
539 void setup_git_env(const char *git_dir);
542 * Returns true iff we have a configured git repository (either via
543 * setup_git_directory, or in the environment via $GIT_DIR).
545 int have_git_dir(void);
547 extern int is_bare_repository_cfg;
548 int is_bare_repository(void);
549 int is_inside_git_dir(void);
550 extern char *git_work_tree_cfg;
551 int is_inside_work_tree(void);
552 const char *get_git_dir(void);
553 const char *get_git_common_dir(void);
554 char *get_object_directory(void);
555 char *get_index_file(void);
556 char *get_graft_file(struct repository *r);
557 void set_git_dir(const char *path, int make_realpath);
558 int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
559 int get_common_dir(struct strbuf *sb, const char *gitdir);
560 const char *get_git_namespace(void);
561 const char *strip_namespace(const char *namespaced_ref);
562 const char *get_super_prefix(void);
563 const char *get_git_work_tree(void);
566 * Return true if the given path is a git directory; note that this _just_
567 * looks at the directory itself. If you want to know whether "foo/.git"
568 * is a repository, you must feed that path, not just "foo".
570 int is_git_directory(const char *path);
573 * Return 1 if the given path is the root of a git repository or
574 * submodule, else 0. Will not return 1 for bare repositories with the
575 * exception of creating a bare repository in "foo/.git" and calling
576 * is_git_repository("foo").
578 * If we run into read errors, we err on the side of saying "yes, it is",
579 * as we usually consider sub-repos precious, and would prefer to err on the
580 * side of not disrupting or deleting them.
582 int is_nonbare_repository_dir(struct strbuf *path);
584 #define READ_GITFILE_ERR_STAT_FAILED 1
585 #define READ_GITFILE_ERR_NOT_A_FILE 2
586 #define READ_GITFILE_ERR_OPEN_FAILED 3
587 #define READ_GITFILE_ERR_READ_FAILED 4
588 #define READ_GITFILE_ERR_INVALID_FORMAT 5
589 #define READ_GITFILE_ERR_NO_PATH 6
590 #define READ_GITFILE_ERR_NOT_A_REPO 7
591 #define READ_GITFILE_ERR_TOO_LARGE 8
592 void read_gitfile_error_die(int error_code, const char *path, const char *dir);
593 const char *read_gitfile_gently(const char *path, int *return_error_code);
594 #define read_gitfile(path) read_gitfile_gently((path), NULL)
595 const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
596 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
598 void set_git_work_tree(const char *tree);
600 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
602 void setup_work_tree(void);
604 * Find the commondir and gitdir of the repository that contains the current
605 * working directory, without changing the working directory or other global
606 * state. The result is appended to commondir and gitdir. If the discovered
607 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
608 * both have the same result appended to the buffer. The return value is
609 * either 0 upon success and non-zero if no repository was found.
611 int discover_git_directory(struct strbuf *commondir,
612 struct strbuf *gitdir);
613 const char *setup_git_directory_gently(int *);
614 const char *setup_git_directory(void);
615 char *prefix_path(const char *prefix, int len, const char *path);
616 char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
619 * Concatenate "prefix" (if len is non-zero) and "path", with no
620 * connecting characters (so "prefix" should end with a "/").
621 * Unlike prefix_path, this should be used if the named file does
622 * not have to interact with index entry; i.e. name of a random file
625 * The return value is always a newly allocated string (even if the
628 char *prefix_filename(const char *prefix, const char *path);
630 int check_filename(const char *prefix, const char *name);
631 void verify_filename(const char *prefix,
633 int diagnose_misspelt_rev);
634 void verify_non_filename(const char *prefix, const char *name);
635 int path_inside_repo(const char *prefix, const char *path);
637 #define INIT_DB_QUIET 0x0001
638 #define INIT_DB_EXIST_OK 0x0002
640 int init_db(const char *git_dir, const char *real_git_dir,
641 const char *template_dir, int hash_algo,
642 const char *initial_branch, unsigned int flags);
643 void initialize_repository_version(int hash_algo, int reinit);
645 void sanitize_stdfds(void);
648 #define alloc_nr(x) (((x)+16)*3/2)
651 * Dynamically growing an array using realloc() is error prone and boring.
653 * Define your array with:
655 * - a pointer (`item`) that points at the array, initialized to `NULL`
656 * (although please name the variable based on its contents, not on its
659 * - an integer variable (`alloc`) that keeps track of how big the current
660 * allocation is, initialized to `0`;
662 * - another integer variable (`nr`) to keep track of how many elements the
663 * array currently has, initialized to `0`.
665 * Then before adding `n`th element to the item, call `ALLOC_GROW(item, n,
666 * alloc)`. This ensures that the array can hold at least `n` elements by
667 * calling `realloc(3)` and adjusting `alloc` variable.
674 * for (i = 0; i < nr; i++)
675 * if (we like item[i] already)
678 * // we did not like any existing one, so add one
679 * ALLOC_GROW(item, nr + 1, alloc);
680 * item[nr++] = value you like;
683 * You are responsible for updating the `nr` variable.
685 * If you need to specify the number of elements to allocate explicitly
686 * then use the macro `REALLOC_ARRAY(item, alloc)` instead of `ALLOC_GROW`.
688 * Consider using ALLOC_GROW_BY instead of ALLOC_GROW as it has some
691 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
693 #define ALLOC_GROW(x, nr, alloc) \
695 if ((nr) > alloc) { \
696 if (alloc_nr(alloc) < (nr)) \
699 alloc = alloc_nr(alloc); \
700 REALLOC_ARRAY(x, alloc); \
705 * Similar to ALLOC_GROW but handles updating of the nr value and
706 * zeroing the bytes of the newly-grown array elements.
708 * DO NOT USE any expression with side-effect for any of the
711 #define ALLOC_GROW_BY(x, nr, increase, alloc) \
714 size_t new_nr = nr + (increase); \
716 BUG("negative growth in ALLOC_GROW_BY"); \
717 ALLOC_GROW(x, new_nr, alloc); \
718 memset((x) + nr, 0, sizeof(*(x)) * (increase)); \
723 /* Initialize and use the cache information */
725 void preload_index(struct index_state *index,
726 const struct pathspec *pathspec,
727 unsigned int refresh_flags);
728 int do_read_index(struct index_state *istate, const char *path,
729 int must_exist); /* for testting only! */
730 int read_index_from(struct index_state *, const char *path,
732 int is_index_unborn(struct index_state *);
734 void ensure_full_index(struct index_state *istate);
736 /* For use with `write_locked_index()`. */
737 #define COMMIT_LOCK (1 << 0)
738 #define SKIP_IF_UNCHANGED (1 << 1)
741 * Write the index while holding an already-taken lock. Close the lock,
742 * and if `COMMIT_LOCK` is given, commit it.
744 * Unless a split index is in use, write the index into the lockfile.
746 * With a split index, write the shared index to a temporary file,
747 * adjust its permissions and rename it into place, then write the
748 * split index to the lockfile. If the temporary file for the shared
749 * index cannot be created, fall back to the behavior described in
750 * the previous paragraph.
752 * With `COMMIT_LOCK`, the lock is always committed or rolled back.
753 * Without it, the lock is closed, but neither committed nor rolled
756 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing
757 * is written (and the lock is rolled back if `COMMIT_LOCK` is given).
759 int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
761 int discard_index(struct index_state *);
762 void move_index_extensions(struct index_state *dst, struct index_state *src);
763 int unmerged_index(const struct index_state *);
766 * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL,
767 * compares istate to HEAD. If tree is NULL and on an unborn branch,
768 * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is
769 * provided, the space-separated list of files that differ will be appended
772 int repo_index_has_changes(struct repository *repo,
776 int verify_path(const char *path, unsigned mode);
777 int strcmp_offset(const char *s1, const char *s2, size_t *first_change);
778 int index_dir_exists(struct index_state *istate, const char *name, int namelen);
779 void adjust_dirname_case(struct index_state *istate, char *name);
780 struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
783 * Searches for an entry defined by name and namelen in the given index.
784 * If the return value is positive (including 0) it is the position of an
785 * exact match. If the return value is negative, the negated value minus 1
786 * is the position where the entry would be inserted.
787 * Example: The current index consists of these files and its stages:
791 * index_name_pos(&index, "a", 1) -> -1
792 * index_name_pos(&index, "b", 1) -> 0
793 * index_name_pos(&index, "c", 1) -> -2
794 * index_name_pos(&index, "d", 1) -> 1
795 * index_name_pos(&index, "e", 1) -> -3
796 * index_name_pos(&index, "f", 1) -> -3
797 * index_name_pos(&index, "g", 1) -> -5
799 int index_name_pos(const struct index_state *, const char *name, int namelen);
802 * Some functions return the negative complement of an insert position when a
803 * precise match was not found but a position was found where the entry would
804 * need to be inserted. This helper protects that logic from any integer
807 static inline int index_pos_to_insert_pos(uintmax_t pos)
810 die("overflow: -1 - %"PRIuMAX, pos);
811 return -1 - (int)pos;
814 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
815 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
816 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
817 #define ADD_CACHE_JUST_APPEND 8 /* Append only */
818 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
819 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
820 #define ADD_CACHE_RENORMALIZE 64 /* Pass along HASH_RENORMALIZE */
821 int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
822 void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
824 /* Remove entry, return true if there are more entries to go. */
825 int remove_index_entry_at(struct index_state *, int pos);
827 void remove_marked_cache_entries(struct index_state *istate, int invalidate);
828 int remove_file_from_index(struct index_state *, const char *path);
829 #define ADD_CACHE_VERBOSE 1
830 #define ADD_CACHE_PRETEND 2
831 #define ADD_CACHE_IGNORE_ERRORS 4
832 #define ADD_CACHE_IGNORE_REMOVAL 8
833 #define ADD_CACHE_INTENT 16
835 * These two are used to add the contents of the file at path
836 * to the index, marking the working tree up-to-date by storing
837 * the cached stat info in the resulting cache entry. A caller
838 * that has already run lstat(2) on the path can call
839 * add_to_index(), and all others can call add_file_to_index();
840 * the latter will do necessary lstat(2) internally before
841 * calling the former.
843 int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
844 int add_file_to_index(struct index_state *, const char *path, int flags);
846 int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
847 int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
848 void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
849 int index_name_is_other(const struct index_state *, const char *, int);
850 void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
852 /* do stat comparison even if CE_VALID is true */
853 #define CE_MATCH_IGNORE_VALID 01
854 /* do not check the contents but report dirty on racily-clean entries */
855 #define CE_MATCH_RACY_IS_DIRTY 02
856 /* do stat comparison even if CE_SKIP_WORKTREE is true */
857 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
858 /* ignore non-existent files during stat update */
859 #define CE_MATCH_IGNORE_MISSING 0x08
860 /* enable stat refresh */
861 #define CE_MATCH_REFRESH 0x10
862 /* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
863 #define CE_MATCH_IGNORE_FSMONITOR 0X20
864 int is_racy_timestamp(const struct index_state *istate,
865 const struct cache_entry *ce);
866 int ie_match_stat(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
867 int ie_modified(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
869 #define HASH_WRITE_OBJECT 1
870 #define HASH_FORMAT_CHECK 2
871 #define HASH_RENORMALIZE 4
872 int index_fd(struct index_state *istate, struct object_id *oid, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
873 int index_path(struct index_state *istate, struct object_id *oid, const char *path, struct stat *st, unsigned flags);
876 * Record to sd the data from st that we use to check whether a file
877 * might have changed.
879 void fill_stat_data(struct stat_data *sd, struct stat *st);
882 * Return 0 if st is consistent with a file not having been changed
883 * since sd was filled. If there are differences, return a
884 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
885 * INODE_CHANGED, and DATA_CHANGED.
887 int match_stat_data(const struct stat_data *sd, struct stat *st);
888 int match_stat_data_racy(const struct index_state *istate,
889 const struct stat_data *sd, struct stat *st);
891 void fill_stat_cache_info(struct index_state *istate, struct cache_entry *ce, struct stat *st);
893 #define REFRESH_REALLY 0x0001 /* ignore_valid */
894 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
895 #define REFRESH_QUIET 0x0004 /* be quiet about it */
896 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
897 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
898 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
899 #define REFRESH_PROGRESS 0x0040 /* show progress bar if stderr is tty */
900 int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
902 * Refresh the index and write it to disk.
904 * 'refresh_flags' is passed directly to 'refresh_index()', while
905 * 'COMMIT_LOCK | write_flags' is passed to 'write_locked_index()', so
906 * the lockfile is always either committed or rolled back.
908 * If 'gentle' is passed, errors locking the index are ignored.
910 * Return 1 if refreshing the index returns an error, -1 if writing
911 * the index to disk fails, 0 on success.
913 * Note that if refreshing the index returns an error, we still write
914 * out the index (unless locking fails).
916 int repo_refresh_and_write_index(struct repository*, unsigned int refresh_flags, unsigned int write_flags, int gentle, const struct pathspec *, char *seen, const char *header_msg);
918 struct cache_entry *refresh_cache_entry(struct index_state *, struct cache_entry *, unsigned int);
920 void set_alternate_index_output(const char *);
922 extern int verify_index_checksum;
923 extern int verify_ce_order;
925 /* Environment bits from configuration mechanism */
926 extern int trust_executable_bit;
927 extern int trust_ctime;
928 extern int check_stat;
929 extern int quote_path_fully;
930 extern int has_symlinks;
931 extern int minimum_abbrev, default_abbrev;
932 extern int ignore_case;
933 extern int assume_unchanged;
934 extern int prefer_symlink_refs;
935 extern int warn_ambiguous_refs;
936 extern int warn_on_object_refname_ambiguity;
937 extern char *apply_default_whitespace;
938 extern char *apply_default_ignorewhitespace;
939 extern const char *git_attributes_file;
940 extern const char *git_hooks_path;
941 extern int zlib_compression_level;
942 extern int core_compression_level;
943 extern int pack_compression_level;
944 extern size_t packed_git_window_size;
945 extern size_t packed_git_limit;
946 extern size_t delta_base_cache_limit;
947 extern unsigned long big_file_threshold;
948 extern unsigned long pack_size_limit_cfg;
951 * Accessors for the core.sharedrepository config which lazy-load the value
952 * from the config (if not already set). The "reset" function can be
953 * used to unset "set" or cached value, meaning that the value will be loaded
954 * fresh from the config file on the next call to get_shared_repository().
956 void set_shared_repository(int value);
957 int get_shared_repository(void);
958 void reset_shared_repository(void);
961 * Do replace refs need to be checked this run? This variable is
962 * initialized to true unless --no-replace-object is used or
963 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
964 * commands that do not want replace references to be active.
966 extern int read_replace_refs;
967 extern char *git_replace_ref_base;
969 extern int fsync_object_files;
970 extern int core_preload_index;
971 extern int precomposed_unicode;
972 extern int protect_hfs;
973 extern int protect_ntfs;
974 extern const char *core_fsmonitor;
976 extern int core_apply_sparse_checkout;
977 extern int core_sparse_checkout_cone;
980 * Include broken refs in all ref iterations, which will
981 * generally choke dangerous operations rather than letting
982 * them silently proceed without taking the broken ref into
985 extern int ref_paranoia;
988 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
990 int use_optional_locks(void);
993 * The character that begins a commented line in user-editable file
994 * that is subject to stripspace.
996 extern char comment_line_char;
997 extern int auto_comment_line_char;
999 enum log_refs_config {
1000 LOG_REFS_UNSET = -1,
1005 extern enum log_refs_config log_all_ref_updates;
1007 enum rebase_setup_type {
1008 AUTOREBASE_NEVER = 0,
1014 enum push_default_type {
1015 PUSH_DEFAULT_NOTHING = 0,
1016 PUSH_DEFAULT_MATCHING,
1017 PUSH_DEFAULT_SIMPLE,
1018 PUSH_DEFAULT_UPSTREAM,
1019 PUSH_DEFAULT_CURRENT,
1020 PUSH_DEFAULT_UNSPECIFIED
1023 extern enum rebase_setup_type autorebase;
1024 extern enum push_default_type push_default;
1026 enum object_creation_mode {
1027 OBJECT_CREATION_USES_HARDLINKS = 0,
1028 OBJECT_CREATION_USES_RENAMES = 1
1031 extern enum object_creation_mode object_creation_mode;
1033 extern char *notes_ref_name;
1035 extern int grafts_replace_parents;
1038 * GIT_REPO_VERSION is the version we write by default. The
1039 * _READ variant is the highest number we know how to
1042 #define GIT_REPO_VERSION 0
1043 #define GIT_REPO_VERSION_READ 1
1044 extern int repository_format_precious_objects;
1045 extern int repository_format_worktree_config;
1048 * You _have_ to initialize a `struct repository_format` using
1049 * `= REPOSITORY_FORMAT_INIT` before calling `read_repository_format()`.
1051 struct repository_format {
1053 int precious_objects;
1054 char *partial_clone; /* value of extensions.partialclone */
1055 int worktree_config;
1059 struct string_list unknown_extensions;
1060 struct string_list v1_only_extensions;
1064 * Always use this to initialize a `struct repository_format`
1065 * to a well-defined, default state before calling
1066 * `read_repository()`.
1068 #define REPOSITORY_FORMAT_INIT \
1072 .hash_algo = GIT_HASH_SHA1, \
1073 .unknown_extensions = STRING_LIST_INIT_DUP, \
1074 .v1_only_extensions = STRING_LIST_INIT_DUP, \
1078 * Read the repository format characteristics from the config file "path" into
1079 * "format" struct. Returns the numeric version. On error, or if no version is
1080 * found in the configuration, -1 is returned, format->version is set to -1,
1081 * and all other fields in the struct are set to the default configuration
1082 * (REPOSITORY_FORMAT_INIT). Always initialize the struct using
1083 * REPOSITORY_FORMAT_INIT before calling this function.
1085 int read_repository_format(struct repository_format *format, const char *path);
1088 * Free the memory held onto by `format`, but not the struct itself.
1089 * (No need to use this after `read_repository_format()` fails.)
1091 void clear_repository_format(struct repository_format *format);
1094 * Verify that the repository described by repository_format is something we
1095 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
1096 * any errors encountered.
1098 int verify_repository_format(const struct repository_format *format,
1099 struct strbuf *err);
1102 * Check the repository format version in the path found in get_git_dir(),
1103 * and die if it is a version we don't understand. Generally one would
1104 * set_git_dir() before calling this, and use it only for "are we in a valid
1107 * If successful and fmt is not NULL, fill fmt with data.
1109 void check_repository_format(struct repository_format *fmt);
1111 #define MTIME_CHANGED 0x0001
1112 #define CTIME_CHANGED 0x0002
1113 #define OWNER_CHANGED 0x0004
1114 #define MODE_CHANGED 0x0008
1115 #define INODE_CHANGED 0x0010
1116 #define DATA_CHANGED 0x0020
1117 #define TYPE_CHANGED 0x0040
1120 * Return an abbreviated sha1 unique within this repository's object database.
1121 * The result will be at least `len` characters long, and will be NUL
1124 * The non-`_r` version returns a static buffer which remains valid until 4
1125 * more calls to find_unique_abbrev are made.
1127 * The `_r` variant writes to a buffer supplied by the caller, which must be at
1128 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes
1129 * written (excluding the NUL terminator).
1131 * Note that while this version avoids the static buffer, it is not fully
1132 * reentrant, as it calls into other non-reentrant git code.
1134 const char *repo_find_unique_abbrev(struct repository *r, const struct object_id *oid, int len);
1135 #define find_unique_abbrev(oid, len) repo_find_unique_abbrev(the_repository, oid, len)
1136 int repo_find_unique_abbrev_r(struct repository *r, char *hex, const struct object_id *oid, int len);
1137 #define find_unique_abbrev_r(hex, oid, len) repo_find_unique_abbrev_r(the_repository, hex, oid, len)
1139 /* set default permissions by passing mode arguments to open(2) */
1140 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1141 int git_mkstemp_mode(char *pattern, int mode);
1146 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1147 * not be changed. Old repositories have core.sharedrepository written in
1148 * numeric format, and therefore these values are preserved for compatibility
1154 OLD_PERM_EVERYBODY = 2,
1156 PERM_EVERYBODY = 0664
1158 int git_config_perm(const char *var, const char *value);
1159 int adjust_shared_perm(const char *path);
1162 * Create the directory containing the named path, using care to be
1163 * somewhat safe against races. Return one of the scld_error values to
1164 * indicate success/failure. On error, set errno to describe the
1167 * SCLD_VANISHED indicates that one of the ancestor directories of the
1168 * path existed at one point during the function call and then
1169 * suddenly vanished, probably because another process pruned the
1170 * directory while we were working. To be robust against this kind of
1171 * race, callers might want to try invoking the function again when it
1172 * returns SCLD_VANISHED.
1174 * safe_create_leading_directories() temporarily changes path while it
1175 * is working but restores it before returning.
1176 * safe_create_leading_directories_const() doesn't modify path, even
1177 * temporarily. Both these variants adjust the permissions of the
1178 * created directories to honor core.sharedRepository, so they are best
1179 * suited for files inside the git dir. For working tree files, use
1180 * safe_create_leading_directories_no_share() instead, as it ignores
1181 * the core.sharedRepository setting.
1190 enum scld_error safe_create_leading_directories(char *path);
1191 enum scld_error safe_create_leading_directories_const(const char *path);
1192 enum scld_error safe_create_leading_directories_no_share(char *path);
1195 * Callback function for raceproof_create_file(). This function is
1196 * expected to do something that makes dirname(path) permanent despite
1197 * the fact that other processes might be cleaning up empty
1198 * directories at the same time. Usually it will create a file named
1199 * path, but alternatively it could create another file in that
1200 * directory, or even chdir() into that directory. The function should
1201 * return 0 if the action was completed successfully. On error, it
1202 * should return a nonzero result and set errno.
1203 * raceproof_create_file() treats two errno values specially:
1205 * - ENOENT -- dirname(path) does not exist. In this case,
1206 * raceproof_create_file() tries creating dirname(path)
1207 * (and any parent directories, if necessary) and calls
1208 * the function again.
1210 * - EISDIR -- the file already exists and is a directory. In this
1211 * case, raceproof_create_file() removes the directory if
1212 * it is empty (and recursively any empty directories that
1213 * it contains) and calls the function again.
1215 * Any other errno causes raceproof_create_file() to fail with the
1216 * callback's return value and errno.
1218 * Obviously, this function should be OK with being called again if it
1219 * fails with ENOENT or EISDIR. In other scenarios it will not be
1222 typedef int create_file_fn(const char *path, void *cb);
1225 * Create a file in dirname(path) by calling fn, creating leading
1226 * directories if necessary. Retry a few times in case we are racing
1227 * with another process that is trying to clean up the directory that
1228 * contains path. See the documentation for create_file_fn for more
1231 * Return the value and set the errno that resulted from the most
1232 * recent call of fn. fn is always called at least once, and will be
1233 * called more than once if it returns ENOENT or EISDIR.
1235 int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
1237 int mkdir_in_gitdir(const char *path);
1238 char *expand_user_path(const char *path, int real_home);
1239 const char *enter_repo(const char *path, int strict);
1240 static inline int is_absolute_path(const char *path)
1242 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
1244 int is_directory(const char *);
1245 char *strbuf_realpath(struct strbuf *resolved, const char *path,
1247 char *strbuf_realpath_forgiving(struct strbuf *resolved, const char *path,
1249 char *real_pathdup(const char *path, int die_on_error);
1250 const char *absolute_path(const char *path);
1251 char *absolute_pathdup(const char *path);
1252 const char *remove_leading_path(const char *in, const char *prefix);
1253 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
1254 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
1255 int normalize_path_copy(char *dst, const char *src);
1256 int longest_ancestor_length(const char *path, struct string_list *prefixes);
1257 char *strip_path_suffix(const char *path, const char *suffix);
1258 int daemon_avoid_alias(const char *path);
1261 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for
1264 int is_ntfs_dotgit(const char *name);
1265 int is_ntfs_dotgitmodules(const char *name);
1266 int is_ntfs_dotgitignore(const char *name);
1267 int is_ntfs_dotgitattributes(const char *name);
1270 * Returns true iff "str" could be confused as a command-line option when
1271 * passed to a sub-program like "ssh". Note that this has nothing to do with
1272 * shell-quoting, which should be handled separately; we're assuming here that
1273 * the string makes it verbatim to the sub-program.
1275 int looks_like_command_line_option(const char *str);
1278 * Return a newly allocated string with the evaluation of
1279 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1280 * "$HOME/.config/git/$filename". Return NULL upon error.
1282 char *xdg_config_home(const char *filename);
1285 * Return a newly allocated string with the evaluation of
1286 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1287 * "$HOME/.cache/git/$filename". Return NULL upon error.
1289 char *xdg_cache_home(const char *filename);
1291 int git_open_cloexec(const char *name, int flags);
1292 #define git_open(name) git_open_cloexec(name, O_RDONLY)
1293 int unpack_loose_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1294 int parse_loose_header(const char *hdr, unsigned long *sizep);
1296 int check_object_signature(struct repository *r, const struct object_id *oid,
1297 void *buf, unsigned long size, const char *type);
1299 int finalize_object_file(const char *tmpfile, const char *filename);
1301 /* Helper to check and "touch" a file */
1302 int check_and_freshen_file(const char *fn, int freshen);
1304 extern const signed char hexval_table[256];
1305 static inline unsigned int hexval(unsigned char c)
1307 return hexval_table[c];
1311 * Convert two consecutive hexadecimal digits into a char. Return a
1312 * negative value on error. Don't run over the end of short strings.
1314 static inline int hex2chr(const char *s)
1316 unsigned int val = hexval(s[0]);
1317 return (val & ~0xf) ? val : (val << 4) | hexval(s[1]);
1320 /* Convert to/from hex/sha1 representation */
1321 #define MINIMUM_ABBREV minimum_abbrev
1322 #define DEFAULT_ABBREV default_abbrev
1324 /* used when the code does not know or care what the default abbrev is */
1325 #define FALLBACK_DEFAULT_ABBREV 7
1327 struct object_context {
1328 unsigned short mode;
1330 * symlink_path is only used by get_tree_entry_follow_symlinks,
1331 * and only for symlinks that point outside the repository.
1333 struct strbuf symlink_path;
1335 * If GET_OID_RECORD_PATH is set, this will record path (if any)
1336 * found when resolving the name. The caller is responsible for
1337 * releasing the memory.
1342 #define GET_OID_QUIETLY 01
1343 #define GET_OID_COMMIT 02
1344 #define GET_OID_COMMITTISH 04
1345 #define GET_OID_TREE 010
1346 #define GET_OID_TREEISH 020
1347 #define GET_OID_BLOB 040
1348 #define GET_OID_FOLLOW_SYMLINKS 0100
1349 #define GET_OID_RECORD_PATH 0200
1350 #define GET_OID_ONLY_TO_DIE 04000
1352 #define GET_OID_DISAMBIGUATORS \
1353 (GET_OID_COMMIT | GET_OID_COMMITTISH | \
1354 GET_OID_TREE | GET_OID_TREEISH | \
1357 enum get_oid_result {
1359 MISSING_OBJECT = -1, /* The requested object is missing */
1360 SHORT_NAME_AMBIGUOUS = -2,
1361 /* The following only apply when symlinks are followed */
1362 DANGLING_SYMLINK = -4, /*
1363 * The initial symlink is there, but
1364 * (transitively) points to a missing
1369 * Somewhere along the symlink chain, a path is
1370 * requested which contains a file as a
1371 * non-final element.
1375 int repo_get_oid(struct repository *r, const char *str, struct object_id *oid);
1376 int get_oidf(struct object_id *oid, const char *fmt, ...);
1377 int repo_get_oid_commit(struct repository *r, const char *str, struct object_id *oid);
1378 int repo_get_oid_committish(struct repository *r, const char *str, struct object_id *oid);
1379 int repo_get_oid_tree(struct repository *r, const char *str, struct object_id *oid);
1380 int repo_get_oid_treeish(struct repository *r, const char *str, struct object_id *oid);
1381 int repo_get_oid_blob(struct repository *r, const char *str, struct object_id *oid);
1382 int repo_get_oid_mb(struct repository *r, const char *str, struct object_id *oid);
1383 void maybe_die_on_misspelt_object_name(struct repository *repo,
1385 const char *prefix);
1386 enum get_oid_result get_oid_with_context(struct repository *repo, const char *str,
1387 unsigned flags, struct object_id *oid,
1388 struct object_context *oc);
1390 #define get_oid(str, oid) repo_get_oid(the_repository, str, oid)
1391 #define get_oid_commit(str, oid) repo_get_oid_commit(the_repository, str, oid)
1392 #define get_oid_committish(str, oid) repo_get_oid_committish(the_repository, str, oid)
1393 #define get_oid_tree(str, oid) repo_get_oid_tree(the_repository, str, oid)
1394 #define get_oid_treeish(str, oid) repo_get_oid_treeish(the_repository, str, oid)
1395 #define get_oid_blob(str, oid) repo_get_oid_blob(the_repository, str, oid)
1396 #define get_oid_mb(str, oid) repo_get_oid_mb(the_repository, str, oid)
1398 typedef int each_abbrev_fn(const struct object_id *oid, void *);
1399 int repo_for_each_abbrev(struct repository *r, const char *prefix, each_abbrev_fn, void *);
1400 #define for_each_abbrev(prefix, fn, data) repo_for_each_abbrev(the_repository, prefix, fn, data)
1402 int set_disambiguate_hint_config(const char *var, const char *value);
1405 * Try to read a SHA1 in hexadecimal format from the 40 characters
1406 * starting at hex. Write the 20-byte result to sha1 in binary form.
1407 * Return 0 on success. Reading stops if a NUL is encountered in the
1408 * input, so it is safe to pass this function an arbitrary
1409 * null-terminated string.
1411 int get_sha1_hex(const char *hex, unsigned char *sha1);
1412 int get_oid_hex(const char *hex, struct object_id *sha1);
1414 /* Like get_oid_hex, but for an arbitrary hash algorithm. */
1415 int get_oid_hex_algop(const char *hex, struct object_id *oid, const struct git_hash_algo *algop);
1418 * Read `len` pairs of hexadecimal digits from `hex` and write the
1419 * values to `binary` as `len` bytes. Return 0 on success, or -1 if
1420 * the input does not consist of hex digits).
1422 int hex_to_bytes(unsigned char *binary, const char *hex, size_t len);
1425 * Convert a binary hash in "unsigned char []" or an object name in
1426 * "struct object_id *" to its hex equivalent. The `_r` variant is reentrant,
1427 * and writes the NUL-terminated output to the buffer `out`, which must be at
1428 * least `GIT_MAX_HEXSZ + 1` bytes, and returns a pointer to out for
1431 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1432 * buffers, making it safe to make multiple calls for a single statement, like:
1434 * printf("%s -> %s", hash_to_hex(one), hash_to_hex(two));
1435 * printf("%s -> %s", oid_to_hex(one), oid_to_hex(two));
1437 char *hash_to_hex_algop_r(char *buffer, const unsigned char *hash, const struct git_hash_algo *);
1438 char *oid_to_hex_r(char *out, const struct object_id *oid);
1439 char *hash_to_hex_algop(const unsigned char *hash, const struct git_hash_algo *); /* static buffer result! */
1440 char *hash_to_hex(const unsigned char *hash); /* same static buffer */
1441 char *oid_to_hex(const struct object_id *oid); /* same static buffer */
1444 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1445 * pointer specified by end when parsing stops. The resulting object ID is
1446 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1447 * other invalid character. end is only updated on success; otherwise, it is
1450 int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
1452 /* Like parse_oid_hex, but for an arbitrary hash algorithm. */
1453 int parse_oid_hex_algop(const char *hex, struct object_id *oid, const char **end,
1454 const struct git_hash_algo *algo);
1458 * These functions work like get_oid_hex and parse_oid_hex, but they will parse
1459 * a hex value for any algorithm. The algorithm is detected based on the length
1460 * and the algorithm in use is returned. If this is not a hex object ID in any
1461 * algorithm, returns GIT_HASH_UNKNOWN.
1463 int get_oid_hex_any(const char *hex, struct object_id *oid);
1464 int parse_oid_hex_any(const char *hex, struct object_id *oid, const char **end);
1467 * This reads short-hand syntax that not only evaluates to a commit
1468 * object name, but also can act as if the end user spelled the name
1469 * of the branch from the command line.
1471 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1472 * places the name of the branch in the given buf and returns the
1473 * number of characters parsed if successful.
1475 * - "<branch>@{upstream}" finds the name of the other ref that
1476 * <branch> is configured to merge with (missing <branch> defaults
1477 * to the current branch), and places the name of the branch in the
1478 * given buf and returns the number of characters parsed if
1481 * If the input is not of the accepted format, it returns a negative
1482 * number to signal an error.
1484 * If the input was ok but there are not N branch switches in the
1485 * reflog, it returns 0.
1487 #define INTERPRET_BRANCH_LOCAL (1<<0)
1488 #define INTERPRET_BRANCH_REMOTE (1<<1)
1489 #define INTERPRET_BRANCH_HEAD (1<<2)
1490 struct interpret_branch_name_options {
1492 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1493 * expansions: local branches ("refs/heads/"), remote branches
1494 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1495 * allowed, even ones to refs outside of those namespaces.
1500 * If ^{upstream} or ^{push} (or equivalent) is requested, and the
1501 * branch in question does not have such a reference, return -1 instead
1504 unsigned nonfatal_dangling_mark : 1;
1506 int repo_interpret_branch_name(struct repository *r,
1507 const char *str, int len,
1509 const struct interpret_branch_name_options *options);
1510 #define interpret_branch_name(str, len, buf, options) \
1511 repo_interpret_branch_name(the_repository, str, len, buf, options)
1513 int validate_headref(const char *ref);
1515 int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1516 int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1517 int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1518 int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1520 void *read_object_with_reference(struct repository *r,
1521 const struct object_id *oid,
1522 const char *required_type,
1523 unsigned long *size,
1524 struct object_id *oid_ret);
1526 struct object *repo_peel_to_type(struct repository *r,
1527 const char *name, int namelen,
1528 struct object *o, enum object_type);
1529 #define peel_to_type(name, namelen, obj, type) \
1530 repo_peel_to_type(the_repository, name, namelen, obj, type)
1532 enum date_mode_type {
1538 DATE_ISO8601_STRICT,
1546 enum date_mode_type type;
1547 const char *strftime_fmt;
1552 * Convenience helper for passing a constant type, like:
1554 * show_date(t, tz, DATE_MODE(NORMAL));
1556 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1557 struct date_mode *date_mode_from_type(enum date_mode_type type);
1559 const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);
1560 void show_date_relative(timestamp_t time, struct strbuf *timebuf);
1561 void show_date_human(timestamp_t time, int tz, const struct timeval *now,
1562 struct strbuf *timebuf);
1563 int parse_date(const char *date, struct strbuf *out);
1564 int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);
1565 int parse_expiry_date(const char *date, timestamp_t *timestamp);
1566 void datestamp(struct strbuf *out);
1567 #define approxidate(s) approxidate_careful((s), NULL)
1568 timestamp_t approxidate_careful(const char *, int *);
1569 timestamp_t approxidate_relative(const char *date);
1570 void parse_date_format(const char *format, struct date_mode *mode);
1571 int date_overflows(timestamp_t date);
1573 #define IDENT_STRICT 1
1574 #define IDENT_NO_DATE 2
1575 #define IDENT_NO_NAME 4
1580 WANT_COMMITTER_IDENT
1583 const char *git_author_info(int);
1584 const char *git_committer_info(int);
1585 const char *fmt_ident(const char *name, const char *email,
1586 enum want_ident whose_ident,
1587 const char *date_str, int);
1588 const char *fmt_name(enum want_ident);
1589 const char *ident_default_name(void);
1590 const char *ident_default_email(void);
1591 const char *git_editor(void);
1592 const char *git_sequence_editor(void);
1593 const char *git_pager(int stdout_is_tty);
1594 int is_terminal_dumb(void);
1595 int git_ident_config(const char *, const char *, void *);
1597 * Prepare an ident to fall back on if the user didn't configure it.
1599 void prepare_fallback_ident(const char *name, const char *email);
1600 void reset_ident_date(void);
1602 struct ident_split {
1603 const char *name_begin;
1604 const char *name_end;
1605 const char *mail_begin;
1606 const char *mail_end;
1607 const char *date_begin;
1608 const char *date_end;
1609 const char *tz_begin;
1613 * Signals an success with 0, but time part of the result may be NULL
1614 * if the input lacks timestamp and zone
1616 int split_ident_line(struct ident_split *, const char *, int);
1619 * Like show_date, but pull the timestamp and tz parameters from
1620 * the ident_split. It will also sanity-check the values and produce
1621 * a well-known sentinel date if they appear bogus.
1623 const char *show_ident_date(const struct ident_split *id,
1624 const struct date_mode *mode);
1627 * Compare split idents for equality or strict ordering. Note that we
1628 * compare only the ident part of the line, ignoring any timestamp.
1630 * Because there are two fields, we must choose one as the primary key; we
1631 * currently arbitrarily pick the email.
1633 int ident_cmp(const struct ident_split *, const struct ident_split *);
1636 struct index_state *istate;
1637 const char *base_dir;
1639 struct delayed_checkout *delayed_checkout;
1640 struct checkout_metadata meta;
1647 #define CHECKOUT_INIT { NULL, "" }
1649 #define TEMPORARY_FILENAME_LENGTH 25
1650 int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath, int *nr_checkouts);
1651 void enable_delayed_checkout(struct checkout *state);
1652 int finish_delayed_checkout(struct checkout *state, int *nr_checkouts);
1654 * Unlink the last component and schedule the leading directories for
1655 * removal, such that empty directories get removed.
1657 void unlink_entry(const struct cache_entry *ce);
1663 int prefix_len_stat_func;
1665 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1666 static inline void cache_def_clear(struct cache_def *cache)
1668 strbuf_release(&cache->path);
1671 int has_symlink_leading_path(const char *name, int len);
1672 int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1673 int check_leading_path(const char *name, int len);
1674 int has_dirs_only_path(const char *name, int len, int prefix_len);
1675 void schedule_dir_for_removal(const char *name, int len);
1676 void remove_scheduled_dirs(void);
1678 struct pack_window {
1679 struct pack_window *next;
1680 unsigned char *base;
1683 unsigned int last_used;
1684 unsigned int inuse_cnt;
1689 struct packed_git *p;
1693 * Create a temporary file rooted in the object database directory, or
1694 * die on failure. The filename is taken from "pattern", which should have the
1695 * usual "XXXXXX" trailer, and the resulting filename is written into the
1696 * "template" buffer. Returns the open descriptor.
1698 int odb_mkstemp(struct strbuf *temp_filename, const char *pattern);
1701 * Create a pack .keep file named "name" (which should generally be the output
1702 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1705 int odb_pack_keep(const char *name);
1708 * Set this to 0 to prevent oid_object_info_extended() from fetching missing
1709 * blobs. This has a difference only if extensions.partialClone is set.
1711 * Its default value is 1.
1713 extern int fetch_if_missing;
1715 /* Dumb servers support */
1716 int update_server_info(int);
1718 const char *get_log_output_encoding(void);
1719 const char *get_commit_output_encoding(void);
1722 * This is a hack for test programs like test-dump-untracked-cache to
1723 * ensure that they do not modify the untracked cache when reading it.
1724 * Do not use it otherwise!
1726 extern int ignore_untracked_cache_config;
1728 int committer_ident_sufficiently_given(void);
1729 int author_ident_sufficiently_given(void);
1731 extern const char *git_commit_encoding;
1732 extern const char *git_log_output_encoding;
1733 extern const char *git_mailmap_file;
1734 extern const char *git_mailmap_blob;
1736 /* IO helper functions */
1737 void maybe_flush_or_die(FILE *, const char *);
1738 __attribute__((format (printf, 2, 3)))
1739 void fprintf_or_die(FILE *, const char *fmt, ...);
1741 #define COPY_READ_ERROR (-2)
1742 #define COPY_WRITE_ERROR (-3)
1743 int copy_fd(int ifd, int ofd);
1744 int copy_file(const char *dst, const char *src, int mode);
1745 int copy_file_with_time(const char *dst, const char *src, int mode);
1747 void write_or_die(int fd, const void *buf, size_t count);
1748 void fsync_or_die(int fd, const char *);
1750 ssize_t read_in_full(int fd, void *buf, size_t count);
1751 ssize_t write_in_full(int fd, const void *buf, size_t count);
1752 ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1754 static inline ssize_t write_str_in_full(int fd, const char *str)
1756 return write_in_full(fd, str, strlen(str));
1760 * Open (and truncate) the file at path, write the contents of buf to it,
1761 * and close it. Dies if any errors are encountered.
1763 void write_file_buf(const char *path, const char *buf, size_t len);
1766 * Like write_file_buf(), but format the contents into a buffer first.
1767 * Additionally, write_file() will append a newline if one is not already
1768 * present, making it convenient to write text files:
1770 * write_file(path, "counter: %d", ctr);
1772 __attribute__((format (printf, 2, 3)))
1773 void write_file(const char *path, const char *fmt, ...);
1776 void setup_pager(void);
1777 int pager_in_use(void);
1778 extern int pager_use_color;
1779 int term_columns(void);
1780 void term_clear_line(void);
1781 int decimal_width(uintmax_t);
1782 int check_pager_config(const char *cmd);
1783 void prepare_pager_args(struct child_process *, const char *pager);
1785 extern const char *editor_program;
1786 extern const char *askpass_program;
1787 extern const char *excludes_file;
1790 int decode_85(char *dst, const char *line, int linelen);
1791 void encode_85(char *buf, const unsigned char *data, int bytes);
1794 void packet_trace_identity(const char *prog);
1798 * return 0 if success, 1 - if addition of a file failed and
1799 * ADD_FILES_IGNORE_ERRORS was specified in flags
1801 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1804 extern int diff_auto_refresh_index;
1807 void shift_tree(struct repository *, const struct object_id *, const struct object_id *, struct object_id *, int);
1808 void shift_tree_by(struct repository *, const struct object_id *, const struct object_id *, struct object_id *, const char *);
1812 * used by both diff and apply
1813 * last two digits are tab width
1815 #define WS_BLANK_AT_EOL 0100
1816 #define WS_SPACE_BEFORE_TAB 0200
1817 #define WS_INDENT_WITH_NON_TAB 0400
1818 #define WS_CR_AT_EOL 01000
1819 #define WS_BLANK_AT_EOF 02000
1820 #define WS_TAB_IN_INDENT 04000
1821 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1822 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1823 #define WS_TAB_WIDTH_MASK 077
1824 /* All WS_* -- when extended, adapt diff.c emit_symbol */
1825 #define WS_RULE_MASK 07777
1826 extern unsigned whitespace_rule_cfg;
1827 unsigned whitespace_rule(struct index_state *, const char *);
1828 unsigned parse_whitespace_rule(const char *);
1829 unsigned ws_check(const char *line, int len, unsigned ws_rule);
1830 void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1831 char *whitespace_error_string(unsigned ws);
1832 void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1833 int ws_blank_line(const char *line, int len, unsigned ws_rule);
1834 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1837 void overlay_tree_on_index(struct index_state *istate,
1838 const char *tree_name, const char *prefix);
1841 struct startup_info {
1842 int have_repository;
1845 extern struct startup_info *startup_info;
1849 int try_merge_command(struct repository *r,
1850 const char *strategy, size_t xopts_nr,
1851 const char **xopts, struct commit_list *common,
1852 const char *head_arg, struct commit_list *remotes);
1853 int checkout_fast_forward(struct repository *r,
1854 const struct object_id *from,
1855 const struct object_id *to,
1856 int overwrite_ignore);
1859 int sane_execvp(const char *file, char *const argv[]);
1862 * A struct to encapsulate the concept of whether a file has changed
1863 * since we last checked it. This uses criteria similar to those used
1866 struct stat_validity {
1867 struct stat_data *sd;
1870 void stat_validity_clear(struct stat_validity *sv);
1873 * Returns 1 if the path is a regular file (or a symlink to a regular
1874 * file) and matches the saved stat_validity, 0 otherwise. A missing
1875 * or inaccessible file is considered a match if the struct was just
1876 * initialized, or if the previous update found an inaccessible file.
1878 int stat_validity_check(struct stat_validity *sv, const char *path);
1881 * Update the stat_validity from a file opened at descriptor fd. If
1882 * the file is missing, inaccessible, or not a regular file, then
1883 * future calls to stat_validity_check will match iff one of those
1884 * conditions continues to be true.
1886 void stat_validity_update(struct stat_validity *sv, int fd);
1888 int versioncmp(const char *s1, const char *s2);
1891 * Create a directory and (if share is nonzero) adjust its permissions
1892 * according to the shared_repository setting. Only use this for
1893 * directories under $GIT_DIR. Don't use it for working tree
1896 void safe_create_dir(const char *dir, int share);
1899 * Should we print an ellipsis after an abbreviated SHA-1 value
1900 * when doing diff-raw output or indicating a detached HEAD?
1902 int print_sha1_ellipsis(void);
1904 /* Return 1 if the file is empty or does not exists, 0 otherwise. */
1905 int is_empty_or_missing_file(const char *filename);
1907 #endif /* CACHE_H */