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