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 #define _WIN32_WINNT 0x0502
90 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
103 #ifdef HAVE_STRINGS_H
104 #include <strings.h> /* for strcasecmp() */
108 #ifdef NEEDS_SYS_PARAM_H
109 #include <sys/param.h>
111 #include <sys/types.h>
113 #include <sys/time.h>
116 #ifndef USE_WILDMATCH
123 #ifndef NO_SYS_POLL_H
124 #include <sys/poll.h>
128 #if defined(__MINGW32__)
129 /* pull in Windows compatibility stuff */
130 #include "compat/mingw.h"
131 #elif defined(_MSC_VER)
132 #include "compat/msvc.h"
134 #include <sys/wait.h>
135 #include <sys/resource.h>
136 #include <sys/socket.h>
137 #include <sys/ioctl.h>
139 #ifndef NO_SYS_SELECT_H
140 #include <sys/select.h>
142 #include <netinet/in.h>
143 #include <netinet/tcp.h>
144 #include <arpa/inet.h>
148 #ifndef NO_INTTYPES_H
149 #include <inttypes.h>
155 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
156 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
157 * while on IP16 and IP16L32 it is "int" (resp. "short")
158 * Size needs to match (or exceed) 'sizeof(void *)'.
159 * We can't take "long long" here as not everybody has it.
161 typedef long intptr_t;
162 typedef unsigned long uintptr_t;
164 int get_st_mode_bits(const char *path
, int *mode
);
165 #if defined(__CYGWIN__)
168 #define _XOPEN_SOURCE 600
169 #include "compat/cygwin.h"
171 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
173 #define _ALL_SOURCE 1
177 /* used on Mac OS X */
178 #ifdef PRECOMPOSE_UNICODE
179 #include "compat/precompose_utf8.h"
181 #define precompose_str(in,i_nfd2nfc)
182 #define precompose_argv(c,v)
183 #define probe_utf8_pathname_composition(a,b)
186 #ifdef MKDIR_WO_TRAILING_SLASH
187 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
188 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
191 #ifdef NO_STRUCT_ITIMERVAL
193 struct timeval it_interval
;
194 struct timeval it_value
;
199 #define setitimer(which,value,ovalue)
205 #define basename gitbasename
206 extern char *gitbasename(char *);
214 #include <openssl/ssl.h>
215 #include <openssl/err.h>
218 /* On most systems <netdb.h> would have given us this, but
219 * not on some systems (e.g. z/OS).
222 #define NI_MAXHOST 1025
226 #define NI_MAXSERV 32
229 /* On most systems <limits.h> would have given us this, but
230 * not on some systems (e.g. GNU/Hurd).
233 #define PATH_MAX 4096
237 #define PRIuMAX "llu"
259 #ifndef _PATH_DEFPATH
260 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
263 #ifndef STRIP_EXTENSION
264 #define STRIP_EXTENSION ""
267 #ifndef has_dos_drive_prefix
268 #define has_dos_drive_prefix(path) 0
271 #ifndef offset_1st_component
272 #define offset_1st_component(path) (is_dir_sep((path)[0]))
276 #define is_dir_sep(c) ((c) == '/')
279 #ifndef find_last_dir_sep
280 #define find_last_dir_sep(path) strrchr(path, '/')
283 #if defined(__HP_cc) && (__HP_cc >= 61000)
284 #define NORETURN __attribute__((noreturn))
286 #elif defined(__GNUC__) && !defined(NO_NORETURN)
287 #define NORETURN __attribute__((__noreturn__))
288 #define NORETURN_PTR __attribute__((__noreturn__))
289 #elif defined(_MSC_VER)
290 #define NORETURN __declspec(noreturn)
295 #ifndef __attribute__
296 #define __attribute__(x)
300 #include "compat/bswap.h"
303 #include "wildmatch.h"
304 #define FNM_PATHNAME WM_PATHNAME
305 #define FNM_CASEFOLD WM_CASEFOLD
306 #define FNM_NOMATCH WM_NOMATCH
307 static inline int fnmatch(const char *pattern
, const char *string
, int flags
)
309 return wildmatch(pattern
, string
, flags
, NULL
);
313 /* General helper functions */
314 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
315 extern void vwritef(int fd
, const char *prefix
, const char *err
, va_list params
);
316 extern NORETURN
void usage(const char *err
);
317 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
318 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
319 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
320 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
321 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
324 * Let callers be aware of the constant return value; this can help
325 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
326 * because some compilers may not support variadic macros. Since we're only
327 * trying to help gcc, anyway, it's OK; other compilers will fall back to
328 * using the function as usual.
330 #if defined(__GNUC__) && ! defined(__clang__)
331 #define error(...) (error(__VA_ARGS__), -1)
334 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
335 extern void set_error_routine(void (*routine
)(const char *err
, va_list params
));
336 extern void set_die_is_recursing_routine(int (*routine
)(void));
338 extern int prefixcmp(const char *str
, const char *prefix
);
339 extern int suffixcmp(const char *str
, const char *suffix
);
341 static inline const char *skip_prefix(const char *str
, const char *prefix
)
343 size_t len
= strlen(prefix
);
344 return strncmp(str
, prefix
, len
) ? NULL
: str
+ len
;
347 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
352 #define MAP_PRIVATE 1
355 #define mmap git_mmap
356 #define munmap git_munmap
357 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
358 extern int git_munmap(void *start
, size_t length
);
360 #else /* NO_MMAP || USE_WIN32_MMAP */
362 #include <sys/mman.h>
364 #endif /* NO_MMAP || USE_WIN32_MMAP */
368 /* This value must be multiple of (pagesize * 2) */
369 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
373 /* This value must be multiple of (pagesize * 2) */
374 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
375 (sizeof(void*) >= 8 \
376 ? 1 * 1024 * 1024 * 1024 \
382 #define MAP_FAILED ((void *)-1)
385 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
386 #define on_disk_bytes(st) ((st).st_size)
388 #define on_disk_bytes(st) ((st).st_blocks * 512)
391 #define DEFAULT_PACKED_GIT_LIMIT \
392 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
395 #define pread git_pread
396 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
399 * Forward decl that will remind us if its twin in cache.h changes.
400 * This function is used in compat/pread.c. But we can't include
403 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
406 #define setenv gitsetenv
407 extern int gitsetenv(const char *, const char *, int);
411 #define mkdtemp gitmkdtemp
412 extern char *gitmkdtemp(char *);
416 #define mkstemps gitmkstemps
417 extern int gitmkstemps(char *, int);
421 #define unsetenv gitunsetenv
422 extern void gitunsetenv(const char *);
426 #define strcasestr gitstrcasestr
427 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
431 #define strlcpy gitstrlcpy
432 extern size_t gitstrlcpy(char *, const char *, size_t);
436 #define strtoumax gitstrtoumax
437 extern uintmax_t gitstrtoumax(const char *, char **, int);
438 #define strtoimax gitstrtoimax
439 extern intmax_t gitstrtoimax(const char *, char **, int);
443 #define hstrerror githstrerror
444 extern const char *githstrerror(int herror
);
448 #define memmem gitmemmem
449 void *gitmemmem(const void *haystack
, size_t haystacklen
,
450 const void *needle
, size_t needlelen
);
453 #ifdef NO_GETPAGESIZE
454 #define getpagesize() sysconf(_SC_PAGESIZE)
457 #ifdef FREAD_READS_DIRECTORIES
461 #define fopen(a,b) git_fopen(a,b)
462 extern FILE *git_fopen(const char*, const char*);
465 #ifdef SNPRINTF_RETURNS_BOGUS
466 #define snprintf git_snprintf
467 extern int git_snprintf(char *str
, size_t maxsize
,
468 const char *format
, ...);
469 #define vsnprintf git_vsnprintf
470 extern int git_vsnprintf(char *str
, size_t maxsize
,
471 const char *format
, va_list ap
);
474 #ifdef __GLIBC_PREREQ
475 #if __GLIBC_PREREQ(2, 1)
476 #define HAVE_STRCHRNUL
481 #ifndef HAVE_STRCHRNUL
482 #define strchrnul gitstrchrnul
483 static inline char *gitstrchrnul(const char *s
, int c
)
485 while (*s
&& *s
!= c
)
492 #define mempcpy gitmempcpy
493 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
495 return (char *)memcpy(dest
, src
, n
) + n
;
500 int inet_pton(int af
, const char *src
, void *dst
);
504 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
507 extern void release_pack_memory(size_t, int);
509 typedef void (*try_to_free_t
)(size_t);
510 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
512 extern char *xstrdup(const char *str
);
513 extern void *xmalloc(size_t size
);
514 extern void *xmallocz(size_t size
);
515 extern void *xmemdupz(const void *data
, size_t len
);
516 extern char *xstrndup(const char *str
, size_t len
);
517 extern void *xrealloc(void *ptr
, size_t size
);
518 extern void *xcalloc(size_t nmemb
, size_t size
);
519 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
520 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
521 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
522 extern int xdup(int fd
);
523 extern FILE *xfdopen(int fd
, const char *mode
);
524 extern int xmkstemp(char *template);
525 extern int xmkstemp_mode(char *template, int mode
);
526 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
527 extern int odb_pack_keep(char *name
, size_t namesz
, unsigned char *sha1
);
529 static inline size_t xsize_t(off_t len
)
531 if (len
> (size_t) len
)
532 die("Cannot handle files this big");
536 static inline int has_extension(const char *filename
, const char *ext
)
538 size_t len
= strlen(filename
);
539 size_t extlen
= strlen(ext
);
540 return len
> extlen
&& !memcmp(filename
+ len
- extlen
, ext
, extlen
);
543 /* in ctype.c, for kwset users */
544 extern const char tolower_trans_tbl
[256];
546 /* Sane ctype - no locale, and works with signed chars */
561 extern const unsigned char sane_ctype
[256];
562 #define GIT_SPACE 0x01
563 #define GIT_DIGIT 0x02
564 #define GIT_ALPHA 0x04
565 #define GIT_GLOB_SPECIAL 0x08
566 #define GIT_REGEX_SPECIAL 0x10
567 #define GIT_PATHSPEC_MAGIC 0x20
568 #define GIT_CNTRL 0x40
569 #define GIT_PUNCT 0x80
570 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
571 #define isascii(x) (((x) & ~0x7f) == 0)
572 #define isspace(x) sane_istest(x,GIT_SPACE)
573 #define isdigit(x) sane_istest(x,GIT_DIGIT)
574 #define isalpha(x) sane_istest(x,GIT_ALPHA)
575 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
576 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
577 #define islower(x) sane_iscase(x, 1)
578 #define isupper(x) sane_iscase(x, 0)
579 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
580 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
581 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
582 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
583 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
584 #define isxdigit(x) (hexval_table[x] != -1)
585 #define tolower(x) sane_case((unsigned char)(x), 0x20)
586 #define toupper(x) sane_case((unsigned char)(x), 0)
587 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
589 static inline int sane_case(int x
, int high
)
591 if (sane_istest(x
, GIT_ALPHA
))
592 x
= (x
& ~0x20) | high
;
596 static inline int sane_iscase(int x
, int is_lower
)
598 if (!sane_istest(x
, GIT_ALPHA
))
602 return (x
& 0x20) != 0;
604 return (x
& 0x20) == 0;
607 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
613 ul
= strtoul(s
, &p
, base
);
614 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
620 static inline int strtol_i(char const *s
, int base
, int *result
)
626 ul
= strtol(s
, &p
, base
);
627 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
633 #ifdef INTERNAL_QSORT
634 void git_qsort(void *base
, size_t nmemb
, size_t size
,
635 int(*compar
)(const void *, const void *));
636 #define qsort git_qsort
639 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
640 # define FORCE_DIR_SET_GID S_ISGID
642 # define FORCE_DIR_SET_GID 0
647 #define ST_CTIME_NSEC(st) 0
648 #define ST_MTIME_NSEC(st) 0
650 #ifdef USE_ST_TIMESPEC
651 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
652 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
654 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
655 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
659 #ifdef UNRELIABLE_FSTAT
660 #define fstat_is_reliable() 0
662 #define fstat_is_reliable() 1
667 * Since an obvious implementation of va_list would be to make it a
668 * pointer into the stack frame, a simple assignment will work on
669 * many systems. But let's try to be more portable.
672 #define va_copy(dst, src) __va_copy(dst, src)
674 #define va_copy(dst, src) ((dst) = (src))
679 * Preserves errno, prints a message, but gives no warning for ENOENT.
680 * Always returns the return value of unlink(2).
682 int unlink_or_warn(const char *path
);
684 * Likewise for rmdir(2).
686 int rmdir_or_warn(const char *path
);
688 * Calls the correct function out of {unlink,rmdir}_or_warn based on
689 * the supplied file mode.
691 int remove_or_warn(unsigned int mode
, const char *path
);
694 * Call access(2), but warn for any error except "missing file"
695 * (ENOENT or ENOTDIR).
697 int access_or_warn(const char *path
, int mode
);
698 int access_or_die(const char *path
, int mode
);
700 /* Warn on an inaccessible file that ought to be accessible */
701 void warn_on_inaccessible(const char *path
);
703 /* Get the passwd entry for the UID of the current process. */
704 struct passwd
*xgetpwuid_self(void);
706 #ifndef mark_as_git_dir
707 #define mark_as_git_dir(x) /* noop */
710 #ifndef get_home_directory
711 #define get_home_directory() getenv("HOME")