Merge pull request #7850 from augusto2112/fix-anon-struct

[lldb] Handle formatting C anonymous struct and unions in Swift

Author: augusto2112

lldb/source/Plugins/TypeSystem/Swift/TypeSystemSwiftTypeRef.cpp

@@ -3263,6 +3263,34 @@ CompilerType TypeSystemSwiftTypeRef::GetChildCompilerTypeAtIndex(
           clang_child_type = clang_child_type.GetTypedefedType();
       }
       if (clang_child_type) {
+        // TypeSystemSwiftTypeRef can't properly handle C anonymous types, as
+        // the only identifier CompilerTypes backed by this type system carry is
+        // the type's mangled name. This is problematic for anonymous types, as
+        // sibling anonymous types will share the exact same mangled name,
+        // making it impossible to diferentiate between them. For example, the
+        // following two anonymous structs in "MyStruct" share the same name
+        // (which is MyStruct::(anonymous struct)):
+        //
+        // struct MyStruct {
+        //         struct {
+        //             float x;
+        //             float y;
+        //             float z;
+        //         };
+        //         struct {
+        //           int a;
+        //         };
+        // };
+        //
+        // For this reason, forward any lookups of anonymous types to
+        // TypeSystemClang instead, as that type system carries enough
+        // information to handle anonymous types properly.
+        auto ts_clang = clang_child_type.GetTypeSystem()
+                            .dyn_cast_or_null<TypeSystemClang>();
+        if (ts_clang &&
+            ts_clang->IsAnonymousType(clang_child_type.GetOpaqueQualType()))
+          return clang_child_type;
+
         std::string prefix;
         swift::Demangle::Demangler dem;
         swift::Demangle::NodePointer node =
@@ -3305,6 +3333,7 @@ CompilerType TypeSystemSwiftTypeRef::GetChildCompilerTypeAtIndex(
   if (!runtime)
     return impl();
 #ifndef NDEBUG
+  auto result = impl();
   // FIXME:
   // No point comparing the results if the reflection data has more
   // information.  There's a nasty chicken & egg problem buried here:
@@ -3314,9 +3343,18 @@ CompilerType TypeSystemSwiftTypeRef::GetChildCompilerTypeAtIndex(
   if (get_ast_num_children() <
       runtime->GetNumChildren({weak_from_this(), type}, exe_scope)
           .value_or(0))
-    return impl();
+    return result;
   if (ShouldSkipValidation(type))
-    return impl();
+    return result;
+  // When the child compiler type is an anonymous clang type,
+  // GetChildCompilerTypeAtIndex will return the clang type directly. In this
+  // case validation will fail as it can't correctly compare the mangled 
+  // clang and Swift names, so return early.
+  if (auto ts_clang =
+          result.GetTypeSystem().dyn_cast_or_null<TypeSystemClang>()) {
+    if (ts_clang->IsAnonymousType(result.GetOpaqueQualType()))
+      return result;
+  }
   std::string ast_child_name;
   uint32_t ast_child_byte_size = 0;
   int32_t ast_child_byte_offset = 0;

lldb/test/API/lang/swift/clangimporter/anonymous-clang-types/Makefile

@@ -0,0 +1,5 @@
+SWIFT_SOURCES := main.swift
+C_SOURCES := source.c
+SWIFT_BRIDGING_HEADER := bridging-header.h
+
+include Makefile.rules

lldb/test/API/lang/swift/clangimporter/anonymous-clang-types/TestSwiftAnonymousClangTypes.py

@@ -0,0 +1,36 @@
+import lldb
+from lldbsuite.test.decorators import *
+import lldbsuite.test.lldbtest as lldbtest
+import lldbsuite.test.lldbutil as lldbutil
+
+
+class TestSwiftAnonymousClangTypes(lldbtest.TestBase):
+    @swiftTest
+    def test(self):
+        self.build()
+
+        lldbutil.run_to_source_breakpoint(
+            self, "break here", lldb.SBFileSpec("main.swift")
+        )
+        self.expect(
+            "frame variable twoStructs",
+            substrs=[
+                "(TwoAnonymousStructs) twoStructs = {",
+                "= (x = 1, y = 2, z = 3)",
+                "= (a = 4)",
+            ],
+        )
+
+        self.expect(
+            "frame variable twoUnions",
+            substrs=[
+                "(TwoAnonymousUnions) twoUnions = {",
+                "   = {",
+                "     = (x = 2)",
+                "     = (y = 2, z = 3)",
+                "  }",
+                "   = {",
+                "     = (a = 4, b = 5, c = 6)",
+                "     = (d = 4, e = 5)",
+            ],
+        )

lldb/test/API/lang/swift/clangimporter/anonymous-clang-types/bridging-header.h

@@ -0,0 +1,37 @@
+
+typedef struct TwoAnonymousStructs {
+        struct {
+            float x;
+            float y;
+            float z;
+        };
+        struct {
+          int a;
+        };
+} TwoAnonymousStructs;
+
+typedef struct TwoAnonymousUnions {
+        union {
+          struct {
+            int x;
+          };
+          struct {
+            int y;
+            int z;
+          };
+        };
+        union {
+          struct {
+            int a;
+            int b;
+            int c;
+          };
+          struct {
+            int d;
+            int e;
+          };
+        };
+} TwoAnonymousUnions;
+
+TwoAnonymousStructs makeTwoAnonymousStructs();
+TwoAnonymousUnions makeTwoAnonymousUnions();

lldb/test/API/lang/swift/clangimporter/anonymous-clang-types/main.swift

@@ -0,0 +1,3 @@
+let twoStructs = makeTwoAnonymousStructs()
+let twoUnions = makeTwoAnonymousUnions()
+print("break here")

lldb/test/API/lang/swift/clangimporter/anonymous-clang-types/source.c

@@ -0,0 +1,21 @@
+#include "bridging-header.h"
+
+TwoAnonymousStructs makeTwoAnonymousStructs() {
+    TwoAnonymousStructs anon_struct;
+    anon_struct.x = 1;
+    anon_struct.y = 2;
+    anon_struct.z = 3;
+    anon_struct.a = 4;
+    return anon_struct;
+}
+
+
+TwoAnonymousUnions makeTwoAnonymousUnions() {
+  TwoAnonymousUnions anon_unions;
+  anon_unions.y = 2;
+  anon_unions.z = 3;
+  anon_unions.a = 4;
+  anon_unions.b = 5;
+  anon_unions.c = 6;
+  return anon_unions;
+}