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