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