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_WORDSIZE == 32 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_rtl.cc 66 void NORETURN ShowStatsAndAbort(); 67 68 // asan_malloc_linux.cc / asan_malloc_mac.cc 69 void ReplaceSystemMalloc(); 70 71 // asan_linux.cc / asan_mac.cc / asan_win.cc 72 void *AsanDoesNotSupportStaticLinkage(); 73 void AsanCheckDynamicRTPrereqs(); 74 void AsanCheckIncompatibleRT(); 75 76 void AsanOnDeadlySignal(int, void *siginfo, void *context); 77 78 void ReadContextStack(void *context, uptr *stack, uptr *ssize); 79 void StopInitOrderChecking(); 80 81 // Wrapper for TLS/TSD. 82 void AsanTSDInit(void (*destructor)(void *tsd)); 83 void *AsanTSDGet(); 84 void AsanTSDSet(void *tsd); 85 void PlatformTSDDtor(void *tsd); 86 87 void AppendToErrorMessageBuffer(const char *buffer); 88 89 void *AsanDlSymNext(const char *sym); 90 91 void ReserveShadowMemoryRange(uptr beg, uptr end, const char *name); 92 93 // Platform-specific options. 94 #if SANITIZER_MAC 95 bool PlatformHasDifferentMemcpyAndMemmove(); 96 # define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE \ 97 (PlatformHasDifferentMemcpyAndMemmove()) 98 #else 99 # define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE true 100 #endif // SANITIZER_MAC 101 102 // Add convenient macro for interface functions that may be represented as 103 // weak hooks. 104 #define ASAN_MALLOC_HOOK(ptr, size) \ 105 if (&__sanitizer_malloc_hook) __sanitizer_malloc_hook(ptr, size) 106 #define ASAN_FREE_HOOK(ptr) \ 107 if (&__sanitizer_free_hook) __sanitizer_free_hook(ptr) 108 #define ASAN_ON_ERROR() \ 109 if (&__asan_on_error) __asan_on_error() 110 111 extern int asan_inited; 112 // Used to avoid infinite recursion in __asan_init(). 113 extern bool asan_init_is_running; 114 extern void (*death_callback)(void); 115 116 // These magic values are written to shadow for better error reporting. 117 const int kAsanHeapLeftRedzoneMagic = 0xfa; 118 const int kAsanHeapRightRedzoneMagic = 0xfb; 119 const int kAsanHeapFreeMagic = 0xfd; 120 const int kAsanStackLeftRedzoneMagic = 0xf1; 121 const int kAsanStackMidRedzoneMagic = 0xf2; 122 const int kAsanStackRightRedzoneMagic = 0xf3; 123 const int kAsanStackPartialRedzoneMagic = 0xf4; 124 const int kAsanStackAfterReturnMagic = 0xf5; 125 const int kAsanInitializationOrderMagic = 0xf6; 126 const int kAsanUserPoisonedMemoryMagic = 0xf7; 127 const int kAsanContiguousContainerOOBMagic = 0xfc; 128 const int kAsanStackUseAfterScopeMagic = 0xf8; 129 const int kAsanGlobalRedzoneMagic = 0xf9; 130 const int kAsanInternalHeapMagic = 0xfe; 131 const int kAsanArrayCookieMagic = 0xac; 132 const int kAsanIntraObjectRedzone = 0xbb; 133 const int kAsanAllocaLeftMagic = 0xca; 134 const int kAsanAllocaRightMagic = 0xcb; 135 136 static const uptr kCurrentStackFrameMagic = 0x41B58AB3; 137 static const uptr kRetiredStackFrameMagic = 0x45E0360E; 138 139 } // namespace __asan 140 141 #endif // ASAN_INTERNAL_H 142
