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 _DEFAULT_SOURCE 1
87 #define _NETBSD_SOURCE 1
90 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
91 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
92 # define _WIN32_WINNT 0x0502
94 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
97 #define GIT_WINDOWS_NATIVE
102 #include <sys/stat.h>
108 #ifdef HAVE_STRINGS_H
109 #include <strings.h> /* for strcasecmp() */
113 #ifdef NEEDS_SYS_PARAM_H
114 #include <sys/param.h>
116 #include <sys/types.h>
118 #include <sys/time.h>
125 #ifndef NO_SYS_POLL_H
126 #include <sys/poll.h>
131 #if defined(__MINGW32__)
132 /* pull in Windows compatibility stuff */
133 #include "compat/mingw.h"
134 #elif defined(_MSC_VER)
135 #include "compat/msvc.h"
137 #include <sys/wait.h>
138 #include <sys/resource.h>
139 #include <sys/socket.h>
140 #include <sys/ioctl.h>
142 #ifndef NO_SYS_SELECT_H
143 #include <sys/select.h>
145 #include <netinet/in.h>
146 #include <netinet/tcp.h>
147 #include <arpa/inet.h>
151 #ifndef NO_INTTYPES_H
152 #include <inttypes.h>
158 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
159 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
160 * while on IP16 and IP16L32 it is "int" (resp. "short")
161 * Size needs to match (or exceed) 'sizeof(void *)'.
162 * We can't take "long long" here as not everybody has it.
164 typedef long intptr_t;
165 typedef unsigned long uintptr_t;
167 #if defined(__CYGWIN__)
170 #define _XOPEN_SOURCE 600
172 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
174 #define _ALL_SOURCE 1
178 /* used on Mac OS X */
179 #ifdef PRECOMPOSE_UNICODE
180 #include "compat/precompose_utf8.h"
182 #define precompose_str(in,i_nfd2nfc)
183 #define precompose_argv(c,v)
184 #define probe_utf8_pathname_composition(a,b)
187 #ifdef MKDIR_WO_TRAILING_SLASH
188 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
189 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
192 #ifdef NO_STRUCT_ITIMERVAL
194 struct timeval it_interval;
195 struct timeval it_value;
200 #define setitimer(which,value,ovalue)
206 #define basename gitbasename
207 extern char *gitbasename(char *);
215 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
216 #define MAC_OS_X_VERSION_MIN_REQUIRED MAC_OS_X_VERSION_10_6
217 #include <openssl/ssl.h>
218 #include <openssl/err.h>
219 #undef MAC_OS_X_VERSION_MIN_REQUIRED
220 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
221 #ifdef NO_HMAC_CTX_CLEANUP
222 #define HMAC_CTX_cleanup HMAC_cleanup
226 /* On most systems <netdb.h> would have given us this, but
227 * not on some systems (e.g. z/OS).
230 #define NI_MAXHOST 1025
234 #define NI_MAXSERV 32
237 /* On most systems <limits.h> would have given us this, but
238 * not on some systems (e.g. GNU/Hurd).
241 #define PATH_MAX 4096
245 #define PRIuMAX "llu"
267 #ifndef _PATH_DEFPATH
268 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
271 #ifndef STRIP_EXTENSION
272 #define STRIP_EXTENSION ""
275 #ifndef has_dos_drive_prefix
276 static inline int git_has_dos_drive_prefix(const char *path)
280 #define has_dos_drive_prefix git_has_dos_drive_prefix
284 static inline int git_is_dir_sep(int c)
288 #define is_dir_sep git_is_dir_sep
291 #ifndef offset_1st_component
292 static inline int git_offset_1st_component(const char *path)
294 return is_dir_sep(path[0]);
296 #define offset_1st_component git_offset_1st_component
299 #ifndef find_last_dir_sep
300 static inline char *git_find_last_dir_sep(const char *path)
302 return strrchr(path, '/');
304 #define find_last_dir_sep git_find_last_dir_sep
307 #if defined(__HP_cc) && (__HP_cc >= 61000)
308 #define NORETURN __attribute__((noreturn))
310 #elif defined(__GNUC__) && !defined(NO_NORETURN)
311 #define NORETURN __attribute__((__noreturn__))
312 #define NORETURN_PTR __attribute__((__noreturn__))
313 #elif defined(_MSC_VER)
314 #define NORETURN __declspec(noreturn)
320 #ifndef __attribute__
321 #define __attribute__(x)
326 /* The sentinel attribute is valid from gcc version 4.0 */
327 #if defined(__GNUC__) && (__GNUC__ >= 4)
328 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
330 #define LAST_ARG_MUST_BE_NULL
333 #include "compat/bswap.h"
335 #include "wildmatch.h"
339 /* General helper functions */
340 extern void vreportf(const char *prefix, const char *err, va_list params);
341 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
342 extern NORETURN void usage(const char *err);
343 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
344 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
345 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
346 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
347 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
350 #ifdef APPLE_COMMON_CRYPTO
351 #include "compat/apple-common-crypto.h"
353 #include <openssl/evp.h>
354 #include <openssl/hmac.h>
355 #endif /* APPLE_COMMON_CRYPTO */
356 #include <openssl/x509v3.h>
357 #endif /* NO_OPENSSL */
359 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
360 extern void set_error_routine(void (*routine)(const char *err, va_list params));
361 extern void set_die_is_recursing_routine(int (*routine)(void));
363 extern int starts_with(const char *str, const char *prefix);
366 * If the string "str" begins with the string found in "prefix", return 1.
367 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
368 * the string right after the prefix).
370 * Otherwise, return 0 and leave "out" untouched.
374 * [extract branch name, fail if not a branch]
375 * if (!skip_prefix(ref, "refs/heads/", &branch)
378 * [skip prefix if present, otherwise use whole string]
379 * skip_prefix(name, "refs/heads/", &name);
381 static inline int skip_prefix(const char *str, const char *prefix,
389 } while (*str++ == *prefix++);
394 * If buf ends with suffix, return 1 and subtract the length of the suffix
395 * from *len. Otherwise, return 0 and leave *len untouched.
397 static inline int strip_suffix_mem(const char *buf, size_t *len,
400 size_t suflen = strlen(suffix);
401 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
408 * If str ends with suffix, return 1 and set *len to the size of the string
409 * without the suffix. Otherwise, return 0 and set *len to the size of the
412 * Note that we do _not_ NUL-terminate str to the new length.
414 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
417 return strip_suffix_mem(str, len, suffix);
420 static inline int ends_with(const char *str, const char *suffix)
423 return strip_suffix(str, suffix, &len);
426 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
431 #define MAP_PRIVATE 1
434 #define mmap git_mmap
435 #define munmap git_munmap
436 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
437 extern int git_munmap(void *start, size_t length);
439 #else /* NO_MMAP || USE_WIN32_MMAP */
441 #include <sys/mman.h>
443 #endif /* NO_MMAP || USE_WIN32_MMAP */
447 /* This value must be multiple of (pagesize * 2) */
448 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
452 /* This value must be multiple of (pagesize * 2) */
453 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
454 (sizeof(void*) >= 8 \
455 ? 1 * 1024 * 1024 * 1024 \
461 #define MAP_FAILED ((void *)-1)
464 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
465 #define on_disk_bytes(st) ((st).st_size)
467 #define on_disk_bytes(st) ((st).st_blocks * 512)
470 #ifdef NEEDS_MODE_TRANSLATION
479 #define S_IFMT 0170000
480 #define S_IFREG 0100000
481 #define S_IFDIR 0040000
482 #define S_IFLNK 0120000
483 #define S_IFBLK 0060000
484 #define S_IFCHR 0020000
485 #define S_IFIFO 0010000
486 #define S_IFSOCK 0140000
490 #define stat(path, buf) git_stat(path, buf)
491 extern int git_stat(const char *, struct stat *);
495 #define fstat(fd, buf) git_fstat(fd, buf)
496 extern int git_fstat(int, struct stat *);
500 #define lstat(path, buf) git_lstat(path, buf)
501 extern int git_lstat(const char *, struct stat *);
504 #define DEFAULT_PACKED_GIT_LIMIT \
505 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
508 #define pread git_pread
509 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
512 * Forward decl that will remind us if its twin in cache.h changes.
513 * This function is used in compat/pread.c. But we can't include
516 extern ssize_t read_in_full(int fd, void *buf, size_t count);
519 #define setenv gitsetenv
520 extern int gitsetenv(const char *, const char *, int);
524 #define mkdtemp gitmkdtemp
525 extern char *gitmkdtemp(char *);
529 #define mkstemps gitmkstemps
530 extern int gitmkstemps(char *, int);
534 #define unsetenv gitunsetenv
535 extern void gitunsetenv(const char *);
539 #define strcasestr gitstrcasestr
540 extern char *gitstrcasestr(const char *haystack, const char *needle);
544 #define strlcpy gitstrlcpy
545 extern size_t gitstrlcpy(char *, const char *, size_t);
549 #define strtoumax gitstrtoumax
550 extern uintmax_t gitstrtoumax(const char *, char **, int);
551 #define strtoimax gitstrtoimax
552 extern intmax_t gitstrtoimax(const char *, char **, int);
556 #define hstrerror githstrerror
557 extern const char *githstrerror(int herror);
561 #define memmem gitmemmem
562 void *gitmemmem(const void *haystack, size_t haystacklen,
563 const void *needle, size_t needlelen);
566 #ifdef NO_GETPAGESIZE
567 #define getpagesize() sysconf(_SC_PAGESIZE)
570 #ifdef FREAD_READS_DIRECTORIES
574 #define fopen(a,b) git_fopen(a,b)
575 extern FILE *git_fopen(const char*, const char*);
578 #ifdef SNPRINTF_RETURNS_BOGUS
582 #define snprintf git_snprintf
583 extern int git_snprintf(char *str, size_t maxsize,
584 const char *format, ...);
588 #define vsnprintf git_vsnprintf
589 extern int git_vsnprintf(char *str, size_t maxsize,
590 const char *format, va_list ap);
593 #ifdef __GLIBC_PREREQ
594 #if __GLIBC_PREREQ(2, 1)
595 #define HAVE_STRCHRNUL
600 #ifndef HAVE_STRCHRNUL
601 #define strchrnul gitstrchrnul
602 static inline char *gitstrchrnul(const char *s, int c)
604 while (*s && *s != c)
611 #define mempcpy gitmempcpy
612 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
614 return (char *)memcpy(dest, src, n) + n;
619 int inet_pton(int af, const char *src, void *dst);
623 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
627 #define atexit git_atexit
628 extern int git_atexit(void (*handler)(void));
631 extern void release_pack_memory(size_t);
633 typedef void (*try_to_free_t)(size_t);
634 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
638 # define xalloca(size) (alloca(size))
639 # define xalloca_free(p) do {} while (0)
641 # define xalloca(size) (xmalloc(size))
642 # define xalloca_free(p) (free(p))
644 extern char *xstrdup(const char *str);
645 extern void *xmalloc(size_t size);
646 extern void *xmallocz(size_t size);
647 extern void *xmallocz_gently(size_t size);
648 extern void *xmemdupz(const void *data, size_t len);
649 extern char *xstrndup(const char *str, size_t len);
650 extern void *xrealloc(void *ptr, size_t size);
651 extern void *xcalloc(size_t nmemb, size_t size);
652 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
653 extern ssize_t xread(int fd, void *buf, size_t len);
654 extern ssize_t xwrite(int fd, const void *buf, size_t len);
655 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
656 extern int xdup(int fd);
657 extern FILE *xfdopen(int fd, const char *mode);
658 extern int xmkstemp(char *template);
659 extern int xmkstemp_mode(char *template, int mode);
660 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
661 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
662 extern char *xgetcwd(void);
664 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
666 static inline size_t xsize_t(off_t len)
668 if (len > (size_t) len)
669 die("Cannot handle files this big");
673 /* in ctype.c, for kwset users */
674 extern const char tolower_trans_tbl[256];
676 /* Sane ctype - no locale, and works with signed chars */
691 extern const unsigned char sane_ctype[256];
692 #define GIT_SPACE 0x01
693 #define GIT_DIGIT 0x02
694 #define GIT_ALPHA 0x04
695 #define GIT_GLOB_SPECIAL 0x08
696 #define GIT_REGEX_SPECIAL 0x10
697 #define GIT_PATHSPEC_MAGIC 0x20
698 #define GIT_CNTRL 0x40
699 #define GIT_PUNCT 0x80
700 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
701 #define isascii(x) (((x) & ~0x7f) == 0)
702 #define isspace(x) sane_istest(x,GIT_SPACE)
703 #define isdigit(x) sane_istest(x,GIT_DIGIT)
704 #define isalpha(x) sane_istest(x,GIT_ALPHA)
705 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
706 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
707 #define islower(x) sane_iscase(x, 1)
708 #define isupper(x) sane_iscase(x, 0)
709 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
710 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
711 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
712 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
713 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
714 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
715 #define tolower(x) sane_case((unsigned char)(x), 0x20)
716 #define toupper(x) sane_case((unsigned char)(x), 0)
717 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
719 static inline int sane_case(int x, int high)
721 if (sane_istest(x, GIT_ALPHA))
722 x = (x & ~0x20) | high;
726 static inline int sane_iscase(int x, int is_lower)
728 if (!sane_istest(x, GIT_ALPHA))
732 return (x & 0x20) != 0;
734 return (x & 0x20) == 0;
737 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
743 ul = strtoul(s, &p, base);
744 if (errno || *p || p == s || (unsigned int) ul != ul)
750 static inline int strtol_i(char const *s, int base, int *result)
756 ul = strtol(s, &p, base);
757 if (errno || *p || p == s || (int) ul != ul)
763 #ifdef INTERNAL_QSORT
764 void git_qsort(void *base, size_t nmemb, size_t size,
765 int(*compar)(const void *, const void *));
766 #define qsort git_qsort
769 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
770 # define FORCE_DIR_SET_GID S_ISGID
772 # define FORCE_DIR_SET_GID 0
777 #define ST_CTIME_NSEC(st) 0
778 #define ST_MTIME_NSEC(st) 0
780 #ifdef USE_ST_TIMESPEC
781 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
782 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
784 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
785 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
789 #ifdef UNRELIABLE_FSTAT
790 #define fstat_is_reliable() 0
792 #define fstat_is_reliable() 1
797 * Since an obvious implementation of va_list would be to make it a
798 * pointer into the stack frame, a simple assignment will work on
799 * many systems. But let's try to be more portable.
802 #define va_copy(dst, src) __va_copy(dst, src)
804 #define va_copy(dst, src) ((dst) = (src))
808 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
809 #define HAVE_VARIADIC_MACROS 1
813 * Preserves errno, prints a message, but gives no warning for ENOENT.
814 * Returns 0 on success, which includes trying to unlink an object that does
817 int unlink_or_warn(const char *path);
819 * Tries to unlink file. Returns 0 if unlink succeeded
820 * or the file already didn't exist. Returns -1 and
821 * appends a message to err suitable for
822 * 'error("%s", err->buf)' on error.
824 int unlink_or_msg(const char *file, struct strbuf *err);
826 * Preserves errno, prints a message, but gives no warning for ENOENT.
827 * Returns 0 on success, which includes trying to remove a directory that does
830 int rmdir_or_warn(const char *path);
832 * Calls the correct function out of {unlink,rmdir}_or_warn based on
833 * the supplied file mode.
835 int remove_or_warn(unsigned int mode, const char *path);
838 * Call access(2), but warn for any error except "missing file"
839 * (ENOENT or ENOTDIR).
841 #define ACCESS_EACCES_OK (1U << 0)
842 int access_or_warn(const char *path, int mode, unsigned flag);
843 int access_or_die(const char *path, int mode, unsigned flag);
845 /* Warn on an inaccessible file that ought to be accessible */
846 void warn_on_inaccessible(const char *path);
848 /* Get the passwd entry for the UID of the current process. */
849 struct passwd *xgetpwuid_self(void);
851 #ifdef GMTIME_UNRELIABLE_ERRORS
852 struct tm *git_gmtime(const time_t *);
853 struct tm *git_gmtime_r(const time_t *, struct tm *);
854 #define gmtime git_gmtime
855 #define gmtime_r git_gmtime_r