Merge pull request #71723 from eeckstein/swift-verifier

SwiftCompilerSources: refactor and verify conformances to ForwardingInstruction

Author: eeckstein

SwiftCompilerSources/README.md

@@ -129,8 +129,6 @@ For example, to add a new instruction class:
 *  if needed, add bridging functions to access the instruction's data fields.
 
 
-No yet implemented instruction classes are mapped to a "placeholder" instruction, e.g `UnimplementedInstruction`. This ensures that optimizations can process any kind of SIL, even if some instructions don't have a representation in Swift yet.
-
 ## The Optimizer
 
 Similar to SIL, the optimizer also uses a small bridging layer (`OptimizerBridging.h`).

SwiftCompilerSources/Sources/Optimizer/PassManager/PassRegistration.swift

@@ -17,6 +17,7 @@ import OptimizerBridging
 public func initializeSwiftModules() {
   registerSILClasses()
   registerSwiftAnalyses()
+  registerUtilities()
   registerSwiftPasses()
   registerOptimizerTests()
 }
@@ -120,3 +121,7 @@ private func registerSwiftAnalyses() {
   AliasAnalysis.register()
   CalleeAnalysis.register()
 }
+
+private func registerUtilities() {
+  registerVerifier()
+}

SwiftCompilerSources/Sources/Optimizer/Utilities/CMakeLists.txt

@@ -20,4 +20,5 @@ swift_compiler_sources(Optimizer
   SSAUpdater.swift
   StaticInitCloner.swift
   Test.swift
+  Verifier.swift
 )

SwiftCompilerSources/Sources/Optimizer/Utilities/Verifier.swift

@@ -0,0 +1,58 @@
+//===--- Verifier.swift ---------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2024 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
+
+private protocol VerifyableInstruction : Instruction {
+  func verify(_ context: FunctionPassContext)
+}
+
+private func require(_ condition: Bool, _ message: @autoclosure () -> String) {
+  if !condition {
+    fatalError(message())
+  }
+}
+
+extension Function {
+  func verify(_ context: FunctionPassContext) {
+    for block in blocks {
+      for inst in block.instructions {
+
+        inst.checkForwardingConformance()
+
+        if let verifyableInst = inst as? VerifyableInstruction {
+          verifyableInst.verify(context)
+        }
+      }
+    }
+  }
+}
+
+private extension Instruction {
+  func checkForwardingConformance() {
+    if bridged.shouldBeForwarding() {
+      require(self is ForwardingInstruction, "instruction \(self)\nshould conform to ForwardingInstruction")
+    } else {
+      require(!(self is ForwardingInstruction), "instruction \(self)\nshould not conform to ForwardingInstruction")
+    }
+  }
+}
+
+func registerVerifier() {
+  BridgedUtilities.registerVerifier(
+    { (bridgedCtxt: BridgedPassContext, bridgedFunction: BridgedFunction) in
+      let context = FunctionPassContext(_bridged: bridgedCtxt)
+      bridgedFunction.function.verify(context)
+    }
+  )
+}