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

#ifndef GIT_COMPAT_UTIL_H
#define GIT_COMPAT_UTIL_H

#define _FILE_OFFSET_BITS 64

#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]))

#ifdef __GNUC__
#define TYPEOF(x) (__typeof__(x))
#else
#define TYPEOF(x)
#endif

#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))

#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>
#if defined(__CYGWIN__)
#undef _XOPEN_SOURCE
#include <grp.h>
#define _XOPEN_SOURCE 600
#else
#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
#include <grp.h>
#define _ALL_SOURCE 1
#endif

#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

#ifndef PRIuMAX
#define PRIuMAX "llu"
#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 warning(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

#ifdef NO_STRTOUMAX
#define strtoumax gitstrtoumax
extern uintmax_t gitstrtoumax(const char *, char **, int);
#endif

extern void release_pack_memory(size_t, int);

static inline char* xstrdup(const char *str)
{
	char *ret = strdup(str);
	if (!ret) {
		release_pack_memory(strlen(str) + 1, -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, -1);
		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 char *xstrndup(const char *str, size_t len)
{
	char *p;

	p = memchr(str, '\0', len);
	if (p)
		len = p - str;
	p = xmalloc(len + 1);
	memcpy(p, str, len);
	p[len] = '\0';
	return p;
}

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, -1);
		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, -1);
		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, fd);
		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 size_t xsize_t(off_t len)
{
	return (size_t)len;
}

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

static inline int prefixcmp(const char *str, const char *prefix)
{
	return strncmp(str, prefix, strlen(prefix));
}

static inline int strtoul_ui(char const *s, int base, unsigned int *result)
{
	unsigned long ul;
	char *p;

	errno = 0;
	ul = strtoul(s, &p, base);
	if (errno || *p || p == s || (unsigned int) ul != ul)
		return -1;
	*result = ul;
	return 0;
}

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