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