asan_internal.h revision f607fc1c67a613a59a1db3c80c5d1322e1978102
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 "sanitizer_common/sanitizer_common.h" 18#include "sanitizer_common/sanitizer_internal_defs.h" 19#include "sanitizer_common/sanitizer_libc.h" 20 21#if !defined(__linux__) && !defined(__APPLE__) && !defined(_WIN32) 22# error "This operating system is not supported by AddressSanitizer" 23#endif 24 25#if defined(_WIN32) 26extern "C" void* _ReturnAddress(void); 27# pragma intrinsic(_ReturnAddress) 28#endif // defined(_WIN32) 29 30// Limits for integral types. We have to redefine it in case we don't 31// have stdint.h (like in Visual Studio 9). 32#if __WORDSIZE == 64 33# define __INT64_C(c) c ## L 34# define __UINT64_C(c) c ## UL 35#else 36# define __INT64_C(c) c ## LL 37# define __UINT64_C(c) c ## ULL 38#endif // __WORDSIZE == 64 39#undef INT32_MIN 40#define INT32_MIN (-2147483647-1) 41#undef INT32_MAX 42#define INT32_MAX (2147483647) 43#undef UINT32_MAX 44#define UINT32_MAX (4294967295U) 45#undef INT64_MIN 46#define INT64_MIN (-__INT64_C(9223372036854775807)-1) 47#undef INT64_MAX 48#define INT64_MAX (__INT64_C(9223372036854775807)) 49#undef UINT64_MAX 50#define UINT64_MAX (__UINT64_C(18446744073709551615)) 51 52#define ASAN_DEFAULT_FAILURE_EXITCODE 1 53 54#if defined(__linux__) 55# define ASAN_LINUX 1 56#else 57# define ASAN_LINUX 0 58#endif 59 60#if defined(__APPLE__) 61# define ASAN_MAC 1 62#else 63# define ASAN_MAC 0 64#endif 65 66#if defined(_WIN32) 67# define ASAN_WINDOWS 1 68#else 69# define ASAN_WINDOWS 0 70#endif 71 72#define ASAN_POSIX (ASAN_LINUX || ASAN_MAC) 73 74#if __has_feature(address_sanitizer) 75# error "The AddressSanitizer run-time should not be" 76 " instrumented by AddressSanitizer" 77#endif 78 79// Build-time configuration options. 80 81// If set, asan will install its own SEGV signal handler. 82#ifndef ASAN_NEEDS_SEGV 83# define ASAN_NEEDS_SEGV 1 84#endif 85 86// If set, asan will intercept C++ exception api call(s). 87#ifndef ASAN_HAS_EXCEPTIONS 88# define ASAN_HAS_EXCEPTIONS 1 89#endif 90 91// If set, asan uses the values of SHADOW_SCALE and SHADOW_OFFSET 92// provided by the instrumented objects. Otherwise constants are used. 93#ifndef ASAN_FLEXIBLE_MAPPING_AND_OFFSET 94# define ASAN_FLEXIBLE_MAPPING_AND_OFFSET 0 95#endif 96 97// If set, values like allocator chunk size, as well as defaults for some flags 98// will be changed towards less memory overhead. 99#ifndef ASAN_LOW_MEMORY 100# define ASAN_LOW_MEMORY 0 101#endif 102 103// All internal functions in asan reside inside the __asan namespace 104// to avoid namespace collisions with the user programs. 105// Seperate namespace also makes it simpler to distinguish the asan run-time 106// functions from the instrumented user code in a profile. 107namespace __asan { 108 109class AsanThread; 110struct AsanStackTrace; 111 112// asan_rtl.cc 113void NORETURN ShowStatsAndAbort(); 114 115// asan_globals.cc 116bool DescribeAddrIfGlobal(uptr addr); 117 118void ReplaceOperatorsNewAndDelete(); 119// asan_malloc_linux.cc / asan_malloc_mac.cc 120void ReplaceSystemMalloc(); 121 122// asan_linux.cc / asan_mac.cc / asan_win.cc 123void *AsanDoesNotSupportStaticLinkage(); 124bool AsanShadowRangeIsAvailable(); 125void AsanDumpProcessMap(); 126 127void AsanDisableCoreDumper(); 128void GetPcSpBp(void *context, uptr *pc, uptr *sp, uptr *bp); 129 130bool AsanInterceptsSignal(int signum); 131void SetAlternateSignalStack(); 132void UnsetAlternateSignalStack(); 133void InstallSignalHandlers(); 134uptr GetThreadSelf(); 135int AtomicInc(int *a); 136u16 AtomicExchange(u16 *a, u16 new_val); 137u8 AtomicExchange(u8 *a, u8 new_val); 138 139// Wrapper for TLS/TSD. 140void AsanTSDInit(void (*destructor)(void *tsd)); 141void *AsanTSDGet(); 142void AsanTSDSet(void *tsd); 143 144void AppendToErrorMessageBuffer(const char *buffer); 145// asan_printf.cc 146void AsanPrintf(const char *format, ...); 147void AsanReport(const char *format, ...); 148 149// Don't use std::min and std::max, to minimize dependency on libstdc++. 150template<class T> T Min(T a, T b) { return a < b ? a : b; } 151template<class T> T Max(T a, T b) { return a > b ? a : b; } 152 153void SortArray(uptr *array, uptr size); 154 155// asan_poisoning.cc 156// Poisons the shadow memory for "size" bytes starting from "addr". 157void PoisonShadow(uptr addr, uptr size, u8 value); 158// Poisons the shadow memory for "redzone_size" bytes starting from 159// "addr + size". 160void PoisonShadowPartialRightRedzone(uptr addr, 161 uptr size, 162 uptr redzone_size, 163 u8 value); 164 165// Platfrom-specific options. 166#ifdef __APPLE__ 167bool PlatformHasDifferentMemcpyAndMemmove(); 168# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE \ 169 (PlatformHasDifferentMemcpyAndMemmove()) 170#else 171# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE true 172#endif // __APPLE__ 173 174extern uptr FLAG_quarantine_size; 175extern s64 FLAG_demangle; 176extern bool FLAG_symbolize; 177extern s64 FLAG_v; 178extern uptr FLAG_redzone; 179extern s64 FLAG_debug; 180extern bool FLAG_poison_shadow; 181extern s64 FLAG_report_globals; 182extern uptr FLAG_malloc_context_size; 183extern bool FLAG_replace_str; 184extern bool FLAG_replace_intrin; 185extern bool FLAG_replace_cfallocator; 186extern bool FLAG_fast_unwind; 187extern bool FLAG_use_fake_stack; 188extern uptr FLAG_max_malloc_fill_size; 189extern s64 FLAG_exitcode; 190extern bool FLAG_allow_user_poisoning; 191extern s64 FLAG_sleep_before_dying; 192extern bool FLAG_handle_segv; 193extern bool FLAG_use_sigaltstack; 194extern bool FLAG_check_malloc_usable_size; 195extern bool FLAG_unmap_shadow_on_exit; 196extern bool FLAG_abort_on_error; 197 198extern int asan_inited; 199// Used to avoid infinite recursion in __asan_init(). 200extern bool asan_init_is_running; 201extern void (*death_callback)(void); 202 203enum LinkerInitialized { LINKER_INITIALIZED = 0 }; 204 205void SleepForSeconds(int seconds); 206void NORETURN Exit(int exitcode); 207void NORETURN Abort(); 208int Atexit(void (*function)(void)); 209 210#define ASAN_ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0])) 211 212#if !defined(_WIN32) || defined(__clang__) 213# define GET_CALLER_PC() (uptr)__builtin_return_address(0) 214# define GET_CURRENT_FRAME() (uptr)__builtin_frame_address(0) 215#else 216# define GET_CALLER_PC() (uptr)_ReturnAddress() 217// CaptureStackBackTrace doesn't need to know BP on Windows. 218// FIXME: This macro is still used when printing error reports though it's not 219// clear if the BP value is needed in the ASan reports on Windows. 220# define GET_CURRENT_FRAME() (uptr)0xDEADBEEF 221#endif 222 223#ifndef _WIN32 224const uptr kMmapGranularity = kPageSize; 225# define THREAD_CALLING_CONV 226typedef void* thread_return_t; 227#else 228const uptr kMmapGranularity = 1UL << 16; 229# define THREAD_CALLING_CONV __stdcall 230typedef DWORD thread_return_t; 231 232# ifndef ASAN_USE_EXTERNAL_SYMBOLIZER 233# define ASAN_USE_EXTERNAL_SYMBOLIZER __asan_WinSymbolize 234bool __asan_WinSymbolize(const void *addr, char *out_buffer, int buffer_size); 235# endif 236#endif 237 238typedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg); 239 240// These magic values are written to shadow for better error reporting. 241const int kAsanHeapLeftRedzoneMagic = 0xfa; 242const int kAsanHeapRightRedzoneMagic = 0xfb; 243const int kAsanHeapFreeMagic = 0xfd; 244const int kAsanStackLeftRedzoneMagic = 0xf1; 245const int kAsanStackMidRedzoneMagic = 0xf2; 246const int kAsanStackRightRedzoneMagic = 0xf3; 247const int kAsanStackPartialRedzoneMagic = 0xf4; 248const int kAsanStackAfterReturnMagic = 0xf5; 249const int kAsanUserPoisonedMemoryMagic = 0xf7; 250const int kAsanGlobalRedzoneMagic = 0xf9; 251const int kAsanInternalHeapMagic = 0xfe; 252 253static const uptr kCurrentStackFrameMagic = 0x41B58AB3; 254static const uptr kRetiredStackFrameMagic = 0x45E0360E; 255 256// -------------------------- LowLevelAllocator ----- {{{1 257// A simple low-level memory allocator for internal use. 258class LowLevelAllocator { 259 public: 260 explicit LowLevelAllocator(LinkerInitialized) {} 261 // 'size' must be a power of two. 262 // Requires an external lock. 263 void *Allocate(uptr size); 264 private: 265 char *allocated_end_; 266 char *allocated_current_; 267}; 268 269} // namespace __asan 270 271#endif // ASAN_INTERNAL_H 272