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