Use int instead of socklen_t
[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
4ec99bf0 41#ifndef __attribute__
75ea6911 42#define __attribute__(x)
4ec99bf0 43#endif
f1d090e1 44#endif
4ec99bf0 45
2386d658
LT
46/*
47 * Intensive research over the course of many years has shown that
48 * port 9418 is totally unused by anything else. Or
49 *
50 * Your search - "port 9418" - did not match any documents.
51 *
52 * as www.google.com puts it.
53 */
54#define DEFAULT_GIT_PORT 9418
55
e83c5163
LT
56/*
57 * Basic data structures for the directory cache
e83c5163
LT
58 */
59
60#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
61struct cache_header {
ccc4feb5
LT
62 unsigned int hdr_signature;
63 unsigned int hdr_version;
64 unsigned int hdr_entries;
e83c5163
LT
65};
66
67/*
68 * The "cache_time" is just the low 32 bits of the
69 * time. It doesn't matter if it overflows - we only
70 * check it for equality in the 32 bits we save.
71 */
72struct cache_time {
73 unsigned int sec;
74 unsigned int nsec;
75};
76
77/*
78 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
79 * Again - this is just a (very strong in practice) heuristic that
80 * the inode hasn't changed.
ccc4feb5
LT
81 *
82 * We save the fields in big-endian order to allow using the
83 * index file over NFS transparently.
e83c5163
LT
84 */
85struct cache_entry {
ccc4feb5
LT
86 struct cache_time ce_ctime;
87 struct cache_time ce_mtime;
88 unsigned int ce_dev;
89 unsigned int ce_ino;
90 unsigned int ce_mode;
91 unsigned int ce_uid;
92 unsigned int ce_gid;
93 unsigned int ce_size;
e83c5163 94 unsigned char sha1[20];
f5cabd13 95 unsigned short ce_flags;
2c04662d 96 char name[0];
e83c5163
LT
97};
98
95fd5bf8
LT
99#define CE_NAMEMASK (0x0fff)
100#define CE_STAGEMASK (0x3000)
220a0b52 101#define CE_UPDATE (0x4000)
aee46198 102#define CE_STAGESHIFT 12
95fd5bf8 103
aee46198
JH
104#define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
105#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
106#define ce_size(ce) cache_entry_size(ce_namelen(ce))
107#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
108
e4479470 109#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
110static inline unsigned int create_ce_mode(unsigned int mode)
111{
8ae0a8c5
KS
112 if (S_ISLNK(mode))
113 return htonl(S_IFLNK);
db823d4a 114 return htonl(S_IFREG | ce_permissions(mode));
8ae0a8c5 115}
e4479470 116
aee46198 117#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
f5cabd13 118
88355048
PB
119extern struct cache_entry **active_cache;
120extern unsigned int active_nr, active_alloc, active_cache_changed;
e83c5163 121
8ac069ac
JH
122#define GIT_DIR_ENVIRONMENT "GIT_DIR"
123#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 124#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 125#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 126#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
bb233d69 127
8ac069ac 128extern char *get_object_directory(void);
95fc7512 129extern char *get_refs_directory(void);
8ac069ac 130extern char *get_index_file(void);
5da5c8f4 131extern char *get_graft_file(void);
8ac069ac
JH
132
133#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 134
d288a700
LT
135extern const char **get_pathspec(const char *prefix, char **pathspec);
136extern const char *setup_git_directory(void);
828cc617 137extern char *prefix_path(const char *prefix, int len, char *path);
d288a700 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 */
4ec99bf0
TS
174extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
175extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
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
f2db68ed
HE
180int git_mkstemp(char *path, size_t n, const char *template);
181
b2cb9425 182int safe_create_leading_directories(char *path);
f2db68ed 183char *safe_strncpy(char *, const char *, size_t);
b2cb9425 184
e83c5163 185/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
c4483576 186extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
5180cacc 187extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
36e4d74a 188extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
2ade9340 189extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
73134b6d 190extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
bf0f910d 191extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
7672db20
BL
192extern char *write_sha1_file_prepare(void *buf,
193 unsigned long len,
194 const char *type,
195 unsigned char *sha1,
196 unsigned char *hdr,
197 int *hdrlen);
8237b185 198
5d6ccf5c 199extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 200
94537c78 201/* Read a tree into the cache */
3e587635 202extern int read_tree(void *buffer, unsigned long size, int stage, const char **paths);
94537c78 203
70b9829e
DB
204extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
205 size_t bufsize, size_t *bufposn);
a5eda52b 206extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
8237b185 207
dade09c2 208extern int has_sha1_pack(const unsigned char *sha1);
8237b185
DB
209extern int has_sha1_file(const unsigned char *sha1);
210
bf592c50
DB
211extern int has_pack_file(const unsigned char *sha1);
212extern int has_pack_index(const unsigned char *sha1);
213
e83c5163 214/* Convert to/from hex/sha1 representation */
3c249c95 215extern int get_sha1(const char *str, unsigned char *sha1);
197ee8c9
LT
216extern int get_sha1_hex(const char *hex, unsigned char *sha1);
217extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
e83c5163
LT
218
219/* General helper functions */
90334cf7 220extern void usage(const char *err) NORETURN;
4ec99bf0
TS
221extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
222extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
2de381f9 223
958ba6c9 224extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 225extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
e83c5163 226
40469ee9 227extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 228 const char *required_type,
40469ee9
JH
229 unsigned long *size,
230 unsigned char *sha1_ret);
f4913f91 231
f80cd783 232const char *show_date(unsigned long time, int timezone);
26a2d8ae 233void parse_date(const char *date, char *buf, int bufsize);
ecee9d9e
ET
234void datestamp(char *buf, int bufsize);
235
6aa33f40
LT
236extern int setup_ident(void);
237extern char *get_ident(const char *name, const char *email, const char *date_str);
d289d136
EB
238extern char *git_author_info(void);
239extern char *git_committer_info(void);
6aa33f40 240
127cfd0d 241static inline void *xmalloc(size_t size)
812666c8
CL
242{
243 void *ret = malloc(size);
244 if (!ret)
245 die("Out of memory, malloc failed");
246 return ret;
247}
248
127cfd0d 249static inline void *xrealloc(void *ptr, size_t size)
812666c8
CL
250{
251 void *ret = realloc(ptr, size);
252 if (!ret)
253 die("Out of memory, realloc failed");
254 return ret;
255}
256
127cfd0d
BR
257static inline void *xcalloc(size_t nmemb, size_t size)
258{
259 void *ret = calloc(nmemb, size);
260 if (!ret)
261 die("Out of memory, calloc failed");
262 return ret;
263}
264
12dccc16
LT
265struct checkout {
266 const char *base_dir;
267 int base_dir_len;
268 unsigned force:1,
269 quiet:1,
270 not_new:1,
271 refresh_cache:1;
272};
273
274extern int checkout_entry(struct cache_entry *ce, struct checkout *state);
275
9a217f2a 276extern struct alternate_object_database {
d5a63b99 277 struct alternate_object_database *next;
9a217f2a 278 char *name;
2c04662d 279 char base[0]; /* more */
d5a63b99 280} *alt_odb_list;
9a217f2a
JH
281extern void prepare_alt_odb(void);
282
283extern struct packed_git {
284 struct packed_git *next;
285 unsigned long index_size;
286 unsigned long pack_size;
287 unsigned int *index_base;
288 void *pack_base;
289 unsigned int pack_last_used;
f9253394 290 unsigned int pack_use_cnt;
bf592c50 291 unsigned char sha1[20];
2c04662d 292 char pack_name[0]; /* something like ".git/objects/pack/xxxxx.pack" */
9a217f2a 293} *packed_git;
f3bf9224
JH
294
295struct pack_entry {
296 unsigned int offset;
297 unsigned char sha1[20];
298 struct packed_git *p;
299};
300
d1c133f5
LT
301struct ref {
302 struct ref *next;
303 unsigned char old_sha1[20];
304 unsigned char new_sha1[20];
ff27adf3 305 unsigned char force;
f88395ac 306 struct ref *peer_ref; /* when renaming */
2c04662d 307 char name[0];
d1c133f5
LT
308};
309
f7192598
LT
310extern int git_connect(int fd[2], char *url, const char *prog);
311extern int finish_connect(pid_t pid);
013e7c7f 312extern int path_match(const char *path, int nr, char **match);
f88395ac
JH
313extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
314 int nr_refspec, char **refspec, int all);
41cb7488 315extern int get_ack(int fd, unsigned char *result_sha1);
d1c133f5 316extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match);
f7192598 317
bf592c50 318extern struct packed_git *parse_pack_index(unsigned char *sha1);
2ab141a2 319extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
c508df5e 320 char *idx_path);
bf592c50 321
9a217f2a 322extern void prepare_packed_git(void);
bf592c50
DB
323extern void install_packed_git(struct packed_git *pack);
324
325extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
326 struct packed_git *packs);
327
f9253394
JH
328extern int use_packed_git(struct packed_git *);
329extern void unuse_packed_git(struct packed_git *);
330extern struct packed_git *add_packed_git(char *, int);
9a217f2a
JH
331extern int num_packed_objects(const struct packed_git *p);
332extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
f3bf9224
JH
333extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
334extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
ad8c80a5 335extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, int *, unsigned char *);
9a217f2a 336
8f3f9b09
JH
337/* Dumb servers support */
338extern int update_server_info(int);
339
e83c5163 340#endif /* CACHE_H */