1 //===-- tsan_platform_linux.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 a part of ThreadSanitizer (TSan), a race detector.
12 // Linux- and FreeBSD-specific code.
13 //===----------------------------------------------------------------------===//
16 #include "sanitizer_common/sanitizer_platform.h"
17 #if SANITIZER_LINUX || SANITIZER_FREEBSD
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"
29 #include "tsan_flags.h"
40 #include <sys/personality.h>
43 #include <sys/syscall.h>
44 #include <sys/socket.h>
46 #include <sys/types.h>
47 #include <sys/resource.h>
54 #define __need_res_state
67 extern "C" void *__libc_stack_end;
68 void *__libc_stack_end = 0;
71 #if SANITIZER_LINUX && defined(__aarch64__)
72 void InitializeGuardPtr() __attribute__((visibility("hidden")));
77 #ifdef TSAN_RUNTIME_VMA
78 // Runtime detected VMA size.
94 void FillProfileCallback(uptr p, uptr rss, bool file,
95 uptr *mem, uptr stats_size) {
97 if (p >= ShadowBeg() && p < ShadowEnd())
98 mem[MemShadow] += rss;
99 else if (p >= MetaShadowBeg() && p < MetaShadowEnd())
102 else if (p >= HeapMemBeg() && p < HeapMemEnd())
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;
109 else if (p >= AppMemBeg() && p < AppMemEnd())
110 mem[file ? MemFile : MemMmap] += rss;
112 else if (p >= TraceMemBeg() && p < TraceMemEnd())
113 mem[MemTrace] += rss;
115 mem[MemOther] += rss;
118 void WriteMemoryProfile(char *buf, uptr buf_size, uptr nthread, uptr nlive) {
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,
134 void FlushShadowMemoryCallback(
135 const SuspendedThreadsList &suspended_threads_list,
137 ReleaseMemoryPagesToOS(ShadowBeg(), ShadowEnd());
141 void FlushShadowMemory() {
143 StopTheWorld(FlushShadowMemoryCallback, 0);
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");
154 tmpdir = GetEnv("TEST_TMPDIR");
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))
167 internal_unlink(name); // Unlink it now, so that we can reuse the buffer.
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++)
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)) {
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);
205 void InitializeShadowMemoryPlatform() {
209 #endif // #if !SANITIZER_GO
211 void InitializePlatformEarly() {
212 #ifdef TSAN_RUNTIME_VMA
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);
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);
231 void InitializePlatform() {
232 DisableCoreDumperIfNecessary();
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.
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",
248 SetStackSizeLimitInBytes(kMaxStackSize);
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();
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);
272 // Initialize the guard pointer used in {sig}{set,long}jump.
273 InitializeGuardPtr();
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
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];
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) {
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)
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];
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.
331 pthread_cleanup_push(cleanup, arg);
332 res = fn(c, m, abstime);
333 pthread_cleanup_pop(0);
339 void ReplaceSystemMalloc() { }
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;
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),
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),
371 CHECK_EQ(0, internal_sigprocmask(SIG_SETMASK, &oldset, nullptr));
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));
386 CHECK_EQ(0, internal_sigprocmask(SIG_SETMASK, &oldset, nullptr));
388 #endif // SANITIZER_ANDROID
389 #endif // if !SANITIZER_GO
391 } // namespace __tsan
393 #endif // SANITIZER_LINUX || SANITIZER_FREEBSD