xref: /netbsd-src/sys/external/bsd/compiler_rt/dist/lib/msan/msan.h (revision a7c257b03e4462df2b1020128fb82716512d7856)
1*a7c257b0Skamil //===-- msan.h --------------------------------------------------*- C++ -*-===//
2*a7c257b0Skamil //
3*a7c257b0Skamil //                     The LLVM Compiler Infrastructure
4*a7c257b0Skamil //
5*a7c257b0Skamil // This file is distributed under the University of Illinois Open Source
6*a7c257b0Skamil // License. See LICENSE.TXT for details.
7*a7c257b0Skamil //
8*a7c257b0Skamil //===----------------------------------------------------------------------===//
9*a7c257b0Skamil //
10*a7c257b0Skamil // This file is a part of MemorySanitizer.
11*a7c257b0Skamil //
12*a7c257b0Skamil // Private MSan header.
13*a7c257b0Skamil //===----------------------------------------------------------------------===//
14*a7c257b0Skamil 
15*a7c257b0Skamil #ifndef MSAN_H
16*a7c257b0Skamil #define MSAN_H
17*a7c257b0Skamil 
18*a7c257b0Skamil #include "sanitizer_common/sanitizer_flags.h"
19*a7c257b0Skamil #include "sanitizer_common/sanitizer_internal_defs.h"
20*a7c257b0Skamil #include "sanitizer_common/sanitizer_stacktrace.h"
21*a7c257b0Skamil #include "msan_interface_internal.h"
22*a7c257b0Skamil #include "msan_flags.h"
23*a7c257b0Skamil #include "ubsan/ubsan_platform.h"
24*a7c257b0Skamil 
25*a7c257b0Skamil #ifndef MSAN_REPLACE_OPERATORS_NEW_AND_DELETE
26*a7c257b0Skamil # define MSAN_REPLACE_OPERATORS_NEW_AND_DELETE 1
27*a7c257b0Skamil #endif
28*a7c257b0Skamil 
29*a7c257b0Skamil #ifndef MSAN_CONTAINS_UBSAN
30*a7c257b0Skamil # define MSAN_CONTAINS_UBSAN CAN_SANITIZE_UB
31*a7c257b0Skamil #endif
32*a7c257b0Skamil 
33*a7c257b0Skamil struct MappingDesc {
34*a7c257b0Skamil   uptr start;
35*a7c257b0Skamil   uptr end;
36*a7c257b0Skamil   enum Type {
37*a7c257b0Skamil     INVALID, APP, SHADOW, ORIGIN
38*a7c257b0Skamil   } type;
39*a7c257b0Skamil   const char *name;
40*a7c257b0Skamil };
41*a7c257b0Skamil 
42*a7c257b0Skamil 
43*a7c257b0Skamil #if SANITIZER_LINUX && defined(__mips64)
44*a7c257b0Skamil 
45*a7c257b0Skamil // MIPS64 maps:
46*a7c257b0Skamil // - 0x0000000000-0x0200000000: Program own segments
47*a7c257b0Skamil // - 0xa200000000-0xc000000000: PIE program segments
48*a7c257b0Skamil // - 0xe200000000-0xffffffffff: libraries segments.
49*a7c257b0Skamil const MappingDesc kMemoryLayout[] = {
50*a7c257b0Skamil     {0x000000000000ULL, 0x000200000000ULL, MappingDesc::APP, "app-1"},
51*a7c257b0Skamil     {0x000200000000ULL, 0x002200000000ULL, MappingDesc::INVALID, "invalid"},
52*a7c257b0Skamil     {0x002200000000ULL, 0x004000000000ULL, MappingDesc::SHADOW, "shadow-2"},
53*a7c257b0Skamil     {0x004000000000ULL, 0x004200000000ULL, MappingDesc::INVALID, "invalid"},
54*a7c257b0Skamil     {0x004200000000ULL, 0x006000000000ULL, MappingDesc::ORIGIN, "origin-2"},
55*a7c257b0Skamil     {0x006000000000ULL, 0x006200000000ULL, MappingDesc::INVALID, "invalid"},
56*a7c257b0Skamil     {0x006200000000ULL, 0x008000000000ULL, MappingDesc::SHADOW, "shadow-3"},
57*a7c257b0Skamil     {0x008000000000ULL, 0x008200000000ULL, MappingDesc::SHADOW, "shadow-1"},
58*a7c257b0Skamil     {0x008200000000ULL, 0x00a000000000ULL, MappingDesc::ORIGIN, "origin-3"},
59*a7c257b0Skamil     {0x00a000000000ULL, 0x00a200000000ULL, MappingDesc::ORIGIN, "origin-1"},
60*a7c257b0Skamil     {0x00a200000000ULL, 0x00c000000000ULL, MappingDesc::APP, "app-2"},
61*a7c257b0Skamil     {0x00c000000000ULL, 0x00e200000000ULL, MappingDesc::INVALID, "invalid"},
62*a7c257b0Skamil     {0x00e200000000ULL, 0x00ffffffffffULL, MappingDesc::APP, "app-3"}};
63*a7c257b0Skamil 
64*a7c257b0Skamil #define MEM_TO_SHADOW(mem) (((uptr)(mem)) ^ 0x8000000000ULL)
65*a7c257b0Skamil #define SHADOW_TO_ORIGIN(shadow) (((uptr)(shadow)) + 0x2000000000ULL)
66*a7c257b0Skamil 
67*a7c257b0Skamil #elif SANITIZER_LINUX && defined(__aarch64__)
68*a7c257b0Skamil 
69*a7c257b0Skamil // The mapping describes both 39-bits, 42-bits, and 48-bits VMA.  AArch64
70*a7c257b0Skamil // maps:
71*a7c257b0Skamil // - 0x0000000000000-0x0000010000000: 39/42/48-bits program own segments
72*a7c257b0Skamil // - 0x0005500000000-0x0005600000000: 39-bits PIE program segments
73*a7c257b0Skamil // - 0x0007f80000000-0x0007fffffffff: 39-bits libraries segments
74*a7c257b0Skamil // - 0x002aa00000000-0x002ab00000000: 42-bits PIE program segments
75*a7c257b0Skamil // - 0x003ff00000000-0x003ffffffffff: 42-bits libraries segments
76*a7c257b0Skamil // - 0x0aaaaa0000000-0x0aaab00000000: 48-bits PIE program segments
77*a7c257b0Skamil // - 0xffff000000000-0x1000000000000: 48-bits libraries segments
78*a7c257b0Skamil // It is fragmented in multiples segments to increase the memory available
79*a7c257b0Skamil // on 42-bits (12.21% of total VMA available for 42-bits and 13.28 for
80*a7c257b0Skamil // 39 bits). The 48-bits segments only cover the usual PIE/default segments
81*a7c257b0Skamil // plus some more segments (262144GB total, 0.39% total VMA).
82*a7c257b0Skamil const MappingDesc kMemoryLayout[] = {
83*a7c257b0Skamil     {0x00000000000ULL, 0x01000000000ULL, MappingDesc::INVALID, "invalid"},
84*a7c257b0Skamil     {0x01000000000ULL, 0x02000000000ULL, MappingDesc::SHADOW, "shadow-2"},
85*a7c257b0Skamil     {0x02000000000ULL, 0x03000000000ULL, MappingDesc::ORIGIN, "origin-2"},
86*a7c257b0Skamil     {0x03000000000ULL, 0x04000000000ULL, MappingDesc::SHADOW, "shadow-1"},
87*a7c257b0Skamil     {0x04000000000ULL, 0x05000000000ULL, MappingDesc::ORIGIN, "origin-1"},
88*a7c257b0Skamil     {0x05000000000ULL, 0x06000000000ULL, MappingDesc::APP, "app-1"},
89*a7c257b0Skamil     {0x06000000000ULL, 0x07000000000ULL, MappingDesc::INVALID, "invalid"},
90*a7c257b0Skamil     {0x07000000000ULL, 0x08000000000ULL, MappingDesc::APP, "app-2"},
91*a7c257b0Skamil     {0x08000000000ULL, 0x09000000000ULL, MappingDesc::INVALID, "invalid"},
92*a7c257b0Skamil     // The mappings below are used only for 42-bits VMA.
93*a7c257b0Skamil     {0x09000000000ULL, 0x0A000000000ULL, MappingDesc::SHADOW, "shadow-3"},
94*a7c257b0Skamil     {0x0A000000000ULL, 0x0B000000000ULL, MappingDesc::ORIGIN, "origin-3"},
95*a7c257b0Skamil     {0x0B000000000ULL, 0x0F000000000ULL, MappingDesc::INVALID, "invalid"},
96*a7c257b0Skamil     {0x0F000000000ULL, 0x10000000000ULL, MappingDesc::APP, "app-3"},
97*a7c257b0Skamil     {0x10000000000ULL, 0x11000000000ULL, MappingDesc::INVALID, "invalid"},
98*a7c257b0Skamil     {0x11000000000ULL, 0x12000000000ULL, MappingDesc::APP, "app-4"},
99*a7c257b0Skamil     {0x12000000000ULL, 0x17000000000ULL, MappingDesc::INVALID, "invalid"},
100*a7c257b0Skamil     {0x17000000000ULL, 0x18000000000ULL, MappingDesc::SHADOW, "shadow-4"},
101*a7c257b0Skamil     {0x18000000000ULL, 0x19000000000ULL, MappingDesc::ORIGIN, "origin-4"},
102*a7c257b0Skamil     {0x19000000000ULL, 0x20000000000ULL, MappingDesc::INVALID, "invalid"},
103*a7c257b0Skamil     {0x20000000000ULL, 0x21000000000ULL, MappingDesc::APP, "app-5"},
104*a7c257b0Skamil     {0x21000000000ULL, 0x26000000000ULL, MappingDesc::INVALID, "invalid"},
105*a7c257b0Skamil     {0x26000000000ULL, 0x27000000000ULL, MappingDesc::SHADOW, "shadow-5"},
106*a7c257b0Skamil     {0x27000000000ULL, 0x28000000000ULL, MappingDesc::ORIGIN, "origin-5"},
107*a7c257b0Skamil     {0x28000000000ULL, 0x29000000000ULL, MappingDesc::SHADOW, "shadow-7"},
108*a7c257b0Skamil     {0x29000000000ULL, 0x2A000000000ULL, MappingDesc::ORIGIN, "origin-7"},
109*a7c257b0Skamil     {0x2A000000000ULL, 0x2B000000000ULL, MappingDesc::APP, "app-6"},
110*a7c257b0Skamil     {0x2B000000000ULL, 0x2C000000000ULL, MappingDesc::INVALID, "invalid"},
111*a7c257b0Skamil     {0x2C000000000ULL, 0x2D000000000ULL, MappingDesc::SHADOW, "shadow-6"},
112*a7c257b0Skamil     {0x2D000000000ULL, 0x2E000000000ULL, MappingDesc::ORIGIN, "origin-6"},
113*a7c257b0Skamil     {0x2E000000000ULL, 0x2F000000000ULL, MappingDesc::APP, "app-7"},
114*a7c257b0Skamil     {0x2F000000000ULL, 0x39000000000ULL, MappingDesc::INVALID, "invalid"},
115*a7c257b0Skamil     {0x39000000000ULL, 0x3A000000000ULL, MappingDesc::SHADOW, "shadow-9"},
116*a7c257b0Skamil     {0x3A000000000ULL, 0x3B000000000ULL, MappingDesc::ORIGIN, "origin-9"},
117*a7c257b0Skamil     {0x3B000000000ULL, 0x3C000000000ULL, MappingDesc::APP, "app-8"},
118*a7c257b0Skamil     {0x3C000000000ULL, 0x3D000000000ULL, MappingDesc::INVALID, "invalid"},
119*a7c257b0Skamil     {0x3D000000000ULL, 0x3E000000000ULL, MappingDesc::SHADOW, "shadow-8"},
120*a7c257b0Skamil     {0x3E000000000ULL, 0x3F000000000ULL, MappingDesc::ORIGIN, "origin-8"},
121*a7c257b0Skamil     {0x3F000000000ULL, 0x40000000000ULL, MappingDesc::APP, "app-9"},
122*a7c257b0Skamil     // The mappings below are used only for 48-bits VMA.
123*a7c257b0Skamil     // TODO(unknown): 48-bit mapping ony covers the usual PIE, non-PIE
124*a7c257b0Skamil     // segments and some more segments totalizing 262144GB of VMA (which cover
125*a7c257b0Skamil     // only 0.32% of all 48-bit VMA). Memory avaliability can be increase by
126*a7c257b0Skamil     // adding multiple application segments like 39 and 42 mapping.
127*a7c257b0Skamil     {0x0040000000000ULL, 0x0041000000000ULL, MappingDesc::INVALID, "invalid"},
128*a7c257b0Skamil     {0x0041000000000ULL, 0x0042000000000ULL, MappingDesc::APP, "app-10"},
129*a7c257b0Skamil     {0x0042000000000ULL, 0x0047000000000ULL, MappingDesc::INVALID, "invalid"},
130*a7c257b0Skamil     {0x0047000000000ULL, 0x0048000000000ULL, MappingDesc::SHADOW, "shadow-10"},
131*a7c257b0Skamil     {0x0048000000000ULL, 0x0049000000000ULL, MappingDesc::ORIGIN, "origin-10"},
132*a7c257b0Skamil     {0x0049000000000ULL, 0x0050000000000ULL, MappingDesc::INVALID, "invalid"},
133*a7c257b0Skamil     {0x0050000000000ULL, 0x0051000000000ULL, MappingDesc::APP, "app-11"},
134*a7c257b0Skamil     {0x0051000000000ULL, 0x0056000000000ULL, MappingDesc::INVALID, "invalid"},
135*a7c257b0Skamil     {0x0056000000000ULL, 0x0057000000000ULL, MappingDesc::SHADOW, "shadow-11"},
136*a7c257b0Skamil     {0x0057000000000ULL, 0x0058000000000ULL, MappingDesc::ORIGIN, "origin-11"},
137*a7c257b0Skamil     {0x0058000000000ULL, 0x0059000000000ULL, MappingDesc::APP, "app-12"},
138*a7c257b0Skamil     {0x0059000000000ULL, 0x005E000000000ULL, MappingDesc::INVALID, "invalid"},
139*a7c257b0Skamil     {0x005E000000000ULL, 0x005F000000000ULL, MappingDesc::SHADOW, "shadow-12"},
140*a7c257b0Skamil     {0x005F000000000ULL, 0x0060000000000ULL, MappingDesc::ORIGIN, "origin-12"},
141*a7c257b0Skamil     {0x0060000000000ULL, 0x0061000000000ULL, MappingDesc::INVALID, "invalid"},
142*a7c257b0Skamil     {0x0061000000000ULL, 0x0062000000000ULL, MappingDesc::APP, "app-13"},
143*a7c257b0Skamil     {0x0062000000000ULL, 0x0067000000000ULL, MappingDesc::INVALID, "invalid"},
144*a7c257b0Skamil     {0x0067000000000ULL, 0x0068000000000ULL, MappingDesc::SHADOW, "shadow-13"},
145*a7c257b0Skamil     {0x0068000000000ULL, 0x0069000000000ULL, MappingDesc::ORIGIN, "origin-13"},
146*a7c257b0Skamil     {0x0069000000000ULL, 0x0AAAAA0000000ULL, MappingDesc::INVALID, "invalid"},
147*a7c257b0Skamil     {0x0AAAAA0000000ULL, 0x0AAAB00000000ULL, MappingDesc::APP, "app-14"},
148*a7c257b0Skamil     {0x0AAAB00000000ULL, 0x0AACAA0000000ULL, MappingDesc::INVALID, "invalid"},
149*a7c257b0Skamil     {0x0AACAA0000000ULL, 0x0AACB00000000ULL, MappingDesc::SHADOW, "shadow-14"},
150*a7c257b0Skamil     {0x0AACB00000000ULL, 0x0AADAA0000000ULL, MappingDesc::INVALID, "invalid"},
151*a7c257b0Skamil     {0x0AADAA0000000ULL, 0x0AADB00000000ULL, MappingDesc::ORIGIN, "origin-14"},
152*a7c257b0Skamil     {0x0AADB00000000ULL, 0x0FF9F00000000ULL, MappingDesc::INVALID, "invalid"},
153*a7c257b0Skamil     {0x0FF9F00000000ULL, 0x0FFA000000000ULL, MappingDesc::SHADOW, "shadow-15"},
154*a7c257b0Skamil     {0x0FFA000000000ULL, 0x0FFAF00000000ULL, MappingDesc::INVALID, "invalid"},
155*a7c257b0Skamil     {0x0FFAF00000000ULL, 0x0FFB000000000ULL, MappingDesc::ORIGIN, "origin-15"},
156*a7c257b0Skamil     {0x0FFB000000000ULL, 0x0FFFF00000000ULL, MappingDesc::INVALID, "invalid"},
157*a7c257b0Skamil     {0x0FFFF00000000ULL, 0x1000000000000ULL, MappingDesc::APP, "app-15"},
158*a7c257b0Skamil };
159*a7c257b0Skamil # define MEM_TO_SHADOW(mem) ((uptr)mem ^ 0x6000000000ULL)
160*a7c257b0Skamil # define SHADOW_TO_ORIGIN(shadow) (((uptr)(shadow)) + 0x1000000000ULL)
161*a7c257b0Skamil 
162*a7c257b0Skamil #elif SANITIZER_LINUX && SANITIZER_PPC64
163*a7c257b0Skamil const MappingDesc kMemoryLayout[] = {
164*a7c257b0Skamil     {0x000000000000ULL, 0x000200000000ULL, MappingDesc::APP, "low memory"},
165*a7c257b0Skamil     {0x000200000000ULL, 0x080000000000ULL, MappingDesc::INVALID, "invalid"},
166*a7c257b0Skamil     {0x080000000000ULL, 0x180200000000ULL, MappingDesc::SHADOW, "shadow"},
167*a7c257b0Skamil     {0x180200000000ULL, 0x1C0000000000ULL, MappingDesc::INVALID, "invalid"},
168*a7c257b0Skamil     {0x1C0000000000ULL, 0x2C0200000000ULL, MappingDesc::ORIGIN, "origin"},
169*a7c257b0Skamil     {0x2C0200000000ULL, 0x300000000000ULL, MappingDesc::INVALID, "invalid"},
170*a7c257b0Skamil     {0x300000000000ULL, 0x800000000000ULL, MappingDesc::APP, "high memory"}};
171*a7c257b0Skamil 
172*a7c257b0Skamil // Various kernels use different low end ranges but we can combine them into one
173*a7c257b0Skamil // big range. They also use different high end ranges but we can map them all to
174*a7c257b0Skamil // one range.
175*a7c257b0Skamil // Maps low and high app ranges to contiguous space with zero base:
176*a7c257b0Skamil //   Low:  0000 0000 0000 - 0001 ffff ffff  ->  1000 0000 0000 - 1001 ffff ffff
177*a7c257b0Skamil //   High: 3000 0000 0000 - 3fff ffff ffff  ->  0000 0000 0000 - 0fff ffff ffff
178*a7c257b0Skamil //   High: 4000 0000 0000 - 4fff ffff ffff  ->  0000 0000 0000 - 0fff ffff ffff
179*a7c257b0Skamil //   High: 7000 0000 0000 - 7fff ffff ffff  ->  0000 0000 0000 - 0fff ffff ffff
180*a7c257b0Skamil #define LINEARIZE_MEM(mem) \
181*a7c257b0Skamil   (((uptr)(mem) & ~0xE00000000000ULL) ^ 0x100000000000ULL)
182*a7c257b0Skamil #define MEM_TO_SHADOW(mem) (LINEARIZE_MEM((mem)) + 0x080000000000ULL)
183*a7c257b0Skamil #define SHADOW_TO_ORIGIN(shadow) (((uptr)(shadow)) + 0x140000000000ULL)
184*a7c257b0Skamil 
185*a7c257b0Skamil #elif SANITIZER_FREEBSD && SANITIZER_WORDSIZE == 64
186*a7c257b0Skamil 
187*a7c257b0Skamil // Low memory: main binary, MAP_32BIT mappings and modules
188*a7c257b0Skamil // High memory: heap, modules and main thread stack
189*a7c257b0Skamil const MappingDesc kMemoryLayout[] = {
190*a7c257b0Skamil     {0x000000000000ULL, 0x010000000000ULL, MappingDesc::APP, "low memory"},
191*a7c257b0Skamil     {0x010000000000ULL, 0x100000000000ULL, MappingDesc::INVALID, "invalid"},
192*a7c257b0Skamil     {0x100000000000ULL, 0x310000000000ULL, MappingDesc::SHADOW, "shadow"},
193*a7c257b0Skamil     {0x310000000000ULL, 0x380000000000ULL, MappingDesc::INVALID, "invalid"},
194*a7c257b0Skamil     {0x380000000000ULL, 0x590000000000ULL, MappingDesc::ORIGIN, "origin"},
195*a7c257b0Skamil     {0x590000000000ULL, 0x600000000000ULL, MappingDesc::INVALID, "invalid"},
196*a7c257b0Skamil     {0x600000000000ULL, 0x800000000000ULL, MappingDesc::APP, "high memory"}};
197*a7c257b0Skamil 
198*a7c257b0Skamil // Maps low and high app ranges to contiguous space with zero base:
199*a7c257b0Skamil //   Low:  0000 0000 0000 - 00ff ffff ffff  ->  2000 0000 0000 - 20ff ffff ffff
200*a7c257b0Skamil //   High: 6000 0000 0000 - 7fff ffff ffff  ->  0000 0000 0000 - 1fff ffff ffff
201*a7c257b0Skamil #define LINEARIZE_MEM(mem) \
202*a7c257b0Skamil   (((uptr)(mem) & ~0xc00000000000ULL) ^ 0x200000000000ULL)
203*a7c257b0Skamil #define MEM_TO_SHADOW(mem) (LINEARIZE_MEM((mem)) + 0x100000000000ULL)
204*a7c257b0Skamil #define SHADOW_TO_ORIGIN(shadow) (((uptr)(shadow)) + 0x280000000000)
205*a7c257b0Skamil 
206*a7c257b0Skamil #elif SANITIZER_NETBSD || (SANITIZER_LINUX && SANITIZER_WORDSIZE == 64)
207*a7c257b0Skamil 
208*a7c257b0Skamil #ifdef MSAN_LINUX_X86_64_OLD_MAPPING
209*a7c257b0Skamil // Requries PIE binary and ASLR enabled.
210*a7c257b0Skamil // Main thread stack and DSOs at 0x7f0000000000 (sometimes 0x7e0000000000).
211*a7c257b0Skamil // Heap at 0x600000000000.
212*a7c257b0Skamil const MappingDesc kMemoryLayout[] = {
213*a7c257b0Skamil     {0x000000000000ULL, 0x200000000000ULL, MappingDesc::INVALID, "invalid"},
214*a7c257b0Skamil     {0x200000000000ULL, 0x400000000000ULL, MappingDesc::SHADOW, "shadow"},
215*a7c257b0Skamil     {0x400000000000ULL, 0x600000000000ULL, MappingDesc::ORIGIN, "origin"},
216*a7c257b0Skamil     {0x600000000000ULL, 0x800000000000ULL, MappingDesc::APP, "app"}};
217*a7c257b0Skamil 
218*a7c257b0Skamil #define MEM_TO_SHADOW(mem) (((uptr)(mem)) & ~0x400000000000ULL)
219*a7c257b0Skamil #define SHADOW_TO_ORIGIN(mem) (((uptr)(mem)) + 0x200000000000ULL)
220*a7c257b0Skamil #else  // MSAN_LINUX_X86_64_OLD_MAPPING
221*a7c257b0Skamil // All of the following configurations are supported.
222*a7c257b0Skamil // ASLR disabled: main executable and DSOs at 0x555550000000
223*a7c257b0Skamil // PIE and ASLR: main executable and DSOs at 0x7f0000000000
224*a7c257b0Skamil // non-PIE: main executable below 0x100000000, DSOs at 0x7f0000000000
225*a7c257b0Skamil // Heap at 0x700000000000.
226*a7c257b0Skamil const MappingDesc kMemoryLayout[] = {
227*a7c257b0Skamil     {0x000000000000ULL, 0x010000000000ULL, MappingDesc::APP, "app-1"},
228*a7c257b0Skamil     {0x010000000000ULL, 0x100000000000ULL, MappingDesc::SHADOW, "shadow-2"},
229*a7c257b0Skamil     {0x100000000000ULL, 0x110000000000ULL, MappingDesc::INVALID, "invalid"},
230*a7c257b0Skamil     {0x110000000000ULL, 0x200000000000ULL, MappingDesc::ORIGIN, "origin-2"},
231*a7c257b0Skamil     {0x200000000000ULL, 0x300000000000ULL, MappingDesc::SHADOW, "shadow-3"},
232*a7c257b0Skamil     {0x300000000000ULL, 0x400000000000ULL, MappingDesc::ORIGIN, "origin-3"},
233*a7c257b0Skamil     {0x400000000000ULL, 0x500000000000ULL, MappingDesc::INVALID, "invalid"},
234*a7c257b0Skamil     {0x500000000000ULL, 0x510000000000ULL, MappingDesc::SHADOW, "shadow-1"},
235*a7c257b0Skamil     {0x510000000000ULL, 0x600000000000ULL, MappingDesc::APP, "app-2"},
236*a7c257b0Skamil     {0x600000000000ULL, 0x610000000000ULL, MappingDesc::ORIGIN, "origin-1"},
237*a7c257b0Skamil     {0x610000000000ULL, 0x700000000000ULL, MappingDesc::INVALID, "invalid"},
238*a7c257b0Skamil     {0x700000000000ULL, 0x800000000000ULL, MappingDesc::APP, "app-3"}};
239*a7c257b0Skamil #define MEM_TO_SHADOW(mem) (((uptr)(mem)) ^ 0x500000000000ULL)
240*a7c257b0Skamil #define SHADOW_TO_ORIGIN(mem) (((uptr)(mem)) + 0x100000000000ULL)
241*a7c257b0Skamil #endif  // MSAN_LINUX_X86_64_OLD_MAPPING
242*a7c257b0Skamil 
243*a7c257b0Skamil #else
244*a7c257b0Skamil #error "Unsupported platform"
245*a7c257b0Skamil #endif
246*a7c257b0Skamil 
247*a7c257b0Skamil const uptr kMemoryLayoutSize = sizeof(kMemoryLayout) / sizeof(kMemoryLayout[0]);
248*a7c257b0Skamil 
249*a7c257b0Skamil #define MEM_TO_ORIGIN(mem) (SHADOW_TO_ORIGIN(MEM_TO_SHADOW((mem))))
250*a7c257b0Skamil 
251*a7c257b0Skamil #ifndef __clang__
252*a7c257b0Skamil __attribute__((optimize("unroll-loops")))
253*a7c257b0Skamil #endif
addr_is_type(uptr addr,MappingDesc::Type mapping_type)254*a7c257b0Skamil inline bool addr_is_type(uptr addr, MappingDesc::Type mapping_type) {
255*a7c257b0Skamil // It is critical for performance that this loop is unrolled (because then it is
256*a7c257b0Skamil // simplified into just a few constant comparisons).
257*a7c257b0Skamil #ifdef __clang__
258*a7c257b0Skamil #pragma unroll
259*a7c257b0Skamil #endif
260*a7c257b0Skamil   for (unsigned i = 0; i < kMemoryLayoutSize; ++i)
261*a7c257b0Skamil     if (kMemoryLayout[i].type == mapping_type &&
262*a7c257b0Skamil         addr >= kMemoryLayout[i].start && addr < kMemoryLayout[i].end)
263*a7c257b0Skamil       return true;
264*a7c257b0Skamil   return false;
265*a7c257b0Skamil }
266*a7c257b0Skamil 
267*a7c257b0Skamil #define MEM_IS_APP(mem) addr_is_type((uptr)(mem), MappingDesc::APP)
268*a7c257b0Skamil #define MEM_IS_SHADOW(mem) addr_is_type((uptr)(mem), MappingDesc::SHADOW)
269*a7c257b0Skamil #define MEM_IS_ORIGIN(mem) addr_is_type((uptr)(mem), MappingDesc::ORIGIN)
270*a7c257b0Skamil 
271*a7c257b0Skamil // These constants must be kept in sync with the ones in MemorySanitizer.cc.
272*a7c257b0Skamil const int kMsanParamTlsSize = 800;
273*a7c257b0Skamil const int kMsanRetvalTlsSize = 800;
274*a7c257b0Skamil 
275*a7c257b0Skamil namespace __msan {
276*a7c257b0Skamil extern int msan_inited;
277*a7c257b0Skamil extern bool msan_init_is_running;
278*a7c257b0Skamil extern int msan_report_count;
279*a7c257b0Skamil 
280*a7c257b0Skamil bool ProtectRange(uptr beg, uptr end);
281*a7c257b0Skamil bool InitShadow(bool init_origins);
282*a7c257b0Skamil char *GetProcSelfMaps();
283*a7c257b0Skamil void InitializeInterceptors();
284*a7c257b0Skamil 
285*a7c257b0Skamil void MsanAllocatorInit();
286*a7c257b0Skamil void MsanAllocatorThreadFinish();
287*a7c257b0Skamil void MsanDeallocate(StackTrace *stack, void *ptr);
288*a7c257b0Skamil 
289*a7c257b0Skamil void *msan_malloc(uptr size, StackTrace *stack);
290*a7c257b0Skamil void *msan_calloc(uptr nmemb, uptr size, StackTrace *stack);
291*a7c257b0Skamil void *msan_realloc(void *ptr, uptr size, StackTrace *stack);
292*a7c257b0Skamil void *msan_valloc(uptr size, StackTrace *stack);
293*a7c257b0Skamil void *msan_pvalloc(uptr size, StackTrace *stack);
294*a7c257b0Skamil void *msan_aligned_alloc(uptr alignment, uptr size, StackTrace *stack);
295*a7c257b0Skamil void *msan_memalign(uptr alignment, uptr size, StackTrace *stack);
296*a7c257b0Skamil int msan_posix_memalign(void **memptr, uptr alignment, uptr size,
297*a7c257b0Skamil                         StackTrace *stack);
298*a7c257b0Skamil 
299*a7c257b0Skamil void InstallTrapHandler();
300*a7c257b0Skamil void InstallAtExitHandler();
301*a7c257b0Skamil 
302*a7c257b0Skamil const char *GetStackOriginDescr(u32 id, uptr *pc);
303*a7c257b0Skamil 
304*a7c257b0Skamil void EnterSymbolizer();
305*a7c257b0Skamil void ExitSymbolizer();
306*a7c257b0Skamil bool IsInSymbolizer();
307*a7c257b0Skamil 
308*a7c257b0Skamil struct SymbolizerScope {
SymbolizerScopeSymbolizerScope309*a7c257b0Skamil   SymbolizerScope() { EnterSymbolizer(); }
~SymbolizerScopeSymbolizerScope310*a7c257b0Skamil   ~SymbolizerScope() { ExitSymbolizer(); }
311*a7c257b0Skamil };
312*a7c257b0Skamil 
313*a7c257b0Skamil void PrintWarning(uptr pc, uptr bp);
314*a7c257b0Skamil void PrintWarningWithOrigin(uptr pc, uptr bp, u32 origin);
315*a7c257b0Skamil 
316*a7c257b0Skamil void GetStackTrace(BufferedStackTrace *stack, uptr max_s, uptr pc, uptr bp,
317*a7c257b0Skamil                    void *context, bool request_fast_unwind);
318*a7c257b0Skamil 
319*a7c257b0Skamil // Unpoison first n function arguments.
320*a7c257b0Skamil void UnpoisonParam(uptr n);
321*a7c257b0Skamil void UnpoisonThreadLocalState();
322*a7c257b0Skamil 
323*a7c257b0Skamil // Returns a "chained" origin id, pointing to the given stack trace followed by
324*a7c257b0Skamil // the previous origin id.
325*a7c257b0Skamil u32 ChainOrigin(u32 id, StackTrace *stack);
326*a7c257b0Skamil 
327*a7c257b0Skamil const int STACK_TRACE_TAG_POISON = StackTrace::TAG_CUSTOM + 1;
328*a7c257b0Skamil 
329*a7c257b0Skamil #define GET_MALLOC_STACK_TRACE                                            \
330*a7c257b0Skamil   BufferedStackTrace stack;                                               \
331*a7c257b0Skamil   if (__msan_get_track_origins() && msan_inited)                          \
332*a7c257b0Skamil   GetStackTrace(&stack, common_flags()->malloc_context_size,              \
333*a7c257b0Skamil                 StackTrace::GetCurrentPc(), GET_CURRENT_FRAME(), nullptr, \
334*a7c257b0Skamil                 common_flags()->fast_unwind_on_malloc)
335*a7c257b0Skamil 
336*a7c257b0Skamil // For platforms which support slow unwinder only, we restrict the store context
337*a7c257b0Skamil // size to 1, basically only storing the current pc. We do this because the slow
338*a7c257b0Skamil // unwinder which is based on libunwind is not async signal safe and causes
339*a7c257b0Skamil // random freezes in forking applications as well as in signal handlers.
340*a7c257b0Skamil #define GET_STORE_STACK_TRACE_PC_BP(pc, bp)                               \
341*a7c257b0Skamil   BufferedStackTrace stack;                                               \
342*a7c257b0Skamil   if (__msan_get_track_origins() > 1 && msan_inited) {                    \
343*a7c257b0Skamil     if (!SANITIZER_CAN_FAST_UNWIND)                                       \
344*a7c257b0Skamil       GetStackTrace(&stack, Min(1, flags()->store_context_size), pc, bp,  \
345*a7c257b0Skamil                     nullptr, false);                                      \
346*a7c257b0Skamil     else                                                                  \
347*a7c257b0Skamil       GetStackTrace(&stack, flags()->store_context_size, pc, bp, nullptr, \
348*a7c257b0Skamil                     common_flags()->fast_unwind_on_malloc);               \
349*a7c257b0Skamil   }
350*a7c257b0Skamil 
351*a7c257b0Skamil #define GET_STORE_STACK_TRACE \
352*a7c257b0Skamil   GET_STORE_STACK_TRACE_PC_BP(StackTrace::GetCurrentPc(), GET_CURRENT_FRAME())
353*a7c257b0Skamil 
354*a7c257b0Skamil #define GET_FATAL_STACK_TRACE_PC_BP(pc, bp)              \
355*a7c257b0Skamil   BufferedStackTrace stack;                              \
356*a7c257b0Skamil   if (msan_inited)                                       \
357*a7c257b0Skamil   GetStackTrace(&stack, kStackTraceMax, pc, bp, nullptr, \
358*a7c257b0Skamil                 common_flags()->fast_unwind_on_fatal)
359*a7c257b0Skamil 
360*a7c257b0Skamil #define GET_FATAL_STACK_TRACE_HERE \
361*a7c257b0Skamil   GET_FATAL_STACK_TRACE_PC_BP(StackTrace::GetCurrentPc(), GET_CURRENT_FRAME())
362*a7c257b0Skamil 
363*a7c257b0Skamil #define PRINT_CURRENT_STACK_CHECK() \
364*a7c257b0Skamil   {                                 \
365*a7c257b0Skamil     GET_FATAL_STACK_TRACE_HERE;     \
366*a7c257b0Skamil     stack.Print();                  \
367*a7c257b0Skamil   }
368*a7c257b0Skamil 
369*a7c257b0Skamil class ScopedThreadLocalStateBackup {
370*a7c257b0Skamil  public:
ScopedThreadLocalStateBackup()371*a7c257b0Skamil   ScopedThreadLocalStateBackup() { Backup(); }
~ScopedThreadLocalStateBackup()372*a7c257b0Skamil   ~ScopedThreadLocalStateBackup() { Restore(); }
373*a7c257b0Skamil   void Backup();
374*a7c257b0Skamil   void Restore();
375*a7c257b0Skamil  private:
376*a7c257b0Skamil   u64 va_arg_overflow_size_tls;
377*a7c257b0Skamil };
378*a7c257b0Skamil 
379*a7c257b0Skamil void MsanTSDInit(void (*destructor)(void *tsd));
380*a7c257b0Skamil void *MsanTSDGet();
381*a7c257b0Skamil void MsanTSDSet(void *tsd);
382*a7c257b0Skamil void MsanTSDDtor(void *tsd);
383*a7c257b0Skamil 
384*a7c257b0Skamil }  // namespace __msan
385*a7c257b0Skamil 
386*a7c257b0Skamil #define MSAN_MALLOC_HOOK(ptr, size)       \
387*a7c257b0Skamil   do {                                    \
388*a7c257b0Skamil     if (&__sanitizer_malloc_hook) {       \
389*a7c257b0Skamil       UnpoisonParam(2);                   \
390*a7c257b0Skamil       __sanitizer_malloc_hook(ptr, size); \
391*a7c257b0Skamil     }                                     \
392*a7c257b0Skamil     RunMallocHooks(ptr, size);            \
393*a7c257b0Skamil   } while (false)
394*a7c257b0Skamil #define MSAN_FREE_HOOK(ptr)       \
395*a7c257b0Skamil   do {                            \
396*a7c257b0Skamil     if (&__sanitizer_free_hook) { \
397*a7c257b0Skamil       UnpoisonParam(1);           \
398*a7c257b0Skamil       __sanitizer_free_hook(ptr); \
399*a7c257b0Skamil     }                             \
400*a7c257b0Skamil     RunFreeHooks(ptr);            \
401*a7c257b0Skamil   } while (false)
402*a7c257b0Skamil 
403*a7c257b0Skamil #endif  // MSAN_H
404