object-store: move packed_git and packed_git_mru to object store
[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"
ec2dd32c 7#include "list.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 347 unsigned name_hash_initialized : 1,
4bddd983
TG
348 initialized : 1,
349 drop_cache_tree : 1;
8b013788 350 struct hashmap name_hash;
e05881a4 351 struct hashmap dir_hash;
426ddeea 352 unsigned char sha1[20];
83c094ad 353 struct untracked_cache *untracked;
883e248b 354 uint64_t fsmonitor_last_update;
ba1b9cac 355 struct ewah_bitmap *fsmonitor_dirty;
228e94f9
JH
356};
357
358extern struct index_state the_index;
359
96872bc2 360/* Name hashing */
ea194895 361extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
96872bc2 362extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
2092678c
KB
363extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
364extern void free_name_hash(struct index_state *istate);
96872bc2
LT
365
366
4aab5b46 367#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
228e94f9
JH
368#define active_cache (the_index.cache)
369#define active_nr (the_index.cache_nr)
370#define active_alloc (the_index.cache_alloc)
371#define active_cache_changed (the_index.cache_changed)
372#define active_cache_tree (the_index.cache_tree)
e83c5163 373
4aab5b46 374#define read_cache() read_index(&the_index)
a125a223 375#define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir()))
671c9b7e 376#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
fa7b3c2f 377#define is_cache_unborn() is_index_unborn(&the_index)
e46bbcf6 378#define read_cache_unmerged() read_index_unmerged(&the_index)
4aab5b46 379#define discard_cache() discard_index(&the_index)
94a5728c 380#define unmerged_cache() unmerged_index(&the_index)
4aab5b46
JH
381#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
382#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
81dc2307 383#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
4aab5b46
JH
384#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
385#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
610d55af
TG
386#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
387#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
d9d70966 388#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
3deffc52 389#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
4bd5b7da
JH
390#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
391#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
db5360f3
ES
392#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
393#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
98fa4738 394#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
cfc5789a 395#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
8aa38563 396#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
4421a823 397#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
ff366825 398#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
4aab5b46 399#endif
e83c5163 400
edaec3fb
JH
401enum object_type {
402 OBJ_BAD = -1,
403 OBJ_NONE = 0,
404 OBJ_COMMIT = 1,
405 OBJ_TREE = 2,
406 OBJ_BLOB = 3,
407 OBJ_TAG = 4,
408 /* 5 for future expansion */
409 OBJ_OFS_DELTA = 6,
410 OBJ_REF_DELTA = 7,
355885d5 411 OBJ_ANY,
4b05548f 412 OBJ_MAX
edaec3fb
JH
413};
414
b45563a2
JH
415static inline enum object_type object_type(unsigned int mode)
416{
417 return S_ISDIR(mode) ? OBJ_TREE :
418 S_ISGITLINK(mode) ? OBJ_COMMIT :
419 OBJ_BLOB;
420}
421
2163e5db 422/* Double-check local_repo_env below if you add to this list. */
8ac069ac 423#define GIT_DIR_ENVIRONMENT "GIT_DIR"
c7b3a3d2 424#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
a1bea2c1 425#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
892c41b9 426#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
a6f7f9a3 427#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
74866d75 428#define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
8ac069ac 429#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 430#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 431#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 432#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
069c0532 433#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
d4ebc36c
JH
434#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
435#define CONFIG_ENVIRONMENT "GIT_CONFIG"
2b64fc89 436#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
d4ebc36c 437#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
0454dd93 438#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
6476b38b 439#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
58d121b2 440#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
d0bfd026
JH
441#define GITATTRIBUTES_FILE ".gitattributes"
442#define INFOATTRIBUTES_FILE "info/attributes"
f48fd688 443#define ATTRIBUTE_MACRO_PREFIX "[attr]"
4c0eeafe 444#define GITMODULES_FILE ".gitmodules"
a97a7468
JS
445#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
446#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
894a9d33 447#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
6956f858
TR
448#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
449#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
823ab40f 450#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
bd30c2e4
NTND
451#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
452#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
93d93537 453#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
e34c2e01 454#define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
27344d6a 455#define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
bb233d69 456
373d70ef
BW
457/*
458 * Environment variable used in handshaking the wire protocol.
459 * Contains a colon ':' separated list of keys with optional values
460 * 'key[=value]'. Presence of unknown keys and values must be
461 * ignored.
462 */
463#define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
19113a26
BW
464/* HTTP header used to handshake the wire protocol */
465#define GIT_PROTOCOL_HEADER "Git-Protocol"
373d70ef 466
48a7c1c4 467/*
2cd83d10
JK
468 * This environment variable is expected to contain a boolean indicating
469 * whether we should or should not treat:
470 *
471 * GIT_DIR=foo.git git ...
472 *
473 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
474 * of this, but we use it internally to communicate to sub-processes that we
475 * are in a bare repo. If not set, defaults to true.
476 */
477#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
478
48a7c1c4 479/*
2163e5db
JK
480 * Repository-local GIT_* environment variables; these will be cleared
481 * when git spawns a sub-process that runs inside another repository.
482 * The array is NULL-terminated, which makes it easy to pass in the "env"
483 * parameter of a run-command invocation, or to do a simple walk.
48a7c1c4 484 */
2163e5db 485extern const char * const local_repo_env[];
48a7c1c4 486
357a03eb 487extern void setup_git_env(const char *git_dir);
73f192c9 488
b9605bc4
JK
489/*
490 * Returns true iff we have a configured git repository (either via
491 * setup_git_directory, or in the environment via $GIT_DIR).
492 */
493int have_git_dir(void);
494
7d1864ce
JH
495extern int is_bare_repository_cfg;
496extern int is_bare_repository(void);
68025633 497extern int is_inside_git_dir(void);
e90fdc39 498extern char *git_work_tree_cfg;
892c41b9 499extern int is_inside_work_tree(void);
c5fba16c 500extern const char *get_git_dir(void);
c7b3a3d2 501extern const char *get_git_common_dir(void);
8ac069ac
JH
502extern char *get_object_directory(void);
503extern char *get_index_file(void);
5da5c8f4 504extern char *get_graft_file(void);
d7ac12b2 505extern int set_git_dir(const char *path);
11f9dd71 506extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
31e26ebc 507extern int get_common_dir(struct strbuf *sb, const char *gitdir);
a1bea2c1
JT
508extern const char *get_git_namespace(void);
509extern const char *strip_namespace(const char *namespaced_ref);
74866d75 510extern const char *get_super_prefix(void);
e90fdc39 511extern const char *get_git_work_tree(void);
a93bedad 512
ffd036b1
JK
513/*
514 * Return true if the given path is a git directory; note that this _just_
515 * looks at the directory itself. If you want to know whether "foo/.git"
516 * is a repository, you must feed that path, not just "foo".
517 */
518extern int is_git_directory(const char *path);
519
520/*
521 * Return 1 if the given path is the root of a git repository or
522 * submodule, else 0. Will not return 1 for bare repositories with the
523 * exception of creating a bare repository in "foo/.git" and calling
524 * is_git_repository("foo").
525 *
526 * If we run into read errors, we err on the side of saying "yes, it is",
527 * as we usually consider sub-repos precious, and would prefer to err on the
528 * side of not disrupting or deleting them.
529 */
530extern int is_nonbare_repository_dir(struct strbuf *path);
531
a93bedad
EE
532#define READ_GITFILE_ERR_STAT_FAILED 1
533#define READ_GITFILE_ERR_NOT_A_FILE 2
534#define READ_GITFILE_ERR_OPEN_FAILED 3
535#define READ_GITFILE_ERR_READ_FAILED 4
536#define READ_GITFILE_ERR_INVALID_FORMAT 5
537#define READ_GITFILE_ERR_NO_PATH 6
538#define READ_GITFILE_ERR_NOT_A_REPO 7
921bdd96 539#define READ_GITFILE_ERR_TOO_LARGE 8
5f29433f 540extern void read_gitfile_error_die(int error_code, const char *path, const char *dir);
a93bedad
EE
541extern const char *read_gitfile_gently(const char *path, int *return_error_code);
542#define read_gitfile(path) read_gitfile_gently((path), NULL)
40d96325
SB
543extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
544#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
545
19757d80 546extern void set_git_work_tree(const char *tree);
8ac069ac
JH
547
548#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 549
59f0f2f3 550extern void setup_work_tree(void);
16ac8b8d 551/*
d3fb71b3
BW
552 * Find the commondir and gitdir of the repository that contains the current
553 * working directory, without changing the working directory or other global
554 * state. The result is appended to commondir and gitdir. If the discovered
555 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
556 * both have the same result appended to the buffer. The return value is
557 * either 0 upon success and non-zero if no repository was found.
16ac8b8d 558 */
d3fb71b3
BW
559extern int discover_git_directory(struct strbuf *commondir,
560 struct strbuf *gitdir);
4ca06608 561extern const char *setup_git_directory_gently(int *);
d288a700 562extern const char *setup_git_directory(void);
edc54fb5 563extern char *prefix_path(const char *prefix, int len, const char *path);
645a29c4 564extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
59801976
JK
565
566/*
567 * Concatenate "prefix" (if len is non-zero) and "path", with no
568 * connecting characters (so "prefix" should end with a "/").
569 * Unlike prefix_path, this should be used if the named file does
570 * not have to interact with index entry; i.e. name of a random file
571 * on the filesystem.
572 *
e4da43b1
JK
573 * The return value is always a newly allocated string (even if the
574 * prefix was empty).
59801976 575 */
e4da43b1 576extern char *prefix_filename(const char *prefix, const char *path);
59801976 577
c6e8c800 578extern int check_filename(const char *prefix, const char *name);
023e37c3
MM
579extern void verify_filename(const char *prefix,
580 const char *name,
581 int diagnose_misspelt_rev);
ea92f41f 582extern void verify_non_filename(const char *prefix, const char *name);
546e0fd9 583extern int path_inside_repo(const char *prefix, const char *path);
d288a700 584
f225aeb2 585#define INIT_DB_QUIET 0x0001
33158701 586#define INIT_DB_EXIST_OK 0x0002
f225aeb2 587
33158701
NTND
588extern int init_db(const char *git_dir, const char *real_git_dir,
589 const char *template_dir, unsigned int flags);
f225aeb2 590
1d999ddd 591extern void sanitize_stdfds(void);
de0957ce 592extern int daemonize(void);
1d999ddd 593
e83c5163
LT
594#define alloc_nr(x) (((x)+16)*3/2)
595
6815e569
JK
596/*
597 * Realloc the buffer pointed at by variable 'x' so that it can hold
598 * at least 'nr' entries; the number of entries currently allocated
599 * is 'alloc', using the standard growing factor alloc_nr() macro.
600 *
01f6fd4b 601 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
6815e569
JK
602 */
603#define ALLOC_GROW(x, nr, alloc) \
604 do { \
c927e6c6 605 if ((nr) > alloc) { \
4234a761
JH
606 if (alloc_nr(alloc) < (nr)) \
607 alloc = (nr); \
608 else \
609 alloc = alloc_nr(alloc); \
2756ca43 610 REALLOC_ARRAY(x, alloc); \
6815e569 611 } \
98746061 612 } while (0)
6815e569 613
734aab75 614/* Initialize and use the cache information */
03b86647 615struct lock_file;
4aab5b46 616extern int read_index(struct index_state *);
5ab2a2da 617extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
3e52f70b
NTND
618extern int do_read_index(struct index_state *istate, const char *path,
619 int must_exist); /* for testting only! */
a125a223
TG
620extern int read_index_from(struct index_state *, const char *path,
621 const char *gitdir);
fa7b3c2f 622extern int is_index_unborn(struct index_state *);
e46bbcf6 623extern int read_index_unmerged(struct index_state *);
8dc38346
624
625/* For use with `write_locked_index()`. */
03b86647 626#define COMMIT_LOCK (1 << 0)
8dc38346
627
628/*
812d6b00
629 * Write the index while holding an already-taken lock. Close the lock,
630 * and if `COMMIT_LOCK` is given, commit it.
8dc38346
631 *
632 * Unless a split index is in use, write the index into the lockfile.
633 *
634 * With a split index, write the shared index to a temporary file,
635 * adjust its permissions and rename it into place, then write the
636 * split index to the lockfile. If the temporary file for the shared
637 * index cannot be created, fall back to the behavior described in
638 * the previous paragraph.
df60cf57
639 *
640 * With `COMMIT_LOCK`, the lock is always committed or rolled back.
641 * Without it, the lock is closed, but neither committed nor rolled
642 * back.
8dc38346 643 */
03b86647 644extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
8dc38346 645
4aab5b46 646extern int discard_index(struct index_state *);
edf3b905 647extern void move_index_extensions(struct index_state *dst, struct index_state *src);
d1f128b0 648extern int unmerged_index(const struct index_state *);
b101793c
EN
649
650/**
651 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn
652 * branch, returns 1 if there are entries in the index, 0 otherwise. If an
653 * strbuf is provided, the space-separated list of files that differ will be
654 * appended to it.
655 */
656extern int index_has_changes(struct strbuf *sb);
657
8dcf39c4 658extern int verify_path(const char *path);
a6db3fbb 659extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change);
41284eb0
DT
660extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
661extern void adjust_dirname_case(struct index_state *istate, char *name);
db5360f3 662extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
12733e9d
SB
663
664/*
665 * Searches for an entry defined by name and namelen in the given index.
666 * If the return value is positive (including 0) it is the position of an
667 * exact match. If the return value is negative, the negated value minus 1
668 * is the position where the entry would be inserted.
669 * Example: The current index consists of these files and its stages:
670 *
671 * b#0, d#0, f#1, f#3
672 *
673 * index_name_pos(&index, "a", 1) -> -1
674 * index_name_pos(&index, "b", 1) -> 0
675 * index_name_pos(&index, "c", 1) -> -2
676 * index_name_pos(&index, "d", 1) -> 1
677 * index_name_pos(&index, "e", 1) -> -3
678 * index_name_pos(&index, "f", 1) -> -3
679 * index_name_pos(&index, "g", 1) -> -5
680 */
d1f128b0 681extern int index_name_pos(const struct index_state *, const char *name, int namelen);
12733e9d 682
192268c1
JH
683#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
684#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 685#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
af3785dc 686#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
39425819 687#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
ce7c614b 688#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
4aab5b46 689extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
81dc2307 690extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
3bd72adf
SB
691
692/* Remove entry, return true if there are more entries to go. */
4aab5b46 693extern int remove_index_entry_at(struct index_state *, int pos);
3bd72adf 694
36419c8e 695extern void remove_marked_cache_entries(struct index_state *istate);
4aab5b46 696extern int remove_file_from_index(struct index_state *, const char *path);
38ed1d89
JH
697#define ADD_CACHE_VERBOSE 1
698#define ADD_CACHE_PRETEND 2
01665924 699#define ADD_CACHE_IGNORE_ERRORS 4
041aee31 700#define ADD_CACHE_IGNORE_REMOVAL 8
39425819 701#define ADD_CACHE_INTENT 16
20cf41d0
SB
702/*
703 * These two are used to add the contents of the file at path
704 * to the index, marking the working tree up-to-date by storing
705 * the cached stat info in the resulting cache entry. A caller
706 * that has already run lstat(2) on the path can call
707 * add_to_index(), and all others can call add_file_to_index();
708 * the latter will do necessary lstat(2) internally before
709 * calling the former.
710 */
610d55af
TG
711extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
712extern int add_file_to_index(struct index_state *, const char *path, int flags);
20cf41d0 713
25762726 714extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
d9d70966 715extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
9c5e6c80 716extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
b4b313f9 717extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
98fa4738 718extern int index_name_is_other(const struct index_state *, const char *, int);
87542508 719extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
4bd5b7da
JH
720
721/* do stat comparison even if CE_VALID is true */
722#define CE_MATCH_IGNORE_VALID 01
723/* do not check the contents but report dirty on racily-clean entries */
56cac48c
NTND
724#define CE_MATCH_RACY_IS_DIRTY 02
725/* do stat comparison even if CE_SKIP_WORKTREE is true */
726#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
2e2e7ec1
BK
727/* ignore non-existent files during stat update */
728#define CE_MATCH_IGNORE_MISSING 0x08
25762726
BK
729/* enable stat refresh */
730#define CE_MATCH_REFRESH 0x10
883e248b
BP
731/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
732#define CE_MATCH_IGNORE_FSMONITOR 0X20
733extern int ie_match_stat(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
734extern int ie_modified(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
4bd5b7da 735
c4ce46fc
JH
736#define HASH_WRITE_OBJECT 1
737#define HASH_FORMAT_CHECK 2
9472935d 738#define HASH_RENORMALIZE 4
e3506559 739extern int index_fd(struct object_id *oid, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
98e019b0 740extern int index_path(struct object_id *oid, const char *path, struct stat *st, unsigned flags);
c21d39d7
MH
741
742/*
743 * Record to sd the data from st that we use to check whether a file
744 * might have changed.
745 */
746extern void fill_stat_data(struct stat_data *sd, struct stat *st);
747
748/*
749 * Return 0 if st is consistent with a file not having been changed
750 * since sd was filled. If there are differences, return a
751 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
752 * INODE_CHANGED, and DATA_CHANGED.
753 */
754extern int match_stat_data(const struct stat_data *sd, struct stat *st);
ed4efab1
NTND
755extern int match_stat_data_racy(const struct index_state *istate,
756 const struct stat_data *sd, struct stat *st);
c21d39d7 757
415e96c8
JH
758extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
759
405e5b2f
LT
760#define REFRESH_REALLY 0x0001 /* ignore_valid */
761#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
762#define REFRESH_QUIET 0x0004 /* be quiet about it */
763#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
3f1b7b60 764#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
43673fdd 765#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
9b2d6149 766extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
1335d76e 767extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
405e5b2f 768
b74c90fb
769/*
770 * Opportunistically update the index but do not complain if we can't.
771 * The lockfile is always committed or rolled back.
772 */
ccdc4ec3 773extern void update_index_if_able(struct index_state *, struct lock_file *);
30ca07a2
JH
774
775extern int hold_locked_index(struct lock_file *, int);
5e7f56ac 776extern void set_alternate_index_output(const char *);
697cc8ef 777
a33fc72f 778extern int verify_index_checksum;
00ec50e5 779extern int verify_ce_order;
a33fc72f 780
2ae1c53b 781/* Environment bits from configuration mechanism */
17712991 782extern int trust_executable_bit;
1ce4790b 783extern int trust_ctime;
c08e4d5b 784extern int check_stat;
9378c161 785extern int quote_path_fully;
78a8d641 786extern int has_symlinks;
dce96489 787extern int minimum_abbrev, default_abbrev;
0a9b88b7 788extern int ignore_case;
5f73076c 789extern int assume_unchanged;
9f0bb90d 790extern int prefer_symlink_refs;
2f8acdb3 791extern int warn_ambiguous_refs;
25fba78d 792extern int warn_on_object_refname_ambiguity;
2ae1c53b 793extern const char *apply_default_whitespace;
86c91f91 794extern const char *apply_default_ignorewhitespace;
64589a03 795extern const char *git_attributes_file;
867ad08a 796extern const char *git_hooks_path;
12f6c308 797extern int zlib_compression_level;
960ccca6 798extern int core_compression_level;
8de7eeb5 799extern int pack_compression_level;
60bb8b14 800extern size_t packed_git_window_size;
77ccc5bb 801extern size_t packed_git_limit;
18bdec11 802extern size_t delta_base_cache_limit;
15366280 803extern unsigned long big_file_threshold;
568508e7 804extern unsigned long pack_size_limit_cfg;
afc711b8 805
4543926b
JK
806/*
807 * Accessors for the core.sharedrepository config which lazy-load the value
808 * from the config (if not already set). The "reset" function can be
809 * used to unset "set" or cached value, meaning that the value will be loaded
810 * fresh from the config file on the next call to get_shared_repository().
811 */
7875acb6
JK
812void set_shared_repository(int value);
813int get_shared_repository(void);
4543926b 814void reset_shared_repository(void);
7875acb6 815
afc711b8
MH
816/*
817 * Do replace refs need to be checked this run? This variable is
818 * initialized to true unless --no-replace-object is used or
819 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
820 * commands that do not want replace references to be active. As an
821 * optimization it is also set to false if replace references have
822 * been sought but there were none.
823 */
824extern int check_replace_refs;
58d121b2 825extern char *git_replace_ref_base;
afc711b8 826
aafe9fba 827extern int fsync_object_files;
671c9b7e 828extern int core_preload_index;
08aefc9e 829extern int core_apply_sparse_checkout;
76759c7d 830extern int precomposed_unicode;
a42643aa 831extern int protect_hfs;
2b4c6efc 832extern int protect_ntfs;
883e248b 833extern const char *core_fsmonitor;
17712991 834
49672f26
JK
835/*
836 * Include broken refs in all ref iterations, which will
837 * generally choke dangerous operations rather than letting
838 * them silently proceed without taking the broken ref into
839 * account.
840 */
841extern int ref_paranoia;
842
27344d6a
JK
843/*
844 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
845 */
846int use_optional_locks(void);
847
eff80a9f
JH
848/*
849 * The character that begins a commented line in user-editable file
850 * that is subject to stripspace.
851 */
852extern char comment_line_char;
84c9dc2c 853extern int auto_comment_line_char;
eff80a9f 854
f30afdab
JS
855/* Windows only */
856enum hide_dotfiles_type {
857 HIDE_DOTFILES_FALSE = 0,
858 HIDE_DOTFILES_TRUE,
859 HIDE_DOTFILES_DOTGITONLY
860};
861extern enum hide_dotfiles_type hide_dotfiles;
862
341fb286
CW
863enum log_refs_config {
864 LOG_REFS_UNSET = -1,
865 LOG_REFS_NONE = 0,
866 LOG_REFS_NORMAL,
867 LOG_REFS_ALWAYS
868};
869extern enum log_refs_config log_all_ref_updates;
870
9ed36cfa 871enum branch_track {
9188ed89 872 BRANCH_TRACK_UNSPECIFIED = -1,
9ed36cfa
JS
873 BRANCH_TRACK_NEVER = 0,
874 BRANCH_TRACK_REMOTE,
875 BRANCH_TRACK_ALWAYS,
876 BRANCH_TRACK_EXPLICIT,
4b05548f 877 BRANCH_TRACK_OVERRIDE
9ed36cfa
JS
878};
879
c998ae9b
DS
880enum rebase_setup_type {
881 AUTOREBASE_NEVER = 0,
882 AUTOREBASE_LOCAL,
883 AUTOREBASE_REMOTE,
4b05548f 884 AUTOREBASE_ALWAYS
c998ae9b
DS
885};
886
52153747 887enum push_default_type {
52153747
FAG
888 PUSH_DEFAULT_NOTHING = 0,
889 PUSH_DEFAULT_MATCHING,
b55e6775 890 PUSH_DEFAULT_SIMPLE,
53c40311 891 PUSH_DEFAULT_UPSTREAM,
f25950f3
CT
892 PUSH_DEFAULT_CURRENT,
893 PUSH_DEFAULT_UNSPECIFIED
52153747
FAG
894};
895
9ed36cfa 896extern enum branch_track git_branch_track;
c998ae9b 897extern enum rebase_setup_type autorebase;
52153747 898extern enum push_default_type push_default;
9ed36cfa 899
348df166
JS
900enum object_creation_mode {
901 OBJECT_CREATION_USES_HARDLINKS = 0,
4b05548f 902 OBJECT_CREATION_USES_RENAMES = 1
348df166
JS
903};
904
905extern enum object_creation_mode object_creation_mode;
be66a6c4 906
a97a7468
JS
907extern char *notes_ref_name;
908
7f3140cd
JS
909extern int grafts_replace_parents;
910
00a09d57
JK
911/*
912 * GIT_REPO_VERSION is the version we write by default. The
913 * _READ variant is the highest number we know how to
914 * handle.
915 */
ab9cb76f 916#define GIT_REPO_VERSION 0
00a09d57 917#define GIT_REPO_VERSION_READ 1
067fbd41 918extern int repository_format_precious_objects;
75b97fec 919extern char *repository_format_partial_clone;
1e1e39b3 920extern const char *core_partial_clone_filter_default;
4b0d1eeb 921
2cc7c2c7
JK
922struct repository_format {
923 int version;
924 int precious_objects;
75b97fec 925 char *partial_clone; /* value of extensions.partialclone */
2cc7c2c7 926 int is_bare;
78a67668 927 int hash_algo;
2cc7c2c7
JK
928 char *work_tree;
929 struct string_list unknown_extensions;
930};
931
932/*
933 * Read the repository format characteristics from the config file "path" into
934 * "format" struct. Returns the numeric version. On error, -1 is returned,
935 * format->version is set to -1, and all other fields in the struct are
936 * undefined.
937 */
938int read_repository_format(struct repository_format *format, const char *path);
939
940/*
941 * Verify that the repository described by repository_format is something we
942 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
943 * any errors encountered.
944 */
945int verify_repository_format(const struct repository_format *format,
946 struct strbuf *err);
947
4b0d1eeb
JK
948/*
949 * Check the repository format version in the path found in get_git_dir(),
950 * and die if it is a version we don't understand. Generally one would
951 * set_git_dir() before calling this, and use it only for "are we in a valid
952 * repo?".
953 */
954extern void check_repository_format(void);
ab9cb76f 955
734aab75
LT
956#define MTIME_CHANGED 0x0001
957#define CTIME_CHANGED 0x0002
958#define OWNER_CHANGED 0x0004
959#define MODE_CHANGED 0x0008
960#define INODE_CHANGED 0x0010
961#define DATA_CHANGED 0x0020
8ae0a8c5 962#define TYPE_CHANGED 0x0040
e83c5163 963
d40d535b 964/*
ea657730
CC
965 * Put in `buf` the name of the file in the local object database that
966 * would be used to store a loose object with the specified sha1.
d40d535b 967 */
ea657730 968extern void sha1_file_name(struct strbuf *buf, 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{
0b006014 993 return memcmp(sha1, sha2, GIT_SHA1_RAWSZ);
0bef57ee 994}
1a812f3a 995
aa1c6fdf 996static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
997{
998 return hashcmp(oid1->hash, oid2->hash);
999}
1000
1a812f3a 1001static inline int is_null_sha1(const unsigned char *sha1)
a89fccd2 1002{
1a812f3a 1003 return !hashcmp(sha1, null_sha1);
a89fccd2 1004}
1a812f3a 1005
aa1c6fdf 1006static inline int is_null_oid(const struct object_id *oid)
1007{
1008 return !hashcmp(oid->hash, null_sha1);
1009}
1010
e702496e
SP
1011static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
1012{
aa1c6fdf 1013 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
e702496e 1014}
aa1c6fdf 1015
1016static inline void oidcpy(struct object_id *dst, const struct object_id *src)
1017{
1018 hashcpy(dst->hash, src->hash);
e702496e 1019}
aa1c6fdf 1020
1c41c82b
BW
1021static inline struct object_id *oiddup(const struct object_id *src)
1022{
1023 struct object_id *dst = xmalloc(sizeof(struct object_id));
1024 oidcpy(dst, src);
1025 return dst;
1026}
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{
eb0ccfd7 1058 return !hashcmp(sha1, the_hash_algo->empty_blob->hash);
f8582cad
JK
1059}
1060
8576fde6
JK
1061static inline int is_empty_blob_oid(const struct object_id *oid)
1062{
eb0ccfd7 1063 return !oidcmp(oid, the_hash_algo->empty_blob);
8576fde6
JK
1064}
1065
1066static inline int is_empty_tree_sha1(const unsigned char *sha1)
1067{
eb0ccfd7 1068 return !hashcmp(sha1, the_hash_algo->empty_tree->hash);
8576fde6
JK
1069}
1070
1071static inline int is_empty_tree_oid(const struct object_id *oid)
1072{
eb0ccfd7 1073 return !oidcmp(oid, the_hash_algo->empty_tree);
8576fde6
JK
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
2491f77b
JK
1193/*
1194 * Returns true iff "str" could be confused as a command-line option when
1195 * passed to a sub-program like "ssh". Note that this has nothing to do with
1196 * shell-quoting, which should be handled separately; we're assuming here that
1197 * the string makes it verbatim to the sub-program.
1198 */
1199int looks_like_command_line_option(const char *str);
1200
ea19289b
PT
1201/**
1202 * Return a newly allocated string with the evaluation of
1203 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1204 * "$HOME/.config/git/$filename". Return NULL upon error.
1205 */
1206extern char *xdg_config_home(const char *filename);
1207
e7f136bf
DL
1208/**
1209 * Return a newly allocated string with the evaluation of
1210 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1211 * "$HOME/.cache/git/$filename". Return NULL upon error.
1212 */
1213extern char *xdg_cache_home(const char *filename);
1214
1f0c0d36
JT
1215extern void *read_sha1_file_extended(const unsigned char *sha1,
1216 enum object_type *type,
1217 unsigned long *size, int lookup_replace);
f5552aee
CC
1218static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1219{
1f0c0d36 1220 return read_sha1_file_extended(sha1, type, size, 1);
5bf29b95 1221}
1f91e79c
MH
1222
1223/*
1224 * This internal function is only declared here for the benefit of
1225 * lookup_replace_object(). Please do not call it directly.
1226 */
e1111cef 1227extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1f91e79c
MH
1228
1229/*
1230 * If object sha1 should be replaced, return the replacement object's
1231 * name (replaced recursively, if necessary). The return value is
1232 * either sha1 or a pointer to a permanently-allocated value. When
1233 * object replacement is suppressed, always return sha1.
1234 */
e1111cef
JH
1235static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1236{
afc711b8 1237 if (!check_replace_refs)
e1111cef
JH
1238 return sha1;
1239 return do_lookup_replace_object(sha1);
f5552aee 1240}
1f91e79c 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);
da77611d 1246extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, struct object_id *oid, 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
5d6ccf5c 1255extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 1256
cb5add58 1257extern int finalize_object_file(const char *tmpfile, const char *filename);
8237b185 1258
f6371f92
JK
1259/*
1260 * Open the loose object at path, check its sha1, and return the contents,
1261 * type, and size. If the object is a blob, then "contents" may return NULL,
1262 * to allow streaming of large blobs.
1263 *
1264 * Returns 0 on success, negative on error (details may be written to stderr).
1265 */
1266int read_loose_object(const char *path,
1267 const unsigned char *expected_sha1,
1268 enum object_type *type,
1269 unsigned long *size,
1270 void **contents);
1271
d40d535b 1272/*
e83e71c5
JT
1273 * Convenience for sha1_object_info_extended() with a NULL struct
1274 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass
1275 * nonzero flags to also set other flags.
d40d535b 1276 */
0eeb077b
JK
1277extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1278static inline int has_sha1_file(const unsigned char *sha1)
1279{
1280 return has_sha1_file_with_flags(sha1, 0);
1281}
d40d535b 1282
b419aa25 1283/* Same as the above, except for struct object_id. */
1284extern int has_object_file(const struct object_id *oid);
5827a035 1285extern int has_object_file_with_flags(const struct object_id *oid, int flags);
b419aa25 1286
d40d535b
MH
1287/*
1288 * Return true iff an alternate object database has a loose object
1289 * with the specified name. This function does not respect replace
1290 * references.
1291 */
0f4dc14a 1292extern int has_loose_object_nonlocal(const unsigned char *sha1);
8237b185 1293
40d52ff7
JK
1294extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1295
6a5e6f5e
CC
1296/* Helper to check and "touch" a file */
1297extern int check_and_freshen_file(const char *fn, int freshen);
1298
192a6be2
LT
1299extern const signed char hexval_table[256];
1300static inline unsigned int hexval(unsigned char c)
e49521b5
JH
1301{
1302 return hexval_table[c];
1303}
1304
d2330973
RS
1305/*
1306 * Convert two consecutive hexadecimal digits into a char. Return a
1307 * negative value on error. Don't run over the end of short strings.
1308 */
1309static inline int hex2chr(const char *s)
1310{
356a293f
RJ
1311 unsigned int val = hexval(s[0]);
1312 return (val & ~0xf) ? val : (val << 4) | hexval(s[1]);
d2330973
RS
1313}
1314
e83c5163 1315/* Convert to/from hex/sha1 representation */
dce96489
LT
1316#define MINIMUM_ABBREV minimum_abbrev
1317#define DEFAULT_ABBREV default_abbrev
46a6c262 1318
65acfeac
JH
1319/* used when the code does not know or care what the default abbrev is */
1320#define FALLBACK_DEFAULT_ABBREV 7
1321
573285e5
CP
1322struct object_context {
1323 unsigned char tree[20];
573285e5 1324 unsigned mode;
c4ec9677
DT
1325 /*
1326 * symlink_path is only used by get_tree_entry_follow_symlinks,
1327 * and only for symlinks that point outside the repository.
1328 */
1329 struct strbuf symlink_path;
dc944b65 1330 /*
321c89bf 1331 * If GET_OID_RECORD_PATH is set, this will record path (if any)
dc944b65
JK
1332 * found when resolving the name. The caller is responsible for
1333 * releasing the memory.
1334 */
1335 char *path;
573285e5
CP
1336};
1337
321c89bf 1338#define GET_OID_QUIETLY 01
1339#define GET_OID_COMMIT 02
1340#define GET_OID_COMMITTISH 04
1341#define GET_OID_TREE 010
1342#define GET_OID_TREEISH 020
1343#define GET_OID_BLOB 040
1344#define GET_OID_FOLLOW_SYMLINKS 0100
1345#define GET_OID_RECORD_PATH 0200
1346#define GET_OID_ONLY_TO_DIE 04000
1347
1348#define GET_OID_DISAMBIGUATORS \
1349 (GET_OID_COMMIT | GET_OID_COMMITTISH | \
1350 GET_OID_TREE | GET_OID_TREEISH | \
1351 GET_OID_BLOB)
d4e85a1a 1352
2764fd93 1353extern int get_oid(const char *str, struct object_id *oid);
e82caf38 1354extern int get_oid_commit(const char *str, struct object_id *oid);
1355extern int get_oid_committish(const char *str, struct object_id *oid);
1356extern int get_oid_tree(const char *str, struct object_id *oid);
1357extern int get_oid_treeish(const char *str, struct object_id *oid);
1358extern int get_oid_blob(const char *str, struct object_id *oid);
8c135ea2 1359extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
e82caf38 1360extern int get_oid_with_context(const char *str, unsigned flags, struct object_id *oid, struct object_context *oc);
d4e85a1a 1361
2764fd93 1362
1b7ba794 1363typedef int each_abbrev_fn(const struct object_id *oid, void *);
957d7406 1364extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
d4e85a1a 1365
5b33cb1f
JK
1366extern int set_disambiguate_hint_config(const char *var, const char *value);
1367
d4e85a1a
MH
1368/*
1369 * Try to read a SHA1 in hexadecimal format from the 40 characters
1370 * starting at hex. Write the 20-byte result to sha1 in binary form.
1371 * Return 0 on success. Reading stops if a NUL is encountered in the
1372 * input, so it is safe to pass this function an arbitrary
1373 * null-terminated string.
1374 */
197ee8c9 1375extern int get_sha1_hex(const char *hex, unsigned char *sha1);
aa1c6fdf 1376extern int get_oid_hex(const char *hex, struct object_id *sha1);
d4e85a1a 1377
0ec21865
RS
1378/*
1379 * Read `len` pairs of hexadecimal digits from `hex` and write the
1380 * values to `binary` as `len` bytes. Return 0 on success, or -1 if
1381 * the input does not consist of hex digits).
1382 */
1383extern int hex_to_bytes(unsigned char *binary, const char *hex, size_t len);
1384
af49c6d0
JK
1385/*
1386 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1387 * and writes the NUL-terminated output to the buffer `out`, which must be at
1388 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1389 * convenience.
1390 *
1391 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1392 * buffers, making it safe to make multiple calls for a single statement, like:
1393 *
1394 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1395 */
1396extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
55c529a7 1397extern char *oid_to_hex_r(char *out, const struct object_id *oid);
197ee8c9 1398extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
aa1c6fdf 1399extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
7cb36842 1400
605f430e 1401/*
1402 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1403 * pointer specified by end when parsing stops. The resulting object ID is
1404 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1405 * other invalid character. end is only updated on success; otherwise, it is
1406 * unmodified.
1407 */
1408extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
1409
e322b60d
JK
1410/*
1411 * This reads short-hand syntax that not only evaluates to a commit
1412 * object name, but also can act as if the end user spelled the name
1413 * of the branch from the command line.
1414 *
1415 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1416 * places the name of the branch in the given buf and returns the
1417 * number of characters parsed if successful.
1418 *
1419 * - "<branch>@{upstream}" finds the name of the other ref that
1420 * <branch> is configured to merge with (missing <branch> defaults
1421 * to the current branch), and places the name of the branch in the
1422 * given buf and returns the number of characters parsed if
1423 * successful.
1424 *
1425 * If the input is not of the accepted format, it returns a negative
1426 * number to signal an error.
1427 *
1428 * If the input was ok but there are not N branch switches in the
1429 * reflog, it returns 0.
0e9f62da
JK
1430 *
1431 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1432 * expansions: local branches ("refs/heads/"), remote branches
1433 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1434 * allowed, even ones to refs outside of those namespaces.
e322b60d 1435 */
0e9f62da
JK
1436#define INTERPRET_BRANCH_LOCAL (1<<0)
1437#define INTERPRET_BRANCH_REMOTE (1<<1)
1438#define INTERPRET_BRANCH_HEAD (1<<2)
1439extern int interpret_branch_name(const char *str, int len, struct strbuf *,
1440 unsigned allowed);
151b2911 1441extern int get_oid_mb(const char *str, struct object_id *oid);
e86eb666 1442
c847f537 1443extern int validate_headref(const char *ref);
e83c5163 1444
958ba6c9 1445extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
0ab9e1e8 1446extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
ccdd4a0f 1447extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
b60e188c 1448extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
e83c5163 1449
40469ee9 1450extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 1451 const char *required_type,
40469ee9
JH
1452 unsigned long *size,
1453 unsigned char *sha1_ret);
f4913f91 1454
81776315
JH
1455extern struct object *peel_to_type(const char *name, int namelen,
1456 struct object *o, enum object_type);
1457
a5481a6c
JK
1458struct date_mode {
1459 enum date_mode_type {
1460 DATE_NORMAL = 0,
1461 DATE_RELATIVE,
1462 DATE_SHORT,
a5481a6c
JK
1463 DATE_ISO8601,
1464 DATE_ISO8601_STRICT,
1465 DATE_RFC2822,
aa1462cc 1466 DATE_STRFTIME,
642833db
JK
1467 DATE_RAW,
1468 DATE_UNIX
a5481a6c 1469 } type;
aa1462cc 1470 const char *strftime_fmt;
add00ba2 1471 int local;
73013afd
JH
1472};
1473
a5481a6c
JK
1474/*
1475 * Convenience helper for passing a constant type, like:
1476 *
1477 * show_date(t, tz, DATE_MODE(NORMAL));
1478 */
1479#define DATE_MODE(t) date_mode_from_type(DATE_##t)
1480struct date_mode *date_mode_from_type(enum date_mode_type type);
1481
dddbad72
JS
1482const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);
1483void show_date_relative(timestamp_t time, int tz, const struct timeval *now,
7d29afd4 1484 struct strbuf *timebuf);
c33ddc2e 1485int parse_date(const char *date, struct strbuf *out);
dddbad72
JS
1486int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);
1487int parse_expiry_date(const char *date, timestamp_t *timestamp);
c33ddc2e 1488void datestamp(struct strbuf *out);
93cfa7c7 1489#define approxidate(s) approxidate_careful((s), NULL)
dddbad72
JS
1490timestamp_t approxidate_careful(const char *, int *);
1491timestamp_t approxidate_relative(const char *date, const struct timeval *now);
a5481a6c 1492void parse_date_format(const char *format, struct date_mode *mode);
dddbad72 1493int date_overflows(timestamp_t date);
ecee9d9e 1494
f9bc573f 1495#define IDENT_STRICT 1
b9f0ac17 1496#define IDENT_NO_DATE 2
c15e1987 1497#define IDENT_NO_NAME 4
749be728
JH
1498extern const char *git_author_info(int);
1499extern const char *git_committer_info(int);
798123af 1500extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
d9ccfe77 1501extern const char *fmt_name(const char *name, const char *email);
9830534e 1502extern const char *ident_default_name(void);
bcb2b004 1503extern const char *ident_default_email(void);
44fcb497 1504extern const char *git_editor(void);
64778d24 1505extern const char *git_pager(int stdout_is_tty);
a64f213d 1506extern int is_terminal_dumb(void);
9597921b 1507extern int git_ident_config(const char *, const char *, void *);
4d9c7e6f 1508extern void reset_ident_date(void);
6aa33f40 1509
4b340cfa
JH
1510struct ident_split {
1511 const char *name_begin;
1512 const char *name_end;
1513 const char *mail_begin;
1514 const char *mail_end;
1515 const char *date_begin;
1516 const char *date_end;
1517 const char *tz_begin;
1518 const char *tz_end;
1519};
1520/*
1521 * Signals an success with 0, but time part of the result may be NULL
1522 * if the input lacks timestamp and zone
1523 */
1524extern int split_ident_line(struct ident_split *, const char *, int);
1525
d1053246
JK
1526/*
1527 * Like show_date, but pull the timestamp and tz parameters from
1528 * the ident_split. It will also sanity-check the values and produce
1529 * a well-known sentinel date if they appear bogus.
1530 */
a5481a6c
JK
1531const char *show_ident_date(const struct ident_split *id,
1532 const struct date_mode *mode);
d1053246 1533
662cc30c
JK
1534/*
1535 * Compare split idents for equality or strict ordering. Note that we
1536 * compare only the ident part of the line, ignoring any timestamp.
1537 *
1538 * Because there are two fields, we must choose one as the primary key; we
1539 * currently arbitrarily pick the email.
1540 */
1541extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1542
12dccc16 1543struct checkout {
d4a2024a 1544 struct index_state *istate;
12dccc16
LT
1545 const char *base_dir;
1546 int base_dir_len;
2841e8f8 1547 struct delayed_checkout *delayed_checkout;
12dccc16
LT
1548 unsigned force:1,
1549 quiet:1,
1550 not_new:1,
1551 refresh_cache:1;
1552};
68e3d629 1553#define CHECKOUT_INIT { NULL, "" }
12dccc16 1554
af2a651d 1555#define TEMPORARY_FILENAME_LENGTH 25
efbc5831 1556extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
2841e8f8
LS
1557extern void enable_delayed_checkout(struct checkout *state);
1558extern int finish_delayed_checkout(struct checkout *state);
b9fd2846
LT
1559
1560struct cache_def {
e7c73053 1561 struct strbuf path;
b9fd2846
LT
1562 int flags;
1563 int track_flags;
1564 int prefix_len_stat_func;
1565};
e7c73053 1566#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
2a608391 1567static inline void cache_def_clear(struct cache_def *cache)
e7c73053
KB
1568{
1569 strbuf_release(&cache->path);
1570}
b9fd2846 1571
57199892 1572extern int has_symlink_leading_path(const char *name, int len);
b9fd2846 1573extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
f66caaf9 1574extern int check_leading_path(const char *name, int len);
57199892 1575extern int has_dirs_only_path(const char *name, int len, int prefix_len);
78478927
KB
1576extern void schedule_dir_for_removal(const char *name, int len);
1577extern void remove_scheduled_dirs(void);
12dccc16 1578
c41ee586
SP
1579struct pack_window {
1580 struct pack_window *next;
1581 unsigned char *base;
1582 off_t offset;
1583 size_t len;
1584 unsigned int last_used;
1585 unsigned int inuse_cnt;
1586};
1587
f3bf9224 1588struct pack_entry {
c4001d92 1589 off_t offset;
f3bf9224
JH
1590 unsigned char sha1[20];
1591 struct packed_git *p;
1592};
1593
82c9d661 1594/*
892e723a
JK
1595 * Create a temporary file rooted in the object database directory, or
1596 * die on failure. The filename is taken from "pattern", which should have the
1597 * usual "XXXXXX" trailer, and the resulting filename is written into the
1598 * "template" buffer. Returns the open descriptor.
82c9d661 1599 */
594fa999 1600extern int odb_mkstemp(struct strbuf *template, const char *pattern);
82c9d661
JK
1601
1602/*
eaeefc32
JK
1603 * Create a pack .keep file named "name" (which should generally be the output
1604 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1605 * error.
82c9d661 1606 */
eaeefc32 1607extern int odb_pack_keep(const char *name);
82c9d661 1608
27e1e22d
JK
1609/*
1610 * Iterate over the files in the loose-object parts of the object
1611 * directory "path", triggering the following callbacks:
1612 *
1613 * - loose_object is called for each loose object we find.
1614 *
1615 * - loose_cruft is called for any files that do not appear to be
1616 * loose objects. Note that we only look in the loose object
1617 * directories "objects/[0-9a-f]{2}/", so we will not report
1618 * "objects/foobar" as cruft.
1619 *
1620 * - loose_subdir is called for each top-level hashed subdirectory
1621 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1622 * after the objects in the directory are processed.
1623 *
1624 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1625 * will end the iteration.
e6f875e0
JK
1626 *
1627 * In the "buf" variant, "path" is a strbuf which will also be used as a
1628 * scratch buffer, but restored to its original contents before
1629 * the function returns.
27e1e22d 1630 */
76c1d9a0 1631typedef int each_loose_object_fn(const struct object_id *oid,
27e1e22d
JK
1632 const char *path,
1633 void *data);
1634typedef int each_loose_cruft_fn(const char *basename,
1635 const char *path,
1636 void *data);
70c49050 1637typedef int each_loose_subdir_fn(unsigned int nr,
27e1e22d
JK
1638 const char *path,
1639 void *data);
70c49050 1640int for_each_file_in_obj_subdir(unsigned int subdir_nr,
cc817ca3
RS
1641 struct strbuf *path,
1642 each_loose_object_fn obj_cb,
1643 each_loose_cruft_fn cruft_cb,
1644 each_loose_subdir_fn subdir_cb,
1645 void *data);
27e1e22d
JK
1646int for_each_loose_file_in_objdir(const char *path,
1647 each_loose_object_fn obj_cb,
1648 each_loose_cruft_fn cruft_cb,
1649 each_loose_subdir_fn subdir_cb,
1650 void *data);
e6f875e0
JK
1651int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1652 each_loose_object_fn obj_cb,
1653 each_loose_cruft_fn cruft_cb,
1654 each_loose_subdir_fn subdir_cb,
1655 void *data);
27e1e22d 1656
660c889e 1657/*
7709f468 1658 * Iterate over loose objects in both the local
1385bb7b
JK
1659 * repository and any alternates repositories (unless the
1660 * LOCAL_ONLY flag is set).
660c889e 1661 */
1385bb7b 1662#define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1385bb7b 1663extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
660c889e 1664
9a490590
JH
1665struct object_info {
1666 /* Request */
5b086407 1667 enum object_type *typep;
9a490590 1668 unsigned long *sizep;
166df26f 1669 off_t *disk_sizep;
5d642e75 1670 unsigned char *delta_base_sha1;
46f03448 1671 struct strbuf *typename;
c84a1f3e 1672 void **contentp;
9a490590
JH
1673
1674 /* Response */
1675 enum {
1676 OI_CACHED,
1677 OI_LOOSE,
5266d369
JH
1678 OI_PACKED,
1679 OI_DBCACHED
9a490590
JH
1680 } whence;
1681 union {
1682 /*
1683 * struct {
1684 * ... Nothing to expose in this case
1685 * } cached;
1686 * struct {
1687 * ... Nothing to expose in this case
1688 * } loose;
1689 */
1690 struct {
1691 struct packed_git *pack;
1692 off_t offset;
1693 unsigned int is_delta;
1694 } packed;
1695 } u;
1696};
27b5c1a0
JK
1697
1698/*
1699 * Initializer for a "struct object_info" that wants no items. You may
1700 * also memset() the memory to all-zeroes.
1701 */
1702#define OBJECT_INFO_INIT {NULL}
1703
1f0c0d36
JT
1704/* Invoke lookup_replace_object() on the given hash */
1705#define OBJECT_INFO_LOOKUP_REPLACE 1
19fc5e84
JT
1706/* Allow reading from a loose object file of unknown/bogus type */
1707#define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 2
dfdd4afc
JT
1708/* Do not check cached storage */
1709#define OBJECT_INFO_SKIP_CACHED 4
1710/* Do not retry packed storage after checking packed and loose storage */
1711#define OBJECT_INFO_QUICK 8
de7b5d62 1712extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
9a217f2a 1713
8b4c0103
JT
1714/*
1715 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing
1716 * blobs. This has a difference only if extensions.partialClone is set.
1717 *
1718 * Its default value is 1.
1719 */
1720extern int fetch_if_missing;
1721
8f3f9b09
JH
1722/* Dumb servers support */
1723extern int update_server_info(int);
1724
a6fa5992
PN
1725extern const char *get_log_output_encoding(void);
1726extern const char *get_commit_output_encoding(void);
1727
dae6c322
CC
1728/*
1729 * This is a hack for test programs like test-dump-untracked-cache to
1730 * ensure that they do not modify the untracked cache when reading it.
1731 * Do not use it otherwise!
1732 */
1733extern int ignore_untracked_cache_config;
3c8687a7 1734
d6991cee
JK
1735extern int committer_ident_sufficiently_given(void);
1736extern int author_ident_sufficiently_given(void);
e1b10391 1737
1a8f2741 1738extern const char *git_commit_encoding;
3a55602e 1739extern const char *git_log_output_encoding;
d551a488 1740extern const char *git_mailmap_file;
08610900 1741extern const char *git_mailmap_blob;
4e72dcec 1742
06f59e9f
TT
1743/* IO helper functions */
1744extern void maybe_flush_or_die(FILE *, const char *);
9540ce50
JK
1745__attribute__((format (printf, 2, 3)))
1746extern void fprintf_or_die(FILE *, const char *fmt, ...);
00b7cbfc
JH
1747
1748#define COPY_READ_ERROR (-2)
1749#define COPY_WRITE_ERROR (-3)
f3123c4a 1750extern int copy_fd(int ifd, int ofd);
1468bd47 1751extern int copy_file(const char *dst, const char *src, int mode);
f7835a25 1752extern int copy_file_with_time(const char *dst, const char *src, int mode);
00b7cbfc 1753
7230e6d0 1754extern void write_or_die(int fd, const void *buf, size_t count);
4c81b03e 1755extern void fsync_or_die(int fd, const char *);
ad897215 1756
2b7ca830
JM
1757extern ssize_t read_in_full(int fd, void *buf, size_t count);
1758extern ssize_t write_in_full(int fd, const void *buf, size_t count);
426ddeea
YM
1759extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1760
2b7ca830
JM
1761static inline ssize_t write_str_in_full(int fd, const char *str)
1762{
1763 return write_in_full(fd, str, strlen(str));
1764}
12d6ce1d 1765
52563d7e
JK
1766/**
1767 * Open (and truncate) the file at path, write the contents of buf to it,
1768 * and close it. Dies if any errors are encountered.
1769 */
1770extern void write_file_buf(const char *path, const char *buf, size_t len);
1771
e04d08a4
JK
1772/**
1773 * Like write_file_buf(), but format the contents into a buffer first.
1774 * Additionally, write_file() will append a newline if one is not already
1775 * present, making it convenient to write text files:
1776 *
1777 * write_file(path, "counter: %d", ctr);
1778 */
1779__attribute__((format (printf, 2, 3)))
ef22318c 1780extern void write_file(const char *path, const char *fmt, ...);
2b7ca830 1781
f67b45f8
LT
1782/* pager.c */
1783extern void setup_pager(void);
6e9af863 1784extern int pager_in_use(void);
aa086eb8 1785extern int pager_use_color;
ad6c3739 1786extern int term_columns(void);
d306f3d3 1787extern int decimal_width(uintmax_t);
4914c962 1788extern int check_pager_config(const char *cmd);
3e3a4a41 1789extern void prepare_pager_args(struct child_process *, const char *pager);
f67b45f8 1790
ee9601e6 1791extern const char *editor_program;
d3e7da89 1792extern const char *askpass_program;
dfb068be 1793extern const char *excludes_file;
4d87b9c5 1794
051308f6 1795/* base85 */
f9815772
JM
1796int decode_85(char *dst, const char *line, int linelen);
1797void encode_85(char *buf, const unsigned char *data, int bytes);
051308f6 1798
855419f7 1799/* alloc.c */
100c5f3b
LT
1800extern void *alloc_blob_node(void);
1801extern void *alloc_tree_node(void);
1802extern void *alloc_commit_node(void);
1803extern void *alloc_tag_node(void);
1804extern void *alloc_object_node(void);
855419f7 1805extern void alloc_report(void);
94d5a22c 1806extern unsigned int alloc_commit_index(void);
855419f7 1807
5991a55c 1808/* pkt-line.c */
bbc30f99 1809void packet_trace_identity(const char *prog);
6ce4e61f 1810
b6ec1d61 1811/* add */
7ae02a30
AR
1812/*
1813 * return 0 if success, 1 - if addition of a file failed and
1814 * ADD_FILES_IGNORE_ERRORS was specified in flags
1815 */
610d55af 1816int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
b6ec1d61 1817
aecbf914
JH
1818/* diff.c */
1819extern int diff_auto_refresh_index;
1820
68faf689 1821/* match-trees.c */
82db3d44 1822void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
1823void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
68faf689 1824
a9cc857a
JH
1825/*
1826 * whitespace rules.
1827 * used by both diff and apply
f4b05a49 1828 * last two digits are tab width
a9cc857a 1829 */
f4b05a49
JS
1830#define WS_BLANK_AT_EOL 0100
1831#define WS_SPACE_BEFORE_TAB 0200
1832#define WS_INDENT_WITH_NON_TAB 0400
1833#define WS_CR_AT_EOL 01000
1834#define WS_BLANK_AT_EOF 02000
1835#define WS_TAB_IN_INDENT 04000
aeb84b05 1836#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
f4b05a49
JS
1837#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1838#define WS_TAB_WIDTH_MASK 077
091f8e28
SB
1839/* All WS_* -- when extended, adapt diff.c emit_symbol */
1840#define WS_RULE_MASK 07777
cf1b7869
JH
1841extern unsigned whitespace_rule_cfg;
1842extern unsigned whitespace_rule(const char *);
1843extern unsigned parse_whitespace_rule(const char *);
8f8841e9
JH
1844extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1845extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
c1795bb0 1846extern char *whitespace_error_string(unsigned ws);
d511bd33 1847extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
877f23cc 1848extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
f4b05a49 1849#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
a9cc857a 1850
ee425e46 1851/* ls-files */
312c984a
BW
1852void overlay_tree_on_index(struct index_state *istate,
1853 const char *tree_name, const char *prefix);
ee425e46 1854
94351118 1855char *alias_lookup(const char *alias);
0989fe96 1856int split_cmdline(char *cmdline, const char ***argv);
ad9ac6db
GB
1857/* Takes a negative value returned by split_cmdline */
1858const char *split_cmdline_strerror(int cmdline_errno);
94351118 1859
46c3cd44 1860/* setup.c */
e37c1329 1861struct startup_info {
a60645f9 1862 int have_repository;
f07d6a1a 1863 const char *prefix;
e37c1329
NTND
1864};
1865extern struct startup_info *startup_info;
1866
db699a8a
NTND
1867/* merge.c */
1868struct commit_list;
1869int try_merge_command(const char *strategy, size_t xopts_nr,
1870 const char **xopts, struct commit_list *common,
1871 const char *head_arg, struct commit_list *remotes);
f06e90da 1872int checkout_fast_forward(const struct object_id *from,
1873 const struct object_id *to,
db699a8a
NTND
1874 int overwrite_ignore);
1875
cac42b26 1876
38f865c2
JK
1877int sane_execvp(const char *file, char *const argv[]);
1878
38612532
MH
1879/*
1880 * A struct to encapsulate the concept of whether a file has changed
1881 * since we last checked it. This uses criteria similar to those used
1882 * for the index.
1883 */
1884struct stat_validity {
1885 struct stat_data *sd;
1886};
1887
1888void stat_validity_clear(struct stat_validity *sv);
1889
1890/*
1891 * Returns 1 if the path is a regular file (or a symlink to a regular
1892 * file) and matches the saved stat_validity, 0 otherwise. A missing
1893 * or inaccessible file is considered a match if the struct was just
1894 * initialized, or if the previous update found an inaccessible file.
1895 */
1896int stat_validity_check(struct stat_validity *sv, const char *path);
1897
1898/*
1899 * Update the stat_validity from a file opened at descriptor fd. If
1900 * the file is missing, inaccessible, or not a regular file, then
1901 * future calls to stat_validity_check will match iff one of those
1902 * conditions continues to be true.
1903 */
1904void stat_validity_update(struct stat_validity *sv, int fd);
1905
9ef176b5 1906int versioncmp(const char *s1, const char *s2);
2024d317 1907void sleep_millisec(int millisec);
9ef176b5 1908
eb33876c
DT
1909/*
1910 * Create a directory and (if share is nonzero) adjust its permissions
1911 * according to the shared_repository setting. Only use this for
1912 * directories under $GIT_DIR. Don't use it for working tree
1913 * directories.
1914 */
1915void safe_create_dir(const char *dir, int share);
1916
a2cd709d
AR
1917/*
1918 * Should we print an ellipsis after an abbreviated SHA-1 value
1919 * when doing diff-raw output or indicating a detached HEAD?
1920 */
1921extern int print_sha1_ellipsis(void);
1922
e83c5163 1923#endif /* CACHE_H */