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 "IntelJITEventsWrapper.h"
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/CodeGen/MachineFunction.h"
19 #include "llvm/DebugInfo/DIContext.h"
20 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
21 #include "llvm/ExecutionEngine/JITEventListener.h"
22 #include "llvm/IR/DebugInfo.h"
23 #include "llvm/IR/Function.h"
24 #include "llvm/IR/Metadata.h"
25 #include "llvm/IR/ValueHandle.h"
26 #include "llvm/Object/ObjectFile.h"
27 #include "llvm/Support/Debug.h"
28 #include "llvm/Support/Errno.h"
29 #include "llvm/Support/raw_ostream.h"
32 using namespace llvm::object;
34 #define DEBUG_TYPE "amplifier-jit-event-listener"
38 class IntelJITEventListener : public JITEventListener {
39 typedef DenseMap<void*, unsigned int> MethodIDMap;
41 std::unique_ptr<IntelJITEventsWrapper> Wrapper;
42 MethodIDMap MethodIDs;
44 typedef SmallVector<const void *, 64> MethodAddressVector;
45 typedef DenseMap<const void *, MethodAddressVector> ObjectMap;
47 ObjectMap LoadedObjectMap;
48 std::map<const char*, OwningBinary<ObjectFile>> DebugObjects;
51 IntelJITEventListener(IntelJITEventsWrapper* libraryWrapper) {
52 Wrapper.reset(libraryWrapper);
55 ~IntelJITEventListener() {
58 void NotifyObjectEmitted(const ObjectFile &Obj,
59 const RuntimeDyld::LoadedObjectInfo &L) override;
61 void NotifyFreeingObject(const ObjectFile &Obj) override;
64 static LineNumberInfo DILineInfoToIntelJITFormat(uintptr_t StartAddress,
67 LineNumberInfo Result;
69 Result.Offset = Address - StartAddress;
70 Result.LineNumber = Line.Line;
75 static iJIT_Method_Load FunctionDescToIntelJITFormat(
76 IntelJITEventsWrapper& Wrapper,
80 iJIT_Method_Load Result;
81 memset(&Result, 0, sizeof(iJIT_Method_Load));
83 Result.method_id = Wrapper.iJIT_GetNewMethodID();
84 Result.method_name = const_cast<char*>(FnName);
85 Result.method_load_address = reinterpret_cast<void*>(FnStart);
86 Result.method_size = FnSize;
89 Result.class_file_name = NULL;
90 Result.user_data = NULL;
91 Result.user_data_size = 0;
92 Result.env = iJDE_JittingAPI;
97 void IntelJITEventListener::NotifyObjectEmitted(
98 const ObjectFile &Obj,
99 const RuntimeDyld::LoadedObjectInfo &L) {
101 OwningBinary<ObjectFile> DebugObjOwner = L.getObjectForDebug(Obj);
102 const ObjectFile &DebugObj = *DebugObjOwner.getBinary();
104 // Get the address of the object image for use as a unique identifier
105 const void* ObjData = DebugObj.getData().data();
106 DIContext* Context = new DWARFContextInMemory(DebugObj);
107 MethodAddressVector Functions;
109 // Use symbol info to iterate functions in the object.
110 for (symbol_iterator I = DebugObj.symbol_begin(),
111 E = DebugObj.symbol_end();
114 std::vector<LineNumberInfo> LineInfo;
115 std::string SourceFileName;
117 SymbolRef::Type SymType;
118 if (I->getType(SymType)) continue;
119 if (SymType == SymbolRef::ST_Function) {
122 if (I->getName(Name)) continue;
123 if (I->getAddress(Addr)) continue;
124 uint64_t Size = I->getSize();
126 // Record this address in a local vector
127 Functions.push_back((void*)Addr);
129 // Build the function loaded notification message
130 iJIT_Method_Load FunctionMessage = FunctionDescToIntelJITFormat(*Wrapper,
135 DILineInfoTable Lines = Context->getLineInfoForAddressRange(Addr, Size);
136 DILineInfoTable::iterator Begin = Lines.begin();
137 DILineInfoTable::iterator End = Lines.end();
138 for (DILineInfoTable::iterator It = Begin; It != End; ++It) {
139 LineInfo.push_back(DILineInfoToIntelJITFormat((uintptr_t)Addr,
143 if (LineInfo.size() == 0) {
144 FunctionMessage.source_file_name = 0;
145 FunctionMessage.line_number_size = 0;
146 FunctionMessage.line_number_table = 0;
148 // Source line information for the address range is provided as
149 // a code offset for the start of the corresponding sub-range and
150 // a source line. JIT API treats offsets in LineNumberInfo structures
151 // as the end of the corresponding code region. The start of the code
152 // is taken from the previous element. Need to shift the elements.
154 LineNumberInfo last = LineInfo.back();
155 last.Offset = FunctionMessage.method_size;
156 LineInfo.push_back(last);
157 for (size_t i = LineInfo.size() - 2; i > 0; --i)
158 LineInfo[i].LineNumber = LineInfo[i - 1].LineNumber;
160 SourceFileName = Lines.front().second.FileName;
161 FunctionMessage.source_file_name = const_cast<char *>(SourceFileName.c_str());
162 FunctionMessage.line_number_size = LineInfo.size();
163 FunctionMessage.line_number_table = &*LineInfo.begin();
166 FunctionMessage.source_file_name = 0;
167 FunctionMessage.line_number_size = 0;
168 FunctionMessage.line_number_table = 0;
171 Wrapper->iJIT_NotifyEvent(iJVM_EVENT_TYPE_METHOD_LOAD_FINISHED,
173 MethodIDs[(void*)Addr] = FunctionMessage.method_id;
177 // To support object unload notification, we need to keep a list of
178 // registered function addresses for each loaded object. We will
179 // use the MethodIDs map to get the registered ID for each function.
180 LoadedObjectMap[ObjData] = Functions;
181 DebugObjects[Obj.getData().data()] = std::move(DebugObjOwner);
184 void IntelJITEventListener::NotifyFreeingObject(const ObjectFile &Obj) {
185 // This object may not have been registered with the listener. If it wasn't,
187 if (DebugObjects.find(Obj.getData().data()) == DebugObjects.end())
190 // Get the address of the object image for use as a unique identifier
191 const ObjectFile &DebugObj = *DebugObjects[Obj.getData().data()].getBinary();
192 const void* ObjData = DebugObj.getData().data();
194 // Get the object's function list from LoadedObjectMap
195 ObjectMap::iterator OI = LoadedObjectMap.find(ObjData);
196 if (OI == LoadedObjectMap.end())
198 MethodAddressVector& Functions = OI->second;
200 // Walk the function list, unregistering each function
201 for (MethodAddressVector::iterator FI = Functions.begin(),
202 FE = Functions.end();
205 void* FnStart = const_cast<void*>(*FI);
206 MethodIDMap::iterator MI = MethodIDs.find(FnStart);
207 if (MI != MethodIDs.end()) {
208 Wrapper->iJIT_NotifyEvent(iJVM_EVENT_TYPE_METHOD_UNLOAD_START,
214 // Erase the object from LoadedObjectMap
215 LoadedObjectMap.erase(OI);
216 DebugObjects.erase(Obj.getData().data());
219 } // anonymous namespace.
222 JITEventListener *JITEventListener::createIntelJITEventListener() {
223 return new IntelJITEventListener(new IntelJITEventsWrapper);
227 JITEventListener *JITEventListener::createIntelJITEventListener(
228 IntelJITEventsWrapper* TestImpl) {
229 return new IntelJITEventListener(TestImpl);