Clean up compatibility definitions.
[git/git.git] / cache.h
1 #ifndef CACHE_H
2 #define CACHE_H
3
4 #include "git-compat-util.h"
5
6 #include SHA1_HEADER
7 #include <zlib.h>
8
9 #if ZLIB_VERNUM < 0x1200
10 #define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
11 #endif
12
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
19 #define DT_LNK 3
20 #define DTYPE(de) DT_UNKNOWN
21 #endif
22
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.
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
41 */
42 #define DEFAULT_GIT_PORT 9418
43
44 /*
45 * Basic data structures for the directory cache
46 */
47
48 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
49 struct cache_header {
50 unsigned int hdr_signature;
51 unsigned int hdr_version;
52 unsigned int hdr_entries;
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 */
60 struct 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.
69 *
70 * We save the fields in big-endian order to allow using the
71 * index file over NFS transparently.
72 */
73 struct cache_entry {
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;
82 unsigned char sha1[20];
83 unsigned short ce_flags;
84 char name[0];
85 };
86
87 #define CE_NAMEMASK (0x0fff)
88 #define CE_STAGEMASK (0x3000)
89 #define CE_UPDATE (0x4000)
90 #define CE_STAGESHIFT 12
91
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
97 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
98 static inline unsigned int create_ce_mode(unsigned int mode)
99 {
100 if (S_ISLNK(mode))
101 return htonl(S_IFLNK);
102 return htonl(S_IFREG | ce_permissions(mode));
103 }
104
105 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
106
107 extern struct cache_entry **active_cache;
108 extern unsigned int active_nr, active_alloc, active_cache_changed;
109
110 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
111 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
112 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
113 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
114 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
115
116 extern char *get_git_dir(void);
117 extern char *get_object_directory(void);
118 extern char *get_refs_directory(void);
119 extern char *get_index_file(void);
120 extern char *get_graft_file(void);
121
122 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
123
124 extern const char **get_pathspec(const char *prefix, const char **pathspec);
125 extern const char *setup_git_directory_gently(int *);
126 extern const char *setup_git_directory(void);
127 extern const char *prefix_path(const char *prefix, int len, const char *path);
128 extern const char *prefix_filename(const char *prefix, int len, const char *path);
129
130 #define alloc_nr(x) (((x)+16)*3/2)
131
132 /* Initialize and use the cache information */
133 extern int read_cache(void);
134 extern int write_cache(int newfd, struct cache_entry **cache, int entries);
135 extern int cache_name_pos(const char *name, int namelen);
136 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
137 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
138 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
139 extern int add_cache_entry(struct cache_entry *ce, int option);
140 extern int remove_cache_entry_at(int pos);
141 extern int remove_file_from_cache(const char *path);
142 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
143 extern int ce_match_stat(struct cache_entry *ce, struct stat *st);
144 extern int ce_modified(struct cache_entry *ce, struct stat *st);
145 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
146 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
147 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
148 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
149
150 struct cache_file {
151 struct cache_file *next;
152 char lockfile[PATH_MAX];
153 };
154 extern int hold_index_file_for_update(struct cache_file *, const char *path);
155 extern int commit_index_file(struct cache_file *);
156 extern void rollback_index_file(struct cache_file *);
157
158 extern int trust_executable_bit;
159 extern int only_use_symrefs;
160 extern int diff_rename_limit_default;
161
162 #define GIT_REPO_VERSION 0
163 extern int repository_format_version;
164 extern int check_repository_format(void);
165
166 #define MTIME_CHANGED 0x0001
167 #define CTIME_CHANGED 0x0002
168 #define OWNER_CHANGED 0x0004
169 #define MODE_CHANGED 0x0008
170 #define INODE_CHANGED 0x0010
171 #define DATA_CHANGED 0x0020
172 #define TYPE_CHANGED 0x0040
173
174 /* Return a statically allocated filename matching the sha1 signature */
175 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
176 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
177 extern char *sha1_file_name(const unsigned char *sha1);
178 extern char *sha1_pack_name(const unsigned char *sha1);
179 extern char *sha1_pack_index_name(const unsigned char *sha1);
180 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
181 extern const unsigned char null_sha1[20];
182
183 int git_mkstemp(char *path, size_t n, const char *template);
184
185 int safe_create_leading_directories(char *path);
186 char *safe_strncpy(char *, const char *, size_t);
187 char *enter_repo(char *path, int strict);
188
189 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
190 extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
191 extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
192 extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
193 extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
194 extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
195 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
196 extern char *write_sha1_file_prepare(void *buf,
197 unsigned long len,
198 const char *type,
199 unsigned char *sha1,
200 unsigned char *hdr,
201 int *hdrlen);
202
203 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
204
205 /* Read a tree into the cache */
206 extern int read_tree(void *buffer, unsigned long size, int stage, const char **paths);
207
208 extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
209 size_t bufsize, size_t *bufposn);
210 extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
211 extern int move_temp_to_file(const char *tmpfile, char *filename);
212
213 extern int has_sha1_pack(const unsigned char *sha1);
214 extern int has_sha1_file(const unsigned char *sha1);
215
216 extern int has_pack_file(const unsigned char *sha1);
217 extern int has_pack_index(const unsigned char *sha1);
218
219 /* Convert to/from hex/sha1 representation */
220 extern int get_sha1(const char *str, unsigned char *sha1);
221 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
222 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
223 extern int read_ref(const char *filename, unsigned char *sha1);
224 extern const char *resolve_ref(const char *path, unsigned char *sha1, int);
225 extern int create_symref(const char *git_HEAD, const char *refs_heads_master);
226 extern int validate_symref(const char *git_HEAD);
227
228 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
229 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
230
231 extern void *read_object_with_reference(const unsigned char *sha1,
232 const char *required_type,
233 unsigned long *size,
234 unsigned char *sha1_ret);
235
236 const char *show_date(unsigned long time, int timezone);
237 int parse_date(const char *date, char *buf, int bufsize);
238 void datestamp(char *buf, int bufsize);
239 unsigned long approxidate(const char *);
240
241 extern int setup_ident(void);
242 extern const char *git_author_info(void);
243 extern const char *git_committer_info(void);
244
245 struct checkout {
246 const char *base_dir;
247 int base_dir_len;
248 unsigned force:1,
249 quiet:1,
250 not_new:1,
251 refresh_cache:1;
252 };
253
254 extern int checkout_entry(struct cache_entry *ce, struct checkout *state);
255
256 extern struct alternate_object_database {
257 struct alternate_object_database *next;
258 char *name;
259 char base[0]; /* more */
260 } *alt_odb_list;
261 extern void prepare_alt_odb(void);
262
263 extern struct packed_git {
264 struct packed_git *next;
265 unsigned long index_size;
266 unsigned long pack_size;
267 unsigned int *index_base;
268 void *pack_base;
269 unsigned int pack_last_used;
270 unsigned int pack_use_cnt;
271 int pack_local;
272 unsigned char sha1[20];
273 char pack_name[0]; /* something like ".git/objects/pack/xxxxx.pack" */
274 } *packed_git;
275
276 struct pack_entry {
277 unsigned int offset;
278 unsigned char sha1[20];
279 struct packed_git *p;
280 };
281
282 struct ref {
283 struct ref *next;
284 unsigned char old_sha1[20];
285 unsigned char new_sha1[20];
286 unsigned char force;
287 struct ref *peer_ref; /* when renaming */
288 char name[0];
289 };
290
291 extern int git_connect(int fd[2], char *url, const char *prog);
292 extern int finish_connect(pid_t pid);
293 extern int path_match(const char *path, int nr, char **match);
294 extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
295 int nr_refspec, char **refspec, int all);
296 extern int get_ack(int fd, unsigned char *result_sha1);
297 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, int ignore_funny);
298 extern int server_supports(const char *feature);
299
300 extern struct packed_git *parse_pack_index(unsigned char *sha1);
301 extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
302 char *idx_path);
303
304 extern void prepare_packed_git(void);
305 extern void install_packed_git(struct packed_git *pack);
306
307 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
308 struct packed_git *packs);
309
310 extern int use_packed_git(struct packed_git *);
311 extern void unuse_packed_git(struct packed_git *);
312 extern struct packed_git *add_packed_git(char *, int, int);
313 extern int num_packed_objects(const struct packed_git *p);
314 extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
315 extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
316 extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
317 extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, int *, unsigned char *);
318
319 /* Dumb servers support */
320 extern int update_server_info(int);
321
322 typedef int (*config_fn_t)(const char *, const char *);
323 extern int git_default_config(const char *, const char *);
324 extern int git_config_from_file(config_fn_t fn, const char *);
325 extern int git_config(config_fn_t fn);
326 extern int git_config_int(const char *, const char *);
327 extern int git_config_bool(const char *, const char *);
328 extern int git_config_set(const char *, const char *);
329 extern int git_config_set_multivar(const char *, const char *, const char *, int);
330 extern int check_repository_format_version(const char *var, const char *value);
331
332 #define MAX_GITNAME (1000)
333 extern char git_default_email[MAX_GITNAME];
334 extern char git_default_name[MAX_GITNAME];
335
336 #define MAX_ENCODING_LENGTH 64
337 extern char git_commit_encoding[MAX_ENCODING_LENGTH];
338
339 extern int copy_fd(int ifd, int ofd);
340 #endif /* CACHE_H */