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])))
100 # define BARF_UNLESS_COPYABLE(dst, src) \
101 BUILD_ASSERT_OR_ZERO(__builtin_types_compatible_p(__typeof__(*(dst)), \
104 # define BARF_UNLESS_AN_ARRAY(arr) 0
105 # define BARF_UNLESS_COPYABLE(dst, src) \
106 BUILD_ASSERT_OR_ZERO(0 ? ((*(dst) = *(src)), 0) : \
107 sizeof(*(dst)) == sizeof(*(src)))
110 * ARRAY_SIZE - get the number of elements in a visible array
111 * @x: the array whose size you want.
113 * This does not work on pointers, or arrays declared as [], or
114 * function parameters. With correct compiler support, such usage
115 * will cause a build error (see the build_assert_or_zero macro).
117 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
119 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
121 #define maximum_signed_value_of_type(a) \
122 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
124 #define maximum_unsigned_value_of_type(a) \
125 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
128 * Signed integer overflow is undefined in C, so here's a helper macro
129 * to detect if the sum of two integers will overflow.
131 * Requires: a >= 0, typeof(a) equals typeof(b)
133 #define signed_add_overflows(a, b) \
134 ((b) > maximum_signed_value_of_type(a) - (a))
136 #define unsigned_add_overflows(a, b) \
137 ((b) > maximum_unsigned_value_of_type(a) - (a))
140 * Returns true if the multiplication of "a" and "b" will
141 * overflow. The types of "a" and "b" must match and must be unsigned.
142 * Note that this macro evaluates "a" twice!
144 #define unsigned_mult_overflows(a, b) \
145 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
148 * Returns true if the left shift of "a" by "shift" bits will
149 * overflow. The type of "a" must be unsigned.
151 #define unsigned_left_shift_overflows(a, shift) \
152 ((shift) < bitsizeof(a) && \
153 (a) > maximum_unsigned_value_of_type(a) >> (shift))
156 #define TYPEOF(x) (__typeof__(x))
161 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
162 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
164 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
166 /* Approximation of the length of the decimal representation of this type. */
167 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
170 #define _POSIX_C_SOURCE 1
171 #elif defined(__sun__)
173 * On Solaris, when _XOPEN_EXTENDED is set, its header file
174 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
175 * setting to say we are XPG5 or XPG6. Also on Solaris,
176 * XPG6 programs must be compiled with a c99 compiler, while
177 * non XPG6 programs must be compiled with a pre-c99 compiler.
179 # if __STDC_VERSION__ - 0 >= 199901L
180 # define _XOPEN_SOURCE 600
182 # define _XOPEN_SOURCE 500
184 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
185 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
186 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
188 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
189 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
191 #define _ALL_SOURCE 1
192 #define _GNU_SOURCE 1
193 #define _BSD_SOURCE 1
194 #define _DEFAULT_SOURCE 1
195 #define _NETBSD_SOURCE 1
196 #define _SGI_SOURCE 1
198 #if GIT_GNUC_PREREQ(4, 5)
199 #define UNUSED __attribute__((unused)) \
200 __attribute__((deprecated ("parameter declared as UNUSED")))
201 #elif defined(__GNUC__)
202 #define UNUSED __attribute__((unused)) \
203 __attribute__((deprecated))
208 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
209 # if !defined(_WIN32_WINNT)
210 # define _WIN32_WINNT 0x0600
212 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
213 #include <winsock2.h>
214 #ifndef NO_UNIX_SOCKETS
218 #define GIT_WINDOWS_NATIVE
221 #if defined(NO_UNIX_SOCKETS) || !defined(GIT_WINDOWS_NATIVE)
222 static inline int _have_unix_sockets(void)
224 #if defined(NO_UNIX_SOCKETS)
230 #define have_unix_sockets _have_unix_sockets
235 #include <sys/stat.h>
242 #ifdef HAVE_STRINGS_H
243 #include <strings.h> /* for strcasecmp() */
248 #ifdef NEEDS_SYS_PARAM_H
249 #include <sys/param.h>
251 #include <sys/types.h>
253 #include <sys/time.h>
260 #if !defined(NO_POLL_H)
262 #elif !defined(NO_SYS_POLL_H)
263 #include <sys/poll.h>
265 /* Pull the compat stuff */
268 #ifdef HAVE_BSD_SYSCTL
269 #include <sys/sysctl.h>
272 /* Used by compat/win32/path-utils.h, and more */
273 static inline int is_xplatform_dir_sep(int c
)
275 return c
== '/' || c
== '\\';
278 #if defined(__CYGWIN__)
279 #include "compat/win32/path-utils.h"
281 #if defined(__MINGW32__)
282 /* pull in Windows compatibility stuff */
283 #include "compat/win32/path-utils.h"
284 #include "compat/mingw.h"
285 #elif defined(_MSC_VER)
286 #include "compat/win32/path-utils.h"
287 #include "compat/msvc.h"
289 #include <sys/utsname.h>
290 #include <sys/wait.h>
291 #include <sys/resource.h>
292 #include <sys/socket.h>
293 #include <sys/ioctl.h>
294 #include <sys/statvfs.h>
296 #ifndef NO_SYS_SELECT_H
297 #include <sys/select.h>
299 #include <netinet/in.h>
300 #include <netinet/tcp.h>
301 #include <arpa/inet.h>
305 #ifndef NO_INTTYPES_H
306 #include <inttypes.h>
310 #ifdef HAVE_ARC4RANDOM_LIBBSD
311 #include <bsd/stdlib.h>
313 #ifdef HAVE_GETRANDOM
314 #include <sys/random.h>
318 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
319 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
320 * while on IP16 and IP16L32 it is "int" (resp. "short")
321 * Size needs to match (or exceed) 'sizeof(void *)'.
322 * We can't take "long long" here as not everybody has it.
324 typedef long intptr_t;
325 typedef unsigned long uintptr_t;
327 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
329 #define _ALL_SOURCE 1
332 /* used on Mac OS X */
333 #ifdef PRECOMPOSE_UNICODE
334 #include "compat/precompose_utf8.h"
336 static inline const char *precompose_argv_prefix(int argc UNUSED
,
337 const char **argv UNUSED
,
342 static inline const char *precompose_string_if_needed(const char *in
)
347 #define probe_utf8_pathname_composition()
350 #ifdef MKDIR_WO_TRAILING_SLASH
351 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
352 int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
358 static inline time_t git_time(time_t *tloc
)
363 * Avoid time(NULL), which can disagree with gettimeofday(2)
364 * and filesystem timestamps.
366 gettimeofday(&tv
, NULL
);
372 #define time git_time
374 #ifdef NO_STRUCT_ITIMERVAL
376 struct timeval it_interval
;
377 struct timeval it_value
;
382 static inline int git_setitimer(int which UNUSED
,
383 const struct itimerval
*value UNUSED
,
384 struct itimerval
*newvalue UNUSED
) {
385 return 0; /* pretend success */
388 #define setitimer(which,value,ovalue) git_setitimer(which,value,ovalue)
394 #define basename gitbasename
395 char *gitbasename(char *);
396 #define dirname gitdirname
397 char *gitdirname(char *);
406 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
407 #include <AvailabilityMacros.h>
408 #undef DEPRECATED_ATTRIBUTE
409 #define DEPRECATED_ATTRIBUTE
410 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
412 #include <openssl/ssl.h>
413 #include <openssl/err.h>
417 # include <sys/sysinfo.h>
420 /* On most systems <netdb.h> would have given us this, but
421 * not on some systems (e.g. z/OS).
424 #define NI_MAXHOST 1025
428 #define NI_MAXSERV 32
431 /* On most systems <limits.h> would have given us this, but
432 * not on some systems (e.g. GNU/Hurd).
435 #define PATH_MAX 4096
442 typedef uintmax_t timestamp_t
;
443 #define PRItime PRIuMAX
444 #define parse_timestamp strtoumax
445 #define TIME_MAX UINTMAX_MAX
455 #ifndef _PATH_DEFPATH
456 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
459 #ifndef platform_core_config
460 struct config_context
;
461 static inline int noop_core_config(const char *var UNUSED
,
462 const char *value UNUSED
,
463 const struct config_context
*ctx UNUSED
,
468 #define platform_core_config noop_core_config
471 int lstat_cache_aware_rmdir(const char *path
);
472 #if !defined(__MINGW32__) && !defined(_MSC_VER)
473 #define rmdir lstat_cache_aware_rmdir
476 #ifndef has_dos_drive_prefix
477 static inline int git_has_dos_drive_prefix(const char *path UNUSED
)
481 #define has_dos_drive_prefix git_has_dos_drive_prefix
484 #ifndef skip_dos_drive_prefix
485 static inline int git_skip_dos_drive_prefix(char **path UNUSED
)
489 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
492 static inline int git_is_dir_sep(int c
)
497 #define is_dir_sep git_is_dir_sep
500 #ifndef offset_1st_component
501 static inline int git_offset_1st_component(const char *path
)
503 return is_dir_sep(path
[0]);
505 #define offset_1st_component git_offset_1st_component
508 #ifndef is_valid_path
509 #define is_valid_path(path) 1
512 #ifndef is_path_owned_by_current_user
515 #define ROOT_UID 65535
521 * Do not use this function when
522 * (1) geteuid() did not say we are running as 'root', or
523 * (2) using this function will compromise the system.
525 * PORTABILITY WARNING:
526 * This code assumes uid_t is unsigned because that is what sudo does.
527 * If your uid_t type is signed and all your ids are positive then it
528 * should all work fine.
529 * If your version of sudo uses negative values for uid_t or it is
530 * buggy and return an overflowed value in SUDO_UID, then git might
531 * fail to grant access to your repository properly or even mistakenly
532 * grant access to someone else.
533 * In the unlikely scenario this happened to you, and that is how you
534 * got to this message, we would like to know about it; so sent us an
535 * email to git@vger.kernel.org indicating which platform you are
536 * using and which version of sudo, so we can improve this logic and
537 * maybe provide you with a patch that would prevent this issue again
540 static inline void extract_id_from_env(const char *env
, uid_t
*id
)
542 const char *real_uid
= getenv(env
);
544 /* discard anything empty to avoid a more complex check below */
545 if (real_uid
&& *real_uid
) {
547 unsigned long env_id
;
550 /* silent overflow errors could trigger a bug here */
551 env_id
= strtoul(real_uid
, &endptr
, 10);
552 if (!*endptr
&& !errno
)
557 static inline int is_path_owned_by_current_uid(const char *path
,
558 struct strbuf
*report UNUSED
)
563 if (lstat(path
, &st
))
567 if (euid
== ROOT_UID
)
569 if (st
.st_uid
== ROOT_UID
)
572 extract_id_from_env("SUDO_UID", &euid
);
575 return st
.st_uid
== euid
;
578 #define is_path_owned_by_current_user is_path_owned_by_current_uid
581 #ifndef find_last_dir_sep
582 static inline char *git_find_last_dir_sep(const char *path
)
584 return strrchr(path
, '/');
586 #define find_last_dir_sep git_find_last_dir_sep
590 static inline int git_has_dir_sep(const char *path
)
592 return !!strchr(path
, '/');
594 #define has_dir_sep(path) git_has_dir_sep(path)
597 #ifndef query_user_email
598 #define query_user_email() NULL
602 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
603 #include <floss.h(floss_getpwuid)>
606 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
607 * known, by detective work using kill -l as a list is all signals
608 * instead of signal.h where it should be.
614 #if defined(__HP_cc) && (__HP_cc >= 61000)
615 #define NORETURN __attribute__((noreturn))
617 #elif defined(__GNUC__) && !defined(NO_NORETURN)
618 #define NORETURN __attribute__((__noreturn__))
619 #define NORETURN_PTR __attribute__((__noreturn__))
620 #elif defined(_MSC_VER)
621 #define NORETURN __declspec(noreturn)
627 #ifndef __attribute__
628 #define __attribute__(x)
633 /* The sentinel attribute is valid from gcc version 4.0 */
634 #if defined(__GNUC__) && (__GNUC__ >= 4)
635 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
636 /* warn_unused_result exists as of gcc 3.4.0, but be lazy and check 4.0 */
637 #define RESULT_MUST_BE_USED __attribute__ ((warn_unused_result))
639 #define LAST_ARG_MUST_BE_NULL
640 #define RESULT_MUST_BE_USED
643 #define MAYBE_UNUSED __attribute__((__unused__))
645 #include "compat/bswap.h"
649 /* General helper functions */
650 NORETURN
void usage(const char *err
);
651 NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
652 NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
653 NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
654 int die_message(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
655 int die_message_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
656 int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
657 int error_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
658 void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
659 void warning_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
662 #ifdef APPLE_COMMON_CRYPTO
663 #include "compat/apple-common-crypto.h"
665 #include <openssl/evp.h>
666 #include <openssl/hmac.h>
667 #endif /* APPLE_COMMON_CRYPTO */
668 #include <openssl/x509v3.h>
669 #endif /* NO_OPENSSL */
671 #ifdef HAVE_OPENSSL_CSPRNG
672 #include <openssl/rand.h>
676 * Let callers be aware of the constant return value; this can help
677 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
678 * because other compilers may be confused by this.
680 #if defined(__GNUC__)
681 static inline int const_error(void)
685 #define error(...) (error(__VA_ARGS__), const_error())
686 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
689 typedef void (*report_fn
)(const char *, va_list params
);
691 void set_die_routine(NORETURN_PTR report_fn routine
);
692 report_fn
get_die_message_routine(void);
693 void set_error_routine(report_fn routine
);
694 report_fn
get_error_routine(void);
695 void set_warn_routine(report_fn routine
);
696 report_fn
get_warn_routine(void);
697 void set_die_is_recursing_routine(int (*routine
)(void));
700 * If the string "str" begins with the string found in "prefix", return true.
701 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
702 * the string right after the prefix).
704 * Otherwise, return false and leave "out" untouched.
708 * [extract branch name, fail if not a branch]
709 * if (!skip_prefix(ref, "refs/heads/", &branch)
712 * [skip prefix if present, otherwise use whole string]
713 * skip_prefix(name, "refs/heads/", &name);
715 static inline bool skip_prefix(const char *str
, const char *prefix
,
723 } while (*str
++ == *prefix
++);
728 * Like skip_prefix, but promises never to read past "len" bytes of the input
729 * buffer, and returns the remaining number of bytes in "out" via "outlen".
731 static inline bool skip_prefix_mem(const char *buf
, size_t len
,
733 const char **out
, size_t *outlen
)
735 size_t prefix_len
= strlen(prefix
);
736 if (prefix_len
<= len
&& !memcmp(buf
, prefix
, prefix_len
)) {
737 *out
= buf
+ prefix_len
;
738 *outlen
= len
- prefix_len
;
745 * If buf ends with suffix, return true and subtract the length of the suffix
746 * from *len. Otherwise, return false and leave *len untouched.
748 static inline bool strip_suffix_mem(const char *buf
, size_t *len
,
751 size_t suflen
= strlen(suffix
);
752 if (*len
< suflen
|| memcmp(buf
+ (*len
- suflen
), suffix
, suflen
))
759 * If str ends with suffix, return true and set *len to the size of the string
760 * without the suffix. Otherwise, return false and set *len to the size of the
763 * Note that we do _not_ NUL-terminate str to the new length.
765 static inline bool strip_suffix(const char *str
, const char *suffix
,
769 return strip_suffix_mem(str
, len
, suffix
);
772 #define SWAP(a, b) do { \
773 void *_swap_a_ptr = &(a); \
774 void *_swap_b_ptr = &(b); \
775 unsigned char _swap_buffer[sizeof(a)]; \
776 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
777 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
778 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
779 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
782 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
787 #define MAP_PRIVATE 1
790 #define mmap git_mmap
791 #define munmap git_munmap
792 void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
793 int git_munmap(void *start
, size_t length
);
795 #else /* NO_MMAP || USE_WIN32_MMAP */
797 #include <sys/mman.h>
799 #endif /* NO_MMAP || USE_WIN32_MMAP */
803 /* This value must be multiple of (pagesize * 2) */
804 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
808 /* This value must be multiple of (pagesize * 2) */
809 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
810 (sizeof(void*) >= 8 \
811 ? 1 * 1024 * 1024 * 1024 \
817 #define MAP_FAILED ((void *)-1)
820 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
821 #define on_disk_bytes(st) ((st).st_size)
823 #define on_disk_bytes(st) ((st).st_blocks * 512)
826 #ifdef NEEDS_MODE_TRANSLATION
835 #define S_IFMT 0170000
836 #define S_IFREG 0100000
837 #define S_IFDIR 0040000
838 #define S_IFLNK 0120000
839 #define S_IFBLK 0060000
840 #define S_IFCHR 0020000
841 #define S_IFIFO 0010000
842 #define S_IFSOCK 0140000
846 #define stat(path, buf) git_stat(path, buf)
847 int git_stat(const char *, struct stat
*);
851 #define fstat(fd, buf) git_fstat(fd, buf)
852 int git_fstat(int, struct stat
*);
856 #define lstat(path, buf) git_lstat(path, buf)
857 int git_lstat(const char *, struct stat
*);
860 #define DEFAULT_PACKED_GIT_LIMIT \
861 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
864 #define pread git_pread
865 ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
869 #define setenv gitsetenv
870 int gitsetenv(const char *, const char *, int);
874 #define mkdtemp gitmkdtemp
875 char *gitmkdtemp(char *);
879 #define unsetenv gitunsetenv
880 int gitunsetenv(const char *);
884 #define strcasestr gitstrcasestr
885 char *gitstrcasestr(const char *haystack
, const char *needle
);
889 #define strlcpy gitstrlcpy
890 size_t gitstrlcpy(char *, const char *, size_t);
894 #define strtoumax gitstrtoumax
895 uintmax_t gitstrtoumax(const char *, char **, int);
896 #define strtoimax gitstrtoimax
897 intmax_t gitstrtoimax(const char *, char **, int);
901 #define hstrerror githstrerror
902 const char *githstrerror(int herror
);
906 #define memmem gitmemmem
907 void *gitmemmem(const void *haystack
, size_t haystacklen
,
908 const void *needle
, size_t needlelen
);
911 #ifdef OVERRIDE_STRDUP
915 #define strdup gitstrdup
916 char *gitstrdup(const char *s
);
919 #ifdef NO_GETPAGESIZE
920 #define getpagesize() sysconf(_SC_PAGESIZE)
927 #ifdef FREAD_READS_DIRECTORIES
928 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
932 # define fopen(a,b) git_fopen(a,b)
934 FILE *git_fopen(const char*, const char*);
937 #ifdef SNPRINTF_RETURNS_BOGUS
941 #define snprintf git_snprintf
942 int git_snprintf(char *str
, size_t maxsize
,
943 const char *format
, ...);
947 #define vsnprintf git_vsnprintf
948 int git_vsnprintf(char *str
, size_t maxsize
,
949 const char *format
, va_list ap
);
952 #ifdef OPEN_RETURNS_EINTR
954 #define open git_open_with_retry
955 int git_open_with_retry(const char *path
, int flag
, ...);
958 #ifdef __GLIBC_PREREQ
959 #if __GLIBC_PREREQ(2, 1)
960 #define HAVE_STRCHRNUL
964 #ifndef HAVE_STRCHRNUL
965 #define strchrnul gitstrchrnul
966 static inline char *gitstrchrnul(const char *s
, int c
)
968 while (*s
&& *s
!= c
)
975 int inet_pton(int af
, const char *src
, void *dst
);
979 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
983 #define atexit git_atexit
984 int git_atexit(void (*handler
)(void));
987 static inline size_t st_add(size_t a
, size_t b
)
989 if (unsigned_add_overflows(a
, b
))
990 die("size_t overflow: %"PRIuMAX
" + %"PRIuMAX
,
991 (uintmax_t)a
, (uintmax_t)b
);
994 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
995 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
997 static inline size_t st_mult(size_t a
, size_t b
)
999 if (unsigned_mult_overflows(a
, b
))
1000 die("size_t overflow: %"PRIuMAX
" * %"PRIuMAX
,
1001 (uintmax_t)a
, (uintmax_t)b
);
1005 static inline size_t st_sub(size_t a
, size_t b
)
1008 die("size_t underflow: %"PRIuMAX
" - %"PRIuMAX
,
1009 (uintmax_t)a
, (uintmax_t)b
);
1013 static inline size_t st_left_shift(size_t a
, unsigned shift
)
1015 if (unsigned_left_shift_overflows(a
, shift
))
1016 die("size_t overflow: %"PRIuMAX
" << %u",
1017 (uintmax_t)a
, shift
);
1021 static inline unsigned long cast_size_t_to_ulong(size_t a
)
1023 if (a
!= (unsigned long)a
)
1024 die("object too large to read on this platform: %"
1025 PRIuMAX
" is cut off to %lu",
1026 (uintmax_t)a
, (unsigned long)a
);
1027 return (unsigned long)a
;
1030 static inline uint32_t cast_size_t_to_uint32_t(size_t a
)
1032 if (a
!= (uint32_t)a
)
1033 die("object too large to read on this platform: %"
1034 PRIuMAX
" is cut off to %u",
1035 (uintmax_t)a
, (uint32_t)a
);
1039 static inline int cast_size_t_to_int(size_t a
)
1042 die("number too large to represent as int on this platform: %"PRIuMAX
,
1048 * Limit size of IO chunks, because huge chunks only cause pain. OS X
1049 * 64-bit is buggy, returning EINVAL if len >= INT_MAX; and even in
1050 * the absence of bugs, large chunks can result in bad latencies when
1051 * you decide to kill the process.
1053 * We pick 8 MiB as our default, but if the platform defines SSIZE_MAX
1054 * that is smaller than that, clip it to SSIZE_MAX, as a call to
1055 * read(2) or write(2) larger than that is allowed to fail. As the last
1056 * resort, we allow a port to pass via CFLAGS e.g. "-DMAX_IO_SIZE=value"
1057 * to override this, if the definition of SSIZE_MAX given by the platform
1061 # define MAX_IO_SIZE_DEFAULT (8*1024*1024)
1062 # if defined(SSIZE_MAX) && (SSIZE_MAX < MAX_IO_SIZE_DEFAULT)
1063 # define MAX_IO_SIZE SSIZE_MAX
1065 # define MAX_IO_SIZE MAX_IO_SIZE_DEFAULT
1069 #ifdef HAVE_ALLOCA_H
1070 # include <alloca.h>
1071 # define xalloca(size) (alloca(size))
1072 # define xalloca_free(p) do {} while (0)
1074 # define xalloca(size) (xmalloc(size))
1075 # define xalloca_free(p) (free(p))
1079 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
1080 * that ptr is used twice, so don't pass e.g. ptr++.
1082 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
1084 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
1085 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
1086 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
1088 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
1089 BARF_UNLESS_COPYABLE((dst), (src)))
1090 static inline void copy_array(void *dst
, const void *src
, size_t n
, size_t size
)
1093 memcpy(dst
, src
, st_mult(size
, n
));
1096 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
1097 BARF_UNLESS_COPYABLE((dst), (src)))
1098 static inline void move_array(void *dst
, const void *src
, size_t n
, size_t size
)
1101 memmove(dst
, src
, st_mult(size
, n
));
1104 #define DUP_ARRAY(dst, src, n) do { \
1105 size_t dup_array_n_ = (n); \
1106 COPY_ARRAY(ALLOC_ARRAY((dst), dup_array_n_), (src), dup_array_n_); \
1110 * These functions help you allocate structs with flex arrays, and copy
1111 * the data directly into the array. For example, if you had:
1115 * char name[FLEX_ARRAY];
1121 * FLEX_ALLOC_MEM(f, name, src, len);
1123 * to allocate a "foo" with the contents of "src" in the "name" field.
1124 * The resulting struct is automatically zero'd, and the flex-array field
1125 * is NUL-terminated (whether the incoming src buffer was or not).
1127 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
1128 * but do want to store a pointer to some extra data in the same allocated
1129 * block. For example, if you have:
1139 * FLEXPTR_ALLOC_STR(f, name, src);
1141 * and "name" will point to a block of memory after the struct, which will be
1142 * freed along with the struct (but the pointer can be repointed anywhere).
1144 * The *_STR variants accept a string parameter rather than a ptr/len
1147 * Note that these macros will evaluate the first parameter multiple
1148 * times, and it must be assignable as an lvalue.
1150 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
1151 size_t flex_array_len_ = (len); \
1152 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1153 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
1155 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
1156 size_t flex_array_len_ = (len); \
1157 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1158 memcpy((x) + 1, (buf), flex_array_len_); \
1159 (x)->ptrname = (void *)((x)+1); \
1161 #define FLEX_ALLOC_STR(x, flexname, str) \
1162 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1163 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1164 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1166 #define alloc_nr(x) (((x)+16)*3/2)
1169 * Dynamically growing an array using realloc() is error prone and boring.
1171 * Define your array with:
1173 * - a pointer (`item`) that points at the array, initialized to `NULL`
1174 * (although please name the variable based on its contents, not on its
1177 * - an integer variable (`alloc`) that keeps track of how big the current
1178 * allocation is, initialized to `0`;
1180 * - another integer variable (`nr`) to keep track of how many elements the
1181 * array currently has, initialized to `0`.
1183 * Then before adding `n`th element to the item, call `ALLOC_GROW(item, n,
1184 * alloc)`. This ensures that the array can hold at least `n` elements by
1185 * calling `realloc(3)` and adjusting `alloc` variable.
1192 * for (i = 0; i < nr; i++)
1193 * if (we like item[i] already)
1196 * // we did not like any existing one, so add one
1197 * ALLOC_GROW(item, nr + 1, alloc);
1198 * item[nr++] = value you like;
1201 * You are responsible for updating the `nr` variable.
1203 * If you need to specify the number of elements to allocate explicitly
1204 * then use the macro `REALLOC_ARRAY(item, alloc)` instead of `ALLOC_GROW`.
1206 * Consider using ALLOC_GROW_BY instead of ALLOC_GROW as it has some
1209 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
1211 #define ALLOC_GROW(x, nr, alloc) \
1213 if ((nr) > alloc) { \
1214 if (alloc_nr(alloc) < (nr)) \
1217 alloc = alloc_nr(alloc); \
1218 REALLOC_ARRAY(x, alloc); \
1223 * Similar to ALLOC_GROW but handles updating of the nr value and
1224 * zeroing the bytes of the newly-grown array elements.
1226 * DO NOT USE any expression with side-effect for any of the
1229 #define ALLOC_GROW_BY(x, nr, increase, alloc) \
1232 size_t new_nr = nr + (increase); \
1234 BUG("negative growth in ALLOC_GROW_BY"); \
1235 ALLOC_GROW(x, new_nr, alloc); \
1236 memset((x) + nr, 0, sizeof(*(x)) * (increase)); \
1241 static inline char *xstrdup_or_null(const char *str
)
1243 return str
? xstrdup(str
) : NULL
;
1246 static inline size_t xsize_t(off_t len
)
1248 if (len
< 0 || (uintmax_t) len
> SIZE_MAX
)
1249 die("Cannot handle files this big");
1250 return (size_t) len
;
1253 #ifndef HOST_NAME_MAX
1254 #define HOST_NAME_MAX 256
1257 #include "sane-ctype.h"
1260 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1261 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1262 * locale-specific conversions).
1264 static inline int skip_iprefix(const char *str
, const char *prefix
,
1272 } while (tolower(*str
++) == tolower(*prefix
++));
1277 * Like skip_prefix_mem, but compare case-insensitively. Note that the
1278 * comparison is done via tolower(), so it is strictly ASCII (no multi-byte
1279 * characters or locale-specific conversions).
1281 static inline int skip_iprefix_mem(const char *buf
, size_t len
,
1283 const char **out
, size_t *outlen
)
1291 } while (len
-- > 0 && tolower(*buf
++) == tolower(*prefix
++));
1295 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
1301 /* negative values would be accepted by strtoul */
1304 ul
= strtoul(s
, &p
, base
);
1305 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
1311 static inline int strtol_i(char const *s
, int base
, int *result
)
1317 ul
= strtol(s
, &p
, base
);
1318 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
1324 void git_stable_qsort(void *base
, size_t nmemb
, size_t size
,
1325 int(*compar
)(const void *, const void *));
1326 #ifdef INTERNAL_QSORT
1327 #define qsort git_stable_qsort
1330 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1331 static inline void sane_qsort(void *base
, size_t nmemb
, size_t size
,
1332 int(*compar
)(const void *, const void *))
1335 qsort(base
, nmemb
, size
, compar
);
1338 #define STABLE_QSORT(base, n, compar) \
1339 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1341 #ifndef HAVE_ISO_QSORT_S
1342 int git_qsort_s(void *base
, size_t nmemb
, size_t size
,
1343 int (*compar
)(const void *, const void *, void *), void *ctx
);
1344 #define qsort_s git_qsort_s
1347 #define QSORT_S(base, n, compar, ctx) do { \
1348 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1349 BUG("qsort_s() failed"); \
1352 #ifndef REG_STARTEND
1353 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1356 static inline int regexec_buf(const regex_t
*preg
, const char *buf
, size_t size
,
1357 size_t nmatch
, regmatch_t pmatch
[], int eflags
)
1359 assert(nmatch
> 0 && pmatch
);
1360 pmatch
[0].rm_so
= 0;
1361 pmatch
[0].rm_eo
= size
;
1362 return regexec(preg
, buf
, nmatch
, pmatch
, eflags
| REG_STARTEND
);
1365 #ifdef USE_ENHANCED_BASIC_REGULAR_EXPRESSIONS
1366 int git_regcomp(regex_t
*preg
, const char *pattern
, int cflags
);
1367 #define regcomp git_regcomp
1370 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1371 # define FORCE_DIR_SET_GID S_ISGID
1373 # define FORCE_DIR_SET_GID 0
1378 #define ST_CTIME_NSEC(st) 0
1379 #define ST_MTIME_NSEC(st) 0
1381 #ifdef USE_ST_TIMESPEC
1382 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1383 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1385 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1386 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1390 #ifdef UNRELIABLE_FSTAT
1391 #define fstat_is_reliable() 0
1393 #define fstat_is_reliable() 1
1398 * Since an obvious implementation of va_list would be to make it a
1399 * pointer into the stack frame, a simple assignment will work on
1400 * many systems. But let's try to be more portable.
1403 #define va_copy(dst, src) __va_copy(dst, src)
1405 #define va_copy(dst, src) ((dst) = (src))
1409 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1410 extern int BUG_exit_code
;
1412 /* usage.c: if bug() is called we should have a BUG_if_bug() afterwards */
1413 extern int bug_called_must_BUG
;
1415 __attribute__((format (printf
, 3, 4))) NORETURN
1416 void BUG_fl(const char *file
, int line
, const char *fmt
, ...);
1417 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1418 __attribute__((format (printf
, 3, 4)))
1419 void bug_fl(const char *file
, int line
, const char *fmt
, ...);
1420 #define bug(...) bug_fl(__FILE__, __LINE__, __VA_ARGS__)
1421 #define BUG_if_bug(...) do { \
1422 if (bug_called_must_BUG) \
1423 BUG_fl(__FILE__, __LINE__, __VA_ARGS__); \
1426 #ifndef FSYNC_METHOD_DEFAULT
1428 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_WRITEOUT_ONLY
1430 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_FSYNC
1435 # define SHELL_PATH "/bin/sh"
1438 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1439 static inline void git_flockfile(FILE *fh UNUSED
)
1443 static inline void git_funlockfile(FILE *fh UNUSED
)
1449 #undef getc_unlocked
1450 #define flockfile(fh) git_flockfile(fh)
1451 #define funlockfile(fh) git_funlockfile(fh)
1452 #define getc_unlocked(fh) getc(fh)
1455 #ifdef FILENO_IS_A_MACRO
1456 int git_fileno(FILE *stream
);
1457 # ifndef COMPAT_CODE_FILENO
1459 # define fileno(p) git_fileno(p)
1463 #ifdef NEED_ACCESS_ROOT_HANDLER
1464 int git_access(const char *path
, int mode
);
1465 # ifndef COMPAT_CODE_ACCESS
1469 # define access(path, mode) git_access(path, mode)
1474 * Our code often opens a path to an optional file, to work on its
1475 * contents when we can successfully open it. We can ignore a failure
1476 * to open if such an optional file does not exist, but we do want to
1477 * report a failure in opening for other reasons (e.g. we got an I/O
1478 * error, or the file is there, but we lack the permission to open).
1480 * Call this function after seeing an error from open() or fopen() to
1481 * see if the errno indicates a missing file that we can safely ignore.
1483 static inline int is_missing_file_error(int errno_
)
1485 return (errno_
== ENOENT
|| errno_
== ENOTDIR
);
1488 int cmd_main(int, const char **);
1491 * Intercept all calls to exit() and route them to trace2 to
1492 * optionally emit a message before calling the real exit().
1494 int common_exit(const char *file
, int line
, int code
);
1495 #define exit(code) exit(common_exit(__FILE__, __LINE__, (code)))
1498 * You can mark a stack variable with UNLEAK(var) to avoid it being
1499 * reported as a leak by tools like LSAN or valgrind. The argument
1500 * should generally be the variable itself (not its address and not what
1501 * it points to). It's safe to use this on pointers which may already
1502 * have been freed, or on pointers which may still be in use.
1504 * Use this _only_ for a variable that leaks by going out of scope at
1505 * program exit (so only from cmd_* functions or their direct helpers).
1506 * Normal functions, especially those which may be called multiple
1507 * times, should actually free their memory. This is only meant as
1508 * an annotation, and does nothing in non-leak-checking builds.
1510 #ifdef SUPPRESS_ANNOTATED_LEAKS
1511 void unleak_memory(const void *ptr
, size_t len
);
1512 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1514 #define UNLEAK(var) do {} while (0)
1520 #if ZLIB_VERNUM < 0x1290
1522 * This is uncompress2, which is only available in zlib >= 1.2.9
1523 * (released as of early 2017). See compat/zlib-uncompress2.c.
1525 int uncompress2(Bytef
*dest
, uLongf
*destLen
, const Bytef
*source
,
1530 * This include must come after system headers, since it introduces macros that
1531 * replace system names.
1536 * container_of - Get the address of an object containing a field.
1538 * @ptr: pointer to the field.
1539 * @type: type of the object.
1540 * @member: name of the field within the object.
1542 #define container_of(ptr, type, member) \
1543 ((type *) ((char *)(ptr) - offsetof(type, member)))
1546 * helper function for `container_of_or_null' to avoid multiple
1547 * evaluation of @ptr
1549 static inline void *container_of_or_null_offset(void *ptr
, size_t offset
)
1551 return ptr
? (char *)ptr
- offset
: NULL
;
1555 * like `container_of', but allows returned value to be NULL
1557 #define container_of_or_null(ptr, type, member) \
1558 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1561 * like offsetof(), but takes a pointer to a variable of type which
1562 * contains @member, instead of a specified type.
1563 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1566 #if defined(__GNUC__) /* clang sets this, too */
1567 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1568 #else /* !__GNUC__ */
1569 #define OFFSETOF_VAR(ptr, member) \
1570 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1571 #endif /* !__GNUC__ */