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