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_WINNT 0x0501
90 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
103 #ifdef __TANDEM /* or HAVE_STRINGS_H or !NO_STRINGS_H? */
104 #include <strings.h> /* for strcasecmp() */
108 #include <sys/param.h>
109 #include <sys/types.h>
111 #include <sys/time.h>
119 #ifndef NO_SYS_POLL_H
120 #include <sys/poll.h>
124 #if defined(__MINGW32__)
125 /* pull in Windows compatibility stuff */
126 #include "compat/mingw.h"
127 #elif defined(_MSC_VER)
128 #include "compat/msvc.h"
130 #include <sys/wait.h>
131 #include <sys/resource.h>
132 #include <sys/socket.h>
133 #include <sys/ioctl.h>
135 #ifndef NO_SYS_SELECT_H
136 #include <sys/select.h>
138 #include <netinet/in.h>
139 #include <netinet/tcp.h>
140 #include <arpa/inet.h>
144 #ifndef NO_INTTYPES_H
145 #include <inttypes.h>
151 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
152 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
153 * while on IP16 and IP16L32 it is "int" (resp. "short")
154 * Size needs to match (or exceed) 'sizeof(void *)'.
155 * We can't take "long long" here as not everybody has it.
157 typedef long intptr_t;
158 typedef unsigned long uintptr_t;
160 #if defined(__CYGWIN__)
163 #define _XOPEN_SOURCE 600
164 #include "compat/cygwin.h"
166 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
168 #define _ALL_SOURCE 1
172 /* used on Mac OS X */
173 #ifdef PRECOMPOSE_UNICODE
174 #include "compat/precompose_utf8.h"
176 #define precompose_str(in,i_nfd2nfc)
177 #define precompose_argv(c,v)
178 #define probe_utf8_pathname_composition(a,b)
181 #ifdef MKDIR_WO_TRAILING_SLASH
182 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
183 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t
);
186 #ifdef NO_STRUCT_ITIMERVAL
188 struct timeval it_interval
;
189 struct timeval it_value
;
194 #define setitimer(which,value,ovalue)
200 #define basename gitbasename
201 extern char *gitbasename(char *);
209 #include <openssl/ssl.h>
210 #include <openssl/err.h>
213 /* On most systems <limits.h> would have given us this, but
214 * not on some systems (e.g. GNU/Hurd).
217 #define PATH_MAX 4096
221 #define PRIuMAX "llu"
243 #ifndef _PATH_DEFPATH
244 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
247 #ifndef STRIP_EXTENSION
248 #define STRIP_EXTENSION ""
251 #ifndef has_dos_drive_prefix
252 #define has_dos_drive_prefix(path) 0
255 #ifndef offset_1st_component
256 #define offset_1st_component(path) (is_dir_sep((path)[0]))
260 #define is_dir_sep(c) ((c) == '/')
263 #ifndef find_last_dir_sep
264 #define find_last_dir_sep(path) strrchr(path, '/')
267 #if defined(__HP_cc) && (__HP_cc >= 61000)
268 #define NORETURN __attribute__((noreturn))
270 #elif defined(__GNUC__) && !defined(NO_NORETURN)
271 #define NORETURN __attribute__((__noreturn__))
272 #define NORETURN_PTR __attribute__((__noreturn__))
273 #elif defined(_MSC_VER)
274 #define NORETURN __declspec(noreturn)
279 #ifndef __attribute__
280 #define __attribute__(x)
284 #include "compat/bswap.h"
286 /* General helper functions */
287 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
288 extern void vwritef(int fd
, const char *prefix
, const char *err
, va_list params
);
289 extern NORETURN
void usage(const char *err
);
290 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
291 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
292 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
293 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
294 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
296 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
297 extern void set_error_routine(void (*routine
)(const char *err
, va_list params
));
299 extern int prefixcmp(const char *str
, const char *prefix
);
300 extern int suffixcmp(const char *str
, const char *suffix
);
302 static inline const char *skip_prefix(const char *str
, const char *prefix
)
304 size_t len
= strlen(prefix
);
305 return strncmp(str
, prefix
, len
) ? NULL
: str
+ len
;
308 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
313 #define MAP_PRIVATE 1
316 #define mmap git_mmap
317 #define munmap git_munmap
318 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
319 extern int git_munmap(void *start
, size_t length
);
321 #else /* NO_MMAP || USE_WIN32_MMAP */
323 #include <sys/mman.h>
325 #endif /* NO_MMAP || USE_WIN32_MMAP */
329 /* This value must be multiple of (pagesize * 2) */
330 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
334 /* This value must be multiple of (pagesize * 2) */
335 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
336 (sizeof(void*) >= 8 \
337 ? 1 * 1024 * 1024 * 1024 \
343 #define MAP_FAILED ((void *)-1)
346 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
347 #define on_disk_bytes(st) ((st).st_size)
349 #define on_disk_bytes(st) ((st).st_blocks * 512)
352 #define DEFAULT_PACKED_GIT_LIMIT \
353 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
356 #define pread git_pread
357 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
360 * Forward decl that will remind us if its twin in cache.h changes.
361 * This function is used in compat/pread.c. But we can't include
364 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
367 #define setenv gitsetenv
368 extern int gitsetenv(const char *, const char *, int);
372 #define mkdtemp gitmkdtemp
373 extern char *gitmkdtemp(char *);
377 #define mkstemps gitmkstemps
378 extern int gitmkstemps(char *, int);
382 #define unsetenv gitunsetenv
383 extern void gitunsetenv(const char *);
387 #define strcasestr gitstrcasestr
388 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
392 #define strlcpy gitstrlcpy
393 extern size_t gitstrlcpy(char *, const char *, size_t);
397 #define strtoumax gitstrtoumax
398 extern uintmax_t gitstrtoumax(const char *, char **, int);
399 #define strtoimax gitstrtoimax
400 extern intmax_t gitstrtoimax(const char *, char **, int);
404 #define strtok_r gitstrtok_r
405 extern char *gitstrtok_r(char *s
, const char *delim
, char **save_ptr
);
409 #define hstrerror githstrerror
410 extern const char *githstrerror(int herror
);
414 #define memmem gitmemmem
415 void *gitmemmem(const void *haystack
, size_t haystacklen
,
416 const void *needle
, size_t needlelen
);
419 #ifdef FREAD_READS_DIRECTORIES
423 #define fopen(a,b) git_fopen(a,b)
424 extern FILE *git_fopen(const char*, const char*);
427 #ifdef SNPRINTF_RETURNS_BOGUS
428 #define snprintf git_snprintf
429 extern int git_snprintf(char *str
, size_t maxsize
,
430 const char *format
, ...);
431 #define vsnprintf git_vsnprintf
432 extern int git_vsnprintf(char *str
, size_t maxsize
,
433 const char *format
, va_list ap
);
436 #ifdef __GLIBC_PREREQ
437 #if __GLIBC_PREREQ(2, 1)
438 #define HAVE_STRCHRNUL
443 #ifndef HAVE_STRCHRNUL
444 #define strchrnul gitstrchrnul
445 static inline char *gitstrchrnul(const char *s
, int c
)
447 while (*s
&& *s
!= c
)
454 #define mempcpy gitmempcpy
455 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
457 return (char *)memcpy(dest
, src
, n
) + n
;
462 int inet_pton(int af
, const char *src
, void *dst
);
466 const char *inet_ntop(int af
, const void *src
, char *dst
, size_t size
);
469 extern void release_pack_memory(size_t, int);
471 typedef void (*try_to_free_t
)(size_t);
472 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
474 extern char *xstrdup(const char *str
);
475 extern void *xmalloc(size_t size
);
476 extern void *xmallocz(size_t size
);
477 extern void *xmemdupz(const void *data
, size_t len
);
478 extern char *xstrndup(const char *str
, size_t len
);
479 extern void *xrealloc(void *ptr
, size_t size
);
480 extern void *xcalloc(size_t nmemb
, size_t size
);
481 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
482 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
483 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
484 extern int xdup(int fd
);
485 extern FILE *xfdopen(int fd
, const char *mode
);
486 extern int xmkstemp(char *template);
487 extern int xmkstemp_mode(char *template, int mode
);
488 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
489 extern int odb_pack_keep(char *name
, size_t namesz
, unsigned char *sha1
);
491 static inline size_t xsize_t(off_t len
)
493 if (len
> (size_t) len
)
494 die("Cannot handle files this big");
498 static inline int has_extension(const char *filename
, const char *ext
)
500 size_t len
= strlen(filename
);
501 size_t extlen
= strlen(ext
);
502 return len
> extlen
&& !memcmp(filename
+ len
- extlen
, ext
, extlen
);
505 /* in ctype.c, for kwset users */
506 extern const char tolower_trans_tbl
[256];
508 /* Sane ctype - no locale, and works with signed chars */
519 extern unsigned char sane_ctype
[256];
520 #define GIT_SPACE 0x01
521 #define GIT_DIGIT 0x02
522 #define GIT_ALPHA 0x04
523 #define GIT_GLOB_SPECIAL 0x08
524 #define GIT_REGEX_SPECIAL 0x10
525 #define GIT_PATHSPEC_MAGIC 0x20
526 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
527 #define isascii(x) (((x) & ~0x7f) == 0)
528 #define isspace(x) sane_istest(x,GIT_SPACE)
529 #define isdigit(x) sane_istest(x,GIT_DIGIT)
530 #define isalpha(x) sane_istest(x,GIT_ALPHA)
531 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
532 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
533 #define islower(x) sane_iscase(x, 1)
534 #define isupper(x) sane_iscase(x, 0)
535 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
536 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
537 #define tolower(x) sane_case((unsigned char)(x), 0x20)
538 #define toupper(x) sane_case((unsigned char)(x), 0)
539 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
541 static inline int sane_case(int x
, int high
)
543 if (sane_istest(x
, GIT_ALPHA
))
544 x
= (x
& ~0x20) | high
;
548 static inline int sane_iscase(int x
, int is_lower
)
550 if (!sane_istest(x
, GIT_ALPHA
))
554 return (x
& 0x20) != 0;
556 return (x
& 0x20) == 0;
559 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
565 ul
= strtoul(s
, &p
, base
);
566 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
572 static inline int strtol_i(char const *s
, int base
, int *result
)
578 ul
= strtol(s
, &p
, base
);
579 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
585 #ifdef INTERNAL_QSORT
586 void git_qsort(void *base
, size_t nmemb
, size_t size
,
587 int(*compar
)(const void *, const void *));
588 #define qsort git_qsort
591 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
592 # define FORCE_DIR_SET_GID S_ISGID
594 # define FORCE_DIR_SET_GID 0
599 #define ST_CTIME_NSEC(st) 0
600 #define ST_MTIME_NSEC(st) 0
602 #ifdef USE_ST_TIMESPEC
603 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
604 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
606 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
607 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
611 #ifdef UNRELIABLE_FSTAT
612 #define fstat_is_reliable() 0
614 #define fstat_is_reliable() 1
619 * Since an obvious implementation of va_list would be to make it a
620 * pointer into the stack frame, a simple assignment will work on
621 * many systems. But let's try to be more portable.
624 #define va_copy(dst, src) __va_copy(dst, src)
626 #define va_copy(dst, src) ((dst) = (src))
631 * Preserves errno, prints a message, but gives no warning for ENOENT.
632 * Always returns the return value of unlink(2).
634 int unlink_or_warn(const char *path
);
636 * Likewise for rmdir(2).
638 int rmdir_or_warn(const char *path
);
640 * Calls the correct function out of {unlink,rmdir}_or_warn based on
641 * the supplied file mode.
643 int remove_or_warn(unsigned int mode
, const char *path
);
646 * Call access(2), but warn for any error except "missing file"
647 * (ENOENT or ENOTDIR).
649 int access_or_warn(const char *path
, int mode
);
650 int access_or_die(const char *path
, int mode
);
652 /* Warn on an inaccessible file that ought to be accessible */
653 void warn_on_inaccessible(const char *path
);
655 /* Get the passwd entry for the UID of the current process. */
656 struct passwd
*xgetpwuid_self(void);
658 #ifndef mark_as_git_dir
659 #define mark_as_git_dir(x) /* noop */
662 #ifndef get_home_directory
663 #define get_home_directory() getenv("HOME")