git.oblomov.eu Git - git/blob - git-compat-util.h

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