git-compat-util.h

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