-
Notifications
You must be signed in to change notification settings - Fork 10.4k
/
Copy pathSILGenBuilder.cpp
1230 lines (1077 loc) · 52.7 KB
/
SILGenBuilder.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
//===--- SILGenBuilder.cpp ------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
#include "SILGenBuilder.h"
#include "ArgumentSource.h"
#include "Cleanup.h"
#include "RValue.h"
#include "SILGenFunction.h"
#include "Scope.h"
#include "SwitchEnumBuilder.h"
#include "swift/AST/GenericSignature.h"
#include "swift/AST/SubstitutionMap.h"
#include "swift/SIL/DynamicCasts.h"
#include "swift/SIL/SILInstruction.h"
using namespace swift;
using namespace Lowering;
//===----------------------------------------------------------------------===//
// Utility Methods
//===----------------------------------------------------------------------===//
SILGenModule &SILGenBuilder::getSILGenModule() const { return SGF.SGM; }
//===----------------------------------------------------------------------===//
// Constructors
//===----------------------------------------------------------------------===//
SILGenBuilder::SILGenBuilder(SILGenFunction &SGF)
: SILBuilder(SGF.F), SGF(SGF) {}
SILGenBuilder::SILGenBuilder(SILGenFunction &SGF, SILBasicBlock *insertBB,
SmallVectorImpl<SILInstruction *> *insertedInsts)
: SILBuilder(insertBB, insertedInsts), SGF(SGF) {
auto FirstInsn = insertBB->begin();
if (FirstInsn != insertBB->end())
setCurrentDebugScope(FirstInsn->getDebugScope());
}
SILGenBuilder::SILGenBuilder(SILGenFunction &SGF, SILBasicBlock *insertBB,
SILBasicBlock::iterator insertInst)
: SILBuilder(insertBB, insertInst), SGF(SGF) {
if (insertInst != insertBB->end())
setCurrentDebugScope(insertInst->getDebugScope());
}
SILDebugLocation SILGenBuilder::getSILDebugLocation(SILLocation Loc,
bool ForMetaInstruction) {
return SGF.getSILDebugLocation(*this, Loc, getCurrentDebugLocOverride(),
ForMetaInstruction);
}
//===----------------------------------------------------------------------===//
// Managed Value APIs
//===----------------------------------------------------------------------===//
ManagedValue SILGenBuilder::createPartialApply(SILLocation loc, SILValue fn,
SubstitutionMap subs,
ArrayRef<ManagedValue> args,
ParameterConvention calleeConvention,
SILFunctionTypeIsolation resultIsolation) {
llvm::SmallVector<SILValue, 8> values;
llvm::transform(args, std::back_inserter(values),
[&](ManagedValue mv) -> SILValue {
return mv.forward(getSILGenFunction());
});
SILValue result =
createPartialApply(loc, fn, subs, values, calleeConvention,
resultIsolation);
// Partial apply instructions create a box, so we need to put on a cleanup.
return getSILGenFunction().emitManagedRValueWithCleanup(result);
}
ManagedValue
SILGenBuilder::createConvertFunction(SILLocation loc, ManagedValue fn,
SILType resultTy,
bool withoutActuallyEscaping) {
CleanupCloner cloner(*this, fn);
SILValue result = createConvertFunction(loc, fn.forward(getSILGenFunction()),
resultTy, withoutActuallyEscaping);
return cloner.clone(result);
}
ManagedValue SILGenBuilder::createConvertEscapeToNoEscape(
SILLocation loc, ManagedValue fn, SILType resultTy) {
auto fnType = fn.getType().castTo<SILFunctionType>();
auto resultFnType = resultTy.castTo<SILFunctionType>();
// Escaping to noescape conversion.
assert(resultFnType->getRepresentation() ==
SILFunctionTypeRepresentation::Thick &&
fnType->getRepresentation() ==
SILFunctionTypeRepresentation::Thick &&
!fnType->isNoEscape() && resultFnType->isNoEscape() &&
"Expect a escaping to noescape conversion");
(void)fnType;
(void)resultFnType;
SILValue fnValue = fn.getValue();
SILValue result =
createConvertEscapeToNoEscape(loc, fnValue, resultTy, false);
return SGF.emitManagedRValueWithCleanup(result);
}
ManagedValue SILGenBuilder::createInitExistentialValue(
SILLocation loc, SILType existentialType, CanType formalConcreteType,
ManagedValue concrete, ArrayRef<ProtocolConformanceRef> conformances) {
// *NOTE* we purposely do not use a cleanup cloner here. The reason why is no
// matter whether we have a trivial or non-trivial input,
// init_existential_value returns a +1 value (the COW box).
SILValue v =
createInitExistentialValue(loc, existentialType, formalConcreteType,
concrete.forward(SGF), conformances);
return SGF.emitManagedRValueWithCleanup(v);
}
ManagedValue SILGenBuilder::createInitExistentialRef(
SILLocation Loc, SILType ExistentialType, CanType FormalConcreteType,
ManagedValue Concrete, ArrayRef<ProtocolConformanceRef> Conformances) {
CleanupCloner Cloner(*this, Concrete);
InitExistentialRefInst *IERI =
createInitExistentialRef(Loc, ExistentialType, FormalConcreteType,
Concrete.forward(SGF), Conformances);
return Cloner.clone(IERI);
}
ManagedValue SILGenBuilder::createStructExtract(SILLocation loc,
ManagedValue base,
VarDecl *decl) {
ManagedValue borrowedBase = base.formalAccessBorrow(SGF, loc);
SILValue extract = createStructExtract(loc, borrowedBase.getValue(), decl);
return ManagedValue::forBorrowedRValue(extract);
}
ManagedValue SILGenBuilder::createRefElementAddr(SILLocation loc,
ManagedValue operand,
VarDecl *field,
SILType resultTy) {
operand = operand.formalAccessBorrow(SGF, loc);
SILValue result = createRefElementAddr(loc, operand.getValue(), field);
return ManagedValue::forBorrowedRValue(result);
}
ManagedValue SILGenBuilder::createCopyValue(SILLocation loc,
ManagedValue originalValue) {
auto &lowering = SGF.getTypeLowering(originalValue.getType());
return createCopyValue(loc, originalValue, lowering);
}
ManagedValue SILGenBuilder::createCopyValue(SILLocation loc,
ManagedValue originalValue,
const TypeLowering &lowering) {
if (lowering.isTrivial())
return originalValue;
SILType ty = originalValue.getType();
assert(!ty.isAddress() && "Can not perform a copy value of an address typed "
"value");
if (ty.isObject() &&
originalValue.getOwnershipKind() == OwnershipKind::None) {
return originalValue;
}
SILValue result =
lowering.emitCopyValue(*this, loc, originalValue.getValue());
return SGF.emitManagedRValueWithCleanup(result, lowering);
}
#define NEVER_LOADABLE_CHECKED_REF_STORAGE(Name, ...) \
ManagedValue SILGenBuilder::createStrongCopy##Name##Value( \
SILLocation loc, ManagedValue originalValue) { \
assert(!SGF.useLoweredAddresses()); \
auto ty = originalValue.getType(); \
assert(ty.isAddressOnly(SGF.F)); \
auto storageTy = originalValue.getType().castTo<Name##StorageType>(); \
(void)storageTy; \
SILValue result = \
createStrongCopy##Name##Value(loc, originalValue.getValue()); \
return SGF.emitManagedRValueWithCleanup(result); \
}
#define SOMETIMES_LOADABLE_CHECKED_REF_STORAGE(Name, ...) \
ManagedValue SILGenBuilder::createStrongCopy##Name##Value( \
SILLocation loc, ManagedValue originalValue) { \
auto ty = originalValue.getType().castTo<Name##StorageType>(); \
assert(ty->isLoadable(ResilienceExpansion::Maximal) || \
!SGF.useLoweredAddresses()); \
(void)ty; \
SILValue result = \
createStrongCopy##Name##Value(loc, originalValue.getValue()); \
return SGF.emitManagedRValueWithCleanup(result); \
}
#define ALWAYS_LOADABLE_CHECKED_REF_STORAGE(Name, ...) \
ManagedValue SILGenBuilder::createStrongCopy##Name##Value( \
SILLocation loc, ManagedValue originalValue) { \
SILValue result = \
createStrongCopy##Name##Value(loc, originalValue.getValue()); \
return SGF.emitManagedRValueWithCleanup(result); \
}
#define UNCHECKED_REF_STORAGE(Name, ...) \
ManagedValue SILGenBuilder::createStrongCopy##Name##Value( \
SILLocation loc, ManagedValue originalValue) { \
/* *NOTE* The reason why this is unsafe is that we are converting and */ \
/* unconditionally retaining, rather than before converting from */ \
/* type->ref checking that our value is not yet uninitialized. */ \
SILValue result = \
createStrongCopy##Name##Value(loc, originalValue.getValue()); \
return SGF.emitManagedRValueWithCleanup(result); \
}
#include "swift/AST/ReferenceStorage.def"
ManagedValue SILGenBuilder::createForwardedTermResult(SILType type) {
auto *succBB = getInsertionBB();
auto *term = cast<OwnershipForwardingTermInst>(
succBB->getSinglePredecessorBlock()->getTerminator());
auto *arg = term->createResult(succBB, type);
return ManagedValue::forForwardedRValue(SGF, arg);
}
ManagedValue SILGenBuilder::createTermResult(SILType type,
ValueOwnershipKind ownership) {
// Despite the name, 'arg' is a terminator result, not a phi.
auto *arg = getInsertionBB()->createPhiArgument(type, ownership);
return ManagedValue::forForwardedRValue(SGF, arg);
}
ManagedValue SILGenBuilder::createPhi(SILType type,
ValueOwnershipKind ownership) {
SILPhiArgument *arg = getInsertionBB()->createPhiArgument(type, ownership);
switch (ownership) {
case OwnershipKind::Any:
llvm_unreachable("Invalid ownership for value");
case OwnershipKind::Owned:
return SGF.emitManagedRValueWithCleanup(arg);
case OwnershipKind::Guaranteed:
return SGF.emitManagedBorrowedArgumentWithCleanup(arg);
case OwnershipKind::None:
return ManagedValue::forObjectRValueWithoutOwnership(arg);
case OwnershipKind::Unowned:
return ManagedValue::forUnownedObjectValue(arg);
}
}
ManagedValue SILGenBuilder::createAllocRef(
SILLocation loc, SILType refType, bool objc,
ArrayRef<SILType> inputElementTypes,
ArrayRef<ManagedValue> inputElementCountOperands) {
llvm::SmallVector<SILType, 8> elementTypes(inputElementTypes.begin(),
inputElementTypes.end());
llvm::SmallVector<SILValue, 8> elementCountOperands;
llvm::transform(inputElementCountOperands,
std::back_inserter(elementCountOperands),
[](ManagedValue mv) -> SILValue { return mv.getValue(); });
AllocRefInst *i = createAllocRef(loc, refType, objc, false, false,
elementTypes, elementCountOperands);
return SGF.emitManagedRValueWithCleanup(i);
}
ManagedValue SILGenBuilder::createAllocRefDynamic(
SILLocation loc, ManagedValue operand, SILType refType, bool objc,
ArrayRef<SILType> inputElementTypes,
ArrayRef<ManagedValue> inputElementCountOperands) {
llvm::SmallVector<SILType, 8> elementTypes(inputElementTypes.begin(),
inputElementTypes.end());
llvm::SmallVector<SILValue, 8> elementCountOperands;
llvm::transform(inputElementCountOperands,
std::back_inserter(elementCountOperands),
[](ManagedValue mv) -> SILValue { return mv.getValue(); });
AllocRefDynamicInst *i =
createAllocRefDynamic(loc, operand.getValue(), refType, objc, false,
elementTypes, elementCountOperands);
return SGF.emitManagedRValueWithCleanup(i);
}
ManagedValue SILGenBuilder::createTupleExtract(SILLocation loc,
ManagedValue base,
unsigned index, SILType type) {
ManagedValue borrowedBase = SGF.emitManagedBeginBorrow(loc, base.getValue());
SILValue extract =
createTupleExtract(loc, borrowedBase.getValue(), index, type);
return ManagedValue::forBorrowedRValue(extract);
}
ManagedValue SILGenBuilder::createTupleExtract(SILLocation loc,
ManagedValue value,
unsigned index) {
SILType type = value.getType().getTupleElementType(index);
return createTupleExtract(loc, value, index, type);
}
ManagedValue SILGenBuilder::createLoadBorrow(SILLocation loc,
ManagedValue base) {
if (SGF.getTypeLowering(base.getType()).isTrivial()) {
auto *i = createLoad(loc, base.getValue(), LoadOwnershipQualifier::Trivial);
return ManagedValue::forBorrowedRValue(i);
}
auto *i = createLoadBorrow(loc, base.getValue());
return SGF.emitManagedBorrowedRValueWithCleanup(base.getValue(), i);
}
ManagedValue SILGenBuilder::createFormalAccessLoadBorrow(SILLocation loc,
ManagedValue base) {
if (SGF.getTypeLowering(base.getType()).isTrivial()) {
auto *i = createLoad(loc, base.getValue(), LoadOwnershipQualifier::Trivial);
return ManagedValue::forBorrowedRValue(i);
}
SILValue baseValue = base.getValue();
auto *i = createLoadBorrow(loc, baseValue);
return SGF.emitFormalEvaluationManagedBorrowedRValueWithCleanup(loc,
baseValue, i);
}
ManagedValue SILGenBuilder::createFormalAccessLoadTake(SILLocation loc,
ManagedValue base) {
if (SGF.getTypeLowering(base.getType()).isTrivial()) {
auto *i = createLoad(loc, base.getValue(), LoadOwnershipQualifier::Trivial);
return ManagedValue::forObjectRValueWithoutOwnership(i);
}
SILValue baseValue = base.getValue();
auto i = emitLoadValueOperation(loc, baseValue, LoadOwnershipQualifier::Take);
return SGF.emitFormalAccessManagedRValueWithCleanup(loc, i);
}
ManagedValue SILGenBuilder::createFormalAccessLoadCopy(SILLocation loc,
ManagedValue base) {
if (SGF.getTypeLowering(base.getType()).isTrivial()) {
auto *i = createLoad(loc, base.getValue(), LoadOwnershipQualifier::Trivial);
return ManagedValue::forObjectRValueWithoutOwnership(i);
}
SILValue baseValue = base.getValue();
auto i = emitLoadValueOperation(loc, baseValue, LoadOwnershipQualifier::Copy);
return SGF.emitFormalAccessManagedRValueWithCleanup(loc, i);
}
ManagedValue
SILGenBuilder::createFormalAccessCopyValue(SILLocation loc,
ManagedValue originalValue) {
SILType ty = originalValue.getType();
const auto &lowering = SGF.getTypeLowering(ty);
if (lowering.isTrivial())
return originalValue;
assert(!lowering.isAddressOnly() && "cannot perform a copy value of an "
"address only type");
if (ty.isObject() &&
originalValue.getOwnershipKind() == OwnershipKind::None) {
return originalValue;
}
SILValue result =
lowering.emitCopyValue(*this, loc, originalValue.getValue());
return SGF.emitFormalAccessManagedRValueWithCleanup(loc, result);
}
ManagedValue SILGenBuilder::createFormalAccessCopyAddr(
SILLocation loc, ManagedValue originalAddr, SILValue newAddr,
IsTake_t isTake, IsInitialization_t isInit) {
createCopyAddr(loc, originalAddr.getValue(), newAddr, isTake, isInit);
return SGF.emitFormalAccessManagedBufferWithCleanup(loc, newAddr);
}
ManagedValue
SILGenBuilder::bufferForExpr(SILLocation loc, SILType ty,
const TypeLowering &lowering, SGFContext context,
llvm::function_ref<void(SILValue)> rvalueEmitter) {
// If we have a single-buffer "emit into" initialization, use that for the
// result.
SILValue address = context.getAddressForInPlaceInitialization(SGF, loc);
// If we couldn't emit into the Initialization, emit into a temporary
// allocation.
if (!address) {
address = SGF.emitTemporaryAllocation(loc, ty.getObjectType());
}
rvalueEmitter(address);
// If we have a single-buffer "emit into" initialization, use that for the
// result.
if (context.finishInPlaceInitialization(SGF)) {
return ManagedValue::forInContext();
}
// Add a cleanup for the temporary we allocated.
if (lowering.isTrivial())
return ManagedValue::forTrivialAddressRValue(address);
return SGF.emitManagedBufferWithCleanup(address);
}
ManagedValue SILGenBuilder::formalAccessBufferForExpr(
SILLocation loc, SILType ty, const TypeLowering &lowering,
SGFContext context, llvm::function_ref<void(SILValue)> rvalueEmitter) {
// If we have a single-buffer "emit into" initialization, use that for the
// result.
SILValue address = context.getAddressForInPlaceInitialization(SGF, loc);
// If we couldn't emit into the Initialization, emit into a temporary
// allocation.
if (!address) {
address = SGF.emitTemporaryAllocation(loc, ty.getObjectType());
}
rvalueEmitter(address);
// If we have a single-buffer "emit into" initialization, use that for the
// result.
if (context.finishInPlaceInitialization(SGF)) {
return ManagedValue::forInContext();
}
// Add a cleanup for the temporary we allocated.
if (lowering.isTrivial())
return ManagedValue::forTrivialAddressRValue(address);
return SGF.emitFormalAccessManagedBufferWithCleanup(loc, address);
}
ManagedValue SILGenBuilder::createUncheckedEnumData(SILLocation loc,
ManagedValue operand,
EnumElementDecl *element) {
CleanupCloner cloner(*this, operand);
SILValue result = createUncheckedEnumData(loc, operand.forward(SGF), element);
return cloner.clone(result);
}
ManagedValue SILGenBuilder::createUncheckedTakeEnumDataAddr(
SILLocation loc, ManagedValue operand, EnumElementDecl *element,
SILType ty) {
CleanupCloner cloner(*this, operand);
SILValue result =
createUncheckedTakeEnumDataAddr(loc, operand.forward(SGF), element);
return cloner.clone(result);
}
ManagedValue
SILGenBuilder::createLoadIfLoadable(SILLocation loc, ManagedValue addr) {
assert(addr.getType().isAddress());
if (!addr.getType().isLoadable(SGF.F))
return addr;
return createLoadWithSameOwnership(loc, addr);
}
ManagedValue
SILGenBuilder::createLoadWithSameOwnership(SILLocation loc,
ManagedValue addr) {
if (addr.isPlusOne(SGF))
return createLoadTake(loc, addr);
else
return createLoadBorrow(loc, addr);
}
ManagedValue SILGenBuilder::createLoadTake(SILLocation loc, ManagedValue v) {
auto &lowering = SGF.getTypeLowering(v.getType());
return createLoadTake(loc, v, lowering);
}
ManagedValue SILGenBuilder::createLoadTake(SILLocation loc, ManagedValue v,
const TypeLowering &lowering) {
assert(lowering.getLoweredType().getAddressType() == v.getType());
SILValue result =
lowering.emitLoadOfCopy(*this, loc, v.forward(SGF), IsTake);
if (lowering.isTrivial())
return ManagedValue::forObjectRValueWithoutOwnership(result);
assert((!lowering.isAddressOnly() || !SGF.silConv.useLoweredAddresses()) &&
"cannot retain an unloadable type");
return SGF.emitManagedRValueWithCleanup(result, lowering);
}
ManagedValue SILGenBuilder::createLoadTrivial(SILLocation loc,
ManagedValue addr) {
#ifndef NDEBUG
auto &lowering = SGF.getTypeLowering(addr.getType());
assert(lowering.isTrivial());
assert((!lowering.isAddressOnly() || !SGF.silConv.useLoweredAddresses()) &&
"cannot load an unloadable type");
assert(!addr.hasCleanup());
#endif
auto value = createLoad(loc, addr.getValue(),
LoadOwnershipQualifier::Trivial);
return ManagedValue::forObjectRValueWithoutOwnership(value);
}
ManagedValue SILGenBuilder::createLoadCopy(SILLocation loc, ManagedValue v) {
auto &lowering = SGF.getTypeLowering(v.getType());
return createLoadCopy(loc, v, lowering);
}
ManagedValue SILGenBuilder::createLoadCopy(SILLocation loc, ManagedValue v,
const TypeLowering &lowering) {
assert(lowering.getLoweredType().getAddressType() == v.getType());
SILValue result =
lowering.emitLoadOfCopy(*this, loc, v.getValue(), IsNotTake);
if (lowering.isTrivial())
return ManagedValue::forObjectRValueWithoutOwnership(result);
assert((!lowering.isAddressOnly()
|| !SGF.silConv.useLoweredAddresses()) &&
"cannot retain an unloadable type");
return SGF.emitManagedRValueWithCleanup(result, lowering);
}
static ManagedValue createInputFunctionArgument(
SILGenBuilder &B, SILType type, SILLocation loc, ValueDecl *decl = nullptr,
bool isNoImplicitCopy = false,
LifetimeAnnotation lifetimeAnnotation = LifetimeAnnotation::None,
bool isClosureCapture = false,
bool isFormalParameterPack = false) {
auto &SGF = B.getSILGenFunction();
SILFunction &F = B.getFunction();
assert((F.isBare() || isFormalParameterPack || decl) &&
"Function arguments of non-bare functions must have a decl");
auto *arg = F.begin()->createFunctionArgument(type, decl);
if (auto *pd = dyn_cast_or_null<ParamDecl>(decl)) {
if (!arg->getType().isMoveOnly()) {
isNoImplicitCopy |= pd->getSpecifier() == ParamSpecifier::Borrowing;
isNoImplicitCopy |= pd->getSpecifier() == ParamSpecifier::Consuming;
}
if (pd->hasResultDependsOn()) {
arg->setHasResultDependsOn();
}
}
if (isNoImplicitCopy)
arg->setNoImplicitCopy(isNoImplicitCopy);
arg->setClosureCapture(isClosureCapture);
arg->setLifetimeAnnotation(lifetimeAnnotation);
arg->setFormalParameterPack(isFormalParameterPack);
switch (arg->getArgumentConvention()) {
case SILArgumentConvention::Indirect_In_Guaranteed:
case SILArgumentConvention::Direct_Guaranteed:
case SILArgumentConvention::Pack_Guaranteed:
// Guaranteed parameters are passed at +0.
return ManagedValue::forBorrowedRValue(arg);
case SILArgumentConvention::Direct_Unowned:
// Unowned parameters are only guaranteed at the instant of the call, so we
// must retain them even if we're in a context that can accept a +0 value.
//
// NOTE: If we have a trivial value, the copy will do nothing, so this is
// just a convenient way to avoid writing conditional code.
return SGF.B.copyOwnedObjectRValue(loc, arg,
ManagedValue::ScopeKind::Lexical);
case SILArgumentConvention::Direct_Owned:
return SGF.emitManagedRValueWithCleanup(arg);
case SILArgumentConvention::Pack_Owned:
return SGF.emitManagedPackWithCleanup(arg);
case SILArgumentConvention::Indirect_In:
if (SGF.silConv.useLoweredAddresses())
return SGF.emitManagedBufferWithCleanup(arg);
return SGF.emitManagedRValueWithCleanup(arg);
case SILArgumentConvention::Indirect_Inout:
case SILArgumentConvention::Indirect_InoutAliasable:
case SILArgumentConvention::Pack_Inout:
// An inout parameter is +0 and guaranteed, but represents an lvalue.
return ManagedValue::forLValue(arg);
case SILArgumentConvention::Indirect_Out:
case SILArgumentConvention::Pack_Out:
llvm_unreachable("unsupported convention for API");
}
llvm_unreachable("bad parameter convention");
}
ManagedValue SILGenBuilder::createInputFunctionArgument(
SILType type, ValueDecl *decl, bool isNoImplicitCopy,
LifetimeAnnotation lifetimeAnnotation, bool isClosureCapture,
bool isFormalParameterPack) {
return ::createInputFunctionArgument(*this, type, SILLocation(decl), decl,
isNoImplicitCopy, lifetimeAnnotation,
isClosureCapture,
isFormalParameterPack);
}
ManagedValue SILGenBuilder::createInputFunctionArgument(
SILType type, std::optional<SILLocation> inputLoc) {
assert(inputLoc.has_value() && "This optional is only for overload resolution "
"purposes! Do not pass in None here!");
return ::createInputFunctionArgument(*this, type, *inputLoc);
}
ManagedValue
SILGenBuilder::createMarkUninitialized(ValueDecl *decl, ManagedValue operand,
MarkUninitializedInst::Kind muKind) {
// We either have an owned or trivial value.
SILValue value = createMarkUninitialized(decl, operand.forward(SGF), muKind);
assert(value->getType().isObject() && "Expected only objects here");
// If we have a trivial value, just return without a cleanup.
if (operand.getOwnershipKind() != OwnershipKind::Owned) {
return ManagedValue::forObjectRValueWithoutOwnership(value);
}
// Otherwise, recreate the cleanup.
return SGF.emitManagedRValueWithCleanup(value);
}
ManagedValue SILGenBuilder::createEnum(SILLocation loc, ManagedValue payload,
EnumElementDecl *decl, SILType type) {
SILValue result = createEnum(loc, payload.forward(SGF), decl, type);
if (result->getOwnershipKind() == OwnershipKind::None)
return ManagedValue::forObjectRValueWithoutOwnership(result);
if (result->getOwnershipKind() == OwnershipKind::Guaranteed)
return ManagedValue::forBorrowedObjectRValue(result);
return SGF.emitManagedRValueWithCleanup(result);
}
ManagedValue SILGenBuilder::createUnconditionalCheckedCast(
SILLocation loc, ManagedValue op,
SILType destLoweredTy, CanType destFormalTy) {
SILValue result =
createUnconditionalCheckedCast(loc, op.forward(SGF),
destLoweredTy, destFormalTy);
return SGF.emitManagedRValueWithCleanup(result);
}
void SILGenBuilder::createCheckedCastBranch(SILLocation loc, bool isExact,
ManagedValue op,
CanType sourceFormalTy,
SILType destLoweredTy,
CanType destFormalTy,
SILBasicBlock *trueBlock,
SILBasicBlock *falseBlock,
ProfileCounter Target1Count,
ProfileCounter Target2Count) {
// Casting a guaranteed value requires ownership preservation.
if (!doesCastPreserveOwnershipForTypes(SGF.SGM.M, op.getType().getASTType(),
destFormalTy)) {
op = op.ensurePlusOne(SGF, loc);
}
createCheckedCastBranch(loc, isExact, op.forward(SGF), sourceFormalTy,
destLoweredTy, destFormalTy, trueBlock, falseBlock,
Target1Count, Target2Count);
}
ManagedValue SILGenBuilder::createUpcast(SILLocation loc, ManagedValue original,
SILType type) {
CleanupCloner cloner(*this, original);
SILValue convertedValue = createUpcast(loc, original.forward(SGF), type);
return cloner.clone(convertedValue);
}
ManagedValue SILGenBuilder::createOptionalSome(SILLocation loc,
ManagedValue arg) {
CleanupCloner cloner(*this, arg);
auto &argTL = SGF.getTypeLowering(arg.getType());
SILType optionalType = SILType::getOptionalType(arg.getType());
if (argTL.isLoadable() || !SGF.silConv.useLoweredAddresses()) {
SILValue someValue =
createOptionalSome(loc, arg.forward(SGF), optionalType);
return cloner.clone(someValue);
}
SILValue tempResult = SGF.emitTemporaryAllocation(loc, optionalType);
RValue rvalue(SGF, loc, arg.getType().getASTType(), arg);
ArgumentSource argValue(loc, std::move(rvalue));
SGF.emitInjectOptionalValueInto(
loc, std::move(argValue), tempResult,
SGF.getTypeLowering(tempResult->getType()));
return ManagedValue::forBorrowedAddressRValue(tempResult);
}
ManagedValue SILGenBuilder::createManagedOptionalNone(SILLocation loc,
SILType type) {
if (!type.isAddressOnly(getFunction()) ||
!SGF.silConv.useLoweredAddresses()) {
SILValue noneValue = createOptionalNone(loc, type);
return SGF.emitManagedRValueWithCleanup(noneValue);
}
SILValue tempResult = SGF.emitTemporaryAllocation(loc, type);
SGF.emitInjectOptionalNothingInto(loc, tempResult,
SGF.getTypeLowering(type));
return ManagedValue::forBorrowedAddressRValue(tempResult);
}
ManagedValue SILGenBuilder::createManagedFunctionRef(SILLocation loc,
SILFunction *f) {
return ManagedValue::forObjectRValueWithoutOwnership(
createFunctionRefFor(loc, f));
}
ManagedValue SILGenBuilder::createTupleElementAddr(SILLocation Loc,
ManagedValue Base,
unsigned Index,
SILType Type) {
SILValue TupleEltAddr =
createTupleElementAddr(Loc, Base.getValue(), Index, Type);
return ManagedValue::forBorrowedAddressRValue(TupleEltAddr);
}
ManagedValue SILGenBuilder::createTupleElementAddr(SILLocation Loc,
ManagedValue Value,
unsigned Index) {
SILType Type = Value.getType().getTupleElementType(Index);
return createTupleElementAddr(Loc, Value, Index, Type);
}
ManagedValue SILGenBuilder::createUncheckedRefCast(SILLocation loc,
ManagedValue value,
SILType type) {
CleanupCloner cloner(*this, value);
SILValue cast = createUncheckedRefCast(loc, value.forward(SGF), type);
return cloner.clone(cast);
}
ManagedValue SILGenBuilder::createUncheckedBitCast(SILLocation loc,
ManagedValue value,
SILType type) {
CleanupCloner cloner(*this, value);
SILValue cast = createUncheckedReinterpretCast(loc, value.getValue(), type);
// Currently createUncheckedBitCast only produces these
// instructions. We assert here to make sure if this changes, this code is
// updated.
assert((isa<UncheckedTrivialBitCastInst>(cast) ||
isa<UncheckedRefCastInst>(cast) ||
isa<UncheckedBitwiseCastInst>(cast) ||
isa<ConvertFunctionInst>(cast)) &&
"SILGenBuilder is out of sync with SILBuilder.");
// If we have a trivial inst, just return early.
if (isa<UncheckedTrivialBitCastInst>(cast))
return ManagedValue::forObjectRValueWithoutOwnership(cast);
// If we perform an unchecked bitwise case, then we are producing a new RC
// identity implying that we need a copy of the casted value to be returned so
// that the inputs/outputs of the case have separate ownership.
if (isa<UncheckedBitwiseCastInst>(cast)) {
return SGF.B.copyOwnedObjectRValue(loc, cast,
ManagedValue::ScopeKind::Lexical);
}
// Otherwise, we forward the cleanup of the input value and place the cleanup
// on the cast value since unchecked_ref_cast is "forwarding".
value.forward(SGF);
return cloner.clone(cast);
}
ManagedValue SILGenBuilder::createOpenExistentialRef(SILLocation loc,
ManagedValue original,
SILType type) {
CleanupCloner cloner(*this, original);
SILValue openedExistential =
createOpenExistentialRef(loc, original.forward(SGF), type);
return cloner.clone(openedExistential);
}
ManagedValue SILGenBuilder::createOpenExistentialValue(SILLocation loc,
ManagedValue original,
SILType type) {
ManagedValue borrowedExistential = original.formalAccessBorrow(SGF, loc);
SILValue openedExistential =
createOpenExistentialValue(loc, borrowedExistential.getValue(), type);
return ManagedValue::forBorrowedObjectRValue(openedExistential);
}
ManagedValue SILGenBuilder::createOpenExistentialBoxValue(SILLocation loc,
ManagedValue original,
SILType type) {
ManagedValue borrowedExistential = original.formalAccessBorrow(SGF, loc);
SILValue openedExistential =
createOpenExistentialBoxValue(loc, borrowedExistential.getValue(), type);
return ManagedValue::forBorrowedObjectRValue(openedExistential);
}
ManagedValue SILGenBuilder::createOpenExistentialBox(SILLocation loc,
ManagedValue original,
SILType type) {
ManagedValue borrowedExistential = original.formalAccessBorrow(SGF, loc);
SILValue openedExistentialAddr =
createOpenExistentialBox(loc, borrowedExistential.getValue(), type);
return ManagedValue::forBorrowedAddressRValue(openedExistentialAddr);
}
ManagedValue SILGenBuilder::createOpenExistentialMetatype(SILLocation loc,
ManagedValue value,
SILType openedType) {
SILValue result = SILGenBuilder::createOpenExistentialMetatype(
loc, value.getValue(), openedType);
return ManagedValue::forRValueWithoutOwnership(result);
}
ManagedValue SILGenBuilder::createStore(SILLocation loc, ManagedValue value,
SILValue address,
StoreOwnershipQualifier qualifier) {
CleanupCloner cloner(*this, value);
if (value.getOwnershipKind() == OwnershipKind::None)
qualifier = StoreOwnershipQualifier::Trivial;
createStore(loc, value.forward(SGF), address, qualifier);
return cloner.clone(address);
}
ManagedValue SILGenBuilder::createSuperMethod(SILLocation loc,
ManagedValue operand,
SILDeclRef member,
SILType methodTy) {
SILValue v = createSuperMethod(loc, operand.getValue(), member, methodTy);
return ManagedValue::forObjectRValueWithoutOwnership(v);
}
ManagedValue SILGenBuilder::createObjCSuperMethod(SILLocation loc,
ManagedValue operand,
SILDeclRef member,
SILType methodTy) {
SILValue v = createObjCSuperMethod(loc, operand.getValue(), member, methodTy);
return ManagedValue::forObjectRValueWithoutOwnership(v);
}
ManagedValue SILGenBuilder::
createValueMetatype(SILLocation loc, SILType metatype,
ManagedValue base) {
SILValue v = createValueMetatype(loc, metatype, base.getValue());
return ManagedValue::forObjectRValueWithoutOwnership(v);
}
ManagedValue SILGenBuilder::createStoreBorrow(SILLocation loc,
ManagedValue value,
SILValue address) {
assert(value.getOwnershipKind() == OwnershipKind::Guaranteed);
auto *sbi = createStoreBorrow(loc, value.getValue(), address);
SGF.Cleanups.pushCleanup<EndBorrowCleanup>(sbi);
return ManagedValue::forBorrowedAddressRValue(sbi);
}
ManagedValue SILGenBuilder::createFormalAccessStoreBorrow(SILLocation loc,
ManagedValue value,
SILValue address) {
assert(value.getOwnershipKind() == OwnershipKind::Guaranteed);
auto *sbi = createStoreBorrow(loc, value.getValue(), address);
return SGF.emitFormalEvaluationManagedBorrowedRValueWithCleanup(
loc, value.getValue(), sbi);
}
ManagedValue SILGenBuilder::createStoreBorrowOrTrivial(SILLocation loc,
ManagedValue value,
SILValue address) {
if (value.getOwnershipKind() == OwnershipKind::None) {
createStore(loc, value, address, StoreOwnershipQualifier::Trivial);
return ManagedValue::forTrivialAddressRValue(address);
}
return createStoreBorrow(loc, value, address);
}
ManagedValue SILGenBuilder::createBridgeObjectToRef(SILLocation loc,
ManagedValue mv,
SILType destType) {
CleanupCloner cloner(*this, mv);
SILValue result = createBridgeObjectToRef(loc, mv.forward(SGF), destType);
return cloner.clone(result);
}
ManagedValue SILGenBuilder::createRefToBridgeObject(SILLocation loc,
ManagedValue mv,
SILValue bits) {
CleanupCloner cloner(*this, mv);
SILValue result = createRefToBridgeObject(loc, mv.forward(SGF), bits);
return cloner.clone(result);
}
ManagedValue SILGenBuilder::createBlockToAnyObject(SILLocation loc,
ManagedValue v,
SILType destType) {
assert(SGF.getASTContext().LangOpts.EnableObjCInterop);
assert(destType.isAnyObject());
assert(v.getType().is<SILFunctionType>());
assert(v.getType().castTo<SILFunctionType>()->getRepresentation() ==
SILFunctionTypeRepresentation::Block);
// For now, we don't have a better instruction than this.
return createUncheckedRefCast(loc, v, destType);
}
BranchInst *SILGenBuilder::createBranch(SILLocation loc,
SILBasicBlock *targetBlock,
ArrayRef<ManagedValue> args) {
llvm::SmallVector<SILValue, 8> newArgs;
llvm::transform(args, std::back_inserter(newArgs),
[&](ManagedValue mv) -> SILValue { return mv.forward(SGF); });
return createBranch(loc, targetBlock, newArgs);
}
ReturnInst *SILGenBuilder::createReturn(SILLocation loc,
ManagedValue returnValue) {
return createReturn(loc, returnValue.forward(SGF));
}
ReturnInst *
SILGenBuilder::createReturn(SILLocation loc, SILValue returnValue,
AssertingManualScope &&functionLevelScope) {
std::move(functionLevelScope).pop();
return createReturn(loc, returnValue);
}
ManagedValue SILGenBuilder::createTuple(SILLocation loc, SILType type,
ArrayRef<ManagedValue> elements) {
// Handle the empty tuple case.
if (elements.empty()) {
SILValue result = createTuple(loc, type, ArrayRef<SILValue>());
return ManagedValue::forObjectRValueWithoutOwnership(result);
}
// We need to look for the first value without .none ownership and use that as
// our cleanup cloner value.
auto iter = find_if(elements, [&](ManagedValue mv) -> bool {
return mv.getOwnershipKind() != OwnershipKind::None;
});
llvm::SmallVector<SILValue, 8> forwardedValues;
// If we have all .none values, then just create the tuple and return. No
// cleanups need to be cloned.
if (iter == elements.end()) {
llvm::transform(elements, std::back_inserter(forwardedValues),
[&](ManagedValue mv) -> SILValue {
return mv.forward(getSILGenFunction());
});
SILValue result = createTuple(loc, type, forwardedValues);
return ManagedValue::forObjectRValueWithoutOwnership(result);
}
// Otherwise, we use that values cloner. This is taking advantage of
// instructions that forward ownership requiring that all input values have
// the same ownership if they are non-trivial.
CleanupCloner cloner(*this, *iter);
llvm::transform(elements, std::back_inserter(forwardedValues),
[&](ManagedValue mv) -> SILValue {
return mv.forward(getSILGenFunction());
});
return cloner.clone(createTuple(loc, type, forwardedValues));
}
ManagedValue SILGenBuilder::createUncheckedAddrCast(SILLocation loc, ManagedValue op,
SILType resultTy) {
CleanupCloner cloner(*this, op);
SILValue cast = createUncheckedAddrCast(loc, op.forward(SGF), resultTy);
return cloner.clone(cast);
}
ManagedValue SILGenBuilder::createUncheckedTrivialBitCast(SILLocation loc,
ManagedValue original,
SILType type) {
SILValue result =
SGF.B.createUncheckedTrivialBitCast(loc, original.getValue(), type);
return ManagedValue::forObjectRValueWithoutOwnership(result);
}
void SILGenBuilder::emitDestructureValueOperation(
SILLocation loc, ManagedValue value,
llvm::function_ref<void(unsigned, ManagedValue)> func) {
CleanupCloner cloner(*this, value);
// NOTE: We can not directly use SILBuilder::emitDestructureValueOperation()
// here since we need to create all of our cleanups before invoking \p
// func. This is necessary since our func may want to emit conditional code
// with an early exit, emitting unused cleanups from the current scope via the
// function emitBranchAndCleanups(). If we have not yet created those
// cleanups, we will introduce a leak along that path.
SmallVector<ManagedValue, 8> destructuredValues;
emitDestructureValueOperation(
loc, value.forward(SGF), [&](unsigned index, SILValue subValue) {
destructuredValues.push_back(cloner.clone(subValue));
});
for (auto p : llvm::enumerate(destructuredValues)) {
func(p.index(), p.value());
}
}
void SILGenBuilder::emitDestructureValueOperation(
SILLocation loc, ManagedValue value,
SmallVectorImpl<ManagedValue> &destructuredValues) {
CleanupCloner cloner(*this, value);
emitDestructureValueOperation(
loc, value.forward(SGF), [&](unsigned index, SILValue subValue) {
destructuredValues.push_back(cloner.clone(subValue));
});
}