Introduce die_errno() that appends strerror(errno) to die()
[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 /*
8  * See if our compiler is known to support flexible array members.
9  */
10 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
11 # define FLEX_ARRAY /* empty */
12 #elif defined(__GNUC__)
13 # if (__GNUC__ >= 3)
14 #  define FLEX_ARRAY /* empty */
15 # else
16 #  define FLEX_ARRAY 0 /* older GNU extension */
17 # endif
18 #endif
19
20 /*
21  * Otherwise, default to safer but a bit wasteful traditional style
22  */
23 #ifndef FLEX_ARRAY
24 # define FLEX_ARRAY 1
25 #endif
26 #endif
27
28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29
30 #ifdef __GNUC__
31 #define TYPEOF(x) (__typeof__(x))
32 #else
33 #define TYPEOF(x)
34 #endif
35
36 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
37 #define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
38
39 /* Approximation of the length of the decimal representation of this type. */
40 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
41
42 #if !defined(__APPLE__) && !defined(__FreeBSD__)  && !defined(__USLC__) && !defined(_M_UNIX)
43 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
44 #ifndef __sun__
45 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
46 #endif
47 #endif
48 #define _ALL_SOURCE 1
49 #define _GNU_SOURCE 1
50 #define _BSD_SOURCE 1
51 #define _NETBSD_SOURCE 1
52
53 #include <unistd.h>
54 #include <stdio.h>
55 #include <sys/stat.h>
56 #include <fcntl.h>
57 #include <stddef.h>
58 #include <stdlib.h>
59 #include <stdarg.h>
60 #include <string.h>
61 #include <errno.h>
62 #include <limits.h>
63 #include <sys/param.h>
64 #include <sys/types.h>
65 #include <dirent.h>
66 #include <sys/time.h>
67 #include <time.h>
68 #include <signal.h>
69 #include <fnmatch.h>
70 #include <assert.h>
71 #include <regex.h>
72 #include <utime.h>
73 #ifndef __MINGW32__
74 #include <sys/wait.h>
75 #include <sys/poll.h>
76 #include <sys/socket.h>
77 #include <sys/ioctl.h>
78 #ifndef NO_SYS_SELECT_H
79 #include <sys/select.h>
80 #endif
81 #include <netinet/in.h>
82 #include <netinet/tcp.h>
83 #include <arpa/inet.h>
84 #include <netdb.h>
85 #include <pwd.h>
86 #include <inttypes.h>
87 #if defined(__CYGWIN__)
88 #undef _XOPEN_SOURCE
89 #include <grp.h>
90 #define _XOPEN_SOURCE 600
91 #include "compat/cygwin.h"
92 #else
93 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
94 #include <grp.h>
95 #define _ALL_SOURCE 1
96 #endif
97 #else   /* __MINGW32__ */
98 /* pull in Windows compatibility stuff */
99 #include "compat/mingw.h"
100 #endif  /* __MINGW32__ */
101
102 #ifndef NO_LIBGEN_H
103 #include <libgen.h>
104 #else
105 #define basename gitbasename
106 extern char *gitbasename(char *);
107 #endif
108
109 #ifndef NO_ICONV
110 #include <iconv.h>
111 #endif
112
113 #ifndef NO_OPENSSL
114 #include <openssl/ssl.h>
115 #include <openssl/err.h>
116 #endif
117
118 /* On most systems <limits.h> would have given us this, but
119  * not on some systems (e.g. GNU/Hurd).
120  */
121 #ifndef PATH_MAX
122 #define PATH_MAX 4096
123 #endif
124
125 #ifndef PRIuMAX
126 #define PRIuMAX "llu"
127 #endif
128
129 #ifndef PRIu32
130 #define PRIu32 "u"
131 #endif
132
133 #ifndef PRIx32
134 #define PRIx32 "x"
135 #endif
136
137 #ifndef PATH_SEP
138 #define PATH_SEP ':'
139 #endif
140
141 #ifndef STRIP_EXTENSION
142 #define STRIP_EXTENSION ""
143 #endif
144
145 #ifndef has_dos_drive_prefix
146 #define has_dos_drive_prefix(path) 0
147 #endif
148
149 #ifndef is_dir_sep
150 #define is_dir_sep(c) ((c) == '/')
151 #endif
152
153 #ifdef __GNUC__
154 #define NORETURN __attribute__((__noreturn__))
155 #else
156 #define NORETURN
157 #ifndef __attribute__
158 #define __attribute__(x)
159 #endif
160 #endif
161
162 /* General helper functions */
163 extern void usage(const char *err) NORETURN;
164 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
165 extern void die_errno(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
166 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
167 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
168
169 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
170
171 extern int prefixcmp(const char *str, const char *prefix);
172 extern time_t tm_to_time_t(const struct tm *tm);
173
174 static inline const char *skip_prefix(const char *str, const char *prefix)
175 {
176         size_t len = strlen(prefix);
177         return strncmp(str, prefix, len) ? NULL : str + len;
178 }
179
180 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
181
182 #ifndef PROT_READ
183 #define PROT_READ 1
184 #define PROT_WRITE 2
185 #define MAP_PRIVATE 1
186 #define MAP_FAILED ((void*)-1)
187 #endif
188
189 #define mmap git_mmap
190 #define munmap git_munmap
191 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
192 extern int git_munmap(void *start, size_t length);
193
194 #else /* NO_MMAP || USE_WIN32_MMAP */
195
196 #include <sys/mman.h>
197
198 #endif /* NO_MMAP || USE_WIN32_MMAP */
199
200 #ifdef NO_MMAP
201
202 /* This value must be multiple of (pagesize * 2) */
203 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
204
205 #else /* NO_MMAP */
206
207 /* This value must be multiple of (pagesize * 2) */
208 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
209         (sizeof(void*) >= 8 \
210                 ?  1 * 1024 * 1024 * 1024 \
211                 : 32 * 1024 * 1024)
212
213 #endif /* NO_MMAP */
214
215 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
216 #define on_disk_bytes(st) ((st).st_size)
217 #else
218 #define on_disk_bytes(st) ((st).st_blocks * 512)
219 #endif
220
221 #define DEFAULT_PACKED_GIT_LIMIT \
222         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
223
224 #ifdef NO_PREAD
225 #define pread git_pread
226 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
227 #endif
228 /*
229  * Forward decl that will remind us if its twin in cache.h changes.
230  * This function is used in compat/pread.c.  But we can't include
231  * cache.h there.
232  */
233 extern ssize_t read_in_full(int fd, void *buf, size_t count);
234
235 #ifdef NO_SETENV
236 #define setenv gitsetenv
237 extern int gitsetenv(const char *, const char *, int);
238 #endif
239
240 #ifdef NO_MKDTEMP
241 #define mkdtemp gitmkdtemp
242 extern char *gitmkdtemp(char *);
243 #endif
244
245 #ifdef NO_MKSTEMPS
246 #define mkstemps gitmkstemps
247 extern int gitmkstemps(char *, int);
248 #endif
249
250 #ifdef NO_UNSETENV
251 #define unsetenv gitunsetenv
252 extern void gitunsetenv(const char *);
253 #endif
254
255 #ifdef NO_STRCASESTR
256 #define strcasestr gitstrcasestr
257 extern char *gitstrcasestr(const char *haystack, const char *needle);
258 #endif
259
260 #ifdef NO_STRLCPY
261 #define strlcpy gitstrlcpy
262 extern size_t gitstrlcpy(char *, const char *, size_t);
263 #endif
264
265 #ifdef NO_STRTOUMAX
266 #define strtoumax gitstrtoumax
267 extern uintmax_t gitstrtoumax(const char *, char **, int);
268 #endif
269
270 #ifdef NO_HSTRERROR
271 #define hstrerror githstrerror
272 extern const char *githstrerror(int herror);
273 #endif
274
275 #ifdef NO_MEMMEM
276 #define memmem gitmemmem
277 void *gitmemmem(const void *haystack, size_t haystacklen,
278                 const void *needle, size_t needlelen);
279 #endif
280
281 #ifdef FREAD_READS_DIRECTORIES
282 #ifdef fopen
283 #undef fopen
284 #endif
285 #define fopen(a,b) git_fopen(a,b)
286 extern FILE *git_fopen(const char*, const char*);
287 #endif
288
289 #ifdef SNPRINTF_RETURNS_BOGUS
290 #define snprintf git_snprintf
291 extern int git_snprintf(char *str, size_t maxsize,
292                         const char *format, ...);
293 #define vsnprintf git_vsnprintf
294 extern int git_vsnprintf(char *str, size_t maxsize,
295                          const char *format, va_list ap);
296 #endif
297
298 #ifdef __GLIBC_PREREQ
299 #if __GLIBC_PREREQ(2, 1)
300 #define HAVE_STRCHRNUL
301 #endif
302 #endif
303
304 #ifndef HAVE_STRCHRNUL
305 #define strchrnul gitstrchrnul
306 static inline char *gitstrchrnul(const char *s, int c)
307 {
308         while (*s && *s != c)
309                 s++;
310         return (char *)s;
311 }
312 #endif
313
314 extern void release_pack_memory(size_t, int);
315
316 extern char *xstrdup(const char *str);
317 extern void *xmalloc(size_t size);
318 extern void *xmemdupz(const void *data, size_t len);
319 extern char *xstrndup(const char *str, size_t len);
320 extern void *xrealloc(void *ptr, size_t size);
321 extern void *xcalloc(size_t nmemb, size_t size);
322 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
323 extern ssize_t xread(int fd, void *buf, size_t len);
324 extern ssize_t xwrite(int fd, const void *buf, size_t len);
325 extern int xdup(int fd);
326 extern FILE *xfdopen(int fd, const char *mode);
327 extern int xmkstemp(char *template);
328 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
329 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
330
331 static inline size_t xsize_t(off_t len)
332 {
333         return (size_t)len;
334 }
335
336 static inline int has_extension(const char *filename, const char *ext)
337 {
338         size_t len = strlen(filename);
339         size_t extlen = strlen(ext);
340         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
341 }
342
343 /* Sane ctype - no locale, and works with signed chars */
344 #undef isascii
345 #undef isspace
346 #undef isdigit
347 #undef isalpha
348 #undef isalnum
349 #undef tolower
350 #undef toupper
351 extern unsigned char sane_ctype[256];
352 #define GIT_SPACE 0x01
353 #define GIT_DIGIT 0x02
354 #define GIT_ALPHA 0x04
355 #define GIT_GLOB_SPECIAL 0x08
356 #define GIT_REGEX_SPECIAL 0x10
357 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
358 #define isascii(x) (((x) & ~0x7f) == 0)
359 #define isspace(x) sane_istest(x,GIT_SPACE)
360 #define isdigit(x) sane_istest(x,GIT_DIGIT)
361 #define isalpha(x) sane_istest(x,GIT_ALPHA)
362 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
363 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
364 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
365 #define tolower(x) sane_case((unsigned char)(x), 0x20)
366 #define toupper(x) sane_case((unsigned char)(x), 0)
367
368 static inline int sane_case(int x, int high)
369 {
370         if (sane_istest(x, GIT_ALPHA))
371                 x = (x & ~0x20) | high;
372         return x;
373 }
374
375 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
376 {
377         unsigned long ul;
378         char *p;
379
380         errno = 0;
381         ul = strtoul(s, &p, base);
382         if (errno || *p || p == s || (unsigned int) ul != ul)
383                 return -1;
384         *result = ul;
385         return 0;
386 }
387
388 static inline int strtol_i(char const *s, int base, int *result)
389 {
390         long ul;
391         char *p;
392
393         errno = 0;
394         ul = strtol(s, &p, base);
395         if (errno || *p || p == s || (int) ul != ul)
396                 return -1;
397         *result = ul;
398         return 0;
399 }
400
401 #ifdef INTERNAL_QSORT
402 void git_qsort(void *base, size_t nmemb, size_t size,
403                int(*compar)(const void *, const void *));
404 #define qsort git_qsort
405 #endif
406
407 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
408 # define FORCE_DIR_SET_GID S_ISGID
409 #else
410 # define FORCE_DIR_SET_GID 0
411 #endif
412
413 #ifdef NO_NSEC
414 #undef USE_NSEC
415 #define ST_CTIME_NSEC(st) 0
416 #define ST_MTIME_NSEC(st) 0
417 #else
418 #ifdef USE_ST_TIMESPEC
419 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
420 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
421 #else
422 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
423 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
424 #endif
425 #endif
426
427 #ifdef UNRELIABLE_FSTAT
428 #define fstat_is_reliable() 0
429 #else
430 #define fstat_is_reliable() 1
431 #endif
432
433 /*
434  * Preserves errno, prints a message, but gives no warning for ENOENT.
435  * Always returns the return value of unlink(2).
436  */
437 int unlink_or_warn(const char *path);
438
439 #endif