1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
8 * See if our compiler is known to support flexible array members.
10 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
11 # define FLEX_ARRAY /* empty */
12 #elif defined(__GNUC__)
14 # define FLEX_ARRAY /* empty */
16 # define FLEX_ARRAY 0 /* older GNU extension */
21 * Otherwise, default to safer but a bit wasteful traditional style
28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
31 #define maximum_signed_value_of_type(a) \
32 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
34 #define maximum_unsigned_value_of_type(a) \
35 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
38 * Signed integer overflow is undefined in C, so here's a helper macro
39 * to detect if the sum of two integers will overflow.
41 * Requires: a >= 0, typeof(a) equals typeof(b)
43 #define signed_add_overflows(a, b) \
44 ((b) > maximum_signed_value_of_type(a) - (a))
46 #define unsigned_add_overflows(a, b) \
47 ((b) > maximum_unsigned_value_of_type(a) - (a))
50 #define TYPEOF(x) (__typeof__(x))
55 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
56 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
58 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
60 /* Approximation of the length of the decimal representation of this type. */
61 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
65 * On Solaris, when _XOPEN_EXTENDED is set, its header file
66 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
67 * setting to say we are XPG5 or XPG6. Also on Solaris,
68 * XPG6 programs must be compiled with a c99 compiler, while
69 * non XPG6 programs must be compiled with a pre-c99 compiler.
71 # if __STDC_VERSION__ - 0 >= 199901L
72 # define _XOPEN_SOURCE 600
74 # define _XOPEN_SOURCE 500
76 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
77 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
78 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__)
79 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
80 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
85 #define _NETBSD_SOURCE 1
88 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
89 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
90 # define _WIN32_WINNT 0x0502
92 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
95 #define GIT_WINDOWS_NATIVE
100 #include <sys/stat.h>
106 #ifdef HAVE_STRINGS_H
107 #include <strings.h> /* for strcasecmp() */
111 #ifdef NEEDS_SYS_PARAM_H
112 #include <sys/param.h>
114 #include <sys/types.h>
116 #include <sys/time.h>
123 #ifndef NO_SYS_POLL_H
124 #include <sys/poll.h>
129 #if defined(__MINGW32__)
130 /* pull in Windows compatibility stuff */
131 #include "compat/mingw.h"
132 #include "compat/win32/fscache.h"
133 #elif defined(_MSC_VER)
134 #include "compat/msvc.h"
135 #include "compat/win32/fscache.h"
137 #include <sys/wait.h>
138 #include <sys/resource.h>
139 #include <sys/socket.h>
140 #include <sys/ioctl.h>
142 #ifndef NO_SYS_SELECT_H
143 #include <sys/select.h>
145 #include <netinet/in.h>
146 #include <netinet/tcp.h>
147 #include <arpa/inet.h>
151 #ifndef NO_INTTYPES_H
152 #include <inttypes.h>
158 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
159 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
160 * while on IP16 and IP16L32 it is "int" (resp. "short")
161 * Size needs to match (or exceed) 'sizeof(void *)'.
162 * We can't take "long long" here as not everybody has it.
164 typedef long intptr_t;
165 typedef unsigned long uintptr_t;
167 #if defined(__CYGWIN__)
170 #define _XOPEN_SOURCE 600
172 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
174 #define _ALL_SOURCE 1
178 /* used on Mac OS X */
179 #ifdef PRECOMPOSE_UNICODE
180 #include "compat/precompose_utf8.h"
182 #define precompose_str(in,i_nfd2nfc)
183 #define precompose_argv(c,v)
184 #define probe_utf8_pathname_composition(a,b)
187 #ifdef MKDIR_WO_TRAILING_SLASH
188 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
189 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
192 #ifdef NO_STRUCT_ITIMERVAL
194 struct timeval it_interval
;
195 struct timeval it_value
;
200 #define setitimer(which,value,ovalue)
206 #define basename gitbasename
207 extern char *gitbasename(char *);
215 #include <openssl/ssl.h>
216 #include <openssl/err.h>
219 /* On most systems <netdb.h> would have given us this, but
220 * not on some systems (e.g. z/OS).
223 #define NI_MAXHOST 1025
227 #define NI_MAXSERV 32
230 /* On most systems <limits.h> would have given us this, but
231 * not on some systems (e.g. GNU/Hurd).
234 #define PATH_MAX 4096
238 #define PRIuMAX "llu"
260 #ifndef _PATH_DEFPATH
261 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
264 #ifndef STRIP_EXTENSION
265 #define STRIP_EXTENSION ""
268 #ifndef has_dos_drive_prefix
269 #define has_dos_drive_prefix(path) 0
273 #define is_dir_sep(c) ((c) == '/')
276 #ifndef find_last_dir_sep
277 #define find_last_dir_sep(path) strrchr(path, '/')
280 #if defined(__HP_cc) && (__HP_cc >= 61000)
281 #define NORETURN __attribute__((noreturn))
283 #elif defined(__GNUC__) && !defined(NO_NORETURN)
284 #define NORETURN __attribute__((__noreturn__))
285 #define NORETURN_PTR __attribute__((__noreturn__))
286 #elif defined(_MSC_VER)
287 #define NORETURN __declspec(noreturn)
292 #ifndef __attribute__
293 #define __attribute__(x)
297 /* The sentinel attribute is valid from gcc version 4.0 */
298 #if defined(__GNUC__) && (__GNUC__ >= 4)
299 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
301 #define LAST_ARG_MUST_BE_NULL
304 #include "compat/bswap.h"
306 #include "wildmatch.h"
308 /* General helper functions */
309 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
310 extern void vwritef(int fd
, const char *prefix
, const char *err
, va_list params
);
311 extern NORETURN
void usage(const char *err
);
312 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
313 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
314 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
315 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
316 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
319 #ifdef APPLE_COMMON_CRYPTO
320 #include "compat/apple-common-crypto.h"
322 #include <openssl/evp.h>
323 #include <openssl/hmac.h>
324 #endif /* APPLE_COMMON_CRYPTO */
325 #include <openssl/x509v3.h>
326 #endif /* NO_OPENSSL */
329 * Let callers be aware of the constant return value; this can help
330 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
331 * because some compilers may not support variadic macros. Since we're only
332 * trying to help gcc, anyway, it's OK; other compilers will fall back to
333 * using the function as usual.
335 #if defined(__GNUC__) && ! defined(__clang__)
336 #define error(...) (error(__VA_ARGS__), -1)
339 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
340 extern void set_error_routine(void (*routine
)(const char *err
, va_list params
));
341 extern void set_die_is_recursing_routine(int (*routine
)(void));
343 extern int starts_with(const char *str
, const char *prefix
);
344 extern int ends_with(const char *str
, const char *suffix
);
346 static inline const char *skip_prefix(const char *str
, const char *prefix
)
351 } while (*str
++ == *prefix
++);
355 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
360 #define MAP_PRIVATE 1
363 #define mmap git_mmap
364 #define munmap git_munmap
365 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
366 extern int git_munmap(void *start
, size_t length
);
368 #else /* NO_MMAP || USE_WIN32_MMAP */
370 #include <sys/mman.h>
372 #endif /* NO_MMAP || USE_WIN32_MMAP */
376 /* This value must be multiple of (pagesize * 2) */
377 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
381 /* This value must be multiple of (pagesize * 2) */
382 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
383 (sizeof(void*) >= 8 \
384 ? 1 * 1024 * 1024 * 1024 \
390 #define MAP_FAILED ((void *)-1)
393 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
394 #define on_disk_bytes(st) ((st).st_size)
396 #define on_disk_bytes(st) ((st).st_blocks * 512)
399 #define DEFAULT_PACKED_GIT_LIMIT \
400 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
403 #define pread git_pread
404 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
407 * Forward decl that will remind us if its twin in cache.h changes.
408 * This function is used in compat/pread.c. But we can't include
411 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
414 #define setenv gitsetenv
415 extern int gitsetenv(const char *, const char *, int);
419 #define mkdtemp gitmkdtemp
420 extern char *gitmkdtemp(char *);
424 #define mkstemps gitmkstemps
425 extern int gitmkstemps(char *, int);
429 #define unsetenv gitunsetenv
430 extern void gitunsetenv(const char *);
434 #define strcasestr gitstrcasestr
435 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
439 #define strlcpy gitstrlcpy
440 extern size_t gitstrlcpy(char *, const char *, size_t);
444 #define strtoumax gitstrtoumax
445 extern uintmax_t gitstrtoumax(const char *, char **, int);
446 #define strtoimax gitstrtoimax
447 extern intmax_t gitstrtoimax(const char *, char **, int);
451 #define hstrerror githstrerror
452 extern const char *githstrerror(int herror
);
456 #define memmem gitmemmem
457 void *gitmemmem(const void *haystack
, size_t haystacklen
,
458 const void *needle
, size_t needlelen
);
461 #ifdef NO_GETPAGESIZE
462 #define getpagesize() sysconf(_SC_PAGESIZE)
465 #ifdef FREAD_READS_DIRECTORIES
469 #define fopen(a,b) git_fopen(a,b)
470 extern FILE *git_fopen(const char*, const char*);
473 #ifdef SNPRINTF_RETURNS_BOGUS
477 #define snprintf git_snprintf
478 extern int git_snprintf(char *str
, size_t maxsize
,
479 const char *format
, ...);
483 #define vsnprintf git_vsnprintf
484 extern int git_vsnprintf(char *str
, size_t maxsize
,
485 const char *format
, va_list ap
);
488 #ifdef __GLIBC_PREREQ
489 #if __GLIBC_PREREQ(2, 1)
490 #define HAVE_STRCHRNUL
495 #ifndef HAVE_STRCHRNUL
496 #define strchrnul gitstrchrnul
497 static inline char *gitstrchrnul(const char *s
, int c
)
499 while (*s
&& *s
!= c
)
506 #define mempcpy gitmempcpy
507 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
509 return (char *)memcpy(dest
, src
, n
) + n
;
514 int inet_pton(int af
, const char *src
, void *dst
);
518 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
521 extern void release_pack_memory(size_t);
523 typedef void (*try_to_free_t
)(size_t);
524 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
526 extern char *xstrdup(const char *str
);
527 extern void *xmalloc(size_t size
);
528 extern void *xmallocz(size_t size
);
529 extern void *xmemdupz(const void *data
, size_t len
);
530 extern char *xstrndup(const char *str
, size_t len
);
531 extern void *xrealloc(void *ptr
, size_t size
);
532 extern void *xcalloc(size_t nmemb
, size_t size
);
533 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
534 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
535 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
536 extern int xdup(int fd
);
537 extern FILE *xfdopen(int fd
, const char *mode
);
538 extern int xmkstemp(char *template);
539 extern int xmkstemp_mode(char *template, int mode
);
540 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
541 extern int odb_pack_keep(char *name
, size_t namesz
, const unsigned char *sha1
);
543 static inline size_t xsize_t(off_t len
)
545 if (len
> (size_t) len
)
546 die("Cannot handle files this big");
550 static inline int has_extension(const char *filename
, const char *ext
)
552 size_t len
= strlen(filename
);
553 size_t extlen
= strlen(ext
);
554 return len
> extlen
&& !memcmp(filename
+ len
- extlen
, ext
, extlen
);
557 /* in ctype.c, for kwset users */
558 extern const char tolower_trans_tbl
[256];
560 /* Sane ctype - no locale, and works with signed chars */
575 extern const unsigned char sane_ctype
[256];
576 #define GIT_SPACE 0x01
577 #define GIT_DIGIT 0x02
578 #define GIT_ALPHA 0x04
579 #define GIT_GLOB_SPECIAL 0x08
580 #define GIT_REGEX_SPECIAL 0x10
581 #define GIT_PATHSPEC_MAGIC 0x20
582 #define GIT_CNTRL 0x40
583 #define GIT_PUNCT 0x80
584 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
585 #define isascii(x) (((x) & ~0x7f) == 0)
586 #define isspace(x) sane_istest(x,GIT_SPACE)
587 #define isdigit(x) sane_istest(x,GIT_DIGIT)
588 #define isalpha(x) sane_istest(x,GIT_ALPHA)
589 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
590 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
591 #define islower(x) sane_iscase(x, 1)
592 #define isupper(x) sane_iscase(x, 0)
593 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
594 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
595 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
596 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
597 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
598 #define isxdigit(x) (hexval_table[x] != -1)
599 #define tolower(x) sane_case((unsigned char)(x), 0x20)
600 #define toupper(x) sane_case((unsigned char)(x), 0)
601 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
603 static inline int sane_case(int x
, int high
)
605 if (sane_istest(x
, GIT_ALPHA
))
606 x
= (x
& ~0x20) | high
;
610 static inline int sane_iscase(int x
, int is_lower
)
612 if (!sane_istest(x
, GIT_ALPHA
))
616 return (x
& 0x20) != 0;
618 return (x
& 0x20) == 0;
621 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
627 ul
= strtoul(s
, &p
, base
);
628 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
634 static inline int strtol_i(char const *s
, int base
, int *result
)
640 ul
= strtol(s
, &p
, base
);
641 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
647 #ifdef INTERNAL_QSORT
648 void git_qsort(void *base
, size_t nmemb
, size_t size
,
649 int(*compar
)(const void *, const void *));
650 #define qsort git_qsort
653 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
654 # define FORCE_DIR_SET_GID S_ISGID
656 # define FORCE_DIR_SET_GID 0
661 #define ST_CTIME_NSEC(st) 0
662 #define ST_MTIME_NSEC(st) 0
664 #ifdef USE_ST_TIMESPEC
665 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
666 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
668 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
669 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
673 #ifdef UNRELIABLE_FSTAT
674 #define fstat_is_reliable() 0
676 #define fstat_is_reliable() 1
681 * Since an obvious implementation of va_list would be to make it a
682 * pointer into the stack frame, a simple assignment will work on
683 * many systems. But let's try to be more portable.
686 #define va_copy(dst, src) __va_copy(dst, src)
688 #define va_copy(dst, src) ((dst) = (src))
693 * Preserves errno, prints a message, but gives no warning for ENOENT.
694 * Always returns the return value of unlink(2).
696 int unlink_or_warn(const char *path
);
698 * Likewise for rmdir(2).
700 int rmdir_or_warn(const char *path
);
702 * Calls the correct function out of {unlink,rmdir}_or_warn based on
703 * the supplied file mode.
705 int remove_or_warn(unsigned int mode
, const char *path
);
708 * Call access(2), but warn for any error except "missing file"
709 * (ENOENT or ENOTDIR).
711 #define ACCESS_EACCES_OK (1U << 0)
712 int access_or_warn(const char *path
, int mode
, unsigned flag
);
713 int access_or_die(const char *path
, int mode
, unsigned flag
);
715 /* Warn on an inaccessible file that ought to be accessible */
716 void warn_on_inaccessible(const char *path
);
718 /* Get the passwd entry for the UID of the current process. */
719 struct passwd
*xgetpwuid_self(void);
721 #ifdef GMTIME_UNRELIABLE_ERRORS
722 struct tm
*git_gmtime(const time_t *);
723 struct tm
*git_gmtime_r(const time_t *, struct tm
*);
724 #define gmtime git_gmtime
725 #define gmtime_r git_gmtime_r
728 #ifndef mark_as_git_dir
729 #define mark_as_git_dir(x) /* noop */
732 #ifndef get_home_directory
733 #define get_home_directory() getenv("HOME")
737 * Enable/disable a read-only cache for file system data on platforms that
740 * Implementing a live-cache is complicated and requires special platform
741 * support (inotify, ReadDirectoryChangesW...). enable_fscache shall be used
742 * to mark sections of git code that extensively read from the file system
743 * without modifying anything. Implementations can use this to cache e.g. stat
744 * data or even file content without the need to synchronize with the file
747 #ifndef enable_fscache
748 #define enable_fscache(x) /* noop */