Add MinGW header files to build git with MSVC
[git/git.git] / git-compat-util.h
CommitLineData
4050c0df
JH
1#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
b97e9116
MW
4#define _FILE_OFFSET_BITS 64
5
8f1d2e6f 6#ifndef FLEX_ARRAY
8e973991
JH
7/*
8 * See if our compiler is known to support flexible array members.
9 */
203ee91f 10#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
8e973991
JH
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
19
20/*
21 * Otherwise, default to safer but a bit wasteful traditional style
22 */
23#ifndef FLEX_ARRAY
24# define FLEX_ARRAY 1
8f1d2e6f
JH
25#endif
26#endif
27
b4f2a6ac 28#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
f630cfda 29#define bitsizeof(x) (CHAR_BIT * sizeof(x))
b4f2a6ac 30
8723f216
NP
31#ifdef __GNUC__
32#define TYPEOF(x) (__typeof__(x))
33#else
34#define TYPEOF(x)
35#endif
36
f630cfda 37#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
db7244bd 38#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216 39
98cb6f30
PH
40#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
41
cf606e3d
AW
42/* Approximation of the length of the decimal representation of this type. */
43#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
44
4cb18a49
BC
45#if defined(__sun__)
46 /*
47 * On Solaris, when _XOPEN_EXTENDED is set, its header file
48 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
49 * setting to say we are XPG5 or XPG6. Also on Solaris,
50 * XPG6 programs must be compiled with a c99 compiler, while
51 * non XPG6 programs must be compiled with a pre-c99 compiler.
52 */
53# if __STDC_VERSION__ - 0 >= 199901L
54# define _XOPEN_SOURCE 600
55# else
56# define _XOPEN_SOURCE 500
57# endif
9398b859 58#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX) && !defined(sgi)
85023577
JH
59#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
60#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6 61#endif
fb952206
JR
62#define _ALL_SOURCE 1
63#define _GNU_SOURCE 1
64#define _BSD_SOURCE 1
9a695fbf 65#define _NETBSD_SOURCE 1
9398b859 66#define _SGI_SOURCE 1
85023577 67
4050c0df
JH
68#include <unistd.h>
69#include <stdio.h>
70#include <sys/stat.h>
71#include <fcntl.h>
72#include <stddef.h>
73#include <stdlib.h>
74#include <stdarg.h>
75#include <string.h>
76#include <errno.h>
77#include <limits.h>
78#include <sys/param.h>
4050c0df
JH
79#include <sys/types.h>
80#include <dirent.h>
85023577
JH
81#include <sys/time.h>
82#include <time.h>
83#include <signal.h>
85023577 84#include <fnmatch.h>
f4626df5
JS
85#include <assert.h>
86#include <regex.h>
87#include <utime.h>
88#ifndef __MINGW32__
89#include <sys/wait.h>
85023577
JH
90#include <sys/poll.h>
91#include <sys/socket.h>
80bbe72b 92#include <sys/ioctl.h>
2600973f 93#ifndef NO_SYS_SELECT_H
80bbe72b 94#include <sys/select.h>
2600973f 95#endif
85023577
JH
96#include <netinet/in.h>
97#include <netinet/tcp.h>
98#include <arpa/inet.h>
99#include <netdb.h>
100#include <pwd.h>
007e2ba6 101#include <inttypes.h>
41b20017
RJ
102#if defined(__CYGWIN__)
103#undef _XOPEN_SOURCE
104#include <grp.h>
105#define _XOPEN_SOURCE 600
adbc0b6b 106#include "compat/cygwin.h"
41b20017 107#else
fb952206 108#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 109#include <grp.h>
fb952206 110#define _ALL_SOURCE 1
41b20017 111#endif
f4626df5
JS
112#else /* __MINGW32__ */
113/* pull in Windows compatibility stuff */
114#include "compat/mingw.h"
115#endif /* __MINGW32__ */
85023577 116
e1c06886
DA
117#ifndef NO_LIBGEN_H
118#include <libgen.h>
119#else
120#define basename gitbasename
121extern char *gitbasename(char *);
122#endif
123
85023577
JH
124#ifndef NO_ICONV
125#include <iconv.h>
126#endif
4050c0df 127
684ec6c6
RS
128#ifndef NO_OPENSSL
129#include <openssl/ssl.h>
130#include <openssl/err.h>
131#endif
132
d0c2449f
JH
133/* On most systems <limits.h> would have given us this, but
134 * not on some systems (e.g. GNU/Hurd).
135 */
136#ifndef PATH_MAX
137#define PATH_MAX 4096
138#endif
139
c4001d92
SP
140#ifndef PRIuMAX
141#define PRIuMAX "llu"
142#endif
143
607bb3ff
JS
144#ifndef PRIu32
145#define PRIu32 "u"
146#endif
147
148#ifndef PRIx32
149#define PRIx32 "x"
150#endif
151
80ba074f
JS
152#ifndef PATH_SEP
153#define PATH_SEP ':'
154#endif
155
23326d14
JS
156#ifndef STRIP_EXTENSION
157#define STRIP_EXTENSION ""
158#endif
159
25fe217b
JS
160#ifndef has_dos_drive_prefix
161#define has_dos_drive_prefix(path) 0
162#endif
163
164#ifndef is_dir_sep
165#define is_dir_sep(c) ((c) == '/')
166#endif
167
4050c0df
JH
168#ifdef __GNUC__
169#define NORETURN __attribute__((__noreturn__))
170#else
171#define NORETURN
172#ifndef __attribute__
173#define __attribute__(x)
174#endif
175#endif
176
51ea5519
NP
177#include "compat/bswap.h"
178
4050c0df
JH
179/* General helper functions */
180extern void usage(const char *err) NORETURN;
181extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
b875036e 182extern void die_errno(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
4050c0df 183extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 184extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 185
39a3f5ea 186extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
39a3f5ea 187
698a68be 188extern int prefixcmp(const char *str, const char *prefix);
bb5799d6 189extern time_t tm_to_time_t(const struct tm *tm);
698a68be 190
fbca5837
MV
191static inline const char *skip_prefix(const char *str, const char *prefix)
192{
193 size_t len = strlen(prefix);
194 return strncmp(str, prefix, len) ? NULL : str + len;
195}
196
b130a72b 197#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
198
199#ifndef PROT_READ
200#define PROT_READ 1
201#define PROT_WRITE 2
202#define MAP_PRIVATE 1
203#define MAP_FAILED ((void*)-1)
204#endif
205
d6779124
SP
206#define mmap git_mmap
207#define munmap git_munmap
208extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
209extern int git_munmap(void *start, size_t length);
4050c0df 210
b130a72b
JL
211#else /* NO_MMAP || USE_WIN32_MMAP */
212
213#include <sys/mman.h>
214
215#endif /* NO_MMAP || USE_WIN32_MMAP */
216
217#ifdef NO_MMAP
218
5faaf246 219/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
220#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
221
4050c0df
JH
222#else /* NO_MMAP */
223
5faaf246 224/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
225#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
226 (sizeof(void*) >= 8 \
227 ? 1 * 1024 * 1024 * 1024 \
228 : 32 * 1024 * 1024)
4050c0df
JH
229
230#endif /* NO_MMAP */
231
fdb2a2a6
JH
232#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
233#define on_disk_bytes(st) ((st).st_size)
234#else
235#define on_disk_bytes(st) ((st).st_blocks * 512)
236#endif
237
22bac0ea 238#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 239 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 240
6900679c
SH
241#ifdef NO_PREAD
242#define pread git_pread
243extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
244#endif
14086b0a
SP
245/*
246 * Forward decl that will remind us if its twin in cache.h changes.
247 * This function is used in compat/pread.c. But we can't include
248 * cache.h there.
249 */
250extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 251
4050c0df
JH
252#ifdef NO_SETENV
253#define setenv gitsetenv
254extern int gitsetenv(const char *, const char *, int);
255#endif
256
ca5bb5d5
SP
257#ifdef NO_MKDTEMP
258#define mkdtemp gitmkdtemp
259extern char *gitmkdtemp(char *);
260#endif
261
0620b39b
DA
262#ifdef NO_MKSTEMPS
263#define mkstemps gitmkstemps
264extern int gitmkstemps(char *, int);
265#endif
266
731043fd
JR
267#ifdef NO_UNSETENV
268#define unsetenv gitunsetenv
269extern void gitunsetenv(const char *);
270#endif
271
4050c0df
JH
272#ifdef NO_STRCASESTR
273#define strcasestr gitstrcasestr
274extern char *gitstrcasestr(const char *haystack, const char *needle);
275#endif
276
817151e6
PE
277#ifdef NO_STRLCPY
278#define strlcpy gitstrlcpy
279extern size_t gitstrlcpy(char *, const char *, size_t);
280#endif
281
bc6b4f52
JR
282#ifdef NO_STRTOUMAX
283#define strtoumax gitstrtoumax
284extern uintmax_t gitstrtoumax(const char *, char **, int);
285#endif
286
fa0c87c3
AR
287#ifdef NO_HSTRERROR
288#define hstrerror githstrerror
289extern const char *githstrerror(int herror);
290#endif
291
b21b9f1d
RS
292#ifdef NO_MEMMEM
293#define memmem gitmemmem
294void *gitmemmem(const void *haystack, size_t haystacklen,
295 const void *needle, size_t needlelen);
296#endif
297
cba22528 298#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
299#ifdef fopen
300#undef fopen
301#endif
cba22528
BC
302#define fopen(a,b) git_fopen(a,b)
303extern FILE *git_fopen(const char*, const char*);
304#endif
305
c4582f93
MR
306#ifdef SNPRINTF_RETURNS_BOGUS
307#define snprintf git_snprintf
308extern int git_snprintf(char *str, size_t maxsize,
309 const char *format, ...);
310#define vsnprintf git_vsnprintf
311extern int git_vsnprintf(char *str, size_t maxsize,
312 const char *format, va_list ap);
313#endif
314
726c8ef5
JS
315#ifdef __GLIBC_PREREQ
316#if __GLIBC_PREREQ(2, 1)
317#define HAVE_STRCHRNUL
318#endif
319#endif
320
321#ifndef HAVE_STRCHRNUL
659c69cf 322#define strchrnul gitstrchrnul
9e79f00f
AE
323static inline char *gitstrchrnul(const char *s, int c)
324{
325 while (*s && *s != c)
326 s++;
327 return (char *)s;
328}
659c69cf
RS
329#endif
330
d1efefa4 331extern void release_pack_memory(size_t, int);
97bfeb34 332
112db553
LT
333extern char *xstrdup(const char *str);
334extern void *xmalloc(size_t size);
335extern void *xmemdupz(const void *data, size_t len);
336extern char *xstrndup(const char *str, size_t len);
337extern void *xrealloc(void *ptr, size_t size);
338extern void *xcalloc(size_t nmemb, size_t size);
339extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
340extern ssize_t xread(int fd, void *buf, size_t len);
341extern ssize_t xwrite(int fd, const void *buf, size_t len);
342extern int xdup(int fd);
343extern FILE *xfdopen(int fd, const char *mode);
344extern int xmkstemp(char *template);
6e180cdc
JH
345extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
346extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
f21a47b2 347
dc49cd76
SP
348static inline size_t xsize_t(off_t len)
349{
350 return (size_t)len;
351}
352
5bb1cda5 353static inline int has_extension(const char *filename, const char *ext)
83a2b841 354{
5bb1cda5
RS
355 size_t len = strlen(filename);
356 size_t extlen = strlen(ext);
83a2b841
RS
357 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
358}
359
4050c0df 360/* Sane ctype - no locale, and works with signed chars */
c2e9364a 361#undef isascii
4050c0df
JH
362#undef isspace
363#undef isdigit
364#undef isalpha
365#undef isalnum
366#undef tolower
367#undef toupper
368extern unsigned char sane_ctype[256];
369#define GIT_SPACE 0x01
370#define GIT_DIGIT 0x02
371#define GIT_ALPHA 0x04
8cc32992 372#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 373#define GIT_REGEX_SPECIAL 0x10
4050c0df 374#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 375#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
376#define isspace(x) sane_istest(x,GIT_SPACE)
377#define isdigit(x) sane_istest(x,GIT_DIGIT)
378#define isalpha(x) sane_istest(x,GIT_ALPHA)
379#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
8cc32992 380#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 381#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
4050c0df
JH
382#define tolower(x) sane_case((unsigned char)(x), 0x20)
383#define toupper(x) sane_case((unsigned char)(x), 0)
384
385static inline int sane_case(int x, int high)
386{
387 if (sane_istest(x, GIT_ALPHA))
388 x = (x & ~0x20) | high;
389 return x;
390}
391
6aead43d
JM
392static inline int strtoul_ui(char const *s, int base, unsigned int *result)
393{
394 unsigned long ul;
395 char *p;
396
397 errno = 0;
398 ul = strtoul(s, &p, base);
399 if (errno || *p || p == s || (unsigned int) ul != ul)
400 return -1;
401 *result = ul;
402 return 0;
403}
404
7791ecbc
JH
405static inline int strtol_i(char const *s, int base, int *result)
406{
407 long ul;
408 char *p;
409
410 errno = 0;
411 ul = strtol(s, &p, base);
412 if (errno || *p || p == s || (int) ul != ul)
413 return -1;
414 *result = ul;
415 return 0;
416}
417
43fe901b
BD
418#ifdef INTERNAL_QSORT
419void git_qsort(void *base, size_t nmemb, size_t size,
420 int(*compar)(const void *, const void *));
421#define qsort git_qsort
422#endif
423
81a24b52
AR
424#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
425# define FORCE_DIR_SET_GID S_ISGID
426#else
427# define FORCE_DIR_SET_GID 0
428#endif
429
c06ff490
KB
430#ifdef NO_NSEC
431#undef USE_NSEC
432#define ST_CTIME_NSEC(st) 0
433#define ST_MTIME_NSEC(st) 0
434#else
c567383b
BG
435#ifdef USE_ST_TIMESPEC
436#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
437#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
438#else
c06ff490
KB
439#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
440#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
441#endif
c567383b 442#endif
c06ff490 443
34779c53
JS
444#ifdef UNRELIABLE_FSTAT
445#define fstat_is_reliable() 0
446#else
447#define fstat_is_reliable() 1
448#endif
449
fc71db39
AR
450/*
451 * Preserves errno, prints a message, but gives no warning for ENOENT.
452 * Always returns the return value of unlink(2).
453 */
454int unlink_or_warn(const char *path);
455
4050c0df 456#endif