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