asan_internal.h revision 7ed1d2b699767dd1875994cb625d51a95b44221a
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 "sanitizer_common/sanitizer_common.h" 19#include "sanitizer_common/sanitizer_internal_defs.h" 20#include "sanitizer_common/sanitizer_libc.h" 21 22#if !defined(__linux__) && !defined(__APPLE__) && !defined(_WIN32) 23# error "This operating system is not supported by AddressSanitizer" 24#endif 25 26#if defined(_WIN32) 27extern "C" void* _ReturnAddress(void); 28# pragma intrinsic(_ReturnAddress) 29#endif // defined(_WIN32) 30 31#define ASAN_DEFAULT_FAILURE_EXITCODE 1 32 33#if defined(__linux__) 34# define ASAN_LINUX 1 35#else 36# define ASAN_LINUX 0 37#endif 38 39#if defined(__APPLE__) 40# define ASAN_MAC 1 41#else 42# define ASAN_MAC 0 43#endif 44 45#if defined(_WIN32) 46# define ASAN_WINDOWS 1 47#else 48# define ASAN_WINDOWS 0 49#endif 50 51#define ASAN_POSIX (ASAN_LINUX || ASAN_MAC) 52 53#if __has_feature(address_sanitizer) 54# error "The AddressSanitizer run-time should not be" 55 " instrumented by AddressSanitizer" 56#endif 57 58// Build-time configuration options. 59 60// If set, asan will install its own SEGV signal handler. 61#ifndef ASAN_NEEDS_SEGV 62# define ASAN_NEEDS_SEGV 1 63#endif 64 65// If set, asan will intercept C++ exception api call(s). 66#ifndef ASAN_HAS_EXCEPTIONS 67# define ASAN_HAS_EXCEPTIONS 1 68#endif 69 70// If set, asan uses the values of SHADOW_SCALE and SHADOW_OFFSET 71// provided by the instrumented objects. Otherwise constants are used. 72#ifndef ASAN_FLEXIBLE_MAPPING_AND_OFFSET 73# define ASAN_FLEXIBLE_MAPPING_AND_OFFSET 0 74#endif 75 76// If set, values like allocator chunk size, as well as defaults for some flags 77// will be changed towards less memory overhead. 78#ifndef ASAN_LOW_MEMORY 79# define ASAN_LOW_MEMORY 0 80#endif 81 82// All internal functions in asan reside inside the __asan namespace 83// to avoid namespace collisions with the user programs. 84// Seperate namespace also makes it simpler to distinguish the asan run-time 85// functions from the instrumented user code in a profile. 86namespace __asan { 87 88class AsanThread; 89struct AsanStackTrace; 90 91// asan_rtl.cc 92void NORETURN ShowStatsAndAbort(); 93 94// asan_globals.cc 95bool DescribeAddrIfGlobal(uptr addr); 96 97void ReplaceOperatorsNewAndDelete(); 98// asan_malloc_linux.cc / asan_malloc_mac.cc 99void ReplaceSystemMalloc(); 100 101// asan_linux.cc / asan_mac.cc / asan_win.cc 102void *AsanDoesNotSupportStaticLinkage(); 103 104void GetPcSpBp(void *context, uptr *pc, uptr *sp, uptr *bp); 105 106bool AsanInterceptsSignal(int signum); 107void SetAlternateSignalStack(); 108void UnsetAlternateSignalStack(); 109void InstallSignalHandlers(); 110 111// Wrapper for TLS/TSD. 112void AsanTSDInit(void (*destructor)(void *tsd)); 113void *AsanTSDGet(); 114void AsanTSDSet(void *tsd); 115 116void AppendToErrorMessageBuffer(const char *buffer); 117// asan_printf.cc 118void AsanPrintf(const char *format, ...); 119void AsanReport(const char *format, ...); 120 121// asan_poisoning.cc 122// Poisons the shadow memory for "size" bytes starting from "addr". 123void PoisonShadow(uptr addr, uptr size, u8 value); 124// Poisons the shadow memory for "redzone_size" bytes starting from 125// "addr + size". 126void PoisonShadowPartialRightRedzone(uptr addr, 127 uptr size, 128 uptr redzone_size, 129 u8 value); 130 131// Platfrom-specific options. 132#ifdef __APPLE__ 133bool PlatformHasDifferentMemcpyAndMemmove(); 134# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE \ 135 (PlatformHasDifferentMemcpyAndMemmove()) 136#else 137# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE true 138#endif // __APPLE__ 139 140extern int asan_inited; 141// Used to avoid infinite recursion in __asan_init(). 142extern bool asan_init_is_running; 143extern void (*death_callback)(void); 144 145enum LinkerInitialized { LINKER_INITIALIZED = 0 }; 146 147#define ASAN_ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0])) 148 149#if !defined(_WIN32) || defined(__clang__) 150# define GET_CALLER_PC() (uptr)__builtin_return_address(0) 151# define GET_CURRENT_FRAME() (uptr)__builtin_frame_address(0) 152#else 153# define GET_CALLER_PC() (uptr)_ReturnAddress() 154// CaptureStackBackTrace doesn't need to know BP on Windows. 155// FIXME: This macro is still used when printing error reports though it's not 156// clear if the BP value is needed in the ASan reports on Windows. 157# define GET_CURRENT_FRAME() (uptr)0xDEADBEEF 158#endif 159 160#ifdef _WIN32 161# ifndef ASAN_USE_EXTERNAL_SYMBOLIZER 162# define ASAN_USE_EXTERNAL_SYMBOLIZER __asan_WinSymbolize 163bool __asan_WinSymbolize(const void *addr, char *out_buffer, int buffer_size); 164# endif 165#endif // _WIN32 166 167// These magic values are written to shadow for better error reporting. 168const int kAsanHeapLeftRedzoneMagic = 0xfa; 169const int kAsanHeapRightRedzoneMagic = 0xfb; 170const int kAsanHeapFreeMagic = 0xfd; 171const int kAsanStackLeftRedzoneMagic = 0xf1; 172const int kAsanStackMidRedzoneMagic = 0xf2; 173const int kAsanStackRightRedzoneMagic = 0xf3; 174const int kAsanStackPartialRedzoneMagic = 0xf4; 175const int kAsanStackAfterReturnMagic = 0xf5; 176const int kAsanUserPoisonedMemoryMagic = 0xf7; 177const int kAsanGlobalRedzoneMagic = 0xf9; 178const int kAsanInternalHeapMagic = 0xfe; 179 180static const uptr kCurrentStackFrameMagic = 0x41B58AB3; 181static const uptr kRetiredStackFrameMagic = 0x45E0360E; 182 183// -------------------------- LowLevelAllocator ----- {{{1 184// A simple low-level memory allocator for internal use. 185class LowLevelAllocator { 186 public: 187 explicit LowLevelAllocator(LinkerInitialized) {} 188 // 'size' must be a power of two. 189 // Requires an external lock. 190 void *Allocate(uptr size); 191 private: 192 char *allocated_end_; 193 char *allocated_current_; 194}; 195 196} // namespace __asan 197 198#endif // ASAN_INTERNAL_H 199