1 //===-- sanitizer_linux_libcdep.cc ----------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file is shared between AddressSanitizer and ThreadSanitizer
11 // run-time libraries and implements linux-specific functions from
13 //===----------------------------------------------------------------------===//
15 #include "sanitizer_platform.h"
17 #if SANITIZER_FREEBSD || SANITIZER_LINUX
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"
29 #if SANITIZER_ANDROID || SANITIZER_FREEBSD
30 #include <dlfcn.h> // for dlsym()
36 #include <sys/resource.h>
39 #include <pthread_np.h>
40 #include <osreldate.h>
41 #define pthread_getattr_np pthread_attr_get_np
45 #include <sys/prctl.h>
49 #include <android/api-level.h>
52 #if SANITIZER_ANDROID && __ANDROID_API__ < 21
53 #include <android/log.h>
58 #if !SANITIZER_ANDROID
63 namespace __sanitizer {
65 SANITIZER_WEAK_ATTRIBUTE int
66 real_sigaction(int signum, const void *act, void *oldact);
68 int internal_sigaction(int signum, const void *act, void *oldact) {
71 return real_sigaction(signum, act, oldact);
73 return sigaction(signum, (const struct sigaction *)act,
74 (struct sigaction *)oldact);
77 void GetThreadStackTopAndBottom(bool at_initialization, uptr *stack_top,
81 if (at_initialization) {
82 // This is the main thread. Libpthread may not be initialized yet.
84 CHECK_EQ(getrlimit(RLIMIT_STACK, &rl), 0);
86 // Find the mapping that contains a stack variable.
87 MemoryMappingLayout proc_maps(/*cache_enabled*/true);
88 uptr start, end, offset;
90 while (proc_maps.Next(&start, &end, &offset, nullptr, 0,
91 /* protection */nullptr)) {
96 CHECK((uptr)&rl >= start && (uptr)&rl < end);
98 // Get stacksize from rlimit, but clip it so that it does not overlap
99 // with other mappings.
100 uptr stacksize = rl.rlim_cur;
101 if (stacksize > end - prev_end)
102 stacksize = end - prev_end;
103 // When running with unlimited stack size, we still want to set some limit.
104 // The unlimited stack size is caused by 'ulimit -s unlimited'.
105 // Also, for some reason, GNU make spawns subprocesses with unlimited stack.
106 if (stacksize > kMaxThreadStackSize)
107 stacksize = kMaxThreadStackSize;
109 *stack_bottom = end - stacksize;
113 pthread_attr_init(&attr);
114 CHECK_EQ(pthread_getattr_np(pthread_self(), &attr), 0);
116 void *stackaddr = nullptr;
117 my_pthread_attr_getstack(&attr, &stackaddr, &stacksize);
118 pthread_attr_destroy(&attr);
120 CHECK_LE(stacksize, kMaxThreadStackSize); // Sanity check.
121 *stack_top = (uptr)stackaddr + stacksize;
122 *stack_bottom = (uptr)stackaddr;
126 bool SetEnv(const char *name, const char *value) {
127 void *f = dlsym(RTLD_NEXT, "setenv");
130 typedef int(*setenv_ft)(const char *name, const char *value, int overwrite);
132 CHECK_EQ(sizeof(setenv_f), sizeof(f));
133 internal_memcpy(&setenv_f, &f, sizeof(f));
134 return setenv_f(name, value, 1) == 0;
138 bool SanitizerSetThreadName(const char *name) {
140 return 0 == prctl(PR_SET_NAME, (unsigned long)name, 0, 0, 0); // NOLINT
146 bool SanitizerGetThreadName(char *name, int max_len) {
149 if (prctl(PR_GET_NAME, (unsigned long)buff, 0, 0, 0)) // NOLINT
151 internal_strncpy(name, buff, max_len);
159 #if !SANITIZER_FREEBSD && !SANITIZER_ANDROID && !SANITIZER_GO
160 static uptr g_tls_size;
163 # define DL_INTERNAL_FUNCTION __attribute__((regparm(3), stdcall))
165 # define DL_INTERNAL_FUNCTION
169 // all current supported platforms have 16 bytes stack alignment
170 const size_t kStackAlign = 16;
171 typedef void (*get_tls_func)(size_t*, size_t*) DL_INTERNAL_FUNCTION;
172 get_tls_func get_tls;
173 void *get_tls_static_info_ptr = dlsym(RTLD_NEXT, "_dl_get_tls_static_info");
174 CHECK_EQ(sizeof(get_tls), sizeof(get_tls_static_info_ptr));
175 internal_memcpy(&get_tls, &get_tls_static_info_ptr,
176 sizeof(get_tls_static_info_ptr));
177 CHECK_NE(get_tls, 0);
179 size_t tls_align = 0;
180 get_tls(&tls_size, &tls_align);
181 if (tls_align < kStackAlign)
182 tls_align = kStackAlign;
183 g_tls_size = RoundUpTo(tls_size, tls_align);
186 void InitTlsSize() { }
187 #endif // !SANITIZER_FREEBSD && !SANITIZER_ANDROID && !SANITIZER_GO
189 #if (defined(__x86_64__) || defined(__i386__) || defined(__mips__) \
190 || defined(__aarch64__) || defined(__powerpc64__) || defined(__s390__)) \
191 && SANITIZER_LINUX && !SANITIZER_ANDROID
192 // sizeof(struct pthread) from glibc.
193 static atomic_uintptr_t kThreadDescriptorSize;
195 uptr ThreadDescriptorSize() {
196 uptr val = atomic_load(&kThreadDescriptorSize, memory_order_relaxed);
199 #if defined(__x86_64__) || defined(__i386__)
200 #ifdef _CS_GNU_LIBC_VERSION
202 uptr len = confstr(_CS_GNU_LIBC_VERSION, buf, sizeof(buf));
203 if (len < sizeof(buf) && internal_strncmp(buf, "glibc 2.", 8) == 0) {
205 int minor = internal_simple_strtoll(buf + 8, &end, 10);
206 if (end != buf + 8 && (*end == '\0' || *end == '.')) {
209 // strtoll will return 0 if no valid conversion could be performed
210 patch = internal_simple_strtoll(end + 1, nullptr, 10);
212 /* sizeof(struct pthread) values from various glibc versions. */
214 val = 1728; // Assume only one particular version for x32.
216 val = FIRST_32_SECOND_64(1104, 1696);
218 val = FIRST_32_SECOND_64(1120, 1728);
220 val = FIRST_32_SECOND_64(1136, 1728);
222 val = FIRST_32_SECOND_64(1136, 1712);
223 else if (minor == 10)
224 val = FIRST_32_SECOND_64(1168, 1776);
225 else if (minor == 11 || (minor == 12 && patch == 1))
226 val = FIRST_32_SECOND_64(1168, 2288);
227 else if (minor <= 13)
228 val = FIRST_32_SECOND_64(1168, 2304);
230 val = FIRST_32_SECOND_64(1216, 2304);
233 atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
237 #elif defined(__mips__)
238 // TODO(sagarthakur): add more values as per different glibc versions.
239 val = FIRST_32_SECOND_64(1152, 1776);
241 atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
243 #elif defined(__aarch64__)
244 // The sizeof (struct pthread) is the same from GLIBC 2.17 to 2.22.
246 atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
248 #elif defined(__powerpc64__)
249 val = 1776; // from glibc.ppc64le 2.20-8.fc21
250 atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
252 #elif defined(__s390__)
253 val = FIRST_32_SECOND_64(1152, 1776); // valid for glibc 2.22
254 atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
259 // The offset at which pointer to self is located in the thread descriptor.
260 const uptr kThreadSelfOffset = FIRST_32_SECOND_64(8, 16);
262 uptr ThreadSelfOffset() {
263 return kThreadSelfOffset;
266 #if defined(__mips__) || defined(__powerpc64__)
267 // TlsPreTcbSize includes size of struct pthread_descr and size of tcb
268 // head structure. It lies before the static tls blocks.
269 static uptr TlsPreTcbSize() {
270 # if defined(__mips__)
271 const uptr kTcbHead = 16; // sizeof (tcbhead_t)
272 # elif defined(__powerpc64__)
273 const uptr kTcbHead = 88; // sizeof (tcbhead_t)
275 const uptr kTlsAlign = 16;
276 const uptr kTlsPreTcbSize =
277 (ThreadDescriptorSize() + kTcbHead + kTlsAlign - 1) & ~(kTlsAlign - 1);
279 g_tls_size = (g_tls_size + kTlsPreTcbSize + kTlsAlign -1) & ~(kTlsAlign - 1);
280 return kTlsPreTcbSize;
286 # if defined(__i386__)
287 asm("mov %%gs:%c1,%0" : "=r"(descr_addr) : "i"(kThreadSelfOffset));
288 # elif defined(__x86_64__)
289 asm("mov %%fs:%c1,%0" : "=r"(descr_addr) : "i"(kThreadSelfOffset));
290 # elif defined(__mips__)
291 // MIPS uses TLS variant I. The thread pointer (in hardware register $29)
292 // points to the end of the TCB + 0x7000. The pthread_descr structure is
293 // immediately in front of the TCB. TlsPreTcbSize() includes the size of the
294 // TCB and the size of pthread_descr.
295 const uptr kTlsTcbOffset = 0x7000;
297 asm volatile(".set push;\
300 .set pop" : "=r" (thread_pointer));
301 descr_addr = thread_pointer - kTlsTcbOffset - TlsPreTcbSize();
302 # elif defined(__aarch64__) || 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;
311 asm("addi %0,13,%1" : "=r"(thread_pointer) : "I"(-kTlsTcbOffset));
312 descr_addr = thread_pointer - TlsPreTcbSize();
314 # error "unsupported CPU arch"
318 #endif // (x86_64 || i386 || MIPS) && SANITIZER_LINUX
320 #if SANITIZER_FREEBSD
321 static void **ThreadSelfSegbase() {
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));
330 # error "unsupported CPU arch for FreeBSD platform"
336 return (uptr)ThreadSelfSegbase()[2];
338 #endif // SANITIZER_FREEBSD
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();
347 *addr += ThreadDescriptorSize();
348 # elif defined(__mips__) || defined(__aarch64__) || defined(__powerpc64__)
349 *addr = ThreadSelf();
350 *size = GetTlsSize();
355 #elif SANITIZER_FREEBSD
356 void** segbase = ThreadSelfSegbase();
361 // tls_size = round(tls_static_space, tcbalign);
363 // dtv[2] = segbase - tls_static_space;
364 void **dtv = (void**) segbase[1];
365 *addr = (uptr) dtv[2];
366 *size = (*addr == 0) ? 0 : ((uptr) segbase[0] - (uptr) dtv[2]);
368 #elif SANITIZER_ANDROID
379 #if SANITIZER_FREEBSD || SANITIZER_ANDROID
381 GetTls(&addr, &size);
389 void GetThreadStackAndTls(bool main, uptr *stk_addr, uptr *stk_size,
390 uptr *tls_addr, uptr *tls_size) {
392 // Stub implementation for Go.
393 *stk_addr = *stk_size = *tls_addr = *tls_size = 0;
395 GetTls(tls_addr, tls_size);
397 uptr stack_top, stack_bottom;
398 GetThreadStackTopAndBottom(main, &stack_top, &stack_bottom);
399 *stk_addr = stack_bottom;
400 *stk_size = stack_top - stack_bottom;
403 // If stack and tls intersect, make them non-intersecting.
404 if (*tls_addr > *stk_addr && *tls_addr < *stk_addr + *stk_size) {
405 CHECK_GT(*tls_addr + *tls_size, *stk_addr);
406 CHECK_LE(*tls_addr + *tls_size, *stk_addr + *stk_size);
407 *stk_size -= *tls_size;
408 *tls_addr = *stk_addr + *stk_size;
414 # if !SANITIZER_FREEBSD
415 typedef ElfW(Phdr) Elf_Phdr;
416 # elif SANITIZER_WORDSIZE == 32 && __FreeBSD_version <= 902001 // v9.2
417 # define Elf_Phdr XElf32_Phdr
418 # define dl_phdr_info xdl_phdr_info
419 # define dl_iterate_phdr(c, b) xdl_iterate_phdr((c), (b))
422 struct DlIteratePhdrData {
423 InternalMmapVector<LoadedModule> *modules;
427 static int dl_iterate_phdr_cb(dl_phdr_info *info, size_t size, void *arg) {
428 DlIteratePhdrData *data = (DlIteratePhdrData*)arg;
429 InternalScopedString module_name(kMaxPathLength);
432 // First module is the binary itself.
433 ReadBinaryNameCached(module_name.data(), module_name.size());
434 } else if (info->dlpi_name) {
435 module_name.append("%s", info->dlpi_name);
437 if (module_name[0] == '\0')
439 LoadedModule cur_module;
440 cur_module.set(module_name.data(), info->dlpi_addr);
441 for (int i = 0; i < info->dlpi_phnum; i++) {
442 const Elf_Phdr *phdr = &info->dlpi_phdr[i];
443 if (phdr->p_type == PT_LOAD) {
444 uptr cur_beg = info->dlpi_addr + phdr->p_vaddr;
445 uptr cur_end = cur_beg + phdr->p_memsz;
446 bool executable = phdr->p_flags & PF_X;
447 cur_module.addAddressRange(cur_beg, cur_end, executable);
450 data->modules->push_back(cur_module);
454 #if SANITIZER_ANDROID && __ANDROID_API__ < 21
455 extern "C" __attribute__((weak)) int dl_iterate_phdr(
456 int (*)(struct dl_phdr_info *, size_t, void *), void *);
459 void ListOfModules::init() {
461 #if SANITIZER_ANDROID && __ANDROID_API__ <= 22
462 u32 api_level = AndroidGetApiLevel();
463 // Fall back to /proc/maps if dl_iterate_phdr is unavailable or broken.
464 // The runtime check allows the same library to work with
465 // both K and L (and future) Android releases.
466 if (api_level <= ANDROID_LOLLIPOP_MR1) { // L or earlier
467 MemoryMappingLayout memory_mapping(false);
468 memory_mapping.DumpListOfModules(&modules_);
472 DlIteratePhdrData data = {&modules_, true};
473 dl_iterate_phdr(dl_iterate_phdr_cb, &data);
476 // getrusage does not give us the current RSS, only the max RSS.
477 // Still, this is better than nothing if /proc/self/statm is not available
478 // for some reason, e.g. due to a sandbox.
479 static uptr GetRSSFromGetrusage() {
481 if (getrusage(RUSAGE_SELF, &usage)) // Failed, probably due to a sandbox.
483 return usage.ru_maxrss << 10; // ru_maxrss is in Kb.
487 if (!common_flags()->can_use_proc_maps_statm)
488 return GetRSSFromGetrusage();
489 fd_t fd = OpenFile("/proc/self/statm", RdOnly);
490 if (fd == kInvalidFd)
491 return GetRSSFromGetrusage();
493 uptr len = internal_read(fd, buf, sizeof(buf) - 1);
498 // The format of the file is:
499 // 1084 89 69 11 0 79 0
500 // We need the second number which is RSS in pages.
502 // Skip the first number.
503 while (*pos >= '0' && *pos <= '9')
506 while (!(*pos >= '0' && *pos <= '9') && *pos != 0)
510 while (*pos >= '0' && *pos <= '9')
511 rss = rss * 10 + *pos++ - '0';
512 return rss * GetPageSizeCached();
515 // 64-bit Android targets don't provide the deprecated __android_log_write.
516 // Starting with the L release, syslog() works and is preferable to
517 // __android_log_write.
520 #if SANITIZER_ANDROID
521 static atomic_uint8_t android_log_initialized;
523 void AndroidLogInit() {
524 atomic_store(&android_log_initialized, 1, memory_order_release);
527 static bool ShouldLogAfterPrintf() {
528 return atomic_load(&android_log_initialized, memory_order_acquire);
531 void AndroidLogInit() {}
533 static bool ShouldLogAfterPrintf() { return true; }
534 #endif // SANITIZER_ANDROID
536 void WriteOneLineToSyslog(const char *s) {
537 #if SANITIZER_ANDROID &&__ANDROID_API__ < 21
538 __android_log_write(ANDROID_LOG_INFO, NULL, s);
540 syslog(LOG_INFO, "%s", s);
544 void LogMessageOnPrintf(const char *str) {
545 if (common_flags()->log_to_syslog && ShouldLogAfterPrintf())
549 #endif // SANITIZER_LINUX
551 } // namespace __sanitizer
553 #endif // SANITIZER_FREEBSD || SANITIZER_LINUX