Merge branch 'rs/janitorial' into maint
[git.git] / git-compat-util.h
blobb45c75fc7a6cfd8884e748ee128f72da4aa43e6e
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 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
72 * ARRAY_SIZE - get the number of elements in a visible array
73 * <at> x: the array whose size you want.
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).
79 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
81 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
83 #define maximum_signed_value_of_type(a) \
84 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
86 #define maximum_unsigned_value_of_type(a) \
87 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
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.
93 * Requires: a >= 0, typeof(a) equals typeof(b)
95 #define signed_add_overflows(a, b) \
96 ((b) > maximum_signed_value_of_type(a) - (a))
98 #define unsigned_add_overflows(a, b) \
99 ((b) > maximum_unsigned_value_of_type(a) - (a))
101 #ifdef __GNUC__
102 #define TYPEOF(x) (__typeof__(x))
103 #else
104 #define TYPEOF(x)
105 #endif
107 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
108 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
110 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
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)
115 #if defined(__sun__)
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.
123 # if __STDC_VERSION__ - 0 >= 199901L
124 # define _XOPEN_SOURCE 600
125 # else
126 # define _XOPEN_SOURCE 500
127 # endif
128 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
129 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
130 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
131 !defined(__CYGWIN__)
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 */
134 #endif
135 #define _ALL_SOURCE 1
136 #define _GNU_SOURCE 1
137 #define _BSD_SOURCE 1
138 #define _DEFAULT_SOURCE 1
139 #define _NETBSD_SOURCE 1
140 #define _SGI_SOURCE 1
142 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
143 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
144 # define _WIN32_WINNT 0x0502
145 # endif
146 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
147 #include <winsock2.h>
148 #include <windows.h>
149 #define GIT_WINDOWS_NATIVE
150 #endif
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>
160 #ifdef HAVE_STRINGS_H
161 #include <strings.h> /* for strcasecmp() */
162 #endif
163 #include <errno.h>
164 #include <limits.h>
165 #ifdef NEEDS_SYS_PARAM_H
166 #include <sys/param.h>
167 #endif
168 #include <sys/types.h>
169 #include <dirent.h>
170 #include <sys/time.h>
171 #include <time.h>
172 #include <signal.h>
173 #include <assert.h>
174 #include <regex.h>
175 #include <utime.h>
176 #include <syslog.h>
177 #ifndef NO_SYS_POLL_H
178 #include <sys/poll.h>
179 #else
180 #include <poll.h>
181 #endif
182 #ifdef HAVE_BSD_SYSCTL
183 #include <sys/sysctl.h>
184 #endif
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
192 #include <sys/wait.h>
193 #include <sys/resource.h>
194 #include <sys/socket.h>
195 #include <sys/ioctl.h>
196 #include <termios.h>
197 #ifndef NO_SYS_SELECT_H
198 #include <sys/select.h>
199 #endif
200 #include <netinet/in.h>
201 #include <netinet/tcp.h>
202 #include <arpa/inet.h>
203 #include <netdb.h>
204 #include <pwd.h>
205 #include <sys/un.h>
206 #ifndef NO_INTTYPES_H
207 #include <inttypes.h>
208 #else
209 #include <stdint.h>
210 #endif
211 #ifdef NO_INTPTR_T
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.
219 typedef long intptr_t;
220 typedef unsigned long uintptr_t;
221 #endif
222 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
223 #include <grp.h>
224 #define _ALL_SOURCE 1
225 #endif
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
236 #ifdef MKDIR_WO_TRAILING_SLASH
237 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
238 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
239 #endif
241 #ifdef NO_STRUCT_ITIMERVAL
242 struct itimerval {
243 struct timeval it_interval;
244 struct timeval it_value;
246 #endif
248 #ifdef NO_SETITIMER
249 #define setitimer(which,value,ovalue)
250 #endif
252 #ifndef NO_LIBGEN_H
253 #include <libgen.h>
254 #else
255 #define basename gitbasename
256 extern char *gitbasename(char *);
257 #endif
259 #ifndef NO_ICONV
260 #include <iconv.h>
261 #endif
263 #ifndef NO_OPENSSL
264 #ifdef __APPLE__
265 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
266 #include <AvailabilityMacros.h>
267 #undef DEPRECATED_ATTRIBUTE
268 #define DEPRECATED_ATTRIBUTE
269 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
270 #endif
271 #include <openssl/ssl.h>
272 #include <openssl/err.h>
273 #ifdef NO_HMAC_CTX_CLEANUP
274 #define HMAC_CTX_cleanup HMAC_cleanup
275 #endif
276 #endif
278 /* On most systems <netdb.h> would have given us this, but
279 * not on some systems (e.g. z/OS).
281 #ifndef NI_MAXHOST
282 #define NI_MAXHOST 1025
283 #endif
285 #ifndef NI_MAXSERV
286 #define NI_MAXSERV 32
287 #endif
289 /* On most systems <limits.h> would have given us this, but
290 * not on some systems (e.g. GNU/Hurd).
292 #ifndef PATH_MAX
293 #define PATH_MAX 4096
294 #endif
296 #ifndef PRIuMAX
297 #define PRIuMAX "llu"
298 #endif
300 #ifndef PRIu32
301 #define PRIu32 "u"
302 #endif
304 #ifndef PRIx32
305 #define PRIx32 "x"
306 #endif
308 #ifndef PRIo32
309 #define PRIo32 "o"
310 #endif
312 #ifndef PATH_SEP
313 #define PATH_SEP ':'
314 #endif
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
323 #ifndef STRIP_EXTENSION
324 #define STRIP_EXTENSION ""
325 #endif
327 #ifndef has_dos_drive_prefix
328 static inline int git_has_dos_drive_prefix(const char *path)
330 return 0;
332 #define has_dos_drive_prefix git_has_dos_drive_prefix
333 #endif
335 #ifndef is_dir_sep
336 static inline int git_is_dir_sep(int c)
338 return c == '/';
340 #define is_dir_sep git_is_dir_sep
341 #endif
343 #ifndef offset_1st_component
344 static inline int git_offset_1st_component(const char *path)
346 return is_dir_sep(path[0]);
348 #define offset_1st_component git_offset_1st_component
349 #endif
351 #ifndef find_last_dir_sep
352 static inline char *git_find_last_dir_sep(const char *path)
354 return strrchr(path, '/');
356 #define find_last_dir_sep git_find_last_dir_sep
357 #endif
359 #if defined(__HP_cc) && (__HP_cc >= 61000)
360 #define NORETURN __attribute__((noreturn))
361 #define NORETURN_PTR
362 #elif defined(__GNUC__) && !defined(NO_NORETURN)
363 #define NORETURN __attribute__((__noreturn__))
364 #define NORETURN_PTR __attribute__((__noreturn__))
365 #elif defined(_MSC_VER)
366 #define NORETURN __declspec(noreturn)
367 #define NORETURN_PTR
368 #else
369 #define NORETURN
370 #define NORETURN_PTR
371 #ifndef __GNUC__
372 #ifndef __attribute__
373 #define __attribute__(x)
374 #endif
375 #endif
376 #endif
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
385 #include "compat/bswap.h"
387 #include "wildmatch.h"
389 struct strbuf;
391 /* General helper functions */
392 extern void vreportf(const char *prefix, const char *err, va_list params);
393 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
394 extern NORETURN void usage(const char *err);
395 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
396 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
397 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
398 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
399 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
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 */
412 * Let callers be aware of the constant return value; this can help
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.
418 #if defined(__GNUC__)
419 static inline int const_error(void)
421 return -1;
423 #define error(...) (error(__VA_ARGS__), const_error())
424 #endif
426 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
427 extern void set_error_routine(void (*routine)(const char *err, va_list params));
428 extern void set_die_is_recursing_routine(int (*routine)(void));
430 extern int starts_with(const char *str, const char *prefix);
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).
437 * Otherwise, return 0 and leave "out" untouched.
439 * Examples:
441 * [extract branch name, fail if not a branch]
442 * if (!skip_prefix(ref, "refs/heads/", &branch)
443 * return -1;
445 * [skip prefix if present, otherwise use whole string]
446 * skip_prefix(name, "refs/heads/", &name);
448 static inline int skip_prefix(const char *str, const char *prefix,
449 const char **out)
451 do {
452 if (!*prefix) {
453 *out = str;
454 return 1;
456 } while (*str++ == *prefix++);
457 return 0;
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.
464 static inline int strip_suffix_mem(const char *buf, size_t *len,
465 const char *suffix)
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;
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.
479 * Note that we do _not_ NUL-terminate str to the new length.
481 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
483 *len = strlen(str);
484 return strip_suffix_mem(str, len, suffix);
487 static inline int ends_with(const char *str, const char *suffix)
489 size_t len;
490 return strip_suffix(str, suffix, &len);
493 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
495 #ifndef PROT_READ
496 #define PROT_READ 1
497 #define PROT_WRITE 2
498 #define MAP_PRIVATE 1
499 #endif
501 #define mmap git_mmap
502 #define munmap git_munmap
503 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
504 extern int git_munmap(void *start, size_t length);
506 #else /* NO_MMAP || USE_WIN32_MMAP */
508 #include <sys/mman.h>
510 #endif /* NO_MMAP || USE_WIN32_MMAP */
512 #ifdef NO_MMAP
514 /* This value must be multiple of (pagesize * 2) */
515 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
517 #else /* NO_MMAP */
519 /* This value must be multiple of (pagesize * 2) */
520 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
521 (sizeof(void*) >= 8 \
522 ? 1 * 1024 * 1024 * 1024 \
523 : 32 * 1024 * 1024)
525 #endif /* NO_MMAP */
527 #ifndef MAP_FAILED
528 #define MAP_FAILED ((void *)-1)
529 #endif
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
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)
558 extern int git_stat(const char *, struct stat *);
559 #ifdef fstat
560 #undef fstat
561 #endif
562 #define fstat(fd, buf) git_fstat(fd, buf)
563 extern int git_fstat(int, struct stat *);
564 #ifdef lstat
565 #undef lstat
566 #endif
567 #define lstat(path, buf) git_lstat(path, buf)
568 extern int git_lstat(const char *, struct stat *);
569 #endif
571 #define DEFAULT_PACKED_GIT_LIMIT \
572 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
574 #ifdef NO_PREAD
575 #define pread git_pread
576 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
577 #endif
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.
583 extern ssize_t read_in_full(int fd, void *buf, size_t count);
585 #ifdef NO_SETENV
586 #define setenv gitsetenv
587 extern int gitsetenv(const char *, const char *, int);
588 #endif
590 #ifdef NO_MKDTEMP
591 #define mkdtemp gitmkdtemp
592 extern char *gitmkdtemp(char *);
593 #endif
595 #ifdef NO_MKSTEMPS
596 #define mkstemps gitmkstemps
597 extern int gitmkstemps(char *, int);
598 #endif
600 #ifdef NO_UNSETENV
601 #define unsetenv gitunsetenv
602 extern void gitunsetenv(const char *);
603 #endif
605 #ifdef NO_STRCASESTR
606 #define strcasestr gitstrcasestr
607 extern char *gitstrcasestr(const char *haystack, const char *needle);
608 #endif
610 #ifdef NO_STRLCPY
611 #define strlcpy gitstrlcpy
612 extern size_t gitstrlcpy(char *, const char *, size_t);
613 #endif
615 #ifdef NO_STRTOUMAX
616 #define strtoumax gitstrtoumax
617 extern uintmax_t gitstrtoumax(const char *, char **, int);
618 #define strtoimax gitstrtoimax
619 extern intmax_t gitstrtoimax(const char *, char **, int);
620 #endif
622 #ifdef NO_HSTRERROR
623 #define hstrerror githstrerror
624 extern const char *githstrerror(int herror);
625 #endif
627 #ifdef NO_MEMMEM
628 #define memmem gitmemmem
629 void *gitmemmem(const void *haystack, size_t haystacklen,
630 const void *needle, size_t needlelen);
631 #endif
633 #ifdef NO_GETPAGESIZE
634 #define getpagesize() sysconf(_SC_PAGESIZE)
635 #endif
637 #ifdef FREAD_READS_DIRECTORIES
638 #ifdef fopen
639 #undef fopen
640 #endif
641 #define fopen(a,b) git_fopen(a,b)
642 extern FILE *git_fopen(const char*, const char*);
643 #endif
645 #ifdef SNPRINTF_RETURNS_BOGUS
646 #ifdef snprintf
647 #undef snprintf
648 #endif
649 #define snprintf git_snprintf
650 extern int git_snprintf(char *str, size_t maxsize,
651 const char *format, ...);
652 #ifdef vsnprintf
653 #undef vsnprintf
654 #endif
655 #define vsnprintf git_vsnprintf
656 extern int git_vsnprintf(char *str, size_t maxsize,
657 const char *format, va_list ap);
658 #endif
660 #ifdef __GLIBC_PREREQ
661 #if __GLIBC_PREREQ(2, 1)
662 #define HAVE_STRCHRNUL
663 #define HAVE_MEMPCPY
664 #endif
665 #endif
667 #ifndef HAVE_STRCHRNUL
668 #define strchrnul gitstrchrnul
669 static inline char *gitstrchrnul(const char *s, int c)
671 while (*s && *s != c)
672 s++;
673 return (char *)s;
675 #endif
677 #ifndef HAVE_MEMPCPY
678 #define mempcpy gitmempcpy
679 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
681 return (char *)memcpy(dest, src, n) + n;
683 #endif
685 #ifdef NO_INET_PTON
686 int inet_pton(int af, const char *src, void *dst);
687 #endif
689 #ifdef NO_INET_NTOP
690 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
691 #endif
693 #ifdef NO_PTHREADS
694 #define atexit git_atexit
695 extern int git_atexit(void (*handler)(void));
696 #endif
698 extern void release_pack_memory(size_t);
700 typedef void (*try_to_free_t)(size_t);
701 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
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
711 extern char *xstrdup(const char *str);
712 extern void *xmalloc(size_t size);
713 extern void *xmallocz(size_t size);
714 extern void *xmallocz_gently(size_t size);
715 extern void *xmemdupz(const void *data, size_t len);
716 extern char *xstrndup(const char *str, size_t len);
717 extern void *xrealloc(void *ptr, size_t size);
718 extern void *xcalloc(size_t nmemb, size_t size);
719 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
720 extern ssize_t xread(int fd, void *buf, size_t len);
721 extern ssize_t xwrite(int fd, const void *buf, size_t len);
722 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
723 extern int xdup(int fd);
724 extern FILE *xfdopen(int fd, const char *mode);
725 extern int xmkstemp(char *template);
726 extern int xmkstemp_mode(char *template, int mode);
727 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
728 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
729 extern char *xgetcwd(void);
731 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
733 static inline char *xstrdup_or_null(const char *str)
735 return str ? xstrdup(str) : NULL;
738 static inline size_t xsize_t(off_t len)
740 if (len > (size_t) len)
741 die("Cannot handle files this big");
742 return (size_t)len;
745 /* in ctype.c, for kwset users */
746 extern const unsigned char tolower_trans_tbl[256];
748 /* Sane ctype - no locale, and works with signed chars */
749 #undef isascii
750 #undef isspace
751 #undef isdigit
752 #undef isalpha
753 #undef isalnum
754 #undef isprint
755 #undef islower
756 #undef isupper
757 #undef tolower
758 #undef toupper
759 #undef iscntrl
760 #undef ispunct
761 #undef isxdigit
763 extern const unsigned char sane_ctype[256];
764 #define GIT_SPACE 0x01
765 #define GIT_DIGIT 0x02
766 #define GIT_ALPHA 0x04
767 #define GIT_GLOB_SPECIAL 0x08
768 #define GIT_REGEX_SPECIAL 0x10
769 #define GIT_PATHSPEC_MAGIC 0x20
770 #define GIT_CNTRL 0x40
771 #define GIT_PUNCT 0x80
772 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
773 #define isascii(x) (((x) & ~0x7f) == 0)
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)
778 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
779 #define islower(x) sane_iscase(x, 1)
780 #define isupper(x) sane_iscase(x, 0)
781 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
782 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
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)
786 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
787 #define tolower(x) sane_case((unsigned char)(x), 0x20)
788 #define toupper(x) sane_case((unsigned char)(x), 0)
789 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
791 static inline int sane_case(int x, int high)
793 if (sane_istest(x, GIT_ALPHA))
794 x = (x & ~0x20) | high;
795 return x;
798 static inline int sane_iscase(int x, int is_lower)
800 if (!sane_istest(x, GIT_ALPHA))
801 return 0;
803 if (is_lower)
804 return (x & 0x20) != 0;
805 else
806 return (x & 0x20) == 0;
809 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
811 unsigned long ul;
812 char *p;
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;
822 static inline int strtol_i(char const *s, int base, int *result)
824 long ul;
825 char *p;
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;
835 #ifdef INTERNAL_QSORT
836 void git_qsort(void *base, size_t nmemb, size_t size,
837 int(*compar)(const void *, const void *));
838 #define qsort git_qsort
839 #endif
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
847 #ifdef NO_NSEC
848 #undef USE_NSEC
849 #define ST_CTIME_NSEC(st) 0
850 #define ST_MTIME_NSEC(st) 0
851 #else
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
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
859 #endif
861 #ifdef UNRELIABLE_FSTAT
862 #define fstat_is_reliable() 0
863 #else
864 #define fstat_is_reliable() 1
865 #endif
867 #ifndef va_copy
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.
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
878 #endif
880 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
881 #define HAVE_VARIADIC_MACROS 1
882 #endif
885 * Preserves errno, prints a message, but gives no warning for ENOENT.
886 * Returns 0 on success, which includes trying to unlink an object that does
887 * not exist.
889 int unlink_or_warn(const char *path);
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.
896 int unlink_or_msg(const char *file, struct strbuf *err);
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.
902 int rmdir_or_warn(const char *path);
904 * Calls the correct function out of {unlink,rmdir}_or_warn based on
905 * the supplied file mode.
907 int remove_or_warn(unsigned int mode, const char *path);
910 * Call access(2), but warn for any error except "missing file"
911 * (ENOENT or ENOTDIR).
913 #define ACCESS_EACCES_OK (1U << 0)
914 int access_or_warn(const char *path, int mode, unsigned flag);
915 int access_or_die(const char *path, int mode, unsigned flag);
917 /* Warn on an inaccessible file that ought to be accessible */
918 void warn_on_inaccessible(const char *path);
920 /* Get the passwd entry for the UID of the current process. */
921 struct passwd *xgetpwuid_self(void);
923 #ifdef GMTIME_UNRELIABLE_ERRORS
924 struct tm *git_gmtime(const time_t *);
925 struct tm *git_gmtime_r(const time_t *, struct tm *);
926 #define gmtime git_gmtime
927 #define gmtime_r git_gmtime_r
928 #endif
930 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
931 #define USE_PARENS_AROUND_GETTEXT_N 1
932 #endif
934 #ifndef SHELL_PATH
935 # define SHELL_PATH "/bin/sh"
936 #endif
938 #endif