]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/compiler-rt/lib/sanitizer_common/sanitizer_linux_libcdep.cc
Merge clang trunk r300422 and resolve conflicts.
[FreeBSD/FreeBSD.git] / 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     && 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__)
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 == '.')) {
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       else if (minor <= 3)
212         val = FIRST_32_SECOND_64(1104, 1696);
213       else if (minor == 4)
214         val = FIRST_32_SECOND_64(1120, 1728);
215       else if (minor == 5)
216         val = FIRST_32_SECOND_64(1136, 1728);
217       else if (minor <= 9)
218         val = FIRST_32_SECOND_64(1136, 1712);
219       else if (minor == 10)
220         val = FIRST_32_SECOND_64(1168, 1776);
221       else if (minor == 11 || (minor == 12 && patch == 1))
222         val = FIRST_32_SECOND_64(1168, 2288);
223       else if (minor <= 13)
224         val = FIRST_32_SECOND_64(1168, 2304);
225       else
226         val = FIRST_32_SECOND_64(1216, 2304);
227     }
228     if (val)
229       atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
230     return val;
231   }
232 #endif
233 #elif defined(__mips__)
234   // TODO(sagarthakur): add more values as per different glibc versions.
235   val = FIRST_32_SECOND_64(1152, 1776);
236   if (val)
237     atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
238   return val;
239 #elif defined(__aarch64__)
240   // The sizeof (struct pthread) is the same from GLIBC 2.17 to 2.22.
241   val = 1776;
242   atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
243   return val;
244 #elif defined(__powerpc64__)
245   val = 1776; // from glibc.ppc64le 2.20-8.fc21
246   atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
247   return val;
248 #elif defined(__s390__)
249   val = FIRST_32_SECOND_64(1152, 1776); // valid for glibc 2.22
250   atomic_store(&kThreadDescriptorSize, val, memory_order_relaxed);
251 #endif
252   return 0;
253 }
254
255 // The offset at which pointer to self is located in the thread descriptor.
256 const uptr kThreadSelfOffset = FIRST_32_SECOND_64(8, 16);
257
258 uptr ThreadSelfOffset() {
259   return kThreadSelfOffset;
260 }
261
262 #if defined(__mips__) || defined(__powerpc64__)
263 // TlsPreTcbSize includes size of struct pthread_descr and size of tcb
264 // head structure. It lies before the static tls blocks.
265 static uptr TlsPreTcbSize() {
266 # if defined(__mips__)
267   const uptr kTcbHead = 16; // sizeof (tcbhead_t)
268 # elif defined(__powerpc64__)
269   const uptr kTcbHead = 88; // sizeof (tcbhead_t)
270 # endif
271   const uptr kTlsAlign = 16;
272   const uptr kTlsPreTcbSize =
273     (ThreadDescriptorSize() + kTcbHead + kTlsAlign - 1) & ~(kTlsAlign - 1);
274   InitTlsSize();
275   g_tls_size = (g_tls_size + kTlsPreTcbSize + kTlsAlign -1) & ~(kTlsAlign - 1);
276   return kTlsPreTcbSize;
277 }
278 #endif
279
280 uptr ThreadSelf() {
281   uptr descr_addr;
282 # if defined(__i386__)
283   asm("mov %%gs:%c1,%0" : "=r"(descr_addr) : "i"(kThreadSelfOffset));
284 # elif defined(__x86_64__)
285   asm("mov %%fs:%c1,%0" : "=r"(descr_addr) : "i"(kThreadSelfOffset));
286 # elif defined(__mips__)
287   // MIPS uses TLS variant I. The thread pointer (in hardware register $29)
288   // points to the end of the TCB + 0x7000. The pthread_descr structure is
289   // immediately in front of the TCB. TlsPreTcbSize() includes the size of the
290   // TCB and the size of pthread_descr.
291   const uptr kTlsTcbOffset = 0x7000;
292   uptr thread_pointer;
293   asm volatile(".set push;\
294                 .set mips64r2;\
295                 rdhwr %0,$29;\
296                 .set pop" : "=r" (thread_pointer));
297   descr_addr = thread_pointer - kTlsTcbOffset - TlsPreTcbSize();
298 # elif defined(__aarch64__)
299   descr_addr = reinterpret_cast<uptr>(__builtin_thread_pointer()) -
300                                       ThreadDescriptorSize();
301 # elif defined(__s390__)
302   descr_addr = reinterpret_cast<uptr>(__builtin_thread_pointer());
303 # elif defined(__powerpc64__)
304   // PPC64LE uses TLS variant I. The thread pointer (in GPR 13)
305   // points to the end of the TCB + 0x7000. The pthread_descr structure is
306   // immediately in front of the TCB. TlsPreTcbSize() includes the size of the
307   // TCB and the size of pthread_descr.
308   const uptr kTlsTcbOffset = 0x7000;
309   uptr thread_pointer;
310   asm("addi %0,13,%1" : "=r"(thread_pointer) : "I"(-kTlsTcbOffset));
311   descr_addr = thread_pointer - TlsPreTcbSize();
312 # else
313 #  error "unsupported CPU arch"
314 # endif
315   return descr_addr;
316 }
317 #endif  // (x86_64 || i386 || MIPS) && SANITIZER_LINUX
318
319 #if SANITIZER_FREEBSD
320 static void **ThreadSelfSegbase() {
321   void **segbase = 0;
322 # if defined(__i386__)
323   // sysarch(I386_GET_GSBASE, segbase);
324   __asm __volatile("mov %%gs:0, %0" : "=r" (segbase));
325 # elif defined(__x86_64__)
326   // sysarch(AMD64_GET_FSBASE, segbase);
327   __asm __volatile("movq %%fs:0, %0" : "=r" (segbase));
328 # else
329 #  error "unsupported CPU arch for FreeBSD platform"
330 # endif
331   return segbase;
332 }
333
334 uptr ThreadSelf() {
335   return (uptr)ThreadSelfSegbase()[2];
336 }
337 #endif  // SANITIZER_FREEBSD
338
339 #if !SANITIZER_GO
340 static void GetTls(uptr *addr, uptr *size) {
341 #if SANITIZER_LINUX && !SANITIZER_ANDROID
342 # if defined(__x86_64__) || defined(__i386__) || defined(__s390__)
343   *addr = ThreadSelf();
344   *size = GetTlsSize();
345   *addr -= *size;
346   *addr += ThreadDescriptorSize();
347 # elif defined(__mips__) || defined(__aarch64__) || defined(__powerpc64__)
348   *addr = ThreadSelf();
349   *size = GetTlsSize();
350 # else
351   *addr = 0;
352   *size = 0;
353 # endif
354 #elif SANITIZER_FREEBSD
355   void** segbase = ThreadSelfSegbase();
356   *addr = 0;
357   *size = 0;
358   if (segbase != 0) {
359     // tcbalign = 16
360     // tls_size = round(tls_static_space, tcbalign);
361     // dtv = segbase[1];
362     // dtv[2] = segbase - tls_static_space;
363     void **dtv = (void**) segbase[1];
364     *addr = (uptr) dtv[2];
365     *size = (*addr == 0) ? 0 : ((uptr) segbase[0] - (uptr) dtv[2]);
366   }
367 #elif SANITIZER_ANDROID
368   *addr = 0;
369   *size = 0;
370 #else
371 # error "Unknown OS"
372 #endif
373 }
374 #endif
375
376 #if !SANITIZER_GO
377 uptr GetTlsSize() {
378 #if SANITIZER_FREEBSD || SANITIZER_ANDROID
379   uptr addr, size;
380   GetTls(&addr, &size);
381   return size;
382 #else
383   return g_tls_size;
384 #endif
385 }
386 #endif
387
388 void GetThreadStackAndTls(bool main, uptr *stk_addr, uptr *stk_size,
389                           uptr *tls_addr, uptr *tls_size) {
390 #if SANITIZER_GO
391   // Stub implementation for Go.
392   *stk_addr = *stk_size = *tls_addr = *tls_size = 0;
393 #else
394   GetTls(tls_addr, tls_size);
395
396   uptr stack_top, stack_bottom;
397   GetThreadStackTopAndBottom(main, &stack_top, &stack_bottom);
398   *stk_addr = stack_bottom;
399   *stk_size = stack_top - stack_bottom;
400
401   if (!main) {
402     // If stack and tls intersect, make them non-intersecting.
403     if (*tls_addr > *stk_addr && *tls_addr < *stk_addr + *stk_size) {
404       CHECK_GT(*tls_addr + *tls_size, *stk_addr);
405       CHECK_LE(*tls_addr + *tls_size, *stk_addr + *stk_size);
406       *stk_size -= *tls_size;
407       *tls_addr = *stk_addr + *stk_size;
408     }
409   }
410 #endif
411 }
412
413 # if !SANITIZER_FREEBSD
414 typedef ElfW(Phdr) Elf_Phdr;
415 # elif SANITIZER_WORDSIZE == 32 && __FreeBSD_version <= 902001  // v9.2
416 #  define Elf_Phdr XElf32_Phdr
417 #  define dl_phdr_info xdl_phdr_info
418 #  define dl_iterate_phdr(c, b) xdl_iterate_phdr((c), (b))
419 # endif
420
421 struct DlIteratePhdrData {
422   InternalMmapVector<LoadedModule> *modules;
423   bool first;
424 };
425
426 static int dl_iterate_phdr_cb(dl_phdr_info *info, size_t size, void *arg) {
427   DlIteratePhdrData *data = (DlIteratePhdrData*)arg;
428   InternalScopedString module_name(kMaxPathLength);
429   if (data->first) {
430     data->first = false;
431     // First module is the binary itself.
432     ReadBinaryNameCached(module_name.data(), module_name.size());
433   } else if (info->dlpi_name) {
434     module_name.append("%s", info->dlpi_name);
435   }
436   if (module_name[0] == '\0')
437     return 0;
438   LoadedModule cur_module;
439   cur_module.set(module_name.data(), info->dlpi_addr);
440   for (int i = 0; i < info->dlpi_phnum; i++) {
441     const Elf_Phdr *phdr = &info->dlpi_phdr[i];
442     if (phdr->p_type == PT_LOAD) {
443       uptr cur_beg = info->dlpi_addr + phdr->p_vaddr;
444       uptr cur_end = cur_beg + phdr->p_memsz;
445       bool executable = phdr->p_flags & PF_X;
446       cur_module.addAddressRange(cur_beg, cur_end, executable);
447     }
448   }
449   data->modules->push_back(cur_module);
450   return 0;
451 }
452
453 #if SANITIZER_ANDROID && __ANDROID_API__ < 21
454 extern "C" __attribute__((weak)) int dl_iterate_phdr(
455     int (*)(struct dl_phdr_info *, size_t, void *), void *);
456 #endif
457
458 void ListOfModules::init() {
459   clear();
460 #if SANITIZER_ANDROID && __ANDROID_API__ <= 22
461   u32 api_level = AndroidGetApiLevel();
462   // Fall back to /proc/maps if dl_iterate_phdr is unavailable or broken.
463   // The runtime check allows the same library to work with
464   // both K and L (and future) Android releases.
465   if (api_level <= ANDROID_LOLLIPOP_MR1) { // L or earlier
466     MemoryMappingLayout memory_mapping(false);
467     memory_mapping.DumpListOfModules(&modules_);
468     return;
469   }
470 #endif
471   DlIteratePhdrData data = {&modules_, true};
472   dl_iterate_phdr(dl_iterate_phdr_cb, &data);
473 }
474
475 // getrusage does not give us the current RSS, only the max RSS.
476 // Still, this is better than nothing if /proc/self/statm is not available
477 // for some reason, e.g. due to a sandbox.
478 static uptr GetRSSFromGetrusage() {
479   struct rusage usage;
480   if (getrusage(RUSAGE_SELF, &usage))  // Failed, probably due to a sandbox.
481     return 0;
482   return usage.ru_maxrss << 10;  // ru_maxrss is in Kb.
483 }
484
485 uptr GetRSS() {
486   if (!common_flags()->can_use_proc_maps_statm)
487     return GetRSSFromGetrusage();
488   fd_t fd = OpenFile("/proc/self/statm", RdOnly);
489   if (fd == kInvalidFd)
490     return GetRSSFromGetrusage();
491   char buf[64];
492   uptr len = internal_read(fd, buf, sizeof(buf) - 1);
493   internal_close(fd);
494   if ((sptr)len <= 0)
495     return 0;
496   buf[len] = 0;
497   // The format of the file is:
498   // 1084 89 69 11 0 79 0
499   // We need the second number which is RSS in pages.
500   char *pos = buf;
501   // Skip the first number.
502   while (*pos >= '0' && *pos <= '9')
503     pos++;
504   // Skip whitespaces.
505   while (!(*pos >= '0' && *pos <= '9') && *pos != 0)
506     pos++;
507   // Read the number.
508   uptr rss = 0;
509   while (*pos >= '0' && *pos <= '9')
510     rss = rss * 10 + *pos++ - '0';
511   return rss * GetPageSizeCached();
512 }
513
514 // 64-bit Android targets don't provide the deprecated __android_log_write.
515 // Starting with the L release, syslog() works and is preferable to
516 // __android_log_write.
517 #if SANITIZER_LINUX
518
519 #if SANITIZER_ANDROID
520 static atomic_uint8_t android_log_initialized;
521
522 void AndroidLogInit() {
523   openlog(GetProcessName(), 0, LOG_USER);
524   atomic_store(&android_log_initialized, 1, memory_order_release);
525 }
526
527 static bool ShouldLogAfterPrintf() {
528   return atomic_load(&android_log_initialized, memory_order_acquire);
529 }
530 #else
531 void AndroidLogInit() {}
532
533 static bool ShouldLogAfterPrintf() { return true; }
534 #endif  // SANITIZER_ANDROID
535
536 void WriteOneLineToSyslog(const char *s) {
537 #if SANITIZER_ANDROID &&__ANDROID_API__ < 21
538   __android_log_write(ANDROID_LOG_INFO, NULL, s);
539 #else
540   syslog(LOG_INFO, "%s", s);
541 #endif
542 }
543
544 void LogMessageOnPrintf(const char *str) {
545   if (common_flags()->log_to_syslog && ShouldLogAfterPrintf())
546     WriteToSyslog(str);
547 }
548
549 #endif // SANITIZER_LINUX
550
551 } // namespace __sanitizer
552
553 #endif // SANITIZER_FREEBSD || SANITIZER_LINUX