Merge branch 'jc/apply'
[alt-git.git] / cache.h
blobccb83a1fd5ccf9fe38e154b93b436e0021a91be6
1 #ifndef CACHE_H
2 #define CACHE_H
4 #include "git-compat-util.h"
6 #include SHA1_HEADER
7 #include <zlib.h>
9 #if ZLIB_VERNUM < 0x1200
10 #define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
11 #endif
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
28 * Intensive research over the course of many years has shown that
29 * port 9418 is totally unused by anything else. Or
31 * Your search - "port 9418" - did not match any documents.
33 * as www.google.com puts it.
35 * This port has been properly assigned for git use by IANA:
36 * git (Assigned-9418) [I06-050728-0001].
38 * git 9418/tcp git pack transfer service
39 * git 9418/udp git pack transfer service
41 * with Linus Torvalds <torvalds@osdl.org> as the point of
42 * contact. September 2005.
44 * See http://www.iana.org/assignments/port-numbers
46 #define DEFAULT_GIT_PORT 9418
49 * Basic data structures for the directory cache
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;
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.
64 struct cache_time {
65 unsigned int sec;
66 unsigned int nsec;
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.
74 * We save the fields in big-endian order to allow using the
75 * index file over NFS transparently.
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 */
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
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)
102 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
103 static inline unsigned int create_ce_mode(unsigned int mode)
105 if (S_ISLNK(mode))
106 return htonl(S_IFLNK);
107 return htonl(S_IFREG | ce_permissions(mode));
109 #define canon_mode(mode) \
110 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
111 S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
113 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
115 extern struct cache_entry **active_cache;
116 extern unsigned int active_nr, active_alloc, active_cache_changed;
117 extern struct cache_tree *active_cache_tree;
118 extern int cache_errno;
120 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
121 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
122 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
123 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
124 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
126 extern const char *get_git_dir(void);
127 extern char *get_object_directory(void);
128 extern char *get_refs_directory(void);
129 extern char *get_index_file(void);
130 extern char *get_graft_file(void);
132 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
134 extern const char **get_pathspec(const char *prefix, const char **pathspec);
135 extern const char *setup_git_directory_gently(int *);
136 extern const char *setup_git_directory(void);
137 extern const char *prefix_path(const char *prefix, int len, const char *path);
138 extern const char *prefix_filename(const char *prefix, int len, const char *path);
139 extern void verify_filename(const char *prefix, const char *name);
140 extern void verify_non_filename(const char *prefix, const char *name);
142 #define alloc_nr(x) (((x)+16)*3/2)
144 /* Initialize and use the cache information */
145 extern int read_cache(void);
146 extern int read_cache_from(const char *path);
147 extern int write_cache(int newfd, struct cache_entry **cache, int entries);
148 extern int verify_path(const char *path);
149 extern int cache_name_pos(const char *name, int namelen);
150 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
151 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
152 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
153 extern int add_cache_entry(struct cache_entry *ce, int option);
154 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
155 extern int remove_cache_entry_at(int pos);
156 extern int remove_file_from_cache(const char *path);
157 extern int add_file_to_index(const char *path, int verbose);
158 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
159 extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
160 extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
161 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
162 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
163 extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
164 extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
165 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
166 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
168 #define REFRESH_REALLY 0x0001 /* ignore_valid */
169 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
170 #define REFRESH_QUIET 0x0004 /* be quiet about it */
171 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
172 extern int refresh_cache(unsigned int flags);
174 struct lock_file {
175 struct lock_file *next;
176 char filename[PATH_MAX];
178 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
179 extern int commit_lock_file(struct lock_file *);
180 extern void rollback_lock_file(struct lock_file *);
182 /* Environment bits from configuration mechanism */
183 extern int use_legacy_headers;
184 extern int trust_executable_bit;
185 extern int assume_unchanged;
186 extern int prefer_symlink_refs;
187 extern int log_all_ref_updates;
188 extern int warn_ambiguous_refs;
189 extern int shared_repository;
190 extern const char *apply_default_whitespace;
191 extern int zlib_compression_level;
193 #define GIT_REPO_VERSION 0
194 extern int repository_format_version;
195 extern int check_repository_format(void);
197 #define MTIME_CHANGED 0x0001
198 #define CTIME_CHANGED 0x0002
199 #define OWNER_CHANGED 0x0004
200 #define MODE_CHANGED 0x0008
201 #define INODE_CHANGED 0x0010
202 #define DATA_CHANGED 0x0020
203 #define TYPE_CHANGED 0x0040
205 /* Return a statically allocated filename matching the sha1 signature */
206 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
207 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
208 extern char *sha1_file_name(const unsigned char *sha1);
209 extern char *sha1_pack_name(const unsigned char *sha1);
210 extern char *sha1_pack_index_name(const unsigned char *sha1);
211 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
212 extern const unsigned char null_sha1[20];
213 static inline int is_null_sha1(const unsigned char *sha1)
215 return !memcmp(sha1, null_sha1, 20);
217 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
219 return memcmp(sha1, sha2, 20);
221 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
223 memcpy(sha_dst, sha_src, 20);
225 static inline void hashclr(unsigned char *hash)
227 memset(hash, 0, 20);
230 int git_mkstemp(char *path, size_t n, const char *template);
232 enum sharedrepo {
233 PERM_UMASK = 0,
234 PERM_GROUP,
235 PERM_EVERYBODY
237 int git_config_perm(const char *var, const char *value);
238 int adjust_shared_perm(const char *path);
239 int safe_create_leading_directories(char *path);
240 char *enter_repo(char *path, int strict);
242 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
243 extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
244 extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
245 extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
246 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
247 extern char *write_sha1_file_prepare(void *buf,
248 unsigned long len,
249 const char *type,
250 unsigned char *sha1,
251 unsigned char *hdr,
252 int *hdrlen);
254 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
256 extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
257 size_t bufsize, size_t *bufposn);
258 extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
259 extern int move_temp_to_file(const char *tmpfile, char *filename);
261 extern int has_sha1_pack(const unsigned char *sha1);
262 extern int has_sha1_file(const unsigned char *sha1);
263 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *);
264 extern int legacy_loose_object(unsigned char *);
266 extern int has_pack_file(const unsigned char *sha1);
267 extern int has_pack_index(const unsigned char *sha1);
269 /* Convert to/from hex/sha1 representation */
270 #define MINIMUM_ABBREV 4
271 #define DEFAULT_ABBREV 7
273 extern int get_sha1(const char *str, unsigned char *sha1);
274 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
275 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
276 extern int read_ref(const char *filename, unsigned char *sha1);
277 extern const char *resolve_ref(const char *path, unsigned char *sha1, int);
278 extern int create_symref(const char *git_HEAD, const char *refs_heads_master);
279 extern int validate_symref(const char *git_HEAD);
281 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
282 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
284 extern void *read_object_with_reference(const unsigned char *sha1,
285 const char *required_type,
286 unsigned long *size,
287 unsigned char *sha1_ret);
289 const char *show_date(unsigned long time, int timezone, int relative);
290 const char *show_rfc2822_date(unsigned long time, int timezone);
291 int parse_date(const char *date, char *buf, int bufsize);
292 void datestamp(char *buf, int bufsize);
293 unsigned long approxidate(const char *);
295 extern int setup_ident(void);
296 extern const char *git_author_info(int);
297 extern const char *git_committer_info(int);
299 struct checkout {
300 const char *base_dir;
301 int base_dir_len;
302 unsigned force:1,
303 quiet:1,
304 not_new:1,
305 refresh_cache:1;
308 extern int checkout_entry(struct cache_entry *ce, struct checkout *state, char *topath);
310 extern struct alternate_object_database {
311 struct alternate_object_database *next;
312 char *name;
313 char base[FLEX_ARRAY]; /* more */
314 } *alt_odb_list;
315 extern void prepare_alt_odb(void);
317 extern struct packed_git {
318 struct packed_git *next;
319 unsigned long index_size;
320 unsigned long pack_size;
321 unsigned int *index_base;
322 void *pack_base;
323 unsigned int pack_last_used;
324 unsigned int pack_use_cnt;
325 int pack_local;
326 unsigned char sha1[20];
327 /* something like ".git/objects/pack/xxxxx.pack" */
328 char pack_name[FLEX_ARRAY]; /* more */
329 } *packed_git;
331 struct pack_entry {
332 unsigned int offset;
333 unsigned char sha1[20];
334 struct packed_git *p;
337 struct ref {
338 struct ref *next;
339 unsigned char old_sha1[20];
340 unsigned char new_sha1[20];
341 unsigned char force;
342 struct ref *peer_ref; /* when renaming */
343 char name[FLEX_ARRAY]; /* more */
346 #define REF_NORMAL (1u << 0)
347 #define REF_HEADS (1u << 1)
348 #define REF_TAGS (1u << 2)
350 extern int git_connect(int fd[2], char *url, const char *prog);
351 extern int finish_connect(pid_t pid);
352 extern int path_match(const char *path, int nr, char **match);
353 extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
354 int nr_refspec, char **refspec, int all);
355 extern int get_ack(int fd, unsigned char *result_sha1);
356 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
357 extern int server_supports(const char *feature);
359 extern struct packed_git *parse_pack_index(unsigned char *sha1);
360 extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
361 char *idx_path);
363 extern void prepare_packed_git(void);
364 extern void install_packed_git(struct packed_git *pack);
366 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
367 struct packed_git *packs);
369 extern int use_packed_git(struct packed_git *);
370 extern void unuse_packed_git(struct packed_git *);
371 extern struct packed_git *add_packed_git(char *, int, int);
372 extern int num_packed_objects(const struct packed_git *p);
373 extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
374 extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
375 extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
376 extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
378 /* Dumb servers support */
379 extern int update_server_info(int);
381 typedef int (*config_fn_t)(const char *, const char *);
382 extern int git_default_config(const char *, const char *);
383 extern int git_config_from_file(config_fn_t fn, const char *);
384 extern int git_config(config_fn_t fn);
385 extern int git_config_int(const char *, const char *);
386 extern int git_config_bool(const char *, const char *);
387 extern int git_config_set(const char *, const char *);
388 extern int git_config_set_multivar(const char *, const char *, const char *, int);
389 extern int check_repository_format_version(const char *var, const char *value);
391 #define MAX_GITNAME (1000)
392 extern char git_default_email[MAX_GITNAME];
393 extern char git_default_name[MAX_GITNAME];
395 #define MAX_ENCODING_LENGTH 64
396 extern char git_commit_encoding[MAX_ENCODING_LENGTH];
398 extern int copy_fd(int ifd, int ofd);
399 extern void write_or_die(int fd, const void *buf, size_t count);
401 /* Finish off pack transfer receiving end */
402 extern int receive_unpack_pack(int fd[2], const char *me, int quiet, int);
403 extern int receive_keep_pack(int fd[2], const char *me, int quiet, int);
405 /* pager.c */
406 extern void setup_pager(void);
407 extern int pager_in_use;
408 extern int pager_use_color;
410 /* base85 */
411 int decode_85(char *dst, char *line, int linelen);
412 void encode_85(char *buf, unsigned char *data, int bytes);
414 /* alloc.c */
415 struct blob;
416 struct tree;
417 struct commit;
418 struct tag;
419 extern struct blob *alloc_blob_node(void);
420 extern struct tree *alloc_tree_node(void);
421 extern struct commit *alloc_commit_node(void);
422 extern struct tag *alloc_tag_node(void);
423 extern void alloc_report(void);
425 #endif /* CACHE_H */