1 //===-- hwasan.h ------------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file is a part of HWAddressSanitizer.
12 // Private Hwasan header.
13 //===----------------------------------------------------------------------===//
18 #include "sanitizer_common/sanitizer_flags.h"
19 #include "sanitizer_common/sanitizer_internal_defs.h"
20 #include "sanitizer_common/sanitizer_stacktrace.h"
21 #include "hwasan_interface_internal.h"
22 #include "hwasan_flags.h"
23 #include "ubsan/ubsan_platform.h"
25 #ifndef HWASAN_REPLACE_OPERATORS_NEW_AND_DELETE
26 # define HWASAN_REPLACE_OPERATORS_NEW_AND_DELETE 1
29 #ifndef HWASAN_CONTAINS_UBSAN
30 # define HWASAN_CONTAINS_UBSAN CAN_SANITIZE_UB
35 // TBI (Top Byte Ignore) feature of AArch64: bits [63:56] are ignored in address
36 // translation and can be used to store a tag.
37 const unsigned kAddressTagShift = 56;
38 const uptr kAddressTagMask = 0xFFUL << kAddressTagShift;
40 static inline tag_t GetTagFromPointer(uptr p) {
41 return p >> kAddressTagShift;
44 static inline uptr GetAddressFromPointer(uptr p) {
45 return p & ~kAddressTagMask;
48 static inline void * GetAddressFromPointer(const void *p) {
49 return (void *)((uptr)p & ~kAddressTagMask);
52 static inline uptr AddTagToPointer(uptr p, tag_t tag) {
53 return (p & ~kAddressTagMask) | ((uptr)tag << kAddressTagShift);
58 extern int hwasan_inited;
59 extern bool hwasan_init_is_running;
60 extern int hwasan_report_count;
62 bool ProtectRange(uptr beg, uptr end);
64 char *GetProcSelfMaps();
65 void InitializeInterceptors();
67 void HwasanAllocatorInit();
68 void HwasanAllocatorThreadFinish();
69 void HwasanDeallocate(StackTrace *stack, void *ptr);
71 void *hwasan_malloc(uptr size, StackTrace *stack);
72 void *hwasan_calloc(uptr nmemb, uptr size, StackTrace *stack);
73 void *hwasan_realloc(void *ptr, uptr size, StackTrace *stack);
74 void *hwasan_valloc(uptr size, StackTrace *stack);
75 void *hwasan_pvalloc(uptr size, StackTrace *stack);
76 void *hwasan_aligned_alloc(uptr alignment, uptr size, StackTrace *stack);
77 void *hwasan_memalign(uptr alignment, uptr size, StackTrace *stack);
78 int hwasan_posix_memalign(void **memptr, uptr alignment, uptr size,
81 void InstallTrapHandler();
82 void InstallAtExitHandler();
84 const char *GetStackOriginDescr(u32 id, uptr *pc);
86 void EnterSymbolizer();
87 void ExitSymbolizer();
88 bool IsInSymbolizer();
90 struct SymbolizerScope {
91 SymbolizerScope() { EnterSymbolizer(); }
92 ~SymbolizerScope() { ExitSymbolizer(); }
95 void PrintWarning(uptr pc, uptr bp);
97 void GetStackTrace(BufferedStackTrace *stack, uptr max_s, uptr pc, uptr bp,
98 void *context, bool request_fast_unwind);
100 // Returns a "chained" origin id, pointing to the given stack trace followed by
101 // the previous origin id.
102 u32 ChainOrigin(u32 id, StackTrace *stack);
104 const int STACK_TRACE_TAG_POISON = StackTrace::TAG_CUSTOM + 1;
106 #define GET_MALLOC_STACK_TRACE \
107 BufferedStackTrace stack; \
109 GetStackTrace(&stack, common_flags()->malloc_context_size, \
110 StackTrace::GetCurrentPc(), GET_CURRENT_FRAME(), nullptr, \
111 common_flags()->fast_unwind_on_malloc)
113 #define GET_FATAL_STACK_TRACE_PC_BP(pc, bp) \
114 BufferedStackTrace stack; \
116 GetStackTrace(&stack, kStackTraceMax, pc, bp, nullptr, \
117 common_flags()->fast_unwind_on_fatal)
119 #define GET_FATAL_STACK_TRACE_HERE \
120 GET_FATAL_STACK_TRACE_PC_BP(StackTrace::GetCurrentPc(), GET_CURRENT_FRAME())
122 #define PRINT_CURRENT_STACK_CHECK() \
124 GET_FATAL_STACK_TRACE_HERE; \
128 class ScopedThreadLocalStateBackup {
130 ScopedThreadLocalStateBackup() { Backup(); }
131 ~ScopedThreadLocalStateBackup() { Restore(); }
135 u64 va_arg_overflow_size_tls;
138 void HwasanTSDInit(void (*destructor)(void *tsd));
139 void *HwasanTSDGet();
140 void HwasanTSDSet(void *tsd);
141 void HwasanTSDDtor(void *tsd);
143 void HwasanOnDeadlySignal(int signo, void *info, void *context);
145 } // namespace __hwasan
147 #define HWASAN_MALLOC_HOOK(ptr, size) \
149 if (&__sanitizer_malloc_hook) { \
150 __sanitizer_malloc_hook(ptr, size); \
152 RunMallocHooks(ptr, size); \
154 #define HWASAN_FREE_HOOK(ptr) \
156 if (&__sanitizer_free_hook) { \
157 __sanitizer_free_hook(ptr); \