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