Merge branch 'maint-1.6.6' into maint
[tgit.git] / git-compat-util.h
bloba3c45373669cd8482c04d5815862ed36a153572d
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
6 #ifndef FLEX_ARRAY
7 /*
8 * See if our compiler is known to support flexible array members.
9 */
10 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
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
21 * Otherwise, default to safer but a bit wasteful traditional style
23 #ifndef FLEX_ARRAY
24 # define FLEX_ARRAY 1
25 #endif
26 #endif
28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
31 #ifdef __GNUC__
32 #define TYPEOF(x) (__typeof__(x))
33 #else
34 #define TYPEOF(x)
35 #endif
37 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
38 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
40 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
42 /* Approximation of the length of the decimal representation of this type. */
43 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
45 #if defined(__sun__)
47 * On Solaris, when _XOPEN_EXTENDED is set, its header file
48 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
49 * setting to say we are XPG5 or XPG6. Also on Solaris,
50 * XPG6 programs must be compiled with a c99 compiler, while
51 * non XPG6 programs must be compiled with a pre-c99 compiler.
53 # if __STDC_VERSION__ - 0 >= 199901L
54 # define _XOPEN_SOURCE 600
55 # else
56 # define _XOPEN_SOURCE 500
57 # endif
58 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX) && !defined(sgi)
59 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
60 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
61 #endif
62 #define _ALL_SOURCE 1
63 #define _GNU_SOURCE 1
64 #define _BSD_SOURCE 1
65 #define _NETBSD_SOURCE 1
66 #define _SGI_SOURCE 1
68 #ifdef WIN32 /* Both MinGW and MSVC */
69 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
70 #include <winsock2.h>
71 #include <windows.h>
72 #endif
74 #include <unistd.h>
75 #include <stdio.h>
76 #include <sys/stat.h>
77 #include <fcntl.h>
78 #include <stddef.h>
79 #include <stdlib.h>
80 #include <stdarg.h>
81 #include <string.h>
82 #include <errno.h>
83 #include <limits.h>
84 #include <sys/param.h>
85 #include <sys/types.h>
86 #include <dirent.h>
87 #include <sys/time.h>
88 #include <time.h>
89 #include <signal.h>
90 #include <fnmatch.h>
91 #include <assert.h>
92 #include <regex.h>
93 #include <utime.h>
94 #ifndef __MINGW32__
95 #include <sys/wait.h>
96 #include <sys/poll.h>
97 #include <sys/socket.h>
98 #include <sys/ioctl.h>
99 #include <termios.h>
100 #ifndef NO_SYS_SELECT_H
101 #include <sys/select.h>
102 #endif
103 #include <netinet/in.h>
104 #include <netinet/tcp.h>
105 #include <arpa/inet.h>
106 #include <netdb.h>
107 #include <pwd.h>
108 #include <inttypes.h>
109 #if defined(__CYGWIN__)
110 #undef _XOPEN_SOURCE
111 #include <grp.h>
112 #define _XOPEN_SOURCE 600
113 #include "compat/cygwin.h"
114 #else
115 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
116 #include <grp.h>
117 #define _ALL_SOURCE 1
118 #endif
119 #else /* __MINGW32__ */
120 /* pull in Windows compatibility stuff */
121 #include "compat/mingw.h"
122 #endif /* __MINGW32__ */
123 #ifdef _MSC_VER
124 #include "compat/msvc.h"
125 #endif
127 #ifndef NO_LIBGEN_H
128 #include <libgen.h>
129 #else
130 #define basename gitbasename
131 extern char *gitbasename(char *);
132 #endif
134 #ifndef NO_ICONV
135 #include <iconv.h>
136 #endif
138 #ifndef NO_OPENSSL
139 #include <openssl/ssl.h>
140 #include <openssl/err.h>
141 #endif
143 /* On most systems <limits.h> would have given us this, but
144 * not on some systems (e.g. GNU/Hurd).
146 #ifndef PATH_MAX
147 #define PATH_MAX 4096
148 #endif
150 #ifndef PRIuMAX
151 #define PRIuMAX "llu"
152 #endif
154 #ifndef PRIu32
155 #define PRIu32 "u"
156 #endif
158 #ifndef PRIx32
159 #define PRIx32 "x"
160 #endif
162 #ifndef PATH_SEP
163 #define PATH_SEP ':'
164 #endif
166 #ifndef STRIP_EXTENSION
167 #define STRIP_EXTENSION ""
168 #endif
170 #ifndef has_dos_drive_prefix
171 #define has_dos_drive_prefix(path) 0
172 #endif
174 #ifndef is_dir_sep
175 #define is_dir_sep(c) ((c) == '/')
176 #endif
178 #ifdef __GNUC__
179 #define NORETURN __attribute__((__noreturn__))
180 #define NORETURN_PTR __attribute__((__noreturn__))
181 #elif defined(_MSC_VER)
182 #define NORETURN __declspec(noreturn)
183 #define NORETURN_PTR
184 #else
185 #define NORETURN
186 #define NORETURN_PTR
187 #ifndef __attribute__
188 #define __attribute__(x)
189 #endif
190 #endif
192 #include "compat/bswap.h"
194 /* General helper functions */
195 extern NORETURN void usage(const char *err);
196 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
197 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
198 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
199 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
200 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
202 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
204 extern int prefixcmp(const char *str, const char *prefix);
205 extern int suffixcmp(const char *str, const char *suffix);
207 static inline const char *skip_prefix(const char *str, const char *prefix)
209 size_t len = strlen(prefix);
210 return strncmp(str, prefix, len) ? NULL : str + len;
213 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
215 #ifndef PROT_READ
216 #define PROT_READ 1
217 #define PROT_WRITE 2
218 #define MAP_PRIVATE 1
219 #define MAP_FAILED ((void*)-1)
220 #endif
222 #define mmap git_mmap
223 #define munmap git_munmap
224 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
225 extern int git_munmap(void *start, size_t length);
227 #else /* NO_MMAP || USE_WIN32_MMAP */
229 #include <sys/mman.h>
231 #endif /* NO_MMAP || USE_WIN32_MMAP */
233 #ifdef NO_MMAP
235 /* This value must be multiple of (pagesize * 2) */
236 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
238 #else /* NO_MMAP */
240 /* This value must be multiple of (pagesize * 2) */
241 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
242 (sizeof(void*) >= 8 \
243 ? 1 * 1024 * 1024 * 1024 \
244 : 32 * 1024 * 1024)
246 #endif /* NO_MMAP */
248 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
249 #define on_disk_bytes(st) ((st).st_size)
250 #else
251 #define on_disk_bytes(st) ((st).st_blocks * 512)
252 #endif
254 #define DEFAULT_PACKED_GIT_LIMIT \
255 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
257 #ifdef NO_PREAD
258 #define pread git_pread
259 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
260 #endif
262 * Forward decl that will remind us if its twin in cache.h changes.
263 * This function is used in compat/pread.c. But we can't include
264 * cache.h there.
266 extern ssize_t read_in_full(int fd, void *buf, size_t count);
268 #ifdef NO_SETENV
269 #define setenv gitsetenv
270 extern int gitsetenv(const char *, const char *, int);
271 #endif
273 #ifdef NO_MKDTEMP
274 #define mkdtemp gitmkdtemp
275 extern char *gitmkdtemp(char *);
276 #endif
278 #ifdef NO_MKSTEMPS
279 #define mkstemps gitmkstemps
280 extern int gitmkstemps(char *, int);
281 #endif
283 #ifdef NO_UNSETENV
284 #define unsetenv gitunsetenv
285 extern void gitunsetenv(const char *);
286 #endif
288 #ifdef NO_STRCASESTR
289 #define strcasestr gitstrcasestr
290 extern char *gitstrcasestr(const char *haystack, const char *needle);
291 #endif
293 #ifdef NO_STRLCPY
294 #define strlcpy gitstrlcpy
295 extern size_t gitstrlcpy(char *, const char *, size_t);
296 #endif
298 #ifdef NO_STRTOUMAX
299 #define strtoumax gitstrtoumax
300 extern uintmax_t gitstrtoumax(const char *, char **, int);
301 #endif
303 #ifdef NO_HSTRERROR
304 #define hstrerror githstrerror
305 extern const char *githstrerror(int herror);
306 #endif
308 #ifdef NO_MEMMEM
309 #define memmem gitmemmem
310 void *gitmemmem(const void *haystack, size_t haystacklen,
311 const void *needle, size_t needlelen);
312 #endif
314 #ifdef FREAD_READS_DIRECTORIES
315 #ifdef fopen
316 #undef fopen
317 #endif
318 #define fopen(a,b) git_fopen(a,b)
319 extern FILE *git_fopen(const char*, const char*);
320 #endif
322 #ifdef SNPRINTF_RETURNS_BOGUS
323 #define snprintf git_snprintf
324 extern int git_snprintf(char *str, size_t maxsize,
325 const char *format, ...);
326 #define vsnprintf git_vsnprintf
327 extern int git_vsnprintf(char *str, size_t maxsize,
328 const char *format, va_list ap);
329 #endif
331 #ifdef __GLIBC_PREREQ
332 #if __GLIBC_PREREQ(2, 1)
333 #define HAVE_STRCHRNUL
334 #endif
335 #endif
337 #ifndef HAVE_STRCHRNUL
338 #define strchrnul gitstrchrnul
339 static inline char *gitstrchrnul(const char *s, int c)
341 while (*s && *s != c)
342 s++;
343 return (char *)s;
345 #endif
347 extern void release_pack_memory(size_t, int);
349 extern char *xstrdup(const char *str);
350 extern void *xmalloc(size_t size);
351 extern void *xmallocz(size_t size);
352 extern void *xmemdupz(const void *data, size_t len);
353 extern char *xstrndup(const char *str, size_t len);
354 extern void *xrealloc(void *ptr, size_t size);
355 extern void *xcalloc(size_t nmemb, size_t size);
356 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
357 extern ssize_t xread(int fd, void *buf, size_t len);
358 extern ssize_t xwrite(int fd, const void *buf, size_t len);
359 extern int xdup(int fd);
360 extern FILE *xfdopen(int fd, const char *mode);
361 extern int xmkstemp(char *template);
362 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
363 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
365 static inline size_t xsize_t(off_t len)
367 return (size_t)len;
370 static inline int has_extension(const char *filename, const char *ext)
372 size_t len = strlen(filename);
373 size_t extlen = strlen(ext);
374 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
377 /* Sane ctype - no locale, and works with signed chars */
378 #undef isascii
379 #undef isspace
380 #undef isdigit
381 #undef isalpha
382 #undef isalnum
383 #undef tolower
384 #undef toupper
385 extern unsigned char sane_ctype[256];
386 #define GIT_SPACE 0x01
387 #define GIT_DIGIT 0x02
388 #define GIT_ALPHA 0x04
389 #define GIT_GLOB_SPECIAL 0x08
390 #define GIT_REGEX_SPECIAL 0x10
391 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
392 #define isascii(x) (((x) & ~0x7f) == 0)
393 #define isspace(x) sane_istest(x,GIT_SPACE)
394 #define isdigit(x) sane_istest(x,GIT_DIGIT)
395 #define isalpha(x) sane_istest(x,GIT_ALPHA)
396 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
397 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
398 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
399 #define tolower(x) sane_case((unsigned char)(x), 0x20)
400 #define toupper(x) sane_case((unsigned char)(x), 0)
402 static inline int sane_case(int x, int high)
404 if (sane_istest(x, GIT_ALPHA))
405 x = (x & ~0x20) | high;
406 return x;
409 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
411 unsigned long ul;
412 char *p;
414 errno = 0;
415 ul = strtoul(s, &p, base);
416 if (errno || *p || p == s || (unsigned int) ul != ul)
417 return -1;
418 *result = ul;
419 return 0;
422 static inline int strtol_i(char const *s, int base, int *result)
424 long ul;
425 char *p;
427 errno = 0;
428 ul = strtol(s, &p, base);
429 if (errno || *p || p == s || (int) ul != ul)
430 return -1;
431 *result = ul;
432 return 0;
435 #ifdef INTERNAL_QSORT
436 void git_qsort(void *base, size_t nmemb, size_t size,
437 int(*compar)(const void *, const void *));
438 #define qsort git_qsort
439 #endif
441 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
442 # define FORCE_DIR_SET_GID S_ISGID
443 #else
444 # define FORCE_DIR_SET_GID 0
445 #endif
447 #ifdef NO_NSEC
448 #undef USE_NSEC
449 #define ST_CTIME_NSEC(st) 0
450 #define ST_MTIME_NSEC(st) 0
451 #else
452 #ifdef USE_ST_TIMESPEC
453 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
454 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
455 #else
456 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
457 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
458 #endif
459 #endif
461 #ifdef UNRELIABLE_FSTAT
462 #define fstat_is_reliable() 0
463 #else
464 #define fstat_is_reliable() 1
465 #endif
468 * Preserves errno, prints a message, but gives no warning for ENOENT.
469 * Always returns the return value of unlink(2).
471 int unlink_or_warn(const char *path);
473 #endif