git-multimail: update to release 1.2.0
[git.git] / git-compat-util.h
blob1df82fa598daa131c9e84023083a014ac3ee3f9f
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
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
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
23 #ifndef FLEX_ARRAY
25 * See if our compiler is known to support flexible array members.
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
38 * Otherwise, default to safer but a bit wasteful traditional style
40 #ifndef FLEX_ARRAY
41 # define FLEX_ARRAY 1
42 #endif
43 #endif
47 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
48 * @cond: the compile-time condition which must be true.
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".
53 * Example:
54 * #define foo_to_char(foo) \
55 * ((char *)(foo) \
56 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
58 #define BUILD_ASSERT_OR_ZERO(cond) \
59 (sizeof(char [1 - 2*!(cond)]) - 1)
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
70 * ARRAY_SIZE - get the number of elements in a visible array
71 * <at> x: the array whose size you want.
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).
77 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
79 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
81 #define maximum_signed_value_of_type(a) \
82 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
84 #define maximum_unsigned_value_of_type(a) \
85 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
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.
91 * Requires: a >= 0, typeof(a) equals typeof(b)
93 #define signed_add_overflows(a, b) \
94 ((b) > maximum_signed_value_of_type(a) - (a))
96 #define unsigned_add_overflows(a, b) \
97 ((b) > maximum_unsigned_value_of_type(a) - (a))
99 #ifdef __GNUC__
100 #define TYPEOF(x) (__typeof__(x))
101 #else
102 #define TYPEOF(x)
103 #endif
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 */
108 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
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)
113 #if defined(__sun__)
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.
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
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
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
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
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.
218 typedef long intptr_t;
219 typedef 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
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(a,b)
233 #endif
235 #ifdef MKDIR_WO_TRAILING_SLASH
236 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
237 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
238 #endif
240 #ifdef NO_STRUCT_ITIMERVAL
241 struct itimerval {
242 struct timeval it_interval;
243 struct timeval it_value;
245 #endif
247 #ifdef NO_SETITIMER
248 #define setitimer(which,value,ovalue)
249 #endif
251 #ifndef NO_LIBGEN_H
252 #include <libgen.h>
253 #else
254 #define basename gitbasename
255 extern char *gitbasename(char *);
256 #endif
258 #ifndef NO_ICONV
259 #include <iconv.h>
260 #endif
262 #ifndef NO_OPENSSL
263 #ifdef __APPLE__
264 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
265 #include <AvailabilityMacros.h>
266 #undef DEPRECATED_ATTRIBUTE
267 #define DEPRECATED_ATTRIBUTE
268 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
269 #endif
270 #include <openssl/ssl.h>
271 #include <openssl/err.h>
272 #ifdef NO_HMAC_CTX_CLEANUP
273 #define HMAC_CTX_cleanup HMAC_cleanup
274 #endif
275 #endif
277 /* On most systems <netdb.h> would have given us this, but
278 * not on some systems (e.g. z/OS).
280 #ifndef NI_MAXHOST
281 #define NI_MAXHOST 1025
282 #endif
284 #ifndef NI_MAXSERV
285 #define NI_MAXSERV 32
286 #endif
288 /* On most systems <limits.h> would have given us this, but
289 * not on some systems (e.g. GNU/Hurd).
291 #ifndef PATH_MAX
292 #define PATH_MAX 4096
293 #endif
295 #ifndef PRIuMAX
296 #define PRIuMAX "llu"
297 #endif
299 #ifndef PRIu32
300 #define PRIu32 "u"
301 #endif
303 #ifndef PRIx32
304 #define PRIx32 "x"
305 #endif
307 #ifndef PRIo32
308 #define PRIo32 "o"
309 #endif
311 #ifndef PATH_SEP
312 #define PATH_SEP ':'
313 #endif
315 #ifdef HAVE_PATHS_H
316 #include <paths.h>
317 #endif
318 #ifndef _PATH_DEFPATH
319 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
320 #endif
322 #ifndef STRIP_EXTENSION
323 #define STRIP_EXTENSION ""
324 #endif
326 #ifndef has_dos_drive_prefix
327 static inline int git_has_dos_drive_prefix(const char *path)
329 return 0;
331 #define has_dos_drive_prefix git_has_dos_drive_prefix
332 #endif
334 #ifndef is_dir_sep
335 static inline int git_is_dir_sep(int c)
337 return c == '/';
339 #define is_dir_sep git_is_dir_sep
340 #endif
342 #ifndef offset_1st_component
343 static inline int git_offset_1st_component(const char *path)
345 return is_dir_sep(path[0]);
347 #define offset_1st_component git_offset_1st_component
348 #endif
350 #ifndef find_last_dir_sep
351 static inline char *git_find_last_dir_sep(const char *path)
353 return strrchr(path, '/');
355 #define find_last_dir_sep git_find_last_dir_sep
356 #endif
358 #if defined(__HP_cc) && (__HP_cc >= 61000)
359 #define NORETURN __attribute__((noreturn))
360 #define NORETURN_PTR
361 #elif defined(__GNUC__) && !defined(NO_NORETURN)
362 #define NORETURN __attribute__((__noreturn__))
363 #define NORETURN_PTR __attribute__((__noreturn__))
364 #elif defined(_MSC_VER)
365 #define NORETURN __declspec(noreturn)
366 #define NORETURN_PTR
367 #else
368 #define NORETURN
369 #define NORETURN_PTR
370 #ifndef __GNUC__
371 #ifndef __attribute__
372 #define __attribute__(x)
373 #endif
374 #endif
375 #endif
377 /* The sentinel attribute is valid from gcc version 4.0 */
378 #if defined(__GNUC__) && (__GNUC__ >= 4)
379 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
380 #else
381 #define LAST_ARG_MUST_BE_NULL
382 #endif
384 #include "compat/bswap.h"
386 #include "wildmatch.h"
388 struct strbuf;
390 /* General helper functions */
391 extern void vreportf(const char *prefix, const char *err, va_list params);
392 extern NORETURN void usage(const char *err);
393 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
394 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
395 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
396 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
397 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
399 #ifndef NO_OPENSSL
400 #ifdef APPLE_COMMON_CRYPTO
401 #include "compat/apple-common-crypto.h"
402 #else
403 #include <openssl/evp.h>
404 #include <openssl/hmac.h>
405 #endif /* APPLE_COMMON_CRYPTO */
406 #include <openssl/x509v3.h>
407 #endif /* NO_OPENSSL */
410 * Let callers be aware of the constant return value; this can help
411 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
412 * because some compilers may not support variadic macros. Since we're only
413 * trying to help gcc, anyway, it's OK; other compilers will fall back to
414 * using the function as usual.
416 #if defined(__GNUC__)
417 static inline int const_error(void)
419 return -1;
421 #define error(...) (error(__VA_ARGS__), const_error())
422 #endif
424 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
425 extern void set_error_routine(void (*routine)(const char *err, va_list params));
426 extern void set_die_is_recursing_routine(int (*routine)(void));
427 extern void set_error_handle(FILE *);
429 extern int starts_with(const char *str, const char *prefix);
432 * If the string "str" begins with the string found in "prefix", return 1.
433 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
434 * the string right after the prefix).
436 * Otherwise, return 0 and leave "out" untouched.
438 * Examples:
440 * [extract branch name, fail if not a branch]
441 * if (!skip_prefix(ref, "refs/heads/", &branch)
442 * return -1;
444 * [skip prefix if present, otherwise use whole string]
445 * skip_prefix(name, "refs/heads/", &name);
447 static inline int skip_prefix(const char *str, const char *prefix,
448 const char **out)
450 do {
451 if (!*prefix) {
452 *out = str;
453 return 1;
455 } while (*str++ == *prefix++);
456 return 0;
460 * If buf ends with suffix, return 1 and subtract the length of the suffix
461 * from *len. Otherwise, return 0 and leave *len untouched.
463 static inline int strip_suffix_mem(const char *buf, size_t *len,
464 const char *suffix)
466 size_t suflen = strlen(suffix);
467 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
468 return 0;
469 *len -= suflen;
470 return 1;
474 * If str ends with suffix, return 1 and set *len to the size of the string
475 * without the suffix. Otherwise, return 0 and set *len to the size of the
476 * string.
478 * Note that we do _not_ NUL-terminate str to the new length.
480 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
482 *len = strlen(str);
483 return strip_suffix_mem(str, len, suffix);
486 static inline int ends_with(const char *str, const char *suffix)
488 size_t len;
489 return strip_suffix(str, suffix, &len);
492 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
494 #ifndef PROT_READ
495 #define PROT_READ 1
496 #define PROT_WRITE 2
497 #define MAP_PRIVATE 1
498 #endif
500 #define mmap git_mmap
501 #define munmap git_munmap
502 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
503 extern int git_munmap(void *start, size_t length);
505 #else /* NO_MMAP || USE_WIN32_MMAP */
507 #include <sys/mman.h>
509 #endif /* NO_MMAP || USE_WIN32_MMAP */
511 #ifdef NO_MMAP
513 /* This value must be multiple of (pagesize * 2) */
514 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
516 #else /* NO_MMAP */
518 /* This value must be multiple of (pagesize * 2) */
519 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
520 (sizeof(void*) >= 8 \
521 ? 1 * 1024 * 1024 * 1024 \
522 : 32 * 1024 * 1024)
524 #endif /* NO_MMAP */
526 #ifndef MAP_FAILED
527 #define MAP_FAILED ((void *)-1)
528 #endif
530 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
531 #define on_disk_bytes(st) ((st).st_size)
532 #else
533 #define on_disk_bytes(st) ((st).st_blocks * 512)
534 #endif
536 #ifdef NEEDS_MODE_TRANSLATION
537 #undef S_IFMT
538 #undef S_IFREG
539 #undef S_IFDIR
540 #undef S_IFLNK
541 #undef S_IFBLK
542 #undef S_IFCHR
543 #undef S_IFIFO
544 #undef S_IFSOCK
545 #define S_IFMT 0170000
546 #define S_IFREG 0100000
547 #define S_IFDIR 0040000
548 #define S_IFLNK 0120000
549 #define S_IFBLK 0060000
550 #define S_IFCHR 0020000
551 #define S_IFIFO 0010000
552 #define S_IFSOCK 0140000
553 #ifdef stat
554 #undef stat
555 #endif
556 #define stat(path, buf) git_stat(path, buf)
557 extern int git_stat(const char *, struct stat *);
558 #ifdef fstat
559 #undef fstat
560 #endif
561 #define fstat(fd, buf) git_fstat(fd, buf)
562 extern int git_fstat(int, struct stat *);
563 #ifdef lstat
564 #undef lstat
565 #endif
566 #define lstat(path, buf) git_lstat(path, buf)
567 extern int git_lstat(const char *, struct stat *);
568 #endif
570 #define DEFAULT_PACKED_GIT_LIMIT \
571 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
573 #ifdef NO_PREAD
574 #define pread git_pread
575 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
576 #endif
578 * Forward decl that will remind us if its twin in cache.h changes.
579 * This function is used in compat/pread.c. But we can't include
580 * cache.h there.
582 extern ssize_t read_in_full(int fd, void *buf, size_t count);
584 #ifdef NO_SETENV
585 #define setenv gitsetenv
586 extern int gitsetenv(const char *, const char *, int);
587 #endif
589 #ifdef NO_MKDTEMP
590 #define mkdtemp gitmkdtemp
591 extern char *gitmkdtemp(char *);
592 #endif
594 #ifdef NO_MKSTEMPS
595 #define mkstemps gitmkstemps
596 extern int gitmkstemps(char *, int);
597 #endif
599 #ifdef NO_UNSETENV
600 #define unsetenv gitunsetenv
601 extern void gitunsetenv(const char *);
602 #endif
604 #ifdef NO_STRCASESTR
605 #define strcasestr gitstrcasestr
606 extern char *gitstrcasestr(const char *haystack, const char *needle);
607 #endif
609 #ifdef NO_STRLCPY
610 #define strlcpy gitstrlcpy
611 extern size_t gitstrlcpy(char *, const char *, size_t);
612 #endif
614 #ifdef NO_STRTOUMAX
615 #define strtoumax gitstrtoumax
616 extern uintmax_t gitstrtoumax(const char *, char **, int);
617 #define strtoimax gitstrtoimax
618 extern intmax_t gitstrtoimax(const char *, char **, int);
619 #endif
621 #ifdef NO_HSTRERROR
622 #define hstrerror githstrerror
623 extern const char *githstrerror(int herror);
624 #endif
626 #ifdef NO_MEMMEM
627 #define memmem gitmemmem
628 void *gitmemmem(const void *haystack, size_t haystacklen,
629 const void *needle, size_t needlelen);
630 #endif
632 #ifdef NO_GETPAGESIZE
633 #define getpagesize() sysconf(_SC_PAGESIZE)
634 #endif
636 #ifdef FREAD_READS_DIRECTORIES
637 #ifdef fopen
638 #undef fopen
639 #endif
640 #define fopen(a,b) git_fopen(a,b)
641 extern FILE *git_fopen(const char*, const char*);
642 #endif
644 #ifdef SNPRINTF_RETURNS_BOGUS
645 #ifdef snprintf
646 #undef snprintf
647 #endif
648 #define snprintf git_snprintf
649 extern int git_snprintf(char *str, size_t maxsize,
650 const char *format, ...);
651 #ifdef vsnprintf
652 #undef vsnprintf
653 #endif
654 #define vsnprintf git_vsnprintf
655 extern int git_vsnprintf(char *str, size_t maxsize,
656 const char *format, va_list ap);
657 #endif
659 #ifdef __GLIBC_PREREQ
660 #if __GLIBC_PREREQ(2, 1)
661 #define HAVE_STRCHRNUL
662 #define HAVE_MEMPCPY
663 #endif
664 #endif
666 #ifndef HAVE_STRCHRNUL
667 #define strchrnul gitstrchrnul
668 static inline char *gitstrchrnul(const char *s, int c)
670 while (*s && *s != c)
671 s++;
672 return (char *)s;
674 #endif
676 #ifndef HAVE_MEMPCPY
677 #define mempcpy gitmempcpy
678 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
680 return (char *)memcpy(dest, src, n) + n;
682 #endif
684 #ifdef NO_INET_PTON
685 int inet_pton(int af, const char *src, void *dst);
686 #endif
688 #ifdef NO_INET_NTOP
689 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
690 #endif
692 #ifdef NO_PTHREADS
693 #define atexit git_atexit
694 extern int git_atexit(void (*handler)(void));
695 #endif
697 extern void release_pack_memory(size_t);
699 typedef void (*try_to_free_t)(size_t);
700 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
702 #ifdef HAVE_ALLOCA_H
703 # include <alloca.h>
704 # define xalloca(size) (alloca(size))
705 # define xalloca_free(p) do {} while (0)
706 #else
707 # define xalloca(size) (xmalloc(size))
708 # define xalloca_free(p) (free(p))
709 #endif
710 extern char *xstrdup(const char *str);
711 extern void *xmalloc(size_t size);
712 extern void *xmallocz(size_t size);
713 extern void *xmallocz_gently(size_t size);
714 extern void *xmemdupz(const void *data, size_t len);
715 extern char *xstrndup(const char *str, size_t len);
716 extern void *xrealloc(void *ptr, size_t size);
717 extern void *xcalloc(size_t nmemb, size_t size);
718 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
719 extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
720 extern int xopen(const char *path, int flags, ...);
721 extern ssize_t xread(int fd, void *buf, size_t len);
722 extern ssize_t xwrite(int fd, const void *buf, size_t len);
723 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
724 extern int xdup(int fd);
725 extern FILE *xfopen(const char *path, const char *mode);
726 extern FILE *xfdopen(int fd, const char *mode);
727 extern int xmkstemp(char *template);
728 extern int xmkstemp_mode(char *template, int mode);
729 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
730 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
731 extern char *xgetcwd(void);
733 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
735 static inline char *xstrdup_or_null(const char *str)
737 return str ? xstrdup(str) : NULL;
740 static inline size_t xsize_t(off_t len)
742 if (len > (size_t) len)
743 die("Cannot handle files this big");
744 return (size_t)len;
747 /* in ctype.c, for kwset users */
748 extern const unsigned char tolower_trans_tbl[256];
750 /* Sane ctype - no locale, and works with signed chars */
751 #undef isascii
752 #undef isspace
753 #undef isdigit
754 #undef isalpha
755 #undef isalnum
756 #undef isprint
757 #undef islower
758 #undef isupper
759 #undef tolower
760 #undef toupper
761 #undef iscntrl
762 #undef ispunct
763 #undef isxdigit
765 extern const unsigned char sane_ctype[256];
766 #define GIT_SPACE 0x01
767 #define GIT_DIGIT 0x02
768 #define GIT_ALPHA 0x04
769 #define GIT_GLOB_SPECIAL 0x08
770 #define GIT_REGEX_SPECIAL 0x10
771 #define GIT_PATHSPEC_MAGIC 0x20
772 #define GIT_CNTRL 0x40
773 #define GIT_PUNCT 0x80
774 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
775 #define isascii(x) (((x) & ~0x7f) == 0)
776 #define isspace(x) sane_istest(x,GIT_SPACE)
777 #define isdigit(x) sane_istest(x,GIT_DIGIT)
778 #define isalpha(x) sane_istest(x,GIT_ALPHA)
779 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
780 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
781 #define islower(x) sane_iscase(x, 1)
782 #define isupper(x) sane_iscase(x, 0)
783 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
784 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
785 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
786 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
787 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
788 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
789 #define tolower(x) sane_case((unsigned char)(x), 0x20)
790 #define toupper(x) sane_case((unsigned char)(x), 0)
791 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
793 static inline int sane_case(int x, int high)
795 if (sane_istest(x, GIT_ALPHA))
796 x = (x & ~0x20) | high;
797 return x;
800 static inline int sane_iscase(int x, int is_lower)
802 if (!sane_istest(x, GIT_ALPHA))
803 return 0;
805 if (is_lower)
806 return (x & 0x20) != 0;
807 else
808 return (x & 0x20) == 0;
811 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
813 unsigned long ul;
814 char *p;
816 errno = 0;
817 /* negative values would be accepted by strtoul */
818 if (strchr(s, '-'))
819 return -1;
820 ul = strtoul(s, &p, base);
821 if (errno || *p || p == s || (unsigned int) ul != ul)
822 return -1;
823 *result = ul;
824 return 0;
827 static inline int strtol_i(char const *s, int base, int *result)
829 long ul;
830 char *p;
832 errno = 0;
833 ul = strtol(s, &p, base);
834 if (errno || *p || p == s || (int) ul != ul)
835 return -1;
836 *result = ul;
837 return 0;
840 #ifdef INTERNAL_QSORT
841 void git_qsort(void *base, size_t nmemb, size_t size,
842 int(*compar)(const void *, const void *));
843 #define qsort git_qsort
844 #endif
846 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
847 # define FORCE_DIR_SET_GID S_ISGID
848 #else
849 # define FORCE_DIR_SET_GID 0
850 #endif
852 #ifdef NO_NSEC
853 #undef USE_NSEC
854 #define ST_CTIME_NSEC(st) 0
855 #define ST_MTIME_NSEC(st) 0
856 #else
857 #ifdef USE_ST_TIMESPEC
858 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
859 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
860 #else
861 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
862 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
863 #endif
864 #endif
866 #ifdef UNRELIABLE_FSTAT
867 #define fstat_is_reliable() 0
868 #else
869 #define fstat_is_reliable() 1
870 #endif
872 #ifndef va_copy
874 * Since an obvious implementation of va_list would be to make it a
875 * pointer into the stack frame, a simple assignment will work on
876 * many systems. But let's try to be more portable.
878 #ifdef __va_copy
879 #define va_copy(dst, src) __va_copy(dst, src)
880 #else
881 #define va_copy(dst, src) ((dst) = (src))
882 #endif
883 #endif
885 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
886 #define HAVE_VARIADIC_MACROS 1
887 #endif
890 * Preserves errno, prints a message, but gives no warning for ENOENT.
891 * Returns 0 on success, which includes trying to unlink an object that does
892 * not exist.
894 int unlink_or_warn(const char *path);
896 * Tries to unlink file. Returns 0 if unlink succeeded
897 * or the file already didn't exist. Returns -1 and
898 * appends a message to err suitable for
899 * 'error("%s", err->buf)' on error.
901 int unlink_or_msg(const char *file, struct strbuf *err);
903 * Preserves errno, prints a message, but gives no warning for ENOENT.
904 * Returns 0 on success, which includes trying to remove a directory that does
905 * not exist.
907 int rmdir_or_warn(const char *path);
909 * Calls the correct function out of {unlink,rmdir}_or_warn based on
910 * the supplied file mode.
912 int remove_or_warn(unsigned int mode, const char *path);
915 * Call access(2), but warn for any error except "missing file"
916 * (ENOENT or ENOTDIR).
918 #define ACCESS_EACCES_OK (1U << 0)
919 int access_or_warn(const char *path, int mode, unsigned flag);
920 int access_or_die(const char *path, int mode, unsigned flag);
922 /* Warn on an inaccessible file that ought to be accessible */
923 void warn_on_inaccessible(const char *path);
925 /* Get the passwd entry for the UID of the current process. */
926 struct passwd *xgetpwuid_self(void);
928 #ifdef GMTIME_UNRELIABLE_ERRORS
929 struct tm *git_gmtime(const time_t *);
930 struct tm *git_gmtime_r(const time_t *, struct tm *);
931 #define gmtime git_gmtime
932 #define gmtime_r git_gmtime_r
933 #endif
935 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
936 #define USE_PARENS_AROUND_GETTEXT_N 1
937 #endif
939 #ifndef SHELL_PATH
940 # define SHELL_PATH "/bin/sh"
941 #endif
943 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
944 #define flockfile(fh)
945 #define funlockfile(fh)
946 #define getc_unlocked(fh) getc(fh)
947 #endif
949 #endif