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)
294 #ifndef __attribute__
295 #define __attribute__(x)
299 /* The sentinel attribute is valid from gcc version 4.0 */
300 #if defined(__GNUC__) && (__GNUC__ >= 4)
301 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
303 #define LAST_ARG_MUST_BE_NULL
306 #include "compat/bswap.h"
308 #include "wildmatch.h"
310 /* General helper functions */
311 extern void vreportf(const char *prefix, const char *err, va_list params);
312 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
313 extern NORETURN void usage(const char *err);
314 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
315 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
316 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
317 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
318 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
321 #ifdef APPLE_COMMON_CRYPTO
322 #include "compat/apple-common-crypto.h"
324 #include <openssl/evp.h>
325 #include <openssl/hmac.h>
326 #endif /* APPLE_COMMON_CRYPTO */
327 #include <openssl/x509v3.h>
328 #endif /* NO_OPENSSL */
331 * Let callers be aware of the constant return value; this can help
332 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
333 * because some compilers may not support variadic macros. Since we're only
334 * trying to help gcc, anyway, it's OK; other compilers will fall back to
335 * using the function as usual.
337 #if defined(__GNUC__)
338 static inline int const_error(void)
342 #define error(...) (error(__VA_ARGS__), const_error())
345 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
346 extern void set_error_routine(void (*routine)(const char *err, va_list params));
347 extern void set_die_is_recursing_routine(int (*routine)(void));
349 extern int starts_with(const char *str, const char *prefix);
350 extern int ends_with(const char *str, const char *suffix);
352 static inline const char *skip_prefix(const char *str, const char *prefix)
357 } while (*str++ == *prefix++);
361 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
366 #define MAP_PRIVATE 1
369 #define mmap git_mmap
370 #define munmap git_munmap
371 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
372 extern int git_munmap(void *start, size_t length);
374 #else /* NO_MMAP || USE_WIN32_MMAP */
376 #include <sys/mman.h>
378 #endif /* NO_MMAP || USE_WIN32_MMAP */
382 /* This value must be multiple of (pagesize * 2) */
383 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
387 /* This value must be multiple of (pagesize * 2) */
388 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
389 (sizeof(void*) >= 8 \
390 ? 1 * 1024 * 1024 * 1024 \
396 #define MAP_FAILED ((void *)-1)
399 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
400 #define on_disk_bytes(st) ((st).st_size)
402 #define on_disk_bytes(st) ((st).st_blocks * 512)
405 #define DEFAULT_PACKED_GIT_LIMIT \
406 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
409 #define pread git_pread
410 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
413 * Forward decl that will remind us if its twin in cache.h changes.
414 * This function is used in compat/pread.c. But we can't include
417 extern ssize_t read_in_full(int fd, void *buf, size_t count);
420 #define setenv gitsetenv
421 extern int gitsetenv(const char *, const char *, int);
425 #define mkdtemp gitmkdtemp
426 extern char *gitmkdtemp(char *);
430 #define mkstemps gitmkstemps
431 extern int gitmkstemps(char *, int);
435 #define unsetenv gitunsetenv
436 extern void gitunsetenv(const char *);
440 #define strcasestr gitstrcasestr
441 extern char *gitstrcasestr(const char *haystack, const char *needle);
445 #define strlcpy gitstrlcpy
446 extern size_t gitstrlcpy(char *, const char *, size_t);
450 #define strtoumax gitstrtoumax
451 extern uintmax_t gitstrtoumax(const char *, char **, int);
452 #define strtoimax gitstrtoimax
453 extern intmax_t gitstrtoimax(const char *, char **, int);
457 #define hstrerror githstrerror
458 extern const char *githstrerror(int herror);
462 #define memmem gitmemmem
463 void *gitmemmem(const void *haystack, size_t haystacklen,
464 const void *needle, size_t needlelen);
467 #ifdef NO_GETPAGESIZE
468 #define getpagesize() sysconf(_SC_PAGESIZE)
471 #ifdef FREAD_READS_DIRECTORIES
475 #define fopen(a,b) git_fopen(a,b)
476 extern FILE *git_fopen(const char*, const char*);
479 #ifdef SNPRINTF_RETURNS_BOGUS
483 #define snprintf git_snprintf
484 extern int git_snprintf(char *str, size_t maxsize,
485 const char *format, ...);
489 #define vsnprintf git_vsnprintf
490 extern int git_vsnprintf(char *str, size_t maxsize,
491 const char *format, va_list ap);
494 #ifdef __GLIBC_PREREQ
495 #if __GLIBC_PREREQ(2, 1)
496 #define HAVE_STRCHRNUL
501 #ifndef HAVE_STRCHRNUL
502 #define strchrnul gitstrchrnul
503 static inline char *gitstrchrnul(const char *s, int c)
505 while (*s && *s != c)
512 #define mempcpy gitmempcpy
513 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
515 return (char *)memcpy(dest, src, n) + n;
520 int inet_pton(int af, const char *src, void *dst);
524 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
527 extern void release_pack_memory(size_t);
529 typedef void (*try_to_free_t)(size_t);
530 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
534 # define xalloca(size) (alloca(size))
535 # define xalloca_free(p) do {} while (0)
537 # define xalloca(size) (xmalloc(size))
538 # define xalloca_free(p) (free(p))
540 extern char *xstrdup(const char *str);
541 extern void *xmalloc(size_t size);
542 extern void *xmallocz(size_t size);
543 extern void *xmemdupz(const void *data, size_t len);
544 extern char *xstrndup(const char *str, size_t len);
545 extern void *xrealloc(void *ptr, size_t size);
546 extern void *xcalloc(size_t nmemb, size_t size);
547 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
548 extern ssize_t xread(int fd, void *buf, size_t len);
549 extern ssize_t xwrite(int fd, const void *buf, size_t len);
550 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
551 extern int xdup(int fd);
552 extern FILE *xfdopen(int fd, const char *mode);
553 extern int xmkstemp(char *template);
554 extern int xmkstemp_mode(char *template, int mode);
555 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
556 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
558 static inline size_t xsize_t(off_t len)
560 if (len > (size_t) len)
561 die("Cannot handle files this big");
565 static inline int has_extension(const char *filename, const char *ext)
567 size_t len = strlen(filename);
568 size_t extlen = strlen(ext);
569 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
572 /* in ctype.c, for kwset users */
573 extern const char tolower_trans_tbl[256];
575 /* Sane ctype - no locale, and works with signed chars */
590 extern const unsigned char sane_ctype[256];
591 #define GIT_SPACE 0x01
592 #define GIT_DIGIT 0x02
593 #define GIT_ALPHA 0x04
594 #define GIT_GLOB_SPECIAL 0x08
595 #define GIT_REGEX_SPECIAL 0x10
596 #define GIT_PATHSPEC_MAGIC 0x20
597 #define GIT_CNTRL 0x40
598 #define GIT_PUNCT 0x80
599 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
600 #define isascii(x) (((x) & ~0x7f) == 0)
601 #define isspace(x) sane_istest(x,GIT_SPACE)
602 #define isdigit(x) sane_istest(x,GIT_DIGIT)
603 #define isalpha(x) sane_istest(x,GIT_ALPHA)
604 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
605 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
606 #define islower(x) sane_iscase(x, 1)
607 #define isupper(x) sane_iscase(x, 0)
608 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
609 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
610 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
611 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
612 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
613 #define isxdigit(x) (hexval_table[x] != -1)
614 #define tolower(x) sane_case((unsigned char)(x), 0x20)
615 #define toupper(x) sane_case((unsigned char)(x), 0)
616 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
618 static inline int sane_case(int x, int high)
620 if (sane_istest(x, GIT_ALPHA))
621 x = (x & ~0x20) | high;
625 static inline int sane_iscase(int x, int is_lower)
627 if (!sane_istest(x, GIT_ALPHA))
631 return (x & 0x20) != 0;
633 return (x & 0x20) == 0;
636 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
642 ul = strtoul(s, &p, base);
643 if (errno || *p || p == s || (unsigned int) ul != ul)
649 static inline int strtol_i(char const *s, int base, int *result)
655 ul = strtol(s, &p, base);
656 if (errno || *p || p == s || (int) ul != ul)
662 #ifdef INTERNAL_QSORT
663 void git_qsort(void *base, size_t nmemb, size_t size,
664 int(*compar)(const void *, const void *));
665 #define qsort git_qsort
668 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
669 # define FORCE_DIR_SET_GID S_ISGID
671 # define FORCE_DIR_SET_GID 0
676 #define ST_CTIME_NSEC(st) 0
677 #define ST_MTIME_NSEC(st) 0
679 #ifdef USE_ST_TIMESPEC
680 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
681 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
683 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
684 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
688 #ifdef UNRELIABLE_FSTAT
689 #define fstat_is_reliable() 0
691 #define fstat_is_reliable() 1
696 * Since an obvious implementation of va_list would be to make it a
697 * pointer into the stack frame, a simple assignment will work on
698 * many systems. But let's try to be more portable.
701 #define va_copy(dst, src) __va_copy(dst, src)
703 #define va_copy(dst, src) ((dst) = (src))
708 * Preserves errno, prints a message, but gives no warning for ENOENT.
709 * Always returns the return value of unlink(2).
711 int unlink_or_warn(const char *path);
713 * Likewise for rmdir(2).
715 int rmdir_or_warn(const char *path);
717 * Calls the correct function out of {unlink,rmdir}_or_warn based on
718 * the supplied file mode.
720 int remove_or_warn(unsigned int mode, const char *path);
723 * Call access(2), but warn for any error except "missing file"
724 * (ENOENT or ENOTDIR).
726 #define ACCESS_EACCES_OK (1U << 0)
727 int access_or_warn(const char *path, int mode, unsigned flag);
728 int access_or_die(const char *path, int mode, unsigned flag);
730 /* Warn on an inaccessible file that ought to be accessible */
731 void warn_on_inaccessible(const char *path);
733 /* Get the passwd entry for the UID of the current process. */
734 struct passwd *xgetpwuid_self(void);
736 #ifdef GMTIME_UNRELIABLE_ERRORS
737 struct tm *git_gmtime(const time_t *);
738 struct tm *git_gmtime_r(const time_t *, struct tm *);
739 #define gmtime git_gmtime
740 #define gmtime_r git_gmtime_r