Merge branch 'jn/warn-on-inaccessible-loosen'
[git/git.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 !defined(__TANDEM) && !defined(__QNX__)
79 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
80 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
81 #endif
82 #define _ALL_SOURCE 1
83 #define _GNU_SOURCE 1
84 #define _BSD_SOURCE 1
85 #define _NETBSD_SOURCE 1
86 #define _SGI_SOURCE 1
87
88 #ifdef WIN32 /* Both MinGW and MSVC */
89 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
90 #include <winsock2.h>
91 #include <windows.h>
92 #endif
93
94 #include <unistd.h>
95 #include <stdio.h>
96 #include <sys/stat.h>
97 #include <fcntl.h>
98 #include <stddef.h>
99 #include <stdlib.h>
100 #include <stdarg.h>
101 #include <string.h>
102 #ifdef HAVE_STRINGS_H
103 #include <strings.h> /* for strcasecmp() */
104 #endif
105 #include <errno.h>
106 #include <limits.h>
107 #ifdef NEEDS_SYS_PARAM_H
108 #include <sys/param.h>
109 #endif
110 #include <sys/types.h>
111 #include <dirent.h>
112 #include <sys/time.h>
113 #include <time.h>
114 #include <signal.h>
115 #include <fnmatch.h>
116 #include <assert.h>
117 #include <regex.h>
118 #include <utime.h>
119 #include <syslog.h>
120 #ifndef NO_SYS_POLL_H
121 #include <sys/poll.h>
122 #else
123 #include <poll.h>
124 #endif
125 #if defined(__MINGW32__)
126 /* pull in Windows compatibility stuff */
127 #include "compat/mingw.h"
128 #elif defined(_MSC_VER)
129 #include "compat/msvc.h"
130 #else
131 #include <sys/wait.h>
132 #include <sys/resource.h>
133 #include <sys/socket.h>
134 #include <sys/ioctl.h>
135 #include <termios.h>
136 #ifndef NO_SYS_SELECT_H
137 #include <sys/select.h>
138 #endif
139 #include <netinet/in.h>
140 #include <netinet/tcp.h>
141 #include <arpa/inet.h>
142 #include <netdb.h>
143 #include <pwd.h>
144 #include <sys/un.h>
145 #ifndef NO_INTTYPES_H
146 #include <inttypes.h>
147 #else
148 #include <stdint.h>
149 #endif
150 #ifdef NO_INTPTR_T
151 /*
152 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
153 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
154 * while on IP16 and IP16L32 it is "int" (resp. "short")
155 * Size needs to match (or exceed) 'sizeof(void *)'.
156 * We can't take "long long" here as not everybody has it.
157 */
158 typedef long intptr_t;
159 typedef unsigned long uintptr_t;
160 #endif
161 #if defined(__CYGWIN__)
162 #undef _XOPEN_SOURCE
163 #include <grp.h>
164 #define _XOPEN_SOURCE 600
165 #include "compat/cygwin.h"
166 #else
167 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
168 #include <grp.h>
169 #define _ALL_SOURCE 1
170 #endif
171 #endif
172
173 /* used on Mac OS X */
174 #ifdef PRECOMPOSE_UNICODE
175 #include "compat/precompose_utf8.h"
176 #else
177 #define precompose_str(in,i_nfd2nfc)
178 #define precompose_argv(c,v)
179 #define probe_utf8_pathname_composition(a,b)
180 #endif
181
182 #ifdef MKDIR_WO_TRAILING_SLASH
183 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
184 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
185 #endif
186
187 #ifdef NO_STRUCT_ITIMERVAL
188 struct itimerval {
189 struct timeval it_interval;
190 struct timeval it_value;
191 }
192 #endif
193
194 #ifdef NO_SETITIMER
195 #define setitimer(which,value,ovalue)
196 #endif
197
198 #ifndef NO_LIBGEN_H
199 #include <libgen.h>
200 #else
201 #define basename gitbasename
202 extern char *gitbasename(char *);
203 #endif
204
205 #ifndef NO_ICONV
206 #include <iconv.h>
207 #endif
208
209 #ifndef NO_OPENSSL
210 #include <openssl/ssl.h>
211 #include <openssl/err.h>
212 #endif
213
214 /* On most systems <limits.h> would have given us this, but
215 * not on some systems (e.g. GNU/Hurd).
216 */
217 #ifndef PATH_MAX
218 #define PATH_MAX 4096
219 #endif
220
221 #ifndef PRIuMAX
222 #define PRIuMAX "llu"
223 #endif
224
225 #ifndef PRIu32
226 #define PRIu32 "u"
227 #endif
228
229 #ifndef PRIx32
230 #define PRIx32 "x"
231 #endif
232
233 #ifndef PRIo32
234 #define PRIo32 "o"
235 #endif
236
237 #ifndef PATH_SEP
238 #define PATH_SEP ':'
239 #endif
240
241 #ifdef HAVE_PATHS_H
242 #include <paths.h>
243 #endif
244 #ifndef _PATH_DEFPATH
245 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
246 #endif
247
248 #ifndef STRIP_EXTENSION
249 #define STRIP_EXTENSION ""
250 #endif
251
252 #ifndef has_dos_drive_prefix
253 #define has_dos_drive_prefix(path) 0
254 #endif
255
256 #ifndef is_dir_sep
257 #define is_dir_sep(c) ((c) == '/')
258 #endif
259
260 #ifndef find_last_dir_sep
261 #define find_last_dir_sep(path) strrchr(path, '/')
262 #endif
263
264 #if defined(__HP_cc) && (__HP_cc >= 61000)
265 #define NORETURN __attribute__((noreturn))
266 #define NORETURN_PTR
267 #elif defined(__GNUC__) && !defined(NO_NORETURN)
268 #define NORETURN __attribute__((__noreturn__))
269 #define NORETURN_PTR __attribute__((__noreturn__))
270 #elif defined(_MSC_VER)
271 #define NORETURN __declspec(noreturn)
272 #define NORETURN_PTR
273 #else
274 #define NORETURN
275 #define NORETURN_PTR
276 #ifndef __attribute__
277 #define __attribute__(x)
278 #endif
279 #endif
280
281 #include "compat/bswap.h"
282
283 /* General helper functions */
284 extern void vreportf(const char *prefix, const char *err, va_list params);
285 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
286 extern NORETURN void usage(const char *err);
287 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
288 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
289 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
290 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
291 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
292
293 /*
294 * Let callers be aware of the constant return value; this can help
295 * gcc with -Wuninitialized analysis. We have to restrict this trick to
296 * gcc, though, because of the variadic macro and the magic ## comma pasting
297 * behavior. But since we're only trying to help gcc, anyway, it's OK; other
298 * compilers will fall back to using the function as usual.
299 */
300 #ifdef __GNUC__
301 #define error(fmt, ...) (error((fmt), ##__VA_ARGS__), -1)
302 #endif
303
304 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
305 extern void set_error_routine(void (*routine)(const char *err, va_list params));
306
307 extern int prefixcmp(const char *str, const char *prefix);
308 extern int suffixcmp(const char *str, const char *suffix);
309
310 static inline const char *skip_prefix(const char *str, const char *prefix)
311 {
312 size_t len = strlen(prefix);
313 return strncmp(str, prefix, len) ? NULL : str + len;
314 }
315
316 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
317
318 #ifndef PROT_READ
319 #define PROT_READ 1
320 #define PROT_WRITE 2
321 #define MAP_PRIVATE 1
322 #endif
323
324 #define mmap git_mmap
325 #define munmap git_munmap
326 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
327 extern int git_munmap(void *start, size_t length);
328
329 #else /* NO_MMAP || USE_WIN32_MMAP */
330
331 #include <sys/mman.h>
332
333 #endif /* NO_MMAP || USE_WIN32_MMAP */
334
335 #ifdef NO_MMAP
336
337 /* This value must be multiple of (pagesize * 2) */
338 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
339
340 #else /* NO_MMAP */
341
342 /* This value must be multiple of (pagesize * 2) */
343 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
344 (sizeof(void*) >= 8 \
345 ? 1 * 1024 * 1024 * 1024 \
346 : 32 * 1024 * 1024)
347
348 #endif /* NO_MMAP */
349
350 #ifndef MAP_FAILED
351 #define MAP_FAILED ((void *)-1)
352 #endif
353
354 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
355 #define on_disk_bytes(st) ((st).st_size)
356 #else
357 #define on_disk_bytes(st) ((st).st_blocks * 512)
358 #endif
359
360 #define DEFAULT_PACKED_GIT_LIMIT \
361 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
362
363 #ifdef NO_PREAD
364 #define pread git_pread
365 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
366 #endif
367 /*
368 * Forward decl that will remind us if its twin in cache.h changes.
369 * This function is used in compat/pread.c. But we can't include
370 * cache.h there.
371 */
372 extern ssize_t read_in_full(int fd, void *buf, size_t count);
373
374 #ifdef NO_SETENV
375 #define setenv gitsetenv
376 extern int gitsetenv(const char *, const char *, int);
377 #endif
378
379 #ifdef NO_MKDTEMP
380 #define mkdtemp gitmkdtemp
381 extern char *gitmkdtemp(char *);
382 #endif
383
384 #ifdef NO_MKSTEMPS
385 #define mkstemps gitmkstemps
386 extern int gitmkstemps(char *, int);
387 #endif
388
389 #ifdef NO_UNSETENV
390 #define unsetenv gitunsetenv
391 extern void gitunsetenv(const char *);
392 #endif
393
394 #ifdef NO_STRCASESTR
395 #define strcasestr gitstrcasestr
396 extern char *gitstrcasestr(const char *haystack, const char *needle);
397 #endif
398
399 #ifdef NO_STRLCPY
400 #define strlcpy gitstrlcpy
401 extern size_t gitstrlcpy(char *, const char *, size_t);
402 #endif
403
404 #ifdef NO_STRTOUMAX
405 #define strtoumax gitstrtoumax
406 extern uintmax_t gitstrtoumax(const char *, char **, int);
407 #define strtoimax gitstrtoimax
408 extern intmax_t gitstrtoimax(const char *, char **, int);
409 #endif
410
411 #ifdef NO_STRTOK_R
412 #define strtok_r gitstrtok_r
413 extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
414 #endif
415
416 #ifdef NO_HSTRERROR
417 #define hstrerror githstrerror
418 extern const char *githstrerror(int herror);
419 #endif
420
421 #ifdef NO_MEMMEM
422 #define memmem gitmemmem
423 void *gitmemmem(const void *haystack, size_t haystacklen,
424 const void *needle, size_t needlelen);
425 #endif
426
427 #ifdef NO_GETPAGESIZE
428 #define getpagesize() sysconf(_SC_PAGESIZE)
429 #endif
430
431 #ifdef FREAD_READS_DIRECTORIES
432 #ifdef fopen
433 #undef fopen
434 #endif
435 #define fopen(a,b) git_fopen(a,b)
436 extern FILE *git_fopen(const char*, const char*);
437 #endif
438
439 #ifdef SNPRINTF_RETURNS_BOGUS
440 #define snprintf git_snprintf
441 extern int git_snprintf(char *str, size_t maxsize,
442 const char *format, ...);
443 #define vsnprintf git_vsnprintf
444 extern int git_vsnprintf(char *str, size_t maxsize,
445 const char *format, va_list ap);
446 #endif
447
448 #ifdef __GLIBC_PREREQ
449 #if __GLIBC_PREREQ(2, 1)
450 #define HAVE_STRCHRNUL
451 #define HAVE_MEMPCPY
452 #endif
453 #endif
454
455 #ifndef HAVE_STRCHRNUL
456 #define strchrnul gitstrchrnul
457 static inline char *gitstrchrnul(const char *s, int c)
458 {
459 while (*s && *s != c)
460 s++;
461 return (char *)s;
462 }
463 #endif
464
465 #ifndef HAVE_MEMPCPY
466 #define mempcpy gitmempcpy
467 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
468 {
469 return (char *)memcpy(dest, src, n) + n;
470 }
471 #endif
472
473 #ifdef NO_INET_PTON
474 int inet_pton(int af, const char *src, void *dst);
475 #endif
476
477 #ifdef NO_INET_NTOP
478 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
479 #endif
480
481 extern void release_pack_memory(size_t, int);
482
483 typedef void (*try_to_free_t)(size_t);
484 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
485
486 extern char *xstrdup(const char *str);
487 extern void *xmalloc(size_t size);
488 extern void *xmallocz(size_t size);
489 extern void *xmemdupz(const void *data, size_t len);
490 extern char *xstrndup(const char *str, size_t len);
491 extern void *xrealloc(void *ptr, size_t size);
492 extern void *xcalloc(size_t nmemb, size_t size);
493 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
494 extern ssize_t xread(int fd, void *buf, size_t len);
495 extern ssize_t xwrite(int fd, const void *buf, size_t len);
496 extern int xdup(int fd);
497 extern FILE *xfdopen(int fd, const char *mode);
498 extern int xmkstemp(char *template);
499 extern int xmkstemp_mode(char *template, int mode);
500 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
501 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
502
503 static inline size_t xsize_t(off_t len)
504 {
505 if (len > (size_t) len)
506 die("Cannot handle files this big");
507 return (size_t)len;
508 }
509
510 static inline int has_extension(const char *filename, const char *ext)
511 {
512 size_t len = strlen(filename);
513 size_t extlen = strlen(ext);
514 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
515 }
516
517 /* in ctype.c, for kwset users */
518 extern const char tolower_trans_tbl[256];
519
520 /* Sane ctype - no locale, and works with signed chars */
521 #undef isascii
522 #undef isspace
523 #undef isdigit
524 #undef isalpha
525 #undef isalnum
526 #undef isprint
527 #undef islower
528 #undef isupper
529 #undef tolower
530 #undef toupper
531 extern unsigned char sane_ctype[256];
532 #define GIT_SPACE 0x01
533 #define GIT_DIGIT 0x02
534 #define GIT_ALPHA 0x04
535 #define GIT_GLOB_SPECIAL 0x08
536 #define GIT_REGEX_SPECIAL 0x10
537 #define GIT_PATHSPEC_MAGIC 0x20
538 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
539 #define isascii(x) (((x) & ~0x7f) == 0)
540 #define isspace(x) sane_istest(x,GIT_SPACE)
541 #define isdigit(x) sane_istest(x,GIT_DIGIT)
542 #define isalpha(x) sane_istest(x,GIT_ALPHA)
543 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
544 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
545 #define islower(x) sane_iscase(x, 1)
546 #define isupper(x) sane_iscase(x, 0)
547 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
548 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
549 #define tolower(x) sane_case((unsigned char)(x), 0x20)
550 #define toupper(x) sane_case((unsigned char)(x), 0)
551 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
552
553 static inline int sane_case(int x, int high)
554 {
555 if (sane_istest(x, GIT_ALPHA))
556 x = (x & ~0x20) | high;
557 return x;
558 }
559
560 static inline int sane_iscase(int x, int is_lower)
561 {
562 if (!sane_istest(x, GIT_ALPHA))
563 return 0;
564
565 if (is_lower)
566 return (x & 0x20) != 0;
567 else
568 return (x & 0x20) == 0;
569 }
570
571 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
572 {
573 unsigned long ul;
574 char *p;
575
576 errno = 0;
577 ul = strtoul(s, &p, base);
578 if (errno || *p || p == s || (unsigned int) ul != ul)
579 return -1;
580 *result = ul;
581 return 0;
582 }
583
584 static inline int strtol_i(char const *s, int base, int *result)
585 {
586 long ul;
587 char *p;
588
589 errno = 0;
590 ul = strtol(s, &p, base);
591 if (errno || *p || p == s || (int) ul != ul)
592 return -1;
593 *result = ul;
594 return 0;
595 }
596
597 #ifdef INTERNAL_QSORT
598 void git_qsort(void *base, size_t nmemb, size_t size,
599 int(*compar)(const void *, const void *));
600 #define qsort git_qsort
601 #endif
602
603 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
604 # define FORCE_DIR_SET_GID S_ISGID
605 #else
606 # define FORCE_DIR_SET_GID 0
607 #endif
608
609 #ifdef NO_NSEC
610 #undef USE_NSEC
611 #define ST_CTIME_NSEC(st) 0
612 #define ST_MTIME_NSEC(st) 0
613 #else
614 #ifdef USE_ST_TIMESPEC
615 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
616 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
617 #else
618 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
619 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
620 #endif
621 #endif
622
623 #ifdef UNRELIABLE_FSTAT
624 #define fstat_is_reliable() 0
625 #else
626 #define fstat_is_reliable() 1
627 #endif
628
629 #ifndef va_copy
630 /*
631 * Since an obvious implementation of va_list would be to make it a
632 * pointer into the stack frame, a simple assignment will work on
633 * many systems. But let's try to be more portable.
634 */
635 #ifdef __va_copy
636 #define va_copy(dst, src) __va_copy(dst, src)
637 #else
638 #define va_copy(dst, src) ((dst) = (src))
639 #endif
640 #endif
641
642 /*
643 * Preserves errno, prints a message, but gives no warning for ENOENT.
644 * Always returns the return value of unlink(2).
645 */
646 int unlink_or_warn(const char *path);
647 /*
648 * Likewise for rmdir(2).
649 */
650 int rmdir_or_warn(const char *path);
651 /*
652 * Calls the correct function out of {unlink,rmdir}_or_warn based on
653 * the supplied file mode.
654 */
655 int remove_or_warn(unsigned int mode, const char *path);
656
657 /*
658 * Call access(2), but warn for any error except "missing file"
659 * (ENOENT or ENOTDIR).
660 */
661 int access_or_warn(const char *path, int mode);
662 int access_or_die(const char *path, int mode);
663
664 /* Warn on an inaccessible file that ought to be accessible */
665 void warn_on_inaccessible(const char *path);
666
667 /* Get the passwd entry for the UID of the current process. */
668 struct passwd *xgetpwuid_self(void);
669
670 #endif