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(_WIN32_WINNT)
150 # define _WIN32_WINNT 0x0600
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 #if !defined(NO_POLL_H)
185 #elif !defined(NO_SYS_POLL_H)
186 #include <sys/poll.h>
188 /* Pull the compat stuff */
191 #ifdef HAVE_BSD_SYSCTL
192 #include <sys/sysctl.h>
195 #if defined(__CYGWIN__)
196 #include "compat/cygwin.h"
198 #if defined(__MINGW32__)
199 /* pull in Windows compatibility stuff */
200 #include "compat/mingw.h"
201 #elif defined(_MSC_VER)
202 #include "compat/msvc.h"
204 #include <sys/utsname.h>
205 #include <sys/wait.h>
206 #include <sys/resource.h>
207 #include <sys/socket.h>
208 #include <sys/ioctl.h>
210 #ifndef NO_SYS_SELECT_H
211 #include <sys/select.h>
213 #include <netinet/in.h>
214 #include <netinet/tcp.h>
215 #include <arpa/inet.h>
219 #ifndef NO_INTTYPES_H
220 #include <inttypes.h>
226 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
227 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
228 * while on IP16 and IP16L32 it is "int" (resp. "short")
229 * Size needs to match (or exceed) 'sizeof(void *)'.
230 * We can't take "long long" here as not everybody has it.
232 typedef long intptr_t;
233 typedef unsigned long uintptr_t;
235 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
237 #define _ALL_SOURCE 1
240 /* used on Mac OS X */
241 #ifdef PRECOMPOSE_UNICODE
242 #include "compat/precompose_utf8.h"
244 #define precompose_str(in,i_nfd2nfc)
245 #define precompose_argv(c,v)
246 #define probe_utf8_pathname_composition()
249 #ifdef MKDIR_WO_TRAILING_SLASH
250 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
251 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
254 #ifdef NO_STRUCT_ITIMERVAL
256 struct timeval it_interval
;
257 struct timeval it_value
;
262 #define setitimer(which,value,ovalue)
268 #define basename gitbasename
269 extern char *gitbasename(char *);
270 #define dirname gitdirname
271 extern char *gitdirname(char *);
280 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
281 #include <AvailabilityMacros.h>
282 #undef DEPRECATED_ATTRIBUTE
283 #define DEPRECATED_ATTRIBUTE
284 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
286 #include <openssl/ssl.h>
287 #include <openssl/err.h>
291 # include <sys/sysinfo.h>
294 /* On most systems <netdb.h> would have given us this, but
295 * not on some systems (e.g. z/OS).
298 #define NI_MAXHOST 1025
302 #define NI_MAXSERV 32
305 /* On most systems <limits.h> would have given us this, but
306 * not on some systems (e.g. GNU/Hurd).
309 #define PATH_MAX 4096
313 #define PRIuMAX "llu"
317 #define SCNuMAX PRIuMAX
332 typedef uintmax_t timestamp_t
;
333 #define PRItime PRIuMAX
334 #define parse_timestamp strtoumax
335 #define TIME_MAX UINTMAX_MAX
344 #ifndef _PATH_DEFPATH
345 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
348 #ifndef platform_core_config
349 static inline int noop_core_config(const char *var
, const char *value
, void *cb
)
353 #define platform_core_config noop_core_config
356 #ifndef has_dos_drive_prefix
357 static inline int git_has_dos_drive_prefix(const char *path
)
361 #define has_dos_drive_prefix git_has_dos_drive_prefix
364 #ifndef skip_dos_drive_prefix
365 static inline int git_skip_dos_drive_prefix(char **path
)
369 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
373 static inline int git_is_dir_sep(int c
)
377 #define is_dir_sep git_is_dir_sep
380 #ifndef offset_1st_component
381 static inline int git_offset_1st_component(const char *path
)
383 return is_dir_sep(path
[0]);
385 #define offset_1st_component git_offset_1st_component
388 #ifndef find_last_dir_sep
389 static inline char *git_find_last_dir_sep(const char *path
)
391 return strrchr(path
, '/');
393 #define find_last_dir_sep git_find_last_dir_sep
396 #ifndef query_user_email
397 #define query_user_email() NULL
401 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
402 #include <floss.h(floss_getpwuid)>
405 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
406 * known, by detective work using kill -l as a list is all signals
407 * instead of signal.h where it should be.
413 #if defined(__HP_cc) && (__HP_cc >= 61000)
414 #define NORETURN __attribute__((noreturn))
416 #elif defined(__GNUC__) && !defined(NO_NORETURN)
417 #define NORETURN __attribute__((__noreturn__))
418 #define NORETURN_PTR __attribute__((__noreturn__))
419 #elif defined(_MSC_VER)
420 #define NORETURN __declspec(noreturn)
426 #ifndef __attribute__
427 #define __attribute__(x)
432 /* The sentinel attribute is valid from gcc version 4.0 */
433 #if defined(__GNUC__) && (__GNUC__ >= 4)
434 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
436 #define LAST_ARG_MUST_BE_NULL
439 #define MAYBE_UNUSED __attribute__((__unused__))
441 #include "compat/bswap.h"
443 #include "wildmatch.h"
447 /* General helper functions */
448 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
449 extern NORETURN
void usage(const char *err
);
450 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
451 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
452 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
453 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
454 extern int error_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
455 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
456 extern void warning_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
459 #ifdef APPLE_COMMON_CRYPTO
460 #include "compat/apple-common-crypto.h"
462 #include <openssl/evp.h>
463 #include <openssl/hmac.h>
464 #endif /* APPLE_COMMON_CRYPTO */
465 #include <openssl/x509v3.h>
466 #endif /* NO_OPENSSL */
469 * Let callers be aware of the constant return value; this can help
470 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
471 * because some compilers may not support variadic macros. Since we're only
472 * trying to help gcc, anyway, it's OK; other compilers will fall back to
473 * using the function as usual.
475 #if defined(__GNUC__)
476 static inline int const_error(void)
480 #define error(...) (error(__VA_ARGS__), const_error())
481 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
484 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
485 extern void set_error_routine(void (*routine
)(const char *err
, va_list params
));
486 extern void (*get_error_routine(void))(const char *err
, va_list params
);
487 extern void set_warn_routine(void (*routine
)(const char *warn
, va_list params
));
488 extern void (*get_warn_routine(void))(const char *warn
, va_list params
);
489 extern void set_die_is_recursing_routine(int (*routine
)(void));
491 extern int starts_with(const char *str
, const char *prefix
);
492 extern int istarts_with(const char *str
, const char *prefix
);
495 * If the string "str" begins with the string found in "prefix", return 1.
496 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
497 * the string right after the prefix).
499 * Otherwise, return 0 and leave "out" untouched.
503 * [extract branch name, fail if not a branch]
504 * if (!skip_prefix(ref, "refs/heads/", &branch)
507 * [skip prefix if present, otherwise use whole string]
508 * skip_prefix(name, "refs/heads/", &name);
510 static inline int skip_prefix(const char *str
, const char *prefix
,
518 } while (*str
++ == *prefix
++);
523 * If the string "str" is the same as the string in "prefix", then the "arg"
524 * parameter is set to the "def" parameter and 1 is returned.
525 * If the string "str" begins with the string found in "prefix" and then a
526 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
527 * (i.e., to the point in the string right after the prefix and the "=" sign),
530 * Otherwise, return 0 and leave "arg" untouched.
532 * When we accept both a "--key" and a "--key=<val>" option, this function
533 * can be used instead of !strcmp(arg, "--key") and then
534 * skip_prefix(arg, "--key=", &arg) to parse such an option.
536 int skip_to_optional_arg_default(const char *str
, const char *prefix
,
537 const char **arg
, const char *def
);
539 static inline int skip_to_optional_arg(const char *str
, const char *prefix
,
542 return skip_to_optional_arg_default(str
, prefix
, arg
, "");
546 * Like skip_prefix, but promises never to read past "len" bytes of the input
547 * buffer, and returns the remaining number of bytes in "out" via "outlen".
549 static inline int skip_prefix_mem(const char *buf
, size_t len
,
551 const char **out
, size_t *outlen
)
553 size_t prefix_len
= strlen(prefix
);
554 if (prefix_len
<= len
&& !memcmp(buf
, prefix
, prefix_len
)) {
555 *out
= buf
+ prefix_len
;
556 *outlen
= len
- prefix_len
;
563 * If buf ends with suffix, return 1 and subtract the length of the suffix
564 * from *len. Otherwise, return 0 and leave *len untouched.
566 static inline int strip_suffix_mem(const char *buf
, size_t *len
,
569 size_t suflen
= strlen(suffix
);
570 if (*len
< suflen
|| memcmp(buf
+ (*len
- suflen
), suffix
, suflen
))
577 * If str ends with suffix, return 1 and set *len to the size of the string
578 * without the suffix. Otherwise, return 0 and set *len to the size of the
581 * Note that we do _not_ NUL-terminate str to the new length.
583 static inline int strip_suffix(const char *str
, const char *suffix
, size_t *len
)
586 return strip_suffix_mem(str
, len
, suffix
);
589 static inline int ends_with(const char *str
, const char *suffix
)
592 return strip_suffix(str
, suffix
, &len
);
595 #define SWAP(a, b) do { \
596 void *_swap_a_ptr = &(a); \
597 void *_swap_b_ptr = &(b); \
598 unsigned char _swap_buffer[sizeof(a)]; \
599 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
600 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
601 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
602 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
605 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
610 #define MAP_PRIVATE 1
613 #define mmap git_mmap
614 #define munmap git_munmap
615 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
616 extern int git_munmap(void *start
, size_t length
);
618 #else /* NO_MMAP || USE_WIN32_MMAP */
620 #include <sys/mman.h>
622 #endif /* NO_MMAP || USE_WIN32_MMAP */
626 /* This value must be multiple of (pagesize * 2) */
627 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
631 /* This value must be multiple of (pagesize * 2) */
632 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
633 (sizeof(void*) >= 8 \
634 ? 1 * 1024 * 1024 * 1024 \
640 #define MAP_FAILED ((void *)-1)
643 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
644 #define on_disk_bytes(st) ((st).st_size)
646 #define on_disk_bytes(st) ((st).st_blocks * 512)
649 #ifdef NEEDS_MODE_TRANSLATION
658 #define S_IFMT 0170000
659 #define S_IFREG 0100000
660 #define S_IFDIR 0040000
661 #define S_IFLNK 0120000
662 #define S_IFBLK 0060000
663 #define S_IFCHR 0020000
664 #define S_IFIFO 0010000
665 #define S_IFSOCK 0140000
669 #define stat(path, buf) git_stat(path, buf)
670 extern int git_stat(const char *, struct stat
*);
674 #define fstat(fd, buf) git_fstat(fd, buf)
675 extern int git_fstat(int, struct stat
*);
679 #define lstat(path, buf) git_lstat(path, buf)
680 extern int git_lstat(const char *, struct stat
*);
683 #define DEFAULT_PACKED_GIT_LIMIT \
684 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
687 #define pread git_pread
688 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
691 * Forward decl that will remind us if its twin in cache.h changes.
692 * This function is used in compat/pread.c. But we can't include
695 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
698 #define setenv gitsetenv
699 extern int gitsetenv(const char *, const char *, int);
703 #define mkdtemp gitmkdtemp
704 extern char *gitmkdtemp(char *);
708 #define unsetenv gitunsetenv
709 extern void gitunsetenv(const char *);
713 #define strcasestr gitstrcasestr
714 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
718 #define strlcpy gitstrlcpy
719 extern size_t gitstrlcpy(char *, const char *, size_t);
723 #define strtoumax gitstrtoumax
724 extern uintmax_t gitstrtoumax(const char *, char **, int);
725 #define strtoimax gitstrtoimax
726 extern intmax_t gitstrtoimax(const char *, char **, int);
730 #define hstrerror githstrerror
731 extern const char *githstrerror(int herror
);
735 #define memmem gitmemmem
736 void *gitmemmem(const void *haystack
, size_t haystacklen
,
737 const void *needle
, size_t needlelen
);
740 #ifdef OVERRIDE_STRDUP
744 #define strdup gitstrdup
745 char *gitstrdup(const char *s
);
748 #ifdef NO_GETPAGESIZE
749 #define getpagesize() sysconf(_SC_PAGESIZE)
756 #ifdef FREAD_READS_DIRECTORIES
757 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
761 # define fopen(a,b) git_fopen(a,b)
763 extern FILE *git_fopen(const char*, const char*);
766 #ifdef SNPRINTF_RETURNS_BOGUS
770 #define snprintf git_snprintf
771 extern int git_snprintf(char *str
, size_t maxsize
,
772 const char *format
, ...);
776 #define vsnprintf git_vsnprintf
777 extern int git_vsnprintf(char *str
, size_t maxsize
,
778 const char *format
, va_list ap
);
781 #ifdef __GLIBC_PREREQ
782 #if __GLIBC_PREREQ(2, 1)
783 #define HAVE_STRCHRNUL
787 #ifndef HAVE_STRCHRNUL
788 #define strchrnul gitstrchrnul
789 static inline char *gitstrchrnul(const char *s
, int c
)
791 while (*s
&& *s
!= c
)
798 int inet_pton(int af
, const char *src
, void *dst
);
802 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
806 #define atexit git_atexit
807 extern int git_atexit(void (*handler
)(void));
810 typedef void (*try_to_free_t
)(size_t);
811 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
813 static inline size_t st_add(size_t a
, size_t b
)
815 if (unsigned_add_overflows(a
, b
))
816 die("size_t overflow: %"PRIuMAX
" + %"PRIuMAX
,
817 (uintmax_t)a
, (uintmax_t)b
);
820 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
821 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
823 static inline size_t st_mult(size_t a
, size_t b
)
825 if (unsigned_mult_overflows(a
, b
))
826 die("size_t overflow: %"PRIuMAX
" * %"PRIuMAX
,
827 (uintmax_t)a
, (uintmax_t)b
);
831 static inline size_t st_sub(size_t a
, size_t b
)
834 die("size_t underflow: %"PRIuMAX
" - %"PRIuMAX
,
835 (uintmax_t)a
, (uintmax_t)b
);
841 # define xalloca(size) (alloca(size))
842 # define xalloca_free(p) do {} while (0)
844 # define xalloca(size) (xmalloc(size))
845 # define xalloca_free(p) (free(p))
847 extern char *xstrdup(const char *str
);
848 extern void *xmalloc(size_t size
);
849 extern void *xmallocz(size_t size
);
850 extern void *xmallocz_gently(size_t size
);
851 extern void *xmemdupz(const void *data
, size_t len
);
852 extern char *xstrndup(const char *str
, size_t len
);
853 extern void *xrealloc(void *ptr
, size_t size
);
854 extern void *xcalloc(size_t nmemb
, size_t size
);
855 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
856 extern void *xmmap_gently(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
857 extern int xopen(const char *path
, int flags
, ...);
858 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
859 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
860 extern ssize_t
xpread(int fd
, void *buf
, size_t len
, off_t offset
);
861 extern int xdup(int fd
);
862 extern FILE *xfopen(const char *path
, const char *mode
);
863 extern FILE *xfdopen(int fd
, const char *mode
);
864 extern int xmkstemp(char *temp_filename
);
865 extern int xmkstemp_mode(char *temp_filename
, int mode
);
866 extern char *xgetcwd(void);
867 extern FILE *fopen_for_writing(const char *path
);
868 extern FILE *fopen_or_warn(const char *path
, const char *mode
);
871 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
872 * that ptr is used twice, so don't pass e.g. ptr++.
874 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
876 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
877 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)));
878 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
880 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
881 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
882 static inline void copy_array(void *dst
, const void *src
, size_t n
, size_t size
)
885 memcpy(dst
, src
, st_mult(size
, n
));
888 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
889 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
890 static inline void move_array(void *dst
, const void *src
, size_t n
, size_t size
)
893 memmove(dst
, src
, st_mult(size
, n
));
897 * These functions help you allocate structs with flex arrays, and copy
898 * the data directly into the array. For example, if you had:
902 * char name[FLEX_ARRAY];
908 * FLEX_ALLOC_MEM(f, name, src, len);
910 * to allocate a "foo" with the contents of "src" in the "name" field.
911 * The resulting struct is automatically zero'd, and the flex-array field
912 * is NUL-terminated (whether the incoming src buffer was or not).
914 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
915 * but do want to store a pointer to some extra data in the same allocated
916 * block. For example, if you have:
926 * FLEXPTR_ALLOC_STR(f, name, src);
928 * and "name" will point to a block of memory after the struct, which will be
929 * freed along with the struct (but the pointer can be repointed anywhere).
931 * The *_STR variants accept a string parameter rather than a ptr/len
934 * Note that these macros will evaluate the first parameter multiple
935 * times, and it must be assignable as an lvalue.
937 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
938 size_t flex_array_len_ = (len); \
939 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
940 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
942 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
943 size_t flex_array_len_ = (len); \
944 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
945 memcpy((x) + 1, (buf), flex_array_len_); \
946 (x)->ptrname = (void *)((x)+1); \
948 #define FLEX_ALLOC_STR(x, flexname, str) \
949 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
950 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
951 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
953 static inline char *xstrdup_or_null(const char *str
)
955 return str
? xstrdup(str
) : NULL
;
958 static inline size_t xsize_t(off_t len
)
960 size_t size
= (size_t) len
;
962 if (len
!= (off_t
) size
)
963 die("Cannot handle files this big");
967 __attribute__((format (printf
, 3, 4)))
968 extern int xsnprintf(char *dst
, size_t max
, const char *fmt
, ...);
970 #ifndef HOST_NAME_MAX
971 #define HOST_NAME_MAX 256
974 extern int xgethostname(char *buf
, size_t len
);
976 /* in ctype.c, for kwset users */
977 extern const unsigned char tolower_trans_tbl
[256];
979 /* Sane ctype - no locale, and works with signed chars */
994 extern const unsigned char sane_ctype
[256];
995 #define GIT_SPACE 0x01
996 #define GIT_DIGIT 0x02
997 #define GIT_ALPHA 0x04
998 #define GIT_GLOB_SPECIAL 0x08
999 #define GIT_REGEX_SPECIAL 0x10
1000 #define GIT_PATHSPEC_MAGIC 0x20
1001 #define GIT_CNTRL 0x40
1002 #define GIT_PUNCT 0x80
1003 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1004 #define isascii(x) (((x) & ~0x7f) == 0)
1005 #define isspace(x) sane_istest(x,GIT_SPACE)
1006 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1007 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1008 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1009 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1010 #define islower(x) sane_iscase(x, 1)
1011 #define isupper(x) sane_iscase(x, 0)
1012 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1013 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1014 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1015 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1016 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1017 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1018 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1019 #define toupper(x) sane_case((unsigned char)(x), 0)
1020 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1022 static inline int sane_case(int x
, int high
)
1024 if (sane_istest(x
, GIT_ALPHA
))
1025 x
= (x
& ~0x20) | high
;
1029 static inline int sane_iscase(int x
, int is_lower
)
1031 if (!sane_istest(x
, GIT_ALPHA
))
1035 return (x
& 0x20) != 0;
1037 return (x
& 0x20) == 0;
1041 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1042 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1043 * locale-specific conversions).
1045 static inline int skip_iprefix(const char *str
, const char *prefix
,
1053 } while (tolower(*str
++) == tolower(*prefix
++));
1057 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
1063 /* negative values would be accepted by strtoul */
1066 ul
= strtoul(s
, &p
, base
);
1067 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
1073 static inline int strtol_i(char const *s
, int base
, int *result
)
1079 ul
= strtol(s
, &p
, base
);
1080 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
1086 #ifdef INTERNAL_QSORT
1087 void git_qsort(void *base
, size_t nmemb
, size_t size
,
1088 int(*compar
)(const void *, const void *));
1089 #define qsort git_qsort
1092 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1093 static inline void sane_qsort(void *base
, size_t nmemb
, size_t size
,
1094 int(*compar
)(const void *, const void *))
1097 qsort(base
, nmemb
, size
, compar
);
1100 #ifndef HAVE_ISO_QSORT_S
1101 int git_qsort_s(void *base
, size_t nmemb
, size_t size
,
1102 int (*compar
)(const void *, const void *, void *), void *ctx
);
1103 #define qsort_s git_qsort_s
1106 #define QSORT_S(base, n, compar, ctx) do { \
1107 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1108 BUG("qsort_s() failed"); \
1111 #ifndef REG_STARTEND
1112 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1115 static inline int regexec_buf(const regex_t
*preg
, const char *buf
, size_t size
,
1116 size_t nmatch
, regmatch_t pmatch
[], int eflags
)
1118 assert(nmatch
> 0 && pmatch
);
1119 pmatch
[0].rm_so
= 0;
1120 pmatch
[0].rm_eo
= size
;
1121 return regexec(preg
, buf
, nmatch
, pmatch
, eflags
| REG_STARTEND
);
1124 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1125 # define FORCE_DIR_SET_GID S_ISGID
1127 # define FORCE_DIR_SET_GID 0
1132 #define ST_CTIME_NSEC(st) 0
1133 #define ST_MTIME_NSEC(st) 0
1135 #ifdef USE_ST_TIMESPEC
1136 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1137 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1139 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1140 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1144 #ifdef UNRELIABLE_FSTAT
1145 #define fstat_is_reliable() 0
1147 #define fstat_is_reliable() 1
1152 * Since an obvious implementation of va_list would be to make it a
1153 * pointer into the stack frame, a simple assignment will work on
1154 * many systems. But let's try to be more portable.
1157 #define va_copy(dst, src) __va_copy(dst, src)
1159 #define va_copy(dst, src) ((dst) = (src))
1163 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
1164 #define HAVE_VARIADIC_MACROS 1
1167 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1168 extern int BUG_exit_code
;
1170 #ifdef HAVE_VARIADIC_MACROS
1171 __attribute__((format (printf
, 3, 4))) NORETURN
1172 void BUG_fl(const char *file
, int line
, const char *fmt
, ...);
1173 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1175 __attribute__((format (printf
, 1, 2))) NORETURN
1176 void BUG(const char *fmt
, ...);
1180 * Preserves errno, prints a message, but gives no warning for ENOENT.
1181 * Returns 0 on success, which includes trying to unlink an object that does
1184 int unlink_or_warn(const char *path
);
1186 * Tries to unlink file. Returns 0 if unlink succeeded
1187 * or the file already didn't exist. Returns -1 and
1188 * appends a message to err suitable for
1189 * 'error("%s", err->buf)' on error.
1191 int unlink_or_msg(const char *file
, struct strbuf
*err
);
1193 * Preserves errno, prints a message, but gives no warning for ENOENT.
1194 * Returns 0 on success, which includes trying to remove a directory that does
1197 int rmdir_or_warn(const char *path
);
1199 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1200 * the supplied file mode.
1202 int remove_or_warn(unsigned int mode
, const char *path
);
1205 * Call access(2), but warn for any error except "missing file"
1206 * (ENOENT or ENOTDIR).
1208 #define ACCESS_EACCES_OK (1U << 0)
1209 int access_or_warn(const char *path
, int mode
, unsigned flag
);
1210 int access_or_die(const char *path
, int mode
, unsigned flag
);
1212 /* Warn on an inaccessible file if errno indicates this is an error */
1213 int warn_on_fopen_errors(const char *path
);
1215 #ifdef GMTIME_UNRELIABLE_ERRORS
1216 struct tm
*git_gmtime(const time_t *);
1217 struct tm
*git_gmtime_r(const time_t *, struct tm
*);
1218 #define gmtime git_gmtime
1219 #define gmtime_r git_gmtime_r
1222 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1223 #define USE_PARENS_AROUND_GETTEXT_N 1
1227 # define SHELL_PATH "/bin/sh"
1230 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1231 #define flockfile(fh)
1232 #define funlockfile(fh)
1233 #define getc_unlocked(fh) getc(fh)
1237 * Our code often opens a path to an optional file, to work on its
1238 * contents when we can successfully open it. We can ignore a failure
1239 * to open if such an optional file does not exist, but we do want to
1240 * report a failure in opening for other reasons (e.g. we got an I/O
1241 * error, or the file is there, but we lack the permission to open).
1243 * Call this function after seeing an error from open() or fopen() to
1244 * see if the errno indicates a missing file that we can safely ignore.
1246 static inline int is_missing_file_error(int errno_
)
1248 return (errno_
== ENOENT
|| errno_
== ENOTDIR
);
1251 extern int cmd_main(int, const char **);
1254 * You can mark a stack variable with UNLEAK(var) to avoid it being
1255 * reported as a leak by tools like LSAN or valgrind. The argument
1256 * should generally be the variable itself (not its address and not what
1257 * it points to). It's safe to use this on pointers which may already
1258 * have been freed, or on pointers which may still be in use.
1260 * Use this _only_ for a variable that leaks by going out of scope at
1261 * program exit (so only from cmd_* functions or their direct helpers).
1262 * Normal functions, especially those which may be called multiple
1263 * times, should actually free their memory. This is only meant as
1264 * an annotation, and does nothing in non-leak-checking builds.
1266 #ifdef SUPPRESS_ANNOTATED_LEAKS
1267 extern void unleak_memory(const void *ptr
, size_t len
);
1268 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1270 #define UNLEAK(var) do {} while (0)
1274 * This include must come after system headers, since it introduces macros that
1275 * replace system names.