]> git.ipfire.org Git - thirdparty/git.git/blame - cache.h
Merge with gitk --parents change.
[thirdparty/git.git] / cache.h
CommitLineData
e83c5163
LT
1#ifndef CACHE_H
2#define CACHE_H
3
2dee0609 4#include <unistd.h>
e83c5163
LT
5#include <stdio.h>
6#include <sys/stat.h>
7#include <fcntl.h>
8#include <stddef.h>
9#include <stdlib.h>
10#include <stdarg.h>
bf0c6e83 11#include <string.h>
e83c5163 12#include <errno.h>
6b0c3121 13#include <limits.h>
e83c5163 14#include <sys/mman.h>
bb233d69 15#include <sys/param.h>
ccc4feb5 16#include <netinet/in.h>
575f4974
LT
17#include <sys/types.h>
18#include <dirent.h>
e83c5163 19
cef661fc 20#include SHA1_HEADER
e83c5163
LT
21#include <zlib.h>
22
9da3acfb
ET
23#if ZLIB_VERNUM < 0x1200
24#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
25#endif
26
b6829693
ET
27#ifdef DT_UNKNOWN
28#define DTYPE(de) ((de)->d_type)
29#else
30#define DT_UNKNOWN 0
31#define DT_DIR 1
32#define DT_REG 2
a15c1c60 33#define DT_LNK 3
b6829693
ET
34#define DTYPE(de) DT_UNKNOWN
35#endif
36
90334cf7
LT
37#ifdef __GNUC__
38#define NORETURN __attribute__((__noreturn__))
39#else
40#define NORETURN
41#endif
42
4ec99bf0
TS
43#ifndef __attribute__
44#define __attribute(x)
45#endif
46
2386d658
LT
47/*
48 * Intensive research over the course of many years has shown that
49 * port 9418 is totally unused by anything else. Or
50 *
51 * Your search - "port 9418" - did not match any documents.
52 *
53 * as www.google.com puts it.
54 */
55#define DEFAULT_GIT_PORT 9418
56
d19938ab
JH
57/*
58 * Environment variables transition.
59 * We accept older names for now but warn.
60 */
61extern char *gitenv_bc(const char *);
62#define gitenv(e) (getenv(e) ? : gitenv_bc(e))
63
e83c5163
LT
64/*
65 * Basic data structures for the directory cache
e83c5163
LT
66 */
67
68#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
69struct cache_header {
ccc4feb5
LT
70 unsigned int hdr_signature;
71 unsigned int hdr_version;
72 unsigned int hdr_entries;
e83c5163
LT
73};
74
75/*
76 * The "cache_time" is just the low 32 bits of the
77 * time. It doesn't matter if it overflows - we only
78 * check it for equality in the 32 bits we save.
79 */
80struct cache_time {
81 unsigned int sec;
82 unsigned int nsec;
83};
84
85/*
86 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
87 * Again - this is just a (very strong in practice) heuristic that
88 * the inode hasn't changed.
ccc4feb5
LT
89 *
90 * We save the fields in big-endian order to allow using the
91 * index file over NFS transparently.
e83c5163
LT
92 */
93struct cache_entry {
ccc4feb5
LT
94 struct cache_time ce_ctime;
95 struct cache_time ce_mtime;
96 unsigned int ce_dev;
97 unsigned int ce_ino;
98 unsigned int ce_mode;
99 unsigned int ce_uid;
100 unsigned int ce_gid;
101 unsigned int ce_size;
e83c5163 102 unsigned char sha1[20];
f5cabd13 103 unsigned short ce_flags;
59c1e249 104 char name[0];
e83c5163
LT
105};
106
95fd5bf8
LT
107#define CE_NAMEMASK (0x0fff)
108#define CE_STAGEMASK (0x3000)
220a0b52 109#define CE_UPDATE (0x4000)
aee46198 110#define CE_STAGESHIFT 12
95fd5bf8 111
aee46198
JH
112#define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
113#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
114#define ce_size(ce) cache_entry_size(ce_namelen(ce))
115#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
116
e4479470 117#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
118static inline unsigned int create_ce_mode(unsigned int mode)
119{
8ae0a8c5
KS
120 if (S_ISLNK(mode))
121 return htonl(S_IFLNK);
db823d4a 122 return htonl(S_IFREG | ce_permissions(mode));
8ae0a8c5 123}
e4479470 124
aee46198 125#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
f5cabd13 126
88355048
PB
127extern struct cache_entry **active_cache;
128extern unsigned int active_nr, active_alloc, active_cache_changed;
e83c5163 129
8ac069ac
JH
130#define GIT_DIR_ENVIRONMENT "GIT_DIR"
131#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 132#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 133#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 134#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
bb233d69 135
8ac069ac 136extern char *get_object_directory(void);
95fc7512 137extern char *get_refs_directory(void);
8ac069ac 138extern char *get_index_file(void);
5da5c8f4 139extern char *get_graft_file(void);
8ac069ac
JH
140
141#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 142
d288a700
LT
143extern const char **get_pathspec(const char *prefix, char **pathspec);
144extern const char *setup_git_directory(void);
828cc617 145extern char *prefix_path(const char *prefix, int len, char *path);
d288a700 146
e83c5163
LT
147#define alloc_nr(x) (((x)+16)*3/2)
148
734aab75 149/* Initialize and use the cache information */
e83c5163 150extern int read_cache(void);
197ee8c9 151extern int write_cache(int newfd, struct cache_entry **cache, int entries);
eb38c22f 152extern int cache_name_pos(const char *name, int namelen);
192268c1
JH
153#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
154#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 155#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
192268c1 156extern int add_cache_entry(struct cache_entry *ce, int option);
dbbce55b 157extern int remove_cache_entry_at(int pos);
197ee8c9 158extern int remove_file_from_cache(char *path);
dbbce55b 159extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
5d728c84 160extern int ce_match_stat(struct cache_entry *ce, struct stat *st);
c0fd1f51 161extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
7672db20 162extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
415e96c8
JH
163extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
164
165struct cache_file {
166 struct cache_file *next;
167 char lockfile[PATH_MAX];
168};
169extern int hold_index_file_for_update(struct cache_file *, const char *path);
170extern int commit_index_file(struct cache_file *);
171extern void rollback_index_file(struct cache_file *);
734aab75
LT
172
173#define MTIME_CHANGED 0x0001
174#define CTIME_CHANGED 0x0002
175#define OWNER_CHANGED 0x0004
176#define MODE_CHANGED 0x0008
177#define INODE_CHANGED 0x0010
178#define DATA_CHANGED 0x0020
8ae0a8c5 179#define TYPE_CHANGED 0x0040
e83c5163
LT
180
181/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0
TS
182extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
183extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
73134b6d 184extern char *sha1_file_name(const unsigned char *sha1);
bf592c50
DB
185extern char *sha1_pack_name(const unsigned char *sha1);
186extern char *sha1_pack_index_name(const unsigned char *sha1);
e83c5163 187
f2db68ed
HE
188int git_mkstemp(char *path, size_t n, const char *template);
189
b2cb9425 190int safe_create_leading_directories(char *path);
f2db68ed 191char *safe_strncpy(char *, const char *, size_t);
b2cb9425 192
e83c5163 193/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
c4483576 194extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
5180cacc 195extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
36e4d74a 196extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
2ade9340 197extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
73134b6d 198extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
bf0f910d 199extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
7672db20
BL
200extern char *write_sha1_file_prepare(void *buf,
201 unsigned long len,
202 const char *type,
203 unsigned char *sha1,
204 unsigned char *hdr,
205 int *hdrlen);
8237b185 206
5d6ccf5c 207extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 208
94537c78 209/* Read a tree into the cache */
3e587635 210extern int read_tree(void *buffer, unsigned long size, int stage, const char **paths);
94537c78 211
70b9829e
DB
212extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
213 size_t bufsize, size_t *bufposn);
a5eda52b 214extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
8237b185 215
dade09c2 216extern int has_sha1_pack(const unsigned char *sha1);
8237b185
DB
217extern int has_sha1_file(const unsigned char *sha1);
218
bf592c50
DB
219extern int has_pack_file(const unsigned char *sha1);
220extern int has_pack_index(const unsigned char *sha1);
221
e83c5163 222/* Convert to/from hex/sha1 representation */
3c249c95 223extern int get_sha1(const char *str, unsigned char *sha1);
197ee8c9
LT
224extern int get_sha1_hex(const char *hex, unsigned char *sha1);
225extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
e83c5163
LT
226
227/* General helper functions */
90334cf7 228extern void usage(const char *err) NORETURN;
4ec99bf0
TS
229extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
230extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
2de381f9 231
958ba6c9 232extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 233extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
e83c5163 234
40469ee9 235extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 236 const char *required_type,
40469ee9
JH
237 unsigned long *size,
238 unsigned char *sha1_ret);
f4913f91 239
f80cd783 240const char *show_date(unsigned long time, int timezone);
26a2d8ae 241void parse_date(const char *date, char *buf, int bufsize);
ecee9d9e
ET
242void datestamp(char *buf, int bufsize);
243
6aa33f40
LT
244extern int setup_ident(void);
245extern char *get_ident(const char *name, const char *email, const char *date_str);
d289d136
EB
246extern char *git_author_info(void);
247extern char *git_committer_info(void);
6aa33f40 248
127cfd0d 249static inline void *xmalloc(size_t size)
812666c8
CL
250{
251 void *ret = malloc(size);
252 if (!ret)
253 die("Out of memory, malloc failed");
254 return ret;
255}
256
127cfd0d 257static inline void *xrealloc(void *ptr, size_t size)
812666c8
CL
258{
259 void *ret = realloc(ptr, size);
260 if (!ret)
261 die("Out of memory, realloc failed");
262 return ret;
263}
264
127cfd0d
BR
265static inline void *xcalloc(size_t nmemb, size_t size)
266{
267 void *ret = calloc(nmemb, size);
268 if (!ret)
269 die("Out of memory, calloc failed");
270 return ret;
271}
272
12dccc16
LT
273struct checkout {
274 const char *base_dir;
275 int base_dir_len;
276 unsigned force:1,
277 quiet:1,
278 not_new:1,
279 refresh_cache:1;
280};
281
282extern int checkout_entry(struct cache_entry *ce, struct checkout *state);
283
9a217f2a 284extern struct alternate_object_database {
d5a63b99 285 struct alternate_object_database *next;
9a217f2a 286 char *name;
d5a63b99
JH
287 char base[0]; /* more */
288} *alt_odb_list;
9a217f2a
JH
289extern void prepare_alt_odb(void);
290
291extern struct packed_git {
292 struct packed_git *next;
293 unsigned long index_size;
294 unsigned long pack_size;
295 unsigned int *index_base;
296 void *pack_base;
297 unsigned int pack_last_used;
f9253394 298 unsigned int pack_use_cnt;
bf592c50 299 unsigned char sha1[20];
9a217f2a
JH
300 char pack_name[0]; /* something like ".git/objects/pack/xxxxx.pack" */
301} *packed_git;
f3bf9224
JH
302
303struct pack_entry {
304 unsigned int offset;
305 unsigned char sha1[20];
306 struct packed_git *p;
307};
308
d1c133f5
LT
309struct ref {
310 struct ref *next;
311 unsigned char old_sha1[20];
312 unsigned char new_sha1[20];
f88395ac 313 struct ref *peer_ref; /* when renaming */
d1c133f5
LT
314 char name[0];
315};
316
f7192598
LT
317extern int git_connect(int fd[2], char *url, const char *prog);
318extern int finish_connect(pid_t pid);
013e7c7f 319extern int path_match(const char *path, int nr, char **match);
f88395ac
JH
320extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
321 int nr_refspec, char **refspec, int all);
41cb7488 322extern int get_ack(int fd, unsigned char *result_sha1);
d1c133f5 323extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match);
f7192598 324
bf592c50 325extern struct packed_git *parse_pack_index(unsigned char *sha1);
c508df5e
DB
326extern struct packed_git *parse_pack_index_file(unsigned char *sha1,
327 char *idx_path);
bf592c50 328
9a217f2a 329extern void prepare_packed_git(void);
bf592c50
DB
330extern void install_packed_git(struct packed_git *pack);
331
332extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
333 struct packed_git *packs);
334
f9253394
JH
335extern int use_packed_git(struct packed_git *);
336extern void unuse_packed_git(struct packed_git *);
337extern struct packed_git *add_packed_git(char *, int);
9a217f2a
JH
338extern int num_packed_objects(const struct packed_git *p);
339extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
f3bf9224
JH
340extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
341extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
ad8c80a5 342extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, int *, unsigned char *);
9a217f2a 343
8f3f9b09
JH
344/* Dumb servers support */
345extern int update_server_info(int);
346
e83c5163 347#endif /* CACHE_H */