1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
7 /* Derived from Linux "Features Test Macro" header
8 * Convenience macros to test the versions of gcc (or
9 * a compatible compiler).
11 * #if GIT_GNUC_PREREQ (2,8)
12 * ... code requiring gcc 2.8 or later ...
15 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
16 # define GIT_GNUC_PREREQ(maj, min) \
17 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
19 #define GIT_GNUC_PREREQ(maj, min) 0
25 * See if our compiler is known to support flexible array members.
27 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
28 # define FLEX_ARRAY /* empty */
29 #elif defined(__GNUC__)
31 # define FLEX_ARRAY /* empty */
33 # define FLEX_ARRAY 0 /* older GNU extension */
38 * Otherwise, default to safer but a bit wasteful traditional style
47 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
48 * @cond: the compile-time condition which must be true.
50 * Your compile will fail if the condition isn't true, or can't be evaluated
51 * by the compiler. This can be used in an expression: its value is "0".
54 * #define foo_to_char(foo) \
56 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
58 #define BUILD_ASSERT_OR_ZERO(cond) \
59 (sizeof(char [1 - 2*!(cond)]) - 1)
61 #if GIT_GNUC_PREREQ(3, 1)
62 /* &arr[0] degrades to a pointer: a different type from an array */
63 # define BARF_UNLESS_AN_ARRAY(arr) \
64 BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
65 __typeof__(&(arr)[0])))
67 # define BARF_UNLESS_AN_ARRAY(arr) 0
70 * ARRAY_SIZE - get the number of elements in a visible array
71 * <at> x: the array whose size you want.
73 * This does not work on pointers, or arrays declared as [], or
74 * function parameters. With correct compiler support, such usage
75 * will cause a build error (see the build_assert_or_zero macro).
77 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
79 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
81 #define maximum_signed_value_of_type(a) \
82 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
84 #define maximum_unsigned_value_of_type(a) \
85 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
88 * Signed integer overflow is undefined in C, so here's a helper macro
89 * to detect if the sum of two integers will overflow.
91 * Requires: a >= 0, typeof(a) equals typeof(b)
93 #define signed_add_overflows(a, b) \
94 ((b) > maximum_signed_value_of_type(a) - (a))
96 #define unsigned_add_overflows(a, b) \
97 ((b) > maximum_unsigned_value_of_type(a) - (a))
100 * Returns true if the multiplication of "a" and "b" will
101 * overflow. The types of "a" and "b" must match and must be unsigned.
102 * Note that this macro evaluates "a" twice!
104 #define unsigned_mult_overflows(a, b) \
105 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
108 #define TYPEOF(x) (__typeof__(x))
113 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
114 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
116 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
118 /* Approximation of the length of the decimal representation of this type. */
119 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
123 * On Solaris, when _XOPEN_EXTENDED is set, its header file
124 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
125 * setting to say we are XPG5 or XPG6. Also on Solaris,
126 * XPG6 programs must be compiled with a c99 compiler, while
127 * non XPG6 programs must be compiled with a pre-c99 compiler.
129 # if __STDC_VERSION__ - 0 >= 199901L
130 # define _XOPEN_SOURCE 600
132 # define _XOPEN_SOURCE 500
134 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
135 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
136 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
138 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
139 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
141 #define _ALL_SOURCE 1
142 #define _GNU_SOURCE 1
143 #define _BSD_SOURCE 1
144 #define _DEFAULT_SOURCE 1
145 #define _NETBSD_SOURCE 1
146 #define _SGI_SOURCE 1
148 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
149 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
150 # define _WIN32_WINNT 0x0502
152 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
153 #include <winsock2.h>
155 #define GIT_WINDOWS_NATIVE
160 #include <sys/stat.h>
166 #ifdef HAVE_STRINGS_H
167 #include <strings.h> /* for strcasecmp() */
171 #ifdef NEEDS_SYS_PARAM_H
172 #include <sys/param.h>
174 #include <sys/types.h>
176 #include <sys/time.h>
183 #ifndef NO_SYS_POLL_H
184 #include <sys/poll.h>
188 #ifdef HAVE_BSD_SYSCTL
189 #include <sys/sysctl.h>
192 #if defined(__CYGWIN__)
193 #include "compat/cygwin.h"
195 #if defined(__MINGW32__)
196 /* pull in Windows compatibility stuff */
197 #include "compat/mingw.h"
198 #elif defined(_MSC_VER)
199 #include "compat/msvc.h"
201 #include <sys/utsname.h>
202 #include <sys/wait.h>
203 #include <sys/resource.h>
204 #include <sys/socket.h>
205 #include <sys/ioctl.h>
207 #ifndef NO_SYS_SELECT_H
208 #include <sys/select.h>
210 #include <netinet/in.h>
211 #include <netinet/tcp.h>
212 #include <arpa/inet.h>
216 #ifndef NO_INTTYPES_H
217 #include <inttypes.h>
223 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
224 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
225 * while on IP16 and IP16L32 it is "int" (resp. "short")
226 * Size needs to match (or exceed) 'sizeof(void *)'.
227 * We can't take "long long" here as not everybody has it.
229 typedef long intptr_t;
230 typedef unsigned long uintptr_t;
232 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
234 #define _ALL_SOURCE 1
237 /* used on Mac OS X */
238 #ifdef PRECOMPOSE_UNICODE
239 #include "compat/precompose_utf8.h"
241 #define precompose_str(in,i_nfd2nfc)
242 #define precompose_argv(c,v)
243 #define probe_utf8_pathname_composition()
246 #ifdef MKDIR_WO_TRAILING_SLASH
247 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
248 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
251 #ifdef NO_STRUCT_ITIMERVAL
253 struct timeval it_interval
;
254 struct timeval it_value
;
259 #define setitimer(which,value,ovalue)
265 #define basename gitbasename
266 extern char *gitbasename(char *);
267 #define dirname gitdirname
268 extern char *gitdirname(char *);
277 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
278 #include <AvailabilityMacros.h>
279 #undef DEPRECATED_ATTRIBUTE
280 #define DEPRECATED_ATTRIBUTE
281 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
283 #include <openssl/ssl.h>
284 #include <openssl/err.h>
288 # include <sys/sysinfo.h>
291 /* On most systems <netdb.h> would have given us this, but
292 * not on some systems (e.g. z/OS).
295 #define NI_MAXHOST 1025
299 #define NI_MAXSERV 32
302 /* On most systems <limits.h> would have given us this, but
303 * not on some systems (e.g. GNU/Hurd).
306 #define PATH_MAX 4096
310 #define PRIuMAX "llu"
314 #define SCNuMAX PRIuMAX
329 typedef uintmax_t timestamp_t
;
330 #define PRItime PRIuMAX
331 #define parse_timestamp strtoumax
332 #define TIME_MAX UINTMAX_MAX
341 #ifndef _PATH_DEFPATH
342 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
345 #ifndef has_dos_drive_prefix
346 static inline int git_has_dos_drive_prefix(const char *path
)
350 #define has_dos_drive_prefix git_has_dos_drive_prefix
353 #ifndef skip_dos_drive_prefix
354 static inline int git_skip_dos_drive_prefix(char **path
)
358 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
362 static inline int git_is_dir_sep(int c
)
366 #define is_dir_sep git_is_dir_sep
369 #ifndef offset_1st_component
370 static inline int git_offset_1st_component(const char *path
)
372 return is_dir_sep(path
[0]);
374 #define offset_1st_component git_offset_1st_component
377 #ifndef find_last_dir_sep
378 static inline char *git_find_last_dir_sep(const char *path
)
380 return strrchr(path
, '/');
382 #define find_last_dir_sep git_find_last_dir_sep
385 #if defined(__HP_cc) && (__HP_cc >= 61000)
386 #define NORETURN __attribute__((noreturn))
388 #elif defined(__GNUC__) && !defined(NO_NORETURN)
389 #define NORETURN __attribute__((__noreturn__))
390 #define NORETURN_PTR __attribute__((__noreturn__))
391 #elif defined(_MSC_VER)
392 #define NORETURN __declspec(noreturn)
398 #ifndef __attribute__
399 #define __attribute__(x)
404 /* The sentinel attribute is valid from gcc version 4.0 */
405 #if defined(__GNUC__) && (__GNUC__ >= 4)
406 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
408 #define LAST_ARG_MUST_BE_NULL
411 #include "compat/bswap.h"
413 #include "wildmatch.h"
417 /* General helper functions */
418 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
419 extern NORETURN
void usage(const char *err
);
420 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
421 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
422 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
423 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
424 extern int error_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
425 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
426 extern void warning_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
429 #ifdef APPLE_COMMON_CRYPTO
430 #include "compat/apple-common-crypto.h"
432 #include <openssl/evp.h>
433 #include <openssl/hmac.h>
434 #endif /* APPLE_COMMON_CRYPTO */
435 #include <openssl/x509v3.h>
436 #endif /* NO_OPENSSL */
439 * Let callers be aware of the constant return value; this can help
440 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
441 * because some compilers may not support variadic macros. Since we're only
442 * trying to help gcc, anyway, it's OK; other compilers will fall back to
443 * using the function as usual.
445 #if defined(__GNUC__)
446 static inline int const_error(void)
450 #define error(...) (error(__VA_ARGS__), const_error())
451 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
454 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
455 extern void set_error_routine(void (*routine
)(const char *err
, va_list params
));
456 extern void (*get_error_routine(void))(const char *err
, va_list params
);
457 extern void set_warn_routine(void (*routine
)(const char *warn
, va_list params
));
458 extern void (*get_warn_routine(void))(const char *warn
, va_list params
);
459 extern void set_die_is_recursing_routine(int (*routine
)(void));
461 extern int starts_with(const char *str
, const char *prefix
);
462 extern int istarts_with(const char *str
, const char *prefix
);
465 * If the string "str" begins with the string found in "prefix", return 1.
466 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
467 * the string right after the prefix).
469 * Otherwise, return 0 and leave "out" untouched.
473 * [extract branch name, fail if not a branch]
474 * if (!skip_prefix(ref, "refs/heads/", &branch)
477 * [skip prefix if present, otherwise use whole string]
478 * skip_prefix(name, "refs/heads/", &name);
480 static inline int skip_prefix(const char *str
, const char *prefix
,
488 } while (*str
++ == *prefix
++);
493 * If the string "str" is the same as the string in "prefix", then the "arg"
494 * parameter is set to the "def" parameter and 1 is returned.
495 * If the string "str" begins with the string found in "prefix" and then a
496 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
497 * (i.e., to the point in the string right after the prefix and the "=" sign),
500 * Otherwise, return 0 and leave "arg" untouched.
502 * When we accept both a "--key" and a "--key=<val>" option, this function
503 * can be used instead of !strcmp(arg, "--key") and then
504 * skip_prefix(arg, "--key=", &arg) to parse such an option.
506 int skip_to_optional_arg_default(const char *str
, const char *prefix
,
507 const char **arg
, const char *def
);
509 static inline int skip_to_optional_arg(const char *str
, const char *prefix
,
512 return skip_to_optional_arg_default(str
, prefix
, arg
, "");
516 * Like skip_prefix, but promises never to read past "len" bytes of the input
517 * buffer, and returns the remaining number of bytes in "out" via "outlen".
519 static inline int skip_prefix_mem(const char *buf
, size_t len
,
521 const char **out
, size_t *outlen
)
523 size_t prefix_len
= strlen(prefix
);
524 if (prefix_len
<= len
&& !memcmp(buf
, prefix
, prefix_len
)) {
525 *out
= buf
+ prefix_len
;
526 *outlen
= len
- prefix_len
;
533 * If buf ends with suffix, return 1 and subtract the length of the suffix
534 * from *len. Otherwise, return 0 and leave *len untouched.
536 static inline int strip_suffix_mem(const char *buf
, size_t *len
,
539 size_t suflen
= strlen(suffix
);
540 if (*len
< suflen
|| memcmp(buf
+ (*len
- suflen
), suffix
, suflen
))
547 * If str ends with suffix, return 1 and set *len to the size of the string
548 * without the suffix. Otherwise, return 0 and set *len to the size of the
551 * Note that we do _not_ NUL-terminate str to the new length.
553 static inline int strip_suffix(const char *str
, const char *suffix
, size_t *len
)
556 return strip_suffix_mem(str
, len
, suffix
);
559 static inline int ends_with(const char *str
, const char *suffix
)
562 return strip_suffix(str
, suffix
, &len
);
565 #define SWAP(a, b) do { \
566 void *_swap_a_ptr = &(a); \
567 void *_swap_b_ptr = &(b); \
568 unsigned char _swap_buffer[sizeof(a)]; \
569 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
570 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
571 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
572 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
575 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
580 #define MAP_PRIVATE 1
583 #define mmap git_mmap
584 #define munmap git_munmap
585 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
586 extern int git_munmap(void *start
, size_t length
);
588 #else /* NO_MMAP || USE_WIN32_MMAP */
590 #include <sys/mman.h>
592 #endif /* NO_MMAP || USE_WIN32_MMAP */
596 /* This value must be multiple of (pagesize * 2) */
597 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
601 /* This value must be multiple of (pagesize * 2) */
602 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
603 (sizeof(void*) >= 8 \
604 ? 1 * 1024 * 1024 * 1024 \
610 #define MAP_FAILED ((void *)-1)
613 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
614 #define on_disk_bytes(st) ((st).st_size)
616 #define on_disk_bytes(st) ((st).st_blocks * 512)
619 #ifdef NEEDS_MODE_TRANSLATION
628 #define S_IFMT 0170000
629 #define S_IFREG 0100000
630 #define S_IFDIR 0040000
631 #define S_IFLNK 0120000
632 #define S_IFBLK 0060000
633 #define S_IFCHR 0020000
634 #define S_IFIFO 0010000
635 #define S_IFSOCK 0140000
639 #define stat(path, buf) git_stat(path, buf)
640 extern int git_stat(const char *, struct stat
*);
644 #define fstat(fd, buf) git_fstat(fd, buf)
645 extern int git_fstat(int, struct stat
*);
649 #define lstat(path, buf) git_lstat(path, buf)
650 extern int git_lstat(const char *, struct stat
*);
653 #define DEFAULT_PACKED_GIT_LIMIT \
654 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
657 #define pread git_pread
658 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
661 * Forward decl that will remind us if its twin in cache.h changes.
662 * This function is used in compat/pread.c. But we can't include
665 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
668 #define setenv gitsetenv
669 extern int gitsetenv(const char *, const char *, int);
673 #define mkdtemp gitmkdtemp
674 extern char *gitmkdtemp(char *);
678 #define unsetenv gitunsetenv
679 extern void gitunsetenv(const char *);
683 #define strcasestr gitstrcasestr
684 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
688 #define strlcpy gitstrlcpy
689 extern size_t gitstrlcpy(char *, const char *, size_t);
693 #define strtoumax gitstrtoumax
694 extern uintmax_t gitstrtoumax(const char *, char **, int);
695 #define strtoimax gitstrtoimax
696 extern intmax_t gitstrtoimax(const char *, char **, int);
700 #define hstrerror githstrerror
701 extern const char *githstrerror(int herror
);
705 #define memmem gitmemmem
706 void *gitmemmem(const void *haystack
, size_t haystacklen
,
707 const void *needle
, size_t needlelen
);
710 #ifdef OVERRIDE_STRDUP
714 #define strdup gitstrdup
715 char *gitstrdup(const char *s
);
718 #ifdef NO_GETPAGESIZE
719 #define getpagesize() sysconf(_SC_PAGESIZE)
726 #ifdef FREAD_READS_DIRECTORIES
727 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
731 # define fopen(a,b) git_fopen(a,b)
733 extern FILE *git_fopen(const char*, const char*);
736 #ifdef SNPRINTF_RETURNS_BOGUS
740 #define snprintf git_snprintf
741 extern int git_snprintf(char *str
, size_t maxsize
,
742 const char *format
, ...);
746 #define vsnprintf git_vsnprintf
747 extern int git_vsnprintf(char *str
, size_t maxsize
,
748 const char *format
, va_list ap
);
751 #ifdef __GLIBC_PREREQ
752 #if __GLIBC_PREREQ(2, 1)
753 #define HAVE_STRCHRNUL
757 #ifndef HAVE_STRCHRNUL
758 #define strchrnul gitstrchrnul
759 static inline char *gitstrchrnul(const char *s
, int c
)
761 while (*s
&& *s
!= c
)
768 int inet_pton(int af
, const char *src
, void *dst
);
772 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
776 #define atexit git_atexit
777 extern int git_atexit(void (*handler
)(void));
780 typedef void (*try_to_free_t
)(size_t);
781 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
783 static inline size_t st_add(size_t a
, size_t b
)
785 if (unsigned_add_overflows(a
, b
))
786 die("size_t overflow: %"PRIuMAX
" + %"PRIuMAX
,
787 (uintmax_t)a
, (uintmax_t)b
);
790 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
791 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
793 static inline size_t st_mult(size_t a
, size_t b
)
795 if (unsigned_mult_overflows(a
, b
))
796 die("size_t overflow: %"PRIuMAX
" * %"PRIuMAX
,
797 (uintmax_t)a
, (uintmax_t)b
);
801 static inline size_t st_sub(size_t a
, size_t b
)
804 die("size_t underflow: %"PRIuMAX
" - %"PRIuMAX
,
805 (uintmax_t)a
, (uintmax_t)b
);
811 # define xalloca(size) (alloca(size))
812 # define xalloca_free(p) do {} while (0)
814 # define xalloca(size) (xmalloc(size))
815 # define xalloca_free(p) (free(p))
817 extern char *xstrdup(const char *str
);
818 extern void *xmalloc(size_t size
);
819 extern void *xmallocz(size_t size
);
820 extern void *xmallocz_gently(size_t size
);
821 extern void *xmemdupz(const void *data
, size_t len
);
822 extern char *xstrndup(const char *str
, size_t len
);
823 extern void *xrealloc(void *ptr
, size_t size
);
824 extern void *xcalloc(size_t nmemb
, size_t size
);
825 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
826 extern void *xmmap_gently(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
827 extern int xopen(const char *path
, int flags
, ...);
828 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
829 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
830 extern ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
);
831 extern int xdup(int fd
);
832 extern FILE *xfopen(const char *path
, const char *mode
);
833 extern FILE *xfdopen(int fd
, const char *mode
);
834 extern int xmkstemp(char *temp_filename
);
835 extern int xmkstemp_mode(char *temp_filename
, int mode
);
836 extern char *xgetcwd(void);
837 extern FILE *fopen_for_writing(const char *path
);
838 extern FILE *fopen_or_warn(const char *path
, const char *mode
);
841 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
842 * that ptr is used twice, so don't pass e.g. ptr++.
844 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
846 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
847 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
849 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
850 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
851 static inline void copy_array(void *dst
, const void *src
, size_t n
, size_t size
)
854 memcpy(dst
, src
, st_mult(size
, n
));
857 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
858 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
859 static inline void move_array(void *dst
, const void *src
, size_t n
, size_t size
)
862 memmove(dst
, src
, st_mult(size
, n
));
866 * These functions help you allocate structs with flex arrays, and copy
867 * the data directly into the array. For example, if you had:
871 * char name[FLEX_ARRAY];
877 * FLEX_ALLOC_MEM(f, name, src, len);
879 * to allocate a "foo" with the contents of "src" in the "name" field.
880 * The resulting struct is automatically zero'd, and the flex-array field
881 * is NUL-terminated (whether the incoming src buffer was or not).
883 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
884 * but do want to store a pointer to some extra data in the same allocated
885 * block. For example, if you have:
895 * FLEXPTR_ALLOC_STR(f, name, src);
897 * and "name" will point to a block of memory after the struct, which will be
898 * freed along with the struct (but the pointer can be repointed anywhere).
900 * The *_STR variants accept a string parameter rather than a ptr/len
903 * Note that these macros will evaluate the first parameter multiple
904 * times, and it must be assignable as an lvalue.
906 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
907 size_t flex_array_len_ = (len); \
908 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
909 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
911 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
912 size_t flex_array_len_ = (len); \
913 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
914 memcpy((x) + 1, (buf), flex_array_len_); \
915 (x)->ptrname = (void *)((x)+1); \
917 #define FLEX_ALLOC_STR(x, flexname, str) \
918 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
919 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
920 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
922 static inline char *xstrdup_or_null(const char *str
)
924 return str
? xstrdup(str
) : NULL
;
927 static inline size_t xsize_t(off_t len
)
929 size_t size
= (size_t) len
;
931 if (len
!= (off_t
) size
)
932 die("Cannot handle files this big");
936 __attribute__((format (printf
, 3, 4)))
937 extern int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...);
939 #ifndef HOST_NAME_MAX
940 #define HOST_NAME_MAX 256
943 extern int xgethostname(char *buf
, size_t len
);
945 /* in ctype.c, for kwset users */
946 extern const unsigned char tolower_trans_tbl
[256];
948 /* Sane ctype - no locale, and works with signed chars */
963 extern const unsigned char sane_ctype
[256];
964 #define GIT_SPACE 0x01
965 #define GIT_DIGIT 0x02
966 #define GIT_ALPHA 0x04
967 #define GIT_GLOB_SPECIAL 0x08
968 #define GIT_REGEX_SPECIAL 0x10
969 #define GIT_PATHSPEC_MAGIC 0x20
970 #define GIT_CNTRL 0x40
971 #define GIT_PUNCT 0x80
972 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
973 #define isascii(x) (((x) & ~0x7f) == 0)
974 #define isspace(x) sane_istest(x,GIT_SPACE)
975 #define isdigit(x) sane_istest(x,GIT_DIGIT)
976 #define isalpha(x) sane_istest(x,GIT_ALPHA)
977 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
978 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
979 #define islower(x) sane_iscase(x, 1)
980 #define isupper(x) sane_iscase(x, 0)
981 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
982 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
983 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
984 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
985 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
986 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
987 #define tolower(x) sane_case((unsigned char)(x), 0x20)
988 #define toupper(x) sane_case((unsigned char)(x), 0)
989 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
991 static inline int sane_case(int x
, int high
)
993 if (sane_istest(x
, GIT_ALPHA
))
994 x
= (x
& ~0x20) | high
;
998 static inline int sane_iscase(int x
, int is_lower
)
1000 if (!sane_istest(x
, GIT_ALPHA
))
1004 return (x
& 0x20) != 0;
1006 return (x
& 0x20) == 0;
1010 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1011 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1012 * locale-specific conversions).
1014 static inline int skip_iprefix(const char *str
, const char *prefix
,
1022 } while (tolower(*str
++) == tolower(*prefix
++));
1026 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
1032 /* negative values would be accepted by strtoul */
1035 ul
= strtoul(s
, &p
, base
);
1036 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
1042 static inline int strtol_i(char const *s
, int base
, int *result
)
1048 ul
= strtol(s
, &p
, base
);
1049 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
1055 #ifdef INTERNAL_QSORT
1056 void git_qsort(void *base
, size_t nmemb
, size_t size
,
1057 int(*compar
)(const void *, const void *));
1058 #define qsort git_qsort
1061 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1062 static inline void sane_qsort(void *base
, size_t nmemb
, size_t size
,
1063 int(*compar
)(const void *, const void *))
1066 qsort(base
, nmemb
, size
, compar
);
1069 #ifndef HAVE_ISO_QSORT_S
1070 int git_qsort_s(void *base
, size_t nmemb
, size_t size
,
1071 int (*compar
)(const void *, const void *, void *), void *ctx
);
1072 #define qsort_s git_qsort_s
1075 #define QSORT_S(base, n, compar, ctx) do { \
1076 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1077 BUG("qsort_s() failed"); \
1080 #ifndef REG_STARTEND
1081 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1084 static inline int regexec_buf(const regex_t
*preg
, const char *buf
, size_t size
,
1085 size_t nmatch
, regmatch_t pmatch
[], int eflags
)
1087 assert(nmatch
> 0 && pmatch
);
1088 pmatch
[0].rm_so
= 0;
1089 pmatch
[0].rm_eo
= size
;
1090 return regexec(preg
, buf
, nmatch
, pmatch
, eflags
| REG_STARTEND
);
1093 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1094 # define FORCE_DIR_SET_GID S_ISGID
1096 # define FORCE_DIR_SET_GID 0
1101 #define ST_CTIME_NSEC(st) 0
1102 #define ST_MTIME_NSEC(st) 0
1104 #ifdef USE_ST_TIMESPEC
1105 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1106 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1108 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1109 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1113 #ifdef UNRELIABLE_FSTAT
1114 #define fstat_is_reliable() 0
1116 #define fstat_is_reliable() 1
1121 * Since an obvious implementation of va_list would be to make it a
1122 * pointer into the stack frame, a simple assignment will work on
1123 * many systems. But let's try to be more portable.
1126 #define va_copy(dst, src) __va_copy(dst, src)
1128 #define va_copy(dst, src) ((dst) = (src))
1132 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
1133 #define HAVE_VARIADIC_MACROS 1
1136 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1137 extern int BUG_exit_code
;
1139 #ifdef HAVE_VARIADIC_MACROS
1140 __attribute__((format (printf
, 3, 4))) NORETURN
1141 void BUG_fl(const char *file
, int line
, const char *fmt
, ...);
1142 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1144 __attribute__((format (printf
, 1, 2))) NORETURN
1145 void BUG(const char *fmt
, ...);
1149 * Preserves errno, prints a message, but gives no warning for ENOENT.
1150 * Returns 0 on success, which includes trying to unlink an object that does
1153 int unlink_or_warn(const char *path
);
1155 * Tries to unlink file. Returns 0 if unlink succeeded
1156 * or the file already didn't exist. Returns -1 and
1157 * appends a message to err suitable for
1158 * 'error("%s", err->buf)' on error.
1160 int unlink_or_msg(const char *file
, struct strbuf
*err
);
1162 * Preserves errno, prints a message, but gives no warning for ENOENT.
1163 * Returns 0 on success, which includes trying to remove a directory that does
1166 int rmdir_or_warn(const char *path
);
1168 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1169 * the supplied file mode.
1171 int remove_or_warn(unsigned int mode
, const char *path
);
1174 * Call access(2), but warn for any error except "missing file"
1175 * (ENOENT or ENOTDIR).
1177 #define ACCESS_EACCES_OK (1U << 0)
1178 int access_or_warn(const char *path
, int mode
, unsigned flag
);
1179 int access_or_die(const char *path
, int mode
, unsigned flag
);
1181 /* Warn on an inaccessible file if errno indicates this is an error */
1182 int warn_on_fopen_errors(const char *path
);
1184 #ifdef GMTIME_UNRELIABLE_ERRORS
1185 struct tm
*git_gmtime(const time_t *);
1186 struct tm
*git_gmtime_r(const time_t *, struct tm
*);
1187 #define gmtime git_gmtime
1188 #define gmtime_r git_gmtime_r
1191 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1192 #define USE_PARENS_AROUND_GETTEXT_N 1
1196 # define SHELL_PATH "/bin/sh"
1199 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1200 #define flockfile(fh)
1201 #define funlockfile(fh)
1202 #define getc_unlocked(fh) getc(fh)
1206 * Our code often opens a path to an optional file, to work on its
1207 * contents when we can successfully open it. We can ignore a failure
1208 * to open if such an optional file does not exist, but we do want to
1209 * report a failure in opening for other reasons (e.g. we got an I/O
1210 * error, or the file is there, but we lack the permission to open).
1212 * Call this function after seeing an error from open() or fopen() to
1213 * see if the errno indicates a missing file that we can safely ignore.
1215 static inline int is_missing_file_error(int errno_
)
1217 return (errno_
== ENOENT
|| errno_
== ENOTDIR
);
1220 extern int cmd_main(int, const char **);
1223 * You can mark a stack variable with UNLEAK(var) to avoid it being
1224 * reported as a leak by tools like LSAN or valgrind. The argument
1225 * should generally be the variable itself (not its address and not what
1226 * it points to). It's safe to use this on pointers which may already
1227 * have been freed, or on pointers which may still be in use.
1229 * Use this _only_ for a variable that leaks by going out of scope at
1230 * program exit (so only from cmd_* functions or their direct helpers).
1231 * Normal functions, especially those which may be called multiple
1232 * times, should actually free their memory. This is only meant as
1233 * an annotation, and does nothing in non-leak-checking builds.
1235 #ifdef SUPPRESS_ANNOTATED_LEAKS
1236 extern void unleak_memory(const void *ptr
, size_t len
);
1237 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1239 #define UNLEAK(var) do {} while (0)