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

/* Approximation of the length of the decimal representation of this type. */
#define decimal_length(x)	((int)(sizeof(x) * 2.56 + 0.5) + 1)

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