f8d46d587bec2b4dbab0263fa3df97e60beb08e4
[git/git.git] / git-compat-util.h
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
3
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
11
12 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
13
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 _GNU_SOURCE
19 #define _BSD_SOURCE
20
21 #include <unistd.h>
22 #include <stdio.h>
23 #include <sys/stat.h>
24 #include <fcntl.h>
25 #include <stddef.h>
26 #include <stdlib.h>
27 #include <stdarg.h>
28 #include <string.h>
29 #include <errno.h>
30 #include <limits.h>
31 #include <sys/param.h>
32 #include <sys/types.h>
33 #include <dirent.h>
34 #include <sys/time.h>
35 #include <time.h>
36 #include <signal.h>
37 #include <sys/wait.h>
38 #include <fnmatch.h>
39 #include <sys/poll.h>
40 #include <sys/socket.h>
41 #include <assert.h>
42 #include <regex.h>
43 #include <netinet/in.h>
44 #include <netinet/tcp.h>
45 #include <arpa/inet.h>
46 #include <netdb.h>
47 #include <pwd.h>
48 #include <grp.h>
49
50 #ifndef NO_ICONV
51 #include <iconv.h>
52 #endif
53
54 /* On most systems <limits.h> would have given us this, but
55 * not on some systems (e.g. GNU/Hurd).
56 */
57 #ifndef PATH_MAX
58 #define PATH_MAX 4096
59 #endif
60
61 #ifdef __GNUC__
62 #define NORETURN __attribute__((__noreturn__))
63 #else
64 #define NORETURN
65 #ifndef __attribute__
66 #define __attribute__(x)
67 #endif
68 #endif
69
70 /* General helper functions */
71 extern void usage(const char *err) NORETURN;
72 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
73 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
74 extern void warn(const char *err, ...) __attribute__((format (printf, 1, 2)));
75
76 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
77 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
78 extern void set_error_routine(void (*routine)(const char *err, va_list params));
79 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
80
81 #ifdef NO_MMAP
82
83 #ifndef PROT_READ
84 #define PROT_READ 1
85 #define PROT_WRITE 2
86 #define MAP_PRIVATE 1
87 #define MAP_FAILED ((void*)-1)
88 #endif
89
90 #define mmap git_mmap
91 #define munmap git_munmap
92 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
93 extern int git_munmap(void *start, size_t length);
94
95 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
96
97 #else /* NO_MMAP */
98
99 #include <sys/mman.h>
100 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
101 (sizeof(void*) >= 8 \
102 ? 1 * 1024 * 1024 * 1024 \
103 : 32 * 1024 * 1024)
104
105 #endif /* NO_MMAP */
106
107 #define DEFAULT_PACKED_GIT_LIMIT \
108 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
109
110 #ifdef NO_PREAD
111 #define pread git_pread
112 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
113 #endif
114
115 #ifdef NO_SETENV
116 #define setenv gitsetenv
117 extern int gitsetenv(const char *, const char *, int);
118 #endif
119
120 #ifdef NO_UNSETENV
121 #define unsetenv gitunsetenv
122 extern void gitunsetenv(const char *);
123 #endif
124
125 #ifdef NO_STRCASESTR
126 #define strcasestr gitstrcasestr
127 extern char *gitstrcasestr(const char *haystack, const char *needle);
128 #endif
129
130 #ifdef NO_STRLCPY
131 #define strlcpy gitstrlcpy
132 extern size_t gitstrlcpy(char *, const char *, size_t);
133 #endif
134
135 extern void release_pack_memory(size_t);
136
137 static inline char* xstrdup(const char *str)
138 {
139 char *ret = strdup(str);
140 if (!ret) {
141 release_pack_memory(strlen(str) + 1);
142 ret = strdup(str);
143 if (!ret)
144 die("Out of memory, strdup failed");
145 }
146 return ret;
147 }
148
149 static inline void *xmalloc(size_t size)
150 {
151 void *ret = malloc(size);
152 if (!ret && !size)
153 ret = malloc(1);
154 if (!ret) {
155 release_pack_memory(size);
156 ret = malloc(size);
157 if (!ret && !size)
158 ret = malloc(1);
159 if (!ret)
160 die("Out of memory, malloc failed");
161 }
162 #ifdef XMALLOC_POISON
163 memset(ret, 0xA5, size);
164 #endif
165 return ret;
166 }
167
168 static inline void *xrealloc(void *ptr, size_t size)
169 {
170 void *ret = realloc(ptr, size);
171 if (!ret && !size)
172 ret = realloc(ptr, 1);
173 if (!ret) {
174 release_pack_memory(size);
175 ret = realloc(ptr, size);
176 if (!ret && !size)
177 ret = realloc(ptr, 1);
178 if (!ret)
179 die("Out of memory, realloc failed");
180 }
181 return ret;
182 }
183
184 static inline void *xcalloc(size_t nmemb, size_t size)
185 {
186 void *ret = calloc(nmemb, size);
187 if (!ret && (!nmemb || !size))
188 ret = calloc(1, 1);
189 if (!ret) {
190 release_pack_memory(nmemb * size);
191 ret = calloc(nmemb, size);
192 if (!ret && (!nmemb || !size))
193 ret = calloc(1, 1);
194 if (!ret)
195 die("Out of memory, calloc failed");
196 }
197 return ret;
198 }
199
200 static inline void *xmmap(void *start, size_t length,
201 int prot, int flags, int fd, off_t offset)
202 {
203 void *ret = mmap(start, length, prot, flags, fd, offset);
204 if (ret == MAP_FAILED) {
205 release_pack_memory(length);
206 ret = mmap(start, length, prot, flags, fd, offset);
207 if (ret == MAP_FAILED)
208 die("Out of memory? mmap failed: %s", strerror(errno));
209 }
210 return ret;
211 }
212
213 static inline ssize_t xread(int fd, void *buf, size_t len)
214 {
215 ssize_t nr;
216 while (1) {
217 nr = read(fd, buf, len);
218 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
219 continue;
220 return nr;
221 }
222 }
223
224 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
225 {
226 ssize_t nr;
227 while (1) {
228 nr = write(fd, buf, len);
229 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
230 continue;
231 return nr;
232 }
233 }
234
235 static inline int has_extension(const char *filename, const char *ext)
236 {
237 size_t len = strlen(filename);
238 size_t extlen = strlen(ext);
239 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
240 }
241
242 /* Sane ctype - no locale, and works with signed chars */
243 #undef isspace
244 #undef isdigit
245 #undef isalpha
246 #undef isalnum
247 #undef tolower
248 #undef toupper
249 extern unsigned char sane_ctype[256];
250 #define GIT_SPACE 0x01
251 #define GIT_DIGIT 0x02
252 #define GIT_ALPHA 0x04
253 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
254 #define isspace(x) sane_istest(x,GIT_SPACE)
255 #define isdigit(x) sane_istest(x,GIT_DIGIT)
256 #define isalpha(x) sane_istest(x,GIT_ALPHA)
257 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
258 #define tolower(x) sane_case((unsigned char)(x), 0x20)
259 #define toupper(x) sane_case((unsigned char)(x), 0)
260
261 static inline int sane_case(int x, int high)
262 {
263 if (sane_istest(x, GIT_ALPHA))
264 x = (x & ~0x20) | high;
265 return x;
266 }
267
268 #endif