Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 1 | //===-- asan_mapping.h ------------------------------------------*- C++ -*-===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file is a part of AddressSanitizer, an address sanity checker. |
| 11 | // |
| 12 | // Defines ASan memory mapping. |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | #ifndef ASAN_MAPPING_H |
| 15 | #define ASAN_MAPPING_H |
| 16 | |
| 17 | #include "asan_internal.h" |
| 18 | |
| 19 | // The full explanation of the memory mapping could be found here: |
| 20 | // http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerAlgorithm |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 21 | // |
| 22 | // Typical shadow mapping on Linux/x86_64 with SHADOW_OFFSET == 0x00007fff8000: |
| 23 | // || `[0x10007fff8000, 0x7fffffffffff]` || HighMem || |
| 24 | // || `[0x02008fff7000, 0x10007fff7fff]` || HighShadow || |
| 25 | // || `[0x00008fff7000, 0x02008fff6fff]` || ShadowGap || |
| 26 | // || `[0x00007fff8000, 0x00008fff6fff]` || LowShadow || |
| 27 | // || `[0x000000000000, 0x00007fff7fff]` || LowMem || |
| 28 | // |
| 29 | // When SHADOW_OFFSET is zero (-pie): |
| 30 | // || `[0x100000000000, 0x7fffffffffff]` || HighMem || |
| 31 | // || `[0x020000000000, 0x0fffffffffff]` || HighShadow || |
| 32 | // || `[0x000000040000, 0x01ffffffffff]` || ShadowGap || |
| 33 | // |
| 34 | // Special case when something is already mapped between |
Kostya Serebryany | 13577fe | 2013-02-28 12:28:37 +0000 | [diff] [blame] | 35 | // 0x003000000000 and 0x005000000000 (e.g. when prelink is installed): |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 36 | // || `[0x10007fff8000, 0x7fffffffffff]` || HighMem || |
| 37 | // || `[0x02008fff7000, 0x10007fff7fff]` || HighShadow || |
Kostya Serebryany | 13577fe | 2013-02-28 12:28:37 +0000 | [diff] [blame] | 38 | // || `[0x005000000000, 0x02008fff6fff]` || ShadowGap3 || |
| 39 | // || `[0x003000000000, 0x004fffffffff]` || MidMem || |
| 40 | // || `[0x000a7fff8000, 0x002fffffffff]` || ShadowGap2 || |
| 41 | // || `[0x00067fff8000, 0x000a7fff7fff]` || MidShadow || |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 42 | // || `[0x00008fff7000, 0x00067fff7fff]` || ShadowGap || |
| 43 | // || `[0x00007fff8000, 0x00008fff6fff]` || LowShadow || |
| 44 | // || `[0x000000000000, 0x00007fff7fff]` || LowMem || |
| 45 | // |
| 46 | // Default Linux/i386 mapping: |
| 47 | // || `[0x40000000, 0xffffffff]` || HighMem || |
| 48 | // || `[0x28000000, 0x3fffffff]` || HighShadow || |
| 49 | // || `[0x24000000, 0x27ffffff]` || ShadowGap || |
| 50 | // || `[0x20000000, 0x23ffffff]` || LowShadow || |
| 51 | // || `[0x00000000, 0x1fffffff]` || LowMem || |
Kostya Serebryany | 40527a5 | 2013-06-03 14:49:25 +0000 | [diff] [blame] | 52 | // |
| 53 | // Default Linux/MIPS mapping: |
| 54 | // || `[0x2aaa8000, 0xffffffff]` || HighMem || |
| 55 | // || `[0x0fffd000, 0x2aaa7fff]` || HighShadow || |
| 56 | // || `[0x0bffd000, 0x0fffcfff]` || ShadowGap || |
| 57 | // || `[0x0aaa8000, 0x0bffcfff]` || LowShadow || |
| 58 | // || `[0x00000000, 0x0aaa7fff]` || LowMem || |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 59 | |
Alexey Samsonov | 22e21b0 | 2013-09-16 15:45:06 +0000 | [diff] [blame] | 60 | static const u64 kDefaultShadowScale = 3; |
| 61 | static const u64 kDefaultShadowOffset32 = 1ULL << 29; |
| 62 | static const u64 kDefaultShadowOffset64 = 1ULL << 44; |
| 63 | static const u64 kDefaultShort64bitShadowOffset = 0x7FFF8000; // < 2G. |
| 64 | static const u64 kPPC64_ShadowOffset64 = 1ULL << 41; |
| 65 | static const u64 kMIPS32_ShadowOffset32 = 0x0aaa8000; |
| 66 | |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 67 | #if ASAN_FLEXIBLE_MAPPING_AND_OFFSET == 1 |
Alexey Samsonov | a6d4cf7 | 2012-12-28 11:22:23 +0000 | [diff] [blame] | 68 | extern SANITIZER_INTERFACE_ATTRIBUTE uptr __asan_mapping_scale; |
| 69 | extern SANITIZER_INTERFACE_ATTRIBUTE uptr __asan_mapping_offset; |
Evgeniy Stepanov | f1ee2cd | 2012-05-23 11:52:37 +0000 | [diff] [blame] | 70 | # define SHADOW_SCALE (__asan_mapping_scale) |
| 71 | # define SHADOW_OFFSET (__asan_mapping_offset) |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 72 | #else |
Alexey Samsonov | 22e21b0 | 2013-09-16 15:45:06 +0000 | [diff] [blame] | 73 | # define SHADOW_SCALE kDefaultShadowScale |
Evgeniy Stepanov | 83cb787 | 2013-03-19 13:54:41 +0000 | [diff] [blame] | 74 | # if SANITIZER_ANDROID |
Evgeniy Stepanov | f1ee2cd | 2012-05-23 11:52:37 +0000 | [diff] [blame] | 75 | # define SHADOW_OFFSET (0) |
| 76 | # else |
Kostya Serebryany | 5af39e5 | 2012-11-21 12:38:58 +0000 | [diff] [blame] | 77 | # if SANITIZER_WORDSIZE == 32 |
Kostya Serebryany | 40527a5 | 2013-06-03 14:49:25 +0000 | [diff] [blame] | 78 | # if defined(__mips__) |
Alexey Samsonov | 22e21b0 | 2013-09-16 15:45:06 +0000 | [diff] [blame] | 79 | # define SHADOW_OFFSET kMIPS32_ShadowOffset32 |
Kostya Serebryany | 40527a5 | 2013-06-03 14:49:25 +0000 | [diff] [blame] | 80 | # else |
Alexey Samsonov | 22e21b0 | 2013-09-16 15:45:06 +0000 | [diff] [blame] | 81 | # define SHADOW_OFFSET kDefaultShadowOffset32 |
Kostya Serebryany | 40527a5 | 2013-06-03 14:49:25 +0000 | [diff] [blame] | 82 | # endif |
Evgeniy Stepanov | f1ee2cd | 2012-05-23 11:52:37 +0000 | [diff] [blame] | 83 | # else |
Kostya Serebryany | d7d4650 | 2012-11-20 07:00:42 +0000 | [diff] [blame] | 84 | # if defined(__powerpc64__) |
Alexey Samsonov | 22e21b0 | 2013-09-16 15:45:06 +0000 | [diff] [blame] | 85 | # define SHADOW_OFFSET kPPC64_ShadowOffset64 |
| 86 | # elif SANITIZER_MAC |
| 87 | # define SHADOW_OFFSET kDefaultShadowOffset64 |
Kostya Serebryany | d7d4650 | 2012-11-20 07:00:42 +0000 | [diff] [blame] | 88 | # else |
Alexey Samsonov | 22e21b0 | 2013-09-16 15:45:06 +0000 | [diff] [blame] | 89 | # define SHADOW_OFFSET kDefaultShort64bitShadowOffset |
Kostya Serebryany | d7d4650 | 2012-11-20 07:00:42 +0000 | [diff] [blame] | 90 | # endif |
Evgeniy Stepanov | f1ee2cd | 2012-05-23 11:52:37 +0000 | [diff] [blame] | 91 | # endif |
| 92 | # endif |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 93 | #endif // ASAN_FLEXIBLE_MAPPING_AND_OFFSET |
| 94 | |
| 95 | #define SHADOW_GRANULARITY (1ULL << SHADOW_SCALE) |
Kostya Serebryany | e5ab968 | 2013-01-23 13:27:43 +0000 | [diff] [blame] | 96 | #define MEM_TO_SHADOW(mem) (((mem) >> SHADOW_SCALE) + (SHADOW_OFFSET)) |
Evgeniy Stepanov | 3972ea0 | 2012-05-12 12:33:10 +0000 | [diff] [blame] | 97 | #define SHADOW_TO_MEM(shadow) (((shadow) - SHADOW_OFFSET) << SHADOW_SCALE) |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 98 | |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 99 | #define kLowMemBeg 0 |
| 100 | #define kLowMemEnd (SHADOW_OFFSET ? SHADOW_OFFSET - 1 : 0) |
| 101 | |
| 102 | #define kLowShadowBeg SHADOW_OFFSET |
| 103 | #define kLowShadowEnd MEM_TO_SHADOW(kLowMemEnd) |
| 104 | |
| 105 | #define kHighMemBeg (MEM_TO_SHADOW(kHighMemEnd) + 1) |
| 106 | |
| 107 | #define kHighShadowBeg MEM_TO_SHADOW(kHighMemBeg) |
| 108 | #define kHighShadowEnd MEM_TO_SHADOW(kHighMemEnd) |
| 109 | |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 110 | # define kMidShadowBeg MEM_TO_SHADOW(kMidMemBeg) |
| 111 | # define kMidShadowEnd MEM_TO_SHADOW(kMidMemEnd) |
| 112 | |
Kostya Serebryany | e89f184 | 2012-11-24 05:03:11 +0000 | [diff] [blame] | 113 | // With the zero shadow base we can not actually map pages starting from 0. |
| 114 | // This constant is somewhat arbitrary. |
| 115 | #define kZeroBaseShadowStart (1 << 18) |
| 116 | |
| 117 | #define kShadowGapBeg (kLowShadowEnd ? kLowShadowEnd + 1 \ |
| 118 | : kZeroBaseShadowStart) |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 119 | #define kShadowGapEnd ((kMidMemBeg ? kMidShadowBeg : kHighShadowBeg) - 1) |
| 120 | |
| 121 | #define kShadowGap2Beg (kMidMemBeg ? kMidShadowEnd + 1 : 0) |
| 122 | #define kShadowGap2End (kMidMemBeg ? kMidMemBeg - 1 : 0) |
| 123 | |
| 124 | #define kShadowGap3Beg (kMidMemBeg ? kMidMemEnd + 1 : 0) |
| 125 | #define kShadowGap3End (kMidMemBeg ? kHighShadowBeg - 1 : 0) |
| 126 | |
| 127 | #define DO_ASAN_MAPPING_PROFILE 0 // Set to 1 to profile the functions below. |
| 128 | |
| 129 | #if DO_ASAN_MAPPING_PROFILE |
| 130 | # define PROFILE_ASAN_MAPPING() AsanMappingProfile[__LINE__]++; |
| 131 | #else |
| 132 | # define PROFILE_ASAN_MAPPING() |
| 133 | #endif |
| 134 | |
| 135 | // If 1, all shadow boundaries are constants. |
| 136 | // Don't set to 1 other than for testing. |
| 137 | #define ASAN_FIXED_MAPPING 0 |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 138 | |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 139 | namespace __asan { |
| 140 | |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 141 | extern uptr AsanMappingProfile[]; |
| 142 | |
| 143 | #if ASAN_FIXED_MAPPING |
| 144 | // Fixed mapping for 64-bit Linux. Mostly used for performance comparison |
| 145 | // with non-fixed mapping. As of r175253 (Feb 2013) the performance |
| 146 | // difference between fixed and non-fixed mapping is below the noise level. |
| 147 | static uptr kHighMemEnd = 0x7fffffffffffULL; |
| 148 | static uptr kMidMemBeg = 0x3000000000ULL; |
Kostya Serebryany | 13577fe | 2013-02-28 12:28:37 +0000 | [diff] [blame] | 149 | static uptr kMidMemEnd = 0x4fffffffffULL; |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 150 | #else |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 151 | extern uptr kHighMemEnd, kMidMemBeg, kMidMemEnd; // Initialized in __asan_init. |
| 152 | #endif |
Kostya Serebryany | e5ab968 | 2013-01-23 13:27:43 +0000 | [diff] [blame] | 153 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 154 | static inline bool AddrIsInLowMem(uptr a) { |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 155 | PROFILE_ASAN_MAPPING(); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 156 | return a < kLowMemEnd; |
| 157 | } |
| 158 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 159 | static inline bool AddrIsInLowShadow(uptr a) { |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 160 | PROFILE_ASAN_MAPPING(); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 161 | return a >= kLowShadowBeg && a <= kLowShadowEnd; |
| 162 | } |
| 163 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 164 | static inline bool AddrIsInHighMem(uptr a) { |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 165 | PROFILE_ASAN_MAPPING(); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 166 | return a >= kHighMemBeg && a <= kHighMemEnd; |
| 167 | } |
| 168 | |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 169 | static inline bool AddrIsInMidMem(uptr a) { |
| 170 | PROFILE_ASAN_MAPPING(); |
| 171 | return kMidMemBeg && a >= kMidMemBeg && a <= kMidMemEnd; |
| 172 | } |
| 173 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 174 | static inline bool AddrIsInMem(uptr a) { |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 175 | PROFILE_ASAN_MAPPING(); |
| 176 | return AddrIsInLowMem(a) || AddrIsInMidMem(a) || AddrIsInHighMem(a); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 177 | } |
| 178 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 179 | static inline uptr MemToShadow(uptr p) { |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 180 | PROFILE_ASAN_MAPPING(); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 181 | CHECK(AddrIsInMem(p)); |
| 182 | return MEM_TO_SHADOW(p); |
| 183 | } |
| 184 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 185 | static inline bool AddrIsInHighShadow(uptr a) { |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 186 | PROFILE_ASAN_MAPPING(); |
| 187 | return a >= kHighShadowBeg && a <= kHighMemEnd; |
| 188 | } |
| 189 | |
| 190 | static inline bool AddrIsInMidShadow(uptr a) { |
| 191 | PROFILE_ASAN_MAPPING(); |
| 192 | return kMidMemBeg && a >= kMidShadowBeg && a <= kMidMemEnd; |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 193 | } |
| 194 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 195 | static inline bool AddrIsInShadow(uptr a) { |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 196 | PROFILE_ASAN_MAPPING(); |
| 197 | return AddrIsInLowShadow(a) || AddrIsInMidShadow(a) || AddrIsInHighShadow(a); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 198 | } |
| 199 | |
Alexander Potapenko | 79d12e8 | 2012-07-23 08:22:27 +0000 | [diff] [blame] | 200 | static inline bool AddrIsInShadowGap(uptr a) { |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 201 | PROFILE_ASAN_MAPPING(); |
| 202 | if (kMidMemBeg) { |
| 203 | if (a <= kShadowGapEnd) |
| 204 | return SHADOW_OFFSET == 0 || a >= kShadowGapBeg; |
| 205 | return (a >= kShadowGap2Beg && a <= kShadowGap2End) || |
| 206 | (a >= kShadowGap3Beg && a <= kShadowGap3End); |
| 207 | } |
Alexey Samsonov | ee485d4 | 2013-01-21 10:51:18 +0000 | [diff] [blame] | 208 | // In zero-based shadow mode we treat addresses near zero as addresses |
| 209 | // in shadow gap as well. |
Alexey Samsonov | 87b52b9 | 2013-01-21 11:36:38 +0000 | [diff] [blame] | 210 | if (SHADOW_OFFSET == 0) |
Alexey Samsonov | ee485d4 | 2013-01-21 10:51:18 +0000 | [diff] [blame] | 211 | return a <= kShadowGapEnd; |
Alexander Potapenko | 79d12e8 | 2012-07-23 08:22:27 +0000 | [diff] [blame] | 212 | return a >= kShadowGapBeg && a <= kShadowGapEnd; |
| 213 | } |
| 214 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 215 | static inline bool AddrIsAlignedByGranularity(uptr a) { |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 216 | PROFILE_ASAN_MAPPING(); |
Kostya Serebryany | 218a9b7 | 2011-11-30 18:50:23 +0000 | [diff] [blame] | 217 | return (a & (SHADOW_GRANULARITY - 1)) == 0; |
| 218 | } |
| 219 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 220 | static inline bool AddressIsPoisoned(uptr a) { |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 221 | PROFILE_ASAN_MAPPING(); |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 222 | const uptr kAccessSize = 1; |
Kostya Serebryany | a84805f | 2013-02-21 07:07:39 +0000 | [diff] [blame] | 223 | u8 *shadow_address = (u8*)MEM_TO_SHADOW(a); |
Kostya Serebryany | ee39255 | 2012-05-31 15:02:07 +0000 | [diff] [blame] | 224 | s8 shadow_value = *shadow_address; |
Kostya Serebryany | 8599762 | 2012-03-15 01:18:06 +0000 | [diff] [blame] | 225 | if (shadow_value) { |
Kostya Serebryany | ee39255 | 2012-05-31 15:02:07 +0000 | [diff] [blame] | 226 | u8 last_accessed_byte = (a & (SHADOW_GRANULARITY - 1)) |
Kostya Serebryany | 8599762 | 2012-03-15 01:18:06 +0000 | [diff] [blame] | 227 | + kAccessSize - 1; |
| 228 | return (last_accessed_byte >= shadow_value); |
| 229 | } |
| 230 | return false; |
| 231 | } |
| 232 | |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 233 | // Must be after all calls to PROFILE_ASAN_MAPPING(). |
| 234 | static const uptr kAsanMappingProfileSize = __LINE__; |
| 235 | |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 236 | } // namespace __asan |
| 237 | |
| 238 | #endif // ASAN_MAPPING_H |