_GIT_INDEX_OUTPUT: allow plumbing to output to an alternative index file.
[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 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
110 {
111 extern int trust_executable_bit, has_symlinks;
112 if (!has_symlinks && S_ISREG(mode) &&
113 ce && S_ISLNK(ntohl(ce->ce_mode)))
114 return ce->ce_mode;
115 if (!trust_executable_bit && S_ISREG(mode)) {
116 if (ce && S_ISREG(ntohl(ce->ce_mode)))
117 return ce->ce_mode;
118 return create_ce_mode(0666);
119 }
120 return create_ce_mode(mode);
121 }
122 #define canon_mode(mode) \
123 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
124 S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
125
126 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
127
128 extern struct cache_entry **active_cache;
129 extern unsigned int active_nr, active_alloc, active_cache_changed;
130 extern struct cache_tree *active_cache_tree;
131 extern int cache_errno;
132
133 enum object_type {
134 OBJ_BAD = -1,
135 OBJ_NONE = 0,
136 OBJ_COMMIT = 1,
137 OBJ_TREE = 2,
138 OBJ_BLOB = 3,
139 OBJ_TAG = 4,
140 /* 5 for future expansion */
141 OBJ_OFS_DELTA = 6,
142 OBJ_REF_DELTA = 7,
143 OBJ_MAX,
144 };
145
146 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
147 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
148 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
149 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
150 #define INDEX_OUTPUT_ENVIRONMENT "_GIT_INDEX_OUTPUT"
151 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
152 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
153 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
154 #define CONFIG_LOCAL_ENVIRONMENT "GIT_CONFIG_LOCAL"
155 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
156
157 extern int is_bare_repository_cfg;
158 extern int is_bare_repository(void);
159 extern int is_inside_git_dir(void);
160 extern const char *get_git_dir(void);
161 extern char *get_object_directory(void);
162 extern char *get_refs_directory(void);
163 extern char *get_index_file(void);
164 extern char *get_graft_file(void);
165
166 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
167
168 extern const char **get_pathspec(const char *prefix, const char **pathspec);
169 extern const char *setup_git_directory_gently(int *);
170 extern const char *setup_git_directory(void);
171 extern const char *prefix_path(const char *prefix, int len, const char *path);
172 extern const char *prefix_filename(const char *prefix, int len, const char *path);
173 extern void verify_filename(const char *prefix, const char *name);
174 extern void verify_non_filename(const char *prefix, const char *name);
175
176 #define alloc_nr(x) (((x)+16)*3/2)
177
178 /* Initialize and use the cache information */
179 extern int read_cache(void);
180 extern int read_cache_from(const char *path);
181 extern int write_cache(int newfd, struct cache_entry **cache, int entries);
182 extern int discard_cache(void);
183 extern int verify_path(const char *path);
184 extern int cache_name_pos(const char *name, int namelen);
185 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
186 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
187 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
188 extern int add_cache_entry(struct cache_entry *ce, int option);
189 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
190 extern int remove_cache_entry_at(int pos);
191 extern int remove_file_from_cache(const char *path);
192 extern int add_file_to_index(const char *path, int verbose);
193 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
194 extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
195 extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
196 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
197 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
198 extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
199 extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
200 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
201 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
202
203 #define REFRESH_REALLY 0x0001 /* ignore_valid */
204 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
205 #define REFRESH_QUIET 0x0004 /* be quiet about it */
206 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
207 extern int refresh_cache(unsigned int flags);
208
209 struct lock_file {
210 struct lock_file *next;
211 char on_list;
212 char filename[PATH_MAX];
213 };
214 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
215 extern int commit_lock_file(struct lock_file *);
216
217 extern int hold_locked_index(struct lock_file *, int);
218 extern int commit_locked_index(struct lock_file *);
219
220 extern void rollback_lock_file(struct lock_file *);
221 extern int delete_ref(const char *, unsigned char *sha1);
222
223 /* Environment bits from configuration mechanism */
224 extern int use_legacy_headers;
225 extern int trust_executable_bit;
226 extern int has_symlinks;
227 extern int assume_unchanged;
228 extern int prefer_symlink_refs;
229 extern int log_all_ref_updates;
230 extern int warn_ambiguous_refs;
231 extern int shared_repository;
232 extern const char *apply_default_whitespace;
233 extern int zlib_compression_level;
234 extern size_t packed_git_window_size;
235 extern size_t packed_git_limit;
236 extern size_t delta_base_cache_limit;
237 extern int auto_crlf;
238
239 #define GIT_REPO_VERSION 0
240 extern int repository_format_version;
241 extern int check_repository_format(void);
242
243 #define MTIME_CHANGED 0x0001
244 #define CTIME_CHANGED 0x0002
245 #define OWNER_CHANGED 0x0004
246 #define MODE_CHANGED 0x0008
247 #define INODE_CHANGED 0x0010
248 #define DATA_CHANGED 0x0020
249 #define TYPE_CHANGED 0x0040
250
251 /* Return a statically allocated filename matching the sha1 signature */
252 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
253 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
254 extern char *sha1_file_name(const unsigned char *sha1);
255 extern char *sha1_pack_name(const unsigned char *sha1);
256 extern char *sha1_pack_index_name(const unsigned char *sha1);
257 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
258 extern const unsigned char null_sha1[20];
259 static inline int is_null_sha1(const unsigned char *sha1)
260 {
261 return !memcmp(sha1, null_sha1, 20);
262 }
263 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
264 {
265 return memcmp(sha1, sha2, 20);
266 }
267 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
268 {
269 memcpy(sha_dst, sha_src, 20);
270 }
271 static inline void hashclr(unsigned char *hash)
272 {
273 memset(hash, 0, 20);
274 }
275
276 int git_mkstemp(char *path, size_t n, const char *template);
277
278 enum sharedrepo {
279 PERM_UMASK = 0,
280 PERM_GROUP,
281 PERM_EVERYBODY
282 };
283 int git_config_perm(const char *var, const char *value);
284 int adjust_shared_perm(const char *path);
285 int safe_create_leading_directories(char *path);
286 char *enter_repo(char *path, int strict);
287
288 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
289 extern int sha1_object_info(const unsigned char *, unsigned long *);
290 extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
291 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
292 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
293 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
294
295 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
296
297 extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
298 size_t bufsize, size_t *bufposn);
299 extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
300 extern int move_temp_to_file(const char *tmpfile, const char *filename);
301
302 extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
303 extern int has_sha1_file(const unsigned char *sha1);
304 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *);
305 extern int legacy_loose_object(unsigned char *);
306
307 extern int has_pack_file(const unsigned char *sha1);
308 extern int has_pack_index(const unsigned char *sha1);
309
310 extern signed char hexval_table[256];
311 static inline unsigned int hexval(unsigned int c)
312 {
313 return hexval_table[c];
314 }
315
316 /* Convert to/from hex/sha1 representation */
317 #define MINIMUM_ABBREV 4
318 #define DEFAULT_ABBREV 7
319
320 extern int get_sha1(const char *str, unsigned char *sha1);
321 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
322 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
323 extern int read_ref(const char *filename, unsigned char *sha1);
324 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
325 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
326 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
327
328 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
329 extern int validate_headref(const char *ref);
330
331 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
332 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
333
334 extern void *read_object_with_reference(const unsigned char *sha1,
335 const char *required_type,
336 unsigned long *size,
337 unsigned char *sha1_ret);
338
339 enum date_mode { DATE_NORMAL = 0, DATE_RELATIVE, DATE_SHORT };
340 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
341 const char *show_rfc2822_date(unsigned long time, int timezone);
342 int parse_date(const char *date, char *buf, int bufsize);
343 void datestamp(char *buf, int bufsize);
344 unsigned long approxidate(const char *);
345
346 extern const char *git_author_info(int);
347 extern const char *git_committer_info(int);
348 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
349
350 struct checkout {
351 const char *base_dir;
352 int base_dir_len;
353 unsigned force:1,
354 quiet:1,
355 not_new:1,
356 refresh_cache:1;
357 };
358
359 extern int checkout_entry(struct cache_entry *ce, struct checkout *state, char *topath);
360
361 extern struct alternate_object_database {
362 struct alternate_object_database *next;
363 char *name;
364 char base[FLEX_ARRAY]; /* more */
365 } *alt_odb_list;
366 extern void prepare_alt_odb(void);
367
368 struct pack_window {
369 struct pack_window *next;
370 unsigned char *base;
371 off_t offset;
372 size_t len;
373 unsigned int last_used;
374 unsigned int inuse_cnt;
375 };
376
377 extern struct packed_git {
378 struct packed_git *next;
379 struct pack_window *windows;
380 const void *index_data;
381 off_t index_size;
382 off_t pack_size;
383 time_t mtime;
384 int index_version;
385 int pack_fd;
386 int pack_local;
387 unsigned char sha1[20];
388 /* something like ".git/objects/pack/xxxxx.pack" */
389 char pack_name[FLEX_ARRAY]; /* more */
390 } *packed_git;
391
392 struct pack_entry {
393 off_t offset;
394 unsigned char sha1[20];
395 struct packed_git *p;
396 };
397
398 struct ref {
399 struct ref *next;
400 unsigned char old_sha1[20];
401 unsigned char new_sha1[20];
402 unsigned char force;
403 struct ref *peer_ref; /* when renaming */
404 char name[FLEX_ARRAY]; /* more */
405 };
406
407 #define REF_NORMAL (1u << 0)
408 #define REF_HEADS (1u << 1)
409 #define REF_TAGS (1u << 2)
410
411 extern pid_t git_connect(int fd[2], char *url, const char *prog);
412 extern int finish_connect(pid_t pid);
413 extern int path_match(const char *path, int nr, char **match);
414 extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
415 int nr_refspec, char **refspec, int all);
416 extern int get_ack(int fd, unsigned char *result_sha1);
417 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
418 extern int server_supports(const char *feature);
419
420 extern struct packed_git *parse_pack_index(unsigned char *sha1);
421 extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
422 const char *idx_path);
423
424 extern void prepare_packed_git(void);
425 extern void reprepare_packed_git(void);
426 extern void install_packed_git(struct packed_git *pack);
427
428 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
429 struct packed_git *packs);
430
431 extern void pack_report(void);
432 extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
433 extern void unuse_pack(struct pack_window **);
434 extern struct packed_git *add_packed_git(const char *, int, int);
435 extern uint32_t num_packed_objects(const struct packed_git *p);
436 extern int nth_packed_object_sha1(const struct packed_git *, uint32_t, unsigned char*);
437 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
438 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
439 extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
440 extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
441
442 /* Dumb servers support */
443 extern int update_server_info(int);
444
445 typedef int (*config_fn_t)(const char *, const char *);
446 extern int git_default_config(const char *, const char *);
447 extern int git_config_from_file(config_fn_t fn, const char *);
448 extern int git_config(config_fn_t fn);
449 extern int git_config_int(const char *, const char *);
450 extern int git_config_bool(const char *, const char *);
451 extern int git_config_set(const char *, const char *);
452 extern int git_config_set_multivar(const char *, const char *, const char *, int);
453 extern int git_config_rename_section(const char *, const char *);
454 extern int check_repository_format_version(const char *var, const char *value);
455
456 #define MAX_GITNAME (1000)
457 extern char git_default_email[MAX_GITNAME];
458 extern char git_default_name[MAX_GITNAME];
459
460 extern const char *git_commit_encoding;
461 extern const char *git_log_output_encoding;
462
463 extern int copy_fd(int ifd, int ofd);
464 extern int read_in_full(int fd, void *buf, size_t count);
465 extern int write_in_full(int fd, const void *buf, size_t count);
466 extern void write_or_die(int fd, const void *buf, size_t count);
467 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
468 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
469
470 /* pager.c */
471 extern void setup_pager(void);
472 extern int pager_in_use;
473 extern int pager_use_color;
474
475 /* base85 */
476 int decode_85(char *dst, char *line, int linelen);
477 void encode_85(char *buf, unsigned char *data, int bytes);
478
479 /* alloc.c */
480 struct blob;
481 struct tree;
482 struct commit;
483 struct tag;
484 extern struct blob *alloc_blob_node(void);
485 extern struct tree *alloc_tree_node(void);
486 extern struct commit *alloc_commit_node(void);
487 extern struct tag *alloc_tag_node(void);
488 extern void alloc_report(void);
489
490 /* trace.c */
491 extern int nfasprintf(char **str, const char *fmt, ...);
492 extern int nfvasprintf(char **str, const char *fmt, va_list va);
493 extern void trace_printf(const char *format, ...);
494 extern void trace_argv_printf(const char **argv, int count, const char *format, ...);
495
496 /* convert.c */
497 extern int convert_to_git(const char *path, char **bufp, unsigned long *sizep);
498 extern int convert_to_working_tree(const char *path, char **bufp, unsigned long *sizep);
499
500 #endif /* CACHE_H */