Files
llvm/lldb/source/Target/InstrumentationRuntimeStopInfo.cpp
Michael Buch 879f40ab04 [lldb][Instrumentation] Set selected frame to outside sanitizer libraries (#133079)
When hitting a sanitizer breakpoint, LLDB currently displays the frame
in the sanitizer dylib (which we usually don't have debug-info for),
which isn't very helpful to the user. A more helpful frame to display
would be the first frame not in the sanitizer library (we have a
[similar heuristic when we trap inside
libc++](https://github.com/llvm/llvm-project/pull/108825)). This patch
does just that, by implementing the `GetSuggestedStackFrameIndex` API

Depends on https://github.com/llvm/llvm-project/pull/133078
2025-09-08 17:03:31 +00:00

79 lines
2.4 KiB
C++

//===-- InstrumentationRuntimeStopInfo.cpp --------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "lldb/Target/InstrumentationRuntimeStopInfo.h"
#include "lldb/Core/Module.h"
#include "lldb/Target/InstrumentationRuntime.h"
#include "lldb/Target/Process.h"
#include "lldb/lldb-enumerations.h"
#include "lldb/lldb-private.h"
using namespace lldb;
using namespace lldb_private;
static bool IsStoppedInDarwinSanitizer(Thread &thread, Module &module) {
return module.GetFileSpec().GetFilename().GetStringRef().starts_with(
"libclang_rt.");
}
InstrumentationRuntimeStopInfo::InstrumentationRuntimeStopInfo(
Thread &thread, std::string description,
StructuredData::ObjectSP additional_data)
: StopInfo(thread, 0) {
m_extended_info = additional_data;
m_description = description;
}
const char *InstrumentationRuntimeStopInfo::GetDescription() {
return m_description.c_str();
}
StopInfoSP
InstrumentationRuntimeStopInfo::CreateStopReasonWithInstrumentationData(
Thread &thread, std::string description,
StructuredData::ObjectSP additionalData) {
return StopInfoSP(
new InstrumentationRuntimeStopInfo(thread, description, additionalData));
}
std::optional<uint32_t>
InstrumentationRuntimeStopInfo::GetSuggestedStackFrameIndex(
bool inlined_stack) {
ThreadSP thread_sp = GetThread();
if (!thread_sp)
return std::nullopt;
// Defensive upper-bound of when we stop walking up the frames in
// case we somehow ended up looking at an infinite recursion.
constexpr size_t max_stack_depth = 128;
// Start at parent frame.
size_t stack_idx = 1;
StackFrameSP most_relevant_frame_sp =
thread_sp->GetStackFrameAtIndex(stack_idx);
while (most_relevant_frame_sp && stack_idx <= max_stack_depth) {
auto const &sc =
most_relevant_frame_sp->GetSymbolContext(lldb::eSymbolContextModule);
if (!sc.module_sp)
return std::nullopt;
// Found a frame outside of the sanitizer runtime libraries.
// That's the one we want to display.
if (!IsStoppedInDarwinSanitizer(*thread_sp, *sc.module_sp))
return stack_idx;
++stack_idx;
most_relevant_frame_sp = thread_sp->GetStackFrameAtIndex(stack_idx);
}
return stack_idx;
}