]> git.ipfire.org Git - thirdparty/git.git/blame - git-compat-util.h
setup.c: Prepare for Windows directory separators.
[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
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
80ba074f
JS
113#ifndef PATH_SEP
114#define PATH_SEP ':'
115#endif
116
4050c0df
JH
117#ifdef __GNUC__
118#define NORETURN __attribute__((__noreturn__))
119#else
120#define NORETURN
121#ifndef __attribute__
122#define __attribute__(x)
123#endif
124#endif
125
126/* General helper functions */
127extern void usage(const char *err) NORETURN;
128extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
129extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 130extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 131
39a3f5ea
PB
132extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
133extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
134extern void set_error_routine(void (*routine)(const char *err, va_list params));
fa39b6b5 135extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
39a3f5ea 136
698a68be
JH
137extern int prefixcmp(const char *str, const char *prefix);
138
4050c0df
JH
139#ifdef NO_MMAP
140
141#ifndef PROT_READ
142#define PROT_READ 1
143#define PROT_WRITE 2
144#define MAP_PRIVATE 1
145#define MAP_FAILED ((void*)-1)
146#endif
147
d6779124
SP
148#define mmap git_mmap
149#define munmap git_munmap
150extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
151extern int git_munmap(void *start, size_t length);
4050c0df 152
5faaf246 153/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
154#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
155
4050c0df
JH
156#else /* NO_MMAP */
157
158#include <sys/mman.h>
5faaf246
JH
159
160/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
161#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
162 (sizeof(void*) >= 8 \
163 ? 1 * 1024 * 1024 * 1024 \
164 : 32 * 1024 * 1024)
4050c0df
JH
165
166#endif /* NO_MMAP */
167
22bac0ea 168#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 169 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 170
6900679c
SH
171#ifdef NO_PREAD
172#define pread git_pread
173extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
174#endif
175
4050c0df
JH
176#ifdef NO_SETENV
177#define setenv gitsetenv
178extern int gitsetenv(const char *, const char *, int);
179#endif
180
ca5bb5d5
SP
181#ifdef NO_MKDTEMP
182#define mkdtemp gitmkdtemp
183extern char *gitmkdtemp(char *);
184#endif
185
731043fd
JR
186#ifdef NO_UNSETENV
187#define unsetenv gitunsetenv
188extern void gitunsetenv(const char *);
189#endif
190
4050c0df
JH
191#ifdef NO_STRCASESTR
192#define strcasestr gitstrcasestr
193extern char *gitstrcasestr(const char *haystack, const char *needle);
194#endif
195
817151e6
PE
196#ifdef NO_STRLCPY
197#define strlcpy gitstrlcpy
198extern size_t gitstrlcpy(char *, const char *, size_t);
199#endif
200
bc6b4f52
JR
201#ifdef NO_STRTOUMAX
202#define strtoumax gitstrtoumax
203extern uintmax_t gitstrtoumax(const char *, char **, int);
204#endif
205
fa0c87c3
AR
206#ifdef NO_HSTRERROR
207#define hstrerror githstrerror
208extern const char *githstrerror(int herror);
209#endif
210
b21b9f1d
RS
211#ifdef NO_MEMMEM
212#define memmem gitmemmem
213void *gitmemmem(const void *haystack, size_t haystacklen,
214 const void *needle, size_t needlelen);
215#endif
216
cba22528 217#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
218#ifdef fopen
219#undef fopen
220#endif
cba22528
BC
221#define fopen(a,b) git_fopen(a,b)
222extern FILE *git_fopen(const char*, const char*);
223#endif
224
c4582f93
MR
225#ifdef SNPRINTF_RETURNS_BOGUS
226#define snprintf git_snprintf
227extern int git_snprintf(char *str, size_t maxsize,
228 const char *format, ...);
229#define vsnprintf git_vsnprintf
230extern int git_vsnprintf(char *str, size_t maxsize,
231 const char *format, va_list ap);
232#endif
233
726c8ef5
JS
234#ifdef __GLIBC_PREREQ
235#if __GLIBC_PREREQ(2, 1)
236#define HAVE_STRCHRNUL
237#endif
238#endif
239
240#ifndef HAVE_STRCHRNUL
659c69cf 241#define strchrnul gitstrchrnul
9e79f00f
AE
242static inline char *gitstrchrnul(const char *s, int c)
243{
244 while (*s && *s != c)
245 s++;
246 return (char *)s;
247}
659c69cf
RS
248#endif
249
d1efefa4 250extern void release_pack_memory(size_t, int);
97bfeb34 251
9befac47
SP
252static inline char* xstrdup(const char *str)
253{
254 char *ret = strdup(str);
97bfeb34 255 if (!ret) {
d1efefa4 256 release_pack_memory(strlen(str) + 1, -1);
97bfeb34
SP
257 ret = strdup(str);
258 if (!ret)
259 die("Out of memory, strdup failed");
260 }
9befac47
SP
261 return ret;
262}
263
4050c0df
JH
264static inline void *xmalloc(size_t size)
265{
266 void *ret = malloc(size);
4e7a2ecc
JH
267 if (!ret && !size)
268 ret = malloc(1);
97bfeb34 269 if (!ret) {
d1efefa4 270 release_pack_memory(size, -1);
97bfeb34
SP
271 ret = malloc(size);
272 if (!ret && !size)
273 ret = malloc(1);
274 if (!ret)
275 die("Out of memory, malloc failed");
276 }
aa5481c1
JH
277#ifdef XMALLOC_POISON
278 memset(ret, 0xA5, size);
279#endif
4050c0df
JH
280 return ret;
281}
282
e8729f53
HO
283/*
284 * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
285 * "data" to the allocated memory, zero terminates the allocated memory,
286 * and returns a pointer to the allocated memory. If the allocation fails,
287 * the program dies.
288 */
68d3025a 289static inline void *xmemdupz(const void *data, size_t len)
5094102e 290{
68d3025a
PH
291 char *p = xmalloc(len + 1);
292 memcpy(p, data, len);
5094102e
DB
293 p[len] = '\0';
294 return p;
295}
296
68d3025a
PH
297static inline char *xstrndup(const char *str, size_t len)
298{
299 char *p = memchr(str, '\0', len);
300 return xmemdupz(str, p ? p - str : len);
301}
302
4050c0df
JH
303static inline void *xrealloc(void *ptr, size_t size)
304{
305 void *ret = realloc(ptr, size);
4e7a2ecc
JH
306 if (!ret && !size)
307 ret = realloc(ptr, 1);
97bfeb34 308 if (!ret) {
d1efefa4 309 release_pack_memory(size, -1);
97bfeb34
SP
310 ret = realloc(ptr, size);
311 if (!ret && !size)
312 ret = realloc(ptr, 1);
313 if (!ret)
314 die("Out of memory, realloc failed");
315 }
4050c0df
JH
316 return ret;
317}
318
319static inline void *xcalloc(size_t nmemb, size_t size)
320{
321 void *ret = calloc(nmemb, size);
4e7a2ecc
JH
322 if (!ret && (!nmemb || !size))
323 ret = calloc(1, 1);
97bfeb34 324 if (!ret) {
d1efefa4 325 release_pack_memory(nmemb * size, -1);
97bfeb34
SP
326 ret = calloc(nmemb, size);
327 if (!ret && (!nmemb || !size))
328 ret = calloc(1, 1);
329 if (!ret)
330 die("Out of memory, calloc failed");
331 }
4050c0df
JH
332 return ret;
333}
334
c4712e45
SP
335static inline void *xmmap(void *start, size_t length,
336 int prot, int flags, int fd, off_t offset)
337{
338 void *ret = mmap(start, length, prot, flags, fd, offset);
339 if (ret == MAP_FAILED) {
9130ac1e
LT
340 if (!length)
341 return NULL;
d1efefa4 342 release_pack_memory(length, fd);
c4712e45
SP
343 ret = mmap(start, length, prot, flags, fd, offset);
344 if (ret == MAP_FAILED)
345 die("Out of memory? mmap failed: %s", strerror(errno));
346 }
347 return ret;
348}
349
e8729f53
HO
350/*
351 * xread() is the same a read(), but it automatically restarts read()
352 * operations with a recoverable error (EAGAIN and EINTR). xread()
353 * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
354 */
1c15afb9
JH
355static inline ssize_t xread(int fd, void *buf, size_t len)
356{
357 ssize_t nr;
358 while (1) {
359 nr = read(fd, buf, len);
360 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
361 continue;
362 return nr;
363 }
364}
365
e8729f53
HO
366/*
367 * xwrite() is the same a write(), but it automatically restarts write()
368 * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
369 * GUARANTEE that "len" bytes is written even if the operation is successful.
370 */
1c15afb9
JH
371static inline ssize_t xwrite(int fd, const void *buf, size_t len)
372{
373 ssize_t nr;
374 while (1) {
375 nr = write(fd, buf, len);
376 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
377 continue;
378 return nr;
379 }
380}
381
f5788250
JM
382static inline int xdup(int fd)
383{
384 int ret = dup(fd);
385 if (ret < 0)
386 die("dup failed: %s", strerror(errno));
387 return ret;
388}
389
390static inline FILE *xfdopen(int fd, const char *mode)
391{
392 FILE *stream = fdopen(fd, mode);
393 if (stream == NULL)
394 die("Out of memory? fdopen failed: %s", strerror(errno));
395 return stream;
396}
397
f21a47b2
LFC
398static inline int xmkstemp(char *template)
399{
400 int fd;
401
402 fd = mkstemp(template);
403 if (fd < 0)
404 die("Unable to create temporary file: %s", strerror(errno));
405 return fd;
406}
407
dc49cd76
SP
408static inline size_t xsize_t(off_t len)
409{
410 return (size_t)len;
411}
412
5bb1cda5 413static inline int has_extension(const char *filename, const char *ext)
83a2b841 414{
5bb1cda5
RS
415 size_t len = strlen(filename);
416 size_t extlen = strlen(ext);
83a2b841
RS
417 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
418}
419
4050c0df
JH
420/* Sane ctype - no locale, and works with signed chars */
421#undef isspace
422#undef isdigit
423#undef isalpha
424#undef isalnum
425#undef tolower
426#undef toupper
427extern unsigned char sane_ctype[256];
428#define GIT_SPACE 0x01
429#define GIT_DIGIT 0x02
430#define GIT_ALPHA 0x04
431#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
432#define isspace(x) sane_istest(x,GIT_SPACE)
433#define isdigit(x) sane_istest(x,GIT_DIGIT)
434#define isalpha(x) sane_istest(x,GIT_ALPHA)
435#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
436#define tolower(x) sane_case((unsigned char)(x), 0x20)
437#define toupper(x) sane_case((unsigned char)(x), 0)
438
439static inline int sane_case(int x, int high)
440{
441 if (sane_istest(x, GIT_ALPHA))
442 x = (x & ~0x20) | high;
443 return x;
444}
445
6aead43d
JM
446static inline int strtoul_ui(char const *s, int base, unsigned int *result)
447{
448 unsigned long ul;
449 char *p;
450
451 errno = 0;
452 ul = strtoul(s, &p, base);
453 if (errno || *p || p == s || (unsigned int) ul != ul)
454 return -1;
455 *result = ul;
456 return 0;
457}
458
7791ecbc
JH
459static inline int strtol_i(char const *s, int base, int *result)
460{
461 long ul;
462 char *p;
463
464 errno = 0;
465 ul = strtol(s, &p, base);
466 if (errno || *p || p == s || (int) ul != ul)
467 return -1;
468 *result = ul;
469 return 0;
470}
471
43fe901b
BD
472#ifdef INTERNAL_QSORT
473void git_qsort(void *base, size_t nmemb, size_t size,
474 int(*compar)(const void *, const void *));
475#define qsort git_qsort
476#endif
477
81a24b52
AR
478#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
479# define FORCE_DIR_SET_GID S_ISGID
480#else
481# define FORCE_DIR_SET_GID 0
482#endif
483
4050c0df 484#endif