lstat_cache(): introduce has_symlink_or_noent_leading_path() function
[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"
e83c5163 7
cef661fc 8#include SHA1_HEADER
9126f009
NP
9#ifndef git_SHA_CTX
10#define git_SHA_CTX SHA_CTX
11#define git_SHA1_Init SHA1_Init
12#define git_SHA1_Update SHA1_Update
13#define git_SHA1_Final SHA1_Final
14#endif
e83c5163 15
9126f009 16#include <zlib.h>
609a2289 17#if defined(NO_DEFLATE_BOUND) || ZLIB_VERNUM < 0x1200
9da3acfb
ET
18#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
19#endif
20
962554c6 21#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
b6829693
ET
22#define DTYPE(de) ((de)->d_type)
23#else
0bdd79af
JH
24#undef DT_UNKNOWN
25#undef DT_DIR
26#undef DT_REG
27#undef DT_LNK
b6829693
ET
28#define DT_UNKNOWN 0
29#define DT_DIR 1
30#define DT_REG 2
a15c1c60 31#define DT_LNK 3
b6829693
ET
32#define DTYPE(de) DT_UNKNOWN
33#endif
34
40689ae1
MK
35/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
36#define S_IFINVALID 0030000
37
9eec4795
LT
38/*
39 * A "directory link" is a link to another git directory.
40 *
41 * The value 0160000 is not normally a valid mode, and
42 * also just happens to be S_IFDIR + S_IFLNK
43 *
44 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
45 * always having the same values everywhere. We should use
46 * our internal git values for these things, and then we can
47 * translate that to the OS-specific value. It just so
48 * happens that everybody shares the same bit representation
49 * in the UNIX world (and apparently wider too..)
50 */
302b9282
MW
51#define S_IFGITLINK 0160000
52#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
9eec4795 53
2386d658
LT
54/*
55 * Intensive research over the course of many years has shown that
56 * port 9418 is totally unused by anything else. Or
57 *
58 * Your search - "port 9418" - did not match any documents.
59 *
60 * as www.google.com puts it.
ba8a4970
LT
61 *
62 * This port has been properly assigned for git use by IANA:
63 * git (Assigned-9418) [I06-050728-0001].
64 *
65 * git 9418/tcp git pack transfer service
66 * git 9418/udp git pack transfer service
67 *
68 * with Linus Torvalds <torvalds@osdl.org> as the point of
69 * contact. September 2005.
70 *
71 * See http://www.iana.org/assignments/port-numbers
2386d658
LT
72 */
73#define DEFAULT_GIT_PORT 9418
74
e83c5163
LT
75/*
76 * Basic data structures for the directory cache
e83c5163
LT
77 */
78
79#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
80struct cache_header {
ccc4feb5
LT
81 unsigned int hdr_signature;
82 unsigned int hdr_version;
83 unsigned int hdr_entries;
e83c5163
LT
84};
85
86/*
87 * The "cache_time" is just the low 32 bits of the
88 * time. It doesn't matter if it overflows - we only
89 * check it for equality in the 32 bits we save.
90 */
91struct cache_time {
92 unsigned int sec;
93 unsigned int nsec;
94};
95
96/*
97 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
98 * Again - this is just a (very strong in practice) heuristic that
99 * the inode hasn't changed.
ccc4feb5
LT
100 *
101 * We save the fields in big-endian order to allow using the
102 * index file over NFS transparently.
e83c5163 103 */
7a51ed66
LT
104struct ondisk_cache_entry {
105 struct cache_time ctime;
106 struct cache_time mtime;
107 unsigned int dev;
108 unsigned int ino;
109 unsigned int mode;
110 unsigned int uid;
111 unsigned int gid;
112 unsigned int size;
113 unsigned char sha1[20];
114 unsigned short flags;
115 char name[FLEX_ARRAY]; /* more */
116};
117
06aaaa0b
NTND
118/*
119 * This struct is used when CE_EXTENDED bit is 1
120 * The struct must match ondisk_cache_entry exactly from
121 * ctime till flags
122 */
123struct ondisk_cache_entry_extended {
124 struct cache_time ctime;
125 struct cache_time mtime;
126 unsigned int dev;
127 unsigned int ino;
128 unsigned int mode;
129 unsigned int uid;
130 unsigned int gid;
131 unsigned int size;
132 unsigned char sha1[20];
133 unsigned short flags;
134 unsigned short flags2;
135 char name[FLEX_ARRAY]; /* more */
136};
137
e83c5163 138struct cache_entry {
7a51ed66
LT
139 unsigned int ce_ctime;
140 unsigned int ce_mtime;
ccc4feb5
LT
141 unsigned int ce_dev;
142 unsigned int ce_ino;
143 unsigned int ce_mode;
144 unsigned int ce_uid;
145 unsigned int ce_gid;
146 unsigned int ce_size;
7a51ed66 147 unsigned int ce_flags;
e83c5163 148 unsigned char sha1[20];
eb7a2f1d 149 struct cache_entry *next;
8f1d2e6f 150 char name[FLEX_ARRAY]; /* more */
e83c5163
LT
151};
152
95fd5bf8
LT
153#define CE_NAMEMASK (0x0fff)
154#define CE_STAGEMASK (0x3000)
16ce2e4c 155#define CE_EXTENDED (0x4000)
5f73076c 156#define CE_VALID (0x8000)
aee46198 157#define CE_STAGESHIFT 12
95fd5bf8 158
06aaaa0b
NTND
159/*
160 * Range 0xFFFF0000 in ce_flags is divided into
161 * two parts: in-memory flags and on-disk ones.
162 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
163 * if you want to save a new flag, add it in
164 * CE_EXTENDED_FLAGS
165 *
166 * In-memory only flags
167 */
7a51ed66
LT
168#define CE_UPDATE (0x10000)
169#define CE_REMOVE (0x20000)
eadb5831 170#define CE_UPTODATE (0x40000)
1102952b 171#define CE_ADDED (0x80000)
a22c6371
LT
172
173#define CE_HASHED (0x100000)
174#define CE_UNHASHED (0x200000)
7a51ed66 175
06aaaa0b
NTND
176/*
177 * Extended on-disk flags
178 */
388b2acd 179#define CE_INTENT_TO_ADD 0x20000000
06aaaa0b
NTND
180/* CE_EXTENDED2 is for future extension */
181#define CE_EXTENDED2 0x80000000
182
388b2acd 183#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD)
06aaaa0b
NTND
184
185/*
186 * Safeguard to avoid saving wrong flags:
187 * - CE_EXTENDED2 won't get saved until its semantic is known
188 * - Bits in 0x0000FFFF have been saved in ce_flags already
189 * - Bits in 0x003F0000 are currently in-memory flags
190 */
191#if CE_EXTENDED_FLAGS & 0x803FFFFF
192#error "CE_EXTENDED_FLAGS out of range"
193#endif
194
eb7a2f1d
LT
195/*
196 * Copy the sha1 and stat state of a cache entry from one to
197 * another. But we never change the name, or the hash state!
198 */
199#define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
200static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
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
7fec10b7
JH
211static inline unsigned create_ce_flags(size_t len, unsigned stage)
212{
213 if (len >= CE_NAMEMASK)
214 len = CE_NAMEMASK;
215 return (len | (stage << CE_STAGESHIFT));
216}
217
218static inline size_t ce_namelen(const struct cache_entry *ce)
219{
220 size_t len = ce->ce_flags & CE_NAMEMASK;
221 if (len < CE_NAMEMASK)
222 return len;
223 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
224}
225
aee46198 226#define ce_size(ce) cache_entry_size(ce_namelen(ce))
06aaaa0b
NTND
227#define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
228 ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
229 ondisk_cache_entry_size(ce_namelen(ce)))
7a51ed66 230#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
eadb5831
JH
231#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
232#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
aee46198 233
e4479470 234#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
235static inline unsigned int create_ce_mode(unsigned int mode)
236{
8ae0a8c5 237 if (S_ISLNK(mode))
7a51ed66 238 return S_IFLNK;
302b9282 239 if (S_ISDIR(mode) || S_ISGITLINK(mode))
7a51ed66
LT
240 return S_IFGITLINK;
241 return S_IFREG | ce_permissions(mode);
8ae0a8c5 242}
185c975f
JH
243static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
244{
78a8d641
JS
245 extern int trust_executable_bit, has_symlinks;
246 if (!has_symlinks && S_ISREG(mode) &&
7a51ed66 247 ce && S_ISLNK(ce->ce_mode))
78a8d641 248 return ce->ce_mode;
185c975f 249 if (!trust_executable_bit && S_ISREG(mode)) {
7a51ed66 250 if (ce && S_ISREG(ce->ce_mode))
185c975f
JH
251 return ce->ce_mode;
252 return create_ce_mode(0666);
253 }
254 return create_ce_mode(mode);
255}
d6b8fc30
JH
256static inline int ce_to_dtype(const struct cache_entry *ce)
257{
258 unsigned ce_mode = ntohl(ce->ce_mode);
259 if (S_ISREG(ce_mode))
260 return DT_REG;
261 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
262 return DT_DIR;
263 else if (S_ISLNK(ce_mode))
264 return DT_LNK;
265 else
266 return DT_UNKNOWN;
267}
1b0c7174
JH
268#define canon_mode(mode) \
269 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
302b9282 270 S_ISLNK(mode) ? S_IFLNK : S_ISDIR(mode) ? S_IFDIR : S_IFGITLINK)
e4479470 271
06aaaa0b
NTND
272#define flexible_size(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
273#define cache_entry_size(len) flexible_size(cache_entry,len)
274#define ondisk_cache_entry_size(len) flexible_size(ondisk_cache_entry,len)
275#define ondisk_cache_entry_extended_size(len) flexible_size(ondisk_cache_entry_extended,len)
f5cabd13 276
228e94f9
JH
277struct index_state {
278 struct cache_entry **cache;
279 unsigned int cache_nr, cache_alloc, cache_changed;
280 struct cache_tree *cache_tree;
281 time_t timestamp;
7a51ed66 282 void *alloc;
913e0e99
JH
283 unsigned name_hash_initialized : 1,
284 initialized : 1;
cf558704 285 struct hash_table name_hash;
228e94f9
JH
286};
287
288extern struct index_state the_index;
289
96872bc2
LT
290/* Name hashing */
291extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
292/*
293 * We don't actually *remove* it, we can just mark it invalid so that
294 * we won't find it in lookups.
295 *
296 * Not only would we have to search the lists (simple enough), but
297 * we'd also have to rehash other hash buckets in case this makes the
298 * hash bucket empty (common). So it's much better to just mark
299 * it.
300 */
301static inline void remove_name_hash(struct cache_entry *ce)
302{
303 ce->ce_flags |= CE_UNHASHED;
304}
305
306
4aab5b46 307#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
228e94f9
JH
308#define active_cache (the_index.cache)
309#define active_nr (the_index.cache_nr)
310#define active_alloc (the_index.cache_alloc)
311#define active_cache_changed (the_index.cache_changed)
312#define active_cache_tree (the_index.cache_tree)
e83c5163 313
4aab5b46
JH
314#define read_cache() read_index(&the_index)
315#define read_cache_from(path) read_index_from(&the_index, (path))
671c9b7e 316#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
fa7b3c2f 317#define is_cache_unborn() is_index_unborn(&the_index)
e46bbcf6 318#define read_cache_unmerged() read_index_unmerged(&the_index)
4aab5b46
JH
319#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
320#define discard_cache() discard_index(&the_index)
94a5728c 321#define unmerged_cache() unmerged_index(&the_index)
4aab5b46
JH
322#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
323#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
81dc2307 324#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
4aab5b46
JH
325#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
326#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
38ed1d89
JH
327#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
328#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
d616813d 329#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL)
4bd5b7da
JH
330#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
331#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
cd2fef59 332#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
98fa4738 333#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
4aab5b46 334#endif
e83c5163 335
edaec3fb
JH
336enum object_type {
337 OBJ_BAD = -1,
338 OBJ_NONE = 0,
339 OBJ_COMMIT = 1,
340 OBJ_TREE = 2,
341 OBJ_BLOB = 3,
342 OBJ_TAG = 4,
343 /* 5 for future expansion */
344 OBJ_OFS_DELTA = 6,
345 OBJ_REF_DELTA = 7,
355885d5 346 OBJ_ANY,
edaec3fb
JH
347 OBJ_MAX,
348};
349
b45563a2
JH
350static inline enum object_type object_type(unsigned int mode)
351{
352 return S_ISDIR(mode) ? OBJ_TREE :
353 S_ISGITLINK(mode) ? OBJ_COMMIT :
354 OBJ_BLOB;
355}
356
8ac069ac 357#define GIT_DIR_ENVIRONMENT "GIT_DIR"
892c41b9 358#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
8ac069ac 359#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 360#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 361#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 362#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
d4ebc36c
JH
363#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
364#define CONFIG_ENVIRONMENT "GIT_CONFIG"
d4ebc36c 365#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
0454dd93 366#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
d0bfd026
JH
367#define GITATTRIBUTES_FILE ".gitattributes"
368#define INFOATTRIBUTES_FILE "info/attributes"
f48fd688 369#define ATTRIBUTE_MACRO_PREFIX "[attr]"
bb233d69 370
7d1864ce
JH
371extern int is_bare_repository_cfg;
372extern int is_bare_repository(void);
68025633 373extern int is_inside_git_dir(void);
e90fdc39 374extern char *git_work_tree_cfg;
892c41b9 375extern int is_inside_work_tree(void);
d2b0708e 376extern int have_git_dir(void);
c5fba16c 377extern const char *get_git_dir(void);
8ac069ac
JH
378extern char *get_object_directory(void);
379extern char *get_index_file(void);
5da5c8f4 380extern char *get_graft_file(void);
d7ac12b2 381extern int set_git_dir(const char *path);
e90fdc39 382extern const char *get_git_work_tree(void);
b44ebb19 383extern const char *read_gitfile_gently(const char *path);
19757d80 384extern void set_git_work_tree(const char *tree);
8ac069ac
JH
385
386#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 387
6b5ee137 388extern const char **get_pathspec(const char *prefix, const char **pathspec);
59f0f2f3 389extern void setup_work_tree(void);
4ca06608 390extern const char *setup_git_directory_gently(int *);
d288a700 391extern const char *setup_git_directory(void);
6b5ee137 392extern const char *prefix_path(const char *prefix, int len, const char *path);
4ca06608 393extern const char *prefix_filename(const char *prefix, int len, const char *path);
e23d0b4a 394extern void verify_filename(const char *prefix, const char *name);
ea92f41f 395extern void verify_non_filename(const char *prefix, const char *name);
d288a700 396
f225aeb2
DB
397#define INIT_DB_QUIET 0x0001
398
399extern int init_db(const char *template_dir, unsigned int flags);
400
e83c5163
LT
401#define alloc_nr(x) (((x)+16)*3/2)
402
6815e569
JK
403/*
404 * Realloc the buffer pointed at by variable 'x' so that it can hold
405 * at least 'nr' entries; the number of entries currently allocated
406 * is 'alloc', using the standard growing factor alloc_nr() macro.
407 *
408 * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
409 */
410#define ALLOC_GROW(x, nr, alloc) \
411 do { \
c927e6c6 412 if ((nr) > alloc) { \
4234a761
JH
413 if (alloc_nr(alloc) < (nr)) \
414 alloc = (nr); \
415 else \
416 alloc = alloc_nr(alloc); \
6815e569
JK
417 x = xrealloc((x), alloc * sizeof(*(x))); \
418 } \
419 } while(0)
420
734aab75 421/* Initialize and use the cache information */
4aab5b46 422extern int read_index(struct index_state *);
671c9b7e 423extern int read_index_preload(struct index_state *, const char **pathspec);
4aab5b46 424extern int read_index_from(struct index_state *, const char *path);
fa7b3c2f 425extern int is_index_unborn(struct index_state *);
e46bbcf6 426extern int read_index_unmerged(struct index_state *);
d1f128b0 427extern int write_index(const struct index_state *, int newfd);
4aab5b46 428extern int discard_index(struct index_state *);
d1f128b0 429extern int unmerged_index(const struct index_state *);
8dcf39c4 430extern int verify_path(const char *path);
cd2fef59 431extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
d1f128b0 432extern int index_name_pos(const struct index_state *, const char *name, int namelen);
192268c1
JH
433#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
434#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 435#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
af3785dc 436#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
39425819 437#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
4aab5b46 438extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
8fd2cb40 439extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
81dc2307 440extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
4aab5b46
JH
441extern int remove_index_entry_at(struct index_state *, int pos);
442extern int remove_file_from_index(struct index_state *, const char *path);
38ed1d89
JH
443#define ADD_CACHE_VERBOSE 1
444#define ADD_CACHE_PRETEND 2
01665924 445#define ADD_CACHE_IGNORE_ERRORS 4
041aee31 446#define ADD_CACHE_IGNORE_REMOVAL 8
39425819 447#define ADD_CACHE_INTENT 16
38ed1d89
JH
448extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
449extern int add_file_to_index(struct index_state *, const char *path, int flags);
6640f881 450extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
dbbce55b 451extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
98fa4738 452extern int index_name_is_other(const struct index_state *, const char *, int);
4bd5b7da
JH
453
454/* do stat comparison even if CE_VALID is true */
455#define CE_MATCH_IGNORE_VALID 01
456/* do not check the contents but report dirty on racily-clean entries */
457#define CE_MATCH_RACY_IS_DIRTY 02
d1f128b0
LT
458extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
459extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
4bd5b7da 460
c0fd1f51 461extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
53bca91a 462extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
ec1fcc16 463extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
415e96c8
JH
464extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
465
405e5b2f
LT
466#define REFRESH_REALLY 0x0001 /* ignore_valid */
467#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
468#define REFRESH_QUIET 0x0004 /* be quiet about it */
469#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
3f1b7b60 470#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
d14e7407 471#define REFRESH_SAY_CHANGED 0x0020 /* say "changed" not "needs update" */
d616813d 472extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen);
405e5b2f 473
021b6e45
JH
474struct lock_file {
475 struct lock_file *next;
4723ee99 476 int fd;
5e635e39 477 pid_t owner;
1084b845 478 char on_list;
021b6e45 479 char filename[PATH_MAX];
415e96c8 480};
acd3b9ec
JH
481#define LOCK_DIE_ON_ERROR 1
482#define LOCK_NODEREF 2
40aaae88 483extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
ea3cd5c7 484extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
021b6e45 485extern int commit_lock_file(struct lock_file *);
30ca07a2
JH
486
487extern int hold_locked_index(struct lock_file *, int);
488extern int commit_locked_index(struct lock_file *);
5e7f56ac 489extern void set_alternate_index_output(const char *);
d6cf61bf 490extern int close_lock_file(struct lock_file *);
021b6e45 491extern void rollback_lock_file(struct lock_file *);
eca35a25 492extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
734aab75 493
2ae1c53b 494/* Environment bits from configuration mechanism */
17712991 495extern int trust_executable_bit;
1ce4790b 496extern int trust_ctime;
9378c161 497extern int quote_path_fully;
78a8d641 498extern int has_symlinks;
0a9b88b7 499extern int ignore_case;
5f73076c 500extern int assume_unchanged;
9f0bb90d 501extern int prefer_symlink_refs;
6de08ae6 502extern int log_all_ref_updates;
2f8acdb3 503extern int warn_ambiguous_refs;
457f06d6 504extern int shared_repository;
2ae1c53b 505extern const char *apply_default_whitespace;
12f6c308 506extern int zlib_compression_level;
960ccca6
DH
507extern int core_compression_level;
508extern int core_compression_seen;
60bb8b14 509extern size_t packed_git_window_size;
77ccc5bb 510extern size_t packed_git_limit;
18bdec11 511extern size_t delta_base_cache_limit;
6c510bee 512extern int auto_crlf;
aafe9fba 513extern int fsync_object_files;
671c9b7e 514extern int core_preload_index;
17712991 515
21e5ad50
SP
516enum safe_crlf {
517 SAFE_CRLF_FALSE = 0,
518 SAFE_CRLF_FAIL = 1,
519 SAFE_CRLF_WARN = 2,
520};
521
522extern enum safe_crlf safe_crlf;
523
9ed36cfa 524enum branch_track {
9188ed89 525 BRANCH_TRACK_UNSPECIFIED = -1,
9ed36cfa
JS
526 BRANCH_TRACK_NEVER = 0,
527 BRANCH_TRACK_REMOTE,
528 BRANCH_TRACK_ALWAYS,
529 BRANCH_TRACK_EXPLICIT,
530};
531
c998ae9b
DS
532enum rebase_setup_type {
533 AUTOREBASE_NEVER = 0,
534 AUTOREBASE_LOCAL,
535 AUTOREBASE_REMOTE,
536 AUTOREBASE_ALWAYS,
537};
538
9ed36cfa 539extern enum branch_track git_branch_track;
c998ae9b 540extern enum rebase_setup_type autorebase;
9ed36cfa 541
ab9cb76f
JH
542#define GIT_REPO_VERSION 0
543extern int repository_format_version;
544extern int check_repository_format(void);
545
734aab75
LT
546#define MTIME_CHANGED 0x0001
547#define CTIME_CHANGED 0x0002
548#define OWNER_CHANGED 0x0004
549#define MODE_CHANGED 0x0008
550#define INODE_CHANGED 0x0010
551#define DATA_CHANGED 0x0020
8ae0a8c5 552#define TYPE_CHANGED 0x0040
e83c5163 553
108bebea
AR
554extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
555 __attribute__((format (printf, 3, 4)));
fe2d7776
AR
556extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
557 __attribute__((format (printf, 3, 4)));
aba13e7c
AR
558extern char *git_pathdup(const char *fmt, ...)
559 __attribute__((format (printf, 1, 2)));
108bebea 560
e83c5163 561/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0
TS
562extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
563extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
73134b6d 564extern char *sha1_file_name(const unsigned char *sha1);
bf592c50
DB
565extern char *sha1_pack_name(const unsigned char *sha1);
566extern char *sha1_pack_index_name(const unsigned char *sha1);
013f276e 567extern const char *find_unique_abbrev(const unsigned char *sha1, int);
88cd621d 568extern const unsigned char null_sha1[20];
0bef57ee
DR
569static inline int is_null_sha1(const unsigned char *sha1)
570{
571 return !memcmp(sha1, null_sha1, 20);
572}
a89fccd2
DR
573static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
574{
575 return memcmp(sha1, sha2, 20);
576}
e702496e
SP
577static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
578{
579 memcpy(sha_dst, sha_src, 20);
580}
a8e0d16d
JH
581static inline void hashclr(unsigned char *hash)
582{
583 memset(hash, 0, 20);
584}
f55527f8 585extern int is_empty_blob_sha1(const unsigned char *sha1);
e83c5163 586
14d9c578
JK
587#define EMPTY_TREE_SHA1_HEX \
588 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
589#define EMPTY_TREE_SHA1_BIN \
590 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
591 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
592
f2db68ed
HE
593int git_mkstemp(char *path, size_t n, const char *template);
594
06cbe855
HO
595/*
596 * NOTE NOTE NOTE!!
597 *
598 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
599 * not be changed. Old repositories have core.sharedrepository written in
600 * numeric format, and therefore these values are preserved for compatibility
601 * reasons.
602 */
94df2506 603enum sharedrepo {
06cbe855
HO
604 PERM_UMASK = 0,
605 OLD_PERM_GROUP = 1,
606 OLD_PERM_EVERYBODY = 2,
607 PERM_GROUP = 0660,
608 PERM_EVERYBODY = 0664,
94df2506
JH
609};
610int git_config_perm(const char *var, const char *value);
457f06d6 611int adjust_shared_perm(const char *path);
b2cb9425 612int safe_create_leading_directories(char *path);
8e21d63b 613int safe_create_leading_directories_const(const char *path);
bd22c904 614char *enter_repo(char *path, int strict);
e5392c51
JS
615static inline int is_absolute_path(const char *path)
616{
25fe217b 617 return path[0] == '/' || has_dos_drive_prefix(path);
e5392c51 618}
90b4a71c 619int is_directory(const char *);
e5392c51 620const char *make_absolute_path(const char *path);
1b9a9467 621const char *make_nonrelative_path(const char *path);
044bbbcb 622const char *make_relative_path(const char *abs, const char *base);
ae299be0 623int normalize_absolute_path(char *buf, const char *path);
0454dd93 624int longest_ancestor_length(const char *path, const char *prefix_list);
b2cb9425 625
e83c5163 626/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
21666f1a 627extern int sha1_object_info(const unsigned char *, unsigned long *);
21666f1a 628extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
ce9fbf16 629extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
bf0f910d 630extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
21666f1a 631extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
bbac7311 632extern int force_object_loose(const unsigned char *sha1, time_t mtime);
8237b185 633
ac939109
NP
634/* just like read_sha1_file(), but non fatal in presence of bad objects */
635extern void *read_object(const unsigned char *sha1, enum object_type *type, unsigned long *size);
636
0e8189e2
NP
637/* global flag to enable extra checks when accessing packed objects */
638extern int do_check_packed_object_crc;
639
5d6ccf5c 640extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 641
839837b9 642extern int move_temp_to_file(const char *tmpfile, const char *filename);
8237b185 643
106d710b 644extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
8237b185 645extern int has_sha1_file(const unsigned char *sha1);
0f4dc14a 646extern int has_loose_object_nonlocal(const unsigned char *sha1);
8237b185 647
bf592c50
DB
648extern int has_pack_file(const unsigned char *sha1);
649extern int has_pack_index(const unsigned char *sha1);
650
192a6be2
LT
651extern const signed char hexval_table[256];
652static inline unsigned int hexval(unsigned char c)
e49521b5
JH
653{
654 return hexval_table[c];
655}
656
e83c5163 657/* Convert to/from hex/sha1 representation */
46a6c262
JH
658#define MINIMUM_ABBREV 4
659#define DEFAULT_ABBREV 7
660
3c249c95 661extern int get_sha1(const char *str, unsigned char *sha1);
a0cd87a5 662extern int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode);
197ee8c9
LT
663extern int get_sha1_hex(const char *hex, unsigned char *sha1);
664extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
ca8db142 665extern int read_ref(const char *filename, unsigned char *sha1);
8da19775 666extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
e86eb666 667extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
eb3a4822 668extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
e86eb666 669
79803322
SP
670extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
671extern const char *ref_rev_parse_rules[];
605b4978 672extern const char *ref_fetch_rules[];
79803322 673
8b5157e4 674extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
c847f537 675extern int validate_headref(const char *ref);
e83c5163 676
958ba6c9 677extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
0ab9e1e8 678extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 679extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
e83c5163 680
40469ee9 681extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 682 const char *required_type,
40469ee9
JH
683 unsigned long *size,
684 unsigned char *sha1_ret);
f4913f91 685
81776315
JH
686extern struct object *peel_to_type(const char *name, int namelen,
687 struct object *o, enum object_type);
688
73013afd
JH
689enum date_mode {
690 DATE_NORMAL = 0,
691 DATE_RELATIVE,
692 DATE_SHORT,
693 DATE_LOCAL,
694 DATE_ISO8601,
695 DATE_RFC2822
696};
697
f8493ec0 698const char *show_date(unsigned long time, int timezone, enum date_mode mode);
2a39064c 699int parse_date(const char *date, char *buf, int bufsize);
ecee9d9e 700void datestamp(char *buf, int bufsize);
3c07b1d1 701unsigned long approxidate(const char *);
856665f8 702enum date_mode parse_date_format(const char *format);
ecee9d9e 703
774751a8
JH
704#define IDENT_WARN_ON_NO_NAME 1
705#define IDENT_ERROR_ON_NO_NAME 2
706#define IDENT_NO_DATE 4
749be728
JH
707extern const char *git_author_info(int);
708extern const char *git_committer_info(int);
798123af 709extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
d9ccfe77 710extern const char *fmt_name(const char *name, const char *email);
6aa33f40 711
12dccc16
LT
712struct checkout {
713 const char *base_dir;
714 int base_dir_len;
715 unsigned force:1,
716 quiet:1,
717 not_new:1,
718 refresh_cache:1;
719};
720
efbc5831 721extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
c40641b7 722extern int has_symlink_leading_path(int len, const char *name);
09c93066 723extern int has_symlink_or_noent_leading_path(int len, const char *name);
12dccc16 724
9a217f2a 725extern struct alternate_object_database {
d5a63b99 726 struct alternate_object_database *next;
9a217f2a 727 char *name;
8f1d2e6f 728 char base[FLEX_ARRAY]; /* more */
d5a63b99 729} *alt_odb_list;
9a217f2a 730extern void prepare_alt_odb(void);
bef70b22 731extern void add_to_alternates_file(const char *reference);
d79796bc
JH
732typedef int alt_odb_fn(struct alternate_object_database *, void *);
733extern void foreach_alt_odb(alt_odb_fn, void*);
9a217f2a 734
c41ee586
SP
735struct pack_window {
736 struct pack_window *next;
737 unsigned char *base;
738 off_t offset;
739 size_t len;
740 unsigned int last_used;
741 unsigned int inuse_cnt;
742};
743
9a217f2a
JH
744extern struct packed_git {
745 struct packed_git *next;
c41ee586 746 struct pack_window *windows;
2dc3a234 747 off_t pack_size;
57059091
NP
748 const void *index_data;
749 size_t index_size;
750 uint32_t num_objects;
8eca0b47
NP
751 uint32_t num_bad_objects;
752 unsigned char *bad_object_sha1;
42873078 753 int index_version;
57059091 754 time_t mtime;
9bc879c1 755 int pack_fd;
8d25931d
BC
756 unsigned pack_local:1,
757 pack_keep:1;
bf592c50 758 unsigned char sha1[20];
8f1d2e6f
JH
759 /* something like ".git/objects/pack/xxxxx.pack" */
760 char pack_name[FLEX_ARRAY]; /* more */
9a217f2a 761} *packed_git;
f3bf9224
JH
762
763struct pack_entry {
c4001d92 764 off_t offset;
f3bf9224
JH
765 unsigned char sha1[20];
766 struct packed_git *p;
767};
768
d1c133f5
LT
769struct ref {
770 struct ref *next;
771 unsigned char old_sha1[20];
772 unsigned char new_sha1[20];
be885d96 773 char *symref;
9f8a15c7
SP
774 unsigned int force:1,
775 merge:1,
776 nonfastforward:1,
777 deletion:1;
8736a848
JK
778 enum {
779 REF_STATUS_NONE = 0,
780 REF_STATUS_OK,
781 REF_STATUS_REJECT_NONFASTFORWARD,
782 REF_STATUS_REJECT_NODELETE,
783 REF_STATUS_UPTODATE,
ca74c458 784 REF_STATUS_REMOTE_REJECT,
2a0fe89a 785 REF_STATUS_EXPECTING_REPORT,
8736a848 786 } status;
2a0fe89a 787 char *remote_status;
f88395ac 788 struct ref *peer_ref; /* when renaming */
8f1d2e6f 789 char name[FLEX_ARRAY]; /* more */
d1c133f5
LT
790};
791
2718ff09
LT
792#define REF_NORMAL (1u << 0)
793#define REF_HEADS (1u << 1)
794#define REF_TAGS (1u << 2)
795
cda69f48
JK
796extern struct ref *find_ref_by_name(struct ref *list, const char *name);
797
7841ce79 798#define CONNECT_VERBOSE (1u << 0)
4577370e 799extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
98158e9c 800extern int finish_connect(struct child_process *conn);
013e7c7f 801extern int path_match(const char *path, int nr, char **match);
41cb7488 802extern int get_ack(int fd, unsigned char *result_sha1);
40c155ff
JH
803struct extra_have_objects {
804 int nr, alloc;
805 unsigned char (*array)[20];
806};
807extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
211b5f9e 808extern int server_supports(const char *feature);
f7192598 809
bf592c50
DB
810extern struct packed_git *parse_pack_index(unsigned char *sha1);
811
9a217f2a 812extern void prepare_packed_git(void);
fc04c412 813extern void reprepare_packed_git(void);
bf592c50
DB
814extern void install_packed_git(struct packed_git *pack);
815
a6080a0a 816extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
bf592c50
DB
817 struct packed_git *packs);
818
276bc2ca 819extern void pack_report(void);
d079837e 820extern int open_pack_index(struct packed_git *);
c4001d92 821extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
c9ced051 822extern void close_pack_windows(struct packed_git *);
03e79c88 823extern void unuse_pack(struct pack_window **);
c74faea1 824extern void free_pack_by_name(const char *);
42873078 825extern struct packed_git *add_packed_git(const char *, int, int);
d079837e 826extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
99093238 827extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
c4001d92
SP
828extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
829extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
09ded04b 830extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
54dab52a 831extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
c4001d92 832extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
000dfd3f 833extern int matches_pack_name(struct packed_git *p, const char *name);
9a217f2a 834
8f3f9b09
JH
835/* Dumb servers support */
836extern int update_server_info(int);
837
ef90d6d4
JS
838typedef int (*config_fn_t)(const char *, const char *, void *);
839extern int git_default_config(const char *, const char *, void *);
840extern int git_config_from_file(config_fn_t fn, const char *, void *);
841extern int git_config(config_fn_t fn, void *);
0b87b6e0 842extern int git_parse_ulong(const char *, unsigned long *);
17712991 843extern int git_config_int(const char *, const char *);
0b87b6e0 844extern unsigned long git_config_ulong(const char *, const char *);
a53f2ec6 845extern int git_config_bool_or_int(const char *, const char *, int *);
17712991 846extern int git_config_bool(const char *, const char *);
ea5105a5 847extern int git_config_string(const char **, const char *, const char *);
10bea152 848extern int git_config_set(const char *, const char *);
4ddba79d 849extern int git_config_set_multivar(const char *, const char *, const char *, int);
0667fcfb 850extern int git_config_rename_section(const char *, const char *);
506b17b1 851extern const char *git_etc_gitconfig(void);
ef90d6d4 852extern int check_repository_format_version(const char *var, const char *value, void *cb);
ab88c363
JK
853extern int git_config_system(void);
854extern int git_config_global(void);
40ea4ed9 855extern int config_error_nonbool(const char *);
dc871831 856extern const char *config_exclusive_filename;
17712991 857
e1b10391
LT
858#define MAX_GITNAME (1000)
859extern char git_default_email[MAX_GITNAME];
860extern char git_default_name[MAX_GITNAME];
bb1ae3f6 861extern int user_ident_explicitly_given;
e1b10391 862
1a8f2741 863extern const char *git_commit_encoding;
3a55602e 864extern const char *git_log_output_encoding;
4e72dcec 865
06f59e9f
TT
866/* IO helper functions */
867extern void maybe_flush_or_die(FILE *, const char *);
f3123c4a 868extern int copy_fd(int ifd, int ofd);
1468bd47 869extern int copy_file(const char *dst, const char *src, int mode);
0104ca09
HO
870extern ssize_t read_in_full(int fd, void *buf, size_t count);
871extern ssize_t write_in_full(int fd, const void *buf, size_t count);
7230e6d0 872extern void write_or_die(int fd, const void *buf, size_t count);
6ce4e61f 873extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
e0814056 874extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
4c81b03e 875extern void fsync_or_die(int fd, const char *);
ad897215 876
f67b45f8
LT
877/* pager.c */
878extern void setup_pager(void);
872da32d 879extern const char *pager_program;
6e9af863 880extern int pager_in_use(void);
aa086eb8 881extern int pager_use_color;
f67b45f8 882
ee9601e6 883extern const char *editor_program;
dfb068be 884extern const char *excludes_file;
4d87b9c5 885
051308f6 886/* base85 */
f9815772
JM
887int decode_85(char *dst, const char *line, int linelen);
888void encode_85(char *buf, const unsigned char *data, int bytes);
051308f6 889
855419f7 890/* alloc.c */
100c5f3b
LT
891extern void *alloc_blob_node(void);
892extern void *alloc_tree_node(void);
893extern void *alloc_commit_node(void);
894extern void *alloc_tag_node(void);
895extern void *alloc_object_node(void);
855419f7
LT
896extern void alloc_report(void);
897
6ce4e61f 898/* trace.c */
6ce4e61f 899extern void trace_printf(const char *format, ...);
b319ce4c 900extern void trace_argv_printf(const char **argv, const char *format, ...);
6ce4e61f 901
6c510bee 902/* convert.c */
5ecd293d 903/* returns 1 if *dst was used */
21e5ad50
SP
904extern int convert_to_git(const char *path, const char *src, size_t len,
905 struct strbuf *dst, enum safe_crlf checksafe);
5ecd293d 906extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
6c510bee 907
b6ec1d61 908/* add */
7ae02a30
AR
909/*
910 * return 0 if success, 1 - if addition of a file failed and
911 * ADD_FILES_IGNORE_ERRORS was specified in flags
912 */
913int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
b6ec1d61 914
aecbf914
JH
915/* diff.c */
916extern int diff_auto_refresh_index;
917
68faf689
JH
918/* match-trees.c */
919void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
920
a9cc857a
JH
921/*
922 * whitespace rules.
923 * used by both diff and apply
924 */
925#define WS_TRAILING_SPACE 01
926#define WS_SPACE_BEFORE_TAB 02
459fa6d0 927#define WS_INDENT_WITH_NON_TAB 04
b2979ff5 928#define WS_CR_AT_EOL 010
a9cc857a 929#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB)
cf1b7869
JH
930extern unsigned whitespace_rule_cfg;
931extern unsigned whitespace_rule(const char *);
932extern unsigned parse_whitespace_rule(const char *);
8f8841e9
JH
933extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
934extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
c1795bb0 935extern char *whitespace_error_string(unsigned ws);
fe3403c3 936extern int ws_fix_copy(char *, const char *, int, unsigned, int *);
877f23cc 937extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
a9cc857a 938
ee425e46
JH
939/* ls-files */
940int pathspec_match(const char **spec, char *matched, const char *filename, int skiplen);
941int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
942void overlay_tree_on_cache(const char *tree_name, const char *prefix);
943
94351118 944char *alias_lookup(const char *alias);
0989fe96 945int split_cmdline(char *cmdline, const char ***argv);
94351118 946
e83c5163 947#endif /* CACHE_H */