Files
swift-mirror/SwiftCompilerSources/Sources/Optimizer/InstructionSimplification/SimplifyCopyBlock.swift
Erik Eckstein 57e08affcb SIL: add ApplySite.calleeArgument(of operand: Operand, in callee: Function)
This is a safer API than using
```
  let argIdx = applySite.calleeArgumentIndex(of: op)
  let arg = callee.arguments[argIdx]
```
because there is no potential misuse of the index.
2025-06-20 08:14:59 +02:00

108 lines
3.5 KiB
Swift

//===--- SimplifyCopyBlock.swift ------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2025 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
//
//===----------------------------------------------------------------------===//
import SIL
extension CopyBlockInst : Simplifiable, SILCombineSimplifiable {
/// Removes a `copy_block` if its only uses, beside ownership instructions, are callees of function calls
/// ```
/// %2 = copy_block %0
/// %3 = begin_borrow [lexical] %2
/// %4 = apply %3() : $@convention(block) @noescape () -> ()
/// end_borrow %3
/// destroy_value %2
/// ```
/// ->
/// ```
/// %4 = apply %0() : $@convention(block) @noescape () -> ()
/// ```
///
func simplify(_ context: SimplifyContext) {
if hasValidUses(block: self) {
replaceBlock(self, with: operand.value, context)
context.erase(instruction: self)
}
}
}
private func hasValidUses(block: Value) -> Bool {
for use in block.uses {
switch use.instruction {
case let beginBorrow as BeginBorrowInst:
if !hasValidUses(block: beginBorrow) {
return false
}
case let apply as FullApplySite where apply.isCallee(operand: use):
break
case let partialApply as PartialApplyInst:
// If the block is passed to another function - either as closure argument or as closure capture -
// it's "converted" to a swift closure with the help of a thunk. The thunk just calls the block.
// If this is a non-escaping partial_apply and it's such a thunk, the block does not escape.
if partialApply.canClosureArgumentEscape(closure: use) {
return false
}
case is EndBorrowInst, is DestroyValueInst:
break
default:
return false
}
}
return true
}
private func replaceBlock(_ block: Value, with original: Value, _ context: SimplifyContext) {
for use in block.uses {
switch use.instruction {
case let beginBorrow as BeginBorrowInst:
replaceBlock(beginBorrow, with: original, context)
context.erase(instruction: beginBorrow)
case is FullApplySite:
use.set(to: original, context)
case let partialApply as PartialApplyInst:
if original.ownership == .unowned {
let builder = Builder(before: partialApply, context)
let conv = builder.createUncheckedOwnershipConversion(operand: original, resultOwnership: .guaranteed)
use.set(to: conv, context)
} else {
use.set(to: original, context)
}
case is EndBorrowInst, is DestroyValueInst:
context.erase(instruction: use.instruction)
default:
fatalError("unhandled use")
}
}
}
private extension PartialApplyInst {
func canClosureArgumentEscape(closure: Operand) -> Bool {
guard isOnStack,
let callee = referencedFunction,
callee.isDefinition,
let calleeArg = calleeArgument(of: closure, in: callee),
// If the callee only _calls_ the closure argument, it does not escape.
calleeArg.uses.allSatisfy(isCalleeOperandOfApply)
else {
return true
}
return false
}
}
private func isCalleeOperandOfApply(_ operand: Operand) -> Bool {
if let apply = operand.instruction as? FullApplySite, apply.isCallee(operand: operand) {
return true
}
return false
}