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)
132 * On Solaris, when _XOPEN_EXTENDED is set, its header file
133 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
134 * setting to say we are XPG5 or XPG6. Also on Solaris,
135 * XPG6 programs must be compiled with a c99 compiler, while
136 * non XPG6 programs must be compiled with a pre-c99 compiler.
138 # if __STDC_VERSION__ - 0 >= 199901L
139 # define _XOPEN_SOURCE 600
141 # define _XOPEN_SOURCE 500
143 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
144 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
145 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
147 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
148 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
150 #define _ALL_SOURCE 1
151 #define _GNU_SOURCE 1
152 #define _BSD_SOURCE 1
153 #define _DEFAULT_SOURCE 1
154 #define _NETBSD_SOURCE 1
155 #define _SGI_SOURCE 1
157 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
158 # if !defined(_WIN32_WINNT)
159 # define _WIN32_WINNT 0x0600
161 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
162 #include <winsock2.h>
164 #define GIT_WINDOWS_NATIVE
169 #include <sys/stat.h>
175 #ifdef HAVE_STRINGS_H
176 #include <strings.h> /* for strcasecmp() */
180 #ifdef NEEDS_SYS_PARAM_H
181 #include <sys/param.h>
183 #include <sys/types.h>
185 #include <sys/time.h>
192 #if !defined(NO_POLL_H)
194 #elif !defined(NO_SYS_POLL_H)
195 #include <sys/poll.h>
197 /* Pull the compat stuff */
200 #ifdef HAVE_BSD_SYSCTL
201 #include <sys/sysctl.h>
204 #if defined(__CYGWIN__)
205 #include "compat/win32/path-utils.h"
207 #if defined(__MINGW32__)
208 /* pull in Windows compatibility stuff */
209 #include "compat/win32/path-utils.h"
210 #include "compat/mingw.h"
211 #elif defined(_MSC_VER)
212 #include "compat/win32/path-utils.h"
213 #include "compat/msvc.h"
215 #include <sys/utsname.h>
216 #include <sys/wait.h>
217 #include <sys/resource.h>
218 #include <sys/socket.h>
219 #include <sys/ioctl.h>
221 #ifndef NO_SYS_SELECT_H
222 #include <sys/select.h>
224 #include <netinet/in.h>
225 #include <netinet/tcp.h>
226 #include <arpa/inet.h>
230 #ifndef NO_INTTYPES_H
231 #include <inttypes.h>
237 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
238 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
239 * while on IP16 and IP16L32 it is "int" (resp. "short")
240 * Size needs to match (or exceed) 'sizeof(void *)'.
241 * We can't take "long long" here as not everybody has it.
243 typedef long intptr_t;
244 typedef unsigned long uintptr_t;
246 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
248 #define _ALL_SOURCE 1
251 /* used on Mac OS X */
252 #ifdef PRECOMPOSE_UNICODE
253 #include "compat/precompose_utf8.h"
255 #define precompose_str(in,i_nfd2nfc)
256 #define precompose_argv(c,v)
257 #define probe_utf8_pathname_composition()
260 #ifdef MKDIR_WO_TRAILING_SLASH
261 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
262 int compat_mkdir_wo_trailing_slash(const char*, mode_t);
265 #ifdef NO_STRUCT_ITIMERVAL
267 struct timeval it_interval;
268 struct timeval it_value;
273 #define setitimer(which,value,ovalue)
279 #define basename gitbasename
280 char *gitbasename(char *);
281 #define dirname gitdirname
282 char *gitdirname(char *);
291 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
292 #include <AvailabilityMacros.h>
293 #undef DEPRECATED_ATTRIBUTE
294 #define DEPRECATED_ATTRIBUTE
295 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
297 #include <openssl/ssl.h>
298 #include <openssl/err.h>
302 # include <sys/sysinfo.h>
305 /* On most systems <netdb.h> would have given us this, but
306 * not on some systems (e.g. z/OS).
309 #define NI_MAXHOST 1025
313 #define NI_MAXSERV 32
316 /* On most systems <limits.h> would have given us this, but
317 * not on some systems (e.g. GNU/Hurd).
320 #define PATH_MAX 4096
323 typedef uintmax_t timestamp_t;
324 #define PRItime PRIuMAX
325 #define parse_timestamp strtoumax
326 #define TIME_MAX UINTMAX_MAX
336 #ifndef _PATH_DEFPATH
337 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
340 #ifndef platform_core_config
341 static inline int noop_core_config(const char *var, const char *value, void *cb)
345 #define platform_core_config noop_core_config
348 #ifndef has_dos_drive_prefix
349 static inline int git_has_dos_drive_prefix(const char *path)
353 #define has_dos_drive_prefix git_has_dos_drive_prefix
356 #ifndef skip_dos_drive_prefix
357 static inline int git_skip_dos_drive_prefix(char **path)
361 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
365 static inline int git_is_dir_sep(int c)
369 #define is_dir_sep git_is_dir_sep
372 #ifndef offset_1st_component
373 static inline int git_offset_1st_component(const char *path)
375 return is_dir_sep(path[0]);
377 #define offset_1st_component git_offset_1st_component
380 #ifndef find_last_dir_sep
381 static inline char *git_find_last_dir_sep(const char *path)
383 return strrchr(path, '/');
385 #define find_last_dir_sep git_find_last_dir_sep
388 #ifndef query_user_email
389 #define query_user_email() NULL
393 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
394 #include <floss.h(floss_getpwuid)>
397 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
398 * known, by detective work using kill -l as a list is all signals
399 * instead of signal.h where it should be.
405 #if defined(__HP_cc) && (__HP_cc >= 61000)
406 #define NORETURN __attribute__((noreturn))
408 #elif defined(__GNUC__) && !defined(NO_NORETURN)
409 #define NORETURN __attribute__((__noreturn__))
410 #define NORETURN_PTR __attribute__((__noreturn__))
411 #elif defined(_MSC_VER)
412 #define NORETURN __declspec(noreturn)
418 #ifndef __attribute__
419 #define __attribute__(x)
424 /* The sentinel attribute is valid from gcc version 4.0 */
425 #if defined(__GNUC__) && (__GNUC__ >= 4)
426 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
428 #define LAST_ARG_MUST_BE_NULL
431 #define MAYBE_UNUSED __attribute__((__unused__))
433 #include "compat/bswap.h"
435 #include "wildmatch.h"
439 /* General helper functions */
440 void vreportf(const char *prefix, const char *err, va_list params);
441 NORETURN void usage(const char *err);
442 NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
443 NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
444 NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
445 int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
446 int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
447 void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
448 void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
451 #ifdef APPLE_COMMON_CRYPTO
452 #include "compat/apple-common-crypto.h"
454 #include <openssl/evp.h>
455 #include <openssl/hmac.h>
456 #endif /* APPLE_COMMON_CRYPTO */
457 #include <openssl/x509v3.h>
458 #endif /* NO_OPENSSL */
461 * Let callers be aware of the constant return value; this can help
462 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
463 * because some compilers may not support variadic macros. Since we're only
464 * trying to help gcc, anyway, it's OK; other compilers will fall back to
465 * using the function as usual.
467 #if defined(__GNUC__)
468 static inline int const_error(void)
472 #define error(...) (error(__VA_ARGS__), const_error())
473 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
476 void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
477 void set_error_routine(void (*routine)(const char *err, va_list params));
478 extern void (*get_error_routine(void))(const char *err, va_list params);
479 void set_warn_routine(void (*routine)(const char *warn, va_list params));
480 extern void (*get_warn_routine(void))(const char *warn, va_list params);
481 void set_die_is_recursing_routine(int (*routine)(void));
483 int starts_with(const char *str, const char *prefix);
484 int istarts_with(const char *str, const char *prefix);
487 * If the string "str" begins with the string found in "prefix", return 1.
488 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
489 * the string right after the prefix).
491 * Otherwise, return 0 and leave "out" untouched.
495 * [extract branch name, fail if not a branch]
496 * if (!skip_prefix(ref, "refs/heads/", &branch)
499 * [skip prefix if present, otherwise use whole string]
500 * skip_prefix(name, "refs/heads/", &name);
502 static inline int skip_prefix(const char *str, const char *prefix,
510 } while (*str++ == *prefix++);
515 * If the string "str" is the same as the string in "prefix", then the "arg"
516 * parameter is set to the "def" parameter and 1 is returned.
517 * If the string "str" begins with the string found in "prefix" and then a
518 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
519 * (i.e., to the point in the string right after the prefix and the "=" sign),
522 * Otherwise, return 0 and leave "arg" untouched.
524 * When we accept both a "--key" and a "--key=<val>" option, this function
525 * can be used instead of !strcmp(arg, "--key") and then
526 * skip_prefix(arg, "--key=", &arg) to parse such an option.
528 int skip_to_optional_arg_default(const char *str, const char *prefix,
529 const char **arg, const char *def);
531 static inline int skip_to_optional_arg(const char *str, const char *prefix,
534 return skip_to_optional_arg_default(str, prefix, arg, "");
538 * Like skip_prefix, but promises never to read past "len" bytes of the input
539 * buffer, and returns the remaining number of bytes in "out" via "outlen".
541 static inline int skip_prefix_mem(const char *buf, size_t len,
543 const char **out, size_t *outlen)
545 size_t prefix_len = strlen(prefix);
546 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
547 *out = buf + prefix_len;
548 *outlen = len - prefix_len;
555 * If buf ends with suffix, return 1 and subtract the length of the suffix
556 * from *len. Otherwise, return 0 and leave *len untouched.
558 static inline int strip_suffix_mem(const char *buf, size_t *len,
561 size_t suflen = strlen(suffix);
562 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
569 * If str ends with suffix, return 1 and set *len to the size of the string
570 * without the suffix. Otherwise, return 0 and set *len to the size of the
573 * Note that we do _not_ NUL-terminate str to the new length.
575 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
578 return strip_suffix_mem(str, len, suffix);
581 static inline int ends_with(const char *str, const char *suffix)
584 return strip_suffix(str, suffix, &len);
587 #define SWAP(a, b) do { \
588 void *_swap_a_ptr = &(a); \
589 void *_swap_b_ptr = &(b); \
590 unsigned char _swap_buffer[sizeof(a)]; \
591 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
592 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
593 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
594 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
597 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
602 #define MAP_PRIVATE 1
605 #define mmap git_mmap
606 #define munmap git_munmap
607 void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
608 int git_munmap(void *start, size_t length);
610 #else /* NO_MMAP || USE_WIN32_MMAP */
612 #include <sys/mman.h>
614 #endif /* NO_MMAP || USE_WIN32_MMAP */
618 /* This value must be multiple of (pagesize * 2) */
619 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
623 /* This value must be multiple of (pagesize * 2) */
624 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
625 (sizeof(void*) >= 8 \
626 ? 1 * 1024 * 1024 * 1024 \
632 #define MAP_FAILED ((void *)-1)
635 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
636 #define on_disk_bytes(st) ((st).st_size)
638 #define on_disk_bytes(st) ((st).st_blocks * 512)
641 #ifdef NEEDS_MODE_TRANSLATION
650 #define S_IFMT 0170000
651 #define S_IFREG 0100000
652 #define S_IFDIR 0040000
653 #define S_IFLNK 0120000
654 #define S_IFBLK 0060000
655 #define S_IFCHR 0020000
656 #define S_IFIFO 0010000
657 #define S_IFSOCK 0140000
661 #define stat(path, buf) git_stat(path, buf)
662 int git_stat(const char *, struct stat *);
666 #define fstat(fd, buf) git_fstat(fd, buf)
667 int git_fstat(int, struct stat *);
671 #define lstat(path, buf) git_lstat(path, buf)
672 int git_lstat(const char *, struct stat *);
675 #define DEFAULT_PACKED_GIT_LIMIT \
676 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
679 #define pread git_pread
680 ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
683 * Forward decl that will remind us if its twin in cache.h changes.
684 * This function is used in compat/pread.c. But we can't include
687 ssize_t read_in_full(int fd, void *buf, size_t count);
690 #define setenv gitsetenv
691 int gitsetenv(const char *, const char *, int);
695 #define mkdtemp gitmkdtemp
696 char *gitmkdtemp(char *);
700 #define unsetenv gitunsetenv
701 void gitunsetenv(const char *);
705 #define strcasestr gitstrcasestr
706 char *gitstrcasestr(const char *haystack, const char *needle);
710 #define strlcpy gitstrlcpy
711 size_t gitstrlcpy(char *, const char *, size_t);
715 #define strtoumax gitstrtoumax
716 uintmax_t gitstrtoumax(const char *, char **, int);
717 #define strtoimax gitstrtoimax
718 intmax_t gitstrtoimax(const char *, char **, int);
722 #define hstrerror githstrerror
723 const char *githstrerror(int herror);
727 #define memmem gitmemmem
728 void *gitmemmem(const void *haystack, size_t haystacklen,
729 const void *needle, size_t needlelen);
732 #ifdef OVERRIDE_STRDUP
736 #define strdup gitstrdup
737 char *gitstrdup(const char *s);
740 #ifdef NO_GETPAGESIZE
741 #define getpagesize() sysconf(_SC_PAGESIZE)
748 #ifdef FREAD_READS_DIRECTORIES
749 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
753 # define fopen(a,b) git_fopen(a,b)
755 FILE *git_fopen(const char*, const char*);
758 #ifdef SNPRINTF_RETURNS_BOGUS
762 #define snprintf git_snprintf
763 int git_snprintf(char *str, size_t maxsize,
764 const char *format, ...);
768 #define vsnprintf git_vsnprintf
769 int git_vsnprintf(char *str, size_t maxsize,
770 const char *format, va_list ap);
773 #ifdef __GLIBC_PREREQ
774 #if __GLIBC_PREREQ(2, 1)
775 #define HAVE_STRCHRNUL
779 #ifndef HAVE_STRCHRNUL
780 #define strchrnul gitstrchrnul
781 static inline char *gitstrchrnul(const char *s, int c)
783 while (*s && *s != c)
790 int inet_pton(int af, const char *src, void *dst);
794 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
798 #define atexit git_atexit
799 int git_atexit(void (*handler)(void));
802 static inline size_t st_add(size_t a, size_t b)
804 if (unsigned_add_overflows(a, b))
805 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
806 (uintmax_t)a, (uintmax_t)b);
809 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
810 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
812 static inline size_t st_mult(size_t a, size_t b)
814 if (unsigned_mult_overflows(a, b))
815 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
816 (uintmax_t)a, (uintmax_t)b);
820 static inline size_t st_sub(size_t a, size_t b)
823 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
824 (uintmax_t)a, (uintmax_t)b);
830 # define xalloca(size) (alloca(size))
831 # define xalloca_free(p) do {} while (0)
833 # define xalloca(size) (xmalloc(size))
834 # define xalloca_free(p) (free(p))
836 char *xstrdup(const char *str);
837 void *xmalloc(size_t size);
838 void *xmallocz(size_t size);
839 void *xmallocz_gently(size_t size);
840 void *xmemdupz(const void *data, size_t len);
841 char *xstrndup(const char *str, size_t len);
842 void *xrealloc(void *ptr, size_t size);
843 void *xcalloc(size_t nmemb, size_t size);
844 void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
845 void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
846 int xopen(const char *path, int flags, ...);
847 ssize_t xread(int fd, void *buf, size_t len);
848 ssize_t xwrite(int fd, const void *buf, size_t len);
849 ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
851 FILE *xfopen(const char *path, const char *mode);
852 FILE *xfdopen(int fd, const char *mode);
853 int xmkstemp(char *temp_filename);
854 int xmkstemp_mode(char *temp_filename, int mode);
856 FILE *fopen_for_writing(const char *path);
857 FILE *fopen_or_warn(const char *path, const char *mode);
860 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
861 * that ptr is used twice, so don't pass e.g. ptr++.
863 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
865 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
866 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)));
867 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
869 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
870 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
871 static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
874 memcpy(dst, src, st_mult(size, n));
877 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
878 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
879 static inline void move_array(void *dst, const void *src, size_t n, size_t size)
882 memmove(dst, src, st_mult(size, n));
886 * These functions help you allocate structs with flex arrays, and copy
887 * the data directly into the array. For example, if you had:
891 * char name[FLEX_ARRAY];
897 * FLEX_ALLOC_MEM(f, name, src, len);
899 * to allocate a "foo" with the contents of "src" in the "name" field.
900 * The resulting struct is automatically zero'd, and the flex-array field
901 * is NUL-terminated (whether the incoming src buffer was or not).
903 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
904 * but do want to store a pointer to some extra data in the same allocated
905 * block. For example, if you have:
915 * FLEXPTR_ALLOC_STR(f, name, src);
917 * and "name" will point to a block of memory after the struct, which will be
918 * freed along with the struct (but the pointer can be repointed anywhere).
920 * The *_STR variants accept a string parameter rather than a ptr/len
923 * Note that these macros will evaluate the first parameter multiple
924 * times, and it must be assignable as an lvalue.
926 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
927 size_t flex_array_len_ = (len); \
928 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
929 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
931 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
932 size_t flex_array_len_ = (len); \
933 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
934 memcpy((x) + 1, (buf), flex_array_len_); \
935 (x)->ptrname = (void *)((x)+1); \
937 #define FLEX_ALLOC_STR(x, flexname, str) \
938 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
939 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
940 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
942 static inline char *xstrdup_or_null(const char *str)
944 return str ? xstrdup(str) : NULL;
947 static inline size_t xsize_t(off_t len)
949 size_t size = (size_t) len;
951 if (len != (off_t) size)
952 die("Cannot handle files this big");
956 __attribute__((format (printf, 3, 4)))
957 int xsnprintf(char *dst, size_t max, const char *fmt, ...);
959 #ifndef HOST_NAME_MAX
960 #define HOST_NAME_MAX 256
963 int xgethostname(char *buf, size_t len);
965 /* in ctype.c, for kwset users */
966 extern const unsigned char tolower_trans_tbl[256];
968 /* Sane ctype - no locale, and works with signed chars */
983 extern const unsigned char sane_ctype[256];
984 #define GIT_SPACE 0x01
985 #define GIT_DIGIT 0x02
986 #define GIT_ALPHA 0x04
987 #define GIT_GLOB_SPECIAL 0x08
988 #define GIT_REGEX_SPECIAL 0x10
989 #define GIT_PATHSPEC_MAGIC 0x20
990 #define GIT_CNTRL 0x40
991 #define GIT_PUNCT 0x80
992 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
993 #define isascii(x) (((x) & ~0x7f) == 0)
994 #define isspace(x) sane_istest(x,GIT_SPACE)
995 #define isdigit(x) sane_istest(x,GIT_DIGIT)
996 #define isalpha(x) sane_istest(x,GIT_ALPHA)
997 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
998 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
999 #define islower(x) sane_iscase(x, 1)
1000 #define isupper(x) sane_iscase(x, 0)
1001 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1002 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1003 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1004 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1005 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1006 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1007 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1008 #define toupper(x) sane_case((unsigned char)(x), 0)
1009 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1011 static inline int sane_case(int x, int high)
1013 if (sane_istest(x, GIT_ALPHA))
1014 x = (x & ~0x20) | high;
1018 static inline int sane_iscase(int x, int is_lower)
1020 if (!sane_istest(x, GIT_ALPHA))
1024 return (x & 0x20) != 0;
1026 return (x & 0x20) == 0;
1030 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1031 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1032 * locale-specific conversions).
1034 static inline int skip_iprefix(const char *str, const char *prefix,
1042 } while (tolower(*str++) == tolower(*prefix++));
1046 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1052 /* negative values would be accepted by strtoul */
1055 ul = strtoul(s, &p, base);
1056 if (errno || *p || p == s || (unsigned int) ul != ul)
1062 static inline int strtol_i(char const *s, int base, int *result)
1068 ul = strtol(s, &p, base);
1069 if (errno || *p || p == s || (int) ul != ul)
1075 void git_stable_qsort(void *base, size_t nmemb, size_t size,
1076 int(*compar)(const void *, const void *));
1077 #ifdef INTERNAL_QSORT
1078 #define qsort git_stable_qsort
1081 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1082 static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1083 int(*compar)(const void *, const void *))
1086 qsort(base, nmemb, size, compar);
1089 #define STABLE_QSORT(base, n, compar) \
1090 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1092 #ifndef HAVE_ISO_QSORT_S
1093 int git_qsort_s(void *base, size_t nmemb, size_t size,
1094 int (*compar)(const void *, const void *, void *), void *ctx);
1095 #define qsort_s git_qsort_s
1098 #define QSORT_S(base, n, compar, ctx) do { \
1099 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1100 BUG("qsort_s() failed"); \
1103 #ifndef REG_STARTEND
1104 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1107 static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1108 size_t nmatch, regmatch_t pmatch[], int eflags)
1110 assert(nmatch > 0 && pmatch);
1111 pmatch[0].rm_so = 0;
1112 pmatch[0].rm_eo = size;
1113 return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1116 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1117 # define FORCE_DIR_SET_GID S_ISGID
1119 # define FORCE_DIR_SET_GID 0
1124 #define ST_CTIME_NSEC(st) 0
1125 #define ST_MTIME_NSEC(st) 0
1127 #ifdef USE_ST_TIMESPEC
1128 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1129 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1131 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1132 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1136 #ifdef UNRELIABLE_FSTAT
1137 #define fstat_is_reliable() 0
1139 #define fstat_is_reliable() 1
1144 * Since an obvious implementation of va_list would be to make it a
1145 * pointer into the stack frame, a simple assignment will work on
1146 * many systems. But let's try to be more portable.
1149 #define va_copy(dst, src) __va_copy(dst, src)
1151 #define va_copy(dst, src) ((dst) = (src))
1155 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
1156 #define HAVE_VARIADIC_MACROS 1
1159 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1160 extern int BUG_exit_code;
1162 #ifdef HAVE_VARIADIC_MACROS
1163 __attribute__((format (printf, 3, 4))) NORETURN
1164 void BUG_fl(const char *file, int line, const char *fmt, ...);
1165 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1167 __attribute__((format (printf, 1, 2))) NORETURN
1168 void BUG(const char *fmt, ...);
1172 * Preserves errno, prints a message, but gives no warning for ENOENT.
1173 * Returns 0 on success, which includes trying to unlink an object that does
1176 int unlink_or_warn(const char *path);
1178 * Tries to unlink file. Returns 0 if unlink succeeded
1179 * or the file already didn't exist. Returns -1 and
1180 * appends a message to err suitable for
1181 * 'error("%s", err->buf)' on error.
1183 int unlink_or_msg(const char *file, struct strbuf *err);
1185 * Preserves errno, prints a message, but gives no warning for ENOENT.
1186 * Returns 0 on success, which includes trying to remove a directory that does
1189 int rmdir_or_warn(const char *path);
1191 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1192 * the supplied file mode.
1194 int remove_or_warn(unsigned int mode, const char *path);
1197 * Call access(2), but warn for any error except "missing file"
1198 * (ENOENT or ENOTDIR).
1200 #define ACCESS_EACCES_OK (1U << 0)
1201 int access_or_warn(const char *path, int mode, unsigned flag);
1202 int access_or_die(const char *path, int mode, unsigned flag);
1204 /* Warn on an inaccessible file if errno indicates this is an error */
1205 int warn_on_fopen_errors(const char *path);
1207 #ifdef GMTIME_UNRELIABLE_ERRORS
1208 struct tm *git_gmtime(const time_t *);
1209 struct tm *git_gmtime_r(const time_t *, struct tm *);
1210 #define gmtime git_gmtime
1211 #define gmtime_r git_gmtime_r
1214 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1215 #define USE_PARENS_AROUND_GETTEXT_N 1
1219 # define SHELL_PATH "/bin/sh"
1222 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1223 #define flockfile(fh)
1224 #define funlockfile(fh)
1225 #define getc_unlocked(fh) getc(fh)
1228 #ifdef FILENO_IS_A_MACRO
1229 int git_fileno(FILE *stream);
1230 # ifndef COMPAT_CODE_FILENO
1232 # define fileno(p) git_fileno(p)
1236 #ifdef NEED_ACCESS_ROOT_HANDLER
1237 int git_access(const char *path, int mode);
1238 # ifndef COMPAT_CODE_ACCESS
1242 # define access(path, mode) git_access(path, mode)
1247 * Our code often opens a path to an optional file, to work on its
1248 * contents when we can successfully open it. We can ignore a failure
1249 * to open if such an optional file does not exist, but we do want to
1250 * report a failure in opening for other reasons (e.g. we got an I/O
1251 * error, or the file is there, but we lack the permission to open).
1253 * Call this function after seeing an error from open() or fopen() to
1254 * see if the errno indicates a missing file that we can safely ignore.
1256 static inline int is_missing_file_error(int errno_)
1258 return (errno_ == ENOENT || errno_ == ENOTDIR);
1261 int cmd_main(int, const char **);
1264 * Intercept all calls to exit() and route them to trace2 to
1265 * optionally emit a message before calling the real exit().
1267 int trace2_cmd_exit_fl(const char *file, int line, int code);
1268 #define exit(code) exit(trace2_cmd_exit_fl(__FILE__, __LINE__, (code)))
1271 * You can mark a stack variable with UNLEAK(var) to avoid it being
1272 * reported as a leak by tools like LSAN or valgrind. The argument
1273 * should generally be the variable itself (not its address and not what
1274 * it points to). It's safe to use this on pointers which may already
1275 * have been freed, or on pointers which may still be in use.
1277 * Use this _only_ for a variable that leaks by going out of scope at
1278 * program exit (so only from cmd_* functions or their direct helpers).
1279 * Normal functions, especially those which may be called multiple
1280 * times, should actually free their memory. This is only meant as
1281 * an annotation, and does nothing in non-leak-checking builds.
1283 #ifdef SUPPRESS_ANNOTATED_LEAKS
1284 void unleak_memory(const void *ptr, size_t len);
1285 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1287 #define UNLEAK(var) do {} while (0)
1291 * This include must come after system headers, since it introduces macros that
1292 * replace system names.
1297 * container_of - Get the address of an object containing a field.
1299 * @ptr: pointer to the field.
1300 * @type: type of the object.
1301 * @member: name of the field within the object.
1303 #define container_of(ptr, type, member) \
1304 ((type *) ((char *)(ptr) - offsetof(type, member)))
1307 * helper function for `container_of_or_null' to avoid multiple
1308 * evaluation of @ptr
1310 static inline void *container_of_or_null_offset(void *ptr, size_t offset)
1312 return ptr ? (char *)ptr - offset : NULL;
1316 * like `container_of', but allows returned value to be NULL
1318 #define container_of_or_null(ptr, type, member) \
1319 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1322 * like offsetof(), but takes a pointer to a a variable of type which
1323 * contains @member, instead of a specified type.
1324 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1327 #if defined(__GNUC__) /* clang sets this, too */
1328 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1329 #else /* !__GNUC__ */
1330 #define OFFSETOF_VAR(ptr, member) \
1331 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1332 #endif /* !__GNUC__ */