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