compiler-rt/lib/sanitizer_common/sanitizer_internal_defs.h

   1 //===-- sanitizer_internal_defs.h -------------------------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // This file is shared between AddressSanitizer and ThreadSanitizer.
  10 // It contains macro used in run-time libraries code.
  11 //===----------------------------------------------------------------------===//
  12 #ifndef SANITIZER_DEFS_H
  13 #define SANITIZER_DEFS_H
  14
  15 #include "sanitizer_platform.h"
  16
  17 #ifndef SANITIZER_DEBUG
  18 # define SANITIZER_DEBUG 0
  19 #endif
  20
  21 #define SANITIZER_STRINGIFY_(S) #S
  22 #define SANITIZER_STRINGIFY(S) SANITIZER_STRINGIFY_(S)
  23
  24 // Only use SANITIZER_*ATTRIBUTE* before the function return type!
  25 #if SANITIZER_WINDOWS
  26 #if SANITIZER_IMPORT_INTERFACE
  27 # define SANITIZER_INTERFACE_ATTRIBUTE __declspec(dllimport)
  28 #else
  29 # define SANITIZER_INTERFACE_ATTRIBUTE __declspec(dllexport)
  30 #endif
  31 # define SANITIZER_WEAK_ATTRIBUTE
  32 #elif SANITIZER_GO
  33 # define SANITIZER_INTERFACE_ATTRIBUTE
  34 # define SANITIZER_WEAK_ATTRIBUTE
  35 #else
  36 # define SANITIZER_INTERFACE_ATTRIBUTE __attribute__((visibility("default")))
  37 # define SANITIZER_WEAK_ATTRIBUTE  __attribute__((weak))
  38 #endif
  39
  40 // TLS is handled differently on different platforms
  41 #if SANITIZER_LINUX || SANITIZER_NETBSD || \
  42   SANITIZER_FREEBSD
  43 # define SANITIZER_TLS_INITIAL_EXEC_ATTRIBUTE \
  44     __attribute__((tls_model("initial-exec"))) thread_local
  45 #else
  46 # define SANITIZER_TLS_INITIAL_EXEC_ATTRIBUTE
  47 #endif
  48
  49 //--------------------------- WEAK FUNCTIONS ---------------------------------//
  50 // When working with weak functions, to simplify the code and make it more
  51 // portable, when possible define a default implementation using this macro:
  52 //
  53 // SANITIZER_INTERFACE_WEAK_DEF(<return_type>, <name>, <parameter list>)
  54 //
  55 // For example:
  56 //   SANITIZER_INTERFACE_WEAK_DEF(bool, compare, int a, int b) { return a > b; }
  57 //
  58 #if SANITIZER_WINDOWS
  59 #include "sanitizer_win_defs.h"
  60 # define SANITIZER_INTERFACE_WEAK_DEF(ReturnType, Name, ...)                   \
  61   WIN_WEAK_EXPORT_DEF(ReturnType, Name, __VA_ARGS__)
  62 #else
  63 # define SANITIZER_INTERFACE_WEAK_DEF(ReturnType, Name, ...)                   \
  64   extern "C" SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE            \
  65   ReturnType Name(__VA_ARGS__)
  66 #endif
  67
  68 // SANITIZER_SUPPORTS_WEAK_HOOKS means that we support real weak functions that
  69 // will evaluate to a null pointer when not defined.
  70 #ifndef SANITIZER_SUPPORTS_WEAK_HOOKS
  71 #if (SANITIZER_LINUX || SANITIZER_SOLARIS) && !SANITIZER_GO
  72 # define SANITIZER_SUPPORTS_WEAK_HOOKS 1
  73 // Before Xcode 4.5, the Darwin linker doesn't reliably support undefined
  74 // weak symbols.  Mac OS X 10.9/Darwin 13 is the first release only supported
  75 // by Xcode >= 4.5.
  76 #elif SANITIZER_MAC && \
  77     __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ >= 1090 && !SANITIZER_GO
  78 # define SANITIZER_SUPPORTS_WEAK_HOOKS 1
  79 #else
  80 # define SANITIZER_SUPPORTS_WEAK_HOOKS 0
  81 #endif
  82 #endif // SANITIZER_SUPPORTS_WEAK_HOOKS
  83 // For some weak hooks that will be called very often and we want to avoid the
  84 // overhead of executing the default implementation when it is not necessary,
  85 // we can use the flag SANITIZER_SUPPORTS_WEAK_HOOKS to only define the default
  86 // implementation for platforms that doesn't support weak symbols. For example:
  87 //
  88 //   #if !SANITIZER_SUPPORT_WEAK_HOOKS
  89 //     SANITIZER_INTERFACE_WEAK_DEF(bool, compare_hook, int a, int b) {
  90 //       return a > b;
  91 //     }
  92 //   #endif
  93 //
  94 // And then use it as: if (compare_hook) compare_hook(a, b);
  95 //----------------------------------------------------------------------------//
  96
  97
  98 // We can use .preinit_array section on Linux to call sanitizer initialization
  99 // functions very early in the process startup (unless PIC macro is defined).
 100 //
 101 // On FreeBSD, .preinit_array functions are called with rtld_bind_lock writer
 102 // lock held. It will lead to dead lock if unresolved PLT functions (which helds
 103 // rtld_bind_lock reader lock) are called inside .preinit_array functions.
 104 //
 105 // FIXME: do we have anything like this on Mac?
 106 #ifndef SANITIZER_CAN_USE_PREINIT_ARRAY
 107 #if (SANITIZER_LINUX || SANITIZER_FUCHSIA || SANITIZER_NETBSD) && !defined(PIC)
 108 #define SANITIZER_CAN_USE_PREINIT_ARRAY 1
 109 // Before Solaris 11.4, .preinit_array is fully supported only with GNU ld.
 110 // FIXME: Check for those conditions.
 111 #elif SANITIZER_SOLARIS && !defined(PIC)
 112 # define SANITIZER_CAN_USE_PREINIT_ARRAY 1
 113 #else
 114 # define SANITIZER_CAN_USE_PREINIT_ARRAY 0
 115 #endif
 116 #endif  // SANITIZER_CAN_USE_PREINIT_ARRAY
 117
 118 // GCC does not understand __has_feature
 119 #if !defined(__has_feature)
 120 # define __has_feature(x) 0
 121 #endif
 122
 123 // Older GCCs do not understand __has_attribute.
 124 #if !defined(__has_attribute)
 125 # define __has_attribute(x) 0
 126 #endif
 127
 128 #if !defined(__has_cpp_attribute)
 129 #  define __has_cpp_attribute(x) 0
 130 #endif
 131
 132 // For portability reasons we do not include stddef.h, stdint.h or any other
 133 // system header, but we do need some basic types that are not defined
 134 // in a portable way by the language itself.
 135 namespace __sanitizer {
 136
 137 #if defined(_WIN64)
 138 // 64-bit Windows uses LLP64 data model.
 139 typedef unsigned long long uptr;
 140 typedef signed long long sptr;
 141 #else
 142 #  if (SANITIZER_WORDSIZE == 64) || SANITIZER_MAC || SANITIZER_WINDOWS
 143 typedef unsigned long uptr;
 144 typedef signed long sptr;
 145 #  else
 146 typedef unsigned int uptr;
 147 typedef signed int sptr;
 148 #  endif
 149 #endif  // defined(_WIN64)
 150 #if defined(__x86_64__)
 151 // Since x32 uses ILP32 data model in 64-bit hardware mode, we must use
 152 // 64-bit pointer to unwind stack frame.
 153 typedef unsigned long long uhwptr;
 154 #else
 155 typedef uptr uhwptr;
 156 #endif
 157 typedef unsigned char u8;
 158 typedef unsigned short u16;
 159 typedef unsigned int u32;
 160 typedef unsigned long long u64;
 161 typedef signed char s8;
 162 typedef signed short s16;
 163 typedef signed int s32;
 164 typedef signed long long s64;
 165 #if SANITIZER_WINDOWS
 166 // On Windows, files are HANDLE, which is a synonim of void*.
 167 // Use void* to avoid including <windows.h> everywhere.
 168 typedef void* fd_t;
 169 typedef unsigned error_t;
 170 #else
 171 typedef int fd_t;
 172 typedef int error_t;
 173 #endif
 174 #if SANITIZER_SOLARIS && !defined(_LP64)
 175 typedef long pid_t;
 176 #else
 177 typedef int pid_t;
 178 #endif
 179
 180 #if SANITIZER_FREEBSD || SANITIZER_NETBSD || SANITIZER_MAC ||             \
 181     (SANITIZER_SOLARIS && (defined(_LP64) || _FILE_OFFSET_BITS == 64)) || \
 182     (SANITIZER_LINUX && !SANITIZER_GLIBC && !SANITIZER_ANDROID) ||        \
 183     (SANITIZER_LINUX && (defined(__x86_64__) || defined(__hexagon__)))
 184 typedef u64 OFF_T;
 185 #else
 186 typedef uptr OFF_T;
 187 #endif
 188 typedef u64  OFF64_T;
 189
 190 #if (SANITIZER_WORDSIZE == 64) || SANITIZER_MAC
 191 typedef uptr operator_new_size_type;
 192 #else
 193 # if defined(__s390__) && !defined(__s390x__)
 194 // Special case: 31-bit s390 has unsigned long as size_t.
 195 typedef unsigned long operator_new_size_type;
 196 # else
 197 typedef u32 operator_new_size_type;
 198 # endif
 199 #endif
 200
 201 typedef u64 tid_t;
 202
 203 // ----------- ATTENTION -------------
 204 // This header should NOT include any other headers to avoid portability issues.
 205
 206 // Common defs.
 207 #define INTERFACE_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE
 208 #define SANITIZER_WEAK_DEFAULT_IMPL \
 209   extern "C" SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE NOINLINE
 210 #define SANITIZER_WEAK_CXX_DEFAULT_IMPL \
 211   extern "C++" SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE NOINLINE
 212
 213 // Platform-specific defs.
 214 #if defined(_MSC_VER)
 215 # define ALWAYS_INLINE __forceinline
 216 // FIXME(timurrrr): do we need this on Windows?
 217 # define ALIAS(x)
 218 # define ALIGNED(x) __declspec(align(x))
 219 # define FORMAT(f, a)
 220 # define NOINLINE __declspec(noinline)
 221 # define NORETURN __declspec(noreturn)
 222 # define THREADLOCAL   __declspec(thread)
 223 # define LIKELY(x) (x)
 224 # define UNLIKELY(x) (x)
 225 # define PREFETCH(x) /* _mm_prefetch(x, _MM_HINT_NTA) */ (void)0
 226 # define WARN_UNUSED_RESULT
 227 #else  // _MSC_VER
 228 # define ALWAYS_INLINE inline __attribute__((always_inline))
 229 # define ALIAS(x) __attribute__((alias(x)))
 230 // Please only use the ALIGNED macro before the type.
 231 // Using ALIGNED after the variable declaration is not portable!
 232 # define ALIGNED(x) __attribute__((aligned(x)))
 233 # define FORMAT(f, a)  __attribute__((format(printf, f, a)))
 234 # define NOINLINE __attribute__((noinline))
 235 # define NORETURN  __attribute__((noreturn))
 236 # define THREADLOCAL   __thread
 237 # define LIKELY(x)     __builtin_expect(!!(x), 1)
 238 # define UNLIKELY(x)   __builtin_expect(!!(x), 0)
 239 # if defined(__i386__) || defined(__x86_64__)
 240 // __builtin_prefetch(x) generates prefetchnt0 on x86
 241 #  define PREFETCH(x) __asm__("prefetchnta (%0)" : : "r" (x))
 242 # else
 243 #  define PREFETCH(x) __builtin_prefetch(x)
 244 # endif
 245 # define WARN_UNUSED_RESULT __attribute__((warn_unused_result))
 246 #endif  // _MSC_VER
 247
 248 #if !defined(_MSC_VER) || defined(__clang__)
 249 # define UNUSED __attribute__((unused))
 250 # define USED __attribute__((used))
 251 #else
 252 # define UNUSED
 253 # define USED
 254 #endif
 255
 256 #if !defined(_MSC_VER) || defined(__clang__) || MSC_PREREQ(1900)
 257 # define NOEXCEPT noexcept
 258 #else
 259 # define NOEXCEPT throw()
 260 #endif
 261
 262 #if __has_cpp_attribute(clang::fallthrough)
 263 #  define FALLTHROUGH [[clang::fallthrough]]
 264 #else
 265 #  define FALLTHROUGH
 266 #endif
 267
 268 // Unaligned versions of basic types.
 269 typedef ALIGNED(1) u16 uu16;
 270 typedef ALIGNED(1) u32 uu32;
 271 typedef ALIGNED(1) u64 uu64;
 272 typedef ALIGNED(1) s16 us16;
 273 typedef ALIGNED(1) s32 us32;
 274 typedef ALIGNED(1) s64 us64;
 275
 276 #if SANITIZER_WINDOWS
 277 }  // namespace __sanitizer
 278 typedef unsigned long DWORD;
 279 namespace __sanitizer {
 280 typedef DWORD thread_return_t;
 281 # define THREAD_CALLING_CONV __stdcall
 282 #else  // _WIN32
 283 typedef void* thread_return_t;
 284 # define THREAD_CALLING_CONV
 285 #endif  // _WIN32
 286 typedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg);
 287
 288 // NOTE: Functions below must be defined in each run-time.
 289 void NORETURN Die();
 290
 291 void NORETURN CheckFailed(const char *file, int line, const char *cond,
 292                           u64 v1, u64 v2);
 293
 294 // Check macro
 295 #define RAW_CHECK_MSG(expr, msg, ...)          \
 296   do {                                         \
 297     if (UNLIKELY(!(expr))) {                   \
 298       const char* msgs[] = {msg, __VA_ARGS__}; \
 299       for (const char* m : msgs) RawWrite(m);  \
 300       Die();                                   \
 301     }                                          \
 302   } while (0)
 303
 304 #define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr "\n", )
 305 #define RAW_CHECK_VA(expr, ...) RAW_CHECK_MSG(expr, #expr "\n", __VA_ARGS__)
 306
 307 #define CHECK_IMPL(c1, op, c2) \
 308   do { \
 309     __sanitizer::u64 v1 = (__sanitizer::u64)(c1); \
 310     __sanitizer::u64 v2 = (__sanitizer::u64)(c2); \
 311     if (UNLIKELY(!(v1 op v2))) \
 312       __sanitizer::CheckFailed(__FILE__, __LINE__, \
 313         "(" #c1 ") " #op " (" #c2 ")", v1, v2); \
 314   } while (false) \
 315 /**/
 316
 317 #define CHECK(a)       CHECK_IMPL((a), !=, 0)
 318 #define CHECK_EQ(a, b) CHECK_IMPL((a), ==, (b))
 319 #define CHECK_NE(a, b) CHECK_IMPL((a), !=, (b))
 320 #define CHECK_LT(a, b) CHECK_IMPL((a), <,  (b))
 321 #define CHECK_LE(a, b) CHECK_IMPL((a), <=, (b))
 322 #define CHECK_GT(a, b) CHECK_IMPL((a), >,  (b))
 323 #define CHECK_GE(a, b) CHECK_IMPL((a), >=, (b))
 324
 325 #if SANITIZER_DEBUG
 326 #define DCHECK(a)       CHECK(a)
 327 #define DCHECK_EQ(a, b) CHECK_EQ(a, b)
 328 #define DCHECK_NE(a, b) CHECK_NE(a, b)
 329 #define DCHECK_LT(a, b) CHECK_LT(a, b)
 330 #define DCHECK_LE(a, b) CHECK_LE(a, b)
 331 #define DCHECK_GT(a, b) CHECK_GT(a, b)
 332 #define DCHECK_GE(a, b) CHECK_GE(a, b)
 333 #else
 334 #define DCHECK(a)
 335 #define DCHECK_EQ(a, b)
 336 #define DCHECK_NE(a, b)
 337 #define DCHECK_LT(a, b)
 338 #define DCHECK_LE(a, b)
 339 #define DCHECK_GT(a, b)
 340 #define DCHECK_GE(a, b)
 341 #endif
 342
 343 #define UNREACHABLE(msg) do { \
 344   CHECK(0 && msg); \
 345   Die(); \
 346 } while (0)
 347
 348 #define UNIMPLEMENTED() UNREACHABLE("unimplemented")
 349
 350 #define COMPILER_CHECK(pred) static_assert(pred, "")
 351
 352 #define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
 353
 354 // Limits for integral types. We have to redefine it in case we don't
 355 // have stdint.h (like in Visual Studio 9).
 356 #undef __INT64_C
 357 #undef __UINT64_C
 358 #if SANITIZER_WORDSIZE == 64
 359 # define __INT64_C(c)  c ## L
 360 # define __UINT64_C(c) c ## UL
 361 #else
 362 # define __INT64_C(c)  c ## LL
 363 # define __UINT64_C(c) c ## ULL
 364 #endif  // SANITIZER_WORDSIZE == 64
 365 #undef INT32_MIN
 366 #define INT32_MIN              (-2147483647-1)
 367 #undef INT32_MAX
 368 #define INT32_MAX              (2147483647)
 369 #undef UINT32_MAX
 370 #define UINT32_MAX             (4294967295U)
 371 #undef INT64_MIN
 372 #define INT64_MIN              (-__INT64_C(9223372036854775807)-1)
 373 #undef INT64_MAX
 374 #define INT64_MAX              (__INT64_C(9223372036854775807))
 375 #undef UINT64_MAX
 376 #define UINT64_MAX             (__UINT64_C(18446744073709551615))
 377 #undef UINTPTR_MAX
 378 #if SANITIZER_WORDSIZE == 64
 379 # define UINTPTR_MAX           (18446744073709551615UL)
 380 #else
 381 # define UINTPTR_MAX           (4294967295U)
 382 #endif  // SANITIZER_WORDSIZE == 64
 383
 384 enum LinkerInitialized { LINKER_INITIALIZED = 0 };
 385
 386 #if !defined(_MSC_VER) || defined(__clang__)
 387 #if SANITIZER_S390_31
 388 #define GET_CALLER_PC() \
 389   (__sanitizer::uptr) __builtin_extract_return_addr(__builtin_return_address(0))
 390 #else
 391 #define GET_CALLER_PC() (__sanitizer::uptr) __builtin_return_address(0)
 392 #endif
 393 #define GET_CURRENT_FRAME() (__sanitizer::uptr) __builtin_frame_address(0)
 394 inline void Trap() {
 395   __builtin_trap();
 396 }
 397 #else
 398 extern "C" void* _ReturnAddress(void);
 399 extern "C" void* _AddressOfReturnAddress(void);
 400 # pragma intrinsic(_ReturnAddress)
 401 # pragma intrinsic(_AddressOfReturnAddress)
 402 #define GET_CALLER_PC() (__sanitizer::uptr) _ReturnAddress()
 403 // CaptureStackBackTrace doesn't need to know BP on Windows.
 404 #define GET_CURRENT_FRAME() \
 405   (((__sanitizer::uptr)_AddressOfReturnAddress()) + sizeof(__sanitizer::uptr))
 406
 407 extern "C" void __ud2(void);
 408 # pragma intrinsic(__ud2)
 409 inline void Trap() {
 410   __ud2();
 411 }
 412 #endif
 413
 414 #define HANDLE_EINTR(res, f)                                       \
 415   {                                                                \
 416     int rverrno;                                                   \
 417     do {                                                           \
 418       res = (f);                                                   \
 419     } while (internal_iserror(res, &rverrno) && rverrno == EINTR); \
 420   }
 421
 422 // Forces the compiler to generate a frame pointer in the function.
 423 #define ENABLE_FRAME_POINTER              \
 424   do {                                    \
 425     volatile __sanitizer::uptr enable_fp; \
 426     enable_fp = GET_CURRENT_FRAME();      \
 427     (void)enable_fp;                      \
 428   } while (0)
 429
 430 // Internal thread identifier allocated by ThreadRegistry.
 431 typedef u32 Tid;
 432 constexpr Tid kInvalidTid = -1;
 433 constexpr Tid kMainTid = 0;
 434
 435 // Stack depot stack identifier.
 436 typedef u32 StackID;
 437 const StackID kInvalidStackID = 0;
 438
 439 }  // namespace __sanitizer
 440
 441 namespace __asan {
 442 using namespace __sanitizer;
 443 }
 444 namespace __dsan {
 445 using namespace __sanitizer;
 446 }
 447 namespace __dfsan {
 448 using namespace __sanitizer;
 449 }
 450 namespace __lsan {
 451 using namespace __sanitizer;
 452 }
 453 namespace __msan {
 454 using namespace __sanitizer;
 455 }
 456 namespace __hwasan {
 457 using namespace __sanitizer;
 458 }
 459 namespace __tsan {
 460 using namespace __sanitizer;
 461 }
 462 namespace __scudo {
 463 using namespace __sanitizer;
 464 }
 465 namespace __ubsan {
 466 using namespace __sanitizer;
 467 }
 468 namespace __xray {
 469 using namespace __sanitizer;
 470 }
 471 namespace __interception {
 472 using namespace __sanitizer;
 473 }
 474 namespace __hwasan {
 475 using namespace __sanitizer;
 476 }
 477 namespace __memprof {
 478 using namespace __sanitizer;
 479 }
 480
 481 #endif  // SANITIZER_DEFS_H