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