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