1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
6 * For these to work they must appear very early in each
7 * file -- before most of the standard header files.
13 #define _FILE_OFFSET_BITS 64
16 /* Derived from Linux "Features Test Macro" header
17 * Convenience macros to test the versions of gcc (or
18 * a compatible compiler).
20 * #if GIT_GNUC_PREREQ (2,8)
21 * ... code requiring gcc 2.8 or later ...
24 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
25 # define GIT_GNUC_PREREQ(maj, min) \
26 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
28 #define GIT_GNUC_PREREQ(maj, min) 0
34 * See if our compiler is known to support flexible array members.
36 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
37 # define FLEX_ARRAY /* empty */
38 #elif defined(__GNUC__)
40 # define FLEX_ARRAY /* empty */
42 # define FLEX_ARRAY 0 /* older GNU extension */
47 * Otherwise, default to safer but a bit wasteful traditional style
56 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
57 * @cond: the compile-time condition which must be true.
59 * Your compile will fail if the condition isn't true, or can't be evaluated
60 * by the compiler. This can be used in an expression: its value is "0".
63 * #define foo_to_char(foo) \
65 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
67 #define BUILD_ASSERT_OR_ZERO(cond) \
68 (sizeof(char [1 - 2*!(cond)]) - 1)
70 #if GIT_GNUC_PREREQ(3, 1)
71 /* &arr[0] degrades to a pointer: a different type from an array */
72 # define BARF_UNLESS_AN_ARRAY(arr) \
73 BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
74 __typeof__(&(arr)[0])))
76 # define BARF_UNLESS_AN_ARRAY(arr) 0
79 * ARRAY_SIZE - get the number of elements in a visible array
80 * @x: the array whose size you want.
82 * This does not work on pointers, or arrays declared as [], or
83 * function parameters. With correct compiler support, such usage
84 * will cause a build error (see the build_assert_or_zero macro).
86 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
88 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
90 #define maximum_signed_value_of_type(a) \
91 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
93 #define maximum_unsigned_value_of_type(a) \
94 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
97 * Signed integer overflow is undefined in C, so here's a helper macro
98 * to detect if the sum of two integers will overflow.
100 * Requires: a >= 0, typeof(a) equals typeof(b)
102 #define signed_add_overflows(a, b) \
103 ((b) > maximum_signed_value_of_type(a) - (a))
105 #define unsigned_add_overflows(a, b) \
106 ((b) > maximum_unsigned_value_of_type(a) - (a))
109 * Returns true if the multiplication of "a" and "b" will
110 * overflow. The types of "a" and "b" must match and must be unsigned.
111 * Note that this macro evaluates "a" twice!
113 #define unsigned_mult_overflows(a, b) \
114 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
117 * Returns true if the left shift of "a" by "shift" bits will
118 * overflow. The type of "a" must be unsigned.
120 #define unsigned_left_shift_overflows(a, shift) \
121 ((shift) < bitsizeof(a) && \
122 (a) > maximum_unsigned_value_of_type(a) >> (shift))
125 #define TYPEOF(x) (__typeof__(x))
130 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
131 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
133 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
135 /* Approximation of the length of the decimal representation of this type. */
136 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
140 * On Solaris, when _XOPEN_EXTENDED is set, its header file
141 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
142 * setting to say we are XPG5 or XPG6. Also on Solaris,
143 * XPG6 programs must be compiled with a c99 compiler, while
144 * non XPG6 programs must be compiled with a pre-c99 compiler.
146 # if __STDC_VERSION__ - 0 >= 199901L
147 # define _XOPEN_SOURCE 600
149 # define _XOPEN_SOURCE 500
151 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
152 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
153 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
155 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
156 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
158 #define _ALL_SOURCE 1
159 #define _GNU_SOURCE 1
160 #define _BSD_SOURCE 1
161 #define _DEFAULT_SOURCE 1
162 #define _NETBSD_SOURCE 1
163 #define _SGI_SOURCE 1
165 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
166 # if !defined(_WIN32_WINNT)
167 # define _WIN32_WINNT 0x0600
169 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
170 #include <winsock2.h>
171 #ifndef NO_UNIX_SOCKETS
175 #define GIT_WINDOWS_NATIVE
180 #include <sys/stat.h>
186 #ifdef HAVE_STRINGS_H
187 #include <strings.h> /* for strcasecmp() */
191 #ifdef NEEDS_SYS_PARAM_H
192 #include <sys/param.h>
194 #include <sys/types.h>
196 #include <sys/time.h>
203 #if !defined(NO_POLL_H)
205 #elif !defined(NO_SYS_POLL_H)
206 #include <sys/poll.h>
208 /* Pull the compat stuff */
211 #ifdef HAVE_BSD_SYSCTL
212 #include <sys/sysctl.h>
215 #if defined(__CYGWIN__)
216 #include "compat/win32/path-utils.h"
218 #if defined(__MINGW32__)
219 /* pull in Windows compatibility stuff */
220 #include "compat/win32/path-utils.h"
221 #include "compat/mingw.h"
222 #elif defined(_MSC_VER)
223 #include "compat/win32/path-utils.h"
224 #include "compat/msvc.h"
226 #include <sys/utsname.h>
227 #include <sys/wait.h>
228 #include <sys/resource.h>
229 #include <sys/socket.h>
230 #include <sys/ioctl.h>
232 #ifndef NO_SYS_SELECT_H
233 #include <sys/select.h>
235 #include <netinet/in.h>
236 #include <netinet/tcp.h>
237 #include <arpa/inet.h>
241 #ifndef NO_INTTYPES_H
242 #include <inttypes.h>
248 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
249 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
250 * while on IP16 and IP16L32 it is "int" (resp. "short")
251 * Size needs to match (or exceed) 'sizeof(void *)'.
252 * We can't take "long long" here as not everybody has it.
254 typedef long intptr_t;
255 typedef unsigned long uintptr_t;
257 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
259 #define _ALL_SOURCE 1
262 /* used on Mac OS X */
263 #ifdef PRECOMPOSE_UNICODE
264 #include "compat/precompose_utf8.h"
266 static inline const char *precompose_argv_prefix(int argc
, const char **argv
, const char *prefix
)
270 static inline const char *precompose_string_if_needed(const char *in
)
275 #define probe_utf8_pathname_composition()
278 #ifdef MKDIR_WO_TRAILING_SLASH
279 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
280 int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
283 #ifdef NO_STRUCT_ITIMERVAL
285 struct timeval it_interval
;
286 struct timeval it_value
;
291 static inline int setitimer(int which
, const struct itimerval
*value
, struct itimerval
*newvalue
) {
292 return 0; /* pretend success */
299 #define basename gitbasename
300 char *gitbasename(char *);
301 #define dirname gitdirname
302 char *gitdirname(char *);
311 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
312 #include <AvailabilityMacros.h>
313 #undef DEPRECATED_ATTRIBUTE
314 #define DEPRECATED_ATTRIBUTE
315 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
317 #include <openssl/ssl.h>
318 #include <openssl/err.h>
322 # include <sys/sysinfo.h>
325 /* On most systems <netdb.h> would have given us this, but
326 * not on some systems (e.g. z/OS).
329 #define NI_MAXHOST 1025
333 #define NI_MAXSERV 32
336 /* On most systems <limits.h> would have given us this, but
337 * not on some systems (e.g. GNU/Hurd).
340 #define PATH_MAX 4096
343 typedef uintmax_t timestamp_t
;
344 #define PRItime PRIuMAX
345 #define parse_timestamp strtoumax
346 #define TIME_MAX UINTMAX_MAX
356 #ifndef _PATH_DEFPATH
357 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
360 #ifndef platform_core_config
361 static inline int noop_core_config(const char *var
, const char *value
, void *cb
)
365 #define platform_core_config noop_core_config
368 int lstat_cache_aware_rmdir(const char *path
);
369 #if !defined(__MINGW32__) && !defined(_MSC_VER)
370 #define rmdir lstat_cache_aware_rmdir
373 #ifndef has_dos_drive_prefix
374 static inline int git_has_dos_drive_prefix(const char *path
)
378 #define has_dos_drive_prefix git_has_dos_drive_prefix
381 #ifndef skip_dos_drive_prefix
382 static inline int git_skip_dos_drive_prefix(char **path
)
386 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
390 static inline int git_is_dir_sep(int c
)
394 #define is_dir_sep git_is_dir_sep
397 #ifndef offset_1st_component
398 static inline int git_offset_1st_component(const char *path
)
400 return is_dir_sep(path
[0]);
402 #define offset_1st_component git_offset_1st_component
405 #ifndef is_valid_path
406 #define is_valid_path(path) 1
409 #ifndef find_last_dir_sep
410 static inline char *git_find_last_dir_sep(const char *path
)
412 return strrchr(path
, '/');
414 #define find_last_dir_sep git_find_last_dir_sep
418 static inline int git_has_dir_sep(const char *path
)
420 return !!strchr(path
, '/');
422 #define has_dir_sep(path) git_has_dir_sep(path)
425 #ifndef query_user_email
426 #define query_user_email() NULL
430 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
431 #include <floss.h(floss_getpwuid)>
434 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
435 * known, by detective work using kill -l as a list is all signals
436 * instead of signal.h where it should be.
442 #if defined(__HP_cc) && (__HP_cc >= 61000)
443 #define NORETURN __attribute__((noreturn))
445 #elif defined(__GNUC__) && !defined(NO_NORETURN)
446 #define NORETURN __attribute__((__noreturn__))
447 #define NORETURN_PTR __attribute__((__noreturn__))
448 #elif defined(_MSC_VER)
449 #define NORETURN __declspec(noreturn)
455 #ifndef __attribute__
456 #define __attribute__(x)
461 /* The sentinel attribute is valid from gcc version 4.0 */
462 #if defined(__GNUC__) && (__GNUC__ >= 4)
463 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
465 #define LAST_ARG_MUST_BE_NULL
468 #define MAYBE_UNUSED __attribute__((__unused__))
470 #include "compat/bswap.h"
472 #include "wildmatch.h"
476 /* General helper functions */
477 void vreportf(const char *prefix
, const char *err
, va_list params
);
478 NORETURN
void usage(const char *err
);
479 NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
480 NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
481 NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
482 int die_message(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
483 int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
484 int error_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
485 void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
486 void warning_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
489 #ifdef APPLE_COMMON_CRYPTO
490 #include "compat/apple-common-crypto.h"
492 #include <openssl/evp.h>
493 #include <openssl/hmac.h>
494 #endif /* APPLE_COMMON_CRYPTO */
495 #include <openssl/x509v3.h>
496 #endif /* NO_OPENSSL */
499 * Let callers be aware of the constant return value; this can help
500 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
501 * because some compilers may not support variadic macros. Since we're only
502 * trying to help gcc, anyway, it's OK; other compilers will fall back to
503 * using the function as usual.
505 #if defined(__GNUC__)
506 static inline int const_error(void)
510 #define error(...) (error(__VA_ARGS__), const_error())
511 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
514 typedef void (*report_fn
)(const char *, va_list params
);
516 void set_die_routine(NORETURN_PTR report_fn routine
);
517 report_fn
get_die_message_routine(void);
518 void set_error_routine(report_fn routine
);
519 report_fn
get_error_routine(void);
520 void set_warn_routine(report_fn routine
);
521 report_fn
get_warn_routine(void);
522 void set_die_is_recursing_routine(int (*routine
)(void));
524 int starts_with(const char *str
, const char *prefix
);
525 int istarts_with(const char *str
, const char *prefix
);
528 * If the string "str" begins with the string found in "prefix", return 1.
529 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
530 * the string right after the prefix).
532 * Otherwise, return 0 and leave "out" untouched.
536 * [extract branch name, fail if not a branch]
537 * if (!skip_prefix(ref, "refs/heads/", &branch)
540 * [skip prefix if present, otherwise use whole string]
541 * skip_prefix(name, "refs/heads/", &name);
543 static inline int skip_prefix(const char *str
, const char *prefix
,
551 } while (*str
++ == *prefix
++);
556 * If the string "str" is the same as the string in "prefix", then the "arg"
557 * parameter is set to the "def" parameter and 1 is returned.
558 * If the string "str" begins with the string found in "prefix" and then a
559 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
560 * (i.e., to the point in the string right after the prefix and the "=" sign),
563 * Otherwise, return 0 and leave "arg" untouched.
565 * When we accept both a "--key" and a "--key=<val>" option, this function
566 * can be used instead of !strcmp(arg, "--key") and then
567 * skip_prefix(arg, "--key=", &arg) to parse such an option.
569 int skip_to_optional_arg_default(const char *str
, const char *prefix
,
570 const char **arg
, const char *def
);
572 static inline int skip_to_optional_arg(const char *str
, const char *prefix
,
575 return skip_to_optional_arg_default(str
, prefix
, arg
, "");
579 * Like skip_prefix, but promises never to read past "len" bytes of the input
580 * buffer, and returns the remaining number of bytes in "out" via "outlen".
582 static inline int skip_prefix_mem(const char *buf
, size_t len
,
584 const char **out
, size_t *outlen
)
586 size_t prefix_len
= strlen(prefix
);
587 if (prefix_len
<= len
&& !memcmp(buf
, prefix
, prefix_len
)) {
588 *out
= buf
+ prefix_len
;
589 *outlen
= len
- prefix_len
;
596 * If buf ends with suffix, return 1 and subtract the length of the suffix
597 * from *len. Otherwise, return 0 and leave *len untouched.
599 static inline int strip_suffix_mem(const char *buf
, size_t *len
,
602 size_t suflen
= strlen(suffix
);
603 if (*len
< suflen
|| memcmp(buf
+ (*len
- suflen
), suffix
, suflen
))
610 * If str ends with suffix, return 1 and set *len to the size of the string
611 * without the suffix. Otherwise, return 0 and set *len to the size of the
614 * Note that we do _not_ NUL-terminate str to the new length.
616 static inline int strip_suffix(const char *str
, const char *suffix
, size_t *len
)
619 return strip_suffix_mem(str
, len
, suffix
);
622 static inline int ends_with(const char *str
, const char *suffix
)
625 return strip_suffix(str
, suffix
, &len
);
628 #define SWAP(a, b) do { \
629 void *_swap_a_ptr = &(a); \
630 void *_swap_b_ptr = &(b); \
631 unsigned char _swap_buffer[sizeof(a)]; \
632 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
633 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
634 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
635 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
638 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
643 #define MAP_PRIVATE 1
646 #define mmap git_mmap
647 #define munmap git_munmap
648 void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
649 int git_munmap(void *start
, size_t length
);
651 #else /* NO_MMAP || USE_WIN32_MMAP */
653 #include <sys/mman.h>
655 #endif /* NO_MMAP || USE_WIN32_MMAP */
659 /* This value must be multiple of (pagesize * 2) */
660 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
664 /* This value must be multiple of (pagesize * 2) */
665 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
666 (sizeof(void*) >= 8 \
667 ? 1 * 1024 * 1024 * 1024 \
673 #define MAP_FAILED ((void *)-1)
676 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
677 #define on_disk_bytes(st) ((st).st_size)
679 #define on_disk_bytes(st) ((st).st_blocks * 512)
682 #ifdef NEEDS_MODE_TRANSLATION
691 #define S_IFMT 0170000
692 #define S_IFREG 0100000
693 #define S_IFDIR 0040000
694 #define S_IFLNK 0120000
695 #define S_IFBLK 0060000
696 #define S_IFCHR 0020000
697 #define S_IFIFO 0010000
698 #define S_IFSOCK 0140000
702 #define stat(path, buf) git_stat(path, buf)
703 int git_stat(const char *, struct stat
*);
707 #define fstat(fd, buf) git_fstat(fd, buf)
708 int git_fstat(int, struct stat
*);
712 #define lstat(path, buf) git_lstat(path, buf)
713 int git_lstat(const char *, struct stat
*);
716 #define DEFAULT_PACKED_GIT_LIMIT \
717 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
720 #define pread git_pread
721 ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
724 * Forward decl that will remind us if its twin in cache.h changes.
725 * This function is used in compat/pread.c. But we can't include
728 ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
731 #define setenv gitsetenv
732 int gitsetenv(const char *, const char *, int);
736 #define mkdtemp gitmkdtemp
737 char *gitmkdtemp(char *);
741 #define unsetenv gitunsetenv
742 int gitunsetenv(const char *);
746 #define strcasestr gitstrcasestr
747 char *gitstrcasestr(const char *haystack
, const char *needle
);
751 #define strlcpy gitstrlcpy
752 size_t gitstrlcpy(char *, const char *, size_t);
756 #define strtoumax gitstrtoumax
757 uintmax_t gitstrtoumax(const char *, char **, int);
758 #define strtoimax gitstrtoimax
759 intmax_t gitstrtoimax(const char *, char **, int);
763 #define hstrerror githstrerror
764 const char *githstrerror(int herror
);
768 #define memmem gitmemmem
769 void *gitmemmem(const void *haystack
, size_t haystacklen
,
770 const void *needle
, size_t needlelen
);
773 #ifdef OVERRIDE_STRDUP
777 #define strdup gitstrdup
778 char *gitstrdup(const char *s
);
781 #ifdef NO_GETPAGESIZE
782 #define getpagesize() sysconf(_SC_PAGESIZE)
789 #ifdef FREAD_READS_DIRECTORIES
790 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
794 # define fopen(a,b) git_fopen(a,b)
796 FILE *git_fopen(const char*, const char*);
799 #ifdef SNPRINTF_RETURNS_BOGUS
803 #define snprintf git_snprintf
804 int git_snprintf(char *str
, size_t maxsize
,
805 const char *format
, ...);
809 #define vsnprintf git_vsnprintf
810 int git_vsnprintf(char *str
, size_t maxsize
,
811 const char *format
, va_list ap
);
814 #ifdef OPEN_RETURNS_EINTR
816 #define open git_open_with_retry
817 int git_open_with_retry(const char *path
, int flag
, ...);
820 #ifdef __GLIBC_PREREQ
821 #if __GLIBC_PREREQ(2, 1)
822 #define HAVE_STRCHRNUL
826 #ifndef HAVE_STRCHRNUL
827 #define strchrnul gitstrchrnul
828 static inline char *gitstrchrnul(const char *s
, int c
)
830 while (*s
&& *s
!= c
)
837 int inet_pton(int af
, const char *src
, void *dst
);
841 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
845 #define atexit git_atexit
846 int git_atexit(void (*handler
)(void));
849 static inline size_t st_add(size_t a
, size_t b
)
851 if (unsigned_add_overflows(a
, b
))
852 die("size_t overflow: %"PRIuMAX
" + %"PRIuMAX
,
853 (uintmax_t)a
, (uintmax_t)b
);
856 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
857 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
859 static inline size_t st_mult(size_t a
, size_t b
)
861 if (unsigned_mult_overflows(a
, b
))
862 die("size_t overflow: %"PRIuMAX
" * %"PRIuMAX
,
863 (uintmax_t)a
, (uintmax_t)b
);
867 static inline size_t st_sub(size_t a
, size_t b
)
870 die("size_t underflow: %"PRIuMAX
" - %"PRIuMAX
,
871 (uintmax_t)a
, (uintmax_t)b
);
875 static inline size_t st_left_shift(size_t a
, unsigned shift
)
877 if (unsigned_left_shift_overflows(a
, shift
))
878 die("size_t overflow: %"PRIuMAX
" << %u",
879 (uintmax_t)a
, shift
);
883 static inline unsigned long cast_size_t_to_ulong(size_t a
)
885 if (a
!= (unsigned long)a
)
886 die("object too large to read on this platform: %"
887 PRIuMAX
" is cut off to %lu",
888 (uintmax_t)a
, (unsigned long)a
);
889 return (unsigned long)a
;
894 # define xalloca(size) (alloca(size))
895 # define xalloca_free(p) do {} while (0)
897 # define xalloca(size) (xmalloc(size))
898 # define xalloca_free(p) (free(p))
900 char *xstrdup(const char *str
);
901 void *xmalloc(size_t size
);
902 void *xmallocz(size_t size
);
903 void *xmallocz_gently(size_t size
);
904 void *xmemdupz(const void *data
, size_t len
);
905 char *xstrndup(const char *str
, size_t len
);
906 void *xrealloc(void *ptr
, size_t size
);
907 void *xcalloc(size_t nmemb
, size_t size
);
908 void xsetenv(const char *name
, const char *value
, int overwrite
);
909 void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
910 const char *mmap_os_err(void);
911 void *xmmap_gently(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
912 int xopen(const char *path
, int flags
, ...);
913 ssize_t
xread(int fd
, void *buf
, size_t len
);
914 ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
915 ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
);
917 FILE *xfopen(const char *path
, const char *mode
);
918 FILE *xfdopen(int fd
, const char *mode
);
919 int xmkstemp(char *temp_filename
);
920 int xmkstemp_mode(char *temp_filename
, int mode
);
922 FILE *fopen_for_writing(const char *path
);
923 FILE *fopen_or_warn(const char *path
, const char *mode
);
926 * Like strncmp, but only return zero if s is NUL-terminated and exactly len
927 * characters long. If it is not, consider it greater than t.
929 int xstrncmpz(const char *s
, const char *t
, size_t len
);
932 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
933 * that ptr is used twice, so don't pass e.g. ptr++.
935 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
937 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
938 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
939 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
941 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
942 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
943 static inline void copy_array(void *dst
, const void *src
, size_t n
, size_t size
)
946 memcpy(dst
, src
, st_mult(size
, n
));
949 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
950 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
951 static inline void move_array(void *dst
, const void *src
, size_t n
, size_t size
)
954 memmove(dst
, src
, st_mult(size
, n
));
958 * These functions help you allocate structs with flex arrays, and copy
959 * the data directly into the array. For example, if you had:
963 * char name[FLEX_ARRAY];
969 * FLEX_ALLOC_MEM(f, name, src, len);
971 * to allocate a "foo" with the contents of "src" in the "name" field.
972 * The resulting struct is automatically zero'd, and the flex-array field
973 * is NUL-terminated (whether the incoming src buffer was or not).
975 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
976 * but do want to store a pointer to some extra data in the same allocated
977 * block. For example, if you have:
987 * FLEXPTR_ALLOC_STR(f, name, src);
989 * and "name" will point to a block of memory after the struct, which will be
990 * freed along with the struct (but the pointer can be repointed anywhere).
992 * The *_STR variants accept a string parameter rather than a ptr/len
995 * Note that these macros will evaluate the first parameter multiple
996 * times, and it must be assignable as an lvalue.
998 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
999 size_t flex_array_len_ = (len); \
1000 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1001 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
1003 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
1004 size_t flex_array_len_ = (len); \
1005 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1006 memcpy((x) + 1, (buf), flex_array_len_); \
1007 (x)->ptrname = (void *)((x)+1); \
1009 #define FLEX_ALLOC_STR(x, flexname, str) \
1010 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1011 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1012 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1014 static inline char *xstrdup_or_null(const char *str
)
1016 return str
? xstrdup(str
) : NULL
;
1019 static inline size_t xsize_t(off_t len
)
1021 if (len
< 0 || (uintmax_t) len
> SIZE_MAX
)
1022 die("Cannot handle files this big");
1023 return (size_t) len
;
1026 __attribute__((format (printf
, 3, 4)))
1027 int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...);
1029 #ifndef HOST_NAME_MAX
1030 #define HOST_NAME_MAX 256
1033 int xgethostname(char *buf
, size_t len
);
1035 /* in ctype.c, for kwset users */
1036 extern const unsigned char tolower_trans_tbl
[256];
1038 /* Sane ctype - no locale, and works with signed chars */
1053 extern const unsigned char sane_ctype
[256];
1054 #define GIT_SPACE 0x01
1055 #define GIT_DIGIT 0x02
1056 #define GIT_ALPHA 0x04
1057 #define GIT_GLOB_SPECIAL 0x08
1058 #define GIT_REGEX_SPECIAL 0x10
1059 #define GIT_PATHSPEC_MAGIC 0x20
1060 #define GIT_CNTRL 0x40
1061 #define GIT_PUNCT 0x80
1062 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1063 #define isascii(x) (((x) & ~0x7f) == 0)
1064 #define isspace(x) sane_istest(x,GIT_SPACE)
1065 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1066 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1067 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1068 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1069 #define islower(x) sane_iscase(x, 1)
1070 #define isupper(x) sane_iscase(x, 0)
1071 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1072 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1073 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1074 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1075 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1076 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1077 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1078 #define toupper(x) sane_case((unsigned char)(x), 0)
1079 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1081 static inline int sane_case(int x
, int high
)
1083 if (sane_istest(x
, GIT_ALPHA
))
1084 x
= (x
& ~0x20) | high
;
1088 static inline int sane_iscase(int x
, int is_lower
)
1090 if (!sane_istest(x
, GIT_ALPHA
))
1094 return (x
& 0x20) != 0;
1096 return (x
& 0x20) == 0;
1100 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1101 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1102 * locale-specific conversions).
1104 static inline int skip_iprefix(const char *str
, const char *prefix
,
1112 } while (tolower(*str
++) == tolower(*prefix
++));
1116 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
1122 /* negative values would be accepted by strtoul */
1125 ul
= strtoul(s
, &p
, base
);
1126 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
1132 static inline int strtol_i(char const *s
, int base
, int *result
)
1138 ul
= strtol(s
, &p
, base
);
1139 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
1145 void git_stable_qsort(void *base
, size_t nmemb
, size_t size
,
1146 int(*compar
)(const void *, const void *));
1147 #ifdef INTERNAL_QSORT
1148 #define qsort git_stable_qsort
1151 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1152 static inline void sane_qsort(void *base
, size_t nmemb
, size_t size
,
1153 int(*compar
)(const void *, const void *))
1156 qsort(base
, nmemb
, size
, compar
);
1159 #define STABLE_QSORT(base, n, compar) \
1160 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1162 #ifndef HAVE_ISO_QSORT_S
1163 int git_qsort_s(void *base
, size_t nmemb
, size_t size
,
1164 int (*compar
)(const void *, const void *, void *), void *ctx
);
1165 #define qsort_s git_qsort_s
1168 #define QSORT_S(base, n, compar, ctx) do { \
1169 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1170 BUG("qsort_s() failed"); \
1173 #ifndef REG_STARTEND
1174 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1177 static inline int regexec_buf(const regex_t
*preg
, const char *buf
, size_t size
,
1178 size_t nmatch
, regmatch_t pmatch
[], int eflags
)
1180 assert(nmatch
> 0 && pmatch
);
1181 pmatch
[0].rm_so
= 0;
1182 pmatch
[0].rm_eo
= size
;
1183 return regexec(preg
, buf
, nmatch
, pmatch
, eflags
| REG_STARTEND
);
1186 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1187 # define FORCE_DIR_SET_GID S_ISGID
1189 # define FORCE_DIR_SET_GID 0
1194 #define ST_CTIME_NSEC(st) 0
1195 #define ST_MTIME_NSEC(st) 0
1197 #ifdef USE_ST_TIMESPEC
1198 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1199 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1201 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1202 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1206 #ifdef UNRELIABLE_FSTAT
1207 #define fstat_is_reliable() 0
1209 #define fstat_is_reliable() 1
1214 * Since an obvious implementation of va_list would be to make it a
1215 * pointer into the stack frame, a simple assignment will work on
1216 * many systems. But let's try to be more portable.
1219 #define va_copy(dst, src) __va_copy(dst, src)
1221 #define va_copy(dst, src) ((dst) = (src))
1226 * This is always defined as a first step towards making the use of variadic
1227 * macros unconditional. If it causes compilation problems on your platform,
1228 * please report it to the Git mailing list at git@vger.kernel.org.
1230 #define HAVE_VARIADIC_MACROS 1
1232 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1233 extern int BUG_exit_code
;
1235 #ifdef HAVE_VARIADIC_MACROS
1236 __attribute__((format (printf
, 3, 4))) NORETURN
1237 void BUG_fl(const char *file
, int line
, const char *fmt
, ...);
1238 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1240 __attribute__((format (printf
, 1, 2))) NORETURN
1241 void BUG(const char *fmt
, ...);
1245 * Preserves errno, prints a message, but gives no warning for ENOENT.
1246 * Returns 0 on success, which includes trying to unlink an object that does
1249 int unlink_or_warn(const char *path
);
1251 * Tries to unlink file. Returns 0 if unlink succeeded
1252 * or the file already didn't exist. Returns -1 and
1253 * appends a message to err suitable for
1254 * 'error("%s", err->buf)' on error.
1256 int unlink_or_msg(const char *file
, struct strbuf
*err
);
1258 * Preserves errno, prints a message, but gives no warning for ENOENT.
1259 * Returns 0 on success, which includes trying to remove a directory that does
1262 int rmdir_or_warn(const char *path
);
1264 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1265 * the supplied file mode.
1267 int remove_or_warn(unsigned int mode
, const char *path
);
1270 * Call access(2), but warn for any error except "missing file"
1271 * (ENOENT or ENOTDIR).
1273 #define ACCESS_EACCES_OK (1U << 0)
1274 int access_or_warn(const char *path
, int mode
, unsigned flag
);
1275 int access_or_die(const char *path
, int mode
, unsigned flag
);
1277 /* Warn on an inaccessible file if errno indicates this is an error */
1278 int warn_on_fopen_errors(const char *path
);
1281 * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent
1282 * may be racy. Do not use this as protection against an attacker who can
1283 * simultaneously create paths.
1285 int open_nofollow(const char *path
, int flags
);
1288 # define SHELL_PATH "/bin/sh"
1291 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1292 static inline void flockfile(FILE *fh
)
1296 static inline void funlockfile(FILE *fh
)
1300 #define getc_unlocked(fh) getc(fh)
1303 #ifdef FILENO_IS_A_MACRO
1304 int git_fileno(FILE *stream
);
1305 # ifndef COMPAT_CODE_FILENO
1307 # define fileno(p) git_fileno(p)
1311 #ifdef NEED_ACCESS_ROOT_HANDLER
1312 int git_access(const char *path
, int mode
);
1313 # ifndef COMPAT_CODE_ACCESS
1317 # define access(path, mode) git_access(path, mode)
1322 * Our code often opens a path to an optional file, to work on its
1323 * contents when we can successfully open it. We can ignore a failure
1324 * to open if such an optional file does not exist, but we do want to
1325 * report a failure in opening for other reasons (e.g. we got an I/O
1326 * error, or the file is there, but we lack the permission to open).
1328 * Call this function after seeing an error from open() or fopen() to
1329 * see if the errno indicates a missing file that we can safely ignore.
1331 static inline int is_missing_file_error(int errno_
)
1333 return (errno_
== ENOENT
|| errno_
== ENOTDIR
);
1336 int cmd_main(int, const char **);
1339 * Intercept all calls to exit() and route them to trace2 to
1340 * optionally emit a message before calling the real exit().
1342 int trace2_cmd_exit_fl(const char *file
, int line
, int code
);
1343 #define exit(code) exit(trace2_cmd_exit_fl(__FILE__, __LINE__, (code)))
1346 * You can mark a stack variable with UNLEAK(var) to avoid it being
1347 * reported as a leak by tools like LSAN or valgrind. The argument
1348 * should generally be the variable itself (not its address and not what
1349 * it points to). It's safe to use this on pointers which may already
1350 * have been freed, or on pointers which may still be in use.
1352 * Use this _only_ for a variable that leaks by going out of scope at
1353 * program exit (so only from cmd_* functions or their direct helpers).
1354 * Normal functions, especially those which may be called multiple
1355 * times, should actually free their memory. This is only meant as
1356 * an annotation, and does nothing in non-leak-checking builds.
1358 #ifdef SUPPRESS_ANNOTATED_LEAKS
1359 void unleak_memory(const void *ptr
, size_t len
);
1360 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1362 #define UNLEAK(var) do {} while (0)
1366 * This include must come after system headers, since it introduces macros that
1367 * replace system names.
1372 * container_of - Get the address of an object containing a field.
1374 * @ptr: pointer to the field.
1375 * @type: type of the object.
1376 * @member: name of the field within the object.
1378 #define container_of(ptr, type, member) \
1379 ((type *) ((char *)(ptr) - offsetof(type, member)))
1382 * helper function for `container_of_or_null' to avoid multiple
1383 * evaluation of @ptr
1385 static inline void *container_of_or_null_offset(void *ptr
, size_t offset
)
1387 return ptr
? (char *)ptr
- offset
: NULL
;
1391 * like `container_of', but allows returned value to be NULL
1393 #define container_of_or_null(ptr, type, member) \
1394 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1397 * like offsetof(), but takes a pointer to a variable of type which
1398 * contains @member, instead of a specified type.
1399 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1402 #if defined(__GNUC__) /* clang sets this, too */
1403 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1404 #else /* !__GNUC__ */
1405 #define OFFSETOF_VAR(ptr, member) \
1406 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1407 #endif /* !__GNUC__ */
1409 void sleep_millisec(int millisec
);