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 calls into OProfile to tell
11 // it about JITted functions. For now, we only record function names and sizes,
12 // but eventually we'll also record line number information.
14 // See http://oprofile.sourceforge.net/doc/devel/jit-interface.html for the
15 // definition of the interface we're using.
17 //===----------------------------------------------------------------------===//
19 #define DEBUG_TYPE "oprofile-jit-event-listener"
20 #include "llvm/Function.h"
21 #include "llvm/Analysis/DebugInfo.h"
22 #include "llvm/CodeGen/MachineFunction.h"
23 #include "llvm/ExecutionEngine/JITEventListener.h"
24 #include "llvm/Support/Debug.h"
25 #include "llvm/Support/raw_ostream.h"
26 #include "llvm/System/Errno.h"
27 #include "llvm/Config/config.h"
37 class OProfileJITEventListener : public JITEventListener {
40 OProfileJITEventListener();
41 ~OProfileJITEventListener();
43 virtual void NotifyFunctionEmitted(const Function &F,
44 void *FnStart, size_t FnSize,
45 const EmittedFunctionDetails &Details);
46 virtual void NotifyFreeingMachineCode(void *OldPtr);
49 OProfileJITEventListener::OProfileJITEventListener()
50 : Agent(op_open_agent()) {
52 const std::string err_str = sys::StrError();
53 DEBUG(dbgs() << "Failed to connect to OProfile agent: " << err_str << "\n");
55 DEBUG(dbgs() << "Connected to OProfile agent.\n");
59 OProfileJITEventListener::~OProfileJITEventListener() {
61 if (op_close_agent(Agent) == -1) {
62 const std::string err_str = sys::StrError();
63 DEBUG(dbgs() << "Failed to disconnect from OProfile agent: "
66 DEBUG(dbgs() << "Disconnected from OProfile agent.\n");
72 // Holds the filename of each Scope, so that we can pass a null-terminated
73 // string into oprofile.
74 DenseMap<MDNode*, std::string> Filenames;
77 const char *getFilename(MDNode *Scope) {
78 std::string &Filename = Filenames[Scope];
79 if (Filename.empty()) {
81 Filename = S.getFilename();
83 return Filename.c_str();
87 static debug_line_info LineStartToOProfileFormat(
88 const MachineFunction &MF, FilenameCache &Filenames,
89 uintptr_t Address, DebugLoc Loc) {
90 debug_line_info Result;
92 const DebugLocTuple &tuple = MF.getDebugLocTuple(Loc);
93 Result.lineno = tuple.Line;
94 Result.filename = Filenames.getFilename(tuple.Scope);
95 DEBUG(dbgs() << "Mapping " << reinterpret_cast<void*>(Result.vma) << " to "
96 << Result.filename << ":" << Result.lineno << "\n");
100 // Adds the just-emitted function to the symbol table.
101 void OProfileJITEventListener::NotifyFunctionEmitted(
102 const Function &F, void *FnStart, size_t FnSize,
103 const EmittedFunctionDetails &Details) {
104 assert(F.hasName() && FnStart != 0 && "Bad symbol to add");
105 if (op_write_native_code(Agent, F.getName().data(),
106 reinterpret_cast<uint64_t>(FnStart),
107 FnStart, FnSize) == -1) {
108 DEBUG(dbgs() << "Failed to tell OProfile about native function "
109 << F.getName() << " at ["
110 << FnStart << "-" << ((char*)FnStart + FnSize) << "]\n");
114 // Now we convert the line number information from the address/DebugLoc format
115 // in Details to the address/filename/lineno format that OProfile expects.
116 // OProfile 0.9.4 (and maybe later versions) has a bug that causes it to
117 // ignore line numbers for addresses above 4G.
118 FilenameCache Filenames;
119 std::vector<debug_line_info> LineInfo;
120 LineInfo.reserve(1 + Details.LineStarts.size());
121 if (!Details.MF->getDefaultDebugLoc().isUnknown()) {
122 LineInfo.push_back(LineStartToOProfileFormat(
123 *Details.MF, Filenames,
124 reinterpret_cast<uintptr_t>(FnStart),
125 Details.MF->getDefaultDebugLoc()));
127 for (std::vector<EmittedFunctionDetails::LineStart>::const_iterator
128 I = Details.LineStarts.begin(), E = Details.LineStarts.end();
130 LineInfo.push_back(LineStartToOProfileFormat(
131 *Details.MF, Filenames, I->Address, I->Loc));
133 if (!LineInfo.empty()) {
134 if (op_write_debug_line_info(Agent, FnStart,
135 LineInfo.size(), &*LineInfo.begin()) == -1) {
137 << "Failed to tell OProfile about line numbers for native function "
138 << F.getName() << " at ["
139 << FnStart << "-" << ((char*)FnStart + FnSize) << "]\n");
144 // Removes the being-deleted function from the symbol table.
145 void OProfileJITEventListener::NotifyFreeingMachineCode(void *FnStart) {
146 assert(FnStart && "Invalid function pointer");
147 if (op_unload_native_code(Agent, reinterpret_cast<uint64_t>(FnStart)) == -1) {
149 << "Failed to tell OProfile about unload of native function at "
154 } // anonymous namespace.
157 JITEventListener *createOProfileJITEventListener() {
158 return new OProfileJITEventListener;
162 #else // USE_OPROFILE
165 // By defining this to return NULL, we can let clients call it unconditionally,
166 // even if they haven't configured with the OProfile libraries.
167 JITEventListener *createOProfileJITEventListener() {
172 #endif // USE_OPROFILE