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 #ifndef NO_SYS_POLL_H
110 #include <sys/poll.h>
114 #include <sys/socket.h>
115 #include <sys/ioctl.h>
117 #ifndef NO_SYS_SELECT_H
118 #include <sys/select.h>
120 #include <netinet/in.h>
121 #include <netinet/tcp.h>
122 #include <arpa/inet.h>
125 #ifndef NO_INTTYPES_H
126 #include <inttypes.h>
130 #if defined(__CYGWIN__)
133 #define _XOPEN_SOURCE 600
134 #include "compat/cygwin.h"
136 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
138 #define _ALL_SOURCE 1
140 #else /* __MINGW32__ */
141 /* pull in Windows compatibility stuff */
142 #include "compat/mingw.h"
143 #endif /* __MINGW32__ */
145 #include "compat/msvc.h"
151 #define basename gitbasename
152 extern char *gitbasename(char *);
160 #include <openssl/ssl.h>
161 #include <openssl/err.h>
164 /* On most systems <limits.h> would have given us this, but
165 * not on some systems (e.g. GNU/Hurd).
168 #define PATH_MAX 4096
172 #define PRIuMAX "llu"
194 #ifndef _PATH_DEFPATH
195 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
198 #ifndef STRIP_EXTENSION
199 #define STRIP_EXTENSION ""
202 #ifndef has_dos_drive_prefix
203 #define has_dos_drive_prefix(path) 0
207 #define is_dir_sep(c) ((c) == '/')
211 #define NORETURN __attribute__((__noreturn__))
212 #define NORETURN_PTR __attribute__((__noreturn__))
213 #elif defined(_MSC_VER)
214 #define NORETURN __declspec(noreturn)
219 #ifndef __attribute__
220 #define __attribute__(x)
224 #include "compat/bswap.h"
226 /* General helper functions */
227 extern void vreportf(const char *prefix, const char *err, va_list params);
228 extern NORETURN void usage(const char *err);
229 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
230 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
231 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
232 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
233 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
235 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
237 extern int prefixcmp(const char *str, const char *prefix);
238 extern int suffixcmp(const char *str, const char *suffix);
240 static inline const char *skip_prefix(const char *str, const char *prefix)
242 size_t len = strlen(prefix);
243 return strncmp(str, prefix, len) ? NULL : str + len;
246 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
251 #define MAP_PRIVATE 1
254 #define mmap git_mmap
255 #define munmap git_munmap
256 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
257 extern int git_munmap(void *start, size_t length);
259 #else /* NO_MMAP || USE_WIN32_MMAP */
261 #include <sys/mman.h>
263 #endif /* NO_MMAP || USE_WIN32_MMAP */
267 /* This value must be multiple of (pagesize * 2) */
268 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
272 /* This value must be multiple of (pagesize * 2) */
273 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
274 (sizeof(void*) >= 8 \
275 ? 1 * 1024 * 1024 * 1024 \
281 #define MAP_FAILED ((void *)-1)
284 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
285 #define on_disk_bytes(st) ((st).st_size)
287 #define on_disk_bytes(st) ((st).st_blocks * 512)
290 #define DEFAULT_PACKED_GIT_LIMIT \
291 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
294 #define pread git_pread
295 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
298 * Forward decl that will remind us if its twin in cache.h changes.
299 * This function is used in compat/pread.c. But we can't include
302 extern ssize_t read_in_full(int fd, void *buf, size_t count);
305 #define setenv gitsetenv
306 extern int gitsetenv(const char *, const char *, int);
310 #define mkdtemp gitmkdtemp
311 extern char *gitmkdtemp(char *);
315 #define mkstemps gitmkstemps
316 extern int gitmkstemps(char *, int);
320 #define unsetenv gitunsetenv
321 extern void gitunsetenv(const char *);
325 #define strcasestr gitstrcasestr
326 extern char *gitstrcasestr(const char *haystack, const char *needle);
330 #define strlcpy gitstrlcpy
331 extern size_t gitstrlcpy(char *, const char *, size_t);
335 #define strtoumax gitstrtoumax
336 extern uintmax_t gitstrtoumax(const char *, char **, int);
340 #define strtok_r gitstrtok_r
341 extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
345 #define hstrerror githstrerror
346 extern const char *githstrerror(int herror);
350 #define memmem gitmemmem
351 void *gitmemmem(const void *haystack, size_t haystacklen,
352 const void *needle, size_t needlelen);
355 #ifdef FREAD_READS_DIRECTORIES
359 #define fopen(a,b) git_fopen(a,b)
360 extern FILE *git_fopen(const char*, const char*);
363 #ifdef SNPRINTF_RETURNS_BOGUS
364 #define snprintf git_snprintf
365 extern int git_snprintf(char *str, size_t maxsize,
366 const char *format, ...);
367 #define vsnprintf git_vsnprintf
368 extern int git_vsnprintf(char *str, size_t maxsize,
369 const char *format, va_list ap);
372 #ifdef __GLIBC_PREREQ
373 #if __GLIBC_PREREQ(2, 1)
374 #define HAVE_STRCHRNUL
379 #ifndef HAVE_STRCHRNUL
380 #define strchrnul gitstrchrnul
381 static inline char *gitstrchrnul(const char *s, int c)
383 while (*s && *s != c)
390 #define mempcpy gitmempcpy
391 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
393 return (char *)memcpy(dest, src, n) + n;
397 extern void release_pack_memory(size_t, int);
399 typedef void (*try_to_free_t)(size_t);
400 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
402 extern char *xstrdup(const char *str);
403 extern void *xmalloc(size_t size);
404 extern void *xmallocz(size_t size);
405 extern void *xmemdupz(const void *data, size_t len);
406 extern char *xstrndup(const char *str, size_t len);
407 extern void *xrealloc(void *ptr, size_t size);
408 extern void *xcalloc(size_t nmemb, size_t size);
409 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
410 extern ssize_t xread(int fd, void *buf, size_t len);
411 extern ssize_t xwrite(int fd, const void *buf, size_t len);
412 extern int xdup(int fd);
413 extern FILE *xfdopen(int fd, const char *mode);
414 extern int xmkstemp(char *template);
415 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
416 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
418 static inline size_t xsize_t(off_t len)
420 if (len > (size_t) len)
421 die("Cannot handle files this big");
425 static inline int has_extension(const char *filename, const char *ext)
427 size_t len = strlen(filename);
428 size_t extlen = strlen(ext);
429 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
432 /* Sane ctype - no locale, and works with signed chars */
440 extern unsigned char sane_ctype[256];
441 #define GIT_SPACE 0x01
442 #define GIT_DIGIT 0x02
443 #define GIT_ALPHA 0x04
444 #define GIT_GLOB_SPECIAL 0x08
445 #define GIT_REGEX_SPECIAL 0x10
446 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
447 #define isascii(x) (((x) & ~0x7f) == 0)
448 #define isspace(x) sane_istest(x,GIT_SPACE)
449 #define isdigit(x) sane_istest(x,GIT_DIGIT)
450 #define isalpha(x) sane_istest(x,GIT_ALPHA)
451 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
452 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
453 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
454 #define tolower(x) sane_case((unsigned char)(x), 0x20)
455 #define toupper(x) sane_case((unsigned char)(x), 0)
457 static inline int sane_case(int x, int high)
459 if (sane_istest(x, GIT_ALPHA))
460 x = (x & ~0x20) | high;
464 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
470 ul = strtoul(s, &p, base);
471 if (errno || *p || p == s || (unsigned int) ul != ul)
477 static inline int strtol_i(char const *s, int base, int *result)
483 ul = strtol(s, &p, base);
484 if (errno || *p || p == s || (int) ul != ul)
490 #ifdef INTERNAL_QSORT
491 void git_qsort(void *base, size_t nmemb, size_t size,
492 int(*compar)(const void *, const void *));
493 #define qsort git_qsort
496 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
497 # define FORCE_DIR_SET_GID S_ISGID
499 # define FORCE_DIR_SET_GID 0
504 #define ST_CTIME_NSEC(st) 0
505 #define ST_MTIME_NSEC(st) 0
507 #ifdef USE_ST_TIMESPEC
508 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
509 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
511 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
512 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
516 #ifdef UNRELIABLE_FSTAT
517 #define fstat_is_reliable() 0
519 #define fstat_is_reliable() 1
523 * Preserves errno, prints a message, but gives no warning for ENOENT.
524 * Always returns the return value of unlink(2).
526 int unlink_or_warn(const char *path);
528 * Likewise for rmdir(2).
530 int rmdir_or_warn(const char *path);
532 * Calls the correct function out of {unlink,rmdir}_or_warn based on
533 * the supplied file mode.
535 int remove_or_warn(unsigned int mode, const char *path);