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