Skip to content

SILInliner: Disable inlining mulitple yields and don't create a temporary for yielded address values #18477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 3, 2018
Merged

SILInliner: Disable inlining mulitple yields and don't create a temporary for yielded address values #18477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions include/swift/SILOptimizer/Utils/SILInliner.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ class SILInliner : public TypeSubstCloner<SILInliner> {
public:
enum class InlineKind { MandatoryInline, PerformanceInline };

// Returns true if this an begin_apply instruction that we can inline or
// another application site.
static bool canInlineBeginApply(FullApplySite AI);

private:
InlineKind IKind;

Expand Down
5 changes: 5 additions & 0 deletions lib/SILOptimizer/Utils/PerformanceInlinerUtils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -661,6 +661,11 @@ SILFunction *swift::getEligibleFunction(FullApplySite AI,
if (!Callee) {
return nullptr;
}

// We don't currently support inlining co-routines with several yields.
if (!SILInliner::canInlineBeginApply(AI))
return nullptr;

auto ModuleName = Callee->getModule().getSwiftModule()->getName().str();
bool IsInStdlib = (ModuleName == STDLIB_NAME || ModuleName == SWIFT_ONONE_SUPPORT);

Expand Down
36 changes: 23 additions & 13 deletions lib/SILOptimizer/Utils/SILInliner.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,32 @@
#include "llvm/Support/Debug.h"
using namespace swift;

bool SILInliner::canInlineBeginApply(FullApplySite AI) {
// Don't inline a coroutine with multiple yields. We are not yet able to do
// so. The current implementation cannot handle values that are live across
// only some yields.
unsigned NumYields = 0;
if (auto BA = dyn_cast<BeginApplyInst>(AI)) {
for (auto &B : BA->getReferencedFunction()->getBlocks()) {
if (isa<YieldInst>(B.getTerminator()))
NumYields++;
if (NumYields > 1)
return false;
}
}
return true;
}

bool SILInliner::canInlineFunction(FullApplySite AI) {
if (!canInlineBeginApply(AI))
return false;
return AI.getFunction() != &Original;
}

/// Utility class for rewiring control-flow of inlined begin_apply functions.
class BeginApplySite {
SmallVector<SILBasicBlock *, 4> ExitingBlocks;
SmallVector<AllocStackInst*, 8> YieldedIndirectValues;
SmallVector<SILValue, 8> YieldedIndirectValues;
SILLocation Loc;
SILBuilder &Builder;
BeginApplyInst *BeginApply;
Expand Down Expand Up @@ -77,17 +95,10 @@ class BeginApplySite {
void processApply(SILBasicBlock *ReturnToBB) {
// Handle direct and indirect results.
for (auto YieldedValue : BeginApply->getYieldedValues()) {
// Insert an alloc_stack for indirect results.
// Store the addresses of indirect results so that we can replace them by
// the yielded address value later.
if (YieldedValue->getType().isAddress()) {
Builder.setInsertionPoint(F->getEntryBlock()->begin());
auto Addr = Builder.createAllocStack(
Loc, YieldedValue->getType().getObjectType());
YieldedValue->replaceAllUsesWith(Addr);
YieldedIndirectValues.push_back(Addr);
for (auto *Exit : ExitingBlocks) {
Builder.setInsertionPoint(Exit->getTerminator());
Builder.createDeallocStack(Loc, Addr);
}
YieldedIndirectValues.push_back(YieldedValue);
continue;
}
// Insert a phi for direct results.
Expand Down Expand Up @@ -148,8 +159,7 @@ class BeginApplySite {
auto YieldedVal = remapValue(CalleeYieldedVal);
if (YieldedVal->getType().isAddress()) {
auto YieldedDestAddr = YieldedIndirectValues[IndirectIdx++];
Builder.createCopyAddr(Loc, YieldedVal, YieldedDestAddr, IsTake,
IsInitialization);
YieldedDestAddr->replaceAllUsesWith(YieldedVal);
} else
BrResults.push_back(YieldedVal);
}
Expand Down
173 changes: 97 additions & 76 deletions test/SILOptimizer/inline_begin_apply.sil
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ unwind:

// CHECK-LABEL: sil @test_simple_call
// CHECK: bb0(%0 : @trivial $Builtin.Int1):
// CHECK: [[IND_RES:%.*]] = alloc_stack $Indirect<SomeSubclass>
// CHECK: [[MARKER:%.*]] = function_ref @marker
// CHECK: [[MARKER2:%.*]] = function_ref @marker
// CHECK: [[I:%.*]] = integer_literal $Builtin.Int32, 1000
Expand All @@ -55,7 +54,6 @@ unwind:
// CHECK: [[MK_IND:%.*]] = function_ref @make_indirect
// CHECK: apply [[MK_IND]]<SomeSubclass>([[TEMP]])
// CHECK: [[INTTOKEN:%.*]] = integer_literal $Builtin.Int32, 0
// CHECK: copy_addr [take] [[TEMP]] to [initialization] [[IND_RES]] : $*Indirect<SomeSubclass>
// CHECK: br bb3([[INTTOKEN]] : $Builtin.Int32)

// CHECK:bb1:
Expand All @@ -71,7 +69,7 @@ unwind:
// CHECK: br bb7

// CHECK: bb3([[WHICH_YIELD:%.*]] : @trivial $Builtin.Int32):
// CHECK: destroy_addr [[IND_RES]] : $*Indirect<SomeSubclass>
// CHECK: destroy_addr [[TEMP]] : $*Indirect<SomeSubclass>
// CHECK: cond_br %0, bb4, bb6

// CHECK: bb4:
Expand All @@ -82,7 +80,7 @@ unwind:

// CHECK: bb5:
// CHECK: [[I5:%.*]] = integer_literal $Builtin.Int32, 20
// CHECK: %29 = apply [[MARKER]]([[I5]])
// CHECK: apply [[MARKER]]([[I5]])
// CHECK: br bb8

// CHECK: bb6:
Expand All @@ -97,7 +95,6 @@ unwind:
// CHECK: br bb8

// CHECK:bb8:
// CHECK: dealloc_stack [[IND_RES]] : $*Indirect<SomeSubclass>
// CHECK: return
// CHECK:}

Expand Down Expand Up @@ -173,79 +170,11 @@ unwind:
unwind
}

// We don't support inlining functions with multiple yields yet.
// CHECK-LABEL: sil @test_simple_call_two_yields : $@convention(thin) (Builtin.Int1, Builtin.Int1) -> () {
// CHECK: bb0(%0 : @trivial $Builtin.Int1, %1 : @trivial $Builtin.Int1):
// CHECK: %2 = alloc_stack $Indirect<SomeSubclass>
// CHECK: %3 = function_ref @marker : $@convention(thin) (Builtin.Int32) -> ()
// CHECK: %4 = function_ref @marker : $@convention(thin) (Builtin.Int32) -> ()
// CHECK: %5 = integer_literal $Builtin.Int32, 1000
// CHECK: %6 = apply %4(%5) : $@convention(thin) (Builtin.Int32) -> ()
// CHECK: %7 = alloc_stack $Indirect<SomeSubclass>
// CHECK: %8 = function_ref @make_indirect
// CHECK: cond_br %0, bb1, bb6

// CHECK: bb1:
// CHECK: %10 = apply %8<SomeSubclass>(%7)
// CHECK: %11 = integer_literal $Builtin.Int64, 31
// CHECK: %12 = integer_literal $Builtin.Int32, 0
// CHECK: copy_addr [take] %7 to [initialization] %2 : $*Indirect<SomeSubclass>
// CHECK: br bb9(%11 : $Builtin.Int64, %12 : $Builtin.Int32)

// CHECK: bb2:
// CHECK: br bb3

// CHECK: bb3:
// CHECK: %16 = integer_literal $Builtin.Int32, 2000
// CHECK: %17 = apply %4(%16)
// CHECK: dealloc_stack %7 : $*Indirect<SomeSubclass>
// CHECK: br bb11

// CHECK: bb4:
// CHECK: br bb5

// CHECK: bb5:
// CHECK: %22 = integer_literal $Builtin.Int32, 3000
// CHECK: %23 = apply %4(%22)
// CHECK: dealloc_stack %7 : $*Indirect<SomeSubclass>
// CHECK: br bb13

// CHECK: bb6:
// CHECK: %26 = apply %8<SomeSubclass>(%7) : $@convention(thin) <τ_0_0 where τ_0_0 : SomeClass> () -> @out Indirect<τ_0_0>
// CHECK: %27 = integer_literal $Builtin.Int64, 32
// CHECK: %28 = integer_literal $Builtin.Int32, 1
// CHECK: copy_addr [take] %7 to [initialization] %2 : $*Indirect<SomeSubclass>
// CHECK: br bb9(%27 : $Builtin.Int64, %28 : $Builtin.Int32)

// CHECK: bb7:
// CHECK: br bb3

// CHECK: bb8:
// CHECK: br bb5

// CHECK: bb9(%33 : @trivial $Builtin.Int64, %34 : @trivial $Builtin.Int32):
// CHECK: destroy_addr %2 : $*Indirect<SomeSubclass>
// CHECK: cond_br %1, bb10, bb12

// CHECK: bb10:
// CHECK: %37 = integer_literal $Builtin.Int32, 0
// CHECK: %38 = integer_literal $Builtin.Int32, 1
// CHECK: switch_value %34 : $Builtin.Int32, case %37: bb2, case %38: bb7

// CHECK: bb11:
// CHECK: br bb14

// CHECK: bb12:
// CHECK: %41 = integer_literal $Builtin.Int32, 0
// CHECK: %42 = integer_literal $Builtin.Int32, 1
// CHECK: switch_value %34 : $Builtin.Int32, case %41: bb4, case %42: bb8

// CHECK: bb13:
// CHECK: br bb14

// CHECK: bb14:
// CHECK: %45 = tuple ()
// CHECK: dealloc_stack %2 : $*Indirect<SomeSubclass>
// CHECK: return %45 : $()
// CHECK: begin_apply
// CHECK: return

sil @test_simple_call_two_yields : $(Builtin.Int1, Builtin.Int1) -> () {
entry(%flag : @trivial $Builtin.Int1, %flag2 : @trivial $Builtin.Int1):
Expand Down Expand Up @@ -348,3 +277,95 @@ cont:
%ret = tuple ()
return %ret : $()
}

sil @use : $@convention(thin) (@in Builtin.Int8) -> ()

sil [transparent] @yield_inout : $@yield_once() -> (@yields @inout Builtin.Int8) {
entry:
%addr = alloc_stack $Builtin.Int8
%8 = integer_literal $Builtin.Int8, 8
store %8 to [trivial] %addr : $*Builtin.Int8
yield %addr : $*Builtin.Int8, resume resume, unwind unwind

resume:
%use = function_ref @use : $@convention(thin) (@in Builtin.Int8) -> ()
apply %use(%addr) : $@convention(thin) (@in Builtin.Int8) -> ()
dealloc_stack %addr: $*Builtin.Int8
%ret = tuple ()
return %ret : $()

unwind:
%3000 = integer_literal $Builtin.Int32, 3000
%marker = function_ref @marker : $@convention(thin) (Builtin.Int32) -> ()
apply %marker(%3000) : $@convention(thin) (Builtin.Int32) -> ()
dealloc_stack %addr: $*Builtin.Int8
unwind
}


// CHECK: sil @test_simple_call_yield_inout : $@convention(thin) (Builtin.Int1) -> () {
// CHECK: bb0(%0 : @trivial $Builtin.Int1):
// CHECK: %1 = alloc_stack $Builtin.Int8
// CHECK: %2 = integer_literal $Builtin.Int8, 8
// CHECK: store %2 to [trivial] %1 : $*Builtin.Int8
// CHECK: %4 = integer_literal $Builtin.Int32, 0
// CHECK: br bb3(%4 : $Builtin.Int32)

// CHECK: bb1:
// CHECK: %6 = function_ref @use : $@convention(thin) (@in Builtin.Int8) -> ()
// CHECK: %7 = apply %6(%1) : $@convention(thin) (@in Builtin.Int8) -> ()
// CHECK: dealloc_stack %1 : $*Builtin.Int8
// CHECK: %9 = tuple ()
// CHECK: br bb5

// CHECK: bb2:
// CHECK: %11 = integer_literal $Builtin.Int32, 3000
// CHECK: %12 = function_ref @marker : $@convention(thin) (Builtin.Int32) -> ()
// CHECK: %13 = apply %12(%11) : $@convention(thin) (Builtin.Int32) -> ()
// CHECK: dealloc_stack %1 : $*Builtin.Int8
// CHECK: br bb7

// CHECK: bb3(%16 : @trivial $Builtin.Int32):
// CHECK: cond_br %0, bb4, bb6

// CHECK: bb4:
// CHECK: %18 = integer_literal $Builtin.Int8, 8
// CHECK: store %18 to [trivial] %1 : $*Builtin.Int8
// CHECK: %20 = integer_literal $Builtin.Int32, 0
// CHECK: switch_value %16 : $Builtin.Int32, case %20: bb1

// CHECK: bb5:
// CHECK: br bb8

// CHECK: bb6:
// CHECK: %23 = integer_literal $Builtin.Int32, 0
// CHECK: switch_value %16 : $Builtin.Int32, case %23: bb2

// CHECK: bb7:
// CHECK: br bb8

// CHECK: bb8:
// CHECK: %26 = tuple ()
// CHECK: return %26 : $()
// CHECK: }

sil @test_simple_call_yield_inout : $(Builtin.Int1) -> () {
entry(%flag : @trivial $Builtin.Int1):
%0 = function_ref @yield_inout : $@convention(thin) @yield_once() -> (@yields @inout Builtin.Int8)
(%addr, %token) = begin_apply %0() : $@convention(thin) @yield_once() -> (@yields @inout Builtin.Int8)
cond_br %flag, yes, no

yes:
%8 = integer_literal $Builtin.Int8, 8
store %8 to [trivial] %addr : $*Builtin.Int8
end_apply %token
br cont

no:
abort_apply %token
br cont

cont:
%ret = tuple ()
return %ret : $()
}