[Outlining] Pass polymorphic args of type.

If any deinit must be called, just pass the full generic environment of
the type being destroyed.

Author: nate-chandler

lib/IRGen/Outlining.cpp

@@ -19,6 +19,7 @@
 #include "Explosion.h"
 #include "GenOpaque.h"
 #include "GenProto.h"
+#include "GenericRequirement.h"
 #include "IRGenFunction.h"
 #include "IRGenMangler.h"
 #include "IRGenModule.h"
@@ -27,6 +28,7 @@
 #include "MetadataRequest.h"
 #include "swift/AST/GenericEnvironment.h"
 #include "swift/AST/IRGenOptions.h"
+#include "swift/IRGen/GenericRequirement.h"
 #include "swift/SIL/SILModule.h"
 
 using namespace swift;
@@ -65,18 +67,8 @@ void OutliningMetadataCollector::collectTypeMetadata(SILType ty) {
   // Substitute opaque types if allowed.
   ty = IGF.IGM.substOpaqueTypesWithUnderlyingTypes(ty, CanGenericSignature());
 
-  auto astType = ty.getASTType();
-  auto &ti = IGF.IGM.getTypeInfoForLowered(astType);
-
-  if (needsDeinit) {
-    auto *nominal = ty.getASTType()->getAnyNominal();
-    if (nominal && nominal->getValueTypeDestructor()) {
-      assert(ty.isMoveOnly());
-      collectFormalTypeMetadata(ty.getASTType());
-    }
-  }
-
   collectTypeMetadataForLayout(ty);
+  collectTypeMetadataForDeinit(ty);
 }
 
 void OutliningMetadataCollector::collectTypeMetadataForLayout(SILType ty) {
@@ -103,6 +95,33 @@ void OutliningMetadataCollector::collectTypeMetadataForLayout(SILType ty) {
   collectRepresentationTypeMetadata(ty);
 }
 
+void OutliningMetadataCollector::collectTypeMetadataForDeinit(SILType ty) {
+  if (!needsDeinit)
+    return;
+
+  auto *nominal = ty.getASTType()->getAnyNominal();
+  if (!nominal)
+    return;
+  if (!nominal->getValueTypeDestructor())
+    return;
+  assert(ty.isMoveOnly());
+
+  if (Requirements.size())
+    return;
+
+  auto pair = getTypeAndGenericSignatureForManglingOutlineFunction(T);
+  auto sig = pair.second;
+  auto subs =
+      digOutGenericEnvironment(T.getASTType())->getForwardingSubstitutionMap();
+  Subs = subs;
+  GenericTypeRequirements requirements(IGF.IGM, sig);
+  for (auto requirement : requirements.getRequirements()) {
+    auto *value = emitGenericRequirementFromSubstitutions(
+        IGF, requirement, MetadataState::Complete, subs);
+    Requirements.insert({requirement, value});
+  }
+}
+
 void OutliningMetadataCollector::collectFormalTypeMetadata(CanType ty) {
   // If the type has no archetypes, we can emit it from scratch in the callee.
   assert(ty->hasArchetype());
@@ -126,6 +145,13 @@ void OutliningMetadataCollector::collectRepresentationTypeMetadata(SILType ty) {
 
 void OutliningMetadataCollector::addPolymorphicArguments(
     SmallVectorImpl<llvm::Value *> &args) const {
+  if (Subs) {
+    for (auto &pair : Requirements) {
+      auto *value = pair.second;
+      args.push_back(value);
+    }
+    return;
+  }
   for (auto &pair : Values) {
     auto metadata = pair.second;
     assert(metadata->getType() == IGF.IGM.TypeMetadataPtrTy);
@@ -135,6 +161,13 @@ void OutliningMetadataCollector::addPolymorphicArguments(
 
 void OutliningMetadataCollector::addPolymorphicParameterTypes(
     SmallVectorImpl<llvm::Type *> &paramTys) const {
+  if (Subs) {
+    for (auto &pair : Requirements) {
+      auto *value = pair.second;
+      paramTys.push_back(value->getType());
+    }
+    return;
+  }
   for (auto &pair : Values) {
     auto *metadata = pair.second;
     paramTys.push_back(metadata->getType());
@@ -143,6 +176,13 @@ void OutliningMetadataCollector::addPolymorphicParameterTypes(
 
 void OutliningMetadataCollector::bindPolymorphicParameters(
     IRGenFunction &IGF, Explosion &params) const {
+  if (Subs) {
+    for (auto &pair : Requirements) {
+      bindGenericRequirement(IGF, pair.first, params.claimNext(),
+                             MetadataState::Complete, *Subs);
+    }
+    return;
+  }
   // Note that our parameter IGF intentionally shadows the IGF that this
   // collector was built with.
   for (auto &pair : Values) {

lib/IRGen/Outlining.h

@@ -19,7 +19,9 @@
 
 #include "IRGen.h"
 #include "LocalTypeDataKind.h"
+#include "swift/AST/SubstitutionMap.h"
 #include "swift/Basic/LLVM.h"
+#include "swift/IRGen/GenericRequirement.h"
 #include "swift/SIL/SILType.h"
 #include "llvm/ADT/MapVector.h"
 
@@ -69,6 +71,8 @@ class OutliningMetadataCollector {
 
 private:
   llvm::MapVector<LocalTypeDataKey, llvm::Value *> Values;
+  llvm::MapVector<GenericRequirement, llvm::Value *> Requirements;
+  std::optional<SubstitutionMap> Subs;
   friend class IRGenModule;
 
 public:
@@ -94,6 +98,7 @@ class OutliningMetadataCollector {
 
 private:
   void collectTypeMetadataForLayout(SILType type);
+  void collectTypeMetadataForDeinit(SILType type);
   void collectFormalTypeMetadata(CanType type);
   void collectRepresentationTypeMetadata(SILType ty);
 };

test/IRGen/moveonly_value_functions.swift

@@ -8,6 +8,10 @@
 @_silgen_name("external_symbol")
 func external_symbol()
 
+public protocol P {
+  static func foo()
+}
+
 public class C<T> {
   deinit {
     external_symbol()
@@ -66,6 +70,31 @@ public struct OuterNC_2<T> : ~Copyable {
   public let i: InnerDeinitingDestructableNC<T>
 }
 
+public struct GenericContext_1<T> {
+}
+
+extension GenericContext_1 : P where T : P {
+  public static func foo() {
+    T.foo()
+  }
+  public struct OuterNC_1: ~Copyable {
+    let i: Inner_NC1
+
+    func doit() {
+      i.beinit()
+    }
+  }
+
+  public struct Inner_NC1: ~Copyable {
+    let t: T
+    let ptr: Int
+    deinit {
+      T.foo()
+    }
+    func beinit() {}
+  }
+}
+
 // Destroyed value:
 // - has deinit
 // On lifetime end:
@@ -98,13 +127,9 @@ public func takeOuterDeinitingNC_1<T>(_ t: consuming OuterDeinitingNC_1<T>) {
 // CHECK-SAME:      ptr{{.*}} %0,
 // CHECK-SAME:      ptr %T)
 // CHECK-SAME:  {
-// CHECK:         [[RESPONSE:%[^,]+]] = call{{.*}} @"$s24moveonly_value_functions26InnerDeinitingReleasableNCVMa"(
-//           :        i64 0,
-// CHECK-SAME:        ptr %T)
-// CHECK:         [[INNER_DEINITING_RELEASABLE_NC_METADATA:%[^,]+]] = extractvalue %swift.metadata_response [[RESPONSE]]
 // CHECK:         call{{.*}} @"$s24moveonly_value_functions9OuterNC_1VyxGlWOs"(
 // CHECK-SAME:        ptr %0,
-// CHECK-SAME:        ptr [[INNER_DEINITING_RELEASABLE_NC_METADATA]])
+// CHECK-SAME:        ptr %T)
 // CHECK:       }
 
 // Verify that the outlined release function takes the metadata for the
@@ -113,12 +138,16 @@ public func takeOuterDeinitingNC_1<T>(_ t: consuming OuterDeinitingNC_1<T>) {
 // $s24moveonly_value_functions9OuterNC_1VyxGlWOs ---> outlined release of moveonly_value_functions.OuterNC_2<A>
 // CHECK-LABEL: define{{.*}} @"$s24moveonly_value_functions9OuterNC_1VyxGlWOs"(
 // CHECK-SAME:      ptr %0,
-// CHECK-SAME:      ptr %"InnerDeinitingReleasableNC<T>")
+// CHECK-SAME:      ptr %T)
 // CHECK-SAME:  {
 //                ...
 //                ...
+// CHECK:         [[RESPONSE:%[^,]+]] = call{{.*}} @"$s24moveonly_value_functions26InnerDeinitingReleasableNCVMa"(
+//           :        i64 0,
+// CHECK-SAME:        ptr %T)
+// CHECK:         [[INNER_DEINITING_RELEASABLE_NC_METADATA:%[^,]+]] = extractvalue %swift.metadata_response [[RESPONSE]]
 // CHECK:         call swiftcc void @"$s24moveonly_value_functions26InnerDeinitingReleasableNCVfD"(
-// CHECK-SAME:        ptr %"InnerDeinitingReleasableNC<T>",
+// CHECK-SAME:        ptr [[INNER_DEINITING_RELEASABLE_NC_METADATA]],
 //           :        ptr noalias nocapture swiftself dereferenceable(64) %deinit.arg)
 // CHECK:       }
 public func takeOuterNC_1<T>(_ o: consuming OuterNC_1<T>) {
@@ -137,15 +166,9 @@ public func takeOuterNC_1<T>(_ o: consuming OuterNC_1<T>) {
 // CHECK-SAME:      ptr{{.*}} %0,
 // CHECK-SAME:      ptr %T)
 // CHECK-SAME:  {
-// CHECK:         [[RESPONSE:%[^,]+]] = call{{.*}} @"$s24moveonly_value_functions28InnerDeinitingDestructableNCVMa"(
-// CHECK-SAME:        [[INT]] 0,
-// CHECK-SAME:        ptr %T)
-// CHECK:         [[INNER_DEINITING_DESTRUCTABLE_NC_METADATA:%[^,]+]] = extractvalue %swift.metadata_response [[RESPONSE]]
 // CHECK:         call{{.*}} @"$s24moveonly_value_functions9OuterNC_2VyxGlWOh"(
 // CHECK-SAME:        ptr %0,
-// CHECK-SAME:        ptr %T,
-// CHECK-SAME:        ptr [[INNER_DEINITING_DESTRUCTABLE_NC_METADATA]],
-//           :        ptr %4)
+// CHECK-SAME:        ptr %T)
 // CHECK:       }
 
 // Verify that the outlined destroy function takes the metadata for the
@@ -154,16 +177,44 @@ public func takeOuterNC_1<T>(_ o: consuming OuterNC_1<T>) {
 // $s24moveonly_value_functions9OuterNC_2VyxGlWOh ---> outlined destroy of moveonly_value_functions.OuterNC_2<A>
 // CHECK-LABEL: define{{.*}} @"$s24moveonly_value_functions9OuterNC_2VyxGlWOh"(
 // CHECK-SAME:      ptr %0, 
-// CHECK-SAME:      ptr %T, 
-// CHECK-SAME:      ptr %"InnerDeinitingDestructableNC<T>", 
-// CHECK-SAME:      ptr %"OuterNC_2<T>")
+// CHECK-SAME:      ptr %T)
 // CHECK-SAME:  {
 //                ...
 //                ...
+// CHECK:         [[RESPONSE:%[^,]+]] = call{{.*}} @"$s24moveonly_value_functions28InnerDeinitingDestructableNCVMa"(
+//           :        [[INT]] 0,
+// CHECK-SAME:        ptr %T)
+// CHECK:         [[INNER_DEINITING_DESTRUCTABLE_NC_METADATA:%[^,]+]] = extractvalue %swift.metadata_response [[RESPONSE]]
 // CHECK:         call{{.*}} @"$s24moveonly_value_functions28InnerDeinitingDestructableNCVfD"(
-// CHECK-SAME:        ptr %"InnerDeinitingDestructableNC<T>", 
+// CHECK-SAME:        ptr [[INNER_DEINITING_DESTRUCTABLE_NC_METADATA]], 
 //           :        ptr noalias swiftself %3)
 // CHECK:       }
 public func takeOuterNC_2<T>(_ o: consuming OuterNC_2<T>) {
   external_symbol()
 }
+
+// CHECK-LABEL: define{{.*}} @"$s24moveonly_value_functions29takeGenericContext_1OuterNC_1yyAA0eF2_1VA2A1PRzlE0gH2_1Vyx_GnAaERzlF"(
+// CHECK-SAME:      ptr noalias %0, 
+// CHECK-SAME:      ptr %T, 
+// CHECK-SAME:      ptr %T.P)
+// CHECK-SAME:  {
+// CHECK:         call ptr @"$s24moveonly_value_functions16GenericContext_1VA2A1PRzlE9OuterNC_1Vyx_GAaDRzlWOh"(
+// CHECK-SAME:        ptr %0, 
+// CHECK-SAME:        ptr %T, 
+// CHECK-SAME:        ptr %T.P)
+// CHECK:       }
+// CHECK-LABEL: define{{.*}} @"$s24moveonly_value_functions16GenericContext_1VA2A1PRzlE9OuterNC_1Vyx_GAaDRzlWOh"(
+// CHECK-SAME:      ptr %0, 
+// CHECK-SAME:      ptr %T, 
+// CHECK-SAME:      ptr %T.P)
+// CHECK-SAME:  {
+// CHECK:         [[RESPONSE:%[^,]+]] = call{{.*}} @"$s24moveonly_value_functions16GenericContext_1VA2A1PRzlE9Inner_NC1VMa"(
+//           :        i64 0, 
+// CHECK-SAME:        ptr %T, 
+// CHECK-SAME:        ptr %T.P)
+// CHECK:         [[GENERIC_CONTEXT_1_INNER_NC_1_METADATA:%[^,]+]] = extractvalue %swift.metadata_response [[RESPONSE]], 0
+// CHECK:         call swiftcc void @"$s24moveonly_value_functions16GenericContext_1VA2A1PRzlE9Inner_NC1VfD"(
+// CHECK-SAME:        ptr [[GENERIC_CONTEXT_1_INNER_NC_1_METADATA]], 
+// CHECK-SAME:        ptr noalias swiftself %0)
+// CHECK:       }
+public func takeGenericContext_1OuterNC_1<T : P>(_ e: consuming GenericContext_1<T>.OuterNC_1) {}