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