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