Skip to content

Commit 90e1d20

Browse files
kubamracekkubamracek
committed
[embedded] Add support for actors and async let into the embedded Concurrency runtime
1 parent d61b885 commit 90e1d20

File tree

12 files changed

+232
-43
lines changed

12 files changed

+232
-43
lines changed

‎lib/IRGen/GenCall.cpp‎

Lines changed: 45 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -4470,44 +4470,9 @@ void irgen::emitTaskCancel(IRGenFunction &IGF, llvm::Value *task) {
44704470
call->setCallingConv(IGF.IGM.SwiftCC);
44714471
}
44724472

4473-
llvm::Value *irgen::emitTaskCreate(IRGenFunction &IGF, llvm::Value *flags,
4474-
llvm::Value *taskGroup,
4475-
llvm::Value *futureResultType,
4476-
llvm::Value *taskFunction,
4477-
llvm::Value *localContextInfo,
4478-
SubstitutionMap subs) {
4479-
// Start with empty task options.
4480-
llvm::Value *taskOptions =
4481-
llvm::ConstantInt::get(IGF.IGM.SwiftTaskOptionRecordPtrTy, 0);
4482-
4483-
// If there is a task group, emit a task group option structure to contain it.
4484-
if (taskGroup) {
4485-
TaskOptionRecordFlags optionsFlags(TaskOptionRecordKind::TaskGroup);
4486-
llvm::Value *optionsFlagsVal = llvm::ConstantInt::get(
4487-
IGF.IGM.SizeTy, optionsFlags.getOpaqueValue());
4488-
4489-
auto optionsRecord = IGF.createAlloca(
4490-
IGF.IGM.SwiftTaskGroupTaskOptionRecordTy, Alignment(),
4491-
"task_group_options");
4492-
auto optionsBaseRecord = IGF.Builder.CreateStructGEP(
4493-
optionsRecord, 0, Size());
4494-
4495-
// Flags
4496-
IGF.Builder.CreateStore(
4497-
optionsFlagsVal,
4498-
IGF.Builder.CreateStructGEP(optionsBaseRecord, 0, Size()));
4499-
// Parent
4500-
IGF.Builder.CreateStore(
4501-
taskOptions, IGF.Builder.CreateStructGEP(optionsBaseRecord, 1, Size()));
4502-
// TaskGroup
4503-
IGF.Builder.CreateStore(
4504-
taskGroup, IGF.Builder.CreateStructGEP(optionsRecord, 1, Size()));
4505-
4506-
taskOptions = IGF.Builder.CreateBitOrPointerCast(
4507-
optionsRecord.getAddress(), IGF.IGM.SwiftTaskOptionRecordPtrTy);
4508-
}
4509-
4510-
// In embedded Swift, create and pass result type info.
4473+
llvm::Value *irgen::addEmbeddedSwiftResultTypeInfo(IRGenFunction &IGF,
4474+
llvm::Value *taskOptions,
4475+
SubstitutionMap subs) {
45114476
if (IGF.IGM.Context.LangOpts.hasFeature(Feature::Embedded)) {
45124477
auto optionsRecord =
45134478
IGF.createAlloca(IGF.IGM.SwiftResultTypeInfoTaskOptionRecordTy,
@@ -4561,6 +4526,48 @@ llvm::Value *irgen::emitTaskCreate(IRGenFunction &IGF, llvm::Value *flags,
45614526
taskOptions = IGF.Builder.CreateBitOrPointerCast(
45624527
optionsRecord.getAddress(), IGF.IGM.SwiftTaskOptionRecordPtrTy);
45634528
}
4529+
return taskOptions;
4530+
}
4531+
4532+
llvm::Value *irgen::emitTaskCreate(IRGenFunction &IGF, llvm::Value *flags,
4533+
llvm::Value *taskGroup,
4534+
llvm::Value *futureResultType,
4535+
llvm::Value *taskFunction,
4536+
llvm::Value *localContextInfo,
4537+
SubstitutionMap subs) {
4538+
// Start with empty task options.
4539+
llvm::Value *taskOptions =
4540+
llvm::ConstantInt::get(IGF.IGM.SwiftTaskOptionRecordPtrTy, 0);
4541+
4542+
// If there is a task group, emit a task group option structure to contain it.
4543+
if (taskGroup) {
4544+
TaskOptionRecordFlags optionsFlags(TaskOptionRecordKind::TaskGroup);
4545+
llvm::Value *optionsFlagsVal = llvm::ConstantInt::get(
4546+
IGF.IGM.SizeTy, optionsFlags.getOpaqueValue());
4547+
4548+
auto optionsRecord = IGF.createAlloca(
4549+
IGF.IGM.SwiftTaskGroupTaskOptionRecordTy, Alignment(),
4550+
"task_group_options");
4551+
auto optionsBaseRecord = IGF.Builder.CreateStructGEP(
4552+
optionsRecord, 0, Size());
4553+
4554+
// Flags
4555+
IGF.Builder.CreateStore(
4556+
optionsFlagsVal,
4557+
IGF.Builder.CreateStructGEP(optionsBaseRecord, 0, Size()));
4558+
// Parent
4559+
IGF.Builder.CreateStore(
4560+
taskOptions, IGF.Builder.CreateStructGEP(optionsBaseRecord, 1, Size()));
4561+
// TaskGroup
4562+
IGF.Builder.CreateStore(
4563+
taskGroup, IGF.Builder.CreateStructGEP(optionsRecord, 1, Size()));
4564+
4565+
taskOptions = IGF.Builder.CreateBitOrPointerCast(
4566+
optionsRecord.getAddress(), IGF.IGM.SwiftTaskOptionRecordPtrTy);
4567+
}
4568+
4569+
// In embedded Swift, create and pass result type info.
4570+
taskOptions = addEmbeddedSwiftResultTypeInfo(IGF, taskOptions, subs);
45644571

45654572
assert(futureResultType && "no future?!");
45664573
llvm::CallInst *result = IGF.Builder.CreateCall(

‎lib/IRGen/GenCall.h‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,10 @@ namespace irgen {
217217

218218
void emitTaskCancel(IRGenFunction &IGF, llvm::Value *task);
219219

220+
llvm::Value *addEmbeddedSwiftResultTypeInfo(IRGenFunction &IGF,
221+
llvm::Value *taskOptions,
222+
SubstitutionMap subs);
223+
220224
/// Emit a call to swift_task_create[_f] with the given flags, options, and
221225
/// task function.
222226
llvm::Value *emitTaskCreate(

‎lib/IRGen/GenConcurrency.cpp‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919

2020
#include "BitPatternBuilder.h"
2121
#include "ExtraInhabitants.h"
22+
#include "GenCall.h"
2223
#include "GenProto.h"
2324
#include "GenType.h"
2425
#include "IRGenDebugInfo.h"
@@ -226,7 +227,13 @@ llvm::Value *irgen::emitBuiltinStartAsyncLet(IRGenFunction &IGF,
226227
assert(subs.getReplacementTypes().size() == 1 &&
227228
"startAsyncLet should have a type substitution");
228229
auto futureResultType = subs.getReplacementTypes()[0]->getCanonicalType();
229-
auto futureResultTypeMetadata = IGF.emitAbstractTypeMetadataRef(futureResultType);
230+
231+
llvm::Value *futureResultTypeMetadata =
232+
llvm::ConstantPointerNull::get(IGF.IGM.Int8PtrTy);
233+
if (!IGF.IGM.Context.LangOpts.hasFeature(Feature::Embedded)) {
234+
futureResultTypeMetadata =
235+
IGF.emitAbstractTypeMetadataRef(futureResultType);
236+
}
230237

231238
// The concurrency runtime for older Apple OSes has a bug in task formation
232239
// for `async let`s that may manifest when trying to use room in the
@@ -269,6 +276,9 @@ llvm::Value *irgen::emitBuiltinStartAsyncLet(IRGenFunction &IGF,
269276
IGF.IGM.markAsyncFunctionPointerForPadding(taskAsyncFunctionPointer);
270277
}
271278
}
279+
280+
// In embedded Swift, create and pass result type info.
281+
taskOptions = addEmbeddedSwiftResultTypeInfo(IGF, taskOptions, subs);
272282

273283
llvm::CallInst *call;
274284
if (localResultBuffer) {

‎stdlib/public/Concurrency/AsyncLet.cpp‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,11 @@ static void _asyncLet_finish_continuation(
393393

394394
// Destroy the error, or the result that was stored to the buffer.
395395
if (error) {
396+
#if SWIFT_CONCURRENCY_EMBEDDED
397+
swift_unreachable("untyped error used in embedded Swift");
398+
#else
396399
swift_errorRelease((SwiftError*)error);
400+
#endif
397401
} else {
398402
alet->getTask()->futureFragment()->getResultType().vw_destroy(resultBuffer);
399403
}

‎stdlib/public/Concurrency/CMakeLists.txt‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,7 @@ if(SWIFT_SHOULD_BUILD_EMBEDDED_STDLIB AND SWIFT_SHOULD_BUILD_EMBEDDED_CONCURRENC
188188
set(SWIFT_STDLIB_STABLE_ABI OFF)
189189
set(SWIFT_STDLIB_ENABLE_OBJC_INTEROP OFF)
190190
set(SWIFT_STDLIB_SINGLE_THREADED_CONCURRENCY TRUE)
191+
set(SWIFT_STDLIB_CONCURRENCY_TRACING FALSE)
191192

192193
foreach(entry ${EMBEDDED_STDLIB_TARGET_TRIPLES})
193194
string(REGEX REPLACE "[ \t]+" ";" list "${entry}")
@@ -210,12 +211,33 @@ if(SWIFT_SHOULD_BUILD_EMBEDDED_STDLIB AND SWIFT_SHOULD_BUILD_EMBEDDED_CONCURRENC
210211
IS_STDLIB
211212

212213
${SWIFT_RUNTIME_CONCURRENCY_C_SOURCES}
213-
# TODO: Only a handful of Swift Concurrency .swift sources, for now.
214-
Task.swift
214+
# TODO: Only a subset of Swift Concurrency .swift sources, for now.
215+
Actor.swift
215216
AsyncLet.swift
216-
Executor.swift
217+
CheckedContinuation.swift
217218
Errors.swift
219+
Executor.swift
220+
ExecutorAssertions.swift
221+
AsyncCompactMapSequence.swift
222+
AsyncDropFirstSequence.swift
223+
AsyncDropWhileSequence.swift
224+
AsyncFilterSequence.swift
225+
AsyncFlatMapSequence.swift
226+
AsyncIteratorProtocol.swift
227+
AsyncMapSequence.swift
228+
AsyncPrefixSequence.swift
229+
AsyncPrefixWhileSequence.swift
230+
AsyncSequence.swift
231+
AsyncThrowingCompactMapSequence.swift
232+
AsyncThrowingDropWhileSequence.swift
233+
AsyncThrowingFilterSequence.swift
234+
AsyncThrowingFlatMapSequence.swift
235+
AsyncThrowingMapSequence.swift
236+
AsyncThrowingPrefixWhileSequence.swift
237+
GlobalActor.swift
218238
PartialAsyncTask.swift
239+
Task.swift
240+
TaskCancellation.swift
219241

220242
SWIFT_COMPILE_FLAGS
221243
-Xcc -D__MACH__ -Xcc -D__APPLE__ -Xcc -ffreestanding -enable-experimental-feature Embedded

‎stdlib/public/Concurrency/CheckedContinuation.swift‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ internal func logFailedCheck(_ message: UnsafeRawPointer)
1919
/// Implementation class that holds the `UnsafeContinuation` instance for
2020
/// a `CheckedContinuation`.
2121
@available(SwiftStdlib 5.1, *)
22+
@_unavailableInEmbedded
2223
internal final class CheckedContinuationCanary: @unchecked Sendable {
2324
// The instance state is stored in tail-allocated raw memory, so that
2425
// we can atomically check the continuation state.
@@ -119,6 +120,7 @@ internal final class CheckedContinuationCanary: @unchecked Sendable {
119120
/// you can replace one with the other in most circumstances,
120121
/// without making other changes.
121122
@available(SwiftStdlib 5.1, *)
123+
@_unavailableInEmbedded
122124
public struct CheckedContinuation<T, E: Error>: Sendable {
123125
private let canary: CheckedContinuationCanary
124126

@@ -187,6 +189,7 @@ public struct CheckedContinuation<T, E: Error>: Sendable {
187189
}
188190

189191
@available(SwiftStdlib 5.1, *)
192+
@_unavailableInEmbedded
190193
extension CheckedContinuation {
191194
/// Resume the task awaiting the continuation by having it either
192195
/// return normally or throw an error based on the state of the given
@@ -281,6 +284,7 @@ extension CheckedContinuation {
281284
@available(SwiftStdlib 5.1, *)
282285
@_unsafeInheritExecutor // ABI compatibility with Swift 5.1
283286
@inlinable
287+
@_unavailableInEmbedded
284288
public func withCheckedContinuation<T>(
285289
function: String = #function,
286290
_ body: (CheckedContinuation<T, Never>) -> Void
@@ -321,6 +325,7 @@ public func withCheckedContinuation<T>(
321325
@available(SwiftStdlib 5.1, *)
322326
@_unsafeInheritExecutor // ABI compatibility with Swift 5.1
323327
@inlinable
328+
@_unavailableInEmbedded
324329
public func withCheckedThrowingContinuation<T>(
325330
function: String = #function,
326331
_ body: (CheckedContinuation<T, Error>) -> Void

‎stdlib/public/Concurrency/ExecutorAssertions.swift‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ extension SerialExecutor {
3636
/// never called. Failure to satisfy that assumption is a serious
3737
/// programming error.
3838
@available(SwiftStdlib 5.9, *)
39+
@_unavailableInEmbedded
3940
public func preconditionIsolated(
4041
_ message: @autoclosure () -> String = String(),
4142
file: StaticString = #fileID, line: UInt = #line
@@ -72,6 +73,7 @@ extension Actor {
7273
/// never called. Failure to satisfy that assumption is a serious
7374
/// programming error.
7475
@available(SwiftStdlib 5.9, *)
76+
@_unavailableInEmbedded
7577
public nonisolated func preconditionIsolated(
7678
_ message: @autoclosure () -> String = String(),
7779
file: StaticString = #fileID, line: UInt = #line
@@ -108,6 +110,7 @@ extension GlobalActor {
108110
/// never called. Failure to satisfy that assumption is a serious
109111
/// programming error.
110112
@available(SwiftStdlib 5.9, *)
113+
@_unavailableInEmbedded
111114
public static func preconditionIsolated(
112115
_ message: @autoclosure () -> String = String(),
113116
file: StaticString = #fileID, line: UInt = #line
@@ -134,6 +137,7 @@ extension SerialExecutor {
134137
/// may assume that it *always* evaluates to `true`. Failure to satisfy that
135138
/// assumption is a serious programming error.
136139
@available(SwiftStdlib 5.9, *)
140+
@_unavailableInEmbedded
137141
public func assertIsolated(
138142
_ message: @autoclosure () -> String = String(),
139143
file: StaticString = #fileID, line: UInt = #line
@@ -167,6 +171,7 @@ extension Actor {
167171
/// may assume that it *always* evaluates to `true`. Failure to satisfy that
168172
/// assumption is a serious programming error.
169173
@available(SwiftStdlib 5.9, *)
174+
@_unavailableInEmbedded
170175
public nonisolated func assertIsolated(
171176
_ message: @autoclosure () -> String = String(),
172177
file: StaticString = #fileID, line: UInt = #line
@@ -201,6 +206,7 @@ extension GlobalActor {
201206
/// may assume that it *always* evaluates to `true`. Failure to satisfy that
202207
/// assumption is a serious programming error.
203208
@available(SwiftStdlib 5.9, *)
209+
@_unavailableInEmbedded
204210
public static func assertIsolated(
205211
_ message: @autoclosure () -> String = String(),
206212
file: StaticString = #fileID, line: UInt = #line
@@ -229,6 +235,7 @@ extension Actor {
229235
/// perspective, the serial executor guarantees mutual exclusion of those two actors.
230236
@available(SwiftStdlib 5.9, *)
231237
@_unavailableFromAsync(message: "express the closure as an explicit function declared on the specified 'actor' instead")
238+
@_unavailableInEmbedded
232239
public nonisolated func assumeIsolated<T>(
233240
_ operation: (isolated Self) throws -> T,
234241
file: StaticString = #fileID, line: UInt = #line

‎stdlib/public/Concurrency/Task.cpp‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1236,11 +1236,15 @@ void swift_task_future_wait_throwingImpl(
12361236
}
12371237

12381238
case FutureFragment::Status::Error: {
1239+
#if SWIFT_CONCURRENCY_EMBEDDED
1240+
swift_unreachable("untyped error used in embedded Swift");
1241+
#else
12391242
// Run the task with an error result.
12401243
auto future = task->futureFragment();
12411244
auto error = future->getError();
12421245
swift_errorRetain(error);
12431246
return resumeFunction(callerContext, error);
1247+
#endif
12441248
}
12451249
}
12461250
}

‎stdlib/public/Concurrency/Task.swift‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -840,7 +840,6 @@ extension Task where Failure == Error {
840840
// ==== Voluntary Suspension -----------------------------------------------------
841841

842842
@available(SwiftStdlib 5.1, *)
843-
@_unavailableInEmbedded
844843
extension Task where Success == Never, Failure == Never {
845844

846845
/// Suspends the current task and allows other tasks to execute.

‎stdlib/public/Concurrency/TaskCancellation.swift‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ extension Task where Success == Never, Failure == Never {
9393
/// The error is always an instance of `CancellationError`.
9494
///
9595
/// - SeeAlso: `isCancelled()`
96+
@_unavailableInEmbedded
9697
public static func checkCancellation() throws {
9798
if Task<Never, Never>.isCancelled {
9899
throw _Concurrency.CancellationError()

0 commit comments

Comments
 (0)