4 #include "git-compat-util.h"
13 #include "string-list.h"
14 #include "pack-revindex.h"
19 #include "oid-array.h"
20 #include "repository.h"
24 typedef struct git_zstream
{
26 unsigned long avail_in
;
27 unsigned long avail_out
;
28 unsigned long total_in
;
29 unsigned long total_out
;
30 unsigned char *next_in
;
31 unsigned char *next_out
;
34 void git_inflate_init(git_zstream
*);
35 void git_inflate_init_gzip_only(git_zstream
*);
36 void git_inflate_end(git_zstream
*);
37 int git_inflate(git_zstream
*, int flush
);
39 void git_deflate_init(git_zstream
*, int level
);
40 void git_deflate_init_gzip(git_zstream
*, int level
);
41 void git_deflate_init_raw(git_zstream
*, int level
);
42 void git_deflate_end(git_zstream
*);
43 int git_deflate_abort(git_zstream
*);
44 int git_deflate_end_gently(git_zstream
*);
45 int git_deflate(git_zstream
*, int flush
);
46 unsigned long git_deflate_bound(git_zstream
*, unsigned long);
48 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
49 #define DTYPE(de) ((de)->d_type)
59 #define DTYPE(de) DT_UNKNOWN
62 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
63 #define S_IFINVALID 0030000
66 * A "directory link" is a link to another git directory.
68 * The value 0160000 is not normally a valid mode, and
69 * also just happens to be S_IFDIR + S_IFLNK
71 #define S_IFGITLINK 0160000
72 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
75 * Some mode bits are also used internally for computations.
77 * They *must* not overlap with any valid modes, and they *must* not be emitted
78 * to outside world - i.e. appear on disk or network. In other words, it's just
79 * temporary fields, which we internally use, but they have to stay in-house.
81 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
82 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
85 /* used internally in tree-diff */
86 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
90 * Intensive research over the course of many years has shown that
91 * port 9418 is totally unused by anything else. Or
93 * Your search - "port 9418" - did not match any documents.
95 * as www.google.com puts it.
97 * This port has been properly assigned for git use by IANA:
98 * git (Assigned-9418) [I06-050728-0001].
100 * git 9418/tcp git pack transfer service
101 * git 9418/udp git pack transfer service
103 * with Linus Torvalds <torvalds@osdl.org> as the point of
104 * contact. September 2005.
106 * See http://www.iana.org/assignments/port-numbers
108 #define DEFAULT_GIT_PORT 9418
111 * Basic data structures for the directory cache
114 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
115 struct cache_header
{
116 uint32_t hdr_signature
;
117 uint32_t hdr_version
;
118 uint32_t hdr_entries
;
121 #define INDEX_FORMAT_LB 2
122 #define INDEX_FORMAT_UB 4
125 struct hashmap_entry ent
;
126 struct stat_data ce_stat_data
;
127 unsigned int ce_mode
;
128 unsigned int ce_flags
;
129 unsigned int mem_pool_allocated
;
130 unsigned int ce_namelen
;
131 unsigned int index
; /* for link extension */
132 struct object_id oid
;
133 char name
[FLEX_ARRAY
]; /* more */
136 #define CE_STAGEMASK (0x3000)
137 #define CE_EXTENDED (0x4000)
138 #define CE_VALID (0x8000)
139 #define CE_STAGESHIFT 12
142 * Range 0xFFFF0FFF in ce_flags is divided into
143 * two parts: in-memory flags and on-disk ones.
144 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
145 * if you want to save a new flag, add it in
148 * In-memory only flags
150 #define CE_UPDATE (1 << 16)
151 #define CE_REMOVE (1 << 17)
152 #define CE_UPTODATE (1 << 18)
153 #define CE_ADDED (1 << 19)
155 #define CE_HASHED (1 << 20)
156 #define CE_FSMONITOR_VALID (1 << 21)
157 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
158 #define CE_CONFLICTED (1 << 23)
160 #define CE_UNPACKED (1 << 24)
161 #define CE_NEW_SKIP_WORKTREE (1 << 25)
163 /* used to temporarily mark paths matched by pathspecs */
164 #define CE_MATCHED (1 << 26)
166 #define CE_UPDATE_IN_BASE (1 << 27)
167 #define CE_STRIP_NAME (1 << 28)
170 * Extended on-disk flags
172 #define CE_INTENT_TO_ADD (1 << 29)
173 #define CE_SKIP_WORKTREE (1 << 30)
174 /* CE_EXTENDED2 is for future extension */
175 #define CE_EXTENDED2 (1U << 31)
177 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
180 * Safeguard to avoid saving wrong flags:
181 * - CE_EXTENDED2 won't get saved until its semantic is known
182 * - Bits in 0x0000FFFF have been saved in ce_flags already
183 * - Bits in 0x003F0000 are currently in-memory flags
185 #if CE_EXTENDED_FLAGS & 0x803FFFFF
186 #error "CE_EXTENDED_FLAGS out of range"
189 #define S_ISSPARSEDIR(m) ((m) == S_IFDIR)
191 /* Forward structure decls */
193 struct child_process
;
197 * Copy the sha1 and stat state of a cache entry from one to
198 * another. But we never change the name, or the hash state!
200 static inline void copy_cache_entry(struct cache_entry
*dst
,
201 const struct cache_entry
*src
)
203 unsigned int state
= dst
->ce_flags
& CE_HASHED
;
204 int mem_pool_allocated
= dst
->mem_pool_allocated
;
206 /* Don't copy hash chain and name */
207 memcpy(&dst
->ce_stat_data
, &src
->ce_stat_data
,
208 offsetof(struct cache_entry
, name
) -
209 offsetof(struct cache_entry
, ce_stat_data
));
211 /* Restore the hash state */
212 dst
->ce_flags
= (dst
->ce_flags
& ~CE_HASHED
) | state
;
214 /* Restore the mem_pool_allocated flag */
215 dst
->mem_pool_allocated
= mem_pool_allocated
;
218 static inline unsigned create_ce_flags(unsigned stage
)
220 return (stage
<< CE_STAGESHIFT
);
223 #define ce_namelen(ce) ((ce)->ce_namelen)
224 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
225 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
226 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
227 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
228 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
229 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
231 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
232 static inline unsigned int create_ce_mode(unsigned int mode
)
236 if (S_ISSPARSEDIR(mode
))
238 if (S_ISDIR(mode
) || S_ISGITLINK(mode
))
240 return S_IFREG
| ce_permissions(mode
);
242 static inline unsigned int ce_mode_from_stat(const struct cache_entry
*ce
,
245 extern int trust_executable_bit
, has_symlinks
;
246 if (!has_symlinks
&& S_ISREG(mode
) &&
247 ce
&& S_ISLNK(ce
->ce_mode
))
249 if (!trust_executable_bit
&& S_ISREG(mode
)) {
250 if (ce
&& S_ISREG(ce
->ce_mode
))
252 return create_ce_mode(0666);
254 return create_ce_mode(mode
);
256 static inline int ce_to_dtype(const struct cache_entry
*ce
)
258 unsigned ce_mode
= ntohl(ce
->ce_mode
);
259 if (S_ISREG(ce_mode
))
261 else if (S_ISDIR(ce_mode
) || S_ISGITLINK(ce_mode
))
263 else if (S_ISLNK(ce_mode
))
268 static inline unsigned int canon_mode(unsigned int mode
)
271 return S_IFREG
| ce_permissions(mode
);
279 static inline int ce_path_match(struct index_state
*istate
,
280 const struct cache_entry
*ce
,
281 const struct pathspec
*pathspec
,
284 return match_pathspec(istate
, pathspec
, ce
->name
, ce_namelen(ce
), 0, seen
,
285 S_ISDIR(ce
->ce_mode
) || S_ISGITLINK(ce
->ce_mode
));
288 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
290 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
291 #define CE_ENTRY_CHANGED (1 << 1)
292 #define CE_ENTRY_REMOVED (1 << 2)
293 #define CE_ENTRY_ADDED (1 << 3)
294 #define RESOLVE_UNDO_CHANGED (1 << 4)
295 #define CACHE_TREE_CHANGED (1 << 5)
296 #define SPLIT_INDEX_ORDERED (1 << 6)
297 #define UNTRACKED_CHANGED (1 << 7)
298 #define FSMONITOR_CHANGED (1 << 8)
301 struct untracked_cache
;
305 enum sparse_index_mode
{
307 * There are no sparse directories in the index at all.
309 * Repositories that don't use cone-mode sparse-checkout will
310 * always have their indexes in this mode.
315 * The index has already been collapsed to sparse directories
316 * whereever possible.
321 * The sparse directories that exist are outside the
322 * sparse-checkout boundary, but it is possible that some file
323 * entries could collapse to sparse directory entries.
325 INDEX_PARTIALLY_SPARSE
,
329 struct cache_entry
**cache
;
330 unsigned int version
;
331 unsigned int cache_nr
, cache_alloc
, cache_changed
;
332 struct string_list
*resolve_undo
;
333 struct cache_tree
*cache_tree
;
334 struct split_index
*split_index
;
335 struct cache_time timestamp
;
336 unsigned name_hash_initialized
: 1,
340 updated_skipworktree
: 1,
341 fsmonitor_has_run_once
: 1;
342 enum sparse_index_mode sparse_index
;
343 struct hashmap name_hash
;
344 struct hashmap dir_hash
;
345 struct object_id oid
;
346 struct untracked_cache
*untracked
;
347 char *fsmonitor_last_update
;
348 struct ewah_bitmap
*fsmonitor_dirty
;
349 struct mem_pool
*ce_mem_pool
;
350 struct progress
*progress
;
351 struct repository
*repo
;
352 struct pattern_list
*sparse_checkout_patterns
;
356 * A "struct index_state istate" must be initialized with
357 * INDEX_STATE_INIT or the corresponding index_state_init().
359 * If the variable won't be used again, use release_index() to free()
360 * its resources. If it needs to be used again use discard_index(),
361 * which does the same thing, but will use use index_state_init() at
362 * the end. The discard_index() will use its own "istate->repo" as the
363 * "r" argument to index_state_init() in that case.
365 #define INDEX_STATE_INIT(r) { \
368 void index_state_init(struct index_state
*istate
, struct repository
*r
);
369 void release_index(struct index_state
*istate
);
372 int test_lazy_init_name_hash(struct index_state
*istate
, int try_threaded
);
373 void add_name_hash(struct index_state
*istate
, struct cache_entry
*ce
);
374 void remove_name_hash(struct index_state
*istate
, struct cache_entry
*ce
);
375 void free_name_hash(struct index_state
*istate
);
377 /* Cache entry creation and cleanup */
380 * Create cache_entry intended for use in the specified index. Caller
381 * is responsible for discarding the cache_entry with
382 * `discard_cache_entry`.
384 struct cache_entry
*make_cache_entry(struct index_state
*istate
,
386 const struct object_id
*oid
,
389 unsigned int refresh_options
);
391 struct cache_entry
*make_empty_cache_entry(struct index_state
*istate
,
395 * Create a cache_entry that is not intended to be added to an index. If
396 * `ce_mem_pool` is not NULL, the entry is allocated within the given memory
397 * pool. Caller is responsible for discarding "loose" entries with
398 * `discard_cache_entry()` and the memory pool with
399 * `mem_pool_discard(ce_mem_pool, should_validate_cache_entries())`.
401 struct cache_entry
*make_transient_cache_entry(unsigned int mode
,
402 const struct object_id
*oid
,
405 struct mem_pool
*ce_mem_pool
);
407 struct cache_entry
*make_empty_transient_cache_entry(size_t len
,
408 struct mem_pool
*ce_mem_pool
);
411 * Discard cache entry.
413 void discard_cache_entry(struct cache_entry
*ce
);
416 * Check configuration if we should perform extra validation on cache
419 int should_validate_cache_entries(void);
422 * Duplicate a cache_entry. Allocate memory for the new entry from a
423 * memory_pool. Takes into account cache_entry fields that are meant
424 * for managing the underlying memory allocation of the cache_entry.
426 struct cache_entry
*dup_cache_entry(const struct cache_entry
*ce
, struct index_state
*istate
);
429 * Validate the cache entries in the index. This is an internal
430 * consistency check that the cache_entry structs are allocated from
431 * the expected memory pool.
433 void validate_cache_entries(const struct index_state
*istate
);
436 * Bulk prefetch all missing cache entries that are not GITLINKs and that match
437 * the given predicate. This function should only be called if
438 * has_promisor_remote() returns true.
440 typedef int (*must_prefetch_predicate
)(const struct cache_entry
*);
441 void prefetch_cache_entries(const struct index_state
*istate
,
442 must_prefetch_predicate must_prefetch
);
444 #ifdef USE_THE_INDEX_VARIABLE
445 extern struct index_state the_index
;
448 static inline enum object_type
object_type(unsigned int mode
)
450 return S_ISDIR(mode
) ? OBJ_TREE
:
451 S_ISGITLINK(mode
) ? OBJ_COMMIT
:
455 /* Double-check local_repo_env below if you add to this list. */
456 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
457 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
458 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
459 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
460 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
461 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
462 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
463 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
464 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
465 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
466 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
467 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
468 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
469 #define CONFIG_COUNT_ENVIRONMENT "GIT_CONFIG_COUNT"
470 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
471 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
472 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
473 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
474 #define GITATTRIBUTES_FILE ".gitattributes"
475 #define INFOATTRIBUTES_FILE "info/attributes"
476 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
477 #define GITMODULES_FILE ".gitmodules"
478 #define GITMODULES_INDEX ":.gitmodules"
479 #define GITMODULES_HEAD "HEAD:.gitmodules"
480 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
481 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
482 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
483 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
484 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
485 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
486 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
487 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
488 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
489 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
490 #define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
491 #define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT "GIT_TEXTDOMAINDIR"
494 * Environment variable used in handshaking the wire protocol.
495 * Contains a colon ':' separated list of keys with optional values
496 * 'key[=value]'. Presence of unknown keys and values must be
499 #define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
500 /* HTTP header used to handshake the wire protocol */
501 #define GIT_PROTOCOL_HEADER "Git-Protocol"
504 * This environment variable is expected to contain a boolean indicating
505 * whether we should or should not treat:
507 * GIT_DIR=foo.git git ...
509 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
510 * of this, but we use it internally to communicate to sub-processes that we
511 * are in a bare repo. If not set, defaults to true.
513 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
516 * Repository-local GIT_* environment variables; these will be cleared
517 * when git spawns a sub-process that runs inside another repository.
518 * The array is NULL-terminated, which makes it easy to pass in the "env"
519 * parameter of a run-command invocation, or to do a simple walk.
521 extern const char * const local_repo_env
[];
523 void setup_git_env(const char *git_dir
);
526 * Returns true iff we have a configured git repository (either via
527 * setup_git_directory, or in the environment via $GIT_DIR).
529 int have_git_dir(void);
531 extern int is_bare_repository_cfg
;
532 int is_bare_repository(void);
533 int is_inside_git_dir(void);
534 extern char *git_work_tree_cfg
;
535 int is_inside_work_tree(void);
536 const char *get_git_dir(void);
537 const char *get_git_common_dir(void);
538 const char *get_object_directory(void);
539 char *get_index_file(void);
540 char *get_graft_file(struct repository
*r
);
541 void set_git_dir(const char *path
, int make_realpath
);
542 int get_common_dir_noenv(struct strbuf
*sb
, const char *gitdir
);
543 int get_common_dir(struct strbuf
*sb
, const char *gitdir
);
544 const char *get_git_namespace(void);
545 const char *strip_namespace(const char *namespaced_ref
);
546 const char *get_git_work_tree(void);
549 * Return true if the given path is a git directory; note that this _just_
550 * looks at the directory itself. If you want to know whether "foo/.git"
551 * is a repository, you must feed that path, not just "foo".
553 int is_git_directory(const char *path
);
556 * Return 1 if the given path is the root of a git repository or
557 * submodule, else 0. Will not return 1 for bare repositories with the
558 * exception of creating a bare repository in "foo/.git" and calling
559 * is_git_repository("foo").
561 * If we run into read errors, we err on the side of saying "yes, it is",
562 * as we usually consider sub-repos precious, and would prefer to err on the
563 * side of not disrupting or deleting them.
565 int is_nonbare_repository_dir(struct strbuf
*path
);
567 #define READ_GITFILE_ERR_STAT_FAILED 1
568 #define READ_GITFILE_ERR_NOT_A_FILE 2
569 #define READ_GITFILE_ERR_OPEN_FAILED 3
570 #define READ_GITFILE_ERR_READ_FAILED 4
571 #define READ_GITFILE_ERR_INVALID_FORMAT 5
572 #define READ_GITFILE_ERR_NO_PATH 6
573 #define READ_GITFILE_ERR_NOT_A_REPO 7
574 #define READ_GITFILE_ERR_TOO_LARGE 8
575 void read_gitfile_error_die(int error_code
, const char *path
, const char *dir
);
576 const char *read_gitfile_gently(const char *path
, int *return_error_code
);
577 #define read_gitfile(path) read_gitfile_gently((path), NULL)
578 const char *resolve_gitdir_gently(const char *suspect
, int *return_error_code
);
579 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
581 void set_git_work_tree(const char *tree
);
583 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
585 void setup_work_tree(void);
587 * Find the commondir and gitdir of the repository that contains the current
588 * working directory, without changing the working directory or other global
589 * state. The result is appended to commondir and gitdir. If the discovered
590 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
591 * both have the same result appended to the buffer. The return value is
592 * either 0 upon success and non-zero if no repository was found.
594 int discover_git_directory(struct strbuf
*commondir
,
595 struct strbuf
*gitdir
);
596 const char *setup_git_directory_gently(int *);
597 const char *setup_git_directory(void);
598 char *prefix_path(const char *prefix
, int len
, const char *path
);
599 char *prefix_path_gently(const char *prefix
, int len
, int *remaining
, const char *path
);
602 * Concatenate "prefix" (if len is non-zero) and "path", with no
603 * connecting characters (so "prefix" should end with a "/").
604 * Unlike prefix_path, this should be used if the named file does
605 * not have to interact with index entry; i.e. name of a random file
608 * The return value is always a newly allocated string (even if the
611 char *prefix_filename(const char *prefix
, const char *path
);
613 /* Likewise, but path=="-" always yields "-" */
614 char *prefix_filename_except_for_dash(const char *prefix
, const char *path
);
616 int check_filename(const char *prefix
, const char *name
);
617 void verify_filename(const char *prefix
,
619 int diagnose_misspelt_rev
);
620 void verify_non_filename(const char *prefix
, const char *name
);
621 int path_inside_repo(const char *prefix
, const char *path
);
623 #define INIT_DB_QUIET 0x0001
624 #define INIT_DB_EXIST_OK 0x0002
626 int init_db(const char *git_dir
, const char *real_git_dir
,
627 const char *template_dir
, int hash_algo
,
628 const char *initial_branch
, unsigned int flags
);
629 void initialize_repository_version(int hash_algo
, int reinit
);
631 void sanitize_stdfds(void);
634 /* Initialize and use the cache information */
636 void preload_index(struct index_state
*index
,
637 const struct pathspec
*pathspec
,
638 unsigned int refresh_flags
);
639 int do_read_index(struct index_state
*istate
, const char *path
,
640 int must_exist
); /* for testting only! */
641 int read_index_from(struct index_state
*, const char *path
,
643 int is_index_unborn(struct index_state
*);
645 void ensure_full_index(struct index_state
*istate
);
647 /* For use with `write_locked_index()`. */
648 #define COMMIT_LOCK (1 << 0)
649 #define SKIP_IF_UNCHANGED (1 << 1)
652 * Write the index while holding an already-taken lock. Close the lock,
653 * and if `COMMIT_LOCK` is given, commit it.
655 * Unless a split index is in use, write the index into the lockfile.
657 * With a split index, write the shared index to a temporary file,
658 * adjust its permissions and rename it into place, then write the
659 * split index to the lockfile. If the temporary file for the shared
660 * index cannot be created, fall back to the behavior described in
661 * the previous paragraph.
663 * With `COMMIT_LOCK`, the lock is always committed or rolled back.
664 * Without it, the lock is closed, but neither committed nor rolled
667 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing
668 * is written (and the lock is rolled back if `COMMIT_LOCK` is given).
670 int write_locked_index(struct index_state
*, struct lock_file
*lock
, unsigned flags
);
672 void discard_index(struct index_state
*);
673 void move_index_extensions(struct index_state
*dst
, struct index_state
*src
);
674 int unmerged_index(const struct index_state
*);
677 * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL,
678 * compares istate to HEAD. If tree is NULL and on an unborn branch,
679 * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is
680 * provided, the space-separated list of files that differ will be appended
683 int repo_index_has_changes(struct repository
*repo
,
687 int verify_path(const char *path
, unsigned mode
);
688 int strcmp_offset(const char *s1
, const char *s2
, size_t *first_change
);
689 int index_dir_exists(struct index_state
*istate
, const char *name
, int namelen
);
690 void adjust_dirname_case(struct index_state
*istate
, char *name
);
691 struct cache_entry
*index_file_exists(struct index_state
*istate
, const char *name
, int namelen
, int igncase
);
694 * Searches for an entry defined by name and namelen in the given index.
695 * If the return value is positive (including 0) it is the position of an
696 * exact match. If the return value is negative, the negated value minus 1
697 * is the position where the entry would be inserted.
698 * Example: The current index consists of these files and its stages:
702 * index_name_pos(&index, "a", 1) -> -1
703 * index_name_pos(&index, "b", 1) -> 0
704 * index_name_pos(&index, "c", 1) -> -2
705 * index_name_pos(&index, "d", 1) -> 1
706 * index_name_pos(&index, "e", 1) -> -3
707 * index_name_pos(&index, "f", 1) -> -3
708 * index_name_pos(&index, "g", 1) -> -5
710 int index_name_pos(struct index_state
*, const char *name
, int namelen
);
713 * Like index_name_pos, returns the position of an entry of the given name in
714 * the index if one exists, otherwise returns a negative value where the negated
715 * value minus 1 is the position where the index entry would be inserted. Unlike
716 * index_name_pos, however, a sparse index is not expanded to find an entry
717 * inside a sparse directory.
719 int index_name_pos_sparse(struct index_state
*, const char *name
, int namelen
);
722 * Determines whether an entry with the given name exists within the
723 * given index. The return value is 1 if an exact match is found, otherwise
724 * it is 0. Note that, unlike index_name_pos, this function does not expand
725 * the index if it is sparse. If an item exists within the full index but it
726 * is contained within a sparse directory (and not in the sparse index), 0 is
729 int index_entry_exists(struct index_state
*, const char *name
, int namelen
);
732 * Some functions return the negative complement of an insert position when a
733 * precise match was not found but a position was found where the entry would
734 * need to be inserted. This helper protects that logic from any integer
737 static inline int index_pos_to_insert_pos(uintmax_t pos
)
740 die("overflow: -1 - %"PRIuMAX
, pos
);
741 return -1 - (int)pos
;
744 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
745 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
746 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
747 #define ADD_CACHE_JUST_APPEND 8 /* Append only */
748 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
749 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
750 #define ADD_CACHE_RENORMALIZE 64 /* Pass along HASH_RENORMALIZE */
751 int add_index_entry(struct index_state
*, struct cache_entry
*ce
, int option
);
752 void rename_index_entry_at(struct index_state
*, int pos
, const char *new_name
);
754 /* Remove entry, return true if there are more entries to go. */
755 int remove_index_entry_at(struct index_state
*, int pos
);
757 void remove_marked_cache_entries(struct index_state
*istate
, int invalidate
);
758 int remove_file_from_index(struct index_state
*, const char *path
);
759 #define ADD_CACHE_VERBOSE 1
760 #define ADD_CACHE_PRETEND 2
761 #define ADD_CACHE_IGNORE_ERRORS 4
762 #define ADD_CACHE_IGNORE_REMOVAL 8
763 #define ADD_CACHE_INTENT 16
765 * These two are used to add the contents of the file at path
766 * to the index, marking the working tree up-to-date by storing
767 * the cached stat info in the resulting cache entry. A caller
768 * that has already run lstat(2) on the path can call
769 * add_to_index(), and all others can call add_file_to_index();
770 * the latter will do necessary lstat(2) internally before
771 * calling the former.
773 int add_to_index(struct index_state
*, const char *path
, struct stat
*, int flags
);
774 int add_file_to_index(struct index_state
*, const char *path
, int flags
);
776 int chmod_index_entry(struct index_state
*, struct cache_entry
*ce
, char flip
);
777 int ce_same_name(const struct cache_entry
*a
, const struct cache_entry
*b
);
778 void set_object_name_for_intent_to_add_entry(struct cache_entry
*ce
);
779 int index_name_is_other(struct index_state
*, const char *, int);
780 void *read_blob_data_from_index(struct index_state
*, const char *, unsigned long *);
782 /* do stat comparison even if CE_VALID is true */
783 #define CE_MATCH_IGNORE_VALID 01
784 /* do not check the contents but report dirty on racily-clean entries */
785 #define CE_MATCH_RACY_IS_DIRTY 02
786 /* do stat comparison even if CE_SKIP_WORKTREE is true */
787 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
788 /* ignore non-existent files during stat update */
789 #define CE_MATCH_IGNORE_MISSING 0x08
790 /* enable stat refresh */
791 #define CE_MATCH_REFRESH 0x10
792 /* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
793 #define CE_MATCH_IGNORE_FSMONITOR 0X20
794 int is_racy_timestamp(const struct index_state
*istate
,
795 const struct cache_entry
*ce
);
796 int has_racy_timestamp(struct index_state
*istate
);
797 int ie_match_stat(struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
798 int ie_modified(struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
800 #define HASH_WRITE_OBJECT 1
801 #define HASH_FORMAT_CHECK 2
802 #define HASH_RENORMALIZE 4
803 #define HASH_SILENT 8
804 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
);
805 int index_path(struct index_state
*istate
, struct object_id
*oid
, const char *path
, struct stat
*st
, unsigned flags
);
808 * Record to sd the data from st that we use to check whether a file
809 * might have changed.
811 void fill_stat_data(struct stat_data
*sd
, struct stat
*st
);
814 * Return 0 if st is consistent with a file not having been changed
815 * since sd was filled. If there are differences, return a
816 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
817 * INODE_CHANGED, and DATA_CHANGED.
819 int match_stat_data(const struct stat_data
*sd
, struct stat
*st
);
820 int match_stat_data_racy(const struct index_state
*istate
,
821 const struct stat_data
*sd
, struct stat
*st
);
823 void fill_stat_cache_info(struct index_state
*istate
, struct cache_entry
*ce
, struct stat
*st
);
825 #define REFRESH_REALLY (1 << 0) /* ignore_valid */
826 #define REFRESH_UNMERGED (1 << 1) /* allow unmerged */
827 #define REFRESH_QUIET (1 << 2) /* be quiet about it */
828 #define REFRESH_IGNORE_MISSING (1 << 3) /* ignore non-existent */
829 #define REFRESH_IGNORE_SUBMODULES (1 << 4) /* ignore submodules */
830 #define REFRESH_IN_PORCELAIN (1 << 5) /* user friendly output, not "needs update" */
831 #define REFRESH_PROGRESS (1 << 6) /* show progress bar if stderr is tty */
832 #define REFRESH_IGNORE_SKIP_WORKTREE (1 << 7) /* ignore skip_worktree entries */
833 int refresh_index(struct index_state
*, unsigned int flags
, const struct pathspec
*pathspec
, char *seen
, const char *header_msg
);
835 * Refresh the index and write it to disk.
837 * 'refresh_flags' is passed directly to 'refresh_index()', while
838 * 'COMMIT_LOCK | write_flags' is passed to 'write_locked_index()', so
839 * the lockfile is always either committed or rolled back.
841 * If 'gentle' is passed, errors locking the index are ignored.
843 * Return 1 if refreshing the index returns an error, -1 if writing
844 * the index to disk fails, 0 on success.
846 * Note that if refreshing the index returns an error, we still write
847 * out the index (unless locking fails).
849 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
);
851 struct cache_entry
*refresh_cache_entry(struct index_state
*, struct cache_entry
*, unsigned int);
853 void set_alternate_index_output(const char *);
855 extern int verify_index_checksum
;
856 extern int verify_ce_order
;
858 /* Environment bits from configuration mechanism */
859 extern int trust_executable_bit
;
860 extern int trust_ctime
;
861 extern int check_stat
;
862 extern int quote_path_fully
;
863 extern int has_symlinks
;
864 extern int minimum_abbrev
, default_abbrev
;
865 extern int ignore_case
;
866 extern int assume_unchanged
;
867 extern int prefer_symlink_refs
;
868 extern int warn_ambiguous_refs
;
869 extern int warn_on_object_refname_ambiguity
;
870 extern char *apply_default_whitespace
;
871 extern char *apply_default_ignorewhitespace
;
872 extern const char *git_attributes_file
;
873 extern const char *git_hooks_path
;
874 extern int zlib_compression_level
;
875 extern int pack_compression_level
;
876 extern size_t packed_git_window_size
;
877 extern size_t packed_git_limit
;
878 extern size_t delta_base_cache_limit
;
879 extern unsigned long big_file_threshold
;
880 extern unsigned long pack_size_limit_cfg
;
883 * Accessors for the core.sharedrepository config which lazy-load the value
884 * from the config (if not already set). The "reset" function can be
885 * used to unset "set" or cached value, meaning that the value will be loaded
886 * fresh from the config file on the next call to get_shared_repository().
888 void set_shared_repository(int value
);
889 int get_shared_repository(void);
890 void reset_shared_repository(void);
893 * These values are used to help identify parts of a repository to fsync.
894 * FSYNC_COMPONENT_NONE identifies data that will not be a persistent part of the
895 * repository and so shouldn't be fsynced.
897 enum fsync_component
{
898 FSYNC_COMPONENT_NONE
,
899 FSYNC_COMPONENT_LOOSE_OBJECT
= 1 << 0,
900 FSYNC_COMPONENT_PACK
= 1 << 1,
901 FSYNC_COMPONENT_PACK_METADATA
= 1 << 2,
902 FSYNC_COMPONENT_COMMIT_GRAPH
= 1 << 3,
903 FSYNC_COMPONENT_INDEX
= 1 << 4,
904 FSYNC_COMPONENT_REFERENCE
= 1 << 5,
907 #define FSYNC_COMPONENTS_OBJECTS (FSYNC_COMPONENT_LOOSE_OBJECT | \
908 FSYNC_COMPONENT_PACK)
910 #define FSYNC_COMPONENTS_DERIVED_METADATA (FSYNC_COMPONENT_PACK_METADATA | \
911 FSYNC_COMPONENT_COMMIT_GRAPH)
913 #define FSYNC_COMPONENTS_DEFAULT ((FSYNC_COMPONENTS_OBJECTS | \
914 FSYNC_COMPONENTS_DERIVED_METADATA) & \
915 ~FSYNC_COMPONENT_LOOSE_OBJECT)
917 #define FSYNC_COMPONENTS_COMMITTED (FSYNC_COMPONENTS_OBJECTS | \
918 FSYNC_COMPONENT_REFERENCE)
920 #define FSYNC_COMPONENTS_ADDED (FSYNC_COMPONENTS_COMMITTED | \
921 FSYNC_COMPONENT_INDEX)
923 #define FSYNC_COMPONENTS_ALL (FSYNC_COMPONENT_LOOSE_OBJECT | \
924 FSYNC_COMPONENT_PACK | \
925 FSYNC_COMPONENT_PACK_METADATA | \
926 FSYNC_COMPONENT_COMMIT_GRAPH | \
927 FSYNC_COMPONENT_INDEX | \
928 FSYNC_COMPONENT_REFERENCE)
930 #ifndef FSYNC_COMPONENTS_PLATFORM_DEFAULT
931 #define FSYNC_COMPONENTS_PLATFORM_DEFAULT FSYNC_COMPONENTS_DEFAULT
935 * A bitmask indicating which components of the repo should be fsynced.
937 extern enum fsync_component fsync_components
;
938 extern int fsync_object_files
;
939 extern int use_fsync
;
943 FSYNC_METHOD_WRITEOUT_ONLY
,
947 extern enum fsync_method fsync_method
;
948 extern int core_preload_index
;
949 extern int precomposed_unicode
;
950 extern int protect_hfs
;
951 extern int protect_ntfs
;
953 extern int core_apply_sparse_checkout
;
954 extern int core_sparse_checkout_cone
;
955 extern int sparse_expect_files_outside_of_patterns
;
958 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
960 int use_optional_locks(void);
963 * The character that begins a commented line in user-editable file
964 * that is subject to stripspace.
966 extern char comment_line_char
;
967 extern int auto_comment_line_char
;
969 enum log_refs_config
{
975 extern enum log_refs_config log_all_ref_updates
;
977 enum rebase_setup_type
{
978 AUTOREBASE_NEVER
= 0,
984 enum push_default_type
{
985 PUSH_DEFAULT_NOTHING
= 0,
986 PUSH_DEFAULT_MATCHING
,
988 PUSH_DEFAULT_UPSTREAM
,
989 PUSH_DEFAULT_CURRENT
,
990 PUSH_DEFAULT_UNSPECIFIED
993 extern enum rebase_setup_type autorebase
;
994 extern enum push_default_type push_default
;
996 enum object_creation_mode
{
997 OBJECT_CREATION_USES_HARDLINKS
= 0,
998 OBJECT_CREATION_USES_RENAMES
= 1
1001 extern enum object_creation_mode object_creation_mode
;
1003 extern char *notes_ref_name
;
1005 extern int grafts_replace_parents
;
1008 * GIT_REPO_VERSION is the version we write by default. The
1009 * _READ variant is the highest number we know how to
1012 #define GIT_REPO_VERSION 0
1013 #define GIT_REPO_VERSION_READ 1
1014 extern int repository_format_precious_objects
;
1015 extern int repository_format_worktree_config
;
1018 * You _have_ to initialize a `struct repository_format` using
1019 * `= REPOSITORY_FORMAT_INIT` before calling `read_repository_format()`.
1021 struct repository_format
{
1023 int precious_objects
;
1024 char *partial_clone
; /* value of extensions.partialclone */
1025 int worktree_config
;
1030 struct string_list unknown_extensions
;
1031 struct string_list v1_only_extensions
;
1035 * Always use this to initialize a `struct repository_format`
1036 * to a well-defined, default state before calling
1037 * `read_repository()`.
1039 #define REPOSITORY_FORMAT_INIT \
1043 .hash_algo = GIT_HASH_SHA1, \
1044 .unknown_extensions = STRING_LIST_INIT_DUP, \
1045 .v1_only_extensions = STRING_LIST_INIT_DUP, \
1049 * Read the repository format characteristics from the config file "path" into
1050 * "format" struct. Returns the numeric version. On error, or if no version is
1051 * found in the configuration, -1 is returned, format->version is set to -1,
1052 * and all other fields in the struct are set to the default configuration
1053 * (REPOSITORY_FORMAT_INIT). Always initialize the struct using
1054 * REPOSITORY_FORMAT_INIT before calling this function.
1056 int read_repository_format(struct repository_format
*format
, const char *path
);
1059 * Free the memory held onto by `format`, but not the struct itself.
1060 * (No need to use this after `read_repository_format()` fails.)
1062 void clear_repository_format(struct repository_format
*format
);
1065 * Verify that the repository described by repository_format is something we
1066 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
1067 * any errors encountered.
1069 int verify_repository_format(const struct repository_format
*format
,
1070 struct strbuf
*err
);
1073 * Check the repository format version in the path found in get_git_dir(),
1074 * and die if it is a version we don't understand. Generally one would
1075 * set_git_dir() before calling this, and use it only for "are we in a valid
1078 * If successful and fmt is not NULL, fill fmt with data.
1080 void check_repository_format(struct repository_format
*fmt
);
1082 #define MTIME_CHANGED 0x0001
1083 #define CTIME_CHANGED 0x0002
1084 #define OWNER_CHANGED 0x0004
1085 #define MODE_CHANGED 0x0008
1086 #define INODE_CHANGED 0x0010
1087 #define DATA_CHANGED 0x0020
1088 #define TYPE_CHANGED 0x0040
1091 * Return an abbreviated sha1 unique within this repository's object database.
1092 * The result will be at least `len` characters long, and will be NUL
1095 * The non-`_r` version returns a static buffer which remains valid until 4
1096 * more calls to find_unique_abbrev are made.
1098 * The `_r` variant writes to a buffer supplied by the caller, which must be at
1099 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes
1100 * written (excluding the NUL terminator).
1102 * Note that while this version avoids the static buffer, it is not fully
1103 * reentrant, as it calls into other non-reentrant git code.
1105 const char *repo_find_unique_abbrev(struct repository
*r
, const struct object_id
*oid
, int len
);
1106 #define find_unique_abbrev(oid, len) repo_find_unique_abbrev(the_repository, oid, len)
1107 int repo_find_unique_abbrev_r(struct repository
*r
, char *hex
, const struct object_id
*oid
, int len
);
1108 #define find_unique_abbrev_r(hex, oid, len) repo_find_unique_abbrev_r(the_repository, hex, oid, len)
1110 /* set default permissions by passing mode arguments to open(2) */
1111 int git_mkstemps_mode(char *pattern
, int suffix_len
, int mode
);
1112 int git_mkstemp_mode(char *pattern
, int mode
);
1117 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1118 * not be changed. Old repositories have core.sharedrepository written in
1119 * numeric format, and therefore these values are preserved for compatibility
1125 OLD_PERM_EVERYBODY
= 2,
1127 PERM_EVERYBODY
= 0664
1129 int git_config_perm(const char *var
, const char *value
);
1130 int adjust_shared_perm(const char *path
);
1133 * Create the directory containing the named path, using care to be
1134 * somewhat safe against races. Return one of the scld_error values to
1135 * indicate success/failure. On error, set errno to describe the
1138 * SCLD_VANISHED indicates that one of the ancestor directories of the
1139 * path existed at one point during the function call and then
1140 * suddenly vanished, probably because another process pruned the
1141 * directory while we were working. To be robust against this kind of
1142 * race, callers might want to try invoking the function again when it
1143 * returns SCLD_VANISHED.
1145 * safe_create_leading_directories() temporarily changes path while it
1146 * is working but restores it before returning.
1147 * safe_create_leading_directories_const() doesn't modify path, even
1148 * temporarily. Both these variants adjust the permissions of the
1149 * created directories to honor core.sharedRepository, so they are best
1150 * suited for files inside the git dir. For working tree files, use
1151 * safe_create_leading_directories_no_share() instead, as it ignores
1152 * the core.sharedRepository setting.
1161 enum scld_error
safe_create_leading_directories(char *path
);
1162 enum scld_error
safe_create_leading_directories_const(const char *path
);
1163 enum scld_error
safe_create_leading_directories_no_share(char *path
);
1165 int mkdir_in_gitdir(const char *path
);
1166 char *interpolate_path(const char *path
, int real_home
);
1167 /* NEEDSWORK: remove this synonym once in-flight topics have migrated */
1168 #define expand_user_path interpolate_path
1169 const char *enter_repo(const char *path
, int strict
);
1170 static inline int is_absolute_path(const char *path
)
1172 return is_dir_sep(path
[0]) || has_dos_drive_prefix(path
);
1174 int is_directory(const char *);
1175 char *strbuf_realpath(struct strbuf
*resolved
, const char *path
,
1177 char *strbuf_realpath_forgiving(struct strbuf
*resolved
, const char *path
,
1179 char *real_pathdup(const char *path
, int die_on_error
);
1180 const char *absolute_path(const char *path
);
1181 char *absolute_pathdup(const char *path
);
1182 const char *remove_leading_path(const char *in
, const char *prefix
);
1183 const char *relative_path(const char *in
, const char *prefix
, struct strbuf
*sb
);
1184 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
);
1185 int normalize_path_copy(char *dst
, const char *src
);
1186 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
);
1187 char *strip_path_suffix(const char *path
, const char *suffix
);
1188 int daemon_avoid_alias(const char *path
);
1191 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for
1194 int is_ntfs_dotgit(const char *name
);
1195 int is_ntfs_dotgitmodules(const char *name
);
1196 int is_ntfs_dotgitignore(const char *name
);
1197 int is_ntfs_dotgitattributes(const char *name
);
1198 int is_ntfs_dotmailmap(const char *name
);
1201 * Returns true iff "str" could be confused as a command-line option when
1202 * passed to a sub-program like "ssh". Note that this has nothing to do with
1203 * shell-quoting, which should be handled separately; we're assuming here that
1204 * the string makes it verbatim to the sub-program.
1206 int looks_like_command_line_option(const char *str
);
1209 * Return a newly allocated string with the evaluation of
1210 * "$XDG_CONFIG_HOME/$subdir/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1211 * "$HOME/.config/$subdir/$filename". Return NULL upon error.
1213 char *xdg_config_home_for(const char *subdir
, const char *filename
);
1216 * Return a newly allocated string with the evaluation of
1217 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1218 * "$HOME/.config/git/$filename". Return NULL upon error.
1220 char *xdg_config_home(const char *filename
);
1223 * Return a newly allocated string with the evaluation of
1224 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1225 * "$HOME/.cache/git/$filename". Return NULL upon error.
1227 char *xdg_cache_home(const char *filename
);
1229 int git_open_cloexec(const char *name
, int flags
);
1230 #define git_open(name) git_open_cloexec(name, O_RDONLY)
1233 * unpack_loose_header() initializes the data stream needed to unpack
1234 * a loose object header.
1238 * - ULHR_OK on success
1239 * - ULHR_BAD on error
1240 * - ULHR_TOO_LONG if the header was too long
1242 * It will only parse up to MAX_HEADER_LEN bytes unless an optional
1243 * "hdrbuf" argument is non-NULL. This is intended for use with
1244 * OBJECT_INFO_ALLOW_UNKNOWN_TYPE to extract the bad type for (error)
1245 * reporting. The full header will be extracted to "hdrbuf" for use
1246 * with parse_loose_header(), ULHR_TOO_LONG will still be returned
1247 * from this function to indicate that the header was too long.
1249 enum unpack_loose_header_result
{
1254 enum unpack_loose_header_result
unpack_loose_header(git_zstream
*stream
,
1256 unsigned long mapsize
,
1258 unsigned long bufsiz
,
1259 struct strbuf
*hdrbuf
);
1262 * parse_loose_header() parses the starting "<type> <len>\0" of an
1263 * object. If it doesn't follow that format -1 is returned. To check
1264 * the validity of the <type> populate the "typep" in the "struct
1265 * object_info". It will be OBJ_BAD if the object type is unknown. The
1266 * parsed <len> can be retrieved via "oi->sizep", and from there
1267 * passed to unpack_loose_rest().
1270 int parse_loose_header(const char *hdr
, struct object_info
*oi
);
1273 * With in-core object data in "buf", rehash it to make sure the
1274 * object name actually matches "oid" to detect object corruption.
1276 * A negative value indicates an error, usually that the OID is not
1277 * what we expected, but it might also indicate another error.
1279 int check_object_signature(struct repository
*r
, const struct object_id
*oid
,
1280 void *map
, unsigned long size
,
1281 enum object_type type
);
1284 * A streaming version of check_object_signature().
1285 * Try reading the object named with "oid" using
1286 * the streaming interface and rehash it to do the same.
1288 int stream_object_signature(struct repository
*r
, const struct object_id
*oid
);
1290 int finalize_object_file(const char *tmpfile
, const char *filename
);
1292 /* Helper to check and "touch" a file */
1293 int check_and_freshen_file(const char *fn
, int freshen
);
1295 /* Convert to/from hex/sha1 representation */
1296 #define MINIMUM_ABBREV minimum_abbrev
1297 #define DEFAULT_ABBREV default_abbrev
1299 /* used when the code does not know or care what the default abbrev is */
1300 #define FALLBACK_DEFAULT_ABBREV 7
1302 struct object_context
{
1303 unsigned short mode
;
1305 * symlink_path is only used by get_tree_entry_follow_symlinks,
1306 * and only for symlinks that point outside the repository.
1308 struct strbuf symlink_path
;
1310 * If GET_OID_RECORD_PATH is set, this will record path (if any)
1311 * found when resolving the name. The caller is responsible for
1312 * releasing the memory.
1317 int repo_get_oid(struct repository
*r
, const char *str
, struct object_id
*oid
);
1318 __attribute__((format (printf
, 2, 3)))
1319 int get_oidf(struct object_id
*oid
, const char *fmt
, ...);
1320 int repo_get_oid_commit(struct repository
*r
, const char *str
, struct object_id
*oid
);
1321 int repo_get_oid_committish(struct repository
*r
, const char *str
, struct object_id
*oid
);
1322 int repo_get_oid_tree(struct repository
*r
, const char *str
, struct object_id
*oid
);
1323 int repo_get_oid_treeish(struct repository
*r
, const char *str
, struct object_id
*oid
);
1324 int repo_get_oid_blob(struct repository
*r
, const char *str
, struct object_id
*oid
);
1325 int repo_get_oid_mb(struct repository
*r
, const char *str
, struct object_id
*oid
);
1326 void maybe_die_on_misspelt_object_name(struct repository
*repo
,
1328 const char *prefix
);
1329 enum get_oid_result
get_oid_with_context(struct repository
*repo
, const char *str
,
1330 unsigned flags
, struct object_id
*oid
,
1331 struct object_context
*oc
);
1333 #define get_oid(str, oid) repo_get_oid(the_repository, str, oid)
1334 #define get_oid_commit(str, oid) repo_get_oid_commit(the_repository, str, oid)
1335 #define get_oid_committish(str, oid) repo_get_oid_committish(the_repository, str, oid)
1336 #define get_oid_tree(str, oid) repo_get_oid_tree(the_repository, str, oid)
1337 #define get_oid_treeish(str, oid) repo_get_oid_treeish(the_repository, str, oid)
1338 #define get_oid_blob(str, oid) repo_get_oid_blob(the_repository, str, oid)
1339 #define get_oid_mb(str, oid) repo_get_oid_mb(the_repository, str, oid)
1341 typedef int each_abbrev_fn(const struct object_id
*oid
, void *);
1342 int repo_for_each_abbrev(struct repository
*r
, const char *prefix
, each_abbrev_fn
, void *);
1343 #define for_each_abbrev(prefix, fn, data) repo_for_each_abbrev(the_repository, prefix, fn, data)
1345 int set_disambiguate_hint_config(const char *var
, const char *value
);
1348 * This reads short-hand syntax that not only evaluates to a commit
1349 * object name, but also can act as if the end user spelled the name
1350 * of the branch from the command line.
1352 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1353 * places the name of the branch in the given buf and returns the
1354 * number of characters parsed if successful.
1356 * - "<branch>@{upstream}" finds the name of the other ref that
1357 * <branch> is configured to merge with (missing <branch> defaults
1358 * to the current branch), and places the name of the branch in the
1359 * given buf and returns the number of characters parsed if
1362 * If the input is not of the accepted format, it returns a negative
1363 * number to signal an error.
1365 * If the input was ok but there are not N branch switches in the
1366 * reflog, it returns 0.
1368 #define INTERPRET_BRANCH_LOCAL (1<<0)
1369 #define INTERPRET_BRANCH_REMOTE (1<<1)
1370 #define INTERPRET_BRANCH_HEAD (1<<2)
1371 struct interpret_branch_name_options
{
1373 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1374 * expansions: local branches ("refs/heads/"), remote branches
1375 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1376 * allowed, even ones to refs outside of those namespaces.
1381 * If ^{upstream} or ^{push} (or equivalent) is requested, and the
1382 * branch in question does not have such a reference, return -1 instead
1385 unsigned nonfatal_dangling_mark
: 1;
1387 int repo_interpret_branch_name(struct repository
*r
,
1388 const char *str
, int len
,
1390 const struct interpret_branch_name_options
*options
);
1391 #define interpret_branch_name(str, len, buf, options) \
1392 repo_interpret_branch_name(the_repository, str, len, buf, options)
1394 int validate_headref(const char *ref
);
1396 int base_name_compare(const char *name1
, size_t len1
, int mode1
,
1397 const char *name2
, size_t len2
, int mode2
);
1398 int df_name_compare(const char *name1
, size_t len1
, int mode1
,
1399 const char *name2
, size_t len2
, int mode2
);
1400 int name_compare(const char *name1
, size_t len1
, const char *name2
, size_t len2
);
1401 int cache_name_stage_compare(const char *name1
, int len1
, int stage1
, const char *name2
, int len2
, int stage2
);
1403 void *read_object_with_reference(struct repository
*r
,
1404 const struct object_id
*oid
,
1405 enum object_type required_type
,
1406 unsigned long *size
,
1407 struct object_id
*oid_ret
);
1409 struct object
*repo_peel_to_type(struct repository
*r
,
1410 const char *name
, int namelen
,
1411 struct object
*o
, enum object_type
);
1412 #define peel_to_type(name, namelen, obj, type) \
1413 repo_peel_to_type(the_repository, name, namelen, obj, type)
1415 const char *git_editor(void);
1416 const char *git_sequence_editor(void);
1417 const char *git_pager(int stdout_is_tty
);
1418 int is_terminal_dumb(void);
1424 int prefix_len_stat_func
;
1426 #define CACHE_DEF_INIT { \
1427 .path = STRBUF_INIT, \
1429 static inline void cache_def_clear(struct cache_def
*cache
)
1431 strbuf_release(&cache
->path
);
1434 int has_symlink_leading_path(const char *name
, int len
);
1435 int threaded_has_symlink_leading_path(struct cache_def
*, const char *, int);
1436 int check_leading_path(const char *name
, int len
, int warn_on_lstat_err
);
1437 int has_dirs_only_path(const char *name
, int len
, int prefix_len
);
1438 void invalidate_lstat_cache(void);
1439 void schedule_dir_for_removal(const char *name
, int len
);
1440 void remove_scheduled_dirs(void);
1442 struct pack_window
{
1443 struct pack_window
*next
;
1444 unsigned char *base
;
1447 unsigned int last_used
;
1448 unsigned int inuse_cnt
;
1453 struct packed_git
*p
;
1457 * Create a temporary file rooted in the object database directory, or
1458 * die on failure. The filename is taken from "pattern", which should have the
1459 * usual "XXXXXX" trailer, and the resulting filename is written into the
1460 * "template" buffer. Returns the open descriptor.
1462 int odb_mkstemp(struct strbuf
*temp_filename
, const char *pattern
);
1465 * Create a pack .keep file named "name" (which should generally be the output
1466 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1469 int odb_pack_keep(const char *name
);
1472 * Set this to 0 to prevent oid_object_info_extended() from fetching missing
1473 * blobs. This has a difference only if extensions.partialClone is set.
1475 * Its default value is 1.
1477 extern int fetch_if_missing
;
1479 /* Dumb servers support */
1480 int update_server_info(int);
1482 const char *get_log_output_encoding(void);
1483 const char *get_commit_output_encoding(void);
1485 extern const char *git_commit_encoding
;
1486 extern const char *git_log_output_encoding
;
1487 extern const char *git_mailmap_file
;
1488 extern const char *git_mailmap_blob
;
1490 /* IO helper functions */
1491 void maybe_flush_or_die(FILE *, const char *);
1492 __attribute__((format (printf
, 2, 3)))
1493 void fprintf_or_die(FILE *, const char *fmt
, ...);
1494 void fwrite_or_die(FILE *f
, const void *buf
, size_t count
);
1495 void fflush_or_die(FILE *f
);
1497 #define COPY_READ_ERROR (-2)
1498 #define COPY_WRITE_ERROR (-3)
1499 int copy_fd(int ifd
, int ofd
);
1500 int copy_file(const char *dst
, const char *src
, int mode
);
1501 int copy_file_with_time(const char *dst
, const char *src
, int mode
);
1503 void write_or_die(int fd
, const void *buf
, size_t count
);
1504 void fsync_or_die(int fd
, const char *);
1505 int fsync_component(enum fsync_component component
, int fd
);
1506 void fsync_component_or_die(enum fsync_component component
, int fd
, const char *msg
);
1508 static inline int batch_fsync_enabled(enum fsync_component component
)
1510 return (fsync_components
& component
) && (fsync_method
== FSYNC_METHOD_BATCH
);
1513 ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
1514 ssize_t
write_in_full(int fd
, const void *buf
, size_t count
);
1515 ssize_t
pread_in_full(int fd
, void *buf
, size_t count
, off_t offset
);
1517 static inline ssize_t
write_str_in_full(int fd
, const char *str
)
1519 return write_in_full(fd
, str
, strlen(str
));
1523 * Open (and truncate) the file at path, write the contents of buf to it,
1524 * and close it. Dies if any errors are encountered.
1526 void write_file_buf(const char *path
, const char *buf
, size_t len
);
1529 * Like write_file_buf(), but format the contents into a buffer first.
1530 * Additionally, write_file() will append a newline if one is not already
1531 * present, making it convenient to write text files:
1533 * write_file(path, "counter: %d", ctr);
1535 __attribute__((format (printf
, 2, 3)))
1536 void write_file(const char *path
, const char *fmt
, ...);
1539 void setup_pager(void);
1540 int pager_in_use(void);
1541 extern int pager_use_color
;
1542 int term_columns(void);
1543 void term_clear_line(void);
1544 int decimal_width(uintmax_t);
1545 int check_pager_config(const char *cmd
);
1546 void prepare_pager_args(struct child_process
*, const char *pager
);
1548 extern const char *editor_program
;
1549 extern const char *askpass_program
;
1550 extern const char *excludes_file
;
1553 int decode_85(char *dst
, const char *line
, int linelen
);
1554 void encode_85(char *buf
, const unsigned char *data
, int bytes
);
1557 void packet_trace_identity(const char *prog
);
1561 * return 0 if success, 1 - if addition of a file failed and
1562 * ADD_FILES_IGNORE_ERRORS was specified in flags
1564 int add_files_to_cache(const char *prefix
, const struct pathspec
*pathspec
, int flags
);
1567 extern int diff_auto_refresh_index
;
1570 void shift_tree(struct repository
*, const struct object_id
*, const struct object_id
*, struct object_id
*, int);
1571 void shift_tree_by(struct repository
*, const struct object_id
*, const struct object_id
*, struct object_id
*, const char *);
1575 * used by both diff and apply
1576 * last two digits are tab width
1578 #define WS_BLANK_AT_EOL 0100
1579 #define WS_SPACE_BEFORE_TAB 0200
1580 #define WS_INDENT_WITH_NON_TAB 0400
1581 #define WS_CR_AT_EOL 01000
1582 #define WS_BLANK_AT_EOF 02000
1583 #define WS_TAB_IN_INDENT 04000
1584 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1585 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1586 #define WS_TAB_WIDTH_MASK 077
1587 /* All WS_* -- when extended, adapt diff.c emit_symbol */
1588 #define WS_RULE_MASK 07777
1589 extern unsigned whitespace_rule_cfg
;
1590 unsigned whitespace_rule(struct index_state
*, const char *);
1591 unsigned parse_whitespace_rule(const char *);
1592 unsigned ws_check(const char *line
, int len
, unsigned ws_rule
);
1593 void ws_check_emit(const char *line
, int len
, unsigned ws_rule
, FILE *stream
, const char *set
, const char *reset
, const char *ws
);
1594 char *whitespace_error_string(unsigned ws
);
1595 void ws_fix_copy(struct strbuf
*, const char *, int, unsigned, int *);
1596 int ws_blank_line(const char *line
, int len
);
1597 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1600 void overlay_tree_on_index(struct index_state
*istate
,
1601 const char *tree_name
, const char *prefix
);
1604 struct startup_info
{
1605 int have_repository
;
1607 const char *original_cwd
;
1609 extern struct startup_info
*startup_info
;
1610 extern const char *tmp_original_cwd
;
1614 int try_merge_command(struct repository
*r
,
1615 const char *strategy
, size_t xopts_nr
,
1616 const char **xopts
, struct commit_list
*common
,
1617 const char *head_arg
, struct commit_list
*remotes
);
1618 int checkout_fast_forward(struct repository
*r
,
1619 const struct object_id
*from
,
1620 const struct object_id
*to
,
1621 int overwrite_ignore
);
1624 int sane_execvp(const char *file
, char *const argv
[]);
1627 * A struct to encapsulate the concept of whether a file has changed
1628 * since we last checked it. This uses criteria similar to those used
1631 struct stat_validity
{
1632 struct stat_data
*sd
;
1635 void stat_validity_clear(struct stat_validity
*sv
);
1638 * Returns 1 if the path is a regular file (or a symlink to a regular
1639 * file) and matches the saved stat_validity, 0 otherwise. A missing
1640 * or inaccessible file is considered a match if the struct was just
1641 * initialized, or if the previous update found an inaccessible file.
1643 int stat_validity_check(struct stat_validity
*sv
, const char *path
);
1646 * Update the stat_validity from a file opened at descriptor fd. If
1647 * the file is missing, inaccessible, or not a regular file, then
1648 * future calls to stat_validity_check will match iff one of those
1649 * conditions continues to be true.
1651 void stat_validity_update(struct stat_validity
*sv
, int fd
);
1653 int versioncmp(const char *s1
, const char *s2
);
1656 * Create a directory and (if share is nonzero) adjust its permissions
1657 * according to the shared_repository setting. Only use this for
1658 * directories under $GIT_DIR. Don't use it for working tree
1661 void safe_create_dir(const char *dir
, int share
);
1664 * Should we print an ellipsis after an abbreviated SHA-1 value
1665 * when doing diff-raw output or indicating a detached HEAD?
1667 int print_sha1_ellipsis(void);
1669 /* Return 1 if the file is empty or does not exists, 0 otherwise. */
1670 int is_empty_or_missing_file(const char *filename
);
1672 #endif /* CACHE_H */