Merge branch 'jk/path-name-safety-2.5' into jk/path-name-safety-2.6
[git/debian.git] / git-compat-util.h
blobf035363ba6047c20e76dd9532521c0852a7d6b1f
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 SCNuMAX
308 #define SCNuMAX PRIuMAX
309 #endif
311 #ifndef PRIu32
312 #define PRIu32 "u"
313 #endif
315 #ifndef PRIx32
316 #define PRIx32 "x"
317 #endif
319 #ifndef PRIo32
320 #define PRIo32 "o"
321 #endif
323 #ifndef PATH_SEP
324 #define PATH_SEP ':'
325 #endif
327 #ifdef HAVE_PATHS_H
328 #include <paths.h>
329 #endif
330 #ifndef _PATH_DEFPATH
331 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
332 #endif
334 #ifndef STRIP_EXTENSION
335 #define STRIP_EXTENSION ""
336 #endif
338 #ifndef has_dos_drive_prefix
339 static inline int git_has_dos_drive_prefix(const char *path)
341 return 0;
343 #define has_dos_drive_prefix git_has_dos_drive_prefix
344 #endif
346 #ifndef is_dir_sep
347 static inline int git_is_dir_sep(int c)
349 return c == '/';
351 #define is_dir_sep git_is_dir_sep
352 #endif
354 #ifndef offset_1st_component
355 static inline int git_offset_1st_component(const char *path)
357 return is_dir_sep(path[0]);
359 #define offset_1st_component git_offset_1st_component
360 #endif
362 #ifndef find_last_dir_sep
363 static inline char *git_find_last_dir_sep(const char *path)
365 return strrchr(path, '/');
367 #define find_last_dir_sep git_find_last_dir_sep
368 #endif
370 #if defined(__HP_cc) && (__HP_cc >= 61000)
371 #define NORETURN __attribute__((noreturn))
372 #define NORETURN_PTR
373 #elif defined(__GNUC__) && !defined(NO_NORETURN)
374 #define NORETURN __attribute__((__noreturn__))
375 #define NORETURN_PTR __attribute__((__noreturn__))
376 #elif defined(_MSC_VER)
377 #define NORETURN __declspec(noreturn)
378 #define NORETURN_PTR
379 #else
380 #define NORETURN
381 #define NORETURN_PTR
382 #ifndef __GNUC__
383 #ifndef __attribute__
384 #define __attribute__(x)
385 #endif
386 #endif
387 #endif
389 /* The sentinel attribute is valid from gcc version 4.0 */
390 #if defined(__GNUC__) && (__GNUC__ >= 4)
391 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
392 #else
393 #define LAST_ARG_MUST_BE_NULL
394 #endif
396 #include "compat/bswap.h"
398 #include "wildmatch.h"
400 struct strbuf;
402 /* General helper functions */
403 extern void vreportf(const char *prefix, const char *err, va_list params);
404 extern NORETURN void usage(const char *err);
405 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
406 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
407 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
408 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
409 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
411 #ifndef NO_OPENSSL
412 #ifdef APPLE_COMMON_CRYPTO
413 #include "compat/apple-common-crypto.h"
414 #else
415 #include <openssl/evp.h>
416 #include <openssl/hmac.h>
417 #endif /* APPLE_COMMON_CRYPTO */
418 #include <openssl/x509v3.h>
419 #endif /* NO_OPENSSL */
422 * Let callers be aware of the constant return value; this can help
423 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
424 * because some compilers may not support variadic macros. Since we're only
425 * trying to help gcc, anyway, it's OK; other compilers will fall back to
426 * using the function as usual.
428 #if defined(__GNUC__)
429 static inline int const_error(void)
431 return -1;
433 #define error(...) (error(__VA_ARGS__), const_error())
434 #endif
436 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
437 extern void set_error_routine(void (*routine)(const char *err, va_list params));
438 extern void set_die_is_recursing_routine(int (*routine)(void));
439 extern void set_error_handle(FILE *);
441 extern int starts_with(const char *str, const char *prefix);
444 * If the string "str" begins with the string found in "prefix", return 1.
445 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
446 * the string right after the prefix).
448 * Otherwise, return 0 and leave "out" untouched.
450 * Examples:
452 * [extract branch name, fail if not a branch]
453 * if (!skip_prefix(ref, "refs/heads/", &branch)
454 * return -1;
456 * [skip prefix if present, otherwise use whole string]
457 * skip_prefix(name, "refs/heads/", &name);
459 static inline int skip_prefix(const char *str, const char *prefix,
460 const char **out)
462 do {
463 if (!*prefix) {
464 *out = str;
465 return 1;
467 } while (*str++ == *prefix++);
468 return 0;
472 * If buf ends with suffix, return 1 and subtract the length of the suffix
473 * from *len. Otherwise, return 0 and leave *len untouched.
475 static inline int strip_suffix_mem(const char *buf, size_t *len,
476 const char *suffix)
478 size_t suflen = strlen(suffix);
479 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
480 return 0;
481 *len -= suflen;
482 return 1;
486 * If str ends with suffix, return 1 and set *len to the size of the string
487 * without the suffix. Otherwise, return 0 and set *len to the size of the
488 * string.
490 * Note that we do _not_ NUL-terminate str to the new length.
492 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
494 *len = strlen(str);
495 return strip_suffix_mem(str, len, suffix);
498 static inline int ends_with(const char *str, const char *suffix)
500 size_t len;
501 return strip_suffix(str, suffix, &len);
504 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
506 #ifndef PROT_READ
507 #define PROT_READ 1
508 #define PROT_WRITE 2
509 #define MAP_PRIVATE 1
510 #endif
512 #define mmap git_mmap
513 #define munmap git_munmap
514 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
515 extern int git_munmap(void *start, size_t length);
517 #else /* NO_MMAP || USE_WIN32_MMAP */
519 #include <sys/mman.h>
521 #endif /* NO_MMAP || USE_WIN32_MMAP */
523 #ifdef NO_MMAP
525 /* This value must be multiple of (pagesize * 2) */
526 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
528 #else /* NO_MMAP */
530 /* This value must be multiple of (pagesize * 2) */
531 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
532 (sizeof(void*) >= 8 \
533 ? 1 * 1024 * 1024 * 1024 \
534 : 32 * 1024 * 1024)
536 #endif /* NO_MMAP */
538 #ifndef MAP_FAILED
539 #define MAP_FAILED ((void *)-1)
540 #endif
542 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
543 #define on_disk_bytes(st) ((st).st_size)
544 #else
545 #define on_disk_bytes(st) ((st).st_blocks * 512)
546 #endif
548 #ifdef NEEDS_MODE_TRANSLATION
549 #undef S_IFMT
550 #undef S_IFREG
551 #undef S_IFDIR
552 #undef S_IFLNK
553 #undef S_IFBLK
554 #undef S_IFCHR
555 #undef S_IFIFO
556 #undef S_IFSOCK
557 #define S_IFMT 0170000
558 #define S_IFREG 0100000
559 #define S_IFDIR 0040000
560 #define S_IFLNK 0120000
561 #define S_IFBLK 0060000
562 #define S_IFCHR 0020000
563 #define S_IFIFO 0010000
564 #define S_IFSOCK 0140000
565 #ifdef stat
566 #undef stat
567 #endif
568 #define stat(path, buf) git_stat(path, buf)
569 extern int git_stat(const char *, struct stat *);
570 #ifdef fstat
571 #undef fstat
572 #endif
573 #define fstat(fd, buf) git_fstat(fd, buf)
574 extern int git_fstat(int, struct stat *);
575 #ifdef lstat
576 #undef lstat
577 #endif
578 #define lstat(path, buf) git_lstat(path, buf)
579 extern int git_lstat(const char *, struct stat *);
580 #endif
582 #define DEFAULT_PACKED_GIT_LIMIT \
583 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? 8192 : 256))
585 #ifdef NO_PREAD
586 #define pread git_pread
587 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
588 #endif
590 * Forward decl that will remind us if its twin in cache.h changes.
591 * This function is used in compat/pread.c. But we can't include
592 * cache.h there.
594 extern ssize_t read_in_full(int fd, void *buf, size_t count);
596 #ifdef NO_SETENV
597 #define setenv gitsetenv
598 extern int gitsetenv(const char *, const char *, int);
599 #endif
601 #ifdef NO_MKDTEMP
602 #define mkdtemp gitmkdtemp
603 extern char *gitmkdtemp(char *);
604 #endif
606 #ifdef NO_MKSTEMPS
607 #define mkstemps gitmkstemps
608 extern int gitmkstemps(char *, int);
609 #endif
611 #ifdef NO_UNSETENV
612 #define unsetenv gitunsetenv
613 extern void gitunsetenv(const char *);
614 #endif
616 #ifdef NO_STRCASESTR
617 #define strcasestr gitstrcasestr
618 extern char *gitstrcasestr(const char *haystack, const char *needle);
619 #endif
621 #ifdef NO_STRLCPY
622 #define strlcpy gitstrlcpy
623 extern size_t gitstrlcpy(char *, const char *, size_t);
624 #endif
626 #ifdef NO_STRTOUMAX
627 #define strtoumax gitstrtoumax
628 extern uintmax_t gitstrtoumax(const char *, char **, int);
629 #define strtoimax gitstrtoimax
630 extern intmax_t gitstrtoimax(const char *, char **, int);
631 #endif
633 #ifdef NO_HSTRERROR
634 #define hstrerror githstrerror
635 extern const char *githstrerror(int herror);
636 #endif
638 #ifdef NO_MEMMEM
639 #define memmem gitmemmem
640 void *gitmemmem(const void *haystack, size_t haystacklen,
641 const void *needle, size_t needlelen);
642 #endif
644 #ifdef NO_GETPAGESIZE
645 #define getpagesize() sysconf(_SC_PAGESIZE)
646 #endif
648 #ifdef FREAD_READS_DIRECTORIES
649 #ifdef fopen
650 #undef fopen
651 #endif
652 #define fopen(a,b) git_fopen(a,b)
653 extern FILE *git_fopen(const char*, const char*);
654 #endif
656 #ifdef SNPRINTF_RETURNS_BOGUS
657 #ifdef snprintf
658 #undef snprintf
659 #endif
660 #define snprintf git_snprintf
661 extern int git_snprintf(char *str, size_t maxsize,
662 const char *format, ...);
663 #ifdef vsnprintf
664 #undef vsnprintf
665 #endif
666 #define vsnprintf git_vsnprintf
667 extern int git_vsnprintf(char *str, size_t maxsize,
668 const char *format, va_list ap);
669 #endif
671 #ifdef __GLIBC_PREREQ
672 #if __GLIBC_PREREQ(2, 1)
673 #define HAVE_STRCHRNUL
674 #define HAVE_MEMPCPY
675 #endif
676 #endif
678 #ifndef HAVE_STRCHRNUL
679 #define strchrnul gitstrchrnul
680 static inline char *gitstrchrnul(const char *s, int c)
682 while (*s && *s != c)
683 s++;
684 return (char *)s;
686 #endif
688 #ifndef HAVE_MEMPCPY
689 #define mempcpy gitmempcpy
690 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
692 return (char *)memcpy(dest, src, n) + n;
694 #endif
696 #ifdef NO_INET_PTON
697 int inet_pton(int af, const char *src, void *dst);
698 #endif
700 #ifdef NO_INET_NTOP
701 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
702 #endif
704 #ifdef NO_PTHREADS
705 #define atexit git_atexit
706 extern int git_atexit(void (*handler)(void));
707 #endif
709 extern void release_pack_memory(size_t);
711 typedef void (*try_to_free_t)(size_t);
712 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
714 static inline size_t st_add(size_t a, size_t b)
716 if (unsigned_add_overflows(a, b))
717 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
718 (uintmax_t)a, (uintmax_t)b);
719 return a + b;
721 #define st_add3(a,b,c) st_add((a),st_add((b),(c)))
722 #define st_add4(a,b,c,d) st_add((a),st_add3((b),(c),(d)))
724 static inline size_t st_mult(size_t a, size_t b)
726 if (unsigned_mult_overflows(a, b))
727 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
728 (uintmax_t)a, (uintmax_t)b);
729 return a * b;
732 static inline size_t st_sub(size_t a, size_t b)
734 if (a < b)
735 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
736 (uintmax_t)a, (uintmax_t)b);
737 return a - b;
740 #ifdef HAVE_ALLOCA_H
741 # include <alloca.h>
742 # define xalloca(size) (alloca(size))
743 # define xalloca_free(p) do {} while (0)
744 #else
745 # define xalloca(size) (xmalloc(size))
746 # define xalloca_free(p) (free(p))
747 #endif
748 extern char *xstrdup(const char *str);
749 extern void *xmalloc(size_t size);
750 extern void *xmallocz(size_t size);
751 extern void *xmallocz_gently(size_t size);
752 extern void *xmemdupz(const void *data, size_t len);
753 extern char *xstrndup(const char *str, size_t len);
754 extern void *xrealloc(void *ptr, size_t size);
755 extern void *xcalloc(size_t nmemb, size_t size);
756 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
757 extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
758 extern int xopen(const char *path, int flags, ...);
759 extern ssize_t xread(int fd, void *buf, size_t len);
760 extern ssize_t xwrite(int fd, const void *buf, size_t len);
761 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
762 extern int xdup(int fd);
763 extern FILE *xfopen(const char *path, const char *mode);
764 extern FILE *xfdopen(int fd, const char *mode);
765 extern int xmkstemp(char *template);
766 extern int xmkstemp_mode(char *template, int mode);
767 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
768 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
769 extern char *xgetcwd(void);
771 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
773 static inline char *xstrdup_or_null(const char *str)
775 return str ? xstrdup(str) : NULL;
778 static inline size_t xsize_t(off_t len)
780 if (len > (size_t) len)
781 die("Cannot handle files this big");
782 return (size_t)len;
785 /* in ctype.c, for kwset users */
786 extern const unsigned char tolower_trans_tbl[256];
788 /* Sane ctype - no locale, and works with signed chars */
789 #undef isascii
790 #undef isspace
791 #undef isdigit
792 #undef isalpha
793 #undef isalnum
794 #undef isprint
795 #undef islower
796 #undef isupper
797 #undef tolower
798 #undef toupper
799 #undef iscntrl
800 #undef ispunct
801 #undef isxdigit
803 extern const unsigned char sane_ctype[256];
804 #define GIT_SPACE 0x01
805 #define GIT_DIGIT 0x02
806 #define GIT_ALPHA 0x04
807 #define GIT_GLOB_SPECIAL 0x08
808 #define GIT_REGEX_SPECIAL 0x10
809 #define GIT_PATHSPEC_MAGIC 0x20
810 #define GIT_CNTRL 0x40
811 #define GIT_PUNCT 0x80
812 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
813 #define isascii(x) (((x) & ~0x7f) == 0)
814 #define isspace(x) sane_istest(x,GIT_SPACE)
815 #define isdigit(x) sane_istest(x,GIT_DIGIT)
816 #define isalpha(x) sane_istest(x,GIT_ALPHA)
817 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
818 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
819 #define islower(x) sane_iscase(x, 1)
820 #define isupper(x) sane_iscase(x, 0)
821 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
822 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
823 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
824 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
825 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
826 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
827 #define tolower(x) sane_case((unsigned char)(x), 0x20)
828 #define toupper(x) sane_case((unsigned char)(x), 0)
829 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
831 static inline int sane_case(int x, int high)
833 if (sane_istest(x, GIT_ALPHA))
834 x = (x & ~0x20) | high;
835 return x;
838 static inline int sane_iscase(int x, int is_lower)
840 if (!sane_istest(x, GIT_ALPHA))
841 return 0;
843 if (is_lower)
844 return (x & 0x20) != 0;
845 else
846 return (x & 0x20) == 0;
849 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
851 unsigned long ul;
852 char *p;
854 errno = 0;
855 ul = strtoul(s, &p, base);
856 if (errno || *p || p == s || (unsigned int) ul != ul)
857 return -1;
858 *result = ul;
859 return 0;
862 static inline int strtol_i(char const *s, int base, int *result)
864 long ul;
865 char *p;
867 errno = 0;
868 ul = strtol(s, &p, base);
869 if (errno || *p || p == s || (int) ul != ul)
870 return -1;
871 *result = ul;
872 return 0;
875 #ifdef INTERNAL_QSORT
876 void git_qsort(void *base, size_t nmemb, size_t size,
877 int(*compar)(const void *, const void *));
878 #define qsort git_qsort
879 #endif
881 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
882 # define FORCE_DIR_SET_GID S_ISGID
883 #else
884 # define FORCE_DIR_SET_GID 0
885 #endif
887 #ifdef NO_NSEC
888 #undef USE_NSEC
889 #define ST_CTIME_NSEC(st) 0
890 #define ST_MTIME_NSEC(st) 0
891 #else
892 #ifdef USE_ST_TIMESPEC
893 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
894 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
895 #else
896 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
897 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
898 #endif
899 #endif
901 #ifdef UNRELIABLE_FSTAT
902 #define fstat_is_reliable() 0
903 #else
904 #define fstat_is_reliable() 1
905 #endif
907 #ifndef va_copy
909 * Since an obvious implementation of va_list would be to make it a
910 * pointer into the stack frame, a simple assignment will work on
911 * many systems. But let's try to be more portable.
913 #ifdef __va_copy
914 #define va_copy(dst, src) __va_copy(dst, src)
915 #else
916 #define va_copy(dst, src) ((dst) = (src))
917 #endif
918 #endif
920 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
921 #define HAVE_VARIADIC_MACROS 1
922 #endif
925 * Preserves errno, prints a message, but gives no warning for ENOENT.
926 * Returns 0 on success, which includes trying to unlink an object that does
927 * not exist.
929 int unlink_or_warn(const char *path);
931 * Tries to unlink file. Returns 0 if unlink succeeded
932 * or the file already didn't exist. Returns -1 and
933 * appends a message to err suitable for
934 * 'error("%s", err->buf)' on error.
936 int unlink_or_msg(const char *file, struct strbuf *err);
938 * Preserves errno, prints a message, but gives no warning for ENOENT.
939 * Returns 0 on success, which includes trying to remove a directory that does
940 * not exist.
942 int rmdir_or_warn(const char *path);
944 * Calls the correct function out of {unlink,rmdir}_or_warn based on
945 * the supplied file mode.
947 int remove_or_warn(unsigned int mode, const char *path);
950 * Call access(2), but warn for any error except "missing file"
951 * (ENOENT or ENOTDIR).
953 #define ACCESS_EACCES_OK (1U << 0)
954 int access_or_warn(const char *path, int mode, unsigned flag);
955 int access_or_die(const char *path, int mode, unsigned flag);
957 /* Warn on an inaccessible file that ought to be accessible */
958 void warn_on_inaccessible(const char *path);
960 #ifdef GMTIME_UNRELIABLE_ERRORS
961 struct tm *git_gmtime(const time_t *);
962 struct tm *git_gmtime_r(const time_t *, struct tm *);
963 #define gmtime git_gmtime
964 #define gmtime_r git_gmtime_r
965 #endif
967 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
968 #define USE_PARENS_AROUND_GETTEXT_N 1
969 #endif
971 #ifndef SHELL_PATH
972 # define SHELL_PATH "/bin/sh"
973 #endif
975 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
976 #define flockfile(fh)
977 #define funlockfile(fh)
978 #define getc_unlocked(fh) getc(fh)
979 #endif
981 #endif