contrib/compiler-rt/lib/tsan/rtl/tsan_platform_linux.cc

   1 //===-- tsan_platform_linux.cc --------------------------------------------===//
   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 // Linux- and FreeBSD-specific code.
  13 //===----------------------------------------------------------------------===//
  14
  15
  16 #include "sanitizer_common/sanitizer_platform.h"
  17 #if SANITIZER_LINUX || SANITIZER_FREEBSD
  18
  19 #include "sanitizer_common/sanitizer_common.h"
  20 #include "sanitizer_common/sanitizer_libc.h"
  21 #include "sanitizer_common/sanitizer_linux.h"
  22 #include "sanitizer_common/sanitizer_platform_limits_posix.h"
  23 #include "sanitizer_common/sanitizer_posix.h"
  24 #include "sanitizer_common/sanitizer_procmaps.h"
  25 #include "sanitizer_common/sanitizer_stoptheworld.h"
  26 #include "sanitizer_common/sanitizer_stackdepot.h"
  27 #include "tsan_platform.h"
  28 #include "tsan_rtl.h"
  29 #include "tsan_flags.h"
  30
  31 #include <fcntl.h>
  32 #include <pthread.h>
  33 #include <signal.h>
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <string.h>
  37 #include <stdarg.h>
  38 #include <sys/mman.h>
  39 #if SANITIZER_LINUX
  40 #include <sys/personality.h>
  41 #include <setjmp.h>
  42 #endif
  43 #include <sys/syscall.h>
  44 #include <sys/socket.h>
  45 #include <sys/time.h>
  46 #include <sys/types.h>
  47 #include <sys/resource.h>
  48 #include <sys/stat.h>
  49 #include <unistd.h>
  50 #include <errno.h>
  51 #include <sched.h>
  52 #include <dlfcn.h>
  53 #if SANITIZER_LINUX
  54 #define __need_res_state
  55 #include <resolv.h>
  56 #endif
  57
  58 #ifdef sa_handler
  59 # undef sa_handler
  60 #endif
  61
  62 #ifdef sa_sigaction
  63 # undef sa_sigaction
  64 #endif
  65
  66 #if SANITIZER_FREEBSD
  67 extern "C" void *__libc_stack_end;
  68 void *__libc_stack_end = 0;
  69 #endif
  70
  71 #if SANITIZER_LINUX && defined(__aarch64__)
  72 void InitializeGuardPtr() __attribute__((visibility("hidden")));
  73 #endif
  74
  75 namespace __tsan {
  76
  77 #ifdef TSAN_RUNTIME_VMA
  78 // Runtime detected VMA size.
  79 uptr vmaSize;
  80 #endif
  81
  82 enum {
  83   MemTotal  = 0,
  84   MemShadow = 1,
  85   MemMeta   = 2,
  86   MemFile   = 3,
  87   MemMmap   = 4,
  88   MemTrace  = 5,
  89   MemHeap   = 6,
  90   MemOther  = 7,
  91   MemCount  = 8,
  92 };
  93
  94 void FillProfileCallback(uptr p, uptr rss, bool file,
  95                          uptr *mem, uptr stats_size) {
  96   mem[MemTotal] += rss;
  97   if (p >= ShadowBeg() && p < ShadowEnd())
  98     mem[MemShadow] += rss;
  99   else if (p >= MetaShadowBeg() && p < MetaShadowEnd())
 100     mem[MemMeta] += rss;
 101 #if !SANITIZER_GO
 102   else if (p >= HeapMemBeg() && p < HeapMemEnd())
 103     mem[MemHeap] += rss;
 104   else if (p >= LoAppMemBeg() && p < LoAppMemEnd())
 105     mem[file ? MemFile : MemMmap] += rss;
 106   else if (p >= HiAppMemBeg() && p < HiAppMemEnd())
 107     mem[file ? MemFile : MemMmap] += rss;
 108 #else
 109   else if (p >= AppMemBeg() && p < AppMemEnd())
 110     mem[file ? MemFile : MemMmap] += rss;
 111 #endif
 112   else if (p >= TraceMemBeg() && p < TraceMemEnd())
 113     mem[MemTrace] += rss;
 114   else
 115     mem[MemOther] += rss;
 116 }
 117
 118 void WriteMemoryProfile(char *buf, uptr buf_size, uptr nthread, uptr nlive) {
 119   uptr mem[MemCount];
 120   internal_memset(mem, 0, sizeof(mem[0]) * MemCount);
 121   __sanitizer::GetMemoryProfile(FillProfileCallback, mem, 7);
 122   StackDepotStats *stacks = StackDepotGetStats();
 123   internal_snprintf(buf, buf_size,
 124       "RSS %zd MB: shadow:%zd meta:%zd file:%zd mmap:%zd"
 125       " trace:%zd heap:%zd other:%zd stacks=%zd[%zd] nthr=%zd/%zd\n",
 126       mem[MemTotal] >> 20, mem[MemShadow] >> 20, mem[MemMeta] >> 20,
 127       mem[MemFile] >> 20, mem[MemMmap] >> 20, mem[MemTrace] >> 20,
 128       mem[MemHeap] >> 20, mem[MemOther] >> 20,
 129       stacks->allocated >> 20, stacks->n_uniq_ids,
 130       nlive, nthread);
 131 }
 132
 133 #if SANITIZER_LINUX
 134 void FlushShadowMemoryCallback(
 135     const SuspendedThreadsList &suspended_threads_list,
 136     void *argument) {
 137   ReleaseMemoryPagesToOS(ShadowBeg(), ShadowEnd());
 138 }
 139 #endif
 140
 141 void FlushShadowMemory() {
 142 #if SANITIZER_LINUX
 143   StopTheWorld(FlushShadowMemoryCallback, 0);
 144 #endif
 145 }
 146
 147 #if !SANITIZER_GO
 148 // Mark shadow for .rodata sections with the special kShadowRodata marker.
 149 // Accesses to .rodata can't race, so this saves time, memory and trace space.
 150 static void MapRodata() {
 151   // First create temp file.
 152   const char *tmpdir = GetEnv("TMPDIR");
 153   if (tmpdir == 0)
 154     tmpdir = GetEnv("TEST_TMPDIR");
 155 #ifdef P_tmpdir
 156   if (tmpdir == 0)
 157     tmpdir = P_tmpdir;
 158 #endif
 159   if (tmpdir == 0)
 160     return;
 161   char name[256];
 162   internal_snprintf(name, sizeof(name), "%s/tsan.rodata.%d",
 163                     tmpdir, (int)internal_getpid());
 164   uptr openrv = internal_open(name, O_RDWR | O_CREAT | O_EXCL, 0600);
 165   if (internal_iserror(openrv))
 166     return;
 167   internal_unlink(name);  // Unlink it now, so that we can reuse the buffer.
 168   fd_t fd = openrv;
 169   // Fill the file with kShadowRodata.
 170   const uptr kMarkerSize = 512 * 1024 / sizeof(u64);
 171   InternalScopedBuffer<u64> marker(kMarkerSize);
 172   // volatile to prevent insertion of memset
 173   for (volatile u64 *p = marker.data(); p < marker.data() + kMarkerSize; p++)
 174     *p = kShadowRodata;
 175   internal_write(fd, marker.data(), marker.size());
 176   // Map the file into memory.
 177   uptr page = internal_mmap(0, GetPageSizeCached(), PROT_READ | PROT_WRITE,
 178                             MAP_PRIVATE | MAP_ANONYMOUS, fd, 0);
 179   if (internal_iserror(page)) {
 180     internal_close(fd);
 181     return;
 182   }
 183   // Map the file into shadow of .rodata sections.
 184   MemoryMappingLayout proc_maps(/*cache_enabled*/true);
 185   uptr start, end, offset, prot;
 186   // Reusing the buffer 'name'.
 187   while (proc_maps.Next(&start, &end, &offset, name, ARRAY_SIZE(name), &prot)) {
 188     if (name[0] != 0 && name[0] != '['
 189         && (prot & MemoryMappingLayout::kProtectionRead)
 190         && (prot & MemoryMappingLayout::kProtectionExecute)
 191         && !(prot & MemoryMappingLayout::kProtectionWrite)
 192         && IsAppMem(start)) {
 193       // Assume it's .rodata
 194       char *shadow_start = (char*)MemToShadow(start);
 195       char *shadow_end = (char*)MemToShadow(end);
 196       for (char *p = shadow_start; p < shadow_end; p += marker.size()) {
 197         internal_mmap(p, Min<uptr>(marker.size(), shadow_end - p),
 198                       PROT_READ, MAP_PRIVATE | MAP_FIXED, fd, 0);
 199       }
 200     }
 201   }
 202   internal_close(fd);
 203 }
 204
 205 void InitializeShadowMemoryPlatform() {
 206   MapRodata();
 207 }
 208
 209 #endif  // #if !SANITIZER_GO
 210
 211 void InitializePlatformEarly() {
 212 #ifdef TSAN_RUNTIME_VMA
 213   vmaSize =
 214     (MostSignificantSetBitIndex(GET_CURRENT_FRAME()) + 1);
 215 #if defined(__aarch64__)
 216   if (vmaSize != 39 && vmaSize != 42 && vmaSize != 48) {
 217     Printf("FATAL: ThreadSanitizer: unsupported VMA range\n");
 218     Printf("FATAL: Found %d - Supported 39, 42 and 48\n", vmaSize);
 219     Die();
 220   }
 221 #elif defined(__powerpc64__)
 222   if (vmaSize != 44 && vmaSize != 46) {
 223     Printf("FATAL: ThreadSanitizer: unsupported VMA range\n");
 224     Printf("FATAL: Found %d - Supported 44 and 46\n", vmaSize);
 225     Die();
 226   }
 227 #endif
 228 #endif
 229 }
 230
 231 void InitializePlatform() {
 232   DisableCoreDumperIfNecessary();
 233
 234   // Go maps shadow memory lazily and works fine with limited address space.
 235   // Unlimited stack is not a problem as well, because the executable
 236   // is not compiled with -pie.
 237   if (!SANITIZER_GO) {
 238     bool reexec = false;
 239     // TSan doesn't play well with unlimited stack size (as stack
 240     // overlaps with shadow memory). If we detect unlimited stack size,
 241     // we re-exec the program with limited stack size as a best effort.
 242     if (StackSizeIsUnlimited()) {
 243       const uptr kMaxStackSize = 32 * 1024 * 1024;
 244       VReport(1, "Program is run with unlimited stack size, which wouldn't "
 245                  "work with ThreadSanitizer.\n"
 246                  "Re-execing with stack size limited to %zd bytes.\n",
 247               kMaxStackSize);
 248       SetStackSizeLimitInBytes(kMaxStackSize);
 249       reexec = true;
 250     }
 251
 252     if (!AddressSpaceIsUnlimited()) {
 253       Report("WARNING: Program is run with limited virtual address space,"
 254              " which wouldn't work with ThreadSanitizer.\n");
 255       Report("Re-execing with unlimited virtual address space.\n");
 256       SetAddressSpaceUnlimited();
 257       reexec = true;
 258     }
 259 #if SANITIZER_LINUX && defined(__aarch64__)
 260     // After patch "arm64: mm: support ARCH_MMAP_RND_BITS." is introduced in
 261     // linux kernel, the random gap between stack and mapped area is increased
 262     // from 128M to 36G on 39-bit aarch64. As it is almost impossible to cover
 263     // this big range, we should disable randomized virtual space on aarch64.
 264     int old_personality = personality(0xffffffff);
 265     if (old_personality != -1 && (old_personality & ADDR_NO_RANDOMIZE) == 0) {
 266       VReport(1, "WARNING: Program is run with randomized virtual address "
 267               "space, which wouldn't work with ThreadSanitizer.\n"
 268               "Re-execing with fixed virtual address space.\n");
 269       CHECK_NE(personality(old_personality | ADDR_NO_RANDOMIZE), -1);
 270       reexec = true;
 271     }
 272     // Initialize the guard pointer used in {sig}{set,long}jump.
 273     InitializeGuardPtr();
 274 #endif
 275     if (reexec)
 276       ReExec();
 277   }
 278
 279 #if !SANITIZER_GO
 280   CheckAndProtect();
 281   InitTlsSize();
 282 #endif
 283 }
 284
 285 #if !SANITIZER_GO
 286 // Extract file descriptors passed to glibc internal __res_iclose function.
 287 // This is required to properly "close" the fds, because we do not see internal
 288 // closes within glibc. The code is a pure hack.
 289 int ExtractResolvFDs(void *state, int *fds, int nfd) {
 290 #if SANITIZER_LINUX && !SANITIZER_ANDROID
 291   int cnt = 0;
 292   __res_state *statp = (__res_state*)state;
 293   for (int i = 0; i < MAXNS && cnt < nfd; i++) {
 294     if (statp->_u._ext.nsaddrs[i] && statp->_u._ext.nssocks[i] != -1)
 295       fds[cnt++] = statp->_u._ext.nssocks[i];
 296   }
 297   return cnt;
 298 #else
 299   return 0;
 300 #endif
 301 }
 302
 303 // Extract file descriptors passed via UNIX domain sockets.
 304 // This is requried to properly handle "open" of these fds.
 305 // see 'man recvmsg' and 'man 3 cmsg'.
 306 int ExtractRecvmsgFDs(void *msgp, int *fds, int nfd) {
 307   int res = 0;
 308   msghdr *msg = (msghdr*)msgp;
 309   struct cmsghdr *cmsg = CMSG_FIRSTHDR(msg);
 310   for (; cmsg; cmsg = CMSG_NXTHDR(msg, cmsg)) {
 311     if (cmsg->cmsg_level != SOL_SOCKET || cmsg->cmsg_type != SCM_RIGHTS)
 312       continue;
 313     int n = (cmsg->cmsg_len - CMSG_LEN(0)) / sizeof(fds[0]);
 314     for (int i = 0; i < n; i++) {
 315       fds[res++] = ((int*)CMSG_DATA(cmsg))[i];
 316       if (res == nfd)
 317         return res;
 318     }
 319   }
 320   return res;
 321 }
 322
 323 // Note: this function runs with async signals enabled,
 324 // so it must not touch any tsan state.
 325 int call_pthread_cancel_with_cleanup(int(*fn)(void *c, void *m,
 326     void *abstime), void *c, void *m, void *abstime,
 327     void(*cleanup)(void *arg), void *arg) {
 328   // pthread_cleanup_push/pop are hardcore macros mess.
 329   // We can't intercept nor call them w/o including pthread.h.
 330   int res;
 331   pthread_cleanup_push(cleanup, arg);
 332   res = fn(c, m, abstime);
 333   pthread_cleanup_pop(0);
 334   return res;
 335 }
 336 #endif
 337
 338 #if !SANITIZER_GO
 339 void ReplaceSystemMalloc() { }
 340 #endif
 341
 342 #if !SANITIZER_GO
 343 #if SANITIZER_ANDROID
 344 // On Android, one thread can call intercepted functions after
 345 // DestroyThreadState(), so add a fake thread state for "dead" threads.
 346 static ThreadState *dead_thread_state = nullptr;
 347
 348 ThreadState *cur_thread() {
 349   ThreadState* thr = reinterpret_cast<ThreadState*>(*get_android_tls_ptr());
 350   if (thr == nullptr) {
 351     __sanitizer_sigset_t emptyset;
 352     internal_sigfillset(&emptyset);
 353     __sanitizer_sigset_t oldset;
 354     CHECK_EQ(0, internal_sigprocmask(SIG_SETMASK, &emptyset, &oldset));
 355     thr = reinterpret_cast<ThreadState*>(*get_android_tls_ptr());
 356     if (thr == nullptr) {
 357       thr = reinterpret_cast<ThreadState*>(MmapOrDie(sizeof(ThreadState),
 358                                                      "ThreadState"));
 359       *get_android_tls_ptr() = reinterpret_cast<uptr>(thr);
 360       if (dead_thread_state == nullptr) {
 361         dead_thread_state = reinterpret_cast<ThreadState*>(
 362             MmapOrDie(sizeof(ThreadState), "ThreadState"));
 363         dead_thread_state->fast_state.SetIgnoreBit();
 364         dead_thread_state->ignore_interceptors = 1;
 365         dead_thread_state->is_dead = true;
 366         *const_cast<int*>(&dead_thread_state->tid) = -1;
 367         CHECK_EQ(0, internal_mprotect(dead_thread_state, sizeof(ThreadState),
 368                                       PROT_READ));
 369       }
 370     }
 371     CHECK_EQ(0, internal_sigprocmask(SIG_SETMASK, &oldset, nullptr));
 372   }
 373   return thr;
 374 }
 375
 376 void cur_thread_finalize() {
 377   __sanitizer_sigset_t emptyset;
 378   internal_sigfillset(&emptyset);
 379   __sanitizer_sigset_t oldset;
 380   CHECK_EQ(0, internal_sigprocmask(SIG_SETMASK, &emptyset, &oldset));
 381   ThreadState* thr = reinterpret_cast<ThreadState*>(*get_android_tls_ptr());
 382   if (thr != dead_thread_state) {
 383     *get_android_tls_ptr() = reinterpret_cast<uptr>(dead_thread_state);
 384     UnmapOrDie(thr, sizeof(ThreadState));
 385   }
 386   CHECK_EQ(0, internal_sigprocmask(SIG_SETMASK, &oldset, nullptr));
 387 }
 388 #endif  // SANITIZER_ANDROID
 389 #endif  // if !SANITIZER_GO
 390
 391 }  // namespace __tsan
 392
 393 #endif  // SANITIZER_LINUX || SANITIZER_FREEBSD