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