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