Merge pull request #198 from CodaFi/file-format

Add accessors for DIFile

Author: CodaFi

Sources/LLVM/IRMetadata.swift

@@ -1,5 +1,6 @@
 #if SWIFT_PACKAGE
 import cllvm
+import llvmshims
 #endif
 
 /// An unfortunate artifact of the design of the metadata class hierarchy is
@@ -79,6 +80,13 @@ extension IRMetadata {
 /// Denotes a scope in which child metadata nodes can be inserted.
 public protocol DIScope: IRMetadata {}
 
+extension DIScope {
+  /// Retrieves the file metadata associated with this scope, if any.
+  public var file: FileMetadata? {
+    return LLVMDIScopeGetFile(self.asMetadata()).map(FileMetadata.init(llvm:))
+  }
+}
+
 /// Denotes metadata for a type.
 public protocol DIType: DIScope {}
 
@@ -206,6 +214,27 @@ public struct FileMetadata: DIScope {
   public init(llvm: LLVMMetadataRef) {
     self.llvm = llvm
   }
+
+  /// Retrieves the name of this file
+  public var name: String {
+    var length: UInt32 = 0
+    let cstring = LLVMDIFileGetFilename(self.asMetadata(), &length)
+    return String(cString: cstring!)
+  }
+
+  /// Retrieves the directory of this file
+  public var directory: String {
+    var length: UInt32 = 0
+    let cstring = LLVMDIFileGetDirectory(self.asMetadata(), &length)
+    return String(cString: cstring!)
+  }
+
+  /// Retrieves the source text of this file.
+  public var source: String {
+    var length: UInt32 = 0
+    let cstring = LLVMDIFileGetSource(self.asMetadata(), &length)
+    return String(cString: cstring!)
+  }
 }
 
 /// `DIBasicType` nodes represent primitive types, such as `int`, `bool` and

Sources/llvmshims/include/shim.h

@@ -77,4 +77,9 @@ void LLVMInstructionSetDebugLoc(LLVMValueRef Inst, LLVMMetadataRef Loc);
 LLVMMetadataRef LLVMGetCurrentDebugLocation2(LLVMBuilderRef Builder);
 void LLVMSetCurrentDebugLocation2(LLVMBuilderRef Builder, LLVMMetadataRef Loc);
 
+LLVMMetadataRef LLVMDIScopeGetFile(LLVMMetadataRef Scope);
+const char *LLVMDIFileGetDirectory(LLVMMetadataRef File, unsigned *Len);
+const char *LLVMDIFileGetFilename(LLVMMetadataRef File, unsigned *Len);
+const char *LLVMDIFileGetSource(LLVMMetadataRef File, unsigned *Len);
+
 #endif /* LLVMSWIFT_LLVM_SHIM_H */

Sources/llvmshims/src/shim.cpp

@@ -1,4 +1,6 @@
 #include "llvm-c/Object.h"
+#include "llvm/IR/DebugInfo.h"
+#include "llvm/IR/DIBuilder.h"
 #include "llvm/IR/Intrinsics.h"
 #include "llvm/IR/Function.h"
 #include "llvm/IR/IRBuilder.h"
@@ -94,6 +96,12 @@ extern "C" {
   // https://reviews.llvm.org/D60484
   LLVMMetadataRef LLVMGetCurrentDebugLocation2(LLVMBuilderRef Builder);
   void LLVMSetCurrentDebugLocation2(LLVMBuilderRef Builder, LLVMMetadataRef Loc);
+
+  // https://reviews.llvm.org/D60489
+  LLVMMetadataRef LLVMDIScopeGetFile(LLVMMetadataRef Scope);
+  const char *LLVMDIFileGetDirectory(LLVMMetadataRef File, unsigned *Len);
+  const char *LLVMDIFileGetFilename(LLVMMetadataRef File, unsigned *Len);
+  const char *LLVMDIFileGetSource(LLVMMetadataRef File, unsigned *Len);
 }
 
 using namespace llvm;
@@ -277,3 +285,28 @@ void LLVMSetCurrentDebugLocation2(LLVMBuilderRef Builder, LLVMMetadataRef Loc) {
   else
     unwrap(Builder)->SetCurrentDebugLocation(DebugLoc());
 }
+
+const char *LLVMDIFileGetDirectory(LLVMMetadataRef File, unsigned *Len) {
+  auto Dir = unwrap<DIFile>(File)->getDirectory();
+  *Len = Dir.size();
+  return Dir.data();
+}
+
+const char *LLVMDIFileGetFilename(LLVMMetadataRef File, unsigned *Len) {
+  auto Dir = unwrap<DIFile>(File)->getFilename();
+  *Len = Dir.size();
+  return Dir.data();
+}
+
+const char *LLVMDIFileGetSource(LLVMMetadataRef File, unsigned *Len) {
+  if (auto Dir = unwrap<DIFile>(File)->getSource()) {
+    *Len = Dir->size();
+    return Dir->data();
+  }
+  *Len = 0;
+  return "";
+}
+
+LLVMMetadataRef LLVMDIScopeGetFile(LLVMMetadataRef Scope) {
+  return wrap(unwrap<DIScope>(Scope)->getFile());
+}

Tests/LLVMTests/DIBuilderSpec.swift

@@ -21,7 +21,6 @@ class DIBuilderSpec : XCTestCase {
       let file = debugBuilder.buildFile(named: "test.trill", in: "/")
       // DIBUILDER-DAG: !{{[0-9]+}} = distinct !DICompileUnit(language: DW_LANG_Swift, file: !{{[0-9]+}}, isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, enums: !{{[0-9]+}}, splitDebugInlining: false)
       _ = debugBuilder.buildCompileUnit(for: .swift, in: file, kind: .full, optimized: false, runtimeVersion: 0)
-
       debugBuilder.finalize()
       module.dump()
     })
@@ -78,9 +77,26 @@ class DIBuilderSpec : XCTestCase {
     })
   }
 
+  func testDIScopeAccessors() {
+    let module = Module(name: "DISCope")
+    let debugBuilder = DIBuilder(module: module)
+
+    let directory = "/some/long/directory/name"
+    let fileName = "test.trill"
+    let file = debugBuilder.buildFile(named: fileName, in: directory)
+    let cu = debugBuilder.buildCompileUnit(for: .swift, in: file, kind: .full, optimized: false, runtimeVersion: 0)
+
+    XCTAssertEqual(cu.file?.name, fileName)
+    XCTAssertEqual(cu.file?.directory, directory)
+    // FIXME: Empty, for now.  Need hashing and DWARF 5 source text bindings.
+    XCTAssertEqual(cu.file?.source, "")
+  }
+
   #if !os(macOS)
   static var allTests = testCase([
     ("testDIBuilder", testDIBuilder),
+    ("testDIExpression", testDIExpression),
+    ("testDIScopeAccessors", testDIScopeAccessors),
   ])
   #endif
 }