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>
119 #ifndef USE_WILDMATCH
126 #ifndef NO_SYS_POLL_H
127 #include <sys/poll.h>
132 #if defined(__MINGW32__)
133 /* pull in Windows compatibility stuff */
134 #include "compat/mingw.h"
135 #elif defined(_MSC_VER)
136 #include "compat/msvc.h"
138 #include <sys/wait.h>
139 #include <sys/resource.h>
140 #include <sys/socket.h>
141 #include <sys/ioctl.h>
143 #ifndef NO_SYS_SELECT_H
144 #include <sys/select.h>
146 #include <netinet/in.h>
147 #include <netinet/tcp.h>
148 #include <arpa/inet.h>
152 #ifndef NO_INTTYPES_H
153 #include <inttypes.h>
159 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
160 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
161 * while on IP16 and IP16L32 it is "int" (resp. "short")
162 * Size needs to match (or exceed) 'sizeof(void *)'.
163 * We can't take "long long" here as not everybody has it.
165 typedef long intptr_t;
166 typedef unsigned long uintptr_t;
168 #if defined(__CYGWIN__)
171 #define _XOPEN_SOURCE 600
173 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
175 #define _ALL_SOURCE 1
179 /* used on Mac OS X */
180 #ifdef PRECOMPOSE_UNICODE
181 #include "compat/precompose_utf8.h"
183 #define precompose_str(in,i_nfd2nfc)
184 #define precompose_argv(c,v)
185 #define probe_utf8_pathname_composition(a,b)
188 #ifdef MKDIR_WO_TRAILING_SLASH
189 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
190 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
193 #ifdef NO_STRUCT_ITIMERVAL
195 struct timeval it_interval;
196 struct timeval it_value;
201 #define setitimer(which,value,ovalue)
207 #define basename gitbasename
208 extern char *gitbasename(char *);
216 #include <openssl/ssl.h>
217 #include <openssl/err.h>
220 /* On most systems <netdb.h> would have given us this, but
221 * not on some systems (e.g. z/OS).
224 #define NI_MAXHOST 1025
228 #define NI_MAXSERV 32
231 /* On most systems <limits.h> would have given us this, but
232 * not on some systems (e.g. GNU/Hurd).
235 #define PATH_MAX 4096
239 #define PRIuMAX "llu"
261 #ifndef _PATH_DEFPATH
262 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
265 #ifndef STRIP_EXTENSION
266 #define STRIP_EXTENSION ""
269 #ifndef has_dos_drive_prefix
270 #define has_dos_drive_prefix(path) 0
274 #define is_dir_sep(c) ((c) == '/')
277 #ifndef find_last_dir_sep
278 #define find_last_dir_sep(path) strrchr(path, '/')
281 #if defined(__HP_cc) && (__HP_cc >= 61000)
282 #define NORETURN __attribute__((noreturn))
284 #elif defined(__GNUC__) && !defined(NO_NORETURN)
285 #define NORETURN __attribute__((__noreturn__))
286 #define NORETURN_PTR __attribute__((__noreturn__))
287 #elif defined(_MSC_VER)
288 #define NORETURN __declspec(noreturn)
293 #ifndef __attribute__
294 #define __attribute__(x)
298 /* The sentinel attribute is valid from gcc version 4.0 */
299 #if defined(__GNUC__) && (__GNUC__ >= 4)
300 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
302 #define LAST_ARG_MUST_BE_NULL
305 #include "compat/bswap.h"
308 #include "wildmatch.h"
309 #define FNM_PATHNAME WM_PATHNAME
310 #define FNM_CASEFOLD WM_CASEFOLD
311 #define FNM_NOMATCH WM_NOMATCH
312 static inline int fnmatch(const char *pattern, const char *string, int flags)
314 return wildmatch(pattern, string, flags, NULL);
318 /* General helper functions */
319 extern void vreportf(const char *prefix, const char *err, va_list params);
320 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
321 extern NORETURN void usage(const char *err);
322 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
323 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
324 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
325 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
326 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
329 #ifdef APPLE_COMMON_CRYPTO
330 #include "compat/apple-common-crypto.h"
332 #include <openssl/evp.h>
333 #include <openssl/hmac.h>
334 #endif /* APPLE_COMMON_CRYPTO */
335 #include <openssl/x509v3.h>
336 #endif /* NO_OPENSSL */
339 * Let callers be aware of the constant return value; this can help
340 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
341 * because some compilers may not support variadic macros. Since we're only
342 * trying to help gcc, anyway, it's OK; other compilers will fall back to
343 * using the function as usual.
345 #if defined(__GNUC__) && ! defined(__clang__)
346 #define error(...) (error(__VA_ARGS__), -1)
349 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
350 extern void set_error_routine(void (*routine)(const char *err, va_list params));
351 extern void set_die_is_recursing_routine(int (*routine)(void));
353 extern int starts_with(const char *str, const char *prefix);
354 extern int prefixcmp(const char *str, const char *prefix);
355 extern int ends_with(const char *str, const char *suffix);
356 extern int suffixcmp(const char *str, const char *suffix);
358 static inline const char *skip_prefix(const char *str, const char *prefix)
360 size_t len = strlen(prefix);
361 return strncmp(str, prefix, len) ? NULL : str + len;
364 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
369 #define MAP_PRIVATE 1
372 #define mmap git_mmap
373 #define munmap git_munmap
374 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
375 extern int git_munmap(void *start, size_t length);
377 #else /* NO_MMAP || USE_WIN32_MMAP */
379 #include <sys/mman.h>
381 #endif /* NO_MMAP || USE_WIN32_MMAP */
385 /* This value must be multiple of (pagesize * 2) */
386 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
390 /* This value must be multiple of (pagesize * 2) */
391 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
392 (sizeof(void*) >= 8 \
393 ? 1 * 1024 * 1024 * 1024 \
399 #define MAP_FAILED ((void *)-1)
402 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
403 #define on_disk_bytes(st) ((st).st_size)
405 #define on_disk_bytes(st) ((st).st_blocks * 512)
408 #define DEFAULT_PACKED_GIT_LIMIT \
409 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
412 #define pread git_pread
413 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
416 * Forward decl that will remind us if its twin in cache.h changes.
417 * This function is used in compat/pread.c. But we can't include
420 extern ssize_t read_in_full(int fd, void *buf, size_t count);
423 #define setenv gitsetenv
424 extern int gitsetenv(const char *, const char *, int);
428 #define mkdtemp gitmkdtemp
429 extern char *gitmkdtemp(char *);
433 #define mkstemps gitmkstemps
434 extern int gitmkstemps(char *, int);
438 #define unsetenv gitunsetenv
439 extern void gitunsetenv(const char *);
443 #define strcasestr gitstrcasestr
444 extern char *gitstrcasestr(const char *haystack, const char *needle);
448 #define strlcpy gitstrlcpy
449 extern size_t gitstrlcpy(char *, const char *, size_t);
453 #define strtoumax gitstrtoumax
454 extern uintmax_t gitstrtoumax(const char *, char **, int);
455 #define strtoimax gitstrtoimax
456 extern intmax_t gitstrtoimax(const char *, char **, int);
460 #define hstrerror githstrerror
461 extern const char *githstrerror(int herror);
465 #define memmem gitmemmem
466 void *gitmemmem(const void *haystack, size_t haystacklen,
467 const void *needle, size_t needlelen);
470 #ifdef NO_GETPAGESIZE
471 #define getpagesize() sysconf(_SC_PAGESIZE)
474 #ifdef FREAD_READS_DIRECTORIES
478 #define fopen(a,b) git_fopen(a,b)
479 extern FILE *git_fopen(const char*, const char*);
482 #ifdef SNPRINTF_RETURNS_BOGUS
486 #define snprintf git_snprintf
487 extern int git_snprintf(char *str, size_t maxsize,
488 const char *format, ...);
492 #define vsnprintf git_vsnprintf
493 extern int git_vsnprintf(char *str, size_t maxsize,
494 const char *format, va_list ap);
497 #ifdef __GLIBC_PREREQ
498 #if __GLIBC_PREREQ(2, 1)
499 #define HAVE_STRCHRNUL
504 #ifndef HAVE_STRCHRNUL
505 #define strchrnul gitstrchrnul
506 static inline char *gitstrchrnul(const char *s, int c)
508 while (*s && *s != c)
515 #define mempcpy gitmempcpy
516 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
518 return (char *)memcpy(dest, src, n) + n;
523 int inet_pton(int af, const char *src, void *dst);
527 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
530 extern void release_pack_memory(size_t);
532 typedef void (*try_to_free_t)(size_t);
533 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
535 extern char *xstrdup(const char *str);
536 extern void *xmalloc(size_t size);
537 extern void *xmallocz(size_t size);
538 extern void *xmemdupz(const void *data, size_t len);
539 extern char *xstrndup(const char *str, size_t len);
540 extern void *xrealloc(void *ptr, size_t size);
541 extern void *xcalloc(size_t nmemb, size_t size);
542 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
543 extern ssize_t xread(int fd, void *buf, size_t len);
544 extern ssize_t xwrite(int fd, const void *buf, size_t len);
545 extern int xdup(int fd);
546 extern FILE *xfdopen(int fd, const char *mode);
547 extern int xmkstemp(char *template);
548 extern int xmkstemp_mode(char *template, int mode);
549 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
550 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
552 static inline size_t xsize_t(off_t len)
554 if (len > (size_t) len)
555 die("Cannot handle files this big");
559 static inline int has_extension(const char *filename, const char *ext)
561 size_t len = strlen(filename);
562 size_t extlen = strlen(ext);
563 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
566 /* in ctype.c, for kwset users */
567 extern const char tolower_trans_tbl[256];
569 /* Sane ctype - no locale, and works with signed chars */
584 extern const unsigned char sane_ctype[256];
585 #define GIT_SPACE 0x01
586 #define GIT_DIGIT 0x02
587 #define GIT_ALPHA 0x04
588 #define GIT_GLOB_SPECIAL 0x08
589 #define GIT_REGEX_SPECIAL 0x10
590 #define GIT_PATHSPEC_MAGIC 0x20
591 #define GIT_CNTRL 0x40
592 #define GIT_PUNCT 0x80
593 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
594 #define isascii(x) (((x) & ~0x7f) == 0)
595 #define isspace(x) sane_istest(x,GIT_SPACE)
596 #define isdigit(x) sane_istest(x,GIT_DIGIT)
597 #define isalpha(x) sane_istest(x,GIT_ALPHA)
598 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
599 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
600 #define islower(x) sane_iscase(x, 1)
601 #define isupper(x) sane_iscase(x, 0)
602 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
603 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
604 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
605 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
606 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
607 #define isxdigit(x) (hexval_table[x] != -1)
608 #define tolower(x) sane_case((unsigned char)(x), 0x20)
609 #define toupper(x) sane_case((unsigned char)(x), 0)
610 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
612 static inline int sane_case(int x, int high)
614 if (sane_istest(x, GIT_ALPHA))
615 x = (x & ~0x20) | high;
619 static inline int sane_iscase(int x, int is_lower)
621 if (!sane_istest(x, GIT_ALPHA))
625 return (x & 0x20) != 0;
627 return (x & 0x20) == 0;
630 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
636 ul = strtoul(s, &p, base);
637 if (errno || *p || p == s || (unsigned int) ul != ul)
643 static inline int strtol_i(char const *s, int base, int *result)
649 ul = strtol(s, &p, base);
650 if (errno || *p || p == s || (int) ul != ul)
656 #ifdef INTERNAL_QSORT
657 void git_qsort(void *base, size_t nmemb, size_t size,
658 int(*compar)(const void *, const void *));
659 #define qsort git_qsort
662 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
663 # define FORCE_DIR_SET_GID S_ISGID
665 # define FORCE_DIR_SET_GID 0
670 #define ST_CTIME_NSEC(st) 0
671 #define ST_MTIME_NSEC(st) 0
673 #ifdef USE_ST_TIMESPEC
674 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
675 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
677 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
678 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
682 #ifdef UNRELIABLE_FSTAT
683 #define fstat_is_reliable() 0
685 #define fstat_is_reliable() 1
690 * Since an obvious implementation of va_list would be to make it a
691 * pointer into the stack frame, a simple assignment will work on
692 * many systems. But let's try to be more portable.
695 #define va_copy(dst, src) __va_copy(dst, src)
697 #define va_copy(dst, src) ((dst) = (src))
702 * Preserves errno, prints a message, but gives no warning for ENOENT.
703 * Always returns the return value of unlink(2).
705 int unlink_or_warn(const char *path);
707 * Likewise for rmdir(2).
709 int rmdir_or_warn(const char *path);
711 * Calls the correct function out of {unlink,rmdir}_or_warn based on
712 * the supplied file mode.
714 int remove_or_warn(unsigned int mode, const char *path);
717 * Call access(2), but warn for any error except "missing file"
718 * (ENOENT or ENOTDIR).
720 #define ACCESS_EACCES_OK (1U << 0)
721 int access_or_warn(const char *path, int mode, unsigned flag);
722 int access_or_die(const char *path, int mode, unsigned flag);
724 /* Warn on an inaccessible file that ought to be accessible */
725 void warn_on_inaccessible(const char *path);
727 /* Get the passwd entry for the UID of the current process. */
728 struct passwd *xgetpwuid_self(void);