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__)
79 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
80 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
85 #define _NETBSD_SOURCE 1
88 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
89 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
90 # define _WIN32_WINNT 0x0502
92 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
95 #define GIT_WINDOWS_NATIVE
100 #include <sys/stat.h>
106 #ifdef HAVE_STRINGS_H
107 #include <strings.h> /* for strcasecmp() */
111 #ifdef NEEDS_SYS_PARAM_H
112 #include <sys/param.h>
114 #include <sys/types.h>
116 #include <sys/time.h>
123 #ifndef NO_SYS_POLL_H
124 #include <sys/poll.h>
129 #if defined(__MINGW32__)
130 /* pull in Windows compatibility stuff */
131 #include "compat/mingw.h"
132 #elif defined(_MSC_VER)
133 #include "compat/msvc.h"
135 #include <sys/wait.h>
136 #include <sys/resource.h>
137 #include <sys/socket.h>
138 #include <sys/ioctl.h>
140 #ifndef NO_SYS_SELECT_H
141 #include <sys/select.h>
143 #include <netinet/in.h>
144 #include <netinet/tcp.h>
145 #include <arpa/inet.h>
149 #ifndef NO_INTTYPES_H
150 #include <inttypes.h>
156 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
157 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
158 * while on IP16 and IP16L32 it is "int" (resp. "short")
159 * Size needs to match (or exceed) 'sizeof(void *)'.
160 * We can't take "long long" here as not everybody has it.
162 typedef long intptr_t;
163 typedef unsigned long uintptr_t;
165 #if defined(__CYGWIN__)
168 #define _XOPEN_SOURCE 600
170 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
172 #define _ALL_SOURCE 1
176 /* used on Mac OS X */
177 #ifdef PRECOMPOSE_UNICODE
178 #include "compat/precompose_utf8.h"
180 #define precompose_str(in,i_nfd2nfc)
181 #define precompose_argv(c,v)
182 #define probe_utf8_pathname_composition(a,b)
185 #ifdef MKDIR_WO_TRAILING_SLASH
186 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
187 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
190 #ifdef NO_STRUCT_ITIMERVAL
192 struct timeval it_interval;
193 struct timeval it_value;
198 #define setitimer(which,value,ovalue)
204 #define basename gitbasename
205 extern char *gitbasename(char *);
213 #include <openssl/ssl.h>
214 #include <openssl/err.h>
217 /* On most systems <netdb.h> would have given us this, but
218 * not on some systems (e.g. z/OS).
221 #define NI_MAXHOST 1025
225 #define NI_MAXSERV 32
228 /* On most systems <limits.h> would have given us this, but
229 * not on some systems (e.g. GNU/Hurd).
232 #define PATH_MAX 4096
236 #define PRIuMAX "llu"
258 #ifndef _PATH_DEFPATH
259 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
262 #ifndef STRIP_EXTENSION
263 #define STRIP_EXTENSION ""
266 #ifndef has_dos_drive_prefix
267 #define has_dos_drive_prefix(path) 0
270 #ifndef offset_1st_component
271 #define offset_1st_component(path) (is_dir_sep((path)[0]))
275 #define is_dir_sep(c) ((c) == '/')
278 #ifndef find_last_dir_sep
279 #define find_last_dir_sep(path) strrchr(path, '/')
282 #if defined(__HP_cc) && (__HP_cc >= 61000)
283 #define NORETURN __attribute__((noreturn))
285 #elif defined(__GNUC__) && !defined(NO_NORETURN)
286 #define NORETURN __attribute__((__noreturn__))
287 #define NORETURN_PTR __attribute__((__noreturn__))
288 #elif defined(_MSC_VER)
289 #define NORETURN __declspec(noreturn)
295 #ifndef __attribute__
296 #define __attribute__(x)
301 /* The sentinel attribute is valid from gcc version 4.0 */
302 #if defined(__GNUC__) && (__GNUC__ >= 4)
303 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
305 #define LAST_ARG_MUST_BE_NULL
308 #include "compat/bswap.h"
310 #include "wildmatch.h"
312 /* General helper functions */
313 extern void vreportf(const char *prefix, const char *err, va_list params);
314 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
315 extern NORETURN void usage(const char *err);
316 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
317 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
318 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
319 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
320 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
323 #ifdef APPLE_COMMON_CRYPTO
324 #include "compat/apple-common-crypto.h"
326 #include <openssl/evp.h>
327 #include <openssl/hmac.h>
328 #endif /* APPLE_COMMON_CRYPTO */
329 #include <openssl/x509v3.h>
330 #endif /* NO_OPENSSL */
333 * Let callers be aware of the constant return value; this can help
334 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
335 * because some compilers may not support variadic macros. Since we're only
336 * trying to help gcc, anyway, it's OK; other compilers will fall back to
337 * using the function as usual.
339 #if defined(__GNUC__)
340 static inline int const_error(void)
344 #define error(...) (error(__VA_ARGS__), const_error())
347 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
348 extern void set_error_routine(void (*routine)(const char *err, va_list params));
349 extern void set_die_is_recursing_routine(int (*routine)(void));
351 extern int starts_with(const char *str, const char *prefix);
354 * If the string "str" begins with the string found in "prefix", return 1.
355 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
356 * the string right after the prefix).
358 * Otherwise, return 0 and leave "out" untouched.
362 * [extract branch name, fail if not a branch]
363 * if (!skip_prefix(ref, "refs/heads/", &branch)
366 * [skip prefix if present, otherwise use whole string]
367 * skip_prefix(name, "refs/heads/", &name);
369 static inline int skip_prefix(const char *str, const char *prefix,
377 } while (*str++ == *prefix++);
382 * If buf ends with suffix, return 1 and subtract the length of the suffix
383 * from *len. Otherwise, return 0 and leave *len untouched.
385 static inline int strip_suffix_mem(const char *buf, size_t *len,
388 size_t suflen = strlen(suffix);
389 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
396 * If str ends with suffix, return 1 and set *len to the size of the string
397 * without the suffix. Otherwise, return 0 and set *len to the size of the
400 * Note that we do _not_ NUL-terminate str to the new length.
402 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
405 return strip_suffix_mem(str, len, suffix);
408 static inline int ends_with(const char *str, const char *suffix)
411 return strip_suffix(str, suffix, &len);
414 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
419 #define MAP_PRIVATE 1
422 #define mmap git_mmap
423 #define munmap git_munmap
424 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
425 extern int git_munmap(void *start, size_t length);
427 #else /* NO_MMAP || USE_WIN32_MMAP */
429 #include <sys/mman.h>
431 #endif /* NO_MMAP || USE_WIN32_MMAP */
435 /* This value must be multiple of (pagesize * 2) */
436 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
440 /* This value must be multiple of (pagesize * 2) */
441 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
442 (sizeof(void*) >= 8 \
443 ? 1 * 1024 * 1024 * 1024 \
449 #define MAP_FAILED ((void *)-1)
452 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
453 #define on_disk_bytes(st) ((st).st_size)
455 #define on_disk_bytes(st) ((st).st_blocks * 512)
458 #ifdef NEEDS_MODE_TRANSLATION
467 #define S_IFMT 0170000
468 #define S_IFREG 0100000
469 #define S_IFDIR 0040000
470 #define S_IFLNK 0120000
471 #define S_IFBLK 0060000
472 #define S_IFCHR 0020000
473 #define S_IFIFO 0010000
474 #define S_IFSOCK 0140000
478 #define stat(path, buf) git_stat(path, buf)
479 extern int git_stat(const char *, struct stat *);
483 #define fstat(fd, buf) git_fstat(fd, buf)
484 extern int git_fstat(int, struct stat *);
488 #define lstat(path, buf) git_lstat(path, buf)
489 extern int git_lstat(const char *, struct stat *);
492 #define DEFAULT_PACKED_GIT_LIMIT \
493 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
496 #define pread git_pread
497 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
500 * Forward decl that will remind us if its twin in cache.h changes.
501 * This function is used in compat/pread.c. But we can't include
504 extern ssize_t read_in_full(int fd, void *buf, size_t count);
507 #define setenv gitsetenv
508 extern int gitsetenv(const char *, const char *, int);
512 #define mkdtemp gitmkdtemp
513 extern char *gitmkdtemp(char *);
517 #define mkstemps gitmkstemps
518 extern int gitmkstemps(char *, int);
522 #define unsetenv gitunsetenv
523 extern void gitunsetenv(const char *);
527 #define strcasestr gitstrcasestr
528 extern char *gitstrcasestr(const char *haystack, const char *needle);
532 #define strlcpy gitstrlcpy
533 extern size_t gitstrlcpy(char *, const char *, size_t);
537 #define strtoumax gitstrtoumax
538 extern uintmax_t gitstrtoumax(const char *, char **, int);
539 #define strtoimax gitstrtoimax
540 extern intmax_t gitstrtoimax(const char *, char **, int);
544 #define hstrerror githstrerror
545 extern const char *githstrerror(int herror);
549 #define memmem gitmemmem
550 void *gitmemmem(const void *haystack, size_t haystacklen,
551 const void *needle, size_t needlelen);
554 #ifdef NO_GETPAGESIZE
555 #define getpagesize() sysconf(_SC_PAGESIZE)
558 #ifdef FREAD_READS_DIRECTORIES
562 #define fopen(a,b) git_fopen(a,b)
563 extern FILE *git_fopen(const char*, const char*);
566 #ifdef SNPRINTF_RETURNS_BOGUS
570 #define snprintf git_snprintf
571 extern int git_snprintf(char *str, size_t maxsize,
572 const char *format, ...);
576 #define vsnprintf git_vsnprintf
577 extern int git_vsnprintf(char *str, size_t maxsize,
578 const char *format, va_list ap);
581 #ifdef __GLIBC_PREREQ
582 #if __GLIBC_PREREQ(2, 1)
583 #define HAVE_STRCHRNUL
588 #ifndef HAVE_STRCHRNUL
589 #define strchrnul gitstrchrnul
590 static inline char *gitstrchrnul(const char *s, int c)
592 while (*s && *s != c)
599 #define mempcpy gitmempcpy
600 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
602 return (char *)memcpy(dest, src, n) + n;
607 int inet_pton(int af, const char *src, void *dst);
611 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
614 extern void release_pack_memory(size_t);
616 typedef void (*try_to_free_t)(size_t);
617 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
621 # define xalloca(size) (alloca(size))
622 # define xalloca_free(p) do {} while (0)
624 # define xalloca(size) (xmalloc(size))
625 # define xalloca_free(p) (free(p))
627 extern char *xstrdup(const char *str);
628 extern void *xmalloc(size_t size);
629 extern void *xmallocz(size_t size);
630 extern void *xmemdupz(const void *data, size_t len);
631 extern char *xstrndup(const char *str, size_t len);
632 extern void *xrealloc(void *ptr, size_t size);
633 extern void *xcalloc(size_t nmemb, size_t size);
634 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
635 extern ssize_t xread(int fd, void *buf, size_t len);
636 extern ssize_t xwrite(int fd, const void *buf, size_t len);
637 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
638 extern int xdup(int fd);
639 extern FILE *xfdopen(int fd, const char *mode);
640 extern int xmkstemp(char *template);
641 extern int xmkstemp_mode(char *template, int mode);
642 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
643 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
645 static inline size_t xsize_t(off_t len)
647 if (len > (size_t) len)
648 die("Cannot handle files this big");
652 /* in ctype.c, for kwset users */
653 extern const char tolower_trans_tbl[256];
655 /* Sane ctype - no locale, and works with signed chars */
670 extern const unsigned char sane_ctype[256];
671 #define GIT_SPACE 0x01
672 #define GIT_DIGIT 0x02
673 #define GIT_ALPHA 0x04
674 #define GIT_GLOB_SPECIAL 0x08
675 #define GIT_REGEX_SPECIAL 0x10
676 #define GIT_PATHSPEC_MAGIC 0x20
677 #define GIT_CNTRL 0x40
678 #define GIT_PUNCT 0x80
679 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
680 #define isascii(x) (((x) & ~0x7f) == 0)
681 #define isspace(x) sane_istest(x,GIT_SPACE)
682 #define isdigit(x) sane_istest(x,GIT_DIGIT)
683 #define isalpha(x) sane_istest(x,GIT_ALPHA)
684 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
685 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
686 #define islower(x) sane_iscase(x, 1)
687 #define isupper(x) sane_iscase(x, 0)
688 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
689 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
690 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
691 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
692 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
693 #define isxdigit(x) (hexval_table[x] != -1)
694 #define tolower(x) sane_case((unsigned char)(x), 0x20)
695 #define toupper(x) sane_case((unsigned char)(x), 0)
696 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
698 static inline int sane_case(int x, int high)
700 if (sane_istest(x, GIT_ALPHA))
701 x = (x & ~0x20) | high;
705 static inline int sane_iscase(int x, int is_lower)
707 if (!sane_istest(x, GIT_ALPHA))
711 return (x & 0x20) != 0;
713 return (x & 0x20) == 0;
716 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
722 ul = strtoul(s, &p, base);
723 if (errno || *p || p == s || (unsigned int) ul != ul)
729 static inline int strtol_i(char const *s, int base, int *result)
735 ul = strtol(s, &p, base);
736 if (errno || *p || p == s || (int) ul != ul)
742 #ifdef INTERNAL_QSORT
743 void git_qsort(void *base, size_t nmemb, size_t size,
744 int(*compar)(const void *, const void *));
745 #define qsort git_qsort
748 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
749 # define FORCE_DIR_SET_GID S_ISGID
751 # define FORCE_DIR_SET_GID 0
756 #define ST_CTIME_NSEC(st) 0
757 #define ST_MTIME_NSEC(st) 0
759 #ifdef USE_ST_TIMESPEC
760 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
761 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
763 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
764 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
768 #ifdef UNRELIABLE_FSTAT
769 #define fstat_is_reliable() 0
771 #define fstat_is_reliable() 1
776 * Since an obvious implementation of va_list would be to make it a
777 * pointer into the stack frame, a simple assignment will work on
778 * many systems. But let's try to be more portable.
781 #define va_copy(dst, src) __va_copy(dst, src)
783 #define va_copy(dst, src) ((dst) = (src))
787 #if defined(__GNUC__) || (_MSC_VER >= 1400)
788 #define HAVE_VARIADIC_MACROS 1
792 * Preserves errno, prints a message, but gives no warning for ENOENT.
793 * Always returns the return value of unlink(2).
795 int unlink_or_warn(const char *path);
797 * Likewise for rmdir(2).
799 int rmdir_or_warn(const char *path);
801 * Calls the correct function out of {unlink,rmdir}_or_warn based on
802 * the supplied file mode.
804 int remove_or_warn(unsigned int mode, const char *path);
807 * Call access(2), but warn for any error except "missing file"
808 * (ENOENT or ENOTDIR).
810 #define ACCESS_EACCES_OK (1U << 0)
811 int access_or_warn(const char *path, int mode, unsigned flag);
812 int access_or_die(const char *path, int mode, unsigned flag);
814 /* Warn on an inaccessible file that ought to be accessible */
815 void warn_on_inaccessible(const char *path);
817 /* Get the passwd entry for the UID of the current process. */
818 struct passwd *xgetpwuid_self(void);
820 #ifdef GMTIME_UNRELIABLE_ERRORS
821 struct tm *git_gmtime(const time_t *);
822 struct tm *git_gmtime_r(const time_t *, struct tm *);
823 #define gmtime git_gmtime
824 #define gmtime_r git_gmtime_r