asan_internal.h revision cffe2f5c30c27234260d004b54152916ff0c45c6
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(); 125const char *AsanGetEnv(const char *name); 126void AsanDumpProcessMap(); 127 128void *AsanMmapFixedNoReserve(uptr fixed_addr, uptr size); 129void *AsanMmapFixedReserve(uptr fixed_addr, uptr size); 130void *AsanMprotect(uptr fixed_addr, uptr size); 131 132void AsanDisableCoreDumper(); 133void GetPcSpBp(void *context, uptr *pc, uptr *sp, uptr *bp); 134 135bool AsanInterceptsSignal(int signum); 136void SetAlternateSignalStack(); 137void UnsetAlternateSignalStack(); 138void InstallSignalHandlers(); 139uptr GetThreadSelf(); 140int AtomicInc(int *a); 141u16 AtomicExchange(u16 *a, u16 new_val); 142u8 AtomicExchange(u8 *a, u8 new_val); 143 144// Wrapper for TLS/TSD. 145void AsanTSDInit(void (*destructor)(void *tsd)); 146void *AsanTSDGet(); 147void AsanTSDSet(void *tsd); 148 149void AppendToErrorMessageBuffer(const char *buffer); 150// asan_printf.cc 151void AsanPrintf(const char *format, ...); 152void AsanReport(const char *format, ...); 153 154// Don't use std::min and std::max, to minimize dependency on libstdc++. 155template<class T> T Min(T a, T b) { return a < b ? a : b; } 156template<class T> T Max(T a, T b) { return a > b ? a : b; } 157 158void SortArray(uptr *array, uptr size); 159 160// asan_poisoning.cc 161// Poisons the shadow memory for "size" bytes starting from "addr". 162void PoisonShadow(uptr addr, uptr size, u8 value); 163// Poisons the shadow memory for "redzone_size" bytes starting from 164// "addr + size". 165void PoisonShadowPartialRightRedzone(uptr addr, 166 uptr size, 167 uptr redzone_size, 168 u8 value); 169 170// Platfrom-specific options. 171#ifdef __APPLE__ 172bool PlatformHasDifferentMemcpyAndMemmove(); 173# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE \ 174 (PlatformHasDifferentMemcpyAndMemmove()) 175#else 176# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE true 177#endif // __APPLE__ 178 179extern uptr FLAG_quarantine_size; 180extern s64 FLAG_demangle; 181extern bool FLAG_symbolize; 182extern s64 FLAG_v; 183extern uptr FLAG_redzone; 184extern s64 FLAG_debug; 185extern bool FLAG_poison_shadow; 186extern s64 FLAG_report_globals; 187extern uptr FLAG_malloc_context_size; 188extern bool FLAG_replace_str; 189extern bool FLAG_replace_intrin; 190extern bool FLAG_replace_cfallocator; 191extern bool FLAG_fast_unwind; 192extern bool FLAG_use_fake_stack; 193extern uptr FLAG_max_malloc_fill_size; 194extern s64 FLAG_exitcode; 195extern bool FLAG_allow_user_poisoning; 196extern s64 FLAG_sleep_before_dying; 197extern bool FLAG_handle_segv; 198extern bool FLAG_use_sigaltstack; 199extern bool FLAG_check_malloc_usable_size; 200extern bool FLAG_unmap_shadow_on_exit; 201extern bool FLAG_abort_on_error; 202 203extern int asan_inited; 204// Used to avoid infinite recursion in __asan_init(). 205extern bool asan_init_is_running; 206extern void (*death_callback)(void); 207 208enum LinkerInitialized { LINKER_INITIALIZED = 0 }; 209 210void SleepForSeconds(int seconds); 211void NORETURN Exit(int exitcode); 212void NORETURN Abort(); 213int Atexit(void (*function)(void)); 214 215#define ASAN_ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0])) 216 217#if !defined(_WIN32) || defined(__clang__) 218# define GET_CALLER_PC() (uptr)__builtin_return_address(0) 219# define GET_CURRENT_FRAME() (uptr)__builtin_frame_address(0) 220#else 221# define GET_CALLER_PC() (uptr)_ReturnAddress() 222// CaptureStackBackTrace doesn't need to know BP on Windows. 223// FIXME: This macro is still used when printing error reports though it's not 224// clear if the BP value is needed in the ASan reports on Windows. 225# define GET_CURRENT_FRAME() (uptr)0xDEADBEEF 226#endif 227 228#ifndef _WIN32 229const uptr kMmapGranularity = kPageSize; 230# define THREAD_CALLING_CONV 231typedef void* thread_return_t; 232#else 233const uptr kMmapGranularity = 1UL << 16; 234# define THREAD_CALLING_CONV __stdcall 235typedef DWORD thread_return_t; 236 237# ifndef ASAN_USE_EXTERNAL_SYMBOLIZER 238# define ASAN_USE_EXTERNAL_SYMBOLIZER __asan_WinSymbolize 239bool __asan_WinSymbolize(const void *addr, char *out_buffer, int buffer_size); 240# endif 241#endif 242 243typedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg); 244 245// These magic values are written to shadow for better error reporting. 246const int kAsanHeapLeftRedzoneMagic = 0xfa; 247const int kAsanHeapRightRedzoneMagic = 0xfb; 248const int kAsanHeapFreeMagic = 0xfd; 249const int kAsanStackLeftRedzoneMagic = 0xf1; 250const int kAsanStackMidRedzoneMagic = 0xf2; 251const int kAsanStackRightRedzoneMagic = 0xf3; 252const int kAsanStackPartialRedzoneMagic = 0xf4; 253const int kAsanStackAfterReturnMagic = 0xf5; 254const int kAsanUserPoisonedMemoryMagic = 0xf7; 255const int kAsanGlobalRedzoneMagic = 0xf9; 256const int kAsanInternalHeapMagic = 0xfe; 257 258static const uptr kCurrentStackFrameMagic = 0x41B58AB3; 259static const uptr kRetiredStackFrameMagic = 0x45E0360E; 260 261// -------------------------- LowLevelAllocator ----- {{{1 262// A simple low-level memory allocator for internal use. 263class LowLevelAllocator { 264 public: 265 explicit LowLevelAllocator(LinkerInitialized) {} 266 // 'size' must be a power of two. 267 // Requires an external lock. 268 void *Allocate(uptr size); 269 private: 270 char *allocated_end_; 271 char *allocated_current_; 272}; 273 274} // namespace __asan 275 276#endif // ASAN_INTERNAL_H 277