git-merge-tree.txt: replace spurious HTML entity
[git.git] / git-compat-util.h
blobde57f435e2a6da67d1c49b9a05816b5a12346122
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #if __STDC_VERSION__ - 0 < 199901L
5 /*
6 * Git is in a testing period for mandatory C99 support in the compiler. If
7 * your compiler is reasonably recent, you can try to enable C99 support (or,
8 * for MSVC, C11 support). If you encounter a problem and can't enable C99
9 * support with your compiler (such as with "-std=gnu99") and don't have access
10 * to one with this support, such as GCC or Clang, you can remove this #if
11 * directive, but please report the details of your system to
12 * git@vger.kernel.org.
14 #error "Required C99 support is in a test phase. Please see git-compat-util.h for more details."
15 #endif
17 #ifdef USE_MSVC_CRTDBG
19 * For these to work they must appear very early in each
20 * file -- before most of the standard header files.
22 #include <stdlib.h>
23 #include <crtdbg.h>
24 #endif
26 struct strbuf;
29 #define _FILE_OFFSET_BITS 64
32 /* Derived from Linux "Features Test Macro" header
33 * Convenience macros to test the versions of gcc (or
34 * a compatible compiler).
35 * Use them like this:
36 * #if GIT_GNUC_PREREQ (2,8)
37 * ... code requiring gcc 2.8 or later ...
38 * #endif
40 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
41 # define GIT_GNUC_PREREQ(maj, min) \
42 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
43 #else
44 #define GIT_GNUC_PREREQ(maj, min) 0
45 #endif
48 #ifndef FLEX_ARRAY
50 * See if our compiler is known to support flexible array members.
54 * Check vendor specific quirks first, before checking the
55 * __STDC_VERSION__, as vendor compilers can lie and we need to be
56 * able to work them around. Note that by not defining FLEX_ARRAY
57 * here, we can fall back to use the "safer but a bit wasteful" one
58 * later.
60 #if defined(__SUNPRO_C) && (__SUNPRO_C <= 0x580)
61 #elif defined(__GNUC__)
62 # if (__GNUC__ >= 3)
63 # define FLEX_ARRAY /* empty */
64 # else
65 # define FLEX_ARRAY 0 /* older GNU extension */
66 # endif
67 #elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
68 # define FLEX_ARRAY /* empty */
69 #endif
72 * Otherwise, default to safer but a bit wasteful traditional style
74 #ifndef FLEX_ARRAY
75 # define FLEX_ARRAY 1
76 #endif
77 #endif
81 * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
82 * @cond: the compile-time condition which must be true.
84 * Your compile will fail if the condition isn't true, or can't be evaluated
85 * by the compiler. This can be used in an expression: its value is "0".
87 * Example:
88 * #define foo_to_char(foo) \
89 * ((char *)(foo) \
90 * + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
92 #define BUILD_ASSERT_OR_ZERO(cond) \
93 (sizeof(char [1 - 2*!(cond)]) - 1)
95 #if GIT_GNUC_PREREQ(3, 1)
96 /* &arr[0] degrades to a pointer: a different type from an array */
97 # define BARF_UNLESS_AN_ARRAY(arr) \
98 BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
99 __typeof__(&(arr)[0])))
100 #else
101 # define BARF_UNLESS_AN_ARRAY(arr) 0
102 #endif
104 * ARRAY_SIZE - get the number of elements in a visible array
105 * @x: the array whose size you want.
107 * This does not work on pointers, or arrays declared as [], or
108 * function parameters. With correct compiler support, such usage
109 * will cause a build error (see the build_assert_or_zero macro).
111 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
113 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
115 #define maximum_signed_value_of_type(a) \
116 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
118 #define maximum_unsigned_value_of_type(a) \
119 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
122 * Signed integer overflow is undefined in C, so here's a helper macro
123 * to detect if the sum of two integers will overflow.
125 * Requires: a >= 0, typeof(a) equals typeof(b)
127 #define signed_add_overflows(a, b) \
128 ((b) > maximum_signed_value_of_type(a) - (a))
130 #define unsigned_add_overflows(a, b) \
131 ((b) > maximum_unsigned_value_of_type(a) - (a))
134 * Returns true if the multiplication of "a" and "b" will
135 * overflow. The types of "a" and "b" must match and must be unsigned.
136 * Note that this macro evaluates "a" twice!
138 #define unsigned_mult_overflows(a, b) \
139 ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
142 * Returns true if the left shift of "a" by "shift" bits will
143 * overflow. The type of "a" must be unsigned.
145 #define unsigned_left_shift_overflows(a, shift) \
146 ((shift) < bitsizeof(a) && \
147 (a) > maximum_unsigned_value_of_type(a) >> (shift))
149 #ifdef __GNUC__
150 #define TYPEOF(x) (__typeof__(x))
151 #else
152 #define TYPEOF(x)
153 #endif
155 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
156 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
158 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
160 /* Approximation of the length of the decimal representation of this type. */
161 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
163 #ifdef __MINGW64__
164 #define _POSIX_C_SOURCE 1
165 #elif defined(__sun__)
167 * On Solaris, when _XOPEN_EXTENDED is set, its header file
168 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
169 * setting to say we are XPG5 or XPG6. Also on Solaris,
170 * XPG6 programs must be compiled with a c99 compiler, while
171 * non XPG6 programs must be compiled with a pre-c99 compiler.
173 # if __STDC_VERSION__ - 0 >= 199901L
174 # define _XOPEN_SOURCE 600
175 # else
176 # define _XOPEN_SOURCE 500
177 # endif
178 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
179 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
180 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
181 !defined(__CYGWIN__)
182 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
183 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
184 #endif
185 #define _ALL_SOURCE 1
186 #define _GNU_SOURCE 1
187 #define _BSD_SOURCE 1
188 #define _DEFAULT_SOURCE 1
189 #define _NETBSD_SOURCE 1
190 #define _SGI_SOURCE 1
192 #if GIT_GNUC_PREREQ(4, 5)
193 #define UNUSED __attribute__((unused)) \
194 __attribute__((deprecated ("parameter declared as UNUSED")))
195 #elif defined(__GNUC__)
196 #define UNUSED __attribute__((unused)) \
197 __attribute__((deprecated))
198 #else
199 #define UNUSED
200 #endif
202 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
203 # if !defined(_WIN32_WINNT)
204 # define _WIN32_WINNT 0x0600
205 # endif
206 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
207 #include <winsock2.h>
208 #ifndef NO_UNIX_SOCKETS
209 #include <afunix.h>
210 #endif
211 #include <windows.h>
212 #define GIT_WINDOWS_NATIVE
213 #endif
215 #include <unistd.h>
216 #include <stdio.h>
217 #include <sys/stat.h>
218 #include <fcntl.h>
219 #include <stddef.h>
220 #include <stdlib.h>
221 #include <stdarg.h>
222 #include <string.h>
223 #ifdef HAVE_STRINGS_H
224 #include <strings.h> /* for strcasecmp() */
225 #endif
226 #include <errno.h>
227 #include <limits.h>
228 #include <locale.h>
229 #ifdef NEEDS_SYS_PARAM_H
230 #include <sys/param.h>
231 #endif
232 #include <sys/types.h>
233 #include <dirent.h>
234 #include <sys/time.h>
235 #include <time.h>
236 #include <signal.h>
237 #include <assert.h>
238 #include <regex.h>
239 #include <utime.h>
240 #include <syslog.h>
241 #if !defined(NO_POLL_H)
242 #include <poll.h>
243 #elif !defined(NO_SYS_POLL_H)
244 #include <sys/poll.h>
245 #else
246 /* Pull the compat stuff */
247 #include <poll.h>
248 #endif
249 #ifdef HAVE_BSD_SYSCTL
250 #include <sys/sysctl.h>
251 #endif
253 /* Used by compat/win32/path-utils.h, and more */
254 static inline int is_xplatform_dir_sep(int c)
256 return c == '/' || c == '\\';
259 #if defined(__CYGWIN__)
260 #include "compat/win32/path-utils.h"
261 #endif
262 #if defined(__MINGW32__)
263 /* pull in Windows compatibility stuff */
264 #include "compat/win32/path-utils.h"
265 #include "compat/mingw.h"
266 #elif defined(_MSC_VER)
267 #include "compat/win32/path-utils.h"
268 #include "compat/msvc.h"
269 #else
270 #include <sys/utsname.h>
271 #include <sys/wait.h>
272 #include <sys/resource.h>
273 #include <sys/socket.h>
274 #include <sys/ioctl.h>
275 #include <sys/statvfs.h>
276 #include <termios.h>
277 #ifndef NO_SYS_SELECT_H
278 #include <sys/select.h>
279 #endif
280 #include <netinet/in.h>
281 #include <netinet/tcp.h>
282 #include <arpa/inet.h>
283 #include <netdb.h>
284 #include <pwd.h>
285 #include <sys/un.h>
286 #ifndef NO_INTTYPES_H
287 #include <inttypes.h>
288 #else
289 #include <stdint.h>
290 #endif
291 #ifdef HAVE_ARC4RANDOM_LIBBSD
292 #include <bsd/stdlib.h>
293 #endif
294 #ifdef HAVE_GETRANDOM
295 #include <sys/random.h>
296 #endif
297 #ifdef NO_INTPTR_T
299 * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
300 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
301 * while on IP16 and IP16L32 it is "int" (resp. "short")
302 * Size needs to match (or exceed) 'sizeof(void *)'.
303 * We can't take "long long" here as not everybody has it.
305 typedef long intptr_t;
306 typedef unsigned long uintptr_t;
307 #endif
308 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
309 #include <grp.h>
310 #define _ALL_SOURCE 1
311 #endif
313 /* used on Mac OS X */
314 #ifdef PRECOMPOSE_UNICODE
315 #include "compat/precompose_utf8.h"
316 #else
317 static inline const char *precompose_argv_prefix(int argc UNUSED,
318 const char **argv UNUSED,
319 const char *prefix)
321 return prefix;
323 static inline const char *precompose_string_if_needed(const char *in)
325 return in;
328 #define probe_utf8_pathname_composition()
329 #endif
331 #ifdef MKDIR_WO_TRAILING_SLASH
332 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
333 int compat_mkdir_wo_trailing_slash(const char*, mode_t);
334 #endif
336 #ifdef NO_STRUCT_ITIMERVAL
337 struct itimerval {
338 struct timeval it_interval;
339 struct timeval it_value;
341 #endif
343 #ifdef NO_SETITIMER
344 static inline int git_setitimer(int which UNUSED,
345 const struct itimerval *value UNUSED,
346 struct itimerval *newvalue UNUSED) {
347 return 0; /* pretend success */
349 #undef setitimer
350 #define setitimer(which,value,ovalue) git_setitimer(which,value,ovalue)
351 #endif
353 #ifndef NO_LIBGEN_H
354 #include <libgen.h>
355 #else
356 #define basename gitbasename
357 char *gitbasename(char *);
358 #define dirname gitdirname
359 char *gitdirname(char *);
360 #endif
362 #ifndef NO_ICONV
363 #include <iconv.h>
364 #endif
366 #ifndef NO_OPENSSL
367 #ifdef __APPLE__
368 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
369 #include <AvailabilityMacros.h>
370 #undef DEPRECATED_ATTRIBUTE
371 #define DEPRECATED_ATTRIBUTE
372 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
373 #endif
374 #include <openssl/ssl.h>
375 #include <openssl/err.h>
376 #endif
378 #ifdef HAVE_SYSINFO
379 # include <sys/sysinfo.h>
380 #endif
382 /* On most systems <netdb.h> would have given us this, but
383 * not on some systems (e.g. z/OS).
385 #ifndef NI_MAXHOST
386 #define NI_MAXHOST 1025
387 #endif
389 #ifndef NI_MAXSERV
390 #define NI_MAXSERV 32
391 #endif
393 /* On most systems <limits.h> would have given us this, but
394 * not on some systems (e.g. GNU/Hurd).
396 #ifndef PATH_MAX
397 #define PATH_MAX 4096
398 #endif
400 typedef uintmax_t timestamp_t;
401 #define PRItime PRIuMAX
402 #define parse_timestamp strtoumax
403 #define TIME_MAX UINTMAX_MAX
404 #define TIME_MIN 0
406 #ifndef PATH_SEP
407 #define PATH_SEP ':'
408 #endif
410 #ifdef HAVE_PATHS_H
411 #include <paths.h>
412 #endif
413 #ifndef _PATH_DEFPATH
414 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
415 #endif
417 #ifndef platform_core_config
418 static inline int noop_core_config(const char *var UNUSED,
419 const char *value UNUSED,
420 void *cb UNUSED)
422 return 0;
424 #define platform_core_config noop_core_config
425 #endif
427 int lstat_cache_aware_rmdir(const char *path);
428 #if !defined(__MINGW32__) && !defined(_MSC_VER)
429 #define rmdir lstat_cache_aware_rmdir
430 #endif
432 #ifndef has_dos_drive_prefix
433 static inline int git_has_dos_drive_prefix(const char *path UNUSED)
435 return 0;
437 #define has_dos_drive_prefix git_has_dos_drive_prefix
438 #endif
440 #ifndef skip_dos_drive_prefix
441 static inline int git_skip_dos_drive_prefix(char **path UNUSED)
443 return 0;
445 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
446 #endif
448 static inline int git_is_dir_sep(int c)
450 return c == '/';
452 #ifndef is_dir_sep
453 #define is_dir_sep git_is_dir_sep
454 #endif
456 #ifndef offset_1st_component
457 static inline int git_offset_1st_component(const char *path)
459 return is_dir_sep(path[0]);
461 #define offset_1st_component git_offset_1st_component
462 #endif
464 #ifndef is_valid_path
465 #define is_valid_path(path) 1
466 #endif
468 #ifndef is_path_owned_by_current_user
470 #ifdef __TANDEM
471 #define ROOT_UID 65535
472 #else
473 #define ROOT_UID 0
474 #endif
477 * Do not use this function when
478 * (1) geteuid() did not say we are running as 'root', or
479 * (2) using this function will compromise the system.
481 * PORTABILITY WARNING:
482 * This code assumes uid_t is unsigned because that is what sudo does.
483 * If your uid_t type is signed and all your ids are positive then it
484 * should all work fine.
485 * If your version of sudo uses negative values for uid_t or it is
486 * buggy and return an overflowed value in SUDO_UID, then git might
487 * fail to grant access to your repository properly or even mistakenly
488 * grant access to someone else.
489 * In the unlikely scenario this happened to you, and that is how you
490 * got to this message, we would like to know about it; so sent us an
491 * email to git@vger.kernel.org indicating which platform you are
492 * using and which version of sudo, so we can improve this logic and
493 * maybe provide you with a patch that would prevent this issue again
494 * in the future.
496 static inline void extract_id_from_env(const char *env, uid_t *id)
498 const char *real_uid = getenv(env);
500 /* discard anything empty to avoid a more complex check below */
501 if (real_uid && *real_uid) {
502 char *endptr = NULL;
503 unsigned long env_id;
505 errno = 0;
506 /* silent overflow errors could trigger a bug here */
507 env_id = strtoul(real_uid, &endptr, 10);
508 if (!*endptr && !errno)
509 *id = env_id;
513 static inline int is_path_owned_by_current_uid(const char *path,
514 struct strbuf *report UNUSED)
516 struct stat st;
517 uid_t euid;
519 if (lstat(path, &st))
520 return 0;
522 euid = geteuid();
523 if (euid == ROOT_UID)
525 if (st.st_uid == ROOT_UID)
526 return 1;
527 else
528 extract_id_from_env("SUDO_UID", &euid);
531 return st.st_uid == euid;
534 #define is_path_owned_by_current_user is_path_owned_by_current_uid
535 #endif
537 #ifndef find_last_dir_sep
538 static inline char *git_find_last_dir_sep(const char *path)
540 return strrchr(path, '/');
542 #define find_last_dir_sep git_find_last_dir_sep
543 #endif
545 #ifndef has_dir_sep
546 static inline int git_has_dir_sep(const char *path)
548 return !!strchr(path, '/');
550 #define has_dir_sep(path) git_has_dir_sep(path)
551 #endif
553 #ifndef query_user_email
554 #define query_user_email() NULL
555 #endif
557 #ifdef __TANDEM
558 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
559 #include <floss.h(floss_getpwuid)>
560 #ifndef NSIG
562 * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
563 * known, by detective work using kill -l as a list is all signals
564 * instead of signal.h where it should be.
566 # define NSIG 100
567 #endif
568 #endif
570 #if defined(__HP_cc) && (__HP_cc >= 61000)
571 #define NORETURN __attribute__((noreturn))
572 #define NORETURN_PTR
573 #elif defined(__GNUC__) && !defined(NO_NORETURN)
574 #define NORETURN __attribute__((__noreturn__))
575 #define NORETURN_PTR __attribute__((__noreturn__))
576 #elif defined(_MSC_VER)
577 #define NORETURN __declspec(noreturn)
578 #define NORETURN_PTR
579 #else
580 #define NORETURN
581 #define NORETURN_PTR
582 #ifndef __GNUC__
583 #ifndef __attribute__
584 #define __attribute__(x)
585 #endif
586 #endif
587 #endif
589 /* The sentinel attribute is valid from gcc version 4.0 */
590 #if defined(__GNUC__) && (__GNUC__ >= 4)
591 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
592 /* warn_unused_result exists as of gcc 3.4.0, but be lazy and check 4.0 */
593 #define RESULT_MUST_BE_USED __attribute__ ((warn_unused_result))
594 #else
595 #define LAST_ARG_MUST_BE_NULL
596 #define RESULT_MUST_BE_USED
597 #endif
599 #define MAYBE_UNUSED __attribute__((__unused__))
601 #include "compat/bswap.h"
603 #include "wildmatch.h"
605 struct strbuf;
607 /* General helper functions */
608 NORETURN void usage(const char *err);
609 NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
610 NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
611 NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
612 int die_message(const char *err, ...) __attribute__((format (printf, 1, 2)));
613 int die_message_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
614 int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
615 int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
616 void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
617 void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
619 #ifndef NO_OPENSSL
620 #ifdef APPLE_COMMON_CRYPTO
621 #include "compat/apple-common-crypto.h"
622 #else
623 #include <openssl/evp.h>
624 #include <openssl/hmac.h>
625 #endif /* APPLE_COMMON_CRYPTO */
626 #include <openssl/x509v3.h>
627 #endif /* NO_OPENSSL */
629 #ifdef HAVE_OPENSSL_CSPRNG
630 #include <openssl/rand.h>
631 #endif
634 * Let callers be aware of the constant return value; this can help
635 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
636 * because other compilers may be confused by this.
638 #if defined(__GNUC__)
639 static inline int const_error(void)
641 return -1;
643 #define error(...) (error(__VA_ARGS__), const_error())
644 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
645 #endif
647 typedef void (*report_fn)(const char *, va_list params);
649 void set_die_routine(NORETURN_PTR report_fn routine);
650 report_fn get_die_message_routine(void);
651 void set_error_routine(report_fn routine);
652 report_fn get_error_routine(void);
653 void set_warn_routine(report_fn routine);
654 report_fn get_warn_routine(void);
655 void set_die_is_recursing_routine(int (*routine)(void));
657 int starts_with(const char *str, const char *prefix);
658 int istarts_with(const char *str, const char *prefix);
661 * If the string "str" begins with the string found in "prefix", return 1.
662 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
663 * the string right after the prefix).
665 * Otherwise, return 0 and leave "out" untouched.
667 * Examples:
669 * [extract branch name, fail if not a branch]
670 * if (!skip_prefix(ref, "refs/heads/", &branch)
671 * return -1;
673 * [skip prefix if present, otherwise use whole string]
674 * skip_prefix(name, "refs/heads/", &name);
676 static inline int skip_prefix(const char *str, const char *prefix,
677 const char **out)
679 do {
680 if (!*prefix) {
681 *out = str;
682 return 1;
684 } while (*str++ == *prefix++);
685 return 0;
689 * If the string "str" is the same as the string in "prefix", then the "arg"
690 * parameter is set to the "def" parameter and 1 is returned.
691 * If the string "str" begins with the string found in "prefix" and then a
692 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
693 * (i.e., to the point in the string right after the prefix and the "=" sign),
694 * and 1 is returned.
696 * Otherwise, return 0 and leave "arg" untouched.
698 * When we accept both a "--key" and a "--key=<val>" option, this function
699 * can be used instead of !strcmp(arg, "--key") and then
700 * skip_prefix(arg, "--key=", &arg) to parse such an option.
702 int skip_to_optional_arg_default(const char *str, const char *prefix,
703 const char **arg, const char *def);
705 static inline int skip_to_optional_arg(const char *str, const char *prefix,
706 const char **arg)
708 return skip_to_optional_arg_default(str, prefix, arg, "");
712 * Like skip_prefix, but promises never to read past "len" bytes of the input
713 * buffer, and returns the remaining number of bytes in "out" via "outlen".
715 static inline int skip_prefix_mem(const char *buf, size_t len,
716 const char *prefix,
717 const char **out, size_t *outlen)
719 size_t prefix_len = strlen(prefix);
720 if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
721 *out = buf + prefix_len;
722 *outlen = len - prefix_len;
723 return 1;
725 return 0;
729 * If buf ends with suffix, return 1 and subtract the length of the suffix
730 * from *len. Otherwise, return 0 and leave *len untouched.
732 static inline int strip_suffix_mem(const char *buf, size_t *len,
733 const char *suffix)
735 size_t suflen = strlen(suffix);
736 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
737 return 0;
738 *len -= suflen;
739 return 1;
743 * If str ends with suffix, return 1 and set *len to the size of the string
744 * without the suffix. Otherwise, return 0 and set *len to the size of the
745 * string.
747 * Note that we do _not_ NUL-terminate str to the new length.
749 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
751 *len = strlen(str);
752 return strip_suffix_mem(str, len, suffix);
755 static inline int ends_with(const char *str, const char *suffix)
757 size_t len;
758 return strip_suffix(str, suffix, &len);
761 #define SWAP(a, b) do { \
762 void *_swap_a_ptr = &(a); \
763 void *_swap_b_ptr = &(b); \
764 unsigned char _swap_buffer[sizeof(a)]; \
765 memcpy(_swap_buffer, _swap_a_ptr, sizeof(a)); \
766 memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) + \
767 BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b))); \
768 memcpy(_swap_b_ptr, _swap_buffer, sizeof(a)); \
769 } while (0)
771 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
773 #ifndef PROT_READ
774 #define PROT_READ 1
775 #define PROT_WRITE 2
776 #define MAP_PRIVATE 1
777 #endif
779 #define mmap git_mmap
780 #define munmap git_munmap
781 void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
782 int git_munmap(void *start, size_t length);
784 #else /* NO_MMAP || USE_WIN32_MMAP */
786 #include <sys/mman.h>
788 #endif /* NO_MMAP || USE_WIN32_MMAP */
790 #ifdef NO_MMAP
792 /* This value must be multiple of (pagesize * 2) */
793 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
795 #else /* NO_MMAP */
797 /* This value must be multiple of (pagesize * 2) */
798 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
799 (sizeof(void*) >= 8 \
800 ? 1 * 1024 * 1024 * 1024 \
801 : 32 * 1024 * 1024)
803 #endif /* NO_MMAP */
805 #ifndef MAP_FAILED
806 #define MAP_FAILED ((void *)-1)
807 #endif
809 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
810 #define on_disk_bytes(st) ((st).st_size)
811 #else
812 #define on_disk_bytes(st) ((st).st_blocks * 512)
813 #endif
815 #ifdef NEEDS_MODE_TRANSLATION
816 #undef S_IFMT
817 #undef S_IFREG
818 #undef S_IFDIR
819 #undef S_IFLNK
820 #undef S_IFBLK
821 #undef S_IFCHR
822 #undef S_IFIFO
823 #undef S_IFSOCK
824 #define S_IFMT 0170000
825 #define S_IFREG 0100000
826 #define S_IFDIR 0040000
827 #define S_IFLNK 0120000
828 #define S_IFBLK 0060000
829 #define S_IFCHR 0020000
830 #define S_IFIFO 0010000
831 #define S_IFSOCK 0140000
832 #ifdef stat
833 #undef stat
834 #endif
835 #define stat(path, buf) git_stat(path, buf)
836 int git_stat(const char *, struct stat *);
837 #ifdef fstat
838 #undef fstat
839 #endif
840 #define fstat(fd, buf) git_fstat(fd, buf)
841 int git_fstat(int, struct stat *);
842 #ifdef lstat
843 #undef lstat
844 #endif
845 #define lstat(path, buf) git_lstat(path, buf)
846 int git_lstat(const char *, struct stat *);
847 #endif
849 #define DEFAULT_PACKED_GIT_LIMIT \
850 ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
852 #ifdef NO_PREAD
853 #define pread git_pread
854 ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
855 #endif
857 * Forward decl that will remind us if its twin in cache.h changes.
858 * This function is used in compat/pread.c. But we can't include
859 * cache.h there.
861 ssize_t read_in_full(int fd, void *buf, size_t count);
863 #ifdef NO_SETENV
864 #define setenv gitsetenv
865 int gitsetenv(const char *, const char *, int);
866 #endif
868 #ifdef NO_MKDTEMP
869 #define mkdtemp gitmkdtemp
870 char *gitmkdtemp(char *);
871 #endif
873 #ifdef NO_UNSETENV
874 #define unsetenv gitunsetenv
875 int gitunsetenv(const char *);
876 #endif
878 #ifdef NO_STRCASESTR
879 #define strcasestr gitstrcasestr
880 char *gitstrcasestr(const char *haystack, const char *needle);
881 #endif
883 #ifdef NO_STRLCPY
884 #define strlcpy gitstrlcpy
885 size_t gitstrlcpy(char *, const char *, size_t);
886 #endif
888 #ifdef NO_STRTOUMAX
889 #define strtoumax gitstrtoumax
890 uintmax_t gitstrtoumax(const char *, char **, int);
891 #define strtoimax gitstrtoimax
892 intmax_t gitstrtoimax(const char *, char **, int);
893 #endif
895 #ifdef NO_HSTRERROR
896 #define hstrerror githstrerror
897 const char *githstrerror(int herror);
898 #endif
900 #ifdef NO_MEMMEM
901 #define memmem gitmemmem
902 void *gitmemmem(const void *haystack, size_t haystacklen,
903 const void *needle, size_t needlelen);
904 #endif
906 #ifdef OVERRIDE_STRDUP
907 #ifdef strdup
908 #undef strdup
909 #endif
910 #define strdup gitstrdup
911 char *gitstrdup(const char *s);
912 #endif
914 #ifdef NO_GETPAGESIZE
915 #define getpagesize() sysconf(_SC_PAGESIZE)
916 #endif
918 #ifndef O_CLOEXEC
919 #define O_CLOEXEC 0
920 #endif
922 #ifdef FREAD_READS_DIRECTORIES
923 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
924 # ifdef fopen
925 # undef fopen
926 # endif
927 # define fopen(a,b) git_fopen(a,b)
928 # endif
929 FILE *git_fopen(const char*, const char*);
930 #endif
932 #ifdef SNPRINTF_RETURNS_BOGUS
933 #ifdef snprintf
934 #undef snprintf
935 #endif
936 #define snprintf git_snprintf
937 int git_snprintf(char *str, size_t maxsize,
938 const char *format, ...);
939 #ifdef vsnprintf
940 #undef vsnprintf
941 #endif
942 #define vsnprintf git_vsnprintf
943 int git_vsnprintf(char *str, size_t maxsize,
944 const char *format, va_list ap);
945 #endif
947 #ifdef OPEN_RETURNS_EINTR
948 #undef open
949 #define open git_open_with_retry
950 int git_open_with_retry(const char *path, int flag, ...);
951 #endif
953 #ifdef __GLIBC_PREREQ
954 #if __GLIBC_PREREQ(2, 1)
955 #define HAVE_STRCHRNUL
956 #endif
957 #endif
959 #ifndef HAVE_STRCHRNUL
960 #define strchrnul gitstrchrnul
961 static inline char *gitstrchrnul(const char *s, int c)
963 while (*s && *s != c)
964 s++;
965 return (char *)s;
967 #endif
969 #ifdef NO_INET_PTON
970 int inet_pton(int af, const char *src, void *dst);
971 #endif
973 #ifdef NO_INET_NTOP
974 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
975 #endif
977 #ifdef NO_PTHREADS
978 #define atexit git_atexit
979 int git_atexit(void (*handler)(void));
980 #endif
982 static inline size_t st_add(size_t a, size_t b)
984 if (unsigned_add_overflows(a, b))
985 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
986 (uintmax_t)a, (uintmax_t)b);
987 return a + b;
989 #define st_add3(a,b,c) st_add(st_add((a),(b)),(c))
990 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
992 static inline size_t st_mult(size_t a, size_t b)
994 if (unsigned_mult_overflows(a, b))
995 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
996 (uintmax_t)a, (uintmax_t)b);
997 return a * b;
1000 static inline size_t st_sub(size_t a, size_t b)
1002 if (a < b)
1003 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
1004 (uintmax_t)a, (uintmax_t)b);
1005 return a - b;
1008 static inline size_t st_left_shift(size_t a, unsigned shift)
1010 if (unsigned_left_shift_overflows(a, shift))
1011 die("size_t overflow: %"PRIuMAX" << %u",
1012 (uintmax_t)a, shift);
1013 return a << shift;
1016 static inline unsigned long cast_size_t_to_ulong(size_t a)
1018 if (a != (unsigned long)a)
1019 die("object too large to read on this platform: %"
1020 PRIuMAX" is cut off to %lu",
1021 (uintmax_t)a, (unsigned long)a);
1022 return (unsigned long)a;
1025 static inline int cast_size_t_to_int(size_t a)
1027 if (a > INT_MAX)
1028 die("number too large to represent as int on this platform: %"PRIuMAX,
1029 (uintmax_t)a);
1030 return (int)a;
1034 * Limit size of IO chunks, because huge chunks only cause pain. OS X
1035 * 64-bit is buggy, returning EINVAL if len >= INT_MAX; and even in
1036 * the absence of bugs, large chunks can result in bad latencies when
1037 * you decide to kill the process.
1039 * We pick 8 MiB as our default, but if the platform defines SSIZE_MAX
1040 * that is smaller than that, clip it to SSIZE_MAX, as a call to
1041 * read(2) or write(2) larger than that is allowed to fail. As the last
1042 * resort, we allow a port to pass via CFLAGS e.g. "-DMAX_IO_SIZE=value"
1043 * to override this, if the definition of SSIZE_MAX given by the platform
1044 * is broken.
1046 #ifndef MAX_IO_SIZE
1047 # define MAX_IO_SIZE_DEFAULT (8*1024*1024)
1048 # if defined(SSIZE_MAX) && (SSIZE_MAX < MAX_IO_SIZE_DEFAULT)
1049 # define MAX_IO_SIZE SSIZE_MAX
1050 # else
1051 # define MAX_IO_SIZE MAX_IO_SIZE_DEFAULT
1052 # endif
1053 #endif
1055 #ifdef HAVE_ALLOCA_H
1056 # include <alloca.h>
1057 # define xalloca(size) (alloca(size))
1058 # define xalloca_free(p) do {} while (0)
1059 #else
1060 # define xalloca(size) (xmalloc(size))
1061 # define xalloca_free(p) (free(p))
1062 #endif
1063 char *xstrdup(const char *str);
1064 void *xmalloc(size_t size);
1065 void *xmallocz(size_t size);
1066 void *xmallocz_gently(size_t size);
1067 void *xmemdupz(const void *data, size_t len);
1068 char *xstrndup(const char *str, size_t len);
1069 void *xrealloc(void *ptr, size_t size);
1070 void *xcalloc(size_t nmemb, size_t size);
1071 void xsetenv(const char *name, const char *value, int overwrite);
1072 void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
1073 const char *mmap_os_err(void);
1074 void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
1075 int xopen(const char *path, int flags, ...);
1076 ssize_t xread(int fd, void *buf, size_t len);
1077 ssize_t xwrite(int fd, const void *buf, size_t len);
1078 ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
1079 int xdup(int fd);
1080 FILE *xfopen(const char *path, const char *mode);
1081 FILE *xfdopen(int fd, const char *mode);
1082 int xmkstemp(char *temp_filename);
1083 int xmkstemp_mode(char *temp_filename, int mode);
1084 char *xgetcwd(void);
1085 FILE *fopen_for_writing(const char *path);
1086 FILE *fopen_or_warn(const char *path, const char *mode);
1089 * Like strncmp, but only return zero if s is NUL-terminated and exactly len
1090 * characters long. If it is not, consider it greater than t.
1092 int xstrncmpz(const char *s, const char *t, size_t len);
1095 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
1096 * that ptr is used twice, so don't pass e.g. ptr++.
1098 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
1100 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
1101 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
1102 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
1104 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
1105 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
1106 static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
1108 if (n)
1109 memcpy(dst, src, st_mult(size, n));
1112 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
1113 BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
1114 static inline void move_array(void *dst, const void *src, size_t n, size_t size)
1116 if (n)
1117 memmove(dst, src, st_mult(size, n));
1121 * These functions help you allocate structs with flex arrays, and copy
1122 * the data directly into the array. For example, if you had:
1124 * struct foo {
1125 * int bar;
1126 * char name[FLEX_ARRAY];
1127 * };
1129 * you can do:
1131 * struct foo *f;
1132 * FLEX_ALLOC_MEM(f, name, src, len);
1134 * to allocate a "foo" with the contents of "src" in the "name" field.
1135 * The resulting struct is automatically zero'd, and the flex-array field
1136 * is NUL-terminated (whether the incoming src buffer was or not).
1138 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
1139 * but do want to store a pointer to some extra data in the same allocated
1140 * block. For example, if you have:
1142 * struct foo {
1143 * char *name;
1144 * int bar;
1145 * };
1147 * you can do:
1149 * struct foo *f;
1150 * FLEXPTR_ALLOC_STR(f, name, src);
1152 * and "name" will point to a block of memory after the struct, which will be
1153 * freed along with the struct (but the pointer can be repointed anywhere).
1155 * The *_STR variants accept a string parameter rather than a ptr/len
1156 * combination.
1158 * Note that these macros will evaluate the first parameter multiple
1159 * times, and it must be assignable as an lvalue.
1161 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
1162 size_t flex_array_len_ = (len); \
1163 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1164 memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
1165 } while (0)
1166 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
1167 size_t flex_array_len_ = (len); \
1168 (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1169 memcpy((x) + 1, (buf), flex_array_len_); \
1170 (x)->ptrname = (void *)((x)+1); \
1171 } while(0)
1172 #define FLEX_ALLOC_STR(x, flexname, str) \
1173 FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1174 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1175 FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1177 static inline char *xstrdup_or_null(const char *str)
1179 return str ? xstrdup(str) : NULL;
1182 static inline size_t xsize_t(off_t len)
1184 if (len < 0 || (uintmax_t) len > SIZE_MAX)
1185 die("Cannot handle files this big");
1186 return (size_t) len;
1189 __attribute__((format (printf, 3, 4)))
1190 int xsnprintf(char *dst, size_t max, const char *fmt, ...);
1192 #ifndef HOST_NAME_MAX
1193 #define HOST_NAME_MAX 256
1194 #endif
1196 int xgethostname(char *buf, size_t len);
1198 /* in ctype.c, for kwset users */
1199 extern const unsigned char tolower_trans_tbl[256];
1201 /* Sane ctype - no locale, and works with signed chars */
1202 #undef isascii
1203 #undef isspace
1204 #undef isdigit
1205 #undef isalpha
1206 #undef isalnum
1207 #undef isprint
1208 #undef islower
1209 #undef isupper
1210 #undef tolower
1211 #undef toupper
1212 #undef iscntrl
1213 #undef ispunct
1214 #undef isxdigit
1216 extern const unsigned char sane_ctype[256];
1217 #define GIT_SPACE 0x01
1218 #define GIT_DIGIT 0x02
1219 #define GIT_ALPHA 0x04
1220 #define GIT_GLOB_SPECIAL 0x08
1221 #define GIT_REGEX_SPECIAL 0x10
1222 #define GIT_PATHSPEC_MAGIC 0x20
1223 #define GIT_CNTRL 0x40
1224 #define GIT_PUNCT 0x80
1225 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1226 #define isascii(x) (((x) & ~0x7f) == 0)
1227 #define isspace(x) sane_istest(x,GIT_SPACE)
1228 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1229 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1230 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1231 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1232 #define islower(x) sane_iscase(x, 1)
1233 #define isupper(x) sane_iscase(x, 0)
1234 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1235 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1236 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1237 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1238 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1239 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1240 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1241 #define toupper(x) sane_case((unsigned char)(x), 0)
1242 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1244 static inline int sane_case(int x, int high)
1246 if (sane_istest(x, GIT_ALPHA))
1247 x = (x & ~0x20) | high;
1248 return x;
1251 static inline int sane_iscase(int x, int is_lower)
1253 if (!sane_istest(x, GIT_ALPHA))
1254 return 0;
1256 if (is_lower)
1257 return (x & 0x20) != 0;
1258 else
1259 return (x & 0x20) == 0;
1263 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1264 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1265 * locale-specific conversions).
1267 static inline int skip_iprefix(const char *str, const char *prefix,
1268 const char **out)
1270 do {
1271 if (!*prefix) {
1272 *out = str;
1273 return 1;
1275 } while (tolower(*str++) == tolower(*prefix++));
1276 return 0;
1279 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1281 unsigned long ul;
1282 char *p;
1284 errno = 0;
1285 /* negative values would be accepted by strtoul */
1286 if (strchr(s, '-'))
1287 return -1;
1288 ul = strtoul(s, &p, base);
1289 if (errno || *p || p == s || (unsigned int) ul != ul)
1290 return -1;
1291 *result = ul;
1292 return 0;
1295 static inline int strtol_i(char const *s, int base, int *result)
1297 long ul;
1298 char *p;
1300 errno = 0;
1301 ul = strtol(s, &p, base);
1302 if (errno || *p || p == s || (int) ul != ul)
1303 return -1;
1304 *result = ul;
1305 return 0;
1308 void git_stable_qsort(void *base, size_t nmemb, size_t size,
1309 int(*compar)(const void *, const void *));
1310 #ifdef INTERNAL_QSORT
1311 #define qsort git_stable_qsort
1312 #endif
1314 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1315 static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1316 int(*compar)(const void *, const void *))
1318 if (nmemb > 1)
1319 qsort(base, nmemb, size, compar);
1322 #define STABLE_QSORT(base, n, compar) \
1323 git_stable_qsort((base), (n), sizeof(*(base)), compar)
1325 #ifndef HAVE_ISO_QSORT_S
1326 int git_qsort_s(void *base, size_t nmemb, size_t size,
1327 int (*compar)(const void *, const void *, void *), void *ctx);
1328 #define qsort_s git_qsort_s
1329 #endif
1331 #define QSORT_S(base, n, compar, ctx) do { \
1332 if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1333 BUG("qsort_s() failed"); \
1334 } while (0)
1336 #ifndef REG_STARTEND
1337 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1338 #endif
1340 static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1341 size_t nmatch, regmatch_t pmatch[], int eflags)
1343 assert(nmatch > 0 && pmatch);
1344 pmatch[0].rm_so = 0;
1345 pmatch[0].rm_eo = size;
1346 return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1349 #ifdef USE_ENHANCED_BASIC_REGULAR_EXPRESSIONS
1350 int git_regcomp(regex_t *preg, const char *pattern, int cflags);
1351 #define regcomp git_regcomp
1352 #endif
1354 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1355 # define FORCE_DIR_SET_GID S_ISGID
1356 #else
1357 # define FORCE_DIR_SET_GID 0
1358 #endif
1360 #ifdef NO_NSEC
1361 #undef USE_NSEC
1362 #define ST_CTIME_NSEC(st) 0
1363 #define ST_MTIME_NSEC(st) 0
1364 #else
1365 #ifdef USE_ST_TIMESPEC
1366 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1367 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1368 #else
1369 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1370 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1371 #endif
1372 #endif
1374 #ifdef UNRELIABLE_FSTAT
1375 #define fstat_is_reliable() 0
1376 #else
1377 #define fstat_is_reliable() 1
1378 #endif
1380 #ifndef va_copy
1382 * Since an obvious implementation of va_list would be to make it a
1383 * pointer into the stack frame, a simple assignment will work on
1384 * many systems. But let's try to be more portable.
1386 #ifdef __va_copy
1387 #define va_copy(dst, src) __va_copy(dst, src)
1388 #else
1389 #define va_copy(dst, src) ((dst) = (src))
1390 #endif
1391 #endif
1393 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1394 extern int BUG_exit_code;
1396 /* usage.c: if bug() is called we should have a BUG_if_bug() afterwards */
1397 extern int bug_called_must_BUG;
1399 __attribute__((format (printf, 3, 4))) NORETURN
1400 void BUG_fl(const char *file, int line, const char *fmt, ...);
1401 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1402 __attribute__((format (printf, 3, 4)))
1403 void bug_fl(const char *file, int line, const char *fmt, ...);
1404 #define bug(...) bug_fl(__FILE__, __LINE__, __VA_ARGS__)
1405 #define BUG_if_bug(...) do { \
1406 if (bug_called_must_BUG) \
1407 BUG_fl(__FILE__, __LINE__, __VA_ARGS__); \
1408 } while (0)
1410 #ifndef FSYNC_METHOD_DEFAULT
1411 #ifdef __APPLE__
1412 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_WRITEOUT_ONLY
1413 #else
1414 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_FSYNC
1415 #endif
1416 #endif
1418 enum fsync_action {
1419 FSYNC_WRITEOUT_ONLY,
1420 FSYNC_HARDWARE_FLUSH
1424 * Issues an fsync against the specified file according to the specified mode.
1426 * FSYNC_WRITEOUT_ONLY attempts to use interfaces available on some operating
1427 * systems to flush the OS cache without issuing a flush command to the storage
1428 * controller. If those interfaces are unavailable, the function fails with
1429 * ENOSYS.
1431 * FSYNC_HARDWARE_FLUSH does an OS writeout and hardware flush to ensure that
1432 * changes are durable. It is not expected to fail.
1434 int git_fsync(int fd, enum fsync_action action);
1437 * Writes out trace statistics for fsync using the trace2 API.
1439 void trace_git_fsync_stats(void);
1442 * Preserves errno, prints a message, but gives no warning for ENOENT.
1443 * Returns 0 on success, which includes trying to unlink an object that does
1444 * not exist.
1446 int unlink_or_warn(const char *path);
1448 * Tries to unlink file. Returns 0 if unlink succeeded
1449 * or the file already didn't exist. Returns -1 and
1450 * appends a message to err suitable for
1451 * 'error("%s", err->buf)' on error.
1453 int unlink_or_msg(const char *file, struct strbuf *err);
1455 * Preserves errno, prints a message, but gives no warning for ENOENT.
1456 * Returns 0 on success, which includes trying to remove a directory that does
1457 * not exist.
1459 int rmdir_or_warn(const char *path);
1461 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1462 * the supplied file mode.
1464 int remove_or_warn(unsigned int mode, const char *path);
1467 * Call access(2), but warn for any error except "missing file"
1468 * (ENOENT or ENOTDIR).
1470 #define ACCESS_EACCES_OK (1U << 0)
1471 int access_or_warn(const char *path, int mode, unsigned flag);
1472 int access_or_die(const char *path, int mode, unsigned flag);
1474 /* Warn on an inaccessible file if errno indicates this is an error */
1475 int warn_on_fopen_errors(const char *path);
1478 * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent
1479 * may be racy. Do not use this as protection against an attacker who can
1480 * simultaneously create paths.
1482 int open_nofollow(const char *path, int flags);
1484 #ifndef SHELL_PATH
1485 # define SHELL_PATH "/bin/sh"
1486 #endif
1488 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1489 static inline void git_flockfile(FILE *fh UNUSED)
1491 ; /* nothing */
1493 static inline void git_funlockfile(FILE *fh UNUSED)
1495 ; /* nothing */
1497 #undef flockfile
1498 #undef funlockfile
1499 #undef getc_unlocked
1500 #define flockfile(fh) git_flockfile(fh)
1501 #define funlockfile(fh) git_funlockfile(fh)
1502 #define getc_unlocked(fh) getc(fh)
1503 #endif
1505 #ifdef FILENO_IS_A_MACRO
1506 int git_fileno(FILE *stream);
1507 # ifndef COMPAT_CODE_FILENO
1508 # undef fileno
1509 # define fileno(p) git_fileno(p)
1510 # endif
1511 #endif
1513 #ifdef NEED_ACCESS_ROOT_HANDLER
1514 int git_access(const char *path, int mode);
1515 # ifndef COMPAT_CODE_ACCESS
1516 # ifdef access
1517 # undef access
1518 # endif
1519 # define access(path, mode) git_access(path, mode)
1520 # endif
1521 #endif
1524 * Our code often opens a path to an optional file, to work on its
1525 * contents when we can successfully open it. We can ignore a failure
1526 * to open if such an optional file does not exist, but we do want to
1527 * report a failure in opening for other reasons (e.g. we got an I/O
1528 * error, or the file is there, but we lack the permission to open).
1530 * Call this function after seeing an error from open() or fopen() to
1531 * see if the errno indicates a missing file that we can safely ignore.
1533 static inline int is_missing_file_error(int errno_)
1535 return (errno_ == ENOENT || errno_ == ENOTDIR);
1538 int cmd_main(int, const char **);
1541 * Intercept all calls to exit() and route them to trace2 to
1542 * optionally emit a message before calling the real exit().
1544 int common_exit(const char *file, int line, int code);
1545 #define exit(code) exit(common_exit(__FILE__, __LINE__, (code)))
1548 * You can mark a stack variable with UNLEAK(var) to avoid it being
1549 * reported as a leak by tools like LSAN or valgrind. The argument
1550 * should generally be the variable itself (not its address and not what
1551 * it points to). It's safe to use this on pointers which may already
1552 * have been freed, or on pointers which may still be in use.
1554 * Use this _only_ for a variable that leaks by going out of scope at
1555 * program exit (so only from cmd_* functions or their direct helpers).
1556 * Normal functions, especially those which may be called multiple
1557 * times, should actually free their memory. This is only meant as
1558 * an annotation, and does nothing in non-leak-checking builds.
1560 #ifdef SUPPRESS_ANNOTATED_LEAKS
1561 void unleak_memory(const void *ptr, size_t len);
1562 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1563 #else
1564 #define UNLEAK(var) do {} while (0)
1565 #endif
1567 #define z_const
1568 #include <zlib.h>
1570 #if ZLIB_VERNUM < 0x1290
1572 * This is uncompress2, which is only available in zlib >= 1.2.9
1573 * (released as of early 2017). See compat/zlib-uncompress2.c.
1575 int uncompress2(Bytef *dest, uLongf *destLen, const Bytef *source,
1576 uLong *sourceLen);
1577 #endif
1580 * This include must come after system headers, since it introduces macros that
1581 * replace system names.
1583 #include "banned.h"
1586 * container_of - Get the address of an object containing a field.
1588 * @ptr: pointer to the field.
1589 * @type: type of the object.
1590 * @member: name of the field within the object.
1592 #define container_of(ptr, type, member) \
1593 ((type *) ((char *)(ptr) - offsetof(type, member)))
1596 * helper function for `container_of_or_null' to avoid multiple
1597 * evaluation of @ptr
1599 static inline void *container_of_or_null_offset(void *ptr, size_t offset)
1601 return ptr ? (char *)ptr - offset : NULL;
1605 * like `container_of', but allows returned value to be NULL
1607 #define container_of_or_null(ptr, type, member) \
1608 (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1611 * like offsetof(), but takes a pointer to a variable of type which
1612 * contains @member, instead of a specified type.
1613 * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1614 * everywhere.
1616 #if defined(__GNUC__) /* clang sets this, too */
1617 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1618 #else /* !__GNUC__ */
1619 #define OFFSETOF_VAR(ptr, member) \
1620 ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1621 #endif /* !__GNUC__ */
1623 void sleep_millisec(int millisec);
1626 * Generate len bytes from the system cryptographically secure PRNG.
1627 * Returns 0 on success and -1 on error, setting errno. The inability to
1628 * satisfy the full request is an error.
1630 int csprng_bytes(void *buf, size_t len);
1632 #endif