Skip to content

Commit 203a190

Browse files
committed
[Distributed] make witness be the distributed thunk
1 parent 0dae896 commit 203a190

16 files changed

+359
-31
lines changed

include/swift/AST/DiagnosticsSema.def

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4791,6 +4791,9 @@ ERROR(distributed_actor_func_static,none,
47914791
ERROR(distributed_actor_func_not_in_distributed_actor,none,
47924792
"'distributed' method can only be declared within 'distributed actor'",
47934793
())
4794+
ERROR(distributed_method_requirement_must_be_async_throws,none, // FIXME(distributed): this is an implementation limitation we should lift
4795+
"'distributed' protocol requirement %0 must currently be declared explicitly 'async throws'",
4796+
(DeclName))
47944797
ERROR(distributed_actor_user_defined_special_property,none,
47954798
"property %0 cannot be defined explicitly, as it conflicts with "
47964799
"distributed actor synthesized stored property",

include/swift/AST/DistributedDecl.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@ Type getDistributedActorSystemType(NominalTypeDecl *actor);
4747
/// Determine the `ID` type for the given actor.
4848
Type getDistributedActorIDType(NominalTypeDecl *actor);
4949

50+
/// Similar to `getDistributedSerializationRequirementType`, however, from the
51+
/// perspective of a concrete function. This way we're able to get the
52+
/// serialization requirement for specific members, also in protocols.
53+
Type getConcreteReplacementForMemberSerializationRequirement(ValueDecl *member);
54+
5055
/// Get specific 'SerializationRequirement' as defined in 'nominal'
5156
/// type, which must conform to the passed 'protocol' which is expected
5257
/// to require the 'SerializationRequirement'.

include/swift/SIL/SILDeclRef.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -414,8 +414,7 @@ struct SILDeclRef {
414414
defaultArgIndex,
415415
pointer.get<AutoDiffDerivativeFunctionIdentifier *>());
416416
}
417-
/// Returns the distributed entry point corresponding to the same
418-
/// decl.
417+
/// Returns the distributed entry point corresponding to the same decl.
419418
SILDeclRef asDistributed(bool distributed = true) const {
420419
return SILDeclRef(loc.getOpaqueValue(), kind,
421420
/*foreign=*/false,

lib/AST/DistributedDecl.cpp

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,37 @@ Type swift::getConcreteReplacementForProtocolActorSystemType(ValueDecl *member)
9696
llvm_unreachable("Unable to fetch ActorSystem type!");
9797
}
9898

99+
Type swift::getConcreteReplacementForMemberSerializationRequirement(
100+
ValueDecl *member) {
101+
auto &C = member->getASTContext();
102+
auto *DC = member->getDeclContext();
103+
auto DA = C.getDistributedActorDecl();
104+
105+
// === When declared inside an actor, we can get the type directly
106+
if (auto classDecl = DC->getSelfClassDecl()) {
107+
return getDistributedSerializationRequirementType(classDecl, C.getDistributedActorDecl());
108+
}
109+
110+
/// === Maybe the value is declared in a protocol?
111+
if (auto protocol = DC->getSelfProtocolDecl()) {
112+
GenericSignature signature;
113+
if (auto *genericContext = member->getAsGenericContext()) {
114+
signature = genericContext->getGenericSignature();
115+
} else {
116+
signature = DC->getGenericSignatureOfContext();
117+
}
118+
119+
auto SerReqAssocType = DA->getAssociatedType(C.Id_SerializationRequirement)
120+
->getDeclaredInterfaceType();
121+
122+
// Note that this may be null, e.g. if we're a distributed func inside
123+
// a protocol that did not declare a specific actor system requirement.
124+
return signature->getConcreteType(SerReqAssocType);
125+
}
126+
127+
llvm_unreachable("Unable to fetch ActorSystem type!");
128+
}
129+
99130
Type swift::getDistributedActorSystemType(NominalTypeDecl *actor) {
100131
assert(!dyn_cast<ProtocolDecl>(actor) &&
101132
"Use getConcreteReplacementForProtocolActorSystemType instead to get"

lib/SILGen/SILGenPoly.cpp

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4439,15 +4439,22 @@ void SILGenFunction::emitProtocolWitness(
44394439
SmallVector<ManagedValue, 8> origParams;
44404440
collectThunkParams(loc, origParams);
44414441

4442-
// If the witness is isolated to a distributed actor, but the requirement is
4443-
// not, go through the distributed thunk.
44444442
if (witness.hasDecl() &&
4445-
getActorIsolation(witness.getDecl()).isDistributedActor() &&
4446-
requirement.hasDecl() &&
4447-
!getActorIsolation(requirement.getDecl()).isDistributedActor()) {
4448-
witness = SILDeclRef(
4449-
cast<AbstractFunctionDecl>(witness.getDecl())->getDistributedThunk())
4450-
.asDistributed();
4443+
getActorIsolation(witness.getDecl()).isDistributedActor()) {
4444+
// We witness protocol requirements using the distributed thunk, when:
4445+
// - the witness is isolated to a distributed actor, but the requirement is not
4446+
// - the requirement is a distributed func, and therefore can only be witnessed
4447+
// by a distributed func; we handle this by witnessing the requirement with the thunk
4448+
// FIXME(distributed): this limits us to only allow distributed explicitly throwing async requirements... we need to fix this somehow.
4449+
if (requirement.hasDecl()) {
4450+
if ((!getActorIsolation(requirement.getDecl()).isDistributedActor()) ||
4451+
(isa<FuncDecl>(requirement.getDecl()) &&
4452+
witness.getFuncDecl()->isDistributed())) {
4453+
auto thunk = cast<AbstractFunctionDecl>(witness.getDecl())
4454+
->getDistributedThunk();
4455+
witness = SILDeclRef(thunk).asDistributed();
4456+
}
4457+
}
44514458
} else if (enterIsolation) {
44524459
// If we are supposed to enter the actor, do so now by hopping to the
44534460
// actor.

lib/Sema/CodeSynthesisDistributedActor.cpp

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -648,8 +648,13 @@ static FuncDecl *createDistributedThunkFunction(FuncDecl *func) {
648648
auto &C = func->getASTContext();
649649
auto DC = func->getDeclContext();
650650

651-
auto systemTy = getConcreteReplacementForProtocolActorSystemType(func);
652-
assert(systemTy &&
651+
// NOTE: So we don't need a thunk in the protocol, we should call the underlying
652+
// thing instead, which MUST have a thunk, since it must be a distributed func as well...
653+
if (dyn_cast<ProtocolDecl>(DC)) {
654+
return nullptr;
655+
}
656+
657+
assert(getConcreteReplacementForProtocolActorSystemType(func) &&
653658
"Thunk synthesis must have concrete actor system type available");
654659

655660
DeclName thunkName = func->getName();

lib/Sema/TypeCheckAttr.cpp

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5900,6 +5900,7 @@ void AttributeChecker::visitDistributedActorAttr(DistributedActorAttr *attr) {
59005900

59015901
// distributed func must be declared inside an distributed actor
59025902
auto selfTy = dc->getSelfTypeInContext();
5903+
59035904
if (!selfTy->isDistributedActor()) {
59045905
auto diagnostic = diagnoseAndRemoveAttr(
59055906
attr, diag::distributed_actor_func_not_in_distributed_actor);
@@ -5910,6 +5911,24 @@ void AttributeChecker::visitDistributedActorAttr(DistributedActorAttr *attr) {
59105911
}
59115912
return;
59125913
}
5914+
5915+
// Diagnose for the limitation that we currently have to require distributed
5916+
// actor constrained protocols to declare the distributed requirements as
5917+
// 'async throws'
5918+
// FIXME: rdar://95949498 allow requirements to not declare explicit async/throws in protocols; those effects are implicit in any case
5919+
if (isa<ProtocolDecl>(dc)) {
5920+
if (!funcDecl->hasAsync() || !funcDecl->hasThrows()) {
5921+
auto diag = funcDecl->diagnose(diag::distributed_method_requirement_must_be_async_throws,
5922+
funcDecl->getName());
5923+
if (!funcDecl->hasAsync()) {
5924+
diag.fixItInsertAfter(funcDecl->getThrowsLoc(), " async");
5925+
}
5926+
if (!funcDecl->hasThrows()) {
5927+
diag.fixItInsertAfter(funcDecl->getThrowsLoc(), " throws");
5928+
}
5929+
return;
5930+
}
5931+
}
59135932
}
59145933
}
59155934

lib/Sema/TypeCheckDistributed.cpp

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -503,9 +503,25 @@ bool CheckDistributedFunctionRequest::evaluate(
503503
serializationRequirements = getDistributedSerializationRequirementProtocols(
504504
getDistributedActorSystemType(actor)->getAnyNominal(),
505505
C.getProtocol(KnownProtocolKind::DistributedActorSystem));
506+
} else if (isa<ProtocolDecl>(DC)) {
507+
if (auto seqReqTy =
508+
getConcreteReplacementForMemberSerializationRequirement(func)) {
509+
auto seqReqTyDes = seqReqTy->castTo<ExistentialType>()->getConstraintType()->getDesugaredType();
510+
for (auto req : flattenDistributedSerializationTypeToRequiredProtocols(seqReqTyDes)) {
511+
serializationRequirements.insert(req);
512+
}
513+
}
514+
515+
// The distributed actor constrained protocol has no serialization requirements
516+
// or actor system defined, so these will only be enforced, by implementations
517+
// of DAs conforming to it, skip checks here.
518+
if (serializationRequirements.empty()) {
519+
return false;
520+
}
506521
} else {
507-
llvm_unreachable("Cannot handle types other than extensions and actor "
508-
"declarations in distributed function checking.");
522+
llvm_unreachable("Distributed function detected in type other than extension, "
523+
"distributed actor, or protocol! This should not be possible "
524+
", please file a bug.");
509525
}
510526

511527
// If the requirement is exactly `Codable` we diagnose it ia bit nicer.
@@ -653,12 +669,23 @@ void TypeChecker::checkDistributedActor(SourceFile *SF, NominalTypeDecl *nominal
653669
// If applicable, this will create the default 'init(transport:)' initializer
654670
(void)nominal->getDefaultInitializer();
655671

672+
656673
for (auto member : nominal->getMembers()) {
657674
// --- Ensure all thunks
658675
if (auto func = dyn_cast<AbstractFunctionDecl>(member)) {
659676
if (!func->isDistributed())
660677
continue;
661678

679+
if (!isa<ProtocolDecl>(nominal)) {
680+
auto systemTy = getConcreteReplacementForProtocolActorSystemType(func);
681+
if (!systemTy || systemTy->hasError()) {
682+
nominal->diagnose(
683+
diag::distributed_actor_conformance_missing_system_type,
684+
nominal->getName());
685+
return;
686+
}
687+
}
688+
662689
if (auto thunk = func->getDistributedThunk()) {
663690
SF->DelayedFunctions.push_back(thunk);
664691
}

lib/Sema/TypeChecker.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1101,6 +1101,9 @@ diagnosePotentialOpaqueTypeUnavailability(SourceRange ReferenceRange,
11011101
/// Type check a 'distributed actor' declaration.
11021102
void checkDistributedActor(SourceFile *SF, NominalTypeDecl *decl);
11031103

1104+
/// Type check a single 'distributed func' declaration.
1105+
void checkDistributedFunc(FuncDecl *func);
1106+
11041107
void checkConcurrencyAvailability(SourceRange ReferenceRange,
11051108
const DeclContext *ReferenceDC);
11061109

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
// RUN: %empty-directory(%t)
2+
// RUN: %target-swift-frontend-emit-module -emit-module-path %t/FakeDistributedActorSystems.swiftmodule -module-name FakeDistributedActorSystems -disable-availability-checking %S/../Inputs/FakeDistributedActorSystems.swift
3+
// RUN: %target-build-swift -module-name main -Xfrontend -disable-availability-checking -j2 -parse-as-library -I %t %s %S/../Inputs/FakeDistributedActorSystems.swift -o %t/a.out
4+
// RUN: %target-run %t/a.out | %FileCheck %s --color --dump-input=always
5+
6+
// REQUIRES: executable_test
7+
// REQUIRES: concurrency
8+
// REQUIRES: distributed
9+
10+
// rdar://76038845
11+
// UNSUPPORTED: use_os_stdlib
12+
// UNSUPPORTED: back_deployment_runtime
13+
14+
// FIXME(distributed): Distributed actors currently have some issues on windows, isRemote always returns false. rdar://82593574
15+
// UNSUPPORTED: OS=windows-msvc
16+
17+
import Distributed
18+
import FakeDistributedActorSystems
19+
20+
21+
typealias DefaultDistributedActorSystem = FakeRoundtripActorSystem
22+
23+
protocol DistributedWorker: DistributedActor where ActorSystem == DefaultDistributedActorSystem {
24+
associatedtype WorkItem: Sendable & Codable
25+
associatedtype WorkResult: Sendable & Codable
26+
27+
// distributed requirement currently is forced to be `async throws`...
28+
// FIXME(distributed): requirements don't have to be async throws,
29+
// distributed makes them implicitly async throws anyway...
30+
distributed func submit(work: WorkItem) async throws -> WorkResult
31+
32+
// non distributed requirements can be witnessed with _normal_ functions
33+
func sync(work: WorkItem) -> WorkResult
34+
func async(work: WorkItem) async -> WorkResult
35+
func syncThrows(work: WorkItem) throws -> WorkResult
36+
func asyncThrows(work: WorkItem) async throws -> WorkResult
37+
}
38+
39+
distributed actor TheWorker: DistributedWorker {
40+
typealias ActorSystem = DefaultDistributedActorSystem
41+
typealias WorkItem = String
42+
typealias WorkResult = String
43+
44+
distributed func submit(work: WorkItem) async throws -> WorkResult {
45+
"\(#function): \(work)"
46+
}
47+
48+
func sync(work: WorkItem) -> WorkResult {
49+
return "\(#function): \(work)"
50+
}
51+
func async(work: WorkItem) async -> WorkResult {
52+
return "\(#function): \(work)"
53+
}
54+
func syncThrows(work: WorkItem) throws -> WorkResult {
55+
return "\(#function): \(work)"
56+
}
57+
func asyncThrows(work: WorkItem) async throws -> WorkResult {
58+
return "\(#function): \(work)"
59+
}
60+
}
61+
62+
func test_generic(system: DefaultDistributedActorSystem) async throws {
63+
let localW = TheWorker(actorSystem: system)
64+
let remoteW = try! TheWorker.resolve(id: localW.id, using: system)
65+
precondition(__isRemoteActor(remoteW))
66+
67+
// direct calls work ok:
68+
let replyDirect = try await remoteW.submit(work: "Direct")
69+
print("reply direct: \(replyDirect)")
70+
// CHECK: >> remoteCall: on:main.TheWorker, target:main.TheWorker.submit(work:), invocation:FakeInvocationEncoder(genericSubs: [], arguments: ["Direct"], returnType: Optional(Swift.String), errorType: Optional(Swift.Error)), throwing:Swift.Error, returning:Swift.String
71+
// CHECK: reply direct: submit(work:): Direct
72+
73+
func callWorker<W: DistributedWorker>(w: W) async throws -> String where W.WorkItem == String, W.WorkResult == String {
74+
try await w.submit(work: "Hello")
75+
}
76+
let reply = try await callWorker(w: remoteW)
77+
print("reply (remote): \(reply)")
78+
// CHECK: >> remoteCall: on:main.TheWorker, target:main.TheWorker.submit(work:), invocation:FakeInvocationEncoder(genericSubs: [], arguments: ["Hello"], returnType: Optional(Swift.String), errorType: Optional(Swift.Error)), throwing:Swift.Error, returning:Swift.String
79+
// CHECK: << remoteCall return: submit(work:): Hello
80+
// CHECK: reply (remote): submit(work:): Hello
81+
82+
let replyLocal = try await callWorker(w: localW)
83+
print("reply (local): \(replyLocal)")
84+
// CHECK-NOT: >> remoteCall
85+
// CHECK: reply (local): submit(work:): Hello
86+
}
87+
88+
func test_whenLocal(system: DefaultDistributedActorSystem) async throws {
89+
let localW = TheWorker(actorSystem: system)
90+
let remoteW = try! TheWorker.resolve(id: localW.id, using: system)
91+
precondition(__isRemoteActor(remoteW))
92+
93+
do {
94+
let replySync = await remoteW.whenLocal { __secretlyKnownToBeLocal in
95+
__secretlyKnownToBeLocal.sync(work: "test")
96+
}
97+
print("replySync (remote): \(replySync)")
98+
// CHECK: replySync (remote): nil
99+
100+
let replySyncThrows = try await remoteW.whenLocal { __secretlyKnownToBeLocal in
101+
try __secretlyKnownToBeLocal.syncThrows(work: "test")
102+
}
103+
print("replySyncThrows (remote): \(replySyncThrows)")
104+
// CHECK: replySyncThrows (remote): nil
105+
106+
let replyAsync = await remoteW.whenLocal { __secretlyKnownToBeLocal in
107+
await __secretlyKnownToBeLocal.async(work: "test")
108+
}
109+
print("replyAsync (remote): \(replyAsync)")
110+
// CHECK: replyAsync (remote): nil
111+
112+
let replyAsyncThrows = try await remoteW.whenLocal { __secretlyKnownToBeLocal in
113+
try await __secretlyKnownToBeLocal.asyncThrows(work: "test")
114+
}
115+
print("replyAsyncThrows (remote): \(replyAsyncThrows)")
116+
// CHECK: replyAsyncThrows (remote): nil
117+
}
118+
// ==== ----------------------------------------------------------------------
119+
120+
do {
121+
let replyDistSubmit = try await localW.whenLocal { __secretlyKnownToBeLocal in
122+
try await __secretlyKnownToBeLocal.submit(work: "local-test")
123+
}
124+
print("replyDistSubmit (local): \(replyDistSubmit ?? "nil")")
125+
// CHECK-NOT: >> remoteCall
126+
// CHECK: replyDistSubmit (local): submit(work:): local-test
127+
128+
let replySyncLocal = await localW.whenLocal { __secretlyKnownToBeLocal in
129+
__secretlyKnownToBeLocal.sync(work: "local-test")
130+
}
131+
print("replySyncLocal (local): \(replySyncLocal ?? "nil")")
132+
// CHECK-NOT: >> remoteCall
133+
// CHECK: replySyncLocal (local): sync(work:): local-test
134+
135+
let replySyncThrowsLocal = try await localW.whenLocal { __secretlyKnownToBeLocal in
136+
try __secretlyKnownToBeLocal.syncThrows(work: "local-test")
137+
}
138+
print("replySyncThrowsLocal (local): \(replySyncThrowsLocal ?? "nil")")
139+
// CHECK-NOT: >> remoteCall
140+
// CHECK: replySyncThrowsLocal (local): syncThrows(work:): local-test
141+
142+
let replyAsyncLocal = await localW.whenLocal { __secretlyKnownToBeLocal in
143+
await __secretlyKnownToBeLocal.async(work: "local-test")
144+
}
145+
print("replyAsyncLocal (local): \(replyAsyncLocal ?? "nil")")
146+
// CHECK-NOT: >> remoteCall
147+
// CHECK: replyAsyncLocal (local): async(work:): local-test
148+
149+
let replyAsyncThrowsLocal = try await localW.whenLocal { __secretlyKnownToBeLocal in
150+
try await __secretlyKnownToBeLocal.asyncThrows(work: "local-test")
151+
}
152+
print("replyAsyncThrowsLocal (local): \(replyAsyncThrowsLocal ?? "nil")")
153+
// CHECK-NOT: >> remoteCall
154+
// CHECK: replyAsyncThrowsLocal (local): asyncThrows(work:): local-test
155+
}
156+
}
157+
158+
@main struct Main {
159+
static func main() async {
160+
let system = DefaultDistributedActorSystem()
161+
try! await test_generic(system: system)
162+
print("==== ---------------------------------------------------")
163+
try! await test_whenLocal(system: system)
164+
}
165+
}

0 commit comments

Comments
 (0)