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