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