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
204 #include <sys/stat.h>
210 #ifdef HAVE_STRINGS_H
211 #include <strings.h> /* for strcasecmp() */
215 #ifdef NEEDS_SYS_PARAM_H
216 #include <sys/param.h>
218 #include <sys/types.h>
220 #include <sys/time.h>
227 #if !defined(NO_POLL_H)
229 #elif !defined(NO_SYS_POLL_H)
230 #include <sys/poll.h>
232 /* Pull the compat stuff */
235 #ifdef HAVE_BSD_SYSCTL
236 #include <sys/sysctl.h>
239 #if defined(__CYGWIN__)
240 #include "compat/win32/path-utils.h"
242 #if defined(__MINGW32__)
243 /* pull in Windows compatibility stuff */
244 #include "compat/win32/path-utils.h"
245 #include "compat/mingw.h"
246 #elif defined(_MSC_VER)
247 #include "compat/win32/path-utils.h"
248 #include "compat/msvc.h"
250 #include <sys/utsname.h>
251 #include <sys/wait.h>
252 #include <sys/resource.h>
253 #include <sys/socket.h>
254 #include <sys/ioctl.h>
256 #ifndef NO_SYS_SELECT_H
257 #include <sys/select.h>
259 #include <netinet/in.h>
260 #include <netinet/tcp.h>
261 #include <arpa/inet.h>
265 #ifndef NO_INTTYPES_H
266 #include <inttypes.h>
270 #ifdef HAVE_ARC4RANDOM_LIBBSD
271 #include <bsd/stdlib.h>
273 #ifdef HAVE_GETRANDOM
274 #include <sys/random.h>
278 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
279 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
280 * while on IP16 and IP16L32 it is "int" (resp. "short")
281 * Size needs to match (or exceed) 'sizeof(void *)'.
282 * We can't take "long long" here as not everybody has it.
284 typedef long intptr_t;
285 typedef unsigned long uintptr_t;
287 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
289 #define _ALL_SOURCE 1
292 /* used on Mac OS X */
293 #ifdef PRECOMPOSE_UNICODE
294 #include "compat/precompose_utf8.h"
296 static inline const char *precompose_argv_prefix(int argc
, const char **argv
, const char *prefix
)
300 static inline const char *precompose_string_if_needed(const char *in
)
305 #define probe_utf8_pathname_composition()
308 #ifdef MKDIR_WO_TRAILING_SLASH
309 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
310 int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
313 #ifdef NO_STRUCT_ITIMERVAL
315 struct timeval it_interval
;
316 struct timeval it_value
;
321 static inline int setitimer(int which
, const struct itimerval
*value
, struct itimerval
*newvalue
) {
322 return 0; /* pretend success */
329 #define basename gitbasename
330 char *gitbasename(char *);
331 #define dirname gitdirname
332 char *gitdirname(char *);
341 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
342 #include <AvailabilityMacros.h>
343 #undef DEPRECATED_ATTRIBUTE
344 #define DEPRECATED_ATTRIBUTE
345 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
347 #include <openssl/ssl.h>
348 #include <openssl/err.h>
352 # include <sys/sysinfo.h>
355 /* On most systems <netdb.h> would have given us this, but
356 * not on some systems (e.g. z/OS).
359 #define NI_MAXHOST 1025
363 #define NI_MAXSERV 32
366 /* On most systems <limits.h> would have given us this, but
367 * not on some systems (e.g. GNU/Hurd).
370 #define PATH_MAX 4096
373 typedef uintmax_t timestamp_t
;
374 #define PRItime PRIuMAX
375 #define parse_timestamp strtoumax
376 #define TIME_MAX UINTMAX_MAX
386 #ifndef _PATH_DEFPATH
387 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
390 #ifndef platform_core_config
391 static inline int noop_core_config(const char *var
, const char *value
, void *cb
)
395 #define platform_core_config noop_core_config
398 int lstat_cache_aware_rmdir(const char *path
);
399 #if !defined(__MINGW32__) && !defined(_MSC_VER)
400 #define rmdir lstat_cache_aware_rmdir
403 #ifndef has_dos_drive_prefix
404 static inline int git_has_dos_drive_prefix(const char *path
)
408 #define has_dos_drive_prefix git_has_dos_drive_prefix
411 #ifndef skip_dos_drive_prefix
412 static inline int git_skip_dos_drive_prefix(char **path
)
416 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
420 static inline int git_is_dir_sep(int c
)
424 #define is_dir_sep git_is_dir_sep
427 #ifndef offset_1st_component
428 static inline int git_offset_1st_component(const char *path
)
430 return is_dir_sep(path
[0]);
432 #define offset_1st_component git_offset_1st_component
435 #ifndef is_valid_path
436 #define is_valid_path(path) 1
439 #ifndef find_last_dir_sep
440 static inline char *git_find_last_dir_sep(const char *path
)
442 return strrchr(path
, '/');
444 #define find_last_dir_sep git_find_last_dir_sep
448 static inline int git_has_dir_sep(const char *path
)
450 return !!strchr(path
, '/');
452 #define has_dir_sep(path) git_has_dir_sep(path)
455 #ifndef query_user_email
456 #define query_user_email() NULL
460 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
461 #include <floss.h(floss_getpwuid)>
464 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
465 * known, by detective work using kill -l as a list is all signals
466 * instead of signal.h where it should be.
472 #if defined(__HP_cc) && (__HP_cc >= 61000)
473 #define NORETURN __attribute__((noreturn))
475 #elif defined(__GNUC__) && !defined(NO_NORETURN)
476 #define NORETURN __attribute__((__noreturn__))
477 #define NORETURN_PTR __attribute__((__noreturn__))
478 #elif defined(_MSC_VER)
479 #define NORETURN __declspec(noreturn)
485 #ifndef __attribute__
486 #define __attribute__(x)
491 /* The sentinel attribute is valid from gcc version 4.0 */
492 #if defined(__GNUC__) && (__GNUC__ >= 4)
493 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
495 #define LAST_ARG_MUST_BE_NULL
498 #define MAYBE_UNUSED __attribute__((__unused__))
500 #include "compat/bswap.h"
502 #include "wildmatch.h"
506 /* General helper functions */
507 NORETURN
void usage(const char *err
);
508 NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
509 NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
510 NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
511 int die_message(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
512 int die_message_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
513 int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
514 int error_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
515 void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
516 void warning_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
519 #ifdef APPLE_COMMON_CRYPTO
520 #include "compat/apple-common-crypto.h"
522 #include <openssl/evp.h>
523 #include <openssl/hmac.h>
524 #endif /* APPLE_COMMON_CRYPTO */
525 #include <openssl/x509v3.h>
526 #endif /* NO_OPENSSL */
529 * Let callers be aware of the constant return value; this can help
530 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
531 * because some compilers may not support variadic macros. Since we're only
532 * trying to help gcc, anyway, it's OK; other compilers will fall back to
533 * using the function as usual.
535 #if defined(__GNUC__)
536 static inline int const_error(void)
540 #define error(...) (error(__VA_ARGS__), const_error())
541 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
544 typedef void (*report_fn
)(const char *, va_list params
);
546 void set_die_routine(NORETURN_PTR report_fn routine
);
547 report_fn
get_die_message_routine(void);
548 void set_error_routine(report_fn routine
);
549 report_fn
get_error_routine(void);
550 void set_warn_routine(report_fn routine
);
551 report_fn
get_warn_routine(void);
552 void set_die_is_recursing_routine(int (*routine
)(void));
554 int starts_with(const char *str
, const char *prefix
);
555 int istarts_with(const char *str
, const char *prefix
);
558 * If the string "str" begins with the string found in "prefix", return 1.
559 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
560 * the string right after the prefix).
562 * Otherwise, return 0 and leave "out" untouched.
566 * [extract branch name, fail if not a branch]
567 * if (!skip_prefix(ref, "refs/heads/", &branch)
570 * [skip prefix if present, otherwise use whole string]
571 * skip_prefix(name, "refs/heads/", &name);
573 static inline int skip_prefix(const char *str
, const char *prefix
,
581 } while (*str
++ == *prefix
++);
586 * If the string "str" is the same as the string in "prefix", then the "arg"
587 * parameter is set to the "def" parameter and 1 is returned.
588 * If the string "str" begins with the string found in "prefix" and then a
589 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
590 * (i.e., to the point in the string right after the prefix and the "=" sign),
593 * Otherwise, return 0 and leave "arg" untouched.
595 * When we accept both a "--key" and a "--key=<val>" option, this function
596 * can be used instead of !strcmp(arg, "--key") and then
597 * skip_prefix(arg, "--key=", &arg) to parse such an option.
599 int skip_to_optional_arg_default(const char *str
, const char *prefix
,
600 const char **arg
, const char *def
);
602 static inline int skip_to_optional_arg(const char *str
, const char *prefix
,
605 return skip_to_optional_arg_default(str
, prefix
, arg
, "");
609 * Like skip_prefix, but promises never to read past "len" bytes of the input
610 * buffer, and returns the remaining number of bytes in "out" via "outlen".
612 static inline int skip_prefix_mem(const char *buf
, size_t len
,
614 const char **out
, size_t *outlen
)
616 size_t prefix_len
= strlen(prefix
);
617 if (prefix_len
<= len
&& !memcmp(buf
, prefix
, prefix_len
)) {
618 *out
= buf
+ prefix_len
;
619 *outlen
= len
- prefix_len
;
626 * If buf ends with suffix, return 1 and subtract the length of the suffix
627 * from *len. Otherwise, return 0 and leave *len untouched.
629 static inline int strip_suffix_mem(const char *buf
, size_t *len
,
632 size_t suflen
= strlen(suffix
);
633 if (*len
< suflen
|| memcmp(buf
+ (*len
- suflen
), suffix
, suflen
))
640 * If str ends with suffix, return 1 and set *len to the size of the string
641 * without the suffix. Otherwise, return 0 and set *len to the size of the
644 * Note that we do _not_ NUL-terminate str to the new length.
646 static inline int strip_suffix(const char *str
, const char *suffix
, size_t *len
)
649 return strip_suffix_mem(str
, len
, suffix
);
652 static inline int ends_with(const char *str
, const char *suffix
)
655 return strip_suffix(str
, suffix
, &len
);
658 #define SWAP(a, b) do { \
659 void *_swap_a_ptr = &(a); \
660 void *_swap_b_ptr = &(b); \
661 unsigned char _swap_buffer[sizeof(a)]; \
662 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
663 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
664 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
665 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
668 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
673 #define MAP_PRIVATE 1
676 #define mmap git_mmap
677 #define munmap git_munmap
678 void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
679 int git_munmap(void *start
, size_t length
);
681 #else /* NO_MMAP || USE_WIN32_MMAP */
683 #include <sys/mman.h>
685 #endif /* NO_MMAP || USE_WIN32_MMAP */
689 /* This value must be multiple of (pagesize * 2) */
690 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
694 /* This value must be multiple of (pagesize * 2) */
695 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
696 (sizeof(void*) >= 8 \
697 ? 1 * 1024 * 1024 * 1024 \
703 #define MAP_FAILED ((void *)-1)
706 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
707 #define on_disk_bytes(st) ((st).st_size)
709 #define on_disk_bytes(st) ((st).st_blocks * 512)
712 #ifdef NEEDS_MODE_TRANSLATION
721 #define S_IFMT 0170000
722 #define S_IFREG 0100000
723 #define S_IFDIR 0040000
724 #define S_IFLNK 0120000
725 #define S_IFBLK 0060000
726 #define S_IFCHR 0020000
727 #define S_IFIFO 0010000
728 #define S_IFSOCK 0140000
732 #define stat(path, buf) git_stat(path, buf)
733 int git_stat(const char *, struct stat
*);
737 #define fstat(fd, buf) git_fstat(fd, buf)
738 int git_fstat(int, struct stat
*);
742 #define lstat(path, buf) git_lstat(path, buf)
743 int git_lstat(const char *, struct stat
*);
746 #define DEFAULT_PACKED_GIT_LIMIT \
747 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
750 #define pread git_pread
751 ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
754 * Forward decl that will remind us if its twin in cache.h changes.
755 * This function is used in compat/pread.c. But we can't include
758 ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
761 #define setenv gitsetenv
762 int gitsetenv(const char *, const char *, int);
766 #define mkdtemp gitmkdtemp
767 char *gitmkdtemp(char *);
771 #define unsetenv gitunsetenv
772 int gitunsetenv(const char *);
776 #define strcasestr gitstrcasestr
777 char *gitstrcasestr(const char *haystack
, const char *needle
);
781 #define strlcpy gitstrlcpy
782 size_t gitstrlcpy(char *, const char *, size_t);
786 #define strtoumax gitstrtoumax
787 uintmax_t gitstrtoumax(const char *, char **, int);
788 #define strtoimax gitstrtoimax
789 intmax_t gitstrtoimax(const char *, char **, int);
793 #define hstrerror githstrerror
794 const char *githstrerror(int herror
);
798 #define memmem gitmemmem
799 void *gitmemmem(const void *haystack
, size_t haystacklen
,
800 const void *needle
, size_t needlelen
);
803 #ifdef OVERRIDE_STRDUP
807 #define strdup gitstrdup
808 char *gitstrdup(const char *s
);
811 #ifdef NO_GETPAGESIZE
812 #define getpagesize() sysconf(_SC_PAGESIZE)
819 #ifdef FREAD_READS_DIRECTORIES
820 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
824 # define fopen(a,b) git_fopen(a,b)
826 FILE *git_fopen(const char*, const char*);
829 #ifdef SNPRINTF_RETURNS_BOGUS
833 #define snprintf git_snprintf
834 int git_snprintf(char *str
, size_t maxsize
,
835 const char *format
, ...);
839 #define vsnprintf git_vsnprintf
840 int git_vsnprintf(char *str
, size_t maxsize
,
841 const char *format
, va_list ap
);
844 #ifdef OPEN_RETURNS_EINTR
846 #define open git_open_with_retry
847 int git_open_with_retry(const char *path
, int flag
, ...);
850 #ifdef __GLIBC_PREREQ
851 #if __GLIBC_PREREQ(2, 1)
852 #define HAVE_STRCHRNUL
856 #ifndef HAVE_STRCHRNUL
857 #define strchrnul gitstrchrnul
858 static inline char *gitstrchrnul(const char *s
, int c
)
860 while (*s
&& *s
!= c
)
867 int inet_pton(int af
, const char *src
, void *dst
);
871 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
875 #define atexit git_atexit
876 int git_atexit(void (*handler
)(void));
879 static inline size_t st_add(size_t a
, size_t b
)
881 if (unsigned_add_overflows(a
, b
))
882 die("size_t overflow: %"PRIuMAX
" + %"PRIuMAX
,
883 (uintmax_t)a
, (uintmax_t)b
);
886 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
887 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
889 static inline size_t st_mult(size_t a
, size_t b
)
891 if (unsigned_mult_overflows(a
, b
))
892 die("size_t overflow: %"PRIuMAX
" * %"PRIuMAX
,
893 (uintmax_t)a
, (uintmax_t)b
);
897 static inline size_t st_sub(size_t a
, size_t b
)
900 die("size_t underflow: %"PRIuMAX
" - %"PRIuMAX
,
901 (uintmax_t)a
, (uintmax_t)b
);
905 static inline size_t st_left_shift(size_t a
, unsigned shift
)
907 if (unsigned_left_shift_overflows(a
, shift
))
908 die("size_t overflow: %"PRIuMAX
" << %u",
909 (uintmax_t)a
, shift
);
913 static inline unsigned long cast_size_t_to_ulong(size_t a
)
915 if (a
!= (unsigned long)a
)
916 die("object too large to read on this platform: %"
917 PRIuMAX
" is cut off to %lu",
918 (uintmax_t)a
, (unsigned long)a
);
919 return (unsigned long)a
;
924 # define xalloca(size) (alloca(size))
925 # define xalloca_free(p) do {} while (0)
927 # define xalloca(size) (xmalloc(size))
928 # define xalloca_free(p) (free(p))
930 char *xstrdup(const char *str
);
931 void *xmalloc(size_t size
);
932 void *xmallocz(size_t size
);
933 void *xmallocz_gently(size_t size
);
934 void *xmemdupz(const void *data
, size_t len
);
935 char *xstrndup(const char *str
, size_t len
);
936 void *xrealloc(void *ptr
, size_t size
);
937 void *xcalloc(size_t nmemb
, size_t size
);
938 void xsetenv(const char *name
, const char *value
, int overwrite
);
939 void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
940 const char *mmap_os_err(void);
941 void *xmmap_gently(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
942 int xopen(const char *path
, int flags
, ...);
943 ssize_t
xread(int fd
, void *buf
, size_t len
);
944 ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
945 ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
);
947 FILE *xfopen(const char *path
, const char *mode
);
948 FILE *xfdopen(int fd
, const char *mode
);
949 int xmkstemp(char *temp_filename
);
950 int xmkstemp_mode(char *temp_filename
, int mode
);
952 FILE *fopen_for_writing(const char *path
);
953 FILE *fopen_or_warn(const char *path
, const char *mode
);
956 * Like strncmp, but only return zero if s is NUL-terminated and exactly len
957 * characters long. If it is not, consider it greater than t.
959 int xstrncmpz(const char *s
, const char *t
, size_t len
);
962 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
963 * that ptr is used twice, so don't pass e.g. ptr++.
965 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
967 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
968 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
969 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
971 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
972 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
973 static inline void copy_array(void *dst
, const void *src
, size_t n
, size_t size
)
976 memcpy(dst
, src
, st_mult(size
, n
));
979 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
980 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
981 static inline void move_array(void *dst
, const void *src
, size_t n
, size_t size
)
984 memmove(dst
, src
, st_mult(size
, n
));
988 * These functions help you allocate structs with flex arrays, and copy
989 * the data directly into the array. For example, if you had:
993 * char name[FLEX_ARRAY];
999 * FLEX_ALLOC_MEM(f, name, src, len);
1001 * to allocate a "foo" with the contents of "src" in the "name" field.
1002 * The resulting struct is automatically zero'd, and the flex-array field
1003 * is NUL-terminated (whether the incoming src buffer was or not).
1005 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
1006 * but do want to store a pointer to some extra data in the same allocated
1007 * block. For example, if you have:
1017 * FLEXPTR_ALLOC_STR(f, name, src);
1019 * and "name" will point to a block of memory after the struct, which will be
1020 * freed along with the struct (but the pointer can be repointed anywhere).
1022 * The *_STR variants accept a string parameter rather than a ptr/len
1025 * Note that these macros will evaluate the first parameter multiple
1026 * times, and it must be assignable as an lvalue.
1028 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
1029 size_t flex_array_len_ = (len); \
1030 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1031 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
1033 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
1034 size_t flex_array_len_ = (len); \
1035 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1036 memcpy((x) + 1, (buf), flex_array_len_); \
1037 (x)->ptrname = (void *)((x)+1); \
1039 #define FLEX_ALLOC_STR(x, flexname, str) \
1040 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1041 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1042 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1044 static inline char *xstrdup_or_null(const char *str
)
1046 return str
? xstrdup(str
) : NULL
;
1049 static inline size_t xsize_t(off_t len
)
1051 if (len
< 0 || (uintmax_t) len
> SIZE_MAX
)
1052 die("Cannot handle files this big");
1053 return (size_t) len
;
1056 __attribute__((format (printf
, 3, 4)))
1057 int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...);
1059 #ifndef HOST_NAME_MAX
1060 #define HOST_NAME_MAX 256
1063 int xgethostname(char *buf
, size_t len
);
1065 /* in ctype.c, for kwset users */
1066 extern const unsigned char tolower_trans_tbl
[256];
1068 /* Sane ctype - no locale, and works with signed chars */
1083 extern const unsigned char sane_ctype
[256];
1084 #define GIT_SPACE 0x01
1085 #define GIT_DIGIT 0x02
1086 #define GIT_ALPHA 0x04
1087 #define GIT_GLOB_SPECIAL 0x08
1088 #define GIT_REGEX_SPECIAL 0x10
1089 #define GIT_PATHSPEC_MAGIC 0x20
1090 #define GIT_CNTRL 0x40
1091 #define GIT_PUNCT 0x80
1092 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1093 #define isascii(x) (((x) & ~0x7f) == 0)
1094 #define isspace(x) sane_istest(x,GIT_SPACE)
1095 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1096 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1097 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1098 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1099 #define islower(x) sane_iscase(x, 1)
1100 #define isupper(x) sane_iscase(x, 0)
1101 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1102 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1103 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1104 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1105 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1106 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1107 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1108 #define toupper(x) sane_case((unsigned char)(x), 0)
1109 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1111 static inline int sane_case(int x
, int high
)
1113 if (sane_istest(x
, GIT_ALPHA
))
1114 x
= (x
& ~0x20) | high
;
1118 static inline int sane_iscase(int x
, int is_lower
)
1120 if (!sane_istest(x
, GIT_ALPHA
))
1124 return (x
& 0x20) != 0;
1126 return (x
& 0x20) == 0;
1130 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1131 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1132 * locale-specific conversions).
1134 static inline int skip_iprefix(const char *str
, const char *prefix
,
1142 } while (tolower(*str
++) == tolower(*prefix
++));
1146 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
1152 /* negative values would be accepted by strtoul */
1155 ul
= strtoul(s
, &p
, base
);
1156 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
1162 static inline int strtol_i(char const *s
, int base
, int *result
)
1168 ul
= strtol(s
, &p
, base
);
1169 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
1175 void git_stable_qsort(void *base
, size_t nmemb
, size_t size
,
1176 int(*compar
)(const void *, const void *));
1177 #ifdef INTERNAL_QSORT
1178 #define qsort git_stable_qsort
1181 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1182 static inline void sane_qsort(void *base
, size_t nmemb
, size_t size
,
1183 int(*compar
)(const void *, const void *))
1186 qsort(base
, nmemb
, size
, compar
);
1189 #define STABLE_QSORT(base, n, compar) \
1190 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1192 #ifndef HAVE_ISO_QSORT_S
1193 int git_qsort_s(void *base
, size_t nmemb
, size_t size
,
1194 int (*compar
)(const void *, const void *, void *), void *ctx
);
1195 #define qsort_s git_qsort_s
1198 #define QSORT_S(base, n, compar, ctx) do { \
1199 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1200 BUG("qsort_s() failed"); \
1203 #ifndef REG_STARTEND
1204 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1207 static inline int regexec_buf(const regex_t
*preg
, const char *buf
, size_t size
,
1208 size_t nmatch
, regmatch_t pmatch
[], int eflags
)
1210 assert(nmatch
> 0 && pmatch
);
1211 pmatch
[0].rm_so
= 0;
1212 pmatch
[0].rm_eo
= size
;
1213 return regexec(preg
, buf
, nmatch
, pmatch
, eflags
| REG_STARTEND
);
1216 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1217 # define FORCE_DIR_SET_GID S_ISGID
1219 # define FORCE_DIR_SET_GID 0
1224 #define ST_CTIME_NSEC(st) 0
1225 #define ST_MTIME_NSEC(st) 0
1227 #ifdef USE_ST_TIMESPEC
1228 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1229 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1231 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1232 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1236 #ifdef UNRELIABLE_FSTAT
1237 #define fstat_is_reliable() 0
1239 #define fstat_is_reliable() 1
1244 * Since an obvious implementation of va_list would be to make it a
1245 * pointer into the stack frame, a simple assignment will work on
1246 * many systems. But let's try to be more portable.
1249 #define va_copy(dst, src) __va_copy(dst, src)
1251 #define va_copy(dst, src) ((dst) = (src))
1256 * This is always defined as a first step towards making the use of variadic
1257 * macros unconditional. If it causes compilation problems on your platform,
1258 * please report it to the Git mailing list at git@vger.kernel.org.
1260 #define HAVE_VARIADIC_MACROS 1
1262 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1263 extern int BUG_exit_code
;
1265 #ifdef HAVE_VARIADIC_MACROS
1266 __attribute__((format (printf
, 3, 4))) NORETURN
1267 void BUG_fl(const char *file
, int line
, const char *fmt
, ...);
1268 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1270 __attribute__((format (printf
, 1, 2))) NORETURN
1271 void BUG(const char *fmt
, ...);
1275 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_WRITEOUT_ONLY
1277 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_FSYNC
1281 FSYNC_WRITEOUT_ONLY
,
1282 FSYNC_HARDWARE_FLUSH
1286 * Issues an fsync against the specified file according to the specified mode.
1288 * FSYNC_WRITEOUT_ONLY attempts to use interfaces available on some operating
1289 * systems to flush the OS cache without issuing a flush command to the storage
1290 * controller. If those interfaces are unavailable, the function fails with
1293 * FSYNC_HARDWARE_FLUSH does an OS writeout and hardware flush to ensure that
1294 * changes are durable. It is not expected to fail.
1296 int git_fsync(int fd
, enum fsync_action action
);
1299 * Preserves errno, prints a message, but gives no warning for ENOENT.
1300 * Returns 0 on success, which includes trying to unlink an object that does
1303 int unlink_or_warn(const char *path
);
1305 * Tries to unlink file. Returns 0 if unlink succeeded
1306 * or the file already didn't exist. Returns -1 and
1307 * appends a message to err suitable for
1308 * 'error("%s", err->buf)' on error.
1310 int unlink_or_msg(const char *file
, struct strbuf
*err
);
1312 * Preserves errno, prints a message, but gives no warning for ENOENT.
1313 * Returns 0 on success, which includes trying to remove a directory that does
1316 int rmdir_or_warn(const char *path
);
1318 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1319 * the supplied file mode.
1321 int remove_or_warn(unsigned int mode
, const char *path
);
1324 * Call access(2), but warn for any error except "missing file"
1325 * (ENOENT or ENOTDIR).
1327 #define ACCESS_EACCES_OK (1U << 0)
1328 int access_or_warn(const char *path
, int mode
, unsigned flag
);
1329 int access_or_die(const char *path
, int mode
, unsigned flag
);
1331 /* Warn on an inaccessible file if errno indicates this is an error */
1332 int warn_on_fopen_errors(const char *path
);
1335 * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent
1336 * may be racy. Do not use this as protection against an attacker who can
1337 * simultaneously create paths.
1339 int open_nofollow(const char *path
, int flags
);
1342 # define SHELL_PATH "/bin/sh"
1345 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1346 static inline void flockfile(FILE *fh
)
1350 static inline void funlockfile(FILE *fh
)
1354 #define getc_unlocked(fh) getc(fh)
1357 #ifdef FILENO_IS_A_MACRO
1358 int git_fileno(FILE *stream
);
1359 # ifndef COMPAT_CODE_FILENO
1361 # define fileno(p) git_fileno(p)
1365 #ifdef NEED_ACCESS_ROOT_HANDLER
1366 int git_access(const char *path
, int mode
);
1367 # ifndef COMPAT_CODE_ACCESS
1371 # define access(path, mode) git_access(path, mode)
1376 * Our code often opens a path to an optional file, to work on its
1377 * contents when we can successfully open it. We can ignore a failure
1378 * to open if such an optional file does not exist, but we do want to
1379 * report a failure in opening for other reasons (e.g. we got an I/O
1380 * error, or the file is there, but we lack the permission to open).
1382 * Call this function after seeing an error from open() or fopen() to
1383 * see if the errno indicates a missing file that we can safely ignore.
1385 static inline int is_missing_file_error(int errno_
)
1387 return (errno_
== ENOENT
|| errno_
== ENOTDIR
);
1390 int cmd_main(int, const char **);
1393 * Intercept all calls to exit() and route them to trace2 to
1394 * optionally emit a message before calling the real exit().
1396 int trace2_cmd_exit_fl(const char *file
, int line
, int code
);
1397 #define exit(code) exit(trace2_cmd_exit_fl(__FILE__, __LINE__, (code)))
1400 * You can mark a stack variable with UNLEAK(var) to avoid it being
1401 * reported as a leak by tools like LSAN or valgrind. The argument
1402 * should generally be the variable itself (not its address and not what
1403 * it points to). It's safe to use this on pointers which may already
1404 * have been freed, or on pointers which may still be in use.
1406 * Use this _only_ for a variable that leaks by going out of scope at
1407 * program exit (so only from cmd_* functions or their direct helpers).
1408 * Normal functions, especially those which may be called multiple
1409 * times, should actually free their memory. This is only meant as
1410 * an annotation, and does nothing in non-leak-checking builds.
1412 #ifdef SUPPRESS_ANNOTATED_LEAKS
1413 void unleak_memory(const void *ptr
, size_t len
);
1414 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1416 #define UNLEAK(var) do {} while (0)
1422 #if ZLIB_VERNUM < 0x1290
1424 * This is uncompress2, which is only available in zlib >= 1.2.9
1425 * (released as of early 2017). See compat/zlib-uncompress2.c.
1427 int uncompress2(Bytef
*dest
, uLongf
*destLen
, const Bytef
*source
,
1432 * This include must come after system headers, since it introduces macros that
1433 * replace system names.
1438 * container_of - Get the address of an object containing a field.
1440 * @ptr: pointer to the field.
1441 * @type: type of the object.
1442 * @member: name of the field within the object.
1444 #define container_of(ptr, type, member) \
1445 ((type *) ((char *)(ptr) - offsetof(type, member)))
1448 * helper function for `container_of_or_null' to avoid multiple
1449 * evaluation of @ptr
1451 static inline void *container_of_or_null_offset(void *ptr
, size_t offset
)
1453 return ptr
? (char *)ptr
- offset
: NULL
;
1457 * like `container_of', but allows returned value to be NULL
1459 #define container_of_or_null(ptr, type, member) \
1460 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1463 * like offsetof(), but takes a pointer to a variable of type which
1464 * contains @member, instead of a specified type.
1465 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1468 #if defined(__GNUC__) /* clang sets this, too */
1469 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1470 #else /* !__GNUC__ */
1471 #define OFFSETOF_VAR(ptr, member) \
1472 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1473 #endif /* !__GNUC__ */
1475 void sleep_millisec(int millisec
);
1478 * Generate len bytes from the system cryptographically secure PRNG.
1479 * Returns 0 on success and -1 on error, setting errno. The inability to
1480 * satisfy the full request is an error.
1482 int csprng_bytes(void *buf
, size_t len
);