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