Add debug info for OProfile porifling support

[gipri]

Summary

The LLVM implementation of the OProfile interface is almost complete, except for the support of line level code annotations.
This is an attempt to fill this gap, as the Oprofile wrapper is already capable of registering debug events.

For example in Julia we can now target user-level functions.
As an example we set

>sudo operf -Vdebug ./julia pidigits.jl
>opreport -l `which ./julia`
...
1         0.0095  sys-debug.so             japi1_widen_all_consts!_995
1         0.0095  sys-debug.so             jlcall_pidigits_2258
1         0.0095  sys-debug.so             jlcall_lower_sum_2188
1         0.0095  sys-debug.so             jlcall_upper_sum_2923
1         0.0095  sys-debug.so             jlcall_<=_417
1         0.0095  sys-debug.so             jlcall_==_219
1         0.0095  sys-debug.so             jlcall_==_2322
1         0.0095  sys-debug.so             jlcall_done_216
1         0.0095  sys-debug.so             jlcall_fill_2011
1         0.0095  sys-debug.so             jlcall_in_2246
1         0.0095  sys-debug.so             jlcall_isbits_2230
1         0.0095  sys-debug.so             jlcall_next_217
1         0.0095  sys-debug.so             jlcall_record_ssa_assign_926
1         0.0095  sys-debug.so             jlcall_setindex!_533
1         0.0095  sys-debug.so             julia_+_431
1         0.0095  sys-debug.so             julia_-_646
1         0.0095  sys-debug.so             julia_<=_418
1         0.0095  sys-debug.so             julia_==_2225

[aprantl]

lib/ExecutionEngine/OProfileJIT/OProfileJITEventListener.cpp

132 ↗

(On Diff #150439)

please clang-format your patch.

[gipri]

Clang-format

[aprantl]

lib/ExecutionEngine/OProfileJIT/OProfileJITEventListener.cpp

132 ↗

(On Diff #150439)

sorry for being obnoxious :-) but this still doesn't look clang-formatted...

[gipri]

Yeah sorry, I am new to SVN and in particular LLVM standards.
The output diff is obtained by revisioning on a git branch, so it seems that is not redirecting correctly.
The diff can still be applied with patch to trunk, but I don't know if it is still a problem.

[aprantl]

lib/ExecutionEngine/OProfileJIT/OProfileJITEventListener.cpp

132 ↗

(On Diff #150439)

http://clang.llvm.org/docs/ClangFormat.html#script-for-patch-reformatting

[andrew.w.kaylor]

Thanks for the patch!

I assume you've tested this and it works? It looks correct, but I'm not in a position to set up an OProfile environment to verify it and I don't know the OProfile interface well enough to know without testing.

lib/ExecutionEngine/OProfileJIT/OProfileJITEventListener.cpp

120 ↗

(On Diff #150552)

DILineInfoTable is an alias of llvm::SmallVector, so you can use Lines.size() here.

121 ↗

(On Diff #150552)

Why is this static?

124 ↗

(On Diff #150552)

Also because DILineInfoTable is a SmallVector, you can use a range-based iterator here:

for (auto InfoPair : Lines) {
  <fill in debug_line[i]>
  ++i;
}

The IntelJITEventListener is old code and I don't think we had range-based iterators when it was last updated.

128 ↗

(On Diff #150552)

I'm not sure this copy is going to do anything useful. It's copying the file name into a string that will be destructed at the end of the out loop iteration. I realize this part of the code is copied directly from the IntelJITEventListener, but it's wrong there too. Maybe we get away with it there because the Intel debug info registration function doesn't need the string pointer to outlive the function call. Maybe that's true with OProfile too. In any event, I can't see a reason to copy the string here.

[gipri]

Ok now the files are redirected correctly.

You can easily test this if you have a Linux Arch as Oprofile is mainted by the community!

Yeah effectively it does not need to be static.
The reason why I did in the first place is that the Oprofile Wrapper is not calling the op_write_debug_line_info function directly but dinamically binds it to a pointer function.
By being abit scared from that, I made it static so that it could have the same lifetime of the program, whenever so the binded function was called the memory section would outlive it.
But yeah now I tested it and it is not necessary.
Regarding the formatting I am sorry but I did not knew this praxis, hope that now it fits the standards!

[andrew.w.kaylor]

lgtm

[gipri]

Great! Sorry but I do not have merge access, can you land this for me? Thanks!

[andrew.w.kaylor]

In D47925#1131851, @gipri wrote:

Great! Sorry but I do not have merge access, can you land this for me? Thanks!

I'm having some trouble getting the build to work with OProfile support turned on. It doesn't seem to be related to these changes. I'll commit the patch as soon as I figure it out.

llvm/trunk/lib/ExecutionEngine/OProfileJIT/LLVMBuild.txt

 ;===------------------------------------------------------------------------===;
 
 [common]
 
 [component_0]
 type = OptionalLibrary
 name = OProfileJIT
 parent = ExecutionEngine
-required_libraries = Support Object ExecutionEngine
+required_libraries = DebugInfoDWARF Support Object ExecutionEngine

llvm/trunk/lib/ExecutionEngine/OProfileJIT/OProfileJITEventListener.cpp

 // This file defines a JITEventListener object that uses OProfileWrapper to tell
 // oprofile about JITted functions, including source line information.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm-c/ExecutionEngine.h"
 #include "llvm/CodeGen/MachineFunction.h"
 #include "llvm/Config/config.h"
+#include "llvm/DebugInfo/DWARF/DWARFContext.h"
 #include "llvm/ExecutionEngine/JITEventListener.h"
 #include "llvm/ExecutionEngine/OProfileWrapper.h"
 #include "llvm/ExecutionEngine/RuntimeDyld.h"
 #include "llvm/IR/DebugInfo.h"
 #include "llvm/IR/Function.h"
 #include "llvm/Object/ObjectFile.h"
 #include "llvm/Object/SymbolSize.h"
 #include "llvm/Support/Debug.h"
void OProfileJITEventListener::NotifyObjectEmitted(
                                        const ObjectFile &Obj,
                                        const RuntimeDyld::LoadedObjectInfo &L) {
   if (!Wrapper->isAgentAvailable()) {
     return;
   }
 
   OwningBinary<ObjectFile> DebugObjOwner = L.getObjectForDebug(Obj);
   const ObjectFile &DebugObj = *DebugObjOwner.getBinary();
+  std::unique_ptr<DIContext> Context = DWARFContext::create(DebugObj);
 
   // Use symbol info to iterate functions in the object.
   for (const std::pair<SymbolRef, uint64_t> &P : computeSymbolSizes(DebugObj)) {
     SymbolRef Sym = P.first;
     if (!Sym.getType() || *Sym.getType() != SymbolRef::ST_Function)
       continue;
 
     Expected<StringRef> NameOrErr = Sym.getName();
     if (!NameOrErr)
       continue;
     StringRef Name = *NameOrErr;
     Expected<uint64_t> AddrOrErr = Sym.getAddress();
     if (!AddrOrErr)
       continue;
     uint64_t Addr = *AddrOrErr;
     uint64_t Size = P.second;
 
     if (Wrapper->op_write_native_code(Name.data(), Addr, (void *)Addr, Size) ==
         -1) {
       LLVM_DEBUG(dbgs() << "Failed to tell OProfile about native function "
                         << Name << " at [" << (void *)Addr << "-"
                         << ((char *)Addr + Size) << "]\n");
       continue;
     }
-    // TODO: support line number info (similar to IntelJITEventListener.cpp)
+
+    DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
+    size_t i = 0;
+    size_t num_entries = Lines.size();
+    struct debug_line_info *debug_line;
+    debug_line = (struct debug_line_info *)calloc(
+        num_entries, sizeof(struct debug_line_info));
+
+    for (auto& It : Lines) {
+      debug_line[i].vma = (unsigned long)It.first;
+      debug_line[i].lineno = It.second.Line;
+      debug_line[i].filename =
+          const_cast<char *>(Lines.front().second.FileName.c_str());
+      ++i;
+    }
+
+    if (Wrapper->op_write_debug_line_info((void *)Addr, num_entries,
+                                          debug_line) == -1) {
+      LLVM_DEBUG(dbgs() << "Failed to tell OProfiler about debug object at ["
+                        << (void *)Addr << "-" << ((char *)Addr + Size)
+                        << "]\n");
+      continue;
+    }
   }
 
   DebugObjects[Obj.getData().data()] = std::move(DebugObjOwner);
 }
 
 void OProfileJITEventListener::NotifyFreeingObject(const ObjectFile &Obj) {
   if (Wrapper->isAgentAvailable()) {