parse-options new features.
[git/git.git] / git-compat-util.h
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
3
4 #define _FILE_OFFSET_BITS 64
5
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
13
14 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
15
16 #ifdef __GNUC__
17 #define TYPEOF(x) (__typeof__(x))
18 #else
19 #define TYPEOF(x)
20 #endif
21
22 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
23 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
24
25 /* Approximation of the length of the decimal representation of this type. */
26 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
27
28 #if !defined(__APPLE__) && !defined(__FreeBSD__)
29 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
30 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
31 #endif
32 #define _ALL_SOURCE 1
33 #define _GNU_SOURCE 1
34 #define _BSD_SOURCE 1
35
36 #include <unistd.h>
37 #include <stdio.h>
38 #include <sys/stat.h>
39 #include <fcntl.h>
40 #include <stddef.h>
41 #include <stdlib.h>
42 #include <stdarg.h>
43 #include <string.h>
44 #include <errno.h>
45 #include <limits.h>
46 #include <sys/param.h>
47 #include <sys/types.h>
48 #include <dirent.h>
49 #include <sys/time.h>
50 #include <time.h>
51 #include <signal.h>
52 #include <sys/wait.h>
53 #include <fnmatch.h>
54 #include <sys/poll.h>
55 #include <sys/socket.h>
56 #include <assert.h>
57 #include <regex.h>
58 #include <netinet/in.h>
59 #include <netinet/tcp.h>
60 #include <arpa/inet.h>
61 #include <netdb.h>
62 #include <pwd.h>
63 #include <inttypes.h>
64 #if defined(__CYGWIN__)
65 #undef _XOPEN_SOURCE
66 #include <grp.h>
67 #define _XOPEN_SOURCE 600
68 #else
69 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
70 #include <grp.h>
71 #define _ALL_SOURCE 1
72 #endif
73
74 #ifndef NO_ICONV
75 #include <iconv.h>
76 #endif
77
78 /* On most systems <limits.h> would have given us this, but
79 * not on some systems (e.g. GNU/Hurd).
80 */
81 #ifndef PATH_MAX
82 #define PATH_MAX 4096
83 #endif
84
85 #ifndef PRIuMAX
86 #define PRIuMAX "llu"
87 #endif
88
89 #ifdef __GNUC__
90 #define NORETURN __attribute__((__noreturn__))
91 #else
92 #define NORETURN
93 #ifndef __attribute__
94 #define __attribute__(x)
95 #endif
96 #endif
97
98 /* General helper functions */
99 extern void usage(const char *err) NORETURN;
100 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
101 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
102 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
103
104 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
105 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
106 extern void set_error_routine(void (*routine)(const char *err, va_list params));
107 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
108
109 #ifdef NO_MMAP
110
111 #ifndef PROT_READ
112 #define PROT_READ 1
113 #define PROT_WRITE 2
114 #define MAP_PRIVATE 1
115 #define MAP_FAILED ((void*)-1)
116 #endif
117
118 #define mmap git_mmap
119 #define munmap git_munmap
120 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
121 extern int git_munmap(void *start, size_t length);
122
123 /* This value must be multiple of (pagesize * 2) */
124 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
125
126 #else /* NO_MMAP */
127
128 #include <sys/mman.h>
129
130 /* This value must be multiple of (pagesize * 2) */
131 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
132 (sizeof(void*) >= 8 \
133 ? 1 * 1024 * 1024 * 1024 \
134 : 32 * 1024 * 1024)
135
136 #endif /* NO_MMAP */
137
138 #define DEFAULT_PACKED_GIT_LIMIT \
139 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
140
141 #ifdef NO_PREAD
142 #define pread git_pread
143 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
144 #endif
145
146 #ifdef NO_SETENV
147 #define setenv gitsetenv
148 extern int gitsetenv(const char *, const char *, int);
149 #endif
150
151 #ifdef NO_MKDTEMP
152 #define mkdtemp gitmkdtemp
153 extern char *gitmkdtemp(char *);
154 #endif
155
156 #ifdef NO_UNSETENV
157 #define unsetenv gitunsetenv
158 extern void gitunsetenv(const char *);
159 #endif
160
161 #ifdef NO_STRCASESTR
162 #define strcasestr gitstrcasestr
163 extern char *gitstrcasestr(const char *haystack, const char *needle);
164 #endif
165
166 #ifdef NO_STRLCPY
167 #define strlcpy gitstrlcpy
168 extern size_t gitstrlcpy(char *, const char *, size_t);
169 #endif
170
171 #ifdef NO_STRTOUMAX
172 #define strtoumax gitstrtoumax
173 extern uintmax_t gitstrtoumax(const char *, char **, int);
174 #endif
175
176 #ifdef NO_HSTRERROR
177 #define hstrerror githstrerror
178 extern const char *githstrerror(int herror);
179 #endif
180
181 #ifdef NO_MEMMEM
182 #define memmem gitmemmem
183 void *gitmemmem(const void *haystack, size_t haystacklen,
184 const void *needle, size_t needlelen);
185 #endif
186
187 extern void release_pack_memory(size_t, int);
188
189 static inline char* xstrdup(const char *str)
190 {
191 char *ret = strdup(str);
192 if (!ret) {
193 release_pack_memory(strlen(str) + 1, -1);
194 ret = strdup(str);
195 if (!ret)
196 die("Out of memory, strdup failed");
197 }
198 return ret;
199 }
200
201 static inline void *xmalloc(size_t size)
202 {
203 void *ret = malloc(size);
204 if (!ret && !size)
205 ret = malloc(1);
206 if (!ret) {
207 release_pack_memory(size, -1);
208 ret = malloc(size);
209 if (!ret && !size)
210 ret = malloc(1);
211 if (!ret)
212 die("Out of memory, malloc failed");
213 }
214 #ifdef XMALLOC_POISON
215 memset(ret, 0xA5, size);
216 #endif
217 return ret;
218 }
219
220 static inline void *xmemdupz(const void *data, size_t len)
221 {
222 char *p = xmalloc(len + 1);
223 memcpy(p, data, len);
224 p[len] = '\0';
225 return p;
226 }
227
228 static inline char *xstrndup(const char *str, size_t len)
229 {
230 char *p = memchr(str, '\0', len);
231 return xmemdupz(str, p ? p - str : len);
232 }
233
234 static inline void *xrealloc(void *ptr, size_t size)
235 {
236 void *ret = realloc(ptr, size);
237 if (!ret && !size)
238 ret = realloc(ptr, 1);
239 if (!ret) {
240 release_pack_memory(size, -1);
241 ret = realloc(ptr, size);
242 if (!ret && !size)
243 ret = realloc(ptr, 1);
244 if (!ret)
245 die("Out of memory, realloc failed");
246 }
247 return ret;
248 }
249
250 static inline void *xcalloc(size_t nmemb, size_t size)
251 {
252 void *ret = calloc(nmemb, size);
253 if (!ret && (!nmemb || !size))
254 ret = calloc(1, 1);
255 if (!ret) {
256 release_pack_memory(nmemb * size, -1);
257 ret = calloc(nmemb, size);
258 if (!ret && (!nmemb || !size))
259 ret = calloc(1, 1);
260 if (!ret)
261 die("Out of memory, calloc failed");
262 }
263 return ret;
264 }
265
266 static inline void *xmmap(void *start, size_t length,
267 int prot, int flags, int fd, off_t offset)
268 {
269 void *ret = mmap(start, length, prot, flags, fd, offset);
270 if (ret == MAP_FAILED) {
271 if (!length)
272 return NULL;
273 release_pack_memory(length, fd);
274 ret = mmap(start, length, prot, flags, fd, offset);
275 if (ret == MAP_FAILED)
276 die("Out of memory? mmap failed: %s", strerror(errno));
277 }
278 return ret;
279 }
280
281 static inline ssize_t xread(int fd, void *buf, size_t len)
282 {
283 ssize_t nr;
284 while (1) {
285 nr = read(fd, buf, len);
286 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
287 continue;
288 return nr;
289 }
290 }
291
292 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
293 {
294 ssize_t nr;
295 while (1) {
296 nr = write(fd, buf, len);
297 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
298 continue;
299 return nr;
300 }
301 }
302
303 static inline int xdup(int fd)
304 {
305 int ret = dup(fd);
306 if (ret < 0)
307 die("dup failed: %s", strerror(errno));
308 return ret;
309 }
310
311 static inline FILE *xfdopen(int fd, const char *mode)
312 {
313 FILE *stream = fdopen(fd, mode);
314 if (stream == NULL)
315 die("Out of memory? fdopen failed: %s", strerror(errno));
316 return stream;
317 }
318
319 static inline int xmkstemp(char *template)
320 {
321 int fd;
322
323 fd = mkstemp(template);
324 if (fd < 0)
325 die("Unable to create temporary file: %s", strerror(errno));
326 return fd;
327 }
328
329 static inline size_t xsize_t(off_t len)
330 {
331 return (size_t)len;
332 }
333
334 static inline int has_extension(const char *filename, const char *ext)
335 {
336 size_t len = strlen(filename);
337 size_t extlen = strlen(ext);
338 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
339 }
340
341 /* Sane ctype - no locale, and works with signed chars */
342 #undef isspace
343 #undef isdigit
344 #undef isalpha
345 #undef isalnum
346 #undef tolower
347 #undef toupper
348 extern unsigned char sane_ctype[256];
349 #define GIT_SPACE 0x01
350 #define GIT_DIGIT 0x02
351 #define GIT_ALPHA 0x04
352 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
353 #define isspace(x) sane_istest(x,GIT_SPACE)
354 #define isdigit(x) sane_istest(x,GIT_DIGIT)
355 #define isalpha(x) sane_istest(x,GIT_ALPHA)
356 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
357 #define tolower(x) sane_case((unsigned char)(x), 0x20)
358 #define toupper(x) sane_case((unsigned char)(x), 0)
359
360 static inline int sane_case(int x, int high)
361 {
362 if (sane_istest(x, GIT_ALPHA))
363 x = (x & ~0x20) | high;
364 return x;
365 }
366
367 static inline int prefixcmp(const char *str, const char *prefix)
368 {
369 return strncmp(str, prefix, strlen(prefix));
370 }
371
372 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
373 {
374 unsigned long ul;
375 char *p;
376
377 errno = 0;
378 ul = strtoul(s, &p, base);
379 if (errno || *p || p == s || (unsigned int) ul != ul)
380 return -1;
381 *result = ul;
382 return 0;
383 }
384
385 static inline int strtol_i(char const *s, int base, int *result)
386 {
387 long ul;
388 char *p;
389
390 errno = 0;
391 ul = strtol(s, &p, base);
392 if (errno || *p || p == s || (int) ul != ul)
393 return -1;
394 *result = ul;
395 return 0;
396 }
397
398 #endif