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