Merge pull request #42328 from rjmccall/build-constrained-existential-metadata-5.7

[5.7] IR generation for constrained existentials

Author: rjmccall

docs/ABI/Mangling.rst

@@ -189,6 +189,8 @@ Globals
   global ::= global 'MN'                 // noncanonical specialized generic type metadata for global
   global ::= global 'Mz'                 // canonical specialized generic type metadata caching token
 
+  global ::= global 'Mq'                 // global with a uniquing prefix
+
   #if SWIFT_RUNTIME_VERSION >= 5.4
     global ::= context (decl-name '_')+ 'WZ' // global variable one-time initialization function
     global ::= context (decl-name '_')+ 'Wz' // global variable one-time initialization token
@@ -914,6 +916,23 @@ than the module of the conforming type or the conformed-to protocol), it is
 mangled with its offset into the set of conformance requirements, the
 root protocol conformance, and the suffix 'g'.
 
+::
+
+  // No generalization signature, no type expression.
+  extended-existential-shape ::= generic-signature 'Xg' extended-existential-value-storage
+
+  // Generalization signature (the second one), no type expression.
+  extended-existential-shape ::= generic-signature generic-signature 'XG' extended-existential-value-storage
+
+  // No generalization signature, type expression.
+  extended-existential-shape ::= generic-signature type 'Xh' extended-existential-value-storage
+
+  // Generalization signature (the second one), type expression.
+  extended-existential-shape ::= generic-signature generic-signature type 'Xh' extended-existential-value-storage
+
+  extended-existential-value-storage ::= 'o' // opaque
+  extended-existential-value-storage ::= 'c' // class
+  extended-existential-value-storage ::= 'm' // metatype
 
 Identifiers
 ~~~~~~~~~~~

include/swift/ABI/MetadataValues.h

@@ -865,7 +865,7 @@ class ExtendedExistentialTypeShapeFlags {
       (Data & ~SpecialKindMask) | (int_type(kind) << SpecialKindShift));
   }
   constexpr ExtendedExistentialTypeShapeFlags
-  withHasTypeExpresssion(bool hasTypeExpression) const {
+  withHasTypeExpression(bool hasTypeExpression) const {
     return ExtendedExistentialTypeShapeFlags(
       hasTypeExpression ? (Data | HasTypeExpression)
                         : (Data & ~HasTypeExpression));

include/swift/AST/ExistentialLayout.h

@@ -19,7 +19,7 @@
 
 #include "swift/Basic/ArrayRefView.h"
 #include "swift/AST/ASTContext.h"
-#include "swift/AST/Type.h"
+#include "swift/AST/Types.h"
 
 namespace swift {
   class ProtocolDecl;
@@ -32,12 +32,12 @@ struct ExistentialLayout {
   ExistentialLayout() {
     hasExplicitAnyObject = false;
     containsNonObjCProtocol = false;
-    singleProtocol = nullptr;
+    containsParameterized = false;
   }
 
-  ExistentialLayout(ProtocolType *type);
-  ExistentialLayout(ProtocolCompositionType *type);
-  ExistentialLayout(ParameterizedProtocolType *type);
+  ExistentialLayout(CanProtocolType type);
+  ExistentialLayout(CanProtocolCompositionType type);
+  ExistentialLayout(CanParameterizedProtocolType type);
 
   /// The explicit superclass constraint, if any.
   Type explicitSuperclass;
@@ -48,6 +48,9 @@ struct ExistentialLayout {
   /// Whether any protocol members are non-@objc.
   bool containsNonObjCProtocol : 1;
 
+  /// Whether any protocol members are parameterized.s
+  bool containsParameterized : 1;
+
   /// Return the kind of this existential (class/error/opaque).
   Kind getKind() {
     if (requiresClass())
@@ -87,28 +90,17 @@ struct ExistentialLayout {
   /// constraints?
   bool isErrorExistential() const;
 
-  static inline ProtocolType *getProtocolType(const Type &Ty) {
-    return cast<ProtocolType>(Ty.getPointer());
-  }
-  typedef ArrayRefView<Type,ProtocolType*,getProtocolType> ProtocolTypeArrayRef;
-
-  ProtocolTypeArrayRef getProtocols() const & {
-    if (singleProtocol)
-      return llvm::makeArrayRef(&singleProtocol, 1);
+  ArrayRef<ProtocolDecl*> getProtocols() const & {
     return protocols;
   }
-  /// The returned ArrayRef may point directly to \c this->singleProtocol, so
+  /// The returned ArrayRef points to internal storage, so
   /// calling this on a temporary is likely to be incorrect.
-  ProtocolTypeArrayRef getProtocols() const && = delete;
+  ArrayRef<ProtocolDecl*> getProtocols() const && = delete;
 
   LayoutConstraint getLayoutConstraint() const;
 
 private:
-  // The protocol from a ProtocolType
-  Type singleProtocol;
-
-  /// Zero or more protocol constraints from a ProtocolCompositionType
-  ArrayRef<Type> protocols;
+  SmallVector<ProtocolDecl *, 4> protocols;
 
   /// Zero or more primary associated type requirements from a
   /// ParameterizedProtocolType

include/swift/AST/IRGenOptions.h

@@ -189,6 +189,12 @@ struct PointerAuthOptions : clang::PointerAuthOptions {
 
   /// The swift async context entry in the extended frame info.
   PointerAuthSchema AsyncContextExtendedFrameEntry;
+
+  /// Extended existential type shapes in flight.
+  PointerAuthSchema ExtendedExistentialTypeShape;
+
+  /// Non-unique extended existential type shapes in flight.
+  PointerAuthSchema NonUniqueExtendedExistentialTypeShape;
 };
 
 enum class JITDebugArtifact : unsigned {

include/swift/AST/Types.h

@@ -2768,6 +2768,7 @@ BEGIN_CAN_TYPE_WRAPPER(ExistentialMetatypeType, AnyMetatypeType)
                                         MetatypeRepresentation repr) {
     return CanExistentialMetatypeType(ExistentialMetatypeType::get(type, repr));
   }
+  PROXY_CAN_TYPE_SIMPLE_GETTER(getExistentialInstanceType)
 END_CAN_TYPE_WRAPPER(ExistentialMetatypeType, AnyMetatypeType)
 
 /// ModuleType - This is the type given to a module value, e.g. the "Builtin" in
@@ -5254,6 +5255,9 @@ class ProtocolCompositionType final : public TypeBase,
   }
 };
 BEGIN_CAN_TYPE_WRAPPER(ProtocolCompositionType, Type)
+  CanTypeArrayRef getMembers() const {
+    return CanTypeArrayRef(getPointer()->getMembers());
+  }
 END_CAN_TYPE_WRAPPER(ProtocolCompositionType, Type)
 
 /// ParameterizedProtocolType - A type that constrains one or more primary
@@ -5291,11 +5295,19 @@ class ParameterizedProtocolType final : public TypeBase,
     return Base;
   }
 
+  ProtocolDecl *getProtocol() const {
+    return Base->getDecl();
+  }
+
   ArrayRef<Type> getArgs() const {
     return {getTrailingObjects<Type>(),
             Bits.ParameterizedProtocolType.ArgCount};
   }
 
+  bool requiresClass() const {
+    return getBaseType()->requiresClass();
+  }
+
   void getRequirements(Type baseType, SmallVectorImpl<Requirement> &reqs) const;
 
   void Profile(llvm::FoldingSetNodeID &ID) {
@@ -5317,12 +5329,36 @@ class ParameterizedProtocolType final : public TypeBase,
                             RecursiveTypeProperties properties);
 };
 BEGIN_CAN_TYPE_WRAPPER(ParameterizedProtocolType, Type)
-  PROXY_CAN_TYPE_SIMPLE_GETTER(getBaseType)
+  CanProtocolType getBaseType() const {
+    return CanProtocolType(getPointer()->getBaseType());
+  }
   CanTypeArrayRef getArgs() const {
     return CanTypeArrayRef(getPointer()->getArgs());
   }
 END_CAN_TYPE_WRAPPER(ParameterizedProtocolType, Type)
 
+/// The generalized shape of an existential type.
+struct ExistentialTypeGeneralization {
+  /// The generalized existential type.  May refer to type parameters
+  /// from the generalization signature.
+  Type Shape;
+
+  /// The generalization signature and substitutions.
+  SubstitutionMap Generalization;
+
+  /// Retrieve the generalization for the given existential type.
+  ///
+  /// Substituting the generalization substitutions into the shape
+  /// should produce the original existential type.
+  ///
+  /// If there is a generic type substitution which can turn existential
+  /// type A into existential type B, then:
+  /// - the generalized shape types of A and B must be equal and
+  /// - the generic signatures of the generalization substitutions of
+  ///   A and B must be equal.
+  static ExistentialTypeGeneralization get(Type existentialType);
+};
+
 /// An existential type, spelled with \c any .
 ///
 /// In Swift 5 mode, a plain protocol name in type
@@ -5348,6 +5384,9 @@ class ExistentialType final : public TypeBase {
     if (auto composition = ConstraintType->getAs<ProtocolCompositionType>())
       return composition->requiresClass();
 
+    if (auto paramProtocol = ConstraintType->getAs<ParameterizedProtocolType>())
+      return paramProtocol->requiresClass();
+
     return false;
   }
 

include/swift/Demangling/DemangleNodes.def

@@ -335,6 +335,9 @@ NODE(CompileTimeConst)
 NODE(OpaqueReturnTypeIndexed)
 NODE(BackDeploymentThunk)
 NODE(BackDeploymentFallback)
+NODE(ExtendedExistentialTypeShape)
+NODE(ExtendedExistentialValueStorage)
+NODE(Uniquable)
 
 #undef CONTEXT_NODE
 #undef NODE

include/swift/Demangling/Demangler.h

@@ -529,6 +529,7 @@ class Demangler : public NodeFactory {
   NodePointer demangleArchetype();
   NodePointer demangleAssociatedTypeSimple(NodePointer GenericParamIdx);
   NodePointer demangleAssociatedTypeCompound(NodePointer GenericParamIdx);
+  NodePointer demangleExtendedExistentialShape(char kind);
 
   NodePointer popAssocTypeName();
   NodePointer popAssocTypePath();

include/swift/IRGen/Linking.h

@@ -119,6 +119,16 @@ class LinkEntity {
     // This field appears in SILFunction.
     IsDynamicallyReplaceableImplShift = 8,
     IsDynamicallyReplaceableImplMask = ~KindMask,
+
+    // These fields appear in ExtendedExistentialTypeShape.
+    ExtendedExistentialIsUniqueShift = 8,
+    ExtendedExistentialIsUniqueMask = 0x100,
+    ExtendedExistentialIsSharedShift = 9,
+    ExtendedExistentialIsSharedMask = 0x200,
+    ExtendedExistentialMetatypeDepthShift = 10,
+    ExtendedExistentialMetatypeDepthMask =
+      ~(KindMask | ExtendedExistentialIsUniqueMask |
+        ExtendedExistentialIsSharedMask),
   };
 #define LINKENTITY_SET_FIELD(field, value) (value << field##Shift)
 #define LINKENTITY_GET_FIELD(value, field) ((value & field##Mask) >> field##Shift)
@@ -493,6 +503,11 @@ class LinkEntity {
     /// Accessible function record, which describes a function that can be
     /// looked up by name by the runtime.
     AccessibleFunctionRecord,
+
+    /// Extended existential type shape.
+    /// Pointer is the (generalized) existential type.
+    /// SecondaryPointer is the GenericSignatureImpl*.
+    ExtendedExistentialTypeShape,
   };
   friend struct llvm::DenseMapInfo<LinkEntity>;
 
@@ -1352,6 +1367,24 @@ class LinkEntity {
     return entity;
   }
 
+  static LinkEntity forExtendedExistentialTypeShape(CanGenericSignature genSig,
+                                                    CanExistentialType
+                                                      existentialType,
+                                                    unsigned metatypeDepth,
+                                                    bool isUnique,
+                                                    bool isShared) {
+    LinkEntity entity;
+    entity.Pointer = existentialType.getPointer();
+    entity.SecondaryPointer =
+      const_cast<GenericSignatureImpl*>(genSig.getPointer());
+    entity.Data =
+        LINKENTITY_SET_FIELD(Kind, unsigned(Kind::ExtendedExistentialTypeShape))
+      | LINKENTITY_SET_FIELD(ExtendedExistentialIsUnique, unsigned(isUnique))
+      | LINKENTITY_SET_FIELD(ExtendedExistentialIsShared, unsigned(isShared))
+      | LINKENTITY_SET_FIELD(ExtendedExistentialMetatypeDepth, metatypeDepth);
+    return entity;
+  }
+
   void mangle(llvm::raw_ostream &out) const;
   void mangle(SmallVectorImpl<char> &buffer) const;
   std::string mangleAsString() const;
@@ -1445,6 +1478,32 @@ class LinkEntity {
         SecondaryPointer);
   }
 
+  CanGenericSignature getExtendedExistentialTypeShapeGenSig() const {
+    assert(getKind() == Kind::ExtendedExistentialTypeShape);
+    return CanGenericSignature(
+             reinterpret_cast<const GenericSignatureImpl*>(SecondaryPointer));
+  }
+
+  CanExistentialType getExtendedExistentialTypeShapeType() const {
+    assert(getKind() == Kind::ExtendedExistentialTypeShape);
+    return cast<ExistentialType>(CanType(reinterpret_cast<TypeBase*>(Pointer)));
+  }
+
+  bool isExtendedExistentialTypeShapeUnique() const {
+    assert(getKind() == Kind::ExtendedExistentialTypeShape);
+    return LINKENTITY_GET_FIELD(Data, ExtendedExistentialIsUnique);
+  }
+
+  bool isExtendedExistentialTypeShapeShared() const {
+    assert(getKind() == Kind::ExtendedExistentialTypeShape);
+    return LINKENTITY_GET_FIELD(Data, ExtendedExistentialIsShared);
+  }
+
+  unsigned getExtendedExistentialTypeShapeMetatypeDepth() const {
+    assert(getKind() == Kind::ExtendedExistentialTypeShape);
+    return LINKENTITY_GET_FIELD(Data, ExtendedExistentialMetatypeDepth);
+  }
+
   bool isDynamicallyReplaceable() const {
     assert(getKind() == Kind::SILFunction);
     return LINKENTITY_GET_FIELD(Data, IsDynamicallyReplaceableImpl);

include/swift/Runtime/RuntimeFunctions.def

@@ -1076,6 +1076,36 @@ FUNCTION(GetExistentialMetadata,
          ATTRS(NoUnwind, ReadOnly, WillReturn),
          EFFECT(MetaData)) // ?
 
+// const ExtendedExistentialTypeShape *
+// swift_getExtendedExistentialTypeShape(
+//             const NonUniqueExtendedExistentialTypeShape *nonUnique);
+FUNCTION(GetExtendedExistentialTypeShape,
+         swift_getExtendedExistentialTypeShape, C_CC, AlwaysAvailable,
+         RETURNS(TypeMetadataPtrTy),
+         ARGS(Int8PtrTy, Int8PtrPtrTy),
+         ATTRS(NoUnwind, ArgMemOnly, WillReturn),
+         EFFECT(MetaData)) // ?
+
+// Metadata *swift_getExtendedExistentialTypeMetadata(
+//             const NonUniqueExtendedExistentialTypeShape *shape,
+//             const void * const *generalizationArgs);
+FUNCTION(GetExtendedExistentialTypeMetadata,
+         swift_getExtendedExistentialTypeMetadata, C_CC, AlwaysAvailable,
+         RETURNS(TypeMetadataPtrTy),
+         ARGS(Int8PtrTy, Int8PtrPtrTy),
+         ATTRS(NoUnwind, ArgMemOnly, WillReturn),
+         EFFECT(MetaData)) // ?
+
+// Metadata *swift_getExtendedExistentialTypeMetadata_unique(
+//             const ExtendedExistentialTypeShape *shape,
+//             const void * const *generalizationArgs);
+FUNCTION(GetExtendedExistentialTypeMetadataUnique,
+         swift_getExtendedExistentialTypeMetadata_unique, C_CC, AlwaysAvailable,
+         RETURNS(TypeMetadataPtrTy),
+         ARGS(Int8PtrTy, Int8PtrPtrTy),
+         ATTRS(NoUnwind, ArgMemOnly, WillReturn),
+         EFFECT(MetaData)) // ?
+
 // Metadata *swift_relocateClassMetadata(TypeContextDescriptor *descriptor,
 //                                       const void *pattern);
 FUNCTION(RelocateClassMetadata,

include/swift/SIL/FormalLinkage.h

@@ -15,6 +15,7 @@
 
 namespace swift {
 
+class CanGenericSignature;
 class CanType;
 class RootProtocolConformance;
 class ValueDecl;
@@ -44,6 +45,8 @@ enum class FormalLinkage {
 
 FormalLinkage getDeclLinkage(const ValueDecl *decl);
 FormalLinkage getTypeLinkage(CanType formalType);
+FormalLinkage getTypeLinkage_correct(CanType formalType);
+FormalLinkage getGenericSignatureLinkage(CanGenericSignature signature);
 SILLinkage getSILLinkage(FormalLinkage linkage,
                          ForDefinition_t forDefinition);
 SILLinkage