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__) && \
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_LEAN_AND_MEAN /* stops windows.h including winsock.h */
102 #ifdef __TANDEM /* or HAVE_STRINGS_H or !NO_STRINGS_H? */
103 #include <strings.h> /* for strcasecmp() */
107 #include <sys/param.h>
108 #include <sys/types.h>
110 #include <sys/time.h>
118 #ifndef NO_SYS_POLL_H
119 #include <sys/poll.h>
123 #if defined(__MINGW32__)
124 /* pull in Windows compatibility stuff */
125 #include "compat/mingw.h"
126 #elif defined(_MSC_VER)
127 #include "compat/msvc.h"
129 #include <sys/wait.h>
130 #include <sys/resource.h>
131 #include <sys/socket.h>
132 #include <sys/ioctl.h>
134 #ifndef NO_SYS_SELECT_H
135 #include <sys/select.h>
137 #include <netinet/in.h>
138 #include <netinet/tcp.h>
139 #include <arpa/inet.h>
143 #ifndef NO_INTTYPES_H
144 #include <inttypes.h>
150 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
151 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
152 * while on IP16 and IP16L32 it is "int" (resp. "short")
153 * Size needs to match (or exceed) 'sizeof(void *)'.
154 * We can't take "long long" here as not everybody has it.
156 typedef long intptr_t;
157 typedef unsigned long uintptr_t;
159 #if defined(__CYGWIN__)
162 #define _XOPEN_SOURCE 600
163 #include "compat/cygwin.h"
165 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
167 #define _ALL_SOURCE 1
171 /* used on Mac OS X */
172 #ifdef PRECOMPOSE_UNICODE
173 #include "compat/precompose_utf8.h"
175 #define precompose_str(in,i_nfd2nfc)
176 #define precompose_argv(c,v)
177 #define probe_utf8_pathname_composition(a,b)
180 #ifdef MKDIR_WO_TRAILING_SLASH
181 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
182 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
185 #ifdef NO_STRUCT_ITIMERVAL
187 struct timeval it_interval
;
188 struct timeval it_value
;
193 #define setitimer(which,value,ovalue)
199 #define basename gitbasename
200 extern char *gitbasename(char *);
208 #include <openssl/ssl.h>
209 #include <openssl/err.h>
212 /* On most systems <netdb.h> would have given us this, but
213 * not on some systems (e.g. z/OS).
216 #define NI_MAXHOST 1025
220 #define NI_MAXSERV 32
223 /* On most systems <limits.h> would have given us this, but
224 * not on some systems (e.g. GNU/Hurd).
227 #define PATH_MAX 4096
231 #define PRIuMAX "llu"
253 #ifndef _PATH_DEFPATH
254 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
257 #ifndef STRIP_EXTENSION
258 #define STRIP_EXTENSION ""
261 #ifndef has_dos_drive_prefix
262 #define has_dos_drive_prefix(path) 0
266 #define is_dir_sep(c) ((c) == '/')
269 #ifndef find_last_dir_sep
270 #define find_last_dir_sep(path) strrchr(path, '/')
273 #if defined(__HP_cc) && (__HP_cc >= 61000)
274 #define NORETURN __attribute__((noreturn))
276 #elif defined(__GNUC__) && !defined(NO_NORETURN)
277 #define NORETURN __attribute__((__noreturn__))
278 #define NORETURN_PTR __attribute__((__noreturn__))
279 #elif defined(_MSC_VER)
280 #define NORETURN __declspec(noreturn)
285 #ifndef __attribute__
286 #define __attribute__(x)
290 #include "compat/bswap.h"
292 /* General helper functions */
293 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
294 extern void vwritef(int fd
, const char *prefix
, const char *err
, va_list params
);
295 extern NORETURN
void usage(const char *err
);
296 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
297 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
298 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
299 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
300 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
302 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
303 extern void set_error_routine(void (*routine
)(const char *err
, va_list params
));
304 extern void set_die_is_recursing_routine(int (*routine
)(void));
306 extern int prefixcmp(const char *str
, const char *prefix
);
307 extern int suffixcmp(const char *str
, const char *suffix
);
309 static inline const char *skip_prefix(const char *str
, const char *prefix
)
311 size_t len
= strlen(prefix
);
312 return strncmp(str
, prefix
, len
) ? NULL
: str
+ len
;
315 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
320 #define MAP_PRIVATE 1
323 #define mmap git_mmap
324 #define munmap git_munmap
325 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
326 extern int git_munmap(void *start
, size_t length
);
328 #else /* NO_MMAP || USE_WIN32_MMAP */
330 #include <sys/mman.h>
332 #endif /* NO_MMAP || USE_WIN32_MMAP */
336 /* This value must be multiple of (pagesize * 2) */
337 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
341 /* This value must be multiple of (pagesize * 2) */
342 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
343 (sizeof(void*) >= 8 \
344 ? 1 * 1024 * 1024 * 1024 \
350 #define MAP_FAILED ((void *)-1)
353 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
354 #define on_disk_bytes(st) ((st).st_size)
356 #define on_disk_bytes(st) ((st).st_blocks * 512)
359 #define DEFAULT_PACKED_GIT_LIMIT \
360 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
363 #define pread git_pread
364 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
367 * Forward decl that will remind us if its twin in cache.h changes.
368 * This function is used in compat/pread.c. But we can't include
371 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
374 #define setenv gitsetenv
375 extern int gitsetenv(const char *, const char *, int);
379 #define mkdtemp gitmkdtemp
380 extern char *gitmkdtemp(char *);
384 #define mkstemps gitmkstemps
385 extern int gitmkstemps(char *, int);
389 #define unsetenv gitunsetenv
390 extern void gitunsetenv(const char *);
394 #define strcasestr gitstrcasestr
395 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
399 #define strlcpy gitstrlcpy
400 extern size_t gitstrlcpy(char *, const char *, size_t);
404 #define strtoumax gitstrtoumax
405 extern uintmax_t gitstrtoumax(const char *, char **, int);
406 #define strtoimax gitstrtoimax
407 extern intmax_t gitstrtoimax(const char *, char **, int);
411 #define strtok_r gitstrtok_r
412 extern char *gitstrtok_r(char *s
, const char *delim
, char **save_ptr
);
416 #define hstrerror githstrerror
417 extern const char *githstrerror(int herror
);
421 #define memmem gitmemmem
422 void *gitmemmem(const void *haystack
, size_t haystacklen
,
423 const void *needle
, size_t needlelen
);
426 #ifdef FREAD_READS_DIRECTORIES
430 #define fopen(a,b) git_fopen(a,b)
431 extern FILE *git_fopen(const char*, const char*);
434 #ifdef SNPRINTF_RETURNS_BOGUS
435 #define snprintf git_snprintf
436 extern int git_snprintf(char *str
, size_t maxsize
,
437 const char *format
, ...);
438 #define vsnprintf git_vsnprintf
439 extern int git_vsnprintf(char *str
, size_t maxsize
,
440 const char *format
, va_list ap
);
443 #ifdef __GLIBC_PREREQ
444 #if __GLIBC_PREREQ(2, 1)
445 #define HAVE_STRCHRNUL
450 #ifndef HAVE_STRCHRNUL
451 #define strchrnul gitstrchrnul
452 static inline char *gitstrchrnul(const char *s
, int c
)
454 while (*s
&& *s
!= c
)
461 #define mempcpy gitmempcpy
462 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
464 return (char *)memcpy(dest
, src
, n
) + n
;
469 int inet_pton(int af
, const char *src
, void *dst
);
473 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
476 extern void release_pack_memory(size_t, int);
478 typedef void (*try_to_free_t
)(size_t);
479 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
481 extern char *xstrdup(const char *str
);
482 extern void *xmalloc(size_t size
);
483 extern void *xmallocz(size_t size
);
484 extern void *xmemdupz(const void *data
, size_t len
);
485 extern char *xstrndup(const char *str
, size_t len
);
486 extern void *xrealloc(void *ptr
, size_t size
);
487 extern void *xcalloc(size_t nmemb
, size_t size
);
488 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
489 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
490 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
491 extern int xdup(int fd
);
492 extern FILE *xfdopen(int fd
, const char *mode
);
493 extern int xmkstemp(char *template);
494 extern int xmkstemp_mode(char *template, int mode
);
495 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
496 extern int odb_pack_keep(char *name
, size_t namesz
, unsigned char *sha1
);
498 static inline size_t xsize_t(off_t len
)
500 if (len
> (size_t) len
)
501 die("Cannot handle files this big");
505 static inline int has_extension(const char *filename
, const char *ext
)
507 size_t len
= strlen(filename
);
508 size_t extlen
= strlen(ext
);
509 return len
> extlen
&& !memcmp(filename
+ len
- extlen
, ext
, extlen
);
512 /* in ctype.c, for kwset users */
513 extern const char tolower_trans_tbl
[256];
515 /* Sane ctype - no locale, and works with signed chars */
526 extern unsigned char sane_ctype
[256];
527 #define GIT_SPACE 0x01
528 #define GIT_DIGIT 0x02
529 #define GIT_ALPHA 0x04
530 #define GIT_GLOB_SPECIAL 0x08
531 #define GIT_REGEX_SPECIAL 0x10
532 #define GIT_PATHSPEC_MAGIC 0x20
533 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
534 #define isascii(x) (((x) & ~0x7f) == 0)
535 #define isspace(x) sane_istest(x,GIT_SPACE)
536 #define isdigit(x) sane_istest(x,GIT_DIGIT)
537 #define isalpha(x) sane_istest(x,GIT_ALPHA)
538 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
539 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
540 #define islower(x) sane_iscase(x, 1)
541 #define isupper(x) sane_iscase(x, 0)
542 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
543 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
544 #define tolower(x) sane_case((unsigned char)(x), 0x20)
545 #define toupper(x) sane_case((unsigned char)(x), 0)
546 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
548 static inline int sane_case(int x
, int high
)
550 if (sane_istest(x
, GIT_ALPHA
))
551 x
= (x
& ~0x20) | high
;
555 static inline int sane_iscase(int x
, int is_lower
)
557 if (!sane_istest(x
, GIT_ALPHA
))
561 return (x
& 0x20) != 0;
563 return (x
& 0x20) == 0;
566 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
572 ul
= strtoul(s
, &p
, base
);
573 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
579 static inline int strtol_i(char const *s
, int base
, int *result
)
585 ul
= strtol(s
, &p
, base
);
586 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
592 #ifdef INTERNAL_QSORT
593 void git_qsort(void *base
, size_t nmemb
, size_t size
,
594 int(*compar
)(const void *, const void *));
595 #define qsort git_qsort
598 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
599 # define FORCE_DIR_SET_GID S_ISGID
601 # define FORCE_DIR_SET_GID 0
606 #define ST_CTIME_NSEC(st) 0
607 #define ST_MTIME_NSEC(st) 0
609 #ifdef USE_ST_TIMESPEC
610 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
611 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
613 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
614 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
618 #ifdef UNRELIABLE_FSTAT
619 #define fstat_is_reliable() 0
621 #define fstat_is_reliable() 1
626 * Since an obvious implementation of va_list would be to make it a
627 * pointer into the stack frame, a simple assignment will work on
628 * many systems. But let's try to be more portable.
631 #define va_copy(dst, src) __va_copy(dst, src)
633 #define va_copy(dst, src) ((dst) = (src))
638 * Preserves errno, prints a message, but gives no warning for ENOENT.
639 * Always returns the return value of unlink(2).
641 int unlink_or_warn(const char *path
);
643 * Likewise for rmdir(2).
645 int rmdir_or_warn(const char *path
);
647 * Calls the correct function out of {unlink,rmdir}_or_warn based on
648 * the supplied file mode.
650 int remove_or_warn(unsigned int mode
, const char *path
);
653 * Call access(2), but warn for any error except "missing file"
654 * (ENOENT or ENOTDIR).
656 int access_or_warn(const char *path
, int mode
);
657 int access_or_die(const char *path
, int mode
);
659 /* Warn on an inaccessible file that ought to be accessible */
660 void warn_on_inaccessible(const char *path
);
662 /* Get the passwd entry for the UID of the current process. */
663 struct passwd
*xgetpwuid_self(void);