[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) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
# 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]))
#define bitsizeof(x)  (CHAR_BIT * sizeof(x))

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

#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
#define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */

#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))

/* 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(__sun__)
 /*
  * On Solaris, when _XOPEN_EXTENDED is set, its header file
  * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
  * setting to say we are XPG5 or XPG6.  Also on Solaris,
  * XPG6 programs must be compiled with a c99 compiler, while
  * non XPG6 programs must be compiled with a pre-c99 compiler.
  */
# if __STDC_VERSION__ - 0 >= 199901L
# define _XOPEN_SOURCE 600
# else
# define _XOPEN_SOURCE 500
# endif
#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
      !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
#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
#define _NETBSD_SOURCE 1
#define _SGI_SOURCE 1

#ifdef WIN32 /* Both MinGW and MSVC */
#define WIN32_LEAN_AND_MEAN  /* stops windows.h including winsock.h */
#include <winsock2.h>
#include <windows.h>
#endif

#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 <fnmatch.h>
#include <assert.h>
#include <regex.h>
#include <utime.h>
#ifndef __MINGW32__
#include <sys/wait.h>
#include <sys/poll.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <termios.h>
#ifndef NO_SYS_SELECT_H
#include <sys/select.h>
#endif
#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
#include "compat/cygwin.h"
#else
#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
#include <grp.h>
#define _ALL_SOURCE 1
#endif
#else 	/* __MINGW32__ */
/* pull in Windows compatibility stuff */
#include "compat/mingw.h"
#endif	/* __MINGW32__ */
#ifdef _MSC_VER
#include "compat/msvc.h"
#endif

#ifndef NO_LIBGEN_H
#include <libgen.h>
#else
#define basename gitbasename
extern char *gitbasename(char *);
#endif

#ifndef NO_ICONV
#include <iconv.h>
#endif

#ifndef NO_OPENSSL
#include <openssl/ssl.h>
#include <openssl/err.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

#ifndef PRIu32
#define PRIu32 "u"
#endif

#ifndef PRIx32
#define PRIx32 "x"
#endif

#ifndef PATH_SEP
#define PATH_SEP ':'
#endif

#ifdef HAVE_PATHS_H
#include <paths.h>
#endif
#ifndef _PATH_DEFPATH
#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
#endif

#ifndef STRIP_EXTENSION
#define STRIP_EXTENSION ""
#endif

#ifndef has_dos_drive_prefix
#define has_dos_drive_prefix(path) 0
#endif

#ifndef is_dir_sep
#define is_dir_sep(c) ((c) == '/')
#endif

#ifdef __GNUC__
#define NORETURN __attribute__((__noreturn__))
#define NORETURN_PTR __attribute__((__noreturn__))
#elif defined(_MSC_VER)
#define NORETURN __declspec(noreturn)
#define NORETURN_PTR
#else
#define NORETURN
#define NORETURN_PTR
#ifndef __attribute__
#define __attribute__(x)
#endif
#endif

#include "compat/bswap.h"

/* General helper functions */
extern NORETURN void usage(const char *err);
extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
extern NORETURN void die_errno(const char *err, ...) __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_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));

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

static inline const char *skip_prefix(const char *str, const char *prefix)
{
	size_t len = strlen(prefix);
	return strncmp(str, prefix, len) ? NULL : str + len;
}

#if defined(NO_MMAP) || defined(USE_WIN32_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);

#else /* NO_MMAP || USE_WIN32_MMAP */

#include <sys/mman.h>

#endif /* NO_MMAP || USE_WIN32_MMAP */

#ifdef NO_MMAP

/* This value must be multiple of (pagesize * 2) */
#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)

#else /* NO_MMAP */

/* 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 */

#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
#define on_disk_bytes(st) ((st).st_size)
#else
#define on_disk_bytes(st) ((st).st_blocks * 512)
#endif

#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
/*
 * Forward decl that will remind us if its twin in cache.h changes.
 * This function is used in compat/pread.c.  But we can't include
 * cache.h there.
 */
extern ssize_t read_in_full(int fd, void *buf, size_t count);

#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_MKSTEMPS
#define mkstemps gitmkstemps
extern int gitmkstemps(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

#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
#define HAVE_MEMPCPY
#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

#ifndef HAVE_MEMPCPY
#define mempcpy gitmempcpy
static inline void *gitmempcpy(void *dest, const void *src, size_t n)
{
	return (char *)memcpy(dest, src, n) + n;
}
#endif

extern void release_pack_memory(size_t, int);

extern void set_try_to_free_routine(void (*routine)(size_t));

extern char *xstrdup(const char *str);
extern void *xmalloc(size_t size);
extern void *xmallocz(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);
extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);

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 isascii
#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 GIT_GLOB_SPECIAL 0x08
#define GIT_REGEX_SPECIAL 0x10
#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
#define isascii(x) (((x) & ~0x7f) == 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 is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
#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

#ifdef NO_NSEC
#undef USE_NSEC
#define ST_CTIME_NSEC(st) 0
#define ST_MTIME_NSEC(st) 0
#else
#ifdef USE_ST_TIMESPEC
#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
#else
#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
#endif
#endif

#ifdef UNRELIABLE_FSTAT
#define fstat_is_reliable() 0
#else
#define fstat_is_reliable() 1
#endif

/*
 * Preserves errno, prints a message, but gives no warning for ENOENT.
 * Always returns the return value of unlink(2).
 */
int unlink_or_warn(const char *path);
/*
 * Likewise for rmdir(2).
 */
int rmdir_or_warn(const char *path);
/*
 * Calls the correct function out of {unlink,rmdir}_or_warn based on
 * the supplied file mode.
 */
int remove_or_warn(unsigned int mode, const char *path);

#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	*/
203ee91f	10	#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) \|\| (__SUNPRO_C > 0x580))
8e973991 JH	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	28	#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
f630cfda	29	#define bitsizeof(x) (CHAR_BIT * sizeof(x))
b4f2a6ac	30
8723f216 NP	31	#ifdef __GNUC__
	32	#define TYPEOF(x) (__typeof__(x))
	33	#else
	34	#define TYPEOF(x)
	35	#endif
	36
f630cfda	37	#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
db7244bd	38	#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216	39
98cb6f30 PH	40	#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
98cb6f30 PH	41
cf606e3d AW	42	/* Approximation of the length of the decimal representation of this type. */
	43	#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
	44
4cb18a49 BC	45	#if defined(__sun__)
	46	/*
	47	* On Solaris, when _XOPEN_EXTENDED is set, its header file
	48	* forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
	49	* setting to say we are XPG5 or XPG6. Also on Solaris,
	50	* XPG6 programs must be compiled with a c99 compiler, while
	51	* non XPG6 programs must be compiled with a pre-c99 compiler.
	52	*/
	53	# if __STDC_VERSION__ - 0 >= 199901L
	54	# define _XOPEN_SOURCE 600
	55	# else
	56	# define _XOPEN_SOURCE 500
	57	# endif
6555b196	58	#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
761a889a	59	!defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
85023577 JH	60	#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
85023577 JH	61	#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6	62	#endif
fb952206 JR	63	#define _ALL_SOURCE 1
	64	#define _GNU_SOURCE 1
	65	#define _BSD_SOURCE 1
9a695fbf	66	#define _NETBSD_SOURCE 1
9398b859	67	#define _SGI_SOURCE 1
85023577	68
435bdf8c MSO	69	#ifdef WIN32 /* Both MinGW and MSVC */
	70	#define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
	71	#include <winsock2.h>
	72	#include <windows.h>
	73	#endif
	74
4050c0df JH	75	#include <unistd.h>
	76	#include <stdio.h>
	77	#include <sys/stat.h>
	78	#include <fcntl.h>
	79	#include <stddef.h>
	80	#include <stdlib.h>
	81	#include <stdarg.h>
	82	#include <string.h>
	83	#include <errno.h>
	84	#include <limits.h>
	85	#include <sys/param.h>
4050c0df JH	86	#include <sys/types.h>
4050c0df JH	87	#include <dirent.h>
85023577 JH	88	#include <sys/time.h>
	89	#include <time.h>
	90	#include <signal.h>
85023577	91	#include <fnmatch.h>
f4626df5 JS	92	#include <assert.h>
	93	#include <regex.h>
	94	#include <utime.h>
	95	#ifndef __MINGW32__
	96	#include <sys/wait.h>
85023577 JH	97	#include <sys/poll.h>
85023577 JH	98	#include <sys/socket.h>
80bbe72b	99	#include <sys/ioctl.h>
eb80042c	100	#include <termios.h>
2600973f	101	#ifndef NO_SYS_SELECT_H
80bbe72b	102	#include <sys/select.h>
2600973f	103	#endif
85023577 JH	104	#include <netinet/in.h>
	105	#include <netinet/tcp.h>
	106	#include <arpa/inet.h>
	107	#include <netdb.h>
	108	#include <pwd.h>
007e2ba6	109	#include <inttypes.h>
41b20017 RJ	110	#if defined(__CYGWIN__)
	111	#undef _XOPEN_SOURCE
	112	#include <grp.h>
	113	#define _XOPEN_SOURCE 600
adbc0b6b	114	#include "compat/cygwin.h"
41b20017	115	#else
fb952206	116	#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577	117	#include <grp.h>
fb952206	118	#define _ALL_SOURCE 1
41b20017	119	#endif
f4626df5 JS	120	#else /* __MINGW32__ */
	121	/* pull in Windows compatibility stuff */
	122	#include "compat/mingw.h"
	123	#endif /* __MINGW32__ */
d75f8e61 FL	124	#ifdef _MSC_VER
	125	#include "compat/msvc.h"
	126	#endif
85023577	127
e1c06886 DA	128	#ifndef NO_LIBGEN_H
	129	#include <libgen.h>
	130	#else
	131	#define basename gitbasename
	132	extern char gitbasename(char );
	133	#endif
	134
85023577 JH	135	#ifndef NO_ICONV
	136	#include <iconv.h>
	137	#endif
4050c0df	138
684ec6c6 RS	139	#ifndef NO_OPENSSL
	140	#include <openssl/ssl.h>
	141	#include <openssl/err.h>
	142	#endif
	143
d0c2449f JH	144	/* On most systems <limits.h> would have given us this, but
	145	* not on some systems (e.g. GNU/Hurd).
	146	*/
	147	#ifndef PATH_MAX
	148	#define PATH_MAX 4096
	149	#endif
	150
c4001d92 SP	151	#ifndef PRIuMAX
	152	#define PRIuMAX "llu"
	153	#endif
	154
607bb3ff JS	155	#ifndef PRIu32
	156	#define PRIu32 "u"
	157	#endif
	158
	159	#ifndef PRIx32
	160	#define PRIx32 "x"
	161	#endif
	162
80ba074f JS	163	#ifndef PATH_SEP
	164	#define PATH_SEP ':'
	165	#endif
	166
cb6a22c0 CW	167	#ifdef HAVE_PATHS_H
	168	#include <paths.h>
	169	#endif
	170	#ifndef _PATH_DEFPATH
	171	#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
	172	#endif
	173
23326d14 JS	174	#ifndef STRIP_EXTENSION
	175	#define STRIP_EXTENSION ""
	176	#endif
	177
25fe217b JS	178	#ifndef has_dos_drive_prefix
	179	#define has_dos_drive_prefix(path) 0
	180	#endif
	181
	182	#ifndef is_dir_sep
	183	#define is_dir_sep(c) ((c) == '/')
	184	#endif
	185
4050c0df JH	186	#ifdef __GNUC__
4050c0df JH	187	#define NORETURN __attribute__((__noreturn__))
18660bc9	188	#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8 RJ	189	#elif defined(_MSC_VER)
	190	#define NORETURN __declspec(noreturn)
	191	#define NORETURN_PTR
4050c0df JH	192	#else
4050c0df JH	193	#define NORETURN
18660bc9	194	#define NORETURN_PTR
4050c0df JH	195	#ifndef __attribute__
	196	#define __attribute__(x)
	197	#endif
	198	#endif
	199
51ea5519 NP	200	#include "compat/bswap.h"
51ea5519 NP	201
4050c0df	202	/* General helper functions */
a4f3131c	203	extern NORETURN void usage(const char *err);
64b1cb74	204	extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
a4f3131c EFL	205	extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
a4f3131c EFL	206	extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df	207	extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9	208	extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df	209
18660bc9	210	extern void set_die_routine(NORETURN_PTR void (routine)(const char err, va_list params));
39a3f5ea	211
698a68be	212	extern int prefixcmp(const char str, const char prefix);
8cc5b290	213	extern int suffixcmp(const char str, const char suffix);
698a68be	214
fbca5837 MV	215	static inline const char skip_prefix(const char str, const char *prefix)
	216	{
	217	size_t len = strlen(prefix);
	218	return strncmp(str, prefix, len) ? NULL : str + len;
	219	}
	220
b130a72b	221	#if defined(NO_MMAP) \|\| defined(USE_WIN32_MMAP)
4050c0df JH	222
	223	#ifndef PROT_READ
	224	#define PROT_READ 1
	225	#define PROT_WRITE 2
	226	#define MAP_PRIVATE 1
	227	#define MAP_FAILED ((void*)-1)
	228	#endif
	229
d6779124 SP	230	#define mmap git_mmap
	231	#define munmap git_munmap
	232	extern void git_mmap(void start, size_t length, int prot, int flags, int fd, off_t offset);
	233	extern int git_munmap(void *start, size_t length);
4050c0df	234
b130a72b JL	235	#else /* NO_MMAP \|\| USE_WIN32_MMAP */
	236
	237	#include <sys/mman.h>
	238
	239	#endif /* NO_MMAP \|\| USE_WIN32_MMAP */
	240
	241	#ifdef NO_MMAP
	242
5faaf246	243	/* This value must be multiple of (pagesize * 2) */
8c82534d SP	244	#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
8c82534d SP	245
4050c0df JH	246	#else /* NO_MMAP */
4050c0df JH	247
5faaf246	248	/* This value must be multiple of (pagesize * 2) */
22bac0ea SP	249	#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
	250	(sizeof(void*) >= 8 \
	251	? 1 * 1024 * 1024 * 1024 \
	252	: 32 * 1024 * 1024)
4050c0df JH	253
	254	#endif /* NO_MMAP */
	255
fdb2a2a6 JH	256	#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
	257	#define on_disk_bytes(st) ((st).st_size)
	258	#else
	259	#define on_disk_bytes(st) ((st).st_blocks * 512)
	260	#endif
	261
22bac0ea	262	#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a	263	((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d	264
6900679c SH	265	#ifdef NO_PREAD
	266	#define pread git_pread
	267	extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
	268	#endif
14086b0a SP	269	/*
	270	* Forward decl that will remind us if its twin in cache.h changes.
	271	* This function is used in compat/pread.c. But we can't include
	272	* cache.h there.
	273	*/
	274	extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c	275
4050c0df JH	276	#ifdef NO_SETENV
	277	#define setenv gitsetenv
	278	extern int gitsetenv(const char , const char , int);
	279	#endif
	280
ca5bb5d5 SP	281	#ifdef NO_MKDTEMP
	282	#define mkdtemp gitmkdtemp
	283	extern char gitmkdtemp(char );
	284	#endif
	285
0620b39b DA	286	#ifdef NO_MKSTEMPS
	287	#define mkstemps gitmkstemps
	288	extern int gitmkstemps(char *, int);
	289	#endif
	290
731043fd JR	291	#ifdef NO_UNSETENV
	292	#define unsetenv gitunsetenv
	293	extern void gitunsetenv(const char *);
	294	#endif
	295
4050c0df JH	296	#ifdef NO_STRCASESTR
	297	#define strcasestr gitstrcasestr
	298	extern char gitstrcasestr(const char haystack, const char *needle);
	299	#endif
	300
817151e6 PE	301	#ifdef NO_STRLCPY
	302	#define strlcpy gitstrlcpy
	303	extern size_t gitstrlcpy(char , const char , size_t);
	304	#endif
	305
bc6b4f52 JR	306	#ifdef NO_STRTOUMAX
	307	#define strtoumax gitstrtoumax
	308	extern uintmax_t gitstrtoumax(const char , char *, int);
	309	#endif
	310
fa0c87c3 AR	311	#ifdef NO_HSTRERROR
	312	#define hstrerror githstrerror
	313	extern const char *githstrerror(int herror);
	314	#endif
	315
b21b9f1d RS	316	#ifdef NO_MEMMEM
	317	#define memmem gitmemmem
	318	void gitmemmem(const void haystack, size_t haystacklen,
	319	const void *needle, size_t needlelen);
	320	#endif
	321
cba22528	322	#ifdef FREAD_READS_DIRECTORIES
c5445fe0 JS	323	#ifdef fopen
	324	#undef fopen
	325	#endif
cba22528 BC	326	#define fopen(a,b) git_fopen(a,b)
	327	extern FILE git_fopen(const char, const char*);
	328	#endif
	329
c4582f93 MR	330	#ifdef SNPRINTF_RETURNS_BOGUS
	331	#define snprintf git_snprintf
	332	extern int git_snprintf(char *str, size_t maxsize,
	333	const char *format, ...);
	334	#define vsnprintf git_vsnprintf
	335	extern int git_vsnprintf(char *str, size_t maxsize,
	336	const char *format, va_list ap);
	337	#endif
	338
726c8ef5 JS	339	#ifdef __GLIBC_PREREQ
	340	#if __GLIBC_PREREQ(2, 1)
	341	#define HAVE_STRCHRNUL
137c6eaa	342	#define HAVE_MEMPCPY
726c8ef5 JS	343	#endif
	344	#endif
	345
	346	#ifndef HAVE_STRCHRNUL
659c69cf	347	#define strchrnul gitstrchrnul
9e79f00f AE	348	static inline char gitstrchrnul(const char s, int c)
	349	{
	350	while (s && s != c)
	351	s++;
	352	return (char *)s;
	353	}
659c69cf RS	354	#endif
659c69cf RS	355
137c6eaa JN	356	#ifndef HAVE_MEMPCPY
	357	#define mempcpy gitmempcpy
	358	static inline void gitmempcpy(void dest, const void *src, size_t n)
	359	{
	360	return (char *)memcpy(dest, src, n) + n;
	361	}
	362	#endif
	363
d1efefa4	364	extern void release_pack_memory(size_t, int);
97bfeb34	365
a9a74636 NP	366	extern void set_try_to_free_routine(void (*routine)(size_t));
a9a74636 NP	367
112db553 LT	368	extern char xstrdup(const char str);
112db553 LT	369	extern void *xmalloc(size_t size);
5bf9219d	370	extern void *xmallocz(size_t size);
112db553 LT	371	extern void xmemdupz(const void data, size_t len);
	372	extern char xstrndup(const char str, size_t len);
	373	extern void xrealloc(void ptr, size_t size);
	374	extern void *xcalloc(size_t nmemb, size_t size);
	375	extern void xmmap(void start, size_t length, int prot, int flags, int fd, off_t offset);
	376	extern ssize_t xread(int fd, void *buf, size_t len);
	377	extern ssize_t xwrite(int fd, const void *buf, size_t len);
	378	extern int xdup(int fd);
	379	extern FILE xfdopen(int fd, const char mode);
	380	extern int xmkstemp(char *template);
6e180cdc JH	381	extern int odb_mkstemp(char template, size_t limit, const char pattern);
6e180cdc JH	382	extern int odb_pack_keep(char name, size_t namesz, unsigned char sha1);
f21a47b2	383
dc49cd76 SP	384	static inline size_t xsize_t(off_t len)
	385	{
	386	return (size_t)len;
	387	}
	388
5bb1cda5	389	static inline int has_extension(const char filename, const char ext)
83a2b841	390	{
5bb1cda5 RS	391	size_t len = strlen(filename);
5bb1cda5 RS	392	size_t extlen = strlen(ext);
83a2b841 RS	393	return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
	394	}
	395
4050c0df	396	/* Sane ctype - no locale, and works with signed chars */
c2e9364a	397	#undef isascii
4050c0df JH	398	#undef isspace
	399	#undef isdigit
	400	#undef isalpha
	401	#undef isalnum
	402	#undef tolower
	403	#undef toupper
	404	extern unsigned char sane_ctype[256];
	405	#define GIT_SPACE 0x01
	406	#define GIT_DIGIT 0x02
	407	#define GIT_ALPHA 0x04
8cc32992	408	#define GIT_GLOB_SPECIAL 0x08
f9b7cce6	409	#define GIT_REGEX_SPECIAL 0x10
4050c0df	410	#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a	411	#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df JH	412	#define isspace(x) sane_istest(x,GIT_SPACE)
	413	#define isdigit(x) sane_istest(x,GIT_DIGIT)
	414	#define isalpha(x) sane_istest(x,GIT_ALPHA)
	415	#define isalnum(x) sane_istest(x,GIT_ALPHA \| GIT_DIGIT)
8cc32992	416	#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6	417	#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL \| GIT_REGEX_SPECIAL)
4050c0df JH	418	#define tolower(x) sane_case((unsigned char)(x), 0x20)
	419	#define toupper(x) sane_case((unsigned char)(x), 0)
	420
	421	static inline int sane_case(int x, int high)
	422	{
	423	if (sane_istest(x, GIT_ALPHA))
	424	x = (x & ~0x20) \| high;
	425	return x;
	426	}
	427
6aead43d JM	428	static inline int strtoul_ui(char const s, int base, unsigned int result)
	429	{
	430	unsigned long ul;
	431	char *p;
	432
	433	errno = 0;
	434	ul = strtoul(s, &p, base);
	435	if (errno \|\| *p \|\| p == s \|\| (unsigned int) ul != ul)
	436	return -1;
	437	*result = ul;
	438	return 0;
	439	}
	440
7791ecbc JH	441	static inline int strtol_i(char const s, int base, int result)
	442	{
	443	long ul;
	444	char *p;
	445
	446	errno = 0;
	447	ul = strtol(s, &p, base);
	448	if (errno \|\| *p \|\| p == s \|\| (int) ul != ul)
	449	return -1;
	450	*result = ul;
	451	return 0;
	452	}
	453
43fe901b BD	454	#ifdef INTERNAL_QSORT
	455	void git_qsort(void *base, size_t nmemb, size_t size,
	456	int(compar)(const void , const void *));
	457	#define qsort git_qsort
	458	#endif
	459
81a24b52 AR	460	#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
	461	# define FORCE_DIR_SET_GID S_ISGID
	462	#else
	463	# define FORCE_DIR_SET_GID 0
	464	#endif
	465
c06ff490 KB	466	#ifdef NO_NSEC
	467	#undef USE_NSEC
	468	#define ST_CTIME_NSEC(st) 0
	469	#define ST_MTIME_NSEC(st) 0
	470	#else
c567383b BG	471	#ifdef USE_ST_TIMESPEC
	472	#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
	473	#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
	474	#else
c06ff490 KB	475	#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
	476	#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
	477	#endif
c567383b	478	#endif
c06ff490	479
34779c53 JS	480	#ifdef UNRELIABLE_FSTAT
	481	#define fstat_is_reliable() 0
	482	#else
	483	#define fstat_is_reliable() 1
	484	#endif
	485
fc71db39 AR	486	/*
	487	* Preserves errno, prints a message, but gives no warning for ENOENT.
	488	* Always returns the return value of unlink(2).
	489	*/
	490	int unlink_or_warn(const char *path);
d1723296 PC	491	/*
	492	* Likewise for rmdir(2).
	493	*/
	494	int rmdir_or_warn(const char *path);
80d706af PC	495	/*
	496	* Calls the correct function out of {unlink,rmdir}_or_warn based on
	497	* the supplied file mode.
	498	*/
	499	int remove_or_warn(unsigned int mode, const char *path);
fc71db39	500
4050c0df	501	#endif