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