Introduce git_etc_gitconfig() that encapsulates access of ETC_GITCONFIG.
[git/mingw.git] / git-compat-util.h
blob515331d0b56c4925f41b31918a277ebef6e7a2ee
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 extern void release_pack_memory(size_t, int);
183 static inline char* xstrdup(const char *str)
185 char *ret = strdup(str);
186 if (!ret) {
187 release_pack_memory(strlen(str) + 1, -1);
188 ret = strdup(str);
189 if (!ret)
190 die("Out of memory, strdup failed");
192 return ret;
195 static inline void *xmalloc(size_t size)
197 void *ret = malloc(size);
198 if (!ret && !size)
199 ret = malloc(1);
200 if (!ret) {
201 release_pack_memory(size, -1);
202 ret = malloc(size);
203 if (!ret && !size)
204 ret = malloc(1);
205 if (!ret)
206 die("Out of memory, malloc failed");
208 #ifdef XMALLOC_POISON
209 memset(ret, 0xA5, size);
210 #endif
211 return ret;
214 static inline char *xstrndup(const char *str, size_t len)
216 char *p;
218 p = memchr(str, '\0', len);
219 if (p)
220 len = p - str;
221 p = xmalloc(len + 1);
222 memcpy(p, str, len);
223 p[len] = '\0';
224 return p;
227 static inline void *xrealloc(void *ptr, size_t size)
229 void *ret = realloc(ptr, size);
230 if (!ret && !size)
231 ret = realloc(ptr, 1);
232 if (!ret) {
233 release_pack_memory(size, -1);
234 ret = realloc(ptr, size);
235 if (!ret && !size)
236 ret = realloc(ptr, 1);
237 if (!ret)
238 die("Out of memory, realloc failed");
240 return ret;
243 static inline void *xcalloc(size_t nmemb, size_t size)
245 void *ret = calloc(nmemb, size);
246 if (!ret && (!nmemb || !size))
247 ret = calloc(1, 1);
248 if (!ret) {
249 release_pack_memory(nmemb * size, -1);
250 ret = calloc(nmemb, size);
251 if (!ret && (!nmemb || !size))
252 ret = calloc(1, 1);
253 if (!ret)
254 die("Out of memory, calloc failed");
256 return ret;
259 static inline void *xmmap(void *start, size_t length,
260 int prot, int flags, int fd, off_t offset)
262 void *ret = mmap(start, length, prot, flags, fd, offset);
263 if (ret == MAP_FAILED) {
264 if (!length)
265 return NULL;
266 release_pack_memory(length, fd);
267 ret = mmap(start, length, prot, flags, fd, offset);
268 if (ret == MAP_FAILED)
269 die("Out of memory? mmap failed: %s", strerror(errno));
271 return ret;
274 static inline ssize_t xread(int fd, void *buf, size_t len)
276 ssize_t nr;
277 while (1) {
278 nr = read(fd, buf, len);
279 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
280 continue;
281 return nr;
285 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
287 ssize_t nr;
288 while (1) {
289 nr = write(fd, buf, len);
290 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
291 continue;
292 return nr;
296 static inline size_t xsize_t(off_t len)
298 return (size_t)len;
301 static inline int has_extension(const char *filename, const char *ext)
303 size_t len = strlen(filename);
304 size_t extlen = strlen(ext);
305 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
308 /* Sane ctype - no locale, and works with signed chars */
309 #undef isspace
310 #undef isdigit
311 #undef isalpha
312 #undef isalnum
313 #undef tolower
314 #undef toupper
315 extern unsigned char sane_ctype[256];
316 #define GIT_SPACE 0x01
317 #define GIT_DIGIT 0x02
318 #define GIT_ALPHA 0x04
319 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
320 #define isspace(x) sane_istest(x,GIT_SPACE)
321 #define isdigit(x) sane_istest(x,GIT_DIGIT)
322 #define isalpha(x) sane_istest(x,GIT_ALPHA)
323 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
324 #define tolower(x) sane_case((unsigned char)(x), 0x20)
325 #define toupper(x) sane_case((unsigned char)(x), 0)
327 static inline int sane_case(int x, int high)
329 if (sane_istest(x, GIT_ALPHA))
330 x = (x & ~0x20) | high;
331 return x;
334 static inline int prefixcmp(const char *str, const char *prefix)
336 return strncmp(str, prefix, strlen(prefix));
339 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
341 unsigned long ul;
342 char *p;
344 errno = 0;
345 ul = strtoul(s, &p, base);
346 if (errno || *p || p == s || (unsigned int) ul != ul)
347 return -1;
348 *result = ul;
349 return 0;
352 #ifdef __MINGW32__
354 #ifndef S_ISLNK
355 #define S_IFLNK 0120000 /* Symbolic link */
356 #define S_ISLNK(x) (((x) & S_IFMT) == S_IFLNK)
357 #endif
359 #ifndef S_ISGRP
360 #define S_ISGRP(x) 0
361 #define S_IRGRP 0
362 #define S_IWGRP 0
363 #define S_IXGRP 0
364 #define S_ISGID 0
365 #define S_IROTH 0
366 #define S_IXOTH 0
367 #endif
369 int readlink(const char *path, char *buf, size_t bufsiz);
370 int symlink(const char *oldpath, const char *newpath);
371 #define link symlink
372 int fchmod(int fildes, mode_t mode);
373 int lstat(const char *file_name, struct stat *buf);
375 /* missing: link, mkstemp, fchmod, getuid (?), gettimeofday */
376 int socketpair(int d, int type, int protocol, int sv[2]);
377 #define AF_UNIX 0
378 #define SOCK_STREAM 0
379 int syslog(int type, char *bufp, ...);
380 #define LOG_ERR 1
381 #define LOG_INFO 2
382 #define LOG_DAEMON 4
383 unsigned int alarm(unsigned int seconds);
384 #include <winsock2.h>
385 void mingw_execve(const char *cmd, const char **argv, const char **env);
386 #define execve mingw_execve
387 int fork();
388 typedef int pid_t;
389 #define waitpid(pid, status, options) \
390 ((options == 0) ? _cwait((status), (pid), 0) \
391 : (errno = EINVAL, -1))
392 #define WIFEXITED(x) ((unsigned)(x) < 259) /* STILL_ACTIVE */
393 #define WEXITSTATUS(x) ((x) & 0xff)
394 #define WIFSIGNALED(x) ((unsigned)(x) > 259)
395 #define WTERMSIG(x) (x)
396 #define WNOHANG 1
397 #define SIGKILL 0
398 #define SIGCHLD 0
399 #define SIGALRM 0
400 #define ECONNABORTED 0
402 int kill(pid_t pid, int sig);
403 unsigned int sleep (unsigned int __seconds);
404 const char *inet_ntop(int af, const void *src,
405 char *dst, size_t cnt);
406 int mkstemp (char *__template);
407 int gettimeofday(struct timeval *tv, void *tz);
408 int pipe(int filedes[2]);
410 struct pollfd {
411 int fd; /* file descriptor */
412 short events; /* requested events */
413 short revents; /* returned events */
415 int poll(struct pollfd *ufds, unsigned int nfds, int timeout);
416 #define POLLIN 1
417 #define POLLHUP 2
419 static inline int git_mkdir(const char *path, int mode)
421 return mkdir(path);
423 #define mkdir git_mkdir
425 static inline int git_unlink(const char *pathname) {
426 /* read-only files cannot be removed */
427 chmod(pathname, 0666);
428 return unlink(pathname);
430 #define unlink git_unlink
432 #define open(P, F, M...) \
433 (__builtin_constant_p(*(P)) && !strcmp(P, "/dev/null") ? \
434 open("nul", F, ## M) : open(P, F, ## M))
436 #include <time.h>
437 struct tm *gmtime_r(const time_t *timep, struct tm *result);
438 struct tm *localtime_r(const time_t *timep, struct tm *result);
439 #define hstrerror strerror
441 char *mingw_getcwd(char *pointer, int len);
442 #define getcwd mingw_getcwd
444 int mingw_socket(int domain, int type, int protocol);
445 #define socket mingw_socket
447 #define setlinebuf(x)
448 #define fsync(x)
450 extern void quote_argv(const char **dst, const char **src);
451 extern const char *parse_interpreter(const char *cmd);
453 #endif /* __MINGW32__ */
455 #endif