Merge branch 'rb/hpe'
[git.git] / git-compat-util.h
blob29a19902aaa00b90176e253c90c2384fca65857c
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).
10 * Use them like this:
11 * #if GIT_GNUC_PREREQ (2,8)
12 * ... code requiring gcc 2.8 or later ...
13 * #endif
15 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
16 # define GIT_GNUC_PREREQ(maj, min) \
17 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
18 #else
19 #define GIT_GNUC_PREREQ(maj, min) 0
20 #endif
23 #ifndef FLEX_ARRAY
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__)
30 # if (__GNUC__ >= 3)
31 # define FLEX_ARRAY /* empty */
32 # else
33 # define FLEX_ARRAY 0 /* older GNU extension */
34 # endif
35 #endif
38 * Otherwise, default to safer but a bit wasteful traditional style
40 #ifndef FLEX_ARRAY
41 # define FLEX_ARRAY 1
42 #endif
43 #endif
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".
53 * Example:
54 * #define foo_to_char(foo) \
55 * ((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])))
66 #else
67 # define BARF_UNLESS_AN_ARRAY(arr) 0
68 #endif
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))
107 #ifdef __GNUC__
108 #define TYPEOF(x) (__typeof__(x))
109 #else
110 #define TYPEOF(x)
111 #endif
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)
121 #if defined(__sun__)
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
131 # else
132 # define _XOPEN_SOURCE 500
133 # endif
134 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
135 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
136 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
137 !defined(__CYGWIN__)
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 */
140 #endif
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
151 # endif
152 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
153 #include <winsock2.h>
154 #include <windows.h>
155 #define GIT_WINDOWS_NATIVE
156 #endif
158 #include <unistd.h>
159 #include <stdio.h>
160 #include <sys/stat.h>
161 #include <fcntl.h>
162 #include <stddef.h>
163 #include <stdlib.h>
164 #include <stdarg.h>
165 #include <string.h>
166 #ifdef HAVE_STRINGS_H
167 #include <strings.h> /* for strcasecmp() */
168 #endif
169 #include <errno.h>
170 #include <limits.h>
171 #ifdef NEEDS_SYS_PARAM_H
172 #include <sys/param.h>
173 #endif
174 #include <sys/types.h>
175 #include <dirent.h>
176 #include <sys/time.h>
177 #include <time.h>
178 #include <signal.h>
179 #include <assert.h>
180 #include <regex.h>
181 #include <utime.h>
182 #include <syslog.h>
183 #if !defined(NO_POLL_H)
184 #include <poll.h>
185 #elif !defined(NO_SYS_POLL_H)
186 #include <sys/poll.h>
187 #else
188 /* Pull the compat stuff */
189 #include <poll.h>
190 #endif
191 #ifdef HAVE_BSD_SYSCTL
192 #include <sys/sysctl.h>
193 #endif
195 #if defined(__CYGWIN__)
196 #include "compat/win32/path-utils.h"
197 #endif
198 #if defined(__MINGW32__)
199 /* pull in Windows compatibility stuff */
200 #include "compat/win32/path-utils.h"
201 #include "compat/mingw.h"
202 #elif defined(_MSC_VER)
203 #include "compat/msvc.h"
204 #else
205 #include <sys/utsname.h>
206 #include <sys/wait.h>
207 #include <sys/resource.h>
208 #include <sys/socket.h>
209 #include <sys/ioctl.h>
210 #include <termios.h>
211 #ifndef NO_SYS_SELECT_H
212 #include <sys/select.h>
213 #endif
214 #include <netinet/in.h>
215 #include <netinet/tcp.h>
216 #include <arpa/inet.h>
217 #include <netdb.h>
218 #include <pwd.h>
219 #include <sys/un.h>
220 #ifndef NO_INTTYPES_H
221 #include <inttypes.h>
222 #else
223 #include <stdint.h>
224 #endif
225 #ifdef NO_INTPTR_T
227 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
228 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
229 * while on IP16 and IP16L32 it is "int" (resp. "short")
230 * Size needs to match (or exceed) 'sizeof(void *)'.
231 * We can't take "long long" here as not everybody has it.
233 typedef long intptr_t;
234 typedef unsigned long uintptr_t;
235 #endif
236 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
237 #include <grp.h>
238 #define _ALL_SOURCE 1
239 #endif
241 /* used on Mac OS X */
242 #ifdef PRECOMPOSE_UNICODE
243 #include "compat/precompose_utf8.h"
244 #else
245 #define precompose_str(in,i_nfd2nfc)
246 #define precompose_argv(c,v)
247 #define probe_utf8_pathname_composition()
248 #endif
250 #ifdef MKDIR_WO_TRAILING_SLASH
251 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
252 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
253 #endif
255 #ifdef NO_STRUCT_ITIMERVAL
256 struct itimerval {
257 struct timeval it_interval;
258 struct timeval it_value;
260 #endif
262 #ifdef NO_SETITIMER
263 #define setitimer(which,value,ovalue)
264 #endif
266 #ifndef NO_LIBGEN_H
267 #include <libgen.h>
268 #else
269 #define basename gitbasename
270 extern char *gitbasename(char *);
271 #define dirname gitdirname
272 extern char *gitdirname(char *);
273 #endif
275 #ifndef NO_ICONV
276 #include <iconv.h>
277 #endif
279 #ifndef NO_OPENSSL
280 #ifdef __APPLE__
281 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
282 #include <AvailabilityMacros.h>
283 #undef DEPRECATED_ATTRIBUTE
284 #define DEPRECATED_ATTRIBUTE
285 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
286 #endif
287 #include <openssl/ssl.h>
288 #include <openssl/err.h>
289 #endif
291 #ifdef HAVE_SYSINFO
292 # include <sys/sysinfo.h>
293 #endif
295 /* On most systems <netdb.h> would have given us this, but
296 * not on some systems (e.g. z/OS).
298 #ifndef NI_MAXHOST
299 #define NI_MAXHOST 1025
300 #endif
302 #ifndef NI_MAXSERV
303 #define NI_MAXSERV 32
304 #endif
306 /* On most systems <limits.h> would have given us this, but
307 * not on some systems (e.g. GNU/Hurd).
309 #ifndef PATH_MAX
310 #define PATH_MAX 4096
311 #endif
313 #ifndef PRIuMAX
314 #define PRIuMAX "llu"
315 #endif
317 #ifndef SCNuMAX
318 #define SCNuMAX PRIuMAX
319 #endif
321 #ifndef PRIu32
322 #define PRIu32 "u"
323 #endif
325 #ifndef PRIx32
326 #define PRIx32 "x"
327 #endif
329 #ifndef PRIo32
330 #define PRIo32 "o"
331 #endif
333 typedef uintmax_t timestamp_t;
334 #define PRItime PRIuMAX
335 #define parse_timestamp strtoumax
336 #define TIME_MAX UINTMAX_MAX
338 #ifndef PATH_SEP
339 #define PATH_SEP ':'
340 #endif
342 #ifdef HAVE_PATHS_H
343 #include <paths.h>
344 #endif
345 #ifndef _PATH_DEFPATH
346 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
347 #endif
349 #ifndef platform_core_config
350 static inline int noop_core_config(const char *var, const char *value, void *cb)
352 return 0;
354 #define platform_core_config noop_core_config
355 #endif
357 #ifndef has_dos_drive_prefix
358 static inline int git_has_dos_drive_prefix(const char *path)
360 return 0;
362 #define has_dos_drive_prefix git_has_dos_drive_prefix
363 #endif
365 #ifndef skip_dos_drive_prefix
366 static inline int git_skip_dos_drive_prefix(char **path)
368 return 0;
370 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
371 #endif
373 #ifndef is_dir_sep
374 static inline int git_is_dir_sep(int c)
376 return c == '/';
378 #define is_dir_sep git_is_dir_sep
379 #endif
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
387 #endif
389 #ifndef find_last_dir_sep
390 static inline char *git_find_last_dir_sep(const char *path)
392 return strrchr(path, '/');
394 #define find_last_dir_sep git_find_last_dir_sep
395 #endif
397 #ifndef query_user_email
398 #define query_user_email() NULL
399 #endif
401 #ifdef __TANDEM
402 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
403 #include <floss.h(floss_getpwuid)>
404 #ifndef NSIG
406 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
407 * known, by detective work using kill -l as a list is all signals
408 * instead of signal.h where it should be.
410 # define NSIG 100
411 #endif
412 #endif
414 #if defined(__HP_cc) && (__HP_cc >= 61000)
415 #define NORETURN __attribute__((noreturn))
416 #define NORETURN_PTR
417 #elif defined(__GNUC__) && !defined(NO_NORETURN)
418 #define NORETURN __attribute__((__noreturn__))
419 #define NORETURN_PTR __attribute__((__noreturn__))
420 #elif defined(_MSC_VER)
421 #define NORETURN __declspec(noreturn)
422 #define NORETURN_PTR
423 #else
424 #define NORETURN
425 #define NORETURN_PTR
426 #ifndef __GNUC__
427 #ifndef __attribute__
428 #define __attribute__(x)
429 #endif
430 #endif
431 #endif
433 /* The sentinel attribute is valid from gcc version 4.0 */
434 #if defined(__GNUC__) && (__GNUC__ >= 4)
435 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
436 #else
437 #define LAST_ARG_MUST_BE_NULL
438 #endif
440 #define MAYBE_UNUSED __attribute__((__unused__))
442 #include "compat/bswap.h"
444 #include "wildmatch.h"
446 struct strbuf;
448 /* General helper functions */
449 extern void vreportf(const char *prefix, const char *err, va_list params);
450 extern NORETURN void usage(const char *err);
451 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
452 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
453 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
454 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
455 extern int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
456 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
457 extern void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
459 #ifndef NO_OPENSSL
460 #ifdef APPLE_COMMON_CRYPTO
461 #include "compat/apple-common-crypto.h"
462 #else
463 #include <openssl/evp.h>
464 #include <openssl/hmac.h>
465 #endif /* APPLE_COMMON_CRYPTO */
466 #include <openssl/x509v3.h>
467 #endif /* NO_OPENSSL */
470 * Let callers be aware of the constant return value; this can help
471 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
472 * because some compilers may not support variadic macros. Since we're only
473 * trying to help gcc, anyway, it's OK; other compilers will fall back to
474 * using the function as usual.
476 #if defined(__GNUC__)
477 static inline int const_error(void)
479 return -1;
481 #define error(...) (error(__VA_ARGS__), const_error())
482 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
483 #endif
485 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
486 extern void set_error_routine(void (*routine)(const char *err, va_list params));
487 extern void (*get_error_routine(void))(const char *err, va_list params);
488 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
489 extern void (*get_warn_routine(void))(const char *warn, va_list params);
490 extern void set_die_is_recursing_routine(int (*routine)(void));
492 extern int starts_with(const char *str, const char *prefix);
493 extern int istarts_with(const char *str, const char *prefix);
496 * If the string "str" begins with the string found in "prefix", return 1.
497 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
498 * the string right after the prefix).
500 * Otherwise, return 0 and leave "out" untouched.
502 * Examples:
504 * [extract branch name, fail if not a branch]
505 * if (!skip_prefix(ref, "refs/heads/", &branch)
506 * return -1;
508 * [skip prefix if present, otherwise use whole string]
509 * skip_prefix(name, "refs/heads/", &name);
511 static inline int skip_prefix(const char *str, const char *prefix,
512 const char **out)
514 do {
515 if (!*prefix) {
516 *out = str;
517 return 1;
519 } while (*str++ == *prefix++);
520 return 0;
524 * If the string "str" is the same as the string in "prefix", then the "arg"
525 * parameter is set to the "def" parameter and 1 is returned.
526 * If the string "str" begins with the string found in "prefix" and then a
527 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
528 * (i.e., to the point in the string right after the prefix and the "=" sign),
529 * and 1 is returned.
531 * Otherwise, return 0 and leave "arg" untouched.
533 * When we accept both a "--key" and a "--key=<val>" option, this function
534 * can be used instead of !strcmp(arg, "--key") and then
535 * skip_prefix(arg, "--key=", &arg) to parse such an option.
537 int skip_to_optional_arg_default(const char *str, const char *prefix,
538 const char **arg, const char *def);
540 static inline int skip_to_optional_arg(const char *str, const char *prefix,
541 const char **arg)
543 return skip_to_optional_arg_default(str, prefix, arg, "");
547 * Like skip_prefix, but promises never to read past "len" bytes of the input
548 * buffer, and returns the remaining number of bytes in "out" via "outlen".
550 static inline int skip_prefix_mem(const char *buf, size_t len,
551 const char *prefix,
552 const char **out, size_t *outlen)
554 size_t prefix_len = strlen(prefix);
555 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
556 *out = buf + prefix_len;
557 *outlen = len - prefix_len;
558 return 1;
560 return 0;
564 * If buf ends with suffix, return 1 and subtract the length of the suffix
565 * from *len. Otherwise, return 0 and leave *len untouched.
567 static inline int strip_suffix_mem(const char *buf, size_t *len,
568 const char *suffix)
570 size_t suflen = strlen(suffix);
571 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
572 return 0;
573 *len -= suflen;
574 return 1;
578 * If str ends with suffix, return 1 and set *len to the size of the string
579 * without the suffix. Otherwise, return 0 and set *len to the size of the
580 * string.
582 * Note that we do _not_ NUL-terminate str to the new length.
584 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
586 *len = strlen(str);
587 return strip_suffix_mem(str, len, suffix);
590 static inline int ends_with(const char *str, const char *suffix)
592 size_t len;
593 return strip_suffix(str, suffix, &len);
596 #define SWAP(a, b) do { \
597 void *_swap_a_ptr = &(a); \
598 void *_swap_b_ptr = &(b); \
599 unsigned char _swap_buffer[sizeof(a)]; \
600 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
601 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
602 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
603 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
604 } while (0)
606 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
608 #ifndef PROT_READ
609 #define PROT_READ 1
610 #define PROT_WRITE 2
611 #define MAP_PRIVATE 1
612 #endif
614 #define mmap git_mmap
615 #define munmap git_munmap
616 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
617 extern int git_munmap(void *start, size_t length);
619 #else /* NO_MMAP || USE_WIN32_MMAP */
621 #include <sys/mman.h>
623 #endif /* NO_MMAP || USE_WIN32_MMAP */
625 #ifdef NO_MMAP
627 /* This value must be multiple of (pagesize * 2) */
628 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
630 #else /* NO_MMAP */
632 /* This value must be multiple of (pagesize * 2) */
633 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
634 (sizeof(void*) >= 8 \
635 ? 1 * 1024 * 1024 * 1024 \
636 : 32 * 1024 * 1024)
638 #endif /* NO_MMAP */
640 #ifndef MAP_FAILED
641 #define MAP_FAILED ((void *)-1)
642 #endif
644 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
645 #define on_disk_bytes(st) ((st).st_size)
646 #else
647 #define on_disk_bytes(st) ((st).st_blocks * 512)
648 #endif
650 #ifdef NEEDS_MODE_TRANSLATION
651 #undef S_IFMT
652 #undef S_IFREG
653 #undef S_IFDIR
654 #undef S_IFLNK
655 #undef S_IFBLK
656 #undef S_IFCHR
657 #undef S_IFIFO
658 #undef S_IFSOCK
659 #define S_IFMT 0170000
660 #define S_IFREG 0100000
661 #define S_IFDIR 0040000
662 #define S_IFLNK 0120000
663 #define S_IFBLK 0060000
664 #define S_IFCHR 0020000
665 #define S_IFIFO 0010000
666 #define S_IFSOCK 0140000
667 #ifdef stat
668 #undef stat
669 #endif
670 #define stat(path, buf) git_stat(path, buf)
671 extern int git_stat(const char *, struct stat *);
672 #ifdef fstat
673 #undef fstat
674 #endif
675 #define fstat(fd, buf) git_fstat(fd, buf)
676 extern int git_fstat(int, struct stat *);
677 #ifdef lstat
678 #undef lstat
679 #endif
680 #define lstat(path, buf) git_lstat(path, buf)
681 extern int git_lstat(const char *, struct stat *);
682 #endif
684 #define DEFAULT_PACKED_GIT_LIMIT \
685 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
687 #ifdef NO_PREAD
688 #define pread git_pread
689 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
690 #endif
692 * Forward decl that will remind us if its twin in cache.h changes.
693 * This function is used in compat/pread.c. But we can't include
694 * cache.h there.
696 extern ssize_t read_in_full(int fd, void *buf, size_t count);
698 #ifdef NO_SETENV
699 #define setenv gitsetenv
700 extern int gitsetenv(const char *, const char *, int);
701 #endif
703 #ifdef NO_MKDTEMP
704 #define mkdtemp gitmkdtemp
705 extern char *gitmkdtemp(char *);
706 #endif
708 #ifdef NO_UNSETENV
709 #define unsetenv gitunsetenv
710 extern void gitunsetenv(const char *);
711 #endif
713 #ifdef NO_STRCASESTR
714 #define strcasestr gitstrcasestr
715 extern char *gitstrcasestr(const char *haystack, const char *needle);
716 #endif
718 #ifdef NO_STRLCPY
719 #define strlcpy gitstrlcpy
720 extern size_t gitstrlcpy(char *, const char *, size_t);
721 #endif
723 #ifdef NO_STRTOUMAX
724 #define strtoumax gitstrtoumax
725 extern uintmax_t gitstrtoumax(const char *, char **, int);
726 #define strtoimax gitstrtoimax
727 extern intmax_t gitstrtoimax(const char *, char **, int);
728 #endif
730 #ifdef NO_HSTRERROR
731 #define hstrerror githstrerror
732 extern const char *githstrerror(int herror);
733 #endif
735 #ifdef NO_MEMMEM
736 #define memmem gitmemmem
737 void *gitmemmem(const void *haystack, size_t haystacklen,
738 const void *needle, size_t needlelen);
739 #endif
741 #ifdef OVERRIDE_STRDUP
742 #ifdef strdup
743 #undef strdup
744 #endif
745 #define strdup gitstrdup
746 char *gitstrdup(const char *s);
747 #endif
749 #ifdef NO_GETPAGESIZE
750 #define getpagesize() sysconf(_SC_PAGESIZE)
751 #endif
753 #ifndef O_CLOEXEC
754 #define O_CLOEXEC 0
755 #endif
757 #ifdef FREAD_READS_DIRECTORIES
758 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
759 # ifdef fopen
760 # undef fopen
761 # endif
762 # define fopen(a,b) git_fopen(a,b)
763 # endif
764 extern FILE *git_fopen(const char*, const char*);
765 #endif
767 #ifdef SNPRINTF_RETURNS_BOGUS
768 #ifdef snprintf
769 #undef snprintf
770 #endif
771 #define snprintf git_snprintf
772 extern int git_snprintf(char *str, size_t maxsize,
773 const char *format, ...);
774 #ifdef vsnprintf
775 #undef vsnprintf
776 #endif
777 #define vsnprintf git_vsnprintf
778 extern int git_vsnprintf(char *str, size_t maxsize,
779 const char *format, va_list ap);
780 #endif
782 #ifdef __GLIBC_PREREQ
783 #if __GLIBC_PREREQ(2, 1)
784 #define HAVE_STRCHRNUL
785 #endif
786 #endif
788 #ifndef HAVE_STRCHRNUL
789 #define strchrnul gitstrchrnul
790 static inline char *gitstrchrnul(const char *s, int c)
792 while (*s && *s != c)
793 s++;
794 return (char *)s;
796 #endif
798 #ifdef NO_INET_PTON
799 int inet_pton(int af, const char *src, void *dst);
800 #endif
802 #ifdef NO_INET_NTOP
803 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
804 #endif
806 #ifdef NO_PTHREADS
807 #define atexit git_atexit
808 extern int git_atexit(void (*handler)(void));
809 #endif
811 typedef void (*try_to_free_t)(size_t);
812 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
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 extern char *xstrdup(const char *str);
849 extern void *xmalloc(size_t size);
850 extern void *xmallocz(size_t size);
851 extern void *xmallocz_gently(size_t size);
852 extern void *xmemdupz(const void *data, size_t len);
853 extern char *xstrndup(const char *str, size_t len);
854 extern void *xrealloc(void *ptr, size_t size);
855 extern void *xcalloc(size_t nmemb, size_t size);
856 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
857 extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
858 extern int xopen(const char *path, int flags, ...);
859 extern ssize_t xread(int fd, void *buf, size_t len);
860 extern ssize_t xwrite(int fd, const void *buf, size_t len);
861 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
862 extern int xdup(int fd);
863 extern FILE *xfopen(const char *path, const char *mode);
864 extern FILE *xfdopen(int fd, const char *mode);
865 extern int xmkstemp(char *temp_filename);
866 extern int xmkstemp_mode(char *temp_filename, int mode);
867 extern char *xgetcwd(void);
868 extern FILE *fopen_for_writing(const char *path);
869 extern 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 extern int xsnprintf(char *dst, size_t max, const char *fmt, ...);
971 #ifndef HOST_NAME_MAX
972 #define HOST_NAME_MAX 256
973 #endif
975 extern 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 #ifdef INTERNAL_QSORT
1088 void git_qsort(void *base, size_t nmemb, size_t size,
1089 int(*compar)(const void *, const void *));
1090 #define qsort git_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 #ifndef HAVE_ISO_QSORT_S
1102 int git_qsort_s(void *base, size_t nmemb, size_t size,
1103 int (*compar)(const void *, const void *, void *), void *ctx);
1104 #define qsort_s git_qsort_s
1105 #endif
1107 #define QSORT_S(base, n, compar, ctx) do { \
1108 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1109 BUG("qsort_s() failed"); \
1110 } while (0)
1112 #ifndef REG_STARTEND
1113 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1114 #endif
1116 static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1117 size_t nmatch, regmatch_t pmatch[], int eflags)
1119 assert(nmatch > 0 && pmatch);
1120 pmatch[0].rm_so = 0;
1121 pmatch[0].rm_eo = size;
1122 return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1125 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1126 # define FORCE_DIR_SET_GID S_ISGID
1127 #else
1128 # define FORCE_DIR_SET_GID 0
1129 #endif
1131 #ifdef NO_NSEC
1132 #undef USE_NSEC
1133 #define ST_CTIME_NSEC(st) 0
1134 #define ST_MTIME_NSEC(st) 0
1135 #else
1136 #ifdef USE_ST_TIMESPEC
1137 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1138 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1139 #else
1140 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1141 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1142 #endif
1143 #endif
1145 #ifdef UNRELIABLE_FSTAT
1146 #define fstat_is_reliable() 0
1147 #else
1148 #define fstat_is_reliable() 1
1149 #endif
1151 #ifndef va_copy
1153 * Since an obvious implementation of va_list would be to make it a
1154 * pointer into the stack frame, a simple assignment will work on
1155 * many systems. But let's try to be more portable.
1157 #ifdef __va_copy
1158 #define va_copy(dst, src) __va_copy(dst, src)
1159 #else
1160 #define va_copy(dst, src) ((dst) = (src))
1161 #endif
1162 #endif
1164 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
1165 #define HAVE_VARIADIC_MACROS 1
1166 #endif
1168 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1169 extern int BUG_exit_code;
1171 #ifdef HAVE_VARIADIC_MACROS
1172 __attribute__((format (printf, 3, 4))) NORETURN
1173 void BUG_fl(const char *file, int line, const char *fmt, ...);
1174 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1175 #else
1176 __attribute__((format (printf, 1, 2))) NORETURN
1177 void BUG(const char *fmt, ...);
1178 #endif
1181 * Preserves errno, prints a message, but gives no warning for ENOENT.
1182 * Returns 0 on success, which includes trying to unlink an object that does
1183 * not exist.
1185 int unlink_or_warn(const char *path);
1187 * Tries to unlink file. Returns 0 if unlink succeeded
1188 * or the file already didn't exist. Returns -1 and
1189 * appends a message to err suitable for
1190 * 'error("%s", err->buf)' on error.
1192 int unlink_or_msg(const char *file, struct strbuf *err);
1194 * Preserves errno, prints a message, but gives no warning for ENOENT.
1195 * Returns 0 on success, which includes trying to remove a directory that does
1196 * not exist.
1198 int rmdir_or_warn(const char *path);
1200 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1201 * the supplied file mode.
1203 int remove_or_warn(unsigned int mode, const char *path);
1206 * Call access(2), but warn for any error except "missing file"
1207 * (ENOENT or ENOTDIR).
1209 #define ACCESS_EACCES_OK (1U << 0)
1210 int access_or_warn(const char *path, int mode, unsigned flag);
1211 int access_or_die(const char *path, int mode, unsigned flag);
1213 /* Warn on an inaccessible file if errno indicates this is an error */
1214 int warn_on_fopen_errors(const char *path);
1216 #ifdef GMTIME_UNRELIABLE_ERRORS
1217 struct tm *git_gmtime(const time_t *);
1218 struct tm *git_gmtime_r(const time_t *, struct tm *);
1219 #define gmtime git_gmtime
1220 #define gmtime_r git_gmtime_r
1221 #endif
1223 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1224 #define USE_PARENS_AROUND_GETTEXT_N 1
1225 #endif
1227 #ifndef SHELL_PATH
1228 # define SHELL_PATH "/bin/sh"
1229 #endif
1231 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1232 #define flockfile(fh)
1233 #define funlockfile(fh)
1234 #define getc_unlocked(fh) getc(fh)
1235 #endif
1238 * Our code often opens a path to an optional file, to work on its
1239 * contents when we can successfully open it. We can ignore a failure
1240 * to open if such an optional file does not exist, but we do want to
1241 * report a failure in opening for other reasons (e.g. we got an I/O
1242 * error, or the file is there, but we lack the permission to open).
1244 * Call this function after seeing an error from open() or fopen() to
1245 * see if the errno indicates a missing file that we can safely ignore.
1247 static inline int is_missing_file_error(int errno_)
1249 return (errno_ == ENOENT || errno_ == ENOTDIR);
1252 extern int cmd_main(int, const char **);
1255 * You can mark a stack variable with UNLEAK(var) to avoid it being
1256 * reported as a leak by tools like LSAN or valgrind. The argument
1257 * should generally be the variable itself (not its address and not what
1258 * it points to). It's safe to use this on pointers which may already
1259 * have been freed, or on pointers which may still be in use.
1261 * Use this _only_ for a variable that leaks by going out of scope at
1262 * program exit (so only from cmd_* functions or their direct helpers).
1263 * Normal functions, especially those which may be called multiple
1264 * times, should actually free their memory. This is only meant as
1265 * an annotation, and does nothing in non-leak-checking builds.
1267 #ifdef SUPPRESS_ANNOTATED_LEAKS
1268 extern void unleak_memory(const void *ptr, size_t len);
1269 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1270 #else
1271 #define UNLEAK(var) do {} while (0)
1272 #endif
1275 * This include must come after system headers, since it introduces macros that
1276 * replace system names.
1278 #include "banned.h"
1280 #endif