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