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