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