submodule: Use cat instead of echo to avoid DOS line-endings
[git/dscho.git] / git-compat-util.h
blob92af8ab3ebd1decc2040dc2ddc7d32f21b9ecebd
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 #define maximum_signed_value_of_type(a) \
32 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
34 #define maximum_unsigned_value_of_type(a) \
35 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
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.
41 * Requires: a >= 0, typeof(a) equals typeof(b)
43 #define signed_add_overflows(a, b) \
44 ((b) > maximum_signed_value_of_type(a) - (a))
46 #define unsigned_add_overflows(a, b) \
47 ((b) > maximum_unsigned_value_of_type(a) - (a))
49 #ifdef __GNUC__
50 #define TYPEOF(x) (__typeof__(x))
51 #else
52 #define TYPEOF(x)
53 #endif
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 */
58 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
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)
63 #if defined(__sun__)
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.
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 !defined(__TANDEM)
79 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
80 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
81 #endif
82 #define _ALL_SOURCE 1
83 #define _GNU_SOURCE 1
84 #define _BSD_SOURCE 1
85 #define _NETBSD_SOURCE 1
86 #define _SGI_SOURCE 1
88 #ifdef WIN32 /* Both MinGW and MSVC */
89 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
90 #include <winsock2.h>
91 #include <windows.h>
92 #endif
94 #include <unistd.h>
95 #include <stdio.h>
96 #include <sys/stat.h>
97 #include <fcntl.h>
98 #include <stddef.h>
99 #include <stdlib.h>
100 #include <stdarg.h>
101 #include <string.h>
102 #ifdef __TANDEM /* or HAVE_STRINGS_H or !NO_STRINGS_H? */
103 #include <strings.h> /* for strcasecmp() */
104 #endif
105 #include <errno.h>
106 #include <limits.h>
107 #include <sys/param.h>
108 #include <sys/types.h>
109 #include <dirent.h>
110 #include <sys/time.h>
111 #include <time.h>
112 #include <signal.h>
113 #include <fnmatch.h>
114 #include <assert.h>
115 #include <regex.h>
116 #include <utime.h>
117 #include <syslog.h>
118 #ifndef NO_SYS_POLL_H
119 #include <sys/poll.h>
120 #else
121 #include <poll.h>
122 #endif
123 #if defined(__MINGW32__)
124 /* pull in Windows compatibility stuff */
125 #include "compat/mingw.h"
126 #elif defined(_MSC_VER)
127 #include "compat/msvc.h"
128 #else
129 #include <sys/wait.h>
130 #include <sys/resource.h>
131 #include <sys/socket.h>
132 #include <sys/ioctl.h>
133 #include <termios.h>
134 #ifndef NO_SYS_SELECT_H
135 #include <sys/select.h>
136 #endif
137 #include <netinet/in.h>
138 #include <netinet/tcp.h>
139 #include <arpa/inet.h>
140 #include <netdb.h>
141 #include <pwd.h>
142 #include <sys/un.h>
143 #ifndef NO_INTTYPES_H
144 #include <inttypes.h>
145 #else
146 #include <stdint.h>
147 #endif
148 #ifdef NO_INTPTR_T
150 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
151 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
152 * while on IP16 and IP16L32 it is "int" (resp. "short")
153 * Size needs to match (or exceed) 'sizeof(void *)'.
154 * We can't take "long long" here as not everybody has it.
156 typedef long intptr_t;
157 typedef unsigned long uintptr_t;
158 #endif
159 #if defined(__CYGWIN__)
160 #undef _XOPEN_SOURCE
161 #include <grp.h>
162 #define _XOPEN_SOURCE 600
163 #include "compat/cygwin.h"
164 #else
165 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
166 #include <grp.h>
167 #define _ALL_SOURCE 1
168 #endif
169 #endif
171 /* used on Mac OS X */
172 #ifdef PRECOMPOSE_UNICODE
173 #include "compat/precompose_utf8.h"
174 #else
175 #define precompose_str(in,i_nfd2nfc)
176 #define precompose_argv(c,v)
177 #define probe_utf8_pathname_composition(a,b)
178 #endif
180 #ifdef MKDIR_WO_TRAILING_SLASH
181 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
182 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
183 #endif
185 #ifdef NO_STRUCT_ITIMERVAL
186 struct itimerval {
187 struct timeval it_interval;
188 struct timeval it_value;
190 #endif
192 #ifdef NO_SETITIMER
193 #define setitimer(which,value,ovalue)
194 #endif
196 #ifndef NO_LIBGEN_H
197 #include <libgen.h>
198 #else
199 #define basename gitbasename
200 extern char *gitbasename(char *);
201 #endif
203 #ifndef NO_ICONV
204 #include <iconv.h>
205 #endif
207 #ifndef NO_OPENSSL
208 #include <openssl/ssl.h>
209 #include <openssl/err.h>
210 #endif
212 /* On most systems <limits.h> would have given us this, but
213 * not on some systems (e.g. GNU/Hurd).
215 #ifndef PATH_MAX
216 #define PATH_MAX 4096
217 #endif
219 #ifndef PRIuMAX
220 #define PRIuMAX "llu"
221 #endif
223 #ifndef PRIu32
224 #define PRIu32 "u"
225 #endif
227 #ifndef PRIx32
228 #define PRIx32 "x"
229 #endif
231 #ifndef PRIo32
232 #define PRIo32 "o"
233 #endif
235 #ifndef PATH_SEP
236 #define PATH_SEP ':'
237 #endif
239 #ifdef HAVE_PATHS_H
240 #include <paths.h>
241 #endif
242 #ifndef _PATH_DEFPATH
243 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
244 #endif
246 #ifndef STRIP_EXTENSION
247 #define STRIP_EXTENSION ""
248 #endif
250 #ifndef has_dos_drive_prefix
251 #define has_dos_drive_prefix(path) 0
252 #endif
254 #ifndef offset_1st_component
255 #define offset_1st_component(path) (is_dir_sep((path)[0]))
256 #endif
258 #ifndef is_dir_sep
259 #define is_dir_sep(c) ((c) == '/')
260 #endif
262 #ifndef find_last_dir_sep
263 #define find_last_dir_sep(path) strrchr(path, '/')
264 #endif
266 #if defined(__HP_cc) && (__HP_cc >= 61000)
267 #define NORETURN __attribute__((noreturn))
268 #define NORETURN_PTR
269 #elif defined(__GNUC__) && !defined(NO_NORETURN)
270 #define NORETURN __attribute__((__noreturn__))
271 #define NORETURN_PTR __attribute__((__noreturn__))
272 #elif defined(_MSC_VER)
273 #define NORETURN __declspec(noreturn)
274 #define NORETURN_PTR
275 #else
276 #define NORETURN
277 #define NORETURN_PTR
278 #ifndef __attribute__
279 #define __attribute__(x)
280 #endif
281 #endif
283 #include "compat/bswap.h"
285 /* General helper functions */
286 extern void vreportf(const char *prefix, const char *err, va_list params);
287 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
288 extern NORETURN void usage(const char *err);
289 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
290 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
291 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
292 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
293 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
295 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
296 extern void set_error_routine(void (*routine)(const char *err, va_list params));
298 extern int prefixcmp(const char *str, const char *prefix);
299 extern int suffixcmp(const char *str, const char *suffix);
301 static inline const char *skip_prefix(const char *str, const char *prefix)
303 size_t len = strlen(prefix);
304 return strncmp(str, prefix, len) ? NULL : str + len;
307 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
309 #ifndef PROT_READ
310 #define PROT_READ 1
311 #define PROT_WRITE 2
312 #define MAP_PRIVATE 1
313 #endif
315 #define mmap git_mmap
316 #define munmap git_munmap
317 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
318 extern int git_munmap(void *start, size_t length);
320 #else /* NO_MMAP || USE_WIN32_MMAP */
322 #include <sys/mman.h>
324 #endif /* NO_MMAP || USE_WIN32_MMAP */
326 #ifdef NO_MMAP
328 /* This value must be multiple of (pagesize * 2) */
329 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
331 #else /* NO_MMAP */
333 /* This value must be multiple of (pagesize * 2) */
334 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
335 (sizeof(void*) >= 8 \
336 ? 1 * 1024 * 1024 * 1024 \
337 : 32 * 1024 * 1024)
339 #endif /* NO_MMAP */
341 #ifndef MAP_FAILED
342 #define MAP_FAILED ((void *)-1)
343 #endif
345 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
346 #define on_disk_bytes(st) ((st).st_size)
347 #else
348 #define on_disk_bytes(st) ((st).st_blocks * 512)
349 #endif
351 #define DEFAULT_PACKED_GIT_LIMIT \
352 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
354 #ifdef NO_PREAD
355 #define pread git_pread
356 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
357 #endif
359 * Forward decl that will remind us if its twin in cache.h changes.
360 * This function is used in compat/pread.c. But we can't include
361 * cache.h there.
363 extern ssize_t read_in_full(int fd, void *buf, size_t count);
365 #ifdef NO_SETENV
366 #define setenv gitsetenv
367 extern int gitsetenv(const char *, const char *, int);
368 #endif
370 #ifdef NO_MKDTEMP
371 #define mkdtemp gitmkdtemp
372 extern char *gitmkdtemp(char *);
373 #endif
375 #ifdef NO_MKSTEMPS
376 #define mkstemps gitmkstemps
377 extern int gitmkstemps(char *, int);
378 #endif
380 #ifdef NO_UNSETENV
381 #define unsetenv gitunsetenv
382 extern void gitunsetenv(const char *);
383 #endif
385 #ifdef NO_STRCASESTR
386 #define strcasestr gitstrcasestr
387 extern char *gitstrcasestr(const char *haystack, const char *needle);
388 #endif
390 #ifdef NO_STRLCPY
391 #define strlcpy gitstrlcpy
392 extern size_t gitstrlcpy(char *, const char *, size_t);
393 #endif
395 #ifdef NO_STRTOUMAX
396 #define strtoumax gitstrtoumax
397 extern uintmax_t gitstrtoumax(const char *, char **, int);
398 #define strtoimax gitstrtoimax
399 extern intmax_t gitstrtoimax(const char *, char **, int);
400 #endif
402 #ifdef NO_STRTOK_R
403 #define strtok_r gitstrtok_r
404 extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
405 #endif
407 #ifdef NO_HSTRERROR
408 #define hstrerror githstrerror
409 extern const char *githstrerror(int herror);
410 #endif
412 #ifdef NO_MEMMEM
413 #define memmem gitmemmem
414 void *gitmemmem(const void *haystack, size_t haystacklen,
415 const void *needle, size_t needlelen);
416 #endif
418 #ifdef FREAD_READS_DIRECTORIES
419 #ifdef fopen
420 #undef fopen
421 #endif
422 #define fopen(a,b) git_fopen(a,b)
423 extern FILE *git_fopen(const char*, const char*);
424 #endif
426 #ifdef SNPRINTF_RETURNS_BOGUS
427 #define snprintf git_snprintf
428 extern int git_snprintf(char *str, size_t maxsize,
429 const char *format, ...);
430 #define vsnprintf git_vsnprintf
431 extern int git_vsnprintf(char *str, size_t maxsize,
432 const char *format, va_list ap);
433 #endif
435 #ifdef __GLIBC_PREREQ
436 #if __GLIBC_PREREQ(2, 1)
437 #define HAVE_STRCHRNUL
438 #define HAVE_MEMPCPY
439 #endif
440 #endif
442 #ifndef HAVE_STRCHRNUL
443 #define strchrnul gitstrchrnul
444 static inline char *gitstrchrnul(const char *s, int c)
446 while (*s && *s != c)
447 s++;
448 return (char *)s;
450 #endif
452 #ifndef HAVE_MEMPCPY
453 #define mempcpy gitmempcpy
454 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
456 return (char *)memcpy(dest, src, n) + n;
458 #endif
460 #ifdef NO_INET_PTON
461 int inet_pton(int af, const char *src, void *dst);
462 #endif
464 #ifdef NO_INET_NTOP
465 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
466 #endif
468 extern void release_pack_memory(size_t, int);
470 typedef void (*try_to_free_t)(size_t);
471 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
473 extern char *xstrdup(const char *str);
474 extern void *xmalloc(size_t size);
475 extern void *xmallocz(size_t size);
476 extern void *xmemdupz(const void *data, size_t len);
477 extern char *xstrndup(const char *str, size_t len);
478 extern void *xrealloc(void *ptr, size_t size);
479 extern void *xcalloc(size_t nmemb, size_t size);
480 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
481 extern ssize_t xread(int fd, void *buf, size_t len);
482 extern ssize_t xwrite(int fd, const void *buf, size_t len);
483 extern int xdup(int fd);
484 extern FILE *xfdopen(int fd, const char *mode);
485 extern int xmkstemp(char *template);
486 extern int xmkstemp_mode(char *template, int mode);
487 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
488 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
490 static inline size_t xsize_t(off_t len)
492 if (len > (size_t) len)
493 die("Cannot handle files this big");
494 return (size_t)len;
497 static inline int has_extension(const char *filename, const char *ext)
499 size_t len = strlen(filename);
500 size_t extlen = strlen(ext);
501 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
504 /* in ctype.c, for kwset users */
505 extern const char tolower_trans_tbl[256];
507 /* Sane ctype - no locale, and works with signed chars */
508 #undef isascii
509 #undef isspace
510 #undef isdigit
511 #undef isalpha
512 #undef isalnum
513 #undef islower
514 #undef isupper
515 #undef tolower
516 #undef toupper
517 extern unsigned char sane_ctype[256];
518 #define GIT_SPACE 0x01
519 #define GIT_DIGIT 0x02
520 #define GIT_ALPHA 0x04
521 #define GIT_GLOB_SPECIAL 0x08
522 #define GIT_REGEX_SPECIAL 0x10
523 #define GIT_PATHSPEC_MAGIC 0x20
524 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
525 #define isascii(x) (((x) & ~0x7f) == 0)
526 #define isspace(x) sane_istest(x,GIT_SPACE)
527 #define isdigit(x) sane_istest(x,GIT_DIGIT)
528 #define isalpha(x) sane_istest(x,GIT_ALPHA)
529 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
530 #define islower(x) sane_iscase(x, 1)
531 #define isupper(x) sane_iscase(x, 0)
532 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
533 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
534 #define tolower(x) sane_case((unsigned char)(x), 0x20)
535 #define toupper(x) sane_case((unsigned char)(x), 0)
536 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
538 static inline int sane_case(int x, int high)
540 if (sane_istest(x, GIT_ALPHA))
541 x = (x & ~0x20) | high;
542 return x;
545 static inline int sane_iscase(int x, int is_lower)
547 if (!sane_istest(x, GIT_ALPHA))
548 return 0;
550 if (is_lower)
551 return (x & 0x20) != 0;
552 else
553 return (x & 0x20) == 0;
556 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
558 unsigned long ul;
559 char *p;
561 errno = 0;
562 ul = strtoul(s, &p, base);
563 if (errno || *p || p == s || (unsigned int) ul != ul)
564 return -1;
565 *result = ul;
566 return 0;
569 static inline int strtol_i(char const *s, int base, int *result)
571 long ul;
572 char *p;
574 errno = 0;
575 ul = strtol(s, &p, base);
576 if (errno || *p || p == s || (int) ul != ul)
577 return -1;
578 *result = ul;
579 return 0;
582 #ifdef INTERNAL_QSORT
583 void git_qsort(void *base, size_t nmemb, size_t size,
584 int(*compar)(const void *, const void *));
585 #define qsort git_qsort
586 #endif
588 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
589 # define FORCE_DIR_SET_GID S_ISGID
590 #else
591 # define FORCE_DIR_SET_GID 0
592 #endif
594 #ifdef NO_NSEC
595 #undef USE_NSEC
596 #define ST_CTIME_NSEC(st) 0
597 #define ST_MTIME_NSEC(st) 0
598 #else
599 #ifdef USE_ST_TIMESPEC
600 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
601 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
602 #else
603 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
604 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
605 #endif
606 #endif
608 #ifdef UNRELIABLE_FSTAT
609 #define fstat_is_reliable() 0
610 #else
611 #define fstat_is_reliable() 1
612 #endif
614 #ifndef va_copy
616 * Since an obvious implementation of va_list would be to make it a
617 * pointer into the stack frame, a simple assignment will work on
618 * many systems. But let's try to be more portable.
620 #ifdef __va_copy
621 #define va_copy(dst, src) __va_copy(dst, src)
622 #else
623 #define va_copy(dst, src) ((dst) = (src))
624 #endif
625 #endif
628 * Preserves errno, prints a message, but gives no warning for ENOENT.
629 * Always returns the return value of unlink(2).
631 int unlink_or_warn(const char *path);
633 * Likewise for rmdir(2).
635 int rmdir_or_warn(const char *path);
637 * Calls the correct function out of {unlink,rmdir}_or_warn based on
638 * the supplied file mode.
640 int remove_or_warn(unsigned int mode, const char *path);
642 /* Call access(2), but warn for any error besides ENOENT. */
643 int access_or_warn(const char *path, int mode);
645 /* Warn on an inaccessible file that ought to be accessible */
646 void warn_on_inaccessible(const char *path);
648 /* Get the passwd entry for the UID of the current process. */
649 struct passwd *xgetpwuid_self(void);
651 #ifndef mark_as_git_dir
652 #define mark_as_git_dir(x) /* noop */
653 #endif
655 #ifndef get_home_directory
656 #define get_home_directory() getenv("HOME")
657 #endif
659 #endif