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