glossary: Add definitions for dangling and unreachable objects
[git/mingw/4msysgit/kblees.git] / git-compat-util.h
blob309240bbce15f732597198818a3c67c3e6274fe8
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
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
12 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
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
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 #include <inttypes.h>
50 #if defined(__CYGWIN__)
51 #undef _XOPEN_SOURCE
52 #include <grp.h>
53 #define _XOPEN_SOURCE 600
54 #else
55 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
56 #include <grp.h>
57 #define _ALL_SOURCE 1
58 #endif
60 #ifndef NO_ICONV
61 #include <iconv.h>
62 #endif
64 /* On most systems <limits.h> would have given us this, but
65 * not on some systems (e.g. GNU/Hurd).
67 #ifndef PATH_MAX
68 #define PATH_MAX 4096
69 #endif
71 #ifdef __GNUC__
72 #define NORETURN __attribute__((__noreturn__))
73 #else
74 #define NORETURN
75 #ifndef __attribute__
76 #define __attribute__(x)
77 #endif
78 #endif
80 /* General helper functions */
81 extern void usage(const char *err) NORETURN;
82 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
83 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
84 extern void warn(const char *err, ...) __attribute__((format (printf, 1, 2)));
86 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
87 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
88 extern void set_error_routine(void (*routine)(const char *err, va_list params));
89 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
91 #ifdef NO_MMAP
93 #ifndef PROT_READ
94 #define PROT_READ 1
95 #define PROT_WRITE 2
96 #define MAP_PRIVATE 1
97 #define MAP_FAILED ((void*)-1)
98 #endif
100 #define mmap git_mmap
101 #define munmap git_munmap
102 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
103 extern int git_munmap(void *start, size_t length);
105 /* This value must be multiple of (pagesize * 2) */
106 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
108 #else /* NO_MMAP */
110 #include <sys/mman.h>
112 /* This value must be multiple of (pagesize * 2) */
113 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
114 (sizeof(void*) >= 8 \
115 ? 1 * 1024 * 1024 * 1024 \
116 : 32 * 1024 * 1024)
118 #endif /* NO_MMAP */
120 #define DEFAULT_PACKED_GIT_LIMIT \
121 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
123 #ifdef NO_PREAD
124 #define pread git_pread
125 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
126 #endif
128 #ifdef NO_SETENV
129 #define setenv gitsetenv
130 extern int gitsetenv(const char *, const char *, int);
131 #endif
133 #ifdef NO_UNSETENV
134 #define unsetenv gitunsetenv
135 extern void gitunsetenv(const char *);
136 #endif
138 #ifdef NO_STRCASESTR
139 #define strcasestr gitstrcasestr
140 extern char *gitstrcasestr(const char *haystack, const char *needle);
141 #endif
143 #ifdef NO_STRLCPY
144 #define strlcpy gitstrlcpy
145 extern size_t gitstrlcpy(char *, const char *, size_t);
146 #endif
148 #ifdef NO_STRTOUMAX
149 #define strtoumax gitstrtoumax
150 extern uintmax_t gitstrtoumax(const char *, char **, int);
151 #endif
153 extern void release_pack_memory(size_t);
155 static inline char* xstrdup(const char *str)
157 char *ret = strdup(str);
158 if (!ret) {
159 release_pack_memory(strlen(str) + 1);
160 ret = strdup(str);
161 if (!ret)
162 die("Out of memory, strdup failed");
164 return ret;
167 static inline void *xmalloc(size_t size)
169 void *ret = malloc(size);
170 if (!ret && !size)
171 ret = malloc(1);
172 if (!ret) {
173 release_pack_memory(size);
174 ret = malloc(size);
175 if (!ret && !size)
176 ret = malloc(1);
177 if (!ret)
178 die("Out of memory, malloc failed");
180 #ifdef XMALLOC_POISON
181 memset(ret, 0xA5, size);
182 #endif
183 return ret;
186 static inline void *xrealloc(void *ptr, size_t size)
188 void *ret = realloc(ptr, size);
189 if (!ret && !size)
190 ret = realloc(ptr, 1);
191 if (!ret) {
192 release_pack_memory(size);
193 ret = realloc(ptr, size);
194 if (!ret && !size)
195 ret = realloc(ptr, 1);
196 if (!ret)
197 die("Out of memory, realloc failed");
199 return ret;
202 static inline void *xcalloc(size_t nmemb, size_t size)
204 void *ret = calloc(nmemb, size);
205 if (!ret && (!nmemb || !size))
206 ret = calloc(1, 1);
207 if (!ret) {
208 release_pack_memory(nmemb * size);
209 ret = calloc(nmemb, size);
210 if (!ret && (!nmemb || !size))
211 ret = calloc(1, 1);
212 if (!ret)
213 die("Out of memory, calloc failed");
215 return ret;
218 static inline void *xmmap(void *start, size_t length,
219 int prot, int flags, int fd, off_t offset)
221 void *ret = mmap(start, length, prot, flags, fd, offset);
222 if (ret == MAP_FAILED) {
223 if (!length)
224 return NULL;
225 release_pack_memory(length);
226 ret = mmap(start, length, prot, flags, fd, offset);
227 if (ret == MAP_FAILED)
228 die("Out of memory? mmap failed: %s", strerror(errno));
230 return ret;
233 static inline ssize_t xread(int fd, void *buf, size_t len)
235 ssize_t nr;
236 while (1) {
237 nr = read(fd, buf, len);
238 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
239 continue;
240 return nr;
244 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
246 ssize_t nr;
247 while (1) {
248 nr = write(fd, buf, len);
249 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
250 continue;
251 return nr;
255 static inline int has_extension(const char *filename, const char *ext)
257 size_t len = strlen(filename);
258 size_t extlen = strlen(ext);
259 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
262 /* Sane ctype - no locale, and works with signed chars */
263 #undef isspace
264 #undef isdigit
265 #undef isalpha
266 #undef isalnum
267 #undef tolower
268 #undef toupper
269 extern unsigned char sane_ctype[256];
270 #define GIT_SPACE 0x01
271 #define GIT_DIGIT 0x02
272 #define GIT_ALPHA 0x04
273 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
274 #define isspace(x) sane_istest(x,GIT_SPACE)
275 #define isdigit(x) sane_istest(x,GIT_DIGIT)
276 #define isalpha(x) sane_istest(x,GIT_ALPHA)
277 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
278 #define tolower(x) sane_case((unsigned char)(x), 0x20)
279 #define toupper(x) sane_case((unsigned char)(x), 0)
281 static inline int sane_case(int x, int high)
283 if (sane_istest(x, GIT_ALPHA))
284 x = (x & ~0x20) | high;
285 return x;
288 #endif