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
|
/*
* Copyright (C) 2018-2025 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
*/
#include "debug_settings_manager.h"
#include "shared/source/debug_settings/debug_variables_helper.h"
#include "shared/source/debug_settings/definitions/translate_debug_settings.h"
#include "shared/source/helpers/api_specific_config.h"
#include "shared/source/helpers/debug_helpers.h"
#include "shared/source/helpers/string.h"
#include "shared/source/utilities/debug_settings_reader_creator.h"
#include "shared/source/utilities/io_functions.h"
#include "shared/source/utilities/logger.h"
#include <chrono>
#include <cinttypes>
#include <fstream>
#include <iomanip>
#include <iostream>
#include <sstream>
#include <type_traits>
namespace NEO {
#define DECLARE_DEBUG_SCOPED_V(dataType, variableName, defaultValue, description, ...) \
DECLARE_DEBUG_VARIABLE(dataType, variableName, defaultValue, description)
template <typename T>
static std::string toString(const T &arg) {
if constexpr (std::is_convertible_v<std::string, T>) {
return static_cast<std::string>(arg);
} else {
return std::to_string(arg);
}
}
template <DebugFunctionalityLevel debugLevel>
DebugSettingsManager<debugLevel>::DebugSettingsManager(const char *registryPath) {
readerImpl = SettingsReaderCreator::create(std::string(registryPath));
ApiSpecificConfig::initPrefixes();
for (auto prefixType : ApiSpecificConfig::getPrefixTypes()) {
this->scope |= getDebugVarScopeMaskFor(prefixType);
}
injectSettingsFromReader();
dumpFlags();
translateDebugSettings(flags);
while (isLoopAtDriverInitEnabled()) {
;
}
}
template <DebugFunctionalityLevel debugLevel>
DebugSettingsManager<debugLevel>::~DebugSettingsManager() {
readerImpl.reset();
};
template <DebugFunctionalityLevel debugLevel>
void DebugSettingsManager<debugLevel>::getHardwareInfoOverride(std::string &hwInfoConfig) {
std::string str = flags.HardwareInfoOverride.get();
if (str[0] == '\"') {
str.pop_back();
hwInfoConfig = str.substr(1, std::string::npos);
} else {
hwInfoConfig = str;
}
}
static const char *convPrefixToString(DebugVarPrefix prefix) {
if (prefix == DebugVarPrefix::neo) {
return "NEO_";
} else if (prefix == DebugVarPrefix::neoL0) {
return "NEO_L0_";
} else if (prefix == DebugVarPrefix::neoOcl) {
return "NEO_OCL_";
} else if (prefix == DebugVarPrefix::neoOcloc) {
return "NEO_OCLOC_";
} else {
return "";
}
}
template <DebugFunctionalityLevel debugLevel>
template <typename DataType>
void DebugSettingsManager<debugLevel>::dumpNonDefaultFlag(const char *variableName, const DataType &variableValue, const DataType &defaultValue, std::ostringstream &ostring) {
if (variableValue != defaultValue) {
const auto variableStringValue = toString(variableValue);
ostring << "Non-default value of debug variable: " << variableName << " = " << variableStringValue.c_str() << '\n';
}
}
template <DebugFunctionalityLevel debugLevel>
void DebugSettingsManager<debugLevel>::getStringWithFlags(std::string &allFlags, std::string &changedFlags) const {
std::ostringstream allFlagsStream;
allFlagsStream.str("");
std::ostringstream changedFlagsStream;
changedFlagsStream.str("");
#define DECLARE_DEBUG_VARIABLE(dataType, variableName, defaultValue, description) \
{ \
std::string neoKey = convPrefixToString(flags.variableName.getPrefixType()); \
constexpr auto keyName = getNonReleaseKeyName(#variableName); \
neoKey += keyName; \
allFlagsStream << neoKey.c_str() << " = " << flags.variableName.get() << '\n'; \
dumpNonDefaultFlag<dataType>(neoKey.c_str(), flags.variableName.get(), defaultValue, changedFlagsStream); \
}
if (registryReadAvailable() || isDebugKeysReadEnabled()) {
#include "debug_variables.inl"
}
#undef DECLARE_DEBUG_VARIABLE
#define DECLARE_RELEASE_VARIABLE(dataType, variableName, defaultValue, description) \
{ \
std::string neoKey = convPrefixToString(flags.variableName.getPrefixType()); \
neoKey += #variableName; \
allFlagsStream << neoKey.c_str() << " = " << flags.variableName.get() << '\n'; \
dumpNonDefaultFlag<dataType>(neoKey.c_str(), flags.variableName.get(), defaultValue, changedFlagsStream); \
}
#define DECLARE_RELEASE_VARIABLE_OPT(enabled, dataType, variableName, defaultValue, description) \
if constexpr (enabled) { \
DECLARE_RELEASE_VARIABLE(dataType, variableName, defaultValue, description) \
}
#include "release_variables.inl"
#undef DECLARE_RELEASE_VARIABLE_OPT
#undef DECLARE_RELEASE_VARIABLE
allFlags = allFlagsStream.str();
changedFlags = changedFlagsStream.str();
}
template <DebugFunctionalityLevel debugLevel>
void DebugSettingsManager<debugLevel>::dumpFlags() const {
if (flags.PrintDebugSettings.get() == false) {
return;
}
std::ofstream settingsDumpFile{settingsDumpFileName, std::ios::out};
DEBUG_BREAK_IF(!settingsDumpFile.good());
std::string allFlags;
std::string changedFlags;
getStringWithFlags(allFlags, changedFlags);
PRINT_DEBUG_STRING(true, stdout, "%s", changedFlags.c_str());
settingsDumpFile << allFlags;
}
template <DebugFunctionalityLevel debugLevel>
void DebugSettingsManager<debugLevel>::injectSettingsFromReader() {
#undef DECLARE_DEBUG_VARIABLE
#define DECLARE_DEBUG_VARIABLE(dataType, variableName, defaultValue, description) \
{ \
DebugVarPrefix type; \
constexpr auto keyName = getNonReleaseKeyName(#variableName); \
dataType tempData = readerImpl->getSetting(keyName, flags.variableName.get(), type); \
if (0 != (this->scope & flags.variableName.getScopeMask())) { \
flags.variableName.setPrefixType(type); \
flags.variableName.set(tempData); \
} \
}
if (registryReadAvailable() || isDebugKeysReadEnabled()) {
#include "debug_variables.inl"
}
#undef DECLARE_DEBUG_VARIABLE
#define DECLARE_RELEASE_VARIABLE(dataType, variableName, defaultValue, description) \
{ \
DebugVarPrefix type; \
dataType tempData = readerImpl->getSetting(#variableName, flags.variableName.get(), type); \
if (0 != (this->scope & flags.variableName.getScopeMask())) { \
flags.variableName.setPrefixType(type); \
flags.variableName.set(tempData); \
} \
}
#define DECLARE_RELEASE_VARIABLE_OPT(enabled, dataType, variableName, defaultValue, description) \
if constexpr (enabled) { \
DECLARE_RELEASE_VARIABLE(dataType, variableName, defaultValue, description) \
}
#include "release_variables.inl"
#undef DECLARE_RELEASE_VARIABLE_OPT
#undef DECLARE_RELEASE_VARIABLE
} // namespace NEO
void logDebugString(std::string_view debugString) {
NEO::fileLoggerInstance().logDebugString(true, debugString);
}
std::string DurationLog::getTimeString() {
auto now = std::chrono::steady_clock::now();
auto microseconds = std::chrono::duration_cast<std::chrono::microseconds>(now.time_since_epoch());
auto seconds = microseconds.count() / 1000000;
auto remainingMicroSeconds = microseconds.count() % 1000000;
char buffer[32];
std::snprintf(buffer, sizeof(buffer), "[%5" PRId64 ".%06" PRId64 "]",
static_cast<int64_t>(seconds), static_cast<int64_t>(remainingMicroSeconds));
return std::string(buffer);
}
std::string DurationLog::getTimestamp() {
auto now = std::chrono::system_clock::now();
std::time_t nowTime = std::chrono::system_clock::to_time_t(now);
tm timeInfo = *std::localtime(&nowTime);
std::stringstream ss;
char buffer[32]{};
std::strftime(buffer, sizeof(buffer), "[%Y-%m-%d %H:%M:%S] ", &timeInfo);
ss << buffer;
return ss.str();
}
template class DebugSettingsManager<DebugFunctionalityLevel::none>;
template class DebugSettingsManager<DebugFunctionalityLevel::full>;
template class DebugSettingsManager<DebugFunctionalityLevel::regKeys>;
}; // namespace NEO
|
