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