Start 1.6.1 cycle
[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 */
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
JH
43#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
44#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6 45#endif
fb952206
JR
46#define _ALL_SOURCE 1
47#define _GNU_SOURCE 1
48#define _BSD_SOURCE 1
85023577 49
4050c0df
JH
50#include <unistd.h>
51#include <stdio.h>
52#include <sys/stat.h>
53#include <fcntl.h>
54#include <stddef.h>
55#include <stdlib.h>
56#include <stdarg.h>
57#include <string.h>
58#include <errno.h>
59#include <limits.h>
60#include <sys/param.h>
4050c0df
JH
61#include <sys/types.h>
62#include <dirent.h>
85023577
JH
63#include <sys/time.h>
64#include <time.h>
65#include <signal.h>
85023577 66#include <fnmatch.h>
f4626df5
JS
67#include <assert.h>
68#include <regex.h>
69#include <utime.h>
70#ifndef __MINGW32__
71#include <sys/wait.h>
85023577
JH
72#include <sys/poll.h>
73#include <sys/socket.h>
80bbe72b 74#include <sys/ioctl.h>
2600973f 75#ifndef NO_SYS_SELECT_H
80bbe72b 76#include <sys/select.h>
2600973f 77#endif
85023577
JH
78#include <netinet/in.h>
79#include <netinet/tcp.h>
80#include <arpa/inet.h>
81#include <netdb.h>
82#include <pwd.h>
007e2ba6 83#include <inttypes.h>
41b20017
RJ
84#if defined(__CYGWIN__)
85#undef _XOPEN_SOURCE
86#include <grp.h>
87#define _XOPEN_SOURCE 600
88#else
fb952206 89#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 90#include <grp.h>
fb952206 91#define _ALL_SOURCE 1
41b20017 92#endif
f4626df5
JS
93#else /* __MINGW32__ */
94/* pull in Windows compatibility stuff */
95#include "compat/mingw.h"
96#endif /* __MINGW32__ */
85023577
JH
97
98#ifndef NO_ICONV
99#include <iconv.h>
100#endif
4050c0df 101
d0c2449f
JH
102/* On most systems <limits.h> would have given us this, but
103 * not on some systems (e.g. GNU/Hurd).
104 */
105#ifndef PATH_MAX
106#define PATH_MAX 4096
107#endif
108
c4001d92
SP
109#ifndef PRIuMAX
110#define PRIuMAX "llu"
111#endif
112
607bb3ff
JS
113#ifndef PRIu32
114#define PRIu32 "u"
115#endif
116
117#ifndef PRIx32
118#define PRIx32 "x"
119#endif
120
80ba074f
JS
121#ifndef PATH_SEP
122#define PATH_SEP ':'
123#endif
124
23326d14
JS
125#ifndef STRIP_EXTENSION
126#define STRIP_EXTENSION ""
127#endif
128
25fe217b
JS
129#ifndef has_dos_drive_prefix
130#define has_dos_drive_prefix(path) 0
131#endif
132
133#ifndef is_dir_sep
134#define is_dir_sep(c) ((c) == '/')
135#endif
136
4050c0df
JH
137#ifdef __GNUC__
138#define NORETURN __attribute__((__noreturn__))
139#else
140#define NORETURN
141#ifndef __attribute__
142#define __attribute__(x)
143#endif
144#endif
145
146/* General helper functions */
147extern void usage(const char *err) NORETURN;
148extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
149extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 150extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 151
39a3f5ea
PB
152extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
153extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
154extern void set_error_routine(void (*routine)(const char *err, va_list params));
fa39b6b5 155extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
39a3f5ea 156
698a68be 157extern int prefixcmp(const char *str, const char *prefix);
bb5799d6 158extern time_t tm_to_time_t(const struct tm *tm);
698a68be 159
fbca5837
MV
160static inline const char *skip_prefix(const char *str, const char *prefix)
161{
162 size_t len = strlen(prefix);
163 return strncmp(str, prefix, len) ? NULL : str + len;
164}
165
4050c0df
JH
166#ifdef NO_MMAP
167
168#ifndef PROT_READ
169#define PROT_READ 1
170#define PROT_WRITE 2
171#define MAP_PRIVATE 1
172#define MAP_FAILED ((void*)-1)
173#endif
174
d6779124
SP
175#define mmap git_mmap
176#define munmap git_munmap
177extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
178extern int git_munmap(void *start, size_t length);
4050c0df 179
5faaf246 180/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
181#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
182
4050c0df
JH
183#else /* NO_MMAP */
184
185#include <sys/mman.h>
5faaf246
JH
186
187/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
188#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
189 (sizeof(void*) >= 8 \
190 ? 1 * 1024 * 1024 * 1024 \
191 : 32 * 1024 * 1024)
4050c0df
JH
192
193#endif /* NO_MMAP */
194
22bac0ea 195#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 196 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 197
6900679c
SH
198#ifdef NO_PREAD
199#define pread git_pread
200extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
201#endif
14086b0a
SP
202/*
203 * Forward decl that will remind us if its twin in cache.h changes.
204 * This function is used in compat/pread.c. But we can't include
205 * cache.h there.
206 */
207extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 208
4050c0df
JH
209#ifdef NO_SETENV
210#define setenv gitsetenv
211extern int gitsetenv(const char *, const char *, int);
212#endif
213
ca5bb5d5
SP
214#ifdef NO_MKDTEMP
215#define mkdtemp gitmkdtemp
216extern char *gitmkdtemp(char *);
217#endif
218
731043fd
JR
219#ifdef NO_UNSETENV
220#define unsetenv gitunsetenv
221extern void gitunsetenv(const char *);
222#endif
223
4050c0df
JH
224#ifdef NO_STRCASESTR
225#define strcasestr gitstrcasestr
226extern char *gitstrcasestr(const char *haystack, const char *needle);
227#endif
228
817151e6
PE
229#ifdef NO_STRLCPY
230#define strlcpy gitstrlcpy
231extern size_t gitstrlcpy(char *, const char *, size_t);
232#endif
233
bc6b4f52
JR
234#ifdef NO_STRTOUMAX
235#define strtoumax gitstrtoumax
236extern uintmax_t gitstrtoumax(const char *, char **, int);
237#endif
238
fa0c87c3
AR
239#ifdef NO_HSTRERROR
240#define hstrerror githstrerror
241extern const char *githstrerror(int herror);
242#endif
243
b21b9f1d
RS
244#ifdef NO_MEMMEM
245#define memmem gitmemmem
246void *gitmemmem(const void *haystack, size_t haystacklen,
247 const void *needle, size_t needlelen);
248#endif
249
cba22528 250#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
251#ifdef fopen
252#undef fopen
253#endif
cba22528
BC
254#define fopen(a,b) git_fopen(a,b)
255extern FILE *git_fopen(const char*, const char*);
256#endif
257
c4582f93
MR
258#ifdef SNPRINTF_RETURNS_BOGUS
259#define snprintf git_snprintf
260extern int git_snprintf(char *str, size_t maxsize,
261 const char *format, ...);
262#define vsnprintf git_vsnprintf
263extern int git_vsnprintf(char *str, size_t maxsize,
264 const char *format, va_list ap);
265#endif
266
726c8ef5
JS
267#ifdef __GLIBC_PREREQ
268#if __GLIBC_PREREQ(2, 1)
269#define HAVE_STRCHRNUL
270#endif
271#endif
272
273#ifndef HAVE_STRCHRNUL
659c69cf 274#define strchrnul gitstrchrnul
9e79f00f
AE
275static inline char *gitstrchrnul(const char *s, int c)
276{
277 while (*s && *s != c)
278 s++;
279 return (char *)s;
280}
659c69cf
RS
281#endif
282
d1efefa4 283extern void release_pack_memory(size_t, int);
97bfeb34 284
112db553
LT
285extern char *xstrdup(const char *str);
286extern void *xmalloc(size_t size);
287extern void *xmemdupz(const void *data, size_t len);
288extern char *xstrndup(const char *str, size_t len);
289extern void *xrealloc(void *ptr, size_t size);
290extern void *xcalloc(size_t nmemb, size_t size);
291extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
292extern ssize_t xread(int fd, void *buf, size_t len);
293extern ssize_t xwrite(int fd, const void *buf, size_t len);
294extern int xdup(int fd);
295extern FILE *xfdopen(int fd, const char *mode);
296extern int xmkstemp(char *template);
f21a47b2 297
dc49cd76
SP
298static inline size_t xsize_t(off_t len)
299{
300 return (size_t)len;
301}
302
5bb1cda5 303static inline int has_extension(const char *filename, const char *ext)
83a2b841 304{
5bb1cda5
RS
305 size_t len = strlen(filename);
306 size_t extlen = strlen(ext);
83a2b841
RS
307 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
308}
309
4050c0df
JH
310/* Sane ctype - no locale, and works with signed chars */
311#undef isspace
312#undef isdigit
313#undef isalpha
314#undef isalnum
315#undef tolower
316#undef toupper
317extern unsigned char sane_ctype[256];
318#define GIT_SPACE 0x01
319#define GIT_DIGIT 0x02
320#define GIT_ALPHA 0x04
321#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
322#define isspace(x) sane_istest(x,GIT_SPACE)
323#define isdigit(x) sane_istest(x,GIT_DIGIT)
324#define isalpha(x) sane_istest(x,GIT_ALPHA)
325#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
326#define tolower(x) sane_case((unsigned char)(x), 0x20)
327#define toupper(x) sane_case((unsigned char)(x), 0)
328
329static inline int sane_case(int x, int high)
330{
331 if (sane_istest(x, GIT_ALPHA))
332 x = (x & ~0x20) | high;
333 return x;
334}
335
6aead43d
JM
336static inline int strtoul_ui(char const *s, int base, unsigned int *result)
337{
338 unsigned long ul;
339 char *p;
340
341 errno = 0;
342 ul = strtoul(s, &p, base);
343 if (errno || *p || p == s || (unsigned int) ul != ul)
344 return -1;
345 *result = ul;
346 return 0;
347}
348
7791ecbc
JH
349static inline int strtol_i(char const *s, int base, int *result)
350{
351 long ul;
352 char *p;
353
354 errno = 0;
355 ul = strtol(s, &p, base);
356 if (errno || *p || p == s || (int) ul != ul)
357 return -1;
358 *result = ul;
359 return 0;
360}
361
43fe901b
BD
362#ifdef INTERNAL_QSORT
363void git_qsort(void *base, size_t nmemb, size_t size,
364 int(*compar)(const void *, const void *));
365#define qsort git_qsort
366#endif
367
81a24b52
AR
368#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
369# define FORCE_DIR_SET_GID S_ISGID
370#else
371# define FORCE_DIR_SET_GID 0
372#endif
373
4050c0df 374#endif