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 NotifyFreeingMachineCode(void *OldPtr);
62 virtual void NotifyObjectEmitted(const ObjectImage &Obj);
64 virtual void NotifyFreeingObject(const ObjectImage &Obj);
67 static LineNumberInfo DILineInfoToIntelJITFormat(uintptr_t StartAddress,
70 LineNumberInfo Result;
72 Result.Offset = Address - StartAddress;
73 Result.LineNumber = Line.Line;
78 static iJIT_Method_Load FunctionDescToIntelJITFormat(
79 IntelJITEventsWrapper& Wrapper,
83 iJIT_Method_Load Result;
84 memset(&Result, 0, sizeof(iJIT_Method_Load));
86 Result.method_id = Wrapper.iJIT_GetNewMethodID();
87 Result.method_name = const_cast<char*>(FnName);
88 Result.method_load_address = reinterpret_cast<void*>(FnStart);
89 Result.method_size = FnSize;
92 Result.class_file_name = NULL;
93 Result.user_data = NULL;
94 Result.user_data_size = 0;
95 Result.env = iJDE_JittingAPI;
100 void IntelJITEventListener::NotifyFreeingMachineCode(void *FnStart) {
101 MethodIDMap::iterator I = MethodIDs.find(FnStart);
102 if (I != MethodIDs.end()) {
103 Wrapper->iJIT_NotifyEvent(iJVM_EVENT_TYPE_METHOD_UNLOAD_START, &I->second);
108 void IntelJITEventListener::NotifyObjectEmitted(const ObjectImage &Obj) {
109 // Get the address of the object image for use as a unique identifier
110 const void* ObjData = Obj.getData().data();
111 DIContext* Context = DIContext::getDWARFContext(*Obj.getObjectFile());
112 MethodAddressVector Functions;
114 // Use symbol info to iterate functions in the object.
115 for (object::symbol_iterator I = Obj.begin_symbols(),
116 E = Obj.end_symbols();
119 std::vector<LineNumberInfo> LineInfo;
120 std::string SourceFileName;
122 object::SymbolRef::Type SymType;
123 if (I->getType(SymType)) continue;
124 if (SymType == object::SymbolRef::ST_Function) {
128 if (I->getName(Name)) continue;
129 if (I->getAddress(Addr)) continue;
130 if (I->getSize(Size)) continue;
132 // Record this address in a local vector
133 Functions.push_back((void*)Addr);
135 // Build the function loaded notification message
136 iJIT_Method_Load FunctionMessage = FunctionDescToIntelJITFormat(*Wrapper,
141 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
142 DILineInfoTable::iterator Begin = Lines.begin();
143 DILineInfoTable::iterator End = Lines.end();
144 for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
145 LineInfo.push_back(DILineInfoToIntelJITFormat((uintptr_t)Addr,
149 if (LineInfo.size() == 0) {
150 FunctionMessage.source_file_name = 0;
151 FunctionMessage.line_number_size = 0;
152 FunctionMessage.line_number_table = 0;
154 SourceFileName = Lines.front().second.FileName;
155 FunctionMessage.source_file_name = const_cast<char *>(SourceFileName.c_str());
156 FunctionMessage.line_number_size = LineInfo.size();
157 FunctionMessage.line_number_table = &*LineInfo.begin();
160 FunctionMessage.source_file_name = 0;
161 FunctionMessage.line_number_size = 0;
162 FunctionMessage.line_number_table = 0;
165 Wrapper->iJIT_NotifyEvent(iJVM_EVENT_TYPE_METHOD_LOAD_FINISHED,
167 MethodIDs[(void*)Addr] = FunctionMessage.method_id;
171 // To support object unload notification, we need to keep a list of
172 // registered function addresses for each loaded object. We will
173 // use the MethodIDs map to get the registered ID for each function.
174 LoadedObjectMap[ObjData] = Functions;
177 void IntelJITEventListener::NotifyFreeingObject(const ObjectImage &Obj) {
178 // Get the address of the object image for use as a unique identifier
179 const void* ObjData = Obj.getData().data();
181 // Get the object's function list from LoadedObjectMap
182 ObjectMap::iterator OI = LoadedObjectMap.find(ObjData);
183 if (OI == LoadedObjectMap.end())
185 MethodAddressVector& Functions = OI->second;
187 // Walk the function list, unregistering each function
188 for (MethodAddressVector::iterator FI = Functions.begin(),
189 FE = Functions.end();
192 void* FnStart = const_cast<void*>(*FI);
193 MethodIDMap::iterator MI = MethodIDs.find(FnStart);
194 if (MI != MethodIDs.end()) {
195 Wrapper->iJIT_NotifyEvent(iJVM_EVENT_TYPE_METHOD_UNLOAD_START,
201 // Erase the object from LoadedObjectMap
202 LoadedObjectMap.erase(OI);
205 } // anonymous namespace.
208 JITEventListener *JITEventListener::createIntelJITEventListener() {
209 return new IntelJITEventListener(new IntelJITEventsWrapper);
213 JITEventListener *JITEventListener::createIntelJITEventListener(
214 IntelJITEventsWrapper* TestImpl) {
215 return new IntelJITEventListener(TestImpl);