libswift: add the SIL Builder

And two example instruction building functions.

Author: eeckstein

include/swift/SIL/SILBridging.h

@@ -166,6 +166,13 @@ BridgedMultiValueResult
 BridgedStringRef CondFailInst_getMessage(BridgedInstruction cfi);
 BridgedGlobalVar GlobalAccessInst_getGlobal(BridgedInstruction globalInst);
 
+BridgedInstruction SILBuilder_createBuiltinBinaryFunction(
+          BridgedInstruction insertionPoint,
+          BridgedLocation loc, BridgedStringRef name,
+          BridgedType operandType, BridgedType resultType, BridgedValueArray arguments);
+BridgedInstruction SILBuilder_createCondFail(BridgedInstruction insertionPoint,
+          BridgedLocation loc, BridgedValue condition, BridgedStringRef messge);
+
 #ifdef __cplusplus
 } // extern "C"
 #endif

include/swift/SIL/SILBuilder.h

@@ -123,6 +123,13 @@ class SILBuilder {
     setInsertionPoint(I);
   }
 
+  // Used by libswift bridging.
+  explicit SILBuilder(SILInstruction *I, const SILDebugScope *debugScope)
+      : TempContext(I->getFunction()->getModule()),
+        C(TempContext), F(I->getFunction()), CurDebugScope(debugScope) {
+    setInsertionPoint(I);
+  }
+
   explicit SILBuilder(SILBasicBlock::iterator I,
                       SmallVectorImpl<SILInstruction *> *InsertedInstrs = 0)
       : SILBuilder(&*I, InsertedInstrs) {}

lib/SIL/Utils/SILBridging.cpp

@@ -13,6 +13,7 @@
 #include "swift/SIL/SILNode.h"
 #include "swift/SIL/SILBridgingUtils.h"
 #include "swift/SIL/SILGlobalVariable.h"
+#include "swift/SIL/SILBuilder.h"
 
 using namespace swift;
 
@@ -361,3 +362,26 @@ BridgedStringRef CondFailInst_getMessage(BridgedInstruction cfi) {
 BridgedGlobalVar GlobalAccessInst_getGlobal(BridgedInstruction globalInst) {
   return {castToInst<GlobalAccessInst>(globalInst)->getReferencedGlobal()};
 }
+
+//===----------------------------------------------------------------------===//
+//                                SILBuilder
+//===----------------------------------------------------------------------===//
+
+BridgedInstruction SILBuilder_createBuiltinBinaryFunction(
+          BridgedInstruction insertionPoint,
+          BridgedLocation loc, BridgedStringRef name,
+          BridgedType operandType, BridgedType resultType,
+          BridgedValueArray arguments) {
+    SILBuilder builder(castToInst(insertionPoint), getSILDebugScope(loc));
+    SmallVector<SILValue, 16> argValues;
+    return {builder.createBuiltinBinaryFunction(getRegularLocation(loc),
+      getStringRef(name), getSILType(operandType), getSILType(resultType),
+      getSILValues(arguments, argValues))};
+}
+
+BridgedInstruction SILBuilder_createCondFail(BridgedInstruction insertionPoint,
+          BridgedLocation loc, BridgedValue condition, BridgedStringRef messge) {
+  SILBuilder builder(castToInst(insertionPoint), getSILDebugScope(loc));
+  return {builder.createCondFail(getRegularLocation(loc),
+    castToSILValue(condition), getStringRef(messge))};
+}

libswift/Sources/Optimizer/PassManager/PassUtils.swift

@@ -49,3 +49,15 @@ struct FunctionPass {
   }
 }
 
+extension Builder {
+  init(at insPnt: Instruction, location: Location,
+       _ context: FunctionPassContext) {
+    self.init(insertionPoint: insPnt, location: location,
+              passContext: context.passContext)
+  }
+
+  init(at insPnt: Instruction, _ context: FunctionPassContext) {
+    self.init(insertionPoint: insPnt, location: insPnt.location,
+              passContext: context.passContext)
+  }
+}

libswift/Sources/SIL/Builder.swift

@@ -0,0 +1,63 @@
+//===--- Builder.swift -  Building and modifying SIL ----------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2021 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 SILBridging
+
+/// A utility to create new instructions at a given insertion point.
+public struct Builder {
+  let insertionPoint: Instruction
+  let location: Location
+  private let passContext: BridgedPassContext
+
+  private var bridgedInsPoint: BridgedInstruction { insertionPoint.bridged }
+
+  private func notifyInstructionsChanged() {
+    PassContext_notifyChanges(passContext, instructionsChanged)
+  }
+
+  private func notifyCallsChanged() {
+    PassContext_notifyChanges(passContext, callsChanged)
+  }
+
+  private func notifyBranchesChanged() {
+    PassContext_notifyChanges(passContext, branchesChanged)
+  }
+
+  public init(insertionPoint: Instruction, location: Location,
+              passContext: BridgedPassContext) {
+    self.insertionPoint = insertionPoint
+    self.location = location;
+    self.passContext = passContext
+  }
+
+  public func createBuiltinBinaryFunction(name: String,
+      operandType: Type, resultType: Type, arguments: [Value]) -> BuiltinInst {
+    notifyInstructionsChanged()
+    return arguments.withBridgedValues { valuesRef in
+      return name.withBridgedStringRef { nameStr in
+        let bi = SILBuilder_createBuiltinBinaryFunction(
+          bridgedInsPoint, location.bridgedLocation, nameStr,
+          operandType.silType, resultType.silType, valuesRef)
+        return bi.getAs(BuiltinInst.self)
+      }
+    }
+  }
+
+  public func createCondFail(condition: Value, message: String) -> CondFailInst {
+    notifyInstructionsChanged()
+    return message.withBridgedStringRef { messageStr in
+      let cf = SILBuilder_createCondFail(
+        bridgedInsPoint, location.bridgedLocation, condition.bridged, messageStr)
+      return cf.getAs(CondFailInst.self)
+    }
+  }
+}

libswift/Sources/SIL/CMakeLists.txt

@@ -9,6 +9,7 @@
 add_libswift_module(SIL
   Argument.swift
   BasicBlock.swift
+  Builder.swift
   Function.swift
   GlobalVariable.swift
   Instruction.swift