LLDB mainline
InstrumentationRuntimeUBSan.cpp
Go to the documentation of this file.
1//===-- InstrumentationRuntimeUBSan.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
10
13#include "lldb/Core/Debugger.h"
14#include "lldb/Core/Module.h"
21#include "lldb/Symbol/Symbol.h"
28#include "lldb/Target/Target.h"
29#include "lldb/Target/Thread.h"
31#include "lldb/Utility/Stream.h"
32#include <cctype>
33
34#include <memory>
35
36using namespace lldb;
37using namespace lldb_private;
38
40
42
46}
47
51 "UndefinedBehaviorSanitizer instrumentation runtime plugin.",
53}
54
57}
58
61}
62
64extern "C" {
65void
66__ubsan_get_current_report_data(const char **OutIssueKind,
67 const char **OutMessage, const char **OutFilename, unsigned *OutLine,
68 unsigned *OutCol, char **OutMemoryAddr);
69}
70)";
71
73struct {
74 const char *issue_kind;
75 const char *message;
76 const char *filename;
77 unsigned line;
78 unsigned col;
79 char *memory_addr;
80} t;
81
82__ubsan_get_current_report_data(&t.issue_kind, &t.message, &t.filename, &t.line,
83 &t.col, &t.memory_addr);
84t;
85)";
86
87static addr_t RetrieveUnsigned(ValueObjectSP return_value_sp,
88 ProcessSP process_sp,
89 const std::string &expression_path) {
90 return return_value_sp->GetValueForExpressionPath(expression_path.c_str())
91 ->GetValueAsUnsigned(0);
92}
93
94static std::string RetrieveString(ValueObjectSP return_value_sp,
95 ProcessSP process_sp,
96 const std::string &expression_path) {
97 addr_t ptr = RetrieveUnsigned(return_value_sp, process_sp, expression_path);
98 std::string str;
100 process_sp->ReadCStringFromMemory(ptr, str, error);
101 return str;
102}
103
105 ExecutionContextRef exe_ctx_ref) {
106 ProcessSP process_sp = GetProcessSP();
107 if (!process_sp)
109
110 ThreadSP thread_sp = exe_ctx_ref.GetThreadSP();
111 StackFrameSP frame_sp =
112 thread_sp->GetSelectedFrame(DoNoSelectMostRelevantFrame);
113 ModuleSP runtime_module_sp = GetRuntimeModuleSP();
114 Target &target = process_sp->GetTarget();
115
116 if (!frame_sp)
118
120
122 options.SetUnwindOnError(true);
123 options.SetTryAllThreads(true);
124 options.SetStopOthers(true);
125 options.SetIgnoreBreakpoints(true);
126 options.SetTimeout(process_sp->GetUtilityExpressionTimeout());
128 options.SetAutoApplyFixIts(false);
130
131 ValueObjectSP main_value;
132 ExecutionContext exe_ctx;
133 Status eval_error;
134 frame_sp->CalculateExecutionContext(exe_ctx);
136 exe_ctx, options, ub_sanitizer_retrieve_report_data_command, "",
137 main_value, eval_error);
138 if (result != eExpressionCompleted) {
139 StreamString ss;
140 ss << "cannot evaluate UndefinedBehaviorSanitizer expression:\n";
141 ss << eval_error.AsCString();
143 process_sp->GetTarget().GetDebugger().GetID());
145 }
146
147 // Gather the PCs of the user frames in the backtrace.
149 auto trace_sp = StructuredData::ObjectSP(trace);
150 for (unsigned I = 0; I < thread_sp->GetStackFrameCount(); ++I) {
151 const Address FCA = thread_sp->GetStackFrameAtIndex(I)
152 ->GetFrameCodeAddressForSymbolication();
153 if (FCA.GetModule() == runtime_module_sp) // Skip PCs from the runtime.
154 continue;
155
156 lldb::addr_t PC = FCA.GetLoadAddress(&target);
157 trace->AddIntegerItem(PC);
158 }
159
160 std::string IssueKind = RetrieveString(main_value, process_sp, ".issue_kind");
161 std::string ErrMessage = RetrieveString(main_value, process_sp, ".message");
162 std::string Filename = RetrieveString(main_value, process_sp, ".filename");
163 unsigned Line = RetrieveUnsigned(main_value, process_sp, ".line");
164 unsigned Col = RetrieveUnsigned(main_value, process_sp, ".col");
165 uintptr_t MemoryAddr =
166 RetrieveUnsigned(main_value, process_sp, ".memory_addr");
167
168 auto *d = new StructuredData::Dictionary();
169 auto dict_sp = StructuredData::ObjectSP(d);
170 d->AddStringItem("instrumentation_class", "UndefinedBehaviorSanitizer");
171 d->AddStringItem("description", IssueKind);
172 d->AddStringItem("summary", ErrMessage);
173 d->AddStringItem("filename", Filename);
174 d->AddIntegerItem("line", Line);
175 d->AddIntegerItem("col", Col);
176 d->AddIntegerItem("memory_address", MemoryAddr);
177 d->AddIntegerItem("tid", thread_sp->GetID());
178 d->AddItem("trace", trace_sp);
179 return dict_sp;
180}
181
183 llvm::StringRef stop_reason_description_ref;
184 report->GetAsDictionary()->GetValueForKeyAsString(
185 "description", stop_reason_description_ref);
186 std::string stop_reason_description =
187 std::string(stop_reason_description_ref);
188
189 if (!stop_reason_description.size()) {
190 stop_reason_description = "Undefined behavior detected";
191 } else {
192 stop_reason_description[0] = toupper(stop_reason_description[0]);
193 for (unsigned I = 1; I < stop_reason_description.size(); ++I)
194 if (stop_reason_description[I] == '-')
195 stop_reason_description[I] = ' ';
196 }
197 return stop_reason_description;
198}
199
201 void *baton, StoppointCallbackContext *context, user_id_t break_id,
202 user_id_t break_loc_id) {
203 assert(baton && "null baton");
204 if (!baton)
205 return false; ///< false => resume execution.
206
207 InstrumentationRuntimeUBSan *const instance =
208 static_cast<InstrumentationRuntimeUBSan *>(baton);
209
210 ProcessSP process_sp = instance->GetProcessSP();
211 ThreadSP thread_sp = context->exe_ctx_ref.GetThreadSP();
212 if (!process_sp || !thread_sp ||
213 process_sp != context->exe_ctx_ref.GetProcessSP())
214 return false;
215
216 if (process_sp->GetModIDRef().IsLastResumeForUserExpression())
217 return false;
218
220 instance->RetrieveReportData(context->exe_ctx_ref);
221
222 if (report) {
223 thread_sp->SetStopInfo(
225 *thread_sp, GetStopReasonDescription(report), report));
226 return true;
227 }
228
229 return false;
230}
231
232const RegularExpression &
234 static RegularExpression regex(llvm::StringRef("libclang_rt\\.(a|t|ub)san_"));
235 return regex;
236}
237
239 const lldb::ModuleSP module_sp) {
240 static ConstString ubsan_test_sym("__ubsan_on_report");
241 const Symbol *symbol = module_sp->FindFirstSymbolWithNameAndType(
242 ubsan_test_sym, lldb::eSymbolTypeAny);
243 return symbol != nullptr;
244}
245
246// FIXME: Factor out all the logic we have in common with the {a,t}san plugins.
248 if (IsActive())
249 return;
250
251 ProcessSP process_sp = GetProcessSP();
252 if (!process_sp)
253 return;
254
255 ModuleSP runtime_module_sp = GetRuntimeModuleSP();
256
257 ConstString symbol_name("__ubsan_on_report");
258 const Symbol *symbol = runtime_module_sp->FindFirstSymbolWithNameAndType(
259 symbol_name, eSymbolTypeCode);
260
261 if (symbol == nullptr)
262 return;
263
264 if (!symbol->ValueIsAddress() || !symbol->GetAddressRef().IsValid())
265 return;
266
267 Target &target = process_sp->GetTarget();
268 addr_t symbol_address = symbol->GetAddressRef().GetOpcodeLoadAddress(&target);
269
270 if (symbol_address == LLDB_INVALID_ADDRESS)
271 return;
272
273 Breakpoint *breakpoint =
274 process_sp->GetTarget()
275 .CreateBreakpoint(symbol_address, /*internal=*/true,
276 /*hardware=*/false)
277 .get();
278 const bool sync = false;
280 this, sync);
281 breakpoint->SetBreakpointKind("undefined-behavior-sanitizer-report");
282 SetBreakpointID(breakpoint->GetID());
283
284 SetActive(true);
285}
286
288 SetActive(false);
289
290 auto BID = GetBreakpointID();
291 if (BID == LLDB_INVALID_BREAK_ID)
292 return;
293
294 if (ProcessSP process_sp = GetProcessSP()) {
295 process_sp->GetTarget().RemoveBreakpointByID(BID);
297 }
298}
299
303 ThreadCollectionSP threads;
304 threads = std::make_shared<ThreadCollection>();
305
306 ProcessSP process_sp = GetProcessSP();
307
308 if (info->GetObjectForDotSeparatedPath("instrumentation_class")
309 ->GetStringValue() != "UndefinedBehaviorSanitizer")
310 return threads;
311
312 std::vector<lldb::addr_t> PCs;
313 auto trace = info->GetObjectForDotSeparatedPath("trace")->GetAsArray();
314 trace->ForEach([&PCs](StructuredData::Object *PC) -> bool {
315 PCs.push_back(PC->GetUnsignedIntegerValue());
316 return true;
317 });
318
319 if (PCs.empty())
320 return threads;
321
322 StructuredData::ObjectSP thread_id_obj =
323 info->GetObjectForDotSeparatedPath("tid");
324 tid_t tid = thread_id_obj ? thread_id_obj->GetUnsignedIntegerValue() : 0;
325
326 // We gather symbolication addresses above, so no need for HistoryThread to
327 // try to infer the call addresses.
328 bool pcs_are_call_addresses = true;
329 ThreadSP new_thread_sp = std::make_shared<HistoryThread>(
330 *process_sp, tid, PCs, pcs_are_call_addresses);
331 std::string stop_reason_description = GetStopReasonDescription(info);
332 new_thread_sp->SetName(stop_reason_description.c_str());
333
334 // Save this in the Process' ExtendedThreadList so a strong pointer retains
335 // the object
336 process_sp->GetExtendedThreadList().AddThread(new_thread_sp);
337 threads->AddThread(new_thread_sp);
338
339 return threads;
340}
static llvm::raw_ostream & error(Stream &strm)
static std::string RetrieveString(ValueObjectSP return_value_sp, ProcessSP process_sp, const std::string &expression_path)
static addr_t RetrieveUnsigned(ValueObjectSP return_value_sp, ProcessSP process_sp, const std::string &expression_path)
static const char * ub_sanitizer_retrieve_report_data_command
static std::string GetStopReasonDescription(StructuredData::ObjectSP report)
static const char * ub_sanitizer_retrieve_report_data_prefix
#define LLDB_PLUGIN_DEFINE(PluginName)
Definition: PluginManager.h:31
A section + offset based address class.
Definition: Address.h:62
lldb::addr_t GetLoadAddress(Target *target) const
Get the load address.
Definition: Address.cpp:313
lldb::addr_t GetOpcodeLoadAddress(Target *target, AddressClass addr_class=AddressClass::eInvalid) const
Get the load address as an opcode load address.
Definition: Address.cpp:370
lldb::ModuleSP GetModule() const
Get accessor for the module for this address.
Definition: Address.cpp:285
bool IsValid() const
Check if the object state is valid.
Definition: Address.h:355
General Outline: A breakpoint has four main parts, a filter, a resolver, the list of breakpoint locat...
Definition: Breakpoint.h:81
void SetBreakpointKind(const char *kind)
Set the "kind" description for a breakpoint.
Definition: Breakpoint.h:452
Target & GetTarget()
Accessor for the breakpoint Target.
Definition: Breakpoint.h:463
void SetCallback(BreakpointHitCallback callback, void *baton, bool is_synchronous=false)
Set the callback action invoked when the breakpoint is hit.
Definition: Breakpoint.cpp:408
A uniqued constant string class.
Definition: ConstString.h:40
static void ReportWarning(std::string message, std::optional< lldb::user_id_t > debugger_id=std::nullopt, std::once_flag *once=nullptr)
Report warning events.
Definition: Debugger.cpp:1552
lldb::StreamFileSP GetOutputStreamSP()
Definition: Debugger.h:144
void SetLanguage(lldb::LanguageType language)
Definition: Target.h:315
void SetUnwindOnError(bool unwind=false)
Definition: Target.h:334
void SetPrefix(const char *prefix)
Definition: Target.h:323
void SetTryAllThreads(bool try_others=true)
Definition: Target.h:367
void SetTimeout(const Timeout< std::micro > &timeout)
Definition: Target.h:355
void SetStopOthers(bool stop_others=true)
Definition: Target.h:371
void SetIgnoreBreakpoints(bool ignore=false)
Definition: Target.h:338
Execution context objects refer to objects in the execution of the program that is being debugged.
lldb::ThreadSP GetThreadSP() const
Get accessor that creates a strong reference from the weak thread reference contained in this object.
lldb::ProcessSP GetProcessSP() const
Get accessor that creates a strong reference from the weak process reference contained in this object...
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
static lldb::StopInfoSP CreateStopReasonWithInstrumentationData(Thread &thread, std::string description, StructuredData::ObjectSP additional_data)
void Activate() override
Register a breakpoint in the runtime library and perform any other necessary initialization.
static lldb::InstrumentationRuntimeType GetTypeStatic()
static bool NotifyBreakpointHit(void *baton, StoppointCallbackContext *context, lldb::user_id_t break_id, lldb::user_id_t break_loc_id)
bool CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp) override
Check whether module_sp corresponds to a valid runtime library.
StructuredData::ObjectSP RetrieveReportData(ExecutionContextRef exe_ctx_ref)
lldb::ThreadCollectionSP GetBacktracesFromExtendedStopInfo(StructuredData::ObjectSP info) override
const RegularExpression & GetPatternForRuntimeLibrary() override
Return a regular expression which can be used to identify a valid version of the runtime library.
static lldb::InstrumentationRuntimeSP CreateInstance(const lldb::ProcessSP &process_sp)
static bool RegisterPlugin(llvm::StringRef name, llvm::StringRef description, ABICreateInstance create_callback)
static bool UnregisterPlugin(ABICreateInstance create_callback)
An error handling class.
Definition: Status.h:44
const char * AsCString(const char *default_error_str="unknown error") const
Get the error string associated with the current error.
Definition: Status.cpp:130
General Outline: When we hit a breakpoint we need to package up whatever information is needed to eva...
lldb::break_id_t GetID() const
Definition: Stoppoint.cpp:22
llvm::StringRef GetString() const
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
uint64_t GetUnsignedIntegerValue(uint64_t fail_value=0)
std::shared_ptr< Object > ObjectSP
bool ValueIsAddress() const
Definition: Symbol.cpp:169
Address & GetAddressRef()
Definition: Symbol.h:72
Debugger & GetDebugger()
Definition: Target.h:1055
lldb::BreakpointSP CreateBreakpoint(const FileSpecList *containingModules, const FileSpec &file, uint32_t line_no, uint32_t column, lldb::addr_t offset, LazyBool check_inlines, LazyBool skip_prologue, bool internal, bool request_hardware, LazyBool move_to_nearest_code)
Definition: Target.cpp:395
static lldb::ExpressionResults Evaluate(ExecutionContext &exe_ctx, const EvaluateExpressionOptions &options, llvm::StringRef expr_cstr, llvm::StringRef expr_prefix, lldb::ValueObjectSP &result_valobj_sp, Status &error, std::string *fixed_expression=nullptr, ValueObject *ctx_obj=nullptr)
Evaluate one expression in the scratch context of the target passed in the exe_ctx and return its res...
#define LLDB_INVALID_BREAK_ID
Definition: lldb-defines.h:37
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:82
@ DoNoSelectMostRelevantFrame
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
Definition: SBAddress.h:15
std::shared_ptr< lldb_private::StackFrame > StackFrameSP
Definition: lldb-forward.h:412
std::shared_ptr< lldb_private::Thread > ThreadSP
Definition: lldb-forward.h:438
std::shared_ptr< lldb_private::ValueObject > ValueObjectSP
Definition: lldb-forward.h:472
@ eLanguageTypeObjC_plus_plus
Objective-C++.
ExpressionResults
The results of expression evaluation.
@ eExpressionCompleted
std::shared_ptr< lldb_private::Process > ProcessSP
Definition: lldb-forward.h:381
InstrumentationRuntimeType
@ eInstrumentationRuntimeTypeUndefinedBehaviorSanitizer
std::shared_ptr< lldb_private::StreamFile > StreamFileSP
Definition: lldb-forward.h:421
uint64_t user_id_t
Definition: lldb-types.h:80
uint64_t addr_t
Definition: lldb-types.h:79
std::shared_ptr< lldb_private::InstrumentationRuntime > InstrumentationRuntimeSP
Definition: lldb-forward.h:352
uint64_t tid_t
Definition: lldb-types.h:82
std::shared_ptr< lldb_private::Module > ModuleSP
Definition: lldb-forward.h:365
std::shared_ptr< lldb_private::ThreadCollection > ThreadCollectionSP
Definition: lldb-forward.h:440