contrib/git-svn: version 0.10.0
[git/git.git] / cache.h
CommitLineData
e83c5163
LT
1#ifndef CACHE_H
2#define CACHE_H
3
4050c0df 4#include "git-compat-util.h"
e83c5163 5
cef661fc 6#include SHA1_HEADER
e83c5163
LT
7#include <zlib.h>
8
9da3acfb
ET
9#if ZLIB_VERNUM < 0x1200
10#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
11#endif
12
63be37b0 13#if defined(DT_UNKNOWN) && !NO_D_TYPE_IN_DIRENT
b6829693
ET
14#define DTYPE(de) ((de)->d_type)
15#else
0bdd79af
JH
16#undef DT_UNKNOWN
17#undef DT_DIR
18#undef DT_REG
19#undef DT_LNK
b6829693
ET
20#define DT_UNKNOWN 0
21#define DT_DIR 1
22#define DT_REG 2
a15c1c60 23#define DT_LNK 3
b6829693
ET
24#define DTYPE(de) DT_UNKNOWN
25#endif
26
2386d658
LT
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.
ba8a4970
LT
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
2386d658
LT
45 */
46#define DEFAULT_GIT_PORT 9418
47
e83c5163
LT
48/*
49 * Basic data structures for the directory cache
e83c5163
LT
50 */
51
52#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
53struct cache_header {
ccc4feb5
LT
54 unsigned int hdr_signature;
55 unsigned int hdr_version;
56 unsigned int hdr_entries;
e83c5163
LT
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.
ccc4feb5
LT
73 *
74 * We save the fields in big-endian order to allow using the
75 * index file over NFS transparently.
e83c5163
LT
76 */
77struct cache_entry {
ccc4feb5
LT
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;
e83c5163 86 unsigned char sha1[20];
f5cabd13 87 unsigned short ce_flags;
8f1d2e6f 88 char name[FLEX_ARRAY]; /* more */
e83c5163
LT
89};
90
95fd5bf8
LT
91#define CE_NAMEMASK (0x0fff)
92#define CE_STAGEMASK (0x3000)
220a0b52 93#define CE_UPDATE (0x4000)
5f73076c 94#define CE_VALID (0x8000)
aee46198 95#define CE_STAGESHIFT 12
95fd5bf8 96
aee46198
JH
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
e4479470 102#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
103static inline unsigned int create_ce_mode(unsigned int mode)
104{
8ae0a8c5
KS
105 if (S_ISLNK(mode))
106 return htonl(S_IFLNK);
db823d4a 107 return htonl(S_IFREG | ce_permissions(mode));
8ae0a8c5 108}
e4479470 109
aee46198 110#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
f5cabd13 111
88355048
PB
112extern struct cache_entry **active_cache;
113extern unsigned int active_nr, active_alloc, active_cache_changed;
e83c5163 114
8ac069ac
JH
115#define GIT_DIR_ENVIRONMENT "GIT_DIR"
116#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 117#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 118#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 119#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
bb233d69 120
5da1606d 121extern char *get_git_dir(void);
8ac069ac 122extern char *get_object_directory(void);
95fc7512 123extern char *get_refs_directory(void);
8ac069ac 124extern char *get_index_file(void);
5da5c8f4 125extern char *get_graft_file(void);
8ac069ac
JH
126
127#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 128
6b5ee137 129extern const char **get_pathspec(const char *prefix, const char **pathspec);
4ca06608 130extern const char *setup_git_directory_gently(int *);
d288a700 131extern const char *setup_git_directory(void);
6b5ee137 132extern const char *prefix_path(const char *prefix, int len, const char *path);
4ca06608 133extern const char *prefix_filename(const char *prefix, int len, const char *path);
d288a700 134
e83c5163
LT
135#define alloc_nr(x) (((x)+16)*3/2)
136
734aab75 137/* Initialize and use the cache information */
e83c5163 138extern int read_cache(void);
197ee8c9 139extern int write_cache(int newfd, struct cache_entry **cache, int entries);
eb38c22f 140extern int cache_name_pos(const char *name, int namelen);
192268c1
JH
141#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
142#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 143#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
192268c1 144extern int add_cache_entry(struct cache_entry *ce, int option);
dbbce55b 145extern int remove_cache_entry_at(int pos);
6b5ee137 146extern int remove_file_from_cache(const char *path);
dbbce55b 147extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
5f73076c
JH
148extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
149extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
c0fd1f51 150extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
7672db20 151extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
024510c8 152extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
ec1fcc16 153extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
415e96c8
JH
154extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
155
156struct cache_file {
157 struct cache_file *next;
158 char lockfile[PATH_MAX];
159};
160extern int hold_index_file_for_update(struct cache_file *, const char *path);
161extern int commit_index_file(struct cache_file *);
162extern void rollback_index_file(struct cache_file *);
734aab75 163
17712991 164extern int trust_executable_bit;
5f73076c 165extern int assume_unchanged;
f8348be3 166extern int only_use_symrefs;
3299c6f6 167extern int diff_rename_limit_default;
457f06d6 168extern int shared_repository;
17712991 169
ab9cb76f
JH
170#define GIT_REPO_VERSION 0
171extern int repository_format_version;
172extern int check_repository_format(void);
173
734aab75
LT
174#define MTIME_CHANGED 0x0001
175#define CTIME_CHANGED 0x0002
176#define OWNER_CHANGED 0x0004
177#define MODE_CHANGED 0x0008
178#define INODE_CHANGED 0x0010
179#define DATA_CHANGED 0x0020
8ae0a8c5 180#define TYPE_CHANGED 0x0040
e83c5163
LT
181
182/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0
TS
183extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
184extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
73134b6d 185extern char *sha1_file_name(const unsigned char *sha1);
bf592c50
DB
186extern char *sha1_pack_name(const unsigned char *sha1);
187extern char *sha1_pack_index_name(const unsigned char *sha1);
013f276e 188extern const char *find_unique_abbrev(const unsigned char *sha1, int);
88cd621d 189extern const unsigned char null_sha1[20];
e83c5163 190
f2db68ed
HE
191int git_mkstemp(char *path, size_t n, const char *template);
192
457f06d6 193int adjust_shared_perm(const char *path);
b2cb9425 194int safe_create_leading_directories(char *path);
f2db68ed 195char *safe_strncpy(char *, const char *, size_t);
bd22c904 196char *enter_repo(char *path, int strict);
b2cb9425 197
e83c5163 198/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
c4483576 199extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
5180cacc 200extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
36e4d74a 201extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
2ade9340 202extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
73134b6d 203extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
bf0f910d 204extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
7672db20
BL
205extern char *write_sha1_file_prepare(void *buf,
206 unsigned long len,
207 const char *type,
208 unsigned char *sha1,
209 unsigned char *hdr,
210 int *hdrlen);
8237b185 211
5d6ccf5c 212extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 213
70b9829e
DB
214extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
215 size_t bufsize, size_t *bufposn);
a5eda52b 216extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
b721e01f 217extern int move_temp_to_file(const char *tmpfile, char *filename);
8237b185 218
dade09c2 219extern int has_sha1_pack(const unsigned char *sha1);
8237b185
DB
220extern int has_sha1_file(const unsigned char *sha1);
221
bf592c50
DB
222extern int has_pack_file(const unsigned char *sha1);
223extern int has_pack_index(const unsigned char *sha1);
224
e83c5163 225/* Convert to/from hex/sha1 representation */
46a6c262
JH
226#define MINIMUM_ABBREV 4
227#define DEFAULT_ABBREV 7
228
3c249c95 229extern int get_sha1(const char *str, unsigned char *sha1);
197ee8c9
LT
230extern int get_sha1_hex(const char *hex, unsigned char *sha1);
231extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
ca8db142 232extern int read_ref(const char *filename, unsigned char *sha1);
a876ed83 233extern const char *resolve_ref(const char *path, unsigned char *sha1, int);
8098a178
JH
234extern int create_symref(const char *git_HEAD, const char *refs_heads_master);
235extern int validate_symref(const char *git_HEAD);
e83c5163 236
958ba6c9 237extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 238extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
e83c5163 239
40469ee9 240extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 241 const char *required_type,
40469ee9
JH
242 unsigned long *size,
243 unsigned char *sha1_ret);
f4913f91 244
f80cd783 245const char *show_date(unsigned long time, int timezone);
2a39064c 246int parse_date(const char *date, char *buf, int bufsize);
ecee9d9e 247void datestamp(char *buf, int bufsize);
3c07b1d1 248unsigned long approxidate(const char *);
ecee9d9e 249
6aa33f40 250extern int setup_ident(void);
749be728
JH
251extern const char *git_author_info(int);
252extern const char *git_committer_info(int);
6aa33f40 253
12dccc16
LT
254struct checkout {
255 const char *base_dir;
256 int base_dir_len;
257 unsigned force:1,
258 quiet:1,
259 not_new:1,
260 refresh_cache:1;
261};
262
263extern int checkout_entry(struct cache_entry *ce, struct checkout *state);
264
9a217f2a 265extern struct alternate_object_database {
d5a63b99 266 struct alternate_object_database *next;
9a217f2a 267 char *name;
8f1d2e6f 268 char base[FLEX_ARRAY]; /* more */
d5a63b99 269} *alt_odb_list;
9a217f2a
JH
270extern void prepare_alt_odb(void);
271
272extern struct packed_git {
273 struct packed_git *next;
274 unsigned long index_size;
275 unsigned long pack_size;
276 unsigned int *index_base;
277 void *pack_base;
278 unsigned int pack_last_used;
f9253394 279 unsigned int pack_use_cnt;
9d835df2 280 int pack_local;
bf592c50 281 unsigned char sha1[20];
8f1d2e6f
JH
282 /* something like ".git/objects/pack/xxxxx.pack" */
283 char pack_name[FLEX_ARRAY]; /* more */
9a217f2a 284} *packed_git;
f3bf9224
JH
285
286struct pack_entry {
287 unsigned int offset;
288 unsigned char sha1[20];
289 struct packed_git *p;
290};
291
d1c133f5
LT
292struct ref {
293 struct ref *next;
294 unsigned char old_sha1[20];
295 unsigned char new_sha1[20];
ff27adf3 296 unsigned char force;
f88395ac 297 struct ref *peer_ref; /* when renaming */
8f1d2e6f 298 char name[FLEX_ARRAY]; /* more */
d1c133f5
LT
299};
300
f7192598
LT
301extern int git_connect(int fd[2], char *url, const char *prog);
302extern int finish_connect(pid_t pid);
013e7c7f 303extern int path_match(const char *path, int nr, char **match);
f88395ac
JH
304extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
305 int nr_refspec, char **refspec, int all);
41cb7488 306extern int get_ack(int fd, unsigned char *result_sha1);
1a7141ff 307extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, int ignore_funny);
211b5f9e 308extern int server_supports(const char *feature);
f7192598 309
bf592c50 310extern struct packed_git *parse_pack_index(unsigned char *sha1);
2ab141a2 311extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
c508df5e 312 char *idx_path);
bf592c50 313
9a217f2a 314extern void prepare_packed_git(void);
bf592c50
DB
315extern void install_packed_git(struct packed_git *pack);
316
317extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
318 struct packed_git *packs);
319
f9253394
JH
320extern int use_packed_git(struct packed_git *);
321extern void unuse_packed_git(struct packed_git *);
9d835df2 322extern struct packed_git *add_packed_git(char *, int, int);
9a217f2a
JH
323extern int num_packed_objects(const struct packed_git *p);
324extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
f3bf9224
JH
325extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
326extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
f8f135c9 327extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
9a217f2a 328
8f3f9b09
JH
329/* Dumb servers support */
330extern int update_server_info(int);
331
17712991
LT
332typedef int (*config_fn_t)(const char *, const char *);
333extern int git_default_config(const char *, const char *);
4f629539 334extern int git_config_from_file(config_fn_t fn, const char *);
17712991
LT
335extern int git_config(config_fn_t fn);
336extern int git_config_int(const char *, const char *);
337extern int git_config_bool(const char *, const char *);
10bea152 338extern int git_config_set(const char *, const char *);
4ddba79d 339extern int git_config_set_multivar(const char *, const char *, const char *, int);
ab9cb76f 340extern int check_repository_format_version(const char *var, const char *value);
17712991 341
e1b10391
LT
342#define MAX_GITNAME (1000)
343extern char git_default_email[MAX_GITNAME];
344extern char git_default_name[MAX_GITNAME];
345
4e72dcec
JH
346#define MAX_ENCODING_LENGTH 64
347extern char git_commit_encoding[MAX_ENCODING_LENGTH];
348
f3123c4a 349extern int copy_fd(int ifd, int ofd);
ad897215
JH
350
351/* Finish off pack transfer receiving end */
352extern int receive_unpack_pack(int fd[2], const char *me, int quiet);
5ee2ad65 353extern int receive_keep_pack(int fd[2], const char *me, int quiet);
ad897215 354
e83c5163 355#endif /* CACHE_H */