forked from OSchip/llvm-project
283 lines
9.1 KiB
C++
283 lines
9.1 KiB
C++
//===-- sanitizer_internal_defs.h -------------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file is shared between AddressSanitizer and ThreadSanitizer.
|
|
// It contains macro used in run-time libraries code.
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef SANITIZER_DEFS_H
|
|
#define SANITIZER_DEFS_H
|
|
|
|
#include "sanitizer_platform.h"
|
|
|
|
#if SANITIZER_WINDOWS
|
|
// FIXME find out what we need on Windows. __declspec(dllexport) ?
|
|
# define SANITIZER_INTERFACE_ATTRIBUTE
|
|
# define SANITIZER_WEAK_ATTRIBUTE
|
|
#elif defined(SANITIZER_GO)
|
|
# define SANITIZER_INTERFACE_ATTRIBUTE
|
|
# define SANITIZER_WEAK_ATTRIBUTE
|
|
#else
|
|
# define SANITIZER_INTERFACE_ATTRIBUTE __attribute__((visibility("default")))
|
|
# define SANITIZER_WEAK_ATTRIBUTE __attribute__((weak))
|
|
#endif
|
|
|
|
#if SANITIZER_LINUX
|
|
# define SANITIZER_SUPPORTS_WEAK_HOOKS 1
|
|
#else
|
|
# define SANITIZER_SUPPORTS_WEAK_HOOKS 0
|
|
#endif
|
|
|
|
// GCC does not understand __has_feature
|
|
#if !defined(__has_feature)
|
|
# define __has_feature(x) 0
|
|
#endif
|
|
|
|
// For portability reasons we do not include stddef.h, stdint.h or any other
|
|
// system header, but we do need some basic types that are not defined
|
|
// in a portable way by the language itself.
|
|
namespace __sanitizer {
|
|
|
|
#if defined(_WIN64)
|
|
// 64-bit Windows uses LLP64 data model.
|
|
typedef unsigned long long uptr; // NOLINT
|
|
typedef signed long long sptr; // NOLINT
|
|
#else
|
|
typedef unsigned long uptr; // NOLINT
|
|
typedef signed long sptr; // NOLINT
|
|
#endif // defined(_WIN64)
|
|
#if defined(__x86_64__)
|
|
// Since x32 uses ILP32 data model in 64-bit hardware mode, we must use
|
|
// 64-bit pointer to unwind stack frame.
|
|
typedef unsigned long long uhwptr; // NOLINT
|
|
#else
|
|
typedef uptr uhwptr; // NOLINT
|
|
#endif
|
|
typedef unsigned char u8;
|
|
typedef unsigned short u16; // NOLINT
|
|
typedef unsigned int u32;
|
|
typedef unsigned long long u64; // NOLINT
|
|
typedef signed char s8;
|
|
typedef signed short s16; // NOLINT
|
|
typedef signed int s32;
|
|
typedef signed long long s64; // NOLINT
|
|
typedef int fd_t;
|
|
|
|
// WARNING: OFF_T may be different from OS type off_t, depending on the value of
|
|
// _FILE_OFFSET_BITS. This definition of OFF_T matches the ABI of system calls
|
|
// like pread and mmap, as opposed to pread64 and mmap64.
|
|
// Mac and Linux/x86-64 are special.
|
|
#if SANITIZER_MAC || (SANITIZER_LINUX && defined(__x86_64__))
|
|
typedef u64 OFF_T;
|
|
#else
|
|
typedef uptr OFF_T;
|
|
#endif
|
|
typedef u64 OFF64_T;
|
|
} // namespace __sanitizer
|
|
|
|
extern "C" {
|
|
// Tell the tools to write their reports to "path.<pid>" instead of stderr.
|
|
void __sanitizer_set_report_path(const char *path)
|
|
SANITIZER_INTERFACE_ATTRIBUTE;
|
|
|
|
// Tell the tools to write their reports to given file descriptor instead of
|
|
// stderr.
|
|
void __sanitizer_set_report_fd(int fd)
|
|
SANITIZER_INTERFACE_ATTRIBUTE;
|
|
|
|
// Notify the tools that the sandbox is going to be turned on. The reserved
|
|
// parameter will be used in the future to hold a structure with functions
|
|
// that the tools may call to bypass the sandbox.
|
|
void __sanitizer_sandbox_on_notify(void *reserved)
|
|
SANITIZER_WEAK_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE;
|
|
|
|
// This function is called by the tool when it has just finished reporting
|
|
// an error. 'error_summary' is a one-line string that summarizes
|
|
// the error message. This function can be overridden by the client.
|
|
void __sanitizer_report_error_summary(const char *error_summary)
|
|
SANITIZER_WEAK_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE;
|
|
} // extern "C"
|
|
|
|
|
|
using namespace __sanitizer; // NOLINT
|
|
// ----------- ATTENTION -------------
|
|
// This header should NOT include any other headers to avoid portability issues.
|
|
|
|
// Common defs.
|
|
#define INLINE static inline
|
|
#define INTERFACE_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE
|
|
#define WEAK SANITIZER_WEAK_ATTRIBUTE
|
|
|
|
// Platform-specific defs.
|
|
#if defined(_MSC_VER)
|
|
# define ALWAYS_INLINE __declspec(forceinline)
|
|
// FIXME(timurrrr): do we need this on Windows?
|
|
# define ALIAS(x)
|
|
# define ALIGNED(x) __declspec(align(x))
|
|
# define FORMAT(f, a)
|
|
# define NOINLINE __declspec(noinline)
|
|
# define NORETURN __declspec(noreturn)
|
|
# define THREADLOCAL __declspec(thread)
|
|
# define NOTHROW
|
|
# define LIKELY(x) (x)
|
|
# define UNLIKELY(x) (x)
|
|
# define UNUSED
|
|
# define USED
|
|
# define PREFETCH(x) /* _mm_prefetch(x, _MM_HINT_NTA) */
|
|
#else // _MSC_VER
|
|
# define ALWAYS_INLINE __attribute__((always_inline))
|
|
# define ALIAS(x) __attribute__((alias(x)))
|
|
# define ALIGNED(x) __attribute__((aligned(x)))
|
|
# define FORMAT(f, a) __attribute__((format(printf, f, a)))
|
|
# define NOINLINE __attribute__((noinline))
|
|
# define NORETURN __attribute__((noreturn))
|
|
# define THREADLOCAL __thread
|
|
# define NOTHROW throw()
|
|
# define LIKELY(x) __builtin_expect(!!(x), 1)
|
|
# define UNLIKELY(x) __builtin_expect(!!(x), 0)
|
|
# define UNUSED __attribute__((unused))
|
|
# define USED __attribute__((used))
|
|
# if defined(__i386__) || defined(__x86_64__)
|
|
// __builtin_prefetch(x) generates prefetchnt0 on x86
|
|
# define PREFETCH(x) __asm__("prefetchnta (%0)" : : "r" (x))
|
|
# else
|
|
# define PREFETCH(x) __builtin_prefetch(x)
|
|
# endif
|
|
#endif // _MSC_VER
|
|
|
|
#if SANITIZER_WINDOWS
|
|
typedef unsigned long DWORD; // NOLINT
|
|
typedef DWORD thread_return_t;
|
|
# define THREAD_CALLING_CONV __stdcall
|
|
#else // _WIN32
|
|
typedef void* thread_return_t;
|
|
# define THREAD_CALLING_CONV
|
|
#endif // _WIN32
|
|
typedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg);
|
|
|
|
#if __LP64__ || defined(_WIN64)
|
|
# define SANITIZER_WORDSIZE 64
|
|
#else
|
|
# define SANITIZER_WORDSIZE 32
|
|
#endif
|
|
|
|
// NOTE: Functions below must be defined in each run-time.
|
|
namespace __sanitizer {
|
|
void NORETURN Die();
|
|
void NORETURN CheckFailed(const char *file, int line, const char *cond,
|
|
u64 v1, u64 v2);
|
|
} // namespace __sanitizer
|
|
|
|
// Check macro
|
|
#define RAW_CHECK_MSG(expr, msg) do { \
|
|
if (!(expr)) { \
|
|
RawWrite(msg); \
|
|
Die(); \
|
|
} \
|
|
} while (0)
|
|
|
|
#define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr)
|
|
|
|
#define CHECK_IMPL(c1, op, c2) \
|
|
do { \
|
|
__sanitizer::u64 v1 = (u64)(c1); \
|
|
__sanitizer::u64 v2 = (u64)(c2); \
|
|
if (!(v1 op v2)) \
|
|
__sanitizer::CheckFailed(__FILE__, __LINE__, \
|
|
"(" #c1 ") " #op " (" #c2 ")", v1, v2); \
|
|
} while (false) \
|
|
/**/
|
|
|
|
#define CHECK(a) CHECK_IMPL((a), !=, 0)
|
|
#define CHECK_EQ(a, b) CHECK_IMPL((a), ==, (b))
|
|
#define CHECK_NE(a, b) CHECK_IMPL((a), !=, (b))
|
|
#define CHECK_LT(a, b) CHECK_IMPL((a), <, (b))
|
|
#define CHECK_LE(a, b) CHECK_IMPL((a), <=, (b))
|
|
#define CHECK_GT(a, b) CHECK_IMPL((a), >, (b))
|
|
#define CHECK_GE(a, b) CHECK_IMPL((a), >=, (b))
|
|
|
|
#if TSAN_DEBUG
|
|
#define DCHECK(a) CHECK(a)
|
|
#define DCHECK_EQ(a, b) CHECK_EQ(a, b)
|
|
#define DCHECK_NE(a, b) CHECK_NE(a, b)
|
|
#define DCHECK_LT(a, b) CHECK_LT(a, b)
|
|
#define DCHECK_LE(a, b) CHECK_LE(a, b)
|
|
#define DCHECK_GT(a, b) CHECK_GT(a, b)
|
|
#define DCHECK_GE(a, b) CHECK_GE(a, b)
|
|
#else
|
|
#define DCHECK(a)
|
|
#define DCHECK_EQ(a, b)
|
|
#define DCHECK_NE(a, b)
|
|
#define DCHECK_LT(a, b)
|
|
#define DCHECK_LE(a, b)
|
|
#define DCHECK_GT(a, b)
|
|
#define DCHECK_GE(a, b)
|
|
#endif
|
|
|
|
#define UNREACHABLE(msg) do { \
|
|
CHECK(0 && msg); \
|
|
Die(); \
|
|
} while (0)
|
|
|
|
#define UNIMPLEMENTED() UNREACHABLE("unimplemented")
|
|
|
|
#define COMPILER_CHECK(pred) IMPL_COMPILER_ASSERT(pred, __LINE__)
|
|
|
|
#define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
|
|
|
|
#define IMPL_PASTE(a, b) a##b
|
|
#define IMPL_COMPILER_ASSERT(pred, line) \
|
|
typedef char IMPL_PASTE(assertion_failed_##_, line)[2*(int)(pred)-1]
|
|
|
|
// Limits for integral types. We have to redefine it in case we don't
|
|
// have stdint.h (like in Visual Studio 9).
|
|
#undef __INT64_C
|
|
#undef __UINT64_C
|
|
#if SANITIZER_WORDSIZE == 64
|
|
# define __INT64_C(c) c ## L
|
|
# define __UINT64_C(c) c ## UL
|
|
#else
|
|
# define __INT64_C(c) c ## LL
|
|
# define __UINT64_C(c) c ## ULL
|
|
#endif // SANITIZER_WORDSIZE == 64
|
|
#undef INT32_MIN
|
|
#define INT32_MIN (-2147483647-1)
|
|
#undef INT32_MAX
|
|
#define INT32_MAX (2147483647)
|
|
#undef UINT32_MAX
|
|
#define UINT32_MAX (4294967295U)
|
|
#undef INT64_MIN
|
|
#define INT64_MIN (-__INT64_C(9223372036854775807)-1)
|
|
#undef INT64_MAX
|
|
#define INT64_MAX (__INT64_C(9223372036854775807))
|
|
#undef UINT64_MAX
|
|
#define UINT64_MAX (__UINT64_C(18446744073709551615))
|
|
|
|
enum LinkerInitialized { LINKER_INITIALIZED = 0 };
|
|
|
|
#if !defined(_MSC_VER) || defined(__clang__)
|
|
# define GET_CALLER_PC() (uptr)__builtin_return_address(0)
|
|
# define GET_CURRENT_FRAME() (uptr)__builtin_frame_address(0)
|
|
#else
|
|
extern "C" void* _ReturnAddress(void);
|
|
# pragma intrinsic(_ReturnAddress)
|
|
# define GET_CALLER_PC() (uptr)_ReturnAddress()
|
|
// CaptureStackBackTrace doesn't need to know BP on Windows.
|
|
// FIXME: This macro is still used when printing error reports though it's not
|
|
// clear if the BP value is needed in the ASan reports on Windows.
|
|
# define GET_CURRENT_FRAME() (uptr)0xDEADBEEF
|
|
#endif
|
|
|
|
#define HANDLE_EINTR(res, f) { \
|
|
do { \
|
|
res = (f); \
|
|
} while (res == -1 && errno == EINTR); \
|
|
}
|
|
|
|
#endif // SANITIZER_DEFS_H
|