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