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