-
Notifications
You must be signed in to change notification settings - Fork 10.4k
/
Copy pathDistributedDecl.cpp
1582 lines (1296 loc) · 46.4 KB
/
DistributedDecl.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//===--- Decl.cpp - Swift Language Decl ASTs ------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// This file handles lookups related to distributed actor decls.
//
//===----------------------------------------------------------------------===//
#include "swift/AST/DistributedDecl.h"
#include "swift/AST/AccessRequests.h"
#include "swift/AST/AccessScope.h"
#include "swift/AST/ASTContext.h"
#include "swift/AST/ASTWalker.h"
#include "swift/AST/ASTMangler.h"
#include "swift/AST/ConformanceLookup.h"
#include "swift/AST/ExistentialLayout.h"
#include "swift/AST/Expr.h"
#include "swift/AST/ForeignAsyncConvention.h"
#include "swift/AST/ForeignErrorConvention.h"
#include "swift/AST/GenericEnvironment.h"
#include "swift/AST/GenericSignature.h"
#include "swift/AST/Initializer.h"
#include "swift/AST/LazyResolver.h"
#include "swift/AST/ASTMangler.h"
#include "swift/AST/Module.h"
#include "swift/AST/NameLookup.h"
#include "swift/AST/NameLookupRequests.h"
#include "swift/AST/ParseRequests.h"
#include "swift/AST/PropertyWrappers.h"
#include "swift/AST/ProtocolConformance.h"
#include "swift/AST/ResilienceExpansion.h"
#include "swift/AST/SourceFile.h"
#include "swift/AST/Stmt.h"
#include "swift/AST/TypeCheckRequests.h"
#include "swift/AST/SwiftNameTranslation.h"
#include "swift/Basic/Assertions.h"
#include "swift/ClangImporter/ClangModule.h"
#include "swift/Parse/Lexer.h" // FIXME: Bad dependency
#include "clang/Lex/MacroInfo.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/SmallSet.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/raw_ostream.h"
#include "swift/Basic/StringExtras.h"
#include "clang/Basic/CharInfo.h"
#include "clang/Basic/Module.h"
#include "clang/AST/Attr.h"
#include "clang/AST/DeclObjC.h"
#include <algorithm>
using namespace swift;
/******************************************************************************/
/******************* Distributed Actor Conformances ***************************/
/******************************************************************************/
bool swift::canSynthesizeDistributedActorCodableConformance(NominalTypeDecl *actor) {
auto &C = actor->getASTContext();
if (!actor->isDistributedActor())
return false;
return evaluateOrDefault(
C.evaluator,
CanSynthesizeDistributedActorCodableConformanceRequest{actor},
false);
}
ExtensionDecl *
swift::findDistributedActorAsActorExtension(
ProtocolDecl *distributedActorProto) {
ASTContext &C = distributedActorProto->getASTContext();
auto name = C.getIdentifier("__actorUnownedExecutor");
auto results = distributedActorProto->lookupDirect(
name, SourceLoc(),
NominalTypeDecl::LookupDirectFlags::IncludeAttrImplements);
for (auto result : results) {
if (auto var = dyn_cast<VarDecl>(result)) {
return dyn_cast<ExtensionDecl>(var->getDeclContext());
}
}
return nullptr;
}
bool swift::isDistributedActorAsLocalActorComputedProperty(VarDecl *var) {
auto &C = var->getASTContext();
return var->getName() == C.Id_asLocalActor &&
var->getDeclContext()->getSelfProtocolDecl() &&
var->getDeclContext()->getSelfProtocolDecl()->isSpecificProtocol(
KnownProtocolKind::DistributedActor);
}
VarDecl *
swift::getDistributedActorAsLocalActorComputedProperty(ModuleDecl *module) {
auto &C = module->getASTContext();
auto DA = C.getDistributedActorDecl();
if (!DA)
return nullptr;
auto extension = findDistributedActorAsActorExtension(DA);
if (!extension)
return nullptr;
for (auto decl : extension->getMembers()) {
if (auto var = dyn_cast<VarDecl>(decl)) {
if (isDistributedActorAsLocalActorComputedProperty(var)) {
return var;
}
}
}
return nullptr;
}
ProtocolConformanceRef
swift::getDistributedActorAsActorConformanceRef(ASTContext &C) {
auto distributedActorAsActorConformance =
getDistributedActorAsActorConformance(C);
return ProtocolConformanceRef(distributedActorAsActorConformance);
}
NormalProtocolConformance *
swift::getDistributedActorAsActorConformance(ASTContext &C) {
auto distributedActorProtocol = C.getProtocol(KnownProtocolKind::DistributedActor);
return evaluateOrDefault(
C.evaluator,
GetDistributedActorAsActorConformanceRequest{distributedActorProtocol},
nullptr);
}
/******************************************************************************/
/************** Distributed Actor System Associated Types *********************/
/******************************************************************************/
// TODO(distributed): make into a request
Type swift::getConcreteReplacementForProtocolActorSystemType(
ValueDecl *anyValue) {
auto &C = anyValue->getASTContext();
// FIXME(distributed): clean this up, we want a method that gets us AS type
// given any value, but is this the best way?
DeclContext *DC;
if (auto nominal = dyn_cast<NominalTypeDecl>(anyValue)) {
DC = nominal;
} else if (auto extension = dyn_cast<ExtensionDecl>(anyValue)) {
DC = extension->getExtendedNominal();
} else {
DC = anyValue->getDeclContext();
}
auto DA = C.getDistributedActorDecl();
// === When declared inside an actor, we can get the type directly
if (auto classDecl = DC->getSelfClassDecl()) {
return getDistributedActorSystemType(classDecl);
}
/// === Maybe the value is declared in a protocol?
if (DC->getSelfProtocolDecl()) {
GenericSignature signature;
if (auto *genericContext = anyValue->getAsGenericContext()) {
signature = genericContext->getGenericSignature();
} else {
signature = DC->getGenericSignatureOfContext();
}
auto ActorSystemAssocType =
DA->getAssociatedType(C.Id_ActorSystem)->getDeclaredInterfaceType();
// Note that this may be null, e.g. if we're a distributed func inside
// a protocol that did not declare a specific actor system requirement.
return signature->getConcreteType(ActorSystemAssocType);
}
llvm_unreachable("Unable to fetch ActorSystem type!");
}
Type swift::getDistributedActorSystemType(NominalTypeDecl *actor) {
assert(!dyn_cast<ProtocolDecl>(actor) &&
"Use getConcreteReplacementForProtocolActorSystemType instead to get"
"the concrete ActorSystem, if bound, for this DistributedActor "
"constrained ProtocolDecl!");
assert(actor->isDistributedActor());
auto &C = actor->getASTContext();
auto DA = C.getDistributedActorDecl();
if (!DA)
return ErrorType::get(C); // FIXME(distributed): just use Type()
// Dig out the actor system type.
Type selfType = actor->getSelfInterfaceType();
auto conformance = lookupConformance(selfType, DA);
return conformance.getTypeWitnessByName(selfType, C.Id_ActorSystem);
}
Type swift::getDistributedActorIDType(NominalTypeDecl *actor) {
auto &C = actor->getASTContext();
return getAssociatedTypeOfDistributedSystemOfActor(actor, C.Id_ActorID);
}
static Type getTypeWitnessByName(NominalTypeDecl *type, ProtocolDecl *protocol,
Identifier member) {
if (!protocol)
return ErrorType::get(type->getASTContext());
Type selfType = type->getSelfInterfaceType();
auto conformance = lookupConformance(selfType, protocol);
if (!conformance || conformance.isInvalid())
return Type();
return conformance.getTypeWitnessByName(selfType, member);
}
Type swift::getDistributedActorSerializationType(
DeclContext *actorOrExtension) {
auto &ctx = actorOrExtension->getASTContext();
auto resultTy = getAssociatedTypeOfDistributedSystemOfActor(
actorOrExtension,
ctx.Id_SerializationRequirement);
// Protocols are allowed to either not provide a `SerializationRequirement`
// at all or provide it in a conformance requirement.
if ((!resultTy || resultTy->hasDependentMember()) &&
actorOrExtension->getSelfProtocolDecl()) {
auto sig = actorOrExtension->getGenericSignatureOfContext();
auto actorProtocol = ctx.getProtocol(KnownProtocolKind::DistributedActor);
if (!actorProtocol)
return Type();
auto serializationTy =
actorProtocol->getAssociatedType(ctx.Id_SerializationRequirement)
->getDeclaredInterfaceType();
return sig->getExistentialType(serializationTy);
}
return resultTy;
}
Type swift::getDistributedActorSystemSerializationType(
NominalTypeDecl *system) {
assert(!system->isDistributedActor());
auto &ctx = system->getASTContext();
return getTypeWitnessByName(system, ctx.getDistributedActorSystemDecl(),
ctx.Id_SerializationRequirement);
}
Type swift::getDistributedActorSystemActorIDType(NominalTypeDecl *system) {
assert(!system->isDistributedActor());
auto &ctx = system->getASTContext();
return getTypeWitnessByName(system, ctx.getDistributedActorSystemDecl(),
ctx.Id_ActorID);
}
Type swift::getDistributedActorSystemResultHandlerType(
NominalTypeDecl *system) {
assert(!system->isDistributedActor());
auto &ctx = system->getASTContext();
return getTypeWitnessByName(system, ctx.getDistributedActorSystemDecl(),
ctx.Id_ResultHandler);
}
Type swift::getDistributedActorSystemInvocationEncoderType(NominalTypeDecl *system) {
assert(!system->isDistributedActor());
auto &ctx = system->getASTContext();
return getTypeWitnessByName(system, ctx.getDistributedActorSystemDecl(),
ctx.Id_InvocationEncoder);
}
Type swift::getDistributedActorSystemInvocationDecoderType(NominalTypeDecl *system) {
assert(!system->isDistributedActor());
auto &ctx = system->getASTContext();
return getTypeWitnessByName(system, ctx.getDistributedActorSystemDecl(),
ctx.Id_InvocationDecoder);
}
Type swift::getDistributedSerializationRequirementType(
NominalTypeDecl *nominal, ProtocolDecl *protocol) {
assert(nominal);
auto &ctx = nominal->getASTContext();
if (!protocol)
return Type();
// Dig out the serialization requirement type.
Type selfType = nominal->getSelfInterfaceType();
auto conformance = lookupConformance(selfType, protocol);
if (conformance.isInvalid())
return Type();
return conformance.getTypeWitnessByName(selfType,
ctx.Id_SerializationRequirement);
}
AbstractFunctionDecl *
swift::getAssociatedDistributedInvocationDecoderDecodeNextArgumentFunction(
ValueDecl *thunk) {
assert(thunk);
auto *actor = thunk->getDeclContext()->getSelfNominalTypeDecl();
if (!actor)
return nullptr;
if (!actor->isDistributedActor())
return nullptr;
auto systemTy = getConcreteReplacementForProtocolActorSystemType(thunk);
if (!systemTy || systemTy->is<GenericTypeParamType>())
return nullptr;
auto decoderTy =
getDistributedActorSystemInvocationDecoderType(
systemTy->getAnyNominal());
if (!decoderTy)
return nullptr;
return getDecodeNextArgumentOnDistributedInvocationDecoder(
decoderTy->getAnyNominal());
}
Type swift::getAssociatedTypeOfDistributedSystemOfActor(
DeclContext *actorOrExtension, Identifier member) {
auto &ctx = actorOrExtension->getASTContext();
auto actorProtocol = ctx.getProtocol(KnownProtocolKind::DistributedActor);
if (!actorProtocol)
return Type();
AssociatedTypeDecl *actorSystemDecl =
actorProtocol->getAssociatedType(ctx.Id_ActorSystem);
if (!actorSystemDecl)
return Type();
auto actorSystemProtocol = ctx.getDistributedActorSystemDecl();
if (!actorSystemProtocol)
return Type();
AssociatedTypeDecl *memberTypeDecl =
actorSystemProtocol->getAssociatedType(member);
if (!memberTypeDecl)
return Type();
Type memberTy = DependentMemberType::get(
DependentMemberType::get(actorProtocol->getSelfInterfaceType(),
actorSystemDecl),
memberTypeDecl);
auto sig = actorOrExtension->getGenericSignatureOfContext();
auto *actorType = actorOrExtension->getSelfNominalTypeDecl();
if (isa<ProtocolDecl>(actorType))
return memberTy->getReducedType(sig);
auto actorConformance =
lookupConformance(
actorType->getDeclaredInterfaceType(), actorProtocol);
if (!actorConformance || actorConformance.isInvalid())
return Type();
auto subs = SubstitutionMap::getProtocolSubstitutions(
actorProtocol, actorType->getDeclaredInterfaceType(), actorConformance);
memberTy = memberTy.subst(subs);
// If substitution is still not fully resolved, let's see if we can
// find a concrete replacement in the generic signature.
if (memberTy->hasTypeParameter() && sig) {
if (auto concreteTy = sig->getConcreteType(memberTy))
return concreteTy;
}
return memberTy;
}
/******************************************************************************/
/******** Functions on DistributedActorSystem and friends *********************/
/******************************************************************************/
FuncDecl *
swift::getDistributedActorArgumentDecodingMethod(NominalTypeDecl *actor) {
auto &ctx = actor->getASTContext();
return evaluateOrDefault(
ctx.evaluator,
GetDistributedActorConcreteArgumentDecodingMethodRequest{actor}, nullptr);
}
NominalTypeDecl *
swift::getDistributedActorInvocationDecoder(NominalTypeDecl *actor) {
if (!actor->isDistributedActor())
return nullptr;
auto &ctx = actor->getASTContext();
return evaluateOrDefault(ctx.evaluator,
GetDistributedActorInvocationDecoderRequest{actor},
nullptr);
}
bool
swift::getDistributedSerializationRequirements(
NominalTypeDecl *nominal,
ProtocolDecl *protocol,
llvm::SmallPtrSetImpl<ProtocolDecl *> &requirementProtos) {
auto existentialRequirementTy =
getDistributedSerializationRequirementType(nominal, protocol);
if (existentialRequirementTy->hasError()) {
return false;
}
if (existentialRequirementTy->isAny())
return true; // we're done here, any means there are no requirements
auto *serialReqType = existentialRequirementTy->getAs<ExistentialType>();
if (!serialReqType || serialReqType->hasError()) {
return false;
}
auto layout = serialReqType->getExistentialLayout();
for (auto p : layout.getProtocols()) {
requirementProtos.insert(p);
}
return true;
}
bool swift::checkDistributedSerializationRequirementIsExactlyCodable(
ASTContext &C,
Type type) {
if (!type)
return false;
if (type->hasError())
return false;
auto encodable = C.getProtocol(KnownProtocolKind::Encodable);
auto decodable = C.getProtocol(KnownProtocolKind::Decodable);
auto layout = type->getExistentialLayout();
auto protocols = layout.getProtocols();
if (protocols.size() != 2)
return false;
return std::count(protocols.begin(), protocols.end(), encodable) == 1 &&
std::count(protocols.begin(), protocols.end(), decodable) == 1;
}
// TODO(distributed): probably can be removed?
llvm::ArrayRef<ValueDecl *>
AbstractFunctionDecl::getDistributedMethodWitnessedProtocolRequirements() const {
auto mutableThis = const_cast<AbstractFunctionDecl *>(this);
// Only a 'distributed' decl can witness 'distributed' protocol
if (!isDistributed()) {
return llvm::ArrayRef<ValueDecl *>();
}
return evaluateOrDefault(
getASTContext().evaluator,
GetDistributedMethodWitnessedProtocolRequirements(mutableThis), {});
}
/******************************************************************************/
/********************* Ad-hoc protocol requirement checks *********************/
/******************************************************************************/
bool AbstractFunctionDecl::isDistributedActorSystemRemoteCall(bool isVoidReturn) const {
auto &C = getASTContext();
auto *DC = getDeclContext();
if (!DC->isTypeContext() || !isGeneric())
return false;
// === Check the name
auto callId = isVoidReturn ? C.Id_remoteCallVoid : C.Id_remoteCall;
if (getBaseName() != callId) {
return false;
}
// === Must be declared in a 'DistributedActorSystem' conforming type
ProtocolDecl *systemProto =
C.getDistributedActorSystemDecl();
auto systemNominal = DC->getSelfNominalTypeDecl();
auto distSystemConformance = lookupConformance(
systemNominal->getDeclaredInterfaceType(), systemProto);
if (distSystemConformance.isInvalid()) {
return false;
}
auto *func = dyn_cast<FuncDecl>(this);
if (!func) {
return false;
}
// === Structural Checks
// -- Must be throwing
if (!hasThrows()) {
return false;
}
// -- Must be async
if (!hasAsync()) {
return false;
}
// -- Must not be mutating, use classes to implement a system instead
if (func->isMutating()) {
return false;
}
// === Check generics
if (!isGeneric()) {
return false;
}
// --- Check number of generic parameters
auto genericParams = getGenericParams();
unsigned int expectedGenericParamNum = isVoidReturn ? 2 : 3;
if (genericParams->size() != expectedGenericParamNum) {
return false;
}
// === Get the SerializationRequirement
SmallPtrSet<ProtocolDecl*, 2> requirementProtos;
if (!getDistributedSerializationRequirements(
systemNominal, systemProto, requirementProtos)) {
return false;
}
// -- Check number of generic requirements
size_t expectedRequirementsNum = 3;
size_t serializationRequirementsNum = 0;
if (!isVoidReturn) {
serializationRequirementsNum = requirementProtos.size();
expectedRequirementsNum += serializationRequirementsNum;
}
// === Check all parameters
auto params = getParameters();
// --- Count of parameters depends on if we're void returning or not
unsigned int expectedParamNum = isVoidReturn ? 4 : 5;
if (!params || params->size() != expectedParamNum) {
return false;
}
// --- Check parameter: on: Actor
auto actorParam = params->get(0);
if (actorParam->getArgumentName() != C.Id_on) {
return false;
}
// --- Check parameter: target RemoteCallTarget
auto targetParam = params->get(1);
if (targetParam->getArgumentName() != C.Id_target) {
return false;
}
// --- Check parameter: invocation: inout InvocationEncoder
auto invocationParam = params->get(2);
if (invocationParam->getArgumentName() != C.Id_invocation) {
return false;
}
if (!invocationParam->isInOut()) {
return false;
}
// --- Check parameter: throwing: Err.Type
auto thrownTypeParam = params->get(3);
if (thrownTypeParam->getArgumentName() != C.Id_throwing) {
return false;
}
// --- Check parameter: returning: Res.Type
if (!isVoidReturn) {
auto returnedTypeParam = params->get(4);
if (returnedTypeParam->getArgumentName() != C.Id_returning) {
return false;
}
}
// === Check generic parameters in detail
// --- Check: Act: DistributedActor,
// Act.ID == Self.ActorID
GenericTypeParamDecl *ActParam = genericParams->getParams()[0];
auto ActConformance = lookupConformance(
mapTypeIntoContext(ActParam->getDeclaredInterfaceType()),
C.getProtocol(KnownProtocolKind::DistributedActor));
if (ActConformance.isInvalid()) {
return false;
}
// --- Check: Err: Error
GenericTypeParamDecl *ErrParam = genericParams->getParams()[1];
auto ErrConformance = lookupConformance(
mapTypeIntoContext(ErrParam->getDeclaredInterfaceType()),
C.getProtocol(KnownProtocolKind::Error));
if (ErrConformance.isInvalid()) {
return false;
}
// --- Check: Res: SerializationRequirement
// We could have the `SerializationRequirement = Any` in which case there are
// no requirements to check on `Res`
GenericTypeParamDecl *ResParam = nullptr;
if (!isVoidReturn) {
ResParam = genericParams->getParams().back();
}
auto sig = getGenericSignature();
SmallVector<Requirement, 2> reqs;
SmallVector<InverseRequirement, 2> inverseReqs;
sig->getRequirementsWithInverses(reqs, inverseReqs);
assert(inverseReqs.empty() && "Non-copyable generics not supported here!");
if (reqs.size() != expectedRequirementsNum) {
return false;
}
// --- Check the expected requirements
// conforms_to: Act DistributedActor
// conforms_to: Err Error
// --- all the Res requirements ---
// conforms_to: Res Decodable
// conforms_to: Res Encodable
// ...
// --------------------------------
// same_type: Act.ID FakeActorSystem.ActorID // LAST one
// --- Check requirement: conforms_to: Act DistributedActor
auto actorReq = reqs[0];
if (actorReq.getKind() != RequirementKind::Conformance) {
return false;
}
if (!actorReq.getProtocolDecl()->isSpecificProtocol(KnownProtocolKind::DistributedActor)) {
return false;
}
// --- Check requirement: conforms_to: Err Error
auto errorReq = reqs[1];
if (errorReq.getKind() != RequirementKind::Conformance) {
return false;
}
if (!errorReq.getProtocolDecl()->isSpecificProtocol(KnownProtocolKind::Error)) {
return false;
}
// --- Check requirement: Res either Void or all SerializationRequirements
if (isVoidReturn) {
if (auto func = dyn_cast<FuncDecl>(this)) {
if (!func->getResultInterfaceType()->isVoid()) {
return false;
}
}
} else if (ResParam) {
assert(ResParam && "Non void function, yet no Res generic parameter found");
if (auto func = dyn_cast<FuncDecl>(this)) {
auto resultType = func->mapTypeIntoContext(func->getResultInterfaceType())
->getMetatypeInstanceType();
auto resultParamType = func->mapTypeIntoContext(
ResParam->getDeclaredInterfaceType());
// The result of the function must be the `Res` generic argument.
if (!resultType->isEqual(resultParamType)) {
return false;
}
for (auto requirementProto : requirementProtos) {
auto conformance = lookupConformance(resultType, requirementProto);
if (conformance.isInvalid()) {
return false;
}
}
} else {
return false;
}
}
// -- Check requirement: same_type Actor.ID Self.ActorID
auto actorIdReq = reqs.back();
if (actorIdReq.getKind() != RequirementKind::SameType) {
return false;
}
auto expectedActorIdTy = getDistributedActorSystemActorIDType(systemNominal);
if (!actorIdReq.getSecondType()->isEqual(expectedActorIdTy)) {
return false;
}
return true;
}
bool
AbstractFunctionDecl::isDistributedActorSystemMakeInvocationEncoder() const {
auto &C = getASTContext();
if (getBaseIdentifier() != C.Id_makeInvocationEncoder) {
return false;
}
auto *func = dyn_cast<FuncDecl>(this);
if (!func) {
return false;
}
if (func->getParameters()->size() != 0) {
return false;
}
if (func->hasAsync()) {
return false;
}
if (func->hasThrows()) {
return false;
}
auto returnTy = func->getResultInterfaceType();
auto conformance = lookupConformance(
returnTy, C.getDistributedTargetInvocationEncoderDecl());
if (conformance.isInvalid()) {
return false;
}
return true;
}
bool
AbstractFunctionDecl::isDistributedTargetInvocationEncoderRecordGenericSubstitution() const {
auto &C = getASTContext();
if (getBaseIdentifier() != C.Id_recordGenericSubstitution) {
return false;
}
auto *fd = dyn_cast<FuncDecl>(this);
if (!fd) {
return false;
}
if (fd->getParameters()->size() != 1) {
return false;
}
if (fd->hasAsync()) {
return false;
}
if (!fd->hasThrows()) {
return false;
}
// TODO(distributed): more checks
// A single generic parameter.
auto genericParamList = fd->getGenericParams();
if (genericParamList->size() != 1) {
return false;
}
SmallVector<Requirement, 2> reqs;
SmallVector<InverseRequirement, 2> inverseReqs;
fd->getGenericSignature()->getRequirementsWithInverses(reqs, inverseReqs);
assert(inverseReqs.empty() && "Non-copyable generics not supported here!");
// No requirements on the generic parameter
if (!reqs.empty())
return false;
if (!fd->getResultInterfaceType()->isVoid())
return false;
return true;
}
bool
AbstractFunctionDecl::isDistributedTargetInvocationEncoderRecordArgument() const {
auto &C = getASTContext();
auto func = dyn_cast<FuncDecl>(this);
if (!func) {
return false;
}
// === Check base name
if (getBaseIdentifier() != C.Id_recordArgument) {
return false;
}
// === Must be declared in a 'DistributedTargetInvocationEncoder' conforming type
ProtocolDecl *encoderProto =
C.getProtocol(KnownProtocolKind::DistributedTargetInvocationEncoder);
auto encoderNominal = getDeclContext()->getSelfNominalTypeDecl();
auto protocolConformance = lookupConformance(
encoderNominal->getDeclaredInterfaceType(), encoderProto);
if (protocolConformance.isInvalid()) {
return false;
}
// === Check modifiers
// --- must not be async
if (hasAsync()) {
return false;
}
// --- must be throwing
if (!hasThrows()) {
return false;
}
// === Check generics
if (!isGeneric()) {
return false;
}
// --- must be mutating, if it is defined in a struct
if (isa<StructDecl>(getDeclContext()) &&
!func->isMutating()) {
return false;
}
// --- Check number of generic parameters
auto genericParams = getGenericParams();
unsigned int expectedGenericParamNum = 1;
if (genericParams->size() != expectedGenericParamNum) {
return false;
}
// === Get the SerializationRequirement
SmallPtrSet<ProtocolDecl*, 2> requirementProtos;
if (!getDistributedSerializationRequirements(
encoderNominal, encoderProto, requirementProtos)) {
return false;
}
// -- Check number of generic requirements
size_t serializationRequirementsNum = requirementProtos.size();
size_t expectedRequirementsNum = serializationRequirementsNum;
// === Check all parameters
auto params = getParameters();
if (params->size() != 1) {
return false;
}
GenericTypeParamDecl *ArgumentParam = genericParams->getParams()[0];
// --- Check parameter: _ argument
auto argumentParam = params->get(0);
if (!argumentParam->getArgumentName().empty()) {
return false;
}
auto argumentTy = argumentParam->getInterfaceType();
auto argumentInContextTy = mapTypeIntoContext(argumentTy);
if (argumentInContextTy->getAnyNominal() == C.getRemoteCallArgumentDecl()) {
auto argGenericParams = argumentInContextTy->getStructOrBoundGenericStruct()
->getGenericParams()->getParams();
if (argGenericParams.size() != 1) {
return false;
}
// the <Value> of the RemoteCallArgument<Value>
auto remoteCallArgValueGenericTy =
mapTypeIntoContext(argGenericParams[0]->getDeclaredInterfaceType());
// expected (the <Value> from the recordArgument<Value>)
auto expectedGenericParamTy = mapTypeIntoContext(
ArgumentParam->getDeclaredInterfaceType());
if (!remoteCallArgValueGenericTy->isEqual(expectedGenericParamTy)) {
return false;
}
} else {
return false;
}
auto sig = getGenericSignature();
SmallVector<Requirement, 2> reqs;
SmallVector<InverseRequirement, 2> inverseReqs;
sig->getRequirementsWithInverses(reqs, inverseReqs);
assert(inverseReqs.empty() && "Non-copyable generics not supported here!");
if (reqs.size() != expectedRequirementsNum) {
return false;
}
// --- Check the expected requirements
// --- all the Argument requirements ---
// e.g.
// conforms_to: Argument Decodable
// conforms_to: Argument Encodable
// ...
// === Check result type: Void
if (!func->getResultInterfaceType()->isVoid()) {
return false;
}
return true;
}
bool
AbstractFunctionDecl::isDistributedTargetInvocationEncoderRecordReturnType() const {
auto &C = getASTContext();
auto func = dyn_cast<FuncDecl>(this);
if (!func) {
return false;
}
// === Check base name
if (getBaseIdentifier() != C.Id_recordReturnType) {
return false;
}
// === Must be declared in a 'DistributedTargetInvocationEncoder' conforming type
ProtocolDecl *encoderProto =
C.getProtocol(KnownProtocolKind::DistributedTargetInvocationEncoder);
auto encoderNominal = getDeclContext()->getSelfNominalTypeDecl();
auto protocolConformance = lookupConformance(
encoderNominal->getDeclaredInterfaceType(), encoderProto);
if (protocolConformance.isInvalid()) {
return false;
}
// === Check modifiers
// --- must not be async
if (hasAsync()) {
return false;
}
// --- must be throwing
if (!hasThrows()) {
return false;
}
// --- must be mutating, if it is defined in a struct
if (isa<StructDecl>(getDeclContext()) &&
!func->isMutating()) {
return false;
}
// === Check generics
if (!isGeneric()) {
return false;
}
// --- Check number of generic parameters
auto genericParams = getGenericParams();
unsigned int expectedGenericParamNum = 1;
if (genericParams->size() != expectedGenericParamNum) {
return false;
}
// === Get the SerializationRequirement
SmallPtrSet<ProtocolDecl*, 2> requirementProtos;
if (!getDistributedSerializationRequirements(
encoderNominal, encoderProto, requirementProtos)) {
return false;
}
// -- Check number of generic requirements
size_t serializationRequirementsNum = requirementProtos.size();
size_t expectedRequirementsNum = serializationRequirementsNum;
// === Check all parameters
auto params = getParameters();
if (params->size() != 1) {
return false;
}
// --- Check parameter: _ argument
auto argumentParam = params->get(0);
if (!argumentParam->getArgumentName().is("")) {
return false;
}
// === Check generic parameters in detail
// --- Check: Argument: SerializationRequirement
GenericTypeParamDecl *ArgumentParam = genericParams->getParams()[0];
auto sig = getGenericSignature();
SmallVector<Requirement, 2> reqs;
SmallVector<InverseRequirement, 2> inverseReqs;
sig->getRequirementsWithInverses(reqs, inverseReqs);
assert(inverseReqs.empty() && "Non-copyable generics not supported here!");