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