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