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 #ifndef FLEX_ARRAY
   7 /*
   8  * See if our compiler is known to support flexible array members.
   9  */
  10 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
  11 # define FLEX_ARRAY /* empty */
  12 #elif defined(__GNUC__)
  13 # if (__GNUC__ >= 3)
  14 #  define FLEX_ARRAY /* empty */
  15 # else
  16 #  define FLEX_ARRAY 0 /* older GNU extension */
  17 # endif
  18 #endif
  19
  20 /*
  21  * Otherwise, default to safer but a bit wasteful traditional style
  22  */
  23 #ifndef FLEX_ARRAY
  24 # define FLEX_ARRAY 1
  25 #endif
  26 #endif
  27
  28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
  29 #define bitsizeof(x)  (CHAR_BIT * sizeof(x))
  30
  31 #define maximum_signed_value_of_type(a) \
  32     (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
  33
  34 #define maximum_unsigned_value_of_type(a) \
  35     (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
  36
  37 /*
  38  * Signed integer overflow is undefined in C, so here's a helper macro
  39  * to detect if the sum of two integers will overflow.
  40  *
  41  * Requires: a >= 0, typeof(a) equals typeof(b)
  42  */
  43 #define signed_add_overflows(a, b) \
  44     ((b) > maximum_signed_value_of_type(a) - (a))
  45
  46 #define unsigned_add_overflows(a, b) \
  47     ((b) > maximum_unsigned_value_of_type(a) - (a))
  48
  49 #ifdef __GNUC__
  50 #define TYPEOF(x) (__typeof__(x))
  51 #else
  52 #define TYPEOF(x)
  53 #endif
  54
  55 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
  56 #define HAS_MULTI_BITS(i)  ((i) & ((i) - 1))  /* checks if an integer has more than 1 bit set */
  57
  58 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  59
  60 /* Approximation of the length of the decimal representation of this type. */
  61 #define decimal_length(x)       ((int)(sizeof(x) * 2.56 + 0.5) + 1)
  62
  63 #if defined(__sun__)
  64  /*
  65   * On Solaris, when _XOPEN_EXTENDED is set, its header file
  66   * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
  67   * setting to say we are XPG5 or XPG6.  Also on Solaris,
  68   * XPG6 programs must be compiled with a c99 compiler, while
  69   * non XPG6 programs must be compiled with a pre-c99 compiler.
  70   */
  71 # if __STDC_VERSION__ - 0 >= 199901L
  72 # define _XOPEN_SOURCE 600
  73 # else
  74 # define _XOPEN_SOURCE 500
  75 # endif
  76 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
  77       !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
  78       !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__) && \
  79       !defined(__CYGWIN__)
  80 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
  81 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
  82 #endif
  83 #define _ALL_SOURCE 1
  84 #define _GNU_SOURCE 1
  85 #define _BSD_SOURCE 1
  86 #define _DEFAULT_SOURCE 1
  87 #define _NETBSD_SOURCE 1
  88 #define _SGI_SOURCE 1
  89
  90 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
  91 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
  92 #  define _WIN32_WINNT 0x0502
  93 # endif
  94 #define WIN32_LEAN_AND_MEAN  /* stops windows.h including winsock.h */
  95 #include <winsock2.h>
  96 #include <windows.h>
  97 #define GIT_WINDOWS_NATIVE
  98 #endif
  99
 100 #include <unistd.h>
 101 #include <stdio.h>
 102 #include <sys/stat.h>
 103 #include <fcntl.h>
 104 #include <stddef.h>
 105 #include <stdlib.h>
 106 #include <stdarg.h>
 107 #include <string.h>
 108 #ifdef HAVE_STRINGS_H
 109 #include <strings.h> /* for strcasecmp() */
 110 #endif
 111 #include <errno.h>
 112 #include <limits.h>
 113 #ifdef NEEDS_SYS_PARAM_H
 114 #include <sys/param.h>
 115 #endif
 116 #include <sys/types.h>
 117 #include <dirent.h>
 118 #include <sys/time.h>
 119 #include <time.h>
 120 #include <signal.h>
 121 #include <assert.h>
 122 #include <regex.h>
 123 #include <utime.h>
 124 #include <syslog.h>
 125 #ifndef NO_SYS_POLL_H
 126 #include <sys/poll.h>
 127 #else
 128 #include <poll.h>
 129 #endif
 130 #ifdef HAVE_BSD_SYSCTL
 131 #include <sys/sysctl.h>
 132 #endif
 133
 134 #if defined(__MINGW32__)
 135 /* pull in Windows compatibility stuff */
 136 #include "compat/mingw.h"
 137 #elif defined(_MSC_VER)
 138 #include "compat/msvc.h"
 139 #else
 140 #include <sys/wait.h>
 141 #include <sys/resource.h>
 142 #include <sys/socket.h>
 143 #include <sys/ioctl.h>
 144 #include <termios.h>
 145 #ifndef NO_SYS_SELECT_H
 146 #include <sys/select.h>
 147 #endif
 148 #include <netinet/in.h>
 149 #include <netinet/tcp.h>
 150 #include <arpa/inet.h>
 151 #include <netdb.h>
 152 #include <pwd.h>
 153 #include <sys/un.h>
 154 #ifndef NO_INTTYPES_H
 155 #include <inttypes.h>
 156 #else
 157 #include <stdint.h>
 158 #endif
 159 #ifdef NO_INTPTR_T
 160 /*
 161  * On I16LP32, ILP32 and LP64 "long" is the save bet, however
 162  * on LLP86, IL33LLP64 and P64 it needs to be "long long",
 163  * while on IP16 and IP16L32 it is "int" (resp. "short")
 164  * Size needs to match (or exceed) 'sizeof(void *)'.
 165  * We can't take "long long" here as not everybody has it.
 166  */
 167 typedef long intptr_t;
 168 typedef unsigned long uintptr_t;
 169 #endif
 170 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
 171 #include <grp.h>
 172 #define _ALL_SOURCE 1
 173 #endif
 174
 175 /* used on Mac OS X */
 176 #ifdef PRECOMPOSE_UNICODE
 177 #include "compat/precompose_utf8.h"
 178 #else
 179 #define precompose_str(in,i_nfd2nfc)
 180 #define precompose_argv(c,v)
 181 #define probe_utf8_pathname_composition(a,b)
 182 #endif
 183
 184 #ifdef MKDIR_WO_TRAILING_SLASH
 185 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
 186 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
 187 #endif
 188
 189 #ifdef NO_STRUCT_ITIMERVAL
 190 struct itimerval {
 191         struct timeval it_interval;
 192         struct timeval it_value;
 193 };
 194 #endif
 195
 196 #ifdef NO_SETITIMER
 197 #define setitimer(which,value,ovalue)
 198 #endif
 199
 200 #ifndef NO_LIBGEN_H
 201 #include <libgen.h>
 202 #else
 203 #define basename gitbasename
 204 extern char *gitbasename(char *);
 205 #endif
 206
 207 #ifndef NO_ICONV
 208 #include <iconv.h>
 209 #endif
 210
 211 #ifndef NO_OPENSSL
 212 #ifdef __APPLE__
 213 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
 214 #include <AvailabilityMacros.h>
 215 #undef DEPRECATED_ATTRIBUTE
 216 #define DEPRECATED_ATTRIBUTE
 217 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
 218 #endif
 219 #include <openssl/ssl.h>
 220 #include <openssl/err.h>
 221 #ifdef NO_HMAC_CTX_CLEANUP
 222 #define HMAC_CTX_cleanup HMAC_cleanup
 223 #endif
 224 #endif
 225
 226 /* On most systems <netdb.h> would have given us this, but
 227  * not on some systems (e.g. z/OS).
 228  */
 229 #ifndef NI_MAXHOST
 230 #define NI_MAXHOST 1025
 231 #endif
 232
 233 #ifndef NI_MAXSERV
 234 #define NI_MAXSERV 32
 235 #endif
 236
 237 /* On most systems <limits.h> would have given us this, but
 238  * not on some systems (e.g. GNU/Hurd).
 239  */
 240 #ifndef PATH_MAX
 241 #define PATH_MAX 4096
 242 #endif
 243
 244 #ifndef PRIuMAX
 245 #define PRIuMAX "llu"
 246 #endif
 247
 248 #ifndef PRIu32
 249 #define PRIu32 "u"
 250 #endif
 251
 252 #ifndef PRIx32
 253 #define PRIx32 "x"
 254 #endif
 255
 256 #ifndef PRIo32
 257 #define PRIo32 "o"
 258 #endif
 259
 260 #ifndef PATH_SEP
 261 #define PATH_SEP ':'
 262 #endif
 263
 264 #ifdef HAVE_PATHS_H
 265 #include <paths.h>
 266 #endif
 267 #ifndef _PATH_DEFPATH
 268 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
 269 #endif
 270
 271 #ifndef STRIP_EXTENSION
 272 #define STRIP_EXTENSION ""
 273 #endif
 274
 275 #ifndef has_dos_drive_prefix
 276 static inline int git_has_dos_drive_prefix(const char *path)
 277 {
 278         return 0;
 279 }
 280 #define has_dos_drive_prefix git_has_dos_drive_prefix
 281 #endif
 282
 283 #ifndef is_dir_sep
 284 static inline int git_is_dir_sep(int c)
 285 {
 286         return c == '/';
 287 }
 288 #define is_dir_sep git_is_dir_sep
 289 #endif
 290
 291 #ifndef offset_1st_component
 292 static inline int git_offset_1st_component(const char *path)
 293 {
 294         return is_dir_sep(path[0]);
 295 }
 296 #define offset_1st_component git_offset_1st_component
 297 #endif
 298
 299 #ifndef find_last_dir_sep
 300 static inline char *git_find_last_dir_sep(const char *path)
 301 {
 302         return strrchr(path, '/');
 303 }
 304 #define find_last_dir_sep git_find_last_dir_sep
 305 #endif
 306
 307 #if defined(__HP_cc) && (__HP_cc >= 61000)
 308 #define NORETURN __attribute__((noreturn))
 309 #define NORETURN_PTR
 310 #elif defined(__GNUC__) && !defined(NO_NORETURN)
 311 #define NORETURN __attribute__((__noreturn__))
 312 #define NORETURN_PTR __attribute__((__noreturn__))
 313 #elif defined(_MSC_VER)
 314 #define NORETURN __declspec(noreturn)
 315 #define NORETURN_PTR
 316 #else
 317 #define NORETURN
 318 #define NORETURN_PTR
 319 #ifndef __GNUC__
 320 #ifndef __attribute__
 321 #define __attribute__(x)
 322 #endif
 323 #endif
 324 #endif
 325
 326 /* The sentinel attribute is valid from gcc version 4.0 */
 327 #if defined(__GNUC__) && (__GNUC__ >= 4)
 328 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
 329 #else
 330 #define LAST_ARG_MUST_BE_NULL
 331 #endif
 332
 333 #include "compat/bswap.h"
 334
 335 #include "wildmatch.h"
 336
 337 struct strbuf;
 338
 339 /* General helper functions */
 340 extern void vreportf(const char *prefix, const char *err, va_list params);
 341 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
 342 extern NORETURN void usage(const char *err);
 343 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
 344 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
 345 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
 346 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
 347 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
 348
 349 #ifndef NO_OPENSSL
 350 #ifdef APPLE_COMMON_CRYPTO
 351 #include "compat/apple-common-crypto.h"
 352 #else
 353 #include <openssl/evp.h>
 354 #include <openssl/hmac.h>
 355 #endif /* APPLE_COMMON_CRYPTO */
 356 #include <openssl/x509v3.h>
 357 #endif /* NO_OPENSSL */
 358
 359 /*
 360  * Let callers be aware of the constant return value; this can help
 361  * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
 362  * because some compilers may not support variadic macros. Since we're only
 363  * trying to help gcc, anyway, it's OK; other compilers will fall back to
 364  * using the function as usual.
 365  */
 366 #if defined(__GNUC__)
 367 static inline int const_error(void)
 368 {
 369         return -1;
 370 }
 371 #define error(...) (error(__VA_ARGS__), const_error())
 372 #endif
 373
 374 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
 375 extern void set_error_routine(void (*routine)(const char *err, va_list params));
 376 extern void set_die_is_recursing_routine(int (*routine)(void));
 377
 378 extern int starts_with(const char *str, const char *prefix);
 379
 380 /*
 381  * If the string "str" begins with the string found in "prefix", return 1.
 382  * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
 383  * the string right after the prefix).
 384  *
 385  * Otherwise, return 0 and leave "out" untouched.
 386  *
 387  * Examples:
 388  *
 389  *   [extract branch name, fail if not a branch]
 390  *   if (!skip_prefix(ref, "refs/heads/", &branch)
 391  *      return -1;
 392  *
 393  *   [skip prefix if present, otherwise use whole string]
 394  *   skip_prefix(name, "refs/heads/", &name);
 395  */
 396 static inline int skip_prefix(const char *str, const char *prefix,
 397                               const char **out)
 398 {
 399         do {
 400                 if (!*prefix) {
 401                         *out = str;
 402                         return 1;
 403                 }
 404         } while (*str++ == *prefix++);
 405         return 0;
 406 }
 407
 408 /*
 409  * If buf ends with suffix, return 1 and subtract the length of the suffix
 410  * from *len. Otherwise, return 0 and leave *len untouched.
 411  */
 412 static inline int strip_suffix_mem(const char *buf, size_t *len,
 413                                    const char *suffix)
 414 {
 415         size_t suflen = strlen(suffix);
 416         if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
 417                 return 0;
 418         *len -= suflen;
 419         return 1;
 420 }
 421
 422 /*
 423  * If str ends with suffix, return 1 and set *len to the size of the string
 424  * without the suffix. Otherwise, return 0 and set *len to the size of the
 425  * string.
 426  *
 427  * Note that we do _not_ NUL-terminate str to the new length.
 428  */
 429 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
 430 {
 431         *len = strlen(str);
 432         return strip_suffix_mem(str, len, suffix);
 433 }
 434
 435 static inline int ends_with(const char *str, const char *suffix)
 436 {
 437         size_t len;
 438         return strip_suffix(str, suffix, &len);
 439 }
 440
 441 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
 442
 443 #ifndef PROT_READ
 444 #define PROT_READ 1
 445 #define PROT_WRITE 2
 446 #define MAP_PRIVATE 1
 447 #endif
 448
 449 #define mmap git_mmap
 450 #define munmap git_munmap
 451 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 452 extern int git_munmap(void *start, size_t length);
 453
 454 #else /* NO_MMAP || USE_WIN32_MMAP */
 455
 456 #include <sys/mman.h>
 457
 458 #endif /* NO_MMAP || USE_WIN32_MMAP */
 459
 460 #ifdef NO_MMAP
 461
 462 /* This value must be multiple of (pagesize * 2) */
 463 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
 464
 465 #else /* NO_MMAP */
 466
 467 /* This value must be multiple of (pagesize * 2) */
 468 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
 469         (sizeof(void*) >= 8 \
 470                 ?  1 * 1024 * 1024 * 1024 \
 471                 : 32 * 1024 * 1024)
 472
 473 #endif /* NO_MMAP */
 474
 475 #ifndef MAP_FAILED
 476 #define MAP_FAILED ((void *)-1)
 477 #endif
 478
 479 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
 480 #define on_disk_bytes(st) ((st).st_size)
 481 #else
 482 #define on_disk_bytes(st) ((st).st_blocks * 512)
 483 #endif
 484
 485 #ifdef NEEDS_MODE_TRANSLATION
 486 #undef S_IFMT
 487 #undef S_IFREG
 488 #undef S_IFDIR
 489 #undef S_IFLNK
 490 #undef S_IFBLK
 491 #undef S_IFCHR
 492 #undef S_IFIFO
 493 #undef S_IFSOCK
 494 #define S_IFMT   0170000
 495 #define S_IFREG  0100000
 496 #define S_IFDIR  0040000
 497 #define S_IFLNK  0120000
 498 #define S_IFBLK  0060000
 499 #define S_IFCHR  0020000
 500 #define S_IFIFO  0010000
 501 #define S_IFSOCK 0140000
 502 #ifdef stat
 503 #undef stat
 504 #endif
 505 #define stat(path, buf) git_stat(path, buf)
 506 extern int git_stat(const char *, struct stat *);
 507 #ifdef fstat
 508 #undef fstat
 509 #endif
 510 #define fstat(fd, buf) git_fstat(fd, buf)
 511 extern int git_fstat(int, struct stat *);
 512 #ifdef lstat
 513 #undef lstat
 514 #endif
 515 #define lstat(path, buf) git_lstat(path, buf)
 516 extern int git_lstat(const char *, struct stat *);
 517 #endif
 518
 519 #define DEFAULT_PACKED_GIT_LIMIT \
 520         ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
 521
 522 #ifdef NO_PREAD
 523 #define pread git_pread
 524 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
 525 #endif
 526 /*
 527  * Forward decl that will remind us if its twin in cache.h changes.
 528  * This function is used in compat/pread.c.  But we can't include
 529  * cache.h there.
 530  */
 531 extern ssize_t read_in_full(int fd, void *buf, size_t count);
 532
 533 #ifdef NO_SETENV
 534 #define setenv gitsetenv
 535 extern int gitsetenv(const char *, const char *, int);
 536 #endif
 537
 538 #ifdef NO_MKDTEMP
 539 #define mkdtemp gitmkdtemp
 540 extern char *gitmkdtemp(char *);
 541 #endif
 542
 543 #ifdef NO_MKSTEMPS
 544 #define mkstemps gitmkstemps
 545 extern int gitmkstemps(char *, int);
 546 #endif
 547
 548 #ifdef NO_UNSETENV
 549 #define unsetenv gitunsetenv
 550 extern void gitunsetenv(const char *);
 551 #endif
 552
 553 #ifdef NO_STRCASESTR
 554 #define strcasestr gitstrcasestr
 555 extern char *gitstrcasestr(const char *haystack, const char *needle);
 556 #endif
 557
 558 #ifdef NO_STRLCPY
 559 #define strlcpy gitstrlcpy
 560 extern size_t gitstrlcpy(char *, const char *, size_t);
 561 #endif
 562
 563 #ifdef NO_STRTOUMAX
 564 #define strtoumax gitstrtoumax
 565 extern uintmax_t gitstrtoumax(const char *, char **, int);
 566 #define strtoimax gitstrtoimax
 567 extern intmax_t gitstrtoimax(const char *, char **, int);
 568 #endif
 569
 570 #ifdef NO_HSTRERROR
 571 #define hstrerror githstrerror
 572 extern const char *githstrerror(int herror);
 573 #endif
 574
 575 #ifdef NO_MEMMEM
 576 #define memmem gitmemmem
 577 void *gitmemmem(const void *haystack, size_t haystacklen,
 578                 const void *needle, size_t needlelen);
 579 #endif
 580
 581 #ifdef NO_GETPAGESIZE
 582 #define getpagesize() sysconf(_SC_PAGESIZE)
 583 #endif
 584
 585 #ifdef FREAD_READS_DIRECTORIES
 586 #ifdef fopen
 587 #undef fopen
 588 #endif
 589 #define fopen(a,b) git_fopen(a,b)
 590 extern FILE *git_fopen(const char*, const char*);
 591 #endif
 592
 593 #ifdef SNPRINTF_RETURNS_BOGUS
 594 #ifdef snprintf
 595 #undef snprintf
 596 #endif
 597 #define snprintf git_snprintf
 598 extern int git_snprintf(char *str, size_t maxsize,
 599                         const char *format, ...);
 600 #ifdef vsnprintf
 601 #undef vsnprintf
 602 #endif
 603 #define vsnprintf git_vsnprintf
 604 extern int git_vsnprintf(char *str, size_t maxsize,
 605                          const char *format, va_list ap);
 606 #endif
 607
 608 #ifdef __GLIBC_PREREQ
 609 #if __GLIBC_PREREQ(2, 1)
 610 #define HAVE_STRCHRNUL
 611 #define HAVE_MEMPCPY
 612 #endif
 613 #endif
 614
 615 #ifndef HAVE_STRCHRNUL
 616 #define strchrnul gitstrchrnul
 617 static inline char *gitstrchrnul(const char *s, int c)
 618 {
 619         while (*s && *s != c)
 620                 s++;
 621         return (char *)s;
 622 }
 623 #endif
 624
 625 #ifndef HAVE_MEMPCPY
 626 #define mempcpy gitmempcpy
 627 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
 628 {
 629         return (char *)memcpy(dest, src, n) + n;
 630 }
 631 #endif
 632
 633 #ifdef NO_INET_PTON
 634 int inet_pton(int af, const char *src, void *dst);
 635 #endif
 636
 637 #ifdef NO_INET_NTOP
 638 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
 639 #endif
 640
 641 #ifdef NO_PTHREADS
 642 #define atexit git_atexit
 643 extern int git_atexit(void (*handler)(void));
 644 #endif
 645
 646 extern void release_pack_memory(size_t);
 647
 648 typedef void (*try_to_free_t)(size_t);
 649 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
 650
 651 #ifdef HAVE_ALLOCA_H
 652 # include <alloca.h>
 653 # define xalloca(size)      (alloca(size))
 654 # define xalloca_free(p)    do {} while (0)
 655 #else
 656 # define xalloca(size)      (xmalloc(size))
 657 # define xalloca_free(p)    (free(p))
 658 #endif
 659 extern char *xstrdup(const char *str);
 660 extern void *xmalloc(size_t size);
 661 extern void *xmallocz(size_t size);
 662 extern void *xmallocz_gently(size_t size);
 663 extern void *xmemdupz(const void *data, size_t len);
 664 extern char *xstrndup(const char *str, size_t len);
 665 extern void *xrealloc(void *ptr, size_t size);
 666 extern void *xcalloc(size_t nmemb, size_t size);
 667 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
 668 extern ssize_t xread(int fd, void *buf, size_t len);
 669 extern ssize_t xwrite(int fd, const void *buf, size_t len);
 670 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
 671 extern int xdup(int fd);
 672 extern FILE *xfdopen(int fd, const char *mode);
 673 extern int xmkstemp(char *template);
 674 extern int xmkstemp_mode(char *template, int mode);
 675 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
 676 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
 677 extern char *xgetcwd(void);
 678
 679 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
 680
 681 static inline char *xstrdup_or_null(const char *str)
 682 {
 683         return str ? xstrdup(str) : NULL;
 684 }
 685
 686 static inline size_t xsize_t(off_t len)
 687 {
 688         if (len > (size_t) len)
 689                 die("Cannot handle files this big");
 690         return (size_t)len;
 691 }
 692
 693 /* in ctype.c, for kwset users */
 694 extern const unsigned char tolower_trans_tbl[256];
 695
 696 /* Sane ctype - no locale, and works with signed chars */
 697 #undef isascii
 698 #undef isspace
 699 #undef isdigit
 700 #undef isalpha
 701 #undef isalnum
 702 #undef isprint
 703 #undef islower
 704 #undef isupper
 705 #undef tolower
 706 #undef toupper
 707 #undef iscntrl
 708 #undef ispunct
 709 #undef isxdigit
 710
 711 extern const unsigned char sane_ctype[256];
 712 #define GIT_SPACE 0x01
 713 #define GIT_DIGIT 0x02
 714 #define GIT_ALPHA 0x04
 715 #define GIT_GLOB_SPECIAL 0x08
 716 #define GIT_REGEX_SPECIAL 0x10
 717 #define GIT_PATHSPEC_MAGIC 0x20
 718 #define GIT_CNTRL 0x40
 719 #define GIT_PUNCT 0x80
 720 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
 721 #define isascii(x) (((x) & ~0x7f) == 0)
 722 #define isspace(x) sane_istest(x,GIT_SPACE)
 723 #define isdigit(x) sane_istest(x,GIT_DIGIT)
 724 #define isalpha(x) sane_istest(x,GIT_ALPHA)
 725 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
 726 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
 727 #define islower(x) sane_iscase(x, 1)
 728 #define isupper(x) sane_iscase(x, 0)
 729 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
 730 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
 731 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
 732 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
 733                 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
 734 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
 735 #define tolower(x) sane_case((unsigned char)(x), 0x20)
 736 #define toupper(x) sane_case((unsigned char)(x), 0)
 737 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
 738
 739 static inline int sane_case(int x, int high)
 740 {
 741         if (sane_istest(x, GIT_ALPHA))
 742                 x = (x & ~0x20) | high;
 743         return x;
 744 }
 745
 746 static inline int sane_iscase(int x, int is_lower)
 747 {
 748         if (!sane_istest(x, GIT_ALPHA))
 749                 return 0;
 750
 751         if (is_lower)
 752                 return (x & 0x20) != 0;
 753         else
 754                 return (x & 0x20) == 0;
 755 }
 756
 757 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
 758 {
 759         unsigned long ul;
 760         char *p;
 761
 762         errno = 0;
 763         ul = strtoul(s, &p, base);
 764         if (errno || *p || p == s || (unsigned int) ul != ul)
 765                 return -1;
 766         *result = ul;
 767         return 0;
 768 }
 769
 770 static inline int strtol_i(char const *s, int base, int *result)
 771 {
 772         long ul;
 773         char *p;
 774
 775         errno = 0;
 776         ul = strtol(s, &p, base);
 777         if (errno || *p || p == s || (int) ul != ul)
 778                 return -1;
 779         *result = ul;
 780         return 0;
 781 }
 782
 783 #ifdef INTERNAL_QSORT
 784 void git_qsort(void *base, size_t nmemb, size_t size,
 785                int(*compar)(const void *, const void *));
 786 #define qsort git_qsort
 787 #endif
 788
 789 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
 790 # define FORCE_DIR_SET_GID S_ISGID
 791 #else
 792 # define FORCE_DIR_SET_GID 0
 793 #endif
 794
 795 #ifdef NO_NSEC
 796 #undef USE_NSEC
 797 #define ST_CTIME_NSEC(st) 0
 798 #define ST_MTIME_NSEC(st) 0
 799 #else
 800 #ifdef USE_ST_TIMESPEC
 801 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
 802 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
 803 #else
 804 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
 805 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
 806 #endif
 807 #endif
 808
 809 #ifdef UNRELIABLE_FSTAT
 810 #define fstat_is_reliable() 0
 811 #else
 812 #define fstat_is_reliable() 1
 813 #endif
 814
 815 #ifndef va_copy
 816 /*
 817  * Since an obvious implementation of va_list would be to make it a
 818  * pointer into the stack frame, a simple assignment will work on
 819  * many systems.  But let's try to be more portable.
 820  */
 821 #ifdef __va_copy
 822 #define va_copy(dst, src) __va_copy(dst, src)
 823 #else
 824 #define va_copy(dst, src) ((dst) = (src))
 825 #endif
 826 #endif
 827
 828 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
 829 #define HAVE_VARIADIC_MACROS 1
 830 #endif
 831
 832 /*
 833  * Preserves errno, prints a message, but gives no warning for ENOENT.
 834  * Returns 0 on success, which includes trying to unlink an object that does
 835  * not exist.
 836  */
 837 int unlink_or_warn(const char *path);
 838  /*
 839   * Tries to unlink file.  Returns 0 if unlink succeeded
 840   * or the file already didn't exist.  Returns -1 and
 841   * appends a message to err suitable for
 842   * 'error("%s", err->buf)' on error.
 843   */
 844 int unlink_or_msg(const char *file, struct strbuf *err);
 845 /*
 846  * Preserves errno, prints a message, but gives no warning for ENOENT.
 847  * Returns 0 on success, which includes trying to remove a directory that does
 848  * not exist.
 849  */
 850 int rmdir_or_warn(const char *path);
 851 /*
 852  * Calls the correct function out of {unlink,rmdir}_or_warn based on
 853  * the supplied file mode.
 854  */
 855 int remove_or_warn(unsigned int mode, const char *path);
 856
 857 /*
 858  * Call access(2), but warn for any error except "missing file"
 859  * (ENOENT or ENOTDIR).
 860  */
 861 #define ACCESS_EACCES_OK (1U << 0)
 862 int access_or_warn(const char *path, int mode, unsigned flag);
 863 int access_or_die(const char *path, int mode, unsigned flag);
 864
 865 /* Warn on an inaccessible file that ought to be accessible */
 866 void warn_on_inaccessible(const char *path);
 867
 868 /* Get the passwd entry for the UID of the current process. */
 869 struct passwd *xgetpwuid_self(void);
 870
 871 #ifdef GMTIME_UNRELIABLE_ERRORS
 872 struct tm *git_gmtime(const time_t *);
 873 struct tm *git_gmtime_r(const time_t *, struct tm *);
 874 #define gmtime git_gmtime
 875 #define gmtime_r git_gmtime_r
 876 #endif
 877
 878 #if !defined(USE_PARENS_AROUND_GETTEXT_N) && defined(__GNUC__)
 879 #define USE_PARENS_AROUND_GETTEXT_N 1
 880 #endif
 881
 882 #ifndef SHELL_PATH
 883 # define SHELL_PATH "/bin/sh"
 884 #endif
 885
 886 #endif