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 MKDIR_WO_TRAILING_SLASH
189 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
190 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
193 #ifdef NO_STRUCT_ITIMERVAL
195 struct timeval it_interval
;
196 struct timeval it_value
;
201 #define setitimer(which,value,ovalue)
207 #define basename gitbasename
208 extern char *gitbasename(char *);
216 #include <openssl/ssl.h>
217 #include <openssl/err.h>
220 /* On most systems <netdb.h> would have given us this, but
221 * not on some systems (e.g. z/OS).
224 #define NI_MAXHOST 1025
228 #define NI_MAXSERV 32
231 /* On most systems <limits.h> would have given us this, but
232 * not on some systems (e.g. GNU/Hurd).
235 #define PATH_MAX 4096
239 #define PRIuMAX "llu"
261 #ifndef _PATH_DEFPATH
262 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
265 #ifndef STRIP_EXTENSION
266 #define STRIP_EXTENSION ""
269 #ifndef has_dos_drive_prefix
270 #define has_dos_drive_prefix(path) 0
273 #ifndef offset_1st_component
274 #define offset_1st_component(path) (is_dir_sep((path)[0]))
278 #define is_dir_sep(c) ((c) == '/')
281 #ifndef find_last_dir_sep
282 #define find_last_dir_sep(path) strrchr(path, '/')
285 #if defined(__HP_cc) && (__HP_cc >= 61000)
286 #define NORETURN __attribute__((noreturn))
288 #elif defined(__GNUC__) && !defined(NO_NORETURN)
289 #define NORETURN __attribute__((__noreturn__))
290 #define NORETURN_PTR __attribute__((__noreturn__))
291 #elif defined(_MSC_VER)
292 #define NORETURN __declspec(noreturn)
297 #ifndef __attribute__
298 #define __attribute__(x)
302 #include "compat/bswap.h"
305 #include "wildmatch.h"
306 #define FNM_PATHNAME WM_PATHNAME
307 #define FNM_CASEFOLD WM_CASEFOLD
308 #define FNM_NOMATCH WM_NOMATCH
309 static inline int fnmatch(const char *pattern
, const char *string
, int flags
)
311 return wildmatch(pattern
, string
, flags
, NULL
);
315 /* General helper functions */
316 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
317 extern void vwritef(int fd
, const char *prefix
, const char *err
, va_list params
);
318 extern NORETURN
void usage(const char *err
);
319 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
320 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
321 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
322 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
323 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
326 * Let callers be aware of the constant return value; this can help
327 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
328 * because some compilers may not support variadic macros. Since we're only
329 * trying to help gcc, anyway, it's OK; other compilers will fall back to
330 * using the function as usual.
332 #if defined(__GNUC__) && ! defined(__clang__)
333 #define error(...) (error(__VA_ARGS__), -1)
336 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
337 extern void set_error_routine(void (*routine
)(const char *err
, va_list params
));
338 extern void set_die_is_recursing_routine(int (*routine
)(void));
340 extern int prefixcmp(const char *str
, const char *prefix
);
341 extern int suffixcmp(const char *str
, const char *suffix
);
343 static inline const char *skip_prefix(const char *str
, const char *prefix
)
345 size_t len
= strlen(prefix
);
346 return strncmp(str
, prefix
, len
) ? NULL
: str
+ len
;
349 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
354 #define MAP_PRIVATE 1
357 #define mmap git_mmap
358 #define munmap git_munmap
359 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
360 extern int git_munmap(void *start
, size_t length
);
362 #else /* NO_MMAP || USE_WIN32_MMAP */
364 #include <sys/mman.h>
366 #endif /* NO_MMAP || USE_WIN32_MMAP */
370 /* This value must be multiple of (pagesize * 2) */
371 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
375 /* This value must be multiple of (pagesize * 2) */
376 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
377 (sizeof(void*) >= 8 \
378 ? 1 * 1024 * 1024 * 1024 \
384 #define MAP_FAILED ((void *)-1)
387 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
388 #define on_disk_bytes(st) ((st).st_size)
390 #define on_disk_bytes(st) ((st).st_blocks * 512)
393 #define DEFAULT_PACKED_GIT_LIMIT \
394 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
397 #define pread git_pread
398 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
401 * Forward decl that will remind us if its twin in cache.h changes.
402 * This function is used in compat/pread.c. But we can't include
405 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
408 #define setenv gitsetenv
409 extern int gitsetenv(const char *, const char *, int);
413 #define mkdtemp gitmkdtemp
414 extern char *gitmkdtemp(char *);
418 #define mkstemps gitmkstemps
419 extern int gitmkstemps(char *, int);
423 #define unsetenv gitunsetenv
424 extern void gitunsetenv(const char *);
428 #define strcasestr gitstrcasestr
429 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
433 #define strlcpy gitstrlcpy
434 extern size_t gitstrlcpy(char *, const char *, size_t);
438 #define strtoumax gitstrtoumax
439 extern uintmax_t gitstrtoumax(const char *, char **, int);
440 #define strtoimax gitstrtoimax
441 extern intmax_t gitstrtoimax(const char *, char **, int);
445 #define hstrerror githstrerror
446 extern const char *githstrerror(int herror
);
450 #define memmem gitmemmem
451 void *gitmemmem(const void *haystack
, size_t haystacklen
,
452 const void *needle
, size_t needlelen
);
455 #ifdef NO_GETPAGESIZE
456 #define getpagesize() sysconf(_SC_PAGESIZE)
459 #ifdef FREAD_READS_DIRECTORIES
463 #define fopen(a,b) git_fopen(a,b)
464 extern FILE *git_fopen(const char*, const char*);
467 #ifdef SNPRINTF_RETURNS_BOGUS
468 #define snprintf git_snprintf
469 extern int git_snprintf(char *str
, size_t maxsize
,
470 const char *format
, ...);
471 #define vsnprintf git_vsnprintf
472 extern int git_vsnprintf(char *str
, size_t maxsize
,
473 const char *format
, va_list ap
);
476 #ifdef __GLIBC_PREREQ
477 #if __GLIBC_PREREQ(2, 1)
478 #define HAVE_STRCHRNUL
483 #ifndef HAVE_STRCHRNUL
484 #define strchrnul gitstrchrnul
485 static inline char *gitstrchrnul(const char *s
, int c
)
487 while (*s
&& *s
!= c
)
494 #define mempcpy gitmempcpy
495 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
497 return (char *)memcpy(dest
, src
, n
) + n
;
502 int inet_pton(int af
, const char *src
, void *dst
);
506 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
509 extern void release_pack_memory(size_t, int);
511 typedef void (*try_to_free_t
)(size_t);
512 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
514 extern char *xstrdup(const char *str
);
515 extern void *xmalloc(size_t size
);
516 extern void *xmallocz(size_t size
);
517 extern void *xmemdupz(const void *data
, size_t len
);
518 extern char *xstrndup(const char *str
, size_t len
);
519 extern void *xrealloc(void *ptr
, size_t size
);
520 extern void *xcalloc(size_t nmemb
, size_t size
);
521 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
522 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
523 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
524 extern int xdup(int fd
);
525 extern FILE *xfdopen(int fd
, const char *mode
);
526 extern int xmkstemp(char *template);
527 extern int xmkstemp_mode(char *template, int mode
);
528 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
529 extern int odb_pack_keep(char *name
, size_t namesz
, unsigned char *sha1
);
531 static inline size_t xsize_t(off_t len
)
533 if (len
> (size_t) len
)
534 die("Cannot handle files this big");
538 static inline int has_extension(const char *filename
, const char *ext
)
540 size_t len
= strlen(filename
);
541 size_t extlen
= strlen(ext
);
542 return len
> extlen
&& !memcmp(filename
+ len
- extlen
, ext
, extlen
);
545 /* in ctype.c, for kwset users */
546 extern const char tolower_trans_tbl
[256];
548 /* Sane ctype - no locale, and works with signed chars */
563 extern const unsigned char sane_ctype
[256];
564 #define GIT_SPACE 0x01
565 #define GIT_DIGIT 0x02
566 #define GIT_ALPHA 0x04
567 #define GIT_GLOB_SPECIAL 0x08
568 #define GIT_REGEX_SPECIAL 0x10
569 #define GIT_PATHSPEC_MAGIC 0x20
570 #define GIT_CNTRL 0x40
571 #define GIT_PUNCT 0x80
572 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
573 #define isascii(x) (((x) & ~0x7f) == 0)
574 #define isspace(x) sane_istest(x,GIT_SPACE)
575 #define isdigit(x) sane_istest(x,GIT_DIGIT)
576 #define isalpha(x) sane_istest(x,GIT_ALPHA)
577 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
578 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
579 #define islower(x) sane_iscase(x, 1)
580 #define isupper(x) sane_iscase(x, 0)
581 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
582 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
583 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
584 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
585 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
586 #define isxdigit(x) (hexval_table[x] != -1)
587 #define tolower(x) sane_case((unsigned char)(x), 0x20)
588 #define toupper(x) sane_case((unsigned char)(x), 0)
589 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
591 static inline int sane_case(int x
, int high
)
593 if (sane_istest(x
, GIT_ALPHA
))
594 x
= (x
& ~0x20) | high
;
598 static inline int sane_iscase(int x
, int is_lower
)
600 if (!sane_istest(x
, GIT_ALPHA
))
604 return (x
& 0x20) != 0;
606 return (x
& 0x20) == 0;
609 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
615 ul
= strtoul(s
, &p
, base
);
616 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
622 static inline int strtol_i(char const *s
, int base
, int *result
)
628 ul
= strtol(s
, &p
, base
);
629 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
635 #ifdef INTERNAL_QSORT
636 void git_qsort(void *base
, size_t nmemb
, size_t size
,
637 int(*compar
)(const void *, const void *));
638 #define qsort git_qsort
641 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
642 # define FORCE_DIR_SET_GID S_ISGID
644 # define FORCE_DIR_SET_GID 0
649 #define ST_CTIME_NSEC(st) 0
650 #define ST_MTIME_NSEC(st) 0
652 #ifdef USE_ST_TIMESPEC
653 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
654 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
656 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
657 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
661 #ifdef UNRELIABLE_FSTAT
662 #define fstat_is_reliable() 0
664 #define fstat_is_reliable() 1
669 * Since an obvious implementation of va_list would be to make it a
670 * pointer into the stack frame, a simple assignment will work on
671 * many systems. But let's try to be more portable.
674 #define va_copy(dst, src) __va_copy(dst, src)
676 #define va_copy(dst, src) ((dst) = (src))
681 * Preserves errno, prints a message, but gives no warning for ENOENT.
682 * Always returns the return value of unlink(2).
684 int unlink_or_warn(const char *path
);
686 * Likewise for rmdir(2).
688 int rmdir_or_warn(const char *path
);
690 * Calls the correct function out of {unlink,rmdir}_or_warn based on
691 * the supplied file mode.
693 int remove_or_warn(unsigned int mode
, const char *path
);
696 * Call access(2), but warn for any error except "missing file"
697 * (ENOENT or ENOTDIR).
699 int access_or_warn(const char *path
, int mode
);
700 int access_or_die(const char *path
, int mode
);
702 /* Warn on an inaccessible file that ought to be accessible */
703 void warn_on_inaccessible(const char *path
);
705 /* Get the passwd entry for the UID of the current process. */
706 struct passwd
*xgetpwuid_self(void);
708 #ifndef mark_as_git_dir
709 #define mark_as_git_dir(x) /* noop */
712 #ifndef get_home_directory
713 #define get_home_directory() getenv("HOME")