1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #if __STDC_VERSION__ - 0 < 199901L
6 * Git is in a testing period for mandatory C99 support in the compiler. If
7 * your compiler is reasonably recent, you can try to enable C99 support (or,
8 * for MSVC, C11 support). If you encounter a problem and can't enable C99
9 * support with your compiler (such as with "-std=gnu99") and don't have access
10 * to one with this support, such as GCC or Clang, you can remove this #if
11 * directive, but please report the details of your system to
12 * git@vger.kernel.org.
14 #error "Required C99 support is in a test phase. Please see git-compat-util.h for more details."
17 #ifdef USE_MSVC_CRTDBG
19 * For these to work they must appear very early in each
20 * file -- before most of the standard header files.
26 #define _FILE_OFFSET_BITS 64
29 /* Derived from Linux "Features Test Macro" header
30 * Convenience macros to test the versions of gcc (or
31 * a compatible compiler).
33 * #if GIT_GNUC_PREREQ (2,8)
34 * ... code requiring gcc 2.8 or later ...
37 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
38 # define GIT_GNUC_PREREQ(maj, min) \
39 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
41 #define GIT_GNUC_PREREQ(maj, min) 0
47 * See if our compiler is known to support flexible array members.
51 * Check vendor specific quirks first, before checking the
52 * __STDC_VERSION__, as vendor compilers can lie and we need to be
53 * able to work them around. Note that by not defining FLEX_ARRAY
54 * here, we can fall back to use the "safer but a bit wasteful" one
57 #if defined(__SUNPRO_C) && (__SUNPRO_C <= 0x580)
58 #elif defined(__GNUC__)
60 # define FLEX_ARRAY /* empty */
62 # define FLEX_ARRAY 0 /* older GNU extension */
64 #elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
65 # define FLEX_ARRAY /* empty */
69 * Otherwise, default to safer but a bit wasteful traditional style
78 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
79 * @cond: the compile-time condition which must be true.
81 * Your compile will fail if the condition isn't true, or can't be evaluated
82 * by the compiler. This can be used in an expression: its value is "0".
85 * #define foo_to_char(foo) \
87 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
89 #define BUILD_ASSERT_OR_ZERO(cond) \
90 (sizeof(char [1 - 2*!(cond)]) - 1)
92 #if GIT_GNUC_PREREQ(3, 1)
93 /* &arr[0] degrades to a pointer: a different type from an array */
94 # define BARF_UNLESS_AN_ARRAY(arr) \
95 BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
96 __typeof__(&(arr)[0])))
98 # define BARF_UNLESS_AN_ARRAY(arr) 0
101 * ARRAY_SIZE - get the number of elements in a visible array
102 * @x: the array whose size you want.
104 * This does not work on pointers, or arrays declared as [], or
105 * function parameters. With correct compiler support, such usage
106 * will cause a build error (see the build_assert_or_zero macro).
108 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
110 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
112 #define maximum_signed_value_of_type(a) \
113 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
115 #define maximum_unsigned_value_of_type(a) \
116 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
119 * Signed integer overflow is undefined in C, so here's a helper macro
120 * to detect if the sum of two integers will overflow.
122 * Requires: a >= 0, typeof(a) equals typeof(b)
124 #define signed_add_overflows(a, b) \
125 ((b) > maximum_signed_value_of_type(a) - (a))
127 #define unsigned_add_overflows(a, b) \
128 ((b) > maximum_unsigned_value_of_type(a) - (a))
131 * Returns true if the multiplication of "a" and "b" will
132 * overflow. The types of "a" and "b" must match and must be unsigned.
133 * Note that this macro evaluates "a" twice!
135 #define unsigned_mult_overflows(a, b) \
136 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
139 * Returns true if the left shift of "a" by "shift" bits will
140 * overflow. The type of "a" must be unsigned.
142 #define unsigned_left_shift_overflows(a, shift) \
143 ((shift) < bitsizeof(a) && \
144 (a) > maximum_unsigned_value_of_type(a) >> (shift))
147 #define TYPEOF(x) (__typeof__(x))
152 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
153 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
155 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
157 /* Approximation of the length of the decimal representation of this type. */
158 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
161 #define _POSIX_C_SOURCE 1
162 #elif defined(__sun__)
164 * On Solaris, when _XOPEN_EXTENDED is set, its header file
165 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
166 * setting to say we are XPG5 or XPG6. Also on Solaris,
167 * XPG6 programs must be compiled with a c99 compiler, while
168 * non XPG6 programs must be compiled with a pre-c99 compiler.
170 # if __STDC_VERSION__ - 0 >= 199901L
171 # define _XOPEN_SOURCE 600
173 # define _XOPEN_SOURCE 500
175 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
176 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
177 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
179 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
180 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
182 #define _ALL_SOURCE 1
183 #define _GNU_SOURCE 1
184 #define _BSD_SOURCE 1
185 #define _DEFAULT_SOURCE 1
186 #define _NETBSD_SOURCE 1
187 #define _SGI_SOURCE 1
189 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
190 # if !defined(_WIN32_WINNT)
191 # define _WIN32_WINNT 0x0600
193 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
194 #include <winsock2.h>
195 #ifndef NO_UNIX_SOCKETS
199 #define GIT_WINDOWS_NATIVE
200 #ifdef HAVE_RTLGENRANDOM
201 /* This is required to get access to RtlGenRandom. */
202 #define SystemFunction036 NTAPI SystemFunction036
203 #include <NTSecAPI.h>
204 #undef SystemFunction036
210 #include <sys/stat.h>
216 #ifdef HAVE_STRINGS_H
217 #include <strings.h> /* for strcasecmp() */
221 #ifdef NEEDS_SYS_PARAM_H
222 #include <sys/param.h>
224 #include <sys/types.h>
226 #include <sys/time.h>
233 #if !defined(NO_POLL_H)
235 #elif !defined(NO_SYS_POLL_H)
236 #include <sys/poll.h>
238 /* Pull the compat stuff */
241 #ifdef HAVE_BSD_SYSCTL
242 #include <sys/sysctl.h>
245 #if defined(__CYGWIN__)
246 #include "compat/win32/path-utils.h"
248 #if defined(__MINGW32__)
249 /* pull in Windows compatibility stuff */
250 #include "compat/win32/path-utils.h"
251 #include "compat/mingw.h"
252 #elif defined(_MSC_VER)
253 #include "compat/win32/path-utils.h"
254 #include "compat/msvc.h"
256 #include <sys/utsname.h>
257 #include <sys/wait.h>
258 #include <sys/resource.h>
259 #include <sys/socket.h>
260 #include <sys/ioctl.h>
262 #ifndef NO_SYS_SELECT_H
263 #include <sys/select.h>
265 #include <netinet/in.h>
266 #include <netinet/tcp.h>
267 #include <arpa/inet.h>
271 #ifndef NO_INTTYPES_H
272 #include <inttypes.h>
276 #ifdef HAVE_ARC4RANDOM_LIBBSD
277 #include <bsd/stdlib.h>
279 #ifdef HAVE_GETRANDOM
280 #include <sys/random.h>
284 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
285 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
286 * while on IP16 and IP16L32 it is "int" (resp. "short")
287 * Size needs to match (or exceed) 'sizeof(void *)'.
288 * We can't take "long long" here as not everybody has it.
290 typedef long intptr_t;
291 typedef unsigned long uintptr_t;
293 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
295 #define _ALL_SOURCE 1
298 /* used on Mac OS X */
299 #ifdef PRECOMPOSE_UNICODE
300 #include "compat/precompose_utf8.h"
302 static inline const char *precompose_argv_prefix(int argc
, const char **argv
, const char *prefix
)
306 static inline const char *precompose_string_if_needed(const char *in
)
311 #define probe_utf8_pathname_composition()
314 #ifdef MKDIR_WO_TRAILING_SLASH
315 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
316 int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
319 #ifdef NO_STRUCT_ITIMERVAL
321 struct timeval it_interval
;
322 struct timeval it_value
;
327 static inline int setitimer(int which
, const struct itimerval
*value
, struct itimerval
*newvalue
) {
328 return 0; /* pretend success */
335 #define basename gitbasename
336 char *gitbasename(char *);
337 #define dirname gitdirname
338 char *gitdirname(char *);
347 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
348 #include <AvailabilityMacros.h>
349 #undef DEPRECATED_ATTRIBUTE
350 #define DEPRECATED_ATTRIBUTE
351 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
353 #include <openssl/ssl.h>
354 #include <openssl/err.h>
358 # include <sys/sysinfo.h>
361 /* On most systems <netdb.h> would have given us this, but
362 * not on some systems (e.g. z/OS).
365 #define NI_MAXHOST 1025
369 #define NI_MAXSERV 32
372 /* On most systems <limits.h> would have given us this, but
373 * not on some systems (e.g. GNU/Hurd).
376 #define PATH_MAX 4096
379 typedef uintmax_t timestamp_t
;
380 #define PRItime PRIuMAX
381 #define parse_timestamp strtoumax
382 #define TIME_MAX UINTMAX_MAX
392 #ifndef _PATH_DEFPATH
393 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
396 #ifndef platform_core_config
397 static inline int noop_core_config(const char *var
, const char *value
, void *cb
)
401 #define platform_core_config noop_core_config
404 int lstat_cache_aware_rmdir(const char *path
);
405 #if !defined(__MINGW32__) && !defined(_MSC_VER)
406 #define rmdir lstat_cache_aware_rmdir
409 #ifndef has_dos_drive_prefix
410 static inline int git_has_dos_drive_prefix(const char *path
)
414 #define has_dos_drive_prefix git_has_dos_drive_prefix
417 #ifndef skip_dos_drive_prefix
418 static inline int git_skip_dos_drive_prefix(char **path
)
422 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
426 static inline int git_is_dir_sep(int c
)
430 #define is_dir_sep git_is_dir_sep
433 #ifndef offset_1st_component
434 static inline int git_offset_1st_component(const char *path
)
436 return is_dir_sep(path
[0]);
438 #define offset_1st_component git_offset_1st_component
441 #ifndef is_valid_path
442 #define is_valid_path(path) 1
445 #ifndef find_last_dir_sep
446 static inline char *git_find_last_dir_sep(const char *path
)
448 return strrchr(path
, '/');
450 #define find_last_dir_sep git_find_last_dir_sep
454 static inline int git_has_dir_sep(const char *path
)
456 return !!strchr(path
, '/');
458 #define has_dir_sep(path) git_has_dir_sep(path)
461 #ifndef query_user_email
462 #define query_user_email() NULL
466 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
467 #include <floss.h(floss_getpwuid)>
470 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
471 * known, by detective work using kill -l as a list is all signals
472 * instead of signal.h where it should be.
478 #if defined(__HP_cc) && (__HP_cc >= 61000)
479 #define NORETURN __attribute__((noreturn))
481 #elif defined(__GNUC__) && !defined(NO_NORETURN)
482 #define NORETURN __attribute__((__noreturn__))
483 #define NORETURN_PTR __attribute__((__noreturn__))
484 #elif defined(_MSC_VER)
485 #define NORETURN __declspec(noreturn)
491 #ifndef __attribute__
492 #define __attribute__(x)
497 /* The sentinel attribute is valid from gcc version 4.0 */
498 #if defined(__GNUC__) && (__GNUC__ >= 4)
499 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
501 #define LAST_ARG_MUST_BE_NULL
504 #define MAYBE_UNUSED __attribute__((__unused__))
506 #include "compat/bswap.h"
508 #include "wildmatch.h"
512 /* General helper functions */
513 NORETURN
void usage(const char *err
);
514 NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
515 NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
516 NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
517 int die_message(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
518 int die_message_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
519 int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
520 int error_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
521 void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
522 void warning_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
525 #ifdef APPLE_COMMON_CRYPTO
526 #include "compat/apple-common-crypto.h"
528 #include <openssl/evp.h>
529 #include <openssl/hmac.h>
530 #endif /* APPLE_COMMON_CRYPTO */
531 #include <openssl/x509v3.h>
532 #endif /* NO_OPENSSL */
535 * Let callers be aware of the constant return value; this can help
536 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
537 * because other compilers may be confused by this.
539 #if defined(__GNUC__)
540 static inline int const_error(void)
544 #define error(...) (error(__VA_ARGS__), const_error())
545 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
548 typedef void (*report_fn
)(const char *, va_list params
);
550 void set_die_routine(NORETURN_PTR report_fn routine
);
551 report_fn
get_die_message_routine(void);
552 void set_error_routine(report_fn routine
);
553 report_fn
get_error_routine(void);
554 void set_warn_routine(report_fn routine
);
555 report_fn
get_warn_routine(void);
556 void set_die_is_recursing_routine(int (*routine
)(void));
558 int starts_with(const char *str
, const char *prefix
);
559 int istarts_with(const char *str
, const char *prefix
);
562 * If the string "str" begins with the string found in "prefix", return 1.
563 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
564 * the string right after the prefix).
566 * Otherwise, return 0 and leave "out" untouched.
570 * [extract branch name, fail if not a branch]
571 * if (!skip_prefix(ref, "refs/heads/", &branch)
574 * [skip prefix if present, otherwise use whole string]
575 * skip_prefix(name, "refs/heads/", &name);
577 static inline int skip_prefix(const char *str
, const char *prefix
,
585 } while (*str
++ == *prefix
++);
590 * If the string "str" is the same as the string in "prefix", then the "arg"
591 * parameter is set to the "def" parameter and 1 is returned.
592 * If the string "str" begins with the string found in "prefix" and then a
593 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
594 * (i.e., to the point in the string right after the prefix and the "=" sign),
597 * Otherwise, return 0 and leave "arg" untouched.
599 * When we accept both a "--key" and a "--key=<val>" option, this function
600 * can be used instead of !strcmp(arg, "--key") and then
601 * skip_prefix(arg, "--key=", &arg) to parse such an option.
603 int skip_to_optional_arg_default(const char *str
, const char *prefix
,
604 const char **arg
, const char *def
);
606 static inline int skip_to_optional_arg(const char *str
, const char *prefix
,
609 return skip_to_optional_arg_default(str
, prefix
, arg
, "");
613 * Like skip_prefix, but promises never to read past "len" bytes of the input
614 * buffer, and returns the remaining number of bytes in "out" via "outlen".
616 static inline int skip_prefix_mem(const char *buf
, size_t len
,
618 const char **out
, size_t *outlen
)
620 size_t prefix_len
= strlen(prefix
);
621 if (prefix_len
<= len
&& !memcmp(buf
, prefix
, prefix_len
)) {
622 *out
= buf
+ prefix_len
;
623 *outlen
= len
- prefix_len
;
630 * If buf ends with suffix, return 1 and subtract the length of the suffix
631 * from *len. Otherwise, return 0 and leave *len untouched.
633 static inline int strip_suffix_mem(const char *buf
, size_t *len
,
636 size_t suflen
= strlen(suffix
);
637 if (*len
< suflen
|| memcmp(buf
+ (*len
- suflen
), suffix
, suflen
))
644 * If str ends with suffix, return 1 and set *len to the size of the string
645 * without the suffix. Otherwise, return 0 and set *len to the size of the
648 * Note that we do _not_ NUL-terminate str to the new length.
650 static inline int strip_suffix(const char *str
, const char *suffix
, size_t *len
)
653 return strip_suffix_mem(str
, len
, suffix
);
656 static inline int ends_with(const char *str
, const char *suffix
)
659 return strip_suffix(str
, suffix
, &len
);
662 #define SWAP(a, b) do { \
663 void *_swap_a_ptr = &(a); \
664 void *_swap_b_ptr = &(b); \
665 unsigned char _swap_buffer[sizeof(a)]; \
666 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
667 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
668 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
669 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
672 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
677 #define MAP_PRIVATE 1
680 #define mmap git_mmap
681 #define munmap git_munmap
682 void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
683 int git_munmap(void *start
, size_t length
);
685 #else /* NO_MMAP || USE_WIN32_MMAP */
687 #include <sys/mman.h>
689 #endif /* NO_MMAP || USE_WIN32_MMAP */
693 /* This value must be multiple of (pagesize * 2) */
694 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
698 /* This value must be multiple of (pagesize * 2) */
699 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
700 (sizeof(void*) >= 8 \
701 ? 1 * 1024 * 1024 * 1024 \
707 #define MAP_FAILED ((void *)-1)
710 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
711 #define on_disk_bytes(st) ((st).st_size)
713 #define on_disk_bytes(st) ((st).st_blocks * 512)
716 #ifdef NEEDS_MODE_TRANSLATION
725 #define S_IFMT 0170000
726 #define S_IFREG 0100000
727 #define S_IFDIR 0040000
728 #define S_IFLNK 0120000
729 #define S_IFBLK 0060000
730 #define S_IFCHR 0020000
731 #define S_IFIFO 0010000
732 #define S_IFSOCK 0140000
736 #define stat(path, buf) git_stat(path, buf)
737 int git_stat(const char *, struct stat
*);
741 #define fstat(fd, buf) git_fstat(fd, buf)
742 int git_fstat(int, struct stat
*);
746 #define lstat(path, buf) git_lstat(path, buf)
747 int git_lstat(const char *, struct stat
*);
750 #define DEFAULT_PACKED_GIT_LIMIT \
751 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
754 #define pread git_pread
755 ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
758 * Forward decl that will remind us if its twin in cache.h changes.
759 * This function is used in compat/pread.c. But we can't include
762 ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
765 #define setenv gitsetenv
766 int gitsetenv(const char *, const char *, int);
770 #define mkdtemp gitmkdtemp
771 char *gitmkdtemp(char *);
775 #define unsetenv gitunsetenv
776 int gitunsetenv(const char *);
780 #define strcasestr gitstrcasestr
781 char *gitstrcasestr(const char *haystack
, const char *needle
);
785 #define strlcpy gitstrlcpy
786 size_t gitstrlcpy(char *, const char *, size_t);
790 #define strtoumax gitstrtoumax
791 uintmax_t gitstrtoumax(const char *, char **, int);
792 #define strtoimax gitstrtoimax
793 intmax_t gitstrtoimax(const char *, char **, int);
797 #define hstrerror githstrerror
798 const char *githstrerror(int herror
);
802 #define memmem gitmemmem
803 void *gitmemmem(const void *haystack
, size_t haystacklen
,
804 const void *needle
, size_t needlelen
);
807 #ifdef OVERRIDE_STRDUP
811 #define strdup gitstrdup
812 char *gitstrdup(const char *s
);
815 #ifdef NO_GETPAGESIZE
816 #define getpagesize() sysconf(_SC_PAGESIZE)
823 #ifdef FREAD_READS_DIRECTORIES
824 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
828 # define fopen(a,b) git_fopen(a,b)
830 FILE *git_fopen(const char*, const char*);
833 #ifdef SNPRINTF_RETURNS_BOGUS
837 #define snprintf git_snprintf
838 int git_snprintf(char *str
, size_t maxsize
,
839 const char *format
, ...);
843 #define vsnprintf git_vsnprintf
844 int git_vsnprintf(char *str
, size_t maxsize
,
845 const char *format
, va_list ap
);
848 #ifdef OPEN_RETURNS_EINTR
850 #define open git_open_with_retry
851 int git_open_with_retry(const char *path
, int flag
, ...);
854 #ifdef __GLIBC_PREREQ
855 #if __GLIBC_PREREQ(2, 1)
856 #define HAVE_STRCHRNUL
860 #ifndef HAVE_STRCHRNUL
861 #define strchrnul gitstrchrnul
862 static inline char *gitstrchrnul(const char *s
, int c
)
864 while (*s
&& *s
!= c
)
871 int inet_pton(int af
, const char *src
, void *dst
);
875 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
879 #define atexit git_atexit
880 int git_atexit(void (*handler
)(void));
883 static inline size_t st_add(size_t a
, size_t b
)
885 if (unsigned_add_overflows(a
, b
))
886 die("size_t overflow: %"PRIuMAX
" + %"PRIuMAX
,
887 (uintmax_t)a
, (uintmax_t)b
);
890 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
891 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
893 static inline size_t st_mult(size_t a
, size_t b
)
895 if (unsigned_mult_overflows(a
, b
))
896 die("size_t overflow: %"PRIuMAX
" * %"PRIuMAX
,
897 (uintmax_t)a
, (uintmax_t)b
);
901 static inline size_t st_sub(size_t a
, size_t b
)
904 die("size_t underflow: %"PRIuMAX
" - %"PRIuMAX
,
905 (uintmax_t)a
, (uintmax_t)b
);
909 static inline size_t st_left_shift(size_t a
, unsigned shift
)
911 if (unsigned_left_shift_overflows(a
, shift
))
912 die("size_t overflow: %"PRIuMAX
" << %u",
913 (uintmax_t)a
, shift
);
917 static inline unsigned long cast_size_t_to_ulong(size_t a
)
919 if (a
!= (unsigned long)a
)
920 die("object too large to read on this platform: %"
921 PRIuMAX
" is cut off to %lu",
922 (uintmax_t)a
, (unsigned long)a
);
923 return (unsigned long)a
;
928 # define xalloca(size) (alloca(size))
929 # define xalloca_free(p) do {} while (0)
931 # define xalloca(size) (xmalloc(size))
932 # define xalloca_free(p) (free(p))
934 char *xstrdup(const char *str
);
935 void *xmalloc(size_t size
);
936 void *xmallocz(size_t size
);
937 void *xmallocz_gently(size_t size
);
938 void *xmemdupz(const void *data
, size_t len
);
939 char *xstrndup(const char *str
, size_t len
);
940 void *xrealloc(void *ptr
, size_t size
);
941 void *xcalloc(size_t nmemb
, size_t size
);
942 void xsetenv(const char *name
, const char *value
, int overwrite
);
943 void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
944 const char *mmap_os_err(void);
945 void *xmmap_gently(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
946 int xopen(const char *path
, int flags
, ...);
947 ssize_t
xread(int fd
, void *buf
, size_t len
);
948 ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
949 ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
);
951 FILE *xfopen(const char *path
, const char *mode
);
952 FILE *xfdopen(int fd
, const char *mode
);
953 int xmkstemp(char *temp_filename
);
954 int xmkstemp_mode(char *temp_filename
, int mode
);
956 FILE *fopen_for_writing(const char *path
);
957 FILE *fopen_or_warn(const char *path
, const char *mode
);
960 * Like strncmp, but only return zero if s is NUL-terminated and exactly len
961 * characters long. If it is not, consider it greater than t.
963 int xstrncmpz(const char *s
, const char *t
, size_t len
);
966 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
967 * that ptr is used twice, so don't pass e.g. ptr++.
969 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
971 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
972 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
973 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
975 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
976 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
977 static inline void copy_array(void *dst
, const void *src
, size_t n
, size_t size
)
980 memcpy(dst
, src
, st_mult(size
, n
));
983 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
984 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
985 static inline void move_array(void *dst
, const void *src
, size_t n
, size_t size
)
988 memmove(dst
, src
, st_mult(size
, n
));
992 * These functions help you allocate structs with flex arrays, and copy
993 * the data directly into the array. For example, if you had:
997 * char name[FLEX_ARRAY];
1003 * FLEX_ALLOC_MEM(f, name, src, len);
1005 * to allocate a "foo" with the contents of "src" in the "name" field.
1006 * The resulting struct is automatically zero'd, and the flex-array field
1007 * is NUL-terminated (whether the incoming src buffer was or not).
1009 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
1010 * but do want to store a pointer to some extra data in the same allocated
1011 * block. For example, if you have:
1021 * FLEXPTR_ALLOC_STR(f, name, src);
1023 * and "name" will point to a block of memory after the struct, which will be
1024 * freed along with the struct (but the pointer can be repointed anywhere).
1026 * The *_STR variants accept a string parameter rather than a ptr/len
1029 * Note that these macros will evaluate the first parameter multiple
1030 * times, and it must be assignable as an lvalue.
1032 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
1033 size_t flex_array_len_ = (len); \
1034 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1035 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
1037 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
1038 size_t flex_array_len_ = (len); \
1039 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1040 memcpy((x) + 1, (buf), flex_array_len_); \
1041 (x)->ptrname = (void *)((x)+1); \
1043 #define FLEX_ALLOC_STR(x, flexname, str) \
1044 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1045 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1046 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1048 static inline char *xstrdup_or_null(const char *str
)
1050 return str
? xstrdup(str
) : NULL
;
1053 static inline size_t xsize_t(off_t len
)
1055 if (len
< 0 || (uintmax_t) len
> SIZE_MAX
)
1056 die("Cannot handle files this big");
1057 return (size_t) len
;
1060 __attribute__((format (printf
, 3, 4)))
1061 int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...);
1063 #ifndef HOST_NAME_MAX
1064 #define HOST_NAME_MAX 256
1067 int xgethostname(char *buf
, size_t len
);
1069 /* in ctype.c, for kwset users */
1070 extern const unsigned char tolower_trans_tbl
[256];
1072 /* Sane ctype - no locale, and works with signed chars */
1087 extern const unsigned char sane_ctype
[256];
1088 #define GIT_SPACE 0x01
1089 #define GIT_DIGIT 0x02
1090 #define GIT_ALPHA 0x04
1091 #define GIT_GLOB_SPECIAL 0x08
1092 #define GIT_REGEX_SPECIAL 0x10
1093 #define GIT_PATHSPEC_MAGIC 0x20
1094 #define GIT_CNTRL 0x40
1095 #define GIT_PUNCT 0x80
1096 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1097 #define isascii(x) (((x) & ~0x7f) == 0)
1098 #define isspace(x) sane_istest(x,GIT_SPACE)
1099 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1100 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1101 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1102 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1103 #define islower(x) sane_iscase(x, 1)
1104 #define isupper(x) sane_iscase(x, 0)
1105 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1106 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1107 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1108 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1109 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1110 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1111 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1112 #define toupper(x) sane_case((unsigned char)(x), 0)
1113 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1115 static inline int sane_case(int x
, int high
)
1117 if (sane_istest(x
, GIT_ALPHA
))
1118 x
= (x
& ~0x20) | high
;
1122 static inline int sane_iscase(int x
, int is_lower
)
1124 if (!sane_istest(x
, GIT_ALPHA
))
1128 return (x
& 0x20) != 0;
1130 return (x
& 0x20) == 0;
1134 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1135 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1136 * locale-specific conversions).
1138 static inline int skip_iprefix(const char *str
, const char *prefix
,
1146 } while (tolower(*str
++) == tolower(*prefix
++));
1150 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
1156 /* negative values would be accepted by strtoul */
1159 ul
= strtoul(s
, &p
, base
);
1160 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
1166 static inline int strtol_i(char const *s
, int base
, int *result
)
1172 ul
= strtol(s
, &p
, base
);
1173 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
1179 void git_stable_qsort(void *base
, size_t nmemb
, size_t size
,
1180 int(*compar
)(const void *, const void *));
1181 #ifdef INTERNAL_QSORT
1182 #define qsort git_stable_qsort
1185 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1186 static inline void sane_qsort(void *base
, size_t nmemb
, size_t size
,
1187 int(*compar
)(const void *, const void *))
1190 qsort(base
, nmemb
, size
, compar
);
1193 #define STABLE_QSORT(base, n, compar) \
1194 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1196 #ifndef HAVE_ISO_QSORT_S
1197 int git_qsort_s(void *base
, size_t nmemb
, size_t size
,
1198 int (*compar
)(const void *, const void *, void *), void *ctx
);
1199 #define qsort_s git_qsort_s
1202 #define QSORT_S(base, n, compar, ctx) do { \
1203 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1204 BUG("qsort_s() failed"); \
1207 #ifndef REG_STARTEND
1208 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1211 static inline int regexec_buf(const regex_t
*preg
, const char *buf
, size_t size
,
1212 size_t nmatch
, regmatch_t pmatch
[], int eflags
)
1214 assert(nmatch
> 0 && pmatch
);
1215 pmatch
[0].rm_so
= 0;
1216 pmatch
[0].rm_eo
= size
;
1217 return regexec(preg
, buf
, nmatch
, pmatch
, eflags
| REG_STARTEND
);
1220 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1221 # define FORCE_DIR_SET_GID S_ISGID
1223 # define FORCE_DIR_SET_GID 0
1228 #define ST_CTIME_NSEC(st) 0
1229 #define ST_MTIME_NSEC(st) 0
1231 #ifdef USE_ST_TIMESPEC
1232 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1233 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1235 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1236 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1240 #ifdef UNRELIABLE_FSTAT
1241 #define fstat_is_reliable() 0
1243 #define fstat_is_reliable() 1
1248 * Since an obvious implementation of va_list would be to make it a
1249 * pointer into the stack frame, a simple assignment will work on
1250 * many systems. But let's try to be more portable.
1253 #define va_copy(dst, src) __va_copy(dst, src)
1255 #define va_copy(dst, src) ((dst) = (src))
1259 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1260 extern int BUG_exit_code
;
1262 __attribute__((format (printf
, 3, 4))) NORETURN
1263 void BUG_fl(const char *file
, int line
, const char *fmt
, ...);
1264 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1267 * Preserves errno, prints a message, but gives no warning for ENOENT.
1268 * Returns 0 on success, which includes trying to unlink an object that does
1271 int unlink_or_warn(const char *path
);
1273 * Tries to unlink file. Returns 0 if unlink succeeded
1274 * or the file already didn't exist. Returns -1 and
1275 * appends a message to err suitable for
1276 * 'error("%s", err->buf)' on error.
1278 int unlink_or_msg(const char *file
, struct strbuf
*err
);
1280 * Preserves errno, prints a message, but gives no warning for ENOENT.
1281 * Returns 0 on success, which includes trying to remove a directory that does
1284 int rmdir_or_warn(const char *path
);
1286 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1287 * the supplied file mode.
1289 int remove_or_warn(unsigned int mode
, const char *path
);
1292 * Call access(2), but warn for any error except "missing file"
1293 * (ENOENT or ENOTDIR).
1295 #define ACCESS_EACCES_OK (1U << 0)
1296 int access_or_warn(const char *path
, int mode
, unsigned flag
);
1297 int access_or_die(const char *path
, int mode
, unsigned flag
);
1299 /* Warn on an inaccessible file if errno indicates this is an error */
1300 int warn_on_fopen_errors(const char *path
);
1303 * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent
1304 * may be racy. Do not use this as protection against an attacker who can
1305 * simultaneously create paths.
1307 int open_nofollow(const char *path
, int flags
);
1310 # define SHELL_PATH "/bin/sh"
1313 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1314 static inline void flockfile(FILE *fh
)
1318 static inline void funlockfile(FILE *fh
)
1322 #define getc_unlocked(fh) getc(fh)
1325 #ifdef FILENO_IS_A_MACRO
1326 int git_fileno(FILE *stream
);
1327 # ifndef COMPAT_CODE_FILENO
1329 # define fileno(p) git_fileno(p)
1333 #ifdef NEED_ACCESS_ROOT_HANDLER
1334 int git_access(const char *path
, int mode
);
1335 # ifndef COMPAT_CODE_ACCESS
1339 # define access(path, mode) git_access(path, mode)
1344 * Our code often opens a path to an optional file, to work on its
1345 * contents when we can successfully open it. We can ignore a failure
1346 * to open if such an optional file does not exist, but we do want to
1347 * report a failure in opening for other reasons (e.g. we got an I/O
1348 * error, or the file is there, but we lack the permission to open).
1350 * Call this function after seeing an error from open() or fopen() to
1351 * see if the errno indicates a missing file that we can safely ignore.
1353 static inline int is_missing_file_error(int errno_
)
1355 return (errno_
== ENOENT
|| errno_
== ENOTDIR
);
1358 int cmd_main(int, const char **);
1361 * Intercept all calls to exit() and route them to trace2 to
1362 * optionally emit a message before calling the real exit().
1364 int trace2_cmd_exit_fl(const char *file
, int line
, int code
);
1365 #define exit(code) exit(trace2_cmd_exit_fl(__FILE__, __LINE__, (code)))
1368 * You can mark a stack variable with UNLEAK(var) to avoid it being
1369 * reported as a leak by tools like LSAN or valgrind. The argument
1370 * should generally be the variable itself (not its address and not what
1371 * it points to). It's safe to use this on pointers which may already
1372 * have been freed, or on pointers which may still be in use.
1374 * Use this _only_ for a variable that leaks by going out of scope at
1375 * program exit (so only from cmd_* functions or their direct helpers).
1376 * Normal functions, especially those which may be called multiple
1377 * times, should actually free their memory. This is only meant as
1378 * an annotation, and does nothing in non-leak-checking builds.
1380 #ifdef SUPPRESS_ANNOTATED_LEAKS
1381 void unleak_memory(const void *ptr
, size_t len
);
1382 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1384 #define UNLEAK(var) do {} while (0)
1390 #if ZLIB_VERNUM < 0x1290
1392 * This is uncompress2, which is only available in zlib >= 1.2.9
1393 * (released as of early 2017). See compat/zlib-uncompress2.c.
1395 int uncompress2(Bytef
*dest
, uLongf
*destLen
, const Bytef
*source
,
1400 * This include must come after system headers, since it introduces macros that
1401 * replace system names.
1406 * container_of - Get the address of an object containing a field.
1408 * @ptr: pointer to the field.
1409 * @type: type of the object.
1410 * @member: name of the field within the object.
1412 #define container_of(ptr, type, member) \
1413 ((type *) ((char *)(ptr) - offsetof(type, member)))
1416 * helper function for `container_of_or_null' to avoid multiple
1417 * evaluation of @ptr
1419 static inline void *container_of_or_null_offset(void *ptr
, size_t offset
)
1421 return ptr
? (char *)ptr
- offset
: NULL
;
1425 * like `container_of', but allows returned value to be NULL
1427 #define container_of_or_null(ptr, type, member) \
1428 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1431 * like offsetof(), but takes a pointer to a variable of type which
1432 * contains @member, instead of a specified type.
1433 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1436 #if defined(__GNUC__) /* clang sets this, too */
1437 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1438 #else /* !__GNUC__ */
1439 #define OFFSETOF_VAR(ptr, member) \
1440 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1441 #endif /* !__GNUC__ */
1443 void sleep_millisec(int millisec
);
1446 * Generate len bytes from the system cryptographically secure PRNG.
1447 * Returns 0 on success and -1 on error, setting errno. The inability to
1448 * satisfy the full request is an error.
1450 int csprng_bytes(void *buf
, size_t len
);