harden REALLOC_ARRAY and xcalloc against size_t overflow
[git/git.git] / git-compat-util.h
CommitLineData
4050c0df
JH
1#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
b97e9116
MW
4#define _FILE_OFFSET_BITS 64
5
89c855ed
EP
6
7/* Derived from Linux "Features Test Macro" header
8 * Convenience macros to test the versions of gcc (or
9 * a compatible compiler).
10 * Use them like this:
11 * #if GIT_GNUC_PREREQ (2,8)
12 * ... code requiring gcc 2.8 or later ...
13 * #endif
14*/
15#if defined(__GNUC__) && defined(__GNUC_MINOR__)
16# define GIT_GNUC_PREREQ(maj, min) \
17 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
18#else
19 #define GIT_GNUC_PREREQ(maj, min) 0
20#endif
21
22
8f1d2e6f 23#ifndef FLEX_ARRAY
8e973991
JH
24/*
25 * See if our compiler is known to support flexible array members.
26 */
203ee91f 27#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
8e973991
JH
28# define FLEX_ARRAY /* empty */
29#elif defined(__GNUC__)
30# if (__GNUC__ >= 3)
31# define FLEX_ARRAY /* empty */
32# else
33# define FLEX_ARRAY 0 /* older GNU extension */
34# endif
35#endif
36
37/*
38 * Otherwise, default to safer but a bit wasteful traditional style
39 */
40#ifndef FLEX_ARRAY
41# define FLEX_ARRAY 1
8f1d2e6f
JH
42#endif
43#endif
44
89c855ed
EP
45
46/*
47 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
48 * @cond: the compile-time condition which must be true.
49 *
50 * Your compile will fail if the condition isn't true, or can't be evaluated
51 * by the compiler. This can be used in an expression: its value is "0".
52 *
53 * Example:
54 * #define foo_to_char(foo) \
55 * ((char *)(foo) \
56 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
57 */
58#define BUILD_ASSERT_OR_ZERO(cond) \
59 (sizeof(char [1 - 2*!(cond)]) - 1)
60
e2c6f7cd 61#if GIT_GNUC_PREREQ(3, 1)
89c855ed
EP
62 /* &arr[0] degrades to a pointer: a different type from an array */
63# define BARF_UNLESS_AN_ARRAY(arr) \
64 BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
65 __typeof__(&(arr)[0])))
e2c6f7cd
CB
66#else
67# define BARF_UNLESS_AN_ARRAY(arr) 0
89c855ed
EP
68#endif
69/*
70 * ARRAY_SIZE - get the number of elements in a visible array
71 * <at> x: the array whose size you want.
72 *
73 * This does not work on pointers, or arrays declared as [], or
74 * function parameters. With correct compiler support, such usage
75 * will cause a build error (see the build_assert_or_zero macro).
76 */
77#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
78
f630cfda 79#define bitsizeof(x) (CHAR_BIT * sizeof(x))
b4f2a6ac 80
c03c8315
EFL
81#define maximum_signed_value_of_type(a) \
82 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
83
1368f650
JN
84#define maximum_unsigned_value_of_type(a) \
85 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
86
c03c8315
EFL
87/*
88 * Signed integer overflow is undefined in C, so here's a helper macro
89 * to detect if the sum of two integers will overflow.
90 *
91 * Requires: a >= 0, typeof(a) equals typeof(b)
92 */
93#define signed_add_overflows(a, b) \
94 ((b) > maximum_signed_value_of_type(a) - (a))
95
1368f650
JN
96#define unsigned_add_overflows(a, b) \
97 ((b) > maximum_unsigned_value_of_type(a) - (a))
98
320d0b49
JK
99/*
100 * Returns true if the multiplication of "a" and "b" will
101 * overflow. The types of "a" and "b" must match and must be unsigned.
102 * Note that this macro evaluates "a" twice!
103 */
104#define unsigned_mult_overflows(a, b) \
105 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
106
8723f216
NP
107#ifdef __GNUC__
108#define TYPEOF(x) (__typeof__(x))
109#else
110#define TYPEOF(x)
111#endif
112
f630cfda 113#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
db7244bd 114#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216 115
98cb6f30
PH
116#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
117
cf606e3d
AW
118/* Approximation of the length of the decimal representation of this type. */
119#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
120
4cb18a49
BC
121#if defined(__sun__)
122 /*
123 * On Solaris, when _XOPEN_EXTENDED is set, its header file
124 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
125 * setting to say we are XPG5 or XPG6. Also on Solaris,
126 * XPG6 programs must be compiled with a c99 compiler, while
127 * non XPG6 programs must be compiled with a pre-c99 compiler.
128 */
129# if __STDC_VERSION__ - 0 >= 199901L
130# define _XOPEN_SOURCE 600
131# else
132# define _XOPEN_SOURCE 500
133# endif
6555b196 134#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
6c109904 135 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
3a0a3a89
RJ
136 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
137 !defined(__CYGWIN__)
85023577
JH
138#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
139#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6 140#endif
fb952206
JR
141#define _ALL_SOURCE 1
142#define _GNU_SOURCE 1
143#define _BSD_SOURCE 1
f978a99f 144#define _DEFAULT_SOURCE 1
9a695fbf 145#define _NETBSD_SOURCE 1
9398b859 146#define _SGI_SOURCE 1
85023577 147
380395d0 148#if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
8453c125 149# if defined (_MSC_VER) && !defined(_WIN32_WINNT)
41f29991
RJ
150# define _WIN32_WINNT 0x0502
151# endif
435bdf8c
MSO
152#define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
153#include <winsock2.h>
154#include <windows.h>
380395d0 155#define GIT_WINDOWS_NATIVE
435bdf8c
MSO
156#endif
157
4050c0df
JH
158#include <unistd.h>
159#include <stdio.h>
160#include <sys/stat.h>
161#include <fcntl.h>
162#include <stddef.h>
163#include <stdlib.h>
164#include <stdarg.h>
165#include <string.h>
b3e103da 166#ifdef HAVE_STRINGS_H
6c109904
JS
167#include <strings.h> /* for strcasecmp() */
168#endif
4050c0df
JH
169#include <errno.h>
170#include <limits.h>
b2d05e06 171#ifdef NEEDS_SYS_PARAM_H
4050c0df 172#include <sys/param.h>
6ede7205 173#endif
4050c0df
JH
174#include <sys/types.h>
175#include <dirent.h>
85023577
JH
176#include <sys/time.h>
177#include <time.h>
178#include <signal.h>
f4626df5
JS
179#include <assert.h>
180#include <regex.h>
181#include <utime.h>
088d8802 182#include <syslog.h>
2844923d 183#ifndef NO_SYS_POLL_H
fdc12114 184#include <sys/poll.h>
2844923d
MD
185#else
186#include <poll.h>
187#endif
9529080d
KM
188#ifdef HAVE_BSD_SYSCTL
189#include <sys/sysctl.h>
190#endif
2f0aaaf9 191
cfc755d3
VR
192#if defined(__MINGW32__)
193/* pull in Windows compatibility stuff */
194#include "compat/mingw.h"
195#elif defined(_MSC_VER)
196#include "compat/msvc.h"
197#else
1e8fef60 198#include <sys/utsname.h>
f4626df5 199#include <sys/wait.h>
ebae9ff9 200#include <sys/resource.h>
85023577 201#include <sys/socket.h>
80bbe72b 202#include <sys/ioctl.h>
eb80042c 203#include <termios.h>
2600973f 204#ifndef NO_SYS_SELECT_H
80bbe72b 205#include <sys/select.h>
2600973f 206#endif
85023577
JH
207#include <netinet/in.h>
208#include <netinet/tcp.h>
209#include <arpa/inet.h>
210#include <netdb.h>
211#include <pwd.h>
e2770979 212#include <sys/un.h>
2844923d 213#ifndef NO_INTTYPES_H
007e2ba6 214#include <inttypes.h>
2844923d
MD
215#else
216#include <stdint.h>
217#endif
6c109904
JS
218#ifdef NO_INTPTR_T
219/*
220 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
221 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
222 * while on IP16 and IP16L32 it is "int" (resp. "short")
223 * Size needs to match (or exceed) 'sizeof(void *)'.
224 * We can't take "long long" here as not everybody has it.
225 */
226typedef long intptr_t;
227typedef unsigned long uintptr_t;
228#endif
fb952206 229#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 230#include <grp.h>
fb952206 231#define _ALL_SOURCE 1
41b20017 232#endif
85023577 233
76759c7d
TB
234/* used on Mac OS X */
235#ifdef PRECOMPOSE_UNICODE
236#include "compat/precompose_utf8.h"
237#else
238#define precompose_str(in,i_nfd2nfc)
239#define precompose_argv(c,v)
fdf72966 240#define probe_utf8_pathname_composition()
76759c7d
TB
241#endif
242
0539ecfd
JS
243#ifdef MKDIR_WO_TRAILING_SLASH
244#define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
245extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
246#endif
247
7f9e848c
JS
248#ifdef NO_STRUCT_ITIMERVAL
249struct itimerval {
250 struct timeval it_interval;
251 struct timeval it_value;
981ff520 252};
7f9e848c
JS
253#endif
254
255#ifdef NO_SETITIMER
256#define setitimer(which,value,ovalue)
257#endif
258
e1c06886
DA
259#ifndef NO_LIBGEN_H
260#include <libgen.h>
261#else
262#define basename gitbasename
263extern char *gitbasename(char *);
824682ab
JS
264#define dirname gitdirname
265extern char *gitdirname(char *);
e1c06886
DA
266#endif
267
85023577
JH
268#ifndef NO_ICONV
269#include <iconv.h>
270#endif
4050c0df 271
684ec6c6 272#ifndef NO_OPENSSL
88c03eb5 273#ifdef __APPLE__
b195aa00 274#define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
88c03eb5
KM
275#include <AvailabilityMacros.h>
276#undef DEPRECATED_ATTRIBUTE
277#define DEPRECATED_ATTRIBUTE
278#undef __AVAILABILITY_MACROS_USES_AVAILABILITY
279#endif
684ec6c6
RS
280#include <openssl/ssl.h>
281#include <openssl/err.h>
88e01181
RH
282#ifdef NO_HMAC_CTX_CLEANUP
283#define HMAC_CTX_cleanup HMAC_cleanup
284#endif
684ec6c6
RS
285#endif
286
3b130ade
DM
287/* On most systems <netdb.h> would have given us this, but
288 * not on some systems (e.g. z/OS).
289 */
290#ifndef NI_MAXHOST
291#define NI_MAXHOST 1025
292#endif
293
294#ifndef NI_MAXSERV
295#define NI_MAXSERV 32
296#endif
297
d0c2449f
JH
298/* On most systems <limits.h> would have given us this, but
299 * not on some systems (e.g. GNU/Hurd).
300 */
301#ifndef PATH_MAX
302#define PATH_MAX 4096
303#endif
304
c4001d92
SP
305#ifndef PRIuMAX
306#define PRIuMAX "llu"
307#endif
308
fdcdb778
WM
309#ifndef SCNuMAX
310#define SCNuMAX PRIuMAX
311#endif
312
607bb3ff
JS
313#ifndef PRIu32
314#define PRIu32 "u"
315#endif
316
317#ifndef PRIx32
318#define PRIx32 "x"
319#endif
320
5418d96d
RJ
321#ifndef PRIo32
322#define PRIo32 "o"
323#endif
324
80ba074f
JS
325#ifndef PATH_SEP
326#define PATH_SEP ':'
327#endif
328
cb6a22c0
CW
329#ifdef HAVE_PATHS_H
330#include <paths.h>
331#endif
332#ifndef _PATH_DEFPATH
333#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
334#endif
335
23326d14
JS
336#ifndef STRIP_EXTENSION
337#define STRIP_EXTENSION ""
338#endif
339
25fe217b 340#ifndef has_dos_drive_prefix
bf728346
RS
341static inline int git_has_dos_drive_prefix(const char *path)
342{
343 return 0;
344}
345#define has_dos_drive_prefix git_has_dos_drive_prefix
25fe217b
JS
346#endif
347
2f36eed9
JS
348#ifndef skip_dos_drive_prefix
349static inline int git_skip_dos_drive_prefix(char **path)
350{
351 return 0;
352}
353#define skip_dos_drive_prefix git_skip_dos_drive_prefix
354#endif
355
bf728346
RS
356#ifndef is_dir_sep
357static inline int git_is_dir_sep(int c)
358{
359 return c == '/';
360}
361#define is_dir_sep git_is_dir_sep
c2369bdf
CZ
362#endif
363
bf728346
RS
364#ifndef offset_1st_component
365static inline int git_offset_1st_component(const char *path)
366{
367 return is_dir_sep(path[0]);
368}
369#define offset_1st_component git_offset_1st_component
25fe217b
JS
370#endif
371
d1c69255 372#ifndef find_last_dir_sep
bf728346
RS
373static inline char *git_find_last_dir_sep(const char *path)
374{
375 return strrchr(path, '/');
376}
377#define find_last_dir_sep git_find_last_dir_sep
d1c69255
TN
378#endif
379
e4ac953b 380#if defined(__HP_cc) && (__HP_cc >= 61000)
b6ab349b
MR
381#define NORETURN __attribute__((noreturn))
382#define NORETURN_PTR
6520c846 383#elif defined(__GNUC__) && !defined(NO_NORETURN)
4050c0df 384#define NORETURN __attribute__((__noreturn__))
18660bc9 385#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8
RJ
386#elif defined(_MSC_VER)
387#define NORETURN __declspec(noreturn)
388#define NORETURN_PTR
4050c0df
JH
389#else
390#define NORETURN
18660bc9 391#define NORETURN_PTR
8cd7ebc8 392#ifndef __GNUC__
4050c0df
JH
393#ifndef __attribute__
394#define __attribute__(x)
395#endif
396#endif
8cd7ebc8 397#endif
4050c0df 398
9fe3edc4
RJ
399/* The sentinel attribute is valid from gcc version 4.0 */
400#if defined(__GNUC__) && (__GNUC__ >= 4)
401#define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
402#else
403#define LAST_ARG_MUST_BE_NULL
404#endif
405
51ea5519
NP
406#include "compat/bswap.h"
407
cebcab18 408#include "wildmatch.h"
cebcab18 409
9ccc0c08
RS
410struct strbuf;
411
4050c0df 412/* General helper functions */
ebaa79f4 413extern void vreportf(const char *prefix, const char *err, va_list params);
a4f3131c 414extern NORETURN void usage(const char *err);
64b1cb74 415extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
a4f3131c
EFL
416extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
417extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 418extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 419extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 420
f2be034c
BG
421#ifndef NO_OPENSSL
422#ifdef APPLE_COMMON_CRYPTO
423#include "compat/apple-common-crypto.h"
424#else
425#include <openssl/evp.h>
426#include <openssl/hmac.h>
427#endif /* APPLE_COMMON_CRYPTO */
428#include <openssl/x509v3.h>
429#endif /* NO_OPENSSL */
430
e208f9cc
JK
431/*
432 * Let callers be aware of the constant return value; this can help
9798f7e5
MK
433 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
434 * because some compilers may not support variadic macros. Since we're only
435 * trying to help gcc, anyway, it's OK; other compilers will fall back to
436 * using the function as usual.
e208f9cc 437 */
ff0a80af 438#if defined(__GNUC__)
87fe5df3
JK
439static inline int const_error(void)
440{
441 return -1;
442}
443#define error(...) (error(__VA_ARGS__), const_error())
e208f9cc
JK
444#endif
445
18660bc9 446extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
3bc4181f 447extern void set_error_routine(void (*routine)(const char *err, va_list params));
c19a490e 448extern void set_die_is_recursing_routine(int (*routine)(void));
3b331e92 449extern void set_error_handle(FILE *);
39a3f5ea 450
95662315 451extern int starts_with(const char *str, const char *prefix);
698a68be 452
cf4fff57
JK
453/*
454 * If the string "str" begins with the string found in "prefix", return 1.
455 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
456 * the string right after the prefix).
457 *
458 * Otherwise, return 0 and leave "out" untouched.
459 *
460 * Examples:
461 *
462 * [extract branch name, fail if not a branch]
463 * if (!skip_prefix(ref, "refs/heads/", &branch)
464 * return -1;
465 *
466 * [skip prefix if present, otherwise use whole string]
467 * skip_prefix(name, "refs/heads/", &name);
468 */
469static inline int skip_prefix(const char *str, const char *prefix,
470 const char **out)
fbca5837 471{
ba399c46 472 do {
cf4fff57
JK
473 if (!*prefix) {
474 *out = str;
475 return 1;
476 }
ba399c46 477 } while (*str++ == *prefix++);
cf4fff57 478 return 0;
fbca5837
MV
479}
480
35480f0b
JK
481/*
482 * If buf ends with suffix, return 1 and subtract the length of the suffix
483 * from *len. Otherwise, return 0 and leave *len untouched.
484 */
485static inline int strip_suffix_mem(const char *buf, size_t *len,
486 const char *suffix)
487{
488 size_t suflen = strlen(suffix);
489 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
490 return 0;
491 *len -= suflen;
492 return 1;
493}
494
495/*
496 * If str ends with suffix, return 1 and set *len to the size of the string
497 * without the suffix. Otherwise, return 0 and set *len to the size of the
498 * string.
499 *
500 * Note that we do _not_ NUL-terminate str to the new length.
501 */
502static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
503{
504 *len = strlen(str);
505 return strip_suffix_mem(str, len, suffix);
506}
507
f52a35fd
JK
508static inline int ends_with(const char *str, const char *suffix)
509{
510 size_t len;
511 return strip_suffix(str, suffix, &len);
512}
513
b130a72b 514#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
515
516#ifndef PROT_READ
517#define PROT_READ 1
518#define PROT_WRITE 2
519#define MAP_PRIVATE 1
4050c0df
JH
520#endif
521
d6779124
SP
522#define mmap git_mmap
523#define munmap git_munmap
524extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
525extern int git_munmap(void *start, size_t length);
4050c0df 526
b130a72b
JL
527#else /* NO_MMAP || USE_WIN32_MMAP */
528
529#include <sys/mman.h>
530
531#endif /* NO_MMAP || USE_WIN32_MMAP */
532
533#ifdef NO_MMAP
534
5faaf246 535/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
536#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
537
4050c0df
JH
538#else /* NO_MMAP */
539
5faaf246 540/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
541#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
542 (sizeof(void*) >= 8 \
543 ? 1 * 1024 * 1024 * 1024 \
544 : 32 * 1024 * 1024)
4050c0df
JH
545
546#endif /* NO_MMAP */
547
fcf3a21a
GV
548#ifndef MAP_FAILED
549#define MAP_FAILED ((void *)-1)
550#endif
551
fdb2a2a6
JH
552#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
553#define on_disk_bytes(st) ((st).st_size)
554#else
555#define on_disk_bytes(st) ((st).st_blocks * 512)
556#endif
557
d543d9c0
DM
558#ifdef NEEDS_MODE_TRANSLATION
559#undef S_IFMT
560#undef S_IFREG
561#undef S_IFDIR
562#undef S_IFLNK
563#undef S_IFBLK
564#undef S_IFCHR
565#undef S_IFIFO
566#undef S_IFSOCK
567#define S_IFMT 0170000
568#define S_IFREG 0100000
569#define S_IFDIR 0040000
570#define S_IFLNK 0120000
571#define S_IFBLK 0060000
572#define S_IFCHR 0020000
573#define S_IFIFO 0010000
574#define S_IFSOCK 0140000
575#ifdef stat
576#undef stat
577#endif
578#define stat(path, buf) git_stat(path, buf)
579extern int git_stat(const char *, struct stat *);
580#ifdef fstat
581#undef fstat
582#endif
583#define fstat(fd, buf) git_fstat(fd, buf)
584extern int git_fstat(int, struct stat *);
585#ifdef lstat
586#undef lstat
587#endif
588#define lstat(path, buf) git_lstat(path, buf)
589extern int git_lstat(const char *, struct stat *);
590#endif
591
22bac0ea 592#define DEFAULT_PACKED_GIT_LIMIT \
8f774423 593 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 594
6900679c
SH
595#ifdef NO_PREAD
596#define pread git_pread
597extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
598#endif
14086b0a
SP
599/*
600 * Forward decl that will remind us if its twin in cache.h changes.
601 * This function is used in compat/pread.c. But we can't include
602 * cache.h there.
603 */
604extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 605
4050c0df
JH
606#ifdef NO_SETENV
607#define setenv gitsetenv
608extern int gitsetenv(const char *, const char *, int);
609#endif
610
ca5bb5d5
SP
611#ifdef NO_MKDTEMP
612#define mkdtemp gitmkdtemp
613extern char *gitmkdtemp(char *);
614#endif
615
0620b39b
DA
616#ifdef NO_MKSTEMPS
617#define mkstemps gitmkstemps
618extern int gitmkstemps(char *, int);
619#endif
620
731043fd
JR
621#ifdef NO_UNSETENV
622#define unsetenv gitunsetenv
623extern void gitunsetenv(const char *);
624#endif
625
4050c0df
JH
626#ifdef NO_STRCASESTR
627#define strcasestr gitstrcasestr
628extern char *gitstrcasestr(const char *haystack, const char *needle);
629#endif
630
817151e6
PE
631#ifdef NO_STRLCPY
632#define strlcpy gitstrlcpy
633extern size_t gitstrlcpy(char *, const char *, size_t);
634#endif
635
bc6b4f52
JR
636#ifdef NO_STRTOUMAX
637#define strtoumax gitstrtoumax
638extern uintmax_t gitstrtoumax(const char *, char **, int);
97000ba6
JS
639#define strtoimax gitstrtoimax
640extern intmax_t gitstrtoimax(const char *, char **, int);
bc6b4f52
JR
641#endif
642
fa0c87c3
AR
643#ifdef NO_HSTRERROR
644#define hstrerror githstrerror
645extern const char *githstrerror(int herror);
646#endif
647
b21b9f1d
RS
648#ifdef NO_MEMMEM
649#define memmem gitmemmem
650void *gitmemmem(const void *haystack, size_t haystacklen,
651 const void *needle, size_t needlelen);
652#endif
653
40036bed
MK
654#ifdef NO_GETPAGESIZE
655#define getpagesize() sysconf(_SC_PAGESIZE)
656#endif
657
cba22528 658#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
659#ifdef fopen
660#undef fopen
661#endif
cba22528
BC
662#define fopen(a,b) git_fopen(a,b)
663extern FILE *git_fopen(const char*, const char*);
664#endif
665
c4582f93 666#ifdef SNPRINTF_RETURNS_BOGUS
ab03803c
BS
667#ifdef snprintf
668#undef snprintf
669#endif
c4582f93
MR
670#define snprintf git_snprintf
671extern int git_snprintf(char *str, size_t maxsize,
672 const char *format, ...);
ab03803c
BS
673#ifdef vsnprintf
674#undef vsnprintf
675#endif
c4582f93
MR
676#define vsnprintf git_vsnprintf
677extern int git_vsnprintf(char *str, size_t maxsize,
678 const char *format, va_list ap);
679#endif
680
726c8ef5
JS
681#ifdef __GLIBC_PREREQ
682#if __GLIBC_PREREQ(2, 1)
683#define HAVE_STRCHRNUL
137c6eaa 684#define HAVE_MEMPCPY
726c8ef5
JS
685#endif
686#endif
687
688#ifndef HAVE_STRCHRNUL
659c69cf 689#define strchrnul gitstrchrnul
9e79f00f
AE
690static inline char *gitstrchrnul(const char *s, int c)
691{
692 while (*s && *s != c)
693 s++;
694 return (char *)s;
695}
659c69cf
RS
696#endif
697
137c6eaa
JN
698#ifndef HAVE_MEMPCPY
699#define mempcpy gitmempcpy
700static inline void *gitmempcpy(void *dest, const void *src, size_t n)
701{
702 return (char *)memcpy(dest, src, n) + n;
703}
704#endif
705
da523cc5
MP
706#ifdef NO_INET_PTON
707int inet_pton(int af, const char *src, void *dst);
708#endif
709
710#ifdef NO_INET_NTOP
711const char *inet_ntop(int af, const void *src, char *dst, size_t size);
712#endif
713
0f4b6db3
EB
714#ifdef NO_PTHREADS
715#define atexit git_atexit
716extern int git_atexit(void (*handler)(void));
717#endif
718
7c3ecb32 719extern void release_pack_memory(size_t);
97bfeb34 720
851c34b0
JS
721typedef void (*try_to_free_t)(size_t);
722extern try_to_free_t set_try_to_free_routine(try_to_free_t);
320d0b49
JK
723
724static inline size_t st_add(size_t a, size_t b)
725{
726 if (unsigned_add_overflows(a, b))
727 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
728 (uintmax_t)a, (uintmax_t)b);
729 return a + b;
730}
731#define st_add3(a,b,c) st_add((a),st_add((b),(c)))
732#define st_add4(a,b,c,d) st_add((a),st_add3((b),(c),(d)))
733
734static inline size_t st_mult(size_t a, size_t b)
735{
736 if (unsigned_mult_overflows(a, b))
737 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
738 (uintmax_t)a, (uintmax_t)b);
739 return a * b;
740}
741
742static inline size_t st_sub(size_t a, size_t b)
743{
744 if (a < b)
745 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
746 (uintmax_t)a, (uintmax_t)b);
747 return a - b;
748}
a9a74636 749
61f76a36
KS
750#ifdef HAVE_ALLOCA_H
751# include <alloca.h>
752# define xalloca(size) (alloca(size))
753# define xalloca_free(p) do {} while (0)
754#else
755# define xalloca(size) (xmalloc(size))
756# define xalloca_free(p) (free(p))
757#endif
112db553
LT
758extern char *xstrdup(const char *str);
759extern void *xmalloc(size_t size);
5bf9219d 760extern void *xmallocz(size_t size);
f8bb1d94 761extern void *xmallocz_gently(size_t size);
112db553
LT
762extern void *xmemdupz(const void *data, size_t len);
763extern char *xstrndup(const char *str, size_t len);
764extern void *xrealloc(void *ptr, size_t size);
765extern void *xcalloc(size_t nmemb, size_t size);
766extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
1570856b 767extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
3ff53df7 768extern int xopen(const char *path, int flags, ...);
112db553
LT
769extern ssize_t xread(int fd, void *buf, size_t len);
770extern ssize_t xwrite(int fd, const void *buf, size_t len);
9aa91af0 771extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
112db553 772extern int xdup(int fd);
260eec29 773extern FILE *xfopen(const char *path, const char *mode);
112db553
LT
774extern FILE *xfdopen(int fd, const char *mode);
775extern int xmkstemp(char *template);
463db9b1 776extern int xmkstemp_mode(char *template, int mode);
6e180cdc 777extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
8640d496 778extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
aa14e980 779extern char *xgetcwd(void);
79d7582e 780extern FILE *fopen_for_writing(const char *path);
f21a47b2 781
e7792a74
JK
782#define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
783#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
3ac22f82 784
d64ea0f8
JK
785static inline char *xstrdup_or_null(const char *str)
786{
787 return str ? xstrdup(str) : NULL;
788}
789
dc49cd76
SP
790static inline size_t xsize_t(off_t len)
791{
46be82df
TR
792 if (len > (size_t) len)
793 die("Cannot handle files this big");
dc49cd76
SP
794 return (size_t)len;
795}
796
7b03c89e
JK
797__attribute__((format (printf, 3, 4)))
798extern int xsnprintf(char *dst, size_t max, const char *fmt, ...);
799
f1589d10 800/* in ctype.c, for kwset users */
189c860c 801extern const unsigned char tolower_trans_tbl[256];
f1589d10 802
4050c0df 803/* Sane ctype - no locale, and works with signed chars */
c2e9364a 804#undef isascii
4050c0df
JH
805#undef isspace
806#undef isdigit
807#undef isalpha
808#undef isalnum
0fcec2ce 809#undef isprint
43ccdf56
NK
810#undef islower
811#undef isupper
4050c0df
JH
812#undef tolower
813#undef toupper
1c149ab2
NTND
814#undef iscntrl
815#undef ispunct
816#undef isxdigit
2adf7247 817
ca5ab7d1 818extern const unsigned char sane_ctype[256];
4050c0df
JH
819#define GIT_SPACE 0x01
820#define GIT_DIGIT 0x02
821#define GIT_ALPHA 0x04
8cc32992 822#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 823#define GIT_REGEX_SPECIAL 0x10
2f6c9760 824#define GIT_PATHSPEC_MAGIC 0x20
1c149ab2
NTND
825#define GIT_CNTRL 0x40
826#define GIT_PUNCT 0x80
4050c0df 827#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 828#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
829#define isspace(x) sane_istest(x,GIT_SPACE)
830#define isdigit(x) sane_istest(x,GIT_DIGIT)
831#define isalpha(x) sane_istest(x,GIT_ALPHA)
832#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
0fcec2ce 833#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
43ccdf56
NK
834#define islower(x) sane_iscase(x, 1)
835#define isupper(x) sane_iscase(x, 0)
8cc32992 836#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 837#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1c149ab2
NTND
838#define iscntrl(x) (sane_istest(x,GIT_CNTRL))
839#define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
840 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
50a71776 841#define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
4050c0df
JH
842#define tolower(x) sane_case((unsigned char)(x), 0x20)
843#define toupper(x) sane_case((unsigned char)(x), 0)
2f6c9760 844#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
4050c0df
JH
845
846static inline int sane_case(int x, int high)
847{
848 if (sane_istest(x, GIT_ALPHA))
849 x = (x & ~0x20) | high;
850 return x;
851}
852
43ccdf56
NK
853static inline int sane_iscase(int x, int is_lower)
854{
855 if (!sane_istest(x, GIT_ALPHA))
856 return 0;
857
858 if (is_lower)
859 return (x & 0x20) != 0;
860 else
861 return (x & 0x20) == 0;
862}
863
6aead43d
JM
864static inline int strtoul_ui(char const *s, int base, unsigned int *result)
865{
866 unsigned long ul;
867 char *p;
868
869 errno = 0;
e6f2599c
MM
870 /* negative values would be accepted by strtoul */
871 if (strchr(s, '-'))
872 return -1;
6aead43d
JM
873 ul = strtoul(s, &p, base);
874 if (errno || *p || p == s || (unsigned int) ul != ul)
875 return -1;
876 *result = ul;
877 return 0;
878}
879
7791ecbc
JH
880static inline int strtol_i(char const *s, int base, int *result)
881{
882 long ul;
883 char *p;
884
885 errno = 0;
886 ul = strtol(s, &p, base);
887 if (errno || *p || p == s || (int) ul != ul)
888 return -1;
889 *result = ul;
890 return 0;
891}
892
43fe901b
BD
893#ifdef INTERNAL_QSORT
894void git_qsort(void *base, size_t nmemb, size_t size,
895 int(*compar)(const void *, const void *));
896#define qsort git_qsort
897#endif
898
81a24b52
AR
899#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
900# define FORCE_DIR_SET_GID S_ISGID
901#else
902# define FORCE_DIR_SET_GID 0
903#endif
904
c06ff490
KB
905#ifdef NO_NSEC
906#undef USE_NSEC
907#define ST_CTIME_NSEC(st) 0
908#define ST_MTIME_NSEC(st) 0
909#else
c567383b
BG
910#ifdef USE_ST_TIMESPEC
911#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
912#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
913#else
c06ff490
KB
914#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
915#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
916#endif
c567383b 917#endif
c06ff490 918
34779c53
JS
919#ifdef UNRELIABLE_FSTAT
920#define fstat_is_reliable() 0
921#else
922#define fstat_is_reliable() 1
923#endif
924
ab8632ae 925#ifndef va_copy
26db0f2e
JN
926/*
927 * Since an obvious implementation of va_list would be to make it a
928 * pointer into the stack frame, a simple assignment will work on
929 * many systems. But let's try to be more portable.
930 */
931#ifdef __va_copy
932#define va_copy(dst, src) __va_copy(dst, src)
933#else
934#define va_copy(dst, src) ((dst) = (src))
935#endif
ab8632ae
JK
936#endif
937
f51140c2 938#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
e05bed96
KB
939#define HAVE_VARIADIC_MACROS 1
940#endif
941
fc71db39
AR
942/*
943 * Preserves errno, prints a message, but gives no warning for ENOENT.
1054af7d
RS
944 * Returns 0 on success, which includes trying to unlink an object that does
945 * not exist.
fc71db39
AR
946 */
947int unlink_or_warn(const char *path);
9ccc0c08
RS
948 /*
949 * Tries to unlink file. Returns 0 if unlink succeeded
950 * or the file already didn't exist. Returns -1 and
951 * appends a message to err suitable for
952 * 'error("%s", err->buf)' on error.
953 */
954int unlink_or_msg(const char *file, struct strbuf *err);
d1723296 955/*
1054af7d
RS
956 * Preserves errno, prints a message, but gives no warning for ENOENT.
957 * Returns 0 on success, which includes trying to remove a directory that does
958 * not exist.
d1723296
PC
959 */
960int rmdir_or_warn(const char *path);
80d706af
PC
961/*
962 * Calls the correct function out of {unlink,rmdir}_or_warn based on
963 * the supplied file mode.
964 */
965int remove_or_warn(unsigned int mode, const char *path);
fc71db39 966
e5c52c98
JN
967/*
968 * Call access(2), but warn for any error except "missing file"
969 * (ENOENT or ENOTDIR).
970 */
4698c8fe
JN
971#define ACCESS_EACCES_OK (1U << 0)
972int access_or_warn(const char *path, int mode, unsigned flag);
973int access_or_die(const char *path, int mode, unsigned flag);
ba8bd830 974
55b38a48
JH
975/* Warn on an inaccessible file that ought to be accessible */
976void warn_on_inaccessible(const char *path);
977
66547547
JK
978#ifdef GMTIME_UNRELIABLE_ERRORS
979struct tm *git_gmtime(const time_t *);
980struct tm *git_gmtime_r(const time_t *, struct tm *);
981#define gmtime git_gmtime
982#define gmtime_r git_gmtime_r
983#endif
984
290c8e7a
KM
985#if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
986#define USE_PARENS_AROUND_GETTEXT_N 1
987#endif
988
1b56cdf9
KM
989#ifndef SHELL_PATH
990# define SHELL_PATH "/bin/sh"
991#endif
992
f43cce23
JK
993#ifndef _POSIX_THREAD_SAFE_FUNCTIONS
994#define flockfile(fh)
995#define funlockfile(fh)
996#define getc_unlocked(fh) getc(fh)
997#endif
998
4050c0df 999#endif