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

#define maximum_signed_value_of_type(a) \
    (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))

#define maximum_unsigned_value_of_type(a) \
    (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))

/*
 * Signed integer overflow is undefined in C, so here's a helper macro
 * to detect if the sum of two integers will overflow.
 *
 * Requires: a >= 0, typeof(a) equals typeof(b)
 */
#define signed_add_overflows(a, b) \
    ((b) > maximum_signed_value_of_type(a) - (a))

#define unsigned_add_overflows(a, b) \
    ((b) > maximum_unsigned_value_of_type(a) - (a))

#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>
#include <syslog.h>
#ifndef NO_SYS_POLL_H
#include <sys/poll.h>
#else
#include <poll.h>
#endif
#if defined(__MINGW32__)
/* pull in Windows compatibility stuff */
#include "compat/mingw.h"
#elif defined(_MSC_VER)
#include "compat/msvc.h"
#else
#include <sys/wait.h>
#include <sys/resource.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 <sys/un.h>
#ifndef NO_INTTYPES_H
#include <inttypes.h>
#else
#include <stdint.h>
#endif
#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
#endif

/* used on Mac OS X */
#ifdef PRECOMPOSE_UNICODE
#include "compat/precompose_utf8.h"
#else
#define precompose_str(in,i_nfd2nfc)
#define precompose_argv(c,v)
#define probe_utf8_pathname_composition(a,b)
#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 PRIo32
#define PRIo32 "o"
#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

#ifndef find_last_dir_sep
#define find_last_dir_sep(path) strrchr(path, '/')
#endif

#if defined(__HP_cc) && (__HP_cc >= 61000)
#define NORETURN __attribute__((noreturn))
#define NORETURN_PTR
#elif defined(__GNUC__) && !defined(NO_NORETURN)
#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 void vreportf(const char *prefix, const char *err, va_list params);
extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
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 void set_error_routine(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
#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 */

#ifndef MAP_FAILED
#define MAP_FAILED ((void *)-1)
#endif

#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);
#define strtoimax gitstrtoimax
extern intmax_t gitstrtoimax(const char *, char **, int);
#endif

#ifdef NO_STRTOK_R
#define strtok_r gitstrtok_r
extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
#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

#ifdef NO_INET_PTON
int inet_pton(int af, const char *src, void *dst);
#endif

#ifdef NO_INET_NTOP
const char *inet_ntop(int af, const void *src, char *dst, size_t size);
#endif

extern void release_pack_memory(size_t, int);

typedef void (*try_to_free_t)(size_t);
extern try_to_free_t set_try_to_free_routine(try_to_free_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 xmkstemp_mode(char *template, int mode);
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)
{
	if (len > (size_t) len)
		die("Cannot handle files this big");
	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);
}

/* in ctype.c, for kwset users */
extern const char tolower_trans_tbl[256];

/* Sane ctype - no locale, and works with signed chars */
#undef isascii
#undef isspace
#undef isdigit
#undef isalpha
#undef isalnum
#undef islower
#undef isupper
#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 GIT_PATHSPEC_MAGIC 0x20
#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 islower(x) sane_iscase(x, 1)
#define isupper(x) sane_iscase(x, 0)
#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)
#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)

static inline int sane_case(int x, int high)
{
	if (sane_istest(x, GIT_ALPHA))
		x = (x & ~0x20) | high;
	return x;
}

static inline int sane_iscase(int x, int is_lower)
{
	if (!sane_istest(x, GIT_ALPHA))
		return 0;

	if (is_lower)
		return (x & 0x20) != 0;
	else
		return (x & 0x20) == 0;
}

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

#ifndef va_copy
/*
 * Since an obvious implementation of va_list would be to make it a
 * pointer into the stack frame, a simple assignment will work on
 * many systems.  But let's try to be more portable.
 */
#ifdef __va_copy
#define va_copy(dst, src) __va_copy(dst, src)
#else
#define va_copy(dst, src) ((dst) = (src))
#endif
#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);

/* Call access(2), but warn for any error besides ENOENT. */
int access_or_warn(const char *path, int mode);

/* Warn on an inaccessible file that ought to be accessible */
void warn_on_inaccessible(const char *path);

/* Get the passwd entry for the UID of the current process. */
struct passwd *xgetpwuid_self(void);

#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
c03c8315 EFL	31	#define maximum_signed_value_of_type(a) \
	32	(INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
	33
1368f650 JN	34	#define maximum_unsigned_value_of_type(a) \
	35	(UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
	36
c03c8315 EFL	37	/*
	38	* Signed integer overflow is undefined in C, so here's a helper macro
	39	* to detect if the sum of two integers will overflow.
	40	*
	41	* Requires: a >= 0, typeof(a) equals typeof(b)
	42	*/
	43	#define signed_add_overflows(a, b) \
	44	((b) > maximum_signed_value_of_type(a) - (a))
	45
1368f650 JN	46	#define unsigned_add_overflows(a, b) \
	47	((b) > maximum_unsigned_value_of_type(a) - (a))
	48
8723f216 NP	49	#ifdef __GNUC__
	50	#define TYPEOF(x) (__typeof__(x))
	51	#else
	52	#define TYPEOF(x)
	53	#endif
	54
f630cfda	55	#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
db7244bd	56	#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216	57
98cb6f30 PH	58	#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
98cb6f30 PH	59
cf606e3d AW	60	/* Approximation of the length of the decimal representation of this type. */
	61	#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
	62
4cb18a49 BC	63	#if defined(__sun__)
	64	/*
	65	* On Solaris, when _XOPEN_EXTENDED is set, its header file
	66	* forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
	67	* setting to say we are XPG5 or XPG6. Also on Solaris,
	68	* XPG6 programs must be compiled with a c99 compiler, while
	69	* non XPG6 programs must be compiled with a pre-c99 compiler.
	70	*/
	71	# if __STDC_VERSION__ - 0 >= 199901L
	72	# define _XOPEN_SOURCE 600
	73	# else
	74	# define _XOPEN_SOURCE 500
	75	# endif
6555b196	76	#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
761a889a	77	!defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
85023577 JH	78	#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
85023577 JH	79	#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6	80	#endif
fb952206 JR	81	#define _ALL_SOURCE 1
	82	#define _GNU_SOURCE 1
	83	#define _BSD_SOURCE 1
9a695fbf	84	#define _NETBSD_SOURCE 1
9398b859	85	#define _SGI_SOURCE 1
85023577	86
435bdf8c MSO	87	#ifdef WIN32 /* Both MinGW and MSVC */
	88	#define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
	89	#include <winsock2.h>
	90	#include <windows.h>
	91	#endif
	92
4050c0df JH	93	#include <unistd.h>
	94	#include <stdio.h>
	95	#include <sys/stat.h>
	96	#include <fcntl.h>
	97	#include <stddef.h>
	98	#include <stdlib.h>
	99	#include <stdarg.h>
	100	#include <string.h>
	101	#include <errno.h>
	102	#include <limits.h>
	103	#include <sys/param.h>
4050c0df JH	104	#include <sys/types.h>
4050c0df JH	105	#include <dirent.h>
85023577 JH	106	#include <sys/time.h>
	107	#include <time.h>
	108	#include <signal.h>
85023577	109	#include <fnmatch.h>
f4626df5 JS	110	#include <assert.h>
	111	#include <regex.h>
	112	#include <utime.h>
088d8802	113	#include <syslog.h>
2844923d	114	#ifndef NO_SYS_POLL_H
fdc12114	115	#include <sys/poll.h>
2844923d MD	116	#else
	117	#include <poll.h>
	118	#endif
cfc755d3 VR	119	#if defined(__MINGW32__)
	120	/* pull in Windows compatibility stuff */
	121	#include "compat/mingw.h"
	122	#elif defined(_MSC_VER)
	123	#include "compat/msvc.h"
	124	#else
f4626df5	125	#include <sys/wait.h>
ebae9ff9	126	#include <sys/resource.h>
85023577	127	#include <sys/socket.h>
80bbe72b	128	#include <sys/ioctl.h>
eb80042c	129	#include <termios.h>
2600973f	130	#ifndef NO_SYS_SELECT_H
80bbe72b	131	#include <sys/select.h>
2600973f	132	#endif
85023577 JH	133	#include <netinet/in.h>
	134	#include <netinet/tcp.h>
	135	#include <arpa/inet.h>
	136	#include <netdb.h>
	137	#include <pwd.h>
e2770979	138	#include <sys/un.h>
2844923d	139	#ifndef NO_INTTYPES_H
007e2ba6	140	#include <inttypes.h>
2844923d MD	141	#else
	142	#include <stdint.h>
	143	#endif
41b20017 RJ	144	#if defined(__CYGWIN__)
	145	#undef _XOPEN_SOURCE
	146	#include <grp.h>
	147	#define _XOPEN_SOURCE 600
adbc0b6b	148	#include "compat/cygwin.h"
41b20017	149	#else
fb952206	150	#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577	151	#include <grp.h>
fb952206	152	#define _ALL_SOURCE 1
41b20017	153	#endif
d75f8e61	154	#endif
85023577	155
76759c7d TB	156	/* used on Mac OS X */
	157	#ifdef PRECOMPOSE_UNICODE
	158	#include "compat/precompose_utf8.h"
	159	#else
	160	#define precompose_str(in,i_nfd2nfc)
	161	#define precompose_argv(c,v)
	162	#define probe_utf8_pathname_composition(a,b)
	163	#endif
	164
e1c06886 DA	165	#ifndef NO_LIBGEN_H
	166	#include <libgen.h>
	167	#else
	168	#define basename gitbasename
	169	extern char gitbasename(char );
	170	#endif
	171
85023577 JH	172	#ifndef NO_ICONV
	173	#include <iconv.h>
	174	#endif
4050c0df	175
684ec6c6 RS	176	#ifndef NO_OPENSSL
	177	#include <openssl/ssl.h>
	178	#include <openssl/err.h>
	179	#endif
	180
d0c2449f JH	181	/* On most systems <limits.h> would have given us this, but
	182	* not on some systems (e.g. GNU/Hurd).
	183	*/
	184	#ifndef PATH_MAX
	185	#define PATH_MAX 4096
	186	#endif
	187
c4001d92 SP	188	#ifndef PRIuMAX
	189	#define PRIuMAX "llu"
	190	#endif
	191
607bb3ff JS	192	#ifndef PRIu32
	193	#define PRIu32 "u"
	194	#endif
	195
	196	#ifndef PRIx32
	197	#define PRIx32 "x"
	198	#endif
	199
5418d96d RJ	200	#ifndef PRIo32
	201	#define PRIo32 "o"
	202	#endif
	203
80ba074f JS	204	#ifndef PATH_SEP
	205	#define PATH_SEP ':'
	206	#endif
	207
cb6a22c0 CW	208	#ifdef HAVE_PATHS_H
	209	#include <paths.h>
	210	#endif
	211	#ifndef _PATH_DEFPATH
	212	#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
	213	#endif
	214
23326d14 JS	215	#ifndef STRIP_EXTENSION
	216	#define STRIP_EXTENSION ""
	217	#endif
	218
25fe217b JS	219	#ifndef has_dos_drive_prefix
	220	#define has_dos_drive_prefix(path) 0
	221	#endif
	222
	223	#ifndef is_dir_sep
	224	#define is_dir_sep(c) ((c) == '/')
	225	#endif
	226
d1c69255 TN	227	#ifndef find_last_dir_sep
	228	#define find_last_dir_sep(path) strrchr(path, '/')
	229	#endif
	230
e4ac953b	231	#if defined(__HP_cc) && (__HP_cc >= 61000)
b6ab349b MR	232	#define NORETURN __attribute__((noreturn))
b6ab349b MR	233	#define NORETURN_PTR
6520c846	234	#elif defined(__GNUC__) && !defined(NO_NORETURN)
4050c0df	235	#define NORETURN __attribute__((__noreturn__))
18660bc9	236	#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8 RJ	237	#elif defined(_MSC_VER)
	238	#define NORETURN __declspec(noreturn)
	239	#define NORETURN_PTR
4050c0df JH	240	#else
4050c0df JH	241	#define NORETURN
18660bc9	242	#define NORETURN_PTR
4050c0df JH	243	#ifndef __attribute__
	244	#define __attribute__(x)
	245	#endif
	246	#endif
	247
51ea5519 NP	248	#include "compat/bswap.h"
51ea5519 NP	249
4050c0df	250	/* General helper functions */
ebaa79f4	251	extern void vreportf(const char prefix, const char err, va_list params);
3bc4181f	252	extern void vwritef(int fd, const char prefix, const char err, va_list params);
a4f3131c	253	extern NORETURN void usage(const char *err);
64b1cb74	254	extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
a4f3131c EFL	255	extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
a4f3131c EFL	256	extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df	257	extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9	258	extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df	259
18660bc9	260	extern void set_die_routine(NORETURN_PTR void (routine)(const char err, va_list params));
3bc4181f	261	extern void set_error_routine(void (routine)(const char err, va_list params));
39a3f5ea	262
698a68be	263	extern int prefixcmp(const char str, const char prefix);
8cc5b290	264	extern int suffixcmp(const char str, const char suffix);
698a68be	265
fbca5837 MV	266	static inline const char skip_prefix(const char str, const char *prefix)
	267	{
	268	size_t len = strlen(prefix);
	269	return strncmp(str, prefix, len) ? NULL : str + len;
	270	}
	271
b130a72b	272	#if defined(NO_MMAP) \|\| defined(USE_WIN32_MMAP)
4050c0df JH	273
	274	#ifndef PROT_READ
	275	#define PROT_READ 1
	276	#define PROT_WRITE 2
	277	#define MAP_PRIVATE 1
4050c0df JH	278	#endif
4050c0df JH	279
d6779124 SP	280	#define mmap git_mmap
	281	#define munmap git_munmap
	282	extern void git_mmap(void start, size_t length, int prot, int flags, int fd, off_t offset);
	283	extern int git_munmap(void *start, size_t length);
4050c0df	284
b130a72b JL	285	#else /* NO_MMAP \|\| USE_WIN32_MMAP */
	286
	287	#include <sys/mman.h>
	288
	289	#endif /* NO_MMAP \|\| USE_WIN32_MMAP */
	290
	291	#ifdef NO_MMAP
	292
5faaf246	293	/* This value must be multiple of (pagesize * 2) */
8c82534d SP	294	#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
8c82534d SP	295
4050c0df JH	296	#else /* NO_MMAP */
4050c0df JH	297
5faaf246	298	/* This value must be multiple of (pagesize * 2) */
22bac0ea SP	299	#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
	300	(sizeof(void*) >= 8 \
	301	? 1 * 1024 * 1024 * 1024 \
	302	: 32 * 1024 * 1024)
4050c0df JH	303
	304	#endif /* NO_MMAP */
	305
fcf3a21a GV	306	#ifndef MAP_FAILED
	307	#define MAP_FAILED ((void *)-1)
	308	#endif
	309
fdb2a2a6 JH	310	#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
	311	#define on_disk_bytes(st) ((st).st_size)
	312	#else
	313	#define on_disk_bytes(st) ((st).st_blocks * 512)
	314	#endif
	315
22bac0ea	316	#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a	317	((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d	318
6900679c SH	319	#ifdef NO_PREAD
	320	#define pread git_pread
	321	extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
	322	#endif
14086b0a SP	323	/*
	324	* Forward decl that will remind us if its twin in cache.h changes.
	325	* This function is used in compat/pread.c. But we can't include
	326	* cache.h there.
	327	*/
	328	extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c	329
4050c0df JH	330	#ifdef NO_SETENV
	331	#define setenv gitsetenv
	332	extern int gitsetenv(const char , const char , int);
	333	#endif
	334
ca5bb5d5 SP	335	#ifdef NO_MKDTEMP
	336	#define mkdtemp gitmkdtemp
	337	extern char gitmkdtemp(char );
	338	#endif
	339
0620b39b DA	340	#ifdef NO_MKSTEMPS
	341	#define mkstemps gitmkstemps
	342	extern int gitmkstemps(char *, int);
	343	#endif
	344
731043fd JR	345	#ifdef NO_UNSETENV
	346	#define unsetenv gitunsetenv
	347	extern void gitunsetenv(const char *);
	348	#endif
	349
4050c0df JH	350	#ifdef NO_STRCASESTR
	351	#define strcasestr gitstrcasestr
	352	extern char gitstrcasestr(const char haystack, const char *needle);
	353	#endif
	354
817151e6 PE	355	#ifdef NO_STRLCPY
	356	#define strlcpy gitstrlcpy
	357	extern size_t gitstrlcpy(char , const char , size_t);
	358	#endif
	359
bc6b4f52 JR	360	#ifdef NO_STRTOUMAX
	361	#define strtoumax gitstrtoumax
	362	extern uintmax_t gitstrtoumax(const char , char *, int);
97000ba6 JS	363	#define strtoimax gitstrtoimax
97000ba6 JS	364	extern intmax_t gitstrtoimax(const char , char *, int);
bc6b4f52 JR	365	#endif
bc6b4f52 JR	366
78457bc0 JN	367	#ifdef NO_STRTOK_R
	368	#define strtok_r gitstrtok_r
	369	extern char gitstrtok_r(char s, const char delim, char *save_ptr);
	370	#endif
	371
fa0c87c3 AR	372	#ifdef NO_HSTRERROR
	373	#define hstrerror githstrerror
	374	extern const char *githstrerror(int herror);
	375	#endif
	376
b21b9f1d RS	377	#ifdef NO_MEMMEM
	378	#define memmem gitmemmem
	379	void gitmemmem(const void haystack, size_t haystacklen,
	380	const void *needle, size_t needlelen);
	381	#endif
	382
cba22528	383	#ifdef FREAD_READS_DIRECTORIES
c5445fe0 JS	384	#ifdef fopen
	385	#undef fopen
	386	#endif
cba22528 BC	387	#define fopen(a,b) git_fopen(a,b)
	388	extern FILE git_fopen(const char, const char*);
	389	#endif
	390
c4582f93 MR	391	#ifdef SNPRINTF_RETURNS_BOGUS
	392	#define snprintf git_snprintf
	393	extern int git_snprintf(char *str, size_t maxsize,
	394	const char *format, ...);
	395	#define vsnprintf git_vsnprintf
	396	extern int git_vsnprintf(char *str, size_t maxsize,
	397	const char *format, va_list ap);
	398	#endif
	399
726c8ef5 JS	400	#ifdef __GLIBC_PREREQ
	401	#if __GLIBC_PREREQ(2, 1)
	402	#define HAVE_STRCHRNUL
137c6eaa	403	#define HAVE_MEMPCPY
726c8ef5 JS	404	#endif
	405	#endif
	406
	407	#ifndef HAVE_STRCHRNUL
659c69cf	408	#define strchrnul gitstrchrnul
9e79f00f AE	409	static inline char gitstrchrnul(const char s, int c)
	410	{
	411	while (s && s != c)
	412	s++;
	413	return (char *)s;
	414	}
659c69cf RS	415	#endif
659c69cf RS	416
137c6eaa JN	417	#ifndef HAVE_MEMPCPY
	418	#define mempcpy gitmempcpy
	419	static inline void gitmempcpy(void dest, const void *src, size_t n)
	420	{
	421	return (char *)memcpy(dest, src, n) + n;
	422	}
	423	#endif
	424
da523cc5 MP	425	#ifdef NO_INET_PTON
	426	int inet_pton(int af, const char src, void dst);
	427	#endif
	428
	429	#ifdef NO_INET_NTOP
	430	const char inet_ntop(int af, const void src, char *dst, size_t size);
	431	#endif
	432
d1efefa4	433	extern void release_pack_memory(size_t, int);
97bfeb34	434
851c34b0 JS	435	typedef void (*try_to_free_t)(size_t);
851c34b0 JS	436	extern try_to_free_t set_try_to_free_routine(try_to_free_t);
a9a74636	437
112db553 LT	438	extern char xstrdup(const char str);
112db553 LT	439	extern void *xmalloc(size_t size);
5bf9219d	440	extern void *xmallocz(size_t size);
112db553 LT	441	extern void xmemdupz(const void data, size_t len);
	442	extern char xstrndup(const char str, size_t len);
	443	extern void xrealloc(void ptr, size_t size);
	444	extern void *xcalloc(size_t nmemb, size_t size);
	445	extern void xmmap(void start, size_t length, int prot, int flags, int fd, off_t offset);
	446	extern ssize_t xread(int fd, void *buf, size_t len);
	447	extern ssize_t xwrite(int fd, const void *buf, size_t len);
	448	extern int xdup(int fd);
	449	extern FILE xfdopen(int fd, const char mode);
	450	extern int xmkstemp(char *template);
463db9b1	451	extern int xmkstemp_mode(char *template, int mode);
6e180cdc JH	452	extern int odb_mkstemp(char template, size_t limit, const char pattern);
6e180cdc JH	453	extern int odb_pack_keep(char name, size_t namesz, unsigned char sha1);
f21a47b2	454
dc49cd76 SP	455	static inline size_t xsize_t(off_t len)
dc49cd76 SP	456	{
46be82df TR	457	if (len > (size_t) len)
46be82df TR	458	die("Cannot handle files this big");
dc49cd76 SP	459	return (size_t)len;
	460	}
	461
5bb1cda5	462	static inline int has_extension(const char filename, const char ext)
83a2b841	463	{
5bb1cda5 RS	464	size_t len = strlen(filename);
5bb1cda5 RS	465	size_t extlen = strlen(ext);
83a2b841 RS	466	return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
	467	}
	468
f1589d10 RJ	469	/* in ctype.c, for kwset users */
	470	extern const char tolower_trans_tbl[256];
	471
4050c0df	472	/* Sane ctype - no locale, and works with signed chars */
c2e9364a	473	#undef isascii
4050c0df JH	474	#undef isspace
	475	#undef isdigit
	476	#undef isalpha
	477	#undef isalnum
43ccdf56 NK	478	#undef islower
43ccdf56 NK	479	#undef isupper
4050c0df JH	480	#undef tolower
	481	#undef toupper
	482	extern unsigned char sane_ctype[256];
	483	#define GIT_SPACE 0x01
	484	#define GIT_DIGIT 0x02
	485	#define GIT_ALPHA 0x04
8cc32992	486	#define GIT_GLOB_SPECIAL 0x08
f9b7cce6	487	#define GIT_REGEX_SPECIAL 0x10
2f6c9760	488	#define GIT_PATHSPEC_MAGIC 0x20
4050c0df	489	#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a	490	#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df JH	491	#define isspace(x) sane_istest(x,GIT_SPACE)
	492	#define isdigit(x) sane_istest(x,GIT_DIGIT)
	493	#define isalpha(x) sane_istest(x,GIT_ALPHA)
	494	#define isalnum(x) sane_istest(x,GIT_ALPHA \| GIT_DIGIT)
43ccdf56 NK	495	#define islower(x) sane_iscase(x, 1)
43ccdf56 NK	496	#define isupper(x) sane_iscase(x, 0)
8cc32992	497	#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6	498	#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL \| GIT_REGEX_SPECIAL)
4050c0df JH	499	#define tolower(x) sane_case((unsigned char)(x), 0x20)
4050c0df JH	500	#define toupper(x) sane_case((unsigned char)(x), 0)
2f6c9760	501	#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
4050c0df JH	502
	503	static inline int sane_case(int x, int high)
	504	{
	505	if (sane_istest(x, GIT_ALPHA))
	506	x = (x & ~0x20) \| high;
	507	return x;
	508	}
	509
43ccdf56 NK	510	static inline int sane_iscase(int x, int is_lower)
	511	{
	512	if (!sane_istest(x, GIT_ALPHA))
	513	return 0;
	514
	515	if (is_lower)
	516	return (x & 0x20) != 0;
	517	else
	518	return (x & 0x20) == 0;
	519	}
	520
6aead43d JM	521	static inline int strtoul_ui(char const s, int base, unsigned int result)
	522	{
	523	unsigned long ul;
	524	char *p;
	525
	526	errno = 0;
	527	ul = strtoul(s, &p, base);
	528	if (errno \|\| *p \|\| p == s \|\| (unsigned int) ul != ul)
	529	return -1;
	530	*result = ul;
	531	return 0;
	532	}
	533
7791ecbc JH	534	static inline int strtol_i(char const s, int base, int result)
	535	{
	536	long ul;
	537	char *p;
	538
	539	errno = 0;
	540	ul = strtol(s, &p, base);
	541	if (errno \|\| *p \|\| p == s \|\| (int) ul != ul)
	542	return -1;
	543	*result = ul;
	544	return 0;
	545	}
	546
43fe901b BD	547	#ifdef INTERNAL_QSORT
	548	void git_qsort(void *base, size_t nmemb, size_t size,
	549	int(compar)(const void , const void *));
	550	#define qsort git_qsort
	551	#endif
	552
81a24b52 AR	553	#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
	554	# define FORCE_DIR_SET_GID S_ISGID
	555	#else
	556	# define FORCE_DIR_SET_GID 0
	557	#endif
	558
c06ff490 KB	559	#ifdef NO_NSEC
	560	#undef USE_NSEC
	561	#define ST_CTIME_NSEC(st) 0
	562	#define ST_MTIME_NSEC(st) 0
	563	#else
c567383b BG	564	#ifdef USE_ST_TIMESPEC
	565	#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
	566	#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
	567	#else
c06ff490 KB	568	#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
	569	#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
	570	#endif
c567383b	571	#endif
c06ff490	572
34779c53 JS	573	#ifdef UNRELIABLE_FSTAT
	574	#define fstat_is_reliable() 0
	575	#else
	576	#define fstat_is_reliable() 1
	577	#endif
	578
ab8632ae	579	#ifndef va_copy
26db0f2e JN	580	/*
	581	* Since an obvious implementation of va_list would be to make it a
	582	* pointer into the stack frame, a simple assignment will work on
	583	* many systems. But let's try to be more portable.
	584	*/
	585	#ifdef __va_copy
	586	#define va_copy(dst, src) __va_copy(dst, src)
	587	#else
	588	#define va_copy(dst, src) ((dst) = (src))
	589	#endif
ab8632ae JK	590	#endif
ab8632ae JK	591
fc71db39 AR	592	/*
	593	* Preserves errno, prints a message, but gives no warning for ENOENT.
	594	* Always returns the return value of unlink(2).
	595	*/
	596	int unlink_or_warn(const char *path);
d1723296 PC	597	/*
	598	* Likewise for rmdir(2).
	599	*/
	600	int rmdir_or_warn(const char *path);
80d706af PC	601	/*
	602	* Calls the correct function out of {unlink,rmdir}_or_warn based on
	603	* the supplied file mode.
	604	*/
	605	int remove_or_warn(unsigned int mode, const char *path);
fc71db39	606
ba8bd830 JK	607	/* Call access(2), but warn for any error besides ENOENT. */
	608	int access_or_warn(const char *path, int mode);
	609
55b38a48 JH	610	/* Warn on an inaccessible file that ought to be accessible */
	611	void warn_on_inaccessible(const char *path);
	612
2f705875 JK	613	/* Get the passwd entry for the UID of the current process. */
	614	struct passwd *xgetpwuid_self(void);
	615
4050c0df	616	#endif