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)))
35 * Signed integer overflow is undefined in C, so here's a helper macro
36 * to detect if the sum of two integers will overflow.
38 * Requires: a >= 0, typeof(a) equals typeof(b)
40 #define signed_add_overflows(a, b) \
41 ((b) > maximum_signed_value_of_type(a) - (a))
44 #define TYPEOF(x) (__typeof__(x))
49 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
50 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
52 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
54 /* Approximation of the length of the decimal representation of this type. */
55 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
59 * On Solaris, when _XOPEN_EXTENDED is set, its header file
60 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
61 * setting to say we are XPG5 or XPG6. Also on Solaris,
62 * XPG6 programs must be compiled with a c99 compiler, while
63 * non XPG6 programs must be compiled with a pre-c99 compiler.
65 # if __STDC_VERSION__ - 0 >= 199901L
66 # define _XOPEN_SOURCE 600
68 # define _XOPEN_SOURCE 500
70 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
71 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
72 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
73 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
78 #define _NETBSD_SOURCE 1
81 #ifdef WIN32 /* Both MinGW and MSVC */
82 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
97 #include <sys/param.h>
98 #include <sys/types.h>
100 #include <sys/time.h>
108 #include <sys/wait.h>
109 #include <sys/poll.h>
110 #include <sys/socket.h>
111 #include <sys/ioctl.h>
113 #ifndef NO_SYS_SELECT_H
114 #include <sys/select.h>
116 #include <netinet/in.h>
117 #include <netinet/tcp.h>
118 #include <arpa/inet.h>
121 #include <inttypes.h>
122 #if defined(__CYGWIN__)
125 #define _XOPEN_SOURCE 600
126 #include "compat/cygwin.h"
128 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
130 #define _ALL_SOURCE 1
132 #else /* __MINGW32__ */
133 /* pull in Windows compatibility stuff */
134 #include "compat/mingw.h"
135 #endif /* __MINGW32__ */
137 #include "compat/msvc.h"
143 #define basename gitbasename
144 extern char *gitbasename(char *);
152 #include <openssl/ssl.h>
153 #include <openssl/err.h>
156 /* On most systems <limits.h> would have given us this, but
157 * not on some systems (e.g. GNU/Hurd).
160 #define PATH_MAX 4096
164 #define PRIuMAX "llu"
186 #ifndef _PATH_DEFPATH
187 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
190 #ifndef STRIP_EXTENSION
191 #define STRIP_EXTENSION ""
194 #ifndef has_dos_drive_prefix
195 #define has_dos_drive_prefix(path) 0
198 #ifndef offset_1st_component
199 #define offset_1st_component(path) (is_dir_sep((path)[0]))
203 #define is_dir_sep(c) ((c) == '/')
207 #define NORETURN __attribute__((__noreturn__))
208 #define NORETURN_PTR __attribute__((__noreturn__))
209 #elif defined(_MSC_VER)
210 #define NORETURN __declspec(noreturn)
215 #ifndef __attribute__
216 #define __attribute__(x)
220 #include "compat/bswap.h"
222 /* General helper functions */
223 extern void vreportf(const char *prefix
, const char *err
, va_list params
);
224 extern NORETURN
void usage(const char *err
);
225 extern NORETURN
void usagef(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
226 extern NORETURN
void die(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
227 extern NORETURN
void die_errno(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
228 extern int error(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
229 extern void warning(const char *err
, ...) __attribute__((format (printf
, 1, 2)));
231 extern void set_die_routine(NORETURN_PTR
void (*routine
)(const char *err
, va_list params
));
233 extern int prefixcmp(const char *str
, const char *prefix
);
234 extern int suffixcmp(const char *str
, const char *suffix
);
236 static inline const char *skip_prefix(const char *str
, const char *prefix
)
238 size_t len
= strlen(prefix
);
239 return strncmp(str
, prefix
, len
) ? NULL
: str
+ len
;
242 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
247 #define MAP_PRIVATE 1
250 #define mmap git_mmap
251 #define munmap git_munmap
252 extern void *git_mmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
253 extern int git_munmap(void *start
, size_t length
);
255 #else /* NO_MMAP || USE_WIN32_MMAP */
257 #include <sys/mman.h>
259 #endif /* NO_MMAP || USE_WIN32_MMAP */
263 /* This value must be multiple of (pagesize * 2) */
264 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
268 /* This value must be multiple of (pagesize * 2) */
269 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
270 (sizeof(void*) >= 8 \
271 ? 1 * 1024 * 1024 * 1024 \
277 #define MAP_FAILED ((void *)-1)
280 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
281 #define on_disk_bytes(st) ((st).st_size)
283 #define on_disk_bytes(st) ((st).st_blocks * 512)
286 #define DEFAULT_PACKED_GIT_LIMIT \
287 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
290 #define pread git_pread
291 extern ssize_t
git_pread(int fd
, void *buf
, size_t count
, off_t offset
);
294 * Forward decl that will remind us if its twin in cache.h changes.
295 * This function is used in compat/pread.c. But we can't include
298 extern ssize_t
read_in_full(int fd
, void *buf
, size_t count
);
301 #define setenv gitsetenv
302 extern int gitsetenv(const char *, const char *, int);
306 #define mkdtemp gitmkdtemp
307 extern char *gitmkdtemp(char *);
311 #define mkstemps gitmkstemps
312 extern int gitmkstemps(char *, int);
316 #define unsetenv gitunsetenv
317 extern void gitunsetenv(const char *);
321 #define strcasestr gitstrcasestr
322 extern char *gitstrcasestr(const char *haystack
, const char *needle
);
326 #define strlcpy gitstrlcpy
327 extern size_t gitstrlcpy(char *, const char *, size_t);
331 #define strtoumax gitstrtoumax
332 extern uintmax_t gitstrtoumax(const char *, char **, int);
336 #define strtok_r gitstrtok_r
337 extern char *gitstrtok_r(char *s
, const char *delim
, char **save_ptr
);
341 #define hstrerror githstrerror
342 extern const char *githstrerror(int herror
);
346 #define memmem gitmemmem
347 void *gitmemmem(const void *haystack
, size_t haystacklen
,
348 const void *needle
, size_t needlelen
);
351 #ifdef FREAD_READS_DIRECTORIES
355 #define fopen(a,b) git_fopen(a,b)
356 extern FILE *git_fopen(const char*, const char*);
359 #ifdef SNPRINTF_RETURNS_BOGUS
360 #define snprintf git_snprintf
361 extern int git_snprintf(char *str
, size_t maxsize
,
362 const char *format
, ...);
363 #define vsnprintf git_vsnprintf
364 extern int git_vsnprintf(char *str
, size_t maxsize
,
365 const char *format
, va_list ap
);
368 #ifdef __GLIBC_PREREQ
369 #if __GLIBC_PREREQ(2, 1)
370 #define HAVE_STRCHRNUL
375 #ifndef HAVE_STRCHRNUL
376 #define strchrnul gitstrchrnul
377 static inline char *gitstrchrnul(const char *s
, int c
)
379 while (*s
&& *s
!= c
)
386 #define mempcpy gitmempcpy
387 static inline void *gitmempcpy(void *dest
, const void *src
, size_t n
)
389 return (char *)memcpy(dest
, src
, n
) + n
;
393 extern void release_pack_memory(size_t, int);
395 typedef void (*try_to_free_t
)(size_t);
396 extern try_to_free_t
set_try_to_free_routine(try_to_free_t
);
398 extern char *xstrdup(const char *str
);
399 extern void *xmalloc(size_t size
);
400 extern void *xmallocz(size_t size
);
401 extern void *xmemdupz(const void *data
, size_t len
);
402 extern char *xstrndup(const char *str
, size_t len
);
403 extern void *xrealloc(void *ptr
, size_t size
);
404 extern void *xcalloc(size_t nmemb
, size_t size
);
405 extern void *xmmap(void *start
, size_t length
, int prot
, int flags
, int fd
, off_t offset
);
406 extern ssize_t
xread(int fd
, void *buf
, size_t len
);
407 extern ssize_t
xwrite(int fd
, const void *buf
, size_t len
);
408 extern int xdup(int fd
);
409 extern FILE *xfdopen(int fd
, const char *mode
);
410 extern int xmkstemp(char *template);
411 extern int odb_mkstemp(char *template, size_t limit
, const char *pattern
);
412 extern int odb_pack_keep(char *name
, size_t namesz
, unsigned char *sha1
);
414 static inline size_t xsize_t(off_t len
)
416 if (len
> (size_t) len
)
417 die("Cannot handle files this big");
421 static inline int has_extension(const char *filename
, const char *ext
)
423 size_t len
= strlen(filename
);
424 size_t extlen
= strlen(ext
);
425 return len
> extlen
&& !memcmp(filename
+ len
- extlen
, ext
, extlen
);
428 /* Sane ctype - no locale, and works with signed chars */
436 extern unsigned char sane_ctype
[256];
437 #define GIT_SPACE 0x01
438 #define GIT_DIGIT 0x02
439 #define GIT_ALPHA 0x04
440 #define GIT_GLOB_SPECIAL 0x08
441 #define GIT_REGEX_SPECIAL 0x10
442 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
443 #define isascii(x) (((x) & ~0x7f) == 0)
444 #define isspace(x) sane_istest(x,GIT_SPACE)
445 #define isdigit(x) sane_istest(x,GIT_DIGIT)
446 #define isalpha(x) sane_istest(x,GIT_ALPHA)
447 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
448 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
449 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
450 #define tolower(x) sane_case((unsigned char)(x), 0x20)
451 #define toupper(x) sane_case((unsigned char)(x), 0)
453 static inline int sane_case(int x
, int high
)
455 if (sane_istest(x
, GIT_ALPHA
))
456 x
= (x
& ~0x20) | high
;
460 static inline int strtoul_ui(char const *s
, int base
, unsigned int *result
)
466 ul
= strtoul(s
, &p
, base
);
467 if (errno
|| *p
|| p
== s
|| (unsigned int) ul
!= ul
)
473 static inline int strtol_i(char const *s
, int base
, int *result
)
479 ul
= strtol(s
, &p
, base
);
480 if (errno
|| *p
|| p
== s
|| (int) ul
!= ul
)
486 #ifdef INTERNAL_QSORT
487 void git_qsort(void *base
, size_t nmemb
, size_t size
,
488 int(*compar
)(const void *, const void *));
489 #define qsort git_qsort
492 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
493 # define FORCE_DIR_SET_GID S_ISGID
495 # define FORCE_DIR_SET_GID 0
500 #define ST_CTIME_NSEC(st) 0
501 #define ST_MTIME_NSEC(st) 0
503 #ifdef USE_ST_TIMESPEC
504 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
505 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
507 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
508 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
512 #ifdef UNRELIABLE_FSTAT
513 #define fstat_is_reliable() 0
515 #define fstat_is_reliable() 1
519 * Preserves errno, prints a message, but gives no warning for ENOENT.
520 * Always returns the return value of unlink(2).
522 int unlink_or_warn(const char *path
);
524 * Likewise for rmdir(2).
526 int rmdir_or_warn(const char *path
);
528 * Calls the correct function out of {unlink,rmdir}_or_warn based on
529 * the supplied file mode.
531 int remove_or_warn(unsigned int mode
, const char *path
);
533 #ifndef mark_as_git_dir
534 #define mark_as_git_dir(x) /* noop */
537 #ifndef get_home_directory
538 #define get_home_directory() getenv("HOME")