1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
6 * For these to work they must appear very early in each
7 * file -- before most of the standard header files.
13 #define _FILE_OFFSET_BITS 64
16 /* Derived from Linux "Features Test Macro" header
17 * Convenience macros to test the versions of gcc (or
18 * a compatible compiler).
20 * #if GIT_GNUC_PREREQ (2,8)
21 * ... code requiring gcc 2.8 or later ...
24 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
25 # define GIT_GNUC_PREREQ(maj, min) \
26 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
28 #define GIT_GNUC_PREREQ(maj, min) 0
34 * See if our compiler is known to support flexible array members.
36 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
37 # define FLEX_ARRAY /* empty */
38 #elif defined(__GNUC__)
40 # define FLEX_ARRAY /* empty */
42 # define FLEX_ARRAY 0 /* older GNU extension */
47 * Otherwise, default to safer but a bit wasteful traditional style
56 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
57 * @cond: the compile-time condition which must be true.
59 * Your compile will fail if the condition isn't true, or can't be evaluated
60 * by the compiler. This can be used in an expression: its value is "0".
63 * #define foo_to_char(foo) \
65 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
67 #define BUILD_ASSERT_OR_ZERO(cond) \
68 (sizeof(char [1 - 2*!(cond)]) - 1)
70 #if GIT_GNUC_PREREQ(3, 1)
71 /* &arr[0] degrades to a pointer: a different type from an array */
72 # define BARF_UNLESS_AN_ARRAY(arr) \
73 BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
74 __typeof__(&(arr)[0])))
76 # define BARF_UNLESS_AN_ARRAY(arr) 0
79 * ARRAY_SIZE - get the number of elements in a visible array
80 * @x: the array whose size you want.
82 * This does not work on pointers, or arrays declared as [], or
83 * function parameters. With correct compiler support, such usage
84 * will cause a build error (see the build_assert_or_zero macro).
86 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
88 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
90 #define maximum_signed_value_of_type(a) \
91 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
93 #define maximum_unsigned_value_of_type(a) \
94 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
97 * Signed integer overflow is undefined in C, so here's a helper macro
98 * to detect if the sum of two integers will overflow.
100 * Requires: a >= 0, typeof(a) equals typeof(b)
102 #define signed_add_overflows(a, b) \
103 ((b) > maximum_signed_value_of_type(a) - (a))
105 #define unsigned_add_overflows(a, b) \
106 ((b) > maximum_unsigned_value_of_type(a) - (a))
109 * Returns true if the multiplication of "a" and "b" will
110 * overflow. The types of "a" and "b" must match and must be unsigned.
111 * Note that this macro evaluates "a" twice!
113 #define unsigned_mult_overflows(a, b) \
114 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
117 #define TYPEOF(x) (__typeof__(x))
122 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
123 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
125 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
127 /* Approximation of the length of the decimal representation of this type. */
128 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
131 #define _POSIX_C_SOURCE 1
132 #elif defined(__sun__)
134 * On Solaris, when _XOPEN_EXTENDED is set, its header file
135 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
136 * setting to say we are XPG5 or XPG6. Also on Solaris,
137 * XPG6 programs must be compiled with a c99 compiler, while
138 * non XPG6 programs must be compiled with a pre-c99 compiler.
140 # if __STDC_VERSION__ - 0 >= 199901L
141 # define _XOPEN_SOURCE 600
143 # define _XOPEN_SOURCE 500
145 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
146 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
147 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
149 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
150 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
152 #define _ALL_SOURCE 1
153 #define _GNU_SOURCE 1
154 #define _BSD_SOURCE 1
155 #define _DEFAULT_SOURCE 1
156 #define _NETBSD_SOURCE 1
157 #define _SGI_SOURCE 1
159 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
160 # if !defined(_WIN32_WINNT)
161 # define _WIN32_WINNT 0x0600
163 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
164 #include <winsock2.h>
165 #ifndef NO_UNIX_SOCKETS
169 #define GIT_WINDOWS_NATIVE
174 #include <sys/stat.h>
180 #ifdef HAVE_STRINGS_H
181 #include <strings.h> /* for strcasecmp() */
185 #ifdef NEEDS_SYS_PARAM_H
186 #include <sys/param.h>
188 #include <sys/types.h>
190 #include <sys/time.h>
197 #if !defined(NO_POLL_H)
199 #elif !defined(NO_SYS_POLL_H)
200 #include <sys/poll.h>
202 /* Pull the compat stuff */
205 #ifdef HAVE_BSD_SYSCTL
206 #include <sys/sysctl.h>
209 #if defined(__CYGWIN__)
210 #include "compat/win32/path-utils.h"
212 #if defined(__MINGW32__)
213 /* pull in Windows compatibility stuff */
214 #include "compat/win32/path-utils.h"
215 #include "compat/mingw.h"
216 #elif defined(_MSC_VER)
217 #include "compat/win32/path-utils.h"
218 #include "compat/msvc.h"
220 #include <sys/utsname.h>
221 #include <sys/wait.h>
222 #include <sys/resource.h>
223 #include <sys/socket.h>
224 #include <sys/ioctl.h>
226 #ifndef NO_SYS_SELECT_H
227 #include <sys/select.h>
229 #include <netinet/in.h>
230 #include <netinet/tcp.h>
231 #include <arpa/inet.h>
235 #ifndef NO_INTTYPES_H
236 #include <inttypes.h>
242 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
243 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
244 * while on IP16 and IP16L32 it is "int" (resp. "short")
245 * Size needs to match (or exceed) 'sizeof(void *)'.
246 * We can't take "long long" here as not everybody has it.
248 typedef long intptr_t;
249 typedef unsigned long uintptr_t;
251 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
253 #define _ALL_SOURCE 1
256 /* used on Mac OS X */
257 #ifdef PRECOMPOSE_UNICODE
258 #include "compat/precompose_utf8.h"
260 static inline const char *precompose_argv_prefix(int argc
, const char **argv
, const char *prefix
)
264 static inline const char *precompose_string_if_needed(const char *in
)
269 #define probe_utf8_pathname_composition()
272 #ifdef MKDIR_WO_TRAILING_SLASH
273 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
274 int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
277 #ifdef NO_STRUCT_ITIMERVAL
279 struct timeval it_interval
;
280 struct timeval it_value
;
285 static inline int setitimer(int which
, const struct itimerval
*value
, struct itimerval
*newvalue
) {
286 return 0; /* pretend success */
293 #define basename gitbasename
294 char *gitbasename(char *);
295 #define dirname gitdirname
296 char *gitdirname(char *);
305 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
306 #include <AvailabilityMacros.h>
307 #undef DEPRECATED_ATTRIBUTE
308 #define DEPRECATED_ATTRIBUTE
309 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
311 #include <openssl/ssl.h>
312 #include <openssl/err.h>
316 # include <sys/sysinfo.h>
319 /* On most systems <netdb.h> would have given us this, but
320 * not on some systems (e.g. z/OS).
323 #define NI_MAXHOST 1025
327 #define NI_MAXSERV 32
330 /* On most systems <limits.h> would have given us this, but
331 * not on some systems (e.g. GNU/Hurd).
334 #define PATH_MAX 4096
337 typedef uintmax_t timestamp_t
;
338 #define PRItime PRIuMAX
339 #define parse_timestamp strtoumax
340 #define TIME_MAX UINTMAX_MAX
350 #ifndef _PATH_DEFPATH
351 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
354 #ifndef platform_core_config
355 static inline int noop_core_config(const char *var
, const char *value
, void *cb
)
359 #define platform_core_config noop_core_config
362 int lstat_cache_aware_rmdir(const char *path
);
363 #if !defined(__MINGW32__) && !defined(_MSC_VER)
364 #define rmdir lstat_cache_aware_rmdir
367 #ifndef has_dos_drive_prefix
368 static inline int git_has_dos_drive_prefix(const char *path
)
372 #define has_dos_drive_prefix git_has_dos_drive_prefix
375 #ifndef skip_dos_drive_prefix
376 static inline int git_skip_dos_drive_prefix(char **path
)
380 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
384 static inline int git_is_dir_sep(int c
)
388 #define is_dir_sep git_is_dir_sep
391 #ifndef offset_1st_component
392 static inline int git_offset_1st_component(const char *path
)
394 return is_dir_sep(path
[0]);
396 #define offset_1st_component git_offset_1st_component
399 #ifndef is_valid_path
400 #define is_valid_path(path) 1
403 #ifndef is_path_owned_by_current_user
406 #define ROOT_UID 65535
412 * Do not use this function when
413 * (1) geteuid() did not say we are running as 'root', or
414 * (2) using this function will compromise the system.
416 * PORTABILITY WARNING:
417 * This code assumes uid_t is unsigned because that is what sudo does.
418 * If your uid_t type is signed and all your ids are positive then it
419 * should all work fine.
420 * If your version of sudo uses negative values for uid_t or it is
421 * buggy and return an overflowed value in SUDO_UID, then git might
422 * fail to grant access to your repository properly or even mistakenly
423 * grant access to someone else.
424 * In the unlikely scenario this happened to you, and that is how you
425 * got to this message, we would like to know about it; so sent us an
426 * email to git@vger.kernel.org indicating which platform you are
427 * using and which version of sudo, so we can improve this logic and
428 * maybe provide you with a patch that would prevent this issue again
431 static inline void extract_id_from_env(const char *env
, uid_t
*id
)
433 const char *real_uid
= getenv(env
);
435 /* discard anything empty to avoid a more complex check below */
436 if (real_uid
&& *real_uid
) {
438 unsigned long env_id
;
441 /* silent overflow errors could trigger a bug here */
442 env_id
= strtoul(real_uid
, &endptr
, 10);
443 if (!*endptr
&& !errno
)
448 static inline int is_path_owned_by_current_uid(const char *path
)
453 if (lstat(path
, &st
))
457 if (euid
== ROOT_UID
)
459 if (st
.st_uid
== ROOT_UID
)
462 extract_id_from_env("SUDO_UID", &euid
);
465 return st
.st_uid
== euid
;
468 #define is_path_owned_by_current_user is_path_owned_by_current_uid
471 #ifndef find_last_dir_sep
472 static inline char *git_find_last_dir_sep(const char *path
)
474 return strrchr(path
, '/');
476 #define find_last_dir_sep git_find_last_dir_sep
480 static inline int git_has_dir_sep(const char *path
)
482 return !!strchr(path
, '/');
484 #define has_dir_sep(path) git_has_dir_sep(path)
487 #ifndef query_user_email
488 #define query_user_email() NULL
492 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
493 #include <floss.h(floss_getpwuid)>
496 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
497 * known, by detective work using kill -l as a list is all signals
498 * instead of signal.h where it should be.
504 #if defined(__HP_cc) && (__HP_cc >= 61000)
505 #define NORETURN __attribute__((noreturn))
507 #elif defined(__GNUC__) && !defined(NO_NORETURN)
508 #define NORETURN __attribute__((__noreturn__))
509 #define NORETURN_PTR __attribute__((__noreturn__))
510 #elif defined(_MSC_VER)
511 #define NORETURN __declspec(noreturn)
517 #ifndef __attribute__
518 #define __attribute__(x)
523 /* The sentinel attribute is valid from gcc version 4.0 */
524 #if defined(__GNUC__) && (__GNUC__ >= 4)
525 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
527 #define LAST_ARG_MUST_BE_NULL
530 #define MAYBE_UNUSED __attribute__((__unused__))
532 #include "compat/bswap.h"
534 #include "wildmatch.h"
538 /* General helper functions */
539 void vreportf(const char *prefix
, const char *err
, va_list params
);
540 NORETURN
void usage(const char *err
);
541 NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
542 NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
543 NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
544 int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
545 int error_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
546 void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
547 void warning_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
550 #ifdef APPLE_COMMON_CRYPTO
551 #include "compat/apple-common-crypto.h"
553 #include <openssl/evp.h>
554 #include <openssl/hmac.h>
555 #endif /* APPLE_COMMON_CRYPTO */
556 #include <openssl/x509v3.h>
557 #endif /* NO_OPENSSL */
560 * Let callers be aware of the constant return value; this can help
561 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
562 * because some compilers may not support variadic macros. Since we're only
563 * trying to help gcc, anyway, it's OK; other compilers will fall back to
564 * using the function as usual.
566 #if defined(__GNUC__)
567 static inline int const_error(void)
571 #define error(...) (error(__VA_ARGS__), const_error())
572 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
575 typedef void (*report_fn
)(const char *, va_list params
);
577 void set_die_routine(NORETURN_PTR report_fn routine
);
578 void set_error_routine(report_fn routine
);
579 report_fn
get_error_routine(void);
580 void set_warn_routine(report_fn routine
);
581 report_fn
get_warn_routine(void);
582 void set_die_is_recursing_routine(int (*routine
)(void));
584 int starts_with(const char *str
, const char *prefix
);
585 int istarts_with(const char *str
, const char *prefix
);
588 * If the string "str" begins with the string found in "prefix", return 1.
589 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
590 * the string right after the prefix).
592 * Otherwise, return 0 and leave "out" untouched.
596 * [extract branch name, fail if not a branch]
597 * if (!skip_prefix(ref, "refs/heads/", &branch)
600 * [skip prefix if present, otherwise use whole string]
601 * skip_prefix(name, "refs/heads/", &name);
603 static inline int skip_prefix(const char *str
, const char *prefix
,
611 } while (*str
++ == *prefix
++);
616 * If the string "str" is the same as the string in "prefix", then the "arg"
617 * parameter is set to the "def" parameter and 1 is returned.
618 * If the string "str" begins with the string found in "prefix" and then a
619 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
620 * (i.e., to the point in the string right after the prefix and the "=" sign),
623 * Otherwise, return 0 and leave "arg" untouched.
625 * When we accept both a "--key" and a "--key=<val>" option, this function
626 * can be used instead of !strcmp(arg, "--key") and then
627 * skip_prefix(arg, "--key=", &arg) to parse such an option.
629 int skip_to_optional_arg_default(const char *str
, const char *prefix
,
630 const char **arg
, const char *def
);
632 static inline int skip_to_optional_arg(const char *str
, const char *prefix
,
635 return skip_to_optional_arg_default(str
, prefix
, arg
, "");
639 * Like skip_prefix, but promises never to read past "len" bytes of the input
640 * buffer, and returns the remaining number of bytes in "out" via "outlen".
642 static inline int skip_prefix_mem(const char *buf
, size_t len
,
644 const char **out
, size_t *outlen
)
646 size_t prefix_len
= strlen(prefix
);
647 if (prefix_len
<= len
&& !memcmp(buf
, prefix
, prefix_len
)) {
648 *out
= buf
+ prefix_len
;
649 *outlen
= len
- prefix_len
;
656 * If buf ends with suffix, return 1 and subtract the length of the suffix
657 * from *len. Otherwise, return 0 and leave *len untouched.
659 static inline int strip_suffix_mem(const char *buf
, size_t *len
,
662 size_t suflen
= strlen(suffix
);
663 if (*len
< suflen
|| memcmp(buf
+ (*len
- suflen
), suffix
, suflen
))
670 * If str ends with suffix, return 1 and set *len to the size of the string
671 * without the suffix. Otherwise, return 0 and set *len to the size of the
674 * Note that we do _not_ NUL-terminate str to the new length.
676 static inline int strip_suffix(const char *str
, const char *suffix
, size_t *len
)
679 return strip_suffix_mem(str
, len
, suffix
);
682 static inline int ends_with(const char *str
, const char *suffix
)
685 return strip_suffix(str
, suffix
, &len
);
688 #define SWAP(a, b) do { \
689 void *_swap_a_ptr = &(a); \
690 void *_swap_b_ptr = &(b); \
691 unsigned char _swap_buffer[sizeof(a)]; \
692 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
693 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
694 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
695 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
698 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
703 #define MAP_PRIVATE 1
706 #define mmap git_mmap
707 #define munmap git_munmap
708 void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
709 int git_munmap(void *start
, size_t length
);
711 #else /* NO_MMAP || USE_WIN32_MMAP */
713 #include <sys/mman.h>
715 #endif /* NO_MMAP || USE_WIN32_MMAP */
719 /* This value must be multiple of (pagesize * 2) */
720 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
724 /* This value must be multiple of (pagesize * 2) */
725 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
726 (sizeof(void*) >= 8 \
727 ? 1 * 1024 * 1024 * 1024 \
733 #define MAP_FAILED ((void *)-1)
736 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
737 #define on_disk_bytes(st) ((st).st_size)
739 #define on_disk_bytes(st) ((st).st_blocks * 512)
742 #ifdef NEEDS_MODE_TRANSLATION
751 #define S_IFMT 0170000
752 #define S_IFREG 0100000
753 #define S_IFDIR 0040000
754 #define S_IFLNK 0120000
755 #define S_IFBLK 0060000
756 #define S_IFCHR 0020000
757 #define S_IFIFO 0010000
758 #define S_IFSOCK 0140000
762 #define stat(path, buf) git_stat(path, buf)
763 int git_stat(const char *, struct stat
*);
767 #define fstat(fd, buf) git_fstat(fd, buf)
768 int git_fstat(int, struct stat
*);
772 #define lstat(path, buf) git_lstat(path, buf)
773 int git_lstat(const char *, struct stat
*);
776 #define DEFAULT_PACKED_GIT_LIMIT \
777 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
780 #define pread git_pread
781 ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
784 * Forward decl that will remind us if its twin in cache.h changes.
785 * This function is used in compat/pread.c. But we can't include
788 ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
791 #define setenv gitsetenv
792 int gitsetenv(const char *, const char *, int);
796 #define mkdtemp gitmkdtemp
797 char *gitmkdtemp(char *);
801 #define unsetenv gitunsetenv
802 void gitunsetenv(const char *);
806 #define strcasestr gitstrcasestr
807 char *gitstrcasestr(const char *haystack
, const char *needle
);
811 #define strlcpy gitstrlcpy
812 size_t gitstrlcpy(char *, const char *, size_t);
816 #define strtoumax gitstrtoumax
817 uintmax_t gitstrtoumax(const char *, char **, int);
818 #define strtoimax gitstrtoimax
819 intmax_t gitstrtoimax(const char *, char **, int);
823 #define hstrerror githstrerror
824 const char *githstrerror(int herror
);
828 #define memmem gitmemmem
829 void *gitmemmem(const void *haystack
, size_t haystacklen
,
830 const void *needle
, size_t needlelen
);
833 #ifdef OVERRIDE_STRDUP
837 #define strdup gitstrdup
838 char *gitstrdup(const char *s
);
841 #ifdef NO_GETPAGESIZE
842 #define getpagesize() sysconf(_SC_PAGESIZE)
849 #ifdef FREAD_READS_DIRECTORIES
850 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
854 # define fopen(a,b) git_fopen(a,b)
856 FILE *git_fopen(const char*, const char*);
859 #ifdef SNPRINTF_RETURNS_BOGUS
863 #define snprintf git_snprintf
864 int git_snprintf(char *str
, size_t maxsize
,
865 const char *format
, ...);
869 #define vsnprintf git_vsnprintf
870 int git_vsnprintf(char *str
, size_t maxsize
,
871 const char *format
, va_list ap
);
874 #ifdef OPEN_RETURNS_EINTR
876 #define open git_open_with_retry
877 int git_open_with_retry(const char *path
, int flag
, ...);
880 #ifdef __GLIBC_PREREQ
881 #if __GLIBC_PREREQ(2, 1)
882 #define HAVE_STRCHRNUL
886 #ifndef HAVE_STRCHRNUL
887 #define strchrnul gitstrchrnul
888 static inline char *gitstrchrnul(const char *s
, int c
)
890 while (*s
&& *s
!= c
)
897 int inet_pton(int af
, const char *src
, void *dst
);
901 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
905 #define atexit git_atexit
906 int git_atexit(void (*handler
)(void));
909 static inline size_t st_add(size_t a
, size_t b
)
911 if (unsigned_add_overflows(a
, b
))
912 die("size_t overflow: %"PRIuMAX
" + %"PRIuMAX
,
913 (uintmax_t)a
, (uintmax_t)b
);
916 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
917 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
919 static inline size_t st_mult(size_t a
, size_t b
)
921 if (unsigned_mult_overflows(a
, b
))
922 die("size_t overflow: %"PRIuMAX
" * %"PRIuMAX
,
923 (uintmax_t)a
, (uintmax_t)b
);
927 static inline size_t st_sub(size_t a
, size_t b
)
930 die("size_t underflow: %"PRIuMAX
" - %"PRIuMAX
,
931 (uintmax_t)a
, (uintmax_t)b
);
935 static inline int cast_size_t_to_int(size_t a
)
938 die("number too large to represent as int on this platform: %"PRIuMAX
,
945 # define xalloca(size) (alloca(size))
946 # define xalloca_free(p) do {} while (0)
948 # define xalloca(size) (xmalloc(size))
949 # define xalloca_free(p) (free(p))
951 char *xstrdup(const char *str
);
952 void *xmalloc(size_t size
);
953 void *xmallocz(size_t size
);
954 void *xmallocz_gently(size_t size
);
955 void *xmemdupz(const void *data
, size_t len
);
956 char *xstrndup(const char *str
, size_t len
);
957 void *xrealloc(void *ptr
, size_t size
);
958 void *xcalloc(size_t nmemb
, size_t size
);
959 void xsetenv(const char *name
, const char *value
, int overwrite
);
960 void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
961 const char *mmap_os_err(void);
962 void *xmmap_gently(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
963 int xopen(const char *path
, int flags
, ...);
964 ssize_t
xread(int fd
, void *buf
, size_t len
);
965 ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
966 ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
);
968 FILE *xfopen(const char *path
, const char *mode
);
969 FILE *xfdopen(int fd
, const char *mode
);
970 int xmkstemp(char *temp_filename
);
971 int xmkstemp_mode(char *temp_filename
, int mode
);
973 FILE *fopen_for_writing(const char *path
);
974 FILE *fopen_or_warn(const char *path
, const char *mode
);
977 * Like strncmp, but only return zero if s is NUL-terminated and exactly len
978 * characters long. If it is not, consider it greater than t.
980 int xstrncmpz(const char *s
, const char *t
, size_t len
);
983 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
984 * that ptr is used twice, so don't pass e.g. ptr++.
986 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
988 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
989 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
990 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
992 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
993 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
994 static inline void copy_array(void *dst
, const void *src
, size_t n
, size_t size
)
997 memcpy(dst
, src
, st_mult(size
, n
));
1000 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
1001 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
1002 static inline void move_array(void *dst
, const void *src
, size_t n
, size_t size
)
1005 memmove(dst
, src
, st_mult(size
, n
));
1009 * These functions help you allocate structs with flex arrays, and copy
1010 * the data directly into the array. For example, if you had:
1014 * char name[FLEX_ARRAY];
1020 * FLEX_ALLOC_MEM(f, name, src, len);
1022 * to allocate a "foo" with the contents of "src" in the "name" field.
1023 * The resulting struct is automatically zero'd, and the flex-array field
1024 * is NUL-terminated (whether the incoming src buffer was or not).
1026 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
1027 * but do want to store a pointer to some extra data in the same allocated
1028 * block. For example, if you have:
1038 * FLEXPTR_ALLOC_STR(f, name, src);
1040 * and "name" will point to a block of memory after the struct, which will be
1041 * freed along with the struct (but the pointer can be repointed anywhere).
1043 * The *_STR variants accept a string parameter rather than a ptr/len
1046 * Note that these macros will evaluate the first parameter multiple
1047 * times, and it must be assignable as an lvalue.
1049 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
1050 size_t flex_array_len_ = (len); \
1051 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1052 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
1054 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
1055 size_t flex_array_len_ = (len); \
1056 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1057 memcpy((x) + 1, (buf), flex_array_len_); \
1058 (x)->ptrname = (void *)((x)+1); \
1060 #define FLEX_ALLOC_STR(x, flexname, str) \
1061 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1062 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1063 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1065 static inline char *xstrdup_or_null(const char *str
)
1067 return str
? xstrdup(str
) : NULL
;
1070 static inline size_t xsize_t(off_t len
)
1072 if (len
< 0 || (uintmax_t) len
> SIZE_MAX
)
1073 die("Cannot handle files this big");
1074 return (size_t) len
;
1077 __attribute__((format (printf
, 3, 4)))
1078 int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...);
1080 #ifndef HOST_NAME_MAX
1081 #define HOST_NAME_MAX 256
1084 int xgethostname(char *buf
, size_t len
);
1086 /* in ctype.c, for kwset users */
1087 extern const unsigned char tolower_trans_tbl
[256];
1089 /* Sane ctype - no locale, and works with signed chars */
1104 extern const unsigned char sane_ctype
[256];
1105 #define GIT_SPACE 0x01
1106 #define GIT_DIGIT 0x02
1107 #define GIT_ALPHA 0x04
1108 #define GIT_GLOB_SPECIAL 0x08
1109 #define GIT_REGEX_SPECIAL 0x10
1110 #define GIT_PATHSPEC_MAGIC 0x20
1111 #define GIT_CNTRL 0x40
1112 #define GIT_PUNCT 0x80
1113 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1114 #define isascii(x) (((x) & ~0x7f) == 0)
1115 #define isspace(x) sane_istest(x,GIT_SPACE)
1116 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1117 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1118 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1119 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1120 #define islower(x) sane_iscase(x, 1)
1121 #define isupper(x) sane_iscase(x, 0)
1122 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1123 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1124 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1125 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1126 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1127 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1128 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1129 #define toupper(x) sane_case((unsigned char)(x), 0)
1130 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1132 static inline int sane_case(int x
, int high
)
1134 if (sane_istest(x
, GIT_ALPHA
))
1135 x
= (x
& ~0x20) | high
;
1139 static inline int sane_iscase(int x
, int is_lower
)
1141 if (!sane_istest(x
, GIT_ALPHA
))
1145 return (x
& 0x20) != 0;
1147 return (x
& 0x20) == 0;
1151 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1152 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1153 * locale-specific conversions).
1155 static inline int skip_iprefix(const char *str
, const char *prefix
,
1163 } while (tolower(*str
++) == tolower(*prefix
++));
1167 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
1173 /* negative values would be accepted by strtoul */
1176 ul
= strtoul(s
, &p
, base
);
1177 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
1183 static inline int strtol_i(char const *s
, int base
, int *result
)
1189 ul
= strtol(s
, &p
, base
);
1190 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
1196 void git_stable_qsort(void *base
, size_t nmemb
, size_t size
,
1197 int(*compar
)(const void *, const void *));
1198 #ifdef INTERNAL_QSORT
1199 #define qsort git_stable_qsort
1202 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1203 static inline void sane_qsort(void *base
, size_t nmemb
, size_t size
,
1204 int(*compar
)(const void *, const void *))
1207 qsort(base
, nmemb
, size
, compar
);
1210 #define STABLE_QSORT(base, n, compar) \
1211 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1213 #ifndef HAVE_ISO_QSORT_S
1214 int git_qsort_s(void *base
, size_t nmemb
, size_t size
,
1215 int (*compar
)(const void *, const void *, void *), void *ctx
);
1216 #define qsort_s git_qsort_s
1219 #define QSORT_S(base, n, compar, ctx) do { \
1220 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1221 BUG("qsort_s() failed"); \
1224 #ifndef REG_STARTEND
1225 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1228 static inline int regexec_buf(const regex_t
*preg
, const char *buf
, size_t size
,
1229 size_t nmatch
, regmatch_t pmatch
[], int eflags
)
1231 assert(nmatch
> 0 && pmatch
);
1232 pmatch
[0].rm_so
= 0;
1233 pmatch
[0].rm_eo
= size
;
1234 return regexec(preg
, buf
, nmatch
, pmatch
, eflags
| REG_STARTEND
);
1237 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1238 # define FORCE_DIR_SET_GID S_ISGID
1240 # define FORCE_DIR_SET_GID 0
1245 #define ST_CTIME_NSEC(st) 0
1246 #define ST_MTIME_NSEC(st) 0
1248 #ifdef USE_ST_TIMESPEC
1249 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1250 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1252 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1253 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1257 #ifdef UNRELIABLE_FSTAT
1258 #define fstat_is_reliable() 0
1260 #define fstat_is_reliable() 1
1265 * Since an obvious implementation of va_list would be to make it a
1266 * pointer into the stack frame, a simple assignment will work on
1267 * many systems. But let's try to be more portable.
1270 #define va_copy(dst, src) __va_copy(dst, src)
1272 #define va_copy(dst, src) ((dst) = (src))
1277 * This is always defined as a first step towards making the use of variadic
1278 * macros unconditional. If it causes compilation problems on your platform,
1279 * please report it to the Git mailing list at git@vger.kernel.org.
1281 #define HAVE_VARIADIC_MACROS 1
1283 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1284 extern int BUG_exit_code
;
1286 #ifdef HAVE_VARIADIC_MACROS
1287 __attribute__((format (printf
, 3, 4))) NORETURN
1288 void BUG_fl(const char *file
, int line
, const char *fmt
, ...);
1289 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1291 __attribute__((format (printf
, 1, 2))) NORETURN
1292 void BUG(const char *fmt
, ...);
1296 * Preserves errno, prints a message, but gives no warning for ENOENT.
1297 * Returns 0 on success, which includes trying to unlink an object that does
1300 int unlink_or_warn(const char *path
);
1302 * Tries to unlink file. Returns 0 if unlink succeeded
1303 * or the file already didn't exist. Returns -1 and
1304 * appends a message to err suitable for
1305 * 'error("%s", err->buf)' on error.
1307 int unlink_or_msg(const char *file
, struct strbuf
*err
);
1309 * Preserves errno, prints a message, but gives no warning for ENOENT.
1310 * Returns 0 on success, which includes trying to remove a directory that does
1313 int rmdir_or_warn(const char *path
);
1315 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1316 * the supplied file mode.
1318 int remove_or_warn(unsigned int mode
, const char *path
);
1321 * Call access(2), but warn for any error except "missing file"
1322 * (ENOENT or ENOTDIR).
1324 #define ACCESS_EACCES_OK (1U << 0)
1325 int access_or_warn(const char *path
, int mode
, unsigned flag
);
1326 int access_or_die(const char *path
, int mode
, unsigned flag
);
1328 /* Warn on an inaccessible file if errno indicates this is an error */
1329 int warn_on_fopen_errors(const char *path
);
1332 * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent
1333 * may be racy. Do not use this as protection against an attacker who can
1334 * simultaneously create paths.
1336 int open_nofollow(const char *path
, int flags
);
1339 # define SHELL_PATH "/bin/sh"
1342 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1343 static inline void flockfile(FILE *fh
)
1347 static inline void funlockfile(FILE *fh
)
1351 #define getc_unlocked(fh) getc(fh)
1354 #ifdef FILENO_IS_A_MACRO
1355 int git_fileno(FILE *stream
);
1356 # ifndef COMPAT_CODE_FILENO
1358 # define fileno(p) git_fileno(p)
1362 #ifdef NEED_ACCESS_ROOT_HANDLER
1363 int git_access(const char *path
, int mode
);
1364 # ifndef COMPAT_CODE_ACCESS
1368 # define access(path, mode) git_access(path, mode)
1373 * Our code often opens a path to an optional file, to work on its
1374 * contents when we can successfully open it. We can ignore a failure
1375 * to open if such an optional file does not exist, but we do want to
1376 * report a failure in opening for other reasons (e.g. we got an I/O
1377 * error, or the file is there, but we lack the permission to open).
1379 * Call this function after seeing an error from open() or fopen() to
1380 * see if the errno indicates a missing file that we can safely ignore.
1382 static inline int is_missing_file_error(int errno_
)
1384 return (errno_
== ENOENT
|| errno_
== ENOTDIR
);
1387 int cmd_main(int, const char **);
1390 * Intercept all calls to exit() and route them to trace2 to
1391 * optionally emit a message before calling the real exit().
1393 int trace2_cmd_exit_fl(const char *file
, int line
, int code
);
1394 #define exit(code) exit(trace2_cmd_exit_fl(__FILE__, __LINE__, (code)))
1397 * You can mark a stack variable with UNLEAK(var) to avoid it being
1398 * reported as a leak by tools like LSAN or valgrind. The argument
1399 * should generally be the variable itself (not its address and not what
1400 * it points to). It's safe to use this on pointers which may already
1401 * have been freed, or on pointers which may still be in use.
1403 * Use this _only_ for a variable that leaks by going out of scope at
1404 * program exit (so only from cmd_* functions or their direct helpers).
1405 * Normal functions, especially those which may be called multiple
1406 * times, should actually free their memory. This is only meant as
1407 * an annotation, and does nothing in non-leak-checking builds.
1409 #ifdef SUPPRESS_ANNOTATED_LEAKS
1410 void unleak_memory(const void *ptr
, size_t len
);
1411 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1413 #define UNLEAK(var) do {} while (0)
1417 * This include must come after system headers, since it introduces macros that
1418 * replace system names.
1423 * container_of - Get the address of an object containing a field.
1425 * @ptr: pointer to the field.
1426 * @type: type of the object.
1427 * @member: name of the field within the object.
1429 #define container_of(ptr, type, member) \
1430 ((type *) ((char *)(ptr) - offsetof(type, member)))
1433 * helper function for `container_of_or_null' to avoid multiple
1434 * evaluation of @ptr
1436 static inline void *container_of_or_null_offset(void *ptr
, size_t offset
)
1438 return ptr
? (char *)ptr
- offset
: NULL
;
1442 * like `container_of', but allows returned value to be NULL
1444 #define container_of_or_null(ptr, type, member) \
1445 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1448 * like offsetof(), but takes a pointer to a variable of type which
1449 * contains @member, instead of a specified type.
1450 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1453 #if defined(__GNUC__) /* clang sets this, too */
1454 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1455 #else /* !__GNUC__ */
1456 #define OFFSETOF_VAR(ptr, member) \
1457 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1458 #endif /* !__GNUC__ */
1460 void sleep_millisec(int millisec
);