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