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>
132 extern int get_st_mode_bits(const char *path, int *mode);
134 #if defined(__MINGW32__)
135 /* pull in Windows compatibility stuff */
136 #include "compat/mingw.h"
137 #elif defined(_MSC_VER)
138 #include "compat/msvc.h"
140 #include <sys/wait.h>
141 #include <sys/resource.h>
142 #include <sys/socket.h>
143 #include <sys/ioctl.h>
145 #ifndef NO_SYS_SELECT_H
146 #include <sys/select.h>
148 #include <netinet/in.h>
149 #include <netinet/tcp.h>
150 #include <arpa/inet.h>
154 #ifndef NO_INTTYPES_H
155 #include <inttypes.h>
161 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
162 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
163 * while on IP16 and IP16L32 it is "int" (resp. "short")
164 * Size needs to match (or exceed) 'sizeof(void *)'.
165 * We can't take "long long" here as not everybody has it.
167 typedef long intptr_t;
168 typedef unsigned long uintptr_t;
170 #if defined(__CYGWIN__)
173 #define _XOPEN_SOURCE 600
174 #include "compat/cygwin.h"
176 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
178 #define _ALL_SOURCE 1
182 /* used on Mac OS X */
183 #ifdef PRECOMPOSE_UNICODE
184 #include "compat/precompose_utf8.h"
186 #define precompose_str(in,i_nfd2nfc)
187 #define precompose_argv(c,v)
188 #define probe_utf8_pathname_composition(a,b)
191 #ifdef NEEDS_CLIPPED_WRITE
192 ssize_t clipped_write(int fildes, const void *buf, size_t nbyte);
193 #define write(x,y,z) clipped_write((x),(y),(z))
196 #ifdef MKDIR_WO_TRAILING_SLASH
197 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
198 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
201 #ifdef NO_STRUCT_ITIMERVAL
203 struct timeval it_interval;
204 struct timeval it_value;
209 #define setitimer(which,value,ovalue)
215 #define basename gitbasename
216 extern char *gitbasename(char *);
224 #include <openssl/ssl.h>
225 #include <openssl/err.h>
228 /* On most systems <netdb.h> would have given us this, but
229 * not on some systems (e.g. z/OS).
232 #define NI_MAXHOST 1025
236 #define NI_MAXSERV 32
239 /* On most systems <limits.h> would have given us this, but
240 * not on some systems (e.g. GNU/Hurd).
243 #define PATH_MAX 4096
247 #define PRIuMAX "llu"
269 #ifndef _PATH_DEFPATH
270 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
273 #ifndef STRIP_EXTENSION
274 #define STRIP_EXTENSION ""
277 #ifndef has_dos_drive_prefix
278 #define has_dos_drive_prefix(path) 0
282 #define is_dir_sep(c) ((c) == '/')
285 #ifndef find_last_dir_sep
286 #define find_last_dir_sep(path) strrchr(path, '/')
289 #if defined(__HP_cc) && (__HP_cc >= 61000)
290 #define NORETURN __attribute__((noreturn))
292 #elif defined(__GNUC__) && !defined(NO_NORETURN)
293 #define NORETURN __attribute__((__noreturn__))
294 #define NORETURN_PTR __attribute__((__noreturn__))
295 #elif defined(_MSC_VER)
296 #define NORETURN __declspec(noreturn)
301 #ifndef __attribute__
302 #define __attribute__(x)
306 #include "compat/bswap.h"
309 #include "wildmatch.h"
310 #define FNM_PATHNAME WM_PATHNAME
311 #define FNM_CASEFOLD WM_CASEFOLD
312 #define FNM_NOMATCH WM_NOMATCH
313 static inline int fnmatch(const char *pattern, const char *string, int flags)
315 return wildmatch(pattern, string, flags, NULL);
319 /* General helper functions */
320 extern void vreportf(const char *prefix, const char *err, va_list params);
321 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
322 extern NORETURN void usage(const char *err);
323 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
324 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
325 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
326 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
327 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
330 * Let callers be aware of the constant return value; this can help
331 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
332 * because some compilers may not support variadic macros. Since we're only
333 * trying to help gcc, anyway, it's OK; other compilers will fall back to
334 * using the function as usual.
336 #if defined(__GNUC__) && ! defined(__clang__)
337 #define error(...) (error(__VA_ARGS__), -1)
340 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
341 extern void set_error_routine(void (*routine)(const char *err, va_list params));
342 extern void set_die_is_recursing_routine(int (*routine)(void));
344 extern int prefixcmp(const char *str, const char *prefix);
345 extern int suffixcmp(const char *str, const char *suffix);
347 static inline const char *skip_prefix(const char *str, const char *prefix)
349 size_t len = strlen(prefix);
350 return strncmp(str, prefix, len) ? NULL : str + len;
353 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
358 #define MAP_PRIVATE 1
361 #define mmap git_mmap
362 #define munmap git_munmap
363 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
364 extern int git_munmap(void *start, size_t length);
366 #else /* NO_MMAP || USE_WIN32_MMAP */
368 #include <sys/mman.h>
370 #endif /* NO_MMAP || USE_WIN32_MMAP */
374 /* This value must be multiple of (pagesize * 2) */
375 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
379 /* This value must be multiple of (pagesize * 2) */
380 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
381 (sizeof(void*) >= 8 \
382 ? 1 * 1024 * 1024 * 1024 \
388 #define MAP_FAILED ((void *)-1)
391 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
392 #define on_disk_bytes(st) ((st).st_size)
394 #define on_disk_bytes(st) ((st).st_blocks * 512)
397 #define DEFAULT_PACKED_GIT_LIMIT \
398 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
401 #define pread git_pread
402 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
405 * Forward decl that will remind us if its twin in cache.h changes.
406 * This function is used in compat/pread.c. But we can't include
409 extern ssize_t read_in_full(int fd, void *buf, size_t count);
412 #define setenv gitsetenv
413 extern int gitsetenv(const char *, const char *, int);
417 #define mkdtemp gitmkdtemp
418 extern char *gitmkdtemp(char *);
422 #define mkstemps gitmkstemps
423 extern int gitmkstemps(char *, int);
427 #define unsetenv gitunsetenv
428 extern void gitunsetenv(const char *);
432 #define strcasestr gitstrcasestr
433 extern char *gitstrcasestr(const char *haystack, const char *needle);
437 #define strlcpy gitstrlcpy
438 extern size_t gitstrlcpy(char *, const char *, size_t);
442 #define strtoumax gitstrtoumax
443 extern uintmax_t gitstrtoumax(const char *, char **, int);
444 #define strtoimax gitstrtoimax
445 extern intmax_t gitstrtoimax(const char *, char **, int);
449 #define hstrerror githstrerror
450 extern const char *githstrerror(int herror);
454 #define memmem gitmemmem
455 void *gitmemmem(const void *haystack, size_t haystacklen,
456 const void *needle, size_t needlelen);
459 #ifdef NO_GETPAGESIZE
460 #define getpagesize() sysconf(_SC_PAGESIZE)
463 #ifdef FREAD_READS_DIRECTORIES
467 #define fopen(a,b) git_fopen(a,b)
468 extern FILE *git_fopen(const char*, const char*);
471 #ifdef SNPRINTF_RETURNS_BOGUS
472 #define snprintf git_snprintf
473 extern int git_snprintf(char *str, size_t maxsize,
474 const char *format, ...);
475 #define vsnprintf git_vsnprintf
476 extern int git_vsnprintf(char *str, size_t maxsize,
477 const char *format, va_list ap);
480 #ifdef __GLIBC_PREREQ
481 #if __GLIBC_PREREQ(2, 1)
482 #define HAVE_STRCHRNUL
487 #ifndef HAVE_STRCHRNUL
488 #define strchrnul gitstrchrnul
489 static inline char *gitstrchrnul(const char *s, int c)
491 while (*s && *s != c)
498 #define mempcpy gitmempcpy
499 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
501 return (char *)memcpy(dest, src, n) + n;
506 int inet_pton(int af, const char *src, void *dst);
510 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
513 extern void release_pack_memory(size_t, int);
515 typedef void (*try_to_free_t)(size_t);
516 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
518 extern char *xstrdup(const char *str);
519 extern void *xmalloc(size_t size);
520 extern void *xmallocz(size_t size);
521 extern void *xmemdupz(const void *data, size_t len);
522 extern char *xstrndup(const char *str, size_t len);
523 extern void *xrealloc(void *ptr, size_t size);
524 extern void *xcalloc(size_t nmemb, size_t size);
525 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
526 extern ssize_t xread(int fd, void *buf, size_t len);
527 extern ssize_t xwrite(int fd, const void *buf, size_t len);
528 extern int xdup(int fd);
529 extern FILE *xfdopen(int fd, const char *mode);
530 extern int xmkstemp(char *template);
531 extern int xmkstemp_mode(char *template, int mode);
532 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
533 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
535 static inline size_t xsize_t(off_t len)
537 if (len > (size_t) len)
538 die("Cannot handle files this big");
542 static inline int has_extension(const char *filename, const char *ext)
544 size_t len = strlen(filename);
545 size_t extlen = strlen(ext);
546 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
549 /* in ctype.c, for kwset users */
550 extern const char tolower_trans_tbl[256];
552 /* Sane ctype - no locale, and works with signed chars */
567 extern const unsigned char sane_ctype[256];
568 #define GIT_SPACE 0x01
569 #define GIT_DIGIT 0x02
570 #define GIT_ALPHA 0x04
571 #define GIT_GLOB_SPECIAL 0x08
572 #define GIT_REGEX_SPECIAL 0x10
573 #define GIT_PATHSPEC_MAGIC 0x20
574 #define GIT_CNTRL 0x40
575 #define GIT_PUNCT 0x80
576 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
577 #define isascii(x) (((x) & ~0x7f) == 0)
578 #define isspace(x) sane_istest(x,GIT_SPACE)
579 #define isdigit(x) sane_istest(x,GIT_DIGIT)
580 #define isalpha(x) sane_istest(x,GIT_ALPHA)
581 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
582 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
583 #define islower(x) sane_iscase(x, 1)
584 #define isupper(x) sane_iscase(x, 0)
585 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
586 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
587 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
588 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
589 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
590 #define isxdigit(x) (hexval_table[x] != -1)
591 #define tolower(x) sane_case((unsigned char)(x), 0x20)
592 #define toupper(x) sane_case((unsigned char)(x), 0)
593 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
595 static inline int sane_case(int x, int high)
597 if (sane_istest(x, GIT_ALPHA))
598 x = (x & ~0x20) | high;
602 static inline int sane_iscase(int x, int is_lower)
604 if (!sane_istest(x, GIT_ALPHA))
608 return (x & 0x20) != 0;
610 return (x & 0x20) == 0;
613 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
619 ul = strtoul(s, &p, base);
620 if (errno || *p || p == s || (unsigned int) ul != ul)
626 static inline int strtol_i(char const *s, int base, int *result)
632 ul = strtol(s, &p, base);
633 if (errno || *p || p == s || (int) ul != ul)
639 #ifdef INTERNAL_QSORT
640 void git_qsort(void *base, size_t nmemb, size_t size,
641 int(*compar)(const void *, const void *));
642 #define qsort git_qsort
645 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
646 # define FORCE_DIR_SET_GID S_ISGID
648 # define FORCE_DIR_SET_GID 0
653 #define ST_CTIME_NSEC(st) 0
654 #define ST_MTIME_NSEC(st) 0
656 #ifdef USE_ST_TIMESPEC
657 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
658 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
660 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
661 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
665 #ifdef UNRELIABLE_FSTAT
666 #define fstat_is_reliable() 0
668 #define fstat_is_reliable() 1
673 * Since an obvious implementation of va_list would be to make it a
674 * pointer into the stack frame, a simple assignment will work on
675 * many systems. But let's try to be more portable.
678 #define va_copy(dst, src) __va_copy(dst, src)
680 #define va_copy(dst, src) ((dst) = (src))
685 * Preserves errno, prints a message, but gives no warning for ENOENT.
686 * Always returns the return value of unlink(2).
688 int unlink_or_warn(const char *path);
690 * Likewise for rmdir(2).
692 int rmdir_or_warn(const char *path);
694 * Calls the correct function out of {unlink,rmdir}_or_warn based on
695 * the supplied file mode.
697 int remove_or_warn(unsigned int mode, const char *path);
700 * Call access(2), but warn for any error except "missing file"
701 * (ENOENT or ENOTDIR).
703 #define ACCESS_EACCES_OK (1U << 0)
704 int access_or_warn(const char *path, int mode, unsigned flag);
705 int access_or_die(const char *path, int mode, unsigned flag);
707 /* Warn on an inaccessible file that ought to be accessible */
708 void warn_on_inaccessible(const char *path);
710 /* Get the passwd entry for the UID of the current process. */
711 struct passwd *xgetpwuid_self(void);