1//===-- asan_internal.h -----------------------------------------*- C++ -*-===// 2// 3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4// See https://llvm.org/LICENSE.txt for license information. 5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6// 7//===----------------------------------------------------------------------===// 8// 9// This file is a part of AddressSanitizer, an address sanity checker. 10// 11// ASan-private header which defines various general utilities. 12//===----------------------------------------------------------------------===// 13#ifndef ASAN_INTERNAL_H 14#define ASAN_INTERNAL_H 15 16#include "asan_flags.h" 17#include "asan_interface_internal.h" 18#include "sanitizer_common/sanitizer_common.h" 19#include "sanitizer_common/sanitizer_internal_defs.h" 20#include "sanitizer_common/sanitizer_stacktrace.h" 21#include "sanitizer_common/sanitizer_libc.h" 22 23#if __has_feature(address_sanitizer) || defined(__SANITIZE_ADDRESS__) 24# error "The AddressSanitizer run-time should not be" 25 " instrumented by AddressSanitizer" 26#endif 27 28// Build-time configuration options. 29 30// If set, asan will intercept C++ exception api call(s). 31#ifndef ASAN_HAS_EXCEPTIONS 32# define ASAN_HAS_EXCEPTIONS 1 33#endif 34 35// If set, values like allocator chunk size, as well as defaults for some flags 36// will be changed towards less memory overhead. 37#ifndef ASAN_LOW_MEMORY 38# if SANITIZER_IOS || SANITIZER_ANDROID || SANITIZER_RTEMS 39# define ASAN_LOW_MEMORY 1 40# else 41# define ASAN_LOW_MEMORY 0 42# endif 43#endif 44 45#ifndef ASAN_DYNAMIC 46# ifdef PIC 47# define ASAN_DYNAMIC 1 48# else 49# define ASAN_DYNAMIC 0 50# endif 51#endif 52 53// All internal functions in asan reside inside the __asan namespace 54// to avoid namespace collisions with the user programs. 55// Separate namespace also makes it simpler to distinguish the asan run-time 56// functions from the instrumented user code in a profile. 57namespace __asan { 58 59class AsanThread; 60using __sanitizer::StackTrace; 61 62void AsanInitFromRtl(); 63 64// asan_win.cpp 65void InitializePlatformExceptionHandlers(); 66// Returns whether an address is a valid allocated system heap block. 67// 'addr' must point to the beginning of the block. 68bool IsSystemHeapAddress(uptr addr); 69 70// asan_rtl.cpp 71void PrintAddressSpaceLayout(); 72void NORETURN ShowStatsAndAbort(); 73 74// asan_shadow_setup.cpp 75void InitializeShadowMemory(); 76 77// asan_malloc_linux.cpp / asan_malloc_mac.cpp 78void ReplaceSystemMalloc(); 79 80// asan_linux.cpp / asan_mac.cpp / asan_rtems.cpp / asan_win.cpp 81uptr FindDynamicShadowStart(); 82void *AsanDoesNotSupportStaticLinkage(); 83void AsanCheckDynamicRTPrereqs(); 84void AsanCheckIncompatibleRT(); 85 86// Unpoisons platform-specific stacks. 87// Returns true if all stacks have been unpoisoned. 88bool PlatformUnpoisonStacks(); 89 90// asan_rtl.cpp 91// Unpoison a region containing a stack. 92// Performs a sanity check and warns if the bounds don't look right. 93// The warning contains the type string to identify the stack type. 94void UnpoisonStack(uptr bottom, uptr top, const char *type); 95 96// asan_thread.cpp 97AsanThread *CreateMainThread(); 98 99// Support function for __asan_(un)register_image_globals. Searches for the 100// loaded image containing `needle' and then enumerates all global metadata 101// structures declared in that image, applying `op' (e.g., 102// __asan_(un)register_globals) to them. 103typedef void (*globals_op_fptr)(__asan_global *, uptr); 104void AsanApplyToGlobals(globals_op_fptr op, const void *needle); 105 106void AsanOnDeadlySignal(int, void *siginfo, void *context); 107 108void ReadContextStack(void *context, uptr *stack, uptr *ssize); 109void StopInitOrderChecking(); 110 111// Wrapper for TLS/TSD. 112void AsanTSDInit(void (*destructor)(void *tsd)); 113void *AsanTSDGet(); 114void AsanTSDSet(void *tsd); 115void PlatformTSDDtor(void *tsd); 116 117void AppendToErrorMessageBuffer(const char *buffer); 118 119void *AsanDlSymNext(const char *sym); 120 121void ReserveShadowMemoryRange(uptr beg, uptr end, const char *name); 122 123// Returns `true` iff most of ASan init process should be skipped due to the 124// ASan library being loaded via `dlopen()`. Platforms may perform any 125// `dlopen()` specific initialization inside this function. 126bool HandleDlopenInit(); 127 128// Add convenient macro for interface functions that may be represented as 129// weak hooks. 130#define ASAN_MALLOC_HOOK(ptr, size) \ 131 do { \ 132 if (&__sanitizer_malloc_hook) __sanitizer_malloc_hook(ptr, size); \ 133 RunMallocHooks(ptr, size); \ 134 } while (false) 135#define ASAN_FREE_HOOK(ptr) \ 136 do { \ 137 if (&__sanitizer_free_hook) __sanitizer_free_hook(ptr); \ 138 RunFreeHooks(ptr); \ 139 } while (false) 140#define ASAN_ON_ERROR() \ 141 if (&__asan_on_error) __asan_on_error() 142 143extern int asan_inited; 144// Used to avoid infinite recursion in __asan_init(). 145extern bool asan_init_is_running; 146extern void (*death_callback)(void); 147// These magic values are written to shadow for better error reporting. 148const int kAsanHeapLeftRedzoneMagic = 0xfa; 149const int kAsanHeapFreeMagic = 0xfd; 150const int kAsanStackLeftRedzoneMagic = 0xf1; 151const int kAsanStackMidRedzoneMagic = 0xf2; 152const int kAsanStackRightRedzoneMagic = 0xf3; 153const int kAsanStackAfterReturnMagic = 0xf5; 154const int kAsanInitializationOrderMagic = 0xf6; 155const int kAsanUserPoisonedMemoryMagic = 0xf7; 156const int kAsanContiguousContainerOOBMagic = 0xfc; 157const int kAsanStackUseAfterScopeMagic = 0xf8; 158const int kAsanGlobalRedzoneMagic = 0xf9; 159const int kAsanInternalHeapMagic = 0xfe; 160const int kAsanArrayCookieMagic = 0xac; 161const int kAsanIntraObjectRedzone = 0xbb; 162const int kAsanAllocaLeftMagic = 0xca; 163const int kAsanAllocaRightMagic = 0xcb; 164// Used to populate the shadow gap for systems without memory 165// protection there (i.e. Myriad). 166const int kAsanShadowGap = 0xcc; 167 168static const uptr kCurrentStackFrameMagic = 0x41B58AB3; 169static const uptr kRetiredStackFrameMagic = 0x45E0360E; 170 171} // namespace __asan 172 173#endif // ASAN_INTERNAL_H 174