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