]> git.ipfire.org Git - thirdparty/git.git/blame - git-compat-util.h
Documentation: A...B shortcut for checkout and rebase
[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 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
YT
58#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
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
23326d14
JS
167#ifndef STRIP_EXTENSION
168#define STRIP_EXTENSION ""
169#endif
170
25fe217b
JS
171#ifndef has_dos_drive_prefix
172#define has_dos_drive_prefix(path) 0
173#endif
174
175#ifndef is_dir_sep
176#define is_dir_sep(c) ((c) == '/')
177#endif
178
4050c0df
JH
179#ifdef __GNUC__
180#define NORETURN __attribute__((__noreturn__))
18660bc9 181#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8
RJ
182#elif defined(_MSC_VER)
183#define NORETURN __declspec(noreturn)
184#define NORETURN_PTR
4050c0df
JH
185#else
186#define NORETURN
18660bc9 187#define NORETURN_PTR
4050c0df
JH
188#ifndef __attribute__
189#define __attribute__(x)
190#endif
191#endif
192
51ea5519
NP
193#include "compat/bswap.h"
194
4050c0df 195/* General helper functions */
a4f3131c 196extern NORETURN void usage(const char *err);
64b1cb74 197extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
a4f3131c
EFL
198extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
199extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 200extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 201extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 202
18660bc9 203extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
39a3f5ea 204
698a68be 205extern int prefixcmp(const char *str, const char *prefix);
8cc5b290 206extern int suffixcmp(const char *str, const char *suffix);
698a68be 207
fbca5837
MV
208static inline const char *skip_prefix(const char *str, const char *prefix)
209{
210 size_t len = strlen(prefix);
211 return strncmp(str, prefix, len) ? NULL : str + len;
212}
213
b130a72b 214#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
215
216#ifndef PROT_READ
217#define PROT_READ 1
218#define PROT_WRITE 2
219#define MAP_PRIVATE 1
220#define MAP_FAILED ((void*)-1)
221#endif
222
d6779124
SP
223#define mmap git_mmap
224#define munmap git_munmap
225extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
226extern int git_munmap(void *start, size_t length);
4050c0df 227
b130a72b
JL
228#else /* NO_MMAP || USE_WIN32_MMAP */
229
230#include <sys/mman.h>
231
232#endif /* NO_MMAP || USE_WIN32_MMAP */
233
234#ifdef NO_MMAP
235
5faaf246 236/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
237#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
238
4050c0df
JH
239#else /* NO_MMAP */
240
5faaf246 241/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
242#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
243 (sizeof(void*) >= 8 \
244 ? 1 * 1024 * 1024 * 1024 \
245 : 32 * 1024 * 1024)
4050c0df
JH
246
247#endif /* NO_MMAP */
248
fdb2a2a6
JH
249#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
250#define on_disk_bytes(st) ((st).st_size)
251#else
252#define on_disk_bytes(st) ((st).st_blocks * 512)
253#endif
254
22bac0ea 255#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 256 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 257
6900679c
SH
258#ifdef NO_PREAD
259#define pread git_pread
260extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
261#endif
14086b0a
SP
262/*
263 * Forward decl that will remind us if its twin in cache.h changes.
264 * This function is used in compat/pread.c. But we can't include
265 * cache.h there.
266 */
267extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 268
4050c0df
JH
269#ifdef NO_SETENV
270#define setenv gitsetenv
271extern int gitsetenv(const char *, const char *, int);
272#endif
273
ca5bb5d5
SP
274#ifdef NO_MKDTEMP
275#define mkdtemp gitmkdtemp
276extern char *gitmkdtemp(char *);
277#endif
278
0620b39b
DA
279#ifdef NO_MKSTEMPS
280#define mkstemps gitmkstemps
281extern int gitmkstemps(char *, int);
282#endif
283
731043fd
JR
284#ifdef NO_UNSETENV
285#define unsetenv gitunsetenv
286extern void gitunsetenv(const char *);
287#endif
288
4050c0df
JH
289#ifdef NO_STRCASESTR
290#define strcasestr gitstrcasestr
291extern char *gitstrcasestr(const char *haystack, const char *needle);
292#endif
293
817151e6
PE
294#ifdef NO_STRLCPY
295#define strlcpy gitstrlcpy
296extern size_t gitstrlcpy(char *, const char *, size_t);
297#endif
298
bc6b4f52
JR
299#ifdef NO_STRTOUMAX
300#define strtoumax gitstrtoumax
301extern uintmax_t gitstrtoumax(const char *, char **, int);
302#endif
303
fa0c87c3
AR
304#ifdef NO_HSTRERROR
305#define hstrerror githstrerror
306extern const char *githstrerror(int herror);
307#endif
308
b21b9f1d
RS
309#ifdef NO_MEMMEM
310#define memmem gitmemmem
311void *gitmemmem(const void *haystack, size_t haystacklen,
312 const void *needle, size_t needlelen);
313#endif
314
cba22528 315#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
316#ifdef fopen
317#undef fopen
318#endif
cba22528
BC
319#define fopen(a,b) git_fopen(a,b)
320extern FILE *git_fopen(const char*, const char*);
321#endif
322
c4582f93
MR
323#ifdef SNPRINTF_RETURNS_BOGUS
324#define snprintf git_snprintf
325extern int git_snprintf(char *str, size_t maxsize,
326 const char *format, ...);
327#define vsnprintf git_vsnprintf
328extern int git_vsnprintf(char *str, size_t maxsize,
329 const char *format, va_list ap);
330#endif
331
726c8ef5
JS
332#ifdef __GLIBC_PREREQ
333#if __GLIBC_PREREQ(2, 1)
334#define HAVE_STRCHRNUL
137c6eaa 335#define HAVE_MEMPCPY
726c8ef5
JS
336#endif
337#endif
338
339#ifndef HAVE_STRCHRNUL
659c69cf 340#define strchrnul gitstrchrnul
9e79f00f
AE
341static inline char *gitstrchrnul(const char *s, int c)
342{
343 while (*s && *s != c)
344 s++;
345 return (char *)s;
346}
659c69cf
RS
347#endif
348
137c6eaa
JN
349#ifndef HAVE_MEMPCPY
350#define mempcpy gitmempcpy
351static inline void *gitmempcpy(void *dest, const void *src, size_t n)
352{
353 return (char *)memcpy(dest, src, n) + n;
354}
355#endif
356
d1efefa4 357extern void release_pack_memory(size_t, int);
97bfeb34 358
112db553
LT
359extern char *xstrdup(const char *str);
360extern void *xmalloc(size_t size);
5bf9219d 361extern void *xmallocz(size_t size);
112db553
LT
362extern void *xmemdupz(const void *data, size_t len);
363extern char *xstrndup(const char *str, size_t len);
364extern void *xrealloc(void *ptr, size_t size);
365extern void *xcalloc(size_t nmemb, size_t size);
366extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
367extern ssize_t xread(int fd, void *buf, size_t len);
368extern ssize_t xwrite(int fd, const void *buf, size_t len);
369extern int xdup(int fd);
370extern FILE *xfdopen(int fd, const char *mode);
371extern int xmkstemp(char *template);
6e180cdc
JH
372extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
373extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
f21a47b2 374
dc49cd76
SP
375static inline size_t xsize_t(off_t len)
376{
377 return (size_t)len;
378}
379
5bb1cda5 380static inline int has_extension(const char *filename, const char *ext)
83a2b841 381{
5bb1cda5
RS
382 size_t len = strlen(filename);
383 size_t extlen = strlen(ext);
83a2b841
RS
384 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
385}
386
4050c0df 387/* Sane ctype - no locale, and works with signed chars */
c2e9364a 388#undef isascii
4050c0df
JH
389#undef isspace
390#undef isdigit
391#undef isalpha
392#undef isalnum
393#undef tolower
394#undef toupper
395extern unsigned char sane_ctype[256];
396#define GIT_SPACE 0x01
397#define GIT_DIGIT 0x02
398#define GIT_ALPHA 0x04
8cc32992 399#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 400#define GIT_REGEX_SPECIAL 0x10
4050c0df 401#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 402#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
403#define isspace(x) sane_istest(x,GIT_SPACE)
404#define isdigit(x) sane_istest(x,GIT_DIGIT)
405#define isalpha(x) sane_istest(x,GIT_ALPHA)
406#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
8cc32992 407#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 408#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
4050c0df
JH
409#define tolower(x) sane_case((unsigned char)(x), 0x20)
410#define toupper(x) sane_case((unsigned char)(x), 0)
411
412static inline int sane_case(int x, int high)
413{
414 if (sane_istest(x, GIT_ALPHA))
415 x = (x & ~0x20) | high;
416 return x;
417}
418
6aead43d
JM
419static inline int strtoul_ui(char const *s, int base, unsigned int *result)
420{
421 unsigned long ul;
422 char *p;
423
424 errno = 0;
425 ul = strtoul(s, &p, base);
426 if (errno || *p || p == s || (unsigned int) ul != ul)
427 return -1;
428 *result = ul;
429 return 0;
430}
431
7791ecbc
JH
432static inline int strtol_i(char const *s, int base, int *result)
433{
434 long ul;
435 char *p;
436
437 errno = 0;
438 ul = strtol(s, &p, base);
439 if (errno || *p || p == s || (int) ul != ul)
440 return -1;
441 *result = ul;
442 return 0;
443}
444
43fe901b
BD
445#ifdef INTERNAL_QSORT
446void git_qsort(void *base, size_t nmemb, size_t size,
447 int(*compar)(const void *, const void *));
448#define qsort git_qsort
449#endif
450
81a24b52
AR
451#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
452# define FORCE_DIR_SET_GID S_ISGID
453#else
454# define FORCE_DIR_SET_GID 0
455#endif
456
c06ff490
KB
457#ifdef NO_NSEC
458#undef USE_NSEC
459#define ST_CTIME_NSEC(st) 0
460#define ST_MTIME_NSEC(st) 0
461#else
c567383b
BG
462#ifdef USE_ST_TIMESPEC
463#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
464#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
465#else
c06ff490
KB
466#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
467#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
468#endif
c567383b 469#endif
c06ff490 470
34779c53
JS
471#ifdef UNRELIABLE_FSTAT
472#define fstat_is_reliable() 0
473#else
474#define fstat_is_reliable() 1
475#endif
476
fc71db39
AR
477/*
478 * Preserves errno, prints a message, but gives no warning for ENOENT.
479 * Always returns the return value of unlink(2).
480 */
481int unlink_or_warn(const char *path);
482
4050c0df 483#endif