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