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