Merge pull request #69176 from meg-gupta/resultdependson

meg-gupta · web-flow · commit 3db420a45f8c · 2023-11-08T18:55:51.000-08:00
Add initial support for  _resultDependsOnSelf
diff --git a/include/swift/AST/Attr.def b/include/swift/AST/Attr.def
@@ -527,6 +527,9 @@ DECL_ATTR(storageRestrictions, StorageRestrictions,
 CONTEXTUAL_SIMPLE_DECL_ATTR(actor, Actor,
   DeclModifier | OnClass | ConcurrencyOnly | ABIBreakingToAdd | ABIBreakingToRemove | APIBreakingToAdd | APIBreakingToRemove,
   102)
+CONTEXTUAL_SIMPLE_DECL_ATTR(_resultDependsOnSelf, ResultDependsOnSelf,
+  OnFunc | DeclModifier | UserInaccessible | ABIBreakingToAdd | ABIStableToRemove | APIBreakingToAdd | APIStableToRemove,
+  150)
 
 #undef TYPE_ATTR
 #undef DECL_ATTR_ALIAS
diff --git a/include/swift/AST/Decl.h b/include/swift/AST/Decl.h
@@ -241,7 +241,8 @@ enum class SelfAccessKind : uint8_t {
   LegacyConsuming,
   Consuming,
   Borrowing,
-  LastSelfAccessKind = Borrowing,
+  ResultDependsOnSelf,
+  LastSelfAccessKind = ResultDependsOnSelf,
 };
 enum : unsigned {
   NumSelfAccessKindBits =
diff --git a/include/swift/AST/DiagnosticsParse.def b/include/swift/AST/DiagnosticsParse.def
@@ -2166,5 +2166,10 @@ ERROR(duplicate_storage_restrictions_attr_label,none,
 ERROR(storage_restrictions_attr_expected_name,none,
       "expected property name in @storageRestrictions list", ())
 
+ERROR(requires_non_escapable_types, none,
+      "'%0' %select{attribute|parameter specifier}1 is only valid when experimental "
+      "NonEscapableTypes is enabled",
+      (StringRef, bool))
+
 #define UNDEFINE_DIAGNOSTIC_MACROS
 #include "DefineDiagnosticMacros.h"
diff --git a/include/swift/AST/DiagnosticsSema.def b/include/swift/AST/DiagnosticsSema.def
@@ -7701,5 +7701,12 @@ ERROR(referencebindings_binding_must_have_initial_value,none,
 ERROR(referencebindings_binding_must_be_to_lvalue,none,
       "%0 bindings must be bound to an lvalue", (StringRef))
 
+//------------------------------------------------------------------------------
+// MARK: resultDependsOn Errors
+//------------------------------------------------------------------------------
+
+ERROR(result_depends_on_no_result,none,
+      "Incorrect use of %0 with no result", (StringRef))
+
 #define UNDEFINE_DIAGNOSTIC_MACROS
 #include "DefineDiagnosticMacros.h"
diff --git a/lib/APIDigester/ModuleAnalyzerNodes.cpp b/lib/APIDigester/ModuleAnalyzerNodes.cpp
@@ -1559,6 +1559,9 @@ SDKNodeInitInfo::SDKNodeInitInfo(SDKContext &Ctx, ValueDecl *VD)
     case SelfAccessKind::Borrowing:
       FuncSelfKind = "Borrowing";
       break;
+    case SelfAccessKind::ResultDependsOnSelf:
+      FuncSelfKind = "ResultDependsOnSelf";
+      break;
     }
   }
 
diff --git a/lib/AST/ASTContext.cpp b/lib/AST/ASTContext.cpp
@@ -3455,6 +3455,8 @@ AnyFunctionType::Param swift::computeSelfParam(AbstractFunctionDecl *AFD,
   case SelfAccessKind::NonMutating:
     // The default flagless state.
     break;
+  case SelfAccessKind::ResultDependsOnSelf:
+    break;
   }
 
   return AnyFunctionType::Param(selfTy, Identifier(), flags);
diff --git a/lib/AST/ASTPrinter.cpp b/lib/AST/ASTPrinter.cpp
@@ -2119,6 +2119,10 @@ void PrintAST::printSelfAccessKindModifiersIfNeeded(const FuncDecl *FD) {
     if (!Options.excludeAttrKind(DAK_Borrowing))
       Printer.printKeyword("borrowing", Options, " ");
     break;
+  case SelfAccessKind::ResultDependsOnSelf:
+    if (!Options.excludeAttrKind(DAK_ResultDependsOnSelf))
+      Printer.printKeyword("_resultDependsOnSelf", Options, " ");
+    break;
   }
 }
 
@@ -3516,8 +3520,15 @@ static bool usesFeatureStructLetDestructuring(Decl *decl) {
 }
 
 static bool usesFeatureNonEscapableTypes(Decl *decl) {
-  return decl->getAttrs().hasAttribute<NonEscapableAttr>()
-    || decl->getAttrs().hasAttribute<UnsafeNonEscapableResultAttr>();
+  if (decl->getAttrs().hasAttribute<NonEscapableAttr>() ||
+      decl->getAttrs().hasAttribute<UnsafeNonEscapableResultAttr>()) {
+    return true;
+  }
+  auto *fd = dyn_cast<FuncDecl>(decl);
+  if (fd && fd->getAttrs().getAttribute(DAK_ResultDependsOnSelf)) {
+    return true;
+  }
+  return false;
 }
 
 static bool hasParameterPacks(Decl *decl) {
diff --git a/lib/AST/Decl.cpp b/lib/AST/Decl.cpp
@@ -604,6 +604,8 @@ llvm::raw_ostream &swift::operator<<(llvm::raw_ostream &OS,
   case SelfAccessKind::LegacyConsuming: return OS << "'__consuming'";
   case SelfAccessKind::Consuming: return OS << "'consuming'";
   case SelfAccessKind::Borrowing: return OS << "'borrowing'";
+  case SelfAccessKind::ResultDependsOnSelf:
+    return OS << "'resultDependsOnSelf'";
   }
   llvm_unreachable("Unknown SelfAccessKind");
 }
diff --git a/lib/ASTGen/Sources/ASTGen/SourceFile.swift b/lib/ASTGen/Sources/ASTGen/SourceFile.swift
@@ -34,6 +34,7 @@ extension Parser.ExperimentalFeatures {
     mapFeature(.ThenStatements, to: .thenStatements)
     mapFeature(.TypedThrows, to: .typedThrows)
     mapFeature(.DoExpressions, to: .doExpressions)
+    mapFeature(.NonEscapableTypes, to: .nonEscapableTypes)
   }
 }
 
diff --git a/lib/ASTGen/Sources/ASTGen/Types.swift b/lib/ASTGen/Sources/ASTGen/Types.swift
@@ -217,7 +217,7 @@ extension ASTGenVisitor {
   }
 }
 
-// MARK: - SpecifierTypeRepr/AttrubutedTypeRepr
+// MARK: - SpecifierTypeRepr/AttributedTypeRepr
 
 extension BridgedAttributedTypeSpecifier {
   fileprivate init?(from tokenKind: TokenKind) {
diff --git a/lib/Parse/ParseDecl.cpp b/lib/Parse/ParseDecl.cpp
@@ -2900,6 +2900,12 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
     }
   }
 
+  if (DK == DAK_ResultDependsOnSelf &&
+      !Context.LangOpts.hasFeature(Feature::NonEscapableTypes)) {
+    diagnose(Loc, diag::requires_non_escapable_types, AttrName, true);
+    DiscardAttribute = true;
+  }
+
   // Filled in during parsing.  If there is a duplicate
   // diagnostic this can be used for better error presentation.
   SourceRange AttrRange;
diff --git a/lib/SILGen/SILGenApply.cpp b/lib/SILGen/SILGenApply.cpp
@@ -5348,6 +5348,7 @@ bool SILGenModule::shouldEmitSelfAsRValue(FuncDecl *fn, CanType selfType) {
   case SelfAccessKind::LegacyConsuming:
   case SelfAccessKind::Consuming:
   case SelfAccessKind::Borrowing:
+  case SelfAccessKind::ResultDependsOnSelf:
     return true;
   }
   llvm_unreachable("bad self-access kind");
diff --git a/lib/Sema/TypeCheckAttr.cpp b/lib/Sema/TypeCheckAttr.cpp
@@ -202,6 +202,9 @@ class AttributeChecker : public AttributeVisitor<AttributeChecker> {
   void visitBorrowingAttr(BorrowingAttr *attr) { visitMutationAttr(attr); }
   void visitConsumingAttr(ConsumingAttr *attr) { visitMutationAttr(attr); }
   void visitLegacyConsumingAttr(LegacyConsumingAttr *attr) { visitMutationAttr(attr); }
+  void visitResultDependsOnSelfAttr(ResultDependsOnSelfAttr *attr) {
+    visitMutationAttr(attr);
+  }
   void visitDynamicAttr(DynamicAttr *attr);
 
   void visitIndirectAttr(IndirectAttr *attr) {
@@ -468,6 +471,9 @@ void AttributeChecker::visitMutationAttr(DeclAttribute *attr) {
   case DeclAttrKind::DAK_Borrowing:
     attrModifier = SelfAccessKind::Borrowing;
     break;
+  case DeclAttrKind::DAK_ResultDependsOnSelf:
+    attrModifier = SelfAccessKind::ResultDependsOnSelf;
+    break;
   default:
     llvm_unreachable("unhandled attribute kind");
   }
@@ -482,6 +488,7 @@ void AttributeChecker::visitMutationAttr(DeclAttribute *attr) {
       case SelfAccessKind::Consuming:
       case SelfAccessKind::LegacyConsuming:
       case SelfAccessKind::Borrowing:
+      case SelfAccessKind::ResultDependsOnSelf:
         // It's still OK to specify the ownership convention of methods in
         // classes.
         break;
@@ -501,10 +508,11 @@ void AttributeChecker::visitMutationAttr(DeclAttribute *attr) {
 
   // Verify we don't have more than one ownership specifier.
   if ((FD->getAttrs().hasAttribute<MutatingAttr>() +
-          FD->getAttrs().hasAttribute<NonMutatingAttr>() +
-          FD->getAttrs().hasAttribute<LegacyConsumingAttr>() +
-          FD->getAttrs().hasAttribute<ConsumingAttr>() +
-          FD->getAttrs().hasAttribute<BorrowingAttr>()) > 1) {
+       FD->getAttrs().hasAttribute<NonMutatingAttr>() +
+       FD->getAttrs().hasAttribute<LegacyConsumingAttr>() +
+       FD->getAttrs().hasAttribute<ConsumingAttr>() +
+       FD->getAttrs().hasAttribute<BorrowingAttr>() +
+       FD->getAttrs().hasAttribute<ResultDependsOnSelfAttr>()) > 1) {
     if (auto *NMA = FD->getAttrs().getAttribute<NonMutatingAttr>()) {
       if (attrModifier != SelfAccessKind::NonMutating) {
         diagnoseAndRemoveAttr(NMA, diag::functions_mutating_and_not,
@@ -539,8 +547,25 @@ void AttributeChecker::visitMutationAttr(DeclAttribute *attr) {
                               SelfAccessKind::Borrowing, attrModifier);
       }
     }
+
+    if (auto *RDSA = FD->getAttrs().getAttribute<ResultDependsOnSelfAttr>()) {
+      if (attrModifier != SelfAccessKind::ResultDependsOnSelf) {
+        diagnoseAndRemoveAttr(RDSA, diag::functions_mutating_and_not,
+                              SelfAccessKind::ResultDependsOnSelf,
+                              attrModifier);
+      }
+    }
   }
 
+  if (auto *RDSA = FD->getAttrs().getAttribute<ResultDependsOnSelfAttr>()) {
+    if (FD->getResultTypeRepr() == nullptr) {
+      diagnoseAndRemoveAttr(RDSA, diag::result_depends_on_no_result,
+                            attr->getAttrName());
+    }
+    if (FD->getDescriptiveKind() != DescriptiveDeclKind::Method) {
+      diagnoseAndRemoveAttr(RDSA, diag::attr_methods_only, attr);
+    }
+  }
   // Verify that we don't have a static function.
   if (FD->isStatic())
     diagnoseAndRemoveAttr(attr, diag::static_functions_not_mutating);
diff --git a/lib/Sema/TypeCheckDecl.cpp b/lib/Sema/TypeCheckDecl.cpp
@@ -2392,6 +2392,7 @@ ParamSpecifierRequest::evaluate(Evaluator &evaluator,
       case SelfAccessKind::Mutating:
         return ParamSpecifier::InOut;
       case SelfAccessKind::NonMutating:
+      case SelfAccessKind::ResultDependsOnSelf:
         return ParamSpecifier::Default;
       }
       llvm_unreachable("nonexhaustive switch");
diff --git a/lib/Sema/TypeCheckDeclOverride.cpp b/lib/Sema/TypeCheckDeclOverride.cpp
@@ -1531,6 +1531,7 @@ namespace  {
     UNINTERESTING_ATTR(Override)
     UNINTERESTING_ATTR(RawDocComment)
     UNINTERESTING_ATTR(RawLayout)
+    UNINTERESTING_ATTR(ResultDependsOnSelf)
     UNINTERESTING_ATTR(Required)
     UNINTERESTING_ATTR(Convenience)
     UNINTERESTING_ATTR(Semantics)
diff --git a/lib/Sema/TypeCheckStmt.cpp b/lib/Sema/TypeCheckStmt.cpp
@@ -1348,6 +1348,7 @@ class StmtChecker : public StmtVisitor<StmtChecker, Stmt*> {
         case SelfAccessKind::Borrowing:
         case SelfAccessKind::NonMutating:
         case SelfAccessKind::Mutating:
+        case SelfAccessKind::ResultDependsOnSelf:
           ctx.Diags.diagnose(DS->getDiscardLoc(),
                              diag::discard_wrong_context_nonconsuming,
                              fn->getDescriptiveKind());
diff --git a/lib/Serialization/Deserialization.cpp b/lib/Serialization/Deserialization.cpp
@@ -2837,6 +2837,8 @@ getActualSelfAccessKind(uint8_t raw) {
     return swift::SelfAccessKind::Consuming;
   case serialization::SelfAccessKind::Borrowing:
     return swift::SelfAccessKind::Borrowing;
+  case serialization::SelfAccessKind::ResultDependsOnSelf:
+    return swift::SelfAccessKind::ResultDependsOnSelf;
   }
   return llvm::None;
 }
diff --git a/lib/Serialization/ModuleFormat.h b/lib/Serialization/ModuleFormat.h
@@ -58,7 +58,7 @@ const uint16_t SWIFTMODULE_VERSION_MAJOR = 0;
 /// describe what change you made. The content of this comment isn't important;
 /// it just ensures a conflict if two people change the module format.
 /// Don't worry about adhering to the 80-column limit for this line.
-const uint16_t SWIFTMODULE_VERSION_MINOR = 818; // tuple_addr_constructor
+const uint16_t SWIFTMODULE_VERSION_MINOR = 819; // _resultDependsOnSelf
 
 /// A standard hash seed used for all string hashes in a serialized module.
 ///
@@ -428,7 +428,8 @@ enum class SelfAccessKind : uint8_t {
   Mutating,
   LegacyConsuming,
   Consuming,
-  Borrowing
+  Borrowing,
+  ResultDependsOnSelf,
 };
 using SelfAccessKindField = BCFixed<3>;
   
diff --git a/lib/Serialization/Serialization.cpp b/lib/Serialization/Serialization.cpp
@@ -2334,6 +2334,8 @@ getStableSelfAccessKind(swift::SelfAccessKind MM) {
     return serialization::SelfAccessKind::Consuming;
   case swift::SelfAccessKind::Borrowing:
     return serialization::SelfAccessKind::Borrowing;
+  case swift::SelfAccessKind::ResultDependsOnSelf:
+    return serialization::SelfAccessKind::ResultDependsOnSelf;
   }
 
   llvm_unreachable("Unhandled StaticSpellingKind in switch.");
diff --git a/test/Parse/result_depends_on.swift b/test/Parse/result_depends_on.swift
@@ -0,0 +1,12 @@
+// RUN: %target-typecheck-verify-swift  -enable-builtin-module -enable-experimental-feature NonEscapableTypes
+// REQUIRES: asserts
+
+import Builtin
+
+class Klass {}
+
+class MethodModifiers {
+    _resultDependsOnSelf func getDependentResult() -> Builtin.NativeObject {
+      return Builtin.unsafeCastToNativeObject(self)
+    }
+}
diff --git a/test/Parse/result_depends_on_contextual_tests1.swift b/test/Parse/result_depends_on_contextual_tests1.swift
@@ -0,0 +1,16 @@
+// RUN: %target-typecheck-verify-swift  -enable-builtin-module -enable-experimental-feature NonEscapableTypes
+// REQUIRES: asserts
+
+import Builtin
+
+class Klass {}
+
+var _resultDependsOn = 0
+var _resultDependsOnSelf = 100.9
+
+class MethodModifiers {
+    _resultDependsOnSelf func _resultDependsOnSelf() -> Builtin.NativeObject {
+      return Builtin.unsafeCastToNativeObject(self)
+    }
+}
+
diff --git a/test/Parse/result_depends_on_contextual_tests2.swift b/test/Parse/result_depends_on_contextual_tests2.swift
@@ -0,0 +1,16 @@
+// RUN: %target-typecheck-verify-swift  -enable-builtin-module -enable-experimental-feature NonEscapableTypes
+// REQUIRES: asserts
+
+import Builtin
+
+class Klass {}
+
+class borrowing {}
+
+class _resultDependsOnSelf {}
+
+class MethodModifiers {
+    func getNoOpReturn() -> _resultDependsOnSelf {
+      return _resultDependsOnSelf()
+    }
+}
diff --git a/test/Sema/result_depends_on_errors.swift b/test/Sema/result_depends_on_errors.swift
@@ -0,0 +1,11 @@
+// RUN: %target-typecheck-verify-swift  -enable-builtin-module -enable-experimental-feature  NonEscapableTypes
+// REQUIRES: asserts
+
+import Builtin
+
+class Klass {}
+class MethodModifiers {
+    _resultDependsOnSelf func testAttrOnMethod() { } // expected-error{{Incorrect use of _resultDependsOnSelf with no result}}
+}
+
+_resultDependsOnSelf func testAttrOnFunc () { } // expected-error{{'resultDependsOnSelf' is only valid on methods}}

Original file line number	Diff line number	Diff line change
`@@ -1559,6 +1559,9 @@ SDKNodeInitInfo::SDKNodeInitInfo(SDKContext &Ctx, ValueDecl *VD)`
`1559`	`1559`	`case SelfAccessKind::Borrowing:`
`1560`	`1560`	`FuncSelfKind = "Borrowing";`
`1561`	`1561`	`break;`
	`1562`	`+ case SelfAccessKind::ResultDependsOnSelf:`
	`1563`	`+ FuncSelfKind = "ResultDependsOnSelf";`
	`1564`	`+ break;`
`1562`	`1565`	`}`
`1563`	`1566`	`}`
`1564`	`1567`
Original file line number	Diff line number	Diff line change
`@@ -3455,6 +3455,8 @@ AnyFunctionType::Param swift::computeSelfParam(AbstractFunctionDecl *AFD,`
`3455`	`3455`	`case SelfAccessKind::NonMutating:`
`3456`	`3456`	`// The default flagless state.`
`3457`	`3457`	`break;`
	`3458`	`+ case SelfAccessKind::ResultDependsOnSelf:`
	`3459`	`+ break;`
`3458`	`3460`	`}`
`3459`	`3461`
`3460`	`3462`	`return AnyFunctionType::Param(selfTy, Identifier(), flags);`
Original file line number	Diff line number	Diff line change
`@@ -604,6 +604,8 @@ llvm::raw_ostream &swift::operator<<(llvm::raw_ostream &OS,`
`604`	`604`	`case SelfAccessKind::LegacyConsuming: return OS << "'__consuming'";`
`605`	`605`	`case SelfAccessKind::Consuming: return OS << "'consuming'";`
`606`	`606`	`case SelfAccessKind::Borrowing: return OS << "'borrowing'";`
	`607`	`+ case SelfAccessKind::ResultDependsOnSelf:`
	`608`	`+ return OS << "'resultDependsOnSelf'";`
`607`	`609`	`}`
`608`	`610`	`llvm_unreachable("Unknown SelfAccessKind");`
`609`	`611`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ extension Parser.ExperimentalFeatures {`
`34`	`34`	`mapFeature(.ThenStatements, to: .thenStatements)`
`35`	`35`	`mapFeature(.TypedThrows, to: .typedThrows)`
`36`	`36`	`mapFeature(.DoExpressions, to: .doExpressions)`
	`37`	`+ mapFeature(.NonEscapableTypes, to: .nonEscapableTypes)`
`37`	`38`	`}`
`38`	`39`	`}`
`39`	`40`
Original file line number	Diff line number	Diff line change
`@@ -217,7 +217,7 @@ extension ASTGenVisitor {`
`217`	`217`	`}`
`218`	`218`	`}`
`219`	`219`
`220`		`-// MARK: - SpecifierTypeRepr/AttrubutedTypeRepr`
	`220`	`+// MARK: - SpecifierTypeRepr/AttributedTypeRepr`
`221`	`221`
`222`	`222`	`extension BridgedAttributedTypeSpecifier {`
`223`	`223`	`fileprivate init?(from tokenKind: TokenKind) {`