blob: 1d99d6817d8bcd629d01ca75daf0767e93376f11 [file] [log] [blame]
Linus Torvaldse83c5162005-04-07 22:13:131#ifndef CACHE_H
2#define CACHE_H
3
Linus Torvalds2dee0602005-04-20 20:00:084#include <unistd.h>
Linus Torvaldse83c5162005-04-07 22:13:135#include <stdio.h>
6#include <sys/stat.h>
7#include <fcntl.h>
8#include <stddef.h>
9#include <stdlib.h>
10#include <stdarg.h>
Linus Torvaldsbf0c6e82005-04-08 16:16:3811#include <string.h>
Linus Torvaldse83c5162005-04-07 22:13:1312#include <errno.h>
Linus Torvalds6b0c3122005-05-22 18:54:1713#include <limits.h>
Linus Torvaldse83c5162005-04-07 22:13:1314#include <sys/mman.h>
Linus Torvaldsbb233d62005-04-21 17:55:1815#include <sys/param.h>
Linus Torvaldsccc4feb2005-04-15 17:44:2716#include <netinet/in.h>
Linus Torvalds575f4972005-06-30 00:52:1117#include <sys/types.h>
18#include <dirent.h>
Linus Torvaldse83c5162005-04-07 22:13:1319
Linus Torvaldscef661f2005-04-21 19:33:2220#include SHA1_HEADER
Linus Torvaldse83c5162005-04-07 22:13:1321#include <zlib.h>
22
Edgar Toernig9da3acf2005-04-30 16:51:0323#if ZLIB_VERNUM < 0x1200
24#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
25#endif
26
Edgar Toernigb6829692005-04-30 16:51:0327#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
Junio C Hamanoa15c1c62005-05-13 00:16:0433#define DT_LNK 3
Edgar Toernigb6829692005-04-30 16:51:0334#define DTYPE(de) DT_UNKNOWN
35#endif
36
Linus Torvalds90334cf2005-06-06 17:12:3137#ifdef __GNUC__
38#define NORETURN __attribute__((__noreturn__))
39#else
40#define NORETURN
Timo Sirainen4ec99bf2005-08-09 15:30:2241#ifndef __attribute__
Jason Riedy75ea6912005-08-19 04:10:0842#define __attribute__(x)
Timo Sirainen4ec99bf2005-08-09 15:30:2243#endif
Junio C Hamanof1d090e2005-08-19 09:06:5244#endif
Timo Sirainen4ec99bf2005-08-09 15:30:2245
Linus Torvaldse83c5162005-04-07 22:13:1346/*
Linus Torvalds2386d652005-07-14 01:46:2047 * Intensive research over the course of many years has shown that
48 * port 9418 is totally unused by anything else. Or
49 *
50 * Your search - "port 9418" - did not match any documents.
51 *
52 * as www.google.com puts it.
Linus Torvaldsba8a4972005-09-12 18:23:0053 *
54 * This port has been properly assigned for git use by IANA:
55 * git (Assigned-9418) [I06-050728-0001].
56 *
57 * git 9418/tcp git pack transfer service
58 * git 9418/udp git pack transfer service
59 *
60 * with Linus Torvalds <torvalds@osdl.org> as the point of
61 * contact. September 2005.
62 *
63 * See http://www.iana.org/assignments/port-numbers
Linus Torvalds2386d652005-07-14 01:46:2064 */
65#define DEFAULT_GIT_PORT 9418
66
67/*
Linus Torvaldse83c5162005-04-07 22:13:1368 * Basic data structures for the directory cache
Linus Torvaldse83c5162005-04-07 22:13:1369 */
70
71#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
72struct cache_header {
Linus Torvaldsccc4feb2005-04-15 17:44:2773 unsigned int hdr_signature;
74 unsigned int hdr_version;
75 unsigned int hdr_entries;
Linus Torvaldse83c5162005-04-07 22:13:1376};
77
78/*
79 * The "cache_time" is just the low 32 bits of the
80 * time. It doesn't matter if it overflows - we only
81 * check it for equality in the 32 bits we save.
82 */
83struct cache_time {
84 unsigned int sec;
85 unsigned int nsec;
86};
87
88/*
89 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
90 * Again - this is just a (very strong in practice) heuristic that
91 * the inode hasn't changed.
Linus Torvaldsccc4feb2005-04-15 17:44:2792 *
93 * We save the fields in big-endian order to allow using the
94 * index file over NFS transparently.
Linus Torvaldse83c5162005-04-07 22:13:1395 */
96struct cache_entry {
Linus Torvaldsccc4feb2005-04-15 17:44:2797 struct cache_time ce_ctime;
98 struct cache_time ce_mtime;
99 unsigned int ce_dev;
100 unsigned int ce_ino;
101 unsigned int ce_mode;
102 unsigned int ce_uid;
103 unsigned int ce_gid;
104 unsigned int ce_size;
Linus Torvaldse83c5162005-04-07 22:13:13105 unsigned char sha1[20];
Linus Torvaldsf5cabd12005-04-16 04:45:38106 unsigned short ce_flags;
Junio C Hamano2c046622005-08-29 19:41:03107 char name[0];
Linus Torvaldse83c5162005-04-07 22:13:13108};
109
Linus Torvalds95fd5bf2005-04-16 05:51:44110#define CE_NAMEMASK (0x0fff)
111#define CE_STAGEMASK (0x3000)
Linus Torvalds220a0b52005-06-06 05:07:31112#define CE_UPDATE (0x4000)
Junio C Hamanoaee46192005-04-16 15:33:23113#define CE_STAGESHIFT 12
Linus Torvalds95fd5bf2005-04-16 05:51:44114
Junio C Hamanoaee46192005-04-16 15:33:23115#define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
116#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
117#define ce_size(ce) cache_entry_size(ce_namelen(ce))
118#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
119
Linus Torvaldse4479472005-04-17 05:26:31120#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
Kay Sievers8ae0a8c2005-05-05 12:38:25121static inline unsigned int create_ce_mode(unsigned int mode)
122{
Kay Sievers8ae0a8c2005-05-05 12:38:25123 if (S_ISLNK(mode))
124 return htonl(S_IFLNK);
Linus Torvaldsdb823d42005-05-05 23:01:46125 return htonl(S_IFREG | ce_permissions(mode));
Kay Sievers8ae0a8c2005-05-05 12:38:25126}
Linus Torvaldse4479472005-04-17 05:26:31127
Junio C Hamanoaee46192005-04-16 15:33:23128#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
Linus Torvaldsf5cabd12005-04-16 04:45:38129
Petr Baudis88355042005-05-10 22:58:16130extern struct cache_entry **active_cache;
131extern unsigned int active_nr, active_alloc, active_cache_changed;
Linus Torvaldse83c5162005-04-07 22:13:13132
Junio C Hamano8ac069a2005-05-10 05:57:58133#define GIT_DIR_ENVIRONMENT "GIT_DIR"
134#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
Junio C Hamanod19938a2005-05-10 00:57:56135#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
Linus Torvaldsbb233d62005-04-21 17:55:18136#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
Junio C Hamano5da5c8f2005-07-30 07:58:28137#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
Linus Torvaldsbb233d62005-04-21 17:55:18138
Junio C Hamano8ac069a2005-05-10 05:57:58139extern char *get_object_directory(void);
Daniel Barkalow95fc7512005-06-06 20:31:29140extern char *get_refs_directory(void);
Junio C Hamano8ac069a2005-05-10 05:57:58141extern char *get_index_file(void);
Junio C Hamano5da5c8f2005-07-30 07:58:28142extern char *get_graft_file(void);
Junio C Hamano8ac069a2005-05-10 05:57:58143
144#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
Linus Torvaldsbb233d62005-04-21 17:55:18145
Linus Torvaldsd288a702005-08-17 01:06:34146extern const char **get_pathspec(const char *prefix, char **pathspec);
147extern const char *setup_git_directory(void);
Linus Torvalds828cc612005-08-17 20:31:49148extern char *prefix_path(const char *prefix, int len, char *path);
Linus Torvaldsd288a702005-08-17 01:06:34149
Linus Torvaldse83c5162005-04-07 22:13:13150#define alloc_nr(x) (((x)+16)*3/2)
151
Linus Torvalds734aab72005-04-09 16:48:20152/* Initialize and use the cache information */
Linus Torvaldse83c5162005-04-07 22:13:13153extern int read_cache(void);
Linus Torvalds197ee8c2005-04-09 19:09:27154extern int write_cache(int newfd, struct cache_entry **cache, int entries);
Linus Torvaldseb38c222005-04-09 16:26:55155extern int cache_name_pos(const char *name, int namelen);
Junio C Hamano192268c2005-05-08 04:55:21156#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
157#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
Junio C Hamanob1557252005-06-25 09:25:29158#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
Junio C Hamano192268c2005-05-08 04:55:21159extern int add_cache_entry(struct cache_entry *ce, int option);
Brad Robertsdbbce552005-05-15 02:04:25160extern int remove_cache_entry_at(int pos);
Linus Torvalds197ee8c2005-04-09 19:09:27161extern int remove_file_from_cache(char *path);
Brad Robertsdbbce552005-05-15 02:04:25162extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
Brad Roberts5d728c82005-05-15 02:04:25163extern int ce_match_stat(struct cache_entry *ce, struct stat *st);
Linus Torvaldsc0fd1f52005-07-14 23:55:06164extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
Bryan Larsen7672db22005-07-08 23:51:55165extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
Junio C Hamano415e96c2005-05-15 21:23:12166extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
167
168struct cache_file {
169 struct cache_file *next;
170 char lockfile[PATH_MAX];
171};
172extern int hold_index_file_for_update(struct cache_file *, const char *path);
173extern int commit_index_file(struct cache_file *);
174extern void rollback_index_file(struct cache_file *);
Linus Torvalds734aab72005-04-09 16:48:20175
176#define MTIME_CHANGED 0x0001
177#define CTIME_CHANGED 0x0002
178#define OWNER_CHANGED 0x0004
179#define MODE_CHANGED 0x0008
180#define INODE_CHANGED 0x0010
181#define DATA_CHANGED 0x0020
Kay Sievers8ae0a8c2005-05-05 12:38:25182#define TYPE_CHANGED 0x0040
Linus Torvaldse83c5162005-04-07 22:13:13183
184/* Return a statically allocated filename matching the sha1 signature */
Timo Sirainen4ec99bf2005-08-09 15:30:22185extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
186extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
Linus Torvalds73134b62005-04-10 21:03:58187extern char *sha1_file_name(const unsigned char *sha1);
barkalow@iabervon.orgbf592c52005-08-01 00:53:44188extern char *sha1_pack_name(const unsigned char *sha1);
189extern char *sha1_pack_index_name(const unsigned char *sha1);
Linus Torvaldse83c5162005-04-07 22:13:13190
Holger Eitzenbergerf2db68e2005-08-04 20:43:03191int git_mkstemp(char *path, size_t n, const char *template);
192
Junio C Hamanob2cb9422005-07-06 08:11:52193int safe_create_leading_directories(char *path);
Holger Eitzenbergerf2db68e2005-08-04 20:43:03194char *safe_strncpy(char *, const char *, size_t);
Junio C Hamanob2cb9422005-07-06 08:11:52195
Linus Torvaldse83c5162005-04-07 22:13:13196/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
Linus Torvaldsc4483572005-06-02 00:54:59197extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
Linus Torvalds5180cac2005-06-02 14:57:25198extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
Junio C Hamano36e4d742005-06-27 10:34:06199extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
Linus Torvalds2ade9342005-04-08 22:01:15200extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
Linus Torvalds73134b62005-04-10 21:03:58201extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
Brian Gerstbf0f9102005-05-18 12:14:09202extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
Bryan Larsen7672db22005-07-08 23:51:55203extern char *write_sha1_file_prepare(void *buf,
204 unsigned long len,
205 const char *type,
206 unsigned char *sha1,
207 unsigned char *hdr,
208 int *hdrlen);
Daniel Barkalow8237b182005-04-24 01:47:23209
Jason McMullan5d6ccf52005-06-03 15:05:39210extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
Linus Torvaldse83c5162005-04-07 22:13:13211
Linus Torvalds94537c72005-04-22 23:42:37212/* Read a tree into the cache */
Linus Torvalds3e587632005-07-14 18:39:27213extern int read_tree(void *buffer, unsigned long size, int stage, const char **paths);
Linus Torvalds94537c72005-04-22 23:42:37214
barkalow@iabervon.org70b98292005-08-02 23:46:29215extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
216 size_t bufsize, size_t *bufposn);
Daniel Barkalowa5eda522005-07-10 22:25:38217extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
Daniel Barkalow8237b182005-04-24 01:47:23218
Linus Torvaldsdade09c2005-07-03 20:06:36219extern int has_sha1_pack(const unsigned char *sha1);
Daniel Barkalow8237b182005-04-24 01:47:23220extern int has_sha1_file(const unsigned char *sha1);
221
barkalow@iabervon.orgbf592c52005-08-01 00:53:44222extern int has_pack_file(const unsigned char *sha1);
223extern int has_pack_index(const unsigned char *sha1);
224
Linus Torvaldse83c5162005-04-07 22:13:13225/* Convert to/from hex/sha1 representation */
Linus Torvalds3c249c92005-05-01 23:36:56226extern int get_sha1(const char *str, unsigned char *sha1);
Linus Torvalds197ee8c2005-04-09 19:09:27227extern int get_sha1_hex(const char *hex, unsigned char *sha1);
228extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
Linus Torvaldse83c5162005-04-07 22:13:13229
230/* General helper functions */
Linus Torvalds90334cf2005-06-06 17:12:31231extern void usage(const char *err) NORETURN;
Timo Sirainen4ec99bf2005-08-09 15:30:22232extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
233extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
Petr Baudis2de381f2005-04-13 09:28:48234
Linus Torvalds958ba6c2005-05-20 16:09:18235extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
Linus Torvalds79517a02005-04-09 19:59:11236extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
Linus Torvaldse83c5162005-04-07 22:13:13237
Junio C Hamano40469ee2005-04-28 23:42:27238extern void *read_object_with_reference(const unsigned char *sha1,
Brian Gerstbf0f9102005-05-18 12:14:09239 const char *required_type,
Junio C Hamano40469ee2005-04-28 23:42:27240 unsigned long *size,
241 unsigned char *sha1_ret);
Junio C Hamanof4913f92005-04-21 01:06:49242
Linus Torvaldsf80cd782005-05-06 22:28:59243const char *show_date(unsigned long time, int timezone);
Linus Torvalds26a2d8a2005-07-12 17:33:06244void parse_date(const char *date, char *buf, int bufsize);
Edgar Toernigecee9d92005-04-30 16:46:49245void datestamp(char *buf, int bufsize);
246
Linus Torvalds6aa33f42005-07-12 18:49:27247extern int setup_ident(void);
248extern char *get_ident(const char *name, const char *email, const char *date_str);
Eric W. Biedermand289d132005-07-15 00:50:33249extern char *git_author_info(void);
250extern char *git_committer_info(void);
Linus Torvalds6aa33f42005-07-12 18:49:27251
Brad Roberts127cfd02005-05-15 02:04:25252static inline void *xmalloc(size_t size)
Christopher Li812666c2005-04-26 19:00:58253{
254 void *ret = malloc(size);
255 if (!ret)
256 die("Out of memory, malloc failed");
257 return ret;
258}
259
Brad Roberts127cfd02005-05-15 02:04:25260static inline void *xrealloc(void *ptr, size_t size)
Christopher Li812666c2005-04-26 19:00:58261{
262 void *ret = realloc(ptr, size);
263 if (!ret)
264 die("Out of memory, realloc failed");
265 return ret;
266}
267
Brad Roberts127cfd02005-05-15 02:04:25268static inline void *xcalloc(size_t nmemb, size_t size)
269{
270 void *ret = calloc(nmemb, size);
271 if (!ret)
272 die("Out of memory, calloc failed");
273 return ret;
274}
275
Linus Torvalds12dccc12005-06-06 04:59:54276struct checkout {
277 const char *base_dir;
278 int base_dir_len;
279 unsigned force:1,
280 quiet:1,
281 not_new:1,
282 refresh_cache:1;
283};
284
285extern int checkout_entry(struct cache_entry *ce, struct checkout *state);
286
Junio C Hamano9a217f22005-06-28 21:56:57287extern struct alternate_object_database {
Junio C Hamanod5a63b92005-08-15 00:25:57288 struct alternate_object_database *next;
Junio C Hamano9a217f22005-06-28 21:56:57289 char *name;
Junio C Hamano2c046622005-08-29 19:41:03290 char base[0]; /* more */
Junio C Hamanod5a63b92005-08-15 00:25:57291} *alt_odb_list;
Junio C Hamano9a217f22005-06-28 21:56:57292extern void prepare_alt_odb(void);
293
294extern struct packed_git {
295 struct packed_git *next;
296 unsigned long index_size;
297 unsigned long pack_size;
298 unsigned int *index_base;
299 void *pack_base;
300 unsigned int pack_last_used;
Junio C Hamanof9253392005-06-29 09:51:27301 unsigned int pack_use_cnt;
barkalow@iabervon.orgbf592c52005-08-01 00:53:44302 unsigned char sha1[20];
Junio C Hamano2c046622005-08-29 19:41:03303 char pack_name[0]; /* something like ".git/objects/pack/xxxxx.pack" */
Junio C Hamano9a217f22005-06-28 21:56:57304} *packed_git;
Junio C Hamanof3bf9222005-07-01 00:15:39305
306struct pack_entry {
307 unsigned int offset;
308 unsigned char sha1[20];
309 struct packed_git *p;
310};
311
Linus Torvaldsd1c133f2005-07-16 20:55:50312struct ref {
313 struct ref *next;
314 unsigned char old_sha1[20];
315 unsigned char new_sha1[20];
Junio C Hamanoff27adf2005-08-24 07:40:14316 unsigned char force;
Junio C Hamanof88395a2005-08-03 23:35:29317 struct ref *peer_ref; /* when renaming */
Junio C Hamano2c046622005-08-29 19:41:03318 char name[0];
Linus Torvaldsd1c133f2005-07-16 20:55:50319};
320
Linus Torvaldsf7192592005-07-04 18:57:58321extern int git_connect(int fd[2], char *url, const char *prog);
322extern int finish_connect(pid_t pid);
Linus Torvalds013e7c72005-07-04 20:24:30323extern int path_match(const char *path, int nr, char **match);
Junio C Hamanof88395a2005-08-03 23:35:29324extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
325 int nr_refspec, char **refspec, int all);
Linus Torvalds41cb7482005-07-05 22:44:09326extern int get_ack(int fd, unsigned char *result_sha1);
Linus Torvaldsd1c133f2005-07-16 20:55:50327extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match);
Linus Torvaldsf7192592005-07-04 18:57:58328
barkalow@iabervon.orgbf592c52005-08-01 00:53:44329extern struct packed_git *parse_pack_index(unsigned char *sha1);
Peter Hagervall2ab141a2005-09-02 12:17:10330extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
Daniel Barkalowc508df52005-08-16 04:10:03331 char *idx_path);
barkalow@iabervon.orgbf592c52005-08-01 00:53:44332
Junio C Hamano9a217f22005-06-28 21:56:57333extern void prepare_packed_git(void);
barkalow@iabervon.orgbf592c52005-08-01 00:53:44334extern void install_packed_git(struct packed_git *pack);
335
336extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
337 struct packed_git *packs);
338
Junio C Hamanof9253392005-06-29 09:51:27339extern int use_packed_git(struct packed_git *);
340extern void unuse_packed_git(struct packed_git *);
341extern struct packed_git *add_packed_git(char *, int);
Junio C Hamano9a217f22005-06-28 21:56:57342extern int num_packed_objects(const struct packed_git *p);
343extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
Junio C Hamanof3bf9222005-07-01 00:15:39344extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
345extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
Junio C Hamanoad8c80a2005-07-01 00:17:20346extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, int *, unsigned char *);
Junio C Hamano9a217f22005-06-28 21:56:57347
Junio C Hamano8f3f9b02005-07-24 00:54:41348/* Dumb servers support */
349extern int update_server_info(int);
350
Linus Torvaldse83c5162005-04-07 22:13:13351#endif /* CACHE_H */