transport-helper: drop read/write errno checks
[git.git] / cache.h
blobca36b44ee0b5851f837616c322a201ac420a90d2
1 #ifndef CACHE_H
2 #define CACHE_H
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hashmap.h"
7 #include "list.h"
8 #include "advice.h"
9 #include "gettext.h"
10 #include "convert.h"
11 #include "trace.h"
12 #include "string-list.h"
13 #include "pack-revindex.h"
14 #include "hash.h"
15 #include "path.h"
16 #include "sha1-array.h"
17 #include "repository.h"
18 #include "mem-pool.h"
20 #include <zlib.h>
21 typedef struct git_zstream {
22 z_stream z;
23 unsigned long avail_in;
24 unsigned long avail_out;
25 unsigned long total_in;
26 unsigned long total_out;
27 unsigned char *next_in;
28 unsigned char *next_out;
29 } git_zstream;
31 void git_inflate_init(git_zstream *);
32 void git_inflate_init_gzip_only(git_zstream *);
33 void git_inflate_end(git_zstream *);
34 int git_inflate(git_zstream *, int flush);
36 void git_deflate_init(git_zstream *, int level);
37 void git_deflate_init_gzip(git_zstream *, int level);
38 void git_deflate_init_raw(git_zstream *, int level);
39 void git_deflate_end(git_zstream *);
40 int git_deflate_abort(git_zstream *);
41 int git_deflate_end_gently(git_zstream *);
42 int git_deflate(git_zstream *, int flush);
43 unsigned long git_deflate_bound(git_zstream *, unsigned long);
45 /* The length in bytes and in hex digits of an object name (SHA-1 value). */
46 #define GIT_SHA1_RAWSZ 20
47 #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
49 /* The length in byte and in hex digits of the largest possible hash value. */
50 #define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ
51 #define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ
53 struct object_id {
54 unsigned char hash[GIT_MAX_RAWSZ];
57 #define the_hash_algo the_repository->hash_algo
59 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
60 #define DTYPE(de) ((de)->d_type)
61 #else
62 #undef DT_UNKNOWN
63 #undef DT_DIR
64 #undef DT_REG
65 #undef DT_LNK
66 #define DT_UNKNOWN 0
67 #define DT_DIR 1
68 #define DT_REG 2
69 #define DT_LNK 3
70 #define DTYPE(de) DT_UNKNOWN
71 #endif
73 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
74 #define S_IFINVALID 0030000
77 * A "directory link" is a link to another git directory.
79 * The value 0160000 is not normally a valid mode, and
80 * also just happens to be S_IFDIR + S_IFLNK
82 #define S_IFGITLINK 0160000
83 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
86 * Some mode bits are also used internally for computations.
88 * They *must* not overlap with any valid modes, and they *must* not be emitted
89 * to outside world - i.e. appear on disk or network. In other words, it's just
90 * temporary fields, which we internally use, but they have to stay in-house.
92 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
93 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
96 /* used internally in tree-diff */
97 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
101 * Intensive research over the course of many years has shown that
102 * port 9418 is totally unused by anything else. Or
104 * Your search - "port 9418" - did not match any documents.
106 * as www.google.com puts it.
108 * This port has been properly assigned for git use by IANA:
109 * git (Assigned-9418) [I06-050728-0001].
111 * git 9418/tcp git pack transfer service
112 * git 9418/udp git pack transfer service
114 * with Linus Torvalds <torvalds@osdl.org> as the point of
115 * contact. September 2005.
117 * See http://www.iana.org/assignments/port-numbers
119 #define DEFAULT_GIT_PORT 9418
122 * Basic data structures for the directory cache
125 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
126 struct cache_header {
127 uint32_t hdr_signature;
128 uint32_t hdr_version;
129 uint32_t hdr_entries;
132 #define INDEX_FORMAT_LB 2
133 #define INDEX_FORMAT_UB 4
136 * The "cache_time" is just the low 32 bits of the
137 * time. It doesn't matter if it overflows - we only
138 * check it for equality in the 32 bits we save.
140 struct cache_time {
141 uint32_t sec;
142 uint32_t nsec;
145 struct stat_data {
146 struct cache_time sd_ctime;
147 struct cache_time sd_mtime;
148 unsigned int sd_dev;
149 unsigned int sd_ino;
150 unsigned int sd_uid;
151 unsigned int sd_gid;
152 unsigned int sd_size;
155 struct cache_entry {
156 struct hashmap_entry ent;
157 struct stat_data ce_stat_data;
158 unsigned int ce_mode;
159 unsigned int ce_flags;
160 unsigned int mem_pool_allocated;
161 unsigned int ce_namelen;
162 unsigned int index; /* for link extension */
163 struct object_id oid;
164 char name[FLEX_ARRAY]; /* more */
167 #define CE_STAGEMASK (0x3000)
168 #define CE_EXTENDED (0x4000)
169 #define CE_VALID (0x8000)
170 #define CE_STAGESHIFT 12
173 * Range 0xFFFF0FFF in ce_flags is divided into
174 * two parts: in-memory flags and on-disk ones.
175 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
176 * if you want to save a new flag, add it in
177 * CE_EXTENDED_FLAGS
179 * In-memory only flags
181 #define CE_UPDATE (1 << 16)
182 #define CE_REMOVE (1 << 17)
183 #define CE_UPTODATE (1 << 18)
184 #define CE_ADDED (1 << 19)
186 #define CE_HASHED (1 << 20)
187 #define CE_FSMONITOR_VALID (1 << 21)
188 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
189 #define CE_CONFLICTED (1 << 23)
191 #define CE_UNPACKED (1 << 24)
192 #define CE_NEW_SKIP_WORKTREE (1 << 25)
194 /* used to temporarily mark paths matched by pathspecs */
195 #define CE_MATCHED (1 << 26)
197 #define CE_UPDATE_IN_BASE (1 << 27)
198 #define CE_STRIP_NAME (1 << 28)
201 * Extended on-disk flags
203 #define CE_INTENT_TO_ADD (1 << 29)
204 #define CE_SKIP_WORKTREE (1 << 30)
205 /* CE_EXTENDED2 is for future extension */
206 #define CE_EXTENDED2 (1U << 31)
208 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
211 * Safeguard to avoid saving wrong flags:
212 * - CE_EXTENDED2 won't get saved until its semantic is known
213 * - Bits in 0x0000FFFF have been saved in ce_flags already
214 * - Bits in 0x003F0000 are currently in-memory flags
216 #if CE_EXTENDED_FLAGS & 0x803FFFFF
217 #error "CE_EXTENDED_FLAGS out of range"
218 #endif
220 /* Forward structure decls */
221 struct pathspec;
222 struct child_process;
223 struct tree;
226 * Copy the sha1 and stat state of a cache entry from one to
227 * another. But we never change the name, or the hash state!
229 static inline void copy_cache_entry(struct cache_entry *dst,
230 const struct cache_entry *src)
232 unsigned int state = dst->ce_flags & CE_HASHED;
233 int mem_pool_allocated = dst->mem_pool_allocated;
235 /* Don't copy hash chain and name */
236 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
237 offsetof(struct cache_entry, name) -
238 offsetof(struct cache_entry, ce_stat_data));
240 /* Restore the hash state */
241 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
243 /* Restore the mem_pool_allocated flag */
244 dst->mem_pool_allocated = mem_pool_allocated;
247 static inline unsigned create_ce_flags(unsigned stage)
249 return (stage << CE_STAGESHIFT);
252 #define ce_namelen(ce) ((ce)->ce_namelen)
253 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
254 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
255 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
256 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
257 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
258 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
260 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
261 static inline unsigned int create_ce_mode(unsigned int mode)
263 if (S_ISLNK(mode))
264 return S_IFLNK;
265 if (S_ISDIR(mode) || S_ISGITLINK(mode))
266 return S_IFGITLINK;
267 return S_IFREG | ce_permissions(mode);
269 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
270 unsigned int mode)
272 extern int trust_executable_bit, has_symlinks;
273 if (!has_symlinks && S_ISREG(mode) &&
274 ce && S_ISLNK(ce->ce_mode))
275 return ce->ce_mode;
276 if (!trust_executable_bit && S_ISREG(mode)) {
277 if (ce && S_ISREG(ce->ce_mode))
278 return ce->ce_mode;
279 return create_ce_mode(0666);
281 return create_ce_mode(mode);
283 static inline int ce_to_dtype(const struct cache_entry *ce)
285 unsigned ce_mode = ntohl(ce->ce_mode);
286 if (S_ISREG(ce_mode))
287 return DT_REG;
288 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
289 return DT_DIR;
290 else if (S_ISLNK(ce_mode))
291 return DT_LNK;
292 else
293 return DT_UNKNOWN;
295 static inline unsigned int canon_mode(unsigned int mode)
297 if (S_ISREG(mode))
298 return S_IFREG | ce_permissions(mode);
299 if (S_ISLNK(mode))
300 return S_IFLNK;
301 if (S_ISDIR(mode))
302 return S_IFDIR;
303 return S_IFGITLINK;
306 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
308 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
309 #define CE_ENTRY_CHANGED (1 << 1)
310 #define CE_ENTRY_REMOVED (1 << 2)
311 #define CE_ENTRY_ADDED (1 << 3)
312 #define RESOLVE_UNDO_CHANGED (1 << 4)
313 #define CACHE_TREE_CHANGED (1 << 5)
314 #define SPLIT_INDEX_ORDERED (1 << 6)
315 #define UNTRACKED_CHANGED (1 << 7)
316 #define FSMONITOR_CHANGED (1 << 8)
318 struct split_index;
319 struct untracked_cache;
321 struct index_state {
322 struct cache_entry **cache;
323 unsigned int version;
324 unsigned int cache_nr, cache_alloc, cache_changed;
325 struct string_list *resolve_undo;
326 struct cache_tree *cache_tree;
327 struct split_index *split_index;
328 struct cache_time timestamp;
329 unsigned name_hash_initialized : 1,
330 initialized : 1,
331 drop_cache_tree : 1;
332 struct hashmap name_hash;
333 struct hashmap dir_hash;
334 struct object_id oid;
335 struct untracked_cache *untracked;
336 uint64_t fsmonitor_last_update;
337 struct ewah_bitmap *fsmonitor_dirty;
338 struct mem_pool *ce_mem_pool;
341 extern struct index_state the_index;
343 /* Name hashing */
344 extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
345 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
346 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
347 extern void free_name_hash(struct index_state *istate);
350 /* Cache entry creation and cleanup */
353 * Create cache_entry intended for use in the specified index. Caller
354 * is responsible for discarding the cache_entry with
355 * `discard_cache_entry`.
357 struct cache_entry *make_cache_entry(struct index_state *istate,
358 unsigned int mode,
359 const struct object_id *oid,
360 const char *path,
361 int stage,
362 unsigned int refresh_options);
364 struct cache_entry *make_empty_cache_entry(struct index_state *istate,
365 size_t name_len);
368 * Create a cache_entry that is not intended to be added to an index.
369 * Caller is responsible for discarding the cache_entry
370 * with `discard_cache_entry`.
372 struct cache_entry *make_transient_cache_entry(unsigned int mode,
373 const struct object_id *oid,
374 const char *path,
375 int stage);
377 struct cache_entry *make_empty_transient_cache_entry(size_t name_len);
380 * Discard cache entry.
382 void discard_cache_entry(struct cache_entry *ce);
385 * Check configuration if we should perform extra validation on cache
386 * entries.
388 int should_validate_cache_entries(void);
391 * Duplicate a cache_entry. Allocate memory for the new entry from a
392 * memory_pool. Takes into account cache_entry fields that are meant
393 * for managing the underlying memory allocation of the cache_entry.
395 struct cache_entry *dup_cache_entry(const struct cache_entry *ce, struct index_state *istate);
398 * Validate the cache entries in the index. This is an internal
399 * consistency check that the cache_entry structs are allocated from
400 * the expected memory pool.
402 void validate_cache_entries(const struct index_state *istate);
404 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
405 #define active_cache (the_index.cache)
406 #define active_nr (the_index.cache_nr)
407 #define active_alloc (the_index.cache_alloc)
408 #define active_cache_changed (the_index.cache_changed)
409 #define active_cache_tree (the_index.cache_tree)
411 #define read_cache() read_index(&the_index)
412 #define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir()))
413 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec), 0)
414 #define is_cache_unborn() is_index_unborn(&the_index)
415 #define read_cache_unmerged() read_index_unmerged(&the_index)
416 #define discard_cache() discard_index(&the_index)
417 #define unmerged_cache() unmerged_index(&the_index)
418 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
419 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
420 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
421 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
422 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
423 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
424 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
425 #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
426 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
427 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
428 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
429 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
430 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
431 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
432 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
433 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
434 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
435 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
436 #endif
438 #define TYPE_BITS 3
441 * Values in this enum (except those outside the 3 bit range) are part
442 * of pack file format. See Documentation/technical/pack-format.txt
443 * for more information.
445 enum object_type {
446 OBJ_BAD = -1,
447 OBJ_NONE = 0,
448 OBJ_COMMIT = 1,
449 OBJ_TREE = 2,
450 OBJ_BLOB = 3,
451 OBJ_TAG = 4,
452 /* 5 for future expansion */
453 OBJ_OFS_DELTA = 6,
454 OBJ_REF_DELTA = 7,
455 OBJ_ANY,
456 OBJ_MAX
459 static inline enum object_type object_type(unsigned int mode)
461 return S_ISDIR(mode) ? OBJ_TREE :
462 S_ISGITLINK(mode) ? OBJ_COMMIT :
463 OBJ_BLOB;
466 /* Double-check local_repo_env below if you add to this list. */
467 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
468 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
469 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
470 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
471 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
472 #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
473 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
474 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
475 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
476 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
477 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
478 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
479 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
480 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
481 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
482 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
483 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
484 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
485 #define GITATTRIBUTES_FILE ".gitattributes"
486 #define INFOATTRIBUTES_FILE "info/attributes"
487 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
488 #define GITMODULES_FILE ".gitmodules"
489 #define GITMODULES_INDEX ":.gitmodules"
490 #define GITMODULES_HEAD "HEAD:.gitmodules"
491 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
492 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
493 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
494 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
495 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
496 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
497 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
498 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
499 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
500 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
501 #define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
502 #define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT "GIT_TEXTDOMAINDIR"
505 * Environment variable used in handshaking the wire protocol.
506 * Contains a colon ':' separated list of keys with optional values
507 * 'key[=value]'. Presence of unknown keys and values must be
508 * ignored.
510 #define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
511 /* HTTP header used to handshake the wire protocol */
512 #define GIT_PROTOCOL_HEADER "Git-Protocol"
515 * This environment variable is expected to contain a boolean indicating
516 * whether we should or should not treat:
518 * GIT_DIR=foo.git git ...
520 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
521 * of this, but we use it internally to communicate to sub-processes that we
522 * are in a bare repo. If not set, defaults to true.
524 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
527 * Repository-local GIT_* environment variables; these will be cleared
528 * when git spawns a sub-process that runs inside another repository.
529 * The array is NULL-terminated, which makes it easy to pass in the "env"
530 * parameter of a run-command invocation, or to do a simple walk.
532 extern const char * const local_repo_env[];
534 extern void setup_git_env(const char *git_dir);
537 * Returns true iff we have a configured git repository (either via
538 * setup_git_directory, or in the environment via $GIT_DIR).
540 int have_git_dir(void);
542 extern int is_bare_repository_cfg;
543 extern int is_bare_repository(void);
544 extern int is_inside_git_dir(void);
545 extern char *git_work_tree_cfg;
546 extern int is_inside_work_tree(void);
547 extern const char *get_git_dir(void);
548 extern const char *get_git_common_dir(void);
549 extern char *get_object_directory(void);
550 extern char *get_index_file(void);
551 extern char *get_graft_file(struct repository *r);
552 extern void set_git_dir(const char *path);
553 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
554 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
555 extern const char *get_git_namespace(void);
556 extern const char *strip_namespace(const char *namespaced_ref);
557 extern const char *get_super_prefix(void);
558 extern const char *get_git_work_tree(void);
561 * Return true if the given path is a git directory; note that this _just_
562 * looks at the directory itself. If you want to know whether "foo/.git"
563 * is a repository, you must feed that path, not just "foo".
565 extern int is_git_directory(const char *path);
568 * Return 1 if the given path is the root of a git repository or
569 * submodule, else 0. Will not return 1 for bare repositories with the
570 * exception of creating a bare repository in "foo/.git" and calling
571 * is_git_repository("foo").
573 * If we run into read errors, we err on the side of saying "yes, it is",
574 * as we usually consider sub-repos precious, and would prefer to err on the
575 * side of not disrupting or deleting them.
577 extern int is_nonbare_repository_dir(struct strbuf *path);
579 #define READ_GITFILE_ERR_STAT_FAILED 1
580 #define READ_GITFILE_ERR_NOT_A_FILE 2
581 #define READ_GITFILE_ERR_OPEN_FAILED 3
582 #define READ_GITFILE_ERR_READ_FAILED 4
583 #define READ_GITFILE_ERR_INVALID_FORMAT 5
584 #define READ_GITFILE_ERR_NO_PATH 6
585 #define READ_GITFILE_ERR_NOT_A_REPO 7
586 #define READ_GITFILE_ERR_TOO_LARGE 8
587 extern void read_gitfile_error_die(int error_code, const char *path, const char *dir);
588 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
589 #define read_gitfile(path) read_gitfile_gently((path), NULL)
590 extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
591 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
593 extern void set_git_work_tree(const char *tree);
595 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
597 extern void setup_work_tree(void);
599 * Find the commondir and gitdir of the repository that contains the current
600 * working directory, without changing the working directory or other global
601 * state. The result is appended to commondir and gitdir. If the discovered
602 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
603 * both have the same result appended to the buffer. The return value is
604 * either 0 upon success and non-zero if no repository was found.
606 extern int discover_git_directory(struct strbuf *commondir,
607 struct strbuf *gitdir);
608 extern const char *setup_git_directory_gently(int *);
609 extern const char *setup_git_directory(void);
610 extern char *prefix_path(const char *prefix, int len, const char *path);
611 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
614 * Concatenate "prefix" (if len is non-zero) and "path", with no
615 * connecting characters (so "prefix" should end with a "/").
616 * Unlike prefix_path, this should be used if the named file does
617 * not have to interact with index entry; i.e. name of a random file
618 * on the filesystem.
620 * The return value is always a newly allocated string (even if the
621 * prefix was empty).
623 extern char *prefix_filename(const char *prefix, const char *path);
625 extern int check_filename(const char *prefix, const char *name);
626 extern void verify_filename(const char *prefix,
627 const char *name,
628 int diagnose_misspelt_rev);
629 extern void verify_non_filename(const char *prefix, const char *name);
630 extern int path_inside_repo(const char *prefix, const char *path);
632 #define INIT_DB_QUIET 0x0001
633 #define INIT_DB_EXIST_OK 0x0002
635 extern int init_db(const char *git_dir, const char *real_git_dir,
636 const char *template_dir, unsigned int flags);
638 extern void sanitize_stdfds(void);
639 extern int daemonize(void);
641 #define alloc_nr(x) (((x)+16)*3/2)
644 * Realloc the buffer pointed at by variable 'x' so that it can hold
645 * at least 'nr' entries; the number of entries currently allocated
646 * is 'alloc', using the standard growing factor alloc_nr() macro.
648 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
650 #define ALLOC_GROW(x, nr, alloc) \
651 do { \
652 if ((nr) > alloc) { \
653 if (alloc_nr(alloc) < (nr)) \
654 alloc = (nr); \
655 else \
656 alloc = alloc_nr(alloc); \
657 REALLOC_ARRAY(x, alloc); \
659 } while (0)
661 /* Initialize and use the cache information */
662 struct lock_file;
663 extern int read_index(struct index_state *);
664 extern void preload_index(struct index_state *index,
665 const struct pathspec *pathspec,
666 unsigned int refresh_flags);
667 extern int read_index_preload(struct index_state *,
668 const struct pathspec *pathspec,
669 unsigned int refresh_flags);
670 extern int do_read_index(struct index_state *istate, const char *path,
671 int must_exist); /* for testting only! */
672 extern int read_index_from(struct index_state *, const char *path,
673 const char *gitdir);
674 extern int is_index_unborn(struct index_state *);
675 extern int read_index_unmerged(struct index_state *);
677 /* For use with `write_locked_index()`. */
678 #define COMMIT_LOCK (1 << 0)
679 #define SKIP_IF_UNCHANGED (1 << 1)
682 * Write the index while holding an already-taken lock. Close the lock,
683 * and if `COMMIT_LOCK` is given, commit it.
685 * Unless a split index is in use, write the index into the lockfile.
687 * With a split index, write the shared index to a temporary file,
688 * adjust its permissions and rename it into place, then write the
689 * split index to the lockfile. If the temporary file for the shared
690 * index cannot be created, fall back to the behavior described in
691 * the previous paragraph.
693 * With `COMMIT_LOCK`, the lock is always committed or rolled back.
694 * Without it, the lock is closed, but neither committed nor rolled
695 * back.
697 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing
698 * is written (and the lock is rolled back if `COMMIT_LOCK` is given).
700 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
702 extern int discard_index(struct index_state *);
703 extern void move_index_extensions(struct index_state *dst, struct index_state *src);
704 extern int unmerged_index(const struct index_state *);
707 * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL,
708 * compares istate to HEAD. If tree is NULL and on an unborn branch,
709 * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is
710 * provided, the space-separated list of files that differ will be appended
711 * to it.
713 extern int index_has_changes(struct index_state *istate,
714 struct tree *tree,
715 struct strbuf *sb);
717 extern int verify_path(const char *path, unsigned mode);
718 extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change);
719 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
720 extern void adjust_dirname_case(struct index_state *istate, char *name);
721 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
724 * Searches for an entry defined by name and namelen in the given index.
725 * If the return value is positive (including 0) it is the position of an
726 * exact match. If the return value is negative, the negated value minus 1
727 * is the position where the entry would be inserted.
728 * Example: The current index consists of these files and its stages:
730 * b#0, d#0, f#1, f#3
732 * index_name_pos(&index, "a", 1) -> -1
733 * index_name_pos(&index, "b", 1) -> 0
734 * index_name_pos(&index, "c", 1) -> -2
735 * index_name_pos(&index, "d", 1) -> 1
736 * index_name_pos(&index, "e", 1) -> -3
737 * index_name_pos(&index, "f", 1) -> -3
738 * index_name_pos(&index, "g", 1) -> -5
740 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
742 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
743 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
744 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
745 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
746 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
747 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
748 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
749 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
751 /* Remove entry, return true if there are more entries to go. */
752 extern int remove_index_entry_at(struct index_state *, int pos);
754 extern void remove_marked_cache_entries(struct index_state *istate);
755 extern int remove_file_from_index(struct index_state *, const char *path);
756 #define ADD_CACHE_VERBOSE 1
757 #define ADD_CACHE_PRETEND 2
758 #define ADD_CACHE_IGNORE_ERRORS 4
759 #define ADD_CACHE_IGNORE_REMOVAL 8
760 #define ADD_CACHE_INTENT 16
762 * These two are used to add the contents of the file at path
763 * to the index, marking the working tree up-to-date by storing
764 * the cached stat info in the resulting cache entry. A caller
765 * that has already run lstat(2) on the path can call
766 * add_to_index(), and all others can call add_file_to_index();
767 * the latter will do necessary lstat(2) internally before
768 * calling the former.
770 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
771 extern int add_file_to_index(struct index_state *, const char *path, int flags);
773 extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
774 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
775 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
776 extern int index_name_is_other(const struct index_state *, const char *, int);
777 extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
779 /* do stat comparison even if CE_VALID is true */
780 #define CE_MATCH_IGNORE_VALID 01
781 /* do not check the contents but report dirty on racily-clean entries */
782 #define CE_MATCH_RACY_IS_DIRTY 02
783 /* do stat comparison even if CE_SKIP_WORKTREE is true */
784 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
785 /* ignore non-existent files during stat update */
786 #define CE_MATCH_IGNORE_MISSING 0x08
787 /* enable stat refresh */
788 #define CE_MATCH_REFRESH 0x10
789 /* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
790 #define CE_MATCH_IGNORE_FSMONITOR 0X20
791 extern int is_racy_timestamp(const struct index_state *istate,
792 const struct cache_entry *ce);
793 extern int ie_match_stat(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
794 extern int ie_modified(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
796 #define HASH_WRITE_OBJECT 1
797 #define HASH_FORMAT_CHECK 2
798 #define HASH_RENORMALIZE 4
799 extern 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);
800 extern int index_path(struct index_state *istate, struct object_id *oid, const char *path, struct stat *st, unsigned flags);
803 * Record to sd the data from st that we use to check whether a file
804 * might have changed.
806 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
809 * Return 0 if st is consistent with a file not having been changed
810 * since sd was filled. If there are differences, return a
811 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
812 * INODE_CHANGED, and DATA_CHANGED.
814 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
815 extern int match_stat_data_racy(const struct index_state *istate,
816 const struct stat_data *sd, struct stat *st);
818 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
820 #define REFRESH_REALLY 0x0001 /* ignore_valid */
821 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
822 #define REFRESH_QUIET 0x0004 /* be quiet about it */
823 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
824 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
825 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
826 #define REFRESH_PROGRESS 0x0040 /* show progress bar if stderr is tty */
827 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
828 extern struct cache_entry *refresh_cache_entry(struct index_state *, struct cache_entry *, unsigned int);
831 * Opportunistically update the index but do not complain if we can't.
832 * The lockfile is always committed or rolled back.
834 extern void update_index_if_able(struct index_state *, struct lock_file *);
836 extern int hold_locked_index(struct lock_file *, int);
837 extern void set_alternate_index_output(const char *);
839 extern int verify_index_checksum;
840 extern int verify_ce_order;
842 /* Environment bits from configuration mechanism */
843 extern int trust_executable_bit;
844 extern int trust_ctime;
845 extern int check_stat;
846 extern int quote_path_fully;
847 extern int has_symlinks;
848 extern int minimum_abbrev, default_abbrev;
849 extern int ignore_case;
850 extern int assume_unchanged;
851 extern int prefer_symlink_refs;
852 extern int warn_ambiguous_refs;
853 extern int warn_on_object_refname_ambiguity;
854 extern const char *apply_default_whitespace;
855 extern const char *apply_default_ignorewhitespace;
856 extern const char *git_attributes_file;
857 extern const char *git_hooks_path;
858 extern int zlib_compression_level;
859 extern int core_compression_level;
860 extern int pack_compression_level;
861 extern size_t packed_git_window_size;
862 extern size_t packed_git_limit;
863 extern size_t delta_base_cache_limit;
864 extern unsigned long big_file_threshold;
865 extern unsigned long pack_size_limit_cfg;
868 * Accessors for the core.sharedrepository config which lazy-load the value
869 * from the config (if not already set). The "reset" function can be
870 * used to unset "set" or cached value, meaning that the value will be loaded
871 * fresh from the config file on the next call to get_shared_repository().
873 void set_shared_repository(int value);
874 int get_shared_repository(void);
875 void reset_shared_repository(void);
878 * Do replace refs need to be checked this run? This variable is
879 * initialized to true unless --no-replace-object is used or
880 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
881 * commands that do not want replace references to be active.
883 extern int read_replace_refs;
884 extern char *git_replace_ref_base;
886 extern int fsync_object_files;
887 extern int core_preload_index;
888 extern int core_apply_sparse_checkout;
889 extern int precomposed_unicode;
890 extern int protect_hfs;
891 extern int protect_ntfs;
892 extern const char *core_fsmonitor;
895 * Include broken refs in all ref iterations, which will
896 * generally choke dangerous operations rather than letting
897 * them silently proceed without taking the broken ref into
898 * account.
900 extern int ref_paranoia;
903 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
905 int use_optional_locks(void);
908 * The character that begins a commented line in user-editable file
909 * that is subject to stripspace.
911 extern char comment_line_char;
912 extern int auto_comment_line_char;
914 enum log_refs_config {
915 LOG_REFS_UNSET = -1,
916 LOG_REFS_NONE = 0,
917 LOG_REFS_NORMAL,
918 LOG_REFS_ALWAYS
920 extern enum log_refs_config log_all_ref_updates;
922 enum rebase_setup_type {
923 AUTOREBASE_NEVER = 0,
924 AUTOREBASE_LOCAL,
925 AUTOREBASE_REMOTE,
926 AUTOREBASE_ALWAYS
929 enum push_default_type {
930 PUSH_DEFAULT_NOTHING = 0,
931 PUSH_DEFAULT_MATCHING,
932 PUSH_DEFAULT_SIMPLE,
933 PUSH_DEFAULT_UPSTREAM,
934 PUSH_DEFAULT_CURRENT,
935 PUSH_DEFAULT_UNSPECIFIED
938 extern enum rebase_setup_type autorebase;
939 extern enum push_default_type push_default;
941 enum object_creation_mode {
942 OBJECT_CREATION_USES_HARDLINKS = 0,
943 OBJECT_CREATION_USES_RENAMES = 1
946 extern enum object_creation_mode object_creation_mode;
948 extern char *notes_ref_name;
950 extern int grafts_replace_parents;
953 * GIT_REPO_VERSION is the version we write by default. The
954 * _READ variant is the highest number we know how to
955 * handle.
957 #define GIT_REPO_VERSION 0
958 #define GIT_REPO_VERSION_READ 1
959 extern int repository_format_precious_objects;
960 extern char *repository_format_partial_clone;
961 extern const char *core_partial_clone_filter_default;
962 extern int repository_format_worktree_config;
964 struct repository_format {
965 int version;
966 int precious_objects;
967 char *partial_clone; /* value of extensions.partialclone */
968 int worktree_config;
969 int is_bare;
970 int hash_algo;
971 char *work_tree;
972 struct string_list unknown_extensions;
976 * Read the repository format characteristics from the config file "path" into
977 * "format" struct. Returns the numeric version. On error, -1 is returned,
978 * format->version is set to -1, and all other fields in the struct are
979 * undefined.
981 int read_repository_format(struct repository_format *format, const char *path);
984 * Verify that the repository described by repository_format is something we
985 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
986 * any errors encountered.
988 int verify_repository_format(const struct repository_format *format,
989 struct strbuf *err);
992 * Check the repository format version in the path found in get_git_dir(),
993 * and die if it is a version we don't understand. Generally one would
994 * set_git_dir() before calling this, and use it only for "are we in a valid
995 * repo?".
997 extern void check_repository_format(void);
999 #define MTIME_CHANGED 0x0001
1000 #define CTIME_CHANGED 0x0002
1001 #define OWNER_CHANGED 0x0004
1002 #define MODE_CHANGED 0x0008
1003 #define INODE_CHANGED 0x0010
1004 #define DATA_CHANGED 0x0020
1005 #define TYPE_CHANGED 0x0040
1008 * Return an abbreviated sha1 unique within this repository's object database.
1009 * The result will be at least `len` characters long, and will be NUL
1010 * terminated.
1012 * The non-`_r` version returns a static buffer which remains valid until 4
1013 * more calls to find_unique_abbrev are made.
1015 * The `_r` variant writes to a buffer supplied by the caller, which must be at
1016 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes
1017 * written (excluding the NUL terminator).
1019 * Note that while this version avoids the static buffer, it is not fully
1020 * reentrant, as it calls into other non-reentrant git code.
1022 extern const char *find_unique_abbrev(const struct object_id *oid, int len);
1023 extern int find_unique_abbrev_r(char *hex, const struct object_id *oid, int len);
1025 extern const unsigned char null_sha1[GIT_MAX_RAWSZ];
1026 extern const struct object_id null_oid;
1028 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
1031 * This is a temporary optimization hack. By asserting the size here,
1032 * we let the compiler know that it's always going to be 20, which lets
1033 * it turn this fixed-size memcmp into a few inline instructions.
1035 * This will need to be extended or ripped out when we learn about
1036 * hashes of different sizes.
1038 if (the_hash_algo->rawsz != 20)
1039 BUG("hash size not yet supported by hashcmp");
1040 return memcmp(sha1, sha2, the_hash_algo->rawsz);
1043 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
1045 return hashcmp(oid1->hash, oid2->hash);
1048 static inline int hasheq(const unsigned char *sha1, const unsigned char *sha2)
1050 return !hashcmp(sha1, sha2);
1053 static inline int oideq(const struct object_id *oid1, const struct object_id *oid2)
1055 return hasheq(oid1->hash, oid2->hash);
1058 static inline int is_null_sha1(const unsigned char *sha1)
1060 return hasheq(sha1, null_sha1);
1063 static inline int is_null_oid(const struct object_id *oid)
1065 return hasheq(oid->hash, null_sha1);
1068 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
1070 memcpy(sha_dst, sha_src, the_hash_algo->rawsz);
1073 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
1075 hashcpy(dst->hash, src->hash);
1078 static inline struct object_id *oiddup(const struct object_id *src)
1080 struct object_id *dst = xmalloc(sizeof(struct object_id));
1081 oidcpy(dst, src);
1082 return dst;
1085 static inline void hashclr(unsigned char *hash)
1087 memset(hash, 0, the_hash_algo->rawsz);
1090 static inline void oidclr(struct object_id *oid)
1092 memset(oid->hash, 0, GIT_MAX_RAWSZ);
1095 static inline void oidread(struct object_id *oid, const unsigned char *hash)
1097 memcpy(oid->hash, hash, the_hash_algo->rawsz);
1100 static inline int is_empty_blob_sha1(const unsigned char *sha1)
1102 return hasheq(sha1, the_hash_algo->empty_blob->hash);
1105 static inline int is_empty_blob_oid(const struct object_id *oid)
1107 return oideq(oid, the_hash_algo->empty_blob);
1110 static inline int is_empty_tree_sha1(const unsigned char *sha1)
1112 return hasheq(sha1, the_hash_algo->empty_tree->hash);
1115 static inline int is_empty_tree_oid(const struct object_id *oid)
1117 return oideq(oid, the_hash_algo->empty_tree);
1120 const char *empty_tree_oid_hex(void);
1121 const char *empty_blob_oid_hex(void);
1123 /* set default permissions by passing mode arguments to open(2) */
1124 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1125 int git_mkstemp_mode(char *pattern, int mode);
1128 * NOTE NOTE NOTE!!
1130 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1131 * not be changed. Old repositories have core.sharedrepository written in
1132 * numeric format, and therefore these values are preserved for compatibility
1133 * reasons.
1135 enum sharedrepo {
1136 PERM_UMASK = 0,
1137 OLD_PERM_GROUP = 1,
1138 OLD_PERM_EVERYBODY = 2,
1139 PERM_GROUP = 0660,
1140 PERM_EVERYBODY = 0664
1142 int git_config_perm(const char *var, const char *value);
1143 int adjust_shared_perm(const char *path);
1146 * Create the directory containing the named path, using care to be
1147 * somewhat safe against races. Return one of the scld_error values to
1148 * indicate success/failure. On error, set errno to describe the
1149 * problem.
1151 * SCLD_VANISHED indicates that one of the ancestor directories of the
1152 * path existed at one point during the function call and then
1153 * suddenly vanished, probably because another process pruned the
1154 * directory while we were working. To be robust against this kind of
1155 * race, callers might want to try invoking the function again when it
1156 * returns SCLD_VANISHED.
1158 * safe_create_leading_directories() temporarily changes path while it
1159 * is working but restores it before returning.
1160 * safe_create_leading_directories_const() doesn't modify path, even
1161 * temporarily.
1163 enum scld_error {
1164 SCLD_OK = 0,
1165 SCLD_FAILED = -1,
1166 SCLD_PERMS = -2,
1167 SCLD_EXISTS = -3,
1168 SCLD_VANISHED = -4
1170 enum scld_error safe_create_leading_directories(char *path);
1171 enum scld_error safe_create_leading_directories_const(const char *path);
1174 * Callback function for raceproof_create_file(). This function is
1175 * expected to do something that makes dirname(path) permanent despite
1176 * the fact that other processes might be cleaning up empty
1177 * directories at the same time. Usually it will create a file named
1178 * path, but alternatively it could create another file in that
1179 * directory, or even chdir() into that directory. The function should
1180 * return 0 if the action was completed successfully. On error, it
1181 * should return a nonzero result and set errno.
1182 * raceproof_create_file() treats two errno values specially:
1184 * - ENOENT -- dirname(path) does not exist. In this case,
1185 * raceproof_create_file() tries creating dirname(path)
1186 * (and any parent directories, if necessary) and calls
1187 * the function again.
1189 * - EISDIR -- the file already exists and is a directory. In this
1190 * case, raceproof_create_file() removes the directory if
1191 * it is empty (and recursively any empty directories that
1192 * it contains) and calls the function again.
1194 * Any other errno causes raceproof_create_file() to fail with the
1195 * callback's return value and errno.
1197 * Obviously, this function should be OK with being called again if it
1198 * fails with ENOENT or EISDIR. In other scenarios it will not be
1199 * called again.
1201 typedef int create_file_fn(const char *path, void *cb);
1204 * Create a file in dirname(path) by calling fn, creating leading
1205 * directories if necessary. Retry a few times in case we are racing
1206 * with another process that is trying to clean up the directory that
1207 * contains path. See the documentation for create_file_fn for more
1208 * details.
1210 * Return the value and set the errno that resulted from the most
1211 * recent call of fn. fn is always called at least once, and will be
1212 * called more than once if it returns ENOENT or EISDIR.
1214 int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
1216 int mkdir_in_gitdir(const char *path);
1217 extern char *expand_user_path(const char *path, int real_home);
1218 const char *enter_repo(const char *path, int strict);
1219 static inline int is_absolute_path(const char *path)
1221 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
1223 int is_directory(const char *);
1224 char *strbuf_realpath(struct strbuf *resolved, const char *path,
1225 int die_on_error);
1226 const char *real_path(const char *path);
1227 const char *real_path_if_valid(const char *path);
1228 char *real_pathdup(const char *path, int die_on_error);
1229 const char *absolute_path(const char *path);
1230 char *absolute_pathdup(const char *path);
1231 const char *remove_leading_path(const char *in, const char *prefix);
1232 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
1233 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
1234 int normalize_path_copy(char *dst, const char *src);
1235 int longest_ancestor_length(const char *path, struct string_list *prefixes);
1236 char *strip_path_suffix(const char *path, const char *suffix);
1237 int daemon_avoid_alias(const char *path);
1240 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for
1241 * details.
1243 int is_ntfs_dotgit(const char *name);
1244 int is_ntfs_dotgitmodules(const char *name);
1245 int is_ntfs_dotgitignore(const char *name);
1246 int is_ntfs_dotgitattributes(const char *name);
1249 * Returns true iff "str" could be confused as a command-line option when
1250 * passed to a sub-program like "ssh". Note that this has nothing to do with
1251 * shell-quoting, which should be handled separately; we're assuming here that
1252 * the string makes it verbatim to the sub-program.
1254 int looks_like_command_line_option(const char *str);
1257 * Return a newly allocated string with the evaluation of
1258 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1259 * "$HOME/.config/git/$filename". Return NULL upon error.
1261 extern char *xdg_config_home(const char *filename);
1264 * Return a newly allocated string with the evaluation of
1265 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1266 * "$HOME/.cache/git/$filename". Return NULL upon error.
1268 extern char *xdg_cache_home(const char *filename);
1270 extern int git_open_cloexec(const char *name, int flags);
1271 #define git_open(name) git_open_cloexec(name, O_RDONLY)
1272 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1273 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1275 extern int check_object_signature(const struct object_id *oid, void *buf, unsigned long size, const char *type);
1277 extern int finalize_object_file(const char *tmpfile, const char *filename);
1279 /* Helper to check and "touch" a file */
1280 extern int check_and_freshen_file(const char *fn, int freshen);
1282 extern const signed char hexval_table[256];
1283 static inline unsigned int hexval(unsigned char c)
1285 return hexval_table[c];
1289 * Convert two consecutive hexadecimal digits into a char. Return a
1290 * negative value on error. Don't run over the end of short strings.
1292 static inline int hex2chr(const char *s)
1294 unsigned int val = hexval(s[0]);
1295 return (val & ~0xf) ? val : (val << 4) | hexval(s[1]);
1298 /* Convert to/from hex/sha1 representation */
1299 #define MINIMUM_ABBREV minimum_abbrev
1300 #define DEFAULT_ABBREV default_abbrev
1302 /* used when the code does not know or care what the default abbrev is */
1303 #define FALLBACK_DEFAULT_ABBREV 7
1305 struct object_context {
1306 unsigned mode;
1308 * symlink_path is only used by get_tree_entry_follow_symlinks,
1309 * and only for symlinks that point outside the repository.
1311 struct strbuf symlink_path;
1313 * If GET_OID_RECORD_PATH is set, this will record path (if any)
1314 * found when resolving the name. The caller is responsible for
1315 * releasing the memory.
1317 char *path;
1320 #define GET_OID_QUIETLY 01
1321 #define GET_OID_COMMIT 02
1322 #define GET_OID_COMMITTISH 04
1323 #define GET_OID_TREE 010
1324 #define GET_OID_TREEISH 020
1325 #define GET_OID_BLOB 040
1326 #define GET_OID_FOLLOW_SYMLINKS 0100
1327 #define GET_OID_RECORD_PATH 0200
1328 #define GET_OID_ONLY_TO_DIE 04000
1330 #define GET_OID_DISAMBIGUATORS \
1331 (GET_OID_COMMIT | GET_OID_COMMITTISH | \
1332 GET_OID_TREE | GET_OID_TREEISH | \
1333 GET_OID_BLOB)
1335 extern int get_oid(const char *str, struct object_id *oid);
1336 extern int get_oid_commit(const char *str, struct object_id *oid);
1337 extern int get_oid_committish(const char *str, struct object_id *oid);
1338 extern int get_oid_tree(const char *str, struct object_id *oid);
1339 extern int get_oid_treeish(const char *str, struct object_id *oid);
1340 extern int get_oid_blob(const char *str, struct object_id *oid);
1341 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1342 extern int get_oid_with_context(const char *str, unsigned flags, struct object_id *oid, struct object_context *oc);
1345 typedef int each_abbrev_fn(const struct object_id *oid, void *);
1346 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1348 extern int set_disambiguate_hint_config(const char *var, const char *value);
1351 * Try to read a SHA1 in hexadecimal format from the 40 characters
1352 * starting at hex. Write the 20-byte result to sha1 in binary form.
1353 * Return 0 on success. Reading stops if a NUL is encountered in the
1354 * input, so it is safe to pass this function an arbitrary
1355 * null-terminated string.
1357 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1358 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1361 * Read `len` pairs of hexadecimal digits from `hex` and write the
1362 * values to `binary` as `len` bytes. Return 0 on success, or -1 if
1363 * the input does not consist of hex digits).
1365 extern int hex_to_bytes(unsigned char *binary, const char *hex, size_t len);
1368 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1369 * and writes the NUL-terminated output to the buffer `out`, which must be at
1370 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1371 * convenience.
1373 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1374 * buffers, making it safe to make multiple calls for a single statement, like:
1376 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1378 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1379 extern char *oid_to_hex_r(char *out, const struct object_id *oid);
1380 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1381 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1384 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1385 * pointer specified by end when parsing stops. The resulting object ID is
1386 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1387 * other invalid character. end is only updated on success; otherwise, it is
1388 * unmodified.
1390 extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
1393 * This reads short-hand syntax that not only evaluates to a commit
1394 * object name, but also can act as if the end user spelled the name
1395 * of the branch from the command line.
1397 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1398 * places the name of the branch in the given buf and returns the
1399 * number of characters parsed if successful.
1401 * - "<branch>@{upstream}" finds the name of the other ref that
1402 * <branch> is configured to merge with (missing <branch> defaults
1403 * to the current branch), and places the name of the branch in the
1404 * given buf and returns the number of characters parsed if
1405 * successful.
1407 * If the input is not of the accepted format, it returns a negative
1408 * number to signal an error.
1410 * If the input was ok but there are not N branch switches in the
1411 * reflog, it returns 0.
1413 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1414 * expansions: local branches ("refs/heads/"), remote branches
1415 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1416 * allowed, even ones to refs outside of those namespaces.
1418 #define INTERPRET_BRANCH_LOCAL (1<<0)
1419 #define INTERPRET_BRANCH_REMOTE (1<<1)
1420 #define INTERPRET_BRANCH_HEAD (1<<2)
1421 extern int interpret_branch_name(const char *str, int len, struct strbuf *,
1422 unsigned allowed);
1423 extern int get_oid_mb(const char *str, struct object_id *oid);
1425 extern int validate_headref(const char *ref);
1427 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1428 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1429 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1430 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1432 extern void *read_object_with_reference(const struct object_id *oid,
1433 const char *required_type,
1434 unsigned long *size,
1435 struct object_id *oid_ret);
1437 extern struct object *peel_to_type(const char *name, int namelen,
1438 struct object *o, enum object_type);
1440 enum date_mode_type {
1441 DATE_NORMAL = 0,
1442 DATE_RELATIVE,
1443 DATE_SHORT,
1444 DATE_ISO8601,
1445 DATE_ISO8601_STRICT,
1446 DATE_RFC2822,
1447 DATE_STRFTIME,
1448 DATE_RAW,
1449 DATE_UNIX
1452 struct date_mode {
1453 enum date_mode_type type;
1454 const char *strftime_fmt;
1455 int local;
1459 * Convenience helper for passing a constant type, like:
1461 * show_date(t, tz, DATE_MODE(NORMAL));
1463 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1464 struct date_mode *date_mode_from_type(enum date_mode_type type);
1466 const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);
1467 void show_date_relative(timestamp_t time, int tz, const struct timeval *now,
1468 struct strbuf *timebuf);
1469 int parse_date(const char *date, struct strbuf *out);
1470 int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);
1471 int parse_expiry_date(const char *date, timestamp_t *timestamp);
1472 void datestamp(struct strbuf *out);
1473 #define approxidate(s) approxidate_careful((s), NULL)
1474 timestamp_t approxidate_careful(const char *, int *);
1475 timestamp_t approxidate_relative(const char *date, const struct timeval *now);
1476 void parse_date_format(const char *format, struct date_mode *mode);
1477 int date_overflows(timestamp_t date);
1479 #define IDENT_STRICT 1
1480 #define IDENT_NO_DATE 2
1481 #define IDENT_NO_NAME 4
1482 extern const char *git_author_info(int);
1483 extern const char *git_committer_info(int);
1484 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1485 extern const char *fmt_name(const char *name, const char *email);
1486 extern const char *ident_default_name(void);
1487 extern const char *ident_default_email(void);
1488 extern const char *git_editor(void);
1489 extern const char *git_sequence_editor(void);
1490 extern const char *git_pager(int stdout_is_tty);
1491 extern int is_terminal_dumb(void);
1492 extern int git_ident_config(const char *, const char *, void *);
1493 extern void reset_ident_date(void);
1495 struct ident_split {
1496 const char *name_begin;
1497 const char *name_end;
1498 const char *mail_begin;
1499 const char *mail_end;
1500 const char *date_begin;
1501 const char *date_end;
1502 const char *tz_begin;
1503 const char *tz_end;
1506 * Signals an success with 0, but time part of the result may be NULL
1507 * if the input lacks timestamp and zone
1509 extern int split_ident_line(struct ident_split *, const char *, int);
1512 * Like show_date, but pull the timestamp and tz parameters from
1513 * the ident_split. It will also sanity-check the values and produce
1514 * a well-known sentinel date if they appear bogus.
1516 const char *show_ident_date(const struct ident_split *id,
1517 const struct date_mode *mode);
1520 * Compare split idents for equality or strict ordering. Note that we
1521 * compare only the ident part of the line, ignoring any timestamp.
1523 * Because there are two fields, we must choose one as the primary key; we
1524 * currently arbitrarily pick the email.
1526 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1528 struct checkout {
1529 struct index_state *istate;
1530 const char *base_dir;
1531 int base_dir_len;
1532 struct delayed_checkout *delayed_checkout;
1533 unsigned force:1,
1534 quiet:1,
1535 not_new:1,
1536 clone:1,
1537 refresh_cache:1;
1539 #define CHECKOUT_INIT { NULL, "" }
1541 #define TEMPORARY_FILENAME_LENGTH 25
1542 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1543 extern void enable_delayed_checkout(struct checkout *state);
1544 extern int finish_delayed_checkout(struct checkout *state);
1546 struct cache_def {
1547 struct strbuf path;
1548 int flags;
1549 int track_flags;
1550 int prefix_len_stat_func;
1552 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1553 static inline void cache_def_clear(struct cache_def *cache)
1555 strbuf_release(&cache->path);
1558 extern int has_symlink_leading_path(const char *name, int len);
1559 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1560 extern int check_leading_path(const char *name, int len);
1561 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1562 extern void schedule_dir_for_removal(const char *name, int len);
1563 extern void remove_scheduled_dirs(void);
1565 struct pack_window {
1566 struct pack_window *next;
1567 unsigned char *base;
1568 off_t offset;
1569 size_t len;
1570 unsigned int last_used;
1571 unsigned int inuse_cnt;
1574 struct pack_entry {
1575 off_t offset;
1576 struct packed_git *p;
1580 * Create a temporary file rooted in the object database directory, or
1581 * die on failure. The filename is taken from "pattern", which should have the
1582 * usual "XXXXXX" trailer, and the resulting filename is written into the
1583 * "template" buffer. Returns the open descriptor.
1585 extern int odb_mkstemp(struct strbuf *temp_filename, const char *pattern);
1588 * Create a pack .keep file named "name" (which should generally be the output
1589 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1590 * error.
1592 extern int odb_pack_keep(const char *name);
1595 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing
1596 * blobs. This has a difference only if extensions.partialClone is set.
1598 * Its default value is 1.
1600 extern int fetch_if_missing;
1602 /* Dumb servers support */
1603 extern int update_server_info(int);
1605 extern const char *get_log_output_encoding(void);
1606 extern const char *get_commit_output_encoding(void);
1609 * This is a hack for test programs like test-dump-untracked-cache to
1610 * ensure that they do not modify the untracked cache when reading it.
1611 * Do not use it otherwise!
1613 extern int ignore_untracked_cache_config;
1615 extern int committer_ident_sufficiently_given(void);
1616 extern int author_ident_sufficiently_given(void);
1618 extern const char *git_commit_encoding;
1619 extern const char *git_log_output_encoding;
1620 extern const char *git_mailmap_file;
1621 extern const char *git_mailmap_blob;
1623 /* IO helper functions */
1624 extern void maybe_flush_or_die(FILE *, const char *);
1625 __attribute__((format (printf, 2, 3)))
1626 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1628 #define COPY_READ_ERROR (-2)
1629 #define COPY_WRITE_ERROR (-3)
1630 extern int copy_fd(int ifd, int ofd);
1631 extern int copy_file(const char *dst, const char *src, int mode);
1632 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1634 extern void write_or_die(int fd, const void *buf, size_t count);
1635 extern void fsync_or_die(int fd, const char *);
1637 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1638 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1639 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1641 static inline ssize_t write_str_in_full(int fd, const char *str)
1643 return write_in_full(fd, str, strlen(str));
1647 * Open (and truncate) the file at path, write the contents of buf to it,
1648 * and close it. Dies if any errors are encountered.
1650 extern void write_file_buf(const char *path, const char *buf, size_t len);
1653 * Like write_file_buf(), but format the contents into a buffer first.
1654 * Additionally, write_file() will append a newline if one is not already
1655 * present, making it convenient to write text files:
1657 * write_file(path, "counter: %d", ctr);
1659 __attribute__((format (printf, 2, 3)))
1660 extern void write_file(const char *path, const char *fmt, ...);
1662 /* pager.c */
1663 extern void setup_pager(void);
1664 extern int pager_in_use(void);
1665 extern int pager_use_color;
1666 extern int term_columns(void);
1667 extern int decimal_width(uintmax_t);
1668 extern int check_pager_config(const char *cmd);
1669 extern void prepare_pager_args(struct child_process *, const char *pager);
1671 extern const char *editor_program;
1672 extern const char *askpass_program;
1673 extern const char *excludes_file;
1675 /* base85 */
1676 int decode_85(char *dst, const char *line, int linelen);
1677 void encode_85(char *buf, const unsigned char *data, int bytes);
1679 /* pkt-line.c */
1680 void packet_trace_identity(const char *prog);
1682 /* add */
1684 * return 0 if success, 1 - if addition of a file failed and
1685 * ADD_FILES_IGNORE_ERRORS was specified in flags
1687 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1689 /* diff.c */
1690 extern int diff_auto_refresh_index;
1692 /* match-trees.c */
1693 void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
1694 void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
1697 * whitespace rules.
1698 * used by both diff and apply
1699 * last two digits are tab width
1701 #define WS_BLANK_AT_EOL 0100
1702 #define WS_SPACE_BEFORE_TAB 0200
1703 #define WS_INDENT_WITH_NON_TAB 0400
1704 #define WS_CR_AT_EOL 01000
1705 #define WS_BLANK_AT_EOF 02000
1706 #define WS_TAB_IN_INDENT 04000
1707 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1708 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1709 #define WS_TAB_WIDTH_MASK 077
1710 /* All WS_* -- when extended, adapt diff.c emit_symbol */
1711 #define WS_RULE_MASK 07777
1712 extern unsigned whitespace_rule_cfg;
1713 extern unsigned whitespace_rule(struct index_state *, const char *);
1714 extern unsigned parse_whitespace_rule(const char *);
1715 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1716 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1717 extern char *whitespace_error_string(unsigned ws);
1718 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1719 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1720 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1722 /* ls-files */
1723 void overlay_tree_on_index(struct index_state *istate,
1724 const char *tree_name, const char *prefix);
1726 /* setup.c */
1727 struct startup_info {
1728 int have_repository;
1729 const char *prefix;
1731 extern struct startup_info *startup_info;
1733 /* merge.c */
1734 struct commit_list;
1735 int try_merge_command(struct repository *r,
1736 const char *strategy, size_t xopts_nr,
1737 const char **xopts, struct commit_list *common,
1738 const char *head_arg, struct commit_list *remotes);
1739 int checkout_fast_forward(struct repository *r,
1740 const struct object_id *from,
1741 const struct object_id *to,
1742 int overwrite_ignore);
1745 int sane_execvp(const char *file, char *const argv[]);
1748 * A struct to encapsulate the concept of whether a file has changed
1749 * since we last checked it. This uses criteria similar to those used
1750 * for the index.
1752 struct stat_validity {
1753 struct stat_data *sd;
1756 void stat_validity_clear(struct stat_validity *sv);
1759 * Returns 1 if the path is a regular file (or a symlink to a regular
1760 * file) and matches the saved stat_validity, 0 otherwise. A missing
1761 * or inaccessible file is considered a match if the struct was just
1762 * initialized, or if the previous update found an inaccessible file.
1764 int stat_validity_check(struct stat_validity *sv, const char *path);
1767 * Update the stat_validity from a file opened at descriptor fd. If
1768 * the file is missing, inaccessible, or not a regular file, then
1769 * future calls to stat_validity_check will match iff one of those
1770 * conditions continues to be true.
1772 void stat_validity_update(struct stat_validity *sv, int fd);
1774 int versioncmp(const char *s1, const char *s2);
1775 void sleep_millisec(int millisec);
1778 * Create a directory and (if share is nonzero) adjust its permissions
1779 * according to the shared_repository setting. Only use this for
1780 * directories under $GIT_DIR. Don't use it for working tree
1781 * directories.
1783 void safe_create_dir(const char *dir, int share);
1786 * Should we print an ellipsis after an abbreviated SHA-1 value
1787 * when doing diff-raw output or indicating a detached HEAD?
1789 extern int print_sha1_ellipsis(void);
1791 #endif /* CACHE_H */