Add cache preload facility
[git/git.git] / cache.h
1 #ifndef CACHE_H
2 #define CACHE_H
3
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hash.h"
7
8 #include SHA1_HEADER
9 #ifndef git_SHA_CTX
10 #define git_SHA_CTX SHA_CTX
11 #define git_SHA1_Init SHA1_Init
12 #define git_SHA1_Update SHA1_Update
13 #define git_SHA1_Final SHA1_Final
14 #endif
15
16 #include <zlib.h>
17 #if defined(NO_DEFLATE_BOUND) || ZLIB_VERNUM < 0x1200
18 #define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
19 #endif
20
21 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
22 #define DTYPE(de) ((de)->d_type)
23 #else
24 #undef DT_UNKNOWN
25 #undef DT_DIR
26 #undef DT_REG
27 #undef DT_LNK
28 #define DT_UNKNOWN 0
29 #define DT_DIR 1
30 #define DT_REG 2
31 #define DT_LNK 3
32 #define DTYPE(de) DT_UNKNOWN
33 #endif
34
35 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
36 #define S_IFINVALID 0030000
37
38 /*
39 * A "directory link" is a link to another git directory.
40 *
41 * The value 0160000 is not normally a valid mode, and
42 * also just happens to be S_IFDIR + S_IFLNK
43 *
44 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
45 * always having the same values everywhere. We should use
46 * our internal git values for these things, and then we can
47 * translate that to the OS-specific value. It just so
48 * happens that everybody shares the same bit representation
49 * in the UNIX world (and apparently wider too..)
50 */
51 #define S_IFGITLINK 0160000
52 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
53
54 /*
55 * Intensive research over the course of many years has shown that
56 * port 9418 is totally unused by anything else. Or
57 *
58 * Your search - "port 9418" - did not match any documents.
59 *
60 * as www.google.com puts it.
61 *
62 * This port has been properly assigned for git use by IANA:
63 * git (Assigned-9418) [I06-050728-0001].
64 *
65 * git 9418/tcp git pack transfer service
66 * git 9418/udp git pack transfer service
67 *
68 * with Linus Torvalds <torvalds@osdl.org> as the point of
69 * contact. September 2005.
70 *
71 * See http://www.iana.org/assignments/port-numbers
72 */
73 #define DEFAULT_GIT_PORT 9418
74
75 /*
76 * Basic data structures for the directory cache
77 */
78
79 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
80 struct cache_header {
81 unsigned int hdr_signature;
82 unsigned int hdr_version;
83 unsigned int hdr_entries;
84 };
85
86 /*
87 * The "cache_time" is just the low 32 bits of the
88 * time. It doesn't matter if it overflows - we only
89 * check it for equality in the 32 bits we save.
90 */
91 struct cache_time {
92 unsigned int sec;
93 unsigned int nsec;
94 };
95
96 /*
97 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
98 * Again - this is just a (very strong in practice) heuristic that
99 * the inode hasn't changed.
100 *
101 * We save the fields in big-endian order to allow using the
102 * index file over NFS transparently.
103 */
104 struct ondisk_cache_entry {
105 struct cache_time ctime;
106 struct cache_time mtime;
107 unsigned int dev;
108 unsigned int ino;
109 unsigned int mode;
110 unsigned int uid;
111 unsigned int gid;
112 unsigned int size;
113 unsigned char sha1[20];
114 unsigned short flags;
115 char name[FLEX_ARRAY]; /* more */
116 };
117
118 struct cache_entry {
119 unsigned int ce_ctime;
120 unsigned int ce_mtime;
121 unsigned int ce_dev;
122 unsigned int ce_ino;
123 unsigned int ce_mode;
124 unsigned int ce_uid;
125 unsigned int ce_gid;
126 unsigned int ce_size;
127 unsigned int ce_flags;
128 unsigned char sha1[20];
129 struct cache_entry *next;
130 char name[FLEX_ARRAY]; /* more */
131 };
132
133 #define CE_NAMEMASK (0x0fff)
134 #define CE_STAGEMASK (0x3000)
135 #define CE_EXTENDED (0x4000)
136 #define CE_VALID (0x8000)
137 #define CE_STAGESHIFT 12
138
139 /* In-memory only */
140 #define CE_UPDATE (0x10000)
141 #define CE_REMOVE (0x20000)
142 #define CE_UPTODATE (0x40000)
143 #define CE_ADDED (0x80000)
144
145 #define CE_HASHED (0x100000)
146 #define CE_UNHASHED (0x200000)
147
148 /*
149 * Copy the sha1 and stat state of a cache entry from one to
150 * another. But we never change the name, or the hash state!
151 */
152 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
153 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
154 {
155 unsigned int state = dst->ce_flags & CE_STATE_MASK;
156
157 /* Don't copy hash chain and name */
158 memcpy(dst, src, offsetof(struct cache_entry, next));
159
160 /* Restore the hash state */
161 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
162 }
163
164 static inline unsigned create_ce_flags(size_t len, unsigned stage)
165 {
166 if (len >= CE_NAMEMASK)
167 len = CE_NAMEMASK;
168 return (len | (stage << CE_STAGESHIFT));
169 }
170
171 static inline size_t ce_namelen(const struct cache_entry *ce)
172 {
173 size_t len = ce->ce_flags & CE_NAMEMASK;
174 if (len < CE_NAMEMASK)
175 return len;
176 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
177 }
178
179 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
180 #define ondisk_ce_size(ce) ondisk_cache_entry_size(ce_namelen(ce))
181 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
182 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
183 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
184
185 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
186 static inline unsigned int create_ce_mode(unsigned int mode)
187 {
188 if (S_ISLNK(mode))
189 return S_IFLNK;
190 if (S_ISDIR(mode) || S_ISGITLINK(mode))
191 return S_IFGITLINK;
192 return S_IFREG | ce_permissions(mode);
193 }
194 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
195 {
196 extern int trust_executable_bit, has_symlinks;
197 if (!has_symlinks && S_ISREG(mode) &&
198 ce && S_ISLNK(ce->ce_mode))
199 return ce->ce_mode;
200 if (!trust_executable_bit && S_ISREG(mode)) {
201 if (ce && S_ISREG(ce->ce_mode))
202 return ce->ce_mode;
203 return create_ce_mode(0666);
204 }
205 return create_ce_mode(mode);
206 }
207 static inline int ce_to_dtype(const struct cache_entry *ce)
208 {
209 unsigned ce_mode = ntohl(ce->ce_mode);
210 if (S_ISREG(ce_mode))
211 return DT_REG;
212 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
213 return DT_DIR;
214 else if (S_ISLNK(ce_mode))
215 return DT_LNK;
216 else
217 return DT_UNKNOWN;
218 }
219 #define canon_mode(mode) \
220 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
221 S_ISLNK(mode) ? S_IFLNK : S_ISDIR(mode) ? S_IFDIR : S_IFGITLINK)
222
223 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
224 #define ondisk_cache_entry_size(len) ((offsetof(struct ondisk_cache_entry,name) + (len) + 8) & ~7)
225
226 struct index_state {
227 struct cache_entry **cache;
228 unsigned int cache_nr, cache_alloc, cache_changed;
229 struct cache_tree *cache_tree;
230 time_t timestamp;
231 void *alloc;
232 unsigned name_hash_initialized : 1,
233 initialized : 1;
234 struct hash_table name_hash;
235 };
236
237 extern struct index_state the_index;
238
239 /* Name hashing */
240 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
241 /*
242 * We don't actually *remove* it, we can just mark it invalid so that
243 * we won't find it in lookups.
244 *
245 * Not only would we have to search the lists (simple enough), but
246 * we'd also have to rehash other hash buckets in case this makes the
247 * hash bucket empty (common). So it's much better to just mark
248 * it.
249 */
250 static inline void remove_name_hash(struct cache_entry *ce)
251 {
252 ce->ce_flags |= CE_UNHASHED;
253 }
254
255
256 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
257 #define active_cache (the_index.cache)
258 #define active_nr (the_index.cache_nr)
259 #define active_alloc (the_index.cache_alloc)
260 #define active_cache_changed (the_index.cache_changed)
261 #define active_cache_tree (the_index.cache_tree)
262
263 #define read_cache() read_index(&the_index)
264 #define read_cache_from(path) read_index_from(&the_index, (path))
265 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
266 #define is_cache_unborn() is_index_unborn(&the_index)
267 #define read_cache_unmerged() read_index_unmerged(&the_index)
268 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
269 #define discard_cache() discard_index(&the_index)
270 #define unmerged_cache() unmerged_index(&the_index)
271 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
272 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
273 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
274 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
275 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
276 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
277 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
278 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL)
279 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
280 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
281 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
282 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
283 #endif
284
285 enum object_type {
286 OBJ_BAD = -1,
287 OBJ_NONE = 0,
288 OBJ_COMMIT = 1,
289 OBJ_TREE = 2,
290 OBJ_BLOB = 3,
291 OBJ_TAG = 4,
292 /* 5 for future expansion */
293 OBJ_OFS_DELTA = 6,
294 OBJ_REF_DELTA = 7,
295 OBJ_ANY,
296 OBJ_MAX,
297 };
298
299 static inline enum object_type object_type(unsigned int mode)
300 {
301 return S_ISDIR(mode) ? OBJ_TREE :
302 S_ISGITLINK(mode) ? OBJ_COMMIT :
303 OBJ_BLOB;
304 }
305
306 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
307 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
308 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
309 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
310 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
311 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
312 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
313 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
314 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
315 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
316 #define GITATTRIBUTES_FILE ".gitattributes"
317 #define INFOATTRIBUTES_FILE "info/attributes"
318 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
319
320 extern int is_bare_repository_cfg;
321 extern int is_bare_repository(void);
322 extern int is_inside_git_dir(void);
323 extern char *git_work_tree_cfg;
324 extern int is_inside_work_tree(void);
325 extern int have_git_dir(void);
326 extern const char *get_git_dir(void);
327 extern char *get_object_directory(void);
328 extern char *get_index_file(void);
329 extern char *get_graft_file(void);
330 extern int set_git_dir(const char *path);
331 extern const char *get_git_work_tree(void);
332 extern const char *read_gitfile_gently(const char *path);
333 extern void set_git_work_tree(const char *tree);
334
335 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
336
337 extern const char **get_pathspec(const char *prefix, const char **pathspec);
338 extern void setup_work_tree(void);
339 extern const char *setup_git_directory_gently(int *);
340 extern const char *setup_git_directory(void);
341 extern const char *prefix_path(const char *prefix, int len, const char *path);
342 extern const char *prefix_filename(const char *prefix, int len, const char *path);
343 extern void verify_filename(const char *prefix, const char *name);
344 extern void verify_non_filename(const char *prefix, const char *name);
345
346 #define INIT_DB_QUIET 0x0001
347
348 extern int init_db(const char *template_dir, unsigned int flags);
349
350 #define alloc_nr(x) (((x)+16)*3/2)
351
352 /*
353 * Realloc the buffer pointed at by variable 'x' so that it can hold
354 * at least 'nr' entries; the number of entries currently allocated
355 * is 'alloc', using the standard growing factor alloc_nr() macro.
356 *
357 * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
358 */
359 #define ALLOC_GROW(x, nr, alloc) \
360 do { \
361 if ((nr) > alloc) { \
362 if (alloc_nr(alloc) < (nr)) \
363 alloc = (nr); \
364 else \
365 alloc = alloc_nr(alloc); \
366 x = xrealloc((x), alloc * sizeof(*(x))); \
367 } \
368 } while(0)
369
370 /* Initialize and use the cache information */
371 extern int read_index(struct index_state *);
372 extern int read_index_preload(struct index_state *, const char **pathspec);
373 extern int read_index_from(struct index_state *, const char *path);
374 extern int is_index_unborn(struct index_state *);
375 extern int read_index_unmerged(struct index_state *);
376 extern int write_index(const struct index_state *, int newfd);
377 extern int discard_index(struct index_state *);
378 extern int unmerged_index(const struct index_state *);
379 extern int verify_path(const char *path);
380 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
381 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
382 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
383 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
384 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
385 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
386 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
387 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
388 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
389 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
390 extern int remove_index_entry_at(struct index_state *, int pos);
391 extern int remove_file_from_index(struct index_state *, const char *path);
392 #define ADD_CACHE_VERBOSE 1
393 #define ADD_CACHE_PRETEND 2
394 #define ADD_CACHE_IGNORE_ERRORS 4
395 #define ADD_CACHE_IGNORE_REMOVAL 8
396 #define ADD_CACHE_INTENT 16
397 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
398 extern int add_file_to_index(struct index_state *, const char *path, int flags);
399 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
400 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
401 extern int index_name_is_other(const struct index_state *, const char *, int);
402
403 /* do stat comparison even if CE_VALID is true */
404 #define CE_MATCH_IGNORE_VALID 01
405 /* do not check the contents but report dirty on racily-clean entries */
406 #define CE_MATCH_RACY_IS_DIRTY 02
407 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
408 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
409
410 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
411 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
412 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
413 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
414
415 #define REFRESH_REALLY 0x0001 /* ignore_valid */
416 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
417 #define REFRESH_QUIET 0x0004 /* be quiet about it */
418 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
419 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
420 #define REFRESH_SAY_CHANGED 0x0020 /* say "changed" not "needs update" */
421 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen);
422
423 struct lock_file {
424 struct lock_file *next;
425 int fd;
426 pid_t owner;
427 char on_list;
428 char filename[PATH_MAX];
429 };
430 #define LOCK_DIE_ON_ERROR 1
431 #define LOCK_NODEREF 2
432 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
433 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
434 extern int commit_lock_file(struct lock_file *);
435
436 extern int hold_locked_index(struct lock_file *, int);
437 extern int commit_locked_index(struct lock_file *);
438 extern void set_alternate_index_output(const char *);
439 extern int close_lock_file(struct lock_file *);
440 extern void rollback_lock_file(struct lock_file *);
441 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
442
443 /* Environment bits from configuration mechanism */
444 extern int trust_executable_bit;
445 extern int trust_ctime;
446 extern int quote_path_fully;
447 extern int has_symlinks;
448 extern int ignore_case;
449 extern int assume_unchanged;
450 extern int prefer_symlink_refs;
451 extern int log_all_ref_updates;
452 extern int warn_ambiguous_refs;
453 extern int shared_repository;
454 extern const char *apply_default_whitespace;
455 extern int zlib_compression_level;
456 extern int core_compression_level;
457 extern int core_compression_seen;
458 extern size_t packed_git_window_size;
459 extern size_t packed_git_limit;
460 extern size_t delta_base_cache_limit;
461 extern int auto_crlf;
462 extern int fsync_object_files;
463 extern int core_preload_index;
464
465 enum safe_crlf {
466 SAFE_CRLF_FALSE = 0,
467 SAFE_CRLF_FAIL = 1,
468 SAFE_CRLF_WARN = 2,
469 };
470
471 extern enum safe_crlf safe_crlf;
472
473 enum branch_track {
474 BRANCH_TRACK_UNSPECIFIED = -1,
475 BRANCH_TRACK_NEVER = 0,
476 BRANCH_TRACK_REMOTE,
477 BRANCH_TRACK_ALWAYS,
478 BRANCH_TRACK_EXPLICIT,
479 };
480
481 enum rebase_setup_type {
482 AUTOREBASE_NEVER = 0,
483 AUTOREBASE_LOCAL,
484 AUTOREBASE_REMOTE,
485 AUTOREBASE_ALWAYS,
486 };
487
488 extern enum branch_track git_branch_track;
489 extern enum rebase_setup_type autorebase;
490
491 #define GIT_REPO_VERSION 0
492 extern int repository_format_version;
493 extern int check_repository_format(void);
494
495 #define MTIME_CHANGED 0x0001
496 #define CTIME_CHANGED 0x0002
497 #define OWNER_CHANGED 0x0004
498 #define MODE_CHANGED 0x0008
499 #define INODE_CHANGED 0x0010
500 #define DATA_CHANGED 0x0020
501 #define TYPE_CHANGED 0x0040
502
503 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
504 __attribute__((format (printf, 3, 4)));
505 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
506 __attribute__((format (printf, 3, 4)));
507 extern char *git_pathdup(const char *fmt, ...)
508 __attribute__((format (printf, 1, 2)));
509
510 /* Return a statically allocated filename matching the sha1 signature */
511 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
512 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
513 extern char *sha1_file_name(const unsigned char *sha1);
514 extern char *sha1_pack_name(const unsigned char *sha1);
515 extern char *sha1_pack_index_name(const unsigned char *sha1);
516 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
517 extern const unsigned char null_sha1[20];
518 static inline int is_null_sha1(const unsigned char *sha1)
519 {
520 return !memcmp(sha1, null_sha1, 20);
521 }
522 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
523 {
524 return memcmp(sha1, sha2, 20);
525 }
526 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
527 {
528 memcpy(sha_dst, sha_src, 20);
529 }
530 static inline void hashclr(unsigned char *hash)
531 {
532 memset(hash, 0, 20);
533 }
534 extern int is_empty_blob_sha1(const unsigned char *sha1);
535
536 int git_mkstemp(char *path, size_t n, const char *template);
537
538 /*
539 * NOTE NOTE NOTE!!
540 *
541 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
542 * not be changed. Old repositories have core.sharedrepository written in
543 * numeric format, and therefore these values are preserved for compatibility
544 * reasons.
545 */
546 enum sharedrepo {
547 PERM_UMASK = 0,
548 OLD_PERM_GROUP = 1,
549 OLD_PERM_EVERYBODY = 2,
550 PERM_GROUP = 0660,
551 PERM_EVERYBODY = 0664,
552 };
553 int git_config_perm(const char *var, const char *value);
554 int adjust_shared_perm(const char *path);
555 int safe_create_leading_directories(char *path);
556 int safe_create_leading_directories_const(const char *path);
557 char *enter_repo(char *path, int strict);
558 static inline int is_absolute_path(const char *path)
559 {
560 return path[0] == '/' || has_dos_drive_prefix(path);
561 }
562 int is_directory(const char *);
563 const char *make_absolute_path(const char *path);
564 const char *make_nonrelative_path(const char *path);
565 const char *make_relative_path(const char *abs, const char *base);
566 int normalize_absolute_path(char *buf, const char *path);
567 int longest_ancestor_length(const char *path, const char *prefix_list);
568
569 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
570 extern int sha1_object_info(const unsigned char *, unsigned long *);
571 extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
572 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
573 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
574 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
575 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
576
577 /* just like read_sha1_file(), but non fatal in presence of bad objects */
578 extern void *read_object(const unsigned char *sha1, enum object_type *type, unsigned long *size);
579
580 /* global flag to enable extra checks when accessing packed objects */
581 extern int do_check_packed_object_crc;
582
583 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
584
585 extern int move_temp_to_file(const char *tmpfile, const char *filename);
586
587 extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
588 extern int has_sha1_file(const unsigned char *sha1);
589 extern int has_loose_object_nonlocal(const unsigned char *sha1);
590
591 extern int has_pack_file(const unsigned char *sha1);
592 extern int has_pack_index(const unsigned char *sha1);
593
594 extern const signed char hexval_table[256];
595 static inline unsigned int hexval(unsigned char c)
596 {
597 return hexval_table[c];
598 }
599
600 /* Convert to/from hex/sha1 representation */
601 #define MINIMUM_ABBREV 4
602 #define DEFAULT_ABBREV 7
603
604 extern int get_sha1(const char *str, unsigned char *sha1);
605 extern int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode);
606 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
607 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
608 extern int read_ref(const char *filename, unsigned char *sha1);
609 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
610 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
611 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
612
613 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
614 extern const char *ref_rev_parse_rules[];
615 extern const char *ref_fetch_rules[];
616
617 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
618 extern int validate_headref(const char *ref);
619
620 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
621 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
622 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
623
624 extern void *read_object_with_reference(const unsigned char *sha1,
625 const char *required_type,
626 unsigned long *size,
627 unsigned char *sha1_ret);
628
629 extern struct object *peel_to_type(const char *name, int namelen,
630 struct object *o, enum object_type);
631
632 enum date_mode {
633 DATE_NORMAL = 0,
634 DATE_RELATIVE,
635 DATE_SHORT,
636 DATE_LOCAL,
637 DATE_ISO8601,
638 DATE_RFC2822
639 };
640
641 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
642 int parse_date(const char *date, char *buf, int bufsize);
643 void datestamp(char *buf, int bufsize);
644 unsigned long approxidate(const char *);
645 enum date_mode parse_date_format(const char *format);
646
647 #define IDENT_WARN_ON_NO_NAME 1
648 #define IDENT_ERROR_ON_NO_NAME 2
649 #define IDENT_NO_DATE 4
650 extern const char *git_author_info(int);
651 extern const char *git_committer_info(int);
652 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
653 extern const char *fmt_name(const char *name, const char *email);
654
655 struct checkout {
656 const char *base_dir;
657 int base_dir_len;
658 unsigned force:1,
659 quiet:1,
660 not_new:1,
661 refresh_cache:1;
662 };
663
664 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
665 extern int has_symlink_leading_path(int len, const char *name);
666
667 extern struct alternate_object_database {
668 struct alternate_object_database *next;
669 char *name;
670 char base[FLEX_ARRAY]; /* more */
671 } *alt_odb_list;
672 extern void prepare_alt_odb(void);
673 extern void add_to_alternates_file(const char *reference);
674 typedef int alt_odb_fn(struct alternate_object_database *, void *);
675 extern void foreach_alt_odb(alt_odb_fn, void*);
676
677 struct pack_window {
678 struct pack_window *next;
679 unsigned char *base;
680 off_t offset;
681 size_t len;
682 unsigned int last_used;
683 unsigned int inuse_cnt;
684 };
685
686 extern struct packed_git {
687 struct packed_git *next;
688 struct pack_window *windows;
689 off_t pack_size;
690 const void *index_data;
691 size_t index_size;
692 uint32_t num_objects;
693 uint32_t num_bad_objects;
694 unsigned char *bad_object_sha1;
695 int index_version;
696 time_t mtime;
697 int pack_fd;
698 unsigned pack_local:1,
699 pack_keep:1;
700 unsigned char sha1[20];
701 /* something like ".git/objects/pack/xxxxx.pack" */
702 char pack_name[FLEX_ARRAY]; /* more */
703 } *packed_git;
704
705 struct pack_entry {
706 off_t offset;
707 unsigned char sha1[20];
708 struct packed_git *p;
709 };
710
711 struct ref {
712 struct ref *next;
713 unsigned char old_sha1[20];
714 unsigned char new_sha1[20];
715 char *symref;
716 unsigned int force:1,
717 merge:1,
718 nonfastforward:1,
719 deletion:1;
720 enum {
721 REF_STATUS_NONE = 0,
722 REF_STATUS_OK,
723 REF_STATUS_REJECT_NONFASTFORWARD,
724 REF_STATUS_REJECT_NODELETE,
725 REF_STATUS_UPTODATE,
726 REF_STATUS_REMOTE_REJECT,
727 REF_STATUS_EXPECTING_REPORT,
728 } status;
729 char *remote_status;
730 struct ref *peer_ref; /* when renaming */
731 char name[FLEX_ARRAY]; /* more */
732 };
733
734 #define REF_NORMAL (1u << 0)
735 #define REF_HEADS (1u << 1)
736 #define REF_TAGS (1u << 2)
737
738 extern struct ref *find_ref_by_name(struct ref *list, const char *name);
739
740 #define CONNECT_VERBOSE (1u << 0)
741 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
742 extern int finish_connect(struct child_process *conn);
743 extern int path_match(const char *path, int nr, char **match);
744 extern int get_ack(int fd, unsigned char *result_sha1);
745 struct extra_have_objects {
746 int nr, alloc;
747 unsigned char (*array)[20];
748 };
749 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
750 extern int server_supports(const char *feature);
751
752 extern struct packed_git *parse_pack_index(unsigned char *sha1);
753
754 extern void prepare_packed_git(void);
755 extern void reprepare_packed_git(void);
756 extern void install_packed_git(struct packed_git *pack);
757
758 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
759 struct packed_git *packs);
760
761 extern void pack_report(void);
762 extern int open_pack_index(struct packed_git *);
763 extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
764 extern void close_pack_windows(struct packed_git *);
765 extern void unuse_pack(struct pack_window **);
766 extern struct packed_git *add_packed_git(const char *, int, int);
767 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
768 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
769 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
770 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
771 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
772 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
773 extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
774 extern int matches_pack_name(struct packed_git *p, const char *name);
775
776 /* Dumb servers support */
777 extern int update_server_info(int);
778
779 typedef int (*config_fn_t)(const char *, const char *, void *);
780 extern int git_default_config(const char *, const char *, void *);
781 extern int git_config_from_file(config_fn_t fn, const char *, void *);
782 extern int git_config(config_fn_t fn, void *);
783 extern int git_parse_ulong(const char *, unsigned long *);
784 extern int git_config_int(const char *, const char *);
785 extern unsigned long git_config_ulong(const char *, const char *);
786 extern int git_config_bool_or_int(const char *, const char *, int *);
787 extern int git_config_bool(const char *, const char *);
788 extern int git_config_string(const char **, const char *, const char *);
789 extern int git_config_set(const char *, const char *);
790 extern int git_config_set_multivar(const char *, const char *, const char *, int);
791 extern int git_config_rename_section(const char *, const char *);
792 extern const char *git_etc_gitconfig(void);
793 extern int check_repository_format_version(const char *var, const char *value, void *cb);
794 extern int git_config_system(void);
795 extern int git_config_global(void);
796 extern int config_error_nonbool(const char *);
797 extern const char *config_exclusive_filename;
798
799 #define MAX_GITNAME (1000)
800 extern char git_default_email[MAX_GITNAME];
801 extern char git_default_name[MAX_GITNAME];
802 extern int user_ident_explicitly_given;
803
804 extern const char *git_commit_encoding;
805 extern const char *git_log_output_encoding;
806
807 /* IO helper functions */
808 extern void maybe_flush_or_die(FILE *, const char *);
809 extern int copy_fd(int ifd, int ofd);
810 extern int copy_file(const char *dst, const char *src, int mode);
811 extern ssize_t read_in_full(int fd, void *buf, size_t count);
812 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
813 extern void write_or_die(int fd, const void *buf, size_t count);
814 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
815 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
816 extern void fsync_or_die(int fd, const char *);
817
818 /* pager.c */
819 extern void setup_pager(void);
820 extern const char *pager_program;
821 extern int pager_in_use(void);
822 extern int pager_use_color;
823
824 extern const char *editor_program;
825 extern const char *excludes_file;
826
827 /* base85 */
828 int decode_85(char *dst, const char *line, int linelen);
829 void encode_85(char *buf, const unsigned char *data, int bytes);
830
831 /* alloc.c */
832 extern void *alloc_blob_node(void);
833 extern void *alloc_tree_node(void);
834 extern void *alloc_commit_node(void);
835 extern void *alloc_tag_node(void);
836 extern void *alloc_object_node(void);
837 extern void alloc_report(void);
838
839 /* trace.c */
840 extern void trace_printf(const char *format, ...);
841 extern void trace_argv_printf(const char **argv, const char *format, ...);
842
843 /* convert.c */
844 /* returns 1 if *dst was used */
845 extern int convert_to_git(const char *path, const char *src, size_t len,
846 struct strbuf *dst, enum safe_crlf checksafe);
847 extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
848
849 /* add */
850 /*
851 * return 0 if success, 1 - if addition of a file failed and
852 * ADD_FILES_IGNORE_ERRORS was specified in flags
853 */
854 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
855
856 /* diff.c */
857 extern int diff_auto_refresh_index;
858
859 /* match-trees.c */
860 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
861
862 /*
863 * whitespace rules.
864 * used by both diff and apply
865 */
866 #define WS_TRAILING_SPACE 01
867 #define WS_SPACE_BEFORE_TAB 02
868 #define WS_INDENT_WITH_NON_TAB 04
869 #define WS_CR_AT_EOL 010
870 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB)
871 extern unsigned whitespace_rule_cfg;
872 extern unsigned whitespace_rule(const char *);
873 extern unsigned parse_whitespace_rule(const char *);
874 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
875 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
876 extern char *whitespace_error_string(unsigned ws);
877 extern int ws_fix_copy(char *, const char *, int, unsigned, int *);
878 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
879
880 /* ls-files */
881 int pathspec_match(const char **spec, char *matched, const char *filename, int skiplen);
882 int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
883 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
884
885 char *alias_lookup(const char *alias);
886 int split_cmdline(char *cmdline, const char ***argv);
887
888 #endif /* CACHE_H */