Revert "compat: add strtok_r()"
[git/mingw.git] / git-compat-util.h
blobb636e0dd0c2ea8284ed6f34e32c448eae433a20a
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 !defined(__TANDEM) && !defined(__QNX__)
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_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 #ifdef HAVE_STRINGS_H
103 #include <strings.h> /* for strcasecmp() */
104 #endif
105 #include <errno.h>
106 #include <limits.h>
107 #ifdef NEEDS_SYS_PARAM_H
108 #include <sys/param.h>
109 #endif
110 #include <sys/types.h>
111 #include <dirent.h>
112 #include <sys/time.h>
113 #include <time.h>
114 #include <signal.h>
115 #ifndef USE_WILDMATCH
116 #include <fnmatch.h>
117 #endif
118 #include <assert.h>
119 #include <regex.h>
120 #include <utime.h>
121 #include <syslog.h>
122 #ifndef NO_SYS_POLL_H
123 #include <sys/poll.h>
124 #else
125 #include <poll.h>
126 #endif
127 #if defined(__MINGW32__)
128 /* pull in Windows compatibility stuff */
129 #include "compat/mingw.h"
130 #elif defined(_MSC_VER)
131 #include "compat/msvc.h"
132 #else
133 #include <sys/wait.h>
134 #include <sys/resource.h>
135 #include <sys/socket.h>
136 #include <sys/ioctl.h>
137 #include <termios.h>
138 #ifndef NO_SYS_SELECT_H
139 #include <sys/select.h>
140 #endif
141 #include <netinet/in.h>
142 #include <netinet/tcp.h>
143 #include <arpa/inet.h>
144 #include <netdb.h>
145 #include <pwd.h>
146 #include <sys/un.h>
147 #ifndef NO_INTTYPES_H
148 #include <inttypes.h>
149 #else
150 #include <stdint.h>
151 #endif
152 #ifdef NO_INTPTR_T
154 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
155 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
156 * while on IP16 and IP16L32 it is "int" (resp. "short")
157 * Size needs to match (or exceed) 'sizeof(void *)'.
158 * We can't take "long long" here as not everybody has it.
160 typedef long intptr_t;
161 typedef unsigned long uintptr_t;
162 #endif
163 #if defined(__CYGWIN__)
164 #undef _XOPEN_SOURCE
165 #include <grp.h>
166 #define _XOPEN_SOURCE 600
167 #include "compat/cygwin.h"
168 #else
169 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
170 #include <grp.h>
171 #define _ALL_SOURCE 1
172 #endif
173 #endif
175 /* used on Mac OS X */
176 #ifdef PRECOMPOSE_UNICODE
177 #include "compat/precompose_utf8.h"
178 #else
179 #define precompose_str(in,i_nfd2nfc)
180 #define precompose_argv(c,v)
181 #define probe_utf8_pathname_composition(a,b)
182 #endif
184 #ifdef MKDIR_WO_TRAILING_SLASH
185 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
186 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
187 #endif
189 #ifdef NO_STRUCT_ITIMERVAL
190 struct itimerval {
191 struct timeval it_interval;
192 struct timeval it_value;
194 #endif
196 #ifdef NO_SETITIMER
197 #define setitimer(which,value,ovalue)
198 #endif
200 #ifndef NO_LIBGEN_H
201 #include <libgen.h>
202 #else
203 #define basename gitbasename
204 extern char *gitbasename(char *);
205 #endif
207 #ifndef NO_ICONV
208 #include <iconv.h>
209 #endif
211 #ifndef NO_OPENSSL
212 #include <openssl/ssl.h>
213 #include <openssl/err.h>
214 #endif
216 /* On most systems <limits.h> would have given us this, but
217 * not on some systems (e.g. GNU/Hurd).
219 #ifndef PATH_MAX
220 #define PATH_MAX 4096
221 #endif
223 #ifndef PRIuMAX
224 #define PRIuMAX "llu"
225 #endif
227 #ifndef PRIu32
228 #define PRIu32 "u"
229 #endif
231 #ifndef PRIx32
232 #define PRIx32 "x"
233 #endif
235 #ifndef PRIo32
236 #define PRIo32 "o"
237 #endif
239 #ifndef PATH_SEP
240 #define PATH_SEP ':'
241 #endif
243 #ifdef HAVE_PATHS_H
244 #include <paths.h>
245 #endif
246 #ifndef _PATH_DEFPATH
247 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
248 #endif
250 #ifndef STRIP_EXTENSION
251 #define STRIP_EXTENSION ""
252 #endif
254 #ifndef has_dos_drive_prefix
255 #define has_dos_drive_prefix(path) 0
256 #endif
258 #ifndef is_dir_sep
259 #define is_dir_sep(c) ((c) == '/')
260 #endif
262 #ifndef find_last_dir_sep
263 #define find_last_dir_sep(path) strrchr(path, '/')
264 #endif
266 #if defined(__HP_cc) && (__HP_cc >= 61000)
267 #define NORETURN __attribute__((noreturn))
268 #define NORETURN_PTR
269 #elif defined(__GNUC__) && !defined(NO_NORETURN)
270 #define NORETURN __attribute__((__noreturn__))
271 #define NORETURN_PTR __attribute__((__noreturn__))
272 #elif defined(_MSC_VER)
273 #define NORETURN __declspec(noreturn)
274 #define NORETURN_PTR
275 #else
276 #define NORETURN
277 #define NORETURN_PTR
278 #ifndef __attribute__
279 #define __attribute__(x)
280 #endif
281 #endif
283 #include "compat/bswap.h"
285 #ifdef USE_WILDMATCH
286 #include "wildmatch.h"
287 #define FNM_PATHNAME WM_PATHNAME
288 #define FNM_CASEFOLD WM_CASEFOLD
289 #define FNM_NOMATCH WM_NOMATCH
290 static inline int fnmatch(const char *pattern, const char *string, int flags)
292 return wildmatch(pattern, string, flags, NULL);
294 #endif
296 /* General helper functions */
297 extern void vreportf(const char *prefix, const char *err, va_list params);
298 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
299 extern NORETURN void usage(const char *err);
300 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
301 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
302 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
303 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
304 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
307 * Let callers be aware of the constant return value; this can help
308 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
309 * because some compilers may not support variadic macros. Since we're only
310 * trying to help gcc, anyway, it's OK; other compilers will fall back to
311 * using the function as usual.
313 #if defined(__GNUC__) && ! defined(__clang__)
314 #define error(...) (error(__VA_ARGS__), -1)
315 #endif
317 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
318 extern void set_error_routine(void (*routine)(const char *err, va_list params));
320 extern int prefixcmp(const char *str, const char *prefix);
321 extern int suffixcmp(const char *str, const char *suffix);
323 static inline const char *skip_prefix(const char *str, const char *prefix)
325 size_t len = strlen(prefix);
326 return strncmp(str, prefix, len) ? NULL : str + len;
329 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
331 #ifndef PROT_READ
332 #define PROT_READ 1
333 #define PROT_WRITE 2
334 #define MAP_PRIVATE 1
335 #endif
337 #define mmap git_mmap
338 #define munmap git_munmap
339 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
340 extern int git_munmap(void *start, size_t length);
342 #else /* NO_MMAP || USE_WIN32_MMAP */
344 #include <sys/mman.h>
346 #endif /* NO_MMAP || USE_WIN32_MMAP */
348 #ifdef NO_MMAP
350 /* This value must be multiple of (pagesize * 2) */
351 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
353 #else /* NO_MMAP */
355 /* This value must be multiple of (pagesize * 2) */
356 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
357 (sizeof(void*) >= 8 \
358 ? 1 * 1024 * 1024 * 1024 \
359 : 32 * 1024 * 1024)
361 #endif /* NO_MMAP */
363 #ifndef MAP_FAILED
364 #define MAP_FAILED ((void *)-1)
365 #endif
367 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
368 #define on_disk_bytes(st) ((st).st_size)
369 #else
370 #define on_disk_bytes(st) ((st).st_blocks * 512)
371 #endif
373 #define DEFAULT_PACKED_GIT_LIMIT \
374 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
376 #ifdef NO_PREAD
377 #define pread git_pread
378 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
379 #endif
381 * Forward decl that will remind us if its twin in cache.h changes.
382 * This function is used in compat/pread.c. But we can't include
383 * cache.h there.
385 extern ssize_t read_in_full(int fd, void *buf, size_t count);
387 #ifdef NO_SETENV
388 #define setenv gitsetenv
389 extern int gitsetenv(const char *, const char *, int);
390 #endif
392 #ifdef NO_MKDTEMP
393 #define mkdtemp gitmkdtemp
394 extern char *gitmkdtemp(char *);
395 #endif
397 #ifdef NO_MKSTEMPS
398 #define mkstemps gitmkstemps
399 extern int gitmkstemps(char *, int);
400 #endif
402 #ifdef NO_UNSETENV
403 #define unsetenv gitunsetenv
404 extern void gitunsetenv(const char *);
405 #endif
407 #ifdef NO_STRCASESTR
408 #define strcasestr gitstrcasestr
409 extern char *gitstrcasestr(const char *haystack, const char *needle);
410 #endif
412 #ifdef NO_STRLCPY
413 #define strlcpy gitstrlcpy
414 extern size_t gitstrlcpy(char *, const char *, size_t);
415 #endif
417 #ifdef NO_STRTOUMAX
418 #define strtoumax gitstrtoumax
419 extern uintmax_t gitstrtoumax(const char *, char **, int);
420 #define strtoimax gitstrtoimax
421 extern intmax_t gitstrtoimax(const char *, char **, int);
422 #endif
424 #ifdef NO_HSTRERROR
425 #define hstrerror githstrerror
426 extern const char *githstrerror(int herror);
427 #endif
429 #ifdef NO_MEMMEM
430 #define memmem gitmemmem
431 void *gitmemmem(const void *haystack, size_t haystacklen,
432 const void *needle, size_t needlelen);
433 #endif
435 #ifdef NO_GETPAGESIZE
436 #define getpagesize() sysconf(_SC_PAGESIZE)
437 #endif
439 #ifdef FREAD_READS_DIRECTORIES
440 #ifdef fopen
441 #undef fopen
442 #endif
443 #define fopen(a,b) git_fopen(a,b)
444 extern FILE *git_fopen(const char*, const char*);
445 #endif
447 #ifdef SNPRINTF_RETURNS_BOGUS
448 #define snprintf git_snprintf
449 extern int git_snprintf(char *str, size_t maxsize,
450 const char *format, ...);
451 #define vsnprintf git_vsnprintf
452 extern int git_vsnprintf(char *str, size_t maxsize,
453 const char *format, va_list ap);
454 #endif
456 #ifdef __GLIBC_PREREQ
457 #if __GLIBC_PREREQ(2, 1)
458 #define HAVE_STRCHRNUL
459 #define HAVE_MEMPCPY
460 #endif
461 #endif
463 #ifndef HAVE_STRCHRNUL
464 #define strchrnul gitstrchrnul
465 static inline char *gitstrchrnul(const char *s, int c)
467 while (*s && *s != c)
468 s++;
469 return (char *)s;
471 #endif
473 #ifndef HAVE_MEMPCPY
474 #define mempcpy gitmempcpy
475 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
477 return (char *)memcpy(dest, src, n) + n;
479 #endif
481 #ifdef NO_INET_PTON
482 int inet_pton(int af, const char *src, void *dst);
483 #endif
485 #ifdef NO_INET_NTOP
486 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
487 #endif
489 extern void release_pack_memory(size_t, int);
491 typedef void (*try_to_free_t)(size_t);
492 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
494 extern char *xstrdup(const char *str);
495 extern void *xmalloc(size_t size);
496 extern void *xmallocz(size_t size);
497 extern void *xmemdupz(const void *data, size_t len);
498 extern char *xstrndup(const char *str, size_t len);
499 extern void *xrealloc(void *ptr, size_t size);
500 extern void *xcalloc(size_t nmemb, size_t size);
501 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
502 extern ssize_t xread(int fd, void *buf, size_t len);
503 extern ssize_t xwrite(int fd, const void *buf, size_t len);
504 extern int xdup(int fd);
505 extern FILE *xfdopen(int fd, const char *mode);
506 extern int xmkstemp(char *template);
507 extern int xmkstemp_mode(char *template, int mode);
508 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
509 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
511 static inline size_t xsize_t(off_t len)
513 if (len > (size_t) len)
514 die("Cannot handle files this big");
515 return (size_t)len;
518 static inline int has_extension(const char *filename, const char *ext)
520 size_t len = strlen(filename);
521 size_t extlen = strlen(ext);
522 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
525 /* in ctype.c, for kwset users */
526 extern const char tolower_trans_tbl[256];
528 /* Sane ctype - no locale, and works with signed chars */
529 #undef isascii
530 #undef isspace
531 #undef isdigit
532 #undef isalpha
533 #undef isalnum
534 #undef isprint
535 #undef islower
536 #undef isupper
537 #undef tolower
538 #undef toupper
539 #undef iscntrl
540 #undef ispunct
541 #undef isxdigit
543 extern const unsigned char sane_ctype[256];
544 #define GIT_SPACE 0x01
545 #define GIT_DIGIT 0x02
546 #define GIT_ALPHA 0x04
547 #define GIT_GLOB_SPECIAL 0x08
548 #define GIT_REGEX_SPECIAL 0x10
549 #define GIT_PATHSPEC_MAGIC 0x20
550 #define GIT_CNTRL 0x40
551 #define GIT_PUNCT 0x80
552 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
553 #define isascii(x) (((x) & ~0x7f) == 0)
554 #define isspace(x) sane_istest(x,GIT_SPACE)
555 #define isdigit(x) sane_istest(x,GIT_DIGIT)
556 #define isalpha(x) sane_istest(x,GIT_ALPHA)
557 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
558 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
559 #define islower(x) sane_iscase(x, 1)
560 #define isupper(x) sane_iscase(x, 0)
561 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
562 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
563 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
564 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
565 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
566 #define isxdigit(x) (hexval_table[x] != -1)
567 #define tolower(x) sane_case((unsigned char)(x), 0x20)
568 #define toupper(x) sane_case((unsigned char)(x), 0)
569 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
571 static inline int sane_case(int x, int high)
573 if (sane_istest(x, GIT_ALPHA))
574 x = (x & ~0x20) | high;
575 return x;
578 static inline int sane_iscase(int x, int is_lower)
580 if (!sane_istest(x, GIT_ALPHA))
581 return 0;
583 if (is_lower)
584 return (x & 0x20) != 0;
585 else
586 return (x & 0x20) == 0;
589 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
591 unsigned long ul;
592 char *p;
594 errno = 0;
595 ul = strtoul(s, &p, base);
596 if (errno || *p || p == s || (unsigned int) ul != ul)
597 return -1;
598 *result = ul;
599 return 0;
602 static inline int strtol_i(char const *s, int base, int *result)
604 long ul;
605 char *p;
607 errno = 0;
608 ul = strtol(s, &p, base);
609 if (errno || *p || p == s || (int) ul != ul)
610 return -1;
611 *result = ul;
612 return 0;
615 #ifdef INTERNAL_QSORT
616 void git_qsort(void *base, size_t nmemb, size_t size,
617 int(*compar)(const void *, const void *));
618 #define qsort git_qsort
619 #endif
621 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
622 # define FORCE_DIR_SET_GID S_ISGID
623 #else
624 # define FORCE_DIR_SET_GID 0
625 #endif
627 #ifdef NO_NSEC
628 #undef USE_NSEC
629 #define ST_CTIME_NSEC(st) 0
630 #define ST_MTIME_NSEC(st) 0
631 #else
632 #ifdef USE_ST_TIMESPEC
633 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
634 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
635 #else
636 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
637 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
638 #endif
639 #endif
641 #ifdef UNRELIABLE_FSTAT
642 #define fstat_is_reliable() 0
643 #else
644 #define fstat_is_reliable() 1
645 #endif
647 #ifndef va_copy
649 * Since an obvious implementation of va_list would be to make it a
650 * pointer into the stack frame, a simple assignment will work on
651 * many systems. But let's try to be more portable.
653 #ifdef __va_copy
654 #define va_copy(dst, src) __va_copy(dst, src)
655 #else
656 #define va_copy(dst, src) ((dst) = (src))
657 #endif
658 #endif
661 * Preserves errno, prints a message, but gives no warning for ENOENT.
662 * Always returns the return value of unlink(2).
664 int unlink_or_warn(const char *path);
666 * Likewise for rmdir(2).
668 int rmdir_or_warn(const char *path);
670 * Calls the correct function out of {unlink,rmdir}_or_warn based on
671 * the supplied file mode.
673 int remove_or_warn(unsigned int mode, const char *path);
676 * Call access(2), but warn for any error except "missing file"
677 * (ENOENT or ENOTDIR).
679 int access_or_warn(const char *path, int mode);
680 int access_or_die(const char *path, int mode);
682 /* Warn on an inaccessible file that ought to be accessible */
683 void warn_on_inaccessible(const char *path);
685 /* Get the passwd entry for the UID of the current process. */
686 struct passwd *xgetpwuid_self(void);
688 #endif