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