contrib/compiler-rt/lib/asan/asan_internal.h

   1 //===-- asan_internal.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 AddressSanitizer, an address sanity checker.
  11 //
  12 // ASan-private header which defines various general utilities.
  13 //===----------------------------------------------------------------------===//
  14 #ifndef ASAN_INTERNAL_H
  15 #define ASAN_INTERNAL_H
  16
  17 #include "asan_flags.h"
  18 #include "asan_interface_internal.h"
  19 #include "sanitizer_common/sanitizer_common.h"
  20 #include "sanitizer_common/sanitizer_internal_defs.h"
  21 #include "sanitizer_common/sanitizer_stacktrace.h"
  22 #include "sanitizer_common/sanitizer_libc.h"
  23
  24 #if __has_feature(address_sanitizer) || defined(__SANITIZE_ADDRESS__)
  25 # error "The AddressSanitizer run-time should not be"
  26         " instrumented by AddressSanitizer"
  27 #endif
  28
  29 // Build-time configuration options.
  30
  31 // If set, asan will intercept C++ exception api call(s).
  32 #ifndef ASAN_HAS_EXCEPTIONS
  33 # define ASAN_HAS_EXCEPTIONS 1
  34 #endif
  35
  36 // If set, values like allocator chunk size, as well as defaults for some flags
  37 // will be changed towards less memory overhead.
  38 #ifndef ASAN_LOW_MEMORY
  39 # if SANITIZER_IOS || SANITIZER_ANDROID || SANITIZER_RTEMS
  40 #  define ASAN_LOW_MEMORY 1
  41 # else
  42 #  define ASAN_LOW_MEMORY 0
  43 # endif
  44 #endif
  45
  46 #ifndef ASAN_DYNAMIC
  47 # ifdef PIC
  48 #  define ASAN_DYNAMIC 1
  49 # else
  50 #  define ASAN_DYNAMIC 0
  51 # endif
  52 #endif
  53
  54 // All internal functions in asan reside inside the __asan namespace
  55 // to avoid namespace collisions with the user programs.
  56 // Separate namespace also makes it simpler to distinguish the asan run-time
  57 // functions from the instrumented user code in a profile.
  58 namespace __asan {
  59
  60 class AsanThread;
  61 using __sanitizer::StackTrace;
  62
  63 void AsanInitFromRtl();
  64
  65 // asan_win.cc
  66 void InitializePlatformExceptionHandlers();
  67 // Returns whether an address is a valid allocated system heap block.
  68 // 'addr' must point to the beginning of the block.
  69 bool IsSystemHeapAddress(uptr addr);
  70
  71 // asan_rtl.cc
  72 void PrintAddressSpaceLayout();
  73 void NORETURN ShowStatsAndAbort();
  74
  75 // asan_shadow_setup.cc
  76 void InitializeShadowMemory();
  77
  78 // asan_malloc_linux.cc / asan_malloc_mac.cc
  79 void ReplaceSystemMalloc();
  80
  81 // asan_linux.cc / asan_mac.cc / asan_rtems.cc / asan_win.cc
  82 uptr FindDynamicShadowStart();
  83 void *AsanDoesNotSupportStaticLinkage();
  84 void AsanCheckDynamicRTPrereqs();
  85 void AsanCheckIncompatibleRT();
  86
  87 // asan_thread.cc
  88 AsanThread *CreateMainThread();
  89
  90 // Support function for __asan_(un)register_image_globals. Searches for the
  91 // loaded image containing `needle' and then enumerates all global metadata
  92 // structures declared in that image, applying `op' (e.g.,
  93 // __asan_(un)register_globals) to them.
  94 typedef void (*globals_op_fptr)(__asan_global *, uptr);
  95 void AsanApplyToGlobals(globals_op_fptr op, const void *needle);
  96
  97 void AsanOnDeadlySignal(int, void *siginfo, void *context);
  98
  99 void ReadContextStack(void *context, uptr *stack, uptr *ssize);
 100 void StopInitOrderChecking();
 101
 102 // Wrapper for TLS/TSD.
 103 void AsanTSDInit(void (*destructor)(void *tsd));
 104 void *AsanTSDGet();
 105 void AsanTSDSet(void *tsd);
 106 void PlatformTSDDtor(void *tsd);
 107
 108 void AppendToErrorMessageBuffer(const char *buffer);
 109
 110 void *AsanDlSymNext(const char *sym);
 111
 112 void ReserveShadowMemoryRange(uptr beg, uptr end, const char *name);
 113
 114 // Add convenient macro for interface functions that may be represented as
 115 // weak hooks.
 116 #define ASAN_MALLOC_HOOK(ptr, size)                                   \
 117   do {                                                                \
 118     if (&__sanitizer_malloc_hook) __sanitizer_malloc_hook(ptr, size); \
 119     RunMallocHooks(ptr, size);                                        \
 120   } while (false)
 121 #define ASAN_FREE_HOOK(ptr)                                 \
 122   do {                                                      \
 123     if (&__sanitizer_free_hook) __sanitizer_free_hook(ptr); \
 124     RunFreeHooks(ptr);                                      \
 125   } while (false)
 126 #define ASAN_ON_ERROR() \
 127   if (&__asan_on_error) __asan_on_error()
 128
 129 extern int asan_inited;
 130 // Used to avoid infinite recursion in __asan_init().
 131 extern bool asan_init_is_running;
 132 extern void (*death_callback)(void);
 133 // These magic values are written to shadow for better error reporting.
 134 const int kAsanHeapLeftRedzoneMagic = 0xfa;
 135 const int kAsanHeapFreeMagic = 0xfd;
 136 const int kAsanStackLeftRedzoneMagic = 0xf1;
 137 const int kAsanStackMidRedzoneMagic = 0xf2;
 138 const int kAsanStackRightRedzoneMagic = 0xf3;
 139 const int kAsanStackAfterReturnMagic = 0xf5;
 140 const int kAsanInitializationOrderMagic = 0xf6;
 141 const int kAsanUserPoisonedMemoryMagic = 0xf7;
 142 const int kAsanContiguousContainerOOBMagic = 0xfc;
 143 const int kAsanStackUseAfterScopeMagic = 0xf8;
 144 const int kAsanGlobalRedzoneMagic = 0xf9;
 145 const int kAsanInternalHeapMagic = 0xfe;
 146 const int kAsanArrayCookieMagic = 0xac;
 147 const int kAsanIntraObjectRedzone = 0xbb;
 148 const int kAsanAllocaLeftMagic = 0xca;
 149 const int kAsanAllocaRightMagic = 0xcb;
 150 // Used to populate the shadow gap for systems without memory
 151 // protection there (i.e. Myriad).
 152 const int kAsanShadowGap = 0xcc;
 153
 154 static const uptr kCurrentStackFrameMagic = 0x41B58AB3;
 155 static const uptr kRetiredStackFrameMagic = 0x45E0360E;
 156
 157 }  // namespace __asan
 158
 159 #endif  // ASAN_INTERNAL_H