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