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