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 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
79 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
84 #define _NETBSD_SOURCE 1
87 #ifdef WIN32 /* Both MinGW and MSVC */
88 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
103 #include <sys/param.h>
104 #include <sys/types.h>
106 #include <sys/time.h>
114 #ifndef NO_SYS_POLL_H
115 #include <sys/poll.h>
119 #if defined(__MINGW32__)
120 /* pull in Windows compatibility stuff */
121 #include "compat/mingw.h"
122 #elif defined(_MSC_VER)
123 #include "compat/msvc.h"
125 #include <sys/wait.h>
126 #include <sys/resource.h>
127 #include <sys/socket.h>
128 #include <sys/ioctl.h>
130 #ifndef NO_SYS_SELECT_H
131 #include <sys/select.h>
133 #include <netinet/in.h>
134 #include <netinet/tcp.h>
135 #include <arpa/inet.h>
139 #ifndef NO_INTTYPES_H
140 #include <inttypes.h>
144 #if defined(__CYGWIN__)
147 #define _XOPEN_SOURCE 600
148 #include "compat/cygwin.h"
150 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
152 #define _ALL_SOURCE 1
156 /* used on Mac OS X */
157 #ifdef PRECOMPOSE_UNICODE
158 #include "compat/precompose_utf8.h"
160 #define precompose_str(in,i_nfd2nfc)
161 #define precompose_argv(c,v)
162 #define probe_utf8_pathname_composition(a,b)
165 #ifdef MKDIR_WO_TRAILING_SLASH
166 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
167 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
170 #ifdef NO_STRUCT_ITIMERVAL
172 struct timeval it_interval
;
173 struct timeval it_value
;
178 #define setitimer(which,value,ovalue)
184 #define basename gitbasename
185 extern char *gitbasename(char *);
193 #include <openssl/ssl.h>
194 #include <openssl/err.h>
197 /* On most systems <limits.h> would have given us this, but
198 * not on some systems (e.g. GNU/Hurd).
201 #define PATH_MAX 4096
205 #define PRIuMAX "llu"
227 #ifndef _PATH_DEFPATH
228 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
231 #ifndef STRIP_EXTENSION
232 #define STRIP_EXTENSION ""
235 #ifndef has_dos_drive_prefix
236 #define has_dos_drive_prefix(path) 0
240 #define is_dir_sep(c) ((c) == '/')
243 #ifndef find_last_dir_sep
244 #define find_last_dir_sep(path) strrchr(path, '/')
247 #if defined(__HP_cc) && (__HP_cc >= 61000)
248 #define NORETURN __attribute__((noreturn))
250 #elif defined(__GNUC__) && !defined(NO_NORETURN)
251 #define NORETURN __attribute__((__noreturn__))
252 #define NORETURN_PTR __attribute__((__noreturn__))
253 #elif defined(_MSC_VER)
254 #define NORETURN __declspec(noreturn)
259 #ifndef __attribute__
260 #define __attribute__(x)
264 #include "compat/bswap.h"
266 /* General helper functions */
267 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
268 extern void vwritef(int fd
, const char *prefix
, const char *err
, va_list params
);
269 extern NORETURN
void usage(const char *err
);
270 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
271 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
272 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
273 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
274 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
276 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
277 extern void set_error_routine(void (*routine
)(const char *err
, va_list params
));
279 extern int prefixcmp(const char *str
, const char *prefix
);
280 extern int suffixcmp(const char *str
, const char *suffix
);
282 static inline const char *skip_prefix(const char *str
, const char *prefix
)
284 size_t len
= strlen(prefix
);
285 return strncmp(str
, prefix
, len
) ? NULL
: str
+ len
;
288 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
293 #define MAP_PRIVATE 1
296 #define mmap git_mmap
297 #define munmap git_munmap
298 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
299 extern int git_munmap(void *start
, size_t length
);
301 #else /* NO_MMAP || USE_WIN32_MMAP */
303 #include <sys/mman.h>
305 #endif /* NO_MMAP || USE_WIN32_MMAP */
309 /* This value must be multiple of (pagesize * 2) */
310 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
314 /* This value must be multiple of (pagesize * 2) */
315 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
316 (sizeof(void*) >= 8 \
317 ? 1 * 1024 * 1024 * 1024 \
323 #define MAP_FAILED ((void *)-1)
326 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
327 #define on_disk_bytes(st) ((st).st_size)
329 #define on_disk_bytes(st) ((st).st_blocks * 512)
332 #define DEFAULT_PACKED_GIT_LIMIT \
333 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
336 #define pread git_pread
337 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
340 * Forward decl that will remind us if its twin in cache.h changes.
341 * This function is used in compat/pread.c. But we can't include
344 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
347 #define setenv gitsetenv
348 extern int gitsetenv(const char *, const char *, int);
352 #define mkdtemp gitmkdtemp
353 extern char *gitmkdtemp(char *);
357 #define mkstemps gitmkstemps
358 extern int gitmkstemps(char *, int);
362 #define unsetenv gitunsetenv
363 extern void gitunsetenv(const char *);
367 #define strcasestr gitstrcasestr
368 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
372 #define strlcpy gitstrlcpy
373 extern size_t gitstrlcpy(char *, const char *, size_t);
377 #define strtoumax gitstrtoumax
378 extern uintmax_t gitstrtoumax(const char *, char **, int);
379 #define strtoimax gitstrtoimax
380 extern intmax_t gitstrtoimax(const char *, char **, int);
384 #define strtok_r gitstrtok_r
385 extern char *gitstrtok_r(char *s
, const char *delim
, char **save_ptr
);
389 #define hstrerror githstrerror
390 extern const char *githstrerror(int herror
);
394 #define memmem gitmemmem
395 void *gitmemmem(const void *haystack
, size_t haystacklen
,
396 const void *needle
, size_t needlelen
);
399 #ifdef FREAD_READS_DIRECTORIES
403 #define fopen(a,b) git_fopen(a,b)
404 extern FILE *git_fopen(const char*, const char*);
407 #ifdef SNPRINTF_RETURNS_BOGUS
408 #define snprintf git_snprintf
409 extern int git_snprintf(char *str
, size_t maxsize
,
410 const char *format
, ...);
411 #define vsnprintf git_vsnprintf
412 extern int git_vsnprintf(char *str
, size_t maxsize
,
413 const char *format
, va_list ap
);
416 #ifdef __GLIBC_PREREQ
417 #if __GLIBC_PREREQ(2, 1)
418 #define HAVE_STRCHRNUL
423 #ifndef HAVE_STRCHRNUL
424 #define strchrnul gitstrchrnul
425 static inline char *gitstrchrnul(const char *s
, int c
)
427 while (*s
&& *s
!= c
)
434 #define mempcpy gitmempcpy
435 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
437 return (char *)memcpy(dest
, src
, n
) + n
;
442 int inet_pton(int af
, const char *src
, void *dst
);
446 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
449 extern void release_pack_memory(size_t, int);
451 typedef void (*try_to_free_t
)(size_t);
452 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
454 extern char *xstrdup(const char *str
);
455 extern void *xmalloc(size_t size
);
456 extern void *xmallocz(size_t size
);
457 extern void *xmemdupz(const void *data
, size_t len
);
458 extern char *xstrndup(const char *str
, size_t len
);
459 extern void *xrealloc(void *ptr
, size_t size
);
460 extern void *xcalloc(size_t nmemb
, size_t size
);
461 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
462 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
463 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
464 extern int xdup(int fd
);
465 extern FILE *xfdopen(int fd
, const char *mode
);
466 extern int xmkstemp(char *template);
467 extern int xmkstemp_mode(char *template, int mode
);
468 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
469 extern int odb_pack_keep(char *name
, size_t namesz
, unsigned char *sha1
);
471 static inline size_t xsize_t(off_t len
)
473 if (len
> (size_t) len
)
474 die("Cannot handle files this big");
478 static inline int has_extension(const char *filename
, const char *ext
)
480 size_t len
= strlen(filename
);
481 size_t extlen
= strlen(ext
);
482 return len
> extlen
&& !memcmp(filename
+ len
- extlen
, ext
, extlen
);
485 /* in ctype.c, for kwset users */
486 extern const char tolower_trans_tbl
[256];
488 /* Sane ctype - no locale, and works with signed chars */
498 extern unsigned char sane_ctype
[256];
499 #define GIT_SPACE 0x01
500 #define GIT_DIGIT 0x02
501 #define GIT_ALPHA 0x04
502 #define GIT_GLOB_SPECIAL 0x08
503 #define GIT_REGEX_SPECIAL 0x10
504 #define GIT_PATHSPEC_MAGIC 0x20
505 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
506 #define isascii(x) (((x) & ~0x7f) == 0)
507 #define isspace(x) sane_istest(x,GIT_SPACE)
508 #define isdigit(x) sane_istest(x,GIT_DIGIT)
509 #define isalpha(x) sane_istest(x,GIT_ALPHA)
510 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
511 #define islower(x) sane_iscase(x, 1)
512 #define isupper(x) sane_iscase(x, 0)
513 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
514 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
515 #define tolower(x) sane_case((unsigned char)(x), 0x20)
516 #define toupper(x) sane_case((unsigned char)(x), 0)
517 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
519 static inline int sane_case(int x
, int high
)
521 if (sane_istest(x
, GIT_ALPHA
))
522 x
= (x
& ~0x20) | high
;
526 static inline int sane_iscase(int x
, int is_lower
)
528 if (!sane_istest(x
, GIT_ALPHA
))
532 return (x
& 0x20) != 0;
534 return (x
& 0x20) == 0;
537 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
543 ul
= strtoul(s
, &p
, base
);
544 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
550 static inline int strtol_i(char const *s
, int base
, int *result
)
556 ul
= strtol(s
, &p
, base
);
557 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
563 #ifdef INTERNAL_QSORT
564 void git_qsort(void *base
, size_t nmemb
, size_t size
,
565 int(*compar
)(const void *, const void *));
566 #define qsort git_qsort
569 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
570 # define FORCE_DIR_SET_GID S_ISGID
572 # define FORCE_DIR_SET_GID 0
577 #define ST_CTIME_NSEC(st) 0
578 #define ST_MTIME_NSEC(st) 0
580 #ifdef USE_ST_TIMESPEC
581 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
582 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
584 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
585 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
589 #ifdef UNRELIABLE_FSTAT
590 #define fstat_is_reliable() 0
592 #define fstat_is_reliable() 1
597 * Since an obvious implementation of va_list would be to make it a
598 * pointer into the stack frame, a simple assignment will work on
599 * many systems. But let's try to be more portable.
602 #define va_copy(dst, src) __va_copy(dst, src)
604 #define va_copy(dst, src) ((dst) = (src))
609 * Preserves errno, prints a message, but gives no warning for ENOENT.
610 * Always returns the return value of unlink(2).
612 int unlink_or_warn(const char *path
);
614 * Likewise for rmdir(2).
616 int rmdir_or_warn(const char *path
);
618 * Calls the correct function out of {unlink,rmdir}_or_warn based on
619 * the supplied file mode.
621 int remove_or_warn(unsigned int mode
, const char *path
);
623 /* Call access(2), but warn for any error besides ENOENT. */
624 int access_or_warn(const char *path
, int mode
);
626 /* Warn on an inaccessible file that ought to be accessible */
627 void warn_on_inaccessible(const char *path
);
629 /* Get the passwd entry for the UID of the current process. */
630 struct passwd
*xgetpwuid_self(void);