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