asan_mapping.h revision 296417
1247606Spjd//===-- asan_mapping.h ------------------------------------------*- C++ -*-===// 2247606Spjd// 3247606Spjd// The LLVM Compiler Infrastructure 4247606Spjd// 5247606Spjd// This file is distributed under the University of Illinois Open Source 6247606Spjd// License. See LICENSE.TXT for details. 7247606Spjd// 8247606Spjd//===----------------------------------------------------------------------===// 9247606Spjd// 10247606Spjd// This file is a part of AddressSanitizer, an address sanity checker. 11247606Spjd// 12247606Spjd// Defines ASan memory mapping. 13247606Spjd//===----------------------------------------------------------------------===// 14247606Spjd#ifndef ASAN_MAPPING_H 15247606Spjd#define ASAN_MAPPING_H 16247606Spjd 17247606Spjd#include "asan_internal.h" 18247606Spjd 19247606Spjd// The full explanation of the memory mapping could be found here: 20247606Spjd// https://github.com/google/sanitizers/wiki/AddressSanitizerAlgorithm 21247606Spjd// 22247606Spjd// Typical shadow mapping on Linux/x86_64 with SHADOW_OFFSET == 0x00007fff8000: 23247606Spjd// || `[0x10007fff8000, 0x7fffffffffff]` || HighMem || 24247606Spjd// || `[0x02008fff7000, 0x10007fff7fff]` || HighShadow || 25247606Spjd// || `[0x00008fff7000, 0x02008fff6fff]` || ShadowGap || 26247606Spjd// || `[0x00007fff8000, 0x00008fff6fff]` || LowShadow || 27247606Spjd// || `[0x000000000000, 0x00007fff7fff]` || LowMem || 28247606Spjd// 29247606Spjd// When SHADOW_OFFSET is zero (-pie): 30247606Spjd// || `[0x100000000000, 0x7fffffffffff]` || HighMem || 31247606Spjd// || `[0x020000000000, 0x0fffffffffff]` || HighShadow || 32247606Spjd// || `[0x000000040000, 0x01ffffffffff]` || ShadowGap || 33247606Spjd// 34263234Srwatson// Special case when something is already mapped between 35247606Spjd// 0x003000000000 and 0x005000000000 (e.g. when prelink is installed): 36247606Spjd// || `[0x10007fff8000, 0x7fffffffffff]` || HighMem || 37247606Spjd// || `[0x02008fff7000, 0x10007fff7fff]` || HighShadow || 38247606Spjd// || `[0x005000000000, 0x02008fff6fff]` || ShadowGap3 || 39247606Spjd// || `[0x003000000000, 0x004fffffffff]` || MidMem || 40247606Spjd// || `[0x000a7fff8000, 0x002fffffffff]` || ShadowGap2 || 41247606Spjd// || `[0x00067fff8000, 0x000a7fff7fff]` || MidShadow || 42247606Spjd// || `[0x00008fff7000, 0x00067fff7fff]` || ShadowGap || 43247606Spjd// || `[0x00007fff8000, 0x00008fff6fff]` || LowShadow || 44247606Spjd// || `[0x000000000000, 0x00007fff7fff]` || LowMem || 45247606Spjd// 46247606Spjd// Default Linux/i386 mapping on x86_64 machine: 47247606Spjd// || `[0x40000000, 0xffffffff]` || HighMem || 48247606Spjd// || `[0x28000000, 0x3fffffff]` || HighShadow || 49247606Spjd// || `[0x24000000, 0x27ffffff]` || ShadowGap || 50247606Spjd// || `[0x20000000, 0x23ffffff]` || LowShadow || 51247606Spjd// || `[0x00000000, 0x1fffffff]` || LowMem || 52247606Spjd// 53247606Spjd// Default Linux/i386 mapping on i386 machine 54247606Spjd// (addresses starting with 0xc0000000 are reserved 55247606Spjd// for kernel and thus not sanitized): 56247606Spjd// || `[0x38000000, 0xbfffffff]` || HighMem || 57247606Spjd// || `[0x27000000, 0x37ffffff]` || HighShadow || 58247606Spjd// || `[0x24000000, 0x26ffffff]` || ShadowGap || 59247606Spjd// || `[0x20000000, 0x23ffffff]` || LowShadow || 60247606Spjd// || `[0x00000000, 0x1fffffff]` || LowMem || 61247606Spjd// 62247606Spjd// Default Linux/MIPS32 mapping: 63247606Spjd// || `[0x2aaa0000, 0xffffffff]` || HighMem || 64247606Spjd// || `[0x0fff4000, 0x2aa9ffff]` || HighShadow || 65247606Spjd// || `[0x0bff4000, 0x0fff3fff]` || ShadowGap || 66247606Spjd// || `[0x0aaa0000, 0x0bff3fff]` || LowShadow || 67247606Spjd// || `[0x00000000, 0x0aa9ffff]` || LowMem || 68247606Spjd// 69247606Spjd// Default Linux/MIPS64 mapping: 70247606Spjd// || `[0x4000000000, 0xffffffffff]` || HighMem || 71247606Spjd// || `[0x2800000000, 0x3fffffffff]` || HighShadow || 72247606Spjd// || `[0x2400000000, 0x27ffffffff]` || ShadowGap || 73247606Spjd// || `[0x2000000000, 0x23ffffffff]` || LowShadow || 74247606Spjd// || `[0x0000000000, 0x1fffffffff]` || LowMem || 75247606Spjd// 76247606Spjd// Default Linux/AArch64 (39-bit VMA) mapping: 77247606Spjd// || `[0x2000000000, 0x7fffffffff]` || highmem || 78247606Spjd// || `[0x1400000000, 0x1fffffffff]` || highshadow || 79247606Spjd// || `[0x1200000000, 0x13ffffffff]` || shadowgap || 80247606Spjd// || `[0x1000000000, 0x11ffffffff]` || lowshadow || 81247606Spjd// || `[0x0000000000, 0x0fffffffff]` || lowmem || 82247606Spjd// 83247606Spjd// Default Linux/AArch64 (42-bit VMA) mapping: 84247606Spjd// || `[0x10000000000, 0x3ffffffffff]` || highmem || 85247606Spjd// || `[0x0a000000000, 0x0ffffffffff]` || highshadow || 86247606Spjd// || `[0x09000000000, 0x09fffffffff]` || shadowgap || 87247606Spjd// || `[0x08000000000, 0x08fffffffff]` || lowshadow || 88247606Spjd// || `[0x00000000000, 0x07fffffffff]` || lowmem || 89247606Spjd// 90247606Spjd// Shadow mapping on FreeBSD/x86-64 with SHADOW_OFFSET == 0x400000000000: 91247606Spjd// || `[0x500000000000, 0x7fffffffffff]` || HighMem || 92247606Spjd// || `[0x4a0000000000, 0x4fffffffffff]` || HighShadow || 93247606Spjd// || `[0x480000000000, 0x49ffffffffff]` || ShadowGap || 94247606Spjd// || `[0x400000000000, 0x47ffffffffff]` || LowShadow || 95247606Spjd// || `[0x000000000000, 0x3fffffffffff]` || LowMem || 96247606Spjd// 97247606Spjd// Shadow mapping on FreeBSD/i386 with SHADOW_OFFSET == 0x40000000: 98247606Spjd// || `[0x60000000, 0xffffffff]` || HighMem || 99247606Spjd// || `[0x4c000000, 0x5fffffff]` || HighShadow || 100247606Spjd// || `[0x48000000, 0x4bffffff]` || ShadowGap || 101247606Spjd// || `[0x40000000, 0x47ffffff]` || LowShadow || 102247606Spjd// || `[0x00000000, 0x3fffffff]` || LowMem || 103247606Spjd// 104247606Spjd// Default Windows/i386 mapping: 105247606Spjd// (the exact location of HighShadow/HighMem may vary depending 106247606Spjd// on WoW64, /LARGEADDRESSAWARE, etc). 107247606Spjd// || `[0x50000000, 0xffffffff]` || HighMem || 108247606Spjd// || `[0x3a000000, 0x4fffffff]` || HighShadow || 109247606Spjd// || `[0x36000000, 0x39ffffff]` || ShadowGap || 110247606Spjd// || `[0x30000000, 0x35ffffff]` || LowShadow || 111247606Spjd// || `[0x00000000, 0x2fffffff]` || LowMem || 112247606Spjd 113247606Spjdstatic const u64 kDefaultShadowScale = 3; 114247606Spjdstatic const u64 kDefaultShadowOffset32 = 1ULL << 29; // 0x20000000 115247606Spjdstatic const u64 kDefaultShadowOffset64 = 1ULL << 44; 116247606Spjdstatic const u64 kDefaultShort64bitShadowOffset = 0x7FFF8000; // < 2G. 117247606Spjdstatic const u64 kIosShadowOffset32 = 1ULL << 30; // 0x40000000 118247606Spjdstatic const u64 kIosShadowOffset64 = 0x130000000; 119247606Spjdstatic const u64 kIosSimShadowOffset32 = 1ULL << 30; 120247606Spjdstatic const u64 kIosSimShadowOffset64 = kDefaultShadowOffset64; 121247606Spjdstatic const u64 kAArch64_ShadowOffset64 = 1ULL << 36; 122247606Spjdstatic const u64 kMIPS32_ShadowOffset32 = 0x0aaa0000; 123247606Spjdstatic const u64 kMIPS64_ShadowOffset64 = 1ULL << 37; 124247606Spjdstatic const u64 kPPC64_ShadowOffset64 = 1ULL << 41; 125247606Spjdstatic const u64 kFreeBSD_ShadowOffset32 = 1ULL << 30; // 0x40000000 126247606Spjdstatic const u64 kFreeBSD_ShadowOffset64 = 1ULL << 46; // 0x400000000000 127247606Spjdstatic const u64 kWindowsShadowOffset32 = 3ULL << 28; // 0x30000000 128247606Spjd 129247606Spjd#define SHADOW_SCALE kDefaultShadowScale 130247606Spjd 131247606Spjd 132247606Spjd#if SANITIZER_WORDSIZE == 32 133247606Spjd# if SANITIZER_ANDROID 134247606Spjd# define SHADOW_OFFSET (0) 135247606Spjd# elif defined(__mips__) 136247606Spjd# define SHADOW_OFFSET kMIPS32_ShadowOffset32 137247606Spjd# elif SANITIZER_FREEBSD 138247606Spjd# define SHADOW_OFFSET kFreeBSD_ShadowOffset32 139247606Spjd# elif SANITIZER_WINDOWS 140247606Spjd# define SHADOW_OFFSET kWindowsShadowOffset32 141247606Spjd# elif SANITIZER_IOSSIM 142247606Spjd# define SHADOW_OFFSET kIosSimShadowOffset32 143247606Spjd# elif SANITIZER_IOS 144247606Spjd# define SHADOW_OFFSET kIosShadowOffset32 145247606Spjd# else 146247606Spjd# define SHADOW_OFFSET kDefaultShadowOffset32 147247606Spjd# endif 148247606Spjd#else 149247606Spjd# if defined(__aarch64__) 150247606Spjd# define SHADOW_OFFSET kAArch64_ShadowOffset64 151247606Spjd# elif defined(__powerpc64__) 152247606Spjd# define SHADOW_OFFSET kPPC64_ShadowOffset64 153247606Spjd# elif SANITIZER_FREEBSD 154247606Spjd# define SHADOW_OFFSET kFreeBSD_ShadowOffset64 155247606Spjd# elif SANITIZER_MAC 156247606Spjd# define SHADOW_OFFSET kDefaultShadowOffset64 157247606Spjd# elif defined(__mips64) 158247606Spjd# define SHADOW_OFFSET kMIPS64_ShadowOffset64 159247606Spjd# elif SANITIZER_IOSSIM 160247606Spjd# define SHADOW_OFFSET kIosSimShadowOffset64 161247606Spjd# elif SANITIZER_IOS 162247606Spjd# define SHADOW_OFFSET kIosShadowOffset64 163247606Spjd# else 164247606Spjd# define SHADOW_OFFSET kDefaultShort64bitShadowOffset 165247606Spjd# endif 166247606Spjd#endif 167247606Spjd 168#define SHADOW_GRANULARITY (1ULL << SHADOW_SCALE) 169#define MEM_TO_SHADOW(mem) (((mem) >> SHADOW_SCALE) + (SHADOW_OFFSET)) 170#define SHADOW_TO_MEM(shadow) (((shadow) - SHADOW_OFFSET) << SHADOW_SCALE) 171 172#define kLowMemBeg 0 173#define kLowMemEnd (SHADOW_OFFSET ? SHADOW_OFFSET - 1 : 0) 174 175#define kLowShadowBeg SHADOW_OFFSET 176#define kLowShadowEnd MEM_TO_SHADOW(kLowMemEnd) 177 178#define kHighMemBeg (MEM_TO_SHADOW(kHighMemEnd) + 1) 179 180#define kHighShadowBeg MEM_TO_SHADOW(kHighMemBeg) 181#define kHighShadowEnd MEM_TO_SHADOW(kHighMemEnd) 182 183# define kMidShadowBeg MEM_TO_SHADOW(kMidMemBeg) 184# define kMidShadowEnd MEM_TO_SHADOW(kMidMemEnd) 185 186// With the zero shadow base we can not actually map pages starting from 0. 187// This constant is somewhat arbitrary. 188#define kZeroBaseShadowStart 0 189#define kZeroBaseMaxShadowStart (1 << 18) 190 191#define kShadowGapBeg (kLowShadowEnd ? kLowShadowEnd + 1 \ 192 : kZeroBaseShadowStart) 193#define kShadowGapEnd ((kMidMemBeg ? kMidShadowBeg : kHighShadowBeg) - 1) 194 195#define kShadowGap2Beg (kMidMemBeg ? kMidShadowEnd + 1 : 0) 196#define kShadowGap2End (kMidMemBeg ? kMidMemBeg - 1 : 0) 197 198#define kShadowGap3Beg (kMidMemBeg ? kMidMemEnd + 1 : 0) 199#define kShadowGap3End (kMidMemBeg ? kHighShadowBeg - 1 : 0) 200 201#define DO_ASAN_MAPPING_PROFILE 0 // Set to 1 to profile the functions below. 202 203#if DO_ASAN_MAPPING_PROFILE 204# define PROFILE_ASAN_MAPPING() AsanMappingProfile[__LINE__]++; 205#else 206# define PROFILE_ASAN_MAPPING() 207#endif 208 209// If 1, all shadow boundaries are constants. 210// Don't set to 1 other than for testing. 211#define ASAN_FIXED_MAPPING 0 212 213namespace __asan { 214 215extern uptr AsanMappingProfile[]; 216 217#if ASAN_FIXED_MAPPING 218// Fixed mapping for 64-bit Linux. Mostly used for performance comparison 219// with non-fixed mapping. As of r175253 (Feb 2013) the performance 220// difference between fixed and non-fixed mapping is below the noise level. 221static uptr kHighMemEnd = 0x7fffffffffffULL; 222static uptr kMidMemBeg = 0x3000000000ULL; 223static uptr kMidMemEnd = 0x4fffffffffULL; 224#else 225extern uptr kHighMemEnd, kMidMemBeg, kMidMemEnd; // Initialized in __asan_init. 226#endif 227 228static inline bool AddrIsInLowMem(uptr a) { 229 PROFILE_ASAN_MAPPING(); 230 return a < kLowMemEnd; 231} 232 233static inline bool AddrIsInLowShadow(uptr a) { 234 PROFILE_ASAN_MAPPING(); 235 return a >= kLowShadowBeg && a <= kLowShadowEnd; 236} 237 238static inline bool AddrIsInHighMem(uptr a) { 239 PROFILE_ASAN_MAPPING(); 240 return a >= kHighMemBeg && a <= kHighMemEnd; 241} 242 243static inline bool AddrIsInMidMem(uptr a) { 244 PROFILE_ASAN_MAPPING(); 245 return kMidMemBeg && a >= kMidMemBeg && a <= kMidMemEnd; 246} 247 248static inline bool AddrIsInMem(uptr a) { 249 PROFILE_ASAN_MAPPING(); 250 return AddrIsInLowMem(a) || AddrIsInMidMem(a) || AddrIsInHighMem(a); 251} 252 253static inline uptr MemToShadow(uptr p) { 254 PROFILE_ASAN_MAPPING(); 255 CHECK(AddrIsInMem(p)); 256 return MEM_TO_SHADOW(p); 257} 258 259static inline bool AddrIsInHighShadow(uptr a) { 260 PROFILE_ASAN_MAPPING(); 261 return a >= kHighShadowBeg && a <= kHighMemEnd; 262} 263 264static inline bool AddrIsInMidShadow(uptr a) { 265 PROFILE_ASAN_MAPPING(); 266 return kMidMemBeg && a >= kMidShadowBeg && a <= kMidMemEnd; 267} 268 269static inline bool AddrIsInShadow(uptr a) { 270 PROFILE_ASAN_MAPPING(); 271 return AddrIsInLowShadow(a) || AddrIsInMidShadow(a) || AddrIsInHighShadow(a); 272} 273 274static inline bool AddrIsInShadowGap(uptr a) { 275 PROFILE_ASAN_MAPPING(); 276 if (kMidMemBeg) { 277 if (a <= kShadowGapEnd) 278 return SHADOW_OFFSET == 0 || a >= kShadowGapBeg; 279 return (a >= kShadowGap2Beg && a <= kShadowGap2End) || 280 (a >= kShadowGap3Beg && a <= kShadowGap3End); 281 } 282 // In zero-based shadow mode we treat addresses near zero as addresses 283 // in shadow gap as well. 284 if (SHADOW_OFFSET == 0) 285 return a <= kShadowGapEnd; 286 return a >= kShadowGapBeg && a <= kShadowGapEnd; 287} 288 289static inline bool AddrIsAlignedByGranularity(uptr a) { 290 PROFILE_ASAN_MAPPING(); 291 return (a & (SHADOW_GRANULARITY - 1)) == 0; 292} 293 294static inline bool AddressIsPoisoned(uptr a) { 295 PROFILE_ASAN_MAPPING(); 296 const uptr kAccessSize = 1; 297 u8 *shadow_address = (u8*)MEM_TO_SHADOW(a); 298 s8 shadow_value = *shadow_address; 299 if (shadow_value) { 300 u8 last_accessed_byte = (a & (SHADOW_GRANULARITY - 1)) 301 + kAccessSize - 1; 302 return (last_accessed_byte >= shadow_value); 303 } 304 return false; 305} 306 307// Must be after all calls to PROFILE_ASAN_MAPPING(). 308static const uptr kAsanMappingProfileSize = __LINE__; 309 310} // namespace __asan 311 312#endif // ASAN_MAPPING_H 313