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