tsan_rtl.cpp revision 1.3 1 1.1 mrg //===-- tsan_rtl.cpp ------------------------------------------------------===//
2 1.1 mrg //
3 1.1 mrg // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 1.1 mrg // See https://llvm.org/LICENSE.txt for license information.
5 1.1 mrg // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 1.1 mrg //
7 1.1 mrg //===----------------------------------------------------------------------===//
8 1.1 mrg //
9 1.1 mrg // This file is a part of ThreadSanitizer (TSan), a race detector.
10 1.1 mrg //
11 1.1 mrg // Main file (entry points) for the TSan run-time.
12 1.1 mrg //===----------------------------------------------------------------------===//
13 1.1 mrg
14 1.3 mrg #include "tsan_rtl.h"
15 1.3 mrg
16 1.1 mrg #include "sanitizer_common/sanitizer_atomic.h"
17 1.1 mrg #include "sanitizer_common/sanitizer_common.h"
18 1.1 mrg #include "sanitizer_common/sanitizer_file.h"
19 1.1 mrg #include "sanitizer_common/sanitizer_libc.h"
20 1.3 mrg #include "sanitizer_common/sanitizer_placement_new.h"
21 1.1 mrg #include "sanitizer_common/sanitizer_stackdepot.h"
22 1.1 mrg #include "sanitizer_common/sanitizer_symbolizer.h"
23 1.1 mrg #include "tsan_defs.h"
24 1.3 mrg #include "tsan_interface.h"
25 1.3 mrg #include "tsan_mman.h"
26 1.1 mrg #include "tsan_platform.h"
27 1.1 mrg #include "tsan_suppressions.h"
28 1.1 mrg #include "tsan_symbolize.h"
29 1.1 mrg #include "ubsan/ubsan_init.h"
30 1.1 mrg
31 1.1 mrg volatile int __tsan_resumed = 0;
32 1.1 mrg
33 1.1 mrg extern "C" void __tsan_resume() {
34 1.1 mrg __tsan_resumed = 1;
35 1.1 mrg }
36 1.1 mrg
37 1.1 mrg namespace __tsan {
38 1.1 mrg
39 1.3 mrg #if !SANITIZER_GO
40 1.3 mrg void (*on_initialize)(void);
41 1.3 mrg int (*on_finalize)(int);
42 1.3 mrg #endif
43 1.3 mrg
44 1.1 mrg #if !SANITIZER_GO && !SANITIZER_MAC
45 1.1 mrg __attribute__((tls_model("initial-exec")))
46 1.3 mrg THREADLOCAL char cur_thread_placeholder[sizeof(ThreadState)] ALIGNED(
47 1.3 mrg SANITIZER_CACHE_LINE_SIZE);
48 1.1 mrg #endif
49 1.3 mrg static char ctx_placeholder[sizeof(Context)] ALIGNED(SANITIZER_CACHE_LINE_SIZE);
50 1.1 mrg Context *ctx;
51 1.1 mrg
52 1.1 mrg // Can be overriden by a front-end.
53 1.1 mrg #ifdef TSAN_EXTERNAL_HOOKS
54 1.1 mrg bool OnFinalize(bool failed);
55 1.1 mrg void OnInitialize();
56 1.1 mrg #else
57 1.3 mrg #include <dlfcn.h>
58 1.1 mrg SANITIZER_WEAK_CXX_DEFAULT_IMPL
59 1.1 mrg bool OnFinalize(bool failed) {
60 1.3 mrg #if !SANITIZER_GO
61 1.3 mrg if (on_finalize)
62 1.3 mrg return on_finalize(failed);
63 1.3 mrg #endif
64 1.1 mrg return failed;
65 1.1 mrg }
66 1.1 mrg SANITIZER_WEAK_CXX_DEFAULT_IMPL
67 1.3 mrg void OnInitialize() {
68 1.3 mrg #if !SANITIZER_GO
69 1.3 mrg if (on_initialize)
70 1.3 mrg on_initialize();
71 1.3 mrg #endif
72 1.3 mrg }
73 1.1 mrg #endif
74 1.1 mrg
75 1.3 mrg static ThreadContextBase *CreateThreadContext(Tid tid) {
76 1.1 mrg // Map thread trace when context is created.
77 1.1 mrg char name[50];
78 1.1 mrg internal_snprintf(name, sizeof(name), "trace %u", tid);
79 1.1 mrg MapThreadTrace(GetThreadTrace(tid), TraceSize() * sizeof(Event), name);
80 1.1 mrg const uptr hdr = GetThreadTraceHeader(tid);
81 1.1 mrg internal_snprintf(name, sizeof(name), "trace header %u", tid);
82 1.1 mrg MapThreadTrace(hdr, sizeof(Trace), name);
83 1.1 mrg new((void*)hdr) Trace();
84 1.1 mrg // We are going to use only a small part of the trace with the default
85 1.1 mrg // value of history_size. However, the constructor writes to the whole trace.
86 1.3 mrg // Release the unused part.
87 1.1 mrg uptr hdr_end = hdr + sizeof(Trace);
88 1.1 mrg hdr_end -= sizeof(TraceHeader) * (kTraceParts - TraceParts());
89 1.1 mrg hdr_end = RoundUp(hdr_end, GetPageSizeCached());
90 1.3 mrg if (hdr_end < hdr + sizeof(Trace)) {
91 1.3 mrg ReleaseMemoryPagesToOS(hdr_end, hdr + sizeof(Trace));
92 1.3 mrg uptr unused = hdr + sizeof(Trace) - hdr_end;
93 1.3 mrg if (hdr_end != (uptr)MmapFixedNoAccess(hdr_end, unused)) {
94 1.3 mrg Report("ThreadSanitizer: failed to mprotect [0x%zx-0x%zx) \n", hdr_end,
95 1.3 mrg unused);
96 1.3 mrg CHECK("unable to mprotect" && 0);
97 1.3 mrg }
98 1.3 mrg }
99 1.3 mrg return New<ThreadContext>(tid);
100 1.1 mrg }
101 1.1 mrg
102 1.1 mrg #if !SANITIZER_GO
103 1.1 mrg static const u32 kThreadQuarantineSize = 16;
104 1.1 mrg #else
105 1.1 mrg static const u32 kThreadQuarantineSize = 64;
106 1.1 mrg #endif
107 1.1 mrg
108 1.1 mrg Context::Context()
109 1.3 mrg : initialized(),
110 1.3 mrg report_mtx(MutexTypeReport),
111 1.3 mrg nreported(),
112 1.3 mrg thread_registry(CreateThreadContext, kMaxTid, kThreadQuarantineSize,
113 1.3 mrg kMaxTidReuse),
114 1.3 mrg racy_mtx(MutexTypeRacy),
115 1.3 mrg racy_stacks(),
116 1.3 mrg racy_addresses(),
117 1.3 mrg fired_suppressions_mtx(MutexTypeFired),
118 1.3 mrg clock_alloc(LINKER_INITIALIZED, "clock allocator") {
119 1.1 mrg fired_suppressions.reserve(8);
120 1.1 mrg }
121 1.1 mrg
122 1.1 mrg // The objects are allocated in TLS, so one may rely on zero-initialization.
123 1.3 mrg ThreadState::ThreadState(Context *ctx, Tid tid, int unique_id, u64 epoch,
124 1.3 mrg unsigned reuse_count, uptr stk_addr, uptr stk_size,
125 1.1 mrg uptr tls_addr, uptr tls_size)
126 1.3 mrg : fast_state(tid, epoch)
127 1.3 mrg // Do not touch these, rely on zero initialization,
128 1.3 mrg // they may be accessed before the ctor.
129 1.3 mrg // , ignore_reads_and_writes()
130 1.3 mrg // , ignore_interceptors()
131 1.3 mrg ,
132 1.3 mrg clock(tid, reuse_count)
133 1.3 mrg #if !SANITIZER_GO
134 1.3 mrg ,
135 1.3 mrg jmp_bufs()
136 1.3 mrg #endif
137 1.3 mrg ,
138 1.3 mrg tid(tid),
139 1.3 mrg unique_id(unique_id),
140 1.3 mrg stk_addr(stk_addr),
141 1.3 mrg stk_size(stk_size),
142 1.3 mrg tls_addr(tls_addr),
143 1.3 mrg tls_size(tls_size)
144 1.1 mrg #if !SANITIZER_GO
145 1.3 mrg ,
146 1.3 mrg last_sleep_clock(tid)
147 1.1 mrg #endif
148 1.1 mrg {
149 1.3 mrg CHECK_EQ(reinterpret_cast<uptr>(this) % SANITIZER_CACHE_LINE_SIZE, 0);
150 1.3 mrg #if !SANITIZER_GO
151 1.3 mrg shadow_stack_pos = shadow_stack;
152 1.3 mrg shadow_stack_end = shadow_stack + kShadowStackSize;
153 1.3 mrg #else
154 1.3 mrg // Setup dynamic shadow stack.
155 1.3 mrg const int kInitStackSize = 8;
156 1.3 mrg shadow_stack = (uptr *)Alloc(kInitStackSize * sizeof(uptr));
157 1.3 mrg shadow_stack_pos = shadow_stack;
158 1.3 mrg shadow_stack_end = shadow_stack + kInitStackSize;
159 1.3 mrg #endif
160 1.1 mrg }
161 1.1 mrg
162 1.1 mrg #if !SANITIZER_GO
163 1.3 mrg void MemoryProfiler(u64 uptime) {
164 1.3 mrg if (ctx->memprof_fd == kInvalidFd)
165 1.3 mrg return;
166 1.1 mrg InternalMmapVector<char> buf(4096);
167 1.3 mrg WriteMemoryProfile(buf.data(), buf.size(), uptime);
168 1.3 mrg WriteToFile(ctx->memprof_fd, buf.data(), internal_strlen(buf.data()));
169 1.1 mrg }
170 1.1 mrg
171 1.3 mrg void InitializeMemoryProfiler() {
172 1.3 mrg ctx->memprof_fd = kInvalidFd;
173 1.3 mrg const char *fname = flags()->profile_memory;
174 1.3 mrg if (!fname || !fname[0])
175 1.3 mrg return;
176 1.3 mrg if (internal_strcmp(fname, "stdout") == 0) {
177 1.3 mrg ctx->memprof_fd = 1;
178 1.3 mrg } else if (internal_strcmp(fname, "stderr") == 0) {
179 1.3 mrg ctx->memprof_fd = 2;
180 1.3 mrg } else {
181 1.3 mrg InternalScopedString filename;
182 1.3 mrg filename.append("%s.%d", fname, (int)internal_getpid());
183 1.3 mrg ctx->memprof_fd = OpenFile(filename.data(), WrOnly);
184 1.3 mrg if (ctx->memprof_fd == kInvalidFd) {
185 1.3 mrg Printf("ThreadSanitizer: failed to open memory profile file '%s'\n",
186 1.3 mrg filename.data());
187 1.3 mrg return;
188 1.3 mrg }
189 1.3 mrg }
190 1.3 mrg MemoryProfiler(0);
191 1.3 mrg MaybeSpawnBackgroundThread();
192 1.3 mrg }
193 1.3 mrg
194 1.3 mrg static void *BackgroundThread(void *arg) {
195 1.1 mrg // This is a non-initialized non-user thread, nothing to see here.
196 1.1 mrg // We don't use ScopedIgnoreInterceptors, because we want ignores to be
197 1.1 mrg // enabled even when the thread function exits (e.g. during pthread thread
198 1.1 mrg // shutdown code).
199 1.3 mrg cur_thread_init()->ignore_interceptors++;
200 1.1 mrg const u64 kMs2Ns = 1000 * 1000;
201 1.3 mrg const u64 start = NanoTime();
202 1.1 mrg
203 1.1 mrg u64 last_flush = NanoTime();
204 1.1 mrg uptr last_rss = 0;
205 1.1 mrg for (int i = 0;
206 1.1 mrg atomic_load(&ctx->stop_background_thread, memory_order_relaxed) == 0;
207 1.1 mrg i++) {
208 1.1 mrg SleepForMillis(100);
209 1.1 mrg u64 now = NanoTime();
210 1.1 mrg
211 1.1 mrg // Flush memory if requested.
212 1.1 mrg if (flags()->flush_memory_ms > 0) {
213 1.1 mrg if (last_flush + flags()->flush_memory_ms * kMs2Ns < now) {
214 1.1 mrg VPrintf(1, "ThreadSanitizer: periodic memory flush\n");
215 1.1 mrg FlushShadowMemory();
216 1.1 mrg last_flush = NanoTime();
217 1.1 mrg }
218 1.1 mrg }
219 1.1 mrg if (flags()->memory_limit_mb > 0) {
220 1.1 mrg uptr rss = GetRSS();
221 1.1 mrg uptr limit = uptr(flags()->memory_limit_mb) << 20;
222 1.1 mrg VPrintf(1, "ThreadSanitizer: memory flush check"
223 1.1 mrg " RSS=%llu LAST=%llu LIMIT=%llu\n",
224 1.1 mrg (u64)rss >> 20, (u64)last_rss >> 20, (u64)limit >> 20);
225 1.1 mrg if (2 * rss > limit + last_rss) {
226 1.1 mrg VPrintf(1, "ThreadSanitizer: flushing memory due to RSS\n");
227 1.1 mrg FlushShadowMemory();
228 1.1 mrg rss = GetRSS();
229 1.1 mrg VPrintf(1, "ThreadSanitizer: memory flushed RSS=%llu\n", (u64)rss>>20);
230 1.1 mrg }
231 1.1 mrg last_rss = rss;
232 1.1 mrg }
233 1.1 mrg
234 1.3 mrg MemoryProfiler(now - start);
235 1.1 mrg
236 1.1 mrg // Flush symbolizer cache if requested.
237 1.1 mrg if (flags()->flush_symbolizer_ms > 0) {
238 1.1 mrg u64 last = atomic_load(&ctx->last_symbolize_time_ns,
239 1.1 mrg memory_order_relaxed);
240 1.1 mrg if (last != 0 && last + flags()->flush_symbolizer_ms * kMs2Ns < now) {
241 1.1 mrg Lock l(&ctx->report_mtx);
242 1.1 mrg ScopedErrorReportLock l2;
243 1.1 mrg SymbolizeFlush();
244 1.1 mrg atomic_store(&ctx->last_symbolize_time_ns, 0, memory_order_relaxed);
245 1.1 mrg }
246 1.1 mrg }
247 1.1 mrg }
248 1.3 mrg return nullptr;
249 1.1 mrg }
250 1.1 mrg
251 1.1 mrg static void StartBackgroundThread() {
252 1.1 mrg ctx->background_thread = internal_start_thread(&BackgroundThread, 0);
253 1.1 mrg }
254 1.1 mrg
255 1.1 mrg #ifndef __mips__
256 1.1 mrg static void StopBackgroundThread() {
257 1.1 mrg atomic_store(&ctx->stop_background_thread, 1, memory_order_relaxed);
258 1.1 mrg internal_join_thread(ctx->background_thread);
259 1.1 mrg ctx->background_thread = 0;
260 1.1 mrg }
261 1.1 mrg #endif
262 1.1 mrg #endif
263 1.1 mrg
264 1.1 mrg void DontNeedShadowFor(uptr addr, uptr size) {
265 1.3 mrg ReleaseMemoryPagesToOS(reinterpret_cast<uptr>(MemToShadow(addr)),
266 1.3 mrg reinterpret_cast<uptr>(MemToShadow(addr + size)));
267 1.1 mrg }
268 1.1 mrg
269 1.1 mrg #if !SANITIZER_GO
270 1.1 mrg void UnmapShadow(ThreadState *thr, uptr addr, uptr size) {
271 1.1 mrg if (size == 0) return;
272 1.1 mrg DontNeedShadowFor(addr, size);
273 1.1 mrg ScopedGlobalProcessor sgp;
274 1.1 mrg ctx->metamap.ResetRange(thr->proc(), addr, size);
275 1.1 mrg }
276 1.1 mrg #endif
277 1.1 mrg
278 1.1 mrg void MapShadow(uptr addr, uptr size) {
279 1.1 mrg // Global data is not 64K aligned, but there are no adjacent mappings,
280 1.1 mrg // so we can get away with unaligned mapping.
281 1.1 mrg // CHECK_EQ(addr, addr & ~((64 << 10) - 1)); // windows wants 64K alignment
282 1.1 mrg const uptr kPageSize = GetPageSizeCached();
283 1.1 mrg uptr shadow_begin = RoundDownTo((uptr)MemToShadow(addr), kPageSize);
284 1.1 mrg uptr shadow_end = RoundUpTo((uptr)MemToShadow(addr + size), kPageSize);
285 1.3 mrg if (!MmapFixedSuperNoReserve(shadow_begin, shadow_end - shadow_begin,
286 1.3 mrg "shadow"))
287 1.1 mrg Die();
288 1.1 mrg
289 1.1 mrg // Meta shadow is 2:1, so tread carefully.
290 1.1 mrg static bool data_mapped = false;
291 1.1 mrg static uptr mapped_meta_end = 0;
292 1.1 mrg uptr meta_begin = (uptr)MemToMeta(addr);
293 1.1 mrg uptr meta_end = (uptr)MemToMeta(addr + size);
294 1.1 mrg meta_begin = RoundDownTo(meta_begin, 64 << 10);
295 1.1 mrg meta_end = RoundUpTo(meta_end, 64 << 10);
296 1.1 mrg if (!data_mapped) {
297 1.1 mrg // First call maps data+bss.
298 1.1 mrg data_mapped = true;
299 1.3 mrg if (!MmapFixedSuperNoReserve(meta_begin, meta_end - meta_begin,
300 1.3 mrg "meta shadow"))
301 1.1 mrg Die();
302 1.1 mrg } else {
303 1.3 mrg // Mapping continuous heap.
304 1.1 mrg // Windows wants 64K alignment.
305 1.1 mrg meta_begin = RoundDownTo(meta_begin, 64 << 10);
306 1.1 mrg meta_end = RoundUpTo(meta_end, 64 << 10);
307 1.1 mrg if (meta_end <= mapped_meta_end)
308 1.1 mrg return;
309 1.1 mrg if (meta_begin < mapped_meta_end)
310 1.1 mrg meta_begin = mapped_meta_end;
311 1.3 mrg if (!MmapFixedSuperNoReserve(meta_begin, meta_end - meta_begin,
312 1.3 mrg "meta shadow"))
313 1.1 mrg Die();
314 1.1 mrg mapped_meta_end = meta_end;
315 1.1 mrg }
316 1.3 mrg VPrintf(2, "mapped meta shadow for (0x%zx-0x%zx) at (0x%zx-0x%zx)\n", addr,
317 1.3 mrg addr + size, meta_begin, meta_end);
318 1.1 mrg }
319 1.1 mrg
320 1.1 mrg void MapThreadTrace(uptr addr, uptr size, const char *name) {
321 1.3 mrg DPrintf("#0: Mapping trace at 0x%zx-0x%zx(0x%zx)\n", addr, addr + size, size);
322 1.1 mrg CHECK_GE(addr, TraceMemBeg());
323 1.1 mrg CHECK_LE(addr + size, TraceMemEnd());
324 1.1 mrg CHECK_EQ(addr, addr & ~((64 << 10) - 1)); // windows wants 64K alignment
325 1.3 mrg if (!MmapFixedSuperNoReserve(addr, size, name)) {
326 1.3 mrg Printf("FATAL: ThreadSanitizer can not mmap thread trace (0x%zx/0x%zx)\n",
327 1.3 mrg addr, size);
328 1.1 mrg Die();
329 1.1 mrg }
330 1.1 mrg }
331 1.1 mrg
332 1.1 mrg #if !SANITIZER_GO
333 1.1 mrg static void OnStackUnwind(const SignalContext &sig, const void *,
334 1.1 mrg BufferedStackTrace *stack) {
335 1.1 mrg stack->Unwind(StackTrace::GetNextInstructionPc(sig.pc), sig.bp, sig.context,
336 1.1 mrg common_flags()->fast_unwind_on_fatal);
337 1.1 mrg }
338 1.1 mrg
339 1.1 mrg static void TsanOnDeadlySignal(int signo, void *siginfo, void *context) {
340 1.1 mrg HandleDeadlySignal(siginfo, context, GetTid(), &OnStackUnwind, nullptr);
341 1.1 mrg }
342 1.1 mrg #endif
343 1.1 mrg
344 1.3 mrg void CheckUnwind() {
345 1.3 mrg // There is high probability that interceptors will check-fail as well,
346 1.3 mrg // on the other hand there is no sense in processing interceptors
347 1.3 mrg // since we are going to die soon.
348 1.3 mrg ScopedIgnoreInterceptors ignore;
349 1.3 mrg #if !SANITIZER_GO
350 1.3 mrg cur_thread()->ignore_sync++;
351 1.3 mrg cur_thread()->ignore_reads_and_writes++;
352 1.3 mrg #endif
353 1.3 mrg PrintCurrentStackSlow(StackTrace::GetCurrentPc());
354 1.3 mrg }
355 1.3 mrg
356 1.3 mrg bool is_initialized;
357 1.3 mrg
358 1.1 mrg void Initialize(ThreadState *thr) {
359 1.1 mrg // Thread safe because done before all threads exist.
360 1.1 mrg if (is_initialized)
361 1.1 mrg return;
362 1.1 mrg is_initialized = true;
363 1.1 mrg // We are not ready to handle interceptors yet.
364 1.1 mrg ScopedIgnoreInterceptors ignore;
365 1.1 mrg SanitizerToolName = "ThreadSanitizer";
366 1.1 mrg // Install tool-specific callbacks in sanitizer_common.
367 1.3 mrg SetCheckUnwindCallback(CheckUnwind);
368 1.1 mrg
369 1.1 mrg ctx = new(ctx_placeholder) Context;
370 1.1 mrg const char *env_name = SANITIZER_GO ? "GORACE" : "TSAN_OPTIONS";
371 1.1 mrg const char *options = GetEnv(env_name);
372 1.1 mrg CacheBinaryName();
373 1.1 mrg CheckASLR();
374 1.1 mrg InitializeFlags(&ctx->flags, options, env_name);
375 1.1 mrg AvoidCVE_2016_2143();
376 1.1 mrg __sanitizer::InitializePlatformEarly();
377 1.1 mrg __tsan::InitializePlatformEarly();
378 1.1 mrg
379 1.1 mrg #if !SANITIZER_GO
380 1.1 mrg // Re-exec ourselves if we need to set additional env or command line args.
381 1.1 mrg MaybeReexec();
382 1.1 mrg
383 1.1 mrg InitializeAllocator();
384 1.1 mrg ReplaceSystemMalloc();
385 1.1 mrg #endif
386 1.1 mrg if (common_flags()->detect_deadlocks)
387 1.1 mrg ctx->dd = DDetector::Create(flags());
388 1.1 mrg Processor *proc = ProcCreate();
389 1.1 mrg ProcWire(proc, thr);
390 1.1 mrg InitializeInterceptors();
391 1.1 mrg InitializePlatform();
392 1.1 mrg InitializeDynamicAnnotations();
393 1.1 mrg #if !SANITIZER_GO
394 1.1 mrg InitializeShadowMemory();
395 1.1 mrg InitializeAllocatorLate();
396 1.1 mrg InstallDeadlySignalHandlers(TsanOnDeadlySignal);
397 1.1 mrg #endif
398 1.1 mrg // Setup correct file descriptor for error reports.
399 1.1 mrg __sanitizer_set_report_path(common_flags()->log_path);
400 1.1 mrg InitializeSuppressions();
401 1.1 mrg #if !SANITIZER_GO
402 1.1 mrg InitializeLibIgnore();
403 1.1 mrg Symbolizer::GetOrInit()->AddHooks(EnterSymbolizer, ExitSymbolizer);
404 1.1 mrg #endif
405 1.1 mrg
406 1.1 mrg VPrintf(1, "***** Running under ThreadSanitizer v2 (pid %d) *****\n",
407 1.1 mrg (int)internal_getpid());
408 1.1 mrg
409 1.1 mrg // Initialize thread 0.
410 1.3 mrg Tid tid = ThreadCreate(thr, 0, 0, true);
411 1.3 mrg CHECK_EQ(tid, kMainTid);
412 1.1 mrg ThreadStart(thr, tid, GetTid(), ThreadType::Regular);
413 1.1 mrg #if TSAN_CONTAINS_UBSAN
414 1.1 mrg __ubsan::InitAsPlugin();
415 1.1 mrg #endif
416 1.1 mrg ctx->initialized = true;
417 1.1 mrg
418 1.1 mrg #if !SANITIZER_GO
419 1.1 mrg Symbolizer::LateInitialize();
420 1.3 mrg InitializeMemoryProfiler();
421 1.1 mrg #endif
422 1.1 mrg
423 1.1 mrg if (flags()->stop_on_start) {
424 1.1 mrg Printf("ThreadSanitizer is suspended at startup (pid %d)."
425 1.1 mrg " Call __tsan_resume().\n",
426 1.1 mrg (int)internal_getpid());
427 1.1 mrg while (__tsan_resumed == 0) {}
428 1.1 mrg }
429 1.1 mrg
430 1.1 mrg OnInitialize();
431 1.1 mrg }
432 1.1 mrg
433 1.1 mrg void MaybeSpawnBackgroundThread() {
434 1.1 mrg // On MIPS, TSan initialization is run before
435 1.1 mrg // __pthread_initialize_minimal_internal() is finished, so we can not spawn
436 1.1 mrg // new threads.
437 1.1 mrg #if !SANITIZER_GO && !defined(__mips__)
438 1.1 mrg static atomic_uint32_t bg_thread = {};
439 1.1 mrg if (atomic_load(&bg_thread, memory_order_relaxed) == 0 &&
440 1.1 mrg atomic_exchange(&bg_thread, 1, memory_order_relaxed) == 0) {
441 1.1 mrg StartBackgroundThread();
442 1.1 mrg SetSandboxingCallback(StopBackgroundThread);
443 1.1 mrg }
444 1.1 mrg #endif
445 1.1 mrg }
446 1.1 mrg
447 1.1 mrg
448 1.1 mrg int Finalize(ThreadState *thr) {
449 1.1 mrg bool failed = false;
450 1.1 mrg
451 1.3 mrg if (common_flags()->print_module_map == 1)
452 1.3 mrg DumpProcessMap();
453 1.1 mrg
454 1.1 mrg if (flags()->atexit_sleep_ms > 0 && ThreadCount(thr) > 1)
455 1.1 mrg SleepForMillis(flags()->atexit_sleep_ms);
456 1.1 mrg
457 1.1 mrg // Wait for pending reports.
458 1.1 mrg ctx->report_mtx.Lock();
459 1.1 mrg { ScopedErrorReportLock l; }
460 1.1 mrg ctx->report_mtx.Unlock();
461 1.1 mrg
462 1.1 mrg #if !SANITIZER_GO
463 1.1 mrg if (Verbosity()) AllocatorPrintStats();
464 1.1 mrg #endif
465 1.1 mrg
466 1.1 mrg ThreadFinalize(thr);
467 1.1 mrg
468 1.1 mrg if (ctx->nreported) {
469 1.1 mrg failed = true;
470 1.1 mrg #if !SANITIZER_GO
471 1.1 mrg Printf("ThreadSanitizer: reported %d warnings\n", ctx->nreported);
472 1.1 mrg #else
473 1.1 mrg Printf("Found %d data race(s)\n", ctx->nreported);
474 1.1 mrg #endif
475 1.1 mrg }
476 1.1 mrg
477 1.1 mrg if (common_flags()->print_suppressions)
478 1.1 mrg PrintMatchedSuppressions();
479 1.1 mrg
480 1.1 mrg failed = OnFinalize(failed);
481 1.1 mrg
482 1.1 mrg return failed ? common_flags()->exitcode : 0;
483 1.1 mrg }
484 1.1 mrg
485 1.1 mrg #if !SANITIZER_GO
486 1.3 mrg void ForkBefore(ThreadState *thr, uptr pc) NO_THREAD_SAFETY_ANALYSIS {
487 1.3 mrg ctx->thread_registry.Lock();
488 1.1 mrg ctx->report_mtx.Lock();
489 1.3 mrg ScopedErrorReportLock::Lock();
490 1.3 mrg // Suppress all reports in the pthread_atfork callbacks.
491 1.3 mrg // Reports will deadlock on the report_mtx.
492 1.3 mrg // We could ignore sync operations as well,
493 1.3 mrg // but so far it's unclear if it will do more good or harm.
494 1.3 mrg // Unnecessarily ignoring things can lead to false positives later.
495 1.3 mrg thr->suppress_reports++;
496 1.3 mrg // On OS X, REAL(fork) can call intercepted functions (OSSpinLockLock), and
497 1.3 mrg // we'll assert in CheckNoLocks() unless we ignore interceptors.
498 1.3 mrg thr->ignore_interceptors++;
499 1.3 mrg }
500 1.3 mrg
501 1.3 mrg void ForkParentAfter(ThreadState *thr, uptr pc) NO_THREAD_SAFETY_ANALYSIS {
502 1.3 mrg thr->suppress_reports--; // Enabled in ForkBefore.
503 1.3 mrg thr->ignore_interceptors--;
504 1.3 mrg ScopedErrorReportLock::Unlock();
505 1.1 mrg ctx->report_mtx.Unlock();
506 1.3 mrg ctx->thread_registry.Unlock();
507 1.1 mrg }
508 1.1 mrg
509 1.3 mrg void ForkChildAfter(ThreadState *thr, uptr pc,
510 1.3 mrg bool start_thread) NO_THREAD_SAFETY_ANALYSIS {
511 1.3 mrg thr->suppress_reports--; // Enabled in ForkBefore.
512 1.3 mrg thr->ignore_interceptors--;
513 1.3 mrg ScopedErrorReportLock::Unlock();
514 1.1 mrg ctx->report_mtx.Unlock();
515 1.3 mrg ctx->thread_registry.Unlock();
516 1.1 mrg
517 1.1 mrg uptr nthread = 0;
518 1.3 mrg ctx->thread_registry.GetNumberOfThreads(0, 0, &nthread /* alive threads */);
519 1.1 mrg VPrintf(1, "ThreadSanitizer: forked new process with pid %d,"
520 1.1 mrg " parent had %d threads\n", (int)internal_getpid(), (int)nthread);
521 1.1 mrg if (nthread == 1) {
522 1.3 mrg if (start_thread)
523 1.3 mrg StartBackgroundThread();
524 1.1 mrg } else {
525 1.1 mrg // We've just forked a multi-threaded process. We cannot reasonably function
526 1.1 mrg // after that (some mutexes may be locked before fork). So just enable
527 1.1 mrg // ignores for everything in the hope that we will exec soon.
528 1.1 mrg ctx->after_multithreaded_fork = true;
529 1.1 mrg thr->ignore_interceptors++;
530 1.1 mrg ThreadIgnoreBegin(thr, pc);
531 1.1 mrg ThreadIgnoreSyncBegin(thr, pc);
532 1.1 mrg }
533 1.1 mrg }
534 1.1 mrg #endif
535 1.1 mrg
536 1.1 mrg #if SANITIZER_GO
537 1.1 mrg NOINLINE
538 1.1 mrg void GrowShadowStack(ThreadState *thr) {
539 1.1 mrg const int sz = thr->shadow_stack_end - thr->shadow_stack;
540 1.1 mrg const int newsz = 2 * sz;
541 1.3 mrg auto *newstack = (uptr *)Alloc(newsz * sizeof(uptr));
542 1.1 mrg internal_memcpy(newstack, thr->shadow_stack, sz * sizeof(uptr));
543 1.3 mrg Free(thr->shadow_stack);
544 1.1 mrg thr->shadow_stack = newstack;
545 1.1 mrg thr->shadow_stack_pos = newstack + sz;
546 1.1 mrg thr->shadow_stack_end = newstack + newsz;
547 1.1 mrg }
548 1.1 mrg #endif
549 1.1 mrg
550 1.3 mrg StackID CurrentStackId(ThreadState *thr, uptr pc) {
551 1.1 mrg if (!thr->is_inited) // May happen during bootstrap.
552 1.3 mrg return kInvalidStackID;
553 1.1 mrg if (pc != 0) {
554 1.1 mrg #if !SANITIZER_GO
555 1.1 mrg DCHECK_LT(thr->shadow_stack_pos, thr->shadow_stack_end);
556 1.1 mrg #else
557 1.1 mrg if (thr->shadow_stack_pos == thr->shadow_stack_end)
558 1.1 mrg GrowShadowStack(thr);
559 1.1 mrg #endif
560 1.1 mrg thr->shadow_stack_pos[0] = pc;
561 1.1 mrg thr->shadow_stack_pos++;
562 1.1 mrg }
563 1.3 mrg StackID id = StackDepotPut(
564 1.1 mrg StackTrace(thr->shadow_stack, thr->shadow_stack_pos - thr->shadow_stack));
565 1.1 mrg if (pc != 0)
566 1.1 mrg thr->shadow_stack_pos--;
567 1.1 mrg return id;
568 1.1 mrg }
569 1.1 mrg
570 1.3 mrg namespace v3 {
571 1.3 mrg
572 1.3 mrg NOINLINE
573 1.3 mrg void TraceSwitchPart(ThreadState *thr) {
574 1.3 mrg Trace *trace = &thr->tctx->trace;
575 1.3 mrg Event *pos = reinterpret_cast<Event *>(atomic_load_relaxed(&thr->trace_pos));
576 1.3 mrg DCHECK_EQ(reinterpret_cast<uptr>(pos + 1) & TracePart::kAlignment, 0);
577 1.3 mrg auto *part = trace->parts.Back();
578 1.3 mrg DPrintf("TraceSwitchPart part=%p pos=%p\n", part, pos);
579 1.3 mrg if (part) {
580 1.3 mrg // We can get here when we still have space in the current trace part.
581 1.3 mrg // The fast-path check in TraceAcquire has false positives in the middle of
582 1.3 mrg // the part. Check if we are indeed at the end of the current part or not,
583 1.3 mrg // and fill any gaps with NopEvent's.
584 1.3 mrg Event *end = &part->events[TracePart::kSize];
585 1.3 mrg DCHECK_GE(pos, &part->events[0]);
586 1.3 mrg DCHECK_LE(pos, end);
587 1.3 mrg if (pos + 1 < end) {
588 1.3 mrg if ((reinterpret_cast<uptr>(pos) & TracePart::kAlignment) ==
589 1.3 mrg TracePart::kAlignment)
590 1.3 mrg *pos++ = NopEvent;
591 1.3 mrg *pos++ = NopEvent;
592 1.3 mrg DCHECK_LE(pos + 2, end);
593 1.3 mrg atomic_store_relaxed(&thr->trace_pos, reinterpret_cast<uptr>(pos));
594 1.3 mrg // Ensure we setup trace so that the next TraceAcquire
595 1.3 mrg // won't detect trace part end.
596 1.3 mrg Event *ev;
597 1.3 mrg CHECK(TraceAcquire(thr, &ev));
598 1.3 mrg return;
599 1.3 mrg }
600 1.3 mrg // We are indeed at the end.
601 1.3 mrg for (; pos < end; pos++) *pos = NopEvent;
602 1.3 mrg }
603 1.3 mrg #if !SANITIZER_GO
604 1.3 mrg if (ctx->after_multithreaded_fork) {
605 1.3 mrg // We just need to survive till exec.
606 1.3 mrg CHECK(part);
607 1.3 mrg atomic_store_relaxed(&thr->trace_pos,
608 1.3 mrg reinterpret_cast<uptr>(&part->events[0]));
609 1.3 mrg return;
610 1.3 mrg }
611 1.3 mrg #endif
612 1.3 mrg part = new (MmapOrDie(sizeof(TracePart), "TracePart")) TracePart();
613 1.3 mrg part->trace = trace;
614 1.3 mrg thr->trace_prev_pc = 0;
615 1.3 mrg {
616 1.3 mrg Lock lock(&trace->mtx);
617 1.3 mrg trace->parts.PushBack(part);
618 1.3 mrg atomic_store_relaxed(&thr->trace_pos,
619 1.3 mrg reinterpret_cast<uptr>(&part->events[0]));
620 1.3 mrg }
621 1.3 mrg // Make this part self-sufficient by restoring the current stack
622 1.3 mrg // and mutex set in the beginning of the trace.
623 1.3 mrg TraceTime(thr);
624 1.3 mrg for (uptr *pos = &thr->shadow_stack[0]; pos < thr->shadow_stack_pos; pos++)
625 1.3 mrg CHECK(TryTraceFunc(thr, *pos));
626 1.3 mrg for (uptr i = 0; i < thr->mset.Size(); i++) {
627 1.3 mrg MutexSet::Desc d = thr->mset.Get(i);
628 1.3 mrg TraceMutexLock(thr, d.write ? EventType::kLock : EventType::kRLock, 0,
629 1.3 mrg d.addr, d.stack_id);
630 1.3 mrg }
631 1.3 mrg }
632 1.3 mrg
633 1.3 mrg } // namespace v3
634 1.3 mrg
635 1.1 mrg void TraceSwitch(ThreadState *thr) {
636 1.1 mrg #if !SANITIZER_GO
637 1.1 mrg if (ctx->after_multithreaded_fork)
638 1.1 mrg return;
639 1.1 mrg #endif
640 1.1 mrg thr->nomalloc++;
641 1.1 mrg Trace *thr_trace = ThreadTrace(thr->tid);
642 1.1 mrg Lock l(&thr_trace->mtx);
643 1.1 mrg unsigned trace = (thr->fast_state.epoch() / kTracePartSize) % TraceParts();
644 1.1 mrg TraceHeader *hdr = &thr_trace->headers[trace];
645 1.1 mrg hdr->epoch0 = thr->fast_state.epoch();
646 1.1 mrg ObtainCurrentStack(thr, 0, &hdr->stack0);
647 1.1 mrg hdr->mset0 = thr->mset;
648 1.1 mrg thr->nomalloc--;
649 1.1 mrg }
650 1.1 mrg
651 1.3 mrg Trace *ThreadTrace(Tid tid) { return (Trace *)GetThreadTraceHeader(tid); }
652 1.1 mrg
653 1.1 mrg uptr TraceTopPC(ThreadState *thr) {
654 1.1 mrg Event *events = (Event*)GetThreadTrace(thr->tid);
655 1.1 mrg uptr pc = events[thr->fast_state.GetTracePos()];
656 1.1 mrg return pc;
657 1.1 mrg }
658 1.1 mrg
659 1.1 mrg uptr TraceSize() {
660 1.1 mrg return (uptr)(1ull << (kTracePartSizeBits + flags()->history_size + 1));
661 1.1 mrg }
662 1.1 mrg
663 1.1 mrg uptr TraceParts() {
664 1.1 mrg return TraceSize() / kTracePartSize;
665 1.1 mrg }
666 1.1 mrg
667 1.1 mrg #if !SANITIZER_GO
668 1.1 mrg extern "C" void __tsan_trace_switch() {
669 1.1 mrg TraceSwitch(cur_thread());
670 1.1 mrg }
671 1.1 mrg
672 1.1 mrg extern "C" void __tsan_report_race() {
673 1.1 mrg ReportRace(cur_thread());
674 1.1 mrg }
675 1.1 mrg #endif
676 1.1 mrg
677 1.3 mrg void ThreadIgnoreBegin(ThreadState *thr, uptr pc) {
678 1.1 mrg DPrintf("#%d: ThreadIgnoreBegin\n", thr->tid);
679 1.1 mrg thr->ignore_reads_and_writes++;
680 1.1 mrg CHECK_GT(thr->ignore_reads_and_writes, 0);
681 1.1 mrg thr->fast_state.SetIgnoreBit();
682 1.1 mrg #if !SANITIZER_GO
683 1.3 mrg if (pc && !ctx->after_multithreaded_fork)
684 1.1 mrg thr->mop_ignore_set.Add(CurrentStackId(thr, pc));
685 1.1 mrg #endif
686 1.1 mrg }
687 1.1 mrg
688 1.3 mrg void ThreadIgnoreEnd(ThreadState *thr) {
689 1.1 mrg DPrintf("#%d: ThreadIgnoreEnd\n", thr->tid);
690 1.1 mrg CHECK_GT(thr->ignore_reads_and_writes, 0);
691 1.1 mrg thr->ignore_reads_and_writes--;
692 1.1 mrg if (thr->ignore_reads_and_writes == 0) {
693 1.1 mrg thr->fast_state.ClearIgnoreBit();
694 1.1 mrg #if !SANITIZER_GO
695 1.1 mrg thr->mop_ignore_set.Reset();
696 1.1 mrg #endif
697 1.1 mrg }
698 1.1 mrg }
699 1.1 mrg
700 1.1 mrg #if !SANITIZER_GO
701 1.1 mrg extern "C" SANITIZER_INTERFACE_ATTRIBUTE
702 1.1 mrg uptr __tsan_testonly_shadow_stack_current_size() {
703 1.1 mrg ThreadState *thr = cur_thread();
704 1.1 mrg return thr->shadow_stack_pos - thr->shadow_stack;
705 1.1 mrg }
706 1.1 mrg #endif
707 1.1 mrg
708 1.3 mrg void ThreadIgnoreSyncBegin(ThreadState *thr, uptr pc) {
709 1.1 mrg DPrintf("#%d: ThreadIgnoreSyncBegin\n", thr->tid);
710 1.1 mrg thr->ignore_sync++;
711 1.1 mrg CHECK_GT(thr->ignore_sync, 0);
712 1.1 mrg #if !SANITIZER_GO
713 1.3 mrg if (pc && !ctx->after_multithreaded_fork)
714 1.1 mrg thr->sync_ignore_set.Add(CurrentStackId(thr, pc));
715 1.1 mrg #endif
716 1.1 mrg }
717 1.1 mrg
718 1.3 mrg void ThreadIgnoreSyncEnd(ThreadState *thr) {
719 1.1 mrg DPrintf("#%d: ThreadIgnoreSyncEnd\n", thr->tid);
720 1.1 mrg CHECK_GT(thr->ignore_sync, 0);
721 1.1 mrg thr->ignore_sync--;
722 1.1 mrg #if !SANITIZER_GO
723 1.1 mrg if (thr->ignore_sync == 0)
724 1.1 mrg thr->sync_ignore_set.Reset();
725 1.1 mrg #endif
726 1.1 mrg }
727 1.1 mrg
728 1.1 mrg bool MD5Hash::operator==(const MD5Hash &other) const {
729 1.1 mrg return hash[0] == other.hash[0] && hash[1] == other.hash[1];
730 1.1 mrg }
731 1.1 mrg
732 1.1 mrg #if SANITIZER_DEBUG
733 1.1 mrg void build_consistency_debug() {}
734 1.1 mrg #else
735 1.1 mrg void build_consistency_release() {}
736 1.1 mrg #endif
737 1.1 mrg
738 1.3 mrg } // namespace __tsan
739 1.1 mrg
740 1.3 mrg #if SANITIZER_CHECK_DEADLOCKS
741 1.3 mrg namespace __sanitizer {
742 1.3 mrg using namespace __tsan;
743 1.3 mrg MutexMeta mutex_meta[] = {
744 1.3 mrg {MutexInvalid, "Invalid", {}},
745 1.3 mrg {MutexThreadRegistry, "ThreadRegistry", {}},
746 1.3 mrg {MutexTypeTrace, "Trace", {MutexLeaf}},
747 1.3 mrg {MutexTypeReport, "Report", {MutexTypeSyncVar}},
748 1.3 mrg {MutexTypeSyncVar, "SyncVar", {}},
749 1.3 mrg {MutexTypeAnnotations, "Annotations", {}},
750 1.3 mrg {MutexTypeAtExit, "AtExit", {MutexTypeSyncVar}},
751 1.3 mrg {MutexTypeFired, "Fired", {MutexLeaf}},
752 1.3 mrg {MutexTypeRacy, "Racy", {MutexLeaf}},
753 1.3 mrg {MutexTypeGlobalProc, "GlobalProc", {}},
754 1.3 mrg {},
755 1.3 mrg };
756 1.1 mrg
757 1.3 mrg void PrintMutexPC(uptr pc) { StackTrace(&pc, 1).Print(); }
758 1.3 mrg } // namespace __sanitizer
759 1.1 mrg #endif
760