1#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
4#define _FILE_OFFSET_BITS 64
5
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
23#ifndef FLEX_ARRAY
24/*
25 * See if our compiler is known to support flexible array members.
26 */
27#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
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
42#endif
43#endif
44
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 GIT_GNUC_PREREQ(3, 1)
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])))
66#else
67# define BARF_UNLESS_AN_ARRAY(arr) 0
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
79#define bitsizeof(x) (CHAR_BIT * sizeof(x))
80
81#define maximum_signed_value_of_type(a) \
82 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
83
84#define maximum_unsigned_value_of_type(a) \
85 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
86
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
96#define unsigned_add_overflows(a, b) \
97 ((b) > maximum_unsigned_value_of_type(a) - (a))
98
99#ifdef __GNUC__
100#define TYPEOF(x) (__typeof__(x))
101#else
102#define TYPEOF(x)
103#endif
104
105#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
106#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
107
108#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
109
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
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
126#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
127 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
128 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
129 !defined(__CYGWIN__)
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 */
132#endif
133#define _ALL_SOURCE 1
134#define _GNU_SOURCE 1
135#define _BSD_SOURCE 1
136#define _DEFAULT_SOURCE 1
137#define _NETBSD_SOURCE 1
138#define _SGI_SOURCE 1
139
140#if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
141# if defined (_MSC_VER) && !defined(_WIN32_WINNT)
142# define _WIN32_WINNT 0x0502
143# endif
144#define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
145#include <winsock2.h>
146#include <windows.h>
147#define GIT_WINDOWS_NATIVE
148#endif
149
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>
158#ifdef HAVE_STRINGS_H
159#include <strings.h> /* for strcasecmp() */
160#endif
161#include <errno.h>
162#include <limits.h>
163#ifdef NEEDS_SYS_PARAM_H
164#include <sys/param.h>
165#endif
166#include <sys/types.h>
167#include <dirent.h>
168#include <sys/time.h>
169#include <time.h>
170#include <signal.h>
171#include <assert.h>
172#include <regex.h>
173#include <utime.h>
174#include <syslog.h>
175#ifndef NO_SYS_POLL_H
176#include <sys/poll.h>
177#else
178#include <poll.h>
179#endif
180#ifdef HAVE_BSD_SYSCTL
181#include <sys/sysctl.h>
182#endif
183
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
190#include <sys/utsname.h>
191#include <sys/wait.h>
192#include <sys/resource.h>
193#include <sys/socket.h>
194#include <sys/ioctl.h>
195#include <termios.h>
196#ifndef NO_SYS_SELECT_H
197#include <sys/select.h>
198#endif
199#include <netinet/in.h>
200#include <netinet/tcp.h>
201#include <arpa/inet.h>
202#include <netdb.h>
203#include <pwd.h>
204#include <sys/un.h>
205#ifndef NO_INTTYPES_H
206#include <inttypes.h>
207#else
208#include <stdint.h>
209#endif
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
221#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
222#include <grp.h>
223#define _ALL_SOURCE 1
224#endif
225
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)
232#define probe_utf8_pathname_composition()
233#endif
234
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
240#ifdef NO_STRUCT_ITIMERVAL
241struct itimerval {
242 struct timeval it_interval;
243 struct timeval it_value;
244};
245#endif
246
247#ifdef NO_SETITIMER
248#define setitimer(which,value,ovalue)
249#endif
250
251#ifndef NO_LIBGEN_H
252#include <libgen.h>
253#else
254#define basename gitbasename
255extern char *gitbasename(char *);
256#define dirname gitdirname
257extern char *gitdirname(char *);
258#endif
259
260#ifndef NO_ICONV
261#include <iconv.h>
262#endif
263
264#ifndef NO_OPENSSL
265#ifdef __APPLE__
266#define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
267#include <AvailabilityMacros.h>
268#undef DEPRECATED_ATTRIBUTE
269#define DEPRECATED_ATTRIBUTE
270#undef __AVAILABILITY_MACROS_USES_AVAILABILITY
271#endif
272#include <openssl/ssl.h>
273#include <openssl/err.h>
274#ifdef NO_HMAC_CTX_CLEANUP
275#define HMAC_CTX_cleanup HMAC_cleanup
276#endif
277#endif
278
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
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
297#ifndef PRIuMAX
298#define PRIuMAX "llu"
299#endif
300
301#ifndef SCNuMAX
302#define SCNuMAX PRIuMAX
303#endif
304
305#ifndef PRIu32
306#define PRIu32 "u"
307#endif
308
309#ifndef PRIx32
310#define PRIx32 "x"
311#endif
312
313#ifndef PRIo32
314#define PRIo32 "o"
315#endif
316
317#ifndef PATH_SEP
318#define PATH_SEP ':'
319#endif
320
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
328#ifndef has_dos_drive_prefix
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
334#endif
335
336#ifndef skip_dos_drive_prefix
337static inline int git_skip_dos_drive_prefix(char **path)
338{
339 return 0;
340}
341#define skip_dos_drive_prefix git_skip_dos_drive_prefix
342#endif
343
344#ifndef is_dir_sep
345static inline int git_is_dir_sep(int c)
346{
347 return c == '/';
348}
349#define is_dir_sep git_is_dir_sep
350#endif
351
352#ifndef offset_1st_component
353static inline int git_offset_1st_component(const char *path)
354{
355 return is_dir_sep(path[0]);
356}
357#define offset_1st_component git_offset_1st_component
358#endif
359
360#ifndef find_last_dir_sep
361static inline char *git_find_last_dir_sep(const char *path)
362{
363 return strrchr(path, '/');
364}
365#define find_last_dir_sep git_find_last_dir_sep
366#endif
367
368#if defined(__HP_cc) && (__HP_cc >= 61000)
369#define NORETURN __attribute__((noreturn))
370#define NORETURN_PTR
371#elif defined(__GNUC__) && !defined(NO_NORETURN)
372#define NORETURN __attribute__((__noreturn__))
373#define NORETURN_PTR __attribute__((__noreturn__))
374#elif defined(_MSC_VER)
375#define NORETURN __declspec(noreturn)
376#define NORETURN_PTR
377#else
378#define NORETURN
379#define NORETURN_PTR
380#ifndef __GNUC__
381#ifndef __attribute__
382#define __attribute__(x)
383#endif
384#endif
385#endif
386
387/* The sentinel attribute is valid from gcc version 4.0 */
388#if defined(__GNUC__) && (__GNUC__ >= 4)
389#define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
390#else
391#define LAST_ARG_MUST_BE_NULL
392#endif
393
394#include "compat/bswap.h"
395
396#include "wildmatch.h"
397
398struct strbuf;
399
400/* General helper functions */
401extern void vreportf(const char *prefix, const char *err, va_list params);
402extern NORETURN void usage(const char *err);
403extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
404extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
405extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
406extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
407extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
408
409#ifndef NO_OPENSSL
410#ifdef APPLE_COMMON_CRYPTO
411#include "compat/apple-common-crypto.h"
412#else
413#include <openssl/evp.h>
414#include <openssl/hmac.h>
415#endif /* APPLE_COMMON_CRYPTO */
416#include <openssl/x509v3.h>
417#endif /* NO_OPENSSL */
418
419/*
420 * Let callers be aware of the constant return value; this can help
421 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
422 * because some compilers may not support variadic macros. Since we're only
423 * trying to help gcc, anyway, it's OK; other compilers will fall back to
424 * using the function as usual.
425 */
426#if defined(__GNUC__)
427static inline int const_error(void)
428{
429 return -1;
430}
431#define error(...) (error(__VA_ARGS__), const_error())
432#endif
433
434extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
435extern void set_error_routine(void (*routine)(const char *err, va_list params));
436extern void set_die_is_recursing_routine(int (*routine)(void));
437extern void set_error_handle(FILE *);
438
439extern int starts_with(const char *str, const char *prefix);
440
441/*
442 * If the string "str" begins with the string found in "prefix", return 1.
443 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
444 * the string right after the prefix).
445 *
446 * Otherwise, return 0 and leave "out" untouched.
447 *
448 * Examples:
449 *
450 * [extract branch name, fail if not a branch]
451 * if (!skip_prefix(ref, "refs/heads/", &branch)
452 * return -1;
453 *
454 * [skip prefix if present, otherwise use whole string]
455 * skip_prefix(name, "refs/heads/", &name);
456 */
457static inline int skip_prefix(const char *str, const char *prefix,
458 const char **out)
459{
460 do {
461 if (!*prefix) {
462 *out = str;
463 return 1;
464 }
465 } while (*str++ == *prefix++);
466 return 0;
467}
468
469/*
470 * If buf ends with suffix, return 1 and subtract the length of the suffix
471 * from *len. Otherwise, return 0 and leave *len untouched.
472 */
473static inline int strip_suffix_mem(const char *buf, size_t *len,
474 const char *suffix)
475{
476 size_t suflen = strlen(suffix);
477 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
478 return 0;
479 *len -= suflen;
480 return 1;
481}
482
483/*
484 * If str ends with suffix, return 1 and set *len to the size of the string
485 * without the suffix. Otherwise, return 0 and set *len to the size of the
486 * string.
487 *
488 * Note that we do _not_ NUL-terminate str to the new length.
489 */
490static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
491{
492 *len = strlen(str);
493 return strip_suffix_mem(str, len, suffix);
494}
495
496static inline int ends_with(const char *str, const char *suffix)
497{
498 size_t len;
499 return strip_suffix(str, suffix, &len);
500}
501
502#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
503
504#ifndef PROT_READ
505#define PROT_READ 1
506#define PROT_WRITE 2
507#define MAP_PRIVATE 1
508#endif
509
510#define mmap git_mmap
511#define munmap git_munmap
512extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
513extern int git_munmap(void *start, size_t length);
514
515#else /* NO_MMAP || USE_WIN32_MMAP */
516
517#include <sys/mman.h>
518
519#endif /* NO_MMAP || USE_WIN32_MMAP */
520
521#ifdef NO_MMAP
522
523/* This value must be multiple of (pagesize * 2) */
524#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
525
526#else /* NO_MMAP */
527
528/* This value must be multiple of (pagesize * 2) */
529#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
530 (sizeof(void*) >= 8 \
531 ? 1 * 1024 * 1024 * 1024 \
532 : 32 * 1024 * 1024)
533
534#endif /* NO_MMAP */
535
536#ifndef MAP_FAILED
537#define MAP_FAILED ((void *)-1)
538#endif
539
540#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
541#define on_disk_bytes(st) ((st).st_size)
542#else
543#define on_disk_bytes(st) ((st).st_blocks * 512)
544#endif
545
546#ifdef NEEDS_MODE_TRANSLATION
547#undef S_IFMT
548#undef S_IFREG
549#undef S_IFDIR
550#undef S_IFLNK
551#undef S_IFBLK
552#undef S_IFCHR
553#undef S_IFIFO
554#undef S_IFSOCK
555#define S_IFMT 0170000
556#define S_IFREG 0100000
557#define S_IFDIR 0040000
558#define S_IFLNK 0120000
559#define S_IFBLK 0060000
560#define S_IFCHR 0020000
561#define S_IFIFO 0010000
562#define S_IFSOCK 0140000
563#ifdef stat
564#undef stat
565#endif
566#define stat(path, buf) git_stat(path, buf)
567extern int git_stat(const char *, struct stat *);
568#ifdef fstat
569#undef fstat
570#endif
571#define fstat(fd, buf) git_fstat(fd, buf)
572extern int git_fstat(int, struct stat *);
573#ifdef lstat
574#undef lstat
575#endif
576#define lstat(path, buf) git_lstat(path, buf)
577extern int git_lstat(const char *, struct stat *);
578#endif
579
580#define DEFAULT_PACKED_GIT_LIMIT \
581 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? 8192 : 256))
582
583#ifdef NO_PREAD
584#define pread git_pread
585extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
586#endif
587/*
588 * Forward decl that will remind us if its twin in cache.h changes.
589 * This function is used in compat/pread.c. But we can't include
590 * cache.h there.
591 */
592extern ssize_t read_in_full(int fd, void *buf, size_t count);
593
594#ifdef NO_SETENV
595#define setenv gitsetenv
596extern int gitsetenv(const char *, const char *, int);
597#endif
598
599#ifdef NO_MKDTEMP
600#define mkdtemp gitmkdtemp
601extern char *gitmkdtemp(char *);
602#endif
603
604#ifdef NO_MKSTEMPS
605#define mkstemps gitmkstemps
606extern int gitmkstemps(char *, int);
607#endif
608
609#ifdef NO_UNSETENV
610#define unsetenv gitunsetenv
611extern void gitunsetenv(const char *);
612#endif
613
614#ifdef NO_STRCASESTR
615#define strcasestr gitstrcasestr
616extern char *gitstrcasestr(const char *haystack, const char *needle);
617#endif
618
619#ifdef NO_STRLCPY
620#define strlcpy gitstrlcpy
621extern size_t gitstrlcpy(char *, const char *, size_t);
622#endif
623
624#ifdef NO_STRTOUMAX
625#define strtoumax gitstrtoumax
626extern uintmax_t gitstrtoumax(const char *, char **, int);
627#define strtoimax gitstrtoimax
628extern intmax_t gitstrtoimax(const char *, char **, int);
629#endif
630
631#ifdef NO_HSTRERROR
632#define hstrerror githstrerror
633extern const char *githstrerror(int herror);
634#endif
635
636#ifdef NO_MEMMEM
637#define memmem gitmemmem
638void *gitmemmem(const void *haystack, size_t haystacklen,
639 const void *needle, size_t needlelen);
640#endif
641
642#ifdef NO_GETPAGESIZE
643#define getpagesize() sysconf(_SC_PAGESIZE)
644#endif
645
646#ifdef FREAD_READS_DIRECTORIES
647#ifdef fopen
648#undef fopen
649#endif
650#define fopen(a,b) git_fopen(a,b)
651extern FILE *git_fopen(const char*, const char*);
652#endif
653
654#ifdef SNPRINTF_RETURNS_BOGUS
655#ifdef snprintf
656#undef snprintf
657#endif
658#define snprintf git_snprintf
659extern int git_snprintf(char *str, size_t maxsize,
660 const char *format, ...);
661#ifdef vsnprintf
662#undef vsnprintf
663#endif
664#define vsnprintf git_vsnprintf
665extern int git_vsnprintf(char *str, size_t maxsize,
666 const char *format, va_list ap);
667#endif
668
669#ifdef __GLIBC_PREREQ
670#if __GLIBC_PREREQ(2, 1)
671#define HAVE_STRCHRNUL
672#define HAVE_MEMPCPY
673#endif
674#endif
675
676#ifndef HAVE_STRCHRNUL
677#define strchrnul gitstrchrnul
678static inline char *gitstrchrnul(const char *s, int c)
679{
680 while (*s && *s != c)
681 s++;
682 return (char *)s;
683}
684#endif
685
686#ifndef HAVE_MEMPCPY
687#define mempcpy gitmempcpy
688static inline void *gitmempcpy(void *dest, const void *src, size_t n)
689{
690 return (char *)memcpy(dest, src, n) + n;
691}
692#endif
693
694#ifdef NO_INET_PTON
695int inet_pton(int af, const char *src, void *dst);
696#endif
697
698#ifdef NO_INET_NTOP
699const char *inet_ntop(int af, const void *src, char *dst, size_t size);
700#endif
701
702#ifdef NO_PTHREADS
703#define atexit git_atexit
704extern int git_atexit(void (*handler)(void));
705#endif
706
707extern void release_pack_memory(size_t);
708
709typedef void (*try_to_free_t)(size_t);
710extern try_to_free_t set_try_to_free_routine(try_to_free_t);
711
712#ifdef HAVE_ALLOCA_H
713# include <alloca.h>
714# define xalloca(size) (alloca(size))
715# define xalloca_free(p) do {} while (0)
716#else
717# define xalloca(size) (xmalloc(size))
718# define xalloca_free(p) (free(p))
719#endif
720extern char *xstrdup(const char *str);
721extern void *xmalloc(size_t size);
722extern void *xmallocz(size_t size);
723extern void *xmallocz_gently(size_t size);
724extern void *xmemdupz(const void *data, size_t len);
725extern char *xstrndup(const char *str, size_t len);
726extern void *xrealloc(void *ptr, size_t size);
727extern void *xcalloc(size_t nmemb, size_t size);
728extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
729extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
730extern int xopen(const char *path, int flags, ...);
731extern ssize_t xread(int fd, void *buf, size_t len);
732extern ssize_t xwrite(int fd, const void *buf, size_t len);
733extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
734extern int xdup(int fd);
735extern FILE *xfopen(const char *path, const char *mode);
736extern FILE *xfdopen(int fd, const char *mode);
737extern int xmkstemp(char *template);
738extern int xmkstemp_mode(char *template, int mode);
739extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
740extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
741extern char *xgetcwd(void);
742extern FILE *fopen_for_writing(const char *path);
743
744#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
745
746static inline char *xstrdup_or_null(const char *str)
747{
748 return str ? xstrdup(str) : NULL;
749}
750
751static inline size_t xsize_t(off_t len)
752{
753 if (len > (size_t) len)
754 die("Cannot handle files this big");
755 return (size_t)len;
756}
757
758__attribute__((format (printf, 3, 4)))
759extern int xsnprintf(char *dst, size_t max, const char *fmt, ...);
760
761/* in ctype.c, for kwset users */
762extern const unsigned char tolower_trans_tbl[256];
763
764/* Sane ctype - no locale, and works with signed chars */
765#undef isascii
766#undef isspace
767#undef isdigit
768#undef isalpha
769#undef isalnum
770#undef isprint
771#undef islower
772#undef isupper
773#undef tolower
774#undef toupper
775#undef iscntrl
776#undef ispunct
777#undef isxdigit
778
779extern const unsigned char sane_ctype[256];
780#define GIT_SPACE 0x01
781#define GIT_DIGIT 0x02
782#define GIT_ALPHA 0x04
783#define GIT_GLOB_SPECIAL 0x08
784#define GIT_REGEX_SPECIAL 0x10
785#define GIT_PATHSPEC_MAGIC 0x20
786#define GIT_CNTRL 0x40
787#define GIT_PUNCT 0x80
788#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
789#define isascii(x) (((x) & ~0x7f) == 0)
790#define isspace(x) sane_istest(x,GIT_SPACE)
791#define isdigit(x) sane_istest(x,GIT_DIGIT)
792#define isalpha(x) sane_istest(x,GIT_ALPHA)
793#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
794#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
795#define islower(x) sane_iscase(x, 1)
796#define isupper(x) sane_iscase(x, 0)
797#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
798#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
799#define iscntrl(x) (sane_istest(x,GIT_CNTRL))
800#define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
801 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
802#define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
803#define tolower(x) sane_case((unsigned char)(x), 0x20)
804#define toupper(x) sane_case((unsigned char)(x), 0)
805#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
806
807static inline int sane_case(int x, int high)
808{
809 if (sane_istest(x, GIT_ALPHA))
810 x = (x & ~0x20) | high;
811 return x;
812}
813
814static inline int sane_iscase(int x, int is_lower)
815{
816 if (!sane_istest(x, GIT_ALPHA))
817 return 0;
818
819 if (is_lower)
820 return (x & 0x20) != 0;
821 else
822 return (x & 0x20) == 0;
823}
824
825static inline int strtoul_ui(char const *s, int base, unsigned int *result)
826{
827 unsigned long ul;
828 char *p;
829
830 errno = 0;
831 /* negative values would be accepted by strtoul */
832 if (strchr(s, '-'))
833 return -1;
834 ul = strtoul(s, &p, base);
835 if (errno || *p || p == s || (unsigned int) ul != ul)
836 return -1;
837 *result = ul;
838 return 0;
839}
840
841static inline int strtol_i(char const *s, int base, int *result)
842{
843 long ul;
844 char *p;
845
846 errno = 0;
847 ul = strtol(s, &p, base);
848 if (errno || *p || p == s || (int) ul != ul)
849 return -1;
850 *result = ul;
851 return 0;
852}
853
854#ifdef INTERNAL_QSORT
855void git_qsort(void *base, size_t nmemb, size_t size,
856 int(*compar)(const void *, const void *));
857#define qsort git_qsort
858#endif
859
860#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
861# define FORCE_DIR_SET_GID S_ISGID
862#else
863# define FORCE_DIR_SET_GID 0
864#endif
865
866#ifdef NO_NSEC
867#undef USE_NSEC
868#define ST_CTIME_NSEC(st) 0
869#define ST_MTIME_NSEC(st) 0
870#else
871#ifdef USE_ST_TIMESPEC
872#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
873#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
874#else
875#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
876#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
877#endif
878#endif
879
880#ifdef UNRELIABLE_FSTAT
881#define fstat_is_reliable() 0
882#else
883#define fstat_is_reliable() 1
884#endif
885
886#ifndef va_copy
887/*
888 * Since an obvious implementation of va_list would be to make it a
889 * pointer into the stack frame, a simple assignment will work on
890 * many systems. But let's try to be more portable.
891 */
892#ifdef __va_copy
893#define va_copy(dst, src) __va_copy(dst, src)
894#else
895#define va_copy(dst, src) ((dst) = (src))
896#endif
897#endif
898
899#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
900#define HAVE_VARIADIC_MACROS 1
901#endif
902
903/*
904 * Preserves errno, prints a message, but gives no warning for ENOENT.
905 * Returns 0 on success, which includes trying to unlink an object that does
906 * not exist.
907 */
908int unlink_or_warn(const char *path);
909 /*
910 * Tries to unlink file. Returns 0 if unlink succeeded
911 * or the file already didn't exist. Returns -1 and
912 * appends a message to err suitable for
913 * 'error("%s", err->buf)' on error.
914 */
915int unlink_or_msg(const char *file, struct strbuf *err);
916/*
917 * Preserves errno, prints a message, but gives no warning for ENOENT.
918 * Returns 0 on success, which includes trying to remove a directory that does
919 * not exist.
920 */
921int rmdir_or_warn(const char *path);
922/*
923 * Calls the correct function out of {unlink,rmdir}_or_warn based on
924 * the supplied file mode.
925 */
926int remove_or_warn(unsigned int mode, const char *path);
927
928/*
929 * Call access(2), but warn for any error except "missing file"
930 * (ENOENT or ENOTDIR).
931 */
932#define ACCESS_EACCES_OK (1U << 0)
933int access_or_warn(const char *path, int mode, unsigned flag);
934int access_or_die(const char *path, int mode, unsigned flag);
935
936/* Warn on an inaccessible file that ought to be accessible */
937void warn_on_inaccessible(const char *path);
938
939#ifdef GMTIME_UNRELIABLE_ERRORS
940struct tm *git_gmtime(const time_t *);
941struct tm *git_gmtime_r(const time_t *, struct tm *);
942#define gmtime git_gmtime
943#define gmtime_r git_gmtime_r
944#endif
945
946#if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
947#define USE_PARENS_AROUND_GETTEXT_N 1
948#endif
949
950#ifndef SHELL_PATH
951# define SHELL_PATH "/bin/sh"
952#endif
953
954#ifndef _POSIX_THREAD_SAFE_FUNCTIONS
955#define flockfile(fh)
956#define funlockfile(fh)
957#define getc_unlocked(fh) getc(fh)
958#endif
959
960#endif