]> git.ipfire.org Git - thirdparty/git.git/blame - git-compat-util.h
add DUP_ARRAY
[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
7f9e848c
JS
342#ifdef NO_STRUCT_ITIMERVAL
343struct itimerval {
344 struct timeval it_interval;
345 struct timeval it_value;
981ff520 346};
7f9e848c
JS
347#endif
348
349#ifdef NO_SETITIMER
efcc48ef
JH
350static inline int git_setitimer(int which UNUSED,
351 const struct itimerval *value UNUSED,
352 struct itimerval *newvalue UNUSED) {
14639a47 353 return 0; /* pretend success */
15b52a44 354}
e1a95b78 355#undef setitimer
e0c08a4f 356#define setitimer(which,value,ovalue) git_setitimer(which,value,ovalue)
7f9e848c
JS
357#endif
358
e1c06886
DA
359#ifndef NO_LIBGEN_H
360#include <libgen.h>
361#else
362#define basename gitbasename
55454427 363char *gitbasename(char *);
824682ab 364#define dirname gitdirname
55454427 365char *gitdirname(char *);
e1c06886
DA
366#endif
367
85023577
JH
368#ifndef NO_ICONV
369#include <iconv.h>
370#endif
4050c0df 371
684ec6c6 372#ifndef NO_OPENSSL
88c03eb5 373#ifdef __APPLE__
b195aa00 374#define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
88c03eb5
KM
375#include <AvailabilityMacros.h>
376#undef DEPRECATED_ATTRIBUTE
377#define DEPRECATED_ATTRIBUTE
378#undef __AVAILABILITY_MACROS_USES_AVAILABILITY
379#endif
684ec6c6
RS
380#include <openssl/ssl.h>
381#include <openssl/err.h>
382#endif
383
9806f5a7
NTND
384#ifdef HAVE_SYSINFO
385# include <sys/sysinfo.h>
386#endif
387
3b130ade
DM
388/* On most systems <netdb.h> would have given us this, but
389 * not on some systems (e.g. z/OS).
390 */
391#ifndef NI_MAXHOST
392#define NI_MAXHOST 1025
393#endif
394
395#ifndef NI_MAXSERV
396#define NI_MAXSERV 32
397#endif
398
d0c2449f
JH
399/* On most systems <limits.h> would have given us this, but
400 * not on some systems (e.g. GNU/Hurd).
401 */
402#ifndef PATH_MAX
403#define PATH_MAX 4096
404#endif
405
28f4aee3
JS
406typedef uintmax_t timestamp_t;
407#define PRItime PRIuMAX
408#define parse_timestamp strtoumax
409#define TIME_MAX UINTMAX_MAX
2e09c012 410#define TIME_MIN 0
1aeb7e75 411
80ba074f
JS
412#ifndef PATH_SEP
413#define PATH_SEP ':'
414#endif
415
cb6a22c0
CW
416#ifdef HAVE_PATHS_H
417#include <paths.h>
418#endif
419#ifndef _PATH_DEFPATH
420#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
421#endif
422
70fc5793 423#ifndef platform_core_config
5cf88fd8
ÆAB
424static inline int noop_core_config(const char *var UNUSED,
425 const char *value UNUSED,
426 void *cb UNUSED)
70fc5793
JS
427{
428 return 0;
429}
430#define platform_core_config noop_core_config
431#endif
432
684dd4c2
MT
433int lstat_cache_aware_rmdir(const char *path);
434#if !defined(__MINGW32__) && !defined(_MSC_VER)
435#define rmdir lstat_cache_aware_rmdir
436#endif
437
25fe217b 438#ifndef has_dos_drive_prefix
808e9195 439static inline int git_has_dos_drive_prefix(const char *path UNUSED)
bf728346
RS
440{
441 return 0;
442}
443#define has_dos_drive_prefix git_has_dos_drive_prefix
25fe217b
JS
444#endif
445
2f36eed9 446#ifndef skip_dos_drive_prefix
808e9195 447static inline int git_skip_dos_drive_prefix(char **path UNUSED)
2f36eed9
JS
448{
449 return 0;
450}
451#define skip_dos_drive_prefix git_skip_dos_drive_prefix
452#endif
453
bf728346
RS
454static inline int git_is_dir_sep(int c)
455{
456 return c == '/';
457}
9fd512c8 458#ifndef is_dir_sep
bf728346 459#define is_dir_sep git_is_dir_sep
c2369bdf
CZ
460#endif
461
bf728346
RS
462#ifndef offset_1st_component
463static inline int git_offset_1st_component(const char *path)
464{
465 return is_dir_sep(path[0]);
466}
467#define offset_1st_component git_offset_1st_component
25fe217b
JS
468#endif
469
d2c84dad
JS
470#ifndef is_valid_path
471#define is_valid_path(path) 1
472#endif
473
bdc77d1d 474#ifndef is_path_owned_by_current_user
ae9abbb6
CMAB
475
476#ifdef __TANDEM
477#define ROOT_UID 65535
478#else
479#define ROOT_UID 0
480#endif
481
482/*
483 * Do not use this function when
484 * (1) geteuid() did not say we are running as 'root', or
485 * (2) using this function will compromise the system.
486 *
487 * PORTABILITY WARNING:
488 * This code assumes uid_t is unsigned because that is what sudo does.
489 * If your uid_t type is signed and all your ids are positive then it
490 * should all work fine.
491 * If your version of sudo uses negative values for uid_t or it is
492 * buggy and return an overflowed value in SUDO_UID, then git might
493 * fail to grant access to your repository properly or even mistakenly
494 * grant access to someone else.
495 * In the unlikely scenario this happened to you, and that is how you
496 * got to this message, we would like to know about it; so sent us an
497 * email to git@vger.kernel.org indicating which platform you are
498 * using and which version of sudo, so we can improve this logic and
499 * maybe provide you with a patch that would prevent this issue again
500 * in the future.
501 */
502static inline void extract_id_from_env(const char *env, uid_t *id)
503{
504 const char *real_uid = getenv(env);
505
506 /* discard anything empty to avoid a more complex check below */
507 if (real_uid && *real_uid) {
508 char *endptr = NULL;
509 unsigned long env_id;
510
511 errno = 0;
512 /* silent overflow errors could trigger a bug here */
513 env_id = strtoul(real_uid, &endptr, 10);
514 if (!*endptr && !errno)
515 *id = env_id;
516 }
517}
518
776515ef 519static inline int is_path_owned_by_current_uid(const char *path,
5cf88fd8 520 struct strbuf *report UNUSED)
bdc77d1d
JS
521{
522 struct stat st;
ae9abbb6
CMAB
523 uid_t euid;
524
bdc77d1d
JS
525 if (lstat(path, &st))
526 return 0;
ae9abbb6
CMAB
527
528 euid = geteuid();
529 if (euid == ROOT_UID)
6b11e3d5
CMAB
530 {
531 if (st.st_uid == ROOT_UID)
532 return 1;
533 else
534 extract_id_from_env("SUDO_UID", &euid);
535 }
ae9abbb6
CMAB
536
537 return st.st_uid == euid;
bdc77d1d
JS
538}
539
540#define is_path_owned_by_current_user is_path_owned_by_current_uid
541#endif
542
d1c69255 543#ifndef find_last_dir_sep
bf728346
RS
544static inline char *git_find_last_dir_sep(const char *path)
545{
546 return strrchr(path, '/');
547}
548#define find_last_dir_sep git_find_last_dir_sep
d1c69255
TN
549#endif
550
05ac8582
AK
551#ifndef has_dir_sep
552static inline int git_has_dir_sep(const char *path)
553{
554 return !!strchr(path, '/');
555}
556#define has_dir_sep(path) git_has_dir_sep(path)
557#endif
558
501afcb8
JS
559#ifndef query_user_email
560#define query_user_email() NULL
561#endif
562
1305ef37
RB
563#ifdef __TANDEM
564#include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
565#include <floss.h(floss_getpwuid)>
566#ifndef NSIG
567/*
568 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
569 * known, by detective work using kill -l as a list is all signals
570 * instead of signal.h where it should be.
571 */
572# define NSIG 100
573#endif
574#endif
575
e4ac953b 576#if defined(__HP_cc) && (__HP_cc >= 61000)
b6ab349b
MR
577#define NORETURN __attribute__((noreturn))
578#define NORETURN_PTR
6520c846 579#elif defined(__GNUC__) && !defined(NO_NORETURN)
4050c0df 580#define NORETURN __attribute__((__noreturn__))
18660bc9 581#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8
RJ
582#elif defined(_MSC_VER)
583#define NORETURN __declspec(noreturn)
584#define NORETURN_PTR
4050c0df
JH
585#else
586#define NORETURN
18660bc9 587#define NORETURN_PTR
8cd7ebc8 588#ifndef __GNUC__
4050c0df
JH
589#ifndef __attribute__
590#define __attribute__(x)
591#endif
592#endif
8cd7ebc8 593#endif
4050c0df 594
9fe3edc4
RJ
595/* The sentinel attribute is valid from gcc version 4.0 */
596#if defined(__GNUC__) && (__GNUC__ >= 4)
597#define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
1e8697b5
ÆAB
598/* warn_unused_result exists as of gcc 3.4.0, but be lazy and check 4.0 */
599#define RESULT_MUST_BE_USED __attribute__ ((warn_unused_result))
9fe3edc4
RJ
600#else
601#define LAST_ARG_MUST_BE_NULL
1e8697b5 602#define RESULT_MUST_BE_USED
9fe3edc4
RJ
603#endif
604
bbd8eb3e
CMAB
605#define MAYBE_UNUSED __attribute__((__unused__))
606
51ea5519
NP
607#include "compat/bswap.h"
608
cebcab18 609#include "wildmatch.h"
cebcab18 610
9ccc0c08
RS
611struct strbuf;
612
4050c0df 613/* General helper functions */
55454427 614NORETURN void usage(const char *err);
b199d714
DL
615NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
616NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
617NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
18568ee8 618int die_message(const char *err, ...) __attribute__((format (printf, 1, 2)));
24f6e6d6 619int die_message_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
b199d714
DL
620int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
621int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
622void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
623void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 624
f2be034c
BG
625#ifndef NO_OPENSSL
626#ifdef APPLE_COMMON_CRYPTO
627#include "compat/apple-common-crypto.h"
628#else
629#include <openssl/evp.h>
630#include <openssl/hmac.h>
631#endif /* APPLE_COMMON_CRYPTO */
632#include <openssl/x509v3.h>
633#endif /* NO_OPENSSL */
634
5b52d9f1
CMAB
635#ifdef HAVE_OPENSSL_CSPRNG
636#include <openssl/rand.h>
637#endif
638
e208f9cc
JK
639/*
640 * Let callers be aware of the constant return value; this can help
9798f7e5 641 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
b7ba8587 642 * because other compilers may be confused by this.
e208f9cc 643 */
ff0a80af 644#if defined(__GNUC__)
87fe5df3
JK
645static inline int const_error(void)
646{
647 return -1;
648}
649#define error(...) (error(__VA_ARGS__), const_error())
4df5e918 650#define error_errno(...) (error_errno(__VA_ARGS__), const_error())
e208f9cc
JK
651#endif
652
5710dcce
JK
653typedef void (*report_fn)(const char *, va_list params);
654
655void set_die_routine(NORETURN_PTR report_fn routine);
18568ee8 656report_fn get_die_message_routine(void);
5710dcce
JK
657void set_error_routine(report_fn routine);
658report_fn get_error_routine(void);
659void set_warn_routine(report_fn routine);
660report_fn get_warn_routine(void);
55454427 661void set_die_is_recursing_routine(int (*routine)(void));
39a3f5ea 662
55454427
DL
663int starts_with(const char *str, const char *prefix);
664int istarts_with(const char *str, const char *prefix);
698a68be 665
cf4fff57
JK
666/*
667 * If the string "str" begins with the string found in "prefix", return 1.
668 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
669 * the string right after the prefix).
670 *
671 * Otherwise, return 0 and leave "out" untouched.
672 *
673 * Examples:
674 *
675 * [extract branch name, fail if not a branch]
676 * if (!skip_prefix(ref, "refs/heads/", &branch)
677 * return -1;
678 *
679 * [skip prefix if present, otherwise use whole string]
680 * skip_prefix(name, "refs/heads/", &name);
681 */
682static inline int skip_prefix(const char *str, const char *prefix,
683 const char **out)
fbca5837 684{
ba399c46 685 do {
cf4fff57
JK
686 if (!*prefix) {
687 *out = str;
688 return 1;
689 }
ba399c46 690 } while (*str++ == *prefix++);
cf4fff57 691 return 0;
fbca5837
MV
692}
693
afaef55e
CC
694/*
695 * If the string "str" is the same as the string in "prefix", then the "arg"
696 * parameter is set to the "def" parameter and 1 is returned.
697 * If the string "str" begins with the string found in "prefix" and then a
698 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
699 * (i.e., to the point in the string right after the prefix and the "=" sign),
700 * and 1 is returned.
701 *
702 * Otherwise, return 0 and leave "arg" untouched.
703 *
704 * When we accept both a "--key" and a "--key=<val>" option, this function
705 * can be used instead of !strcmp(arg, "--key") and then
706 * skip_prefix(arg, "--key=", &arg) to parse such an option.
707 */
708int skip_to_optional_arg_default(const char *str, const char *prefix,
709 const char **arg, const char *def);
710
711static inline int skip_to_optional_arg(const char *str, const char *prefix,
712 const char **arg)
713{
714 return skip_to_optional_arg_default(str, prefix, arg, "");
715}
716
ae989a61
JK
717/*
718 * Like skip_prefix, but promises never to read past "len" bytes of the input
719 * buffer, and returns the remaining number of bytes in "out" via "outlen".
720 */
721static inline int skip_prefix_mem(const char *buf, size_t len,
722 const char *prefix,
723 const char **out, size_t *outlen)
724{
725 size_t prefix_len = strlen(prefix);
726 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
727 *out = buf + prefix_len;
728 *outlen = len - prefix_len;
729 return 1;
730 }
731 return 0;
732}
733
35480f0b
JK
734/*
735 * If buf ends with suffix, return 1 and subtract the length of the suffix
736 * from *len. Otherwise, return 0 and leave *len untouched.
737 */
738static inline int strip_suffix_mem(const char *buf, size_t *len,
739 const char *suffix)
740{
741 size_t suflen = strlen(suffix);
742 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
743 return 0;
744 *len -= suflen;
745 return 1;
746}
747
748/*
749 * If str ends with suffix, return 1 and set *len to the size of the string
750 * without the suffix. Otherwise, return 0 and set *len to the size of the
751 * string.
752 *
753 * Note that we do _not_ NUL-terminate str to the new length.
754 */
755static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
756{
757 *len = strlen(str);
758 return strip_suffix_mem(str, len, suffix);
759}
760
f52a35fd
JK
761static inline int ends_with(const char *str, const char *suffix)
762{
763 size_t len;
764 return strip_suffix(str, suffix, &len);
765}
766
568edcb9
RS
767#define SWAP(a, b) do { \
768 void *_swap_a_ptr = &(a); \
769 void *_swap_b_ptr = &(b); \
770 unsigned char _swap_buffer[sizeof(a)]; \
771 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
772 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
773 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
774 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
775} while (0)
776
b130a72b 777#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
778
779#ifndef PROT_READ
780#define PROT_READ 1
781#define PROT_WRITE 2
782#define MAP_PRIVATE 1
4050c0df
JH
783#endif
784
d6779124
SP
785#define mmap git_mmap
786#define munmap git_munmap
55454427
DL
787void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
788int git_munmap(void *start, size_t length);
4050c0df 789
b130a72b
JL
790#else /* NO_MMAP || USE_WIN32_MMAP */
791
792#include <sys/mman.h>
793
794#endif /* NO_MMAP || USE_WIN32_MMAP */
795
796#ifdef NO_MMAP
797
5faaf246 798/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
799#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
800
4050c0df
JH
801#else /* NO_MMAP */
802
5faaf246 803/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
804#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
805 (sizeof(void*) >= 8 \
806 ? 1 * 1024 * 1024 * 1024 \
807 : 32 * 1024 * 1024)
4050c0df
JH
808
809#endif /* NO_MMAP */
810
fcf3a21a
GV
811#ifndef MAP_FAILED
812#define MAP_FAILED ((void *)-1)
813#endif
814
fdb2a2a6
JH
815#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
816#define on_disk_bytes(st) ((st).st_size)
817#else
818#define on_disk_bytes(st) ((st).st_blocks * 512)
819#endif
820
d543d9c0
DM
821#ifdef NEEDS_MODE_TRANSLATION
822#undef S_IFMT
823#undef S_IFREG
824#undef S_IFDIR
825#undef S_IFLNK
826#undef S_IFBLK
827#undef S_IFCHR
828#undef S_IFIFO
829#undef S_IFSOCK
830#define S_IFMT 0170000
831#define S_IFREG 0100000
832#define S_IFDIR 0040000
833#define S_IFLNK 0120000
834#define S_IFBLK 0060000
835#define S_IFCHR 0020000
836#define S_IFIFO 0010000
837#define S_IFSOCK 0140000
838#ifdef stat
839#undef stat
840#endif
841#define stat(path, buf) git_stat(path, buf)
55454427 842int git_stat(const char *, struct stat *);
d543d9c0
DM
843#ifdef fstat
844#undef fstat
845#endif
846#define fstat(fd, buf) git_fstat(fd, buf)
55454427 847int git_fstat(int, struct stat *);
d543d9c0
DM
848#ifdef lstat
849#undef lstat
850#endif
851#define lstat(path, buf) git_lstat(path, buf)
55454427 852int git_lstat(const char *, struct stat *);
d543d9c0
DM
853#endif
854
22bac0ea 855#define DEFAULT_PACKED_GIT_LIMIT \
be4ca290 856 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
8c82534d 857
6900679c
SH
858#ifdef NO_PREAD
859#define pread git_pread
55454427 860ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
6900679c 861#endif
14086b0a
SP
862/*
863 * Forward decl that will remind us if its twin in cache.h changes.
864 * This function is used in compat/pread.c. But we can't include
865 * cache.h there.
866 */
55454427 867ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 868
4050c0df
JH
869#ifdef NO_SETENV
870#define setenv gitsetenv
55454427 871int gitsetenv(const char *, const char *, int);
4050c0df
JH
872#endif
873
ca5bb5d5
SP
874#ifdef NO_MKDTEMP
875#define mkdtemp gitmkdtemp
55454427 876char *gitmkdtemp(char *);
ca5bb5d5 877#endif
0620b39b 878
731043fd
JR
879#ifdef NO_UNSETENV
880#define unsetenv gitunsetenv
a38989bd 881int gitunsetenv(const char *);
731043fd
JR
882#endif
883
4050c0df
JH
884#ifdef NO_STRCASESTR
885#define strcasestr gitstrcasestr
55454427 886char *gitstrcasestr(const char *haystack, const char *needle);
4050c0df
JH
887#endif
888
817151e6
PE
889#ifdef NO_STRLCPY
890#define strlcpy gitstrlcpy
55454427 891size_t gitstrlcpy(char *, const char *, size_t);
817151e6
PE
892#endif
893
bc6b4f52
JR
894#ifdef NO_STRTOUMAX
895#define strtoumax gitstrtoumax
55454427 896uintmax_t gitstrtoumax(const char *, char **, int);
97000ba6 897#define strtoimax gitstrtoimax
55454427 898intmax_t gitstrtoimax(const char *, char **, int);
bc6b4f52
JR
899#endif
900
fa0c87c3
AR
901#ifdef NO_HSTRERROR
902#define hstrerror githstrerror
55454427 903const char *githstrerror(int herror);
fa0c87c3
AR
904#endif
905
b21b9f1d
RS
906#ifdef NO_MEMMEM
907#define memmem gitmemmem
908void *gitmemmem(const void *haystack, size_t haystacklen,
ec36c42a 909 const void *needle, size_t needlelen);
b21b9f1d
RS
910#endif
911
ca2baa3f
RS
912#ifdef OVERRIDE_STRDUP
913#ifdef strdup
914#undef strdup
915#endif
916#define strdup gitstrdup
917char *gitstrdup(const char *s);
918#endif
b21b9f1d 919
40036bed
MK
920#ifdef NO_GETPAGESIZE
921#define getpagesize() sysconf(_SC_PAGESIZE)
922#endif
923
05d1ed61
BW
924#ifndef O_CLOEXEC
925#define O_CLOEXEC 0
926#endif
927
cba22528 928#ifdef FREAD_READS_DIRECTORIES
b0a642ac
RJ
929# if !defined(SUPPRESS_FOPEN_REDEFINITION)
930# ifdef fopen
931# undef fopen
932# endif
933# define fopen(a,b) git_fopen(a,b)
934# endif
55454427 935FILE *git_fopen(const char*, const char*);
cba22528
BC
936#endif
937
c4582f93 938#ifdef SNPRINTF_RETURNS_BOGUS
ab03803c
BS
939#ifdef snprintf
940#undef snprintf
941#endif
c4582f93 942#define snprintf git_snprintf
b199d714 943int git_snprintf(char *str, size_t maxsize,
ad6dad09 944 const char *format, ...);
ab03803c
BS
945#ifdef vsnprintf
946#undef vsnprintf
947#endif
c4582f93 948#define vsnprintf git_vsnprintf
55454427 949int git_vsnprintf(char *str, size_t maxsize,
ad6dad09 950 const char *format, va_list ap);
c4582f93
MR
951#endif
952
2b081012
JK
953#ifdef OPEN_RETURNS_EINTR
954#undef open
955#define open git_open_with_retry
956int git_open_with_retry(const char *path, int flag, ...);
957#endif
958
726c8ef5
JS
959#ifdef __GLIBC_PREREQ
960#if __GLIBC_PREREQ(2, 1)
961#define HAVE_STRCHRNUL
962#endif
963#endif
964
965#ifndef HAVE_STRCHRNUL
659c69cf 966#define strchrnul gitstrchrnul
9e79f00f
AE
967static inline char *gitstrchrnul(const char *s, int c)
968{
969 while (*s && *s != c)
970 s++;
971 return (char *)s;
972}
659c69cf
RS
973#endif
974
da523cc5
MP
975#ifdef NO_INET_PTON
976int inet_pton(int af, const char *src, void *dst);
977#endif
978
979#ifdef NO_INET_NTOP
980const char *inet_ntop(int af, const void *src, char *dst, size_t size);
981#endif
982
0f4b6db3
EB
983#ifdef NO_PTHREADS
984#define atexit git_atexit
55454427 985int git_atexit(void (*handler)(void));
0f4b6db3
EB
986#endif
987
320d0b49
JK
988static inline size_t st_add(size_t a, size_t b)
989{
990 if (unsigned_add_overflows(a, b))
991 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
992 (uintmax_t)a, (uintmax_t)b);
993 return a + b;
994}
d616fbf2
ES
995#define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
996#define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
320d0b49
JK
997
998static inline size_t st_mult(size_t a, size_t b)
999{
1000 if (unsigned_mult_overflows(a, b))
1001 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
1002 (uintmax_t)a, (uintmax_t)b);
1003 return a * b;
1004}
1005
1006static inline size_t st_sub(size_t a, size_t b)
1007{
1008 if (a < b)
1009 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
1010 (uintmax_t)a, (uintmax_t)b);
1011 return a - b;
1012}
a9a74636 1013
e2ffeae3
JS
1014static inline size_t st_left_shift(size_t a, unsigned shift)
1015{
1016 if (unsigned_left_shift_overflows(a, shift))
1017 die("size_t overflow: %"PRIuMAX" << %u",
1018 (uintmax_t)a, shift);
1019 return a << shift;
1020}
1021
1022static inline unsigned long cast_size_t_to_ulong(size_t a)
1023{
1024 if (a != (unsigned long)a)
1025 die("object too large to read on this platform: %"
1026 PRIuMAX" is cut off to %lu",
1027 (uintmax_t)a, (unsigned long)a);
1028 return (unsigned long)a;
1029}
1030
ec4f39b2
JK
1031/*
1032 * Limit size of IO chunks, because huge chunks only cause pain. OS X
1033 * 64-bit is buggy, returning EINVAL if len >= INT_MAX; and even in
1034 * the absence of bugs, large chunks can result in bad latencies when
1035 * you decide to kill the process.
1036 *
1037 * We pick 8 MiB as our default, but if the platform defines SSIZE_MAX
1038 * that is smaller than that, clip it to SSIZE_MAX, as a call to
1039 * read(2) or write(2) larger than that is allowed to fail. As the last
1040 * resort, we allow a port to pass via CFLAGS e.g. "-DMAX_IO_SIZE=value"
1041 * to override this, if the definition of SSIZE_MAX given by the platform
1042 * is broken.
1043 */
1044#ifndef MAX_IO_SIZE
1045# define MAX_IO_SIZE_DEFAULT (8*1024*1024)
1046# if defined(SSIZE_MAX) && (SSIZE_MAX < MAX_IO_SIZE_DEFAULT)
1047# define MAX_IO_SIZE SSIZE_MAX
1048# else
1049# define MAX_IO_SIZE MAX_IO_SIZE_DEFAULT
1050# endif
1051#endif
1052
61f76a36
KS
1053#ifdef HAVE_ALLOCA_H
1054# include <alloca.h>
1055# define xalloca(size) (alloca(size))
1056# define xalloca_free(p) do {} while (0)
1057#else
1058# define xalloca(size) (xmalloc(size))
1059# define xalloca_free(p) (free(p))
1060#endif
55454427
DL
1061char *xstrdup(const char *str);
1062void *xmalloc(size_t size);
1063void *xmallocz(size_t size);
1064void *xmallocz_gently(size_t size);
1065void *xmemdupz(const void *data, size_t len);
1066char *xstrndup(const char *str, size_t len);
1067void *xrealloc(void *ptr, size_t size);
1068void *xcalloc(size_t nmemb, size_t size);
3540c71e 1069void xsetenv(const char *name, const char *value, int overwrite);
55454427 1070void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
dc059294 1071const char *mmap_os_err(void);
55454427 1072void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
b199d714 1073int xopen(const char *path, int flags, ...);
55454427
DL
1074ssize_t xread(int fd, void *buf, size_t len);
1075ssize_t xwrite(int fd, const void *buf, size_t len);
1076ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
1077int xdup(int fd);
1078FILE *xfopen(const char *path, const char *mode);
1079FILE *xfdopen(int fd, const char *mode);
1080int xmkstemp(char *temp_filename);
1081int xmkstemp_mode(char *temp_filename, int mode);
1082char *xgetcwd(void);
1083FILE *fopen_for_writing(const char *path);
1084FILE *fopen_or_warn(const char *path, const char *mode);
f21a47b2 1085
14570dc6 1086/*
1087 * Like strncmp, but only return zero if s is NUL-terminated and exactly len
1088 * characters long. If it is not, consider it greater than t.
1089 */
1090int xstrncmpz(const char *s, const char *t, size_t len);
1091
481df65f
ÆAB
1092/*
1093 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
1094 * that ptr is used twice, so don't pass e.g. ptr++.
1095 */
1096#define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
1097
e7792a74 1098#define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
f1121499 1099#define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
e7792a74 1100#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
3ac22f82 1101
60566cbb 1102#define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
1891846f 1103 BARF_UNLESS_COPYABLE((dst), (src)))
60566cbb
RS
1104static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
1105{
1106 if (n)
1107 memcpy(dst, src, st_mult(size, n));
1108}
1109
57839807 1110#define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
1891846f 1111 BARF_UNLESS_COPYABLE((dst), (src)))
57839807
RS
1112static inline void move_array(void *dst, const void *src, size_t n, size_t size)
1113{
1114 if (n)
1115 memmove(dst, src, st_mult(size, n));
1116}
1117
d2ec87a6
RS
1118#define DUP_ARRAY(dst, src, n) do { \
1119 size_t dup_array_n_ = (n); \
1120 COPY_ARRAY(ALLOC_ARRAY((dst), dup_array_n_), (src), dup_array_n_); \
1121} while (0)
1122
36895391
JK
1123/*
1124 * These functions help you allocate structs with flex arrays, and copy
1125 * the data directly into the array. For example, if you had:
1126 *
1127 * struct foo {
1128 * int bar;
1129 * char name[FLEX_ARRAY];
1130 * };
1131 *
1132 * you can do:
1133 *
1134 * struct foo *f;
1135 * FLEX_ALLOC_MEM(f, name, src, len);
1136 *
1137 * to allocate a "foo" with the contents of "src" in the "name" field.
1138 * The resulting struct is automatically zero'd, and the flex-array field
1139 * is NUL-terminated (whether the incoming src buffer was or not).
1140 *
1141 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
1142 * but do want to store a pointer to some extra data in the same allocated
1143 * block. For example, if you have:
1144 *
1145 * struct foo {
1146 * char *name;
1147 * int bar;
1148 * };
1149 *
1150 * you can do:
1151 *
1152 * struct foo *f;
0bb1519f 1153 * FLEXPTR_ALLOC_STR(f, name, src);
36895391
JK
1154 *
1155 * and "name" will point to a block of memory after the struct, which will be
1156 * freed along with the struct (but the pointer can be repointed anywhere).
1157 *
1158 * The *_STR variants accept a string parameter rather than a ptr/len
1159 * combination.
1160 *
1161 * Note that these macros will evaluate the first parameter multiple
1162 * times, and it must be assignable as an lvalue.
1163 */
1164#define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
e9451782
RS
1165 size_t flex_array_len_ = (len); \
1166 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1167 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
36895391
JK
1168} while (0)
1169#define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
0ac52a38
RS
1170 size_t flex_array_len_ = (len); \
1171 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1172 memcpy((x) + 1, (buf), flex_array_len_); \
36895391
JK
1173 (x)->ptrname = (void *)((x)+1); \
1174} while(0)
1175#define FLEX_ALLOC_STR(x, flexname, str) \
1176 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1177#define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1178 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1179
d64ea0f8
JK
1180static inline char *xstrdup_or_null(const char *str)
1181{
1182 return str ? xstrdup(str) : NULL;
1183}
1184
dc49cd76
SP
1185static inline size_t xsize_t(off_t len)
1186{
aafa5df0 1187 if (len < 0 || (uintmax_t) len > SIZE_MAX)
46be82df 1188 die("Cannot handle files this big");
aafa5df0 1189 return (size_t) len;
dc49cd76
SP
1190}
1191
7b03c89e 1192__attribute__((format (printf, 3, 4)))
b199d714 1193int xsnprintf(char *dst, size_t max, const char *fmt, ...);
7b03c89e 1194
da25bdb7
RS
1195#ifndef HOST_NAME_MAX
1196#define HOST_NAME_MAX 256
1197#endif
1198
55454427 1199int xgethostname(char *buf, size_t len);
5781a9a2 1200
f1589d10 1201/* in ctype.c, for kwset users */
189c860c 1202extern const unsigned char tolower_trans_tbl[256];
f1589d10 1203
4050c0df 1204/* Sane ctype - no locale, and works with signed chars */
c2e9364a 1205#undef isascii
4050c0df
JH
1206#undef isspace
1207#undef isdigit
1208#undef isalpha
1209#undef isalnum
0fcec2ce 1210#undef isprint
43ccdf56
NK
1211#undef islower
1212#undef isupper
4050c0df
JH
1213#undef tolower
1214#undef toupper
1c149ab2
NTND
1215#undef iscntrl
1216#undef ispunct
1217#undef isxdigit
2adf7247 1218
ca5ab7d1 1219extern const unsigned char sane_ctype[256];
4050c0df
JH
1220#define GIT_SPACE 0x01
1221#define GIT_DIGIT 0x02
1222#define GIT_ALPHA 0x04
8cc32992 1223#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 1224#define GIT_REGEX_SPECIAL 0x10
2f6c9760 1225#define GIT_PATHSPEC_MAGIC 0x20
1c149ab2
NTND
1226#define GIT_CNTRL 0x40
1227#define GIT_PUNCT 0x80
4050c0df 1228#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 1229#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
1230#define isspace(x) sane_istest(x,GIT_SPACE)
1231#define isdigit(x) sane_istest(x,GIT_DIGIT)
1232#define isalpha(x) sane_istest(x,GIT_ALPHA)
1233#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
0fcec2ce 1234#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
43ccdf56
NK
1235#define islower(x) sane_iscase(x, 1)
1236#define isupper(x) sane_iscase(x, 0)
8cc32992 1237#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 1238#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1c149ab2
NTND
1239#define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1240#define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1241 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
50a71776 1242#define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
4050c0df
JH
1243#define tolower(x) sane_case((unsigned char)(x), 0x20)
1244#define toupper(x) sane_case((unsigned char)(x), 0)
2f6c9760 1245#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
4050c0df
JH
1246
1247static inline int sane_case(int x, int high)
1248{
1249 if (sane_istest(x, GIT_ALPHA))
1250 x = (x & ~0x20) | high;
1251 return x;
1252}
1253
43ccdf56
NK
1254static inline int sane_iscase(int x, int is_lower)
1255{
1256 if (!sane_istest(x, GIT_ALPHA))
1257 return 0;
1258
1259 if (is_lower)
1260 return (x & 0x20) != 0;
1261 else
1262 return (x & 0x20) == 0;
1263}
1264
41a80924
JK
1265/*
1266 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1267 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1268 * locale-specific conversions).
1269 */
1270static inline int skip_iprefix(const char *str, const char *prefix,
1271 const char **out)
1272{
1273 do {
1274 if (!*prefix) {
1275 *out = str;
1276 return 1;
1277 }
1278 } while (tolower(*str++) == tolower(*prefix++));
1279 return 0;
1280}
1281
6aead43d
JM
1282static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1283{
1284 unsigned long ul;
1285 char *p;
1286
1287 errno = 0;
e6f2599c
MM
1288 /* negative values would be accepted by strtoul */
1289 if (strchr(s, '-'))
1290 return -1;
6aead43d
JM
1291 ul = strtoul(s, &p, base);
1292 if (errno || *p || p == s || (unsigned int) ul != ul)
1293 return -1;
1294 *result = ul;
1295 return 0;
1296}
1297
7791ecbc
JH
1298static inline int strtol_i(char const *s, int base, int *result)
1299{
1300 long ul;
1301 char *p;
1302
1303 errno = 0;
1304 ul = strtol(s, &p, base);
1305 if (errno || *p || p == s || (int) ul != ul)
1306 return -1;
1307 *result = ul;
1308 return 0;
1309}
1310
97fff610
JS
1311void git_stable_qsort(void *base, size_t nmemb, size_t size,
1312 int(*compar)(const void *, const void *));
43fe901b 1313#ifdef INTERNAL_QSORT
97fff610 1314#define qsort git_stable_qsort
43fe901b
BD
1315#endif
1316
dbc540c7
RS
1317#define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1318static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1319 int(*compar)(const void *, const void *))
1320{
1321 if (nmemb > 1)
1322 qsort(base, nmemb, size, compar);
1323}
1324
97fff610
JS
1325#define STABLE_QSORT(base, n, compar) \
1326 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1327
04ee8b87
RS
1328#ifndef HAVE_ISO_QSORT_S
1329int git_qsort_s(void *base, size_t nmemb, size_t size,
1330 int (*compar)(const void *, const void *, void *), void *ctx);
1331#define qsort_s git_qsort_s
1332#endif
1333
3ca86994
RS
1334#define QSORT_S(base, n, compar, ctx) do { \
1335 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
c3c3486b 1336 BUG("qsort_s() failed"); \
3ca86994
RS
1337} while (0)
1338
2f895225
JS
1339#ifndef REG_STARTEND
1340#error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1341#endif
1342
1343static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1344 size_t nmatch, regmatch_t pmatch[], int eflags)
1345{
1346 assert(nmatch > 0 && pmatch);
1347 pmatch[0].rm_so = 0;
1348 pmatch[0].rm_eo = size;
1349 return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1350}
1351
81a24b52
AR
1352#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1353# define FORCE_DIR_SET_GID S_ISGID
1354#else
1355# define FORCE_DIR_SET_GID 0
1356#endif
1357
c06ff490
KB
1358#ifdef NO_NSEC
1359#undef USE_NSEC
1360#define ST_CTIME_NSEC(st) 0
1361#define ST_MTIME_NSEC(st) 0
1362#else
c567383b
BG
1363#ifdef USE_ST_TIMESPEC
1364#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1365#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1366#else
c06ff490
KB
1367#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1368#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1369#endif
c567383b 1370#endif
c06ff490 1371
34779c53
JS
1372#ifdef UNRELIABLE_FSTAT
1373#define fstat_is_reliable() 0
1374#else
1375#define fstat_is_reliable() 1
1376#endif
1377
ab8632ae 1378#ifndef va_copy
26db0f2e
JN
1379/*
1380 * Since an obvious implementation of va_list would be to make it a
1381 * pointer into the stack frame, a simple assignment will work on
1382 * many systems. But let's try to be more portable.
1383 */
1384#ifdef __va_copy
1385#define va_copy(dst, src) __va_copy(dst, src)
1386#else
1387#define va_copy(dst, src) ((dst) = (src))
1388#endif
ab8632ae
JK
1389#endif
1390
746ea4ad
RJ
1391/* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1392extern int BUG_exit_code;
1393
0cc05b04
ÆAB
1394/* usage.c: if bug() is called we should have a BUG_if_bug() afterwards */
1395extern int bug_called_must_BUG;
1396
d8193743
JK
1397__attribute__((format (printf, 3, 4))) NORETURN
1398void BUG_fl(const char *file, int line, const char *fmt, ...);
1399#define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
0cc05b04
ÆAB
1400__attribute__((format (printf, 3, 4)))
1401void bug_fl(const char *file, int line, const char *fmt, ...);
1402#define bug(...) bug_fl(__FILE__, __LINE__, __VA_ARGS__)
1403#define BUG_if_bug(...) do { \
1404 if (bug_called_must_BUG) \
1405 BUG_fl(__FILE__, __LINE__, __VA_ARGS__); \
1406} while (0)
d8193743 1407
8a94d833 1408#ifndef FSYNC_METHOD_DEFAULT
abf38abe
NS
1409#ifdef __APPLE__
1410#define FSYNC_METHOD_DEFAULT FSYNC_METHOD_WRITEOUT_ONLY
1411#else
1412#define FSYNC_METHOD_DEFAULT FSYNC_METHOD_FSYNC
1413#endif
8a94d833 1414#endif
abf38abe
NS
1415
1416enum fsync_action {
1417 FSYNC_WRITEOUT_ONLY,
1418 FSYNC_HARDWARE_FLUSH
1419};
1420
1421/*
1422 * Issues an fsync against the specified file according to the specified mode.
1423 *
1424 * FSYNC_WRITEOUT_ONLY attempts to use interfaces available on some operating
1425 * systems to flush the OS cache without issuing a flush command to the storage
1426 * controller. If those interfaces are unavailable, the function fails with
1427 * ENOSYS.
1428 *
1429 * FSYNC_HARDWARE_FLUSH does an OS writeout and hardware flush to ensure that
1430 * changes are durable. It is not expected to fail.
1431 */
1432int git_fsync(int fd, enum fsync_action action);
1433
9a498767
NS
1434/*
1435 * Writes out trace statistics for fsync using the trace2 API.
1436 */
1437void trace_git_fsync_stats(void);
1438
fc71db39
AR
1439/*
1440 * Preserves errno, prints a message, but gives no warning for ENOENT.
1054af7d
RS
1441 * Returns 0 on success, which includes trying to unlink an object that does
1442 * not exist.
fc71db39
AR
1443 */
1444int unlink_or_warn(const char *path);
9ccc0c08
RS
1445 /*
1446 * Tries to unlink file. Returns 0 if unlink succeeded
1447 * or the file already didn't exist. Returns -1 and
1448 * appends a message to err suitable for
1449 * 'error("%s", err->buf)' on error.
1450 */
1451int unlink_or_msg(const char *file, struct strbuf *err);
d1723296 1452/*
1054af7d
RS
1453 * Preserves errno, prints a message, but gives no warning for ENOENT.
1454 * Returns 0 on success, which includes trying to remove a directory that does
1455 * not exist.
d1723296
PC
1456 */
1457int rmdir_or_warn(const char *path);
80d706af
PC
1458/*
1459 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1460 * the supplied file mode.
1461 */
1462int remove_or_warn(unsigned int mode, const char *path);
fc71db39 1463
e5c52c98
JN
1464/*
1465 * Call access(2), but warn for any error except "missing file"
1466 * (ENOENT or ENOTDIR).
1467 */
4698c8fe
JN
1468#define ACCESS_EACCES_OK (1U << 0)
1469int access_or_warn(const char *path, int mode, unsigned flag);
1470int access_or_die(const char *path, int mode, unsigned flag);
ba8bd830 1471
11dc1fcb
NTND
1472/* Warn on an inaccessible file if errno indicates this is an error */
1473int warn_on_fopen_errors(const char *path);
55b38a48 1474
00611d84
JK
1475/*
1476 * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent
1477 * may be racy. Do not use this as protection against an attacker who can
1478 * simultaneously create paths.
1479 */
1480int open_nofollow(const char *path, int flags);
1481
1b56cdf9
KM
1482#ifndef SHELL_PATH
1483# define SHELL_PATH "/bin/sh"
1484#endif
1485
f43cce23 1486#ifndef _POSIX_THREAD_SAFE_FUNCTIONS
efcc48ef 1487static inline void git_flockfile(FILE *fh UNUSED)
15b52a44
JH
1488{
1489 ; /* nothing */
1490}
efcc48ef 1491static inline void git_funlockfile(FILE *fh UNUSED)
15b52a44
JH
1492{
1493 ; /* nothing */
1494}
e1a95b78
JK
1495#undef flockfile
1496#undef funlockfile
1497#undef getc_unlocked
e0c08a4f
JK
1498#define flockfile(fh) git_flockfile(fh)
1499#define funlockfile(fh) git_funlockfile(fh)
f43cce23
JK
1500#define getc_unlocked(fh) getc(fh)
1501#endif
1502
18a4f6be
NTND
1503#ifdef FILENO_IS_A_MACRO
1504int git_fileno(FILE *stream);
400caafb 1505# ifndef COMPAT_CODE_FILENO
18a4f6be
NTND
1506# undef fileno
1507# define fileno(p) git_fileno(p)
1508# endif
1509#endif
1510
400caafb
CC
1511#ifdef NEED_ACCESS_ROOT_HANDLER
1512int git_access(const char *path, int mode);
1513# ifndef COMPAT_CODE_ACCESS
1514# ifdef access
1515# undef access
1516# endif
1517# define access(path, mode) git_access(path, mode)
1518# endif
1519#endif
1520
dc5a18b3
JH
1521/*
1522 * Our code often opens a path to an optional file, to work on its
1523 * contents when we can successfully open it. We can ignore a failure
1524 * to open if such an optional file does not exist, but we do want to
1525 * report a failure in opening for other reasons (e.g. we got an I/O
1526 * error, or the file is there, but we lack the permission to open).
1527 *
1528 * Call this function after seeing an error from open() or fopen() to
1529 * see if the errno indicates a missing file that we can safely ignore.
1530 */
1531static inline int is_missing_file_error(int errno_)
1532{
1533 return (errno_ == ENOENT || errno_ == ENOTDIR);
1534}
1535
55454427 1536int cmd_main(int, const char **);
5c238e29 1537
ee4512ed
JH
1538/*
1539 * Intercept all calls to exit() and route them to trace2 to
1540 * optionally emit a message before calling the real exit().
1541 */
19d75948
ÆAB
1542int common_exit(const char *file, int line, int code);
1543#define exit(code) exit(common_exit(__FILE__, __LINE__, (code)))
ee4512ed 1544
0e5bba53
JK
1545/*
1546 * You can mark a stack variable with UNLEAK(var) to avoid it being
1547 * reported as a leak by tools like LSAN or valgrind. The argument
1548 * should generally be the variable itself (not its address and not what
1549 * it points to). It's safe to use this on pointers which may already
1550 * have been freed, or on pointers which may still be in use.
1551 *
1552 * Use this _only_ for a variable that leaks by going out of scope at
1553 * program exit (so only from cmd_* functions or their direct helpers).
1554 * Normal functions, especially those which may be called multiple
1555 * times, should actually free their memory. This is only meant as
1556 * an annotation, and does nothing in non-leak-checking builds.
1557 */
1558#ifdef SUPPRESS_ANNOTATED_LEAKS
55454427 1559void unleak_memory(const void *ptr, size_t len);
5de3de32 1560#define UNLEAK(var) unleak_memory(&(var), sizeof(var))
0e5bba53 1561#else
5de3de32 1562#define UNLEAK(var) do {} while (0)
0e5bba53
JK
1563#endif
1564
07564773
ÆAB
1565#define z_const
1566#include <zlib.h>
1567
1568#if ZLIB_VERNUM < 0x1290
1569/*
1570 * This is uncompress2, which is only available in zlib >= 1.2.9
1571 * (released as of early 2017). See compat/zlib-uncompress2.c.
1572 */
1573int uncompress2(Bytef *dest, uLongf *destLen, const Bytef *source,
1574 uLong *sourceLen);
1575#endif
1576
c8af66ab
JK
1577/*
1578 * This include must come after system headers, since it introduces macros that
1579 * replace system names.
1580 */
1581#include "banned.h"
1582
973d5eea
EW
1583/*
1584 * container_of - Get the address of an object containing a field.
1585 *
1586 * @ptr: pointer to the field.
1587 * @type: type of the object.
1588 * @member: name of the field within the object.
1589 */
1590#define container_of(ptr, type, member) \
1591 ((type *) ((char *)(ptr) - offsetof(type, member)))
1592
f0e63c41
EW
1593/*
1594 * helper function for `container_of_or_null' to avoid multiple
1595 * evaluation of @ptr
1596 */
1597static inline void *container_of_or_null_offset(void *ptr, size_t offset)
1598{
1599 return ptr ? (char *)ptr - offset : NULL;
1600}
1601
1602/*
1603 * like `container_of', but allows returned value to be NULL
1604 */
1605#define container_of_or_null(ptr, type, member) \
1606 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1607
23dee69f 1608/*
abcb66c6 1609 * like offsetof(), but takes a pointer to a variable of type which
23dee69f
EW
1610 * contains @member, instead of a specified type.
1611 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1612 * everywhere.
1613 */
1614#if defined(__GNUC__) /* clang sets this, too */
1615#define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1616#else /* !__GNUC__ */
1617#define OFFSETOF_VAR(ptr, member) \
1618 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1619#endif /* !__GNUC__ */
1620
a76b138d
HWN
1621void sleep_millisec(int millisec);
1622
05cd988d 1623/*
1624 * Generate len bytes from the system cryptographically secure PRNG.
1625 * Returns 0 on success and -1 on error, setting errno. The inability to
1626 * satisfy the full request is an error.
1627 */
1628int csprng_bytes(void *buf, size_t len);
1629
5c238e29 1630#endif