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