sanitizer_internal_defs.h revision 53177247698bfba075f2d5b255a447fc3ced6976
1//===-- sanitizer_internal_defs.h -------------------------------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file is shared between AddressSanitizer and ThreadSanitizer. 11// It contains macro used in run-time libraries code. 12//===----------------------------------------------------------------------===// 13#ifndef SANITIZER_DEFS_H 14#define SANITIZER_DEFS_H 15 16#include "sanitizer_platform.h" 17 18// Only use SANITIZER_*ATTRIBUTE* before the function return type! 19#if SANITIZER_WINDOWS 20# define SANITIZER_INTERFACE_ATTRIBUTE __declspec(dllexport) 21// FIXME find out what we need on Windows, if anything. 22# define SANITIZER_WEAK_ATTRIBUTE 23#elif defined(SANITIZER_GO) 24# define SANITIZER_INTERFACE_ATTRIBUTE 25# define SANITIZER_WEAK_ATTRIBUTE 26#else 27# define SANITIZER_INTERFACE_ATTRIBUTE __attribute__((visibility("default"))) 28# define SANITIZER_WEAK_ATTRIBUTE __attribute__((weak)) 29#endif 30 31#if SANITIZER_LINUX && !defined(SANITIZER_GO) 32# define SANITIZER_SUPPORTS_WEAK_HOOKS 1 33#else 34# define SANITIZER_SUPPORTS_WEAK_HOOKS 0 35#endif 36 37#if __LP64__ || defined(_WIN64) 38# define SANITIZER_WORDSIZE 64 39#else 40# define SANITIZER_WORDSIZE 32 41#endif 42 43// GCC does not understand __has_feature 44#if !defined(__has_feature) 45# define __has_feature(x) 0 46#endif 47 48// For portability reasons we do not include stddef.h, stdint.h or any other 49// system header, but we do need some basic types that are not defined 50// in a portable way by the language itself. 51namespace __sanitizer { 52 53#if defined(_WIN64) 54// 64-bit Windows uses LLP64 data model. 55typedef unsigned long long uptr; // NOLINT 56typedef signed long long sptr; // NOLINT 57#else 58typedef unsigned long uptr; // NOLINT 59typedef signed long sptr; // NOLINT 60#endif // defined(_WIN64) 61#if defined(__x86_64__) 62// Since x32 uses ILP32 data model in 64-bit hardware mode, we must use 63// 64-bit pointer to unwind stack frame. 64typedef unsigned long long uhwptr; // NOLINT 65#else 66typedef uptr uhwptr; // NOLINT 67#endif 68typedef unsigned char u8; 69typedef unsigned short u16; // NOLINT 70typedef unsigned int u32; 71typedef unsigned long long u64; // NOLINT 72typedef signed char s8; 73typedef signed short s16; // NOLINT 74typedef signed int s32; 75typedef signed long long s64; // NOLINT 76typedef int fd_t; 77 78// WARNING: OFF_T may be different from OS type off_t, depending on the value of 79// _FILE_OFFSET_BITS. This definition of OFF_T matches the ABI of system calls 80// like pread and mmap, as opposed to pread64 and mmap64. 81// Mac and Linux/x86-64 are special. 82#if SANITIZER_MAC || (SANITIZER_LINUX && defined(__x86_64__)) 83typedef u64 OFF_T; 84#else 85typedef uptr OFF_T; 86#endif 87typedef u64 OFF64_T; 88 89#if (SANITIZER_WORDSIZE == 64) || SANITIZER_MAC 90typedef uptr operator_new_size_type; 91#else 92typedef u32 operator_new_size_type; 93#endif 94} // namespace __sanitizer 95 96extern "C" { 97 // Tell the tools to write their reports to "path.<pid>" instead of stderr. 98 // The special values are "stdout" and "stderr". 99 SANITIZER_INTERFACE_ATTRIBUTE 100 void __sanitizer_set_report_path(const char *path); 101 102 // Notify the tools that the sandbox is going to be turned on. The reserved 103 // parameter will be used in the future to hold a structure with functions 104 // that the tools may call to bypass the sandbox. 105 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE 106 void __sanitizer_sandbox_on_notify(void *reserved); 107 108 // This function is called by the tool when it has just finished reporting 109 // an error. 'error_summary' is a one-line string that summarizes 110 // the error message. This function can be overridden by the client. 111 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE 112 void __sanitizer_report_error_summary(const char *error_summary); 113} // extern "C" 114 115 116using namespace __sanitizer; // NOLINT 117// ----------- ATTENTION ------------- 118// This header should NOT include any other headers to avoid portability issues. 119 120// Common defs. 121#define INLINE inline 122#define INTERFACE_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE 123#define WEAK SANITIZER_WEAK_ATTRIBUTE 124 125// Platform-specific defs. 126#if defined(_MSC_VER) 127# define ALWAYS_INLINE __forceinline 128// FIXME(timurrrr): do we need this on Windows? 129# define ALIAS(x) 130# define ALIGNED(x) __declspec(align(x)) 131# define FORMAT(f, a) 132# define NOINLINE __declspec(noinline) 133# define NORETURN __declspec(noreturn) 134# define THREADLOCAL __declspec(thread) 135# define NOTHROW 136# define LIKELY(x) (x) 137# define UNLIKELY(x) (x) 138# define UNUSED 139# define USED 140# define PREFETCH(x) /* _mm_prefetch(x, _MM_HINT_NTA) */ 141#else // _MSC_VER 142# define ALWAYS_INLINE inline __attribute__((always_inline)) 143# define ALIAS(x) __attribute__((alias(x))) 144// Please only use the ALIGNED macro before the type. 145// Using ALIGNED after the variable declaration is not portable! 146# define ALIGNED(x) __attribute__((aligned(x))) 147# define FORMAT(f, a) __attribute__((format(printf, f, a))) 148# define NOINLINE __attribute__((noinline)) 149# define NORETURN __attribute__((noreturn)) 150# define THREADLOCAL __thread 151# define NOTHROW throw() 152# define LIKELY(x) __builtin_expect(!!(x), 1) 153# define UNLIKELY(x) __builtin_expect(!!(x), 0) 154# define UNUSED __attribute__((unused)) 155# define USED __attribute__((used)) 156# if defined(__i386__) || defined(__x86_64__) 157// __builtin_prefetch(x) generates prefetchnt0 on x86 158# define PREFETCH(x) __asm__("prefetchnta (%0)" : : "r" (x)) 159# else 160# define PREFETCH(x) __builtin_prefetch(x) 161# endif 162#endif // _MSC_VER 163 164// Unaligned versions of basic types. 165typedef ALIGNED(1) u16 uu16; 166typedef ALIGNED(1) u32 uu32; 167typedef ALIGNED(1) u64 uu64; 168typedef ALIGNED(1) s16 us16; 169typedef ALIGNED(1) s32 us32; 170typedef ALIGNED(1) s64 us64; 171 172#if SANITIZER_WINDOWS 173typedef unsigned long DWORD; // NOLINT 174typedef DWORD thread_return_t; 175# define THREAD_CALLING_CONV __stdcall 176#else // _WIN32 177typedef void* thread_return_t; 178# define THREAD_CALLING_CONV 179#endif // _WIN32 180typedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg); 181 182// NOTE: Functions below must be defined in each run-time. 183namespace __sanitizer { 184void NORETURN Die(); 185 186// FIXME: No, this shouldn't be in the sanitizer interface. 187SANITIZER_INTERFACE_ATTRIBUTE 188void NORETURN CheckFailed(const char *file, int line, const char *cond, 189 u64 v1, u64 v2); 190} // namespace __sanitizer 191 192// Check macro 193#define RAW_CHECK_MSG(expr, msg) do { \ 194 if (!(expr)) { \ 195 RawWrite(msg); \ 196 Die(); \ 197 } \ 198} while (0) 199 200#define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr) 201 202#define CHECK_IMPL(c1, op, c2) \ 203 do { \ 204 __sanitizer::u64 v1 = (u64)(c1); \ 205 __sanitizer::u64 v2 = (u64)(c2); \ 206 if (!(v1 op v2)) \ 207 __sanitizer::CheckFailed(__FILE__, __LINE__, \ 208 "(" #c1 ") " #op " (" #c2 ")", v1, v2); \ 209 } while (false) \ 210/**/ 211 212#define CHECK(a) CHECK_IMPL((a), !=, 0) 213#define CHECK_EQ(a, b) CHECK_IMPL((a), ==, (b)) 214#define CHECK_NE(a, b) CHECK_IMPL((a), !=, (b)) 215#define CHECK_LT(a, b) CHECK_IMPL((a), <, (b)) 216#define CHECK_LE(a, b) CHECK_IMPL((a), <=, (b)) 217#define CHECK_GT(a, b) CHECK_IMPL((a), >, (b)) 218#define CHECK_GE(a, b) CHECK_IMPL((a), >=, (b)) 219 220#if TSAN_DEBUG 221#define DCHECK(a) CHECK(a) 222#define DCHECK_EQ(a, b) CHECK_EQ(a, b) 223#define DCHECK_NE(a, b) CHECK_NE(a, b) 224#define DCHECK_LT(a, b) CHECK_LT(a, b) 225#define DCHECK_LE(a, b) CHECK_LE(a, b) 226#define DCHECK_GT(a, b) CHECK_GT(a, b) 227#define DCHECK_GE(a, b) CHECK_GE(a, b) 228#else 229#define DCHECK(a) 230#define DCHECK_EQ(a, b) 231#define DCHECK_NE(a, b) 232#define DCHECK_LT(a, b) 233#define DCHECK_LE(a, b) 234#define DCHECK_GT(a, b) 235#define DCHECK_GE(a, b) 236#endif 237 238#define UNREACHABLE(msg) do { \ 239 CHECK(0 && msg); \ 240 Die(); \ 241} while (0) 242 243#define UNIMPLEMENTED() UNREACHABLE("unimplemented") 244 245#define COMPILER_CHECK(pred) IMPL_COMPILER_ASSERT(pred, __LINE__) 246 247#define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0])) 248 249#define IMPL_PASTE(a, b) a##b 250#define IMPL_COMPILER_ASSERT(pred, line) \ 251 typedef char IMPL_PASTE(assertion_failed_##_, line)[2*(int)(pred)-1] 252 253// Limits for integral types. We have to redefine it in case we don't 254// have stdint.h (like in Visual Studio 9). 255#undef __INT64_C 256#undef __UINT64_C 257#if SANITIZER_WORDSIZE == 64 258# define __INT64_C(c) c ## L 259# define __UINT64_C(c) c ## UL 260#else 261# define __INT64_C(c) c ## LL 262# define __UINT64_C(c) c ## ULL 263#endif // SANITIZER_WORDSIZE == 64 264#undef INT32_MIN 265#define INT32_MIN (-2147483647-1) 266#undef INT32_MAX 267#define INT32_MAX (2147483647) 268#undef UINT32_MAX 269#define UINT32_MAX (4294967295U) 270#undef INT64_MIN 271#define INT64_MIN (-__INT64_C(9223372036854775807)-1) 272#undef INT64_MAX 273#define INT64_MAX (__INT64_C(9223372036854775807)) 274#undef UINT64_MAX 275#define UINT64_MAX (__UINT64_C(18446744073709551615)) 276 277enum LinkerInitialized { LINKER_INITIALIZED = 0 }; 278 279#if !defined(_MSC_VER) || defined(__clang__) 280# define GET_CALLER_PC() (uptr)__builtin_return_address(0) 281# define GET_CURRENT_FRAME() (uptr)__builtin_frame_address(0) 282#else 283extern "C" void* _ReturnAddress(void); 284# pragma intrinsic(_ReturnAddress) 285# define GET_CALLER_PC() (uptr)_ReturnAddress() 286// CaptureStackBackTrace doesn't need to know BP on Windows. 287// FIXME: This macro is still used when printing error reports though it's not 288// clear if the BP value is needed in the ASan reports on Windows. 289# define GET_CURRENT_FRAME() (uptr)0xDEADBEEF 290#endif 291 292#define HANDLE_EINTR(res, f) \ 293 { \ 294 int rverrno; \ 295 do { \ 296 res = (f); \ 297 } while (internal_iserror(res, &rverrno) && rverrno == EINTR); \ 298 } 299 300#endif // SANITIZER_DEFS_H 301