Skip to content

Commit b7ff16b

Browse files
ktosoktoso
authored
[Distributed] Only synthesize Codable for DA where the ID is Codable (#72081)
1 parent 8bfe9d0 commit b7ff16b

14 files changed

+213
-27
lines changed

‎include/swift/AST/DistributedDecl.h

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,17 @@ Type getAssociatedTypeOfDistributedSystemOfActor(DeclContext *actorOrExtension,
3737
/// Find the concrete invocation decoder associated with the given actor.
3838
NominalTypeDecl *getDistributedActorInvocationDecoder(NominalTypeDecl *);
3939

40+
/// Determine if this distributed actor can synthesize a `Codable` conformance.
41+
/// This is based on the actor's `ID` being `Codable`.
42+
///
43+
/// It is possible for the `ID` to be `Codable` but the
44+
/// `SerializationRequirement` used by the actor (and its actor system to not
45+
/// be `Codable`). In such situation the conformance is synthesized, however
46+
/// the user may need to provide an explicit conformance to the
47+
/// `SerializationRequirement` if they wanted to pass the actor to distributed
48+
/// methods.
49+
bool canSynthesizeDistributedActorCodableConformance(NominalTypeDecl *actor);
50+
4051
/// Find `decodeNextArgument<T>(type: T.Type) -> T` method associated with
4152
/// invocation decoder of the given distributed actor.
4253
FuncDecl *getDistributedActorArgumentDecodingMethod(NominalTypeDecl *);

‎include/swift/AST/TypeCheckRequests.h

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1054,6 +1054,24 @@ class IsDistributedActorRequest :
10541054
bool isCached() const { return true; }
10551055
};
10561056

1057+
/// Determine whether the given class is a distributed actor.
1058+
class CanSynthesizeDistributedActorCodableConformanceRequest :
1059+
public SimpleRequest<CanSynthesizeDistributedActorCodableConformanceRequest,
1060+
bool(NominalTypeDecl *),
1061+
RequestFlags::Cached> {
1062+
public:
1063+
using SimpleRequest::SimpleRequest;
1064+
1065+
private:
1066+
friend SimpleRequest;
1067+
1068+
bool evaluate(Evaluator &evaluator, NominalTypeDecl *nominal) const;
1069+
1070+
public:
1071+
// Caching
1072+
bool isCached() const { return true; }
1073+
};
1074+
10571075
/// Retrieve the implicit conformance for the given distributed actor type to
10581076
/// the Codable protocol protocol.
10591077
///

‎include/swift/AST/TypeCheckerTypeIDZone.def

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,9 @@ SWIFT_REQUEST(TypeChecker, IsDistributedActorRequest, bool(NominalTypeDecl *),
120120
SWIFT_REQUEST(TypeChecker, GetDistributedActorImplicitCodableRequest,
121121
NormalProtocolConformance *(NominalTypeDecl *, KnownProtocolKind),
122122
Cached, NoLocationInfo)
123+
SWIFT_REQUEST(TypeChecker, CanSynthesizeDistributedActorCodableConformanceRequest,
124+
bool (NominalTypeDecl *),
125+
Cached, NoLocationInfo)
123126
SWIFT_REQUEST(TypeChecker, GetDistributedActorSystemRemoteCallFunctionRequest,
124127
AbstractFunctionDecl *(NominalTypeDecl *, bool),
125128
Cached, NoLocationInfo)

‎lib/AST/ConformanceLookup.cpp

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
#include "swift/AST/Module.h"
2727
#include "swift/AST/ASTContext.h"
2828
#include "swift/AST/Builtins.h"
29+
#include "swift/AST/DistributedDecl.h"
2930
#include "swift/AST/DiagnosticsSema.h"
3031
#include "swift/AST/ExistentialLayout.h"
3132
#include "swift/AST/GenericEnvironment.h"
@@ -622,7 +623,8 @@ LookupConformanceInModuleRequest::evaluate(
622623
}
623624
} else if (protocol->isSpecificProtocol(KnownProtocolKind::Encodable) ||
624625
protocol->isSpecificProtocol(KnownProtocolKind::Decodable)) {
625-
if (nominal->isDistributedActor()) {
626+
// if (nominal->isDistributedActor()) {
627+
if (canSynthesizeDistributedActorCodableConformance(nominal)) {
626628
auto protoKind =
627629
protocol->isSpecificProtocol(KnownProtocolKind::Encodable)
628630
? KnownProtocolKind::Encodable

‎lib/AST/DistributedDecl.cpp

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,23 @@
6060

6161
using namespace swift;
6262

63+
/******************************************************************************/
64+
/************* Implicit Distributed Actor Codable Conformance *****************/
65+
/******************************************************************************/
66+
67+
bool swift::canSynthesizeDistributedActorCodableConformance(NominalTypeDecl *actor) {
68+
auto &C = actor->getASTContext();
69+
70+
if (!actor->isDistributedActor())
71+
return false;
72+
73+
return evaluateOrDefault(
74+
C.evaluator,
75+
CanSynthesizeDistributedActorCodableConformanceRequest{actor},
76+
false);
77+
}
78+
79+
6380
/******************************************************************************/
6481
/************** Distributed Actor System Associated Types *********************/
6582
/******************************************************************************/
@@ -210,17 +227,20 @@ Type swift::getDistributedActorSystemInvocationDecoderType(NominalTypeDecl *syst
210227
Type swift::getDistributedSerializationRequirementType(
211228
NominalTypeDecl *nominal, ProtocolDecl *protocol) {
212229
assert(nominal);
213-
assert(protocol);
214230
auto &ctx = nominal->getASTContext();
215231

232+
if (!protocol)
233+
return Type();
234+
216235
// Dig out the serialization requirement type.
217236
auto module = nominal->getParentModule();
218237
Type selfType = nominal->getSelfInterfaceType();
219238
auto conformance = module->lookupConformance(selfType, protocol);
220239
if (conformance.isInvalid())
221240
return Type();
222241

223-
return conformance.getTypeWitnessByName(selfType, ctx.Id_SerializationRequirement);
242+
return conformance.getTypeWitnessByName(selfType,
243+
ctx.Id_SerializationRequirement);
224244
}
225245

226246
AbstractFunctionDecl *

‎lib/AST/ProtocolConformance.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1284,7 +1284,7 @@ static SmallVector<ProtocolConformance *, 2> findSynthesizedConformances(
12841284
}
12851285

12861286
/// Distributed actors can synthesize Encodable/Decodable, so look for those
1287-
if (nominal->isDistributedActor()) {
1287+
if (canSynthesizeDistributedActorCodableConformance(nominal)) {
12881288
trySynthesize(KnownProtocolKind::Encodable);
12891289
trySynthesize(KnownProtocolKind::Decodable);
12901290
}

‎lib/Sema/CodeSynthesisDistributedActor.cpp

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1043,3 +1043,29 @@ NormalProtocolConformance *GetDistributedActorImplicitCodableRequest::evaluate(
10431043
return addDistributedActorCodableConformance(classDecl,
10441044
C.getProtocol(protoKind));
10451045
}
1046+
1047+
bool CanSynthesizeDistributedActorCodableConformanceRequest::evaluate(
1048+
Evaluator &evaluator, NominalTypeDecl *actor) const {
1049+
1050+
if (actor && !isa<ClassDecl>(actor))
1051+
return false;
1052+
1053+
if (!actor->isDistributedActor())
1054+
return false;
1055+
1056+
auto systemTy = getConcreteReplacementForProtocolActorSystemType(actor);
1057+
if (!systemTy)
1058+
return false;
1059+
1060+
if (!systemTy->getAnyNominal())
1061+
return false;
1062+
1063+
auto idTy = getDistributedActorSystemActorIDType(systemTy->getAnyNominal());
1064+
if (!idTy)
1065+
return false;
1066+
1067+
return TypeChecker::conformsToKnownProtocol(
1068+
idTy, KnownProtocolKind::Decodable, actor->getParentModule()) &&
1069+
TypeChecker::conformsToKnownProtocol(
1070+
idTy, KnownProtocolKind::Encodable, actor->getParentModule());
1071+
}

‎test/Distributed/Inputs/FakeDistributedActorSystems.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,8 @@ public struct FakeInvocationEncoder : DistributedTargetInvocationEncoder {
385385
var returnType: Any.Type? = nil
386386
var errorType: Any.Type? = nil
387387

388+
public init() {}
389+
388390
public mutating func recordGenericSubstitution<T>(_ type: T.Type) throws {
389391
print(" > encode generic sub: \(String(reflecting: type))")
390392
genericSubs.append(type)

‎test/Distributed/Runtime/distributed_actor_localSystem_generic.swift

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,11 @@
1717
import Distributed
1818

1919
@available(SwiftStdlib 6.0, *)
20-
distributed actor Worker<ActorSystem> where ActorSystem: DistributedActorSystem<any Codable>, ActorSystem.ActorID: Codable {
20+
//distributed actor Worker<ActorSystem> where ActorSystem: DistributedActorSystem<any Codable>, ActorSystem.ActorID: Codable {
21+
distributed actor Worker<ActorSystem> where ActorSystem: DistributedActorSystem<any Codable> {
2122
distributed func hi(name: String) {
2223
print("Hi, \(name)!")
2324
}
24-
25-
nonisolated var description: Swift.String {
26-
"Worker(\(id))"
27-
}
2825
}
2926

3027
// ==== Execute ----------------------------------------------------------------

‎test/Distributed/distributed_actor_conditionally_implicitly_codable.swift

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
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-swift-frontend -typecheck -verify -disable-availability-checking -I %t 2>&1 %s
4+
// REQUIRES: concurrency
5+
// REQUIRES: distributed
6+
7+
import Distributed
8+
import FakeDistributedActorSystems
9+
10+
distributed actor YesVeryMuchSo {
11+
typealias ActorSystem = FakeRoundtripActorSystem
12+
}
13+
func test_YesVeryMuchSo(_ actor: YesVeryMuchSo) {
14+
let _: any Codable = actor // implicit conformance, ID was Codable
15+
16+
// unrelated protocol
17+
let _: any CustomSerializationProtocol = actor // expected-error{{value of type 'YesVeryMuchSo' does not conform to specified type 'CustomSerializationProtocol'}}
18+
}
19+
20+
// ==== ------------------------------------------------------------------------
21+
22+
distributed actor SerReqNotCodable {
23+
typealias ActorSystem = FakeCustomSerializationRoundtripActorSystem
24+
}
25+
func test_NotAtAll_NoImplicit(_ actor: SerReqNotCodable) {
26+
let _: any Codable = actor // OK, the ID was Codable, even though SerializationRequirement was something else
27+
28+
// no implicit conformance
29+
let _: any CustomSerializationProtocol = actor // expected-error{{value of type 'SerReqNotCodable' does not conform to specified type 'CustomSerializationProtocol'}}
30+
}
31+
32+
// ==== ------------------------------------------------------------------------
33+
34+
distributed actor NotAtAll_NothingCodable {
35+
typealias ActorSystem = FakeIdIsNotCodableActorSystem
36+
}
37+
func test_NotAtAll_NoImplicit(_ actor: NotAtAll_NothingCodable) {
38+
let _: any Codable = actor // expected-error{{value of type 'NotAtAll_NothingCodable' does not conform to specified type 'Decodable'}}
39+
40+
// no implicit conformance
41+
let _: any CustomSerializationProtocol = actor // expected-error{{value of type 'NotAtAll_NothingCodable' does not conform to specified type 'CustomSerializationProtocol'}}
42+
}
43+
44+
public struct NotCodableID: Sendable, Hashable {}
45+
46+
@available(SwiftStdlib 5.7, *)
47+
public struct FakeIdIsNotCodableActorSystem: DistributedActorSystem, CustomStringConvertible {
48+
public typealias ActorID = NotCodableID
49+
public typealias InvocationDecoder = FakeInvocationDecoder
50+
public typealias InvocationEncoder = FakeInvocationEncoder
51+
public typealias SerializationRequirement = Codable
52+
public typealias ResultHandler = FakeRoundtripResultHandler
53+
54+
// just so that the struct does not become "trivial"
55+
let someValue: String = ""
56+
let someValue2: String = ""
57+
let someValue3: String = ""
58+
let someValue4: String = ""
59+
60+
public init() {
61+
}
62+
63+
public func resolve<Act>(id: ActorID, as actorType: Act.Type) throws -> Act?
64+
where Act: DistributedActor,
65+
Act.ID == ActorID {
66+
nil
67+
}
68+
69+
public func assignID<Act>(_ actorType: Act.Type) -> ActorID
70+
where Act: DistributedActor,
71+
Act.ID == ActorID {
72+
.init()
73+
}
74+
75+
public func actorReady<Act>(_ actor: Act)
76+
where Act: DistributedActor,
77+
Act.ID == ActorID {
78+
}
79+
80+
public func resignID(_ id: ActorID) {
81+
}
82+
83+
public func makeInvocationEncoder() -> InvocationEncoder {
84+
.init()
85+
}
86+
87+
public func remoteCall<Act, Err, Res>(
88+
on actor: Act,
89+
target: RemoteCallTarget,
90+
invocation invocationEncoder: inout InvocationEncoder,
91+
throwing: Err.Type,
92+
returning: Res.Type
93+
) async throws -> Res
94+
where Act: DistributedActor,
95+
Act.ID == ActorID,
96+
Err: Error,
97+
Res: SerializationRequirement {
98+
throw ExecuteDistributedTargetError(message: "\(#function) not implemented.")
99+
}
100+
101+
public func remoteCallVoid<Act, Err>(
102+
on actor: Act,
103+
target: RemoteCallTarget,
104+
invocation invocationEncoder: inout InvocationEncoder,
105+
throwing: Err.Type
106+
) async throws
107+
where Act: DistributedActor,
108+
Act.ID == ActorID,
109+
Err: Error {
110+
throw ExecuteDistributedTargetError(message: "\(#function) not implemented.")
111+
}
112+
113+
public nonisolated var description: Swift.String {
114+
"\(Self.self)()"
115+
}
116+
}

‎test/Distributed/distributed_actor_protocol_isolation.swift

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
// RUN: %empty-directory(%t)
22
// 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-swift-frontend-emit-module -I %t -emit-module-path %t/distributed_actor_protocol_isolation.swiftmodule -module-name distributed_actor_protocol_isolation -disable-availability-checking %s
4-
// X: %target-swift-frontend -typecheck -verify -disable-availability-checking -I %t 2>&1 %s
3+
// RUN: %target-swift-frontend -typecheck -verify -disable-availability-checking -I %t 2>&1 %s
54
// REQUIRES: concurrency
65
// REQUIRES: distributed
76

@@ -15,7 +14,7 @@ protocol Greeting: DistributedActor {
1514
}
1615

1716
extension Greeting {
18-
func greetLocal(name: String) {
17+
func greetLocal(name: String) { // expected-note{{distributed actor-isolated instance method 'greetLocal(name:)' declared here}}
1918
print("\(greeting()), \(name)!") // okay, we're on the actor
2019
}
2120
}
@@ -28,10 +27,12 @@ extension Greeting where SerializationRequirement == Codable {
2827
}
2928
}
3029

31-
extension Greeting {
30+
extension Greeting where Self.SerializationRequirement == Codable {
3231
nonisolated func greetAliceALot() async throws {
33-
// try await greetDistributed(name: "Alice") // okay, via Codable
34-
// let rawGreeting = try await greeting() // okay, via Self's serialization requirement
35-
// greetLocal(name: "Alice") // expected-error{{only 'distributed' instance methods can be called on a potentially remote distributed actor}}
32+
try await self.greetDistributed(name: "Alice") // okay, via Codable
33+
let rawGreeting = try await greeting() // okay, via Self's serialization requirement
34+
_ = rawGreeting
35+
36+
greetLocal(name: "Alice") // expected-error{{only 'distributed' instance methods can be called on a potentially remote distributed actor}}
3637
}
3738
}

‎test/Distributed/distributed_actor_system_missing.swift

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,7 @@ distributed actor DA {
1010
// expected-error@-1{{distributed actor 'DA' does not declare ActorSystem it can be used with}}
1111
// expected-error@-2 {{type 'DA' does not conform to protocol 'DistributedActor'}}
1212

13-
// Since synthesis would have failed due to the missing ActorSystem:
14-
// expected-error@-5{{type 'DA' does not conform to protocol 'Encodable'}}
15-
// expected-error@-6{{type 'DA' does not conform to protocol 'Decodable'}}
16-
17-
// expected-note@-8{{you can provide a module-wide default actor system by declaring:}}
13+
// expected-note@-4{{you can provide a module-wide default actor system by declaring:}}
1814

1915
// Note to add the typealias is diagnosed on the protocol:
2016
// _Distributed.DistributedActor:3:20: note: diagnostic produced elsewhere: protocol requires nested type 'ActorSystem'; do you want to add it?
@@ -27,8 +23,6 @@ distributed actor DA {
2723
distributed actor Server { // expected-error 2 {{distributed actor 'Server' does not declare ActorSystem it can be used with}}
2824
// expected-error@-1 {{type 'Server' does not conform to protocol 'DistributedActor'}}
2925
// expected-note@-2{{you can provide a module-wide default actor system by declaring:}}
30-
// expected-error@-3{{type 'Server' does not conform to protocol 'Encodable'}}
31-
// expected-error@-4{{type 'Server' does not conform to protocol 'Decodable'}}
3226
typealias ActorSystem = DoesNotExistDataSystem
3327
// expected-error@-1{{cannot find type 'DoesNotExistDataSystem' in scope}}
3428
typealias SerializationRequirement = any Codable

‎test/Distributed/distributed_actor_system_missing_type_no_crash.swift

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ distributed actor Fish {
1212
// expected-error@-2{{distributed actor 'Fish' does not declare ActorSystem it can be used with}}
1313
// expected-error@-3{{type 'Fish' does not conform to protocol 'DistributedActor'}}
1414
// expected-note@-4{{you can provide a module-wide default actor system by declaring:\ntypealias DefaultDistributedActorSystem = <#ConcreteActorSystem#>}}
15-
// expected-error@-5{{type 'Fish' does not conform to protocol 'Encodable'}}
16-
// expected-error@-6{{type 'Fish' does not conform to protocol 'Decodable'}}
1715

1816
distributed func tell(_ text: String, by: Fish) {
1917
// What would the fish say, if it could talk?

‎test/Distributed/distributed_protocols_distributed_func_serialization_requirements.swift

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,6 @@ distributed actor ProtocolWithChecksSeqReqDA_MissingSystem: ProtocolWithChecksSe
5353
// expected-error@-4{{distributed actor 'ProtocolWithChecksSeqReqDA_MissingSystem' does not declare ActorSystem it can be used with}}
5454
//
5555
// expected-error@-6{{type 'ProtocolWithChecksSeqReqDA_MissingSystem' does not conform to protocol 'DistributedActor'}}
56-
// expected-error@-7{{type 'ProtocolWithChecksSeqReqDA_MissingSystem' does not conform to protocol 'Encodable'}}
57-
// expected-error@-8{{type 'ProtocolWithChecksSeqReqDA_MissingSystem' does not conform to protocol 'Decodable'}}
5856

5957
// Entire conformance is doomed, so we didn't proceed to checking the functions; that's fine
6058
distributed func testAT() async throws -> NotCodable { .init() }

0 commit comments

Comments
 (0)