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