Merge pull request swiftlang#37060 from ktoso/wip-main-remove-task-current

Author: swift-ci

stdlib/public/Concurrency/Task.swift

@@ -33,37 +33,11 @@ import Swift
 /// unless implementing a scheduler.
 @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
 public struct Task {
-  internal let _task: Builtin.NativeObject
-
-  // May only be created by the standard library.
-  internal init(_ task: Builtin.NativeObject) {
-    self._task = task
-  }
-}
-
-// ==== Current Task -----------------------------------------------------------
-
-@available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
-extension Task {
-
-  /// Returns 'current' `Task` instance, representing the task from within which
-  /// this function was called.
-  ///
-  /// All functions available on the Task
-  @available(*, deprecated, message: "`Task.current` has been deprecated and will be removed, use static functions on Task instead.")
-  public static var current: Task? {
-    guard let _task = _getCurrentAsyncTask() else {
-      return nil
-    }
-
-    // FIXME: This retain seems pretty wrong, however if we don't we WILL crash
-    //        with "destroying a task that never completed" in the task's destroy.
-    //        How do we solve this properly?
-    Builtin.retain(_task)
-
-    return Task(_task)
-  }
-
+  // Task instances should not be used as they could be stored away,
+  // and sine some tasks may be task-local allocated such stored away
+  // references could point at already destroyed task memory (!).
+  //
+  // If necessary to obtain a task instance, please use withUnsafeCurrentTask.
 }
 
 // ==== Task Priority ----------------------------------------------------------
@@ -79,19 +53,12 @@ extension Task {
   /// - SeeAlso: `Task.priority`
   public static var currentPriority: Priority {
     withUnsafeCurrentTask { task in
-      task?.priority ?? Priority.default
-    }
-  }
+      guard let task = task else {
+        return Priority.default
+      }
 
-  /// Returns the `current` task's priority.
-  ///
-  /// If no current `Task` is available, returns `Priority.default`.
-  ///
-  /// - SeeAlso: `Task.Priority`
-  /// - SeeAlso: `Task.currentPriority`
-  @available(*, deprecated, message: "Storing `Task` instances has been deprecated, and as such instance functions on Task are deprecated and will be removed soon. Use the static 'Task.currentPriority' instead.")
-  public var priority: Priority {
-    getJobFlags(_task).priority
+      return getJobFlags(task._task).priority
+    }
   }
 
   /// Task priority may inform decisions an `Executor` makes about how and when
@@ -152,19 +119,22 @@ extension Task {
   /// i.e. the task will run regardless of the handle still being present or not.
   /// Dropping a handle however means losing the ability to await on the task's result
   /// and losing the ability to cancel it.
+  ///
+  // Implementation notes:
+  // A task handle can ONLY be obtained for a detached task, and as such shares
+  // no lifetime concerns with regards to holding and storing the `_task` with
+  // the `Task` type, which would have also be obtainable for any task, including
+  // a potentially task-local allocated one. I.e. it is always safe to store away
+  // a Task.Handle, yet the same is not true for the "current task" which may be
+  // a async-let created task, at risk of getting destroyed while the reference
+  // lingers around.
   public struct Handle<Success, Failure: Error>: Sendable {
     internal let _task: Builtin.NativeObject
 
     internal init(_ task: Builtin.NativeObject) {
       self._task = task
     }
 
-    /// Returns the `Task` that this handle refers to.
-    @available(*, deprecated, message: "Storing `Task` instances has been deprecated and will be removed soon.")
-    public var task: Task {
-      Task(_task)
-    }
-
     /// Wait for the task to complete, returning (or throwing) its result.
     ///
     /// ### Priority
@@ -256,23 +226,6 @@ extension Task.Handle: Equatable {
   }
 }
 
-// ==== Conformances -----------------------------------------------------------
-
-@available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
-extension Task: Hashable {
-  public func hash(into hasher: inout Hasher) {
-    UnsafeRawPointer(Builtin.bridgeToRawPointer(_task)).hash(into: &hasher)
-  }
-}
-
-@available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
-extension Task: Equatable {
-  public static func ==(lhs: Self, rhs: Self) -> Bool {
-    UnsafeRawPointer(Builtin.bridgeToRawPointer(lhs._task)) ==
-      UnsafeRawPointer(Builtin.bridgeToRawPointer(rhs._task))
-  }
-}
-
 // ==== Job Flags --------------------------------------------------------------
 
 @available(macOS 9999, iOS 9999, watchOS 9999, tvOS 9999, *)
@@ -606,7 +559,7 @@ extension Task {
 extension Task {
 
   @available(*, deprecated, message: "`Task.unsafeCurrent` was replaced by `withUnsafeCurrentTask { task in ... }`, and will be removed soon.")
-  public static var unsafeCurrent: UnsafeCurrentTask? {
+  public static var unsafeCurrent: UnsafeCurrentTask? { // TODO: remove as soon as possible
     guard let _task = _getCurrentAsyncTask() else {
       return nil
     }
@@ -670,15 +623,6 @@ public struct UnsafeCurrentTask {
     self._task = task
   }
 
-  /// Returns `Task` representing the same asynchronous context as this 'UnsafeCurrentTask'.
-  ///
-  /// Operations on `Task` (unlike `UnsafeCurrentTask`) are safe to be called
-  /// from any other task (or thread).
-  @available(*, deprecated, message: "Storing `Task` instances has been deprecated and will be removed soon.")
-  public var task: Task {
-    Task(_task)
-  }
-
   /// Returns `true` if the task is cancelled, and should stop executing.
   ///
   /// - SeeAlso: `checkCancellation()`

stdlib/public/Concurrency/TaskCancellation.swift

@@ -66,7 +66,13 @@ extension Task {
   /// - SeeAlso: `checkCancellation()`
   @available(*, deprecated, message: "Storing `Task` instances has been deprecated and will be removed soon. Use the static 'Task.isCancelled' instead.")
   public var isCancelled: Bool {
-    _taskIsCancelled(_task)
+    withUnsafeCurrentTask { task in
+      guard let task = task else {
+        return false
+      }
+
+      return _taskIsCancelled(task._task)
+    }
   }
 
   /// Check if the task is cancelled and throw an `CancellationError` if it was.

stdlib/public/Concurrency/TaskLocal.swift

@@ -77,20 +77,22 @@ extension Task {
   public static func local<Key>(
     _ keyPath: KeyPath<TaskLocalValues, Key>
   ) -> Key.Value where Key: TaskLocalKey {
-    guard let task = Task.current else {
-      return Key.defaultValue
+    withUnsafeCurrentTask { current in
+      guard let task = current else {
+        return Key.defaultValue
+      }
+
+      let value = _taskLocalValueGet(
+        task._task, keyType: Key.self, inheritance: Key.inherit.rawValue)
+      guard let rawValue = value else {
+        return Key.defaultValue
+      }
+
+      // Take the value; The type should be correct by construction
+      let storagePtr =
+        rawValue.bindMemory(to: Key.Value.self, capacity: 1)
+      return UnsafeMutablePointer<Key.Value>(mutating: storagePtr).pointee
     }
-
-    let value = _taskLocalValueGet(
-      task._task, keyType: Key.self, inheritance: Key.inherit.rawValue)
-    guard let rawValue = value else {
-      return Key.defaultValue
-    }
-
-    // Take the value; The type should be correct by construction
-    let storagePtr =
-      rawValue.bindMemory(to: Key.Value.self, capacity: 1)
-    return UnsafeMutablePointer<Key.Value>(mutating: storagePtr).pointee
   }
 
   /// Bind the task local key to the given value for the scope of the `body` function.
@@ -106,7 +108,9 @@ extension Task {
     boundTo value: Key.Value,
     operation: () async throws -> BodyResult
   ) async rethrows -> BodyResult where Key: TaskLocalKey {
-    let _task = Task.current!._task // !-safe, guaranteed to have task available inside async function
+    let _task = withUnsafeCurrentTask { current in
+      current!._task // !-safe, guaranteed to have task available inside async function
+    }
 
     _taskLocalValuePush(_task, keyType: Key.self, value: value)
     defer { _taskLocalValuePop(_task) }