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) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
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)
44 * On Solaris, when _XOPEN_EXTENDED is set, its header file
45 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
46 * setting to say we are XPG5 or XPG6. Also on Solaris,
47 * XPG6 programs must be compiled with a c99 compiler, while
48 * non XPG6 programs must be compiled with a pre-c99 compiler.
50 # if __STDC_VERSION__ - 0 >= 199901L
51 # define _XOPEN_SOURCE 600
53 # define _XOPEN_SOURCE 500
55 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX)
56 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
58 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
64 #define _NETBSD_SOURCE 1
76 #include <sys/param.h>
77 #include <sys/types.h>
89 #include <sys/socket.h>
90 #include <sys/ioctl.h>
91 #ifndef NO_SYS_SELECT_H
92 #include <sys/select.h>
94 #include <netinet/in.h>
95 #include <netinet/tcp.h>
96 #include <arpa/inet.h>
100 #if defined(__CYGWIN__)
103 #define _XOPEN_SOURCE 600
104 #include "compat/cygwin.h"
106 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
108 #define _ALL_SOURCE 1
110 #else /* __MINGW32__ */
111 /* pull in Windows compatibility stuff */
112 #include "compat/mingw.h"
113 #endif /* __MINGW32__ */
118 #define basename gitbasename
119 extern char *gitbasename(char *);
127 #include <openssl/ssl.h>
128 #include <openssl/err.h>
131 /* On most systems <limits.h> would have given us this, but
132 * not on some systems (e.g. GNU/Hurd).
135 #define PATH_MAX 4096
139 #define PRIuMAX "llu"
154 #ifndef STRIP_EXTENSION
155 #define STRIP_EXTENSION ""
158 #ifndef has_dos_drive_prefix
159 #define has_dos_drive_prefix(path) 0
163 #define is_dir_sep(c) ((c) == '/')
167 #define NORETURN __attribute__((__noreturn__))
170 #ifndef __attribute__
171 #define __attribute__(x)
175 /* General helper functions */
176 extern void usage(const char *err) NORETURN;
177 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
178 extern void die_errno(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
179 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
180 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
182 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
184 extern int prefixcmp(const char *str, const char *prefix);
185 extern time_t tm_to_time_t(const struct tm *tm);
187 static inline const char *skip_prefix(const char *str, const char *prefix)
189 size_t len = strlen(prefix);
190 return strncmp(str, prefix, len) ? NULL : str + len;
193 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
198 #define MAP_PRIVATE 1
199 #define MAP_FAILED ((void*)-1)
202 #define mmap git_mmap
203 #define munmap git_munmap
204 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
205 extern int git_munmap(void *start, size_t length);
207 #else /* NO_MMAP || USE_WIN32_MMAP */
209 #include <sys/mman.h>
211 #endif /* NO_MMAP || USE_WIN32_MMAP */
215 /* This value must be multiple of (pagesize * 2) */
216 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
220 /* This value must be multiple of (pagesize * 2) */
221 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
222 (sizeof(void*) >= 8 \
223 ? 1 * 1024 * 1024 * 1024 \
228 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
229 #define on_disk_bytes(st) ((st).st_size)
231 #define on_disk_bytes(st) ((st).st_blocks * 512)
234 #define DEFAULT_PACKED_GIT_LIMIT \
235 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
238 #define pread git_pread
239 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
242 * Forward decl that will remind us if its twin in cache.h changes.
243 * This function is used in compat/pread.c. But we can't include
246 extern ssize_t read_in_full(int fd, void *buf, size_t count);
249 #define setenv gitsetenv
250 extern int gitsetenv(const char *, const char *, int);
254 #define mkdtemp gitmkdtemp
255 extern char *gitmkdtemp(char *);
259 #define mkstemps gitmkstemps
260 extern int gitmkstemps(char *, int);
264 #define unsetenv gitunsetenv
265 extern void gitunsetenv(const char *);
269 #define strcasestr gitstrcasestr
270 extern char *gitstrcasestr(const char *haystack, const char *needle);
274 #define strlcpy gitstrlcpy
275 extern size_t gitstrlcpy(char *, const char *, size_t);
279 #define strtoumax gitstrtoumax
280 extern uintmax_t gitstrtoumax(const char *, char **, int);
284 #define hstrerror githstrerror
285 extern const char *githstrerror(int herror);
289 #define memmem gitmemmem
290 void *gitmemmem(const void *haystack, size_t haystacklen,
291 const void *needle, size_t needlelen);
294 #ifdef FREAD_READS_DIRECTORIES
298 #define fopen(a,b) git_fopen(a,b)
299 extern FILE *git_fopen(const char*, const char*);
302 #ifdef SNPRINTF_RETURNS_BOGUS
303 #define snprintf git_snprintf
304 extern int git_snprintf(char *str, size_t maxsize,
305 const char *format, ...);
306 #define vsnprintf git_vsnprintf
307 extern int git_vsnprintf(char *str, size_t maxsize,
308 const char *format, va_list ap);
311 #ifdef __GLIBC_PREREQ
312 #if __GLIBC_PREREQ(2, 1)
313 #define HAVE_STRCHRNUL
317 #ifndef HAVE_STRCHRNUL
318 #define strchrnul gitstrchrnul
319 static inline char *gitstrchrnul(const char *s, int c)
321 while (*s && *s != c)
327 extern void release_pack_memory(size_t, int);
329 extern char *xstrdup(const char *str);
330 extern void *xmalloc(size_t size);
331 extern void *xmemdupz(const void *data, size_t len);
332 extern char *xstrndup(const char *str, size_t len);
333 extern void *xrealloc(void *ptr, size_t size);
334 extern void *xcalloc(size_t nmemb, size_t size);
335 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
336 extern ssize_t xread(int fd, void *buf, size_t len);
337 extern ssize_t xwrite(int fd, const void *buf, size_t len);
338 extern int xdup(int fd);
339 extern FILE *xfdopen(int fd, const char *mode);
340 extern int xmkstemp(char *template);
341 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
342 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
344 static inline size_t xsize_t(off_t len)
349 static inline int has_extension(const char *filename, const char *ext)
351 size_t len = strlen(filename);
352 size_t extlen = strlen(ext);
353 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
356 /* Sane ctype - no locale, and works with signed chars */
364 extern unsigned char sane_ctype[256];
365 #define GIT_SPACE 0x01
366 #define GIT_DIGIT 0x02
367 #define GIT_ALPHA 0x04
368 #define GIT_GLOB_SPECIAL 0x08
369 #define GIT_REGEX_SPECIAL 0x10
370 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
371 #define isascii(x) (((x) & ~0x7f) == 0)
372 #define isspace(x) sane_istest(x,GIT_SPACE)
373 #define isdigit(x) sane_istest(x,GIT_DIGIT)
374 #define isalpha(x) sane_istest(x,GIT_ALPHA)
375 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
376 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
377 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
378 #define tolower(x) sane_case((unsigned char)(x), 0x20)
379 #define toupper(x) sane_case((unsigned char)(x), 0)
381 static inline int sane_case(int x, int high)
383 if (sane_istest(x, GIT_ALPHA))
384 x = (x & ~0x20) | high;
388 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
394 ul = strtoul(s, &p, base);
395 if (errno || *p || p == s || (unsigned int) ul != ul)
401 static inline int strtol_i(char const *s, int base, int *result)
407 ul = strtol(s, &p, base);
408 if (errno || *p || p == s || (int) ul != ul)
414 #ifdef INTERNAL_QSORT
415 void git_qsort(void *base, size_t nmemb, size_t size,
416 int(*compar)(const void *, const void *));
417 #define qsort git_qsort
420 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
421 # define FORCE_DIR_SET_GID S_ISGID
423 # define FORCE_DIR_SET_GID 0
428 #define ST_CTIME_NSEC(st) 0
429 #define ST_MTIME_NSEC(st) 0
431 #ifdef USE_ST_TIMESPEC
432 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
433 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
435 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
436 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
440 #ifdef UNRELIABLE_FSTAT
441 #define fstat_is_reliable() 0
443 #define fstat_is_reliable() 1
447 * Preserves errno, prints a message, but gives no warning for ENOENT.
448 * Always returns the return value of unlink(2).
450 int unlink_or_warn(const char *path);