git-svn: document --username
[git/platforms.git] / git-compat-util.h
blob5d154faef6bcdbef7ae8ad91b92b08be326af1e1
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 #if !defined(__APPLE__) && !defined(__FreeBSD__)
17 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
18 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
19 #endif
20 #define _ALL_SOURCE 1
21 #define _GNU_SOURCE 1
22 #define _BSD_SOURCE 1
24 #include <unistd.h>
25 #include <stdio.h>
26 #include <sys/stat.h>
27 #include <fcntl.h>
28 #include <stddef.h>
29 #include <stdlib.h>
30 #include <stdarg.h>
31 #include <string.h>
32 #include <errno.h>
33 #include <limits.h>
34 #include <sys/param.h>
35 #include <sys/types.h>
36 #include <dirent.h>
37 #include <sys/time.h>
38 #include <time.h>
39 #include <signal.h>
40 #include <sys/wait.h>
41 #include <fnmatch.h>
42 #include <sys/poll.h>
43 #include <sys/socket.h>
44 #include <assert.h>
45 #include <regex.h>
46 #include <netinet/in.h>
47 #include <netinet/tcp.h>
48 #include <arpa/inet.h>
49 #include <netdb.h>
50 #include <pwd.h>
51 #include <inttypes.h>
52 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
53 #include <grp.h>
54 #define _ALL_SOURCE 1
56 #ifndef NO_ICONV
57 #include <iconv.h>
58 #endif
60 /* On most systems <limits.h> would have given us this, but
61 * not on some systems (e.g. GNU/Hurd).
63 #ifndef PATH_MAX
64 #define PATH_MAX 4096
65 #endif
67 #ifdef __GNUC__
68 #define NORETURN __attribute__((__noreturn__))
69 #else
70 #define NORETURN
71 #ifndef __attribute__
72 #define __attribute__(x)
73 #endif
74 #endif
76 /* General helper functions */
77 extern void usage(const char *err) NORETURN;
78 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
79 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
80 extern void warn(const char *err, ...) __attribute__((format (printf, 1, 2)));
82 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
83 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
84 extern void set_error_routine(void (*routine)(const char *err, va_list params));
85 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
87 #ifdef NO_MMAP
89 #ifndef PROT_READ
90 #define PROT_READ 1
91 #define PROT_WRITE 2
92 #define MAP_PRIVATE 1
93 #define MAP_FAILED ((void*)-1)
94 #endif
96 #define mmap git_mmap
97 #define munmap git_munmap
98 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
99 extern int git_munmap(void *start, size_t length);
101 /* This value must be multiple of (pagesize * 2) */
102 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
104 #else /* NO_MMAP */
106 #include <sys/mman.h>
108 /* This value must be multiple of (pagesize * 2) */
109 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
110 (sizeof(void*) >= 8 \
111 ? 1 * 1024 * 1024 * 1024 \
112 : 32 * 1024 * 1024)
114 #endif /* NO_MMAP */
116 #define DEFAULT_PACKED_GIT_LIMIT \
117 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
119 #ifdef NO_PREAD
120 #define pread git_pread
121 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
122 #endif
124 #ifdef NO_SETENV
125 #define setenv gitsetenv
126 extern int gitsetenv(const char *, const char *, int);
127 #endif
129 #ifdef NO_UNSETENV
130 #define unsetenv gitunsetenv
131 extern void gitunsetenv(const char *);
132 #endif
134 #ifdef NO_STRCASESTR
135 #define strcasestr gitstrcasestr
136 extern char *gitstrcasestr(const char *haystack, const char *needle);
137 #endif
139 #ifdef NO_STRLCPY
140 #define strlcpy gitstrlcpy
141 extern size_t gitstrlcpy(char *, const char *, size_t);
142 #endif
144 #ifdef NO_STRTOUMAX
145 #define strtoumax gitstrtoumax
146 extern uintmax_t gitstrtoumax(const char *, char **, int);
147 #endif
149 extern void release_pack_memory(size_t);
151 static inline char* xstrdup(const char *str)
153 char *ret = strdup(str);
154 if (!ret) {
155 release_pack_memory(strlen(str) + 1);
156 ret = strdup(str);
157 if (!ret)
158 die("Out of memory, strdup failed");
160 return ret;
163 static inline void *xmalloc(size_t size)
165 void *ret = malloc(size);
166 if (!ret && !size)
167 ret = malloc(1);
168 if (!ret) {
169 release_pack_memory(size);
170 ret = malloc(size);
171 if (!ret && !size)
172 ret = malloc(1);
173 if (!ret)
174 die("Out of memory, malloc failed");
176 #ifdef XMALLOC_POISON
177 memset(ret, 0xA5, size);
178 #endif
179 return ret;
182 static inline void *xrealloc(void *ptr, size_t size)
184 void *ret = realloc(ptr, size);
185 if (!ret && !size)
186 ret = realloc(ptr, 1);
187 if (!ret) {
188 release_pack_memory(size);
189 ret = realloc(ptr, size);
190 if (!ret && !size)
191 ret = realloc(ptr, 1);
192 if (!ret)
193 die("Out of memory, realloc failed");
195 return ret;
198 static inline void *xcalloc(size_t nmemb, size_t size)
200 void *ret = calloc(nmemb, size);
201 if (!ret && (!nmemb || !size))
202 ret = calloc(1, 1);
203 if (!ret) {
204 release_pack_memory(nmemb * size);
205 ret = calloc(nmemb, size);
206 if (!ret && (!nmemb || !size))
207 ret = calloc(1, 1);
208 if (!ret)
209 die("Out of memory, calloc failed");
211 return ret;
214 static inline void *xmmap(void *start, size_t length,
215 int prot, int flags, int fd, off_t offset)
217 void *ret = mmap(start, length, prot, flags, fd, offset);
218 if (ret == MAP_FAILED) {
219 if (!length)
220 return NULL;
221 release_pack_memory(length);
222 ret = mmap(start, length, prot, flags, fd, offset);
223 if (ret == MAP_FAILED)
224 die("Out of memory? mmap failed: %s", strerror(errno));
226 return ret;
229 static inline ssize_t xread(int fd, void *buf, size_t len)
231 ssize_t nr;
232 while (1) {
233 nr = read(fd, buf, len);
234 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
235 continue;
236 return nr;
240 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
242 ssize_t nr;
243 while (1) {
244 nr = write(fd, buf, len);
245 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
246 continue;
247 return nr;
251 static inline int has_extension(const char *filename, const char *ext)
253 size_t len = strlen(filename);
254 size_t extlen = strlen(ext);
255 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
258 /* Sane ctype - no locale, and works with signed chars */
259 #undef isspace
260 #undef isdigit
261 #undef isalpha
262 #undef isalnum
263 #undef tolower
264 #undef toupper
265 extern unsigned char sane_ctype[256];
266 #define GIT_SPACE 0x01
267 #define GIT_DIGIT 0x02
268 #define GIT_ALPHA 0x04
269 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
270 #define isspace(x) sane_istest(x,GIT_SPACE)
271 #define isdigit(x) sane_istest(x,GIT_DIGIT)
272 #define isalpha(x) sane_istest(x,GIT_ALPHA)
273 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
274 #define tolower(x) sane_case((unsigned char)(x), 0x20)
275 #define toupper(x) sane_case((unsigned char)(x), 0)
277 static inline int sane_case(int x, int high)
279 if (sane_istest(x, GIT_ALPHA))
280 x = (x & ~0x20) | high;
281 return x;
284 static inline int prefixcmp(const char *str, const char *prefix)
286 return strncmp(str, prefix, strlen(prefix));
289 #endif