1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
8 * See if our compiler is known to support flexible array members.
10 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
11 # define FLEX_ARRAY /* empty */
12 #elif defined(__GNUC__)
14 # define FLEX_ARRAY /* empty */
16 # define FLEX_ARRAY 0 /* older GNU extension */
21 * Otherwise, default to safer but a bit wasteful traditional style
28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
31 #define maximum_signed_value_of_type(a) \
32 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
34 #define maximum_unsigned_value_of_type(a) \
35 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
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.
41 * Requires: a >= 0, typeof(a) equals typeof(b)
43 #define signed_add_overflows(a, b) \
44 ((b) > maximum_signed_value_of_type(a) - (a))
46 #define unsigned_add_overflows(a, b) \
47 ((b) > maximum_unsigned_value_of_type(a) - (a))
50 #define TYPEOF(x) (__typeof__(x))
55 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
56 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
58 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
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)
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.
71 # if __STDC_VERSION__ - 0 >= 199901L
72 # define _XOPEN_SOURCE 600
74 # define _XOPEN_SOURCE 500
76 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
77 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
78 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
80 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
81 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
86 #define _NETBSD_SOURCE 1
89 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
90 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
91 # define _WIN32_WINNT 0x0502
93 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
96 #define GIT_WINDOWS_NATIVE
101 #include <sys/stat.h>
107 #ifdef HAVE_STRINGS_H
108 #include <strings.h> /* for strcasecmp() */
112 #ifdef NEEDS_SYS_PARAM_H
113 #include <sys/param.h>
115 #include <sys/types.h>
117 #include <sys/time.h>
124 #ifndef NO_SYS_POLL_H
125 #include <sys/poll.h>
130 #if defined(__MINGW32__)
131 /* pull in Windows compatibility stuff */
132 #include "compat/mingw.h"
133 #elif defined(_MSC_VER)
134 #include "compat/msvc.h"
136 #include <sys/wait.h>
137 #include <sys/resource.h>
138 #include <sys/socket.h>
139 #include <sys/ioctl.h>
141 #ifndef NO_SYS_SELECT_H
142 #include <sys/select.h>
144 #include <netinet/in.h>
145 #include <netinet/tcp.h>
146 #include <arpa/inet.h>
150 #ifndef NO_INTTYPES_H
151 #include <inttypes.h>
157 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
158 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
159 * while on IP16 and IP16L32 it is "int" (resp. "short")
160 * Size needs to match (or exceed) 'sizeof(void *)'.
161 * We can't take "long long" here as not everybody has it.
163 typedef long intptr_t;
164 typedef unsigned long uintptr_t;
166 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
168 #define _ALL_SOURCE 1
171 /* used on Mac OS X */
172 #ifdef PRECOMPOSE_UNICODE
173 #include "compat/precompose_utf8.h"
175 #define precompose_str(in,i_nfd2nfc)
176 #define precompose_argv(c,v)
177 #define probe_utf8_pathname_composition(a,b)
180 #ifdef MKDIR_WO_TRAILING_SLASH
181 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
182 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
185 #ifdef NO_STRUCT_ITIMERVAL
187 struct timeval it_interval;
188 struct timeval it_value;
193 #define setitimer(which,value,ovalue)
199 #define basename gitbasename
200 extern char *gitbasename(char *);
208 #include <openssl/ssl.h>
209 #include <openssl/err.h>
212 /* On most systems <netdb.h> would have given us this, but
213 * not on some systems (e.g. z/OS).
216 #define NI_MAXHOST 1025
220 #define NI_MAXSERV 32
223 /* On most systems <limits.h> would have given us this, but
224 * not on some systems (e.g. GNU/Hurd).
227 #define PATH_MAX 4096
231 #define PRIuMAX "llu"
253 #ifndef _PATH_DEFPATH
254 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
257 #ifndef STRIP_EXTENSION
258 #define STRIP_EXTENSION ""
261 #ifndef has_dos_drive_prefix
262 #define has_dos_drive_prefix(path) 0
265 #ifndef offset_1st_component
266 #define offset_1st_component(path) (is_dir_sep((path)[0]))
270 #define is_dir_sep(c) ((c) == '/')
273 #ifndef find_last_dir_sep
274 #define find_last_dir_sep(path) strrchr(path, '/')
277 #if defined(__HP_cc) && (__HP_cc >= 61000)
278 #define NORETURN __attribute__((noreturn))
280 #elif defined(__GNUC__) && !defined(NO_NORETURN)
281 #define NORETURN __attribute__((__noreturn__))
282 #define NORETURN_PTR __attribute__((__noreturn__))
283 #elif defined(_MSC_VER)
284 #define NORETURN __declspec(noreturn)
290 #ifndef __attribute__
291 #define __attribute__(x)
296 /* The sentinel attribute is valid from gcc version 4.0 */
297 #if defined(__GNUC__) && (__GNUC__ >= 4)
298 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
300 #define LAST_ARG_MUST_BE_NULL
303 #include "compat/bswap.h"
305 #include "wildmatch.h"
307 /* General helper functions */
308 extern void vreportf(const char *prefix, const char *err, va_list params);
309 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
310 extern NORETURN void usage(const char *err);
311 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
312 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
313 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
314 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
315 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
318 #ifdef APPLE_COMMON_CRYPTO
319 #include "compat/apple-common-crypto.h"
321 #include <openssl/evp.h>
322 #include <openssl/hmac.h>
323 #endif /* APPLE_COMMON_CRYPTO */
324 #include <openssl/x509v3.h>
325 #endif /* NO_OPENSSL */
328 * Let callers be aware of the constant return value; this can help
329 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
330 * because some compilers may not support variadic macros. Since we're only
331 * trying to help gcc, anyway, it's OK; other compilers will fall back to
332 * using the function as usual.
334 #if defined(__GNUC__)
335 static inline int const_error(void)
339 #define error(...) (error(__VA_ARGS__), const_error())
342 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
343 extern void set_error_routine(void (*routine)(const char *err, va_list params));
344 extern void set_die_is_recursing_routine(int (*routine)(void));
346 extern int starts_with(const char *str, const char *prefix);
349 * If the string "str" begins with the string found in "prefix", return 1.
350 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
351 * the string right after the prefix).
353 * Otherwise, return 0 and leave "out" untouched.
357 * [extract branch name, fail if not a branch]
358 * if (!skip_prefix(ref, "refs/heads/", &branch)
361 * [skip prefix if present, otherwise use whole string]
362 * skip_prefix(name, "refs/heads/", &name);
364 static inline int skip_prefix(const char *str, const char *prefix,
372 } while (*str++ == *prefix++);
377 * If buf ends with suffix, return 1 and subtract the length of the suffix
378 * from *len. Otherwise, return 0 and leave *len untouched.
380 static inline int strip_suffix_mem(const char *buf, size_t *len,
383 size_t suflen = strlen(suffix);
384 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
391 * If str ends with suffix, return 1 and set *len to the size of the string
392 * without the suffix. Otherwise, return 0 and set *len to the size of the
395 * Note that we do _not_ NUL-terminate str to the new length.
397 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
400 return strip_suffix_mem(str, len, suffix);
403 static inline int ends_with(const char *str, const char *suffix)
406 return strip_suffix(str, suffix, &len);
409 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
414 #define MAP_PRIVATE 1
417 #define mmap git_mmap
418 #define munmap git_munmap
419 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
420 extern int git_munmap(void *start, size_t length);
422 #else /* NO_MMAP || USE_WIN32_MMAP */
424 #include <sys/mman.h>
426 #endif /* NO_MMAP || USE_WIN32_MMAP */
430 /* This value must be multiple of (pagesize * 2) */
431 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
435 /* This value must be multiple of (pagesize * 2) */
436 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
437 (sizeof(void*) >= 8 \
438 ? 1 * 1024 * 1024 * 1024 \
444 #define MAP_FAILED ((void *)-1)
447 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
448 #define on_disk_bytes(st) ((st).st_size)
450 #define on_disk_bytes(st) ((st).st_blocks * 512)
453 #define DEFAULT_PACKED_GIT_LIMIT \
454 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
457 #define pread git_pread
458 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
461 * Forward decl that will remind us if its twin in cache.h changes.
462 * This function is used in compat/pread.c. But we can't include
465 extern ssize_t read_in_full(int fd, void *buf, size_t count);
468 #define setenv gitsetenv
469 extern int gitsetenv(const char *, const char *, int);
473 #define mkdtemp gitmkdtemp
474 extern char *gitmkdtemp(char *);
478 #define mkstemps gitmkstemps
479 extern int gitmkstemps(char *, int);
483 #define unsetenv gitunsetenv
484 extern void gitunsetenv(const char *);
488 #define strcasestr gitstrcasestr
489 extern char *gitstrcasestr(const char *haystack, const char *needle);
493 #define strlcpy gitstrlcpy
494 extern size_t gitstrlcpy(char *, const char *, size_t);
498 #define strtoumax gitstrtoumax
499 extern uintmax_t gitstrtoumax(const char *, char **, int);
500 #define strtoimax gitstrtoimax
501 extern intmax_t gitstrtoimax(const char *, char **, int);
505 #define hstrerror githstrerror
506 extern const char *githstrerror(int herror);
510 #define memmem gitmemmem
511 void *gitmemmem(const void *haystack, size_t haystacklen,
512 const void *needle, size_t needlelen);
515 #ifdef NO_GETPAGESIZE
516 #define getpagesize() sysconf(_SC_PAGESIZE)
519 #ifdef FREAD_READS_DIRECTORIES
523 #define fopen(a,b) git_fopen(a,b)
524 extern FILE *git_fopen(const char*, const char*);
527 #ifdef SNPRINTF_RETURNS_BOGUS
531 #define snprintf git_snprintf
532 extern int git_snprintf(char *str, size_t maxsize,
533 const char *format, ...);
537 #define vsnprintf git_vsnprintf
538 extern int git_vsnprintf(char *str, size_t maxsize,
539 const char *format, va_list ap);
542 #ifdef __GLIBC_PREREQ
543 #if __GLIBC_PREREQ(2, 1)
544 #define HAVE_STRCHRNUL
549 #ifndef HAVE_STRCHRNUL
550 #define strchrnul gitstrchrnul
551 static inline char *gitstrchrnul(const char *s, int c)
553 while (*s && *s != c)
560 #define mempcpy gitmempcpy
561 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
563 return (char *)memcpy(dest, src, n) + n;
568 int inet_pton(int af, const char *src, void *dst);
572 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
575 extern void release_pack_memory(size_t);
577 typedef void (*try_to_free_t)(size_t);
578 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
582 # define xalloca(size) (alloca(size))
583 # define xalloca_free(p) do {} while (0)
585 # define xalloca(size) (xmalloc(size))
586 # define xalloca_free(p) (free(p))
588 extern char *xstrdup(const char *str);
589 extern void *xmalloc(size_t size);
590 extern void *xmallocz(size_t size);
591 extern void *xmemdupz(const void *data, size_t len);
592 extern char *xstrndup(const char *str, size_t len);
593 extern void *xrealloc(void *ptr, size_t size);
594 extern void *xcalloc(size_t nmemb, size_t size);
595 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
596 extern ssize_t xread(int fd, void *buf, size_t len);
597 extern ssize_t xwrite(int fd, const void *buf, size_t len);
598 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
599 extern int xdup(int fd);
600 extern FILE *xfdopen(int fd, const char *mode);
601 extern int xmkstemp(char *template);
602 extern int xmkstemp_mode(char *template, int mode);
603 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
604 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
606 static inline size_t xsize_t(off_t len)
608 if (len > (size_t) len)
609 die("Cannot handle files this big");
613 /* in ctype.c, for kwset users */
614 extern const char tolower_trans_tbl[256];
616 /* Sane ctype - no locale, and works with signed chars */
631 extern const unsigned char sane_ctype[256];
632 #define GIT_SPACE 0x01
633 #define GIT_DIGIT 0x02
634 #define GIT_ALPHA 0x04
635 #define GIT_GLOB_SPECIAL 0x08
636 #define GIT_REGEX_SPECIAL 0x10
637 #define GIT_PATHSPEC_MAGIC 0x20
638 #define GIT_CNTRL 0x40
639 #define GIT_PUNCT 0x80
640 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
641 #define isascii(x) (((x) & ~0x7f) == 0)
642 #define isspace(x) sane_istest(x,GIT_SPACE)
643 #define isdigit(x) sane_istest(x,GIT_DIGIT)
644 #define isalpha(x) sane_istest(x,GIT_ALPHA)
645 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
646 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
647 #define islower(x) sane_iscase(x, 1)
648 #define isupper(x) sane_iscase(x, 0)
649 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
650 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
651 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
652 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
653 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
654 #define isxdigit(x) (hexval_table[x] != -1)
655 #define tolower(x) sane_case((unsigned char)(x), 0x20)
656 #define toupper(x) sane_case((unsigned char)(x), 0)
657 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
659 static inline int sane_case(int x, int high)
661 if (sane_istest(x, GIT_ALPHA))
662 x = (x & ~0x20) | high;
666 static inline int sane_iscase(int x, int is_lower)
668 if (!sane_istest(x, GIT_ALPHA))
672 return (x & 0x20) != 0;
674 return (x & 0x20) == 0;
677 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
683 ul = strtoul(s, &p, base);
684 if (errno || *p || p == s || (unsigned int) ul != ul)
690 static inline int strtol_i(char const *s, int base, int *result)
696 ul = strtol(s, &p, base);
697 if (errno || *p || p == s || (int) ul != ul)
703 #ifdef INTERNAL_QSORT
704 void git_qsort(void *base, size_t nmemb, size_t size,
705 int(*compar)(const void *, const void *));
706 #define qsort git_qsort
709 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
710 # define FORCE_DIR_SET_GID S_ISGID
712 # define FORCE_DIR_SET_GID 0
717 #define ST_CTIME_NSEC(st) 0
718 #define ST_MTIME_NSEC(st) 0
720 #ifdef USE_ST_TIMESPEC
721 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
722 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
724 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
725 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
729 #ifdef UNRELIABLE_FSTAT
730 #define fstat_is_reliable() 0
732 #define fstat_is_reliable() 1
737 * Since an obvious implementation of va_list would be to make it a
738 * pointer into the stack frame, a simple assignment will work on
739 * many systems. But let's try to be more portable.
742 #define va_copy(dst, src) __va_copy(dst, src)
744 #define va_copy(dst, src) ((dst) = (src))
748 #if defined(__GNUC__) || (_MSC_VER >= 1400)
749 #define HAVE_VARIADIC_MACROS 1
753 * Preserves errno, prints a message, but gives no warning for ENOENT.
754 * Always returns the return value of unlink(2).
756 int unlink_or_warn(const char *path);
758 * Likewise for rmdir(2).
760 int rmdir_or_warn(const char *path);
762 * Calls the correct function out of {unlink,rmdir}_or_warn based on
763 * the supplied file mode.
765 int remove_or_warn(unsigned int mode, const char *path);
768 * Call access(2), but warn for any error except "missing file"
769 * (ENOENT or ENOTDIR).
771 #define ACCESS_EACCES_OK (1U << 0)
772 int access_or_warn(const char *path, int mode, unsigned flag);
773 int access_or_die(const char *path, int mode, unsigned flag);
775 /* Warn on an inaccessible file that ought to be accessible */
776 void warn_on_inaccessible(const char *path);
778 /* Get the passwd entry for the UID of the current process. */
779 struct passwd *xgetpwuid_self(void);
781 #ifdef GMTIME_UNRELIABLE_ERRORS
782 struct tm *git_gmtime(const time_t *);
783 struct tm *git_gmtime_r(const time_t *, struct tm *);
784 #define gmtime git_gmtime
785 #define gmtime_r git_gmtime_r