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