1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
8 * See if our compiler is known to support flexible array members.
10 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
11 # define FLEX_ARRAY /* empty */
12 #elif defined(__GNUC__)
14 # define FLEX_ARRAY /* empty */
16 # define FLEX_ARRAY 0 /* older GNU extension */
21 * Otherwise, default to safer but a bit wasteful traditional style
28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
31 #define TYPEOF(x) (__typeof__(x))
36 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
37 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
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)
42 #if !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX)
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 */
60 #include <sys/param.h>
61 #include <sys/types.h>
73 #include <sys/socket.h>
74 #include <sys/ioctl.h>
75 #ifndef NO_SYS_SELECT_H
76 #include <sys/select.h>
78 #include <netinet/in.h>
79 #include <netinet/tcp.h>
80 #include <arpa/inet.h>
84 #if defined(__CYGWIN__)
87 #define _XOPEN_SOURCE 600
89 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
93 #else /* __MINGW32__ */
94 /* pull in Windows compatibility stuff */
95 #include "compat/mingw.h"
96 #endif /* __MINGW32__ */
102 /* On most systems <limits.h> would have given us this, but
103 * not on some systems (e.g. GNU/Hurd).
106 #define PATH_MAX 4096
110 #define PRIuMAX "llu"
117 #ifndef STRIP_EXTENSION
118 #define STRIP_EXTENSION ""
121 #ifndef has_dos_drive_prefix
122 #define has_dos_drive_prefix(path) 0
126 #define is_dir_sep(c) ((c) == '/')
130 #define NORETURN __attribute__((__noreturn__))
133 #ifndef __attribute__
134 #define __attribute__(x)
138 /* General helper functions */
139 extern void usage(const char *err) NORETURN;
140 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
141 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
142 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
144 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
145 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
146 extern void set_error_routine(void (*routine)(const char *err, va_list params));
147 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
149 extern int prefixcmp(const char *str, const char *prefix);
156 #define MAP_PRIVATE 1
157 #define MAP_FAILED ((void*)-1)
160 #define mmap git_mmap
161 #define munmap git_munmap
162 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
163 extern int git_munmap(void *start, size_t length);
165 /* This value must be multiple of (pagesize * 2) */
166 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
170 #include <sys/mman.h>
172 /* This value must be multiple of (pagesize * 2) */
173 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
174 (sizeof(void*) >= 8 \
175 ? 1 * 1024 * 1024 * 1024 \
180 #define DEFAULT_PACKED_GIT_LIMIT \
181 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
184 #define pread git_pread
185 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
189 #define setenv gitsetenv
190 extern int gitsetenv(const char *, const char *, int);
194 #define mkdtemp gitmkdtemp
195 extern char *gitmkdtemp(char *);
199 #define unsetenv gitunsetenv
200 extern void gitunsetenv(const char *);
204 #define strcasestr gitstrcasestr
205 extern char *gitstrcasestr(const char *haystack, const char *needle);
209 #define strlcpy gitstrlcpy
210 extern size_t gitstrlcpy(char *, const char *, size_t);
214 #define strtoumax gitstrtoumax
215 extern uintmax_t gitstrtoumax(const char *, char **, int);
219 #define hstrerror githstrerror
220 extern const char *githstrerror(int herror);
224 #define memmem gitmemmem
225 void *gitmemmem(const void *haystack, size_t haystacklen,
226 const void *needle, size_t needlelen);
229 #ifdef FREAD_READS_DIRECTORIES
233 #define fopen(a,b) git_fopen(a,b)
234 extern FILE *git_fopen(const char*, const char*);
237 #ifdef SNPRINTF_RETURNS_BOGUS
238 #define snprintf git_snprintf
239 extern int git_snprintf(char *str, size_t maxsize,
240 const char *format, ...);
241 #define vsnprintf git_vsnprintf
242 extern int git_vsnprintf(char *str, size_t maxsize,
243 const char *format, va_list ap);
246 #ifdef __GLIBC_PREREQ
247 #if __GLIBC_PREREQ(2, 1)
248 #define HAVE_STRCHRNUL
252 #ifndef HAVE_STRCHRNUL
253 #define strchrnul gitstrchrnul
254 static inline char *gitstrchrnul(const char *s, int c)
256 while (*s && *s != c)
262 extern void release_pack_memory(size_t, int);
264 static inline char* xstrdup(const char *str)
266 char *ret = strdup(str);
268 release_pack_memory(strlen(str) + 1, -1);
271 die("Out of memory, strdup failed");
276 static inline void *xmalloc(size_t size)
278 void *ret = malloc(size);
282 release_pack_memory(size, -1);
287 die("Out of memory, malloc failed");
289 #ifdef XMALLOC_POISON
290 memset(ret, 0xA5, size);
296 * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
297 * "data" to the allocated memory, zero terminates the allocated memory,
298 * and returns a pointer to the allocated memory. If the allocation fails,
301 static inline void *xmemdupz(const void *data, size_t len)
303 char *p = xmalloc(len + 1);
304 memcpy(p, data, len);
309 static inline char *xstrndup(const char *str, size_t len)
311 char *p = memchr(str, '\0', len);
312 return xmemdupz(str, p ? p - str : len);
315 static inline void *xrealloc(void *ptr, size_t size)
317 void *ret = realloc(ptr, size);
319 ret = realloc(ptr, 1);
321 release_pack_memory(size, -1);
322 ret = realloc(ptr, size);
324 ret = realloc(ptr, 1);
326 die("Out of memory, realloc failed");
331 static inline void *xcalloc(size_t nmemb, size_t size)
333 void *ret = calloc(nmemb, size);
334 if (!ret && (!nmemb || !size))
337 release_pack_memory(nmemb * size, -1);
338 ret = calloc(nmemb, size);
339 if (!ret && (!nmemb || !size))
342 die("Out of memory, calloc failed");
347 static inline void *xmmap(void *start, size_t length,
348 int prot, int flags, int fd, off_t offset)
350 void *ret = mmap(start, length, prot, flags, fd, offset);
351 if (ret == MAP_FAILED) {
354 release_pack_memory(length, fd);
355 ret = mmap(start, length, prot, flags, fd, offset);
356 if (ret == MAP_FAILED)
357 die("Out of memory? mmap failed: %s", strerror(errno));
363 * xread() is the same a read(), but it automatically restarts read()
364 * operations with a recoverable error (EAGAIN and EINTR). xread()
365 * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
367 static inline ssize_t xread(int fd, void *buf, size_t len)
371 nr = read(fd, buf, len);
372 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
379 * xwrite() is the same a write(), but it automatically restarts write()
380 * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
381 * GUARANTEE that "len" bytes is written even if the operation is successful.
383 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
387 nr = write(fd, buf, len);
388 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
394 static inline int xdup(int fd)
398 die("dup failed: %s", strerror(errno));
402 static inline FILE *xfdopen(int fd, const char *mode)
404 FILE *stream = fdopen(fd, mode);
406 die("Out of memory? fdopen failed: %s", strerror(errno));
410 static inline int xmkstemp(char *template)
414 fd = mkstemp(template);
416 die("Unable to create temporary file: %s", strerror(errno));
420 static inline size_t xsize_t(off_t len)
425 static inline int has_extension(const char *filename, const char *ext)
427 size_t len = strlen(filename);
428 size_t extlen = strlen(ext);
429 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
432 /* Sane ctype - no locale, and works with signed chars */
439 extern unsigned char sane_ctype[256];
440 #define GIT_SPACE 0x01
441 #define GIT_DIGIT 0x02
442 #define GIT_ALPHA 0x04
443 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
444 #define isspace(x) sane_istest(x,GIT_SPACE)
445 #define isdigit(x) sane_istest(x,GIT_DIGIT)
446 #define isalpha(x) sane_istest(x,GIT_ALPHA)
447 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
448 #define tolower(x) sane_case((unsigned char)(x), 0x20)
449 #define toupper(x) sane_case((unsigned char)(x), 0)
451 static inline int sane_case(int x, int high)
453 if (sane_istest(x, GIT_ALPHA))
454 x = (x & ~0x20) | high;
458 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
464 ul = strtoul(s, &p, base);
465 if (errno || *p || p == s || (unsigned int) ul != ul)
471 static inline int strtol_i(char const *s, int base, int *result)
477 ul = strtol(s, &p, base);
478 if (errno || *p || p == s || (int) ul != ul)
484 #ifdef INTERNAL_QSORT
485 void git_qsort(void *base, size_t nmemb, size_t size,
486 int(*compar)(const void *, const void *));
487 #define qsort git_qsort
490 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
491 # define FORCE_DIR_SET_GID S_ISGID
493 # define FORCE_DIR_SET_GID 0