[lldb] Fix type lookup in DWARF .o files via debug map #87177
Conversation
An inverted condition causes SymbolFileDWARFDebugMap::FindTypes to bail out after inspecting the first .o file in each module. The same kind of bug is found in SymbolFileDWARFDebugMap::ParseDeclsForContext. This change fixes the early-exit conditions and adds a regression test for lookup of up a type defined in a secondary compilation unit.
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write If you have received no comments on your PR for a week, you can request a review If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
|
@llvm/pr-subscribers-lldb Author: Pablo Busse (pabusse) ChangesAn inverted condition causes The same kind of bug is found in Correct both early exit conditions and add a regression test for lookup of up a type defined in a secondary compilation unit. Fixes #87176 Full diff: https://github.com/llvm/llvm-project/pull/87177.diff 5 Files Affected:
diff --git a/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.cpp b/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.cpp
index 6dd3eb3677b7af..4bc2cfd60688a8 100644
--- a/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.cpp
+++ b/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.cpp
@@ -1233,7 +1233,7 @@ void SymbolFileDWARFDebugMap::FindTypes(const TypeQuery &query,
std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
oso_dwarf->FindTypes(query, results);
- return !results.Done(query); // Keep iterating if we aren't done.
+ return results.Done(query); // Keep iterating if we aren't done.
});
}
@@ -1391,7 +1391,7 @@ void SymbolFileDWARFDebugMap::ParseDeclsForContext(
lldb_private::CompilerDeclContext decl_ctx) {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
oso_dwarf->ParseDeclsForContext(decl_ctx);
- return true; // Keep iterating
+ return false; // Keep iterating
});
}
diff --git a/lldb/test/API/functionalities/type_find_first/Makefile b/lldb/test/API/functionalities/type_find_first/Makefile
index 3d0b98f13f3d7b..e027553c7a6b09 100644
--- a/lldb/test/API/functionalities/type_find_first/Makefile
+++ b/lldb/test/API/functionalities/type_find_first/Makefile
@@ -1,2 +1,2 @@
-CXX_SOURCES := main.cpp
+CXX_SOURCES := main.cpp other.cpp
include Makefile.rules
diff --git a/lldb/test/API/functionalities/type_find_first/TestFindFirstType.py b/lldb/test/API/functionalities/type_find_first/TestFindFirstType.py
index 6347a35e72ea3f..4e0ee2ca685e73 100644
--- a/lldb/test/API/functionalities/type_find_first/TestFindFirstType.py
+++ b/lldb/test/API/functionalities/type_find_first/TestFindFirstType.py
@@ -8,8 +8,6 @@
class TypeFindFirstTestCase(TestBase):
- NO_DEBUG_INFO_TESTCASE = True
-
def test_find_first_type(self):
"""
Test SBTarget::FindFirstType() and SBModule::FindFirstType() APIs.
@@ -19,19 +17,22 @@ def test_find_first_type(self):
basename, FindFirstType() could end up failing depending on which
type was found first in the debug info indexes. This test will
ensure this doesn't regress in the future.
+
+ The test also looks for a type defined in a different compilation unit
+ to verify that SymbolFileDWARFDebugMap searches each symbol file in a
+ module.
"""
self.build()
target = self.createTestTarget()
- # Test the SBTarget APIs for FindFirstType
- integer_type = target.FindFirstType("Integer::Point")
- self.assertTrue(integer_type.IsValid())
- float_type = target.FindFirstType("Float::Point")
- self.assertTrue(float_type.IsValid())
-
- # Test the SBModule APIs for FindFirstType
exe_module = target.GetModuleAtIndex(0)
self.assertTrue(exe_module.IsValid())
- integer_type = exe_module.FindFirstType("Integer::Point")
- self.assertTrue(integer_type.IsValid())
- float_type = exe_module.FindFirstType("Float::Point")
- self.assertTrue(float_type.IsValid())
+ # Test the SBTarget and SBModule APIs for FindFirstType
+ for api in [target, exe_module]:
+ integer_type = api.FindFirstType("Integer::Point")
+ self.assertTrue(integer_type.IsValid())
+ float_type = api.FindFirstType("Float::Point")
+ self.assertTrue(float_type.IsValid())
+ external_type = api.FindFirstType("OtherCompilationUnit::Type");
+ self.assertTrue(external_type.IsValid())
+ nonexistent_type = api.FindFirstType("NonexistentType");
+ self.assertFalse(nonexistent_type.IsValid())
diff --git a/lldb/test/API/functionalities/type_find_first/main.cpp b/lldb/test/API/functionalities/type_find_first/main.cpp
index f4e467286004d6..bbb060872a1e9a 100644
--- a/lldb/test/API/functionalities/type_find_first/main.cpp
+++ b/lldb/test/API/functionalities/type_find_first/main.cpp
@@ -10,8 +10,13 @@ struct Point {
};
} // namespace Float
+namespace OtherCompilationUnit {
+void Function();
+} // namespace OtherCompilationUnit
+
int main(int argc, char const *argv[]) {
Integer::Point ip = {2, 3};
Float::Point fp = {2.0, 3.0};
+ OtherCompilationUnit::Function();
return 0;
}
diff --git a/lldb/test/API/functionalities/type_find_first/other.cpp b/lldb/test/API/functionalities/type_find_first/other.cpp
new file mode 100644
index 00000000000000..b91edcd8e1d76d
--- /dev/null
+++ b/lldb/test/API/functionalities/type_find_first/other.cpp
@@ -0,0 +1,4 @@
+namespace OtherCompilationUnit {
+struct Type {};
+void Function() { Type typeIsActuallyUsed; }
+} // namespace OtherCompilationUnit
\ No newline at end of file
|
|
✅ With the latest revision this PR passed the Python code formatter. |
|
@pabusse Hi, thanks for the patch! |
|
Thanks for the patch, sounds like it should fix #86184 |
| @@ -1233,7 +1233,7 @@ void SymbolFileDWARFDebugMap::FindTypes(const TypeQuery &query, | |||
| std::lock_guard<std::recursive_mutex> guard(GetModuleMutex()); | |||
| ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool { | |||
| oso_dwarf->FindTypes(query, results); | |||
| return !results.Done(query); // Keep iterating if we aren't done. | |||
| return results.Done(query); // Keep iterating if we aren't done. | |||
There was a problem hiding this comment.
Outside the scope of this patch, but I think we should finally change the return type to an enum that makes it easier to figure out whether we want to "continue" versus "short-circuit".
| @@ -1391,7 +1391,7 @@ void SymbolFileDWARFDebugMap::ParseDeclsForContext( | |||
| lldb_private::CompilerDeclContext decl_ctx) { | |||
| ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool { | |||
| oso_dwarf->ParseDeclsForContext(decl_ctx); | |||
| return true; // Keep iterating | |||
| return false; // Keep iterating | |||
There was a problem hiding this comment.
Outside the scope of this patch, but note that ParseDeclsForContext isn't actually doing anything specific to the object file. Calling it multiple times for the same decl_ctx happens to be a no-op, but this doesn't feel like something that should be on SymbolFile.
|
@pabusse Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested Please check whether problems have been caused by your change specifically, as How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
An inverted condition causes `SymbolFileDWARFDebugMap::FindTypes` to bail out after inspecting the first .o file in each module. The same kind of bug is found in `SymbolFileDWARFDebugMap::ParseDeclsForContext`. Correct both early exit conditions and add a regression test for lookup of up a type defined in a secondary compilation unit. Fixes llvm#87176 (cherry picked from commit 154cea4)
… continue iteration of object files This patch introduces a new `IterationMarker` enum (happy to take alternative name suggestions), which callbacks, like the one in `SymbolFileDWARFDebugMap::ForEachSymbolFile` can return in order to indicate whether the caller should continue iterating or bail. For now this patch just changes the `ForEachSymbolFile` callback to use this new enum. In the future we could change the various `DWARFIndex::GetXXX` callbacks to do the same. This makes the callbacks easier to read and hopefully reduces the chance of bugs like llvm#87177.
[cherry-pick][swift/release/6.0] [lldb] Fix type lookup in DWARF .o files via debug map (llvm#87177)
… continue iteration of object files (#87344) This patch introduces a new `IterationMarker` enum (happy to take alternative name suggestions), which callbacks, like the one in `SymbolFileDWARFDebugMap::ForEachSymbolFile`, can return in order to indicate whether the caller should continue iterating or bail. For now this patch just changes the `ForEachSymbolFile` callback to use this new enum. In the future we could change the various `DWARFIndex::GetXXX` callbacks to do the same. This makes the callbacks easier to read and hopefully reduces the chance of bugs like #87177.
An inverted condition causes
SymbolFileDWARFDebugMap::FindTypesto bail out after inspecting the first .o file in each module.The same kind of bug is found in
SymbolFileDWARFDebugMap::ParseDeclsForContext.Correct both early exit conditions and add a regression test for lookup of up a type defined in a secondary compilation unit.
Fixes #87176