1 //===-- OProfileJITEventListener.cpp - Tell OProfile about JITted code ----===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines a JITEventListener object that uses OProfileWrapper to tell
11 // oprofile about JITted functions, including source line information.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "llvm/Config/config.h"
16 #include "EventListenerCommon.h"
17 #include "llvm/CodeGen/MachineFunction.h"
18 #include "llvm/ExecutionEngine/JITEventListener.h"
19 #include "llvm/ExecutionEngine/OProfileWrapper.h"
20 #include "llvm/ExecutionEngine/RuntimeDyld.h"
21 #include "llvm/IR/DebugInfo.h"
22 #include "llvm/IR/Function.h"
23 #include "llvm/Object/ObjectFile.h"
24 #include "llvm/Support/Debug.h"
25 #include "llvm/Support/Errno.h"
26 #include "llvm/Support/raw_ostream.h"
27 #include <dirent.h>
28 #include <fcntl.h>
29
30 using namespace llvm;
31 using namespace llvm::jitprofiling;
32 using namespace llvm::object;
33
34 #define DEBUG_TYPE "oprofile-jit-event-listener"
35
36 namespace {
37
38 class OProfileJITEventListener : public JITEventListener {
39 std::unique_ptr<OProfileWrapper> Wrapper;
40
41 void initialize();
42 std::map<const char*, OwningBinary<ObjectFile>> DebugObjects;
43
44 public:
OProfileJITEventListener(std::unique_ptr<OProfileWrapper> LibraryWrapper)45 OProfileJITEventListener(std::unique_ptr<OProfileWrapper> LibraryWrapper)
46 : Wrapper(std::move(LibraryWrapper)) {
47 initialize();
48 }
49
50 ~OProfileJITEventListener();
51
52 void NotifyObjectEmitted(const ObjectFile &Obj,
53 const RuntimeDyld::LoadedObjectInfo &L) override;
54
55 void NotifyFreeingObject(const ObjectFile &Obj) override;
56 };
57
initialize()58 void OProfileJITEventListener::initialize() {
59 if (!Wrapper->op_open_agent()) {
60 const std::string err_str = sys::StrError();
61 DEBUG(dbgs() << "Failed to connect to OProfile agent: " << err_str << "\n");
62 } else {
63 DEBUG(dbgs() << "Connected to OProfile agent.\n");
64 }
65 }
66
~OProfileJITEventListener()67 OProfileJITEventListener::~OProfileJITEventListener() {
68 if (Wrapper->isAgentAvailable()) {
69 if (Wrapper->op_close_agent() == -1) {
70 const std::string err_str = sys::StrError();
71 DEBUG(dbgs() << "Failed to disconnect from OProfile agent: "
72 << err_str << "\n");
73 } else {
74 DEBUG(dbgs() << "Disconnected from OProfile agent.\n");
75 }
76 }
77 }
78
NotifyObjectEmitted(const ObjectFile & Obj,const RuntimeDyld::LoadedObjectInfo & L)79 void OProfileJITEventListener::NotifyObjectEmitted(
80 const ObjectFile &Obj,
81 const RuntimeDyld::LoadedObjectInfo &L) {
82 if (!Wrapper->isAgentAvailable()) {
83 return;
84 }
85
86 OwningBinary<ObjectFile> DebugObjOwner = L.getObjectForDebug(Obj);
87 const ObjectFile &DebugObj = *DebugObjOwner.getBinary();
88
89 // Use symbol info to iterate functions in the object.
90 for (symbol_iterator I = DebugObj.symbol_begin(), E = DebugObj.symbol_end();
91 I != E; ++I) {
92 SymbolRef::Type SymType;
93 if (I->getType(SymType)) continue;
94 if (SymType == SymbolRef::ST_Function) {
95 StringRef Name;
96 uint64_t Addr;
97 uint64_t Size;
98 if (I->getName(Name)) continue;
99 if (I->getAddress(Addr)) continue;
100 if (I->getSize(Size)) continue;
101
102 if (Wrapper->op_write_native_code(Name.data(), Addr, (void*)Addr, Size)
103 == -1) {
104 DEBUG(dbgs() << "Failed to tell OProfile about native function "
105 << Name << " at ["
106 << (void*)Addr << "-" << ((char*)Addr + Size) << "]\n");
107 continue;
108 }
109 // TODO: support line number info (similar to IntelJITEventListener.cpp)
110 }
111 }
112
113 DebugObjects[Obj.getData().data()] = std::move(DebugObjOwner);
114 }
115
NotifyFreeingObject(const ObjectFile & Obj)116 void OProfileJITEventListener::NotifyFreeingObject(const ObjectFile &Obj) {
117 if (Wrapper->isAgentAvailable()) {
118
119 // If there was no agent registered when the original object was loaded then
120 // we won't have created a debug object for it, so bail out.
121 if (DebugObjects.find(Obj.getData().data()) == DebugObjects.end())
122 return;
123
124 const ObjectFile &DebugObj = *DebugObjects[Obj.getData().data()].getBinary();
125
126 // Use symbol info to iterate functions in the object.
127 for (symbol_iterator I = DebugObj.symbol_begin(),
128 E = DebugObj.symbol_end();
129 I != E; ++I) {
130 SymbolRef::Type SymType;
131 if (I->getType(SymType)) continue;
132 if (SymType == SymbolRef::ST_Function) {
133 uint64_t Addr;
134 if (I->getAddress(Addr)) continue;
135
136 if (Wrapper->op_unload_native_code(Addr) == -1) {
137 DEBUG(dbgs()
138 << "Failed to tell OProfile about unload of native function at "
139 << (void*)Addr << "\n");
140 continue;
141 }
142 }
143 }
144 }
145
146 DebugObjects.erase(Obj.getData().data());
147 }
148
149 } // anonymous namespace.
150
151 namespace llvm {
createOProfileJITEventListener()152 JITEventListener *JITEventListener::createOProfileJITEventListener() {
153 return new OProfileJITEventListener(llvm::make_unique<OProfileWrapper>());
154 }
155
156 } // namespace llvm
157
158