git-compat-util.h

   1 #ifndef GIT_COMPAT_UTIL_H
   2 #define GIT_COMPAT_UTIL_H
   3
   4 #if __STDC_VERSION__ - 0 < 199901L
   5 /*
   6  * Git is in a testing period for mandatory C99 support in the compiler.  If
   7  * your compiler is reasonably recent, you can try to enable C99 support (or,
   8  * for MSVC, C11 support).  If you encounter a problem and can't enable C99
   9  * support with your compiler (such as with "-std=gnu99") and don't have access
  10  * to one with this support, such as GCC or Clang, you can remove this #if
  11  * directive, but please report the details of your system to
  12  * git@vger.kernel.org.
  13  */
  14 #error "Required C99 support is in a test phase.  Please see git-compat-util.h for more details."
  15 #endif
  16
  17 #ifdef USE_MSVC_CRTDBG
  18 /*
  19  * For these to work they must appear very early in each
  20  * file -- before most of the standard header files.
  21  */
  22 #include <stdlib.h>
  23 #include <crtdbg.h>
  24 #endif
  25
  26 #define _FILE_OFFSET_BITS 64
  27
  28
  29 /* Derived from Linux "Features Test Macro" header
  30  * Convenience macros to test the versions of gcc (or
  31  * a compatible compiler).
  32  * Use them like this:
  33  *  #if GIT_GNUC_PREREQ (2,8)
  34  *   ... code requiring gcc 2.8 or later ...
  35  *  #endif
  36 */
  37 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
  38 # define GIT_GNUC_PREREQ(maj, min) \
  39         ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  40 #else
  41  #define GIT_GNUC_PREREQ(maj, min) 0
  42 #endif
  43
  44
  45 #ifndef FLEX_ARRAY
  46 /*
  47  * See if our compiler is known to support flexible array members.
  48  */
  49 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
  50 # define FLEX_ARRAY /* empty */
  51 #elif defined(__GNUC__)
  52 # if (__GNUC__ >= 3)
  53 #  define FLEX_ARRAY /* empty */
  54 # else
  55 #  define FLEX_ARRAY 0 /* older GNU extension */
  56 # endif
  57 #endif
  58
  59 /*
  60  * Otherwise, default to safer but a bit wasteful traditional style
  61  */
  62 #ifndef FLEX_ARRAY
  63 # define FLEX_ARRAY 1
  64 #endif
  65 #endif
  66
  67
  68 /*
  69  * BUILD_ASSERT_OR_ZERO - assert a build-time dependency, as an expression.
  70  * @cond: the compile-time condition which must be true.
  71  *
  72  * Your compile will fail if the condition isn't true, or can't be evaluated
  73  * by the compiler.  This can be used in an expression: its value is "0".
  74  *
  75  * Example:
  76  *      #define foo_to_char(foo)                                        \
  77  *               ((char *)(foo)                                         \
  78  *                + BUILD_ASSERT_OR_ZERO(offsetof(struct foo, string) == 0))
  79  */
  80 #define BUILD_ASSERT_OR_ZERO(cond) \
  81         (sizeof(char [1 - 2*!(cond)]) - 1)
  82
  83 #if GIT_GNUC_PREREQ(3, 1)
  84  /* &arr[0] degrades to a pointer: a different type from an array */
  85 # define BARF_UNLESS_AN_ARRAY(arr)                                              \
  86         BUILD_ASSERT_OR_ZERO(!__builtin_types_compatible_p(__typeof__(arr), \
  87                                                            __typeof__(&(arr)[0])))
  88 #else
  89 # define BARF_UNLESS_AN_ARRAY(arr) 0
  90 #endif
  91 /*
  92  * ARRAY_SIZE - get the number of elements in a visible array
  93  * @x: the array whose size you want.
  94  *
  95  * This does not work on pointers, or arrays declared as [], or
  96  * function parameters.  With correct compiler support, such usage
  97  * will cause a build error (see the build_assert_or_zero macro).
  98  */
  99 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]) + BARF_UNLESS_AN_ARRAY(x))
 100
 101 #define bitsizeof(x)  (CHAR_BIT * sizeof(x))
 102
 103 #define maximum_signed_value_of_type(a) \
 104     (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
 105
 106 #define maximum_unsigned_value_of_type(a) \
 107     (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
 108
 109 /*
 110  * Signed integer overflow is undefined in C, so here's a helper macro
 111  * to detect if the sum of two integers will overflow.
 112  *
 113  * Requires: a >= 0, typeof(a) equals typeof(b)
 114  */
 115 #define signed_add_overflows(a, b) \
 116     ((b) > maximum_signed_value_of_type(a) - (a))
 117
 118 #define unsigned_add_overflows(a, b) \
 119     ((b) > maximum_unsigned_value_of_type(a) - (a))
 120
 121 /*
 122  * Returns true if the multiplication of "a" and "b" will
 123  * overflow. The types of "a" and "b" must match and must be unsigned.
 124  * Note that this macro evaluates "a" twice!
 125  */
 126 #define unsigned_mult_overflows(a, b) \
 127     ((a) && (b) > maximum_unsigned_value_of_type(a) / (a))
 128
 129 /*
 130  * Returns true if the left shift of "a" by "shift" bits will
 131  * overflow. The type of "a" must be unsigned.
 132  */
 133 #define unsigned_left_shift_overflows(a, shift) \
 134     ((shift) < bitsizeof(a) && \
 135      (a) > maximum_unsigned_value_of_type(a) >> (shift))
 136
 137 #ifdef __GNUC__
 138 #define TYPEOF(x) (__typeof__(x))
 139 #else
 140 #define TYPEOF(x)
 141 #endif
 142
 143 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
 144 #define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
 145
 146 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
 147
 148 /* Approximation of the length of the decimal representation of this type. */
 149 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
 150
 151 #ifdef __MINGW64__
 152 #define _POSIX_C_SOURCE 1
 153 #elif defined(__sun__)
 154  /*
 155   * On Solaris, when _XOPEN_EXTENDED is set, its header file
 156   * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
 157   * setting to say we are XPG5 or XPG6.  Also on Solaris,
 158   * XPG6 programs must be compiled with a c99 compiler, while
 159   * non XPG6 programs must be compiled with a pre-c99 compiler.
 160   */
 161 # if __STDC_VERSION__ - 0 >= 199901L
 162 # define _XOPEN_SOURCE 600
 163 # else
 164 # define _XOPEN_SOURCE 500
 165 # endif
 166 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
 167       !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
 168       !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
 169       !defined(__CYGWIN__)
 170 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
 171 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
 172 #endif
 173 #define _ALL_SOURCE 1
 174 #define _GNU_SOURCE 1
 175 #define _BSD_SOURCE 1
 176 #define _DEFAULT_SOURCE 1
 177 #define _NETBSD_SOURCE 1
 178 #define _SGI_SOURCE 1
 179
 180 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
 181 # if !defined(_WIN32_WINNT)
 182 #  define _WIN32_WINNT 0x0600
 183 # endif
 184 #define WIN32_LEAN_AND_MEAN  /* stops windows.h including winsock.h */
 185 #include <winsock2.h>
 186 #ifndef NO_UNIX_SOCKETS
 187 #include <afunix.h>
 188 #endif
 189 #include <windows.h>
 190 #define GIT_WINDOWS_NATIVE
 191 #endif
 192
 193 #include <unistd.h>
 194 #include <stdio.h>
 195 #include <sys/stat.h>
 196 #include <fcntl.h>
 197 #include <stddef.h>
 198 #include <stdlib.h>
 199 #include <stdarg.h>
 200 #include <string.h>
 201 #ifdef HAVE_STRINGS_H
 202 #include <strings.h> /* for strcasecmp() */
 203 #endif
 204 #include <errno.h>
 205 #include <limits.h>
 206 #ifdef NEEDS_SYS_PARAM_H
 207 #include <sys/param.h>
 208 #endif
 209 #include <sys/types.h>
 210 #include <dirent.h>
 211 #include <sys/time.h>
 212 #include <time.h>
 213 #include <signal.h>
 214 #include <assert.h>
 215 #include <regex.h>
 216 #include <utime.h>
 217 #include <syslog.h>
 218 #if !defined(NO_POLL_H)
 219 #include <poll.h>
 220 #elif !defined(NO_SYS_POLL_H)
 221 #include <sys/poll.h>
 222 #else
 223 /* Pull the compat stuff */
 224 #include <poll.h>
 225 #endif
 226 #ifdef HAVE_BSD_SYSCTL
 227 #include <sys/sysctl.h>
 228 #endif
 229
 230 #if defined(__CYGWIN__)
 231 #include "compat/win32/path-utils.h"
 232 #endif
 233 #if defined(__MINGW32__)
 234 /* pull in Windows compatibility stuff */
 235 #include "compat/win32/path-utils.h"
 236 #include "compat/mingw.h"
 237 #elif defined(_MSC_VER)
 238 #include "compat/win32/path-utils.h"
 239 #include "compat/msvc.h"
 240 #else
 241 #include <sys/utsname.h>
 242 #include <sys/wait.h>
 243 #include <sys/resource.h>
 244 #include <sys/socket.h>
 245 #include <sys/ioctl.h>
 246 #include <termios.h>
 247 #ifndef NO_SYS_SELECT_H
 248 #include <sys/select.h>
 249 #endif
 250 #include <netinet/in.h>
 251 #include <netinet/tcp.h>
 252 #include <arpa/inet.h>
 253 #include <netdb.h>
 254 #include <pwd.h>
 255 #include <sys/un.h>
 256 #ifndef NO_INTTYPES_H
 257 #include <inttypes.h>
 258 #else
 259 #include <stdint.h>
 260 #endif
 261 #ifdef NO_INTPTR_T
 262 /*
 263  * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
 264  * on LLP86, IL33LLP64 and P64 it needs to be "long long",
 265  * while on IP16 and IP16L32 it is "int" (resp. "short")
 266  * Size needs to match (or exceed) 'sizeof(void *)'.
 267  * We can't take "long long" here as not everybody has it.
 268  */
 269 typedef long intptr_t;
 270 typedef unsigned long uintptr_t;
 271 #endif
 272 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
 273 #include <grp.h>
 274 #define _ALL_SOURCE 1
 275 #endif
 276
 277 /* used on Mac OS X */
 278 #ifdef PRECOMPOSE_UNICODE
 279 #include "compat/precompose_utf8.h"
 280 #else
 281 static inline const char *precompose_argv_prefix(int argc, const char **argv, const char *prefix)
 282 {
 283         return prefix;
 284 }
 285 static inline const char *precompose_string_if_needed(const char *in)
 286 {
 287         return in;
 288 }
 289
 290 #define probe_utf8_pathname_composition()
 291 #endif
 292
 293 #ifdef MKDIR_WO_TRAILING_SLASH
 294 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
 295 int compat_mkdir_wo_trailing_slash(const char*, mode_t);
 296 #endif
 297
 298 #ifdef NO_STRUCT_ITIMERVAL
 299 struct itimerval {
 300         struct timeval it_interval;
 301         struct timeval it_value;
 302 };
 303 #endif
 304
 305 #ifdef NO_SETITIMER
 306 static inline int setitimer(int which, const struct itimerval *value, struct itimerval *newvalue) {
 307         return 0; /* pretend success */
 308 }
 309 #endif
 310
 311 #ifndef NO_LIBGEN_H
 312 #include <libgen.h>
 313 #else
 314 #define basename gitbasename
 315 char *gitbasename(char *);
 316 #define dirname gitdirname
 317 char *gitdirname(char *);
 318 #endif
 319
 320 #ifndef NO_ICONV
 321 #include <iconv.h>
 322 #endif
 323
 324 #ifndef NO_OPENSSL
 325 #ifdef __APPLE__
 326 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
 327 #include <AvailabilityMacros.h>
 328 #undef DEPRECATED_ATTRIBUTE
 329 #define DEPRECATED_ATTRIBUTE
 330 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
 331 #endif
 332 #include <openssl/ssl.h>
 333 #include <openssl/err.h>
 334 #endif
 335
 336 #ifdef HAVE_SYSINFO
 337 # include <sys/sysinfo.h>
 338 #endif
 339
 340 /* On most systems <netdb.h> would have given us this, but
 341  * not on some systems (e.g. z/OS).
 342  */
 343 #ifndef NI_MAXHOST
 344 #define NI_MAXHOST 1025
 345 #endif
 346
 347 #ifndef NI_MAXSERV
 348 #define NI_MAXSERV 32
 349 #endif
 350
 351 /* On most systems <limits.h> would have given us this, but
 352  * not on some systems (e.g. GNU/Hurd).
 353  */
 354 #ifndef PATH_MAX
 355 #define PATH_MAX 4096
 356 #endif
 357
 358 typedef uintmax_t timestamp_t;
 359 #define PRItime PRIuMAX
 360 #define parse_timestamp strtoumax
 361 #define TIME_MAX UINTMAX_MAX
 362 #define TIME_MIN 0
 363
 364 #ifndef PATH_SEP
 365 #define PATH_SEP ':'
 366 #endif
 367
 368 #ifdef HAVE_PATHS_H
 369 #include <paths.h>
 370 #endif
 371 #ifndef _PATH_DEFPATH
 372 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
 373 #endif
 374
 375 #ifndef platform_core_config
 376 static inline int noop_core_config(const char *var, const char *value, void *cb)
 377 {
 378         return 0;
 379 }
 380 #define platform_core_config noop_core_config
 381 #endif
 382
 383 int lstat_cache_aware_rmdir(const char *path);
 384 #if !defined(__MINGW32__) && !defined(_MSC_VER)
 385 #define rmdir lstat_cache_aware_rmdir
 386 #endif
 387
 388 #ifndef has_dos_drive_prefix
 389 static inline int git_has_dos_drive_prefix(const char *path)
 390 {
 391         return 0;
 392 }
 393 #define has_dos_drive_prefix git_has_dos_drive_prefix
 394 #endif
 395
 396 #ifndef skip_dos_drive_prefix
 397 static inline int git_skip_dos_drive_prefix(char **path)
 398 {
 399         return 0;
 400 }
 401 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
 402 #endif
 403
 404 #ifndef is_dir_sep
 405 static inline int git_is_dir_sep(int c)
 406 {
 407         return c == '/';
 408 }
 409 #define is_dir_sep git_is_dir_sep
 410 #endif
 411
 412 #ifndef offset_1st_component
 413 static inline int git_offset_1st_component(const char *path)
 414 {
 415         return is_dir_sep(path[0]);
 416 }
 417 #define offset_1st_component git_offset_1st_component
 418 #endif
 419
 420 #ifndef is_valid_path
 421 #define is_valid_path(path) 1
 422 #endif
 423
 424 #ifndef find_last_dir_sep
 425 static inline char *git_find_last_dir_sep(const char *path)
 426 {
 427         return strrchr(path, '/');
 428 }
 429 #define find_last_dir_sep git_find_last_dir_sep
 430 #endif
 431
 432 #ifndef has_dir_sep
 433 static inline int git_has_dir_sep(const char *path)
 434 {
 435         return !!strchr(path, '/');
 436 }
 437 #define has_dir_sep(path) git_has_dir_sep(path)
 438 #endif
 439
 440 #ifndef query_user_email
 441 #define query_user_email() NULL
 442 #endif
 443
 444 #ifdef __TANDEM
 445 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
 446 #include <floss.h(floss_getpwuid)>
 447 #ifndef NSIG
 448 /*
 449  * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
 450  * known, by detective work using kill -l as a list is all signals
 451  * instead of signal.h where it should be.
 452  */
 453 # define NSIG 100
 454 #endif
 455 #endif
 456
 457 #if defined(__HP_cc) && (__HP_cc >= 61000)
 458 #define NORETURN __attribute__((noreturn))
 459 #define NORETURN_PTR
 460 #elif defined(__GNUC__) && !defined(NO_NORETURN)
 461 #define NORETURN __attribute__((__noreturn__))
 462 #define NORETURN_PTR __attribute__((__noreturn__))
 463 #elif defined(_MSC_VER)
 464 #define NORETURN __declspec(noreturn)
 465 #define NORETURN_PTR
 466 #else
 467 #define NORETURN
 468 #define NORETURN_PTR
 469 #ifndef __GNUC__
 470 #ifndef __attribute__
 471 #define __attribute__(x)
 472 #endif
 473 #endif
 474 #endif
 475
 476 /* The sentinel attribute is valid from gcc version 4.0 */
 477 #if defined(__GNUC__) && (__GNUC__ >= 4)
 478 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
 479 #else
 480 #define LAST_ARG_MUST_BE_NULL
 481 #endif
 482
 483 #define MAYBE_UNUSED __attribute__((__unused__))
 484
 485 #include "compat/bswap.h"
 486
 487 #include "wildmatch.h"
 488
 489 struct strbuf;
 490
 491 /* General helper functions */
 492 void vreportf(const char *prefix, const char *err, va_list params);
 493 NORETURN void usage(const char *err);
 494 NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
 495 NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
 496 NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 497 int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 498 int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 499 void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 500 void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 501
 502 #ifndef NO_OPENSSL
 503 #ifdef APPLE_COMMON_CRYPTO
 504 #include "compat/apple-common-crypto.h"
 505 #else
 506 #include <openssl/evp.h>
 507 #include <openssl/hmac.h>
 508 #endif /* APPLE_COMMON_CRYPTO */
 509 #include <openssl/x509v3.h>
 510 #endif /* NO_OPENSSL */
 511
 512 /*
 513  * Let callers be aware of the constant return value; this can help
 514  * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
 515  * because some compilers may not support variadic macros. Since we're only
 516  * trying to help gcc, anyway, it's OK; other compilers will fall back to
 517  * using the function as usual.
 518  */
 519 #if defined(__GNUC__)
 520 static inline int const_error(void)
 521 {
 522         return -1;
 523 }
 524 #define error(...) (error(__VA_ARGS__), const_error())
 525 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
 526 #endif
 527
 528 typedef void (*report_fn)(const char *, va_list params);
 529
 530 void set_die_routine(NORETURN_PTR report_fn routine);
 531 void set_error_routine(report_fn routine);
 532 report_fn get_error_routine(void);
 533 void set_warn_routine(report_fn routine);
 534 report_fn get_warn_routine(void);
 535 void set_die_is_recursing_routine(int (*routine)(void));
 536
 537 int starts_with(const char *str, const char *prefix);
 538 int istarts_with(const char *str, const char *prefix);
 539
 540 /*
 541  * If the string "str" begins with the string found in "prefix", return 1.
 542  * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
 543  * the string right after the prefix).
 544  *
 545  * Otherwise, return 0 and leave "out" untouched.
 546  *
 547  * Examples:
 548  *
 549  *   [extract branch name, fail if not a branch]
 550  *   if (!skip_prefix(ref, "refs/heads/", &branch)
 551  *      return -1;
 552  *
 553  *   [skip prefix if present, otherwise use whole string]
 554  *   skip_prefix(name, "refs/heads/", &name);
 555  */
 556 static inline int skip_prefix(const char *str, const char *prefix,
 557                               const char **out)
 558 {
 559         do {
 560                 if (!*prefix) {
 561                         *out = str;
 562                         return 1;
 563                 }
 564         } while (*str++ == *prefix++);
 565         return 0;
 566 }
 567
 568 /*
 569  * If the string "str" is the same as the string in "prefix", then the "arg"
 570  * parameter is set to the "def" parameter and 1 is returned.
 571  * If the string "str" begins with the string found in "prefix" and then a
 572  * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
 573  * (i.e., to the point in the string right after the prefix and the "=" sign),
 574  * and 1 is returned.
 575  *
 576  * Otherwise, return 0 and leave "arg" untouched.
 577  *
 578  * When we accept both a "--key" and a "--key=<val>" option, this function
 579  * can be used instead of !strcmp(arg, "--key") and then
 580  * skip_prefix(arg, "--key=", &arg) to parse such an option.
 581  */
 582 int skip_to_optional_arg_default(const char *str, const char *prefix,
 583                                  const char **arg, const char *def);
 584
 585 static inline int skip_to_optional_arg(const char *str, const char *prefix,
 586                                        const char **arg)
 587 {
 588         return skip_to_optional_arg_default(str, prefix, arg, "");
 589 }
 590
 591 /*
 592  * Like skip_prefix, but promises never to read past "len" bytes of the input
 593  * buffer, and returns the remaining number of bytes in "out" via "outlen".
 594  */
 595 static inline int skip_prefix_mem(const char *buf, size_t len,
 596                                   const char *prefix,
 597                                   const char **out, size_t *outlen)
 598 {
 599         size_t prefix_len = strlen(prefix);
 600         if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
 601                 *out = buf + prefix_len;
 602                 *outlen = len - prefix_len;
 603                 return 1;
 604         }
 605         return 0;
 606 }
 607
 608 /*
 609  * If buf ends with suffix, return 1 and subtract the length of the suffix
 610  * from *len. Otherwise, return 0 and leave *len untouched.
 611  */
 612 static inline int strip_suffix_mem(const char *buf, size_t *len,
 613                                    const char *suffix)
 614 {
 615         size_t suflen = strlen(suffix);
 616         if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
 617                 return 0;
 618         *len -= suflen;
 619         return 1;
 620 }
 621
 622 /*
 623  * If str ends with suffix, return 1 and set *len to the size of the string
 624  * without the suffix. Otherwise, return 0 and set *len to the size of the
 625  * string.
 626  *
 627  * Note that we do _not_ NUL-terminate str to the new length.
 628  */
 629 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
 630 {
 631         *len = strlen(str);
 632         return strip_suffix_mem(str, len, suffix);
 633 }
 634
 635 static inline int ends_with(const char *str, const char *suffix)
 636 {
 637         size_t len;
 638         return strip_suffix(str, suffix, &len);
 639 }
 640
 641 #define SWAP(a, b) do {                                         \
 642         void *_swap_a_ptr = &(a);                               \
 643         void *_swap_b_ptr = &(b);                               \
 644         unsigned char _swap_buffer[sizeof(a)];                  \
 645         memcpy(_swap_buffer, _swap_a_ptr, sizeof(a));           \
 646         memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) +            \
 647                BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b)));   \
 648         memcpy(_swap_b_ptr, _swap_buffer, sizeof(a));           \
 649 } while (0)
 650
 651 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 652
 653 #ifndef PROT_READ
 654 #define PROT_READ 1
 655 #define PROT_WRITE 2
 656 #define MAP_PRIVATE 1
 657 #endif
 658
 659 #define mmap git_mmap
 660 #define munmap git_munmap
 661 void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 662 int git_munmap(void *start, size_t length);
 663
 664 #else /* NO_MMAP || USE_WIN32_MMAP */
 665
 666 #include <sys/mman.h>
 667
 668 #endif /* NO_MMAP || USE_WIN32_MMAP */
 669
 670 #ifdef NO_MMAP
 671
 672 /* This value must be multiple of (pagesize * 2) */
 673 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 674
 675 #else /* NO_MMAP */
 676
 677 /* This value must be multiple of (pagesize * 2) */
 678 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 679         (sizeof(void*) >= 8 \
 680                 ?  1 * 1024 * 1024 * 1024 \
 681                 : 32 * 1024 * 1024)
 682
 683 #endif /* NO_MMAP */
 684
 685 #ifndef MAP_FAILED
 686 #define MAP_FAILED ((void *)-1)
 687 #endif
 688
 689 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 690 #define on_disk_bytes(st) ((st).st_size)
 691 #else
 692 #define on_disk_bytes(st) ((st).st_blocks * 512)
 693 #endif
 694
 695 #ifdef NEEDS_MODE_TRANSLATION
 696 #undef S_IFMT
 697 #undef S_IFREG
 698 #undef S_IFDIR
 699 #undef S_IFLNK
 700 #undef S_IFBLK
 701 #undef S_IFCHR
 702 #undef S_IFIFO
 703 #undef S_IFSOCK
 704 #define S_IFMT   0170000
 705 #define S_IFREG  0100000
 706 #define S_IFDIR  0040000
 707 #define S_IFLNK  0120000
 708 #define S_IFBLK  0060000
 709 #define S_IFCHR  0020000
 710 #define S_IFIFO  0010000
 711 #define S_IFSOCK 0140000
 712 #ifdef stat
 713 #undef stat
 714 #endif
 715 #define stat(path, buf) git_stat(path, buf)
 716 int git_stat(const char *, struct stat *);
 717 #ifdef fstat
 718 #undef fstat
 719 #endif
 720 #define fstat(fd, buf) git_fstat(fd, buf)
 721 int git_fstat(int, struct stat *);
 722 #ifdef lstat
 723 #undef lstat
 724 #endif
 725 #define lstat(path, buf) git_lstat(path, buf)
 726 int git_lstat(const char *, struct stat *);
 727 #endif
 728
 729 #define DEFAULT_PACKED_GIT_LIMIT \
 730         ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
 731
 732 #ifdef NO_PREAD
 733 #define pread git_pread
 734 ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 735 #endif
 736 /*
 737  * Forward decl that will remind us if its twin in cache.h changes.
 738  * This function is used in compat/pread.c.  But we can't include
 739  * cache.h there.
 740  */
 741 ssize_t read_in_full(int fd, void *buf, size_t count);
 742
 743 #ifdef NO_SETENV
 744 #define setenv gitsetenv
 745 int gitsetenv(const char *, const char *, int);
 746 #endif
 747
 748 #ifdef NO_MKDTEMP
 749 #define mkdtemp gitmkdtemp
 750 char *gitmkdtemp(char *);
 751 #endif
 752
 753 #ifdef NO_UNSETENV
 754 #define unsetenv gitunsetenv
 755 int gitunsetenv(const char *);
 756 #endif
 757
 758 #ifdef NO_STRCASESTR
 759 #define strcasestr gitstrcasestr
 760 char *gitstrcasestr(const char *haystack, const char *needle);
 761 #endif
 762
 763 #ifdef NO_STRLCPY
 764 #define strlcpy gitstrlcpy
 765 size_t gitstrlcpy(char *, const char *, size_t);
 766 #endif
 767
 768 #ifdef NO_STRTOUMAX
 769 #define strtoumax gitstrtoumax
 770 uintmax_t gitstrtoumax(const char *, char **, int);
 771 #define strtoimax gitstrtoimax
 772 intmax_t gitstrtoimax(const char *, char **, int);
 773 #endif
 774
 775 #ifdef NO_HSTRERROR
 776 #define hstrerror githstrerror
 777 const char *githstrerror(int herror);
 778 #endif
 779
 780 #ifdef NO_MEMMEM
 781 #define memmem gitmemmem
 782 void *gitmemmem(const void *haystack, size_t haystacklen,
 783                 const void *needle, size_t needlelen);
 784 #endif
 785
 786 #ifdef OVERRIDE_STRDUP
 787 #ifdef strdup
 788 #undef strdup
 789 #endif
 790 #define strdup gitstrdup
 791 char *gitstrdup(const char *s);
 792 #endif
 793
 794 #ifdef NO_GETPAGESIZE
 795 #define getpagesize() sysconf(_SC_PAGESIZE)
 796 #endif
 797
 798 #ifndef O_CLOEXEC
 799 #define O_CLOEXEC 0
 800 #endif
 801
 802 #ifdef FREAD_READS_DIRECTORIES
 803 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
 804 #  ifdef fopen
 805 #   undef fopen
 806 #  endif
 807 #  define fopen(a,b) git_fopen(a,b)
 808 # endif
 809 FILE *git_fopen(const char*, const char*);
 810 #endif
 811
 812 #ifdef SNPRINTF_RETURNS_BOGUS
 813 #ifdef snprintf
 814 #undef snprintf
 815 #endif
 816 #define snprintf git_snprintf
 817 int git_snprintf(char *str, size_t maxsize,
 818                  const char *format, ...);
 819 #ifdef vsnprintf
 820 #undef vsnprintf
 821 #endif
 822 #define vsnprintf git_vsnprintf
 823 int git_vsnprintf(char *str, size_t maxsize,
 824                   const char *format, va_list ap);
 825 #endif
 826
 827 #ifdef OPEN_RETURNS_EINTR
 828 #undef open
 829 #define open git_open_with_retry
 830 int git_open_with_retry(const char *path, int flag, ...);
 831 #endif
 832
 833 #ifdef __GLIBC_PREREQ
 834 #if __GLIBC_PREREQ(2, 1)
 835 #define HAVE_STRCHRNUL
 836 #endif
 837 #endif
 838
 839 #ifndef HAVE_STRCHRNUL
 840 #define strchrnul gitstrchrnul
 841 static inline char *gitstrchrnul(const char *s, int c)
 842 {
 843         while (*s && *s != c)
 844                 s++;
 845         return (char *)s;
 846 }
 847 #endif
 848
 849 #ifdef NO_INET_PTON
 850 int inet_pton(int af, const char *src, void *dst);
 851 #endif
 852
 853 #ifdef NO_INET_NTOP
 854 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
 855 #endif
 856
 857 #ifdef NO_PTHREADS
 858 #define atexit git_atexit
 859 int git_atexit(void (*handler)(void));
 860 #endif
 861
 862 static inline size_t st_add(size_t a, size_t b)
 863 {
 864         if (unsigned_add_overflows(a, b))
 865                 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
 866                     (uintmax_t)a, (uintmax_t)b);
 867         return a + b;
 868 }
 869 #define st_add3(a,b,c)   st_add(st_add((a),(b)),(c))
 870 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
 871
 872 static inline size_t st_mult(size_t a, size_t b)
 873 {
 874         if (unsigned_mult_overflows(a, b))
 875                 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
 876                     (uintmax_t)a, (uintmax_t)b);
 877         return a * b;
 878 }
 879
 880 static inline size_t st_sub(size_t a, size_t b)
 881 {
 882         if (a < b)
 883                 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
 884                     (uintmax_t)a, (uintmax_t)b);
 885         return a - b;
 886 }
 887
 888 static inline size_t st_left_shift(size_t a, unsigned shift)
 889 {
 890         if (unsigned_left_shift_overflows(a, shift))
 891                 die("size_t overflow: %"PRIuMAX" << %u",
 892                     (uintmax_t)a, shift);
 893         return a << shift;
 894 }
 895
 896 static inline unsigned long cast_size_t_to_ulong(size_t a)
 897 {
 898         if (a != (unsigned long)a)
 899                 die("object too large to read on this platform: %"
 900                     PRIuMAX" is cut off to %lu",
 901                     (uintmax_t)a, (unsigned long)a);
 902         return (unsigned long)a;
 903 }
 904
 905 #ifdef HAVE_ALLOCA_H
 906 # include <alloca.h>
 907 # define xalloca(size)      (alloca(size))
 908 # define xalloca_free(p)    do {} while (0)
 909 #else
 910 # define xalloca(size)      (xmalloc(size))
 911 # define xalloca_free(p)    (free(p))
 912 #endif
 913 char *xstrdup(const char *str);
 914 void *xmalloc(size_t size);
 915 void *xmallocz(size_t size);
 916 void *xmallocz_gently(size_t size);
 917 void *xmemdupz(const void *data, size_t len);
 918 char *xstrndup(const char *str, size_t len);
 919 void *xrealloc(void *ptr, size_t size);
 920 void *xcalloc(size_t nmemb, size_t size);
 921 void xsetenv(const char *name, const char *value, int overwrite);
 922 void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 923 const char *mmap_os_err(void);
 924 void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 925 int xopen(const char *path, int flags, ...);
 926 ssize_t xread(int fd, void *buf, size_t len);
 927 ssize_t xwrite(int fd, const void *buf, size_t len);
 928 ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
 929 int xdup(int fd);
 930 FILE *xfopen(const char *path, const char *mode);
 931 FILE *xfdopen(int fd, const char *mode);
 932 int xmkstemp(char *temp_filename);
 933 int xmkstemp_mode(char *temp_filename, int mode);
 934 char *xgetcwd(void);
 935 FILE *fopen_for_writing(const char *path);
 936 FILE *fopen_or_warn(const char *path, const char *mode);
 937
 938 /*
 939  * Like strncmp, but only return zero if s is NUL-terminated and exactly len
 940  * characters long.  If it is not, consider it greater than t.
 941  */
 942 int xstrncmpz(const char *s, const char *t, size_t len);
 943
 944 /*
 945  * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
 946  * that ptr is used twice, so don't pass e.g. ptr++.
 947  */
 948 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
 949
 950 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
 951 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
 952 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
 953
 954 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
 955         BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
 956 static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
 957 {
 958         if (n)
 959                 memcpy(dst, src, st_mult(size, n));
 960 }
 961
 962 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
 963         BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
 964 static inline void move_array(void *dst, const void *src, size_t n, size_t size)
 965 {
 966         if (n)
 967                 memmove(dst, src, st_mult(size, n));
 968 }
 969
 970 /*
 971  * These functions help you allocate structs with flex arrays, and copy
 972  * the data directly into the array. For example, if you had:
 973  *
 974  *   struct foo {
 975  *     int bar;
 976  *     char name[FLEX_ARRAY];
 977  *   };
 978  *
 979  * you can do:
 980  *
 981  *   struct foo *f;
 982  *   FLEX_ALLOC_MEM(f, name, src, len);
 983  *
 984  * to allocate a "foo" with the contents of "src" in the "name" field.
 985  * The resulting struct is automatically zero'd, and the flex-array field
 986  * is NUL-terminated (whether the incoming src buffer was or not).
 987  *
 988  * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
 989  * but do want to store a pointer to some extra data in the same allocated
 990  * block. For example, if you have:
 991  *
 992  *   struct foo {
 993  *     char *name;
 994  *     int bar;
 995  *   };
 996  *
 997  * you can do:
 998  *
 999  *   struct foo *f;
1000  *   FLEXPTR_ALLOC_STR(f, name, src);
1001  *
1002  * and "name" will point to a block of memory after the struct, which will be
1003  * freed along with the struct (but the pointer can be repointed anywhere).
1004  *
1005  * The *_STR variants accept a string parameter rather than a ptr/len
1006  * combination.
1007  *
1008  * Note that these macros will evaluate the first parameter multiple
1009  * times, and it must be assignable as an lvalue.
1010  */
1011 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
1012         size_t flex_array_len_ = (len); \
1013         (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1014         memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
1015 } while (0)
1016 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
1017         size_t flex_array_len_ = (len); \
1018         (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1019         memcpy((x) + 1, (buf), flex_array_len_); \
1020         (x)->ptrname = (void *)((x)+1); \
1021 } while(0)
1022 #define FLEX_ALLOC_STR(x, flexname, str) \
1023         FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1024 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1025         FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1026
1027 static inline char *xstrdup_or_null(const char *str)
1028 {
1029         return str ? xstrdup(str) : NULL;
1030 }
1031
1032 static inline size_t xsize_t(off_t len)
1033 {
1034         if (len < 0 || (uintmax_t) len > SIZE_MAX)
1035                 die("Cannot handle files this big");
1036         return (size_t) len;
1037 }
1038
1039 __attribute__((format (printf, 3, 4)))
1040 int xsnprintf(char *dst, size_t max, const char *fmt, ...);
1041
1042 #ifndef HOST_NAME_MAX
1043 #define HOST_NAME_MAX 256
1044 #endif
1045
1046 int xgethostname(char *buf, size_t len);
1047
1048 /* in ctype.c, for kwset users */
1049 extern const unsigned char tolower_trans_tbl[256];
1050
1051 /* Sane ctype - no locale, and works with signed chars */
1052 #undef isascii
1053 #undef isspace
1054 #undef isdigit
1055 #undef isalpha
1056 #undef isalnum
1057 #undef isprint
1058 #undef islower
1059 #undef isupper
1060 #undef tolower
1061 #undef toupper
1062 #undef iscntrl
1063 #undef ispunct
1064 #undef isxdigit
1065
1066 extern const unsigned char sane_ctype[256];
1067 #define GIT_SPACE 0x01
1068 #define GIT_DIGIT 0x02
1069 #define GIT_ALPHA 0x04
1070 #define GIT_GLOB_SPECIAL 0x08
1071 #define GIT_REGEX_SPECIAL 0x10
1072 #define GIT_PATHSPEC_MAGIC 0x20
1073 #define GIT_CNTRL 0x40
1074 #define GIT_PUNCT 0x80
1075 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1076 #define isascii(x) (((x) & ~0x7f) == 0)
1077 #define isspace(x) sane_istest(x,GIT_SPACE)
1078 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1079 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1080 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1081 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1082 #define islower(x) sane_iscase(x, 1)
1083 #define isupper(x) sane_iscase(x, 0)
1084 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1085 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1086 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1087 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1088                 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1089 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1090 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1091 #define toupper(x) sane_case((unsigned char)(x), 0)
1092 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1093
1094 static inline int sane_case(int x, int high)
1095 {
1096         if (sane_istest(x, GIT_ALPHA))
1097                 x = (x & ~0x20) | high;
1098         return x;
1099 }
1100
1101 static inline int sane_iscase(int x, int is_lower)
1102 {
1103         if (!sane_istest(x, GIT_ALPHA))
1104                 return 0;
1105
1106         if (is_lower)
1107                 return (x & 0x20) != 0;
1108         else
1109                 return (x & 0x20) == 0;
1110 }
1111
1112 /*
1113  * Like skip_prefix, but compare case-insensitively. Note that the comparison
1114  * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1115  * locale-specific conversions).
1116  */
1117 static inline int skip_iprefix(const char *str, const char *prefix,
1118                                const char **out)
1119 {
1120         do {
1121                 if (!*prefix) {
1122                         *out = str;
1123                         return 1;
1124                 }
1125         } while (tolower(*str++) == tolower(*prefix++));
1126         return 0;
1127 }
1128
1129 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1130 {
1131         unsigned long ul;
1132         char *p;
1133
1134         errno = 0;
1135         /* negative values would be accepted by strtoul */
1136         if (strchr(s, '-'))
1137                 return -1;
1138         ul = strtoul(s, &p, base);
1139         if (errno || *p || p == s || (unsigned int) ul != ul)
1140                 return -1;
1141         *result = ul;
1142         return 0;
1143 }
1144
1145 static inline int strtol_i(char const *s, int base, int *result)
1146 {
1147         long ul;
1148         char *p;
1149
1150         errno = 0;
1151         ul = strtol(s, &p, base);
1152         if (errno || *p || p == s || (int) ul != ul)
1153                 return -1;
1154         *result = ul;
1155         return 0;
1156 }
1157
1158 void git_stable_qsort(void *base, size_t nmemb, size_t size,
1159                       int(*compar)(const void *, const void *));
1160 #ifdef INTERNAL_QSORT
1161 #define qsort git_stable_qsort
1162 #endif
1163
1164 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1165 static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1166                               int(*compar)(const void *, const void *))
1167 {
1168         if (nmemb > 1)
1169                 qsort(base, nmemb, size, compar);
1170 }
1171
1172 #define STABLE_QSORT(base, n, compar) \
1173         git_stable_qsort((base), (n), sizeof(*(base)), compar)
1174
1175 #ifndef HAVE_ISO_QSORT_S
1176 int git_qsort_s(void *base, size_t nmemb, size_t size,
1177                 int (*compar)(const void *, const void *, void *), void *ctx);
1178 #define qsort_s git_qsort_s
1179 #endif
1180
1181 #define QSORT_S(base, n, compar, ctx) do {                      \
1182         if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1183                 BUG("qsort_s() failed");                        \
1184 } while (0)
1185
1186 #ifndef REG_STARTEND
1187 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1188 #endif
1189
1190 static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1191                               size_t nmatch, regmatch_t pmatch[], int eflags)
1192 {
1193         assert(nmatch > 0 && pmatch);
1194         pmatch[0].rm_so = 0;
1195         pmatch[0].rm_eo = size;
1196         return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1197 }
1198
1199 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1200 # define FORCE_DIR_SET_GID S_ISGID
1201 #else
1202 # define FORCE_DIR_SET_GID 0
1203 #endif
1204
1205 #ifdef NO_NSEC
1206 #undef USE_NSEC
1207 #define ST_CTIME_NSEC(st) 0
1208 #define ST_MTIME_NSEC(st) 0
1209 #else
1210 #ifdef USE_ST_TIMESPEC
1211 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1212 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1213 #else
1214 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1215 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1216 #endif
1217 #endif
1218
1219 #ifdef UNRELIABLE_FSTAT
1220 #define fstat_is_reliable() 0
1221 #else
1222 #define fstat_is_reliable() 1
1223 #endif
1224
1225 #ifndef va_copy
1226 /*
1227  * Since an obvious implementation of va_list would be to make it a
1228  * pointer into the stack frame, a simple assignment will work on
1229  * many systems.  But let's try to be more portable.
1230  */
1231 #ifdef __va_copy
1232 #define va_copy(dst, src) __va_copy(dst, src)
1233 #else
1234 #define va_copy(dst, src) ((dst) = (src))
1235 #endif
1236 #endif
1237
1238 /*
1239  * This is always defined as a first step towards making the use of variadic
1240  * macros unconditional. If it causes compilation problems on your platform,
1241  * please report it to the Git mailing list at git@vger.kernel.org.
1242  */
1243 #define HAVE_VARIADIC_MACROS 1
1244
1245 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1246 extern int BUG_exit_code;
1247
1248 #ifdef HAVE_VARIADIC_MACROS
1249 __attribute__((format (printf, 3, 4))) NORETURN
1250 void BUG_fl(const char *file, int line, const char *fmt, ...);
1251 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1252 #else
1253 __attribute__((format (printf, 1, 2))) NORETURN
1254 void BUG(const char *fmt, ...);
1255 #endif
1256
1257 /*
1258  * Preserves errno, prints a message, but gives no warning for ENOENT.
1259  * Returns 0 on success, which includes trying to unlink an object that does
1260  * not exist.
1261  */
1262 int unlink_or_warn(const char *path);
1263  /*
1264   * Tries to unlink file.  Returns 0 if unlink succeeded
1265   * or the file already didn't exist.  Returns -1 and
1266   * appends a message to err suitable for
1267   * 'error("%s", err->buf)' on error.
1268   */
1269 int unlink_or_msg(const char *file, struct strbuf *err);
1270 /*
1271  * Preserves errno, prints a message, but gives no warning for ENOENT.
1272  * Returns 0 on success, which includes trying to remove a directory that does
1273  * not exist.
1274  */
1275 int rmdir_or_warn(const char *path);
1276 /*
1277  * Calls the correct function out of {unlink,rmdir}_or_warn based on
1278  * the supplied file mode.
1279  */
1280 int remove_or_warn(unsigned int mode, const char *path);
1281
1282 /*
1283  * Call access(2), but warn for any error except "missing file"
1284  * (ENOENT or ENOTDIR).
1285  */
1286 #define ACCESS_EACCES_OK (1U << 0)
1287 int access_or_warn(const char *path, int mode, unsigned flag);
1288 int access_or_die(const char *path, int mode, unsigned flag);
1289
1290 /* Warn on an inaccessible file if errno indicates this is an error */
1291 int warn_on_fopen_errors(const char *path);
1292
1293 /*
1294  * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent
1295  * may be racy. Do not use this as protection against an attacker who can
1296  * simultaneously create paths.
1297  */
1298 int open_nofollow(const char *path, int flags);
1299
1300 #ifndef SHELL_PATH
1301 # define SHELL_PATH "/bin/sh"
1302 #endif
1303
1304 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1305 static inline void flockfile(FILE *fh)
1306 {
1307         ; /* nothing */
1308 }
1309 static inline void funlockfile(FILE *fh)
1310 {
1311         ; /* nothing */
1312 }
1313 #define getc_unlocked(fh) getc(fh)
1314 #endif
1315
1316 #ifdef FILENO_IS_A_MACRO
1317 int git_fileno(FILE *stream);
1318 # ifndef COMPAT_CODE_FILENO
1319 #  undef fileno
1320 #  define fileno(p) git_fileno(p)
1321 # endif
1322 #endif
1323
1324 #ifdef NEED_ACCESS_ROOT_HANDLER
1325 int git_access(const char *path, int mode);
1326 # ifndef COMPAT_CODE_ACCESS
1327 #  ifdef access
1328 #  undef access
1329 #  endif
1330 #  define access(path, mode) git_access(path, mode)
1331 # endif
1332 #endif
1333
1334 /*
1335  * Our code often opens a path to an optional file, to work on its
1336  * contents when we can successfully open it.  We can ignore a failure
1337  * to open if such an optional file does not exist, but we do want to
1338  * report a failure in opening for other reasons (e.g. we got an I/O
1339  * error, or the file is there, but we lack the permission to open).
1340  *
1341  * Call this function after seeing an error from open() or fopen() to
1342  * see if the errno indicates a missing file that we can safely ignore.
1343  */
1344 static inline int is_missing_file_error(int errno_)
1345 {
1346         return (errno_ == ENOENT || errno_ == ENOTDIR);
1347 }
1348
1349 int cmd_main(int, const char **);
1350
1351 /*
1352  * Intercept all calls to exit() and route them to trace2 to
1353  * optionally emit a message before calling the real exit().
1354  */
1355 int trace2_cmd_exit_fl(const char *file, int line, int code);
1356 #define exit(code) exit(trace2_cmd_exit_fl(__FILE__, __LINE__, (code)))
1357
1358 /*
1359  * You can mark a stack variable with UNLEAK(var) to avoid it being
1360  * reported as a leak by tools like LSAN or valgrind. The argument
1361  * should generally be the variable itself (not its address and not what
1362  * it points to). It's safe to use this on pointers which may already
1363  * have been freed, or on pointers which may still be in use.
1364  *
1365  * Use this _only_ for a variable that leaks by going out of scope at
1366  * program exit (so only from cmd_* functions or their direct helpers).
1367  * Normal functions, especially those which may be called multiple
1368  * times, should actually free their memory. This is only meant as
1369  * an annotation, and does nothing in non-leak-checking builds.
1370  */
1371 #ifdef SUPPRESS_ANNOTATED_LEAKS
1372 void unleak_memory(const void *ptr, size_t len);
1373 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1374 #else
1375 #define UNLEAK(var) do {} while (0)
1376 #endif
1377
1378 /*
1379  * This include must come after system headers, since it introduces macros that
1380  * replace system names.
1381  */
1382 #include "banned.h"
1383
1384 /*
1385  * container_of - Get the address of an object containing a field.
1386  *
1387  * @ptr: pointer to the field.
1388  * @type: type of the object.
1389  * @member: name of the field within the object.
1390  */
1391 #define container_of(ptr, type, member) \
1392         ((type *) ((char *)(ptr) - offsetof(type, member)))
1393
1394 /*
1395  * helper function for `container_of_or_null' to avoid multiple
1396  * evaluation of @ptr
1397  */
1398 static inline void *container_of_or_null_offset(void *ptr, size_t offset)
1399 {
1400         return ptr ? (char *)ptr - offset : NULL;
1401 }
1402
1403 /*
1404  * like `container_of', but allows returned value to be NULL
1405  */
1406 #define container_of_or_null(ptr, type, member) \
1407         (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1408
1409 /*
1410  * like offsetof(), but takes a pointer to a variable of type which
1411  * contains @member, instead of a specified type.
1412  * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1413  * everywhere.
1414  */
1415 #if defined(__GNUC__) /* clang sets this, too */
1416 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1417 #else /* !__GNUC__ */
1418 #define OFFSETOF_VAR(ptr, member) \
1419         ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1420 #endif /* !__GNUC__ */
1421
1422 void sleep_millisec(int millisec);
1423
1424 #endif