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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
/*
* Copyright (C) 2018-2025 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#pragma once
#include "shared/source/helpers/non_copyable_or_moveable.h"
#include "shared/source/helpers/options.h"
#include "shared/source/helpers/string.h"
#include "shared/source/helpers/timestamp.h"
#include "shared/source/utilities/io_functions.h"
#include <cstdint>
#include <memory>
#include <string>
#include <type_traits>
#if defined(_WIN32)
#include <process.h>
#pragma warning(disable : 4996)
#else
#include <unistd.h>
#endif
enum class DebugFunctionalityLevel {
none, // Debug functionality disabled
full, // Debug functionality fully enabled
regKeys // Only registry key reads enabled
};
#if defined(_DEBUG)
constexpr DebugFunctionalityLevel globalDebugFunctionalityLevel = DebugFunctionalityLevel::full;
#elif defined(_RELEASE_INTERNAL) || defined(_RELEASE_BUILD_WITH_REGKEYS)
constexpr DebugFunctionalityLevel globalDebugFunctionalityLevel = DebugFunctionalityLevel::regKeys;
#else
constexpr DebugFunctionalityLevel globalDebugFunctionalityLevel = DebugFunctionalityLevel::none;
#endif
#define PRINT_DEBUG_STRING(flag, stream, ...) \
if (flag) \
NEO::printDebugString(flag, stream, __VA_ARGS__);
#define EMIT_WARNING(flag, stream, ...) PRINT_DEBUG_STRING(flag, stream, __VA_ARGS__)
namespace NEO {
template <DebugFunctionalityLevel debugLevel>
class FileLogger;
extern FileLogger<globalDebugFunctionalityLevel> &fileLoggerInstance();
template <typename StreamT, typename... Args>
void flushDebugStream(StreamT stream, Args &&...args) {
IoFunctions::fflushPtr(stream);
}
void logDebugString(std::string_view debugString);
#if defined(__clang__)
#define NO_SANITIZE __attribute__((no_sanitize("undefined")))
#else
#define NO_SANITIZE
#endif
class SettingsReader;
enum class DebugVarPrefix : uint8_t {
none = 1,
neo = 2,
neoL0 = 3,
neoOcl = 4,
neoOcloc = 5
};
using DVarsScopeMask = std::underlying_type_t<DebugVarPrefix>;
constexpr auto getDebugVarScopeMaskFor(DebugVarPrefix v) {
return static_cast<DVarsScopeMask>(1U) << static_cast<DVarsScopeMask>(v);
}
template <DebugVarPrefix... vs>
constexpr auto getDebugVarScopeMaskFor() {
return (0 | ... | getDebugVarScopeMaskFor(vs));
}
// compatibility with "old" behavior (prior to introducing scope masks)
constexpr inline DVarsScopeMask compatibilityMask = getDebugVarScopeMaskFor<DebugVarPrefix::neoL0, DebugVarPrefix::neoOcl>();
template <typename T>
struct DebugVarBase {
DebugVarBase(const T &defaultValue) : value(defaultValue), defaultValue(defaultValue) {}
DebugVarBase(const T &defaultValue, DVarsScopeMask scopeMask) : value(defaultValue), defaultValue(defaultValue), scopeMask(scopeMask) {}
T get() const {
return value;
}
void set(T data) {
value = std::move(data);
}
T &getRef() {
return value;
}
void setIfDefault(T data) {
if (value == defaultValue) {
this->set(data);
}
}
void setPrefixType(DebugVarPrefix data) {
prefixType = std::move(data);
}
DebugVarPrefix getPrefixType() const {
return prefixType;
}
DVarsScopeMask getScopeMask() const {
return scopeMask;
}
private:
T value;
T defaultValue;
DebugVarPrefix prefixType = DebugVarPrefix::none;
DVarsScopeMask scopeMask = compatibilityMask;
};
struct DebugVariables { // NOLINT(clang-analyzer-optin.performance.Padding)
struct DEBUGGER_LOG_BITMASK { // NOLINT(readability-identifier-naming)
constexpr static int32_t LOG_INFO{1}; // NOLINT(readability-identifier-naming)
constexpr static int32_t LOG_ERROR{1 << 1}; // NOLINT(readability-identifier-naming)
constexpr static int32_t LOG_THREADS{1 << 2}; // NOLINT(readability-identifier-naming)
constexpr static int32_t LOG_MEM{1 << 3}; // NOLINT(readability-identifier-naming)
constexpr static int32_t LOG_FIFO{1 << 4}; // NOLINT(readability-identifier-naming)
constexpr static int32_t DUMP_ELF{1 << 10}; // NOLINT(readability-identifier-naming)
constexpr static int32_t DUMP_TO_FILE{1 << 16}; // NOLINT(readability-identifier-naming)
};
#define DECLARE_DEBUG_VARIABLE(dataType, variableName, defaultValue, description) \
DebugVarBase<dataType> variableName{defaultValue};
#define S_NONE getDebugVarScopeMaskFor(DebugVarPrefix::none)
#define S_NEO getDebugVarScopeMaskFor(DebugVarPrefix::neo)
#define S_OCL getDebugVarScopeMaskFor(DebugVarPrefix::neoOcl)
#define S_L0 getDebugVarScopeMaskFor(DebugVarPrefix::neoL0)
#define S_RT (S_NEO | S_OCL | S_L0 | S_NONE)
#define S_OCLOC getDebugVarScopeMaskFor(DebugVarPrefix::neoOcloc)
#define DECLARE_DEBUG_SCOPED_V(dataType, variableName, defaultValue, scope, description) \
DebugVarBase<dataType> variableName{defaultValue, scope};
#include "debug_variables.inl"
#include "release_variables.inl"
#undef S_OCLOC
#undef S_RT
#undef S_L0
#undef S_OCL
#undef S_NEO
#undef S_NONE
#undef DECLARE_DEBUG_SCOPED_V
#undef DECLARE_DEBUG_VARIABLE
};
template <DebugFunctionalityLevel debugLevel>
class DebugSettingsManager : NEO::NonCopyableAndNonMovableClass {
public:
DebugSettingsManager(const char *registryPath);
~DebugSettingsManager();
static consteval bool registryReadAvailable() {
return (debugLevel == DebugFunctionalityLevel::full) || (debugLevel == DebugFunctionalityLevel::regKeys);
}
static consteval bool disabled() {
return debugLevel == DebugFunctionalityLevel::none;
}
void getHardwareInfoOverride(std::string &hwInfoConfig);
void injectSettingsFromReader();
DebugVariables flags;
void *injectFcn = nullptr;
void setReaderImpl(SettingsReader *newReaderImpl) {
readerImpl.reset(newReaderImpl);
}
SettingsReader *getReaderImpl() {
return readerImpl.get();
}
static consteval const char *getNonReleaseKeyName(const char *key) {
return (disabled() && PURGE_DEBUG_KEY_NAMES) ? "" : key;
}
void getStringWithFlags(std::string &allFlags, std::string &changedFlags) const;
template <typename FT>
void logLazyEvaluateArgs(FT &&callable) {
if (!disabled()) {
callable();
}
}
inline bool isTbxPageFaultManagerEnabled() {
auto setCsr = flags.SetCommandStreamReceiver.get();
auto isTbxMode = (setCsr == static_cast<int32_t>(CommandStreamReceiverType::tbx)) ||
(setCsr == static_cast<int32_t>(CommandStreamReceiverType::tbxWithAub));
auto isFaultManagerEnabledInEnvVars = true;
if (flags.EnableTbxPageFaultManager.get() == 0) {
isFaultManagerEnabledInEnvVars = false;
}
return isFaultManagerEnabledInEnvVars && isTbxMode;
}
protected:
DVarsScopeMask scope = 0;
std::unique_ptr<SettingsReader> readerImpl;
bool isLoopAtDriverInitEnabled() const {
auto loopingEnabled = flags.LoopAtDriverInit.get();
return loopingEnabled;
}
template <typename DataType>
static void dumpNonDefaultFlag(const char *variableName, const DataType &variableValue, const DataType &defaultValuep, std::ostringstream &ostring);
void dumpFlags() const;
static const char *settingsDumpFileName;
};
static_assert(NEO::NonCopyableAndNonMovable<DebugSettingsManager<DebugFunctionalityLevel::none>>);
static_assert(NEO::NonCopyableAndNonMovable<DebugSettingsManager<DebugFunctionalityLevel::full>>);
static_assert(NEO::NonCopyableAndNonMovable<DebugSettingsManager<DebugFunctionalityLevel::regKeys>>);
extern DebugSettingsManager<globalDebugFunctionalityLevel> debugManager;
struct DebugMessagesBitmask {
constexpr static int32_t withPid = 1 << 0;
constexpr static int32_t withTimestamp = 1 << 1;
};
template <typename... Args>
void printDebugString(bool showDebugLogs, FILE *stream, Args... args) {
if (showDebugLogs) {
if (NEO::debugManager.flags.DebugMessagesBitmask.get() & DebugMessagesBitmask::withPid) {
IoFunctions::fprintf(stream, "[PID: %d] ", getpid());
}
if (NEO::debugManager.flags.DebugMessagesBitmask.get() & DebugMessagesBitmask::withTimestamp) {
IoFunctions::fprintf(stream, "%s", TimestampHelper::getTimestamp().c_str());
}
IoFunctions::fprintf(stream, args...);
flushDebugStream(stream, args...);
}
}
class DurationLog {
DurationLog() = delete;
public:
static std::string getTimeString();
};
#define PRINT_DEBUGGER_LOG_TO_FILE(...) \
NEO::debugManager.logLazyEvaluateArgs([&] { \
char temp[4000]; \
snprintf_s(temp, sizeof(temp), sizeof(temp), __VA_ARGS__); \
temp[sizeof(temp) - 1] = '\0'; \
NEO::logDebugString(temp); \
});
#define PRINT_DEBUGGER_LOG(OUT, ...) \
if (NEO::debugManager.flags.DebuggerLogBitmask.get() & NEO::DebugVariables::DEBUGGER_LOG_BITMASK::DUMP_TO_FILE) { \
PRINT_DEBUGGER_LOG_TO_FILE(__VA_ARGS__) \
} else { \
NEO::printDebugString(true, OUT, __VA_ARGS__); \
}
#define PRINT_DEBUGGER_INFO_LOG(STR, ...) \
if (NEO::debugManager.flags.DebuggerLogBitmask.get() & NEO::DebugVariables::DEBUGGER_LOG_BITMASK::LOG_INFO) { \
\
auto time = NEO::DurationLog::getTimeString(); \
time = "\n" + time + " INFO: " + STR; \
PRINT_DEBUGGER_LOG(stdout, time.c_str(), __VA_ARGS__) \
}
#define PRINT_DEBUGGER_THREAD_LOG(STR, ...) \
if (NEO::debugManager.flags.DebuggerLogBitmask.get() & NEO::DebugVariables::DEBUGGER_LOG_BITMASK::LOG_THREADS) { \
\
auto time = NEO::DurationLog::getTimeString(); \
time = "\n" + time + " THREAD INFO: " + STR; \
PRINT_DEBUGGER_LOG(stdout, time.c_str(), __VA_ARGS__) \
}
#define PRINT_DEBUGGER_ERROR_LOG(STR, ...) \
if (NEO::debugManager.flags.DebuggerLogBitmask.get() & NEO::DebugVariables::DEBUGGER_LOG_BITMASK::LOG_ERROR) { \
\
auto time = NEO::DurationLog::getTimeString(); \
time = "\n" + time + " ERROR: " + STR; \
PRINT_DEBUGGER_LOG(stderr, time.c_str(), __VA_ARGS__) \
}
#define PRINT_DEBUGGER_MEM_ACCESS_LOG(STR, ...) \
if (NEO::debugManager.flags.DebuggerLogBitmask.get() & NEO::DebugVariables::DEBUGGER_LOG_BITMASK::LOG_MEM) { \
\
auto time = NEO::DurationLog::getTimeString(); \
time = "\n" + time + " MEM_ACCESS: " + STR; \
PRINT_DEBUGGER_LOG(stdout, time.c_str(), __VA_ARGS__) \
}
#define PRINT_DEBUGGER_FIFO_LOG(STR, ...) \
if (NEO::debugManager.flags.DebuggerLogBitmask.get() & NEO::DebugVariables::DEBUGGER_LOG_BITMASK::LOG_FIFO) { \
\
auto time = NEO::DurationLog::getTimeString(); \
time = "\n" + time + " FIFO ACCESS: " + STR; \
PRINT_DEBUGGER_LOG(stdout, time.c_str(), __VA_ARGS__) \
}
template <DebugFunctionalityLevel debugLevel>
const char *DebugSettingsManager<debugLevel>::settingsDumpFileName = "igdrcl_dumped.config";
}; // namespace NEO
|
