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 /* default is not to pass type - mingw needs this */
89 #define symlink_with_type(a,b,c) symlink((a),(b))
91 /* Used for 'Target Type' Parameter for symlink_with_type */
92 enum git_target_type
{
98 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
99 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
100 # define _WIN32_WINNT 0x0502
102 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
103 #include <winsock2.h>
105 #define GIT_WINDOWS_NATIVE
110 #include <sys/stat.h>
116 #ifdef HAVE_STRINGS_H
117 #include <strings.h> /* for strcasecmp() */
121 #ifdef NEEDS_SYS_PARAM_H
122 #include <sys/param.h>
124 #include <sys/types.h>
126 #include <sys/time.h>
133 #ifndef NO_SYS_POLL_H
134 #include <sys/poll.h>
139 #if defined(__MINGW32__)
140 /* pull in Windows compatibility stuff */
141 #include "compat/mingw.h"
142 #include "compat/win32/fscache.h"
143 #elif defined(_MSC_VER)
144 #include "compat/msvc.h"
145 #include "compat/win32/fscache.h"
147 #include <sys/wait.h>
148 #include <sys/resource.h>
149 #include <sys/socket.h>
150 #include <sys/ioctl.h>
152 #ifndef NO_SYS_SELECT_H
153 #include <sys/select.h>
155 #include <netinet/in.h>
156 #include <netinet/tcp.h>
157 #include <arpa/inet.h>
161 #ifndef NO_INTTYPES_H
162 #include <inttypes.h>
168 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
169 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
170 * while on IP16 and IP16L32 it is "int" (resp. "short")
171 * Size needs to match (or exceed) 'sizeof(void *)'.
172 * We can't take "long long" here as not everybody has it.
174 typedef long intptr_t;
175 typedef unsigned long uintptr_t;
177 #if defined(__CYGWIN__)
180 #define _XOPEN_SOURCE 600
182 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
184 #define _ALL_SOURCE 1
188 /* used on Mac OS X */
189 #ifdef PRECOMPOSE_UNICODE
190 #include "compat/precompose_utf8.h"
192 #define precompose_str(in,i_nfd2nfc)
193 #define precompose_argv(c,v)
194 #define probe_utf8_pathname_composition(a,b)
197 #ifdef MKDIR_WO_TRAILING_SLASH
198 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
199 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
202 #ifdef NO_STRUCT_ITIMERVAL
204 struct timeval it_interval
;
205 struct timeval it_value
;
210 #define setitimer(which,value,ovalue)
216 #define basename gitbasename
217 extern char *gitbasename(char *);
225 #include <openssl/ssl.h>
226 #include <openssl/err.h>
229 /* On most systems <netdb.h> would have given us this, but
230 * not on some systems (e.g. z/OS).
233 #define NI_MAXHOST 1025
237 #define NI_MAXSERV 32
240 /* On most systems <limits.h> would have given us this, but
241 * not on some systems (e.g. GNU/Hurd).
244 #define PATH_MAX 4096
248 #define PRIuMAX "llu"
270 #ifndef _PATH_DEFPATH
271 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
274 #ifndef STRIP_EXTENSION
275 #define STRIP_EXTENSION ""
278 #ifndef has_dos_drive_prefix
279 #define has_dos_drive_prefix(path) 0
282 #ifndef offset_1st_component
283 #define offset_1st_component(path) (is_dir_sep((path)[0]))
287 #define is_dir_sep(c) ((c) == '/')
290 #ifndef find_last_dir_sep
291 #define find_last_dir_sep(path) strrchr(path, '/')
294 #if defined(__HP_cc) && (__HP_cc >= 61000)
295 #define NORETURN __attribute__((noreturn))
297 #elif defined(__GNUC__) && !defined(NO_NORETURN)
298 #define NORETURN __attribute__((__noreturn__))
299 #define NORETURN_PTR __attribute__((__noreturn__))
300 #elif defined(_MSC_VER)
301 #define NORETURN __declspec(noreturn)
306 #ifndef __attribute__
307 #define __attribute__(x)
311 /* The sentinel attribute is valid from gcc version 4.0 */
312 #if defined(__GNUC__) && (__GNUC__ >= 4)
313 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
315 #define LAST_ARG_MUST_BE_NULL
318 #include "compat/bswap.h"
320 #include "wildmatch.h"
322 /* General helper functions */
323 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
324 extern void vwritef(int fd
, const char *prefix
, const char *err
, va_list params
);
325 extern NORETURN
void usage(const char *err
);
326 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
327 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
328 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
329 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
330 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
333 #ifdef APPLE_COMMON_CRYPTO
334 #include "compat/apple-common-crypto.h"
336 #include <openssl/evp.h>
337 #include <openssl/hmac.h>
338 #endif /* APPLE_COMMON_CRYPTO */
339 #include <openssl/x509v3.h>
340 #endif /* NO_OPENSSL */
343 * Let callers be aware of the constant return value; this can help
344 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
345 * because some compilers may not support variadic macros. Since we're only
346 * trying to help gcc, anyway, it's OK; other compilers will fall back to
347 * using the function as usual.
349 #if defined(__GNUC__) && ! defined(__clang__)
350 #define error(...) (error(__VA_ARGS__), -1)
353 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
354 extern void set_error_routine(void (*routine
)(const char *err
, va_list params
));
355 extern void set_die_is_recursing_routine(int (*routine
)(void));
357 extern int starts_with(const char *str
, const char *prefix
);
358 extern int ends_with(const char *str
, const char *suffix
);
360 static inline const char *skip_prefix(const char *str
, const char *prefix
)
365 } while (*str
++ == *prefix
++);
369 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
374 #define MAP_PRIVATE 1
377 #define mmap git_mmap
378 #define munmap git_munmap
379 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
380 extern int git_munmap(void *start
, size_t length
);
382 #else /* NO_MMAP || USE_WIN32_MMAP */
384 #include <sys/mman.h>
386 #endif /* NO_MMAP || USE_WIN32_MMAP */
390 /* This value must be multiple of (pagesize * 2) */
391 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
395 /* This value must be multiple of (pagesize * 2) */
396 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
397 (sizeof(void*) >= 8 \
398 ? 1 * 1024 * 1024 * 1024 \
404 #define MAP_FAILED ((void *)-1)
407 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
408 #define on_disk_bytes(st) ((st).st_size)
410 #define on_disk_bytes(st) ((st).st_blocks * 512)
413 #define DEFAULT_PACKED_GIT_LIMIT \
414 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
417 #define pread git_pread
418 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
421 * Forward decl that will remind us if its twin in cache.h changes.
422 * This function is used in compat/pread.c. But we can't include
425 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
428 #define setenv gitsetenv
429 extern int gitsetenv(const char *, const char *, int);
433 #define mkdtemp gitmkdtemp
434 extern char *gitmkdtemp(char *);
438 #define mkstemps gitmkstemps
439 extern int gitmkstemps(char *, int);
443 #define unsetenv gitunsetenv
444 extern void gitunsetenv(const char *);
448 #define strcasestr gitstrcasestr
449 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
453 #define strlcpy gitstrlcpy
454 extern size_t gitstrlcpy(char *, const char *, size_t);
458 #define strtoumax gitstrtoumax
459 extern uintmax_t gitstrtoumax(const char *, char **, int);
460 #define strtoimax gitstrtoimax
461 extern intmax_t gitstrtoimax(const char *, char **, int);
465 #define hstrerror githstrerror
466 extern const char *githstrerror(int herror
);
470 #define memmem gitmemmem
471 void *gitmemmem(const void *haystack
, size_t haystacklen
,
472 const void *needle
, size_t needlelen
);
475 #ifdef NO_GETPAGESIZE
476 #define getpagesize() sysconf(_SC_PAGESIZE)
479 #ifdef FREAD_READS_DIRECTORIES
483 #define fopen(a,b) git_fopen(a,b)
484 extern FILE *git_fopen(const char*, const char*);
487 #ifdef SNPRINTF_RETURNS_BOGUS
491 #define snprintf git_snprintf
492 extern int git_snprintf(char *str
, size_t maxsize
,
493 const char *format
, ...);
497 #define vsnprintf git_vsnprintf
498 extern int git_vsnprintf(char *str
, size_t maxsize
,
499 const char *format
, va_list ap
);
502 #ifdef __GLIBC_PREREQ
503 #if __GLIBC_PREREQ(2, 1)
504 #define HAVE_STRCHRNUL
509 #ifndef HAVE_STRCHRNUL
510 #define strchrnul gitstrchrnul
511 static inline char *gitstrchrnul(const char *s
, int c
)
513 while (*s
&& *s
!= c
)
520 #define mempcpy gitmempcpy
521 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
523 return (char *)memcpy(dest
, src
, n
) + n
;
528 int inet_pton(int af
, const char *src
, void *dst
);
532 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
535 extern void release_pack_memory(size_t);
537 typedef void (*try_to_free_t
)(size_t);
538 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
540 extern char *xstrdup(const char *str
);
541 extern void *xmalloc(size_t size
);
542 extern void *xmallocz(size_t size
);
543 extern void *xmemdupz(const void *data
, size_t len
);
544 extern char *xstrndup(const char *str
, size_t len
);
545 extern void *xrealloc(void *ptr
, size_t size
);
546 extern void *xcalloc(size_t nmemb
, size_t size
);
547 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
548 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
549 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
550 extern int xdup(int fd
);
551 extern FILE *xfdopen(int fd
, const char *mode
);
552 extern int xmkstemp(char *template);
553 extern int xmkstemp_mode(char *template, int mode
);
554 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
555 extern int odb_pack_keep(char *name
, size_t namesz
, const unsigned char *sha1
);
557 static inline size_t xsize_t(off_t len
)
559 if (len
> (size_t) len
)
560 die("Cannot handle files this big");
564 static inline int has_extension(const char *filename
, const char *ext
)
566 size_t len
= strlen(filename
);
567 size_t extlen
= strlen(ext
);
568 return len
> extlen
&& !memcmp(filename
+ len
- extlen
, ext
, extlen
);
571 /* in ctype.c, for kwset users */
572 extern const char tolower_trans_tbl
[256];
574 /* Sane ctype - no locale, and works with signed chars */
589 extern const unsigned char sane_ctype
[256];
590 #define GIT_SPACE 0x01
591 #define GIT_DIGIT 0x02
592 #define GIT_ALPHA 0x04
593 #define GIT_GLOB_SPECIAL 0x08
594 #define GIT_REGEX_SPECIAL 0x10
595 #define GIT_PATHSPEC_MAGIC 0x20
596 #define GIT_CNTRL 0x40
597 #define GIT_PUNCT 0x80
598 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
599 #define isascii(x) (((x) & ~0x7f) == 0)
600 #define isspace(x) sane_istest(x,GIT_SPACE)
601 #define isdigit(x) sane_istest(x,GIT_DIGIT)
602 #define isalpha(x) sane_istest(x,GIT_ALPHA)
603 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
604 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
605 #define islower(x) sane_iscase(x, 1)
606 #define isupper(x) sane_iscase(x, 0)
607 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
608 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
609 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
610 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
611 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
612 #define isxdigit(x) (hexval_table[x] != -1)
613 #define tolower(x) sane_case((unsigned char)(x), 0x20)
614 #define toupper(x) sane_case((unsigned char)(x), 0)
615 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
617 static inline int sane_case(int x
, int high
)
619 if (sane_istest(x
, GIT_ALPHA
))
620 x
= (x
& ~0x20) | high
;
624 static inline int sane_iscase(int x
, int is_lower
)
626 if (!sane_istest(x
, GIT_ALPHA
))
630 return (x
& 0x20) != 0;
632 return (x
& 0x20) == 0;
635 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
641 ul
= strtoul(s
, &p
, base
);
642 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
648 static inline int strtol_i(char const *s
, int base
, int *result
)
654 ul
= strtol(s
, &p
, base
);
655 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
661 #ifdef INTERNAL_QSORT
662 void git_qsort(void *base
, size_t nmemb
, size_t size
,
663 int(*compar
)(const void *, const void *));
664 #define qsort git_qsort
667 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
668 # define FORCE_DIR_SET_GID S_ISGID
670 # define FORCE_DIR_SET_GID 0
675 #define ST_CTIME_NSEC(st) 0
676 #define ST_MTIME_NSEC(st) 0
678 #ifdef USE_ST_TIMESPEC
679 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
680 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
682 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
683 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
687 #ifdef UNRELIABLE_FSTAT
688 #define fstat_is_reliable() 0
690 #define fstat_is_reliable() 1
695 * Since an obvious implementation of va_list would be to make it a
696 * pointer into the stack frame, a simple assignment will work on
697 * many systems. But let's try to be more portable.
700 #define va_copy(dst, src) __va_copy(dst, src)
702 #define va_copy(dst, src) ((dst) = (src))
707 * Preserves errno, prints a message, but gives no warning for ENOENT.
708 * Always returns the return value of unlink(2).
710 int unlink_or_warn(const char *path
);
712 * Likewise for rmdir(2).
714 int rmdir_or_warn(const char *path
);
716 * Calls the correct function out of {unlink,rmdir}_or_warn based on
717 * the supplied file mode.
719 int remove_or_warn(unsigned int mode
, const char *path
);
722 * Call access(2), but warn for any error except "missing file"
723 * (ENOENT or ENOTDIR).
725 #define ACCESS_EACCES_OK (1U << 0)
726 int access_or_warn(const char *path
, int mode
, unsigned flag
);
727 int access_or_die(const char *path
, int mode
, unsigned flag
);
729 /* Warn on an inaccessible file that ought to be accessible */
730 void warn_on_inaccessible(const char *path
);
732 /* Get the passwd entry for the UID of the current process. */
733 struct passwd
*xgetpwuid_self(void);
735 #ifdef GMTIME_UNRELIABLE_ERRORS
736 struct tm
*git_gmtime(const time_t *);
737 struct tm
*git_gmtime_r(const time_t *, struct tm
*);
738 #define gmtime git_gmtime
739 #define gmtime_r git_gmtime_r
742 #ifndef mark_as_git_dir
743 #define mark_as_git_dir(x) /* noop */
746 #ifndef get_home_directory
747 #define get_home_directory() getenv("HOME")
751 * Enable/disable a read-only cache for file system data on platforms that
754 * Implementing a live-cache is complicated and requires special platform
755 * support (inotify, ReadDirectoryChangesW...). enable_fscache shall be used
756 * to mark sections of git code that extensively read from the file system
757 * without modifying anything. Implementations can use this to cache e.g. stat
758 * data or even file content without the need to synchronize with the file
761 #ifndef enable_fscache
762 #define enable_fscache(x) /* noop */