[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
/*
 * See if our compiler is known to support flexible array members.
 */
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
# define FLEX_ARRAY /* empty */
#elif defined(__GNUC__)
# if (__GNUC__ >= 3)
#  define FLEX_ARRAY /* empty */
# else
#  define FLEX_ARRAY 0 /* older GNU extension */
# endif
#endif

/*
 * Otherwise, default to safer but a bit wasteful traditional style
 */
#ifndef FLEX_ARRAY
# define FLEX_ARRAY 1
#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))))
#define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */

/* 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__)  && !defined(__USLC__) && !defined(_M_UNIX)
#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 <sys/ioctl.h>
#include <utime.h>
#ifndef NO_SYS_SELECT_H
#include <sys/select.h>
#endif
#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));

extern int prefixcmp(const char *str, const char *prefix);

#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_MKDTEMP
#define mkdtemp gitmkdtemp
extern char *gitmkdtemp(char *);
#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

#ifdef NO_HSTRERROR
#define hstrerror githstrerror
extern const char *githstrerror(int herror);
#endif

#ifdef NO_MEMMEM
#define memmem gitmemmem
void *gitmemmem(const void *haystack, size_t haystacklen,
                const void *needle, size_t needlelen);
#endif

#ifdef FREAD_READS_DIRECTORIES
#ifdef fopen
#undef fopen
#endif
#define fopen(a,b) git_fopen(a,b)
extern FILE *git_fopen(const char*, const char*);
#endif

#ifdef SNPRINTF_RETURNS_BOGUS
#define snprintf git_snprintf
extern int git_snprintf(char *str, size_t maxsize,
			const char *format, ...);
#define vsnprintf git_vsnprintf
extern int git_vsnprintf(char *str, size_t maxsize,
			 const char *format, va_list ap);
#endif

#ifdef __GLIBC_PREREQ
#if __GLIBC_PREREQ(2, 1)
#define HAVE_STRCHRNUL
#endif
#endif

#ifndef HAVE_STRCHRNUL
#define strchrnul gitstrchrnul
static inline char *gitstrchrnul(const char *s, int c)
{
	while (*s && *s != c)
		s++;
	return (char *)s;
}
#endif

extern void release_pack_memory(size_t, int);

extern char *xstrdup(const char *str);
extern void *xmalloc(size_t size);
extern void *xmemdupz(const void *data, size_t len);
extern char *xstrndup(const char *str, size_t len);
extern void *xrealloc(void *ptr, size_t size);
extern void *xcalloc(size_t nmemb, size_t size);
extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
extern ssize_t xread(int fd, void *buf, size_t len);
extern ssize_t xwrite(int fd, const void *buf, size_t len);
extern int xdup(int fd);
extern FILE *xfdopen(int fd, const char *mode);
extern int xmkstemp(char *template);

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

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

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

#ifdef INTERNAL_QSORT
void git_qsort(void *base, size_t nmemb, size_t size,
	       int(*compar)(const void *, const void *));
#define qsort git_qsort
#endif

#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
# define FORCE_DIR_SET_GID S_ISGID
#else
# define FORCE_DIR_SET_GID 0
#endif

#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	6	#ifndef FLEX_ARRAY
8e973991 JH	7	/*
	8	* See if our compiler is known to support flexible array members.
	9	*/
	10	#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
	11	# define FLEX_ARRAY /* empty */
	12	#elif defined(__GNUC__)
	13	# if (__GNUC__ >= 3)
	14	# define FLEX_ARRAY /* empty */
	15	# else
	16	# define FLEX_ARRAY 0 /* older GNU extension */
	17	# endif
	18	#endif
	19
	20	/*
	21	* Otherwise, default to safer but a bit wasteful traditional style
	22	*/
	23	#ifndef FLEX_ARRAY
	24	# define FLEX_ARRAY 1
8f1d2e6f JH	25	#endif
	26	#endif
	27
b4f2a6ac JH	28	#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
b4f2a6ac JH	29
8723f216 NP	30	#ifdef __GNUC__
	31	#define TYPEOF(x) (__typeof__(x))
	32	#else
	33	#define TYPEOF(x)
	34	#endif
	35
	36	#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
db7244bd	37	#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216	38
cf606e3d AW	39	/* Approximation of the length of the decimal representation of this type. */
	40	#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
	41
457bb452	42	#if !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX)
85023577 JH	43	#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
85023577 JH	44	#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6	45	#endif
fb952206 JR	46	#define _ALL_SOURCE 1
	47	#define _GNU_SOURCE 1
	48	#define _BSD_SOURCE 1
85023577	49
4050c0df JH	50	#include <unistd.h>
	51	#include <stdio.h>
	52	#include <sys/stat.h>
	53	#include <fcntl.h>
	54	#include <stddef.h>
	55	#include <stdlib.h>
	56	#include <stdarg.h>
	57	#include <string.h>
	58	#include <errno.h>
	59	#include <limits.h>
	60	#include <sys/param.h>
4050c0df JH	61	#include <sys/types.h>
4050c0df JH	62	#include <dirent.h>
85023577 JH	63	#include <sys/time.h>
	64	#include <time.h>
	65	#include <signal.h>
	66	#include <sys/wait.h>
	67	#include <fnmatch.h>
	68	#include <sys/poll.h>
	69	#include <sys/socket.h>
80bbe72b	70	#include <sys/ioctl.h>
f746bae8	71	#include <utime.h>
2600973f	72	#ifndef NO_SYS_SELECT_H
80bbe72b	73	#include <sys/select.h>
2600973f	74	#endif
85023577 JH	75	#include <assert.h>
	76	#include <regex.h>
	77	#include <netinet/in.h>
	78	#include <netinet/tcp.h>
	79	#include <arpa/inet.h>
	80	#include <netdb.h>
	81	#include <pwd.h>
007e2ba6	82	#include <inttypes.h>
41b20017 RJ	83	#if defined(__CYGWIN__)
	84	#undef _XOPEN_SOURCE
	85	#include <grp.h>
	86	#define _XOPEN_SOURCE 600
	87	#else
fb952206	88	#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577	89	#include <grp.h>
fb952206	90	#define _ALL_SOURCE 1
41b20017	91	#endif
85023577 JH	92
	93	#ifndef NO_ICONV
	94	#include <iconv.h>
	95	#endif
4050c0df	96
d0c2449f JH	97	/* On most systems <limits.h> would have given us this, but
	98	* not on some systems (e.g. GNU/Hurd).
	99	*/
	100	#ifndef PATH_MAX
	101	#define PATH_MAX 4096
	102	#endif
	103
c4001d92 SP	104	#ifndef PRIuMAX
	105	#define PRIuMAX "llu"
	106	#endif
	107
4050c0df JH	108	#ifdef __GNUC__
	109	#define NORETURN __attribute__((__noreturn__))
	110	#else
	111	#define NORETURN
	112	#ifndef __attribute__
	113	#define __attribute__(x)
	114	#endif
	115	#endif
	116
	117	/* General helper functions */
	118	extern void usage(const char *err) NORETURN;
	119	extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
	120	extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9	121	extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df	122
39a3f5ea PB	123	extern void set_usage_routine(void (routine)(const char err) NORETURN);
	124	extern void set_die_routine(void (routine)(const char err, va_list params) NORETURN);
	125	extern void set_error_routine(void (routine)(const char err, va_list params));
fa39b6b5	126	extern void set_warn_routine(void (routine)(const char warn, va_list params));
39a3f5ea	127
698a68be JH	128	extern int prefixcmp(const char str, const char prefix);
698a68be JH	129
4050c0df JH	130	#ifdef NO_MMAP
	131
	132	#ifndef PROT_READ
	133	#define PROT_READ 1
	134	#define PROT_WRITE 2
	135	#define MAP_PRIVATE 1
	136	#define MAP_FAILED ((void*)-1)
	137	#endif
	138
d6779124 SP	139	#define mmap git_mmap
	140	#define munmap git_munmap
	141	extern void git_mmap(void start, size_t length, int prot, int flags, int fd, off_t offset);
	142	extern int git_munmap(void *start, size_t length);
4050c0df	143
5faaf246	144	/* This value must be multiple of (pagesize * 2) */
8c82534d SP	145	#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
8c82534d SP	146
4050c0df JH	147	#else /* NO_MMAP */
	148
	149	#include <sys/mman.h>
5faaf246 JH	150
5faaf246 JH	151	/* This value must be multiple of (pagesize * 2) */
22bac0ea SP	152	#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
	153	(sizeof(void*) >= 8 \
	154	? 1 * 1024 * 1024 * 1024 \
	155	: 32 * 1024 * 1024)
4050c0df JH	156
	157	#endif /* NO_MMAP */
	158
22bac0ea	159	#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a	160	((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d	161
6900679c SH	162	#ifdef NO_PREAD
	163	#define pread git_pread
	164	extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
	165	#endif
	166
4050c0df JH	167	#ifdef NO_SETENV
	168	#define setenv gitsetenv
	169	extern int gitsetenv(const char , const char , int);
	170	#endif
	171
ca5bb5d5 SP	172	#ifdef NO_MKDTEMP
	173	#define mkdtemp gitmkdtemp
	174	extern char gitmkdtemp(char );
	175	#endif
	176
731043fd JR	177	#ifdef NO_UNSETENV
	178	#define unsetenv gitunsetenv
	179	extern void gitunsetenv(const char *);
	180	#endif
	181
4050c0df JH	182	#ifdef NO_STRCASESTR
	183	#define strcasestr gitstrcasestr
	184	extern char gitstrcasestr(const char haystack, const char *needle);
	185	#endif
	186
817151e6 PE	187	#ifdef NO_STRLCPY
	188	#define strlcpy gitstrlcpy
	189	extern size_t gitstrlcpy(char , const char , size_t);
	190	#endif
	191
bc6b4f52 JR	192	#ifdef NO_STRTOUMAX
	193	#define strtoumax gitstrtoumax
	194	extern uintmax_t gitstrtoumax(const char , char *, int);
	195	#endif
	196
fa0c87c3 AR	197	#ifdef NO_HSTRERROR
	198	#define hstrerror githstrerror
	199	extern const char *githstrerror(int herror);
	200	#endif
	201
b21b9f1d RS	202	#ifdef NO_MEMMEM
	203	#define memmem gitmemmem
	204	void gitmemmem(const void haystack, size_t haystacklen,
	205	const void *needle, size_t needlelen);
	206	#endif
	207
cba22528	208	#ifdef FREAD_READS_DIRECTORIES
c5445fe0 JS	209	#ifdef fopen
	210	#undef fopen
	211	#endif
cba22528 BC	212	#define fopen(a,b) git_fopen(a,b)
	213	extern FILE git_fopen(const char, const char*);
	214	#endif
	215
c4582f93 MR	216	#ifdef SNPRINTF_RETURNS_BOGUS
	217	#define snprintf git_snprintf
	218	extern int git_snprintf(char *str, size_t maxsize,
	219	const char *format, ...);
	220	#define vsnprintf git_vsnprintf
	221	extern int git_vsnprintf(char *str, size_t maxsize,
	222	const char *format, va_list ap);
	223	#endif
	224
726c8ef5 JS	225	#ifdef __GLIBC_PREREQ
	226	#if __GLIBC_PREREQ(2, 1)
	227	#define HAVE_STRCHRNUL
	228	#endif
	229	#endif
	230
	231	#ifndef HAVE_STRCHRNUL
659c69cf	232	#define strchrnul gitstrchrnul
9e79f00f AE	233	static inline char gitstrchrnul(const char s, int c)
	234	{
	235	while (s && s != c)
	236	s++;
	237	return (char *)s;
	238	}
659c69cf RS	239	#endif
659c69cf RS	240
d1efefa4	241	extern void release_pack_memory(size_t, int);
97bfeb34	242
112db553 LT	243	extern char xstrdup(const char str);
	244	extern void *xmalloc(size_t size);
	245	extern void xmemdupz(const void data, size_t len);
	246	extern char xstrndup(const char str, size_t len);
	247	extern void xrealloc(void ptr, size_t size);
	248	extern void *xcalloc(size_t nmemb, size_t size);
	249	extern void xmmap(void start, size_t length, int prot, int flags, int fd, off_t offset);
	250	extern ssize_t xread(int fd, void *buf, size_t len);
	251	extern ssize_t xwrite(int fd, const void *buf, size_t len);
	252	extern int xdup(int fd);
	253	extern FILE xfdopen(int fd, const char mode);
	254	extern int xmkstemp(char *template);
f21a47b2	255
dc49cd76 SP	256	static inline size_t xsize_t(off_t len)
	257	{
	258	return (size_t)len;
	259	}
	260
5bb1cda5	261	static inline int has_extension(const char filename, const char ext)
83a2b841	262	{
5bb1cda5 RS	263	size_t len = strlen(filename);
5bb1cda5 RS	264	size_t extlen = strlen(ext);
83a2b841 RS	265	return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
	266	}
	267
4050c0df JH	268	/* Sane ctype - no locale, and works with signed chars */
	269	#undef isspace
	270	#undef isdigit
	271	#undef isalpha
	272	#undef isalnum
	273	#undef tolower
	274	#undef toupper
	275	extern unsigned char sane_ctype[256];
	276	#define GIT_SPACE 0x01
	277	#define GIT_DIGIT 0x02
	278	#define GIT_ALPHA 0x04
	279	#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
	280	#define isspace(x) sane_istest(x,GIT_SPACE)
	281	#define isdigit(x) sane_istest(x,GIT_DIGIT)
	282	#define isalpha(x) sane_istest(x,GIT_ALPHA)
	283	#define isalnum(x) sane_istest(x,GIT_ALPHA \| GIT_DIGIT)
	284	#define tolower(x) sane_case((unsigned char)(x), 0x20)
	285	#define toupper(x) sane_case((unsigned char)(x), 0)
	286
	287	static inline int sane_case(int x, int high)
	288	{
	289	if (sane_istest(x, GIT_ALPHA))
	290	x = (x & ~0x20) \| high;
	291	return x;
	292	}
	293
6aead43d JM	294	static inline int strtoul_ui(char const s, int base, unsigned int result)
	295	{
	296	unsigned long ul;
	297	char *p;
	298
	299	errno = 0;
	300	ul = strtoul(s, &p, base);
	301	if (errno \|\| *p \|\| p == s \|\| (unsigned int) ul != ul)
	302	return -1;
	303	*result = ul;
	304	return 0;
	305	}
	306
7791ecbc JH	307	static inline int strtol_i(char const s, int base, int result)
	308	{
	309	long ul;
	310	char *p;
	311
	312	errno = 0;
	313	ul = strtol(s, &p, base);
	314	if (errno \|\| *p \|\| p == s \|\| (int) ul != ul)
	315	return -1;
	316	*result = ul;
	317	return 0;
	318	}
	319
43fe901b BD	320	#ifdef INTERNAL_QSORT
	321	void git_qsort(void *base, size_t nmemb, size_t size,
	322	int(compar)(const void , const void *));
	323	#define qsort git_qsort
	324	#endif
	325
81a24b52 AR	326	#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
	327	# define FORCE_DIR_SET_GID S_ISGID
	328	#else
	329	# define FORCE_DIR_SET_GID 0
	330	#endif
	331
4050c0df	332	#endif