Link 1.5.0.1 documentation from the main page.
[debian-git.git] / git-compat-util.h
blob9863cf671f7522f73ea5a88af0d1234488c73396
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #ifndef FLEX_ARRAY
5 #if defined(__GNUC__) && (__GNUC__ < 3)
6 #define FLEX_ARRAY 0
7 #else
8 #define FLEX_ARRAY /* empty */
9 #endif
10 #endif
12 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
14 #if !defined(__APPLE__) && !defined(__FreeBSD__)
15 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
16 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
17 #endif
18 #define _ALL_SOURCE 1
19 #define _GNU_SOURCE 1
20 #define _BSD_SOURCE 1
22 #include <unistd.h>
23 #include <stdio.h>
24 #include <sys/stat.h>
25 #include <fcntl.h>
26 #include <stddef.h>
27 #include <stdlib.h>
28 #include <stdarg.h>
29 #include <string.h>
30 #include <errno.h>
31 #include <limits.h>
32 #include <sys/param.h>
33 #include <sys/types.h>
34 #include <dirent.h>
35 #include <sys/time.h>
36 #include <time.h>
37 #include <signal.h>
38 #include <sys/wait.h>
39 #include <fnmatch.h>
40 #include <sys/poll.h>
41 #include <sys/socket.h>
42 #include <assert.h>
43 #include <regex.h>
44 #include <netinet/in.h>
45 #include <netinet/tcp.h>
46 #include <arpa/inet.h>
47 #include <netdb.h>
48 #include <pwd.h>
49 #include <inttypes.h>
50 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
51 #include <grp.h>
52 #define _ALL_SOURCE 1
54 #ifndef NO_ICONV
55 #include <iconv.h>
56 #endif
58 /* On most systems <limits.h> would have given us this, but
59 * not on some systems (e.g. GNU/Hurd).
61 #ifndef PATH_MAX
62 #define PATH_MAX 4096
63 #endif
65 #ifdef __GNUC__
66 #define NORETURN __attribute__((__noreturn__))
67 #else
68 #define NORETURN
69 #ifndef __attribute__
70 #define __attribute__(x)
71 #endif
72 #endif
74 /* General helper functions */
75 extern void usage(const char *err) NORETURN;
76 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
77 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
78 extern void warn(const char *err, ...) __attribute__((format (printf, 1, 2)));
80 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
81 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
82 extern void set_error_routine(void (*routine)(const char *err, va_list params));
83 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
85 #ifdef NO_MMAP
87 #ifndef PROT_READ
88 #define PROT_READ 1
89 #define PROT_WRITE 2
90 #define MAP_PRIVATE 1
91 #define MAP_FAILED ((void*)-1)
92 #endif
94 #define mmap git_mmap
95 #define munmap git_munmap
96 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
97 extern int git_munmap(void *start, size_t length);
99 /* This value must be multiple of (pagesize * 2) */
100 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
102 #else /* NO_MMAP */
104 #include <sys/mman.h>
106 /* This value must be multiple of (pagesize * 2) */
107 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
108 (sizeof(void*) >= 8 \
109 ? 1 * 1024 * 1024 * 1024 \
110 : 32 * 1024 * 1024)
112 #endif /* NO_MMAP */
114 #define DEFAULT_PACKED_GIT_LIMIT \
115 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
117 #ifdef NO_PREAD
118 #define pread git_pread
119 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
120 #endif
122 #ifdef NO_SETENV
123 #define setenv gitsetenv
124 extern int gitsetenv(const char *, const char *, int);
125 #endif
127 #ifdef NO_UNSETENV
128 #define unsetenv gitunsetenv
129 extern void gitunsetenv(const char *);
130 #endif
132 #ifdef NO_STRCASESTR
133 #define strcasestr gitstrcasestr
134 extern char *gitstrcasestr(const char *haystack, const char *needle);
135 #endif
137 #ifdef NO_STRLCPY
138 #define strlcpy gitstrlcpy
139 extern size_t gitstrlcpy(char *, const char *, size_t);
140 #endif
142 #ifdef NO_STRTOUMAX
143 #define strtoumax gitstrtoumax
144 extern uintmax_t gitstrtoumax(const char *, char **, int);
145 #endif
147 extern void release_pack_memory(size_t);
149 static inline char* xstrdup(const char *str)
151 char *ret = strdup(str);
152 if (!ret) {
153 release_pack_memory(strlen(str) + 1);
154 ret = strdup(str);
155 if (!ret)
156 die("Out of memory, strdup failed");
158 return ret;
161 static inline void *xmalloc(size_t size)
163 void *ret = malloc(size);
164 if (!ret && !size)
165 ret = malloc(1);
166 if (!ret) {
167 release_pack_memory(size);
168 ret = malloc(size);
169 if (!ret && !size)
170 ret = malloc(1);
171 if (!ret)
172 die("Out of memory, malloc failed");
174 #ifdef XMALLOC_POISON
175 memset(ret, 0xA5, size);
176 #endif
177 return ret;
180 static inline void *xrealloc(void *ptr, size_t size)
182 void *ret = realloc(ptr, size);
183 if (!ret && !size)
184 ret = realloc(ptr, 1);
185 if (!ret) {
186 release_pack_memory(size);
187 ret = realloc(ptr, size);
188 if (!ret && !size)
189 ret = realloc(ptr, 1);
190 if (!ret)
191 die("Out of memory, realloc failed");
193 return ret;
196 static inline void *xcalloc(size_t nmemb, size_t size)
198 void *ret = calloc(nmemb, size);
199 if (!ret && (!nmemb || !size))
200 ret = calloc(1, 1);
201 if (!ret) {
202 release_pack_memory(nmemb * size);
203 ret = calloc(nmemb, size);
204 if (!ret && (!nmemb || !size))
205 ret = calloc(1, 1);
206 if (!ret)
207 die("Out of memory, calloc failed");
209 return ret;
212 static inline void *xmmap(void *start, size_t length,
213 int prot, int flags, int fd, off_t offset)
215 void *ret = mmap(start, length, prot, flags, fd, offset);
216 if (ret == MAP_FAILED) {
217 if (!length)
218 return NULL;
219 release_pack_memory(length);
220 ret = mmap(start, length, prot, flags, fd, offset);
221 if (ret == MAP_FAILED)
222 die("Out of memory? mmap failed: %s", strerror(errno));
224 return ret;
227 static inline ssize_t xread(int fd, void *buf, size_t len)
229 ssize_t nr;
230 while (1) {
231 nr = read(fd, buf, len);
232 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
233 continue;
234 return nr;
238 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
240 ssize_t nr;
241 while (1) {
242 nr = write(fd, buf, len);
243 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
244 continue;
245 return nr;
249 static inline int has_extension(const char *filename, const char *ext)
251 size_t len = strlen(filename);
252 size_t extlen = strlen(ext);
253 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
256 /* Sane ctype - no locale, and works with signed chars */
257 #undef isspace
258 #undef isdigit
259 #undef isalpha
260 #undef isalnum
261 #undef tolower
262 #undef toupper
263 extern unsigned char sane_ctype[256];
264 #define GIT_SPACE 0x01
265 #define GIT_DIGIT 0x02
266 #define GIT_ALPHA 0x04
267 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
268 #define isspace(x) sane_istest(x,GIT_SPACE)
269 #define isdigit(x) sane_istest(x,GIT_DIGIT)
270 #define isalpha(x) sane_istest(x,GIT_ALPHA)
271 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
272 #define tolower(x) sane_case((unsigned char)(x), 0x20)
273 #define toupper(x) sane_case((unsigned char)(x), 0)
275 static inline int sane_case(int x, int high)
277 if (sane_istest(x, GIT_ALPHA))
278 x = (x & ~0x20) | high;
279 return x;
282 #endif