Blender V5.3
vk_debug.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <sstream>
10
11#include "BKE_global.hh"
12#include "BLI_utildefines.hh"
13#include "CLG_log.h"
14
15#include "vk_backend.hh"
16#include "vk_context.hh"
17#include "vk_debug.hh"
18#include "vk_to_string.hh"
19
20#include "gpu_profile_report.hh"
21
22namespace blender {
23
24static CLG_LogRef LOG = {"gpu.vulkan"};
25
26namespace gpu {
27void VKContext::debug_group_begin(const char *name, int index)
28{
30 render_graph().debug_group_begin(name, debug::get_debug_group_color(name));
31
32 if (!G.profile_gpu) {
33 return;
34 }
35
36 ScopeTimings timings = {};
37 timings.name = name;
38 timings.finished = false;
39 timings.cpu_start = ScopeTimings::Clock::now();
40
41 scope_timings.append(timings);
42}
43
45{
47
48 if (!G.profile_gpu) {
49 return;
50 }
51
52 for (int i = scope_timings.size() - 1; i >= 0; i--) {
53 ScopeTimings &query = scope_timings[i];
54 if (!query.finished) {
55 query.finished = true;
56 query.cpu_end = ScopeTimings::Clock::now();
57 break;
58 }
59 if (i == 0) {
60 CLOG_ERROR(&LOG, "Profile GPU error: Extra GPU_debug_group_end() call.");
61 }
62 }
63}
64
65void VKContext::process_frame_timings()
66{
67 if (!G.profile_gpu) {
68 return;
69 }
70
71 Vector<ScopeTimings> &queries = scope_timings;
72
73 bool frame_is_valid = !queries.is_empty();
74
75 for (int i = queries.size() - 1; i >= 0; i--) {
76 if (!queries[i].finished) {
77 frame_is_valid = false;
78 CLOG_ERROR(&LOG, "Profile GPU error: Missing GPU_debug_group_end() call");
79 }
80 break;
81 }
82
83 if (!frame_is_valid) {
84 return;
85 }
86
87 for (ScopeTimings &query : queries) {
89 query.cpu_start.time_since_epoch().count(),
90 query.cpu_end.time_since_epoch().count());
91 }
92
93 queries.clear();
94}
95
96bool VKContext::debug_capture_begin(const char *title)
97{
98 return VKBackend::get().debug_capture_begin(title);
99}
100
101bool VKBackend::debug_capture_begin(const char *title)
102{
103#ifdef WITH_RENDERDOC
104 bool result = renderdoc_api_.start_frame_capture(device.instance_get(), nullptr);
105 if (result && title) {
106 renderdoc_api_.set_frame_capture_title(title);
107 }
108 return result;
109#else
110 UNUSED_VARS(title);
111 return false;
112#endif
113}
114
119
121{
122#ifdef WITH_RENDERDOC
123 renderdoc_api_.end_frame_capture(device.instance_get(), nullptr);
124#endif
125}
126
128{
129 return (void *)name;
130}
131
133{
134#ifdef WITH_RENDERDOC
135 const char *title = (const char *)scope;
136 if (StringRefNull(title) != StringRefNull(G.gpu_debug_scope_name)) {
137 return false;
138 }
140#else
141 UNUSED_VARS(scope);
142#endif
143 return false;
144}
145
147{
148#ifdef WITH_RENDERDOC
149 const char *title = (const char *)scope;
150 if (StringRefNull(title) == StringRefNull(G.gpu_debug_scope_name)) {
152 }
153#else
154 UNUSED_VARS(scope);
155#endif
156}
157
158} // namespace gpu
159
160namespace gpu::debug {
161
162void VKDebuggingTools::init(VkInstance vk_instance)
163{
165 init_messenger(vk_instance);
166}
167
168void VKDebuggingTools::deinit(VkInstance vk_instance)
169{
170 destroy_messenger(vk_instance);
171}
172
173void object_label(VkObjectType vk_object_type, uint64_t object_handle, const char *name)
174{
175 const VKDevice &device = VKBackend::get().device;
176 if (G.debug & G_DEBUG_GPU && volk::vkSetDebugUtilsObjectNameEXT && object_handle != 0) {
177 VkDebugUtilsObjectNameInfoEXT info = {};
178 info.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT;
179 info.objectType = vk_object_type;
180 info.objectHandle = object_handle;
181 info.pObjectName = name;
182 volk::vkSetDebugUtilsObjectNameEXT(device.vk_handle(), &info);
183 }
184}
185
186} // namespace gpu::debug
187
188namespace gpu::debug {
189
190void VKDebuggingTools::print_labels(const VkDebugUtilsMessengerCallbackDataEXT *callback_data)
191{
192 std::stringstream ss;
193 for (uint32_t object = 0; object < callback_data->objectCount; ++object) {
194 ss << " - ObjectType[" << to_string(callback_data->pObjects[object].objectType) << "],";
195 ss << "Handle[0x" << std::hex << uintptr_t(callback_data->pObjects[object].objectHandle)
196 << "]";
197 if (callback_data->pObjects[object].pObjectName) {
198 ss << ",Name[" << callback_data->pObjects[object].pObjectName << "]";
199 }
200 ss << std::endl;
201 }
202 for (uint32_t label = 0; label < callback_data->cmdBufLabelCount; ++label) {
203 if (callback_data->pCmdBufLabels[label].pLabelName) {
204 ss << " - CommandBuffer : " << callback_data->pCmdBufLabels[label].pLabelName << std::endl;
205 }
206 }
207 for (uint32_t label = 0; label < callback_data->queueLabelCount; ++label) {
208 if (callback_data->pQueueLabels[label].pLabelName) {
209 ss << " - Queue : " << callback_data->pQueueLabels[label].pLabelName << std::endl;
210 }
211 }
212 ss << std::endl;
213 printf("%s", ss.str().c_str());
214}
215
216static VKAPI_ATTR VkBool32 VKAPI_CALL
217messenger_callback(VkDebugUtilsMessageSeverityFlagBitsEXT message_severity,
218 VkDebugUtilsMessageTypeFlagsEXT message_type,
219 const VkDebugUtilsMessengerCallbackDataEXT *callback_data,
220 void *user_data)
221{
223 if (message_severity & (VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT |
224 VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT))
225 {
226 level = CLG_LEVEL_INFO;
227 }
228 if (message_severity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT) {
229 level = CLG_LEVEL_WARN;
230 }
231 if (message_severity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT) {
232 level = CLG_LEVEL_ERROR;
233 }
234
235 if (bool(message_type & VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT)) {
236 const char *format = "{0x%x}%s\n %s";
238 level,
239 format,
240 callback_data->messageIdNumber,
241 callback_data->pMessageIdName,
242 callback_data->pMessage);
243 const bool do_labels = (callback_data->objectCount + callback_data->cmdBufLabelCount +
244 callback_data->queueLabelCount) > 0;
245 const bool log_active = CLOG_CHECK(&LOG, level);
246 if (do_labels && log_active) {
247 VKDebuggingTools &debugging_tools = *reinterpret_cast<VKDebuggingTools *>(user_data);
248 debugging_tools.print_labels(callback_data);
249 }
250 }
251 else {
252 const char *format = "%s: %s";
253 CLOG_AT_LEVEL(&LOG, level, format, callback_data->pMessageIdName, callback_data->pMessage);
254 }
255
256 return VK_FALSE;
257};
258
259void VKDebuggingTools::init_messenger(VkInstance vk_instance)
260{
261 if (!(G.debug & G_DEBUG_GPU)) {
262 return;
263 }
264 if (vk_debug_utils_messenger != VK_NULL_HANDLE) {
265 return;
266 }
267 if (!volk::vkCreateDebugUtilsMessengerEXT) {
268 return;
269 }
270
271 VkDebugUtilsMessengerCreateInfoEXT create_info;
272 create_info.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
273 create_info.pNext = nullptr;
274 create_info.flags = 0;
275 create_info.messageSeverity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT |
276 VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT |
277 VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT |
278 VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT;
279 create_info.messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT |
280 VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT |
281 VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;
282 create_info.pfnUserCallback = messenger_callback;
283 create_info.pUserData = this;
284 volk::vkCreateDebugUtilsMessengerEXT(
285 vk_instance, &create_info, nullptr, &vk_debug_utils_messenger);
286}
287
288void VKDebuggingTools::destroy_messenger(VkInstance vk_instance)
289{
290 if (vk_debug_utils_messenger == VK_NULL_HANDLE) {
291 return;
292 }
293
294 volk::vkDestroyDebugUtilsMessengerEXT(vk_instance, vk_debug_utils_messenger, nullptr);
295 vk_debug_utils_messenger = VK_NULL_HANDLE;
296}
297
298}; // namespace gpu::debug
299
300} // namespace blender
#define CLOG_ERROR(clg_ref,...)
Definition CLG_log.h:188
#define CLOG_CHECK(clg_ref, verbose_level,...)
Definition CLG_log.h:147
void CLG_logref_init(CLG_LogRef *clg_ref)
Definition clog.cc:981
CLG_Level
Definition CLG_log.h:52
@ CLG_LEVEL_ERROR
Definition CLG_log.h:56
@ CLG_LEVEL_INFO
Definition CLG_log.h:60
@ CLG_LEVEL_WARN
Definition CLG_log.h:58
#define CLOG_AT_LEVEL(clg_ref, verbose_level,...)
Definition CLG_log.h:150
#define UNUSED_VARS(...)
constexpr StringRefNull()
int64_t size() const
bool is_empty() const
static ProfileReport & get()
void add_group_cpu(StringRefNull name, uint64_t cpu_start, uint64_t cpu_end)
static VKBackend & get()
bool debug_capture_begin(const char *title)
Definition vk_debug.cc:101
void debug_group_begin(const char *name, int index) override
Definition vk_debug.cc:27
void debug_group_end() override
Definition vk_debug.cc:44
bool debug_capture_scope_begin(void *scope) override
Definition vk_debug.cc:132
void * debug_capture_scope_create(const char *name) override
Definition vk_debug.cc:127
bool debug_capture_begin(const char *title) override
Definition vk_debug.cc:96
const render_graph::VKRenderGraph & render_graph() const
Definition vk_context.hh:81
void debug_capture_end() override
Definition vk_debug.cc:115
void debug_capture_scope_end(void *scope) override
Definition vk_debug.cc:146
VkDevice vk_handle() const
Definition vk_device.hh:338
VkInstance instance_get() const
Definition vk_device.hh:333
void print_labels(const VkDebugUtilsMessengerCallbackDataEXT *callback_data)
Definition vk_debug.cc:190
void init(VkInstance vk_instance)
Definition vk_debug.cc:162
void destroy_messenger(VkInstance vk_instance)
Definition vk_debug.cc:288
void deinit(VkInstance vk_instance)
Definition vk_debug.cc:168
void init_messenger(VkInstance vk_instance)
Definition vk_debug.cc:259
void debug_group_begin(const char *name, const ColorTheme4f &color)
void object_label(GLenum type, GLuint object, const char *name)
Definition gl_debug.cc:331
static VKAPI_ATTR VkBool32 VKAPI_CALL messenger_callback(VkDebugUtilsMessageSeverityFlagBitsEXT message_severity, VkDebugUtilsMessageTypeFlagsEXT message_type, const VkDebugUtilsMessengerCallbackDataEXT *callback_data, void *user_data)
Definition vk_debug.cc:217
const char * to_string(ShaderStage stage)
Definition mtl_shader.mm:52
BMesh Iterators.
unsigned __int64 uint64_t
Definition BKE_text.h:91
Global G
Definition blender.cc:57
unsigned int uint32_t
Definition BKE_text.h:81
_W64 unsigned int uintptr_t
Definition BKE_text.h:120
static CLG_LogRef LOG
Definition logging.cpp:12