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