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