Merge branch 'cb/khash-maybe-unused-function'
[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
7 /* Derived from Linux "Features Test Macro" header
8 * Convenience macros to test the versions of gcc (or
9 * a compatible compiler).
10 * Use them like this:
11 * #if GIT_GNUC_PREREQ (2,8)
12 * ... code requiring gcc 2.8 or later ...
13 * #endif
14 */
15 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
16 # define GIT_GNUC_PREREQ(maj, min) \
17 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
18 #else
19 #define GIT_GNUC_PREREQ(maj, min) 0
20 #endif
21
22
23 #ifndef FLEX_ARRAY
24 /*
25 * See if our compiler is known to support flexible array members.
26 */
27 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
28 # define FLEX_ARRAY /* empty */
29 #elif defined(__GNUC__)
30 # if (__GNUC__ >= 3)
31 # define FLEX_ARRAY /* empty */
32 # else
33 # define FLEX_ARRAY 0 /* older GNU extension */
34 # endif
35 #endif
36
37 /*
38 * Otherwise, default to safer but a bit wasteful traditional style
39 */
40 #ifndef FLEX_ARRAY
41 # define FLEX_ARRAY 1
42 #endif
43 #endif
44
45
46 /*
47 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
48 * @cond: the compile-time condition which must be true.
49 *
50 * Your compile will fail if the condition isn't true, or can't be evaluated
51 * by the compiler. This can be used in an expression: its value is "0".
52 *
53 * Example:
54 * #define foo_to_char(foo) \
55 * ((char *)(foo) \
56 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
57 */
58 #define BUILD_ASSERT_OR_ZERO(cond) \
59 (sizeof(char [1 - 2*!(cond)]) - 1)
60
61 #if GIT_GNUC_PREREQ(3, 1)
62 /* &arr[0] degrades to a pointer: a different type from an array */
63 # define BARF_UNLESS_AN_ARRAY(arr) \
64 BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
65 __typeof__(&(arr)[0])))
66 #else
67 # define BARF_UNLESS_AN_ARRAY(arr) 0
68 #endif
69 /*
70 * ARRAY_SIZE - get the number of elements in a visible array
71 * <at> x: the array whose size you want.
72 *
73 * This does not work on pointers, or arrays declared as [], or
74 * function parameters. With correct compiler support, such usage
75 * will cause a build error (see the build_assert_or_zero macro).
76 */
77 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
78
79 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
80
81 #define maximum_signed_value_of_type(a) \
82 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
83
84 #define maximum_unsigned_value_of_type(a) \
85 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
86
87 /*
88 * Signed integer overflow is undefined in C, so here's a helper macro
89 * to detect if the sum of two integers will overflow.
90 *
91 * Requires: a >= 0, typeof(a) equals typeof(b)
92 */
93 #define signed_add_overflows(a, b) \
94 ((b) > maximum_signed_value_of_type(a) - (a))
95
96 #define unsigned_add_overflows(a, b) \
97 ((b) > maximum_unsigned_value_of_type(a) - (a))
98
99 /*
100 * Returns true if the multiplication of "a" and "b" will
101 * overflow. The types of "a" and "b" must match and must be unsigned.
102 * Note that this macro evaluates "a" twice!
103 */
104 #define unsigned_mult_overflows(a, b) \
105 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
106
107 #ifdef __GNUC__
108 #define TYPEOF(x) (__typeof__(x))
109 #else
110 #define TYPEOF(x)
111 #endif
112
113 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
114 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
115
116 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
117
118 /* Approximation of the length of the decimal representation of this type. */
119 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
120
121 #if defined(__sun__)
122 /*
123 * On Solaris, when _XOPEN_EXTENDED is set, its header file
124 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
125 * setting to say we are XPG5 or XPG6. Also on Solaris,
126 * XPG6 programs must be compiled with a c99 compiler, while
127 * non XPG6 programs must be compiled with a pre-c99 compiler.
128 */
129 # if __STDC_VERSION__ - 0 >= 199901L
130 # define _XOPEN_SOURCE 600
131 # else
132 # define _XOPEN_SOURCE 500
133 # endif
134 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
135 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
136 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
137 !defined(__CYGWIN__)
138 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
139 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
140 #endif
141 #define _ALL_SOURCE 1
142 #define _GNU_SOURCE 1
143 #define _BSD_SOURCE 1
144 #define _DEFAULT_SOURCE 1
145 #define _NETBSD_SOURCE 1
146 #define _SGI_SOURCE 1
147
148 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
149 # if !defined(_WIN32_WINNT)
150 # define _WIN32_WINNT 0x0600
151 # endif
152 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
153 #include <winsock2.h>
154 #include <windows.h>
155 #define GIT_WINDOWS_NATIVE
156 #endif
157
158 #include <unistd.h>
159 #include <stdio.h>
160 #include <sys/stat.h>
161 #include <fcntl.h>
162 #include <stddef.h>
163 #include <stdlib.h>
164 #include <stdarg.h>
165 #include <string.h>
166 #ifdef HAVE_STRINGS_H
167 #include <strings.h> /* for strcasecmp() */
168 #endif
169 #include <errno.h>
170 #include <limits.h>
171 #ifdef NEEDS_SYS_PARAM_H
172 #include <sys/param.h>
173 #endif
174 #include <sys/types.h>
175 #include <dirent.h>
176 #include <sys/time.h>
177 #include <time.h>
178 #include <signal.h>
179 #include <assert.h>
180 #include <regex.h>
181 #include <utime.h>
182 #include <syslog.h>
183 #ifndef NO_SYS_POLL_H
184 #include <sys/poll.h>
185 #else
186 #include <poll.h>
187 #endif
188 #ifdef HAVE_BSD_SYSCTL
189 #include <sys/sysctl.h>
190 #endif
191
192 #if defined(__CYGWIN__)
193 #include "compat/cygwin.h"
194 #endif
195 #if defined(__MINGW32__)
196 /* pull in Windows compatibility stuff */
197 #include "compat/mingw.h"
198 #elif defined(_MSC_VER)
199 #include "compat/msvc.h"
200 #else
201 #include <sys/utsname.h>
202 #include <sys/wait.h>
203 #include <sys/resource.h>
204 #include <sys/socket.h>
205 #include <sys/ioctl.h>
206 #include <termios.h>
207 #ifndef NO_SYS_SELECT_H
208 #include <sys/select.h>
209 #endif
210 #include <netinet/in.h>
211 #include <netinet/tcp.h>
212 #include <arpa/inet.h>
213 #include <netdb.h>
214 #include <pwd.h>
215 #include <sys/un.h>
216 #ifndef NO_INTTYPES_H
217 #include <inttypes.h>
218 #else
219 #include <stdint.h>
220 #endif
221 #ifdef NO_INTPTR_T
222 /*
223 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
224 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
225 * while on IP16 and IP16L32 it is "int" (resp. "short")
226 * Size needs to match (or exceed) 'sizeof(void *)'.
227 * We can't take "long long" here as not everybody has it.
228 */
229 typedef long intptr_t;
230 typedef unsigned long uintptr_t;
231 #endif
232 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
233 #include <grp.h>
234 #define _ALL_SOURCE 1
235 #endif
236
237 /* used on Mac OS X */
238 #ifdef PRECOMPOSE_UNICODE
239 #include "compat/precompose_utf8.h"
240 #else
241 #define precompose_str(in,i_nfd2nfc)
242 #define precompose_argv(c,v)
243 #define probe_utf8_pathname_composition()
244 #endif
245
246 #ifdef MKDIR_WO_TRAILING_SLASH
247 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
248 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
249 #endif
250
251 #ifdef NO_STRUCT_ITIMERVAL
252 struct itimerval {
253 struct timeval it_interval;
254 struct timeval it_value;
255 };
256 #endif
257
258 #ifdef NO_SETITIMER
259 #define setitimer(which,value,ovalue)
260 #endif
261
262 #ifndef NO_LIBGEN_H
263 #include <libgen.h>
264 #else
265 #define basename gitbasename
266 extern char *gitbasename(char *);
267 #define dirname gitdirname
268 extern char *gitdirname(char *);
269 #endif
270
271 #ifndef NO_ICONV
272 #include <iconv.h>
273 #endif
274
275 #ifndef NO_OPENSSL
276 #ifdef __APPLE__
277 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
278 #include <AvailabilityMacros.h>
279 #undef DEPRECATED_ATTRIBUTE
280 #define DEPRECATED_ATTRIBUTE
281 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
282 #endif
283 #include <openssl/ssl.h>
284 #include <openssl/err.h>
285 #endif
286
287 #ifdef HAVE_SYSINFO
288 # include <sys/sysinfo.h>
289 #endif
290
291 /* On most systems <netdb.h> would have given us this, but
292 * not on some systems (e.g. z/OS).
293 */
294 #ifndef NI_MAXHOST
295 #define NI_MAXHOST 1025
296 #endif
297
298 #ifndef NI_MAXSERV
299 #define NI_MAXSERV 32
300 #endif
301
302 /* On most systems <limits.h> would have given us this, but
303 * not on some systems (e.g. GNU/Hurd).
304 */
305 #ifndef PATH_MAX
306 #define PATH_MAX 4096
307 #endif
308
309 #ifndef PRIuMAX
310 #define PRIuMAX "llu"
311 #endif
312
313 #ifndef SCNuMAX
314 #define SCNuMAX PRIuMAX
315 #endif
316
317 #ifndef PRIu32
318 #define PRIu32 "u"
319 #endif
320
321 #ifndef PRIx32
322 #define PRIx32 "x"
323 #endif
324
325 #ifndef PRIo32
326 #define PRIo32 "o"
327 #endif
328
329 typedef uintmax_t timestamp_t;
330 #define PRItime PRIuMAX
331 #define parse_timestamp strtoumax
332 #define TIME_MAX UINTMAX_MAX
333
334 #ifndef PATH_SEP
335 #define PATH_SEP ':'
336 #endif
337
338 #ifdef HAVE_PATHS_H
339 #include <paths.h>
340 #endif
341 #ifndef _PATH_DEFPATH
342 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
343 #endif
344
345 #ifndef has_dos_drive_prefix
346 static inline int git_has_dos_drive_prefix(const char *path)
347 {
348 return 0;
349 }
350 #define has_dos_drive_prefix git_has_dos_drive_prefix
351 #endif
352
353 #ifndef skip_dos_drive_prefix
354 static inline int git_skip_dos_drive_prefix(char **path)
355 {
356 return 0;
357 }
358 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
359 #endif
360
361 #ifndef is_dir_sep
362 static inline int git_is_dir_sep(int c)
363 {
364 return c == '/';
365 }
366 #define is_dir_sep git_is_dir_sep
367 #endif
368
369 #ifndef offset_1st_component
370 static inline int git_offset_1st_component(const char *path)
371 {
372 return is_dir_sep(path[0]);
373 }
374 #define offset_1st_component git_offset_1st_component
375 #endif
376
377 #ifndef find_last_dir_sep
378 static inline char *git_find_last_dir_sep(const char *path)
379 {
380 return strrchr(path, '/');
381 }
382 #define find_last_dir_sep git_find_last_dir_sep
383 #endif
384
385 #ifndef query_user_email
386 #define query_user_email() NULL
387 #endif
388
389 #if defined(__HP_cc) && (__HP_cc >= 61000)
390 #define NORETURN __attribute__((noreturn))
391 #define NORETURN_PTR
392 #elif defined(__GNUC__) && !defined(NO_NORETURN)
393 #define NORETURN __attribute__((__noreturn__))
394 #define NORETURN_PTR __attribute__((__noreturn__))
395 #elif defined(_MSC_VER)
396 #define NORETURN __declspec(noreturn)
397 #define NORETURN_PTR
398 #else
399 #define NORETURN
400 #define NORETURN_PTR
401 #ifndef __GNUC__
402 #ifndef __attribute__
403 #define __attribute__(x)
404 #endif
405 #endif
406 #endif
407
408 /* The sentinel attribute is valid from gcc version 4.0 */
409 #if defined(__GNUC__) && (__GNUC__ >= 4)
410 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
411 #else
412 #define LAST_ARG_MUST_BE_NULL
413 #endif
414
415 #define MAYBE_UNUSED __attribute__((__unused__))
416
417 #include "compat/bswap.h"
418
419 #include "wildmatch.h"
420
421 struct strbuf;
422
423 /* General helper functions */
424 extern void vreportf(const char *prefix, const char *err, va_list params);
425 extern NORETURN void usage(const char *err);
426 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
427 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
428 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
429 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
430 extern int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
431 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
432 extern void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
433
434 #ifndef NO_OPENSSL
435 #ifdef APPLE_COMMON_CRYPTO
436 #include "compat/apple-common-crypto.h"
437 #else
438 #include <openssl/evp.h>
439 #include <openssl/hmac.h>
440 #endif /* APPLE_COMMON_CRYPTO */
441 #include <openssl/x509v3.h>
442 #endif /* NO_OPENSSL */
443
444 /*
445 * Let callers be aware of the constant return value; this can help
446 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
447 * because some compilers may not support variadic macros. Since we're only
448 * trying to help gcc, anyway, it's OK; other compilers will fall back to
449 * using the function as usual.
450 */
451 #if defined(__GNUC__)
452 static inline int const_error(void)
453 {
454 return -1;
455 }
456 #define error(...) (error(__VA_ARGS__), const_error())
457 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
458 #endif
459
460 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
461 extern void set_error_routine(void (*routine)(const char *err, va_list params));
462 extern void (*get_error_routine(void))(const char *err, va_list params);
463 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
464 extern void (*get_warn_routine(void))(const char *warn, va_list params);
465 extern void set_die_is_recursing_routine(int (*routine)(void));
466
467 extern int starts_with(const char *str, const char *prefix);
468 extern int istarts_with(const char *str, const char *prefix);
469
470 /*
471 * If the string "str" begins with the string found in "prefix", return 1.
472 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
473 * the string right after the prefix).
474 *
475 * Otherwise, return 0 and leave "out" untouched.
476 *
477 * Examples:
478 *
479 * [extract branch name, fail if not a branch]
480 * if (!skip_prefix(ref, "refs/heads/", &branch)
481 * return -1;
482 *
483 * [skip prefix if present, otherwise use whole string]
484 * skip_prefix(name, "refs/heads/", &name);
485 */
486 static inline int skip_prefix(const char *str, const char *prefix,
487 const char **out)
488 {
489 do {
490 if (!*prefix) {
491 *out = str;
492 return 1;
493 }
494 } while (*str++ == *prefix++);
495 return 0;
496 }
497
498 /*
499 * If the string "str" is the same as the string in "prefix", then the "arg"
500 * parameter is set to the "def" parameter and 1 is returned.
501 * If the string "str" begins with the string found in "prefix" and then a
502 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
503 * (i.e., to the point in the string right after the prefix and the "=" sign),
504 * and 1 is returned.
505 *
506 * Otherwise, return 0 and leave "arg" untouched.
507 *
508 * When we accept both a "--key" and a "--key=<val>" option, this function
509 * can be used instead of !strcmp(arg, "--key") and then
510 * skip_prefix(arg, "--key=", &arg) to parse such an option.
511 */
512 int skip_to_optional_arg_default(const char *str, const char *prefix,
513 const char **arg, const char *def);
514
515 static inline int skip_to_optional_arg(const char *str, const char *prefix,
516 const char **arg)
517 {
518 return skip_to_optional_arg_default(str, prefix, arg, "");
519 }
520
521 /*
522 * Like skip_prefix, but promises never to read past "len" bytes of the input
523 * buffer, and returns the remaining number of bytes in "out" via "outlen".
524 */
525 static inline int skip_prefix_mem(const char *buf, size_t len,
526 const char *prefix,
527 const char **out, size_t *outlen)
528 {
529 size_t prefix_len = strlen(prefix);
530 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
531 *out = buf + prefix_len;
532 *outlen = len - prefix_len;
533 return 1;
534 }
535 return 0;
536 }
537
538 /*
539 * If buf ends with suffix, return 1 and subtract the length of the suffix
540 * from *len. Otherwise, return 0 and leave *len untouched.
541 */
542 static inline int strip_suffix_mem(const char *buf, size_t *len,
543 const char *suffix)
544 {
545 size_t suflen = strlen(suffix);
546 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
547 return 0;
548 *len -= suflen;
549 return 1;
550 }
551
552 /*
553 * If str ends with suffix, return 1 and set *len to the size of the string
554 * without the suffix. Otherwise, return 0 and set *len to the size of the
555 * string.
556 *
557 * Note that we do _not_ NUL-terminate str to the new length.
558 */
559 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
560 {
561 *len = strlen(str);
562 return strip_suffix_mem(str, len, suffix);
563 }
564
565 static inline int ends_with(const char *str, const char *suffix)
566 {
567 size_t len;
568 return strip_suffix(str, suffix, &len);
569 }
570
571 #define SWAP(a, b) do { \
572 void *_swap_a_ptr = &(a); \
573 void *_swap_b_ptr = &(b); \
574 unsigned char _swap_buffer[sizeof(a)]; \
575 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
576 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
577 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
578 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
579 } while (0)
580
581 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
582
583 #ifndef PROT_READ
584 #define PROT_READ 1
585 #define PROT_WRITE 2
586 #define MAP_PRIVATE 1
587 #endif
588
589 #define mmap git_mmap
590 #define munmap git_munmap
591 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
592 extern int git_munmap(void *start, size_t length);
593
594 #else /* NO_MMAP || USE_WIN32_MMAP */
595
596 #include <sys/mman.h>
597
598 #endif /* NO_MMAP || USE_WIN32_MMAP */
599
600 #ifdef NO_MMAP
601
602 /* This value must be multiple of (pagesize * 2) */
603 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
604
605 #else /* NO_MMAP */
606
607 /* This value must be multiple of (pagesize * 2) */
608 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
609 (sizeof(void*) >= 8 \
610 ? 1 * 1024 * 1024 * 1024 \
611 : 32 * 1024 * 1024)
612
613 #endif /* NO_MMAP */
614
615 #ifndef MAP_FAILED
616 #define MAP_FAILED ((void *)-1)
617 #endif
618
619 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
620 #define on_disk_bytes(st) ((st).st_size)
621 #else
622 #define on_disk_bytes(st) ((st).st_blocks * 512)
623 #endif
624
625 #ifdef NEEDS_MODE_TRANSLATION
626 #undef S_IFMT
627 #undef S_IFREG
628 #undef S_IFDIR
629 #undef S_IFLNK
630 #undef S_IFBLK
631 #undef S_IFCHR
632 #undef S_IFIFO
633 #undef S_IFSOCK
634 #define S_IFMT 0170000
635 #define S_IFREG 0100000
636 #define S_IFDIR 0040000
637 #define S_IFLNK 0120000
638 #define S_IFBLK 0060000
639 #define S_IFCHR 0020000
640 #define S_IFIFO 0010000
641 #define S_IFSOCK 0140000
642 #ifdef stat
643 #undef stat
644 #endif
645 #define stat(path, buf) git_stat(path, buf)
646 extern int git_stat(const char *, struct stat *);
647 #ifdef fstat
648 #undef fstat
649 #endif
650 #define fstat(fd, buf) git_fstat(fd, buf)
651 extern int git_fstat(int, struct stat *);
652 #ifdef lstat
653 #undef lstat
654 #endif
655 #define lstat(path, buf) git_lstat(path, buf)
656 extern int git_lstat(const char *, struct stat *);
657 #endif
658
659 #define DEFAULT_PACKED_GIT_LIMIT \
660 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
661
662 #ifdef NO_PREAD
663 #define pread git_pread
664 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
665 #endif
666 /*
667 * Forward decl that will remind us if its twin in cache.h changes.
668 * This function is used in compat/pread.c. But we can't include
669 * cache.h there.
670 */
671 extern ssize_t read_in_full(int fd, void *buf, size_t count);
672
673 #ifdef NO_SETENV
674 #define setenv gitsetenv
675 extern int gitsetenv(const char *, const char *, int);
676 #endif
677
678 #ifdef NO_MKDTEMP
679 #define mkdtemp gitmkdtemp
680 extern char *gitmkdtemp(char *);
681 #endif
682
683 #ifdef NO_UNSETENV
684 #define unsetenv gitunsetenv
685 extern void gitunsetenv(const char *);
686 #endif
687
688 #ifdef NO_STRCASESTR
689 #define strcasestr gitstrcasestr
690 extern char *gitstrcasestr(const char *haystack, const char *needle);
691 #endif
692
693 #ifdef NO_STRLCPY
694 #define strlcpy gitstrlcpy
695 extern size_t gitstrlcpy(char *, const char *, size_t);
696 #endif
697
698 #ifdef NO_STRTOUMAX
699 #define strtoumax gitstrtoumax
700 extern uintmax_t gitstrtoumax(const char *, char **, int);
701 #define strtoimax gitstrtoimax
702 extern intmax_t gitstrtoimax(const char *, char **, int);
703 #endif
704
705 #ifdef NO_HSTRERROR
706 #define hstrerror githstrerror
707 extern const char *githstrerror(int herror);
708 #endif
709
710 #ifdef NO_MEMMEM
711 #define memmem gitmemmem
712 void *gitmemmem(const void *haystack, size_t haystacklen,
713 const void *needle, size_t needlelen);
714 #endif
715
716 #ifdef OVERRIDE_STRDUP
717 #ifdef strdup
718 #undef strdup
719 #endif
720 #define strdup gitstrdup
721 char *gitstrdup(const char *s);
722 #endif
723
724 #ifdef NO_GETPAGESIZE
725 #define getpagesize() sysconf(_SC_PAGESIZE)
726 #endif
727
728 #ifndef O_CLOEXEC
729 #define O_CLOEXEC 0
730 #endif
731
732 #ifdef FREAD_READS_DIRECTORIES
733 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
734 # ifdef fopen
735 # undef fopen
736 # endif
737 # define fopen(a,b) git_fopen(a,b)
738 # endif
739 extern FILE *git_fopen(const char*, const char*);
740 #endif
741
742 #ifdef SNPRINTF_RETURNS_BOGUS
743 #ifdef snprintf
744 #undef snprintf
745 #endif
746 #define snprintf git_snprintf
747 extern int git_snprintf(char *str, size_t maxsize,
748 const char *format, ...);
749 #ifdef vsnprintf
750 #undef vsnprintf
751 #endif
752 #define vsnprintf git_vsnprintf
753 extern int git_vsnprintf(char *str, size_t maxsize,
754 const char *format, va_list ap);
755 #endif
756
757 #ifdef __GLIBC_PREREQ
758 #if __GLIBC_PREREQ(2, 1)
759 #define HAVE_STRCHRNUL
760 #endif
761 #endif
762
763 #ifndef HAVE_STRCHRNUL
764 #define strchrnul gitstrchrnul
765 static inline char *gitstrchrnul(const char *s, int c)
766 {
767 while (*s && *s != c)
768 s++;
769 return (char *)s;
770 }
771 #endif
772
773 #ifdef NO_INET_PTON
774 int inet_pton(int af, const char *src, void *dst);
775 #endif
776
777 #ifdef NO_INET_NTOP
778 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
779 #endif
780
781 #ifdef NO_PTHREADS
782 #define atexit git_atexit
783 extern int git_atexit(void (*handler)(void));
784 #endif
785
786 typedef void (*try_to_free_t)(size_t);
787 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
788
789 static inline size_t st_add(size_t a, size_t b)
790 {
791 if (unsigned_add_overflows(a, b))
792 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
793 (uintmax_t)a, (uintmax_t)b);
794 return a + b;
795 }
796 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
797 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
798
799 static inline size_t st_mult(size_t a, size_t b)
800 {
801 if (unsigned_mult_overflows(a, b))
802 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
803 (uintmax_t)a, (uintmax_t)b);
804 return a * b;
805 }
806
807 static inline size_t st_sub(size_t a, size_t b)
808 {
809 if (a < b)
810 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
811 (uintmax_t)a, (uintmax_t)b);
812 return a - b;
813 }
814
815 #ifdef HAVE_ALLOCA_H
816 # include <alloca.h>
817 # define xalloca(size) (alloca(size))
818 # define xalloca_free(p) do {} while (0)
819 #else
820 # define xalloca(size) (xmalloc(size))
821 # define xalloca_free(p) (free(p))
822 #endif
823 extern char *xstrdup(const char *str);
824 extern void *xmalloc(size_t size);
825 extern void *xmallocz(size_t size);
826 extern void *xmallocz_gently(size_t size);
827 extern void *xmemdupz(const void *data, size_t len);
828 extern char *xstrndup(const char *str, size_t len);
829 extern void *xrealloc(void *ptr, size_t size);
830 extern void *xcalloc(size_t nmemb, size_t size);
831 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
832 extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
833 extern int xopen(const char *path, int flags, ...);
834 extern ssize_t xread(int fd, void *buf, size_t len);
835 extern ssize_t xwrite(int fd, const void *buf, size_t len);
836 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
837 extern int xdup(int fd);
838 extern FILE *xfopen(const char *path, const char *mode);
839 extern FILE *xfdopen(int fd, const char *mode);
840 extern int xmkstemp(char *temp_filename);
841 extern int xmkstemp_mode(char *temp_filename, int mode);
842 extern char *xgetcwd(void);
843 extern FILE *fopen_for_writing(const char *path);
844 extern FILE *fopen_or_warn(const char *path, const char *mode);
845
846 /*
847 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
848 * that ptr is used twice, so don't pass e.g. ptr++.
849 */
850 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
851
852 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
853 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
854
855 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
856 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
857 static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
858 {
859 if (n)
860 memcpy(dst, src, st_mult(size, n));
861 }
862
863 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
864 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
865 static inline void move_array(void *dst, const void *src, size_t n, size_t size)
866 {
867 if (n)
868 memmove(dst, src, st_mult(size, n));
869 }
870
871 /*
872 * These functions help you allocate structs with flex arrays, and copy
873 * the data directly into the array. For example, if you had:
874 *
875 * struct foo {
876 * int bar;
877 * char name[FLEX_ARRAY];
878 * };
879 *
880 * you can do:
881 *
882 * struct foo *f;
883 * FLEX_ALLOC_MEM(f, name, src, len);
884 *
885 * to allocate a "foo" with the contents of "src" in the "name" field.
886 * The resulting struct is automatically zero'd, and the flex-array field
887 * is NUL-terminated (whether the incoming src buffer was or not).
888 *
889 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
890 * but do want to store a pointer to some extra data in the same allocated
891 * block. For example, if you have:
892 *
893 * struct foo {
894 * char *name;
895 * int bar;
896 * };
897 *
898 * you can do:
899 *
900 * struct foo *f;
901 * FLEXPTR_ALLOC_STR(f, name, src);
902 *
903 * and "name" will point to a block of memory after the struct, which will be
904 * freed along with the struct (but the pointer can be repointed anywhere).
905 *
906 * The *_STR variants accept a string parameter rather than a ptr/len
907 * combination.
908 *
909 * Note that these macros will evaluate the first parameter multiple
910 * times, and it must be assignable as an lvalue.
911 */
912 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
913 size_t flex_array_len_ = (len); \
914 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
915 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
916 } while (0)
917 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
918 size_t flex_array_len_ = (len); \
919 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
920 memcpy((x) + 1, (buf), flex_array_len_); \
921 (x)->ptrname = (void *)((x)+1); \
922 } while(0)
923 #define FLEX_ALLOC_STR(x, flexname, str) \
924 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
925 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
926 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
927
928 static inline char *xstrdup_or_null(const char *str)
929 {
930 return str ? xstrdup(str) : NULL;
931 }
932
933 static inline size_t xsize_t(off_t len)
934 {
935 size_t size = (size_t) len;
936
937 if (len != (off_t) size)
938 die("Cannot handle files this big");
939 return size;
940 }
941
942 __attribute__((format (printf, 3, 4)))
943 extern int xsnprintf(char *dst, size_t max, const char *fmt, ...);
944
945 #ifndef HOST_NAME_MAX
946 #define HOST_NAME_MAX 256
947 #endif
948
949 extern int xgethostname(char *buf, size_t len);
950
951 /* in ctype.c, for kwset users */
952 extern const unsigned char tolower_trans_tbl[256];
953
954 /* Sane ctype - no locale, and works with signed chars */
955 #undef isascii
956 #undef isspace
957 #undef isdigit
958 #undef isalpha
959 #undef isalnum
960 #undef isprint
961 #undef islower
962 #undef isupper
963 #undef tolower
964 #undef toupper
965 #undef iscntrl
966 #undef ispunct
967 #undef isxdigit
968
969 extern const unsigned char sane_ctype[256];
970 #define GIT_SPACE 0x01
971 #define GIT_DIGIT 0x02
972 #define GIT_ALPHA 0x04
973 #define GIT_GLOB_SPECIAL 0x08
974 #define GIT_REGEX_SPECIAL 0x10
975 #define GIT_PATHSPEC_MAGIC 0x20
976 #define GIT_CNTRL 0x40
977 #define GIT_PUNCT 0x80
978 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
979 #define isascii(x) (((x) & ~0x7f) == 0)
980 #define isspace(x) sane_istest(x,GIT_SPACE)
981 #define isdigit(x) sane_istest(x,GIT_DIGIT)
982 #define isalpha(x) sane_istest(x,GIT_ALPHA)
983 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
984 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
985 #define islower(x) sane_iscase(x, 1)
986 #define isupper(x) sane_iscase(x, 0)
987 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
988 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
989 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
990 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
991 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
992 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
993 #define tolower(x) sane_case((unsigned char)(x), 0x20)
994 #define toupper(x) sane_case((unsigned char)(x), 0)
995 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
996
997 static inline int sane_case(int x, int high)
998 {
999 if (sane_istest(x, GIT_ALPHA))
1000 x = (x & ~0x20) | high;
1001 return x;
1002 }
1003
1004 static inline int sane_iscase(int x, int is_lower)
1005 {
1006 if (!sane_istest(x, GIT_ALPHA))
1007 return 0;
1008
1009 if (is_lower)
1010 return (x & 0x20) != 0;
1011 else
1012 return (x & 0x20) == 0;
1013 }
1014
1015 /*
1016 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1017 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1018 * locale-specific conversions).
1019 */
1020 static inline int skip_iprefix(const char *str, const char *prefix,
1021 const char **out)
1022 {
1023 do {
1024 if (!*prefix) {
1025 *out = str;
1026 return 1;
1027 }
1028 } while (tolower(*str++) == tolower(*prefix++));
1029 return 0;
1030 }
1031
1032 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1033 {
1034 unsigned long ul;
1035 char *p;
1036
1037 errno = 0;
1038 /* negative values would be accepted by strtoul */
1039 if (strchr(s, '-'))
1040 return -1;
1041 ul = strtoul(s, &p, base);
1042 if (errno || *p || p == s || (unsigned int) ul != ul)
1043 return -1;
1044 *result = ul;
1045 return 0;
1046 }
1047
1048 static inline int strtol_i(char const *s, int base, int *result)
1049 {
1050 long ul;
1051 char *p;
1052
1053 errno = 0;
1054 ul = strtol(s, &p, base);
1055 if (errno || *p || p == s || (int) ul != ul)
1056 return -1;
1057 *result = ul;
1058 return 0;
1059 }
1060
1061 #ifdef INTERNAL_QSORT
1062 void git_qsort(void *base, size_t nmemb, size_t size,
1063 int(*compar)(const void *, const void *));
1064 #define qsort git_qsort
1065 #endif
1066
1067 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1068 static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1069 int(*compar)(const void *, const void *))
1070 {
1071 if (nmemb > 1)
1072 qsort(base, nmemb, size, compar);
1073 }
1074
1075 #ifndef HAVE_ISO_QSORT_S
1076 int git_qsort_s(void *base, size_t nmemb, size_t size,
1077 int (*compar)(const void *, const void *, void *), void *ctx);
1078 #define qsort_s git_qsort_s
1079 #endif
1080
1081 #define QSORT_S(base, n, compar, ctx) do { \
1082 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1083 BUG("qsort_s() failed"); \
1084 } while (0)
1085
1086 #ifndef REG_STARTEND
1087 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1088 #endif
1089
1090 static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1091 size_t nmatch, regmatch_t pmatch[], int eflags)
1092 {
1093 assert(nmatch > 0 && pmatch);
1094 pmatch[0].rm_so = 0;
1095 pmatch[0].rm_eo = size;
1096 return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1097 }
1098
1099 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1100 # define FORCE_DIR_SET_GID S_ISGID
1101 #else
1102 # define FORCE_DIR_SET_GID 0
1103 #endif
1104
1105 #ifdef NO_NSEC
1106 #undef USE_NSEC
1107 #define ST_CTIME_NSEC(st) 0
1108 #define ST_MTIME_NSEC(st) 0
1109 #else
1110 #ifdef USE_ST_TIMESPEC
1111 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1112 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1113 #else
1114 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1115 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1116 #endif
1117 #endif
1118
1119 #ifdef UNRELIABLE_FSTAT
1120 #define fstat_is_reliable() 0
1121 #else
1122 #define fstat_is_reliable() 1
1123 #endif
1124
1125 #ifndef va_copy
1126 /*
1127 * Since an obvious implementation of va_list would be to make it a
1128 * pointer into the stack frame, a simple assignment will work on
1129 * many systems. But let's try to be more portable.
1130 */
1131 #ifdef __va_copy
1132 #define va_copy(dst, src) __va_copy(dst, src)
1133 #else
1134 #define va_copy(dst, src) ((dst) = (src))
1135 #endif
1136 #endif
1137
1138 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
1139 #define HAVE_VARIADIC_MACROS 1
1140 #endif
1141
1142 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1143 extern int BUG_exit_code;
1144
1145 #ifdef HAVE_VARIADIC_MACROS
1146 __attribute__((format (printf, 3, 4))) NORETURN
1147 void BUG_fl(const char *file, int line, const char *fmt, ...);
1148 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1149 #else
1150 __attribute__((format (printf, 1, 2))) NORETURN
1151 void BUG(const char *fmt, ...);
1152 #endif
1153
1154 /*
1155 * Preserves errno, prints a message, but gives no warning for ENOENT.
1156 * Returns 0 on success, which includes trying to unlink an object that does
1157 * not exist.
1158 */
1159 int unlink_or_warn(const char *path);
1160 /*
1161 * Tries to unlink file. Returns 0 if unlink succeeded
1162 * or the file already didn't exist. Returns -1 and
1163 * appends a message to err suitable for
1164 * 'error("%s", err->buf)' on error.
1165 */
1166 int unlink_or_msg(const char *file, struct strbuf *err);
1167 /*
1168 * Preserves errno, prints a message, but gives no warning for ENOENT.
1169 * Returns 0 on success, which includes trying to remove a directory that does
1170 * not exist.
1171 */
1172 int rmdir_or_warn(const char *path);
1173 /*
1174 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1175 * the supplied file mode.
1176 */
1177 int remove_or_warn(unsigned int mode, const char *path);
1178
1179 /*
1180 * Call access(2), but warn for any error except "missing file"
1181 * (ENOENT or ENOTDIR).
1182 */
1183 #define ACCESS_EACCES_OK (1U << 0)
1184 int access_or_warn(const char *path, int mode, unsigned flag);
1185 int access_or_die(const char *path, int mode, unsigned flag);
1186
1187 /* Warn on an inaccessible file if errno indicates this is an error */
1188 int warn_on_fopen_errors(const char *path);
1189
1190 #ifdef GMTIME_UNRELIABLE_ERRORS
1191 struct tm *git_gmtime(const time_t *);
1192 struct tm *git_gmtime_r(const time_t *, struct tm *);
1193 #define gmtime git_gmtime
1194 #define gmtime_r git_gmtime_r
1195 #endif
1196
1197 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1198 #define USE_PARENS_AROUND_GETTEXT_N 1
1199 #endif
1200
1201 #ifndef SHELL_PATH
1202 # define SHELL_PATH "/bin/sh"
1203 #endif
1204
1205 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1206 #define flockfile(fh)
1207 #define funlockfile(fh)
1208 #define getc_unlocked(fh) getc(fh)
1209 #endif
1210
1211 /*
1212 * Our code often opens a path to an optional file, to work on its
1213 * contents when we can successfully open it. We can ignore a failure
1214 * to open if such an optional file does not exist, but we do want to
1215 * report a failure in opening for other reasons (e.g. we got an I/O
1216 * error, or the file is there, but we lack the permission to open).
1217 *
1218 * Call this function after seeing an error from open() or fopen() to
1219 * see if the errno indicates a missing file that we can safely ignore.
1220 */
1221 static inline int is_missing_file_error(int errno_)
1222 {
1223 return (errno_ == ENOENT || errno_ == ENOTDIR);
1224 }
1225
1226 extern int cmd_main(int, const char **);
1227
1228 /*
1229 * You can mark a stack variable with UNLEAK(var) to avoid it being
1230 * reported as a leak by tools like LSAN or valgrind. The argument
1231 * should generally be the variable itself (not its address and not what
1232 * it points to). It's safe to use this on pointers which may already
1233 * have been freed, or on pointers which may still be in use.
1234 *
1235 * Use this _only_ for a variable that leaks by going out of scope at
1236 * program exit (so only from cmd_* functions or their direct helpers).
1237 * Normal functions, especially those which may be called multiple
1238 * times, should actually free their memory. This is only meant as
1239 * an annotation, and does nothing in non-leak-checking builds.
1240 */
1241 #ifdef SUPPRESS_ANNOTATED_LEAKS
1242 extern void unleak_memory(const void *ptr, size_t len);
1243 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1244 #else
1245 #define UNLEAK(var) do {} while (0)
1246 #endif
1247
1248 /*
1249 * This include must come after system headers, since it introduces macros that
1250 * replace system names.
1251 */
1252 #include "banned.h"
1253
1254 #endif