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 *);
216 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
217 #include <AvailabilityMacros.h>
218 #undef DEPRECATED_ATTRIBUTE
219 #define DEPRECATED_ATTRIBUTE
220 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
222 #include <openssl/ssl.h>
223 #include <openssl/err.h>
224 #ifdef NO_HMAC_CTX_CLEANUP
225 #define HMAC_CTX_cleanup HMAC_cleanup
229 /* On most systems <netdb.h> would have given us this, but
230 * not on some systems (e.g. z/OS).
233 #define NI_MAXHOST 1025
237 #define NI_MAXSERV 32
240 /* On most systems <limits.h> would have given us this, but
241 * not on some systems (e.g. GNU/Hurd).
244 #define PATH_MAX 4096
248 #define PRIuMAX "llu"
270 #ifndef _PATH_DEFPATH
271 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
274 #ifndef STRIP_EXTENSION
275 #define STRIP_EXTENSION ""
278 #ifndef has_dos_drive_prefix
279 static inline int git_has_dos_drive_prefix(const char *path)
283 #define has_dos_drive_prefix git_has_dos_drive_prefix
287 static inline int git_is_dir_sep(int c)
291 #define is_dir_sep git_is_dir_sep
294 #ifndef offset_1st_component
295 static inline int git_offset_1st_component(const char *path)
297 return is_dir_sep(path[0]);
299 #define offset_1st_component git_offset_1st_component
302 #ifndef find_last_dir_sep
303 static inline char *git_find_last_dir_sep(const char *path)
305 return strrchr(path, '/');
307 #define find_last_dir_sep git_find_last_dir_sep
310 #if defined(__HP_cc) && (__HP_cc >= 61000)
311 #define NORETURN __attribute__((noreturn))
313 #elif defined(__GNUC__) && !defined(NO_NORETURN)
314 #define NORETURN __attribute__((__noreturn__))
315 #define NORETURN_PTR __attribute__((__noreturn__))
316 #elif defined(_MSC_VER)
317 #define NORETURN __declspec(noreturn)
323 #ifndef __attribute__
324 #define __attribute__(x)
329 /* The sentinel attribute is valid from gcc version 4.0 */
330 #if defined(__GNUC__) && (__GNUC__ >= 4)
331 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
333 #define LAST_ARG_MUST_BE_NULL
336 #include "compat/bswap.h"
338 #include "wildmatch.h"
342 /* General helper functions */
343 extern void vreportf(const char *prefix, const char *err, va_list params);
344 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
345 extern NORETURN void usage(const char *err);
346 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
347 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
348 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
349 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
350 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
353 #ifdef APPLE_COMMON_CRYPTO
354 #include "compat/apple-common-crypto.h"
356 #include <openssl/evp.h>
357 #include <openssl/hmac.h>
358 #endif /* APPLE_COMMON_CRYPTO */
359 #include <openssl/x509v3.h>
360 #endif /* NO_OPENSSL */
363 * Let callers be aware of the constant return value; this can help
364 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
365 * because some compilers may not support variadic macros. Since we're only
366 * trying to help gcc, anyway, it's OK; other compilers will fall back to
367 * using the function as usual.
369 #if defined(__GNUC__)
370 static inline int const_error(void)
374 #define error(...) (error(__VA_ARGS__), const_error())
377 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
378 extern void set_error_routine(void (*routine)(const char *err, va_list params));
379 extern void set_die_is_recursing_routine(int (*routine)(void));
381 extern int starts_with(const char *str, const char *prefix);
384 * If the string "str" begins with the string found in "prefix", return 1.
385 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
386 * the string right after the prefix).
388 * Otherwise, return 0 and leave "out" untouched.
392 * [extract branch name, fail if not a branch]
393 * if (!skip_prefix(ref, "refs/heads/", &branch)
396 * [skip prefix if present, otherwise use whole string]
397 * skip_prefix(name, "refs/heads/", &name);
399 static inline int skip_prefix(const char *str, const char *prefix,
407 } while (*str++ == *prefix++);
412 * If buf ends with suffix, return 1 and subtract the length of the suffix
413 * from *len. Otherwise, return 0 and leave *len untouched.
415 static inline int strip_suffix_mem(const char *buf, size_t *len,
418 size_t suflen = strlen(suffix);
419 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
426 * If str ends with suffix, return 1 and set *len to the size of the string
427 * without the suffix. Otherwise, return 0 and set *len to the size of the
430 * Note that we do _not_ NUL-terminate str to the new length.
432 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
435 return strip_suffix_mem(str, len, suffix);
438 static inline int ends_with(const char *str, const char *suffix)
441 return strip_suffix(str, suffix, &len);
444 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
449 #define MAP_PRIVATE 1
452 #define mmap git_mmap
453 #define munmap git_munmap
454 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
455 extern int git_munmap(void *start, size_t length);
457 #else /* NO_MMAP || USE_WIN32_MMAP */
459 #include <sys/mman.h>
461 #endif /* NO_MMAP || USE_WIN32_MMAP */
465 /* This value must be multiple of (pagesize * 2) */
466 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
470 /* This value must be multiple of (pagesize * 2) */
471 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
472 (sizeof(void*) >= 8 \
473 ? 1 * 1024 * 1024 * 1024 \
479 #define MAP_FAILED ((void *)-1)
482 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
483 #define on_disk_bytes(st) ((st).st_size)
485 #define on_disk_bytes(st) ((st).st_blocks * 512)
488 #ifdef NEEDS_MODE_TRANSLATION
497 #define S_IFMT 0170000
498 #define S_IFREG 0100000
499 #define S_IFDIR 0040000
500 #define S_IFLNK 0120000
501 #define S_IFBLK 0060000
502 #define S_IFCHR 0020000
503 #define S_IFIFO 0010000
504 #define S_IFSOCK 0140000
508 #define stat(path, buf) git_stat(path, buf)
509 extern int git_stat(const char *, struct stat *);
513 #define fstat(fd, buf) git_fstat(fd, buf)
514 extern int git_fstat(int, struct stat *);
518 #define lstat(path, buf) git_lstat(path, buf)
519 extern int git_lstat(const char *, struct stat *);
522 #define DEFAULT_PACKED_GIT_LIMIT \
523 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
526 #define pread git_pread
527 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
530 * Forward decl that will remind us if its twin in cache.h changes.
531 * This function is used in compat/pread.c. But we can't include
534 extern ssize_t read_in_full(int fd, void *buf, size_t count);
537 #define setenv gitsetenv
538 extern int gitsetenv(const char *, const char *, int);
542 #define mkdtemp gitmkdtemp
543 extern char *gitmkdtemp(char *);
547 #define mkstemps gitmkstemps
548 extern int gitmkstemps(char *, int);
552 #define unsetenv gitunsetenv
553 extern void gitunsetenv(const char *);
557 #define strcasestr gitstrcasestr
558 extern char *gitstrcasestr(const char *haystack, const char *needle);
562 #define strlcpy gitstrlcpy
563 extern size_t gitstrlcpy(char *, const char *, size_t);
567 #define strtoumax gitstrtoumax
568 extern uintmax_t gitstrtoumax(const char *, char **, int);
569 #define strtoimax gitstrtoimax
570 extern intmax_t gitstrtoimax(const char *, char **, int);
574 #define hstrerror githstrerror
575 extern const char *githstrerror(int herror);
579 #define memmem gitmemmem
580 void *gitmemmem(const void *haystack, size_t haystacklen,
581 const void *needle, size_t needlelen);
584 #ifdef NO_GETPAGESIZE
585 #define getpagesize() sysconf(_SC_PAGESIZE)
588 #ifdef FREAD_READS_DIRECTORIES
592 #define fopen(a,b) git_fopen(a,b)
593 extern FILE *git_fopen(const char*, const char*);
596 #ifdef SNPRINTF_RETURNS_BOGUS
600 #define snprintf git_snprintf
601 extern int git_snprintf(char *str, size_t maxsize,
602 const char *format, ...);
606 #define vsnprintf git_vsnprintf
607 extern int git_vsnprintf(char *str, size_t maxsize,
608 const char *format, va_list ap);
611 #ifdef __GLIBC_PREREQ
612 #if __GLIBC_PREREQ(2, 1)
613 #define HAVE_STRCHRNUL
618 #ifndef HAVE_STRCHRNUL
619 #define strchrnul gitstrchrnul
620 static inline char *gitstrchrnul(const char *s, int c)
622 while (*s && *s != c)
629 #define mempcpy gitmempcpy
630 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
632 return (char *)memcpy(dest, src, n) + n;
637 int inet_pton(int af, const char *src, void *dst);
641 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
645 #define atexit git_atexit
646 extern int git_atexit(void (*handler)(void));
649 extern void release_pack_memory(size_t);
651 typedef void (*try_to_free_t)(size_t);
652 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
656 # define xalloca(size) (alloca(size))
657 # define xalloca_free(p) do {} while (0)
659 # define xalloca(size) (xmalloc(size))
660 # define xalloca_free(p) (free(p))
662 extern char *xstrdup(const char *str);
663 extern void *xmalloc(size_t size);
664 extern void *xmallocz(size_t size);
665 extern void *xmallocz_gently(size_t size);
666 extern void *xmemdupz(const void *data, size_t len);
667 extern char *xstrndup(const char *str, size_t len);
668 extern void *xrealloc(void *ptr, size_t size);
669 extern void *xcalloc(size_t nmemb, size_t size);
670 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
671 extern ssize_t xread(int fd, void *buf, size_t len);
672 extern ssize_t xwrite(int fd, const void *buf, size_t len);
673 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
674 extern int xdup(int fd);
675 extern FILE *xfdopen(int fd, const char *mode);
676 extern int xmkstemp(char *template);
677 extern int xmkstemp_mode(char *template, int mode);
678 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
679 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
680 extern char *xgetcwd(void);
682 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
684 static inline char *xstrdup_or_null(const char *str)
686 return str ? xstrdup(str) : NULL;
689 static inline size_t xsize_t(off_t len)
691 if (len > (size_t) len)
692 die("Cannot handle files this big");
696 /* in ctype.c, for kwset users */
697 extern const char tolower_trans_tbl[256];
699 /* Sane ctype - no locale, and works with signed chars */
714 extern const unsigned char sane_ctype[256];
715 #define GIT_SPACE 0x01
716 #define GIT_DIGIT 0x02
717 #define GIT_ALPHA 0x04
718 #define GIT_GLOB_SPECIAL 0x08
719 #define GIT_REGEX_SPECIAL 0x10
720 #define GIT_PATHSPEC_MAGIC 0x20
721 #define GIT_CNTRL 0x40
722 #define GIT_PUNCT 0x80
723 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
724 #define isascii(x) (((x) & ~0x7f) == 0)
725 #define isspace(x) sane_istest(x,GIT_SPACE)
726 #define isdigit(x) sane_istest(x,GIT_DIGIT)
727 #define isalpha(x) sane_istest(x,GIT_ALPHA)
728 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
729 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
730 #define islower(x) sane_iscase(x, 1)
731 #define isupper(x) sane_iscase(x, 0)
732 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
733 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
734 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
735 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
736 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
737 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
738 #define tolower(x) sane_case((unsigned char)(x), 0x20)
739 #define toupper(x) sane_case((unsigned char)(x), 0)
740 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
742 static inline int sane_case(int x, int high)
744 if (sane_istest(x, GIT_ALPHA))
745 x = (x & ~0x20) | high;
749 static inline int sane_iscase(int x, int is_lower)
751 if (!sane_istest(x, GIT_ALPHA))
755 return (x & 0x20) != 0;
757 return (x & 0x20) == 0;
760 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
766 ul = strtoul(s, &p, base);
767 if (errno || *p || p == s || (unsigned int) ul != ul)
773 static inline int strtol_i(char const *s, int base, int *result)
779 ul = strtol(s, &p, base);
780 if (errno || *p || p == s || (int) ul != ul)
786 #ifdef INTERNAL_QSORT
787 void git_qsort(void *base, size_t nmemb, size_t size,
788 int(*compar)(const void *, const void *));
789 #define qsort git_qsort
792 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
793 # define FORCE_DIR_SET_GID S_ISGID
795 # define FORCE_DIR_SET_GID 0
800 #define ST_CTIME_NSEC(st) 0
801 #define ST_MTIME_NSEC(st) 0
803 #ifdef USE_ST_TIMESPEC
804 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
805 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
807 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
808 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
812 #ifdef UNRELIABLE_FSTAT
813 #define fstat_is_reliable() 0
815 #define fstat_is_reliable() 1
820 * Since an obvious implementation of va_list would be to make it a
821 * pointer into the stack frame, a simple assignment will work on
822 * many systems. But let's try to be more portable.
825 #define va_copy(dst, src) __va_copy(dst, src)
827 #define va_copy(dst, src) ((dst) = (src))
831 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
832 #define HAVE_VARIADIC_MACROS 1
836 * Preserves errno, prints a message, but gives no warning for ENOENT.
837 * Returns 0 on success, which includes trying to unlink an object that does
840 int unlink_or_warn(const char *path);
842 * Tries to unlink file. Returns 0 if unlink succeeded
843 * or the file already didn't exist. Returns -1 and
844 * appends a message to err suitable for
845 * 'error("%s", err->buf)' on error.
847 int unlink_or_msg(const char *file, struct strbuf *err);
849 * Preserves errno, prints a message, but gives no warning for ENOENT.
850 * Returns 0 on success, which includes trying to remove a directory that does
853 int rmdir_or_warn(const char *path);
855 * Calls the correct function out of {unlink,rmdir}_or_warn based on
856 * the supplied file mode.
858 int remove_or_warn(unsigned int mode, const char *path);
861 * Call access(2), but warn for any error except "missing file"
862 * (ENOENT or ENOTDIR).
864 #define ACCESS_EACCES_OK (1U << 0)
865 int access_or_warn(const char *path, int mode, unsigned flag);
866 int access_or_die(const char *path, int mode, unsigned flag);
868 /* Warn on an inaccessible file that ought to be accessible */
869 void warn_on_inaccessible(const char *path);
871 /* Get the passwd entry for the UID of the current process. */
872 struct passwd *xgetpwuid_self(void);
874 #ifdef GMTIME_UNRELIABLE_ERRORS
875 struct tm *git_gmtime(const time_t *);
876 struct tm *git_gmtime_r(const time_t *, struct tm *);
877 #define gmtime git_gmtime
878 #define gmtime_r git_gmtime_r
881 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
882 #define USE_PARENS_AROUND_GETTEXT_N 1