AST: Add a new overload of getContextSubstitutionMap()

slavapestov · slavapestov · commit 977b444eb336 · 2024-07-10T13:28:26.000-04:00
diff --git a/include/swift/AST/Types.h b/include/swift/AST/Types.h
@@ -1289,26 +1289,22 @@ class alignas(1 << TypeAlignInBits) TypeBase
   /// Otherwise, it returns the type itself.
   Type getReferenceStorageReferent();
 
-  /// Determine the set of substitutions that should be applied to a
-  /// type spelled within the given DeclContext to treat it as a
-  /// member of this type.
+  /// Assumes this is a nominal type. Returns a substitution map that sends each
+  /// generic parameter of the declaration's generic signature to the corresponding
+  /// generic argument of this nominal type.
   ///
-  /// For example, given:
-  /// \code
-  /// struct X<T, U> { }
-  /// extension X {
-  ///   typealias SomeArray = [T]
-  /// }
-  /// \endcode
+  /// Eg: Array<Int> ---> { Element := Int }
+  SubstitutionMap getContextSubstitutionMap();
+
+  /// More general form of the above that handles additional cases:
   ///
-  /// Asking for the member substitutions of \c X<Int,String> within
-  /// the context of the extension above will produce substitutions T
-  /// -> Int and U -> String suitable for mapping the type of
-  /// \c SomeArray.
+  /// 1) dc is the nominal type itself or an unconstrained extension
+  /// 2) dc is a superclass
+  /// 3) dc is a protocol
   ///
-  /// \param genericEnv If non-null and the type is nested inside of a
-  /// generic function, generic parameters of the outer context are
-  /// mapped to context archetypes of this generic environment.
+  /// In Case 2) and 3), the substitution map has the generic signature of the dc,
+  /// and not the nominal. In Case 1), this is the same as the no-argument overload
+  /// of getContextSubstitutionMap().
   SubstitutionMap getContextSubstitutionMap(const DeclContext *dc,
                                             GenericEnvironment *genericEnv=nullptr);
 
diff --git a/include/swift/SILOptimizer/OptimizerBridgingImpl.h b/include/swift/SILOptimizer/OptimizerBridgingImpl.h
@@ -415,8 +415,7 @@ void BridgedPassContext::loadFunction(BridgedFunction function, bool loadCallees
 
 BridgedSubstitutionMap BridgedPassContext::getContextSubstitutionMap(BridgedType type) const {
   swift::SILType ty = type.unbridged();
-  auto *ntd = ty.getASTType()->getAnyNominal();
-  return ty.getASTType()->getContextSubstitutionMap(ntd);
+  return ty.getASTType()->getContextSubstitutionMap();
 }
 
 BridgedType BridgedPassContext::getBuiltinIntegerType(SwiftInt bitWidth) const {
diff --git a/lib/AST/ASTMangler.cpp b/lib/AST/ASTMangler.cpp
@@ -1976,10 +1976,9 @@ void ASTMangler::appendRetroactiveConformances(Type type, GenericSignature sig)
     if (type->hasUnboundGenericType())
       return;
 
-    auto nominal = type->getAnyNominal();
-    if (!nominal) return;
+    if (!type->getAnyNominal()) return;
 
-    subMap = type->getContextSubstitutionMap(nominal);
+    subMap = type->getContextSubstitutionMap();
   }
 
   appendRetroactiveConformances(subMap, sig);
diff --git a/lib/AST/Type.cpp b/lib/AST/Type.cpp
@@ -3043,8 +3043,7 @@ getForeignRepresentable(Type type, ForeignLanguage language,
       auto specialized = type->getASTContext()
         .getSpecializedConformance(type,
              cast<NormalProtocolConformance>(result.getConformance()),
-             boundGenericType->getContextSubstitutionMap(
-                                                 boundGenericType->getDecl()));
+             boundGenericType->getContextSubstitutionMap());
       result = ForeignRepresentationInfo::forBridged(specialized);
     }
   }
diff --git a/lib/AST/TypeSubstitution.cpp b/lib/AST/TypeSubstitution.cpp
@@ -805,6 +805,10 @@ TypeBase::getContextSubstitutions(const DeclContext *dc,
   return substitutions;
 }
 
+SubstitutionMap TypeBase::getContextSubstitutionMap() {
+  return getContextSubstitutionMap(getAnyNominal(), nullptr);
+}
+
 SubstitutionMap TypeBase::getContextSubstitutionMap(
     const DeclContext *dc,
     GenericEnvironment *genericEnv) {
diff --git a/lib/IRGen/Fulfillment.cpp b/lib/IRGen/Fulfillment.cpp
@@ -361,7 +361,7 @@ bool FulfillmentMap::searchNominalTypeMetadata(IRGenModule &IGM,
 
   bool hadFulfillment = false;
 
-  auto subs = type->getContextSubstitutionMap(nominal);
+  auto subs = type->getContextSubstitutionMap();
 
   GenericTypeRequirements requirements(IGM, nominal);
 
diff --git a/lib/IRGen/GenMeta.cpp b/lib/IRGen/GenMeta.cpp
@@ -4929,7 +4929,7 @@ namespace {
     }
 
     SubstitutionMap genericSubstitutions() {
-      return type->getContextSubstitutionMap(type->getAnyNominal());
+      return type->getContextSubstitutionMap();
     }
 
     MetadataTrailingFlags getTrailingFlags() {
diff --git a/lib/IRGen/GenProto.cpp b/lib/IRGen/GenProto.cpp
@@ -2991,7 +2991,7 @@ MetadataResponse MetadataPath::followComponent(IRGenFunction &IGF,
     GenericTypeRequirements requirements(IGF.IGM, nominal);
     auto &requirement = requirements.getRequirements()[reqtIndex];
 
-    auto subs = sourceKey.Type->getContextSubstitutionMap(nominal);
+    auto subs = type->getContextSubstitutionMap();
     auto sub = requirement.getTypeParameter().subst(subs)->getCanonicalType();
 
     // In either case, we need to change the type.
diff --git a/lib/IRGen/GenRecord.h b/lib/IRGen/GenRecord.h
@@ -209,7 +209,7 @@ class RecordTypeInfoImpl : public Base,
       if (auto likeType = rawLayout->getResolvedScalarLikeType(structDecl)) {
         if (rawLayout->shouldMoveAsLikeType()) {
           auto astT = T.getASTType();
-          auto subs = astT->getContextSubstitutionMap(structDecl);
+          auto subs = astT->getContextSubstitutionMap();
           auto loweredLikeType = IGF.IGM.getLoweredType(likeType->subst(subs));
           auto &likeTypeInfo = IGF.IGM.getTypeInfo(loweredLikeType);
 
@@ -286,7 +286,7 @@ class RecordTypeInfoImpl : public Base,
       if (auto likeType = rawLayout->getResolvedScalarLikeType(structDecl)) {
         if (rawLayout->shouldMoveAsLikeType()) {
           auto astT = T.getASTType();
-          auto subs = astT->getContextSubstitutionMap(structDecl);
+          auto subs = astT->getContextSubstitutionMap();
           auto loweredLikeType = IGF.IGM.getLoweredType(likeType->subst(subs));
           auto &likeTypeInfo = IGF.IGM.getTypeInfo(loweredLikeType);
 
diff --git a/lib/IRGen/GenType.cpp b/lib/IRGen/GenType.cpp
@@ -2942,7 +2942,7 @@ static bool tryEmitDeinitCall(IRGenFunction &IGF,
          && !deinitTy->hasError()
          && "deinit should have only one parameter");
 
-  auto substitutions = ty->getContextSubstitutionMap(nominal);
+  auto substitutions = ty->getContextSubstitutionMap();
                                                      
   CalleeInfo info(deinitTy,
                   deinitTy->substGenericArgs(IGF.getSILModule(),
diff --git a/lib/IRGen/GenericArguments.h b/lib/IRGen/GenericArguments.h
@@ -64,8 +64,7 @@ struct GenericArguments {
   }
 
   void collect(IRGenFunction &IGF, CanType type) {
-    auto decl = type.getNominalOrBoundGenericNominal();
-    auto subs = type->getContextSubstitutionMap(decl);
+    auto subs = type->getContextSubstitutionMap();
     collect(IGF, subs);
   }
 
diff --git a/lib/IRGen/MetadataRequest.cpp b/lib/IRGen/MetadataRequest.cpp
@@ -870,7 +870,7 @@ bool irgen::isSpecializedNominalTypeMetadataStaticallyAddressable(
 
   // Analyze the substitution map to determine if everything can be referenced
   // statically.
-  auto substitutions = type->getContextSubstitutionMap(nominal);
+  auto substitutions = type->getContextSubstitutionMap();
 
   // If we cannot statically reference type metadata for our replacement types,
   // we cannot specialize.
@@ -2719,7 +2719,7 @@ irgen::emitCanonicalSpecializedGenericTypeMetadataAccessFunction(
   assert(!theType->hasUnboundGenericType());
 
   auto requirements = GenericTypeRequirements(IGF.IGM, nominal);
-  auto substitutions = theType->getContextSubstitutionMap(nominal);
+  auto substitutions = theType->getContextSubstitutionMap();
   for (auto requirement : requirements.getRequirements()) {
     if (requirement.isAnyWitnessTable()) {
       continue;
diff --git a/lib/IRGen/StructLayout.cpp b/lib/IRGen/StructLayout.cpp
@@ -115,7 +115,7 @@ StructLayout::StructLayout(IRGenModule &IGM, std::optional<CanType> type,
       // If our likeType is dependent, then all calls to try and lay it out will
       // be non-fixed, but in a concrete case we want a fixed layout, so try to
       // substitute it out.
-      auto subs = (*type)->getContextSubstitutionMap(decl);
+      auto subs = (*type)->getContextSubstitutionMap();
       auto loweredLikeType = IGM.getLoweredType(likeType->subst(subs));
       const TypeInfo &likeTypeInfo = IGM.getTypeInfo(loweredLikeType);
                                       
@@ -151,7 +151,7 @@ StructLayout::StructLayout(IRGenModule &IGM, std::optional<CanType> type,
       auto elementType = likeArray->first;
       unsigned count = likeArray->second;
       
-      auto subs = (*type)->getContextSubstitutionMap(decl);
+      auto subs = (*type)->getContextSubstitutionMap();
       auto loweredElementType = IGM.getLoweredType(elementType.subst(subs));
       const TypeInfo &likeTypeInfo = IGM.getTypeInfo(loweredElementType);
       
diff --git a/lib/SIL/IR/TypeLowering.cpp b/lib/SIL/IR/TypeLowering.cpp
@@ -2433,7 +2433,7 @@ namespace {
         return handleAddressOnly(structType, properties);
       }
 
-      auto subMap = structType->getContextSubstitutionMap(D);
+      auto subMap = structType->getContextSubstitutionMap();
 
       // Classify the type according to its stored properties.
       for (auto field : D->getStoredProperties()) {
@@ -2530,7 +2530,7 @@ namespace {
                                                  Expansion);
       }
 
-      auto subMap = enumType->getContextSubstitutionMap(D);
+      auto subMap = enumType->getContextSubstitutionMap();
 
       // Accumulate the properties of all direct payloads.
       for (auto elt : D->getAllElements()) {
@@ -2936,7 +2936,7 @@ bool TypeConverter::visitAggregateLeaves(
                            field, index);
       } else if (auto *decl = ty.getStructOrBoundGenericStruct()) {
         for (auto *structField : decl->getStoredProperties()) {
-          auto subMap = ty->getContextSubstitutionMap(decl);
+          auto subMap = ty->getContextSubstitutionMap();
           auto substFieldTy =
               structField->getInterfaceType().subst(subMap)->getCanonicalType();
           auto sig =
@@ -2950,7 +2950,7 @@ bool TypeConverter::visitAggregateLeaves(
                              std::nullopt);
         }
       } else if (auto *decl = ty.getEnumOrBoundGenericEnum()) {
-        auto subMap = ty->getContextSubstitutionMap(decl);
+        auto subMap = ty->getContextSubstitutionMap();
         for (auto *element : decl->getAllElements()) {
           if (!element->hasAssociatedValues())
             continue;
@@ -5063,8 +5063,7 @@ CanSILBoxType TypeConverter::getBoxTypeForEnumElement(
                                /*captures generics*/ false);
 
   // Instantiate the layout with enum's substitution list.
-  auto subMap = boundEnum->getContextSubstitutionMap(
-      enumDecl, enumDecl->getGenericEnvironment());
+  auto subMap = boundEnum->getContextSubstitutionMap();
 
   auto boxTy = SILBoxType::get(C, layout, subMap);
   return boxTy;
diff --git a/lib/SILGen/SILGenApply.cpp b/lib/SILGen/SILGenApply.cpp
@@ -6622,7 +6622,7 @@ SILGenFunction::emitUninitializedArrayAllocation(Type ArrayTy,
   auto allocate = Ctx.getAllocateUninitializedArray();
 
   // Invoke the intrinsic, which returns a tuple.
-  auto subMap = ArrayTy->getContextSubstitutionMap(Ctx.getArrayDecl());
+  auto subMap = ArrayTy->getContextSubstitutionMap();
   auto result = emitApplyOfLibraryIntrinsic(
       Loc, allocate, subMap,
       ManagedValue::forObjectRValueWithoutOwnership(Length), SGFContext());
@@ -6647,7 +6647,7 @@ void SILGenFunction::emitUninitializedArrayDeallocation(SILLocation loc,
   CanType arrayTy = array->getType().getASTType();
 
   // Invoke the intrinsic.
-  auto subMap = arrayTy->getContextSubstitutionMap(Ctx.getArrayDecl());
+  auto subMap = arrayTy->getContextSubstitutionMap();
   emitApplyOfLibraryIntrinsic(loc, deallocate, subMap,
                               ManagedValue::forUnmanagedOwnedValue(array),
                               SGFContext());
@@ -6670,7 +6670,7 @@ ManagedValue SILGenFunction::emitUninitializedArrayFinalization(SILLocation loc,
   CanType arrayTy = arrayVal->getType().getASTType();
 
   // Invoke the intrinsic.
-  auto subMap = arrayTy->getContextSubstitutionMap(Ctx.getArrayDecl());
+  auto subMap = arrayTy->getContextSubstitutionMap();
   RValue result = emitApplyOfLibraryIntrinsic(
       loc, finalize, subMap, ManagedValue::forUnmanagedOwnedValue(arrayVal),
       SGFContext());
diff --git a/lib/SILGen/SILGenConcurrency.cpp b/lib/SILGen/SILGenConcurrency.cpp
@@ -257,7 +257,7 @@ SILGenFunction::emitLoadOfGlobalActorShared(SILLocation loc, CanType actorType)
   VarDecl *sharedInstanceDecl = nominal->getGlobalActorInstance();
   assert(sharedInstanceDecl && "no shared actor field in global actor");
   SubstitutionMap subs =
-    actorType->getContextSubstitutionMap(nominal);
+    actorType->getContextSubstitutionMap();
   Type instanceType =
     actorType->getTypeOfMember(sharedInstanceDecl);
 
diff --git a/lib/SILGen/SILGenExpr.cpp b/lib/SILGen/SILGenExpr.cpp
@@ -6355,7 +6355,7 @@ SILGenFunction::emitArrayToPointer(SILLocation loc, ManagedValue array,
 
   // Invoke the conversion intrinsic, which will produce an owner-pointer pair.
   auto firstSubMap =
-      accessInfo.ArrayType->getContextSubstitutionMap(ctx.getArrayDecl());
+      accessInfo.ArrayType->getContextSubstitutionMap();
   auto secondSubMap = accessInfo.PointerType->getContextSubstitutionMap(
       getPointerProtocol());
 
diff --git a/lib/SILGen/SILGenLValue.cpp b/lib/SILGen/SILGenLValue.cpp
@@ -2406,8 +2406,7 @@ namespace {
       }
 
       auto keyPathTy = keyPathValue.getType().castTo<BoundGenericType>();
-      auto subs = keyPathTy->getContextSubstitutionMap(
-          keyPathTy->getDecl());
+      auto subs = keyPathTy->getContextSubstitutionMap();
 
       auto origType = AbstractionPattern::getOpaque();
       auto loweredTy = SGF.getLoweredType(origType, value.getSubstRValueType());
@@ -2481,8 +2480,7 @@ namespace {
       auto projectFnType = projectFn->getLoweredFunctionType();
 
       auto keyPathTy = keyPathValue.getType().castTo<BoundGenericType>();
-      auto subs = keyPathTy->getContextSubstitutionMap(
-          keyPathTy->getDecl());
+      auto subs = keyPathTy->getContextSubstitutionMap();
 
       auto substFnType = projectFnType->substGenericArgs(
           SGF.SGM.M, subs, SGF.getTypeExpansionContext());
diff --git a/lib/SILGen/SILGenLazyConformance.cpp b/lib/SILGen/SILGenLazyConformance.cpp
@@ -113,7 +113,7 @@ void SILGenModule::useConformancesFromType(CanType type) {
     if (!genericSig)
       return;
 
-    auto subMap = t->getContextSubstitutionMap(decl);
+    auto subMap = t->getContextSubstitutionMap();
     useConformancesFromSubstitutions(subMap);
     return;
   });
diff --git a/lib/SILOptimizer/Mandatory/OSLogOptimization.cpp b/lib/SILOptimizer/Mandatory/OSLogOptimization.cpp
@@ -518,8 +518,7 @@ static SILValue emitCodeForConstantArray(ArrayRef<SILValue> elements,
   // call returns a two-element tuple, where the first element is the newly
   // created array and the second element is a pointer to the internal storage
   // of the array.
-  SubstitutionMap subMap = arrayType->getContextSubstitutionMap(
-      astContext.getArrayDecl());
+  SubstitutionMap subMap = arrayType->getContextSubstitutionMap();
   FunctionRefInst *arrayAllocateRef =
       builder.createFunctionRef(loc, arrayAllocateFun);
   ApplyInst *applyInst = builder.createApply(
diff --git a/lib/SILOptimizer/Transforms/ArrayElementValuePropagation.cpp b/lib/SILOptimizer/Transforms/ArrayElementValuePropagation.cpp
@@ -325,9 +325,8 @@ bool ArrayAllocation::replaceAppendContentOf() {
       continue;
 
     SILType ArrayType = ArrayValue->getType();
-    auto *NTD = ArrayType.getASTType()->getAnyNominal();
     SubstitutionMap ArraySubMap = ArrayType.getASTType()
-      ->getContextSubstitutionMap(NTD);
+      ->getContextSubstitutionMap();
 
     AppendContentsOf.replaceByAppendingValues(AppendFn, ReserveFn,
                                               ElementValueVector,
diff --git a/lib/SILOptimizer/Transforms/VTableSpecializer.cpp b/lib/SILOptimizer/Transforms/VTableSpecializer.cpp
@@ -173,7 +173,7 @@ SILVTable *swift::specializeVTableForType(SILType classTy, SILModule &module,
     return nullptr;
   }
 
-  SubstitutionMap subs = astType->getContextSubstitutionMap(classDecl);
+  SubstitutionMap subs = astType->getContextSubstitutionMap();
 
   llvm::SmallVector<SILVTableEntry, 8> newEntries;
 
@@ -247,8 +247,7 @@ bool swift::specializeClassMethodInst(ClassMethodInst *cm) {
   BoundGenericClassType *genClassTy = dyn_cast<BoundGenericClassType>(astType);
   if (!genClassTy) return false;
 
-  ClassDecl *classDecl = genClassTy->getDecl();
-  SubstitutionMap subs = astType->getContextSubstitutionMap(classDecl);
+  SubstitutionMap subs = astType->getContextSubstitutionMap();
 
   SILType funcTy = cm->getType();
   SILType substitutedType =
diff --git a/lib/Sema/TypeCheckAttr.cpp b/lib/Sema/TypeCheckAttr.cpp
@@ -3778,8 +3778,6 @@ TypeEraserHasViableInitRequest::evaluate(Evaluator &evaluator,
 
   // The type eraser must be a concrete nominal type
   auto nominalTypeDecl = typeEraser->getAnyNominal();
-  if (auto typeAliasDecl = dyn_cast_or_null<TypeAliasDecl>(nominalTypeDecl))
-    nominalTypeDecl = typeAliasDecl->getUnderlyingType()->getAnyNominal();
 
   if (!nominalTypeDecl || isa<ProtocolDecl>(nominalTypeDecl)) {
     diags.diagnose(attr->getLoc(), diag::non_nominal_type_eraser);
@@ -3841,7 +3839,7 @@ TypeEraserHasViableInitRequest::evaluate(Evaluator &evaluator,
     // substituting the protocol's Self type for the generic arg and check that
     // the requirements in the generic signature are satisfied.
     auto baseMap =
-        typeEraser->getContextSubstitutionMap(nominalTypeDecl);
+        typeEraser->getContextSubstitutionMap();
     QuerySubstitutionMap getSubstitution{baseMap};
 
     auto result = checkRequirements(
diff --git a/lib/Sema/TypeCheckAvailability.cpp b/lib/Sema/TypeCheckAvailability.cpp
@@ -4235,15 +4235,15 @@ class ProblematicTypeFinder : public TypeDeclFinder {
     if (isa<ProtocolType>(ty))
       return Action::Continue;
 
-    auto subs = ty->getContextSubstitutionMap(ty->getDecl());
+    auto subs = ty->getContextSubstitutionMap();
     (void) diagnoseSubstitutionMapAvailability(Loc, subs, Where);
     return Action::Continue;
   }
 
   Action visitBoundGenericType(BoundGenericType *ty) override {
     visitTypeDecl(ty->getDecl());
 
-    auto subs = ty->getContextSubstitutionMap(ty->getDecl());
+    auto subs = ty->getContextSubstitutionMap();
     (void)diagnoseSubstitutionMapAvailability(
         Loc, subs, Where,
         /*depTy=*/Type(),
diff --git a/lib/Sema/TypeCheckCircularity.cpp b/lib/Sema/TypeCheckCircularity.cpp
@@ -249,7 +249,7 @@ bool CircularityChecker::expandStruct(CanType type, StructDecl *S,
                                       unsigned depth) {
   startExpandingType(type);
 
-  auto subMap = type->getContextSubstitutionMap(S);
+  auto subMap = type->getContextSubstitutionMap();
 
   for (auto field: S->getStoredProperties()) {
     auto fieldType =field->getValueInterfaceType().subst(subMap);
@@ -272,7 +272,7 @@ bool CircularityChecker::expandEnum(CanType type, EnumDecl *E,
 
   startExpandingType(type);
 
-  auto subMap = type->getContextSubstitutionMap(E);
+  auto subMap = type->getContextSubstitutionMap();
 
   for (auto elt: E->getAllElements()) {
     // Indirect elements are representational leaves.

Original file line number	Diff line number	Diff line change
`@@ -415,8 +415,7 @@ void BridgedPassContext::loadFunction(BridgedFunction function, bool loadCallees`
`415`	`415`
`416`	`416`	`BridgedSubstitutionMap BridgedPassContext::getContextSubstitutionMap(BridgedType type) const {`
`417`	`417`	`swift::SILType ty = type.unbridged();`
`418`		`- auto *ntd = ty.getASTType()->getAnyNominal();`
`419`		`- return ty.getASTType()->getContextSubstitutionMap(ntd);`
	`418`	`+ return ty.getASTType()->getContextSubstitutionMap();`
`420`	`419`	`}`
`421`	`420`
`422`	`421`	`BridgedType BridgedPassContext::getBuiltinIntegerType(SwiftInt bitWidth) const {`
Original file line number	Diff line number	Diff line change
`@@ -3043,8 +3043,7 @@ getForeignRepresentable(Type type, ForeignLanguage language,`
`3043`	`3043`	`auto specialized = type->getASTContext()`
`3044`	`3044`	`.getSpecializedConformance(type,`
`3045`	`3045`	`cast<NormalProtocolConformance>(result.getConformance()),`
`3046`		`- boundGenericType->getContextSubstitutionMap(`
`3047`		`- boundGenericType->getDecl()));`
	`3046`	`+ boundGenericType->getContextSubstitutionMap());`
`3048`	`3047`	`result = ForeignRepresentationInfo::forBridged(specialized);`
`3049`	`3048`	`}`
`3050`	`3049`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4929,7 +4929,7 @@ namespace {`
`4929`	`4929`	`}`
`4930`	`4930`
`4931`	`4931`	`SubstitutionMap genericSubstitutions() {`
`4932`		`- return type->getContextSubstitutionMap(type->getAnyNominal());`
	`4932`	`+ return type->getContextSubstitutionMap();`
`4933`	`4933`	`}`
`4934`	`4934`
`4935`	`4935`	`MetadataTrailingFlags getTrailingFlags() {`