Merge branch 'rs/grep-function-context' into next
[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) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
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 #define bitsizeof(x)  (CHAR_BIT * sizeof(x))
30
31 #define maximum_signed_value_of_type(a) \
32     (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
33
34 #define maximum_unsigned_value_of_type(a) \
35     (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
36
37 /*
38  * Signed integer overflow is undefined in C, so here's a helper macro
39  * to detect if the sum of two integers will overflow.
40  *
41  * Requires: a >= 0, typeof(a) equals typeof(b)
42  */
43 #define signed_add_overflows(a, b) \
44     ((b) > maximum_signed_value_of_type(a) - (a))
45
46 #define unsigned_add_overflows(a, b) \
47     ((b) > maximum_unsigned_value_of_type(a) - (a))
48
49 #ifdef __GNUC__
50 #define TYPEOF(x) (__typeof__(x))
51 #else
52 #define TYPEOF(x)
53 #endif
54
55 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
56 #define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
57
58 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
59
60 /* Approximation of the length of the decimal representation of this type. */
61 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
62
63 #if defined(__sun__)
64  /*
65   * On Solaris, when _XOPEN_EXTENDED is set, its header file
66   * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
67   * setting to say we are XPG5 or XPG6.  Also on Solaris,
68   * XPG6 programs must be compiled with a c99 compiler, while
69   * non XPG6 programs must be compiled with a pre-c99 compiler.
70   */
71 # if __STDC_VERSION__ - 0 >= 199901L
72 # define _XOPEN_SOURCE 600
73 # else
74 # define _XOPEN_SOURCE 500
75 # endif
76 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
77       !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__)
78 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
79 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
80 #endif
81 #define _ALL_SOURCE 1
82 #define _GNU_SOURCE 1
83 #define _BSD_SOURCE 1
84 #define _NETBSD_SOURCE 1
85 #define _SGI_SOURCE 1
86
87 #ifdef WIN32 /* Both MinGW and MSVC */
88 #define WIN32_LEAN_AND_MEAN  /* stops windows.h including winsock.h */
89 #include <winsock2.h>
90 #include <windows.h>
91 #endif
92
93 #include <unistd.h>
94 #include <stdio.h>
95 #include <sys/stat.h>
96 #include <fcntl.h>
97 #include <stddef.h>
98 #include <stdlib.h>
99 #include <stdarg.h>
100 #include <string.h>
101 #include <errno.h>
102 #include <limits.h>
103 #include <sys/param.h>
104 #include <sys/types.h>
105 #include <dirent.h>
106 #include <sys/time.h>
107 #include <time.h>
108 #include <signal.h>
109 #include <fnmatch.h>
110 #include <assert.h>
111 #include <regex.h>
112 #include <utime.h>
113 #include <syslog.h>
114 #ifndef NO_SYS_POLL_H
115 #include <sys/poll.h>
116 #else
117 #include <poll.h>
118 #endif
119 #ifndef __MINGW32__
120 #include <sys/wait.h>
121 #include <sys/resource.h>
122 #include <sys/socket.h>
123 #include <sys/ioctl.h>
124 #include <termios.h>
125 #ifndef NO_SYS_SELECT_H
126 #include <sys/select.h>
127 #endif
128 #include <netinet/in.h>
129 #include <netinet/tcp.h>
130 #include <arpa/inet.h>
131 #include <netdb.h>
132 #include <pwd.h>
133 #include <sys/un.h>
134 #ifndef NO_INTTYPES_H
135 #include <inttypes.h>
136 #else
137 #include <stdint.h>
138 #endif
139 #if defined(__CYGWIN__)
140 #undef _XOPEN_SOURCE
141 #include <grp.h>
142 #define _XOPEN_SOURCE 600
143 #include "compat/cygwin.h"
144 #else
145 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
146 #include <grp.h>
147 #define _ALL_SOURCE 1
148 #endif
149 #else   /* __MINGW32__ */
150 /* pull in Windows compatibility stuff */
151 #include "compat/mingw.h"
152 #endif  /* __MINGW32__ */
153 #ifdef _MSC_VER
154 #include "compat/msvc.h"
155 #endif
156
157 #ifndef NO_LIBGEN_H
158 #include <libgen.h>
159 #else
160 #define basename gitbasename
161 extern char *gitbasename(char *);
162 #endif
163
164 #ifndef NO_ICONV
165 #include <iconv.h>
166 #endif
167
168 #ifndef NO_OPENSSL
169 #include <openssl/ssl.h>
170 #include <openssl/err.h>
171 #endif
172
173 /* On most systems <limits.h> would have given us this, but
174  * not on some systems (e.g. GNU/Hurd).
175  */
176 #ifndef PATH_MAX
177 #define PATH_MAX 4096
178 #endif
179
180 #ifndef PRIuMAX
181 #define PRIuMAX "llu"
182 #endif
183
184 #ifndef PRIu32
185 #define PRIu32 "u"
186 #endif
187
188 #ifndef PRIx32
189 #define PRIx32 "x"
190 #endif
191
192 #ifndef PRIo32
193 #define PRIo32 "o"
194 #endif
195
196 #ifndef PATH_SEP
197 #define PATH_SEP ':'
198 #endif
199
200 #ifdef HAVE_PATHS_H
201 #include <paths.h>
202 #endif
203 #ifndef _PATH_DEFPATH
204 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
205 #endif
206
207 #ifndef STRIP_EXTENSION
208 #define STRIP_EXTENSION ""
209 #endif
210
211 #ifndef has_dos_drive_prefix
212 #define has_dos_drive_prefix(path) 0
213 #endif
214
215 #ifndef is_dir_sep
216 #define is_dir_sep(c) ((c) == '/')
217 #endif
218
219 #ifndef find_last_dir_sep
220 #define find_last_dir_sep(path) strrchr(path, '/')
221 #endif
222
223 #if __HP_cc >= 61000
224 #define NORETURN __attribute__((noreturn))
225 #define NORETURN_PTR
226 #elif defined(__GNUC__) && !defined(NO_NORETURN)
227 #define NORETURN __attribute__((__noreturn__))
228 #define NORETURN_PTR __attribute__((__noreturn__))
229 #elif defined(_MSC_VER)
230 #define NORETURN __declspec(noreturn)
231 #define NORETURN_PTR
232 #else
233 #define NORETURN
234 #define NORETURN_PTR
235 #ifndef __attribute__
236 #define __attribute__(x)
237 #endif
238 #endif
239
240 #include "compat/bswap.h"
241
242 /* General helper functions */
243 extern void vreportf(const char *prefix, const char *err, va_list params);
244 extern NORETURN void usage(const char *err);
245 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
246 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
247 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
248 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
249 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
250
251 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
252
253 extern int prefixcmp(const char *str, const char *prefix);
254 extern int suffixcmp(const char *str, const char *suffix);
255
256 static inline const char *skip_prefix(const char *str, const char *prefix)
257 {
258         size_t len = strlen(prefix);
259         return strncmp(str, prefix, len) ? NULL : str + len;
260 }
261
262 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
263
264 #ifndef PROT_READ
265 #define PROT_READ 1
266 #define PROT_WRITE 2
267 #define MAP_PRIVATE 1
268 #endif
269
270 #define mmap git_mmap
271 #define munmap git_munmap
272 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
273 extern int git_munmap(void *start, size_t length);
274
275 #else /* NO_MMAP || USE_WIN32_MMAP */
276
277 #include <sys/mman.h>
278
279 #endif /* NO_MMAP || USE_WIN32_MMAP */
280
281 #ifdef NO_MMAP
282
283 /* This value must be multiple of (pagesize * 2) */
284 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
285
286 #else /* NO_MMAP */
287
288 /* This value must be multiple of (pagesize * 2) */
289 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
290         (sizeof(void*) >= 8 \
291                 ?  1 * 1024 * 1024 * 1024 \
292                 : 32 * 1024 * 1024)
293
294 #endif /* NO_MMAP */
295
296 #ifndef MAP_FAILED
297 #define MAP_FAILED ((void *)-1)
298 #endif
299
300 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
301 #define on_disk_bytes(st) ((st).st_size)
302 #else
303 #define on_disk_bytes(st) ((st).st_blocks * 512)
304 #endif
305
306 #define DEFAULT_PACKED_GIT_LIMIT \
307         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
308
309 #ifdef NO_PREAD
310 #define pread git_pread
311 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
312 #endif
313 /*
314  * Forward decl that will remind us if its twin in cache.h changes.
315  * This function is used in compat/pread.c.  But we can't include
316  * cache.h there.
317  */
318 extern ssize_t read_in_full(int fd, void *buf, size_t count);
319
320 #ifdef NO_SETENV
321 #define setenv gitsetenv
322 extern int gitsetenv(const char *, const char *, int);
323 #endif
324
325 #ifdef NO_MKDTEMP
326 #define mkdtemp gitmkdtemp
327 extern char *gitmkdtemp(char *);
328 #endif
329
330 #ifdef NO_MKSTEMPS
331 #define mkstemps gitmkstemps
332 extern int gitmkstemps(char *, int);
333 #endif
334
335 #ifdef NO_UNSETENV
336 #define unsetenv gitunsetenv
337 extern void gitunsetenv(const char *);
338 #endif
339
340 #ifdef NO_STRCASESTR
341 #define strcasestr gitstrcasestr
342 extern char *gitstrcasestr(const char *haystack, const char *needle);
343 #endif
344
345 #ifdef NO_STRLCPY
346 #define strlcpy gitstrlcpy
347 extern size_t gitstrlcpy(char *, const char *, size_t);
348 #endif
349
350 #ifdef NO_STRTOUMAX
351 #define strtoumax gitstrtoumax
352 extern uintmax_t gitstrtoumax(const char *, char **, int);
353 #endif
354
355 #ifdef NO_STRTOK_R
356 #define strtok_r gitstrtok_r
357 extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
358 #endif
359
360 #ifdef NO_HSTRERROR
361 #define hstrerror githstrerror
362 extern const char *githstrerror(int herror);
363 #endif
364
365 #ifdef NO_MEMMEM
366 #define memmem gitmemmem
367 void *gitmemmem(const void *haystack, size_t haystacklen,
368                 const void *needle, size_t needlelen);
369 #endif
370
371 #ifdef FREAD_READS_DIRECTORIES
372 #ifdef fopen
373 #undef fopen
374 #endif
375 #define fopen(a,b) git_fopen(a,b)
376 extern FILE *git_fopen(const char*, const char*);
377 #endif
378
379 #ifdef SNPRINTF_RETURNS_BOGUS
380 #define snprintf git_snprintf
381 extern int git_snprintf(char *str, size_t maxsize,
382                         const char *format, ...);
383 #define vsnprintf git_vsnprintf
384 extern int git_vsnprintf(char *str, size_t maxsize,
385                          const char *format, va_list ap);
386 #endif
387
388 #ifdef __GLIBC_PREREQ
389 #if __GLIBC_PREREQ(2, 1)
390 #define HAVE_STRCHRNUL
391 #define HAVE_MEMPCPY
392 #endif
393 #endif
394
395 #ifndef HAVE_STRCHRNUL
396 #define strchrnul gitstrchrnul
397 static inline char *gitstrchrnul(const char *s, int c)
398 {
399         while (*s && *s != c)
400                 s++;
401         return (char *)s;
402 }
403 #endif
404
405 #ifndef HAVE_MEMPCPY
406 #define mempcpy gitmempcpy
407 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
408 {
409         return (char *)memcpy(dest, src, n) + n;
410 }
411 #endif
412
413 #ifdef NO_INET_PTON
414 int inet_pton(int af, const char *src, void *dst);
415 #endif
416
417 #ifdef NO_INET_NTOP
418 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
419 #endif
420
421 extern void release_pack_memory(size_t, int);
422
423 typedef void (*try_to_free_t)(size_t);
424 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
425
426 extern char *xstrdup(const char *str);
427 extern void *xmalloc(size_t size);
428 extern void *xmallocz(size_t size);
429 extern void *xmemdupz(const void *data, size_t len);
430 extern char *xstrndup(const char *str, size_t len);
431 extern void *xrealloc(void *ptr, size_t size);
432 extern void *xcalloc(size_t nmemb, size_t size);
433 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
434 extern ssize_t xread(int fd, void *buf, size_t len);
435 extern ssize_t xwrite(int fd, const void *buf, size_t len);
436 extern int xdup(int fd);
437 extern FILE *xfdopen(int fd, const char *mode);
438 extern int xmkstemp(char *template);
439 extern int xmkstemp_mode(char *template, int mode);
440 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
441 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
442
443 static inline size_t xsize_t(off_t len)
444 {
445         if (len > (size_t) len)
446                 die("Cannot handle files this big");
447         return (size_t)len;
448 }
449
450 static inline int has_extension(const char *filename, const char *ext)
451 {
452         size_t len = strlen(filename);
453         size_t extlen = strlen(ext);
454         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
455 }
456
457 /* Sane ctype - no locale, and works with signed chars */
458 #undef isascii
459 #undef isspace
460 #undef isdigit
461 #undef isalpha
462 #undef isalnum
463 #undef tolower
464 #undef toupper
465 extern unsigned char sane_ctype[256];
466 #define GIT_SPACE 0x01
467 #define GIT_DIGIT 0x02
468 #define GIT_ALPHA 0x04
469 #define GIT_GLOB_SPECIAL 0x08
470 #define GIT_REGEX_SPECIAL 0x10
471 #define GIT_PATHSPEC_MAGIC 0x20
472 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
473 #define isascii(x) (((x) & ~0x7f) == 0)
474 #define isspace(x) sane_istest(x,GIT_SPACE)
475 #define isdigit(x) sane_istest(x,GIT_DIGIT)
476 #define isalpha(x) sane_istest(x,GIT_ALPHA)
477 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
478 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
479 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
480 #define tolower(x) sane_case((unsigned char)(x), 0x20)
481 #define toupper(x) sane_case((unsigned char)(x), 0)
482 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
483
484 static inline int sane_case(int x, int high)
485 {
486         if (sane_istest(x, GIT_ALPHA))
487                 x = (x & ~0x20) | high;
488         return x;
489 }
490
491 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
492 {
493         unsigned long ul;
494         char *p;
495
496         errno = 0;
497         ul = strtoul(s, &p, base);
498         if (errno || *p || p == s || (unsigned int) ul != ul)
499                 return -1;
500         *result = ul;
501         return 0;
502 }
503
504 static inline int strtol_i(char const *s, int base, int *result)
505 {
506         long ul;
507         char *p;
508
509         errno = 0;
510         ul = strtol(s, &p, base);
511         if (errno || *p || p == s || (int) ul != ul)
512                 return -1;
513         *result = ul;
514         return 0;
515 }
516
517 #ifdef INTERNAL_QSORT
518 void git_qsort(void *base, size_t nmemb, size_t size,
519                int(*compar)(const void *, const void *));
520 #define qsort git_qsort
521 #endif
522
523 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
524 # define FORCE_DIR_SET_GID S_ISGID
525 #else
526 # define FORCE_DIR_SET_GID 0
527 #endif
528
529 #ifdef NO_NSEC
530 #undef USE_NSEC
531 #define ST_CTIME_NSEC(st) 0
532 #define ST_MTIME_NSEC(st) 0
533 #else
534 #ifdef USE_ST_TIMESPEC
535 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
536 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
537 #else
538 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
539 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
540 #endif
541 #endif
542
543 #ifdef UNRELIABLE_FSTAT
544 #define fstat_is_reliable() 0
545 #else
546 #define fstat_is_reliable() 1
547 #endif
548
549 #ifndef va_copy
550 /*
551  * Since an obvious implementation of va_list would be to make it a
552  * pointer into the stack frame, a simple assignment will work on
553  * many systems.  But let's try to be more portable.
554  */
555 #ifdef __va_copy
556 #define va_copy(dst, src) __va_copy(dst, src)
557 #else
558 #define va_copy(dst, src) ((dst) = (src))
559 #endif
560 #endif
561
562 /*
563  * Preserves errno, prints a message, but gives no warning for ENOENT.
564  * Always returns the return value of unlink(2).
565  */
566 int unlink_or_warn(const char *path);
567 /*
568  * Likewise for rmdir(2).
569  */
570 int rmdir_or_warn(const char *path);
571 /*
572  * Calls the correct function out of {unlink,rmdir}_or_warn based on
573  * the supplied file mode.
574  */
575 int remove_or_warn(unsigned int mode, const char *path);
576
577 #endif