1 //===-- IntelJITEventListener.cpp - Tell Intel profiler about JITed 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 to tell Intel(R) VTune(TM)
11 // Amplifier XE 2011 about JITted functions.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Config/config.h"
16 #include "llvm/ExecutionEngine/JITEventListener.h"
18 #include "llvm/IR/DebugInfo.h"
19 #include "llvm/IR/Function.h"
20 #include "llvm/IR/Metadata.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/CodeGen/MachineFunction.h"
23 #include "llvm/DebugInfo/DIContext.h"
24 #include "llvm/ExecutionEngine/ObjectImage.h"
25 #include "llvm/Object/ObjectFile.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/raw_ostream.h"
28 #include "llvm/Support/Errno.h"
29 #include "llvm/IR/ValueHandle.h"
30 #include "EventListenerCommon.h"
31 #include "IntelJITEventsWrapper.h"
34 using namespace llvm::jitprofiling;
36 #define DEBUG_TYPE "amplifier-jit-event-listener"
40 class IntelJITEventListener : public JITEventListener {
41 typedef DenseMap<void*, unsigned int> MethodIDMap;
43 std::unique_ptr<IntelJITEventsWrapper> Wrapper;
44 MethodIDMap MethodIDs;
45 FilenameCache Filenames;
47 typedef SmallVector<const void *, 64> MethodAddressVector;
48 typedef DenseMap<const void *, MethodAddressVector> ObjectMap;
50 ObjectMap LoadedObjectMap;
53 IntelJITEventListener(IntelJITEventsWrapper* libraryWrapper) {
54 Wrapper.reset(libraryWrapper);
57 ~IntelJITEventListener() {
60 virtual void NotifyFunctionEmitted(const Function &F,
61 void *FnStart, size_t FnSize,
62 const EmittedFunctionDetails &Details);
64 virtual void NotifyFreeingMachineCode(void *OldPtr);
66 virtual void NotifyObjectEmitted(const ObjectImage &Obj);
68 virtual void NotifyFreeingObject(const ObjectImage &Obj);
71 static LineNumberInfo LineStartToIntelJITFormat(
72 uintptr_t StartAddress,
75 LineNumberInfo Result;
77 Result.Offset = Address - StartAddress;
78 Result.LineNumber = Loc.getLine();
83 static LineNumberInfo DILineInfoToIntelJITFormat(uintptr_t StartAddress,
86 LineNumberInfo Result;
88 Result.Offset = Address - StartAddress;
89 Result.LineNumber = Line.Line;
94 static iJIT_Method_Load FunctionDescToIntelJITFormat(
95 IntelJITEventsWrapper& Wrapper,
99 iJIT_Method_Load Result;
100 memset(&Result, 0, sizeof(iJIT_Method_Load));
102 Result.method_id = Wrapper.iJIT_GetNewMethodID();
103 Result.method_name = const_cast<char*>(FnName);
104 Result.method_load_address = reinterpret_cast<void*>(FnStart);
105 Result.method_size = FnSize;
108 Result.class_file_name = NULL;
109 Result.user_data = NULL;
110 Result.user_data_size = 0;
111 Result.env = iJDE_JittingAPI;
116 // Adds the just-emitted function to the symbol table.
117 void IntelJITEventListener::NotifyFunctionEmitted(
118 const Function &F, void *FnStart, size_t FnSize,
119 const EmittedFunctionDetails &Details) {
120 iJIT_Method_Load FunctionMessage = FunctionDescToIntelJITFormat(*Wrapper,
122 reinterpret_cast<uint64_t>(FnStart),
125 std::vector<LineNumberInfo> LineInfo;
127 if (!Details.LineStarts.empty()) {
128 // Now convert the line number information from the address/DebugLoc
129 // format in Details to the offset/lineno in Intel JIT API format.
131 LineInfo.reserve(Details.LineStarts.size() + 1);
133 DebugLoc FirstLoc = Details.LineStarts[0].Loc;
134 assert(!FirstLoc.isUnknown()
135 && "LineStarts should not contain unknown DebugLocs");
137 MDNode *FirstLocScope = FirstLoc.getScope(F.getContext());
138 DISubprogram FunctionDI = getDISubprogram(FirstLocScope);
139 if (FunctionDI.Verify()) {
140 FunctionMessage.source_file_name = const_cast<char*>(
141 Filenames.getFullPath(FirstLocScope));
143 LineNumberInfo FirstLine;
144 FirstLine.Offset = 0;
145 FirstLine.LineNumber = FunctionDI.getLineNumber();
146 LineInfo.push_back(FirstLine);
149 for (std::vector<EmittedFunctionDetails::LineStart>::const_iterator I =
150 Details.LineStarts.begin(), E = Details.LineStarts.end();
152 // This implementation ignores the DebugLoc filename because the Intel
153 // JIT API does not support multiple source files associated with a single
155 LineInfo.push_back(LineStartToIntelJITFormat(
156 reinterpret_cast<uintptr_t>(FnStart),
160 // If we have no file name yet for the function, use the filename from
161 // the first instruction that has one
162 if (FunctionMessage.source_file_name == 0) {
163 MDNode *scope = I->Loc.getScope(
164 Details.MF->getFunction()->getContext());
165 FunctionMessage.source_file_name = const_cast<char*>(
166 Filenames.getFullPath(scope));
170 FunctionMessage.line_number_size = LineInfo.size();
171 FunctionMessage.line_number_table = &*LineInfo.begin();
173 FunctionMessage.line_number_size = 0;
174 FunctionMessage.line_number_table = 0;
177 Wrapper->iJIT_NotifyEvent(iJVM_EVENT_TYPE_METHOD_LOAD_FINISHED,
179 MethodIDs[FnStart] = FunctionMessage.method_id;
182 void IntelJITEventListener::NotifyFreeingMachineCode(void *FnStart) {
183 MethodIDMap::iterator I = MethodIDs.find(FnStart);
184 if (I != MethodIDs.end()) {
185 Wrapper->iJIT_NotifyEvent(iJVM_EVENT_TYPE_METHOD_UNLOAD_START, &I->second);
190 void IntelJITEventListener::NotifyObjectEmitted(const ObjectImage &Obj) {
191 // Get the address of the object image for use as a unique identifier
192 const void* ObjData = Obj.getData().data();
193 DIContext* Context = DIContext::getDWARFContext(Obj.getObjectFile());
194 MethodAddressVector Functions;
196 // Use symbol info to iterate functions in the object.
197 for (object::symbol_iterator I = Obj.begin_symbols(),
198 E = Obj.end_symbols();
201 std::vector<LineNumberInfo> LineInfo;
202 std::string SourceFileName;
204 object::SymbolRef::Type SymType;
205 if (I->getType(SymType)) continue;
206 if (SymType == object::SymbolRef::ST_Function) {
210 if (I->getName(Name)) continue;
211 if (I->getAddress(Addr)) continue;
212 if (I->getSize(Size)) continue;
214 // Record this address in a local vector
215 Functions.push_back((void*)Addr);
217 // Build the function loaded notification message
218 iJIT_Method_Load FunctionMessage = FunctionDescToIntelJITFormat(*Wrapper,
223 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
224 DILineInfoTable::iterator Begin = Lines.begin();
225 DILineInfoTable::iterator End = Lines.end();
226 for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
227 LineInfo.push_back(DILineInfoToIntelJITFormat((uintptr_t)Addr,
231 if (LineInfo.size() == 0) {
232 FunctionMessage.source_file_name = 0;
233 FunctionMessage.line_number_size = 0;
234 FunctionMessage.line_number_table = 0;
236 SourceFileName = Lines.front().second.FileName;
237 FunctionMessage.source_file_name = const_cast<char *>(SourceFileName.c_str());
238 FunctionMessage.line_number_size = LineInfo.size();
239 FunctionMessage.line_number_table = &*LineInfo.begin();
242 FunctionMessage.source_file_name = 0;
243 FunctionMessage.line_number_size = 0;
244 FunctionMessage.line_number_table = 0;
247 Wrapper->iJIT_NotifyEvent(iJVM_EVENT_TYPE_METHOD_LOAD_FINISHED,
249 MethodIDs[(void*)Addr] = FunctionMessage.method_id;
253 // To support object unload notification, we need to keep a list of
254 // registered function addresses for each loaded object. We will
255 // use the MethodIDs map to get the registered ID for each function.
256 LoadedObjectMap[ObjData] = Functions;
259 void IntelJITEventListener::NotifyFreeingObject(const ObjectImage &Obj) {
260 // Get the address of the object image for use as a unique identifier
261 const void* ObjData = Obj.getData().data();
263 // Get the object's function list from LoadedObjectMap
264 ObjectMap::iterator OI = LoadedObjectMap.find(ObjData);
265 if (OI == LoadedObjectMap.end())
267 MethodAddressVector& Functions = OI->second;
269 // Walk the function list, unregistering each function
270 for (MethodAddressVector::iterator FI = Functions.begin(),
271 FE = Functions.end();
274 void* FnStart = const_cast<void*>(*FI);
275 MethodIDMap::iterator MI = MethodIDs.find(FnStart);
276 if (MI != MethodIDs.end()) {
277 Wrapper->iJIT_NotifyEvent(iJVM_EVENT_TYPE_METHOD_UNLOAD_START,
283 // Erase the object from LoadedObjectMap
284 LoadedObjectMap.erase(OI);
287 } // anonymous namespace.
290 JITEventListener *JITEventListener::createIntelJITEventListener() {
291 return new IntelJITEventListener(new IntelJITEventsWrapper);
295 JITEventListener *JITEventListener::createIntelJITEventListener(
296 IntelJITEventsWrapper* TestImpl) {
297 return new IntelJITEventListener(TestImpl);