Merge pull request #77179 from nate-chandler/general-coro/20241017/1

nate-chandler · web-flow · commit b7fd4e140d3a · 2024-10-23T11:17:43.000-07:00
[CoroutineAccessors] Permit read requirement.
diff --git a/include/swift/AST/DiagnosticsParse.def b/include/swift/AST/DiagnosticsParse.def
@@ -255,6 +255,8 @@ ERROR(static_var_decl_global_scope,none,
       (StaticSpellingKind))
 ERROR(expected_getset_in_protocol,none,
       "expected get or set in a protocol property", ())
+ERROR(expected_getreadset_in_protocol,none,
+      "expected get, read, or set in a protocol property", ())
 ERROR(unexpected_getset_implementation_in_protocol,none,
       "protocol property %0 cannot have a default implementation specified "
       "here; use extension instead", (StringRef))
diff --git a/lib/Parse/ParseDecl.cpp b/lib/Parse/ParseDecl.cpp
@@ -7806,14 +7806,14 @@ static bool isAllowedWhenParsingLimitedSyntax(AccessorKind kind, bool forSIL) {
   case AccessorKind::Get:
   case AccessorKind::DistributedGet:
   case AccessorKind::Set:
+  case AccessorKind::Read2:
     return true;
 
   case AccessorKind::Address:
   case AccessorKind::MutableAddress:
   case AccessorKind::WillSet:
   case AccessorKind::DidSet:
   case AccessorKind::Read:
-  case AccessorKind::Read2:
   case AccessorKind::Modify:
   case AccessorKind::Modify2:
     return false;
@@ -8144,7 +8144,10 @@ ParserStatus Parser::parseGetSet(ParseDeclOptions Flags, ParameterList *Indices,
 
       // parsingLimitedSyntax mode cannot have a body.
       if (parsingLimitedSyntax) {
-        diagnose(Tok, diag::expected_getset_in_protocol);
+        auto diag = Context.LangOpts.hasFeature(Feature::CoroutineAccessors)
+                        ? diag::expected_getreadset_in_protocol
+                        : diag::expected_getset_in_protocol;
+        diagnose(Tok, diag);
         Status |= makeParserError();
         break;
       }
@@ -8178,7 +8181,10 @@ ParserStatus Parser::parseGetSet(ParseDeclOptions Flags, ParameterList *Indices,
     // avoid having to deal with them everywhere.
     if (parsingLimitedSyntax && !isAllowedWhenParsingLimitedSyntax(
                                     Kind, SF.Kind == SourceFileKind::SIL)) {
-      diagnose(Loc, diag::expected_getset_in_protocol);
+      auto diag = Context.LangOpts.hasFeature(Feature::CoroutineAccessors)
+                      ? diag::expected_getreadset_in_protocol
+                      : diag::expected_getset_in_protocol;
+      diagnose(Loc, diag);
       continue;
     }
 
diff --git a/lib/Sema/TypeCheckStorage.cpp b/lib/Sema/TypeCheckStorage.cpp
@@ -859,6 +859,9 @@ OpaqueReadOwnershipRequest::evaluate(Evaluator &evaluator,
     return OpaqueReadOwnership::Borrowed;
   };
 
+  if (storage->getAccessor(AccessorKind::Read2))
+    return OpaqueReadOwnership::Borrowed;
+
   if (storage->getAttrs().hasAttribute<BorrowedAttr>())
     return usesBorrowed(DiagKind::BorrowedAttr);
 
@@ -3846,9 +3849,13 @@ StorageImplInfoRequest::evaluate(Evaluator &evaluator,
       readImpl = ReadImplKind::Get;
       writeImpl = WriteImplKind::Set;
       readWriteImpl = ReadWriteImplKind::MaterializeToTemporary;
-    } else if (storage->getParsedAccessor(AccessorKind::Get)) {
+    }
+    if (storage->getParsedAccessor(AccessorKind::Get)) {
       readImpl = ReadImplKind::Get;
     }
+    if (storage->getParsedAccessor(AccessorKind::Read2)) {
+      readImpl = ReadImplKind::Read2;
+    }
 
     StorageImplInfo info(readImpl, writeImpl, readWriteImpl);
     finishStorageImplInfo(storage, info);
diff --git a/test/IRGen/coroutine_accessors.swift b/test/IRGen/coroutine_accessors.swift
@@ -37,10 +37,11 @@ public var irm: Int {
   modify {
     yield &_i
   }
-// CHECK-OLD-LABEL: define{{.*}} {{i64|i32}} @"$s19coroutine_accessors1SV3irmSivg"(
-// CHECK-OLD-SAME:      ptr %0,
-// CHECK-OLD-SAME:      [[INT]] %1
-// CHECK-OLD-SAME:  ) #0
+// CHECK-OLD-LABEL: define{{.*}} { ptr, {{i64|i32}} } @"$s19coroutine_accessors1SV3irmSivr"(
+// CHECK-OLD-SAME:      ptr noalias dereferenceable({{32|16}}) %0,
+// CHECK-OLD-SAME:      ptr %1,
+// CHECK-OLD-SAME:      [[INT]] %2
+// CHECK-OLD-SAME:  )
 // CHECK-OLD-SAME:  {
 // CHECK-OLD:       }
 // CHECK-OLD-LABEL: define{{.*}} void @"$s19coroutine_accessors1SV3irmSivs"(
diff --git a/test/Parse/coroutine_accessors.swift b/test/Parse/coroutine_accessors.swift
@@ -326,3 +326,18 @@ var ir_rm_m: Int {
     fatalError()
   }
 }
+
+// =============================================================================
+// Protocol Requirements
+// =============================================================================
+
+protocol P {
+  var goodP: Int { read set } //expected-disabled-error{{property in protocol must have explicit { get } or { get set } specifier}}
+                              //expected-disabled-error@-1{{expected get or set in a protocol property}}
+  var badP: Int { read modify } //expected-enabled-error{{expected get, read, or set in a protocol property}}
+                                //expected-disabled-error@-1{{property in protocol must have explicit { get } or { get set } specifier}}
+                                //expected-disabled-error@-2{{expected get or set in a protocol property}}
+  subscript(goodS goodS: Int) -> Int { read set } //expected-disabled-error{{expected get or set in a protocol property}}
+  subscript(badS badS: Int) -> Int { read modify } //expected-enabled-error{{expected get, read, or set in a protocol property}}
+                                                   //expected-disabled-error@-1{{expected get or set in a protocol property}}
+}
diff --git a/test/SILGen/coroutine_accessors.swift b/test/SILGen/coroutine_accessors.swift
@@ -38,24 +38,26 @@ public var irm: Int {
   modify {
     yield &_i
   }
-// CHECK-LABEL: sil {{.*}}[ossa] @$s19coroutine_accessors1SV3irmSivg :
-// CHECK-SAME:      $@convention(method)
+// CHECK-LABEL: sil{{.*}} [ossa] @$s19coroutine_accessors1SV3irmSivr :
+// CHECK-SAME:      $@yield_once
+// CHECK-SAME:      @convention(method)
 // CHECK-SAME:      (@guaranteed S)
 // CHECK-SAME:      ->
-// CHECK-SAME:      Int
+// CHECK-SAME:      @yields Int
 // CHECK-SAME:  {
 // CHECK:       bb0(
-// CHECK-SAME:      [[SELF:%[^,]+]] :
-// CHECK-SAME:  ):
-// CHECK:         [[READ_ACCESSOR:%[^,]+]] = function_ref @$s19coroutine_accessors1SV3irmSivy
-// CHECK:         ([[VALUE:%[^,]+]],
-// CHECK-SAME:     [[TOKEN:%[^,]+]],
-// CHECK-SAME:     [[ALLOCATION:%[^)]+]])
-// CHECK-SAME:    = begin_apply [[READ_ACCESSOR]]([[SELF]])
+// CHECK:           [[SELF:%[^,]+]] :
+// CHECK:       ):
+// CHECK:         [[READER2:%[^,]+]] = function_ref @$s19coroutine_accessors1SV3irmSivy
+// CHECK:         ([[VALUE_ADDRESS:%[^,]+]], [[TOKEN:%[^,]+]], [[ALLOCATION:%[^,]+]]) = begin_apply [[READER2]]([[SELF]])
 // CHECK:         end_apply [[TOKEN]]
-// CHECK:         dealloc_stack [[ALLOCATION]]
-// CHECK:         return [[VALUE:%[^,]+]]
-// CHECK-LABEL: } // end sil function '$s19coroutine_accessors1SV3irmSivg'
+// CHECK:         yield [[VALUE_ADDRESS]] : $Int, resume bb1, unwind bb2
+// CHECK:       bb1:
+// CHECK:         dealloc_stack [[ALLOCATION]] : $*Builtin.SILToken
+// CHECK:       bb2:
+// CHECK:         dealloc_stack [[ALLOCATION]] : $*Builtin.SILToken
+// CHECK:         unwind
+// CHECK-LABEL: } // end sil function '$s19coroutine_accessors1SV3irmSivr'
 
 // CHECK-LABEL: sil {{.*}}[ossa] @$s19coroutine_accessors1SV3irmSivs :
 // CHECK-SAME:      $@convention(method)
@@ -95,12 +97,14 @@ public var irm: Int {
 // CHECK-SAME:   [[TOKEN:%[^,]+]],
 // CHECK-SAME:   [[ALLOCATION:%[^)]+]])
 // CHECK-SAME:  = begin_apply [[MODIFY_ACCESSOR]]([[SELF_ACCESS]])
-// CHECK:       yield [[VALUE_ADDRESS:%[^,]+]] : $*Int, resume bb1, unwind bb2
-// CHECK:     bb1:
+// CHECK:       yield [[VALUE_ADDRESS]] 
+// CHECK-SAME:      resume [[RESUME_BB:bb[0-9]+]]
+// CHECK-SAME:      unwind [[UNWIND_BB:bb[0-9]+]]
+// CHECK:     [[RESUME_BB]]:
 // CHECK:       end_apply [[TOKEN]]
 // CHECK:       end_access [[SELF_ACCESS]]
 // CHECK:       dealloc_stack [[ALLOCATION]]
-// CHECK:     bb2:
+// CHECK:     [[UNWIND_BB]]:
 // CHECK:       end_apply [[TOKEN]]
 // CHECK:       dealloc_stack [[ALLOCATION]]
 // CHECK:       end_access [[SELF_ACCESS]]
@@ -123,7 +127,7 @@ public var irm: Int {
 // CHECK:      store [[NEW_VALUE:%[^,]+]] to [trivial] [[NEW_VALUE_ADDR]]
 // CHECK:      [[SELF_ACCESS:%[^,]+]] = begin_access [modify] [unknown] [[SELF]]
 // CHECK:      [[MODIFY_ACCESSOR:%[^,]+]] = function_ref @$s19coroutine_accessors1SV3irmSivx
-// CHECK:      ([[VALUE_ADDR:%[^,]+]], 
+// CHECK:      ([[VALUE_ADDR:%[^,]+]],
 // CHECK-SAME:  [[TOKEN:%[^,]+]],
 // CHECK-SAME:  [[ALLOCATION:%[^)]+]])
 // CHECK-SAME: = begin_apply [[MODIFY_ACCESSOR]]([[SELF_ACCESS]])
@@ -164,3 +168,65 @@ func update<T : Equatable>(at location: inout T, to newValue: T) throws -> T {
   location = newValue
   return oldValue
 }
+
+protocol ReadableTitle {
+  var title: String { read }
+}
+class OverridableGetter : ReadableTitle {
+  var title: String = ""
+}
+//   The read witness thunk does a direct call to the concrete read accessor.
+// CHECK-LABEL: sil private [transparent] [thunk] [ossa] @$s19coroutine_accessors17OverridableGetterCAA13ReadableTitleA2aDP5titleSSvrTW
+// CHECK:       function_ref @$s19coroutine_accessors17OverridableGetterC5titleSSvr
+// CHECK-LABEL: // end sil function '$s19coroutine_accessors17OverridableGetterCAA13ReadableTitleA2aDP5titleSSvrTW'
+//   The concrete read accessor is generated on-demand and does a class dispatch to the getter.
+// CHECK-LABEL: sil shared [ossa] @$s19coroutine_accessors17OverridableGetterC5titleSSvr
+// CHECK:       class_method %0 : $OverridableGetter, #OverridableGetter.title!getter
+// CHECK-LABEL: // end sil function '$s19coroutine_accessors17OverridableGetterC5titleSSvr'
+
+class ImplementedReader : ReadableTitle {
+  var _title: String = ""
+  var title: String {
+    read {
+      yield _title
+    }
+  }
+}
+
+protocol GettableTitle {
+  var title: String { get }
+}
+
+// CHECK-LABEL: sil{{.*}} [ossa] @$s19coroutine_accessors17OverridableReaderCAA13GettableTitleA2aDP5titleSSvgTW : {{.*}} {
+// CHECK:       bb0(
+// CHECK-SAME:      [[SELF_ADDR:%[^,]+]] :
+// CHECK-SAME:  ):
+// CHECK:         [[SELF:%[^,]+]] = load_borrow [[SELF_ADDR]]
+// CHECK:         [[GETTER:%[^,]+]] = function_ref @$s19coroutine_accessors17OverridableReaderC5titleSSvg
+// CHECK:         [[RETVAL:%[^,]+]] = apply [[GETTER]]([[SELF]])
+// CHECK:         end_borrow [[SELF]]
+// CHECK:         return [[RETVAL]]
+// CHECK-LABEL: } // end sil function '$s19coroutine_accessors17OverridableReaderCAA13GettableTitleA2aDP5titleSSvgTW'
+// CHECK-LABEL: sil{{.*}} [ossa] @$s19coroutine_accessors17OverridableReaderC5titleSSvg : {{.*}} {
+// CHECK:       bb0(
+// CHECK-SAME:      [[SELF:%[^,]+]] :
+// CHECK-SAME:  ):
+// CHECK:         [[READER:%[^,]+]] = class_method [[SELF]] : $OverridableReader, #OverridableReader.title!read
+// CHECK:         ([[TITLE:%[^,]+]], [[TOKEN:%[^,]+]]) = begin_apply [[READER]]([[SELF]])
+// CHECK:         [[RETVAL:%[^,]+]] = copy_value [[TITLE]]
+// CHECK:         end_apply [[TOKEN]] as $()
+// CHECK:         return [[RETVAL]]
+// CHECK-LABEL: } // end sil function '$s19coroutine_accessors17OverridableReaderC5titleSSvg'
+
+// CHECK-LABEL: sil_witness_table{{.*}} OverridableReader: GettableTitle {{.*}} {
+// CHECK-NEXT:    method #GettableTitle.title!getter
+// CHECK-SAME:        @$s19coroutine_accessors17OverridableReaderCAA13GettableTitleA2aDP5titleSSvgTW
+// CHECK-NEXT:  }
+class OverridableReader : GettableTitle {
+  var _title: String = ""
+  var title: String {
+    read {
+      yield _title
+    }
+  }
+}
diff --git a/test/SILGen/read_requirements.swift b/test/SILGen/read_requirements.swift
diff --git a/test/Sema/coroutine_accessors.swift b/test/Sema/coroutine_accessors.swift
diff --git a/test/Sema/read_requirements.swift b/test/Sema/read_requirements.swift
