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