Use off_t when we really mean a file offset.
[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 #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
23
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 #if defined(__CYGWIN__)
53 #undef _XOPEN_SOURCE
54 #include <grp.h>
55 #define _XOPEN_SOURCE 600
56 #else
57 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
58 #include <grp.h>
59 #define _ALL_SOURCE 1
60 #endif
61
62 #ifndef NO_ICONV
63 #include <iconv.h>
64 #endif
65
66 /* On most systems <limits.h> would have given us this, but
67 * not on some systems (e.g. GNU/Hurd).
68 */
69 #ifndef PATH_MAX
70 #define PATH_MAX 4096
71 #endif
72
73 #ifndef PRIuMAX
74 #define PRIuMAX "llu"
75 #endif
76
77 #ifdef __GNUC__
78 #define NORETURN __attribute__((__noreturn__))
79 #else
80 #define NORETURN
81 #ifndef __attribute__
82 #define __attribute__(x)
83 #endif
84 #endif
85
86 /* General helper functions */
87 extern void usage(const char *err) NORETURN;
88 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
89 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
90 extern void warn(const char *err, ...) __attribute__((format (printf, 1, 2)));
91
92 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
93 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
94 extern void set_error_routine(void (*routine)(const char *err, va_list params));
95 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
96
97 #ifdef NO_MMAP
98
99 #ifndef PROT_READ
100 #define PROT_READ 1
101 #define PROT_WRITE 2
102 #define MAP_PRIVATE 1
103 #define MAP_FAILED ((void*)-1)
104 #endif
105
106 #define mmap git_mmap
107 #define munmap git_munmap
108 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
109 extern int git_munmap(void *start, size_t length);
110
111 /* This value must be multiple of (pagesize * 2) */
112 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
113
114 #else /* NO_MMAP */
115
116 #include <sys/mman.h>
117
118 /* This value must be multiple of (pagesize * 2) */
119 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
120 (sizeof(void*) >= 8 \
121 ? 1 * 1024 * 1024 * 1024 \
122 : 32 * 1024 * 1024)
123
124 #endif /* NO_MMAP */
125
126 #define DEFAULT_PACKED_GIT_LIMIT \
127 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
128
129 #ifdef NO_PREAD
130 #define pread git_pread
131 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
132 #endif
133
134 #ifdef NO_SETENV
135 #define setenv gitsetenv
136 extern int gitsetenv(const char *, const char *, int);
137 #endif
138
139 #ifdef NO_UNSETENV
140 #define unsetenv gitunsetenv
141 extern void gitunsetenv(const char *);
142 #endif
143
144 #ifdef NO_STRCASESTR
145 #define strcasestr gitstrcasestr
146 extern char *gitstrcasestr(const char *haystack, const char *needle);
147 #endif
148
149 #ifdef NO_STRLCPY
150 #define strlcpy gitstrlcpy
151 extern size_t gitstrlcpy(char *, const char *, size_t);
152 #endif
153
154 #ifdef NO_STRTOUMAX
155 #define strtoumax gitstrtoumax
156 extern uintmax_t gitstrtoumax(const char *, char **, int);
157 #endif
158
159 extern void release_pack_memory(size_t);
160
161 static inline char* xstrdup(const char *str)
162 {
163 char *ret = strdup(str);
164 if (!ret) {
165 release_pack_memory(strlen(str) + 1);
166 ret = strdup(str);
167 if (!ret)
168 die("Out of memory, strdup failed");
169 }
170 return ret;
171 }
172
173 static inline void *xmalloc(size_t size)
174 {
175 void *ret = malloc(size);
176 if (!ret && !size)
177 ret = malloc(1);
178 if (!ret) {
179 release_pack_memory(size);
180 ret = malloc(size);
181 if (!ret && !size)
182 ret = malloc(1);
183 if (!ret)
184 die("Out of memory, malloc failed");
185 }
186 #ifdef XMALLOC_POISON
187 memset(ret, 0xA5, size);
188 #endif
189 return ret;
190 }
191
192 static inline void *xrealloc(void *ptr, size_t size)
193 {
194 void *ret = realloc(ptr, size);
195 if (!ret && !size)
196 ret = realloc(ptr, 1);
197 if (!ret) {
198 release_pack_memory(size);
199 ret = realloc(ptr, size);
200 if (!ret && !size)
201 ret = realloc(ptr, 1);
202 if (!ret)
203 die("Out of memory, realloc failed");
204 }
205 return ret;
206 }
207
208 static inline void *xcalloc(size_t nmemb, size_t size)
209 {
210 void *ret = calloc(nmemb, size);
211 if (!ret && (!nmemb || !size))
212 ret = calloc(1, 1);
213 if (!ret) {
214 release_pack_memory(nmemb * size);
215 ret = calloc(nmemb, size);
216 if (!ret && (!nmemb || !size))
217 ret = calloc(1, 1);
218 if (!ret)
219 die("Out of memory, calloc failed");
220 }
221 return ret;
222 }
223
224 static inline void *xmmap(void *start, size_t length,
225 int prot, int flags, int fd, off_t offset)
226 {
227 void *ret = mmap(start, length, prot, flags, fd, offset);
228 if (ret == MAP_FAILED) {
229 if (!length)
230 return NULL;
231 release_pack_memory(length);
232 ret = mmap(start, length, prot, flags, fd, offset);
233 if (ret == MAP_FAILED)
234 die("Out of memory? mmap failed: %s", strerror(errno));
235 }
236 return ret;
237 }
238
239 static inline ssize_t xread(int fd, void *buf, size_t len)
240 {
241 ssize_t nr;
242 while (1) {
243 nr = read(fd, buf, len);
244 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
245 continue;
246 return nr;
247 }
248 }
249
250 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
251 {
252 ssize_t nr;
253 while (1) {
254 nr = write(fd, buf, len);
255 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
256 continue;
257 return nr;
258 }
259 }
260
261 static inline int has_extension(const char *filename, const char *ext)
262 {
263 size_t len = strlen(filename);
264 size_t extlen = strlen(ext);
265 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
266 }
267
268 /* Sane ctype - no locale, and works with signed chars */
269 #undef isspace
270 #undef isdigit
271 #undef isalpha
272 #undef isalnum
273 #undef tolower
274 #undef toupper
275 extern unsigned char sane_ctype[256];
276 #define GIT_SPACE 0x01
277 #define GIT_DIGIT 0x02
278 #define GIT_ALPHA 0x04
279 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
280 #define isspace(x) sane_istest(x,GIT_SPACE)
281 #define isdigit(x) sane_istest(x,GIT_DIGIT)
282 #define isalpha(x) sane_istest(x,GIT_ALPHA)
283 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
284 #define tolower(x) sane_case((unsigned char)(x), 0x20)
285 #define toupper(x) sane_case((unsigned char)(x), 0)
286
287 static inline int sane_case(int x, int high)
288 {
289 if (sane_istest(x, GIT_ALPHA))
290 x = (x & ~0x20) | high;
291 return x;
292 }
293
294 static inline int prefixcmp(const char *str, const char *prefix)
295 {
296 return strncmp(str, prefix, strlen(prefix));
297 }
298
299 #endif