[thirdparty/git.git] / git-compat-util.h

#ifndef GIT_COMPAT_UTIL_H
#define GIT_COMPAT_UTIL_H

#ifndef FLEX_ARRAY
#if defined(__GNUC__) && (__GNUC__ < 3)
#define FLEX_ARRAY 0
#else
#define FLEX_ARRAY /* empty */
#endif
#endif

#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))

#if !defined(__APPLE__) && !defined(__FreeBSD__)
#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
#endif
#define _ALL_SOURCE 1
#define _GNU_SOURCE 1
#define _BSD_SOURCE 1

#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/param.h>
#include <sys/types.h>
#include <dirent.h>
#include <sys/time.h>
#include <time.h>
#include <signal.h>
#include <sys/wait.h>
#include <fnmatch.h>
#include <sys/poll.h>
#include <sys/socket.h>
#include <assert.h>
#include <regex.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#include <arpa/inet.h>
#include <netdb.h>
#include <pwd.h>
#include <inttypes.h>
#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
#include <grp.h>
#define _ALL_SOURCE 1

#ifndef NO_ICONV
#include <iconv.h>
#endif

/* On most systems <limits.h> would have given us this, but
 * not on some systems (e.g. GNU/Hurd).
 */
#ifndef PATH_MAX
#define PATH_MAX 4096
#endif

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

/* 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 void warn(const char *err, ...) __attribute__((format (printf, 1, 2)));

extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
extern void set_error_routine(void (*routine)(const char *err, va_list params));
extern void set_warn_routine(void (*routine)(const char *warn, va_list params));

#ifdef NO_MMAP

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

#define mmap git_mmap
#define munmap git_munmap
extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
extern int git_munmap(void *start, size_t length);

/* This value must be multiple of (pagesize * 2) */
#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)

#else /* NO_MMAP */

#include <sys/mman.h>

/* This value must be multiple of (pagesize * 2) */
#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
	(sizeof(void*) >= 8 \
		?  1 * 1024 * 1024 * 1024 \
		: 32 * 1024 * 1024)

#endif /* NO_MMAP */

#define DEFAULT_PACKED_GIT_LIMIT \
	((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))

#ifdef NO_PREAD
#define pread git_pread
extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
#endif

#ifdef NO_SETENV
#define setenv gitsetenv
extern int gitsetenv(const char *, const char *, int);
#endif

#ifdef NO_UNSETENV
#define unsetenv gitunsetenv
extern void gitunsetenv(const char *);
#endif

#ifdef NO_STRCASESTR
#define strcasestr gitstrcasestr
extern char *gitstrcasestr(const char *haystack, const char *needle);
#endif

#ifdef NO_STRLCPY
#define strlcpy gitstrlcpy
extern size_t gitstrlcpy(char *, const char *, size_t);
#endif

extern void release_pack_memory(size_t);

static inline char* xstrdup(const char *str)
{
	char *ret = strdup(str);
	if (!ret) {
		release_pack_memory(strlen(str) + 1);
		ret = strdup(str);
		if (!ret)
			die("Out of memory, strdup failed");
	}
	return ret;
}

static inline void *xmalloc(size_t size)
{
	void *ret = malloc(size);
	if (!ret && !size)
		ret = malloc(1);
	if (!ret) {
		release_pack_memory(size);
		ret = malloc(size);
		if (!ret && !size)
			ret = malloc(1);
		if (!ret)
			die("Out of memory, malloc failed");
	}
#ifdef XMALLOC_POISON
	memset(ret, 0xA5, size);
#endif
	return ret;
}

static inline void *xrealloc(void *ptr, size_t size)
{
	void *ret = realloc(ptr, size);
	if (!ret && !size)
		ret = realloc(ptr, 1);
	if (!ret) {
		release_pack_memory(size);
		ret = realloc(ptr, size);
		if (!ret && !size)
			ret = realloc(ptr, 1);
		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 && (!nmemb || !size))
		ret = calloc(1, 1);
	if (!ret) {
		release_pack_memory(nmemb * size);
		ret = calloc(nmemb, size);
		if (!ret && (!nmemb || !size))
			ret = calloc(1, 1);
		if (!ret)
			die("Out of memory, calloc failed");
	}
	return ret;
}

static inline void *xmmap(void *start, size_t length,
	int prot, int flags, int fd, off_t offset)
{
	void *ret = mmap(start, length, prot, flags, fd, offset);
	if (ret == MAP_FAILED) {
		if (!length)
			return NULL;
		release_pack_memory(length);
		ret = mmap(start, length, prot, flags, fd, offset);
		if (ret == MAP_FAILED)
			die("Out of memory? mmap failed: %s", strerror(errno));
	}
	return ret;
}

static inline ssize_t xread(int fd, void *buf, size_t len)
{
	ssize_t nr;
	while (1) {
		nr = read(fd, buf, len);
		if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
			continue;
		return nr;
	}
}

static inline ssize_t xwrite(int fd, const void *buf, size_t len)
{
	ssize_t nr;
	while (1) {
		nr = write(fd, buf, len);
		if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
			continue;
		return nr;
	}
}

static inline int has_extension(const char *filename, const char *ext)
{
	size_t len = strlen(filename);
	size_t extlen = strlen(ext);
	return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
}

/* 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
Commit	Line	Data
4050c0df JH	1	#ifndef GIT_COMPAT_UTIL_H
	2	#define GIT_COMPAT_UTIL_H
	3
8f1d2e6f JH	4	#ifndef FLEX_ARRAY
	5	#if defined(__GNUC__) && (__GNUC__ < 3)
	6	#define FLEX_ARRAY 0
	7	#else
	8	#define FLEX_ARRAY /* empty */
	9	#endif
	10	#endif
	11
b4f2a6ac JH	12	#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
b4f2a6ac JH	13
95ca1c6c	14	#if !defined(__APPLE__) && !defined(__FreeBSD__)
85023577 JH	15	#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
85023577 JH	16	#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6	17	#endif
fb952206 JR	18	#define _ALL_SOURCE 1
	19	#define _GNU_SOURCE 1
	20	#define _BSD_SOURCE 1
85023577	21
4050c0df JH	22	#include <unistd.h>
	23	#include <stdio.h>
	24	#include <sys/stat.h>
	25	#include <fcntl.h>
	26	#include <stddef.h>
	27	#include <stdlib.h>
	28	#include <stdarg.h>
	29	#include <string.h>
	30	#include <errno.h>
	31	#include <limits.h>
	32	#include <sys/param.h>
4050c0df JH	33	#include <sys/types.h>
4050c0df JH	34	#include <dirent.h>
85023577 JH	35	#include <sys/time.h>
	36	#include <time.h>
	37	#include <signal.h>
	38	#include <sys/wait.h>
	39	#include <fnmatch.h>
	40	#include <sys/poll.h>
	41	#include <sys/socket.h>
	42	#include <assert.h>
	43	#include <regex.h>
	44	#include <netinet/in.h>
	45	#include <netinet/tcp.h>
	46	#include <arpa/inet.h>
	47	#include <netdb.h>
	48	#include <pwd.h>
007e2ba6	49	#include <inttypes.h>
fb952206	50	#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577	51	#include <grp.h>
fb952206	52	#define _ALL_SOURCE 1
85023577 JH	53
	54	#ifndef NO_ICONV
	55	#include <iconv.h>
	56	#endif
4050c0df	57
d0c2449f JH	58	/* On most systems <limits.h> would have given us this, but
	59	* not on some systems (e.g. GNU/Hurd).
	60	*/
	61	#ifndef PATH_MAX
	62	#define PATH_MAX 4096
	63	#endif
	64
4050c0df JH	65	#ifdef __GNUC__
	66	#define NORETURN __attribute__((__noreturn__))
	67	#else
	68	#define NORETURN
	69	#ifndef __attribute__
	70	#define __attribute__(x)
	71	#endif
	72	#endif
	73
	74	/* General helper functions */
	75	extern void usage(const char *err) NORETURN;
	76	extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
	77	extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
fa39b6b5	78	extern void warn(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df	79
39a3f5ea PB	80	extern void set_usage_routine(void (routine)(const char err) NORETURN);
	81	extern void set_die_routine(void (routine)(const char err, va_list params) NORETURN);
	82	extern void set_error_routine(void (routine)(const char err, va_list params));
fa39b6b5	83	extern void set_warn_routine(void (routine)(const char warn, va_list params));
39a3f5ea	84
4050c0df JH	85	#ifdef NO_MMAP
	86
	87	#ifndef PROT_READ
	88	#define PROT_READ 1
	89	#define PROT_WRITE 2
	90	#define MAP_PRIVATE 1
	91	#define MAP_FAILED ((void*)-1)
	92	#endif
	93
d6779124 SP	94	#define mmap git_mmap
	95	#define munmap git_munmap
	96	extern void git_mmap(void start, size_t length, int prot, int flags, int fd, off_t offset);
	97	extern int git_munmap(void *start, size_t length);
4050c0df	98
5faaf246	99	/* This value must be multiple of (pagesize * 2) */
8c82534d SP	100	#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
8c82534d SP	101
4050c0df JH	102	#else /* NO_MMAP */
	103
	104	#include <sys/mman.h>
5faaf246 JH	105
5faaf246 JH	106	/* This value must be multiple of (pagesize * 2) */
22bac0ea SP	107	#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
	108	(sizeof(void*) >= 8 \
	109	? 1 * 1024 * 1024 * 1024 \
	110	: 32 * 1024 * 1024)
4050c0df JH	111
	112	#endif /* NO_MMAP */
	113
22bac0ea	114	#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a	115	((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d	116
6900679c SH	117	#ifdef NO_PREAD
	118	#define pread git_pread
	119	extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
	120	#endif
	121
4050c0df JH	122	#ifdef NO_SETENV
	123	#define setenv gitsetenv
	124	extern int gitsetenv(const char , const char , int);
	125	#endif
	126
731043fd JR	127	#ifdef NO_UNSETENV
	128	#define unsetenv gitunsetenv
	129	extern void gitunsetenv(const char *);
	130	#endif
	131
4050c0df JH	132	#ifdef NO_STRCASESTR
	133	#define strcasestr gitstrcasestr
	134	extern char gitstrcasestr(const char haystack, const char *needle);
	135	#endif
	136
817151e6 PE	137	#ifdef NO_STRLCPY
	138	#define strlcpy gitstrlcpy
	139	extern size_t gitstrlcpy(char , const char , size_t);
	140	#endif
	141
97bfeb34 SP	142	extern void release_pack_memory(size_t);
97bfeb34 SP	143
9befac47 SP	144	static inline char* xstrdup(const char *str)
	145	{
	146	char *ret = strdup(str);
97bfeb34 SP	147	if (!ret) {
	148	release_pack_memory(strlen(str) + 1);
	149	ret = strdup(str);
	150	if (!ret)
	151	die("Out of memory, strdup failed");
	152	}
9befac47 SP	153	return ret;
	154	}
	155
4050c0df JH	156	static inline void *xmalloc(size_t size)
	157	{
	158	void *ret = malloc(size);
4e7a2ecc JH	159	if (!ret && !size)
4e7a2ecc JH	160	ret = malloc(1);
97bfeb34 SP	161	if (!ret) {
	162	release_pack_memory(size);
	163	ret = malloc(size);
	164	if (!ret && !size)
	165	ret = malloc(1);
	166	if (!ret)
	167	die("Out of memory, malloc failed");
	168	}
aa5481c1 JH	169	#ifdef XMALLOC_POISON
	170	memset(ret, 0xA5, size);
	171	#endif
4050c0df JH	172	return ret;
	173	}
	174
	175	static inline void xrealloc(void ptr, size_t size)
	176	{
	177	void *ret = realloc(ptr, size);
4e7a2ecc JH	178	if (!ret && !size)
4e7a2ecc JH	179	ret = realloc(ptr, 1);
97bfeb34 SP	180	if (!ret) {
	181	release_pack_memory(size);
	182	ret = realloc(ptr, size);
	183	if (!ret && !size)
	184	ret = realloc(ptr, 1);
	185	if (!ret)
	186	die("Out of memory, realloc failed");
	187	}
4050c0df JH	188	return ret;
	189	}
	190
	191	static inline void *xcalloc(size_t nmemb, size_t size)
	192	{
	193	void *ret = calloc(nmemb, size);
4e7a2ecc JH	194	if (!ret && (!nmemb \|\| !size))
4e7a2ecc JH	195	ret = calloc(1, 1);
97bfeb34 SP	196	if (!ret) {
	197	release_pack_memory(nmemb * size);
	198	ret = calloc(nmemb, size);
	199	if (!ret && (!nmemb \|\| !size))
	200	ret = calloc(1, 1);
	201	if (!ret)
	202	die("Out of memory, calloc failed");
	203	}
4050c0df JH	204	return ret;
	205	}
	206
c4712e45 SP	207	static inline void xmmap(void start, size_t length,
	208	int prot, int flags, int fd, off_t offset)
	209	{
	210	void *ret = mmap(start, length, prot, flags, fd, offset);
	211	if (ret == MAP_FAILED) {
9130ac1e LT	212	if (!length)
9130ac1e LT	213	return NULL;
c4712e45 SP	214	release_pack_memory(length);
	215	ret = mmap(start, length, prot, flags, fd, offset);
	216	if (ret == MAP_FAILED)
	217	die("Out of memory? mmap failed: %s", strerror(errno));
	218	}
	219	return ret;
	220	}
	221
1c15afb9 JH	222	static inline ssize_t xread(int fd, void *buf, size_t len)
	223	{
	224	ssize_t nr;
	225	while (1) {
	226	nr = read(fd, buf, len);
	227	if ((nr < 0) && (errno == EAGAIN \|\| errno == EINTR))
	228	continue;
	229	return nr;
	230	}
	231	}
	232
	233	static inline ssize_t xwrite(int fd, const void *buf, size_t len)
	234	{
	235	ssize_t nr;
	236	while (1) {
	237	nr = write(fd, buf, len);
	238	if ((nr < 0) && (errno == EAGAIN \|\| errno == EINTR))
	239	continue;
	240	return nr;
	241	}
	242	}
	243
5bb1cda5	244	static inline int has_extension(const char filename, const char ext)
83a2b841	245	{
5bb1cda5 RS	246	size_t len = strlen(filename);
5bb1cda5 RS	247	size_t extlen = strlen(ext);
83a2b841 RS	248	return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
	249	}
	250
4050c0df JH	251	/* Sane ctype - no locale, and works with signed chars */
	252	#undef isspace
	253	#undef isdigit
	254	#undef isalpha
	255	#undef isalnum
	256	#undef tolower
	257	#undef toupper
	258	extern unsigned char sane_ctype[256];
	259	#define GIT_SPACE 0x01
	260	#define GIT_DIGIT 0x02
	261	#define GIT_ALPHA 0x04
	262	#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
	263	#define isspace(x) sane_istest(x,GIT_SPACE)
	264	#define isdigit(x) sane_istest(x,GIT_DIGIT)
	265	#define isalpha(x) sane_istest(x,GIT_ALPHA)
	266	#define isalnum(x) sane_istest(x,GIT_ALPHA \| GIT_DIGIT)
	267	#define tolower(x) sane_case((unsigned char)(x), 0x20)
	268	#define toupper(x) sane_case((unsigned char)(x), 0)
	269
	270	static inline int sane_case(int x, int high)
	271	{
	272	if (sane_istest(x, GIT_ALPHA))
	273	x = (x & ~0x20) \| high;
	274	return x;
	275	}
	276
	277	#endif