Add "mkpath()" helper function
[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>
e83c5163 14#include <sys/mman.h>
bb233d69 15#include <sys/param.h>
ccc4feb5 16#include <netinet/in.h>
575f4974
LT
17#include <sys/types.h>
18#include <dirent.h>
e83c5163 19
cef661fc 20#include SHA1_HEADER
e83c5163
LT
21#include <zlib.h>
22
9da3acfb
ET
23#if ZLIB_VERNUM < 0x1200
24#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
25#endif
26
b6829693
ET
27#ifdef DT_UNKNOWN
28#define DTYPE(de) ((de)->d_type)
29#else
30#define DT_UNKNOWN 0
31#define DT_DIR 1
32#define DT_REG 2
a15c1c60 33#define DT_LNK 3
b6829693
ET
34#define DTYPE(de) DT_UNKNOWN
35#endif
36
90334cf7
LT
37#ifdef __GNUC__
38#define NORETURN __attribute__((__noreturn__))
39#else
40#define NORETURN
41#endif
42
d19938ab
JH
43/*
44 * Environment variables transition.
45 * We accept older names for now but warn.
46 */
47extern char *gitenv_bc(const char *);
48#define gitenv(e) (getenv(e) ? : gitenv_bc(e))
49
e83c5163
LT
50/*
51 * Basic data structures for the directory cache
e83c5163
LT
52 */
53
54#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
55struct cache_header {
ccc4feb5
LT
56 unsigned int hdr_signature;
57 unsigned int hdr_version;
58 unsigned int hdr_entries;
e83c5163
LT
59};
60
61/*
62 * The "cache_time" is just the low 32 bits of the
63 * time. It doesn't matter if it overflows - we only
64 * check it for equality in the 32 bits we save.
65 */
66struct cache_time {
67 unsigned int sec;
68 unsigned int nsec;
69};
70
71/*
72 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
73 * Again - this is just a (very strong in practice) heuristic that
74 * the inode hasn't changed.
ccc4feb5
LT
75 *
76 * We save the fields in big-endian order to allow using the
77 * index file over NFS transparently.
e83c5163
LT
78 */
79struct cache_entry {
ccc4feb5
LT
80 struct cache_time ce_ctime;
81 struct cache_time ce_mtime;
82 unsigned int ce_dev;
83 unsigned int ce_ino;
84 unsigned int ce_mode;
85 unsigned int ce_uid;
86 unsigned int ce_gid;
87 unsigned int ce_size;
e83c5163 88 unsigned char sha1[20];
f5cabd13 89 unsigned short ce_flags;
59c1e249 90 char name[0];
e83c5163
LT
91};
92
95fd5bf8
LT
93#define CE_NAMEMASK (0x0fff)
94#define CE_STAGEMASK (0x3000)
220a0b52 95#define CE_UPDATE (0x4000)
aee46198 96#define CE_STAGESHIFT 12
95fd5bf8 97
aee46198
JH
98#define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
99#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
100#define ce_size(ce) cache_entry_size(ce_namelen(ce))
101#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
102
e4479470 103#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5
KS
104static inline unsigned int create_ce_mode(unsigned int mode)
105{
8ae0a8c5
KS
106 if (S_ISLNK(mode))
107 return htonl(S_IFLNK);
db823d4a 108 return htonl(S_IFREG | ce_permissions(mode));
8ae0a8c5 109}
e4479470 110
aee46198 111#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
f5cabd13 112
88355048
PB
113extern struct cache_entry **active_cache;
114extern unsigned int active_nr, active_alloc, active_cache_changed;
e83c5163 115
8ac069ac
JH
116#define GIT_DIR_ENVIRONMENT "GIT_DIR"
117#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab 118#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69 119#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
bb233d69 120
8ac069ac 121extern char *get_object_directory(void);
95fc7512 122extern char *get_refs_directory(void);
8ac069ac
JH
123extern char *get_index_file(void);
124
125#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69 126
e83c5163
LT
127#define alloc_nr(x) (((x)+16)*3/2)
128
734aab75 129/* Initialize and use the cache information */
e83c5163 130extern int read_cache(void);
197ee8c9 131extern int write_cache(int newfd, struct cache_entry **cache, int entries);
eb38c22f 132extern int cache_name_pos(const char *name, int namelen);
192268c1
JH
133#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
134#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d 135#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
192268c1 136extern int add_cache_entry(struct cache_entry *ce, int option);
dbbce55b 137extern int remove_cache_entry_at(int pos);
197ee8c9 138extern int remove_file_from_cache(char *path);
dbbce55b 139extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
5d728c84 140extern int ce_match_stat(struct cache_entry *ce, struct stat *st);
74400e71 141extern int index_fd(unsigned char *sha1, int fd, struct stat *st);
415e96c8
JH
142extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
143
144struct cache_file {
145 struct cache_file *next;
146 char lockfile[PATH_MAX];
147};
148extern int hold_index_file_for_update(struct cache_file *, const char *path);
149extern int commit_index_file(struct cache_file *);
150extern void rollback_index_file(struct cache_file *);
734aab75
LT
151
152#define MTIME_CHANGED 0x0001
153#define CTIME_CHANGED 0x0002
154#define OWNER_CHANGED 0x0004
155#define MODE_CHANGED 0x0008
156#define INODE_CHANGED 0x0010
157#define DATA_CHANGED 0x0020
8ae0a8c5 158#define TYPE_CHANGED 0x0040
e83c5163
LT
159
160/* Return a statically allocated filename matching the sha1 signature */
26c8a533 161extern char *mkpath(const char *fmt, ...);
723c31fe 162extern char *git_path(const char *fmt, ...);
73134b6d 163extern char *sha1_file_name(const unsigned char *sha1);
e83c5163 164
b2cb9425
JH
165int safe_create_leading_directories(char *path);
166
e83c5163 167/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
73134b6d 168extern void * map_sha1_file(const unsigned char *sha1, unsigned long *size);
c4483576 169extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
5180cacc 170extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
36e4d74a 171extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
2ade9340 172extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
73134b6d 173extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
bf0f910d 174extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
8237b185 175
5d6ccf5c 176extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
e83c5163 177
94537c78
LT
178/* Read a tree into the cache */
179extern int read_tree(void *buffer, unsigned long size, int stage);
180
8237b185
DB
181extern int write_sha1_from_fd(const unsigned char *sha1, int fd);
182
dade09c2 183extern int has_sha1_pack(const unsigned char *sha1);
8237b185
DB
184extern int has_sha1_file(const unsigned char *sha1);
185
e83c5163 186/* Convert to/from hex/sha1 representation */
3c249c95 187extern int get_sha1(const char *str, unsigned char *sha1);
197ee8c9
LT
188extern int get_sha1_hex(const char *hex, unsigned char *sha1);
189extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
e83c5163
LT
190
191/* General helper functions */
90334cf7
LT
192extern void usage(const char *err) NORETURN;
193extern void die(const char *err, ...) NORETURN;
2de381f9
PB
194extern int error(const char *err, ...);
195
958ba6c9 196extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
79517a06 197extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
e83c5163 198
40469ee9 199extern void *read_object_with_reference(const unsigned char *sha1,
bf0f910d 200 const char *required_type,
40469ee9
JH
201 unsigned long *size,
202 unsigned char *sha1_ret);
f4913f91 203
f80cd783 204const char *show_date(unsigned long time, int timezone);
ecee9d9e
ET
205void parse_date(char *date, char *buf, int bufsize);
206void datestamp(char *buf, int bufsize);
207
127cfd0d 208static inline void *xmalloc(size_t size)
812666c8
CL
209{
210 void *ret = malloc(size);
211 if (!ret)
212 die("Out of memory, malloc failed");
213 return ret;
214}
215
127cfd0d 216static inline void *xrealloc(void *ptr, size_t size)
812666c8
CL
217{
218 void *ret = realloc(ptr, size);
219 if (!ret)
220 die("Out of memory, realloc failed");
221 return ret;
222}
223
127cfd0d
BR
224static inline void *xcalloc(size_t nmemb, size_t size)
225{
226 void *ret = calloc(nmemb, size);
227 if (!ret)
228 die("Out of memory, calloc failed");
229 return ret;
230}
231
12dccc16
LT
232struct checkout {
233 const char *base_dir;
234 int base_dir_len;
235 unsigned force:1,
236 quiet:1,
237 not_new:1,
238 refresh_cache:1;
239};
240
241extern int checkout_entry(struct cache_entry *ce, struct checkout *state);
242
9a217f2a
JH
243extern struct alternate_object_database {
244 char *base;
245 char *name;
246} *alt_odb;
247extern void prepare_alt_odb(void);
248
249extern struct packed_git {
250 struct packed_git *next;
251 unsigned long index_size;
252 unsigned long pack_size;
253 unsigned int *index_base;
254 void *pack_base;
255 unsigned int pack_last_used;
f9253394 256 unsigned int pack_use_cnt;
9a217f2a
JH
257 char pack_name[0]; /* something like ".git/objects/pack/xxxxx.pack" */
258} *packed_git;
f3bf9224
JH
259
260struct pack_entry {
261 unsigned int offset;
262 unsigned char sha1[20];
263 struct packed_git *p;
264};
265
f7192598
LT
266extern int git_connect(int fd[2], char *url, const char *prog);
267extern int finish_connect(pid_t pid);
013e7c7f 268extern int path_match(const char *path, int nr, char **match);
41cb7488 269extern int get_ack(int fd, unsigned char *result_sha1);
f7192598 270
9a217f2a 271extern void prepare_packed_git(void);
f9253394
JH
272extern int use_packed_git(struct packed_git *);
273extern void unuse_packed_git(struct packed_git *);
274extern struct packed_git *add_packed_git(char *, int);
9a217f2a
JH
275extern int num_packed_objects(const struct packed_git *p);
276extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
f3bf9224
JH
277extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
278extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
ad8c80a5 279extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, int *, unsigned char *);
9a217f2a 280
e83c5163 281#endif /* CACHE_H */