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