10b57cec5SDimitry Andric //===-- msan.h --------------------------------------------------*- C++ -*-===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // This file is a part of MemorySanitizer.
100b57cec5SDimitry Andric //
110b57cec5SDimitry Andric // Private MSan header.
120b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
130b57cec5SDimitry Andric 
140b57cec5SDimitry Andric #ifndef MSAN_H
150b57cec5SDimitry Andric #define MSAN_H
160b57cec5SDimitry Andric 
170b57cec5SDimitry Andric #include "sanitizer_common/sanitizer_flags.h"
180b57cec5SDimitry Andric #include "sanitizer_common/sanitizer_internal_defs.h"
190b57cec5SDimitry Andric #include "sanitizer_common/sanitizer_stacktrace.h"
200b57cec5SDimitry Andric #include "msan_interface_internal.h"
210b57cec5SDimitry Andric #include "msan_flags.h"
220b57cec5SDimitry Andric #include "ubsan/ubsan_platform.h"
230b57cec5SDimitry Andric 
240b57cec5SDimitry Andric #ifndef MSAN_REPLACE_OPERATORS_NEW_AND_DELETE
250b57cec5SDimitry Andric # define MSAN_REPLACE_OPERATORS_NEW_AND_DELETE 1
260b57cec5SDimitry Andric #endif
270b57cec5SDimitry Andric 
280b57cec5SDimitry Andric #ifndef MSAN_CONTAINS_UBSAN
290b57cec5SDimitry Andric # define MSAN_CONTAINS_UBSAN CAN_SANITIZE_UB
300b57cec5SDimitry Andric #endif
310b57cec5SDimitry Andric 
320b57cec5SDimitry Andric struct MappingDesc {
330b57cec5SDimitry Andric   uptr start;
340b57cec5SDimitry Andric   uptr end;
350b57cec5SDimitry Andric   enum Type {
360b57cec5SDimitry Andric     INVALID, APP, SHADOW, ORIGIN
370b57cec5SDimitry Andric   } type;
380b57cec5SDimitry Andric   const char *name;
390b57cec5SDimitry Andric };
400b57cec5SDimitry Andric 
410b57cec5SDimitry Andric 
420b57cec5SDimitry Andric #if SANITIZER_LINUX && defined(__mips64)
430b57cec5SDimitry Andric 
440b57cec5SDimitry Andric // MIPS64 maps:
450b57cec5SDimitry Andric // - 0x0000000000-0x0200000000: Program own segments
460b57cec5SDimitry Andric // - 0xa200000000-0xc000000000: PIE program segments
470b57cec5SDimitry Andric // - 0xe200000000-0xffffffffff: libraries segments.
480b57cec5SDimitry Andric const MappingDesc kMemoryLayout[] = {
490b57cec5SDimitry Andric     {0x000000000000ULL, 0x000200000000ULL, MappingDesc::APP, "app-1"},
500b57cec5SDimitry Andric     {0x000200000000ULL, 0x002200000000ULL, MappingDesc::INVALID, "invalid"},
510b57cec5SDimitry Andric     {0x002200000000ULL, 0x004000000000ULL, MappingDesc::SHADOW, "shadow-2"},
520b57cec5SDimitry Andric     {0x004000000000ULL, 0x004200000000ULL, MappingDesc::INVALID, "invalid"},
530b57cec5SDimitry Andric     {0x004200000000ULL, 0x006000000000ULL, MappingDesc::ORIGIN, "origin-2"},
540b57cec5SDimitry Andric     {0x006000000000ULL, 0x006200000000ULL, MappingDesc::INVALID, "invalid"},
550b57cec5SDimitry Andric     {0x006200000000ULL, 0x008000000000ULL, MappingDesc::SHADOW, "shadow-3"},
560b57cec5SDimitry Andric     {0x008000000000ULL, 0x008200000000ULL, MappingDesc::SHADOW, "shadow-1"},
570b57cec5SDimitry Andric     {0x008200000000ULL, 0x00a000000000ULL, MappingDesc::ORIGIN, "origin-3"},
580b57cec5SDimitry Andric     {0x00a000000000ULL, 0x00a200000000ULL, MappingDesc::ORIGIN, "origin-1"},
590b57cec5SDimitry Andric     {0x00a200000000ULL, 0x00c000000000ULL, MappingDesc::APP, "app-2"},
600b57cec5SDimitry Andric     {0x00c000000000ULL, 0x00e200000000ULL, MappingDesc::INVALID, "invalid"},
610b57cec5SDimitry Andric     {0x00e200000000ULL, 0x00ffffffffffULL, MappingDesc::APP, "app-3"}};
620b57cec5SDimitry Andric 
630b57cec5SDimitry Andric #define MEM_TO_SHADOW(mem) (((uptr)(mem)) ^ 0x8000000000ULL)
640b57cec5SDimitry Andric #define SHADOW_TO_ORIGIN(shadow) (((uptr)(shadow)) + 0x2000000000ULL)
650b57cec5SDimitry Andric 
660b57cec5SDimitry Andric #elif SANITIZER_LINUX && defined(__aarch64__)
670b57cec5SDimitry Andric 
680b57cec5SDimitry Andric // The mapping describes both 39-bits, 42-bits, and 48-bits VMA.  AArch64
690b57cec5SDimitry Andric // maps:
700b57cec5SDimitry Andric // - 0x0000000000000-0x0000010000000: 39/42/48-bits program own segments
710b57cec5SDimitry Andric // - 0x0005500000000-0x0005600000000: 39-bits PIE program segments
720b57cec5SDimitry Andric // - 0x0007f80000000-0x0007fffffffff: 39-bits libraries segments
730b57cec5SDimitry Andric // - 0x002aa00000000-0x002ab00000000: 42-bits PIE program segments
740b57cec5SDimitry Andric // - 0x003ff00000000-0x003ffffffffff: 42-bits libraries segments
750b57cec5SDimitry Andric // - 0x0aaaaa0000000-0x0aaab00000000: 48-bits PIE program segments
760b57cec5SDimitry Andric // - 0xffff000000000-0x1000000000000: 48-bits libraries segments
770b57cec5SDimitry Andric // It is fragmented in multiples segments to increase the memory available
780b57cec5SDimitry Andric // on 42-bits (12.21% of total VMA available for 42-bits and 13.28 for
790b57cec5SDimitry Andric // 39 bits). The 48-bits segments only cover the usual PIE/default segments
800b57cec5SDimitry Andric // plus some more segments (262144GB total, 0.39% total VMA).
810b57cec5SDimitry Andric const MappingDesc kMemoryLayout[] = {
820b57cec5SDimitry Andric     {0x00000000000ULL, 0x01000000000ULL, MappingDesc::INVALID, "invalid"},
830b57cec5SDimitry Andric     {0x01000000000ULL, 0x02000000000ULL, MappingDesc::SHADOW, "shadow-2"},
840b57cec5SDimitry Andric     {0x02000000000ULL, 0x03000000000ULL, MappingDesc::ORIGIN, "origin-2"},
850b57cec5SDimitry Andric     {0x03000000000ULL, 0x04000000000ULL, MappingDesc::SHADOW, "shadow-1"},
860b57cec5SDimitry Andric     {0x04000000000ULL, 0x05000000000ULL, MappingDesc::ORIGIN, "origin-1"},
870b57cec5SDimitry Andric     {0x05000000000ULL, 0x06000000000ULL, MappingDesc::APP, "app-1"},
880b57cec5SDimitry Andric     {0x06000000000ULL, 0x07000000000ULL, MappingDesc::INVALID, "invalid"},
890b57cec5SDimitry Andric     {0x07000000000ULL, 0x08000000000ULL, MappingDesc::APP, "app-2"},
900b57cec5SDimitry Andric     {0x08000000000ULL, 0x09000000000ULL, MappingDesc::INVALID, "invalid"},
910b57cec5SDimitry Andric     // The mappings below are used only for 42-bits VMA.
920b57cec5SDimitry Andric     {0x09000000000ULL, 0x0A000000000ULL, MappingDesc::SHADOW, "shadow-3"},
930b57cec5SDimitry Andric     {0x0A000000000ULL, 0x0B000000000ULL, MappingDesc::ORIGIN, "origin-3"},
940b57cec5SDimitry Andric     {0x0B000000000ULL, 0x0F000000000ULL, MappingDesc::INVALID, "invalid"},
950b57cec5SDimitry Andric     {0x0F000000000ULL, 0x10000000000ULL, MappingDesc::APP, "app-3"},
960b57cec5SDimitry Andric     {0x10000000000ULL, 0x11000000000ULL, MappingDesc::INVALID, "invalid"},
970b57cec5SDimitry Andric     {0x11000000000ULL, 0x12000000000ULL, MappingDesc::APP, "app-4"},
980b57cec5SDimitry Andric     {0x12000000000ULL, 0x17000000000ULL, MappingDesc::INVALID, "invalid"},
990b57cec5SDimitry Andric     {0x17000000000ULL, 0x18000000000ULL, MappingDesc::SHADOW, "shadow-4"},
1000b57cec5SDimitry Andric     {0x18000000000ULL, 0x19000000000ULL, MappingDesc::ORIGIN, "origin-4"},
1010b57cec5SDimitry Andric     {0x19000000000ULL, 0x20000000000ULL, MappingDesc::INVALID, "invalid"},
1020b57cec5SDimitry Andric     {0x20000000000ULL, 0x21000000000ULL, MappingDesc::APP, "app-5"},
1030b57cec5SDimitry Andric     {0x21000000000ULL, 0x26000000000ULL, MappingDesc::INVALID, "invalid"},
1040b57cec5SDimitry Andric     {0x26000000000ULL, 0x27000000000ULL, MappingDesc::SHADOW, "shadow-5"},
1050b57cec5SDimitry Andric     {0x27000000000ULL, 0x28000000000ULL, MappingDesc::ORIGIN, "origin-5"},
1060b57cec5SDimitry Andric     {0x28000000000ULL, 0x29000000000ULL, MappingDesc::SHADOW, "shadow-7"},
1070b57cec5SDimitry Andric     {0x29000000000ULL, 0x2A000000000ULL, MappingDesc::ORIGIN, "origin-7"},
1080b57cec5SDimitry Andric     {0x2A000000000ULL, 0x2B000000000ULL, MappingDesc::APP, "app-6"},
1090b57cec5SDimitry Andric     {0x2B000000000ULL, 0x2C000000000ULL, MappingDesc::INVALID, "invalid"},
1100b57cec5SDimitry Andric     {0x2C000000000ULL, 0x2D000000000ULL, MappingDesc::SHADOW, "shadow-6"},
1110b57cec5SDimitry Andric     {0x2D000000000ULL, 0x2E000000000ULL, MappingDesc::ORIGIN, "origin-6"},
1120b57cec5SDimitry Andric     {0x2E000000000ULL, 0x2F000000000ULL, MappingDesc::APP, "app-7"},
1130b57cec5SDimitry Andric     {0x2F000000000ULL, 0x39000000000ULL, MappingDesc::INVALID, "invalid"},
1140b57cec5SDimitry Andric     {0x39000000000ULL, 0x3A000000000ULL, MappingDesc::SHADOW, "shadow-9"},
1150b57cec5SDimitry Andric     {0x3A000000000ULL, 0x3B000000000ULL, MappingDesc::ORIGIN, "origin-9"},
1160b57cec5SDimitry Andric     {0x3B000000000ULL, 0x3C000000000ULL, MappingDesc::APP, "app-8"},
1170b57cec5SDimitry Andric     {0x3C000000000ULL, 0x3D000000000ULL, MappingDesc::INVALID, "invalid"},
1180b57cec5SDimitry Andric     {0x3D000000000ULL, 0x3E000000000ULL, MappingDesc::SHADOW, "shadow-8"},
1190b57cec5SDimitry Andric     {0x3E000000000ULL, 0x3F000000000ULL, MappingDesc::ORIGIN, "origin-8"},
1200b57cec5SDimitry Andric     {0x3F000000000ULL, 0x40000000000ULL, MappingDesc::APP, "app-9"},
1210b57cec5SDimitry Andric     // The mappings below are used only for 48-bits VMA.
1220b57cec5SDimitry Andric     // TODO(unknown): 48-bit mapping ony covers the usual PIE, non-PIE
1230b57cec5SDimitry Andric     // segments and some more segments totalizing 262144GB of VMA (which cover
124349cc55cSDimitry Andric     // only 0.32% of all 48-bit VMA). Memory availability can be increase by
1250b57cec5SDimitry Andric     // adding multiple application segments like 39 and 42 mapping.
1260b57cec5SDimitry Andric     {0x0040000000000ULL, 0x0041000000000ULL, MappingDesc::INVALID, "invalid"},
1270b57cec5SDimitry Andric     {0x0041000000000ULL, 0x0042000000000ULL, MappingDesc::APP, "app-10"},
1280b57cec5SDimitry Andric     {0x0042000000000ULL, 0x0047000000000ULL, MappingDesc::INVALID, "invalid"},
1290b57cec5SDimitry Andric     {0x0047000000000ULL, 0x0048000000000ULL, MappingDesc::SHADOW, "shadow-10"},
1300b57cec5SDimitry Andric     {0x0048000000000ULL, 0x0049000000000ULL, MappingDesc::ORIGIN, "origin-10"},
1310b57cec5SDimitry Andric     {0x0049000000000ULL, 0x0050000000000ULL, MappingDesc::INVALID, "invalid"},
1320b57cec5SDimitry Andric     {0x0050000000000ULL, 0x0051000000000ULL, MappingDesc::APP, "app-11"},
1330b57cec5SDimitry Andric     {0x0051000000000ULL, 0x0056000000000ULL, MappingDesc::INVALID, "invalid"},
1340b57cec5SDimitry Andric     {0x0056000000000ULL, 0x0057000000000ULL, MappingDesc::SHADOW, "shadow-11"},
1350b57cec5SDimitry Andric     {0x0057000000000ULL, 0x0058000000000ULL, MappingDesc::ORIGIN, "origin-11"},
1360b57cec5SDimitry Andric     {0x0058000000000ULL, 0x0059000000000ULL, MappingDesc::APP, "app-12"},
1370b57cec5SDimitry Andric     {0x0059000000000ULL, 0x005E000000000ULL, MappingDesc::INVALID, "invalid"},
1380b57cec5SDimitry Andric     {0x005E000000000ULL, 0x005F000000000ULL, MappingDesc::SHADOW, "shadow-12"},
1390b57cec5SDimitry Andric     {0x005F000000000ULL, 0x0060000000000ULL, MappingDesc::ORIGIN, "origin-12"},
1400b57cec5SDimitry Andric     {0x0060000000000ULL, 0x0061000000000ULL, MappingDesc::INVALID, "invalid"},
1410b57cec5SDimitry Andric     {0x0061000000000ULL, 0x0062000000000ULL, MappingDesc::APP, "app-13"},
1420b57cec5SDimitry Andric     {0x0062000000000ULL, 0x0067000000000ULL, MappingDesc::INVALID, "invalid"},
1430b57cec5SDimitry Andric     {0x0067000000000ULL, 0x0068000000000ULL, MappingDesc::SHADOW, "shadow-13"},
1440b57cec5SDimitry Andric     {0x0068000000000ULL, 0x0069000000000ULL, MappingDesc::ORIGIN, "origin-13"},
1450b57cec5SDimitry Andric     {0x0069000000000ULL, 0x0AAAAA0000000ULL, MappingDesc::INVALID, "invalid"},
1460b57cec5SDimitry Andric     {0x0AAAAA0000000ULL, 0x0AAAB00000000ULL, MappingDesc::APP, "app-14"},
1470b57cec5SDimitry Andric     {0x0AAAB00000000ULL, 0x0AACAA0000000ULL, MappingDesc::INVALID, "invalid"},
1480b57cec5SDimitry Andric     {0x0AACAA0000000ULL, 0x0AACB00000000ULL, MappingDesc::SHADOW, "shadow-14"},
1490b57cec5SDimitry Andric     {0x0AACB00000000ULL, 0x0AADAA0000000ULL, MappingDesc::INVALID, "invalid"},
1500b57cec5SDimitry Andric     {0x0AADAA0000000ULL, 0x0AADB00000000ULL, MappingDesc::ORIGIN, "origin-14"},
1510b57cec5SDimitry Andric     {0x0AADB00000000ULL, 0x0FF9F00000000ULL, MappingDesc::INVALID, "invalid"},
1520b57cec5SDimitry Andric     {0x0FF9F00000000ULL, 0x0FFA000000000ULL, MappingDesc::SHADOW, "shadow-15"},
1530b57cec5SDimitry Andric     {0x0FFA000000000ULL, 0x0FFAF00000000ULL, MappingDesc::INVALID, "invalid"},
1540b57cec5SDimitry Andric     {0x0FFAF00000000ULL, 0x0FFB000000000ULL, MappingDesc::ORIGIN, "origin-15"},
1550b57cec5SDimitry Andric     {0x0FFB000000000ULL, 0x0FFFF00000000ULL, MappingDesc::INVALID, "invalid"},
1560b57cec5SDimitry Andric     {0x0FFFF00000000ULL, 0x1000000000000ULL, MappingDesc::APP, "app-15"},
1570b57cec5SDimitry Andric };
1580b57cec5SDimitry Andric # define MEM_TO_SHADOW(mem) ((uptr)mem ^ 0x6000000000ULL)
1590b57cec5SDimitry Andric # define SHADOW_TO_ORIGIN(shadow) (((uptr)(shadow)) + 0x1000000000ULL)
1600b57cec5SDimitry Andric 
1610b57cec5SDimitry Andric #elif SANITIZER_LINUX && SANITIZER_PPC64
1620b57cec5SDimitry Andric const MappingDesc kMemoryLayout[] = {
1630b57cec5SDimitry Andric     {0x000000000000ULL, 0x000200000000ULL, MappingDesc::APP, "low memory"},
1640b57cec5SDimitry Andric     {0x000200000000ULL, 0x080000000000ULL, MappingDesc::INVALID, "invalid"},
1650b57cec5SDimitry Andric     {0x080000000000ULL, 0x180200000000ULL, MappingDesc::SHADOW, "shadow"},
1660b57cec5SDimitry Andric     {0x180200000000ULL, 0x1C0000000000ULL, MappingDesc::INVALID, "invalid"},
1670b57cec5SDimitry Andric     {0x1C0000000000ULL, 0x2C0200000000ULL, MappingDesc::ORIGIN, "origin"},
1680b57cec5SDimitry Andric     {0x2C0200000000ULL, 0x300000000000ULL, MappingDesc::INVALID, "invalid"},
1690b57cec5SDimitry Andric     {0x300000000000ULL, 0x800000000000ULL, MappingDesc::APP, "high memory"}};
1700b57cec5SDimitry Andric 
1710b57cec5SDimitry Andric // Various kernels use different low end ranges but we can combine them into one
1720b57cec5SDimitry Andric // big range. They also use different high end ranges but we can map them all to
1730b57cec5SDimitry Andric // one range.
1740b57cec5SDimitry Andric // Maps low and high app ranges to contiguous space with zero base:
1750b57cec5SDimitry Andric //   Low:  0000 0000 0000 - 0001 ffff ffff  ->  1000 0000 0000 - 1001 ffff ffff
1760b57cec5SDimitry Andric //   High: 3000 0000 0000 - 3fff ffff ffff  ->  0000 0000 0000 - 0fff ffff ffff
1770b57cec5SDimitry Andric //   High: 4000 0000 0000 - 4fff ffff ffff  ->  0000 0000 0000 - 0fff ffff ffff
1780b57cec5SDimitry Andric //   High: 7000 0000 0000 - 7fff ffff ffff  ->  0000 0000 0000 - 0fff ffff ffff
1790b57cec5SDimitry Andric #define LINEARIZE_MEM(mem) \
1800b57cec5SDimitry Andric   (((uptr)(mem) & ~0xE00000000000ULL) ^ 0x100000000000ULL)
1810b57cec5SDimitry Andric #define MEM_TO_SHADOW(mem) (LINEARIZE_MEM((mem)) + 0x080000000000ULL)
1820b57cec5SDimitry Andric #define SHADOW_TO_ORIGIN(shadow) (((uptr)(shadow)) + 0x140000000000ULL)
1830b57cec5SDimitry Andric 
1845ffd83dbSDimitry Andric #elif SANITIZER_LINUX && SANITIZER_S390_64
1855ffd83dbSDimitry Andric const MappingDesc kMemoryLayout[] = {
1865ffd83dbSDimitry Andric     {0x000000000000ULL, 0x040000000000ULL, MappingDesc::APP, "low memory"},
1875ffd83dbSDimitry Andric     {0x040000000000ULL, 0x080000000000ULL, MappingDesc::INVALID, "invalid"},
1885ffd83dbSDimitry Andric     {0x080000000000ULL, 0x180000000000ULL, MappingDesc::SHADOW, "shadow"},
1895ffd83dbSDimitry Andric     {0x180000000000ULL, 0x1C0000000000ULL, MappingDesc::INVALID, "invalid"},
1905ffd83dbSDimitry Andric     {0x1C0000000000ULL, 0x2C0000000000ULL, MappingDesc::ORIGIN, "origin"},
1915ffd83dbSDimitry Andric     {0x2C0000000000ULL, 0x440000000000ULL, MappingDesc::INVALID, "invalid"},
1925ffd83dbSDimitry Andric     {0x440000000000ULL, 0x500000000000ULL, MappingDesc::APP, "high memory"}};
1935ffd83dbSDimitry Andric 
1945ffd83dbSDimitry Andric #define MEM_TO_SHADOW(mem) \
1955ffd83dbSDimitry Andric   ((((uptr)(mem)) & ~0xC00000000000ULL) + 0x080000000000ULL)
1965ffd83dbSDimitry Andric #define SHADOW_TO_ORIGIN(shadow) (((uptr)(shadow)) + 0x140000000000ULL)
1975ffd83dbSDimitry Andric 
1980b57cec5SDimitry Andric #elif SANITIZER_FREEBSD && SANITIZER_WORDSIZE == 64
1990b57cec5SDimitry Andric 
2000b57cec5SDimitry Andric // Low memory: main binary, MAP_32BIT mappings and modules
2010b57cec5SDimitry Andric // High memory: heap, modules and main thread stack
2020b57cec5SDimitry Andric const MappingDesc kMemoryLayout[] = {
2030b57cec5SDimitry Andric     {0x000000000000ULL, 0x010000000000ULL, MappingDesc::APP, "low memory"},
2040b57cec5SDimitry Andric     {0x010000000000ULL, 0x100000000000ULL, MappingDesc::INVALID, "invalid"},
2050b57cec5SDimitry Andric     {0x100000000000ULL, 0x310000000000ULL, MappingDesc::SHADOW, "shadow"},
2060b57cec5SDimitry Andric     {0x310000000000ULL, 0x380000000000ULL, MappingDesc::INVALID, "invalid"},
2070b57cec5SDimitry Andric     {0x380000000000ULL, 0x590000000000ULL, MappingDesc::ORIGIN, "origin"},
2080b57cec5SDimitry Andric     {0x590000000000ULL, 0x600000000000ULL, MappingDesc::INVALID, "invalid"},
2090b57cec5SDimitry Andric     {0x600000000000ULL, 0x800000000000ULL, MappingDesc::APP, "high memory"}};
2100b57cec5SDimitry Andric 
2110b57cec5SDimitry Andric // Maps low and high app ranges to contiguous space with zero base:
2120b57cec5SDimitry Andric //   Low:  0000 0000 0000 - 00ff ffff ffff  ->  2000 0000 0000 - 20ff ffff ffff
2130b57cec5SDimitry Andric //   High: 6000 0000 0000 - 7fff ffff ffff  ->  0000 0000 0000 - 1fff ffff ffff
2140b57cec5SDimitry Andric #define LINEARIZE_MEM(mem) \
2150b57cec5SDimitry Andric   (((uptr)(mem) & ~0xc00000000000ULL) ^ 0x200000000000ULL)
2160b57cec5SDimitry Andric #define MEM_TO_SHADOW(mem) (LINEARIZE_MEM((mem)) + 0x100000000000ULL)
2170b57cec5SDimitry Andric #define SHADOW_TO_ORIGIN(shadow) (((uptr)(shadow)) + 0x280000000000)
2180b57cec5SDimitry Andric 
2190b57cec5SDimitry Andric #elif SANITIZER_NETBSD || (SANITIZER_LINUX && SANITIZER_WORDSIZE == 64)
2200b57cec5SDimitry Andric 
2210b57cec5SDimitry Andric #ifdef MSAN_LINUX_X86_64_OLD_MAPPING
222349cc55cSDimitry Andric // Requires PIE binary and ASLR enabled.
2230b57cec5SDimitry Andric // Main thread stack and DSOs at 0x7f0000000000 (sometimes 0x7e0000000000).
2240b57cec5SDimitry Andric // Heap at 0x600000000000.
2250b57cec5SDimitry Andric const MappingDesc kMemoryLayout[] = {
2260b57cec5SDimitry Andric     {0x000000000000ULL, 0x200000000000ULL, MappingDesc::INVALID, "invalid"},
2270b57cec5SDimitry Andric     {0x200000000000ULL, 0x400000000000ULL, MappingDesc::SHADOW, "shadow"},
2280b57cec5SDimitry Andric     {0x400000000000ULL, 0x600000000000ULL, MappingDesc::ORIGIN, "origin"},
2290b57cec5SDimitry Andric     {0x600000000000ULL, 0x800000000000ULL, MappingDesc::APP, "app"}};
2300b57cec5SDimitry Andric 
2310b57cec5SDimitry Andric #define MEM_TO_SHADOW(mem) (((uptr)(mem)) & ~0x400000000000ULL)
2320b57cec5SDimitry Andric #define SHADOW_TO_ORIGIN(mem) (((uptr)(mem)) + 0x200000000000ULL)
2330b57cec5SDimitry Andric #else  // MSAN_LINUX_X86_64_OLD_MAPPING
2340b57cec5SDimitry Andric // All of the following configurations are supported.
2350b57cec5SDimitry Andric // ASLR disabled: main executable and DSOs at 0x555550000000
2360b57cec5SDimitry Andric // PIE and ASLR: main executable and DSOs at 0x7f0000000000
2370b57cec5SDimitry Andric // non-PIE: main executable below 0x100000000, DSOs at 0x7f0000000000
2380b57cec5SDimitry Andric // Heap at 0x700000000000.
2390b57cec5SDimitry Andric const MappingDesc kMemoryLayout[] = {
2400b57cec5SDimitry Andric     {0x000000000000ULL, 0x010000000000ULL, MappingDesc::APP, "app-1"},
2410b57cec5SDimitry Andric     {0x010000000000ULL, 0x100000000000ULL, MappingDesc::SHADOW, "shadow-2"},
2420b57cec5SDimitry Andric     {0x100000000000ULL, 0x110000000000ULL, MappingDesc::INVALID, "invalid"},
2430b57cec5SDimitry Andric     {0x110000000000ULL, 0x200000000000ULL, MappingDesc::ORIGIN, "origin-2"},
2440b57cec5SDimitry Andric     {0x200000000000ULL, 0x300000000000ULL, MappingDesc::SHADOW, "shadow-3"},
2450b57cec5SDimitry Andric     {0x300000000000ULL, 0x400000000000ULL, MappingDesc::ORIGIN, "origin-3"},
2460b57cec5SDimitry Andric     {0x400000000000ULL, 0x500000000000ULL, MappingDesc::INVALID, "invalid"},
2470b57cec5SDimitry Andric     {0x500000000000ULL, 0x510000000000ULL, MappingDesc::SHADOW, "shadow-1"},
2480b57cec5SDimitry Andric     {0x510000000000ULL, 0x600000000000ULL, MappingDesc::APP, "app-2"},
2490b57cec5SDimitry Andric     {0x600000000000ULL, 0x610000000000ULL, MappingDesc::ORIGIN, "origin-1"},
2500b57cec5SDimitry Andric     {0x610000000000ULL, 0x700000000000ULL, MappingDesc::INVALID, "invalid"},
2510b57cec5SDimitry Andric     {0x700000000000ULL, 0x800000000000ULL, MappingDesc::APP, "app-3"}};
2520b57cec5SDimitry Andric #define MEM_TO_SHADOW(mem) (((uptr)(mem)) ^ 0x500000000000ULL)
2530b57cec5SDimitry Andric #define SHADOW_TO_ORIGIN(mem) (((uptr)(mem)) + 0x100000000000ULL)
2540b57cec5SDimitry Andric #endif  // MSAN_LINUX_X86_64_OLD_MAPPING
2550b57cec5SDimitry Andric 
2560b57cec5SDimitry Andric #else
2570b57cec5SDimitry Andric #error "Unsupported platform"
2580b57cec5SDimitry Andric #endif
2590b57cec5SDimitry Andric 
2600b57cec5SDimitry Andric const uptr kMemoryLayoutSize = sizeof(kMemoryLayout) / sizeof(kMemoryLayout[0]);
2610b57cec5SDimitry Andric 
2620b57cec5SDimitry Andric #define MEM_TO_ORIGIN(mem) (SHADOW_TO_ORIGIN(MEM_TO_SHADOW((mem))))
2630b57cec5SDimitry Andric 
2640b57cec5SDimitry Andric #ifndef __clang__
2650b57cec5SDimitry Andric __attribute__((optimize("unroll-loops")))
2660b57cec5SDimitry Andric #endif
2670b57cec5SDimitry Andric inline bool addr_is_type(uptr addr, MappingDesc::Type mapping_type) {
2680b57cec5SDimitry Andric // It is critical for performance that this loop is unrolled (because then it is
2690b57cec5SDimitry Andric // simplified into just a few constant comparisons).
2700b57cec5SDimitry Andric #ifdef __clang__
2710b57cec5SDimitry Andric #pragma unroll
2720b57cec5SDimitry Andric #endif
2730b57cec5SDimitry Andric   for (unsigned i = 0; i < kMemoryLayoutSize; ++i)
2740b57cec5SDimitry Andric     if (kMemoryLayout[i].type == mapping_type &&
2750b57cec5SDimitry Andric         addr >= kMemoryLayout[i].start && addr < kMemoryLayout[i].end)
2760b57cec5SDimitry Andric       return true;
2770b57cec5SDimitry Andric   return false;
2780b57cec5SDimitry Andric }
2790b57cec5SDimitry Andric 
2800b57cec5SDimitry Andric #define MEM_IS_APP(mem) addr_is_type((uptr)(mem), MappingDesc::APP)
2810b57cec5SDimitry Andric #define MEM_IS_SHADOW(mem) addr_is_type((uptr)(mem), MappingDesc::SHADOW)
2820b57cec5SDimitry Andric #define MEM_IS_ORIGIN(mem) addr_is_type((uptr)(mem), MappingDesc::ORIGIN)
2830b57cec5SDimitry Andric 
28468d75effSDimitry Andric // These constants must be kept in sync with the ones in MemorySanitizer.cpp.
2850b57cec5SDimitry Andric const int kMsanParamTlsSize = 800;
2860b57cec5SDimitry Andric const int kMsanRetvalTlsSize = 800;
2870b57cec5SDimitry Andric 
2880b57cec5SDimitry Andric namespace __msan {
2890b57cec5SDimitry Andric extern int msan_inited;
2900b57cec5SDimitry Andric extern bool msan_init_is_running;
2910b57cec5SDimitry Andric extern int msan_report_count;
2920b57cec5SDimitry Andric 
2930b57cec5SDimitry Andric bool ProtectRange(uptr beg, uptr end);
2940b57cec5SDimitry Andric bool InitShadow(bool init_origins);
2950b57cec5SDimitry Andric char *GetProcSelfMaps();
2960b57cec5SDimitry Andric void InitializeInterceptors();
2970b57cec5SDimitry Andric 
2980b57cec5SDimitry Andric void MsanAllocatorInit();
2990b57cec5SDimitry Andric void MsanDeallocate(StackTrace *stack, void *ptr);
3000b57cec5SDimitry Andric 
3010b57cec5SDimitry Andric void *msan_malloc(uptr size, StackTrace *stack);
3020b57cec5SDimitry Andric void *msan_calloc(uptr nmemb, uptr size, StackTrace *stack);
3030b57cec5SDimitry Andric void *msan_realloc(void *ptr, uptr size, StackTrace *stack);
3040b57cec5SDimitry Andric void *msan_reallocarray(void *ptr, uptr nmemb, uptr size, StackTrace *stack);
3050b57cec5SDimitry Andric void *msan_valloc(uptr size, StackTrace *stack);
3060b57cec5SDimitry Andric void *msan_pvalloc(uptr size, StackTrace *stack);
3070b57cec5SDimitry Andric void *msan_aligned_alloc(uptr alignment, uptr size, StackTrace *stack);
3080b57cec5SDimitry Andric void *msan_memalign(uptr alignment, uptr size, StackTrace *stack);
3090b57cec5SDimitry Andric int msan_posix_memalign(void **memptr, uptr alignment, uptr size,
3100b57cec5SDimitry Andric                         StackTrace *stack);
3110b57cec5SDimitry Andric 
3120b57cec5SDimitry Andric void InstallTrapHandler();
3130b57cec5SDimitry Andric void InstallAtExitHandler();
3140b57cec5SDimitry Andric 
3150b57cec5SDimitry Andric const char *GetStackOriginDescr(u32 id, uptr *pc);
3160b57cec5SDimitry Andric 
31781ad6265SDimitry Andric bool IsInSymbolizerOrUnwider();
3180b57cec5SDimitry Andric 
3190b57cec5SDimitry Andric void PrintWarning(uptr pc, uptr bp);
3200b57cec5SDimitry Andric void PrintWarningWithOrigin(uptr pc, uptr bp, u32 origin);
3210b57cec5SDimitry Andric 
3220b57cec5SDimitry Andric // Unpoison first n function arguments.
3230b57cec5SDimitry Andric void UnpoisonParam(uptr n);
3240b57cec5SDimitry Andric void UnpoisonThreadLocalState();
3250b57cec5SDimitry Andric 
3260b57cec5SDimitry Andric // Returns a "chained" origin id, pointing to the given stack trace followed by
3270b57cec5SDimitry Andric // the previous origin id.
3280b57cec5SDimitry Andric u32 ChainOrigin(u32 id, StackTrace *stack);
3290b57cec5SDimitry Andric 
3300b57cec5SDimitry Andric const int STACK_TRACE_TAG_POISON = StackTrace::TAG_CUSTOM + 1;
3310b57cec5SDimitry Andric 
3320b57cec5SDimitry Andric #define GET_MALLOC_STACK_TRACE                                            \
3330b57cec5SDimitry Andric   BufferedStackTrace stack;                                               \
3340b57cec5SDimitry Andric   if (__msan_get_track_origins() && msan_inited)                          \
3350b57cec5SDimitry Andric     stack.Unwind(StackTrace::GetCurrentPc(), GET_CURRENT_FRAME(),         \
3360b57cec5SDimitry Andric                  nullptr, common_flags()->fast_unwind_on_malloc,          \
3370b57cec5SDimitry Andric                  common_flags()->malloc_context_size)
3380b57cec5SDimitry Andric 
3390b57cec5SDimitry Andric // For platforms which support slow unwinder only, we restrict the store context
3400b57cec5SDimitry Andric // size to 1, basically only storing the current pc. We do this because the slow
3410b57cec5SDimitry Andric // unwinder which is based on libunwind is not async signal safe and causes
3420b57cec5SDimitry Andric // random freezes in forking applications as well as in signal handlers.
3430b57cec5SDimitry Andric #define GET_STORE_STACK_TRACE_PC_BP(pc, bp)                                    \
3440b57cec5SDimitry Andric   BufferedStackTrace stack;                                                    \
3450b57cec5SDimitry Andric   if (__msan_get_track_origins() > 1 && msan_inited) {                         \
3460b57cec5SDimitry Andric     int size = flags()->store_context_size;                                    \
3470b57cec5SDimitry Andric     if (!SANITIZER_CAN_FAST_UNWIND)                                            \
3480b57cec5SDimitry Andric       size = Min(size, 1);                                                     \
3490b57cec5SDimitry Andric     stack.Unwind(pc, bp, nullptr, common_flags()->fast_unwind_on_malloc, size);\
3500b57cec5SDimitry Andric   }
3510b57cec5SDimitry Andric 
3520b57cec5SDimitry Andric #define GET_STORE_STACK_TRACE \
3530b57cec5SDimitry Andric   GET_STORE_STACK_TRACE_PC_BP(StackTrace::GetCurrentPc(), GET_CURRENT_FRAME())
3540b57cec5SDimitry Andric 
3550b57cec5SDimitry Andric #define GET_FATAL_STACK_TRACE_PC_BP(pc, bp)                              \
3560b57cec5SDimitry Andric   BufferedStackTrace stack;                                              \
35768d75effSDimitry Andric   if (msan_inited) {                                                     \
35868d75effSDimitry Andric     stack.Unwind(pc, bp, nullptr, common_flags()->fast_unwind_on_fatal); \
35968d75effSDimitry Andric   }
3600b57cec5SDimitry Andric 
3610b57cec5SDimitry Andric class ScopedThreadLocalStateBackup {
3620b57cec5SDimitry Andric  public:
3630b57cec5SDimitry Andric   ScopedThreadLocalStateBackup() { Backup(); }
3640b57cec5SDimitry Andric   ~ScopedThreadLocalStateBackup() { Restore(); }
3650b57cec5SDimitry Andric   void Backup();
3660b57cec5SDimitry Andric   void Restore();
3670b57cec5SDimitry Andric  private:
3680b57cec5SDimitry Andric   u64 va_arg_overflow_size_tls;
3690b57cec5SDimitry Andric };
3700b57cec5SDimitry Andric 
3710b57cec5SDimitry Andric void MsanTSDInit(void (*destructor)(void *tsd));
3720b57cec5SDimitry Andric void *MsanTSDGet();
3730b57cec5SDimitry Andric void MsanTSDSet(void *tsd);
3740b57cec5SDimitry Andric void MsanTSDDtor(void *tsd);
3750b57cec5SDimitry Andric 
3760b57cec5SDimitry Andric }  // namespace __msan
3770b57cec5SDimitry Andric 
3780b57cec5SDimitry Andric #endif  // MSAN_H
379