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__)
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 #ifdef WIN32 /* Both MinGW and MSVC */
89 # if defined (_MSC_VER)
90 # define _WIN32_WINNT 0x0502
92 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
105 #ifdef HAVE_STRINGS_H
106 #include <strings.h> /* for strcasecmp() */
110 #ifdef NEEDS_SYS_PARAM_H
111 #include <sys/param.h>
113 #include <sys/types.h>
115 #include <sys/time.h>
118 #ifndef USE_WILDMATCH
125 #ifndef NO_SYS_POLL_H
126 #include <sys/poll.h>
130 #if defined(__MINGW32__)
131 /* pull in Windows compatibility stuff */
132 #include "compat/mingw.h"
133 #elif defined(_MSC_VER)
134 #include "compat/msvc.h"
136 #include <sys/wait.h>
137 #include <sys/resource.h>
138 #include <sys/socket.h>
139 #include <sys/ioctl.h>
141 #ifndef NO_SYS_SELECT_H
142 #include <sys/select.h>
144 #include <netinet/in.h>
145 #include <netinet/tcp.h>
146 #include <arpa/inet.h>
150 #ifndef NO_INTTYPES_H
151 #include <inttypes.h>
157 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
158 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
159 * while on IP16 and IP16L32 it is "int" (resp. "short")
160 * Size needs to match (or exceed) 'sizeof(void *)'.
161 * We can't take "long long" here as not everybody has it.
163 typedef long intptr_t;
164 typedef unsigned long uintptr_t;
166 int get_st_mode_bits(const char *path, int *mode);
167 #if defined(__CYGWIN__)
170 #define _XOPEN_SOURCE 600
171 #include "compat/cygwin.h"
173 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
175 #define _ALL_SOURCE 1
179 /* used on Mac OS X */
180 #ifdef PRECOMPOSE_UNICODE
181 #include "compat/precompose_utf8.h"
183 #define precompose_str(in,i_nfd2nfc)
184 #define precompose_argv(c,v)
185 #define probe_utf8_pathname_composition(a,b)
188 #ifdef NEEDS_CLIPPED_WRITE
189 ssize_t clipped_write(int fildes, const void *buf, size_t nbyte);
190 #define write(x,y,z) clipped_write((x),(y),(z))
193 #ifdef MKDIR_WO_TRAILING_SLASH
194 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
195 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
198 #ifdef NO_STRUCT_ITIMERVAL
200 struct timeval it_interval;
201 struct timeval it_value;
206 #define setitimer(which,value,ovalue)
212 #define basename gitbasename
213 extern char *gitbasename(char *);
221 #include <openssl/ssl.h>
222 #include <openssl/err.h>
225 /* On most systems <netdb.h> would have given us this, but
226 * not on some systems (e.g. z/OS).
229 #define NI_MAXHOST 1025
233 #define NI_MAXSERV 32
236 /* On most systems <limits.h> would have given us this, but
237 * not on some systems (e.g. GNU/Hurd).
240 #define PATH_MAX 4096
244 #define PRIuMAX "llu"
266 #ifndef _PATH_DEFPATH
267 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
270 #ifndef STRIP_EXTENSION
271 #define STRIP_EXTENSION ""
274 #ifndef has_dos_drive_prefix
275 #define has_dos_drive_prefix(path) 0
279 #define is_dir_sep(c) ((c) == '/')
282 #ifndef find_last_dir_sep
283 #define find_last_dir_sep(path) strrchr(path, '/')
286 #if defined(__HP_cc) && (__HP_cc >= 61000)
287 #define NORETURN __attribute__((noreturn))
289 #elif defined(__GNUC__) && !defined(NO_NORETURN)
290 #define NORETURN __attribute__((__noreturn__))
291 #define NORETURN_PTR __attribute__((__noreturn__))
292 #elif defined(_MSC_VER)
293 #define NORETURN __declspec(noreturn)
298 #ifndef __attribute__
299 #define __attribute__(x)
303 #include "compat/bswap.h"
306 #include "wildmatch.h"
307 #define FNM_PATHNAME WM_PATHNAME
308 #define FNM_CASEFOLD WM_CASEFOLD
309 #define FNM_NOMATCH WM_NOMATCH
310 static inline int fnmatch(const char *pattern, const char *string, int flags)
312 return wildmatch(pattern, string, flags, NULL);
316 /* General helper functions */
317 extern void vreportf(const char *prefix, const char *err, va_list params);
318 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
319 extern NORETURN void usage(const char *err);
320 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
321 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
322 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
323 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
324 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
327 * Let callers be aware of the constant return value; this can help
328 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
329 * because some compilers may not support variadic macros. Since we're only
330 * trying to help gcc, anyway, it's OK; other compilers will fall back to
331 * using the function as usual.
333 #if defined(__GNUC__) && ! defined(__clang__)
334 #define error(...) (error(__VA_ARGS__), -1)
337 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
338 extern void set_error_routine(void (*routine)(const char *err, va_list params));
339 extern void set_die_is_recursing_routine(int (*routine)(void));
341 extern int prefixcmp(const char *str, const char *prefix);
342 extern int suffixcmp(const char *str, const char *suffix);
344 static inline const char *skip_prefix(const char *str, const char *prefix)
346 size_t len = strlen(prefix);
347 return strncmp(str, prefix, len) ? NULL : str + len;
350 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
355 #define MAP_PRIVATE 1
358 #define mmap git_mmap
359 #define munmap git_munmap
360 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
361 extern int git_munmap(void *start, size_t length);
363 #else /* NO_MMAP || USE_WIN32_MMAP */
365 #include <sys/mman.h>
367 #endif /* NO_MMAP || USE_WIN32_MMAP */
371 /* This value must be multiple of (pagesize * 2) */
372 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
376 /* This value must be multiple of (pagesize * 2) */
377 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
378 (sizeof(void*) >= 8 \
379 ? 1 * 1024 * 1024 * 1024 \
385 #define MAP_FAILED ((void *)-1)
388 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
389 #define on_disk_bytes(st) ((st).st_size)
391 #define on_disk_bytes(st) ((st).st_blocks * 512)
394 #define DEFAULT_PACKED_GIT_LIMIT \
395 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
398 #define pread git_pread
399 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
402 * Forward decl that will remind us if its twin in cache.h changes.
403 * This function is used in compat/pread.c. But we can't include
406 extern ssize_t read_in_full(int fd, void *buf, size_t count);
409 #define setenv gitsetenv
410 extern int gitsetenv(const char *, const char *, int);
414 #define mkdtemp gitmkdtemp
415 extern char *gitmkdtemp(char *);
419 #define mkstemps gitmkstemps
420 extern int gitmkstemps(char *, int);
424 #define unsetenv gitunsetenv
425 extern void gitunsetenv(const char *);
429 #define strcasestr gitstrcasestr
430 extern char *gitstrcasestr(const char *haystack, const char *needle);
434 #define strlcpy gitstrlcpy
435 extern size_t gitstrlcpy(char *, const char *, size_t);
439 #define strtoumax gitstrtoumax
440 extern uintmax_t gitstrtoumax(const char *, char **, int);
441 #define strtoimax gitstrtoimax
442 extern intmax_t gitstrtoimax(const char *, char **, int);
446 #define hstrerror githstrerror
447 extern const char *githstrerror(int herror);
451 #define memmem gitmemmem
452 void *gitmemmem(const void *haystack, size_t haystacklen,
453 const void *needle, size_t needlelen);
456 #ifdef NO_GETPAGESIZE
457 #define getpagesize() sysconf(_SC_PAGESIZE)
460 #ifdef FREAD_READS_DIRECTORIES
464 #define fopen(a,b) git_fopen(a,b)
465 extern FILE *git_fopen(const char*, const char*);
468 #ifdef SNPRINTF_RETURNS_BOGUS
469 #define snprintf git_snprintf
470 extern int git_snprintf(char *str, size_t maxsize,
471 const char *format, ...);
472 #define vsnprintf git_vsnprintf
473 extern int git_vsnprintf(char *str, size_t maxsize,
474 const char *format, va_list ap);
477 #ifdef __GLIBC_PREREQ
478 #if __GLIBC_PREREQ(2, 1)
479 #define HAVE_STRCHRNUL
484 #ifndef HAVE_STRCHRNUL
485 #define strchrnul gitstrchrnul
486 static inline char *gitstrchrnul(const char *s, int c)
488 while (*s && *s != c)
495 #define mempcpy gitmempcpy
496 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
498 return (char *)memcpy(dest, src, n) + n;
503 int inet_pton(int af, const char *src, void *dst);
507 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
510 extern void release_pack_memory(size_t, int);
512 typedef void (*try_to_free_t)(size_t);
513 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
515 extern char *xstrdup(const char *str);
516 extern void *xmalloc(size_t size);
517 extern void *xmallocz(size_t size);
518 extern void *xmemdupz(const void *data, size_t len);
519 extern char *xstrndup(const char *str, size_t len);
520 extern void *xrealloc(void *ptr, size_t size);
521 extern void *xcalloc(size_t nmemb, size_t size);
522 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
523 extern ssize_t xread(int fd, void *buf, size_t len);
524 extern ssize_t xwrite(int fd, const void *buf, size_t len);
525 extern int xdup(int fd);
526 extern FILE *xfdopen(int fd, const char *mode);
527 extern int xmkstemp(char *template);
528 extern int xmkstemp_mode(char *template, int mode);
529 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
530 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
532 static inline size_t xsize_t(off_t len)
534 if (len > (size_t) len)
535 die("Cannot handle files this big");
539 static inline int has_extension(const char *filename, const char *ext)
541 size_t len = strlen(filename);
542 size_t extlen = strlen(ext);
543 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
546 /* in ctype.c, for kwset users */
547 extern const char tolower_trans_tbl[256];
549 /* Sane ctype - no locale, and works with signed chars */
564 extern const unsigned char sane_ctype[256];
565 #define GIT_SPACE 0x01
566 #define GIT_DIGIT 0x02
567 #define GIT_ALPHA 0x04
568 #define GIT_GLOB_SPECIAL 0x08
569 #define GIT_REGEX_SPECIAL 0x10
570 #define GIT_PATHSPEC_MAGIC 0x20
571 #define GIT_CNTRL 0x40
572 #define GIT_PUNCT 0x80
573 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
574 #define isascii(x) (((x) & ~0x7f) == 0)
575 #define isspace(x) sane_istest(x,GIT_SPACE)
576 #define isdigit(x) sane_istest(x,GIT_DIGIT)
577 #define isalpha(x) sane_istest(x,GIT_ALPHA)
578 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
579 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
580 #define islower(x) sane_iscase(x, 1)
581 #define isupper(x) sane_iscase(x, 0)
582 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
583 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
584 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
585 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
586 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
587 #define isxdigit(x) (hexval_table[x] != -1)
588 #define tolower(x) sane_case((unsigned char)(x), 0x20)
589 #define toupper(x) sane_case((unsigned char)(x), 0)
590 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
592 static inline int sane_case(int x, int high)
594 if (sane_istest(x, GIT_ALPHA))
595 x = (x & ~0x20) | high;
599 static inline int sane_iscase(int x, int is_lower)
601 if (!sane_istest(x, GIT_ALPHA))
605 return (x & 0x20) != 0;
607 return (x & 0x20) == 0;
610 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
616 ul = strtoul(s, &p, base);
617 if (errno || *p || p == s || (unsigned int) ul != ul)
623 static inline int strtol_i(char const *s, int base, int *result)
629 ul = strtol(s, &p, base);
630 if (errno || *p || p == s || (int) ul != ul)
636 #ifdef INTERNAL_QSORT
637 void git_qsort(void *base, size_t nmemb, size_t size,
638 int(*compar)(const void *, const void *));
639 #define qsort git_qsort
642 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
643 # define FORCE_DIR_SET_GID S_ISGID
645 # define FORCE_DIR_SET_GID 0
650 #define ST_CTIME_NSEC(st) 0
651 #define ST_MTIME_NSEC(st) 0
653 #ifdef USE_ST_TIMESPEC
654 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
655 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
657 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
658 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
662 #ifdef UNRELIABLE_FSTAT
663 #define fstat_is_reliable() 0
665 #define fstat_is_reliable() 1
670 * Since an obvious implementation of va_list would be to make it a
671 * pointer into the stack frame, a simple assignment will work on
672 * many systems. But let's try to be more portable.
675 #define va_copy(dst, src) __va_copy(dst, src)
677 #define va_copy(dst, src) ((dst) = (src))
682 * Preserves errno, prints a message, but gives no warning for ENOENT.
683 * Always returns the return value of unlink(2).
685 int unlink_or_warn(const char *path);
687 * Likewise for rmdir(2).
689 int rmdir_or_warn(const char *path);
691 * Calls the correct function out of {unlink,rmdir}_or_warn based on
692 * the supplied file mode.
694 int remove_or_warn(unsigned int mode, const char *path);
697 * Call access(2), but warn for any error except "missing file"
698 * (ENOENT or ENOTDIR).
700 #define ACCESS_EACCES_OK (1U << 0)
701 int access_or_warn(const char *path, int mode, unsigned flag);
702 int access_or_die(const char *path, int mode, unsigned flag);
704 /* Warn on an inaccessible file that ought to be accessible */
705 void warn_on_inaccessible(const char *path);
707 /* Get the passwd entry for the UID of the current process. */
708 struct passwd *xgetpwuid_self(void);