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