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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/*
* Copyright (C) 2018-2020 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#include "shared/source/source_level_debugger/source_level_debugger.h"
#include "shared/source/debugger/debugger.h"
#include "shared/source/helpers/debug_helpers.h"
#include "shared/source/kernel/debug_data.h"
#include "shared/source/os_interface/os_interface.h"
#include "igfx_debug_interchange_types.h"
#include "lib_names.h"
#define IGFXDBG_CURRENT_VERSION 4
namespace NEO {
const char *SourceLevelDebugger::notifyNewDeviceSymbol = "notifyNewDevice";
const char *SourceLevelDebugger::notifySourceCodeSymbol = "notifySourceCode";
const char *SourceLevelDebugger::getDebuggerOptionSymbol = "getDebuggerOption";
const char *SourceLevelDebugger::notifyKernelDebugDataSymbol = "notifyKernelDebugData";
const char *SourceLevelDebugger::initSymbol = "init";
const char *SourceLevelDebugger::isDebuggerActiveSymbol = "isDebuggerActive";
const char *SourceLevelDebugger::notifyDeviceDestructionSymbol = "notifyDeviceDestruction";
const char *SourceLevelDebugger::dllName = SLD_LIBRARY_NAME;
class SourceLevelDebugger::SourceLevelDebuggerInterface {
public:
SourceLevelDebuggerInterface() = default;
~SourceLevelDebuggerInterface() = default;
typedef int (*NotifyNewDeviceFunction)(GfxDbgNewDeviceData *data);
typedef int (*NotifySourceCodeFunction)(GfxDbgSourceCode *data);
typedef int (*GetDebuggerOptionFunction)(GfxDbgOption *);
typedef int (*NotifyKernelDebugDataFunction)(GfxDbgKernelDebugData *data);
typedef int (*InitFunction)(GfxDbgTargetCaps *data);
typedef int (*IsDebuggerActiveFunction)(void);
typedef int (*NotifyDeviceDestructionFunction)(GfxDbgDeviceDestructionData *data);
NotifyNewDeviceFunction notifyNewDeviceFunc = nullptr;
NotifySourceCodeFunction notifySourceCodeFunc = nullptr;
GetDebuggerOptionFunction getDebuggerOptionFunc = nullptr;
NotifyKernelDebugDataFunction notifyKernelDebugDataFunc = nullptr;
InitFunction initFunc = nullptr;
IsDebuggerActiveFunction isDebuggerActive = nullptr;
NotifyDeviceDestructionFunction notifyDeviceDestructionFunc = nullptr;
};
SourceLevelDebugger *SourceLevelDebugger::create() {
auto library = SourceLevelDebugger::loadDebugger();
if (library) {
auto isActiveFunc = reinterpret_cast<SourceLevelDebuggerInterface::IsDebuggerActiveFunction>(library->getProcAddress(isDebuggerActiveSymbol));
int result = isActiveFunc();
if (result == 1) {
// pass library ownership to Source Level Debugger
return new SourceLevelDebugger(library);
}
delete library;
}
return nullptr;
}
SourceLevelDebugger::SourceLevelDebugger(OsLibrary *library) {
debuggerLibrary.reset(library);
isLegacyMode = true;
if (debuggerLibrary.get() == nullptr) {
return;
}
sourceLevelDebuggerInterface = new SourceLevelDebuggerInterface;
getFunctions();
if (sourceLevelDebuggerInterface->isDebuggerActive == nullptr) {
return;
}
int result = sourceLevelDebuggerInterface->isDebuggerActive();
if (result == 1) {
UNRECOVERABLE_IF(sourceLevelDebuggerInterface->getDebuggerOptionFunc == nullptr);
UNRECOVERABLE_IF(sourceLevelDebuggerInterface->initFunc == nullptr);
UNRECOVERABLE_IF(sourceLevelDebuggerInterface->notifyKernelDebugDataFunc == nullptr);
UNRECOVERABLE_IF(sourceLevelDebuggerInterface->notifyNewDeviceFunc == nullptr);
UNRECOVERABLE_IF(sourceLevelDebuggerInterface->notifySourceCodeFunc == nullptr);
UNRECOVERABLE_IF(sourceLevelDebuggerInterface->notifyDeviceDestructionFunc == nullptr);
isActive = true;
}
}
SourceLevelDebugger::~SourceLevelDebugger() {
if (sourceLevelDebuggerInterface) {
delete sourceLevelDebuggerInterface;
}
}
bool SourceLevelDebugger::isDebuggerActive() {
return isActive;
}
void SourceLevelDebugger::getFunctions() {
UNRECOVERABLE_IF(debuggerLibrary.get() == nullptr);
sourceLevelDebuggerInterface->notifyNewDeviceFunc = reinterpret_cast<SourceLevelDebuggerInterface::NotifyNewDeviceFunction>(debuggerLibrary->getProcAddress(notifyNewDeviceSymbol));
sourceLevelDebuggerInterface->notifySourceCodeFunc = reinterpret_cast<SourceLevelDebuggerInterface::NotifySourceCodeFunction>(debuggerLibrary->getProcAddress(notifySourceCodeSymbol));
sourceLevelDebuggerInterface->getDebuggerOptionFunc = reinterpret_cast<SourceLevelDebuggerInterface::GetDebuggerOptionFunction>(debuggerLibrary->getProcAddress(getDebuggerOptionSymbol));
sourceLevelDebuggerInterface->notifyKernelDebugDataFunc = reinterpret_cast<SourceLevelDebuggerInterface::NotifyKernelDebugDataFunction>(debuggerLibrary->getProcAddress(notifyKernelDebugDataSymbol));
sourceLevelDebuggerInterface->initFunc = reinterpret_cast<SourceLevelDebuggerInterface::InitFunction>(debuggerLibrary->getProcAddress(initSymbol));
sourceLevelDebuggerInterface->isDebuggerActive = reinterpret_cast<SourceLevelDebuggerInterface::IsDebuggerActiveFunction>(debuggerLibrary->getProcAddress(isDebuggerActiveSymbol));
sourceLevelDebuggerInterface->notifyDeviceDestructionFunc = reinterpret_cast<SourceLevelDebuggerInterface::NotifyDeviceDestructionFunction>(debuggerLibrary->getProcAddress(notifyDeviceDestructionSymbol));
}
bool SourceLevelDebugger::notifyNewDevice(uint32_t deviceHandle) {
if (isActive) {
GfxDbgNewDeviceData newDevice;
newDevice.version = IGFXDBG_CURRENT_VERSION;
newDevice.dh = reinterpret_cast<GfxDeviceHandle>(static_cast<uint64_t>(deviceHandle));
newDevice.udh = GfxDeviceHandle(0);
int result = sourceLevelDebuggerInterface->notifyNewDeviceFunc(&newDevice);
DEBUG_BREAK_IF(static_cast<IgfxdbgRetVal>(result) != IgfxdbgRetVal::IGFXDBG_SUCCESS);
static_cast<void>(result);
this->deviceHandle = deviceHandle;
}
return false;
}
bool SourceLevelDebugger::notifyDeviceDestruction() {
if (isActive) {
GfxDbgDeviceDestructionData deviceDestruction;
deviceDestruction.version = IGFXDBG_CURRENT_VERSION;
deviceDestruction.dh = reinterpret_cast<GfxDeviceHandle>(static_cast<uint64_t>(this->deviceHandle));
int result = sourceLevelDebuggerInterface->notifyDeviceDestructionFunc(&deviceDestruction);
DEBUG_BREAK_IF(static_cast<IgfxdbgRetVal>(result) != IgfxdbgRetVal::IGFXDBG_SUCCESS);
static_cast<void>(result);
this->deviceHandle = 0;
return true;
}
return false;
}
bool SourceLevelDebugger::notifySourceCode(const char *source, size_t sourceSize, std::string &file) const {
if (isActive) {
GfxDbgSourceCode sourceCode;
char fileName[FILENAME_MAX] = "";
sourceCode.version = IGFXDBG_CURRENT_VERSION;
sourceCode.hDevice = reinterpret_cast<GfxDeviceHandle>(static_cast<uint64_t>(this->deviceHandle));
sourceCode.sourceCode = source;
sourceCode.sourceCodeSize = static_cast<unsigned int>(sourceSize);
sourceCode.sourceName = &fileName[0];
sourceCode.sourceNameMaxLen = sizeof(fileName);
int result = sourceLevelDebuggerInterface->notifySourceCodeFunc(&sourceCode);
DEBUG_BREAK_IF(static_cast<IgfxdbgRetVal>(result) != IgfxdbgRetVal::IGFXDBG_SUCCESS);
static_cast<void>(result);
file = fileName;
}
return false;
}
bool SourceLevelDebugger::isOptimizationDisabled() const {
if (isActive) {
const size_t optionValueSize = 4;
char value[optionValueSize] = {0};
GfxDbgOption option;
option.version = IGFXDBG_CURRENT_VERSION;
option.optionName = DBG_OPTION_IS_OPTIMIZATION_DISABLED;
option.valueLen = sizeof(value);
option.value = &value[0];
int result = sourceLevelDebuggerInterface->getDebuggerOptionFunc(&option);
if (result == 1) {
if (option.value[0] == '1') {
return true;
}
}
}
return false;
}
bool SourceLevelDebugger::notifyKernelDebugData(const DebugData *debugData, const std::string &name, const void *isa, size_t isaSize) const {
if (isActive && debugData->vIsa && debugData->genIsa) {
GfxDbgKernelDebugData kernelDebugData;
kernelDebugData.hDevice = reinterpret_cast<GfxDeviceHandle>(static_cast<uint64_t>(this->deviceHandle));
kernelDebugData.version = IGFXDBG_CURRENT_VERSION;
kernelDebugData.hProgram = reinterpret_cast<GenRtProgramHandle>(0);
kernelDebugData.kernelName = name.c_str();
kernelDebugData.kernelBinBuffer = const_cast<void *>(isa);
kernelDebugData.KernelBinSize = static_cast<uint32_t>(isaSize);
kernelDebugData.dbgVisaBuffer = debugData->vIsa;
kernelDebugData.dbgVisaSize = debugData->vIsaSize;
kernelDebugData.dbgGenIsaBuffer = debugData->genIsa;
kernelDebugData.dbgGenIsaSize = debugData->genIsaSize;
int result = sourceLevelDebuggerInterface->notifyKernelDebugDataFunc(&kernelDebugData);
DEBUG_BREAK_IF(static_cast<IgfxdbgRetVal>(result) != IgfxdbgRetVal::IGFXDBG_SUCCESS);
static_cast<void>(result);
}
return false;
}
bool SourceLevelDebugger::initialize(bool useLocalMemory) {
if (isActive) {
GfxDbgTargetCaps caps = {IGFXDBG_CURRENT_VERSION, useLocalMemory};
int result = sourceLevelDebuggerInterface->initFunc(&caps);
if (static_cast<IgfxdbgRetVal>(result) != IgfxdbgRetVal::IGFXDBG_SUCCESS) {
isActive = false;
}
}
return false;
}
} // namespace NEO
|
