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