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