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