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