asan_internal.h revision e86e35fbe861e73c5991200510a028877427b3e7
185a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org//===-- asan_internal.h -----------------------------------------*- C++ -*-===// 285a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org// 385a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org// The LLVM Compiler Infrastructure 485a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org// 585a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org// This file is distributed under the University of Illinois Open Source 685a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org// License. See LICENSE.TXT for details. 785a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org// 885a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org//===----------------------------------------------------------------------===// 985a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org// 1085a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org// This file is a part of AddressSanitizer, an address sanity checker. 1185a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org// 1285a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org// ASan-private header which defines various general utilities. 1385a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org//===----------------------------------------------------------------------===// 1485a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org#ifndef ASAN_INTERNAL_H 1585a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org#define ASAN_INTERNAL_H 1685a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org 1785a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org#include "asan_flags.h" 1885a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org#include "asan_interface_internal.h" 1985a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org#include "sanitizer_common/sanitizer_common.h" 2085a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org#include "sanitizer_common/sanitizer_internal_defs.h" 2185a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org#include "sanitizer_common/sanitizer_stacktrace.h" 2285a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org#include "sanitizer_common/sanitizer_libc.h" 2385a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org 2485a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org#define ASAN_DEFAULT_FAILURE_EXITCODE 1 2585a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org 2685a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org#if __has_feature(address_sanitizer) || defined(__SANITIZE_ADDRESS__) 2785a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org# error "The AddressSanitizer run-time should not be" 2885a1dab7adc4a795cf62ccf08d6727569db9e935sergeyu@chromium.org " instrumented by AddressSanitizer" 29#endif 30 31// Build-time configuration options. 32 33// If set, asan will install its own SEGV signal handler. 34#ifndef ASAN_NEEDS_SEGV 35# if SANITIZER_ANDROID == 1 36# define ASAN_NEEDS_SEGV 0 37# else 38# define ASAN_NEEDS_SEGV 1 39# endif 40#endif 41 42// If set, asan will intercept C++ exception api call(s). 43#ifndef ASAN_HAS_EXCEPTIONS 44# define ASAN_HAS_EXCEPTIONS 1 45#endif 46 47// If set, asan uses the values of SHADOW_SCALE and SHADOW_OFFSET 48// provided by the instrumented objects. Otherwise constants are used. 49#ifndef ASAN_FLEXIBLE_MAPPING_AND_OFFSET 50# define ASAN_FLEXIBLE_MAPPING_AND_OFFSET 0 51#endif 52 53// If set, values like allocator chunk size, as well as defaults for some flags 54// will be changed towards less memory overhead. 55#ifndef ASAN_LOW_MEMORY 56#if SANITIZER_WORDSIZE == 32 57# define ASAN_LOW_MEMORY 1 58#else 59# define ASAN_LOW_MEMORY 0 60# endif 61#endif 62 63#ifndef ASAN_USE_PREINIT_ARRAY 64# define ASAN_USE_PREINIT_ARRAY (SANITIZER_LINUX && !SANITIZER_ANDROID) 65#endif 66 67// All internal functions in asan reside inside the __asan namespace 68// to avoid namespace collisions with the user programs. 69// Seperate namespace also makes it simpler to distinguish the asan run-time 70// functions from the instrumented user code in a profile. 71namespace __asan { 72 73class AsanThread; 74using __sanitizer::StackTrace; 75 76// asan_rtl.cc 77void NORETURN ShowStatsAndAbort(); 78 79void ReplaceOperatorsNewAndDelete(); 80// asan_malloc_linux.cc / asan_malloc_mac.cc 81void ReplaceSystemMalloc(); 82 83// asan_linux.cc / asan_mac.cc / asan_win.cc 84void *AsanDoesNotSupportStaticLinkage(); 85 86void GetPcSpBp(void *context, uptr *pc, uptr *sp, uptr *bp); 87 88void MaybeReexec(); 89bool AsanInterceptsSignal(int signum); 90void SetAlternateSignalStack(); 91void UnsetAlternateSignalStack(); 92void InstallSignalHandlers(); 93void ReadContextStack(void *context, uptr *stack, uptr *ssize); 94void AsanPlatformThreadInit(); 95void StopInitOrderChecking(); 96 97// Wrapper for TLS/TSD. 98void AsanTSDInit(void (*destructor)(void *tsd)); 99void *AsanTSDGet(); 100void AsanTSDSet(void *tsd); 101void PlatformTSDDtor(void *tsd); 102 103void AppendToErrorMessageBuffer(const char *buffer); 104 105// Platfrom-specific options. 106#if SANITIZER_MAC 107bool PlatformHasDifferentMemcpyAndMemmove(); 108# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE \ 109 (PlatformHasDifferentMemcpyAndMemmove()) 110#else 111# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE true 112#endif // SANITIZER_MAC 113 114// Add convenient macro for interface functions that may be represented as 115// weak hooks. 116#define ASAN_MALLOC_HOOK(ptr, size) \ 117 if (&__asan_malloc_hook) __asan_malloc_hook(ptr, size) 118#define ASAN_FREE_HOOK(ptr) \ 119 if (&__asan_free_hook) __asan_free_hook(ptr) 120#define ASAN_ON_ERROR() \ 121 if (&__asan_on_error) __asan_on_error() 122 123extern int asan_inited; 124// Used to avoid infinite recursion in __asan_init(). 125extern bool asan_init_is_running; 126extern void (*death_callback)(void); 127 128// These magic values are written to shadow for better error reporting. 129const int kAsanHeapLeftRedzoneMagic = 0xfa; 130const int kAsanHeapRightRedzoneMagic = 0xfb; 131const int kAsanHeapFreeMagic = 0xfd; 132const int kAsanStackLeftRedzoneMagic = 0xf1; 133const int kAsanStackMidRedzoneMagic = 0xf2; 134const int kAsanStackRightRedzoneMagic = 0xf3; 135const int kAsanStackPartialRedzoneMagic = 0xf4; 136const int kAsanStackAfterReturnMagic = 0xf5; 137const int kAsanInitializationOrderMagic = 0xf6; 138const int kAsanUserPoisonedMemoryMagic = 0xf7; 139const int kAsanStackUseAfterScopeMagic = 0xf8; 140const int kAsanGlobalRedzoneMagic = 0xf9; 141const int kAsanInternalHeapMagic = 0xfe; 142 143static const uptr kCurrentStackFrameMagic = 0x41B58AB3; 144static const uptr kRetiredStackFrameMagic = 0x45E0360E; 145 146} // namespace __asan 147 148#endif // ASAN_INTERNAL_H 149