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