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