[lldb][DataFormatter] Unwrap reference type when formatting std::unordered_map #145872
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…dered_map Desugar any potential references/typedefs before checking `isStdTemplate`. Previously, the typename might've been: ``` const std::unordered_map<...> & ``` for references. This patch gets the pointee type before grabbing the canonical type. `GetNonReferenceType` will unwrap typedefs too, so we should always end up with a non-reference before we get to `GetCanonicalType`. llvm#145847
|
@llvm/pr-subscribers-lldb Author: Michael Buch (Michael137) ChangesDesugar any potential references/typedefs before checking for references. This patch gets the pointee type before grabbing the canonical type. Full diff: https://github.com/llvm/llvm-project/pull/145872.diff 3 Files Affected:
diff --git a/lldb/source/Plugins/Language/CPlusPlus/LibCxxUnorderedMap.cpp b/lldb/source/Plugins/Language/CPlusPlus/LibCxxUnorderedMap.cpp
index ffc33395830bb..501fd0945b82c 100644
--- a/lldb/source/Plugins/Language/CPlusPlus/LibCxxUnorderedMap.cpp
+++ b/lldb/source/Plugins/Language/CPlusPlus/LibCxxUnorderedMap.cpp
@@ -113,8 +113,10 @@ CompilerType lldb_private::formatters::LibcxxStdUnorderedMapSyntheticFrontEnd::
// wraps a std::pair. Peel away the internal wrapper type - whose structure is
// of no value to users, to expose the std::pair. This matches the structure
// returned by the std::map synthetic provider.
- if (isUnorderedMap(
- m_backend.GetCompilerType().GetCanonicalType().GetTypeName())) {
+ if (isUnorderedMap(m_backend.GetCompilerType()
+ .GetNonReferenceType()
+ .GetCanonicalType()
+ .GetTypeName())) {
std::string name;
CompilerType field_type =
element_type.GetFieldAtIndex(0, name, nullptr, nullptr, nullptr);
diff --git a/lldb/test/API/functionalities/data-formatter/data-formatter-stl/libcxx/unordered_map/TestDataFormatterLibccUnorderedMap.py b/lldb/test/API/functionalities/data-formatter/data-formatter-stl/libcxx/unordered_map/TestDataFormatterLibccUnorderedMap.py
index c021a46a17b51..3b412996c6cb4 100644
--- a/lldb/test/API/functionalities/data-formatter/data-formatter-stl/libcxx/unordered_map/TestDataFormatterLibccUnorderedMap.py
+++ b/lldb/test/API/functionalities/data-formatter/data-formatter-stl/libcxx/unordered_map/TestDataFormatterLibccUnorderedMap.py
@@ -64,3 +64,131 @@ def test_iterator_formatters(self):
ValueCheck(name="second", summary='"Qux"'),
],
)
+
+ lldbutil.continue_to_breakpoint(process, bkpt)
+
+ # Test references to std::unordered_map
+ self.expect_var_path(
+ "ref1",
+ summary="size=2",
+ type="const StringMapT &",
+ children=[
+ ValueCheck(
+ name="[0]",
+ children=[
+ ValueCheck(name="first", summary='"Baz"'),
+ ValueCheck(name="second", summary='"Qux"'),
+ ],
+ ),
+ ValueCheck(
+ name="[1]",
+ children=[
+ ValueCheck(name="first", summary='"Foo"'),
+ ValueCheck(name="second", summary='"Bar"'),
+ ],
+ ),
+ ],
+ )
+
+ self.expect_var_path(
+ "ref2",
+ summary="size=2",
+ type="StringMapT &",
+ children=[
+ ValueCheck(
+ name="[0]",
+ children=[
+ ValueCheck(name="first", summary='"Baz"'),
+ ValueCheck(name="second", summary='"Qux"'),
+ ],
+ ),
+ ValueCheck(
+ name="[1]",
+ children=[
+ ValueCheck(name="first", summary='"Foo"'),
+ ValueCheck(name="second", summary='"Bar"'),
+ ],
+ ),
+ ],
+ )
+
+ self.expect_var_path(
+ "ref3",
+ summary="size=2",
+ type="StringMapTRef",
+ children=[
+ ValueCheck(
+ name="[0]",
+ children=[
+ ValueCheck(name="first", summary='"Baz"'),
+ ValueCheck(name="second", summary='"Qux"'),
+ ],
+ ),
+ ValueCheck(
+ name="[1]",
+ children=[
+ ValueCheck(name="first", summary='"Foo"'),
+ ValueCheck(name="second", summary='"Bar"'),
+ ],
+ ),
+ ],
+ )
+
+ self.expect_var_path(
+ "ref4",
+ summary="size=2",
+ type="const StringMapT &",
+ children=[
+ ValueCheck(
+ name="[0]",
+ children=[
+ ValueCheck(name="first", summary='"Baz"'),
+ ValueCheck(name="second", summary='"Qux"'),
+ ],
+ ),
+ ValueCheck(
+ name="[1]",
+ children=[
+ ValueCheck(name="first", summary='"Foo"'),
+ ValueCheck(name="second", summary='"Bar"'),
+ ],
+ ),
+ ],
+ )
+
+ self.expect_var_path(
+ "ref5",
+ summary="size=1",
+ type="const StringMapT &&",
+ children=[
+ ValueCheck(
+ name="[0]",
+ children=[
+ ValueCheck(name="first", summary='"Foo"'),
+ ValueCheck(name="second", summary='"Bar"'),
+ ],
+ ),
+ ],
+ )
+
+ self.expect_var_path(
+ "ref6",
+ summary="size=1",
+ type="StringMapT &&",
+ children=[
+ ValueCheck(
+ name="[0]",
+ children=[
+ ValueCheck(name="first", summary='"Baz"'),
+ ValueCheck(name="second", summary='"Qux"'),
+ ],
+ ),
+ ],
+ )
+
+ # FIXME: we're getting this wrong.
+ self.expect_var_path(
+ "ref7",
+ summary="size=0",
+ type="const StringMapT *const &",
+ )
diff --git a/lldb/test/API/functionalities/data-formatter/data-formatter-stl/libcxx/unordered_map/main.cpp b/lldb/test/API/functionalities/data-formatter/data-formatter-stl/libcxx/unordered_map/main.cpp
index adcea69629770..b3bfdfbbdd7f7 100644
--- a/lldb/test/API/functionalities/data-formatter/data-formatter-stl/libcxx/unordered_map/main.cpp
+++ b/lldb/test/API/functionalities/data-formatter/data-formatter-stl/libcxx/unordered_map/main.cpp
@@ -3,6 +3,14 @@
#include <unordered_map>
using StringMapT = std::unordered_map<std::string, std::string>;
+using StringMapTRef = const StringMapT &;
+
+void check_references(const StringMapT &ref1, StringMapT &ref2,
+ StringMapTRef ref3, StringMapTRef &ref4,
+ const StringMapT &&ref5, StringMapT &&ref6,
+ const StringMapT *const &ref7) {
+ std::printf("Break here");
+}
int main() {
StringMapT string_map;
@@ -21,7 +29,12 @@ int main() {
StringMapT::const_iterator const_baz = string_map.find("Baz");
auto bucket_it = string_map.begin(string_map.bucket("Baz"));
auto const_bucket_it = string_map.cbegin(string_map.bucket("Baz"));
+
std::printf("Break here");
+
+ check_references(string_map, string_map, string_map, string_map,
+ StringMapT{{"Foo", "Bar"}}, StringMapT{{"Baz", "Qux"}},
+ &string_map);
}
return 0;
|
labath
approved these changes
Jun 26, 2025
| lldbutil.continue_to_breakpoint(process, bkpt) | ||
|
|
||
| # Test references to std::unordered_map | ||
| self.expect_var_path( |
There was a problem hiding this comment.
Given that this is just for testing reference resolution, I'd consider making all of the maps have the same content (or even be references to the same object) so that this can be checked with a for loop. (The type will be different, but maybe we don't have to check that since that doesn't come from the data formatter?)
There was a problem hiding this comment.
makes sense. Simplified this in the latest commit. I just passed the "type" as a parameter to a helper function
| ], | ||
| ) | ||
|
|
||
| # FIXME: we're getting this wrong. |
anthonyhatran
pushed a commit
to anthonyhatran/llvm-project
that referenced
this pull request
Jun 26, 2025
…dered_map (llvm#145872) Desugar any potential references/typedefs before checking `isStdTemplate`. Previously, the typename might've been: ``` const std::unordered_map<...> & ``` for references. This patch gets the pointee type before grabbing the canonical type. `GetNonReferenceType` will unwrap typedefs too, so we should always end up with a non-reference before we get to `GetCanonicalType`. llvm#145847
rlavaee
pushed a commit
to rlavaee/llvm-project
that referenced
this pull request
Jul 1, 2025
…dered_map (llvm#145872) Desugar any potential references/typedefs before checking `isStdTemplate`. Previously, the typename might've been: ``` const std::unordered_map<...> & ``` for references. This patch gets the pointee type before grabbing the canonical type. `GetNonReferenceType` will unwrap typedefs too, so we should always end up with a non-reference before we get to `GetCanonicalType`. llvm#145847
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Desugar any potential references/typedefs before checking
isStdTemplate. Previously, the typename might've been:for references. This patch gets the pointee type before grabbing the canonical type.
GetNonReferenceTypewill unwrap typedefs too, so we should always end up with a non-reference before we get toGetCanonicalType.#145847