user-manual: clean up fast-forward and dangling-objects sections
[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 warning(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, int);
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, -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, -1);
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 char *xstrndup(const char *str, size_t len)
193 {
194         char *p;
195
196         p = memchr(str, '\0', len);
197         if (p)
198                 len = p - str;
199         p = xmalloc(len + 1);
200         memcpy(p, str, len);
201         p[len] = '\0';
202         return p;
203 }
204
205 static inline void *xrealloc(void *ptr, size_t size)
206 {
207         void *ret = realloc(ptr, size);
208         if (!ret && !size)
209                 ret = realloc(ptr, 1);
210         if (!ret) {
211                 release_pack_memory(size, -1);
212                 ret = realloc(ptr, size);
213                 if (!ret && !size)
214                         ret = realloc(ptr, 1);
215                 if (!ret)
216                         die("Out of memory, realloc failed");
217         }
218         return ret;
219 }
220
221 static inline void *xcalloc(size_t nmemb, size_t size)
222 {
223         void *ret = calloc(nmemb, size);
224         if (!ret && (!nmemb || !size))
225                 ret = calloc(1, 1);
226         if (!ret) {
227                 release_pack_memory(nmemb * size, -1);
228                 ret = calloc(nmemb, size);
229                 if (!ret && (!nmemb || !size))
230                         ret = calloc(1, 1);
231                 if (!ret)
232                         die("Out of memory, calloc failed");
233         }
234         return ret;
235 }
236
237 static inline void *xmmap(void *start, size_t length,
238         int prot, int flags, int fd, off_t offset)
239 {
240         void *ret = mmap(start, length, prot, flags, fd, offset);
241         if (ret == MAP_FAILED) {
242                 if (!length)
243                         return NULL;
244                 release_pack_memory(length, fd);
245                 ret = mmap(start, length, prot, flags, fd, offset);
246                 if (ret == MAP_FAILED)
247                         die("Out of memory? mmap failed: %s", strerror(errno));
248         }
249         return ret;
250 }
251
252 static inline ssize_t xread(int fd, void *buf, size_t len)
253 {
254         ssize_t nr;
255         while (1) {
256                 nr = read(fd, buf, len);
257                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
258                         continue;
259                 return nr;
260         }
261 }
262
263 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
264 {
265         ssize_t nr;
266         while (1) {
267                 nr = write(fd, buf, len);
268                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
269                         continue;
270                 return nr;
271         }
272 }
273
274 static inline size_t xsize_t(off_t len)
275 {
276         return (size_t)len;
277 }
278
279 static inline int has_extension(const char *filename, const char *ext)
280 {
281         size_t len = strlen(filename);
282         size_t extlen = strlen(ext);
283         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
284 }
285
286 /* Sane ctype - no locale, and works with signed chars */
287 #undef isspace
288 #undef isdigit
289 #undef isalpha
290 #undef isalnum
291 #undef tolower
292 #undef toupper
293 extern unsigned char sane_ctype[256];
294 #define GIT_SPACE 0x01
295 #define GIT_DIGIT 0x02
296 #define GIT_ALPHA 0x04
297 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
298 #define isspace(x) sane_istest(x,GIT_SPACE)
299 #define isdigit(x) sane_istest(x,GIT_DIGIT)
300 #define isalpha(x) sane_istest(x,GIT_ALPHA)
301 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
302 #define tolower(x) sane_case((unsigned char)(x), 0x20)
303 #define toupper(x) sane_case((unsigned char)(x), 0)
304
305 static inline int sane_case(int x, int high)
306 {
307         if (sane_istest(x, GIT_ALPHA))
308                 x = (x & ~0x20) | high;
309         return x;
310 }
311
312 static inline int prefixcmp(const char *str, const char *prefix)
313 {
314         return strncmp(str, prefix, strlen(prefix));
315 }
316
317 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
318 {
319         unsigned long ul;
320         char *p;
321
322         errno = 0;
323         ul = strtoul(s, &p, base);
324         if (errno || *p || p == s || (unsigned int) ul != ul)
325                 return -1;
326         *result = ul;
327         return 0;
328 }
329
330 #endif