fetch-pack: -k option to keep downloaded pack.
[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
b6829693
ET
13#ifdef DT_UNKNOWN
14#define DTYPE(de) ((de)->d_type)
15#else
16#define DT_UNKNOWN 0
17#define DT_DIR 1
18#define DT_REG 2
a15c1c60 19#define DT_LNK 3
b6829693
ET
20#define DTYPE(de) DT_UNKNOWN
21#endif
22
2386d658
LT
23/*
24 * Intensive research over the course of many years has shown that
25 * port 9418 is totally unused by anything else. Or
26 *
27 * Your search - "port 9418" - did not match any documents.
28 *
29 * as www.google.com puts it.
ba8a4970
LT
30 *
31 * This port has been properly assigned for git use by IANA:
32 * git (Assigned-9418) [I06-050728-0001].
33 *
34 * git 9418/tcp git pack transfer service
35 * git 9418/udp git pack transfer service
36 *
37 * with Linus Torvalds <torvalds@osdl.org> as the point of
38 * contact. September 2005.
39 *
40 * See http://www.iana.org/assignments/port-numbers
2386d658
LT
41 */
42#define DEFAULT_GIT_PORT 9418
43
e83c5163
LT
44/*
45 * Basic data structures for the directory cache
e83c5163
LT
46 */
47
48#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
49struct cache_header {
ccc4feb5
LT
50 unsigned int hdr_signature;
51 unsigned int hdr_version;
52 unsigned int hdr_entries;
e83c5163
LT
53};
54
55/*
56 * The "cache_time" is just the low 32 bits of the
57 * time. It doesn't matter if it overflows - we only
58 * check it for equality in the 32 bits we save.
59 */
60struct cache_time {
61 unsigned int sec;
62 unsigned int nsec;
63};
64
65/*
66 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
67 * Again - this is just a (very strong in practice) heuristic that
68 * the inode hasn't changed.
ccc4feb5
LT
69 *
70 * We save the fields in big-endian order to allow using the
71 * index file over NFS transparently.
e83c5163
LT
72 */
73struct cache_entry {
ccc4feb5
LT
74 struct cache_time ce_ctime;
75 struct cache_time ce_mtime;
76 unsigned int ce_dev;
77 unsigned int ce_ino;
78 unsigned int ce_mode;
79 unsigned int ce_uid;
80 unsigned int ce_gid;
81 unsigned int ce_size;
e83c5163 82 unsigned char sha1[20];
f5cabd13 83 unsigned short ce_flags;
2c04662d 84 char name[0];
e83c5163
LT
85};
86
95fd5bf8
LT
87#define CE_NAMEMASK (0x0fff)
88#define CE_STAGEMASK (0x3000)
220a0b52 89#define CE_UPDATE (0x4000)
aee46198 90#define CE_STAGESHIFT 12
95fd5bf8 91
aee46198
JH
92#define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
93#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
94#define ce_size(ce) cache_entry_size(ce_namelen(ce))
95#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
96
e4479470 97#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
98static inline unsigned int create_ce_mode(unsigned int mode)
99{
8ae0a8c5
KS
100 if (S_ISLNK(mode))
101 return htonl(S_IFLNK);
db823d4a 102 return htonl(S_IFREG | ce_permissions(mode));
8ae0a8c5 103}
e4479470 104
aee46198 105#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
f5cabd13 106
88355048
PB
107extern struct cache_entry **active_cache;
108extern unsigned int active_nr, active_alloc, active_cache_changed;
e83c5163 109
8ac069ac
JH
110#define GIT_DIR_ENVIRONMENT "GIT_DIR"
111#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 112#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 113#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 114#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
bb233d69 115
5da1606d 116extern char *get_git_dir(void);
8ac069ac 117extern char *get_object_directory(void);
95fc7512 118extern char *get_refs_directory(void);
8ac069ac 119extern char *get_index_file(void);
5da5c8f4 120extern char *get_graft_file(void);
8ac069ac
JH
121
122#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 123
6b5ee137 124extern const char **get_pathspec(const char *prefix, const char **pathspec);
4ca06608 125extern const char *setup_git_directory_gently(int *);
d288a700 126extern const char *setup_git_directory(void);
6b5ee137 127extern const char *prefix_path(const char *prefix, int len, const char *path);
4ca06608 128extern const char *prefix_filename(const char *prefix, int len, const char *path);
d288a700 129
e83c5163
LT
130#define alloc_nr(x) (((x)+16)*3/2)
131
734aab75 132/* Initialize and use the cache information */
e83c5163 133extern int read_cache(void);
197ee8c9 134extern int write_cache(int newfd, struct cache_entry **cache, int entries);
eb38c22f 135extern int cache_name_pos(const char *name, int namelen);
192268c1
JH
136#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
137#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 138#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
192268c1 139extern int add_cache_entry(struct cache_entry *ce, int option);
dbbce55b 140extern int remove_cache_entry_at(int pos);
6b5ee137 141extern int remove_file_from_cache(const char *path);
dbbce55b 142extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
5d728c84 143extern int ce_match_stat(struct cache_entry *ce, struct stat *st);
b0391890 144extern int ce_modified(struct cache_entry *ce, struct stat *st);
c0fd1f51 145extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
7672db20 146extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
024510c8 147extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
ec1fcc16 148extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
415e96c8
JH
149extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
150
151struct cache_file {
152 struct cache_file *next;
153 char lockfile[PATH_MAX];
154};
155extern int hold_index_file_for_update(struct cache_file *, const char *path);
156extern int commit_index_file(struct cache_file *);
157extern void rollback_index_file(struct cache_file *);
734aab75 158
17712991 159extern int trust_executable_bit;
f8348be3 160extern int only_use_symrefs;
3299c6f6 161extern int diff_rename_limit_default;
17712991 162
ab9cb76f
JH
163#define GIT_REPO_VERSION 0
164extern int repository_format_version;
165extern int check_repository_format(void);
166
734aab75
LT
167#define MTIME_CHANGED 0x0001
168#define CTIME_CHANGED 0x0002
169#define OWNER_CHANGED 0x0004
170#define MODE_CHANGED 0x0008
171#define INODE_CHANGED 0x0010
172#define DATA_CHANGED 0x0020
8ae0a8c5 173#define TYPE_CHANGED 0x0040
e83c5163
LT
174
175/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0
TS
176extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
177extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
73134b6d 178extern char *sha1_file_name(const unsigned char *sha1);
bf592c50
DB
179extern char *sha1_pack_name(const unsigned char *sha1);
180extern char *sha1_pack_index_name(const unsigned char *sha1);
013f276e 181extern const char *find_unique_abbrev(const unsigned char *sha1, int);
88cd621d 182extern const unsigned char null_sha1[20];
e83c5163 183
f2db68ed
HE
184int git_mkstemp(char *path, size_t n, const char *template);
185
b2cb9425 186int safe_create_leading_directories(char *path);
f2db68ed 187char *safe_strncpy(char *, const char *, size_t);
bd22c904 188char *enter_repo(char *path, int strict);
b2cb9425 189
e83c5163 190/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
c4483576 191extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
5180cacc 192extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
36e4d74a 193extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
2ade9340 194extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
73134b6d 195extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
bf0f910d 196extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
7672db20
BL
197extern char *write_sha1_file_prepare(void *buf,
198 unsigned long len,
199 const char *type,
200 unsigned char *sha1,
201 unsigned char *hdr,
202 int *hdrlen);
8237b185 203
5d6ccf5c 204extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 205
94537c78 206/* Read a tree into the cache */
3e587635 207extern int read_tree(void *buffer, unsigned long size, int stage, const char **paths);
94537c78 208
70b9829e
DB
209extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
210 size_t bufsize, size_t *bufposn);
a5eda52b 211extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
b721e01f 212extern int move_temp_to_file(const char *tmpfile, char *filename);
8237b185 213
dade09c2 214extern int has_sha1_pack(const unsigned char *sha1);
8237b185
DB
215extern int has_sha1_file(const unsigned char *sha1);
216
bf592c50
DB
217extern int has_pack_file(const unsigned char *sha1);
218extern int has_pack_index(const unsigned char *sha1);
219
e83c5163 220/* Convert to/from hex/sha1 representation */
3c249c95 221extern int get_sha1(const char *str, unsigned char *sha1);
197ee8c9
LT
222extern int get_sha1_hex(const char *hex, unsigned char *sha1);
223extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
ca8db142 224extern int read_ref(const char *filename, unsigned char *sha1);
a876ed83 225extern const char *resolve_ref(const char *path, unsigned char *sha1, int);
8098a178
JH
226extern int create_symref(const char *git_HEAD, const char *refs_heads_master);
227extern int validate_symref(const char *git_HEAD);
e83c5163 228
958ba6c9 229extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 230extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
e83c5163 231
40469ee9 232extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 233 const char *required_type,
40469ee9
JH
234 unsigned long *size,
235 unsigned char *sha1_ret);
f4913f91 236
f80cd783 237const char *show_date(unsigned long time, int timezone);
2a39064c 238int parse_date(const char *date, char *buf, int bufsize);
ecee9d9e 239void datestamp(char *buf, int bufsize);
3c07b1d1 240unsigned long approxidate(const char *);
ecee9d9e 241
6aa33f40 242extern int setup_ident(void);
c7d77dab
JH
243extern const char *git_author_info(void);
244extern const char *git_committer_info(void);
6aa33f40 245
12dccc16
LT
246struct checkout {
247 const char *base_dir;
248 int base_dir_len;
249 unsigned force:1,
250 quiet:1,
251 not_new:1,
252 refresh_cache:1;
253};
254
255extern int checkout_entry(struct cache_entry *ce, struct checkout *state);
256
9a217f2a 257extern struct alternate_object_database {
d5a63b99 258 struct alternate_object_database *next;
9a217f2a 259 char *name;
2c04662d 260 char base[0]; /* more */
d5a63b99 261} *alt_odb_list;
9a217f2a
JH
262extern void prepare_alt_odb(void);
263
264extern struct packed_git {
265 struct packed_git *next;
266 unsigned long index_size;
267 unsigned long pack_size;
268 unsigned int *index_base;
269 void *pack_base;
270 unsigned int pack_last_used;
f9253394 271 unsigned int pack_use_cnt;
9d835df2 272 int pack_local;
bf592c50 273 unsigned char sha1[20];
2c04662d 274 char pack_name[0]; /* something like ".git/objects/pack/xxxxx.pack" */
9a217f2a 275} *packed_git;
f3bf9224
JH
276
277struct pack_entry {
278 unsigned int offset;
279 unsigned char sha1[20];
280 struct packed_git *p;
281};
282
d1c133f5
LT
283struct ref {
284 struct ref *next;
285 unsigned char old_sha1[20];
286 unsigned char new_sha1[20];
ff27adf3 287 unsigned char force;
f88395ac 288 struct ref *peer_ref; /* when renaming */
2c04662d 289 char name[0];
d1c133f5
LT
290};
291
f7192598
LT
292extern int git_connect(int fd[2], char *url, const char *prog);
293extern int finish_connect(pid_t pid);
013e7c7f 294extern int path_match(const char *path, int nr, char **match);
f88395ac
JH
295extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
296 int nr_refspec, char **refspec, int all);
41cb7488 297extern int get_ack(int fd, unsigned char *result_sha1);
1a7141ff 298extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, int ignore_funny);
211b5f9e 299extern int server_supports(const char *feature);
f7192598 300
bf592c50 301extern struct packed_git *parse_pack_index(unsigned char *sha1);
2ab141a2 302extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
c508df5e 303 char *idx_path);
bf592c50 304
9a217f2a 305extern void prepare_packed_git(void);
bf592c50
DB
306extern void install_packed_git(struct packed_git *pack);
307
308extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
309 struct packed_git *packs);
310
f9253394
JH
311extern int use_packed_git(struct packed_git *);
312extern void unuse_packed_git(struct packed_git *);
9d835df2 313extern struct packed_git *add_packed_git(char *, int, int);
9a217f2a
JH
314extern int num_packed_objects(const struct packed_git *p);
315extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
f3bf9224
JH
316extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
317extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
ad8c80a5 318extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, int *, unsigned char *);
9a217f2a 319
8f3f9b09
JH
320/* Dumb servers support */
321extern int update_server_info(int);
322
17712991
LT
323typedef int (*config_fn_t)(const char *, const char *);
324extern int git_default_config(const char *, const char *);
4f629539 325extern int git_config_from_file(config_fn_t fn, const char *);
17712991
LT
326extern int git_config(config_fn_t fn);
327extern int git_config_int(const char *, const char *);
328extern int git_config_bool(const char *, const char *);
10bea152 329extern int git_config_set(const char *, const char *);
4ddba79d 330extern int git_config_set_multivar(const char *, const char *, const char *, int);
ab9cb76f 331extern int check_repository_format_version(const char *var, const char *value);
17712991 332
e1b10391
LT
333#define MAX_GITNAME (1000)
334extern char git_default_email[MAX_GITNAME];
335extern char git_default_name[MAX_GITNAME];
336
4e72dcec
JH
337#define MAX_ENCODING_LENGTH 64
338extern char git_commit_encoding[MAX_ENCODING_LENGTH];
339
f3123c4a 340extern int copy_fd(int ifd, int ofd);
ad897215
JH
341
342/* Finish off pack transfer receiving end */
343extern int receive_unpack_pack(int fd[2], const char *me, int quiet);
344extern int receive_keep_pack(int fd[2], const char *me);
345
e83c5163 346#endif /* CACHE_H */