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