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