format-patch: use GIT_COMMITTER_EMAIL in message ids
[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"
cf558704 6#include "hash.h"
75194438 7#include "advice.h"
65784830 8#include "gettext.h"
d1bf0e08 9#include "convert.h"
e83c5163 10
cef661fc 11#include SHA1_HEADER
9126f009
NP
12#ifndef git_SHA_CTX
13#define git_SHA_CTX SHA_CTX
14#define git_SHA1_Init SHA1_Init
15#define git_SHA1_Update SHA1_Update
16#define git_SHA1_Final SHA1_Final
17#endif
e83c5163 18
9126f009 19#include <zlib.h>
ef49a7a0
JH
20typedef struct git_zstream {
21 z_stream z;
22 unsigned long avail_in;
23 unsigned long avail_out;
24 unsigned long total_in;
25 unsigned long total_out;
26 unsigned char *next_in;
27 unsigned char *next_out;
28} git_zstream;
29
30void git_inflate_init(git_zstream *);
31void git_inflate_init_gzip_only(git_zstream *);
32void git_inflate_end(git_zstream *);
33int git_inflate(git_zstream *, int flush);
34
35void git_deflate_init(git_zstream *, int level);
36void git_deflate_init_gzip(git_zstream *, int level);
37void git_deflate_end(git_zstream *);
568508e7 38int git_deflate_abort(git_zstream *);
ef49a7a0
JH
39int git_deflate_end_gently(git_zstream *);
40int git_deflate(git_zstream *, int flush);
41unsigned long git_deflate_bound(git_zstream *, unsigned long);
39c68542 42
962554c6 43#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
b6829693
ET
44#define DTYPE(de) ((de)->d_type)
45#else
0bdd79af
JH
46#undef DT_UNKNOWN
47#undef DT_DIR
48#undef DT_REG
49#undef DT_LNK
b6829693
ET
50#define DT_UNKNOWN 0
51#define DT_DIR 1
52#define DT_REG 2
a15c1c60 53#define DT_LNK 3
b6829693
ET
54#define DTYPE(de) DT_UNKNOWN
55#endif
56
40689ae1
MK
57/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
58#define S_IFINVALID 0030000
59
9eec4795
LT
60/*
61 * A "directory link" is a link to another git directory.
62 *
63 * The value 0160000 is not normally a valid mode, and
64 * also just happens to be S_IFDIR + S_IFLNK
65 *
66 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
67 * always having the same values everywhere. We should use
68 * our internal git values for these things, and then we can
69 * translate that to the OS-specific value. It just so
70 * happens that everybody shares the same bit representation
71 * in the UNIX world (and apparently wider too..)
72 */
302b9282
MW
73#define S_IFGITLINK 0160000
74#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
9eec4795 75
2386d658
LT
76/*
77 * Intensive research over the course of many years has shown that
78 * port 9418 is totally unused by anything else. Or
79 *
80 * Your search - "port 9418" - did not match any documents.
81 *
82 * as www.google.com puts it.
ba8a4970
LT
83 *
84 * This port has been properly assigned for git use by IANA:
85 * git (Assigned-9418) [I06-050728-0001].
86 *
87 * git 9418/tcp git pack transfer service
88 * git 9418/udp git pack transfer service
89 *
90 * with Linus Torvalds <torvalds@osdl.org> as the point of
91 * contact. September 2005.
92 *
93 * See http://www.iana.org/assignments/port-numbers
2386d658
LT
94 */
95#define DEFAULT_GIT_PORT 9418
96
e83c5163
LT
97/*
98 * Basic data structures for the directory cache
e83c5163
LT
99 */
100
101#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
102struct cache_header {
ccc4feb5
LT
103 unsigned int hdr_signature;
104 unsigned int hdr_version;
105 unsigned int hdr_entries;
e83c5163
LT
106};
107
9d227781
JH
108#define INDEX_FORMAT_LB 2
109#define INDEX_FORMAT_UB 4
110
e83c5163
LT
111/*
112 * The "cache_time" is just the low 32 bits of the
113 * time. It doesn't matter if it overflows - we only
114 * check it for equality in the 32 bits we save.
115 */
116struct cache_time {
117 unsigned int sec;
118 unsigned int nsec;
119};
120
e83c5163 121struct cache_entry {
fba2f38a
KB
122 struct cache_time ce_ctime;
123 struct cache_time ce_mtime;
ccc4feb5
LT
124 unsigned int ce_dev;
125 unsigned int ce_ino;
126 unsigned int ce_mode;
127 unsigned int ce_uid;
128 unsigned int ce_gid;
129 unsigned int ce_size;
7a51ed66 130 unsigned int ce_flags;
e83c5163 131 unsigned char sha1[20];
eb7a2f1d 132 struct cache_entry *next;
2548183b 133 struct cache_entry *dir_next;
8f1d2e6f 134 char name[FLEX_ARRAY]; /* more */
e83c5163
LT
135};
136
95fd5bf8
LT
137#define CE_NAMEMASK (0x0fff)
138#define CE_STAGEMASK (0x3000)
16ce2e4c 139#define CE_EXTENDED (0x4000)
5f73076c 140#define CE_VALID (0x8000)
aee46198 141#define CE_STAGESHIFT 12
95fd5bf8 142
06aaaa0b
NTND
143/*
144 * Range 0xFFFF0000 in ce_flags is divided into
145 * two parts: in-memory flags and on-disk ones.
146 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
147 * if you want to save a new flag, add it in
148 * CE_EXTENDED_FLAGS
149 *
150 * In-memory only flags
151 */
2977ffbb
NTND
152#define CE_UPDATE (1 << 16)
153#define CE_REMOVE (1 << 17)
154#define CE_UPTODATE (1 << 18)
155#define CE_ADDED (1 << 19)
a22c6371 156
2977ffbb
NTND
157#define CE_HASHED (1 << 20)
158#define CE_UNHASHED (1 << 21)
159#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
160#define CE_CONFLICTED (1 << 23)
7a51ed66 161
2977ffbb 162#define CE_UNPACKED (1 << 24)
2431afbf 163#define CE_NEW_SKIP_WORKTREE (1 << 25)
da165f47 164
06aaaa0b
NTND
165/*
166 * Extended on-disk flags
167 */
2977ffbb
NTND
168#define CE_INTENT_TO_ADD (1 << 29)
169#define CE_SKIP_WORKTREE (1 << 30)
06aaaa0b 170/* CE_EXTENDED2 is for future extension */
2977ffbb 171#define CE_EXTENDED2 (1 << 31)
06aaaa0b 172
44a36913 173#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
06aaaa0b
NTND
174
175/*
176 * Safeguard to avoid saving wrong flags:
177 * - CE_EXTENDED2 won't get saved until its semantic is known
178 * - Bits in 0x0000FFFF have been saved in ce_flags already
179 * - Bits in 0x003F0000 are currently in-memory flags
180 */
181#if CE_EXTENDED_FLAGS & 0x803FFFFF
182#error "CE_EXTENDED_FLAGS out of range"
183#endif
184
eb7a2f1d
LT
185/*
186 * Copy the sha1 and stat state of a cache entry from one to
187 * another. But we never change the name, or the hash state!
188 */
189#define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
190static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
191{
192 unsigned int state = dst->ce_flags & CE_STATE_MASK;
193
194 /* Don't copy hash chain and name */
195 memcpy(dst, src, offsetof(struct cache_entry, next));
196
197 /* Restore the hash state */
198 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
199}
200
7fec10b7
JH
201static inline unsigned create_ce_flags(size_t len, unsigned stage)
202{
203 if (len >= CE_NAMEMASK)
204 len = CE_NAMEMASK;
205 return (len | (stage << CE_STAGESHIFT));
206}
207
208static inline size_t ce_namelen(const struct cache_entry *ce)
209{
210 size_t len = ce->ce_flags & CE_NAMEMASK;
211 if (len < CE_NAMEMASK)
212 return len;
213 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
214}
215
aee46198 216#define ce_size(ce) cache_entry_size(ce_namelen(ce))
7a51ed66 217#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
eadb5831 218#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
44a36913 219#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
eadb5831 220#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
aee46198 221
e4479470 222#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
223static inline unsigned int create_ce_mode(unsigned int mode)
224{
8ae0a8c5 225 if (S_ISLNK(mode))
7a51ed66 226 return S_IFLNK;
302b9282 227 if (S_ISDIR(mode) || S_ISGITLINK(mode))
7a51ed66
LT
228 return S_IFGITLINK;
229 return S_IFREG | ce_permissions(mode);
8ae0a8c5 230}
185c975f
JH
231static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
232{
78a8d641
JS
233 extern int trust_executable_bit, has_symlinks;
234 if (!has_symlinks && S_ISREG(mode) &&
7a51ed66 235 ce && S_ISLNK(ce->ce_mode))
78a8d641 236 return ce->ce_mode;
185c975f 237 if (!trust_executable_bit && S_ISREG(mode)) {
7a51ed66 238 if (ce && S_ISREG(ce->ce_mode))
185c975f
JH
239 return ce->ce_mode;
240 return create_ce_mode(0666);
241 }
242 return create_ce_mode(mode);
243}
d6b8fc30
JH
244static inline int ce_to_dtype(const struct cache_entry *ce)
245{
246 unsigned ce_mode = ntohl(ce->ce_mode);
247 if (S_ISREG(ce_mode))
248 return DT_REG;
249 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
250 return DT_DIR;
251 else if (S_ISLNK(ce_mode))
252 return DT_LNK;
253 else
254 return DT_UNKNOWN;
255}
b90d9b88
RS
256static inline unsigned int canon_mode(unsigned int mode)
257{
258 if (S_ISREG(mode))
259 return S_IFREG | ce_permissions(mode);
260 if (S_ISLNK(mode))
261 return S_IFLNK;
262 if (S_ISDIR(mode))
263 return S_IFDIR;
264 return S_IFGITLINK;
265}
e4479470 266
ee7825b5 267#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
f5cabd13 268
228e94f9
JH
269struct index_state {
270 struct cache_entry **cache;
9d227781 271 unsigned int version;
228e94f9 272 unsigned int cache_nr, cache_alloc, cache_changed;
cfc5789a 273 struct string_list *resolve_undo;
228e94f9 274 struct cache_tree *cache_tree;
fba2f38a 275 struct cache_time timestamp;
913e0e99
JH
276 unsigned name_hash_initialized : 1,
277 initialized : 1;
cf558704 278 struct hash_table name_hash;
228e94f9
JH
279};
280
281extern struct index_state the_index;
282
96872bc2
LT
283/* Name hashing */
284extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
285/*
286 * We don't actually *remove* it, we can just mark it invalid so that
287 * we won't find it in lookups.
288 *
289 * Not only would we have to search the lists (simple enough), but
290 * we'd also have to rehash other hash buckets in case this makes the
291 * hash bucket empty (common). So it's much better to just mark
292 * it.
293 */
294static inline void remove_name_hash(struct cache_entry *ce)
295{
296 ce->ce_flags |= CE_UNHASHED;
297}
298
299
4aab5b46 300#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
228e94f9
JH
301#define active_cache (the_index.cache)
302#define active_nr (the_index.cache_nr)
303#define active_alloc (the_index.cache_alloc)
304#define active_cache_changed (the_index.cache_changed)
305#define active_cache_tree (the_index.cache_tree)
e83c5163 306
4aab5b46
JH
307#define read_cache() read_index(&the_index)
308#define read_cache_from(path) read_index_from(&the_index, (path))
671c9b7e 309#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
fa7b3c2f 310#define is_cache_unborn() is_index_unborn(&the_index)
e46bbcf6 311#define read_cache_unmerged() read_index_unmerged(&the_index)
4aab5b46
JH
312#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
313#define discard_cache() discard_index(&the_index)
94a5728c 314#define unmerged_cache() unmerged_index(&the_index)
4aab5b46
JH
315#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
316#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
81dc2307 317#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
4aab5b46
JH
318#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
319#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
38ed1d89
JH
320#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
321#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
3deffc52 322#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
4bd5b7da
JH
323#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
324#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
cd2fef59 325#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
98fa4738 326#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
cfc5789a 327#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
8aa38563 328#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
4421a823 329#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
4aab5b46 330#endif
e83c5163 331
edaec3fb
JH
332enum object_type {
333 OBJ_BAD = -1,
334 OBJ_NONE = 0,
335 OBJ_COMMIT = 1,
336 OBJ_TREE = 2,
337 OBJ_BLOB = 3,
338 OBJ_TAG = 4,
339 /* 5 for future expansion */
340 OBJ_OFS_DELTA = 6,
341 OBJ_REF_DELTA = 7,
355885d5 342 OBJ_ANY,
4b05548f 343 OBJ_MAX
edaec3fb
JH
344};
345
b45563a2
JH
346static inline enum object_type object_type(unsigned int mode)
347{
348 return S_ISDIR(mode) ? OBJ_TREE :
349 S_ISGITLINK(mode) ? OBJ_COMMIT :
350 OBJ_BLOB;
351}
352
8ac069ac 353#define GIT_DIR_ENVIRONMENT "GIT_DIR"
a1bea2c1 354#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
892c41b9 355#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
8ac069ac 356#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 357#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 358#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 359#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
d4ebc36c
JH
360#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
361#define CONFIG_ENVIRONMENT "GIT_CONFIG"
2b64fc89 362#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
d4ebc36c 363#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
0454dd93 364#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
6476b38b 365#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
d0bfd026
JH
366#define GITATTRIBUTES_FILE ".gitattributes"
367#define INFOATTRIBUTES_FILE "info/attributes"
f48fd688 368#define ATTRIBUTE_MACRO_PREFIX "[attr]"
a97a7468
JS
369#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
370#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
894a9d33 371#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
6956f858
TR
372#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
373#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
bb233d69 374
48a7c1c4
GB
375/*
376 * Repository-local GIT_* environment variables
377 * The array is NULL-terminated to simplify its usage in contexts such
378 * environment creation or simple walk of the list.
379 * The number of non-NULL entries is available as a macro.
380 */
655e8d9c 381#define LOCAL_REPO_ENV_SIZE 9
48a7c1c4
GB
382extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
383
7d1864ce
JH
384extern int is_bare_repository_cfg;
385extern int is_bare_repository(void);
68025633 386extern int is_inside_git_dir(void);
e90fdc39 387extern char *git_work_tree_cfg;
892c41b9 388extern int is_inside_work_tree(void);
d2b0708e 389extern int have_git_dir(void);
c5fba16c 390extern const char *get_git_dir(void);
b3256eb8 391extern int is_git_directory(const char *path);
8ac069ac
JH
392extern char *get_object_directory(void);
393extern char *get_index_file(void);
5da5c8f4 394extern char *get_graft_file(void);
d7ac12b2 395extern int set_git_dir(const char *path);
a1bea2c1
JT
396extern const char *get_git_namespace(void);
397extern const char *strip_namespace(const char *namespaced_ref);
e90fdc39 398extern const char *get_git_work_tree(void);
13d6ec91 399extern const char *read_gitfile(const char *path);
abc06822 400extern const char *resolve_gitdir(const char *suspect);
19757d80 401extern void set_git_work_tree(const char *tree);
8ac069ac
JH
402
403#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 404
6b5ee137 405extern const char **get_pathspec(const char *prefix, const char **pathspec);
59f0f2f3 406extern void setup_work_tree(void);
4ca06608 407extern const char *setup_git_directory_gently(int *);
d288a700 408extern const char *setup_git_directory(void);
edc54fb5 409extern char *prefix_path(const char *prefix, int len, const char *path);
4ca06608 410extern const char *prefix_filename(const char *prefix, int len, const char *path);
c6e8c800 411extern int check_filename(const char *prefix, const char *name);
e23d0b4a 412extern void verify_filename(const char *prefix, const char *name);
ea92f41f 413extern void verify_non_filename(const char *prefix, const char *name);
d288a700 414
f225aeb2
DB
415#define INIT_DB_QUIET 0x0001
416
b57fb80a 417extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
f225aeb2
DB
418extern int init_db(const char *template_dir, unsigned int flags);
419
e83c5163
LT
420#define alloc_nr(x) (((x)+16)*3/2)
421
6815e569
JK
422/*
423 * Realloc the buffer pointed at by variable 'x' so that it can hold
424 * at least 'nr' entries; the number of entries currently allocated
425 * is 'alloc', using the standard growing factor alloc_nr() macro.
426 *
01f6fd4b 427 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
6815e569
JK
428 */
429#define ALLOC_GROW(x, nr, alloc) \
430 do { \
c927e6c6 431 if ((nr) > alloc) { \
4234a761
JH
432 if (alloc_nr(alloc) < (nr)) \
433 alloc = (nr); \
434 else \
435 alloc = alloc_nr(alloc); \
6815e569
JK
436 x = xrealloc((x), alloc * sizeof(*(x))); \
437 } \
98746061 438 } while (0)
6815e569 439
734aab75 440/* Initialize and use the cache information */
4aab5b46 441extern int read_index(struct index_state *);
671c9b7e 442extern int read_index_preload(struct index_state *, const char **pathspec);
4aab5b46 443extern int read_index_from(struct index_state *, const char *path);
fa7b3c2f 444extern int is_index_unborn(struct index_state *);
e46bbcf6 445extern int read_index_unmerged(struct index_state *);
e1afca4f 446extern int write_index(struct index_state *, int newfd);
4aab5b46 447extern int discard_index(struct index_state *);
d1f128b0 448extern int unmerged_index(const struct index_state *);
8dcf39c4 449extern int verify_path(const char *path);
cd2fef59 450extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
d1f128b0 451extern int index_name_pos(const struct index_state *, const char *name, int namelen);
192268c1
JH
452#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
453#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 454#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
af3785dc 455#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
39425819 456#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
4aab5b46 457extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
81dc2307 458extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
4aab5b46 459extern int remove_index_entry_at(struct index_state *, int pos);
36419c8e 460extern void remove_marked_cache_entries(struct index_state *istate);
4aab5b46 461extern int remove_file_from_index(struct index_state *, const char *path);
38ed1d89
JH
462#define ADD_CACHE_VERBOSE 1
463#define ADD_CACHE_PRETEND 2
01665924 464#define ADD_CACHE_IGNORE_ERRORS 4
041aee31 465#define ADD_CACHE_IGNORE_REMOVAL 8
39425819 466#define ADD_CACHE_INTENT 16
38ed1d89
JH
467extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
468extern int add_file_to_index(struct index_state *, const char *path, int flags);
6640f881 469extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
dbbce55b 470extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
98fa4738 471extern int index_name_is_other(const struct index_state *, const char *, int);
4bd5b7da
JH
472
473/* do stat comparison even if CE_VALID is true */
474#define CE_MATCH_IGNORE_VALID 01
475/* do not check the contents but report dirty on racily-clean entries */
56cac48c
NTND
476#define CE_MATCH_RACY_IS_DIRTY 02
477/* do stat comparison even if CE_SKIP_WORKTREE is true */
478#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
d1f128b0
LT
479extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
480extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
4bd5b7da 481
0602f3e9
NTND
482struct pathspec {
483 const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
484 int nr;
9ddf1726
JN
485 unsigned int has_wildcard:1;
486 unsigned int recursive:1;
bc96cc87 487 int max_depth;
0602f3e9
NTND
488 struct pathspec_item {
489 const char *match;
490 int len;
33e0f62b 491 unsigned int use_wildcard:1;
0602f3e9
NTND
492 } *items;
493};
494
495extern int init_pathspec(struct pathspec *, const char **);
496extern void free_pathspec(struct pathspec *);
eb9cb55b 497extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
c4ce46fc
JH
498
499#define HASH_WRITE_OBJECT 1
500#define HASH_FORMAT_CHECK 2
501extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
502extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
415e96c8
JH
503extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
504
405e5b2f
LT
505#define REFRESH_REALLY 0x0001 /* ignore_valid */
506#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
507#define REFRESH_QUIET 0x0004 /* be quiet about it */
508#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
3f1b7b60 509#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
43673fdd 510#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
046613c5 511extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
405e5b2f 512
021b6e45
JH
513struct lock_file {
514 struct lock_file *next;
4723ee99 515 int fd;
5e635e39 516 pid_t owner;
1084b845 517 char on_list;
021b6e45 518 char filename[PATH_MAX];
415e96c8 519};
acd3b9ec
JH
520#define LOCK_DIE_ON_ERROR 1
521#define LOCK_NODEREF 2
1b018fd9 522extern int unable_to_lock_error(const char *path, int err);
e43a6fd3 523extern NORETURN void unable_to_lock_index_die(const char *path, int err);
40aaae88 524extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
ea3cd5c7 525extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
021b6e45 526extern int commit_lock_file(struct lock_file *);
ccdc4ec3 527extern void update_index_if_able(struct index_state *, struct lock_file *);
30ca07a2
JH
528
529extern int hold_locked_index(struct lock_file *, int);
530extern int commit_locked_index(struct lock_file *);
5e7f56ac 531extern void set_alternate_index_output(const char *);
d6cf61bf 532extern int close_lock_file(struct lock_file *);
021b6e45 533extern void rollback_lock_file(struct lock_file *);
eca35a25 534extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
734aab75 535
2ae1c53b 536/* Environment bits from configuration mechanism */
17712991 537extern int trust_executable_bit;
1ce4790b 538extern int trust_ctime;
9378c161 539extern int quote_path_fully;
78a8d641 540extern int has_symlinks;
dce96489 541extern int minimum_abbrev, default_abbrev;
0a9b88b7 542extern int ignore_case;
5f73076c 543extern int assume_unchanged;
9f0bb90d 544extern int prefer_symlink_refs;
6de08ae6 545extern int log_all_ref_updates;
2f8acdb3 546extern int warn_ambiguous_refs;
457f06d6 547extern int shared_repository;
2ae1c53b 548extern const char *apply_default_whitespace;
86c91f91 549extern const char *apply_default_ignorewhitespace;
64589a03 550extern const char *git_attributes_file;
12f6c308 551extern int zlib_compression_level;
960ccca6
DH
552extern int core_compression_level;
553extern int core_compression_seen;
60bb8b14 554extern size_t packed_git_window_size;
77ccc5bb 555extern size_t packed_git_limit;
18bdec11 556extern size_t delta_base_cache_limit;
15366280 557extern unsigned long big_file_threshold;
568508e7 558extern unsigned long pack_size_limit_cfg;
dae556bd 559extern int read_replace_refs;
aafe9fba 560extern int fsync_object_files;
671c9b7e 561extern int core_preload_index;
08aefc9e 562extern int core_apply_sparse_checkout;
17712991 563
9ed36cfa 564enum branch_track {
9188ed89 565 BRANCH_TRACK_UNSPECIFIED = -1,
9ed36cfa
JS
566 BRANCH_TRACK_NEVER = 0,
567 BRANCH_TRACK_REMOTE,
568 BRANCH_TRACK_ALWAYS,
569 BRANCH_TRACK_EXPLICIT,
4b05548f 570 BRANCH_TRACK_OVERRIDE
9ed36cfa
JS
571};
572
c998ae9b
DS
573enum rebase_setup_type {
574 AUTOREBASE_NEVER = 0,
575 AUTOREBASE_LOCAL,
576 AUTOREBASE_REMOTE,
4b05548f 577 AUTOREBASE_ALWAYS
c998ae9b
DS
578};
579
52153747 580enum push_default_type {
52153747
FAG
581 PUSH_DEFAULT_NOTHING = 0,
582 PUSH_DEFAULT_MATCHING,
b55e6775 583 PUSH_DEFAULT_SIMPLE,
53c40311 584 PUSH_DEFAULT_UPSTREAM,
f25950f3
CT
585 PUSH_DEFAULT_CURRENT,
586 PUSH_DEFAULT_UNSPECIFIED
52153747
FAG
587};
588
9ed36cfa 589extern enum branch_track git_branch_track;
c998ae9b 590extern enum rebase_setup_type autorebase;
52153747 591extern enum push_default_type push_default;
9ed36cfa 592
348df166
JS
593enum object_creation_mode {
594 OBJECT_CREATION_USES_HARDLINKS = 0,
4b05548f 595 OBJECT_CREATION_USES_RENAMES = 1
348df166
JS
596};
597
598extern enum object_creation_mode object_creation_mode;
be66a6c4 599
a97a7468
JS
600extern char *notes_ref_name;
601
7f3140cd
JS
602extern int grafts_replace_parents;
603
ab9cb76f
JH
604#define GIT_REPO_VERSION 0
605extern int repository_format_version;
606extern int check_repository_format(void);
607
734aab75
LT
608#define MTIME_CHANGED 0x0001
609#define CTIME_CHANGED 0x0002
610#define OWNER_CHANGED 0x0004
611#define MODE_CHANGED 0x0008
612#define INODE_CHANGED 0x0010
613#define DATA_CHANGED 0x0020
8ae0a8c5 614#define TYPE_CHANGED 0x0040
e83c5163 615
108bebea
AR
616extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
617 __attribute__((format (printf, 3, 4)));
fe2d7776
AR
618extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
619 __attribute__((format (printf, 3, 4)));
aba13e7c
AR
620extern char *git_pathdup(const char *fmt, ...)
621 __attribute__((format (printf, 1, 2)));
108bebea 622
e83c5163 623/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0
TS
624extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
625extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
0bad611b
HV
626extern char *git_path_submodule(const char *path, const char *fmt, ...)
627 __attribute__((format (printf, 2, 3)));
628
73134b6d 629extern char *sha1_file_name(const unsigned char *sha1);
bf592c50
DB
630extern char *sha1_pack_name(const unsigned char *sha1);
631extern char *sha1_pack_index_name(const unsigned char *sha1);
013f276e 632extern const char *find_unique_abbrev(const unsigned char *sha1, int);
88cd621d 633extern const unsigned char null_sha1[20];
1a812f3a
IM
634
635static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
0bef57ee 636{
1a812f3a
IM
637 int i;
638
639 for (i = 0; i < 20; i++, sha1++, sha2++) {
640 if (*sha1 != *sha2)
641 return *sha1 - *sha2;
642 }
643
644 return 0;
0bef57ee 645}
1a812f3a
IM
646
647static inline int is_null_sha1(const unsigned char *sha1)
a89fccd2 648{
1a812f3a 649 return !hashcmp(sha1, null_sha1);
a89fccd2 650}
1a812f3a 651
e702496e
SP
652static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
653{
654 memcpy(sha_dst, sha_src, 20);
655}
a8e0d16d
JH
656static inline void hashclr(unsigned char *hash)
657{
658 memset(hash, 0, 20);
659}
e83c5163 660
14d9c578
JK
661#define EMPTY_TREE_SHA1_HEX \
662 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
dab0d410 663#define EMPTY_TREE_SHA1_BIN_LITERAL \
14d9c578
JK
664 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
665 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
dab0d410
JN
666#define EMPTY_TREE_SHA1_BIN \
667 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
14d9c578 668
f8582cad
JK
669#define EMPTY_BLOB_SHA1_HEX \
670 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
671#define EMPTY_BLOB_SHA1_BIN_LITERAL \
672 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
673 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
674#define EMPTY_BLOB_SHA1_BIN \
675 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
676
677static inline int is_empty_blob_sha1(const unsigned char *sha1)
678{
679 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
680}
681
f2db68ed
HE
682int git_mkstemp(char *path, size_t n, const char *template);
683
003b33a8
DA
684int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
685
b862b61c
MM
686/* set default permissions by passing mode arguments to open(2) */
687int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
688int git_mkstemp_mode(char *pattern, int mode);
689
06cbe855
HO
690/*
691 * NOTE NOTE NOTE!!
692 *
693 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
694 * not be changed. Old repositories have core.sharedrepository written in
695 * numeric format, and therefore these values are preserved for compatibility
696 * reasons.
697 */
94df2506 698enum sharedrepo {
06cbe855
HO
699 PERM_UMASK = 0,
700 OLD_PERM_GROUP = 1,
701 OLD_PERM_EVERYBODY = 2,
702 PERM_GROUP = 0660,
4b05548f 703 PERM_EVERYBODY = 0664
94df2506
JH
704};
705int git_config_perm(const char *var, const char *value);
17e61b82
JH
706int set_shared_perm(const char *path, int mode);
707#define adjust_shared_perm(path) set_shared_perm((path), 0)
b2cb9425 708int safe_create_leading_directories(char *path);
8e21d63b 709int safe_create_leading_directories_const(const char *path);
90a6464b 710int mkdir_in_gitdir(const char *path);
395de250 711extern char *expand_user_path(const char *path);
1c64b48e 712const char *enter_repo(const char *path, int strict);
e5392c51
JS
713static inline int is_absolute_path(const char *path)
714{
88135203 715 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
e5392c51 716}
90b4a71c 717int is_directory(const char *);
e2a57aac
CMN
718const char *real_path(const char *path);
719const char *absolute_path(const char *path);
720const char *relative_path(const char *abs, const char *base);
f3cad0ad 721int normalize_path_copy(char *dst, const char *src);
0454dd93 722int longest_ancestor_length(const char *path, const char *prefix_list);
4fcc86b0 723char *strip_path_suffix(const char *path, const char *suffix);
34b6cb8b 724int daemon_avoid_alias(const char *path);
4bb43de2 725int offset_1st_component(const char *path);
b2cb9425 726
e1111cef 727/* object replacement */
5bf29b95
JH
728#define READ_SHA1_FILE_REPLACE 1
729extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
f5552aee
CC
730static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
731{
5bf29b95
JH
732 return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
733}
e1111cef
JH
734extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
735static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
736{
737 if (!read_replace_refs)
738 return sha1;
739 return do_lookup_replace_object(sha1);
f5552aee 740}
e1111cef 741
e83c5163 742/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
21666f1a 743extern int sha1_object_info(const unsigned char *, unsigned long *);
ce9fbf16 744extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
c00e657d 745extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
21666f1a 746extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
bbac7311 747extern int force_object_loose(const unsigned char *sha1, time_t mtime);
f0270efd 748extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
eb4f4076 749extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
f0270efd 750extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
8237b185 751
0e8189e2
NP
752/* global flag to enable extra checks when accessing packed objects */
753extern int do_check_packed_object_crc;
754
5f44324d
JH
755/* for development: log offset of pack access */
756extern const char *log_pack_access;
757
5d6ccf5c 758extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 759
839837b9 760extern int move_temp_to_file(const char *tmpfile, const char *filename);
8237b185 761
cd673c1f 762extern int has_sha1_pack(const unsigned char *sha1);
8237b185 763extern int has_sha1_file(const unsigned char *sha1);
0f4dc14a 764extern int has_loose_object_nonlocal(const unsigned char *sha1);
8237b185 765
bf592c50
DB
766extern int has_pack_index(const unsigned char *sha1);
767
40d52ff7
JK
768extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
769
192a6be2
LT
770extern const signed char hexval_table[256];
771static inline unsigned int hexval(unsigned char c)
e49521b5
JH
772{
773 return hexval_table[c];
774}
775
e83c5163 776/* Convert to/from hex/sha1 representation */
dce96489
LT
777#define MINIMUM_ABBREV minimum_abbrev
778#define DEFAULT_ABBREV default_abbrev
46a6c262 779
573285e5
CP
780struct object_context {
781 unsigned char tree[20];
782 char path[PATH_MAX];
783 unsigned mode;
784};
785
3c249c95 786extern int get_sha1(const char *str, unsigned char *sha1);
2e83b66c 787extern int get_sha1_with_mode_1(const char *str, unsigned char *sha1, unsigned *mode, int only_to_die, const char *prefix);
009fee47
MM
788static inline int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode)
789{
2e83b66c 790 return get_sha1_with_mode_1(str, sha1, mode, 0, NULL);
009fee47 791}
2e83b66c 792extern int get_sha1_with_context_1(const char *name, unsigned char *sha1, struct object_context *orc, int only_to_die, const char *prefix);
573285e5
CP
793static inline int get_sha1_with_context(const char *str, unsigned char *sha1, struct object_context *orc)
794{
2e83b66c 795 return get_sha1_with_context_1(str, sha1, orc, 0, NULL);
573285e5 796}
d4e85a1a
MH
797
798/*
799 * Try to read a SHA1 in hexadecimal format from the 40 characters
800 * starting at hex. Write the 20-byte result to sha1 in binary form.
801 * Return 0 on success. Reading stops if a NUL is encountered in the
802 * input, so it is safe to pass this function an arbitrary
803 * null-terminated string.
804 */
197ee8c9 805extern int get_sha1_hex(const char *hex, unsigned char *sha1);
d4e85a1a 806
197ee8c9 807extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
dfefa935 808extern int read_ref_full(const char *refname, unsigned char *sha1,
c6893323 809 int reading, int *flags);
dfefa935 810extern int read_ref(const char *refname, unsigned char *sha1);
7cb36842
MH
811
812/*
813 * Resolve a reference, recursively following symbolic refererences.
814 *
815 * Store the referred-to object's name in sha1 and return the name of
816 * the non-symbolic reference that ultimately pointed at it. The
817 * return value, if not NULL, is a pointer into either a static buffer
818 * or the input ref.
819 *
820 * If the reference cannot be resolved to an object, the behavior
821 * depends on the "reading" argument:
822 *
823 * - If reading is set, return NULL.
824 *
825 * - If reading is not set, clear sha1 and return the name of the last
826 * reference name in the chain, which will either be a non-symbolic
827 * reference or an undefined reference. If this is a prelude to
828 * "writing" to the ref, the return value is the name of the ref
829 * that will actually be created or changed.
830 *
831 * If flag is non-NULL, set the value that it points to the
832 * combination of REF_ISPACKED (if the reference was found among the
833 * packed references) and REF_ISSYMREF (if the initial reference was a
834 * symbolic reference).
835 *
836 * If ref is not a properly-formatted, normalized reference, return
837 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
838 * give up and return NULL.
839 *
840 * errno is sometimes set on errors, but not always.
841 */
8cad4744 842extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
96ec7b1e 843extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
7cb36842 844
e86eb666 845extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
eb3a4822 846extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
431b1969 847extern int interpret_branch_name(const char *str, struct strbuf *);
619a644d 848extern int get_sha1_mb(const char *str, unsigned char *sha1);
e86eb666 849
79803322
SP
850extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
851extern const char *ref_rev_parse_rules[];
dd621df9 852#define ref_fetch_rules ref_rev_parse_rules
79803322 853
8b5157e4 854extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
c847f537 855extern int validate_headref(const char *ref);
e83c5163 856
958ba6c9 857extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
0ab9e1e8 858extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 859extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
e83c5163 860
40469ee9 861extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 862 const char *required_type,
40469ee9
JH
863 unsigned long *size,
864 unsigned char *sha1_ret);
f4913f91 865
81776315
JH
866extern struct object *peel_to_type(const char *name, int namelen,
867 struct object *o, enum object_type);
868
73013afd
JH
869enum date_mode {
870 DATE_NORMAL = 0,
871 DATE_RELATIVE,
872 DATE_SHORT,
873 DATE_LOCAL,
874 DATE_ISO8601,
7dff9b30
LT
875 DATE_RFC2822,
876 DATE_RAW
73013afd
JH
877};
878
f8493ec0 879const char *show_date(unsigned long time, int timezone, enum date_mode mode);
7d29afd4
JN
880void show_date_relative(unsigned long time, int tz, const struct timeval *now,
881 struct strbuf *timebuf);
2a39064c 882int parse_date(const char *date, char *buf, int bufsize);
9644c061 883int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
ecee9d9e 884void datestamp(char *buf, int bufsize);
93cfa7c7
JH
885#define approxidate(s) approxidate_careful((s), NULL)
886unsigned long approxidate_careful(const char *, int *);
33012fc4 887unsigned long approxidate_relative(const char *date, const struct timeval *now);
856665f8 888enum date_mode parse_date_format(const char *format);
ecee9d9e 889
b9f0ac17
JK
890#define IDENT_ERROR_ON_NO_NAME 1
891#define IDENT_NO_DATE 2
c15e1987 892#define IDENT_NO_NAME 4
749be728
JH
893extern const char *git_author_info(int);
894extern const char *git_committer_info(int);
798123af 895extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
d9ccfe77 896extern const char *fmt_name(const char *name, const char *email);
bcb2b004
JK
897extern const char *ident_default_name(void);
898extern const char *ident_default_email(void);
899extern const char *ident_default_date(void);
44fcb497 900extern const char *git_editor(void);
64778d24 901extern const char *git_pager(int stdout_is_tty);
9597921b 902extern int git_ident_config(const char *, const char *, void *);
6aa33f40 903
4b340cfa
JH
904struct ident_split {
905 const char *name_begin;
906 const char *name_end;
907 const char *mail_begin;
908 const char *mail_end;
909 const char *date_begin;
910 const char *date_end;
911 const char *tz_begin;
912 const char *tz_end;
913};
914/*
915 * Signals an success with 0, but time part of the result may be NULL
916 * if the input lacks timestamp and zone
917 */
918extern int split_ident_line(struct ident_split *, const char *, int);
919
12dccc16
LT
920struct checkout {
921 const char *base_dir;
922 int base_dir_len;
923 unsigned force:1,
924 quiet:1,
925 not_new:1,
926 refresh_cache:1;
927};
928
efbc5831 929extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
b9fd2846
LT
930
931struct cache_def {
932 char path[PATH_MAX + 1];
933 int len;
934 int flags;
935 int track_flags;
936 int prefix_len_stat_func;
937};
938
57199892 939extern int has_symlink_leading_path(const char *name, int len);
b9fd2846 940extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
f66caaf9 941extern int check_leading_path(const char *name, int len);
15438d5a 942extern int threaded_check_leading_path(struct cache_def *cache, const char *name, int len);
57199892 943extern int has_dirs_only_path(const char *name, int len, int prefix_len);
15438d5a 944extern int threaded_has_dirs_only_path(struct cache_def *cache, const char *name, int len, int prefix_len);
78478927
KB
945extern void schedule_dir_for_removal(const char *name, int len);
946extern void remove_scheduled_dirs(void);
12dccc16 947
9a217f2a 948extern struct alternate_object_database {
d5a63b99 949 struct alternate_object_database *next;
9a217f2a 950 char *name;
8f1d2e6f 951 char base[FLEX_ARRAY]; /* more */
d5a63b99 952} *alt_odb_list;
9a217f2a 953extern void prepare_alt_odb(void);
bef70b22 954extern void add_to_alternates_file(const char *reference);
d79796bc
JH
955typedef int alt_odb_fn(struct alternate_object_database *, void *);
956extern void foreach_alt_odb(alt_odb_fn, void*);
9a217f2a 957
c41ee586
SP
958struct pack_window {
959 struct pack_window *next;
960 unsigned char *base;
961 off_t offset;
962 size_t len;
963 unsigned int last_used;
964 unsigned int inuse_cnt;
965};
966
9a217f2a
JH
967extern struct packed_git {
968 struct packed_git *next;
c41ee586 969 struct pack_window *windows;
2dc3a234 970 off_t pack_size;
57059091
NP
971 const void *index_data;
972 size_t index_size;
973 uint32_t num_objects;
8eca0b47
NP
974 uint32_t num_bad_objects;
975 unsigned char *bad_object_sha1;
42873078 976 int index_version;
57059091 977 time_t mtime;
9bc879c1 978 int pack_fd;
8d25931d 979 unsigned pack_local:1,
d131b7af
SP
980 pack_keep:1,
981 do_not_close:1;
bf592c50 982 unsigned char sha1[20];
8f1d2e6f
JH
983 /* something like ".git/objects/pack/xxxxx.pack" */
984 char pack_name[FLEX_ARRAY]; /* more */
9a217f2a 985} *packed_git;
f3bf9224
JH
986
987struct pack_entry {
c4001d92 988 off_t offset;
f3bf9224
JH
989 unsigned char sha1[20];
990 struct packed_git *p;
991};
992
d1c133f5
LT
993struct ref {
994 struct ref *next;
995 unsigned char old_sha1[20];
996 unsigned char new_sha1[20];
be885d96 997 char *symref;
9f8a15c7
SP
998 unsigned int force:1,
999 merge:1,
1000 nonfastforward:1,
1001 deletion:1;
8736a848
JK
1002 enum {
1003 REF_STATUS_NONE = 0,
1004 REF_STATUS_OK,
1005 REF_STATUS_REJECT_NONFASTFORWARD,
1006 REF_STATUS_REJECT_NODELETE,
1007 REF_STATUS_UPTODATE,
ca74c458 1008 REF_STATUS_REMOTE_REJECT,
4b05548f 1009 REF_STATUS_EXPECTING_REPORT
8736a848 1010 } status;
2a0fe89a 1011 char *remote_status;
f88395ac 1012 struct ref *peer_ref; /* when renaming */
8f1d2e6f 1013 char name[FLEX_ARRAY]; /* more */
d1c133f5
LT
1014};
1015
2718ff09
LT
1016#define REF_NORMAL (1u << 0)
1017#define REF_HEADS (1u << 1)
1018#define REF_TAGS (1u << 2)
1019
5483f799 1020extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
cda69f48 1021
7841ce79 1022#define CONNECT_VERBOSE (1u << 0)
4577370e 1023extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
98158e9c 1024extern int finish_connect(struct child_process *conn);
7ffe853b 1025extern int git_connection_is_socket(struct child_process *conn);
40c155ff
JH
1026struct extra_have_objects {
1027 int nr, alloc;
1028 unsigned char (*array)[20];
1029};
afe7c5ff 1030extern struct ref **get_remote_heads(int in, struct ref **list, unsigned int flags, struct extra_have_objects *);
211b5f9e 1031extern int server_supports(const char *feature);
f47182c8 1032extern const char *parse_feature_request(const char *features, const char *feature);
f7192598 1033
7b64469a 1034extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
bf592c50 1035
9a217f2a 1036extern void prepare_packed_git(void);
fc04c412 1037extern void reprepare_packed_git(void);
bf592c50
DB
1038extern void install_packed_git(struct packed_git *pack);
1039
a6080a0a 1040extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
bf592c50
DB
1041 struct packed_git *packs);
1042
276bc2ca 1043extern void pack_report(void);
d079837e 1044extern int open_pack_index(struct packed_git *);
fa5fc15d 1045extern void close_pack_index(struct packed_git *);
ef49a7a0 1046extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
c9ced051 1047extern void close_pack_windows(struct packed_git *);
03e79c88 1048extern void unuse_pack(struct pack_window **);
c74faea1 1049extern void free_pack_by_name(const char *);
3d20c636 1050extern void clear_delta_base_cache(void);
42873078 1051extern struct packed_git *add_packed_git(const char *, int, int);
d079837e 1052extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
99093238 1053extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
c4001d92 1054extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
4c080182 1055extern int is_pack_valid(struct packed_git *);
c4001d92 1056extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
09ded04b 1057extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
54dab52a 1058extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
f8c8abc5 1059extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
9a217f2a 1060
9a490590
JH
1061struct object_info {
1062 /* Request */
1063 unsigned long *sizep;
1064
1065 /* Response */
1066 enum {
1067 OI_CACHED,
1068 OI_LOOSE,
5266d369
JH
1069 OI_PACKED,
1070 OI_DBCACHED
9a490590
JH
1071 } whence;
1072 union {
1073 /*
1074 * struct {
1075 * ... Nothing to expose in this case
1076 * } cached;
1077 * struct {
1078 * ... Nothing to expose in this case
1079 * } loose;
1080 */
1081 struct {
1082 struct packed_git *pack;
1083 off_t offset;
1084 unsigned int is_delta;
1085 } packed;
1086 } u;
1087};
1088extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
9a217f2a 1089
8f3f9b09
JH
1090/* Dumb servers support */
1091extern int update_server_info(int);
1092
7a397419
MG
1093/* git_config_parse_key() returns these negated: */
1094#define CONFIG_INVALID_KEY 1
1095#define CONFIG_NO_SECTION_OR_NAME 2
1096/* git_config_set(), git_config_set_multivar() return the above or these: */
1097#define CONFIG_NO_LOCK -1
1098#define CONFIG_INVALID_FILE 3
1099#define CONFIG_NO_WRITE 4
1100#define CONFIG_NOTHING_SET 5
1101#define CONFIG_INVALID_PATTERN 6
1102
ef90d6d4
JS
1103typedef int (*config_fn_t)(const char *, const char *, void *);
1104extern int git_default_config(const char *, const char *, void *);
1105extern int git_config_from_file(config_fn_t fn, const char *, void *);
2b64fc89 1106extern void git_config_push_parameter(const char *text);
b3d83d9f 1107extern int git_config_from_parameters(config_fn_t fn, void *data);
ef90d6d4 1108extern int git_config(config_fn_t fn, void *);
9b25a0b5
JK
1109extern int git_config_with_options(config_fn_t fn, void *,
1110 const char *filename, int respect_includes);
dbdf5854 1111extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
0b87b6e0 1112extern int git_parse_ulong(const char *, unsigned long *);
17712991 1113extern int git_config_int(const char *, const char *);
0b87b6e0 1114extern unsigned long git_config_ulong(const char *, const char *);
a53f2ec6 1115extern int git_config_bool_or_int(const char *, const char *, int *);
17712991 1116extern int git_config_bool(const char *, const char *);
8420ccd8 1117extern int git_config_maybe_bool(const char *, const char *);
ea5105a5 1118extern int git_config_string(const char **, const char *, const char *);
395de250 1119extern int git_config_pathname(const char **, const char *, const char *);
5ec31182 1120extern int git_config_set_in_file(const char *, const char *, const char *);
10bea152 1121extern int git_config_set(const char *, const char *);
b09c53a3 1122extern int git_config_parse_key(const char *, char **, int *);
4ddba79d 1123extern int git_config_set_multivar(const char *, const char *, const char *, int);
5ec31182 1124extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
0667fcfb 1125extern int git_config_rename_section(const char *, const char *);
42bd39b5 1126extern int git_config_rename_section_in_file(const char *, const char *, const char *);
506b17b1 1127extern const char *git_etc_gitconfig(void);
ef90d6d4 1128extern int check_repository_format_version(const char *var, const char *value, void *cb);
0ef37164 1129extern int git_env_bool(const char *, int);
ab88c363 1130extern int git_config_system(void);
40ea4ed9 1131extern int config_error_nonbool(const char *);
a6fa5992
PN
1132extern const char *get_log_output_encoding(void);
1133extern const char *get_commit_output_encoding(void);
1134
2496844b
JK
1135extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1136
9b25a0b5
JK
1137struct config_include_data {
1138 int depth;
1139 config_fn_t fn;
1140 void *data;
1141};
1142#define CONFIG_INCLUDE_INIT { 0 }
1143extern int git_config_include(const char *name, const char *value, void *data);
17712991 1144
91c38a21
JH
1145#define IDENT_NAME_GIVEN 01
1146#define IDENT_MAIL_GIVEN 02
1147#define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
bb1ae3f6 1148extern int user_ident_explicitly_given;
5aeb3a3a 1149extern int user_ident_sufficiently_given(void);
e1b10391 1150
1a8f2741 1151extern const char *git_commit_encoding;
3a55602e 1152extern const char *git_log_output_encoding;
d551a488 1153extern const char *git_mailmap_file;
4e72dcec 1154
06f59e9f
TT
1155/* IO helper functions */
1156extern void maybe_flush_or_die(FILE *, const char *);
f3123c4a 1157extern int copy_fd(int ifd, int ofd);
1468bd47 1158extern int copy_file(const char *dst, const char *src, int mode);
f7835a25 1159extern int copy_file_with_time(const char *dst, const char *src, int mode);
7230e6d0 1160extern void write_or_die(int fd, const void *buf, size_t count);
6ce4e61f 1161extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
e0814056 1162extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
4c81b03e 1163extern void fsync_or_die(int fd, const char *);
ad897215 1164
2b7ca830
JM
1165extern ssize_t read_in_full(int fd, void *buf, size_t count);
1166extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1167static inline ssize_t write_str_in_full(int fd, const char *str)
1168{
1169 return write_in_full(fd, str, strlen(str));
1170}
1171
f67b45f8
LT
1172/* pager.c */
1173extern void setup_pager(void);
872da32d 1174extern const char *pager_program;
6e9af863 1175extern int pager_in_use(void);
aa086eb8 1176extern int pager_use_color;
ad6c3739 1177extern int term_columns(void);
ec7ff5ba 1178extern int decimal_width(int);
f67b45f8 1179
ee9601e6 1180extern const char *editor_program;
d3e7da89 1181extern const char *askpass_program;
dfb068be 1182extern const char *excludes_file;
4d87b9c5 1183
051308f6 1184/* base85 */
f9815772
JM
1185int decode_85(char *dst, const char *line, int linelen);
1186void encode_85(char *buf, const unsigned char *data, int bytes);
051308f6 1187
855419f7 1188/* alloc.c */
100c5f3b
LT
1189extern void *alloc_blob_node(void);
1190extern void *alloc_tree_node(void);
1191extern void *alloc_commit_node(void);
1192extern void *alloc_tag_node(void);
1193extern void *alloc_object_node(void);
855419f7
LT
1194extern void alloc_report(void);
1195
6ce4e61f 1196/* trace.c */
28bea9e5 1197__attribute__((format (printf, 1, 2)))
6ce4e61f 1198extern void trace_printf(const char *format, ...);
06796607 1199extern void trace_vprintf(const char *key, const char *format, va_list ap);
28bea9e5 1200__attribute__((format (printf, 2, 3)))
b319ce4c 1201extern void trace_argv_printf(const char **argv, const char *format, ...);
a9ca8a85 1202extern void trace_repo_setup(const char *prefix);
39bc5e46 1203extern int trace_want(const char *key);
94b3b374 1204extern void trace_strbuf(const char *key, const struct strbuf *buf);
6ce4e61f 1205
bbc30f99 1206void packet_trace_identity(const char *prog);
6ce4e61f 1207
b6ec1d61 1208/* add */
7ae02a30
AR
1209/*
1210 * return 0 if success, 1 - if addition of a file failed and
1211 * ADD_FILES_IGNORE_ERRORS was specified in flags
1212 */
1213int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
b6ec1d61 1214
aecbf914
JH
1215/* diff.c */
1216extern int diff_auto_refresh_index;
1217
68faf689
JH
1218/* match-trees.c */
1219void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
85e51b78 1220void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
68faf689 1221
a9cc857a
JH
1222/*
1223 * whitespace rules.
1224 * used by both diff and apply
f4b05a49 1225 * last two digits are tab width
a9cc857a 1226 */
f4b05a49
JS
1227#define WS_BLANK_AT_EOL 0100
1228#define WS_SPACE_BEFORE_TAB 0200
1229#define WS_INDENT_WITH_NON_TAB 0400
1230#define WS_CR_AT_EOL 01000
1231#define WS_BLANK_AT_EOF 02000
1232#define WS_TAB_IN_INDENT 04000
aeb84b05 1233#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
f4b05a49
JS
1234#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1235#define WS_TAB_WIDTH_MASK 077
cf1b7869
JH
1236extern unsigned whitespace_rule_cfg;
1237extern unsigned whitespace_rule(const char *);
1238extern unsigned parse_whitespace_rule(const char *);
8f8841e9
JH
1239extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1240extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
c1795bb0 1241extern char *whitespace_error_string(unsigned ws);
d511bd33 1242extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
877f23cc 1243extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
f4b05a49 1244#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
a9cc857a 1245
ee425e46 1246/* ls-files */
0f64bfa9 1247int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
ee425e46
JH
1248void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1249
94351118 1250char *alias_lookup(const char *alias);
0989fe96 1251int split_cmdline(char *cmdline, const char ***argv);
ad9ac6db
GB
1252/* Takes a negative value returned by split_cmdline */
1253const char *split_cmdline_strerror(int cmdline_errno);
94351118 1254
e37c1329
NTND
1255/* git.c */
1256struct startup_info {
a60645f9 1257 int have_repository;
f07d6a1a 1258 const char *prefix;
e37c1329
NTND
1259};
1260extern struct startup_info *startup_info;
1261
cac42b26
JH
1262/* builtin/merge.c */
1263int checkout_fast_forward(const unsigned char *from, const unsigned char *to);
1264
38f865c2
JK
1265int sane_execvp(const char *file, char *const argv[]);
1266
e83c5163 1267#endif /* CACHE_H */