Merge pull request #197 from CodaFi/instruction-locations

Correct the type of debug locations and provide new shims

Author: CodaFi

Sources/LLVM/IRBuilder.swift

@@ -1,5 +1,6 @@
 #if SWIFT_PACKAGE
 import cllvm
+import llvmshims
 #endif
 
 /// An `IRBuilder` is a helper object that generates LLVM instructions.  IR
@@ -38,7 +39,7 @@ extension IRBuilder {
   /// Repositions the IR Builder before the start of the given instruction.
   ///
   /// - parameter inst: The instruction to reposition the IR Builder before.
-  public func positionBefore(_ inst: IRValue) {
+  public func positionBefore(_ inst: IRInstruction) {
     LLVMPositionBuilderBefore(llvm, inst.asLLVM())
   }
 
@@ -50,7 +51,7 @@ extension IRBuilder {
   ///
   /// - parameter inst: The instruction to reposition the IR Builder before.
   /// - parameter block: The basic block to reposition the IR builder in.
-  public func position(_ inst: IRValue, block: BasicBlock) {
+  public func position(_ inst: IRInstruction, block: BasicBlock) {
     LLVMPositionBuilder(llvm, block.llvm, inst.asLLVM())
   }
 
@@ -76,7 +77,7 @@ extension IRBuilder {
   ///
   /// - parameter inst: The instruction to insert.
   /// - parameter name: The name for the newly inserted instruction.
-  public func insert(_ inst: IRValue, name: String? = nil) {
+  public func insert(_ inst: IRInstruction, name: String? = nil) {
     if let name = name {
       LLVMInsertIntoBuilderWithName(llvm, inst.asLLVM(), name)
     } else {
@@ -89,9 +90,9 @@ extension IRBuilder {
 
 extension IRBuilder {
   /// Access location information used by debugging information.
-  public var currentDebugLocation: DebugLocation {
-    get { return DebugLocation(llvm: LLVMValueAsMetadata(LLVMGetCurrentDebugLocation(self.llvm))) }
-    set { LLVMSetCurrentDebugLocation(self.llvm, LLVMMetadataAsValue(self.module.context.llvm, newValue.asMetadata())) }
+  public var currentDebugLocation: DebugLocation? {
+    get { return LLVMGetCurrentDebugLocation2(self.llvm).map(DebugLocation.init(llvm:)) }
+    set { LLVMSetCurrentDebugLocation2(self.llvm, newValue?.asMetadata()) }
   }
 }
 

Sources/LLVM/Instruction.swift

@@ -1,5 +1,6 @@
 #if SWIFT_PACKAGE
 import cllvm
+import llvmshims
 #endif
 
 /// An `IRInstruction` is a value that directly represents an instruction and
@@ -12,6 +13,12 @@ extension IRInstruction {
     return OpCode(rawValue: LLVMGetInstructionOpcode(self.asLLVM()))
   }
 
+  /// Retrieves the current debug location of this instruction.
+  public var debugLocation: DebugLocation? {
+    get { return LLVMInstructionGetDebugLoc(self.asLLVM()).map(DebugLocation.init(llvm:)) }
+    set { LLVMInstructionSetDebugLoc(self.asLLVM(), newValue?.asMetadata()) }
+  }
+
   /// Obtain the instruction that occurs before this one, if it exists.
   public func previous() -> Instruction? {
     guard let val = LLVMGetPreviousInstruction(self.asLLVM()) else { return nil }

Sources/llvmshims/include/shim.h

@@ -71,4 +71,10 @@ LLVMSymbolIteratorRef LLVMObjectFileGetSymbols(LLVMBinaryRef BR);
 LLVMBool LLVMObjectFileIsSymbolIteratorAtEnd(LLVMBinaryRef BR,
                                              LLVMSymbolIteratorRef SI);
 
+LLVMMetadataRef LLVMInstructionGetDebugLoc(LLVMValueRef Inst);
+void LLVMInstructionSetDebugLoc(LLVMValueRef Inst, LLVMMetadataRef Loc);
+
+LLVMMetadataRef LLVMGetCurrentDebugLocation2(LLVMBuilderRef Builder);
+void LLVMSetCurrentDebugLocation2(LLVMBuilderRef Builder, LLVMMetadataRef Loc);
+
 #endif /* LLVMSWIFT_LLVM_SHIM_H */

Sources/llvmshims/src/shim.cpp

@@ -1,6 +1,7 @@
 #include "llvm-c/Object.h"
 #include "llvm/IR/Intrinsics.h"
 #include "llvm/IR/Function.h"
+#include "llvm/IR/IRBuilder.h"
 #include "llvm/Support/ARMTargetParser.h"
 #include "llvm/Object/MachOUniversal.h"
 #include "llvm/Object/ObjectFile.h"
@@ -73,6 +74,14 @@ extern "C" {
 
   LLVMBool LLVMObjectFileIsSymbolIteratorAtEnd(LLVMBinaryRef BR,
                                                LLVMSymbolIteratorRef SI);
+
+  // https://reviews.llvm.org/D60481
+  LLVMMetadataRef LLVMInstructionGetDebugLoc(LLVMValueRef Inst);
+  void LLVMInstructionSetDebugLoc(LLVMValueRef Inst, LLVMMetadataRef Loc);
+
+  // https://reviews.llvm.org/D60484
+  LLVMMetadataRef LLVMGetCurrentDebugLocation2(LLVMBuilderRef Builder);
+  void LLVMSetCurrentDebugLocation2(LLVMBuilderRef Builder, LLVMMetadataRef Loc);
 }
 
 using namespace llvm;
@@ -231,4 +240,24 @@ const char *LLVMGetARMCanonicalArchName(const char *Name, size_t NameLen) {
   return llvm::ARM::getCanonicalArchName({Name, NameLen}).data();
 }
 
+LLVMMetadataRef LLVMInstructionGetDebugLoc(LLVMValueRef Inst) {
+  return wrap(unwrap<Instruction>(Inst)->getDebugLoc().getAsMDNode());
+}
+
+void LLVMInstructionSetDebugLoc(LLVMValueRef Inst, LLVMMetadataRef Loc) {
+  if (Loc)
+    unwrap<Instruction>(Inst)->setDebugLoc(DebugLoc(unwrap<MDNode>(Loc)));
+  else
+    unwrap<Instruction>(Inst)->setDebugLoc(DebugLoc());
+}
+
+LLVMMetadataRef LLVMGetCurrentDebugLocation2(LLVMBuilderRef Builder) {
+  return wrap(unwrap(Builder)->getCurrentDebugLocation().getAsMDNode());
+}
 
+void LLVMSetCurrentDebugLocation2(LLVMBuilderRef Builder, LLVMMetadataRef Loc) {
+  if (Loc)
+    unwrap(Builder)->SetCurrentDebugLocation(DebugLoc(unwrap<MDNode>(Loc)));
+  else
+    unwrap(Builder)->SetCurrentDebugLocation(DebugLoc());
+}

Tests/LLVMTests/BFC.swift

@@ -297,15 +297,15 @@ private func compileProgramBody(
       dibuilder.buildDbgValue(of: addressPointer, to: diVariable,
                               atEndOf: builder.insertBlock!,
                               expr: dibuilder.buildExpression([.deref]),
-                              location: builder.currentDebugLocation)
+                              location: builder.currentDebugLocation!)
     case "<":
       // Move left
       addressPointer = builder.buildGEP(addressPointer, indices: [ IntType.int32.constant(-1) ])
       builder.currentDebugLocation = dibuilder.buildDebugLocation(at: (sourceLine, sourceColumn), in: scope)
       dibuilder.buildDbgValue(of: addressPointer, to: diVariable,
                               atEndOf: builder.insertBlock!,
                               expr: dibuilder.buildExpression([.deref]),
-                              location: builder.currentDebugLocation)
+                              location: builder.currentDebugLocation!)
     case "+":
       // Increment
       let value = builder.buildLoad(addressPointer)
@@ -315,7 +315,7 @@ private func compileProgramBody(
       dibuilder.buildDbgValue(of: value, to: diVariable,
                               atEndOf: builder.insertBlock!,
                               expr: dibuilder.buildExpression([.plus_uconst(1)]),
-                              location: builder.currentDebugLocation)
+                              location: builder.currentDebugLocation!)
     case "-":
       // Decrement
       let value = builder.buildLoad(addressPointer)
@@ -325,7 +325,7 @@ private func compileProgramBody(
       dibuilder.buildDbgValue(of: value, to: diVariable,
                               atEndOf: builder.insertBlock!,
                               expr: dibuilder.buildExpression([.constu(1), .minus]),
-                              location: builder.currentDebugLocation)
+                              location: builder.currentDebugLocation!)
     case ".":
       // Write
       let dataValue = builder.buildLoad(addressPointer)