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

#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

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