[PATCH] Document config.mak in INSTALL.
[git/git.git] / cache.h
CommitLineData
e83c5163
LT
1#ifndef CACHE_H
2#define CACHE_H
3
2dee0609 4#include <unistd.h>
e83c5163
LT
5#include <stdio.h>
6#include <sys/stat.h>
7#include <fcntl.h>
8#include <stddef.h>
9#include <stdlib.h>
10#include <stdarg.h>
bf0c6e83 11#include <string.h>
e83c5163 12#include <errno.h>
6b0c3121 13#include <limits.h>
730d48a2 14#ifndef NO_MMAP
e83c5163 15#include <sys/mman.h>
730d48a2 16#endif
bb233d69 17#include <sys/param.h>
ccc4feb5 18#include <netinet/in.h>
575f4974
LT
19#include <sys/types.h>
20#include <dirent.h>
e83c5163 21
cef661fc 22#include SHA1_HEADER
e83c5163
LT
23#include <zlib.h>
24
9da3acfb
ET
25#if ZLIB_VERNUM < 0x1200
26#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
27#endif
28
b6829693
ET
29#ifdef DT_UNKNOWN
30#define DTYPE(de) ((de)->d_type)
31#else
32#define DT_UNKNOWN 0
33#define DT_DIR 1
34#define DT_REG 2
a15c1c60 35#define DT_LNK 3
b6829693
ET
36#define DTYPE(de) DT_UNKNOWN
37#endif
38
90334cf7
LT
39#ifdef __GNUC__
40#define NORETURN __attribute__((__noreturn__))
41#else
42#define NORETURN
4ec99bf0 43#ifndef __attribute__
75ea6911 44#define __attribute__(x)
4ec99bf0 45#endif
f1d090e1 46#endif
4ec99bf0 47
2386d658
LT
48/*
49 * Intensive research over the course of many years has shown that
50 * port 9418 is totally unused by anything else. Or
51 *
52 * Your search - "port 9418" - did not match any documents.
53 *
54 * as www.google.com puts it.
ba8a4970
LT
55 *
56 * This port has been properly assigned for git use by IANA:
57 * git (Assigned-9418) [I06-050728-0001].
58 *
59 * git 9418/tcp git pack transfer service
60 * git 9418/udp git pack transfer service
61 *
62 * with Linus Torvalds <torvalds@osdl.org> as the point of
63 * contact. September 2005.
64 *
65 * See http://www.iana.org/assignments/port-numbers
2386d658
LT
66 */
67#define DEFAULT_GIT_PORT 9418
68
e83c5163
LT
69/*
70 * Basic data structures for the directory cache
e83c5163
LT
71 */
72
73#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
74struct cache_header {
ccc4feb5
LT
75 unsigned int hdr_signature;
76 unsigned int hdr_version;
77 unsigned int hdr_entries;
e83c5163
LT
78};
79
80/*
81 * The "cache_time" is just the low 32 bits of the
82 * time. It doesn't matter if it overflows - we only
83 * check it for equality in the 32 bits we save.
84 */
85struct cache_time {
86 unsigned int sec;
87 unsigned int nsec;
88};
89
90/*
91 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
92 * Again - this is just a (very strong in practice) heuristic that
93 * the inode hasn't changed.
ccc4feb5
LT
94 *
95 * We save the fields in big-endian order to allow using the
96 * index file over NFS transparently.
e83c5163
LT
97 */
98struct cache_entry {
ccc4feb5
LT
99 struct cache_time ce_ctime;
100 struct cache_time ce_mtime;
101 unsigned int ce_dev;
102 unsigned int ce_ino;
103 unsigned int ce_mode;
104 unsigned int ce_uid;
105 unsigned int ce_gid;
106 unsigned int ce_size;
e83c5163 107 unsigned char sha1[20];
f5cabd13 108 unsigned short ce_flags;
2c04662d 109 char name[0];
e83c5163
LT
110};
111
95fd5bf8
LT
112#define CE_NAMEMASK (0x0fff)
113#define CE_STAGEMASK (0x3000)
220a0b52 114#define CE_UPDATE (0x4000)
aee46198 115#define CE_STAGESHIFT 12
95fd5bf8 116
aee46198
JH
117#define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
118#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
119#define ce_size(ce) cache_entry_size(ce_namelen(ce))
120#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
121
e4479470 122#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
123static inline unsigned int create_ce_mode(unsigned int mode)
124{
8ae0a8c5
KS
125 if (S_ISLNK(mode))
126 return htonl(S_IFLNK);
db823d4a 127 return htonl(S_IFREG | ce_permissions(mode));
8ae0a8c5 128}
e4479470 129
aee46198 130#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
f5cabd13 131
88355048
PB
132extern struct cache_entry **active_cache;
133extern unsigned int active_nr, active_alloc, active_cache_changed;
e83c5163 134
8ac069ac
JH
135#define GIT_DIR_ENVIRONMENT "GIT_DIR"
136#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 137#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 138#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
5da5c8f4 139#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
bb233d69 140
5da1606d 141extern char *get_git_dir(void);
8ac069ac 142extern char *get_object_directory(void);
95fc7512 143extern char *get_refs_directory(void);
8ac069ac 144extern char *get_index_file(void);
5da5c8f4 145extern char *get_graft_file(void);
8ac069ac
JH
146
147#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 148
6b5ee137 149extern const char **get_pathspec(const char *prefix, const char **pathspec);
4ca06608 150extern const char *setup_git_directory_gently(int *);
d288a700 151extern const char *setup_git_directory(void);
6b5ee137 152extern const char *prefix_path(const char *prefix, int len, const char *path);
4ca06608 153extern const char *prefix_filename(const char *prefix, int len, const char *path);
d288a700 154
e83c5163
LT
155#define alloc_nr(x) (((x)+16)*3/2)
156
734aab75 157/* Initialize and use the cache information */
e83c5163 158extern int read_cache(void);
197ee8c9 159extern int write_cache(int newfd, struct cache_entry **cache, int entries);
eb38c22f 160extern int cache_name_pos(const char *name, int namelen);
192268c1
JH
161#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
162#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 163#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
192268c1 164extern int add_cache_entry(struct cache_entry *ce, int option);
dbbce55b 165extern int remove_cache_entry_at(int pos);
6b5ee137 166extern int remove_file_from_cache(const char *path);
dbbce55b 167extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
5d728c84 168extern int ce_match_stat(struct cache_entry *ce, struct stat *st);
b0391890 169extern int ce_modified(struct cache_entry *ce, struct stat *st);
c0fd1f51 170extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
7672db20 171extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
ec1fcc16 172extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
415e96c8
JH
173extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
174
175struct cache_file {
176 struct cache_file *next;
177 char lockfile[PATH_MAX];
178};
179extern int hold_index_file_for_update(struct cache_file *, const char *path);
180extern int commit_index_file(struct cache_file *);
181extern void rollback_index_file(struct cache_file *);
734aab75 182
17712991 183extern int trust_executable_bit;
f8348be3 184extern int only_use_symrefs;
3299c6f6 185extern int diff_rename_limit_default;
17712991 186
ab9cb76f
JH
187#define GIT_REPO_VERSION 0
188extern int repository_format_version;
189extern int check_repository_format(void);
190
734aab75
LT
191#define MTIME_CHANGED 0x0001
192#define CTIME_CHANGED 0x0002
193#define OWNER_CHANGED 0x0004
194#define MODE_CHANGED 0x0008
195#define INODE_CHANGED 0x0010
196#define DATA_CHANGED 0x0020
8ae0a8c5 197#define TYPE_CHANGED 0x0040
e83c5163
LT
198
199/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0
TS
200extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
201extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
73134b6d 202extern char *sha1_file_name(const unsigned char *sha1);
bf592c50
DB
203extern char *sha1_pack_name(const unsigned char *sha1);
204extern char *sha1_pack_index_name(const unsigned char *sha1);
013f276e 205extern const char *find_unique_abbrev(const unsigned char *sha1, int);
88cd621d 206extern const unsigned char null_sha1[20];
e83c5163 207
f2db68ed
HE
208int git_mkstemp(char *path, size_t n, const char *template);
209
b2cb9425 210int safe_create_leading_directories(char *path);
f2db68ed 211char *safe_strncpy(char *, const char *, size_t);
bd22c904 212char *enter_repo(char *path, int strict);
b2cb9425 213
e83c5163 214/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
c4483576 215extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
5180cacc 216extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
36e4d74a 217extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
2ade9340 218extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
73134b6d 219extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
bf0f910d 220extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
7672db20
BL
221extern char *write_sha1_file_prepare(void *buf,
222 unsigned long len,
223 const char *type,
224 unsigned char *sha1,
225 unsigned char *hdr,
226 int *hdrlen);
8237b185 227
5d6ccf5c 228extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 229
94537c78 230/* Read a tree into the cache */
3e587635 231extern int read_tree(void *buffer, unsigned long size, int stage, const char **paths);
94537c78 232
70b9829e
DB
233extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
234 size_t bufsize, size_t *bufposn);
a5eda52b 235extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
b721e01f 236extern int move_temp_to_file(const char *tmpfile, char *filename);
8237b185 237
dade09c2 238extern int has_sha1_pack(const unsigned char *sha1);
8237b185
DB
239extern int has_sha1_file(const unsigned char *sha1);
240
bf592c50
DB
241extern int has_pack_file(const unsigned char *sha1);
242extern int has_pack_index(const unsigned char *sha1);
243
e83c5163 244/* Convert to/from hex/sha1 representation */
3c249c95 245extern int get_sha1(const char *str, unsigned char *sha1);
197ee8c9
LT
246extern int get_sha1_hex(const char *hex, unsigned char *sha1);
247extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
ca8db142 248extern int read_ref(const char *filename, unsigned char *sha1);
a876ed83 249extern const char *resolve_ref(const char *path, unsigned char *sha1, int);
8098a178
JH
250extern int create_symref(const char *git_HEAD, const char *refs_heads_master);
251extern int validate_symref(const char *git_HEAD);
e83c5163
LT
252
253/* General helper functions */
90334cf7 254extern void usage(const char *err) NORETURN;
4ec99bf0
TS
255extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
256extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
2de381f9 257
958ba6c9 258extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 259extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
e83c5163 260
40469ee9 261extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 262 const char *required_type,
40469ee9
JH
263 unsigned long *size,
264 unsigned char *sha1_ret);
f4913f91 265
f80cd783 266const char *show_date(unsigned long time, int timezone);
2a39064c 267int parse_date(const char *date, char *buf, int bufsize);
ecee9d9e 268void datestamp(char *buf, int bufsize);
3c07b1d1 269unsigned long approxidate(const char *);
ecee9d9e 270
6aa33f40 271extern int setup_ident(void);
c7d77dab
JH
272extern const char *git_author_info(void);
273extern const char *git_committer_info(void);
6aa33f40 274
127cfd0d 275static inline void *xmalloc(size_t size)
812666c8
CL
276{
277 void *ret = malloc(size);
278 if (!ret)
279 die("Out of memory, malloc failed");
280 return ret;
281}
282
127cfd0d 283static inline void *xrealloc(void *ptr, size_t size)
812666c8
CL
284{
285 void *ret = realloc(ptr, size);
286 if (!ret)
287 die("Out of memory, realloc failed");
288 return ret;
289}
290
127cfd0d
BR
291static inline void *xcalloc(size_t nmemb, size_t size)
292{
293 void *ret = calloc(nmemb, size);
294 if (!ret)
295 die("Out of memory, calloc failed");
296 return ret;
297}
298
12dccc16
LT
299struct 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;
306};
307
308extern int checkout_entry(struct cache_entry *ce, struct checkout *state);
309
9a217f2a 310extern struct alternate_object_database {
d5a63b99 311 struct alternate_object_database *next;
9a217f2a 312 char *name;
2c04662d 313 char base[0]; /* more */
d5a63b99 314} *alt_odb_list;
9a217f2a
JH
315extern void prepare_alt_odb(void);
316
317extern 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;
f9253394 324 unsigned int pack_use_cnt;
9d835df2 325 int pack_local;
bf592c50 326 unsigned char sha1[20];
2c04662d 327 char pack_name[0]; /* something like ".git/objects/pack/xxxxx.pack" */
9a217f2a 328} *packed_git;
f3bf9224
JH
329
330struct pack_entry {
331 unsigned int offset;
332 unsigned char sha1[20];
333 struct packed_git *p;
334};
335
d1c133f5
LT
336struct ref {
337 struct ref *next;
338 unsigned char old_sha1[20];
339 unsigned char new_sha1[20];
ff27adf3 340 unsigned char force;
f88395ac 341 struct ref *peer_ref; /* when renaming */
2c04662d 342 char name[0];
d1c133f5
LT
343};
344
f7192598
LT
345extern int git_connect(int fd[2], char *url, const char *prog);
346extern int finish_connect(pid_t pid);
013e7c7f 347extern int path_match(const char *path, int nr, char **match);
f88395ac
JH
348extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
349 int nr_refspec, char **refspec, int all);
41cb7488 350extern int get_ack(int fd, unsigned char *result_sha1);
1a7141ff 351extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, int ignore_funny);
211b5f9e 352extern int server_supports(const char *feature);
f7192598 353
bf592c50 354extern struct packed_git *parse_pack_index(unsigned char *sha1);
2ab141a2 355extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
c508df5e 356 char *idx_path);
bf592c50 357
9a217f2a 358extern void prepare_packed_git(void);
bf592c50
DB
359extern void install_packed_git(struct packed_git *pack);
360
361extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
362 struct packed_git *packs);
363
f9253394
JH
364extern int use_packed_git(struct packed_git *);
365extern void unuse_packed_git(struct packed_git *);
9d835df2 366extern struct packed_git *add_packed_git(char *, int, int);
9a217f2a
JH
367extern int num_packed_objects(const struct packed_git *p);
368extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
f3bf9224
JH
369extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
370extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
ad8c80a5 371extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, int *, unsigned char *);
9a217f2a 372
8f3f9b09
JH
373/* Dumb servers support */
374extern int update_server_info(int);
375
730d48a2
JS
376#ifdef NO_MMAP
377
378#ifndef PROT_READ
379#define PROT_READ 1
380#define PROT_WRITE 2
381#define MAP_PRIVATE 1
382#define MAP_FAILED ((void*)-1)
383#endif
384
385extern void *gitfakemmap(void *start, size_t length, int prot , int flags, int fd, off_t offset);
386extern int gitfakemunmap(void *start, size_t length);
387
388#endif
389
17712991
LT
390typedef int (*config_fn_t)(const char *, const char *);
391extern int git_default_config(const char *, const char *);
4f629539 392extern int git_config_from_file(config_fn_t fn, const char *);
17712991
LT
393extern int git_config(config_fn_t fn);
394extern int git_config_int(const char *, const char *);
395extern int git_config_bool(const char *, const char *);
10bea152 396extern int git_config_set(const char *, const char *);
4ddba79d 397extern int git_config_set_multivar(const char *, const char *, const char *, int);
ab9cb76f 398extern int check_repository_format_version(const char *var, const char *value);
17712991 399
e1b10391
LT
400#define MAX_GITNAME (1000)
401extern char git_default_email[MAX_GITNAME];
402extern char git_default_name[MAX_GITNAME];
403
4e72dcec
JH
404#define MAX_ENCODING_LENGTH 64
405extern char git_commit_encoding[MAX_ENCODING_LENGTH];
406
4546738b
LT
407/* Sane ctype - no locale, and works with signed chars */
408#undef isspace
409#undef isdigit
410#undef isalpha
411#undef isalnum
412#undef tolower
413#undef toupper
414extern unsigned char sane_ctype[256];
415#define GIT_SPACE 0x01
416#define GIT_DIGIT 0x02
417#define GIT_ALPHA 0x04
418#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
419#define isspace(x) sane_istest(x,GIT_SPACE)
420#define isdigit(x) sane_istest(x,GIT_DIGIT)
421#define isalpha(x) sane_istest(x,GIT_ALPHA)
422#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
423#define tolower(x) sane_case((unsigned char)(x), 0x20)
424#define toupper(x) sane_case((unsigned char)(x), 0)
425
426static inline int sane_case(int x, int high)
427{
428 if (sane_istest(x, GIT_ALPHA))
429 x = (x & ~0x20) | high;
430 return x;
431}
432
f3123c4a 433extern int copy_fd(int ifd, int ofd);
e83c5163 434#endif /* CACHE_H */