1 //===-- OProfileJITEventListener.cpp - Tell OProfile about JITted code ----===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines a JITEventListener object that uses OProfileWrapper to tell
11 // oprofile about JITted functions, including source line information.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/CodeGen/MachineFunction.h"
16 #include "llvm/Config/config.h"
17 #include "llvm/ExecutionEngine/JITEventListener.h"
18 #include "llvm/ExecutionEngine/OProfileWrapper.h"
19 #include "llvm/ExecutionEngine/RuntimeDyld.h"
20 #include "llvm/IR/DebugInfo.h"
21 #include "llvm/IR/Function.h"
22 #include "llvm/Object/ObjectFile.h"
23 #include "llvm/Object/SymbolSize.h"
24 #include "llvm/Support/Debug.h"
25 #include "llvm/Support/Errno.h"
26 #include "llvm/Support/raw_ostream.h"
31 using namespace llvm::object;
33 #define DEBUG_TYPE "oprofile-jit-event-listener"
37 class OProfileJITEventListener : public JITEventListener {
38 std::unique_ptr<OProfileWrapper> Wrapper;
41 std::map<const char*, OwningBinary<ObjectFile>> DebugObjects;
44 OProfileJITEventListener(std::unique_ptr<OProfileWrapper> LibraryWrapper)
45 : Wrapper(std::move(LibraryWrapper)) {
49 ~OProfileJITEventListener();
51 void NotifyObjectEmitted(const ObjectFile &Obj,
52 const RuntimeDyld::LoadedObjectInfo &L) override;
54 void NotifyFreeingObject(const ObjectFile &Obj) override;
57 void OProfileJITEventListener::initialize() {
58 if (!Wrapper->op_open_agent()) {
59 const std::string err_str = sys::StrError();
60 DEBUG(dbgs() << "Failed to connect to OProfile agent: " << err_str << "\n");
62 DEBUG(dbgs() << "Connected to OProfile agent.\n");
66 OProfileJITEventListener::~OProfileJITEventListener() {
67 if (Wrapper->isAgentAvailable()) {
68 if (Wrapper->op_close_agent() == -1) {
69 const std::string err_str = sys::StrError();
70 DEBUG(dbgs() << "Failed to disconnect from OProfile agent: "
73 DEBUG(dbgs() << "Disconnected from OProfile agent.\n");
78 void OProfileJITEventListener::NotifyObjectEmitted(
79 const ObjectFile &Obj,
80 const RuntimeDyld::LoadedObjectInfo &L) {
81 if (!Wrapper->isAgentAvailable()) {
85 OwningBinary<ObjectFile> DebugObjOwner = L.getObjectForDebug(Obj);
86 const ObjectFile &DebugObj = *DebugObjOwner.getBinary();
88 // Use symbol info to iterate functions in the object.
89 for (const std::pair<SymbolRef, uint64_t> &P : computeSymbolSizes(DebugObj)) {
90 SymbolRef Sym = P.first;
91 if (!Sym.getType() || *Sym.getType() != SymbolRef::ST_Function)
94 Expected<StringRef> NameOrErr = Sym.getName();
97 StringRef Name = *NameOrErr;
98 Expected<uint64_t> AddrOrErr = Sym.getAddress();
101 uint64_t Addr = *AddrOrErr;
102 uint64_t Size = P.second;
104 if (Wrapper->op_write_native_code(Name.data(), Addr, (void *)Addr, Size) ==
106 DEBUG(dbgs() << "Failed to tell OProfile about native function " << Name
107 << " at [" << (void *)Addr << "-" << ((char *)Addr + Size)
111 // TODO: support line number info (similar to IntelJITEventListener.cpp)
114 DebugObjects[Obj.getData().data()] = std::move(DebugObjOwner);
117 void OProfileJITEventListener::NotifyFreeingObject(const ObjectFile &Obj) {
118 if (Wrapper->isAgentAvailable()) {
120 // If there was no agent registered when the original object was loaded then
121 // we won't have created a debug object for it, so bail out.
122 if (DebugObjects.find(Obj.getData().data()) == DebugObjects.end())
125 const ObjectFile &DebugObj = *DebugObjects[Obj.getData().data()].getBinary();
127 // Use symbol info to iterate functions in the object.
128 for (symbol_iterator I = DebugObj.symbol_begin(),
129 E = DebugObj.symbol_end();
131 if (I->getType() && *I->getType() == SymbolRef::ST_Function) {
132 Expected<uint64_t> AddrOrErr = I->getAddress();
135 uint64_t Addr = *AddrOrErr;
137 if (Wrapper->op_unload_native_code(Addr) == -1) {
139 << "Failed to tell OProfile about unload of native function at "
140 << (void*)Addr << "\n");
147 DebugObjects.erase(Obj.getData().data());
150 } // anonymous namespace.
153 JITEventListener *JITEventListener::createOProfileJITEventListener() {
154 return new OProfileJITEventListener(llvm::make_unique<OProfileWrapper>());