diff: activate diff.renames by default
[git.git] / git-compat-util.h
blob693a336ff52ffc5acfaaa114829008de21b0a651
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()
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 #define dirname gitdirname
257 extern char *gitdirname(char *);
258 #endif
260 #ifndef NO_ICONV
261 #include <iconv.h>
262 #endif
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
279 /* On most systems <netdb.h> would have given us this, but
280 * not on some systems (e.g. z/OS).
282 #ifndef NI_MAXHOST
283 #define NI_MAXHOST 1025
284 #endif
286 #ifndef NI_MAXSERV
287 #define NI_MAXSERV 32
288 #endif
290 /* On most systems <limits.h> would have given us this, but
291 * not on some systems (e.g. GNU/Hurd).
293 #ifndef PATH_MAX
294 #define PATH_MAX 4096
295 #endif
297 #ifndef PRIuMAX
298 #define PRIuMAX "llu"
299 #endif
301 #ifndef SCNuMAX
302 #define SCNuMAX PRIuMAX
303 #endif
305 #ifndef PRIu32
306 #define PRIu32 "u"
307 #endif
309 #ifndef PRIx32
310 #define PRIx32 "x"
311 #endif
313 #ifndef PRIo32
314 #define PRIo32 "o"
315 #endif
317 #ifndef PATH_SEP
318 #define PATH_SEP ':'
319 #endif
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
328 #ifndef STRIP_EXTENSION
329 #define STRIP_EXTENSION ""
330 #endif
332 #ifndef has_dos_drive_prefix
333 static inline int git_has_dos_drive_prefix(const char *path)
335 return 0;
337 #define has_dos_drive_prefix git_has_dos_drive_prefix
338 #endif
340 #ifndef skip_dos_drive_prefix
341 static inline int git_skip_dos_drive_prefix(char **path)
343 return 0;
345 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
346 #endif
348 #ifndef is_dir_sep
349 static inline int git_is_dir_sep(int c)
351 return c == '/';
353 #define is_dir_sep git_is_dir_sep
354 #endif
356 #ifndef offset_1st_component
357 static inline int git_offset_1st_component(const char *path)
359 return is_dir_sep(path[0]);
361 #define offset_1st_component git_offset_1st_component
362 #endif
364 #ifndef find_last_dir_sep
365 static inline char *git_find_last_dir_sep(const char *path)
367 return strrchr(path, '/');
369 #define find_last_dir_sep git_find_last_dir_sep
370 #endif
372 #if defined(__HP_cc) && (__HP_cc >= 61000)
373 #define NORETURN __attribute__((noreturn))
374 #define NORETURN_PTR
375 #elif defined(__GNUC__) && !defined(NO_NORETURN)
376 #define NORETURN __attribute__((__noreturn__))
377 #define NORETURN_PTR __attribute__((__noreturn__))
378 #elif defined(_MSC_VER)
379 #define NORETURN __declspec(noreturn)
380 #define NORETURN_PTR
381 #else
382 #define NORETURN
383 #define NORETURN_PTR
384 #ifndef __GNUC__
385 #ifndef __attribute__
386 #define __attribute__(x)
387 #endif
388 #endif
389 #endif
391 /* The sentinel attribute is valid from gcc version 4.0 */
392 #if defined(__GNUC__) && (__GNUC__ >= 4)
393 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
394 #else
395 #define LAST_ARG_MUST_BE_NULL
396 #endif
398 #include "compat/bswap.h"
400 #include "wildmatch.h"
402 struct strbuf;
404 /* General helper functions */
405 extern void vreportf(const char *prefix, const char *err, va_list params);
406 extern NORETURN void usage(const char *err);
407 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
408 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
409 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
410 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
411 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
413 #ifndef NO_OPENSSL
414 #ifdef APPLE_COMMON_CRYPTO
415 #include "compat/apple-common-crypto.h"
416 #else
417 #include <openssl/evp.h>
418 #include <openssl/hmac.h>
419 #endif /* APPLE_COMMON_CRYPTO */
420 #include <openssl/x509v3.h>
421 #endif /* NO_OPENSSL */
424 * Let callers be aware of the constant return value; this can help
425 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
426 * because some compilers may not support variadic macros. Since we're only
427 * trying to help gcc, anyway, it's OK; other compilers will fall back to
428 * using the function as usual.
430 #if defined(__GNUC__)
431 static inline int const_error(void)
433 return -1;
435 #define error(...) (error(__VA_ARGS__), const_error())
436 #endif
438 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
439 extern void set_error_routine(void (*routine)(const char *err, va_list params));
440 extern void set_die_is_recursing_routine(int (*routine)(void));
441 extern void set_error_handle(FILE *);
443 extern int starts_with(const char *str, const char *prefix);
446 * If the string "str" begins with the string found in "prefix", return 1.
447 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
448 * the string right after the prefix).
450 * Otherwise, return 0 and leave "out" untouched.
452 * Examples:
454 * [extract branch name, fail if not a branch]
455 * if (!skip_prefix(ref, "refs/heads/", &branch)
456 * return -1;
458 * [skip prefix if present, otherwise use whole string]
459 * skip_prefix(name, "refs/heads/", &name);
461 static inline int skip_prefix(const char *str, const char *prefix,
462 const char **out)
464 do {
465 if (!*prefix) {
466 *out = str;
467 return 1;
469 } while (*str++ == *prefix++);
470 return 0;
474 * If buf ends with suffix, return 1 and subtract the length of the suffix
475 * from *len. Otherwise, return 0 and leave *len untouched.
477 static inline int strip_suffix_mem(const char *buf, size_t *len,
478 const char *suffix)
480 size_t suflen = strlen(suffix);
481 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
482 return 0;
483 *len -= suflen;
484 return 1;
488 * If str ends with suffix, return 1 and set *len to the size of the string
489 * without the suffix. Otherwise, return 0 and set *len to the size of the
490 * string.
492 * Note that we do _not_ NUL-terminate str to the new length.
494 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
496 *len = strlen(str);
497 return strip_suffix_mem(str, len, suffix);
500 static inline int ends_with(const char *str, const char *suffix)
502 size_t len;
503 return strip_suffix(str, suffix, &len);
506 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
508 #ifndef PROT_READ
509 #define PROT_READ 1
510 #define PROT_WRITE 2
511 #define MAP_PRIVATE 1
512 #endif
514 #define mmap git_mmap
515 #define munmap git_munmap
516 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
517 extern int git_munmap(void *start, size_t length);
519 #else /* NO_MMAP || USE_WIN32_MMAP */
521 #include <sys/mman.h>
523 #endif /* NO_MMAP || USE_WIN32_MMAP */
525 #ifdef NO_MMAP
527 /* This value must be multiple of (pagesize * 2) */
528 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
530 #else /* NO_MMAP */
532 /* This value must be multiple of (pagesize * 2) */
533 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
534 (sizeof(void*) >= 8 \
535 ? 1 * 1024 * 1024 * 1024 \
536 : 32 * 1024 * 1024)
538 #endif /* NO_MMAP */
540 #ifndef MAP_FAILED
541 #define MAP_FAILED ((void *)-1)
542 #endif
544 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
545 #define on_disk_bytes(st) ((st).st_size)
546 #else
547 #define on_disk_bytes(st) ((st).st_blocks * 512)
548 #endif
550 #ifdef NEEDS_MODE_TRANSLATION
551 #undef S_IFMT
552 #undef S_IFREG
553 #undef S_IFDIR
554 #undef S_IFLNK
555 #undef S_IFBLK
556 #undef S_IFCHR
557 #undef S_IFIFO
558 #undef S_IFSOCK
559 #define S_IFMT 0170000
560 #define S_IFREG 0100000
561 #define S_IFDIR 0040000
562 #define S_IFLNK 0120000
563 #define S_IFBLK 0060000
564 #define S_IFCHR 0020000
565 #define S_IFIFO 0010000
566 #define S_IFSOCK 0140000
567 #ifdef stat
568 #undef stat
569 #endif
570 #define stat(path, buf) git_stat(path, buf)
571 extern int git_stat(const char *, struct stat *);
572 #ifdef fstat
573 #undef fstat
574 #endif
575 #define fstat(fd, buf) git_fstat(fd, buf)
576 extern int git_fstat(int, struct stat *);
577 #ifdef lstat
578 #undef lstat
579 #endif
580 #define lstat(path, buf) git_lstat(path, buf)
581 extern int git_lstat(const char *, struct stat *);
582 #endif
584 #define DEFAULT_PACKED_GIT_LIMIT \
585 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? 8192 : 256))
587 #ifdef NO_PREAD
588 #define pread git_pread
589 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
590 #endif
592 * Forward decl that will remind us if its twin in cache.h changes.
593 * This function is used in compat/pread.c. But we can't include
594 * cache.h there.
596 extern ssize_t read_in_full(int fd, void *buf, size_t count);
598 #ifdef NO_SETENV
599 #define setenv gitsetenv
600 extern int gitsetenv(const char *, const char *, int);
601 #endif
603 #ifdef NO_MKDTEMP
604 #define mkdtemp gitmkdtemp
605 extern char *gitmkdtemp(char *);
606 #endif
608 #ifdef NO_MKSTEMPS
609 #define mkstemps gitmkstemps
610 extern int gitmkstemps(char *, int);
611 #endif
613 #ifdef NO_UNSETENV
614 #define unsetenv gitunsetenv
615 extern void gitunsetenv(const char *);
616 #endif
618 #ifdef NO_STRCASESTR
619 #define strcasestr gitstrcasestr
620 extern char *gitstrcasestr(const char *haystack, const char *needle);
621 #endif
623 #ifdef NO_STRLCPY
624 #define strlcpy gitstrlcpy
625 extern size_t gitstrlcpy(char *, const char *, size_t);
626 #endif
628 #ifdef NO_STRTOUMAX
629 #define strtoumax gitstrtoumax
630 extern uintmax_t gitstrtoumax(const char *, char **, int);
631 #define strtoimax gitstrtoimax
632 extern intmax_t gitstrtoimax(const char *, char **, int);
633 #endif
635 #ifdef NO_HSTRERROR
636 #define hstrerror githstrerror
637 extern const char *githstrerror(int herror);
638 #endif
640 #ifdef NO_MEMMEM
641 #define memmem gitmemmem
642 void *gitmemmem(const void *haystack, size_t haystacklen,
643 const void *needle, size_t needlelen);
644 #endif
646 #ifdef NO_GETPAGESIZE
647 #define getpagesize() sysconf(_SC_PAGESIZE)
648 #endif
650 #ifdef FREAD_READS_DIRECTORIES
651 #ifdef fopen
652 #undef fopen
653 #endif
654 #define fopen(a,b) git_fopen(a,b)
655 extern FILE *git_fopen(const char*, const char*);
656 #endif
658 #ifdef SNPRINTF_RETURNS_BOGUS
659 #ifdef snprintf
660 #undef snprintf
661 #endif
662 #define snprintf git_snprintf
663 extern int git_snprintf(char *str, size_t maxsize,
664 const char *format, ...);
665 #ifdef vsnprintf
666 #undef vsnprintf
667 #endif
668 #define vsnprintf git_vsnprintf
669 extern int git_vsnprintf(char *str, size_t maxsize,
670 const char *format, va_list ap);
671 #endif
673 #ifdef __GLIBC_PREREQ
674 #if __GLIBC_PREREQ(2, 1)
675 #define HAVE_STRCHRNUL
676 #define HAVE_MEMPCPY
677 #endif
678 #endif
680 #ifndef HAVE_STRCHRNUL
681 #define strchrnul gitstrchrnul
682 static inline char *gitstrchrnul(const char *s, int c)
684 while (*s && *s != c)
685 s++;
686 return (char *)s;
688 #endif
690 #ifndef HAVE_MEMPCPY
691 #define mempcpy gitmempcpy
692 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
694 return (char *)memcpy(dest, src, n) + n;
696 #endif
698 #ifdef NO_INET_PTON
699 int inet_pton(int af, const char *src, void *dst);
700 #endif
702 #ifdef NO_INET_NTOP
703 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
704 #endif
706 #ifdef NO_PTHREADS
707 #define atexit git_atexit
708 extern int git_atexit(void (*handler)(void));
709 #endif
711 extern void release_pack_memory(size_t);
713 typedef void (*try_to_free_t)(size_t);
714 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
716 #ifdef HAVE_ALLOCA_H
717 # include <alloca.h>
718 # define xalloca(size) (alloca(size))
719 # define xalloca_free(p) do {} while (0)
720 #else
721 # define xalloca(size) (xmalloc(size))
722 # define xalloca_free(p) (free(p))
723 #endif
724 extern char *xstrdup(const char *str);
725 extern void *xmalloc(size_t size);
726 extern void *xmallocz(size_t size);
727 extern void *xmallocz_gently(size_t size);
728 extern void *xmemdupz(const void *data, size_t len);
729 extern char *xstrndup(const char *str, size_t len);
730 extern void *xrealloc(void *ptr, size_t size);
731 extern void *xcalloc(size_t nmemb, size_t size);
732 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
733 extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
734 extern int xopen(const char *path, int flags, ...);
735 extern ssize_t xread(int fd, void *buf, size_t len);
736 extern ssize_t xwrite(int fd, const void *buf, size_t len);
737 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
738 extern int xdup(int fd);
739 extern FILE *xfopen(const char *path, const char *mode);
740 extern FILE *xfdopen(int fd, const char *mode);
741 extern int xmkstemp(char *template);
742 extern int xmkstemp_mode(char *template, int mode);
743 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
744 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
745 extern char *xgetcwd(void);
746 extern FILE *fopen_for_writing(const char *path);
748 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
750 static inline char *xstrdup_or_null(const char *str)
752 return str ? xstrdup(str) : NULL;
755 static inline size_t xsize_t(off_t len)
757 if (len > (size_t) len)
758 die("Cannot handle files this big");
759 return (size_t)len;
762 __attribute__((format (printf, 3, 4)))
763 extern int xsnprintf(char *dst, size_t max, const char *fmt, ...);
765 /* in ctype.c, for kwset users */
766 extern const unsigned char tolower_trans_tbl[256];
768 /* Sane ctype - no locale, and works with signed chars */
769 #undef isascii
770 #undef isspace
771 #undef isdigit
772 #undef isalpha
773 #undef isalnum
774 #undef isprint
775 #undef islower
776 #undef isupper
777 #undef tolower
778 #undef toupper
779 #undef iscntrl
780 #undef ispunct
781 #undef isxdigit
783 extern const unsigned char sane_ctype[256];
784 #define GIT_SPACE 0x01
785 #define GIT_DIGIT 0x02
786 #define GIT_ALPHA 0x04
787 #define GIT_GLOB_SPECIAL 0x08
788 #define GIT_REGEX_SPECIAL 0x10
789 #define GIT_PATHSPEC_MAGIC 0x20
790 #define GIT_CNTRL 0x40
791 #define GIT_PUNCT 0x80
792 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
793 #define isascii(x) (((x) & ~0x7f) == 0)
794 #define isspace(x) sane_istest(x,GIT_SPACE)
795 #define isdigit(x) sane_istest(x,GIT_DIGIT)
796 #define isalpha(x) sane_istest(x,GIT_ALPHA)
797 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
798 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
799 #define islower(x) sane_iscase(x, 1)
800 #define isupper(x) sane_iscase(x, 0)
801 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
802 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
803 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
804 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
805 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
806 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
807 #define tolower(x) sane_case((unsigned char)(x), 0x20)
808 #define toupper(x) sane_case((unsigned char)(x), 0)
809 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
811 static inline int sane_case(int x, int high)
813 if (sane_istest(x, GIT_ALPHA))
814 x = (x & ~0x20) | high;
815 return x;
818 static inline int sane_iscase(int x, int is_lower)
820 if (!sane_istest(x, GIT_ALPHA))
821 return 0;
823 if (is_lower)
824 return (x & 0x20) != 0;
825 else
826 return (x & 0x20) == 0;
829 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
831 unsigned long ul;
832 char *p;
834 errno = 0;
835 /* negative values would be accepted by strtoul */
836 if (strchr(s, '-'))
837 return -1;
838 ul = strtoul(s, &p, base);
839 if (errno || *p || p == s || (unsigned int) ul != ul)
840 return -1;
841 *result = ul;
842 return 0;
845 static inline int strtol_i(char const *s, int base, int *result)
847 long ul;
848 char *p;
850 errno = 0;
851 ul = strtol(s, &p, base);
852 if (errno || *p || p == s || (int) ul != ul)
853 return -1;
854 *result = ul;
855 return 0;
858 #ifdef INTERNAL_QSORT
859 void git_qsort(void *base, size_t nmemb, size_t size,
860 int(*compar)(const void *, const void *));
861 #define qsort git_qsort
862 #endif
864 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
865 # define FORCE_DIR_SET_GID S_ISGID
866 #else
867 # define FORCE_DIR_SET_GID 0
868 #endif
870 #ifdef NO_NSEC
871 #undef USE_NSEC
872 #define ST_CTIME_NSEC(st) 0
873 #define ST_MTIME_NSEC(st) 0
874 #else
875 #ifdef USE_ST_TIMESPEC
876 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
877 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
878 #else
879 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
880 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
881 #endif
882 #endif
884 #ifdef UNRELIABLE_FSTAT
885 #define fstat_is_reliable() 0
886 #else
887 #define fstat_is_reliable() 1
888 #endif
890 #ifndef va_copy
892 * Since an obvious implementation of va_list would be to make it a
893 * pointer into the stack frame, a simple assignment will work on
894 * many systems. But let's try to be more portable.
896 #ifdef __va_copy
897 #define va_copy(dst, src) __va_copy(dst, src)
898 #else
899 #define va_copy(dst, src) ((dst) = (src))
900 #endif
901 #endif
903 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
904 #define HAVE_VARIADIC_MACROS 1
905 #endif
908 * Preserves errno, prints a message, but gives no warning for ENOENT.
909 * Returns 0 on success, which includes trying to unlink an object that does
910 * not exist.
912 int unlink_or_warn(const char *path);
914 * Tries to unlink file. Returns 0 if unlink succeeded
915 * or the file already didn't exist. Returns -1 and
916 * appends a message to err suitable for
917 * 'error("%s", err->buf)' on error.
919 int unlink_or_msg(const char *file, struct strbuf *err);
921 * Preserves errno, prints a message, but gives no warning for ENOENT.
922 * Returns 0 on success, which includes trying to remove a directory that does
923 * not exist.
925 int rmdir_or_warn(const char *path);
927 * Calls the correct function out of {unlink,rmdir}_or_warn based on
928 * the supplied file mode.
930 int remove_or_warn(unsigned int mode, const char *path);
933 * Call access(2), but warn for any error except "missing file"
934 * (ENOENT or ENOTDIR).
936 #define ACCESS_EACCES_OK (1U << 0)
937 int access_or_warn(const char *path, int mode, unsigned flag);
938 int access_or_die(const char *path, int mode, unsigned flag);
940 /* Warn on an inaccessible file that ought to be accessible */
941 void warn_on_inaccessible(const char *path);
943 #ifdef GMTIME_UNRELIABLE_ERRORS
944 struct tm *git_gmtime(const time_t *);
945 struct tm *git_gmtime_r(const time_t *, struct tm *);
946 #define gmtime git_gmtime
947 #define gmtime_r git_gmtime_r
948 #endif
950 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
951 #define USE_PARENS_AROUND_GETTEXT_N 1
952 #endif
954 #ifndef SHELL_PATH
955 # define SHELL_PATH "/bin/sh"
956 #endif
958 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
959 #define flockfile(fh)
960 #define funlockfile(fh)
961 #define getc_unlocked(fh) getc(fh)
962 #endif
964 #endif