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 #if defined(WIN32) && !defined(__CYGWIN__) /* 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 */
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>
119 #ifndef USE_WILDMATCH
126 #ifndef NO_SYS_POLL_H
127 #include <sys/poll.h>
131 #if defined(__MINGW32__)
132 /* pull in Windows compatibility stuff */
133 #include "compat/mingw.h"
134 #elif defined(_MSC_VER)
135 #include "compat/msvc.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 int get_st_mode_bits(const char *path
, int *mode
);
168 #if defined(__CYGWIN__)
171 #define _XOPEN_SOURCE 600
172 #include "compat/cygwin.h"
174 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
176 #define _ALL_SOURCE 1
180 /* used on Mac OS X */
181 #ifdef PRECOMPOSE_UNICODE
182 #include "compat/precompose_utf8.h"
184 #define precompose_str(in,i_nfd2nfc)
185 #define precompose_argv(c,v)
186 #define probe_utf8_pathname_composition(a,b)
189 #ifdef MKDIR_WO_TRAILING_SLASH
190 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
191 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
194 #ifdef NO_STRUCT_ITIMERVAL
196 struct timeval it_interval
;
197 struct timeval it_value
;
202 #define setitimer(which,value,ovalue)
208 #define basename gitbasename
209 extern char *gitbasename(char *);
217 #include <openssl/ssl.h>
218 #include <openssl/err.h>
221 /* On most systems <netdb.h> would have given us this, but
222 * not on some systems (e.g. z/OS).
225 #define NI_MAXHOST 1025
229 #define NI_MAXSERV 32
232 /* On most systems <limits.h> would have given us this, but
233 * not on some systems (e.g. GNU/Hurd).
236 #define PATH_MAX 4096
240 #define PRIuMAX "llu"
262 #ifndef _PATH_DEFPATH
263 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
266 #ifndef STRIP_EXTENSION
267 #define STRIP_EXTENSION ""
270 #ifndef has_dos_drive_prefix
271 #define has_dos_drive_prefix(path) 0
275 #define is_dir_sep(c) ((c) == '/')
278 #ifndef find_last_dir_sep
279 #define find_last_dir_sep(path) strrchr(path, '/')
282 #if defined(__HP_cc) && (__HP_cc >= 61000)
283 #define NORETURN __attribute__((noreturn))
285 #elif defined(__GNUC__) && !defined(NO_NORETURN)
286 #define NORETURN __attribute__((__noreturn__))
287 #define NORETURN_PTR __attribute__((__noreturn__))
288 #elif defined(_MSC_VER)
289 #define NORETURN __declspec(noreturn)
294 #ifndef __attribute__
295 #define __attribute__(x)
299 #include "compat/bswap.h"
302 #include "wildmatch.h"
303 #define FNM_PATHNAME WM_PATHNAME
304 #define FNM_CASEFOLD WM_CASEFOLD
305 #define FNM_NOMATCH WM_NOMATCH
306 static inline int fnmatch(const char *pattern
, const char *string
, int flags
)
308 return wildmatch(pattern
, string
, flags
, NULL
);
312 /* General helper functions */
313 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
314 extern void vwritef(int fd
, const char *prefix
, const char *err
, va_list params
);
315 extern NORETURN
void usage(const char *err
);
316 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
317 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
318 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
319 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
320 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
323 * Let callers be aware of the constant return value; this can help
324 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
325 * because some compilers may not support variadic macros. Since we're only
326 * trying to help gcc, anyway, it's OK; other compilers will fall back to
327 * using the function as usual.
329 #if defined(__GNUC__) && ! defined(__clang__)
330 #define error(...) (error(__VA_ARGS__), -1)
333 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
334 extern void set_error_routine(void (*routine
)(const char *err
, va_list params
));
335 extern void set_die_is_recursing_routine(int (*routine
)(void));
337 extern int prefixcmp(const char *str
, const char *prefix
);
338 extern int suffixcmp(const char *str
, const char *suffix
);
340 static inline const char *skip_prefix(const char *str
, const char *prefix
)
342 size_t len
= strlen(prefix
);
343 return strncmp(str
, prefix
, len
) ? NULL
: str
+ len
;
346 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
351 #define MAP_PRIVATE 1
354 #define mmap git_mmap
355 #define munmap git_munmap
356 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
357 extern int git_munmap(void *start
, size_t length
);
359 #else /* NO_MMAP || USE_WIN32_MMAP */
361 #include <sys/mman.h>
363 #endif /* NO_MMAP || USE_WIN32_MMAP */
367 /* This value must be multiple of (pagesize * 2) */
368 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
372 /* This value must be multiple of (pagesize * 2) */
373 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
374 (sizeof(void*) >= 8 \
375 ? 1 * 1024 * 1024 * 1024 \
381 #define MAP_FAILED ((void *)-1)
384 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
385 #define on_disk_bytes(st) ((st).st_size)
387 #define on_disk_bytes(st) ((st).st_blocks * 512)
390 #define DEFAULT_PACKED_GIT_LIMIT \
391 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
394 #define pread git_pread
395 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
398 * Forward decl that will remind us if its twin in cache.h changes.
399 * This function is used in compat/pread.c. But we can't include
402 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
405 #define setenv gitsetenv
406 extern int gitsetenv(const char *, const char *, int);
410 #define mkdtemp gitmkdtemp
411 extern char *gitmkdtemp(char *);
415 #define mkstemps gitmkstemps
416 extern int gitmkstemps(char *, int);
420 #define unsetenv gitunsetenv
421 extern void gitunsetenv(const char *);
425 #define strcasestr gitstrcasestr
426 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
430 #define strlcpy gitstrlcpy
431 extern size_t gitstrlcpy(char *, const char *, size_t);
435 #define strtoumax gitstrtoumax
436 extern uintmax_t gitstrtoumax(const char *, char **, int);
437 #define strtoimax gitstrtoimax
438 extern intmax_t gitstrtoimax(const char *, char **, int);
442 #define hstrerror githstrerror
443 extern const char *githstrerror(int herror
);
447 #define memmem gitmemmem
448 void *gitmemmem(const void *haystack
, size_t haystacklen
,
449 const void *needle
, size_t needlelen
);
452 #ifdef NO_GETPAGESIZE
453 #define getpagesize() sysconf(_SC_PAGESIZE)
456 #ifdef FREAD_READS_DIRECTORIES
460 #define fopen(a,b) git_fopen(a,b)
461 extern FILE *git_fopen(const char*, const char*);
464 #ifdef SNPRINTF_RETURNS_BOGUS
465 #define snprintf git_snprintf
466 extern int git_snprintf(char *str
, size_t maxsize
,
467 const char *format
, ...);
468 #define vsnprintf git_vsnprintf
469 extern int git_vsnprintf(char *str
, size_t maxsize
,
470 const char *format
, va_list ap
);
473 #ifdef __GLIBC_PREREQ
474 #if __GLIBC_PREREQ(2, 1)
475 #define HAVE_STRCHRNUL
480 #ifndef HAVE_STRCHRNUL
481 #define strchrnul gitstrchrnul
482 static inline char *gitstrchrnul(const char *s
, int c
)
484 while (*s
&& *s
!= c
)
491 #define mempcpy gitmempcpy
492 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
494 return (char *)memcpy(dest
, src
, n
) + n
;
499 int inet_pton(int af
, const char *src
, void *dst
);
503 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
506 extern void release_pack_memory(size_t, int);
508 typedef void (*try_to_free_t
)(size_t);
509 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
511 extern char *xstrdup(const char *str
);
512 extern void *xmalloc(size_t size
);
513 extern void *xmallocz(size_t size
);
514 extern void *xmemdupz(const void *data
, size_t len
);
515 extern char *xstrndup(const char *str
, size_t len
);
516 extern void *xrealloc(void *ptr
, size_t size
);
517 extern void *xcalloc(size_t nmemb
, size_t size
);
518 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
519 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
520 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
521 extern int xdup(int fd
);
522 extern FILE *xfdopen(int fd
, const char *mode
);
523 extern int xmkstemp(char *template);
524 extern int xmkstemp_mode(char *template, int mode
);
525 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
526 extern int odb_pack_keep(char *name
, size_t namesz
, unsigned char *sha1
);
528 static inline size_t xsize_t(off_t len
)
530 if (len
> (size_t) len
)
531 die("Cannot handle files this big");
535 static inline int has_extension(const char *filename
, const char *ext
)
537 size_t len
= strlen(filename
);
538 size_t extlen
= strlen(ext
);
539 return len
> extlen
&& !memcmp(filename
+ len
- extlen
, ext
, extlen
);
542 /* in ctype.c, for kwset users */
543 extern const char tolower_trans_tbl
[256];
545 /* Sane ctype - no locale, and works with signed chars */
560 extern const unsigned char sane_ctype
[256];
561 #define GIT_SPACE 0x01
562 #define GIT_DIGIT 0x02
563 #define GIT_ALPHA 0x04
564 #define GIT_GLOB_SPECIAL 0x08
565 #define GIT_REGEX_SPECIAL 0x10
566 #define GIT_PATHSPEC_MAGIC 0x20
567 #define GIT_CNTRL 0x40
568 #define GIT_PUNCT 0x80
569 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
570 #define isascii(x) (((x) & ~0x7f) == 0)
571 #define isspace(x) sane_istest(x,GIT_SPACE)
572 #define isdigit(x) sane_istest(x,GIT_DIGIT)
573 #define isalpha(x) sane_istest(x,GIT_ALPHA)
574 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
575 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
576 #define islower(x) sane_iscase(x, 1)
577 #define isupper(x) sane_iscase(x, 0)
578 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
579 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
580 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
581 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
582 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
583 #define isxdigit(x) (hexval_table[x] != -1)
584 #define tolower(x) sane_case((unsigned char)(x), 0x20)
585 #define toupper(x) sane_case((unsigned char)(x), 0)
586 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
588 static inline int sane_case(int x
, int high
)
590 if (sane_istest(x
, GIT_ALPHA
))
591 x
= (x
& ~0x20) | high
;
595 static inline int sane_iscase(int x
, int is_lower
)
597 if (!sane_istest(x
, GIT_ALPHA
))
601 return (x
& 0x20) != 0;
603 return (x
& 0x20) == 0;
606 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
612 ul
= strtoul(s
, &p
, base
);
613 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
619 static inline int strtol_i(char const *s
, int base
, int *result
)
625 ul
= strtol(s
, &p
, base
);
626 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
632 #ifdef INTERNAL_QSORT
633 void git_qsort(void *base
, size_t nmemb
, size_t size
,
634 int(*compar
)(const void *, const void *));
635 #define qsort git_qsort
638 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
639 # define FORCE_DIR_SET_GID S_ISGID
641 # define FORCE_DIR_SET_GID 0
646 #define ST_CTIME_NSEC(st) 0
647 #define ST_MTIME_NSEC(st) 0
649 #ifdef USE_ST_TIMESPEC
650 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
651 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
653 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
654 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
658 #ifdef UNRELIABLE_FSTAT
659 #define fstat_is_reliable() 0
661 #define fstat_is_reliable() 1
666 * Since an obvious implementation of va_list would be to make it a
667 * pointer into the stack frame, a simple assignment will work on
668 * many systems. But let's try to be more portable.
671 #define va_copy(dst, src) __va_copy(dst, src)
673 #define va_copy(dst, src) ((dst) = (src))
678 * Preserves errno, prints a message, but gives no warning for ENOENT.
679 * Always returns the return value of unlink(2).
681 int unlink_or_warn(const char *path
);
683 * Likewise for rmdir(2).
685 int rmdir_or_warn(const char *path
);
687 * Calls the correct function out of {unlink,rmdir}_or_warn based on
688 * the supplied file mode.
690 int remove_or_warn(unsigned int mode
, const char *path
);
693 * Call access(2), but warn for any error except "missing file"
694 * (ENOENT or ENOTDIR).
696 int access_or_warn(const char *path
, int mode
);
697 int access_or_die(const char *path
, int mode
);
699 /* Warn on an inaccessible file that ought to be accessible */
700 void warn_on_inaccessible(const char *path
);
702 /* Get the passwd entry for the UID of the current process. */
703 struct passwd
*xgetpwuid_self(void);