contrib/compiler-rt/lib/hwasan/hwasan.h

   1 //===-- hwasan.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 a part of HWAddressSanitizer.
  11 //
  12 // Private Hwasan header.
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef HWASAN_H
  16 #define HWASAN_H
  17
  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"
  24
  25 #ifndef HWASAN_REPLACE_OPERATORS_NEW_AND_DELETE
  26 # define HWASAN_REPLACE_OPERATORS_NEW_AND_DELETE 1
  27 #endif
  28
  29 #ifndef HWASAN_CONTAINS_UBSAN
  30 # define HWASAN_CONTAINS_UBSAN CAN_SANITIZE_UB
  31 #endif
  32
  33 typedef u8 tag_t;
  34
  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;
  39
  40 static inline tag_t GetTagFromPointer(uptr p) {
  41   return p >> kAddressTagShift;
  42 }
  43
  44 static inline uptr GetAddressFromPointer(uptr p) {
  45   return p & ~kAddressTagMask;
  46 }
  47
  48 static inline void * GetAddressFromPointer(const void *p) {
  49   return (void *)((uptr)p & ~kAddressTagMask);
  50 }
  51
  52 static inline uptr AddTagToPointer(uptr p, tag_t tag) {
  53   return (p & ~kAddressTagMask) | ((uptr)tag << kAddressTagShift);
  54 }
  55
  56 namespace __hwasan {
  57
  58 extern int hwasan_inited;
  59 extern bool hwasan_init_is_running;
  60 extern int hwasan_report_count;
  61
  62 bool ProtectRange(uptr beg, uptr end);
  63 bool InitShadow();
  64 char *GetProcSelfMaps();
  65 void InitializeInterceptors();
  66
  67 void HwasanAllocatorInit();
  68 void HwasanAllocatorThreadFinish();
  69 void HwasanDeallocate(StackTrace *stack, void *ptr);
  70
  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,
  79                         StackTrace *stack);
  80
  81 void InstallTrapHandler();
  82 void InstallAtExitHandler();
  83
  84 const char *GetStackOriginDescr(u32 id, uptr *pc);
  85
  86 void EnterSymbolizer();
  87 void ExitSymbolizer();
  88 bool IsInSymbolizer();
  89
  90 struct SymbolizerScope {
  91   SymbolizerScope() { EnterSymbolizer(); }
  92   ~SymbolizerScope() { ExitSymbolizer(); }
  93 };
  94
  95 void PrintWarning(uptr pc, uptr bp);
  96
  97 void GetStackTrace(BufferedStackTrace *stack, uptr max_s, uptr pc, uptr bp,
  98                    void *context, bool request_fast_unwind);
  99
 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);
 103
 104 const int STACK_TRACE_TAG_POISON = StackTrace::TAG_CUSTOM + 1;
 105
 106 #define GET_MALLOC_STACK_TRACE                                            \
 107   BufferedStackTrace stack;                                               \
 108   if (hwasan_inited)                                                       \
 109   GetStackTrace(&stack, common_flags()->malloc_context_size,              \
 110                 StackTrace::GetCurrentPc(), GET_CURRENT_FRAME(), nullptr, \
 111                 common_flags()->fast_unwind_on_malloc)
 112
 113 #define GET_FATAL_STACK_TRACE_PC_BP(pc, bp)              \
 114   BufferedStackTrace stack;                              \
 115   if (hwasan_inited)                                       \
 116   GetStackTrace(&stack, kStackTraceMax, pc, bp, nullptr, \
 117                 common_flags()->fast_unwind_on_fatal)
 118
 119 #define GET_FATAL_STACK_TRACE_HERE \
 120   GET_FATAL_STACK_TRACE_PC_BP(StackTrace::GetCurrentPc(), GET_CURRENT_FRAME())
 121
 122 #define PRINT_CURRENT_STACK_CHECK() \
 123   {                                 \
 124     GET_FATAL_STACK_TRACE_HERE;     \
 125     stack.Print();                  \
 126   }
 127
 128 class ScopedThreadLocalStateBackup {
 129  public:
 130   ScopedThreadLocalStateBackup() { Backup(); }
 131   ~ScopedThreadLocalStateBackup() { Restore(); }
 132   void Backup();
 133   void Restore();
 134  private:
 135   u64 va_arg_overflow_size_tls;
 136 };
 137
 138 void HwasanTSDInit(void (*destructor)(void *tsd));
 139 void *HwasanTSDGet();
 140 void HwasanTSDSet(void *tsd);
 141 void HwasanTSDDtor(void *tsd);
 142
 143 void HwasanOnDeadlySignal(int signo, void *info, void *context);
 144
 145 }  // namespace __hwasan
 146
 147 #define HWASAN_MALLOC_HOOK(ptr, size)       \
 148   do {                                    \
 149     if (&__sanitizer_malloc_hook) {       \
 150       __sanitizer_malloc_hook(ptr, size); \
 151     }                                     \
 152     RunMallocHooks(ptr, size);            \
 153   } while (false)
 154 #define HWASAN_FREE_HOOK(ptr)       \
 155   do {                            \
 156     if (&__sanitizer_free_hook) { \
 157       __sanitizer_free_hook(ptr); \
 158     }                             \
 159     RunFreeHooks(ptr);            \
 160   } while (false)
 161
 162 #endif  // HWASAN_H