Allow custom "comment char"
[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;
b60e188c 131 unsigned int ce_namelen;
e83c5163 132 unsigned char sha1[20];
eb7a2f1d 133 struct cache_entry *next;
2548183b 134 struct cache_entry *dir_next;
8f1d2e6f 135 char name[FLEX_ARRAY]; /* more */
e83c5163
LT
136};
137
95fd5bf8 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
b60e188c 201static inline unsigned create_ce_flags(unsigned stage)
7fec10b7 202{
b60e188c 203 return (stage << CE_STAGESHIFT);
7fec10b7
JH
204}
205
b60e188c 206#define ce_namelen(ce) ((ce)->ce_namelen)
aee46198 207#define ce_size(ce) cache_entry_size(ce_namelen(ce))
7a51ed66 208#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
eadb5831 209#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
44a36913 210#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
eadb5831 211#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
aee46198 212
e4479470 213#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
214static inline unsigned int create_ce_mode(unsigned int mode)
215{
8ae0a8c5 216 if (S_ISLNK(mode))
7a51ed66 217 return S_IFLNK;
302b9282 218 if (S_ISDIR(mode) || S_ISGITLINK(mode))
7a51ed66
LT
219 return S_IFGITLINK;
220 return S_IFREG | ce_permissions(mode);
8ae0a8c5 221}
185c975f
JH
222static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
223{
78a8d641
JS
224 extern int trust_executable_bit, has_symlinks;
225 if (!has_symlinks && S_ISREG(mode) &&
7a51ed66 226 ce && S_ISLNK(ce->ce_mode))
78a8d641 227 return ce->ce_mode;
185c975f 228 if (!trust_executable_bit && S_ISREG(mode)) {
7a51ed66 229 if (ce && S_ISREG(ce->ce_mode))
185c975f
JH
230 return ce->ce_mode;
231 return create_ce_mode(0666);
232 }
233 return create_ce_mode(mode);
234}
d6b8fc30
JH
235static inline int ce_to_dtype(const struct cache_entry *ce)
236{
237 unsigned ce_mode = ntohl(ce->ce_mode);
238 if (S_ISREG(ce_mode))
239 return DT_REG;
240 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
241 return DT_DIR;
242 else if (S_ISLNK(ce_mode))
243 return DT_LNK;
244 else
245 return DT_UNKNOWN;
246}
b90d9b88
RS
247static inline unsigned int canon_mode(unsigned int mode)
248{
249 if (S_ISREG(mode))
250 return S_IFREG | ce_permissions(mode);
251 if (S_ISLNK(mode))
252 return S_IFLNK;
253 if (S_ISDIR(mode))
254 return S_IFDIR;
255 return S_IFGITLINK;
256}
e4479470 257
ee7825b5 258#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
f5cabd13 259
228e94f9
JH
260struct index_state {
261 struct cache_entry **cache;
9d227781 262 unsigned int version;
228e94f9 263 unsigned int cache_nr, cache_alloc, cache_changed;
cfc5789a 264 struct string_list *resolve_undo;
228e94f9 265 struct cache_tree *cache_tree;
fba2f38a 266 struct cache_time timestamp;
913e0e99
JH
267 unsigned name_hash_initialized : 1,
268 initialized : 1;
cf558704 269 struct hash_table name_hash;
228e94f9
JH
270};
271
272extern struct index_state the_index;
273
96872bc2
LT
274/* Name hashing */
275extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
276/*
277 * We don't actually *remove* it, we can just mark it invalid so that
278 * we won't find it in lookups.
279 *
280 * Not only would we have to search the lists (simple enough), but
281 * we'd also have to rehash other hash buckets in case this makes the
282 * hash bucket empty (common). So it's much better to just mark
283 * it.
284 */
285static inline void remove_name_hash(struct cache_entry *ce)
286{
287 ce->ce_flags |= CE_UNHASHED;
288}
289
290
4aab5b46 291#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
228e94f9
JH
292#define active_cache (the_index.cache)
293#define active_nr (the_index.cache_nr)
294#define active_alloc (the_index.cache_alloc)
295#define active_cache_changed (the_index.cache_changed)
296#define active_cache_tree (the_index.cache_tree)
e83c5163 297
4aab5b46
JH
298#define read_cache() read_index(&the_index)
299#define read_cache_from(path) read_index_from(&the_index, (path))
671c9b7e 300#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
fa7b3c2f 301#define is_cache_unborn() is_index_unborn(&the_index)
e46bbcf6 302#define read_cache_unmerged() read_index_unmerged(&the_index)
4aab5b46
JH
303#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
304#define discard_cache() discard_index(&the_index)
94a5728c 305#define unmerged_cache() unmerged_index(&the_index)
4aab5b46
JH
306#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
307#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
81dc2307 308#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
4aab5b46
JH
309#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
310#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
38ed1d89
JH
311#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
312#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
3deffc52 313#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
4bd5b7da
JH
314#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
315#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
cd2fef59 316#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
98fa4738 317#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
cfc5789a 318#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
8aa38563 319#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
4421a823 320#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
4aab5b46 321#endif
e83c5163 322
edaec3fb
JH
323enum object_type {
324 OBJ_BAD = -1,
325 OBJ_NONE = 0,
326 OBJ_COMMIT = 1,
327 OBJ_TREE = 2,
328 OBJ_BLOB = 3,
329 OBJ_TAG = 4,
330 /* 5 for future expansion */
331 OBJ_OFS_DELTA = 6,
332 OBJ_REF_DELTA = 7,
355885d5 333 OBJ_ANY,
4b05548f 334 OBJ_MAX
edaec3fb
JH
335};
336
b45563a2
JH
337static inline enum object_type object_type(unsigned int mode)
338{
339 return S_ISDIR(mode) ? OBJ_TREE :
340 S_ISGITLINK(mode) ? OBJ_COMMIT :
341 OBJ_BLOB;
342}
343
8ac069ac 344#define GIT_DIR_ENVIRONMENT "GIT_DIR"
a1bea2c1 345#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
892c41b9 346#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
8ac069ac 347#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 348#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 349#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 350#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
d4ebc36c
JH
351#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
352#define CONFIG_ENVIRONMENT "GIT_CONFIG"
2b64fc89 353#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
d4ebc36c 354#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
0454dd93 355#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
6476b38b 356#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
d0bfd026
JH
357#define GITATTRIBUTES_FILE ".gitattributes"
358#define INFOATTRIBUTES_FILE "info/attributes"
f48fd688 359#define ATTRIBUTE_MACRO_PREFIX "[attr]"
a97a7468
JS
360#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
361#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
894a9d33 362#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
6956f858
TR
363#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
364#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
823ab40f 365#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
bb233d69 366
48a7c1c4
GB
367/*
368 * Repository-local GIT_* environment variables
369 * The array is NULL-terminated to simplify its usage in contexts such
370 * environment creation or simple walk of the list.
371 * The number of non-NULL entries is available as a macro.
372 */
655e8d9c 373#define LOCAL_REPO_ENV_SIZE 9
48a7c1c4
GB
374extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
375
7d1864ce
JH
376extern int is_bare_repository_cfg;
377extern int is_bare_repository(void);
68025633 378extern int is_inside_git_dir(void);
e90fdc39 379extern char *git_work_tree_cfg;
892c41b9 380extern int is_inside_work_tree(void);
d2b0708e 381extern int have_git_dir(void);
c5fba16c 382extern const char *get_git_dir(void);
b3256eb8 383extern int is_git_directory(const char *path);
8ac069ac
JH
384extern char *get_object_directory(void);
385extern char *get_index_file(void);
5da5c8f4 386extern char *get_graft_file(void);
d7ac12b2 387extern int set_git_dir(const char *path);
a1bea2c1
JT
388extern const char *get_git_namespace(void);
389extern const char *strip_namespace(const char *namespaced_ref);
e90fdc39 390extern const char *get_git_work_tree(void);
13d6ec91 391extern const char *read_gitfile(const char *path);
abc06822 392extern const char *resolve_gitdir(const char *suspect);
19757d80 393extern void set_git_work_tree(const char *tree);
8ac069ac
JH
394
395#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 396
6b5ee137 397extern const char **get_pathspec(const char *prefix, const char **pathspec);
59f0f2f3 398extern void setup_work_tree(void);
4ca06608 399extern const char *setup_git_directory_gently(int *);
d288a700 400extern const char *setup_git_directory(void);
edc54fb5 401extern char *prefix_path(const char *prefix, int len, const char *path);
4ca06608 402extern const char *prefix_filename(const char *prefix, int len, const char *path);
c6e8c800 403extern int check_filename(const char *prefix, const char *name);
023e37c3
MM
404extern void verify_filename(const char *prefix,
405 const char *name,
406 int diagnose_misspelt_rev);
ea92f41f 407extern void verify_non_filename(const char *prefix, const char *name);
546e0fd9 408extern int path_inside_repo(const char *prefix, const char *path);
d288a700 409
f225aeb2
DB
410#define INIT_DB_QUIET 0x0001
411
b57fb80a 412extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
f225aeb2
DB
413extern int init_db(const char *template_dir, unsigned int flags);
414
e83c5163
LT
415#define alloc_nr(x) (((x)+16)*3/2)
416
6815e569
JK
417/*
418 * Realloc the buffer pointed at by variable 'x' so that it can hold
419 * at least 'nr' entries; the number of entries currently allocated
420 * is 'alloc', using the standard growing factor alloc_nr() macro.
421 *
01f6fd4b 422 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
6815e569
JK
423 */
424#define ALLOC_GROW(x, nr, alloc) \
425 do { \
c927e6c6 426 if ((nr) > alloc) { \
4234a761
JH
427 if (alloc_nr(alloc) < (nr)) \
428 alloc = (nr); \
429 else \
430 alloc = alloc_nr(alloc); \
6815e569
JK
431 x = xrealloc((x), alloc * sizeof(*(x))); \
432 } \
98746061 433 } while (0)
6815e569 434
734aab75 435/* Initialize and use the cache information */
4aab5b46 436extern int read_index(struct index_state *);
671c9b7e 437extern int read_index_preload(struct index_state *, const char **pathspec);
4aab5b46 438extern int read_index_from(struct index_state *, const char *path);
fa7b3c2f 439extern int is_index_unborn(struct index_state *);
e46bbcf6 440extern int read_index_unmerged(struct index_state *);
e1afca4f 441extern int write_index(struct index_state *, int newfd);
4aab5b46 442extern int discard_index(struct index_state *);
d1f128b0 443extern int unmerged_index(const struct index_state *);
8dcf39c4 444extern int verify_path(const char *path);
cd2fef59 445extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
d1f128b0 446extern int index_name_pos(const struct index_state *, const char *name, int namelen);
192268c1
JH
447#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
448#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 449#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
af3785dc 450#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
39425819 451#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
4aab5b46 452extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
81dc2307 453extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
4aab5b46 454extern int remove_index_entry_at(struct index_state *, int pos);
36419c8e 455extern void remove_marked_cache_entries(struct index_state *istate);
4aab5b46 456extern int remove_file_from_index(struct index_state *, const char *path);
38ed1d89
JH
457#define ADD_CACHE_VERBOSE 1
458#define ADD_CACHE_PRETEND 2
01665924 459#define ADD_CACHE_IGNORE_ERRORS 4
041aee31 460#define ADD_CACHE_IGNORE_REMOVAL 8
39425819 461#define ADD_CACHE_INTENT 16
38ed1d89
JH
462extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
463extern int add_file_to_index(struct index_state *, const char *path, int flags);
6640f881 464extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
dbbce55b 465extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
98fa4738 466extern int index_name_is_other(const struct index_state *, const char *, int);
4bd5b7da
JH
467
468/* do stat comparison even if CE_VALID is true */
469#define CE_MATCH_IGNORE_VALID 01
470/* do not check the contents but report dirty on racily-clean entries */
56cac48c
NTND
471#define CE_MATCH_RACY_IS_DIRTY 02
472/* do stat comparison even if CE_SKIP_WORKTREE is true */
473#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
d1f128b0
LT
474extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
475extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
4bd5b7da 476
8c6abbcd
NTND
477#define PATHSPEC_ONESTAR 1 /* the pathspec pattern sastisfies GFNM_ONESTAR */
478
0602f3e9
NTND
479struct pathspec {
480 const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
481 int nr;
9ddf1726
JN
482 unsigned int has_wildcard:1;
483 unsigned int recursive:1;
bc96cc87 484 int max_depth;
0602f3e9
NTND
485 struct pathspec_item {
486 const char *match;
487 int len;
170260ae 488 int nowildcard_len;
8c6abbcd 489 int flags;
0602f3e9
NTND
490 } *items;
491};
492
493extern int init_pathspec(struct pathspec *, const char **);
494extern void free_pathspec(struct pathspec *);
eb9cb55b 495extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
c4ce46fc 496
823ab40f
JK
497extern int limit_pathspec_to_literal(void);
498
c4ce46fc
JH
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;
76759c7d 563extern int precomposed_unicode;
17712991 564
eff80a9f
JH
565/*
566 * The character that begins a commented line in user-editable file
567 * that is subject to stripspace.
568 */
569extern char comment_line_char;
570
9ed36cfa 571enum branch_track {
9188ed89 572 BRANCH_TRACK_UNSPECIFIED = -1,
9ed36cfa
JS
573 BRANCH_TRACK_NEVER = 0,
574 BRANCH_TRACK_REMOTE,
575 BRANCH_TRACK_ALWAYS,
576 BRANCH_TRACK_EXPLICIT,
4b05548f 577 BRANCH_TRACK_OVERRIDE
9ed36cfa
JS
578};
579
c998ae9b
DS
580enum rebase_setup_type {
581 AUTOREBASE_NEVER = 0,
582 AUTOREBASE_LOCAL,
583 AUTOREBASE_REMOTE,
4b05548f 584 AUTOREBASE_ALWAYS
c998ae9b
DS
585};
586
52153747 587enum push_default_type {
52153747
FAG
588 PUSH_DEFAULT_NOTHING = 0,
589 PUSH_DEFAULT_MATCHING,
b55e6775 590 PUSH_DEFAULT_SIMPLE,
53c40311 591 PUSH_DEFAULT_UPSTREAM,
f25950f3
CT
592 PUSH_DEFAULT_CURRENT,
593 PUSH_DEFAULT_UNSPECIFIED
52153747
FAG
594};
595
9ed36cfa 596extern enum branch_track git_branch_track;
c998ae9b 597extern enum rebase_setup_type autorebase;
52153747 598extern enum push_default_type push_default;
9ed36cfa 599
348df166
JS
600enum object_creation_mode {
601 OBJECT_CREATION_USES_HARDLINKS = 0,
4b05548f 602 OBJECT_CREATION_USES_RENAMES = 1
348df166
JS
603};
604
605extern enum object_creation_mode object_creation_mode;
be66a6c4 606
a97a7468
JS
607extern char *notes_ref_name;
608
7f3140cd
JS
609extern int grafts_replace_parents;
610
ab9cb76f
JH
611#define GIT_REPO_VERSION 0
612extern int repository_format_version;
613extern int check_repository_format(void);
614
734aab75
LT
615#define MTIME_CHANGED 0x0001
616#define CTIME_CHANGED 0x0002
617#define OWNER_CHANGED 0x0004
618#define MODE_CHANGED 0x0008
619#define INODE_CHANGED 0x0010
620#define DATA_CHANGED 0x0020
8ae0a8c5 621#define TYPE_CHANGED 0x0040
e83c5163 622
108bebea
AR
623extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
624 __attribute__((format (printf, 3, 4)));
fe2d7776
AR
625extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
626 __attribute__((format (printf, 3, 4)));
aba13e7c
AR
627extern char *git_pathdup(const char *fmt, ...)
628 __attribute__((format (printf, 1, 2)));
21cf3227
HKNN
629extern char *mkpathdup(const char *fmt, ...)
630 __attribute__((format (printf, 1, 2)));
108bebea 631
e83c5163 632/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0
TS
633extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
634extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
0bad611b
HV
635extern char *git_path_submodule(const char *path, const char *fmt, ...)
636 __attribute__((format (printf, 2, 3)));
637
73134b6d 638extern char *sha1_file_name(const unsigned char *sha1);
bf592c50
DB
639extern char *sha1_pack_name(const unsigned char *sha1);
640extern char *sha1_pack_index_name(const unsigned char *sha1);
013f276e 641extern const char *find_unique_abbrev(const unsigned char *sha1, int);
88cd621d 642extern const unsigned char null_sha1[20];
1a812f3a
IM
643
644static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
0bef57ee 645{
1a812f3a
IM
646 int i;
647
648 for (i = 0; i < 20; i++, sha1++, sha2++) {
649 if (*sha1 != *sha2)
650 return *sha1 - *sha2;
651 }
652
653 return 0;
0bef57ee 654}
1a812f3a
IM
655
656static inline int is_null_sha1(const unsigned char *sha1)
a89fccd2 657{
1a812f3a 658 return !hashcmp(sha1, null_sha1);
a89fccd2 659}
1a812f3a 660
e702496e
SP
661static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
662{
663 memcpy(sha_dst, sha_src, 20);
664}
a8e0d16d
JH
665static inline void hashclr(unsigned char *hash)
666{
667 memset(hash, 0, 20);
668}
e83c5163 669
14d9c578
JK
670#define EMPTY_TREE_SHA1_HEX \
671 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
dab0d410 672#define EMPTY_TREE_SHA1_BIN_LITERAL \
14d9c578
JK
673 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
674 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
dab0d410
JN
675#define EMPTY_TREE_SHA1_BIN \
676 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
14d9c578 677
f8582cad
JK
678#define EMPTY_BLOB_SHA1_HEX \
679 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
680#define EMPTY_BLOB_SHA1_BIN_LITERAL \
681 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
682 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
683#define EMPTY_BLOB_SHA1_BIN \
684 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
685
686static inline int is_empty_blob_sha1(const unsigned char *sha1)
687{
688 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
689}
690
f2db68ed
HE
691int git_mkstemp(char *path, size_t n, const char *template);
692
003b33a8
DA
693int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
694
b862b61c
MM
695/* set default permissions by passing mode arguments to open(2) */
696int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
697int git_mkstemp_mode(char *pattern, int mode);
698
06cbe855
HO
699/*
700 * NOTE NOTE NOTE!!
701 *
702 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
703 * not be changed. Old repositories have core.sharedrepository written in
704 * numeric format, and therefore these values are preserved for compatibility
705 * reasons.
706 */
94df2506 707enum sharedrepo {
06cbe855
HO
708 PERM_UMASK = 0,
709 OLD_PERM_GROUP = 1,
710 OLD_PERM_EVERYBODY = 2,
711 PERM_GROUP = 0660,
4b05548f 712 PERM_EVERYBODY = 0664
94df2506
JH
713};
714int git_config_perm(const char *var, const char *value);
17e61b82
JH
715int set_shared_perm(const char *path, int mode);
716#define adjust_shared_perm(path) set_shared_perm((path), 0)
b2cb9425 717int safe_create_leading_directories(char *path);
8e21d63b 718int safe_create_leading_directories_const(const char *path);
90a6464b 719int mkdir_in_gitdir(const char *path);
21cf3227 720extern void home_config_paths(char **global, char **xdg, char *file);
395de250 721extern char *expand_user_path(const char *path);
1c64b48e 722const char *enter_repo(const char *path, int strict);
e5392c51
JS
723static inline int is_absolute_path(const char *path)
724{
88135203 725 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
e5392c51 726}
90b4a71c 727int is_directory(const char *);
e2a57aac 728const char *real_path(const char *path);
e3e46cdb 729const char *real_path_if_valid(const char *path);
e2a57aac
CMN
730const char *absolute_path(const char *path);
731const char *relative_path(const char *abs, const char *base);
f3cad0ad 732int normalize_path_copy(char *dst, const char *src);
31171d9e 733int longest_ancestor_length(const char *path, struct string_list *prefixes);
4fcc86b0 734char *strip_path_suffix(const char *path, const char *suffix);
34b6cb8b 735int daemon_avoid_alias(const char *path);
4bb43de2 736int offset_1st_component(const char *path);
b2cb9425 737
e1111cef 738/* object replacement */
5bf29b95
JH
739#define READ_SHA1_FILE_REPLACE 1
740extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
f5552aee
CC
741static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
742{
5bf29b95
JH
743 return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
744}
e1111cef
JH
745extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
746static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
747{
748 if (!read_replace_refs)
749 return sha1;
750 return do_lookup_replace_object(sha1);
f5552aee 751}
e1111cef 752
e83c5163 753/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
21666f1a 754extern int sha1_object_info(const unsigned char *, unsigned long *);
ce9fbf16 755extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
c00e657d 756extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
21666f1a 757extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
bbac7311 758extern int force_object_loose(const unsigned char *sha1, time_t mtime);
f0270efd 759extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
eb4f4076 760extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
f0270efd 761extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
8237b185 762
0e8189e2
NP
763/* global flag to enable extra checks when accessing packed objects */
764extern int do_check_packed_object_crc;
765
5f44324d
JH
766/* for development: log offset of pack access */
767extern const char *log_pack_access;
768
5d6ccf5c 769extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 770
839837b9 771extern int move_temp_to_file(const char *tmpfile, const char *filename);
8237b185 772
cd673c1f 773extern int has_sha1_pack(const unsigned char *sha1);
8237b185 774extern int has_sha1_file(const unsigned char *sha1);
0f4dc14a 775extern int has_loose_object_nonlocal(const unsigned char *sha1);
8237b185 776
bf592c50
DB
777extern int has_pack_index(const unsigned char *sha1);
778
40d52ff7
JK
779extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
780
192a6be2
LT
781extern const signed char hexval_table[256];
782static inline unsigned int hexval(unsigned char c)
e49521b5
JH
783{
784 return hexval_table[c];
785}
786
e83c5163 787/* Convert to/from hex/sha1 representation */
dce96489
LT
788#define MINIMUM_ABBREV minimum_abbrev
789#define DEFAULT_ABBREV default_abbrev
46a6c262 790
573285e5
CP
791struct object_context {
792 unsigned char tree[20];
793 char path[PATH_MAX];
794 unsigned mode;
795};
796
daba53ae
JH
797#define GET_SHA1_QUIETLY 01
798#define GET_SHA1_COMMIT 02
799#define GET_SHA1_COMMITTISH 04
800#define GET_SHA1_TREE 010
801#define GET_SHA1_TREEISH 020
802#define GET_SHA1_BLOB 040
33bd598c 803#define GET_SHA1_ONLY_TO_DIE 04000
37c00e55 804
3c249c95 805extern int get_sha1(const char *str, unsigned char *sha1);
daba53ae 806extern int get_sha1_commit(const char *str, unsigned char *sha1);
cd74e473 807extern int get_sha1_committish(const char *str, unsigned char *sha1);
daba53ae
JH
808extern int get_sha1_tree(const char *str, unsigned char *sha1);
809extern int get_sha1_treeish(const char *str, unsigned char *sha1);
810extern int get_sha1_blob(const char *str, unsigned char *sha1);
8c135ea2 811extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
33bd598c 812extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
d4e85a1a 813
957d7406
JH
814typedef int each_abbrev_fn(const unsigned char *sha1, void *);
815extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
d4e85a1a
MH
816
817/*
818 * Try to read a SHA1 in hexadecimal format from the 40 characters
819 * starting at hex. Write the 20-byte result to sha1 in binary form.
820 * Return 0 on success. Reading stops if a NUL is encountered in the
821 * input, so it is safe to pass this function an arbitrary
822 * null-terminated string.
823 */
197ee8c9 824extern int get_sha1_hex(const char *hex, unsigned char *sha1);
d4e85a1a 825
197ee8c9 826extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
dfefa935 827extern int read_ref_full(const char *refname, unsigned char *sha1,
c6893323 828 int reading, int *flags);
dfefa935 829extern int read_ref(const char *refname, unsigned char *sha1);
7cb36842
MH
830
831/*
832 * Resolve a reference, recursively following symbolic refererences.
833 *
834 * Store the referred-to object's name in sha1 and return the name of
835 * the non-symbolic reference that ultimately pointed at it. The
836 * return value, if not NULL, is a pointer into either a static buffer
837 * or the input ref.
838 *
839 * If the reference cannot be resolved to an object, the behavior
840 * depends on the "reading" argument:
841 *
842 * - If reading is set, return NULL.
843 *
844 * - If reading is not set, clear sha1 and return the name of the last
845 * reference name in the chain, which will either be a non-symbolic
846 * reference or an undefined reference. If this is a prelude to
847 * "writing" to the ref, the return value is the name of the ref
848 * that will actually be created or changed.
849 *
850 * If flag is non-NULL, set the value that it points to the
851 * combination of REF_ISPACKED (if the reference was found among the
852 * packed references) and REF_ISSYMREF (if the initial reference was a
853 * symbolic reference).
854 *
855 * If ref is not a properly-formatted, normalized reference, return
856 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
857 * give up and return NULL.
858 *
859 * errno is sometimes set on errors, but not always.
860 */
8cad4744 861extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
96ec7b1e 862extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
7cb36842 863
e86eb666 864extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
eb3a4822 865extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
431b1969 866extern int interpret_branch_name(const char *str, struct strbuf *);
619a644d 867extern int get_sha1_mb(const char *str, unsigned char *sha1);
e86eb666 868
79803322
SP
869extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
870extern const char *ref_rev_parse_rules[];
dd621df9 871#define ref_fetch_rules ref_rev_parse_rules
79803322 872
8b5157e4 873extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
c847f537 874extern int validate_headref(const char *ref);
e83c5163 875
958ba6c9 876extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
0ab9e1e8 877extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 878extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
b60e188c 879extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
e83c5163 880
40469ee9 881extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 882 const char *required_type,
40469ee9
JH
883 unsigned long *size,
884 unsigned char *sha1_ret);
f4913f91 885
81776315
JH
886extern struct object *peel_to_type(const char *name, int namelen,
887 struct object *o, enum object_type);
888
73013afd
JH
889enum date_mode {
890 DATE_NORMAL = 0,
891 DATE_RELATIVE,
892 DATE_SHORT,
893 DATE_LOCAL,
894 DATE_ISO8601,
7dff9b30
LT
895 DATE_RFC2822,
896 DATE_RAW
73013afd
JH
897};
898
f8493ec0 899const char *show_date(unsigned long time, int timezone, enum date_mode mode);
7d29afd4
JN
900void show_date_relative(unsigned long time, int tz, const struct timeval *now,
901 struct strbuf *timebuf);
2a39064c 902int parse_date(const char *date, char *buf, int bufsize);
9644c061 903int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
ecee9d9e 904void datestamp(char *buf, int bufsize);
93cfa7c7
JH
905#define approxidate(s) approxidate_careful((s), NULL)
906unsigned long approxidate_careful(const char *, int *);
33012fc4 907unsigned long approxidate_relative(const char *date, const struct timeval *now);
856665f8 908enum date_mode parse_date_format(const char *format);
ecee9d9e 909
f9bc573f 910#define IDENT_STRICT 1
b9f0ac17 911#define IDENT_NO_DATE 2
c15e1987 912#define IDENT_NO_NAME 4
749be728
JH
913extern const char *git_author_info(int);
914extern const char *git_committer_info(int);
798123af 915extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
d9ccfe77 916extern const char *fmt_name(const char *name, const char *email);
bcb2b004 917extern const char *ident_default_email(void);
44fcb497 918extern const char *git_editor(void);
64778d24 919extern const char *git_pager(int stdout_is_tty);
9597921b 920extern int git_ident_config(const char *, const char *, void *);
6aa33f40 921
4b340cfa
JH
922struct ident_split {
923 const char *name_begin;
924 const char *name_end;
925 const char *mail_begin;
926 const char *mail_end;
927 const char *date_begin;
928 const char *date_end;
929 const char *tz_begin;
930 const char *tz_end;
931};
932/*
933 * Signals an success with 0, but time part of the result may be NULL
934 * if the input lacks timestamp and zone
935 */
936extern int split_ident_line(struct ident_split *, const char *, int);
937
12dccc16
LT
938struct checkout {
939 const char *base_dir;
940 int base_dir_len;
941 unsigned force:1,
942 quiet:1,
943 not_new:1,
944 refresh_cache:1;
945};
946
efbc5831 947extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
b9fd2846
LT
948
949struct cache_def {
950 char path[PATH_MAX + 1];
951 int len;
952 int flags;
953 int track_flags;
954 int prefix_len_stat_func;
955};
956
57199892 957extern int has_symlink_leading_path(const char *name, int len);
b9fd2846 958extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
f66caaf9 959extern int check_leading_path(const char *name, int len);
57199892 960extern int has_dirs_only_path(const char *name, int len, int prefix_len);
78478927
KB
961extern void schedule_dir_for_removal(const char *name, int len);
962extern void remove_scheduled_dirs(void);
12dccc16 963
9a217f2a 964extern struct alternate_object_database {
d5a63b99 965 struct alternate_object_database *next;
9a217f2a 966 char *name;
8f1d2e6f 967 char base[FLEX_ARRAY]; /* more */
d5a63b99 968} *alt_odb_list;
9a217f2a 969extern void prepare_alt_odb(void);
5e73633d 970extern void read_info_alternates(const char * relative_base, int depth);
bef70b22 971extern void add_to_alternates_file(const char *reference);
d79796bc
JH
972typedef int alt_odb_fn(struct alternate_object_database *, void *);
973extern void foreach_alt_odb(alt_odb_fn, void*);
9a217f2a 974
c41ee586
SP
975struct pack_window {
976 struct pack_window *next;
977 unsigned char *base;
978 off_t offset;
979 size_t len;
980 unsigned int last_used;
981 unsigned int inuse_cnt;
982};
983
9a217f2a
JH
984extern struct packed_git {
985 struct packed_git *next;
c41ee586 986 struct pack_window *windows;
2dc3a234 987 off_t pack_size;
57059091
NP
988 const void *index_data;
989 size_t index_size;
990 uint32_t num_objects;
8eca0b47
NP
991 uint32_t num_bad_objects;
992 unsigned char *bad_object_sha1;
42873078 993 int index_version;
57059091 994 time_t mtime;
9bc879c1 995 int pack_fd;
8d25931d 996 unsigned pack_local:1,
d131b7af
SP
997 pack_keep:1,
998 do_not_close:1;
bf592c50 999 unsigned char sha1[20];
8f1d2e6f
JH
1000 /* something like ".git/objects/pack/xxxxx.pack" */
1001 char pack_name[FLEX_ARRAY]; /* more */
9a217f2a 1002} *packed_git;
f3bf9224
JH
1003
1004struct pack_entry {
c4001d92 1005 off_t offset;
f3bf9224
JH
1006 unsigned char sha1[20];
1007 struct packed_git *p;
1008};
1009
d1c133f5
LT
1010struct ref {
1011 struct ref *next;
1012 unsigned char old_sha1[20];
1013 unsigned char new_sha1[20];
be885d96 1014 char *symref;
8c5f6f71
CR
1015 unsigned int
1016 force:1,
1017 requires_force:1,
9f8a15c7
SP
1018 merge:1,
1019 nonfastforward:1,
b24e6047 1020 not_forwardable:1,
ffe81ef2 1021 update:1,
9f8a15c7 1022 deletion:1;
8736a848
JK
1023 enum {
1024 REF_STATUS_NONE = 0,
1025 REF_STATUS_OK,
1026 REF_STATUS_REJECT_NONFASTFORWARD,
dbfeddb1 1027 REF_STATUS_REJECT_ALREADY_EXISTS,
8736a848
JK
1028 REF_STATUS_REJECT_NODELETE,
1029 REF_STATUS_UPTODATE,
ca74c458 1030 REF_STATUS_REMOTE_REJECT,
4b05548f 1031 REF_STATUS_EXPECTING_REPORT
8736a848 1032 } status;
2a0fe89a 1033 char *remote_status;
f88395ac 1034 struct ref *peer_ref; /* when renaming */
8f1d2e6f 1035 char name[FLEX_ARRAY]; /* more */
d1c133f5
LT
1036};
1037
2718ff09
LT
1038#define REF_NORMAL (1u << 0)
1039#define REF_HEADS (1u << 1)
1040#define REF_TAGS (1u << 2)
1041
5483f799 1042extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
cda69f48 1043
7841ce79 1044#define CONNECT_VERBOSE (1u << 0)
4577370e 1045extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
98158e9c 1046extern int finish_connect(struct child_process *conn);
7ffe853b 1047extern int git_connection_is_socket(struct child_process *conn);
40c155ff
JH
1048struct extra_have_objects {
1049 int nr, alloc;
1050 unsigned char (*array)[20];
1051};
afe7c5ff 1052extern struct ref **get_remote_heads(int in, struct ref **list, unsigned int flags, struct extra_have_objects *);
211b5f9e 1053extern int server_supports(const char *feature);
94427108
JK
1054extern int parse_feature_request(const char *features, const char *feature);
1055extern const char *server_feature_value(const char *feature, int *len_ret);
1056extern const char *parse_feature_value(const char *feature_list, const char *feature, int *len_ret);
f7192598 1057
7b64469a 1058extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
bf592c50 1059
9a217f2a 1060extern void prepare_packed_git(void);
fc04c412 1061extern void reprepare_packed_git(void);
bf592c50
DB
1062extern void install_packed_git(struct packed_git *pack);
1063
a6080a0a 1064extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
bf592c50
DB
1065 struct packed_git *packs);
1066
276bc2ca 1067extern void pack_report(void);
d079837e 1068extern int open_pack_index(struct packed_git *);
fa5fc15d 1069extern void close_pack_index(struct packed_git *);
ef49a7a0 1070extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
c9ced051 1071extern void close_pack_windows(struct packed_git *);
03e79c88 1072extern void unuse_pack(struct pack_window **);
c74faea1 1073extern void free_pack_by_name(const char *);
3d20c636 1074extern void clear_delta_base_cache(void);
42873078 1075extern struct packed_git *add_packed_git(const char *, int, int);
d079837e 1076extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
99093238 1077extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
c4001d92 1078extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
4c080182 1079extern int is_pack_valid(struct packed_git *);
c4001d92 1080extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
09ded04b 1081extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
54dab52a 1082extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
f8c8abc5 1083extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
9a217f2a 1084
9a490590
JH
1085struct object_info {
1086 /* Request */
1087 unsigned long *sizep;
1088
1089 /* Response */
1090 enum {
1091 OI_CACHED,
1092 OI_LOOSE,
5266d369
JH
1093 OI_PACKED,
1094 OI_DBCACHED
9a490590
JH
1095 } whence;
1096 union {
1097 /*
1098 * struct {
1099 * ... Nothing to expose in this case
1100 * } cached;
1101 * struct {
1102 * ... Nothing to expose in this case
1103 * } loose;
1104 */
1105 struct {
1106 struct packed_git *pack;
1107 off_t offset;
1108 unsigned int is_delta;
1109 } packed;
1110 } u;
1111};
1112extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
9a217f2a 1113
8f3f9b09
JH
1114/* Dumb servers support */
1115extern int update_server_info(int);
1116
7a397419
MG
1117/* git_config_parse_key() returns these negated: */
1118#define CONFIG_INVALID_KEY 1
1119#define CONFIG_NO_SECTION_OR_NAME 2
1120/* git_config_set(), git_config_set_multivar() return the above or these: */
1121#define CONFIG_NO_LOCK -1
1122#define CONFIG_INVALID_FILE 3
1123#define CONFIG_NO_WRITE 4
1124#define CONFIG_NOTHING_SET 5
1125#define CONFIG_INVALID_PATTERN 6
9409c7a5 1126#define CONFIG_GENERIC_ERROR 7
7a397419 1127
ef90d6d4
JS
1128typedef int (*config_fn_t)(const char *, const char *, void *);
1129extern int git_default_config(const char *, const char *, void *);
1130extern int git_config_from_file(config_fn_t fn, const char *, void *);
2b64fc89 1131extern void git_config_push_parameter(const char *text);
b3d83d9f 1132extern int git_config_from_parameters(config_fn_t fn, void *data);
ef90d6d4 1133extern int git_config(config_fn_t fn, void *);
9b25a0b5
JK
1134extern int git_config_with_options(config_fn_t fn, void *,
1135 const char *filename, int respect_includes);
dbdf5854 1136extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
0b87b6e0 1137extern int git_parse_ulong(const char *, unsigned long *);
17712991 1138extern int git_config_int(const char *, const char *);
0b87b6e0 1139extern unsigned long git_config_ulong(const char *, const char *);
a53f2ec6 1140extern int git_config_bool_or_int(const char *, const char *, int *);
17712991 1141extern int git_config_bool(const char *, const char *);
8420ccd8 1142extern int git_config_maybe_bool(const char *, const char *);
ea5105a5 1143extern int git_config_string(const char **, const char *, const char *);
395de250 1144extern int git_config_pathname(const char **, const char *, const char *);
5ec31182 1145extern int git_config_set_in_file(const char *, const char *, const char *);
10bea152 1146extern int git_config_set(const char *, const char *);
b09c53a3 1147extern int git_config_parse_key(const char *, char **, int *);
4ddba79d 1148extern int git_config_set_multivar(const char *, const char *, const char *, int);
5ec31182 1149extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
0667fcfb 1150extern int git_config_rename_section(const char *, const char *);
42bd39b5 1151extern int git_config_rename_section_in_file(const char *, const char *, const char *);
506b17b1 1152extern const char *git_etc_gitconfig(void);
ef90d6d4 1153extern int check_repository_format_version(const char *var, const char *value, void *cb);
0ef37164 1154extern int git_env_bool(const char *, int);
ab88c363 1155extern int git_config_system(void);
40ea4ed9 1156extern int config_error_nonbool(const char *);
a469a101
JK
1157#ifdef __GNUC__
1158#define config_error_nonbool(s) (config_error_nonbool(s), -1)
1159#endif
a6fa5992
PN
1160extern const char *get_log_output_encoding(void);
1161extern const char *get_commit_output_encoding(void);
1162
2496844b
JK
1163extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1164
9b25a0b5
JK
1165struct config_include_data {
1166 int depth;
1167 config_fn_t fn;
1168 void *data;
1169};
1170#define CONFIG_INCLUDE_INIT { 0 }
1171extern int git_config_include(const char *name, const char *value, void *data);
17712991 1172
d6991cee
JK
1173extern int committer_ident_sufficiently_given(void);
1174extern int author_ident_sufficiently_given(void);
e1b10391 1175
1a8f2741 1176extern const char *git_commit_encoding;
3a55602e 1177extern const char *git_log_output_encoding;
d551a488 1178extern const char *git_mailmap_file;
08610900 1179extern const char *git_mailmap_blob;
4e72dcec 1180
06f59e9f
TT
1181/* IO helper functions */
1182extern void maybe_flush_or_die(FILE *, const char *);
f3123c4a 1183extern int copy_fd(int ifd, int ofd);
1468bd47 1184extern int copy_file(const char *dst, const char *src, int mode);
f7835a25 1185extern int copy_file_with_time(const char *dst, const char *src, int mode);
7230e6d0 1186extern void write_or_die(int fd, const void *buf, size_t count);
6ce4e61f 1187extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
e0814056 1188extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
4c81b03e 1189extern void fsync_or_die(int fd, const char *);
ad897215 1190
2b7ca830
JM
1191extern ssize_t read_in_full(int fd, void *buf, size_t count);
1192extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1193static inline ssize_t write_str_in_full(int fd, const char *str)
1194{
1195 return write_in_full(fd, str, strlen(str));
1196}
1197
f67b45f8
LT
1198/* pager.c */
1199extern void setup_pager(void);
872da32d 1200extern const char *pager_program;
6e9af863 1201extern int pager_in_use(void);
aa086eb8 1202extern int pager_use_color;
ad6c3739 1203extern int term_columns(void);
ec7ff5ba 1204extern int decimal_width(int);
4914c962 1205extern int check_pager_config(const char *cmd);
f67b45f8 1206
ee9601e6 1207extern const char *editor_program;
d3e7da89 1208extern const char *askpass_program;
dfb068be 1209extern const char *excludes_file;
4d87b9c5 1210
051308f6 1211/* base85 */
f9815772
JM
1212int decode_85(char *dst, const char *line, int linelen);
1213void encode_85(char *buf, const unsigned char *data, int bytes);
051308f6 1214
855419f7 1215/* alloc.c */
100c5f3b
LT
1216extern void *alloc_blob_node(void);
1217extern void *alloc_tree_node(void);
1218extern void *alloc_commit_node(void);
1219extern void *alloc_tag_node(void);
1220extern void *alloc_object_node(void);
855419f7
LT
1221extern void alloc_report(void);
1222
6ce4e61f 1223/* trace.c */
28bea9e5 1224__attribute__((format (printf, 1, 2)))
6ce4e61f 1225extern void trace_printf(const char *format, ...);
28bea9e5 1226__attribute__((format (printf, 2, 3)))
b319ce4c 1227extern void trace_argv_printf(const char **argv, const char *format, ...);
a9ca8a85 1228extern void trace_repo_setup(const char *prefix);
39bc5e46 1229extern int trace_want(const char *key);
94b3b374 1230extern void trace_strbuf(const char *key, const struct strbuf *buf);
6ce4e61f 1231
bbc30f99 1232void packet_trace_identity(const char *prog);
6ce4e61f 1233
b6ec1d61 1234/* add */
7ae02a30
AR
1235/*
1236 * return 0 if success, 1 - if addition of a file failed and
1237 * ADD_FILES_IGNORE_ERRORS was specified in flags
1238 */
1239int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
b6ec1d61 1240
aecbf914
JH
1241/* diff.c */
1242extern int diff_auto_refresh_index;
1243
68faf689
JH
1244/* match-trees.c */
1245void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
85e51b78 1246void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
68faf689 1247
a9cc857a
JH
1248/*
1249 * whitespace rules.
1250 * used by both diff and apply
f4b05a49 1251 * last two digits are tab width
a9cc857a 1252 */
f4b05a49
JS
1253#define WS_BLANK_AT_EOL 0100
1254#define WS_SPACE_BEFORE_TAB 0200
1255#define WS_INDENT_WITH_NON_TAB 0400
1256#define WS_CR_AT_EOL 01000
1257#define WS_BLANK_AT_EOF 02000
1258#define WS_TAB_IN_INDENT 04000
aeb84b05 1259#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
f4b05a49
JS
1260#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1261#define WS_TAB_WIDTH_MASK 077
cf1b7869
JH
1262extern unsigned whitespace_rule_cfg;
1263extern unsigned whitespace_rule(const char *);
1264extern unsigned parse_whitespace_rule(const char *);
8f8841e9
JH
1265extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1266extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
c1795bb0 1267extern char *whitespace_error_string(unsigned ws);
d511bd33 1268extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
877f23cc 1269extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
f4b05a49 1270#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
a9cc857a 1271
ee425e46 1272/* ls-files */
0f64bfa9 1273int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
ee425e46
JH
1274void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1275
94351118 1276char *alias_lookup(const char *alias);
0989fe96 1277int split_cmdline(char *cmdline, const char ***argv);
ad9ac6db
GB
1278/* Takes a negative value returned by split_cmdline */
1279const char *split_cmdline_strerror(int cmdline_errno);
94351118 1280
e37c1329
NTND
1281/* git.c */
1282struct startup_info {
a60645f9 1283 int have_repository;
f07d6a1a 1284 const char *prefix;
e37c1329
NTND
1285};
1286extern struct startup_info *startup_info;
1287
db699a8a
NTND
1288/* merge.c */
1289struct commit_list;
1290int try_merge_command(const char *strategy, size_t xopts_nr,
1291 const char **xopts, struct commit_list *common,
1292 const char *head_arg, struct commit_list *remotes);
1293int checkout_fast_forward(const unsigned char *from,
1294 const unsigned char *to,
1295 int overwrite_ignore);
1296
cac42b26 1297
38f865c2
JK
1298int sane_execvp(const char *file, char *const argv[]);
1299
e83c5163 1300#endif /* CACHE_H */