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