[git/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>
#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);

#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)

#else /* NO_MMAP */

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