Git 1.7.8.6
[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 #define maximum_signed_value_of_type(a) \
32     (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
33
34 #define maximum_unsigned_value_of_type(a) \
35     (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
36
37 /*
38  * Signed integer overflow is undefined in C, so here's a helper macro
39  * to detect if the sum of two integers will overflow.
40  *
41  * Requires: a >= 0, typeof(a) equals typeof(b)
42  */
43 #define signed_add_overflows(a, b) \
44     ((b) > maximum_signed_value_of_type(a) - (a))
45
46 #define unsigned_add_overflows(a, b) \
47     ((b) > maximum_unsigned_value_of_type(a) - (a))
48
49 #ifdef __GNUC__
50 #define TYPEOF(x) (__typeof__(x))
51 #else
52 #define TYPEOF(x)
53 #endif
54
55 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
56 #define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
57
58 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
59
60 /* Approximation of the length of the decimal representation of this type. */
61 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
62
63 #if defined(__sun__)
64  /*
65   * On Solaris, when _XOPEN_EXTENDED is set, its header file
66   * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
67   * setting to say we are XPG5 or XPG6.  Also on Solaris,
68   * XPG6 programs must be compiled with a c99 compiler, while
69   * non XPG6 programs must be compiled with a pre-c99 compiler.
70   */
71 # if __STDC_VERSION__ - 0 >= 199901L
72 # define _XOPEN_SOURCE 600
73 # else
74 # define _XOPEN_SOURCE 500
75 # endif
76 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
77       !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
78 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
79 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
80 #endif
81 #define _ALL_SOURCE 1
82 #define _GNU_SOURCE 1
83 #define _BSD_SOURCE 1
84 #define _NETBSD_SOURCE 1
85 #define _SGI_SOURCE 1
86
87 #ifdef WIN32 /* Both MinGW and MSVC */
88 #define WIN32_LEAN_AND_MEAN  /* stops windows.h including winsock.h */
89 #include <winsock2.h>
90 #include <windows.h>
91 #endif
92
93 #include <unistd.h>
94 #include <stdio.h>
95 #include <sys/stat.h>
96 #include <fcntl.h>
97 #include <stddef.h>
98 #include <stdlib.h>
99 #include <stdarg.h>
100 #include <string.h>
101 #include <errno.h>
102 #include <limits.h>
103 #include <sys/param.h>
104 #include <sys/types.h>
105 #include <dirent.h>
106 #include <sys/time.h>
107 #include <time.h>
108 #include <signal.h>
109 #include <fnmatch.h>
110 #include <assert.h>
111 #include <regex.h>
112 #include <utime.h>
113 #include <syslog.h>
114 #ifndef NO_SYS_POLL_H
115 #include <sys/poll.h>
116 #else
117 #include <poll.h>
118 #endif
119 #ifndef __MINGW32__
120 #include <sys/wait.h>
121 #include <sys/resource.h>
122 #include <sys/socket.h>
123 #include <sys/ioctl.h>
124 #include <termios.h>
125 #ifndef NO_SYS_SELECT_H
126 #include <sys/select.h>
127 #endif
128 #include <netinet/in.h>
129 #include <netinet/tcp.h>
130 #include <arpa/inet.h>
131 #include <netdb.h>
132 #include <pwd.h>
133 #ifndef NO_INTTYPES_H
134 #include <inttypes.h>
135 #else
136 #include <stdint.h>
137 #endif
138 #if defined(__CYGWIN__)
139 #undef _XOPEN_SOURCE
140 #include <grp.h>
141 #define _XOPEN_SOURCE 600
142 #include "compat/cygwin.h"
143 #else
144 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
145 #include <grp.h>
146 #define _ALL_SOURCE 1
147 #endif
148 #else   /* __MINGW32__ */
149 /* pull in Windows compatibility stuff */
150 #include "compat/mingw.h"
151 #endif  /* __MINGW32__ */
152 #ifdef _MSC_VER
153 #include "compat/msvc.h"
154 #endif
155
156 #ifndef NO_LIBGEN_H
157 #include <libgen.h>
158 #else
159 #define basename gitbasename
160 extern char *gitbasename(char *);
161 #endif
162
163 #ifndef NO_ICONV
164 #include <iconv.h>
165 #endif
166
167 #ifndef NO_OPENSSL
168 #include <openssl/ssl.h>
169 #include <openssl/err.h>
170 #endif
171
172 /* On most systems <limits.h> would have given us this, but
173  * not on some systems (e.g. GNU/Hurd).
174  */
175 #ifndef PATH_MAX
176 #define PATH_MAX 4096
177 #endif
178
179 #ifndef PRIuMAX
180 #define PRIuMAX "llu"
181 #endif
182
183 #ifndef PRIu32
184 #define PRIu32 "u"
185 #endif
186
187 #ifndef PRIx32
188 #define PRIx32 "x"
189 #endif
190
191 #ifndef PRIo32
192 #define PRIo32 "o"
193 #endif
194
195 #ifndef PATH_SEP
196 #define PATH_SEP ':'
197 #endif
198
199 #ifdef HAVE_PATHS_H
200 #include <paths.h>
201 #endif
202 #ifndef _PATH_DEFPATH
203 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
204 #endif
205
206 #ifndef STRIP_EXTENSION
207 #define STRIP_EXTENSION ""
208 #endif
209
210 #ifndef has_dos_drive_prefix
211 #define has_dos_drive_prefix(path) 0
212 #endif
213
214 #ifndef is_dir_sep
215 #define is_dir_sep(c) ((c) == '/')
216 #endif
217
218 #ifndef find_last_dir_sep
219 #define find_last_dir_sep(path) strrchr(path, '/')
220 #endif
221
222 #if defined(__HP_cc) && (__HP_cc >= 61000)
223 #define NORETURN __attribute__((noreturn))
224 #define NORETURN_PTR
225 #elif defined(__GNUC__) && !defined(NO_NORETURN)
226 #define NORETURN __attribute__((__noreturn__))
227 #define NORETURN_PTR __attribute__((__noreturn__))
228 #elif defined(_MSC_VER)
229 #define NORETURN __declspec(noreturn)
230 #define NORETURN_PTR
231 #else
232 #define NORETURN
233 #define NORETURN_PTR
234 #ifndef __attribute__
235 #define __attribute__(x)
236 #endif
237 #endif
238
239 #include "compat/bswap.h"
240
241 /* General helper functions */
242 extern void vreportf(const char *prefix, const char *err, va_list params);
243 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
244 extern NORETURN void usage(const char *err);
245 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
246 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
247 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
248 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
249 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
250
251 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
252 extern void set_error_routine(void (*routine)(const char *err, va_list params));
253
254 extern int prefixcmp(const char *str, const char *prefix);
255 extern int suffixcmp(const char *str, const char *suffix);
256
257 static inline const char *skip_prefix(const char *str, const char *prefix)
258 {
259         size_t len = strlen(prefix);
260         return strncmp(str, prefix, len) ? NULL : str + len;
261 }
262
263 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
264
265 #ifndef PROT_READ
266 #define PROT_READ 1
267 #define PROT_WRITE 2
268 #define MAP_PRIVATE 1
269 #endif
270
271 #define mmap git_mmap
272 #define munmap git_munmap
273 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
274 extern int git_munmap(void *start, size_t length);
275
276 #else /* NO_MMAP || USE_WIN32_MMAP */
277
278 #include <sys/mman.h>
279
280 #endif /* NO_MMAP || USE_WIN32_MMAP */
281
282 #ifdef NO_MMAP
283
284 /* This value must be multiple of (pagesize * 2) */
285 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
286
287 #else /* NO_MMAP */
288
289 /* This value must be multiple of (pagesize * 2) */
290 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
291         (sizeof(void*) >= 8 \
292                 ?  1 * 1024 * 1024 * 1024 \
293                 : 32 * 1024 * 1024)
294
295 #endif /* NO_MMAP */
296
297 #ifndef MAP_FAILED
298 #define MAP_FAILED ((void *)-1)
299 #endif
300
301 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
302 #define on_disk_bytes(st) ((st).st_size)
303 #else
304 #define on_disk_bytes(st) ((st).st_blocks * 512)
305 #endif
306
307 #define DEFAULT_PACKED_GIT_LIMIT \
308         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
309
310 #ifdef NO_PREAD
311 #define pread git_pread
312 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
313 #endif
314 /*
315  * Forward decl that will remind us if its twin in cache.h changes.
316  * This function is used in compat/pread.c.  But we can't include
317  * cache.h there.
318  */
319 extern ssize_t read_in_full(int fd, void *buf, size_t count);
320
321 #ifdef NO_SETENV
322 #define setenv gitsetenv
323 extern int gitsetenv(const char *, const char *, int);
324 #endif
325
326 #ifdef NO_MKDTEMP
327 #define mkdtemp gitmkdtemp
328 extern char *gitmkdtemp(char *);
329 #endif
330
331 #ifdef NO_MKSTEMPS
332 #define mkstemps gitmkstemps
333 extern int gitmkstemps(char *, int);
334 #endif
335
336 #ifdef NO_UNSETENV
337 #define unsetenv gitunsetenv
338 extern void gitunsetenv(const char *);
339 #endif
340
341 #ifdef NO_STRCASESTR
342 #define strcasestr gitstrcasestr
343 extern char *gitstrcasestr(const char *haystack, const char *needle);
344 #endif
345
346 #ifdef NO_STRLCPY
347 #define strlcpy gitstrlcpy
348 extern size_t gitstrlcpy(char *, const char *, size_t);
349 #endif
350
351 #ifdef NO_STRTOUMAX
352 #define strtoumax gitstrtoumax
353 extern uintmax_t gitstrtoumax(const char *, char **, int);
354 #define strtoimax gitstrtoimax
355 extern intmax_t gitstrtoimax(const char *, char **, int);
356 #endif
357
358 #ifdef NO_STRTOK_R
359 #define strtok_r gitstrtok_r
360 extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
361 #endif
362
363 #ifdef NO_HSTRERROR
364 #define hstrerror githstrerror
365 extern const char *githstrerror(int herror);
366 #endif
367
368 #ifdef NO_MEMMEM
369 #define memmem gitmemmem
370 void *gitmemmem(const void *haystack, size_t haystacklen,
371                 const void *needle, size_t needlelen);
372 #endif
373
374 #ifdef FREAD_READS_DIRECTORIES
375 #ifdef fopen
376 #undef fopen
377 #endif
378 #define fopen(a,b) git_fopen(a,b)
379 extern FILE *git_fopen(const char*, const char*);
380 #endif
381
382 #ifdef SNPRINTF_RETURNS_BOGUS
383 #define snprintf git_snprintf
384 extern int git_snprintf(char *str, size_t maxsize,
385                         const char *format, ...);
386 #define vsnprintf git_vsnprintf
387 extern int git_vsnprintf(char *str, size_t maxsize,
388                          const char *format, va_list ap);
389 #endif
390
391 #ifdef __GLIBC_PREREQ
392 #if __GLIBC_PREREQ(2, 1)
393 #define HAVE_STRCHRNUL
394 #define HAVE_MEMPCPY
395 #endif
396 #endif
397
398 #ifndef HAVE_STRCHRNUL
399 #define strchrnul gitstrchrnul
400 static inline char *gitstrchrnul(const char *s, int c)
401 {
402         while (*s && *s != c)
403                 s++;
404         return (char *)s;
405 }
406 #endif
407
408 #ifndef HAVE_MEMPCPY
409 #define mempcpy gitmempcpy
410 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
411 {
412         return (char *)memcpy(dest, src, n) + n;
413 }
414 #endif
415
416 #ifdef NO_INET_PTON
417 int inet_pton(int af, const char *src, void *dst);
418 #endif
419
420 #ifdef NO_INET_NTOP
421 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
422 #endif
423
424 extern void release_pack_memory(size_t, int);
425
426 typedef void (*try_to_free_t)(size_t);
427 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
428
429 extern char *xstrdup(const char *str);
430 extern void *xmalloc(size_t size);
431 extern void *xmallocz(size_t size);
432 extern void *xmemdupz(const void *data, size_t len);
433 extern char *xstrndup(const char *str, size_t len);
434 extern void *xrealloc(void *ptr, size_t size);
435 extern void *xcalloc(size_t nmemb, size_t size);
436 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
437 extern ssize_t xread(int fd, void *buf, size_t len);
438 extern ssize_t xwrite(int fd, const void *buf, size_t len);
439 extern int xdup(int fd);
440 extern FILE *xfdopen(int fd, const char *mode);
441 extern int xmkstemp(char *template);
442 extern int xmkstemp_mode(char *template, int mode);
443 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
444 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
445
446 static inline size_t xsize_t(off_t len)
447 {
448         if (len > (size_t) len)
449                 die("Cannot handle files this big");
450         return (size_t)len;
451 }
452
453 static inline int has_extension(const char *filename, const char *ext)
454 {
455         size_t len = strlen(filename);
456         size_t extlen = strlen(ext);
457         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
458 }
459
460 /* Sane ctype - no locale, and works with signed chars */
461 #undef isascii
462 #undef isspace
463 #undef isdigit
464 #undef isalpha
465 #undef isalnum
466 #undef tolower
467 #undef toupper
468 extern unsigned char sane_ctype[256];
469 #define GIT_SPACE 0x01
470 #define GIT_DIGIT 0x02
471 #define GIT_ALPHA 0x04
472 #define GIT_GLOB_SPECIAL 0x08
473 #define GIT_REGEX_SPECIAL 0x10
474 #define GIT_PATHSPEC_MAGIC 0x20
475 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
476 #define isascii(x) (((x) & ~0x7f) == 0)
477 #define isspace(x) sane_istest(x,GIT_SPACE)
478 #define isdigit(x) sane_istest(x,GIT_DIGIT)
479 #define isalpha(x) sane_istest(x,GIT_ALPHA)
480 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
481 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
482 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
483 #define tolower(x) sane_case((unsigned char)(x), 0x20)
484 #define toupper(x) sane_case((unsigned char)(x), 0)
485 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
486
487 static inline int sane_case(int x, int high)
488 {
489         if (sane_istest(x, GIT_ALPHA))
490                 x = (x & ~0x20) | high;
491         return x;
492 }
493
494 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
495 {
496         unsigned long ul;
497         char *p;
498
499         errno = 0;
500         ul = strtoul(s, &p, base);
501         if (errno || *p || p == s || (unsigned int) ul != ul)
502                 return -1;
503         *result = ul;
504         return 0;
505 }
506
507 static inline int strtol_i(char const *s, int base, int *result)
508 {
509         long ul;
510         char *p;
511
512         errno = 0;
513         ul = strtol(s, &p, base);
514         if (errno || *p || p == s || (int) ul != ul)
515                 return -1;
516         *result = ul;
517         return 0;
518 }
519
520 #ifdef INTERNAL_QSORT
521 void git_qsort(void *base, size_t nmemb, size_t size,
522                int(*compar)(const void *, const void *));
523 #define qsort git_qsort
524 #endif
525
526 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
527 # define FORCE_DIR_SET_GID S_ISGID
528 #else
529 # define FORCE_DIR_SET_GID 0
530 #endif
531
532 #ifdef NO_NSEC
533 #undef USE_NSEC
534 #define ST_CTIME_NSEC(st) 0
535 #define ST_MTIME_NSEC(st) 0
536 #else
537 #ifdef USE_ST_TIMESPEC
538 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
539 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
540 #else
541 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
542 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
543 #endif
544 #endif
545
546 #ifdef UNRELIABLE_FSTAT
547 #define fstat_is_reliable() 0
548 #else
549 #define fstat_is_reliable() 1
550 #endif
551
552 #ifndef va_copy
553 /*
554  * Since an obvious implementation of va_list would be to make it a
555  * pointer into the stack frame, a simple assignment will work on
556  * many systems.  But let's try to be more portable.
557  */
558 #ifdef __va_copy
559 #define va_copy(dst, src) __va_copy(dst, src)
560 #else
561 #define va_copy(dst, src) ((dst) = (src))
562 #endif
563 #endif
564
565 /*
566  * Preserves errno, prints a message, but gives no warning for ENOENT.
567  * Always returns the return value of unlink(2).
568  */
569 int unlink_or_warn(const char *path);
570 /*
571  * Likewise for rmdir(2).
572  */
573 int rmdir_or_warn(const char *path);
574 /*
575  * Calls the correct function out of {unlink,rmdir}_or_warn based on
576  * the supplied file mode.
577  */
578 int remove_or_warn(unsigned int mode, const char *path);
579
580 #endif