Fix silly typo in new builtin grep
[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) && !defined(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_VALID (0x8000)
95 #define CE_STAGESHIFT 12
96
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
102 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
103 static inline unsigned int create_ce_mode(unsigned int mode)
104 {
105 if (S_ISLNK(mode))
106 return htonl(S_IFLNK);
107 return htonl(S_IFREG | ce_permissions(mode));
108 }
109 #define canon_mode(mode) \
110 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
111 S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
112
113 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
114
115 extern struct cache_entry **active_cache;
116 extern unsigned int active_nr, active_alloc, active_cache_changed;
117
118 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
119 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
120 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
121 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
122 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
123
124 extern char *get_git_dir(void);
125 extern char *get_object_directory(void);
126 extern char *get_refs_directory(void);
127 extern char *get_index_file(void);
128 extern char *get_graft_file(void);
129
130 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
131
132 extern const char **get_pathspec(const char *prefix, const char **pathspec);
133 extern const char *setup_git_directory_gently(int *);
134 extern const char *setup_git_directory(void);
135 extern const char *prefix_path(const char *prefix, int len, const char *path);
136 extern const char *prefix_filename(const char *prefix, int len, const char *path);
137 extern void verify_filename(const char *prefix, const char *name);
138
139 #define alloc_nr(x) (((x)+16)*3/2)
140
141 /* Initialize and use the cache information */
142 extern int read_cache(void);
143 extern int write_cache(int newfd, struct cache_entry **cache, int entries);
144 extern int cache_name_pos(const char *name, int namelen);
145 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
146 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
147 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
148 extern int add_cache_entry(struct cache_entry *ce, int option);
149 extern int remove_cache_entry_at(int pos);
150 extern int remove_file_from_cache(const char *path);
151 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
152 extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
153 extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
154 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
155 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
156 extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
157 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
158 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
159
160 struct cache_file {
161 struct cache_file *next;
162 char lockfile[PATH_MAX];
163 };
164 extern int hold_index_file_for_update(struct cache_file *, const char *path);
165 extern int commit_index_file(struct cache_file *);
166 extern void rollback_index_file(struct cache_file *);
167
168 /* Environment bits from configuration mechanism */
169 extern int trust_executable_bit;
170 extern int assume_unchanged;
171 extern int only_use_symrefs;
172 extern int warn_ambiguous_refs;
173 extern int diff_rename_limit_default;
174 extern int shared_repository;
175 extern const char *apply_default_whitespace;
176
177 #define GIT_REPO_VERSION 0
178 extern int repository_format_version;
179 extern int check_repository_format(void);
180
181 #define MTIME_CHANGED 0x0001
182 #define CTIME_CHANGED 0x0002
183 #define OWNER_CHANGED 0x0004
184 #define MODE_CHANGED 0x0008
185 #define INODE_CHANGED 0x0010
186 #define DATA_CHANGED 0x0020
187 #define TYPE_CHANGED 0x0040
188
189 /* Return a statically allocated filename matching the sha1 signature */
190 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
191 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
192 extern char *sha1_file_name(const unsigned char *sha1);
193 extern char *sha1_pack_name(const unsigned char *sha1);
194 extern char *sha1_pack_index_name(const unsigned char *sha1);
195 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
196 extern const unsigned char null_sha1[20];
197
198 int git_mkstemp(char *path, size_t n, const char *template);
199
200 int adjust_shared_perm(const char *path);
201 int safe_create_leading_directories(char *path);
202 char *safe_strncpy(char *, const char *, size_t);
203 char *enter_repo(char *path, int strict);
204
205 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
206 extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
207 extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
208 extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
209 extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
210 extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
211 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
212 extern char *write_sha1_file_prepare(void *buf,
213 unsigned long len,
214 const char *type,
215 unsigned char *sha1,
216 unsigned char *hdr,
217 int *hdrlen);
218
219 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
220
221 extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
222 size_t bufsize, size_t *bufposn);
223 extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
224 extern int move_temp_to_file(const char *tmpfile, char *filename);
225
226 extern int has_sha1_pack(const unsigned char *sha1);
227 extern int has_sha1_file(const unsigned char *sha1);
228
229 extern int has_pack_file(const unsigned char *sha1);
230 extern int has_pack_index(const unsigned char *sha1);
231
232 /* Convert to/from hex/sha1 representation */
233 #define MINIMUM_ABBREV 4
234 #define DEFAULT_ABBREV 7
235
236 extern int get_sha1(const char *str, unsigned char *sha1);
237 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
238 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
239 extern int read_ref(const char *filename, unsigned char *sha1);
240 extern const char *resolve_ref(const char *path, unsigned char *sha1, int);
241 extern int create_symref(const char *git_HEAD, const char *refs_heads_master);
242 extern int validate_symref(const char *git_HEAD);
243
244 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
245 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
246
247 extern void *read_object_with_reference(const unsigned char *sha1,
248 const char *required_type,
249 unsigned long *size,
250 unsigned char *sha1_ret);
251
252 const char *show_date(unsigned long time, int timezone);
253 int parse_date(const char *date, char *buf, int bufsize);
254 void datestamp(char *buf, int bufsize);
255 unsigned long approxidate(const char *);
256
257 extern int setup_ident(void);
258 extern const char *git_author_info(int);
259 extern const char *git_committer_info(int);
260
261 struct checkout {
262 const char *base_dir;
263 int base_dir_len;
264 unsigned force:1,
265 quiet:1,
266 not_new:1,
267 refresh_cache:1;
268 };
269
270 extern int checkout_entry(struct cache_entry *ce, struct checkout *state, char *topath);
271
272 extern struct alternate_object_database {
273 struct alternate_object_database *next;
274 char *name;
275 char base[FLEX_ARRAY]; /* more */
276 } *alt_odb_list;
277 extern void prepare_alt_odb(void);
278
279 extern struct packed_git {
280 struct packed_git *next;
281 unsigned long index_size;
282 unsigned long pack_size;
283 unsigned int *index_base;
284 void *pack_base;
285 unsigned int pack_last_used;
286 unsigned int pack_use_cnt;
287 int pack_local;
288 unsigned char sha1[20];
289 /* something like ".git/objects/pack/xxxxx.pack" */
290 char pack_name[FLEX_ARRAY]; /* more */
291 } *packed_git;
292
293 struct pack_entry {
294 unsigned int offset;
295 unsigned char sha1[20];
296 struct packed_git *p;
297 };
298
299 struct ref {
300 struct ref *next;
301 unsigned char old_sha1[20];
302 unsigned char new_sha1[20];
303 unsigned char force;
304 struct ref *peer_ref; /* when renaming */
305 char name[FLEX_ARRAY]; /* more */
306 };
307
308 extern int git_connect(int fd[2], char *url, const char *prog);
309 extern int finish_connect(pid_t pid);
310 extern int path_match(const char *path, int nr, char **match);
311 extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
312 int nr_refspec, char **refspec, int all);
313 extern int get_ack(int fd, unsigned char *result_sha1);
314 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, int ignore_funny);
315 extern int server_supports(const char *feature);
316
317 extern struct packed_git *parse_pack_index(unsigned char *sha1);
318 extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
319 char *idx_path);
320
321 extern void prepare_packed_git(void);
322 extern void install_packed_git(struct packed_git *pack);
323
324 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
325 struct packed_git *packs);
326
327 extern int use_packed_git(struct packed_git *);
328 extern void unuse_packed_git(struct packed_git *);
329 extern struct packed_git *add_packed_git(char *, int, int);
330 extern int num_packed_objects(const struct packed_git *p);
331 extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
332 extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
333 extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
334 extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
335
336 /* Dumb servers support */
337 extern int update_server_info(int);
338
339 typedef int (*config_fn_t)(const char *, const char *);
340 extern int git_default_config(const char *, const char *);
341 extern int git_config_from_file(config_fn_t fn, const char *);
342 extern int git_config(config_fn_t fn);
343 extern int git_config_int(const char *, const char *);
344 extern int git_config_bool(const char *, const char *);
345 extern int git_config_set(const char *, const char *);
346 extern int git_config_set_multivar(const char *, const char *, const char *, int);
347 extern int check_repository_format_version(const char *var, const char *value);
348
349 #define MAX_GITNAME (1000)
350 extern char git_default_email[MAX_GITNAME];
351 extern char git_default_name[MAX_GITNAME];
352
353 #define MAX_ENCODING_LENGTH 64
354 extern char git_commit_encoding[MAX_ENCODING_LENGTH];
355
356 extern int copy_fd(int ifd, int ofd);
357
358 /* Finish off pack transfer receiving end */
359 extern int receive_unpack_pack(int fd[2], const char *me, int quiet);
360 extern int receive_keep_pack(int fd[2], const char *me, int quiet);
361
362 /* pager.c */
363 extern void setup_pager(void);
364
365 #endif /* CACHE_H */