contrib/compiler-rt/lib/tsan/rtl/tsan_platform.h

   1 //===-- tsan_platform.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 ThreadSanitizer (TSan), a race detector.
  11 //
  12 // Platform-specific code.
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef TSAN_PLATFORM_H
  16 #define TSAN_PLATFORM_H
  17
  18 #if !defined(__LP64__) && !defined(_WIN64)
  19 # error "Only 64-bit is supported"
  20 #endif
  21
  22 #include "tsan_defs.h"
  23 #include "tsan_trace.h"
  24
  25 namespace __tsan {
  26
  27 #if !SANITIZER_GO
  28
  29 #if defined(__x86_64__)
  30 /*
  31 C/C++ on linux/x86_64 and freebsd/x86_64
  32 0000 0000 1000 - 0080 0000 0000: main binary and/or MAP_32BIT mappings (512GB)
  33 0040 0000 0000 - 0100 0000 0000: -
  34 0100 0000 0000 - 2000 0000 0000: shadow
  35 2000 0000 0000 - 3000 0000 0000: -
  36 3000 0000 0000 - 4000 0000 0000: metainfo (memory blocks and sync objects)
  37 4000 0000 0000 - 5500 0000 0000: -
  38 5500 0000 0000 - 5680 0000 0000: pie binaries without ASLR or on 4.1+ kernels
  39 5680 0000 0000 - 6000 0000 0000: -
  40 6000 0000 0000 - 6200 0000 0000: traces
  41 6200 0000 0000 - 7d00 0000 0000: -
  42 7b00 0000 0000 - 7c00 0000 0000: heap
  43 7c00 0000 0000 - 7e80 0000 0000: -
  44 7e80 0000 0000 - 8000 0000 0000: modules and main thread stack
  45
  46 C/C++ on netbsd/amd64 can reuse the same mapping:
  47  * The address space starts from 0x1000 (option with 0x0) and ends with
  48    0x7f7ffffff000.
  49  * LoAppMem-kHeapMemEnd can be reused as it is.
  50  * No VDSO support.
  51  * No MidAppMem region.
  52  * No additional HeapMem region.
  53  * HiAppMem contains the stack, loader, shared libraries and heap.
  54  * Stack on NetBSD/amd64 has prereserved 128MB.
  55  * Heap grows downwards (top-down).
  56  * ASLR must be disabled per-process or globally.
  57
  58 */
  59 struct Mapping {
  60   static const uptr kMetaShadowBeg = 0x300000000000ull;
  61   static const uptr kMetaShadowEnd = 0x340000000000ull;
  62   static const uptr kTraceMemBeg   = 0x600000000000ull;
  63   static const uptr kTraceMemEnd   = 0x620000000000ull;
  64   static const uptr kShadowBeg     = 0x010000000000ull;
  65   static const uptr kShadowEnd     = 0x200000000000ull;
  66   static const uptr kHeapMemBeg    = 0x7b0000000000ull;
  67   static const uptr kHeapMemEnd    = 0x7c0000000000ull;
  68   static const uptr kLoAppMemBeg   = 0x000000001000ull;
  69   static const uptr kLoAppMemEnd   = 0x008000000000ull;
  70   static const uptr kMidAppMemBeg  = 0x550000000000ull;
  71   static const uptr kMidAppMemEnd  = 0x568000000000ull;
  72   static const uptr kHiAppMemBeg   = 0x7e8000000000ull;
  73   static const uptr kHiAppMemEnd   = 0x800000000000ull;
  74   static const uptr kAppMemMsk     = 0x780000000000ull;
  75   static const uptr kAppMemXor     = 0x040000000000ull;
  76   static const uptr kVdsoBeg       = 0xf000000000000000ull;
  77 };
  78
  79 #define TSAN_MID_APP_RANGE 1
  80 #elif defined(__mips64)
  81 /*
  82 C/C++ on linux/mips64 (40-bit VMA)
  83 0000 0000 00 - 0100 0000 00: -                                           (4 GB)
  84 0100 0000 00 - 0200 0000 00: main binary                                 (4 GB)
  85 0200 0000 00 - 2000 0000 00: -                                         (120 GB)
  86 2000 0000 00 - 4000 0000 00: shadow                                    (128 GB)
  87 4000 0000 00 - 5000 0000 00: metainfo (memory blocks and sync objects)  (64 GB)
  88 5000 0000 00 - aa00 0000 00: -                                         (360 GB)
  89 aa00 0000 00 - ab00 0000 00: main binary (PIE)                           (4 GB)
  90 ab00 0000 00 - b000 0000 00: -                                          (20 GB)
  91 b000 0000 00 - b200 0000 00: traces                                      (8 GB)
  92 b200 0000 00 - fe00 0000 00: -                                         (304 GB)
  93 fe00 0000 00 - ff00 0000 00: heap                                        (4 GB)
  94 ff00 0000 00 - ff80 0000 00: -                                           (2 GB)
  95 ff80 0000 00 - ffff ffff ff: modules and main thread stack              (<2 GB)
  96 */
  97 struct Mapping {
  98   static const uptr kMetaShadowBeg = 0x4000000000ull;
  99   static const uptr kMetaShadowEnd = 0x5000000000ull;
 100   static const uptr kTraceMemBeg   = 0xb000000000ull;
 101   static const uptr kTraceMemEnd   = 0xb200000000ull;
 102   static const uptr kShadowBeg     = 0x2000000000ull;
 103   static const uptr kShadowEnd     = 0x4000000000ull;
 104   static const uptr kHeapMemBeg    = 0xfe00000000ull;
 105   static const uptr kHeapMemEnd    = 0xff00000000ull;
 106   static const uptr kLoAppMemBeg   = 0x0100000000ull;
 107   static const uptr kLoAppMemEnd   = 0x0200000000ull;
 108   static const uptr kMidAppMemBeg  = 0xaa00000000ull;
 109   static const uptr kMidAppMemEnd  = 0xab00000000ull;
 110   static const uptr kHiAppMemBeg   = 0xff80000000ull;
 111   static const uptr kHiAppMemEnd   = 0xffffffffffull;
 112   static const uptr kAppMemMsk     = 0xf800000000ull;
 113   static const uptr kAppMemXor     = 0x0800000000ull;
 114   static const uptr kVdsoBeg       = 0xfffff00000ull;
 115 };
 116
 117 #define TSAN_MID_APP_RANGE 1
 118 #elif defined(__aarch64__) && defined(__APPLE__)
 119 /*
 120 C/C++ on Darwin/iOS/ARM64 (36-bit VMA, 64 GB VM)
 121 0000 0000 00 - 0100 0000 00: -                                    (4 GB)
 122 0100 0000 00 - 0200 0000 00: main binary, modules, thread stacks  (4 GB)
 123 0200 0000 00 - 0300 0000 00: heap                                 (4 GB)
 124 0300 0000 00 - 0400 0000 00: -                                    (4 GB)
 125 0400 0000 00 - 0c00 0000 00: shadow memory                       (32 GB)
 126 0c00 0000 00 - 0d00 0000 00: -                                    (4 GB)
 127 0d00 0000 00 - 0e00 0000 00: metainfo                             (4 GB)
 128 0e00 0000 00 - 0f00 0000 00: -                                    (4 GB)
 129 0f00 0000 00 - 0fc0 0000 00: traces                               (3 GB)
 130 0fc0 0000 00 - 1000 0000 00: -
 131 */
 132 struct Mapping {
 133   static const uptr kLoAppMemBeg   = 0x0100000000ull;
 134   static const uptr kLoAppMemEnd   = 0x0200000000ull;
 135   static const uptr kHeapMemBeg    = 0x0200000000ull;
 136   static const uptr kHeapMemEnd    = 0x0300000000ull;
 137   static const uptr kShadowBeg     = 0x0400000000ull;
 138   static const uptr kShadowEnd     = 0x0c00000000ull;
 139   static const uptr kMetaShadowBeg = 0x0d00000000ull;
 140   static const uptr kMetaShadowEnd = 0x0e00000000ull;
 141   static const uptr kTraceMemBeg   = 0x0f00000000ull;
 142   static const uptr kTraceMemEnd   = 0x0fc0000000ull;
 143   static const uptr kHiAppMemBeg   = 0x0fc0000000ull;
 144   static const uptr kHiAppMemEnd   = 0x0fc0000000ull;
 145   static const uptr kAppMemMsk     =          0x0ull;
 146   static const uptr kAppMemXor     =          0x0ull;
 147   static const uptr kVdsoBeg       = 0x7000000000000000ull;
 148 };
 149
 150 #elif defined(__aarch64__)
 151 // AArch64 supports multiple VMA which leads to multiple address transformation
 152 // functions.  To support these multiple VMAS transformations and mappings TSAN
 153 // runtime for AArch64 uses an external memory read (vmaSize) to select which
 154 // mapping to use.  Although slower, it make a same instrumented binary run on
 155 // multiple kernels.
 156
 157 /*
 158 C/C++ on linux/aarch64 (39-bit VMA)
 159 0000 0010 00 - 0100 0000 00: main binary
 160 0100 0000 00 - 0800 0000 00: -
 161 0800 0000 00 - 2000 0000 00: shadow memory
 162 2000 0000 00 - 3100 0000 00: -
 163 3100 0000 00 - 3400 0000 00: metainfo
 164 3400 0000 00 - 5500 0000 00: -
 165 5500 0000 00 - 5600 0000 00: main binary (PIE)
 166 5600 0000 00 - 6000 0000 00: -
 167 6000 0000 00 - 6200 0000 00: traces
 168 6200 0000 00 - 7d00 0000 00: -
 169 7c00 0000 00 - 7d00 0000 00: heap
 170 7d00 0000 00 - 7fff ffff ff: modules and main thread stack
 171 */
 172 struct Mapping39 {
 173   static const uptr kLoAppMemBeg   = 0x0000001000ull;
 174   static const uptr kLoAppMemEnd   = 0x0100000000ull;
 175   static const uptr kShadowBeg     = 0x0800000000ull;
 176   static const uptr kShadowEnd     = 0x2000000000ull;
 177   static const uptr kMetaShadowBeg = 0x3100000000ull;
 178   static const uptr kMetaShadowEnd = 0x3400000000ull;
 179   static const uptr kMidAppMemBeg  = 0x5500000000ull;
 180   static const uptr kMidAppMemEnd  = 0x5600000000ull;
 181   static const uptr kTraceMemBeg   = 0x6000000000ull;
 182   static const uptr kTraceMemEnd   = 0x6200000000ull;
 183   static const uptr kHeapMemBeg    = 0x7c00000000ull;
 184   static const uptr kHeapMemEnd    = 0x7d00000000ull;
 185   static const uptr kHiAppMemBeg   = 0x7e00000000ull;
 186   static const uptr kHiAppMemEnd   = 0x7fffffffffull;
 187   static const uptr kAppMemMsk     = 0x7800000000ull;
 188   static const uptr kAppMemXor     = 0x0200000000ull;
 189   static const uptr kVdsoBeg       = 0x7f00000000ull;
 190 };
 191
 192 /*
 193 C/C++ on linux/aarch64 (42-bit VMA)
 194 00000 0010 00 - 01000 0000 00: main binary
 195 01000 0000 00 - 10000 0000 00: -
 196 10000 0000 00 - 20000 0000 00: shadow memory
 197 20000 0000 00 - 26000 0000 00: -
 198 26000 0000 00 - 28000 0000 00: metainfo
 199 28000 0000 00 - 2aa00 0000 00: -
 200 2aa00 0000 00 - 2ab00 0000 00: main binary (PIE)
 201 2ab00 0000 00 - 36200 0000 00: -
 202 36200 0000 00 - 36240 0000 00: traces
 203 36240 0000 00 - 3e000 0000 00: -
 204 3e000 0000 00 - 3f000 0000 00: heap
 205 3f000 0000 00 - 3ffff ffff ff: modules and main thread stack
 206 */
 207 struct Mapping42 {
 208   static const uptr kLoAppMemBeg   = 0x00000001000ull;
 209   static const uptr kLoAppMemEnd   = 0x01000000000ull;
 210   static const uptr kShadowBeg     = 0x10000000000ull;
 211   static const uptr kShadowEnd     = 0x20000000000ull;
 212   static const uptr kMetaShadowBeg = 0x26000000000ull;
 213   static const uptr kMetaShadowEnd = 0x28000000000ull;
 214   static const uptr kMidAppMemBeg  = 0x2aa00000000ull;
 215   static const uptr kMidAppMemEnd  = 0x2ab00000000ull;
 216   static const uptr kTraceMemBeg   = 0x36200000000ull;
 217   static const uptr kTraceMemEnd   = 0x36400000000ull;
 218   static const uptr kHeapMemBeg    = 0x3e000000000ull;
 219   static const uptr kHeapMemEnd    = 0x3f000000000ull;
 220   static const uptr kHiAppMemBeg   = 0x3f000000000ull;
 221   static const uptr kHiAppMemEnd   = 0x3ffffffffffull;
 222   static const uptr kAppMemMsk     = 0x3c000000000ull;
 223   static const uptr kAppMemXor     = 0x04000000000ull;
 224   static const uptr kVdsoBeg       = 0x37f00000000ull;
 225 };
 226
 227 struct Mapping48 {
 228   static const uptr kLoAppMemBeg   = 0x0000000001000ull;
 229   static const uptr kLoAppMemEnd   = 0x0000200000000ull;
 230   static const uptr kShadowBeg     = 0x0002000000000ull;
 231   static const uptr kShadowEnd     = 0x0004000000000ull;
 232   static const uptr kMetaShadowBeg = 0x0005000000000ull;
 233   static const uptr kMetaShadowEnd = 0x0006000000000ull;
 234   static const uptr kMidAppMemBeg  = 0x0aaaa00000000ull;
 235   static const uptr kMidAppMemEnd  = 0x0aaaf00000000ull;
 236   static const uptr kTraceMemBeg   = 0x0f06000000000ull;
 237   static const uptr kTraceMemEnd   = 0x0f06200000000ull;
 238   static const uptr kHeapMemBeg    = 0x0ffff00000000ull;
 239   static const uptr kHeapMemEnd    = 0x0ffff00000000ull;
 240   static const uptr kHiAppMemBeg   = 0x0ffff00000000ull;
 241   static const uptr kHiAppMemEnd   = 0x1000000000000ull;
 242   static const uptr kAppMemMsk     = 0x0fff800000000ull;
 243   static const uptr kAppMemXor     = 0x0000800000000ull;
 244   static const uptr kVdsoBeg       = 0xffff000000000ull;
 245 };
 246
 247 // Indicates the runtime will define the memory regions at runtime.
 248 #define TSAN_RUNTIME_VMA 1
 249 // Indicates that mapping defines a mid range memory segment.
 250 #define TSAN_MID_APP_RANGE 1
 251 #elif defined(__powerpc64__)
 252 // PPC64 supports multiple VMA which leads to multiple address transformation
 253 // functions.  To support these multiple VMAS transformations and mappings TSAN
 254 // runtime for PPC64 uses an external memory read (vmaSize) to select which
 255 // mapping to use.  Although slower, it make a same instrumented binary run on
 256 // multiple kernels.
 257
 258 /*
 259 C/C++ on linux/powerpc64 (44-bit VMA)
 260 0000 0000 0100 - 0001 0000 0000: main binary
 261 0001 0000 0000 - 0001 0000 0000: -
 262 0001 0000 0000 - 0b00 0000 0000: shadow
 263 0b00 0000 0000 - 0b00 0000 0000: -
 264 0b00 0000 0000 - 0d00 0000 0000: metainfo (memory blocks and sync objects)
 265 0d00 0000 0000 - 0d00 0000 0000: -
 266 0d00 0000 0000 - 0f00 0000 0000: traces
 267 0f00 0000 0000 - 0f00 0000 0000: -
 268 0f00 0000 0000 - 0f50 0000 0000: heap
 269 0f50 0000 0000 - 0f60 0000 0000: -
 270 0f60 0000 0000 - 1000 0000 0000: modules and main thread stack
 271 */
 272 struct Mapping44 {
 273   static const uptr kMetaShadowBeg = 0x0b0000000000ull;
 274   static const uptr kMetaShadowEnd = 0x0d0000000000ull;
 275   static const uptr kTraceMemBeg   = 0x0d0000000000ull;
 276   static const uptr kTraceMemEnd   = 0x0f0000000000ull;
 277   static const uptr kShadowBeg     = 0x000100000000ull;
 278   static const uptr kShadowEnd     = 0x0b0000000000ull;
 279   static const uptr kLoAppMemBeg   = 0x000000000100ull;
 280   static const uptr kLoAppMemEnd   = 0x000100000000ull;
 281   static const uptr kHeapMemBeg    = 0x0f0000000000ull;
 282   static const uptr kHeapMemEnd    = 0x0f5000000000ull;
 283   static const uptr kHiAppMemBeg   = 0x0f6000000000ull;
 284   static const uptr kHiAppMemEnd   = 0x100000000000ull; // 44 bits
 285   static const uptr kAppMemMsk     = 0x0f0000000000ull;
 286   static const uptr kAppMemXor     = 0x002100000000ull;
 287   static const uptr kVdsoBeg       = 0x3c0000000000000ull;
 288 };
 289
 290 /*
 291 C/C++ on linux/powerpc64 (46-bit VMA)
 292 0000 0000 1000 - 0100 0000 0000: main binary
 293 0100 0000 0000 - 0200 0000 0000: -
 294 0100 0000 0000 - 1000 0000 0000: shadow
 295 1000 0000 0000 - 1000 0000 0000: -
 296 1000 0000 0000 - 2000 0000 0000: metainfo (memory blocks and sync objects)
 297 2000 0000 0000 - 2000 0000 0000: -
 298 2000 0000 0000 - 2200 0000 0000: traces
 299 2200 0000 0000 - 3d00 0000 0000: -
 300 3d00 0000 0000 - 3e00 0000 0000: heap
 301 3e00 0000 0000 - 3e80 0000 0000: -
 302 3e80 0000 0000 - 4000 0000 0000: modules and main thread stack
 303 */
 304 struct Mapping46 {
 305   static const uptr kMetaShadowBeg = 0x100000000000ull;
 306   static const uptr kMetaShadowEnd = 0x200000000000ull;
 307   static const uptr kTraceMemBeg   = 0x200000000000ull;
 308   static const uptr kTraceMemEnd   = 0x220000000000ull;
 309   static const uptr kShadowBeg     = 0x010000000000ull;
 310   static const uptr kShadowEnd     = 0x100000000000ull;
 311   static const uptr kHeapMemBeg    = 0x3d0000000000ull;
 312   static const uptr kHeapMemEnd    = 0x3e0000000000ull;
 313   static const uptr kLoAppMemBeg   = 0x000000001000ull;
 314   static const uptr kLoAppMemEnd   = 0x010000000000ull;
 315   static const uptr kHiAppMemBeg   = 0x3e8000000000ull;
 316   static const uptr kHiAppMemEnd   = 0x400000000000ull; // 46 bits
 317   static const uptr kAppMemMsk     = 0x3c0000000000ull;
 318   static const uptr kAppMemXor     = 0x020000000000ull;
 319   static const uptr kVdsoBeg       = 0x7800000000000000ull;
 320 };
 321
 322 /*
 323 C/C++ on linux/powerpc64 (47-bit VMA)
 324 0000 0000 1000 - 0100 0000 0000: main binary
 325 0100 0000 0000 - 0200 0000 0000: -
 326 0100 0000 0000 - 1000 0000 0000: shadow
 327 1000 0000 0000 - 1000 0000 0000: -
 328 1000 0000 0000 - 2000 0000 0000: metainfo (memory blocks and sync objects)
 329 2000 0000 0000 - 2000 0000 0000: -
 330 2000 0000 0000 - 2200 0000 0000: traces
 331 2200 0000 0000 - 7d00 0000 0000: -
 332 7d00 0000 0000 - 7e00 0000 0000: heap
 333 7e00 0000 0000 - 7e80 0000 0000: -
 334 7e80 0000 0000 - 8000 0000 0000: modules and main thread stack
 335 */
 336 struct Mapping47 {
 337   static const uptr kMetaShadowBeg = 0x100000000000ull;
 338   static const uptr kMetaShadowEnd = 0x200000000000ull;
 339   static const uptr kTraceMemBeg   = 0x200000000000ull;
 340   static const uptr kTraceMemEnd   = 0x220000000000ull;
 341   static const uptr kShadowBeg     = 0x010000000000ull;
 342   static const uptr kShadowEnd     = 0x100000000000ull;
 343   static const uptr kHeapMemBeg    = 0x7d0000000000ull;
 344   static const uptr kHeapMemEnd    = 0x7e0000000000ull;
 345   static const uptr kLoAppMemBeg   = 0x000000001000ull;
 346   static const uptr kLoAppMemEnd   = 0x010000000000ull;
 347   static const uptr kHiAppMemBeg   = 0x7e8000000000ull;
 348   static const uptr kHiAppMemEnd   = 0x800000000000ull; // 47 bits
 349   static const uptr kAppMemMsk     = 0x7c0000000000ull;
 350   static const uptr kAppMemXor     = 0x020000000000ull;
 351   static const uptr kVdsoBeg       = 0x7800000000000000ull;
 352 };
 353
 354 // Indicates the runtime will define the memory regions at runtime.
 355 #define TSAN_RUNTIME_VMA 1
 356 #endif
 357
 358 #elif SANITIZER_GO && !SANITIZER_WINDOWS && defined(__x86_64__)
 359
 360 /* Go on linux, darwin and freebsd on x86_64
 361 0000 0000 1000 - 0000 1000 0000: executable
 362 0000 1000 0000 - 00c0 0000 0000: -
 363 00c0 0000 0000 - 00e0 0000 0000: heap
 364 00e0 0000 0000 - 2000 0000 0000: -
 365 2000 0000 0000 - 2380 0000 0000: shadow
 366 2380 0000 0000 - 3000 0000 0000: -
 367 3000 0000 0000 - 4000 0000 0000: metainfo (memory blocks and sync objects)
 368 4000 0000 0000 - 6000 0000 0000: -
 369 6000 0000 0000 - 6200 0000 0000: traces
 370 6200 0000 0000 - 8000 0000 0000: -
 371 */
 372
 373 struct Mapping {
 374   static const uptr kMetaShadowBeg = 0x300000000000ull;
 375   static const uptr kMetaShadowEnd = 0x400000000000ull;
 376   static const uptr kTraceMemBeg   = 0x600000000000ull;
 377   static const uptr kTraceMemEnd   = 0x620000000000ull;
 378   static const uptr kShadowBeg     = 0x200000000000ull;
 379   static const uptr kShadowEnd     = 0x238000000000ull;
 380   static const uptr kAppMemBeg     = 0x000000001000ull;
 381   static const uptr kAppMemEnd     = 0x00e000000000ull;
 382 };
 383
 384 #elif SANITIZER_GO && SANITIZER_WINDOWS
 385
 386 /* Go on windows
 387 0000 0000 1000 - 0000 1000 0000: executable
 388 0000 1000 0000 - 00f8 0000 0000: -
 389 00c0 0000 0000 - 00e0 0000 0000: heap
 390 00e0 0000 0000 - 0100 0000 0000: -
 391 0100 0000 0000 - 0500 0000 0000: shadow
 392 0500 0000 0000 - 0560 0000 0000: -
 393 0560 0000 0000 - 0760 0000 0000: traces
 394 0760 0000 0000 - 07d0 0000 0000: metainfo (memory blocks and sync objects)
 395 07d0 0000 0000 - 8000 0000 0000: -
 396 */
 397
 398 struct Mapping {
 399   static const uptr kMetaShadowBeg = 0x076000000000ull;
 400   static const uptr kMetaShadowEnd = 0x07d000000000ull;
 401   static const uptr kTraceMemBeg   = 0x056000000000ull;
 402   static const uptr kTraceMemEnd   = 0x076000000000ull;
 403   static const uptr kShadowBeg     = 0x010000000000ull;
 404   static const uptr kShadowEnd     = 0x050000000000ull;
 405   static const uptr kAppMemBeg     = 0x000000001000ull;
 406   static const uptr kAppMemEnd     = 0x00e000000000ull;
 407 };
 408
 409 #elif SANITIZER_GO && defined(__powerpc64__)
 410
 411 /* Only Mapping46 and Mapping47 are currently supported for powercp64 on Go. */
 412
 413 /* Go on linux/powerpc64 (46-bit VMA)
 414 0000 0000 1000 - 0000 1000 0000: executable
 415 0000 1000 0000 - 00c0 0000 0000: -
 416 00c0 0000 0000 - 00e0 0000 0000: heap
 417 00e0 0000 0000 - 2000 0000 0000: -
 418 2000 0000 0000 - 2380 0000 0000: shadow
 419 2380 0000 0000 - 2400 0000 0000: -
 420 2400 0000 0000 - 3400 0000 0000: metainfo (memory blocks and sync objects)
 421 3400 0000 0000 - 3600 0000 0000: -
 422 3600 0000 0000 - 3800 0000 0000: traces
 423 3800 0000 0000 - 4000 0000 0000: -
 424 */
 425
 426 struct Mapping46 {
 427   static const uptr kMetaShadowBeg = 0x240000000000ull;
 428   static const uptr kMetaShadowEnd = 0x340000000000ull;
 429   static const uptr kTraceMemBeg   = 0x360000000000ull;
 430   static const uptr kTraceMemEnd   = 0x380000000000ull;
 431   static const uptr kShadowBeg     = 0x200000000000ull;
 432   static const uptr kShadowEnd     = 0x238000000000ull;
 433   static const uptr kAppMemBeg     = 0x000000001000ull;
 434   static const uptr kAppMemEnd     = 0x00e000000000ull;
 435 };
 436
 437 /* Go on linux/powerpc64 (47-bit VMA)
 438 0000 0000 1000 - 0000 1000 0000: executable
 439 0000 1000 0000 - 00c0 0000 0000: -
 440 00c0 0000 0000 - 00e0 0000 0000: heap
 441 00e0 0000 0000 - 2000 0000 0000: -
 442 2000 0000 0000 - 3000 0000 0000: shadow
 443 3000 0000 0000 - 3000 0000 0000: -
 444 3000 0000 0000 - 4000 0000 0000: metainfo (memory blocks and sync objects)
 445 4000 0000 0000 - 6000 0000 0000: -
 446 6000 0000 0000 - 6200 0000 0000: traces
 447 6200 0000 0000 - 8000 0000 0000: -
 448 */
 449
 450 struct Mapping47 {
 451   static const uptr kMetaShadowBeg = 0x300000000000ull;
 452   static const uptr kMetaShadowEnd = 0x400000000000ull;
 453   static const uptr kTraceMemBeg   = 0x600000000000ull;
 454   static const uptr kTraceMemEnd   = 0x620000000000ull;
 455   static const uptr kShadowBeg     = 0x200000000000ull;
 456   static const uptr kShadowEnd     = 0x300000000000ull;
 457   static const uptr kAppMemBeg     = 0x000000001000ull;
 458   static const uptr kAppMemEnd     = 0x00e000000000ull;
 459 };
 460
 461 // Indicates the runtime will define the memory regions at runtime.
 462 #define TSAN_RUNTIME_VMA 1
 463
 464 #else
 465 # error "Unknown platform"
 466 #endif
 467
 468
 469 #ifdef TSAN_RUNTIME_VMA
 470 extern uptr vmaSize;
 471 #endif
 472
 473
 474 enum MappingType {
 475   MAPPING_LO_APP_BEG,
 476   MAPPING_LO_APP_END,
 477   MAPPING_HI_APP_BEG,
 478   MAPPING_HI_APP_END,
 479 #ifdef TSAN_MID_APP_RANGE
 480   MAPPING_MID_APP_BEG,
 481   MAPPING_MID_APP_END,
 482 #endif
 483   MAPPING_HEAP_BEG,
 484   MAPPING_HEAP_END,
 485   MAPPING_APP_BEG,
 486   MAPPING_APP_END,
 487   MAPPING_SHADOW_BEG,
 488   MAPPING_SHADOW_END,
 489   MAPPING_META_SHADOW_BEG,
 490   MAPPING_META_SHADOW_END,
 491   MAPPING_TRACE_BEG,
 492   MAPPING_TRACE_END,
 493   MAPPING_VDSO_BEG,
 494 };
 495
 496 template<typename Mapping, int Type>
 497 uptr MappingImpl(void) {
 498   switch (Type) {
 499 #if !SANITIZER_GO
 500     case MAPPING_LO_APP_BEG: return Mapping::kLoAppMemBeg;
 501     case MAPPING_LO_APP_END: return Mapping::kLoAppMemEnd;
 502 # ifdef TSAN_MID_APP_RANGE
 503     case MAPPING_MID_APP_BEG: return Mapping::kMidAppMemBeg;
 504     case MAPPING_MID_APP_END: return Mapping::kMidAppMemEnd;
 505 # endif
 506     case MAPPING_HI_APP_BEG: return Mapping::kHiAppMemBeg;
 507     case MAPPING_HI_APP_END: return Mapping::kHiAppMemEnd;
 508     case MAPPING_HEAP_BEG: return Mapping::kHeapMemBeg;
 509     case MAPPING_HEAP_END: return Mapping::kHeapMemEnd;
 510     case MAPPING_VDSO_BEG: return Mapping::kVdsoBeg;
 511 #else
 512     case MAPPING_APP_BEG: return Mapping::kAppMemBeg;
 513     case MAPPING_APP_END: return Mapping::kAppMemEnd;
 514 #endif
 515     case MAPPING_SHADOW_BEG: return Mapping::kShadowBeg;
 516     case MAPPING_SHADOW_END: return Mapping::kShadowEnd;
 517     case MAPPING_META_SHADOW_BEG: return Mapping::kMetaShadowBeg;
 518     case MAPPING_META_SHADOW_END: return Mapping::kMetaShadowEnd;
 519     case MAPPING_TRACE_BEG: return Mapping::kTraceMemBeg;
 520     case MAPPING_TRACE_END: return Mapping::kTraceMemEnd;
 521   }
 522 }
 523
 524 template<int Type>
 525 uptr MappingArchImpl(void) {
 526 #if defined(__aarch64__) && !defined(__APPLE__)
 527   switch (vmaSize) {
 528     case 39: return MappingImpl<Mapping39, Type>();
 529     case 42: return MappingImpl<Mapping42, Type>();
 530     case 48: return MappingImpl<Mapping48, Type>();
 531   }
 532   DCHECK(0);
 533   return 0;
 534 #elif defined(__powerpc64__)
 535   switch (vmaSize) {
 536 #if !SANITIZER_GO
 537     case 44: return MappingImpl<Mapping44, Type>();
 538 #endif
 539     case 46: return MappingImpl<Mapping46, Type>();
 540     case 47: return MappingImpl<Mapping47, Type>();
 541   }
 542   DCHECK(0);
 543   return 0;
 544 #else
 545   return MappingImpl<Mapping, Type>();
 546 #endif
 547 }
 548
 549 #if !SANITIZER_GO
 550 ALWAYS_INLINE
 551 uptr LoAppMemBeg(void) {
 552   return MappingArchImpl<MAPPING_LO_APP_BEG>();
 553 }
 554 ALWAYS_INLINE
 555 uptr LoAppMemEnd(void) {
 556   return MappingArchImpl<MAPPING_LO_APP_END>();
 557 }
 558
 559 #ifdef TSAN_MID_APP_RANGE
 560 ALWAYS_INLINE
 561 uptr MidAppMemBeg(void) {
 562   return MappingArchImpl<MAPPING_MID_APP_BEG>();
 563 }
 564 ALWAYS_INLINE
 565 uptr MidAppMemEnd(void) {
 566   return MappingArchImpl<MAPPING_MID_APP_END>();
 567 }
 568 #endif
 569
 570 ALWAYS_INLINE
 571 uptr HeapMemBeg(void) {
 572   return MappingArchImpl<MAPPING_HEAP_BEG>();
 573 }
 574 ALWAYS_INLINE
 575 uptr HeapMemEnd(void) {
 576   return MappingArchImpl<MAPPING_HEAP_END>();
 577 }
 578
 579 ALWAYS_INLINE
 580 uptr HiAppMemBeg(void) {
 581   return MappingArchImpl<MAPPING_HI_APP_BEG>();
 582 }
 583 ALWAYS_INLINE
 584 uptr HiAppMemEnd(void) {
 585   return MappingArchImpl<MAPPING_HI_APP_END>();
 586 }
 587
 588 ALWAYS_INLINE
 589 uptr VdsoBeg(void) {
 590   return MappingArchImpl<MAPPING_VDSO_BEG>();
 591 }
 592
 593 #else
 594
 595 ALWAYS_INLINE
 596 uptr AppMemBeg(void) {
 597   return MappingArchImpl<MAPPING_APP_BEG>();
 598 }
 599 ALWAYS_INLINE
 600 uptr AppMemEnd(void) {
 601   return MappingArchImpl<MAPPING_APP_END>();
 602 }
 603
 604 #endif
 605
 606 static inline
 607 bool GetUserRegion(int i, uptr *start, uptr *end) {
 608   switch (i) {
 609   default:
 610     return false;
 611 #if !SANITIZER_GO
 612   case 0:
 613     *start = LoAppMemBeg();
 614     *end = LoAppMemEnd();
 615     return true;
 616   case 1:
 617     *start = HiAppMemBeg();
 618     *end = HiAppMemEnd();
 619     return true;
 620   case 2:
 621     *start = HeapMemBeg();
 622     *end = HeapMemEnd();
 623     return true;
 624 # ifdef TSAN_MID_APP_RANGE
 625   case 3:
 626     *start = MidAppMemBeg();
 627     *end = MidAppMemEnd();
 628     return true;
 629 # endif
 630 #else
 631   case 0:
 632     *start = AppMemBeg();
 633     *end = AppMemEnd();
 634     return true;
 635 #endif
 636   }
 637 }
 638
 639 ALWAYS_INLINE
 640 uptr ShadowBeg(void) {
 641   return MappingArchImpl<MAPPING_SHADOW_BEG>();
 642 }
 643 ALWAYS_INLINE
 644 uptr ShadowEnd(void) {
 645   return MappingArchImpl<MAPPING_SHADOW_END>();
 646 }
 647
 648 ALWAYS_INLINE
 649 uptr MetaShadowBeg(void) {
 650   return MappingArchImpl<MAPPING_META_SHADOW_BEG>();
 651 }
 652 ALWAYS_INLINE
 653 uptr MetaShadowEnd(void) {
 654   return MappingArchImpl<MAPPING_META_SHADOW_END>();
 655 }
 656
 657 ALWAYS_INLINE
 658 uptr TraceMemBeg(void) {
 659   return MappingArchImpl<MAPPING_TRACE_BEG>();
 660 }
 661 ALWAYS_INLINE
 662 uptr TraceMemEnd(void) {
 663   return MappingArchImpl<MAPPING_TRACE_END>();
 664 }
 665
 666
 667 template<typename Mapping>
 668 bool IsAppMemImpl(uptr mem) {
 669 #if !SANITIZER_GO
 670   return (mem >= Mapping::kHeapMemBeg && mem < Mapping::kHeapMemEnd) ||
 671 # ifdef TSAN_MID_APP_RANGE
 672          (mem >= Mapping::kMidAppMemBeg && mem < Mapping::kMidAppMemEnd) ||
 673 # endif
 674          (mem >= Mapping::kLoAppMemBeg && mem < Mapping::kLoAppMemEnd) ||
 675          (mem >= Mapping::kHiAppMemBeg && mem < Mapping::kHiAppMemEnd);
 676 #else
 677   return mem >= Mapping::kAppMemBeg && mem < Mapping::kAppMemEnd;
 678 #endif
 679 }
 680
 681 ALWAYS_INLINE
 682 bool IsAppMem(uptr mem) {
 683 #if defined(__aarch64__) && !defined(__APPLE__)
 684   switch (vmaSize) {
 685     case 39: return IsAppMemImpl<Mapping39>(mem);
 686     case 42: return IsAppMemImpl<Mapping42>(mem);
 687     case 48: return IsAppMemImpl<Mapping48>(mem);
 688   }
 689   DCHECK(0);
 690   return false;
 691 #elif defined(__powerpc64__)
 692   switch (vmaSize) {
 693 #if !SANITIZER_GO
 694     case 44: return IsAppMemImpl<Mapping44>(mem);
 695 #endif
 696     case 46: return IsAppMemImpl<Mapping46>(mem);
 697     case 47: return IsAppMemImpl<Mapping47>(mem);
 698   }
 699   DCHECK(0);
 700   return false;
 701 #else
 702   return IsAppMemImpl<Mapping>(mem);
 703 #endif
 704 }
 705
 706
 707 template<typename Mapping>
 708 bool IsShadowMemImpl(uptr mem) {
 709   return mem >= Mapping::kShadowBeg && mem <= Mapping::kShadowEnd;
 710 }
 711
 712 ALWAYS_INLINE
 713 bool IsShadowMem(uptr mem) {
 714 #if defined(__aarch64__) && !defined(__APPLE__)
 715   switch (vmaSize) {
 716     case 39: return IsShadowMemImpl<Mapping39>(mem);
 717     case 42: return IsShadowMemImpl<Mapping42>(mem);
 718     case 48: return IsShadowMemImpl<Mapping48>(mem);
 719   }
 720   DCHECK(0);
 721   return false;
 722 #elif defined(__powerpc64__)
 723   switch (vmaSize) {
 724 #if !SANITIZER_GO
 725     case 44: return IsShadowMemImpl<Mapping44>(mem);
 726 #endif
 727     case 46: return IsShadowMemImpl<Mapping46>(mem);
 728     case 47: return IsShadowMemImpl<Mapping47>(mem);
 729   }
 730   DCHECK(0);
 731   return false;
 732 #else
 733   return IsShadowMemImpl<Mapping>(mem);
 734 #endif
 735 }
 736
 737
 738 template<typename Mapping>
 739 bool IsMetaMemImpl(uptr mem) {
 740   return mem >= Mapping::kMetaShadowBeg && mem <= Mapping::kMetaShadowEnd;
 741 }
 742
 743 ALWAYS_INLINE
 744 bool IsMetaMem(uptr mem) {
 745 #if defined(__aarch64__) && !defined(__APPLE__)
 746   switch (vmaSize) {
 747     case 39: return IsMetaMemImpl<Mapping39>(mem);
 748     case 42: return IsMetaMemImpl<Mapping42>(mem);
 749     case 48: return IsMetaMemImpl<Mapping48>(mem);
 750   }
 751   DCHECK(0);
 752   return false;
 753 #elif defined(__powerpc64__)
 754   switch (vmaSize) {
 755 #if !SANITIZER_GO
 756     case 44: return IsMetaMemImpl<Mapping44>(mem);
 757 #endif
 758     case 46: return IsMetaMemImpl<Mapping46>(mem);
 759     case 47: return IsMetaMemImpl<Mapping47>(mem);
 760   }
 761   DCHECK(0);
 762   return false;
 763 #else
 764   return IsMetaMemImpl<Mapping>(mem);
 765 #endif
 766 }
 767
 768
 769 template<typename Mapping>
 770 uptr MemToShadowImpl(uptr x) {
 771   DCHECK(IsAppMem(x));
 772 #if !SANITIZER_GO
 773   return (((x) & ~(Mapping::kAppMemMsk | (kShadowCell - 1)))
 774       ^ Mapping::kAppMemXor) * kShadowCnt;
 775 #else
 776 # ifndef SANITIZER_WINDOWS
 777   return ((x & ~(kShadowCell - 1)) * kShadowCnt) | Mapping::kShadowBeg;
 778 # else
 779   return ((x & ~(kShadowCell - 1)) * kShadowCnt) + Mapping::kShadowBeg;
 780 # endif
 781 #endif
 782 }
 783
 784 ALWAYS_INLINE
 785 uptr MemToShadow(uptr x) {
 786 #if defined(__aarch64__) && !defined(__APPLE__)
 787   switch (vmaSize) {
 788     case 39: return MemToShadowImpl<Mapping39>(x);
 789     case 42: return MemToShadowImpl<Mapping42>(x);
 790     case 48: return MemToShadowImpl<Mapping48>(x);
 791   }
 792   DCHECK(0);
 793   return 0;
 794 #elif defined(__powerpc64__)
 795   switch (vmaSize) {
 796 #if !SANITIZER_GO
 797     case 44: return MemToShadowImpl<Mapping44>(x);
 798 #endif
 799     case 46: return MemToShadowImpl<Mapping46>(x);
 800     case 47: return MemToShadowImpl<Mapping47>(x);
 801   }
 802   DCHECK(0);
 803   return 0;
 804 #else
 805   return MemToShadowImpl<Mapping>(x);
 806 #endif
 807 }
 808
 809
 810 template<typename Mapping>
 811 u32 *MemToMetaImpl(uptr x) {
 812   DCHECK(IsAppMem(x));
 813 #if !SANITIZER_GO
 814   return (u32*)(((((x) & ~(Mapping::kAppMemMsk | (kMetaShadowCell - 1)))) /
 815       kMetaShadowCell * kMetaShadowSize) | Mapping::kMetaShadowBeg);
 816 #else
 817 # ifndef SANITIZER_WINDOWS
 818   return (u32*)(((x & ~(kMetaShadowCell - 1)) / \
 819       kMetaShadowCell * kMetaShadowSize) | Mapping::kMetaShadowBeg);
 820 # else
 821   return (u32*)(((x & ~(kMetaShadowCell - 1)) / \
 822       kMetaShadowCell * kMetaShadowSize) + Mapping::kMetaShadowBeg);
 823 # endif
 824 #endif
 825 }
 826
 827 ALWAYS_INLINE
 828 u32 *MemToMeta(uptr x) {
 829 #if defined(__aarch64__) && !defined(__APPLE__)
 830   switch (vmaSize) {
 831     case 39: return MemToMetaImpl<Mapping39>(x);
 832     case 42: return MemToMetaImpl<Mapping42>(x);
 833     case 48: return MemToMetaImpl<Mapping48>(x);
 834   }
 835   DCHECK(0);
 836   return 0;
 837 #elif defined(__powerpc64__)
 838   switch (vmaSize) {
 839 #if !SANITIZER_GO
 840     case 44: return MemToMetaImpl<Mapping44>(x);
 841 #endif
 842     case 46: return MemToMetaImpl<Mapping46>(x);
 843     case 47: return MemToMetaImpl<Mapping47>(x);
 844   }
 845   DCHECK(0);
 846   return 0;
 847 #else
 848   return MemToMetaImpl<Mapping>(x);
 849 #endif
 850 }
 851
 852
 853 template<typename Mapping>
 854 uptr ShadowToMemImpl(uptr s) {
 855   DCHECK(IsShadowMem(s));
 856 #if !SANITIZER_GO
 857   // The shadow mapping is non-linear and we've lost some bits, so we don't have
 858   // an easy way to restore the original app address. But the mapping is a
 859   // bijection, so we try to restore the address as belonging to low/mid/high
 860   // range consecutively and see if shadow->app->shadow mapping gives us the
 861   // same address.
 862   uptr p = (s / kShadowCnt) ^ Mapping::kAppMemXor;
 863   if (p >= Mapping::kLoAppMemBeg && p < Mapping::kLoAppMemEnd &&
 864       MemToShadow(p) == s)
 865     return p;
 866 # ifdef TSAN_MID_APP_RANGE
 867   p = ((s / kShadowCnt) ^ Mapping::kAppMemXor) +
 868       (Mapping::kMidAppMemBeg & Mapping::kAppMemMsk);
 869   if (p >= Mapping::kMidAppMemBeg && p < Mapping::kMidAppMemEnd &&
 870       MemToShadow(p) == s)
 871     return p;
 872 # endif
 873   return ((s / kShadowCnt) ^ Mapping::kAppMemXor) | Mapping::kAppMemMsk;
 874 #else  // #if !SANITIZER_GO
 875 # ifndef SANITIZER_WINDOWS
 876   return (s & ~Mapping::kShadowBeg) / kShadowCnt;
 877 # else
 878   return (s - Mapping::kShadowBeg) / kShadowCnt;
 879 # endif // SANITIZER_WINDOWS
 880 #endif
 881 }
 882
 883 ALWAYS_INLINE
 884 uptr ShadowToMem(uptr s) {
 885 #if defined(__aarch64__) && !defined(__APPLE__)
 886   switch (vmaSize) {
 887     case 39: return ShadowToMemImpl<Mapping39>(s);
 888     case 42: return ShadowToMemImpl<Mapping42>(s);
 889     case 48: return ShadowToMemImpl<Mapping48>(s);
 890   }
 891   DCHECK(0);
 892   return 0;
 893 #elif defined(__powerpc64__)
 894   switch (vmaSize) {
 895 #if !SANITIZER_GO
 896     case 44: return ShadowToMemImpl<Mapping44>(s);
 897 #endif
 898     case 46: return ShadowToMemImpl<Mapping46>(s);
 899     case 47: return ShadowToMemImpl<Mapping47>(s);
 900   }
 901   DCHECK(0);
 902   return 0;
 903 #else
 904   return ShadowToMemImpl<Mapping>(s);
 905 #endif
 906 }
 907
 908
 909
 910 // The additional page is to catch shadow stack overflow as paging fault.
 911 // Windows wants 64K alignment for mmaps.
 912 const uptr kTotalTraceSize = (kTraceSize * sizeof(Event) + sizeof(Trace)
 913     + (64 << 10) + (64 << 10) - 1) & ~((64 << 10) - 1);
 914
 915 template<typename Mapping>
 916 uptr GetThreadTraceImpl(int tid) {
 917   uptr p = Mapping::kTraceMemBeg + (uptr)tid * kTotalTraceSize;
 918   DCHECK_LT(p, Mapping::kTraceMemEnd);
 919   return p;
 920 }
 921
 922 ALWAYS_INLINE
 923 uptr GetThreadTrace(int tid) {
 924 #if defined(__aarch64__) && !defined(__APPLE__)
 925   switch (vmaSize) {
 926     case 39: return GetThreadTraceImpl<Mapping39>(tid);
 927     case 42: return GetThreadTraceImpl<Mapping42>(tid);
 928     case 48: return GetThreadTraceImpl<Mapping48>(tid);
 929   }
 930   DCHECK(0);
 931   return 0;
 932 #elif defined(__powerpc64__)
 933   switch (vmaSize) {
 934 #if !SANITIZER_GO
 935     case 44: return GetThreadTraceImpl<Mapping44>(tid);
 936 #endif
 937     case 46: return GetThreadTraceImpl<Mapping46>(tid);
 938     case 47: return GetThreadTraceImpl<Mapping47>(tid);
 939   }
 940   DCHECK(0);
 941   return 0;
 942 #else
 943   return GetThreadTraceImpl<Mapping>(tid);
 944 #endif
 945 }
 946
 947
 948 template<typename Mapping>
 949 uptr GetThreadTraceHeaderImpl(int tid) {
 950   uptr p = Mapping::kTraceMemBeg + (uptr)tid * kTotalTraceSize
 951       + kTraceSize * sizeof(Event);
 952   DCHECK_LT(p, Mapping::kTraceMemEnd);
 953   return p;
 954 }
 955
 956 ALWAYS_INLINE
 957 uptr GetThreadTraceHeader(int tid) {
 958 #if defined(__aarch64__) && !defined(__APPLE__)
 959   switch (vmaSize) {
 960     case 39: return GetThreadTraceHeaderImpl<Mapping39>(tid);
 961     case 42: return GetThreadTraceHeaderImpl<Mapping42>(tid);
 962     case 48: return GetThreadTraceHeaderImpl<Mapping48>(tid);
 963   }
 964   DCHECK(0);
 965   return 0;
 966 #elif defined(__powerpc64__)
 967   switch (vmaSize) {
 968 #if !SANITIZER_GO
 969     case 44: return GetThreadTraceHeaderImpl<Mapping44>(tid);
 970 #endif
 971     case 46: return GetThreadTraceHeaderImpl<Mapping46>(tid);
 972     case 47: return GetThreadTraceHeaderImpl<Mapping47>(tid);
 973   }
 974   DCHECK(0);
 975   return 0;
 976 #else
 977   return GetThreadTraceHeaderImpl<Mapping>(tid);
 978 #endif
 979 }
 980
 981 void InitializePlatform();
 982 void InitializePlatformEarly();
 983 void CheckAndProtect();
 984 void InitializeShadowMemoryPlatform();
 985 void FlushShadowMemory();
 986 void WriteMemoryProfile(char *buf, uptr buf_size, uptr nthread, uptr nlive);
 987 int ExtractResolvFDs(void *state, int *fds, int nfd);
 988 int ExtractRecvmsgFDs(void *msg, int *fds, int nfd);
 989 void ImitateTlsWrite(ThreadState *thr, uptr tls_addr, uptr tls_size);
 990
 991 int call_pthread_cancel_with_cleanup(int(*fn)(void *c, void *m,
 992     void *abstime), void *c, void *m, void *abstime,
 993     void(*cleanup)(void *arg), void *arg);
 994
 995 void DestroyThreadState();
 996
 997 }  // namespace __tsan
 998
 999 #endif  // TSAN_PLATFORM_H