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