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