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/wait.h>
 199 #include <sys/resource.h>
 200 #include <sys/socket.h>
 201 #include <sys/ioctl.h>
 202 #include <termios.h>
 203 #ifndef NO_SYS_SELECT_H
 204 #include <sys/select.h>
 205 #endif
 206 #include <netinet/in.h>
 207 #include <netinet/tcp.h>
 208 #include <arpa/inet.h>
 209 #include <netdb.h>
 210 #include <pwd.h>
 211 #include <sys/un.h>
 212 #ifndef NO_INTTYPES_H
 213 #include <inttypes.h>
 214 #else
 215 #include <stdint.h>
 216 #endif
 217 #ifdef NO_INTPTR_T
 218 /*
 219  * On I16LP32, ILP32 and LP64 "long" is the save bet, however
 220  * on LLP86, IL33LLP64 and P64 it needs to be "long long",
 221  * while on IP16 and IP16L32 it is "int" (resp. "short")
 222  * Size needs to match (or exceed) 'sizeof(void *)'.
 223  * We can't take "long long" here as not everybody has it.
 224  */
 225 typedef long intptr_t;
 226 typedef unsigned long uintptr_t;
 227 #endif
 228 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
 229 #include <grp.h>
 230 #define _ALL_SOURCE 1
 231 #endif
 232
 233 /* used on Mac OS X */
 234 #ifdef PRECOMPOSE_UNICODE
 235 #include "compat/precompose_utf8.h"
 236 #else
 237 #define precompose_str(in,i_nfd2nfc)
 238 #define precompose_argv(c,v)
 239 #define probe_utf8_pathname_composition(a,b)
 240 #endif
 241
 242 #ifdef MKDIR_WO_TRAILING_SLASH
 243 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
 244 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
 245 #endif
 246
 247 #ifdef NO_STRUCT_ITIMERVAL
 248 struct itimerval {
 249         struct timeval it_interval;
 250         struct timeval it_value;
 251 };
 252 #endif
 253
 254 #ifdef NO_SETITIMER
 255 #define setitimer(which,value,ovalue)
 256 #endif
 257
 258 #ifndef NO_LIBGEN_H
 259 #include <libgen.h>
 260 #else
 261 #define basename gitbasename
 262 extern char *gitbasename(char *);
 263 #endif
 264
 265 #ifndef NO_ICONV
 266 #include <iconv.h>
 267 #endif
 268
 269 #ifndef NO_OPENSSL
 270 #ifdef __APPLE__
 271 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
 272 #include <AvailabilityMacros.h>
 273 #undef DEPRECATED_ATTRIBUTE
 274 #define DEPRECATED_ATTRIBUTE
 275 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
 276 #endif
 277 #include <openssl/ssl.h>
 278 #include <openssl/err.h>
 279 #ifdef NO_HMAC_CTX_CLEANUP
 280 #define HMAC_CTX_cleanup HMAC_cleanup
 281 #endif
 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 PRIu32
 307 #define PRIu32 "u"
 308 #endif
 309
 310 #ifndef PRIx32
 311 #define PRIx32 "x"
 312 #endif
 313
 314 #ifndef PRIo32
 315 #define PRIo32 "o"
 316 #endif
 317
 318 #ifndef PATH_SEP
 319 #define PATH_SEP ':'
 320 #endif
 321
 322 #ifdef HAVE_PATHS_H
 323 #include <paths.h>
 324 #endif
 325 #ifndef _PATH_DEFPATH
 326 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
 327 #endif
 328
 329 #ifndef STRIP_EXTENSION
 330 #define STRIP_EXTENSION ""
 331 #endif
 332
 333 #ifndef has_dos_drive_prefix
 334 static inline int git_has_dos_drive_prefix(const char *path)
 335 {
 336         return 0;
 337 }
 338 #define has_dos_drive_prefix git_has_dos_drive_prefix
 339 #endif
 340
 341 #ifndef is_dir_sep
 342 static inline int git_is_dir_sep(int c)
 343 {
 344         return c == '/';
 345 }
 346 #define is_dir_sep git_is_dir_sep
 347 #endif
 348
 349 #ifndef offset_1st_component
 350 static inline int git_offset_1st_component(const char *path)
 351 {
 352         return is_dir_sep(path[0]);
 353 }
 354 #define offset_1st_component git_offset_1st_component
 355 #endif
 356
 357 #ifndef find_last_dir_sep
 358 static inline char *git_find_last_dir_sep(const char *path)
 359 {
 360         return strrchr(path, '/');
 361 }
 362 #define find_last_dir_sep git_find_last_dir_sep
 363 #endif
 364
 365 #if defined(__HP_cc) && (__HP_cc >= 61000)
 366 #define NORETURN __attribute__((noreturn))
 367 #define NORETURN_PTR
 368 #elif defined(__GNUC__) && !defined(NO_NORETURN)
 369 #define NORETURN __attribute__((__noreturn__))
 370 #define NORETURN_PTR __attribute__((__noreturn__))
 371 #elif defined(_MSC_VER)
 372 #define NORETURN __declspec(noreturn)
 373 #define NORETURN_PTR
 374 #else
 375 #define NORETURN
 376 #define NORETURN_PTR
 377 #ifndef __GNUC__
 378 #ifndef __attribute__
 379 #define __attribute__(x)
 380 #endif
 381 #endif
 382 #endif
 383
 384 /* The sentinel attribute is valid from gcc version 4.0 */
 385 #if defined(__GNUC__) && (__GNUC__ >= 4)
 386 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
 387 #else
 388 #define LAST_ARG_MUST_BE_NULL
 389 #endif
 390
 391 #include "compat/bswap.h"
 392
 393 #include "wildmatch.h"
 394
 395 struct strbuf;
 396
 397 /* General helper functions */
 398 extern void vreportf(const char *prefix, const char *err, va_list params);
 399 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
 400 extern NORETURN void usage(const char *err);
 401 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
 402 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
 403 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 404 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 405 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 406
 407 #ifndef NO_OPENSSL
 408 #ifdef APPLE_COMMON_CRYPTO
 409 #include "compat/apple-common-crypto.h"
 410 #else
 411 #include <openssl/evp.h>
 412 #include <openssl/hmac.h>
 413 #endif /* APPLE_COMMON_CRYPTO */
 414 #include <openssl/x509v3.h>
 415 #endif /* NO_OPENSSL */
 416
 417 /*
 418  * Let callers be aware of the constant return value; this can help
 419  * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
 420  * because some compilers may not support variadic macros. Since we're only
 421  * trying to help gcc, anyway, it's OK; other compilers will fall back to
 422  * using the function as usual.
 423  */
 424 #if defined(__GNUC__)
 425 static inline int const_error(void)
 426 {
 427         return -1;
 428 }
 429 #define error(...) (error(__VA_ARGS__), const_error())
 430 #endif
 431
 432 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
 433 extern void set_error_routine(void (*routine)(const char *err, va_list params));
 434 extern void set_die_is_recursing_routine(int (*routine)(void));
 435
 436 extern int starts_with(const char *str, const char *prefix);
 437
 438 /*
 439  * If the string "str" begins with the string found in "prefix", return 1.
 440  * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
 441  * the string right after the prefix).
 442  *
 443  * Otherwise, return 0 and leave "out" untouched.
 444  *
 445  * Examples:
 446  *
 447  *   [extract branch name, fail if not a branch]
 448  *   if (!skip_prefix(ref, "refs/heads/", &branch)
 449  *      return -1;
 450  *
 451  *   [skip prefix if present, otherwise use whole string]
 452  *   skip_prefix(name, "refs/heads/", &name);
 453  */
 454 static inline int skip_prefix(const char *str, const char *prefix,
 455                               const char **out)
 456 {
 457         do {
 458                 if (!*prefix) {
 459                         *out = str;
 460                         return 1;
 461                 }
 462         } while (*str++ == *prefix++);
 463         return 0;
 464 }
 465
 466 /*
 467  * If buf ends with suffix, return 1 and subtract the length of the suffix
 468  * from *len. Otherwise, return 0 and leave *len untouched.
 469  */
 470 static inline int strip_suffix_mem(const char *buf, size_t *len,
 471                                    const char *suffix)
 472 {
 473         size_t suflen = strlen(suffix);
 474         if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
 475                 return 0;
 476         *len -= suflen;
 477         return 1;
 478 }
 479
 480 /*
 481  * If str ends with suffix, return 1 and set *len to the size of the string
 482  * without the suffix. Otherwise, return 0 and set *len to the size of the
 483  * string.
 484  *
 485  * Note that we do _not_ NUL-terminate str to the new length.
 486  */
 487 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
 488 {
 489         *len = strlen(str);
 490         return strip_suffix_mem(str, len, suffix);
 491 }
 492
 493 static inline int ends_with(const char *str, const char *suffix)
 494 {
 495         size_t len;
 496         return strip_suffix(str, suffix, &len);
 497 }
 498
 499 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 500
 501 #ifndef PROT_READ
 502 #define PROT_READ 1
 503 #define PROT_WRITE 2
 504 #define MAP_PRIVATE 1
 505 #endif
 506
 507 #define mmap git_mmap
 508 #define munmap git_munmap
 509 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 510 extern int git_munmap(void *start, size_t length);
 511
 512 #else /* NO_MMAP || USE_WIN32_MMAP */
 513
 514 #include <sys/mman.h>
 515
 516 #endif /* NO_MMAP || USE_WIN32_MMAP */
 517
 518 #ifdef NO_MMAP
 519
 520 /* This value must be multiple of (pagesize * 2) */
 521 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 522
 523 #else /* NO_MMAP */
 524
 525 /* This value must be multiple of (pagesize * 2) */
 526 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 527         (sizeof(void*) >= 8 \
 528                 ?  1 * 1024 * 1024 * 1024 \
 529                 : 32 * 1024 * 1024)
 530
 531 #endif /* NO_MMAP */
 532
 533 #ifndef MAP_FAILED
 534 #define MAP_FAILED ((void *)-1)
 535 #endif
 536
 537 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 538 #define on_disk_bytes(st) ((st).st_size)
 539 #else
 540 #define on_disk_bytes(st) ((st).st_blocks * 512)
 541 #endif
 542
 543 #ifdef NEEDS_MODE_TRANSLATION
 544 #undef S_IFMT
 545 #undef S_IFREG
 546 #undef S_IFDIR
 547 #undef S_IFLNK
 548 #undef S_IFBLK
 549 #undef S_IFCHR
 550 #undef S_IFIFO
 551 #undef S_IFSOCK
 552 #define S_IFMT   0170000
 553 #define S_IFREG  0100000
 554 #define S_IFDIR  0040000
 555 #define S_IFLNK  0120000
 556 #define S_IFBLK  0060000
 557 #define S_IFCHR  0020000
 558 #define S_IFIFO  0010000
 559 #define S_IFSOCK 0140000
 560 #ifdef stat
 561 #undef stat
 562 #endif
 563 #define stat(path, buf) git_stat(path, buf)
 564 extern int git_stat(const char *, struct stat *);
 565 #ifdef fstat
 566 #undef fstat
 567 #endif
 568 #define fstat(fd, buf) git_fstat(fd, buf)
 569 extern int git_fstat(int, struct stat *);
 570 #ifdef lstat
 571 #undef lstat
 572 #endif
 573 #define lstat(path, buf) git_lstat(path, buf)
 574 extern int git_lstat(const char *, struct stat *);
 575 #endif
 576
 577 #define DEFAULT_PACKED_GIT_LIMIT \
 578         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 579
 580 #ifdef NO_PREAD
 581 #define pread git_pread
 582 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 583 #endif
 584 /*
 585  * Forward decl that will remind us if its twin in cache.h changes.
 586  * This function is used in compat/pread.c.  But we can't include
 587  * cache.h there.
 588  */
 589 extern ssize_t read_in_full(int fd, void *buf, size_t count);
 590
 591 #ifdef NO_SETENV
 592 #define setenv gitsetenv
 593 extern int gitsetenv(const char *, const char *, int);
 594 #endif
 595
 596 #ifdef NO_MKDTEMP
 597 #define mkdtemp gitmkdtemp
 598 extern char *gitmkdtemp(char *);
 599 #endif
 600
 601 #ifdef NO_MKSTEMPS
 602 #define mkstemps gitmkstemps
 603 extern int gitmkstemps(char *, int);
 604 #endif
 605
 606 #ifdef NO_UNSETENV
 607 #define unsetenv gitunsetenv
 608 extern void gitunsetenv(const char *);
 609 #endif
 610
 611 #ifdef NO_STRCASESTR
 612 #define strcasestr gitstrcasestr
 613 extern char *gitstrcasestr(const char *haystack, const char *needle);
 614 #endif
 615
 616 #ifdef NO_STRLCPY
 617 #define strlcpy gitstrlcpy
 618 extern size_t gitstrlcpy(char *, const char *, size_t);
 619 #endif
 620
 621 #ifdef NO_STRTOUMAX
 622 #define strtoumax gitstrtoumax
 623 extern uintmax_t gitstrtoumax(const char *, char **, int);
 624 #define strtoimax gitstrtoimax
 625 extern intmax_t gitstrtoimax(const char *, char **, int);
 626 #endif
 627
 628 #ifdef NO_HSTRERROR
 629 #define hstrerror githstrerror
 630 extern const char *githstrerror(int herror);
 631 #endif
 632
 633 #ifdef NO_MEMMEM
 634 #define memmem gitmemmem
 635 void *gitmemmem(const void *haystack, size_t haystacklen,
 636                 const void *needle, size_t needlelen);
 637 #endif
 638
 639 #ifdef NO_GETPAGESIZE
 640 #define getpagesize() sysconf(_SC_PAGESIZE)
 641 #endif
 642
 643 #ifdef FREAD_READS_DIRECTORIES
 644 #ifdef fopen
 645 #undef fopen
 646 #endif
 647 #define fopen(a,b) git_fopen(a,b)
 648 extern FILE *git_fopen(const char*, const char*);
 649 #endif
 650
 651 #ifdef SNPRINTF_RETURNS_BOGUS
 652 #ifdef snprintf
 653 #undef snprintf
 654 #endif
 655 #define snprintf git_snprintf
 656 extern int git_snprintf(char *str, size_t maxsize,
 657                         const char *format, ...);
 658 #ifdef vsnprintf
 659 #undef vsnprintf
 660 #endif
 661 #define vsnprintf git_vsnprintf
 662 extern int git_vsnprintf(char *str, size_t maxsize,
 663                          const char *format, va_list ap);
 664 #endif
 665
 666 #ifdef __GLIBC_PREREQ
 667 #if __GLIBC_PREREQ(2, 1)
 668 #define HAVE_STRCHRNUL
 669 #define HAVE_MEMPCPY
 670 #endif
 671 #endif
 672
 673 #ifndef HAVE_STRCHRNUL
 674 #define strchrnul gitstrchrnul
 675 static inline char *gitstrchrnul(const char *s, int c)
 676 {
 677         while (*s && *s != c)
 678                 s++;
 679         return (char *)s;
 680 }
 681 #endif
 682
 683 #ifndef HAVE_MEMPCPY
 684 #define mempcpy gitmempcpy
 685 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
 686 {
 687         return (char *)memcpy(dest, src, n) + n;
 688 }
 689 #endif
 690
 691 #ifdef NO_INET_PTON
 692 int inet_pton(int af, const char *src, void *dst);
 693 #endif
 694
 695 #ifdef NO_INET_NTOP
 696 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
 697 #endif
 698
 699 #ifdef NO_PTHREADS
 700 #define atexit git_atexit
 701 extern int git_atexit(void (*handler)(void));
 702 #endif
 703
 704 extern void release_pack_memory(size_t);
 705
 706 typedef void (*try_to_free_t)(size_t);
 707 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
 708
 709 static inline size_t st_add(size_t a, size_t b)
 710 {
 711         if (unsigned_add_overflows(a, b))
 712                 die("size_t overflow: %"PRIuMAX" + %"PRIuMAX,
 713                     (uintmax_t)a, (uintmax_t)b);
 714         return a + b;
 715 }
 716 #define st_add3(a,b,c)   st_add((a),st_add((b),(c)))
 717 #define st_add4(a,b,c,d) st_add((a),st_add3((b),(c),(d)))
 718
 719 static inline size_t st_mult(size_t a, size_t b)
 720 {
 721         if (unsigned_mult_overflows(a, b))
 722                 die("size_t overflow: %"PRIuMAX" * %"PRIuMAX,
 723                     (uintmax_t)a, (uintmax_t)b);
 724         return a * b;
 725 }
 726
 727 static inline size_t st_sub(size_t a, size_t b)
 728 {
 729         if (a < b)
 730                 die("size_t underflow: %"PRIuMAX" - %"PRIuMAX,
 731                     (uintmax_t)a, (uintmax_t)b);
 732         return a - b;
 733 }
 734
 735 #ifdef HAVE_ALLOCA_H
 736 # include <alloca.h>
 737 # define xalloca(size)      (alloca(size))
 738 # define xalloca_free(p)    do {} while (0)
 739 #else
 740 # define xalloca(size)      (xmalloc(size))
 741 # define xalloca_free(p)    (free(p))
 742 #endif
 743 extern char *xstrdup(const char *str);
 744 extern void *xmalloc(size_t size);
 745 extern void *xmallocz(size_t size);
 746 extern void *xmallocz_gently(size_t size);
 747 extern void *xmemdupz(const void *data, size_t len);
 748 extern char *xstrndup(const char *str, size_t len);
 749 extern void *xrealloc(void *ptr, size_t size);
 750 extern void *xcalloc(size_t nmemb, size_t size);
 751 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 752 extern void *xmmap_gently(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 753 extern ssize_t xread(int fd, void *buf, size_t len);
 754 extern ssize_t xwrite(int fd, const void *buf, size_t len);
 755 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
 756 extern int xdup(int fd);
 757 extern FILE *xfdopen(int fd, const char *mode);
 758 extern int xmkstemp(char *template);
 759 extern int xmkstemp_mode(char *template, int mode);
 760 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
 761 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
 762 extern char *xgetcwd(void);
 763
 764 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
 765
 766 static inline char *xstrdup_or_null(const char *str)
 767 {
 768         return str ? xstrdup(str) : NULL;
 769 }
 770
 771 static inline size_t xsize_t(off_t len)
 772 {
 773         if (len > (size_t) len)
 774                 die("Cannot handle files this big");
 775         return (size_t)len;
 776 }
 777
 778 /* in ctype.c, for kwset users */
 779 extern const unsigned char tolower_trans_tbl[256];
 780
 781 /* Sane ctype - no locale, and works with signed chars */
 782 #undef isascii
 783 #undef isspace
 784 #undef isdigit
 785 #undef isalpha
 786 #undef isalnum
 787 #undef isprint
 788 #undef islower
 789 #undef isupper
 790 #undef tolower
 791 #undef toupper
 792 #undef iscntrl
 793 #undef ispunct
 794 #undef isxdigit
 795
 796 extern const unsigned char sane_ctype[256];
 797 #define GIT_SPACE 0x01
 798 #define GIT_DIGIT 0x02
 799 #define GIT_ALPHA 0x04
 800 #define GIT_GLOB_SPECIAL 0x08
 801 #define GIT_REGEX_SPECIAL 0x10
 802 #define GIT_PATHSPEC_MAGIC 0x20
 803 #define GIT_CNTRL 0x40
 804 #define GIT_PUNCT 0x80
 805 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 806 #define isascii(x) (((x) & ~0x7f) == 0)
 807 #define isspace(x) sane_istest(x,GIT_SPACE)
 808 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 809 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 810 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 811 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
 812 #define islower(x) sane_iscase(x, 1)
 813 #define isupper(x) sane_iscase(x, 0)
 814 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
 815 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
 816 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
 817 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
 818                 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
 819 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
 820 #define tolower(x) sane_case((unsigned char)(x), 0x20)
 821 #define toupper(x) sane_case((unsigned char)(x), 0)
 822 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
 823
 824 static inline int sane_case(int x, int high)
 825 {
 826         if (sane_istest(x, GIT_ALPHA))
 827                 x = (x & ~0x20) | high;
 828         return x;
 829 }
 830
 831 static inline int sane_iscase(int x, int is_lower)
 832 {
 833         if (!sane_istest(x, GIT_ALPHA))
 834                 return 0;
 835
 836         if (is_lower)
 837                 return (x & 0x20) != 0;
 838         else
 839                 return (x & 0x20) == 0;
 840 }
 841
 842 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 843 {
 844         unsigned long ul;
 845         char *p;
 846
 847         errno = 0;
 848         ul = strtoul(s, &p, base);
 849         if (errno || *p || p == s || (unsigned int) ul != ul)
 850                 return -1;
 851         *result = ul;
 852         return 0;
 853 }
 854
 855 static inline int strtol_i(char const *s, int base, int *result)
 856 {
 857         long ul;
 858         char *p;
 859
 860         errno = 0;
 861         ul = strtol(s, &p, base);
 862         if (errno || *p || p == s || (int) ul != ul)
 863                 return -1;
 864         *result = ul;
 865         return 0;
 866 }
 867
 868 #ifdef INTERNAL_QSORT
 869 void git_qsort(void *base, size_t nmemb, size_t size,
 870                int(*compar)(const void *, const void *));
 871 #define qsort git_qsort
 872 #endif
 873
 874 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 875 # define FORCE_DIR_SET_GID S_ISGID
 876 #else
 877 # define FORCE_DIR_SET_GID 0
 878 #endif
 879
 880 #ifdef NO_NSEC
 881 #undef USE_NSEC
 882 #define ST_CTIME_NSEC(st) 0
 883 #define ST_MTIME_NSEC(st) 0
 884 #else
 885 #ifdef USE_ST_TIMESPEC
 886 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
 887 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
 888 #else
 889 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
 890 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
 891 #endif
 892 #endif
 893
 894 #ifdef UNRELIABLE_FSTAT
 895 #define fstat_is_reliable() 0
 896 #else
 897 #define fstat_is_reliable() 1
 898 #endif
 899
 900 #ifndef va_copy
 901 /*
 902  * Since an obvious implementation of va_list would be to make it a
 903  * pointer into the stack frame, a simple assignment will work on
 904  * many systems.  But let's try to be more portable.
 905  */
 906 #ifdef __va_copy
 907 #define va_copy(dst, src) __va_copy(dst, src)
 908 #else
 909 #define va_copy(dst, src) ((dst) = (src))
 910 #endif
 911 #endif
 912
 913 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
 914 #define HAVE_VARIADIC_MACROS 1
 915 #endif
 916
 917 /*
 918  * Preserves errno, prints a message, but gives no warning for ENOENT.
 919  * Returns 0 on success, which includes trying to unlink an object that does
 920  * not exist.
 921  */
 922 int unlink_or_warn(const char *path);
 923  /*
 924   * Tries to unlink file.  Returns 0 if unlink succeeded
 925   * or the file already didn't exist.  Returns -1 and
 926   * appends a message to err suitable for
 927   * 'error("%s", err->buf)' on error.
 928   */
 929 int unlink_or_msg(const char *file, struct strbuf *err);
 930 /*
 931  * Preserves errno, prints a message, but gives no warning for ENOENT.
 932  * Returns 0 on success, which includes trying to remove a directory that does
 933  * not exist.
 934  */
 935 int rmdir_or_warn(const char *path);
 936 /*
 937  * Calls the correct function out of {unlink,rmdir}_or_warn based on
 938  * the supplied file mode.
 939  */
 940 int remove_or_warn(unsigned int mode, const char *path);
 941
 942 /*
 943  * Call access(2), but warn for any error except "missing file"
 944  * (ENOENT or ENOTDIR).
 945  */
 946 #define ACCESS_EACCES_OK (1U << 0)
 947 int access_or_warn(const char *path, int mode, unsigned flag);
 948 int access_or_die(const char *path, int mode, unsigned flag);
 949
 950 /* Warn on an inaccessible file that ought to be accessible */
 951 void warn_on_inaccessible(const char *path);
 952
 953 /* Get the passwd entry for the UID of the current process. */
 954 struct passwd *xgetpwuid_self(void);
 955
 956 #ifdef GMTIME_UNRELIABLE_ERRORS
 957 struct tm *git_gmtime(const time_t *);
 958 struct tm *git_gmtime_r(const time_t *, struct tm *);
 959 #define gmtime git_gmtime
 960 #define gmtime_r git_gmtime_r
 961 #endif
 962
 963 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
 964 #define USE_PARENS_AROUND_GETTEXT_N 1
 965 #endif
 966
 967 #ifndef SHELL_PATH
 968 # define SHELL_PATH "/bin/sh"
 969 #endif
 970
 971 #endif