1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
| //===-- OProfileJITEventListener.cpp - Tell OProfile about JITted code ----===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// 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"
#include "llvm/Support/Errno.h"
#include "llvm/Support/raw_ostream.h"
#include <dirent.h>
#include <fcntl.h>
using namespace llvm;
using namespace llvm::object;
#define DEBUG_TYPE "oprofile-jit-event-listener"
namespace {
class OProfileJITEventListener : public JITEventListener {
std::unique_ptr<OProfileWrapper> Wrapper;
void initialize();
std::map<ObjectKey, OwningBinary<ObjectFile>> DebugObjects;
public:
OProfileJITEventListener(std::unique_ptr<OProfileWrapper> LibraryWrapper)
: Wrapper(std::move(LibraryWrapper)) {
initialize();
}
~OProfileJITEventListener();
void notifyObjectLoaded(ObjectKey Key, const ObjectFile &Obj,
const RuntimeDyld::LoadedObjectInfo &L) override;
void notifyFreeingObject(ObjectKey Key) override;
};
void OProfileJITEventListener::initialize() {
if (!Wrapper->op_open_agent()) {
const std::string err_str = sys::StrError();
LLVM_DEBUG(dbgs() << "Failed to connect to OProfile agent: " << err_str
<< "\n");
} else {
LLVM_DEBUG(dbgs() << "Connected to OProfile agent.\n");
}
}
OProfileJITEventListener::~OProfileJITEventListener() {
if (Wrapper->isAgentAvailable()) {
if (Wrapper->op_close_agent() == -1) {
const std::string err_str = sys::StrError();
LLVM_DEBUG(dbgs() << "Failed to disconnect from OProfile agent: "
<< err_str << "\n");
} else {
LLVM_DEBUG(dbgs() << "Disconnected from OProfile agent.\n");
}
}
}
void OProfileJITEventListener::notifyObjectLoaded(
ObjectKey Key, 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;
}
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[Key] = std::move(DebugObjOwner);
}
void OProfileJITEventListener::notifyFreeingObject(ObjectKey Key) {
if (Wrapper->isAgentAvailable()) {
// If there was no agent registered when the original object was loaded then
// we won't have created a debug object for it, so bail out.
if (DebugObjects.find(Key) == DebugObjects.end())
return;
const ObjectFile &DebugObj = *DebugObjects[Key].getBinary();
// Use symbol info to iterate functions in the object.
for (symbol_iterator I = DebugObj.symbol_begin(),
E = DebugObj.symbol_end();
I != E; ++I) {
if (I->getType() && *I->getType() == SymbolRef::ST_Function) {
Expected<uint64_t> AddrOrErr = I->getAddress();
if (!AddrOrErr)
continue;
uint64_t Addr = *AddrOrErr;
if (Wrapper->op_unload_native_code(Addr) == -1) {
LLVM_DEBUG(
dbgs()
<< "Failed to tell OProfile about unload of native function at "
<< (void *)Addr << "\n");
continue;
}
}
}
}
DebugObjects.erase(Key);
}
} // anonymous namespace.
namespace llvm {
JITEventListener *JITEventListener::createOProfileJITEventListener() {
return new OProfileJITEventListener(std::make_unique<OProfileWrapper>());
}
} // namespace llvm
LLVMJITEventListenerRef LLVMCreateOProfileJITEventListener(void)
{
return wrap(JITEventListener::createOProfileJITEventListener());
}
|