Sync with 1.6.3.4
[git/git.git] / git-compat-util.h
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
3
4 #define _FILE_OFFSET_BITS 64
5
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
19
20 /*
21 * Otherwise, default to safer but a bit wasteful traditional style
22 */
23 #ifndef FLEX_ARRAY
24 # define FLEX_ARRAY 1
25 #endif
26 #endif
27
28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
30
31 #ifdef __GNUC__
32 #define TYPEOF(x) (__typeof__(x))
33 #else
34 #define TYPEOF(x)
35 #endif
36
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 */
39
40 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
41
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)
44
45 #if defined(__sun__)
46 /*
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.
52 */
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 #ifndef __sun__
61 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
62 #endif
63 #endif
64 #define _ALL_SOURCE 1
65 #define _GNU_SOURCE 1
66 #define _BSD_SOURCE 1
67 #define _NETBSD_SOURCE 1
68 #define _SGI_SOURCE 1
69
70 #include <unistd.h>
71 #include <stdio.h>
72 #include <sys/stat.h>
73 #include <fcntl.h>
74 #include <stddef.h>
75 #include <stdlib.h>
76 #include <stdarg.h>
77 #include <string.h>
78 #include <errno.h>
79 #include <limits.h>
80 #include <sys/param.h>
81 #include <sys/types.h>
82 #include <dirent.h>
83 #include <sys/time.h>
84 #include <time.h>
85 #include <signal.h>
86 #include <fnmatch.h>
87 #include <assert.h>
88 #include <regex.h>
89 #include <utime.h>
90 #ifndef __MINGW32__
91 #include <sys/wait.h>
92 #include <sys/poll.h>
93 #include <sys/socket.h>
94 #include <sys/ioctl.h>
95 #ifndef NO_SYS_SELECT_H
96 #include <sys/select.h>
97 #endif
98 #include <netinet/in.h>
99 #include <netinet/tcp.h>
100 #include <arpa/inet.h>
101 #include <netdb.h>
102 #include <pwd.h>
103 #include <inttypes.h>
104 #if defined(__CYGWIN__)
105 #undef _XOPEN_SOURCE
106 #include <grp.h>
107 #define _XOPEN_SOURCE 600
108 #include "compat/cygwin.h"
109 #else
110 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
111 #include <grp.h>
112 #define _ALL_SOURCE 1
113 #endif
114 #else /* __MINGW32__ */
115 /* pull in Windows compatibility stuff */
116 #include "compat/mingw.h"
117 #endif /* __MINGW32__ */
118
119 #ifndef NO_LIBGEN_H
120 #include <libgen.h>
121 #else
122 #define basename gitbasename
123 extern char *gitbasename(char *);
124 #endif
125
126 #ifndef NO_ICONV
127 #include <iconv.h>
128 #endif
129
130 #ifndef NO_OPENSSL
131 #include <openssl/ssl.h>
132 #include <openssl/err.h>
133 #endif
134
135 /* On most systems <limits.h> would have given us this, but
136 * not on some systems (e.g. GNU/Hurd).
137 */
138 #ifndef PATH_MAX
139 #define PATH_MAX 4096
140 #endif
141
142 #ifndef PRIuMAX
143 #define PRIuMAX "llu"
144 #endif
145
146 #ifndef PRIu32
147 #define PRIu32 "u"
148 #endif
149
150 #ifndef PRIx32
151 #define PRIx32 "x"
152 #endif
153
154 #ifndef PATH_SEP
155 #define PATH_SEP ':'
156 #endif
157
158 #ifndef STRIP_EXTENSION
159 #define STRIP_EXTENSION ""
160 #endif
161
162 #ifndef has_dos_drive_prefix
163 #define has_dos_drive_prefix(path) 0
164 #endif
165
166 #ifndef is_dir_sep
167 #define is_dir_sep(c) ((c) == '/')
168 #endif
169
170 #ifdef __GNUC__
171 #define NORETURN __attribute__((__noreturn__))
172 #else
173 #define NORETURN
174 #ifndef __attribute__
175 #define __attribute__(x)
176 #endif
177 #endif
178
179 /* General helper functions */
180 extern void usage(const char *err) NORETURN;
181 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
182 extern void die_errno(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
183 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
184 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
185
186 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
187
188 extern int prefixcmp(const char *str, const char *prefix);
189 extern time_t tm_to_time_t(const struct tm *tm);
190
191 static inline const char *skip_prefix(const char *str, const char *prefix)
192 {
193 size_t len = strlen(prefix);
194 return strncmp(str, prefix, len) ? NULL : str + len;
195 }
196
197 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
198
199 #ifndef PROT_READ
200 #define PROT_READ 1
201 #define PROT_WRITE 2
202 #define MAP_PRIVATE 1
203 #define MAP_FAILED ((void*)-1)
204 #endif
205
206 #define mmap git_mmap
207 #define munmap git_munmap
208 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
209 extern int git_munmap(void *start, size_t length);
210
211 #else /* NO_MMAP || USE_WIN32_MMAP */
212
213 #include <sys/mman.h>
214
215 #endif /* NO_MMAP || USE_WIN32_MMAP */
216
217 #ifdef NO_MMAP
218
219 /* This value must be multiple of (pagesize * 2) */
220 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
221
222 #else /* NO_MMAP */
223
224 /* This value must be multiple of (pagesize * 2) */
225 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
226 (sizeof(void*) >= 8 \
227 ? 1 * 1024 * 1024 * 1024 \
228 : 32 * 1024 * 1024)
229
230 #endif /* NO_MMAP */
231
232 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
233 #define on_disk_bytes(st) ((st).st_size)
234 #else
235 #define on_disk_bytes(st) ((st).st_blocks * 512)
236 #endif
237
238 #define DEFAULT_PACKED_GIT_LIMIT \
239 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
240
241 #ifdef NO_PREAD
242 #define pread git_pread
243 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
244 #endif
245 /*
246 * Forward decl that will remind us if its twin in cache.h changes.
247 * This function is used in compat/pread.c. But we can't include
248 * cache.h there.
249 */
250 extern ssize_t read_in_full(int fd, void *buf, size_t count);
251
252 #ifdef NO_SETENV
253 #define setenv gitsetenv
254 extern int gitsetenv(const char *, const char *, int);
255 #endif
256
257 #ifdef NO_MKDTEMP
258 #define mkdtemp gitmkdtemp
259 extern char *gitmkdtemp(char *);
260 #endif
261
262 #ifdef NO_MKSTEMPS
263 #define mkstemps gitmkstemps
264 extern int gitmkstemps(char *, int);
265 #endif
266
267 #ifdef NO_UNSETENV
268 #define unsetenv gitunsetenv
269 extern void gitunsetenv(const char *);
270 #endif
271
272 #ifdef NO_STRCASESTR
273 #define strcasestr gitstrcasestr
274 extern char *gitstrcasestr(const char *haystack, const char *needle);
275 #endif
276
277 #ifdef NO_STRLCPY
278 #define strlcpy gitstrlcpy
279 extern size_t gitstrlcpy(char *, const char *, size_t);
280 #endif
281
282 #ifdef NO_STRTOUMAX
283 #define strtoumax gitstrtoumax
284 extern uintmax_t gitstrtoumax(const char *, char **, int);
285 #endif
286
287 #ifdef NO_HSTRERROR
288 #define hstrerror githstrerror
289 extern const char *githstrerror(int herror);
290 #endif
291
292 #ifdef NO_MEMMEM
293 #define memmem gitmemmem
294 void *gitmemmem(const void *haystack, size_t haystacklen,
295 const void *needle, size_t needlelen);
296 #endif
297
298 #ifdef FREAD_READS_DIRECTORIES
299 #ifdef fopen
300 #undef fopen
301 #endif
302 #define fopen(a,b) git_fopen(a,b)
303 extern FILE *git_fopen(const char*, const char*);
304 #endif
305
306 #ifdef SNPRINTF_RETURNS_BOGUS
307 #define snprintf git_snprintf
308 extern int git_snprintf(char *str, size_t maxsize,
309 const char *format, ...);
310 #define vsnprintf git_vsnprintf
311 extern int git_vsnprintf(char *str, size_t maxsize,
312 const char *format, va_list ap);
313 #endif
314
315 #ifdef __GLIBC_PREREQ
316 #if __GLIBC_PREREQ(2, 1)
317 #define HAVE_STRCHRNUL
318 #endif
319 #endif
320
321 #ifndef HAVE_STRCHRNUL
322 #define strchrnul gitstrchrnul
323 static inline char *gitstrchrnul(const char *s, int c)
324 {
325 while (*s && *s != c)
326 s++;
327 return (char *)s;
328 }
329 #endif
330
331 extern void release_pack_memory(size_t, int);
332
333 extern char *xstrdup(const char *str);
334 extern void *xmalloc(size_t size);
335 extern void *xmemdupz(const void *data, size_t len);
336 extern char *xstrndup(const char *str, size_t len);
337 extern void *xrealloc(void *ptr, size_t size);
338 extern void *xcalloc(size_t nmemb, size_t size);
339 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
340 extern ssize_t xread(int fd, void *buf, size_t len);
341 extern ssize_t xwrite(int fd, const void *buf, size_t len);
342 extern int xdup(int fd);
343 extern FILE *xfdopen(int fd, const char *mode);
344 extern int xmkstemp(char *template);
345 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
346 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
347
348 static inline size_t xsize_t(off_t len)
349 {
350 return (size_t)len;
351 }
352
353 static inline int has_extension(const char *filename, const char *ext)
354 {
355 size_t len = strlen(filename);
356 size_t extlen = strlen(ext);
357 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
358 }
359
360 /* Sane ctype - no locale, and works with signed chars */
361 #undef isascii
362 #undef isspace
363 #undef isdigit
364 #undef isalpha
365 #undef isalnum
366 #undef tolower
367 #undef toupper
368 extern unsigned char sane_ctype[256];
369 #define GIT_SPACE 0x01
370 #define GIT_DIGIT 0x02
371 #define GIT_ALPHA 0x04
372 #define GIT_GLOB_SPECIAL 0x08
373 #define GIT_REGEX_SPECIAL 0x10
374 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
375 #define isascii(x) (((x) & ~0x7f) == 0)
376 #define isspace(x) sane_istest(x,GIT_SPACE)
377 #define isdigit(x) sane_istest(x,GIT_DIGIT)
378 #define isalpha(x) sane_istest(x,GIT_ALPHA)
379 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
380 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
381 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
382 #define tolower(x) sane_case((unsigned char)(x), 0x20)
383 #define toupper(x) sane_case((unsigned char)(x), 0)
384
385 static inline int sane_case(int x, int high)
386 {
387 if (sane_istest(x, GIT_ALPHA))
388 x = (x & ~0x20) | high;
389 return x;
390 }
391
392 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
393 {
394 unsigned long ul;
395 char *p;
396
397 errno = 0;
398 ul = strtoul(s, &p, base);
399 if (errno || *p || p == s || (unsigned int) ul != ul)
400 return -1;
401 *result = ul;
402 return 0;
403 }
404
405 static inline int strtol_i(char const *s, int base, int *result)
406 {
407 long ul;
408 char *p;
409
410 errno = 0;
411 ul = strtol(s, &p, base);
412 if (errno || *p || p == s || (int) ul != ul)
413 return -1;
414 *result = ul;
415 return 0;
416 }
417
418 #ifdef INTERNAL_QSORT
419 void git_qsort(void *base, size_t nmemb, size_t size,
420 int(*compar)(const void *, const void *));
421 #define qsort git_qsort
422 #endif
423
424 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
425 # define FORCE_DIR_SET_GID S_ISGID
426 #else
427 # define FORCE_DIR_SET_GID 0
428 #endif
429
430 #ifdef NO_NSEC
431 #undef USE_NSEC
432 #define ST_CTIME_NSEC(st) 0
433 #define ST_MTIME_NSEC(st) 0
434 #else
435 #ifdef USE_ST_TIMESPEC
436 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
437 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
438 #else
439 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
440 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
441 #endif
442 #endif
443
444 #ifdef UNRELIABLE_FSTAT
445 #define fstat_is_reliable() 0
446 #else
447 #define fstat_is_reliable() 1
448 #endif
449
450 /*
451 * Preserves errno, prints a message, but gives no warning for ENOENT.
452 * Always returns the return value of unlink(2).
453 */
454 int unlink_or_warn(const char *path);
455
456 #endif