path: create path.h
[git/git.git] / cache.h
CommitLineData
e83c5163
LT
1#ifndef CACHE_H
2#define CACHE_H
3
4050c0df 4#include "git-compat-util.h"
5ecd293d 5#include "strbuf.h"
e05881a4 6#include "hashmap.h"
75194438 7#include "advice.h"
65784830 8#include "gettext.h"
d1bf0e08 9#include "convert.h"
5991a55c 10#include "trace.h"
155ef25f 11#include "string-list.h"
f4015337 12#include "pack-revindex.h"
f18f816c 13#include "hash.h"
e7d72d07 14#include "path.h"
e83c5163 15
3bc72fde
APD
16#ifndef platform_SHA_CTX
17/*
18 * platform's underlying implementation of SHA-1; could be OpenSSL,
19 * blk_SHA, Apple CommonCrypto, etc... Note that including
20 * SHA1_HEADER may have already defined platform_SHA_CTX for our
21 * own implementations like block-sha1 and ppc-sha1, so we list
22 * the default for OpenSSL compatible SHA-1 implementations here.
23 */
24#define platform_SHA_CTX SHA_CTX
25#define platform_SHA1_Init SHA1_Init
26#define platform_SHA1_Update SHA1_Update
27#define platform_SHA1_Final SHA1_Final
9126f009 28#endif
e83c5163 29
3bc72fde
APD
30#define git_SHA_CTX platform_SHA_CTX
31#define git_SHA1_Init platform_SHA1_Init
32#define git_SHA1_Update platform_SHA1_Update
33#define git_SHA1_Final platform_SHA1_Final
34
001fd7a9
APD
35#ifdef SHA1_MAX_BLOCK_SIZE
36#include "compat/sha1-chunked.h"
37#undef git_SHA1_Update
38#define git_SHA1_Update git_SHA1_Update_Chunked
9126f009 39#endif
e83c5163 40
9126f009 41#include <zlib.h>
ef49a7a0
JH
42typedef struct git_zstream {
43 z_stream z;
44 unsigned long avail_in;
45 unsigned long avail_out;
46 unsigned long total_in;
47 unsigned long total_out;
48 unsigned char *next_in;
49 unsigned char *next_out;
50} git_zstream;
51
52void git_inflate_init(git_zstream *);
53void git_inflate_init_gzip_only(git_zstream *);
54void git_inflate_end(git_zstream *);
55int git_inflate(git_zstream *, int flush);
56
57void git_deflate_init(git_zstream *, int level);
58void git_deflate_init_gzip(git_zstream *, int level);
c3c2e1a0 59void git_deflate_init_raw(git_zstream *, int level);
ef49a7a0 60void git_deflate_end(git_zstream *);
568508e7 61int git_deflate_abort(git_zstream *);
ef49a7a0
JH
62int git_deflate_end_gently(git_zstream *);
63int git_deflate(git_zstream *, int flush);
64unsigned long git_deflate_bound(git_zstream *, unsigned long);
39c68542 65
5f7817c8 66/* The length in bytes and in hex digits of an object name (SHA-1 value). */
67#define GIT_SHA1_RAWSZ 20
68#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
69
5028bf62 70/* The length in byte and in hex digits of the largest possible hash value. */
71#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ
72#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ
73
5f7817c8 74struct object_id {
5028bf62 75 unsigned char hash[GIT_MAX_RAWSZ];
5f7817c8 76};
77
962554c6 78#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
b6829693
ET
79#define DTYPE(de) ((de)->d_type)
80#else
0bdd79af
JH
81#undef DT_UNKNOWN
82#undef DT_DIR
83#undef DT_REG
84#undef DT_LNK
b6829693
ET
85#define DT_UNKNOWN 0
86#define DT_DIR 1
87#define DT_REG 2
a15c1c60 88#define DT_LNK 3
b6829693
ET
89#define DTYPE(de) DT_UNKNOWN
90#endif
91
40689ae1
MK
92/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
93#define S_IFINVALID 0030000
94
9eec4795
LT
95/*
96 * A "directory link" is a link to another git directory.
97 *
98 * The value 0160000 is not normally a valid mode, and
99 * also just happens to be S_IFDIR + S_IFLNK
9eec4795 100 */
302b9282
MW
101#define S_IFGITLINK 0160000
102#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
9eec4795 103
72441af7
KS
104/*
105 * Some mode bits are also used internally for computations.
106 *
107 * They *must* not overlap with any valid modes, and they *must* not be emitted
108 * to outside world - i.e. appear on disk or network. In other words, it's just
109 * temporary fields, which we internally use, but they have to stay in-house.
110 *
111 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
112 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
113 */
114
115/* used internally in tree-diff */
116#define S_DIFFTREE_IFXMIN_NEQ 0x80000000
117
118
2386d658
LT
119/*
120 * Intensive research over the course of many years has shown that
121 * port 9418 is totally unused by anything else. Or
122 *
123 * Your search - "port 9418" - did not match any documents.
124 *
125 * as www.google.com puts it.
ba8a4970
LT
126 *
127 * This port has been properly assigned for git use by IANA:
128 * git (Assigned-9418) [I06-050728-0001].
129 *
130 * git 9418/tcp git pack transfer service
131 * git 9418/udp git pack transfer service
132 *
133 * with Linus Torvalds <torvalds@osdl.org> as the point of
134 * contact. September 2005.
135 *
136 * See http://www.iana.org/assignments/port-numbers
2386d658
LT
137 */
138#define DEFAULT_GIT_PORT 9418
139
e83c5163
LT
140/*
141 * Basic data structures for the directory cache
e83c5163
LT
142 */
143
144#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
145struct cache_header {
7800c1eb
TG
146 uint32_t hdr_signature;
147 uint32_t hdr_version;
148 uint32_t hdr_entries;
e83c5163
LT
149};
150
9d227781
JH
151#define INDEX_FORMAT_LB 2
152#define INDEX_FORMAT_UB 4
153
e83c5163
LT
154/*
155 * The "cache_time" is just the low 32 bits of the
156 * time. It doesn't matter if it overflows - we only
157 * check it for equality in the 32 bits we save.
158 */
159struct cache_time {
7800c1eb
TG
160 uint32_t sec;
161 uint32_t nsec;
e83c5163
LT
162};
163
c21d39d7
MH
164struct stat_data {
165 struct cache_time sd_ctime;
166 struct cache_time sd_mtime;
167 unsigned int sd_dev;
168 unsigned int sd_ino;
169 unsigned int sd_uid;
170 unsigned int sd_gid;
171 unsigned int sd_size;
172};
173
e83c5163 174struct cache_entry {
8b013788 175 struct hashmap_entry ent;
c21d39d7 176 struct stat_data ce_stat_data;
ccc4feb5 177 unsigned int ce_mode;
7a51ed66 178 unsigned int ce_flags;
b60e188c 179 unsigned int ce_namelen;
5fc2fc8f 180 unsigned int index; /* for link extension */
99d1a986 181 struct object_id oid;
8f1d2e6f 182 char name[FLEX_ARRAY]; /* more */
e83c5163
LT
183};
184
95fd5bf8 185#define CE_STAGEMASK (0x3000)
16ce2e4c 186#define CE_EXTENDED (0x4000)
5f73076c 187#define CE_VALID (0x8000)
aee46198 188#define CE_STAGESHIFT 12
95fd5bf8 189
06aaaa0b 190/*
ce51bf09 191 * Range 0xFFFF0FFF in ce_flags is divided into
06aaaa0b
NTND
192 * two parts: in-memory flags and on-disk ones.
193 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
194 * if you want to save a new flag, add it in
195 * CE_EXTENDED_FLAGS
196 *
197 * In-memory only flags
198 */
2977ffbb
NTND
199#define CE_UPDATE (1 << 16)
200#define CE_REMOVE (1 << 17)
201#define CE_UPTODATE (1 << 18)
202#define CE_ADDED (1 << 19)
a22c6371 203
2977ffbb 204#define CE_HASHED (1 << 20)
2977ffbb
NTND
205#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
206#define CE_CONFLICTED (1 << 23)
7a51ed66 207
2977ffbb 208#define CE_UNPACKED (1 << 24)
2431afbf 209#define CE_NEW_SKIP_WORKTREE (1 << 25)
da165f47 210
e721c154
NTND
211/* used to temporarily mark paths matched by pathspecs */
212#define CE_MATCHED (1 << 26)
213
078a58e8 214#define CE_UPDATE_IN_BASE (1 << 27)
b3c96fb1 215#define CE_STRIP_NAME (1 << 28)
078a58e8 216
06aaaa0b
NTND
217/*
218 * Extended on-disk flags
219 */
2977ffbb
NTND
220#define CE_INTENT_TO_ADD (1 << 29)
221#define CE_SKIP_WORKTREE (1 << 30)
06aaaa0b 222/* CE_EXTENDED2 is for future extension */
9a93c668 223#define CE_EXTENDED2 (1U << 31)
06aaaa0b 224
44a36913 225#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
06aaaa0b
NTND
226
227/*
228 * Safeguard to avoid saving wrong flags:
229 * - CE_EXTENDED2 won't get saved until its semantic is known
230 * - Bits in 0x0000FFFF have been saved in ce_flags already
231 * - Bits in 0x003F0000 are currently in-memory flags
232 */
233#if CE_EXTENDED_FLAGS & 0x803FFFFF
234#error "CE_EXTENDED_FLAGS out of range"
235#endif
236
3e3a4a41 237/* Forward structure decls */
64acde94 238struct pathspec;
3e3a4a41 239struct child_process;
64acde94 240
eb7a2f1d
LT
241/*
242 * Copy the sha1 and stat state of a cache entry from one to
243 * another. But we never change the name, or the hash state!
244 */
20d142b4
RS
245static inline void copy_cache_entry(struct cache_entry *dst,
246 const struct cache_entry *src)
eb7a2f1d 247{
419a597f 248 unsigned int state = dst->ce_flags & CE_HASHED;
eb7a2f1d
LT
249
250 /* Don't copy hash chain and name */
8b013788
KB
251 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
252 offsetof(struct cache_entry, name) -
253 offsetof(struct cache_entry, ce_stat_data));
eb7a2f1d
LT
254
255 /* Restore the hash state */
419a597f 256 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
eb7a2f1d
LT
257}
258
b60e188c 259static inline unsigned create_ce_flags(unsigned stage)
7fec10b7 260{
b60e188c 261 return (stage << CE_STAGESHIFT);
7fec10b7
JH
262}
263
b60e188c 264#define ce_namelen(ce) ((ce)->ce_namelen)
aee46198 265#define ce_size(ce) cache_entry_size(ce_namelen(ce))
7a51ed66 266#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
eadb5831 267#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
44a36913 268#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
eadb5831 269#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
895ff3b2 270#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
aee46198 271
e4479470 272#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
273static inline unsigned int create_ce_mode(unsigned int mode)
274{
8ae0a8c5 275 if (S_ISLNK(mode))
7a51ed66 276 return S_IFLNK;
302b9282 277 if (S_ISDIR(mode) || S_ISGITLINK(mode))
7a51ed66
LT
278 return S_IFGITLINK;
279 return S_IFREG | ce_permissions(mode);
8ae0a8c5 280}
20d142b4
RS
281static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
282 unsigned int mode)
185c975f 283{
78a8d641
JS
284 extern int trust_executable_bit, has_symlinks;
285 if (!has_symlinks && S_ISREG(mode) &&
7a51ed66 286 ce && S_ISLNK(ce->ce_mode))
78a8d641 287 return ce->ce_mode;
185c975f 288 if (!trust_executable_bit && S_ISREG(mode)) {
7a51ed66 289 if (ce && S_ISREG(ce->ce_mode))
185c975f
JH
290 return ce->ce_mode;
291 return create_ce_mode(0666);
292 }
293 return create_ce_mode(mode);
294}
d6b8fc30
JH
295static inline int ce_to_dtype(const struct cache_entry *ce)
296{
297 unsigned ce_mode = ntohl(ce->ce_mode);
298 if (S_ISREG(ce_mode))
299 return DT_REG;
300 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
301 return DT_DIR;
302 else if (S_ISLNK(ce_mode))
303 return DT_LNK;
304 else
305 return DT_UNKNOWN;
306}
b90d9b88
RS
307static inline unsigned int canon_mode(unsigned int mode)
308{
309 if (S_ISREG(mode))
310 return S_IFREG | ce_permissions(mode);
311 if (S_ISLNK(mode))
312 return S_IFLNK;
313 if (S_ISDIR(mode))
314 return S_IFDIR;
315 return S_IFGITLINK;
316}
e4479470 317
ee7825b5 318#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
f5cabd13 319
e636a7b4
NTND
320#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
321#define CE_ENTRY_CHANGED (1 << 1)
322#define CE_ENTRY_REMOVED (1 << 2)
323#define CE_ENTRY_ADDED (1 << 3)
6c306a34 324#define RESOLVE_UNDO_CHANGED (1 << 4)
a5400efe 325#define CACHE_TREE_CHANGED (1 << 5)
c18b80a0 326#define SPLIT_INDEX_ORDERED (1 << 6)
1bbb3dba 327#define UNTRACKED_CHANGED (1 << 7)
e636a7b4 328
5fc2fc8f 329struct split_index;
83c094ad
NTND
330struct untracked_cache;
331
228e94f9
JH
332struct index_state {
333 struct cache_entry **cache;
9d227781 334 unsigned int version;
228e94f9 335 unsigned int cache_nr, cache_alloc, cache_changed;
cfc5789a 336 struct string_list *resolve_undo;
228e94f9 337 struct cache_tree *cache_tree;
5fc2fc8f 338 struct split_index *split_index;
fba2f38a 339 struct cache_time timestamp;
913e0e99
JH
340 unsigned name_hash_initialized : 1,
341 initialized : 1;
8b013788 342 struct hashmap name_hash;
e05881a4 343 struct hashmap dir_hash;
426ddeea 344 unsigned char sha1[20];
83c094ad 345 struct untracked_cache *untracked;
228e94f9
JH
346};
347
348extern struct index_state the_index;
349
96872bc2 350/* Name hashing */
ea194895 351extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
96872bc2 352extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
2092678c
KB
353extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
354extern void free_name_hash(struct index_state *istate);
96872bc2
LT
355
356
4aab5b46 357#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
228e94f9
JH
358#define active_cache (the_index.cache)
359#define active_nr (the_index.cache_nr)
360#define active_alloc (the_index.cache_alloc)
361#define active_cache_changed (the_index.cache_changed)
362#define active_cache_tree (the_index.cache_tree)
e83c5163 363
4aab5b46
JH
364#define read_cache() read_index(&the_index)
365#define read_cache_from(path) read_index_from(&the_index, (path))
671c9b7e 366#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
fa7b3c2f 367#define is_cache_unborn() is_index_unborn(&the_index)
e46bbcf6 368#define read_cache_unmerged() read_index_unmerged(&the_index)
4aab5b46 369#define discard_cache() discard_index(&the_index)
94a5728c 370#define unmerged_cache() unmerged_index(&the_index)
4aab5b46
JH
371#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
372#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
81dc2307 373#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
4aab5b46
JH
374#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
375#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
610d55af
TG
376#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
377#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
d9d70966 378#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
3deffc52 379#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
4bd5b7da
JH
380#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
381#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
db5360f3
ES
382#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
383#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
98fa4738 384#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
cfc5789a 385#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
8aa38563 386#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
4421a823 387#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
ff366825 388#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
4aab5b46 389#endif
e83c5163 390
edaec3fb
JH
391enum object_type {
392 OBJ_BAD = -1,
393 OBJ_NONE = 0,
394 OBJ_COMMIT = 1,
395 OBJ_TREE = 2,
396 OBJ_BLOB = 3,
397 OBJ_TAG = 4,
398 /* 5 for future expansion */
399 OBJ_OFS_DELTA = 6,
400 OBJ_REF_DELTA = 7,
355885d5 401 OBJ_ANY,
4b05548f 402 OBJ_MAX
edaec3fb
JH
403};
404
b45563a2
JH
405static inline enum object_type object_type(unsigned int mode)
406{
407 return S_ISDIR(mode) ? OBJ_TREE :
408 S_ISGITLINK(mode) ? OBJ_COMMIT :
409 OBJ_BLOB;
410}
411
2163e5db 412/* Double-check local_repo_env below if you add to this list. */
8ac069ac 413#define GIT_DIR_ENVIRONMENT "GIT_DIR"
c7b3a3d2 414#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
a1bea2c1 415#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
892c41b9 416#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
a6f7f9a3 417#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
74866d75 418#define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
b58a68c1 419#define GIT_TOPLEVEL_PREFIX_ENVIRONMENT "GIT_INTERNAL_TOPLEVEL_PREFIX"
8ac069ac 420#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 421#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 422#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 423#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
069c0532 424#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
d4ebc36c
JH
425#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
426#define CONFIG_ENVIRONMENT "GIT_CONFIG"
2b64fc89 427#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
d4ebc36c 428#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
0454dd93 429#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
6476b38b 430#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
58d121b2 431#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
d0bfd026
JH
432#define GITATTRIBUTES_FILE ".gitattributes"
433#define INFOATTRIBUTES_FILE "info/attributes"
f48fd688 434#define ATTRIBUTE_MACRO_PREFIX "[attr]"
a97a7468
JS
435#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
436#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
894a9d33 437#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
6956f858
TR
438#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
439#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
823ab40f 440#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
bd30c2e4
NTND
441#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
442#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
93d93537 443#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
e34c2e01 444#define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
bb233d69 445
48a7c1c4 446/*
2cd83d10
JK
447 * This environment variable is expected to contain a boolean indicating
448 * whether we should or should not treat:
449 *
450 * GIT_DIR=foo.git git ...
451 *
452 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
453 * of this, but we use it internally to communicate to sub-processes that we
454 * are in a bare repo. If not set, defaults to true.
455 */
456#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
457
48a7c1c4 458/*
2163e5db
JK
459 * Repository-local GIT_* environment variables; these will be cleared
460 * when git spawns a sub-process that runs inside another repository.
461 * The array is NULL-terminated, which makes it easy to pass in the "env"
462 * parameter of a run-command invocation, or to do a simple walk.
48a7c1c4 463 */
2163e5db 464extern const char * const local_repo_env[];
48a7c1c4 465
73f192c9
BW
466extern void setup_git_env(void);
467
b9605bc4
JK
468/*
469 * Returns true iff we have a configured git repository (either via
470 * setup_git_directory, or in the environment via $GIT_DIR).
471 */
472int have_git_dir(void);
473
7d1864ce
JH
474extern int is_bare_repository_cfg;
475extern int is_bare_repository(void);
68025633 476extern int is_inside_git_dir(void);
e90fdc39 477extern char *git_work_tree_cfg;
892c41b9 478extern int is_inside_work_tree(void);
c5fba16c 479extern const char *get_git_dir(void);
c7b3a3d2 480extern const char *get_git_common_dir(void);
8ac069ac
JH
481extern char *get_object_directory(void);
482extern char *get_index_file(void);
5da5c8f4 483extern char *get_graft_file(void);
d7ac12b2 484extern int set_git_dir(const char *path);
11f9dd71 485extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
31e26ebc 486extern int get_common_dir(struct strbuf *sb, const char *gitdir);
a1bea2c1
JT
487extern const char *get_git_namespace(void);
488extern const char *strip_namespace(const char *namespaced_ref);
74866d75 489extern const char *get_super_prefix(void);
e90fdc39 490extern const char *get_git_work_tree(void);
a93bedad 491
ffd036b1
JK
492/*
493 * Return true if the given path is a git directory; note that this _just_
494 * looks at the directory itself. If you want to know whether "foo/.git"
495 * is a repository, you must feed that path, not just "foo".
496 */
497extern int is_git_directory(const char *path);
498
499/*
500 * Return 1 if the given path is the root of a git repository or
501 * submodule, else 0. Will not return 1 for bare repositories with the
502 * exception of creating a bare repository in "foo/.git" and calling
503 * is_git_repository("foo").
504 *
505 * If we run into read errors, we err on the side of saying "yes, it is",
506 * as we usually consider sub-repos precious, and would prefer to err on the
507 * side of not disrupting or deleting them.
508 */
509extern int is_nonbare_repository_dir(struct strbuf *path);
510
a93bedad
EE
511#define READ_GITFILE_ERR_STAT_FAILED 1
512#define READ_GITFILE_ERR_NOT_A_FILE 2
513#define READ_GITFILE_ERR_OPEN_FAILED 3
514#define READ_GITFILE_ERR_READ_FAILED 4
515#define READ_GITFILE_ERR_INVALID_FORMAT 5
516#define READ_GITFILE_ERR_NO_PATH 6
517#define READ_GITFILE_ERR_NOT_A_REPO 7
921bdd96 518#define READ_GITFILE_ERR_TOO_LARGE 8
5f29433f 519extern void read_gitfile_error_die(int error_code, const char *path, const char *dir);
a93bedad
EE
520extern const char *read_gitfile_gently(const char *path, int *return_error_code);
521#define read_gitfile(path) read_gitfile_gently((path), NULL)
40d96325
SB
522extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
523#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
524
19757d80 525extern void set_git_work_tree(const char *tree);
8ac069ac
JH
526
527#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 528
59f0f2f3 529extern void setup_work_tree(void);
16ac8b8d 530/*
d3fb71b3
BW
531 * Find the commondir and gitdir of the repository that contains the current
532 * working directory, without changing the working directory or other global
533 * state. The result is appended to commondir and gitdir. If the discovered
534 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
535 * both have the same result appended to the buffer. The return value is
536 * either 0 upon success and non-zero if no repository was found.
16ac8b8d 537 */
d3fb71b3
BW
538extern int discover_git_directory(struct strbuf *commondir,
539 struct strbuf *gitdir);
4ca06608 540extern const char *setup_git_directory_gently(int *);
d288a700 541extern const char *setup_git_directory(void);
edc54fb5 542extern char *prefix_path(const char *prefix, int len, const char *path);
645a29c4 543extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
59801976
JK
544
545/*
546 * Concatenate "prefix" (if len is non-zero) and "path", with no
547 * connecting characters (so "prefix" should end with a "/").
548 * Unlike prefix_path, this should be used if the named file does
549 * not have to interact with index entry; i.e. name of a random file
550 * on the filesystem.
551 *
e4da43b1
JK
552 * The return value is always a newly allocated string (even if the
553 * prefix was empty).
59801976 554 */
e4da43b1 555extern char *prefix_filename(const char *prefix, const char *path);
59801976 556
c6e8c800 557extern int check_filename(const char *prefix, const char *name);
023e37c3
MM
558extern void verify_filename(const char *prefix,
559 const char *name,
560 int diagnose_misspelt_rev);
ea92f41f 561extern void verify_non_filename(const char *prefix, const char *name);
546e0fd9 562extern int path_inside_repo(const char *prefix, const char *path);
d288a700 563
f225aeb2 564#define INIT_DB_QUIET 0x0001
33158701 565#define INIT_DB_EXIST_OK 0x0002
f225aeb2 566
33158701
NTND
567extern int init_db(const char *git_dir, const char *real_git_dir,
568 const char *template_dir, unsigned int flags);
f225aeb2 569
1d999ddd 570extern void sanitize_stdfds(void);
de0957ce 571extern int daemonize(void);
1d999ddd 572
e83c5163
LT
573#define alloc_nr(x) (((x)+16)*3/2)
574
6815e569
JK
575/*
576 * Realloc the buffer pointed at by variable 'x' so that it can hold
577 * at least 'nr' entries; the number of entries currently allocated
578 * is 'alloc', using the standard growing factor alloc_nr() macro.
579 *
01f6fd4b 580 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
6815e569
JK
581 */
582#define ALLOC_GROW(x, nr, alloc) \
583 do { \
c927e6c6 584 if ((nr) > alloc) { \
4234a761
JH
585 if (alloc_nr(alloc) < (nr)) \
586 alloc = (nr); \
587 else \
588 alloc = alloc_nr(alloc); \
2756ca43 589 REALLOC_ARRAY(x, alloc); \
6815e569 590 } \
98746061 591 } while (0)
6815e569 592
734aab75 593/* Initialize and use the cache information */
03b86647 594struct lock_file;
4aab5b46 595extern int read_index(struct index_state *);
5ab2a2da 596extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
3e52f70b
NTND
597extern int do_read_index(struct index_state *istate, const char *path,
598 int must_exist); /* for testting only! */
4aab5b46 599extern int read_index_from(struct index_state *, const char *path);
fa7b3c2f 600extern int is_index_unborn(struct index_state *);
e46bbcf6 601extern int read_index_unmerged(struct index_state *);
03b86647
NTND
602#define COMMIT_LOCK (1 << 0)
603#define CLOSE_LOCK (1 << 1)
604extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
4aab5b46 605extern int discard_index(struct index_state *);
edf3b905 606extern void move_index_extensions(struct index_state *dst, struct index_state *src);
d1f128b0 607extern int unmerged_index(const struct index_state *);
8dcf39c4 608extern int verify_path(const char *path);
a6db3fbb 609extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change);
41284eb0
DT
610extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
611extern void adjust_dirname_case(struct index_state *istate, char *name);
db5360f3 612extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
12733e9d
SB
613
614/*
615 * Searches for an entry defined by name and namelen in the given index.
616 * If the return value is positive (including 0) it is the position of an
617 * exact match. If the return value is negative, the negated value minus 1
618 * is the position where the entry would be inserted.
619 * Example: The current index consists of these files and its stages:
620 *
621 * b#0, d#0, f#1, f#3
622 *
623 * index_name_pos(&index, "a", 1) -> -1
624 * index_name_pos(&index, "b", 1) -> 0
625 * index_name_pos(&index, "c", 1) -> -2
626 * index_name_pos(&index, "d", 1) -> 1
627 * index_name_pos(&index, "e", 1) -> -3
628 * index_name_pos(&index, "f", 1) -> -3
629 * index_name_pos(&index, "g", 1) -> -5
630 */
d1f128b0 631extern int index_name_pos(const struct index_state *, const char *name, int namelen);
12733e9d 632
192268c1
JH
633#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
634#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 635#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
af3785dc 636#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
39425819 637#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
ce7c614b 638#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
4aab5b46 639extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
81dc2307 640extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
3bd72adf
SB
641
642/* Remove entry, return true if there are more entries to go. */
4aab5b46 643extern int remove_index_entry_at(struct index_state *, int pos);
3bd72adf 644
36419c8e 645extern void remove_marked_cache_entries(struct index_state *istate);
4aab5b46 646extern int remove_file_from_index(struct index_state *, const char *path);
38ed1d89
JH
647#define ADD_CACHE_VERBOSE 1
648#define ADD_CACHE_PRETEND 2
01665924 649#define ADD_CACHE_IGNORE_ERRORS 4
041aee31 650#define ADD_CACHE_IGNORE_REMOVAL 8
39425819 651#define ADD_CACHE_INTENT 16
20cf41d0
SB
652/*
653 * These two are used to add the contents of the file at path
654 * to the index, marking the working tree up-to-date by storing
655 * the cached stat info in the resulting cache entry. A caller
656 * that has already run lstat(2) on the path can call
657 * add_to_index(), and all others can call add_file_to_index();
658 * the latter will do necessary lstat(2) internally before
659 * calling the former.
660 */
610d55af
TG
661extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
662extern int add_file_to_index(struct index_state *, const char *path, int flags);
20cf41d0 663
25762726 664extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
d9d70966 665extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
9c5e6c80 666extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
b4b313f9 667extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
98fa4738 668extern int index_name_is_other(const struct index_state *, const char *, int);
87542508 669extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
4bd5b7da
JH
670
671/* do stat comparison even if CE_VALID is true */
672#define CE_MATCH_IGNORE_VALID 01
673/* do not check the contents but report dirty on racily-clean entries */
56cac48c
NTND
674#define CE_MATCH_RACY_IS_DIRTY 02
675/* do stat comparison even if CE_SKIP_WORKTREE is true */
676#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
2e2e7ec1
BK
677/* ignore non-existent files during stat update */
678#define CE_MATCH_IGNORE_MISSING 0x08
25762726
BK
679/* enable stat refresh */
680#define CE_MATCH_REFRESH 0x10
21a6b9fa
RS
681extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
682extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
4bd5b7da 683
c4ce46fc
JH
684#define HASH_WRITE_OBJECT 1
685#define HASH_FORMAT_CHECK 2
686extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
687extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
c21d39d7
MH
688
689/*
690 * Record to sd the data from st that we use to check whether a file
691 * might have changed.
692 */
693extern void fill_stat_data(struct stat_data *sd, struct stat *st);
694
695/*
696 * Return 0 if st is consistent with a file not having been changed
697 * since sd was filled. If there are differences, return a
698 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
699 * INODE_CHANGED, and DATA_CHANGED.
700 */
701extern int match_stat_data(const struct stat_data *sd, struct stat *st);
ed4efab1
NTND
702extern int match_stat_data_racy(const struct index_state *istate,
703 const struct stat_data *sd, struct stat *st);
c21d39d7 704
415e96c8
JH
705extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
706
405e5b2f
LT
707#define REFRESH_REALLY 0x0001 /* ignore_valid */
708#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
709#define REFRESH_QUIET 0x0004 /* be quiet about it */
710#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
3f1b7b60 711#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
43673fdd 712#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
9b2d6149 713extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
1335d76e 714extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
405e5b2f 715
ccdc4ec3 716extern void update_index_if_able(struct index_state *, struct lock_file *);
30ca07a2
JH
717
718extern int hold_locked_index(struct lock_file *, int);
5e7f56ac 719extern void set_alternate_index_output(const char *);
697cc8ef 720
a33fc72f
JH
721extern int verify_index_checksum;
722
2ae1c53b 723/* Environment bits from configuration mechanism */
17712991 724extern int trust_executable_bit;
1ce4790b 725extern int trust_ctime;
c08e4d5b 726extern int check_stat;
9378c161 727extern int quote_path_fully;
78a8d641 728extern int has_symlinks;
dce96489 729extern int minimum_abbrev, default_abbrev;
0a9b88b7 730extern int ignore_case;
5f73076c 731extern int assume_unchanged;
9f0bb90d 732extern int prefer_symlink_refs;
2f8acdb3 733extern int warn_ambiguous_refs;
25fba78d 734extern int warn_on_object_refname_ambiguity;
2ae1c53b 735extern const char *apply_default_whitespace;
86c91f91 736extern const char *apply_default_ignorewhitespace;
64589a03 737extern const char *git_attributes_file;
867ad08a 738extern const char *git_hooks_path;
12f6c308 739extern int zlib_compression_level;
960ccca6 740extern int core_compression_level;
8de7eeb5 741extern int pack_compression_level;
60bb8b14 742extern size_t packed_git_window_size;
77ccc5bb 743extern size_t packed_git_limit;
18bdec11 744extern size_t delta_base_cache_limit;
15366280 745extern unsigned long big_file_threshold;
568508e7 746extern unsigned long pack_size_limit_cfg;
afc711b8 747
4543926b
JK
748/*
749 * Accessors for the core.sharedrepository config which lazy-load the value
750 * from the config (if not already set). The "reset" function can be
751 * used to unset "set" or cached value, meaning that the value will be loaded
752 * fresh from the config file on the next call to get_shared_repository().
753 */
7875acb6
JK
754void set_shared_repository(int value);
755int get_shared_repository(void);
4543926b 756void reset_shared_repository(void);
7875acb6 757
afc711b8
MH
758/*
759 * Do replace refs need to be checked this run? This variable is
760 * initialized to true unless --no-replace-object is used or
761 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
762 * commands that do not want replace references to be active. As an
763 * optimization it is also set to false if replace references have
764 * been sought but there were none.
765 */
766extern int check_replace_refs;
58d121b2 767extern char *git_replace_ref_base;
afc711b8 768
aafe9fba 769extern int fsync_object_files;
671c9b7e 770extern int core_preload_index;
08aefc9e 771extern int core_apply_sparse_checkout;
76759c7d 772extern int precomposed_unicode;
a42643aa 773extern int protect_hfs;
2b4c6efc 774extern int protect_ntfs;
17712991 775
49672f26
JK
776/*
777 * Include broken refs in all ref iterations, which will
778 * generally choke dangerous operations rather than letting
779 * them silently proceed without taking the broken ref into
780 * account.
781 */
782extern int ref_paranoia;
783
eff80a9f
JH
784/*
785 * The character that begins a commented line in user-editable file
786 * that is subject to stripspace.
787 */
788extern char comment_line_char;
84c9dc2c 789extern int auto_comment_line_char;
eff80a9f 790
f30afdab
JS
791/* Windows only */
792enum hide_dotfiles_type {
793 HIDE_DOTFILES_FALSE = 0,
794 HIDE_DOTFILES_TRUE,
795 HIDE_DOTFILES_DOTGITONLY
796};
797extern enum hide_dotfiles_type hide_dotfiles;
798
341fb286
CW
799enum log_refs_config {
800 LOG_REFS_UNSET = -1,
801 LOG_REFS_NONE = 0,
802 LOG_REFS_NORMAL,
803 LOG_REFS_ALWAYS
804};
805extern enum log_refs_config log_all_ref_updates;
806
9ed36cfa 807enum branch_track {
9188ed89 808 BRANCH_TRACK_UNSPECIFIED = -1,
9ed36cfa
JS
809 BRANCH_TRACK_NEVER = 0,
810 BRANCH_TRACK_REMOTE,
811 BRANCH_TRACK_ALWAYS,
812 BRANCH_TRACK_EXPLICIT,
4b05548f 813 BRANCH_TRACK_OVERRIDE
9ed36cfa
JS
814};
815
c998ae9b
DS
816enum rebase_setup_type {
817 AUTOREBASE_NEVER = 0,
818 AUTOREBASE_LOCAL,
819 AUTOREBASE_REMOTE,
4b05548f 820 AUTOREBASE_ALWAYS
c998ae9b
DS
821};
822
52153747 823enum push_default_type {
52153747
FAG
824 PUSH_DEFAULT_NOTHING = 0,
825 PUSH_DEFAULT_MATCHING,
b55e6775 826 PUSH_DEFAULT_SIMPLE,
53c40311 827 PUSH_DEFAULT_UPSTREAM,
f25950f3
CT
828 PUSH_DEFAULT_CURRENT,
829 PUSH_DEFAULT_UNSPECIFIED
52153747
FAG
830};
831
9ed36cfa 832extern enum branch_track git_branch_track;
c998ae9b 833extern enum rebase_setup_type autorebase;
52153747 834extern enum push_default_type push_default;
9ed36cfa 835
348df166
JS
836enum object_creation_mode {
837 OBJECT_CREATION_USES_HARDLINKS = 0,
4b05548f 838 OBJECT_CREATION_USES_RENAMES = 1
348df166
JS
839};
840
841extern enum object_creation_mode object_creation_mode;
be66a6c4 842
a97a7468
JS
843extern char *notes_ref_name;
844
7f3140cd
JS
845extern int grafts_replace_parents;
846
00a09d57
JK
847/*
848 * GIT_REPO_VERSION is the version we write by default. The
849 * _READ variant is the highest number we know how to
850 * handle.
851 */
ab9cb76f 852#define GIT_REPO_VERSION 0
00a09d57 853#define GIT_REPO_VERSION_READ 1
067fbd41 854extern int repository_format_precious_objects;
4b0d1eeb 855
2cc7c2c7
JK
856struct repository_format {
857 int version;
858 int precious_objects;
859 int is_bare;
860 char *work_tree;
861 struct string_list unknown_extensions;
862};
863
864/*
865 * Read the repository format characteristics from the config file "path" into
866 * "format" struct. Returns the numeric version. On error, -1 is returned,
867 * format->version is set to -1, and all other fields in the struct are
868 * undefined.
869 */
870int read_repository_format(struct repository_format *format, const char *path);
871
872/*
873 * Verify that the repository described by repository_format is something we
874 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
875 * any errors encountered.
876 */
877int verify_repository_format(const struct repository_format *format,
878 struct strbuf *err);
879
4b0d1eeb
JK
880/*
881 * Check the repository format version in the path found in get_git_dir(),
882 * and die if it is a version we don't understand. Generally one would
883 * set_git_dir() before calling this, and use it only for "are we in a valid
884 * repo?".
885 */
886extern void check_repository_format(void);
ab9cb76f 887
734aab75
LT
888#define MTIME_CHANGED 0x0001
889#define CTIME_CHANGED 0x0002
890#define OWNER_CHANGED 0x0004
891#define MODE_CHANGED 0x0008
892#define INODE_CHANGED 0x0010
893#define DATA_CHANGED 0x0020
8ae0a8c5 894#define TYPE_CHANGED 0x0040
e83c5163 895
d40d535b
MH
896/*
897 * Return the name of the file in the local object database that would
898 * be used to store a loose object with the specified sha1. The
899 * return value is a pointer to a statically allocated buffer that is
900 * overwritten each time the function is called.
901 */
30d6c6ea 902extern const char *sha1_file_name(const unsigned char *sha1);
d40d535b
MH
903
904/*
905 * Return the name of the (local) packfile with the specified sha1 in
906 * its name. The return value is a pointer to memory that is
907 * overwritten each time this function is called.
908 */
bf592c50 909extern char *sha1_pack_name(const unsigned char *sha1);
d40d535b
MH
910
911/*
912 * Return the name of the (local) pack index file with the specified
913 * sha1 in its name. The return value is a pointer to memory that is
914 * overwritten each time this function is called.
915 */
bf592c50 916extern char *sha1_pack_index_name(const unsigned char *sha1);
d40d535b 917
af49c6d0
JK
918/*
919 * Return an abbreviated sha1 unique within this repository's object database.
920 * The result will be at least `len` characters long, and will be NUL
921 * terminated.
922 *
ef2ed501
JK
923 * The non-`_r` version returns a static buffer which remains valid until 4
924 * more calls to find_unique_abbrev are made.
af49c6d0
JK
925 *
926 * The `_r` variant writes to a buffer supplied by the caller, which must be at
927 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
928 * written (excluding the NUL terminator).
929 *
930 * Note that while this version avoids the static buffer, it is not fully
931 * reentrant, as it calls into other non-reentrant git code.
932 */
933extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
934extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
935
cd02599c 936extern const unsigned char null_sha1[GIT_MAX_RAWSZ];
3e56e724 937extern const struct object_id null_oid;
1a812f3a
IM
938
939static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
0bef57ee 940{
1a812f3a
IM
941 int i;
942
aa1c6fdf 943 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
1a812f3a
IM
944 if (*sha1 != *sha2)
945 return *sha1 - *sha2;
946 }
947
948 return 0;
0bef57ee 949}
1a812f3a 950
aa1c6fdf 951static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
952{
953 return hashcmp(oid1->hash, oid2->hash);
954}
955
1a812f3a 956static inline int is_null_sha1(const unsigned char *sha1)
a89fccd2 957{
1a812f3a 958 return !hashcmp(sha1, null_sha1);
a89fccd2 959}
1a812f3a 960
aa1c6fdf 961static inline int is_null_oid(const struct object_id *oid)
962{
963 return !hashcmp(oid->hash, null_sha1);
964}
965
e702496e
SP
966static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
967{
aa1c6fdf 968 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
e702496e 969}
aa1c6fdf 970
971static inline void oidcpy(struct object_id *dst, const struct object_id *src)
972{
973 hashcpy(dst->hash, src->hash);
e702496e 974}
aa1c6fdf 975
1c41c82b
BW
976static inline struct object_id *oiddup(const struct object_id *src)
977{
978 struct object_id *dst = xmalloc(sizeof(struct object_id));
979 oidcpy(dst, src);
980 return dst;
981}
982
a8e0d16d
JH
983static inline void hashclr(unsigned char *hash)
984{
aa1c6fdf 985 memset(hash, 0, GIT_SHA1_RAWSZ);
a8e0d16d 986}
e83c5163 987
aa1c6fdf 988static inline void oidclr(struct object_id *oid)
989{
990 hashclr(oid->hash);
991}
992
993
14d9c578
JK
994#define EMPTY_TREE_SHA1_HEX \
995 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
dab0d410 996#define EMPTY_TREE_SHA1_BIN_LITERAL \
14d9c578
JK
997 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
998 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
8576fde6
JK
999extern const struct object_id empty_tree_oid;
1000#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)
14d9c578 1001
f8582cad
JK
1002#define EMPTY_BLOB_SHA1_HEX \
1003 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
1004#define EMPTY_BLOB_SHA1_BIN_LITERAL \
1005 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
1006 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
8576fde6
JK
1007extern const struct object_id empty_blob_oid;
1008#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)
1009
f8582cad
JK
1010
1011static inline int is_empty_blob_sha1(const unsigned char *sha1)
1012{
1013 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
1014}
1015
8576fde6
JK
1016static inline int is_empty_blob_oid(const struct object_id *oid)
1017{
1018 return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);
1019}
1020
1021static inline int is_empty_tree_sha1(const unsigned char *sha1)
1022{
1023 return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN);
1024}
1025
1026static inline int is_empty_tree_oid(const struct object_id *oid)
1027{
1028 return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);
1029}
1030
b862b61c
MM
1031/* set default permissions by passing mode arguments to open(2) */
1032int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1033int git_mkstemp_mode(char *pattern, int mode);
1034
06cbe855
HO
1035/*
1036 * NOTE NOTE NOTE!!
1037 *
1038 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1039 * not be changed. Old repositories have core.sharedrepository written in
1040 * numeric format, and therefore these values are preserved for compatibility
1041 * reasons.
1042 */
94df2506 1043enum sharedrepo {
06cbe855
HO
1044 PERM_UMASK = 0,
1045 OLD_PERM_GROUP = 1,
1046 OLD_PERM_EVERYBODY = 2,
1047 PERM_GROUP = 0660,
4b05548f 1048 PERM_EVERYBODY = 0664
94df2506
JH
1049};
1050int git_config_perm(const char *var, const char *value);
3a429d3b 1051int adjust_shared_perm(const char *path);
0be0521b
MH
1052
1053/*
1054 * Create the directory containing the named path, using care to be
204a047f
MH
1055 * somewhat safe against races. Return one of the scld_error values to
1056 * indicate success/failure. On error, set errno to describe the
1057 * problem.
18d37e86
MH
1058 *
1059 * SCLD_VANISHED indicates that one of the ancestor directories of the
1060 * path existed at one point during the function call and then
1061 * suddenly vanished, probably because another process pruned the
1062 * directory while we were working. To be robust against this kind of
1063 * race, callers might want to try invoking the function again when it
1064 * returns SCLD_VANISHED.
e95792e5
MH
1065 *
1066 * safe_create_leading_directories() temporarily changes path while it
1067 * is working but restores it before returning.
1068 * safe_create_leading_directories_const() doesn't modify path, even
1069 * temporarily.
0be0521b
MH
1070 */
1071enum scld_error {
1072 SCLD_OK = 0,
1073 SCLD_FAILED = -1,
1074 SCLD_PERMS = -2,
18d37e86
MH
1075 SCLD_EXISTS = -3,
1076 SCLD_VANISHED = -4
0be0521b
MH
1077};
1078enum scld_error safe_create_leading_directories(char *path);
1079enum scld_error safe_create_leading_directories_const(const char *path);
1080
177978f5
MH
1081/*
1082 * Callback function for raceproof_create_file(). This function is
1083 * expected to do something that makes dirname(path) permanent despite
1084 * the fact that other processes might be cleaning up empty
1085 * directories at the same time. Usually it will create a file named
1086 * path, but alternatively it could create another file in that
1087 * directory, or even chdir() into that directory. The function should
1088 * return 0 if the action was completed successfully. On error, it
1089 * should return a nonzero result and set errno.
1090 * raceproof_create_file() treats two errno values specially:
1091 *
1092 * - ENOENT -- dirname(path) does not exist. In this case,
1093 * raceproof_create_file() tries creating dirname(path)
1094 * (and any parent directories, if necessary) and calls
1095 * the function again.
1096 *
1097 * - EISDIR -- the file already exists and is a directory. In this
1098 * case, raceproof_create_file() removes the directory if
1099 * it is empty (and recursively any empty directories that
1100 * it contains) and calls the function again.
1101 *
1102 * Any other errno causes raceproof_create_file() to fail with the
1103 * callback's return value and errno.
1104 *
1105 * Obviously, this function should be OK with being called again if it
1106 * fails with ENOENT or EISDIR. In other scenarios it will not be
1107 * called again.
1108 */
1109typedef int create_file_fn(const char *path, void *cb);
1110
1111/*
1112 * Create a file in dirname(path) by calling fn, creating leading
1113 * directories if necessary. Retry a few times in case we are racing
1114 * with another process that is trying to clean up the directory that
1115 * contains path. See the documentation for create_file_fn for more
1116 * details.
1117 *
1118 * Return the value and set the errno that resulted from the most
1119 * recent call of fn. fn is always called at least once, and will be
1120 * called more than once if it returns ENOENT or EISDIR.
1121 */
1122int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
1123
90a6464b 1124int mkdir_in_gitdir(const char *path);
4aad2f16 1125extern char *expand_user_path(const char *path, int real_home);
1c64b48e 1126const char *enter_repo(const char *path, int strict);
e5392c51
JS
1127static inline int is_absolute_path(const char *path)
1128{
88135203 1129 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
e5392c51 1130}
90b4a71c 1131int is_directory(const char *);
a1ae4841
BW
1132char *strbuf_realpath(struct strbuf *resolved, const char *path,
1133 int die_on_error);
e2a57aac 1134const char *real_path(const char *path);
e3e46cdb 1135const char *real_path_if_valid(const char *path);
ce83eadd 1136char *real_pathdup(const char *path, int die_on_error);
e2a57aac 1137const char *absolute_path(const char *path);
b1edb40f 1138char *absolute_pathdup(const char *path);
41894ae3 1139const char *remove_leading_path(const char *in, const char *prefix);
e02ca72f 1140const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
645a29c4 1141int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
f3cad0ad 1142int normalize_path_copy(char *dst, const char *src);
31171d9e 1143int longest_ancestor_length(const char *path, struct string_list *prefixes);
4fcc86b0 1144char *strip_path_suffix(const char *path, const char *suffix);
34b6cb8b 1145int daemon_avoid_alias(const char *path);
1d1d69bc 1146extern int is_ntfs_dotgit(const char *name);
b2cb9425 1147
ea19289b
PT
1148/**
1149 * Return a newly allocated string with the evaluation of
1150 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1151 * "$HOME/.config/git/$filename". Return NULL upon error.
1152 */
1153extern char *xdg_config_home(const char *filename);
1154
e7f136bf
DL
1155/**
1156 * Return a newly allocated string with the evaluation of
1157 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1158 * "$HOME/.cache/git/$filename". Return NULL upon error.
1159 */
1160extern char *xdg_cache_home(const char *filename);
1161
e1111cef 1162/* object replacement */
ffe68cf9 1163#define LOOKUP_REPLACE_OBJECT 1
46f03448 1164#define LOOKUP_UNKNOWN_OBJECT 2
5bf29b95 1165extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
f5552aee
CC
1166static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1167{
ffe68cf9 1168 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
5bf29b95 1169}
1f91e79c
MH
1170
1171/*
1172 * This internal function is only declared here for the benefit of
1173 * lookup_replace_object(). Please do not call it directly.
1174 */
e1111cef 1175extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1f91e79c
MH
1176
1177/*
1178 * If object sha1 should be replaced, return the replacement object's
1179 * name (replaced recursively, if necessary). The return value is
1180 * either sha1 or a pointer to a permanently-allocated value. When
1181 * object replacement is suppressed, always return sha1.
1182 */
e1111cef
JH
1183static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1184{
afc711b8 1185 if (!check_replace_refs)
e1111cef
JH
1186 return sha1;
1187 return do_lookup_replace_object(sha1);
f5552aee 1188}
1f91e79c 1189
bf93eea0
CC
1190static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1191{
1192 if (!(flag & LOOKUP_REPLACE_OBJECT))
1193 return sha1;
1194 return lookup_replace_object(sha1);
1195}
e1111cef 1196
e83c5163 1197/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
21666f1a 1198extern int sha1_object_info(const unsigned char *, unsigned long *);
ce9fbf16 1199extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
c00e657d 1200extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
0c3db67c 1201extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
21666f1a 1202extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
bbac7311 1203extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1b8ac5ea 1204extern int git_open_cloexec(const char *name, int flags);
b4d065df 1205#define git_open(name) git_open_cloexec(name, O_RDONLY)
f0270efd 1206extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
eb4f4076 1207extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
f0270efd 1208extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
8237b185 1209
0e8189e2
NP
1210/* global flag to enable extra checks when accessing packed objects */
1211extern int do_check_packed_object_crc;
1212
5d6ccf5c 1213extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 1214
cb5add58 1215extern int finalize_object_file(const char *tmpfile, const char *filename);
8237b185 1216
cd673c1f 1217extern int has_sha1_pack(const unsigned char *sha1);
d40d535b 1218
f6371f92
JK
1219/*
1220 * Open the loose object at path, check its sha1, and return the contents,
1221 * type, and size. If the object is a blob, then "contents" may return NULL,
1222 * to allow streaming of large blobs.
1223 *
1224 * Returns 0 on success, negative on error (details may be written to stderr).
1225 */
1226int read_loose_object(const char *path,
1227 const unsigned char *expected_sha1,
1228 enum object_type *type,
1229 unsigned long *size,
1230 void **contents);
1231
d40d535b
MH
1232/*
1233 * Return true iff we have an object named sha1, whether local or in
1234 * an alternate object database, and whether packed or loose. This
1235 * function does not respect replace references.
0eeb077b
JK
1236 *
1237 * If the QUICK flag is set, do not re-check the pack directory
1238 * when we cannot find the object (this means we may give a false
1239 * negative answer if another process is simultaneously repacking).
d40d535b 1240 */
0eeb077b
JK
1241#define HAS_SHA1_QUICK 0x1
1242extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1243static inline int has_sha1_file(const unsigned char *sha1)
1244{
1245 return has_sha1_file_with_flags(sha1, 0);
1246}
d40d535b 1247
b419aa25 1248/* Same as the above, except for struct object_id. */
1249extern int has_object_file(const struct object_id *oid);
5827a035 1250extern int has_object_file_with_flags(const struct object_id *oid, int flags);
b419aa25 1251
d40d535b
MH
1252/*
1253 * Return true iff an alternate object database has a loose object
1254 * with the specified name. This function does not respect replace
1255 * references.
1256 */
0f4dc14a 1257extern int has_loose_object_nonlocal(const unsigned char *sha1);
8237b185 1258
bf592c50
DB
1259extern int has_pack_index(const unsigned char *sha1);
1260
40d52ff7
JK
1261extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1262
6a5e6f5e
CC
1263/* Helper to check and "touch" a file */
1264extern int check_and_freshen_file(const char *fn, int freshen);
1265
192a6be2
LT
1266extern const signed char hexval_table[256];
1267static inline unsigned int hexval(unsigned char c)
e49521b5
JH
1268{
1269 return hexval_table[c];
1270}
1271
d2330973
RS
1272/*
1273 * Convert two consecutive hexadecimal digits into a char. Return a
1274 * negative value on error. Don't run over the end of short strings.
1275 */
1276static inline int hex2chr(const char *s)
1277{
1278 int val = hexval(s[0]);
1279 return (val < 0) ? val : (val << 4) | hexval(s[1]);
1280}
1281
e83c5163 1282/* Convert to/from hex/sha1 representation */
dce96489
LT
1283#define MINIMUM_ABBREV minimum_abbrev
1284#define DEFAULT_ABBREV default_abbrev
46a6c262 1285
65acfeac
JH
1286/* used when the code does not know or care what the default abbrev is */
1287#define FALLBACK_DEFAULT_ABBREV 7
1288
573285e5
CP
1289struct object_context {
1290 unsigned char tree[20];
573285e5 1291 unsigned mode;
c4ec9677
DT
1292 /*
1293 * symlink_path is only used by get_tree_entry_follow_symlinks,
1294 * and only for symlinks that point outside the repository.
1295 */
1296 struct strbuf symlink_path;
dc944b65
JK
1297 /*
1298 * If GET_SHA1_RECORD_PATH is set, this will record path (if any)
1299 * found when resolving the name. The caller is responsible for
1300 * releasing the memory.
1301 */
1302 char *path;
573285e5
CP
1303};
1304
c4ec9677
DT
1305#define GET_SHA1_QUIETLY 01
1306#define GET_SHA1_COMMIT 02
1307#define GET_SHA1_COMMITTISH 04
1308#define GET_SHA1_TREE 010
1309#define GET_SHA1_TREEISH 020
1310#define GET_SHA1_BLOB 040
1311#define GET_SHA1_FOLLOW_SYMLINKS 0100
dc944b65 1312#define GET_SHA1_RECORD_PATH 0200
c4ec9677 1313#define GET_SHA1_ONLY_TO_DIE 04000
37c00e55 1314
259942f5
JK
1315#define GET_SHA1_DISAMBIGUATORS \
1316 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \
1317 GET_SHA1_TREE | GET_SHA1_TREEISH | \
1318 GET_SHA1_BLOB)
1319
3c249c95 1320extern int get_sha1(const char *str, unsigned char *sha1);
daba53ae 1321extern int get_sha1_commit(const char *str, unsigned char *sha1);
cd74e473 1322extern int get_sha1_committish(const char *str, unsigned char *sha1);
daba53ae
JH
1323extern int get_sha1_tree(const char *str, unsigned char *sha1);
1324extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1325extern int get_sha1_blob(const char *str, unsigned char *sha1);
8c135ea2 1326extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
c0a487ea 1327extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *oc);
d4e85a1a 1328
2764fd93 1329extern int get_oid(const char *str, struct object_id *oid);
1330
1b7ba794 1331typedef int each_abbrev_fn(const struct object_id *oid, void *);
957d7406 1332extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
d4e85a1a 1333
5b33cb1f
JK
1334extern int set_disambiguate_hint_config(const char *var, const char *value);
1335
d4e85a1a
MH
1336/*
1337 * Try to read a SHA1 in hexadecimal format from the 40 characters
1338 * starting at hex. Write the 20-byte result to sha1 in binary form.
1339 * Return 0 on success. Reading stops if a NUL is encountered in the
1340 * input, so it is safe to pass this function an arbitrary
1341 * null-terminated string.
1342 */
197ee8c9 1343extern int get_sha1_hex(const char *hex, unsigned char *sha1);
aa1c6fdf 1344extern int get_oid_hex(const char *hex, struct object_id *sha1);
d4e85a1a 1345
af49c6d0
JK
1346/*
1347 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1348 * and writes the NUL-terminated output to the buffer `out`, which must be at
1349 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1350 * convenience.
1351 *
1352 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1353 * buffers, making it safe to make multiple calls for a single statement, like:
1354 *
1355 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1356 */
1357extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
55c529a7 1358extern char *oid_to_hex_r(char *out, const struct object_id *oid);
197ee8c9 1359extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
aa1c6fdf 1360extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
7cb36842 1361
605f430e 1362/*
1363 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1364 * pointer specified by end when parsing stops. The resulting object ID is
1365 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1366 * other invalid character. end is only updated on success; otherwise, it is
1367 * unmodified.
1368 */
1369extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
1370
e322b60d
JK
1371/*
1372 * This reads short-hand syntax that not only evaluates to a commit
1373 * object name, but also can act as if the end user spelled the name
1374 * of the branch from the command line.
1375 *
1376 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1377 * places the name of the branch in the given buf and returns the
1378 * number of characters parsed if successful.
1379 *
1380 * - "<branch>@{upstream}" finds the name of the other ref that
1381 * <branch> is configured to merge with (missing <branch> defaults
1382 * to the current branch), and places the name of the branch in the
1383 * given buf and returns the number of characters parsed if
1384 * successful.
1385 *
1386 * If the input is not of the accepted format, it returns a negative
1387 * number to signal an error.
1388 *
1389 * If the input was ok but there are not N branch switches in the
1390 * reflog, it returns 0.
0e9f62da
JK
1391 *
1392 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1393 * expansions: local branches ("refs/heads/"), remote branches
1394 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1395 * allowed, even ones to refs outside of those namespaces.
e322b60d 1396 */
0e9f62da
JK
1397#define INTERPRET_BRANCH_LOCAL (1<<0)
1398#define INTERPRET_BRANCH_REMOTE (1<<1)
1399#define INTERPRET_BRANCH_HEAD (1<<2)
1400extern int interpret_branch_name(const char *str, int len, struct strbuf *,
1401 unsigned allowed);
151b2911 1402extern int get_oid_mb(const char *str, struct object_id *oid);
e86eb666 1403
c847f537 1404extern int validate_headref(const char *ref);
e83c5163 1405
958ba6c9 1406extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
0ab9e1e8 1407extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
ccdd4a0f 1408extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
b60e188c 1409extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
e83c5163 1410
40469ee9 1411extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 1412 const char *required_type,
40469ee9
JH
1413 unsigned long *size,
1414 unsigned char *sha1_ret);
f4913f91 1415
81776315
JH
1416extern struct object *peel_to_type(const char *name, int namelen,
1417 struct object *o, enum object_type);
1418
a5481a6c
JK
1419struct date_mode {
1420 enum date_mode_type {
1421 DATE_NORMAL = 0,
1422 DATE_RELATIVE,
1423 DATE_SHORT,
a5481a6c
JK
1424 DATE_ISO8601,
1425 DATE_ISO8601_STRICT,
1426 DATE_RFC2822,
aa1462cc 1427 DATE_STRFTIME,
642833db
JK
1428 DATE_RAW,
1429 DATE_UNIX
a5481a6c 1430 } type;
aa1462cc 1431 const char *strftime_fmt;
add00ba2 1432 int local;
73013afd
JH
1433};
1434
a5481a6c
JK
1435/*
1436 * Convenience helper for passing a constant type, like:
1437 *
1438 * show_date(t, tz, DATE_MODE(NORMAL));
1439 */
1440#define DATE_MODE(t) date_mode_from_type(DATE_##t)
1441struct date_mode *date_mode_from_type(enum date_mode_type type);
1442
dddbad72
JS
1443const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);
1444void show_date_relative(timestamp_t time, int tz, const struct timeval *now,
7d29afd4 1445 struct strbuf *timebuf);
c33ddc2e 1446int parse_date(const char *date, struct strbuf *out);
dddbad72
JS
1447int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);
1448int parse_expiry_date(const char *date, timestamp_t *timestamp);
c33ddc2e 1449void datestamp(struct strbuf *out);
93cfa7c7 1450#define approxidate(s) approxidate_careful((s), NULL)
dddbad72
JS
1451timestamp_t approxidate_careful(const char *, int *);
1452timestamp_t approxidate_relative(const char *date, const struct timeval *now);
a5481a6c 1453void parse_date_format(const char *format, struct date_mode *mode);
dddbad72 1454int date_overflows(timestamp_t date);
ecee9d9e 1455
f9bc573f 1456#define IDENT_STRICT 1
b9f0ac17 1457#define IDENT_NO_DATE 2
c15e1987 1458#define IDENT_NO_NAME 4
749be728
JH
1459extern const char *git_author_info(int);
1460extern const char *git_committer_info(int);
798123af 1461extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
d9ccfe77 1462extern const char *fmt_name(const char *name, const char *email);
9830534e 1463extern const char *ident_default_name(void);
bcb2b004 1464extern const char *ident_default_email(void);
44fcb497 1465extern const char *git_editor(void);
64778d24 1466extern const char *git_pager(int stdout_is_tty);
9597921b 1467extern int git_ident_config(const char *, const char *, void *);
4d9c7e6f 1468extern void reset_ident_date(void);
6aa33f40 1469
4b340cfa
JH
1470struct ident_split {
1471 const char *name_begin;
1472 const char *name_end;
1473 const char *mail_begin;
1474 const char *mail_end;
1475 const char *date_begin;
1476 const char *date_end;
1477 const char *tz_begin;
1478 const char *tz_end;
1479};
1480/*
1481 * Signals an success with 0, but time part of the result may be NULL
1482 * if the input lacks timestamp and zone
1483 */
1484extern int split_ident_line(struct ident_split *, const char *, int);
1485
d1053246
JK
1486/*
1487 * Like show_date, but pull the timestamp and tz parameters from
1488 * the ident_split. It will also sanity-check the values and produce
1489 * a well-known sentinel date if they appear bogus.
1490 */
a5481a6c
JK
1491const char *show_ident_date(const struct ident_split *id,
1492 const struct date_mode *mode);
d1053246 1493
662cc30c
JK
1494/*
1495 * Compare split idents for equality or strict ordering. Note that we
1496 * compare only the ident part of the line, ignoring any timestamp.
1497 *
1498 * Because there are two fields, we must choose one as the primary key; we
1499 * currently arbitrarily pick the email.
1500 */
1501extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1502
12dccc16 1503struct checkout {
d4a2024a 1504 struct index_state *istate;
12dccc16
LT
1505 const char *base_dir;
1506 int base_dir_len;
1507 unsigned force:1,
1508 quiet:1,
1509 not_new:1,
1510 refresh_cache:1;
1511};
68e3d629 1512#define CHECKOUT_INIT { NULL, "" }
12dccc16 1513
af2a651d 1514#define TEMPORARY_FILENAME_LENGTH 25
efbc5831 1515extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
b9fd2846
LT
1516
1517struct cache_def {
e7c73053 1518 struct strbuf path;
b9fd2846
LT
1519 int flags;
1520 int track_flags;
1521 int prefix_len_stat_func;
1522};
e7c73053 1523#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
2a608391 1524static inline void cache_def_clear(struct cache_def *cache)
e7c73053
KB
1525{
1526 strbuf_release(&cache->path);
1527}
b9fd2846 1528
57199892 1529extern int has_symlink_leading_path(const char *name, int len);
b9fd2846 1530extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
f66caaf9 1531extern int check_leading_path(const char *name, int len);
57199892 1532extern int has_dirs_only_path(const char *name, int len, int prefix_len);
78478927
KB
1533extern void schedule_dir_for_removal(const char *name, int len);
1534extern void remove_scheduled_dirs(void);
12dccc16 1535
9a217f2a 1536extern struct alternate_object_database {
d5a63b99 1537 struct alternate_object_database *next;
597f9134 1538
38dbe5f0
JK
1539 /* see alt_scratch_buf() */
1540 struct strbuf scratch;
1541 size_t base_len;
597f9134
JK
1542
1543 char path[FLEX_ARRAY];
d5a63b99 1544} *alt_odb_list;
9a217f2a 1545extern void prepare_alt_odb(void);
5e73633d 1546extern void read_info_alternates(const char * relative_base, int depth);
9eeea7d2 1547extern char *compute_alternate_path(const char *path, struct strbuf *err);
d79796bc 1548typedef int alt_odb_fn(struct alternate_object_database *, void *);
fe1b2268 1549extern int foreach_alt_odb(alt_odb_fn, void*);
9a217f2a 1550
7f0fa2c0
JK
1551/*
1552 * Allocate a "struct alternate_object_database" but do _not_ actually
1553 * add it to the list of alternates.
1554 */
1555struct alternate_object_database *alloc_alt_odb(const char *dir);
1556
a5b34d21
JK
1557/*
1558 * Add the directory to the on-disk alternates file; the new entry will also
1559 * take effect in the current process.
1560 */
1561extern void add_to_alternates_file(const char *dir);
1562
1563/*
1564 * Add the directory to the in-memory list of alternates (along with any
1565 * recursive alternates it points to), but do not modify the on-disk alternates
1566 * file.
1567 */
1568extern void add_to_alternates_memory(const char *dir);
1569
38dbe5f0
JK
1570/*
1571 * Returns a scratch strbuf pre-filled with the alternate object directory,
1572 * including a trailing slash, which can be used to access paths in the
1573 * alternate. Always use this over direct access to alt->scratch, as it
1574 * cleans up any previous use of the scratch buffer.
1575 */
1576extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
1577
c41ee586
SP
1578struct pack_window {
1579 struct pack_window *next;
1580 unsigned char *base;
1581 off_t offset;
1582 size_t len;
1583 unsigned int last_used;
1584 unsigned int inuse_cnt;
1585};
1586
9a217f2a
JH
1587extern struct packed_git {
1588 struct packed_git *next;
c41ee586 1589 struct pack_window *windows;
2dc3a234 1590 off_t pack_size;
57059091
NP
1591 const void *index_data;
1592 size_t index_size;
1593 uint32_t num_objects;
8eca0b47
NP
1594 uint32_t num_bad_objects;
1595 unsigned char *bad_object_sha1;
42873078 1596 int index_version;
57059091 1597 time_t mtime;
9bc879c1 1598 int pack_fd;
8d25931d 1599 unsigned pack_local:1,
d131b7af 1600 pack_keep:1,
ee1c6c34 1601 freshened:1,
d131b7af 1602 do_not_close:1;
bf592c50 1603 unsigned char sha1[20];
9d98bbf5 1604 struct revindex_entry *revindex;
8f1d2e6f
JH
1605 /* something like ".git/objects/pack/xxxxx.pack" */
1606 char pack_name[FLEX_ARRAY]; /* more */
9a217f2a 1607} *packed_git;
f3bf9224 1608
a73cdd21
JK
1609/*
1610 * A most-recently-used ordered version of the packed_git list, which can
1611 * be iterated instead of packed_git (and marked via mru_mark).
1612 */
1613struct mru;
1614extern struct mru *packed_git_mru;
1615
f3bf9224 1616struct pack_entry {
c4001d92 1617 off_t offset;
f3bf9224
JH
1618 unsigned char sha1[20];
1619 struct packed_git *p;
1620};
1621
7b64469a 1622extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
bf592c50 1623
0a489b06
JH
1624/* A hook to report invalid files in pack directory */
1625#define PACKDIR_FILE_PACK 1
1626#define PACKDIR_FILE_IDX 2
1627#define PACKDIR_FILE_GARBAGE 4
1628extern void (*report_garbage)(unsigned seen_bits, const char *path);
543c5caa 1629
9a217f2a 1630extern void prepare_packed_git(void);
fc04c412 1631extern void reprepare_packed_git(void);
bf592c50
DB
1632extern void install_packed_git(struct packed_git *pack);
1633
8e3f52d7
JK
1634/*
1635 * Give a rough count of objects in the repository. This sacrifices accuracy
1636 * for speed.
1637 */
1638unsigned long approximate_object_count(void);
1639
a6080a0a 1640extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
bf592c50
DB
1641 struct packed_git *packs);
1642
276bc2ca 1643extern void pack_report(void);
d40d535b 1644
82c9d661 1645/*
892e723a
JK
1646 * Create a temporary file rooted in the object database directory, or
1647 * die on failure. The filename is taken from "pattern", which should have the
1648 * usual "XXXXXX" trailer, and the resulting filename is written into the
1649 * "template" buffer. Returns the open descriptor.
82c9d661 1650 */
594fa999 1651extern int odb_mkstemp(struct strbuf *template, const char *pattern);
82c9d661 1652
1cec8c63
JK
1653/*
1654 * Generate the filename to be used for a pack file with checksum "sha1" and
1655 * extension "ext". The result is written into the strbuf "buf", overwriting
1656 * any existing contents. A pointer to buf->buf is returned as a convenience.
1657 *
1658 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"
1659 */
1660extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);
1661
82c9d661 1662/*
eaeefc32
JK
1663 * Create a pack .keep file named "name" (which should generally be the output
1664 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1665 * error.
82c9d661 1666 */
eaeefc32 1667extern int odb_pack_keep(const char *name);
82c9d661 1668
d40d535b
MH
1669/*
1670 * mmap the index file for the specified packfile (if it is not
1671 * already mmapped). Return 0 on success.
1672 */
d079837e 1673extern int open_pack_index(struct packed_git *);
d40d535b
MH
1674
1675/*
1676 * munmap the index file for the specified packfile (if it is
1677 * currently mmapped).
1678 */
fa5fc15d 1679extern void close_pack_index(struct packed_git *);
d40d535b 1680
ef49a7a0 1681extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
c9ced051 1682extern void close_pack_windows(struct packed_git *);
38849a81 1683extern void close_all_packs(void);
03e79c88 1684extern void unuse_pack(struct pack_window **);
3d20c636 1685extern void clear_delta_base_cache(void);
48bcc1c3 1686extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
d40d535b 1687
47fe3f6e
JK
1688/*
1689 * Make sure that a pointer access into an mmap'd index file is within bounds,
1690 * and can provide at least 8 bytes of data.
1691 *
1692 * Note that this is only necessary for variable-length segments of the file
1693 * (like the 64-bit extended offset table), as we compare the size to the
1694 * fixed-length parts when we open the file.
1695 */
1696extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
1697
d40d535b
MH
1698/*
1699 * Return the SHA-1 of the nth object within the specified packfile.
1700 * Open the index if it is not already open. The return value points
1701 * at the SHA-1 within the mmapped index. Return NULL if there is an
1702 * error.
1703 */
1704extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
068f85e3 1705/*
1706 * Like nth_packed_object_sha1, but write the data into the object specified by
1707 * the the first argument. Returns the first argument on success, and NULL on
1708 * error.
1709 */
1710extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
d40d535b
MH
1711
1712/*
1713 * Return the offset of the nth object within the specified packfile.
1714 * The index must already be opened.
1715 */
1716extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1717
1718/*
1719 * If the object named sha1 is present in the specified packfile,
1720 * return its offset within the packfile; otherwise, return 0.
1721 */
1722extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1723
4c080182 1724extern int is_pack_valid(struct packed_git *);
c4001d92 1725extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
09ded04b 1726extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
54dab52a 1727extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
f8c8abc5 1728extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
9a217f2a 1729
27e1e22d
JK
1730/*
1731 * Iterate over the files in the loose-object parts of the object
1732 * directory "path", triggering the following callbacks:
1733 *
1734 * - loose_object is called for each loose object we find.
1735 *
1736 * - loose_cruft is called for any files that do not appear to be
1737 * loose objects. Note that we only look in the loose object
1738 * directories "objects/[0-9a-f]{2}/", so we will not report
1739 * "objects/foobar" as cruft.
1740 *
1741 * - loose_subdir is called for each top-level hashed subdirectory
1742 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1743 * after the objects in the directory are processed.
1744 *
1745 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1746 * will end the iteration.
e6f875e0
JK
1747 *
1748 * In the "buf" variant, "path" is a strbuf which will also be used as a
1749 * scratch buffer, but restored to its original contents before
1750 * the function returns.
27e1e22d 1751 */
76c1d9a0 1752typedef int each_loose_object_fn(const struct object_id *oid,
27e1e22d
JK
1753 const char *path,
1754 void *data);
1755typedef int each_loose_cruft_fn(const char *basename,
1756 const char *path,
1757 void *data);
1758typedef int each_loose_subdir_fn(int nr,
1759 const char *path,
1760 void *data);
1761int for_each_loose_file_in_objdir(const char *path,
1762 each_loose_object_fn obj_cb,
1763 each_loose_cruft_fn cruft_cb,
1764 each_loose_subdir_fn subdir_cb,
1765 void *data);
e6f875e0
JK
1766int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1767 each_loose_object_fn obj_cb,
1768 each_loose_cruft_fn cruft_cb,
1769 each_loose_subdir_fn subdir_cb,
1770 void *data);
27e1e22d 1771
660c889e
JK
1772/*
1773 * Iterate over loose and packed objects in both the local
1385bb7b
JK
1774 * repository and any alternates repositories (unless the
1775 * LOCAL_ONLY flag is set).
660c889e 1776 */
1385bb7b 1777#define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
76c1d9a0 1778typedef int each_packed_object_fn(const struct object_id *oid,
660c889e
JK
1779 struct packed_git *pack,
1780 uint32_t pos,
1781 void *data);
1385bb7b
JK
1782extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1783extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
660c889e 1784
9a490590
JH
1785struct object_info {
1786 /* Request */
5b086407 1787 enum object_type *typep;
9a490590 1788 unsigned long *sizep;
166df26f 1789 off_t *disk_sizep;
5d642e75 1790 unsigned char *delta_base_sha1;
46f03448 1791 struct strbuf *typename;
9a490590
JH
1792
1793 /* Response */
1794 enum {
1795 OI_CACHED,
1796 OI_LOOSE,
5266d369
JH
1797 OI_PACKED,
1798 OI_DBCACHED
9a490590
JH
1799 } whence;
1800 union {
1801 /*
1802 * struct {
1803 * ... Nothing to expose in this case
1804 * } cached;
1805 * struct {
1806 * ... Nothing to expose in this case
1807 * } loose;
1808 */
1809 struct {
1810 struct packed_git *pack;
1811 off_t offset;
1812 unsigned int is_delta;
1813 } packed;
1814 } u;
1815};
27b5c1a0
JK
1816
1817/*
1818 * Initializer for a "struct object_info" that wants no items. You may
1819 * also memset() the memory to all-zeroes.
1820 */
1821#define OBJECT_INFO_INIT {NULL}
1822
de7b5d62 1823extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
ca79c985 1824extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
9a217f2a 1825
8f3f9b09
JH
1826/* Dumb servers support */
1827extern int update_server_info(int);
1828
a6fa5992
PN
1829extern const char *get_log_output_encoding(void);
1830extern const char *get_commit_output_encoding(void);
1831
dae6c322
CC
1832/*
1833 * This is a hack for test programs like test-dump-untracked-cache to
1834 * ensure that they do not modify the untracked cache when reading it.
1835 * Do not use it otherwise!
1836 */
1837extern int ignore_untracked_cache_config;
3c8687a7 1838
d6991cee
JK
1839extern int committer_ident_sufficiently_given(void);
1840extern int author_ident_sufficiently_given(void);
e1b10391 1841
1a8f2741 1842extern const char *git_commit_encoding;
3a55602e 1843extern const char *git_log_output_encoding;
d551a488 1844extern const char *git_mailmap_file;
08610900 1845extern const char *git_mailmap_blob;
4e72dcec 1846
06f59e9f
TT
1847/* IO helper functions */
1848extern void maybe_flush_or_die(FILE *, const char *);
9540ce50
JK
1849__attribute__((format (printf, 2, 3)))
1850extern void fprintf_or_die(FILE *, const char *fmt, ...);
00b7cbfc
JH
1851
1852#define COPY_READ_ERROR (-2)
1853#define COPY_WRITE_ERROR (-3)
f3123c4a 1854extern int copy_fd(int ifd, int ofd);
1468bd47 1855extern int copy_file(const char *dst, const char *src, int mode);
f7835a25 1856extern int copy_file_with_time(const char *dst, const char *src, int mode);
00b7cbfc 1857
7230e6d0 1858extern void write_or_die(int fd, const void *buf, size_t count);
4c81b03e 1859extern void fsync_or_die(int fd, const char *);
ad897215 1860
2b7ca830
JM
1861extern ssize_t read_in_full(int fd, void *buf, size_t count);
1862extern ssize_t write_in_full(int fd, const void *buf, size_t count);
426ddeea
YM
1863extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1864
2b7ca830
JM
1865static inline ssize_t write_str_in_full(int fd, const char *str)
1866{
1867 return write_in_full(fd, str, strlen(str));
1868}
12d6ce1d 1869
52563d7e
JK
1870/**
1871 * Open (and truncate) the file at path, write the contents of buf to it,
1872 * and close it. Dies if any errors are encountered.
1873 */
1874extern void write_file_buf(const char *path, const char *buf, size_t len);
1875
e04d08a4
JK
1876/**
1877 * Like write_file_buf(), but format the contents into a buffer first.
1878 * Additionally, write_file() will append a newline if one is not already
1879 * present, making it convenient to write text files:
1880 *
1881 * write_file(path, "counter: %d", ctr);
1882 */
1883__attribute__((format (printf, 2, 3)))
ef22318c 1884extern void write_file(const char *path, const char *fmt, ...);
2b7ca830 1885
f67b45f8
LT
1886/* pager.c */
1887extern void setup_pager(void);
6e9af863 1888extern int pager_in_use(void);
aa086eb8 1889extern int pager_use_color;
ad6c3739 1890extern int term_columns(void);
d306f3d3 1891extern int decimal_width(uintmax_t);
4914c962 1892extern int check_pager_config(const char *cmd);
3e3a4a41 1893extern void prepare_pager_args(struct child_process *, const char *pager);
f67b45f8 1894
ee9601e6 1895extern const char *editor_program;
d3e7da89 1896extern const char *askpass_program;
dfb068be 1897extern const char *excludes_file;
4d87b9c5 1898
051308f6 1899/* base85 */
f9815772
JM
1900int decode_85(char *dst, const char *line, int linelen);
1901void encode_85(char *buf, const unsigned char *data, int bytes);
051308f6 1902
855419f7 1903/* alloc.c */
100c5f3b
LT
1904extern void *alloc_blob_node(void);
1905extern void *alloc_tree_node(void);
1906extern void *alloc_commit_node(void);
1907extern void *alloc_tag_node(void);
1908extern void *alloc_object_node(void);
855419f7 1909extern void alloc_report(void);
94d5a22c 1910extern unsigned int alloc_commit_index(void);
855419f7 1911
5991a55c 1912/* pkt-line.c */
bbc30f99 1913void packet_trace_identity(const char *prog);
6ce4e61f 1914
b6ec1d61 1915/* add */
7ae02a30
AR
1916/*
1917 * return 0 if success, 1 - if addition of a file failed and
1918 * ADD_FILES_IGNORE_ERRORS was specified in flags
1919 */
610d55af 1920int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
b6ec1d61 1921
aecbf914
JH
1922/* diff.c */
1923extern int diff_auto_refresh_index;
1924
68faf689 1925/* match-trees.c */
82db3d44 1926void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
1927void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
68faf689 1928
a9cc857a
JH
1929/*
1930 * whitespace rules.
1931 * used by both diff and apply
f4b05a49 1932 * last two digits are tab width
a9cc857a 1933 */
f4b05a49
JS
1934#define WS_BLANK_AT_EOL 0100
1935#define WS_SPACE_BEFORE_TAB 0200
1936#define WS_INDENT_WITH_NON_TAB 0400
1937#define WS_CR_AT_EOL 01000
1938#define WS_BLANK_AT_EOF 02000
1939#define WS_TAB_IN_INDENT 04000
aeb84b05 1940#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
f4b05a49
JS
1941#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1942#define WS_TAB_WIDTH_MASK 077
cf1b7869
JH
1943extern unsigned whitespace_rule_cfg;
1944extern unsigned whitespace_rule(const char *);
1945extern unsigned parse_whitespace_rule(const char *);
8f8841e9
JH
1946extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1947extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
c1795bb0 1948extern char *whitespace_error_string(unsigned ws);
d511bd33 1949extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
877f23cc 1950extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
f4b05a49 1951#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
a9cc857a 1952
ee425e46 1953/* ls-files */
312c984a
BW
1954void overlay_tree_on_index(struct index_state *istate,
1955 const char *tree_name, const char *prefix);
ee425e46 1956
94351118 1957char *alias_lookup(const char *alias);
0989fe96 1958int split_cmdline(char *cmdline, const char ***argv);
ad9ac6db
GB
1959/* Takes a negative value returned by split_cmdline */
1960const char *split_cmdline_strerror(int cmdline_errno);
94351118 1961
46c3cd44 1962/* setup.c */
e37c1329 1963struct startup_info {
a60645f9 1964 int have_repository;
f07d6a1a 1965 const char *prefix;
e37c1329
NTND
1966};
1967extern struct startup_info *startup_info;
1968
db699a8a
NTND
1969/* merge.c */
1970struct commit_list;
1971int try_merge_command(const char *strategy, size_t xopts_nr,
1972 const char **xopts, struct commit_list *common,
1973 const char *head_arg, struct commit_list *remotes);
f06e90da 1974int checkout_fast_forward(const struct object_id *from,
1975 const struct object_id *to,
db699a8a
NTND
1976 int overwrite_ignore);
1977
cac42b26 1978
38f865c2
JK
1979int sane_execvp(const char *file, char *const argv[]);
1980
38612532
MH
1981/*
1982 * A struct to encapsulate the concept of whether a file has changed
1983 * since we last checked it. This uses criteria similar to those used
1984 * for the index.
1985 */
1986struct stat_validity {
1987 struct stat_data *sd;
1988};
1989
1990void stat_validity_clear(struct stat_validity *sv);
1991
1992/*
1993 * Returns 1 if the path is a regular file (or a symlink to a regular
1994 * file) and matches the saved stat_validity, 0 otherwise. A missing
1995 * or inaccessible file is considered a match if the struct was just
1996 * initialized, or if the previous update found an inaccessible file.
1997 */
1998int stat_validity_check(struct stat_validity *sv, const char *path);
1999
2000/*
2001 * Update the stat_validity from a file opened at descriptor fd. If
2002 * the file is missing, inaccessible, or not a regular file, then
2003 * future calls to stat_validity_check will match iff one of those
2004 * conditions continues to be true.
2005 */
2006void stat_validity_update(struct stat_validity *sv, int fd);
2007
9ef176b5 2008int versioncmp(const char *s1, const char *s2);
2024d317 2009void sleep_millisec(int millisec);
9ef176b5 2010
eb33876c
DT
2011/*
2012 * Create a directory and (if share is nonzero) adjust its permissions
2013 * according to the shared_repository setting. Only use this for
2014 * directories under $GIT_DIR. Don't use it for working tree
2015 * directories.
2016 */
2017void safe_create_dir(const char *dir, int share);
2018
e83c5163 2019#endif /* CACHE_H */