4 #include "git-compat-util.h"
12 #include "string-list.h"
13 #include "pack-revindex.h"
16 #include "sha1-array.h"
17 #include "repository.h"
20 typedef struct git_zstream
{
22 unsigned long avail_in
;
23 unsigned long avail_out
;
24 unsigned long total_in
;
25 unsigned long total_out
;
26 unsigned char *next_in
;
27 unsigned char *next_out
;
30 void git_inflate_init(git_zstream
*);
31 void git_inflate_init_gzip_only(git_zstream
*);
32 void git_inflate_end(git_zstream
*);
33 int git_inflate(git_zstream
*, int flush
);
35 void git_deflate_init(git_zstream
*, int level
);
36 void git_deflate_init_gzip(git_zstream
*, int level
);
37 void git_deflate_init_raw(git_zstream
*, int level
);
38 void git_deflate_end(git_zstream
*);
39 int git_deflate_abort(git_zstream
*);
40 int git_deflate_end_gently(git_zstream
*);
41 int git_deflate(git_zstream
*, int flush
);
42 unsigned long git_deflate_bound(git_zstream
*, unsigned long);
44 /* The length in bytes and in hex digits of an object name (SHA-1 value). */
45 #define GIT_SHA1_RAWSZ 20
46 #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
48 /* The length in byte and in hex digits of the largest possible hash value. */
49 #define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ
50 #define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ
53 unsigned char hash
[GIT_MAX_RAWSZ
];
56 #define the_hash_algo the_repository->hash_algo
58 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
59 #define DTYPE(de) ((de)->d_type)
69 #define DTYPE(de) DT_UNKNOWN
72 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
73 #define S_IFINVALID 0030000
76 * A "directory link" is a link to another git directory.
78 * The value 0160000 is not normally a valid mode, and
79 * also just happens to be S_IFDIR + S_IFLNK
81 #define S_IFGITLINK 0160000
82 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
85 * Some mode bits are also used internally for computations.
87 * They *must* not overlap with any valid modes, and they *must* not be emitted
88 * to outside world - i.e. appear on disk or network. In other words, it's just
89 * temporary fields, which we internally use, but they have to stay in-house.
91 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
92 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
95 /* used internally in tree-diff */
96 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
100 * Intensive research over the course of many years has shown that
101 * port 9418 is totally unused by anything else. Or
103 * Your search - "port 9418" - did not match any documents.
105 * as www.google.com puts it.
107 * This port has been properly assigned for git use by IANA:
108 * git (Assigned-9418) [I06-050728-0001].
110 * git 9418/tcp git pack transfer service
111 * git 9418/udp git pack transfer service
113 * with Linus Torvalds <torvalds@osdl.org> as the point of
114 * contact. September 2005.
116 * See http://www.iana.org/assignments/port-numbers
118 #define DEFAULT_GIT_PORT 9418
121 * Basic data structures for the directory cache
124 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
125 struct cache_header
{
126 uint32_t hdr_signature
;
127 uint32_t hdr_version
;
128 uint32_t hdr_entries
;
131 #define INDEX_FORMAT_LB 2
132 #define INDEX_FORMAT_UB 4
135 * The "cache_time" is just the low 32 bits of the
136 * time. It doesn't matter if it overflows - we only
137 * check it for equality in the 32 bits we save.
145 struct cache_time sd_ctime
;
146 struct cache_time sd_mtime
;
151 unsigned int sd_size
;
155 struct hashmap_entry ent
;
156 struct stat_data ce_stat_data
;
157 unsigned int ce_mode
;
158 unsigned int ce_flags
;
159 unsigned int ce_namelen
;
160 unsigned int index
; /* for link extension */
161 struct object_id oid
;
162 char name
[FLEX_ARRAY
]; /* more */
165 #define CE_STAGEMASK (0x3000)
166 #define CE_EXTENDED (0x4000)
167 #define CE_VALID (0x8000)
168 #define CE_STAGESHIFT 12
171 * Range 0xFFFF0FFF in ce_flags is divided into
172 * two parts: in-memory flags and on-disk ones.
173 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
174 * if you want to save a new flag, add it in
177 * In-memory only flags
179 #define CE_UPDATE (1 << 16)
180 #define CE_REMOVE (1 << 17)
181 #define CE_UPTODATE (1 << 18)
182 #define CE_ADDED (1 << 19)
184 #define CE_HASHED (1 << 20)
185 #define CE_FSMONITOR_VALID (1 << 21)
186 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
187 #define CE_CONFLICTED (1 << 23)
189 #define CE_UNPACKED (1 << 24)
190 #define CE_NEW_SKIP_WORKTREE (1 << 25)
192 /* used to temporarily mark paths matched by pathspecs */
193 #define CE_MATCHED (1 << 26)
195 #define CE_UPDATE_IN_BASE (1 << 27)
196 #define CE_STRIP_NAME (1 << 28)
199 * Extended on-disk flags
201 #define CE_INTENT_TO_ADD (1 << 29)
202 #define CE_SKIP_WORKTREE (1 << 30)
203 /* CE_EXTENDED2 is for future extension */
204 #define CE_EXTENDED2 (1U << 31)
206 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
209 * Safeguard to avoid saving wrong flags:
210 * - CE_EXTENDED2 won't get saved until its semantic is known
211 * - Bits in 0x0000FFFF have been saved in ce_flags already
212 * - Bits in 0x003F0000 are currently in-memory flags
214 #if CE_EXTENDED_FLAGS & 0x803FFFFF
215 #error "CE_EXTENDED_FLAGS out of range"
218 /* Forward structure decls */
220 struct child_process
;
223 * Copy the sha1 and stat state of a cache entry from one to
224 * another. But we never change the name, or the hash state!
226 static inline void copy_cache_entry(struct cache_entry
*dst
,
227 const struct cache_entry
*src
)
229 unsigned int state
= dst
->ce_flags
& CE_HASHED
;
231 /* Don't copy hash chain and name */
232 memcpy(&dst
->ce_stat_data
, &src
->ce_stat_data
,
233 offsetof(struct cache_entry
, name
) -
234 offsetof(struct cache_entry
, ce_stat_data
));
236 /* Restore the hash state */
237 dst
->ce_flags
= (dst
->ce_flags
& ~CE_HASHED
) | state
;
240 static inline unsigned create_ce_flags(unsigned stage
)
242 return (stage
<< CE_STAGESHIFT
);
245 #define ce_namelen(ce) ((ce)->ce_namelen)
246 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
247 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
248 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
249 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
250 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
251 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
253 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
254 static inline unsigned int create_ce_mode(unsigned int mode
)
258 if (S_ISDIR(mode
) || S_ISGITLINK(mode
))
260 return S_IFREG
| ce_permissions(mode
);
262 static inline unsigned int ce_mode_from_stat(const struct cache_entry
*ce
,
265 extern int trust_executable_bit
, has_symlinks
;
266 if (!has_symlinks
&& S_ISREG(mode
) &&
267 ce
&& S_ISLNK(ce
->ce_mode
))
269 if (!trust_executable_bit
&& S_ISREG(mode
)) {
270 if (ce
&& S_ISREG(ce
->ce_mode
))
272 return create_ce_mode(0666);
274 return create_ce_mode(mode
);
276 static inline int ce_to_dtype(const struct cache_entry
*ce
)
278 unsigned ce_mode
= ntohl(ce
->ce_mode
);
279 if (S_ISREG(ce_mode
))
281 else if (S_ISDIR(ce_mode
) || S_ISGITLINK(ce_mode
))
283 else if (S_ISLNK(ce_mode
))
288 static inline unsigned int canon_mode(unsigned int mode
)
291 return S_IFREG
| ce_permissions(mode
);
299 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
301 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
302 #define CE_ENTRY_CHANGED (1 << 1)
303 #define CE_ENTRY_REMOVED (1 << 2)
304 #define CE_ENTRY_ADDED (1 << 3)
305 #define RESOLVE_UNDO_CHANGED (1 << 4)
306 #define CACHE_TREE_CHANGED (1 << 5)
307 #define SPLIT_INDEX_ORDERED (1 << 6)
308 #define UNTRACKED_CHANGED (1 << 7)
309 #define FSMONITOR_CHANGED (1 << 8)
312 struct untracked_cache
;
315 struct cache_entry
**cache
;
316 unsigned int version
;
317 unsigned int cache_nr
, cache_alloc
, cache_changed
;
318 struct string_list
*resolve_undo
;
319 struct cache_tree
*cache_tree
;
320 struct split_index
*split_index
;
321 struct cache_time timestamp
;
322 unsigned name_hash_initialized
: 1,
325 struct hashmap name_hash
;
326 struct hashmap dir_hash
;
327 struct object_id oid
;
328 struct untracked_cache
*untracked
;
329 uint64_t fsmonitor_last_update
;
330 struct ewah_bitmap
*fsmonitor_dirty
;
333 extern struct index_state the_index
;
336 extern int test_lazy_init_name_hash(struct index_state
*istate
, int try_threaded
);
337 extern void add_name_hash(struct index_state
*istate
, struct cache_entry
*ce
);
338 extern void remove_name_hash(struct index_state
*istate
, struct cache_entry
*ce
);
339 extern void free_name_hash(struct index_state
*istate
);
342 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
343 #define active_cache (the_index.cache)
344 #define active_nr (the_index.cache_nr)
345 #define active_alloc (the_index.cache_alloc)
346 #define active_cache_changed (the_index.cache_changed)
347 #define active_cache_tree (the_index.cache_tree)
349 #define read_cache() read_index(&the_index)
350 #define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir()))
351 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
352 #define is_cache_unborn() is_index_unborn(&the_index)
353 #define read_cache_unmerged() read_index_unmerged(&the_index)
354 #define discard_cache() discard_index(&the_index)
355 #define unmerged_cache() unmerged_index(&the_index)
356 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
357 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
358 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
359 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
360 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
361 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
362 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
363 #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
364 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
365 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
366 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
367 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
368 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
369 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
370 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
371 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
372 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
373 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
379 * Values in this enum (except those outside the 3 bit range) are part
380 * of pack file format. See Documentation/technical/pack-format.txt
381 * for more information.
390 /* 5 for future expansion */
397 static inline enum object_type
object_type(unsigned int mode
)
399 return S_ISDIR(mode
) ? OBJ_TREE
:
400 S_ISGITLINK(mode
) ? OBJ_COMMIT
:
404 /* Double-check local_repo_env below if you add to this list. */
405 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
406 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
407 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
408 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
409 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
410 #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
411 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
412 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
413 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
414 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
415 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
416 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
417 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
418 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
419 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
420 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
421 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
422 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
423 #define GITATTRIBUTES_FILE ".gitattributes"
424 #define INFOATTRIBUTES_FILE "info/attributes"
425 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
426 #define GITMODULES_FILE ".gitmodules"
427 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
428 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
429 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
430 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
431 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
432 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
433 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
434 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
435 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
436 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
437 #define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
438 #define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT "GIT_TEXTDOMAINDIR"
441 * Environment variable used in handshaking the wire protocol.
442 * Contains a colon ':' separated list of keys with optional values
443 * 'key[=value]'. Presence of unknown keys and values must be
446 #define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
447 /* HTTP header used to handshake the wire protocol */
448 #define GIT_PROTOCOL_HEADER "Git-Protocol"
451 * This environment variable is expected to contain a boolean indicating
452 * whether we should or should not treat:
454 * GIT_DIR=foo.git git ...
456 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
457 * of this, but we use it internally to communicate to sub-processes that we
458 * are in a bare repo. If not set, defaults to true.
460 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
463 * Repository-local GIT_* environment variables; these will be cleared
464 * when git spawns a sub-process that runs inside another repository.
465 * The array is NULL-terminated, which makes it easy to pass in the "env"
466 * parameter of a run-command invocation, or to do a simple walk.
468 extern const char * const local_repo_env
[];
470 extern void setup_git_env(const char *git_dir
);
473 * Returns true iff we have a configured git repository (either via
474 * setup_git_directory, or in the environment via $GIT_DIR).
476 int have_git_dir(void);
478 extern int is_bare_repository_cfg
;
479 extern int is_bare_repository(void);
480 extern int is_inside_git_dir(void);
481 extern char *git_work_tree_cfg
;
482 extern int is_inside_work_tree(void);
483 extern const char *get_git_dir(void);
484 extern const char *get_git_common_dir(void);
485 extern char *get_object_directory(void);
486 extern char *get_index_file(void);
487 extern char *get_graft_file(struct repository
*r
);
488 extern void set_git_dir(const char *path
);
489 extern int get_common_dir_noenv(struct strbuf
*sb
, const char *gitdir
);
490 extern int get_common_dir(struct strbuf
*sb
, const char *gitdir
);
491 extern const char *get_git_namespace(void);
492 extern const char *strip_namespace(const char *namespaced_ref
);
493 extern const char *get_super_prefix(void);
494 extern const char *get_git_work_tree(void);
497 * Return true if the given path is a git directory; note that this _just_
498 * looks at the directory itself. If you want to know whether "foo/.git"
499 * is a repository, you must feed that path, not just "foo".
501 extern int is_git_directory(const char *path
);
504 * Return 1 if the given path is the root of a git repository or
505 * submodule, else 0. Will not return 1 for bare repositories with the
506 * exception of creating a bare repository in "foo/.git" and calling
507 * is_git_repository("foo").
509 * If we run into read errors, we err on the side of saying "yes, it is",
510 * as we usually consider sub-repos precious, and would prefer to err on the
511 * side of not disrupting or deleting them.
513 extern int is_nonbare_repository_dir(struct strbuf
*path
);
515 #define READ_GITFILE_ERR_STAT_FAILED 1
516 #define READ_GITFILE_ERR_NOT_A_FILE 2
517 #define READ_GITFILE_ERR_OPEN_FAILED 3
518 #define READ_GITFILE_ERR_READ_FAILED 4
519 #define READ_GITFILE_ERR_INVALID_FORMAT 5
520 #define READ_GITFILE_ERR_NO_PATH 6
521 #define READ_GITFILE_ERR_NOT_A_REPO 7
522 #define READ_GITFILE_ERR_TOO_LARGE 8
523 extern void read_gitfile_error_die(int error_code
, const char *path
, const char *dir
);
524 extern const char *read_gitfile_gently(const char *path
, int *return_error_code
);
525 #define read_gitfile(path) read_gitfile_gently((path), NULL)
526 extern const char *resolve_gitdir_gently(const char *suspect
, int *return_error_code
);
527 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
529 extern void set_git_work_tree(const char *tree
);
531 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
533 extern void setup_work_tree(void);
535 * Find the commondir and gitdir of the repository that contains the current
536 * working directory, without changing the working directory or other global
537 * state. The result is appended to commondir and gitdir. If the discovered
538 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
539 * both have the same result appended to the buffer. The return value is
540 * either 0 upon success and non-zero if no repository was found.
542 extern int discover_git_directory(struct strbuf
*commondir
,
543 struct strbuf
*gitdir
);
544 extern const char *setup_git_directory_gently(int *);
545 extern const char *setup_git_directory(void);
546 extern char *prefix_path(const char *prefix
, int len
, const char *path
);
547 extern char *prefix_path_gently(const char *prefix
, int len
, int *remaining
, const char *path
);
550 * Concatenate "prefix" (if len is non-zero) and "path", with no
551 * connecting characters (so "prefix" should end with a "/").
552 * Unlike prefix_path, this should be used if the named file does
553 * not have to interact with index entry; i.e. name of a random file
556 * The return value is always a newly allocated string (even if the
559 extern char *prefix_filename(const char *prefix
, const char *path
);
561 extern int check_filename(const char *prefix
, const char *name
);
562 extern void verify_filename(const char *prefix
,
564 int diagnose_misspelt_rev
);
565 extern void verify_non_filename(const char *prefix
, const char *name
);
566 extern int path_inside_repo(const char *prefix
, const char *path
);
568 #define INIT_DB_QUIET 0x0001
569 #define INIT_DB_EXIST_OK 0x0002
571 extern int init_db(const char *git_dir
, const char *real_git_dir
,
572 const char *template_dir
, unsigned int flags
);
574 extern void sanitize_stdfds(void);
575 extern int daemonize(void);
577 #define alloc_nr(x) (((x)+16)*3/2)
580 * Realloc the buffer pointed at by variable 'x' so that it can hold
581 * at least 'nr' entries; the number of entries currently allocated
582 * is 'alloc', using the standard growing factor alloc_nr() macro.
584 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
586 #define ALLOC_GROW(x, nr, alloc) \
588 if ((nr) > alloc) { \
589 if (alloc_nr(alloc) < (nr)) \
592 alloc = alloc_nr(alloc); \
593 REALLOC_ARRAY(x, alloc); \
597 /* Initialize and use the cache information */
599 extern int read_index(struct index_state
*);
600 extern int read_index_preload(struct index_state
*, const struct pathspec
*pathspec
);
601 extern int do_read_index(struct index_state
*istate
, const char *path
,
602 int must_exist
); /* for testting only! */
603 extern int read_index_from(struct index_state
*, const char *path
,
605 extern int is_index_unborn(struct index_state
*);
606 extern int read_index_unmerged(struct index_state
*);
608 /* For use with `write_locked_index()`. */
609 #define COMMIT_LOCK (1 << 0)
610 #define SKIP_IF_UNCHANGED (1 << 1)
613 * Write the index while holding an already-taken lock. Close the lock,
614 * and if `COMMIT_LOCK` is given, commit it.
616 * Unless a split index is in use, write the index into the lockfile.
618 * With a split index, write the shared index to a temporary file,
619 * adjust its permissions and rename it into place, then write the
620 * split index to the lockfile. If the temporary file for the shared
621 * index cannot be created, fall back to the behavior described in
622 * the previous paragraph.
624 * With `COMMIT_LOCK`, the lock is always committed or rolled back.
625 * Without it, the lock is closed, but neither committed nor rolled
628 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing
629 * is written (and the lock is rolled back if `COMMIT_LOCK` is given).
631 extern int write_locked_index(struct index_state
*, struct lock_file
*lock
, unsigned flags
);
633 extern int discard_index(struct index_state
*);
634 extern void move_index_extensions(struct index_state
*dst
, struct index_state
*src
);
635 extern int unmerged_index(const struct index_state
*);
638 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn
639 * branch, returns 1 if there are entries in the index, 0 otherwise. If an
640 * strbuf is provided, the space-separated list of files that differ will be
643 extern int index_has_changes(struct strbuf
*sb
);
645 extern int verify_path(const char *path
, unsigned mode
);
646 extern int strcmp_offset(const char *s1
, const char *s2
, size_t *first_change
);
647 extern int index_dir_exists(struct index_state
*istate
, const char *name
, int namelen
);
648 extern void adjust_dirname_case(struct index_state
*istate
, char *name
);
649 extern struct cache_entry
*index_file_exists(struct index_state
*istate
, const char *name
, int namelen
, int igncase
);
652 * Searches for an entry defined by name and namelen in the given index.
653 * If the return value is positive (including 0) it is the position of an
654 * exact match. If the return value is negative, the negated value minus 1
655 * is the position where the entry would be inserted.
656 * Example: The current index consists of these files and its stages:
660 * index_name_pos(&index, "a", 1) -> -1
661 * index_name_pos(&index, "b", 1) -> 0
662 * index_name_pos(&index, "c", 1) -> -2
663 * index_name_pos(&index, "d", 1) -> 1
664 * index_name_pos(&index, "e", 1) -> -3
665 * index_name_pos(&index, "f", 1) -> -3
666 * index_name_pos(&index, "g", 1) -> -5
668 extern int index_name_pos(const struct index_state
*, const char *name
, int namelen
);
670 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
671 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
672 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
673 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
674 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
675 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
676 extern int add_index_entry(struct index_state
*, struct cache_entry
*ce
, int option
);
677 extern void rename_index_entry_at(struct index_state
*, int pos
, const char *new_name
);
679 /* Remove entry, return true if there are more entries to go. */
680 extern int remove_index_entry_at(struct index_state
*, int pos
);
682 extern void remove_marked_cache_entries(struct index_state
*istate
);
683 extern int remove_file_from_index(struct index_state
*, const char *path
);
684 #define ADD_CACHE_VERBOSE 1
685 #define ADD_CACHE_PRETEND 2
686 #define ADD_CACHE_IGNORE_ERRORS 4
687 #define ADD_CACHE_IGNORE_REMOVAL 8
688 #define ADD_CACHE_INTENT 16
690 * These two are used to add the contents of the file at path
691 * to the index, marking the working tree up-to-date by storing
692 * the cached stat info in the resulting cache entry. A caller
693 * that has already run lstat(2) on the path can call
694 * add_to_index(), and all others can call add_file_to_index();
695 * the latter will do necessary lstat(2) internally before
696 * calling the former.
698 extern int add_to_index(struct index_state
*, const char *path
, struct stat
*, int flags
);
699 extern int add_file_to_index(struct index_state
*, const char *path
, int flags
);
701 extern struct cache_entry
*make_cache_entry(unsigned int mode
, const unsigned char *sha1
, const char *path
, int stage
, unsigned int refresh_options
);
702 extern int chmod_index_entry(struct index_state
*, struct cache_entry
*ce
, char flip
);
703 extern int ce_same_name(const struct cache_entry
*a
, const struct cache_entry
*b
);
704 extern void set_object_name_for_intent_to_add_entry(struct cache_entry
*ce
);
705 extern int index_name_is_other(const struct index_state
*, const char *, int);
706 extern void *read_blob_data_from_index(const struct index_state
*, const char *, unsigned long *);
708 /* do stat comparison even if CE_VALID is true */
709 #define CE_MATCH_IGNORE_VALID 01
710 /* do not check the contents but report dirty on racily-clean entries */
711 #define CE_MATCH_RACY_IS_DIRTY 02
712 /* do stat comparison even if CE_SKIP_WORKTREE is true */
713 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
714 /* ignore non-existent files during stat update */
715 #define CE_MATCH_IGNORE_MISSING 0x08
716 /* enable stat refresh */
717 #define CE_MATCH_REFRESH 0x10
718 /* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
719 #define CE_MATCH_IGNORE_FSMONITOR 0X20
720 extern int ie_match_stat(struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
721 extern int ie_modified(struct index_state
*, const struct cache_entry
*, struct stat
*, unsigned int);
723 #define HASH_WRITE_OBJECT 1
724 #define HASH_FORMAT_CHECK 2
725 #define HASH_RENORMALIZE 4
726 extern int index_fd(struct object_id
*oid
, int fd
, struct stat
*st
, enum object_type type
, const char *path
, unsigned flags
);
727 extern int index_path(struct object_id
*oid
, const char *path
, struct stat
*st
, unsigned flags
);
730 * Record to sd the data from st that we use to check whether a file
731 * might have changed.
733 extern void fill_stat_data(struct stat_data
*sd
, struct stat
*st
);
736 * Return 0 if st is consistent with a file not having been changed
737 * since sd was filled. If there are differences, return a
738 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
739 * INODE_CHANGED, and DATA_CHANGED.
741 extern int match_stat_data(const struct stat_data
*sd
, struct stat
*st
);
742 extern int match_stat_data_racy(const struct index_state
*istate
,
743 const struct stat_data
*sd
, struct stat
*st
);
745 extern void fill_stat_cache_info(struct cache_entry
*ce
, struct stat
*st
);
747 #define REFRESH_REALLY 0x0001 /* ignore_valid */
748 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
749 #define REFRESH_QUIET 0x0004 /* be quiet about it */
750 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
751 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
752 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
753 extern int refresh_index(struct index_state
*, unsigned int flags
, const struct pathspec
*pathspec
, char *seen
, const char *header_msg
);
754 extern struct cache_entry
*refresh_cache_entry(struct cache_entry
*, unsigned int);
757 * Opportunistically update the index but do not complain if we can't.
758 * The lockfile is always committed or rolled back.
760 extern void update_index_if_able(struct index_state
*, struct lock_file
*);
762 extern int hold_locked_index(struct lock_file
*, int);
763 extern void set_alternate_index_output(const char *);
765 extern int verify_index_checksum
;
766 extern int verify_ce_order
;
768 /* Environment bits from configuration mechanism */
769 extern int trust_executable_bit
;
770 extern int trust_ctime
;
771 extern int check_stat
;
772 extern int quote_path_fully
;
773 extern int has_symlinks
;
774 extern int minimum_abbrev
, default_abbrev
;
775 extern int ignore_case
;
776 extern int assume_unchanged
;
777 extern int prefer_symlink_refs
;
778 extern int warn_ambiguous_refs
;
779 extern int warn_on_object_refname_ambiguity
;
780 extern const char *apply_default_whitespace
;
781 extern const char *apply_default_ignorewhitespace
;
782 extern const char *git_attributes_file
;
783 extern const char *git_hooks_path
;
784 extern int zlib_compression_level
;
785 extern int core_compression_level
;
786 extern int pack_compression_level
;
787 extern size_t packed_git_window_size
;
788 extern size_t packed_git_limit
;
789 extern size_t delta_base_cache_limit
;
790 extern unsigned long big_file_threshold
;
791 extern unsigned long pack_size_limit_cfg
;
794 * Accessors for the core.sharedrepository config which lazy-load the value
795 * from the config (if not already set). The "reset" function can be
796 * used to unset "set" or cached value, meaning that the value will be loaded
797 * fresh from the config file on the next call to get_shared_repository().
799 void set_shared_repository(int value
);
800 int get_shared_repository(void);
801 void reset_shared_repository(void);
804 * Do replace refs need to be checked this run? This variable is
805 * initialized to true unless --no-replace-object is used or
806 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
807 * commands that do not want replace references to be active.
809 extern int check_replace_refs
;
810 extern char *git_replace_ref_base
;
812 extern int fsync_object_files
;
813 extern int core_preload_index
;
814 extern int core_commit_graph
;
815 extern int core_apply_sparse_checkout
;
816 extern int precomposed_unicode
;
817 extern int protect_hfs
;
818 extern int protect_ntfs
;
819 extern const char *core_fsmonitor
;
822 * Include broken refs in all ref iterations, which will
823 * generally choke dangerous operations rather than letting
824 * them silently proceed without taking the broken ref into
827 extern int ref_paranoia
;
830 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
832 int use_optional_locks(void);
835 * The character that begins a commented line in user-editable file
836 * that is subject to stripspace.
838 extern char comment_line_char
;
839 extern int auto_comment_line_char
;
842 enum hide_dotfiles_type
{
843 HIDE_DOTFILES_FALSE
= 0,
845 HIDE_DOTFILES_DOTGITONLY
847 extern enum hide_dotfiles_type hide_dotfiles
;
849 enum log_refs_config
{
855 extern enum log_refs_config log_all_ref_updates
;
858 BRANCH_TRACK_UNSPECIFIED
= -1,
859 BRANCH_TRACK_NEVER
= 0,
862 BRANCH_TRACK_EXPLICIT
,
863 BRANCH_TRACK_OVERRIDE
866 enum rebase_setup_type
{
867 AUTOREBASE_NEVER
= 0,
873 enum push_default_type
{
874 PUSH_DEFAULT_NOTHING
= 0,
875 PUSH_DEFAULT_MATCHING
,
877 PUSH_DEFAULT_UPSTREAM
,
878 PUSH_DEFAULT_CURRENT
,
879 PUSH_DEFAULT_UNSPECIFIED
882 extern enum branch_track git_branch_track
;
883 extern enum rebase_setup_type autorebase
;
884 extern enum push_default_type push_default
;
886 enum object_creation_mode
{
887 OBJECT_CREATION_USES_HARDLINKS
= 0,
888 OBJECT_CREATION_USES_RENAMES
= 1
891 extern enum object_creation_mode object_creation_mode
;
893 extern char *notes_ref_name
;
895 extern int grafts_replace_parents
;
898 * GIT_REPO_VERSION is the version we write by default. The
899 * _READ variant is the highest number we know how to
902 #define GIT_REPO_VERSION 0
903 #define GIT_REPO_VERSION_READ 1
904 extern int repository_format_precious_objects
;
905 extern char *repository_format_partial_clone
;
906 extern const char *core_partial_clone_filter_default
;
908 struct repository_format
{
910 int precious_objects
;
911 char *partial_clone
; /* value of extensions.partialclone */
915 struct string_list unknown_extensions
;
919 * Read the repository format characteristics from the config file "path" into
920 * "format" struct. Returns the numeric version. On error, -1 is returned,
921 * format->version is set to -1, and all other fields in the struct are
924 int read_repository_format(struct repository_format
*format
, const char *path
);
927 * Verify that the repository described by repository_format is something we
928 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
929 * any errors encountered.
931 int verify_repository_format(const struct repository_format
*format
,
935 * Check the repository format version in the path found in get_git_dir(),
936 * and die if it is a version we don't understand. Generally one would
937 * set_git_dir() before calling this, and use it only for "are we in a valid
940 extern void check_repository_format(void);
942 #define MTIME_CHANGED 0x0001
943 #define CTIME_CHANGED 0x0002
944 #define OWNER_CHANGED 0x0004
945 #define MODE_CHANGED 0x0008
946 #define INODE_CHANGED 0x0010
947 #define DATA_CHANGED 0x0020
948 #define TYPE_CHANGED 0x0040
951 * Return an abbreviated sha1 unique within this repository's object database.
952 * The result will be at least `len` characters long, and will be NUL
955 * The non-`_r` version returns a static buffer which remains valid until 4
956 * more calls to find_unique_abbrev are made.
958 * The `_r` variant writes to a buffer supplied by the caller, which must be at
959 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes
960 * written (excluding the NUL terminator).
962 * Note that while this version avoids the static buffer, it is not fully
963 * reentrant, as it calls into other non-reentrant git code.
965 extern const char *find_unique_abbrev(const struct object_id
*oid
, int len
);
966 extern int find_unique_abbrev_r(char *hex
, const struct object_id
*oid
, int len
);
968 extern const unsigned char null_sha1
[GIT_MAX_RAWSZ
];
969 extern const struct object_id null_oid
;
971 static inline int hashcmp(const unsigned char *sha1
, const unsigned char *sha2
)
973 return memcmp(sha1
, sha2
, GIT_SHA1_RAWSZ
);
976 static inline int oidcmp(const struct object_id
*oid1
, const struct object_id
*oid2
)
978 return hashcmp(oid1
->hash
, oid2
->hash
);
981 static inline int is_null_sha1(const unsigned char *sha1
)
983 return !hashcmp(sha1
, null_sha1
);
986 static inline int is_null_oid(const struct object_id
*oid
)
988 return !hashcmp(oid
->hash
, null_sha1
);
991 static inline void hashcpy(unsigned char *sha_dst
, const unsigned char *sha_src
)
993 memcpy(sha_dst
, sha_src
, GIT_SHA1_RAWSZ
);
996 static inline void oidcpy(struct object_id
*dst
, const struct object_id
*src
)
998 hashcpy(dst
->hash
, src
->hash
);
1001 static inline struct object_id
*oiddup(const struct object_id
*src
)
1003 struct object_id
*dst
= xmalloc(sizeof(struct object_id
));
1008 static inline void hashclr(unsigned char *hash
)
1010 memset(hash
, 0, GIT_SHA1_RAWSZ
);
1013 static inline void oidclr(struct object_id
*oid
)
1015 memset(oid
->hash
, 0, GIT_MAX_RAWSZ
);
1018 static inline void oidread(struct object_id
*oid
, const unsigned char *hash
)
1020 memcpy(oid
->hash
, hash
, the_hash_algo
->rawsz
);
1023 static inline int is_empty_blob_sha1(const unsigned char *sha1
)
1025 return !hashcmp(sha1
, the_hash_algo
->empty_blob
->hash
);
1028 static inline int is_empty_blob_oid(const struct object_id
*oid
)
1030 return !oidcmp(oid
, the_hash_algo
->empty_blob
);
1033 static inline int is_empty_tree_sha1(const unsigned char *sha1
)
1035 return !hashcmp(sha1
, the_hash_algo
->empty_tree
->hash
);
1038 static inline int is_empty_tree_oid(const struct object_id
*oid
)
1040 return !oidcmp(oid
, the_hash_algo
->empty_tree
);
1043 const char *empty_tree_oid_hex(void);
1044 const char *empty_blob_oid_hex(void);
1046 /* set default permissions by passing mode arguments to open(2) */
1047 int git_mkstemps_mode(char *pattern
, int suffix_len
, int mode
);
1048 int git_mkstemp_mode(char *pattern
, int mode
);
1053 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1054 * not be changed. Old repositories have core.sharedrepository written in
1055 * numeric format, and therefore these values are preserved for compatibility
1061 OLD_PERM_EVERYBODY
= 2,
1063 PERM_EVERYBODY
= 0664
1065 int git_config_perm(const char *var
, const char *value
);
1066 int adjust_shared_perm(const char *path
);
1069 * Create the directory containing the named path, using care to be
1070 * somewhat safe against races. Return one of the scld_error values to
1071 * indicate success/failure. On error, set errno to describe the
1074 * SCLD_VANISHED indicates that one of the ancestor directories of the
1075 * path existed at one point during the function call and then
1076 * suddenly vanished, probably because another process pruned the
1077 * directory while we were working. To be robust against this kind of
1078 * race, callers might want to try invoking the function again when it
1079 * returns SCLD_VANISHED.
1081 * safe_create_leading_directories() temporarily changes path while it
1082 * is working but restores it before returning.
1083 * safe_create_leading_directories_const() doesn't modify path, even
1093 enum scld_error
safe_create_leading_directories(char *path
);
1094 enum scld_error
safe_create_leading_directories_const(const char *path
);
1097 * Callback function for raceproof_create_file(). This function is
1098 * expected to do something that makes dirname(path) permanent despite
1099 * the fact that other processes might be cleaning up empty
1100 * directories at the same time. Usually it will create a file named
1101 * path, but alternatively it could create another file in that
1102 * directory, or even chdir() into that directory. The function should
1103 * return 0 if the action was completed successfully. On error, it
1104 * should return a nonzero result and set errno.
1105 * raceproof_create_file() treats two errno values specially:
1107 * - ENOENT -- dirname(path) does not exist. In this case,
1108 * raceproof_create_file() tries creating dirname(path)
1109 * (and any parent directories, if necessary) and calls
1110 * the function again.
1112 * - EISDIR -- the file already exists and is a directory. In this
1113 * case, raceproof_create_file() removes the directory if
1114 * it is empty (and recursively any empty directories that
1115 * it contains) and calls the function again.
1117 * Any other errno causes raceproof_create_file() to fail with the
1118 * callback's return value and errno.
1120 * Obviously, this function should be OK with being called again if it
1121 * fails with ENOENT or EISDIR. In other scenarios it will not be
1124 typedef int create_file_fn(const char *path
, void *cb
);
1127 * Create a file in dirname(path) by calling fn, creating leading
1128 * directories if necessary. Retry a few times in case we are racing
1129 * with another process that is trying to clean up the directory that
1130 * contains path. See the documentation for create_file_fn for more
1133 * Return the value and set the errno that resulted from the most
1134 * recent call of fn. fn is always called at least once, and will be
1135 * called more than once if it returns ENOENT or EISDIR.
1137 int raceproof_create_file(const char *path
, create_file_fn fn
, void *cb
);
1139 int mkdir_in_gitdir(const char *path
);
1140 extern char *expand_user_path(const char *path
, int real_home
);
1141 const char *enter_repo(const char *path
, int strict
);
1142 static inline int is_absolute_path(const char *path
)
1144 return is_dir_sep(path
[0]) || has_dos_drive_prefix(path
);
1146 int is_directory(const char *);
1147 char *strbuf_realpath(struct strbuf
*resolved
, const char *path
,
1149 const char *real_path(const char *path
);
1150 const char *real_path_if_valid(const char *path
);
1151 char *real_pathdup(const char *path
, int die_on_error
);
1152 const char *absolute_path(const char *path
);
1153 char *absolute_pathdup(const char *path
);
1154 const char *remove_leading_path(const char *in
, const char *prefix
);
1155 const char *relative_path(const char *in
, const char *prefix
, struct strbuf
*sb
);
1156 int normalize_path_copy_len(char *dst
, const char *src
, int *prefix_len
);
1157 int normalize_path_copy(char *dst
, const char *src
);
1158 int longest_ancestor_length(const char *path
, struct string_list
*prefixes
);
1159 char *strip_path_suffix(const char *path
, const char *suffix
);
1160 int daemon_avoid_alias(const char *path
);
1163 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for
1166 int is_ntfs_dotgit(const char *name
);
1167 int is_ntfs_dotgitmodules(const char *name
);
1168 int is_ntfs_dotgitignore(const char *name
);
1169 int is_ntfs_dotgitattributes(const char *name
);
1172 * Returns true iff "str" could be confused as a command-line option when
1173 * passed to a sub-program like "ssh". Note that this has nothing to do with
1174 * shell-quoting, which should be handled separately; we're assuming here that
1175 * the string makes it verbatim to the sub-program.
1177 int looks_like_command_line_option(const char *str
);
1180 * Return a newly allocated string with the evaluation of
1181 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1182 * "$HOME/.config/git/$filename". Return NULL upon error.
1184 extern char *xdg_config_home(const char *filename
);
1187 * Return a newly allocated string with the evaluation of
1188 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1189 * "$HOME/.cache/git/$filename". Return NULL upon error.
1191 extern char *xdg_cache_home(const char *filename
);
1193 extern int git_open_cloexec(const char *name
, int flags
);
1194 #define git_open(name) git_open_cloexec(name, O_RDONLY)
1195 extern int unpack_sha1_header(git_zstream
*stream
, unsigned char *map
, unsigned long mapsize
, void *buffer
, unsigned long bufsiz
);
1196 extern int parse_sha1_header(const char *hdr
, unsigned long *sizep
);
1198 extern int check_object_signature(const struct object_id
*oid
, void *buf
, unsigned long size
, const char *type
);
1200 extern int finalize_object_file(const char *tmpfile
, const char *filename
);
1202 /* Helper to check and "touch" a file */
1203 extern int check_and_freshen_file(const char *fn
, int freshen
);
1205 extern const signed char hexval_table
[256];
1206 static inline unsigned int hexval(unsigned char c
)
1208 return hexval_table
[c
];
1212 * Convert two consecutive hexadecimal digits into a char. Return a
1213 * negative value on error. Don't run over the end of short strings.
1215 static inline int hex2chr(const char *s
)
1217 unsigned int val
= hexval(s
[0]);
1218 return (val
& ~0xf) ? val
: (val
<< 4) | hexval(s
[1]);
1221 /* Convert to/from hex/sha1 representation */
1222 #define MINIMUM_ABBREV minimum_abbrev
1223 #define DEFAULT_ABBREV default_abbrev
1225 /* used when the code does not know or care what the default abbrev is */
1226 #define FALLBACK_DEFAULT_ABBREV 7
1228 struct object_context
{
1231 * symlink_path is only used by get_tree_entry_follow_symlinks,
1232 * and only for symlinks that point outside the repository.
1234 struct strbuf symlink_path
;
1236 * If GET_OID_RECORD_PATH is set, this will record path (if any)
1237 * found when resolving the name. The caller is responsible for
1238 * releasing the memory.
1243 #define GET_OID_QUIETLY 01
1244 #define GET_OID_COMMIT 02
1245 #define GET_OID_COMMITTISH 04
1246 #define GET_OID_TREE 010
1247 #define GET_OID_TREEISH 020
1248 #define GET_OID_BLOB 040
1249 #define GET_OID_FOLLOW_SYMLINKS 0100
1250 #define GET_OID_RECORD_PATH 0200
1251 #define GET_OID_ONLY_TO_DIE 04000
1253 #define GET_OID_DISAMBIGUATORS \
1254 (GET_OID_COMMIT | GET_OID_COMMITTISH | \
1255 GET_OID_TREE | GET_OID_TREEISH | \
1258 extern int get_oid(const char *str
, struct object_id
*oid
);
1259 extern int get_oid_commit(const char *str
, struct object_id
*oid
);
1260 extern int get_oid_committish(const char *str
, struct object_id
*oid
);
1261 extern int get_oid_tree(const char *str
, struct object_id
*oid
);
1262 extern int get_oid_treeish(const char *str
, struct object_id
*oid
);
1263 extern int get_oid_blob(const char *str
, struct object_id
*oid
);
1264 extern void maybe_die_on_misspelt_object_name(const char *name
, const char *prefix
);
1265 extern int get_oid_with_context(const char *str
, unsigned flags
, struct object_id
*oid
, struct object_context
*oc
);
1268 typedef int each_abbrev_fn(const struct object_id
*oid
, void *);
1269 extern int for_each_abbrev(const char *prefix
, each_abbrev_fn
, void *);
1271 extern int set_disambiguate_hint_config(const char *var
, const char *value
);
1274 * Try to read a SHA1 in hexadecimal format from the 40 characters
1275 * starting at hex. Write the 20-byte result to sha1 in binary form.
1276 * Return 0 on success. Reading stops if a NUL is encountered in the
1277 * input, so it is safe to pass this function an arbitrary
1278 * null-terminated string.
1280 extern int get_sha1_hex(const char *hex
, unsigned char *sha1
);
1281 extern int get_oid_hex(const char *hex
, struct object_id
*sha1
);
1284 * Read `len` pairs of hexadecimal digits from `hex` and write the
1285 * values to `binary` as `len` bytes. Return 0 on success, or -1 if
1286 * the input does not consist of hex digits).
1288 extern int hex_to_bytes(unsigned char *binary
, const char *hex
, size_t len
);
1291 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1292 * and writes the NUL-terminated output to the buffer `out`, which must be at
1293 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1296 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1297 * buffers, making it safe to make multiple calls for a single statement, like:
1299 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1301 extern char *sha1_to_hex_r(char *out
, const unsigned char *sha1
);
1302 extern char *oid_to_hex_r(char *out
, const struct object_id
*oid
);
1303 extern char *sha1_to_hex(const unsigned char *sha1
); /* static buffer result! */
1304 extern char *oid_to_hex(const struct object_id
*oid
); /* same static buffer as sha1_to_hex */
1307 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1308 * pointer specified by end when parsing stops. The resulting object ID is
1309 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1310 * other invalid character. end is only updated on success; otherwise, it is
1313 extern int parse_oid_hex(const char *hex
, struct object_id
*oid
, const char **end
);
1316 * This reads short-hand syntax that not only evaluates to a commit
1317 * object name, but also can act as if the end user spelled the name
1318 * of the branch from the command line.
1320 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1321 * places the name of the branch in the given buf and returns the
1322 * number of characters parsed if successful.
1324 * - "<branch>@{upstream}" finds the name of the other ref that
1325 * <branch> is configured to merge with (missing <branch> defaults
1326 * to the current branch), and places the name of the branch in the
1327 * given buf and returns the number of characters parsed if
1330 * If the input is not of the accepted format, it returns a negative
1331 * number to signal an error.
1333 * If the input was ok but there are not N branch switches in the
1334 * reflog, it returns 0.
1336 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1337 * expansions: local branches ("refs/heads/"), remote branches
1338 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1339 * allowed, even ones to refs outside of those namespaces.
1341 #define INTERPRET_BRANCH_LOCAL (1<<0)
1342 #define INTERPRET_BRANCH_REMOTE (1<<1)
1343 #define INTERPRET_BRANCH_HEAD (1<<2)
1344 extern int interpret_branch_name(const char *str
, int len
, struct strbuf
*,
1346 extern int get_oid_mb(const char *str
, struct object_id
*oid
);
1348 extern int validate_headref(const char *ref
);
1350 extern int base_name_compare(const char *name1
, int len1
, int mode1
, const char *name2
, int len2
, int mode2
);
1351 extern int df_name_compare(const char *name1
, int len1
, int mode1
, const char *name2
, int len2
, int mode2
);
1352 extern int name_compare(const char *name1
, size_t len1
, const char *name2
, size_t len2
);
1353 extern int cache_name_stage_compare(const char *name1
, int len1
, int stage1
, const char *name2
, int len2
, int stage2
);
1355 extern void *read_object_with_reference(const struct object_id
*oid
,
1356 const char *required_type
,
1357 unsigned long *size
,
1358 struct object_id
*oid_ret
);
1360 extern struct object
*peel_to_type(const char *name
, int namelen
,
1361 struct object
*o
, enum object_type
);
1364 enum date_mode_type
{
1369 DATE_ISO8601_STRICT
,
1375 const char *strftime_fmt
;
1380 * Convenience helper for passing a constant type, like:
1382 * show_date(t, tz, DATE_MODE(NORMAL));
1384 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1385 struct date_mode
*date_mode_from_type(enum date_mode_type type
);
1387 const char *show_date(timestamp_t time
, int timezone
, const struct date_mode
*mode
);
1388 void show_date_relative(timestamp_t time
, int tz
, const struct timeval
*now
,
1389 struct strbuf
*timebuf
);
1390 int parse_date(const char *date
, struct strbuf
*out
);
1391 int parse_date_basic(const char *date
, timestamp_t
*timestamp
, int *offset
);
1392 int parse_expiry_date(const char *date
, timestamp_t
*timestamp
);
1393 void datestamp(struct strbuf
*out
);
1394 #define approxidate(s) approxidate_careful((s), NULL)
1395 timestamp_t
approxidate_careful(const char *, int *);
1396 timestamp_t
approxidate_relative(const char *date
, const struct timeval
*now
);
1397 void parse_date_format(const char *format
, struct date_mode
*mode
);
1398 int date_overflows(timestamp_t date
);
1400 #define IDENT_STRICT 1
1401 #define IDENT_NO_DATE 2
1402 #define IDENT_NO_NAME 4
1403 extern const char *git_author_info(int);
1404 extern const char *git_committer_info(int);
1405 extern const char *fmt_ident(const char *name
, const char *email
, const char *date_str
, int);
1406 extern const char *fmt_name(const char *name
, const char *email
);
1407 extern const char *ident_default_name(void);
1408 extern const char *ident_default_email(void);
1409 extern const char *git_editor(void);
1410 extern const char *git_pager(int stdout_is_tty
);
1411 extern int is_terminal_dumb(void);
1412 extern int git_ident_config(const char *, const char *, void *);
1413 extern void reset_ident_date(void);
1415 struct ident_split
{
1416 const char *name_begin
;
1417 const char *name_end
;
1418 const char *mail_begin
;
1419 const char *mail_end
;
1420 const char *date_begin
;
1421 const char *date_end
;
1422 const char *tz_begin
;
1426 * Signals an success with 0, but time part of the result may be NULL
1427 * if the input lacks timestamp and zone
1429 extern int split_ident_line(struct ident_split
*, const char *, int);
1432 * Like show_date, but pull the timestamp and tz parameters from
1433 * the ident_split. It will also sanity-check the values and produce
1434 * a well-known sentinel date if they appear bogus.
1436 const char *show_ident_date(const struct ident_split
*id
,
1437 const struct date_mode
*mode
);
1440 * Compare split idents for equality or strict ordering. Note that we
1441 * compare only the ident part of the line, ignoring any timestamp.
1443 * Because there are two fields, we must choose one as the primary key; we
1444 * currently arbitrarily pick the email.
1446 extern int ident_cmp(const struct ident_split
*, const struct ident_split
*);
1449 struct index_state
*istate
;
1450 const char *base_dir
;
1452 struct delayed_checkout
*delayed_checkout
;
1458 #define CHECKOUT_INIT { NULL, "" }
1460 #define TEMPORARY_FILENAME_LENGTH 25
1461 extern int checkout_entry(struct cache_entry
*ce
, const struct checkout
*state
, char *topath
);
1462 extern void enable_delayed_checkout(struct checkout
*state
);
1463 extern int finish_delayed_checkout(struct checkout
*state
);
1469 int prefix_len_stat_func
;
1471 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1472 static inline void cache_def_clear(struct cache_def
*cache
)
1474 strbuf_release(&cache
->path
);
1477 extern int has_symlink_leading_path(const char *name
, int len
);
1478 extern int threaded_has_symlink_leading_path(struct cache_def
*, const char *, int);
1479 extern int check_leading_path(const char *name
, int len
);
1480 extern int has_dirs_only_path(const char *name
, int len
, int prefix_len
);
1481 extern void schedule_dir_for_removal(const char *name
, int len
);
1482 extern void remove_scheduled_dirs(void);
1484 struct pack_window
{
1485 struct pack_window
*next
;
1486 unsigned char *base
;
1489 unsigned int last_used
;
1490 unsigned int inuse_cnt
;
1495 struct packed_git
*p
;
1499 * Create a temporary file rooted in the object database directory, or
1500 * die on failure. The filename is taken from "pattern", which should have the
1501 * usual "XXXXXX" trailer, and the resulting filename is written into the
1502 * "template" buffer. Returns the open descriptor.
1504 extern int odb_mkstemp(struct strbuf
*temp_filename
, const char *pattern
);
1507 * Create a pack .keep file named "name" (which should generally be the output
1508 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1511 extern int odb_pack_keep(const char *name
);
1514 * Iterate over the files in the loose-object parts of the object
1515 * directory "path", triggering the following callbacks:
1517 * - loose_object is called for each loose object we find.
1519 * - loose_cruft is called for any files that do not appear to be
1520 * loose objects. Note that we only look in the loose object
1521 * directories "objects/[0-9a-f]{2}/", so we will not report
1522 * "objects/foobar" as cruft.
1524 * - loose_subdir is called for each top-level hashed subdirectory
1525 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1526 * after the objects in the directory are processed.
1528 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1529 * will end the iteration.
1531 * In the "buf" variant, "path" is a strbuf which will also be used as a
1532 * scratch buffer, but restored to its original contents before
1533 * the function returns.
1535 typedef int each_loose_object_fn(const struct object_id
*oid
,
1538 typedef int each_loose_cruft_fn(const char *basename
,
1541 typedef int each_loose_subdir_fn(unsigned int nr
,
1544 int for_each_file_in_obj_subdir(unsigned int subdir_nr
,
1545 struct strbuf
*path
,
1546 each_loose_object_fn obj_cb
,
1547 each_loose_cruft_fn cruft_cb
,
1548 each_loose_subdir_fn subdir_cb
,
1550 int for_each_loose_file_in_objdir(const char *path
,
1551 each_loose_object_fn obj_cb
,
1552 each_loose_cruft_fn cruft_cb
,
1553 each_loose_subdir_fn subdir_cb
,
1555 int for_each_loose_file_in_objdir_buf(struct strbuf
*path
,
1556 each_loose_object_fn obj_cb
,
1557 each_loose_cruft_fn cruft_cb
,
1558 each_loose_subdir_fn subdir_cb
,
1562 * Iterate over loose objects in both the local
1563 * repository and any alternates repositories (unless the
1564 * LOCAL_ONLY flag is set).
1566 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1567 extern int for_each_loose_object(each_loose_object_fn
, void *, unsigned flags
);
1570 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing
1571 * blobs. This has a difference only if extensions.partialClone is set.
1573 * Its default value is 1.
1575 extern int fetch_if_missing
;
1577 /* Dumb servers support */
1578 extern int update_server_info(int);
1580 extern const char *get_log_output_encoding(void);
1581 extern const char *get_commit_output_encoding(void);
1584 * This is a hack for test programs like test-dump-untracked-cache to
1585 * ensure that they do not modify the untracked cache when reading it.
1586 * Do not use it otherwise!
1588 extern int ignore_untracked_cache_config
;
1590 extern int committer_ident_sufficiently_given(void);
1591 extern int author_ident_sufficiently_given(void);
1593 extern const char *git_commit_encoding
;
1594 extern const char *git_log_output_encoding
;
1595 extern const char *git_mailmap_file
;
1596 extern const char *git_mailmap_blob
;
1598 /* IO helper functions */
1599 extern void maybe_flush_or_die(FILE *, const char *);
1600 __attribute__((format (printf
, 2, 3)))
1601 extern void fprintf_or_die(FILE *, const char *fmt
, ...);
1603 #define COPY_READ_ERROR (-2)
1604 #define COPY_WRITE_ERROR (-3)
1605 extern int copy_fd(int ifd
, int ofd
);
1606 extern int copy_file(const char *dst
, const char *src
, int mode
);
1607 extern int copy_file_with_time(const char *dst
, const char *src
, int mode
);
1609 extern void write_or_die(int fd
, const void *buf
, size_t count
);
1610 extern void fsync_or_die(int fd
, const char *);
1612 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
1613 extern ssize_t
write_in_full(int fd
, const void *buf
, size_t count
);
1614 extern ssize_t
pread_in_full(int fd
, void *buf
, size_t count
, off_t offset
);
1616 static inline ssize_t
write_str_in_full(int fd
, const char *str
)
1618 return write_in_full(fd
, str
, strlen(str
));
1622 * Open (and truncate) the file at path, write the contents of buf to it,
1623 * and close it. Dies if any errors are encountered.
1625 extern void write_file_buf(const char *path
, const char *buf
, size_t len
);
1628 * Like write_file_buf(), but format the contents into a buffer first.
1629 * Additionally, write_file() will append a newline if one is not already
1630 * present, making it convenient to write text files:
1632 * write_file(path, "counter: %d", ctr);
1634 __attribute__((format (printf
, 2, 3)))
1635 extern void write_file(const char *path
, const char *fmt
, ...);
1638 extern void setup_pager(void);
1639 extern int pager_in_use(void);
1640 extern int pager_use_color
;
1641 extern int term_columns(void);
1642 extern int decimal_width(uintmax_t);
1643 extern int check_pager_config(const char *cmd
);
1644 extern void prepare_pager_args(struct child_process
*, const char *pager
);
1646 extern const char *editor_program
;
1647 extern const char *askpass_program
;
1648 extern const char *excludes_file
;
1651 int decode_85(char *dst
, const char *line
, int linelen
);
1652 void encode_85(char *buf
, const unsigned char *data
, int bytes
);
1655 void packet_trace_identity(const char *prog
);
1659 * return 0 if success, 1 - if addition of a file failed and
1660 * ADD_FILES_IGNORE_ERRORS was specified in flags
1662 int add_files_to_cache(const char *prefix
, const struct pathspec
*pathspec
, int flags
);
1665 extern int diff_auto_refresh_index
;
1668 void shift_tree(const struct object_id
*, const struct object_id
*, struct object_id
*, int);
1669 void shift_tree_by(const struct object_id
*, const struct object_id
*, struct object_id
*, const char *);
1673 * used by both diff and apply
1674 * last two digits are tab width
1676 #define WS_BLANK_AT_EOL 0100
1677 #define WS_SPACE_BEFORE_TAB 0200
1678 #define WS_INDENT_WITH_NON_TAB 0400
1679 #define WS_CR_AT_EOL 01000
1680 #define WS_BLANK_AT_EOF 02000
1681 #define WS_TAB_IN_INDENT 04000
1682 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1683 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1684 #define WS_TAB_WIDTH_MASK 077
1685 /* All WS_* -- when extended, adapt diff.c emit_symbol */
1686 #define WS_RULE_MASK 07777
1687 extern unsigned whitespace_rule_cfg
;
1688 extern unsigned whitespace_rule(const char *);
1689 extern unsigned parse_whitespace_rule(const char *);
1690 extern unsigned ws_check(const char *line
, int len
, unsigned ws_rule
);
1691 extern void ws_check_emit(const char *line
, int len
, unsigned ws_rule
, FILE *stream
, const char *set
, const char *reset
, const char *ws
);
1692 extern char *whitespace_error_string(unsigned ws
);
1693 extern void ws_fix_copy(struct strbuf
*, const char *, int, unsigned, int *);
1694 extern int ws_blank_line(const char *line
, int len
, unsigned ws_rule
);
1695 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1698 void overlay_tree_on_index(struct index_state
*istate
,
1699 const char *tree_name
, const char *prefix
);
1702 struct startup_info
{
1703 int have_repository
;
1706 extern struct startup_info
*startup_info
;
1710 int try_merge_command(const char *strategy
, size_t xopts_nr
,
1711 const char **xopts
, struct commit_list
*common
,
1712 const char *head_arg
, struct commit_list
*remotes
);
1713 int checkout_fast_forward(const struct object_id
*from
,
1714 const struct object_id
*to
,
1715 int overwrite_ignore
);
1718 int sane_execvp(const char *file
, char *const argv
[]);
1721 * A struct to encapsulate the concept of whether a file has changed
1722 * since we last checked it. This uses criteria similar to those used
1725 struct stat_validity
{
1726 struct stat_data
*sd
;
1729 void stat_validity_clear(struct stat_validity
*sv
);
1732 * Returns 1 if the path is a regular file (or a symlink to a regular
1733 * file) and matches the saved stat_validity, 0 otherwise. A missing
1734 * or inaccessible file is considered a match if the struct was just
1735 * initialized, or if the previous update found an inaccessible file.
1737 int stat_validity_check(struct stat_validity
*sv
, const char *path
);
1740 * Update the stat_validity from a file opened at descriptor fd. If
1741 * the file is missing, inaccessible, or not a regular file, then
1742 * future calls to stat_validity_check will match iff one of those
1743 * conditions continues to be true.
1745 void stat_validity_update(struct stat_validity
*sv
, int fd
);
1747 int versioncmp(const char *s1
, const char *s2
);
1748 void sleep_millisec(int millisec
);
1751 * Create a directory and (if share is nonzero) adjust its permissions
1752 * according to the shared_repository setting. Only use this for
1753 * directories under $GIT_DIR. Don't use it for working tree
1756 void safe_create_dir(const char *dir
, int share
);
1759 * Should we print an ellipsis after an abbreviated SHA-1 value
1760 * when doing diff-raw output or indicating a detached HEAD?
1762 extern int print_sha1_ellipsis(void);
1764 #endif /* CACHE_H */