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