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