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