[sending] Change the internals of sending to be based around 'sending' instead of 'transferring'.

We still only parse transferring... but this sets us up for adding the new
'sending' syntax by first validating that this internal change does not mess up
the current transferring impl since we want both to keep working for now.

rdar://128216574

Author: gottesmm

include/swift/ABI/MetadataValues.h

@@ -1198,7 +1198,7 @@ class TargetExtendedFunctionTypeFlags {
     IsolatedAny            = 0x00000002U,
 
     // Values if we have a transferring result.
-    HasTransferringResult  = 0x00000010U,
+    HasSendingResult  = 0x00000010U,
 
     /// A InvertibleProtocolSet in the high bits.
     InvertedProtocolshift = 16,
@@ -1228,10 +1228,10 @@ class TargetExtendedFunctionTypeFlags {
   }
 
   const TargetExtendedFunctionTypeFlags<int_type>
-  withTransferringResult(bool newValue = true) const {
+  withSendingResult(bool newValue = true) const {
     return TargetExtendedFunctionTypeFlags<int_type>(
-        (Data & ~HasTransferringResult) |
-        (newValue ? HasTransferringResult : 0));
+        (Data & ~HasSendingResult) |
+        (newValue ? HasSendingResult : 0));
   }
 
   const TargetExtendedFunctionTypeFlags<int_type>
@@ -1247,8 +1247,8 @@ class TargetExtendedFunctionTypeFlags {
     return (Data & IsolationMask) == IsolatedAny;
   }
 
-  bool hasTransferringResult() const {
-    return bool(Data & HasTransferringResult);
+  bool hasSendingResult() const {
+    return bool(Data & HasSendingResult);
   }
 
   int_type getIntValue() const {
@@ -1295,7 +1295,7 @@ class TargetParameterTypeFlags {
     AutoClosureMask       = 0x100,
     NoDerivativeMask      = 0x200,
     IsolatedMask          = 0x400,
-    TransferringMask      = 0x800,
+    SendingMask           = 0x800,
   };
   int_type Data;
 
@@ -1335,17 +1335,17 @@ class TargetParameterTypeFlags {
   }
 
   constexpr TargetParameterTypeFlags<int_type>
-  withTransferring(bool isTransferring) const {
+  withSending(bool isSending) const {
     return TargetParameterTypeFlags<int_type>(
-        (Data & ~TransferringMask) | (isTransferring ? TransferringMask : 0));
+        (Data & ~SendingMask) | (isSending ? SendingMask : 0));
   }
 
   bool isNone() const { return Data == 0; }
   bool isVariadic() const { return Data & VariadicMask; }
   bool isAutoClosure() const { return Data & AutoClosureMask; }
   bool isNoDerivative() const { return Data & NoDerivativeMask; }
   bool isIsolated() const { return Data & IsolatedMask; }
-  bool isTransferring() const { return Data & TransferringMask; }
+  bool isSending() const { return Data & SendingMask; }
 
   ParameterOwnership getOwnership() const {
     return (ParameterOwnership)(Data & OwnershipMask);

include/swift/AST/Decl.h

@@ -532,8 +532,8 @@ class alignas(1 << DeclAlignInBits) Decl : public ASTAllocated<Decl> {
     /// analysis.
     HasTopLevelLocalContextCaptures : 1,
 
-    /// Set to true if this FuncDecl has a transferring result.
-    HasTransferringResult : 1
+    /// Set to true if this FuncDecl has a 'sending' result.
+    HasSendingResult : 1
   );
 
   SWIFT_INLINE_BITFIELD(AccessorDecl, FuncDecl, 4 + 1 + 1,
@@ -6639,8 +6639,8 @@ class ParamDecl : public VarDecl {
     /// Whether or not this paramater is '_resultDependsOn'
     IsResultDependsOn = 1 << 3,
 
-    /// Whether or not this parameter is 'transferring'.
-    IsTransferring = 1 << 4,
+    /// Whether or not this parameter is 'sending'.
+    IsSending = 1 << 4,
   };
 
   /// The type repr and 3 bits used for flags.
@@ -6918,16 +6918,14 @@ class ParamDecl : public VarDecl {
       removeFlag(Flag::IsIsolated);
   }
 
-  /// Whether or not this parameter is marked with 'transferring'.
-  bool isTransferring() const {
-    return getOptions().contains(Flag::IsTransferring);
-  }
+  /// Whether or not this parameter is marked with 'sending'.
+  bool isSending() const { return getOptions().contains(Flag::IsSending); }
 
-  void setTransferring(bool value = true) {
+  void setSending(bool value = true) {
     if (value)
-      addFlag(Flag::IsTransferring);
+      addFlag(Flag::IsSending);
     else
-      removeFlag(Flag::IsTransferring);
+      removeFlag(Flag::IsSending);
   }
 
   /// Whether or not this parameter is marked with '_const'.
@@ -7966,7 +7964,7 @@ class FuncDecl : public AbstractFunctionDecl {
     Bits.FuncDecl.IsStaticComputed = false;
     Bits.FuncDecl.IsStatic = false;
     Bits.FuncDecl.HasTopLevelLocalContextCaptures = false;
-    Bits.FuncDecl.HasTransferringResult = false;
+    Bits.FuncDecl.HasSendingResult = false;
   }
 
   void setResultInterfaceType(Type type);
@@ -8119,14 +8117,12 @@ class FuncDecl : public AbstractFunctionDecl {
     Bits.FuncDecl.ForcedStaticDispatch = flag;
   }
 
-  /// Returns true if this FuncDecl has a transferring result... returns false
+  /// Returns true if this FuncDecl has a sending result... returns false
   /// otherwise.
-  bool hasTransferringResult() const {
-    return Bits.FuncDecl.HasTransferringResult;
-  }
+  bool hasSendingResult() const { return Bits.FuncDecl.HasSendingResult; }
 
-  void setTransferringResult(bool newValue = true) {
-    Bits.FuncDecl.HasTransferringResult = newValue;
+  void setSendingResult(bool newValue = true) {
+    Bits.FuncDecl.HasSendingResult = newValue;
   }
 
   static bool classof(const Decl *D) {

include/swift/AST/ExtInfo.h

@@ -438,8 +438,8 @@ class ASTExtInfoBuilder {
   // If bits are added or removed, then TypeBase::NumAFTExtInfoBits
   // and NumMaskBits must be updated, and they must match.
   //
-  //   |representation|noEscape|concurrent|async|throws|isolation|differentiability| TransferringResult |
-  //   |    0 .. 3    |    4   |    5     |  6  |   7  | 8 .. 10 |     11 .. 13    |         14         |
+  //   |representation|noEscape|concurrent|async|throws|isolation|differentiability| SendingResult |
+  //   |    0 .. 3    |    4   |    5     |  6  |   7  | 8 .. 10 |     11 .. 13    |         14    |
   //
   enum : unsigned {
     RepresentationMask = 0xF << 0,
@@ -451,7 +451,7 @@ class ASTExtInfoBuilder {
     IsolationMask = 0x7 << IsolationMaskOffset,
     DifferentiabilityMaskOffset = 11,
     DifferentiabilityMask = 0x7 << DifferentiabilityMaskOffset,
-    TransferringResultMask = 1 << 14,
+    SendingResultMask = 1 << 14,
     NumMaskBits = 15
   };
 
@@ -501,14 +501,14 @@ class ASTExtInfoBuilder {
                     Type thrownError, DifferentiabilityKind diffKind,
                     const clang::Type *type, FunctionTypeIsolation isolation,
                     LifetimeDependenceInfo lifetimeDependenceInfo,
-                    bool transferringResult)
+                    bool sendingResult)
       : ASTExtInfoBuilder(
             ((unsigned)rep) | (isNoEscape ? NoEscapeMask : 0) |
                 (throws ? ThrowsMask : 0) |
                 (((unsigned)diffKind << DifferentiabilityMaskOffset) &
                  DifferentiabilityMask) |
                 (unsigned(isolation.getKind()) << IsolationMaskOffset) |
-                (transferringResult ? TransferringResultMask : 0),
+                (sendingResult ? SendingResultMask : 0),
             ClangTypeInfo(type), isolation.getOpaqueType(), thrownError,
             lifetimeDependenceInfo) {}
 
@@ -530,9 +530,7 @@ class ASTExtInfoBuilder {
 
   constexpr bool isThrowing() const { return bits & ThrowsMask; }
 
-  constexpr bool hasTransferringResult() const {
-    return bits & TransferringResultMask;
-  }
+  constexpr bool hasSendingResult() const { return bits & SendingResultMask; }
 
   constexpr DifferentiabilityKind getDifferentiabilityKind() const {
     return DifferentiabilityKind((bits & DifferentiabilityMask) >>
@@ -644,12 +642,10 @@ class ASTExtInfoBuilder {
     return withThrows(true, Type());
   }
 
-  [[nodiscard]] ASTExtInfoBuilder
-  withTransferringResult(bool transferring = true) const {
-    return ASTExtInfoBuilder(transferring ? (bits | TransferringResultMask)
-                                          : (bits & ~TransferringResultMask),
-                             clangTypeInfo, globalActor, thrownError,
-                             lifetimeDependenceInfo);
+  [[nodiscard]] ASTExtInfoBuilder withSendingResult(bool sending = true) const {
+    return ASTExtInfoBuilder(
+        sending ? (bits | SendingResultMask) : (bits & ~SendingResultMask),
+        clangTypeInfo, globalActor, thrownError, lifetimeDependenceInfo);
   }
 
   [[nodiscard]]
@@ -765,9 +761,7 @@ class ASTExtInfo {
 
   constexpr bool isThrowing() const { return builder.isThrowing(); }
 
-  constexpr bool hasTransferringResult() const {
-    return builder.hasTransferringResult();
-  }
+  constexpr bool hasSendingResult() const { return builder.hasSendingResult(); }
 
   constexpr DifferentiabilityKind getDifferentiabilityKind() const {
     return builder.getDifferentiabilityKind();
@@ -838,9 +832,8 @@ class ASTExtInfo {
     return builder.withAsync(async).build();
   }
 
-  [[nodiscard]] ASTExtInfo
-  withTransferringResult(bool transferring = true) const {
-    return builder.withTransferringResult(transferring).build();
+  [[nodiscard]] ASTExtInfo withSendingResult(bool sending = true) const {
+    return builder.withSendingResult(sending).build();
   }
 
   [[nodiscard]]

include/swift/AST/TypeAttr.def

@@ -105,7 +105,7 @@ SIMPLE_SIL_TYPE_ATTR(captures_generics, CapturesGenerics)
 // Used at the SIL level to mark a type as moveOnly.
 SIMPLE_SIL_TYPE_ATTR(moveOnly, MoveOnly)
 SIMPLE_SIL_TYPE_ATTR(sil_isolated, SILIsolated)
-SIMPLE_SIL_TYPE_ATTR(sil_transferring, SILTransferring)
+SIMPLE_SIL_TYPE_ATTR(sil_sending, SILSending)
 
 // SIL metatype attributes.
 SIMPLE_SIL_TYPE_ATTR(thin, Thin)

include/swift/AST/Types.h

@@ -2224,7 +2224,7 @@ class ParameterTypeFlags {
     Isolated = 1 << 7,
     CompileTimeConst = 1 << 8,
     ResultDependsOn = 1 << 9,
-    Transferring = 1 << 10,
+    Sending = 1 << 10,
     NumBits = 11
   };
   OptionSet<ParameterFlags> value;
@@ -2241,21 +2241,21 @@ class ParameterTypeFlags {
   ParameterTypeFlags(bool variadic, bool autoclosure, bool nonEphemeral,
                      ParamSpecifier specifier, bool isolated, bool noDerivative,
                      bool compileTimeConst, bool hasResultDependsOn,
-                     bool isTransferring)
+                     bool isSending)
       : value((variadic ? Variadic : 0) | (autoclosure ? AutoClosure : 0) |
               (nonEphemeral ? NonEphemeral : 0) |
               uint8_t(specifier) << SpecifierShift | (isolated ? Isolated : 0) |
               (noDerivative ? NoDerivative : 0) |
               (compileTimeConst ? CompileTimeConst : 0) |
               (hasResultDependsOn ? ResultDependsOn : 0) |
-              (isTransferring ? Transferring : 0)) {}
+              (isSending ? Sending : 0)) {}
 
   /// Create one from what's present in the parameter type
   inline static ParameterTypeFlags
   fromParameterType(Type paramTy, bool isVariadic, bool isAutoClosure,
                     bool isNonEphemeral, ParamSpecifier ownership,
                     bool isolated, bool isNoDerivative, bool compileTimeConst,
-                    bool hasResultDependsOn, bool isTransferring);
+                    bool hasResultDependsOn, bool isSending);
 
   bool isNone() const { return !value; }
   bool isVariadic() const { return value.contains(Variadic); }
@@ -2268,7 +2268,7 @@ class ParameterTypeFlags {
   bool isCompileTimeConst() const { return value.contains(CompileTimeConst); }
   bool isNoDerivative() const { return value.contains(NoDerivative); }
   bool hasResultDependsOn() const { return value.contains(ResultDependsOn); }
-  bool isTransferring() const { return value.contains(Transferring); }
+  bool isSending() const { return value.contains(Sending); }
 
   /// Get the spelling of the parameter specifier used on the parameter.
   ParamSpecifier getOwnershipSpecifier() const {
@@ -2331,10 +2331,10 @@ class ParameterTypeFlags {
                                   : value - ParameterTypeFlags::NoDerivative);
   }
 
-  ParameterTypeFlags withTransferring(bool withTransferring) const {
-    return ParameterTypeFlags(withTransferring
-                                  ? value | ParameterTypeFlags::Transferring
-                                  : value - ParameterTypeFlags::Transferring);
+  ParameterTypeFlags withSending(bool withSending) const {
+    return ParameterTypeFlags(withSending
+                                  ? value | ParameterTypeFlags::Sending
+                                  : value - ParameterTypeFlags::Sending);
   }
 
   bool operator ==(const ParameterTypeFlags &other) const {
@@ -3646,9 +3646,7 @@ class AnyFunctionType : public TypeBase {
 
   bool isThrowing() const { return getExtInfo().isThrowing(); }
 
-  bool hasTransferringResult() const {
-    return getExtInfo().hasTransferringResult();
-  }
+  bool hasSendingResult() const { return getExtInfo().hasSendingResult(); }
 
   bool hasEffect(EffectKind kind) const;
 
@@ -4218,8 +4216,8 @@ class SILParameterInfo {
     ///   differentiable with respect to this parameter.
     NotDifferentiable = 0x1,
 
-    /// Set if the given parameter is transferring.
-    Transferring = 0x2,
+    /// Set if the given parameter is sending.
+    Sending = 0x2,
 
     /// Set if the given parameter is isolated.
     Isolated = 0x4,
@@ -4488,10 +4486,10 @@ class SILResultInfo {
     ///   differentiable with respect to this result.
     NotDifferentiable = 0x1,
 
-    /// Set if a return type is transferring. This means that the returned value
+    /// Set if a return type is sending. This means that the returned value
     /// must be disconnected and not in any strongly structured regions like an
     /// actor or a task isolated variable.
-    IsTransferring = 0x2,
+    IsSending = 0x2,
   };
 
   using Options = OptionSet<Flag>;
@@ -4940,12 +4938,12 @@ class SILFunctionType final
     return getExtInfo().getIsolation();
   }
 
-  /// Return true if all
-  bool hasTransferringResult() const {
-    // For now all functions either have all transferring results or no
-    // transferring results. This is validated with a SILVerifier check.
+  /// Return true if all results are 'sending'.
+  bool hasSendingResult() const {
+    // For now all functions either have all sending results or no
+    // sending results. This is validated with a SILVerifier check.
     return getNumResults() &&
-           getResults().front().hasOption(SILResultInfo::IsTransferring);
+           getResults().front().hasOption(SILResultInfo::IsSending);
   }
 
   /// Return the array of all the yields.
@@ -7768,7 +7766,7 @@ inline TupleTypeElt TupleTypeElt::getWithType(Type T) const {
 inline ParameterTypeFlags ParameterTypeFlags::fromParameterType(
     Type paramTy, bool isVariadic, bool isAutoClosure, bool isNonEphemeral,
     ParamSpecifier ownership, bool isolated, bool isNoDerivative,
-    bool compileTimeConst, bool hasResultDependsOn, bool isTransferring) {
+    bool compileTimeConst, bool hasResultDependsOn, bool isSending) {
   // FIXME(Remove InOut): The last caller that needs this is argument
   // decomposition.  Start by enabling the assertion there and fixing up those
   // callers, then remove this, then remove
@@ -7780,7 +7778,7 @@ inline ParameterTypeFlags ParameterTypeFlags::fromParameterType(
   }
   return {isVariadic,       isAutoClosure,      isNonEphemeral,
           ownership,        isolated,           isNoDerivative,
-          compileTimeConst, hasResultDependsOn, isTransferring};
+          compileTimeConst, hasResultDependsOn, isSending};
 }
 
 inline const Type *BoundGenericType::getTrailingObjectsPointer() const {

include/swift/Demangling/Demangle.h

@@ -602,7 +602,7 @@ struct [[nodiscard]] ManglingError {
     InvalidImplCoroutineKind,
     InvalidImplFunctionAttribute,
     InvalidImplParameterConvention,
-    InvalidImplParameterTransferring,
+    InvalidImplParameterSending,
     InvalidMetatypeRepresentation,
     MultiByteRelatedEntity,
     BadValueWitnessKind,

include/swift/Demangling/DemangleNodes.def

@@ -133,9 +133,9 @@ NODE(ImplEscaping)
 NODE(ImplConvention)
 NODE(ImplDifferentiabilityKind)
 NODE(ImplErasedIsolation)
-NODE(ImplTransferringResult)
+NODE(ImplSendingResult)
 NODE(ImplParameterResultDifferentiability)
-NODE(ImplParameterTransferring)
+NODE(ImplParameterSending)
 NODE(ImplFunctionAttribute)
 NODE(ImplFunctionConvention)
 NODE(ImplFunctionConventionName)
@@ -153,9 +153,9 @@ NODE(InfixOperator)
 CONTEXT_NODE(Initializer)
 CONTEXT_NODE(InitAccessor)
 NODE(Isolated)
-NODE(Transferring)
+NODE(Sending)
 NODE(IsolatedAnyFunctionType)
-NODE(TransferringResultFunctionType)
+NODE(SendingResultFunctionType)
 NODE(KeyPathGetterThunkHelper)
 NODE(KeyPathSetterThunkHelper)
 NODE(KeyPathEqualsThunkHelper)