Go binding: Add GetCurrentDebugLocation to obtain debug location from builder

[rhysd]

Summary

Currently Go binding only has SetCurrentDebugLocation method.
I added GetCurrentDebugLocation method to IRBuilder instance.

I added this because I want to save current debug location, change debug location temporary and restore the saved one finally.
This is useful when source location jumps and goes back after while LLVM IR generation.

I also added tests for this to ir_test.go.
I confirmed that all test passed with this patch based on r298890

[axw]

LGTM

[axw]

Actually, I've just run the tests and it's asserting:

FAIL: LLVM :: Bindings/Go/go.test (1 of 1)
******************** TEST 'LLVM :: Bindings/Go/go.test' FAILED ********************
Script:
--
/home/andrew/code/src/llvm.org/build/./bin/llvm-go go=/usr/lib/go-1.7/bin/go test llvm.org/llvm/bindings/go/llvm
--
Exit Code: 1

Command Output (stdout):
--
llvm.test: /home/andrew/code/src/llvm.org/llvm/lib/IR/DIBuilder.cpp:45: void llvm::DIBuilder::finalize(): Assertion `!AllowUnresolvedNodes && "creating type nodes without a CU is not supported"' failed.
SIGABRT: abort
PC=0x7f0997eea428 m=0
signal arrived during cgo execution

goroutine 7 [syscall, locked to thread]:
runtime.cgocall(0x111f6f0, 0xc42002bdb8, 0x0)
        /usr/lib/go-1.7/src/runtime/cgocall.go:131 +0x110 fp=0xc42002bd88 sp=0xc42002bd48
llvm.org/llvm/bindings/go/llvm._Cfunc_LLVMDIBuilderFinalize(0x5031680)
        ??:0 +0x41 fp=0xc42002bdb8 sp=0xc42002bd88
llvm.org/llvm/bindings/go/llvm.(*DIBuilder).Finalize(0xc42000c810)
        /tmp/lit_tmp_tlz1QF/gopath176582211/src/llvm.org/llvm/bindings/go/llvm/dibuilder.go:109 +0x78 fp=0xc42002be00 sp=0xc42002bdb8
llvm.org/llvm/bindings/go/llvm.TestDebugLoc.func1(0xc42000c810)
        /tmp/lit_tmp_tlz1QF/gopath176582211/src/llvm.org/llvm/bindings/go/llvm/ir_test.go:110 +0x2b fp=0xc42002be18 sp=0xc42002be00
llvm.org/llvm/bindings/go/llvm.TestDebugLoc(0xc42007e300)
        /tmp/lit_tmp_tlz1QF/gopath176582211/src/llvm.org/llvm/bindings/go/llvm/ir_test.go:137 +0x421 fp=0xc42002bf88 sp=0xc42002be18
testing.tRunner(0xc42007e300, 0x2cd1ab0)
        /usr/lib/go-1.7/src/testing/testing.go:610 +0x81 fp=0xc42002bfb0 sp=0xc42002bf88
runtime.goexit()
        /usr/lib/go-1.7/src/runtime/asm_amd64.s:2086 +0x1 fp=0xc42002bfb8 sp=0xc42002bfb0
created by testing.(*T).Run
        /usr/lib/go-1.7/src/testing/testing.go:646 +0x2ec

goroutine 1 [chan receive]:
testing.(*T).Run(0xc42007e0c0, 0x2cc2f5d, 0xc, 0x2cd1ab0, 0xc42004fd01)
        /usr/lib/go-1.7/src/testing/testing.go:647 +0x316
testing.RunTests.func1(0xc42007e0c0)
        /usr/lib/go-1.7/src/testing/testing.go:793 +0x6d
testing.tRunner(0xc42007e0c0, 0xc42004fe20)
        /usr/lib/go-1.7/src/testing/testing.go:610 +0x81
testing.RunTests(0x2cd1ad8, 0x489b1e0, 0x4, 0x4, 0x104e9e8)
        /usr/lib/go-1.7/src/testing/testing.go:799 +0x2f5
testing.(*M).Run(0xc42004fee8, 0x10c745d)
        /usr/lib/go-1.7/src/testing/testing.go:743 +0x85
main.main()
        llvm.org/llvm/bindings/go/llvm/_test/_testmain.go:60 +0xc6

goroutine 17 [syscall, locked to thread]:
runtime.goexit()
        /usr/lib/go-1.7/src/runtime/asm_amd64.s:2086 +0x1

rax    0x0
rbx    0x7f099936c000
rcx    0x7f0997eea428
rdx    0x6
rdi    0x7cc3
rsi    0x7cc3
rbp    0x3b37a88
rsp    0x7ffd911fdae8
r8     0xfefefefefefefeff
r9     0x1
r10    0x8
r11    0x206
r12    0x2d
r13    0x3b38ee0
r14    0xc
r15    0x3
rip    0x7f0997eea428
rflags 0x206
cs     0x33
fs     0x0
gs     0x0
FAIL    llvm.org/llvm/bindings/go/llvm  0.066s

[rhysd]

Oh, tests passed because I built LLVM with release config (w/o assertions). I'll try debug config and fix the failure.

[rhysd]

I addressed the issue. (I incorrectly called finalizer)

[rhysd]

I confirmed that all tests passed with enabling assertions.

[axw]

Thanks.

[rhysd]

Thank you so much for quick review, axw 😊

llvm/trunk/bindings/go/llvm/IRBindings.h

 
 #include <stdint.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 typedef struct LLVMOpaqueMetadata *LLVMMetadataRef;
+struct LLVMDebugLocMetadata{
+    unsigned Line;
+    unsigned Col;
+    LLVMMetadataRef Scope;
+    LLVMMetadataRef InlinedAt;
+};
 
 LLVMMetadataRef LLVMConstantAsMetadata(LLVMValueRef Val);
 
 LLVMMetadataRef LLVMMDString2(LLVMContextRef C, const char *Str, unsigned SLen);
 LLVMMetadataRef LLVMMDNode2(LLVMContextRef C, LLVMMetadataRef *MDs,
                             unsigned Count);
 LLVMMetadataRef LLVMTemporaryMDNode(LLVMContextRef C, LLVMMetadataRef *MDs,
                                     unsigned Count);
 
 void LLVMAddNamedMetadataOperand2(LLVMModuleRef M, const char *name,
                                   LLVMMetadataRef Val);
 void LLVMSetMetadata2(LLVMValueRef Inst, unsigned KindID, LLVMMetadataRef MD);
 
 void LLVMMetadataReplaceAllUsesWith(LLVMMetadataRef MD, LLVMMetadataRef New);
 
 void LLVMSetCurrentDebugLocation2(LLVMBuilderRef Bref, unsigned Line,
                                   unsigned Col, LLVMMetadataRef Scope,
                                   LLVMMetadataRef InlinedAt);
 
+struct LLVMDebugLocMetadata LLVMGetCurrentDebugLocation2(LLVMBuilderRef Bref);
+
 void LLVMSetSubprogram(LLVMValueRef Fn, LLVMMetadataRef SP);
 
 #ifdef __cplusplus
 }
 
 namespace llvm {
 
 DEFINE_ISA_CONVERSION_FUNCTIONS(Metadata, LLVMMetadataRef)

llvm/trunk/bindings/go/llvm/IRBindings.cpp

 //===- IRBindings.cpp - Additional bindings for ir ------------------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 // This file defines additional C bindings for the ir component.
 //
 //===----------------------------------------------------------------------===//
 
 #include "IRBindings.h"
 #include "llvm/IR/Attributes.h"
 #include "llvm/IR/DebugLoc.h"
+#include "llvm/IR/DebugInfoMetadata.h"
 #include "llvm/IR/Function.h"
 #include "llvm/IR/IRBuilder.h"
 #include "llvm/IR/LLVMContext.h"
 #include "llvm/IR/Module.h"
 
 using namespace llvm;
 
 LLVMMetadataRef LLVMConstantAsMetadata(LLVMValueRef C) {

 void LLVMSetCurrentDebugLocation2(LLVMBuilderRef Bref, unsigned Line,
                                   unsigned Col, LLVMMetadataRef Scope,
                                   LLVMMetadataRef InlinedAt) {
   unwrap(Bref)->SetCurrentDebugLocation(
       DebugLoc::get(Line, Col, Scope ? unwrap<MDNode>(Scope) : nullptr,
                     InlinedAt ? unwrap<MDNode>(InlinedAt) : nullptr));
 }
 
+LLVMDebugLocMetadata LLVMGetCurrentDebugLocation2(LLVMBuilderRef Bref) {
+  const auto& Loc = unwrap(Bref)->getCurrentDebugLocation();
+  const auto* InlinedAt = Loc.getInlinedAt();
+  const LLVMDebugLocMetadata md{
+    Loc.getLine(),
+    Loc.getCol(),
+    wrap(Loc.getScope()),
+    InlinedAt == nullptr ? nullptr : wrap(InlinedAt->getRawInlinedAt()),
+  };
+  return md;
+}
+
 void LLVMSetSubprogram(LLVMValueRef Func, LLVMMetadataRef SP) {
   unwrap<Function>(Func)->setSubprogram(unwrap<DISubprogram>(SP));
 }

llvm/trunk/bindings/go/llvm/ir.go

 func (b Builder) InsertWithName(instr Value, name string) {
   cname := C.CString(name)
   defer C.free(unsafe.Pointer(cname))
   C.LLVMInsertIntoBuilderWithName(b.C, instr.C, cname)
 }
 func (b Builder) Dispose() { C.LLVMDisposeBuilder(b.C) }
 
 // Metadata
+type DebugLoc struct {
+  Line, Col      uint
+  Scope          Metadata
+  InlinedAt      Metadata
+}
 func (b Builder) SetCurrentDebugLocation(line, col uint, scope, inlinedAt Metadata) {
   C.LLVMSetCurrentDebugLocation2(b.C, C.unsigned(line), C.unsigned(col), scope.C, inlinedAt.C)
 }
+// Get current debug location. Please do not call this function until setting debug location with SetCurrentDebugLocation()
+func (b Builder) GetCurrentDebugLocation() (loc DebugLoc) {
+  md := C.LLVMGetCurrentDebugLocation2(b.C)
+  loc.Line = uint(md.Line)
+  loc.Col = uint(md.Col)
+  loc.Scope = Metadata{C: md.Scope}
+  loc.InlinedAt = Metadata{C: md.InlinedAt}
+  return
+}
 func (b Builder) SetInstDebugLocation(v Value) { C.LLVMSetInstDebugLocation(b.C, v.C) }
 func (b Builder) InsertDeclare(module Module, storage Value, md Value) Value {
   f := module.NamedFunction("llvm.dbg.declare")
   if f.IsNil() {
     ftyp := FunctionType(VoidType(), []Type{storage.Type(), md.Type()}, false)
     f = AddFunction(module, "llvm.dbg.declare", ftyp)
   }
   return b.CreateCall(f, []Value{storage, md}, "")

llvm/trunk/bindings/go/llvm/ir_test.go

attrTests := []string{
     "zeroext",
     "cold",
   }
 
   for _, name := range attrTests {
     testAttribute(t, name)
   }
 }
+
+func TestDebugLoc(t *testing.T) {
+  mod := NewModule("")
+  defer mod.Dispose()
+
+  ctx := mod.Context()
+
+  b := ctx.NewBuilder()
+  defer b.Dispose()
+
+  d := NewDIBuilder(mod)
+  defer func() {
+    d.Destroy()
+  }()
+  file := d.CreateFile("dummy_file", "dummy_dir")
+  voidInfo := d.CreateBasicType(DIBasicType{Name: "void"})
+  typeInfo := d.CreateSubroutineType(DISubroutineType{file, []Metadata{voidInfo}})
+  scope := d.CreateFunction(file, DIFunction{
+    Name:         "foo",
+    LinkageName:  "foo",
+    Line:         10,
+    ScopeLine:    10,
+    Type:         typeInfo,
+    File:         file,
+    IsDefinition: true,
+  })
+
+  b.SetCurrentDebugLocation(10, 20, scope, Metadata{})
+  loc := b.GetCurrentDebugLocation()
+  if loc.Line != 10 {
+    t.Errorf("Got line %d, though wanted 10", loc.Line)
+  }
+  if loc.Col != 20 {
+    t.Errorf("Got column %d, though wanted 20", loc.Col)
+  }
+  if loc.Scope.C != scope.C {
+    t.Errorf("Got metadata %v as scope, though wanted %v", loc.Scope.C, scope.C)
+  }
+}