Implement a work-around for a mis-behaved vsnprintf on Windows.
[git/dscho.git] / git-compat-util.h
blobe4f643d70b7693820a501e6e5be1ca5ae64b8ebe
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
6 #ifndef FLEX_ARRAY
7 #if defined(__GNUC__) && (__GNUC__ < 3)
8 #define FLEX_ARRAY 0
9 #else
10 #define FLEX_ARRAY /* empty */
11 #endif
12 #endif
14 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
16 #ifdef __GNUC__
17 #define TYPEOF(x) (__typeof__(x))
18 #else
19 #define TYPEOF(x)
20 #endif
22 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
24 /* Approximation of the length of the decimal representation of this type. */
25 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
27 #if !defined(__APPLE__) && !defined(__FreeBSD__)
28 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
29 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
30 #endif
31 #define _ALL_SOURCE 1
32 #define _GNU_SOURCE 1
33 #define _BSD_SOURCE 1
35 #include <unistd.h>
36 #include <stdio.h>
37 #include <sys/stat.h>
38 #include <fcntl.h>
39 #include <stddef.h>
40 #include <stdlib.h>
41 #include <stdarg.h>
42 #include <string.h>
43 #include <errno.h>
44 #include <limits.h>
45 #include <sys/param.h>
46 #include <sys/types.h>
47 #include <dirent.h>
48 #include <sys/time.h>
49 #include <time.h>
50 #include <signal.h>
51 #include <fnmatch.h>
52 #ifndef __MINGW32__
53 #include <sys/wait.h>
54 #include <sys/poll.h>
55 #include <sys/socket.h>
56 #include <sys/select.h>
57 #else
58 int mkstemp (char *__template);
59 #endif
60 #include <assert.h>
61 #include <regex.h>
62 #ifndef __MINGW32__
63 #include <netinet/in.h>
64 #include <netinet/tcp.h>
65 #include <arpa/inet.h>
66 #endif
67 #ifndef NO_ETC_PASSWD
68 #include <netdb.h>
69 #include <pwd.h>
70 #include <inttypes.h>
71 #if defined(__CYGWIN__)
72 #undef _XOPEN_SOURCE
73 #include <grp.h>
74 #define _XOPEN_SOURCE 600
75 #else
76 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
77 #include <grp.h>
78 #define _ALL_SOURCE 1
79 #endif
80 #endif
82 #ifndef NO_ICONV
83 #include <iconv.h>
84 #endif
86 /* On most systems <limits.h> would have given us this, but
87 * not on some systems (e.g. GNU/Hurd).
89 #ifndef PATH_MAX
90 #define PATH_MAX 4096
91 #endif
93 #ifndef PRIuMAX
94 #ifndef __MINGW32__
95 #define PRIuMAX "llu"
96 #else
97 #define PRIuMAX "I64u"
98 #endif
99 #endif
101 #ifdef __GNUC__
102 #define NORETURN __attribute__((__noreturn__))
103 #else
104 #define NORETURN
105 #ifndef __attribute__
106 #define __attribute__(x)
107 #endif
108 #endif
110 /* General helper functions */
111 extern void usage(const char *err) NORETURN;
112 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
113 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
114 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
116 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
117 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
118 extern void set_error_routine(void (*routine)(const char *err, va_list params));
119 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
121 #ifdef NO_MMAP
123 #ifndef PROT_READ
124 #define PROT_READ 1
125 #define PROT_WRITE 2
126 #define MAP_PRIVATE 1
127 #define MAP_FAILED ((void*)-1)
128 #endif
130 #define mmap git_mmap
131 #define munmap git_munmap
132 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
133 extern int git_munmap(void *start, size_t length);
135 /* This value must be multiple of (pagesize * 2) */
136 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
138 #else /* NO_MMAP */
140 #include <sys/mman.h>
142 /* This value must be multiple of (pagesize * 2) */
143 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
144 (sizeof(void*) >= 8 \
145 ? 1 * 1024 * 1024 * 1024 \
146 : 32 * 1024 * 1024)
148 #endif /* NO_MMAP */
150 #define DEFAULT_PACKED_GIT_LIMIT \
151 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
153 #ifdef NO_PREAD
154 #define pread git_pread
155 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
156 #endif
158 #ifdef NO_SETENV
159 #define setenv gitsetenv
160 extern int gitsetenv(const char *, const char *, int);
161 #endif
163 #ifdef NO_UNSETENV
164 #define unsetenv gitunsetenv
165 extern void gitunsetenv(const char *);
166 #endif
168 #ifdef NO_STRCASESTR
169 #define strcasestr gitstrcasestr
170 extern char *gitstrcasestr(const char *haystack, const char *needle);
171 #endif
173 #ifdef NO_STRLCPY
174 #define strlcpy gitstrlcpy
175 extern size_t gitstrlcpy(char *, const char *, size_t);
176 #endif
178 #ifdef NO_STRTOUMAX
179 #define strtoumax gitstrtoumax
180 extern uintmax_t gitstrtoumax(const char *, char **, int);
181 #endif
183 #ifdef NO_HSTRERROR
184 #define hstrerror githstrerror
185 extern const char *githstrerror(int herror);
186 #endif
188 #ifdef NO_MEMMEM
189 #define memmem gitmemmem
190 void *gitmemmem(const void *haystack, size_t haystacklen,
191 const void *needle, size_t needlelen);
192 #endif
194 extern void release_pack_memory(size_t, int);
196 static inline char* xstrdup(const char *str)
198 char *ret = strdup(str);
199 if (!ret) {
200 release_pack_memory(strlen(str) + 1, -1);
201 ret = strdup(str);
202 if (!ret)
203 die("Out of memory, strdup failed");
205 return ret;
208 static inline void *xmalloc(size_t size)
210 void *ret = malloc(size);
211 if (!ret && !size)
212 ret = malloc(1);
213 if (!ret) {
214 release_pack_memory(size, -1);
215 ret = malloc(size);
216 if (!ret && !size)
217 ret = malloc(1);
218 if (!ret)
219 die("Out of memory, malloc failed");
221 #ifdef XMALLOC_POISON
222 memset(ret, 0xA5, size);
223 #endif
224 return ret;
227 static inline void *xmemdupz(const void *data, size_t len)
229 char *p = xmalloc(len + 1);
230 memcpy(p, data, len);
231 p[len] = '\0';
232 return p;
235 static inline char *xstrndup(const char *str, size_t len)
237 char *p = memchr(str, '\0', len);
238 return xmemdupz(str, p ? p - str : len);
241 static inline void *xrealloc(void *ptr, size_t size)
243 void *ret = realloc(ptr, size);
244 if (!ret && !size)
245 ret = realloc(ptr, 1);
246 if (!ret) {
247 release_pack_memory(size, -1);
248 ret = realloc(ptr, size);
249 if (!ret && !size)
250 ret = realloc(ptr, 1);
251 if (!ret)
252 die("Out of memory, realloc failed");
254 return ret;
257 static inline void *xcalloc(size_t nmemb, size_t size)
259 void *ret = calloc(nmemb, size);
260 if (!ret && (!nmemb || !size))
261 ret = calloc(1, 1);
262 if (!ret) {
263 release_pack_memory(nmemb * size, -1);
264 ret = calloc(nmemb, size);
265 if (!ret && (!nmemb || !size))
266 ret = calloc(1, 1);
267 if (!ret)
268 die("Out of memory, calloc failed");
270 return ret;
273 static inline void *xmmap(void *start, size_t length,
274 int prot, int flags, int fd, off_t offset)
276 void *ret = mmap(start, length, prot, flags, fd, offset);
277 if (ret == MAP_FAILED) {
278 if (!length)
279 return NULL;
280 release_pack_memory(length, fd);
281 ret = mmap(start, length, prot, flags, fd, offset);
282 if (ret == MAP_FAILED)
283 die("Out of memory? mmap failed: %s", strerror(errno));
285 return ret;
288 static inline ssize_t xread(int fd, void *buf, size_t len)
290 ssize_t nr;
291 while (1) {
292 nr = read(fd, buf, len);
293 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
294 continue;
295 return nr;
299 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
301 ssize_t nr;
302 while (1) {
303 nr = write(fd, buf, len);
304 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
305 continue;
306 return nr;
310 static inline int xdup(int fd)
312 int ret = dup(fd);
313 if (ret < 0)
314 die("dup failed: %s", strerror(errno));
315 return ret;
318 static inline FILE *xfdopen(int fd, const char *mode)
320 FILE *stream = fdopen(fd, mode);
321 if (stream == NULL)
322 die("Out of memory? fdopen failed: %s", strerror(errno));
323 return stream;
326 static inline int xmkstemp(char *template)
328 int fd;
330 fd = mkstemp(template);
331 if (fd < 0)
332 die("Unable to create temporary file: %s", strerror(errno));
333 return fd;
336 static inline size_t xsize_t(off_t len)
338 return (size_t)len;
341 static inline int has_extension(const char *filename, const char *ext)
343 size_t len = strlen(filename);
344 size_t extlen = strlen(ext);
345 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
348 /* Sane ctype - no locale, and works with signed chars */
349 #undef isspace
350 #undef isdigit
351 #undef isalpha
352 #undef isalnum
353 #undef tolower
354 #undef toupper
355 extern unsigned char sane_ctype[256];
356 #define GIT_SPACE 0x01
357 #define GIT_DIGIT 0x02
358 #define GIT_ALPHA 0x04
359 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
360 #define isspace(x) sane_istest(x,GIT_SPACE)
361 #define isdigit(x) sane_istest(x,GIT_DIGIT)
362 #define isalpha(x) sane_istest(x,GIT_ALPHA)
363 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
364 #define tolower(x) sane_case((unsigned char)(x), 0x20)
365 #define toupper(x) sane_case((unsigned char)(x), 0)
367 static inline int sane_case(int x, int high)
369 if (sane_istest(x, GIT_ALPHA))
370 x = (x & ~0x20) | high;
371 return x;
374 static inline int prefixcmp(const char *str, const char *prefix)
376 return strncmp(str, prefix, strlen(prefix));
379 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
381 unsigned long ul;
382 char *p;
384 errno = 0;
385 ul = strtoul(s, &p, base);
386 if (errno || *p || p == s || (unsigned int) ul != ul)
387 return -1;
388 *result = ul;
389 return 0;
392 #ifdef __MINGW32__
394 #ifndef S_ISLNK
395 #define S_IFLNK 0120000 /* Symbolic link */
396 #define S_ISLNK(x) (((x) & S_IFMT) == S_IFLNK)
397 #define S_ISSOCK(x) 0
398 #endif
400 #ifndef S_ISGRP
401 #define S_ISGRP(x) 0
402 #define S_IRGRP 0
403 #define S_IWGRP 0
404 #define S_IXGRP 0
405 #define S_ISGID 0
406 #define S_IROTH 0
407 #define S_IXOTH 0
408 #endif
410 int readlink(const char *path, char *buf, size_t bufsiz);
411 int symlink(const char *oldpath, const char *newpath);
412 #define link symlink
413 int fchmod(int fildes, mode_t mode);
414 int lstat(const char *file_name, struct stat *buf);
416 /* missing: link, mkstemp, fchmod, getuid (?), gettimeofday */
417 int socketpair(int d, int type, int protocol, int sv[2]);
418 #define AF_UNIX 0
419 #define SOCK_STREAM 0
420 int syslog(int type, char *bufp, ...);
421 #define LOG_ERR 1
422 #define LOG_INFO 2
423 #define LOG_DAEMON 4
424 unsigned int alarm(unsigned int seconds);
425 #include <winsock2.h>
426 void mingw_execve(const char *cmd, const char **argv, const char **env);
427 #define execve mingw_execve
428 int fork();
429 typedef int pid_t;
430 #define waitpid(pid, status, options) \
431 ((options == 0) ? _cwait((status), (pid), 0) \
432 : (errno = EINVAL, -1))
433 #define WIFEXITED(x) ((unsigned)(x) < 259) /* STILL_ACTIVE */
434 #define WEXITSTATUS(x) ((x) & 0xff)
435 #define WIFSIGNALED(x) ((unsigned)(x) > 259)
436 #define WTERMSIG(x) (x)
437 #define WNOHANG 1
438 #define SIGKILL 0
439 #define SIGCHLD 0
440 #define SIGALRM 0
441 #define SIGPIPE 0
442 #define ECONNABORTED 0
444 int kill(pid_t pid, int sig);
445 unsigned int sleep (unsigned int __seconds);
446 const char *inet_ntop(int af, const void *src,
447 char *dst, size_t cnt);
448 int gettimeofday(struct timeval *tv, void *tz);
449 int pipe(int filedes[2]);
451 struct pollfd {
452 int fd; /* file descriptor */
453 short events; /* requested events */
454 short revents; /* returned events */
456 int poll(struct pollfd *ufds, unsigned int nfds, int timeout);
457 #define POLLIN 1
458 #define POLLHUP 2
460 static inline int git_mkdir(const char *path, int mode)
462 return mkdir(path);
464 #define mkdir git_mkdir
466 static inline int git_unlink(const char *pathname) {
467 /* read-only files cannot be removed */
468 chmod(pathname, 0666);
469 return unlink(pathname);
471 #define unlink git_unlink
473 #define open(P, F, M...) \
474 (__builtin_constant_p(*(P)) && !strcmp(P, "/dev/null") ? \
475 open("nul", F, ## M) : open(P, F, ## M))
477 #include <time.h>
478 struct tm *gmtime_r(const time_t *timep, struct tm *result);
479 struct tm *localtime_r(const time_t *timep, struct tm *result);
480 #define hstrerror strerror
482 char *mingw_getcwd(char *pointer, int len);
483 #define getcwd mingw_getcwd
485 int mingw_socket(int domain, int type, int protocol);
486 #define socket mingw_socket
488 int mingw_rename(const char*, const char*);
489 #define rename mingw_rename
491 #define setlinebuf(x)
492 #define fsync(x) 0
493 #define getppid() 1
495 extern void quote_argv(const char **dst, const char **src);
496 extern const char *parse_interpreter(const char *cmd);
498 /* Use git_lstat() instead of lstat()/stat() and
499 * git_fstat() instead of fstat() on Windows
501 int git_lstat(const char *file_name, struct stat *buf);
502 int git_fstat(int fd, struct stat *buf);
503 #define lstat(x,y) git_lstat(x,y)
504 #define stat(x,y) git_lstat(x,y)
505 #define fstat(x,y) git_fstat(x,y)
507 int mingw_vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
508 #define vsnprintf mingw_vsnprintf
510 #endif /* __MINGW32__ */
512 #endif