Andrew's git / gitweb.git / git-compat-util.h
?
git-compat-util.hon commit editor: add a function to launch the sequence editor (2aed018)
   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 (_MSC_VER) && !defined(_WIN32_WINNT)
 150#  define _WIN32_WINNT 0x0502
 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 save 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#include "compat/bswap.h"
 412
 413#include "wildmatch.h"
 414
 415struct strbuf;
 416
 417/* General helper functions */
 418extern void vreportf(const char *prefix, const char *err, va_list params);
 419extern NORETURN void usage(const char *err);
 420extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
 421extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
 422extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 423extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 424extern int error_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 425extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 426extern void warning_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 427
 428#ifndef NO_OPENSSL
 429#ifdef APPLE_COMMON_CRYPTO
 430#include "compat/apple-common-crypto.h"
 431#else
 432#include <openssl/evp.h>
 433#include <openssl/hmac.h>
 434#endif /* APPLE_COMMON_CRYPTO */
 435#include <openssl/x509v3.h>
 436#endif /* NO_OPENSSL */
 437
 438/*
 439 * Let callers be aware of the constant return value; this can help
 440 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
 441 * because some compilers may not support variadic macros. Since we're only
 442 * trying to help gcc, anyway, it's OK; other compilers will fall back to
 443 * using the function as usual.
 444 */
 445#if defined(__GNUC__)
 446static inline int const_error(void)
 447{
 448        return -1;
 449}
 450#define error(...) (error(__VA_ARGS__), const_error())
 451#define error_errno(...) (error_errno(__VA_ARGS__), const_error())
 452#endif
 453
 454extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
 455extern void set_error_routine(void (*routine)(const char *err, va_list params));
 456extern void (*get_error_routine(void))(const char *err, va_list params);
 457extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
 458extern void (*get_warn_routine(void))(const char *warn, va_list params);
 459extern void set_die_is_recursing_routine(int (*routine)(void));
 460
 461extern int starts_with(const char *str, const char *prefix);
 462extern int istarts_with(const char *str, const char *prefix);
 463
 464/*
 465 * If the string "str" begins with the string found in "prefix", return 1.
 466 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
 467 * the string right after the prefix).
 468 *
 469 * Otherwise, return 0 and leave "out" untouched.
 470 *
 471 * Examples:
 472 *
 473 *   [extract branch name, fail if not a branch]
 474 *   if (!skip_prefix(ref, "refs/heads/", &branch)
 475 *      return -1;
 476 *
 477 *   [skip prefix if present, otherwise use whole string]
 478 *   skip_prefix(name, "refs/heads/", &name);
 479 */
 480static inline int skip_prefix(const char *str, const char *prefix,
 481                              const char **out)
 482{
 483        do {
 484                if (!*prefix) {
 485                        *out = str;
 486                        return 1;
 487                }
 488        } while (*str++ == *prefix++);
 489        return 0;
 490}
 491
 492/*
 493 * If the string "str" is the same as the string in "prefix", then the "arg"
 494 * parameter is set to the "def" parameter and 1 is returned.
 495 * If the string "str" begins with the string found in "prefix" and then a
 496 * "=" sign, then the "arg" parameter is set to "str + strlen(prefix) + 1"
 497 * (i.e., to the point in the string right after the prefix and the "=" sign),
 498 * and 1 is returned.
 499 *
 500 * Otherwise, return 0 and leave "arg" untouched.
 501 *
 502 * When we accept both a "--key" and a "--key=<val>" option, this function
 503 * can be used instead of !strcmp(arg, "--key") and then
 504 * skip_prefix(arg, "--key=", &arg) to parse such an option.
 505 */
 506int skip_to_optional_arg_default(const char *str, const char *prefix,
 507                                 const char **arg, const char *def);
 508
 509static inline int skip_to_optional_arg(const char *str, const char *prefix,
 510                                       const char **arg)
 511{
 512        return skip_to_optional_arg_default(str, prefix, arg, "");
 513}
 514
 515/*
 516 * Like skip_prefix, but promises never to read past "len" bytes of the input
 517 * buffer, and returns the remaining number of bytes in "out" via "outlen".
 518 */
 519static inline int skip_prefix_mem(const char *buf, size_t len,
 520                                  const char *prefix,
 521                                  const char **out, size_t *outlen)
 522{
 523        size_t prefix_len = strlen(prefix);
 524        if (prefix_len <= len && !memcmp(buf, prefix, prefix_len)) {
 525                *out = buf + prefix_len;
 526                *outlen = len - prefix_len;
 527                return 1;
 528        }
 529        return 0;
 530}
 531
 532/*
 533 * If buf ends with suffix, return 1 and subtract the length of the suffix
 534 * from *len. Otherwise, return 0 and leave *len untouched.
 535 */
 536static inline int strip_suffix_mem(const char *buf, size_t *len,
 537                                   const char *suffix)
 538{
 539        size_t suflen = strlen(suffix);
 540        if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
 541                return 0;
 542        *len -= suflen;
 543        return 1;
 544}
 545
 546/*
 547 * If str ends with suffix, return 1 and set *len to the size of the string
 548 * without the suffix. Otherwise, return 0 and set *len to the size of the
 549 * string.
 550 *
 551 * Note that we do _not_ NUL-terminate str to the new length.
 552 */
 553static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
 554{
 555        *len = strlen(str);
 556        return strip_suffix_mem(str, len, suffix);
 557}
 558
 559static inline int ends_with(const char *str, const char *suffix)
 560{
 561        size_t len;
 562        return strip_suffix(str, suffix, &len);
 563}
 564
 565#define SWAP(a, b) do {                                         \
 566        void *_swap_a_ptr = &(a);                               \
 567        void *_swap_b_ptr = &(b);                               \
 568        unsigned char _swap_buffer[sizeof(a)];                  \
 569        memcpy(_swap_buffer, _swap_a_ptr, sizeof(a));           \
 570        memcpy(_swap_a_ptr, _swap_b_ptr, sizeof(a) +            \
 571               BUILD_ASSERT_OR_ZERO(sizeof(a) == sizeof(b)));   \
 572        memcpy(_swap_b_ptr, _swap_buffer, sizeof(a));           \
 573} while (0)
 574
 575#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 576
 577#ifndef PROT_READ
 578#define PROT_READ 1
 579#define PROT_WRITE 2
 580#define MAP_PRIVATE 1
 581#endif
 582
 583#define mmap git_mmap
 584#define munmap git_munmap
 585extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 586extern int git_munmap(void *start, size_t length);
 587
 588#else /* NO_MMAP || USE_WIN32_MMAP */
 589
 590#include <sys/mman.h>
 591
 592#endif /* NO_MMAP || USE_WIN32_MMAP */
 593
 594#ifdef NO_MMAP
 595
 596/* This value must be multiple of (pagesize * 2) */
 597#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 598
 599#else /* NO_MMAP */
 600
 601/* This value must be multiple of (pagesize * 2) */
 602#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 603        (sizeof(void*) >= 8 \
 604                ?  1 * 1024 * 1024 * 1024 \
 605                : 32 * 1024 * 1024)
 606
 607#endif /* NO_MMAP */
 608
 609#ifndef MAP_FAILED
 610#define MAP_FAILED ((void *)-1)
 611#endif
 612
 613#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 614#define on_disk_bytes(st) ((st).st_size)
 615#else
 616#define on_disk_bytes(st) ((st).st_blocks * 512)
 617#endif
 618
 619#ifdef NEEDS_MODE_TRANSLATION
 620#undef S_IFMT
 621#undef S_IFREG
 622#undef S_IFDIR
 623#undef S_IFLNK
 624#undef S_IFBLK
 625#undef S_IFCHR
 626#undef S_IFIFO
 627#undef S_IFSOCK
 628#define S_IFMT   0170000
 629#define S_IFREG  0100000
 630#define S_IFDIR  0040000
 631#define S_IFLNK  0120000
 632#define S_IFBLK  0060000
 633#define S_IFCHR  0020000
 634#define S_IFIFO  0010000
 635#define S_IFSOCK 0140000
 636#ifdef stat
 637#undef stat
 638#endif
 639#define stat(path, buf) git_stat(path, buf)
 640extern int git_stat(const char *, struct stat *);
 641#ifdef fstat
 642#undef fstat
 643#endif
 644#define fstat(fd, buf) git_fstat(fd, buf)
 645extern int git_fstat(int, struct stat *);
 646#ifdef lstat
 647#undef lstat
 648#endif
 649#define lstat(path, buf) git_lstat(path, buf)
 650extern int git_lstat(const char *, struct stat *);
 651#endif
 652
 653#define DEFAULT_PACKED_GIT_LIMIT \
 654        ((1024L * 1024L) * (size_t)(sizeof(void*) >= 8 ? (32 * 1024L * 1024L) : 256))
 655
 656#ifdef NO_PREAD
 657#define pread git_pread
 658extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 659#endif
 660/*
 661 * Forward decl that will remind us if its twin in cache.h changes.
 662 * This function is used in compat/pread.c.  But we can't include
 663 * cache.h there.
 664 */
 665extern ssize_t read_in_full(int fd, void *buf, size_t count);
 666
 667#ifdef NO_SETENV
 668#define setenv gitsetenv
 669extern int gitsetenv(const char *, const char *, int);
 670#endif
 671
 672#ifdef NO_MKDTEMP
 673#define mkdtemp gitmkdtemp
 674extern char *gitmkdtemp(char *);
 675#endif
 676
 677#ifdef NO_UNSETENV
 678#define unsetenv gitunsetenv
 679extern void gitunsetenv(const char *);
 680#endif
 681
 682#ifdef NO_STRCASESTR
 683#define strcasestr gitstrcasestr
 684extern char *gitstrcasestr(const char *haystack, const char *needle);
 685#endif
 686
 687#ifdef NO_STRLCPY
 688#define strlcpy gitstrlcpy
 689extern size_t gitstrlcpy(char *, const char *, size_t);
 690#endif
 691
 692#ifdef NO_STRTOUMAX
 693#define strtoumax gitstrtoumax
 694extern uintmax_t gitstrtoumax(const char *, char **, int);
 695#define strtoimax gitstrtoimax
 696extern intmax_t gitstrtoimax(const char *, char **, int);
 697#endif
 698
 699#ifdef NO_HSTRERROR
 700#define hstrerror githstrerror
 701extern const char *githstrerror(int herror);
 702#endif
 703
 704#ifdef NO_MEMMEM
 705#define memmem gitmemmem
 706void *gitmemmem(const void *haystack, size_t haystacklen,
 707                const void *needle, size_t needlelen);
 708#endif
 709
 710#ifdef OVERRIDE_STRDUP
 711#ifdef strdup
 712#undef strdup
 713#endif
 714#define strdup gitstrdup
 715char *gitstrdup(const char *s);
 716#endif
 717
 718#ifdef NO_GETPAGESIZE
 719#define getpagesize() sysconf(_SC_PAGESIZE)
 720#endif
 721
 722#ifndef O_CLOEXEC
 723#define O_CLOEXEC 0
 724#endif
 725
 726#ifdef FREAD_READS_DIRECTORIES
 727# if !defined(SUPPRESS_FOPEN_REDEFINITION)
 728#  ifdef fopen
 729#   undef fopen
 730#  endif
 731#  define fopen(a,b) git_fopen(a,b)
 732# endif
 733extern FILE *git_fopen(const char*, const char*);
 734#endif
 735
 736#ifdef SNPRINTF_RETURNS_BOGUS
 737#ifdef snprintf
 738#undef snprintf
 739#endif
 740#define snprintf git_snprintf
 741extern int git_snprintf(char *str, size_t maxsize,
 742                        const char *format, ...);
 743#ifdef vsnprintf
 744#undef vsnprintf
 745#endif
 746#define vsnprintf git_vsnprintf
 747extern int git_vsnprintf(char *str, size_t maxsize,
 748                         const char *format, va_list ap);
 749#endif
 750
 751#ifdef __GLIBC_PREREQ
 752#if __GLIBC_PREREQ(2, 1)
 753#define HAVE_STRCHRNUL
 754#endif
 755#endif
 756
 757#ifndef HAVE_STRCHRNUL
 758#define strchrnul gitstrchrnul
 759static inline char *gitstrchrnul(const char *s, int c)
 760{
 761        while (*s && *s != c)
 762                s++;
 763        return (char *)s;
 764}
 765#endif
 766
 767#ifdef NO_INET_PTON
 768int inet_pton(int af, const char *src, void *dst);
 769#endif
 770
 771#ifdef NO_INET_NTOP
 772const char *inet_ntop(int af, const void *src, char *dst, size_t size);
 773#endif
 774
 775#ifdef NO_PTHREADS
 776#define atexit git_atexit
 777extern int git_atexit(void (*handler)(void));
 778#endif
 779
 780typedef void (*try_to_free_t)(size_t);
 781extern try_to_free_t set_try_to_free_routine(try_to_free_t);
 782
 783static inline size_t st_add(size_t a, size_t b)
 784{
 785        if (unsigned_add_overflows(a, b))
 786                die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
 787                    (uintmax_t)a, (uintmax_t)b);
 788        return a + b;
 789}
 790#define st_add3(a,b,c)   st_add(st_add((a),(b)),(c))
 791#define st_add4(a,b,c,d) st_add(st_add3((a),(b),(c)),(d))
 792
 793static inline size_t st_mult(size_t a, size_t b)
 794{
 795        if (unsigned_mult_overflows(a, b))
 796                die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
 797                    (uintmax_t)a, (uintmax_t)b);
 798        return a * b;
 799}
 800
 801static inline size_t st_sub(size_t a, size_t b)
 802{
 803        if (a < b)
 804                die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
 805                    (uintmax_t)a, (uintmax_t)b);
 806        return a - b;
 807}
 808
 809#ifdef HAVE_ALLOCA_H
 810# include <alloca.h>
 811# define xalloca(size)      (alloca(size))
 812# define xalloca_free(p)    do {} while (0)
 813#else
 814# define xalloca(size)      (xmalloc(size))
 815# define xalloca_free(p)    (free(p))
 816#endif
 817extern char *xstrdup(const char *str);
 818extern void *xmalloc(size_t size);
 819extern void *xmallocz(size_t size);
 820extern void *xmallocz_gently(size_t size);
 821extern void *xmemdupz(const void *data, size_t len);
 822extern char *xstrndup(const char *str, size_t len);
 823extern void *xrealloc(void *ptr, size_t size);
 824extern void *xcalloc(size_t nmemb, size_t size);
 825extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 826extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 827extern int xopen(const char *path, int flags, ...);
 828extern ssize_t xread(int fd, void *buf, size_t len);
 829extern ssize_t xwrite(int fd, const void *buf, size_t len);
 830extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
 831extern int xdup(int fd);
 832extern FILE *xfopen(const char *path, const char *mode);
 833extern FILE *xfdopen(int fd, const char *mode);
 834extern int xmkstemp(char *temp_filename);
 835extern int xmkstemp_mode(char *temp_filename, int mode);
 836extern char *xgetcwd(void);
 837extern FILE *fopen_for_writing(const char *path);
 838extern FILE *fopen_or_warn(const char *path, const char *mode);
 839
 840/*
 841 * FREE_AND_NULL(ptr) is like free(ptr) followed by ptr = NULL. Note
 842 * that ptr is used twice, so don't pass e.g. ptr++.
 843 */
 844#define FREE_AND_NULL(p) do { free(p); (p) = NULL; } while (0)
 845
 846#define ALLOC_ARRAY(x, alloc) (x) = xmalloc(st_mult(sizeof(*(x)), (alloc)))
 847#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), st_mult(sizeof(*(x)), (alloc)))
 848
 849#define COPY_ARRAY(dst, src, n) copy_array((dst), (src), (n), sizeof(*(dst)) + \
 850        BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
 851static inline void copy_array(void *dst, const void *src, size_t n, size_t size)
 852{
 853        if (n)
 854                memcpy(dst, src, st_mult(size, n));
 855}
 856
 857#define MOVE_ARRAY(dst, src, n) move_array((dst), (src), (n), sizeof(*(dst)) + \
 858        BUILD_ASSERT_OR_ZERO(sizeof(*(dst)) == sizeof(*(src))))
 859static inline void move_array(void *dst, const void *src, size_t n, size_t size)
 860{
 861        if (n)
 862                memmove(dst, src, st_mult(size, n));
 863}
 864
 865/*
 866 * These functions help you allocate structs with flex arrays, and copy
 867 * the data directly into the array. For example, if you had:
 868 *
 869 *   struct foo {
 870 *     int bar;
 871 *     char name[FLEX_ARRAY];
 872 *   };
 873 *
 874 * you can do:
 875 *
 876 *   struct foo *f;
 877 *   FLEX_ALLOC_MEM(f, name, src, len);
 878 *
 879 * to allocate a "foo" with the contents of "src" in the "name" field.
 880 * The resulting struct is automatically zero'd, and the flex-array field
 881 * is NUL-terminated (whether the incoming src buffer was or not).
 882 *
 883 * The FLEXPTR_* variants operate on structs that don't use flex-arrays,
 884 * but do want to store a pointer to some extra data in the same allocated
 885 * block. For example, if you have:
 886 *
 887 *   struct foo {
 888 *     char *name;
 889 *     int bar;
 890 *   };
 891 *
 892 * you can do:
 893 *
 894 *   struct foo *f;
 895 *   FLEXPTR_ALLOC_STR(f, name, src);
 896 *
 897 * and "name" will point to a block of memory after the struct, which will be
 898 * freed along with the struct (but the pointer can be repointed anywhere).
 899 *
 900 * The *_STR variants accept a string parameter rather than a ptr/len
 901 * combination.
 902 *
 903 * Note that these macros will evaluate the first parameter multiple
 904 * times, and it must be assignable as an lvalue.
 905 */
 906#define FLEX_ALLOC_MEM(x, flexname, buf, len) do { \
 907        size_t flex_array_len_ = (len); \
 908        (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
 909        memcpy((void *)(x)->flexname, (buf), flex_array_len_); \
 910} while (0)
 911#define FLEXPTR_ALLOC_MEM(x, ptrname, buf, len) do { \
 912        size_t flex_array_len_ = (len); \
 913        (x) = xcalloc(1, st_add3(sizeof(*(x)), flex_array_len_, 1)); \
 914        memcpy((x) + 1, (buf), flex_array_len_); \
 915        (x)->ptrname = (void *)((x)+1); \
 916} while(0)
 917#define FLEX_ALLOC_STR(x, flexname, str) \
 918        FLEX_ALLOC_MEM((x), flexname, (str), strlen(str))
 919#define FLEXPTR_ALLOC_STR(x, ptrname, str) \
 920        FLEXPTR_ALLOC_MEM((x), ptrname, (str), strlen(str))
 921
 922static inline char *xstrdup_or_null(const char *str)
 923{
 924        return str ? xstrdup(str) : NULL;
 925}
 926
 927static inline size_t xsize_t(off_t len)
 928{
 929        size_t size = (size_t) len;
 930
 931        if (len != (off_t) size)
 932                die("Cannot handle files this big");
 933        return size;
 934}
 935
 936__attribute__((format (printf, 3, 4)))
 937extern int xsnprintf(char *dst, size_t max, const char *fmt, ...);
 938
 939#ifndef HOST_NAME_MAX
 940#define HOST_NAME_MAX 256
 941#endif
 942
 943extern int xgethostname(char *buf, size_t len);
 944
 945/* in ctype.c, for kwset users */
 946extern const unsigned char tolower_trans_tbl[256];
 947
 948/* Sane ctype - no locale, and works with signed chars */
 949#undef isascii
 950#undef isspace
 951#undef isdigit
 952#undef isalpha
 953#undef isalnum
 954#undef isprint
 955#undef islower
 956#undef isupper
 957#undef tolower
 958#undef toupper
 959#undef iscntrl
 960#undef ispunct
 961#undef isxdigit
 962
 963extern const unsigned char sane_ctype[256];
 964#define GIT_SPACE 0x01
 965#define GIT_DIGIT 0x02
 966#define GIT_ALPHA 0x04
 967#define GIT_GLOB_SPECIAL 0x08
 968#define GIT_REGEX_SPECIAL 0x10
 969#define GIT_PATHSPEC_MAGIC 0x20
 970#define GIT_CNTRL 0x40
 971#define GIT_PUNCT 0x80
 972#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 973#define isascii(x) (((x) & ~0x7f) == 0)
 974#define isspace(x) sane_istest(x,GIT_SPACE)
 975#define isdigit(x) sane_istest(x,GIT_DIGIT)
 976#define isalpha(x) sane_istest(x,GIT_ALPHA)
 977#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 978#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
 979#define islower(x) sane_iscase(x, 1)
 980#define isupper(x) sane_iscase(x, 0)
 981#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
 982#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
 983#define iscntrl(x) (sane_istest(x,GIT_CNTRL))
 984#define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
 985                GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
 986#define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
 987#define tolower(x) sane_case((unsigned char)(x), 0x20)
 988#define toupper(x) sane_case((unsigned char)(x), 0)
 989#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
 990
 991static inline int sane_case(int x, int high)
 992{
 993        if (sane_istest(x, GIT_ALPHA))
 994                x = (x & ~0x20) | high;
 995        return x;
 996}
 997
 998static inline int sane_iscase(int x, int is_lower)
 999{
1000        if (!sane_istest(x, GIT_ALPHA))
1001                return 0;
1002
1003        if (is_lower)
1004                return (x & 0x20) != 0;
1005        else
1006                return (x & 0x20) == 0;
1007}
1008
1009/*
1010 * Like skip_prefix, but compare case-insensitively. Note that the comparison
1011 * is done via tolower(), so it is strictly ASCII (no multi-byte characters or
1012 * locale-specific conversions).
1013 */
1014static inline int skip_iprefix(const char *str, const char *prefix,
1015                               const char **out)
1016{
1017        do {
1018                if (!*prefix) {
1019                        *out = str;
1020                        return 1;
1021                }
1022        } while (tolower(*str++) == tolower(*prefix++));
1023        return 0;
1024}
1025
1026static inline int strtoul_ui(char const *s, int base, unsigned int *result)
1027{
1028        unsigned long ul;
1029        char *p;
1030
1031        errno = 0;
1032        /* negative values would be accepted by strtoul */
1033        if (strchr(s, '-'))
1034                return -1;
1035        ul = strtoul(s, &p, base);
1036        if (errno || *p || p == s || (unsigned int) ul != ul)
1037                return -1;
1038        *result = ul;
1039        return 0;
1040}
1041
1042static inline int strtol_i(char const *s, int base, int *result)
1043{
1044        long ul;
1045        char *p;
1046
1047        errno = 0;
1048        ul = strtol(s, &p, base);
1049        if (errno || *p || p == s || (int) ul != ul)
1050                return -1;
1051        *result = ul;
1052        return 0;
1053}
1054
1055#ifdef INTERNAL_QSORT
1056void git_qsort(void *base, size_t nmemb, size_t size,
1057               int(*compar)(const void *, const void *));
1058#define qsort git_qsort
1059#endif
1060
1061#define QSORT(base, n, compar) sane_qsort((base), (n), sizeof(*(base)), compar)
1062static inline void sane_qsort(void *base, size_t nmemb, size_t size,
1063                              int(*compar)(const void *, const void *))
1064{
1065        if (nmemb > 1)
1066                qsort(base, nmemb, size, compar);
1067}
1068
1069#ifndef HAVE_ISO_QSORT_S
1070int git_qsort_s(void *base, size_t nmemb, size_t size,
1071                int (*compar)(const void *, const void *, void *), void *ctx);
1072#define qsort_s git_qsort_s
1073#endif
1074
1075#define QSORT_S(base, n, compar, ctx) do {                      \
1076        if (qsort_s((base), (n), sizeof(*(base)), compar, ctx)) \
1077                BUG("qsort_s() failed");                        \
1078} while (0)
1079
1080#ifndef REG_STARTEND
1081#error "Git requires REG_STARTEND support. Compile with NO_REGEX=NeedsStartEnd"
1082#endif
1083
1084static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,
1085                              size_t nmatch, regmatch_t pmatch[], int eflags)
1086{
1087        assert(nmatch > 0 && pmatch);
1088        pmatch[0].rm_so = 0;
1089        pmatch[0].rm_eo = size;
1090        return regexec(preg, buf, nmatch, pmatch, eflags | REG_STARTEND);
1091}
1092
1093#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
1094# define FORCE_DIR_SET_GID S_ISGID
1095#else
1096# define FORCE_DIR_SET_GID 0
1097#endif
1098
1099#ifdef NO_NSEC
1100#undef USE_NSEC
1101#define ST_CTIME_NSEC(st) 0
1102#define ST_MTIME_NSEC(st) 0
1103#else
1104#ifdef USE_ST_TIMESPEC
1105#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
1106#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
1107#else
1108#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
1109#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
1110#endif
1111#endif
1112
1113#ifdef UNRELIABLE_FSTAT
1114#define fstat_is_reliable() 0
1115#else
1116#define fstat_is_reliable() 1
1117#endif
1118
1119#ifndef va_copy
1120/*
1121 * Since an obvious implementation of va_list would be to make it a
1122 * pointer into the stack frame, a simple assignment will work on
1123 * many systems.  But let's try to be more portable.
1124 */
1125#ifdef __va_copy
1126#define va_copy(dst, src) __va_copy(dst, src)
1127#else
1128#define va_copy(dst, src) ((dst) = (src))
1129#endif
1130#endif
1131
1132#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
1133#define HAVE_VARIADIC_MACROS 1
1134#endif
1135
1136/* usage.c: only to be used for testing BUG() implementation (see test-tool) */
1137extern int BUG_exit_code;
1138
1139#ifdef HAVE_VARIADIC_MACROS
1140__attribute__((format (printf, 3, 4))) NORETURN
1141void BUG_fl(const char *file, int line, const char *fmt, ...);
1142#define BUG(...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__)
1143#else
1144__attribute__((format (printf, 1, 2))) NORETURN
1145void BUG(const char *fmt, ...);
1146#endif
1147
1148/*
1149 * Preserves errno, prints a message, but gives no warning for ENOENT.
1150 * Returns 0 on success, which includes trying to unlink an object that does
1151 * not exist.
1152 */
1153int unlink_or_warn(const char *path);
1154 /*
1155  * Tries to unlink file.  Returns 0 if unlink succeeded
1156  * or the file already didn't exist.  Returns -1 and
1157  * appends a message to err suitable for
1158  * 'error("%s", err->buf)' on error.
1159  */
1160int unlink_or_msg(const char *file, struct strbuf *err);
1161/*
1162 * Preserves errno, prints a message, but gives no warning for ENOENT.
1163 * Returns 0 on success, which includes trying to remove a directory that does
1164 * not exist.
1165 */
1166int rmdir_or_warn(const char *path);
1167/*
1168 * Calls the correct function out of {unlink,rmdir}_or_warn based on
1169 * the supplied file mode.
1170 */
1171int remove_or_warn(unsigned int mode, const char *path);
1172
1173/*
1174 * Call access(2), but warn for any error except "missing file"
1175 * (ENOENT or ENOTDIR).
1176 */
1177#define ACCESS_EACCES_OK (1U << 0)
1178int access_or_warn(const char *path, int mode, unsigned flag);
1179int access_or_die(const char *path, int mode, unsigned flag);
1180
1181/* Warn on an inaccessible file if errno indicates this is an error */
1182int warn_on_fopen_errors(const char *path);
1183
1184#ifdef GMTIME_UNRELIABLE_ERRORS
1185struct tm *git_gmtime(const time_t *);
1186struct tm *git_gmtime_r(const time_t *, struct tm *);
1187#define gmtime git_gmtime
1188#define gmtime_r git_gmtime_r
1189#endif
1190
1191#if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
1192#define USE_PARENS_AROUND_GETTEXT_N 1
1193#endif
1194
1195#ifndef SHELL_PATH
1196# define SHELL_PATH "/bin/sh"
1197#endif
1198
1199#ifndef _POSIX_THREAD_SAFE_FUNCTIONS
1200#define flockfile(fh)
1201#define funlockfile(fh)
1202#define getc_unlocked(fh) getc(fh)
1203#endif
1204
1205/*
1206 * Our code often opens a path to an optional file, to work on its
1207 * contents when we can successfully open it.  We can ignore a failure
1208 * to open if such an optional file does not exist, but we do want to
1209 * report a failure in opening for other reasons (e.g. we got an I/O
1210 * error, or the file is there, but we lack the permission to open).
1211 *
1212 * Call this function after seeing an error from open() or fopen() to
1213 * see if the errno indicates a missing file that we can safely ignore.
1214 */
1215static inline int is_missing_file_error(int errno_)
1216{
1217        return (errno_ == ENOENT || errno_ == ENOTDIR);
1218}
1219
1220extern int cmd_main(int, const char **);
1221
1222/*
1223 * You can mark a stack variable with UNLEAK(var) to avoid it being
1224 * reported as a leak by tools like LSAN or valgrind. The argument
1225 * should generally be the variable itself (not its address and not what
1226 * it points to). It's safe to use this on pointers which may already
1227 * have been freed, or on pointers which may still be in use.
1228 *
1229 * Use this _only_ for a variable that leaks by going out of scope at
1230 * program exit (so only from cmd_* functions or their direct helpers).
1231 * Normal functions, especially those which may be called multiple
1232 * times, should actually free their memory. This is only meant as
1233 * an annotation, and does nothing in non-leak-checking builds.
1234 */
1235#ifdef SUPPRESS_ANNOTATED_LEAKS
1236extern void unleak_memory(const void *ptr, size_t len);
1237#define UNLEAK(var) unleak_memory(&(var), sizeof(var))
1238#else
1239#define UNLEAK(var) do {} while (0)
1240#endif
1241
1242#endif