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