[thirdparty/git.git] / cache.h

#ifndef CACHE_H
#define CACHE_H

#include <unistd.h>
#include <stdio.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <stddef.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <errno.h>
#include <limits.h>
#include <sys/mman.h>
#include <sys/param.h>
#include <netinet/in.h>

#include SHA1_HEADER
#include <zlib.h>

#if ZLIB_VERNUM < 0x1200
#define deflateBound(c,s)  ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
#endif

#ifdef DT_UNKNOWN
#define DTYPE(de)	((de)->d_type)
#else
#define DT_UNKNOWN	0
#define DT_DIR		1
#define DT_REG		2
#define DT_LNK		3
#define DTYPE(de)	DT_UNKNOWN
#endif

#ifdef __GNUC__
#define NORETURN __attribute__((__noreturn__))
#else
#define NORETURN
#endif

/*
 * Environment variables transition.
 * We accept older names for now but warn.
 */
extern char *gitenv_bc(const char *);
#define gitenv(e) (getenv(e) ? : gitenv_bc(e))

/*
 * Basic data structures for the directory cache
 */

#define CACHE_SIGNATURE 0x44495243	/* "DIRC" */
struct cache_header {
	unsigned int hdr_signature;
	unsigned int hdr_version;
	unsigned int hdr_entries;
};

/*
 * The "cache_time" is just the low 32 bits of the
 * time. It doesn't matter if it overflows - we only
 * check it for equality in the 32 bits we save.
 */
struct cache_time {
	unsigned int sec;
	unsigned int nsec;
};

/*
 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
 * Again - this is just a (very strong in practice) heuristic that
 * the inode hasn't changed.
 *
 * We save the fields in big-endian order to allow using the
 * index file over NFS transparently.
 */
struct cache_entry {
	struct cache_time ce_ctime;
	struct cache_time ce_mtime;
	unsigned int ce_dev;
	unsigned int ce_ino;
	unsigned int ce_mode;
	unsigned int ce_uid;
	unsigned int ce_gid;
	unsigned int ce_size;
	unsigned char sha1[20];
	unsigned short ce_flags;
	char name[0];
};

#define CE_NAMEMASK  (0x0fff)
#define CE_STAGEMASK (0x3000)
#define CE_UPDATE    (0x4000)
#define CE_STAGESHIFT 12

#define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
#define ce_size(ce) cache_entry_size(ce_namelen(ce))
#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)

#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
static inline unsigned int create_ce_mode(unsigned int mode)
{
	if (S_ISLNK(mode))
		return htonl(S_IFLNK);
	return htonl(S_IFREG | ce_permissions(mode));
}

#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)

extern struct cache_entry **active_cache;
extern unsigned int active_nr, active_alloc, active_cache_changed;

#define GIT_DIR_ENVIRONMENT "GIT_DIR"
#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"

extern char *get_object_directory(void);
extern char *get_refs_directory(void);
extern char *get_index_file(void);

#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"

#define alloc_nr(x) (((x)+16)*3/2)

/* Initialize and use the cache information */
extern int read_cache(void);
extern int write_cache(int newfd, struct cache_entry **cache, int entries);
extern int cache_name_pos(const char *name, int namelen);
#define ADD_CACHE_OK_TO_ADD 1		/* Ok to add */
#define ADD_CACHE_OK_TO_REPLACE 2	/* Ok to replace file/directory */
extern int add_cache_entry(struct cache_entry *ce, int option);
extern int remove_cache_entry_at(int pos);
extern int remove_file_from_cache(char *path);
extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
extern int ce_match_stat(struct cache_entry *ce, struct stat *st);
extern int index_fd(unsigned char *sha1, int fd, struct stat *st);
extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);

struct cache_file {
	struct cache_file *next;
	char lockfile[PATH_MAX];
};
extern int hold_index_file_for_update(struct cache_file *, const char *path);
extern int commit_index_file(struct cache_file *);
extern void rollback_index_file(struct cache_file *);

#define MTIME_CHANGED	0x0001
#define CTIME_CHANGED	0x0002
#define OWNER_CHANGED	0x0004
#define MODE_CHANGED    0x0008
#define INODE_CHANGED   0x0010
#define DATA_CHANGED    0x0020
#define TYPE_CHANGED    0x0040

/* Return a statically allocated filename matching the sha1 signature */
extern char *sha1_file_name(const unsigned char *sha1);

/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
extern void * map_sha1_file(const unsigned char *sha1, unsigned long *size);
extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
extern int sha1_delta_base(const unsigned char *, unsigned char *);
extern int sha1_file_size(const unsigned char *, unsigned long *);
extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);

extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);

/* Read a tree into the cache */
extern int read_tree(void *buffer, unsigned long size, int stage);

extern int write_sha1_from_fd(const unsigned char *sha1, int fd);

extern int has_sha1_file(const unsigned char *sha1);

/* Convert to/from hex/sha1 representation */
extern int get_sha1(const char *str, unsigned char *sha1);
extern int get_sha1_hex(const char *hex, unsigned char *sha1);
extern char *sha1_to_hex(const unsigned char *sha1);	/* static buffer result! */

/* General helper functions */
extern void usage(const char *err) NORETURN;
extern void die(const char *err, ...) NORETURN;
extern int error(const char *err, ...);

extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);

extern void *read_object_with_reference(const unsigned char *sha1,
					const char *required_type,
					unsigned long *size,
					unsigned char *sha1_ret);

const char *show_date(unsigned long time, int timezone);
void parse_date(char *date, char *buf, int bufsize);
void datestamp(char *buf, int bufsize);

static inline void *xmalloc(size_t size)
{
	void *ret = malloc(size);
	if (!ret)
		die("Out of memory, malloc failed");
	return ret;
}

static inline void *xrealloc(void *ptr, size_t size)
{
	void *ret = realloc(ptr, size);
	if (!ret)
		die("Out of memory, realloc failed");
	return ret;
}

static inline void *xcalloc(size_t nmemb, size_t size)
{
	void *ret = calloc(nmemb, size);
	if (!ret)
		die("Out of memory, calloc failed");
	return ret;
}

struct checkout {
	const char *base_dir;
	int base_dir_len;
	unsigned force:1,
		 quiet:1,
		 not_new:1,
		 refresh_cache:1;
};

extern int checkout_entry(struct cache_entry *ce, struct checkout *state);

#endif /* CACHE_H */
Commit	Line	Data
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>
e83c5163	17
cef661fc	18	#include SHA1_HEADER
e83c5163 LT	19	#include <zlib.h>
e83c5163 LT	20
9da3acfb ET	21	#if ZLIB_VERNUM < 0x1200
	22	#define deflateBound(c,s) ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
	23	#endif
	24
b6829693 ET	25	#ifdef DT_UNKNOWN
	26	#define DTYPE(de) ((de)->d_type)
	27	#else
	28	#define DT_UNKNOWN 0
	29	#define DT_DIR 1
	30	#define DT_REG 2
a15c1c60	31	#define DT_LNK 3
b6829693 ET	32	#define DTYPE(de) DT_UNKNOWN
	33	#endif
	34
90334cf7 LT	35	#ifdef __GNUC__
	36	#define NORETURN __attribute__((__noreturn__))
	37	#else
	38	#define NORETURN
	39	#endif
	40
d19938ab JH	41	/*
	42	* Environment variables transition.
	43	* We accept older names for now but warn.
	44	*/
	45	extern char gitenv_bc(const char );
	46	#define gitenv(e) (getenv(e) ? : gitenv_bc(e))
	47
e83c5163 LT	48	/*
e83c5163 LT	49	* Basic data structures for the directory cache
e83c5163 LT	50	*/
	51
	52	#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
	53	struct 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	*/
	64	struct 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	*/
e83c5163 LT	77	struct 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;
59c1e249	88	char name[0];
e83c5163 LT	89	};
e83c5163 LT	90
95fd5bf8 LT	91	#define CE_NAMEMASK (0x0fff)
95fd5bf8 LT	92	#define CE_STAGEMASK (0x3000)
220a0b52	93	#define CE_UPDATE (0x4000)
aee46198	94	#define CE_STAGESHIFT 12
95fd5bf8	95
aee46198 JH	96	#define create_ce_flags(len, stage) htons((len) \| ((stage) << CE_STAGESHIFT))
	97	#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
	98	#define ce_size(ce) cache_entry_size(ce_namelen(ce))
	99	#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
	100
e4479470	101	#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
8ae0a8c5 KS	102	static inline unsigned int create_ce_mode(unsigned int mode)
8ae0a8c5 KS	103	{
8ae0a8c5 KS	104	if (S_ISLNK(mode))
8ae0a8c5 KS	105	return htonl(S_IFLNK);
db823d4a	106	return htonl(S_IFREG \| ce_permissions(mode));
8ae0a8c5	107	}
e4479470	108
aee46198	109	#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
f5cabd13	110
88355048 PB	111	extern struct cache_entry **active_cache;
88355048 PB	112	extern unsigned int active_nr, active_alloc, active_cache_changed;
e83c5163	113
8ac069ac JH	114	#define GIT_DIR_ENVIRONMENT "GIT_DIR"
8ac069ac JH	115	#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
d19938ab	116	#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
bb233d69	117	#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
bb233d69	118
8ac069ac	119	extern char *get_object_directory(void);
95fc7512	120	extern char *get_refs_directory(void);
8ac069ac JH	121	extern char *get_index_file(void);
	122
	123	#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69	124
e83c5163 LT	125	#define alloc_nr(x) (((x)+16)*3/2)
e83c5163 LT	126
734aab75	127	/* Initialize and use the cache information */
e83c5163	128	extern int read_cache(void);
197ee8c9	129	extern int write_cache(int newfd, struct cache_entry **cache, int entries);
eb38c22f	130	extern int cache_name_pos(const char *name, int namelen);
192268c1 JH	131	#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
	132	#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
	133	extern int add_cache_entry(struct cache_entry *ce, int option);
dbbce55b	134	extern int remove_cache_entry_at(int pos);
197ee8c9	135	extern int remove_file_from_cache(char *path);
dbbce55b	136	extern int ce_same_name(struct cache_entry a, struct cache_entry b);
5d728c84	137	extern int ce_match_stat(struct cache_entry ce, struct stat st);
74400e71	138	extern int index_fd(unsigned char sha1, int fd, struct stat st);
415e96c8 JH	139	extern void fill_stat_cache_info(struct cache_entry ce, struct stat st);
	140
	141	struct cache_file {
	142	struct cache_file *next;
	143	char lockfile[PATH_MAX];
	144	};
	145	extern int hold_index_file_for_update(struct cache_file , const char path);
	146	extern int commit_index_file(struct cache_file *);
	147	extern void rollback_index_file(struct cache_file *);
734aab75 LT	148
	149	#define MTIME_CHANGED 0x0001
	150	#define CTIME_CHANGED 0x0002
	151	#define OWNER_CHANGED 0x0004
	152	#define MODE_CHANGED 0x0008
	153	#define INODE_CHANGED 0x0010
	154	#define DATA_CHANGED 0x0020
8ae0a8c5	155	#define TYPE_CHANGED 0x0040
e83c5163 LT	156
e83c5163 LT	157	/* Return a statically allocated filename matching the sha1 signature */
73134b6d	158	extern char sha1_file_name(const unsigned char sha1);
e83c5163	159
e83c5163	160	/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
73134b6d	161	extern void * map_sha1_file(const unsigned char sha1, unsigned long size);
c4483576	162	extern int unpack_sha1_header(z_stream stream, void map, unsigned long mapsize, void *buffer, unsigned long size);
5180cacc	163	extern int parse_sha1_header(char hdr, char type, unsigned long *sizep);
4a62b619	164	extern int sha1_delta_base(const unsigned char , unsigned char );
65c2e0c3	165	extern int sha1_file_size(const unsigned char , unsigned long );
2ade9340	166	extern void * unpack_sha1_file(void map, unsigned long mapsize, char type, unsigned long *size);
73134b6d	167	extern void * read_sha1_file(const unsigned char sha1, char type, unsigned long *size);
bf0f910d	168	extern int write_sha1_file(void buf, unsigned long len, const char type, unsigned char *return_sha1);
8237b185	169
5d6ccf5c	170	extern int check_sha1_signature(const unsigned char sha1, void buf, unsigned long size, const char *type);
e83c5163	171
94537c78 LT	172	/* Read a tree into the cache */
	173	extern int read_tree(void *buffer, unsigned long size, int stage);
	174
8237b185 DB	175	extern int write_sha1_from_fd(const unsigned char *sha1, int fd);
	176
	177	extern int has_sha1_file(const unsigned char *sha1);
	178
e83c5163	179	/* Convert to/from hex/sha1 representation */
3c249c95	180	extern int get_sha1(const char str, unsigned char sha1);
197ee8c9 LT	181	extern int get_sha1_hex(const char hex, unsigned char sha1);
197ee8c9 LT	182	extern char sha1_to_hex(const unsigned char sha1); /* static buffer result! */
e83c5163 LT	183
e83c5163 LT	184	/* General helper functions */
90334cf7 LT	185	extern void usage(const char *err) NORETURN;
90334cf7 LT	186	extern void die(const char *err, ...) NORETURN;
2de381f9 PB	187	extern int error(const char *err, ...);
2de381f9 PB	188
958ba6c9	189	extern int base_name_compare(const char name1, int len1, int mode1, const char name2, int len2, int mode2);
79517a06	190	extern int cache_name_compare(const char name1, int len1, const char name2, int len2);
e83c5163	191
40469ee9	192	extern void read_object_with_reference(const unsigned char sha1,
bf0f910d	193	const char *required_type,
40469ee9 JH	194	unsigned long *size,
40469ee9 JH	195	unsigned char *sha1_ret);
f4913f91	196
f80cd783	197	const char *show_date(unsigned long time, int timezone);
ecee9d9e ET	198	void parse_date(char date, char buf, int bufsize);
	199	void datestamp(char *buf, int bufsize);
	200
127cfd0d	201	static inline void *xmalloc(size_t size)
812666c8 CL	202	{
	203	void *ret = malloc(size);
	204	if (!ret)
	205	die("Out of memory, malloc failed");
	206	return ret;
	207	}
	208
127cfd0d	209	static inline void xrealloc(void ptr, size_t size)
812666c8 CL	210	{
	211	void *ret = realloc(ptr, size);
	212	if (!ret)
	213	die("Out of memory, realloc failed");
	214	return ret;
	215	}
	216
127cfd0d BR	217	static inline void *xcalloc(size_t nmemb, size_t size)
	218	{
	219	void *ret = calloc(nmemb, size);
	220	if (!ret)
	221	die("Out of memory, calloc failed");
	222	return ret;
	223	}
	224
12dccc16 LT	225	struct checkout {
	226	const char *base_dir;
	227	int base_dir_len;
	228	unsigned force:1,
	229	quiet:1,
	230	not_new:1,
	231	refresh_cache:1;
	232	};
	233
	234	extern int checkout_entry(struct cache_entry ce, struct checkout state);
	235
e83c5163	236	#endif /* CACHE_H */