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