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