]> git.ipfire.org Git - thirdparty/git.git/blame - git-compat-util.h
Merge git://repo.or.cz/git-gui
[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 */
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
95ca1c6c 42#if !defined(__APPLE__) && !defined(__FreeBSD__)
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>
66#include <sys/wait.h>
67#include <fnmatch.h>
68#include <sys/poll.h>
69#include <sys/socket.h>
80bbe72b
JS
70#include <sys/ioctl.h>
71#include <sys/select.h>
85023577
JH
72#include <assert.h>
73#include <regex.h>
74#include <netinet/in.h>
75#include <netinet/tcp.h>
76#include <arpa/inet.h>
77#include <netdb.h>
78#include <pwd.h>
007e2ba6 79#include <inttypes.h>
41b20017
RJ
80#if defined(__CYGWIN__)
81#undef _XOPEN_SOURCE
82#include <grp.h>
83#define _XOPEN_SOURCE 600
84#else
fb952206 85#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 86#include <grp.h>
fb952206 87#define _ALL_SOURCE 1
41b20017 88#endif
85023577
JH
89
90#ifndef NO_ICONV
91#include <iconv.h>
92#endif
4050c0df 93
d0c2449f
JH
94/* On most systems <limits.h> would have given us this, but
95 * not on some systems (e.g. GNU/Hurd).
96 */
97#ifndef PATH_MAX
98#define PATH_MAX 4096
99#endif
100
c4001d92
SP
101#ifndef PRIuMAX
102#define PRIuMAX "llu"
103#endif
104
4050c0df
JH
105#ifdef __GNUC__
106#define NORETURN __attribute__((__noreturn__))
107#else
108#define NORETURN
109#ifndef __attribute__
110#define __attribute__(x)
111#endif
112#endif
113
114/* General helper functions */
115extern void usage(const char *err) NORETURN;
116extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
117extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 118extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 119
39a3f5ea
PB
120extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
121extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
122extern void set_error_routine(void (*routine)(const char *err, va_list params));
fa39b6b5 123extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
39a3f5ea 124
698a68be
JH
125extern int prefixcmp(const char *str, const char *prefix);
126
4050c0df
JH
127#ifdef NO_MMAP
128
129#ifndef PROT_READ
130#define PROT_READ 1
131#define PROT_WRITE 2
132#define MAP_PRIVATE 1
133#define MAP_FAILED ((void*)-1)
134#endif
135
d6779124
SP
136#define mmap git_mmap
137#define munmap git_munmap
138extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
139extern int git_munmap(void *start, size_t length);
4050c0df 140
5faaf246 141/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
142#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
143
4050c0df
JH
144#else /* NO_MMAP */
145
146#include <sys/mman.h>
5faaf246
JH
147
148/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
149#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
150 (sizeof(void*) >= 8 \
151 ? 1 * 1024 * 1024 * 1024 \
152 : 32 * 1024 * 1024)
4050c0df
JH
153
154#endif /* NO_MMAP */
155
22bac0ea 156#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 157 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 158
6900679c
SH
159#ifdef NO_PREAD
160#define pread git_pread
161extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
162#endif
163
4050c0df
JH
164#ifdef NO_SETENV
165#define setenv gitsetenv
166extern int gitsetenv(const char *, const char *, int);
167#endif
168
ca5bb5d5
SP
169#ifdef NO_MKDTEMP
170#define mkdtemp gitmkdtemp
171extern char *gitmkdtemp(char *);
172#endif
173
731043fd
JR
174#ifdef NO_UNSETENV
175#define unsetenv gitunsetenv
176extern void gitunsetenv(const char *);
177#endif
178
4050c0df
JH
179#ifdef NO_STRCASESTR
180#define strcasestr gitstrcasestr
181extern char *gitstrcasestr(const char *haystack, const char *needle);
182#endif
183
817151e6
PE
184#ifdef NO_STRLCPY
185#define strlcpy gitstrlcpy
186extern size_t gitstrlcpy(char *, const char *, size_t);
187#endif
188
bc6b4f52
JR
189#ifdef NO_STRTOUMAX
190#define strtoumax gitstrtoumax
191extern uintmax_t gitstrtoumax(const char *, char **, int);
192#endif
193
fa0c87c3
AR
194#ifdef NO_HSTRERROR
195#define hstrerror githstrerror
196extern const char *githstrerror(int herror);
197#endif
198
b21b9f1d
RS
199#ifdef NO_MEMMEM
200#define memmem gitmemmem
201void *gitmemmem(const void *haystack, size_t haystacklen,
202 const void *needle, size_t needlelen);
203#endif
204
726c8ef5
JS
205#ifdef __GLIBC_PREREQ
206#if __GLIBC_PREREQ(2, 1)
207#define HAVE_STRCHRNUL
208#endif
209#endif
210
211#ifndef HAVE_STRCHRNUL
659c69cf 212#define strchrnul gitstrchrnul
9e79f00f
AE
213static inline char *gitstrchrnul(const char *s, int c)
214{
215 while (*s && *s != c)
216 s++;
217 return (char *)s;
218}
659c69cf
RS
219#endif
220
d1efefa4 221extern void release_pack_memory(size_t, int);
97bfeb34 222
9befac47
SP
223static inline char* xstrdup(const char *str)
224{
225 char *ret = strdup(str);
97bfeb34 226 if (!ret) {
d1efefa4 227 release_pack_memory(strlen(str) + 1, -1);
97bfeb34
SP
228 ret = strdup(str);
229 if (!ret)
230 die("Out of memory, strdup failed");
231 }
9befac47
SP
232 return ret;
233}
234
4050c0df
JH
235static inline void *xmalloc(size_t size)
236{
237 void *ret = malloc(size);
4e7a2ecc
JH
238 if (!ret && !size)
239 ret = malloc(1);
97bfeb34 240 if (!ret) {
d1efefa4 241 release_pack_memory(size, -1);
97bfeb34
SP
242 ret = malloc(size);
243 if (!ret && !size)
244 ret = malloc(1);
245 if (!ret)
246 die("Out of memory, malloc failed");
247 }
aa5481c1
JH
248#ifdef XMALLOC_POISON
249 memset(ret, 0xA5, size);
250#endif
4050c0df
JH
251 return ret;
252}
253
68d3025a 254static inline void *xmemdupz(const void *data, size_t len)
5094102e 255{
68d3025a
PH
256 char *p = xmalloc(len + 1);
257 memcpy(p, data, len);
5094102e
DB
258 p[len] = '\0';
259 return p;
260}
261
68d3025a
PH
262static inline char *xstrndup(const char *str, size_t len)
263{
264 char *p = memchr(str, '\0', len);
265 return xmemdupz(str, p ? p - str : len);
266}
267
4050c0df
JH
268static inline void *xrealloc(void *ptr, size_t size)
269{
270 void *ret = realloc(ptr, size);
4e7a2ecc
JH
271 if (!ret && !size)
272 ret = realloc(ptr, 1);
97bfeb34 273 if (!ret) {
d1efefa4 274 release_pack_memory(size, -1);
97bfeb34
SP
275 ret = realloc(ptr, size);
276 if (!ret && !size)
277 ret = realloc(ptr, 1);
278 if (!ret)
279 die("Out of memory, realloc failed");
280 }
4050c0df
JH
281 return ret;
282}
283
284static inline void *xcalloc(size_t nmemb, size_t size)
285{
286 void *ret = calloc(nmemb, size);
4e7a2ecc
JH
287 if (!ret && (!nmemb || !size))
288 ret = calloc(1, 1);
97bfeb34 289 if (!ret) {
d1efefa4 290 release_pack_memory(nmemb * size, -1);
97bfeb34
SP
291 ret = calloc(nmemb, size);
292 if (!ret && (!nmemb || !size))
293 ret = calloc(1, 1);
294 if (!ret)
295 die("Out of memory, calloc failed");
296 }
4050c0df
JH
297 return ret;
298}
299
c4712e45
SP
300static inline void *xmmap(void *start, size_t length,
301 int prot, int flags, int fd, off_t offset)
302{
303 void *ret = mmap(start, length, prot, flags, fd, offset);
304 if (ret == MAP_FAILED) {
9130ac1e
LT
305 if (!length)
306 return NULL;
d1efefa4 307 release_pack_memory(length, fd);
c4712e45
SP
308 ret = mmap(start, length, prot, flags, fd, offset);
309 if (ret == MAP_FAILED)
310 die("Out of memory? mmap failed: %s", strerror(errno));
311 }
312 return ret;
313}
314
1c15afb9
JH
315static inline ssize_t xread(int fd, void *buf, size_t len)
316{
317 ssize_t nr;
318 while (1) {
319 nr = read(fd, buf, len);
320 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
321 continue;
322 return nr;
323 }
324}
325
326static inline ssize_t xwrite(int fd, const void *buf, size_t len)
327{
328 ssize_t nr;
329 while (1) {
330 nr = write(fd, buf, len);
331 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
332 continue;
333 return nr;
334 }
335}
336
f5788250
JM
337static inline int xdup(int fd)
338{
339 int ret = dup(fd);
340 if (ret < 0)
341 die("dup failed: %s", strerror(errno));
342 return ret;
343}
344
345static inline FILE *xfdopen(int fd, const char *mode)
346{
347 FILE *stream = fdopen(fd, mode);
348 if (stream == NULL)
349 die("Out of memory? fdopen failed: %s", strerror(errno));
350 return stream;
351}
352
f21a47b2
LFC
353static inline int xmkstemp(char *template)
354{
355 int fd;
356
357 fd = mkstemp(template);
358 if (fd < 0)
359 die("Unable to create temporary file: %s", strerror(errno));
360 return fd;
361}
362
dc49cd76
SP
363static inline size_t xsize_t(off_t len)
364{
365 return (size_t)len;
366}
367
5bb1cda5 368static inline int has_extension(const char *filename, const char *ext)
83a2b841 369{
5bb1cda5
RS
370 size_t len = strlen(filename);
371 size_t extlen = strlen(ext);
83a2b841
RS
372 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
373}
374
4050c0df
JH
375/* Sane ctype - no locale, and works with signed chars */
376#undef isspace
377#undef isdigit
378#undef isalpha
379#undef isalnum
380#undef tolower
381#undef toupper
382extern unsigned char sane_ctype[256];
383#define GIT_SPACE 0x01
384#define GIT_DIGIT 0x02
385#define GIT_ALPHA 0x04
386#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
387#define isspace(x) sane_istest(x,GIT_SPACE)
388#define isdigit(x) sane_istest(x,GIT_DIGIT)
389#define isalpha(x) sane_istest(x,GIT_ALPHA)
390#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
391#define tolower(x) sane_case((unsigned char)(x), 0x20)
392#define toupper(x) sane_case((unsigned char)(x), 0)
393
394static inline int sane_case(int x, int high)
395{
396 if (sane_istest(x, GIT_ALPHA))
397 x = (x & ~0x20) | high;
398 return x;
399}
400
6aead43d
JM
401static inline int strtoul_ui(char const *s, int base, unsigned int *result)
402{
403 unsigned long ul;
404 char *p;
405
406 errno = 0;
407 ul = strtoul(s, &p, base);
408 if (errno || *p || p == s || (unsigned int) ul != ul)
409 return -1;
410 *result = ul;
411 return 0;
412}
413
7791ecbc
JH
414static inline int strtol_i(char const *s, int base, int *result)
415{
416 long ul;
417 char *p;
418
419 errno = 0;
420 ul = strtol(s, &p, base);
421 if (errno || *p || p == s || (int) ul != ul)
422 return -1;
423 *result = ul;
424 return 0;
425}
426
4050c0df 427#endif