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