avoid to use error that shadows the function name, use err instead.
[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
962554c6 13#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
b6829693
ET
14#define DTYPE(de) ((de)->d_type)
15#else
0bdd79af
JH
16#undef DT_UNKNOWN
17#undef DT_DIR
18#undef DT_REG
19#undef DT_LNK
b6829693
ET
20#define DT_UNKNOWN 0
21#define DT_DIR 1
22#define DT_REG 2
a15c1c60 23#define DT_LNK 3
b6829693
ET
24#define DTYPE(de) DT_UNKNOWN
25#endif
26
2386d658
LT
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.
ba8a4970
LT
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
2386d658
LT
45 */
46#define DEFAULT_GIT_PORT 9418
47
e83c5163
LT
48/*
49 * Basic data structures for the directory cache
e83c5163
LT
50 */
51
52#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
53struct cache_header {
ccc4feb5
LT
54 unsigned int hdr_signature;
55 unsigned int hdr_version;
56 unsigned int hdr_entries;
e83c5163
LT
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 */
64struct 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.
ccc4feb5
LT
73 *
74 * We save the fields in big-endian order to allow using the
75 * index file over NFS transparently.
e83c5163
LT
76 */
77struct cache_entry {
ccc4feb5
LT
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;
e83c5163 86 unsigned char sha1[20];
f5cabd13 87 unsigned short ce_flags;
8f1d2e6f 88 char name[FLEX_ARRAY]; /* more */
e83c5163
LT
89};
90
95fd5bf8
LT
91#define CE_NAMEMASK (0x0fff)
92#define CE_STAGEMASK (0x3000)
220a0b52 93#define CE_UPDATE (0x4000)
5f73076c 94#define CE_VALID (0x8000)
aee46198 95#define CE_STAGESHIFT 12
95fd5bf8 96
aee46198
JH
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
e4479470 102#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
103static inline unsigned int create_ce_mode(unsigned int mode)
104{
8ae0a8c5
KS
105 if (S_ISLNK(mode))
106 return htonl(S_IFLNK);
db823d4a 107 return htonl(S_IFREG | ce_permissions(mode));
8ae0a8c5 108}
1b0c7174
JH
109#define canon_mode(mode) \
110 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
111 S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
e4479470 112
aee46198 113#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
f5cabd13 114
88355048
PB
115extern struct cache_entry **active_cache;
116extern unsigned int active_nr, active_alloc, active_cache_changed;
bad68ec9 117extern struct cache_tree *active_cache_tree;
8fd2cb40 118extern int cache_errno;
e83c5163 119
8ac069ac
JH
120#define GIT_DIR_ENVIRONMENT "GIT_DIR"
121#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 122#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 123#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 124#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
bb233d69 125
5da1606d 126extern char *get_git_dir(void);
8ac069ac 127extern char *get_object_directory(void);
95fc7512 128extern char *get_refs_directory(void);
8ac069ac 129extern char *get_index_file(void);
5da5c8f4 130extern char *get_graft_file(void);
8ac069ac
JH
131
132#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 133
6b5ee137 134extern const char **get_pathspec(const char *prefix, const char **pathspec);
4ca06608 135extern const char *setup_git_directory_gently(int *);
d288a700 136extern const char *setup_git_directory(void);
6b5ee137 137extern const char *prefix_path(const char *prefix, int len, const char *path);
4ca06608 138extern const char *prefix_filename(const char *prefix, int len, const char *path);
e23d0b4a 139extern void verify_filename(const char *prefix, const char *name);
ea92f41f 140extern void verify_non_filename(const char *prefix, const char *name);
d288a700 141
e83c5163
LT
142#define alloc_nr(x) (((x)+16)*3/2)
143
734aab75 144/* Initialize and use the cache information */
e83c5163 145extern int read_cache(void);
8fd2cb40 146extern int read_cache_from(const char *path);
197ee8c9 147extern int write_cache(int newfd, struct cache_entry **cache, int entries);
8dcf39c4 148extern int verify_path(const char *path);
eb38c22f 149extern int cache_name_pos(const char *name, int namelen);
192268c1
JH
150#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
151#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 152#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
192268c1 153extern int add_cache_entry(struct cache_entry *ce, int option);
8fd2cb40 154extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
dbbce55b 155extern int remove_cache_entry_at(int pos);
6b5ee137 156extern int remove_file_from_cache(const char *path);
11be42a4 157extern int add_file_to_index(const char *path, int verbose);
dbbce55b 158extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
5f73076c
JH
159extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
160extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
c0fd1f51 161extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
7672db20 162extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
e7332f96 163extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
024510c8 164extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
ec1fcc16 165extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
415e96c8
JH
166extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
167
405e5b2f
LT
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 */
172extern int refresh_cache(unsigned int flags);
173
021b6e45
JH
174struct lock_file {
175 struct lock_file *next;
176 char filename[PATH_MAX];
415e96c8 177};
40aaae88 178extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
021b6e45
JH
179extern int commit_lock_file(struct lock_file *);
180extern void rollback_lock_file(struct lock_file *);
734aab75 181
2ae1c53b 182/* Environment bits from configuration mechanism */
93821bd9 183extern int use_legacy_headers;
17712991 184extern int trust_executable_bit;
5f73076c 185extern int assume_unchanged;
9f0bb90d 186extern int prefer_symlink_refs;
6de08ae6 187extern int log_all_ref_updates;
2f8acdb3 188extern int warn_ambiguous_refs;
457f06d6 189extern int shared_repository;
2ae1c53b 190extern const char *apply_default_whitespace;
12f6c308 191extern int zlib_compression_level;
17712991 192
ab9cb76f
JH
193#define GIT_REPO_VERSION 0
194extern int repository_format_version;
195extern int check_repository_format(void);
196
734aab75
LT
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
8ae0a8c5 203#define TYPE_CHANGED 0x0040
e83c5163
LT
204
205/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0
TS
206extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
207extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
73134b6d 208extern char *sha1_file_name(const unsigned char *sha1);
bf592c50
DB
209extern char *sha1_pack_name(const unsigned char *sha1);
210extern char *sha1_pack_index_name(const unsigned char *sha1);
013f276e 211extern const char *find_unique_abbrev(const unsigned char *sha1, int);
88cd621d 212extern const unsigned char null_sha1[20];
0bef57ee
DR
213static inline int is_null_sha1(const unsigned char *sha1)
214{
215 return !memcmp(sha1, null_sha1, 20);
216}
a89fccd2
DR
217static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
218{
219 return memcmp(sha1, sha2, 20);
220}
e83c5163 221
f2db68ed
HE
222int git_mkstemp(char *path, size_t n, const char *template);
223
94df2506
JH
224enum sharedrepo {
225 PERM_UMASK = 0,
226 PERM_GROUP,
227 PERM_EVERYBODY
228};
229int git_config_perm(const char *var, const char *value);
457f06d6 230int adjust_shared_perm(const char *path);
b2cb9425 231int safe_create_leading_directories(char *path);
bd22c904 232char *enter_repo(char *path, int strict);
b2cb9425 233
e83c5163 234/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
36e4d74a 235extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
2ade9340 236extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
73134b6d 237extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
bf0f910d 238extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
7672db20
BL
239extern char *write_sha1_file_prepare(void *buf,
240 unsigned long len,
241 const char *type,
242 unsigned char *sha1,
243 unsigned char *hdr,
244 int *hdrlen);
8237b185 245
5d6ccf5c 246extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 247
70b9829e
DB
248extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
249 size_t bufsize, size_t *bufposn);
a5eda52b 250extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
b721e01f 251extern int move_temp_to_file(const char *tmpfile, char *filename);
8237b185 252
dade09c2 253extern int has_sha1_pack(const unsigned char *sha1);
8237b185 254extern int has_sha1_file(const unsigned char *sha1);
bb6b8e4f
JH
255extern void *map_sha1_file(const unsigned char *sha1, unsigned long *);
256extern int legacy_loose_object(unsigned char *);
8237b185 257
bf592c50
DB
258extern int has_pack_file(const unsigned char *sha1);
259extern int has_pack_index(const unsigned char *sha1);
260
e83c5163 261/* Convert to/from hex/sha1 representation */
46a6c262
JH
262#define MINIMUM_ABBREV 4
263#define DEFAULT_ABBREV 7
264
3c249c95 265extern int get_sha1(const char *str, unsigned char *sha1);
197ee8c9
LT
266extern int get_sha1_hex(const char *hex, unsigned char *sha1);
267extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
ca8db142 268extern int read_ref(const char *filename, unsigned char *sha1);
a876ed83 269extern const char *resolve_ref(const char *path, unsigned char *sha1, int);
8098a178
JH
270extern int create_symref(const char *git_HEAD, const char *refs_heads_master);
271extern int validate_symref(const char *git_HEAD);
e83c5163 272
958ba6c9 273extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 274extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
e83c5163 275
40469ee9 276extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 277 const char *required_type,
40469ee9
JH
278 unsigned long *size,
279 unsigned char *sha1_ret);
f4913f91 280
f80cd783 281const char *show_date(unsigned long time, int timezone);
2a387043 282const char *show_rfc2822_date(unsigned long time, int timezone);
2a39064c 283int parse_date(const char *date, char *buf, int bufsize);
ecee9d9e 284void datestamp(char *buf, int bufsize);
3c07b1d1 285unsigned long approxidate(const char *);
ecee9d9e 286
6aa33f40 287extern int setup_ident(void);
749be728
JH
288extern const char *git_author_info(int);
289extern const char *git_committer_info(int);
6aa33f40 290
12dccc16
LT
291struct checkout {
292 const char *base_dir;
293 int base_dir_len;
294 unsigned force:1,
295 quiet:1,
296 not_new:1,
297 refresh_cache:1;
298};
299
de84f99c 300extern int checkout_entry(struct cache_entry *ce, struct checkout *state, char *topath);
12dccc16 301
9a217f2a 302extern struct alternate_object_database {
d5a63b99 303 struct alternate_object_database *next;
9a217f2a 304 char *name;
8f1d2e6f 305 char base[FLEX_ARRAY]; /* more */
d5a63b99 306} *alt_odb_list;
9a217f2a
JH
307extern void prepare_alt_odb(void);
308
309extern struct packed_git {
310 struct packed_git *next;
311 unsigned long index_size;
312 unsigned long pack_size;
313 unsigned int *index_base;
314 void *pack_base;
315 unsigned int pack_last_used;
f9253394 316 unsigned int pack_use_cnt;
9d835df2 317 int pack_local;
bf592c50 318 unsigned char sha1[20];
8f1d2e6f
JH
319 /* something like ".git/objects/pack/xxxxx.pack" */
320 char pack_name[FLEX_ARRAY]; /* more */
9a217f2a 321} *packed_git;
f3bf9224
JH
322
323struct pack_entry {
324 unsigned int offset;
325 unsigned char sha1[20];
326 struct packed_git *p;
327};
328
d1c133f5
LT
329struct ref {
330 struct ref *next;
331 unsigned char old_sha1[20];
332 unsigned char new_sha1[20];
ff27adf3 333 unsigned char force;
f88395ac 334 struct ref *peer_ref; /* when renaming */
8f1d2e6f 335 char name[FLEX_ARRAY]; /* more */
d1c133f5
LT
336};
337
2718ff09
LT
338#define REF_NORMAL (1u << 0)
339#define REF_HEADS (1u << 1)
340#define REF_TAGS (1u << 2)
341
f7192598
LT
342extern int git_connect(int fd[2], char *url, const char *prog);
343extern int finish_connect(pid_t pid);
013e7c7f 344extern int path_match(const char *path, int nr, char **match);
f88395ac
JH
345extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
346 int nr_refspec, char **refspec, int all);
41cb7488 347extern int get_ack(int fd, unsigned char *result_sha1);
2718ff09 348extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
211b5f9e 349extern int server_supports(const char *feature);
f7192598 350
bf592c50 351extern struct packed_git *parse_pack_index(unsigned char *sha1);
2ab141a2 352extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
c508df5e 353 char *idx_path);
bf592c50 354
9a217f2a 355extern void prepare_packed_git(void);
bf592c50
DB
356extern void install_packed_git(struct packed_git *pack);
357
358extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
359 struct packed_git *packs);
360
f9253394
JH
361extern int use_packed_git(struct packed_git *);
362extern void unuse_packed_git(struct packed_git *);
9d835df2 363extern struct packed_git *add_packed_git(char *, int, int);
9a217f2a
JH
364extern int num_packed_objects(const struct packed_git *p);
365extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
f3bf9224
JH
366extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
367extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
f8f135c9 368extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
9a217f2a 369
8f3f9b09
JH
370/* Dumb servers support */
371extern int update_server_info(int);
372
17712991
LT
373typedef int (*config_fn_t)(const char *, const char *);
374extern int git_default_config(const char *, const char *);
4f629539 375extern int git_config_from_file(config_fn_t fn, const char *);
17712991
LT
376extern int git_config(config_fn_t fn);
377extern int git_config_int(const char *, const char *);
378extern int git_config_bool(const char *, const char *);
10bea152 379extern int git_config_set(const char *, const char *);
4ddba79d 380extern int git_config_set_multivar(const char *, const char *, const char *, int);
ab9cb76f 381extern int check_repository_format_version(const char *var, const char *value);
17712991 382
e1b10391
LT
383#define MAX_GITNAME (1000)
384extern char git_default_email[MAX_GITNAME];
385extern char git_default_name[MAX_GITNAME];
386
4e72dcec
JH
387#define MAX_ENCODING_LENGTH 64
388extern char git_commit_encoding[MAX_ENCODING_LENGTH];
389
f3123c4a 390extern int copy_fd(int ifd, int ofd);
7230e6d0 391extern void write_or_die(int fd, const void *buf, size_t count);
ad897215
JH
392
393/* Finish off pack transfer receiving end */
583b7ea3
JH
394extern int receive_unpack_pack(int fd[2], const char *me, int quiet, int);
395extern int receive_keep_pack(int fd[2], const char *me, int quiet, int);
ad897215 396
f67b45f8
LT
397/* pager.c */
398extern void setup_pager(void);
85fb65ed 399extern int pager_in_use;
aa086eb8 400extern int pager_use_color;
f67b45f8 401
051308f6
JH
402/* base85 */
403int decode_85(char *dst, char *line, int linelen);
0660626c 404void encode_85(char *buf, unsigned char *data, int bytes);
051308f6 405
855419f7
LT
406/* alloc.c */
407struct blob;
408struct tree;
409struct commit;
410struct tag;
411extern struct blob *alloc_blob_node(void);
412extern struct tree *alloc_tree_node(void);
413extern struct commit *alloc_commit_node(void);
414extern struct tag *alloc_tag_node(void);
415extern void alloc_report(void);
416
e83c5163 417#endif /* CACHE_H */