]> git.ipfire.org Git - thirdparty/git.git/blame - git-compat-util.h
Merge branch 'es/add-doc-list-short-form-of-all-in-synopsis' into maint-2.43
[thirdparty/git.git] / git-compat-util.h
CommitLineData
4050c0df
JH
1#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
7bc341e2 4#if __STDC_VERSION__ - 0 < 199901L
5/*
6 * Git is in a testing period for mandatory C99 support in the compiler. If
7 * your compiler is reasonably recent, you can try to enable C99 support (or,
8 * for MSVC, C11 support). If you encounter a problem and can't enable C99
9 * support with your compiler (such as with "-std=gnu99") and don't have access
10 * to one with this support, such as GCC or Clang, you can remove this #if
11 * directive, but please report the details of your system to
12 * git@vger.kernel.org.
13 */
14#error "Required C99 support is in a test phase. Please see git-compat-util.h for more details."
15#endif
16
556702f8
JH
17#ifdef USE_MSVC_CRTDBG
18/*
19 * For these to work they must appear very early in each
20 * file -- before most of the standard header files.
21 */
22#include <stdlib.h>
23#include <crtdbg.h>
24#endif
25
17d3883f
JS
26struct strbuf;
27
28
b97e9116
MW
29#define _FILE_OFFSET_BITS 64
30
89c855ed
EP
31
32/* Derived from Linux "Features Test Macro" header
33 * Convenience macros to test the versions of gcc (or
34 * a compatible compiler).
35 * Use them like this:
36 * #if GIT_GNUC_PREREQ (2,8)
37 * ... code requiring gcc 2.8 or later ...
38 * #endif
39*/
40#if defined(__GNUC__) && defined(__GNUC_MINOR__)
41# define GIT_GNUC_PREREQ(maj, min) \
42 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
43#else
44 #define GIT_GNUC_PREREQ(maj, min) 0
45#endif
46
47
8f1d2e6f 48#ifndef FLEX_ARRAY
8e973991
JH
49/*
50 * See if our compiler is known to support flexible array members.
51 */
deefc2d9
JH
52
53/*
54 * Check vendor specific quirks first, before checking the
55 * __STDC_VERSION__, as vendor compilers can lie and we need to be
56 * able to work them around. Note that by not defining FLEX_ARRAY
57 * here, we can fall back to use the "safer but a bit wasteful" one
58 * later.
59 */
60#if defined(__SUNPRO_C) && (__SUNPRO_C <= 0x580)
8e973991
JH
61#elif defined(__GNUC__)
62# if (__GNUC__ >= 3)
63# define FLEX_ARRAY /* empty */
64# else
65# define FLEX_ARRAY 0 /* older GNU extension */
66# endif
deefc2d9
JH
67#elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
68# define FLEX_ARRAY /* empty */
8e973991
JH
69#endif
70
71/*
72 * Otherwise, default to safer but a bit wasteful traditional style
73 */
74#ifndef FLEX_ARRAY
75# define FLEX_ARRAY 1
8f1d2e6f
JH
76#endif
77#endif
78
89c855ed
EP
79
80/*
81 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
82 * @cond: the compile-time condition which must be true.
83 *
84 * Your compile will fail if the condition isn't true, or can't be evaluated
85 * by the compiler. This can be used in an expression: its value is "0".
86 *
87 * Example:
88 * #define foo_to_char(foo) \
89 * ((char *)(foo) \
90 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
91 */
92#define BUILD_ASSERT_OR_ZERO(cond) \
93 (sizeof(char [1 - 2*!(cond)]) - 1)
94
e2c6f7cd 95#if GIT_GNUC_PREREQ(3, 1)
89c855ed
EP
96 /* &arr[0] degrades to a pointer: a different type from an array */
97# define BARF_UNLESS_AN_ARRAY(arr) \
98 BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
99 __typeof__(&(arr)[0])))
08e8c266
RS
100# define BARF_UNLESS_COPYABLE(dst, src) \
101 BUILD_ASSERT_OR_ZERO(__builtin_types_compatible_p(__typeof__(*(dst)), \
102 __typeof__(*(src))))
e2c6f7cd
CB
103#else
104# define BARF_UNLESS_AN_ARRAY(arr) 0
08e8c266
RS
105# define BARF_UNLESS_COPYABLE(dst, src) \
106 BUILD_ASSERT_OR_ZERO(0 ? ((*(dst) = *(src)), 0) : \
107 sizeof(*(dst)) == sizeof(*(src)))
89c855ed
EP
108#endif
109/*
110 * ARRAY_SIZE - get the number of elements in a visible array
68b69211 111 * @x: the array whose size you want.
89c855ed
EP
112 *
113 * This does not work on pointers, or arrays declared as [], or
114 * function parameters. With correct compiler support, such usage
115 * will cause a build error (see the build_assert_or_zero macro).
116 */
117#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
118
f630cfda 119#define bitsizeof(x) (CHAR_BIT * sizeof(x))
b4f2a6ac 120
c03c8315
EFL
121#define maximum_signed_value_of_type(a) \
122 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
123
1368f650
JN
124#define maximum_unsigned_value_of_type(a) \
125 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
126
c03c8315
EFL
127/*
128 * Signed integer overflow is undefined in C, so here's a helper macro
129 * to detect if the sum of two integers will overflow.
130 *
131 * Requires: a >= 0, typeof(a) equals typeof(b)
132 */
133#define signed_add_overflows(a, b) \
134 ((b) > maximum_signed_value_of_type(a) - (a))
135
1368f650
JN
136#define unsigned_add_overflows(a, b) \
137 ((b) > maximum_unsigned_value_of_type(a) - (a))
138
320d0b49
JK
139/*
140 * Returns true if the multiplication of "a" and "b" will
141 * overflow. The types of "a" and "b" must match and must be unsigned.
142 * Note that this macro evaluates "a" twice!
143 */
144#define unsigned_mult_overflows(a, b) \
145 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
146
e2ffeae3
JS
147/*
148 * Returns true if the left shift of "a" by "shift" bits will
149 * overflow. The type of "a" must be unsigned.
150 */
151#define unsigned_left_shift_overflows(a, shift) \
152 ((shift) < bitsizeof(a) && \
153 (a) > maximum_unsigned_value_of_type(a) >> (shift))
154
8723f216
NP
155#ifdef __GNUC__
156#define TYPEOF(x) (__typeof__(x))
157#else
158#define TYPEOF(x)
159#endif
160
f630cfda 161#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
db7244bd 162#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216 163
98cb6f30
PH
164#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
165
cf606e3d
AW
166/* Approximation of the length of the decimal representation of this type. */
167#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
168
9e12400d
CMAB
169#ifdef __MINGW64__
170#define _POSIX_C_SOURCE 1
171#elif defined(__sun__)
4cb18a49
BC
172 /*
173 * On Solaris, when _XOPEN_EXTENDED is set, its header file
174 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
175 * setting to say we are XPG5 or XPG6. Also on Solaris,
176 * XPG6 programs must be compiled with a c99 compiler, while
177 * non XPG6 programs must be compiled with a pre-c99 compiler.
178 */
179# if __STDC_VERSION__ - 0 >= 199901L
180# define _XOPEN_SOURCE 600
181# else
182# define _XOPEN_SOURCE 500
183# endif
6555b196 184#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
6c109904 185 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
3a0a3a89
RJ
186 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
187 !defined(__CYGWIN__)
85023577
JH
188#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
189#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6 190#endif
fb952206
JR
191#define _ALL_SOURCE 1
192#define _GNU_SOURCE 1
193#define _BSD_SOURCE 1
f978a99f 194#define _DEFAULT_SOURCE 1
9a695fbf 195#define _NETBSD_SOURCE 1
9398b859 196#define _SGI_SOURCE 1
85023577 197
7c07f36a 198#if GIT_GNUC_PREREQ(4, 5)
9ff7eb8c
ÆAB
199#define UNUSED __attribute__((unused)) \
200 __attribute__((deprecated ("parameter declared as UNUSED")))
7c07f36a
AS
201#elif defined(__GNUC__)
202#define UNUSED __attribute__((unused)) \
203 __attribute__((deprecated))
9b240347 204#else
5cf88fd8 205#define UNUSED
9b240347
JK
206#endif
207
380395d0 208#if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
3571e78a 209# if !defined(_WIN32_WINNT)
2939a1f7 210# define _WIN32_WINNT 0x0600
41f29991 211# endif
435bdf8c
MSO
212#define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
213#include <winsock2.h>
bb390b1f
CMAB
214#ifndef NO_UNIX_SOCKETS
215#include <afunix.h>
216#endif
435bdf8c 217#include <windows.h>
380395d0 218#define GIT_WINDOWS_NATIVE
435bdf8c
MSO
219#endif
220
4050c0df
JH
221#include <unistd.h>
222#include <stdio.h>
223#include <sys/stat.h>
224#include <fcntl.h>
225#include <stddef.h>
226#include <stdlib.h>
227#include <stdarg.h>
228#include <string.h>
b3e103da 229#ifdef HAVE_STRINGS_H
6c109904
JS
230#include <strings.h> /* for strcasecmp() */
231#endif
4050c0df
JH
232#include <errno.h>
233#include <limits.h>
1819ad32 234#include <locale.h>
b2d05e06 235#ifdef NEEDS_SYS_PARAM_H
4050c0df 236#include <sys/param.h>
6ede7205 237#endif
4050c0df
JH
238#include <sys/types.h>
239#include <dirent.h>
85023577
JH
240#include <sys/time.h>
241#include <time.h>
242#include <signal.h>
f4626df5
JS
243#include <assert.h>
244#include <regex.h>
245#include <utime.h>
088d8802 246#include <syslog.h>
2648ccc2
ĐTCD
247#if !defined(NO_POLL_H)
248#include <poll.h>
249#elif !defined(NO_SYS_POLL_H)
fdc12114 250#include <sys/poll.h>
2844923d 251#else
2648ccc2 252/* Pull the compat stuff */
2844923d
MD
253#include <poll.h>
254#endif
9529080d
KM
255#ifdef HAVE_BSD_SYSCTL
256#include <sys/sysctl.h>
257#endif
2f0aaaf9 258
9fd512c8
ÆAB
259/* Used by compat/win32/path-utils.h, and more */
260static inline int is_xplatform_dir_sep(int c)
261{
262 return c == '/' || c == '\\';
263}
264
496f2569 265#if defined(__CYGWIN__)
1cadad6f 266#include "compat/win32/path-utils.h"
496f2569 267#endif
cfc755d3
VR
268#if defined(__MINGW32__)
269/* pull in Windows compatibility stuff */
1cadad6f 270#include "compat/win32/path-utils.h"
cfc755d3
VR
271#include "compat/mingw.h"
272#elif defined(_MSC_VER)
22c3634c 273#include "compat/win32/path-utils.h"
cfc755d3
VR
274#include "compat/msvc.h"
275#else
1e8fef60 276#include <sys/utsname.h>
f4626df5 277#include <sys/wait.h>
ebae9ff9 278#include <sys/resource.h>
85023577 279#include <sys/socket.h>
80bbe72b 280#include <sys/ioctl.h>
435a2535 281#include <sys/statvfs.h>
eb80042c 282#include <termios.h>
2600973f 283#ifndef NO_SYS_SELECT_H
80bbe72b 284#include <sys/select.h>
2600973f 285#endif
85023577
JH
286#include <netinet/in.h>
287#include <netinet/tcp.h>
288#include <arpa/inet.h>
289#include <netdb.h>
290#include <pwd.h>
e2770979 291#include <sys/un.h>
2844923d 292#ifndef NO_INTTYPES_H
007e2ba6 293#include <inttypes.h>
2844923d
MD
294#else
295#include <stdint.h>
296#endif
05cd988d 297#ifdef HAVE_ARC4RANDOM_LIBBSD
298#include <bsd/stdlib.h>
299#endif
300#ifdef HAVE_GETRANDOM
301#include <sys/random.h>
302#endif
6c109904
JS
303#ifdef NO_INTPTR_T
304/*
c70e1b04 305 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
6c109904
JS
306 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
307 * while on IP16 and IP16L32 it is "int" (resp. "short")
308 * Size needs to match (or exceed) 'sizeof(void *)'.
309 * We can't take "long long" here as not everybody has it.
310 */
311typedef long intptr_t;
312typedef unsigned long uintptr_t;
313#endif
fb952206 314#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 315#include <grp.h>
fb952206 316#define _ALL_SOURCE 1
41b20017 317#endif
85023577 318
76759c7d
TB
319/* used on Mac OS X */
320#ifdef PRECOMPOSE_UNICODE
321#include "compat/precompose_utf8.h"
322#else
808e9195
JK
323static inline const char *precompose_argv_prefix(int argc UNUSED,
324 const char **argv UNUSED,
325 const char *prefix)
15b52a44 326{
5c327502 327 return prefix;
15b52a44 328}
5020774a
TB
329static inline const char *precompose_string_if_needed(const char *in)
330{
331 return in;
332}
333
fdf72966 334#define probe_utf8_pathname_composition()
76759c7d
TB
335#endif
336
0539ecfd
JS
337#ifdef MKDIR_WO_TRAILING_SLASH
338#define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
55454427 339int compat_mkdir_wo_trailing_slash(const char*, mode_t);
0539ecfd
JS
340#endif
341
370ddcbc
PE
342#ifdef time
343#undef time
344#endif
345static inline time_t git_time(time_t *tloc)
346{
347 struct timeval tv;
348
349 /*
350 * Avoid time(NULL), which can disagree with gettimeofday(2)
351 * and filesystem timestamps.
352 */
353 gettimeofday(&tv, NULL);
354
355 if (tloc)
356 *tloc = tv.tv_sec;
357 return tv.tv_sec;
358}
359#define time git_time
360
7f9e848c
JS
361#ifdef NO_STRUCT_ITIMERVAL
362struct itimerval {
363 struct timeval it_interval;
364 struct timeval it_value;
981ff520 365};
7f9e848c
JS
366#endif
367
368#ifdef NO_SETITIMER
efcc48ef
JH
369static inline int git_setitimer(int which UNUSED,
370 const struct itimerval *value UNUSED,
371 struct itimerval *newvalue UNUSED) {
14639a47 372 return 0; /* pretend success */
15b52a44 373}
e1a95b78 374#undef setitimer
e0c08a4f 375#define setitimer(which,value,ovalue) git_setitimer(which,value,ovalue)
7f9e848c
JS
376#endif
377
e1c06886
DA
378#ifndef NO_LIBGEN_H
379#include <libgen.h>
380#else
381#define basename gitbasename
55454427 382char *gitbasename(char *);
824682ab 383#define dirname gitdirname
55454427 384char *gitdirname(char *);
e1c06886
DA
385#endif
386
85023577
JH
387#ifndef NO_ICONV
388#include <iconv.h>
389#endif
4050c0df 390
684ec6c6 391#ifndef NO_OPENSSL
88c03eb5 392#ifdef __APPLE__
b195aa00 393#define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
88c03eb5
KM
394#include <AvailabilityMacros.h>
395#undef DEPRECATED_ATTRIBUTE
396#define DEPRECATED_ATTRIBUTE
397#undef __AVAILABILITY_MACROS_USES_AVAILABILITY
398#endif
684ec6c6
RS
399#include <openssl/ssl.h>
400#include <openssl/err.h>
401#endif
402
9806f5a7
NTND
403#ifdef HAVE_SYSINFO
404# include <sys/sysinfo.h>
405#endif
406
3b130ade
DM
407/* On most systems <netdb.h> would have given us this, but
408 * not on some systems (e.g. z/OS).
409 */
410#ifndef NI_MAXHOST
411#define NI_MAXHOST 1025
412#endif
413
414#ifndef NI_MAXSERV
415#define NI_MAXSERV 32
416#endif
417
d0c2449f
JH
418/* On most systems <limits.h> would have given us this, but
419 * not on some systems (e.g. GNU/Hurd).
420 */
421#ifndef PATH_MAX
422#define PATH_MAX 4096
423#endif
424
7481d2bf
MRP
425#ifndef NAME_MAX
426#define NAME_MAX 255
427#endif
428
28f4aee3
JS
429typedef uintmax_t timestamp_t;
430#define PRItime PRIuMAX
431#define parse_timestamp strtoumax
432#define TIME_MAX UINTMAX_MAX
2e09c012 433#define TIME_MIN 0
1aeb7e75 434
80ba074f
JS
435#ifndef PATH_SEP
436#define PATH_SEP ':'
437#endif
438
cb6a22c0
CW
439#ifdef HAVE_PATHS_H
440#include <paths.h>
441#endif
442#ifndef _PATH_DEFPATH
443#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
444#endif
445
70fc5793 446#ifndef platform_core_config
a4e7e317 447struct config_context;
5cf88fd8
ÆAB
448static inline int noop_core_config(const char *var UNUSED,
449 const char *value UNUSED,
a4e7e317 450 const struct config_context *ctx UNUSED,
5cf88fd8 451 void *cb UNUSED)
70fc5793
JS
452{
453 return 0;
454}
455#define platform_core_config noop_core_config
456#endif
457
684dd4c2
MT
458int lstat_cache_aware_rmdir(const char *path);
459#if !defined(__MINGW32__) && !defined(_MSC_VER)
460#define rmdir lstat_cache_aware_rmdir
461#endif
462
25fe217b 463#ifndef has_dos_drive_prefix
808e9195 464static inline int git_has_dos_drive_prefix(const char *path UNUSED)
bf728346
RS
465{
466 return 0;
467}
468#define has_dos_drive_prefix git_has_dos_drive_prefix
25fe217b
JS
469#endif
470
2f36eed9 471#ifndef skip_dos_drive_prefix
808e9195 472static inline int git_skip_dos_drive_prefix(char **path UNUSED)
2f36eed9
JS
473{
474 return 0;
475}
476#define skip_dos_drive_prefix git_skip_dos_drive_prefix
477#endif
478
bf728346
RS
479static inline int git_is_dir_sep(int c)
480{
481 return c == '/';
482}
9fd512c8 483#ifndef is_dir_sep
bf728346 484#define is_dir_sep git_is_dir_sep
c2369bdf
CZ
485#endif
486
bf728346
RS
487#ifndef offset_1st_component
488static inline int git_offset_1st_component(const char *path)
489{
490 return is_dir_sep(path[0]);
491}
492#define offset_1st_component git_offset_1st_component
25fe217b
JS
493#endif
494
d2c84dad
JS
495#ifndef is_valid_path
496#define is_valid_path(path) 1
497#endif
498
bdc77d1d 499#ifndef is_path_owned_by_current_user
ae9abbb6
CMAB
500
501#ifdef __TANDEM
502#define ROOT_UID 65535
503#else
504#define ROOT_UID 0
505#endif
506
507/*
508 * Do not use this function when
509 * (1) geteuid() did not say we are running as 'root', or
510 * (2) using this function will compromise the system.
511 *
512 * PORTABILITY WARNING:
513 * This code assumes uid_t is unsigned because that is what sudo does.
514 * If your uid_t type is signed and all your ids are positive then it
515 * should all work fine.
516 * If your version of sudo uses negative values for uid_t or it is
517 * buggy and return an overflowed value in SUDO_UID, then git might
518 * fail to grant access to your repository properly or even mistakenly
519 * grant access to someone else.
520 * In the unlikely scenario this happened to you, and that is how you
521 * got to this message, we would like to know about it; so sent us an
522 * email to git@vger.kernel.org indicating which platform you are
523 * using and which version of sudo, so we can improve this logic and
524 * maybe provide you with a patch that would prevent this issue again
525 * in the future.
526 */
527static inline void extract_id_from_env(const char *env, uid_t *id)
528{
529 const char *real_uid = getenv(env);
530
531 /* discard anything empty to avoid a more complex check below */
532 if (real_uid && *real_uid) {
533 char *endptr = NULL;
534 unsigned long env_id;
535
536 errno = 0;
537 /* silent overflow errors could trigger a bug here */
538 env_id = strtoul(real_uid, &endptr, 10);
539 if (!*endptr && !errno)
540 *id = env_id;
541 }
542}
543
776515ef 544static inline int is_path_owned_by_current_uid(const char *path,
5cf88fd8 545 struct strbuf *report UNUSED)
bdc77d1d
JS
546{
547 struct stat st;
ae9abbb6
CMAB
548 uid_t euid;
549
bdc77d1d
JS
550 if (lstat(path, &st))
551 return 0;
ae9abbb6
CMAB
552
553 euid = geteuid();
554 if (euid == ROOT_UID)
6b11e3d5
CMAB
555 {
556 if (st.st_uid == ROOT_UID)
557 return 1;
558 else
559 extract_id_from_env("SUDO_UID", &euid);
560 }
ae9abbb6
CMAB
561
562 return st.st_uid == euid;
bdc77d1d
JS
563}
564
565#define is_path_owned_by_current_user is_path_owned_by_current_uid
566#endif
567
d1c69255 568#ifndef find_last_dir_sep
bf728346
RS
569static inline char *git_find_last_dir_sep(const char *path)
570{
571 return strrchr(path, '/');
572}
573#define find_last_dir_sep git_find_last_dir_sep
d1c69255
TN
574#endif
575
05ac8582
AK
576#ifndef has_dir_sep
577static inline int git_has_dir_sep(const char *path)
578{
579 return !!strchr(path, '/');
580}
581#define has_dir_sep(path) git_has_dir_sep(path)
582#endif
583
501afcb8
JS
584#ifndef query_user_email
585#define query_user_email() NULL
586#endif
587
1305ef37
RB
588#ifdef __TANDEM
589#include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
590#include <floss.h(floss_getpwuid)>
591#ifndef NSIG
592/*
593 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
594 * known, by detective work using kill -l as a list is all signals
595 * instead of signal.h where it should be.
596 */
597# define NSIG 100
598#endif
599#endif
600
e4ac953b 601#if defined(__HP_cc) && (__HP_cc >= 61000)
b6ab349b
MR
602#define NORETURN __attribute__((noreturn))
603#define NORETURN_PTR
6520c846 604#elif defined(__GNUC__) && !defined(NO_NORETURN)
4050c0df 605#define NORETURN __attribute__((__noreturn__))
18660bc9 606#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8
RJ
607#elif defined(_MSC_VER)
608#define NORETURN __declspec(noreturn)
609#define NORETURN_PTR
4050c0df
JH
610#else
611#define NORETURN
18660bc9 612#define NORETURN_PTR
8cd7ebc8 613#ifndef __GNUC__
4050c0df
JH
614#ifndef __attribute__
615#define __attribute__(x)
616#endif
617#endif
8cd7ebc8 618#endif
4050c0df 619
9fe3edc4
RJ
620/* The sentinel attribute is valid from gcc version 4.0 */
621#if defined(__GNUC__) && (__GNUC__ >= 4)
622#define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
1e8697b5
ÆAB
623/* warn_unused_result exists as of gcc 3.4.0, but be lazy and check 4.0 */
624#define RESULT_MUST_BE_USED __attribute__ ((warn_unused_result))
9fe3edc4
RJ
625#else
626#define LAST_ARG_MUST_BE_NULL
1e8697b5 627#define RESULT_MUST_BE_USED
9fe3edc4
RJ
628#endif
629
bbd8eb3e
CMAB
630#define MAYBE_UNUSED __attribute__((__unused__))
631
51ea5519
NP
632#include "compat/bswap.h"
633
382f6940 634#include "wrapper.h"
9ccc0c08 635
4050c0df 636/* General helper functions */
55454427 637NORETURN void usage(const char *err);
b199d714
DL
638NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
639NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
640NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
18568ee8 641int die_message(const char *err, ...) __attribute__((format (printf, 1, 2)));
24f6e6d6 642int die_message_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
b199d714
DL
643int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
644int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
645void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
646void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 647
f2be034c
BG
648#ifndef NO_OPENSSL
649#ifdef APPLE_COMMON_CRYPTO
650#include "compat/apple-common-crypto.h"
651#else
652#include <openssl/evp.h>
653#include <openssl/hmac.h>
654#endif /* APPLE_COMMON_CRYPTO */
655#include <openssl/x509v3.h>
656#endif /* NO_OPENSSL */
657
5b52d9f1
CMAB
658#ifdef HAVE_OPENSSL_CSPRNG
659#include <openssl/rand.h>
660#endif
661
e208f9cc
JK
662/*
663 * Let callers be aware of the constant return value; this can help
9798f7e5 664 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
b7ba8587 665 * because other compilers may be confused by this.
e208f9cc 666 */
ff0a80af 667#if defined(__GNUC__)
87fe5df3
JK
668static inline int const_error(void)
669{
670 return -1;
671}
672#define error(...) (error(__VA_ARGS__), const_error())
4df5e918 673#define error_errno(...) (error_errno(__VA_ARGS__), const_error())
e208f9cc
JK
674#endif
675
5710dcce
JK
676typedef void (*report_fn)(const char *, va_list params);
677
678void set_die_routine(NORETURN_PTR report_fn routine);
18568ee8 679report_fn get_die_message_routine(void);
5710dcce
JK
680void set_error_routine(report_fn routine);
681report_fn get_error_routine(void);
682void set_warn_routine(report_fn routine);
683report_fn get_warn_routine(void);
55454427 684void set_die_is_recursing_routine(int (*routine)(void));
39a3f5ea 685
cf4fff57
JK
686/*
687 * If the string "str" begins with the string found in "prefix", return 1.
688 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
689 * the string right after the prefix).
690 *
691 * Otherwise, return 0 and leave "out" untouched.
692 *
693 * Examples:
694 *
695 * [extract branch name, fail if not a branch]
696 * if (!skip_prefix(ref, "refs/heads/", &branch)
697 * return -1;
698 *
699 * [skip prefix if present, otherwise use whole string]
700 * skip_prefix(name, "refs/heads/", &name);
701 */
702static inline int skip_prefix(const char *str, const char *prefix,
703 const char **out)
fbca5837 704{
ba399c46 705 do {
cf4fff57
JK
706 if (!*prefix) {
707 *out = str;
708 return 1;
709 }
ba399c46 710 } while (*str++ == *prefix++);
cf4fff57 711 return 0;
fbca5837
MV
712}
713
ae989a61
JK
714/*
715 * Like skip_prefix, but promises never to read past "len" bytes of the input
716 * buffer, and returns the remaining number of bytes in "out" via "outlen".
717 */
718static inline int skip_prefix_mem(const char *buf, size_t len,
719 const char *prefix,
720 const char **out, size_t *outlen)
721{
722 size_t prefix_len = strlen(prefix);
723 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
724 *out = buf + prefix_len;
725 *outlen = len - prefix_len;
726 return 1;
727 }
728 return 0;
729}
730
35480f0b
JK
731/*
732 * If buf ends with suffix, return 1 and subtract the length of the suffix
733 * from *len. Otherwise, return 0 and leave *len untouched.
734 */
735static inline int strip_suffix_mem(const char *buf, size_t *len,
736 const char *suffix)
737{
738 size_t suflen = strlen(suffix);
739 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
740 return 0;
741 *len -= suflen;
742 return 1;
743}
744
745/*
746 * If str ends with suffix, return 1 and set *len to the size of the string
747 * without the suffix. Otherwise, return 0 and set *len to the size of the
748 * string.
749 *
750 * Note that we do _not_ NUL-terminate str to the new length.
751 */
752static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
753{
754 *len = strlen(str);
755 return strip_suffix_mem(str, len, suffix);
756}
757
568edcb9
RS
758#define SWAP(a, b) do { \
759 void *_swap_a_ptr = &(a); \
760 void *_swap_b_ptr = &(b); \
761 unsigned char _swap_buffer[sizeof(a)]; \
762 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
763 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
764 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
765 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
766} while (0)
767
b130a72b 768#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
769
770#ifndef PROT_READ
771#define PROT_READ 1
772#define PROT_WRITE 2
773#define MAP_PRIVATE 1
4050c0df
JH
774#endif
775
d6779124
SP
776#define mmap git_mmap
777#define munmap git_munmap
55454427
DL
778void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
779int git_munmap(void *start, size_t length);
4050c0df 780
b130a72b
JL
781#else /* NO_MMAP || USE_WIN32_MMAP */
782
783#include <sys/mman.h>
784
785#endif /* NO_MMAP || USE_WIN32_MMAP */
786
787#ifdef NO_MMAP
788
5faaf246 789/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
790#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
791
4050c0df
JH
792#else /* NO_MMAP */
793
5faaf246 794/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
795#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
796 (sizeof(void*) >= 8 \
797 ? 1 * 1024 * 1024 * 1024 \
798 : 32 * 1024 * 1024)
4050c0df
JH
799
800#endif /* NO_MMAP */
801
fcf3a21a
GV
802#ifndef MAP_FAILED
803#define MAP_FAILED ((void *)-1)
804#endif
805
fdb2a2a6
JH
806#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
807#define on_disk_bytes(st) ((st).st_size)
808#else
809#define on_disk_bytes(st) ((st).st_blocks * 512)
810#endif
811
d543d9c0
DM
812#ifdef NEEDS_MODE_TRANSLATION
813#undef S_IFMT
814#undef S_IFREG
815#undef S_IFDIR
816#undef S_IFLNK
817#undef S_IFBLK
818#undef S_IFCHR
819#undef S_IFIFO
820#undef S_IFSOCK
821#define S_IFMT 0170000
822#define S_IFREG 0100000
823#define S_IFDIR 0040000
824#define S_IFLNK 0120000
825#define S_IFBLK 0060000
826#define S_IFCHR 0020000
827#define S_IFIFO 0010000
828#define S_IFSOCK 0140000
829#ifdef stat
830#undef stat
831#endif
832#define stat(path, buf) git_stat(path, buf)
55454427 833int git_stat(const char *, struct stat *);
d543d9c0
DM
834#ifdef fstat
835#undef fstat
836#endif
837#define fstat(fd, buf) git_fstat(fd, buf)
55454427 838int git_fstat(int, struct stat *);
d543d9c0
DM
839#ifdef lstat
840#undef lstat
841#endif
842#define lstat(path, buf) git_lstat(path, buf)
55454427 843int git_lstat(const char *, struct stat *);
d543d9c0
DM
844#endif
845
22bac0ea 846#define DEFAULT_PACKED_GIT_LIMIT \
be4ca290 847 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
8c82534d 848
6900679c
SH
849#ifdef NO_PREAD
850#define pread git_pread
55454427 851ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
6900679c
SH
852#endif
853
4050c0df
JH
854#ifdef NO_SETENV
855#define setenv gitsetenv
55454427 856int gitsetenv(const char *, const char *, int);
4050c0df
JH
857#endif
858
ca5bb5d5
SP
859#ifdef NO_MKDTEMP
860#define mkdtemp gitmkdtemp
55454427 861char *gitmkdtemp(char *);
ca5bb5d5 862#endif
0620b39b 863
731043fd
JR
864#ifdef NO_UNSETENV
865#define unsetenv gitunsetenv
a38989bd 866int gitunsetenv(const char *);
731043fd
JR
867#endif
868
4050c0df
JH
869#ifdef NO_STRCASESTR
870#define strcasestr gitstrcasestr
55454427 871char *gitstrcasestr(const char *haystack, const char *needle);
4050c0df
JH
872#endif
873
817151e6
PE
874#ifdef NO_STRLCPY
875#define strlcpy gitstrlcpy
55454427 876size_t gitstrlcpy(char *, const char *, size_t);
817151e6
PE
877#endif
878
bc6b4f52
JR
879#ifdef NO_STRTOUMAX
880#define strtoumax gitstrtoumax
55454427 881uintmax_t gitstrtoumax(const char *, char **, int);
97000ba6 882#define strtoimax gitstrtoimax
55454427 883intmax_t gitstrtoimax(const char *, char **, int);
bc6b4f52
JR
884#endif
885
fa0c87c3
AR
886#ifdef NO_HSTRERROR
887#define hstrerror githstrerror
55454427 888const char *githstrerror(int herror);
fa0c87c3
AR
889#endif
890
b21b9f1d
RS
891#ifdef NO_MEMMEM
892#define memmem gitmemmem
893void *gitmemmem(const void *haystack, size_t haystacklen,
ec36c42a 894 const void *needle, size_t needlelen);
b21b9f1d
RS
895#endif
896
ca2baa3f
RS
897#ifdef OVERRIDE_STRDUP
898#ifdef strdup
899#undef strdup
900#endif
901#define strdup gitstrdup
902char *gitstrdup(const char *s);
903#endif
b21b9f1d 904
40036bed
MK
905#ifdef NO_GETPAGESIZE
906#define getpagesize() sysconf(_SC_PAGESIZE)
907#endif
908
05d1ed61
BW
909#ifndef O_CLOEXEC
910#define O_CLOEXEC 0
911#endif
912
cba22528 913#ifdef FREAD_READS_DIRECTORIES
b0a642ac
RJ
914# if !defined(SUPPRESS_FOPEN_REDEFINITION)
915# ifdef fopen
916# undef fopen
917# endif
918# define fopen(a,b) git_fopen(a,b)
919# endif
55454427 920FILE *git_fopen(const char*, const char*);
cba22528
BC
921#endif
922
c4582f93 923#ifdef SNPRINTF_RETURNS_BOGUS
ab03803c
BS
924#ifdef snprintf
925#undef snprintf
926#endif
c4582f93 927#define snprintf git_snprintf
b199d714 928int git_snprintf(char *str, size_t maxsize,
ad6dad09 929 const char *format, ...);
ab03803c
BS
930#ifdef vsnprintf
931#undef vsnprintf
932#endif
c4582f93 933#define vsnprintf git_vsnprintf
55454427 934int git_vsnprintf(char *str, size_t maxsize,
ad6dad09 935 const char *format, va_list ap);
c4582f93
MR
936#endif
937
2b081012
JK
938#ifdef OPEN_RETURNS_EINTR
939#undef open
940#define open git_open_with_retry
941int git_open_with_retry(const char *path, int flag, ...);
942#endif
943
726c8ef5
JS
944#ifdef __GLIBC_PREREQ
945#if __GLIBC_PREREQ(2, 1)
946#define HAVE_STRCHRNUL
947#endif
948#endif
949
950#ifndef HAVE_STRCHRNUL
659c69cf 951#define strchrnul gitstrchrnul
9e79f00f
AE
952static inline char *gitstrchrnul(const char *s, int c)
953{
954 while (*s && *s != c)
955 s++;
956 return (char *)s;
957}
659c69cf
RS
958#endif
959
da523cc5
MP
960#ifdef NO_INET_PTON
961int inet_pton(int af, const char *src, void *dst);
962#endif
963
964#ifdef NO_INET_NTOP
965const char *inet_ntop(int af, const void *src, char *dst, size_t size);
966#endif
967
0f4b6db3
EB
968#ifdef NO_PTHREADS
969#define atexit git_atexit
55454427 970int git_atexit(void (*handler)(void));
0f4b6db3
EB
971#endif
972
320d0b49
JK
973static inline size_t st_add(size_t a, size_t b)
974{
975 if (unsigned_add_overflows(a, b))
976 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
977 (uintmax_t)a, (uintmax_t)b);
978 return a + b;
979}
d616fbf2
ES
980#define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
981#define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
320d0b49
JK
982
983static inline size_t st_mult(size_t a, size_t b)
984{
985 if (unsigned_mult_overflows(a, b))
986 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
987 (uintmax_t)a, (uintmax_t)b);
988 return a * b;
989}
990
991static inline size_t st_sub(size_t a, size_t b)
992{
993 if (a < b)
994 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
995 (uintmax_t)a, (uintmax_t)b);
996 return a - b;
997}
a9a74636 998
e2ffeae3
JS
999static inline size_t st_left_shift(size_t a, unsigned shift)
1000{
1001 if (unsigned_left_shift_overflows(a, shift))
1002 die("size_t overflow: %"PRIuMAX" << %u",
1003 (uintmax_t)a, shift);
1004 return a << shift;
1005}
1006
1007static inline unsigned long cast_size_t_to_ulong(size_t a)
1008{
1009 if (a != (unsigned long)a)
1010 die("object too large to read on this platform: %"
1011 PRIuMAX" is cut off to %lu",
1012 (uintmax_t)a, (unsigned long)a);
1013 return (unsigned long)a;
1014}
1015
48050c42
PS
1016static inline int cast_size_t_to_int(size_t a)
1017{
1018 if (a > INT_MAX)
1019 die("number too large to represent as int on this platform: %"PRIuMAX,
1020 (uintmax_t)a);
1021 return (int)a;
1022}
1023
ec4f39b2
JK
1024/*
1025 * Limit size of IO chunks, because huge chunks only cause pain. OS X
1026 * 64-bit is buggy, returning EINVAL if len >= INT_MAX; and even in
1027 * the absence of bugs, large chunks can result in bad latencies when
1028 * you decide to kill the process.
1029 *
1030 * We pick 8 MiB as our default, but if the platform defines SSIZE_MAX
1031 * that is smaller than that, clip it to SSIZE_MAX, as a call to
1032 * read(2) or write(2) larger than that is allowed to fail. As the last
1033 * resort, we allow a port to pass via CFLAGS e.g. "-DMAX_IO_SIZE=value"
1034 * to override this, if the definition of SSIZE_MAX given by the platform
1035 * is broken.
1036 */
1037#ifndef MAX_IO_SIZE
1038# define MAX_IO_SIZE_DEFAULT (8*1024*1024)
1039# if defined(SSIZE_MAX) && (SSIZE_MAX < MAX_IO_SIZE_DEFAULT)
1040# define MAX_IO_SIZE SSIZE_MAX
1041# else
1042# define MAX_IO_SIZE MAX_IO_SIZE_DEFAULT
1043# endif
1044#endif
1045
61f76a36
KS
1046#ifdef HAVE_ALLOCA_H
1047# include <alloca.h>
1048# define xalloca(size) (alloca(size))
1049# define xalloca_free(p) do {} while (0)
1050#else
1051# define xalloca(size) (xmalloc(size))
1052# define xalloca_free(p) (free(p))
1053#endif
14570dc6 1054
481df65f
ÆAB
1055/*
1056 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
1057 * that ptr is used twice, so don't pass e.g. ptr++.
1058 */
1059#define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
1060
e7792a74 1061#define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
f1121499 1062#define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
e7792a74 1063#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
3ac22f82 1064
60566cbb 1065#define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
1891846f 1066 BARF_UNLESS_COPYABLE((dst), (src)))
60566cbb
RS
1067static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
1068{
1069 if (n)
1070 memcpy(dst, src, st_mult(size, n));
1071}
1072
57839807 1073#define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
1891846f 1074 BARF_UNLESS_COPYABLE((dst), (src)))
57839807
RS
1075static inline void move_array(void *dst, const void *src, size_t n, size_t size)
1076{
1077 if (n)
1078 memmove(dst, src, st_mult(size, n));
1079}
1080
d2ec87a6
RS
1081#define DUP_ARRAY(dst, src, n) do { \
1082 size_t dup_array_n_ = (n); \
1083 COPY_ARRAY(ALLOC_ARRAY((dst), dup_array_n_), (src), dup_array_n_); \
1084} while (0)
1085
36895391
JK
1086/*
1087 * These functions help you allocate structs with flex arrays, and copy
1088 * the data directly into the array. For example, if you had:
1089 *
1090 * struct foo {
1091 * int bar;
1092 * char name[FLEX_ARRAY];
1093 * };
1094 *
1095 * you can do:
1096 *
1097 * struct foo *f;
1098 * FLEX_ALLOC_MEM(f, name, src, len);
1099 *
1100 * to allocate a "foo" with the contents of "src" in the "name" field.
1101 * The resulting struct is automatically zero'd, and the flex-array field
1102 * is NUL-terminated (whether the incoming src buffer was or not).
1103 *
1104 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
1105 * but do want to store a pointer to some extra data in the same allocated
1106 * block. For example, if you have:
1107 *
1108 * struct foo {
1109 * char *name;
1110 * int bar;
1111 * };
1112 *
1113 * you can do:
1114 *
1115 * struct foo *f;
0bb1519f 1116 * FLEXPTR_ALLOC_STR(f, name, src);
36895391
JK
1117 *
1118 * and "name" will point to a block of memory after the struct, which will be
1119 * freed along with the struct (but the pointer can be repointed anywhere).
1120 *
1121 * The *_STR variants accept a string parameter rather than a ptr/len
1122 * combination.
1123 *
1124 * Note that these macros will evaluate the first parameter multiple
1125 * times, and it must be assignable as an lvalue.
1126 */
1127#define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
e9451782
RS
1128 size_t flex_array_len_ = (len); \
1129 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1130 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
36895391
JK
1131} while (0)
1132#define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
0ac52a38
RS
1133 size_t flex_array_len_ = (len); \
1134 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1135 memcpy((x) + 1, (buf), flex_array_len_); \
36895391
JK
1136 (x)->ptrname = (void *)((x)+1); \
1137} while(0)
1138#define FLEX_ALLOC_STR(x, flexname, str) \
1139 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1140#define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1141 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1142
91c080df
CW
1143#define alloc_nr(x) (((x)+16)*3/2)
1144
1145/**
1146 * Dynamically growing an array using realloc() is error prone and boring.
1147 *
1148 * Define your array with:
1149 *
1150 * - a pointer (`item`) that points at the array, initialized to `NULL`
1151 * (although please name the variable based on its contents, not on its
1152 * type);
1153 *
1154 * - an integer variable (`alloc`) that keeps track of how big the current
1155 * allocation is, initialized to `0`;
1156 *
1157 * - another integer variable (`nr`) to keep track of how many elements the
1158 * array currently has, initialized to `0`.
1159 *
1160 * Then before adding `n`th element to the item, call `ALLOC_GROW(item, n,
1161 * alloc)`. This ensures that the array can hold at least `n` elements by
1162 * calling `realloc(3)` and adjusting `alloc` variable.
1163 *
1164 * ------------
1165 * sometype *item;
1166 * size_t nr;
1167 * size_t alloc
1168 *
1169 * for (i = 0; i < nr; i++)
1170 * if (we like item[i] already)
1171 * return;
1172 *
1173 * // we did not like any existing one, so add one
1174 * ALLOC_GROW(item, nr + 1, alloc);
1175 * item[nr++] = value you like;
1176 * ------------
1177 *
1178 * You are responsible for updating the `nr` variable.
1179 *
1180 * If you need to specify the number of elements to allocate explicitly
1181 * then use the macro `REALLOC_ARRAY(item, alloc)` instead of `ALLOC_GROW`.
1182 *
1183 * Consider using ALLOC_GROW_BY instead of ALLOC_GROW as it has some
1184 * added niceties.
1185 *
1186 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
1187 */
1188#define ALLOC_GROW(x, nr, alloc) \
1189 do { \
1190 if ((nr) > alloc) { \
1191 if (alloc_nr(alloc) < (nr)) \
1192 alloc = (nr); \
1193 else \
1194 alloc = alloc_nr(alloc); \
1195 REALLOC_ARRAY(x, alloc); \
1196 } \
1197 } while (0)
1198
1199/*
1200 * Similar to ALLOC_GROW but handles updating of the nr value and
1201 * zeroing the bytes of the newly-grown array elements.
1202 *
1203 * DO NOT USE any expression with side-effect for any of the
1204 * arguments.
1205 */
1206#define ALLOC_GROW_BY(x, nr, increase, alloc) \
1207 do { \
1208 if (increase) { \
1209 size_t new_nr = nr + (increase); \
1210 if (new_nr < nr) \
1211 BUG("negative growth in ALLOC_GROW_BY"); \
1212 ALLOC_GROW(x, new_nr, alloc); \
1213 memset((x) + nr, 0, sizeof(*(x)) * (increase)); \
1214 nr = new_nr; \
1215 } \
1216 } while (0)
1217
d64ea0f8
JK
1218static inline char *xstrdup_or_null(const char *str)
1219{
1220 return str ? xstrdup(str) : NULL;
1221}
1222
dc49cd76
SP
1223static inline size_t xsize_t(off_t len)
1224{
aafa5df0 1225 if (len < 0 || (uintmax_t) len > SIZE_MAX)
46be82df 1226 die("Cannot handle files this big");
aafa5df0 1227 return (size_t) len;
dc49cd76
SP
1228}
1229
da25bdb7
RS
1230#ifndef HOST_NAME_MAX
1231#define HOST_NAME_MAX 256
1232#endif
1233
1890ce84 1234#include "sane-ctype.h"
43ccdf56 1235
41a80924
JK
1236/*
1237 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1238 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1239 * locale-specific conversions).
1240 */
1241static inline int skip_iprefix(const char *str, const char *prefix,
1242 const char **out)
1243{
1244 do {
1245 if (!*prefix) {
1246 *out = str;
1247 return 1;
1248 }
1249 } while (tolower(*str++) == tolower(*prefix++));
1250 return 0;
1251}
1252
6b8dda9a
MJC
1253/*
1254 * Like skip_prefix_mem, but compare case-insensitively. Note that the
1255 * comparison is done via tolower(), so it is strictly ASCII (no multi-byte
1256 * characters or locale-specific conversions).
1257 */
1258static inline int skip_iprefix_mem(const char *buf, size_t len,
1259 const char *prefix,
1260 const char **out, size_t *outlen)
1261{
1262 do {
1263 if (!*prefix) {
1264 *out = buf;
1265 *outlen = len;
1266 return 1;
1267 }
1268 } while (len-- > 0 && tolower(*buf++) == tolower(*prefix++));
1269 return 0;
1270}
1271
6aead43d
JM
1272static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1273{
1274 unsigned long ul;
1275 char *p;
1276
1277 errno = 0;
e6f2599c
MM
1278 /* negative values would be accepted by strtoul */
1279 if (strchr(s, '-'))
1280 return -1;
6aead43d
JM
1281 ul = strtoul(s, &p, base);
1282 if (errno || *p || p == s || (unsigned int) ul != ul)
1283 return -1;
1284 *result = ul;
1285 return 0;
1286}
1287
7791ecbc
JH
1288static inline int strtol_i(char const *s, int base, int *result)
1289{
1290 long ul;
1291 char *p;
1292
1293 errno = 0;
1294 ul = strtol(s, &p, base);
1295 if (errno || *p || p == s || (int) ul != ul)
1296 return -1;
1297 *result = ul;
1298 return 0;
1299}
1300
97fff610
JS
1301void git_stable_qsort(void *base, size_t nmemb, size_t size,
1302 int(*compar)(const void *, const void *));
43fe901b 1303#ifdef INTERNAL_QSORT
97fff610 1304#define qsort git_stable_qsort
43fe901b
BD
1305#endif
1306
dbc540c7
RS
1307#define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1308static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1309 int(*compar)(const void *, const void *))
1310{
1311 if (nmemb > 1)
1312 qsort(base, nmemb, size, compar);
1313}
1314
97fff610
JS
1315#define STABLE_QSORT(base, n, compar) \
1316 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1317
04ee8b87
RS
1318#ifndef HAVE_ISO_QSORT_S
1319int git_qsort_s(void *base, size_t nmemb, size_t size,
1320 int (*compar)(const void *, const void *, void *), void *ctx);
1321#define qsort_s git_qsort_s
1322#endif
1323
3ca86994
RS
1324#define QSORT_S(base, n, compar, ctx) do { \
1325 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
c3c3486b 1326 BUG("qsort_s() failed"); \
3ca86994
RS
1327} while (0)
1328
2f895225
JS
1329#ifndef REG_STARTEND
1330#error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1331#endif
1332
1333static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1334 size_t nmatch, regmatch_t pmatch[], int eflags)
1335{
1336 assert(nmatch > 0 && pmatch);
1337 pmatch[0].rm_so = 0;
1338 pmatch[0].rm_eo = size;
1339 return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1340}
1341
54463d32
RS
1342#ifdef USE_ENHANCED_BASIC_REGULAR_EXPRESSIONS
1343int git_regcomp(regex_t *preg, const char *pattern, int cflags);
1344#define regcomp git_regcomp
1345#endif
1346
81a24b52
AR
1347#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1348# define FORCE_DIR_SET_GID S_ISGID
1349#else
1350# define FORCE_DIR_SET_GID 0
1351#endif
1352
c06ff490
KB
1353#ifdef NO_NSEC
1354#undef USE_NSEC
1355#define ST_CTIME_NSEC(st) 0
1356#define ST_MTIME_NSEC(st) 0
1357#else
c567383b
BG
1358#ifdef USE_ST_TIMESPEC
1359#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1360#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1361#else
c06ff490
KB
1362#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1363#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1364#endif
c567383b 1365#endif
c06ff490 1366
34779c53
JS
1367#ifdef UNRELIABLE_FSTAT
1368#define fstat_is_reliable() 0
1369#else
1370#define fstat_is_reliable() 1
1371#endif
1372
ab8632ae 1373#ifndef va_copy
26db0f2e
JN
1374/*
1375 * Since an obvious implementation of va_list would be to make it a
1376 * pointer into the stack frame, a simple assignment will work on
1377 * many systems. But let's try to be more portable.
1378 */
1379#ifdef __va_copy
1380#define va_copy(dst, src) __va_copy(dst, src)
1381#else
1382#define va_copy(dst, src) ((dst) = (src))
1383#endif
ab8632ae
JK
1384#endif
1385
746ea4ad
RJ
1386/* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1387extern int BUG_exit_code;
1388
0cc05b04
ÆAB
1389/* usage.c: if bug() is called we should have a BUG_if_bug() afterwards */
1390extern int bug_called_must_BUG;
1391
d8193743
JK
1392__attribute__((format (printf, 3, 4))) NORETURN
1393void BUG_fl(const char *file, int line, const char *fmt, ...);
1394#define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
0cc05b04
ÆAB
1395__attribute__((format (printf, 3, 4)))
1396void bug_fl(const char *file, int line, const char *fmt, ...);
1397#define bug(...) bug_fl(__FILE__, __LINE__, __VA_ARGS__)
1398#define BUG_if_bug(...) do { \
1399 if (bug_called_must_BUG) \
1400 BUG_fl(__FILE__, __LINE__, __VA_ARGS__); \
1401} while (0)
d8193743 1402
8a94d833 1403#ifndef FSYNC_METHOD_DEFAULT
abf38abe
NS
1404#ifdef __APPLE__
1405#define FSYNC_METHOD_DEFAULT FSYNC_METHOD_WRITEOUT_ONLY
1406#else
1407#define FSYNC_METHOD_DEFAULT FSYNC_METHOD_FSYNC
1408#endif
8a94d833 1409#endif
abf38abe 1410
1b56cdf9
KM
1411#ifndef SHELL_PATH
1412# define SHELL_PATH "/bin/sh"
1413#endif
1414
f43cce23 1415#ifndef _POSIX_THREAD_SAFE_FUNCTIONS
efcc48ef 1416static inline void git_flockfile(FILE *fh UNUSED)
15b52a44
JH
1417{
1418 ; /* nothing */
1419}
efcc48ef 1420static inline void git_funlockfile(FILE *fh UNUSED)
15b52a44
JH
1421{
1422 ; /* nothing */
1423}
e1a95b78
JK
1424#undef flockfile
1425#undef funlockfile
1426#undef getc_unlocked
e0c08a4f
JK
1427#define flockfile(fh) git_flockfile(fh)
1428#define funlockfile(fh) git_funlockfile(fh)
f43cce23
JK
1429#define getc_unlocked(fh) getc(fh)
1430#endif
1431
18a4f6be
NTND
1432#ifdef FILENO_IS_A_MACRO
1433int git_fileno(FILE *stream);
400caafb 1434# ifndef COMPAT_CODE_FILENO
18a4f6be
NTND
1435# undef fileno
1436# define fileno(p) git_fileno(p)
1437# endif
1438#endif
1439
400caafb
CC
1440#ifdef NEED_ACCESS_ROOT_HANDLER
1441int git_access(const char *path, int mode);
1442# ifndef COMPAT_CODE_ACCESS
1443# ifdef access
1444# undef access
1445# endif
1446# define access(path, mode) git_access(path, mode)
1447# endif
1448#endif
1449
dc5a18b3
JH
1450/*
1451 * Our code often opens a path to an optional file, to work on its
1452 * contents when we can successfully open it. We can ignore a failure
1453 * to open if such an optional file does not exist, but we do want to
1454 * report a failure in opening for other reasons (e.g. we got an I/O
1455 * error, or the file is there, but we lack the permission to open).
1456 *
1457 * Call this function after seeing an error from open() or fopen() to
1458 * see if the errno indicates a missing file that we can safely ignore.
1459 */
1460static inline int is_missing_file_error(int errno_)
1461{
1462 return (errno_ == ENOENT || errno_ == ENOTDIR);
1463}
1464
55454427 1465int cmd_main(int, const char **);
5c238e29 1466
ee4512ed
JH
1467/*
1468 * Intercept all calls to exit() and route them to trace2 to
1469 * optionally emit a message before calling the real exit().
1470 */
19d75948
ÆAB
1471int common_exit(const char *file, int line, int code);
1472#define exit(code) exit(common_exit(__FILE__, __LINE__, (code)))
ee4512ed 1473
0e5bba53
JK
1474/*
1475 * You can mark a stack variable with UNLEAK(var) to avoid it being
1476 * reported as a leak by tools like LSAN or valgrind. The argument
1477 * should generally be the variable itself (not its address and not what
1478 * it points to). It's safe to use this on pointers which may already
1479 * have been freed, or on pointers which may still be in use.
1480 *
1481 * Use this _only_ for a variable that leaks by going out of scope at
1482 * program exit (so only from cmd_* functions or their direct helpers).
1483 * Normal functions, especially those which may be called multiple
1484 * times, should actually free their memory. This is only meant as
1485 * an annotation, and does nothing in non-leak-checking builds.
1486 */
1487#ifdef SUPPRESS_ANNOTATED_LEAKS
55454427 1488void unleak_memory(const void *ptr, size_t len);
5de3de32 1489#define UNLEAK(var) unleak_memory(&(var), sizeof(var))
0e5bba53 1490#else
5de3de32 1491#define UNLEAK(var) do {} while (0)
0e5bba53
JK
1492#endif
1493
07564773
ÆAB
1494#define z_const
1495#include <zlib.h>
1496
1497#if ZLIB_VERNUM < 0x1290
1498/*
1499 * This is uncompress2, which is only available in zlib >= 1.2.9
1500 * (released as of early 2017). See compat/zlib-uncompress2.c.
1501 */
1502int uncompress2(Bytef *dest, uLongf *destLen, const Bytef *source,
1503 uLong *sourceLen);
1504#endif
1505
c8af66ab
JK
1506/*
1507 * This include must come after system headers, since it introduces macros that
1508 * replace system names.
1509 */
1510#include "banned.h"
1511
973d5eea
EW
1512/*
1513 * container_of - Get the address of an object containing a field.
1514 *
1515 * @ptr: pointer to the field.
1516 * @type: type of the object.
1517 * @member: name of the field within the object.
1518 */
1519#define container_of(ptr, type, member) \
1520 ((type *) ((char *)(ptr) - offsetof(type, member)))
1521
f0e63c41
EW
1522/*
1523 * helper function for `container_of_or_null' to avoid multiple
1524 * evaluation of @ptr
1525 */
1526static inline void *container_of_or_null_offset(void *ptr, size_t offset)
1527{
1528 return ptr ? (char *)ptr - offset : NULL;
1529}
1530
1531/*
1532 * like `container_of', but allows returned value to be NULL
1533 */
1534#define container_of_or_null(ptr, type, member) \
1535 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1536
23dee69f 1537/*
abcb66c6 1538 * like offsetof(), but takes a pointer to a variable of type which
23dee69f
EW
1539 * contains @member, instead of a specified type.
1540 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1541 * everywhere.
1542 */
1543#if defined(__GNUC__) /* clang sets this, too */
1544#define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1545#else /* !__GNUC__ */
1546#define OFFSETOF_VAR(ptr, member) \
1547 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1548#endif /* !__GNUC__ */
1549
5c238e29 1550#endif