[Lldb-commits] [lldb] [lldb-dap] Report isOptimized on compileUnits (PR #235981)
Nathan Fusselman via lldb-commits
lldb-commits at lists.llvm.org
Sun Nov 1 20:40:20 PST 2026
https://github.com/nathanfusselman updated https://github.com/llvm/llvm-project/pull/235981
>From b15dec62aaafbc2cc8e232316726833e2ff8484e Mon Sep 17 00:00:00 2001
From: Nathan Fusselman <nfusselman at apple.com>
Date: Wed, 21 Oct 2026 16:37:42 -0700
Subject: [PATCH] [lldb-dap] Report isOptimized on compileUnits
Add isOptimized to the CompileUnit type in the compileUnits response, so
a client can tell whether a frame's code was built with optimizations.
Clients look the compile unit up with the frame's moduleId and
compileUnitId.
rdar://190656814
---
lldb/docs/resources/lldbdap-extensions.md | 7 +++++
.../lldbsuite/test/tools/lldb_dap/types.py | 1 +
.../lldb-dap/optimized/TestDAP_optimized.py | 27 ++++++++++++++++++-
.../lldb-dap/stackTrace/TestDAP_stackTrace.py | 5 +++-
.../Handler/CompileUnitsRequestHandler.cpp | 1 +
.../tools/lldb-dap/Protocol/ProtocolTypes.cpp | 2 ++
lldb/tools/lldb-dap/Protocol/ProtocolTypes.h | 4 +++
lldb/unittests/DAP/ProtocolRequestsTest.cpp | 14 +++++++---
8 files changed, 56 insertions(+), 5 deletions(-)
diff --git a/lldb/docs/resources/lldbdap-extensions.md b/lldb/docs/resources/lldbdap-extensions.md
index 4ccee9309aefa0..96dde6a2837b9b 100644
--- a/lldb/docs/resources/lldbdap-extensions.md
+++ b/lldb/docs/resources/lldbdap-extensions.md
@@ -85,6 +85,13 @@ interface CompileUnit {
* example `c11` or `c++17`. Omitted if the language is unknown.
*/
language?: string;
+
+ /**
+ * True if the compile unit was compiled with optimization, false if it
+ * was unoptimized or unknown. Optional so a debugger can omit it when
+ * unknown, in which case clients should treat it as unknown.
+ */
+ isOptimized?: boolean;
}
```
diff --git a/lldb/packages/Python/lldbsuite/test/tools/lldb_dap/types.py b/lldb/packages/Python/lldbsuite/test/tools/lldb_dap/types.py
index 75cfcd28f54612..0337ea492744d1 100644
--- a/lldb/packages/Python/lldbsuite/test/tools/lldb_dap/types.py
+++ b/lldb/packages/Python/lldbsuite/test/tools/lldb_dap/types.py
@@ -784,6 +784,7 @@ class CompileUnit:
id: int
compileUnitPath: str
language: Optional[str] = None
+ isOptimized: Optional[bool] = None
@dataclass(frozen=True)
diff --git a/lldb/test/API/tools/lldb-dap/optimized/TestDAP_optimized.py b/lldb/test/API/tools/lldb-dap/optimized/TestDAP_optimized.py
index 9335a4b7f2b8ff..ec0aa1d2c66954 100644
--- a/lldb/test/API/tools/lldb-dap/optimized/TestDAP_optimized.py
+++ b/lldb/test/API/tools/lldb-dap/optimized/TestDAP_optimized.py
@@ -5,7 +5,7 @@
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import line_number
from lldbsuite.test.tools.lldb_dap import DAPTestCaseBase, ExpectVar
-from lldbsuite.test.tools.lldb_dap.types import LaunchArgs
+from lldbsuite.test.tools.lldb_dap.types import CompileUnitsArgs, LaunchArgs
class TestDAP_optimized(DAPTestCaseBase):
@@ -29,6 +29,31 @@ def test_stack_frame_name(self):
parent_frame = frames[1].frame
self.assertTrue(parent_frame.name.endswith(" [opt]"))
+ def test_compile_unit_is_optimized(self):
+ """Test the compile unit of an optimized frame is marked optimized."""
+ program = self.getBuildArtifact("a.out")
+ session = self.build_and_create_session()
+
+ source = "main.cpp"
+ breakpoint_line = line_number(source, "// breakpoint 1")
+ with session.configure(LaunchArgs(program)) as ctx:
+ bp_ids = session.resolve_source_breakpoints(source, [breakpoint_line])
+
+ stop_event = session.verify_stopped_on_breakpoint(
+ bp_ids, after=ctx.process_event
+ )
+ thread_id = self.expect_not_none(stop_event.body.threadId)
+ frame = session.stack_trace(thread_id).body.stackFrames[0]
+ module_id = self.expect_not_none(frame.moduleId)
+ compile_unit_id = self.expect_not_none(frame.compileUnitId)
+
+ response = session.send_request(
+ CompileUnitsArgs(moduleId=module_id, compileUnitIds=[compile_unit_id])
+ ).result()
+ self.assertEqual(len(response.body.compileUnits), 1)
+ self.assertTrue(response.body.compileUnits[0].isOptimized)
+ session.continue_to_exit()
+
@skipIfAsan # On ASAN builds this test intermittently fails https://github.com/llvm/llvm-project/issues/111061
@skipIfWasm # an optimized out variable keeps a reused local, so reading it succeeds
def test_optimized_variable(self):
diff --git a/lldb/test/API/tools/lldb-dap/stackTrace/TestDAP_stackTrace.py b/lldb/test/API/tools/lldb-dap/stackTrace/TestDAP_stackTrace.py
index 92e9e5ba254f9e..883c992c4adaae 100644
--- a/lldb/test/API/tools/lldb-dap/stackTrace/TestDAP_stackTrace.py
+++ b/lldb/test/API/tools/lldb-dap/stackTrace/TestDAP_stackTrace.py
@@ -346,7 +346,10 @@ def test_stack_frame_compile_unit_id(self) -> None:
self.assertEqual(frame.source.name, "main.c")
expected = CompileUnit(
- id=compile_unit_id, compileUnitPath=source, language="c11"
+ id=compile_unit_id,
+ compileUnitPath=source,
+ language="c11",
+ isOptimized=False,
)
response = session.send_request(CompileUnitsArgs(moduleId=module_id)).result()
diff --git a/lldb/tools/lldb-dap/Handler/CompileUnitsRequestHandler.cpp b/lldb/tools/lldb-dap/Handler/CompileUnitsRequestHandler.cpp
index 365bcba4a6ca35..bf3aa6147429c7 100644
--- a/lldb/tools/lldb-dap/Handler/CompileUnitsRequestHandler.cpp
+++ b/lldb/tools/lldb-dap/Handler/CompileUnitsRequestHandler.cpp
@@ -36,6 +36,7 @@ static std::optional<CompileUnit> CreateCompileUnit(lldb::SBCompileUnit unit) {
lldb::SBLanguageRuntime::GetNameForLanguageType(language))
result.language = name;
}
+ result.isOptimized = unit.GetIsOptimized();
return result;
}
diff --git a/lldb/tools/lldb-dap/Protocol/ProtocolTypes.cpp b/lldb/tools/lldb-dap/Protocol/ProtocolTypes.cpp
index e765c5e647e778..29fefb521a2c48 100644
--- a/lldb/tools/lldb-dap/Protocol/ProtocolTypes.cpp
+++ b/lldb/tools/lldb-dap/Protocol/ProtocolTypes.cpp
@@ -1174,6 +1174,8 @@ llvm::json::Value toJSON(const CompileUnit &CU) {
json::Object result{{"id", CU.id}, {"compileUnitPath", CU.compileUnitPath}};
if (CU.language)
result.insert({"language", *CU.language});
+ if (CU.isOptimized)
+ result.insert({"isOptimized", *CU.isOptimized});
return result;
}
diff --git a/lldb/tools/lldb-dap/Protocol/ProtocolTypes.h b/lldb/tools/lldb-dap/Protocol/ProtocolTypes.h
index 8da03217400806..7a766f81da2e12 100644
--- a/lldb/tools/lldb-dap/Protocol/ProtocolTypes.h
+++ b/lldb/tools/lldb-dap/Protocol/ProtocolTypes.h
@@ -1053,6 +1053,10 @@ struct CompileUnit {
/// The language of the compile unit, with its version where known, for
/// example `c11` or `c++17`.
std::optional<String> language;
+
+ /// True if the compile unit was compiled with optimization, false if it was
+ /// unoptimized or unknown. Optional so a debugger can omit it when unknown.
+ std::optional<bool> isOptimized;
};
llvm::json::Value toJSON(const CompileUnit &);
diff --git a/lldb/unittests/DAP/ProtocolRequestsTest.cpp b/lldb/unittests/DAP/ProtocolRequestsTest.cpp
index 1aaed363c43691..fb9017c6735188 100644
--- a/lldb/unittests/DAP/ProtocolRequestsTest.cpp
+++ b/lldb/unittests/DAP/ProtocolRequestsTest.cpp
@@ -274,7 +274,9 @@ TEST(ProtocolRequestsTest, CompileUnitsArguments) {
TEST(ProtocolRequestsTest, CompileUnitsResponseBody) {
CompileUnitsResponseBody body;
- body.compileUnits = {{1, "main.cpp", "c++"}, {2, "util.cpp", std::nullopt}};
+ body.compileUnits = {{1, "main.cpp", "c++", false},
+ {2, "util.cpp", std::nullopt, true},
+ {3, "other.cpp", std::nullopt, std::nullopt}};
// Check required keys.
Expected<json::Value> expected = parse(R"({
@@ -282,11 +284,17 @@ TEST(ProtocolRequestsTest, CompileUnitsResponseBody) {
{
"id": 1,
"compileUnitPath": "main.cpp",
- "language": "c++"
+ "language": "c++",
+ "isOptimized": false
},
{
"id": 2,
- "compileUnitPath": "util.cpp"
+ "compileUnitPath": "util.cpp",
+ "isOptimized": true
+ },
+ {
+ "id": 3,
+ "compileUnitPath": "other.cpp"
}
]
})");
More information about the lldb-commits
mailing list