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