Merge branch 'cb/test-use-ere-for-alternation'
[git.git] / git-compat-util.h
bloba73632e8e43ce997f4bb2abf9c4e5520d2b078e2
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #ifdef USE_MSVC_CRTDBG
5 /*
6 * For these to work they must appear very early in each
7 * file -- before most of the standard header files.
8 */
9 #include <stdlib.h>
10 #include <crtdbg.h>
11 #endif
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).
19 * Use them like this:
20 * #if GIT_GNUC_PREREQ (2,8)
21 * ... code requiring gcc 2.8 or later ...
22 * #endif
24 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
25 # define GIT_GNUC_PREREQ(maj, min) \
26 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
27 #else
28 #define GIT_GNUC_PREREQ(maj, min) 0
29 #endif
32 #ifndef FLEX_ARRAY
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__)
39 # if (__GNUC__ >= 3)
40 # define FLEX_ARRAY /* empty */
41 # else
42 # define FLEX_ARRAY 0 /* older GNU extension */
43 # endif
44 #endif
47 * Otherwise, default to safer but a bit wasteful traditional style
49 #ifndef FLEX_ARRAY
50 # define FLEX_ARRAY 1
51 #endif
52 #endif
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".
62 * Example:
63 * #define foo_to_char(foo) \
64 * ((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])))
75 #else
76 # define BARF_UNLESS_AN_ARRAY(arr) 0
77 #endif
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))
116 #ifdef __GNUC__
117 #define TYPEOF(x) (__typeof__(x))
118 #else
119 #define TYPEOF(x)
120 #endif
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)
130 #if defined(__sun__)
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
140 # else
141 # define _XOPEN_SOURCE 500
142 # endif
143 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
144 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
145 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
146 !defined(__CYGWIN__)
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 */
149 #endif
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
160 # endif
161 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
162 #include <winsock2.h>
163 #include <windows.h>
164 #define GIT_WINDOWS_NATIVE
165 #endif
167 #include <unistd.h>
168 #include <stdio.h>
169 #include <sys/stat.h>
170 #include <fcntl.h>
171 #include <stddef.h>
172 #include <stdlib.h>
173 #include <stdarg.h>
174 #include <string.h>
175 #ifdef HAVE_STRINGS_H
176 #include <strings.h> /* for strcasecmp() */
177 #endif
178 #include <errno.h>
179 #include <limits.h>
180 #ifdef NEEDS_SYS_PARAM_H
181 #include <sys/param.h>
182 #endif
183 #include <sys/types.h>
184 #include <dirent.h>
185 #include <sys/time.h>
186 #include <time.h>
187 #include <signal.h>
188 #include <assert.h>
189 #include <regex.h>
190 #include <utime.h>
191 #include <syslog.h>
192 #if !defined(NO_POLL_H)
193 #include <poll.h>
194 #elif !defined(NO_SYS_POLL_H)
195 #include <sys/poll.h>
196 #else
197 /* Pull the compat stuff */
198 #include <poll.h>
199 #endif
200 #ifdef HAVE_BSD_SYSCTL
201 #include <sys/sysctl.h>
202 #endif
204 #if defined(__CYGWIN__)
205 #include "compat/win32/path-utils.h"
206 #endif
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"
214 #else
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>
220 #include <termios.h>
221 #ifndef NO_SYS_SELECT_H
222 #include <sys/select.h>
223 #endif
224 #include <netinet/in.h>
225 #include <netinet/tcp.h>
226 #include <arpa/inet.h>
227 #include <netdb.h>
228 #include <pwd.h>
229 #include <sys/un.h>
230 #ifndef NO_INTTYPES_H
231 #include <inttypes.h>
232 #else
233 #include <stdint.h>
234 #endif
235 #ifdef NO_INTPTR_T
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;
245 #endif
246 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
247 #include <grp.h>
248 #define _ALL_SOURCE 1
249 #endif
251 /* used on Mac OS X */
252 #ifdef PRECOMPOSE_UNICODE
253 #include "compat/precompose_utf8.h"
254 #else
255 #define precompose_str(in,i_nfd2nfc)
256 #define precompose_argv(c,v)
257 #define probe_utf8_pathname_composition()
258 #endif
260 #ifdef MKDIR_WO_TRAILING_SLASH
261 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
262 int compat_mkdir_wo_trailing_slash(const char*, mode_t);
263 #endif
265 #ifdef NO_STRUCT_ITIMERVAL
266 struct itimerval {
267 struct timeval it_interval;
268 struct timeval it_value;
270 #endif
272 #ifdef NO_SETITIMER
273 #define setitimer(which,value,ovalue)
274 #endif
276 #ifndef NO_LIBGEN_H
277 #include <libgen.h>
278 #else
279 #define basename gitbasename
280 char *gitbasename(char *);
281 #define dirname gitdirname
282 char *gitdirname(char *);
283 #endif
285 #ifndef NO_ICONV
286 #include <iconv.h>
287 #endif
289 #ifndef NO_OPENSSL
290 #ifdef __APPLE__
291 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
292 #include <AvailabilityMacros.h>
293 #undef DEPRECATED_ATTRIBUTE
294 #define DEPRECATED_ATTRIBUTE
295 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
296 #endif
297 #include <openssl/ssl.h>
298 #include <openssl/err.h>
299 #endif
301 #ifdef HAVE_SYSINFO
302 # include <sys/sysinfo.h>
303 #endif
305 /* On most systems <netdb.h> would have given us this, but
306 * not on some systems (e.g. z/OS).
308 #ifndef NI_MAXHOST
309 #define NI_MAXHOST 1025
310 #endif
312 #ifndef NI_MAXSERV
313 #define NI_MAXSERV 32
314 #endif
316 /* On most systems <limits.h> would have given us this, but
317 * not on some systems (e.g. GNU/Hurd).
319 #ifndef PATH_MAX
320 #define PATH_MAX 4096
321 #endif
323 typedef uintmax_t timestamp_t;
324 #define PRItime PRIuMAX
325 #define parse_timestamp strtoumax
326 #define TIME_MAX UINTMAX_MAX
327 #define TIME_MIN 0
329 #ifndef PATH_SEP
330 #define PATH_SEP ':'
331 #endif
333 #ifdef HAVE_PATHS_H
334 #include <paths.h>
335 #endif
336 #ifndef _PATH_DEFPATH
337 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
338 #endif
340 #ifndef platform_core_config
341 static inline int noop_core_config(const char *var, const char *value, void *cb)
343 return 0;
345 #define platform_core_config noop_core_config
346 #endif
348 #ifndef has_dos_drive_prefix
349 static inline int git_has_dos_drive_prefix(const char *path)
351 return 0;
353 #define has_dos_drive_prefix git_has_dos_drive_prefix
354 #endif
356 #ifndef skip_dos_drive_prefix
357 static inline int git_skip_dos_drive_prefix(char **path)
359 return 0;
361 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
362 #endif
364 #ifndef is_dir_sep
365 static inline int git_is_dir_sep(int c)
367 return c == '/';
369 #define is_dir_sep git_is_dir_sep
370 #endif
372 #ifndef offset_1st_component
373 static inline int git_offset_1st_component(const char *path)
375 return is_dir_sep(path[0]);
377 #define offset_1st_component git_offset_1st_component
378 #endif
380 #ifndef is_valid_path
381 #define is_valid_path(path) 1
382 #endif
384 #ifndef find_last_dir_sep
385 static inline char *git_find_last_dir_sep(const char *path)
387 return strrchr(path, '/');
389 #define find_last_dir_sep git_find_last_dir_sep
390 #endif
392 #ifndef has_dir_sep
393 static inline int git_has_dir_sep(const char *path)
395 return !!strchr(path, '/');
397 #define has_dir_sep(path) git_has_dir_sep(path)
398 #endif
400 #ifndef query_user_email
401 #define query_user_email() NULL
402 #endif
404 #ifdef __TANDEM
405 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
406 #include <floss.h(floss_getpwuid)>
407 #ifndef NSIG
409 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
410 * known, by detective work using kill -l as a list is all signals
411 * instead of signal.h where it should be.
413 # define NSIG 100
414 #endif
415 #endif
417 #if defined(__HP_cc) && (__HP_cc >= 61000)
418 #define NORETURN __attribute__((noreturn))
419 #define NORETURN_PTR
420 #elif defined(__GNUC__) && !defined(NO_NORETURN)
421 #define NORETURN __attribute__((__noreturn__))
422 #define NORETURN_PTR __attribute__((__noreturn__))
423 #elif defined(_MSC_VER)
424 #define NORETURN __declspec(noreturn)
425 #define NORETURN_PTR
426 #else
427 #define NORETURN
428 #define NORETURN_PTR
429 #ifndef __GNUC__
430 #ifndef __attribute__
431 #define __attribute__(x)
432 #endif
433 #endif
434 #endif
436 /* The sentinel attribute is valid from gcc version 4.0 */
437 #if defined(__GNUC__) && (__GNUC__ >= 4)
438 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
439 #else
440 #define LAST_ARG_MUST_BE_NULL
441 #endif
443 #define MAYBE_UNUSED __attribute__((__unused__))
445 #include "compat/bswap.h"
447 #include "wildmatch.h"
449 struct strbuf;
451 /* General helper functions */
452 void vreportf(const char *prefix, const char *err, va_list params);
453 NORETURN void usage(const char *err);
454 NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
455 NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
456 NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
457 int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
458 int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
459 void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
460 void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
462 #ifndef NO_OPENSSL
463 #ifdef APPLE_COMMON_CRYPTO
464 #include "compat/apple-common-crypto.h"
465 #else
466 #include <openssl/evp.h>
467 #include <openssl/hmac.h>
468 #endif /* APPLE_COMMON_CRYPTO */
469 #include <openssl/x509v3.h>
470 #endif /* NO_OPENSSL */
473 * Let callers be aware of the constant return value; this can help
474 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
475 * because some compilers may not support variadic macros. Since we're only
476 * trying to help gcc, anyway, it's OK; other compilers will fall back to
477 * using the function as usual.
479 #if defined(__GNUC__)
480 static inline int const_error(void)
482 return -1;
484 #define error(...) (error(__VA_ARGS__), const_error())
485 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
486 #endif
488 void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
489 void set_error_routine(void (*routine)(const char *err, va_list params));
490 extern void (*get_error_routine(void))(const char *err, va_list params);
491 void set_warn_routine(void (*routine)(const char *warn, va_list params));
492 extern void (*get_warn_routine(void))(const char *warn, va_list params);
493 void set_die_is_recursing_routine(int (*routine)(void));
495 int starts_with(const char *str, const char *prefix);
496 int istarts_with(const char *str, const char *prefix);
499 * If the string "str" begins with the string found in "prefix", return 1.
500 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
501 * the string right after the prefix).
503 * Otherwise, return 0 and leave "out" untouched.
505 * Examples:
507 * [extract branch name, fail if not a branch]
508 * if (!skip_prefix(ref, "refs/heads/", &branch)
509 * return -1;
511 * [skip prefix if present, otherwise use whole string]
512 * skip_prefix(name, "refs/heads/", &name);
514 static inline int skip_prefix(const char *str, const char *prefix,
515 const char **out)
517 do {
518 if (!*prefix) {
519 *out = str;
520 return 1;
522 } while (*str++ == *prefix++);
523 return 0;
527 * If the string "str" is the same as the string in "prefix", then the "arg"
528 * parameter is set to the "def" parameter and 1 is returned.
529 * If the string "str" begins with the string found in "prefix" and then a
530 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
531 * (i.e., to the point in the string right after the prefix and the "=" sign),
532 * and 1 is returned.
534 * Otherwise, return 0 and leave "arg" untouched.
536 * When we accept both a "--key" and a "--key=<val>" option, this function
537 * can be used instead of !strcmp(arg, "--key") and then
538 * skip_prefix(arg, "--key=", &arg) to parse such an option.
540 int skip_to_optional_arg_default(const char *str, const char *prefix,
541 const char **arg, const char *def);
543 static inline int skip_to_optional_arg(const char *str, const char *prefix,
544 const char **arg)
546 return skip_to_optional_arg_default(str, prefix, arg, "");
550 * Like skip_prefix, but promises never to read past "len" bytes of the input
551 * buffer, and returns the remaining number of bytes in "out" via "outlen".
553 static inline int skip_prefix_mem(const char *buf, size_t len,
554 const char *prefix,
555 const char **out, size_t *outlen)
557 size_t prefix_len = strlen(prefix);
558 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
559 *out = buf + prefix_len;
560 *outlen = len - prefix_len;
561 return 1;
563 return 0;
567 * If buf ends with suffix, return 1 and subtract the length of the suffix
568 * from *len. Otherwise, return 0 and leave *len untouched.
570 static inline int strip_suffix_mem(const char *buf, size_t *len,
571 const char *suffix)
573 size_t suflen = strlen(suffix);
574 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
575 return 0;
576 *len -= suflen;
577 return 1;
581 * If str ends with suffix, return 1 and set *len to the size of the string
582 * without the suffix. Otherwise, return 0 and set *len to the size of the
583 * string.
585 * Note that we do _not_ NUL-terminate str to the new length.
587 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
589 *len = strlen(str);
590 return strip_suffix_mem(str, len, suffix);
593 static inline int ends_with(const char *str, const char *suffix)
595 size_t len;
596 return strip_suffix(str, suffix, &len);
599 #define SWAP(a, b) do { \
600 void *_swap_a_ptr = &(a); \
601 void *_swap_b_ptr = &(b); \
602 unsigned char _swap_buffer[sizeof(a)]; \
603 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
604 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
605 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
606 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
607 } while (0)
609 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
611 #ifndef PROT_READ
612 #define PROT_READ 1
613 #define PROT_WRITE 2
614 #define MAP_PRIVATE 1
615 #endif
617 #define mmap git_mmap
618 #define munmap git_munmap
619 void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
620 int git_munmap(void *start, size_t length);
622 #else /* NO_MMAP || USE_WIN32_MMAP */
624 #include <sys/mman.h>
626 #endif /* NO_MMAP || USE_WIN32_MMAP */
628 #ifdef NO_MMAP
630 /* This value must be multiple of (pagesize * 2) */
631 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
633 #else /* NO_MMAP */
635 /* This value must be multiple of (pagesize * 2) */
636 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
637 (sizeof(void*) >= 8 \
638 ? 1 * 1024 * 1024 * 1024 \
639 : 32 * 1024 * 1024)
641 #endif /* NO_MMAP */
643 #ifndef MAP_FAILED
644 #define MAP_FAILED ((void *)-1)
645 #endif
647 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
648 #define on_disk_bytes(st) ((st).st_size)
649 #else
650 #define on_disk_bytes(st) ((st).st_blocks * 512)
651 #endif
653 #ifdef NEEDS_MODE_TRANSLATION
654 #undef S_IFMT
655 #undef S_IFREG
656 #undef S_IFDIR
657 #undef S_IFLNK
658 #undef S_IFBLK
659 #undef S_IFCHR
660 #undef S_IFIFO
661 #undef S_IFSOCK
662 #define S_IFMT 0170000
663 #define S_IFREG 0100000
664 #define S_IFDIR 0040000
665 #define S_IFLNK 0120000
666 #define S_IFBLK 0060000
667 #define S_IFCHR 0020000
668 #define S_IFIFO 0010000
669 #define S_IFSOCK 0140000
670 #ifdef stat
671 #undef stat
672 #endif
673 #define stat(path, buf) git_stat(path, buf)
674 int git_stat(const char *, struct stat *);
675 #ifdef fstat
676 #undef fstat
677 #endif
678 #define fstat(fd, buf) git_fstat(fd, buf)
679 int git_fstat(int, struct stat *);
680 #ifdef lstat
681 #undef lstat
682 #endif
683 #define lstat(path, buf) git_lstat(path, buf)
684 int git_lstat(const char *, struct stat *);
685 #endif
687 #define DEFAULT_PACKED_GIT_LIMIT \
688 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
690 #ifdef NO_PREAD
691 #define pread git_pread
692 ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
693 #endif
695 * Forward decl that will remind us if its twin in cache.h changes.
696 * This function is used in compat/pread.c. But we can't include
697 * cache.h there.
699 ssize_t read_in_full(int fd, void *buf, size_t count);
701 #ifdef NO_SETENV
702 #define setenv gitsetenv
703 int gitsetenv(const char *, const char *, int);
704 #endif
706 #ifdef NO_MKDTEMP
707 #define mkdtemp gitmkdtemp
708 char *gitmkdtemp(char *);
709 #endif
711 #ifdef NO_UNSETENV
712 #define unsetenv gitunsetenv
713 void gitunsetenv(const char *);
714 #endif
716 #ifdef NO_STRCASESTR
717 #define strcasestr gitstrcasestr
718 char *gitstrcasestr(const char *haystack, const char *needle);
719 #endif
721 #ifdef NO_STRLCPY
722 #define strlcpy gitstrlcpy
723 size_t gitstrlcpy(char *, const char *, size_t);
724 #endif
726 #ifdef NO_STRTOUMAX
727 #define strtoumax gitstrtoumax
728 uintmax_t gitstrtoumax(const char *, char **, int);
729 #define strtoimax gitstrtoimax
730 intmax_t gitstrtoimax(const char *, char **, int);
731 #endif
733 #ifdef NO_HSTRERROR
734 #define hstrerror githstrerror
735 const char *githstrerror(int herror);
736 #endif
738 #ifdef NO_MEMMEM
739 #define memmem gitmemmem
740 void *gitmemmem(const void *haystack, size_t haystacklen,
741 const void *needle, size_t needlelen);
742 #endif
744 #ifdef OVERRIDE_STRDUP
745 #ifdef strdup
746 #undef strdup
747 #endif
748 #define strdup gitstrdup
749 char *gitstrdup(const char *s);
750 #endif
752 #ifdef NO_GETPAGESIZE
753 #define getpagesize() sysconf(_SC_PAGESIZE)
754 #endif
756 #ifndef O_CLOEXEC
757 #define O_CLOEXEC 0
758 #endif
760 #ifdef FREAD_READS_DIRECTORIES
761 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
762 # ifdef fopen
763 # undef fopen
764 # endif
765 # define fopen(a,b) git_fopen(a,b)
766 # endif
767 FILE *git_fopen(const char*, const char*);
768 #endif
770 #ifdef SNPRINTF_RETURNS_BOGUS
771 #ifdef snprintf
772 #undef snprintf
773 #endif
774 #define snprintf git_snprintf
775 int git_snprintf(char *str, size_t maxsize,
776 const char *format, ...);
777 #ifdef vsnprintf
778 #undef vsnprintf
779 #endif
780 #define vsnprintf git_vsnprintf
781 int git_vsnprintf(char *str, size_t maxsize,
782 const char *format, va_list ap);
783 #endif
785 #ifdef __GLIBC_PREREQ
786 #if __GLIBC_PREREQ(2, 1)
787 #define HAVE_STRCHRNUL
788 #endif
789 #endif
791 #ifndef HAVE_STRCHRNUL
792 #define strchrnul gitstrchrnul
793 static inline char *gitstrchrnul(const char *s, int c)
795 while (*s && *s != c)
796 s++;
797 return (char *)s;
799 #endif
801 #ifdef NO_INET_PTON
802 int inet_pton(int af, const char *src, void *dst);
803 #endif
805 #ifdef NO_INET_NTOP
806 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
807 #endif
809 #ifdef NO_PTHREADS
810 #define atexit git_atexit
811 int git_atexit(void (*handler)(void));
812 #endif
814 static inline size_t st_add(size_t a, size_t b)
816 if (unsigned_add_overflows(a, b))
817 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
818 (uintmax_t)a, (uintmax_t)b);
819 return a + b;
821 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
822 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
824 static inline size_t st_mult(size_t a, size_t b)
826 if (unsigned_mult_overflows(a, b))
827 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
828 (uintmax_t)a, (uintmax_t)b);
829 return a * b;
832 static inline size_t st_sub(size_t a, size_t b)
834 if (a < b)
835 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
836 (uintmax_t)a, (uintmax_t)b);
837 return a - b;
840 #ifdef HAVE_ALLOCA_H
841 # include <alloca.h>
842 # define xalloca(size) (alloca(size))
843 # define xalloca_free(p) do {} while (0)
844 #else
845 # define xalloca(size) (xmalloc(size))
846 # define xalloca_free(p) (free(p))
847 #endif
848 char *xstrdup(const char *str);
849 void *xmalloc(size_t size);
850 void *xmallocz(size_t size);
851 void *xmallocz_gently(size_t size);
852 void *xmemdupz(const void *data, size_t len);
853 char *xstrndup(const char *str, size_t len);
854 void *xrealloc(void *ptr, size_t size);
855 void *xcalloc(size_t nmemb, size_t size);
856 void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
857 void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
858 int xopen(const char *path, int flags, ...);
859 ssize_t xread(int fd, void *buf, size_t len);
860 ssize_t xwrite(int fd, const void *buf, size_t len);
861 ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
862 int xdup(int fd);
863 FILE *xfopen(const char *path, const char *mode);
864 FILE *xfdopen(int fd, const char *mode);
865 int xmkstemp(char *temp_filename);
866 int xmkstemp_mode(char *temp_filename, int mode);
867 char *xgetcwd(void);
868 FILE *fopen_for_writing(const char *path);
869 FILE *fopen_or_warn(const char *path, const char *mode);
872 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
873 * that ptr is used twice, so don't pass e.g. ptr++.
875 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
877 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
878 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)));
879 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
881 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
882 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
883 static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
885 if (n)
886 memcpy(dst, src, st_mult(size, n));
889 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
890 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
891 static inline void move_array(void *dst, const void *src, size_t n, size_t size)
893 if (n)
894 memmove(dst, src, st_mult(size, n));
898 * These functions help you allocate structs with flex arrays, and copy
899 * the data directly into the array. For example, if you had:
901 * struct foo {
902 * int bar;
903 * char name[FLEX_ARRAY];
904 * };
906 * you can do:
908 * struct foo *f;
909 * FLEX_ALLOC_MEM(f, name, src, len);
911 * to allocate a "foo" with the contents of "src" in the "name" field.
912 * The resulting struct is automatically zero'd, and the flex-array field
913 * is NUL-terminated (whether the incoming src buffer was or not).
915 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
916 * but do want to store a pointer to some extra data in the same allocated
917 * block. For example, if you have:
919 * struct foo {
920 * char *name;
921 * int bar;
922 * };
924 * you can do:
926 * struct foo *f;
927 * FLEXPTR_ALLOC_STR(f, name, src);
929 * and "name" will point to a block of memory after the struct, which will be
930 * freed along with the struct (but the pointer can be repointed anywhere).
932 * The *_STR variants accept a string parameter rather than a ptr/len
933 * combination.
935 * Note that these macros will evaluate the first parameter multiple
936 * times, and it must be assignable as an lvalue.
938 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
939 size_t flex_array_len_ = (len); \
940 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
941 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
942 } while (0)
943 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
944 size_t flex_array_len_ = (len); \
945 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
946 memcpy((x) + 1, (buf), flex_array_len_); \
947 (x)->ptrname = (void *)((x)+1); \
948 } while(0)
949 #define FLEX_ALLOC_STR(x, flexname, str) \
950 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
951 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
952 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
954 static inline char *xstrdup_or_null(const char *str)
956 return str ? xstrdup(str) : NULL;
959 static inline size_t xsize_t(off_t len)
961 size_t size = (size_t) len;
963 if (len != (off_t) size)
964 die("Cannot handle files this big");
965 return size;
968 __attribute__((format (printf, 3, 4)))
969 int xsnprintf(char *dst, size_t max, const char *fmt, ...);
971 #ifndef HOST_NAME_MAX
972 #define HOST_NAME_MAX 256
973 #endif
975 int xgethostname(char *buf, size_t len);
977 /* in ctype.c, for kwset users */
978 extern const unsigned char tolower_trans_tbl[256];
980 /* Sane ctype - no locale, and works with signed chars */
981 #undef isascii
982 #undef isspace
983 #undef isdigit
984 #undef isalpha
985 #undef isalnum
986 #undef isprint
987 #undef islower
988 #undef isupper
989 #undef tolower
990 #undef toupper
991 #undef iscntrl
992 #undef ispunct
993 #undef isxdigit
995 extern const unsigned char sane_ctype[256];
996 #define GIT_SPACE 0x01
997 #define GIT_DIGIT 0x02
998 #define GIT_ALPHA 0x04
999 #define GIT_GLOB_SPECIAL 0x08
1000 #define GIT_REGEX_SPECIAL 0x10
1001 #define GIT_PATHSPEC_MAGIC 0x20
1002 #define GIT_CNTRL 0x40
1003 #define GIT_PUNCT 0x80
1004 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1005 #define isascii(x) (((x) & ~0x7f) == 0)
1006 #define isspace(x) sane_istest(x,GIT_SPACE)
1007 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1008 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1009 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1010 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1011 #define islower(x) sane_iscase(x, 1)
1012 #define isupper(x) sane_iscase(x, 0)
1013 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1014 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1015 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1016 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1017 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1018 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1019 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1020 #define toupper(x) sane_case((unsigned char)(x), 0)
1021 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1023 static inline int sane_case(int x, int high)
1025 if (sane_istest(x, GIT_ALPHA))
1026 x = (x & ~0x20) | high;
1027 return x;
1030 static inline int sane_iscase(int x, int is_lower)
1032 if (!sane_istest(x, GIT_ALPHA))
1033 return 0;
1035 if (is_lower)
1036 return (x & 0x20) != 0;
1037 else
1038 return (x & 0x20) == 0;
1042 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1043 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1044 * locale-specific conversions).
1046 static inline int skip_iprefix(const char *str, const char *prefix,
1047 const char **out)
1049 do {
1050 if (!*prefix) {
1051 *out = str;
1052 return 1;
1054 } while (tolower(*str++) == tolower(*prefix++));
1055 return 0;
1058 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1060 unsigned long ul;
1061 char *p;
1063 errno = 0;
1064 /* negative values would be accepted by strtoul */
1065 if (strchr(s, '-'))
1066 return -1;
1067 ul = strtoul(s, &p, base);
1068 if (errno || *p || p == s || (unsigned int) ul != ul)
1069 return -1;
1070 *result = ul;
1071 return 0;
1074 static inline int strtol_i(char const *s, int base, int *result)
1076 long ul;
1077 char *p;
1079 errno = 0;
1080 ul = strtol(s, &p, base);
1081 if (errno || *p || p == s || (int) ul != ul)
1082 return -1;
1083 *result = ul;
1084 return 0;
1087 void git_stable_qsort(void *base, size_t nmemb, size_t size,
1088 int(*compar)(const void *, const void *));
1089 #ifdef INTERNAL_QSORT
1090 #define qsort git_stable_qsort
1091 #endif
1093 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1094 static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1095 int(*compar)(const void *, const void *))
1097 if (nmemb > 1)
1098 qsort(base, nmemb, size, compar);
1101 #define STABLE_QSORT(base, n, compar) \
1102 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1104 #ifndef HAVE_ISO_QSORT_S
1105 int git_qsort_s(void *base, size_t nmemb, size_t size,
1106 int (*compar)(const void *, const void *, void *), void *ctx);
1107 #define qsort_s git_qsort_s
1108 #endif
1110 #define QSORT_S(base, n, compar, ctx) do { \
1111 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1112 BUG("qsort_s() failed"); \
1113 } while (0)
1115 #ifndef REG_STARTEND
1116 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1117 #endif
1119 static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1120 size_t nmatch, regmatch_t pmatch[], int eflags)
1122 assert(nmatch > 0 && pmatch);
1123 pmatch[0].rm_so = 0;
1124 pmatch[0].rm_eo = size;
1125 return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1128 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1129 # define FORCE_DIR_SET_GID S_ISGID
1130 #else
1131 # define FORCE_DIR_SET_GID 0
1132 #endif
1134 #ifdef NO_NSEC
1135 #undef USE_NSEC
1136 #define ST_CTIME_NSEC(st) 0
1137 #define ST_MTIME_NSEC(st) 0
1138 #else
1139 #ifdef USE_ST_TIMESPEC
1140 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1141 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1142 #else
1143 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1144 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1145 #endif
1146 #endif
1148 #ifdef UNRELIABLE_FSTAT
1149 #define fstat_is_reliable() 0
1150 #else
1151 #define fstat_is_reliable() 1
1152 #endif
1154 #ifndef va_copy
1156 * Since an obvious implementation of va_list would be to make it a
1157 * pointer into the stack frame, a simple assignment will work on
1158 * many systems. But let's try to be more portable.
1160 #ifdef __va_copy
1161 #define va_copy(dst, src) __va_copy(dst, src)
1162 #else
1163 #define va_copy(dst, src) ((dst) = (src))
1164 #endif
1165 #endif
1167 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
1168 #define HAVE_VARIADIC_MACROS 1
1169 #endif
1171 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1172 extern int BUG_exit_code;
1174 #ifdef HAVE_VARIADIC_MACROS
1175 __attribute__((format (printf, 3, 4))) NORETURN
1176 void BUG_fl(const char *file, int line, const char *fmt, ...);
1177 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1178 #else
1179 __attribute__((format (printf, 1, 2))) NORETURN
1180 void BUG(const char *fmt, ...);
1181 #endif
1184 * Preserves errno, prints a message, but gives no warning for ENOENT.
1185 * Returns 0 on success, which includes trying to unlink an object that does
1186 * not exist.
1188 int unlink_or_warn(const char *path);
1190 * Tries to unlink file. Returns 0 if unlink succeeded
1191 * or the file already didn't exist. Returns -1 and
1192 * appends a message to err suitable for
1193 * 'error("%s", err->buf)' on error.
1195 int unlink_or_msg(const char *file, struct strbuf *err);
1197 * Preserves errno, prints a message, but gives no warning for ENOENT.
1198 * Returns 0 on success, which includes trying to remove a directory that does
1199 * not exist.
1201 int rmdir_or_warn(const char *path);
1203 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1204 * the supplied file mode.
1206 int remove_or_warn(unsigned int mode, const char *path);
1209 * Call access(2), but warn for any error except "missing file"
1210 * (ENOENT or ENOTDIR).
1212 #define ACCESS_EACCES_OK (1U << 0)
1213 int access_or_warn(const char *path, int mode, unsigned flag);
1214 int access_or_die(const char *path, int mode, unsigned flag);
1216 /* Warn on an inaccessible file if errno indicates this is an error */
1217 int warn_on_fopen_errors(const char *path);
1219 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1220 #define USE_PARENS_AROUND_GETTEXT_N 1
1221 #endif
1223 #ifndef SHELL_PATH
1224 # define SHELL_PATH "/bin/sh"
1225 #endif
1227 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1228 #define flockfile(fh)
1229 #define funlockfile(fh)
1230 #define getc_unlocked(fh) getc(fh)
1231 #endif
1233 #ifdef FILENO_IS_A_MACRO
1234 int git_fileno(FILE *stream);
1235 # ifndef COMPAT_CODE_FILENO
1236 # undef fileno
1237 # define fileno(p) git_fileno(p)
1238 # endif
1239 #endif
1241 #ifdef NEED_ACCESS_ROOT_HANDLER
1242 int git_access(const char *path, int mode);
1243 # ifndef COMPAT_CODE_ACCESS
1244 # ifdef access
1245 # undef access
1246 # endif
1247 # define access(path, mode) git_access(path, mode)
1248 # endif
1249 #endif
1252 * Our code often opens a path to an optional file, to work on its
1253 * contents when we can successfully open it. We can ignore a failure
1254 * to open if such an optional file does not exist, but we do want to
1255 * report a failure in opening for other reasons (e.g. we got an I/O
1256 * error, or the file is there, but we lack the permission to open).
1258 * Call this function after seeing an error from open() or fopen() to
1259 * see if the errno indicates a missing file that we can safely ignore.
1261 static inline int is_missing_file_error(int errno_)
1263 return (errno_ == ENOENT || errno_ == ENOTDIR);
1266 int cmd_main(int, const char **);
1269 * Intercept all calls to exit() and route them to trace2 to
1270 * optionally emit a message before calling the real exit().
1272 int trace2_cmd_exit_fl(const char *file, int line, int code);
1273 #define exit(code) exit(trace2_cmd_exit_fl(__FILE__, __LINE__, (code)))
1276 * You can mark a stack variable with UNLEAK(var) to avoid it being
1277 * reported as a leak by tools like LSAN or valgrind. The argument
1278 * should generally be the variable itself (not its address and not what
1279 * it points to). It's safe to use this on pointers which may already
1280 * have been freed, or on pointers which may still be in use.
1282 * Use this _only_ for a variable that leaks by going out of scope at
1283 * program exit (so only from cmd_* functions or their direct helpers).
1284 * Normal functions, especially those which may be called multiple
1285 * times, should actually free their memory. This is only meant as
1286 * an annotation, and does nothing in non-leak-checking builds.
1288 #ifdef SUPPRESS_ANNOTATED_LEAKS
1289 void unleak_memory(const void *ptr, size_t len);
1290 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1291 #else
1292 #define UNLEAK(var) do {} while (0)
1293 #endif
1296 * This include must come after system headers, since it introduces macros that
1297 * replace system names.
1299 #include "banned.h"
1302 * container_of - Get the address of an object containing a field.
1304 * @ptr: pointer to the field.
1305 * @type: type of the object.
1306 * @member: name of the field within the object.
1308 #define container_of(ptr, type, member) \
1309 ((type *) ((char *)(ptr) - offsetof(type, member)))
1312 * helper function for `container_of_or_null' to avoid multiple
1313 * evaluation of @ptr
1315 static inline void *container_of_or_null_offset(void *ptr, size_t offset)
1317 return ptr ? (char *)ptr - offset : NULL;
1321 * like `container_of', but allows returned value to be NULL
1323 #define container_of_or_null(ptr, type, member) \
1324 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1327 * like offsetof(), but takes a pointer to a a variable of type which
1328 * contains @member, instead of a specified type.
1329 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1330 * everywhere.
1332 #if defined(__GNUC__) /* clang sets this, too */
1333 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1334 #else /* !__GNUC__ */
1335 #define OFFSETOF_VAR(ptr, member) \
1336 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1337 #endif /* !__GNUC__ */
1339 #endif