Merge branch 'maint'
[git/git.git] / cache.h
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 /*
28 * Intensive research over the course of many years has shown that
29 * port 9418 is totally unused by anything else. Or
30 *
31 * Your search - "port 9418" - did not match any documents.
32 *
33 * as www.google.com puts it.
34 *
35 * This port has been properly assigned for git use by IANA:
36 * git (Assigned-9418) [I06-050728-0001].
37 *
38 * git 9418/tcp git pack transfer service
39 * git 9418/udp git pack transfer service
40 *
41 * with Linus Torvalds <torvalds@osdl.org> as the point of
42 * contact. September 2005.
43 *
44 * See http://www.iana.org/assignments/port-numbers
45 */
46 #define DEFAULT_GIT_PORT 9418
47
48 /*
49 * Basic data structures for the directory cache
50 */
51
52 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
53 struct cache_header {
54 unsigned int hdr_signature;
55 unsigned int hdr_version;
56 unsigned int hdr_entries;
57 };
58
59 /*
60 * The "cache_time" is just the low 32 bits of the
61 * time. It doesn't matter if it overflows - we only
62 * check it for equality in the 32 bits we save.
63 */
64 struct cache_time {
65 unsigned int sec;
66 unsigned int nsec;
67 };
68
69 /*
70 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
71 * Again - this is just a (very strong in practice) heuristic that
72 * the inode hasn't changed.
73 *
74 * We save the fields in big-endian order to allow using the
75 * index file over NFS transparently.
76 */
77 struct cache_entry {
78 struct cache_time ce_ctime;
79 struct cache_time ce_mtime;
80 unsigned int ce_dev;
81 unsigned int ce_ino;
82 unsigned int ce_mode;
83 unsigned int ce_uid;
84 unsigned int ce_gid;
85 unsigned int ce_size;
86 unsigned char sha1[20];
87 unsigned short ce_flags;
88 char name[FLEX_ARRAY]; /* more */
89 };
90
91 #define CE_NAMEMASK (0x0fff)
92 #define CE_STAGEMASK (0x3000)
93 #define CE_UPDATE (0x4000)
94 #define CE_VALID (0x8000)
95 #define CE_STAGESHIFT 12
96
97 #define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
98 #define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
99 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
100 #define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
101
102 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
103 static inline unsigned int create_ce_mode(unsigned int mode)
104 {
105 if (S_ISLNK(mode))
106 return htonl(S_IFLNK);
107 return htonl(S_IFREG | ce_permissions(mode));
108 }
109 #define canon_mode(mode) \
110 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
111 S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
112
113 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
114
115 extern struct cache_entry **active_cache;
116 extern unsigned int active_nr, active_alloc, active_cache_changed;
117 extern struct cache_tree *active_cache_tree;
118 extern int cache_errno;
119
120 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
121 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
122 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
123 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
124 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
125
126 extern int is_bare_git_dir(const char *dir);
127 extern const char *get_git_dir(void);
128 extern char *get_object_directory(void);
129 extern char *get_refs_directory(void);
130 extern char *get_index_file(void);
131 extern char *get_graft_file(void);
132
133 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
134
135 extern const char **get_pathspec(const char *prefix, const char **pathspec);
136 extern const char *setup_git_directory_gently(int *);
137 extern const char *setup_git_directory(void);
138 extern const char *prefix_path(const char *prefix, int len, const char *path);
139 extern const char *prefix_filename(const char *prefix, int len, const char *path);
140 extern void verify_filename(const char *prefix, const char *name);
141 extern void verify_non_filename(const char *prefix, const char *name);
142
143 #define alloc_nr(x) (((x)+16)*3/2)
144
145 /* Initialize and use the cache information */
146 extern int read_cache(void);
147 extern int read_cache_from(const char *path);
148 extern int write_cache(int newfd, struct cache_entry **cache, int entries);
149 extern int discard_cache(void);
150 extern int verify_path(const char *path);
151 extern int cache_name_pos(const char *name, int namelen);
152 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
153 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
154 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
155 extern int add_cache_entry(struct cache_entry *ce, int option);
156 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
157 extern int remove_cache_entry_at(int pos);
158 extern int remove_file_from_cache(const char *path);
159 extern int add_file_to_index(const char *path, int verbose);
160 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
161 extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
162 extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
163 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
164 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
165 extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
166 extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
167 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
168 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
169
170 #define REFRESH_REALLY 0x0001 /* ignore_valid */
171 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
172 #define REFRESH_QUIET 0x0004 /* be quiet about it */
173 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
174 extern int refresh_cache(unsigned int flags);
175
176 struct lock_file {
177 struct lock_file *next;
178 char filename[PATH_MAX];
179 };
180 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
181 extern int commit_lock_file(struct lock_file *);
182 extern void rollback_lock_file(struct lock_file *);
183 extern int delete_ref(const char *, unsigned char *sha1);
184
185 /* Environment bits from configuration mechanism */
186 extern int use_legacy_headers;
187 extern int trust_executable_bit;
188 extern int assume_unchanged;
189 extern int prefer_symlink_refs;
190 extern int log_all_ref_updates;
191 extern int warn_ambiguous_refs;
192 extern int shared_repository;
193 extern const char *apply_default_whitespace;
194 extern int zlib_compression_level;
195
196 #define GIT_REPO_VERSION 0
197 extern int repository_format_version;
198 extern int check_repository_format(void);
199
200 #define MTIME_CHANGED 0x0001
201 #define CTIME_CHANGED 0x0002
202 #define OWNER_CHANGED 0x0004
203 #define MODE_CHANGED 0x0008
204 #define INODE_CHANGED 0x0010
205 #define DATA_CHANGED 0x0020
206 #define TYPE_CHANGED 0x0040
207
208 /* Return a statically allocated filename matching the sha1 signature */
209 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
210 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
211 extern char *sha1_file_name(const unsigned char *sha1);
212 extern char *sha1_pack_name(const unsigned char *sha1);
213 extern char *sha1_pack_index_name(const unsigned char *sha1);
214 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
215 extern const unsigned char null_sha1[20];
216 static inline int is_null_sha1(const unsigned char *sha1)
217 {
218 return !memcmp(sha1, null_sha1, 20);
219 }
220 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
221 {
222 return memcmp(sha1, sha2, 20);
223 }
224 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
225 {
226 memcpy(sha_dst, sha_src, 20);
227 }
228 static inline void hashclr(unsigned char *hash)
229 {
230 memset(hash, 0, 20);
231 }
232
233 int git_mkstemp(char *path, size_t n, const char *template);
234
235 enum sharedrepo {
236 PERM_UMASK = 0,
237 PERM_GROUP,
238 PERM_EVERYBODY
239 };
240 int git_config_perm(const char *var, const char *value);
241 int adjust_shared_perm(const char *path);
242 int safe_create_leading_directories(char *path);
243 char *enter_repo(char *path, int strict);
244
245 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
246 extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
247 extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
248 extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
249 extern int hash_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *sha1);
250 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
251
252 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
253
254 extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
255 size_t bufsize, size_t *bufposn);
256 extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
257 extern int move_temp_to_file(const char *tmpfile, const char *filename);
258
259 extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
260 extern int has_sha1_file(const unsigned char *sha1);
261 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *);
262 extern int legacy_loose_object(unsigned char *);
263
264 extern int has_pack_file(const unsigned char *sha1);
265 extern int has_pack_index(const unsigned char *sha1);
266
267 enum object_type {
268 OBJ_NONE = 0,
269 OBJ_COMMIT = 1,
270 OBJ_TREE = 2,
271 OBJ_BLOB = 3,
272 OBJ_TAG = 4,
273 /* 5 for future expansion */
274 OBJ_OFS_DELTA = 6,
275 OBJ_REF_DELTA = 7,
276 OBJ_BAD,
277 };
278
279 extern signed char hexval_table[256];
280 static inline unsigned int hexval(unsigned int c)
281 {
282 return hexval_table[c];
283 }
284
285 /* Convert to/from hex/sha1 representation */
286 #define MINIMUM_ABBREV 4
287 #define DEFAULT_ABBREV 7
288
289 extern int get_sha1(const char *str, unsigned char *sha1);
290 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
291 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
292 extern int read_ref(const char *filename, unsigned char *sha1);
293 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
294 extern int create_symref(const char *ref, const char *refs_heads_master);
295 extern int validate_symref(const char *ref);
296
297 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
298 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
299
300 extern void *read_object_with_reference(const unsigned char *sha1,
301 const char *required_type,
302 unsigned long *size,
303 unsigned char *sha1_ret);
304
305 const char *show_date(unsigned long time, int timezone, int relative);
306 const char *show_rfc2822_date(unsigned long time, int timezone);
307 int parse_date(const char *date, char *buf, int bufsize);
308 void datestamp(char *buf, int bufsize);
309 unsigned long approxidate(const char *);
310
311 extern int setup_ident(void);
312 extern void ignore_missing_committer_name();
313 extern const char *git_author_info(int);
314 extern const char *git_committer_info(int);
315
316 struct checkout {
317 const char *base_dir;
318 int base_dir_len;
319 unsigned force:1,
320 quiet:1,
321 not_new:1,
322 refresh_cache:1;
323 };
324
325 extern int checkout_entry(struct cache_entry *ce, struct checkout *state, char *topath);
326
327 extern struct alternate_object_database {
328 struct alternate_object_database *next;
329 char *name;
330 char base[FLEX_ARRAY]; /* more */
331 } *alt_odb_list;
332 extern void prepare_alt_odb(void);
333
334 extern struct packed_git {
335 struct packed_git *next;
336 unsigned long index_size;
337 unsigned long pack_size;
338 unsigned int *index_base;
339 void *pack_base;
340 unsigned int pack_last_used;
341 unsigned int pack_use_cnt;
342 int pack_local;
343 unsigned char sha1[20];
344 /* something like ".git/objects/pack/xxxxx.pack" */
345 char pack_name[FLEX_ARRAY]; /* more */
346 } *packed_git;
347
348 struct pack_entry {
349 unsigned int offset;
350 unsigned char sha1[20];
351 struct packed_git *p;
352 };
353
354 struct ref {
355 struct ref *next;
356 unsigned char old_sha1[20];
357 unsigned char new_sha1[20];
358 unsigned char force;
359 struct ref *peer_ref; /* when renaming */
360 char name[FLEX_ARRAY]; /* more */
361 };
362
363 #define REF_NORMAL (1u << 0)
364 #define REF_HEADS (1u << 1)
365 #define REF_TAGS (1u << 2)
366
367 extern pid_t git_connect(int fd[2], char *url, const char *prog);
368 extern int finish_connect(pid_t pid);
369 extern int path_match(const char *path, int nr, char **match);
370 extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
371 int nr_refspec, char **refspec, int all);
372 extern int get_ack(int fd, unsigned char *result_sha1);
373 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
374 extern int server_supports(const char *feature);
375
376 extern struct packed_git *parse_pack_index(unsigned char *sha1);
377 extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
378 char *idx_path);
379
380 extern void prepare_packed_git(void);
381 extern void reprepare_packed_git(void);
382 extern void install_packed_git(struct packed_git *pack);
383
384 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
385 struct packed_git *packs);
386
387 extern int use_packed_git(struct packed_git *);
388 extern void unuse_packed_git(struct packed_git *);
389 extern struct packed_git *add_packed_git(char *, int, int);
390 extern int num_packed_objects(const struct packed_git *p);
391 extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
392 extern unsigned long find_pack_entry_one(const unsigned char *, struct packed_git *);
393 extern void *unpack_entry_gently(struct packed_git *, unsigned long, char *, unsigned long *);
394 extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
395 extern void packed_object_info_detail(struct packed_git *, unsigned long, char *, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
396
397 /* Dumb servers support */
398 extern int update_server_info(int);
399
400 typedef int (*config_fn_t)(const char *, const char *);
401 extern int git_default_config(const char *, const char *);
402 extern int git_config_from_file(config_fn_t fn, const char *);
403 extern int git_config(config_fn_t fn);
404 extern int git_config_int(const char *, const char *);
405 extern int git_config_bool(const char *, const char *);
406 extern int git_config_set(const char *, const char *);
407 extern int git_config_set_multivar(const char *, const char *, const char *, int);
408 extern int git_config_rename_section(const char *, const char *);
409 extern int check_repository_format_version(const char *var, const char *value);
410
411 #define MAX_GITNAME (1000)
412 extern char git_default_email[MAX_GITNAME];
413 extern char git_default_name[MAX_GITNAME];
414
415 #define MAX_ENCODING_LENGTH 64
416 extern char git_commit_encoding[MAX_ENCODING_LENGTH];
417
418 extern int copy_fd(int ifd, int ofd);
419 extern void write_or_die(int fd, const void *buf, size_t count);
420 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
421
422 /* pager.c */
423 extern void setup_pager(void);
424 extern int pager_in_use;
425 extern int pager_use_color;
426
427 /* base85 */
428 int decode_85(char *dst, char *line, int linelen);
429 void encode_85(char *buf, unsigned char *data, int bytes);
430
431 /* alloc.c */
432 struct blob;
433 struct tree;
434 struct commit;
435 struct tag;
436 extern struct blob *alloc_blob_node(void);
437 extern struct tree *alloc_tree_node(void);
438 extern struct commit *alloc_commit_node(void);
439 extern struct tag *alloc_tag_node(void);
440 extern void alloc_report(void);
441
442 /* trace.c */
443 extern int nfvasprintf(char **str, const char *fmt, va_list va);
444 extern void trace_printf(const char *format, ...);
445 extern void trace_argv_printf(const char **argv, int count, const char *format, ...);
446
447 #endif /* CACHE_H */