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 || SANITIZER_OPENBSD
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_ANDROID) || SANITIZER_OPENBSD || \
108 SANITIZER_FUCHSIA || SANITIZER_NETBSD) && !defined(PIC)
109 #define SANITIZER_CAN_USE_PREINIT_ARRAY 1
110 // Before Solaris 11.4, .preinit_array is fully supported only with GNU ld.
111 // FIXME: Check for those conditions.
112 #elif SANITIZER_SOLARIS && !defined(PIC)
113 # define SANITIZER_CAN_USE_PREINIT_ARRAY 1
114 #else
115 # define SANITIZER_CAN_USE_PREINIT_ARRAY 0
116 #endif
117 #endif // SANITIZER_CAN_USE_PREINIT_ARRAY
118
119 // GCC does not understand __has_feature
120 #if !defined(__has_feature)
121 # define __has_feature(x) 0
122 #endif
123
124 // Older GCCs do not understand __has_attribute.
125 #if !defined(__has_attribute)
126 # define __has_attribute(x) 0
127 #endif
128
129 // For portability reasons we do not include stddef.h, stdint.h or any other
130 // system header, but we do need some basic types that are not defined
131 // in a portable way by the language itself.
132 namespace __sanitizer {
133
134 #if defined(_WIN64)
135 // 64-bit Windows uses LLP64 data model.
136 typedef unsigned long long uptr;
137 typedef signed long long sptr;
138 #elif defined(__CHERI_PURE_CAPABILITY__)
139 typedef __uintcap_t uptr;
140 typedef __intcap_t sptr;
141 typedef unsigned long vaddr;
142 #else
143 typedef unsigned long uptr;
144 typedef signed long sptr;
145 typedef unsigned long vaddr;
146 #endif // defined(_WIN64)
147 #if defined(__x86_64__)
148 // Since x32 uses ILP32 data model in 64-bit hardware mode, we must use
149 // 64-bit pointer to unwind stack frame.
150 typedef unsigned long long uhwptr;
151 #else
152 typedef uptr uhwptr;
153 #endif
154 typedef unsigned char u8;
155 typedef unsigned short u16;
156 typedef unsigned int u32;
157 typedef unsigned long long u64;
158 typedef signed char s8;
159 typedef signed short s16;
160 typedef signed int s32;
161 typedef signed long long s64;
162 #if SANITIZER_WINDOWS
163 // On Windows, files are HANDLE, which is a synonim of void*.
164 // Use void* to avoid including <windows.h> everywhere.
165 typedef void* fd_t;
166 typedef unsigned error_t;
167 #else
168 typedef int fd_t;
169 typedef int error_t;
170 #endif
171 #if SANITIZER_SOLARIS && !defined(_LP64)
172 typedef long pid_t;
173 #else
174 typedef int pid_t;
175 #endif
176
177 #if SANITIZER_FREEBSD || SANITIZER_NETBSD || \
178 SANITIZER_OPENBSD || SANITIZER_MAC || \
179 (SANITIZER_SOLARIS && (defined(_LP64) || _FILE_OFFSET_BITS == 64)) || \
180 (SANITIZER_LINUX && defined(__x86_64__))
181 typedef u64 OFF_T;
182 #else
183 typedef uptr OFF_T;
184 #endif
185 typedef u64 OFF64_T;
186
187 #ifdef __CHERI_PURE_CAPABILITY__
188 typedef __SIZE_TYPE__ operator_new_size_type;
189 #elif (SANITIZER_WORDSIZE == 64) || SANITIZER_MAC
190 typedef uptr operator_new_size_type;
191 #else
192 # if SANITIZER_OPENBSD || defined(__s390__) && !defined(__s390x__)
193 // Special case: 31-bit s390 has unsigned long as size_t.
194 typedef unsigned long operator_new_size_type;
195 # else
196 typedef u32 operator_new_size_type;
197 # endif
198 #endif
199
200 #if (SANITIZER_WORDSIZE == 64)
201 static_assert(sizeof(operator_new_size_type) == 8, "");
202 #endif
203
204 typedef u64 tid_t;
205
206 #if (SANITIZER_WORDSIZE == 64)
207 typedef u64 uword;
208 typedef s64 sword;
209 typedef s64 ptrdiff;
210 #elif (SANITIZER_WORDSIZE == 32)
211 typedef u32 uword;
212 typedef s32 sword;
213 typedef s32 ptrdiff;
214 #else
215 #error "SANITIZER_WORDSIZE not supported"
216 #endif
217 typedef unsigned long usize;
218 typedef signed long ssize;
219
220 #ifdef __CHERI_PURE_CAPABILITY__
221 static_assert(sizeof(ptrdiff) == sizeof(__PTRDIFF_TYPE__), "");
222 static_assert(sizeof(usize) == sizeof(__SIZE_TYPE__), "");
223 static_assert(sizeof(uptr) == sizeof(__UINTPTR_TYPE__), "");
224 static_assert(sizeof(sptr) == sizeof(__INTPTR_TYPE__), "");
225 #endif
226
227 // ----------- ATTENTION -------------
228 // This header should NOT include any other headers to avoid portability issues.
229
230 // Common defs.
231 #ifndef INLINE
232 #define INLINE inline
233 #endif
234 #define INTERFACE_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE
235 #define SANITIZER_WEAK_DEFAULT_IMPL \
236 extern "C" SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE NOINLINE
237 #define SANITIZER_WEAK_CXX_DEFAULT_IMPL \
238 extern "C++" SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE NOINLINE
239
240 // Platform-specific defs.
241 #if defined(_MSC_VER)
242 # define ALWAYS_INLINE __forceinline
243 // FIXME(timurrrr): do we need this on Windows?
244 # define ALIAS(x)
245 # define ALIGNED(x) __declspec(align(x))
246 # define FORMAT(f, a)
247 # define NOINLINE __declspec(noinline)
248 # define NORETURN __declspec(noreturn)
249 # define THREADLOCAL __declspec(thread)
250 # define LIKELY(x) (x)
251 # define UNLIKELY(x) (x)
252 # define PREFETCH(x) /* _mm_prefetch(x, _MM_HINT_NTA) */ (void)0
253 # define WARN_UNUSED_RESULT
254 #else // _MSC_VER
255 # define ALWAYS_INLINE inline __attribute__((always_inline))
256 # define ALIAS(x) __attribute__((alias(x)))
257 // Please only use the ALIGNED macro before the type.
258 // Using ALIGNED after the variable declaration is not portable!
259 # define ALIGNED(x) __attribute__((aligned(x)))
260 # define FORMAT(f, a) __attribute__((format(printf, f, a)))
261 # define NOINLINE __attribute__((noinline))
262 # define NORETURN __attribute__((noreturn))
263 # define THREADLOCAL __thread
264 # define LIKELY(x) __builtin_expect(!!(x), 1)
265 # define UNLIKELY(x) __builtin_expect(!!(x), 0)
266 # if defined(__i386__) || defined(__x86_64__)
267 // __builtin_prefetch(x) generates prefetchnt0 on x86
268 # define PREFETCH(x) __asm__("prefetchnta (%0)" : : "r" (x))
269 # else
270 # define PREFETCH(x) __builtin_prefetch(x)
271 # endif
272 # define WARN_UNUSED_RESULT __attribute__((warn_unused_result))
273 #endif // _MSC_VER
274
275 #if !defined(_MSC_VER) || defined(__clang__)
276 # define UNUSED __attribute__((unused))
277 # define USED __attribute__((used))
278 #else
279 # define UNUSED
280 # define USED
281 #endif
282
283 #if !defined(_MSC_VER) || defined(__clang__) || MSC_PREREQ(1900)
284 # define NOEXCEPT noexcept
285 #else
286 # define NOEXCEPT throw()
287 #endif
288
289 // Unaligned versions of basic types.
290 typedef ALIGNED(1) u16 uu16;
291 typedef ALIGNED(1) u32 uu32;
292 typedef ALIGNED(1) u64 uu64;
293 typedef ALIGNED(1) s16 us16;
294 typedef ALIGNED(1) s32 us32;
295 typedef ALIGNED(1) s64 us64;
296
297 #if SANITIZER_WINDOWS
298 } // namespace __sanitizer
299 typedef unsigned long DWORD;
300 namespace __sanitizer {
301 typedef DWORD thread_return_t;
302 # define THREAD_CALLING_CONV __stdcall
303 #else // _WIN32
304 typedef void* thread_return_t;
305 # define THREAD_CALLING_CONV
306 #endif // _WIN32
307 typedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg);
308
309 // NOTE: Functions below must be defined in each run-time.
310 void NORETURN Die();
311
312 void NORETURN CheckFailed(const char *file, int line, const char *cond,
313 u64 v1, u64 v2);
314
315 // Check macro
316 #define RAW_CHECK_MSG(expr, msg) do { \
317 if (UNLIKELY(!(expr))) { \
318 RawWrite(msg); \
319 Die(); \
320 } \
321 } while (0)
322
323 #define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr)
324
325 #define CHECK_IMPL(c1, op, c2) \
326 do { \
327 __sanitizer::u64 v1 = (__sanitizer::u64)(c1); \
328 __sanitizer::u64 v2 = (__sanitizer::u64)(c2); \
329 if (UNLIKELY(!(v1 op v2))) \
330 __sanitizer::CheckFailed(__FILE__, __LINE__, \
331 "(" #c1 ") " #op " (" #c2 ")", v1, v2); \
332 } while (false) \
333 /**/
334
335 #define CHECK(a) CHECK_IMPL((a), !=, 0)
336 #define CHECK_EQ(a, b) CHECK_IMPL((a), ==, (b))
337 #define CHECK_NE(a, b) CHECK_IMPL((a), !=, (b))
338 #define CHECK_LT(a, b) CHECK_IMPL((a), <, (b))
339 #define CHECK_LE(a, b) CHECK_IMPL((a), <=, (b))
340 #define CHECK_GT(a, b) CHECK_IMPL((a), >, (b))
341 #define CHECK_GE(a, b) CHECK_IMPL((a), >=, (b))
342
343 #if SANITIZER_DEBUG
344 #define DCHECK(a) CHECK(a)
345 #define DCHECK_EQ(a, b) CHECK_EQ(a, b)
346 #define DCHECK_NE(a, b) CHECK_NE(a, b)
347 #define DCHECK_LT(a, b) CHECK_LT(a, b)
348 #define DCHECK_LE(a, b) CHECK_LE(a, b)
349 #define DCHECK_GT(a, b) CHECK_GT(a, b)
350 #define DCHECK_GE(a, b) CHECK_GE(a, b)
351 #else
352 #define DCHECK(a)
353 #define DCHECK_EQ(a, b)
354 #define DCHECK_NE(a, b)
355 #define DCHECK_LT(a, b)
356 #define DCHECK_LE(a, b)
357 #define DCHECK_GT(a, b)
358 #define DCHECK_GE(a, b)
359 #endif
360
361 #define UNREACHABLE(msg) do { \
362 CHECK(0 && msg); \
363 Die(); \
364 } while (0)
365
366 #define UNIMPLEMENTED() UNREACHABLE("unimplemented")
367
368 #define COMPILER_CHECK(pred) IMPL_COMPILER_ASSERT(pred, __LINE__)
369
370 #define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
371
372 #define IMPL_PASTE(a, b) a##b
373 #ifdef __CHERI_PURE_CAPABILITY__
374 #define IMPL_COMPILER_ASSERT(pred, line) static_assert(pred, #line)
375 #else
376 #define IMPL_COMPILER_ASSERT(pred, line) \
377 typedef char IMPL_PASTE(assertion_failed_##_, line)[2*(int)(pred)-1]
378 #endif
379
380 // Limits for integral types. We have to redefine it in case we don't
381 // have stdint.h (like in Visual Studio 9).
382 #undef __INT64_C
383 #undef __UINT64_C
384 #if SANITIZER_WORDSIZE == 64
385 # define __INT64_C(c) c ## L
386 # define __UINT64_C(c) c ## UL
387 #else
388 # define __INT64_C(c) c ## LL
389 # define __UINT64_C(c) c ## ULL
390 #endif // SANITIZER_WORDSIZE == 64
391 #undef INT32_MIN
392 #define INT32_MIN (-2147483647-1)
393 #undef INT32_MAX
394 #define INT32_MAX (2147483647)
395 #undef UINT32_MAX
396 #define UINT32_MAX (4294967295U)
397 #undef INT64_MIN
398 #define INT64_MIN (-__INT64_C(9223372036854775807)-1)
399 #undef INT64_MAX
400 #define INT64_MAX (__INT64_C(9223372036854775807))
401 #undef UINT64_MAX
402 #define UINT64_MAX (__UINT64_C(18446744073709551615))
403 #undef UINTPTR_MAX
404 #if SANITIZER_WORDSIZE == 64
405 # define UINTPTR_MAX (18446744073709551615UL)
406 #else
407 # define UINTPTR_MAX (4294967295U)
408 #endif // SANITIZER_WORDSIZE == 64
409
410 enum LinkerInitialized { LINKER_INITIALIZED = 0 };
411
412 #if !defined(_MSC_VER) || defined(__clang__)
413 #if SANITIZER_S390_31
414 #define GET_CALLER_PC() \
415 (__sanitizer::uptr) __builtin_extract_return_addr(__builtin_return_address(0))
416 #else
417 #define GET_CALLER_PC() (__sanitizer::uptr) __builtin_return_address(0)
418 #endif
419 #define GET_CURRENT_FRAME() (__sanitizer::uptr) __builtin_frame_address(0)
Trap()420 inline void Trap() {
421 __builtin_trap();
422 }
423 #else
424 extern "C" void* _ReturnAddress(void);
425 extern "C" void* _AddressOfReturnAddress(void);
426 # pragma intrinsic(_ReturnAddress)
427 # pragma intrinsic(_AddressOfReturnAddress)
428 #define GET_CALLER_PC() (__sanitizer::uptr) _ReturnAddress()
429 // CaptureStackBackTrace doesn't need to know BP on Windows.
430 #define GET_CURRENT_FRAME() \
431 (((__sanitizer::uptr)_AddressOfReturnAddress()) + sizeof(__sanitizer::uptr))
432
433 extern "C" void __ud2(void);
434 # pragma intrinsic(__ud2)
Trap()435 inline void Trap() {
436 __ud2();
437 }
438 #endif
439
440 #define HANDLE_EINTR(res, f) \
441 { \
442 int rverrno; \
443 do { \
444 res = (f); \
445 } while (internal_iserror(res, &rverrno) && rverrno == EINTR); \
446 }
447
448 // Forces the compiler to generate a frame pointer in the function.
449 #define ENABLE_FRAME_POINTER \
450 do { \
451 volatile __sanitizer::uptr enable_fp; \
452 enable_fp = GET_CURRENT_FRAME(); \
453 (void)enable_fp; \
454 } while (0)
455
456 } // namespace __sanitizer
457
458 namespace __asan {
459 using namespace __sanitizer;
460 }
461 namespace __dsan {
462 using namespace __sanitizer;
463 }
464 namespace __dfsan {
465 using namespace __sanitizer;
466 }
467 namespace __lsan {
468 using namespace __sanitizer;
469 }
470 namespace __msan {
471 using namespace __sanitizer;
472 }
473 namespace __hwasan {
474 using namespace __sanitizer;
475 }
476 namespace __tsan {
477 using namespace __sanitizer;
478 }
479 namespace __scudo {
480 using namespace __sanitizer;
481 }
482 namespace __ubsan {
483 using namespace __sanitizer;
484 }
485 namespace __xray {
486 using namespace __sanitizer;
487 }
488 namespace __interception {
489 using namespace __sanitizer;
490 }
491 namespace __hwasan {
492 using namespace __sanitizer;
493 }
494
495 #endif // SANITIZER_DEFS_H
496