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