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