Code

Don't smash stack when $GIT_ALTERNATE_OBJECT_DIRECTORIES is too long
[git.git] / cache.h
1 #ifndef CACHE_H
2 #define CACHE_H
4 #include "git-compat-util.h"
6 #include SHA1_HEADER
7 #include <zlib.h>
9 #if ZLIB_VERNUM < 0x1200
10 #define deflateBound(c,s)  ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
11 #endif
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
27 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
28 #define S_IFINVALID     0030000
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)
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
67 /*
68  * Basic data structures for the directory cache
69  */
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 };
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 };
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 };
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
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)
121 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
122 static inline unsigned int create_ce_mode(unsigned int mode)
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));
130 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
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);
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)
147 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
149 struct 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 };
158 extern struct index_state the_index;
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)
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
181 enum 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 };
194 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
195 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
196 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
197 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
198 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
199 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
200 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
201 #define CONFIG_LOCAL_ENVIRONMENT "GIT_CONFIG_LOCAL"
202 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
203 #define GITATTRIBUTES_FILE ".gitattributes"
204 #define INFOATTRIBUTES_FILE "info/attributes"
205 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
207 extern int is_bare_repository_cfg;
208 extern int is_bare_repository(void);
209 extern int is_inside_git_dir(void);
210 extern const char *get_git_dir(void);
211 extern char *get_object_directory(void);
212 extern char *get_refs_directory(void);
213 extern char *get_index_file(void);
214 extern char *get_graft_file(void);
216 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
218 extern const char **get_pathspec(const char *prefix, const char **pathspec);
219 extern const char *setup_git_directory_gently(int *);
220 extern const char *setup_git_directory(void);
221 extern const char *prefix_path(const char *prefix, int len, const char *path);
222 extern const char *prefix_filename(const char *prefix, int len, const char *path);
223 extern void verify_filename(const char *prefix, const char *name);
224 extern void verify_non_filename(const char *prefix, const char *name);
226 #define alloc_nr(x) (((x)+16)*3/2)
228 /* Initialize and use the cache information */
229 extern int read_index(struct index_state *);
230 extern int read_index_from(struct index_state *, const char *path);
231 extern int write_index(struct index_state *, int newfd);
232 extern int discard_index(struct index_state *);
233 extern int verify_path(const char *path);
234 extern int index_name_pos(struct index_state *, const char *name, int namelen);
235 #define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
236 #define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
237 #define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
238 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
239 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
240 extern int remove_index_entry_at(struct index_state *, int pos);
241 extern int remove_file_from_index(struct index_state *, const char *path);
242 extern int add_file_to_index(struct index_state *, const char *path, int verbose);
243 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
244 extern int ie_match_stat(struct index_state *, struct cache_entry *, struct stat *, int);
245 extern int ie_modified(struct index_state *, struct cache_entry *, struct stat *, int);
246 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
247 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
248 extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
249 extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
250 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
251 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
253 #define REFRESH_REALLY          0x0001  /* ignore_valid */
254 #define REFRESH_UNMERGED        0x0002  /* allow unmerged */
255 #define REFRESH_QUIET           0x0004  /* be quiet about it */
256 #define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
257 extern int refresh_index(struct index_state *, unsigned int flags);
259 struct lock_file {
260         struct lock_file *next;
261         pid_t owner;
262         char on_list;
263         char filename[PATH_MAX];
264 };
265 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
266 extern int commit_lock_file(struct lock_file *);
268 extern int hold_locked_index(struct lock_file *, int);
269 extern int commit_locked_index(struct lock_file *);
270 extern void set_alternate_index_output(const char *);
272 extern void rollback_lock_file(struct lock_file *);
273 extern int delete_ref(const char *, const unsigned char *sha1);
275 /* Environment bits from configuration mechanism */
276 extern int use_legacy_headers;
277 extern int trust_executable_bit;
278 extern int has_symlinks;
279 extern int assume_unchanged;
280 extern int prefer_symlink_refs;
281 extern int log_all_ref_updates;
282 extern int warn_ambiguous_refs;
283 extern int shared_repository;
284 extern const char *apply_default_whitespace;
285 extern int zlib_compression_level;
286 extern size_t packed_git_window_size;
287 extern size_t packed_git_limit;
288 extern size_t delta_base_cache_limit;
289 extern int auto_crlf;
291 #define GIT_REPO_VERSION 0
292 extern int repository_format_version;
293 extern int check_repository_format(void);
295 #define MTIME_CHANGED   0x0001
296 #define CTIME_CHANGED   0x0002
297 #define OWNER_CHANGED   0x0004
298 #define MODE_CHANGED    0x0008
299 #define INODE_CHANGED   0x0010
300 #define DATA_CHANGED    0x0020
301 #define TYPE_CHANGED    0x0040
303 /* Return a statically allocated filename matching the sha1 signature */
304 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
305 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
306 extern char *sha1_file_name(const unsigned char *sha1);
307 extern char *sha1_pack_name(const unsigned char *sha1);
308 extern char *sha1_pack_index_name(const unsigned char *sha1);
309 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
310 extern const unsigned char null_sha1[20];
311 static inline int is_null_sha1(const unsigned char *sha1)
313         return !memcmp(sha1, null_sha1, 20);
315 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
317         return memcmp(sha1, sha2, 20);
319 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
321         memcpy(sha_dst, sha_src, 20);
323 static inline void hashclr(unsigned char *hash)
325         memset(hash, 0, 20);
328 int git_mkstemp(char *path, size_t n, const char *template);
330 enum sharedrepo {
331         PERM_UMASK = 0,
332         PERM_GROUP,
333         PERM_EVERYBODY
334 };
335 int git_config_perm(const char *var, const char *value);
336 int adjust_shared_perm(const char *path);
337 int safe_create_leading_directories(char *path);
338 char *enter_repo(char *path, int strict);
340 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
341 extern int sha1_object_info(const unsigned char *, unsigned long *);
342 extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
343 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
344 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
345 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
347 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
349 extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
350                               size_t bufsize, size_t *bufposn);
351 extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
352 extern int move_temp_to_file(const char *tmpfile, const char *filename);
354 extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
355 extern int has_sha1_file(const unsigned char *sha1);
356 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *);
357 extern int legacy_loose_object(unsigned char *);
359 extern int has_pack_file(const unsigned char *sha1);
360 extern int has_pack_index(const unsigned char *sha1);
362 extern const signed char hexval_table[256];
363 static inline unsigned int hexval(unsigned char c)
365         return hexval_table[c];
368 /* Convert to/from hex/sha1 representation */
369 #define MINIMUM_ABBREV 4
370 #define DEFAULT_ABBREV 7
372 extern int get_sha1(const char *str, unsigned char *sha1);
373 extern int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode);
374 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
375 extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
376 extern int read_ref(const char *filename, unsigned char *sha1);
377 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
378 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
379 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
381 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
382 extern int validate_headref(const char *ref);
384 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
385 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
387 extern void *read_object_with_reference(const unsigned char *sha1,
388                                         const char *required_type,
389                                         unsigned long *size,
390                                         unsigned char *sha1_ret);
392 enum date_mode { DATE_NORMAL = 0, DATE_RELATIVE, DATE_SHORT, DATE_LOCAL };
393 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
394 const char *show_rfc2822_date(unsigned long time, int timezone);
395 int parse_date(const char *date, char *buf, int bufsize);
396 void datestamp(char *buf, int bufsize);
397 unsigned long approxidate(const char *);
399 extern const char *git_author_info(int);
400 extern const char *git_committer_info(int);
401 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
403 struct checkout {
404         const char *base_dir;
405         int base_dir_len;
406         unsigned force:1,
407                  quiet:1,
408                  not_new:1,
409                  refresh_cache:1;
410 };
412 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
413 extern int has_symlink_leading_path(const char *name, char *last_symlink);
415 extern struct alternate_object_database {
416         struct alternate_object_database *next;
417         char *name;
418         char base[FLEX_ARRAY]; /* more */
419 } *alt_odb_list;
420 extern void prepare_alt_odb(void);
422 struct pack_window {
423         struct pack_window *next;
424         unsigned char *base;
425         off_t offset;
426         size_t len;
427         unsigned int last_used;
428         unsigned int inuse_cnt;
429 };
431 extern struct packed_git {
432         struct packed_git *next;
433         struct pack_window *windows;
434         off_t pack_size;
435         const void *index_data;
436         size_t index_size;
437         uint32_t num_objects;
438         int index_version;
439         time_t mtime;
440         int pack_fd;
441         int pack_local;
442         unsigned char sha1[20];
443         /* something like ".git/objects/pack/xxxxx.pack" */
444         char pack_name[FLEX_ARRAY]; /* more */
445 } *packed_git;
447 struct pack_entry {
448         off_t offset;
449         unsigned char sha1[20];
450         struct packed_git *p;
451 };
453 struct ref {
454         struct ref *next;
455         unsigned char old_sha1[20];
456         unsigned char new_sha1[20];
457         unsigned char force;
458         struct ref *peer_ref; /* when renaming */
459         char name[FLEX_ARRAY]; /* more */
460 };
462 #define REF_NORMAL      (1u << 0)
463 #define REF_HEADS       (1u << 1)
464 #define REF_TAGS        (1u << 2)
466 extern pid_t git_connect(int fd[2], char *url, const char *prog);
467 extern int finish_connect(pid_t pid);
468 extern int path_match(const char *path, int nr, char **match);
469 extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
470                       int nr_refspec, char **refspec, int all);
471 extern int get_ack(int fd, unsigned char *result_sha1);
472 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
473 extern int server_supports(const char *feature);
475 extern struct packed_git *parse_pack_index(unsigned char *sha1);
476 extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
477                                                 const char *idx_path);
479 extern void prepare_packed_git(void);
480 extern void reprepare_packed_git(void);
481 extern void install_packed_git(struct packed_git *pack);
483 extern struct packed_git *find_sha1_pack(const unsigned char *sha1, 
484                                          struct packed_git *packs);
486 extern void pack_report(void);
487 extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
488 extern void unuse_pack(struct pack_window **);
489 extern struct packed_git *add_packed_git(const char *, int, int);
490 extern const unsigned char *nth_packed_object_sha1(const struct packed_git *, uint32_t);
491 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
492 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
493 extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
494 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
495 extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
497 /* Dumb servers support */
498 extern int update_server_info(int);
500 typedef int (*config_fn_t)(const char *, const char *);
501 extern int git_default_config(const char *, const char *);
502 extern int git_config_from_file(config_fn_t fn, const char *);
503 extern int git_config(config_fn_t fn);
504 extern int git_config_int(const char *, const char *);
505 extern int git_config_bool(const char *, const char *);
506 extern int git_config_set(const char *, const char *);
507 extern int git_config_set_multivar(const char *, const char *, const char *, int);
508 extern int git_config_rename_section(const char *, const char *);
509 extern int check_repository_format_version(const char *var, const char *value);
511 #define MAX_GITNAME (1000)
512 extern char git_default_email[MAX_GITNAME];
513 extern char git_default_name[MAX_GITNAME];
515 extern const char *git_commit_encoding;
516 extern const char *git_log_output_encoding;
518 extern int copy_fd(int ifd, int ofd);
519 extern int read_in_full(int fd, void *buf, size_t count);
520 extern int write_in_full(int fd, const void *buf, size_t count);
521 extern void write_or_die(int fd, const void *buf, size_t count);
522 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
523 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
525 /* pager.c */
526 extern void setup_pager(void);
527 extern int pager_in_use;
528 extern int pager_use_color;
530 /* base85 */
531 int decode_85(char *dst, const char *line, int linelen);
532 void encode_85(char *buf, const unsigned char *data, int bytes);
534 /* alloc.c */
535 extern void *alloc_blob_node(void);
536 extern void *alloc_tree_node(void);
537 extern void *alloc_commit_node(void);
538 extern void *alloc_tag_node(void);
539 extern void *alloc_object_node(void);
540 extern void alloc_report(void);
542 /* trace.c */
543 extern int nfasprintf(char **str, const char *fmt, ...);
544 extern int nfvasprintf(char **str, const char *fmt, va_list va);
545 extern void trace_printf(const char *format, ...);
546 extern void trace_argv_printf(const char **argv, int count, const char *format, ...);
548 /* convert.c */
549 extern char *convert_to_git(const char *path, const char *src, unsigned long *sizep);
550 extern char *convert_to_working_tree(const char *path, const char *src, unsigned long *sizep);
551 extern void *convert_sha1_file(const char *path, const unsigned char *sha1, unsigned int mode, enum object_type *type, unsigned long *size);
553 /* match-trees.c */
554 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
556 #endif /* CACHE_H */