asan_internal.h revision 9712af9ce7f5efc14cb11af2599fd065e7b7a3dd
11510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org//===-- asan_internal.h -----------------------------------------*- C++ -*-===// 21510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// 31510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// The LLVM Compiler Infrastructure 41510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// 51510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// This file is distributed under the University of Illinois Open Source 61510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// License. See LICENSE.TXT for details. 71510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// 81510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org//===----------------------------------------------------------------------===// 91510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// 101510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// This file is a part of AddressSanitizer, an address sanity checker. 111510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// 121510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// ASan-private header which defines various general utilities. 131510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org//===----------------------------------------------------------------------===// 141510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#ifndef ASAN_INTERNAL_H 151510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#define ASAN_INTERNAL_H 161510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 171510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#include "asan_flags.h" 181510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#include "sanitizer_common/sanitizer_common.h" 191510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#include "sanitizer_common/sanitizer_internal_defs.h" 201510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#include "sanitizer_common/sanitizer_stacktrace.h" 211510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#include "sanitizer_common/sanitizer_libc.h" 221510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 231510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#if !defined(__linux__) && !defined(__APPLE__) && !defined(_WIN32) 241510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# error "This operating system is not supported by AddressSanitizer" 251510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#endif 261510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 271510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#define ASAN_DEFAULT_FAILURE_EXITCODE 1 281510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 291510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#if defined(__linux__) 301510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# define ASAN_LINUX 1 311510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#else 321510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# define ASAN_LINUX 0 331510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#endif 341510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 351510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#if defined(__APPLE__) 361510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# define ASAN_MAC 1 371510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#else 381510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# define ASAN_MAC 0 391510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#endif 401510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 411510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#if defined(_WIN32) 421510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# define ASAN_WINDOWS 1 431510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#else 441510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# define ASAN_WINDOWS 0 451510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#endif 461510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 471510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#if defined(__ANDROID__) || defined(ANDROID) 481510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# define ASAN_ANDROID 1 491510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#else 501510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# define ASAN_ANDROID 0 511510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#endif 521510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 531510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 541510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#define ASAN_POSIX (ASAN_LINUX || ASAN_MAC) 551510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 561510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#if __has_feature(address_sanitizer) 571510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# error "The AddressSanitizer run-time should not be" 581510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org " instrumented by AddressSanitizer" 591510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#endif 601510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 611510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// Build-time configuration options. 621510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 631510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// If set, asan will install its own SEGV signal handler. 641510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#ifndef ASAN_NEEDS_SEGV 651510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# ifdef ASAN_ANDROID 661510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# define ASAN_NEEDS_SEGV 0 671510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# else 681510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# define ASAN_NEEDS_SEGV 1 691510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# endif 701510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#endif 711510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 721510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// If set, asan will intercept C++ exception api call(s). 731510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#ifndef ASAN_HAS_EXCEPTIONS 741510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org# define ASAN_HAS_EXCEPTIONS 1 751510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org#endif 761510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org 771510d58cbcf57c82a10e7d390bfe21a7ae68ba43mstarzinger@chromium.org// If set, asan uses the values of SHADOW_SCALE and SHADOW_OFFSET 78// provided by the instrumented objects. Otherwise constants are used. 79#ifndef ASAN_FLEXIBLE_MAPPING_AND_OFFSET 80# define ASAN_FLEXIBLE_MAPPING_AND_OFFSET 0 81#endif 82 83// If set, values like allocator chunk size, as well as defaults for some flags 84// will be changed towards less memory overhead. 85#ifndef ASAN_LOW_MEMORY 86# ifdef ASAN_ANDROID 87# define ASAN_LOW_MEMORY 1 88# else 89# define ASAN_LOW_MEMORY 0 90# endif 91#endif 92 93// All internal functions in asan reside inside the __asan namespace 94// to avoid namespace collisions with the user programs. 95// Seperate namespace also makes it simpler to distinguish the asan run-time 96// functions from the instrumented user code in a profile. 97namespace __asan { 98 99class AsanThread; 100using __sanitizer::StackTrace; 101 102// asan_rtl.cc 103void NORETURN ShowStatsAndAbort(); 104 105void ReplaceOperatorsNewAndDelete(); 106// asan_malloc_linux.cc / asan_malloc_mac.cc 107void ReplaceSystemMalloc(); 108 109// asan_linux.cc / asan_mac.cc / asan_win.cc 110void *AsanDoesNotSupportStaticLinkage(); 111 112void GetPcSpBp(void *context, uptr *pc, uptr *sp, uptr *bp); 113 114void MaybeReexec(); 115bool AsanInterceptsSignal(int signum); 116void SetAlternateSignalStack(); 117void UnsetAlternateSignalStack(); 118void InstallSignalHandlers(); 119void AsanPlatformThreadInit(); 120 121// Wrapper for TLS/TSD. 122void AsanTSDInit(void (*destructor)(void *tsd)); 123void *AsanTSDGet(); 124void AsanTSDSet(void *tsd); 125 126void AppendToErrorMessageBuffer(const char *buffer); 127 128// asan_poisoning.cc 129// Poisons the shadow memory for "size" bytes starting from "addr". 130void PoisonShadow(uptr addr, uptr size, u8 value); 131// Poisons the shadow memory for "redzone_size" bytes starting from 132// "addr + size". 133void PoisonShadowPartialRightRedzone(uptr addr, 134 uptr size, 135 uptr redzone_size, 136 u8 value); 137 138// Platfrom-specific options. 139#ifdef __APPLE__ 140bool PlatformHasDifferentMemcpyAndMemmove(); 141# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE \ 142 (PlatformHasDifferentMemcpyAndMemmove()) 143#else 144# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE true 145#endif // __APPLE__ 146 147extern int asan_inited; 148// Used to avoid infinite recursion in __asan_init(). 149extern bool asan_init_is_running; 150extern void (*death_callback)(void); 151 152#ifdef _WIN32 153bool WinSymbolize(const void *addr, char *out_buffer, int buffer_size); 154#endif // _WIN32 155 156// These magic values are written to shadow for better error reporting. 157const int kAsanHeapLeftRedzoneMagic = 0xfa; 158const int kAsanHeapRightRedzoneMagic = 0xfb; 159const int kAsanHeapFreeMagic = 0xfd; 160const int kAsanStackLeftRedzoneMagic = 0xf1; 161const int kAsanStackMidRedzoneMagic = 0xf2; 162const int kAsanStackRightRedzoneMagic = 0xf3; 163const int kAsanStackPartialRedzoneMagic = 0xf4; 164const int kAsanStackAfterReturnMagic = 0xf5; 165const int kAsanInitializationOrderMagic = 0xf6; 166const int kAsanUserPoisonedMemoryMagic = 0xf7; 167const int kAsanGlobalRedzoneMagic = 0xf9; 168const int kAsanInternalHeapMagic = 0xfe; 169 170static const uptr kCurrentStackFrameMagic = 0x41B58AB3; 171static const uptr kRetiredStackFrameMagic = 0x45E0360E; 172 173} // namespace __asan 174 175#endif // ASAN_INTERNAL_H 176