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