Files
swift-mirror/SwiftCompilerSources/Sources/Optimizer/PassManager/ModulePassContext.swift
Erik Eckstein 87f2f41d51 Swift Optimizer: add infrastructure for module passes.
To add a module pass in `Passes.def` use the new `SWIFT_MODULE_PASS` macro.
On the swift side, create a `ModulePass`.
It’s run function receives a `ModulePassContext`, which provides access to all functions of a module.
But it doesn't provide any APIs to modify functions.
In order to modify a function, a module pass must use `ModulePassContext.transform(function:)`.
2022-08-24 17:55:02 +02:00

52 lines
1.8 KiB
Swift

//===--- ModulePassContext.swift ------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import SIL
import OptimizerBridging
/// The context which is passed to a `ModulePass`'s run-function.
///
/// It provides access to all functions of a module, but it doesn't provide any
/// APIs to modify functions.
/// In order to modify a function, a module pass must use `transform(function:)`.
struct ModulePassContext {
let _bridged: BridgedPassContext
struct FunctionList : CollectionLikeSequence, IteratorProtocol {
private var currentFunction: Function?
fileprivate init(first: Function?) { currentFunction = first }
mutating func next() -> Function? {
if let f = currentFunction {
currentFunction = PassContext_nextFunctionInModule(f.bridged).function
return f
}
return nil
}
}
var functions: FunctionList {
FunctionList(first: PassContext_firstFunctionInModule(_bridged).function)
}
/// Run a closure with a `PassContext` for a function, which allows to modify that function.
///
/// Only a single `transform` can be alive at the same time, i.e. it's not allowed to nest
/// calls to `transform`.
func transform(function: Function, _ runOnFunction: (PassContext) -> ()) {
PassContext_beginTransformFunction(function.bridged, _bridged)
runOnFunction(PassContext(_bridged: _bridged))
PassContext_endTransformFunction(_bridged);
}
}