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