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