MSVC: fix poll-related macro redefines
[git/dscho.git] / git-compat-util.h
blob76c5eef420982189b55f87d69484bf445f02ff72
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
6 #ifndef FLEX_ARRAY
7 /*
8 * See if our compiler is known to support flexible array members.
9 */
10 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
11 # define FLEX_ARRAY /* empty */
12 #elif defined(__GNUC__)
13 # if (__GNUC__ >= 3)
14 # define FLEX_ARRAY /* empty */
15 # else
16 # define FLEX_ARRAY 0 /* older GNU extension */
17 # endif
18 #endif
21 * Otherwise, default to safer but a bit wasteful traditional style
23 #ifndef FLEX_ARRAY
24 # define FLEX_ARRAY 1
25 #endif
26 #endif
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))
49 #ifdef __GNUC__
50 #define TYPEOF(x) (__typeof__(x))
51 #else
52 #define TYPEOF(x)
53 #endif
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)
63 #if defined(__sun__)
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
73 # else
74 # define _XOPEN_SOURCE 500
75 # endif
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 */
80 #endif
81 #define _ALL_SOURCE 1
82 #define _GNU_SOURCE 1
83 #define _BSD_SOURCE 1
84 #define _NETBSD_SOURCE 1
85 #define _SGI_SOURCE 1
87 #ifdef WIN32 /* Both MinGW and MSVC */
88 #define _WIN32_WINNT 0x0501
89 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
90 #include <winsock2.h>
91 #include <windows.h>
92 #endif
94 #include <unistd.h>
95 #include <stdio.h>
96 #include <sys/stat.h>
97 #include <fcntl.h>
98 #include <stddef.h>
99 #include <stdlib.h>
100 #include <stdarg.h>
101 #include <string.h>
102 #include <errno.h>
103 #include <limits.h>
104 #include <sys/param.h>
105 #include <sys/types.h>
106 #include <dirent.h>
107 #include <sys/time.h>
108 #include <time.h>
109 #include <signal.h>
110 #include <fnmatch.h>
111 #include <assert.h>
112 #include <regex.h>
113 #include <utime.h>
114 #include <syslog.h>
115 #ifndef NO_SYS_POLL_H
116 #include <sys/poll.h>
117 #else
118 #include <poll.h>
119 #endif
120 #if defined(__MINGW32__)
121 /* pull in Windows compatibility stuff */
122 #include "compat/mingw.h"
123 #elif defined(_MSC_VER)
124 #include "compat/msvc.h"
125 #else
126 #include <sys/wait.h>
127 #include <sys/resource.h>
128 #include <sys/socket.h>
129 #include <sys/ioctl.h>
130 #include <termios.h>
131 #ifndef NO_SYS_SELECT_H
132 #include <sys/select.h>
133 #endif
134 #include <netinet/in.h>
135 #include <netinet/tcp.h>
136 #include <arpa/inet.h>
137 #include <netdb.h>
138 #include <pwd.h>
139 #include <sys/un.h>
140 #ifndef NO_INTTYPES_H
141 #include <inttypes.h>
142 #else
143 #include <stdint.h>
144 #endif
145 #if defined(__CYGWIN__)
146 #undef _XOPEN_SOURCE
147 #include <grp.h>
148 #define _XOPEN_SOURCE 600
149 #include "compat/cygwin.h"
150 #else
151 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
152 #include <grp.h>
153 #define _ALL_SOURCE 1
154 #endif
155 #endif
157 #ifndef NO_LIBGEN_H
158 #include <libgen.h>
159 #else
160 #define basename gitbasename
161 extern char *gitbasename(char *);
162 #endif
164 #ifndef NO_ICONV
165 #include <iconv.h>
166 #endif
168 #ifndef NO_OPENSSL
169 #include <openssl/ssl.h>
170 #include <openssl/err.h>
171 #endif
173 /* On most systems <limits.h> would have given us this, but
174 * not on some systems (e.g. GNU/Hurd).
176 #ifndef PATH_MAX
177 #define PATH_MAX 4096
178 #endif
180 #ifndef PRIuMAX
181 #define PRIuMAX "llu"
182 #endif
184 #ifndef PRIu32
185 #define PRIu32 "u"
186 #endif
188 #ifndef PRIx32
189 #define PRIx32 "x"
190 #endif
192 #ifndef PRIo32
193 #define PRIo32 "o"
194 #endif
196 #ifndef PATH_SEP
197 #define PATH_SEP ':'
198 #endif
200 #ifdef HAVE_PATHS_H
201 #include <paths.h>
202 #endif
203 #ifndef _PATH_DEFPATH
204 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
205 #endif
207 #ifndef STRIP_EXTENSION
208 #define STRIP_EXTENSION ""
209 #endif
211 #ifndef has_dos_drive_prefix
212 #define has_dos_drive_prefix(path) 0
213 #endif
215 #ifndef offset_1st_component
216 #define offset_1st_component(path) (is_dir_sep((path)[0]))
217 #endif
219 #ifndef is_dir_sep
220 #define is_dir_sep(c) ((c) == '/')
221 #endif
223 #ifndef find_last_dir_sep
224 #define find_last_dir_sep(path) strrchr(path, '/')
225 #endif
227 #if defined(__HP_cc) && (__HP_cc >= 61000)
228 #define NORETURN __attribute__((noreturn))
229 #define NORETURN_PTR
230 #elif defined(__GNUC__) && !defined(NO_NORETURN)
231 #define NORETURN __attribute__((__noreturn__))
232 #define NORETURN_PTR __attribute__((__noreturn__))
233 #elif defined(_MSC_VER)
234 #define NORETURN __declspec(noreturn)
235 #define NORETURN_PTR
236 #else
237 #define NORETURN
238 #define NORETURN_PTR
239 #ifndef __attribute__
240 #define __attribute__(x)
241 #endif
242 #endif
244 #include "compat/bswap.h"
246 /* General helper functions */
247 extern void vreportf(const char *prefix, const char *err, va_list params);
248 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
249 extern NORETURN void usage(const char *err);
250 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
251 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
252 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
253 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
254 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
256 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
257 extern void set_error_routine(void (*routine)(const char *err, va_list params));
259 extern int prefixcmp(const char *str, const char *prefix);
260 extern int suffixcmp(const char *str, const char *suffix);
262 static inline const char *skip_prefix(const char *str, const char *prefix)
264 size_t len = strlen(prefix);
265 return strncmp(str, prefix, len) ? NULL : str + len;
268 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
270 #ifndef PROT_READ
271 #define PROT_READ 1
272 #define PROT_WRITE 2
273 #define MAP_PRIVATE 1
274 #endif
276 #define mmap git_mmap
277 #define munmap git_munmap
278 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
279 extern int git_munmap(void *start, size_t length);
281 #else /* NO_MMAP || USE_WIN32_MMAP */
283 #include <sys/mman.h>
285 #endif /* NO_MMAP || USE_WIN32_MMAP */
287 #ifdef NO_MMAP
289 /* This value must be multiple of (pagesize * 2) */
290 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
292 #else /* NO_MMAP */
294 /* This value must be multiple of (pagesize * 2) */
295 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
296 (sizeof(void*) >= 8 \
297 ? 1 * 1024 * 1024 * 1024 \
298 : 32 * 1024 * 1024)
300 #endif /* NO_MMAP */
302 #ifndef MAP_FAILED
303 #define MAP_FAILED ((void *)-1)
304 #endif
306 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
307 #define on_disk_bytes(st) ((st).st_size)
308 #else
309 #define on_disk_bytes(st) ((st).st_blocks * 512)
310 #endif
312 #define DEFAULT_PACKED_GIT_LIMIT \
313 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
315 #ifdef NO_PREAD
316 #define pread git_pread
317 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
318 #endif
320 * Forward decl that will remind us if its twin in cache.h changes.
321 * This function is used in compat/pread.c. But we can't include
322 * cache.h there.
324 extern ssize_t read_in_full(int fd, void *buf, size_t count);
326 #ifdef NO_SETENV
327 #define setenv gitsetenv
328 extern int gitsetenv(const char *, const char *, int);
329 #endif
331 #ifdef NO_MKDTEMP
332 #define mkdtemp gitmkdtemp
333 extern char *gitmkdtemp(char *);
334 #endif
336 #ifdef NO_MKSTEMPS
337 #define mkstemps gitmkstemps
338 extern int gitmkstemps(char *, int);
339 #endif
341 #ifdef NO_UNSETENV
342 #define unsetenv gitunsetenv
343 extern void gitunsetenv(const char *);
344 #endif
346 #ifdef NO_STRCASESTR
347 #define strcasestr gitstrcasestr
348 extern char *gitstrcasestr(const char *haystack, const char *needle);
349 #endif
351 #ifdef NO_STRLCPY
352 #define strlcpy gitstrlcpy
353 extern size_t gitstrlcpy(char *, const char *, size_t);
354 #endif
356 #ifdef NO_STRTOUMAX
357 #define strtoumax gitstrtoumax
358 extern uintmax_t gitstrtoumax(const char *, char **, int);
359 #define strtoimax gitstrtoimax
360 extern intmax_t gitstrtoimax(const char *, char **, int);
361 #endif
363 #ifdef NO_STRTOK_R
364 #define strtok_r gitstrtok_r
365 extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
366 #endif
368 #ifdef NO_HSTRERROR
369 #define hstrerror githstrerror
370 extern const char *githstrerror(int herror);
371 #endif
373 #ifdef NO_MEMMEM
374 #define memmem gitmemmem
375 void *gitmemmem(const void *haystack, size_t haystacklen,
376 const void *needle, size_t needlelen);
377 #endif
379 #ifdef FREAD_READS_DIRECTORIES
380 #ifdef fopen
381 #undef fopen
382 #endif
383 #define fopen(a,b) git_fopen(a,b)
384 extern FILE *git_fopen(const char*, const char*);
385 #endif
387 #ifdef SNPRINTF_RETURNS_BOGUS
388 #define snprintf git_snprintf
389 extern int git_snprintf(char *str, size_t maxsize,
390 const char *format, ...);
391 #define vsnprintf git_vsnprintf
392 extern int git_vsnprintf(char *str, size_t maxsize,
393 const char *format, va_list ap);
394 #endif
396 #ifdef __GLIBC_PREREQ
397 #if __GLIBC_PREREQ(2, 1)
398 #define HAVE_STRCHRNUL
399 #define HAVE_MEMPCPY
400 #endif
401 #endif
403 #ifndef HAVE_STRCHRNUL
404 #define strchrnul gitstrchrnul
405 static inline char *gitstrchrnul(const char *s, int c)
407 while (*s && *s != c)
408 s++;
409 return (char *)s;
411 #endif
413 #ifndef HAVE_MEMPCPY
414 #define mempcpy gitmempcpy
415 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
417 return (char *)memcpy(dest, src, n) + n;
419 #endif
421 #ifdef NO_INET_PTON
422 int inet_pton(int af, const char *src, void *dst);
423 #endif
425 #ifdef NO_INET_NTOP
426 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
427 #endif
429 extern void release_pack_memory(size_t, int);
431 typedef void (*try_to_free_t)(size_t);
432 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
434 extern char *xstrdup(const char *str);
435 extern void *xmalloc(size_t size);
436 extern void *xmallocz(size_t size);
437 extern void *xmemdupz(const void *data, size_t len);
438 extern char *xstrndup(const char *str, size_t len);
439 extern void *xrealloc(void *ptr, size_t size);
440 extern void *xcalloc(size_t nmemb, size_t size);
441 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
442 extern ssize_t xread(int fd, void *buf, size_t len);
443 extern ssize_t xwrite(int fd, const void *buf, size_t len);
444 extern int xdup(int fd);
445 extern FILE *xfdopen(int fd, const char *mode);
446 extern int xmkstemp(char *template);
447 extern int xmkstemp_mode(char *template, int mode);
448 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
449 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
451 static inline size_t xsize_t(off_t len)
453 if (len > (size_t) len)
454 die("Cannot handle files this big");
455 return (size_t)len;
458 static inline int has_extension(const char *filename, const char *ext)
460 size_t len = strlen(filename);
461 size_t extlen = strlen(ext);
462 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
465 /* in ctype.c, for kwset users */
466 extern const char tolower_trans_tbl[256];
468 /* Sane ctype - no locale, and works with signed chars */
469 #undef isascii
470 #undef isspace
471 #undef isdigit
472 #undef isalpha
473 #undef isalnum
474 #undef islower
475 #undef isupper
476 #undef tolower
477 #undef toupper
478 extern unsigned char sane_ctype[256];
479 #define GIT_SPACE 0x01
480 #define GIT_DIGIT 0x02
481 #define GIT_ALPHA 0x04
482 #define GIT_GLOB_SPECIAL 0x08
483 #define GIT_REGEX_SPECIAL 0x10
484 #define GIT_PATHSPEC_MAGIC 0x20
485 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
486 #define isascii(x) (((x) & ~0x7f) == 0)
487 #define isspace(x) sane_istest(x,GIT_SPACE)
488 #define isdigit(x) sane_istest(x,GIT_DIGIT)
489 #define isalpha(x) sane_istest(x,GIT_ALPHA)
490 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
491 #define islower(x) sane_iscase(x, 1)
492 #define isupper(x) sane_iscase(x, 0)
493 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
494 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
495 #define tolower(x) sane_case((unsigned char)(x), 0x20)
496 #define toupper(x) sane_case((unsigned char)(x), 0)
497 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
499 static inline int sane_case(int x, int high)
501 if (sane_istest(x, GIT_ALPHA))
502 x = (x & ~0x20) | high;
503 return x;
506 static inline int sane_iscase(int x, int is_lower)
508 if (!sane_istest(x, GIT_ALPHA))
509 return 0;
511 if (is_lower)
512 return (x & 0x20) != 0;
513 else
514 return (x & 0x20) == 0;
517 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
519 unsigned long ul;
520 char *p;
522 errno = 0;
523 ul = strtoul(s, &p, base);
524 if (errno || *p || p == s || (unsigned int) ul != ul)
525 return -1;
526 *result = ul;
527 return 0;
530 static inline int strtol_i(char const *s, int base, int *result)
532 long ul;
533 char *p;
535 errno = 0;
536 ul = strtol(s, &p, base);
537 if (errno || *p || p == s || (int) ul != ul)
538 return -1;
539 *result = ul;
540 return 0;
543 #ifdef INTERNAL_QSORT
544 void git_qsort(void *base, size_t nmemb, size_t size,
545 int(*compar)(const void *, const void *));
546 #define qsort git_qsort
547 #endif
549 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
550 # define FORCE_DIR_SET_GID S_ISGID
551 #else
552 # define FORCE_DIR_SET_GID 0
553 #endif
555 #ifdef NO_NSEC
556 #undef USE_NSEC
557 #define ST_CTIME_NSEC(st) 0
558 #define ST_MTIME_NSEC(st) 0
559 #else
560 #ifdef USE_ST_TIMESPEC
561 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
562 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
563 #else
564 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
565 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
566 #endif
567 #endif
569 #ifdef UNRELIABLE_FSTAT
570 #define fstat_is_reliable() 0
571 #else
572 #define fstat_is_reliable() 1
573 #endif
575 #ifndef va_copy
577 * Since an obvious implementation of va_list would be to make it a
578 * pointer into the stack frame, a simple assignment will work on
579 * many systems. But let's try to be more portable.
581 #ifdef __va_copy
582 #define va_copy(dst, src) __va_copy(dst, src)
583 #else
584 #define va_copy(dst, src) ((dst) = (src))
585 #endif
586 #endif
589 * Preserves errno, prints a message, but gives no warning for ENOENT.
590 * Always returns the return value of unlink(2).
592 int unlink_or_warn(const char *path);
594 * Likewise for rmdir(2).
596 int rmdir_or_warn(const char *path);
598 * Calls the correct function out of {unlink,rmdir}_or_warn based on
599 * the supplied file mode.
601 int remove_or_warn(unsigned int mode, const char *path);
603 #ifndef mark_as_git_dir
604 #define mark_as_git_dir(x) /* noop */
605 #endif
607 #ifndef get_home_directory
608 #define get_home_directory() getenv("HOME")
609 #endif
611 #endif