1#ifndef CACHE_H
2#define CACHE_H
3
4#include "git-compat-util.h"
5
6#include SHA1_HEADER
7#include <zlib.h>
8
9#if ZLIB_VERNUM < 0x1200
10#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
11#endif
12
13#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
14#define DTYPE(de) ((de)->d_type)
15#else
16#undef DT_UNKNOWN
17#undef DT_DIR
18#undef DT_REG
19#undef DT_LNK
20#define DT_UNKNOWN 0
21#define DT_DIR 1
22#define DT_REG 2
23#define DT_LNK 3
24#define DTYPE(de) DT_UNKNOWN
25#endif
26
27/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
28#define S_IFINVALID 0030000
29
30/*
31 * A "directory link" is a link to another git directory.
32 *
33 * The value 0160000 is not normally a valid mode, and
34 * also just happens to be S_IFDIR + S_IFLNK
35 *
36 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
37 * always having the same values everywhere. We should use
38 * our internal git values for these things, and then we can
39 * translate that to the OS-specific value. It just so
40 * happens that everybody shares the same bit representation
41 * in the UNIX world (and apparently wider too..)
42 */
43#define S_IFGITLINK 0160000
44#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
45
46/*
47 * Intensive research over the course of many years has shown that
48 * port 9418 is totally unused by anything else. Or
49 *
50 * Your search - "port 9418" - did not match any documents.
51 *
52 * as www.google.com puts it.
53 *
54 * This port has been properly assigned for git use by IANA:
55 * git (Assigned-9418) [I06-050728-0001].
56 *
57 * git 9418/tcp git pack transfer service
58 * git 9418/udp git pack transfer service
59 *
60 * with Linus Torvalds <torvalds@osdl.org> as the point of
61 * contact. September 2005.
62 *
63 * See http://www.iana.org/assignments/port-numbers
64 */
65#define DEFAULT_GIT_PORT 9418
66
67/*
68 * Basic data structures for the directory cache
69 */
70
71#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
72struct cache_header {
73 unsigned int hdr_signature;
74 unsigned int hdr_version;
75 unsigned int hdr_entries;
76};
77
78/*
79 * The "cache_time" is just the low 32 bits of the
80 * time. It doesn't matter if it overflows - we only
81 * check it for equality in the 32 bits we save.
82 */
83struct cache_time {
84 unsigned int sec;
85 unsigned int nsec;
86};
87
88/*
89 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
90 * Again - this is just a (very strong in practice) heuristic that
91 * the inode hasn't changed.
92 *
93 * We save the fields in big-endian order to allow using the
94 * index file over NFS transparently.
95 */
96struct cache_entry {
97 struct cache_time ce_ctime;
98 struct cache_time ce_mtime;
99 unsigned int ce_dev;
100 unsigned int ce_ino;
101 unsigned int ce_mode;
102 unsigned int ce_uid;
103 unsigned int ce_gid;
104 unsigned int ce_size;
105 unsigned char sha1[20];
106 unsigned short ce_flags;
107 char name[FLEX_ARRAY]; /* more */
108};
109
110#define CE_NAMEMASK (0x0fff)
111#define CE_STAGEMASK (0x3000)
112#define CE_UPDATE (0x4000)
113#define CE_VALID (0x8000)
114#define CE_STAGESHIFT 12
115
116#define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
117#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
118#define ce_size(ce) cache_entry_size(ce_namelen(ce))
119#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
120
121#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
122static inline unsigned int create_ce_mode(unsigned int mode)
123{
124 if (S_ISLNK(mode))
125 return htonl(S_IFLNK);
126 if (S_ISDIR(mode) || S_ISGITLINK(mode))
127 return htonl(S_IFGITLINK);
128 return htonl(S_IFREG | ce_permissions(mode));
129}
130static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
131{
132 extern int trust_executable_bit, has_symlinks;
133 if (!has_symlinks && S_ISREG(mode) &&
134 ce && S_ISLNK(ntohl(ce->ce_mode)))
135 return ce->ce_mode;
136 if (!trust_executable_bit && S_ISREG(mode)) {
137 if (ce && S_ISREG(ntohl(ce->ce_mode)))
138 return ce->ce_mode;
139 return create_ce_mode(0666);
140 }
141 return create_ce_mode(mode);
142}
143#define canon_mode(mode) \
144 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
145 S_ISLNK(mode) ? S_IFLNK : S_ISDIR(mode) ? S_IFDIR : S_IFGITLINK)
146
147#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
148
149struct index_state {
150 struct cache_entry **cache;
151 unsigned int cache_nr, cache_alloc, cache_changed;
152 struct cache_tree *cache_tree;
153 time_t timestamp;
154 void *mmap;
155 size_t mmap_size;
156};
157
158extern struct index_state the_index;
159
160#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
161#define active_cache (the_index.cache)
162#define active_nr (the_index.cache_nr)
163#define active_alloc (the_index.cache_alloc)
164#define active_cache_changed (the_index.cache_changed)
165#define active_cache_tree (the_index.cache_tree)
166
167#define read_cache() read_index(&the_index)
168#define read_cache_from(path) read_index_from(&the_index, (path))
169#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
170#define discard_cache() discard_index(&the_index)
171#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
172#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
173#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
174#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
175#define add_file_to_cache(path, verbose) add_file_to_index(&the_index, (path), (verbose))
176#define refresh_cache(flags) refresh_index(&the_index, flags)
177#define ce_match_stat(ce, st, really) ie_match_stat(&the_index, (ce), (st), (really))
178#define ce_modified(ce, st, really) ie_modified(&the_index, (ce), (st), (really))
179#endif
180
181enum object_type {
182 OBJ_BAD = -1,
183 OBJ_NONE = 0,
184 OBJ_COMMIT = 1,
185 OBJ_TREE = 2,
186 OBJ_BLOB = 3,
187 OBJ_TAG = 4,
188 /* 5 for future expansion */
189 OBJ_OFS_DELTA = 6,
190 OBJ_REF_DELTA = 7,
191 OBJ_MAX,
192};
193
194#define GIT_DIR_ENVIRONMENT "GIT_DIR"
195#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
196#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
197#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
198#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
199#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
200#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
201#define CONFIG_ENVIRONMENT "GIT_CONFIG"
202#define CONFIG_LOCAL_ENVIRONMENT "GIT_CONFIG_LOCAL"
203#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
204#define GITATTRIBUTES_FILE ".gitattributes"
205#define INFOATTRIBUTES_FILE "info/attributes"
206#define ATTRIBUTE_MACRO_PREFIX "[attr]"
207
208extern int is_bare_repository_cfg;
209extern int is_bare_repository(void);
210extern int is_inside_git_dir(void);
211extern int is_inside_work_tree(void);
212extern const char *get_git_dir(void);
213extern char *get_object_directory(void);
214extern char *get_refs_directory(void);
215extern char *get_index_file(void);
216extern char *get_graft_file(void);
217
218#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
219
220extern const char **get_pathspec(const char *prefix, const char **pathspec);
221extern const char *setup_git_directory_gently(int *);
222extern const char *setup_git_directory(void);
223extern const char *prefix_path(const char *prefix, int len, const char *path);
224extern const char *prefix_filename(const char *prefix, int len, const char *path);
225extern void verify_filename(const char *prefix, const char *name);
226extern void verify_non_filename(const char *prefix, const char *name);
227
228#define alloc_nr(x) (((x)+16)*3/2)
229
230/*
231 * Realloc the buffer pointed at by variable 'x' so that it can hold
232 * at least 'nr' entries; the number of entries currently allocated
233 * is 'alloc', using the standard growing factor alloc_nr() macro.
234 *
235 * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
236 */
237#define ALLOC_GROW(x, nr, alloc) \
238 do { \
239 if ((nr) > alloc) { \
240 if (alloc_nr(alloc) < (nr)) \
241 alloc = (nr); \
242 else \
243 alloc = alloc_nr(alloc); \
244 x = xrealloc((x), alloc * sizeof(*(x))); \
245 } \
246 } while(0)
247
248/* Initialize and use the cache information */
249extern int read_index(struct index_state *);
250extern int read_index_from(struct index_state *, const char *path);
251extern int write_index(struct index_state *, int newfd);
252extern int discard_index(struct index_state *);
253extern int verify_path(const char *path);
254extern int index_name_pos(struct index_state *, const char *name, int namelen);
255#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
256#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
257#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
258extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
259extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
260extern int remove_index_entry_at(struct index_state *, int pos);
261extern int remove_file_from_index(struct index_state *, const char *path);
262extern int add_file_to_index(struct index_state *, const char *path, int verbose);
263extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
264extern int ie_match_stat(struct index_state *, struct cache_entry *, struct stat *, int);
265extern int ie_modified(struct index_state *, struct cache_entry *, struct stat *, int);
266extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
267extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
268extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
269extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
270extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
271extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
272
273#define REFRESH_REALLY 0x0001 /* ignore_valid */
274#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
275#define REFRESH_QUIET 0x0004 /* be quiet about it */
276#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
277extern int refresh_index(struct index_state *, unsigned int flags);
278
279struct lock_file {
280 struct lock_file *next;
281 pid_t owner;
282 char on_list;
283 char filename[PATH_MAX];
284};
285extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
286extern int commit_lock_file(struct lock_file *);
287
288extern int hold_locked_index(struct lock_file *, int);
289extern int commit_locked_index(struct lock_file *);
290extern void set_alternate_index_output(const char *);
291
292extern void rollback_lock_file(struct lock_file *);
293extern int delete_ref(const char *, const unsigned char *sha1);
294
295/* Environment bits from configuration mechanism */
296extern int trust_executable_bit;
297extern int has_symlinks;
298extern int assume_unchanged;
299extern int prefer_symlink_refs;
300extern int log_all_ref_updates;
301extern int warn_ambiguous_refs;
302extern int shared_repository;
303extern const char *apply_default_whitespace;
304extern int zlib_compression_level;
305extern int core_compression_level;
306extern int core_compression_seen;
307extern size_t packed_git_window_size;
308extern size_t packed_git_limit;
309extern size_t delta_base_cache_limit;
310extern int auto_crlf;
311
312#define GIT_REPO_VERSION 0
313extern int repository_format_version;
314extern int check_repository_format(void);
315
316#define MTIME_CHANGED 0x0001
317#define CTIME_CHANGED 0x0002
318#define OWNER_CHANGED 0x0004
319#define MODE_CHANGED 0x0008
320#define INODE_CHANGED 0x0010
321#define DATA_CHANGED 0x0020
322#define TYPE_CHANGED 0x0040
323
324/* Return a statically allocated filename matching the sha1 signature */
325extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
326extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
327extern char *sha1_file_name(const unsigned char *sha1);
328extern char *sha1_pack_name(const unsigned char *sha1);
329extern char *sha1_pack_index_name(const unsigned char *sha1);
330extern const char *find_unique_abbrev(const unsigned char *sha1, int);
331extern const unsigned char null_sha1[20];
332static inline int is_null_sha1(const unsigned char *sha1)
333{
334 return !memcmp(sha1, null_sha1, 20);
335}
336static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
337{
338 return memcmp(sha1, sha2, 20);
339}
340static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
341{
342 memcpy(sha_dst, sha_src, 20);
343}
344static inline void hashclr(unsigned char *hash)
345{
346 memset(hash, 0, 20);
347}
348
349int git_mkstemp(char *path, size_t n, const char *template);
350
351enum sharedrepo {
352 PERM_UMASK = 0,
353 PERM_GROUP,
354 PERM_EVERYBODY
355};
356int git_config_perm(const char *var, const char *value);
357int adjust_shared_perm(const char *path);
358int safe_create_leading_directories(char *path);
359char *enter_repo(char *path, int strict);
360
361/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
362extern int sha1_object_info(const unsigned char *, unsigned long *);
363extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
364extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
365extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
366extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
367
368extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
369
370extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
371 size_t bufsize, size_t *bufposn);
372extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
373extern int move_temp_to_file(const char *tmpfile, const char *filename);
374
375extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
376extern int has_sha1_file(const unsigned char *sha1);
377
378extern int has_pack_file(const unsigned char *sha1);
379extern int has_pack_index(const unsigned char *sha1);
380
381extern const signed char hexval_table[256];
382static inline unsigned int hexval(unsigned char c)
383{
384 return hexval_table[c];
385}
386
387/* Convert to/from hex/sha1 representation */
388#define MINIMUM_ABBREV 4
389#define DEFAULT_ABBREV 7
390
391extern int get_sha1(const char *str, unsigned char *sha1);
392extern int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode);
393extern int get_sha1_hex(const char *hex, unsigned char *sha1);
394extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
395extern int read_ref(const char *filename, unsigned char *sha1);
396extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
397extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
398extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
399
400extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
401extern int validate_headref(const char *ref);
402
403extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
404extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
405
406extern void *read_object_with_reference(const unsigned char *sha1,
407 const char *required_type,
408 unsigned long *size,
409 unsigned char *sha1_ret);
410
411enum date_mode { DATE_NORMAL = 0, DATE_RELATIVE, DATE_SHORT, DATE_LOCAL };
412const char *show_date(unsigned long time, int timezone, enum date_mode mode);
413const char *show_rfc2822_date(unsigned long time, int timezone);
414int parse_date(const char *date, char *buf, int bufsize);
415void datestamp(char *buf, int bufsize);
416unsigned long approxidate(const char *);
417
418extern const char *git_author_info(int);
419extern const char *git_committer_info(int);
420extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
421
422struct checkout {
423 const char *base_dir;
424 int base_dir_len;
425 unsigned force:1,
426 quiet:1,
427 not_new:1,
428 refresh_cache:1;
429};
430
431extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
432extern int has_symlink_leading_path(const char *name, char *last_symlink);
433
434extern struct alternate_object_database {
435 struct alternate_object_database *next;
436 char *name;
437 char base[FLEX_ARRAY]; /* more */
438} *alt_odb_list;
439extern void prepare_alt_odb(void);
440
441struct pack_window {
442 struct pack_window *next;
443 unsigned char *base;
444 off_t offset;
445 size_t len;
446 unsigned int last_used;
447 unsigned int inuse_cnt;
448};
449
450extern struct packed_git {
451 struct packed_git *next;
452 struct pack_window *windows;
453 off_t pack_size;
454 const void *index_data;
455 size_t index_size;
456 uint32_t num_objects;
457 int index_version;
458 time_t mtime;
459 int pack_fd;
460 int pack_local;
461 unsigned char sha1[20];
462 /* something like ".git/objects/pack/xxxxx.pack" */
463 char pack_name[FLEX_ARRAY]; /* more */
464} *packed_git;
465
466struct pack_entry {
467 off_t offset;
468 unsigned char sha1[20];
469 struct packed_git *p;
470};
471
472struct ref {
473 struct ref *next;
474 unsigned char old_sha1[20];
475 unsigned char new_sha1[20];
476 unsigned char force;
477 struct ref *peer_ref; /* when renaming */
478 char name[FLEX_ARRAY]; /* more */
479};
480
481#define REF_NORMAL (1u << 0)
482#define REF_HEADS (1u << 1)
483#define REF_TAGS (1u << 2)
484
485#define CONNECT_VERBOSE (1u << 0)
486extern pid_t git_connect(int fd[2], char *url, const char *prog, int flags);
487extern int finish_connect(pid_t pid);
488extern int path_match(const char *path, int nr, char **match);
489extern int get_ack(int fd, unsigned char *result_sha1);
490extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
491extern int server_supports(const char *feature);
492
493extern struct packed_git *parse_pack_index(unsigned char *sha1);
494extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
495 const char *idx_path);
496
497extern void prepare_packed_git(void);
498extern void reprepare_packed_git(void);
499extern void install_packed_git(struct packed_git *pack);
500
501extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
502 struct packed_git *packs);
503
504extern void pack_report(void);
505extern int open_pack_index(struct packed_git *);
506extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
507extern void unuse_pack(struct pack_window **);
508extern struct packed_git *add_packed_git(const char *, int, int);
509extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
510extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
511extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
512extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
513extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
514extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
515
516/* Dumb servers support */
517extern int update_server_info(int);
518
519typedef int (*config_fn_t)(const char *, const char *);
520extern int git_default_config(const char *, const char *);
521extern int git_config_from_file(config_fn_t fn, const char *);
522extern int git_config(config_fn_t fn);
523extern int git_config_int(const char *, const char *);
524extern int git_config_bool(const char *, const char *);
525extern int git_config_set(const char *, const char *);
526extern int git_config_set_multivar(const char *, const char *, const char *, int);
527extern int git_config_rename_section(const char *, const char *);
528extern int check_repository_format_version(const char *var, const char *value);
529
530#define MAX_GITNAME (1000)
531extern char git_default_email[MAX_GITNAME];
532extern char git_default_name[MAX_GITNAME];
533
534extern const char *git_commit_encoding;
535extern const char *git_log_output_encoding;
536
537/* IO helper functions */
538extern void maybe_flush_or_die(FILE *, const char *);
539extern int copy_fd(int ifd, int ofd);
540extern int read_in_full(int fd, void *buf, size_t count);
541extern int write_in_full(int fd, const void *buf, size_t count);
542extern void write_or_die(int fd, const void *buf, size_t count);
543extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
544extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
545
546/* pager.c */
547extern void setup_pager(void);
548extern int pager_in_use;
549extern int pager_use_color;
550
551/* base85 */
552int decode_85(char *dst, const char *line, int linelen);
553void encode_85(char *buf, const unsigned char *data, int bytes);
554
555/* alloc.c */
556extern void *alloc_blob_node(void);
557extern void *alloc_tree_node(void);
558extern void *alloc_commit_node(void);
559extern void *alloc_tag_node(void);
560extern void *alloc_object_node(void);
561extern void alloc_report(void);
562
563/* trace.c */
564extern int nfasprintf(char **str, const char *fmt, ...);
565extern int nfvasprintf(char **str, const char *fmt, va_list va);
566extern void trace_printf(const char *format, ...);
567extern void trace_argv_printf(const char **argv, int count, const char *format, ...);
568
569/* convert.c */
570extern char *convert_to_git(const char *path, const char *src, unsigned long *sizep);
571extern char *convert_to_working_tree(const char *path, const char *src, unsigned long *sizep);
572extern void *convert_sha1_file(const char *path, const unsigned char *sha1, unsigned int mode, enum object_type *type, unsigned long *size);
573
574/* match-trees.c */
575void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
576
577#endif /* CACHE_H */