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