Merge pull request #81428 from xedin/rename-some-task-apis

[stdlib] SE-0472: Rename `Task` and`*TaskGroup` APIs to match the pro…

Author: xedin

Runtimes/Core/Concurrency/CMakeLists.txt

@@ -1,7 +1,7 @@
 add_subdirectory(InternalShims)
 
 gyb_expand(TaskGroup+addTask.swift.gyb TaskGroup+addTask.swift)
-gyb_expand(Task+startSynchronously.swift.gyb Task+startSynchronously.swift)
+gyb_expand(Task+immediate.swift.gyb Task+immediate.swift)
 
 add_library(swift_Concurrency
   Actor.cpp
@@ -97,7 +97,7 @@ add_library(swift_Concurrency
   TaskSleep.swift
   TaskSleepDuration.swift
   "${CMAKE_CURRENT_BINARY_DIR}/TaskGroup+addTask.swift"
-  "${CMAKE_CURRENT_BINARY_DIR}/Task+startSynchronously.swift")
+  "${CMAKE_CURRENT_BINARY_DIR}/Task+immediate.swift")
 
 include(${SwiftCore_CONCURRENCY_GLOBAL_EXECUTOR}.cmake)
 target_compile_definitions(swift_Concurrency PRIVATE

include/swift/ABI/Executor.h

@@ -77,10 +77,10 @@ class SerialExecutorRef {
     /// Executor that may need to participate in complex "same context" checks,
     /// by invoking `isSameExclusiveExecutionContext` when comparing execution contexts.
     ComplexEquality = 0b01,
-    /// Mark this executor as the one used by `Task.startSynchronously`,
+    /// Mark this executor as the one used by `Task.immediate`,
     /// It cannot participate in switching.
     // TODO: Perhaps make this a generic "cannot switch" rather than start synchronously specific.
-    StartSynchronously = 0b10,
+    Immediate = 0b10,
   };
 
   static_assert(static_cast<uintptr_t>(ExecutorKind::Ordinary) == 0);
@@ -107,12 +107,12 @@ class SerialExecutorRef {
 
   static SerialExecutorRef forSynchronousStart() {
     auto wtable = reinterpret_cast<uintptr_t>(nullptr) |
-                  static_cast<uintptr_t>(ExecutorKind::StartSynchronously);
+                  static_cast<uintptr_t>(ExecutorKind::Immediate);
     return SerialExecutorRef(nullptr, wtable);
   }
   bool isForSynchronousStart() const {
     return getIdentity() == nullptr &&
-           getExecutorKind() == ExecutorKind::StartSynchronously;
+           getExecutorKind() == ExecutorKind::Immediate;
   }
 
   /// Given a pointer to a serial executor and its SerialExecutor

include/swift/ABI/MetadataValues.h

@@ -2746,7 +2746,7 @@ class TaskCreateFlags : public FlagSet<size_t> {
     ///
     /// Supported starting in Swift 6.1.
     Task_IsTaskFunctionConsumed                   = 15,
-    Task_IsStartSynchronouslyTask                 = 16,
+    Task_IsImmediateTask                          = 16,
   };
 
   explicit constexpr TaskCreateFlags(size_t bits) : FlagSet(bits) {}
@@ -2779,9 +2779,9 @@ class TaskCreateFlags : public FlagSet<size_t> {
   FLAGSET_DEFINE_FLAG_ACCESSORS(Task_IsTaskFunctionConsumed,
                                 isTaskFunctionConsumed,
                                 setIsTaskFunctionConsumed)
-  FLAGSET_DEFINE_FLAG_ACCESSORS(Task_IsStartSynchronouslyTask,
-                                isSynchronousStartTask,
-                                setIsSYnchronousStartTask)
+  FLAGSET_DEFINE_FLAG_ACCESSORS(Task_IsImmediateTask,
+                                isImmediateTask,
+                                setIsImmediateTask)
 };
 
 /// Flags for schedulable jobs.

include/swift/Runtime/Concurrency.h

@@ -1063,7 +1063,7 @@ SWIFT_EXPORT_FROM(swift_Concurrency) SWIFT_CC(swift)
 void swift_task_startOnMainActor(AsyncTask* job);
 
 SWIFT_EXPORT_FROM(swift_Concurrency) SWIFT_CC(swift)
-void swift_task_startSynchronously(AsyncTask* job, SerialExecutorRef targetExecutor);
+void swift_task_immediate(AsyncTask* job, SerialExecutorRef targetExecutor);
 
 /// Donate this thread to the global executor until either the
 /// given condition returns true or we've run out of cooperative

stdlib/public/CompatibilityOverride/CompatibilityOverrideConcurrency.def

@@ -439,7 +439,7 @@ OVERRIDE_TASK(task_startOnMainActor, void,
               swift::, (AsyncTask *task), (task))
 
 // In ACTOR since we need ExecutorTracking info
-OVERRIDE_ACTOR(task_startSynchronously, void,
+OVERRIDE_ACTOR(task_immediate, void,
                SWIFT_EXPORT_FROM(swift_Concurrency), SWIFT_CC(swift),
                swift::, (AsyncTask *task, SerialExecutorRef targetExecutor),
                (task, targetExecutor))

stdlib/public/Concurrency/Actor.cpp

@@ -2511,8 +2511,8 @@ static void swift_task_switchImpl(SWIFT_ASYNC_CONTEXT AsyncContext *resumeContex
 
 SWIFT_CC(swift)
 static void
-swift_task_startSynchronouslyImpl(AsyncTask *task,
-                                  SerialExecutorRef targetExecutor) {
+swift_task_immediateImpl(AsyncTask *task,
+                         SerialExecutorRef targetExecutor) {
   swift_retain(task);
   if (targetExecutor.isGeneric()) {
   // If the target is generic, it means that the closure did not specify
@@ -2526,7 +2526,7 @@ swift_task_startSynchronouslyImpl(AsyncTask *task,
   _swift_task_setCurrent(originalTask);
   } else {
     assert(swift_task_isCurrentExecutor(targetExecutor) &&
-           "startSynchronously must only be invoked when it is correctly in "
+           "'immediate' must only be invoked when it is correctly in "
            "the same isolation already, but wasn't!");
 
     // We can run synchronously, we're on the expected executor so running in

stdlib/public/Concurrency/CMakeLists.txt

@@ -223,7 +223,7 @@ add_swift_target_library(swift_Concurrency ${SWIFT_STDLIB_LIBRARY_BUILD_TYPES} I
 
   GYB_SOURCES
     TaskGroup+addTask.swift.gyb
-    Task+startSynchronously.swift.gyb
+    Task+immediate.swift.gyb
 
   SWIFT_MODULE_DEPENDS ${SWIFT_CONCURRENCY_DEPENDENCIES}
   SWIFT_MODULE_DEPENDS_ANDROID Android

stdlib/public/Concurrency/Task+startSynchronously.swift.gyb renamed to stdlib/public/Concurrency/Task+immediate.swift.gyb

@@ -13,7 +13,7 @@
 import Swift
 @_implementationOnly import SwiftConcurrencyInternalShims
 
-// ==== Task.startSynchronously ------------------------------------------------
+// ==== Task.immediate ---------------------------------------------------------
 
 % METHOD_VARIANTS = [
 %   'THROWING',
@@ -32,6 +32,17 @@ import Swift
 @available(SwiftStdlib 6.2, *)
 extension Task where Failure == ${FAILURE_TYPE} {
 
+  @available(SwiftStdlib 6.2, *)
+  @available(*, deprecated, renamed: "immediate")
+  @discardableResult
+  public static func startSynchronously(
+    name: String? = nil,
+    priority: TaskPriority? = nil,
+    @_implicitSelfCapture _ operation: __owned @isolated(any) @escaping () async throws -> Success
+  ) -> Task<Success, ${FAILURE_TYPE}> {
+    immediate(name: name, priority: priority, operation)
+  }
+
   /// Create and immediately start running a new task in the context of the calling thread/task.
   ///
   /// This function _starts_ the created task on the calling context.
@@ -56,11 +67,11 @@ extension Task where Failure == ${FAILURE_TYPE} {
   /// - Returns: A reference to the unstructured task which may be awaited on.
   @available(SwiftStdlib 6.2, *)
   @discardableResult
-  public static func startSynchronously(
+  public static func immediate(
     name: String? = nil,
     priority: TaskPriority? = nil,
     % # NOTE: This closure cannot be 'sending' because we'll trigger ' pattern that the region based isolation checker does not understand how to check'
-    % #       In this case: `func syncOnMyGlobalActor() { Task.startSynchronously { @MyGlobalActor in } }`
+    % #       In this case: `func syncOnMyGlobalActor() { Task.immediate { @MyGlobalActor in } }`
     @_implicitSelfCapture _ operation: __owned @isolated(any) @escaping () async throws -> Success
   ) -> Task<Success, ${FAILURE_TYPE}> {
 
@@ -109,7 +120,7 @@ extension Task where Failure == ${FAILURE_TYPE} {
     }
 
     if canRunSynchronously {
-      _startTaskSynchronously(task!, targetExecutor: builtinSerialExecutor)
+      _startTaskImmediately(task!, targetExecutor: builtinSerialExecutor)
     }
     return Task<Success, ${FAILURE_TYPE}>(task!)
   }
@@ -121,35 +132,35 @@ GROUP_AND_OP_INFO = [
    (
      'TaskGroup',
      [
-       'startTaskSynchronously',
-       'startTaskSynchronouslyUnlessCancelled'
+       'addImmediateTask',
+       'addImmediateTaskUnlessCancelled'
      ],
      '',
      'ChildTaskResult'
    ),
    (
      'ThrowingTaskGroup',
      [
-       'startTaskSynchronously',
-       'startTaskSynchronouslyUnlessCancelled'
+       'addImmediateTask',
+       'addImmediateTaskUnlessCancelled'
      ],
      'throws ',
      'ChildTaskResult'
    ),
    (
      'DiscardingTaskGroup',
      [
-       'startTaskSynchronously',
-       'startTaskSynchronouslyUnlessCancelled'
+       'addImmediateTask',
+       'addImmediateTaskUnlessCancelled'
      ],
      '',
      'Void'
    ),
    (
      'ThrowingDiscardingTaskGroup',
      [
-       'startTaskSynchronously',
-       'startTaskSynchronouslyUnlessCancelled'
+       'addImmediateTask',
+       'addImmediateTaskUnlessCancelled'
      ],
      'throws ',
      'Void'
@@ -204,7 +215,7 @@ extension ${GROUP_TYPE} {
       taskGroup: self._group,
       operation: operation
     )
-    _startTaskSynchronously(task, targetExecutor: builtinSerialExecutor)
+    _startTaskImmediately(task, targetExecutor: builtinSerialExecutor)
   }
 }
 %   end # METHOD_NAMES
@@ -264,5 +275,5 @@ extension Task where Failure == ${FAILURE_TYPE} {
 @_silgen_name("swift_task_startOnMainActor")
 internal func _startTaskOnMainActor(_ task: Builtin.NativeObject)
 
-@_silgen_name("swift_task_startSynchronously")
-internal func _startTaskSynchronously(_ task: Builtin.NativeObject, targetExecutor: Builtin.Executor?)
+@_silgen_name("swift_task_immediate")
+internal func _startTaskImmediately(_ task: Builtin.NativeObject, targetExecutor: Builtin.Executor?)