1//===-- Convenient sanitizer macros -----------------------------*- 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#ifndef LLVM_LIBC_SRC___SUPPORT_MACROS_SANITIZER_H
10#define LLVM_LIBC_SRC___SUPPORT_MACROS_SANITIZER_H
11
12#include "src/__support/macros/config.h" //LIBC_HAS_FEATURE
13
14//-----------------------------------------------------------------------------
15// Functions to unpoison memory
16//-----------------------------------------------------------------------------
17
18#if LIBC_HAS_FEATURE(address_sanitizer) || defined(__SANITIZE_ADDRESS__)
19#define LIBC_HAS_ADDRESS_SANITIZER
20#endif
21
22#if LIBC_HAS_FEATURE(memory_sanitizer)
23#define LIBC_HAS_MEMORY_SANITIZER
24#endif
25
26#if LIBC_HAS_FEATURE(thread_sanitizer) || defined(__SANITIZE_THREAD__)
27#define LIBC_HAS_THREAD_SANITIZER
28#endif
29
30#if LIBC_HAS_FEATURE(hwaddress_sanitizer) || defined(__SANITIZE_HWADDRESS__)
31#define LIBC_HAS_HWADDRESS_SANITIZER
32#endif
33
34// Shadow-memory sanitizers (ASan, MSan, TSan, HWASan).
35#if defined(LIBC_HAS_ADDRESS_SANITIZER) || \
36 defined(LIBC_HAS_MEMORY_SANITIZER) || \
37 defined(LIBC_HAS_THREAD_SANITIZER) || \
38 defined(LIBC_HAS_HWADDRESS_SANITIZER)
39#define LIBC_HAS_SANITIZER
40#endif
41
42#ifdef LIBC_HAS_MEMORY_SANITIZER
43// Only perform MSAN unpoison in non-constexpr context.
44#include <sanitizer/msan_interface.h>
45#define LIBC_MSAN_UNPOISON(addr, size) \
46 do { \
47 if (!__builtin_is_constant_evaluated()) \
48 __msan_unpoison(addr, size); \
49 } while (0)
50#else
51#define LIBC_MSAN_UNPOISON(ptr, size) \
52 do { \
53 (void)(ptr); \
54 (void)(size); \
55 } while (0)
56#endif
57
58#ifdef LIBC_HAS_ADDRESS_SANITIZER
59#include <sanitizer/asan_interface.h>
60#define LIBC_ASAN_POISON_MEMORY_REGION(addr, size) \
61 __asan_poison_memory_region((addr), (size))
62#define LIBC_ASAN_UNPOISON_MEMORY_REGION(addr, size) \
63 __asan_unpoison_memory_region((addr), (size))
64#else
65#define LIBC_ASAN_POISON_MEMORY_REGION(addr, size) ((void)(addr), (void)(size))
66#define LIBC_ASAN_UNPOISON_MEMORY_REGION(addr, size) \
67 ((void)(addr), (void)(size))
68#endif
69
70#endif // LLVM_LIBC_SRC___SUPPORT_MACROS_SANITIZER_H
71