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.
29 #define _FILE_OFFSET_BITS 64
32 /* Derived from Linux "Features Test Macro" header
33 * Convenience macros to test the versions of gcc (or
34 * a compatible compiler).
36 * #if GIT_GNUC_PREREQ (2,8)
37 * ... code requiring gcc 2.8 or later ...
40 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
41 # define GIT_GNUC_PREREQ(maj, min) \
42 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
44 #define GIT_GNUC_PREREQ(maj, min) 0
50 * See if our compiler is known to support flexible array members.
54 * Check vendor specific quirks first, before checking the
55 * __STDC_VERSION__, as vendor compilers can lie and we need to be
56 * able to work them around. Note that by not defining FLEX_ARRAY
57 * here, we can fall back to use the "safer but a bit wasteful" one
60 #if defined(__SUNPRO_C) && (__SUNPRO_C <= 0x580)
61 #elif defined(__GNUC__)
63 # define FLEX_ARRAY /* empty */
65 # define FLEX_ARRAY 0 /* older GNU extension */
67 #elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
68 # define FLEX_ARRAY /* empty */
72 * Otherwise, default to safer but a bit wasteful traditional style
81 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
82 * @cond: the compile-time condition which must be true.
84 * Your compile will fail if the condition isn't true, or can't be evaluated
85 * by the compiler. This can be used in an expression: its value is "0".
88 * #define foo_to_char(foo) \
90 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
92 #define BUILD_ASSERT_OR_ZERO(cond) \
93 (sizeof(char [1 - 2*!(cond)]) - 1)
95 #if GIT_GNUC_PREREQ(3, 1)
96 /* &arr[0] degrades to a pointer: a different type from an array */
97 # define BARF_UNLESS_AN_ARRAY(arr) \
98 BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
99 __typeof__(&(arr)[0])))
101 # define BARF_UNLESS_AN_ARRAY(arr) 0
104 * ARRAY_SIZE - get the number of elements in a visible array
105 * @x: the array whose size you want.
107 * This does not work on pointers, or arrays declared as [], or
108 * function parameters. With correct compiler support, such usage
109 * will cause a build error (see the build_assert_or_zero macro).
111 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
113 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
115 #define maximum_signed_value_of_type(a) \
116 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
118 #define maximum_unsigned_value_of_type(a) \
119 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
122 * Signed integer overflow is undefined in C, so here's a helper macro
123 * to detect if the sum of two integers will overflow.
125 * Requires: a >= 0, typeof(a) equals typeof(b)
127 #define signed_add_overflows(a, b) \
128 ((b) > maximum_signed_value_of_type(a) - (a))
130 #define unsigned_add_overflows(a, b) \
131 ((b) > maximum_unsigned_value_of_type(a) - (a))
134 * Returns true if the multiplication of "a" and "b" will
135 * overflow. The types of "a" and "b" must match and must be unsigned.
136 * Note that this macro evaluates "a" twice!
138 #define unsigned_mult_overflows(a, b) \
139 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
142 * Returns true if the left shift of "a" by "shift" bits will
143 * overflow. The type of "a" must be unsigned.
145 #define unsigned_left_shift_overflows(a, shift) \
146 ((shift) < bitsizeof(a) && \
147 (a) > maximum_unsigned_value_of_type(a) >> (shift))
150 #define TYPEOF(x) (__typeof__(x))
155 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
156 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
158 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
160 /* Approximation of the length of the decimal representation of this type. */
161 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
164 #define _POSIX_C_SOURCE 1
165 #elif defined(__sun__)
167 * On Solaris, when _XOPEN_EXTENDED is set, its header file
168 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
169 * setting to say we are XPG5 or XPG6. Also on Solaris,
170 * XPG6 programs must be compiled with a c99 compiler, while
171 * non XPG6 programs must be compiled with a pre-c99 compiler.
173 # if __STDC_VERSION__ - 0 >= 199901L
174 # define _XOPEN_SOURCE 600
176 # define _XOPEN_SOURCE 500
178 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
179 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
180 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
182 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
183 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
185 #define _ALL_SOURCE 1
186 #define _GNU_SOURCE 1
187 #define _BSD_SOURCE 1
188 #define _DEFAULT_SOURCE 1
189 #define _NETBSD_SOURCE 1
190 #define _SGI_SOURCE 1
192 #if defined(__GNUC__)
193 #define UNUSED(var) UNUSED_##var __attribute__((unused))
195 #define UNUSED(var) UNUSED_##var
198 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
199 # if !defined(_WIN32_WINNT)
200 # define _WIN32_WINNT 0x0600
202 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
203 #include <winsock2.h>
204 #ifndef NO_UNIX_SOCKETS
208 #define GIT_WINDOWS_NATIVE
213 #include <sys/stat.h>
219 #ifdef HAVE_STRINGS_H
220 #include <strings.h> /* for strcasecmp() */
224 #ifdef NEEDS_SYS_PARAM_H
225 #include <sys/param.h>
227 #include <sys/types.h>
229 #include <sys/time.h>
236 #if !defined(NO_POLL_H)
238 #elif !defined(NO_SYS_POLL_H)
239 #include <sys/poll.h>
241 /* Pull the compat stuff */
244 #ifdef HAVE_BSD_SYSCTL
245 #include <sys/sysctl.h>
248 /* Used by compat/win32/path-utils.h, and more */
249 static inline int is_xplatform_dir_sep(int c
)
251 return c
== '/' || c
== '\\';
254 #if defined(__CYGWIN__)
255 #include "compat/win32/path-utils.h"
257 #if defined(__MINGW32__)
258 /* pull in Windows compatibility stuff */
259 #include "compat/win32/path-utils.h"
260 #include "compat/mingw.h"
261 #elif defined(_MSC_VER)
262 #include "compat/win32/path-utils.h"
263 #include "compat/msvc.h"
265 #include <sys/utsname.h>
266 #include <sys/wait.h>
267 #include <sys/resource.h>
268 #include <sys/socket.h>
269 #include <sys/ioctl.h>
271 #ifndef NO_SYS_SELECT_H
272 #include <sys/select.h>
274 #include <netinet/in.h>
275 #include <netinet/tcp.h>
276 #include <arpa/inet.h>
280 #ifndef NO_INTTYPES_H
281 #include <inttypes.h>
285 #ifdef HAVE_ARC4RANDOM_LIBBSD
286 #include <bsd/stdlib.h>
288 #ifdef HAVE_GETRANDOM
289 #include <sys/random.h>
293 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
294 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
295 * while on IP16 and IP16L32 it is "int" (resp. "short")
296 * Size needs to match (or exceed) 'sizeof(void *)'.
297 * We can't take "long long" here as not everybody has it.
299 typedef long intptr_t;
300 typedef unsigned long uintptr_t;
302 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
304 #define _ALL_SOURCE 1
307 /* used on Mac OS X */
308 #ifdef PRECOMPOSE_UNICODE
309 #include "compat/precompose_utf8.h"
311 static inline const char *precompose_argv_prefix(int argc
, const char **argv
, const char *prefix
)
315 static inline const char *precompose_string_if_needed(const char *in
)
320 #define probe_utf8_pathname_composition()
323 #ifdef MKDIR_WO_TRAILING_SLASH
324 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
325 int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
328 #ifdef NO_STRUCT_ITIMERVAL
330 struct timeval it_interval
;
331 struct timeval it_value
;
336 static inline int setitimer(int which
, const struct itimerval
*value
, struct itimerval
*newvalue
) {
337 return 0; /* pretend success */
344 #define basename gitbasename
345 char *gitbasename(char *);
346 #define dirname gitdirname
347 char *gitdirname(char *);
356 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
357 #include <AvailabilityMacros.h>
358 #undef DEPRECATED_ATTRIBUTE
359 #define DEPRECATED_ATTRIBUTE
360 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
362 #include <openssl/ssl.h>
363 #include <openssl/err.h>
367 # include <sys/sysinfo.h>
370 /* On most systems <netdb.h> would have given us this, but
371 * not on some systems (e.g. z/OS).
374 #define NI_MAXHOST 1025
378 #define NI_MAXSERV 32
381 /* On most systems <limits.h> would have given us this, but
382 * not on some systems (e.g. GNU/Hurd).
385 #define PATH_MAX 4096
388 typedef uintmax_t timestamp_t
;
389 #define PRItime PRIuMAX
390 #define parse_timestamp strtoumax
391 #define TIME_MAX UINTMAX_MAX
401 #ifndef _PATH_DEFPATH
402 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
405 #ifndef platform_core_config
406 static inline int noop_core_config(const char *var
, const char *value
, void *cb
)
410 #define platform_core_config noop_core_config
413 int lstat_cache_aware_rmdir(const char *path
);
414 #if !defined(__MINGW32__) && !defined(_MSC_VER)
415 #define rmdir lstat_cache_aware_rmdir
418 #ifndef has_dos_drive_prefix
419 static inline int git_has_dos_drive_prefix(const char *path
)
423 #define has_dos_drive_prefix git_has_dos_drive_prefix
426 #ifndef skip_dos_drive_prefix
427 static inline int git_skip_dos_drive_prefix(char **path
)
431 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
434 static inline int git_is_dir_sep(int c
)
439 #define is_dir_sep git_is_dir_sep
442 #ifndef offset_1st_component
443 static inline int git_offset_1st_component(const char *path
)
445 return is_dir_sep(path
[0]);
447 #define offset_1st_component git_offset_1st_component
450 #ifndef is_valid_path
451 #define is_valid_path(path) 1
454 #ifndef is_path_owned_by_current_user
457 #define ROOT_UID 65535
463 * Do not use this function when
464 * (1) geteuid() did not say we are running as 'root', or
465 * (2) using this function will compromise the system.
467 * PORTABILITY WARNING:
468 * This code assumes uid_t is unsigned because that is what sudo does.
469 * If your uid_t type is signed and all your ids are positive then it
470 * should all work fine.
471 * If your version of sudo uses negative values for uid_t or it is
472 * buggy and return an overflowed value in SUDO_UID, then git might
473 * fail to grant access to your repository properly or even mistakenly
474 * grant access to someone else.
475 * In the unlikely scenario this happened to you, and that is how you
476 * got to this message, we would like to know about it; so sent us an
477 * email to git@vger.kernel.org indicating which platform you are
478 * using and which version of sudo, so we can improve this logic and
479 * maybe provide you with a patch that would prevent this issue again
482 static inline void extract_id_from_env(const char *env
, uid_t
*id
)
484 const char *real_uid
= getenv(env
);
486 /* discard anything empty to avoid a more complex check below */
487 if (real_uid
&& *real_uid
) {
489 unsigned long env_id
;
492 /* silent overflow errors could trigger a bug here */
493 env_id
= strtoul(real_uid
, &endptr
, 10);
494 if (!*endptr
&& !errno
)
499 static inline int is_path_owned_by_current_uid(const char *path
, struct strbuf
*report
)
504 if (lstat(path
, &st
))
508 if (euid
== ROOT_UID
)
510 if (st
.st_uid
== ROOT_UID
)
513 extract_id_from_env("SUDO_UID", &euid
);
516 return st
.st_uid
== euid
;
519 #define is_path_owned_by_current_user is_path_owned_by_current_uid
522 #ifndef find_last_dir_sep
523 static inline char *git_find_last_dir_sep(const char *path
)
525 return strrchr(path
, '/');
527 #define find_last_dir_sep git_find_last_dir_sep
531 static inline int git_has_dir_sep(const char *path
)
533 return !!strchr(path
, '/');
535 #define has_dir_sep(path) git_has_dir_sep(path)
538 #ifndef query_user_email
539 #define query_user_email() NULL
543 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
544 #include <floss.h(floss_getpwuid)>
547 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
548 * known, by detective work using kill -l as a list is all signals
549 * instead of signal.h where it should be.
555 #if defined(__HP_cc) && (__HP_cc >= 61000)
556 #define NORETURN __attribute__((noreturn))
558 #elif defined(__GNUC__) && !defined(NO_NORETURN)
559 #define NORETURN __attribute__((__noreturn__))
560 #define NORETURN_PTR __attribute__((__noreturn__))
561 #elif defined(_MSC_VER)
562 #define NORETURN __declspec(noreturn)
568 #ifndef __attribute__
569 #define __attribute__(x)
574 /* The sentinel attribute is valid from gcc version 4.0 */
575 #if defined(__GNUC__) && (__GNUC__ >= 4)
576 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
578 #define LAST_ARG_MUST_BE_NULL
581 #define MAYBE_UNUSED __attribute__((__unused__))
583 #include "compat/bswap.h"
585 #include "wildmatch.h"
589 /* General helper functions */
590 NORETURN
void usage(const char *err
);
591 NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
592 NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
593 NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
594 int die_message(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
595 int die_message_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
596 int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
597 int error_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
598 void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
599 void warning_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
602 #ifdef APPLE_COMMON_CRYPTO
603 #include "compat/apple-common-crypto.h"
605 #include <openssl/evp.h>
606 #include <openssl/hmac.h>
607 #endif /* APPLE_COMMON_CRYPTO */
608 #include <openssl/x509v3.h>
609 #endif /* NO_OPENSSL */
611 #ifdef HAVE_OPENSSL_CSPRNG
612 #include <openssl/rand.h>
616 * Let callers be aware of the constant return value; this can help
617 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
618 * because other compilers may be confused by this.
620 #if defined(__GNUC__)
621 static inline int const_error(void)
625 #define error(...) (error(__VA_ARGS__), const_error())
626 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
629 typedef void (*report_fn
)(const char *, va_list params
);
631 void set_die_routine(NORETURN_PTR report_fn routine
);
632 report_fn
get_die_message_routine(void);
633 void set_error_routine(report_fn routine
);
634 report_fn
get_error_routine(void);
635 void set_warn_routine(report_fn routine
);
636 report_fn
get_warn_routine(void);
637 void set_die_is_recursing_routine(int (*routine
)(void));
639 int starts_with(const char *str
, const char *prefix
);
640 int istarts_with(const char *str
, const char *prefix
);
643 * If the string "str" begins with the string found in "prefix", return 1.
644 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
645 * the string right after the prefix).
647 * Otherwise, return 0 and leave "out" untouched.
651 * [extract branch name, fail if not a branch]
652 * if (!skip_prefix(ref, "refs/heads/", &branch)
655 * [skip prefix if present, otherwise use whole string]
656 * skip_prefix(name, "refs/heads/", &name);
658 static inline int skip_prefix(const char *str
, const char *prefix
,
666 } while (*str
++ == *prefix
++);
671 * If the string "str" is the same as the string in "prefix", then the "arg"
672 * parameter is set to the "def" parameter and 1 is returned.
673 * If the string "str" begins with the string found in "prefix" and then a
674 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
675 * (i.e., to the point in the string right after the prefix and the "=" sign),
678 * Otherwise, return 0 and leave "arg" untouched.
680 * When we accept both a "--key" and a "--key=<val>" option, this function
681 * can be used instead of !strcmp(arg, "--key") and then
682 * skip_prefix(arg, "--key=", &arg) to parse such an option.
684 int skip_to_optional_arg_default(const char *str
, const char *prefix
,
685 const char **arg
, const char *def
);
687 static inline int skip_to_optional_arg(const char *str
, const char *prefix
,
690 return skip_to_optional_arg_default(str
, prefix
, arg
, "");
694 * Like skip_prefix, but promises never to read past "len" bytes of the input
695 * buffer, and returns the remaining number of bytes in "out" via "outlen".
697 static inline int skip_prefix_mem(const char *buf
, size_t len
,
699 const char **out
, size_t *outlen
)
701 size_t prefix_len
= strlen(prefix
);
702 if (prefix_len
<= len
&& !memcmp(buf
, prefix
, prefix_len
)) {
703 *out
= buf
+ prefix_len
;
704 *outlen
= len
- prefix_len
;
711 * If buf ends with suffix, return 1 and subtract the length of the suffix
712 * from *len. Otherwise, return 0 and leave *len untouched.
714 static inline int strip_suffix_mem(const char *buf
, size_t *len
,
717 size_t suflen
= strlen(suffix
);
718 if (*len
< suflen
|| memcmp(buf
+ (*len
- suflen
), suffix
, suflen
))
725 * If str ends with suffix, return 1 and set *len to the size of the string
726 * without the suffix. Otherwise, return 0 and set *len to the size of the
729 * Note that we do _not_ NUL-terminate str to the new length.
731 static inline int strip_suffix(const char *str
, const char *suffix
, size_t *len
)
734 return strip_suffix_mem(str
, len
, suffix
);
737 static inline int ends_with(const char *str
, const char *suffix
)
740 return strip_suffix(str
, suffix
, &len
);
743 #define SWAP(a, b) do { \
744 void *_swap_a_ptr = &(a); \
745 void *_swap_b_ptr = &(b); \
746 unsigned char _swap_buffer[sizeof(a)]; \
747 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
748 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
749 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
750 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
753 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
758 #define MAP_PRIVATE 1
761 #define mmap git_mmap
762 #define munmap git_munmap
763 void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
764 int git_munmap(void *start
, size_t length
);
766 #else /* NO_MMAP || USE_WIN32_MMAP */
768 #include <sys/mman.h>
770 #endif /* NO_MMAP || USE_WIN32_MMAP */
774 /* This value must be multiple of (pagesize * 2) */
775 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
779 /* This value must be multiple of (pagesize * 2) */
780 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
781 (sizeof(void*) >= 8 \
782 ? 1 * 1024 * 1024 * 1024 \
788 #define MAP_FAILED ((void *)-1)
791 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
792 #define on_disk_bytes(st) ((st).st_size)
794 #define on_disk_bytes(st) ((st).st_blocks * 512)
797 #ifdef NEEDS_MODE_TRANSLATION
806 #define S_IFMT 0170000
807 #define S_IFREG 0100000
808 #define S_IFDIR 0040000
809 #define S_IFLNK 0120000
810 #define S_IFBLK 0060000
811 #define S_IFCHR 0020000
812 #define S_IFIFO 0010000
813 #define S_IFSOCK 0140000
817 #define stat(path, buf) git_stat(path, buf)
818 int git_stat(const char *, struct stat
*);
822 #define fstat(fd, buf) git_fstat(fd, buf)
823 int git_fstat(int, struct stat
*);
827 #define lstat(path, buf) git_lstat(path, buf)
828 int git_lstat(const char *, struct stat
*);
831 #define DEFAULT_PACKED_GIT_LIMIT \
832 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
835 #define pread git_pread
836 ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
839 * Forward decl that will remind us if its twin in cache.h changes.
840 * This function is used in compat/pread.c. But we can't include
843 ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
846 #define setenv gitsetenv
847 int gitsetenv(const char *, const char *, int);
851 #define mkdtemp gitmkdtemp
852 char *gitmkdtemp(char *);
856 #define unsetenv gitunsetenv
857 int gitunsetenv(const char *);
861 #define strcasestr gitstrcasestr
862 char *gitstrcasestr(const char *haystack
, const char *needle
);
866 #define strlcpy gitstrlcpy
867 size_t gitstrlcpy(char *, const char *, size_t);
871 #define strtoumax gitstrtoumax
872 uintmax_t gitstrtoumax(const char *, char **, int);
873 #define strtoimax gitstrtoimax
874 intmax_t gitstrtoimax(const char *, char **, int);
878 #define hstrerror githstrerror
879 const char *githstrerror(int herror
);
883 #define memmem gitmemmem
884 void *gitmemmem(const void *haystack
, size_t haystacklen
,
885 const void *needle
, size_t needlelen
);
888 #ifdef OVERRIDE_STRDUP
892 #define strdup gitstrdup
893 char *gitstrdup(const char *s
);
896 #ifdef NO_GETPAGESIZE
897 #define getpagesize() sysconf(_SC_PAGESIZE)
904 #ifdef FREAD_READS_DIRECTORIES
905 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
909 # define fopen(a,b) git_fopen(a,b)
911 FILE *git_fopen(const char*, const char*);
914 #ifdef SNPRINTF_RETURNS_BOGUS
918 #define snprintf git_snprintf
919 int git_snprintf(char *str
, size_t maxsize
,
920 const char *format
, ...);
924 #define vsnprintf git_vsnprintf
925 int git_vsnprintf(char *str
, size_t maxsize
,
926 const char *format
, va_list ap
);
929 #ifdef OPEN_RETURNS_EINTR
931 #define open git_open_with_retry
932 int git_open_with_retry(const char *path
, int flag
, ...);
935 #ifdef __GLIBC_PREREQ
936 #if __GLIBC_PREREQ(2, 1)
937 #define HAVE_STRCHRNUL
941 #ifndef HAVE_STRCHRNUL
942 #define strchrnul gitstrchrnul
943 static inline char *gitstrchrnul(const char *s
, int c
)
945 while (*s
&& *s
!= c
)
952 int inet_pton(int af
, const char *src
, void *dst
);
956 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
960 #define atexit git_atexit
961 int git_atexit(void (*handler
)(void));
964 static inline size_t st_add(size_t a
, size_t b
)
966 if (unsigned_add_overflows(a
, b
))
967 die("size_t overflow: %"PRIuMAX
" + %"PRIuMAX
,
968 (uintmax_t)a
, (uintmax_t)b
);
971 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
972 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
974 static inline size_t st_mult(size_t a
, size_t b
)
976 if (unsigned_mult_overflows(a
, b
))
977 die("size_t overflow: %"PRIuMAX
" * %"PRIuMAX
,
978 (uintmax_t)a
, (uintmax_t)b
);
982 static inline size_t st_sub(size_t a
, size_t b
)
985 die("size_t underflow: %"PRIuMAX
" - %"PRIuMAX
,
986 (uintmax_t)a
, (uintmax_t)b
);
990 static inline size_t st_left_shift(size_t a
, unsigned shift
)
992 if (unsigned_left_shift_overflows(a
, shift
))
993 die("size_t overflow: %"PRIuMAX
" << %u",
994 (uintmax_t)a
, shift
);
998 static inline unsigned long cast_size_t_to_ulong(size_t a
)
1000 if (a
!= (unsigned long)a
)
1001 die("object too large to read on this platform: %"
1002 PRIuMAX
" is cut off to %lu",
1003 (uintmax_t)a
, (unsigned long)a
);
1004 return (unsigned long)a
;
1007 #ifdef HAVE_ALLOCA_H
1008 # include <alloca.h>
1009 # define xalloca(size) (alloca(size))
1010 # define xalloca_free(p) do {} while (0)
1012 # define xalloca(size) (xmalloc(size))
1013 # define xalloca_free(p) (free(p))
1015 char *xstrdup(const char *str
);
1016 void *xmalloc(size_t size
);
1017 void *xmallocz(size_t size
);
1018 void *xmallocz_gently(size_t size
);
1019 void *xmemdupz(const void *data
, size_t len
);
1020 char *xstrndup(const char *str
, size_t len
);
1021 void *xrealloc(void *ptr
, size_t size
);
1022 void *xcalloc(size_t nmemb
, size_t size
);
1023 void xsetenv(const char *name
, const char *value
, int overwrite
);
1024 void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
1025 const char *mmap_os_err(void);
1026 void *xmmap_gently(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
1027 int xopen(const char *path
, int flags
, ...);
1028 ssize_t
xread(int fd
, void *buf
, size_t len
);
1029 ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
1030 ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
);
1032 FILE *xfopen(const char *path
, const char *mode
);
1033 FILE *xfdopen(int fd
, const char *mode
);
1034 int xmkstemp(char *temp_filename
);
1035 int xmkstemp_mode(char *temp_filename
, int mode
);
1036 char *xgetcwd(void);
1037 FILE *fopen_for_writing(const char *path
);
1038 FILE *fopen_or_warn(const char *path
, const char *mode
);
1041 * Like strncmp, but only return zero if s is NUL-terminated and exactly len
1042 * characters long. If it is not, consider it greater than t.
1044 int xstrncmpz(const char *s
, const char *t
, size_t len
);
1047 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
1048 * that ptr is used twice, so don't pass e.g. ptr++.
1050 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
1052 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
1053 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
1054 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
1056 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
1057 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
1058 static inline void copy_array(void *dst
, const void *src
, size_t n
, size_t size
)
1061 memcpy(dst
, src
, st_mult(size
, n
));
1064 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
1065 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
1066 static inline void move_array(void *dst
, const void *src
, size_t n
, size_t size
)
1069 memmove(dst
, src
, st_mult(size
, n
));
1073 * These functions help you allocate structs with flex arrays, and copy
1074 * the data directly into the array. For example, if you had:
1078 * char name[FLEX_ARRAY];
1084 * FLEX_ALLOC_MEM(f, name, src, len);
1086 * to allocate a "foo" with the contents of "src" in the "name" field.
1087 * The resulting struct is automatically zero'd, and the flex-array field
1088 * is NUL-terminated (whether the incoming src buffer was or not).
1090 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
1091 * but do want to store a pointer to some extra data in the same allocated
1092 * block. For example, if you have:
1102 * FLEXPTR_ALLOC_STR(f, name, src);
1104 * and "name" will point to a block of memory after the struct, which will be
1105 * freed along with the struct (but the pointer can be repointed anywhere).
1107 * The *_STR variants accept a string parameter rather than a ptr/len
1110 * Note that these macros will evaluate the first parameter multiple
1111 * times, and it must be assignable as an lvalue.
1113 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
1114 size_t flex_array_len_ = (len); \
1115 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1116 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
1118 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
1119 size_t flex_array_len_ = (len); \
1120 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1121 memcpy((x) + 1, (buf), flex_array_len_); \
1122 (x)->ptrname = (void *)((x)+1); \
1124 #define FLEX_ALLOC_STR(x, flexname, str) \
1125 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1126 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1127 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1129 static inline char *xstrdup_or_null(const char *str
)
1131 return str
? xstrdup(str
) : NULL
;
1134 static inline size_t xsize_t(off_t len
)
1136 if (len
< 0 || (uintmax_t) len
> SIZE_MAX
)
1137 die("Cannot handle files this big");
1138 return (size_t) len
;
1141 __attribute__((format (printf
, 3, 4)))
1142 int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...);
1144 #ifndef HOST_NAME_MAX
1145 #define HOST_NAME_MAX 256
1148 int xgethostname(char *buf
, size_t len
);
1150 /* in ctype.c, for kwset users */
1151 extern const unsigned char tolower_trans_tbl
[256];
1153 /* Sane ctype - no locale, and works with signed chars */
1168 extern const unsigned char sane_ctype
[256];
1169 #define GIT_SPACE 0x01
1170 #define GIT_DIGIT 0x02
1171 #define GIT_ALPHA 0x04
1172 #define GIT_GLOB_SPECIAL 0x08
1173 #define GIT_REGEX_SPECIAL 0x10
1174 #define GIT_PATHSPEC_MAGIC 0x20
1175 #define GIT_CNTRL 0x40
1176 #define GIT_PUNCT 0x80
1177 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1178 #define isascii(x) (((x) & ~0x7f) == 0)
1179 #define isspace(x) sane_istest(x,GIT_SPACE)
1180 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1181 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1182 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1183 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1184 #define islower(x) sane_iscase(x, 1)
1185 #define isupper(x) sane_iscase(x, 0)
1186 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1187 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1188 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1189 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1190 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1191 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1192 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1193 #define toupper(x) sane_case((unsigned char)(x), 0)
1194 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1196 static inline int sane_case(int x
, int high
)
1198 if (sane_istest(x
, GIT_ALPHA
))
1199 x
= (x
& ~0x20) | high
;
1203 static inline int sane_iscase(int x
, int is_lower
)
1205 if (!sane_istest(x
, GIT_ALPHA
))
1209 return (x
& 0x20) != 0;
1211 return (x
& 0x20) == 0;
1215 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1216 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1217 * locale-specific conversions).
1219 static inline int skip_iprefix(const char *str
, const char *prefix
,
1227 } while (tolower(*str
++) == tolower(*prefix
++));
1231 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
1237 /* negative values would be accepted by strtoul */
1240 ul
= strtoul(s
, &p
, base
);
1241 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
1247 static inline int strtol_i(char const *s
, int base
, int *result
)
1253 ul
= strtol(s
, &p
, base
);
1254 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
1260 void git_stable_qsort(void *base
, size_t nmemb
, size_t size
,
1261 int(*compar
)(const void *, const void *));
1262 #ifdef INTERNAL_QSORT
1263 #define qsort git_stable_qsort
1266 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1267 static inline void sane_qsort(void *base
, size_t nmemb
, size_t size
,
1268 int(*compar
)(const void *, const void *))
1271 qsort(base
, nmemb
, size
, compar
);
1274 #define STABLE_QSORT(base, n, compar) \
1275 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1277 #ifndef HAVE_ISO_QSORT_S
1278 int git_qsort_s(void *base
, size_t nmemb
, size_t size
,
1279 int (*compar
)(const void *, const void *, void *), void *ctx
);
1280 #define qsort_s git_qsort_s
1283 #define QSORT_S(base, n, compar, ctx) do { \
1284 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1285 BUG("qsort_s() failed"); \
1288 #ifndef REG_STARTEND
1289 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1292 static inline int regexec_buf(const regex_t
*preg
, const char *buf
, size_t size
,
1293 size_t nmatch
, regmatch_t pmatch
[], int eflags
)
1295 assert(nmatch
> 0 && pmatch
);
1296 pmatch
[0].rm_so
= 0;
1297 pmatch
[0].rm_eo
= size
;
1298 return regexec(preg
, buf
, nmatch
, pmatch
, eflags
| REG_STARTEND
);
1301 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1302 # define FORCE_DIR_SET_GID S_ISGID
1304 # define FORCE_DIR_SET_GID 0
1309 #define ST_CTIME_NSEC(st) 0
1310 #define ST_MTIME_NSEC(st) 0
1312 #ifdef USE_ST_TIMESPEC
1313 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1314 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1316 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1317 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1321 #ifdef UNRELIABLE_FSTAT
1322 #define fstat_is_reliable() 0
1324 #define fstat_is_reliable() 1
1329 * Since an obvious implementation of va_list would be to make it a
1330 * pointer into the stack frame, a simple assignment will work on
1331 * many systems. But let's try to be more portable.
1334 #define va_copy(dst, src) __va_copy(dst, src)
1336 #define va_copy(dst, src) ((dst) = (src))
1340 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1341 extern int BUG_exit_code
;
1343 /* usage.c: if bug() is called we should have a BUG_if_bug() afterwards */
1344 extern int bug_called_must_BUG
;
1346 __attribute__((format (printf
, 3, 4))) NORETURN
1347 void BUG_fl(const char *file
, int line
, const char *fmt
, ...);
1348 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1349 __attribute__((format (printf
, 3, 4)))
1350 void bug_fl(const char *file
, int line
, const char *fmt
, ...);
1351 #define bug(...) bug_fl(__FILE__, __LINE__, __VA_ARGS__)
1352 #define BUG_if_bug(...) do { \
1353 if (bug_called_must_BUG) \
1354 BUG_fl(__FILE__, __LINE__, __VA_ARGS__); \
1357 #ifndef FSYNC_METHOD_DEFAULT
1359 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_WRITEOUT_ONLY
1361 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_FSYNC
1366 FSYNC_WRITEOUT_ONLY
,
1367 FSYNC_HARDWARE_FLUSH
1371 * Issues an fsync against the specified file according to the specified mode.
1373 * FSYNC_WRITEOUT_ONLY attempts to use interfaces available on some operating
1374 * systems to flush the OS cache without issuing a flush command to the storage
1375 * controller. If those interfaces are unavailable, the function fails with
1378 * FSYNC_HARDWARE_FLUSH does an OS writeout and hardware flush to ensure that
1379 * changes are durable. It is not expected to fail.
1381 int git_fsync(int fd
, enum fsync_action action
);
1384 * Writes out trace statistics for fsync using the trace2 API.
1386 void trace_git_fsync_stats(void);
1389 * Preserves errno, prints a message, but gives no warning for ENOENT.
1390 * Returns 0 on success, which includes trying to unlink an object that does
1393 int unlink_or_warn(const char *path
);
1395 * Tries to unlink file. Returns 0 if unlink succeeded
1396 * or the file already didn't exist. Returns -1 and
1397 * appends a message to err suitable for
1398 * 'error("%s", err->buf)' on error.
1400 int unlink_or_msg(const char *file
, struct strbuf
*err
);
1402 * Preserves errno, prints a message, but gives no warning for ENOENT.
1403 * Returns 0 on success, which includes trying to remove a directory that does
1406 int rmdir_or_warn(const char *path
);
1408 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1409 * the supplied file mode.
1411 int remove_or_warn(unsigned int mode
, const char *path
);
1414 * Call access(2), but warn for any error except "missing file"
1415 * (ENOENT or ENOTDIR).
1417 #define ACCESS_EACCES_OK (1U << 0)
1418 int access_or_warn(const char *path
, int mode
, unsigned flag
);
1419 int access_or_die(const char *path
, int mode
, unsigned flag
);
1421 /* Warn on an inaccessible file if errno indicates this is an error */
1422 int warn_on_fopen_errors(const char *path
);
1425 * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent
1426 * may be racy. Do not use this as protection against an attacker who can
1427 * simultaneously create paths.
1429 int open_nofollow(const char *path
, int flags
);
1432 # define SHELL_PATH "/bin/sh"
1435 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1436 static inline void flockfile(FILE *fh
)
1440 static inline void funlockfile(FILE *fh
)
1444 #define getc_unlocked(fh) getc(fh)
1447 #ifdef FILENO_IS_A_MACRO
1448 int git_fileno(FILE *stream
);
1449 # ifndef COMPAT_CODE_FILENO
1451 # define fileno(p) git_fileno(p)
1455 #ifdef NEED_ACCESS_ROOT_HANDLER
1456 int git_access(const char *path
, int mode
);
1457 # ifndef COMPAT_CODE_ACCESS
1461 # define access(path, mode) git_access(path, mode)
1466 * Our code often opens a path to an optional file, to work on its
1467 * contents when we can successfully open it. We can ignore a failure
1468 * to open if such an optional file does not exist, but we do want to
1469 * report a failure in opening for other reasons (e.g. we got an I/O
1470 * error, or the file is there, but we lack the permission to open).
1472 * Call this function after seeing an error from open() or fopen() to
1473 * see if the errno indicates a missing file that we can safely ignore.
1475 static inline int is_missing_file_error(int errno_
)
1477 return (errno_
== ENOENT
|| errno_
== ENOTDIR
);
1480 int cmd_main(int, const char **);
1483 * Intercept all calls to exit() and route them to trace2 to
1484 * optionally emit a message before calling the real exit().
1486 int common_exit(const char *file
, int line
, int code
);
1487 #define exit(code) exit(common_exit(__FILE__, __LINE__, (code)))
1490 * You can mark a stack variable with UNLEAK(var) to avoid it being
1491 * reported as a leak by tools like LSAN or valgrind. The argument
1492 * should generally be the variable itself (not its address and not what
1493 * it points to). It's safe to use this on pointers which may already
1494 * have been freed, or on pointers which may still be in use.
1496 * Use this _only_ for a variable that leaks by going out of scope at
1497 * program exit (so only from cmd_* functions or their direct helpers).
1498 * Normal functions, especially those which may be called multiple
1499 * times, should actually free their memory. This is only meant as
1500 * an annotation, and does nothing in non-leak-checking builds.
1502 #ifdef SUPPRESS_ANNOTATED_LEAKS
1503 void unleak_memory(const void *ptr
, size_t len
);
1504 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1506 #define UNLEAK(var) do {} while (0)
1512 #if ZLIB_VERNUM < 0x1290
1514 * This is uncompress2, which is only available in zlib >= 1.2.9
1515 * (released as of early 2017). See compat/zlib-uncompress2.c.
1517 int uncompress2(Bytef
*dest
, uLongf
*destLen
, const Bytef
*source
,
1522 * This include must come after system headers, since it introduces macros that
1523 * replace system names.
1528 * container_of - Get the address of an object containing a field.
1530 * @ptr: pointer to the field.
1531 * @type: type of the object.
1532 * @member: name of the field within the object.
1534 #define container_of(ptr, type, member) \
1535 ((type *) ((char *)(ptr) - offsetof(type, member)))
1538 * helper function for `container_of_or_null' to avoid multiple
1539 * evaluation of @ptr
1541 static inline void *container_of_or_null_offset(void *ptr
, size_t offset
)
1543 return ptr
? (char *)ptr
- offset
: NULL
;
1547 * like `container_of', but allows returned value to be NULL
1549 #define container_of_or_null(ptr, type, member) \
1550 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1553 * like offsetof(), but takes a pointer to a variable of type which
1554 * contains @member, instead of a specified type.
1555 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1558 #if defined(__GNUC__) /* clang sets this, too */
1559 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1560 #else /* !__GNUC__ */
1561 #define OFFSETOF_VAR(ptr, member) \
1562 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1563 #endif /* !__GNUC__ */
1565 void sleep_millisec(int millisec
);
1568 * Generate len bytes from the system cryptographically secure PRNG.
1569 * Returns 0 on success and -1 on error, setting errno. The inability to
1570 * satisfy the full request is an error.
1572 int csprng_bytes(void *buf
, size_t len
);