refs: introduce a "ref paranoia" flag
[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"
e83c5163 12
cef661fc 13#include SHA1_HEADER
9126f009
NP
14#ifndef git_SHA_CTX
15#define git_SHA_CTX SHA_CTX
16#define git_SHA1_Init SHA1_Init
17#define git_SHA1_Update SHA1_Update
18#define git_SHA1_Final SHA1_Final
19#endif
e83c5163 20
9126f009 21#include <zlib.h>
ef49a7a0
JH
22typedef struct git_zstream {
23 z_stream z;
24 unsigned long avail_in;
25 unsigned long avail_out;
26 unsigned long total_in;
27 unsigned long total_out;
28 unsigned char *next_in;
29 unsigned char *next_out;
30} git_zstream;
31
32void git_inflate_init(git_zstream *);
33void git_inflate_init_gzip_only(git_zstream *);
34void git_inflate_end(git_zstream *);
35int git_inflate(git_zstream *, int flush);
36
37void git_deflate_init(git_zstream *, int level);
38void git_deflate_init_gzip(git_zstream *, int level);
c3c2e1a0 39void git_deflate_init_raw(git_zstream *, int level);
ef49a7a0 40void git_deflate_end(git_zstream *);
568508e7 41int git_deflate_abort(git_zstream *);
ef49a7a0
JH
42int git_deflate_end_gently(git_zstream *);
43int git_deflate(git_zstream *, int flush);
44unsigned long git_deflate_bound(git_zstream *, unsigned long);
39c68542 45
962554c6 46#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
b6829693
ET
47#define DTYPE(de) ((de)->d_type)
48#else
0bdd79af
JH
49#undef DT_UNKNOWN
50#undef DT_DIR
51#undef DT_REG
52#undef DT_LNK
b6829693
ET
53#define DT_UNKNOWN 0
54#define DT_DIR 1
55#define DT_REG 2
a15c1c60 56#define DT_LNK 3
b6829693
ET
57#define DTYPE(de) DT_UNKNOWN
58#endif
59
40689ae1
MK
60/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
61#define S_IFINVALID 0030000
62
9eec4795
LT
63/*
64 * A "directory link" is a link to another git directory.
65 *
66 * The value 0160000 is not normally a valid mode, and
67 * also just happens to be S_IFDIR + S_IFLNK
9eec4795 68 */
302b9282
MW
69#define S_IFGITLINK 0160000
70#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
9eec4795 71
72441af7
KS
72/*
73 * Some mode bits are also used internally for computations.
74 *
75 * They *must* not overlap with any valid modes, and they *must* not be emitted
76 * to outside world - i.e. appear on disk or network. In other words, it's just
77 * temporary fields, which we internally use, but they have to stay in-house.
78 *
79 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
80 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
81 */
82
83/* used internally in tree-diff */
84#define S_DIFFTREE_IFXMIN_NEQ 0x80000000
85
86
2386d658
LT
87/*
88 * Intensive research over the course of many years has shown that
89 * port 9418 is totally unused by anything else. Or
90 *
91 * Your search - "port 9418" - did not match any documents.
92 *
93 * as www.google.com puts it.
ba8a4970
LT
94 *
95 * This port has been properly assigned for git use by IANA:
96 * git (Assigned-9418) [I06-050728-0001].
97 *
98 * git 9418/tcp git pack transfer service
99 * git 9418/udp git pack transfer service
100 *
101 * with Linus Torvalds <torvalds@osdl.org> as the point of
102 * contact. September 2005.
103 *
104 * See http://www.iana.org/assignments/port-numbers
2386d658
LT
105 */
106#define DEFAULT_GIT_PORT 9418
107
e83c5163
LT
108/*
109 * Basic data structures for the directory cache
e83c5163
LT
110 */
111
112#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
113struct cache_header {
7800c1eb
TG
114 uint32_t hdr_signature;
115 uint32_t hdr_version;
116 uint32_t hdr_entries;
e83c5163
LT
117};
118
9d227781
JH
119#define INDEX_FORMAT_LB 2
120#define INDEX_FORMAT_UB 4
121
e83c5163
LT
122/*
123 * The "cache_time" is just the low 32 bits of the
124 * time. It doesn't matter if it overflows - we only
125 * check it for equality in the 32 bits we save.
126 */
127struct cache_time {
7800c1eb
TG
128 uint32_t sec;
129 uint32_t nsec;
e83c5163
LT
130};
131
c21d39d7
MH
132struct stat_data {
133 struct cache_time sd_ctime;
134 struct cache_time sd_mtime;
135 unsigned int sd_dev;
136 unsigned int sd_ino;
137 unsigned int sd_uid;
138 unsigned int sd_gid;
139 unsigned int sd_size;
140};
141
e83c5163 142struct cache_entry {
8b013788 143 struct hashmap_entry ent;
c21d39d7 144 struct stat_data ce_stat_data;
ccc4feb5 145 unsigned int ce_mode;
7a51ed66 146 unsigned int ce_flags;
b60e188c 147 unsigned int ce_namelen;
5fc2fc8f 148 unsigned int index; /* for link extension */
e83c5163 149 unsigned char sha1[20];
8f1d2e6f 150 char name[FLEX_ARRAY]; /* more */
e83c5163
LT
151};
152
95fd5bf8 153#define CE_STAGEMASK (0x3000)
16ce2e4c 154#define CE_EXTENDED (0x4000)
5f73076c 155#define CE_VALID (0x8000)
aee46198 156#define CE_STAGESHIFT 12
95fd5bf8 157
06aaaa0b 158/*
ce51bf09 159 * Range 0xFFFF0FFF in ce_flags is divided into
06aaaa0b
NTND
160 * two parts: in-memory flags and on-disk ones.
161 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
162 * if you want to save a new flag, add it in
163 * CE_EXTENDED_FLAGS
164 *
165 * In-memory only flags
166 */
2977ffbb
NTND
167#define CE_UPDATE (1 << 16)
168#define CE_REMOVE (1 << 17)
169#define CE_UPTODATE (1 << 18)
170#define CE_ADDED (1 << 19)
a22c6371 171
2977ffbb 172#define CE_HASHED (1 << 20)
2977ffbb
NTND
173#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
174#define CE_CONFLICTED (1 << 23)
7a51ed66 175
2977ffbb 176#define CE_UNPACKED (1 << 24)
2431afbf 177#define CE_NEW_SKIP_WORKTREE (1 << 25)
da165f47 178
e721c154
NTND
179/* used to temporarily mark paths matched by pathspecs */
180#define CE_MATCHED (1 << 26)
181
078a58e8 182#define CE_UPDATE_IN_BASE (1 << 27)
b3c96fb1 183#define CE_STRIP_NAME (1 << 28)
078a58e8 184
06aaaa0b
NTND
185/*
186 * Extended on-disk flags
187 */
2977ffbb
NTND
188#define CE_INTENT_TO_ADD (1 << 29)
189#define CE_SKIP_WORKTREE (1 << 30)
06aaaa0b 190/* CE_EXTENDED2 is for future extension */
2977ffbb 191#define CE_EXTENDED2 (1 << 31)
06aaaa0b 192
44a36913 193#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
06aaaa0b
NTND
194
195/*
196 * Safeguard to avoid saving wrong flags:
197 * - CE_EXTENDED2 won't get saved until its semantic is known
198 * - Bits in 0x0000FFFF have been saved in ce_flags already
199 * - Bits in 0x003F0000 are currently in-memory flags
200 */
201#if CE_EXTENDED_FLAGS & 0x803FFFFF
202#error "CE_EXTENDED_FLAGS out of range"
203#endif
204
64acde94
NTND
205struct pathspec;
206
eb7a2f1d
LT
207/*
208 * Copy the sha1 and stat state of a cache entry from one to
209 * another. But we never change the name, or the hash state!
210 */
20d142b4
RS
211static inline void copy_cache_entry(struct cache_entry *dst,
212 const struct cache_entry *src)
eb7a2f1d 213{
419a597f 214 unsigned int state = dst->ce_flags & CE_HASHED;
eb7a2f1d
LT
215
216 /* Don't copy hash chain and name */
8b013788
KB
217 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
218 offsetof(struct cache_entry, name) -
219 offsetof(struct cache_entry, ce_stat_data));
eb7a2f1d
LT
220
221 /* Restore the hash state */
419a597f 222 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
eb7a2f1d
LT
223}
224
b60e188c 225static inline unsigned create_ce_flags(unsigned stage)
7fec10b7 226{
b60e188c 227 return (stage << CE_STAGESHIFT);
7fec10b7
JH
228}
229
b60e188c 230#define ce_namelen(ce) ((ce)->ce_namelen)
aee46198 231#define ce_size(ce) cache_entry_size(ce_namelen(ce))
7a51ed66 232#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
eadb5831 233#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
44a36913 234#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
eadb5831 235#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
aee46198 236
e4479470 237#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
238static inline unsigned int create_ce_mode(unsigned int mode)
239{
8ae0a8c5 240 if (S_ISLNK(mode))
7a51ed66 241 return S_IFLNK;
302b9282 242 if (S_ISDIR(mode) || S_ISGITLINK(mode))
7a51ed66
LT
243 return S_IFGITLINK;
244 return S_IFREG | ce_permissions(mode);
8ae0a8c5 245}
20d142b4
RS
246static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
247 unsigned int mode)
185c975f 248{
78a8d641
JS
249 extern int trust_executable_bit, has_symlinks;
250 if (!has_symlinks && S_ISREG(mode) &&
7a51ed66 251 ce && S_ISLNK(ce->ce_mode))
78a8d641 252 return ce->ce_mode;
185c975f 253 if (!trust_executable_bit && S_ISREG(mode)) {
7a51ed66 254 if (ce && S_ISREG(ce->ce_mode))
185c975f
JH
255 return ce->ce_mode;
256 return create_ce_mode(0666);
257 }
258 return create_ce_mode(mode);
259}
d6b8fc30
JH
260static inline int ce_to_dtype(const struct cache_entry *ce)
261{
262 unsigned ce_mode = ntohl(ce->ce_mode);
263 if (S_ISREG(ce_mode))
264 return DT_REG;
265 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
266 return DT_DIR;
267 else if (S_ISLNK(ce_mode))
268 return DT_LNK;
269 else
270 return DT_UNKNOWN;
271}
b90d9b88
RS
272static inline unsigned int canon_mode(unsigned int mode)
273{
274 if (S_ISREG(mode))
275 return S_IFREG | ce_permissions(mode);
276 if (S_ISLNK(mode))
277 return S_IFLNK;
278 if (S_ISDIR(mode))
279 return S_IFDIR;
280 return S_IFGITLINK;
281}
e4479470 282
ee7825b5 283#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
f5cabd13 284
e636a7b4
NTND
285#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
286#define CE_ENTRY_CHANGED (1 << 1)
287#define CE_ENTRY_REMOVED (1 << 2)
288#define CE_ENTRY_ADDED (1 << 3)
6c306a34 289#define RESOLVE_UNDO_CHANGED (1 << 4)
a5400efe 290#define CACHE_TREE_CHANGED (1 << 5)
c18b80a0 291#define SPLIT_INDEX_ORDERED (1 << 6)
e636a7b4 292
5fc2fc8f 293struct split_index;
228e94f9
JH
294struct index_state {
295 struct cache_entry **cache;
9d227781 296 unsigned int version;
228e94f9 297 unsigned int cache_nr, cache_alloc, cache_changed;
cfc5789a 298 struct string_list *resolve_undo;
228e94f9 299 struct cache_tree *cache_tree;
5fc2fc8f 300 struct split_index *split_index;
fba2f38a 301 struct cache_time timestamp;
913e0e99
JH
302 unsigned name_hash_initialized : 1,
303 initialized : 1;
8b013788 304 struct hashmap name_hash;
e05881a4 305 struct hashmap dir_hash;
426ddeea 306 unsigned char sha1[20];
228e94f9
JH
307};
308
309extern struct index_state the_index;
310
96872bc2
LT
311/* Name hashing */
312extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
2092678c
KB
313extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
314extern void free_name_hash(struct index_state *istate);
96872bc2
LT
315
316
4aab5b46 317#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
228e94f9
JH
318#define active_cache (the_index.cache)
319#define active_nr (the_index.cache_nr)
320#define active_alloc (the_index.cache_alloc)
321#define active_cache_changed (the_index.cache_changed)
322#define active_cache_tree (the_index.cache_tree)
e83c5163 323
4aab5b46
JH
324#define read_cache() read_index(&the_index)
325#define read_cache_from(path) read_index_from(&the_index, (path))
671c9b7e 326#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
fa7b3c2f 327#define is_cache_unborn() is_index_unborn(&the_index)
e46bbcf6 328#define read_cache_unmerged() read_index_unmerged(&the_index)
4aab5b46 329#define discard_cache() discard_index(&the_index)
94a5728c 330#define unmerged_cache() unmerged_index(&the_index)
4aab5b46
JH
331#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
332#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
81dc2307 333#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
4aab5b46
JH
334#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
335#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
38ed1d89
JH
336#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
337#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
3deffc52 338#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
4bd5b7da
JH
339#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
340#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
db5360f3
ES
341#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
342#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
98fa4738 343#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
cfc5789a 344#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
8aa38563 345#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
4421a823 346#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
ff366825 347#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
4aab5b46 348#endif
e83c5163 349
edaec3fb
JH
350enum object_type {
351 OBJ_BAD = -1,
352 OBJ_NONE = 0,
353 OBJ_COMMIT = 1,
354 OBJ_TREE = 2,
355 OBJ_BLOB = 3,
356 OBJ_TAG = 4,
357 /* 5 for future expansion */
358 OBJ_OFS_DELTA = 6,
359 OBJ_REF_DELTA = 7,
355885d5 360 OBJ_ANY,
4b05548f 361 OBJ_MAX
edaec3fb
JH
362};
363
b45563a2
JH
364static inline enum object_type object_type(unsigned int mode)
365{
366 return S_ISDIR(mode) ? OBJ_TREE :
367 S_ISGITLINK(mode) ? OBJ_COMMIT :
368 OBJ_BLOB;
369}
370
2163e5db 371/* Double-check local_repo_env below if you add to this list. */
8ac069ac 372#define GIT_DIR_ENVIRONMENT "GIT_DIR"
a1bea2c1 373#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
892c41b9 374#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
a6f7f9a3 375#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
8ac069ac 376#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 377#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 378#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 379#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
069c0532 380#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
d4ebc36c
JH
381#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
382#define CONFIG_ENVIRONMENT "GIT_CONFIG"
2b64fc89 383#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
d4ebc36c 384#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
0454dd93 385#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
6476b38b 386#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
d0bfd026
JH
387#define GITATTRIBUTES_FILE ".gitattributes"
388#define INFOATTRIBUTES_FILE "info/attributes"
f48fd688 389#define ATTRIBUTE_MACRO_PREFIX "[attr]"
a97a7468
JS
390#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
391#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
894a9d33 392#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
6956f858
TR
393#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
394#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
823ab40f 395#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
bd30c2e4
NTND
396#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
397#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
93d93537 398#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
bb233d69 399
48a7c1c4 400/*
2cd83d10
JK
401 * This environment variable is expected to contain a boolean indicating
402 * whether we should or should not treat:
403 *
404 * GIT_DIR=foo.git git ...
405 *
406 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
407 * of this, but we use it internally to communicate to sub-processes that we
408 * are in a bare repo. If not set, defaults to true.
409 */
410#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
411
48a7c1c4 412/*
2163e5db
JK
413 * Repository-local GIT_* environment variables; these will be cleared
414 * when git spawns a sub-process that runs inside another repository.
415 * The array is NULL-terminated, which makes it easy to pass in the "env"
416 * parameter of a run-command invocation, or to do a simple walk.
48a7c1c4 417 */
2163e5db 418extern const char * const local_repo_env[];
48a7c1c4 419
7d1864ce
JH
420extern int is_bare_repository_cfg;
421extern int is_bare_repository(void);
68025633 422extern int is_inside_git_dir(void);
e90fdc39 423extern char *git_work_tree_cfg;
892c41b9 424extern int is_inside_work_tree(void);
c5fba16c 425extern const char *get_git_dir(void);
b3256eb8 426extern int is_git_directory(const char *path);
8ac069ac
JH
427extern char *get_object_directory(void);
428extern char *get_index_file(void);
5da5c8f4 429extern char *get_graft_file(void);
d7ac12b2 430extern int set_git_dir(const char *path);
a1bea2c1
JT
431extern const char *get_git_namespace(void);
432extern const char *strip_namespace(const char *namespaced_ref);
e90fdc39 433extern const char *get_git_work_tree(void);
13d6ec91 434extern const char *read_gitfile(const char *path);
abc06822 435extern const char *resolve_gitdir(const char *suspect);
19757d80 436extern void set_git_work_tree(const char *tree);
8ac069ac
JH
437
438#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 439
6b5ee137 440extern const char **get_pathspec(const char *prefix, const char **pathspec);
59f0f2f3 441extern void setup_work_tree(void);
4ca06608 442extern const char *setup_git_directory_gently(int *);
d288a700 443extern const char *setup_git_directory(void);
edc54fb5 444extern char *prefix_path(const char *prefix, int len, const char *path);
645a29c4 445extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
4ca06608 446extern const char *prefix_filename(const char *prefix, int len, const char *path);
c6e8c800 447extern int check_filename(const char *prefix, const char *name);
023e37c3
MM
448extern void verify_filename(const char *prefix,
449 const char *name,
450 int diagnose_misspelt_rev);
ea92f41f 451extern void verify_non_filename(const char *prefix, const char *name);
546e0fd9 452extern int path_inside_repo(const char *prefix, const char *path);
d288a700 453
f225aeb2
DB
454#define INIT_DB_QUIET 0x0001
455
b57fb80a 456extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
f225aeb2
DB
457extern int init_db(const char *template_dir, unsigned int flags);
458
1d999ddd 459extern void sanitize_stdfds(void);
de0957ce 460extern int daemonize(void);
1d999ddd 461
e83c5163
LT
462#define alloc_nr(x) (((x)+16)*3/2)
463
6815e569
JK
464/*
465 * Realloc the buffer pointed at by variable 'x' so that it can hold
466 * at least 'nr' entries; the number of entries currently allocated
467 * is 'alloc', using the standard growing factor alloc_nr() macro.
468 *
01f6fd4b 469 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
6815e569
JK
470 */
471#define ALLOC_GROW(x, nr, alloc) \
472 do { \
c927e6c6 473 if ((nr) > alloc) { \
4234a761
JH
474 if (alloc_nr(alloc) < (nr)) \
475 alloc = (nr); \
476 else \
477 alloc = alloc_nr(alloc); \
2756ca43 478 REALLOC_ARRAY(x, alloc); \
6815e569 479 } \
98746061 480 } while (0)
6815e569 481
734aab75 482/* Initialize and use the cache information */
03b86647 483struct lock_file;
4aab5b46 484extern int read_index(struct index_state *);
5ab2a2da 485extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
3e52f70b
NTND
486extern int do_read_index(struct index_state *istate, const char *path,
487 int must_exist); /* for testting only! */
4aab5b46 488extern int read_index_from(struct index_state *, const char *path);
fa7b3c2f 489extern int is_index_unborn(struct index_state *);
e46bbcf6 490extern int read_index_unmerged(struct index_state *);
03b86647
NTND
491#define COMMIT_LOCK (1 << 0)
492#define CLOSE_LOCK (1 << 1)
493extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
4aab5b46 494extern int discard_index(struct index_state *);
d1f128b0 495extern int unmerged_index(const struct index_state *);
8dcf39c4 496extern int verify_path(const char *path);
db5360f3
ES
497extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen);
498extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
d1f128b0 499extern int index_name_pos(const struct index_state *, const char *name, int namelen);
192268c1
JH
500#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
501#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 502#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
af3785dc 503#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
39425819 504#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
ce7c614b 505#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
4aab5b46 506extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
81dc2307 507extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
4aab5b46 508extern int remove_index_entry_at(struct index_state *, int pos);
36419c8e 509extern void remove_marked_cache_entries(struct index_state *istate);
4aab5b46 510extern int remove_file_from_index(struct index_state *, const char *path);
38ed1d89
JH
511#define ADD_CACHE_VERBOSE 1
512#define ADD_CACHE_PRETEND 2
01665924 513#define ADD_CACHE_IGNORE_ERRORS 4
041aee31 514#define ADD_CACHE_IGNORE_REMOVAL 8
39425819 515#define ADD_CACHE_INTENT 16
38ed1d89
JH
516extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
517extern int add_file_to_index(struct index_state *, const char *path, int flags);
25762726 518extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
9c5e6c80 519extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
b4b313f9 520extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
98fa4738 521extern int index_name_is_other(const struct index_state *, const char *, int);
ff366825 522extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
4bd5b7da
JH
523
524/* do stat comparison even if CE_VALID is true */
525#define CE_MATCH_IGNORE_VALID 01
526/* do not check the contents but report dirty on racily-clean entries */
56cac48c
NTND
527#define CE_MATCH_RACY_IS_DIRTY 02
528/* do stat comparison even if CE_SKIP_WORKTREE is true */
529#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
2e2e7ec1
BK
530/* ignore non-existent files during stat update */
531#define CE_MATCH_IGNORE_MISSING 0x08
25762726
BK
532/* enable stat refresh */
533#define CE_MATCH_REFRESH 0x10
21a6b9fa
RS
534extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
535extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
4bd5b7da 536
c4ce46fc
JH
537#define HASH_WRITE_OBJECT 1
538#define HASH_FORMAT_CHECK 2
539extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
540extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
c21d39d7
MH
541
542/*
543 * Record to sd the data from st that we use to check whether a file
544 * might have changed.
545 */
546extern void fill_stat_data(struct stat_data *sd, struct stat *st);
547
548/*
549 * Return 0 if st is consistent with a file not having been changed
550 * since sd was filled. If there are differences, return a
551 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
552 * INODE_CHANGED, and DATA_CHANGED.
553 */
554extern int match_stat_data(const struct stat_data *sd, struct stat *st);
555
415e96c8
JH
556extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
557
405e5b2f
LT
558#define REFRESH_REALLY 0x0001 /* ignore_valid */
559#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
560#define REFRESH_QUIET 0x0004 /* be quiet about it */
561#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
3f1b7b60 562#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
43673fdd 563#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
9b2d6149 564extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
405e5b2f 565
ccdc4ec3 566extern void update_index_if_able(struct index_state *, struct lock_file *);
30ca07a2
JH
567
568extern int hold_locked_index(struct lock_file *, int);
5e7f56ac 569extern void set_alternate_index_output(const char *);
697cc8ef 570
eca35a25 571extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
734aab75 572
2ae1c53b 573/* Environment bits from configuration mechanism */
17712991 574extern int trust_executable_bit;
1ce4790b 575extern int trust_ctime;
c08e4d5b 576extern int check_stat;
9378c161 577extern int quote_path_fully;
78a8d641 578extern int has_symlinks;
dce96489 579extern int minimum_abbrev, default_abbrev;
0a9b88b7 580extern int ignore_case;
5f73076c 581extern int assume_unchanged;
9f0bb90d 582extern int prefer_symlink_refs;
6de08ae6 583extern int log_all_ref_updates;
2f8acdb3 584extern int warn_ambiguous_refs;
25fba78d 585extern int warn_on_object_refname_ambiguity;
457f06d6 586extern int shared_repository;
2ae1c53b 587extern const char *apply_default_whitespace;
86c91f91 588extern const char *apply_default_ignorewhitespace;
64589a03 589extern const char *git_attributes_file;
12f6c308 590extern int zlib_compression_level;
960ccca6
DH
591extern int core_compression_level;
592extern int core_compression_seen;
60bb8b14 593extern size_t packed_git_window_size;
77ccc5bb 594extern size_t packed_git_limit;
18bdec11 595extern size_t delta_base_cache_limit;
15366280 596extern unsigned long big_file_threshold;
568508e7 597extern unsigned long pack_size_limit_cfg;
afc711b8
MH
598
599/*
600 * Do replace refs need to be checked this run? This variable is
601 * initialized to true unless --no-replace-object is used or
602 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
603 * commands that do not want replace references to be active. As an
604 * optimization it is also set to false if replace references have
605 * been sought but there were none.
606 */
607extern int check_replace_refs;
608
aafe9fba 609extern int fsync_object_files;
671c9b7e 610extern int core_preload_index;
08aefc9e 611extern int core_apply_sparse_checkout;
76759c7d 612extern int precomposed_unicode;
a42643aa 613extern int protect_hfs;
2b4c6efc 614extern int protect_ntfs;
17712991 615
49672f26
JK
616/*
617 * Include broken refs in all ref iterations, which will
618 * generally choke dangerous operations rather than letting
619 * them silently proceed without taking the broken ref into
620 * account.
621 */
622extern int ref_paranoia;
623
eff80a9f
JH
624/*
625 * The character that begins a commented line in user-editable file
626 * that is subject to stripspace.
627 */
628extern char comment_line_char;
84c9dc2c 629extern int auto_comment_line_char;
eff80a9f 630
9ed36cfa 631enum branch_track {
9188ed89 632 BRANCH_TRACK_UNSPECIFIED = -1,
9ed36cfa
JS
633 BRANCH_TRACK_NEVER = 0,
634 BRANCH_TRACK_REMOTE,
635 BRANCH_TRACK_ALWAYS,
636 BRANCH_TRACK_EXPLICIT,
4b05548f 637 BRANCH_TRACK_OVERRIDE
9ed36cfa
JS
638};
639
c998ae9b
DS
640enum rebase_setup_type {
641 AUTOREBASE_NEVER = 0,
642 AUTOREBASE_LOCAL,
643 AUTOREBASE_REMOTE,
4b05548f 644 AUTOREBASE_ALWAYS
c998ae9b
DS
645};
646
52153747 647enum push_default_type {
52153747
FAG
648 PUSH_DEFAULT_NOTHING = 0,
649 PUSH_DEFAULT_MATCHING,
b55e6775 650 PUSH_DEFAULT_SIMPLE,
53c40311 651 PUSH_DEFAULT_UPSTREAM,
f25950f3
CT
652 PUSH_DEFAULT_CURRENT,
653 PUSH_DEFAULT_UNSPECIFIED
52153747
FAG
654};
655
9ed36cfa 656extern enum branch_track git_branch_track;
c998ae9b 657extern enum rebase_setup_type autorebase;
52153747 658extern enum push_default_type push_default;
9ed36cfa 659
348df166
JS
660enum object_creation_mode {
661 OBJECT_CREATION_USES_HARDLINKS = 0,
4b05548f 662 OBJECT_CREATION_USES_RENAMES = 1
348df166
JS
663};
664
665extern enum object_creation_mode object_creation_mode;
be66a6c4 666
a97a7468
JS
667extern char *notes_ref_name;
668
7f3140cd
JS
669extern int grafts_replace_parents;
670
ab9cb76f
JH
671#define GIT_REPO_VERSION 0
672extern int repository_format_version;
673extern int check_repository_format(void);
674
734aab75
LT
675#define MTIME_CHANGED 0x0001
676#define CTIME_CHANGED 0x0002
677#define OWNER_CHANGED 0x0004
678#define MODE_CHANGED 0x0008
679#define INODE_CHANGED 0x0010
680#define DATA_CHANGED 0x0020
8ae0a8c5 681#define TYPE_CHANGED 0x0040
e83c5163 682
108bebea
AR
683extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
684 __attribute__((format (printf, 3, 4)));
fe2d7776
AR
685extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
686 __attribute__((format (printf, 3, 4)));
aba13e7c
AR
687extern char *git_pathdup(const char *fmt, ...)
688 __attribute__((format (printf, 1, 2)));
21cf3227
HKNN
689extern char *mkpathdup(const char *fmt, ...)
690 __attribute__((format (printf, 1, 2)));
108bebea 691
e83c5163 692/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0
TS
693extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
694extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
0bad611b
HV
695extern char *git_path_submodule(const char *path, const char *fmt, ...)
696 __attribute__((format (printf, 2, 3)));
697
d40d535b
MH
698/*
699 * Return the name of the file in the local object database that would
700 * be used to store a loose object with the specified sha1. The
701 * return value is a pointer to a statically allocated buffer that is
702 * overwritten each time the function is called.
703 */
30d6c6ea 704extern const char *sha1_file_name(const unsigned char *sha1);
d40d535b
MH
705
706/*
707 * Return the name of the (local) packfile with the specified sha1 in
708 * its name. The return value is a pointer to memory that is
709 * overwritten each time this function is called.
710 */
bf592c50 711extern char *sha1_pack_name(const unsigned char *sha1);
d40d535b
MH
712
713/*
714 * Return the name of the (local) pack index file with the specified
715 * sha1 in its name. The return value is a pointer to memory that is
716 * overwritten each time this function is called.
717 */
bf592c50 718extern char *sha1_pack_index_name(const unsigned char *sha1);
d40d535b 719
013f276e 720extern const char *find_unique_abbrev(const unsigned char *sha1, int);
88cd621d 721extern const unsigned char null_sha1[20];
1a812f3a
IM
722
723static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
0bef57ee 724{
1a812f3a
IM
725 int i;
726
727 for (i = 0; i < 20; i++, sha1++, sha2++) {
728 if (*sha1 != *sha2)
729 return *sha1 - *sha2;
730 }
731
732 return 0;
0bef57ee 733}
1a812f3a
IM
734
735static inline int is_null_sha1(const unsigned char *sha1)
a89fccd2 736{
1a812f3a 737 return !hashcmp(sha1, null_sha1);
a89fccd2 738}
1a812f3a 739
e702496e
SP
740static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
741{
742 memcpy(sha_dst, sha_src, 20);
743}
a8e0d16d
JH
744static inline void hashclr(unsigned char *hash)
745{
746 memset(hash, 0, 20);
747}
e83c5163 748
14d9c578
JK
749#define EMPTY_TREE_SHA1_HEX \
750 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
dab0d410 751#define EMPTY_TREE_SHA1_BIN_LITERAL \
14d9c578
JK
752 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
753 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
dab0d410
JN
754#define EMPTY_TREE_SHA1_BIN \
755 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
14d9c578 756
f8582cad
JK
757#define EMPTY_BLOB_SHA1_HEX \
758 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
759#define EMPTY_BLOB_SHA1_BIN_LITERAL \
760 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
761 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
762#define EMPTY_BLOB_SHA1_BIN \
763 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
764
765static inline int is_empty_blob_sha1(const unsigned char *sha1)
766{
767 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
768}
769
f2db68ed
HE
770int git_mkstemp(char *path, size_t n, const char *template);
771
003b33a8
DA
772int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
773
b862b61c
MM
774/* set default permissions by passing mode arguments to open(2) */
775int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
776int git_mkstemp_mode(char *pattern, int mode);
777
06cbe855
HO
778/*
779 * NOTE NOTE NOTE!!
780 *
781 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
782 * not be changed. Old repositories have core.sharedrepository written in
783 * numeric format, and therefore these values are preserved for compatibility
784 * reasons.
785 */
94df2506 786enum sharedrepo {
06cbe855
HO
787 PERM_UMASK = 0,
788 OLD_PERM_GROUP = 1,
789 OLD_PERM_EVERYBODY = 2,
790 PERM_GROUP = 0660,
4b05548f 791 PERM_EVERYBODY = 0664
94df2506
JH
792};
793int git_config_perm(const char *var, const char *value);
3a429d3b 794int adjust_shared_perm(const char *path);
0be0521b
MH
795
796/*
797 * Create the directory containing the named path, using care to be
798 * somewhat safe against races. Return one of the scld_error values
799 * to indicate success/failure.
18d37e86
MH
800 *
801 * SCLD_VANISHED indicates that one of the ancestor directories of the
802 * path existed at one point during the function call and then
803 * suddenly vanished, probably because another process pruned the
804 * directory while we were working. To be robust against this kind of
805 * race, callers might want to try invoking the function again when it
806 * returns SCLD_VANISHED.
0be0521b
MH
807 */
808enum scld_error {
809 SCLD_OK = 0,
810 SCLD_FAILED = -1,
811 SCLD_PERMS = -2,
18d37e86
MH
812 SCLD_EXISTS = -3,
813 SCLD_VANISHED = -4
0be0521b
MH
814};
815enum scld_error safe_create_leading_directories(char *path);
816enum scld_error safe_create_leading_directories_const(const char *path);
817
90a6464b 818int mkdir_in_gitdir(const char *path);
21cf3227 819extern void home_config_paths(char **global, char **xdg, char *file);
395de250 820extern char *expand_user_path(const char *path);
1c64b48e 821const char *enter_repo(const char *path, int strict);
e5392c51
JS
822static inline int is_absolute_path(const char *path)
823{
88135203 824 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
e5392c51 825}
90b4a71c 826int is_directory(const char *);
e2a57aac 827const char *real_path(const char *path);
e3e46cdb 828const char *real_path_if_valid(const char *path);
e2a57aac 829const char *absolute_path(const char *path);
41894ae3 830const char *remove_leading_path(const char *in, const char *prefix);
e02ca72f 831const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
645a29c4 832int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
f3cad0ad 833int normalize_path_copy(char *dst, const char *src);
31171d9e 834int longest_ancestor_length(const char *path, struct string_list *prefixes);
4fcc86b0 835char *strip_path_suffix(const char *path, const char *suffix);
34b6cb8b 836int daemon_avoid_alias(const char *path);
1d1d69bc 837extern int is_ntfs_dotgit(const char *name);
b2cb9425 838
e1111cef 839/* object replacement */
ffe68cf9 840#define LOOKUP_REPLACE_OBJECT 1
5bf29b95 841extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
f5552aee
CC
842static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
843{
ffe68cf9 844 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
5bf29b95 845}
1f91e79c
MH
846
847/*
848 * This internal function is only declared here for the benefit of
849 * lookup_replace_object(). Please do not call it directly.
850 */
e1111cef 851extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1f91e79c
MH
852
853/*
854 * If object sha1 should be replaced, return the replacement object's
855 * name (replaced recursively, if necessary). The return value is
856 * either sha1 or a pointer to a permanently-allocated value. When
857 * object replacement is suppressed, always return sha1.
858 */
e1111cef
JH
859static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
860{
afc711b8 861 if (!check_replace_refs)
e1111cef
JH
862 return sha1;
863 return do_lookup_replace_object(sha1);
f5552aee 864}
1f91e79c 865
bf93eea0
CC
866static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
867{
868 if (!(flag & LOOKUP_REPLACE_OBJECT))
869 return sha1;
870 return lookup_replace_object(sha1);
871}
e1111cef 872
e83c5163 873/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
21666f1a 874extern int sha1_object_info(const unsigned char *, unsigned long *);
ce9fbf16 875extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
c00e657d 876extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
21666f1a 877extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
bbac7311 878extern int force_object_loose(const unsigned char *sha1, time_t mtime);
ec73f580 879extern int git_open_noatime(const char *name);
f0270efd 880extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
eb4f4076 881extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
f0270efd 882extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
8237b185 883
0e8189e2
NP
884/* global flag to enable extra checks when accessing packed objects */
885extern int do_check_packed_object_crc;
886
5d6ccf5c 887extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 888
839837b9 889extern int move_temp_to_file(const char *tmpfile, const char *filename);
8237b185 890
cd673c1f 891extern int has_sha1_pack(const unsigned char *sha1);
d40d535b
MH
892
893/*
894 * Return true iff we have an object named sha1, whether local or in
895 * an alternate object database, and whether packed or loose. This
896 * function does not respect replace references.
897 */
8237b185 898extern int has_sha1_file(const unsigned char *sha1);
d40d535b
MH
899
900/*
901 * Return true iff an alternate object database has a loose object
902 * with the specified name. This function does not respect replace
903 * references.
904 */
0f4dc14a 905extern int has_loose_object_nonlocal(const unsigned char *sha1);
8237b185 906
bf592c50
DB
907extern int has_pack_index(const unsigned char *sha1);
908
40d52ff7
JK
909extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
910
192a6be2
LT
911extern const signed char hexval_table[256];
912static inline unsigned int hexval(unsigned char c)
e49521b5
JH
913{
914 return hexval_table[c];
915}
916
e83c5163 917/* Convert to/from hex/sha1 representation */
dce96489
LT
918#define MINIMUM_ABBREV minimum_abbrev
919#define DEFAULT_ABBREV default_abbrev
46a6c262 920
573285e5
CP
921struct object_context {
922 unsigned char tree[20];
923 char path[PATH_MAX];
924 unsigned mode;
925};
926
daba53ae
JH
927#define GET_SHA1_QUIETLY 01
928#define GET_SHA1_COMMIT 02
929#define GET_SHA1_COMMITTISH 04
930#define GET_SHA1_TREE 010
931#define GET_SHA1_TREEISH 020
932#define GET_SHA1_BLOB 040
33bd598c 933#define GET_SHA1_ONLY_TO_DIE 04000
37c00e55 934
3c249c95 935extern int get_sha1(const char *str, unsigned char *sha1);
daba53ae 936extern int get_sha1_commit(const char *str, unsigned char *sha1);
cd74e473 937extern int get_sha1_committish(const char *str, unsigned char *sha1);
daba53ae
JH
938extern int get_sha1_tree(const char *str, unsigned char *sha1);
939extern int get_sha1_treeish(const char *str, unsigned char *sha1);
940extern int get_sha1_blob(const char *str, unsigned char *sha1);
8c135ea2 941extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
33bd598c 942extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
d4e85a1a 943
957d7406
JH
944typedef int each_abbrev_fn(const unsigned char *sha1, void *);
945extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
d4e85a1a
MH
946
947/*
948 * Try to read a SHA1 in hexadecimal format from the 40 characters
949 * starting at hex. Write the 20-byte result to sha1 in binary form.
950 * Return 0 on success. Reading stops if a NUL is encountered in the
951 * input, so it is safe to pass this function an arbitrary
952 * null-terminated string.
953 */
197ee8c9 954extern int get_sha1_hex(const char *hex, unsigned char *sha1);
d4e85a1a 955
197ee8c9 956extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
7695d118
RS
957extern int read_ref_full(const char *refname, int resolve_flags,
958 unsigned char *sha1, int *flags);
dfefa935 959extern int read_ref(const char *refname, unsigned char *sha1);
7cb36842
MH
960
961/*
962 * Resolve a reference, recursively following symbolic refererences.
963 *
964 * Store the referred-to object's name in sha1 and return the name of
965 * the non-symbolic reference that ultimately pointed at it. The
966 * return value, if not NULL, is a pointer into either a static buffer
967 * or the input ref.
968 *
969 * If the reference cannot be resolved to an object, the behavior
7695d118 970 * depends on the RESOLVE_REF_READING flag:
7cb36842 971 *
7695d118 972 * - If RESOLVE_REF_READING is set, return NULL.
7cb36842 973 *
7695d118
RS
974 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of
975 * the last reference name in the chain, which will either be a non-symbolic
7cb36842
MH
976 * reference or an undefined reference. If this is a prelude to
977 * "writing" to the ref, the return value is the name of the ref
978 * that will actually be created or changed.
979 *
62a2d525
JN
980 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
981 * level of symbolic reference. The value stored in sha1 for a symbolic
982 * reference will always be null_sha1 in this case, and the return
983 * value is the reference that the symref refers to directly.
984 *
7695d118 985 * If flags is non-NULL, set the value that it points to the
7cb36842 986 * combination of REF_ISPACKED (if the reference was found among the
7695d118 987 * packed references), REF_ISSYMREF (if the initial reference was a
d0f810f0
RS
988 * symbolic reference), REF_BAD_NAME (if the reference name is ill
989 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
990 * (if the ref is malformed or has a bad name). See refs.h for more detail
991 * on each flag.
7cb36842
MH
992 *
993 * If ref is not a properly-formatted, normalized reference, return
994 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
995 * give up and return NULL.
996 *
d0f810f0
RS
997 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
998 * name is invalid according to git-check-ref-format(1). If the name
999 * is bad then the value stored in sha1 will be null_sha1 and the two
1000 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
1001 *
1002 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
1003 * directory and do not consist of all caps and underscores cannot be
1004 * resolved. The function returns NULL for such ref names.
1005 * Caps and underscores refers to the special refs, such as HEAD,
1006 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
7cb36842 1007 */
7695d118 1008#define RESOLVE_REF_READING 0x01
62a2d525 1009#define RESOLVE_REF_NO_RECURSE 0x02
d0f810f0 1010#define RESOLVE_REF_ALLOW_BAD_NAME 0x04
7695d118
RS
1011extern const char *resolve_ref_unsafe(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);
1012extern char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);
7cb36842 1013
e86eb666 1014extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
eb3a4822 1015extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
cf99a761 1016extern int interpret_branch_name(const char *str, int len, struct strbuf *);
619a644d 1017extern int get_sha1_mb(const char *str, unsigned char *sha1);
e86eb666 1018
54457fe5
MH
1019/*
1020 * Return true iff abbrev_name is a possible abbreviation for
1021 * full_name according to the rules defined by ref_rev_parse_rules in
1022 * refs.c.
1023 */
1024extern int refname_match(const char *abbrev_name, const char *full_name);
79803322 1025
8b5157e4 1026extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
c847f537 1027extern int validate_headref(const char *ref);
e83c5163 1028
958ba6c9 1029extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
0ab9e1e8 1030extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
ccdd4a0f 1031extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
b60e188c 1032extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
e83c5163 1033
40469ee9 1034extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 1035 const char *required_type,
40469ee9
JH
1036 unsigned long *size,
1037 unsigned char *sha1_ret);
f4913f91 1038
81776315
JH
1039extern struct object *peel_to_type(const char *name, int namelen,
1040 struct object *o, enum object_type);
1041
73013afd
JH
1042enum date_mode {
1043 DATE_NORMAL = 0,
1044 DATE_RELATIVE,
1045 DATE_SHORT,
1046 DATE_LOCAL,
1047 DATE_ISO8601,
466fb674 1048 DATE_ISO8601_STRICT,
7dff9b30
LT
1049 DATE_RFC2822,
1050 DATE_RAW
73013afd
JH
1051};
1052
f8493ec0 1053const char *show_date(unsigned long time, int timezone, enum date_mode mode);
7d29afd4
JN
1054void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1055 struct strbuf *timebuf);
c33ddc2e 1056int parse_date(const char *date, struct strbuf *out);
9644c061 1057int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
3d27b9b0 1058int parse_expiry_date(const char *date, unsigned long *timestamp);
c33ddc2e 1059void datestamp(struct strbuf *out);
93cfa7c7
JH
1060#define approxidate(s) approxidate_careful((s), NULL)
1061unsigned long approxidate_careful(const char *, int *);
33012fc4 1062unsigned long approxidate_relative(const char *date, const struct timeval *now);
856665f8 1063enum date_mode parse_date_format(const char *format);
7ca36d93 1064int date_overflows(unsigned long date);
ecee9d9e 1065
f9bc573f 1066#define IDENT_STRICT 1
b9f0ac17 1067#define IDENT_NO_DATE 2
c15e1987 1068#define IDENT_NO_NAME 4
749be728
JH
1069extern const char *git_author_info(int);
1070extern const char *git_committer_info(int);
798123af 1071extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
d9ccfe77 1072extern const char *fmt_name(const char *name, const char *email);
9830534e 1073extern const char *ident_default_name(void);
bcb2b004 1074extern const char *ident_default_email(void);
44fcb497 1075extern const char *git_editor(void);
64778d24 1076extern const char *git_pager(int stdout_is_tty);
9597921b 1077extern int git_ident_config(const char *, const char *, void *);
6aa33f40 1078
4b340cfa
JH
1079struct ident_split {
1080 const char *name_begin;
1081 const char *name_end;
1082 const char *mail_begin;
1083 const char *mail_end;
1084 const char *date_begin;
1085 const char *date_end;
1086 const char *tz_begin;
1087 const char *tz_end;
1088};
1089/*
1090 * Signals an success with 0, but time part of the result may be NULL
1091 * if the input lacks timestamp and zone
1092 */
1093extern int split_ident_line(struct ident_split *, const char *, int);
1094
d1053246
JK
1095/*
1096 * Like show_date, but pull the timestamp and tz parameters from
1097 * the ident_split. It will also sanity-check the values and produce
1098 * a well-known sentinel date if they appear bogus.
1099 */
1100const char *show_ident_date(const struct ident_split *id, enum date_mode mode);
1101
662cc30c
JK
1102/*
1103 * Compare split idents for equality or strict ordering. Note that we
1104 * compare only the ident part of the line, ignoring any timestamp.
1105 *
1106 * Because there are two fields, we must choose one as the primary key; we
1107 * currently arbitrarily pick the email.
1108 */
1109extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1110
12dccc16 1111struct checkout {
d4a2024a 1112 struct index_state *istate;
12dccc16
LT
1113 const char *base_dir;
1114 int base_dir_len;
1115 unsigned force:1,
1116 quiet:1,
1117 not_new:1,
1118 refresh_cache:1;
1119};
1120
af2a651d 1121#define TEMPORARY_FILENAME_LENGTH 25
efbc5831 1122extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
b9fd2846
LT
1123
1124struct cache_def {
e7c73053 1125 struct strbuf path;
b9fd2846
LT
1126 int flags;
1127 int track_flags;
1128 int prefix_len_stat_func;
1129};
e7c73053 1130#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
2a608391 1131static inline void cache_def_clear(struct cache_def *cache)
e7c73053
KB
1132{
1133 strbuf_release(&cache->path);
1134}
b9fd2846 1135
57199892 1136extern int has_symlink_leading_path(const char *name, int len);
b9fd2846 1137extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
f66caaf9 1138extern int check_leading_path(const char *name, int len);
57199892 1139extern int has_dirs_only_path(const char *name, int len, int prefix_len);
78478927
KB
1140extern void schedule_dir_for_removal(const char *name, int len);
1141extern void remove_scheduled_dirs(void);
12dccc16 1142
9a217f2a 1143extern struct alternate_object_database {
d5a63b99 1144 struct alternate_object_database *next;
9a217f2a 1145 char *name;
8f1d2e6f 1146 char base[FLEX_ARRAY]; /* more */
d5a63b99 1147} *alt_odb_list;
9a217f2a 1148extern void prepare_alt_odb(void);
5e73633d 1149extern void read_info_alternates(const char * relative_base, int depth);
bef70b22 1150extern void add_to_alternates_file(const char *reference);
d79796bc 1151typedef int alt_odb_fn(struct alternate_object_database *, void *);
fe1b2268 1152extern int foreach_alt_odb(alt_odb_fn, void*);
9a217f2a 1153
c41ee586
SP
1154struct pack_window {
1155 struct pack_window *next;
1156 unsigned char *base;
1157 off_t offset;
1158 size_t len;
1159 unsigned int last_used;
1160 unsigned int inuse_cnt;
1161};
1162
9a217f2a
JH
1163extern struct packed_git {
1164 struct packed_git *next;
c41ee586 1165 struct pack_window *windows;
2dc3a234 1166 off_t pack_size;
57059091
NP
1167 const void *index_data;
1168 size_t index_size;
1169 uint32_t num_objects;
8eca0b47
NP
1170 uint32_t num_bad_objects;
1171 unsigned char *bad_object_sha1;
42873078 1172 int index_version;
57059091 1173 time_t mtime;
9bc879c1 1174 int pack_fd;
8d25931d 1175 unsigned pack_local:1,
d131b7af
SP
1176 pack_keep:1,
1177 do_not_close:1;
bf592c50 1178 unsigned char sha1[20];
8f1d2e6f
JH
1179 /* something like ".git/objects/pack/xxxxx.pack" */
1180 char pack_name[FLEX_ARRAY]; /* more */
9a217f2a 1181} *packed_git;
f3bf9224
JH
1182
1183struct pack_entry {
c4001d92 1184 off_t offset;
f3bf9224
JH
1185 unsigned char sha1[20];
1186 struct packed_git *p;
1187};
1188
7b64469a 1189extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
bf592c50 1190
543c5caa
NTND
1191/* A hook for count-objects to report invalid files in pack directory */
1192extern void (*report_garbage)(const char *desc, const char *path);
1193
9a217f2a 1194extern void prepare_packed_git(void);
fc04c412 1195extern void reprepare_packed_git(void);
bf592c50
DB
1196extern void install_packed_git(struct packed_git *pack);
1197
a6080a0a 1198extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
bf592c50
DB
1199 struct packed_git *packs);
1200
276bc2ca 1201extern void pack_report(void);
d40d535b
MH
1202
1203/*
1204 * mmap the index file for the specified packfile (if it is not
1205 * already mmapped). Return 0 on success.
1206 */
d079837e 1207extern int open_pack_index(struct packed_git *);
d40d535b
MH
1208
1209/*
1210 * munmap the index file for the specified packfile (if it is
1211 * currently mmapped).
1212 */
fa5fc15d 1213extern void close_pack_index(struct packed_git *);
d40d535b 1214
ef49a7a0 1215extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
c9ced051 1216extern void close_pack_windows(struct packed_git *);
03e79c88 1217extern void unuse_pack(struct pack_window **);
c74faea1 1218extern void free_pack_by_name(const char *);
3d20c636 1219extern void clear_delta_base_cache(void);
42873078 1220extern struct packed_git *add_packed_git(const char *, int, int);
d40d535b
MH
1221
1222/*
1223 * Return the SHA-1 of the nth object within the specified packfile.
1224 * Open the index if it is not already open. The return value points
1225 * at the SHA-1 within the mmapped index. Return NULL if there is an
1226 * error.
1227 */
1228extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1229
1230/*
1231 * Return the offset of the nth object within the specified packfile.
1232 * The index must already be opened.
1233 */
1234extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1235
1236/*
1237 * If the object named sha1 is present in the specified packfile,
1238 * return its offset within the packfile; otherwise, return 0.
1239 */
1240extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1241
4c080182 1242extern int is_pack_valid(struct packed_git *);
c4001d92 1243extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
09ded04b 1244extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
54dab52a 1245extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
f8c8abc5 1246extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
9a217f2a 1247
27e1e22d
JK
1248/*
1249 * Iterate over the files in the loose-object parts of the object
1250 * directory "path", triggering the following callbacks:
1251 *
1252 * - loose_object is called for each loose object we find.
1253 *
1254 * - loose_cruft is called for any files that do not appear to be
1255 * loose objects. Note that we only look in the loose object
1256 * directories "objects/[0-9a-f]{2}/", so we will not report
1257 * "objects/foobar" as cruft.
1258 *
1259 * - loose_subdir is called for each top-level hashed subdirectory
1260 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1261 * after the objects in the directory are processed.
1262 *
1263 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1264 * will end the iteration.
e6f875e0
JK
1265 *
1266 * In the "buf" variant, "path" is a strbuf which will also be used as a
1267 * scratch buffer, but restored to its original contents before
1268 * the function returns.
27e1e22d
JK
1269 */
1270typedef int each_loose_object_fn(const unsigned char *sha1,
1271 const char *path,
1272 void *data);
1273typedef int each_loose_cruft_fn(const char *basename,
1274 const char *path,
1275 void *data);
1276typedef int each_loose_subdir_fn(int nr,
1277 const char *path,
1278 void *data);
1279int for_each_loose_file_in_objdir(const char *path,
1280 each_loose_object_fn obj_cb,
1281 each_loose_cruft_fn cruft_cb,
1282 each_loose_subdir_fn subdir_cb,
1283 void *data);
e6f875e0
JK
1284int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1285 each_loose_object_fn obj_cb,
1286 each_loose_cruft_fn cruft_cb,
1287 each_loose_subdir_fn subdir_cb,
1288 void *data);
27e1e22d 1289
660c889e
JK
1290/*
1291 * Iterate over loose and packed objects in both the local
1292 * repository and any alternates repositories.
1293 */
1294typedef int each_packed_object_fn(const unsigned char *sha1,
1295 struct packed_git *pack,
1296 uint32_t pos,
1297 void *data);
1298extern int for_each_loose_object(each_loose_object_fn, void *);
1299extern int for_each_packed_object(each_packed_object_fn, void *);
1300
9a490590
JH
1301struct object_info {
1302 /* Request */
5b086407 1303 enum object_type *typep;
9a490590 1304 unsigned long *sizep;
161f00e7 1305 unsigned long *disk_sizep;
5d642e75 1306 unsigned char *delta_base_sha1;
9a490590
JH
1307
1308 /* Response */
1309 enum {
1310 OI_CACHED,
1311 OI_LOOSE,
5266d369
JH
1312 OI_PACKED,
1313 OI_DBCACHED
9a490590
JH
1314 } whence;
1315 union {
1316 /*
1317 * struct {
1318 * ... Nothing to expose in this case
1319 * } cached;
1320 * struct {
1321 * ... Nothing to expose in this case
1322 * } loose;
1323 */
1324 struct {
1325 struct packed_git *pack;
1326 off_t offset;
1327 unsigned int is_delta;
1328 } packed;
1329 } u;
1330};
de7b5d62 1331extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
9a217f2a 1332
8f3f9b09
JH
1333/* Dumb servers support */
1334extern int update_server_info(int);
1335
7a397419
MG
1336/* git_config_parse_key() returns these negated: */
1337#define CONFIG_INVALID_KEY 1
1338#define CONFIG_NO_SECTION_OR_NAME 2
1339/* git_config_set(), git_config_set_multivar() return the above or these: */
1340#define CONFIG_NO_LOCK -1
1341#define CONFIG_INVALID_FILE 3
1342#define CONFIG_NO_WRITE 4
1343#define CONFIG_NOTHING_SET 5
1344#define CONFIG_INVALID_PATTERN 6
9409c7a5 1345#define CONFIG_GENERIC_ERROR 7
7a397419 1346
c1063be2
JK
1347#define CONFIG_REGEX_NONE ((void *)1)
1348
c8985ce0 1349struct git_config_source {
3caec73b 1350 unsigned int use_stdin:1;
c8985ce0
KS
1351 const char *file;
1352 const char *blob;
1353};
1354
ef90d6d4
JS
1355typedef int (*config_fn_t)(const char *, const char *, void *);
1356extern int git_default_config(const char *, const char *, void *);
1357extern int git_config_from_file(config_fn_t fn, const char *, void *);
1bc88819
HV
1358extern int git_config_from_buf(config_fn_t fn, const char *name,
1359 const char *buf, size_t len, void *data);
2b64fc89 1360extern void git_config_push_parameter(const char *text);
b3d83d9f 1361extern int git_config_from_parameters(config_fn_t fn, void *data);
aace4385 1362extern void git_config(config_fn_t fn, void *);
9b25a0b5 1363extern int git_config_with_options(config_fn_t fn, void *,
c8985ce0 1364 struct git_config_source *config_source,
1bc88819 1365 int respect_includes);
dbdf5854 1366extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
0b87b6e0 1367extern int git_parse_ulong(const char *, unsigned long *);
17712991 1368extern int git_config_int(const char *, const char *);
00160242 1369extern int64_t git_config_int64(const char *, const char *);
0b87b6e0 1370extern unsigned long git_config_ulong(const char *, const char *);
a53f2ec6 1371extern int git_config_bool_or_int(const char *, const char *, int *);
17712991 1372extern int git_config_bool(const char *, const char *);
8420ccd8 1373extern int git_config_maybe_bool(const char *, const char *);
ea5105a5 1374extern int git_config_string(const char **, const char *, const char *);
395de250 1375extern int git_config_pathname(const char **, const char *, const char *);
5ec31182 1376extern int git_config_set_in_file(const char *, const char *, const char *);
10bea152 1377extern int git_config_set(const char *, const char *);
b09c53a3 1378extern int git_config_parse_key(const char *, char **, int *);
4ddba79d 1379extern int git_config_set_multivar(const char *, const char *, const char *, int);
5ec31182 1380extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
0667fcfb 1381extern int git_config_rename_section(const char *, const char *);
42bd39b5 1382extern int git_config_rename_section_in_file(const char *, const char *, const char *);
506b17b1 1383extern const char *git_etc_gitconfig(void);
ef90d6d4 1384extern int check_repository_format_version(const char *var, const char *value, void *cb);
0ef37164 1385extern int git_env_bool(const char *, int);
23b0c478 1386extern unsigned long git_env_ulong(const char *, unsigned long);
ab88c363 1387extern int git_config_system(void);
40ea4ed9 1388extern int config_error_nonbool(const char *);
ff0a80af 1389#if defined(__GNUC__)
87fe5df3 1390#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
a469a101 1391#endif
a6fa5992
PN
1392extern const char *get_log_output_encoding(void);
1393extern const char *get_commit_output_encoding(void);
1394
2496844b
JK
1395extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1396
9b25a0b5
JK
1397struct config_include_data {
1398 int depth;
1399 config_fn_t fn;
1400 void *data;
1401};
1402#define CONFIG_INCLUDE_INIT { 0 }
1403extern int git_config_include(const char *name, const char *value, void *data);
17712991 1404
1b86bbb0
JK
1405/*
1406 * Match and parse a config key of the form:
1407 *
1408 * section.(subsection.)?key
1409 *
1410 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1411 * we return -1 if it does not match, 0 otherwise. The subsection and key
1412 * out-parameters are filled by the function (and subsection is NULL if it is
1413 * missing).
1414 */
1415extern int parse_config_key(const char *var,
1416 const char *section,
1417 const char **subsection, int *subsection_len,
1418 const char **key);
1419
155ef25f
TA
1420struct config_set_element {
1421 struct hashmap_entry ent;
1422 char *key;
1423 struct string_list value_list;
1424};
1425
1426struct configset_list_item {
1427 struct config_set_element *e;
1428 int value_index;
1429};
1430
1431/*
1432 * the contents of the list are ordered according to their
1433 * position in the config files and order of parsing the files.
1434 * (i.e. key-value pair at the last position of .git/config will
1435 * be at the last item of the list)
1436 */
1437struct configset_list {
1438 struct configset_list_item *items;
1439 unsigned int nr, alloc;
1440};
1441
3c8687a7
TA
1442struct config_set {
1443 struct hashmap config_hash;
1444 int hash_initialized;
155ef25f 1445 struct configset_list list;
3c8687a7
TA
1446};
1447
1448extern void git_configset_init(struct config_set *cs);
1449extern int git_configset_add_file(struct config_set *cs, const char *filename);
1450extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1451extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1452extern void git_configset_clear(struct config_set *cs);
1453extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1454extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1455extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1456extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1457extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1458extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1459extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1460extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1461
1462extern int git_config_get_value(const char *key, const char **value);
1463extern const struct string_list *git_config_get_value_multi(const char *key);
1464extern void git_config_clear(void);
1465extern void git_config_iter(config_fn_t fn, void *data);
1466extern int git_config_get_string_const(const char *key, const char **dest);
1467extern int git_config_get_string(const char *key, char **dest);
1468extern int git_config_get_int(const char *key, int *dest);
1469extern int git_config_get_ulong(const char *key, unsigned long *dest);
1470extern int git_config_get_bool(const char *key, int *dest);
1471extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1472extern int git_config_get_maybe_bool(const char *key, int *dest);
1473extern int git_config_get_pathname(const char *key, const char **dest);
1474
3df8fd62
TA
1475struct key_value_info {
1476 const char *filename;
1477 int linenr;
1478};
1479
5a80e97c
TA
1480extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1481extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1482
d6991cee
JK
1483extern int committer_ident_sufficiently_given(void);
1484extern int author_ident_sufficiently_given(void);
e1b10391 1485
1a8f2741 1486extern const char *git_commit_encoding;
3a55602e 1487extern const char *git_log_output_encoding;
d551a488 1488extern const char *git_mailmap_file;
08610900 1489extern const char *git_mailmap_blob;
4e72dcec 1490
06f59e9f
TT
1491/* IO helper functions */
1492extern void maybe_flush_or_die(FILE *, const char *);
9540ce50
JK
1493__attribute__((format (printf, 2, 3)))
1494extern void fprintf_or_die(FILE *, const char *fmt, ...);
f3123c4a 1495extern int copy_fd(int ifd, int ofd);
1468bd47 1496extern int copy_file(const char *dst, const char *src, int mode);
f7835a25 1497extern int copy_file_with_time(const char *dst, const char *src, int mode);
7230e6d0 1498extern void write_or_die(int fd, const void *buf, size_t count);
6ce4e61f 1499extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
e0814056 1500extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
4c81b03e 1501extern void fsync_or_die(int fd, const char *);
ad897215 1502
2b7ca830
JM
1503extern ssize_t read_in_full(int fd, void *buf, size_t count);
1504extern ssize_t write_in_full(int fd, const void *buf, size_t count);
426ddeea
YM
1505extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1506
2b7ca830
JM
1507static inline ssize_t write_str_in_full(int fd, const char *str)
1508{
1509 return write_in_full(fd, str, strlen(str));
1510}
1511
f67b45f8
LT
1512/* pager.c */
1513extern void setup_pager(void);
872da32d 1514extern const char *pager_program;
6e9af863 1515extern int pager_in_use(void);
aa086eb8 1516extern int pager_use_color;
ad6c3739 1517extern int term_columns(void);
d306f3d3 1518extern int decimal_width(uintmax_t);
4914c962 1519extern int check_pager_config(const char *cmd);
f67b45f8 1520
ee9601e6 1521extern const char *editor_program;
d3e7da89 1522extern const char *askpass_program;
dfb068be 1523extern const char *excludes_file;
4d87b9c5 1524
051308f6 1525/* base85 */
f9815772
JM
1526int decode_85(char *dst, const char *line, int linelen);
1527void encode_85(char *buf, const unsigned char *data, int bytes);
051308f6 1528
855419f7 1529/* alloc.c */
100c5f3b
LT
1530extern void *alloc_blob_node(void);
1531extern void *alloc_tree_node(void);
1532extern void *alloc_commit_node(void);
1533extern void *alloc_tag_node(void);
1534extern void *alloc_object_node(void);
855419f7 1535extern void alloc_report(void);
94d5a22c 1536extern unsigned int alloc_commit_index(void);
855419f7 1537
5991a55c 1538/* pkt-line.c */
bbc30f99 1539void packet_trace_identity(const char *prog);
6ce4e61f 1540
b6ec1d61 1541/* add */
7ae02a30
AR
1542/*
1543 * return 0 if success, 1 - if addition of a file failed and
1544 * ADD_FILES_IGNORE_ERRORS was specified in flags
1545 */
3efe8e43 1546int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
b6ec1d61 1547
aecbf914
JH
1548/* diff.c */
1549extern int diff_auto_refresh_index;
1550
68faf689
JH
1551/* match-trees.c */
1552void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
85e51b78 1553void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
68faf689 1554
a9cc857a
JH
1555/*
1556 * whitespace rules.
1557 * used by both diff and apply
f4b05a49 1558 * last two digits are tab width
a9cc857a 1559 */
f4b05a49
JS
1560#define WS_BLANK_AT_EOL 0100
1561#define WS_SPACE_BEFORE_TAB 0200
1562#define WS_INDENT_WITH_NON_TAB 0400
1563#define WS_CR_AT_EOL 01000
1564#define WS_BLANK_AT_EOF 02000
1565#define WS_TAB_IN_INDENT 04000
aeb84b05 1566#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
f4b05a49
JS
1567#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1568#define WS_TAB_WIDTH_MASK 077
cf1b7869
JH
1569extern unsigned whitespace_rule_cfg;
1570extern unsigned whitespace_rule(const char *);
1571extern unsigned parse_whitespace_rule(const char *);
8f8841e9
JH
1572extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1573extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
c1795bb0 1574extern char *whitespace_error_string(unsigned ws);
d511bd33 1575extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
877f23cc 1576extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
f4b05a49 1577#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
a9cc857a 1578
ee425e46 1579/* ls-files */
17ddc66e 1580int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
ee425e46
JH
1581void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1582
94351118 1583char *alias_lookup(const char *alias);
0989fe96 1584int split_cmdline(char *cmdline, const char ***argv);
ad9ac6db
GB
1585/* Takes a negative value returned by split_cmdline */
1586const char *split_cmdline_strerror(int cmdline_errno);
94351118 1587
e37c1329
NTND
1588/* git.c */
1589struct startup_info {
a60645f9 1590 int have_repository;
f07d6a1a 1591 const char *prefix;
e37c1329
NTND
1592};
1593extern struct startup_info *startup_info;
1594
db699a8a
NTND
1595/* merge.c */
1596struct commit_list;
1597int try_merge_command(const char *strategy, size_t xopts_nr,
1598 const char **xopts, struct commit_list *common,
1599 const char *head_arg, struct commit_list *remotes);
1600int checkout_fast_forward(const unsigned char *from,
1601 const unsigned char *to,
1602 int overwrite_ignore);
1603
cac42b26 1604
38f865c2
JK
1605int sane_execvp(const char *file, char *const argv[]);
1606
38612532
MH
1607/*
1608 * A struct to encapsulate the concept of whether a file has changed
1609 * since we last checked it. This uses criteria similar to those used
1610 * for the index.
1611 */
1612struct stat_validity {
1613 struct stat_data *sd;
1614};
1615
1616void stat_validity_clear(struct stat_validity *sv);
1617
1618/*
1619 * Returns 1 if the path is a regular file (or a symlink to a regular
1620 * file) and matches the saved stat_validity, 0 otherwise. A missing
1621 * or inaccessible file is considered a match if the struct was just
1622 * initialized, or if the previous update found an inaccessible file.
1623 */
1624int stat_validity_check(struct stat_validity *sv, const char *path);
1625
1626/*
1627 * Update the stat_validity from a file opened at descriptor fd. If
1628 * the file is missing, inaccessible, or not a regular file, then
1629 * future calls to stat_validity_check will match iff one of those
1630 * conditions continues to be true.
1631 */
1632void stat_validity_update(struct stat_validity *sv, int fd);
1633
9ef176b5
NTND
1634int versioncmp(const char *s1, const char *s2);
1635
e83c5163 1636#endif /* CACHE_H */