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