add COPY_ARRAY
[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>
282#endif
283
3b130ade
DM
284/* On most systems <netdb.h> would have given us this, but
285 * not on some systems (e.g. z/OS).
286 */
287#ifndef NI_MAXHOST
288#define NI_MAXHOST 1025
289#endif
290
291#ifndef NI_MAXSERV
292#define NI_MAXSERV 32
293#endif
294
d0c2449f
JH
295/* On most systems <limits.h> would have given us this, but
296 * not on some systems (e.g. GNU/Hurd).
297 */
298#ifndef PATH_MAX
299#define PATH_MAX 4096
300#endif
301
c4001d92
SP
302#ifndef PRIuMAX
303#define PRIuMAX "llu"
304#endif
305
fdcdb778
WM
306#ifndef SCNuMAX
307#define SCNuMAX PRIuMAX
308#endif
309
607bb3ff
JS
310#ifndef PRIu32
311#define PRIu32 "u"
312#endif
313
314#ifndef PRIx32
315#define PRIx32 "x"
316#endif
317
5418d96d
RJ
318#ifndef PRIo32
319#define PRIo32 "o"
320#endif
321
80ba074f
JS
322#ifndef PATH_SEP
323#define PATH_SEP ':'
324#endif
325
cb6a22c0
CW
326#ifdef HAVE_PATHS_H
327#include <paths.h>
328#endif
329#ifndef _PATH_DEFPATH
330#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
331#endif
332
25fe217b 333#ifndef has_dos_drive_prefix
bf728346
RS
334static inline int git_has_dos_drive_prefix(const char *path)
335{
336 return 0;
337}
338#define has_dos_drive_prefix git_has_dos_drive_prefix
25fe217b
JS
339#endif
340
2f36eed9
JS
341#ifndef skip_dos_drive_prefix
342static inline int git_skip_dos_drive_prefix(char **path)
343{
344 return 0;
345}
346#define skip_dos_drive_prefix git_skip_dos_drive_prefix
347#endif
348
bf728346
RS
349#ifndef is_dir_sep
350static inline int git_is_dir_sep(int c)
351{
352 return c == '/';
353}
354#define is_dir_sep git_is_dir_sep
c2369bdf
CZ
355#endif
356
bf728346
RS
357#ifndef offset_1st_component
358static inline int git_offset_1st_component(const char *path)
359{
360 return is_dir_sep(path[0]);
361}
362#define offset_1st_component git_offset_1st_component
25fe217b
JS
363#endif
364
d1c69255 365#ifndef find_last_dir_sep
bf728346
RS
366static inline char *git_find_last_dir_sep(const char *path)
367{
368 return strrchr(path, '/');
369}
370#define find_last_dir_sep git_find_last_dir_sep
d1c69255
TN
371#endif
372
e4ac953b 373#if defined(__HP_cc) && (__HP_cc >= 61000)
b6ab349b
MR
374#define NORETURN __attribute__((noreturn))
375#define NORETURN_PTR
6520c846 376#elif defined(__GNUC__) && !defined(NO_NORETURN)
4050c0df 377#define NORETURN __attribute__((__noreturn__))
18660bc9 378#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8
RJ
379#elif defined(_MSC_VER)
380#define NORETURN __declspec(noreturn)
381#define NORETURN_PTR
4050c0df
JH
382#else
383#define NORETURN
18660bc9 384#define NORETURN_PTR
8cd7ebc8 385#ifndef __GNUC__
4050c0df
JH
386#ifndef __attribute__
387#define __attribute__(x)
388#endif
389#endif
8cd7ebc8 390#endif
4050c0df 391
9fe3edc4
RJ
392/* The sentinel attribute is valid from gcc version 4.0 */
393#if defined(__GNUC__) && (__GNUC__ >= 4)
394#define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
395#else
396#define LAST_ARG_MUST_BE_NULL
397#endif
398
51ea5519
NP
399#include "compat/bswap.h"
400
cebcab18 401#include "wildmatch.h"
cebcab18 402
9ccc0c08
RS
403struct strbuf;
404
4050c0df 405/* General helper functions */
ebaa79f4 406extern void vreportf(const char *prefix, const char *err, va_list params);
a4f3131c 407extern NORETURN void usage(const char *err);
64b1cb74 408extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
a4f3131c
EFL
409extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
410extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 411extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
fd1d6723 412extern int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 413extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
fd1d6723 414extern void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 415
f2be034c
BG
416#ifndef NO_OPENSSL
417#ifdef APPLE_COMMON_CRYPTO
418#include "compat/apple-common-crypto.h"
419#else
420#include <openssl/evp.h>
421#include <openssl/hmac.h>
422#endif /* APPLE_COMMON_CRYPTO */
423#include <openssl/x509v3.h>
424#endif /* NO_OPENSSL */
425
e208f9cc
JK
426/*
427 * Let callers be aware of the constant return value; this can help
9798f7e5
MK
428 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
429 * because some compilers may not support variadic macros. Since we're only
430 * trying to help gcc, anyway, it's OK; other compilers will fall back to
431 * using the function as usual.
e208f9cc 432 */
ff0a80af 433#if defined(__GNUC__)
87fe5df3
JK
434static inline int const_error(void)
435{
436 return -1;
437}
438#define error(...) (error(__VA_ARGS__), const_error())
e208f9cc
JK
439#endif
440
18660bc9 441extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
3bc4181f 442extern void set_error_routine(void (*routine)(const char *err, va_list params));
c19a490e 443extern void set_die_is_recursing_routine(int (*routine)(void));
3b331e92 444extern void set_error_handle(FILE *);
39a3f5ea 445
95662315 446extern int starts_with(const char *str, const char *prefix);
698a68be 447
cf4fff57
JK
448/*
449 * If the string "str" begins with the string found in "prefix", return 1.
450 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
451 * the string right after the prefix).
452 *
453 * Otherwise, return 0 and leave "out" untouched.
454 *
455 * Examples:
456 *
457 * [extract branch name, fail if not a branch]
458 * if (!skip_prefix(ref, "refs/heads/", &branch)
459 * return -1;
460 *
461 * [skip prefix if present, otherwise use whole string]
462 * skip_prefix(name, "refs/heads/", &name);
463 */
464static inline int skip_prefix(const char *str, const char *prefix,
465 const char **out)
fbca5837 466{
ba399c46 467 do {
cf4fff57
JK
468 if (!*prefix) {
469 *out = str;
470 return 1;
471 }
ba399c46 472 } while (*str++ == *prefix++);
cf4fff57 473 return 0;
fbca5837
MV
474}
475
ae989a61
JK
476/*
477 * Like skip_prefix, but promises never to read past "len" bytes of the input
478 * buffer, and returns the remaining number of bytes in "out" via "outlen".
479 */
480static inline int skip_prefix_mem(const char *buf, size_t len,
481 const char *prefix,
482 const char **out, size_t *outlen)
483{
484 size_t prefix_len = strlen(prefix);
485 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
486 *out = buf + prefix_len;
487 *outlen = len - prefix_len;
488 return 1;
489 }
490 return 0;
491}
492
35480f0b
JK
493/*
494 * If buf ends with suffix, return 1 and subtract the length of the suffix
495 * from *len. Otherwise, return 0 and leave *len untouched.
496 */
497static inline int strip_suffix_mem(const char *buf, size_t *len,
498 const char *suffix)
499{
500 size_t suflen = strlen(suffix);
501 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
502 return 0;
503 *len -= suflen;
504 return 1;
505}
506
507/*
508 * If str ends with suffix, return 1 and set *len to the size of the string
509 * without the suffix. Otherwise, return 0 and set *len to the size of the
510 * string.
511 *
512 * Note that we do _not_ NUL-terminate str to the new length.
513 */
514static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
515{
516 *len = strlen(str);
517 return strip_suffix_mem(str, len, suffix);
518}
519
f52a35fd
JK
520static inline int ends_with(const char *str, const char *suffix)
521{
522 size_t len;
523 return strip_suffix(str, suffix, &len);
524}
525
b130a72b 526#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
527
528#ifndef PROT_READ
529#define PROT_READ 1
530#define PROT_WRITE 2
531#define MAP_PRIVATE 1
4050c0df
JH
532#endif
533
d6779124
SP
534#define mmap git_mmap
535#define munmap git_munmap
536extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
537extern int git_munmap(void *start, size_t length);
4050c0df 538
b130a72b
JL
539#else /* NO_MMAP || USE_WIN32_MMAP */
540
541#include <sys/mman.h>
542
543#endif /* NO_MMAP || USE_WIN32_MMAP */
544
545#ifdef NO_MMAP
546
5faaf246 547/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
548#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
549
4050c0df
JH
550#else /* NO_MMAP */
551
5faaf246 552/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
553#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
554 (sizeof(void*) >= 8 \
555 ? 1 * 1024 * 1024 * 1024 \
556 : 32 * 1024 * 1024)
4050c0df
JH
557
558#endif /* NO_MMAP */
559
fcf3a21a
GV
560#ifndef MAP_FAILED
561#define MAP_FAILED ((void *)-1)
562#endif
563
fdb2a2a6
JH
564#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
565#define on_disk_bytes(st) ((st).st_size)
566#else
567#define on_disk_bytes(st) ((st).st_blocks * 512)
568#endif
569
d543d9c0
DM
570#ifdef NEEDS_MODE_TRANSLATION
571#undef S_IFMT
572#undef S_IFREG
573#undef S_IFDIR
574#undef S_IFLNK
575#undef S_IFBLK
576#undef S_IFCHR
577#undef S_IFIFO
578#undef S_IFSOCK
579#define S_IFMT 0170000
580#define S_IFREG 0100000
581#define S_IFDIR 0040000
582#define S_IFLNK 0120000
583#define S_IFBLK 0060000
584#define S_IFCHR 0020000
585#define S_IFIFO 0010000
586#define S_IFSOCK 0140000
587#ifdef stat
588#undef stat
589#endif
590#define stat(path, buf) git_stat(path, buf)
591extern int git_stat(const char *, struct stat *);
592#ifdef fstat
593#undef fstat
594#endif
595#define fstat(fd, buf) git_fstat(fd, buf)
596extern int git_fstat(int, struct stat *);
597#ifdef lstat
598#undef lstat
599#endif
600#define lstat(path, buf) git_lstat(path, buf)
601extern int git_lstat(const char *, struct stat *);
602#endif
603
22bac0ea 604#define DEFAULT_PACKED_GIT_LIMIT \
8f774423 605 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 606
6900679c
SH
607#ifdef NO_PREAD
608#define pread git_pread
609extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
610#endif
14086b0a
SP
611/*
612 * Forward decl that will remind us if its twin in cache.h changes.
613 * This function is used in compat/pread.c. But we can't include
614 * cache.h there.
615 */
616extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 617
4050c0df
JH
618#ifdef NO_SETENV
619#define setenv gitsetenv
620extern int gitsetenv(const char *, const char *, int);
621#endif
622
ca5bb5d5
SP
623#ifdef NO_MKDTEMP
624#define mkdtemp gitmkdtemp
625extern char *gitmkdtemp(char *);
626#endif
627
0620b39b
DA
628#ifdef NO_MKSTEMPS
629#define mkstemps gitmkstemps
630extern int gitmkstemps(char *, int);
631#endif
632
731043fd
JR
633#ifdef NO_UNSETENV
634#define unsetenv gitunsetenv
635extern void gitunsetenv(const char *);
636#endif
637
4050c0df
JH
638#ifdef NO_STRCASESTR
639#define strcasestr gitstrcasestr
640extern char *gitstrcasestr(const char *haystack, const char *needle);
641#endif
642
817151e6
PE
643#ifdef NO_STRLCPY
644#define strlcpy gitstrlcpy
645extern size_t gitstrlcpy(char *, const char *, size_t);
646#endif
647
bc6b4f52
JR
648#ifdef NO_STRTOUMAX
649#define strtoumax gitstrtoumax
650extern uintmax_t gitstrtoumax(const char *, char **, int);
97000ba6
JS
651#define strtoimax gitstrtoimax
652extern intmax_t gitstrtoimax(const char *, char **, int);
bc6b4f52
JR
653#endif
654
fa0c87c3
AR
655#ifdef NO_HSTRERROR
656#define hstrerror githstrerror
657extern const char *githstrerror(int herror);
658#endif
659
b21b9f1d
RS
660#ifdef NO_MEMMEM
661#define memmem gitmemmem
662void *gitmemmem(const void *haystack, size_t haystacklen,
663 const void *needle, size_t needlelen);
664#endif
665
40036bed
MK
666#ifdef NO_GETPAGESIZE
667#define getpagesize() sysconf(_SC_PAGESIZE)
668#endif
669
cba22528 670#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
671#ifdef fopen
672#undef fopen
673#endif
cba22528
BC
674#define fopen(a,b) git_fopen(a,b)
675extern FILE *git_fopen(const char*, const char*);
676#endif
677
c4582f93 678#ifdef SNPRINTF_RETURNS_BOGUS
ab03803c
BS
679#ifdef snprintf
680#undef snprintf
681#endif
c4582f93
MR
682#define snprintf git_snprintf
683extern int git_snprintf(char *str, size_t maxsize,
684 const char *format, ...);
ab03803c
BS
685#ifdef vsnprintf
686#undef vsnprintf
687#endif
c4582f93
MR
688#define vsnprintf git_vsnprintf
689extern int git_vsnprintf(char *str, size_t maxsize,
690 const char *format, va_list ap);
691#endif
692
726c8ef5
JS
693#ifdef __GLIBC_PREREQ
694#if __GLIBC_PREREQ(2, 1)
695#define HAVE_STRCHRNUL
696#endif
697#endif
698
699#ifndef HAVE_STRCHRNUL
659c69cf 700#define strchrnul gitstrchrnul
9e79f00f
AE
701static inline char *gitstrchrnul(const char *s, int c)
702{
703 while (*s && *s != c)
704 s++;
705 return (char *)s;
706}
659c69cf
RS
707#endif
708
da523cc5
MP
709#ifdef NO_INET_PTON
710int inet_pton(int af, const char *src, void *dst);
711#endif
712
713#ifdef NO_INET_NTOP
714const char *inet_ntop(int af, const void *src, char *dst, size_t size);
715#endif
716
0f4b6db3
EB
717#ifdef NO_PTHREADS
718#define atexit git_atexit
719extern int git_atexit(void (*handler)(void));
720#endif
721
7c3ecb32 722extern void release_pack_memory(size_t);
97bfeb34 723
851c34b0
JS
724typedef void (*try_to_free_t)(size_t);
725extern try_to_free_t set_try_to_free_routine(try_to_free_t);
320d0b49
JK
726
727static inline size_t st_add(size_t a, size_t b)
728{
729 if (unsigned_add_overflows(a, b))
730 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
731 (uintmax_t)a, (uintmax_t)b);
732 return a + b;
733}
d616fbf2
ES
734#define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
735#define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
320d0b49
JK
736
737static inline size_t st_mult(size_t a, size_t b)
738{
739 if (unsigned_mult_overflows(a, b))
740 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
741 (uintmax_t)a, (uintmax_t)b);
742 return a * b;
743}
744
745static inline size_t st_sub(size_t a, size_t b)
746{
747 if (a < b)
748 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
749 (uintmax_t)a, (uintmax_t)b);
750 return a - b;
751}
a9a74636 752
61f76a36
KS
753#ifdef HAVE_ALLOCA_H
754# include <alloca.h>
755# define xalloca(size) (alloca(size))
756# define xalloca_free(p) do {} while (0)
757#else
758# define xalloca(size) (xmalloc(size))
759# define xalloca_free(p) (free(p))
760#endif
112db553
LT
761extern char *xstrdup(const char *str);
762extern void *xmalloc(size_t size);
5bf9219d 763extern void *xmallocz(size_t size);
f8bb1d94 764extern void *xmallocz_gently(size_t size);
112db553
LT
765extern void *xmemdupz(const void *data, size_t len);
766extern char *xstrndup(const char *str, size_t len);
767extern void *xrealloc(void *ptr, size_t size);
768extern void *xcalloc(size_t nmemb, size_t size);
769extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
1570856b 770extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
3ff53df7 771extern int xopen(const char *path, int flags, ...);
112db553
LT
772extern ssize_t xread(int fd, void *buf, size_t len);
773extern ssize_t xwrite(int fd, const void *buf, size_t len);
9aa91af0 774extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
112db553 775extern int xdup(int fd);
260eec29 776extern FILE *xfopen(const char *path, const char *mode);
112db553
LT
777extern FILE *xfdopen(int fd, const char *mode);
778extern int xmkstemp(char *template);
463db9b1 779extern int xmkstemp_mode(char *template, int mode);
6e180cdc 780extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
8640d496 781extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
aa14e980 782extern char *xgetcwd(void);
79d7582e 783extern FILE *fopen_for_writing(const char *path);
f21a47b2 784
e7792a74
JK
785#define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
786#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
3ac22f82 787
60566cbb
RS
788#define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
789 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
790static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
791{
792 if (n)
793 memcpy(dst, src, st_mult(size, n));
794}
795
36895391
JK
796/*
797 * These functions help you allocate structs with flex arrays, and copy
798 * the data directly into the array. For example, if you had:
799 *
800 * struct foo {
801 * int bar;
802 * char name[FLEX_ARRAY];
803 * };
804 *
805 * you can do:
806 *
807 * struct foo *f;
808 * FLEX_ALLOC_MEM(f, name, src, len);
809 *
810 * to allocate a "foo" with the contents of "src" in the "name" field.
811 * The resulting struct is automatically zero'd, and the flex-array field
812 * is NUL-terminated (whether the incoming src buffer was or not).
813 *
814 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
815 * but do want to store a pointer to some extra data in the same allocated
816 * block. For example, if you have:
817 *
818 * struct foo {
819 * char *name;
820 * int bar;
821 * };
822 *
823 * you can do:
824 *
825 * struct foo *f;
826 * FLEX_ALLOC_STR(f, name, src);
827 *
828 * and "name" will point to a block of memory after the struct, which will be
829 * freed along with the struct (but the pointer can be repointed anywhere).
830 *
831 * The *_STR variants accept a string parameter rather than a ptr/len
832 * combination.
833 *
834 * Note that these macros will evaluate the first parameter multiple
835 * times, and it must be assignable as an lvalue.
836 */
837#define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
838 (x) = NULL; /* silence -Wuninitialized for offset calculation */ \
839 (x) = xalloc_flex(sizeof(*(x)), (char *)(&((x)->flexname)) - (char *)(x), (buf), (len)); \
840} while (0)
841#define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
842 (x) = xalloc_flex(sizeof(*(x)), sizeof(*(x)), (buf), (len)); \
843 (x)->ptrname = (void *)((x)+1); \
844} while(0)
845#define FLEX_ALLOC_STR(x, flexname, str) \
846 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
847#define FLEXPTR_ALLOC_STR(x, ptrname, str) \
848 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
849
850static inline void *xalloc_flex(size_t base_len, size_t offset,
851 const void *src, size_t src_len)
852{
853 unsigned char *ret = xcalloc(1, st_add3(base_len, src_len, 1));
854 memcpy(ret + offset, src, src_len);
855 return ret;
856}
857
d64ea0f8
JK
858static inline char *xstrdup_or_null(const char *str)
859{
860 return str ? xstrdup(str) : NULL;
861}
862
dc49cd76
SP
863static inline size_t xsize_t(off_t len)
864{
46be82df
TR
865 if (len > (size_t) len)
866 die("Cannot handle files this big");
dc49cd76
SP
867 return (size_t)len;
868}
869
7b03c89e
JK
870__attribute__((format (printf, 3, 4)))
871extern int xsnprintf(char *dst, size_t max, const char *fmt, ...);
872
f1589d10 873/* in ctype.c, for kwset users */
189c860c 874extern const unsigned char tolower_trans_tbl[256];
f1589d10 875
4050c0df 876/* Sane ctype - no locale, and works with signed chars */
c2e9364a 877#undef isascii
4050c0df
JH
878#undef isspace
879#undef isdigit
880#undef isalpha
881#undef isalnum
0fcec2ce 882#undef isprint
43ccdf56
NK
883#undef islower
884#undef isupper
4050c0df
JH
885#undef tolower
886#undef toupper
1c149ab2
NTND
887#undef iscntrl
888#undef ispunct
889#undef isxdigit
2adf7247 890
ca5ab7d1 891extern const unsigned char sane_ctype[256];
4050c0df
JH
892#define GIT_SPACE 0x01
893#define GIT_DIGIT 0x02
894#define GIT_ALPHA 0x04
8cc32992 895#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 896#define GIT_REGEX_SPECIAL 0x10
2f6c9760 897#define GIT_PATHSPEC_MAGIC 0x20
1c149ab2
NTND
898#define GIT_CNTRL 0x40
899#define GIT_PUNCT 0x80
4050c0df 900#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 901#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
902#define isspace(x) sane_istest(x,GIT_SPACE)
903#define isdigit(x) sane_istest(x,GIT_DIGIT)
904#define isalpha(x) sane_istest(x,GIT_ALPHA)
905#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
0fcec2ce 906#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
43ccdf56
NK
907#define islower(x) sane_iscase(x, 1)
908#define isupper(x) sane_iscase(x, 0)
8cc32992 909#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 910#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1c149ab2
NTND
911#define iscntrl(x) (sane_istest(x,GIT_CNTRL))
912#define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
913 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
50a71776 914#define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
4050c0df
JH
915#define tolower(x) sane_case((unsigned char)(x), 0x20)
916#define toupper(x) sane_case((unsigned char)(x), 0)
2f6c9760 917#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
4050c0df
JH
918
919static inline int sane_case(int x, int high)
920{
921 if (sane_istest(x, GIT_ALPHA))
922 x = (x & ~0x20) | high;
923 return x;
924}
925
43ccdf56
NK
926static inline int sane_iscase(int x, int is_lower)
927{
928 if (!sane_istest(x, GIT_ALPHA))
929 return 0;
930
931 if (is_lower)
932 return (x & 0x20) != 0;
933 else
934 return (x & 0x20) == 0;
935}
936
6aead43d
JM
937static inline int strtoul_ui(char const *s, int base, unsigned int *result)
938{
939 unsigned long ul;
940 char *p;
941
942 errno = 0;
e6f2599c
MM
943 /* negative values would be accepted by strtoul */
944 if (strchr(s, '-'))
945 return -1;
6aead43d
JM
946 ul = strtoul(s, &p, base);
947 if (errno || *p || p == s || (unsigned int) ul != ul)
948 return -1;
949 *result = ul;
950 return 0;
951}
952
7791ecbc
JH
953static inline int strtol_i(char const *s, int base, int *result)
954{
955 long ul;
956 char *p;
957
958 errno = 0;
959 ul = strtol(s, &p, base);
960 if (errno || *p || p == s || (int) ul != ul)
961 return -1;
962 *result = ul;
963 return 0;
964}
965
43fe901b
BD
966#ifdef INTERNAL_QSORT
967void git_qsort(void *base, size_t nmemb, size_t size,
968 int(*compar)(const void *, const void *));
969#define qsort git_qsort
970#endif
971
81a24b52
AR
972#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
973# define FORCE_DIR_SET_GID S_ISGID
974#else
975# define FORCE_DIR_SET_GID 0
976#endif
977
c06ff490
KB
978#ifdef NO_NSEC
979#undef USE_NSEC
980#define ST_CTIME_NSEC(st) 0
981#define ST_MTIME_NSEC(st) 0
982#else
c567383b
BG
983#ifdef USE_ST_TIMESPEC
984#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
985#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
986#else
c06ff490
KB
987#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
988#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
989#endif
c567383b 990#endif
c06ff490 991
34779c53
JS
992#ifdef UNRELIABLE_FSTAT
993#define fstat_is_reliable() 0
994#else
995#define fstat_is_reliable() 1
996#endif
997
ab8632ae 998#ifndef va_copy
26db0f2e
JN
999/*
1000 * Since an obvious implementation of va_list would be to make it a
1001 * pointer into the stack frame, a simple assignment will work on
1002 * many systems. But let's try to be more portable.
1003 */
1004#ifdef __va_copy
1005#define va_copy(dst, src) __va_copy(dst, src)
1006#else
1007#define va_copy(dst, src) ((dst) = (src))
1008#endif
ab8632ae
JK
1009#endif
1010
f51140c2 1011#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
e05bed96
KB
1012#define HAVE_VARIADIC_MACROS 1
1013#endif
1014
fc71db39
AR
1015/*
1016 * Preserves errno, prints a message, but gives no warning for ENOENT.
1054af7d
RS
1017 * Returns 0 on success, which includes trying to unlink an object that does
1018 * not exist.
fc71db39
AR
1019 */
1020int unlink_or_warn(const char *path);
9ccc0c08
RS
1021 /*
1022 * Tries to unlink file. Returns 0 if unlink succeeded
1023 * or the file already didn't exist. Returns -1 and
1024 * appends a message to err suitable for
1025 * 'error("%s", err->buf)' on error.
1026 */
1027int unlink_or_msg(const char *file, struct strbuf *err);
d1723296 1028/*
1054af7d
RS
1029 * Preserves errno, prints a message, but gives no warning for ENOENT.
1030 * Returns 0 on success, which includes trying to remove a directory that does
1031 * not exist.
d1723296
PC
1032 */
1033int rmdir_or_warn(const char *path);
80d706af
PC
1034/*
1035 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1036 * the supplied file mode.
1037 */
1038int remove_or_warn(unsigned int mode, const char *path);
fc71db39 1039
e5c52c98
JN
1040/*
1041 * Call access(2), but warn for any error except "missing file"
1042 * (ENOENT or ENOTDIR).
1043 */
4698c8fe
JN
1044#define ACCESS_EACCES_OK (1U << 0)
1045int access_or_warn(const char *path, int mode, unsigned flag);
1046int access_or_die(const char *path, int mode, unsigned flag);
ba8bd830 1047
55b38a48
JH
1048/* Warn on an inaccessible file that ought to be accessible */
1049void warn_on_inaccessible(const char *path);
1050
66547547
JK
1051#ifdef GMTIME_UNRELIABLE_ERRORS
1052struct tm *git_gmtime(const time_t *);
1053struct tm *git_gmtime_r(const time_t *, struct tm *);
1054#define gmtime git_gmtime
1055#define gmtime_r git_gmtime_r
1056#endif
1057
290c8e7a
KM
1058#if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1059#define USE_PARENS_AROUND_GETTEXT_N 1
1060#endif
1061
1b56cdf9
KM
1062#ifndef SHELL_PATH
1063# define SHELL_PATH "/bin/sh"
1064#endif
1065
f43cce23
JK
1066#ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1067#define flockfile(fh)
1068#define funlockfile(fh)
1069#define getc_unlocked(fh) getc(fh)
1070#endif
1071
4050c0df 1072#endif