add_packed_git: convert strcpy into xsnprintf
[git/git.git] / cache.h
CommitLineData
e83c5163
LT
1#ifndef CACHE_H
2#define CACHE_H
3
4050c0df 4#include "git-compat-util.h"
5ecd293d 5#include "strbuf.h"
e05881a4 6#include "hashmap.h"
75194438 7#include "advice.h"
65784830 8#include "gettext.h"
d1bf0e08 9#include "convert.h"
5991a55c 10#include "trace.h"
155ef25f 11#include "string-list.h"
e83c5163 12
cef661fc 13#include SHA1_HEADER
9126f009
NP
14#ifndef git_SHA_CTX
15#define git_SHA_CTX SHA_CTX
16#define git_SHA1_Init SHA1_Init
17#define git_SHA1_Update SHA1_Update
18#define git_SHA1_Final SHA1_Final
19#endif
e83c5163 20
9126f009 21#include <zlib.h>
ef49a7a0
JH
22typedef struct git_zstream {
23 z_stream z;
24 unsigned long avail_in;
25 unsigned long avail_out;
26 unsigned long total_in;
27 unsigned long total_out;
28 unsigned char *next_in;
29 unsigned char *next_out;
30} git_zstream;
31
32void git_inflate_init(git_zstream *);
33void git_inflate_init_gzip_only(git_zstream *);
34void git_inflate_end(git_zstream *);
35int git_inflate(git_zstream *, int flush);
36
37void git_deflate_init(git_zstream *, int level);
38void git_deflate_init_gzip(git_zstream *, int level);
c3c2e1a0 39void git_deflate_init_raw(git_zstream *, int level);
ef49a7a0 40void git_deflate_end(git_zstream *);
568508e7 41int git_deflate_abort(git_zstream *);
ef49a7a0
JH
42int git_deflate_end_gently(git_zstream *);
43int git_deflate(git_zstream *, int flush);
44unsigned long git_deflate_bound(git_zstream *, unsigned long);
39c68542 45
5f7817c8 46/* The length in bytes and in hex digits of an object name (SHA-1 value). */
47#define GIT_SHA1_RAWSZ 20
48#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
49
50struct object_id {
51 unsigned char hash[GIT_SHA1_RAWSZ];
52};
53
962554c6 54#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
b6829693
ET
55#define DTYPE(de) ((de)->d_type)
56#else
0bdd79af
JH
57#undef DT_UNKNOWN
58#undef DT_DIR
59#undef DT_REG
60#undef DT_LNK
b6829693
ET
61#define DT_UNKNOWN 0
62#define DT_DIR 1
63#define DT_REG 2
a15c1c60 64#define DT_LNK 3
b6829693
ET
65#define DTYPE(de) DT_UNKNOWN
66#endif
67
40689ae1
MK
68/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
69#define S_IFINVALID 0030000
70
9eec4795
LT
71/*
72 * A "directory link" is a link to another git directory.
73 *
74 * The value 0160000 is not normally a valid mode, and
75 * also just happens to be S_IFDIR + S_IFLNK
9eec4795 76 */
302b9282
MW
77#define S_IFGITLINK 0160000
78#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
9eec4795 79
72441af7
KS
80/*
81 * Some mode bits are also used internally for computations.
82 *
83 * They *must* not overlap with any valid modes, and they *must* not be emitted
84 * to outside world - i.e. appear on disk or network. In other words, it's just
85 * temporary fields, which we internally use, but they have to stay in-house.
86 *
87 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
88 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
89 */
90
91/* used internally in tree-diff */
92#define S_DIFFTREE_IFXMIN_NEQ 0x80000000
93
94
2386d658
LT
95/*
96 * Intensive research over the course of many years has shown that
97 * port 9418 is totally unused by anything else. Or
98 *
99 * Your search - "port 9418" - did not match any documents.
100 *
101 * as www.google.com puts it.
ba8a4970
LT
102 *
103 * This port has been properly assigned for git use by IANA:
104 * git (Assigned-9418) [I06-050728-0001].
105 *
106 * git 9418/tcp git pack transfer service
107 * git 9418/udp git pack transfer service
108 *
109 * with Linus Torvalds <torvalds@osdl.org> as the point of
110 * contact. September 2005.
111 *
112 * See http://www.iana.org/assignments/port-numbers
2386d658
LT
113 */
114#define DEFAULT_GIT_PORT 9418
115
e83c5163
LT
116/*
117 * Basic data structures for the directory cache
e83c5163
LT
118 */
119
120#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
121struct cache_header {
7800c1eb
TG
122 uint32_t hdr_signature;
123 uint32_t hdr_version;
124 uint32_t hdr_entries;
e83c5163
LT
125};
126
9d227781
JH
127#define INDEX_FORMAT_LB 2
128#define INDEX_FORMAT_UB 4
129
e83c5163
LT
130/*
131 * The "cache_time" is just the low 32 bits of the
132 * time. It doesn't matter if it overflows - we only
133 * check it for equality in the 32 bits we save.
134 */
135struct cache_time {
7800c1eb
TG
136 uint32_t sec;
137 uint32_t nsec;
e83c5163
LT
138};
139
c21d39d7
MH
140struct stat_data {
141 struct cache_time sd_ctime;
142 struct cache_time sd_mtime;
143 unsigned int sd_dev;
144 unsigned int sd_ino;
145 unsigned int sd_uid;
146 unsigned int sd_gid;
147 unsigned int sd_size;
148};
149
e83c5163 150struct cache_entry {
8b013788 151 struct hashmap_entry ent;
c21d39d7 152 struct stat_data ce_stat_data;
ccc4feb5 153 unsigned int ce_mode;
7a51ed66 154 unsigned int ce_flags;
b60e188c 155 unsigned int ce_namelen;
5fc2fc8f 156 unsigned int index; /* for link extension */
e83c5163 157 unsigned char sha1[20];
8f1d2e6f 158 char name[FLEX_ARRAY]; /* more */
e83c5163
LT
159};
160
95fd5bf8 161#define CE_STAGEMASK (0x3000)
16ce2e4c 162#define CE_EXTENDED (0x4000)
5f73076c 163#define CE_VALID (0x8000)
aee46198 164#define CE_STAGESHIFT 12
95fd5bf8 165
06aaaa0b 166/*
ce51bf09 167 * Range 0xFFFF0FFF in ce_flags is divided into
06aaaa0b
NTND
168 * two parts: in-memory flags and on-disk ones.
169 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
170 * if you want to save a new flag, add it in
171 * CE_EXTENDED_FLAGS
172 *
173 * In-memory only flags
174 */
2977ffbb
NTND
175#define CE_UPDATE (1 << 16)
176#define CE_REMOVE (1 << 17)
177#define CE_UPTODATE (1 << 18)
178#define CE_ADDED (1 << 19)
a22c6371 179
2977ffbb 180#define CE_HASHED (1 << 20)
2977ffbb
NTND
181#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
182#define CE_CONFLICTED (1 << 23)
7a51ed66 183
2977ffbb 184#define CE_UNPACKED (1 << 24)
2431afbf 185#define CE_NEW_SKIP_WORKTREE (1 << 25)
da165f47 186
e721c154
NTND
187/* used to temporarily mark paths matched by pathspecs */
188#define CE_MATCHED (1 << 26)
189
078a58e8 190#define CE_UPDATE_IN_BASE (1 << 27)
b3c96fb1 191#define CE_STRIP_NAME (1 << 28)
078a58e8 192
06aaaa0b
NTND
193/*
194 * Extended on-disk flags
195 */
2977ffbb
NTND
196#define CE_INTENT_TO_ADD (1 << 29)
197#define CE_SKIP_WORKTREE (1 << 30)
06aaaa0b 198/* CE_EXTENDED2 is for future extension */
2977ffbb 199#define CE_EXTENDED2 (1 << 31)
06aaaa0b 200
44a36913 201#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
06aaaa0b
NTND
202
203/*
204 * Safeguard to avoid saving wrong flags:
205 * - CE_EXTENDED2 won't get saved until its semantic is known
206 * - Bits in 0x0000FFFF have been saved in ce_flags already
207 * - Bits in 0x003F0000 are currently in-memory flags
208 */
209#if CE_EXTENDED_FLAGS & 0x803FFFFF
210#error "CE_EXTENDED_FLAGS out of range"
211#endif
212
64acde94
NTND
213struct pathspec;
214
eb7a2f1d
LT
215/*
216 * Copy the sha1 and stat state of a cache entry from one to
217 * another. But we never change the name, or the hash state!
218 */
20d142b4
RS
219static inline void copy_cache_entry(struct cache_entry *dst,
220 const struct cache_entry *src)
eb7a2f1d 221{
419a597f 222 unsigned int state = dst->ce_flags & CE_HASHED;
eb7a2f1d
LT
223
224 /* Don't copy hash chain and name */
8b013788
KB
225 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
226 offsetof(struct cache_entry, name) -
227 offsetof(struct cache_entry, ce_stat_data));
eb7a2f1d
LT
228
229 /* Restore the hash state */
419a597f 230 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
eb7a2f1d
LT
231}
232
b60e188c 233static inline unsigned create_ce_flags(unsigned stage)
7fec10b7 234{
b60e188c 235 return (stage << CE_STAGESHIFT);
7fec10b7
JH
236}
237
b60e188c 238#define ce_namelen(ce) ((ce)->ce_namelen)
aee46198 239#define ce_size(ce) cache_entry_size(ce_namelen(ce))
7a51ed66 240#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
eadb5831 241#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
44a36913 242#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
eadb5831 243#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
aee46198 244
e4479470 245#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
246static inline unsigned int create_ce_mode(unsigned int mode)
247{
8ae0a8c5 248 if (S_ISLNK(mode))
7a51ed66 249 return S_IFLNK;
302b9282 250 if (S_ISDIR(mode) || S_ISGITLINK(mode))
7a51ed66
LT
251 return S_IFGITLINK;
252 return S_IFREG | ce_permissions(mode);
8ae0a8c5 253}
20d142b4
RS
254static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
255 unsigned int mode)
185c975f 256{
78a8d641
JS
257 extern int trust_executable_bit, has_symlinks;
258 if (!has_symlinks && S_ISREG(mode) &&
7a51ed66 259 ce && S_ISLNK(ce->ce_mode))
78a8d641 260 return ce->ce_mode;
185c975f 261 if (!trust_executable_bit && S_ISREG(mode)) {
7a51ed66 262 if (ce && S_ISREG(ce->ce_mode))
185c975f
JH
263 return ce->ce_mode;
264 return create_ce_mode(0666);
265 }
266 return create_ce_mode(mode);
267}
d6b8fc30
JH
268static inline int ce_to_dtype(const struct cache_entry *ce)
269{
270 unsigned ce_mode = ntohl(ce->ce_mode);
271 if (S_ISREG(ce_mode))
272 return DT_REG;
273 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
274 return DT_DIR;
275 else if (S_ISLNK(ce_mode))
276 return DT_LNK;
277 else
278 return DT_UNKNOWN;
279}
b90d9b88
RS
280static inline unsigned int canon_mode(unsigned int mode)
281{
282 if (S_ISREG(mode))
283 return S_IFREG | ce_permissions(mode);
284 if (S_ISLNK(mode))
285 return S_IFLNK;
286 if (S_ISDIR(mode))
287 return S_IFDIR;
288 return S_IFGITLINK;
289}
e4479470 290
ee7825b5 291#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
f5cabd13 292
e636a7b4
NTND
293#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
294#define CE_ENTRY_CHANGED (1 << 1)
295#define CE_ENTRY_REMOVED (1 << 2)
296#define CE_ENTRY_ADDED (1 << 3)
6c306a34 297#define RESOLVE_UNDO_CHANGED (1 << 4)
a5400efe 298#define CACHE_TREE_CHANGED (1 << 5)
c18b80a0 299#define SPLIT_INDEX_ORDERED (1 << 6)
1bbb3dba 300#define UNTRACKED_CHANGED (1 << 7)
e636a7b4 301
5fc2fc8f 302struct split_index;
83c094ad
NTND
303struct untracked_cache;
304
228e94f9
JH
305struct index_state {
306 struct cache_entry **cache;
9d227781 307 unsigned int version;
228e94f9 308 unsigned int cache_nr, cache_alloc, cache_changed;
cfc5789a 309 struct string_list *resolve_undo;
228e94f9 310 struct cache_tree *cache_tree;
5fc2fc8f 311 struct split_index *split_index;
fba2f38a 312 struct cache_time timestamp;
913e0e99
JH
313 unsigned name_hash_initialized : 1,
314 initialized : 1;
8b013788 315 struct hashmap name_hash;
e05881a4 316 struct hashmap dir_hash;
426ddeea 317 unsigned char sha1[20];
83c094ad 318 struct untracked_cache *untracked;
228e94f9
JH
319};
320
321extern struct index_state the_index;
322
96872bc2
LT
323/* Name hashing */
324extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
2092678c
KB
325extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
326extern void free_name_hash(struct index_state *istate);
96872bc2
LT
327
328
4aab5b46 329#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
228e94f9
JH
330#define active_cache (the_index.cache)
331#define active_nr (the_index.cache_nr)
332#define active_alloc (the_index.cache_alloc)
333#define active_cache_changed (the_index.cache_changed)
334#define active_cache_tree (the_index.cache_tree)
e83c5163 335
4aab5b46
JH
336#define read_cache() read_index(&the_index)
337#define read_cache_from(path) read_index_from(&the_index, (path))
671c9b7e 338#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
fa7b3c2f 339#define is_cache_unborn() is_index_unborn(&the_index)
e46bbcf6 340#define read_cache_unmerged() read_index_unmerged(&the_index)
4aab5b46 341#define discard_cache() discard_index(&the_index)
94a5728c 342#define unmerged_cache() unmerged_index(&the_index)
4aab5b46
JH
343#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
344#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
81dc2307 345#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
4aab5b46
JH
346#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
347#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
38ed1d89
JH
348#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
349#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
3deffc52 350#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
4bd5b7da
JH
351#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
352#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
db5360f3
ES
353#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
354#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
98fa4738 355#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
cfc5789a 356#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
8aa38563 357#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
4421a823 358#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
ff366825 359#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
4aab5b46 360#endif
e83c5163 361
edaec3fb
JH
362enum object_type {
363 OBJ_BAD = -1,
364 OBJ_NONE = 0,
365 OBJ_COMMIT = 1,
366 OBJ_TREE = 2,
367 OBJ_BLOB = 3,
368 OBJ_TAG = 4,
369 /* 5 for future expansion */
370 OBJ_OFS_DELTA = 6,
371 OBJ_REF_DELTA = 7,
355885d5 372 OBJ_ANY,
4b05548f 373 OBJ_MAX
edaec3fb
JH
374};
375
b45563a2
JH
376static inline enum object_type object_type(unsigned int mode)
377{
378 return S_ISDIR(mode) ? OBJ_TREE :
379 S_ISGITLINK(mode) ? OBJ_COMMIT :
380 OBJ_BLOB;
381}
382
2163e5db 383/* Double-check local_repo_env below if you add to this list. */
8ac069ac 384#define GIT_DIR_ENVIRONMENT "GIT_DIR"
c7b3a3d2 385#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
a1bea2c1 386#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
892c41b9 387#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
a6f7f9a3 388#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
8ac069ac 389#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 390#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 391#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 392#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
069c0532 393#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
d4ebc36c
JH
394#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
395#define CONFIG_ENVIRONMENT "GIT_CONFIG"
2b64fc89 396#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
d4ebc36c 397#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
0454dd93 398#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
6476b38b 399#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
58d121b2 400#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
d0bfd026
JH
401#define GITATTRIBUTES_FILE ".gitattributes"
402#define INFOATTRIBUTES_FILE "info/attributes"
f48fd688 403#define ATTRIBUTE_MACRO_PREFIX "[attr]"
a97a7468
JS
404#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
405#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
894a9d33 406#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
6956f858
TR
407#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
408#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
823ab40f 409#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
bd30c2e4
NTND
410#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
411#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
93d93537 412#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
bb233d69 413
48a7c1c4 414/*
2cd83d10
JK
415 * This environment variable is expected to contain a boolean indicating
416 * whether we should or should not treat:
417 *
418 * GIT_DIR=foo.git git ...
419 *
420 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
421 * of this, but we use it internally to communicate to sub-processes that we
422 * are in a bare repo. If not set, defaults to true.
423 */
424#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
425
48a7c1c4 426/*
2163e5db
JK
427 * Repository-local GIT_* environment variables; these will be cleared
428 * when git spawns a sub-process that runs inside another repository.
429 * The array is NULL-terminated, which makes it easy to pass in the "env"
430 * parameter of a run-command invocation, or to do a simple walk.
48a7c1c4 431 */
2163e5db 432extern const char * const local_repo_env[];
48a7c1c4 433
7d1864ce
JH
434extern int is_bare_repository_cfg;
435extern int is_bare_repository(void);
68025633 436extern int is_inside_git_dir(void);
e90fdc39 437extern char *git_work_tree_cfg;
892c41b9 438extern int is_inside_work_tree(void);
c5fba16c 439extern const char *get_git_dir(void);
c7b3a3d2 440extern const char *get_git_common_dir(void);
b3256eb8 441extern int is_git_directory(const char *path);
8ac069ac
JH
442extern char *get_object_directory(void);
443extern char *get_index_file(void);
5da5c8f4 444extern char *get_graft_file(void);
d7ac12b2 445extern int set_git_dir(const char *path);
31e26ebc 446extern int get_common_dir(struct strbuf *sb, const char *gitdir);
a1bea2c1
JT
447extern const char *get_git_namespace(void);
448extern const char *strip_namespace(const char *namespaced_ref);
e90fdc39 449extern const char *get_git_work_tree(void);
a93bedad
EE
450
451#define READ_GITFILE_ERR_STAT_FAILED 1
452#define READ_GITFILE_ERR_NOT_A_FILE 2
453#define READ_GITFILE_ERR_OPEN_FAILED 3
454#define READ_GITFILE_ERR_READ_FAILED 4
455#define READ_GITFILE_ERR_INVALID_FORMAT 5
456#define READ_GITFILE_ERR_NO_PATH 6
457#define READ_GITFILE_ERR_NOT_A_REPO 7
921bdd96 458#define READ_GITFILE_ERR_TOO_LARGE 8
a93bedad
EE
459extern const char *read_gitfile_gently(const char *path, int *return_error_code);
460#define read_gitfile(path) read_gitfile_gently((path), NULL)
abc06822 461extern const char *resolve_gitdir(const char *suspect);
19757d80 462extern void set_git_work_tree(const char *tree);
8ac069ac
JH
463
464#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 465
6b5ee137 466extern const char **get_pathspec(const char *prefix, const char **pathspec);
59f0f2f3 467extern void setup_work_tree(void);
4ca06608 468extern const char *setup_git_directory_gently(int *);
d288a700 469extern const char *setup_git_directory(void);
edc54fb5 470extern char *prefix_path(const char *prefix, int len, const char *path);
645a29c4 471extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
4ca06608 472extern const char *prefix_filename(const char *prefix, int len, const char *path);
c6e8c800 473extern int check_filename(const char *prefix, const char *name);
023e37c3
MM
474extern void verify_filename(const char *prefix,
475 const char *name,
476 int diagnose_misspelt_rev);
ea92f41f 477extern void verify_non_filename(const char *prefix, const char *name);
546e0fd9 478extern int path_inside_repo(const char *prefix, const char *path);
d288a700 479
f225aeb2
DB
480#define INIT_DB_QUIET 0x0001
481
b57fb80a 482extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
f225aeb2
DB
483extern int init_db(const char *template_dir, unsigned int flags);
484
1d999ddd 485extern void sanitize_stdfds(void);
de0957ce 486extern int daemonize(void);
1d999ddd 487
e83c5163
LT
488#define alloc_nr(x) (((x)+16)*3/2)
489
6815e569
JK
490/*
491 * Realloc the buffer pointed at by variable 'x' so that it can hold
492 * at least 'nr' entries; the number of entries currently allocated
493 * is 'alloc', using the standard growing factor alloc_nr() macro.
494 *
01f6fd4b 495 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
6815e569
JK
496 */
497#define ALLOC_GROW(x, nr, alloc) \
498 do { \
c927e6c6 499 if ((nr) > alloc) { \
4234a761
JH
500 if (alloc_nr(alloc) < (nr)) \
501 alloc = (nr); \
502 else \
503 alloc = alloc_nr(alloc); \
2756ca43 504 REALLOC_ARRAY(x, alloc); \
6815e569 505 } \
98746061 506 } while (0)
6815e569 507
734aab75 508/* Initialize and use the cache information */
03b86647 509struct lock_file;
4aab5b46 510extern int read_index(struct index_state *);
5ab2a2da 511extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
3e52f70b
NTND
512extern int do_read_index(struct index_state *istate, const char *path,
513 int must_exist); /* for testting only! */
4aab5b46 514extern int read_index_from(struct index_state *, const char *path);
fa7b3c2f 515extern int is_index_unborn(struct index_state *);
e46bbcf6 516extern int read_index_unmerged(struct index_state *);
03b86647
NTND
517#define COMMIT_LOCK (1 << 0)
518#define CLOSE_LOCK (1 << 1)
519extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
4aab5b46 520extern int discard_index(struct index_state *);
d1f128b0 521extern int unmerged_index(const struct index_state *);
8dcf39c4 522extern int verify_path(const char *path);
db5360f3
ES
523extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen);
524extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
d1f128b0 525extern int index_name_pos(const struct index_state *, const char *name, int namelen);
192268c1
JH
526#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
527#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 528#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
af3785dc 529#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
39425819 530#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
ce7c614b 531#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
4aab5b46 532extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
81dc2307 533extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
4aab5b46 534extern int remove_index_entry_at(struct index_state *, int pos);
36419c8e 535extern void remove_marked_cache_entries(struct index_state *istate);
4aab5b46 536extern int remove_file_from_index(struct index_state *, const char *path);
38ed1d89
JH
537#define ADD_CACHE_VERBOSE 1
538#define ADD_CACHE_PRETEND 2
01665924 539#define ADD_CACHE_IGNORE_ERRORS 4
041aee31 540#define ADD_CACHE_IGNORE_REMOVAL 8
39425819 541#define ADD_CACHE_INTENT 16
38ed1d89
JH
542extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
543extern int add_file_to_index(struct index_state *, const char *path, int flags);
25762726 544extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
9c5e6c80 545extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
b4b313f9 546extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
98fa4738 547extern int index_name_is_other(const struct index_state *, const char *, int);
ff366825 548extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
4bd5b7da
JH
549
550/* do stat comparison even if CE_VALID is true */
551#define CE_MATCH_IGNORE_VALID 01
552/* do not check the contents but report dirty on racily-clean entries */
56cac48c
NTND
553#define CE_MATCH_RACY_IS_DIRTY 02
554/* do stat comparison even if CE_SKIP_WORKTREE is true */
555#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
2e2e7ec1
BK
556/* ignore non-existent files during stat update */
557#define CE_MATCH_IGNORE_MISSING 0x08
25762726
BK
558/* enable stat refresh */
559#define CE_MATCH_REFRESH 0x10
21a6b9fa
RS
560extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
561extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
4bd5b7da 562
c4ce46fc
JH
563#define HASH_WRITE_OBJECT 1
564#define HASH_FORMAT_CHECK 2
565extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
566extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
c21d39d7
MH
567
568/*
569 * Record to sd the data from st that we use to check whether a file
570 * might have changed.
571 */
572extern void fill_stat_data(struct stat_data *sd, struct stat *st);
573
574/*
575 * Return 0 if st is consistent with a file not having been changed
576 * since sd was filled. If there are differences, return a
577 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
578 * INODE_CHANGED, and DATA_CHANGED.
579 */
580extern int match_stat_data(const struct stat_data *sd, struct stat *st);
ed4efab1
NTND
581extern int match_stat_data_racy(const struct index_state *istate,
582 const struct stat_data *sd, struct stat *st);
c21d39d7 583
415e96c8
JH
584extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
585
405e5b2f
LT
586#define REFRESH_REALLY 0x0001 /* ignore_valid */
587#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
588#define REFRESH_QUIET 0x0004 /* be quiet about it */
589#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
3f1b7b60 590#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
43673fdd 591#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
9b2d6149 592extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
405e5b2f 593
ccdc4ec3 594extern void update_index_if_able(struct index_state *, struct lock_file *);
30ca07a2
JH
595
596extern int hold_locked_index(struct lock_file *, int);
5e7f56ac 597extern void set_alternate_index_output(const char *);
697cc8ef 598
2ae1c53b 599/* Environment bits from configuration mechanism */
17712991 600extern int trust_executable_bit;
1ce4790b 601extern int trust_ctime;
c08e4d5b 602extern int check_stat;
9378c161 603extern int quote_path_fully;
78a8d641 604extern int has_symlinks;
dce96489 605extern int minimum_abbrev, default_abbrev;
0a9b88b7 606extern int ignore_case;
5f73076c 607extern int assume_unchanged;
9f0bb90d 608extern int prefer_symlink_refs;
6de08ae6 609extern int log_all_ref_updates;
2f8acdb3 610extern int warn_ambiguous_refs;
25fba78d 611extern int warn_on_object_refname_ambiguity;
457f06d6 612extern int shared_repository;
2ae1c53b 613extern const char *apply_default_whitespace;
86c91f91 614extern const char *apply_default_ignorewhitespace;
64589a03 615extern const char *git_attributes_file;
12f6c308 616extern int zlib_compression_level;
960ccca6
DH
617extern int core_compression_level;
618extern int core_compression_seen;
60bb8b14 619extern size_t packed_git_window_size;
77ccc5bb 620extern size_t packed_git_limit;
18bdec11 621extern size_t delta_base_cache_limit;
15366280 622extern unsigned long big_file_threshold;
568508e7 623extern unsigned long pack_size_limit_cfg;
afc711b8
MH
624
625/*
626 * Do replace refs need to be checked this run? This variable is
627 * initialized to true unless --no-replace-object is used or
628 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
629 * commands that do not want replace references to be active. As an
630 * optimization it is also set to false if replace references have
631 * been sought but there were none.
632 */
633extern int check_replace_refs;
58d121b2 634extern char *git_replace_ref_base;
afc711b8 635
aafe9fba 636extern int fsync_object_files;
671c9b7e 637extern int core_preload_index;
08aefc9e 638extern int core_apply_sparse_checkout;
76759c7d 639extern int precomposed_unicode;
a42643aa 640extern int protect_hfs;
2b4c6efc 641extern int protect_ntfs;
c7b3a3d2 642extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
17712991 643
49672f26
JK
644/*
645 * Include broken refs in all ref iterations, which will
646 * generally choke dangerous operations rather than letting
647 * them silently proceed without taking the broken ref into
648 * account.
649 */
650extern int ref_paranoia;
651
eff80a9f
JH
652/*
653 * The character that begins a commented line in user-editable file
654 * that is subject to stripspace.
655 */
656extern char comment_line_char;
84c9dc2c 657extern int auto_comment_line_char;
eff80a9f 658
9ed36cfa 659enum branch_track {
9188ed89 660 BRANCH_TRACK_UNSPECIFIED = -1,
9ed36cfa
JS
661 BRANCH_TRACK_NEVER = 0,
662 BRANCH_TRACK_REMOTE,
663 BRANCH_TRACK_ALWAYS,
664 BRANCH_TRACK_EXPLICIT,
4b05548f 665 BRANCH_TRACK_OVERRIDE
9ed36cfa
JS
666};
667
c998ae9b
DS
668enum rebase_setup_type {
669 AUTOREBASE_NEVER = 0,
670 AUTOREBASE_LOCAL,
671 AUTOREBASE_REMOTE,
4b05548f 672 AUTOREBASE_ALWAYS
c998ae9b
DS
673};
674
52153747 675enum push_default_type {
52153747
FAG
676 PUSH_DEFAULT_NOTHING = 0,
677 PUSH_DEFAULT_MATCHING,
b55e6775 678 PUSH_DEFAULT_SIMPLE,
53c40311 679 PUSH_DEFAULT_UPSTREAM,
f25950f3
CT
680 PUSH_DEFAULT_CURRENT,
681 PUSH_DEFAULT_UNSPECIFIED
52153747
FAG
682};
683
9ed36cfa 684extern enum branch_track git_branch_track;
c998ae9b 685extern enum rebase_setup_type autorebase;
52153747 686extern enum push_default_type push_default;
9ed36cfa 687
348df166
JS
688enum object_creation_mode {
689 OBJECT_CREATION_USES_HARDLINKS = 0,
4b05548f 690 OBJECT_CREATION_USES_RENAMES = 1
348df166
JS
691};
692
693extern enum object_creation_mode object_creation_mode;
be66a6c4 694
a97a7468
JS
695extern char *notes_ref_name;
696
7f3140cd
JS
697extern int grafts_replace_parents;
698
ab9cb76f
JH
699#define GIT_REPO_VERSION 0
700extern int repository_format_version;
701extern int check_repository_format(void);
702
734aab75
LT
703#define MTIME_CHANGED 0x0001
704#define CTIME_CHANGED 0x0002
705#define OWNER_CHANGED 0x0004
706#define MODE_CHANGED 0x0008
707#define INODE_CHANGED 0x0010
708#define DATA_CHANGED 0x0020
8ae0a8c5 709#define TYPE_CHANGED 0x0040
e83c5163 710
69ddd231
JK
711/*
712 * Return a statically allocated filename, either generically (mkpath), in
713 * the repository directory (git_path), or in a submodule's repository
714 * directory (git_path_submodule). In all cases, note that the result
715 * may be overwritten by another call to _any_ of the functions. Consider
07e3070d
JK
716 * using the safer "dup" or "strbuf" formats below (in some cases, the
717 * unsafe versions have already been removed).
69ddd231
JK
718 */
719extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
720extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
69ddd231 721
108bebea
AR
722extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
723 __attribute__((format (printf, 3, 4)));
1a83c240
NTND
724extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
725 __attribute__((format (printf, 2, 3)));
bb3788ce
JK
726extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
727 __attribute__((format (printf, 2, 3)));
f5895fd3
JK
728extern void strbuf_git_path_submodule(struct strbuf *sb, const char *path,
729 const char *fmt, ...)
730 __attribute__((format (printf, 3, 4)));
aba13e7c
AR
731extern char *git_pathdup(const char *fmt, ...)
732 __attribute__((format (printf, 1, 2)));
21cf3227
HKNN
733extern char *mkpathdup(const char *fmt, ...)
734 __attribute__((format (printf, 1, 2)));
f5895fd3 735extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
0bad611b 736 __attribute__((format (printf, 2, 3)));
108bebea 737
77a6d840 738extern void report_linked_checkout_garbage(void);
0bad611b 739
f932729c
JK
740/*
741 * You can define a static memoized git path like:
742 *
743 * static GIT_PATH_FUNC(git_path_foo, "FOO");
744 *
745 * or use one of the global ones below.
746 */
747#define GIT_PATH_FUNC(func, filename) \
748 const char *func(void) \
749 { \
750 static char *ret; \
751 if (!ret) \
752 ret = git_pathdup(filename); \
753 return ret; \
754 }
755
756const char *git_path_cherry_pick_head(void);
757const char *git_path_revert_head(void);
758const char *git_path_squash_msg(void);
759const char *git_path_merge_msg(void);
760const char *git_path_merge_rr(void);
761const char *git_path_merge_mode(void);
762const char *git_path_merge_head(void);
763const char *git_path_fetch_head(void);
764const char *git_path_shallow(void);
765
d40d535b
MH
766/*
767 * Return the name of the file in the local object database that would
768 * be used to store a loose object with the specified sha1. The
769 * return value is a pointer to a statically allocated buffer that is
770 * overwritten each time the function is called.
771 */
30d6c6ea 772extern const char *sha1_file_name(const unsigned char *sha1);
d40d535b
MH
773
774/*
775 * Return the name of the (local) packfile with the specified sha1 in
776 * its name. The return value is a pointer to memory that is
777 * overwritten each time this function is called.
778 */
bf592c50 779extern char *sha1_pack_name(const unsigned char *sha1);
d40d535b
MH
780
781/*
782 * Return the name of the (local) pack index file with the specified
783 * sha1 in its name. The return value is a pointer to memory that is
784 * overwritten each time this function is called.
785 */
bf592c50 786extern char *sha1_pack_index_name(const unsigned char *sha1);
d40d535b 787
af49c6d0
JK
788/*
789 * Return an abbreviated sha1 unique within this repository's object database.
790 * The result will be at least `len` characters long, and will be NUL
791 * terminated.
792 *
793 * The non-`_r` version returns a static buffer which will be overwritten by
794 * subsequent calls.
795 *
796 * The `_r` variant writes to a buffer supplied by the caller, which must be at
797 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
798 * written (excluding the NUL terminator).
799 *
800 * Note that while this version avoids the static buffer, it is not fully
801 * reentrant, as it calls into other non-reentrant git code.
802 */
803extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
804extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
805
aa1c6fdf 806extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
1a812f3a
IM
807
808static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
0bef57ee 809{
1a812f3a
IM
810 int i;
811
aa1c6fdf 812 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
1a812f3a
IM
813 if (*sha1 != *sha2)
814 return *sha1 - *sha2;
815 }
816
817 return 0;
0bef57ee 818}
1a812f3a 819
aa1c6fdf 820static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
821{
822 return hashcmp(oid1->hash, oid2->hash);
823}
824
1a812f3a 825static inline int is_null_sha1(const unsigned char *sha1)
a89fccd2 826{
1a812f3a 827 return !hashcmp(sha1, null_sha1);
a89fccd2 828}
1a812f3a 829
aa1c6fdf 830static inline int is_null_oid(const struct object_id *oid)
831{
832 return !hashcmp(oid->hash, null_sha1);
833}
834
e702496e
SP
835static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
836{
aa1c6fdf 837 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
e702496e 838}
aa1c6fdf 839
840static inline void oidcpy(struct object_id *dst, const struct object_id *src)
841{
842 hashcpy(dst->hash, src->hash);
e702496e 843}
aa1c6fdf 844
a8e0d16d
JH
845static inline void hashclr(unsigned char *hash)
846{
aa1c6fdf 847 memset(hash, 0, GIT_SHA1_RAWSZ);
a8e0d16d 848}
e83c5163 849
aa1c6fdf 850static inline void oidclr(struct object_id *oid)
851{
852 hashclr(oid->hash);
853}
854
855
14d9c578
JK
856#define EMPTY_TREE_SHA1_HEX \
857 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
dab0d410 858#define EMPTY_TREE_SHA1_BIN_LITERAL \
14d9c578
JK
859 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
860 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
dab0d410
JN
861#define EMPTY_TREE_SHA1_BIN \
862 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
14d9c578 863
f8582cad
JK
864#define EMPTY_BLOB_SHA1_HEX \
865 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
866#define EMPTY_BLOB_SHA1_BIN_LITERAL \
867 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
868 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
869#define EMPTY_BLOB_SHA1_BIN \
870 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
871
872static inline int is_empty_blob_sha1(const unsigned char *sha1)
873{
874 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
875}
876
f2db68ed
HE
877int git_mkstemp(char *path, size_t n, const char *template);
878
003b33a8
DA
879int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
880
b862b61c
MM
881/* set default permissions by passing mode arguments to open(2) */
882int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
883int git_mkstemp_mode(char *pattern, int mode);
884
06cbe855
HO
885/*
886 * NOTE NOTE NOTE!!
887 *
888 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
889 * not be changed. Old repositories have core.sharedrepository written in
890 * numeric format, and therefore these values are preserved for compatibility
891 * reasons.
892 */
94df2506 893enum sharedrepo {
06cbe855
HO
894 PERM_UMASK = 0,
895 OLD_PERM_GROUP = 1,
896 OLD_PERM_EVERYBODY = 2,
897 PERM_GROUP = 0660,
4b05548f 898 PERM_EVERYBODY = 0664
94df2506
JH
899};
900int git_config_perm(const char *var, const char *value);
3a429d3b 901int adjust_shared_perm(const char *path);
0be0521b
MH
902
903/*
904 * Create the directory containing the named path, using care to be
905 * somewhat safe against races. Return one of the scld_error values
906 * to indicate success/failure.
18d37e86
MH
907 *
908 * SCLD_VANISHED indicates that one of the ancestor directories of the
909 * path existed at one point during the function call and then
910 * suddenly vanished, probably because another process pruned the
911 * directory while we were working. To be robust against this kind of
912 * race, callers might want to try invoking the function again when it
913 * returns SCLD_VANISHED.
0be0521b
MH
914 */
915enum scld_error {
916 SCLD_OK = 0,
917 SCLD_FAILED = -1,
918 SCLD_PERMS = -2,
18d37e86
MH
919 SCLD_EXISTS = -3,
920 SCLD_VANISHED = -4
0be0521b
MH
921};
922enum scld_error safe_create_leading_directories(char *path);
923enum scld_error safe_create_leading_directories_const(const char *path);
924
90a6464b 925int mkdir_in_gitdir(const char *path);
395de250 926extern char *expand_user_path(const char *path);
1c64b48e 927const char *enter_repo(const char *path, int strict);
e5392c51
JS
928static inline int is_absolute_path(const char *path)
929{
88135203 930 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
e5392c51 931}
90b4a71c 932int is_directory(const char *);
e2a57aac 933const char *real_path(const char *path);
e3e46cdb 934const char *real_path_if_valid(const char *path);
e2a57aac 935const char *absolute_path(const char *path);
41894ae3 936const char *remove_leading_path(const char *in, const char *prefix);
e02ca72f 937const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
645a29c4 938int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
f3cad0ad 939int normalize_path_copy(char *dst, const char *src);
31171d9e 940int longest_ancestor_length(const char *path, struct string_list *prefixes);
4fcc86b0 941char *strip_path_suffix(const char *path, const char *suffix);
34b6cb8b 942int daemon_avoid_alias(const char *path);
1d1d69bc 943extern int is_ntfs_dotgit(const char *name);
b2cb9425 944
ea19289b
PT
945/**
946 * Return a newly allocated string with the evaluation of
947 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
948 * "$HOME/.config/git/$filename". Return NULL upon error.
949 */
950extern char *xdg_config_home(const char *filename);
951
e1111cef 952/* object replacement */
ffe68cf9 953#define LOOKUP_REPLACE_OBJECT 1
46f03448 954#define LOOKUP_UNKNOWN_OBJECT 2
5bf29b95 955extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
f5552aee
CC
956static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
957{
ffe68cf9 958 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
5bf29b95 959}
1f91e79c
MH
960
961/*
962 * This internal function is only declared here for the benefit of
963 * lookup_replace_object(). Please do not call it directly.
964 */
e1111cef 965extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1f91e79c
MH
966
967/*
968 * If object sha1 should be replaced, return the replacement object's
969 * name (replaced recursively, if necessary). The return value is
970 * either sha1 or a pointer to a permanently-allocated value. When
971 * object replacement is suppressed, always return sha1.
972 */
e1111cef
JH
973static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
974{
afc711b8 975 if (!check_replace_refs)
e1111cef
JH
976 return sha1;
977 return do_lookup_replace_object(sha1);
f5552aee 978}
1f91e79c 979
bf93eea0
CC
980static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
981{
982 if (!(flag & LOOKUP_REPLACE_OBJECT))
983 return sha1;
984 return lookup_replace_object(sha1);
985}
e1111cef 986
e83c5163 987/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
21666f1a 988extern int sha1_object_info(const unsigned char *, unsigned long *);
ce9fbf16 989extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
c00e657d 990extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
0c3db67c 991extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
21666f1a 992extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
bbac7311 993extern int force_object_loose(const unsigned char *sha1, time_t mtime);
ec73f580 994extern int git_open_noatime(const char *name);
f0270efd 995extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
eb4f4076 996extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
f0270efd 997extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
8237b185 998
0e8189e2
NP
999/* global flag to enable extra checks when accessing packed objects */
1000extern int do_check_packed_object_crc;
1001
5d6ccf5c 1002extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 1003
cb5add58 1004extern int finalize_object_file(const char *tmpfile, const char *filename);
8237b185 1005
cd673c1f 1006extern int has_sha1_pack(const unsigned char *sha1);
d40d535b
MH
1007
1008/*
1009 * Return true iff we have an object named sha1, whether local or in
1010 * an alternate object database, and whether packed or loose. This
1011 * function does not respect replace references.
0eeb077b
JK
1012 *
1013 * If the QUICK flag is set, do not re-check the pack directory
1014 * when we cannot find the object (this means we may give a false
1015 * negative answer if another process is simultaneously repacking).
d40d535b 1016 */
0eeb077b
JK
1017#define HAS_SHA1_QUICK 0x1
1018extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1019static inline int has_sha1_file(const unsigned char *sha1)
1020{
1021 return has_sha1_file_with_flags(sha1, 0);
1022}
d40d535b
MH
1023
1024/*
1025 * Return true iff an alternate object database has a loose object
1026 * with the specified name. This function does not respect replace
1027 * references.
1028 */
0f4dc14a 1029extern int has_loose_object_nonlocal(const unsigned char *sha1);
8237b185 1030
bf592c50
DB
1031extern int has_pack_index(const unsigned char *sha1);
1032
40d52ff7
JK
1033extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1034
192a6be2
LT
1035extern const signed char hexval_table[256];
1036static inline unsigned int hexval(unsigned char c)
e49521b5
JH
1037{
1038 return hexval_table[c];
1039}
1040
e83c5163 1041/* Convert to/from hex/sha1 representation */
dce96489
LT
1042#define MINIMUM_ABBREV minimum_abbrev
1043#define DEFAULT_ABBREV default_abbrev
46a6c262 1044
573285e5
CP
1045struct object_context {
1046 unsigned char tree[20];
1047 char path[PATH_MAX];
1048 unsigned mode;
c4ec9677
DT
1049 /*
1050 * symlink_path is only used by get_tree_entry_follow_symlinks,
1051 * and only for symlinks that point outside the repository.
1052 */
1053 struct strbuf symlink_path;
573285e5
CP
1054};
1055
c4ec9677
DT
1056#define GET_SHA1_QUIETLY 01
1057#define GET_SHA1_COMMIT 02
1058#define GET_SHA1_COMMITTISH 04
1059#define GET_SHA1_TREE 010
1060#define GET_SHA1_TREEISH 020
1061#define GET_SHA1_BLOB 040
1062#define GET_SHA1_FOLLOW_SYMLINKS 0100
1063#define GET_SHA1_ONLY_TO_DIE 04000
37c00e55 1064
3c249c95 1065extern int get_sha1(const char *str, unsigned char *sha1);
daba53ae 1066extern int get_sha1_commit(const char *str, unsigned char *sha1);
cd74e473 1067extern int get_sha1_committish(const char *str, unsigned char *sha1);
daba53ae
JH
1068extern int get_sha1_tree(const char *str, unsigned char *sha1);
1069extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1070extern int get_sha1_blob(const char *str, unsigned char *sha1);
8c135ea2 1071extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
33bd598c 1072extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
d4e85a1a 1073
957d7406
JH
1074typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1075extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
d4e85a1a
MH
1076
1077/*
1078 * Try to read a SHA1 in hexadecimal format from the 40 characters
1079 * starting at hex. Write the 20-byte result to sha1 in binary form.
1080 * Return 0 on success. Reading stops if a NUL is encountered in the
1081 * input, so it is safe to pass this function an arbitrary
1082 * null-terminated string.
1083 */
197ee8c9 1084extern int get_sha1_hex(const char *hex, unsigned char *sha1);
aa1c6fdf 1085extern int get_oid_hex(const char *hex, struct object_id *sha1);
d4e85a1a 1086
af49c6d0
JK
1087/*
1088 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1089 * and writes the NUL-terminated output to the buffer `out`, which must be at
1090 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1091 * convenience.
1092 *
1093 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1094 * buffers, making it safe to make multiple calls for a single statement, like:
1095 *
1096 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1097 */
1098extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
197ee8c9 1099extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
aa1c6fdf 1100extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
7cb36842 1101
cf99a761 1102extern int interpret_branch_name(const char *str, int len, struct strbuf *);
619a644d 1103extern int get_sha1_mb(const char *str, unsigned char *sha1);
e86eb666 1104
c847f537 1105extern int validate_headref(const char *ref);
e83c5163 1106
958ba6c9 1107extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
0ab9e1e8 1108extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
ccdd4a0f 1109extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
b60e188c 1110extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
e83c5163 1111
40469ee9 1112extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 1113 const char *required_type,
40469ee9
JH
1114 unsigned long *size,
1115 unsigned char *sha1_ret);
f4913f91 1116
81776315
JH
1117extern struct object *peel_to_type(const char *name, int namelen,
1118 struct object *o, enum object_type);
1119
a5481a6c
JK
1120struct date_mode {
1121 enum date_mode_type {
1122 DATE_NORMAL = 0,
1123 DATE_RELATIVE,
1124 DATE_SHORT,
1125 DATE_LOCAL,
1126 DATE_ISO8601,
1127 DATE_ISO8601_STRICT,
1128 DATE_RFC2822,
aa1462cc 1129 DATE_STRFTIME,
a5481a6c
JK
1130 DATE_RAW
1131 } type;
aa1462cc 1132 const char *strftime_fmt;
73013afd
JH
1133};
1134
a5481a6c
JK
1135/*
1136 * Convenience helper for passing a constant type, like:
1137 *
1138 * show_date(t, tz, DATE_MODE(NORMAL));
1139 */
1140#define DATE_MODE(t) date_mode_from_type(DATE_##t)
1141struct date_mode *date_mode_from_type(enum date_mode_type type);
1142
1143const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
7d29afd4
JN
1144void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1145 struct strbuf *timebuf);
c33ddc2e 1146int parse_date(const char *date, struct strbuf *out);
9644c061 1147int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
3d27b9b0 1148int parse_expiry_date(const char *date, unsigned long *timestamp);
c33ddc2e 1149void datestamp(struct strbuf *out);
93cfa7c7
JH
1150#define approxidate(s) approxidate_careful((s), NULL)
1151unsigned long approxidate_careful(const char *, int *);
33012fc4 1152unsigned long approxidate_relative(const char *date, const struct timeval *now);
a5481a6c 1153void parse_date_format(const char *format, struct date_mode *mode);
7ca36d93 1154int date_overflows(unsigned long date);
ecee9d9e 1155
f9bc573f 1156#define IDENT_STRICT 1
b9f0ac17 1157#define IDENT_NO_DATE 2
c15e1987 1158#define IDENT_NO_NAME 4
749be728
JH
1159extern const char *git_author_info(int);
1160extern const char *git_committer_info(int);
798123af 1161extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
d9ccfe77 1162extern const char *fmt_name(const char *name, const char *email);
9830534e 1163extern const char *ident_default_name(void);
bcb2b004 1164extern const char *ident_default_email(void);
44fcb497 1165extern const char *git_editor(void);
64778d24 1166extern const char *git_pager(int stdout_is_tty);
9597921b 1167extern int git_ident_config(const char *, const char *, void *);
6aa33f40 1168
4b340cfa
JH
1169struct ident_split {
1170 const char *name_begin;
1171 const char *name_end;
1172 const char *mail_begin;
1173 const char *mail_end;
1174 const char *date_begin;
1175 const char *date_end;
1176 const char *tz_begin;
1177 const char *tz_end;
1178};
1179/*
1180 * Signals an success with 0, but time part of the result may be NULL
1181 * if the input lacks timestamp and zone
1182 */
1183extern int split_ident_line(struct ident_split *, const char *, int);
1184
d1053246
JK
1185/*
1186 * Like show_date, but pull the timestamp and tz parameters from
1187 * the ident_split. It will also sanity-check the values and produce
1188 * a well-known sentinel date if they appear bogus.
1189 */
a5481a6c
JK
1190const char *show_ident_date(const struct ident_split *id,
1191 const struct date_mode *mode);
d1053246 1192
662cc30c
JK
1193/*
1194 * Compare split idents for equality or strict ordering. Note that we
1195 * compare only the ident part of the line, ignoring any timestamp.
1196 *
1197 * Because there are two fields, we must choose one as the primary key; we
1198 * currently arbitrarily pick the email.
1199 */
1200extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1201
12dccc16 1202struct checkout {
d4a2024a 1203 struct index_state *istate;
12dccc16
LT
1204 const char *base_dir;
1205 int base_dir_len;
1206 unsigned force:1,
1207 quiet:1,
1208 not_new:1,
1209 refresh_cache:1;
1210};
1211
af2a651d 1212#define TEMPORARY_FILENAME_LENGTH 25
efbc5831 1213extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
b9fd2846
LT
1214
1215struct cache_def {
e7c73053 1216 struct strbuf path;
b9fd2846
LT
1217 int flags;
1218 int track_flags;
1219 int prefix_len_stat_func;
1220};
e7c73053 1221#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
2a608391 1222static inline void cache_def_clear(struct cache_def *cache)
e7c73053
KB
1223{
1224 strbuf_release(&cache->path);
1225}
b9fd2846 1226
57199892 1227extern int has_symlink_leading_path(const char *name, int len);
b9fd2846 1228extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
f66caaf9 1229extern int check_leading_path(const char *name, int len);
57199892 1230extern int has_dirs_only_path(const char *name, int len, int prefix_len);
78478927
KB
1231extern void schedule_dir_for_removal(const char *name, int len);
1232extern void remove_scheduled_dirs(void);
12dccc16 1233
9a217f2a 1234extern struct alternate_object_database {
d5a63b99 1235 struct alternate_object_database *next;
9a217f2a 1236 char *name;
8f1d2e6f 1237 char base[FLEX_ARRAY]; /* more */
d5a63b99 1238} *alt_odb_list;
9a217f2a 1239extern void prepare_alt_odb(void);
5e73633d 1240extern void read_info_alternates(const char * relative_base, int depth);
bef70b22 1241extern void add_to_alternates_file(const char *reference);
d79796bc 1242typedef int alt_odb_fn(struct alternate_object_database *, void *);
fe1b2268 1243extern int foreach_alt_odb(alt_odb_fn, void*);
9a217f2a 1244
c41ee586
SP
1245struct pack_window {
1246 struct pack_window *next;
1247 unsigned char *base;
1248 off_t offset;
1249 size_t len;
1250 unsigned int last_used;
1251 unsigned int inuse_cnt;
1252};
1253
9a217f2a
JH
1254extern struct packed_git {
1255 struct packed_git *next;
c41ee586 1256 struct pack_window *windows;
2dc3a234 1257 off_t pack_size;
57059091
NP
1258 const void *index_data;
1259 size_t index_size;
1260 uint32_t num_objects;
8eca0b47
NP
1261 uint32_t num_bad_objects;
1262 unsigned char *bad_object_sha1;
42873078 1263 int index_version;
57059091 1264 time_t mtime;
9bc879c1 1265 int pack_fd;
8d25931d 1266 unsigned pack_local:1,
d131b7af 1267 pack_keep:1,
ee1c6c34 1268 freshened:1,
d131b7af 1269 do_not_close:1;
bf592c50 1270 unsigned char sha1[20];
8f1d2e6f
JH
1271 /* something like ".git/objects/pack/xxxxx.pack" */
1272 char pack_name[FLEX_ARRAY]; /* more */
9a217f2a 1273} *packed_git;
f3bf9224
JH
1274
1275struct pack_entry {
c4001d92 1276 off_t offset;
f3bf9224
JH
1277 unsigned char sha1[20];
1278 struct packed_git *p;
1279};
1280
7b64469a 1281extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
bf592c50 1282
543c5caa
NTND
1283/* A hook for count-objects to report invalid files in pack directory */
1284extern void (*report_garbage)(const char *desc, const char *path);
1285
9a217f2a 1286extern void prepare_packed_git(void);
fc04c412 1287extern void reprepare_packed_git(void);
bf592c50
DB
1288extern void install_packed_git(struct packed_git *pack);
1289
a6080a0a 1290extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
bf592c50
DB
1291 struct packed_git *packs);
1292
276bc2ca 1293extern void pack_report(void);
d40d535b
MH
1294
1295/*
1296 * mmap the index file for the specified packfile (if it is not
1297 * already mmapped). Return 0 on success.
1298 */
d079837e 1299extern int open_pack_index(struct packed_git *);
d40d535b
MH
1300
1301/*
1302 * munmap the index file for the specified packfile (if it is
1303 * currently mmapped).
1304 */
fa5fc15d 1305extern void close_pack_index(struct packed_git *);
d40d535b 1306
ef49a7a0 1307extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
c9ced051 1308extern void close_pack_windows(struct packed_git *);
03e79c88 1309extern void unuse_pack(struct pack_window **);
c74faea1 1310extern void free_pack_by_name(const char *);
3d20c636 1311extern void clear_delta_base_cache(void);
48bcc1c3 1312extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
d40d535b
MH
1313
1314/*
1315 * Return the SHA-1 of the nth object within the specified packfile.
1316 * Open the index if it is not already open. The return value points
1317 * at the SHA-1 within the mmapped index. Return NULL if there is an
1318 * error.
1319 */
1320extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1321
1322/*
1323 * Return the offset of the nth object within the specified packfile.
1324 * The index must already be opened.
1325 */
1326extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1327
1328/*
1329 * If the object named sha1 is present in the specified packfile,
1330 * return its offset within the packfile; otherwise, return 0.
1331 */
1332extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1333
4c080182 1334extern int is_pack_valid(struct packed_git *);
c4001d92 1335extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
09ded04b 1336extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
54dab52a 1337extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
f8c8abc5 1338extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
9a217f2a 1339
27e1e22d
JK
1340/*
1341 * Iterate over the files in the loose-object parts of the object
1342 * directory "path", triggering the following callbacks:
1343 *
1344 * - loose_object is called for each loose object we find.
1345 *
1346 * - loose_cruft is called for any files that do not appear to be
1347 * loose objects. Note that we only look in the loose object
1348 * directories "objects/[0-9a-f]{2}/", so we will not report
1349 * "objects/foobar" as cruft.
1350 *
1351 * - loose_subdir is called for each top-level hashed subdirectory
1352 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1353 * after the objects in the directory are processed.
1354 *
1355 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1356 * will end the iteration.
e6f875e0
JK
1357 *
1358 * In the "buf" variant, "path" is a strbuf which will also be used as a
1359 * scratch buffer, but restored to its original contents before
1360 * the function returns.
27e1e22d
JK
1361 */
1362typedef int each_loose_object_fn(const unsigned char *sha1,
1363 const char *path,
1364 void *data);
1365typedef int each_loose_cruft_fn(const char *basename,
1366 const char *path,
1367 void *data);
1368typedef int each_loose_subdir_fn(int nr,
1369 const char *path,
1370 void *data);
1371int for_each_loose_file_in_objdir(const char *path,
1372 each_loose_object_fn obj_cb,
1373 each_loose_cruft_fn cruft_cb,
1374 each_loose_subdir_fn subdir_cb,
1375 void *data);
e6f875e0
JK
1376int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1377 each_loose_object_fn obj_cb,
1378 each_loose_cruft_fn cruft_cb,
1379 each_loose_subdir_fn subdir_cb,
1380 void *data);
27e1e22d 1381
660c889e
JK
1382/*
1383 * Iterate over loose and packed objects in both the local
1385bb7b
JK
1384 * repository and any alternates repositories (unless the
1385 * LOCAL_ONLY flag is set).
660c889e 1386 */
1385bb7b 1387#define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
660c889e
JK
1388typedef int each_packed_object_fn(const unsigned char *sha1,
1389 struct packed_git *pack,
1390 uint32_t pos,
1391 void *data);
1385bb7b
JK
1392extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1393extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
660c889e 1394
9a490590
JH
1395struct object_info {
1396 /* Request */
5b086407 1397 enum object_type *typep;
9a490590 1398 unsigned long *sizep;
161f00e7 1399 unsigned long *disk_sizep;
5d642e75 1400 unsigned char *delta_base_sha1;
46f03448 1401 struct strbuf *typename;
9a490590
JH
1402
1403 /* Response */
1404 enum {
1405 OI_CACHED,
1406 OI_LOOSE,
5266d369
JH
1407 OI_PACKED,
1408 OI_DBCACHED
9a490590
JH
1409 } whence;
1410 union {
1411 /*
1412 * struct {
1413 * ... Nothing to expose in this case
1414 * } cached;
1415 * struct {
1416 * ... Nothing to expose in this case
1417 * } loose;
1418 */
1419 struct {
1420 struct packed_git *pack;
1421 off_t offset;
1422 unsigned int is_delta;
1423 } packed;
1424 } u;
1425};
de7b5d62 1426extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
9a217f2a 1427
8f3f9b09
JH
1428/* Dumb servers support */
1429extern int update_server_info(int);
1430
7a397419
MG
1431/* git_config_parse_key() returns these negated: */
1432#define CONFIG_INVALID_KEY 1
1433#define CONFIG_NO_SECTION_OR_NAME 2
1434/* git_config_set(), git_config_set_multivar() return the above or these: */
1435#define CONFIG_NO_LOCK -1
1436#define CONFIG_INVALID_FILE 3
1437#define CONFIG_NO_WRITE 4
1438#define CONFIG_NOTHING_SET 5
1439#define CONFIG_INVALID_PATTERN 6
9409c7a5 1440#define CONFIG_GENERIC_ERROR 7
7a397419 1441
c1063be2
JK
1442#define CONFIG_REGEX_NONE ((void *)1)
1443
c8985ce0 1444struct git_config_source {
3caec73b 1445 unsigned int use_stdin:1;
c8985ce0
KS
1446 const char *file;
1447 const char *blob;
1448};
1449
ef90d6d4
JS
1450typedef int (*config_fn_t)(const char *, const char *, void *);
1451extern int git_default_config(const char *, const char *, void *);
1452extern int git_config_from_file(config_fn_t fn, const char *, void *);
1bc88819
HV
1453extern int git_config_from_buf(config_fn_t fn, const char *name,
1454 const char *buf, size_t len, void *data);
2b64fc89 1455extern void git_config_push_parameter(const char *text);
b3d83d9f 1456extern int git_config_from_parameters(config_fn_t fn, void *data);
aace4385 1457extern void git_config(config_fn_t fn, void *);
9b25a0b5 1458extern int git_config_with_options(config_fn_t fn, void *,
c8985ce0 1459 struct git_config_source *config_source,
1bc88819 1460 int respect_includes);
dbdf5854 1461extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
0b87b6e0 1462extern int git_parse_ulong(const char *, unsigned long *);
9a549d43 1463extern int git_parse_maybe_bool(const char *);
17712991 1464extern int git_config_int(const char *, const char *);
00160242 1465extern int64_t git_config_int64(const char *, const char *);
0b87b6e0 1466extern unsigned long git_config_ulong(const char *, const char *);
a53f2ec6 1467extern int git_config_bool_or_int(const char *, const char *, int *);
17712991 1468extern int git_config_bool(const char *, const char *);
8420ccd8 1469extern int git_config_maybe_bool(const char *, const char *);
ea5105a5 1470extern int git_config_string(const char **, const char *, const char *);
395de250 1471extern int git_config_pathname(const char **, const char *, const char *);
5ec31182 1472extern int git_config_set_in_file(const char *, const char *, const char *);
10bea152 1473extern int git_config_set(const char *, const char *);
b09c53a3 1474extern int git_config_parse_key(const char *, char **, int *);
9e9de18f 1475extern int git_config_key_is_valid(const char *key);
4ddba79d 1476extern int git_config_set_multivar(const char *, const char *, const char *, int);
5ec31182 1477extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
0667fcfb 1478extern int git_config_rename_section(const char *, const char *);
42bd39b5 1479extern int git_config_rename_section_in_file(const char *, const char *, const char *);
506b17b1 1480extern const char *git_etc_gitconfig(void);
ef90d6d4 1481extern int check_repository_format_version(const char *var, const char *value, void *cb);
0ef37164 1482extern int git_env_bool(const char *, int);
23b0c478 1483extern unsigned long git_env_ulong(const char *, unsigned long);
ab88c363 1484extern int git_config_system(void);
40ea4ed9 1485extern int config_error_nonbool(const char *);
ff0a80af 1486#if defined(__GNUC__)
87fe5df3 1487#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
a469a101 1488#endif
a6fa5992
PN
1489extern const char *get_log_output_encoding(void);
1490extern const char *get_commit_output_encoding(void);
1491
2496844b
JK
1492extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1493
9b25a0b5
JK
1494struct config_include_data {
1495 int depth;
1496 config_fn_t fn;
1497 void *data;
1498};
1499#define CONFIG_INCLUDE_INIT { 0 }
1500extern int git_config_include(const char *name, const char *value, void *data);
17712991 1501
1b86bbb0
JK
1502/*
1503 * Match and parse a config key of the form:
1504 *
1505 * section.(subsection.)?key
1506 *
1507 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1508 * we return -1 if it does not match, 0 otherwise. The subsection and key
1509 * out-parameters are filled by the function (and subsection is NULL if it is
1510 * missing).
1511 */
1512extern int parse_config_key(const char *var,
1513 const char *section,
1514 const char **subsection, int *subsection_len,
1515 const char **key);
1516
155ef25f
TA
1517struct config_set_element {
1518 struct hashmap_entry ent;
1519 char *key;
1520 struct string_list value_list;
1521};
1522
1523struct configset_list_item {
1524 struct config_set_element *e;
1525 int value_index;
1526};
1527
1528/*
1529 * the contents of the list are ordered according to their
1530 * position in the config files and order of parsing the files.
1531 * (i.e. key-value pair at the last position of .git/config will
1532 * be at the last item of the list)
1533 */
1534struct configset_list {
1535 struct configset_list_item *items;
1536 unsigned int nr, alloc;
1537};
1538
3c8687a7
TA
1539struct config_set {
1540 struct hashmap config_hash;
1541 int hash_initialized;
155ef25f 1542 struct configset_list list;
3c8687a7
TA
1543};
1544
1545extern void git_configset_init(struct config_set *cs);
1546extern int git_configset_add_file(struct config_set *cs, const char *filename);
1547extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1548extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1549extern void git_configset_clear(struct config_set *cs);
1550extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1551extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1552extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1553extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1554extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1555extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1556extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1557extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1558
1559extern int git_config_get_value(const char *key, const char **value);
1560extern const struct string_list *git_config_get_value_multi(const char *key);
1561extern void git_config_clear(void);
1562extern void git_config_iter(config_fn_t fn, void *data);
1563extern int git_config_get_string_const(const char *key, const char **dest);
1564extern int git_config_get_string(const char *key, char **dest);
1565extern int git_config_get_int(const char *key, int *dest);
1566extern int git_config_get_ulong(const char *key, unsigned long *dest);
1567extern int git_config_get_bool(const char *key, int *dest);
1568extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1569extern int git_config_get_maybe_bool(const char *key, int *dest);
1570extern int git_config_get_pathname(const char *key, const char **dest);
1571
3df8fd62
TA
1572struct key_value_info {
1573 const char *filename;
1574 int linenr;
1575};
1576
5a80e97c
TA
1577extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1578extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1579
d6991cee
JK
1580extern int committer_ident_sufficiently_given(void);
1581extern int author_ident_sufficiently_given(void);
e1b10391 1582
1a8f2741 1583extern const char *git_commit_encoding;
3a55602e 1584extern const char *git_log_output_encoding;
d551a488 1585extern const char *git_mailmap_file;
08610900 1586extern const char *git_mailmap_blob;
4e72dcec 1587
06f59e9f
TT
1588/* IO helper functions */
1589extern void maybe_flush_or_die(FILE *, const char *);
9540ce50
JK
1590__attribute__((format (printf, 2, 3)))
1591extern void fprintf_or_die(FILE *, const char *fmt, ...);
00b7cbfc
JH
1592
1593#define COPY_READ_ERROR (-2)
1594#define COPY_WRITE_ERROR (-3)
f3123c4a 1595extern int copy_fd(int ifd, int ofd);
1468bd47 1596extern int copy_file(const char *dst, const char *src, int mode);
f7835a25 1597extern int copy_file_with_time(const char *dst, const char *src, int mode);
00b7cbfc 1598
7230e6d0 1599extern void write_or_die(int fd, const void *buf, size_t count);
6ce4e61f 1600extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
e0814056 1601extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
4c81b03e 1602extern void fsync_or_die(int fd, const char *);
ad897215 1603
2b7ca830
JM
1604extern ssize_t read_in_full(int fd, void *buf, size_t count);
1605extern ssize_t write_in_full(int fd, const void *buf, size_t count);
426ddeea
YM
1606extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1607
2b7ca830
JM
1608static inline ssize_t write_str_in_full(int fd, const char *str)
1609{
1610 return write_in_full(fd, str, strlen(str));
1611}
12d6ce1d
JH
1612
1613extern int write_file(const char *path, const char *fmt, ...);
1614extern int write_file_gently(const char *path, const char *fmt, ...);
2b7ca830 1615
f67b45f8
LT
1616/* pager.c */
1617extern void setup_pager(void);
872da32d 1618extern const char *pager_program;
6e9af863 1619extern int pager_in_use(void);
aa086eb8 1620extern int pager_use_color;
ad6c3739 1621extern int term_columns(void);
d306f3d3 1622extern int decimal_width(uintmax_t);
4914c962 1623extern int check_pager_config(const char *cmd);
f67b45f8 1624
ee9601e6 1625extern const char *editor_program;
d3e7da89 1626extern const char *askpass_program;
dfb068be 1627extern const char *excludes_file;
4d87b9c5 1628
051308f6 1629/* base85 */
f9815772
JM
1630int decode_85(char *dst, const char *line, int linelen);
1631void encode_85(char *buf, const unsigned char *data, int bytes);
051308f6 1632
855419f7 1633/* alloc.c */
100c5f3b
LT
1634extern void *alloc_blob_node(void);
1635extern void *alloc_tree_node(void);
1636extern void *alloc_commit_node(void);
1637extern void *alloc_tag_node(void);
1638extern void *alloc_object_node(void);
855419f7 1639extern void alloc_report(void);
94d5a22c 1640extern unsigned int alloc_commit_index(void);
855419f7 1641
5991a55c 1642/* pkt-line.c */
bbc30f99 1643void packet_trace_identity(const char *prog);
6ce4e61f 1644
b6ec1d61 1645/* add */
7ae02a30
AR
1646/*
1647 * return 0 if success, 1 - if addition of a file failed and
1648 * ADD_FILES_IGNORE_ERRORS was specified in flags
1649 */
3efe8e43 1650int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
b6ec1d61 1651
aecbf914
JH
1652/* diff.c */
1653extern int diff_auto_refresh_index;
1654
68faf689
JH
1655/* match-trees.c */
1656void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
85e51b78 1657void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
68faf689 1658
a9cc857a
JH
1659/*
1660 * whitespace rules.
1661 * used by both diff and apply
f4b05a49 1662 * last two digits are tab width
a9cc857a 1663 */
f4b05a49
JS
1664#define WS_BLANK_AT_EOL 0100
1665#define WS_SPACE_BEFORE_TAB 0200
1666#define WS_INDENT_WITH_NON_TAB 0400
1667#define WS_CR_AT_EOL 01000
1668#define WS_BLANK_AT_EOF 02000
1669#define WS_TAB_IN_INDENT 04000
aeb84b05 1670#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
f4b05a49
JS
1671#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1672#define WS_TAB_WIDTH_MASK 077
cf1b7869
JH
1673extern unsigned whitespace_rule_cfg;
1674extern unsigned whitespace_rule(const char *);
1675extern unsigned parse_whitespace_rule(const char *);
8f8841e9
JH
1676extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1677extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
c1795bb0 1678extern char *whitespace_error_string(unsigned ws);
d511bd33 1679extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
877f23cc 1680extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
f4b05a49 1681#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
a9cc857a 1682
ee425e46 1683/* ls-files */
ee425e46
JH
1684void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1685
94351118 1686char *alias_lookup(const char *alias);
0989fe96 1687int split_cmdline(char *cmdline, const char ***argv);
ad9ac6db
GB
1688/* Takes a negative value returned by split_cmdline */
1689const char *split_cmdline_strerror(int cmdline_errno);
94351118 1690
e37c1329
NTND
1691/* git.c */
1692struct startup_info {
a60645f9 1693 int have_repository;
f07d6a1a 1694 const char *prefix;
e37c1329
NTND
1695};
1696extern struct startup_info *startup_info;
1697
db699a8a
NTND
1698/* merge.c */
1699struct commit_list;
1700int try_merge_command(const char *strategy, size_t xopts_nr,
1701 const char **xopts, struct commit_list *common,
1702 const char *head_arg, struct commit_list *remotes);
1703int checkout_fast_forward(const unsigned char *from,
1704 const unsigned char *to,
1705 int overwrite_ignore);
1706
cac42b26 1707
38f865c2
JK
1708int sane_execvp(const char *file, char *const argv[]);
1709
38612532
MH
1710/*
1711 * A struct to encapsulate the concept of whether a file has changed
1712 * since we last checked it. This uses criteria similar to those used
1713 * for the index.
1714 */
1715struct stat_validity {
1716 struct stat_data *sd;
1717};
1718
1719void stat_validity_clear(struct stat_validity *sv);
1720
1721/*
1722 * Returns 1 if the path is a regular file (or a symlink to a regular
1723 * file) and matches the saved stat_validity, 0 otherwise. A missing
1724 * or inaccessible file is considered a match if the struct was just
1725 * initialized, or if the previous update found an inaccessible file.
1726 */
1727int stat_validity_check(struct stat_validity *sv, const char *path);
1728
1729/*
1730 * Update the stat_validity from a file opened at descriptor fd. If
1731 * the file is missing, inaccessible, or not a regular file, then
1732 * future calls to stat_validity_check will match iff one of those
1733 * conditions continues to be true.
1734 */
1735void stat_validity_update(struct stat_validity *sv, int fd);
1736
9ef176b5 1737int versioncmp(const char *s1, const char *s2);
2024d317 1738void sleep_millisec(int millisec);
9ef176b5 1739
e83c5163 1740#endif /* CACHE_H */