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