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