xref: /openbsd-src/gnu/llvm/lldb/source/Plugins/InstrumentationRuntime/UBSan/InstrumentationRuntimeUBSan.cpp (revision f6aab3d83b51b91c24247ad2c2573574de475a82)
1dda28197Spatrick //===-- InstrumentationRuntimeUBSan.cpp -----------------------------------===//
2dda28197Spatrick //
3dda28197Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4dda28197Spatrick // See https://llvm.org/LICENSE.txt for license information.
5dda28197Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6dda28197Spatrick //
7dda28197Spatrick //===----------------------------------------------------------------------===//
8dda28197Spatrick 
9dda28197Spatrick #include "InstrumentationRuntimeUBSan.h"
10dda28197Spatrick 
11dda28197Spatrick #include "Plugins/Process/Utility/HistoryThread.h"
12dda28197Spatrick #include "lldb/Breakpoint/StoppointCallbackContext.h"
13dda28197Spatrick #include "lldb/Core/Debugger.h"
14dda28197Spatrick #include "lldb/Core/Module.h"
15dda28197Spatrick #include "lldb/Core/PluginInterface.h"
16dda28197Spatrick #include "lldb/Core/PluginManager.h"
17dda28197Spatrick #include "lldb/Core/StreamFile.h"
18dda28197Spatrick #include "lldb/Core/ValueObject.h"
19dda28197Spatrick #include "lldb/Expression/UserExpression.h"
20dda28197Spatrick #include "lldb/Interpreter/CommandReturnObject.h"
21dda28197Spatrick #include "lldb/Symbol/Symbol.h"
22dda28197Spatrick #include "lldb/Symbol/SymbolContext.h"
23dda28197Spatrick #include "lldb/Symbol/Variable.h"
24dda28197Spatrick #include "lldb/Symbol/VariableList.h"
25dda28197Spatrick #include "lldb/Target/InstrumentationRuntimeStopInfo.h"
26dda28197Spatrick #include "lldb/Target/SectionLoadList.h"
27dda28197Spatrick #include "lldb/Target/StopInfo.h"
28dda28197Spatrick #include "lldb/Target/Target.h"
29dda28197Spatrick #include "lldb/Target/Thread.h"
30dda28197Spatrick #include "lldb/Utility/RegularExpression.h"
31dda28197Spatrick #include "lldb/Utility/Stream.h"
32be691f3bSpatrick #include <cctype>
33dda28197Spatrick 
34dda28197Spatrick #include <memory>
35dda28197Spatrick 
36dda28197Spatrick using namespace lldb;
37dda28197Spatrick using namespace lldb_private;
38dda28197Spatrick 
LLDB_PLUGIN_DEFINE(InstrumentationRuntimeUBSan)39dda28197Spatrick LLDB_PLUGIN_DEFINE(InstrumentationRuntimeUBSan)
40dda28197Spatrick 
41dda28197Spatrick InstrumentationRuntimeUBSan::~InstrumentationRuntimeUBSan() { Deactivate(); }
42dda28197Spatrick 
43dda28197Spatrick lldb::InstrumentationRuntimeSP
CreateInstance(const lldb::ProcessSP & process_sp)44dda28197Spatrick InstrumentationRuntimeUBSan::CreateInstance(const lldb::ProcessSP &process_sp) {
45dda28197Spatrick   return InstrumentationRuntimeSP(new InstrumentationRuntimeUBSan(process_sp));
46dda28197Spatrick }
47dda28197Spatrick 
Initialize()48dda28197Spatrick void InstrumentationRuntimeUBSan::Initialize() {
49dda28197Spatrick   PluginManager::RegisterPlugin(
50dda28197Spatrick       GetPluginNameStatic(),
51dda28197Spatrick       "UndefinedBehaviorSanitizer instrumentation runtime plugin.",
52dda28197Spatrick       CreateInstance, GetTypeStatic);
53dda28197Spatrick }
54dda28197Spatrick 
Terminate()55dda28197Spatrick void InstrumentationRuntimeUBSan::Terminate() {
56dda28197Spatrick   PluginManager::UnregisterPlugin(CreateInstance);
57dda28197Spatrick }
58dda28197Spatrick 
GetTypeStatic()59dda28197Spatrick lldb::InstrumentationRuntimeType InstrumentationRuntimeUBSan::GetTypeStatic() {
60dda28197Spatrick   return eInstrumentationRuntimeTypeUndefinedBehaviorSanitizer;
61dda28197Spatrick }
62dda28197Spatrick 
63dda28197Spatrick static const char *ub_sanitizer_retrieve_report_data_prefix = R"(
64dda28197Spatrick extern "C" {
65dda28197Spatrick void
66dda28197Spatrick __ubsan_get_current_report_data(const char **OutIssueKind,
67dda28197Spatrick     const char **OutMessage, const char **OutFilename, unsigned *OutLine,
68dda28197Spatrick     unsigned *OutCol, char **OutMemoryAddr);
69dda28197Spatrick }
70dda28197Spatrick 
71dda28197Spatrick struct data {
72dda28197Spatrick   const char *issue_kind;
73dda28197Spatrick   const char *message;
74dda28197Spatrick   const char *filename;
75dda28197Spatrick   unsigned line;
76dda28197Spatrick   unsigned col;
77dda28197Spatrick   char *memory_addr;
78dda28197Spatrick };
79dda28197Spatrick )";
80dda28197Spatrick 
81dda28197Spatrick static const char *ub_sanitizer_retrieve_report_data_command = R"(
82dda28197Spatrick data t;
83dda28197Spatrick __ubsan_get_current_report_data(&t.issue_kind, &t.message, &t.filename, &t.line,
84dda28197Spatrick                                 &t.col, &t.memory_addr);
85dda28197Spatrick t;
86dda28197Spatrick )";
87dda28197Spatrick 
RetrieveUnsigned(ValueObjectSP return_value_sp,ProcessSP process_sp,const std::string & expression_path)88dda28197Spatrick static addr_t RetrieveUnsigned(ValueObjectSP return_value_sp,
89dda28197Spatrick                                ProcessSP process_sp,
90dda28197Spatrick                                const std::string &expression_path) {
91dda28197Spatrick   return return_value_sp->GetValueForExpressionPath(expression_path.c_str())
92dda28197Spatrick       ->GetValueAsUnsigned(0);
93dda28197Spatrick }
94dda28197Spatrick 
RetrieveString(ValueObjectSP return_value_sp,ProcessSP process_sp,const std::string & expression_path)95dda28197Spatrick static std::string RetrieveString(ValueObjectSP return_value_sp,
96dda28197Spatrick                                   ProcessSP process_sp,
97dda28197Spatrick                                   const std::string &expression_path) {
98dda28197Spatrick   addr_t ptr = RetrieveUnsigned(return_value_sp, process_sp, expression_path);
99dda28197Spatrick   std::string str;
100dda28197Spatrick   Status error;
101dda28197Spatrick   process_sp->ReadCStringFromMemory(ptr, str, error);
102dda28197Spatrick   return str;
103dda28197Spatrick }
104dda28197Spatrick 
RetrieveReportData(ExecutionContextRef exe_ctx_ref)105dda28197Spatrick StructuredData::ObjectSP InstrumentationRuntimeUBSan::RetrieveReportData(
106dda28197Spatrick     ExecutionContextRef exe_ctx_ref) {
107dda28197Spatrick   ProcessSP process_sp = GetProcessSP();
108dda28197Spatrick   if (!process_sp)
109dda28197Spatrick     return StructuredData::ObjectSP();
110dda28197Spatrick 
111dda28197Spatrick   ThreadSP thread_sp = exe_ctx_ref.GetThreadSP();
112dda28197Spatrick   StackFrameSP frame_sp = thread_sp->GetSelectedFrame();
113dda28197Spatrick   ModuleSP runtime_module_sp = GetRuntimeModuleSP();
114dda28197Spatrick   Target &target = process_sp->GetTarget();
115dda28197Spatrick 
116dda28197Spatrick   if (!frame_sp)
117dda28197Spatrick     return StructuredData::ObjectSP();
118dda28197Spatrick 
119dda28197Spatrick   StreamFileSP Stream = target.GetDebugger().GetOutputStreamSP();
120dda28197Spatrick 
121dda28197Spatrick   EvaluateExpressionOptions options;
122dda28197Spatrick   options.SetUnwindOnError(true);
123dda28197Spatrick   options.SetTryAllThreads(true);
124dda28197Spatrick   options.SetStopOthers(true);
125dda28197Spatrick   options.SetIgnoreBreakpoints(true);
126dda28197Spatrick   options.SetTimeout(process_sp->GetUtilityExpressionTimeout());
127dda28197Spatrick   options.SetPrefix(ub_sanitizer_retrieve_report_data_prefix);
128dda28197Spatrick   options.SetAutoApplyFixIts(false);
129dda28197Spatrick   options.SetLanguage(eLanguageTypeObjC_plus_plus);
130dda28197Spatrick 
131dda28197Spatrick   ValueObjectSP main_value;
132dda28197Spatrick   ExecutionContext exe_ctx;
133dda28197Spatrick   Status eval_error;
134dda28197Spatrick   frame_sp->CalculateExecutionContext(exe_ctx);
135dda28197Spatrick   ExpressionResults result = UserExpression::Evaluate(
136dda28197Spatrick       exe_ctx, options, ub_sanitizer_retrieve_report_data_command, "",
137dda28197Spatrick       main_value, eval_error);
138dda28197Spatrick   if (result != eExpressionCompleted) {
139*f6aab3d8Srobert     StreamString ss;
140*f6aab3d8Srobert     ss << "cannot evaluate UndefinedBehaviorSanitizer expression:\n";
141*f6aab3d8Srobert     ss << eval_error.AsCString();
142*f6aab3d8Srobert     Debugger::ReportWarning(ss.GetString().str(),
143*f6aab3d8Srobert                             process_sp->GetTarget().GetDebugger().GetID());
144dda28197Spatrick     return StructuredData::ObjectSP();
145dda28197Spatrick   }
146dda28197Spatrick 
147dda28197Spatrick   // Gather the PCs of the user frames in the backtrace.
148dda28197Spatrick   StructuredData::Array *trace = new StructuredData::Array();
149dda28197Spatrick   auto trace_sp = StructuredData::ObjectSP(trace);
150dda28197Spatrick   for (unsigned I = 0; I < thread_sp->GetStackFrameCount(); ++I) {
151be691f3bSpatrick     const Address FCA = thread_sp->GetStackFrameAtIndex(I)
152be691f3bSpatrick                             ->GetFrameCodeAddressForSymbolication();
153dda28197Spatrick     if (FCA.GetModule() == runtime_module_sp) // Skip PCs from the runtime.
154dda28197Spatrick       continue;
155dda28197Spatrick 
156dda28197Spatrick     lldb::addr_t PC = FCA.GetLoadAddress(&target);
157dda28197Spatrick     trace->AddItem(StructuredData::ObjectSP(new StructuredData::Integer(PC)));
158dda28197Spatrick   }
159dda28197Spatrick 
160dda28197Spatrick   std::string IssueKind = RetrieveString(main_value, process_sp, ".issue_kind");
161dda28197Spatrick   std::string ErrMessage = RetrieveString(main_value, process_sp, ".message");
162dda28197Spatrick   std::string Filename = RetrieveString(main_value, process_sp, ".filename");
163dda28197Spatrick   unsigned Line = RetrieveUnsigned(main_value, process_sp, ".line");
164dda28197Spatrick   unsigned Col = RetrieveUnsigned(main_value, process_sp, ".col");
165dda28197Spatrick   uintptr_t MemoryAddr =
166dda28197Spatrick       RetrieveUnsigned(main_value, process_sp, ".memory_addr");
167dda28197Spatrick 
168dda28197Spatrick   auto *d = new StructuredData::Dictionary();
169dda28197Spatrick   auto dict_sp = StructuredData::ObjectSP(d);
170dda28197Spatrick   d->AddStringItem("instrumentation_class", "UndefinedBehaviorSanitizer");
171dda28197Spatrick   d->AddStringItem("description", IssueKind);
172dda28197Spatrick   d->AddStringItem("summary", ErrMessage);
173dda28197Spatrick   d->AddStringItem("filename", Filename);
174dda28197Spatrick   d->AddIntegerItem("line", Line);
175dda28197Spatrick   d->AddIntegerItem("col", Col);
176dda28197Spatrick   d->AddIntegerItem("memory_address", MemoryAddr);
177dda28197Spatrick   d->AddIntegerItem("tid", thread_sp->GetID());
178dda28197Spatrick   d->AddItem("trace", trace_sp);
179dda28197Spatrick   return dict_sp;
180dda28197Spatrick }
181dda28197Spatrick 
GetStopReasonDescription(StructuredData::ObjectSP report)182dda28197Spatrick static std::string GetStopReasonDescription(StructuredData::ObjectSP report) {
183dda28197Spatrick   llvm::StringRef stop_reason_description_ref;
184dda28197Spatrick   report->GetAsDictionary()->GetValueForKeyAsString(
185dda28197Spatrick       "description", stop_reason_description_ref);
186dda28197Spatrick   std::string stop_reason_description =
187dda28197Spatrick       std::string(stop_reason_description_ref);
188dda28197Spatrick 
189dda28197Spatrick   if (!stop_reason_description.size()) {
190dda28197Spatrick     stop_reason_description = "Undefined behavior detected";
191dda28197Spatrick   } else {
192dda28197Spatrick     stop_reason_description[0] = toupper(stop_reason_description[0]);
193dda28197Spatrick     for (unsigned I = 1; I < stop_reason_description.size(); ++I)
194dda28197Spatrick       if (stop_reason_description[I] == '-')
195dda28197Spatrick         stop_reason_description[I] = ' ';
196dda28197Spatrick   }
197dda28197Spatrick   return stop_reason_description;
198dda28197Spatrick }
199dda28197Spatrick 
NotifyBreakpointHit(void * baton,StoppointCallbackContext * context,user_id_t break_id,user_id_t break_loc_id)200dda28197Spatrick bool InstrumentationRuntimeUBSan::NotifyBreakpointHit(
201dda28197Spatrick     void *baton, StoppointCallbackContext *context, user_id_t break_id,
202dda28197Spatrick     user_id_t break_loc_id) {
203dda28197Spatrick   assert(baton && "null baton");
204dda28197Spatrick   if (!baton)
205dda28197Spatrick     return false; ///< false => resume execution.
206dda28197Spatrick 
207dda28197Spatrick   InstrumentationRuntimeUBSan *const instance =
208dda28197Spatrick       static_cast<InstrumentationRuntimeUBSan *>(baton);
209dda28197Spatrick 
210dda28197Spatrick   ProcessSP process_sp = instance->GetProcessSP();
211dda28197Spatrick   ThreadSP thread_sp = context->exe_ctx_ref.GetThreadSP();
212dda28197Spatrick   if (!process_sp || !thread_sp ||
213dda28197Spatrick       process_sp != context->exe_ctx_ref.GetProcessSP())
214dda28197Spatrick     return false;
215dda28197Spatrick 
216dda28197Spatrick   if (process_sp->GetModIDRef().IsLastResumeForUserExpression())
217dda28197Spatrick     return false;
218dda28197Spatrick 
219dda28197Spatrick   StructuredData::ObjectSP report =
220dda28197Spatrick       instance->RetrieveReportData(context->exe_ctx_ref);
221dda28197Spatrick 
222dda28197Spatrick   if (report) {
223dda28197Spatrick     thread_sp->SetStopInfo(
224dda28197Spatrick         InstrumentationRuntimeStopInfo::CreateStopReasonWithInstrumentationData(
225dda28197Spatrick             *thread_sp, GetStopReasonDescription(report), report));
226dda28197Spatrick     return true;
227dda28197Spatrick   }
228dda28197Spatrick 
229dda28197Spatrick   return false;
230dda28197Spatrick }
231dda28197Spatrick 
232dda28197Spatrick const RegularExpression &
GetPatternForRuntimeLibrary()233dda28197Spatrick InstrumentationRuntimeUBSan::GetPatternForRuntimeLibrary() {
234dda28197Spatrick   static RegularExpression regex(llvm::StringRef("libclang_rt\\.(a|t|ub)san_"));
235dda28197Spatrick   return regex;
236dda28197Spatrick }
237dda28197Spatrick 
CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp)238dda28197Spatrick bool InstrumentationRuntimeUBSan::CheckIfRuntimeIsValid(
239dda28197Spatrick     const lldb::ModuleSP module_sp) {
240dda28197Spatrick   static ConstString ubsan_test_sym("__ubsan_on_report");
241dda28197Spatrick   const Symbol *symbol = module_sp->FindFirstSymbolWithNameAndType(
242dda28197Spatrick       ubsan_test_sym, lldb::eSymbolTypeAny);
243dda28197Spatrick   return symbol != nullptr;
244dda28197Spatrick }
245dda28197Spatrick 
246dda28197Spatrick // FIXME: Factor out all the logic we have in common with the {a,t}san plugins.
Activate()247dda28197Spatrick void InstrumentationRuntimeUBSan::Activate() {
248dda28197Spatrick   if (IsActive())
249dda28197Spatrick     return;
250dda28197Spatrick 
251dda28197Spatrick   ProcessSP process_sp = GetProcessSP();
252dda28197Spatrick   if (!process_sp)
253dda28197Spatrick     return;
254dda28197Spatrick 
255dda28197Spatrick   ModuleSP runtime_module_sp = GetRuntimeModuleSP();
256dda28197Spatrick 
257dda28197Spatrick   ConstString symbol_name("__ubsan_on_report");
258dda28197Spatrick   const Symbol *symbol = runtime_module_sp->FindFirstSymbolWithNameAndType(
259dda28197Spatrick       symbol_name, eSymbolTypeCode);
260dda28197Spatrick 
261dda28197Spatrick   if (symbol == nullptr)
262dda28197Spatrick     return;
263dda28197Spatrick 
264dda28197Spatrick   if (!symbol->ValueIsAddress() || !symbol->GetAddressRef().IsValid())
265dda28197Spatrick     return;
266dda28197Spatrick 
267dda28197Spatrick   Target &target = process_sp->GetTarget();
268dda28197Spatrick   addr_t symbol_address = symbol->GetAddressRef().GetOpcodeLoadAddress(&target);
269dda28197Spatrick 
270dda28197Spatrick   if (symbol_address == LLDB_INVALID_ADDRESS)
271dda28197Spatrick     return;
272dda28197Spatrick 
273dda28197Spatrick   Breakpoint *breakpoint =
274dda28197Spatrick       process_sp->GetTarget()
275dda28197Spatrick           .CreateBreakpoint(symbol_address, /*internal=*/true,
276dda28197Spatrick                             /*hardware=*/false)
277dda28197Spatrick           .get();
278*f6aab3d8Srobert   const bool sync = false;
279dda28197Spatrick   breakpoint->SetCallback(InstrumentationRuntimeUBSan::NotifyBreakpointHit,
280*f6aab3d8Srobert                           this, sync);
281dda28197Spatrick   breakpoint->SetBreakpointKind("undefined-behavior-sanitizer-report");
282dda28197Spatrick   SetBreakpointID(breakpoint->GetID());
283dda28197Spatrick 
284dda28197Spatrick   SetActive(true);
285dda28197Spatrick }
286dda28197Spatrick 
Deactivate()287dda28197Spatrick void InstrumentationRuntimeUBSan::Deactivate() {
288dda28197Spatrick   SetActive(false);
289dda28197Spatrick 
290dda28197Spatrick   auto BID = GetBreakpointID();
291dda28197Spatrick   if (BID == LLDB_INVALID_BREAK_ID)
292dda28197Spatrick     return;
293dda28197Spatrick 
294dda28197Spatrick   if (ProcessSP process_sp = GetProcessSP()) {
295dda28197Spatrick     process_sp->GetTarget().RemoveBreakpointByID(BID);
296dda28197Spatrick     SetBreakpointID(LLDB_INVALID_BREAK_ID);
297dda28197Spatrick   }
298dda28197Spatrick }
299dda28197Spatrick 
300dda28197Spatrick lldb::ThreadCollectionSP
GetBacktracesFromExtendedStopInfo(StructuredData::ObjectSP info)301dda28197Spatrick InstrumentationRuntimeUBSan::GetBacktracesFromExtendedStopInfo(
302dda28197Spatrick     StructuredData::ObjectSP info) {
303dda28197Spatrick   ThreadCollectionSP threads;
304dda28197Spatrick   threads = std::make_shared<ThreadCollection>();
305dda28197Spatrick 
306dda28197Spatrick   ProcessSP process_sp = GetProcessSP();
307dda28197Spatrick 
308dda28197Spatrick   if (info->GetObjectForDotSeparatedPath("instrumentation_class")
309dda28197Spatrick           ->GetStringValue() != "UndefinedBehaviorSanitizer")
310dda28197Spatrick     return threads;
311dda28197Spatrick 
312dda28197Spatrick   std::vector<lldb::addr_t> PCs;
313dda28197Spatrick   auto trace = info->GetObjectForDotSeparatedPath("trace")->GetAsArray();
314dda28197Spatrick   trace->ForEach([&PCs](StructuredData::Object *PC) -> bool {
315dda28197Spatrick     PCs.push_back(PC->GetAsInteger()->GetValue());
316dda28197Spatrick     return true;
317dda28197Spatrick   });
318dda28197Spatrick 
319dda28197Spatrick   if (PCs.empty())
320dda28197Spatrick     return threads;
321dda28197Spatrick 
322dda28197Spatrick   StructuredData::ObjectSP thread_id_obj =
323dda28197Spatrick       info->GetObjectForDotSeparatedPath("tid");
324dda28197Spatrick   tid_t tid = thread_id_obj ? thread_id_obj->GetIntegerValue() : 0;
325dda28197Spatrick 
326be691f3bSpatrick   // We gather symbolication addresses above, so no need for HistoryThread to
327be691f3bSpatrick   // try to infer the call addresses.
328be691f3bSpatrick   bool pcs_are_call_addresses = true;
329be691f3bSpatrick   ThreadSP new_thread_sp = std::make_shared<HistoryThread>(
330be691f3bSpatrick       *process_sp, tid, PCs, pcs_are_call_addresses);
331dda28197Spatrick   std::string stop_reason_description = GetStopReasonDescription(info);
332dda28197Spatrick   new_thread_sp->SetName(stop_reason_description.c_str());
333dda28197Spatrick 
334dda28197Spatrick   // Save this in the Process' ExtendedThreadList so a strong pointer retains
335dda28197Spatrick   // the object
336dda28197Spatrick   process_sp->GetExtendedThreadList().AddThread(new_thread_sp);
337dda28197Spatrick   threads->AddThread(new_thread_sp);
338dda28197Spatrick 
339dda28197Spatrick   return threads;
340dda28197Spatrick }
341