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