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"
21 typedef struct git_zstream
{
23 unsigned long avail_in
;
24 unsigned long avail_out
;
25 unsigned long total_in
;
26 unsigned long total_out
;
27 unsigned char *next_in
;
28 unsigned char *next_out
;
31 void git_inflate_init(git_zstream
*);
32 void git_inflate_init_gzip_only(git_zstream
*);
33 void git_inflate_end(git_zstream
*);
34 int git_inflate(git_zstream
*, int flush
);
36 void git_deflate_init(git_zstream
*, int level
);
37 void git_deflate_init_gzip(git_zstream
*, int level
);
38 void git_deflate_init_raw(git_zstream
*, int level
);
39 void git_deflate_end(git_zstream
*);
40 int git_deflate_abort(git_zstream
*);
41 int git_deflate_end_gently(git_zstream
*);
42 int git_deflate(git_zstream
*, int flush
);
43 unsigned long git_deflate_bound(git_zstream
*, unsigned long);
45 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
46 #define DTYPE(de) ((de)->d_type)
56 #define DTYPE(de) DT_UNKNOWN
59 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
60 #define S_IFINVALID 0030000
63 * A "directory link" is a link to another git directory.
65 * The value 0160000 is not normally a valid mode, and
66 * also just happens to be S_IFDIR + S_IFLNK
68 #define S_IFGITLINK 0160000
69 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
72 * Some mode bits are also used internally for computations.
74 * They *must* not overlap with any valid modes, and they *must* not be emitted
75 * to outside world - i.e. appear on disk or network. In other words, it's just
76 * temporary fields, which we internally use, but they have to stay in-house.
78 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
79 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
82 /* used internally in tree-diff */
83 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
87 * Intensive research over the course of many years has shown that
88 * port 9418 is totally unused by anything else. Or
90 * Your search - "port 9418" - did not match any documents.
92 * as www.google.com puts it.
94 * This port has been properly assigned for git use by IANA:
95 * git (Assigned-9418) [I06-050728-0001].
97 * git 9418/tcp git pack transfer service
98 * git 9418/udp git pack transfer service
100 * with Linus Torvalds <torvalds@osdl.org> as the point of
101 * contact. September 2005.
103 * See http://www.iana.org/assignments/port-numbers
105 #define DEFAULT_GIT_PORT 9418
108 * Basic data structures for the directory cache
111 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
112 struct cache_header
{
113 uint32_t hdr_signature
;
114 uint32_t hdr_version
;
115 uint32_t hdr_entries
;
118 #define INDEX_FORMAT_LB 2
119 #define INDEX_FORMAT_UB 4
122 * The "cache_time" is just the low 32 bits of the
123 * time. It doesn't matter if it overflows - we only
124 * check it for equality in the 32 bits we save.
132 struct cache_time sd_ctime
;
133 struct cache_time sd_mtime
;
138 unsigned int sd_size
;
142 struct hashmap_entry ent
;
143 struct stat_data ce_stat_data
;
144 unsigned int ce_mode
;
145 unsigned int ce_flags
;
146 unsigned int mem_pool_allocated
;
147 unsigned int ce_namelen
;
148 unsigned int index
; /* for link extension */
149 struct object_id oid
;
150 char name
[FLEX_ARRAY
]; /* more */
153 #define CE_STAGEMASK (0x3000)
154 #define CE_EXTENDED (0x4000)
155 #define CE_VALID (0x8000)
156 #define CE_STAGESHIFT 12
159 * Range 0xFFFF0FFF in ce_flags is divided into
160 * two parts: in-memory flags and on-disk ones.
161 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
162 * if you want to save a new flag, add it in
165 * In-memory only flags
167 #define CE_UPDATE (1 << 16)
168 #define CE_REMOVE (1 << 17)
169 #define CE_UPTODATE (1 << 18)
170 #define CE_ADDED (1 << 19)
172 #define CE_HASHED (1 << 20)
173 #define CE_FSMONITOR_VALID (1 << 21)
174 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
175 #define CE_CONFLICTED (1 << 23)
177 #define CE_UNPACKED (1 << 24)
178 #define CE_NEW_SKIP_WORKTREE (1 << 25)
180 /* used to temporarily mark paths matched by pathspecs */
181 #define CE_MATCHED (1 << 26)
183 #define CE_UPDATE_IN_BASE (1 << 27)
184 #define CE_STRIP_NAME (1 << 28)
187 * Extended on-disk flags
189 #define CE_INTENT_TO_ADD (1 << 29)
190 #define CE_SKIP_WORKTREE (1 << 30)
191 /* CE_EXTENDED2 is for future extension */
192 #define CE_EXTENDED2 (1U << 31)
194 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
197 * Safeguard to avoid saving wrong flags:
198 * - CE_EXTENDED2 won't get saved until its semantic is known
199 * - Bits in 0x0000FFFF have been saved in ce_flags already
200 * - Bits in 0x003F0000 are currently in-memory flags
202 #if CE_EXTENDED_FLAGS & 0x803FFFFF
203 #error "CE_EXTENDED_FLAGS out of range"
206 #define S_ISSPARSEDIR(m) ((m) == S_IFDIR)
208 /* Forward structure decls */
210 struct child_process
;
214 * Copy the sha1 and stat state of a cache entry from one to
215 * another. But we never change the name, or the hash state!
217 static inline void copy_cache_entry(struct cache_entry
*dst
,
218 const struct cache_entry
*src
)
220 unsigned int state
= dst
->ce_flags
& CE_HASHED
;
221 int mem_pool_allocated
= dst
->mem_pool_allocated
;
223 /* Don't copy hash chain and name */
224 memcpy(&dst
->ce_stat_data
, &src
->ce_stat_data
,
225 offsetof(struct cache_entry
, name
) -
226 offsetof(struct cache_entry
, ce_stat_data
));
228 /* Restore the hash state */
229 dst
->ce_flags
= (dst
->ce_flags
& ~CE_HASHED
) | state
;
231 /* Restore the mem_pool_allocated flag */
232 dst
->mem_pool_allocated
= mem_pool_allocated
;
235 static inline unsigned create_ce_flags(unsigned stage
)
237 return (stage
<< CE_STAGESHIFT
);
240 #define ce_namelen(ce) ((ce)->ce_namelen)
241 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
242 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
243 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
244 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
245 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
246 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
248 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
249 static inline unsigned int create_ce_mode(unsigned int mode
)
253 if (S_ISSPARSEDIR(mode
))
255 if (S_ISDIR(mode
) || S_ISGITLINK(mode
))
257 return S_IFREG
| ce_permissions(mode
);
259 static inline unsigned int ce_mode_from_stat(const struct cache_entry
*ce
,
262 extern int trust_executable_bit
, has_symlinks
;
263 if (!has_symlinks
&& S_ISREG(mode
) &&
264 ce
&& S_ISLNK(ce
->ce_mode
))
266 if (!trust_executable_bit
&& S_ISREG(mode
)) {
267 if (ce
&& S_ISREG(ce
->ce_mode
))
269 return create_ce_mode(0666);
271 return create_ce_mode(mode
);
273 static inline int ce_to_dtype(const struct cache_entry
*ce
)
275 unsigned ce_mode
= ntohl(ce
->ce_mode
);
276 if (S_ISREG(ce_mode
))
278 else if (S_ISDIR(ce_mode
) || S_ISGITLINK(ce_mode
))
280 else if (S_ISLNK(ce_mode
))
285 static inline unsigned int canon_mode(unsigned int mode
)
288 return S_IFREG
| ce_permissions(mode
);
296 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
298 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
299 #define CE_ENTRY_CHANGED (1 << 1)
300 #define CE_ENTRY_REMOVED (1 << 2)
301 #define CE_ENTRY_ADDED (1 << 3)
302 #define RESOLVE_UNDO_CHANGED (1 << 4)
303 #define CACHE_TREE_CHANGED (1 << 5)
304 #define SPLIT_INDEX_ORDERED (1 << 6)
305 #define UNTRACKED_CHANGED (1 << 7)
306 #define FSMONITOR_CHANGED (1 << 8)
309 struct untracked_cache
;
313 enum sparse_index_mode
{
315 * There are no sparse directories in the index at all.
317 * Repositories that don't use cone-mode sparse-checkout will
318 * always have their indexes in this mode.
323 * The index has already been collapsed to sparse directories
324 * whereever possible.
329 * The sparse directories that exist are outside the
330 * sparse-checkout boundary, but it is possible that some file
331 * entries could collapse to sparse directory entries.
333 INDEX_PARTIALLY_SPARSE
,
337 struct cache_entry
**cache
;
338 unsigned int version
;
339 unsigned int cache_nr
, cache_alloc
, cache_changed
;
340 struct string_list
*resolve_undo
;
341 struct cache_tree
*cache_tree
;
342 struct split_index
*split_index
;
343 struct cache_time timestamp
;
344 unsigned name_hash_initialized
: 1,
348 updated_skipworktree
: 1,
349 fsmonitor_has_run_once
: 1;
350 enum sparse_index_mode sparse_index
;
351 struct hashmap name_hash
;
352 struct hashmap dir_hash
;
353 struct object_id oid
;
354 struct untracked_cache
*untracked
;
355 char *fsmonitor_last_update
;
356 struct ewah_bitmap
*fsmonitor_dirty
;
357 struct mem_pool
*ce_mem_pool
;
358 struct progress
*progress
;
359 struct repository
*repo
;
360 struct pattern_list
*sparse_checkout_patterns
;
364 * A "struct index_state istate" must be initialized with
365 * INDEX_STATE_INIT or the corresponding index_state_init().
367 * If the variable won't be used again, use release_index() to free()
368 * its resources. If it needs to be used again use discard_index(),
369 * which does the same thing, but will use use index_state_init() at
370 * the end. The discard_index() will use its own "istate->repo" as the
371 * "r" argument to index_state_init() in that case.
373 #define INDEX_STATE_INIT(r) { \
376 void index_state_init(struct index_state
*istate
, struct repository
*r
);
377 void release_index(struct index_state
*istate
);
380 int test_lazy_init_name_hash(struct index_state
*istate
, int try_threaded
);
381 void add_name_hash(struct index_state
*istate
, struct cache_entry
*ce
);
382 void remove_name_hash(struct index_state
*istate
, struct cache_entry
*ce
);
383 void free_name_hash(struct index_state
*istate
);
385 /* Cache entry creation and cleanup */
388 * Create cache_entry intended for use in the specified index. Caller
389 * is responsible for discarding the cache_entry with
390 * `discard_cache_entry`.
392 struct cache_entry
*make_cache_entry(struct index_state
*istate
,
394 const struct object_id
*oid
,
397 unsigned int refresh_options
);
399 struct cache_entry
*make_empty_cache_entry(struct index_state
*istate
,
403 * Create a cache_entry that is not intended to be added to an index. If
404 * `ce_mem_pool` is not NULL, the entry is allocated within the given memory
405 * pool. Caller is responsible for discarding "loose" entries with
406 * `discard_cache_entry()` and the memory pool with
407 * `mem_pool_discard(ce_mem_pool, should_validate_cache_entries())`.
409 struct cache_entry
*make_transient_cache_entry(unsigned int mode
,
410 const struct object_id
*oid
,
413 struct mem_pool
*ce_mem_pool
);
415 struct cache_entry
*make_empty_transient_cache_entry(size_t len
,
416 struct mem_pool
*ce_mem_pool
);
419 * Discard cache entry.
421 void discard_cache_entry(struct cache_entry
*ce
);
424 * Check configuration if we should perform extra validation on cache
427 int should_validate_cache_entries(void);
430 * Duplicate a cache_entry. Allocate memory for the new entry from a
431 * memory_pool. Takes into account cache_entry fields that are meant
432 * for managing the underlying memory allocation of the cache_entry.
434 struct cache_entry
*dup_cache_entry(const struct cache_entry
*ce
, struct index_state
*istate
);
437 * Validate the cache entries in the index. This is an internal
438 * consistency check that the cache_entry structs are allocated from
439 * the expected memory pool.
441 void validate_cache_entries(const struct index_state
*istate
);
444 * Bulk prefetch all missing cache entries that are not GITLINKs and that match
445 * the given predicate. This function should only be called if
446 * has_promisor_remote() returns true.
448 typedef int (*must_prefetch_predicate
)(const struct cache_entry
*);
449 void prefetch_cache_entries(const struct index_state
*istate
,
450 must_prefetch_predicate must_prefetch
);
452 #ifdef USE_THE_INDEX_VARIABLE
453 extern struct index_state the_index
;
459 * Values in this enum (except those outside the 3 bit range) are part
460 * of pack file format. See gitformat-pack(5) for more information.
469 /* 5 for future expansion */
476 static inline enum object_type
object_type(unsigned int mode
)
478 return S_ISDIR(mode
) ? OBJ_TREE
:
479 S_ISGITLINK(mode
) ? OBJ_COMMIT
:
483 /* Double-check local_repo_env below if you add to this list. */
484 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
485 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
486 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
487 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
488 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
489 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
490 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
491 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
492 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
493 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
494 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
495 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
496 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
497 #define CONFIG_COUNT_ENVIRONMENT "GIT_CONFIG_COUNT"
498 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
499 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
500 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
501 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
502 #define GITATTRIBUTES_FILE ".gitattributes"
503 #define INFOATTRIBUTES_FILE "info/attributes"
504 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
505 #define GITMODULES_FILE ".gitmodules"
506 #define GITMODULES_INDEX ":.gitmodules"
507 #define GITMODULES_HEAD "HEAD:.gitmodules"
508 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
509 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
510 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
511 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
512 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
513 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
514 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
515 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
516 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
517 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
518 #define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
519 #define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT "GIT_TEXTDOMAINDIR"
522 * Environment variable used in handshaking the wire protocol.
523 * Contains a colon ':' separated list of keys with optional values
524 * 'key[=value]'. Presence of unknown keys and values must be
527 #define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
528 /* HTTP header used to handshake the wire protocol */
529 #define GIT_PROTOCOL_HEADER "Git-Protocol"
532 * This environment variable is expected to contain a boolean indicating
533 * whether we should or should not treat:
535 * GIT_DIR=foo.git git ...
537 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
538 * of this, but we use it internally to communicate to sub-processes that we
539 * are in a bare repo. If not set, defaults to true.
541 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
544 * Repository-local GIT_* environment variables; these will be cleared
545 * when git spawns a sub-process that runs inside another repository.
546 * The array is NULL-terminated, which makes it easy to pass in the "env"
547 * parameter of a run-command invocation, or to do a simple walk.
549 extern const char * const local_repo_env
[];
551 void setup_git_env(const char *git_dir
);
554 * Returns true iff we have a configured git repository (either via
555 * setup_git_directory, or in the environment via $GIT_DIR).
557 int have_git_dir(void);
559 extern int is_bare_repository_cfg
;
560 int is_bare_repository(void);
561 int is_inside_git_dir(void);
562 extern char *git_work_tree_cfg
;
563 int is_inside_work_tree(void);
564 const char *get_git_dir(void);
565 const char *get_git_common_dir(void);
566 const char *get_object_directory(void);
567 char *get_index_file(void);
568 char *get_graft_file(struct repository
*r
);
569 void set_git_dir(const char *path
, int make_realpath
);
570 int get_common_dir_noenv(struct strbuf
*sb
, const char *gitdir
);
571 int get_common_dir(struct strbuf
*sb
, const char *gitdir
);
572 const char *get_git_namespace(void);
573 const char *strip_namespace(const char *namespaced_ref
);
574 const char *get_git_work_tree(void);
577 * Return true if the given path is a git directory; note that this _just_
578 * looks at the directory itself. If you want to know whether "foo/.git"
579 * is a repository, you must feed that path, not just "foo".
581 int is_git_directory(const char *path
);
584 * Return 1 if the given path is the root of a git repository or
585 * submodule, else 0. Will not return 1 for bare repositories with the
586 * exception of creating a bare repository in "foo/.git" and calling
587 * is_git_repository("foo").
589 * If we run into read errors, we err on the side of saying "yes, it is",
590 * as we usually consider sub-repos precious, and would prefer to err on the
591 * side of not disrupting or deleting them.
593 int is_nonbare_repository_dir(struct strbuf
*path
);
595 #define READ_GITFILE_ERR_STAT_FAILED 1
596 #define READ_GITFILE_ERR_NOT_A_FILE 2
597 #define READ_GITFILE_ERR_OPEN_FAILED 3
598 #define READ_GITFILE_ERR_READ_FAILED 4
599 #define READ_GITFILE_ERR_INVALID_FORMAT 5
600 #define READ_GITFILE_ERR_NO_PATH 6
601 #define READ_GITFILE_ERR_NOT_A_REPO 7
602 #define READ_GITFILE_ERR_TOO_LARGE 8
603 void read_gitfile_error_die(int error_code
, const char *path
, const char *dir
);
604 const char *read_gitfile_gently(const char *path
, int *return_error_code
);
605 #define read_gitfile(path) read_gitfile_gently((path), NULL)
606 const char *resolve_gitdir_gently(const char *suspect
, int *return_error_code
);
607 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
609 void set_git_work_tree(const char *tree
);
611 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
613 void setup_work_tree(void);
615 * Find the commondir and gitdir of the repository that contains the current
616 * working directory, without changing the working directory or other global
617 * state. The result is appended to commondir and gitdir. If the discovered
618 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
619 * both have the same result appended to the buffer. The return value is
620 * either 0 upon success and non-zero if no repository was found.
622 int discover_git_directory(struct strbuf
*commondir
,
623 struct strbuf
*gitdir
);
624 const char *setup_git_directory_gently(int *);
625 const char *setup_git_directory(void);
626 char *prefix_path(const char *prefix
, int len
, const char *path
);
627 char *prefix_path_gently(const char *prefix
, int len
, int *remaining
, const char *path
);
630 * Concatenate "prefix" (if len is non-zero) and "path", with no
631 * connecting characters (so "prefix" should end with a "/").
632 * Unlike prefix_path, this should be used if the named file does
633 * not have to interact with index entry; i.e. name of a random file
636 * The return value is always a newly allocated string (even if the
639 char *prefix_filename(const char *prefix
, const char *path
);
641 int check_filename(const char *prefix
, const char *name
);
642 void verify_filename(const char *prefix
,
644 int diagnose_misspelt_rev
);
645 void verify_non_filename(const char *prefix
, const char *name
);
646 int path_inside_repo(const char *prefix
, const char *path
);
648 #define INIT_DB_QUIET 0x0001
649 #define INIT_DB_EXIST_OK 0x0002
651 int init_db(const char *git_dir
, const char *real_git_dir
,
652 const char *template_dir
, int hash_algo
,
653 const char *initial_branch
, unsigned int flags
);
654 void initialize_repository_version(int hash_algo
, int reinit
);
656 void sanitize_stdfds(void);
659 /* Initialize and use the cache information */
661 void preload_index(struct index_state
*index
,
662 const struct pathspec
*pathspec
,
663 unsigned int refresh_flags
);
664 int do_read_index(struct index_state
*istate
, const char *path
,
665 int must_exist
); /* for testting only! */
666 int read_index_from(struct index_state
*, const char *path
,
668 int is_index_unborn(struct index_state
*);
670 void ensure_full_index(struct index_state
*istate
);
672 /* For use with `write_locked_index()`. */
673 #define COMMIT_LOCK (1 << 0)
674 #define SKIP_IF_UNCHANGED (1 << 1)
677 * Write the index while holding an already-taken lock. Close the lock,
678 * and if `COMMIT_LOCK` is given, commit it.
680 * Unless a split index is in use, write the index into the lockfile.
682 * With a split index, write the shared index to a temporary file,
683 * adjust its permissions and rename it into place, then write the
684 * split index to the lockfile. If the temporary file for the shared
685 * index cannot be created, fall back to the behavior described in
686 * the previous paragraph.
688 * With `COMMIT_LOCK`, the lock is always committed or rolled back.
689 * Without it, the lock is closed, but neither committed nor rolled
692 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing
693 * is written (and the lock is rolled back if `COMMIT_LOCK` is given).
695 int write_locked_index(struct index_state
*, struct lock_file
*lock
, unsigned flags
);
697 void discard_index(struct index_state
*);
698 void move_index_extensions(struct index_state
*dst
, struct index_state
*src
);
699 int unmerged_index(const struct index_state
*);
702 * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL,
703 * compares istate to HEAD. If tree is NULL and on an unborn branch,
704 * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is
705 * provided, the space-separated list of files that differ will be appended
708 int repo_index_has_changes(struct repository
*repo
,
712 int verify_path(const char *path
, unsigned mode
);
713 int strcmp_offset(const char *s1
, const char *s2
, size_t *first_change
);
714 int index_dir_exists(struct index_state
*istate
, const char *name
, int namelen
);
715 void adjust_dirname_case(struct index_state
*istate
, char *name
);
716 struct cache_entry
*index_file_exists(struct index_state
*istate
, const char *name
, int namelen
, int igncase
);
719 * Searches for an entry defined by name and namelen in the given index.
720 * If the return value is positive (including 0) it is the position of an
721 * exact match. If the return value is negative, the negated value minus 1
722 * is the position where the entry would be inserted.
723 * Example: The current index consists of these files and its stages:
727 * index_name_pos(&index, "a", 1) -> -1
728 * index_name_pos(&index, "b", 1) -> 0
729 * index_name_pos(&index, "c", 1) -> -2
730 * index_name_pos(&index, "d", 1) -> 1
731 * index_name_pos(&index, "e", 1) -> -3
732 * index_name_pos(&index, "f", 1) -> -3
733 * index_name_pos(&index, "g", 1) -> -5
735 int index_name_pos(struct index_state
*, const char *name
, int namelen
);
738 * Like index_name_pos, returns the position of an entry of the given name in
739 * the index if one exists, otherwise returns a negative value where the negated
740 * value minus 1 is the position where the index entry would be inserted. Unlike
741 * index_name_pos, however, a sparse index is not expanded to find an entry
742 * inside a sparse directory.
744 int index_name_pos_sparse(struct index_state
*, const char *name
, int namelen
);
747 * Determines whether an entry with the given name exists within the
748 * given index. The return value is 1 if an exact match is found, otherwise
749 * it is 0. Note that, unlike index_name_pos, this function does not expand
750 * the index if it is sparse. If an item exists within the full index but it
751 * is contained within a sparse directory (and not in the sparse index), 0 is
754 int index_entry_exists(struct index_state
*, const char *name
, int namelen
);
757 * Some functions return the negative complement of an insert position when a
758 * precise match was not found but a position was found where the entry would
759 * need to be inserted. This helper protects that logic from any integer
762 static inline int index_pos_to_insert_pos(uintmax_t pos
)
765 die("overflow: -1 - %"PRIuMAX
, pos
);
766 return -1 - (int)pos
;
769 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
770 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
771 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
772 #define ADD_CACHE_JUST_APPEND 8 /* Append only */
773 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
774 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
775 #define ADD_CACHE_RENORMALIZE 64 /* Pass along HASH_RENORMALIZE */
776 int add_index_entry(struct index_state
*, struct cache_entry
*ce
, int option
);
777 void rename_index_entry_at(struct index_state
*, int pos
, const char *new_name
);
779 /* Remove entry, return true if there are more entries to go. */
780 int remove_index_entry_at(struct index_state
*, int pos
);
782 void remove_marked_cache_entries(struct index_state
*istate
, int invalidate
);
783 int remove_file_from_index(struct index_state
*, const char *path
);
784 #define ADD_CACHE_VERBOSE 1
785 #define ADD_CACHE_PRETEND 2
786 #define ADD_CACHE_IGNORE_ERRORS 4
787 #define ADD_CACHE_IGNORE_REMOVAL 8
788 #define ADD_CACHE_INTENT 16
790 * These two are used to add the contents of the file at path
791 * to the index, marking the working tree up-to-date by storing
792 * the cached stat info in the resulting cache entry. A caller
793 * that has already run lstat(2) on the path can call
794 * add_to_index(), and all others can call add_file_to_index();
795 * the latter will do necessary lstat(2) internally before
796 * calling the former.
798 int add_to_index(struct index_state
*, const char *path
, struct stat
*, int flags
);
799 int add_file_to_index(struct index_state
*, const char *path
, int flags
);
801 int chmod_index_entry(struct index_state
*, struct cache_entry
*ce
, char flip
);
802 int ce_same_name(const struct cache_entry
*a
, const struct cache_entry
*b
);
803 void set_object_name_for_intent_to_add_entry(struct cache_entry
*ce
);
804 int index_name_is_other(struct index_state
*, const char *, int);
805 void *read_blob_data_from_index(struct index_state
*, const char *, unsigned long *);
807 /* do stat comparison even if CE_VALID is true */
808 #define CE_MATCH_IGNORE_VALID 01
809 /* do not check the contents but report dirty on racily-clean entries */
810 #define CE_MATCH_RACY_IS_DIRTY 02
811 /* do stat comparison even if CE_SKIP_WORKTREE is true */
812 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
813 /* ignore non-existent files during stat update */
814 #define CE_MATCH_IGNORE_MISSING 0x08
815 /* enable stat refresh */
816 #define CE_MATCH_REFRESH 0x10
817 /* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
818 #define CE_MATCH_IGNORE_FSMONITOR 0X20
819 int is_racy_timestamp(const struct index_state
*istate
,
820 const struct cache_entry
*ce
);
821 int has_racy_timestamp(struct index_state
*istate
);
822 int ie_match_stat(struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
823 int ie_modified(struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
825 #define HASH_WRITE_OBJECT 1
826 #define HASH_FORMAT_CHECK 2
827 #define HASH_RENORMALIZE 4
828 #define HASH_SILENT 8
829 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
);
830 int index_path(struct index_state
*istate
, struct object_id
*oid
, const char *path
, struct stat
*st
, unsigned flags
);
833 * Record to sd the data from st that we use to check whether a file
834 * might have changed.
836 void fill_stat_data(struct stat_data
*sd
, struct stat
*st
);
839 * Return 0 if st is consistent with a file not having been changed
840 * since sd was filled. If there are differences, return a
841 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
842 * INODE_CHANGED, and DATA_CHANGED.
844 int match_stat_data(const struct stat_data
*sd
, struct stat
*st
);
845 int match_stat_data_racy(const struct index_state
*istate
,
846 const struct stat_data
*sd
, struct stat
*st
);
848 void fill_stat_cache_info(struct index_state
*istate
, struct cache_entry
*ce
, struct stat
*st
);
850 #define REFRESH_REALLY (1 << 0) /* ignore_valid */
851 #define REFRESH_UNMERGED (1 << 1) /* allow unmerged */
852 #define REFRESH_QUIET (1 << 2) /* be quiet about it */
853 #define REFRESH_IGNORE_MISSING (1 << 3) /* ignore non-existent */
854 #define REFRESH_IGNORE_SUBMODULES (1 << 4) /* ignore submodules */
855 #define REFRESH_IN_PORCELAIN (1 << 5) /* user friendly output, not "needs update" */
856 #define REFRESH_PROGRESS (1 << 6) /* show progress bar if stderr is tty */
857 #define REFRESH_IGNORE_SKIP_WORKTREE (1 << 7) /* ignore skip_worktree entries */
858 int refresh_index(struct index_state
*, unsigned int flags
, const struct pathspec
*pathspec
, char *seen
, const char *header_msg
);
860 * Refresh the index and write it to disk.
862 * 'refresh_flags' is passed directly to 'refresh_index()', while
863 * 'COMMIT_LOCK | write_flags' is passed to 'write_locked_index()', so
864 * the lockfile is always either committed or rolled back.
866 * If 'gentle' is passed, errors locking the index are ignored.
868 * Return 1 if refreshing the index returns an error, -1 if writing
869 * the index to disk fails, 0 on success.
871 * Note that if refreshing the index returns an error, we still write
872 * out the index (unless locking fails).
874 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
);
876 struct cache_entry
*refresh_cache_entry(struct index_state
*, struct cache_entry
*, unsigned int);
878 void set_alternate_index_output(const char *);
880 extern int verify_index_checksum
;
881 extern int verify_ce_order
;
883 /* Environment bits from configuration mechanism */
884 extern int trust_executable_bit
;
885 extern int trust_ctime
;
886 extern int check_stat
;
887 extern int quote_path_fully
;
888 extern int has_symlinks
;
889 extern int minimum_abbrev
, default_abbrev
;
890 extern int ignore_case
;
891 extern int assume_unchanged
;
892 extern int prefer_symlink_refs
;
893 extern int warn_ambiguous_refs
;
894 extern int warn_on_object_refname_ambiguity
;
895 extern char *apply_default_whitespace
;
896 extern char *apply_default_ignorewhitespace
;
897 extern const char *git_attributes_file
;
898 extern const char *git_hooks_path
;
899 extern int zlib_compression_level
;
900 extern int pack_compression_level
;
901 extern size_t packed_git_window_size
;
902 extern size_t packed_git_limit
;
903 extern size_t delta_base_cache_limit
;
904 extern unsigned long big_file_threshold
;
905 extern unsigned long pack_size_limit_cfg
;
908 * Accessors for the core.sharedrepository config which lazy-load the value
909 * from the config (if not already set). The "reset" function can be
910 * used to unset "set" or cached value, meaning that the value will be loaded
911 * fresh from the config file on the next call to get_shared_repository().
913 void set_shared_repository(int value
);
914 int get_shared_repository(void);
915 void reset_shared_repository(void);
918 * Do replace refs need to be checked this run? This variable is
919 * initialized to true unless --no-replace-object is used or
920 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
921 * commands that do not want replace references to be active.
923 extern int read_replace_refs
;
926 * These values are used to help identify parts of a repository to fsync.
927 * FSYNC_COMPONENT_NONE identifies data that will not be a persistent part of the
928 * repository and so shouldn't be fsynced.
930 enum fsync_component
{
931 FSYNC_COMPONENT_NONE
,
932 FSYNC_COMPONENT_LOOSE_OBJECT
= 1 << 0,
933 FSYNC_COMPONENT_PACK
= 1 << 1,
934 FSYNC_COMPONENT_PACK_METADATA
= 1 << 2,
935 FSYNC_COMPONENT_COMMIT_GRAPH
= 1 << 3,
936 FSYNC_COMPONENT_INDEX
= 1 << 4,
937 FSYNC_COMPONENT_REFERENCE
= 1 << 5,
940 #define FSYNC_COMPONENTS_OBJECTS (FSYNC_COMPONENT_LOOSE_OBJECT | \
941 FSYNC_COMPONENT_PACK)
943 #define FSYNC_COMPONENTS_DERIVED_METADATA (FSYNC_COMPONENT_PACK_METADATA | \
944 FSYNC_COMPONENT_COMMIT_GRAPH)
946 #define FSYNC_COMPONENTS_DEFAULT ((FSYNC_COMPONENTS_OBJECTS | \
947 FSYNC_COMPONENTS_DERIVED_METADATA) & \
948 ~FSYNC_COMPONENT_LOOSE_OBJECT)
950 #define FSYNC_COMPONENTS_COMMITTED (FSYNC_COMPONENTS_OBJECTS | \
951 FSYNC_COMPONENT_REFERENCE)
953 #define FSYNC_COMPONENTS_ADDED (FSYNC_COMPONENTS_COMMITTED | \
954 FSYNC_COMPONENT_INDEX)
956 #define FSYNC_COMPONENTS_ALL (FSYNC_COMPONENT_LOOSE_OBJECT | \
957 FSYNC_COMPONENT_PACK | \
958 FSYNC_COMPONENT_PACK_METADATA | \
959 FSYNC_COMPONENT_COMMIT_GRAPH | \
960 FSYNC_COMPONENT_INDEX | \
961 FSYNC_COMPONENT_REFERENCE)
963 #ifndef FSYNC_COMPONENTS_PLATFORM_DEFAULT
964 #define FSYNC_COMPONENTS_PLATFORM_DEFAULT FSYNC_COMPONENTS_DEFAULT
968 * A bitmask indicating which components of the repo should be fsynced.
970 extern enum fsync_component fsync_components
;
971 extern int fsync_object_files
;
972 extern int use_fsync
;
976 FSYNC_METHOD_WRITEOUT_ONLY
,
980 extern enum fsync_method fsync_method
;
981 extern int core_preload_index
;
982 extern int precomposed_unicode
;
983 extern int protect_hfs
;
984 extern int protect_ntfs
;
986 extern int core_apply_sparse_checkout
;
987 extern int core_sparse_checkout_cone
;
988 extern int sparse_expect_files_outside_of_patterns
;
991 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
993 int use_optional_locks(void);
996 * The character that begins a commented line in user-editable file
997 * that is subject to stripspace.
999 extern char comment_line_char
;
1000 extern int auto_comment_line_char
;
1002 enum log_refs_config
{
1003 LOG_REFS_UNSET
= -1,
1008 extern enum log_refs_config log_all_ref_updates
;
1010 enum rebase_setup_type
{
1011 AUTOREBASE_NEVER
= 0,
1017 enum push_default_type
{
1018 PUSH_DEFAULT_NOTHING
= 0,
1019 PUSH_DEFAULT_MATCHING
,
1020 PUSH_DEFAULT_SIMPLE
,
1021 PUSH_DEFAULT_UPSTREAM
,
1022 PUSH_DEFAULT_CURRENT
,
1023 PUSH_DEFAULT_UNSPECIFIED
1026 extern enum rebase_setup_type autorebase
;
1027 extern enum push_default_type push_default
;
1029 enum object_creation_mode
{
1030 OBJECT_CREATION_USES_HARDLINKS
= 0,
1031 OBJECT_CREATION_USES_RENAMES
= 1
1034 extern enum object_creation_mode object_creation_mode
;
1036 extern char *notes_ref_name
;
1038 extern int grafts_replace_parents
;
1041 * GIT_REPO_VERSION is the version we write by default. The
1042 * _READ variant is the highest number we know how to
1045 #define GIT_REPO_VERSION 0
1046 #define GIT_REPO_VERSION_READ 1
1047 extern int repository_format_precious_objects
;
1048 extern int repository_format_worktree_config
;
1051 * You _have_ to initialize a `struct repository_format` using
1052 * `= REPOSITORY_FORMAT_INIT` before calling `read_repository_format()`.
1054 struct repository_format
{
1056 int precious_objects
;
1057 char *partial_clone
; /* value of extensions.partialclone */
1058 int worktree_config
;
1063 struct string_list unknown_extensions
;
1064 struct string_list v1_only_extensions
;
1068 * Always use this to initialize a `struct repository_format`
1069 * to a well-defined, default state before calling
1070 * `read_repository()`.
1072 #define REPOSITORY_FORMAT_INIT \
1076 .hash_algo = GIT_HASH_SHA1, \
1077 .unknown_extensions = STRING_LIST_INIT_DUP, \
1078 .v1_only_extensions = STRING_LIST_INIT_DUP, \
1082 * Read the repository format characteristics from the config file "path" into
1083 * "format" struct. Returns the numeric version. On error, or if no version is
1084 * found in the configuration, -1 is returned, format->version is set to -1,
1085 * and all other fields in the struct are set to the default configuration
1086 * (REPOSITORY_FORMAT_INIT). Always initialize the struct using
1087 * REPOSITORY_FORMAT_INIT before calling this function.
1089 int read_repository_format(struct repository_format
*format
, const char *path
);
1092 * Free the memory held onto by `format`, but not the struct itself.
1093 * (No need to use this after `read_repository_format()` fails.)
1095 void clear_repository_format(struct repository_format
*format
);
1098 * Verify that the repository described by repository_format is something we
1099 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
1100 * any errors encountered.
1102 int verify_repository_format(const struct repository_format
*format
,
1103 struct strbuf
*err
);
1106 * Check the repository format version in the path found in get_git_dir(),
1107 * and die if it is a version we don't understand. Generally one would
1108 * set_git_dir() before calling this, and use it only for "are we in a valid
1111 * If successful and fmt is not NULL, fill fmt with data.
1113 void check_repository_format(struct repository_format
*fmt
);
1115 #define MTIME_CHANGED 0x0001
1116 #define CTIME_CHANGED 0x0002
1117 #define OWNER_CHANGED 0x0004
1118 #define MODE_CHANGED 0x0008
1119 #define INODE_CHANGED 0x0010
1120 #define DATA_CHANGED 0x0020
1121 #define TYPE_CHANGED 0x0040
1124 * Return an abbreviated sha1 unique within this repository's object database.
1125 * The result will be at least `len` characters long, and will be NUL
1128 * The non-`_r` version returns a static buffer which remains valid until 4
1129 * more calls to find_unique_abbrev are made.
1131 * The `_r` variant writes to a buffer supplied by the caller, which must be at
1132 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes
1133 * written (excluding the NUL terminator).
1135 * Note that while this version avoids the static buffer, it is not fully
1136 * reentrant, as it calls into other non-reentrant git code.
1138 const char *repo_find_unique_abbrev(struct repository
*r
, const struct object_id
*oid
, int len
);
1139 #define find_unique_abbrev(oid, len) repo_find_unique_abbrev(the_repository, oid, len)
1140 int repo_find_unique_abbrev_r(struct repository
*r
, char *hex
, const struct object_id
*oid
, int len
);
1141 #define find_unique_abbrev_r(hex, oid, len) repo_find_unique_abbrev_r(the_repository, hex, oid, len)
1143 /* set default permissions by passing mode arguments to open(2) */
1144 int git_mkstemps_mode(char *pattern
, int suffix_len
, int mode
);
1145 int git_mkstemp_mode(char *pattern
, int mode
);
1150 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1151 * not be changed. Old repositories have core.sharedrepository written in
1152 * numeric format, and therefore these values are preserved for compatibility
1158 OLD_PERM_EVERYBODY
= 2,
1160 PERM_EVERYBODY
= 0664
1162 int git_config_perm(const char *var
, const char *value
);
1163 int adjust_shared_perm(const char *path
);
1166 * Create the directory containing the named path, using care to be
1167 * somewhat safe against races. Return one of the scld_error values to
1168 * indicate success/failure. On error, set errno to describe the
1171 * SCLD_VANISHED indicates that one of the ancestor directories of the
1172 * path existed at one point during the function call and then
1173 * suddenly vanished, probably because another process pruned the
1174 * directory while we were working. To be robust against this kind of
1175 * race, callers might want to try invoking the function again when it
1176 * returns SCLD_VANISHED.
1178 * safe_create_leading_directories() temporarily changes path while it
1179 * is working but restores it before returning.
1180 * safe_create_leading_directories_const() doesn't modify path, even
1181 * temporarily. Both these variants adjust the permissions of the
1182 * created directories to honor core.sharedRepository, so they are best
1183 * suited for files inside the git dir. For working tree files, use
1184 * safe_create_leading_directories_no_share() instead, as it ignores
1185 * the core.sharedRepository setting.
1194 enum scld_error
safe_create_leading_directories(char *path
);
1195 enum scld_error
safe_create_leading_directories_const(const char *path
);
1196 enum scld_error
safe_create_leading_directories_no_share(char *path
);
1198 int mkdir_in_gitdir(const char *path
);
1199 char *interpolate_path(const char *path
, int real_home
);
1200 /* NEEDSWORK: remove this synonym once in-flight topics have migrated */
1201 #define expand_user_path interpolate_path
1202 const char *enter_repo(const char *path
, int strict
);
1203 static inline int is_absolute_path(const char *path
)
1205 return is_dir_sep(path
[0]) || has_dos_drive_prefix(path
);
1207 int is_directory(const char *);
1208 char *strbuf_realpath(struct strbuf
*resolved
, const char *path
,
1210 char *strbuf_realpath_forgiving(struct strbuf
*resolved
, const char *path
,
1212 char *real_pathdup(const char *path
, int die_on_error
);
1213 const char *absolute_path(const char *path
);
1214 char *absolute_pathdup(const char *path
);
1215 const char *remove_leading_path(const char *in
, const char *prefix
);
1216 const char *relative_path(const char *in
, const char *prefix
, struct strbuf
*sb
);
1217 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
);
1218 int normalize_path_copy(char *dst
, const char *src
);
1219 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
);
1220 char *strip_path_suffix(const char *path
, const char *suffix
);
1221 int daemon_avoid_alias(const char *path
);
1224 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for
1227 int is_ntfs_dotgit(const char *name
);
1228 int is_ntfs_dotgitmodules(const char *name
);
1229 int is_ntfs_dotgitignore(const char *name
);
1230 int is_ntfs_dotgitattributes(const char *name
);
1231 int is_ntfs_dotmailmap(const char *name
);
1234 * Returns true iff "str" could be confused as a command-line option when
1235 * passed to a sub-program like "ssh". Note that this has nothing to do with
1236 * shell-quoting, which should be handled separately; we're assuming here that
1237 * the string makes it verbatim to the sub-program.
1239 int looks_like_command_line_option(const char *str
);
1242 * Return a newly allocated string with the evaluation of
1243 * "$XDG_CONFIG_HOME/$subdir/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1244 * "$HOME/.config/$subdir/$filename". Return NULL upon error.
1246 char *xdg_config_home_for(const char *subdir
, const char *filename
);
1249 * Return a newly allocated string with the evaluation of
1250 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1251 * "$HOME/.config/git/$filename". Return NULL upon error.
1253 char *xdg_config_home(const char *filename
);
1256 * Return a newly allocated string with the evaluation of
1257 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1258 * "$HOME/.cache/git/$filename". Return NULL upon error.
1260 char *xdg_cache_home(const char *filename
);
1262 int git_open_cloexec(const char *name
, int flags
);
1263 #define git_open(name) git_open_cloexec(name, O_RDONLY)
1266 * unpack_loose_header() initializes the data stream needed to unpack
1267 * a loose object header.
1271 * - ULHR_OK on success
1272 * - ULHR_BAD on error
1273 * - ULHR_TOO_LONG if the header was too long
1275 * It will only parse up to MAX_HEADER_LEN bytes unless an optional
1276 * "hdrbuf" argument is non-NULL. This is intended for use with
1277 * OBJECT_INFO_ALLOW_UNKNOWN_TYPE to extract the bad type for (error)
1278 * reporting. The full header will be extracted to "hdrbuf" for use
1279 * with parse_loose_header(), ULHR_TOO_LONG will still be returned
1280 * from this function to indicate that the header was too long.
1282 enum unpack_loose_header_result
{
1287 enum unpack_loose_header_result
unpack_loose_header(git_zstream
*stream
,
1289 unsigned long mapsize
,
1291 unsigned long bufsiz
,
1292 struct strbuf
*hdrbuf
);
1295 * parse_loose_header() parses the starting "<type> <len>\0" of an
1296 * object. If it doesn't follow that format -1 is returned. To check
1297 * the validity of the <type> populate the "typep" in the "struct
1298 * object_info". It will be OBJ_BAD if the object type is unknown. The
1299 * parsed <len> can be retrieved via "oi->sizep", and from there
1300 * passed to unpack_loose_rest().
1303 int parse_loose_header(const char *hdr
, struct object_info
*oi
);
1306 * With in-core object data in "buf", rehash it to make sure the
1307 * object name actually matches "oid" to detect object corruption.
1309 * A negative value indicates an error, usually that the OID is not
1310 * what we expected, but it might also indicate another error.
1312 int check_object_signature(struct repository
*r
, const struct object_id
*oid
,
1313 void *map
, unsigned long size
,
1314 enum object_type type
);
1317 * A streaming version of check_object_signature().
1318 * Try reading the object named with "oid" using
1319 * the streaming interface and rehash it to do the same.
1321 int stream_object_signature(struct repository
*r
, const struct object_id
*oid
);
1323 int finalize_object_file(const char *tmpfile
, const char *filename
);
1325 /* Helper to check and "touch" a file */
1326 int check_and_freshen_file(const char *fn
, int freshen
);
1328 extern const signed char hexval_table
[256];
1329 static inline unsigned int hexval(unsigned char c
)
1331 return hexval_table
[c
];
1335 * Convert two consecutive hexadecimal digits into a char. Return a
1336 * negative value on error. Don't run over the end of short strings.
1338 static inline int hex2chr(const char *s
)
1340 unsigned int val
= hexval(s
[0]);
1341 return (val
& ~0xf) ? val
: (val
<< 4) | hexval(s
[1]);
1344 /* Convert to/from hex/sha1 representation */
1345 #define MINIMUM_ABBREV minimum_abbrev
1346 #define DEFAULT_ABBREV default_abbrev
1348 /* used when the code does not know or care what the default abbrev is */
1349 #define FALLBACK_DEFAULT_ABBREV 7
1351 struct object_context
{
1352 unsigned short mode
;
1354 * symlink_path is only used by get_tree_entry_follow_symlinks,
1355 * and only for symlinks that point outside the repository.
1357 struct strbuf symlink_path
;
1359 * If GET_OID_RECORD_PATH is set, this will record path (if any)
1360 * found when resolving the name. The caller is responsible for
1361 * releasing the memory.
1366 #define GET_OID_QUIETLY 01
1367 #define GET_OID_COMMIT 02
1368 #define GET_OID_COMMITTISH 04
1369 #define GET_OID_TREE 010
1370 #define GET_OID_TREEISH 020
1371 #define GET_OID_BLOB 040
1372 #define GET_OID_FOLLOW_SYMLINKS 0100
1373 #define GET_OID_RECORD_PATH 0200
1374 #define GET_OID_ONLY_TO_DIE 04000
1375 #define GET_OID_REQUIRE_PATH 010000
1377 #define GET_OID_DISAMBIGUATORS \
1378 (GET_OID_COMMIT | GET_OID_COMMITTISH | \
1379 GET_OID_TREE | GET_OID_TREEISH | \
1382 enum get_oid_result
{
1384 MISSING_OBJECT
= -1, /* The requested object is missing */
1385 SHORT_NAME_AMBIGUOUS
= -2,
1386 /* The following only apply when symlinks are followed */
1387 DANGLING_SYMLINK
= -4, /*
1388 * The initial symlink is there, but
1389 * (transitively) points to a missing
1394 * Somewhere along the symlink chain, a path is
1395 * requested which contains a file as a
1396 * non-final element.
1400 int repo_get_oid(struct repository
*r
, const char *str
, struct object_id
*oid
);
1401 __attribute__((format (printf
, 2, 3)))
1402 int get_oidf(struct object_id
*oid
, const char *fmt
, ...);
1403 int repo_get_oid_commit(struct repository
*r
, const char *str
, struct object_id
*oid
);
1404 int repo_get_oid_committish(struct repository
*r
, const char *str
, struct object_id
*oid
);
1405 int repo_get_oid_tree(struct repository
*r
, const char *str
, struct object_id
*oid
);
1406 int repo_get_oid_treeish(struct repository
*r
, const char *str
, struct object_id
*oid
);
1407 int repo_get_oid_blob(struct repository
*r
, const char *str
, struct object_id
*oid
);
1408 int repo_get_oid_mb(struct repository
*r
, const char *str
, struct object_id
*oid
);
1409 void maybe_die_on_misspelt_object_name(struct repository
*repo
,
1411 const char *prefix
);
1412 enum get_oid_result
get_oid_with_context(struct repository
*repo
, const char *str
,
1413 unsigned flags
, struct object_id
*oid
,
1414 struct object_context
*oc
);
1416 #define get_oid(str, oid) repo_get_oid(the_repository, str, oid)
1417 #define get_oid_commit(str, oid) repo_get_oid_commit(the_repository, str, oid)
1418 #define get_oid_committish(str, oid) repo_get_oid_committish(the_repository, str, oid)
1419 #define get_oid_tree(str, oid) repo_get_oid_tree(the_repository, str, oid)
1420 #define get_oid_treeish(str, oid) repo_get_oid_treeish(the_repository, str, oid)
1421 #define get_oid_blob(str, oid) repo_get_oid_blob(the_repository, str, oid)
1422 #define get_oid_mb(str, oid) repo_get_oid_mb(the_repository, str, oid)
1424 typedef int each_abbrev_fn(const struct object_id
*oid
, void *);
1425 int repo_for_each_abbrev(struct repository
*r
, const char *prefix
, each_abbrev_fn
, void *);
1426 #define for_each_abbrev(prefix, fn, data) repo_for_each_abbrev(the_repository, prefix, fn, data)
1428 int set_disambiguate_hint_config(const char *var
, const char *value
);
1431 * Try to read a SHA1 in hexadecimal format from the 40 characters
1432 * starting at hex. Write the 20-byte result to sha1 in binary form.
1433 * Return 0 on success. Reading stops if a NUL is encountered in the
1434 * input, so it is safe to pass this function an arbitrary
1435 * null-terminated string.
1437 int get_sha1_hex(const char *hex
, unsigned char *sha1
);
1438 int get_oid_hex(const char *hex
, struct object_id
*sha1
);
1440 /* Like get_oid_hex, but for an arbitrary hash algorithm. */
1441 int get_oid_hex_algop(const char *hex
, struct object_id
*oid
, const struct git_hash_algo
*algop
);
1444 * Read `len` pairs of hexadecimal digits from `hex` and write the
1445 * values to `binary` as `len` bytes. Return 0 on success, or -1 if
1446 * the input does not consist of hex digits).
1448 int hex_to_bytes(unsigned char *binary
, const char *hex
, size_t len
);
1451 * Convert a binary hash in "unsigned char []" or an object name in
1452 * "struct object_id *" to its hex equivalent. The `_r` variant is reentrant,
1453 * and writes the NUL-terminated output to the buffer `out`, which must be at
1454 * least `GIT_MAX_HEXSZ + 1` bytes, and returns a pointer to out for
1457 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1458 * buffers, making it safe to make multiple calls for a single statement, like:
1460 * printf("%s -> %s", hash_to_hex(one), hash_to_hex(two));
1461 * printf("%s -> %s", oid_to_hex(one), oid_to_hex(two));
1463 char *hash_to_hex_algop_r(char *buffer
, const unsigned char *hash
, const struct git_hash_algo
*);
1464 char *oid_to_hex_r(char *out
, const struct object_id
*oid
);
1465 char *hash_to_hex_algop(const unsigned char *hash
, const struct git_hash_algo
*); /* static buffer result! */
1466 char *hash_to_hex(const unsigned char *hash
); /* same static buffer */
1467 char *oid_to_hex(const struct object_id
*oid
); /* same static buffer */
1470 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1471 * pointer specified by end when parsing stops. The resulting object ID is
1472 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1473 * other invalid character. end is only updated on success; otherwise, it is
1476 int parse_oid_hex(const char *hex
, struct object_id
*oid
, const char **end
);
1478 /* Like parse_oid_hex, but for an arbitrary hash algorithm. */
1479 int parse_oid_hex_algop(const char *hex
, struct object_id
*oid
, const char **end
,
1480 const struct git_hash_algo
*algo
);
1484 * These functions work like get_oid_hex and parse_oid_hex, but they will parse
1485 * a hex value for any algorithm. The algorithm is detected based on the length
1486 * and the algorithm in use is returned. If this is not a hex object ID in any
1487 * algorithm, returns GIT_HASH_UNKNOWN.
1489 int get_oid_hex_any(const char *hex
, struct object_id
*oid
);
1490 int parse_oid_hex_any(const char *hex
, struct object_id
*oid
, const char **end
);
1493 * This reads short-hand syntax that not only evaluates to a commit
1494 * object name, but also can act as if the end user spelled the name
1495 * of the branch from the command line.
1497 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1498 * places the name of the branch in the given buf and returns the
1499 * number of characters parsed if successful.
1501 * - "<branch>@{upstream}" finds the name of the other ref that
1502 * <branch> is configured to merge with (missing <branch> defaults
1503 * to the current branch), and places the name of the branch in the
1504 * given buf and returns the number of characters parsed if
1507 * If the input is not of the accepted format, it returns a negative
1508 * number to signal an error.
1510 * If the input was ok but there are not N branch switches in the
1511 * reflog, it returns 0.
1513 #define INTERPRET_BRANCH_LOCAL (1<<0)
1514 #define INTERPRET_BRANCH_REMOTE (1<<1)
1515 #define INTERPRET_BRANCH_HEAD (1<<2)
1516 struct interpret_branch_name_options
{
1518 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1519 * expansions: local branches ("refs/heads/"), remote branches
1520 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1521 * allowed, even ones to refs outside of those namespaces.
1526 * If ^{upstream} or ^{push} (or equivalent) is requested, and the
1527 * branch in question does not have such a reference, return -1 instead
1530 unsigned nonfatal_dangling_mark
: 1;
1532 int repo_interpret_branch_name(struct repository
*r
,
1533 const char *str
, int len
,
1535 const struct interpret_branch_name_options
*options
);
1536 #define interpret_branch_name(str, len, buf, options) \
1537 repo_interpret_branch_name(the_repository, str, len, buf, options)
1539 int validate_headref(const char *ref
);
1541 int base_name_compare(const char *name1
, size_t len1
, int mode1
,
1542 const char *name2
, size_t len2
, int mode2
);
1543 int df_name_compare(const char *name1
, size_t len1
, int mode1
,
1544 const char *name2
, size_t len2
, int mode2
);
1545 int name_compare(const char *name1
, size_t len1
, const char *name2
, size_t len2
);
1546 int cache_name_stage_compare(const char *name1
, int len1
, int stage1
, const char *name2
, int len2
, int stage2
);
1548 void *read_object_with_reference(struct repository
*r
,
1549 const struct object_id
*oid
,
1550 enum object_type required_type
,
1551 unsigned long *size
,
1552 struct object_id
*oid_ret
);
1554 struct object
*repo_peel_to_type(struct repository
*r
,
1555 const char *name
, int namelen
,
1556 struct object
*o
, enum object_type
);
1557 #define peel_to_type(name, namelen, obj, type) \
1558 repo_peel_to_type(the_repository, name, namelen, obj, type)
1560 #define IDENT_STRICT 1
1561 #define IDENT_NO_DATE 2
1562 #define IDENT_NO_NAME 4
1567 WANT_COMMITTER_IDENT
1570 const char *git_author_info(int);
1571 const char *git_committer_info(int);
1572 const char *fmt_ident(const char *name
, const char *email
,
1573 enum want_ident whose_ident
,
1574 const char *date_str
, int);
1575 const char *fmt_name(enum want_ident
);
1576 const char *ident_default_name(void);
1577 const char *ident_default_email(void);
1578 const char *git_editor(void);
1579 const char *git_sequence_editor(void);
1580 const char *git_pager(int stdout_is_tty
);
1581 int is_terminal_dumb(void);
1582 int git_ident_config(const char *, const char *, void *);
1584 * Prepare an ident to fall back on if the user didn't configure it.
1586 void prepare_fallback_ident(const char *name
, const char *email
);
1587 void reset_ident_date(void);
1589 struct ident_split
{
1590 const char *name_begin
;
1591 const char *name_end
;
1592 const char *mail_begin
;
1593 const char *mail_end
;
1594 const char *date_begin
;
1595 const char *date_end
;
1596 const char *tz_begin
;
1600 * Signals an success with 0, but time part of the result may be NULL
1601 * if the input lacks timestamp and zone
1603 int split_ident_line(struct ident_split
*, const char *, int);
1606 * Given a commit or tag object buffer and the commit or tag headers, replaces
1607 * the idents in the headers with their canonical versions using the mailmap mechanism.
1609 void apply_mailmap_to_header(struct strbuf
*, const char **, struct string_list
*);
1612 * Compare split idents for equality or strict ordering. Note that we
1613 * compare only the ident part of the line, ignoring any timestamp.
1615 * Because there are two fields, we must choose one as the primary key; we
1616 * currently arbitrarily pick the email.
1618 int ident_cmp(const struct ident_split
*, const struct ident_split
*);
1624 int prefix_len_stat_func
;
1626 #define CACHE_DEF_INIT { \
1627 .path = STRBUF_INIT, \
1629 static inline void cache_def_clear(struct cache_def
*cache
)
1631 strbuf_release(&cache
->path
);
1634 int has_symlink_leading_path(const char *name
, int len
);
1635 int threaded_has_symlink_leading_path(struct cache_def
*, const char *, int);
1636 int check_leading_path(const char *name
, int len
, int warn_on_lstat_err
);
1637 int has_dirs_only_path(const char *name
, int len
, int prefix_len
);
1638 void invalidate_lstat_cache(void);
1639 void schedule_dir_for_removal(const char *name
, int len
);
1640 void remove_scheduled_dirs(void);
1642 struct pack_window
{
1643 struct pack_window
*next
;
1644 unsigned char *base
;
1647 unsigned int last_used
;
1648 unsigned int inuse_cnt
;
1653 struct packed_git
*p
;
1657 * Create a temporary file rooted in the object database directory, or
1658 * die on failure. The filename is taken from "pattern", which should have the
1659 * usual "XXXXXX" trailer, and the resulting filename is written into the
1660 * "template" buffer. Returns the open descriptor.
1662 int odb_mkstemp(struct strbuf
*temp_filename
, const char *pattern
);
1665 * Create a pack .keep file named "name" (which should generally be the output
1666 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1669 int odb_pack_keep(const char *name
);
1672 * Set this to 0 to prevent oid_object_info_extended() from fetching missing
1673 * blobs. This has a difference only if extensions.partialClone is set.
1675 * Its default value is 1.
1677 extern int fetch_if_missing
;
1679 /* Dumb servers support */
1680 int update_server_info(int);
1682 const char *get_log_output_encoding(void);
1683 const char *get_commit_output_encoding(void);
1685 int committer_ident_sufficiently_given(void);
1686 int author_ident_sufficiently_given(void);
1688 extern const char *git_commit_encoding
;
1689 extern const char *git_log_output_encoding
;
1690 extern const char *git_mailmap_file
;
1691 extern const char *git_mailmap_blob
;
1693 /* IO helper functions */
1694 void maybe_flush_or_die(FILE *, const char *);
1695 __attribute__((format (printf
, 2, 3)))
1696 void fprintf_or_die(FILE *, const char *fmt
, ...);
1697 void fwrite_or_die(FILE *f
, const void *buf
, size_t count
);
1698 void fflush_or_die(FILE *f
);
1700 #define COPY_READ_ERROR (-2)
1701 #define COPY_WRITE_ERROR (-3)
1702 int copy_fd(int ifd
, int ofd
);
1703 int copy_file(const char *dst
, const char *src
, int mode
);
1704 int copy_file_with_time(const char *dst
, const char *src
, int mode
);
1706 void write_or_die(int fd
, const void *buf
, size_t count
);
1707 void fsync_or_die(int fd
, const char *);
1708 int fsync_component(enum fsync_component component
, int fd
);
1709 void fsync_component_or_die(enum fsync_component component
, int fd
, const char *msg
);
1711 static inline int batch_fsync_enabled(enum fsync_component component
)
1713 return (fsync_components
& component
) && (fsync_method
== FSYNC_METHOD_BATCH
);
1716 ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
1717 ssize_t
write_in_full(int fd
, const void *buf
, size_t count
);
1718 ssize_t
pread_in_full(int fd
, void *buf
, size_t count
, off_t offset
);
1720 static inline ssize_t
write_str_in_full(int fd
, const char *str
)
1722 return write_in_full(fd
, str
, strlen(str
));
1726 * Open (and truncate) the file at path, write the contents of buf to it,
1727 * and close it. Dies if any errors are encountered.
1729 void write_file_buf(const char *path
, const char *buf
, size_t len
);
1732 * Like write_file_buf(), but format the contents into a buffer first.
1733 * Additionally, write_file() will append a newline if one is not already
1734 * present, making it convenient to write text files:
1736 * write_file(path, "counter: %d", ctr);
1738 __attribute__((format (printf
, 2, 3)))
1739 void write_file(const char *path
, const char *fmt
, ...);
1742 void setup_pager(void);
1743 int pager_in_use(void);
1744 extern int pager_use_color
;
1745 int term_columns(void);
1746 void term_clear_line(void);
1747 int decimal_width(uintmax_t);
1748 int check_pager_config(const char *cmd
);
1749 void prepare_pager_args(struct child_process
*, const char *pager
);
1751 extern const char *editor_program
;
1752 extern const char *askpass_program
;
1753 extern const char *excludes_file
;
1756 int decode_85(char *dst
, const char *line
, int linelen
);
1757 void encode_85(char *buf
, const unsigned char *data
, int bytes
);
1760 void packet_trace_identity(const char *prog
);
1764 * return 0 if success, 1 - if addition of a file failed and
1765 * ADD_FILES_IGNORE_ERRORS was specified in flags
1767 int add_files_to_cache(const char *prefix
, const struct pathspec
*pathspec
, int flags
);
1770 extern int diff_auto_refresh_index
;
1773 void shift_tree(struct repository
*, const struct object_id
*, const struct object_id
*, struct object_id
*, int);
1774 void shift_tree_by(struct repository
*, const struct object_id
*, const struct object_id
*, struct object_id
*, const char *);
1778 * used by both diff and apply
1779 * last two digits are tab width
1781 #define WS_BLANK_AT_EOL 0100
1782 #define WS_SPACE_BEFORE_TAB 0200
1783 #define WS_INDENT_WITH_NON_TAB 0400
1784 #define WS_CR_AT_EOL 01000
1785 #define WS_BLANK_AT_EOF 02000
1786 #define WS_TAB_IN_INDENT 04000
1787 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1788 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1789 #define WS_TAB_WIDTH_MASK 077
1790 /* All WS_* -- when extended, adapt diff.c emit_symbol */
1791 #define WS_RULE_MASK 07777
1792 extern unsigned whitespace_rule_cfg
;
1793 unsigned whitespace_rule(struct index_state
*, const char *);
1794 unsigned parse_whitespace_rule(const char *);
1795 unsigned ws_check(const char *line
, int len
, unsigned ws_rule
);
1796 void ws_check_emit(const char *line
, int len
, unsigned ws_rule
, FILE *stream
, const char *set
, const char *reset
, const char *ws
);
1797 char *whitespace_error_string(unsigned ws
);
1798 void ws_fix_copy(struct strbuf
*, const char *, int, unsigned, int *);
1799 int ws_blank_line(const char *line
, int len
);
1800 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1803 void overlay_tree_on_index(struct index_state
*istate
,
1804 const char *tree_name
, const char *prefix
);
1807 struct startup_info
{
1808 int have_repository
;
1810 const char *original_cwd
;
1812 extern struct startup_info
*startup_info
;
1813 extern const char *tmp_original_cwd
;
1817 int try_merge_command(struct repository
*r
,
1818 const char *strategy
, size_t xopts_nr
,
1819 const char **xopts
, struct commit_list
*common
,
1820 const char *head_arg
, struct commit_list
*remotes
);
1821 int checkout_fast_forward(struct repository
*r
,
1822 const struct object_id
*from
,
1823 const struct object_id
*to
,
1824 int overwrite_ignore
);
1827 int sane_execvp(const char *file
, char *const argv
[]);
1830 * A struct to encapsulate the concept of whether a file has changed
1831 * since we last checked it. This uses criteria similar to those used
1834 struct stat_validity
{
1835 struct stat_data
*sd
;
1838 void stat_validity_clear(struct stat_validity
*sv
);
1841 * Returns 1 if the path is a regular file (or a symlink to a regular
1842 * file) and matches the saved stat_validity, 0 otherwise. A missing
1843 * or inaccessible file is considered a match if the struct was just
1844 * initialized, or if the previous update found an inaccessible file.
1846 int stat_validity_check(struct stat_validity
*sv
, const char *path
);
1849 * Update the stat_validity from a file opened at descriptor fd. If
1850 * the file is missing, inaccessible, or not a regular file, then
1851 * future calls to stat_validity_check will match iff one of those
1852 * conditions continues to be true.
1854 void stat_validity_update(struct stat_validity
*sv
, int fd
);
1856 int versioncmp(const char *s1
, const char *s2
);
1859 * Create a directory and (if share is nonzero) adjust its permissions
1860 * according to the shared_repository setting. Only use this for
1861 * directories under $GIT_DIR. Don't use it for working tree
1864 void safe_create_dir(const char *dir
, int share
);
1867 * Should we print an ellipsis after an abbreviated SHA-1 value
1868 * when doing diff-raw output or indicating a detached HEAD?
1870 int print_sha1_ellipsis(void);
1872 /* Return 1 if the file is empty or does not exists, 0 otherwise. */
1873 int is_empty_or_missing_file(const char *filename
);
1875 #endif /* CACHE_H */