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