gc --aggressive: make it really aggressive
[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
4050c0df
JH
169#ifdef NO_MMAP
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
5faaf246 183/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
184#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
185
4050c0df
JH
186#else /* NO_MMAP */
187
188#include <sys/mman.h>
5faaf246
JH
189
190/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
191#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
192 (sizeof(void*) >= 8 \
193 ? 1 * 1024 * 1024 * 1024 \
194 : 32 * 1024 * 1024)
4050c0df
JH
195
196#endif /* NO_MMAP */
197
fdb2a2a6
JH
198#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
199#define on_disk_bytes(st) ((st).st_size)
200#else
201#define on_disk_bytes(st) ((st).st_blocks * 512)
202#endif
203
22bac0ea 204#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 205 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 206
6900679c
SH
207#ifdef NO_PREAD
208#define pread git_pread
209extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
210#endif
14086b0a
SP
211/*
212 * Forward decl that will remind us if its twin in cache.h changes.
213 * This function is used in compat/pread.c. But we can't include
214 * cache.h there.
215 */
216extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 217
4050c0df
JH
218#ifdef NO_SETENV
219#define setenv gitsetenv
220extern int gitsetenv(const char *, const char *, int);
221#endif
222
ca5bb5d5
SP
223#ifdef NO_MKDTEMP
224#define mkdtemp gitmkdtemp
225extern char *gitmkdtemp(char *);
226#endif
227
731043fd
JR
228#ifdef NO_UNSETENV
229#define unsetenv gitunsetenv
230extern void gitunsetenv(const char *);
231#endif
232
4050c0df
JH
233#ifdef NO_STRCASESTR
234#define strcasestr gitstrcasestr
235extern char *gitstrcasestr(const char *haystack, const char *needle);
236#endif
237
817151e6
PE
238#ifdef NO_STRLCPY
239#define strlcpy gitstrlcpy
240extern size_t gitstrlcpy(char *, const char *, size_t);
241#endif
242
bc6b4f52
JR
243#ifdef NO_STRTOUMAX
244#define strtoumax gitstrtoumax
245extern uintmax_t gitstrtoumax(const char *, char **, int);
246#endif
247
fa0c87c3
AR
248#ifdef NO_HSTRERROR
249#define hstrerror githstrerror
250extern const char *githstrerror(int herror);
251#endif
252
b21b9f1d
RS
253#ifdef NO_MEMMEM
254#define memmem gitmemmem
255void *gitmemmem(const void *haystack, size_t haystacklen,
256 const void *needle, size_t needlelen);
257#endif
258
cba22528 259#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
260#ifdef fopen
261#undef fopen
262#endif
cba22528
BC
263#define fopen(a,b) git_fopen(a,b)
264extern FILE *git_fopen(const char*, const char*);
265#endif
266
c4582f93
MR
267#ifdef SNPRINTF_RETURNS_BOGUS
268#define snprintf git_snprintf
269extern int git_snprintf(char *str, size_t maxsize,
270 const char *format, ...);
271#define vsnprintf git_vsnprintf
272extern int git_vsnprintf(char *str, size_t maxsize,
273 const char *format, va_list ap);
274#endif
275
726c8ef5
JS
276#ifdef __GLIBC_PREREQ
277#if __GLIBC_PREREQ(2, 1)
278#define HAVE_STRCHRNUL
279#endif
280#endif
281
282#ifndef HAVE_STRCHRNUL
659c69cf 283#define strchrnul gitstrchrnul
9e79f00f
AE
284static inline char *gitstrchrnul(const char *s, int c)
285{
286 while (*s && *s != c)
287 s++;
288 return (char *)s;
289}
659c69cf
RS
290#endif
291
d1efefa4 292extern void release_pack_memory(size_t, int);
97bfeb34 293
112db553
LT
294extern char *xstrdup(const char *str);
295extern void *xmalloc(size_t size);
296extern void *xmemdupz(const void *data, size_t len);
297extern char *xstrndup(const char *str, size_t len);
298extern void *xrealloc(void *ptr, size_t size);
299extern void *xcalloc(size_t nmemb, size_t size);
300extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
301extern ssize_t xread(int fd, void *buf, size_t len);
302extern ssize_t xwrite(int fd, const void *buf, size_t len);
303extern int xdup(int fd);
304extern FILE *xfdopen(int fd, const char *mode);
305extern int xmkstemp(char *template);
6e180cdc
JH
306extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
307extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
f21a47b2 308
dc49cd76
SP
309static inline size_t xsize_t(off_t len)
310{
311 return (size_t)len;
312}
313
5bb1cda5 314static inline int has_extension(const char *filename, const char *ext)
83a2b841 315{
5bb1cda5
RS
316 size_t len = strlen(filename);
317 size_t extlen = strlen(ext);
83a2b841
RS
318 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
319}
320
4050c0df 321/* Sane ctype - no locale, and works with signed chars */
c2e9364a 322#undef isascii
4050c0df
JH
323#undef isspace
324#undef isdigit
325#undef isalpha
326#undef isalnum
327#undef tolower
328#undef toupper
329extern unsigned char sane_ctype[256];
330#define GIT_SPACE 0x01
331#define GIT_DIGIT 0x02
332#define GIT_ALPHA 0x04
8cc32992 333#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 334#define GIT_REGEX_SPECIAL 0x10
4050c0df 335#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 336#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
337#define isspace(x) sane_istest(x,GIT_SPACE)
338#define isdigit(x) sane_istest(x,GIT_DIGIT)
339#define isalpha(x) sane_istest(x,GIT_ALPHA)
340#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
8cc32992 341#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 342#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
4050c0df
JH
343#define tolower(x) sane_case((unsigned char)(x), 0x20)
344#define toupper(x) sane_case((unsigned char)(x), 0)
345
346static inline int sane_case(int x, int high)
347{
348 if (sane_istest(x, GIT_ALPHA))
349 x = (x & ~0x20) | high;
350 return x;
351}
352
6aead43d
JM
353static inline int strtoul_ui(char const *s, int base, unsigned int *result)
354{
355 unsigned long ul;
356 char *p;
357
358 errno = 0;
359 ul = strtoul(s, &p, base);
360 if (errno || *p || p == s || (unsigned int) ul != ul)
361 return -1;
362 *result = ul;
363 return 0;
364}
365
7791ecbc
JH
366static inline int strtol_i(char const *s, int base, int *result)
367{
368 long ul;
369 char *p;
370
371 errno = 0;
372 ul = strtol(s, &p, base);
373 if (errno || *p || p == s || (int) ul != ul)
374 return -1;
375 *result = ul;
376 return 0;
377}
378
43fe901b
BD
379#ifdef INTERNAL_QSORT
380void git_qsort(void *base, size_t nmemb, size_t size,
381 int(*compar)(const void *, const void *));
382#define qsort git_qsort
383#endif
384
81a24b52
AR
385#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
386# define FORCE_DIR_SET_GID S_ISGID
387#else
388# define FORCE_DIR_SET_GID 0
389#endif
390
c06ff490
KB
391#ifdef NO_NSEC
392#undef USE_NSEC
393#define ST_CTIME_NSEC(st) 0
394#define ST_MTIME_NSEC(st) 0
395#else
c567383b
BG
396#ifdef USE_ST_TIMESPEC
397#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
398#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
399#else
c06ff490
KB
400#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
401#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
402#endif
c567383b 403#endif
c06ff490 404
4050c0df 405#endif