Merge branch 'bc/hash-independent-tests-part-5'
[git/git.git] / git-compat-util.h
CommitLineData
4050c0df
JH
1#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
556702f8
JH
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
12
b97e9116
MW
13#define _FILE_OFFSET_BITS 64
14
89c855ed
EP
15
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
23*/
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
30
31
8f1d2e6f 32#ifndef FLEX_ARRAY
8e973991
JH
33/*
34 * See if our compiler is known to support flexible array members.
35 */
203ee91f 36#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
8e973991
JH
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
45
46/*
47 * Otherwise, default to safer but a bit wasteful traditional style
48 */
49#ifndef FLEX_ARRAY
50# define FLEX_ARRAY 1
8f1d2e6f
JH
51#endif
52#endif
53
89c855ed
EP
54
55/*
56 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
57 * @cond: the compile-time condition which must be true.
58 *
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".
61 *
62 * Example:
63 * #define foo_to_char(foo) \
64 * ((char *)(foo) \
65 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
66 */
67#define BUILD_ASSERT_OR_ZERO(cond) \
68 (sizeof(char [1 - 2*!(cond)]) - 1)
69
e2c6f7cd 70#if GIT_GNUC_PREREQ(3, 1)
89c855ed
EP
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])))
e2c6f7cd
CB
75#else
76# define BARF_UNLESS_AN_ARRAY(arr) 0
89c855ed
EP
77#endif
78/*
79 * ARRAY_SIZE - get the number of elements in a visible array
80 * <at> x: the array whose size you want.
81 *
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).
85 */
86#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
87
f630cfda 88#define bitsizeof(x) (CHAR_BIT * sizeof(x))
b4f2a6ac 89
c03c8315
EFL
90#define maximum_signed_value_of_type(a) \
91 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
92
1368f650
JN
93#define maximum_unsigned_value_of_type(a) \
94 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
95
c03c8315
EFL
96/*
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.
99 *
100 * Requires: a >= 0, typeof(a) equals typeof(b)
101 */
102#define signed_add_overflows(a, b) \
103 ((b) > maximum_signed_value_of_type(a) - (a))
104
1368f650
JN
105#define unsigned_add_overflows(a, b) \
106 ((b) > maximum_unsigned_value_of_type(a) - (a))
107
320d0b49
JK
108/*
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!
112 */
113#define unsigned_mult_overflows(a, b) \
114 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
115
8723f216
NP
116#ifdef __GNUC__
117#define TYPEOF(x) (__typeof__(x))
118#else
119#define TYPEOF(x)
120#endif
121
f630cfda 122#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
db7244bd 123#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216 124
98cb6f30
PH
125#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
126
cf606e3d
AW
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)
129
4cb18a49
BC
130#if defined(__sun__)
131 /*
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.
137 */
138# if __STDC_VERSION__ - 0 >= 199901L
139# define _XOPEN_SOURCE 600
140# else
141# define _XOPEN_SOURCE 500
142# endif
6555b196 143#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
6c109904 144 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
3a0a3a89
RJ
145 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
146 !defined(__CYGWIN__)
85023577
JH
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 */
c902c9a6 149#endif
fb952206
JR
150#define _ALL_SOURCE 1
151#define _GNU_SOURCE 1
152#define _BSD_SOURCE 1
f978a99f 153#define _DEFAULT_SOURCE 1
9a695fbf 154#define _NETBSD_SOURCE 1
9398b859 155#define _SGI_SOURCE 1
85023577 156
380395d0 157#if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
3571e78a 158# if !defined(_WIN32_WINNT)
2939a1f7 159# define _WIN32_WINNT 0x0600
41f29991 160# endif
435bdf8c
MSO
161#define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
162#include <winsock2.h>
163#include <windows.h>
380395d0 164#define GIT_WINDOWS_NATIVE
435bdf8c
MSO
165#endif
166
4050c0df
JH
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>
b3e103da 175#ifdef HAVE_STRINGS_H
6c109904
JS
176#include <strings.h> /* for strcasecmp() */
177#endif
4050c0df
JH
178#include <errno.h>
179#include <limits.h>
b2d05e06 180#ifdef NEEDS_SYS_PARAM_H
4050c0df 181#include <sys/param.h>
6ede7205 182#endif
4050c0df
JH
183#include <sys/types.h>
184#include <dirent.h>
85023577
JH
185#include <sys/time.h>
186#include <time.h>
187#include <signal.h>
f4626df5
JS
188#include <assert.h>
189#include <regex.h>
190#include <utime.h>
088d8802 191#include <syslog.h>
2648ccc2
ĐTCD
192#if !defined(NO_POLL_H)
193#include <poll.h>
194#elif !defined(NO_SYS_POLL_H)
fdc12114 195#include <sys/poll.h>
2844923d 196#else
2648ccc2 197/* Pull the compat stuff */
2844923d
MD
198#include <poll.h>
199#endif
9529080d
KM
200#ifdef HAVE_BSD_SYSCTL
201#include <sys/sysctl.h>
202#endif
2f0aaaf9 203
496f2569 204#if defined(__CYGWIN__)
1cadad6f 205#include "compat/win32/path-utils.h"
496f2569 206#endif
cfc755d3
VR
207#if defined(__MINGW32__)
208/* pull in Windows compatibility stuff */
1cadad6f 209#include "compat/win32/path-utils.h"
cfc755d3
VR
210#include "compat/mingw.h"
211#elif defined(_MSC_VER)
22c3634c 212#include "compat/win32/path-utils.h"
cfc755d3
VR
213#include "compat/msvc.h"
214#else
1e8fef60 215#include <sys/utsname.h>
f4626df5 216#include <sys/wait.h>
ebae9ff9 217#include <sys/resource.h>
85023577 218#include <sys/socket.h>
80bbe72b 219#include <sys/ioctl.h>
eb80042c 220#include <termios.h>
2600973f 221#ifndef NO_SYS_SELECT_H
80bbe72b 222#include <sys/select.h>
2600973f 223#endif
85023577
JH
224#include <netinet/in.h>
225#include <netinet/tcp.h>
226#include <arpa/inet.h>
227#include <netdb.h>
228#include <pwd.h>
e2770979 229#include <sys/un.h>
2844923d 230#ifndef NO_INTTYPES_H
007e2ba6 231#include <inttypes.h>
2844923d
MD
232#else
233#include <stdint.h>
234#endif
6c109904
JS
235#ifdef NO_INTPTR_T
236/*
c70e1b04 237 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
6c109904
JS
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.
242 */
243typedef long intptr_t;
244typedef unsigned long uintptr_t;
245#endif
fb952206 246#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 247#include <grp.h>
fb952206 248#define _ALL_SOURCE 1
41b20017 249#endif
85023577 250
76759c7d
TB
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)
fdf72966 257#define probe_utf8_pathname_composition()
76759c7d
TB
258#endif
259
0539ecfd
JS
260#ifdef MKDIR_WO_TRAILING_SLASH
261#define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
55454427 262int compat_mkdir_wo_trailing_slash(const char*, mode_t);
0539ecfd
JS
263#endif
264
7f9e848c
JS
265#ifdef NO_STRUCT_ITIMERVAL
266struct itimerval {
267 struct timeval it_interval;
268 struct timeval it_value;
981ff520 269};
7f9e848c
JS
270#endif
271
272#ifdef NO_SETITIMER
273#define setitimer(which,value,ovalue)
274#endif
275
e1c06886
DA
276#ifndef NO_LIBGEN_H
277#include <libgen.h>
278#else
279#define basename gitbasename
55454427 280char *gitbasename(char *);
824682ab 281#define dirname gitdirname
55454427 282char *gitdirname(char *);
e1c06886
DA
283#endif
284
85023577
JH
285#ifndef NO_ICONV
286#include <iconv.h>
287#endif
4050c0df 288
684ec6c6 289#ifndef NO_OPENSSL
88c03eb5 290#ifdef __APPLE__
b195aa00 291#define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
88c03eb5
KM
292#include <AvailabilityMacros.h>
293#undef DEPRECATED_ATTRIBUTE
294#define DEPRECATED_ATTRIBUTE
295#undef __AVAILABILITY_MACROS_USES_AVAILABILITY
296#endif
684ec6c6
RS
297#include <openssl/ssl.h>
298#include <openssl/err.h>
299#endif
300
9806f5a7
NTND
301#ifdef HAVE_SYSINFO
302# include <sys/sysinfo.h>
303#endif
304
3b130ade
DM
305/* On most systems <netdb.h> would have given us this, but
306 * not on some systems (e.g. z/OS).
307 */
308#ifndef NI_MAXHOST
309#define NI_MAXHOST 1025
310#endif
311
312#ifndef NI_MAXSERV
313#define NI_MAXSERV 32
314#endif
315
d0c2449f
JH
316/* On most systems <limits.h> would have given us this, but
317 * not on some systems (e.g. GNU/Hurd).
318 */
319#ifndef PATH_MAX
320#define PATH_MAX 4096
321#endif
322
c4001d92
SP
323#ifndef PRIuMAX
324#define PRIuMAX "llu"
325#endif
326
fdcdb778
WM
327#ifndef SCNuMAX
328#define SCNuMAX PRIuMAX
329#endif
330
607bb3ff
JS
331#ifndef PRIu32
332#define PRIu32 "u"
333#endif
334
335#ifndef PRIx32
336#define PRIx32 "x"
337#endif
338
5418d96d
RJ
339#ifndef PRIo32
340#define PRIo32 "o"
341#endif
342
28f4aee3
JS
343typedef uintmax_t timestamp_t;
344#define PRItime PRIuMAX
345#define parse_timestamp strtoumax
346#define TIME_MAX UINTMAX_MAX
1aeb7e75 347
80ba074f
JS
348#ifndef PATH_SEP
349#define PATH_SEP ':'
350#endif
351
cb6a22c0
CW
352#ifdef HAVE_PATHS_H
353#include <paths.h>
354#endif
355#ifndef _PATH_DEFPATH
356#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
357#endif
358
70fc5793
JS
359#ifndef platform_core_config
360static inline int noop_core_config(const char *var, const char *value, void *cb)
361{
362 return 0;
363}
364#define platform_core_config noop_core_config
365#endif
366
25fe217b 367#ifndef has_dos_drive_prefix
bf728346
RS
368static inline int git_has_dos_drive_prefix(const char *path)
369{
370 return 0;
371}
372#define has_dos_drive_prefix git_has_dos_drive_prefix
25fe217b
JS
373#endif
374
2f36eed9
JS
375#ifndef skip_dos_drive_prefix
376static inline int git_skip_dos_drive_prefix(char **path)
377{
378 return 0;
379}
380#define skip_dos_drive_prefix git_skip_dos_drive_prefix
381#endif
382
bf728346
RS
383#ifndef is_dir_sep
384static inline int git_is_dir_sep(int c)
385{
386 return c == '/';
387}
388#define is_dir_sep git_is_dir_sep
c2369bdf
CZ
389#endif
390
bf728346
RS
391#ifndef offset_1st_component
392static inline int git_offset_1st_component(const char *path)
393{
394 return is_dir_sep(path[0]);
395}
396#define offset_1st_component git_offset_1st_component
25fe217b
JS
397#endif
398
d1c69255 399#ifndef find_last_dir_sep
bf728346
RS
400static inline char *git_find_last_dir_sep(const char *path)
401{
402 return strrchr(path, '/');
403}
404#define find_last_dir_sep git_find_last_dir_sep
d1c69255
TN
405#endif
406
501afcb8
JS
407#ifndef query_user_email
408#define query_user_email() NULL
409#endif
410
1305ef37
RB
411#ifdef __TANDEM
412#include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
413#include <floss.h(floss_getpwuid)>
414#ifndef NSIG
415/*
416 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
417 * known, by detective work using kill -l as a list is all signals
418 * instead of signal.h where it should be.
419 */
420# define NSIG 100
421#endif
422#endif
423
e4ac953b 424#if defined(__HP_cc) && (__HP_cc >= 61000)
b6ab349b
MR
425#define NORETURN __attribute__((noreturn))
426#define NORETURN_PTR
6520c846 427#elif defined(__GNUC__) && !defined(NO_NORETURN)
4050c0df 428#define NORETURN __attribute__((__noreturn__))
18660bc9 429#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8
RJ
430#elif defined(_MSC_VER)
431#define NORETURN __declspec(noreturn)
432#define NORETURN_PTR
4050c0df
JH
433#else
434#define NORETURN
18660bc9 435#define NORETURN_PTR
8cd7ebc8 436#ifndef __GNUC__
4050c0df
JH
437#ifndef __attribute__
438#define __attribute__(x)
439#endif
440#endif
8cd7ebc8 441#endif
4050c0df 442
9fe3edc4
RJ
443/* The sentinel attribute is valid from gcc version 4.0 */
444#if defined(__GNUC__) && (__GNUC__ >= 4)
445#define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
446#else
447#define LAST_ARG_MUST_BE_NULL
448#endif
449
bbd8eb3e
CMAB
450#define MAYBE_UNUSED __attribute__((__unused__))
451
51ea5519
NP
452#include "compat/bswap.h"
453
cebcab18 454#include "wildmatch.h"
cebcab18 455
9ccc0c08
RS
456struct strbuf;
457
4050c0df 458/* General helper functions */
55454427
DL
459void vreportf(const char *prefix, const char *err, va_list params);
460NORETURN void usage(const char *err);
b199d714
DL
461NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
462NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
463NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
464int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
465int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
466void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
467void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 468
f2be034c
BG
469#ifndef NO_OPENSSL
470#ifdef APPLE_COMMON_CRYPTO
471#include "compat/apple-common-crypto.h"
472#else
473#include <openssl/evp.h>
474#include <openssl/hmac.h>
475#endif /* APPLE_COMMON_CRYPTO */
476#include <openssl/x509v3.h>
477#endif /* NO_OPENSSL */
478
e208f9cc
JK
479/*
480 * Let callers be aware of the constant return value; this can help
9798f7e5
MK
481 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
482 * because some compilers may not support variadic macros. Since we're only
483 * trying to help gcc, anyway, it's OK; other compilers will fall back to
484 * using the function as usual.
e208f9cc 485 */
ff0a80af 486#if defined(__GNUC__)
87fe5df3
JK
487static inline int const_error(void)
488{
489 return -1;
490}
491#define error(...) (error(__VA_ARGS__), const_error())
4df5e918 492#define error_errno(...) (error_errno(__VA_ARGS__), const_error())
e208f9cc
JK
493#endif
494
55454427
DL
495void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
496void set_error_routine(void (*routine)(const char *err, va_list params));
725149be 497extern void (*get_error_routine(void))(const char *err, va_list params);
55454427 498void set_warn_routine(void (*routine)(const char *warn, va_list params));
725149be 499extern void (*get_warn_routine(void))(const char *warn, va_list params);
55454427 500void set_die_is_recursing_routine(int (*routine)(void));
39a3f5ea 501
55454427
DL
502int starts_with(const char *str, const char *prefix);
503int istarts_with(const char *str, const char *prefix);
698a68be 504
cf4fff57
JK
505/*
506 * If the string "str" begins with the string found in "prefix", return 1.
507 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
508 * the string right after the prefix).
509 *
510 * Otherwise, return 0 and leave "out" untouched.
511 *
512 * Examples:
513 *
514 * [extract branch name, fail if not a branch]
515 * if (!skip_prefix(ref, "refs/heads/", &branch)
516 * return -1;
517 *
518 * [skip prefix if present, otherwise use whole string]
519 * skip_prefix(name, "refs/heads/", &name);
520 */
521static inline int skip_prefix(const char *str, const char *prefix,
522 const char **out)
fbca5837 523{
ba399c46 524 do {
cf4fff57
JK
525 if (!*prefix) {
526 *out = str;
527 return 1;
528 }
ba399c46 529 } while (*str++ == *prefix++);
cf4fff57 530 return 0;
fbca5837
MV
531}
532
afaef55e
CC
533/*
534 * If the string "str" is the same as the string in "prefix", then the "arg"
535 * parameter is set to the "def" parameter and 1 is returned.
536 * If the string "str" begins with the string found in "prefix" and then a
537 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
538 * (i.e., to the point in the string right after the prefix and the "=" sign),
539 * and 1 is returned.
540 *
541 * Otherwise, return 0 and leave "arg" untouched.
542 *
543 * When we accept both a "--key" and a "--key=<val>" option, this function
544 * can be used instead of !strcmp(arg, "--key") and then
545 * skip_prefix(arg, "--key=", &arg) to parse such an option.
546 */
547int skip_to_optional_arg_default(const char *str, const char *prefix,
548 const char **arg, const char *def);
549
550static inline int skip_to_optional_arg(const char *str, const char *prefix,
551 const char **arg)
552{
553 return skip_to_optional_arg_default(str, prefix, arg, "");
554}
555
ae989a61
JK
556/*
557 * Like skip_prefix, but promises never to read past "len" bytes of the input
558 * buffer, and returns the remaining number of bytes in "out" via "outlen".
559 */
560static inline int skip_prefix_mem(const char *buf, size_t len,
561 const char *prefix,
562 const char **out, size_t *outlen)
563{
564 size_t prefix_len = strlen(prefix);
565 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
566 *out = buf + prefix_len;
567 *outlen = len - prefix_len;
568 return 1;
569 }
570 return 0;
571}
572
35480f0b
JK
573/*
574 * If buf ends with suffix, return 1 and subtract the length of the suffix
575 * from *len. Otherwise, return 0 and leave *len untouched.
576 */
577static inline int strip_suffix_mem(const char *buf, size_t *len,
578 const char *suffix)
579{
580 size_t suflen = strlen(suffix);
581 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
582 return 0;
583 *len -= suflen;
584 return 1;
585}
586
587/*
588 * If str ends with suffix, return 1 and set *len to the size of the string
589 * without the suffix. Otherwise, return 0 and set *len to the size of the
590 * string.
591 *
592 * Note that we do _not_ NUL-terminate str to the new length.
593 */
594static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
595{
596 *len = strlen(str);
597 return strip_suffix_mem(str, len, suffix);
598}
599
f52a35fd
JK
600static inline int ends_with(const char *str, const char *suffix)
601{
602 size_t len;
603 return strip_suffix(str, suffix, &len);
604}
605
568edcb9
RS
606#define SWAP(a, b) do { \
607 void *_swap_a_ptr = &(a); \
608 void *_swap_b_ptr = &(b); \
609 unsigned char _swap_buffer[sizeof(a)]; \
610 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
611 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
612 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
613 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
614} while (0)
615
b130a72b 616#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
617
618#ifndef PROT_READ
619#define PROT_READ 1
620#define PROT_WRITE 2
621#define MAP_PRIVATE 1
4050c0df
JH
622#endif
623
d6779124
SP
624#define mmap git_mmap
625#define munmap git_munmap
55454427
DL
626void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
627int git_munmap(void *start, size_t length);
4050c0df 628
b130a72b
JL
629#else /* NO_MMAP || USE_WIN32_MMAP */
630
631#include <sys/mman.h>
632
633#endif /* NO_MMAP || USE_WIN32_MMAP */
634
635#ifdef NO_MMAP
636
5faaf246 637/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
638#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
639
4050c0df
JH
640#else /* NO_MMAP */
641
5faaf246 642/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
643#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
644 (sizeof(void*) >= 8 \
645 ? 1 * 1024 * 1024 * 1024 \
646 : 32 * 1024 * 1024)
4050c0df
JH
647
648#endif /* NO_MMAP */
649
fcf3a21a
GV
650#ifndef MAP_FAILED
651#define MAP_FAILED ((void *)-1)
652#endif
653
fdb2a2a6
JH
654#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
655#define on_disk_bytes(st) ((st).st_size)
656#else
657#define on_disk_bytes(st) ((st).st_blocks * 512)
658#endif
659
d543d9c0
DM
660#ifdef NEEDS_MODE_TRANSLATION
661#undef S_IFMT
662#undef S_IFREG
663#undef S_IFDIR
664#undef S_IFLNK
665#undef S_IFBLK
666#undef S_IFCHR
667#undef S_IFIFO
668#undef S_IFSOCK
669#define S_IFMT 0170000
670#define S_IFREG 0100000
671#define S_IFDIR 0040000
672#define S_IFLNK 0120000
673#define S_IFBLK 0060000
674#define S_IFCHR 0020000
675#define S_IFIFO 0010000
676#define S_IFSOCK 0140000
677#ifdef stat
678#undef stat
679#endif
680#define stat(path, buf) git_stat(path, buf)
55454427 681int git_stat(const char *, struct stat *);
d543d9c0
DM
682#ifdef fstat
683#undef fstat
684#endif
685#define fstat(fd, buf) git_fstat(fd, buf)
55454427 686int git_fstat(int, struct stat *);
d543d9c0
DM
687#ifdef lstat
688#undef lstat
689#endif
690#define lstat(path, buf) git_lstat(path, buf)
55454427 691int git_lstat(const char *, struct stat *);
d543d9c0
DM
692#endif
693
22bac0ea 694#define DEFAULT_PACKED_GIT_LIMIT \
be4ca290 695 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
8c82534d 696
6900679c
SH
697#ifdef NO_PREAD
698#define pread git_pread
55454427 699ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
6900679c 700#endif
14086b0a
SP
701/*
702 * Forward decl that will remind us if its twin in cache.h changes.
703 * This function is used in compat/pread.c. But we can't include
704 * cache.h there.
705 */
55454427 706ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 707
4050c0df
JH
708#ifdef NO_SETENV
709#define setenv gitsetenv
55454427 710int gitsetenv(const char *, const char *, int);
4050c0df
JH
711#endif
712
ca5bb5d5
SP
713#ifdef NO_MKDTEMP
714#define mkdtemp gitmkdtemp
55454427 715char *gitmkdtemp(char *);
ca5bb5d5 716#endif
0620b39b 717
731043fd
JR
718#ifdef NO_UNSETENV
719#define unsetenv gitunsetenv
55454427 720void gitunsetenv(const char *);
731043fd
JR
721#endif
722
4050c0df
JH
723#ifdef NO_STRCASESTR
724#define strcasestr gitstrcasestr
55454427 725char *gitstrcasestr(const char *haystack, const char *needle);
4050c0df
JH
726#endif
727
817151e6
PE
728#ifdef NO_STRLCPY
729#define strlcpy gitstrlcpy
55454427 730size_t gitstrlcpy(char *, const char *, size_t);
817151e6
PE
731#endif
732
bc6b4f52
JR
733#ifdef NO_STRTOUMAX
734#define strtoumax gitstrtoumax
55454427 735uintmax_t gitstrtoumax(const char *, char **, int);
97000ba6 736#define strtoimax gitstrtoimax
55454427 737intmax_t gitstrtoimax(const char *, char **, int);
bc6b4f52
JR
738#endif
739
fa0c87c3
AR
740#ifdef NO_HSTRERROR
741#define hstrerror githstrerror
55454427 742const char *githstrerror(int herror);
fa0c87c3
AR
743#endif
744
b21b9f1d
RS
745#ifdef NO_MEMMEM
746#define memmem gitmemmem
747void *gitmemmem(const void *haystack, size_t haystacklen,
ec36c42a 748 const void *needle, size_t needlelen);
b21b9f1d
RS
749#endif
750
ca2baa3f
RS
751#ifdef OVERRIDE_STRDUP
752#ifdef strdup
753#undef strdup
754#endif
755#define strdup gitstrdup
756char *gitstrdup(const char *s);
757#endif
b21b9f1d 758
40036bed
MK
759#ifdef NO_GETPAGESIZE
760#define getpagesize() sysconf(_SC_PAGESIZE)
761#endif
762
05d1ed61
BW
763#ifndef O_CLOEXEC
764#define O_CLOEXEC 0
765#endif
766
cba22528 767#ifdef FREAD_READS_DIRECTORIES
b0a642ac
RJ
768# if !defined(SUPPRESS_FOPEN_REDEFINITION)
769# ifdef fopen
770# undef fopen
771# endif
772# define fopen(a,b) git_fopen(a,b)
773# endif
55454427 774FILE *git_fopen(const char*, const char*);
cba22528
BC
775#endif
776
c4582f93 777#ifdef SNPRINTF_RETURNS_BOGUS
ab03803c
BS
778#ifdef snprintf
779#undef snprintf
780#endif
c4582f93 781#define snprintf git_snprintf
b199d714 782int git_snprintf(char *str, size_t maxsize,
ad6dad09 783 const char *format, ...);
ab03803c
BS
784#ifdef vsnprintf
785#undef vsnprintf
786#endif
c4582f93 787#define vsnprintf git_vsnprintf
55454427 788int git_vsnprintf(char *str, size_t maxsize,
ad6dad09 789 const char *format, va_list ap);
c4582f93
MR
790#endif
791
726c8ef5
JS
792#ifdef __GLIBC_PREREQ
793#if __GLIBC_PREREQ(2, 1)
794#define HAVE_STRCHRNUL
795#endif
796#endif
797
798#ifndef HAVE_STRCHRNUL
659c69cf 799#define strchrnul gitstrchrnul
9e79f00f
AE
800static inline char *gitstrchrnul(const char *s, int c)
801{
802 while (*s && *s != c)
803 s++;
804 return (char *)s;
805}
659c69cf
RS
806#endif
807
da523cc5
MP
808#ifdef NO_INET_PTON
809int inet_pton(int af, const char *src, void *dst);
810#endif
811
812#ifdef NO_INET_NTOP
813const char *inet_ntop(int af, const void *src, char *dst, size_t size);
814#endif
815
0f4b6db3
EB
816#ifdef NO_PTHREADS
817#define atexit git_atexit
55454427 818int git_atexit(void (*handler)(void));
0f4b6db3
EB
819#endif
820
320d0b49
JK
821static inline size_t st_add(size_t a, size_t b)
822{
823 if (unsigned_add_overflows(a, b))
824 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
825 (uintmax_t)a, (uintmax_t)b);
826 return a + b;
827}
d616fbf2
ES
828#define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
829#define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
320d0b49
JK
830
831static inline size_t st_mult(size_t a, size_t b)
832{
833 if (unsigned_mult_overflows(a, b))
834 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
835 (uintmax_t)a, (uintmax_t)b);
836 return a * b;
837}
838
839static inline size_t st_sub(size_t a, size_t b)
840{
841 if (a < b)
842 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
843 (uintmax_t)a, (uintmax_t)b);
844 return a - b;
845}
a9a74636 846
61f76a36
KS
847#ifdef HAVE_ALLOCA_H
848# include <alloca.h>
849# define xalloca(size) (alloca(size))
850# define xalloca_free(p) do {} while (0)
851#else
852# define xalloca(size) (xmalloc(size))
853# define xalloca_free(p) (free(p))
854#endif
55454427
DL
855char *xstrdup(const char *str);
856void *xmalloc(size_t size);
857void *xmallocz(size_t size);
858void *xmallocz_gently(size_t size);
859void *xmemdupz(const void *data, size_t len);
860char *xstrndup(const char *str, size_t len);
861void *xrealloc(void *ptr, size_t size);
862void *xcalloc(size_t nmemb, size_t size);
863void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
864void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
b199d714 865int xopen(const char *path, int flags, ...);
55454427
DL
866ssize_t xread(int fd, void *buf, size_t len);
867ssize_t xwrite(int fd, const void *buf, size_t len);
868ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
869int xdup(int fd);
870FILE *xfopen(const char *path, const char *mode);
871FILE *xfdopen(int fd, const char *mode);
872int xmkstemp(char *temp_filename);
873int xmkstemp_mode(char *temp_filename, int mode);
874char *xgetcwd(void);
875FILE *fopen_for_writing(const char *path);
876FILE *fopen_or_warn(const char *path, const char *mode);
f21a47b2 877
481df65f
ÆAB
878/*
879 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
880 * that ptr is used twice, so don't pass e.g. ptr++.
881 */
882#define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
883
e7792a74 884#define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
e159b810 885#define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)));
e7792a74 886#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
3ac22f82 887
60566cbb
RS
888#define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
889 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
890static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
891{
892 if (n)
893 memcpy(dst, src, st_mult(size, n));
894}
895
57839807
RS
896#define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
897 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
898static inline void move_array(void *dst, const void *src, size_t n, size_t size)
899{
900 if (n)
901 memmove(dst, src, st_mult(size, n));
902}
903
36895391
JK
904/*
905 * These functions help you allocate structs with flex arrays, and copy
906 * the data directly into the array. For example, if you had:
907 *
908 * struct foo {
909 * int bar;
910 * char name[FLEX_ARRAY];
911 * };
912 *
913 * you can do:
914 *
915 * struct foo *f;
916 * FLEX_ALLOC_MEM(f, name, src, len);
917 *
918 * to allocate a "foo" with the contents of "src" in the "name" field.
919 * The resulting struct is automatically zero'd, and the flex-array field
920 * is NUL-terminated (whether the incoming src buffer was or not).
921 *
922 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
923 * but do want to store a pointer to some extra data in the same allocated
924 * block. For example, if you have:
925 *
926 * struct foo {
927 * char *name;
928 * int bar;
929 * };
930 *
931 * you can do:
932 *
933 * struct foo *f;
0bb1519f 934 * FLEXPTR_ALLOC_STR(f, name, src);
36895391
JK
935 *
936 * and "name" will point to a block of memory after the struct, which will be
937 * freed along with the struct (but the pointer can be repointed anywhere).
938 *
939 * The *_STR variants accept a string parameter rather than a ptr/len
940 * combination.
941 *
942 * Note that these macros will evaluate the first parameter multiple
943 * times, and it must be assignable as an lvalue.
944 */
945#define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
e9451782
RS
946 size_t flex_array_len_ = (len); \
947 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
948 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
36895391
JK
949} while (0)
950#define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
0ac52a38
RS
951 size_t flex_array_len_ = (len); \
952 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
953 memcpy((x) + 1, (buf), flex_array_len_); \
36895391
JK
954 (x)->ptrname = (void *)((x)+1); \
955} while(0)
956#define FLEX_ALLOC_STR(x, flexname, str) \
957 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
958#define FLEXPTR_ALLOC_STR(x, ptrname, str) \
959 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
960
d64ea0f8
JK
961static inline char *xstrdup_or_null(const char *str)
962{
963 return str ? xstrdup(str) : NULL;
964}
965
dc49cd76
SP
966static inline size_t xsize_t(off_t len)
967{
73560c79
RJ
968 size_t size = (size_t) len;
969
970 if (len != (off_t) size)
46be82df 971 die("Cannot handle files this big");
73560c79 972 return size;
dc49cd76
SP
973}
974
7b03c89e 975__attribute__((format (printf, 3, 4)))
b199d714 976int xsnprintf(char *dst, size_t max, const char *fmt, ...);
7b03c89e 977
da25bdb7
RS
978#ifndef HOST_NAME_MAX
979#define HOST_NAME_MAX 256
980#endif
981
55454427 982int xgethostname(char *buf, size_t len);
5781a9a2 983
f1589d10 984/* in ctype.c, for kwset users */
189c860c 985extern const unsigned char tolower_trans_tbl[256];
f1589d10 986
4050c0df 987/* Sane ctype - no locale, and works with signed chars */
c2e9364a 988#undef isascii
4050c0df
JH
989#undef isspace
990#undef isdigit
991#undef isalpha
992#undef isalnum
0fcec2ce 993#undef isprint
43ccdf56
NK
994#undef islower
995#undef isupper
4050c0df
JH
996#undef tolower
997#undef toupper
1c149ab2
NTND
998#undef iscntrl
999#undef ispunct
1000#undef isxdigit
2adf7247 1001
ca5ab7d1 1002extern const unsigned char sane_ctype[256];
4050c0df
JH
1003#define GIT_SPACE 0x01
1004#define GIT_DIGIT 0x02
1005#define GIT_ALPHA 0x04
8cc32992 1006#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 1007#define GIT_REGEX_SPECIAL 0x10
2f6c9760 1008#define GIT_PATHSPEC_MAGIC 0x20
1c149ab2
NTND
1009#define GIT_CNTRL 0x40
1010#define GIT_PUNCT 0x80
4050c0df 1011#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 1012#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
1013#define isspace(x) sane_istest(x,GIT_SPACE)
1014#define isdigit(x) sane_istest(x,GIT_DIGIT)
1015#define isalpha(x) sane_istest(x,GIT_ALPHA)
1016#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
0fcec2ce 1017#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
43ccdf56
NK
1018#define islower(x) sane_iscase(x, 1)
1019#define isupper(x) sane_iscase(x, 0)
8cc32992 1020#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 1021#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1c149ab2
NTND
1022#define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1023#define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1024 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
50a71776 1025#define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
4050c0df
JH
1026#define tolower(x) sane_case((unsigned char)(x), 0x20)
1027#define toupper(x) sane_case((unsigned char)(x), 0)
2f6c9760 1028#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
4050c0df
JH
1029
1030static inline int sane_case(int x, int high)
1031{
1032 if (sane_istest(x, GIT_ALPHA))
1033 x = (x & ~0x20) | high;
1034 return x;
1035}
1036
43ccdf56
NK
1037static inline int sane_iscase(int x, int is_lower)
1038{
1039 if (!sane_istest(x, GIT_ALPHA))
1040 return 0;
1041
1042 if (is_lower)
1043 return (x & 0x20) != 0;
1044 else
1045 return (x & 0x20) == 0;
1046}
1047
41a80924
JK
1048/*
1049 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1050 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1051 * locale-specific conversions).
1052 */
1053static inline int skip_iprefix(const char *str, const char *prefix,
1054 const char **out)
1055{
1056 do {
1057 if (!*prefix) {
1058 *out = str;
1059 return 1;
1060 }
1061 } while (tolower(*str++) == tolower(*prefix++));
1062 return 0;
1063}
1064
6aead43d
JM
1065static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1066{
1067 unsigned long ul;
1068 char *p;
1069
1070 errno = 0;
e6f2599c
MM
1071 /* negative values would be accepted by strtoul */
1072 if (strchr(s, '-'))
1073 return -1;
6aead43d
JM
1074 ul = strtoul(s, &p, base);
1075 if (errno || *p || p == s || (unsigned int) ul != ul)
1076 return -1;
1077 *result = ul;
1078 return 0;
1079}
1080
7791ecbc
JH
1081static inline int strtol_i(char const *s, int base, int *result)
1082{
1083 long ul;
1084 char *p;
1085
1086 errno = 0;
1087 ul = strtol(s, &p, base);
1088 if (errno || *p || p == s || (int) ul != ul)
1089 return -1;
1090 *result = ul;
1091 return 0;
1092}
1093
43fe901b
BD
1094#ifdef INTERNAL_QSORT
1095void git_qsort(void *base, size_t nmemb, size_t size,
1096 int(*compar)(const void *, const void *));
1097#define qsort git_qsort
1098#endif
1099
dbc540c7
RS
1100#define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1101static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1102 int(*compar)(const void *, const void *))
1103{
1104 if (nmemb > 1)
1105 qsort(base, nmemb, size, compar);
1106}
1107
04ee8b87
RS
1108#ifndef HAVE_ISO_QSORT_S
1109int git_qsort_s(void *base, size_t nmemb, size_t size,
1110 int (*compar)(const void *, const void *, void *), void *ctx);
1111#define qsort_s git_qsort_s
1112#endif
1113
3ca86994
RS
1114#define QSORT_S(base, n, compar, ctx) do { \
1115 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
c3c3486b 1116 BUG("qsort_s() failed"); \
3ca86994
RS
1117} while (0)
1118
2f895225
JS
1119#ifndef REG_STARTEND
1120#error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1121#endif
1122
1123static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1124 size_t nmatch, regmatch_t pmatch[], int eflags)
1125{
1126 assert(nmatch > 0 && pmatch);
1127 pmatch[0].rm_so = 0;
1128 pmatch[0].rm_eo = size;
1129 return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1130}
1131
81a24b52
AR
1132#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1133# define FORCE_DIR_SET_GID S_ISGID
1134#else
1135# define FORCE_DIR_SET_GID 0
1136#endif
1137
c06ff490
KB
1138#ifdef NO_NSEC
1139#undef USE_NSEC
1140#define ST_CTIME_NSEC(st) 0
1141#define ST_MTIME_NSEC(st) 0
1142#else
c567383b
BG
1143#ifdef USE_ST_TIMESPEC
1144#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1145#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1146#else
c06ff490
KB
1147#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1148#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1149#endif
c567383b 1150#endif
c06ff490 1151
34779c53
JS
1152#ifdef UNRELIABLE_FSTAT
1153#define fstat_is_reliable() 0
1154#else
1155#define fstat_is_reliable() 1
1156#endif
1157
ab8632ae 1158#ifndef va_copy
26db0f2e
JN
1159/*
1160 * Since an obvious implementation of va_list would be to make it a
1161 * pointer into the stack frame, a simple assignment will work on
1162 * many systems. But let's try to be more portable.
1163 */
1164#ifdef __va_copy
1165#define va_copy(dst, src) __va_copy(dst, src)
1166#else
1167#define va_copy(dst, src) ((dst) = (src))
1168#endif
ab8632ae
JK
1169#endif
1170
f51140c2 1171#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
e05bed96
KB
1172#define HAVE_VARIADIC_MACROS 1
1173#endif
1174
746ea4ad
RJ
1175/* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1176extern int BUG_exit_code;
1177
d8193743
JK
1178#ifdef HAVE_VARIADIC_MACROS
1179__attribute__((format (printf, 3, 4))) NORETURN
1180void BUG_fl(const char *file, int line, const char *fmt, ...);
1181#define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1182#else
1183__attribute__((format (printf, 1, 2))) NORETURN
1184void BUG(const char *fmt, ...);
1185#endif
1186
fc71db39
AR
1187/*
1188 * Preserves errno, prints a message, but gives no warning for ENOENT.
1054af7d
RS
1189 * Returns 0 on success, which includes trying to unlink an object that does
1190 * not exist.
fc71db39
AR
1191 */
1192int unlink_or_warn(const char *path);
9ccc0c08
RS
1193 /*
1194 * Tries to unlink file. Returns 0 if unlink succeeded
1195 * or the file already didn't exist. Returns -1 and
1196 * appends a message to err suitable for
1197 * 'error("%s", err->buf)' on error.
1198 */
1199int unlink_or_msg(const char *file, struct strbuf *err);
d1723296 1200/*
1054af7d
RS
1201 * Preserves errno, prints a message, but gives no warning for ENOENT.
1202 * Returns 0 on success, which includes trying to remove a directory that does
1203 * not exist.
d1723296
PC
1204 */
1205int rmdir_or_warn(const char *path);
80d706af
PC
1206/*
1207 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1208 * the supplied file mode.
1209 */
1210int remove_or_warn(unsigned int mode, const char *path);
fc71db39 1211
e5c52c98
JN
1212/*
1213 * Call access(2), but warn for any error except "missing file"
1214 * (ENOENT or ENOTDIR).
1215 */
4698c8fe
JN
1216#define ACCESS_EACCES_OK (1U << 0)
1217int access_or_warn(const char *path, int mode, unsigned flag);
1218int access_or_die(const char *path, int mode, unsigned flag);
ba8bd830 1219
11dc1fcb
NTND
1220/* Warn on an inaccessible file if errno indicates this is an error */
1221int warn_on_fopen_errors(const char *path);
55b38a48 1222
66547547
JK
1223#ifdef GMTIME_UNRELIABLE_ERRORS
1224struct tm *git_gmtime(const time_t *);
1225struct tm *git_gmtime_r(const time_t *, struct tm *);
1226#define gmtime git_gmtime
1227#define gmtime_r git_gmtime_r
1228#endif
1229
290c8e7a
KM
1230#if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1231#define USE_PARENS_AROUND_GETTEXT_N 1
1232#endif
1233
1b56cdf9
KM
1234#ifndef SHELL_PATH
1235# define SHELL_PATH "/bin/sh"
1236#endif
1237
f43cce23
JK
1238#ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1239#define flockfile(fh)
1240#define funlockfile(fh)
1241#define getc_unlocked(fh) getc(fh)
1242#endif
1243
18a4f6be
NTND
1244#ifdef FILENO_IS_A_MACRO
1245int git_fileno(FILE *stream);
400caafb 1246# ifndef COMPAT_CODE_FILENO
18a4f6be
NTND
1247# undef fileno
1248# define fileno(p) git_fileno(p)
1249# endif
1250#endif
1251
400caafb
CC
1252#ifdef NEED_ACCESS_ROOT_HANDLER
1253int git_access(const char *path, int mode);
1254# ifndef COMPAT_CODE_ACCESS
1255# ifdef access
1256# undef access
1257# endif
1258# define access(path, mode) git_access(path, mode)
1259# endif
1260#endif
1261
dc5a18b3
JH
1262/*
1263 * Our code often opens a path to an optional file, to work on its
1264 * contents when we can successfully open it. We can ignore a failure
1265 * to open if such an optional file does not exist, but we do want to
1266 * report a failure in opening for other reasons (e.g. we got an I/O
1267 * error, or the file is there, but we lack the permission to open).
1268 *
1269 * Call this function after seeing an error from open() or fopen() to
1270 * see if the errno indicates a missing file that we can safely ignore.
1271 */
1272static inline int is_missing_file_error(int errno_)
1273{
1274 return (errno_ == ENOENT || errno_ == ENOTDIR);
1275}
1276
55454427 1277int cmd_main(int, const char **);
5c238e29 1278
ee4512ed
JH
1279/*
1280 * Intercept all calls to exit() and route them to trace2 to
1281 * optionally emit a message before calling the real exit().
1282 */
1283int trace2_cmd_exit_fl(const char *file, int line, int code);
1284#define exit(code) exit(trace2_cmd_exit_fl(__FILE__, __LINE__, (code)))
1285
0e5bba53
JK
1286/*
1287 * You can mark a stack variable with UNLEAK(var) to avoid it being
1288 * reported as a leak by tools like LSAN or valgrind. The argument
1289 * should generally be the variable itself (not its address and not what
1290 * it points to). It's safe to use this on pointers which may already
1291 * have been freed, or on pointers which may still be in use.
1292 *
1293 * Use this _only_ for a variable that leaks by going out of scope at
1294 * program exit (so only from cmd_* functions or their direct helpers).
1295 * Normal functions, especially those which may be called multiple
1296 * times, should actually free their memory. This is only meant as
1297 * an annotation, and does nothing in non-leak-checking builds.
1298 */
1299#ifdef SUPPRESS_ANNOTATED_LEAKS
55454427 1300void unleak_memory(const void *ptr, size_t len);
5de3de32 1301#define UNLEAK(var) unleak_memory(&(var), sizeof(var))
0e5bba53 1302#else
5de3de32 1303#define UNLEAK(var) do {} while (0)
0e5bba53
JK
1304#endif
1305
c8af66ab
JK
1306/*
1307 * This include must come after system headers, since it introduces macros that
1308 * replace system names.
1309 */
1310#include "banned.h"
1311
5c238e29 1312#endif