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