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 /* Used by compat/win32/path-utils.h, and more */
 240 static inline int is_xplatform_dir_sep(int c)
 241 {
 242         return c == '/' || c == '\\';
 243 }
 244
 245 #if defined(__CYGWIN__)
 246 #include "compat/win32/path-utils.h"
 247 #endif
 248 #if defined(__MINGW32__)
 249 /* pull in Windows compatibility stuff */
 250 #include "compat/win32/path-utils.h"
 251 #include "compat/mingw.h"
 252 #elif defined(_MSC_VER)
 253 #include "compat/win32/path-utils.h"
 254 #include "compat/msvc.h"
 255 #else
 256 #include <sys/utsname.h>
 257 #include <sys/wait.h>
 258 #include <sys/resource.h>
 259 #include <sys/socket.h>
 260 #include <sys/ioctl.h>
 261 #include <termios.h>
 262 #ifndef NO_SYS_SELECT_H
 263 #include <sys/select.h>
 264 #endif
 265 #include <netinet/in.h>
 266 #include <netinet/tcp.h>
 267 #include <arpa/inet.h>
 268 #include <netdb.h>
 269 #include <pwd.h>
 270 #include <sys/un.h>
 271 #ifndef NO_INTTYPES_H
 272 #include <inttypes.h>
 273 #else
 274 #include <stdint.h>
 275 #endif
 276 #ifdef HAVE_ARC4RANDOM_LIBBSD
 277 #include <bsd/stdlib.h>
 278 #endif
 279 #ifdef HAVE_GETRANDOM
 280 #include <sys/random.h>
 281 #endif
 282 #ifdef NO_INTPTR_T
 283 /*
 284  * On I16LP32, ILP32 and LP64 "long" is the safe bet, however
 285  * on LLP86, IL33LLP64 and P64 it needs to be "long long",
 286  * while on IP16 and IP16L32 it is "int" (resp. "short")
 287  * Size needs to match (or exceed) 'sizeof(void *)'.
 288  * We can't take "long long" here as not everybody has it.
 289  */
 290 typedef long intptr_t;
 291 typedef unsigned long uintptr_t;
 292 #endif
 293 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
 294 #include <grp.h>
 295 #define _ALL_SOURCE 1
 296 #endif
 297
 298 /* used on Mac OS X */
 299 #ifdef PRECOMPOSE_UNICODE
 300 #include "compat/precompose_utf8.h"
 301 #else
 302 static inline const char *precompose_argv_prefix(int argc, const char **argv, const char *prefix)
 303 {
 304         return prefix;
 305 }
 306 static inline const char *precompose_string_if_needed(const char *in)
 307 {
 308         return in;
 309 }
 310
 311 #define probe_utf8_pathname_composition()
 312 #endif
 313
 314 #ifdef MKDIR_WO_TRAILING_SLASH
 315 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
 316 int compat_mkdir_wo_trailing_slash(const char*, mode_t);
 317 #endif
 318
 319 #ifdef NO_STRUCT_ITIMERVAL
 320 struct itimerval {
 321         struct timeval it_interval;
 322         struct timeval it_value;
 323 };
 324 #endif
 325
 326 #ifdef NO_SETITIMER
 327 static inline int setitimer(int which, const struct itimerval *value, struct itimerval *newvalue) {
 328         return 0; /* pretend success */
 329 }
 330 #endif
 331
 332 #ifndef NO_LIBGEN_H
 333 #include <libgen.h>
 334 #else
 335 #define basename gitbasename
 336 char *gitbasename(char *);
 337 #define dirname gitdirname
 338 char *gitdirname(char *);
 339 #endif
 340
 341 #ifndef NO_ICONV
 342 #include <iconv.h>
 343 #endif
 344
 345 #ifndef NO_OPENSSL
 346 #ifdef __APPLE__
 347 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
 348 #include <AvailabilityMacros.h>
 349 #undef DEPRECATED_ATTRIBUTE
 350 #define DEPRECATED_ATTRIBUTE
 351 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
 352 #endif
 353 #include <openssl/ssl.h>
 354 #include <openssl/err.h>
 355 #endif
 356
 357 #ifdef HAVE_SYSINFO
 358 # include <sys/sysinfo.h>
 359 #endif
 360
 361 /* On most systems <netdb.h> would have given us this, but
 362  * not on some systems (e.g. z/OS).
 363  */
 364 #ifndef NI_MAXHOST
 365 #define NI_MAXHOST 1025
 366 #endif
 367
 368 #ifndef NI_MAXSERV
 369 #define NI_MAXSERV 32
 370 #endif
 371
 372 /* On most systems <limits.h> would have given us this, but
 373  * not on some systems (e.g. GNU/Hurd).
 374  */
 375 #ifndef PATH_MAX
 376 #define PATH_MAX 4096
 377 #endif
 378
 379 typedef uintmax_t timestamp_t;
 380 #define PRItime PRIuMAX
 381 #define parse_timestamp strtoumax
 382 #define TIME_MAX UINTMAX_MAX
 383 #define TIME_MIN 0
 384
 385 #ifndef PATH_SEP
 386 #define PATH_SEP ':'
 387 #endif
 388
 389 #ifdef HAVE_PATHS_H
 390 #include <paths.h>
 391 #endif
 392 #ifndef _PATH_DEFPATH
 393 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
 394 #endif
 395
 396 #ifndef platform_core_config
 397 static inline int noop_core_config(const char *var, const char *value, void *cb)
 398 {
 399         return 0;
 400 }
 401 #define platform_core_config noop_core_config
 402 #endif
 403
 404 int lstat_cache_aware_rmdir(const char *path);
 405 #if !defined(__MINGW32__) && !defined(_MSC_VER)
 406 #define rmdir lstat_cache_aware_rmdir
 407 #endif
 408
 409 #ifndef has_dos_drive_prefix
 410 static inline int git_has_dos_drive_prefix(const char *path)
 411 {
 412         return 0;
 413 }
 414 #define has_dos_drive_prefix git_has_dos_drive_prefix
 415 #endif
 416
 417 #ifndef skip_dos_drive_prefix
 418 static inline int git_skip_dos_drive_prefix(char **path)
 419 {
 420         return 0;
 421 }
 422 #define skip_dos_drive_prefix git_skip_dos_drive_prefix
 423 #endif
 424
 425 static inline int git_is_dir_sep(int c)
 426 {
 427         return c == '/';
 428 }
 429 #ifndef is_dir_sep
 430 #define is_dir_sep git_is_dir_sep
 431 #endif
 432
 433 #ifndef offset_1st_component
 434 static inline int git_offset_1st_component(const char *path)
 435 {
 436         return is_dir_sep(path[0]);
 437 }
 438 #define offset_1st_component git_offset_1st_component
 439 #endif
 440
 441 #ifndef is_valid_path
 442 #define is_valid_path(path) 1
 443 #endif
 444
 445 #ifndef is_path_owned_by_current_user
 446
 447 #ifdef __TANDEM
 448 #define ROOT_UID 65535
 449 #else
 450 #define ROOT_UID 0
 451 #endif
 452
 453 /*
 454  * Do not use this function when
 455  * (1) geteuid() did not say we are running as 'root', or
 456  * (2) using this function will compromise the system.
 457  *
 458  * PORTABILITY WARNING:
 459  * This code assumes uid_t is unsigned because that is what sudo does.
 460  * If your uid_t type is signed and all your ids are positive then it
 461  * should all work fine.
 462  * If your version of sudo uses negative values for uid_t or it is
 463  * buggy and return an overflowed value in SUDO_UID, then git might
 464  * fail to grant access to your repository properly or even mistakenly
 465  * grant access to someone else.
 466  * In the unlikely scenario this happened to you, and that is how you
 467  * got to this message, we would like to know about it; so sent us an
 468  * email to git@vger.kernel.org indicating which platform you are
 469  * using and which version of sudo, so we can improve this logic and
 470  * maybe provide you with a patch that would prevent this issue again
 471  * in the future.
 472  */
 473 static inline void extract_id_from_env(const char *env, uid_t *id)
 474 {
 475         const char *real_uid = getenv(env);
 476
 477         /* discard anything empty to avoid a more complex check below */
 478         if (real_uid && *real_uid) {
 479                 char *endptr = NULL;
 480                 unsigned long env_id;
 481
 482                 errno = 0;
 483                 /* silent overflow errors could trigger a bug here */
 484                 env_id = strtoul(real_uid, &endptr, 10);
 485                 if (!*endptr && !errno)
 486                         *id = env_id;
 487         }
 488 }
 489
 490 static inline int is_path_owned_by_current_uid(const char *path)
 491 {
 492         struct stat st;
 493         uid_t euid;
 494
 495         if (lstat(path, &st))
 496                 return 0;
 497
 498         euid = geteuid();
 499         if (euid == ROOT_UID)
 500         {
 501                 if (st.st_uid == ROOT_UID)
 502                         return 1;
 503                 else
 504                         extract_id_from_env("SUDO_UID", &euid);
 505         }
 506
 507         return st.st_uid == euid;
 508 }
 509
 510 #define is_path_owned_by_current_user is_path_owned_by_current_uid
 511 #endif
 512
 513 #ifndef find_last_dir_sep
 514 static inline char *git_find_last_dir_sep(const char *path)
 515 {
 516         return strrchr(path, '/');
 517 }
 518 #define find_last_dir_sep git_find_last_dir_sep
 519 #endif
 520
 521 #ifndef has_dir_sep
 522 static inline int git_has_dir_sep(const char *path)
 523 {
 524         return !!strchr(path, '/');
 525 }
 526 #define has_dir_sep(path) git_has_dir_sep(path)
 527 #endif
 528
 529 #ifndef query_user_email
 530 #define query_user_email() NULL
 531 #endif
 532
 533 #ifdef __TANDEM
 534 #include <floss.h(floss_execl,floss_execlp,floss_execv,floss_execvp)>
 535 #include <floss.h(floss_getpwuid)>
 536 #ifndef NSIG
 537 /*
 538  * NonStop NSE and NSX do not provide NSIG. SIGGUARDIAN(99) is the highest
 539  * known, by detective work using kill -l as a list is all signals
 540  * instead of signal.h where it should be.
 541  */
 542 # define NSIG 100
 543 #endif
 544 #endif
 545
 546 #if defined(__HP_cc) && (__HP_cc >= 61000)
 547 #define NORETURN __attribute__((noreturn))
 548 #define NORETURN_PTR
 549 #elif defined(__GNUC__) && !defined(NO_NORETURN)
 550 #define NORETURN __attribute__((__noreturn__))
 551 #define NORETURN_PTR __attribute__((__noreturn__))
 552 #elif defined(_MSC_VER)
 553 #define NORETURN __declspec(noreturn)
 554 #define NORETURN_PTR
 555 #else
 556 #define NORETURN
 557 #define NORETURN_PTR
 558 #ifndef __GNUC__
 559 #ifndef __attribute__
 560 #define __attribute__(x)
 561 #endif
 562 #endif
 563 #endif
 564
 565 /* The sentinel attribute is valid from gcc version 4.0 */
 566 #if defined(__GNUC__) && (__GNUC__ >= 4)
 567 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
 568 #else
 569 #define LAST_ARG_MUST_BE_NULL
 570 #endif
 571
 572 #define MAYBE_UNUSED __attribute__((__unused__))
 573
 574 #include "compat/bswap.h"
 575
 576 #include "wildmatch.h"
 577
 578 struct strbuf;
 579
 580 /* General helper functions */
 581 NORETURN void usage(const char *err);
 582 NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
 583 NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
 584 NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 585 int die_message(const char *err, ...) __attribute__((format (printf, 1, 2)));
 586 int die_message_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 587 int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 588 int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 589 void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 590 void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 591
 592 #ifndef NO_OPENSSL
 593 #ifdef APPLE_COMMON_CRYPTO
 594 #include "compat/apple-common-crypto.h"
 595 #else
 596 #include <openssl/evp.h>
 597 #include <openssl/hmac.h>
 598 #endif /* APPLE_COMMON_CRYPTO */
 599 #include <openssl/x509v3.h>
 600 #endif /* NO_OPENSSL */
 601
 602 #ifdef HAVE_OPENSSL_CSPRNG
 603 #include <openssl/rand.h>
 604 #endif
 605
 606 /*
 607  * Let callers be aware of the constant return value; this can help
 608  * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
 609  * because other compilers may be confused by this.
 610  */
 611 #if defined(__GNUC__)
 612 static inline int const_error(void)
 613 {
 614         return -1;
 615 }
 616 #define error(...) (error(__VA_ARGS__), const_error())
 617 #define error_errno(...) (error_errno(__VA_ARGS__), const_error())
 618 #endif
 619
 620 typedef void (*report_fn)(const char *, va_list params);
 621
 622 void set_die_routine(NORETURN_PTR report_fn routine);
 623 report_fn get_die_message_routine(void);
 624 void set_error_routine(report_fn routine);
 625 report_fn get_error_routine(void);
 626 void set_warn_routine(report_fn routine);
 627 report_fn get_warn_routine(void);
 628 void set_die_is_recursing_routine(int (*routine)(void));
 629
 630 int starts_with(const char *str, const char *prefix);
 631 int istarts_with(const char *str, const char *prefix);
 632
 633 /*
 634  * If the string "str" begins with the string found in "prefix", return 1.
 635  * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
 636  * the string right after the prefix).
 637  *
 638  * Otherwise, return 0 and leave "out" untouched.
 639  *
 640  * Examples:
 641  *
 642  *   [extract branch name, fail if not a branch]
 643  *   if (!skip_prefix(ref, "refs/heads/", &branch)
 644  *      return -1;
 645  *
 646  *   [skip prefix if present, otherwise use whole string]
 647  *   skip_prefix(name, "refs/heads/", &name);
 648  */
 649 static inline int skip_prefix(const char *str, const char *prefix,
 650                               const char **out)
 651 {
 652         do {
 653                 if (!*prefix) {
 654                         *out = str;
 655                         return 1;
 656                 }
 657         } while (*str++ == *prefix++);
 658         return 0;
 659 }
 660
 661 /*
 662  * If the string "str" is the same as the string in "prefix", then the "arg"
 663  * parameter is set to the "def" parameter and 1 is returned.
 664  * If the string "str" begins with the string found in "prefix" and then a
 665  * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
 666  * (i.e., to the point in the string right after the prefix and the "=" sign),
 667  * and 1 is returned.
 668  *
 669  * Otherwise, return 0 and leave "arg" untouched.
 670  *
 671  * When we accept both a "--key" and a "--key=<val>" option, this function
 672  * can be used instead of !strcmp(arg, "--key") and then
 673  * skip_prefix(arg, "--key=", &arg) to parse such an option.
 674  */
 675 int skip_to_optional_arg_default(const char *str, const char *prefix,
 676                                  const char **arg, const char *def);
 677
 678 static inline int skip_to_optional_arg(const char *str, const char *prefix,
 679                                        const char **arg)
 680 {
 681         return skip_to_optional_arg_default(str, prefix, arg, "");
 682 }
 683
 684 /*
 685  * Like skip_prefix, but promises never to read past "len" bytes of the input
 686  * buffer, and returns the remaining number of bytes in "out" via "outlen".
 687  */
 688 static inline int skip_prefix_mem(const char *buf, size_t len,
 689                                   const char *prefix,
 690                                   const char **out, size_t *outlen)
 691 {
 692         size_t prefix_len = strlen(prefix);
 693         if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
 694                 *out = buf + prefix_len;
 695                 *outlen = len - prefix_len;
 696                 return 1;
 697         }
 698         return 0;
 699 }
 700
 701 /*
 702  * If buf ends with suffix, return 1 and subtract the length of the suffix
 703  * from *len. Otherwise, return 0 and leave *len untouched.
 704  */
 705 static inline int strip_suffix_mem(const char *buf, size_t *len,
 706                                    const char *suffix)
 707 {
 708         size_t suflen = strlen(suffix);
 709         if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
 710                 return 0;
 711         *len -= suflen;
 712         return 1;
 713 }
 714
 715 /*
 716  * If str ends with suffix, return 1 and set *len to the size of the string
 717  * without the suffix. Otherwise, return 0 and set *len to the size of the
 718  * string.
 719  *
 720  * Note that we do _not_ NUL-terminate str to the new length.
 721  */
 722 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
 723 {
 724         *len = strlen(str);
 725         return strip_suffix_mem(str, len, suffix);
 726 }
 727
 728 static inline int ends_with(const char *str, const char *suffix)
 729 {
 730         size_t len;
 731         return strip_suffix(str, suffix, &len);
 732 }
 733
 734 #define SWAP(a, b) do {                                         \
 735         void *_swap_a_ptr = &(a);                               \
 736         void *_swap_b_ptr = &(b);                               \
 737         unsigned char _swap_buffer[sizeof(a)];                  \
 738         memcpy(_swap_buffer, _swap_a_ptr, sizeof(a));           \
 739         memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) +            \
 740                BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b)));   \
 741         memcpy(_swap_b_ptr, _swap_buffer, sizeof(a));           \
 742 } while (0)
 743
 744 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 745
 746 #ifndef PROT_READ
 747 #define PROT_READ 1
 748 #define PROT_WRITE 2
 749 #define MAP_PRIVATE 1
 750 #endif
 751
 752 #define mmap git_mmap
 753 #define munmap git_munmap
 754 void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 755 int git_munmap(void *start, size_t length);
 756
 757 #else /* NO_MMAP || USE_WIN32_MMAP */
 758
 759 #include <sys/mman.h>
 760
 761 #endif /* NO_MMAP || USE_WIN32_MMAP */
 762
 763 #ifdef NO_MMAP
 764
 765 /* This value must be multiple of (pagesize * 2) */
 766 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 767
 768 #else /* NO_MMAP */
 769
 770 /* This value must be multiple of (pagesize * 2) */
 771 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 772         (sizeof(void*) >= 8 \
 773                 ?  1 * 1024 * 1024 * 1024 \
 774                 : 32 * 1024 * 1024)
 775
 776 #endif /* NO_MMAP */
 777
 778 #ifndef MAP_FAILED
 779 #define MAP_FAILED ((void *)-1)
 780 #endif
 781
 782 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 783 #define on_disk_bytes(st) ((st).st_size)
 784 #else
 785 #define on_disk_bytes(st) ((st).st_blocks * 512)
 786 #endif
 787
 788 #ifdef NEEDS_MODE_TRANSLATION
 789 #undef S_IFMT
 790 #undef S_IFREG
 791 #undef S_IFDIR
 792 #undef S_IFLNK
 793 #undef S_IFBLK
 794 #undef S_IFCHR
 795 #undef S_IFIFO
 796 #undef S_IFSOCK
 797 #define S_IFMT   0170000
 798 #define S_IFREG  0100000
 799 #define S_IFDIR  0040000
 800 #define S_IFLNK  0120000
 801 #define S_IFBLK  0060000
 802 #define S_IFCHR  0020000
 803 #define S_IFIFO  0010000
 804 #define S_IFSOCK 0140000
 805 #ifdef stat
 806 #undef stat
 807 #endif
 808 #define stat(path, buf) git_stat(path, buf)
 809 int git_stat(const char *, struct stat *);
 810 #ifdef fstat
 811 #undef fstat
 812 #endif
 813 #define fstat(fd, buf) git_fstat(fd, buf)
 814 int git_fstat(int, struct stat *);
 815 #ifdef lstat
 816 #undef lstat
 817 #endif
 818 #define lstat(path, buf) git_lstat(path, buf)
 819 int git_lstat(const char *, struct stat *);
 820 #endif
 821
 822 #define DEFAULT_PACKED_GIT_LIMIT \
 823         ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
 824
 825 #ifdef NO_PREAD
 826 #define pread git_pread
 827 ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 828 #endif
 829 /*
 830  * Forward decl that will remind us if its twin in cache.h changes.
 831  * This function is used in compat/pread.c.  But we can't include
 832  * cache.h there.
 833  */
 834 ssize_t read_in_full(int fd, void *buf, size_t count);
 835
 836 #ifdef NO_SETENV
 837 #define setenv gitsetenv
 838 int gitsetenv(const char *, const char *, int);
 839 #endif
 840
 841 #ifdef NO_MKDTEMP
 842 #define mkdtemp gitmkdtemp
 843 char *gitmkdtemp(char *);
 844 #endif
 845
 846 #ifdef NO_UNSETENV
 847 #define unsetenv gitunsetenv
 848 int gitunsetenv(const char *);
 849 #endif
 850
 851 #ifdef NO_STRCASESTR
 852 #define strcasestr gitstrcasestr
 853 char *gitstrcasestr(const char *haystack, const char *needle);
 854 #endif
 855
 856 #ifdef NO_STRLCPY
 857 #define strlcpy gitstrlcpy
 858 size_t gitstrlcpy(char *, const char *, size_t);
 859 #endif
 860
 861 #ifdef NO_STRTOUMAX
 862 #define strtoumax gitstrtoumax
 863 uintmax_t gitstrtoumax(const char *, char **, int);
 864 #define strtoimax gitstrtoimax
 865 intmax_t gitstrtoimax(const char *, char **, int);
 866 #endif
 867
 868 #ifdef NO_HSTRERROR
 869 #define hstrerror githstrerror
 870 const char *githstrerror(int herror);
 871 #endif
 872
 873 #ifdef NO_MEMMEM
 874 #define memmem gitmemmem
 875 void *gitmemmem(const void *haystack, size_t haystacklen,
 876                 const void *needle, size_t needlelen);
 877 #endif
 878
 879 #ifdef OVERRIDE_STRDUP
 880 #ifdef strdup
 881 #undef strdup
 882 #endif
 883 #define strdup gitstrdup
 884 char *gitstrdup(const char *s);
 885 #endif
 886
 887 #ifdef NO_GETPAGESIZE
 888 #define getpagesize() sysconf(_SC_PAGESIZE)
 889 #endif
 890
 891 #ifndef O_CLOEXEC
 892 #define O_CLOEXEC 0
 893 #endif
 894
 895 #ifdef FREAD_READS_DIRECTORIES
 896 # if !defined(SUPPRESS_FOPEN_REDEFINITION)
 897 #  ifdef fopen
 898 #   undef fopen
 899 #  endif
 900 #  define fopen(a,b) git_fopen(a,b)
 901 # endif
 902 FILE *git_fopen(const char*, const char*);
 903 #endif
 904
 905 #ifdef SNPRINTF_RETURNS_BOGUS
 906 #ifdef snprintf
 907 #undef snprintf
 908 #endif
 909 #define snprintf git_snprintf
 910 int git_snprintf(char *str, size_t maxsize,
 911                  const char *format, ...);
 912 #ifdef vsnprintf
 913 #undef vsnprintf
 914 #endif
 915 #define vsnprintf git_vsnprintf
 916 int git_vsnprintf(char *str, size_t maxsize,
 917                   const char *format, va_list ap);
 918 #endif
 919
 920 #ifdef OPEN_RETURNS_EINTR
 921 #undef open
 922 #define open git_open_with_retry
 923 int git_open_with_retry(const char *path, int flag, ...);
 924 #endif
 925
 926 #ifdef __GLIBC_PREREQ
 927 #if __GLIBC_PREREQ(2, 1)
 928 #define HAVE_STRCHRNUL
 929 #endif
 930 #endif
 931
 932 #ifndef HAVE_STRCHRNUL
 933 #define strchrnul gitstrchrnul
 934 static inline char *gitstrchrnul(const char *s, int c)
 935 {
 936         while (*s && *s != c)
 937                 s++;
 938         return (char *)s;
 939 }
 940 #endif
 941
 942 #ifdef NO_INET_PTON
 943 int inet_pton(int af, const char *src, void *dst);
 944 #endif
 945
 946 #ifdef NO_INET_NTOP
 947 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
 948 #endif
 949
 950 #ifdef NO_PTHREADS
 951 #define atexit git_atexit
 952 int git_atexit(void (*handler)(void));
 953 #endif
 954
 955 static inline size_t st_add(size_t a, size_t b)
 956 {
 957         if (unsigned_add_overflows(a, b))
 958                 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
 959                     (uintmax_t)a, (uintmax_t)b);
 960         return a + b;
 961 }
 962 #define st_add3(a,b,c)   st_add(st_add((a),(b)),(c))
 963 #define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
 964
 965 static inline size_t st_mult(size_t a, size_t b)
 966 {
 967         if (unsigned_mult_overflows(a, b))
 968                 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
 969                     (uintmax_t)a, (uintmax_t)b);
 970         return a * b;
 971 }
 972
 973 static inline size_t st_sub(size_t a, size_t b)
 974 {
 975         if (a < b)
 976                 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
 977                     (uintmax_t)a, (uintmax_t)b);
 978         return a - b;
 979 }
 980
 981 static inline size_t st_left_shift(size_t a, unsigned shift)
 982 {
 983         if (unsigned_left_shift_overflows(a, shift))
 984                 die("size_t overflow: %"PRIuMAX" << %u",
 985                     (uintmax_t)a, shift);
 986         return a << shift;
 987 }
 988
 989 static inline unsigned long cast_size_t_to_ulong(size_t a)
 990 {
 991         if (a != (unsigned long)a)
 992                 die("object too large to read on this platform: %"
 993                     PRIuMAX" is cut off to %lu",
 994                     (uintmax_t)a, (unsigned long)a);
 995         return (unsigned long)a;
 996 }
 997
 998 #ifdef HAVE_ALLOCA_H
 999 # include <alloca.h>
1000 # define xalloca(size)      (alloca(size))
1001 # define xalloca_free(p)    do {} while (0)
1002 #else
1003 # define xalloca(size)      (xmalloc(size))
1004 # define xalloca_free(p)    (free(p))
1005 #endif
1006 char *xstrdup(const char *str);
1007 void *xmalloc(size_t size);
1008 void *xmallocz(size_t size);
1009 void *xmallocz_gently(size_t size);
1010 void *xmemdupz(const void *data, size_t len);
1011 char *xstrndup(const char *str, size_t len);
1012 void *xrealloc(void *ptr, size_t size);
1013 void *xcalloc(size_t nmemb, size_t size);
1014 void xsetenv(const char *name, const char *value, int overwrite);
1015 void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
1016 const char *mmap_os_err(void);
1017 void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
1018 int xopen(const char *path, int flags, ...);
1019 ssize_t xread(int fd, void *buf, size_t len);
1020 ssize_t xwrite(int fd, const void *buf, size_t len);
1021 ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
1022 int xdup(int fd);
1023 FILE *xfopen(const char *path, const char *mode);
1024 FILE *xfdopen(int fd, const char *mode);
1025 int xmkstemp(char *temp_filename);
1026 int xmkstemp_mode(char *temp_filename, int mode);
1027 char *xgetcwd(void);
1028 FILE *fopen_for_writing(const char *path);
1029 FILE *fopen_or_warn(const char *path, const char *mode);
1030
1031 /*
1032  * Like strncmp, but only return zero if s is NUL-terminated and exactly len
1033  * characters long.  If it is not, consider it greater than t.
1034  */
1035 int xstrncmpz(const char *s, const char *t, size_t len);
1036
1037 /*
1038  * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
1039  * that ptr is used twice, so don't pass e.g. ptr++.
1040  */
1041 #define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
1042
1043 #define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
1044 #define CALLOC_ARRAY(x, alloc) (x) = xcalloc((alloc), sizeof(*(x)))
1045 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
1046
1047 #define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
1048         BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
1049 static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
1050 {
1051         if (n)
1052                 memcpy(dst, src, st_mult(size, n));
1053 }
1054
1055 #define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
1056         BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
1057 static inline void move_array(void *dst, const void *src, size_t n, size_t size)
1058 {
1059         if (n)
1060                 memmove(dst, src, st_mult(size, n));
1061 }
1062
1063 /*
1064  * These functions help you allocate structs with flex arrays, and copy
1065  * the data directly into the array. For example, if you had:
1066  *
1067  *   struct foo {
1068  *     int bar;
1069  *     char name[FLEX_ARRAY];
1070  *   };
1071  *
1072  * you can do:
1073  *
1074  *   struct foo *f;
1075  *   FLEX_ALLOC_MEM(f, name, src, len);
1076  *
1077  * to allocate a "foo" with the contents of "src" in the "name" field.
1078  * The resulting struct is automatically zero'd, and the flex-array field
1079  * is NUL-terminated (whether the incoming src buffer was or not).
1080  *
1081  * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
1082  * but do want to store a pointer to some extra data in the same allocated
1083  * block. For example, if you have:
1084  *
1085  *   struct foo {
1086  *     char *name;
1087  *     int bar;
1088  *   };
1089  *
1090  * you can do:
1091  *
1092  *   struct foo *f;
1093  *   FLEXPTR_ALLOC_STR(f, name, src);
1094  *
1095  * and "name" will point to a block of memory after the struct, which will be
1096  * freed along with the struct (but the pointer can be repointed anywhere).
1097  *
1098  * The *_STR variants accept a string parameter rather than a ptr/len
1099  * combination.
1100  *
1101  * Note that these macros will evaluate the first parameter multiple
1102  * times, and it must be assignable as an lvalue.
1103  */
1104 #define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
1105         size_t flex_array_len_ = (len); \
1106         (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1107         memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
1108 } while (0)
1109 #define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
1110         size_t flex_array_len_ = (len); \
1111         (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
1112         memcpy((x) + 1, (buf), flex_array_len_); \
1113         (x)->ptrname = (void *)((x)+1); \
1114 } while(0)
1115 #define FLEX_ALLOC_STR(x, flexname, str) \
1116         FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
1117 #define FLEXPTR_ALLOC_STR(x, ptrname, str) \
1118         FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
1119
1120 static inline char *xstrdup_or_null(const char *str)
1121 {
1122         return str ? xstrdup(str) : NULL;
1123 }
1124
1125 static inline size_t xsize_t(off_t len)
1126 {
1127         if (len < 0 || (uintmax_t) len > SIZE_MAX)
1128                 die("Cannot handle files this big");
1129         return (size_t) len;
1130 }
1131
1132 __attribute__((format (printf, 3, 4)))
1133 int xsnprintf(char *dst, size_t max, const char *fmt, ...);
1134
1135 #ifndef HOST_NAME_MAX
1136 #define HOST_NAME_MAX 256
1137 #endif
1138
1139 int xgethostname(char *buf, size_t len);
1140
1141 /* in ctype.c, for kwset users */
1142 extern const unsigned char tolower_trans_tbl[256];
1143
1144 /* Sane ctype - no locale, and works with signed chars */
1145 #undef isascii
1146 #undef isspace
1147 #undef isdigit
1148 #undef isalpha
1149 #undef isalnum
1150 #undef isprint
1151 #undef islower
1152 #undef isupper
1153 #undef tolower
1154 #undef toupper
1155 #undef iscntrl
1156 #undef ispunct
1157 #undef isxdigit
1158
1159 extern const unsigned char sane_ctype[256];
1160 #define GIT_SPACE 0x01
1161 #define GIT_DIGIT 0x02
1162 #define GIT_ALPHA 0x04
1163 #define GIT_GLOB_SPECIAL 0x08
1164 #define GIT_REGEX_SPECIAL 0x10
1165 #define GIT_PATHSPEC_MAGIC 0x20
1166 #define GIT_CNTRL 0x40
1167 #define GIT_PUNCT 0x80
1168 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
1169 #define isascii(x) (((x) & ~0x7f) == 0)
1170 #define isspace(x) sane_istest(x,GIT_SPACE)
1171 #define isdigit(x) sane_istest(x,GIT_DIGIT)
1172 #define isalpha(x) sane_istest(x,GIT_ALPHA)
1173 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
1174 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
1175 #define islower(x) sane_iscase(x, 1)
1176 #define isupper(x) sane_iscase(x, 0)
1177 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
1178 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1179 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
1180 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
1181                 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
1182 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
1183 #define tolower(x) sane_case((unsigned char)(x), 0x20)
1184 #define toupper(x) sane_case((unsigned char)(x), 0)
1185 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
1186
1187 static inline int sane_case(int x, int high)
1188 {
1189         if (sane_istest(x, GIT_ALPHA))
1190                 x = (x & ~0x20) | high;
1191         return x;
1192 }
1193
1194 static inline int sane_iscase(int x, int is_lower)
1195 {
1196         if (!sane_istest(x, GIT_ALPHA))
1197                 return 0;
1198
1199         if (is_lower)
1200                 return (x & 0x20) != 0;
1201         else
1202                 return (x & 0x20) == 0;
1203 }
1204
1205 /*
1206  * Like skip_prefix, but compare case-insensitively. Note that the comparison
1207  * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1208  * locale-specific conversions).
1209  */
1210 static inline int skip_iprefix(const char *str, const char *prefix,
1211                                const char **out)
1212 {
1213         do {
1214                 if (!*prefix) {
1215                         *out = str;
1216                         return 1;
1217                 }
1218         } while (tolower(*str++) == tolower(*prefix++));
1219         return 0;
1220 }
1221
1222 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1223 {
1224         unsigned long ul;
1225         char *p;
1226
1227         errno = 0;
1228         /* negative values would be accepted by strtoul */
1229         if (strchr(s, '-'))
1230                 return -1;
1231         ul = strtoul(s, &p, base);
1232         if (errno || *p || p == s || (unsigned int) ul != ul)
1233                 return -1;
1234         *result = ul;
1235         return 0;
1236 }
1237
1238 static inline int strtol_i(char const *s, int base, int *result)
1239 {
1240         long ul;
1241         char *p;
1242
1243         errno = 0;
1244         ul = strtol(s, &p, base);
1245         if (errno || *p || p == s || (int) ul != ul)
1246                 return -1;
1247         *result = ul;
1248         return 0;
1249 }
1250
1251 void git_stable_qsort(void *base, size_t nmemb, size_t size,
1252                       int(*compar)(const void *, const void *));
1253 #ifdef INTERNAL_QSORT
1254 #define qsort git_stable_qsort
1255 #endif
1256
1257 #define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1258 static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1259                               int(*compar)(const void *, const void *))
1260 {
1261         if (nmemb > 1)
1262                 qsort(base, nmemb, size, compar);
1263 }
1264
1265 #define STABLE_QSORT(base, n, compar) \
1266         git_stable_qsort((base), (n), sizeof(*(base)), compar)
1267
1268 #ifndef HAVE_ISO_QSORT_S
1269 int git_qsort_s(void *base, size_t nmemb, size_t size,
1270                 int (*compar)(const void *, const void *, void *), void *ctx);
1271 #define qsort_s git_qsort_s
1272 #endif
1273
1274 #define QSORT_S(base, n, compar, ctx) do {                      \
1275         if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1276                 BUG("qsort_s() failed");                        \
1277 } while (0)
1278
1279 #ifndef REG_STARTEND
1280 #error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1281 #endif
1282
1283 static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1284                               size_t nmatch, regmatch_t pmatch[], int eflags)
1285 {
1286         assert(nmatch > 0 && pmatch);
1287         pmatch[0].rm_so = 0;
1288         pmatch[0].rm_eo = size;
1289         return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1290 }
1291
1292 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1293 # define FORCE_DIR_SET_GID S_ISGID
1294 #else
1295 # define FORCE_DIR_SET_GID 0
1296 #endif
1297
1298 #ifdef NO_NSEC
1299 #undef USE_NSEC
1300 #define ST_CTIME_NSEC(st) 0
1301 #define ST_MTIME_NSEC(st) 0
1302 #else
1303 #ifdef USE_ST_TIMESPEC
1304 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1305 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1306 #else
1307 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1308 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1309 #endif
1310 #endif
1311
1312 #ifdef UNRELIABLE_FSTAT
1313 #define fstat_is_reliable() 0
1314 #else
1315 #define fstat_is_reliable() 1
1316 #endif
1317
1318 #ifndef va_copy
1319 /*
1320  * Since an obvious implementation of va_list would be to make it a
1321  * pointer into the stack frame, a simple assignment will work on
1322  * many systems.  But let's try to be more portable.
1323  */
1324 #ifdef __va_copy
1325 #define va_copy(dst, src) __va_copy(dst, src)
1326 #else
1327 #define va_copy(dst, src) ((dst) = (src))
1328 #endif
1329 #endif
1330
1331 /* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1332 extern int BUG_exit_code;
1333
1334 /* usage.c: if bug() is called we should have a BUG_if_bug() afterwards */
1335 extern int bug_called_must_BUG;
1336
1337 __attribute__((format (printf, 3, 4))) NORETURN
1338 void BUG_fl(const char *file, int line, const char *fmt, ...);
1339 #define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1340 __attribute__((format (printf, 3, 4)))
1341 void bug_fl(const char *file, int line, const char *fmt, ...);
1342 #define bug(...) bug_fl(__FILE__, __LINE__, __VA_ARGS__)
1343 #define BUG_if_bug(...) do { \
1344         if (bug_called_must_BUG) \
1345                 BUG_fl(__FILE__, __LINE__, __VA_ARGS__); \
1346 } while (0)
1347
1348 #ifndef FSYNC_METHOD_DEFAULT
1349 #ifdef __APPLE__
1350 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_WRITEOUT_ONLY
1351 #else
1352 #define FSYNC_METHOD_DEFAULT FSYNC_METHOD_FSYNC
1353 #endif
1354 #endif
1355
1356 enum fsync_action {
1357         FSYNC_WRITEOUT_ONLY,
1358         FSYNC_HARDWARE_FLUSH
1359 };
1360
1361 /*
1362  * Issues an fsync against the specified file according to the specified mode.
1363  *
1364  * FSYNC_WRITEOUT_ONLY attempts to use interfaces available on some operating
1365  * systems to flush the OS cache without issuing a flush command to the storage
1366  * controller. If those interfaces are unavailable, the function fails with
1367  * ENOSYS.
1368  *
1369  * FSYNC_HARDWARE_FLUSH does an OS writeout and hardware flush to ensure that
1370  * changes are durable. It is not expected to fail.
1371  */
1372 int git_fsync(int fd, enum fsync_action action);
1373
1374 /*
1375  * Writes out trace statistics for fsync using the trace2 API.
1376  */
1377 void trace_git_fsync_stats(void);
1378
1379 /*
1380  * Preserves errno, prints a message, but gives no warning for ENOENT.
1381  * Returns 0 on success, which includes trying to unlink an object that does
1382  * not exist.
1383  */
1384 int unlink_or_warn(const char *path);
1385  /*
1386   * Tries to unlink file.  Returns 0 if unlink succeeded
1387   * or the file already didn't exist.  Returns -1 and
1388   * appends a message to err suitable for
1389   * 'error("%s", err->buf)' on error.
1390   */
1391 int unlink_or_msg(const char *file, struct strbuf *err);
1392 /*
1393  * Preserves errno, prints a message, but gives no warning for ENOENT.
1394  * Returns 0 on success, which includes trying to remove a directory that does
1395  * not exist.
1396  */
1397 int rmdir_or_warn(const char *path);
1398 /*
1399  * Calls the correct function out of {unlink,rmdir}_or_warn based on
1400  * the supplied file mode.
1401  */
1402 int remove_or_warn(unsigned int mode, const char *path);
1403
1404 /*
1405  * Call access(2), but warn for any error except "missing file"
1406  * (ENOENT or ENOTDIR).
1407  */
1408 #define ACCESS_EACCES_OK (1U << 0)
1409 int access_or_warn(const char *path, int mode, unsigned flag);
1410 int access_or_die(const char *path, int mode, unsigned flag);
1411
1412 /* Warn on an inaccessible file if errno indicates this is an error */
1413 int warn_on_fopen_errors(const char *path);
1414
1415 /*
1416  * Open with O_NOFOLLOW, or equivalent. Note that the fallback equivalent
1417  * may be racy. Do not use this as protection against an attacker who can
1418  * simultaneously create paths.
1419  */
1420 int open_nofollow(const char *path, int flags);
1421
1422 #ifndef SHELL_PATH
1423 # define SHELL_PATH "/bin/sh"
1424 #endif
1425
1426 #ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1427 static inline void flockfile(FILE *fh)
1428 {
1429         ; /* nothing */
1430 }
1431 static inline void funlockfile(FILE *fh)
1432 {
1433         ; /* nothing */
1434 }
1435 #define getc_unlocked(fh) getc(fh)
1436 #endif
1437
1438 #ifdef FILENO_IS_A_MACRO
1439 int git_fileno(FILE *stream);
1440 # ifndef COMPAT_CODE_FILENO
1441 #  undef fileno
1442 #  define fileno(p) git_fileno(p)
1443 # endif
1444 #endif
1445
1446 #ifdef NEED_ACCESS_ROOT_HANDLER
1447 int git_access(const char *path, int mode);
1448 # ifndef COMPAT_CODE_ACCESS
1449 #  ifdef access
1450 #  undef access
1451 #  endif
1452 #  define access(path, mode) git_access(path, mode)
1453 # endif
1454 #endif
1455
1456 /*
1457  * Our code often opens a path to an optional file, to work on its
1458  * contents when we can successfully open it.  We can ignore a failure
1459  * to open if such an optional file does not exist, but we do want to
1460  * report a failure in opening for other reasons (e.g. we got an I/O
1461  * error, or the file is there, but we lack the permission to open).
1462  *
1463  * Call this function after seeing an error from open() or fopen() to
1464  * see if the errno indicates a missing file that we can safely ignore.
1465  */
1466 static inline int is_missing_file_error(int errno_)
1467 {
1468         return (errno_ == ENOENT || errno_ == ENOTDIR);
1469 }
1470
1471 int cmd_main(int, const char **);
1472
1473 /*
1474  * Intercept all calls to exit() and route them to trace2 to
1475  * optionally emit a message before calling the real exit().
1476  */
1477 int common_exit(const char *file, int line, int code);
1478 #define exit(code) exit(common_exit(__FILE__, __LINE__, (code)))
1479
1480 /*
1481  * You can mark a stack variable with UNLEAK(var) to avoid it being
1482  * reported as a leak by tools like LSAN or valgrind. The argument
1483  * should generally be the variable itself (not its address and not what
1484  * it points to). It's safe to use this on pointers which may already
1485  * have been freed, or on pointers which may still be in use.
1486  *
1487  * Use this _only_ for a variable that leaks by going out of scope at
1488  * program exit (so only from cmd_* functions or their direct helpers).
1489  * Normal functions, especially those which may be called multiple
1490  * times, should actually free their memory. This is only meant as
1491  * an annotation, and does nothing in non-leak-checking builds.
1492  */
1493 #ifdef SUPPRESS_ANNOTATED_LEAKS
1494 void unleak_memory(const void *ptr, size_t len);
1495 #define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1496 #else
1497 #define UNLEAK(var) do {} while (0)
1498 #endif
1499
1500 #define z_const
1501 #include <zlib.h>
1502
1503 #if ZLIB_VERNUM < 0x1290
1504 /*
1505  * This is uncompress2, which is only available in zlib >= 1.2.9
1506  * (released as of early 2017). See compat/zlib-uncompress2.c.
1507  */
1508 int uncompress2(Bytef *dest, uLongf *destLen, const Bytef *source,
1509                 uLong *sourceLen);
1510 #endif
1511
1512 /*
1513  * This include must come after system headers, since it introduces macros that
1514  * replace system names.
1515  */
1516 #include "banned.h"
1517
1518 /*
1519  * container_of - Get the address of an object containing a field.
1520  *
1521  * @ptr: pointer to the field.
1522  * @type: type of the object.
1523  * @member: name of the field within the object.
1524  */
1525 #define container_of(ptr, type, member) \
1526         ((type *) ((char *)(ptr) - offsetof(type, member)))
1527
1528 /*
1529  * helper function for `container_of_or_null' to avoid multiple
1530  * evaluation of @ptr
1531  */
1532 static inline void *container_of_or_null_offset(void *ptr, size_t offset)
1533 {
1534         return ptr ? (char *)ptr - offset : NULL;
1535 }
1536
1537 /*
1538  * like `container_of', but allows returned value to be NULL
1539  */
1540 #define container_of_or_null(ptr, type, member) \
1541         (type *)container_of_or_null_offset(ptr, offsetof(type, member))
1542
1543 /*
1544  * like offsetof(), but takes a pointer to a variable of type which
1545  * contains @member, instead of a specified type.
1546  * @ptr is subject to multiple evaluation since we can't rely on __typeof__
1547  * everywhere.
1548  */
1549 #if defined(__GNUC__) /* clang sets this, too */
1550 #define OFFSETOF_VAR(ptr, member) offsetof(__typeof__(*ptr), member)
1551 #else /* !__GNUC__ */
1552 #define OFFSETOF_VAR(ptr, member) \
1553         ((uintptr_t)&(ptr)->member - (uintptr_t)(ptr))
1554 #endif /* !__GNUC__ */
1555
1556 void sleep_millisec(int millisec);
1557
1558 /*
1559  * Generate len bytes from the system cryptographically secure PRNG.
1560  * Returns 0 on success and -1 on error, setting errno.  The inability to
1561  * satisfy the full request is an error.
1562  */
1563 int csprng_bytes(void *buf, size_t len);
1564
1565 #endif