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