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