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