-
Notifications
You must be signed in to change notification settings - Fork 10.5k
/
Copy pathDeserializeSIL.cpp
3296 lines (2967 loc) · 128 KB
/
DeserializeSIL.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
//===--- DeserializeSIL.cpp - Read SIL ------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 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
//
//===----------------------------------------------------------------------===//
#define DEBUG_TYPE "deserialize"
#include "DeserializeSIL.h"
#include "DeserializationErrors.h"
#include "SILFormat.h"
#include "SILSerializationFunctionBuilder.h"
#include "swift/AST/GenericSignature.h"
#include "swift/AST/PrettyStackTrace.h"
#include "swift/AST/ProtocolConformance.h"
#include "swift/Basic/Defer.h"
#include "swift/Basic/PrettyStackTrace.h"
#include "swift/SIL/SILArgument.h"
#include "swift/SIL/SILBuilder.h"
#include "swift/SIL/SILDebugScope.h"
#include "swift/SIL/SILModule.h"
#include "swift/SIL/SILUndef.h"
#include "swift/Serialization/BCReadingExtras.h"
#include "swift/Serialization/ModuleFile.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/DJB.h"
#include "llvm/Support/OnDiskHashTable.h"
#include <type_traits>
using namespace swift;
using namespace swift::serialization;
using namespace swift::serialization::sil_block;
using namespace llvm::support;
const char SILEntityError::ID = '\0';
void SILEntityError::anchor() {}
STATISTIC(NumDeserializedFunc, "Number of deserialized SIL functions");
static Optional<StringLiteralInst::Encoding>
fromStableStringEncoding(unsigned value) {
switch (value) {
case SIL_BYTES: return StringLiteralInst::Encoding::Bytes;
case SIL_UTF8: return StringLiteralInst::Encoding::UTF8;
case SIL_UTF16: return StringLiteralInst::Encoding::UTF16;
case SIL_OBJC_SELECTOR: return StringLiteralInst::Encoding::ObjCSelector;
default: return None;
}
}
static Optional<SILLinkage>
fromStableSILLinkage(unsigned value) {
switch (value) {
case SIL_LINKAGE_PUBLIC: return SILLinkage::Public;
case SIL_LINKAGE_PUBLIC_NON_ABI: return SILLinkage::PublicNonABI;
case SIL_LINKAGE_HIDDEN: return SILLinkage::Hidden;
case SIL_LINKAGE_SHARED: return SILLinkage::Shared;
case SIL_LINKAGE_PRIVATE: return SILLinkage::Private;
case SIL_LINKAGE_PUBLIC_EXTERNAL: return SILLinkage::PublicExternal;
case SIL_LINKAGE_HIDDEN_EXTERNAL: return SILLinkage::HiddenExternal;
case SIL_LINKAGE_SHARED_EXTERNAL: return SILLinkage::SharedExternal;
case SIL_LINKAGE_PRIVATE_EXTERNAL: return SILLinkage::PrivateExternal;
default: return None;
}
}
static Optional<SILVTable::Entry::Kind>
fromStableVTableEntryKind(unsigned value) {
switch (value) {
case SIL_VTABLE_ENTRY_NORMAL: return SILVTable::Entry::Kind::Normal;
case SIL_VTABLE_ENTRY_INHERITED: return SILVTable::Entry::Kind::Inherited;
case SIL_VTABLE_ENTRY_OVERRIDE: return SILVTable::Entry::Kind::Override;
default: return None;
}
}
/// Used to deserialize entries in the on-disk func hash table.
class SILDeserializer::FuncTableInfo {
ModuleFile &MF;
public:
using internal_key_type = StringRef;
using external_key_type = StringRef;
using data_type = DeclID;
using hash_value_type = uint32_t;
using offset_type = unsigned;
explicit FuncTableInfo(ModuleFile &MF) : MF(MF) {}
internal_key_type GetInternalKey(external_key_type ID) { return ID; }
external_key_type GetExternalKey(internal_key_type ID) { return ID; }
hash_value_type ComputeHash(internal_key_type key) {
// FIXME: DJB seed=0, audit whether the default seed could be used.
return llvm::djbHash(key, 0);
}
static bool EqualKey(internal_key_type lhs, internal_key_type rhs) {
return lhs == rhs;
}
static std::pair<unsigned, unsigned> ReadKeyDataLength(const uint8_t *&data) {
return { sizeof(uint32_t), sizeof(uint32_t) };
}
internal_key_type ReadKey(const uint8_t *data, unsigned length) {
assert(length == sizeof(uint32_t) && "Expect a single IdentifierID.");
IdentifierID keyID = endian::readNext<uint32_t, little, unaligned>(data);
return MF.getIdentifierText(keyID);
}
static data_type ReadData(internal_key_type key, const uint8_t *data,
unsigned length) {
assert(length == sizeof(uint32_t) && "Expect a single DeclID.");
data_type result = endian::readNext<uint32_t, little, unaligned>(data);
return result;
}
};
SILDeserializer::SILDeserializer(
ModuleFile *MF, SILModule &M,
DeserializationNotificationHandlerSet *callback)
: MF(MF), SILMod(M), Callback(callback) {
SILCursor = MF->getSILCursor();
SILIndexCursor = MF->getSILIndexCursor();
// Early return if either sil block or sil index block does not exist.
if (SILCursor.AtEndOfStream() || SILIndexCursor.AtEndOfStream())
return;
// Load any abbrev records at the start of the block.
SILCursor.advance();
llvm::BitstreamCursor cursor = SILIndexCursor;
// We expect SIL_FUNC_NAMES first, then SIL_VTABLE_NAMES, then
// SIL_GLOBALVAR_NAMES, then SIL_WITNESS_TABLE_NAMES, and finally
// SIL_DEFAULT_WITNESS_TABLE_NAMES. But each one can be
// omitted if no entries exist in the module file.
unsigned kind = 0;
while (kind != sil_index_block::SIL_PROPERTY_OFFSETS) {
auto next = cursor.advance();
if (next.Kind == llvm::BitstreamEntry::EndBlock)
return;
SmallVector<uint64_t, 4> scratch;
StringRef blobData;
unsigned prevKind = kind;
kind = cursor.readRecord(next.ID, scratch, &blobData);
assert((next.Kind == llvm::BitstreamEntry::Record &&
kind > prevKind &&
(kind == sil_index_block::SIL_FUNC_NAMES ||
kind == sil_index_block::SIL_VTABLE_NAMES ||
kind == sil_index_block::SIL_GLOBALVAR_NAMES ||
kind == sil_index_block::SIL_WITNESS_TABLE_NAMES ||
kind == sil_index_block::SIL_DEFAULT_WITNESS_TABLE_NAMES ||
kind == sil_index_block::SIL_PROPERTY_OFFSETS)) &&
"Expect SIL_FUNC_NAMES, SIL_VTABLE_NAMES, SIL_GLOBALVAR_NAMES, \
SIL_WITNESS_TABLE_NAMES, or SIL_DEFAULT_WITNESS_TABLE_NAMES.");
(void)prevKind;
if (kind == sil_index_block::SIL_FUNC_NAMES)
FuncTable = readFuncTable(scratch, blobData);
else if (kind == sil_index_block::SIL_VTABLE_NAMES)
VTableList = readFuncTable(scratch, blobData);
else if (kind == sil_index_block::SIL_GLOBALVAR_NAMES)
GlobalVarList = readFuncTable(scratch, blobData);
else if (kind == sil_index_block::SIL_WITNESS_TABLE_NAMES)
WitnessTableList = readFuncTable(scratch, blobData);
else if (kind == sil_index_block::SIL_DEFAULT_WITNESS_TABLE_NAMES)
DefaultWitnessTableList = readFuncTable(scratch, blobData);
else if (kind == sil_index_block::SIL_PROPERTY_OFFSETS) {
// No matching 'names' block for property descriptors needed yet.
MF->allocateBuffer(Properties, scratch);
return;
}
// Read SIL_FUNC|VTABLE|GLOBALVAR_OFFSETS record.
next = cursor.advance();
scratch.clear();
unsigned offKind = cursor.readRecord(next.ID, scratch, &blobData);
(void)offKind;
if (kind == sil_index_block::SIL_FUNC_NAMES) {
assert((next.Kind == llvm::BitstreamEntry::Record &&
offKind == sil_index_block::SIL_FUNC_OFFSETS) &&
"Expect a SIL_FUNC_OFFSETS record.");
MF->allocateBuffer(Funcs, scratch);
} else if (kind == sil_index_block::SIL_VTABLE_NAMES) {
assert((next.Kind == llvm::BitstreamEntry::Record &&
offKind == sil_index_block::SIL_VTABLE_OFFSETS) &&
"Expect a SIL_VTABLE_OFFSETS record.");
MF->allocateBuffer(VTables, scratch);
} else if (kind == sil_index_block::SIL_GLOBALVAR_NAMES) {
assert((next.Kind == llvm::BitstreamEntry::Record &&
offKind == sil_index_block::SIL_GLOBALVAR_OFFSETS) &&
"Expect a SIL_GLOBALVAR_OFFSETS record.");
MF->allocateBuffer(GlobalVars, scratch);
} else if (kind == sil_index_block::SIL_WITNESS_TABLE_NAMES) {
assert((next.Kind == llvm::BitstreamEntry::Record &&
offKind == sil_index_block::SIL_WITNESS_TABLE_OFFSETS) &&
"Expect a SIL_WITNESS_TABLE_OFFSETS record.");
MF->allocateBuffer(WitnessTables, scratch);
} else if (kind == sil_index_block::SIL_DEFAULT_WITNESS_TABLE_NAMES) {
assert((next.Kind == llvm::BitstreamEntry::Record &&
offKind == sil_index_block::SIL_DEFAULT_WITNESS_TABLE_OFFSETS) &&
"Expect a SIL_DEFAULT_WITNESS_TABLE_OFFSETS record.");
MF->allocateBuffer(DefaultWitnessTables, scratch);
}
}
}
std::unique_ptr<SILDeserializer::SerializedFuncTable>
SILDeserializer::readFuncTable(ArrayRef<uint64_t> fields, StringRef blobData) {
uint32_t tableOffset;
sil_index_block::ListLayout::readRecord(fields, tableOffset);
auto base = reinterpret_cast<const uint8_t *>(blobData.data());
using OwnedTable = std::unique_ptr<SerializedFuncTable>;
return OwnedTable(SerializedFuncTable::Create(base + tableOffset,
base + sizeof(uint32_t), base,
FuncTableInfo(*MF)));
}
/// A high-level overview of how forward references work in serializer and
/// deserializer:
/// In serializer, we pre-assign a value ID in order, to each basic block
/// argument and each SILInstruction that has a value.
/// In deserializer, we use LocalValues to store the definitions and
/// ForwardLocalValues for forward-referenced values (values that are
/// used but not yet defined). LocalValues are updated in setLocalValue where
/// the ID passed in assumes the same ordering as in serializer: in-order
/// for each basic block argument and each SILInstruction that has a value.
/// We update ForwardLocalValues in getLocalValue and when a value is defined
/// in setLocalValue, the corresponding entry in ForwardLocalValues will be
/// erased.
void SILDeserializer::setLocalValue(ValueBase *Value, ValueID Id) {
ValueBase *&Entry = LocalValues[Id];
assert(!Entry && "We should not redefine the same value.");
auto It = ForwardLocalValues.find(Id);
if (It != ForwardLocalValues.end()) {
// Take the information about the forward ref out of the map.
ValueBase *Placeholder = It->second;
// Remove the entries from the map.
ForwardLocalValues.erase(It);
Placeholder->replaceAllUsesWith(Value);
}
// Store it in our map.
Entry = Value;
}
SILValue SILDeserializer::getLocalValue(ValueID Id,
SILType Type) {
// The first two IDs are special undefined values.
if (Id == 0)
return SILUndef::get(Type, SILMod, ValueOwnershipKind::Any);
else if (Id == 1)
return SILUndef::get(Type, SILMod, ValueOwnershipKind::Owned);
// Check to see if this is already defined.
ValueBase *Entry = LocalValues.lookup(Id);
if (Entry) {
// If this value was already defined, check it to make sure types match.
assert(Entry->getType() == Type && "Value Type mismatch?");
return Entry;
}
// Otherwise, this is a forward reference. Create a dummy node to represent
// it until we see a real definition.
ValueBase *&Placeholder = ForwardLocalValues[Id];
if (!Placeholder)
Placeholder = new (SILMod) GlobalAddrInst(SILDebugLocation(), Type);
return Placeholder;
}
/// Return the SILBasicBlock of a given ID.
SILBasicBlock *SILDeserializer::getBBForDefinition(SILFunction *Fn,
SILBasicBlock *Prev,
unsigned ID) {
SILBasicBlock *&BB = BlocksByID[ID];
// If the block has never been named yet, just create it.
if (BB == nullptr) {
if (Prev) {
BB = Fn->createBasicBlockAfter(Prev);
} else {
BB = Fn->createBasicBlock();
}
return BB;
}
// If it already exists, it was either a forward reference or a redefinition.
// The latter should never happen.
bool wasForwardReferenced = UndefinedBlocks.erase(BB);
assert(wasForwardReferenced);
(void)wasForwardReferenced;
if (Prev)
BB->moveAfter(Prev);
return BB;
}
/// Return the SILBasicBlock of a given ID.
SILBasicBlock *SILDeserializer::getBBForReference(SILFunction *Fn,
unsigned ID) {
SILBasicBlock *&BB = BlocksByID[ID];
if (BB != nullptr)
return BB;
// Otherwise, create it and remember that this is a forward reference
BB = Fn->createBasicBlock();
UndefinedBlocks[BB] = ID;
return BB;
}
/// Helper function to convert from Type to SILType.
static SILType getSILType(Type Ty, SILValueCategory Category) {
auto TyLoc = TypeLoc::withoutLoc(Ty);
return SILType::getPrimitiveType(TyLoc.getType()->getCanonicalType(),
Category);
}
/// Helper function to find a SILFunction, given its name and type.
SILFunction *SILDeserializer::getFuncForReference(StringRef name,
SILType type) {
// Check to see if we have a function by this name already.
SILFunction *fn = SILMod.lookUpFunction(name);
if (!fn) {
// Otherwise, look for a function with this name in the module.
auto iter = FuncTable->find(name);
if (iter != FuncTable->end()) {
auto maybeFn = readSILFunctionChecked(*iter, nullptr, name,
/*declarationOnly*/ true);
if (maybeFn) {
fn = maybeFn.get();
} else {
// Ignore the failure; we'll synthesize a bogus function instead.
llvm::consumeError(maybeFn.takeError());
}
}
}
// FIXME: check for matching types.
// At this point, if fn is set, we know that we have a good function to use.
if (fn)
return fn;
// Otherwise, create a function declaration with the right type and a bogus
// source location. This ensures that we can at least parse the rest of the
// SIL.
SourceLoc sourceLoc;
SILSerializationFunctionBuilder builder(SILMod);
return builder.createDeclaration(name, type, RegularLocation(sourceLoc));
}
/// Helper function to find a SILFunction, given its name and type.
SILFunction *SILDeserializer::getFuncForReference(StringRef name) {
// Check to see if we have a function by this name already.
SILFunction *fn = SILMod.lookUpFunction(name);
if (fn)
return fn;
// Otherwise, look for a function with this name in the module.
auto iter = FuncTable->find(name);
if (iter == FuncTable->end())
return nullptr;
auto maybeFn = readSILFunctionChecked(*iter, nullptr, name,
/*declarationOnly*/ true);
if (!maybeFn) {
// Ignore the failure and just pretend the function doesn't exist
llvm::consumeError(maybeFn.takeError());
return nullptr;
}
return maybeFn.get();
}
/// Helper function to find a SILGlobalVariable given its name. It first checks
/// in the module. If we cannot find it in the module, we attempt to
/// deserialize it.
SILGlobalVariable *SILDeserializer::getGlobalForReference(StringRef name) {
// Check to see if we have a global by this name already.
if (SILGlobalVariable *g = SILMod.lookUpGlobalVariable(name))
return g;
// Otherwise, look for a global with this name in the module.
return readGlobalVar(name);
}
/// Deserialize a SILFunction if it is not already deserialized. The input
/// SILFunction can either be an empty declaration or null. If it is an empty
/// declaration, we fill in the contents. If the input SILFunction is
/// null, we create a SILFunction.
SILFunction *SILDeserializer::readSILFunction(DeclID FID,
SILFunction *existingFn,
StringRef name,
bool declarationOnly,
bool errorIfEmptyBody) {
llvm::Expected<SILFunction *> deserialized =
readSILFunctionChecked(FID, existingFn, name, declarationOnly,
errorIfEmptyBody);
if (!deserialized) {
MF->fatal(deserialized.takeError());
}
return deserialized.get();
}
llvm::Expected<SILFunction *>
SILDeserializer::readSILFunctionChecked(DeclID FID, SILFunction *existingFn,
StringRef name, bool declarationOnly,
bool errorIfEmptyBody) {
// We can't deserialize function bodies after IRGen lowering passes have
// happened since other definitions in the module will no longer be in
// canonical SIL form.
switch (SILMod.getStage()) {
case SILStage::Raw:
case SILStage::Canonical:
break;
case SILStage::Lowered:
llvm_unreachable("cannot deserialize into a module that has entered "
"Lowered stage");
}
if (FID == 0)
return nullptr;
assert(FID <= Funcs.size() && "invalid SILFunction ID");
PrettyStackTraceStringAction trace("deserializing SIL function", name);
auto &cacheEntry = Funcs[FID-1];
if (cacheEntry.isFullyDeserialized() ||
(cacheEntry.isDeserialized() && declarationOnly))
return cacheEntry.get();
BCOffsetRAII restoreOffset(SILCursor);
SILCursor.JumpToBit(cacheEntry.getOffset());
auto entry = SILCursor.advance(AF_DontPopBlockAtEnd);
if (entry.Kind == llvm::BitstreamEntry::Error) {
LLVM_DEBUG(llvm::dbgs() << "Cursor advance error in readSILFunction.\n");
MF->error();
return nullptr;
}
SmallVector<uint64_t, 64> scratch;
StringRef blobData;
unsigned kind = SILCursor.readRecord(entry.ID, scratch, &blobData);
assert(kind == SIL_FUNCTION && "expect a sil function");
(void)kind;
DeclID clangNodeOwnerID;
TypeID funcTyID;
IdentifierID replacedFunctionID;
GenericEnvironmentID genericEnvID;
unsigned rawLinkage, isTransparent, isSerialized, isThunk,
isWithoutactuallyEscapingThunk, isGlobal, inlineStrategy,
// SWIFT_ENABLE_TENSORFLOW
optimizationMode, effect, numSpecAttrs, numDifferentiableAttrs,
hasQualifiedOwnership, isWeakLinked, isDynamic;
ArrayRef<uint64_t> SemanticsIDs;
SILFunctionLayout::readRecord(
scratch, rawLinkage, isTransparent, isSerialized, isThunk,
isWithoutactuallyEscapingThunk, isGlobal, inlineStrategy,
// SWIFT_ENABLE_TENSORFLOW
optimizationMode, effect, numSpecAttrs, numDifferentiableAttrs,
hasQualifiedOwnership, isWeakLinked, isDynamic, funcTyID,
replacedFunctionID, genericEnvID, clangNodeOwnerID, SemanticsIDs);
if (funcTyID == 0) {
LLVM_DEBUG(llvm::dbgs() << "SILFunction typeID is 0.\n");
MF->error();
return nullptr;
}
auto astType = MF->getTypeChecked(funcTyID);
if (!astType) {
if (!existingFn || errorIfEmptyBody) {
return llvm::make_error<SILEntityError>(
name, takeErrorInfo(astType.takeError()));
}
llvm::consumeError(astType.takeError());
return existingFn;
}
auto ty = getSILType(astType.get(), SILValueCategory::Object);
if (!ty.is<SILFunctionType>()) {
LLVM_DEBUG(llvm::dbgs() << "not a function type for SILFunction\n");
MF->error();
return nullptr;
}
SILFunction *replacedFunction = nullptr;
Identifier replacedObjectiveCFunc;
if (replacedFunctionID &&
ty.getAs<SILFunctionType>()->getExtInfo().getRepresentation() !=
SILFunctionTypeRepresentation::ObjCMethod) {
replacedFunction =
getFuncForReference(MF->getIdentifier(replacedFunctionID).str());
} else if (replacedFunctionID) {
replacedObjectiveCFunc = MF->getIdentifier(replacedFunctionID);
}
auto linkage = fromStableSILLinkage(rawLinkage);
if (!linkage) {
LLVM_DEBUG(llvm::dbgs() << "invalid linkage code " << rawLinkage
<< " for SILFunction\n");
MF->error();
return nullptr;
}
ValueDecl *clangNodeOwner = nullptr;
if (clangNodeOwnerID != 0) {
clangNodeOwner = dyn_cast_or_null<ValueDecl>(MF->getDecl(clangNodeOwnerID));
if (!clangNodeOwner) {
LLVM_DEBUG(llvm::dbgs() << "invalid clang node owner for SILFunction\n");
MF->error();
return nullptr;
}
}
// If we weren't handed a function, check for an existing
// declaration in the output module.
if (!existingFn) existingFn = SILMod.lookUpFunction(name);
auto fn = existingFn;
// TODO: use the correct SILLocation from module.
SILLocation loc = RegularLocation::getAutoGeneratedLocation();
// If we've already serialized the module, don't mark the function
// as serialized, since we no longer need to enforce resilience
// boundaries.
if (SILMod.isSerialized())
isSerialized = IsNotSerialized;
// If we have an existing function, verify that the types match up.
if (fn) {
if (fn->getLoweredType() != ty) {
LLVM_DEBUG(llvm::dbgs() << "SILFunction type mismatch.\n");
MF->error();
return nullptr;
}
fn->setSerialized(IsSerialized_t(isSerialized));
if (SILMod.getOptions().MergePartialModules)
fn->setLinkage(*linkage);
// Don't override the transparency or linkage of a function with
// an existing declaration, except if we deserialized a
// PublicNonABI function, which has HiddenExternal when
// referenced as a declaration, and SharedExternal when it has
// a deserialized body.
if (fn->getLinkage() == SILLinkage::HiddenExternal &&
linkage == SILLinkage::PublicNonABI) {
fn->setLinkage(SILLinkage::SharedExternal);
}
if (fn->isDynamicallyReplaceable() != isDynamic) {
LLVM_DEBUG(llvm::dbgs() << "SILFunction type mismatch.\n");
MF->error();
return nullptr;
}
} else {
// Otherwise, create a new function.
SILSerializationFunctionBuilder builder(SILMod);
fn = builder.createDeclaration(name, ty, loc);
fn->setLinkage(linkage.getValue());
fn->setTransparent(IsTransparent_t(isTransparent == 1));
fn->setSerialized(IsSerialized_t(isSerialized));
fn->setThunk(IsThunk_t(isThunk));
fn->setWithoutActuallyEscapingThunk(bool(isWithoutactuallyEscapingThunk));
fn->setInlineStrategy(Inline_t(inlineStrategy));
fn->setGlobalInit(isGlobal == 1);
fn->setEffectsKind(EffectsKind(effect));
fn->setOptimizationMode(OptimizationMode(optimizationMode));
fn->setWeakLinked(isWeakLinked);
fn->setIsDynamic(IsDynamicallyReplaceable_t(isDynamic));
if (replacedFunction)
fn->setDynamicallyReplacedFunction(replacedFunction);
if (!replacedObjectiveCFunc.empty())
fn->setObjCReplacement(replacedObjectiveCFunc);
if (clangNodeOwner)
fn->setClangNodeOwner(clangNodeOwner);
for (auto ID : SemanticsIDs) {
fn->addSemanticsAttr(MF->getIdentifierText(ID));
}
if (Callback) Callback->didDeserialize(MF->getAssociatedModule(), fn);
}
// Mark this function as deserialized. This avoids rerunning diagnostic
// passes. Certain passes in the madatory pipeline may not work as expected
// after arbitrary optimization and lowering.
if (!MF->IsSIB)
fn->setWasDeserializedCanonical();
assert(fn->empty() &&
"SILFunction to be deserialized starts being empty.");
fn->setBare(IsBare);
const SILDebugScope *DS = fn->getDebugScope();
if (!DS) {
DS = new (SILMod) SILDebugScope(loc, fn);
fn->setDebugScope(DS);
}
// Read and instantiate the specialize attributes.
while (numSpecAttrs--) {
auto next = SILCursor.advance(AF_DontPopBlockAtEnd);
assert(next.Kind == llvm::BitstreamEntry::Record);
scratch.clear();
kind = SILCursor.readRecord(next.ID, scratch);
assert(kind == SIL_SPECIALIZE_ATTR && "Missing specialization attribute");
unsigned exported;
unsigned specializationKindVal;
SILSpecializeAttrLayout::readRecord(scratch, exported, specializationKindVal);
SILSpecializeAttr::SpecializationKind specializationKind =
specializationKindVal ? SILSpecializeAttr::SpecializationKind::Partial
: SILSpecializeAttr::SpecializationKind::Full;
SmallVector<Requirement, 8> requirements;
MF->readGenericRequirements(requirements, SILCursor);
// Read the substitution list and construct a SILSpecializeAttr.
fn->addSpecializeAttr(SILSpecializeAttr::create(
SILMod, requirements, exported != 0, specializationKind));
}
// SWIFT_ENABLE_TENSORFLOW
// Read and instantiate the differentiable attributes.
while (numDifferentiableAttrs--) {
auto next = SILCursor.advance(AF_DontPopBlockAtEnd);
assert(next.Kind == llvm::BitstreamEntry::Record);
scratch.clear();
kind = SILCursor.readRecord(next.ID, scratch);
assert(kind == SIL_DIFFERENTIABLE_ATTR &&
"Missing differentiable attribute");
uint64_t jvpNameId;
uint64_t vjpNameId;
unsigned source;
ArrayRef<uint64_t> rawParameterIndices;
SmallVector<Requirement, 8> requirements;
SILDifferentiableAttrLayout::readRecord(scratch, jvpNameId, vjpNameId,
source, rawParameterIndices);
StringRef jvpName = MF->getIdentifier(jvpNameId).str();
StringRef vjpName = MF->getIdentifier(vjpNameId).str();
SmallVector<unsigned, 8> parameterIndices(rawParameterIndices.begin(),
rawParameterIndices.end());
auto *parameterIndexSubset = AutoDiffIndexSubset::get(
MF->getContext(), fn->getLoweredFunctionType()->getNumParameters(),
parameterIndices);
SILAutoDiffIndices indices(source, parameterIndexSubset);
MF->readGenericRequirements(requirements, SILCursor);
auto *attr = SILDifferentiableAttr::create(SILMod, indices, requirements,
jvpName, vjpName);
fn->addDifferentiableAttr(attr);
}
GenericEnvironment *genericEnv = nullptr;
if (!declarationOnly)
genericEnv = MF->getGenericEnvironment(genericEnvID);
// If the next entry is the end of the block, then this function has
// no contents.
entry = SILCursor.advance(AF_DontPopBlockAtEnd);
bool isEmptyFunction = (entry.Kind == llvm::BitstreamEntry::EndBlock);
assert((!isEmptyFunction || !genericEnv) &&
"generic environment without body?!");
// Remember this in our cache in case it's a recursive function.
// Increase the reference count to keep it alive.
bool isFullyDeserialized = (isEmptyFunction || !declarationOnly);
if (cacheEntry.isDeserialized()) {
assert(fn == cacheEntry.get() && "changing SIL function during deserialization!");
} else {
fn->incrementRefCount();
}
cacheEntry.set(fn, isFullyDeserialized);
// Stop here if we have nothing else to do.
if (isEmptyFunction || declarationOnly) {
return fn;
}
if (!hasQualifiedOwnership)
fn->setOwnershipEliminated();
NumDeserializedFunc++;
assert(!(fn->getGenericEnvironment() && !fn->empty())
&& "function already has context generic params?!");
if (genericEnv)
fn->setGenericEnvironment(genericEnv);
scratch.clear();
kind = SILCursor.readRecord(entry.ID, scratch);
SILBasicBlock *CurrentBB = nullptr;
// Clear up at the beginning of each SILFunction.
BasicBlockID = 0;
BlocksByID.clear();
UndefinedBlocks.clear();
// The first two IDs are reserved for SILUndef.
LastValueID = 1;
LocalValues.clear();
ForwardLocalValues.clear();
SILOpenedArchetypesTracker OpenedArchetypesTracker(fn);
SILBuilder Builder(*fn);
// Track the archetypes just like SILGen. This
// is required for adding typedef operands to instructions.
Builder.setOpenedArchetypesTracker(&OpenedArchetypesTracker);
// Define a callback to be invoked on the deserialized types.
auto OldDeserializedTypeCallback = MF->DeserializedTypeCallback;
SWIFT_DEFER {
MF->DeserializedTypeCallback = OldDeserializedTypeCallback;
};
MF->DeserializedTypeCallback = [&OpenedArchetypesTracker] (Type ty) {
// We can't call getCanonicalType() immediately on everything we
// deserialize, but fortunately we only need to register opened
// existentials.
if (ty->isOpenedExistential())
OpenedArchetypesTracker.registerUsedOpenedArchetypes(CanType(ty));
};
// Another SIL_FUNCTION record means the end of this SILFunction.
// SIL_VTABLE or SIL_GLOBALVAR or SIL_WITNESS_TABLE record also means the end
// of this SILFunction.
while (kind != SIL_FUNCTION && kind != SIL_VTABLE && kind != SIL_GLOBALVAR &&
kind != SIL_WITNESS_TABLE) {
if (kind == SIL_BASIC_BLOCK)
// Handle a SILBasicBlock record.
CurrentBB = readSILBasicBlock(fn, CurrentBB, scratch);
else {
// If CurrentBB is empty, just return fn. The code in readSILInstruction
// assumes that such a situation means that fn is a declaration. Thus it
// is using return false to mean two different things, error a failure
// occurred and this is a declaration. Work around that for now.
if (!CurrentBB)
return fn;
// Handle a SILInstruction record.
if (readSILInstruction(fn, CurrentBB, Builder, kind, scratch)) {
LLVM_DEBUG(llvm::dbgs() << "readSILInstruction returns error.\n");
MF->error();
return fn;
}
}
// Fetch the next record.
scratch.clear();
entry = SILCursor.advance(AF_DontPopBlockAtEnd);
// EndBlock means the end of this SILFunction.
if (entry.Kind == llvm::BitstreamEntry::EndBlock)
break;
kind = SILCursor.readRecord(entry.ID, scratch);
}
// If fn is empty, we failed to deserialize its body. Return nullptr to signal
// error.
if (fn->empty() && errorIfEmptyBody)
return nullptr;
// Check that there are no unresolved forward definitions of opened
// archetypes.
if (OpenedArchetypesTracker.hasUnresolvedOpenedArchetypeDefinitions())
llvm_unreachable(
"All forward definitions of opened archetypes should be resolved");
if (Callback)
Callback->didDeserializeFunctionBody(MF->getAssociatedModule(), fn);
return fn;
}
// We put these static asserts here to formalize our assumption that both
// SILValueCategory and ValueOwnershipKind have uint8_t as their underlying
// pointer values.
static_assert(
std::is_same<std::underlying_type<SILValueCategory>::type, uint8_t>::value,
"Expected an underlying uint8_t type");
// We put these static asserts here to formalize our assumption that both
// SILValueCategory and ValueOwnershipKind have uint8_t as their underlying
// pointer values.
static_assert(
std::is_same<std::underlying_type<ValueOwnershipKind::innerty>::type,
uint8_t>::value,
"Expected an underlying uint8_t type");
SILBasicBlock *SILDeserializer::readSILBasicBlock(SILFunction *Fn,
SILBasicBlock *Prev,
SmallVectorImpl<uint64_t> &scratch) {
ArrayRef<uint64_t> Args;
SILBasicBlockLayout::readRecord(scratch, Args);
// Args should be a list of triples of the following form:
//
// 1. A TypeID.
// 2. A flag of metadata. This currently includes the SILValueCategory and
// ValueOwnershipKind. We enforce size constraints of these types above.
// 3. A ValueID.
SILBasicBlock *CurrentBB = getBBForDefinition(Fn, Prev, BasicBlockID++);
bool IsEntry = CurrentBB->isEntry();
for (unsigned I = 0, E = Args.size(); I < E; I += 3) {
TypeID TyID = Args[I];
if (!TyID) return nullptr;
ValueID ValId = Args[I+2];
if (!ValId) return nullptr;
auto ArgTy = MF->getType(TyID);
SILArgument *Arg;
auto ValueCategory = SILValueCategory(Args[I + 1] & 0xF);
SILType SILArgTy = getSILType(ArgTy, ValueCategory);
if (IsEntry) {
Arg = CurrentBB->createFunctionArgument(SILArgTy);
} else {
auto OwnershipKind = ValueOwnershipKind((Args[I + 1] >> 8) & 0xF);
Arg = CurrentBB->createPhiArgument(SILArgTy, OwnershipKind);
}
LastValueID = LastValueID + 1;
setLocalValue(Arg, LastValueID);
}
return CurrentBB;
}
static CastConsumptionKind getCastConsumptionKind(unsigned attr) {
switch (attr) {
case SIL_CAST_CONSUMPTION_TAKE_ALWAYS:
return CastConsumptionKind::TakeAlways;
case SIL_CAST_CONSUMPTION_TAKE_ON_SUCCESS:
return CastConsumptionKind::TakeOnSuccess;
case SIL_CAST_CONSUMPTION_COPY_ON_SUCCESS:
return CastConsumptionKind::CopyOnSuccess;
case SIL_CAST_CONSUMPTION_BORROW_ALWAYS:
return CastConsumptionKind::BorrowAlways;
default:
llvm_unreachable("not a valid CastConsumptionKind for SIL");
}
}
/// Construct a SILDeclRef from ListOfValues.
static SILDeclRef getSILDeclRef(ModuleFile *MF,
ArrayRef<uint64_t> ListOfValues,
unsigned &NextIdx) {
assert(ListOfValues.size() >= NextIdx+4 &&
"Expect 4 numbers for SILDeclRef");
SILDeclRef DRef(cast<ValueDecl>(MF->getDecl(ListOfValues[NextIdx])),
(SILDeclRef::Kind)ListOfValues[NextIdx+1],
/*isCurried=*/ListOfValues[NextIdx+2] > 0,
/*isForeign=*/ListOfValues[NextIdx+3] > 0);
NextIdx += 4;
return DRef;
}
Optional<KeyPathPatternComponent>
SILDeserializer::readKeyPathComponent(ArrayRef<uint64_t> ListOfValues,
unsigned &nextValue) {
auto kind =
(KeyPathComponentKindEncoding)ListOfValues[nextValue++];
if (kind == KeyPathComponentKindEncoding::Trivial)
return None;
auto type = MF->getType(ListOfValues[nextValue++])
->getCanonicalType();
auto handleComputedId =
[&]() -> KeyPathPatternComponent::ComputedPropertyId {
auto kind =
(KeyPathComputedComponentIdKindEncoding)ListOfValues[nextValue++];
switch (kind) {
case KeyPathComputedComponentIdKindEncoding::Property:
return cast<VarDecl>(MF->getDecl(ListOfValues[nextValue++]));
case KeyPathComputedComponentIdKindEncoding::Function: {
auto name = MF->getIdentifierText(ListOfValues[nextValue++]);
return getFuncForReference(name);
}
case KeyPathComputedComponentIdKindEncoding::DeclRef: {
// read SILDeclRef
return getSILDeclRef(MF, ListOfValues, nextValue);
}
}
llvm_unreachable("unhandled kind");
};
ArrayRef<KeyPathPatternComponent::Index> indices;
SILFunction *indicesEquals = nullptr;
SILFunction *indicesHash = nullptr;
AbstractStorageDecl *externalDecl = nullptr;
SubstitutionMap externalSubs;
auto handleComputedExternalReferenceAndIndices = [&] {
auto externalDeclID = ListOfValues[nextValue++];
externalDecl =
cast_or_null<AbstractStorageDecl>(MF->getDecl(externalDeclID));
externalSubs = MF->getSubstitutionMap(ListOfValues[nextValue++]);
SmallVector<KeyPathPatternComponent::Index, 4> indicesBuf;
auto numIndexes = ListOfValues[nextValue++];
indicesBuf.reserve(numIndexes);
while (numIndexes-- > 0) {
unsigned operand = ListOfValues[nextValue++];
auto formalType = MF->getType(ListOfValues[nextValue++]);
auto loweredType = MF->getType(ListOfValues[nextValue++]);
auto loweredCategory = (SILValueCategory)ListOfValues[nextValue++];
auto conformance = MF->readConformance(SILCursor);
indicesBuf.push_back({
operand, formalType->getCanonicalType(),
SILType::getPrimitiveType(loweredType->getCanonicalType(),
loweredCategory),
conformance});
}
indices = MF->getContext().AllocateCopy(indicesBuf);
if (!indices.empty()) {
auto indicesEqualsName = MF->getIdentifierText(ListOfValues[nextValue++]);
auto indicesHashName = MF->getIdentifierText(ListOfValues[nextValue++]);
indicesEquals = getFuncForReference(indicesEqualsName);
indicesHash = getFuncForReference(indicesHashName);
}
};
switch (kind) {
case KeyPathComponentKindEncoding::StoredProperty: {
auto decl = cast<VarDecl>(MF->getDecl(ListOfValues[nextValue++]));
return KeyPathPatternComponent::forStoredProperty(decl, type);
}
case KeyPathComponentKindEncoding::GettableProperty: {
auto id = handleComputedId();
auto getterName = MF->getIdentifierText(ListOfValues[nextValue++]);
auto getter = getFuncForReference(getterName);
handleComputedExternalReferenceAndIndices();
return KeyPathPatternComponent::forComputedGettableProperty(
id, getter, indices, indicesEquals, indicesHash,
externalDecl, externalSubs, type);
}
case KeyPathComponentKindEncoding::SettableProperty: {
auto id = handleComputedId();
auto getterName = MF->getIdentifierText(ListOfValues[nextValue++]);
auto getter = getFuncForReference(getterName);
auto setterName = MF->getIdentifierText(ListOfValues[nextValue++]);
auto setter = getFuncForReference(setterName);
handleComputedExternalReferenceAndIndices();
return KeyPathPatternComponent::forComputedSettableProperty(
id, getter, setter, indices, indicesEquals, indicesHash,
externalDecl, externalSubs, type);
break;
}
case KeyPathComponentKindEncoding::OptionalChain:
return KeyPathPatternComponent::forOptional(
KeyPathPatternComponent::Kind::OptionalChain, type);
case KeyPathComponentKindEncoding::OptionalForce:
return KeyPathPatternComponent::forOptional(
KeyPathPatternComponent::Kind::OptionalForce, type);
case KeyPathComponentKindEncoding::OptionalWrap:
return KeyPathPatternComponent::forOptional(
KeyPathPatternComponent::Kind::OptionalWrap, type);
case KeyPathComponentKindEncoding::TupleElement:
return KeyPathPatternComponent::forTupleElement(
ListOfValues[nextValue++], type);
case KeyPathComponentKindEncoding::Trivial:
llvm_unreachable("handled above");
}
llvm_unreachable("invalid key path component kind encoding");
}
bool SILDeserializer::readSILInstruction(SILFunction *Fn, SILBasicBlock *BB,
SILBuilder &Builder,
unsigned RecordKind,
SmallVectorImpl<uint64_t> &scratch) {
// Return error if Basic Block is null.
if (!BB)
return true;
Builder.setInsertionPoint(BB);