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 static inline const char *precompose_argv_prefix(int argc, const char **argv, const char *prefix)
259 #define probe_utf8_pathname_composition()
262 #ifdef MKDIR_WO_TRAILING_SLASH
263 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
264 int compat_mkdir_wo_trailing_slash(const char*, mode_t);
267 #ifdef NO_STRUCT_ITIMERVAL
269 struct timeval it_interval;
270 struct timeval it_value;
275 static inline int setitimer(int which, const struct itimerval *value, struct itimerval *newvalue) {
276 return 0; /* pretend success */
283 #define basename gitbasename
284 char *gitbasename(char *);
285 #define dirname gitdirname
286 char *gitdirname(char *);
295 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
296 #include <AvailabilityMacros.h>
297 #undef DEPRECATED_ATTRIBUTE
298 #define DEPRECATED_ATTRIBUTE
299 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
301 #include <openssl/ssl.h>
302 #include <openssl/err.h>
306 # include <sys/sysinfo.h>
309 /* On most systems <netdb.h> would have given us this, but
310 * not on some systems (e.g. z/OS).
313 #define NI_MAXHOST 1025
317 #define NI_MAXSERV 32
320 /* On most systems <limits.h> would have given us this, but
321 * not on some systems (e.g. GNU/Hurd).
324 #define PATH_MAX 4096
327 typedef uintmax_t timestamp_t;
328 #define PRItime PRIuMAX
329 #define parse_timestamp strtoumax
330 #define TIME_MAX UINTMAX_MAX
340 #ifndef _PATH_DEFPATH
341 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
344 #ifndef platform_core_config
345 static inline int noop_core_config(const char *var, const char *value, void *cb)
349 #define platform_core_config noop_core_config
352 int lstat_cache_aware_rmdir(const char *path);
353 #if !defined(__MINGW32__) && !defined(_MSC_VER)
354 #define rmdir lstat_cache_aware_rmdir
357 #ifndef has_dos_drive_prefix
358 static inline int git_has_dos_drive_prefix(const char *path)
362 #define has_dos_drive_prefix git_has_dos_drive_prefix
365 #ifndef skip_dos_drive_prefix
366 static inline int git_skip_dos_drive_prefix(char **path)
370 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
374 static inline int git_is_dir_sep(int c)
378 #define is_dir_sep git_is_dir_sep
381 #ifndef offset_1st_component
382 static inline int git_offset_1st_component(const char *path)
384 return is_dir_sep(path[0]);
386 #define offset_1st_component git_offset_1st_component
389 #ifndef is_valid_path
390 #define is_valid_path(path) 1
393 #ifndef find_last_dir_sep
394 static inline char *git_find_last_dir_sep(const char *path)
396 return strrchr(path, '/');
398 #define find_last_dir_sep git_find_last_dir_sep
402 static inline int git_has_dir_sep(const char *path)
404 return !!strchr(path, '/');
406 #define has_dir_sep(path) git_has_dir_sep(path)
409 #ifndef query_user_email
410 #define query_user_email() NULL
414 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
415 #include <floss.h(floss_getpwuid)>
418 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
419 * known, by detective work using kill -l as a list is all signals
420 * instead of signal.h where it should be.
426 #if defined(__HP_cc) && (__HP_cc >= 61000)
427 #define NORETURN __attribute__((noreturn))
429 #elif defined(__GNUC__) && !defined(NO_NORETURN)
430 #define NORETURN __attribute__((__noreturn__))
431 #define NORETURN_PTR __attribute__((__noreturn__))
432 #elif defined(_MSC_VER)
433 #define NORETURN __declspec(noreturn)
439 #ifndef __attribute__
440 #define __attribute__(x)
445 /* The sentinel attribute is valid from gcc version 4.0 */
446 #if defined(__GNUC__) && (__GNUC__ >= 4)
447 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
449 #define LAST_ARG_MUST_BE_NULL
452 #define MAYBE_UNUSED __attribute__((__unused__))
454 #include "compat/bswap.h"
456 #include "wildmatch.h"
460 /* General helper functions */
461 void vreportf(const char *prefix, const char *err, va_list params);
462 NORETURN void usage(const char *err);
463 NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
464 NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
465 NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
466 int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
467 int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
468 void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
469 void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
472 #ifdef APPLE_COMMON_CRYPTO
473 #include "compat/apple-common-crypto.h"
475 #include <openssl/evp.h>
476 #include <openssl/hmac.h>
477 #endif /* APPLE_COMMON_CRYPTO */
478 #include <openssl/x509v3.h>
479 #endif /* NO_OPENSSL */
482 * Let callers be aware of the constant return value; this can help
483 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
484 * because some compilers may not support variadic macros. Since we're only
485 * trying to help gcc, anyway, it's OK; other compilers will fall back to
486 * using the function as usual.
488 #if defined(__GNUC__)
489 static inline int const_error(void)
493 #define error(...) (error(__VA_ARGS__), const_error())
494 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
497 typedef void (*report_fn)(const char *, va_list params);
499 void set_die_routine(NORETURN_PTR report_fn routine);
500 void set_error_routine(report_fn routine);
501 report_fn get_error_routine(void);
502 void set_warn_routine(report_fn routine);
503 report_fn get_warn_routine(void);
504 void set_die_is_recursing_routine(int (*routine)(void));
506 int starts_with(const char *str, const char *prefix);
507 int istarts_with(const char *str, const char *prefix);
510 * If the string "str" begins with the string found in "prefix", return 1.
511 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
512 * the string right after the prefix).
514 * Otherwise, return 0 and leave "out" untouched.
518 * [extract branch name, fail if not a branch]
519 * if (!skip_prefix(ref, "refs/heads/", &branch)
522 * [skip prefix if present, otherwise use whole string]
523 * skip_prefix(name, "refs/heads/", &name);
525 static inline int skip_prefix(const char *str, const char *prefix,
533 } while (*str++ == *prefix++);
538 * If the string "str" is the same as the string in "prefix", then the "arg"
539 * parameter is set to the "def" parameter and 1 is returned.
540 * If the string "str" begins with the string found in "prefix" and then a
541 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
542 * (i.e., to the point in the string right after the prefix and the "=" sign),
545 * Otherwise, return 0 and leave "arg" untouched.
547 * When we accept both a "--key" and a "--key=<val>" option, this function
548 * can be used instead of !strcmp(arg, "--key") and then
549 * skip_prefix(arg, "--key=", &arg) to parse such an option.
551 int skip_to_optional_arg_default(const char *str, const char *prefix,
552 const char **arg, const char *def);
554 static inline int skip_to_optional_arg(const char *str, const char *prefix,
557 return skip_to_optional_arg_default(str, prefix, arg, "");
561 * Like skip_prefix, but promises never to read past "len" bytes of the input
562 * buffer, and returns the remaining number of bytes in "out" via "outlen".
564 static inline int skip_prefix_mem(const char *buf, size_t len,
566 const char **out, size_t *outlen)
568 size_t prefix_len = strlen(prefix);
569 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
570 *out = buf + prefix_len;
571 *outlen = len - prefix_len;
578 * If buf ends with suffix, return 1 and subtract the length of the suffix
579 * from *len. Otherwise, return 0 and leave *len untouched.
581 static inline int strip_suffix_mem(const char *buf, size_t *len,
584 size_t suflen = strlen(suffix);
585 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
592 * If str ends with suffix, return 1 and set *len to the size of the string
593 * without the suffix. Otherwise, return 0 and set *len to the size of the
596 * Note that we do _not_ NUL-terminate str to the new length.
598 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
601 return strip_suffix_mem(str, len, suffix);
604 static inline int ends_with(const char *str, const char *suffix)
607 return strip_suffix(str, suffix, &len);
610 #define SWAP(a, b) do { \
611 void *_swap_a_ptr = &(a); \
612 void *_swap_b_ptr = &(b); \
613 unsigned char _swap_buffer[sizeof(a)]; \
614 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
615 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
616 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
617 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
620 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
625 #define MAP_PRIVATE 1
628 #define mmap git_mmap
629 #define munmap git_munmap
630 void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
631 int git_munmap(void *start, size_t length);
633 #else /* NO_MMAP || USE_WIN32_MMAP */
635 #include <sys/mman.h>
637 #endif /* NO_MMAP || USE_WIN32_MMAP */
641 /* This value must be multiple of (pagesize * 2) */
642 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
646 /* This value must be multiple of (pagesize * 2) */
647 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
648 (sizeof(void*) >= 8 \
649 ? 1 * 1024 * 1024 * 1024 \
655 #define MAP_FAILED ((void *)-1)
658 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
659 #define on_disk_bytes(st) ((st).st_size)
661 #define on_disk_bytes(st) ((st).st_blocks * 512)
664 #ifdef NEEDS_MODE_TRANSLATION
673 #define S_IFMT 0170000
674 #define S_IFREG 0100000
675 #define S_IFDIR 0040000
676 #define S_IFLNK 0120000
677 #define S_IFBLK 0060000
678 #define S_IFCHR 0020000
679 #define S_IFIFO 0010000
680 #define S_IFSOCK 0140000
684 #define stat(path, buf) git_stat(path, buf)
685 int git_stat(const char *, struct stat *);
689 #define fstat(fd, buf) git_fstat(fd, buf)
690 int git_fstat(int, struct stat *);
694 #define lstat(path, buf) git_lstat(path, buf)
695 int git_lstat(const char *, struct stat *);
698 #define DEFAULT_PACKED_GIT_LIMIT \
699 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
702 #define pread git_pread
703 ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
706 * Forward decl that will remind us if its twin in cache.h changes.
707 * This function is used in compat/pread.c. But we can't include
710 ssize_t read_in_full(int fd, void *buf, size_t count);
713 #define setenv gitsetenv
714 int gitsetenv(const char *, const char *, int);
718 #define mkdtemp gitmkdtemp
719 char *gitmkdtemp(char *);
723 #define unsetenv gitunsetenv
724 void gitunsetenv(const char *);
728 #define strcasestr gitstrcasestr
729 char *gitstrcasestr(const char *haystack, const char *needle);
733 #define strlcpy gitstrlcpy
734 size_t gitstrlcpy(char *, const char *, size_t);
738 #define strtoumax gitstrtoumax
739 uintmax_t gitstrtoumax(const char *, char **, int);
740 #define strtoimax gitstrtoimax
741 intmax_t gitstrtoimax(const char *, char **, int);
745 #define hstrerror githstrerror
746 const char *githstrerror(int herror);
750 #define memmem gitmemmem
751 void *gitmemmem(const void *haystack, size_t haystacklen,
752 const void *needle, size_t needlelen);
755 #ifdef OVERRIDE_STRDUP
759 #define strdup gitstrdup
760 char *gitstrdup(const char *s);
763 #ifdef NO_GETPAGESIZE
764 #define getpagesize() sysconf(_SC_PAGESIZE)
771 #ifdef FREAD_READS_DIRECTORIES
772 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
776 # define fopen(a,b) git_fopen(a,b)
778 FILE *git_fopen(const char*, const char*);
781 #ifdef SNPRINTF_RETURNS_BOGUS
785 #define snprintf git_snprintf
786 int git_snprintf(char *str, size_t maxsize,
787 const char *format, ...);
791 #define vsnprintf git_vsnprintf
792 int git_vsnprintf(char *str, size_t maxsize,
793 const char *format, va_list ap);
796 #ifdef OPEN_RETURNS_EINTR
798 #define open git_open_with_retry
799 int git_open_with_retry(const char *path, int flag, ...);
802 #ifdef __GLIBC_PREREQ
803 #if __GLIBC_PREREQ(2, 1)
804 #define HAVE_STRCHRNUL
808 #ifndef HAVE_STRCHRNUL
809 #define strchrnul gitstrchrnul
810 static inline char *gitstrchrnul(const char *s, int c)
812 while (*s && *s != c)
819 int inet_pton(int af, const char *src, void *dst);
823 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
827 #define atexit git_atexit
828 int git_atexit(void (*handler)(void));
831 static inline size_t st_add(size_t a, size_t b)
833 if (unsigned_add_overflows(a, b))
834 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
835 (uintmax_t)a, (uintmax_t)b);
838 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
839 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
841 static inline size_t st_mult(size_t a, size_t b)
843 if (unsigned_mult_overflows(a, b))
844 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
845 (uintmax_t)a, (uintmax_t)b);
849 static inline size_t st_sub(size_t a, size_t b)
852 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
853 (uintmax_t)a, (uintmax_t)b);
859 # define xalloca(size) (alloca(size))
860 # define xalloca_free(p) do {} while (0)
862 # define xalloca(size) (xmalloc(size))
863 # define xalloca_free(p) (free(p))
865 char *xstrdup(const char *str);
866 void *xmalloc(size_t size);
867 void *xmallocz(size_t size);
868 void *xmallocz_gently(size_t size);
869 void *xmemdupz(const void *data, size_t len);
870 char *xstrndup(const char *str, size_t len);
871 void *xrealloc(void *ptr, size_t size);
872 void *xcalloc(size_t nmemb, size_t size);
873 void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
874 void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
875 int xopen(const char *path, int flags, ...);
876 ssize_t xread(int fd, void *buf, size_t len);
877 ssize_t xwrite(int fd, const void *buf, size_t len);
878 ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
880 FILE *xfopen(const char *path, const char *mode);
881 FILE *xfdopen(int fd, const char *mode);
882 int xmkstemp(char *temp_filename);
883 int xmkstemp_mode(char *temp_filename, int mode);
885 FILE *fopen_for_writing(const char *path);
886 FILE *fopen_or_warn(const char *path, const char *mode);
889 * Like strncmp, but only return zero if s is NUL-terminated and exactly len
890 * characters long. If it is not, consider it greater than t.
892 int xstrncmpz(const char *s, const char *t, size_t len);
895 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
896 * that ptr is used twice, so don't pass e.g. ptr++.
898 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
900 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
901 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
902 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
904 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
905 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
906 static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
909 memcpy(dst, src, st_mult(size, n));
912 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
913 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
914 static inline void move_array(void *dst, const void *src, size_t n, size_t size)
917 memmove(dst, src, st_mult(size, n));
921 * These functions help you allocate structs with flex arrays, and copy
922 * the data directly into the array. For example, if you had:
926 * char name[FLEX_ARRAY];
932 * FLEX_ALLOC_MEM(f, name, src, len);
934 * to allocate a "foo" with the contents of "src" in the "name" field.
935 * The resulting struct is automatically zero'd, and the flex-array field
936 * is NUL-terminated (whether the incoming src buffer was or not).
938 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
939 * but do want to store a pointer to some extra data in the same allocated
940 * block. For example, if you have:
950 * FLEXPTR_ALLOC_STR(f, name, src);
952 * and "name" will point to a block of memory after the struct, which will be
953 * freed along with the struct (but the pointer can be repointed anywhere).
955 * The *_STR variants accept a string parameter rather than a ptr/len
958 * Note that these macros will evaluate the first parameter multiple
959 * times, and it must be assignable as an lvalue.
961 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
962 size_t flex_array_len_ = (len); \
963 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
964 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
966 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
967 size_t flex_array_len_ = (len); \
968 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
969 memcpy((x) + 1, (buf), flex_array_len_); \
970 (x)->ptrname = (void *)((x)+1); \
972 #define FLEX_ALLOC_STR(x, flexname, str) \
973 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
974 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
975 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
977 static inline char *xstrdup_or_null(const char *str)
979 return str ? xstrdup(str) : NULL;
982 static inline size_t xsize_t(off_t len)
984 size_t size = (size_t) len;
986 if (len != (off_t) size)
987 die("Cannot handle files this big");
991 __attribute__((format (printf, 3, 4)))
992 int xsnprintf(char *dst, size_t max, const char *fmt, ...);
994 #ifndef HOST_NAME_MAX
995 #define HOST_NAME_MAX 256
998 int xgethostname(char *buf, size_t len);
1000 /* in ctype.c, for kwset users */
1001 extern const unsigned char tolower_trans_tbl[256];
1003 /* Sane ctype - no locale, and works with signed chars */
1018 extern const unsigned char sane_ctype[256];
1019 #define GIT_SPACE 0x01
1020 #define GIT_DIGIT 0x02
1021 #define GIT_ALPHA 0x04
1022 #define GIT_GLOB_SPECIAL 0x08
1023 #define GIT_REGEX_SPECIAL 0x10
1024 #define GIT_PATHSPEC_MAGIC 0x20
1025 #define GIT_CNTRL 0x40
1026 #define GIT_PUNCT 0x80
1027 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1028 #define isascii(x) (((x) & ~0x7f) == 0)
1029 #define isspace(x) sane_istest(x,GIT_SPACE)
1030 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1031 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1032 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1033 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1034 #define islower(x) sane_iscase(x, 1)
1035 #define isupper(x) sane_iscase(x, 0)
1036 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1037 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1038 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1039 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1040 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1041 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1042 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1043 #define toupper(x) sane_case((unsigned char)(x), 0)
1044 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1046 static inline int sane_case(int x, int high)
1048 if (sane_istest(x, GIT_ALPHA))
1049 x = (x & ~0x20) | high;
1053 static inline int sane_iscase(int x, int is_lower)
1055 if (!sane_istest(x, GIT_ALPHA))
1059 return (x & 0x20) != 0;
1061 return (x & 0x20) == 0;
1065 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1066 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1067 * locale-specific conversions).
1069 static inline int skip_iprefix(const char *str, const char *prefix,
1077 } while (tolower(*str++) == tolower(*prefix++));
1081 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1087 /* negative values would be accepted by strtoul */
1090 ul = strtoul(s, &p, base);
1091 if (errno || *p || p == s || (unsigned int) ul != ul)
1097 static inline int strtol_i(char const *s, int base, int *result)
1103 ul = strtol(s, &p, base);
1104 if (errno || *p || p == s || (int) ul != ul)
1110 void git_stable_qsort(void *base, size_t nmemb, size_t size,
1111 int(*compar)(const void *, const void *));
1112 #ifdef INTERNAL_QSORT
1113 #define qsort git_stable_qsort
1116 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1117 static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1118 int(*compar)(const void *, const void *))
1121 qsort(base, nmemb, size, compar);
1124 #define STABLE_QSORT(base, n, compar) \
1125 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1127 #ifndef HAVE_ISO_QSORT_S
1128 int git_qsort_s(void *base, size_t nmemb, size_t size,
1129 int (*compar)(const void *, const void *, void *), void *ctx);
1130 #define qsort_s git_qsort_s
1133 #define QSORT_S(base, n, compar, ctx) do { \
1134 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1135 BUG("qsort_s() failed"); \
1138 #ifndef REG_STARTEND
1139 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1142 static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1143 size_t nmatch, regmatch_t pmatch[], int eflags)
1145 assert(nmatch > 0 && pmatch);
1146 pmatch[0].rm_so = 0;
1147 pmatch[0].rm_eo = size;
1148 return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1151 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1152 # define FORCE_DIR_SET_GID S_ISGID
1154 # define FORCE_DIR_SET_GID 0
1159 #define ST_CTIME_NSEC(st) 0
1160 #define ST_MTIME_NSEC(st) 0
1162 #ifdef USE_ST_TIMESPEC
1163 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1164 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1166 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1167 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1171 #ifdef UNRELIABLE_FSTAT
1172 #define fstat_is_reliable() 0
1174 #define fstat_is_reliable() 1
1179 * Since an obvious implementation of va_list would be to make it a
1180 * pointer into the stack frame, a simple assignment will work on
1181 * many systems. But let's try to be more portable.
1184 #define va_copy(dst, src) __va_copy(dst, src)
1186 #define va_copy(dst, src) ((dst) = (src))
1191 * This is always defined as a first step towards making the use of variadic
1192 * macros unconditional. If it causes compilation problems on your platform,
1193 * please report it to the Git mailing list at git@vger.kernel.org.
1195 #define HAVE_VARIADIC_MACROS 1
1197 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1198 extern int BUG_exit_code;
1200 #ifdef HAVE_VARIADIC_MACROS
1201 __attribute__((format (printf, 3, 4))) NORETURN
1202 void BUG_fl(const char *file, int line, const char *fmt, ...);
1203 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1205 __attribute__((format (printf, 1, 2))) NORETURN
1206 void BUG(const char *fmt, ...);
1210 * Preserves errno, prints a message, but gives no warning for ENOENT.
1211 * Returns 0 on success, which includes trying to unlink an object that does
1214 int unlink_or_warn(const char *path);
1216 * Tries to unlink file. Returns 0 if unlink succeeded
1217 * or the file already didn't exist. Returns -1 and
1218 * appends a message to err suitable for
1219 * 'error("%s", err->buf)' on error.
1221 int unlink_or_msg(const char *file, struct strbuf *err);
1223 * Preserves errno, prints a message, but gives no warning for ENOENT.
1224 * Returns 0 on success, which includes trying to remove a directory that does
1227 int rmdir_or_warn(const char *path);
1229 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1230 * the supplied file mode.
1232 int remove_or_warn(unsigned int mode, const char *path);
1235 * Call access(2), but warn for any error except "missing file"
1236 * (ENOENT or ENOTDIR).
1238 #define ACCESS_EACCES_OK (1U << 0)
1239 int access_or_warn(const char *path, int mode, unsigned flag);
1240 int access_or_die(const char *path, int mode, unsigned flag);
1242 /* Warn on an inaccessible file if errno indicates this is an error */
1243 int warn_on_fopen_errors(const char *path);
1245 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1246 #define USE_PARENS_AROUND_GETTEXT_N 1
1250 # define SHELL_PATH "/bin/sh"
1253 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1254 static inline void flockfile(FILE *fh)
1258 static inline void funlockfile(FILE *fh)
1262 #define getc_unlocked(fh) getc(fh)
1265 #ifdef FILENO_IS_A_MACRO
1266 int git_fileno(FILE *stream);
1267 # ifndef COMPAT_CODE_FILENO
1269 # define fileno(p) git_fileno(p)
1273 #ifdef NEED_ACCESS_ROOT_HANDLER
1274 int git_access(const char *path, int mode);
1275 # ifndef COMPAT_CODE_ACCESS
1279 # define access(path, mode) git_access(path, mode)
1284 * Our code often opens a path to an optional file, to work on its
1285 * contents when we can successfully open it. We can ignore a failure
1286 * to open if such an optional file does not exist, but we do want to
1287 * report a failure in opening for other reasons (e.g. we got an I/O
1288 * error, or the file is there, but we lack the permission to open).
1290 * Call this function after seeing an error from open() or fopen() to
1291 * see if the errno indicates a missing file that we can safely ignore.
1293 static inline int is_missing_file_error(int errno_)
1295 return (errno_ == ENOENT || errno_ == ENOTDIR);
1298 int cmd_main(int, const char **);
1301 * Intercept all calls to exit() and route them to trace2 to
1302 * optionally emit a message before calling the real exit().
1304 int trace2_cmd_exit_fl(const char *file, int line, int code);
1305 #define exit(code) exit(trace2_cmd_exit_fl(__FILE__, __LINE__, (code)))
1308 * You can mark a stack variable with UNLEAK(var) to avoid it being
1309 * reported as a leak by tools like LSAN or valgrind. The argument
1310 * should generally be the variable itself (not its address and not what
1311 * it points to). It's safe to use this on pointers which may already
1312 * have been freed, or on pointers which may still be in use.
1314 * Use this _only_ for a variable that leaks by going out of scope at
1315 * program exit (so only from cmd_* functions or their direct helpers).
1316 * Normal functions, especially those which may be called multiple
1317 * times, should actually free their memory. This is only meant as
1318 * an annotation, and does nothing in non-leak-checking builds.
1320 #ifdef SUPPRESS_ANNOTATED_LEAKS
1321 void unleak_memory(const void *ptr, size_t len);
1322 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1324 #define UNLEAK(var) do {} while (0)
1328 * This include must come after system headers, since it introduces macros that
1329 * replace system names.
1334 * container_of - Get the address of an object containing a field.
1336 * @ptr: pointer to the field.
1337 * @type: type of the object.
1338 * @member: name of the field within the object.
1340 #define container_of(ptr, type, member) \
1341 ((type *) ((char *)(ptr) - offsetof(type, member)))
1344 * helper function for `container_of_or_null' to avoid multiple
1345 * evaluation of @ptr
1347 static inline void *container_of_or_null_offset(void *ptr, size_t offset)
1349 return ptr ? (char *)ptr - offset : NULL;
1353 * like `container_of', but allows returned value to be NULL
1355 #define container_of_or_null(ptr, type, member) \
1356 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1359 * like offsetof(), but takes a pointer to a a variable of type which
1360 * contains @member, instead of a specified type.
1361 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1364 #if defined(__GNUC__) /* clang sets this, too */
1365 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1366 #else /* !__GNUC__ */
1367 #define OFFSETOF_VAR(ptr, member) \
1368 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1369 #endif /* !__GNUC__ */
1371 void sleep_millisec(int millisec);