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);
150 extern time_t tm_to_time_t(const struct tm *tm);
157 #define MAP_PRIVATE 1
158 #define MAP_FAILED ((void*)-1)
161 #define mmap git_mmap
162 #define munmap git_munmap
163 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
164 extern int git_munmap(void *start, size_t length);
166 /* This value must be multiple of (pagesize * 2) */
167 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
171 #include <sys/mman.h>
173 /* This value must be multiple of (pagesize * 2) */
174 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
175 (sizeof(void*) >= 8 \
176 ? 1 * 1024 * 1024 * 1024 \
181 #define DEFAULT_PACKED_GIT_LIMIT \
182 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
185 #define pread git_pread
186 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
190 #define setenv gitsetenv
191 extern int gitsetenv(const char *, const char *, int);
195 #define mkdtemp gitmkdtemp
196 extern char *gitmkdtemp(char *);
200 #define unsetenv gitunsetenv
201 extern void gitunsetenv(const char *);
205 #define strcasestr gitstrcasestr
206 extern char *gitstrcasestr(const char *haystack, const char *needle);
210 #define strlcpy gitstrlcpy
211 extern size_t gitstrlcpy(char *, const char *, size_t);
215 #define strtoumax gitstrtoumax
216 extern uintmax_t gitstrtoumax(const char *, char **, int);
220 #define hstrerror githstrerror
221 extern const char *githstrerror(int herror);
225 #define memmem gitmemmem
226 void *gitmemmem(const void *haystack, size_t haystacklen,
227 const void *needle, size_t needlelen);
230 #ifdef FREAD_READS_DIRECTORIES
234 #define fopen(a,b) git_fopen(a,b)
235 extern FILE *git_fopen(const char*, const char*);
238 #ifdef SNPRINTF_RETURNS_BOGUS
239 #define snprintf git_snprintf
240 extern int git_snprintf(char *str, size_t maxsize,
241 const char *format, ...);
242 #define vsnprintf git_vsnprintf
243 extern int git_vsnprintf(char *str, size_t maxsize,
244 const char *format, va_list ap);
247 #ifdef __GLIBC_PREREQ
248 #if __GLIBC_PREREQ(2, 1)
249 #define HAVE_STRCHRNUL
253 #ifndef HAVE_STRCHRNUL
254 #define strchrnul gitstrchrnul
255 static inline char *gitstrchrnul(const char *s, int c)
257 while (*s && *s != c)
263 extern void release_pack_memory(size_t, int);
265 static inline char* xstrdup(const char *str)
267 char *ret = strdup(str);
269 release_pack_memory(strlen(str) + 1, -1);
272 die("Out of memory, strdup failed");
277 static inline void *xmalloc(size_t size)
279 void *ret = malloc(size);
283 release_pack_memory(size, -1);
288 die("Out of memory, malloc failed");
290 #ifdef XMALLOC_POISON
291 memset(ret, 0xA5, size);
297 * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
298 * "data" to the allocated memory, zero terminates the allocated memory,
299 * and returns a pointer to the allocated memory. If the allocation fails,
302 static inline void *xmemdupz(const void *data, size_t len)
304 char *p = xmalloc(len + 1);
305 memcpy(p, data, len);
310 static inline char *xstrndup(const char *str, size_t len)
312 char *p = memchr(str, '\0', len);
313 return xmemdupz(str, p ? p - str : len);
316 static inline void *xrealloc(void *ptr, size_t size)
318 void *ret = realloc(ptr, size);
320 ret = realloc(ptr, 1);
322 release_pack_memory(size, -1);
323 ret = realloc(ptr, size);
325 ret = realloc(ptr, 1);
327 die("Out of memory, realloc failed");
332 static inline void *xcalloc(size_t nmemb, size_t size)
334 void *ret = calloc(nmemb, size);
335 if (!ret && (!nmemb || !size))
338 release_pack_memory(nmemb * size, -1);
339 ret = calloc(nmemb, size);
340 if (!ret && (!nmemb || !size))
343 die("Out of memory, calloc failed");
348 static inline void *xmmap(void *start, size_t length,
349 int prot, int flags, int fd, off_t offset)
351 void *ret = mmap(start, length, prot, flags, fd, offset);
352 if (ret == MAP_FAILED) {
355 release_pack_memory(length, fd);
356 ret = mmap(start, length, prot, flags, fd, offset);
357 if (ret == MAP_FAILED)
358 die("Out of memory? mmap failed: %s", strerror(errno));
364 * xread() is the same a read(), but it automatically restarts read()
365 * operations with a recoverable error (EAGAIN and EINTR). xread()
366 * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
368 static inline ssize_t xread(int fd, void *buf, size_t len)
372 nr = read(fd, buf, len);
373 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
380 * xwrite() is the same a write(), but it automatically restarts write()
381 * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
382 * GUARANTEE that "len" bytes is written even if the operation is successful.
384 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
388 nr = write(fd, buf, len);
389 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
395 static inline int xdup(int fd)
399 die("dup failed: %s", strerror(errno));
403 static inline FILE *xfdopen(int fd, const char *mode)
405 FILE *stream = fdopen(fd, mode);
407 die("Out of memory? fdopen failed: %s", strerror(errno));
411 static inline int xmkstemp(char *template)
415 fd = mkstemp(template);
417 die("Unable to create temporary file: %s", strerror(errno));
421 static inline size_t xsize_t(off_t len)
426 static inline int has_extension(const char *filename, const char *ext)
428 size_t len = strlen(filename);
429 size_t extlen = strlen(ext);
430 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
433 /* Sane ctype - no locale, and works with signed chars */
440 extern unsigned char sane_ctype[256];
441 #define GIT_SPACE 0x01
442 #define GIT_DIGIT 0x02
443 #define GIT_ALPHA 0x04
444 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
445 #define isspace(x) sane_istest(x,GIT_SPACE)
446 #define isdigit(x) sane_istest(x,GIT_DIGIT)
447 #define isalpha(x) sane_istest(x,GIT_ALPHA)
448 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
449 #define tolower(x) sane_case((unsigned char)(x), 0x20)
450 #define toupper(x) sane_case((unsigned char)(x), 0)
452 static inline int sane_case(int x, int high)
454 if (sane_istest(x, GIT_ALPHA))
455 x = (x & ~0x20) | high;
459 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
465 ul = strtoul(s, &p, base);
466 if (errno || *p || p == s || (unsigned int) ul != ul)
472 static inline int strtol_i(char const *s, int base, int *result)
478 ul = strtol(s, &p, base);
479 if (errno || *p || p == s || (int) ul != ul)
485 #ifdef INTERNAL_QSORT
486 void git_qsort(void *base, size_t nmemb, size_t size,
487 int(*compar)(const void *, const void *));
488 #define qsort git_qsort
491 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
492 # define FORCE_DIR_SET_GID S_ISGID
494 # define FORCE_DIR_SET_GID 0