contrib/compiler-rt/lib/sanitizer_common/sanitizer_linux_libcdep.cc

   1 //===-- sanitizer_linux_libcdep.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 shared between AddressSanitizer and ThreadSanitizer
  11 // run-time libraries and implements linux-specific functions from
  12 // sanitizer_libc.h.
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "sanitizer_platform.h"
  16
  17 #if SANITIZER_FREEBSD || SANITIZER_LINUX
  18
  19 #include "sanitizer_allocator_internal.h"
  20 #include "sanitizer_atomic.h"
  21 #include "sanitizer_common.h"
  22 #include "sanitizer_flags.h"
  23 #include "sanitizer_freebsd.h"
  24 #include "sanitizer_linux.h"
  25 #include "sanitizer_placement_new.h"
  26 #include "sanitizer_procmaps.h"
  27 #include "sanitizer_stacktrace.h"
  28
  29 #include <dlfcn.h>  // for dlsym()
  30 #include <link.h>
  31 #include <pthread.h>
  32 #include <signal.h>
  33 #include <sys/resource.h>
  34 #include <syslog.h>
  35
  36 #if SANITIZER_FREEBSD
  37 #include <pthread_np.h>
  38 #include <osreldate.h>
  39 #define pthread_getattr_np pthread_attr_get_np
  40 #endif
  41
  42 #if SANITIZER_LINUX
  43 #include <sys/prctl.h>
  44 #endif
  45
  46 #if SANITIZER_ANDROID
  47 #include <android/api-level.h>
  48 #endif
  49
  50 #if SANITIZER_ANDROID && __ANDROID_API__ < 21
  51 #include <android/log.h>
  52 #endif
  53
  54 #if !SANITIZER_ANDROID
  55 #include <elf.h>
  56 #include <unistd.h>
  57 #endif
  58
  59 namespace __sanitizer {
  60
  61 SANITIZER_WEAK_ATTRIBUTE int
  62 real_sigaction(int signum, const void *act, void *oldact);
  63
  64 int internal_sigaction(int signum, const void *act, void *oldact) {
  65 #if !SANITIZER_GO
  66   if (&real_sigaction)
  67     return real_sigaction(signum, act, oldact);
  68 #endif
  69   return sigaction(signum, (const struct sigaction *)act,
  70                    (struct sigaction *)oldact);
  71 }
  72
  73 void GetThreadStackTopAndBottom(bool at_initialization, uptr *stack_top,
  74                                 uptr *stack_bottom) {
  75   CHECK(stack_top);
  76   CHECK(stack_bottom);
  77   if (at_initialization) {
  78     // This is the main thread. Libpthread may not be initialized yet.
  79     struct rlimit rl;
  80     CHECK_EQ(getrlimit(RLIMIT_STACK, &rl), 0);
  81
  82     // Find the mapping that contains a stack variable.
  83     MemoryMappingLayout proc_maps(/*cache_enabled*/true);
  84     uptr start, end, offset;
  85     uptr prev_end = 0;
  86     while (proc_maps.Next(&start, &end, &offset, nullptr, 0,
  87           /* protection */nullptr)) {
  88       if ((uptr)&rl < end)
  89         break;
  90       prev_end = end;
  91     }
  92     CHECK((uptr)&rl >= start && (uptr)&rl < end);
  93
  94     // Get stacksize from rlimit, but clip it so that it does not overlap
  95     // with other mappings.
  96     uptr stacksize = rl.rlim_cur;
  97     if (stacksize > end - prev_end)
  98       stacksize = end - prev_end;
  99     // When running with unlimited stack size, we still want to set some limit.
 100     // The unlimited stack size is caused by 'ulimit -s unlimited'.
 101     // Also, for some reason, GNU make spawns subprocesses with unlimited stack.
 102     if (stacksize > kMaxThreadStackSize)
 103       stacksize = kMaxThreadStackSize;
 104     *stack_top = end;
 105     *stack_bottom = end - stacksize;
 106     return;
 107   }
 108   pthread_attr_t attr;
 109   pthread_attr_init(&attr);
 110   CHECK_EQ(pthread_getattr_np(pthread_self(), &attr), 0);
 111   uptr stacksize = 0;
 112   void *stackaddr = nullptr;
 113   my_pthread_attr_getstack(&attr, &stackaddr, &stacksize);
 114   pthread_attr_destroy(&attr);
 115
 116   CHECK_LE(stacksize, kMaxThreadStackSize);  // Sanity check.
 117   *stack_top = (uptr)stackaddr + stacksize;
 118   *stack_bottom = (uptr)stackaddr;
 119 }
 120
 121 #if !SANITIZER_GO
 122 bool SetEnv(const char *name, const char *value) {
 123   void *f = dlsym(RTLD_NEXT, "setenv");
 124   if (!f)
 125     return false;
 126   typedef int(*setenv_ft)(const char *name, const char *value, int overwrite);
 127   setenv_ft setenv_f;
 128   CHECK_EQ(sizeof(setenv_f), sizeof(f));
 129   internal_memcpy(&setenv_f, &f, sizeof(f));
 130   return setenv_f(name, value, 1) == 0;
 131 }
 132 #endif
 133
 134 bool SanitizerSetThreadName(const char *name) {
 135 #ifdef PR_SET_NAME
 136   return 0 == prctl(PR_SET_NAME, (unsigned long)name, 0, 0, 0);  // NOLINT
 137 #else
 138   return false;
 139 #endif
 140 }
 141
 142 bool SanitizerGetThreadName(char *name, int max_len) {
 143 #ifdef PR_GET_NAME
 144   char buff[17];
 145   if (prctl(PR_GET_NAME, (unsigned long)buff, 0, 0, 0))  // NOLINT
 146     return false;
 147   internal_strncpy(name, buff, max_len);
 148   name[max_len] = 0;
 149   return true;
 150 #else
 151   return false;
 152 #endif
 153 }
 154
 155 #if !SANITIZER_FREEBSD && !SANITIZER_ANDROID && !SANITIZER_GO
 156 static uptr g_tls_size;
 157
 158 #ifdef __i386__
 159 # define DL_INTERNAL_FUNCTION __attribute__((regparm(3), stdcall))
 160 #else
 161 # define DL_INTERNAL_FUNCTION
 162 #endif
 163
 164 void InitTlsSize() {
 165 // all current supported platforms have 16 bytes stack alignment
 166   const size_t kStackAlign = 16;
 167   typedef void (*get_tls_func)(size_t*, size_t*) DL_INTERNAL_FUNCTION;
 168   get_tls_func get_tls;
 169   void *get_tls_static_info_ptr = dlsym(RTLD_NEXT, "_dl_get_tls_static_info");
 170   CHECK_EQ(sizeof(get_tls), sizeof(get_tls_static_info_ptr));
 171   internal_memcpy(&get_tls, &get_tls_static_info_ptr,
 172                   sizeof(get_tls_static_info_ptr));
 173   CHECK_NE(get_tls, 0);
 174   size_t tls_size = 0;
 175   size_t tls_align = 0;
 176   get_tls(&tls_size, &tls_align);
 177   if (tls_align < kStackAlign)
 178     tls_align = kStackAlign;
 179   g_tls_size = RoundUpTo(tls_size, tls_align);
 180 }
 181 #else
 182 void InitTlsSize() { }
 183 #endif  // !SANITIZER_FREEBSD && !SANITIZER_ANDROID && !SANITIZER_GO
 184
 185 #if (defined(__x86_64__) || defined(__i386__) || defined(__mips__) \
 186     || defined(__aarch64__) || defined(__powerpc64__) || defined(__s390__) \
 187     || defined(__arm__)) && SANITIZER_LINUX && !SANITIZER_ANDROID
 188 // sizeof(struct pthread) from glibc.
 189 static atomic_uintptr_t kThreadDescriptorSize;
 190
 191 uptr ThreadDescriptorSize() {
 192   uptr val = atomic_load(&kThreadDescriptorSize, memory_order_relaxed);
 193   if (val)
 194     return val;
 195 #if defined(__x86_64__) || defined(__i386__) || defined(__arm__)
 196 #ifdef _CS_GNU_LIBC_VERSION
 197   char buf[64];
 198   uptr len = confstr(_CS_GNU_LIBC_VERSION, buf, sizeof(buf));
 199   if (len < sizeof(buf) && internal_strncmp(buf, "glibc 2.", 8) == 0) {
 200     char *end;
 201     int minor = internal_simple_strtoll(buf + 8, &end, 10);
 202     if (end != buf + 8 && (*end == '\0' || *end == '.' || *end == '-')) {
 203       int patch = 0;
 204       if (*end == '.')
 205         // strtoll will return 0 if no valid conversion could be performed
 206         patch = internal_simple_strtoll(end + 1, nullptr, 10);
 207
 208       /* sizeof(struct pthread) values from various glibc versions.  */
 209       if (SANITIZER_X32)
 210         val = 1728;  // Assume only one particular version for x32.
 211       // For ARM sizeof(struct pthread) changed in Glibc 2.23.
 212       else if (SANITIZER_ARM)
 213         val = minor <= 22 ? 1120 : 1216;
 214       else if (minor <= 3)
 215         val = FIRST_32_SECOND_64(1104, 1696);
 216       else if (minor == 4)
 217         val = FIRST_32_SECOND_64(1120, 1728);
 218       else if (minor == 5)
 219         val = FIRST_32_SECOND_64(1136, 1728);
 220       else if (minor <= 9)
 221         val = FIRST_32_SECOND_64(1136, 1712);
 222       else if (minor == 10)
 223         val = FIRST_32_SECOND_64(1168, 1776);
 224       else if (minor == 11 || (minor == 12 && patch == 1))
 225         val = FIRST_32_SECOND_64(1168, 2288);
 226       else if (minor <= 13)
 227         val = FIRST_32_SECOND_64(1168, 2304);
 228       else
 229         val = FIRST_32_SECOND_64(1216, 2304);
 230     }
 231     if (val)
 232       atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
 233     return val;
 234   }
 235 #endif
 236 #elif defined(__mips__)
 237   // TODO(sagarthakur): add more values as per different glibc versions.
 238   val = FIRST_32_SECOND_64(1152, 1776);
 239   if (val)
 240     atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
 241   return val;
 242 #elif defined(__aarch64__)
 243   // The sizeof (struct pthread) is the same from GLIBC 2.17 to 2.22.
 244   val = 1776;
 245   atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
 246   return val;
 247 #elif defined(__powerpc64__)
 248   val = 1776; // from glibc.ppc64le 2.20-8.fc21
 249   atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
 250   return val;
 251 #elif defined(__s390__)
 252   val = FIRST_32_SECOND_64(1152, 1776); // valid for glibc 2.22
 253   atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
 254 #endif
 255   return 0;
 256 }
 257
 258 // The offset at which pointer to self is located in the thread descriptor.
 259 const uptr kThreadSelfOffset = FIRST_32_SECOND_64(8, 16);
 260
 261 uptr ThreadSelfOffset() {
 262   return kThreadSelfOffset;
 263 }
 264
 265 #if defined(__mips__) || defined(__powerpc64__)
 266 // TlsPreTcbSize includes size of struct pthread_descr and size of tcb
 267 // head structure. It lies before the static tls blocks.
 268 static uptr TlsPreTcbSize() {
 269 # if defined(__mips__)
 270   const uptr kTcbHead = 16; // sizeof (tcbhead_t)
 271 # elif defined(__powerpc64__)
 272   const uptr kTcbHead = 88; // sizeof (tcbhead_t)
 273 # endif
 274   const uptr kTlsAlign = 16;
 275   const uptr kTlsPreTcbSize =
 276       RoundUpTo(ThreadDescriptorSize() + kTcbHead, kTlsAlign);
 277   return kTlsPreTcbSize;
 278 }
 279 #endif
 280
 281 uptr ThreadSelf() {
 282   uptr descr_addr;
 283 # if defined(__i386__)
 284   asm("mov %%gs:%c1,%0" : "=r"(descr_addr) : "i"(kThreadSelfOffset));
 285 # elif defined(__x86_64__)
 286   asm("mov %%fs:%c1,%0" : "=r"(descr_addr) : "i"(kThreadSelfOffset));
 287 # elif defined(__mips__)
 288   // MIPS uses TLS variant I. The thread pointer (in hardware register $29)
 289   // points to the end of the TCB + 0x7000. The pthread_descr structure is
 290   // immediately in front of the TCB. TlsPreTcbSize() includes the size of the
 291   // TCB and the size of pthread_descr.
 292   const uptr kTlsTcbOffset = 0x7000;
 293   uptr thread_pointer;
 294   asm volatile(".set push;\
 295                 .set mips64r2;\
 296                 rdhwr %0,$29;\
 297                 .set pop" : "=r" (thread_pointer));
 298   descr_addr = thread_pointer - kTlsTcbOffset - TlsPreTcbSize();
 299 # elif defined(__aarch64__) || defined(__arm__)
 300   descr_addr = reinterpret_cast<uptr>(__builtin_thread_pointer()) -
 301                                       ThreadDescriptorSize();
 302 # elif defined(__s390__)
 303   descr_addr = reinterpret_cast<uptr>(__builtin_thread_pointer());
 304 # elif defined(__powerpc64__)
 305   // PPC64LE uses TLS variant I. The thread pointer (in GPR 13)
 306   // points to the end of the TCB + 0x7000. The pthread_descr structure is
 307   // immediately in front of the TCB. TlsPreTcbSize() includes the size of the
 308   // TCB and the size of pthread_descr.
 309   const uptr kTlsTcbOffset = 0x7000;
 310   uptr thread_pointer;
 311   asm("addi %0,13,%1" : "=r"(thread_pointer) : "I"(-kTlsTcbOffset));
 312   descr_addr = thread_pointer - TlsPreTcbSize();
 313 # else
 314 #  error "unsupported CPU arch"
 315 # endif
 316   return descr_addr;
 317 }
 318 #endif  // (x86_64 || i386 || MIPS) && SANITIZER_LINUX
 319
 320 #if SANITIZER_FREEBSD
 321 static void **ThreadSelfSegbase() {
 322   void **segbase = 0;
 323 # if defined(__i386__)
 324   // sysarch(I386_GET_GSBASE, segbase);
 325   __asm __volatile("mov %%gs:0, %0" : "=r" (segbase));
 326 # elif defined(__x86_64__)
 327   // sysarch(AMD64_GET_FSBASE, segbase);
 328   __asm __volatile("movq %%fs:0, %0" : "=r" (segbase));
 329 # else
 330 #  error "unsupported CPU arch for FreeBSD platform"
 331 # endif
 332   return segbase;
 333 }
 334
 335 uptr ThreadSelf() {
 336   return (uptr)ThreadSelfSegbase()[2];
 337 }
 338 #endif  // SANITIZER_FREEBSD
 339
 340 #if !SANITIZER_GO
 341 static void GetTls(uptr *addr, uptr *size) {
 342 #if SANITIZER_LINUX && !SANITIZER_ANDROID
 343 # if defined(__x86_64__) || defined(__i386__) || defined(__s390__)
 344   *addr = ThreadSelf();
 345   *size = GetTlsSize();
 346   *addr -= *size;
 347   *addr += ThreadDescriptorSize();
 348 # elif defined(__mips__) || defined(__aarch64__) || defined(__powerpc64__) \
 349     || defined(__arm__)
 350   *addr = ThreadSelf();
 351   *size = GetTlsSize();
 352 # else
 353   *addr = 0;
 354   *size = 0;
 355 # endif
 356 #elif SANITIZER_FREEBSD
 357   void** segbase = ThreadSelfSegbase();
 358   *addr = 0;
 359   *size = 0;
 360   if (segbase != 0) {
 361     // tcbalign = 16
 362     // tls_size = round(tls_static_space, tcbalign);
 363     // dtv = segbase[1];
 364     // dtv[2] = segbase - tls_static_space;
 365     void **dtv = (void**) segbase[1];
 366     *addr = (uptr) dtv[2];
 367     *size = (*addr == 0) ? 0 : ((uptr) segbase[0] - (uptr) dtv[2]);
 368   }
 369 #elif SANITIZER_ANDROID
 370   *addr = 0;
 371   *size = 0;
 372 #else
 373 # error "Unknown OS"
 374 #endif
 375 }
 376 #endif
 377
 378 #if !SANITIZER_GO
 379 uptr GetTlsSize() {
 380 #if SANITIZER_FREEBSD || SANITIZER_ANDROID
 381   uptr addr, size;
 382   GetTls(&addr, &size);
 383   return size;
 384 #elif defined(__mips__) || defined(__powerpc64__)
 385   return RoundUpTo(g_tls_size + TlsPreTcbSize(), 16);
 386 #else
 387   return g_tls_size;
 388 #endif
 389 }
 390 #endif
 391
 392 void GetThreadStackAndTls(bool main, uptr *stk_addr, uptr *stk_size,
 393                           uptr *tls_addr, uptr *tls_size) {
 394 #if SANITIZER_GO
 395   // Stub implementation for Go.
 396   *stk_addr = *stk_size = *tls_addr = *tls_size = 0;
 397 #else
 398   GetTls(tls_addr, tls_size);
 399
 400   uptr stack_top, stack_bottom;
 401   GetThreadStackTopAndBottom(main, &stack_top, &stack_bottom);
 402   *stk_addr = stack_bottom;
 403   *stk_size = stack_top - stack_bottom;
 404
 405   if (!main) {
 406     // If stack and tls intersect, make them non-intersecting.
 407     if (*tls_addr > *stk_addr && *tls_addr < *stk_addr + *stk_size) {
 408       CHECK_GT(*tls_addr + *tls_size, *stk_addr);
 409       CHECK_LE(*tls_addr + *tls_size, *stk_addr + *stk_size);
 410       *stk_size -= *tls_size;
 411       *tls_addr = *stk_addr + *stk_size;
 412     }
 413   }
 414 #endif
 415 }
 416
 417 # if !SANITIZER_FREEBSD
 418 typedef ElfW(Phdr) Elf_Phdr;
 419 # elif SANITIZER_WORDSIZE == 32 && __FreeBSD_version <= 902001  // v9.2
 420 #  define Elf_Phdr XElf32_Phdr
 421 #  define dl_phdr_info xdl_phdr_info
 422 #  define dl_iterate_phdr(c, b) xdl_iterate_phdr((c), (b))
 423 # endif
 424
 425 struct DlIteratePhdrData {
 426   InternalMmapVector<LoadedModule> *modules;
 427   bool first;
 428 };
 429
 430 static int dl_iterate_phdr_cb(dl_phdr_info *info, size_t size, void *arg) {
 431   DlIteratePhdrData *data = (DlIteratePhdrData*)arg;
 432   InternalScopedString module_name(kMaxPathLength);
 433   if (data->first) {
 434     data->first = false;
 435     // First module is the binary itself.
 436     ReadBinaryNameCached(module_name.data(), module_name.size());
 437   } else if (info->dlpi_name) {
 438     module_name.append("%s", info->dlpi_name);
 439   }
 440   if (module_name[0] == '\0')
 441     return 0;
 442   LoadedModule cur_module;
 443   cur_module.set(module_name.data(), info->dlpi_addr);
 444   for (int i = 0; i < info->dlpi_phnum; i++) {
 445     const Elf_Phdr *phdr = &info->dlpi_phdr[i];
 446     if (phdr->p_type == PT_LOAD) {
 447       uptr cur_beg = info->dlpi_addr + phdr->p_vaddr;
 448       uptr cur_end = cur_beg + phdr->p_memsz;
 449       bool executable = phdr->p_flags & PF_X;
 450       bool readable = phdr->p_flags & PF_R;
 451       cur_module.addAddressRange(cur_beg, cur_end, executable,
 452                                  readable);
 453     }
 454   }
 455   data->modules->push_back(cur_module);
 456   return 0;
 457 }
 458
 459 #if SANITIZER_ANDROID && __ANDROID_API__ < 21
 460 extern "C" __attribute__((weak)) int dl_iterate_phdr(
 461     int (*)(struct dl_phdr_info *, size_t, void *), void *);
 462 #endif
 463
 464 void ListOfModules::init() {
 465   clear();
 466 #if SANITIZER_ANDROID && __ANDROID_API__ <= 22
 467   u32 api_level = AndroidGetApiLevel();
 468   // Fall back to /proc/maps if dl_iterate_phdr is unavailable or broken.
 469   // The runtime check allows the same library to work with
 470   // both K and L (and future) Android releases.
 471   if (api_level <= ANDROID_LOLLIPOP_MR1) { // L or earlier
 472     MemoryMappingLayout memory_mapping(false);
 473     memory_mapping.DumpListOfModules(&modules_);
 474     return;
 475   }
 476 #endif
 477   DlIteratePhdrData data = {&modules_, true};
 478   dl_iterate_phdr(dl_iterate_phdr_cb, &data);
 479 }
 480
 481 // getrusage does not give us the current RSS, only the max RSS.
 482 // Still, this is better than nothing if /proc/self/statm is not available
 483 // for some reason, e.g. due to a sandbox.
 484 static uptr GetRSSFromGetrusage() {
 485   struct rusage usage;
 486   if (getrusage(RUSAGE_SELF, &usage))  // Failed, probably due to a sandbox.
 487     return 0;
 488   return usage.ru_maxrss << 10;  // ru_maxrss is in Kb.
 489 }
 490
 491 uptr GetRSS() {
 492   if (!common_flags()->can_use_proc_maps_statm)
 493     return GetRSSFromGetrusage();
 494   fd_t fd = OpenFile("/proc/self/statm", RdOnly);
 495   if (fd == kInvalidFd)
 496     return GetRSSFromGetrusage();
 497   char buf[64];
 498   uptr len = internal_read(fd, buf, sizeof(buf) - 1);
 499   internal_close(fd);
 500   if ((sptr)len <= 0)
 501     return 0;
 502   buf[len] = 0;
 503   // The format of the file is:
 504   // 1084 89 69 11 0 79 0
 505   // We need the second number which is RSS in pages.
 506   char *pos = buf;
 507   // Skip the first number.
 508   while (*pos >= '0' && *pos <= '9')
 509     pos++;
 510   // Skip whitespaces.
 511   while (!(*pos >= '0' && *pos <= '9') && *pos != 0)
 512     pos++;
 513   // Read the number.
 514   uptr rss = 0;
 515   while (*pos >= '0' && *pos <= '9')
 516     rss = rss * 10 + *pos++ - '0';
 517   return rss * GetPageSizeCached();
 518 }
 519
 520 // 64-bit Android targets don't provide the deprecated __android_log_write.
 521 // Starting with the L release, syslog() works and is preferable to
 522 // __android_log_write.
 523 #if SANITIZER_LINUX
 524
 525 #if SANITIZER_ANDROID
 526 static atomic_uint8_t android_log_initialized;
 527
 528 void AndroidLogInit() {
 529   openlog(GetProcessName(), 0, LOG_USER);
 530   atomic_store(&android_log_initialized, 1, memory_order_release);
 531 }
 532
 533 static bool ShouldLogAfterPrintf() {
 534   return atomic_load(&android_log_initialized, memory_order_acquire);
 535 }
 536 #else
 537 void AndroidLogInit() {}
 538
 539 static bool ShouldLogAfterPrintf() { return true; }
 540 #endif  // SANITIZER_ANDROID
 541
 542 void WriteOneLineToSyslog(const char *s) {
 543 #if SANITIZER_ANDROID &&__ANDROID_API__ < 21
 544   __android_log_write(ANDROID_LOG_INFO, NULL, s);
 545 #else
 546   syslog(LOG_INFO, "%s", s);
 547 #endif
 548 }
 549
 550 void LogMessageOnPrintf(const char *str) {
 551   if (common_flags()->log_to_syslog && ShouldLogAfterPrintf())
 552     WriteToSyslog(str);
 553 }
 554
 555 #endif // SANITIZER_LINUX
 556
 557 } // namespace __sanitizer
 558
 559 #endif // SANITIZER_FREEBSD || SANITIZER_LINUX