Trace ssh connections when GIT_TRACE is set
[git/mingw/4msysgit/wingit-dll.git] / git-compat-util.h
blobddafec997f5e8ad7e8ddfee10b7ecda5cc3c68f4
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 #endif
58 #include <assert.h>
59 #include <regex.h>
60 #ifndef __MINGW32__
61 #include <netinet/in.h>
62 #include <netinet/tcp.h>
63 #include <arpa/inet.h>
64 #endif
65 #ifndef NO_ETC_PASSWD
66 #include <netdb.h>
67 #include <pwd.h>
68 #include <inttypes.h>
69 #if defined(__CYGWIN__)
70 #undef _XOPEN_SOURCE
71 #include <grp.h>
72 #define _XOPEN_SOURCE 600
73 #else
74 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
75 #include <grp.h>
76 #define _ALL_SOURCE 1
77 #endif
78 #endif
80 #ifndef NO_ICONV
81 #include <iconv.h>
82 #endif
84 /* On most systems <limits.h> would have given us this, but
85 * not on some systems (e.g. GNU/Hurd).
87 #ifndef PATH_MAX
88 #define PATH_MAX 4096
89 #endif
91 #ifndef PRIuMAX
92 #ifndef __MINGW32__
93 #define PRIuMAX "llu"
94 #else
95 #define PRIuMAX "I64u"
96 #endif
97 #endif
99 #ifdef __GNUC__
100 #define NORETURN __attribute__((__noreturn__))
101 #else
102 #define NORETURN
103 #ifndef __attribute__
104 #define __attribute__(x)
105 #endif
106 #endif
108 /* General helper functions */
109 extern void usage(const char *err) NORETURN;
110 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
111 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
112 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
114 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
115 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
116 extern void set_error_routine(void (*routine)(const char *err, va_list params));
117 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
119 #ifdef NO_MMAP
121 #ifndef PROT_READ
122 #define PROT_READ 1
123 #define PROT_WRITE 2
124 #define MAP_PRIVATE 1
125 #define MAP_FAILED ((void*)-1)
126 #endif
128 #define mmap git_mmap
129 #define munmap git_munmap
130 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
131 extern int git_munmap(void *start, size_t length);
133 /* This value must be multiple of (pagesize * 2) */
134 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
136 #else /* NO_MMAP */
138 #include <sys/mman.h>
140 /* This value must be multiple of (pagesize * 2) */
141 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
142 (sizeof(void*) >= 8 \
143 ? 1 * 1024 * 1024 * 1024 \
144 : 32 * 1024 * 1024)
146 #endif /* NO_MMAP */
148 #define DEFAULT_PACKED_GIT_LIMIT \
149 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
151 #ifdef NO_PREAD
152 #define pread git_pread
153 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
154 #endif
156 #ifdef NO_SETENV
157 #define setenv gitsetenv
158 extern int gitsetenv(const char *, const char *, int);
159 #endif
161 #ifdef NO_UNSETENV
162 #define unsetenv gitunsetenv
163 extern void gitunsetenv(const char *);
164 #endif
166 #ifdef NO_STRCASESTR
167 #define strcasestr gitstrcasestr
168 extern char *gitstrcasestr(const char *haystack, const char *needle);
169 #endif
171 #ifdef NO_STRLCPY
172 #define strlcpy gitstrlcpy
173 extern size_t gitstrlcpy(char *, const char *, size_t);
174 #endif
176 #ifdef NO_STRTOUMAX
177 #define strtoumax gitstrtoumax
178 extern uintmax_t gitstrtoumax(const char *, char **, int);
179 #endif
181 #ifdef NO_HSTRERROR
182 #define hstrerror githstrerror
183 extern const char *githstrerror(int herror);
184 #endif
186 extern void release_pack_memory(size_t, int);
188 static inline char* xstrdup(const char *str)
190 char *ret = strdup(str);
191 if (!ret) {
192 release_pack_memory(strlen(str) + 1, -1);
193 ret = strdup(str);
194 if (!ret)
195 die("Out of memory, strdup failed");
197 return ret;
200 static inline void *xmalloc(size_t size)
202 void *ret = malloc(size);
203 if (!ret && !size)
204 ret = malloc(1);
205 if (!ret) {
206 release_pack_memory(size, -1);
207 ret = malloc(size);
208 if (!ret && !size)
209 ret = malloc(1);
210 if (!ret)
211 die("Out of memory, malloc failed");
213 #ifdef XMALLOC_POISON
214 memset(ret, 0xA5, size);
215 #endif
216 return ret;
219 static inline char *xstrndup(const char *str, size_t len)
221 char *p;
223 p = memchr(str, '\0', len);
224 if (p)
225 len = p - str;
226 p = xmalloc(len + 1);
227 memcpy(p, str, len);
228 p[len] = '\0';
229 return p;
232 static inline void *xrealloc(void *ptr, size_t size)
234 void *ret = realloc(ptr, size);
235 if (!ret && !size)
236 ret = realloc(ptr, 1);
237 if (!ret) {
238 release_pack_memory(size, -1);
239 ret = realloc(ptr, size);
240 if (!ret && !size)
241 ret = realloc(ptr, 1);
242 if (!ret)
243 die("Out of memory, realloc failed");
245 return ret;
248 static inline void *xcalloc(size_t nmemb, size_t size)
250 void *ret = calloc(nmemb, size);
251 if (!ret && (!nmemb || !size))
252 ret = calloc(1, 1);
253 if (!ret) {
254 release_pack_memory(nmemb * size, -1);
255 ret = calloc(nmemb, size);
256 if (!ret && (!nmemb || !size))
257 ret = calloc(1, 1);
258 if (!ret)
259 die("Out of memory, calloc failed");
261 return ret;
264 static inline void *xmmap(void *start, size_t length,
265 int prot, int flags, int fd, off_t offset)
267 void *ret = mmap(start, length, prot, flags, fd, offset);
268 if (ret == MAP_FAILED) {
269 if (!length)
270 return NULL;
271 release_pack_memory(length, fd);
272 ret = mmap(start, length, prot, flags, fd, offset);
273 if (ret == MAP_FAILED)
274 die("Out of memory? mmap failed: %s", strerror(errno));
276 return ret;
279 static inline ssize_t xread(int fd, void *buf, size_t len)
281 ssize_t nr;
282 while (1) {
283 nr = read(fd, buf, len);
284 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
285 continue;
286 return nr;
290 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
292 ssize_t nr;
293 while (1) {
294 nr = write(fd, buf, len);
295 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
296 continue;
297 return nr;
301 static inline int xdup(int fd)
303 int ret = dup(fd);
304 if (ret < 0)
305 die("dup failed: %s", strerror(errno));
306 return ret;
309 static inline FILE *xfdopen(int fd, const char *mode)
311 FILE *stream = fdopen(fd, mode);
312 if (stream == NULL)
313 die("Out of memory? fdopen failed: %s", strerror(errno));
314 return stream;
317 static inline size_t xsize_t(off_t len)
319 return (size_t)len;
322 static inline int has_extension(const char *filename, const char *ext)
324 size_t len = strlen(filename);
325 size_t extlen = strlen(ext);
326 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
329 /* Sane ctype - no locale, and works with signed chars */
330 #undef isspace
331 #undef isdigit
332 #undef isalpha
333 #undef isalnum
334 #undef tolower
335 #undef toupper
336 extern unsigned char sane_ctype[256];
337 #define GIT_SPACE 0x01
338 #define GIT_DIGIT 0x02
339 #define GIT_ALPHA 0x04
340 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
341 #define isspace(x) sane_istest(x,GIT_SPACE)
342 #define isdigit(x) sane_istest(x,GIT_DIGIT)
343 #define isalpha(x) sane_istest(x,GIT_ALPHA)
344 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
345 #define tolower(x) sane_case((unsigned char)(x), 0x20)
346 #define toupper(x) sane_case((unsigned char)(x), 0)
348 static inline int sane_case(int x, int high)
350 if (sane_istest(x, GIT_ALPHA))
351 x = (x & ~0x20) | high;
352 return x;
355 static inline int prefixcmp(const char *str, const char *prefix)
357 return strncmp(str, prefix, strlen(prefix));
360 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
362 unsigned long ul;
363 char *p;
365 errno = 0;
366 ul = strtoul(s, &p, base);
367 if (errno || *p || p == s || (unsigned int) ul != ul)
368 return -1;
369 *result = ul;
370 return 0;
373 #ifdef __MINGW32__
375 #ifndef S_ISLNK
376 #define S_IFLNK 0120000 /* Symbolic link */
377 #define S_ISLNK(x) (((x) & S_IFMT) == S_IFLNK)
378 #define S_ISSOCK(x) 0
379 #endif
381 #ifndef S_ISGRP
382 #define S_ISGRP(x) 0
383 #define S_IRGRP 0
384 #define S_IWGRP 0
385 #define S_IXGRP 0
386 #define S_ISGID 0
387 #define S_IROTH 0
388 #define S_IXOTH 0
389 #endif
391 int readlink(const char *path, char *buf, size_t bufsiz);
392 int symlink(const char *oldpath, const char *newpath);
393 #define link symlink
394 int fchmod(int fildes, mode_t mode);
395 int lstat(const char *file_name, struct stat *buf);
397 /* missing: link, mkstemp, fchmod, getuid (?), gettimeofday */
398 int socketpair(int d, int type, int protocol, int sv[2]);
399 #define AF_UNIX 0
400 #define SOCK_STREAM 0
401 int syslog(int type, char *bufp, ...);
402 #define LOG_ERR 1
403 #define LOG_INFO 2
404 #define LOG_DAEMON 4
405 unsigned int alarm(unsigned int seconds);
406 #include <winsock2.h>
407 void mingw_execve(const char *cmd, const char **argv, const char **env);
408 #define execve mingw_execve
409 int fork();
410 typedef int pid_t;
411 #define waitpid(pid, status, options) \
412 ((options == 0) ? _cwait((status), (pid), 0) \
413 : (errno = EINVAL, -1))
414 #define WIFEXITED(x) ((unsigned)(x) < 259) /* STILL_ACTIVE */
415 #define WEXITSTATUS(x) ((x) & 0xff)
416 #define WIFSIGNALED(x) ((unsigned)(x) > 259)
417 #define WTERMSIG(x) (x)
418 #define WNOHANG 1
419 #define SIGKILL 0
420 #define SIGCHLD 0
421 #define SIGALRM 0
422 #define ECONNABORTED 0
424 int kill(pid_t pid, int sig);
425 unsigned int sleep (unsigned int __seconds);
426 const char *inet_ntop(int af, const void *src,
427 char *dst, size_t cnt);
428 int mkstemp (char *__template);
429 int gettimeofday(struct timeval *tv, void *tz);
430 int pipe(int filedes[2]);
432 struct pollfd {
433 int fd; /* file descriptor */
434 short events; /* requested events */
435 short revents; /* returned events */
437 int poll(struct pollfd *ufds, unsigned int nfds, int timeout);
438 #define POLLIN 1
439 #define POLLHUP 2
441 static inline int git_mkdir(const char *path, int mode)
443 return mkdir(path);
445 #define mkdir git_mkdir
447 static inline int git_unlink(const char *pathname) {
448 /* read-only files cannot be removed */
449 chmod(pathname, 0666);
450 return unlink(pathname);
452 #define unlink git_unlink
454 #define open(P, F, M...) \
455 (__builtin_constant_p(*(P)) && !strcmp(P, "/dev/null") ? \
456 open("nul", F, ## M) : open(P, F, ## M))
458 #include <time.h>
459 struct tm *gmtime_r(const time_t *timep, struct tm *result);
460 struct tm *localtime_r(const time_t *timep, struct tm *result);
461 #define hstrerror strerror
463 char *mingw_getcwd(char *pointer, int len);
464 #define getcwd mingw_getcwd
466 int mingw_socket(int domain, int type, int protocol);
467 #define socket mingw_socket
469 #define setlinebuf(x)
470 #define fsync(x) 0
472 extern void quote_argv(const char **dst, const char **src);
473 extern const char *parse_interpreter(const char *cmd);
475 #endif /* __MINGW32__ */
477 #endif