Add testcase for format-patch --subject-prefix (take 3)
[git/git.git] / git-compat-util.h
CommitLineData
4050c0df
JH
1#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
b97e9116
MW
4#define _FILE_OFFSET_BITS 64
5
8f1d2e6f
JH
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
b4f2a6ac
JH
14#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
15
95ca1c6c 16#if !defined(__APPLE__) && !defined(__FreeBSD__)
85023577
JH
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 */
c902c9a6 19#endif
fb952206
JR
20#define _ALL_SOURCE 1
21#define _GNU_SOURCE 1
22#define _BSD_SOURCE 1
85023577 23
4050c0df
JH
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>
4050c0df
JH
35#include <sys/types.h>
36#include <dirent.h>
85023577
JH
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>
007e2ba6 51#include <inttypes.h>
41b20017
RJ
52#if defined(__CYGWIN__)
53#undef _XOPEN_SOURCE
54#include <grp.h>
55#define _XOPEN_SOURCE 600
56#else
fb952206 57#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 58#include <grp.h>
fb952206 59#define _ALL_SOURCE 1
41b20017 60#endif
85023577
JH
61
62#ifndef NO_ICONV
63#include <iconv.h>
64#endif
4050c0df 65
d0c2449f
JH
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
c4001d92
SP
73#ifndef PRIuMAX
74#define PRIuMAX "llu"
75#endif
76
4050c0df
JH
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 */
87extern void usage(const char *err) NORETURN;
88extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
89extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 90extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 91
39a3f5ea
PB
92extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
93extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
94extern void set_error_routine(void (*routine)(const char *err, va_list params));
fa39b6b5 95extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
39a3f5ea 96
4050c0df
JH
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
d6779124
SP
106#define mmap git_mmap
107#define munmap git_munmap
108extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
109extern int git_munmap(void *start, size_t length);
4050c0df 110
5faaf246 111/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
112#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
113
4050c0df
JH
114#else /* NO_MMAP */
115
116#include <sys/mman.h>
5faaf246
JH
117
118/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
119#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
120 (sizeof(void*) >= 8 \
121 ? 1 * 1024 * 1024 * 1024 \
122 : 32 * 1024 * 1024)
4050c0df
JH
123
124#endif /* NO_MMAP */
125
22bac0ea 126#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 127 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 128
6900679c
SH
129#ifdef NO_PREAD
130#define pread git_pread
131extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
132#endif
133
4050c0df
JH
134#ifdef NO_SETENV
135#define setenv gitsetenv
136extern int gitsetenv(const char *, const char *, int);
137#endif
138
731043fd
JR
139#ifdef NO_UNSETENV
140#define unsetenv gitunsetenv
141extern void gitunsetenv(const char *);
142#endif
143
4050c0df
JH
144#ifdef NO_STRCASESTR
145#define strcasestr gitstrcasestr
146extern char *gitstrcasestr(const char *haystack, const char *needle);
147#endif
148
817151e6
PE
149#ifdef NO_STRLCPY
150#define strlcpy gitstrlcpy
151extern size_t gitstrlcpy(char *, const char *, size_t);
152#endif
153
bc6b4f52
JR
154#ifdef NO_STRTOUMAX
155#define strtoumax gitstrtoumax
156extern uintmax_t gitstrtoumax(const char *, char **, int);
157#endif
158
97bfeb34
SP
159extern void release_pack_memory(size_t);
160
9befac47
SP
161static inline char* xstrdup(const char *str)
162{
163 char *ret = strdup(str);
97bfeb34
SP
164 if (!ret) {
165 release_pack_memory(strlen(str) + 1);
166 ret = strdup(str);
167 if (!ret)
168 die("Out of memory, strdup failed");
169 }
9befac47
SP
170 return ret;
171}
172
4050c0df
JH
173static inline void *xmalloc(size_t size)
174{
175 void *ret = malloc(size);
4e7a2ecc
JH
176 if (!ret && !size)
177 ret = malloc(1);
97bfeb34
SP
178 if (!ret) {
179 release_pack_memory(size);
180 ret = malloc(size);
181 if (!ret && !size)
182 ret = malloc(1);
183 if (!ret)
184 die("Out of memory, malloc failed");
185 }
aa5481c1
JH
186#ifdef XMALLOC_POISON
187 memset(ret, 0xA5, size);
188#endif
4050c0df
JH
189 return ret;
190}
191
192static inline void *xrealloc(void *ptr, size_t size)
193{
194 void *ret = realloc(ptr, size);
4e7a2ecc
JH
195 if (!ret && !size)
196 ret = realloc(ptr, 1);
97bfeb34
SP
197 if (!ret) {
198 release_pack_memory(size);
199 ret = realloc(ptr, size);
200 if (!ret && !size)
201 ret = realloc(ptr, 1);
202 if (!ret)
203 die("Out of memory, realloc failed");
204 }
4050c0df
JH
205 return ret;
206}
207
208static inline void *xcalloc(size_t nmemb, size_t size)
209{
210 void *ret = calloc(nmemb, size);
4e7a2ecc
JH
211 if (!ret && (!nmemb || !size))
212 ret = calloc(1, 1);
97bfeb34
SP
213 if (!ret) {
214 release_pack_memory(nmemb * size);
215 ret = calloc(nmemb, size);
216 if (!ret && (!nmemb || !size))
217 ret = calloc(1, 1);
218 if (!ret)
219 die("Out of memory, calloc failed");
220 }
4050c0df
JH
221 return ret;
222}
223
c4712e45
SP
224static inline void *xmmap(void *start, size_t length,
225 int prot, int flags, int fd, off_t offset)
226{
227 void *ret = mmap(start, length, prot, flags, fd, offset);
228 if (ret == MAP_FAILED) {
9130ac1e
LT
229 if (!length)
230 return NULL;
c4712e45
SP
231 release_pack_memory(length);
232 ret = mmap(start, length, prot, flags, fd, offset);
233 if (ret == MAP_FAILED)
234 die("Out of memory? mmap failed: %s", strerror(errno));
235 }
236 return ret;
237}
238
1c15afb9
JH
239static inline ssize_t xread(int fd, void *buf, size_t len)
240{
241 ssize_t nr;
242 while (1) {
243 nr = read(fd, buf, len);
244 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
245 continue;
246 return nr;
247 }
248}
249
250static inline ssize_t xwrite(int fd, const void *buf, size_t len)
251{
252 ssize_t nr;
253 while (1) {
254 nr = write(fd, buf, len);
255 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
256 continue;
257 return nr;
258 }
259}
260
dc49cd76
SP
261static inline size_t xsize_t(off_t len)
262{
263 return (size_t)len;
264}
265
5bb1cda5 266static inline int has_extension(const char *filename, const char *ext)
83a2b841 267{
5bb1cda5
RS
268 size_t len = strlen(filename);
269 size_t extlen = strlen(ext);
83a2b841
RS
270 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
271}
272
4050c0df
JH
273/* Sane ctype - no locale, and works with signed chars */
274#undef isspace
275#undef isdigit
276#undef isalpha
277#undef isalnum
278#undef tolower
279#undef toupper
280extern unsigned char sane_ctype[256];
281#define GIT_SPACE 0x01
282#define GIT_DIGIT 0x02
283#define GIT_ALPHA 0x04
284#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
285#define isspace(x) sane_istest(x,GIT_SPACE)
286#define isdigit(x) sane_istest(x,GIT_DIGIT)
287#define isalpha(x) sane_istest(x,GIT_ALPHA)
288#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
289#define tolower(x) sane_case((unsigned char)(x), 0x20)
290#define toupper(x) sane_case((unsigned char)(x), 0)
291
292static inline int sane_case(int x, int high)
293{
294 if (sane_istest(x, GIT_ALPHA))
295 x = (x & ~0x20) | high;
296 return x;
297}
298
cff0302c
JH
299static inline int prefixcmp(const char *str, const char *prefix)
300{
301 return strncmp(str, prefix, strlen(prefix));
302}
303
4050c0df 304#endif