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 static inline int git_has_dos_drive_prefix(const char *path
)
271 #define has_dos_drive_prefix git_has_dos_drive_prefix
275 static inline int git_is_dir_sep(int c
)
279 #define is_dir_sep git_is_dir_sep
282 #ifndef offset_1st_component
283 static inline int git_offset_1st_component(const char *path
)
285 return is_dir_sep(path
[0]);
287 #define offset_1st_component git_offset_1st_component
290 #ifndef find_last_dir_sep
291 static inline char *git_find_last_dir_sep(const char *path
)
293 return strrchr(path
, '/');
295 #define find_last_dir_sep git_find_last_dir_sep
298 #if defined(__HP_cc) && (__HP_cc >= 61000)
299 #define NORETURN __attribute__((noreturn))
301 #elif defined(__GNUC__) && !defined(NO_NORETURN)
302 #define NORETURN __attribute__((__noreturn__))
303 #define NORETURN_PTR __attribute__((__noreturn__))
304 #elif defined(_MSC_VER)
305 #define NORETURN __declspec(noreturn)
311 #ifndef __attribute__
312 #define __attribute__(x)
317 /* The sentinel attribute is valid from gcc version 4.0 */
318 #if defined(__GNUC__) && (__GNUC__ >= 4)
319 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
321 #define LAST_ARG_MUST_BE_NULL
324 #include "compat/bswap.h"
326 #include "wildmatch.h"
328 /* General helper functions */
329 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
330 extern void vwritef(int fd
, const char *prefix
, const char *err
, va_list params
);
331 extern NORETURN
void usage(const char *err
);
332 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
333 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
334 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
335 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
336 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
339 #ifdef APPLE_COMMON_CRYPTO
340 #include "compat/apple-common-crypto.h"
342 #include <openssl/evp.h>
343 #include <openssl/hmac.h>
344 #endif /* APPLE_COMMON_CRYPTO */
345 #include <openssl/x509v3.h>
346 #endif /* NO_OPENSSL */
349 * Let callers be aware of the constant return value; this can help
350 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
351 * because some compilers may not support variadic macros. Since we're only
352 * trying to help gcc, anyway, it's OK; other compilers will fall back to
353 * using the function as usual.
355 #if defined(__GNUC__)
356 static inline int const_error(void)
360 #define error(...) (error(__VA_ARGS__), const_error())
363 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
364 extern void set_error_routine(void (*routine
)(const char *err
, va_list params
));
365 extern void set_die_is_recursing_routine(int (*routine
)(void));
367 extern int starts_with(const char *str
, const char *prefix
);
370 * If the string "str" begins with the string found in "prefix", return 1.
371 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
372 * the string right after the prefix).
374 * Otherwise, return 0 and leave "out" untouched.
378 * [extract branch name, fail if not a branch]
379 * if (!skip_prefix(ref, "refs/heads/", &branch)
382 * [skip prefix if present, otherwise use whole string]
383 * skip_prefix(name, "refs/heads/", &name);
385 static inline int skip_prefix(const char *str
, const char *prefix
,
393 } while (*str
++ == *prefix
++);
398 * If buf ends with suffix, return 1 and subtract the length of the suffix
399 * from *len. Otherwise, return 0 and leave *len untouched.
401 static inline int strip_suffix_mem(const char *buf
, size_t *len
,
404 size_t suflen
= strlen(suffix
);
405 if (*len
< suflen
|| memcmp(buf
+ (*len
- suflen
), suffix
, suflen
))
412 * If str ends with suffix, return 1 and set *len to the size of the string
413 * without the suffix. Otherwise, return 0 and set *len to the size of the
416 * Note that we do _not_ NUL-terminate str to the new length.
418 static inline int strip_suffix(const char *str
, const char *suffix
, size_t *len
)
421 return strip_suffix_mem(str
, len
, suffix
);
424 static inline int ends_with(const char *str
, const char *suffix
)
427 return strip_suffix(str
, suffix
, &len
);
430 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
435 #define MAP_PRIVATE 1
438 #define mmap git_mmap
439 #define munmap git_munmap
440 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
441 extern int git_munmap(void *start
, size_t length
);
443 #else /* NO_MMAP || USE_WIN32_MMAP */
445 #include <sys/mman.h>
447 #endif /* NO_MMAP || USE_WIN32_MMAP */
451 /* This value must be multiple of (pagesize * 2) */
452 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
456 /* This value must be multiple of (pagesize * 2) */
457 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
458 (sizeof(void*) >= 8 \
459 ? 1 * 1024 * 1024 * 1024 \
465 #define MAP_FAILED ((void *)-1)
468 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
469 #define on_disk_bytes(st) ((st).st_size)
471 #define on_disk_bytes(st) ((st).st_blocks * 512)
474 #define DEFAULT_PACKED_GIT_LIMIT \
475 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
478 #define pread git_pread
479 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
482 * Forward decl that will remind us if its twin in cache.h changes.
483 * This function is used in compat/pread.c. But we can't include
486 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
489 #define setenv gitsetenv
490 extern int gitsetenv(const char *, const char *, int);
494 #define mkdtemp gitmkdtemp
495 extern char *gitmkdtemp(char *);
499 #define mkstemps gitmkstemps
500 extern int gitmkstemps(char *, int);
504 #define unsetenv gitunsetenv
505 extern void gitunsetenv(const char *);
509 #define strcasestr gitstrcasestr
510 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
514 #define strlcpy gitstrlcpy
515 extern size_t gitstrlcpy(char *, const char *, size_t);
519 #define strtoumax gitstrtoumax
520 extern uintmax_t gitstrtoumax(const char *, char **, int);
521 #define strtoimax gitstrtoimax
522 extern intmax_t gitstrtoimax(const char *, char **, int);
526 #define hstrerror githstrerror
527 extern const char *githstrerror(int herror
);
531 #define memmem gitmemmem
532 void *gitmemmem(const void *haystack
, size_t haystacklen
,
533 const void *needle
, size_t needlelen
);
536 #ifdef NO_GETPAGESIZE
537 #define getpagesize() sysconf(_SC_PAGESIZE)
540 #ifdef FREAD_READS_DIRECTORIES
544 #define fopen(a,b) git_fopen(a,b)
545 extern FILE *git_fopen(const char*, const char*);
548 #ifdef SNPRINTF_RETURNS_BOGUS
552 #define snprintf git_snprintf
553 extern int git_snprintf(char *str
, size_t maxsize
,
554 const char *format
, ...);
558 #define vsnprintf git_vsnprintf
559 extern int git_vsnprintf(char *str
, size_t maxsize
,
560 const char *format
, va_list ap
);
563 #ifdef __GLIBC_PREREQ
564 #if __GLIBC_PREREQ(2, 1)
565 #define HAVE_STRCHRNUL
570 #ifndef HAVE_STRCHRNUL
571 #define strchrnul gitstrchrnul
572 static inline char *gitstrchrnul(const char *s
, int c
)
574 while (*s
&& *s
!= c
)
581 #define mempcpy gitmempcpy
582 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
584 return (char *)memcpy(dest
, src
, n
) + n
;
589 int inet_pton(int af
, const char *src
, void *dst
);
593 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
596 extern void release_pack_memory(size_t);
598 typedef void (*try_to_free_t
)(size_t);
599 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
603 # define xalloca(size) (alloca(size))
604 # define xalloca_free(p) do {} while (0)
606 # define xalloca(size) (xmalloc(size))
607 # define xalloca_free(p) (free(p))
609 extern char *xstrdup(const char *str
);
610 extern void *xmalloc(size_t size
);
611 extern void *xmallocz(size_t size
);
612 extern void *xmallocz_gently(size_t size
);
613 extern void *xmemdupz(const void *data
, size_t len
);
614 extern char *xstrndup(const char *str
, size_t len
);
615 extern void *xrealloc(void *ptr
, size_t size
);
616 extern void *xcalloc(size_t nmemb
, size_t size
);
617 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
618 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
619 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
620 extern ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
);
621 extern int xdup(int fd
);
622 extern FILE *xfdopen(int fd
, const char *mode
);
623 extern int xmkstemp(char *template);
624 extern int xmkstemp_mode(char *template, int mode
);
625 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
626 extern int odb_pack_keep(char *name
, size_t namesz
, const unsigned char *sha1
);
627 extern char *xgetcwd(void);
629 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
631 static inline size_t xsize_t(off_t len
)
633 if (len
> (size_t) len
)
634 die("Cannot handle files this big");
638 /* in ctype.c, for kwset users */
639 extern const char tolower_trans_tbl
[256];
641 /* Sane ctype - no locale, and works with signed chars */
656 extern const unsigned char sane_ctype
[256];
657 #define GIT_SPACE 0x01
658 #define GIT_DIGIT 0x02
659 #define GIT_ALPHA 0x04
660 #define GIT_GLOB_SPECIAL 0x08
661 #define GIT_REGEX_SPECIAL 0x10
662 #define GIT_PATHSPEC_MAGIC 0x20
663 #define GIT_CNTRL 0x40
664 #define GIT_PUNCT 0x80
665 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
666 #define isascii(x) (((x) & ~0x7f) == 0)
667 #define isspace(x) sane_istest(x,GIT_SPACE)
668 #define isdigit(x) sane_istest(x,GIT_DIGIT)
669 #define isalpha(x) sane_istest(x,GIT_ALPHA)
670 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
671 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
672 #define islower(x) sane_iscase(x, 1)
673 #define isupper(x) sane_iscase(x, 0)
674 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
675 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
676 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
677 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
678 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
679 #define isxdigit(x) (hexval_table[x] != -1)
680 #define tolower(x) sane_case((unsigned char)(x), 0x20)
681 #define toupper(x) sane_case((unsigned char)(x), 0)
682 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
684 static inline int sane_case(int x
, int high
)
686 if (sane_istest(x
, GIT_ALPHA
))
687 x
= (x
& ~0x20) | high
;
691 static inline int sane_iscase(int x
, int is_lower
)
693 if (!sane_istest(x
, GIT_ALPHA
))
697 return (x
& 0x20) != 0;
699 return (x
& 0x20) == 0;
702 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
708 ul
= strtoul(s
, &p
, base
);
709 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
715 static inline int strtol_i(char const *s
, int base
, int *result
)
721 ul
= strtol(s
, &p
, base
);
722 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
728 #ifdef INTERNAL_QSORT
729 void git_qsort(void *base
, size_t nmemb
, size_t size
,
730 int(*compar
)(const void *, const void *));
731 #define qsort git_qsort
734 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
735 # define FORCE_DIR_SET_GID S_ISGID
737 # define FORCE_DIR_SET_GID 0
742 #define ST_CTIME_NSEC(st) 0
743 #define ST_MTIME_NSEC(st) 0
745 #ifdef USE_ST_TIMESPEC
746 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
747 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
749 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
750 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
754 #ifdef UNRELIABLE_FSTAT
755 #define fstat_is_reliable() 0
757 #define fstat_is_reliable() 1
762 * Since an obvious implementation of va_list would be to make it a
763 * pointer into the stack frame, a simple assignment will work on
764 * many systems. But let's try to be more portable.
767 #define va_copy(dst, src) __va_copy(dst, src)
769 #define va_copy(dst, src) ((dst) = (src))
773 #if defined(__GNUC__) || (_MSC_VER >= 1400)
774 #define HAVE_VARIADIC_MACROS 1
778 * Preserves errno, prints a message, but gives no warning for ENOENT.
779 * Always returns the return value of unlink(2).
781 int unlink_or_warn(const char *path
);
783 * Likewise for rmdir(2).
785 int rmdir_or_warn(const char *path
);
787 * Calls the correct function out of {unlink,rmdir}_or_warn based on
788 * the supplied file mode.
790 int remove_or_warn(unsigned int mode
, const char *path
);
793 * Call access(2), but warn for any error except "missing file"
794 * (ENOENT or ENOTDIR).
796 #define ACCESS_EACCES_OK (1U << 0)
797 int access_or_warn(const char *path
, int mode
, unsigned flag
);
798 int access_or_die(const char *path
, int mode
, unsigned flag
);
800 /* Warn on an inaccessible file that ought to be accessible */
801 void warn_on_inaccessible(const char *path
);
803 /* Get the passwd entry for the UID of the current process. */
804 struct passwd
*xgetpwuid_self(void);
806 #ifdef GMTIME_UNRELIABLE_ERRORS
807 struct tm
*git_gmtime(const time_t *);
808 struct tm
*git_gmtime_r(const time_t *, struct tm
*);
809 #define gmtime git_gmtime
810 #define gmtime_r git_gmtime_r