1 //===-- InstrumentationRuntimeTSan.cpp ------------------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "InstrumentationRuntimeTSan.h" 10 11 #include "Plugins/Process/Utility/HistoryThread.h" 12 #include "lldb/Breakpoint/StoppointCallbackContext.h" 13 #include "lldb/Core/Debugger.h" 14 #include "lldb/Core/Module.h" 15 #include "lldb/Core/PluginInterface.h" 16 #include "lldb/Core/PluginManager.h" 17 #include "lldb/Core/StreamFile.h" 18 #include "lldb/Core/ValueObject.h" 19 #include "lldb/Expression/UserExpression.h" 20 #include "lldb/Interpreter/CommandReturnObject.h" 21 #include "lldb/Symbol/Symbol.h" 22 #include "lldb/Symbol/SymbolContext.h" 23 #include "lldb/Symbol/Variable.h" 24 #include "lldb/Symbol/VariableList.h" 25 #include "lldb/Target/InstrumentationRuntimeStopInfo.h" 26 #include "lldb/Target/SectionLoadList.h" 27 #include "lldb/Target/StopInfo.h" 28 #include "lldb/Target/Target.h" 29 #include "lldb/Target/Thread.h" 30 #include "lldb/Utility/RegularExpression.h" 31 #include "lldb/Utility/Stream.h" 32 33 #include <memory> 34 35 using namespace lldb; 36 using namespace lldb_private; 37 38 LLDB_PLUGIN_DEFINE(InstrumentationRuntimeTSan) 39 40 lldb::InstrumentationRuntimeSP 41 InstrumentationRuntimeTSan::CreateInstance(const lldb::ProcessSP &process_sp) { 42 return InstrumentationRuntimeSP(new InstrumentationRuntimeTSan(process_sp)); 43 } 44 45 void InstrumentationRuntimeTSan::Initialize() { 46 PluginManager::RegisterPlugin( 47 GetPluginNameStatic(), "ThreadSanitizer instrumentation runtime plugin.", 48 CreateInstance, GetTypeStatic); 49 } 50 51 void InstrumentationRuntimeTSan::Terminate() { 52 PluginManager::UnregisterPlugin(CreateInstance); 53 } 54 55 lldb::InstrumentationRuntimeType InstrumentationRuntimeTSan::GetTypeStatic() { 56 return eInstrumentationRuntimeTypeThreadSanitizer; 57 } 58 59 InstrumentationRuntimeTSan::~InstrumentationRuntimeTSan() { Deactivate(); } 60 61 const char *thread_sanitizer_retrieve_report_data_prefix = R"( 62 extern "C" 63 { 64 void *__tsan_get_current_report(); 65 int __tsan_get_report_data(void *report, const char **description, int *count, 66 int *stack_count, int *mop_count, int *loc_count, 67 int *mutex_count, int *thread_count, 68 int *unique_tid_count, void **sleep_trace, 69 unsigned long trace_size); 70 int __tsan_get_report_stack(void *report, unsigned long idx, void **trace, 71 unsigned long trace_size); 72 int __tsan_get_report_mop(void *report, unsigned long idx, int *tid, void **addr, 73 int *size, int *write, int *atomic, void **trace, 74 unsigned long trace_size); 75 int __tsan_get_report_loc(void *report, unsigned long idx, const char **type, 76 void **addr, unsigned long *start, unsigned long *size, int *tid, 77 int *fd, int *suppressable, void **trace, 78 unsigned long trace_size); 79 int __tsan_get_report_mutex(void *report, unsigned long idx, unsigned long *mutex_id, void **addr, 80 int *destroyed, void **trace, unsigned long trace_size); 81 int __tsan_get_report_thread(void *report, unsigned long idx, int *tid, unsigned long *os_id, 82 int *running, const char **name, int *parent_tid, 83 void **trace, unsigned long trace_size); 84 int __tsan_get_report_unique_tid(void *report, unsigned long idx, int *tid); 85 86 // TODO: dlsym won't work on Windows. 87 void *dlsym(void* handle, const char* symbol); 88 int (*ptr__tsan_get_report_loc_object_type)(void *report, unsigned long idx, const char **object_type); 89 } 90 )"; 91 92 const char *thread_sanitizer_retrieve_report_data_command = R"( 93 94 const int REPORT_TRACE_SIZE = 128; 95 const int REPORT_ARRAY_SIZE = 4; 96 97 struct { 98 void *report; 99 const char *description; 100 int report_count; 101 102 void *sleep_trace[REPORT_TRACE_SIZE]; 103 104 int stack_count; 105 struct { 106 int idx; 107 void *trace[REPORT_TRACE_SIZE]; 108 } stacks[REPORT_ARRAY_SIZE]; 109 110 int mop_count; 111 struct { 112 int idx; 113 int tid; 114 int size; 115 int write; 116 int atomic; 117 void *addr; 118 void *trace[REPORT_TRACE_SIZE]; 119 } mops[REPORT_ARRAY_SIZE]; 120 121 int loc_count; 122 struct { 123 int idx; 124 const char *type; 125 void *addr; 126 unsigned long start; 127 unsigned long size; 128 int tid; 129 int fd; 130 int suppressable; 131 void *trace[REPORT_TRACE_SIZE]; 132 const char *object_type; 133 } locs[REPORT_ARRAY_SIZE]; 134 135 int mutex_count; 136 struct { 137 int idx; 138 unsigned long mutex_id; 139 void *addr; 140 int destroyed; 141 void *trace[REPORT_TRACE_SIZE]; 142 } mutexes[REPORT_ARRAY_SIZE]; 143 144 int thread_count; 145 struct { 146 int idx; 147 int tid; 148 unsigned long os_id; 149 int running; 150 const char *name; 151 int parent_tid; 152 void *trace[REPORT_TRACE_SIZE]; 153 } threads[REPORT_ARRAY_SIZE]; 154 155 int unique_tid_count; 156 struct { 157 int idx; 158 int tid; 159 } unique_tids[REPORT_ARRAY_SIZE]; 160 } t = {0}; 161 162 ptr__tsan_get_report_loc_object_type = (typeof(ptr__tsan_get_report_loc_object_type))(void *)dlsym((void*)-2 /*RTLD_DEFAULT*/, "__tsan_get_report_loc_object_type"); 163 164 t.report = __tsan_get_current_report(); 165 __tsan_get_report_data(t.report, &t.description, &t.report_count, &t.stack_count, &t.mop_count, &t.loc_count, &t.mutex_count, &t.thread_count, &t.unique_tid_count, t.sleep_trace, REPORT_TRACE_SIZE); 166 167 if (t.stack_count > REPORT_ARRAY_SIZE) t.stack_count = REPORT_ARRAY_SIZE; 168 for (int i = 0; i < t.stack_count; i++) { 169 t.stacks[i].idx = i; 170 __tsan_get_report_stack(t.report, i, t.stacks[i].trace, REPORT_TRACE_SIZE); 171 } 172 173 if (t.mop_count > REPORT_ARRAY_SIZE) t.mop_count = REPORT_ARRAY_SIZE; 174 for (int i = 0; i < t.mop_count; i++) { 175 t.mops[i].idx = i; 176 __tsan_get_report_mop(t.report, i, &t.mops[i].tid, &t.mops[i].addr, &t.mops[i].size, &t.mops[i].write, &t.mops[i].atomic, t.mops[i].trace, REPORT_TRACE_SIZE); 177 } 178 179 if (t.loc_count > REPORT_ARRAY_SIZE) t.loc_count = REPORT_ARRAY_SIZE; 180 for (int i = 0; i < t.loc_count; i++) { 181 t.locs[i].idx = i; 182 __tsan_get_report_loc(t.report, i, &t.locs[i].type, &t.locs[i].addr, &t.locs[i].start, &t.locs[i].size, &t.locs[i].tid, &t.locs[i].fd, &t.locs[i].suppressable, t.locs[i].trace, REPORT_TRACE_SIZE); 183 if (ptr__tsan_get_report_loc_object_type) 184 ptr__tsan_get_report_loc_object_type(t.report, i, &t.locs[i].object_type); 185 } 186 187 if (t.mutex_count > REPORT_ARRAY_SIZE) t.mutex_count = REPORT_ARRAY_SIZE; 188 for (int i = 0; i < t.mutex_count; i++) { 189 t.mutexes[i].idx = i; 190 __tsan_get_report_mutex(t.report, i, &t.mutexes[i].mutex_id, &t.mutexes[i].addr, &t.mutexes[i].destroyed, t.mutexes[i].trace, REPORT_TRACE_SIZE); 191 } 192 193 if (t.thread_count > REPORT_ARRAY_SIZE) t.thread_count = REPORT_ARRAY_SIZE; 194 for (int i = 0; i < t.thread_count; i++) { 195 t.threads[i].idx = i; 196 __tsan_get_report_thread(t.report, i, &t.threads[i].tid, &t.threads[i].os_id, &t.threads[i].running, &t.threads[i].name, &t.threads[i].parent_tid, t.threads[i].trace, REPORT_TRACE_SIZE); 197 } 198 199 if (t.unique_tid_count > REPORT_ARRAY_SIZE) t.unique_tid_count = REPORT_ARRAY_SIZE; 200 for (int i = 0; i < t.unique_tid_count; i++) { 201 t.unique_tids[i].idx = i; 202 __tsan_get_report_unique_tid(t.report, i, &t.unique_tids[i].tid); 203 } 204 205 t; 206 )"; 207 208 static StructuredData::ArraySP 209 CreateStackTrace(ValueObjectSP o, 210 const std::string &trace_item_name = ".trace") { 211 auto trace_sp = std::make_shared<StructuredData::Array>(); 212 ValueObjectSP trace_value_object = 213 o->GetValueForExpressionPath(trace_item_name.c_str()); 214 size_t count = trace_value_object->GetNumChildren(); 215 for (size_t j = 0; j < count; j++) { 216 addr_t trace_addr = 217 trace_value_object->GetChildAtIndex(j)->GetValueAsUnsigned(0); 218 if (trace_addr == 0) 219 break; 220 trace_sp->AddIntegerItem(trace_addr); 221 } 222 return trace_sp; 223 } 224 225 static StructuredData::ArraySP ConvertToStructuredArray( 226 ValueObjectSP return_value_sp, const std::string &items_name, 227 const std::string &count_name, 228 std::function<void(const ValueObjectSP &o, 229 const StructuredData::DictionarySP &dict)> const 230 &callback) { 231 auto array_sp = std::make_shared<StructuredData::Array>(); 232 unsigned int count = 233 return_value_sp->GetValueForExpressionPath(count_name.c_str()) 234 ->GetValueAsUnsigned(0); 235 ValueObjectSP objects = 236 return_value_sp->GetValueForExpressionPath(items_name.c_str()); 237 for (unsigned int i = 0; i < count; i++) { 238 ValueObjectSP o = objects->GetChildAtIndex(i); 239 auto dict_sp = std::make_shared<StructuredData::Dictionary>(); 240 241 callback(o, dict_sp); 242 243 array_sp->AddItem(dict_sp); 244 } 245 return array_sp; 246 } 247 248 static std::string RetrieveString(ValueObjectSP return_value_sp, 249 ProcessSP process_sp, 250 const std::string &expression_path) { 251 addr_t ptr = 252 return_value_sp->GetValueForExpressionPath(expression_path.c_str()) 253 ->GetValueAsUnsigned(0); 254 std::string str; 255 Status error; 256 process_sp->ReadCStringFromMemory(ptr, str, error); 257 return str; 258 } 259 260 static void 261 GetRenumberedThreadIds(ProcessSP process_sp, ValueObjectSP data, 262 std::map<uint64_t, user_id_t> &thread_id_map) { 263 ConvertToStructuredArray( 264 data, ".threads", ".thread_count", 265 [process_sp, &thread_id_map](const ValueObjectSP &o, 266 const StructuredData::DictionarySP &dict) { 267 uint64_t thread_id = 268 o->GetValueForExpressionPath(".tid")->GetValueAsUnsigned(0); 269 uint64_t thread_os_id = 270 o->GetValueForExpressionPath(".os_id")->GetValueAsUnsigned(0); 271 user_id_t lldb_user_id = 0; 272 273 bool can_update = true; 274 ThreadSP lldb_thread = process_sp->GetThreadList().FindThreadByID( 275 thread_os_id, can_update); 276 if (lldb_thread) { 277 lldb_user_id = lldb_thread->GetIndexID(); 278 } else { 279 // This isn't a live thread anymore. Ask process to assign a new 280 // Index ID (or return an old one if we've already seen this 281 // thread_os_id). It will also make sure that no new threads are 282 // assigned this Index ID. 283 lldb_user_id = process_sp->AssignIndexIDToThread(thread_os_id); 284 } 285 286 thread_id_map[thread_id] = lldb_user_id; 287 }); 288 } 289 290 static user_id_t Renumber(uint64_t id, 291 std::map<uint64_t, user_id_t> &thread_id_map) { 292 auto IT = thread_id_map.find(id); 293 if (IT == thread_id_map.end()) 294 return 0; 295 296 return IT->second; 297 } 298 299 StructuredData::ObjectSP InstrumentationRuntimeTSan::RetrieveReportData( 300 ExecutionContextRef exe_ctx_ref) { 301 ProcessSP process_sp = GetProcessSP(); 302 if (!process_sp) 303 return StructuredData::ObjectSP(); 304 305 ThreadSP thread_sp = exe_ctx_ref.GetThreadSP(); 306 StackFrameSP frame_sp = 307 thread_sp->GetSelectedFrame(DoNoSelectMostRelevantFrame); 308 309 if (!frame_sp) 310 return StructuredData::ObjectSP(); 311 312 EvaluateExpressionOptions options; 313 options.SetUnwindOnError(true); 314 options.SetTryAllThreads(true); 315 options.SetStopOthers(true); 316 options.SetIgnoreBreakpoints(true); 317 options.SetTimeout(process_sp->GetUtilityExpressionTimeout()); 318 options.SetPrefix(thread_sanitizer_retrieve_report_data_prefix); 319 options.SetAutoApplyFixIts(false); 320 options.SetLanguage(eLanguageTypeObjC_plus_plus); 321 322 ValueObjectSP main_value; 323 ExecutionContext exe_ctx; 324 Status eval_error; 325 frame_sp->CalculateExecutionContext(exe_ctx); 326 ExpressionResults result = UserExpression::Evaluate( 327 exe_ctx, options, thread_sanitizer_retrieve_report_data_command, "", 328 main_value, eval_error); 329 if (result != eExpressionCompleted) { 330 StreamString ss; 331 ss << "cannot evaluate ThreadSanitizer expression:\n"; 332 ss << eval_error.AsCString(); 333 Debugger::ReportWarning(ss.GetString().str(), 334 process_sp->GetTarget().GetDebugger().GetID()); 335 return StructuredData::ObjectSP(); 336 } 337 338 std::map<uint64_t, user_id_t> thread_id_map; 339 GetRenumberedThreadIds(process_sp, main_value, thread_id_map); 340 341 auto dict = std::make_shared<StructuredData::Dictionary>(); 342 dict->AddStringItem("instrumentation_class", "ThreadSanitizer"); 343 dict->AddStringItem("issue_type", 344 RetrieveString(main_value, process_sp, ".description")); 345 dict->AddIntegerItem("report_count", 346 main_value->GetValueForExpressionPath(".report_count") 347 ->GetValueAsUnsigned(0)); 348 dict->AddItem("sleep_trace", CreateStackTrace( 349 main_value, ".sleep_trace")); 350 351 StructuredData::ArraySP stacks = ConvertToStructuredArray( 352 main_value, ".stacks", ".stack_count", 353 [thread_sp](const ValueObjectSP &o, 354 const StructuredData::DictionarySP &dict) { 355 dict->AddIntegerItem( 356 "index", 357 o->GetValueForExpressionPath(".idx")->GetValueAsUnsigned(0)); 358 dict->AddItem("trace", CreateStackTrace(o)); 359 // "stacks" happen on the current thread 360 dict->AddIntegerItem("thread_id", thread_sp->GetIndexID()); 361 }); 362 dict->AddItem("stacks", stacks); 363 364 StructuredData::ArraySP mops = ConvertToStructuredArray( 365 main_value, ".mops", ".mop_count", 366 [&thread_id_map](const ValueObjectSP &o, 367 const StructuredData::DictionarySP &dict) { 368 dict->AddIntegerItem( 369 "index", 370 o->GetValueForExpressionPath(".idx")->GetValueAsUnsigned(0)); 371 dict->AddIntegerItem( 372 "thread_id", 373 Renumber( 374 o->GetValueForExpressionPath(".tid")->GetValueAsUnsigned(0), 375 thread_id_map)); 376 dict->AddIntegerItem( 377 "size", 378 o->GetValueForExpressionPath(".size")->GetValueAsUnsigned(0)); 379 dict->AddBooleanItem( 380 "is_write", 381 o->GetValueForExpressionPath(".write")->GetValueAsUnsigned(0)); 382 dict->AddBooleanItem( 383 "is_atomic", 384 o->GetValueForExpressionPath(".atomic")->GetValueAsUnsigned(0)); 385 dict->AddIntegerItem( 386 "address", 387 o->GetValueForExpressionPath(".addr")->GetValueAsUnsigned(0)); 388 dict->AddItem("trace", CreateStackTrace(o)); 389 }); 390 dict->AddItem("mops", mops); 391 392 StructuredData::ArraySP locs = ConvertToStructuredArray( 393 main_value, ".locs", ".loc_count", 394 [process_sp, &thread_id_map](const ValueObjectSP &o, 395 const StructuredData::DictionarySP &dict) { 396 dict->AddIntegerItem( 397 "index", 398 o->GetValueForExpressionPath(".idx")->GetValueAsUnsigned(0)); 399 dict->AddStringItem("type", RetrieveString(o, process_sp, ".type")); 400 dict->AddIntegerItem( 401 "address", 402 o->GetValueForExpressionPath(".addr")->GetValueAsUnsigned(0)); 403 dict->AddIntegerItem( 404 "start", 405 o->GetValueForExpressionPath(".start")->GetValueAsUnsigned(0)); 406 dict->AddIntegerItem( 407 "size", 408 o->GetValueForExpressionPath(".size")->GetValueAsUnsigned(0)); 409 dict->AddIntegerItem( 410 "thread_id", 411 Renumber( 412 o->GetValueForExpressionPath(".tid")->GetValueAsUnsigned(0), 413 thread_id_map)); 414 dict->AddIntegerItem( 415 "file_descriptor", 416 o->GetValueForExpressionPath(".fd")->GetValueAsUnsigned(0)); 417 dict->AddIntegerItem("suppressable", 418 o->GetValueForExpressionPath(".suppressable") 419 ->GetValueAsUnsigned(0)); 420 dict->AddItem("trace", CreateStackTrace(o)); 421 dict->AddStringItem("object_type", 422 RetrieveString(o, process_sp, ".object_type")); 423 }); 424 dict->AddItem("locs", locs); 425 426 StructuredData::ArraySP mutexes = ConvertToStructuredArray( 427 main_value, ".mutexes", ".mutex_count", 428 [](const ValueObjectSP &o, const StructuredData::DictionarySP &dict) { 429 dict->AddIntegerItem( 430 "index", 431 o->GetValueForExpressionPath(".idx")->GetValueAsUnsigned(0)); 432 dict->AddIntegerItem( 433 "mutex_id", 434 o->GetValueForExpressionPath(".mutex_id")->GetValueAsUnsigned(0)); 435 dict->AddIntegerItem( 436 "address", 437 o->GetValueForExpressionPath(".addr")->GetValueAsUnsigned(0)); 438 dict->AddIntegerItem( 439 "destroyed", 440 o->GetValueForExpressionPath(".destroyed")->GetValueAsUnsigned(0)); 441 dict->AddItem("trace", CreateStackTrace(o)); 442 }); 443 dict->AddItem("mutexes", mutexes); 444 445 StructuredData::ArraySP threads = ConvertToStructuredArray( 446 main_value, ".threads", ".thread_count", 447 [process_sp, &thread_id_map](const ValueObjectSP &o, 448 const StructuredData::DictionarySP &dict) { 449 dict->AddIntegerItem( 450 "index", 451 o->GetValueForExpressionPath(".idx")->GetValueAsUnsigned(0)); 452 dict->AddIntegerItem( 453 "thread_id", 454 Renumber( 455 o->GetValueForExpressionPath(".tid")->GetValueAsUnsigned(0), 456 thread_id_map)); 457 dict->AddIntegerItem( 458 "thread_os_id", 459 o->GetValueForExpressionPath(".os_id")->GetValueAsUnsigned(0)); 460 dict->AddIntegerItem( 461 "running", 462 o->GetValueForExpressionPath(".running")->GetValueAsUnsigned(0)); 463 dict->AddStringItem("name", RetrieveString(o, process_sp, ".name")); 464 dict->AddIntegerItem( 465 "parent_thread_id", 466 Renumber(o->GetValueForExpressionPath(".parent_tid") 467 ->GetValueAsUnsigned(0), 468 thread_id_map)); 469 dict->AddItem("trace", CreateStackTrace(o)); 470 }); 471 dict->AddItem("threads", threads); 472 473 StructuredData::ArraySP unique_tids = ConvertToStructuredArray( 474 main_value, ".unique_tids", ".unique_tid_count", 475 [&thread_id_map](const ValueObjectSP &o, 476 const StructuredData::DictionarySP &dict) { 477 dict->AddIntegerItem( 478 "index", 479 o->GetValueForExpressionPath(".idx")->GetValueAsUnsigned(0)); 480 dict->AddIntegerItem( 481 "tid", 482 Renumber( 483 o->GetValueForExpressionPath(".tid")->GetValueAsUnsigned(0), 484 thread_id_map)); 485 }); 486 dict->AddItem("unique_tids", unique_tids); 487 488 return dict; 489 } 490 491 std::string 492 InstrumentationRuntimeTSan::FormatDescription(StructuredData::ObjectSP report) { 493 std::string description = std::string(report->GetAsDictionary() 494 ->GetValueForKey("issue_type") 495 ->GetAsString() 496 ->GetValue()); 497 498 if (description == "data-race") { 499 return "Data race"; 500 } else if (description == "data-race-vptr") { 501 return "Data race on C++ virtual pointer"; 502 } else if (description == "heap-use-after-free") { 503 return "Use of deallocated memory"; 504 } else if (description == "heap-use-after-free-vptr") { 505 return "Use of deallocated C++ virtual pointer"; 506 } else if (description == "thread-leak") { 507 return "Thread leak"; 508 } else if (description == "locked-mutex-destroy") { 509 return "Destruction of a locked mutex"; 510 } else if (description == "mutex-double-lock") { 511 return "Double lock of a mutex"; 512 } else if (description == "mutex-invalid-access") { 513 return "Use of an uninitialized or destroyed mutex"; 514 } else if (description == "mutex-bad-unlock") { 515 return "Unlock of an unlocked mutex (or by a wrong thread)"; 516 } else if (description == "mutex-bad-read-lock") { 517 return "Read lock of a write locked mutex"; 518 } else if (description == "mutex-bad-read-unlock") { 519 return "Read unlock of a write locked mutex"; 520 } else if (description == "signal-unsafe-call") { 521 return "Signal-unsafe call inside a signal handler"; 522 } else if (description == "errno-in-signal-handler") { 523 return "Overwrite of errno in a signal handler"; 524 } else if (description == "lock-order-inversion") { 525 return "Lock order inversion (potential deadlock)"; 526 } else if (description == "external-race") { 527 return "Race on a library object"; 528 } else if (description == "swift-access-race") { 529 return "Swift access race"; 530 } 531 532 // for unknown report codes just show the code 533 return description; 534 } 535 536 static std::string Sprintf(const char *format, ...) { 537 StreamString s; 538 va_list args; 539 va_start(args, format); 540 s.PrintfVarArg(format, args); 541 va_end(args); 542 return std::string(s.GetString()); 543 } 544 545 static std::string GetSymbolNameFromAddress(ProcessSP process_sp, addr_t addr) { 546 lldb_private::Address so_addr; 547 if (!process_sp->GetTarget().GetSectionLoadList().ResolveLoadAddress(addr, 548 so_addr)) 549 return ""; 550 551 lldb_private::Symbol *symbol = so_addr.CalculateSymbolContextSymbol(); 552 if (!symbol) 553 return ""; 554 555 std::string sym_name = symbol->GetName().GetCString(); 556 return sym_name; 557 } 558 559 static void GetSymbolDeclarationFromAddress(ProcessSP process_sp, addr_t addr, 560 Declaration &decl) { 561 lldb_private::Address so_addr; 562 if (!process_sp->GetTarget().GetSectionLoadList().ResolveLoadAddress(addr, 563 so_addr)) 564 return; 565 566 lldb_private::Symbol *symbol = so_addr.CalculateSymbolContextSymbol(); 567 if (!symbol) 568 return; 569 570 ConstString sym_name = symbol->GetMangled().GetName(Mangled::ePreferMangled); 571 572 ModuleSP module = symbol->CalculateSymbolContextModule(); 573 if (!module) 574 return; 575 576 VariableList var_list; 577 module->FindGlobalVariables(sym_name, CompilerDeclContext(), 1U, var_list); 578 if (var_list.GetSize() < 1) 579 return; 580 581 VariableSP var = var_list.GetVariableAtIndex(0); 582 decl = var->GetDeclaration(); 583 } 584 585 addr_t InstrumentationRuntimeTSan::GetFirstNonInternalFramePc( 586 StructuredData::ObjectSP trace, bool skip_one_frame) { 587 ProcessSP process_sp = GetProcessSP(); 588 ModuleSP runtime_module_sp = GetRuntimeModuleSP(); 589 590 StructuredData::Array *trace_array = trace->GetAsArray(); 591 for (size_t i = 0; i < trace_array->GetSize(); i++) { 592 if (skip_one_frame && i == 0) 593 continue; 594 595 addr_t addr; 596 if (!trace_array->GetItemAtIndexAsInteger(i, addr)) 597 continue; 598 599 lldb_private::Address so_addr; 600 if (!process_sp->GetTarget().GetSectionLoadList().ResolveLoadAddress( 601 addr, so_addr)) 602 continue; 603 604 if (so_addr.GetModule() == runtime_module_sp) 605 continue; 606 607 return addr; 608 } 609 610 return 0; 611 } 612 613 std::string 614 InstrumentationRuntimeTSan::GenerateSummary(StructuredData::ObjectSP report) { 615 ProcessSP process_sp = GetProcessSP(); 616 617 std::string summary = std::string(report->GetAsDictionary() 618 ->GetValueForKey("description") 619 ->GetAsString() 620 ->GetValue()); 621 bool skip_one_frame = 622 report->GetObjectForDotSeparatedPath("issue_type")->GetStringValue() == 623 "external-race"; 624 625 addr_t pc = 0; 626 if (report->GetAsDictionary() 627 ->GetValueForKey("mops") 628 ->GetAsArray() 629 ->GetSize() > 0) 630 pc = GetFirstNonInternalFramePc(report->GetAsDictionary() 631 ->GetValueForKey("mops") 632 ->GetAsArray() 633 ->GetItemAtIndex(0) 634 ->GetAsDictionary() 635 ->GetValueForKey("trace"), 636 skip_one_frame); 637 638 if (report->GetAsDictionary() 639 ->GetValueForKey("stacks") 640 ->GetAsArray() 641 ->GetSize() > 0) 642 pc = GetFirstNonInternalFramePc(report->GetAsDictionary() 643 ->GetValueForKey("stacks") 644 ->GetAsArray() 645 ->GetItemAtIndex(0) 646 ->GetAsDictionary() 647 ->GetValueForKey("trace"), 648 skip_one_frame); 649 650 if (pc != 0) { 651 summary = summary + " in " + GetSymbolNameFromAddress(process_sp, pc); 652 } 653 654 if (report->GetAsDictionary() 655 ->GetValueForKey("locs") 656 ->GetAsArray() 657 ->GetSize() > 0) { 658 StructuredData::ObjectSP loc = report->GetAsDictionary() 659 ->GetValueForKey("locs") 660 ->GetAsArray() 661 ->GetItemAtIndex(0); 662 std::string object_type = std::string(loc->GetAsDictionary() 663 ->GetValueForKey("object_type") 664 ->GetAsString() 665 ->GetValue()); 666 if (!object_type.empty()) { 667 summary = "Race on " + object_type + " object"; 668 } 669 addr_t addr = loc->GetAsDictionary() 670 ->GetValueForKey("address") 671 ->GetUnsignedIntegerValue(); 672 if (addr == 0) 673 addr = loc->GetAsDictionary() 674 ->GetValueForKey("start") 675 ->GetUnsignedIntegerValue(); 676 677 if (addr != 0) { 678 std::string global_name = GetSymbolNameFromAddress(process_sp, addr); 679 if (!global_name.empty()) { 680 summary = summary + " at " + global_name; 681 } else { 682 summary = summary + " at " + Sprintf("0x%llx", addr); 683 } 684 } else { 685 int fd = loc->GetAsDictionary() 686 ->GetValueForKey("file_descriptor") 687 ->GetSignedIntegerValue(); 688 if (fd != 0) { 689 summary = summary + " on file descriptor " + Sprintf("%d", fd); 690 } 691 } 692 } 693 694 return summary; 695 } 696 697 addr_t InstrumentationRuntimeTSan::GetMainRacyAddress( 698 StructuredData::ObjectSP report) { 699 addr_t result = (addr_t)-1; 700 701 report->GetObjectForDotSeparatedPath("mops")->GetAsArray()->ForEach( 702 [&result](StructuredData::Object *o) -> bool { 703 addr_t addr = o->GetObjectForDotSeparatedPath("address") 704 ->GetUnsignedIntegerValue(); 705 if (addr < result) 706 result = addr; 707 return true; 708 }); 709 710 return (result == (addr_t)-1) ? 0 : result; 711 } 712 713 std::string InstrumentationRuntimeTSan::GetLocationDescription( 714 StructuredData::ObjectSP report, addr_t &global_addr, 715 std::string &global_name, std::string &filename, uint32_t &line) { 716 std::string result; 717 718 ProcessSP process_sp = GetProcessSP(); 719 720 if (report->GetAsDictionary() 721 ->GetValueForKey("locs") 722 ->GetAsArray() 723 ->GetSize() > 0) { 724 StructuredData::ObjectSP loc = report->GetAsDictionary() 725 ->GetValueForKey("locs") 726 ->GetAsArray() 727 ->GetItemAtIndex(0); 728 std::string type = std::string( 729 loc->GetAsDictionary()->GetValueForKey("type")->GetStringValue()); 730 if (type == "global") { 731 global_addr = loc->GetAsDictionary() 732 ->GetValueForKey("address") 733 ->GetUnsignedIntegerValue(); 734 735 global_name = GetSymbolNameFromAddress(process_sp, global_addr); 736 if (!global_name.empty()) { 737 result = Sprintf("'%s' is a global variable (0x%llx)", 738 global_name.c_str(), global_addr); 739 } else { 740 result = Sprintf("0x%llx is a global variable", global_addr); 741 } 742 743 Declaration decl; 744 GetSymbolDeclarationFromAddress(process_sp, global_addr, decl); 745 if (decl.GetFile()) { 746 filename = decl.GetFile().GetPath(); 747 line = decl.GetLine(); 748 } 749 } else if (type == "heap") { 750 addr_t addr = loc->GetAsDictionary() 751 ->GetValueForKey("start") 752 ->GetUnsignedIntegerValue(); 753 754 size_t size = loc->GetAsDictionary() 755 ->GetValueForKey("size") 756 ->GetUnsignedIntegerValue(); 757 758 std::string object_type = std::string(loc->GetAsDictionary() 759 ->GetValueForKey("object_type") 760 ->GetAsString() 761 ->GetValue()); 762 if (!object_type.empty()) { 763 result = Sprintf("Location is a %ld-byte %s object at 0x%llx", size, 764 object_type.c_str(), addr); 765 } else { 766 result = 767 Sprintf("Location is a %ld-byte heap object at 0x%llx", size, addr); 768 } 769 } else if (type == "stack") { 770 tid_t tid = loc->GetAsDictionary() 771 ->GetValueForKey("thread_id") 772 ->GetUnsignedIntegerValue(); 773 774 result = Sprintf("Location is stack of thread %d", tid); 775 } else if (type == "tls") { 776 tid_t tid = loc->GetAsDictionary() 777 ->GetValueForKey("thread_id") 778 ->GetUnsignedIntegerValue(); 779 780 result = Sprintf("Location is TLS of thread %d", tid); 781 } else if (type == "fd") { 782 int fd = loc->GetAsDictionary() 783 ->GetValueForKey("file_descriptor") 784 ->GetSignedIntegerValue(); 785 786 result = Sprintf("Location is file descriptor %d", fd); 787 } 788 } 789 790 return result; 791 } 792 793 bool InstrumentationRuntimeTSan::NotifyBreakpointHit( 794 void *baton, StoppointCallbackContext *context, user_id_t break_id, 795 user_id_t break_loc_id) { 796 assert(baton && "null baton"); 797 if (!baton) 798 return false; 799 800 InstrumentationRuntimeTSan *const instance = 801 static_cast<InstrumentationRuntimeTSan *>(baton); 802 803 ProcessSP process_sp = instance->GetProcessSP(); 804 805 if (process_sp->GetModIDRef().IsLastResumeForUserExpression()) 806 return false; 807 808 StructuredData::ObjectSP report = 809 instance->RetrieveReportData(context->exe_ctx_ref); 810 std::string stop_reason_description = 811 "unknown thread sanitizer fault (unable to extract thread sanitizer " 812 "report)"; 813 if (report) { 814 std::string issue_description = instance->FormatDescription(report); 815 report->GetAsDictionary()->AddStringItem("description", issue_description); 816 stop_reason_description = issue_description + " detected"; 817 report->GetAsDictionary()->AddStringItem("stop_description", 818 stop_reason_description); 819 std::string summary = instance->GenerateSummary(report); 820 report->GetAsDictionary()->AddStringItem("summary", summary); 821 addr_t main_address = instance->GetMainRacyAddress(report); 822 report->GetAsDictionary()->AddIntegerItem("memory_address", main_address); 823 824 addr_t global_addr = 0; 825 std::string global_name; 826 std::string location_filename; 827 uint32_t location_line = 0; 828 std::string location_description = instance->GetLocationDescription( 829 report, global_addr, global_name, location_filename, location_line); 830 report->GetAsDictionary()->AddStringItem("location_description", 831 location_description); 832 if (global_addr != 0) { 833 report->GetAsDictionary()->AddIntegerItem("global_address", global_addr); 834 } 835 if (!global_name.empty()) { 836 report->GetAsDictionary()->AddStringItem("global_name", global_name); 837 } 838 if (location_filename != "") { 839 report->GetAsDictionary()->AddStringItem("location_filename", 840 location_filename); 841 report->GetAsDictionary()->AddIntegerItem("location_line", location_line); 842 } 843 844 bool all_addresses_are_same = true; 845 report->GetObjectForDotSeparatedPath("mops")->GetAsArray()->ForEach( 846 [&all_addresses_are_same, 847 main_address](StructuredData::Object *o) -> bool { 848 addr_t addr = o->GetObjectForDotSeparatedPath("address") 849 ->GetUnsignedIntegerValue(); 850 if (main_address != addr) 851 all_addresses_are_same = false; 852 return true; 853 }); 854 report->GetAsDictionary()->AddBooleanItem("all_addresses_are_same", 855 all_addresses_are_same); 856 } 857 858 // Make sure this is the right process 859 if (process_sp && process_sp == context->exe_ctx_ref.GetProcessSP()) { 860 ThreadSP thread_sp = context->exe_ctx_ref.GetThreadSP(); 861 if (thread_sp) 862 thread_sp->SetStopInfo( 863 InstrumentationRuntimeStopInfo:: 864 CreateStopReasonWithInstrumentationData( 865 *thread_sp, stop_reason_description, report)); 866 867 StreamFile &s = process_sp->GetTarget().GetDebugger().GetOutputStream(); 868 s.Printf("ThreadSanitizer report breakpoint hit. Use 'thread " 869 "info -s' to get extended information about the " 870 "report.\n"); 871 872 return true; // Return true to stop the target 873 } else 874 return false; // Let target run 875 } 876 877 const RegularExpression & 878 InstrumentationRuntimeTSan::GetPatternForRuntimeLibrary() { 879 static RegularExpression regex(llvm::StringRef("libclang_rt.tsan_")); 880 return regex; 881 } 882 883 bool InstrumentationRuntimeTSan::CheckIfRuntimeIsValid( 884 const lldb::ModuleSP module_sp) { 885 static ConstString g_tsan_get_current_report("__tsan_get_current_report"); 886 const Symbol *symbol = module_sp->FindFirstSymbolWithNameAndType( 887 g_tsan_get_current_report, lldb::eSymbolTypeAny); 888 return symbol != nullptr; 889 } 890 891 void InstrumentationRuntimeTSan::Activate() { 892 if (IsActive()) 893 return; 894 895 ProcessSP process_sp = GetProcessSP(); 896 if (!process_sp) 897 return; 898 899 ConstString symbol_name("__tsan_on_report"); 900 const Symbol *symbol = GetRuntimeModuleSP()->FindFirstSymbolWithNameAndType( 901 symbol_name, eSymbolTypeCode); 902 903 if (symbol == nullptr) 904 return; 905 906 if (!symbol->ValueIsAddress() || !symbol->GetAddressRef().IsValid()) 907 return; 908 909 Target &target = process_sp->GetTarget(); 910 addr_t symbol_address = symbol->GetAddressRef().GetOpcodeLoadAddress(&target); 911 912 if (symbol_address == LLDB_INVALID_ADDRESS) 913 return; 914 915 const bool internal = true; 916 const bool hardware = false; 917 const bool sync = false; 918 Breakpoint *breakpoint = 919 process_sp->GetTarget() 920 .CreateBreakpoint(symbol_address, internal, hardware) 921 .get(); 922 breakpoint->SetCallback(InstrumentationRuntimeTSan::NotifyBreakpointHit, this, 923 sync); 924 breakpoint->SetBreakpointKind("thread-sanitizer-report"); 925 SetBreakpointID(breakpoint->GetID()); 926 927 SetActive(true); 928 } 929 930 void InstrumentationRuntimeTSan::Deactivate() { 931 if (GetBreakpointID() != LLDB_INVALID_BREAK_ID) { 932 ProcessSP process_sp = GetProcessSP(); 933 if (process_sp) { 934 process_sp->GetTarget().RemoveBreakpointByID(GetBreakpointID()); 935 SetBreakpointID(LLDB_INVALID_BREAK_ID); 936 } 937 } 938 SetActive(false); 939 } 940 static std::string GenerateThreadName(const std::string &path, 941 StructuredData::Object *o, 942 StructuredData::ObjectSP main_info) { 943 std::string result = "additional information"; 944 945 if (path == "mops") { 946 size_t size = 947 o->GetObjectForDotSeparatedPath("size")->GetUnsignedIntegerValue(); 948 tid_t thread_id = 949 o->GetObjectForDotSeparatedPath("thread_id")->GetUnsignedIntegerValue(); 950 bool is_write = 951 o->GetObjectForDotSeparatedPath("is_write")->GetBooleanValue(); 952 bool is_atomic = 953 o->GetObjectForDotSeparatedPath("is_atomic")->GetBooleanValue(); 954 addr_t addr = 955 o->GetObjectForDotSeparatedPath("address")->GetUnsignedIntegerValue(); 956 957 std::string addr_string = Sprintf(" at 0x%llx", addr); 958 959 if (main_info->GetObjectForDotSeparatedPath("all_addresses_are_same") 960 ->GetBooleanValue()) { 961 addr_string = ""; 962 } 963 964 if (main_info->GetObjectForDotSeparatedPath("issue_type") 965 ->GetStringValue() == "external-race") { 966 result = Sprintf("%s access by thread %d", 967 is_write ? "mutating" : "read-only", thread_id); 968 } else if (main_info->GetObjectForDotSeparatedPath("issue_type") 969 ->GetStringValue() == "swift-access-race") { 970 result = Sprintf("modifying access by thread %d", thread_id); 971 } else { 972 result = Sprintf("%s%s of size %zu%s by thread %" PRIu64, 973 is_atomic ? "atomic " : "", is_write ? "write" : "read", 974 size, addr_string.c_str(), thread_id); 975 } 976 } 977 978 if (path == "threads") { 979 tid_t thread_id = 980 o->GetObjectForDotSeparatedPath("thread_id")->GetUnsignedIntegerValue(); 981 result = Sprintf("Thread %zu created", thread_id); 982 } 983 984 if (path == "locs") { 985 std::string type = std::string( 986 o->GetAsDictionary()->GetValueForKey("type")->GetStringValue()); 987 tid_t thread_id = 988 o->GetObjectForDotSeparatedPath("thread_id")->GetUnsignedIntegerValue(); 989 int fd = o->GetObjectForDotSeparatedPath("file_descriptor") 990 ->GetSignedIntegerValue(); 991 if (type == "heap") { 992 result = Sprintf("Heap block allocated by thread %" PRIu64, thread_id); 993 } else if (type == "fd") { 994 result = Sprintf("File descriptor %d created by thread %" PRIu64, fd, 995 thread_id); 996 } 997 } 998 999 if (path == "mutexes") { 1000 int mutex_id = 1001 o->GetObjectForDotSeparatedPath("mutex_id")->GetSignedIntegerValue(); 1002 1003 result = Sprintf("Mutex M%d created", mutex_id); 1004 } 1005 1006 if (path == "stacks") { 1007 tid_t thread_id = 1008 o->GetObjectForDotSeparatedPath("thread_id")->GetUnsignedIntegerValue(); 1009 result = Sprintf("Thread %" PRIu64, thread_id); 1010 } 1011 1012 result[0] = toupper(result[0]); 1013 1014 return result; 1015 } 1016 1017 static void AddThreadsForPath(const std::string &path, 1018 ThreadCollectionSP threads, ProcessSP process_sp, 1019 StructuredData::ObjectSP info) { 1020 info->GetObjectForDotSeparatedPath(path)->GetAsArray()->ForEach( 1021 [process_sp, threads, path, info](StructuredData::Object *o) -> bool { 1022 std::vector<lldb::addr_t> pcs; 1023 o->GetObjectForDotSeparatedPath("trace")->GetAsArray()->ForEach( 1024 [&pcs](StructuredData::Object *pc) -> bool { 1025 pcs.push_back(pc->GetUnsignedIntegerValue()); 1026 return true; 1027 }); 1028 1029 if (pcs.size() == 0) 1030 return true; 1031 1032 StructuredData::ObjectSP thread_id_obj = 1033 o->GetObjectForDotSeparatedPath("thread_os_id"); 1034 tid_t tid = 1035 thread_id_obj ? thread_id_obj->GetUnsignedIntegerValue() : 0; 1036 1037 ThreadSP new_thread_sp = 1038 std::make_shared<HistoryThread>(*process_sp, tid, pcs); 1039 new_thread_sp->SetName(GenerateThreadName(path, o, info).c_str()); 1040 1041 // Save this in the Process' ExtendedThreadList so a strong pointer 1042 // retains the object 1043 process_sp->GetExtendedThreadList().AddThread(new_thread_sp); 1044 threads->AddThread(new_thread_sp); 1045 1046 return true; 1047 }); 1048 } 1049 1050 lldb::ThreadCollectionSP 1051 InstrumentationRuntimeTSan::GetBacktracesFromExtendedStopInfo( 1052 StructuredData::ObjectSP info) { 1053 1054 ThreadCollectionSP threads = std::make_shared<ThreadCollection>(); 1055 1056 if (info->GetObjectForDotSeparatedPath("instrumentation_class") 1057 ->GetStringValue() != "ThreadSanitizer") 1058 return threads; 1059 1060 ProcessSP process_sp = GetProcessSP(); 1061 1062 AddThreadsForPath("stacks", threads, process_sp, info); 1063 AddThreadsForPath("mops", threads, process_sp, info); 1064 AddThreadsForPath("locs", threads, process_sp, info); 1065 AddThreadsForPath("mutexes", threads, process_sp, info); 1066 AddThreadsForPath("threads", threads, process_sp, info); 1067 1068 return threads; 1069 } 1070