//===-- asan_mapping.h ------------------------------------------*- C++ -*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// // // This file is a part of AddressSanitizer, an address sanity checker. // // Defines ASan memory mapping. //===----------------------------------------------------------------------===// #ifndef ASAN_MAPPING_H #define ASAN_MAPPING_H #include "sanitizer_common/sanitizer_platform.h" // The full explanation of the memory mapping could be found here: // https://github.com/google/sanitizers/wiki/AddressSanitizerAlgorithm // // Typical shadow mapping on Linux/x86_64 with SHADOW_OFFSET == 0x00007fff8000: // || `[0x10007fff8000, 0x7fffffffffff]` || HighMem || // || `[0x02008fff7000, 0x10007fff7fff]` || HighShadow || // || `[0x00008fff7000, 0x02008fff6fff]` || ShadowGap || // || `[0x00007fff8000, 0x00008fff6fff]` || LowShadow || // || `[0x000000000000, 0x00007fff7fff]` || LowMem || // // When SHADOW_OFFSET is zero (-pie): // || `[0x100000000000, 0x7fffffffffff]` || HighMem || // || `[0x020000000000, 0x0fffffffffff]` || HighShadow || // || `[0x000000040000, 0x01ffffffffff]` || ShadowGap || // // Special case when something is already mapped between // 0x003000000000 and 0x005000000000 (e.g. when prelink is installed): // || `[0x10007fff8000, 0x7fffffffffff]` || HighMem || // || `[0x02008fff7000, 0x10007fff7fff]` || HighShadow || // || `[0x005000000000, 0x02008fff6fff]` || ShadowGap3 || // || `[0x003000000000, 0x004fffffffff]` || MidMem || // || `[0x000a7fff8000, 0x002fffffffff]` || ShadowGap2 || // || `[0x00067fff8000, 0x000a7fff7fff]` || MidShadow || // || `[0x00008fff7000, 0x00067fff7fff]` || ShadowGap || // || `[0x00007fff8000, 0x00008fff6fff]` || LowShadow || // || `[0x000000000000, 0x00007fff7fff]` || LowMem || // // Default Linux/i386 mapping on x86_64 machine: // || `[0x40000000, 0xffffffff]` || HighMem || // || `[0x28000000, 0x3fffffff]` || HighShadow || // || `[0x24000000, 0x27ffffff]` || ShadowGap || // || `[0x20000000, 0x23ffffff]` || LowShadow || // || `[0x00000000, 0x1fffffff]` || LowMem || // // Default Linux/i386 mapping on i386 machine // (addresses starting with 0xc0000000 are reserved // for kernel and thus not sanitized): // || `[0x38000000, 0xbfffffff]` || HighMem || // || `[0x27000000, 0x37ffffff]` || HighShadow || // || `[0x24000000, 0x26ffffff]` || ShadowGap || // || `[0x20000000, 0x23ffffff]` || LowShadow || // || `[0x00000000, 0x1fffffff]` || LowMem || // // Default Linux/MIPS32 mapping: // || `[0x2aaa0000, 0xffffffff]` || HighMem || // || `[0x0fff4000, 0x2aa9ffff]` || HighShadow || // || `[0x0bff4000, 0x0fff3fff]` || ShadowGap || // || `[0x0aaa0000, 0x0bff3fff]` || LowShadow || // || `[0x00000000, 0x0aa9ffff]` || LowMem || // // Default Linux/MIPS64 mapping: // || `[0x4000000000, 0xffffffffff]` || HighMem || // || `[0x2800000000, 0x3fffffffff]` || HighShadow || // || `[0x2400000000, 0x27ffffffff]` || ShadowGap || // || `[0x2000000000, 0x23ffffffff]` || LowShadow || // || `[0x0000000000, 0x1fffffffff]` || LowMem || // // Default Linux/RISCV64 Sv39 mapping with SHADOW_OFFSET == 0xd55550000; // (the exact location of SHADOW_OFFSET may vary depending the dynamic probing // by FindDynamicShadowStart). // // || `[0x1555550000, 0x3fffffffff]` || HighMem || // || `[0x0fffffa000, 0x1555555fff]` || HighShadow || // || `[0x0effffa000, 0x0fffff9fff]` || ShadowGap || // || `[0x0d55550000, 0x0effff9fff]` || LowShadow || // || `[0x0000000000, 0x0d5554ffff]` || LowMem || // // Default Linux/AArch64 (39-bit VMA) mapping: // || `[0x2000000000, 0x7fffffffff]` || highmem || // || `[0x1400000000, 0x1fffffffff]` || highshadow || // || `[0x1200000000, 0x13ffffffff]` || shadowgap || // || `[0x1000000000, 0x11ffffffff]` || lowshadow || // || `[0x0000000000, 0x0fffffffff]` || lowmem || // // Default Linux/AArch64 (42-bit VMA) mapping: // || `[0x10000000000, 0x3ffffffffff]` || highmem || // || `[0x0a000000000, 0x0ffffffffff]` || highshadow || // || `[0x09000000000, 0x09fffffffff]` || shadowgap || // || `[0x08000000000, 0x08fffffffff]` || lowshadow || // || `[0x00000000000, 0x07fffffffff]` || lowmem || // // Default Linux/S390 mapping: // || `[0x30000000, 0x7fffffff]` || HighMem || // || `[0x26000000, 0x2fffffff]` || HighShadow || // || `[0x24000000, 0x25ffffff]` || ShadowGap || // || `[0x20000000, 0x23ffffff]` || LowShadow || // || `[0x00000000, 0x1fffffff]` || LowMem || // // Default Linux/SystemZ mapping: // || `[0x14000000000000, 0x1fffffffffffff]` || HighMem || // || `[0x12800000000000, 0x13ffffffffffff]` || HighShadow || // || `[0x12000000000000, 0x127fffffffffff]` || ShadowGap || // || `[0x10000000000000, 0x11ffffffffffff]` || LowShadow || // || `[0x00000000000000, 0x0fffffffffffff]` || LowMem || // // Default Linux/SPARC64 (52-bit VMA) mapping: // || `[0x8000000000000, 0xfffffffffffff]` || HighMem || // || `[0x1080000000000, 0x207ffffffffff]` || HighShadow || // || `[0x0090000000000, 0x107ffffffffff]` || ShadowGap || // || `[0x0080000000000, 0x008ffffffffff]` || LowShadow || // || `[0x0000000000000, 0x007ffffffffff]` || LowMem || // // Default Linux/LoongArch64 (47-bit VMA) mapping: // || `[0x500000000000, 0x7fffffffffff]` || HighMem || // || `[0x4a0000000000, 0x4fffffffffff]` || HighShadow || // || `[0x480000000000, 0x49ffffffffff]` || ShadowGap || // || `[0x400000000000, 0x47ffffffffff]` || LowShadow || // || `[0x000000000000, 0x3fffffffffff]` || LowMem || // // Shadow mapping on FreeBSD/x86-64 with SHADOW_OFFSET == 0x400000000000: // || `[0x500000000000, 0x7fffffffffff]` || HighMem || // || `[0x4a0000000000, 0x4fffffffffff]` || HighShadow || // || `[0x480000000000, 0x49ffffffffff]` || ShadowGap || // || `[0x400000000000, 0x47ffffffffff]` || LowShadow || // || `[0x000000000000, 0x3fffffffffff]` || LowMem || // // Shadow mapping on FreeBSD/i386 with SHADOW_OFFSET == 0x40000000: // || `[0x60000000, 0xffffffff]` || HighMem || // || `[0x4c000000, 0x5fffffff]` || HighShadow || // || `[0x48000000, 0x4bffffff]` || ShadowGap || // || `[0x40000000, 0x47ffffff]` || LowShadow || // || `[0x00000000, 0x3fffffff]` || LowMem || // // Shadow mapping on NetBSD/x86-64 with SHADOW_OFFSET == 0x400000000000: // || `[0x4feffffffe01, 0x7f7ffffff000]` || HighMem || // || `[0x49fdffffffc0, 0x4feffffffe00]` || HighShadow || // || `[0x480000000000, 0x49fdffffffbf]` || ShadowGap || // || `[0x400000000000, 0x47ffffffffff]` || LowShadow || // || `[0x000000000000, 0x3fffffffffff]` || LowMem || // // Shadow mapping on NetBSD/i386 with SHADOW_OFFSET == 0x40000000: // || `[0x60000000, 0xfffff000]` || HighMem || // || `[0x4c000000, 0x5fffffff]` || HighShadow || // || `[0x48000000, 0x4bffffff]` || ShadowGap || // || `[0x40000000, 0x47ffffff]` || LowShadow || // || `[0x00000000, 0x3fffffff]` || LowMem || // // Default Windows/i386 mapping: // (the exact location of HighShadow/HighMem may vary depending // on WoW64, /LARGEADDRESSAWARE, etc). // || `[0x50000000, 0xffffffff]` || HighMem || // || `[0x3a000000, 0x4fffffff]` || HighShadow || // || `[0x36000000, 0x39ffffff]` || ShadowGap || // || `[0x30000000, 0x35ffffff]` || LowShadow || // || `[0x00000000, 0x2fffffff]` || LowMem || #define ASAN_SHADOW_SCALE … #if SANITIZER_FUCHSIA #define ASAN_SHADOW_OFFSET_CONST … #elif SANITIZER_WORDSIZE == 32 # if SANITIZER_ANDROID #define ASAN_SHADOW_OFFSET_DYNAMIC # elif defined(__mips__) #define ASAN_SHADOW_OFFSET_CONST … # elif SANITIZER_FREEBSD #define ASAN_SHADOW_OFFSET_CONST … # elif SANITIZER_NETBSD #define ASAN_SHADOW_OFFSET_CONST … # elif SANITIZER_WINDOWS #define ASAN_SHADOW_OFFSET_CONST … # elif SANITIZER_IOS #define ASAN_SHADOW_OFFSET_DYNAMIC # else #define ASAN_SHADOW_OFFSET_CONST … # endif #else # if SANITIZER_IOS #define ASAN_SHADOW_OFFSET_DYNAMIC # elif SANITIZER_APPLE && defined(__aarch64__) #define ASAN_SHADOW_OFFSET_DYNAMIC # elif SANITIZER_FREEBSD && defined(__aarch64__) #define ASAN_SHADOW_OFFSET_CONST … # elif SANITIZER_RISCV64 #define ASAN_SHADOW_OFFSET_DYNAMIC # elif defined(__aarch64__) #define ASAN_SHADOW_OFFSET_CONST … # elif defined(__powerpc64__) #define ASAN_SHADOW_OFFSET_CONST … # elif defined(__s390x__) #define ASAN_SHADOW_OFFSET_CONST … # elif SANITIZER_FREEBSD #define ASAN_SHADOW_OFFSET_CONST … # elif SANITIZER_NETBSD #define ASAN_SHADOW_OFFSET_CONST … # elif SANITIZER_APPLE #define ASAN_SHADOW_OFFSET_CONST … # elif defined(__mips64) #define ASAN_SHADOW_OFFSET_CONST … # elif defined(__sparc__) #define ASAN_SHADOW_OFFSET_CONST … # elif SANITIZER_LOONGARCH64 #define ASAN_SHADOW_OFFSET_CONST … # elif SANITIZER_WINDOWS64 #define ASAN_SHADOW_OFFSET_DYNAMIC # else # if ASAN_SHADOW_SCALE != 3 # error "Value below is based on shadow scale = 3." # error "Original formula was: 0x7FFFFFFF & (~0xFFFULL << SHADOW_SCALE)." # endif #define ASAN_SHADOW_OFFSET_CONST … # endif #endif #if defined(__cplusplus) # include "asan_internal.h" static const u64 kDefaultShadowSentinel = …; # if defined(ASAN_SHADOW_OFFSET_CONST) static const u64 kConstShadowOffset = …; #define ASAN_SHADOW_OFFSET … # elif defined(ASAN_SHADOW_OFFSET_DYNAMIC) #define ASAN_SHADOW_OFFSET … # else # error "ASAN_SHADOW_OFFSET can't be determined." # endif # if SANITIZER_ANDROID && defined(__arm__) #define ASAN_PREMAP_SHADOW … # else #define ASAN_PREMAP_SHADOW … # endif #define ASAN_SHADOW_GRANULARITY … #define DO_ASAN_MAPPING_PROFILE … # if DO_ASAN_MAPPING_PROFILE #define PROFILE_ASAN_MAPPING … # else #define PROFILE_ASAN_MAPPING() … # endif // If 1, all shadow boundaries are constants. // Don't set to 1 other than for testing. #define ASAN_FIXED_MAPPING … namespace __asan { extern uptr AsanMappingProfile[]; # if ASAN_FIXED_MAPPING // Fixed mapping for 64-bit Linux. Mostly used for performance comparison // with non-fixed mapping. As of r175253 (Feb 2013) the performance // difference between fixed and non-fixed mapping is below the noise level. static uptr kHighMemEnd = 0x7fffffffffffULL; static uptr kMidMemBeg = 0x3000000000ULL; static uptr kMidMemEnd = 0x4fffffffffULL; # else extern uptr kHighMemEnd, kMidMemBeg, kMidMemEnd; // Initialized in __asan_init. # endif } // namespace __asan # if defined(__sparc__) && SANITIZER_WORDSIZE == 64 # include "asan_mapping_sparc64.h" # else #define MEM_TO_SHADOW(mem) … #define SHADOW_TO_MEM(mem) … #define kLowMemBeg … #define kLowMemEnd … #define kLowShadowBeg … #define kLowShadowEnd … #define kHighMemBeg … #define kHighShadowBeg … #define kHighShadowEnd … #define kMidShadowBeg … #define kMidShadowEnd … // With the zero shadow base we can not actually map pages starting from 0. // This constant is somewhat arbitrary. #define kZeroBaseShadowStart … #define kZeroBaseMaxShadowStart … #define kShadowGapBeg … #define kShadowGapEnd … #define kShadowGap2Beg … #define kShadowGap2End … #define kShadowGap3Beg … #define kShadowGap3End … namespace __asan { static inline bool AddrIsInLowMem(uptr a) { … } static inline bool AddrIsInLowShadow(uptr a) { … } static inline bool AddrIsInMidMem(uptr a) { … } static inline bool AddrIsInMidShadow(uptr a) { … } static inline bool AddrIsInHighMem(uptr a) { … } static inline bool AddrIsInHighShadow(uptr a) { … } static inline bool AddrIsInShadowGap(uptr a) { … } } // namespace __asan # endif namespace __asan { static inline uptr MemToShadowSize(uptr size) { … } static inline bool AddrIsInMem(uptr a) { … } static inline uptr MemToShadow(uptr p) { … } static inline bool AddrIsInShadow(uptr a) { … } static inline uptr ShadowToMem(uptr p) { … } static inline bool AddrIsAlignedByGranularity(uptr a) { … } static inline bool AddressIsPoisoned(uptr a) { … } // Must be after all calls to PROFILE_ASAN_MAPPING(). static const uptr kAsanMappingProfileSize = …; } // namespace __asan #endif // __cplusplus #endif // ASAN_MAPPING_H