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 __attribute__((unused)) \
194 __attribute__((deprecated ("parameter declared as UNUSED")))
199 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
200 # if !defined(_WIN32_WINNT)
201 # define _WIN32_WINNT 0x0600
203 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
204 #include <winsock2.h>
205 #ifndef NO_UNIX_SOCKETS
209 #define GIT_WINDOWS_NATIVE
214 #include <sys/stat.h>
220 #ifdef HAVE_STRINGS_H
221 #include <strings.h> /* for strcasecmp() */
226 #ifdef NEEDS_SYS_PARAM_H
227 #include <sys/param.h>
229 #include <sys/types.h>
231 #include <sys/time.h>
238 #if !defined(NO_POLL_H)
240 #elif !defined(NO_SYS_POLL_H)
241 #include <sys/poll.h>
243 /* Pull the compat stuff */
246 #ifdef HAVE_BSD_SYSCTL
247 #include <sys/sysctl.h>
250 /* Used by compat/win32/path-utils.h, and more */
251 static inline int is_xplatform_dir_sep(int c
)
253 return c
== '/' || c
== '\\';
256 #if defined(__CYGWIN__)
257 #include "compat/win32/path-utils.h"
259 #if defined(__MINGW32__)
260 /* pull in Windows compatibility stuff */
261 #include "compat/win32/path-utils.h"
262 #include "compat/mingw.h"
263 #elif defined(_MSC_VER)
264 #include "compat/win32/path-utils.h"
265 #include "compat/msvc.h"
267 #include <sys/utsname.h>
268 #include <sys/wait.h>
269 #include <sys/resource.h>
270 #include <sys/socket.h>
271 #include <sys/ioctl.h>
272 #include <sys/statvfs.h>
274 #ifndef NO_SYS_SELECT_H
275 #include <sys/select.h>
277 #include <netinet/in.h>
278 #include <netinet/tcp.h>
279 #include <arpa/inet.h>
283 #ifndef NO_INTTYPES_H
284 #include <inttypes.h>
288 #ifdef HAVE_ARC4RANDOM_LIBBSD
289 #include <bsd/stdlib.h>
291 #ifdef HAVE_GETRANDOM
292 #include <sys/random.h>
296 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
297 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
298 * while on IP16 and IP16L32 it is "int" (resp. "short")
299 * Size needs to match (or exceed) 'sizeof(void *)'.
300 * We can't take "long long" here as not everybody has it.
302 typedef long intptr_t;
303 typedef unsigned long uintptr_t;
305 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
307 #define _ALL_SOURCE 1
310 /* used on Mac OS X */
311 #ifdef PRECOMPOSE_UNICODE
312 #include "compat/precompose_utf8.h"
314 static inline const char *precompose_argv_prefix(int argc
, const char **argv
, const char *prefix
)
318 static inline const char *precompose_string_if_needed(const char *in
)
323 #define probe_utf8_pathname_composition()
326 #ifdef MKDIR_WO_TRAILING_SLASH
327 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
328 int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
331 #ifdef NO_STRUCT_ITIMERVAL
333 struct timeval it_interval
;
334 struct timeval it_value
;
339 static inline int setitimer(int which
, const struct itimerval
*value
, struct itimerval
*newvalue
) {
340 return 0; /* pretend success */
347 #define basename gitbasename
348 char *gitbasename(char *);
349 #define dirname gitdirname
350 char *gitdirname(char *);
359 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
360 #include <AvailabilityMacros.h>
361 #undef DEPRECATED_ATTRIBUTE
362 #define DEPRECATED_ATTRIBUTE
363 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
365 #include <openssl/ssl.h>
366 #include <openssl/err.h>
370 # include <sys/sysinfo.h>
373 /* On most systems <netdb.h> would have given us this, but
374 * not on some systems (e.g. z/OS).
377 #define NI_MAXHOST 1025
381 #define NI_MAXSERV 32
384 /* On most systems <limits.h> would have given us this, but
385 * not on some systems (e.g. GNU/Hurd).
388 #define PATH_MAX 4096
391 typedef uintmax_t timestamp_t
;
392 #define PRItime PRIuMAX
393 #define parse_timestamp strtoumax
394 #define TIME_MAX UINTMAX_MAX
404 #ifndef _PATH_DEFPATH
405 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
408 #ifndef platform_core_config
409 static inline int noop_core_config(const char *var UNUSED
,
410 const char *value UNUSED
,
415 #define platform_core_config noop_core_config
418 int lstat_cache_aware_rmdir(const char *path
);
419 #if !defined(__MINGW32__) && !defined(_MSC_VER)
420 #define rmdir lstat_cache_aware_rmdir
423 #ifndef has_dos_drive_prefix
424 static inline int git_has_dos_drive_prefix(const char *path
)
428 #define has_dos_drive_prefix git_has_dos_drive_prefix
431 #ifndef skip_dos_drive_prefix
432 static inline int git_skip_dos_drive_prefix(char **path
)
436 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
439 static inline int git_is_dir_sep(int c
)
444 #define is_dir_sep git_is_dir_sep
447 #ifndef offset_1st_component
448 static inline int git_offset_1st_component(const char *path
)
450 return is_dir_sep(path
[0]);
452 #define offset_1st_component git_offset_1st_component
455 #ifndef is_valid_path
456 #define is_valid_path(path) 1
459 #ifndef is_path_owned_by_current_user
462 #define ROOT_UID 65535
468 * Do not use this function when
469 * (1) geteuid() did not say we are running as 'root', or
470 * (2) using this function will compromise the system.
472 * PORTABILITY WARNING:
473 * This code assumes uid_t is unsigned because that is what sudo does.
474 * If your uid_t type is signed and all your ids are positive then it
475 * should all work fine.
476 * If your version of sudo uses negative values for uid_t or it is
477 * buggy and return an overflowed value in SUDO_UID, then git might
478 * fail to grant access to your repository properly or even mistakenly
479 * grant access to someone else.
480 * In the unlikely scenario this happened to you, and that is how you
481 * got to this message, we would like to know about it; so sent us an
482 * email to git@vger.kernel.org indicating which platform you are
483 * using and which version of sudo, so we can improve this logic and
484 * maybe provide you with a patch that would prevent this issue again
487 static inline void extract_id_from_env(const char *env
, uid_t
*id
)
489 const char *real_uid
= getenv(env
);
491 /* discard anything empty to avoid a more complex check below */
492 if (real_uid
&& *real_uid
) {
494 unsigned long env_id
;
497 /* silent overflow errors could trigger a bug here */
498 env_id
= strtoul(real_uid
, &endptr
, 10);
499 if (!*endptr
&& !errno
)
504 static inline int is_path_owned_by_current_uid(const char *path
,
505 struct strbuf
*report UNUSED
)
510 if (lstat(path
, &st
))
514 if (euid
== ROOT_UID
)
516 if (st
.st_uid
== ROOT_UID
)
519 extract_id_from_env("SUDO_UID", &euid
);
522 return st
.st_uid
== euid
;
525 #define is_path_owned_by_current_user is_path_owned_by_current_uid
528 #ifndef find_last_dir_sep
529 static inline char *git_find_last_dir_sep(const char *path
)
531 return strrchr(path
, '/');
533 #define find_last_dir_sep git_find_last_dir_sep
537 static inline int git_has_dir_sep(const char *path
)
539 return !!strchr(path
, '/');
541 #define has_dir_sep(path) git_has_dir_sep(path)
544 #ifndef query_user_email
545 #define query_user_email() NULL
549 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
550 #include <floss.h(floss_getpwuid)>
553 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
554 * known, by detective work using kill -l as a list is all signals
555 * instead of signal.h where it should be.
561 #if defined(__HP_cc) && (__HP_cc >= 61000)
562 #define NORETURN __attribute__((noreturn))
564 #elif defined(__GNUC__) && !defined(NO_NORETURN)
565 #define NORETURN __attribute__((__noreturn__))
566 #define NORETURN_PTR __attribute__((__noreturn__))
567 #elif defined(_MSC_VER)
568 #define NORETURN __declspec(noreturn)
574 #ifndef __attribute__
575 #define __attribute__(x)
580 /* The sentinel attribute is valid from gcc version 4.0 */
581 #if defined(__GNUC__) && (__GNUC__ >= 4)
582 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
583 /* warn_unused_result exists as of gcc 3.4.0, but be lazy and check 4.0 */
584 #define RESULT_MUST_BE_USED __attribute__ ((warn_unused_result))
586 #define LAST_ARG_MUST_BE_NULL
587 #define RESULT_MUST_BE_USED
590 #define MAYBE_UNUSED __attribute__((__unused__))
592 #include "compat/bswap.h"
594 #include "wildmatch.h"
598 /* General helper functions */
599 NORETURN
void usage(const char *err
);
600 NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
601 NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
602 NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
603 int die_message(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
604 int die_message_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
605 int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
606 int error_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
607 void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
608 void warning_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
611 #ifdef APPLE_COMMON_CRYPTO
612 #include "compat/apple-common-crypto.h"
614 #include <openssl/evp.h>
615 #include <openssl/hmac.h>
616 #endif /* APPLE_COMMON_CRYPTO */
617 #include <openssl/x509v3.h>
618 #endif /* NO_OPENSSL */
620 #ifdef HAVE_OPENSSL_CSPRNG
621 #include <openssl/rand.h>
625 * Let callers be aware of the constant return value; this can help
626 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
627 * because other compilers may be confused by this.
629 #if defined(__GNUC__)
630 static inline int const_error(void)
634 #define error(...) (error(__VA_ARGS__), const_error())
635 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
638 typedef void (*report_fn
)(const char *, va_list params
);
640 void set_die_routine(NORETURN_PTR report_fn routine
);
641 report_fn
get_die_message_routine(void);
642 void set_error_routine(report_fn routine
);
643 report_fn
get_error_routine(void);
644 void set_warn_routine(report_fn routine
);
645 report_fn
get_warn_routine(void);
646 void set_die_is_recursing_routine(int (*routine
)(void));
648 int starts_with(const char *str
, const char *prefix
);
649 int istarts_with(const char *str
, const char *prefix
);
652 * If the string "str" begins with the string found in "prefix", return 1.
653 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
654 * the string right after the prefix).
656 * Otherwise, return 0 and leave "out" untouched.
660 * [extract branch name, fail if not a branch]
661 * if (!skip_prefix(ref, "refs/heads/", &branch)
664 * [skip prefix if present, otherwise use whole string]
665 * skip_prefix(name, "refs/heads/", &name);
667 static inline int skip_prefix(const char *str
, const char *prefix
,
675 } while (*str
++ == *prefix
++);
680 * If the string "str" is the same as the string in "prefix", then the "arg"
681 * parameter is set to the "def" parameter and 1 is returned.
682 * If the string "str" begins with the string found in "prefix" and then a
683 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
684 * (i.e., to the point in the string right after the prefix and the "=" sign),
687 * Otherwise, return 0 and leave "arg" untouched.
689 * When we accept both a "--key" and a "--key=<val>" option, this function
690 * can be used instead of !strcmp(arg, "--key") and then
691 * skip_prefix(arg, "--key=", &arg) to parse such an option.
693 int skip_to_optional_arg_default(const char *str
, const char *prefix
,
694 const char **arg
, const char *def
);
696 static inline int skip_to_optional_arg(const char *str
, const char *prefix
,
699 return skip_to_optional_arg_default(str
, prefix
, arg
, "");
703 * Like skip_prefix, but promises never to read past "len" bytes of the input
704 * buffer, and returns the remaining number of bytes in "out" via "outlen".
706 static inline int skip_prefix_mem(const char *buf
, size_t len
,
708 const char **out
, size_t *outlen
)
710 size_t prefix_len
= strlen(prefix
);
711 if (prefix_len
<= len
&& !memcmp(buf
, prefix
, prefix_len
)) {
712 *out
= buf
+ prefix_len
;
713 *outlen
= len
- prefix_len
;
720 * If buf ends with suffix, return 1 and subtract the length of the suffix
721 * from *len. Otherwise, return 0 and leave *len untouched.
723 static inline int strip_suffix_mem(const char *buf
, size_t *len
,
726 size_t suflen
= strlen(suffix
);
727 if (*len
< suflen
|| memcmp(buf
+ (*len
- suflen
), suffix
, suflen
))
734 * If str ends with suffix, return 1 and set *len to the size of the string
735 * without the suffix. Otherwise, return 0 and set *len to the size of the
738 * Note that we do _not_ NUL-terminate str to the new length.
740 static inline int strip_suffix(const char *str
, const char *suffix
, size_t *len
)
743 return strip_suffix_mem(str
, len
, suffix
);
746 static inline int ends_with(const char *str
, const char *suffix
)
749 return strip_suffix(str
, suffix
, &len
);
752 #define SWAP(a, b) do { \
753 void *_swap_a_ptr = &(a); \
754 void *_swap_b_ptr = &(b); \
755 unsigned char _swap_buffer[sizeof(a)]; \
756 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
757 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
758 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
759 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
762 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
767 #define MAP_PRIVATE 1
770 #define mmap git_mmap
771 #define munmap git_munmap
772 void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
773 int git_munmap(void *start
, size_t length
);
775 #else /* NO_MMAP || USE_WIN32_MMAP */
777 #include <sys/mman.h>
779 #endif /* NO_MMAP || USE_WIN32_MMAP */
783 /* This value must be multiple of (pagesize * 2) */
784 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
788 /* This value must be multiple of (pagesize * 2) */
789 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
790 (sizeof(void*) >= 8 \
791 ? 1 * 1024 * 1024 * 1024 \
797 #define MAP_FAILED ((void *)-1)
800 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
801 #define on_disk_bytes(st) ((st).st_size)
803 #define on_disk_bytes(st) ((st).st_blocks * 512)
806 #ifdef NEEDS_MODE_TRANSLATION
815 #define S_IFMT 0170000
816 #define S_IFREG 0100000
817 #define S_IFDIR 0040000
818 #define S_IFLNK 0120000
819 #define S_IFBLK 0060000
820 #define S_IFCHR 0020000
821 #define S_IFIFO 0010000
822 #define S_IFSOCK 0140000
826 #define stat(path, buf) git_stat(path, buf)
827 int git_stat(const char *, struct stat
*);
831 #define fstat(fd, buf) git_fstat(fd, buf)
832 int git_fstat(int, struct stat
*);
836 #define lstat(path, buf) git_lstat(path, buf)
837 int git_lstat(const char *, struct stat
*);
840 #define DEFAULT_PACKED_GIT_LIMIT \
841 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
844 #define pread git_pread
845 ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
848 * Forward decl that will remind us if its twin in cache.h changes.
849 * This function is used in compat/pread.c. But we can't include
852 ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
855 #define setenv gitsetenv
856 int gitsetenv(const char *, const char *, int);
860 #define mkdtemp gitmkdtemp
861 char *gitmkdtemp(char *);
865 #define unsetenv gitunsetenv
866 int gitunsetenv(const char *);
870 #define strcasestr gitstrcasestr
871 char *gitstrcasestr(const char *haystack
, const char *needle
);
875 #define strlcpy gitstrlcpy
876 size_t gitstrlcpy(char *, const char *, size_t);
880 #define strtoumax gitstrtoumax
881 uintmax_t gitstrtoumax(const char *, char **, int);
882 #define strtoimax gitstrtoimax
883 intmax_t gitstrtoimax(const char *, char **, int);
887 #define hstrerror githstrerror
888 const char *githstrerror(int herror
);
892 #define memmem gitmemmem
893 void *gitmemmem(const void *haystack
, size_t haystacklen
,
894 const void *needle
, size_t needlelen
);
897 #ifdef OVERRIDE_STRDUP
901 #define strdup gitstrdup
902 char *gitstrdup(const char *s
);
905 #ifdef NO_GETPAGESIZE
906 #define getpagesize() sysconf(_SC_PAGESIZE)
913 #ifdef FREAD_READS_DIRECTORIES
914 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
918 # define fopen(a,b) git_fopen(a,b)
920 FILE *git_fopen(const char*, const char*);
923 #ifdef SNPRINTF_RETURNS_BOGUS
927 #define snprintf git_snprintf
928 int git_snprintf(char *str
, size_t maxsize
,
929 const char *format
, ...);
933 #define vsnprintf git_vsnprintf
934 int git_vsnprintf(char *str
, size_t maxsize
,
935 const char *format
, va_list ap
);
938 #ifdef OPEN_RETURNS_EINTR
940 #define open git_open_with_retry
941 int git_open_with_retry(const char *path
, int flag
, ...);
944 #ifdef __GLIBC_PREREQ
945 #if __GLIBC_PREREQ(2, 1)
946 #define HAVE_STRCHRNUL
950 #ifndef HAVE_STRCHRNUL
951 #define strchrnul gitstrchrnul
952 static inline char *gitstrchrnul(const char *s
, int c
)
954 while (*s
&& *s
!= c
)
961 int inet_pton(int af
, const char *src
, void *dst
);
965 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
969 #define atexit git_atexit
970 int git_atexit(void (*handler
)(void));
973 static inline size_t st_add(size_t a
, size_t b
)
975 if (unsigned_add_overflows(a
, b
))
976 die("size_t overflow: %"PRIuMAX
" + %"PRIuMAX
,
977 (uintmax_t)a
, (uintmax_t)b
);
980 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
981 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
983 static inline size_t st_mult(size_t a
, size_t b
)
985 if (unsigned_mult_overflows(a
, b
))
986 die("size_t overflow: %"PRIuMAX
" * %"PRIuMAX
,
987 (uintmax_t)a
, (uintmax_t)b
);
991 static inline size_t st_sub(size_t a
, size_t b
)
994 die("size_t underflow: %"PRIuMAX
" - %"PRIuMAX
,
995 (uintmax_t)a
, (uintmax_t)b
);
999 static inline size_t st_left_shift(size_t a
, unsigned shift
)
1001 if (unsigned_left_shift_overflows(a
, shift
))
1002 die("size_t overflow: %"PRIuMAX
" << %u",
1003 (uintmax_t)a
, shift
);
1007 static inline unsigned long cast_size_t_to_ulong(size_t a
)
1009 if (a
!= (unsigned long)a
)
1010 die("object too large to read on this platform: %"
1011 PRIuMAX
" is cut off to %lu",
1012 (uintmax_t)a
, (unsigned long)a
);
1013 return (unsigned long)a
;
1017 * Limit size of IO chunks, because huge chunks only cause pain. OS X
1018 * 64-bit is buggy, returning EINVAL if len >= INT_MAX; and even in
1019 * the absence of bugs, large chunks can result in bad latencies when
1020 * you decide to kill the process.
1022 * We pick 8 MiB as our default, but if the platform defines SSIZE_MAX
1023 * that is smaller than that, clip it to SSIZE_MAX, as a call to
1024 * read(2) or write(2) larger than that is allowed to fail. As the last
1025 * resort, we allow a port to pass via CFLAGS e.g. "-DMAX_IO_SIZE=value"
1026 * to override this, if the definition of SSIZE_MAX given by the platform
1030 # define MAX_IO_SIZE_DEFAULT (8*1024*1024)
1031 # if defined(SSIZE_MAX) && (SSIZE_MAX < MAX_IO_SIZE_DEFAULT)
1032 # define MAX_IO_SIZE SSIZE_MAX
1034 # define MAX_IO_SIZE MAX_IO_SIZE_DEFAULT
1038 #ifdef HAVE_ALLOCA_H
1039 # include <alloca.h>
1040 # define xalloca(size) (alloca(size))
1041 # define xalloca_free(p) do {} while (0)
1043 # define xalloca(size) (xmalloc(size))
1044 # define xalloca_free(p) (free(p))
1046 char *xstrdup(const char *str
);
1047 void *xmalloc(size_t size
);
1048 void *xmallocz(size_t size
);
1049 void *xmallocz_gently(size_t size
);
1050 void *xmemdupz(const void *data
, size_t len
);
1051 char *xstrndup(const char *str
, size_t len
);
1052 void *xrealloc(void *ptr
, size_t size
);
1053 void *xcalloc(size_t nmemb
, size_t size
);
1054 void xsetenv(const char *name
, const char *value
, int overwrite
);
1055 void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
1056 const char *mmap_os_err(void);
1057 void *xmmap_gently(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
1058 int xopen(const char *path
, int flags
, ...);
1059 ssize_t
xread(int fd
, void *buf
, size_t len
);
1060 ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
1061 ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
);
1063 FILE *xfopen(const char *path
, const char *mode
);
1064 FILE *xfdopen(int fd
, const char *mode
);
1065 int xmkstemp(char *temp_filename
);
1066 int xmkstemp_mode(char *temp_filename
, int mode
);
1067 char *xgetcwd(void);
1068 FILE *fopen_for_writing(const char *path
);
1069 FILE *fopen_or_warn(const char *path
, const char *mode
);
1072 * Like strncmp, but only return zero if s is NUL-terminated and exactly len
1073 * characters long. If it is not, consider it greater than t.
1075 int xstrncmpz(const char *s
, const char *t
, size_t len
);
1078 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
1079 * that ptr is used twice, so don't pass e.g. ptr++.
1081 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
1083 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
1084 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
1085 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
1087 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
1088 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
1089 static inline void copy_array(void *dst
, const void *src
, size_t n
, size_t size
)
1092 memcpy(dst
, src
, st_mult(size
, n
));
1095 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
1096 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
1097 static inline void move_array(void *dst
, const void *src
, size_t n
, size_t size
)
1100 memmove(dst
, src
, st_mult(size
, n
));
1104 * These functions help you allocate structs with flex arrays, and copy
1105 * the data directly into the array. For example, if you had:
1109 * char name[FLEX_ARRAY];
1115 * FLEX_ALLOC_MEM(f, name, src, len);
1117 * to allocate a "foo" with the contents of "src" in the "name" field.
1118 * The resulting struct is automatically zero'd, and the flex-array field
1119 * is NUL-terminated (whether the incoming src buffer was or not).
1121 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
1122 * but do want to store a pointer to some extra data in the same allocated
1123 * block. For example, if you have:
1133 * FLEXPTR_ALLOC_STR(f, name, src);
1135 * and "name" will point to a block of memory after the struct, which will be
1136 * freed along with the struct (but the pointer can be repointed anywhere).
1138 * The *_STR variants accept a string parameter rather than a ptr/len
1141 * Note that these macros will evaluate the first parameter multiple
1142 * times, and it must be assignable as an lvalue.
1144 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
1145 size_t flex_array_len_ = (len); \
1146 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1147 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
1149 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
1150 size_t flex_array_len_ = (len); \
1151 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1152 memcpy((x) + 1, (buf), flex_array_len_); \
1153 (x)->ptrname = (void *)((x)+1); \
1155 #define FLEX_ALLOC_STR(x, flexname, str) \
1156 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1157 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1158 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1160 static inline char *xstrdup_or_null(const char *str
)
1162 return str
? xstrdup(str
) : NULL
;
1165 static inline size_t xsize_t(off_t len
)
1167 if (len
< 0 || (uintmax_t) len
> SIZE_MAX
)
1168 die("Cannot handle files this big");
1169 return (size_t) len
;
1172 __attribute__((format (printf
, 3, 4)))
1173 int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...);
1175 #ifndef HOST_NAME_MAX
1176 #define HOST_NAME_MAX 256
1179 int xgethostname(char *buf
, size_t len
);
1181 /* in ctype.c, for kwset users */
1182 extern const unsigned char tolower_trans_tbl
[256];
1184 /* Sane ctype - no locale, and works with signed chars */
1199 extern const unsigned char sane_ctype
[256];
1200 #define GIT_SPACE 0x01
1201 #define GIT_DIGIT 0x02
1202 #define GIT_ALPHA 0x04
1203 #define GIT_GLOB_SPECIAL 0x08
1204 #define GIT_REGEX_SPECIAL 0x10
1205 #define GIT_PATHSPEC_MAGIC 0x20
1206 #define GIT_CNTRL 0x40
1207 #define GIT_PUNCT 0x80
1208 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1209 #define isascii(x) (((x) & ~0x7f) == 0)
1210 #define isspace(x) sane_istest(x,GIT_SPACE)
1211 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1212 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1213 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1214 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1215 #define islower(x) sane_iscase(x, 1)
1216 #define isupper(x) sane_iscase(x, 0)
1217 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1218 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1219 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1220 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1221 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1222 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1223 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1224 #define toupper(x) sane_case((unsigned char)(x), 0)
1225 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1227 static inline int sane_case(int x
, int high
)
1229 if (sane_istest(x
, GIT_ALPHA
))
1230 x
= (x
& ~0x20) | high
;
1234 static inline int sane_iscase(int x
, int is_lower
)
1236 if (!sane_istest(x
, GIT_ALPHA
))
1240 return (x
& 0x20) != 0;
1242 return (x
& 0x20) == 0;
1246 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1247 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1248 * locale-specific conversions).
1250 static inline int skip_iprefix(const char *str
, const char *prefix
,
1258 } while (tolower(*str
++) == tolower(*prefix
++));
1262 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
1268 /* negative values would be accepted by strtoul */
1271 ul
= strtoul(s
, &p
, base
);
1272 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
1278 static inline int strtol_i(char const *s
, int base
, int *result
)
1284 ul
= strtol(s
, &p
, base
);
1285 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
1291 void git_stable_qsort(void *base
, size_t nmemb
, size_t size
,
1292 int(*compar
)(const void *, const void *));
1293 #ifdef INTERNAL_QSORT
1294 #define qsort git_stable_qsort
1297 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1298 static inline void sane_qsort(void *base
, size_t nmemb
, size_t size
,
1299 int(*compar
)(const void *, const void *))
1302 qsort(base
, nmemb
, size
, compar
);
1305 #define STABLE_QSORT(base, n, compar) \
1306 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1308 #ifndef HAVE_ISO_QSORT_S
1309 int git_qsort_s(void *base
, size_t nmemb
, size_t size
,
1310 int (*compar
)(const void *, const void *, void *), void *ctx
);
1311 #define qsort_s git_qsort_s
1314 #define QSORT_S(base, n, compar, ctx) do { \
1315 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1316 BUG("qsort_s() failed"); \
1319 #ifndef REG_STARTEND
1320 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1323 static inline int regexec_buf(const regex_t
*preg
, const char *buf
, size_t size
,
1324 size_t nmatch
, regmatch_t pmatch
[], int eflags
)
1326 assert(nmatch
> 0 && pmatch
);
1327 pmatch
[0].rm_so
= 0;
1328 pmatch
[0].rm_eo
= size
;
1329 return regexec(preg
, buf
, nmatch
, pmatch
, eflags
| REG_STARTEND
);
1332 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1333 # define FORCE_DIR_SET_GID S_ISGID
1335 # define FORCE_DIR_SET_GID 0
1340 #define ST_CTIME_NSEC(st) 0
1341 #define ST_MTIME_NSEC(st) 0
1343 #ifdef USE_ST_TIMESPEC
1344 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1345 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1347 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1348 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1352 #ifdef UNRELIABLE_FSTAT
1353 #define fstat_is_reliable() 0
1355 #define fstat_is_reliable() 1
1360 * Since an obvious implementation of va_list would be to make it a
1361 * pointer into the stack frame, a simple assignment will work on
1362 * many systems. But let's try to be more portable.
1365 #define va_copy(dst, src) __va_copy(dst, src)
1367 #define va_copy(dst, src) ((dst) = (src))
1371 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1372 extern int BUG_exit_code
;
1374 /* usage.c: if bug() is called we should have a BUG_if_bug() afterwards */
1375 extern int bug_called_must_BUG
;
1377 __attribute__((format (printf
, 3, 4))) NORETURN
1378 void BUG_fl(const char *file
, int line
, const char *fmt
, ...);
1379 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1380 __attribute__((format (printf
, 3, 4)))
1381 void bug_fl(const char *file
, int line
, const char *fmt
, ...);
1382 #define bug(...) bug_fl(__FILE__, __LINE__, __VA_ARGS__)
1383 #define BUG_if_bug(...) do { \
1384 if (bug_called_must_BUG) \
1385 BUG_fl(__FILE__, __LINE__, __VA_ARGS__); \
1388 #ifndef FSYNC_METHOD_DEFAULT
1390 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_WRITEOUT_ONLY
1392 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_FSYNC
1397 FSYNC_WRITEOUT_ONLY
,
1398 FSYNC_HARDWARE_FLUSH
1402 * Issues an fsync against the specified file according to the specified mode.
1404 * FSYNC_WRITEOUT_ONLY attempts to use interfaces available on some operating
1405 * systems to flush the OS cache without issuing a flush command to the storage
1406 * controller. If those interfaces are unavailable, the function fails with
1409 * FSYNC_HARDWARE_FLUSH does an OS writeout and hardware flush to ensure that
1410 * changes are durable. It is not expected to fail.
1412 int git_fsync(int fd
, enum fsync_action action
);
1415 * Writes out trace statistics for fsync using the trace2 API.
1417 void trace_git_fsync_stats(void);
1420 * Preserves errno, prints a message, but gives no warning for ENOENT.
1421 * Returns 0 on success, which includes trying to unlink an object that does
1424 int unlink_or_warn(const char *path
);
1426 * Tries to unlink file. Returns 0 if unlink succeeded
1427 * or the file already didn't exist. Returns -1 and
1428 * appends a message to err suitable for
1429 * 'error("%s", err->buf)' on error.
1431 int unlink_or_msg(const char *file
, struct strbuf
*err
);
1433 * Preserves errno, prints a message, but gives no warning for ENOENT.
1434 * Returns 0 on success, which includes trying to remove a directory that does
1437 int rmdir_or_warn(const char *path
);
1439 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1440 * the supplied file mode.
1442 int remove_or_warn(unsigned int mode
, const char *path
);
1445 * Call access(2), but warn for any error except "missing file"
1446 * (ENOENT or ENOTDIR).
1448 #define ACCESS_EACCES_OK (1U << 0)
1449 int access_or_warn(const char *path
, int mode
, unsigned flag
);
1450 int access_or_die(const char *path
, int mode
, unsigned flag
);
1452 /* Warn on an inaccessible file if errno indicates this is an error */
1453 int warn_on_fopen_errors(const char *path
);
1456 * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent
1457 * may be racy. Do not use this as protection against an attacker who can
1458 * simultaneously create paths.
1460 int open_nofollow(const char *path
, int flags
);
1463 # define SHELL_PATH "/bin/sh"
1466 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1467 static inline void flockfile(FILE *fh
)
1471 static inline void funlockfile(FILE *fh
)
1475 #define getc_unlocked(fh) getc(fh)
1478 #ifdef FILENO_IS_A_MACRO
1479 int git_fileno(FILE *stream
);
1480 # ifndef COMPAT_CODE_FILENO
1482 # define fileno(p) git_fileno(p)
1486 #ifdef NEED_ACCESS_ROOT_HANDLER
1487 int git_access(const char *path
, int mode
);
1488 # ifndef COMPAT_CODE_ACCESS
1492 # define access(path, mode) git_access(path, mode)
1497 * Our code often opens a path to an optional file, to work on its
1498 * contents when we can successfully open it. We can ignore a failure
1499 * to open if such an optional file does not exist, but we do want to
1500 * report a failure in opening for other reasons (e.g. we got an I/O
1501 * error, or the file is there, but we lack the permission to open).
1503 * Call this function after seeing an error from open() or fopen() to
1504 * see if the errno indicates a missing file that we can safely ignore.
1506 static inline int is_missing_file_error(int errno_
)
1508 return (errno_
== ENOENT
|| errno_
== ENOTDIR
);
1511 int cmd_main(int, const char **);
1514 * Intercept all calls to exit() and route them to trace2 to
1515 * optionally emit a message before calling the real exit().
1517 int common_exit(const char *file
, int line
, int code
);
1518 #define exit(code) exit(common_exit(__FILE__, __LINE__, (code)))
1521 * You can mark a stack variable with UNLEAK(var) to avoid it being
1522 * reported as a leak by tools like LSAN or valgrind. The argument
1523 * should generally be the variable itself (not its address and not what
1524 * it points to). It's safe to use this on pointers which may already
1525 * have been freed, or on pointers which may still be in use.
1527 * Use this _only_ for a variable that leaks by going out of scope at
1528 * program exit (so only from cmd_* functions or their direct helpers).
1529 * Normal functions, especially those which may be called multiple
1530 * times, should actually free their memory. This is only meant as
1531 * an annotation, and does nothing in non-leak-checking builds.
1533 #ifdef SUPPRESS_ANNOTATED_LEAKS
1534 void unleak_memory(const void *ptr
, size_t len
);
1535 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1537 #define UNLEAK(var) do {} while (0)
1543 #if ZLIB_VERNUM < 0x1290
1545 * This is uncompress2, which is only available in zlib >= 1.2.9
1546 * (released as of early 2017). See compat/zlib-uncompress2.c.
1548 int uncompress2(Bytef
*dest
, uLongf
*destLen
, const Bytef
*source
,
1553 * This include must come after system headers, since it introduces macros that
1554 * replace system names.
1559 * container_of - Get the address of an object containing a field.
1561 * @ptr: pointer to the field.
1562 * @type: type of the object.
1563 * @member: name of the field within the object.
1565 #define container_of(ptr, type, member) \
1566 ((type *) ((char *)(ptr) - offsetof(type, member)))
1569 * helper function for `container_of_or_null' to avoid multiple
1570 * evaluation of @ptr
1572 static inline void *container_of_or_null_offset(void *ptr
, size_t offset
)
1574 return ptr
? (char *)ptr
- offset
: NULL
;
1578 * like `container_of', but allows returned value to be NULL
1580 #define container_of_or_null(ptr, type, member) \
1581 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1584 * like offsetof(), but takes a pointer to a variable of type which
1585 * contains @member, instead of a specified type.
1586 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1589 #if defined(__GNUC__) /* clang sets this, too */
1590 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1591 #else /* !__GNUC__ */
1592 #define OFFSETOF_VAR(ptr, member) \
1593 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1594 #endif /* !__GNUC__ */
1596 void sleep_millisec(int millisec
);
1599 * Generate len bytes from the system cryptographically secure PRNG.
1600 * Returns 0 on success and -1 on error, setting errno. The inability to
1601 * satisfy the full request is an error.
1603 int csprng_bytes(void *buf
, size_t len
);