257 lines · cpp
1//===-- ReportRetriever.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-exception6//7//===----------------------------------------------------------------------===//8 9#include "ReportRetriever.h"10#include "Utility.h"11 12#include "lldb/Breakpoint/StoppointCallbackContext.h"13#include "lldb/Core/Debugger.h"14#include "lldb/Core/Module.h"15#include "lldb/Expression/UserExpression.h"16#include "lldb/Target/InstrumentationRuntimeStopInfo.h"17#include "lldb/ValueObject/ValueObject.h"18 19using namespace lldb;20using namespace lldb_private;21 22const char *address_sanitizer_retrieve_report_data_prefix = R"(23extern "C"24{25int __asan_report_present();26void *__asan_get_report_pc();27void *__asan_get_report_bp();28void *__asan_get_report_sp();29void *__asan_get_report_address();30const char *__asan_get_report_description();31int __asan_get_report_access_type();32size_t __asan_get_report_access_size();33}34)";35 36const char *address_sanitizer_retrieve_report_data_command = R"(37struct {38 int present;39 int access_type;40 void *pc;41 void *bp;42 void *sp;43 void *address;44 size_t access_size;45 const char *description;46} t;47 48t.present = __asan_report_present();49t.access_type = __asan_get_report_access_type();50t.pc = __asan_get_report_pc();51t.bp = __asan_get_report_bp();52t.sp = __asan_get_report_sp();53t.address = __asan_get_report_address();54t.access_size = __asan_get_report_access_size();55t.description = __asan_get_report_description();56t57)";58 59StructuredData::ObjectSP60ReportRetriever::RetrieveReportData(const ProcessSP process_sp) {61 if (!process_sp)62 return StructuredData::ObjectSP();63 64 ThreadSP thread_sp =65 process_sp->GetThreadList().GetExpressionExecutionThread();66 67 if (!thread_sp)68 return StructuredData::ObjectSP();69 70 StackFrameSP frame_sp =71 thread_sp->GetSelectedFrame(DoNoSelectMostRelevantFrame);72 73 if (!frame_sp)74 return StructuredData::ObjectSP();75 76 EvaluateExpressionOptions options;77 options.SetUnwindOnError(true);78 options.SetTryAllThreads(true);79 options.SetStopOthers(true);80 options.SetIgnoreBreakpoints(true);81 options.SetTimeout(process_sp->GetUtilityExpressionTimeout());82 options.SetPrefix(address_sanitizer_retrieve_report_data_prefix);83 options.SetAutoApplyFixIts(false);84 options.SetLanguage(eLanguageTypeObjC_plus_plus);85 86 if (auto [m, _] = GetPreferredAsanModule(process_sp->GetTarget()); m) {87 SymbolContextList sc_list;88 sc_list.Append(SymbolContext(std::move(m)));89 options.SetPreferredSymbolContexts(std::move(sc_list));90 }91 92 ValueObjectSP return_value_sp;93 ExecutionContext exe_ctx;94 frame_sp->CalculateExecutionContext(exe_ctx);95 ExpressionResults result = UserExpression::Evaluate(96 exe_ctx, options, address_sanitizer_retrieve_report_data_command, "",97 return_value_sp);98 if (result != eExpressionCompleted) {99 StreamString ss;100 ss << "cannot evaluate AddressSanitizer expression:\n";101 if (return_value_sp)102 ss << return_value_sp->GetError().AsCString();103 Debugger::ReportWarning(ss.GetString().str(),104 process_sp->GetTarget().GetDebugger().GetID());105 return StructuredData::ObjectSP();106 }107 108 int present = return_value_sp->GetValueForExpressionPath(".present")109 ->GetValueAsUnsigned(0);110 if (present != 1)111 return StructuredData::ObjectSP();112 113 addr_t pc =114 return_value_sp->GetValueForExpressionPath(".pc")->GetValueAsUnsigned(0);115 addr_t bp =116 return_value_sp->GetValueForExpressionPath(".bp")->GetValueAsUnsigned(0);117 addr_t sp =118 return_value_sp->GetValueForExpressionPath(".sp")->GetValueAsUnsigned(0);119 addr_t address = return_value_sp->GetValueForExpressionPath(".address")120 ->GetValueAsUnsigned(0);121 addr_t access_type =122 return_value_sp->GetValueForExpressionPath(".access_type")123 ->GetValueAsUnsigned(0);124 addr_t access_size =125 return_value_sp->GetValueForExpressionPath(".access_size")126 ->GetValueAsUnsigned(0);127 addr_t description_ptr =128 return_value_sp->GetValueForExpressionPath(".description")129 ->GetValueAsUnsigned(0);130 std::string description;131 Status error;132 process_sp->ReadCStringFromMemory(description_ptr, description, error);133 134 auto dict = std::make_shared<StructuredData::Dictionary>();135 if (!dict)136 return StructuredData::ObjectSP();137 138 dict->AddStringItem("instrumentation_class", "AddressSanitizer");139 dict->AddStringItem("stop_type", "fatal_error");140 dict->AddIntegerItem("pc", pc);141 dict->AddIntegerItem("bp", bp);142 dict->AddIntegerItem("sp", sp);143 dict->AddIntegerItem("address", address);144 dict->AddIntegerItem("access_type", access_type);145 dict->AddIntegerItem("access_size", access_size);146 dict->AddStringItem("description", description);147 148 return StructuredData::ObjectSP(dict);149}150 151std::string152ReportRetriever::FormatDescription(StructuredData::ObjectSP report) {153 std::string description = std::string(report->GetAsDictionary()154 ->GetValueForKey("description")155 ->GetAsString()156 ->GetValue());157 return llvm::StringSwitch<std::string>(description)158 .Case("heap-use-after-free", "Use of deallocated memory")159 .Case("heap-buffer-overflow", "Heap buffer overflow")160 .Case("stack-buffer-underflow", "Stack buffer underflow")161 .Case("initialization-order-fiasco", "Initialization order problem")162 .Case("stack-buffer-overflow", "Stack buffer overflow")163 .Case("stack-use-after-return", "Use of stack memory after return")164 .Case("use-after-poison", "Use of poisoned memory")165 .Case("container-overflow", "Container overflow")166 .Case("stack-use-after-scope", "Use of out-of-scope stack memory")167 .Case("global-buffer-overflow", "Global buffer overflow")168 .Case("unknown-crash", "Invalid memory access")169 .Case("stack-overflow", "Stack space exhausted")170 .Case("null-deref", "Dereference of null pointer")171 .Case("wild-jump", "Jump to non-executable address")172 .Case("wild-addr-write", "Write through wild pointer")173 .Case("wild-addr-read", "Read from wild pointer")174 .Case("wild-addr", "Access through wild pointer")175 .Case("signal", "Deadly signal")176 .Case("double-free", "Deallocation of freed memory")177 .Case("new-delete-type-mismatch",178 "Deallocation size different from allocation size")179 .Case("bad-free", "Deallocation of non-allocated memory")180 .Case("alloc-dealloc-mismatch",181 "Mismatch between allocation and deallocation APIs")182 .Case("bad-malloc_usable_size", "Invalid argument to malloc_usable_size")183 .Case("bad-__sanitizer_get_allocated_size",184 "Invalid argument to __sanitizer_get_allocated_size")185 .Case("param-overlap",186 "Call to function disallowing overlapping memory ranges")187 .Case("negative-size-param", "Negative size used when accessing memory")188 .Case("bad-__sanitizer_annotate_contiguous_container",189 "Invalid argument to __sanitizer_annotate_contiguous_container")190 .Case("odr-violation", "Symbol defined in multiple translation units")191 .Case(192 "invalid-pointer-pair",193 "Comparison or arithmetic on pointers from different memory regions")194 // for unknown report codes just show the code195 .Default("AddressSanitizer detected: " + description);196}197 198bool ReportRetriever::NotifyBreakpointHit(ProcessSP process_sp,199 StoppointCallbackContext *context,200 user_id_t break_id,201 user_id_t break_loc_id) {202 // Make sure this is the right process203 if (!process_sp || process_sp != context->exe_ctx_ref.GetProcessSP())204 return false;205 206 if (process_sp->GetModIDRef().IsLastResumeForUserExpression())207 return false;208 209 StructuredData::ObjectSP report = RetrieveReportData(process_sp);210 if (!report || report->GetType() != lldb::eStructuredDataTypeDictionary) {211 LLDB_LOGF(GetLog(LLDBLog::InstrumentationRuntime),212 "ReportRetriever::RetrieveReportData() failed");213 return false;214 }215 216 std::string description = FormatDescription(report);217 218 if (ThreadSP thread_sp = context->exe_ctx_ref.GetThreadSP())219 thread_sp->SetStopInfo(220 InstrumentationRuntimeStopInfo::CreateStopReasonWithInstrumentationData(221 *thread_sp, description, report));222 223 if (StreamSP stream_sp =224 process_sp->GetTarget().GetDebugger().GetAsyncOutputStream())225 stream_sp->Printf("AddressSanitizer report breakpoint hit. Use 'thread "226 "info -s' to get extended information about the "227 "report.\n");228 229 return true; // Return true to stop the target230}231 232Breakpoint *ReportRetriever::SetupBreakpoint(ModuleSP module_sp,233 ProcessSP process_sp,234 ConstString symbol_name) {235 if (!module_sp || !process_sp)236 return nullptr;237 238 const Symbol *symbol =239 module_sp->FindFirstSymbolWithNameAndType(symbol_name, eSymbolTypeCode);240 241 if (symbol == nullptr)242 return nullptr;243 244 if (!symbol->ValueIsAddress() || !symbol->GetAddressRef().IsValid())245 return nullptr;246 247 const Address &address = symbol->GetAddressRef();248 const bool internal = true;249 const bool hardware = false;250 251 Breakpoint *breakpoint = process_sp->GetTarget()252 .CreateBreakpoint(address, internal, hardware)253 .get();254 255 return breakpoint;256}257