[Concurrency] Adopt stable keyword consuming instead of __owned

ktoso · ktoso · commit 0f6a32f60691 · 2023-05-02T12:55:45.000+09:00
diff --git a/lib/AST/Decl.cpp b/lib/AST/Decl.cpp
@@ -5335,11 +5335,13 @@ NominalTypeDecl::getExecutorOwnedEnqueueFunction() const {
       continue;
 
     if (auto *funcDecl = dyn_cast<AbstractFunctionDecl>(candidate)) {
-      if (funcDecl->getParameters()->size() != 1)
+      auto params = funcDecl->getParameters();
+      if (params->size() != 1)
         continue;
 
-      auto params = funcDecl->getParameters();
-      if (params->get(0)->getSpecifier() == ParamSpecifier::LegacyOwned) { // TODO: make this Consuming
+      auto param = params->get(0);
+      if (param->getSpecifier() == ParamSpecifier::LegacyOwned ||
+          param->getSpecifier() == ParamSpecifier::Consuming) {
         return funcDecl;
       }
     }
diff --git a/stdlib/public/Concurrency/Executor.swift b/stdlib/public/Concurrency/Executor.swift
@@ -26,7 +26,7 @@ public protocol Executor: AnyObject, Sendable {
 
   #if !SWIFT_STDLIB_TASK_TO_THREAD_MODEL_CONCURRENCY
   @available(SwiftStdlib 5.9, *)
-  func enqueue(_ job: __owned ExecutorJob)
+  func enqueue(_ job: consuming ExecutorJob)
   #endif // !SWIFT_STDLIB_TASK_TO_THREAD_MODEL_CONCURRENCY
 }
 
@@ -53,7 +53,7 @@ public protocol SerialExecutor: Executor {
   // work-scheduling operation.
   @_nonoverride
   @available(SwiftStdlib 5.9, *)
-  func enqueue(_ job: __owned ExecutorJob)
+  func enqueue(_ job: consuming ExecutorJob)
   #endif // !SWIFT_STDLIB_TASK_TO_THREAD_MODEL_CONCURRENCY
 
   /// Convert this executor value to the optimized form of borrowed
@@ -89,7 +89,7 @@ extension Executor {
     self.enqueue(ExecutorJob(job))
   }
 
-  public func enqueue(_ job: __owned ExecutorJob) {
+  public func enqueue(_ job: consuming ExecutorJob) {
     self.enqueue(UnownedJob(job))
   }
 }
diff --git a/stdlib/public/Concurrency/PartialAsyncTask.swift b/stdlib/public/Concurrency/PartialAsyncTask.swift
@@ -45,7 +45,7 @@ public struct UnownedJob: Sendable {
   #if !SWIFT_STDLIB_TASK_TO_THREAD_MODEL_CONCURRENCY
   /// Create an `UnownedJob` whose lifetime must be managed carefully until it is run exactly once.
   @available(SwiftStdlib 5.9, *)
-  public init(_ job: __owned ExecutorJob) {
+  public init(_ job: consuming ExecutorJob) {
     self.context = job.context
   }
   #endif // !SWIFT_STDLIB_TASK_TO_THREAD_MODEL_CONCURRENCY
diff --git a/stdlib/public/Distributed/DistributedDefaultExecutor.swift b/stdlib/public/Distributed/DistributedDefaultExecutor.swift
@@ -24,7 +24,7 @@ internal final class DistributedRemoteActorReferenceExecutor: SerialExecutor {
   internal init() {}
 
   @inlinable
-  public func enqueue(_ job: __owned ExecutorJob) {
+  public func enqueue(_ job: consuming ExecutorJob) {
     let jobDescription = job.description
     fatalError("Attempted to enqueue \(ExecutorJob.self) (\(jobDescription)) on executor of remote distributed actor reference!")
   }
diff --git a/test/Concurrency/Runtime/custom_executors_complex_equality_crash.swift b/test/Concurrency/Runtime/custom_executors_complex_equality_crash.swift
@@ -23,7 +23,7 @@ final class NaiveQueueExecutor: SerialExecutor, CustomStringConvertible {
     self.queue = queue
   }
 
-  public func enqueue(_ job: __owned ExecutorJob) {
+  public func enqueue(_ job: consuming ExecutorJob) {
     let unowned = UnownedJob(job)
     queue.sync {
       unowned.runSynchronously(on: self.asUnownedSerialExecutor())
diff --git a/test/Concurrency/Runtime/custom_executors_moveOnly_job.swift b/test/Concurrency/Runtime/custom_executors_moveOnly_job.swift
@@ -10,7 +10,7 @@
 // REQUIRES: concurrency_runtime
 
 final class InlineExecutor: SerialExecutor, CustomStringConvertible {
-  public func enqueue(_ job: __owned ExecutorJob) {
+  public func enqueue(_ job: consuming ExecutorJob) {
     job.runSynchronously(on: self.asUnownedSerialExecutor())
   }
 
diff --git a/test/Concurrency/Runtime/custom_executors_priority.swift b/test/Concurrency/Runtime/custom_executors_priority.swift
@@ -10,7 +10,7 @@
 // REQUIRES: concurrency_runtime
 
 final class InlineExecutor: SerialExecutor {
-  public func enqueue(_ job: __owned ExecutorJob) {
+  public func enqueue(_ job: consuming ExecutorJob) {
     print("\(self): enqueue (priority: \(TaskPriority(job.priority)!))")
     job.runSynchronously(on: self.asUnownedSerialExecutor())
   }
diff --git a/test/Concurrency/Runtime/custom_executors_protocol.swift b/test/Concurrency/Runtime/custom_executors_protocol.swift
@@ -35,7 +35,7 @@ final class NaiveQueueExecutor: SpecifiedExecutor, CustomStringConvertible {
     self.queue = queue
   }
 
-  public func enqueue(_ job: __owned ExecutorJob) {
+  public func enqueue(_ job: consuming ExecutorJob) {
     print("\(self): enqueue")
     let unowned = UnownedJob(job)
     queue.sync {
diff --git a/test/Concurrency/Runtime/custom_executors_sdk_with_consuming_param_but_impl_owned.swift b/test/Concurrency/Runtime/custom_executors_sdk_with_consuming_param_but_impl_owned.swift
@@ -0,0 +1,18 @@
+// RUN: %target-swift-frontend(mock-sdk: %clang-importer-sdk-concurrency-consuming-job-param) -typecheck -parse-as-library %s -verify
+
+// REQUIRES: concurrency
+// REQUIRES: libdispatch
+
+// rdar://106849189 move-only types should be supported in freestanding mode
+// UNSUPPORTED: freestanding
+
+// UNSUPPORTED: back_deployment_runtime
+// REQUIRES: concurrency_runtime
+
+import _Concurrency
+
+final class FakeExecutor: SerialExecutor {
+  // implements the __owned requirement in "old" SDK:
+  //    func enqueue(_ job: __owned Job)
+  func enqueue(_ job: __owned ExecutorJob) {}
+}
diff --git a/test/Concurrency/Runtime/custom_executors_sdk_with_owned_param_but_impl_consuming.swift b/test/Concurrency/Runtime/custom_executors_sdk_with_owned_param_but_impl_consuming.swift
@@ -0,0 +1,18 @@
+// RUN: %target-swift-frontend(mock-sdk: %clang-importer-sdk-concurrency-owned-job-param) -typecheck -parse-as-library %s -verify
+
+// REQUIRES: concurrency
+// REQUIRES: libdispatch
+
+// rdar://106849189 move-only types should be supported in freestanding mode
+// UNSUPPORTED: freestanding
+
+// UNSUPPORTED: back_deployment_runtime
+// REQUIRES: concurrency_runtime
+
+import _Concurrency
+
+final class FakeExecutor: SerialExecutor {
+  // implements the __owned requirement in "old" SDK:
+  //    func enqueue(_ job: __owned Job)
+  func enqueue(_ job: consuming ExecutorJob) {}
+}
diff --git a/test/Concurrency/custom_executor_enqueue_impls.swift b/test/Concurrency/custom_executor_enqueue_impls.swift
@@ -25,7 +25,7 @@ final class OldExecutor: SerialExecutor {
 /// That's why we do log the deprecation warning, people should use the move-only version.
 final class BothExecutor: SerialExecutor {
   func enqueue(_ job: UnownedJob) {} // expected-warning{{'Executor.enqueue(UnownedJob)' is deprecated as a protocol requirement; conform type 'BothExecutor' to 'Executor' by implementing 'func enqueue(Job)' instead}}
-  func enqueue(_ job: __owned ExecutorJob) {}
+  func enqueue(_ job: consuming ExecutorJob) {}
 
   func asUnownedSerialExecutor() -> UnownedSerialExecutor {
     UnownedSerialExecutor(ordinary: self)
@@ -45,7 +45,7 @@ final class NoneExecutor: SerialExecutor { // expected-error{{type 'NoneExecutor
 
 /// Just implementing the new signature causes no warnings, good.
 final class NewExecutor: SerialExecutor {
-  func enqueue(_ job: __owned ExecutorJob) {} // no warnings
+  func enqueue(_ job: consuming ExecutorJob) {} // no warnings
 
   func asUnownedSerialExecutor() -> UnownedSerialExecutor {
     UnownedSerialExecutor(ordinary: self)
diff --git a/test/Inputs/clang-importer-sdk/swift-modules-concurrency-consuming-job-param/_Concurrency.swift b/test/Inputs/clang-importer-sdk/swift-modules-concurrency-consuming-job-param/_Concurrency.swift
@@ -0,0 +1,11 @@
+
+// This simulates a pre-Swift5.9 concurrency library with `Job` and `ExecutorJob` not being defined at all.
+// This is used to verify missing type handling in the SDK when a latest compiler is used.
+
+@_moveOnly
+public struct ExecutorJob {}
+
+public protocol SerialExecutor {
+  // pretend old SDK with `__owned` param rather than ``
+  func enqueue(_ job: consuming ExecutorJob)
+}
diff --git a/test/Inputs/clang-importer-sdk/swift-modules-concurrency-owned-job-param/_Concurrency.swift b/test/Inputs/clang-importer-sdk/swift-modules-concurrency-owned-job-param/_Concurrency.swift
@@ -0,0 +1,11 @@
+
+// This simulates a pre-Swift5.9 concurrency library with `Job` and `ExecutorJob` not being defined at all.
+// This is used to verify missing type handling in the SDK when a latest compiler is used.
+
+@_moveOnly
+public struct ExecutorJob {}
+
+public protocol SerialExecutor {
+  // pretend old SDK with `__owned` param rather than ``
+  func enqueue(_ job: __owned ExecutorJob)
+}
diff --git a/test/lit.cfg b/test/lit.cfg
@@ -616,15 +616,33 @@ config.substitutions.append(('%build-clang-importer-objc-overlays',
 # FIXME: BEGIN -enable-source-import hackaround
 config.substitutions.append(('%clang-importer-sdk-concurrency-without-job-path',
                              '%r' % (make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk'))))
-
 config.substitutions.append(('%clang-importer-sdk-concurrency-without-job-nosource',
                              '-sdk %r' % (make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk'))))
 # FIXME: END -enable-source-import hackaround
-
 config.substitutions.append(('%clang-importer-sdk-concurrency-without-job',
                              '-enable-source-import -sdk %r -I %r ' % (make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk'),
                                                                        make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk', 'swift-modules-concurrency-without-job'))))
 
+# FIXME: BEGIN -enable-source-import hackaround
+config.substitutions.append(('%clang-importer-sdk-concurrency-owned-job-param-path',
+                             '%r' % (make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk'))))
+config.substitutions.append(('%clang-importer-sdk-concurrency-owned-job-param-nosource',
+                             '-sdk %r' % (make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk'))))
+# FIXME: END -enable-source-import hackaround
+config.substitutions.append(('%clang-importer-sdk-concurrency-owned-job-param',
+                             '-enable-source-import -sdk %r -I %r ' % (make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk'),
+                                                                       make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk', 'swift-modules-concurrency-owned-job-param'))))
+
+# FIXME: BEGIN -enable-source-import hackaround
+config.substitutions.append(('%clang-importer-sdk-concurrency-consuming-job-param-path',
+                             '%r' % (make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk'))))
+config.substitutions.append(('%clang-importer-sdk-concurrency-owned-job-param-nosource',
+                             '-sdk %r' % (make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk'))))
+# FIXME: END -enable-source-import hackaround
+config.substitutions.append(('%clang-importer-sdk-concurrency-consuming-job-param',
+                             '-enable-source-import -sdk %r -I %r ' % (make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk'),
+                                                                       make_path(config.test_source_root, 'Inputs', 'clang-importer-sdk', 'swift-modules-concurrency-consuming-job-param'))))
+
 
 # FIXME: BEGIN -enable-source-import hackaround
 config.substitutions.append(('%clang-importer-sdk-path',

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public protocol Executor: AnyObject, Sendable {`
`26`	`26`
`27`	`27`	`#if !SWIFT_STDLIB_TASK_TO_THREAD_MODEL_CONCURRENCY`
`28`	`28`	`@available(SwiftStdlib 5.9, *)`
`29`		`- func enqueue(_ job: __owned ExecutorJob)`
	`29`	`+ func enqueue(_ job: consuming ExecutorJob)`
`30`	`30`	`#endif // !SWIFT_STDLIB_TASK_TO_THREAD_MODEL_CONCURRENCY`
`31`	`31`	`}`
`32`	`32`
`@@ -53,7 +53,7 @@ public protocol SerialExecutor: Executor {`
`53`	`53`	`// work-scheduling operation.`
`54`	`54`	`@_nonoverride`
`55`	`55`	`@available(SwiftStdlib 5.9, *)`
`56`		`- func enqueue(_ job: __owned ExecutorJob)`
	`56`	`+ func enqueue(_ job: consuming ExecutorJob)`
`57`	`57`	`#endif // !SWIFT_STDLIB_TASK_TO_THREAD_MODEL_CONCURRENCY`
`58`	`58`
`59`	`59`	`/// Convert this executor value to the optimized form of borrowed`
`@@ -89,7 +89,7 @@ extension Executor {`
`89`	`89`	`self.enqueue(ExecutorJob(job))`
`90`	`90`	`}`
`91`	`91`
`92`		`- public func enqueue(_ job: __owned ExecutorJob) {`
	`92`	`+ public func enqueue(_ job: consuming ExecutorJob) {`
`93`	`93`	`self.enqueue(UnownedJob(job))`
`94`	`94`	`}`
`95`	`95`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public struct UnownedJob: Sendable {`
`45`	`45`	`#if !SWIFT_STDLIB_TASK_TO_THREAD_MODEL_CONCURRENCY`
`46`	`46`	/// Create an `UnownedJob` whose lifetime must be managed carefully until it is run exactly once.
`47`	`47`	`@available(SwiftStdlib 5.9, *)`
`48`		`- public init(_ job: __owned ExecutorJob) {`
	`48`	`+ public init(_ job: consuming ExecutorJob) {`
`49`	`49`	`self.context = job.context`
`50`	`50`	`}`
`51`	`51`	`#endif // !SWIFT_STDLIB_TASK_TO_THREAD_MODEL_CONCURRENCY`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ internal final class DistributedRemoteActorReferenceExecutor: SerialExecutor {`
`24`	`24`	`internal init() {}`
`25`	`25`
`26`	`26`	`@inlinable`
`27`		`- public func enqueue(_ job: __owned ExecutorJob) {`
	`27`	`+ public func enqueue(_ job: consuming ExecutorJob) {`
`28`	`28`	`let jobDescription = job.description`
`29`	`29`	`fatalError("Attempted to enqueue \(ExecutorJob.self) (\(jobDescription)) on executor of remote distributed actor reference!")`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ final class NaiveQueueExecutor: SerialExecutor, CustomStringConvertible {`
`23`	`23`	`self.queue = queue`
`24`	`24`	`}`
`25`	`25`
`26`		`- public func enqueue(_ job: __owned ExecutorJob) {`
	`26`	`+ public func enqueue(_ job: consuming ExecutorJob) {`
`27`	`27`	`let unowned = UnownedJob(job)`
`28`	`28`	`queue.sync {`
`29`	`29`	`unowned.runSynchronously(on: self.asUnownedSerialExecutor())`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`// REQUIRES: concurrency_runtime`
`11`	`11`
`12`	`12`	`final class InlineExecutor: SerialExecutor, CustomStringConvertible {`
`13`		`- public func enqueue(_ job: __owned ExecutorJob) {`
	`13`	`+ public func enqueue(_ job: consuming ExecutorJob) {`
`14`	`14`	`job.runSynchronously(on: self.asUnownedSerialExecutor())`
`15`	`15`	`}`
`16`	`16`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ final class NaiveQueueExecutor: SpecifiedExecutor, CustomStringConvertible {`
`35`	`35`	`self.queue = queue`
`36`	`36`	`}`
`37`	`37`
`38`		`- public func enqueue(_ job: __owned ExecutorJob) {`
	`38`	`+ public func enqueue(_ job: consuming ExecutorJob) {`
`39`	`39`	`print("\(self): enqueue")`
`40`	`40`	`let unowned = UnownedJob(job)`
`41`	`41`	`queue.sync {`