Code

tutorial: revise index introduction
[git.git] / git-compat-util.h
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 /* Approximation of the length of the decimal representation of this type. */
17 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
19 #if !defined(__APPLE__) && !defined(__FreeBSD__)
20 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
21 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
22 #endif
23 #define _ALL_SOURCE 1
24 #define _GNU_SOURCE 1
25 #define _BSD_SOURCE 1
27 #include <unistd.h>
28 #include <stdio.h>
29 #include <sys/stat.h>
30 #include <fcntl.h>
31 #include <stddef.h>
32 #include <stdlib.h>
33 #include <stdarg.h>
34 #include <string.h>
35 #include <errno.h>
36 #include <limits.h>
37 #include <sys/param.h>
38 #include <sys/types.h>
39 #include <dirent.h>
40 #include <sys/time.h>
41 #include <time.h>
42 #include <signal.h>
43 #include <sys/wait.h>
44 #include <fnmatch.h>
45 #include <sys/poll.h>
46 #include <sys/socket.h>
47 #include <assert.h>
48 #include <regex.h>
49 #include <netinet/in.h>
50 #include <netinet/tcp.h>
51 #include <arpa/inet.h>
52 #include <netdb.h>
53 #include <pwd.h>
54 #include <inttypes.h>
55 #if defined(__CYGWIN__)
56 #undef _XOPEN_SOURCE
57 #include <grp.h>
58 #define _XOPEN_SOURCE 600
59 #else
60 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
61 #include <grp.h>
62 #define _ALL_SOURCE 1
63 #endif
65 #ifndef NO_ICONV
66 #include <iconv.h>
67 #endif
69 /* On most systems <limits.h> would have given us this, but
70  * not on some systems (e.g. GNU/Hurd).
71  */
72 #ifndef PATH_MAX
73 #define PATH_MAX 4096
74 #endif
76 #ifndef PRIuMAX
77 #define PRIuMAX "llu"
78 #endif
80 #ifdef __GNUC__
81 #define NORETURN __attribute__((__noreturn__))
82 #else
83 #define NORETURN
84 #ifndef __attribute__
85 #define __attribute__(x)
86 #endif
87 #endif
89 /* General helper functions */
90 extern void usage(const char *err) NORETURN;
91 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
92 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
93 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
95 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
96 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
97 extern void set_error_routine(void (*routine)(const char *err, va_list params));
98 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
100 #ifdef NO_MMAP
102 #ifndef PROT_READ
103 #define PROT_READ 1
104 #define PROT_WRITE 2
105 #define MAP_PRIVATE 1
106 #define MAP_FAILED ((void*)-1)
107 #endif
109 #define mmap git_mmap
110 #define munmap git_munmap
111 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
112 extern int git_munmap(void *start, size_t length);
114 /* This value must be multiple of (pagesize * 2) */
115 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
117 #else /* NO_MMAP */
119 #include <sys/mman.h>
121 /* This value must be multiple of (pagesize * 2) */
122 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
123         (sizeof(void*) >= 8 \
124                 ?  1 * 1024 * 1024 * 1024 \
125                 : 32 * 1024 * 1024)
127 #endif /* NO_MMAP */
129 #define DEFAULT_PACKED_GIT_LIMIT \
130         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
132 #ifdef NO_PREAD
133 #define pread git_pread
134 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
135 #endif
137 #ifdef NO_SETENV
138 #define setenv gitsetenv
139 extern int gitsetenv(const char *, const char *, int);
140 #endif
142 #ifdef NO_UNSETENV
143 #define unsetenv gitunsetenv
144 extern void gitunsetenv(const char *);
145 #endif
147 #ifdef NO_STRCASESTR
148 #define strcasestr gitstrcasestr
149 extern char *gitstrcasestr(const char *haystack, const char *needle);
150 #endif
152 #ifdef NO_STRLCPY
153 #define strlcpy gitstrlcpy
154 extern size_t gitstrlcpy(char *, const char *, size_t);
155 #endif
157 #ifdef NO_STRTOUMAX
158 #define strtoumax gitstrtoumax
159 extern uintmax_t gitstrtoumax(const char *, char **, int);
160 #endif
162 extern void release_pack_memory(size_t, int);
164 static inline char* xstrdup(const char *str)
166         char *ret = strdup(str);
167         if (!ret) {
168                 release_pack_memory(strlen(str) + 1, -1);
169                 ret = strdup(str);
170                 if (!ret)
171                         die("Out of memory, strdup failed");
172         }
173         return ret;
176 static inline void *xmalloc(size_t size)
178         void *ret = malloc(size);
179         if (!ret && !size)
180                 ret = malloc(1);
181         if (!ret) {
182                 release_pack_memory(size, -1);
183                 ret = malloc(size);
184                 if (!ret && !size)
185                         ret = malloc(1);
186                 if (!ret)
187                         die("Out of memory, malloc failed");
188         }
189 #ifdef XMALLOC_POISON
190         memset(ret, 0xA5, size);
191 #endif
192         return ret;
195 static inline char *xstrndup(const char *str, size_t len)
197         char *p;
199         p = memchr(str, '\0', len);
200         if (p)
201                 len = p - str;
202         p = xmalloc(len + 1);
203         memcpy(p, str, len);
204         p[len] = '\0';
205         return p;
208 static inline void *xrealloc(void *ptr, size_t size)
210         void *ret = realloc(ptr, size);
211         if (!ret && !size)
212                 ret = realloc(ptr, 1);
213         if (!ret) {
214                 release_pack_memory(size, -1);
215                 ret = realloc(ptr, size);
216                 if (!ret && !size)
217                         ret = realloc(ptr, 1);
218                 if (!ret)
219                         die("Out of memory, realloc failed");
220         }
221         return ret;
224 static inline void *xcalloc(size_t nmemb, size_t size)
226         void *ret = calloc(nmemb, size);
227         if (!ret && (!nmemb || !size))
228                 ret = calloc(1, 1);
229         if (!ret) {
230                 release_pack_memory(nmemb * size, -1);
231                 ret = calloc(nmemb, size);
232                 if (!ret && (!nmemb || !size))
233                         ret = calloc(1, 1);
234                 if (!ret)
235                         die("Out of memory, calloc failed");
236         }
237         return ret;
240 static inline void *xmmap(void *start, size_t length,
241         int prot, int flags, int fd, off_t offset)
243         void *ret = mmap(start, length, prot, flags, fd, offset);
244         if (ret == MAP_FAILED) {
245                 if (!length)
246                         return NULL;
247                 release_pack_memory(length, fd);
248                 ret = mmap(start, length, prot, flags, fd, offset);
249                 if (ret == MAP_FAILED)
250                         die("Out of memory? mmap failed: %s", strerror(errno));
251         }
252         return ret;
255 static inline ssize_t xread(int fd, void *buf, size_t len)
257         ssize_t nr;
258         while (1) {
259                 nr = read(fd, buf, len);
260                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
261                         continue;
262                 return nr;
263         }
266 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
268         ssize_t nr;
269         while (1) {
270                 nr = write(fd, buf, len);
271                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
272                         continue;
273                 return nr;
274         }
277 static inline size_t xsize_t(off_t len)
279         return (size_t)len;
282 static inline int has_extension(const char *filename, const char *ext)
284         size_t len = strlen(filename);
285         size_t extlen = strlen(ext);
286         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
289 /* Sane ctype - no locale, and works with signed chars */
290 #undef isspace
291 #undef isdigit
292 #undef isalpha
293 #undef isalnum
294 #undef tolower
295 #undef toupper
296 extern unsigned char sane_ctype[256];
297 #define GIT_SPACE 0x01
298 #define GIT_DIGIT 0x02
299 #define GIT_ALPHA 0x04
300 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
301 #define isspace(x) sane_istest(x,GIT_SPACE)
302 #define isdigit(x) sane_istest(x,GIT_DIGIT)
303 #define isalpha(x) sane_istest(x,GIT_ALPHA)
304 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
305 #define tolower(x) sane_case((unsigned char)(x), 0x20)
306 #define toupper(x) sane_case((unsigned char)(x), 0)
308 static inline int sane_case(int x, int high)
310         if (sane_istest(x, GIT_ALPHA))
311                 x = (x & ~0x20) | high;
312         return x;
315 static inline int prefixcmp(const char *str, const char *prefix)
317         return strncmp(str, prefix, strlen(prefix));
320 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
322         unsigned long ul;
323         char *p;
325         errno = 0;
326         ul = strtoul(s, &p, base);
327         if (errno || *p || p == s || (unsigned int) ul != ul)
328                 return -1;
329         *result = ul;
330         return 0;
333 #endif