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