[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>
#ifndef NO_MMAP
#include <sys/mman.h>
#endif
#include <sys/param.h>
#include <netinet/in.h>
#include <sys/types.h>
#include <dirent.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
#ifndef __attribute__
#define __attribute__(x)
#endif
#endif

/*
 * Intensive research over the course of many years has shown that
 * port 9418 is totally unused by anything else. Or
 *
 *	Your search - "port 9418" - did not match any documents.
 *
 * as www.google.com puts it.
 *
 * This port has been properly assigned for git use by IANA:
 * git (Assigned-9418) [I06-050728-0001].
 *
 *	git  9418/tcp   git pack transfer service
 *	git  9418/udp   git pack transfer service
 *
 * with Linus Torvalds <torvalds@osdl.org> as the point of
 * contact. September 2005.
 *
 * See http://www.iana.org/assignments/port-numbers
 */
#define DEFAULT_GIT_PORT 9418

/*
 * 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"
#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"

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

#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"

extern const char **get_pathspec(const char *prefix, const char **pathspec);
extern const char *setup_git_directory(void);
extern const char *prefix_path(const char *prefix, int len, const char *path);

#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 */
#define ADD_CACHE_SKIP_DFCHECK 4	/* Ok to skip DF conflict checks */
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(const 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 ce_modified(struct cache_entry *ce, struct stat *st);
extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
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 *);

extern int trust_executable_bit;

#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 *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
extern char *sha1_file_name(const unsigned char *sha1);
extern char *sha1_pack_name(const unsigned char *sha1);
extern char *sha1_pack_index_name(const unsigned char *sha1);
extern const char *find_unique_abbrev(const unsigned char *sha1, int);
extern const unsigned char null_sha1[20];

int git_mkstemp(char *path, size_t n, const char *template);

int safe_create_leading_directories(char *path);
char *safe_strncpy(char *, const char *, size_t);

/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
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_object_info(const unsigned char *, 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 char *write_sha1_file_prepare(void *buf,
				     unsigned long len,
				     const char *type,
				     unsigned char *sha1,
				     unsigned char *hdr,
				     int *hdrlen);

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, const char **paths);

extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
			      size_t bufsize, size_t *bufposn);
extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
extern int move_temp_to_file(const char *tmpfile, char *filename);

extern int has_sha1_pack(const unsigned char *sha1);
extern int has_sha1_file(const unsigned char *sha1);

extern int has_pack_file(const unsigned char *sha1);
extern int has_pack_index(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! */
extern int read_ref(const char *filename, unsigned char *sha1);
extern const char *resolve_ref(const char *path, unsigned char *sha1, int);
extern int create_symref(const char *git_HEAD, const char *refs_heads_master);
extern int validate_symref(const char *git_HEAD);

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

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);
int parse_date(const char *date, char *buf, int bufsize);
void datestamp(char *buf, int bufsize);

extern int setup_ident(void);
extern char *get_ident(const char *name, const char *email, const char *date_str);
extern char *git_author_info(void);
extern char *git_committer_info(void);

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);

extern struct alternate_object_database {
	struct alternate_object_database *next;
	char *name;
	char base[0]; /* more */
} *alt_odb_list;
extern void prepare_alt_odb(void);

extern struct packed_git {
	struct packed_git *next;
	unsigned long index_size;
	unsigned long pack_size;
	unsigned int *index_base;
	void *pack_base;
	unsigned int pack_last_used;
	unsigned int pack_use_cnt;
	int pack_local;
	unsigned char sha1[20];
	char pack_name[0]; /* something like ".git/objects/pack/xxxxx.pack" */
} *packed_git;

struct pack_entry {
	unsigned int offset;
	unsigned char sha1[20];
	struct packed_git *p;
};

struct ref {
	struct ref *next;
	unsigned char old_sha1[20];
	unsigned char new_sha1[20];
	unsigned char force;
	struct ref *peer_ref; /* when renaming */
	char name[0];
};

extern int git_connect(int fd[2], char *url, const char *prog);
extern int finish_connect(pid_t pid);
extern int path_match(const char *path, int nr, char **match);
extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
		      int nr_refspec, char **refspec, int all);
extern int get_ack(int fd, unsigned char *result_sha1);
extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, int ignore_funny);

extern struct packed_git *parse_pack_index(unsigned char *sha1);
extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
						char *idx_path);

extern void prepare_packed_git(void);
extern void install_packed_git(struct packed_git *pack);

extern struct packed_git *find_sha1_pack(const unsigned char *sha1, 
					 struct packed_git *packs);

extern int use_packed_git(struct packed_git *);
extern void unuse_packed_git(struct packed_git *);
extern struct packed_git *add_packed_git(char *, int, int);
extern int num_packed_objects(const struct packed_git *p);
extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, int *, unsigned char *);

/* Dumb servers support */
extern int update_server_info(int);

#ifdef NO_MMAP

#ifndef PROT_READ
#define PROT_READ 1
#define PROT_WRITE 2
#define MAP_PRIVATE 1
#define MAP_FAILED ((void*)-1)
#endif

extern void *gitfakemmap(void *start, size_t length, int prot , int flags, int fd, off_t offset);
extern int gitfakemunmap(void *start, size_t length);

#endif

typedef int (*config_fn_t)(const char *, const char *);
extern int git_default_config(const char *, const char *);
extern int git_config(config_fn_t fn);
extern int git_config_int(const char *, const char *);
extern int git_config_bool(const char *, const char *);

#define MAX_GITNAME (1000)
extern char git_default_email[MAX_GITNAME];
extern char git_default_name[MAX_GITNAME];

/* Sane ctype - no locale, and works with signed chars */
#undef isspace
#undef isdigit
#undef isalpha
#undef isalnum
#undef tolower
#undef toupper
extern unsigned char sane_ctype[256];
#define GIT_SPACE 0x01
#define GIT_DIGIT 0x02
#define GIT_ALPHA 0x04
#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
#define isspace(x) sane_istest(x,GIT_SPACE)
#define isdigit(x) sane_istest(x,GIT_DIGIT)
#define isalpha(x) sane_istest(x,GIT_ALPHA)
#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
#define tolower(x) sane_case((unsigned char)(x), 0x20)
#define toupper(x) sane_case((unsigned char)(x), 0)

static inline int sane_case(int x, int high)
{
	if (sane_istest(x, GIT_ALPHA))
		x = (x & ~0x20) | high;
	return x;
}

#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>
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>
575f4974 LT	20	#include <dirent.h>
e83c5163	21
cef661fc	22	#include SHA1_HEADER
e83c5163 LT	23	#include <zlib.h>
e83c5163 LT	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	/*
e83c5163 LT	70	* Basic data structures for the directory cache
e83c5163 LT	71	*/
	72
	73	#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
	74	struct 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	*/
	85	struct 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	*/
e83c5163 LT	98	struct 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	};
e83c5163 LT	111
95fd5bf8 LT	112	#define CE_NAMEMASK (0x0fff)
95fd5bf8 LT	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	123	static inline unsigned int create_ce_mode(unsigned int mode)
8ae0a8c5 KS	124	{
8ae0a8c5 KS	125	if (S_ISLNK(mode))
8ae0a8c5 KS	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	132	extern struct cache_entry **active_cache;
88355048 PB	133	extern unsigned int active_nr, active_alloc, active_cache_changed;
e83c5163	134
8ac069ac JH	135	#define GIT_DIR_ENVIRONMENT "GIT_DIR"
8ac069ac JH	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	141	extern char *get_git_dir(void);
8ac069ac	142	extern char *get_object_directory(void);
95fc7512	143	extern char *get_refs_directory(void);
8ac069ac	144	extern char *get_index_file(void);
5da5c8f4	145	extern char *get_graft_file(void);
8ac069ac JH	146
8ac069ac JH	147	#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
bb233d69	148
6b5ee137	149	extern const char *get_pathspec(const char prefix, const char **pathspec);
d288a700	150	extern const char *setup_git_directory(void);
6b5ee137	151	extern const char prefix_path(const char prefix, int len, const char *path);
d288a700	152
e83c5163 LT	153	#define alloc_nr(x) (((x)+16)*3/2)
e83c5163 LT	154
734aab75	155	/* Initialize and use the cache information */
e83c5163	156	extern int read_cache(void);
197ee8c9	157	extern int write_cache(int newfd, struct cache_entry **cache, int entries);
eb38c22f	158	extern int cache_name_pos(const char *name, int namelen);
192268c1 JH	159	#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
192268c1 JH	160	#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
b155725d	161	#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
192268c1	162	extern int add_cache_entry(struct cache_entry *ce, int option);
dbbce55b	163	extern int remove_cache_entry_at(int pos);
6b5ee137	164	extern int remove_file_from_cache(const char *path);
dbbce55b	165	extern int ce_same_name(struct cache_entry a, struct cache_entry b);
5d728c84	166	extern int ce_match_stat(struct cache_entry ce, struct stat st);
b0391890	167	extern int ce_modified(struct cache_entry ce, struct stat st);
c0fd1f51	168	extern int ce_path_match(const struct cache_entry ce, const char *pathspec);
7672db20	169	extern int index_fd(unsigned char sha1, int fd, struct stat st, int write_object, const char *type);
ec1fcc16	170	extern int index_path(unsigned char sha1, const char path, struct stat *st, int write_object);
415e96c8 JH	171	extern void fill_stat_cache_info(struct cache_entry ce, struct stat st);
	172
	173	struct cache_file {
	174	struct cache_file *next;
	175	char lockfile[PATH_MAX];
	176	};
	177	extern int hold_index_file_for_update(struct cache_file , const char path);
	178	extern int commit_index_file(struct cache_file *);
	179	extern void rollback_index_file(struct cache_file *);
734aab75	180
17712991 LT	181	extern int trust_executable_bit;
17712991 LT	182
734aab75 LT	183	#define MTIME_CHANGED 0x0001
	184	#define CTIME_CHANGED 0x0002
	185	#define OWNER_CHANGED 0x0004
	186	#define MODE_CHANGED 0x0008
	187	#define INODE_CHANGED 0x0010
	188	#define DATA_CHANGED 0x0020
8ae0a8c5	189	#define TYPE_CHANGED 0x0040
e83c5163 LT	190
e83c5163 LT	191	/* Return a statically allocated filename matching the sha1 signature */
4ec99bf0 TS	192	extern char mkpath(const char fmt, ...) __attribute__((format (printf, 1, 2)));
4ec99bf0 TS	193	extern char git_path(const char fmt, ...) __attribute__((format (printf, 1, 2)));
73134b6d	194	extern char sha1_file_name(const unsigned char sha1);
bf592c50 DB	195	extern char sha1_pack_name(const unsigned char sha1);
bf592c50 DB	196	extern char sha1_pack_index_name(const unsigned char sha1);
013f276e	197	extern const char find_unique_abbrev(const unsigned char sha1, int);
88cd621d	198	extern const unsigned char null_sha1[20];
e83c5163	199
f2db68ed HE	200	int git_mkstemp(char path, size_t n, const char template);
f2db68ed HE	201
b2cb9425	202	int safe_create_leading_directories(char *path);
f2db68ed	203	char safe_strncpy(char , const char *, size_t);
b2cb9425	204
e83c5163	205	/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
c4483576	206	extern int unpack_sha1_header(z_stream stream, void map, unsigned long mapsize, void *buffer, unsigned long size);
5180cacc	207	extern int parse_sha1_header(char hdr, char type, unsigned long *sizep);
36e4d74a	208	extern int sha1_object_info(const unsigned char , char , unsigned long *);
2ade9340	209	extern void * unpack_sha1_file(void map, unsigned long mapsize, char type, unsigned long *size);
73134b6d	210	extern void * read_sha1_file(const unsigned char sha1, char type, unsigned long *size);
bf0f910d	211	extern int write_sha1_file(void buf, unsigned long len, const char type, unsigned char *return_sha1);
7672db20 BL	212	extern char write_sha1_file_prepare(void buf,
	213	unsigned long len,
	214	const char *type,
	215	unsigned char *sha1,
	216	unsigned char *hdr,
	217	int *hdrlen);
8237b185	218
5d6ccf5c	219	extern int check_sha1_signature(const unsigned char sha1, void buf, unsigned long size, const char *type);
e83c5163	220
94537c78	221	/* Read a tree into the cache */
3e587635	222	extern int read_tree(void buffer, unsigned long size, int stage, const char *paths);
94537c78	223
70b9829e DB	224	extern int write_sha1_from_fd(const unsigned char sha1, int fd, char buffer,
70b9829e DB	225	size_t bufsize, size_t *bufposn);
a5eda52b	226	extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
b721e01f	227	extern int move_temp_to_file(const char tmpfile, char filename);
8237b185	228
dade09c2	229	extern int has_sha1_pack(const unsigned char *sha1);
8237b185 DB	230	extern int has_sha1_file(const unsigned char *sha1);
8237b185 DB	231
bf592c50 DB	232	extern int has_pack_file(const unsigned char *sha1);
	233	extern int has_pack_index(const unsigned char *sha1);
	234
e83c5163	235	/* Convert to/from hex/sha1 representation */
3c249c95	236	extern int get_sha1(const char str, unsigned char sha1);
197ee8c9 LT	237	extern int get_sha1_hex(const char hex, unsigned char sha1);
197ee8c9 LT	238	extern char sha1_to_hex(const unsigned char sha1); /* static buffer result! */
ca8db142	239	extern int read_ref(const char filename, unsigned char sha1);
a876ed83	240	extern const char resolve_ref(const char path, unsigned char *sha1, int);
8098a178 JH	241	extern int create_symref(const char git_HEAD, const char refs_heads_master);
8098a178 JH	242	extern int validate_symref(const char *git_HEAD);
e83c5163 LT	243
e83c5163 LT	244	/* General helper functions */
90334cf7	245	extern void usage(const char *err) NORETURN;
4ec99bf0 TS	246	extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
4ec99bf0 TS	247	extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
2de381f9	248
958ba6c9	249	extern int base_name_compare(const char name1, int len1, int mode1, const char name2, int len2, int mode2);
79517a06	250	extern int cache_name_compare(const char name1, int len1, const char name2, int len2);
e83c5163	251
40469ee9	252	extern void read_object_with_reference(const unsigned char sha1,
bf0f910d	253	const char *required_type,
40469ee9 JH	254	unsigned long *size,
40469ee9 JH	255	unsigned char *sha1_ret);
f4913f91	256
f80cd783	257	const char *show_date(unsigned long time, int timezone);
2a39064c	258	int parse_date(const char date, char buf, int bufsize);
ecee9d9e ET	259	void datestamp(char *buf, int bufsize);
ecee9d9e ET	260
6aa33f40 LT	261	extern int setup_ident(void);
6aa33f40 LT	262	extern char get_ident(const char name, const char email, const char date_str);
d289d136 EB	263	extern char *git_author_info(void);
d289d136 EB	264	extern char *git_committer_info(void);
6aa33f40	265
127cfd0d	266	static inline void *xmalloc(size_t size)
812666c8 CL	267	{
	268	void *ret = malloc(size);
	269	if (!ret)
	270	die("Out of memory, malloc failed");
	271	return ret;
	272	}
	273
127cfd0d	274	static inline void xrealloc(void ptr, size_t size)
812666c8 CL	275	{
	276	void *ret = realloc(ptr, size);
	277	if (!ret)
	278	die("Out of memory, realloc failed");
	279	return ret;
	280	}
	281
127cfd0d BR	282	static inline void *xcalloc(size_t nmemb, size_t size)
	283	{
	284	void *ret = calloc(nmemb, size);
	285	if (!ret)
	286	die("Out of memory, calloc failed");
	287	return ret;
	288	}
	289
12dccc16 LT	290	struct checkout {
	291	const char *base_dir;
	292	int base_dir_len;
	293	unsigned force:1,
	294	quiet:1,
	295	not_new:1,
	296	refresh_cache:1;
	297	};
	298
	299	extern int checkout_entry(struct cache_entry ce, struct checkout state);
	300
9a217f2a	301	extern struct alternate_object_database {
d5a63b99	302	struct alternate_object_database *next;
9a217f2a	303	char *name;
2c04662d	304	char base[0]; /* more */
d5a63b99	305	} *alt_odb_list;
9a217f2a JH	306	extern void prepare_alt_odb(void);
	307
	308	extern struct packed_git {
	309	struct packed_git *next;
	310	unsigned long index_size;
	311	unsigned long pack_size;
	312	unsigned int *index_base;
	313	void *pack_base;
	314	unsigned int pack_last_used;
f9253394	315	unsigned int pack_use_cnt;
9d835df2	316	int pack_local;
bf592c50	317	unsigned char sha1[20];
2c04662d	318	char pack_name[0]; /* something like ".git/objects/pack/xxxxx.pack" */
9a217f2a	319	} *packed_git;
f3bf9224 JH	320
	321	struct pack_entry {
	322	unsigned int offset;
	323	unsigned char sha1[20];
	324	struct packed_git *p;
	325	};
	326
d1c133f5 LT	327	struct ref {
	328	struct ref *next;
	329	unsigned char old_sha1[20];
	330	unsigned char new_sha1[20];
ff27adf3	331	unsigned char force;
f88395ac	332	struct ref peer_ref; / when renaming */
2c04662d	333	char name[0];
d1c133f5 LT	334	};
d1c133f5 LT	335
f7192598 LT	336	extern int git_connect(int fd[2], char url, const char prog);
f7192598 LT	337	extern int finish_connect(pid_t pid);
013e7c7f	338	extern int path_match(const char path, int nr, char *match);
f88395ac JH	339	extern int match_refs(struct ref src, struct ref dst, struct ref ***dst_tail,
f88395ac JH	340	int nr_refspec, char **refspec, int all);
41cb7488	341	extern int get_ack(int fd, unsigned char *result_sha1);
1a7141ff	342	extern struct ref get_remote_heads(int in, struct ref list, int nr_match, char **match, int ignore_funny);
f7192598	343
bf592c50	344	extern struct packed_git parse_pack_index(unsigned char sha1);
2ab141a2	345	extern struct packed_git parse_pack_index_file(const unsigned char sha1,
c508df5e	346	char *idx_path);
bf592c50	347
9a217f2a	348	extern void prepare_packed_git(void);
bf592c50 DB	349	extern void install_packed_git(struct packed_git *pack);
	350
	351	extern struct packed_git find_sha1_pack(const unsigned char sha1,
	352	struct packed_git *packs);
	353
f9253394 JH	354	extern int use_packed_git(struct packed_git *);
f9253394 JH	355	extern void unuse_packed_git(struct packed_git *);
9d835df2	356	extern struct packed_git add_packed_git(char , int, int);
9a217f2a JH	357	extern int num_packed_objects(const struct packed_git *p);
9a217f2a JH	358	extern int nth_packed_object_sha1(const struct packed_git , int, unsigned char);
f3bf9224 JH	359	extern int find_pack_entry_one(const unsigned char , struct pack_entry , struct packed_git *);
f3bf9224 JH	360	extern void unpack_entry_gently(struct pack_entry , char , unsigned long );
ad8c80a5	361	extern void packed_object_info_detail(struct pack_entry , char , unsigned long , unsigned long , int , unsigned char );
9a217f2a	362
8f3f9b09 JH	363	/* Dumb servers support */
	364	extern int update_server_info(int);
	365
730d48a2 JS	366	#ifdef NO_MMAP
	367
	368	#ifndef PROT_READ
	369	#define PROT_READ 1
	370	#define PROT_WRITE 2
	371	#define MAP_PRIVATE 1
	372	#define MAP_FAILED ((void*)-1)
	373	#endif
	374
	375	extern void gitfakemmap(void start, size_t length, int prot , int flags, int fd, off_t offset);
	376	extern int gitfakemunmap(void *start, size_t length);
	377
	378	#endif
	379
17712991 LT	380	typedef int (config_fn_t)(const char , const char *);
	381	extern int git_default_config(const char , const char );
	382	extern int git_config(config_fn_t fn);
	383	extern int git_config_int(const char , const char );
	384	extern int git_config_bool(const char , const char );
	385
e1b10391 LT	386	#define MAX_GITNAME (1000)
	387	extern char git_default_email[MAX_GITNAME];
	388	extern char git_default_name[MAX_GITNAME];
	389
4546738b LT	390	/* Sane ctype - no locale, and works with signed chars */
	391	#undef isspace
	392	#undef isdigit
	393	#undef isalpha
	394	#undef isalnum
	395	#undef tolower
	396	#undef toupper
	397	extern unsigned char sane_ctype[256];
	398	#define GIT_SPACE 0x01
	399	#define GIT_DIGIT 0x02
	400	#define GIT_ALPHA 0x04
	401	#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
	402	#define isspace(x) sane_istest(x,GIT_SPACE)
	403	#define isdigit(x) sane_istest(x,GIT_DIGIT)
	404	#define isalpha(x) sane_istest(x,GIT_ALPHA)
	405	#define isalnum(x) sane_istest(x,GIT_ALPHA \| GIT_DIGIT)
	406	#define tolower(x) sane_case((unsigned char)(x), 0x20)
	407	#define toupper(x) sane_case((unsigned char)(x), 0)
	408
	409	static inline int sane_case(int x, int high)
	410	{
	411	if (sane_istest(x, GIT_ALPHA))
	412	x = (x & ~0x20) \| high;
	413	return x;
	414	}
	415
e83c5163	416	#endif /* CACHE_H */