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.
49 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
50 # define FLEX_ARRAY /* empty */
51 #elif defined(__GNUC__)
53 # define FLEX_ARRAY /* empty */
55 # define FLEX_ARRAY 0 /* older GNU extension */
60 * Otherwise, default to safer but a bit wasteful traditional style
69 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
70 * @cond: the compile-time condition which must be true.
72 * Your compile will fail if the condition isn't true, or can't be evaluated
73 * by the compiler. This can be used in an expression: its value is "0".
76 * #define foo_to_char(foo) \
78 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
80 #define BUILD_ASSERT_OR_ZERO(cond) \
81 (sizeof(char [1 - 2*!(cond)]) - 1)
83 #if GIT_GNUC_PREREQ(3, 1)
84 /* &arr[0] degrades to a pointer: a different type from an array */
85 # define BARF_UNLESS_AN_ARRAY(arr) \
86 BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
87 __typeof__(&(arr)[0])))
89 # define BARF_UNLESS_AN_ARRAY(arr) 0
92 * ARRAY_SIZE - get the number of elements in a visible array
93 * @x: the array whose size you want.
95 * This does not work on pointers, or arrays declared as [], or
96 * function parameters. With correct compiler support, such usage
97 * will cause a build error (see the build_assert_or_zero macro).
99 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
101 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
103 #define maximum_signed_value_of_type(a) \
104 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
106 #define maximum_unsigned_value_of_type(a) \
107 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
110 * Signed integer overflow is undefined in C, so here's a helper macro
111 * to detect if the sum of two integers will overflow.
113 * Requires: a >= 0, typeof(a) equals typeof(b)
115 #define signed_add_overflows(a, b) \
116 ((b) > maximum_signed_value_of_type(a) - (a))
118 #define unsigned_add_overflows(a, b) \
119 ((b) > maximum_unsigned_value_of_type(a) - (a))
122 * Returns true if the multiplication of "a" and "b" will
123 * overflow. The types of "a" and "b" must match and must be unsigned.
124 * Note that this macro evaluates "a" twice!
126 #define unsigned_mult_overflows(a, b) \
127 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
130 * Returns true if the left shift of "a" by "shift" bits will
131 * overflow. The type of "a" must be unsigned.
133 #define unsigned_left_shift_overflows(a, shift) \
134 ((shift) < bitsizeof(a) && \
135 (a) > maximum_unsigned_value_of_type(a) >> (shift))
138 #define TYPEOF(x) (__typeof__(x))
143 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
144 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
146 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
148 /* Approximation of the length of the decimal representation of this type. */
149 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
153 * On Solaris, when _XOPEN_EXTENDED is set, its header file
154 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
155 * setting to say we are XPG5 or XPG6. Also on Solaris,
156 * XPG6 programs must be compiled with a c99 compiler, while
157 * non XPG6 programs must be compiled with a pre-c99 compiler.
159 # if __STDC_VERSION__ - 0 >= 199901L
160 # define _XOPEN_SOURCE 600
162 # define _XOPEN_SOURCE 500
164 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
165 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
166 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
168 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
169 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
171 #define _ALL_SOURCE 1
172 #define _GNU_SOURCE 1
173 #define _BSD_SOURCE 1
174 #define _DEFAULT_SOURCE 1
175 #define _NETBSD_SOURCE 1
176 #define _SGI_SOURCE 1
178 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
179 # if !defined(_WIN32_WINNT)
180 # define _WIN32_WINNT 0x0600
182 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
183 #include <winsock2.h>
184 #ifndef NO_UNIX_SOCKETS
188 #define GIT_WINDOWS_NATIVE
193 #include <sys/stat.h>
199 #ifdef HAVE_STRINGS_H
200 #include <strings.h> /* for strcasecmp() */
204 #ifdef NEEDS_SYS_PARAM_H
205 #include <sys/param.h>
207 #include <sys/types.h>
209 #include <sys/time.h>
216 #if !defined(NO_POLL_H)
218 #elif !defined(NO_SYS_POLL_H)
219 #include <sys/poll.h>
221 /* Pull the compat stuff */
224 #ifdef HAVE_BSD_SYSCTL
225 #include <sys/sysctl.h>
228 #if defined(__CYGWIN__)
229 #include "compat/win32/path-utils.h"
231 #if defined(__MINGW32__)
232 /* pull in Windows compatibility stuff */
233 #include "compat/win32/path-utils.h"
234 #include "compat/mingw.h"
235 #elif defined(_MSC_VER)
236 #include "compat/win32/path-utils.h"
237 #include "compat/msvc.h"
239 #include <sys/utsname.h>
240 #include <sys/wait.h>
241 #include <sys/resource.h>
242 #include <sys/socket.h>
243 #include <sys/ioctl.h>
245 #ifndef NO_SYS_SELECT_H
246 #include <sys/select.h>
248 #include <netinet/in.h>
249 #include <netinet/tcp.h>
250 #include <arpa/inet.h>
254 #ifndef NO_INTTYPES_H
255 #include <inttypes.h>
261 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
262 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
263 * while on IP16 and IP16L32 it is "int" (resp. "short")
264 * Size needs to match (or exceed) 'sizeof(void *)'.
265 * We can't take "long long" here as not everybody has it.
267 typedef long intptr_t;
268 typedef unsigned long uintptr_t;
270 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
272 #define _ALL_SOURCE 1
275 /* used on Mac OS X */
276 #ifdef PRECOMPOSE_UNICODE
277 #include "compat/precompose_utf8.h"
279 static inline const char *precompose_argv_prefix(int argc
, const char **argv
, const char *prefix
)
283 static inline const char *precompose_string_if_needed(const char *in
)
288 #define probe_utf8_pathname_composition()
291 #ifdef MKDIR_WO_TRAILING_SLASH
292 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
293 int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
296 #ifdef NO_STRUCT_ITIMERVAL
298 struct timeval it_interval
;
299 struct timeval it_value
;
304 static inline int setitimer(int which
, const struct itimerval
*value
, struct itimerval
*newvalue
) {
305 return 0; /* pretend success */
312 #define basename gitbasename
313 char *gitbasename(char *);
314 #define dirname gitdirname
315 char *gitdirname(char *);
324 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
325 #include <AvailabilityMacros.h>
326 #undef DEPRECATED_ATTRIBUTE
327 #define DEPRECATED_ATTRIBUTE
328 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
330 #include <openssl/ssl.h>
331 #include <openssl/err.h>
335 # include <sys/sysinfo.h>
338 /* On most systems <netdb.h> would have given us this, but
339 * not on some systems (e.g. z/OS).
342 #define NI_MAXHOST 1025
346 #define NI_MAXSERV 32
349 /* On most systems <limits.h> would have given us this, but
350 * not on some systems (e.g. GNU/Hurd).
353 #define PATH_MAX 4096
356 typedef uintmax_t timestamp_t
;
357 #define PRItime PRIuMAX
358 #define parse_timestamp strtoumax
359 #define TIME_MAX UINTMAX_MAX
369 #ifndef _PATH_DEFPATH
370 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
373 #ifndef platform_core_config
374 static inline int noop_core_config(const char *var
, const char *value
, void *cb
)
378 #define platform_core_config noop_core_config
381 int lstat_cache_aware_rmdir(const char *path
);
382 #if !defined(__MINGW32__) && !defined(_MSC_VER)
383 #define rmdir lstat_cache_aware_rmdir
386 #ifndef has_dos_drive_prefix
387 static inline int git_has_dos_drive_prefix(const char *path
)
391 #define has_dos_drive_prefix git_has_dos_drive_prefix
394 #ifndef skip_dos_drive_prefix
395 static inline int git_skip_dos_drive_prefix(char **path
)
399 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
403 static inline int git_is_dir_sep(int c
)
407 #define is_dir_sep git_is_dir_sep
410 #ifndef offset_1st_component
411 static inline int git_offset_1st_component(const char *path
)
413 return is_dir_sep(path
[0]);
415 #define offset_1st_component git_offset_1st_component
418 #ifndef is_valid_path
419 #define is_valid_path(path) 1
422 #ifndef find_last_dir_sep
423 static inline char *git_find_last_dir_sep(const char *path
)
425 return strrchr(path
, '/');
427 #define find_last_dir_sep git_find_last_dir_sep
431 static inline int git_has_dir_sep(const char *path
)
433 return !!strchr(path
, '/');
435 #define has_dir_sep(path) git_has_dir_sep(path)
438 #ifndef query_user_email
439 #define query_user_email() NULL
443 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
444 #include <floss.h(floss_getpwuid)>
447 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
448 * known, by detective work using kill -l as a list is all signals
449 * instead of signal.h where it should be.
455 #if defined(__HP_cc) && (__HP_cc >= 61000)
456 #define NORETURN __attribute__((noreturn))
458 #elif defined(__GNUC__) && !defined(NO_NORETURN)
459 #define NORETURN __attribute__((__noreturn__))
460 #define NORETURN_PTR __attribute__((__noreturn__))
461 #elif defined(_MSC_VER)
462 #define NORETURN __declspec(noreturn)
468 #ifndef __attribute__
469 #define __attribute__(x)
474 /* The sentinel attribute is valid from gcc version 4.0 */
475 #if defined(__GNUC__) && (__GNUC__ >= 4)
476 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
478 #define LAST_ARG_MUST_BE_NULL
481 #define MAYBE_UNUSED __attribute__((__unused__))
483 #include "compat/bswap.h"
485 #include "wildmatch.h"
489 /* General helper functions */
490 void vreportf(const char *prefix
, const char *err
, va_list params
);
491 NORETURN
void usage(const char *err
);
492 NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
493 NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
494 NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
495 int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
496 int error_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
497 void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
498 void warning_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
501 #ifdef APPLE_COMMON_CRYPTO
502 #include "compat/apple-common-crypto.h"
504 #include <openssl/evp.h>
505 #include <openssl/hmac.h>
506 #endif /* APPLE_COMMON_CRYPTO */
507 #include <openssl/x509v3.h>
508 #endif /* NO_OPENSSL */
511 * Let callers be aware of the constant return value; this can help
512 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
513 * because some compilers may not support variadic macros. Since we're only
514 * trying to help gcc, anyway, it's OK; other compilers will fall back to
515 * using the function as usual.
517 #if defined(__GNUC__)
518 static inline int const_error(void)
522 #define error(...) (error(__VA_ARGS__), const_error())
523 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
526 typedef void (*report_fn
)(const char *, va_list params
);
528 void set_die_routine(NORETURN_PTR report_fn routine
);
529 void set_error_routine(report_fn routine
);
530 report_fn
get_error_routine(void);
531 void set_warn_routine(report_fn routine
);
532 report_fn
get_warn_routine(void);
533 void set_die_is_recursing_routine(int (*routine
)(void));
535 int starts_with(const char *str
, const char *prefix
);
536 int istarts_with(const char *str
, const char *prefix
);
539 * If the string "str" begins with the string found in "prefix", return 1.
540 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
541 * the string right after the prefix).
543 * Otherwise, return 0 and leave "out" untouched.
547 * [extract branch name, fail if not a branch]
548 * if (!skip_prefix(ref, "refs/heads/", &branch)
551 * [skip prefix if present, otherwise use whole string]
552 * skip_prefix(name, "refs/heads/", &name);
554 static inline int skip_prefix(const char *str
, const char *prefix
,
562 } while (*str
++ == *prefix
++);
567 * If the string "str" is the same as the string in "prefix", then the "arg"
568 * parameter is set to the "def" parameter and 1 is returned.
569 * If the string "str" begins with the string found in "prefix" and then a
570 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
571 * (i.e., to the point in the string right after the prefix and the "=" sign),
574 * Otherwise, return 0 and leave "arg" untouched.
576 * When we accept both a "--key" and a "--key=<val>" option, this function
577 * can be used instead of !strcmp(arg, "--key") and then
578 * skip_prefix(arg, "--key=", &arg) to parse such an option.
580 int skip_to_optional_arg_default(const char *str
, const char *prefix
,
581 const char **arg
, const char *def
);
583 static inline int skip_to_optional_arg(const char *str
, const char *prefix
,
586 return skip_to_optional_arg_default(str
, prefix
, arg
, "");
590 * Like skip_prefix, but promises never to read past "len" bytes of the input
591 * buffer, and returns the remaining number of bytes in "out" via "outlen".
593 static inline int skip_prefix_mem(const char *buf
, size_t len
,
595 const char **out
, size_t *outlen
)
597 size_t prefix_len
= strlen(prefix
);
598 if (prefix_len
<= len
&& !memcmp(buf
, prefix
, prefix_len
)) {
599 *out
= buf
+ prefix_len
;
600 *outlen
= len
- prefix_len
;
607 * If buf ends with suffix, return 1 and subtract the length of the suffix
608 * from *len. Otherwise, return 0 and leave *len untouched.
610 static inline int strip_suffix_mem(const char *buf
, size_t *len
,
613 size_t suflen
= strlen(suffix
);
614 if (*len
< suflen
|| memcmp(buf
+ (*len
- suflen
), suffix
, suflen
))
621 * If str ends with suffix, return 1 and set *len to the size of the string
622 * without the suffix. Otherwise, return 0 and set *len to the size of the
625 * Note that we do _not_ NUL-terminate str to the new length.
627 static inline int strip_suffix(const char *str
, const char *suffix
, size_t *len
)
630 return strip_suffix_mem(str
, len
, suffix
);
633 static inline int ends_with(const char *str
, const char *suffix
)
636 return strip_suffix(str
, suffix
, &len
);
639 #define SWAP(a, b) do { \
640 void *_swap_a_ptr = &(a); \
641 void *_swap_b_ptr = &(b); \
642 unsigned char _swap_buffer[sizeof(a)]; \
643 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
644 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
645 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
646 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
649 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
654 #define MAP_PRIVATE 1
657 #define mmap git_mmap
658 #define munmap git_munmap
659 void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
660 int git_munmap(void *start
, size_t length
);
662 #else /* NO_MMAP || USE_WIN32_MMAP */
664 #include <sys/mman.h>
666 #endif /* NO_MMAP || USE_WIN32_MMAP */
670 /* This value must be multiple of (pagesize * 2) */
671 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
675 /* This value must be multiple of (pagesize * 2) */
676 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
677 (sizeof(void*) >= 8 \
678 ? 1 * 1024 * 1024 * 1024 \
684 #define MAP_FAILED ((void *)-1)
687 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
688 #define on_disk_bytes(st) ((st).st_size)
690 #define on_disk_bytes(st) ((st).st_blocks * 512)
693 #ifdef NEEDS_MODE_TRANSLATION
702 #define S_IFMT 0170000
703 #define S_IFREG 0100000
704 #define S_IFDIR 0040000
705 #define S_IFLNK 0120000
706 #define S_IFBLK 0060000
707 #define S_IFCHR 0020000
708 #define S_IFIFO 0010000
709 #define S_IFSOCK 0140000
713 #define stat(path, buf) git_stat(path, buf)
714 int git_stat(const char *, struct stat
*);
718 #define fstat(fd, buf) git_fstat(fd, buf)
719 int git_fstat(int, struct stat
*);
723 #define lstat(path, buf) git_lstat(path, buf)
724 int git_lstat(const char *, struct stat
*);
727 #define DEFAULT_PACKED_GIT_LIMIT \
728 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
731 #define pread git_pread
732 ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
735 * Forward decl that will remind us if its twin in cache.h changes.
736 * This function is used in compat/pread.c. But we can't include
739 ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
742 #define setenv gitsetenv
743 int gitsetenv(const char *, const char *, int);
747 #define mkdtemp gitmkdtemp
748 char *gitmkdtemp(char *);
752 #define unsetenv gitunsetenv
753 int gitunsetenv(const char *);
757 #define strcasestr gitstrcasestr
758 char *gitstrcasestr(const char *haystack
, const char *needle
);
762 #define strlcpy gitstrlcpy
763 size_t gitstrlcpy(char *, const char *, size_t);
767 #define strtoumax gitstrtoumax
768 uintmax_t gitstrtoumax(const char *, char **, int);
769 #define strtoimax gitstrtoimax
770 intmax_t gitstrtoimax(const char *, char **, int);
774 #define hstrerror githstrerror
775 const char *githstrerror(int herror
);
779 #define memmem gitmemmem
780 void *gitmemmem(const void *haystack
, size_t haystacklen
,
781 const void *needle
, size_t needlelen
);
784 #ifdef OVERRIDE_STRDUP
788 #define strdup gitstrdup
789 char *gitstrdup(const char *s
);
792 #ifdef NO_GETPAGESIZE
793 #define getpagesize() sysconf(_SC_PAGESIZE)
800 #ifdef FREAD_READS_DIRECTORIES
801 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
805 # define fopen(a,b) git_fopen(a,b)
807 FILE *git_fopen(const char*, const char*);
810 #ifdef SNPRINTF_RETURNS_BOGUS
814 #define snprintf git_snprintf
815 int git_snprintf(char *str
, size_t maxsize
,
816 const char *format
, ...);
820 #define vsnprintf git_vsnprintf
821 int git_vsnprintf(char *str
, size_t maxsize
,
822 const char *format
, va_list ap
);
825 #ifdef OPEN_RETURNS_EINTR
827 #define open git_open_with_retry
828 int git_open_with_retry(const char *path
, int flag
, ...);
831 #ifdef __GLIBC_PREREQ
832 #if __GLIBC_PREREQ(2, 1)
833 #define HAVE_STRCHRNUL
837 #ifndef HAVE_STRCHRNUL
838 #define strchrnul gitstrchrnul
839 static inline char *gitstrchrnul(const char *s
, int c
)
841 while (*s
&& *s
!= c
)
848 int inet_pton(int af
, const char *src
, void *dst
);
852 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
856 #define atexit git_atexit
857 int git_atexit(void (*handler
)(void));
860 static inline size_t st_add(size_t a
, size_t b
)
862 if (unsigned_add_overflows(a
, b
))
863 die("size_t overflow: %"PRIuMAX
" + %"PRIuMAX
,
864 (uintmax_t)a
, (uintmax_t)b
);
867 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
868 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
870 static inline size_t st_mult(size_t a
, size_t b
)
872 if (unsigned_mult_overflows(a
, b
))
873 die("size_t overflow: %"PRIuMAX
" * %"PRIuMAX
,
874 (uintmax_t)a
, (uintmax_t)b
);
878 static inline size_t st_sub(size_t a
, size_t b
)
881 die("size_t underflow: %"PRIuMAX
" - %"PRIuMAX
,
882 (uintmax_t)a
, (uintmax_t)b
);
886 static inline size_t st_left_shift(size_t a
, unsigned shift
)
888 if (unsigned_left_shift_overflows(a
, shift
))
889 die("size_t overflow: %"PRIuMAX
" << %u",
890 (uintmax_t)a
, shift
);
894 static inline unsigned long cast_size_t_to_ulong(size_t a
)
896 if (a
!= (unsigned long)a
)
897 die("object too large to read on this platform: %"
898 PRIuMAX
" is cut off to %lu",
899 (uintmax_t)a
, (unsigned long)a
);
900 return (unsigned long)a
;
905 # define xalloca(size) (alloca(size))
906 # define xalloca_free(p) do {} while (0)
908 # define xalloca(size) (xmalloc(size))
909 # define xalloca_free(p) (free(p))
911 char *xstrdup(const char *str
);
912 void *xmalloc(size_t size
);
913 void *xmallocz(size_t size
);
914 void *xmallocz_gently(size_t size
);
915 void *xmemdupz(const void *data
, size_t len
);
916 char *xstrndup(const char *str
, size_t len
);
917 void *xrealloc(void *ptr
, size_t size
);
918 void *xcalloc(size_t nmemb
, size_t size
);
919 void xsetenv(const char *name
, const char *value
, int overwrite
);
920 void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
921 const char *mmap_os_err(void);
922 void *xmmap_gently(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
923 int xopen(const char *path
, int flags
, ...);
924 ssize_t
xread(int fd
, void *buf
, size_t len
);
925 ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
926 ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
);
928 FILE *xfopen(const char *path
, const char *mode
);
929 FILE *xfdopen(int fd
, const char *mode
);
930 int xmkstemp(char *temp_filename
);
931 int xmkstemp_mode(char *temp_filename
, int mode
);
933 FILE *fopen_for_writing(const char *path
);
934 FILE *fopen_or_warn(const char *path
, const char *mode
);
937 * Like strncmp, but only return zero if s is NUL-terminated and exactly len
938 * characters long. If it is not, consider it greater than t.
940 int xstrncmpz(const char *s
, const char *t
, size_t len
);
943 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
944 * that ptr is used twice, so don't pass e.g. ptr++.
946 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
948 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
949 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
950 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
952 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
953 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
954 static inline void copy_array(void *dst
, const void *src
, size_t n
, size_t size
)
957 memcpy(dst
, src
, st_mult(size
, n
));
960 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
961 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
962 static inline void move_array(void *dst
, const void *src
, size_t n
, size_t size
)
965 memmove(dst
, src
, st_mult(size
, n
));
969 * These functions help you allocate structs with flex arrays, and copy
970 * the data directly into the array. For example, if you had:
974 * char name[FLEX_ARRAY];
980 * FLEX_ALLOC_MEM(f, name, src, len);
982 * to allocate a "foo" with the contents of "src" in the "name" field.
983 * The resulting struct is automatically zero'd, and the flex-array field
984 * is NUL-terminated (whether the incoming src buffer was or not).
986 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
987 * but do want to store a pointer to some extra data in the same allocated
988 * block. For example, if you have:
998 * FLEXPTR_ALLOC_STR(f, name, src);
1000 * and "name" will point to a block of memory after the struct, which will be
1001 * freed along with the struct (but the pointer can be repointed anywhere).
1003 * The *_STR variants accept a string parameter rather than a ptr/len
1006 * Note that these macros will evaluate the first parameter multiple
1007 * times, and it must be assignable as an lvalue.
1009 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
1010 size_t flex_array_len_ = (len); \
1011 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1012 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
1014 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
1015 size_t flex_array_len_ = (len); \
1016 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1017 memcpy((x) + 1, (buf), flex_array_len_); \
1018 (x)->ptrname = (void *)((x)+1); \
1020 #define FLEX_ALLOC_STR(x, flexname, str) \
1021 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1022 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1023 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1025 static inline char *xstrdup_or_null(const char *str
)
1027 return str
? xstrdup(str
) : NULL
;
1030 static inline size_t xsize_t(off_t len
)
1032 if (len
< 0 || (uintmax_t) len
> SIZE_MAX
)
1033 die("Cannot handle files this big");
1034 return (size_t) len
;
1037 __attribute__((format (printf
, 3, 4)))
1038 int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...);
1040 #ifndef HOST_NAME_MAX
1041 #define HOST_NAME_MAX 256
1044 int xgethostname(char *buf
, size_t len
);
1046 /* in ctype.c, for kwset users */
1047 extern const unsigned char tolower_trans_tbl
[256];
1049 /* Sane ctype - no locale, and works with signed chars */
1064 extern const unsigned char sane_ctype
[256];
1065 #define GIT_SPACE 0x01
1066 #define GIT_DIGIT 0x02
1067 #define GIT_ALPHA 0x04
1068 #define GIT_GLOB_SPECIAL 0x08
1069 #define GIT_REGEX_SPECIAL 0x10
1070 #define GIT_PATHSPEC_MAGIC 0x20
1071 #define GIT_CNTRL 0x40
1072 #define GIT_PUNCT 0x80
1073 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1074 #define isascii(x) (((x) & ~0x7f) == 0)
1075 #define isspace(x) sane_istest(x,GIT_SPACE)
1076 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1077 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1078 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1079 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1080 #define islower(x) sane_iscase(x, 1)
1081 #define isupper(x) sane_iscase(x, 0)
1082 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1083 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1084 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1085 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1086 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1087 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1088 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1089 #define toupper(x) sane_case((unsigned char)(x), 0)
1090 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1092 static inline int sane_case(int x
, int high
)
1094 if (sane_istest(x
, GIT_ALPHA
))
1095 x
= (x
& ~0x20) | high
;
1099 static inline int sane_iscase(int x
, int is_lower
)
1101 if (!sane_istest(x
, GIT_ALPHA
))
1105 return (x
& 0x20) != 0;
1107 return (x
& 0x20) == 0;
1111 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1112 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1113 * locale-specific conversions).
1115 static inline int skip_iprefix(const char *str
, const char *prefix
,
1123 } while (tolower(*str
++) == tolower(*prefix
++));
1127 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
1133 /* negative values would be accepted by strtoul */
1136 ul
= strtoul(s
, &p
, base
);
1137 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
1143 static inline int strtol_i(char const *s
, int base
, int *result
)
1149 ul
= strtol(s
, &p
, base
);
1150 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
1156 void git_stable_qsort(void *base
, size_t nmemb
, size_t size
,
1157 int(*compar
)(const void *, const void *));
1158 #ifdef INTERNAL_QSORT
1159 #define qsort git_stable_qsort
1162 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1163 static inline void sane_qsort(void *base
, size_t nmemb
, size_t size
,
1164 int(*compar
)(const void *, const void *))
1167 qsort(base
, nmemb
, size
, compar
);
1170 #define STABLE_QSORT(base, n, compar) \
1171 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1173 #ifndef HAVE_ISO_QSORT_S
1174 int git_qsort_s(void *base
, size_t nmemb
, size_t size
,
1175 int (*compar
)(const void *, const void *, void *), void *ctx
);
1176 #define qsort_s git_qsort_s
1179 #define QSORT_S(base, n, compar, ctx) do { \
1180 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1181 BUG("qsort_s() failed"); \
1184 #ifndef REG_STARTEND
1185 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1188 static inline int regexec_buf(const regex_t
*preg
, const char *buf
, size_t size
,
1189 size_t nmatch
, regmatch_t pmatch
[], int eflags
)
1191 assert(nmatch
> 0 && pmatch
);
1192 pmatch
[0].rm_so
= 0;
1193 pmatch
[0].rm_eo
= size
;
1194 return regexec(preg
, buf
, nmatch
, pmatch
, eflags
| REG_STARTEND
);
1197 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1198 # define FORCE_DIR_SET_GID S_ISGID
1200 # define FORCE_DIR_SET_GID 0
1205 #define ST_CTIME_NSEC(st) 0
1206 #define ST_MTIME_NSEC(st) 0
1208 #ifdef USE_ST_TIMESPEC
1209 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1210 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1212 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1213 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1217 #ifdef UNRELIABLE_FSTAT
1218 #define fstat_is_reliable() 0
1220 #define fstat_is_reliable() 1
1225 * Since an obvious implementation of va_list would be to make it a
1226 * pointer into the stack frame, a simple assignment will work on
1227 * many systems. But let's try to be more portable.
1230 #define va_copy(dst, src) __va_copy(dst, src)
1232 #define va_copy(dst, src) ((dst) = (src))
1237 * This is always defined as a first step towards making the use of variadic
1238 * macros unconditional. If it causes compilation problems on your platform,
1239 * please report it to the Git mailing list at git@vger.kernel.org.
1241 #define HAVE_VARIADIC_MACROS 1
1243 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1244 extern int BUG_exit_code
;
1246 #ifdef HAVE_VARIADIC_MACROS
1247 __attribute__((format (printf
, 3, 4))) NORETURN
1248 void BUG_fl(const char *file
, int line
, const char *fmt
, ...);
1249 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1251 __attribute__((format (printf
, 1, 2))) NORETURN
1252 void BUG(const char *fmt
, ...);
1256 * Preserves errno, prints a message, but gives no warning for ENOENT.
1257 * Returns 0 on success, which includes trying to unlink an object that does
1260 int unlink_or_warn(const char *path
);
1262 * Tries to unlink file. Returns 0 if unlink succeeded
1263 * or the file already didn't exist. Returns -1 and
1264 * appends a message to err suitable for
1265 * 'error("%s", err->buf)' on error.
1267 int unlink_or_msg(const char *file
, struct strbuf
*err
);
1269 * Preserves errno, prints a message, but gives no warning for ENOENT.
1270 * Returns 0 on success, which includes trying to remove a directory that does
1273 int rmdir_or_warn(const char *path
);
1275 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1276 * the supplied file mode.
1278 int remove_or_warn(unsigned int mode
, const char *path
);
1281 * Call access(2), but warn for any error except "missing file"
1282 * (ENOENT or ENOTDIR).
1284 #define ACCESS_EACCES_OK (1U << 0)
1285 int access_or_warn(const char *path
, int mode
, unsigned flag
);
1286 int access_or_die(const char *path
, int mode
, unsigned flag
);
1288 /* Warn on an inaccessible file if errno indicates this is an error */
1289 int warn_on_fopen_errors(const char *path
);
1292 * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent
1293 * may be racy. Do not use this as protection against an attacker who can
1294 * simultaneously create paths.
1296 int open_nofollow(const char *path
, int flags
);
1299 # define SHELL_PATH "/bin/sh"
1302 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1303 static inline void flockfile(FILE *fh
)
1307 static inline void funlockfile(FILE *fh
)
1311 #define getc_unlocked(fh) getc(fh)
1314 #ifdef FILENO_IS_A_MACRO
1315 int git_fileno(FILE *stream
);
1316 # ifndef COMPAT_CODE_FILENO
1318 # define fileno(p) git_fileno(p)
1322 #ifdef NEED_ACCESS_ROOT_HANDLER
1323 int git_access(const char *path
, int mode
);
1324 # ifndef COMPAT_CODE_ACCESS
1328 # define access(path, mode) git_access(path, mode)
1333 * Our code often opens a path to an optional file, to work on its
1334 * contents when we can successfully open it. We can ignore a failure
1335 * to open if such an optional file does not exist, but we do want to
1336 * report a failure in opening for other reasons (e.g. we got an I/O
1337 * error, or the file is there, but we lack the permission to open).
1339 * Call this function after seeing an error from open() or fopen() to
1340 * see if the errno indicates a missing file that we can safely ignore.
1342 static inline int is_missing_file_error(int errno_
)
1344 return (errno_
== ENOENT
|| errno_
== ENOTDIR
);
1347 int cmd_main(int, const char **);
1350 * Intercept all calls to exit() and route them to trace2 to
1351 * optionally emit a message before calling the real exit().
1353 int trace2_cmd_exit_fl(const char *file
, int line
, int code
);
1354 #define exit(code) exit(trace2_cmd_exit_fl(__FILE__, __LINE__, (code)))
1357 * You can mark a stack variable with UNLEAK(var) to avoid it being
1358 * reported as a leak by tools like LSAN or valgrind. The argument
1359 * should generally be the variable itself (not its address and not what
1360 * it points to). It's safe to use this on pointers which may already
1361 * have been freed, or on pointers which may still be in use.
1363 * Use this _only_ for a variable that leaks by going out of scope at
1364 * program exit (so only from cmd_* functions or their direct helpers).
1365 * Normal functions, especially those which may be called multiple
1366 * times, should actually free their memory. This is only meant as
1367 * an annotation, and does nothing in non-leak-checking builds.
1369 #ifdef SUPPRESS_ANNOTATED_LEAKS
1370 void unleak_memory(const void *ptr
, size_t len
);
1371 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1373 #define UNLEAK(var) do {} while (0)
1377 * This include must come after system headers, since it introduces macros that
1378 * replace system names.
1383 * container_of - Get the address of an object containing a field.
1385 * @ptr: pointer to the field.
1386 * @type: type of the object.
1387 * @member: name of the field within the object.
1389 #define container_of(ptr, type, member) \
1390 ((type *) ((char *)(ptr) - offsetof(type, member)))
1393 * helper function for `container_of_or_null' to avoid multiple
1394 * evaluation of @ptr
1396 static inline void *container_of_or_null_offset(void *ptr
, size_t offset
)
1398 return ptr
? (char *)ptr
- offset
: NULL
;
1402 * like `container_of', but allows returned value to be NULL
1404 #define container_of_or_null(ptr, type, member) \
1405 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1408 * like offsetof(), but takes a pointer to a variable of type which
1409 * contains @member, instead of a specified type.
1410 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1413 #if defined(__GNUC__) /* clang sets this, too */
1414 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1415 #else /* !__GNUC__ */
1416 #define OFFSETOF_VAR(ptr, member) \
1417 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1418 #endif /* !__GNUC__ */
1420 void sleep_millisec(int millisec
);