git-remote-hg: add the helper
[git/dscho.git] / git-compat-util.h
blobe6f12cc458e9840a8a1b81d8f171d86b31a62920
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
22  */
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.
40  *
41  * Requires: a >= 0, typeof(a) equals typeof(b)
42  */
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__)
64  /*
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.
70   */
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       !defined(__TANDEM)
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 */
81 #endif
82 #define _ALL_SOURCE 1
83 #define _GNU_SOURCE 1
84 #define _BSD_SOURCE 1
85 #define _NETBSD_SOURCE 1
86 #define _SGI_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 */
91 #include <winsock2.h>
92 #include <windows.h>
93 #endif
95 #include <unistd.h>
96 #include <stdio.h>
97 #include <sys/stat.h>
98 #include <fcntl.h>
99 #include <stddef.h>
100 #include <stdlib.h>
101 #include <stdarg.h>
102 #include <string.h>
103 #ifdef __TANDEM /* or HAVE_STRINGS_H or !NO_STRINGS_H? */
104 #include <strings.h> /* for strcasecmp() */
105 #endif
106 #include <errno.h>
107 #include <limits.h>
108 #include <sys/param.h>
109 #include <sys/types.h>
110 #include <dirent.h>
111 #include <sys/time.h>
112 #include <time.h>
113 #include <signal.h>
114 #include <fnmatch.h>
115 #include <assert.h>
116 #include <regex.h>
117 #include <utime.h>
118 #include <syslog.h>
119 #ifndef NO_SYS_POLL_H
120 #include <sys/poll.h>
121 #else
122 #include <poll.h>
123 #endif
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"
129 #else
130 #include <sys/wait.h>
131 #include <sys/resource.h>
132 #include <sys/socket.h>
133 #include <sys/ioctl.h>
134 #include <termios.h>
135 #ifndef NO_SYS_SELECT_H
136 #include <sys/select.h>
137 #endif
138 #include <netinet/in.h>
139 #include <netinet/tcp.h>
140 #include <arpa/inet.h>
141 #include <netdb.h>
142 #include <pwd.h>
143 #include <sys/un.h>
144 #ifndef NO_INTTYPES_H
145 #include <inttypes.h>
146 #else
147 #include <stdint.h>
148 #endif
149 #ifdef NO_INTPTR_T
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.
156  */
157 typedef long intptr_t;
158 typedef unsigned long uintptr_t;
159 #endif
160 #if defined(__CYGWIN__)
161 #undef _XOPEN_SOURCE
162 #include <grp.h>
163 #define _XOPEN_SOURCE 600
164 #include "compat/cygwin.h"
165 #else
166 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
167 #include <grp.h>
168 #define _ALL_SOURCE 1
169 #endif
170 #endif
172 /* used on Mac OS X */
173 #ifdef PRECOMPOSE_UNICODE
174 #include "compat/precompose_utf8.h"
175 #else
176 #define precompose_str(in,i_nfd2nfc)
177 #define precompose_argv(c,v)
178 #define probe_utf8_pathname_composition(a,b)
179 #endif
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);
184 #endif
186 #ifdef NO_STRUCT_ITIMERVAL
187 struct itimerval {
188         struct timeval it_interval;
189         struct timeval it_value;
191 #endif
193 #ifdef NO_SETITIMER
194 #define setitimer(which,value,ovalue)
195 #endif
197 #ifndef NO_LIBGEN_H
198 #include <libgen.h>
199 #else
200 #define basename gitbasename
201 extern char *gitbasename(char *);
202 #endif
204 #ifndef NO_ICONV
205 #include <iconv.h>
206 #endif
208 #ifndef NO_OPENSSL
209 #include <openssl/ssl.h>
210 #include <openssl/err.h>
211 #endif
213 /* On most systems <limits.h> would have given us this, but
214  * not on some systems (e.g. GNU/Hurd).
215  */
216 #ifndef PATH_MAX
217 #define PATH_MAX 4096
218 #endif
220 #ifndef PRIuMAX
221 #define PRIuMAX "llu"
222 #endif
224 #ifndef PRIu32
225 #define PRIu32 "u"
226 #endif
228 #ifndef PRIx32
229 #define PRIx32 "x"
230 #endif
232 #ifndef PRIo32
233 #define PRIo32 "o"
234 #endif
236 #ifndef PATH_SEP
237 #define PATH_SEP ':'
238 #endif
240 #ifdef HAVE_PATHS_H
241 #include <paths.h>
242 #endif
243 #ifndef _PATH_DEFPATH
244 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
245 #endif
247 #ifndef STRIP_EXTENSION
248 #define STRIP_EXTENSION ""
249 #endif
251 #ifndef has_dos_drive_prefix
252 #define has_dos_drive_prefix(path) 0
253 #endif
255 #ifndef offset_1st_component
256 #define offset_1st_component(path) (is_dir_sep((path)[0]))
257 #endif
259 #ifndef is_dir_sep
260 #define is_dir_sep(c) ((c) == '/')
261 #endif
263 #ifndef find_last_dir_sep
264 #define find_last_dir_sep(path) strrchr(path, '/')
265 #endif
267 #if defined(__HP_cc) && (__HP_cc >= 61000)
268 #define NORETURN __attribute__((noreturn))
269 #define NORETURN_PTR
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)
275 #define NORETURN_PTR
276 #else
277 #define NORETURN
278 #define NORETURN_PTR
279 #ifndef __attribute__
280 #define __attribute__(x)
281 #endif
282 #endif
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)
310 #ifndef PROT_READ
311 #define PROT_READ 1
312 #define PROT_WRITE 2
313 #define MAP_PRIVATE 1
314 #endif
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 */
327 #ifdef NO_MMAP
329 /* This value must be multiple of (pagesize * 2) */
330 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
332 #else /* NO_MMAP */
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 \
338                 : 32 * 1024 * 1024)
340 #endif /* NO_MMAP */
342 #ifndef MAP_FAILED
343 #define MAP_FAILED ((void *)-1)
344 #endif
346 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
347 #define on_disk_bytes(st) ((st).st_size)
348 #else
349 #define on_disk_bytes(st) ((st).st_blocks * 512)
350 #endif
352 #define DEFAULT_PACKED_GIT_LIMIT \
353         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
355 #ifdef NO_PREAD
356 #define pread git_pread
357 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
358 #endif
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
362  * cache.h there.
363  */
364 extern ssize_t read_in_full(int fd, void *buf, size_t count);
366 #ifdef NO_SETENV
367 #define setenv gitsetenv
368 extern int gitsetenv(const char *, const char *, int);
369 #endif
371 #ifdef NO_MKDTEMP
372 #define mkdtemp gitmkdtemp
373 extern char *gitmkdtemp(char *);
374 #endif
376 #ifdef NO_MKSTEMPS
377 #define mkstemps gitmkstemps
378 extern int gitmkstemps(char *, int);
379 #endif
381 #ifdef NO_UNSETENV
382 #define unsetenv gitunsetenv
383 extern void gitunsetenv(const char *);
384 #endif
386 #ifdef NO_STRCASESTR
387 #define strcasestr gitstrcasestr
388 extern char *gitstrcasestr(const char *haystack, const char *needle);
389 #endif
391 #ifdef NO_STRLCPY
392 #define strlcpy gitstrlcpy
393 extern size_t gitstrlcpy(char *, const char *, size_t);
394 #endif
396 #ifdef NO_STRTOUMAX
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);
401 #endif
403 #ifdef NO_STRTOK_R
404 #define strtok_r gitstrtok_r
405 extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
406 #endif
408 #ifdef NO_HSTRERROR
409 #define hstrerror githstrerror
410 extern const char *githstrerror(int herror);
411 #endif
413 #ifdef NO_MEMMEM
414 #define memmem gitmemmem
415 void *gitmemmem(const void *haystack, size_t haystacklen,
416                 const void *needle, size_t needlelen);
417 #endif
419 #ifdef FREAD_READS_DIRECTORIES
420 #ifdef fopen
421 #undef fopen
422 #endif
423 #define fopen(a,b) git_fopen(a,b)
424 extern FILE *git_fopen(const char*, const char*);
425 #endif
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);
434 #endif
436 #ifdef __GLIBC_PREREQ
437 #if __GLIBC_PREREQ(2, 1)
438 #define HAVE_STRCHRNUL
439 #define HAVE_MEMPCPY
440 #endif
441 #endif
443 #ifndef HAVE_STRCHRNUL
444 #define strchrnul gitstrchrnul
445 static inline char *gitstrchrnul(const char *s, int c)
447         while (*s && *s != c)
448                 s++;
449         return (char *)s;
451 #endif
453 #ifndef HAVE_MEMPCPY
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;
459 #endif
461 #ifdef NO_INET_PTON
462 int inet_pton(int af, const char *src, void *dst);
463 #endif
465 #ifdef NO_INET_NTOP
466 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
467 #endif
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");
495         return (size_t)len;
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 */
509 #undef isascii
510 #undef isspace
511 #undef isdigit
512 #undef isalpha
513 #undef isalnum
514 #undef islower
515 #undef isupper
516 #undef tolower
517 #undef toupper
518 extern unsigned char sane_ctype[256];
519 #define GIT_SPACE 0x01
520 #define GIT_DIGIT 0x02
521 #define GIT_ALPHA 0x04
522 #define GIT_GLOB_SPECIAL 0x08
523 #define GIT_REGEX_SPECIAL 0x10
524 #define GIT_PATHSPEC_MAGIC 0x20
525 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
526 #define isascii(x) (((x) & ~0x7f) == 0)
527 #define isspace(x) sane_istest(x,GIT_SPACE)
528 #define isdigit(x) sane_istest(x,GIT_DIGIT)
529 #define isalpha(x) sane_istest(x,GIT_ALPHA)
530 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
531 #define islower(x) sane_iscase(x, 1)
532 #define isupper(x) sane_iscase(x, 0)
533 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
534 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
535 #define tolower(x) sane_case((unsigned char)(x), 0x20)
536 #define toupper(x) sane_case((unsigned char)(x), 0)
537 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
539 static inline int sane_case(int x, int high)
541         if (sane_istest(x, GIT_ALPHA))
542                 x = (x & ~0x20) | high;
543         return x;
546 static inline int sane_iscase(int x, int is_lower)
548         if (!sane_istest(x, GIT_ALPHA))
549                 return 0;
551         if (is_lower)
552                 return (x & 0x20) != 0;
553         else
554                 return (x & 0x20) == 0;
557 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
559         unsigned long ul;
560         char *p;
562         errno = 0;
563         ul = strtoul(s, &p, base);
564         if (errno || *p || p == s || (unsigned int) ul != ul)
565                 return -1;
566         *result = ul;
567         return 0;
570 static inline int strtol_i(char const *s, int base, int *result)
572         long ul;
573         char *p;
575         errno = 0;
576         ul = strtol(s, &p, base);
577         if (errno || *p || p == s || (int) ul != ul)
578                 return -1;
579         *result = ul;
580         return 0;
583 #ifdef INTERNAL_QSORT
584 void git_qsort(void *base, size_t nmemb, size_t size,
585                int(*compar)(const void *, const void *));
586 #define qsort git_qsort
587 #endif
589 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
590 # define FORCE_DIR_SET_GID S_ISGID
591 #else
592 # define FORCE_DIR_SET_GID 0
593 #endif
595 #ifdef NO_NSEC
596 #undef USE_NSEC
597 #define ST_CTIME_NSEC(st) 0
598 #define ST_MTIME_NSEC(st) 0
599 #else
600 #ifdef USE_ST_TIMESPEC
601 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
602 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
603 #else
604 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
605 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
606 #endif
607 #endif
609 #ifdef UNRELIABLE_FSTAT
610 #define fstat_is_reliable() 0
611 #else
612 #define fstat_is_reliable() 1
613 #endif
615 #ifndef va_copy
617  * Since an obvious implementation of va_list would be to make it a
618  * pointer into the stack frame, a simple assignment will work on
619  * many systems.  But let's try to be more portable.
620  */
621 #ifdef __va_copy
622 #define va_copy(dst, src) __va_copy(dst, src)
623 #else
624 #define va_copy(dst, src) ((dst) = (src))
625 #endif
626 #endif
629  * Preserves errno, prints a message, but gives no warning for ENOENT.
630  * Always returns the return value of unlink(2).
631  */
632 int unlink_or_warn(const char *path);
634  * Likewise for rmdir(2).
635  */
636 int rmdir_or_warn(const char *path);
638  * Calls the correct function out of {unlink,rmdir}_or_warn based on
639  * the supplied file mode.
640  */
641 int remove_or_warn(unsigned int mode, const char *path);
643 /* Call access(2), but warn for any error besides ENOENT. */
644 int access_or_warn(const char *path, int mode);
646 /* Warn on an inaccessible file that ought to be accessible */
647 void warn_on_inaccessible(const char *path);
649 /* Get the passwd entry for the UID of the current process. */
650 struct passwd *xgetpwuid_self(void);
652 #ifndef mark_as_git_dir
653 #define mark_as_git_dir(x) /* noop */
654 #endif
656 #ifndef get_home_directory
657 #define get_home_directory() getenv("HOME")
658 #endif
660 #endif