Git 2.5.6
[git/raj.git] / git-compat-util.h
blobd20fa89d5f32e0c76c7a9e6f77d91be6cb0d9f09
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))
100 * Returns true if the multiplication of "a" and "b" will
101 * overflow. The types of "a" and "b" must match and must be unsigned.
102 * Note that this macro evaluates "a" twice!
104 #define unsigned_mult_overflows(a, b) \
105 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
107 #ifdef __GNUC__
108 #define TYPEOF(x) (__typeof__(x))
109 #else
110 #define TYPEOF(x)
111 #endif
113 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
114 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
116 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
118 /* Approximation of the length of the decimal representation of this type. */
119 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
121 #if defined(__sun__)
123 * On Solaris, when _XOPEN_EXTENDED is set, its header file
124 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
125 * setting to say we are XPG5 or XPG6. Also on Solaris,
126 * XPG6 programs must be compiled with a c99 compiler, while
127 * non XPG6 programs must be compiled with a pre-c99 compiler.
129 # if __STDC_VERSION__ - 0 >= 199901L
130 # define _XOPEN_SOURCE 600
131 # else
132 # define _XOPEN_SOURCE 500
133 # endif
134 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
135 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
136 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
137 !defined(__CYGWIN__)
138 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
139 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
140 #endif
141 #define _ALL_SOURCE 1
142 #define _GNU_SOURCE 1
143 #define _BSD_SOURCE 1
144 #define _DEFAULT_SOURCE 1
145 #define _NETBSD_SOURCE 1
146 #define _SGI_SOURCE 1
148 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
149 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
150 # define _WIN32_WINNT 0x0502
151 # endif
152 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
153 #include <winsock2.h>
154 #include <windows.h>
155 #define GIT_WINDOWS_NATIVE
156 #endif
158 #include <unistd.h>
159 #include <stdio.h>
160 #include <sys/stat.h>
161 #include <fcntl.h>
162 #include <stddef.h>
163 #include <stdlib.h>
164 #include <stdarg.h>
165 #include <string.h>
166 #ifdef HAVE_STRINGS_H
167 #include <strings.h> /* for strcasecmp() */
168 #endif
169 #include <errno.h>
170 #include <limits.h>
171 #ifdef NEEDS_SYS_PARAM_H
172 #include <sys/param.h>
173 #endif
174 #include <sys/types.h>
175 #include <dirent.h>
176 #include <sys/time.h>
177 #include <time.h>
178 #include <signal.h>
179 #include <assert.h>
180 #include <regex.h>
181 #include <utime.h>
182 #include <syslog.h>
183 #ifndef NO_SYS_POLL_H
184 #include <sys/poll.h>
185 #else
186 #include <poll.h>
187 #endif
188 #ifdef HAVE_BSD_SYSCTL
189 #include <sys/sysctl.h>
190 #endif
192 #if defined(__MINGW32__)
193 /* pull in Windows compatibility stuff */
194 #include "compat/mingw.h"
195 #elif defined(_MSC_VER)
196 #include "compat/msvc.h"
197 #else
198 #include <sys/utsname.h>
199 #include <sys/wait.h>
200 #include <sys/resource.h>
201 #include <sys/socket.h>
202 #include <sys/ioctl.h>
203 #include <termios.h>
204 #ifndef NO_SYS_SELECT_H
205 #include <sys/select.h>
206 #endif
207 #include <netinet/in.h>
208 #include <netinet/tcp.h>
209 #include <arpa/inet.h>
210 #include <netdb.h>
211 #include <pwd.h>
212 #include <sys/un.h>
213 #ifndef NO_INTTYPES_H
214 #include <inttypes.h>
215 #else
216 #include <stdint.h>
217 #endif
218 #ifdef NO_INTPTR_T
220 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
221 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
222 * while on IP16 and IP16L32 it is "int" (resp. "short")
223 * Size needs to match (or exceed) 'sizeof(void *)'.
224 * We can't take "long long" here as not everybody has it.
226 typedef long intptr_t;
227 typedef unsigned long uintptr_t;
228 #endif
229 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
230 #include <grp.h>
231 #define _ALL_SOURCE 1
232 #endif
234 /* used on Mac OS X */
235 #ifdef PRECOMPOSE_UNICODE
236 #include "compat/precompose_utf8.h"
237 #else
238 #define precompose_str(in,i_nfd2nfc)
239 #define precompose_argv(c,v)
240 #define probe_utf8_pathname_composition(a,b)
241 #endif
243 #ifdef MKDIR_WO_TRAILING_SLASH
244 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
245 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
246 #endif
248 #ifdef NO_STRUCT_ITIMERVAL
249 struct itimerval {
250 struct timeval it_interval;
251 struct timeval it_value;
253 #endif
255 #ifdef NO_SETITIMER
256 #define setitimer(which,value,ovalue)
257 #endif
259 #ifndef NO_LIBGEN_H
260 #include <libgen.h>
261 #else
262 #define basename gitbasename
263 extern char *gitbasename(char *);
264 #endif
266 #ifndef NO_ICONV
267 #include <iconv.h>
268 #endif
270 #ifndef NO_OPENSSL
271 #ifdef __APPLE__
272 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
273 #include <AvailabilityMacros.h>
274 #undef DEPRECATED_ATTRIBUTE
275 #define DEPRECATED_ATTRIBUTE
276 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
277 #endif
278 #include <openssl/ssl.h>
279 #include <openssl/err.h>
280 #ifdef NO_HMAC_CTX_CLEANUP
281 #define HMAC_CTX_cleanup HMAC_cleanup
282 #endif
283 #endif
285 /* On most systems <netdb.h> would have given us this, but
286 * not on some systems (e.g. z/OS).
288 #ifndef NI_MAXHOST
289 #define NI_MAXHOST 1025
290 #endif
292 #ifndef NI_MAXSERV
293 #define NI_MAXSERV 32
294 #endif
296 /* On most systems <limits.h> would have given us this, but
297 * not on some systems (e.g. GNU/Hurd).
299 #ifndef PATH_MAX
300 #define PATH_MAX 4096
301 #endif
303 #ifndef PRIuMAX
304 #define PRIuMAX "llu"
305 #endif
307 #ifndef PRIu32
308 #define PRIu32 "u"
309 #endif
311 #ifndef PRIx32
312 #define PRIx32 "x"
313 #endif
315 #ifndef PRIo32
316 #define PRIo32 "o"
317 #endif
319 #ifndef PATH_SEP
320 #define PATH_SEP ':'
321 #endif
323 #ifdef HAVE_PATHS_H
324 #include <paths.h>
325 #endif
326 #ifndef _PATH_DEFPATH
327 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
328 #endif
330 #ifndef STRIP_EXTENSION
331 #define STRIP_EXTENSION ""
332 #endif
334 #ifndef has_dos_drive_prefix
335 static inline int git_has_dos_drive_prefix(const char *path)
337 return 0;
339 #define has_dos_drive_prefix git_has_dos_drive_prefix
340 #endif
342 #ifndef is_dir_sep
343 static inline int git_is_dir_sep(int c)
345 return c == '/';
347 #define is_dir_sep git_is_dir_sep
348 #endif
350 #ifndef offset_1st_component
351 static inline int git_offset_1st_component(const char *path)
353 return is_dir_sep(path[0]);
355 #define offset_1st_component git_offset_1st_component
356 #endif
358 #ifndef find_last_dir_sep
359 static inline char *git_find_last_dir_sep(const char *path)
361 return strrchr(path, '/');
363 #define find_last_dir_sep git_find_last_dir_sep
364 #endif
366 #if defined(__HP_cc) && (__HP_cc >= 61000)
367 #define NORETURN __attribute__((noreturn))
368 #define NORETURN_PTR
369 #elif defined(__GNUC__) && !defined(NO_NORETURN)
370 #define NORETURN __attribute__((__noreturn__))
371 #define NORETURN_PTR __attribute__((__noreturn__))
372 #elif defined(_MSC_VER)
373 #define NORETURN __declspec(noreturn)
374 #define NORETURN_PTR
375 #else
376 #define NORETURN
377 #define NORETURN_PTR
378 #ifndef __GNUC__
379 #ifndef __attribute__
380 #define __attribute__(x)
381 #endif
382 #endif
383 #endif
385 /* The sentinel attribute is valid from gcc version 4.0 */
386 #if defined(__GNUC__) && (__GNUC__ >= 4)
387 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
388 #else
389 #define LAST_ARG_MUST_BE_NULL
390 #endif
392 #include "compat/bswap.h"
394 #include "wildmatch.h"
396 struct strbuf;
398 /* General helper functions */
399 extern void vreportf(const char *prefix, const char *err, va_list params);
400 extern NORETURN void usage(const char *err);
401 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
402 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
403 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
404 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
405 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
407 #ifndef NO_OPENSSL
408 #ifdef APPLE_COMMON_CRYPTO
409 #include "compat/apple-common-crypto.h"
410 #else
411 #include <openssl/evp.h>
412 #include <openssl/hmac.h>
413 #endif /* APPLE_COMMON_CRYPTO */
414 #include <openssl/x509v3.h>
415 #endif /* NO_OPENSSL */
418 * Let callers be aware of the constant return value; this can help
419 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
420 * because some compilers may not support variadic macros. Since we're only
421 * trying to help gcc, anyway, it's OK; other compilers will fall back to
422 * using the function as usual.
424 #if defined(__GNUC__)
425 static inline int const_error(void)
427 return -1;
429 #define error(...) (error(__VA_ARGS__), const_error())
430 #endif
432 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
433 extern void set_error_routine(void (*routine)(const char *err, va_list params));
434 extern void set_die_is_recursing_routine(int (*routine)(void));
435 extern void set_error_handle(FILE *);
437 extern int starts_with(const char *str, const char *prefix);
440 * If the string "str" begins with the string found in "prefix", return 1.
441 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
442 * the string right after the prefix).
444 * Otherwise, return 0 and leave "out" untouched.
446 * Examples:
448 * [extract branch name, fail if not a branch]
449 * if (!skip_prefix(ref, "refs/heads/", &branch)
450 * return -1;
452 * [skip prefix if present, otherwise use whole string]
453 * skip_prefix(name, "refs/heads/", &name);
455 static inline int skip_prefix(const char *str, const char *prefix,
456 const char **out)
458 do {
459 if (!*prefix) {
460 *out = str;
461 return 1;
463 } while (*str++ == *prefix++);
464 return 0;
468 * If buf ends with suffix, return 1 and subtract the length of the suffix
469 * from *len. Otherwise, return 0 and leave *len untouched.
471 static inline int strip_suffix_mem(const char *buf, size_t *len,
472 const char *suffix)
474 size_t suflen = strlen(suffix);
475 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
476 return 0;
477 *len -= suflen;
478 return 1;
482 * If str ends with suffix, return 1 and set *len to the size of the string
483 * without the suffix. Otherwise, return 0 and set *len to the size of the
484 * string.
486 * Note that we do _not_ NUL-terminate str to the new length.
488 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
490 *len = strlen(str);
491 return strip_suffix_mem(str, len, suffix);
494 static inline int ends_with(const char *str, const char *suffix)
496 size_t len;
497 return strip_suffix(str, suffix, &len);
500 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
502 #ifndef PROT_READ
503 #define PROT_READ 1
504 #define PROT_WRITE 2
505 #define MAP_PRIVATE 1
506 #endif
508 #define mmap git_mmap
509 #define munmap git_munmap
510 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
511 extern int git_munmap(void *start, size_t length);
513 #else /* NO_MMAP || USE_WIN32_MMAP */
515 #include <sys/mman.h>
517 #endif /* NO_MMAP || USE_WIN32_MMAP */
519 #ifdef NO_MMAP
521 /* This value must be multiple of (pagesize * 2) */
522 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
524 #else /* NO_MMAP */
526 /* This value must be multiple of (pagesize * 2) */
527 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
528 (sizeof(void*) >= 8 \
529 ? 1 * 1024 * 1024 * 1024 \
530 : 32 * 1024 * 1024)
532 #endif /* NO_MMAP */
534 #ifndef MAP_FAILED
535 #define MAP_FAILED ((void *)-1)
536 #endif
538 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
539 #define on_disk_bytes(st) ((st).st_size)
540 #else
541 #define on_disk_bytes(st) ((st).st_blocks * 512)
542 #endif
544 #ifdef NEEDS_MODE_TRANSLATION
545 #undef S_IFMT
546 #undef S_IFREG
547 #undef S_IFDIR
548 #undef S_IFLNK
549 #undef S_IFBLK
550 #undef S_IFCHR
551 #undef S_IFIFO
552 #undef S_IFSOCK
553 #define S_IFMT 0170000
554 #define S_IFREG 0100000
555 #define S_IFDIR 0040000
556 #define S_IFLNK 0120000
557 #define S_IFBLK 0060000
558 #define S_IFCHR 0020000
559 #define S_IFIFO 0010000
560 #define S_IFSOCK 0140000
561 #ifdef stat
562 #undef stat
563 #endif
564 #define stat(path, buf) git_stat(path, buf)
565 extern int git_stat(const char *, struct stat *);
566 #ifdef fstat
567 #undef fstat
568 #endif
569 #define fstat(fd, buf) git_fstat(fd, buf)
570 extern int git_fstat(int, struct stat *);
571 #ifdef lstat
572 #undef lstat
573 #endif
574 #define lstat(path, buf) git_lstat(path, buf)
575 extern int git_lstat(const char *, struct stat *);
576 #endif
578 #define DEFAULT_PACKED_GIT_LIMIT \
579 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
581 #ifdef NO_PREAD
582 #define pread git_pread
583 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
584 #endif
586 * Forward decl that will remind us if its twin in cache.h changes.
587 * This function is used in compat/pread.c. But we can't include
588 * cache.h there.
590 extern ssize_t read_in_full(int fd, void *buf, size_t count);
592 #ifdef NO_SETENV
593 #define setenv gitsetenv
594 extern int gitsetenv(const char *, const char *, int);
595 #endif
597 #ifdef NO_MKDTEMP
598 #define mkdtemp gitmkdtemp
599 extern char *gitmkdtemp(char *);
600 #endif
602 #ifdef NO_MKSTEMPS
603 #define mkstemps gitmkstemps
604 extern int gitmkstemps(char *, int);
605 #endif
607 #ifdef NO_UNSETENV
608 #define unsetenv gitunsetenv
609 extern void gitunsetenv(const char *);
610 #endif
612 #ifdef NO_STRCASESTR
613 #define strcasestr gitstrcasestr
614 extern char *gitstrcasestr(const char *haystack, const char *needle);
615 #endif
617 #ifdef NO_STRLCPY
618 #define strlcpy gitstrlcpy
619 extern size_t gitstrlcpy(char *, const char *, size_t);
620 #endif
622 #ifdef NO_STRTOUMAX
623 #define strtoumax gitstrtoumax
624 extern uintmax_t gitstrtoumax(const char *, char **, int);
625 #define strtoimax gitstrtoimax
626 extern intmax_t gitstrtoimax(const char *, char **, int);
627 #endif
629 #ifdef NO_HSTRERROR
630 #define hstrerror githstrerror
631 extern const char *githstrerror(int herror);
632 #endif
634 #ifdef NO_MEMMEM
635 #define memmem gitmemmem
636 void *gitmemmem(const void *haystack, size_t haystacklen,
637 const void *needle, size_t needlelen);
638 #endif
640 #ifdef NO_GETPAGESIZE
641 #define getpagesize() sysconf(_SC_PAGESIZE)
642 #endif
644 #ifdef FREAD_READS_DIRECTORIES
645 #ifdef fopen
646 #undef fopen
647 #endif
648 #define fopen(a,b) git_fopen(a,b)
649 extern FILE *git_fopen(const char*, const char*);
650 #endif
652 #ifdef SNPRINTF_RETURNS_BOGUS
653 #ifdef snprintf
654 #undef snprintf
655 #endif
656 #define snprintf git_snprintf
657 extern int git_snprintf(char *str, size_t maxsize,
658 const char *format, ...);
659 #ifdef vsnprintf
660 #undef vsnprintf
661 #endif
662 #define vsnprintf git_vsnprintf
663 extern int git_vsnprintf(char *str, size_t maxsize,
664 const char *format, va_list ap);
665 #endif
667 #ifdef __GLIBC_PREREQ
668 #if __GLIBC_PREREQ(2, 1)
669 #define HAVE_STRCHRNUL
670 #define HAVE_MEMPCPY
671 #endif
672 #endif
674 #ifndef HAVE_STRCHRNUL
675 #define strchrnul gitstrchrnul
676 static inline char *gitstrchrnul(const char *s, int c)
678 while (*s && *s != c)
679 s++;
680 return (char *)s;
682 #endif
684 #ifndef HAVE_MEMPCPY
685 #define mempcpy gitmempcpy
686 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
688 return (char *)memcpy(dest, src, n) + n;
690 #endif
692 #ifdef NO_INET_PTON
693 int inet_pton(int af, const char *src, void *dst);
694 #endif
696 #ifdef NO_INET_NTOP
697 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
698 #endif
700 #ifdef NO_PTHREADS
701 #define atexit git_atexit
702 extern int git_atexit(void (*handler)(void));
703 #endif
705 extern void release_pack_memory(size_t);
707 typedef void (*try_to_free_t)(size_t);
708 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
710 static inline size_t st_add(size_t a, size_t b)
712 if (unsigned_add_overflows(a, b))
713 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
714 (uintmax_t)a, (uintmax_t)b);
715 return a + b;
717 #define st_add3(a,b,c) st_add((a),st_add((b),(c)))
718 #define st_add4(a,b,c,d) st_add((a),st_add3((b),(c),(d)))
720 static inline size_t st_mult(size_t a, size_t b)
722 if (unsigned_mult_overflows(a, b))
723 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
724 (uintmax_t)a, (uintmax_t)b);
725 return a * b;
728 static inline size_t st_sub(size_t a, size_t b)
730 if (a < b)
731 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
732 (uintmax_t)a, (uintmax_t)b);
733 return a - b;
736 #ifdef HAVE_ALLOCA_H
737 # include <alloca.h>
738 # define xalloca(size) (alloca(size))
739 # define xalloca_free(p) do {} while (0)
740 #else
741 # define xalloca(size) (xmalloc(size))
742 # define xalloca_free(p) (free(p))
743 #endif
744 extern char *xstrdup(const char *str);
745 extern void *xmalloc(size_t size);
746 extern void *xmallocz(size_t size);
747 extern void *xmallocz_gently(size_t size);
748 extern void *xmemdupz(const void *data, size_t len);
749 extern char *xstrndup(const char *str, size_t len);
750 extern void *xrealloc(void *ptr, size_t size);
751 extern void *xcalloc(size_t nmemb, size_t size);
752 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
753 extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
754 extern ssize_t xread(int fd, void *buf, size_t len);
755 extern ssize_t xwrite(int fd, const void *buf, size_t len);
756 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
757 extern int xdup(int fd);
758 extern FILE *xfdopen(int fd, const char *mode);
759 extern int xmkstemp(char *template);
760 extern int xmkstemp_mode(char *template, int mode);
761 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
762 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
763 extern char *xgetcwd(void);
765 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
767 static inline char *xstrdup_or_null(const char *str)
769 return str ? xstrdup(str) : NULL;
772 static inline size_t xsize_t(off_t len)
774 if (len > (size_t) len)
775 die("Cannot handle files this big");
776 return (size_t)len;
779 /* in ctype.c, for kwset users */
780 extern const unsigned char tolower_trans_tbl[256];
782 /* Sane ctype - no locale, and works with signed chars */
783 #undef isascii
784 #undef isspace
785 #undef isdigit
786 #undef isalpha
787 #undef isalnum
788 #undef isprint
789 #undef islower
790 #undef isupper
791 #undef tolower
792 #undef toupper
793 #undef iscntrl
794 #undef ispunct
795 #undef isxdigit
797 extern const unsigned char sane_ctype[256];
798 #define GIT_SPACE 0x01
799 #define GIT_DIGIT 0x02
800 #define GIT_ALPHA 0x04
801 #define GIT_GLOB_SPECIAL 0x08
802 #define GIT_REGEX_SPECIAL 0x10
803 #define GIT_PATHSPEC_MAGIC 0x20
804 #define GIT_CNTRL 0x40
805 #define GIT_PUNCT 0x80
806 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
807 #define isascii(x) (((x) & ~0x7f) == 0)
808 #define isspace(x) sane_istest(x,GIT_SPACE)
809 #define isdigit(x) sane_istest(x,GIT_DIGIT)
810 #define isalpha(x) sane_istest(x,GIT_ALPHA)
811 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
812 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
813 #define islower(x) sane_iscase(x, 1)
814 #define isupper(x) sane_iscase(x, 0)
815 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
816 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
817 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
818 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
819 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
820 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
821 #define tolower(x) sane_case((unsigned char)(x), 0x20)
822 #define toupper(x) sane_case((unsigned char)(x), 0)
823 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
825 static inline int sane_case(int x, int high)
827 if (sane_istest(x, GIT_ALPHA))
828 x = (x & ~0x20) | high;
829 return x;
832 static inline int sane_iscase(int x, int is_lower)
834 if (!sane_istest(x, GIT_ALPHA))
835 return 0;
837 if (is_lower)
838 return (x & 0x20) != 0;
839 else
840 return (x & 0x20) == 0;
843 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
845 unsigned long ul;
846 char *p;
848 errno = 0;
849 ul = strtoul(s, &p, base);
850 if (errno || *p || p == s || (unsigned int) ul != ul)
851 return -1;
852 *result = ul;
853 return 0;
856 static inline int strtol_i(char const *s, int base, int *result)
858 long ul;
859 char *p;
861 errno = 0;
862 ul = strtol(s, &p, base);
863 if (errno || *p || p == s || (int) ul != ul)
864 return -1;
865 *result = ul;
866 return 0;
869 #ifdef INTERNAL_QSORT
870 void git_qsort(void *base, size_t nmemb, size_t size,
871 int(*compar)(const void *, const void *));
872 #define qsort git_qsort
873 #endif
875 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
876 # define FORCE_DIR_SET_GID S_ISGID
877 #else
878 # define FORCE_DIR_SET_GID 0
879 #endif
881 #ifdef NO_NSEC
882 #undef USE_NSEC
883 #define ST_CTIME_NSEC(st) 0
884 #define ST_MTIME_NSEC(st) 0
885 #else
886 #ifdef USE_ST_TIMESPEC
887 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
888 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
889 #else
890 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
891 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
892 #endif
893 #endif
895 #ifdef UNRELIABLE_FSTAT
896 #define fstat_is_reliable() 0
897 #else
898 #define fstat_is_reliable() 1
899 #endif
901 #ifndef va_copy
903 * Since an obvious implementation of va_list would be to make it a
904 * pointer into the stack frame, a simple assignment will work on
905 * many systems. But let's try to be more portable.
907 #ifdef __va_copy
908 #define va_copy(dst, src) __va_copy(dst, src)
909 #else
910 #define va_copy(dst, src) ((dst) = (src))
911 #endif
912 #endif
914 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
915 #define HAVE_VARIADIC_MACROS 1
916 #endif
919 * Preserves errno, prints a message, but gives no warning for ENOENT.
920 * Returns 0 on success, which includes trying to unlink an object that does
921 * not exist.
923 int unlink_or_warn(const char *path);
925 * Tries to unlink file. Returns 0 if unlink succeeded
926 * or the file already didn't exist. Returns -1 and
927 * appends a message to err suitable for
928 * 'error("%s", err->buf)' on error.
930 int unlink_or_msg(const char *file, struct strbuf *err);
932 * Preserves errno, prints a message, but gives no warning for ENOENT.
933 * Returns 0 on success, which includes trying to remove a directory that does
934 * not exist.
936 int rmdir_or_warn(const char *path);
938 * Calls the correct function out of {unlink,rmdir}_or_warn based on
939 * the supplied file mode.
941 int remove_or_warn(unsigned int mode, const char *path);
944 * Call access(2), but warn for any error except "missing file"
945 * (ENOENT or ENOTDIR).
947 #define ACCESS_EACCES_OK (1U << 0)
948 int access_or_warn(const char *path, int mode, unsigned flag);
949 int access_or_die(const char *path, int mode, unsigned flag);
951 /* Warn on an inaccessible file that ought to be accessible */
952 void warn_on_inaccessible(const char *path);
954 /* Get the passwd entry for the UID of the current process. */
955 struct passwd *xgetpwuid_self(void);
957 #ifdef GMTIME_UNRELIABLE_ERRORS
958 struct tm *git_gmtime(const time_t *);
959 struct tm *git_gmtime_r(const time_t *, struct tm *);
960 #define gmtime git_gmtime
961 #define gmtime_r git_gmtime_r
962 #endif
964 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
965 #define USE_PARENS_AROUND_GETTEXT_N 1
966 #endif
968 #ifndef SHELL_PATH
969 # define SHELL_PATH "/bin/sh"
970 #endif
972 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
973 #define flockfile(fh)
974 #define funlockfile(fh)
975 #define getc_unlocked(fh) getc(fh)
976 #endif
978 #endif