Merge pull request #41680 from artemcm/StaticMirrorFields

[Static Mirror] Refactor gathering of field types from a binary and add SwiftStaticMirror entry-points for collection of field types.

Author: artemcm

include/swift-c/StaticMirror/BinaryScan.h

@@ -25,7 +25,7 @@
 /// SWIFTSTATICMIRROR_VERSION_MINOR should increase when there are API additions.
 /// SWIFTSTATICMIRROR_VERSION_MAJOR is intended for "major" source/ABI breaking changes.
 #define SWIFTSTATICMIRROR_VERSION_MAJOR 0
-#define SWIFTSTATICMIRROR_VERSION_MINOR 2 // Added associated-type gather
+#define SWIFTSTATICMIRROR_VERSION_MINOR 3 // Added filed type info gather
 
 SWIFTSTATICMIRROR_BEGIN_DECLS
 
@@ -42,6 +42,18 @@ typedef void *swift_static_mirror_t;
 typedef struct swift_static_mirror_conformance_info_s
     *swift_static_mirror_conformance_info_t;
 
+/// Opaque container to a field info (property type or enum case)
+typedef struct swift_static_mirror_field_info_s
+    *swift_static_mirror_field_info_t;
+
+/// Opaque container to a property type info
+typedef struct swift_static_mirror_property_info_s
+    *swift_static_mirror_property_info_t;
+
+/// Opaque container to an enum case info
+typedef struct swift_static_mirror_enum_case_info_s
+    *swift_static_mirror_enum_case_info_t;
+
 /// Opaque container to details of an associated type specification.
 typedef struct swift_static_mirror_type_alias_s
     *swift_static_mirror_type_alias_t;
@@ -55,7 +67,6 @@ typedef struct {
   size_t count;
 } swift_static_mirror_type_alias_set_t;
 
-
 typedef struct {
   swift_static_mirror_associated_type_info_t *associated_type_infos;
   size_t count;
@@ -66,26 +77,35 @@ typedef struct {
   size_t count;
 } swift_static_mirror_conformances_set_t;
 
+typedef struct {
+  swift_static_mirror_property_info_t *properties;
+  size_t count;
+} swift_static_mirror_property_info_set_t;
 
-// swift_static_mirror_conformance_info query methods
+typedef struct {
+  swift_static_mirror_enum_case_info_t *enum_cases;
+  size_t count;
+} swift_static_mirror_enum_case_info_set_t;
+
+typedef struct {
+  swift_static_mirror_field_info_t *field_infos;
+  size_t count;
+} swift_static_mirror_field_info_set_t;
 
+// swift_static_mirror_conformance_info query methods
 SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_string_ref_t
     swift_static_mirror_conformance_info_get_type_name(
         swift_static_mirror_conformance_info_t);
-
 SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_string_ref_t
     swift_static_mirror_conformance_info_get_protocol_name(
         swift_static_mirror_conformance_info_t);
-
 SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_string_ref_t
     swift_static_mirror_conformance_info_get_mangled_type_name(
         swift_static_mirror_conformance_info_t);
+SWIFTSTATICMIRROR_PUBLIC void swift_static_mirror_conformance_info_dispose(
+    swift_static_mirror_conformance_info_t);
 
-SWIFTSTATICMIRROR_PUBLIC void
-    swift_static_mirror_conformance_info_dispose(
-        swift_static_mirror_conformance_info_t);
-
-// swift_static_mirror_associated_type query methods
+// swift_static_mirror_associated_type_info query methods
 SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_string_ref_t
     swift_static_mirror_type_alias_get_type_alias_name(
         swift_static_mirror_type_alias_t);
@@ -100,41 +120,77 @@ SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_string_ref_t
 SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_string_ref_t
     swift_static_mirror_associated_type_info_get_mangled_type_name(
         swift_static_mirror_associated_type_info_t);
-SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_type_alias_set_t*
+SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_type_alias_set_t *
     swift_static_mirror_associated_type_info_get_type_alias_set(
         swift_static_mirror_associated_type_info_t);
 
+// swift_static_mirror_field_info query methods
+SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_string_ref_t
+    swift_static_mirror_field_info_get_mangled_type_name(
+        swift_static_mirror_field_info_t);
+SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_property_info_set_t *
+    swift_static_mirror_field_info_get_property_info_set(
+        swift_static_mirror_field_info_t);
+SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_enum_case_info_set_t *
+    swift_static_mirror_field_info_get_enum_case_info_set(
+        swift_static_mirror_field_info_t);
+SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_string_ref_t
+    swift_static_mirror_property_info_get_label(
+        swift_static_mirror_property_info_t);
+SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_string_ref_t
+    swift_static_mirror_property_info_get_type_name(
+        swift_static_mirror_property_info_t);
+SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_string_ref_t
+    swift_static_mirror_property_info_get_mangled_type_name(
+        swift_static_mirror_property_info_t);
+SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_string_ref_t
+    swift_static_mirror_enum_case_info_get_label(
+        swift_static_mirror_enum_case_info_t);
+
 /// Create an \c swift_static_mirror_t instance.
 /// The returned \c swift_static_mirror_t is owned by the caller and must be
 /// disposed of using \c swift_static_mirror_dispose .
 SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_t
 swift_static_mirror_create(int, const char **, const char *);
 
 SWIFTSTATICMIRROR_PUBLIC void
-swift_static_mirror_dispose(swift_static_mirror_t);
+    swift_static_mirror_dispose(swift_static_mirror_t);
 
 /// Identify and collect all types conforming to any of the protocol names
 /// specified as arguments
 SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_conformances_set_t *
-swift_static_mirror_conformances_set_create(
-    swift_static_mirror_t, int, const char **);
+swift_static_mirror_conformances_set_create(swift_static_mirror_t, int,
+                                            const char **);
 
 SWIFTSTATICMIRROR_PUBLIC void swift_static_mirror_conformances_set_dispose(
     swift_static_mirror_conformances_set_t *);
 
-/// Identify and collect all associated types of a given input type (by mangled name)
+/// Identify and collect all associated types of a given input type (by mangled
+/// name)
 SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_associated_type_info_set_t *
-swift_static_mirror_associated_type_info_set_create(
-    swift_static_mirror_t, const char *);
+swift_static_mirror_associated_type_info_set_create(swift_static_mirror_t,
+                                                    const char *);
 
 /// Identify and collect associated types of all discovered types.
 SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_associated_type_info_set_t *
-swift_static_mirror_all_associated_type_info_set_create(
-    swift_static_mirror_t);
+    swift_static_mirror_all_associated_type_info_set_create(
+        swift_static_mirror_t);
 
-SWIFTSTATICMIRROR_PUBLIC void swift_static_mirror_associated_type_info_set_dispose(
+SWIFTSTATICMIRROR_PUBLIC void
+swift_static_mirror_associated_type_info_set_dispose(
     swift_static_mirror_associated_type_info_set_t *);
 
+/// Identify and collect all field types of a given input type (by mangled name)
+SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_field_info_set_t *
+swift_static_mirror_field_info_set_create(swift_static_mirror_t, const char *);
+
+/// Identify and collect field types of all discovered types.
+SWIFTSTATICMIRROR_PUBLIC swift_static_mirror_field_info_set_t *
+    swift_static_mirror_all_field_info_set_create(swift_static_mirror_t);
+
+SWIFTSTATICMIRROR_PUBLIC void swift_static_mirror_field_info_set_dispose(
+    swift_static_mirror_field_info_set_t *);
+
 SWIFTSTATICMIRROR_END_DECLS
 
 #endif // SWIFT_C_BINARY_SCAN_H

include/swift/Reflection/TypeRefBuilder.h

@@ -304,7 +304,7 @@ struct AssociatedType {
   std::string SubstitutedTypeDiagnosticPrintName;
 };
 
-/// Info about a given type's associated type, as read out from an Image
+/// Info about all of a given type's associated types, as read out from an Image
 struct AssociatedTypeInfo {
   std::string MangledTypeName;
   std::string FullyQualifiedName;
@@ -317,6 +317,30 @@ struct AssociatedTypeCollectionResult {
   std::vector<std::string> Errors;
 };
 
+struct PropertyTypeInfo {
+  std::string Label;
+  std::string TypeMangledName;
+  std::string TypeFullyQualifiedName;
+  std::string TypeDiagnosticPrintName;
+};
+
+struct EnumCaseInfo {
+  std::string Label;
+};
+
+/// Info about all of a given type's fields, as read out from an Image
+struct FieldMetadata {
+  std::string MangledTypeName;
+  std::string FullyQualifiedName;
+  std::vector<PropertyTypeInfo> Properties;
+  std::vector<EnumCaseInfo> EnumCases;
+};
+
+struct FieldTypeCollectionResult {
+  std::vector<FieldMetadata> FieldInfos;
+  std::vector<std::string> Errors;
+};
+
 /// An implementation of MetadataReader's BuilderType concept for
 /// building TypeRefs, and parsing field metadata from any images
 /// it has been made aware of.
@@ -899,6 +923,7 @@ class TypeRefBuilder {
 
   void dumpTypeRef(RemoteRef<char> MangledName, std::ostream &stream,
                    bool printTypeName = false);
+  FieldTypeCollectionResult collectFieldTypes(llvm::Optional<std::string> forMangledTypeName);
   void dumpFieldSection(std::ostream &stream);
   AssociatedTypeCollectionResult collectAssociatedTypes(llvm::Optional<std::string> forMangledTypeName);
   void dumpAssociatedTypeSection(std::ostream &stream);

include/swift/StaticMirror/BinaryScanImpl.h

@@ -41,4 +41,20 @@ struct swift_static_mirror_associated_type_info_s {
   swift_static_mirror_type_alias_set_t *type_alias_set;
 };
 
+struct swift_static_mirror_enum_case_info_s {
+  swift_static_mirror_string_ref_t label;
+};
+
+struct swift_static_mirror_property_info_s {
+  swift_static_mirror_string_ref_t label;
+  swift_static_mirror_string_ref_t type_name;
+  swift_static_mirror_string_ref_t mangled_type_name;
+};
+
+struct swift_static_mirror_field_info_s {
+  swift_static_mirror_string_ref_t mangled_type_name;
+  swift_static_mirror_property_info_set_t *property_set;
+  swift_static_mirror_enum_case_info_set_t *enum_case_set;
+};
+
 #endif // SWIFT_C_BINARY_SCAN_IMPL_H

include/swift/StaticMirror/BinaryScanningTool.h

@@ -54,6 +54,14 @@ class BinaryScanningTool {
   reflection::AssociatedTypeCollectionResult
   collectAllAssociatedTypes();
 
+  /// Collect all field type infos of the specified type
+  reflection::FieldTypeCollectionResult
+  collectFieldTypes(const std::string &mangledTypeName);
+
+  /// Collect field type infos of all discovered types
+  reflection::FieldTypeCollectionResult
+  collectAllFieldTypes();
+
 private:
   // Note: binaryOrError and objectOrError own the memory for our ObjectFile;
   // once they go out of scope, we can no longer do anything.

lib/StaticMirror/BinaryScanningTool.cpp

@@ -87,5 +87,15 @@ AssociatedTypeCollectionResult
 BinaryScanningTool::collectAllAssociatedTypes() {
   return Context->Builder.collectAssociatedTypes(llvm::Optional<std::string>());
 }
+
+FieldTypeCollectionResult
+BinaryScanningTool::collectFieldTypes(const std::string &mangledTypeName) {
+  return Context->Builder.collectFieldTypes(mangledTypeName);
+}
+
+FieldTypeCollectionResult
+BinaryScanningTool::collectAllFieldTypes() {
+  return Context->Builder.collectFieldTypes(llvm::Optional<std::string>());
+}
 } // end namespace static_mirror
 } // end namespace swift

stdlib/public/Reflection/TypeRefBuilder.cpp

@@ -432,30 +432,76 @@ void TypeRefBuilder::dumpTypeRef(RemoteRef<char> MangledName,
   stream << "\n";
 }
 
-void TypeRefBuilder::dumpFieldSection(std::ostream &stream) {
+FieldTypeCollectionResult TypeRefBuilder::collectFieldTypes(
+    llvm::Optional<std::string> forMangledTypeName) {
+  FieldTypeCollectionResult result;
   for (const auto &sections : ReflectionInfos) {
     for (auto descriptor : sections.Field) {
-      auto TypeDemangling =
-          demangleTypeRef(readTypeRef(descriptor, descriptor->MangledTypeName));
-      auto TypeName = nodeToString(TypeDemangling);
+      auto typeRef = readTypeRef(descriptor, descriptor->MangledTypeName);
+      auto typeName = nodeToString(demangleTypeRef(typeRef));
+      auto optionalMangledTypeName = normalizeReflectionName(typeRef);
       clearNodeFactory();
-      stream << TypeName.c_str() << "\n";
-      for (size_t i = 0; i < TypeName.size(); ++i)
-        stream << "-";
-      stream << "\n";
-      for (auto &fieldRef : *descriptor.getLocalBuffer()) {
-        auto field = descriptor.getField(fieldRef);
-        auto fieldName = getTypeRefString(readTypeRef(field, field->FieldName));
-        stream.write(fieldName.data(), fieldName.size());
-        if (field->hasMangledTypeName()) {
-          stream << ": ";
-          dumpTypeRef(readTypeRef(field, field->MangledTypeName), stream);
-        } else {
-          stream << "\n\n";
+      if (optionalMangledTypeName.hasValue()) {
+        auto mangledTypeName =
+            optionalMangledTypeName.getValue().insert(0, "$s");
+        if (forMangledTypeName.hasValue()) {
+          if (mangledTypeName != forMangledTypeName.getValue())
+            continue;
         }
+
+        std::vector<PropertyTypeInfo> properties;
+        std::vector<EnumCaseInfo> enumCases;
+        for (auto &fieldRef : *descriptor.getLocalBuffer()) {
+          auto field = descriptor.getField(fieldRef);
+          auto fieldName = getTypeRefString(readTypeRef(field, field->FieldName));
+          if (field->hasMangledTypeName()) {
+            std::string mangledFieldTypeName =
+                std::string(field->MangledTypeName);
+            auto fieldTypeRef = readTypeRef(field, field->MangledTypeName);
+            auto optionalMangledfieldTypeName =
+                normalizeReflectionName(fieldTypeRef);
+            if (optionalMangledfieldTypeName.hasValue()) {
+              mangledFieldTypeName =
+                  "$s" + optionalMangledfieldTypeName.getValue();
+            }
+            auto fieldTypeDemangleTree = demangleTypeRef(fieldTypeRef);
+            auto fieldTypeName = nodeToString(fieldTypeDemangleTree);
+            std::stringstream OS;
+            dumpTypeRef(fieldTypeRef, OS);
+            properties.emplace_back(PropertyTypeInfo{fieldName.str(),
+                                                     mangledFieldTypeName,
+                                                     fieldTypeName, OS.str()});
+          } else {
+            enumCases.emplace_back(EnumCaseInfo{fieldName.str()});
+          }
+        }
+        result.FieldInfos.emplace_back(FieldMetadata{
+            mangledTypeName, typeName, properties, enumCases});
       }
     }
   }
+
+  return result;
+}
+
+void TypeRefBuilder::dumpFieldSection(std::ostream &stream) {
+  auto fieldInfoCollectionResult =
+      collectFieldTypes(llvm::Optional<std::string>());
+  for (const auto &info : fieldInfoCollectionResult.FieldInfos) {
+    stream << info.FullyQualifiedName << "\n";
+    for (size_t i = 0; i < info.FullyQualifiedName.size(); ++i)
+      stream << "-";
+    stream << "\n";
+    for (const auto &field : info.Properties) {
+      stream << field.Label;
+      stream << ": ";
+      stream << field.TypeDiagnosticPrintName;
+    }
+    for (const auto &field : info.EnumCases) {
+      stream << field.Label;
+      stream << "\n\n";
+    }
+  }
 }
 
 AssociatedTypeCollectionResult TypeRefBuilder::collectAssociatedTypes(