Skip to content

[lldb-dap] Support StackFrameFormat #137113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 24, 2025
Merged

[lldb-dap] Support StackFrameFormat #137113

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2168161
[lldb-dap] Support StackFrameFormat
JDevlieghere Apr 24, 2025
5b1378f
Fix incorrect interpretation of includeAll
JDevlieghere Apr 24, 2025
3cf5b4f
Black & Darker disagree
JDevlieghere Apr 24, 2025
66f2253
Simplify dap.configuration.displayExtendedBacktrace
JDevlieghere Apr 24, 2025
0584669
Fix decorator
JDevlieghere Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion lldb/packages/Python/lldbsuite/test/tools/lldb-dap/dap_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1046,7 +1046,7 @@ def request_modules(self):
return self.send_recv({"command": "modules", "type": "request"})

def request_stackTrace(
self, threadId=None, startFrame=None, levels=None, dump=False
self, threadId=None, startFrame=None, levels=None, format=None, dump=False
):
if threadId is None:
threadId = self.get_thread_id()
Expand All @@ -1055,6 +1055,8 @@ def request_stackTrace(
args_dict["startFrame"] = startFrame
if levels is not None:
args_dict["levels"] = levels
if format is not None:
args_dict["format"] = format
command_dict = {
"command": "stackTrace",
"type": "request",
Expand Down
18 changes: 14 additions & 4 deletions lldb/packages/Python/lldbsuite/test/tools/lldb-dap/lldbdap_testcase.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,14 @@ def get_dict_value(self, d, key_path):
return value

def get_stackFrames_and_totalFramesCount(
self, threadId=None, startFrame=None, levels=None, dump=False
self, threadId=None, startFrame=None, levels=None, format=None, dump=False
):
response = self.dap_server.request_stackTrace(
threadId=threadId, startFrame=startFrame, levels=levels, dump=dump
threadId=threadId,
startFrame=startFrame,
levels=levels,
format=format,
dump=dump,
)
if response:
stackFrames = self.get_dict_value(response, ["body", "stackFrames"])
Expand All @@ -177,9 +181,15 @@ def get_stackFrames_and_totalFramesCount(
return (stackFrames, totalFrames)
return (None, 0)

def get_stackFrames(self, threadId=None, startFrame=None, levels=None, dump=False):
def get_stackFrames(
self, threadId=None, startFrame=None, levels=None, format=None, dump=False
):
(stackFrames, totalFrames) = self.get_stackFrames_and_totalFramesCount(
threadId=threadId, startFrame=startFrame, levels=levels, dump=dump
threadId=threadId,
startFrame=startFrame,
levels=levels,
format=format,
dump=dump,
)
return stackFrames

Expand Down
35 changes: 28 additions & 7 deletions lldb/test/API/tools/lldb-dap/extendedStackTrace/TestDAP_extendedStackTrace.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
Test lldb-dap stackTrace request with an extended backtrace thread.
"""


import os

import lldbdap_testcase
Expand All @@ -12,11 +11,7 @@


class TestDAP_extendedStackTrace(lldbdap_testcase.DAPTestCaseBase):
@skipUnlessDarwin
def test_stackTrace(self):
"""
Tests the 'stackTrace' packet on a thread with an extended backtrace.
"""
def build_and_run(self, displayExtendedBacktrace=True):
backtrace_recording_lib = findBacktraceRecordingDylib()
if not backtrace_recording_lib:
self.skipTest(
Expand All @@ -36,7 +31,7 @@ def test_stackTrace(self):
"DYLD_LIBRARY_PATH=/usr/lib/system/introspection",
"DYLD_INSERT_LIBRARIES=" + backtrace_recording_lib,
],
displayExtendedBacktrace=True,
displayExtendedBacktrace=displayExtendedBacktrace,
)
source = "main.m"
breakpoint = line_number(source, "breakpoint 1")
Expand All @@ -47,6 +42,12 @@ def test_stackTrace(self):
len(breakpoint_ids), len(lines), "expect correct number of breakpoints"
)

@skipUnlessDarwin
def test_stackTrace(self):
"""
Tests the 'stackTrace' packet on a thread with an extended backtrace.
"""
self.build_and_run()
events = self.continue_to_next_stop()

stackFrames, totalFrames = self.get_stackFrames_and_totalFramesCount(
Expand Down Expand Up @@ -102,3 +103,23 @@ def test_stackTrace(self):
self.assertGreaterEqual(
totalFrames, i, "total frames should include a pagination offset"
)

@skipIfWindows
def test_stackTraceWithFormat(self):
"""
Tests the 'stackTrace' packet on a thread with an extended backtrace using stack trace formats.
"""
self.build_and_run(displayExtendedBacktrace=False)
events = self.continue_to_next_stop()

stackFrames, _ = self.get_stackFrames_and_totalFramesCount(
threadId=events[0]["body"]["threadId"], format={"includeAll": True}
)

stackLabels = [
(i, frame)
for i, frame in enumerate(stackFrames)
if frame.get("presentationHint", "") == "label"
]

self.assertEqual(len(stackLabels), 2, "expected two label stack frames")
28 changes: 27 additions & 1 deletion lldb/test/API/tools/lldb-dap/stackTrace/TestDAP_stackTrace.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
Test lldb-dap stackTrace request
"""


import os

import lldbdap_testcase
Expand Down Expand Up @@ -217,3 +216,30 @@ def test_functionNameWithArgs(self):
self.continue_to_next_stop()
frame = self.get_stackFrames()[0]
self.assertEqual(frame["name"], "recurse(x=1)")

@skipIfWindows
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
But I could not see why this test is skipped on windows
there is a #include <unistd.h> but it is not used any where

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough. All the tests in this file are skipped on Windows for as far as the history goes back. I can try removing all of them in a followup and see what the Windows bot say.

def test_StackFrameFormat(self):
"""
Test the StackFrameFormat.
"""
program = self.getBuildArtifact("a.out")
self.build_and_launch(program)
source = "main.c"

self.set_source_breakpoints(source, [line_number(source, "recurse end")])

self.continue_to_next_stop()
frame = self.get_stackFrames(format={"parameters": True})[0]
self.assertEqual(frame["name"], "recurse(x=1)")

frame = self.get_stackFrames(format={"parameterNames": True})[0]
self.assertEqual(frame["name"], "recurse(x=1)")

frame = self.get_stackFrames(format={"parameterValues": True})[0]
self.assertEqual(frame["name"], "recurse(x=1)")

frame = self.get_stackFrames(format={"parameters": False, "line": True})[0]
self.assertEqual(frame["name"], "main.c:6:5 recurse")

frame = self.get_stackFrames(format={"parameters": False, "module": True})[0]
self.assertEqual(frame["name"], "a.out recurse")
61 changes: 52 additions & 9 deletions lldb/tools/lldb-dap/Handler/StackTraceRequestHandler.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,16 @@ static constexpr int StackPageSize = 20;
//
// s=3,l=3 = [th0->s3, label1, th1->s0]
static bool FillStackFrames(DAP &dap, lldb::SBThread &thread,
lldb::SBFormat &frame_format,
llvm::json::Array &stack_frames, int64_t &offset,
const int64_t start_frame, const int64_t levels) {
const int64_t start_frame, const int64_t levels,
const bool include_all) {
bool reached_end_of_stack = false;
for (int64_t i = start_frame;
static_cast<int64_t>(stack_frames.size()) < levels; i++) {
if (i == -1) {
stack_frames.emplace_back(
CreateExtendedStackFrameLabel(thread, dap.frame_format));
CreateExtendedStackFrameLabel(thread, frame_format));
continue;
}

Expand All @@ -67,10 +69,10 @@ static bool FillStackFrames(DAP &dap, lldb::SBThread &thread,
break;
}

stack_frames.emplace_back(CreateStackFrame(frame, dap.frame_format));
stack_frames.emplace_back(CreateStackFrame(frame, frame_format));
}

if (dap.configuration.displayExtendedBacktrace && reached_end_of_stack) {
if (include_all && reached_end_of_stack) {
// Check for any extended backtraces.
for (uint32_t bt = 0;
bt < thread.GetProcess().GetNumExtendedBacktraceTypes(); bt++) {
Expand All @@ -80,8 +82,9 @@ static bool FillStackFrames(DAP &dap, lldb::SBThread &thread,
continue;

reached_end_of_stack = FillStackFrames(
dap, backtrace, stack_frames, offset,
(start_frame - offset) > 0 ? start_frame - offset : -1, levels);
dap, backtrace, frame_format, stack_frames, offset,
(start_frame - offset) > 0 ? start_frame - offset : -1, levels,
include_all);
if (static_cast<int64_t>(stack_frames.size()) >= levels)
break;
}
Expand Down Expand Up @@ -178,14 +181,54 @@ void StackTraceRequestHandler::operator()(
llvm::json::Array stack_frames;
llvm::json::Object body;

lldb::SBFormat frame_format = dap.frame_format;
bool include_all = dap.configuration.displayExtendedBacktrace;

if (const auto *format = arguments->getObject("format")) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another thing I notice is the StackFrameFormat inherits from ValueFormat and thus includes the hex?: boolean; field as well.

I'm not sure what that would mean in terms of a stack frame however, just thought I would note that for completeness.

// Indicates that all stack frames should be included, even those the debug
// adapter might otherwise hide.
include_all = GetBoolean(format, "includeAll").value_or(false);

// Parse the properties that have a corresponding format string.
// FIXME: Support "parameterTypes" and "hex".
const bool module = GetBoolean(format, "module").value_or(false);
const bool line = GetBoolean(format, "line").value_or(false);
const bool parameters = GetBoolean(format, "parameters").value_or(false);
const bool parameter_names =
GetBoolean(format, "parameterNames").value_or(false);
const bool parameter_values =
GetBoolean(format, "parameterValues").value_or(false);

// Only change the format string if we have to.
if (module || line || parameters || parameter_names || parameter_values) {
std::string format_str;
llvm::raw_string_ostream os(format_str);

if (module)
os << "{${module.file.basename} }";

if (line)
os << "{${line.file.basename}:${line.number}:${line.column} }";

if (parameters || parameter_names || parameter_values)
os << "{${function.name-with-args}}";
else
os << "{${function.name-without-args}}";

lldb::SBError error;
frame_format = lldb::SBFormat(format_str.c_str(), error);
assert(error.Success());
}
}

if (thread.IsValid()) {
const auto start_frame =
GetInteger<uint64_t>(arguments, "startFrame").value_or(0);
const auto levels = GetInteger<uint64_t>(arguments, "levels").value_or(0);
int64_t offset = 0;
bool reached_end_of_stack =
FillStackFrames(dap, thread, stack_frames, offset, start_frame,
levels == 0 ? INT64_MAX : levels);
bool reached_end_of_stack = FillStackFrames(
dap, thread, frame_format, stack_frames, offset, start_frame,
levels == 0 ? INT64_MAX : levels, include_all);
body.try_emplace("totalFrames",
start_frame + stack_frames.size() +
(reached_end_of_stack ? 0 : StackPageSize));
Expand Down
Loading