e955c94ed3
Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
94 lines
3.4 KiB
C++
94 lines
3.4 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup gpu
|
|
*/
|
|
#pragma once
|
|
|
|
#include "BKE_global.h"
|
|
#include "BLI_set.hh"
|
|
#include "BLI_string.h"
|
|
|
|
#include "vk_common.hh"
|
|
|
|
#include <mutex>
|
|
#include <typeindex>
|
|
|
|
namespace blender::gpu {
|
|
class VKContext;
|
|
class VKDevice;
|
|
|
|
namespace debug {
|
|
class VKDebuggingTools {
|
|
public:
|
|
bool enabled = false;
|
|
VkDebugUtilsMessageSeverityFlagsEXT message_severity =
|
|
VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT |
|
|
VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT |
|
|
VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT |
|
|
VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT;
|
|
/* Function pointer definitions. */
|
|
PFN_vkCreateDebugUtilsMessengerEXT vkCreateDebugUtilsMessengerEXT_r = nullptr;
|
|
PFN_vkDestroyDebugUtilsMessengerEXT vkDestroyDebugUtilsMessengerEXT_r = nullptr;
|
|
PFN_vkSubmitDebugUtilsMessageEXT vkSubmitDebugUtilsMessageEXT_r = nullptr;
|
|
PFN_vkCmdBeginDebugUtilsLabelEXT vkCmdBeginDebugUtilsLabelEXT_r = nullptr;
|
|
PFN_vkCmdEndDebugUtilsLabelEXT vkCmdEndDebugUtilsLabelEXT_r = nullptr;
|
|
PFN_vkCmdInsertDebugUtilsLabelEXT vkCmdInsertDebugUtilsLabelEXT_r = nullptr;
|
|
PFN_vkQueueBeginDebugUtilsLabelEXT vkQueueBeginDebugUtilsLabelEXT_r = nullptr;
|
|
PFN_vkQueueEndDebugUtilsLabelEXT vkQueueEndDebugUtilsLabelEXT_r = nullptr;
|
|
PFN_vkQueueInsertDebugUtilsLabelEXT vkQueueInsertDebugUtilsLabelEXT_r = nullptr;
|
|
PFN_vkSetDebugUtilsObjectNameEXT vkSetDebugUtilsObjectNameEXT_r = nullptr;
|
|
PFN_vkSetDebugUtilsObjectTagEXT vkSetDebugUtilsObjectTagEXT_r = nullptr;
|
|
VKDebuggingTools() = default;
|
|
~VKDebuggingTools();
|
|
void init(VkInstance vk_instance);
|
|
void deinit(VkInstance vk_instance);
|
|
bool is_ignore(int32_t id_number);
|
|
VkResult init_messenger(VkInstance vk_instance);
|
|
void destroy_messenger(VkInstance vk_instance);
|
|
void print_labels(const VkDebugUtilsMessengerCallbackDataEXT *callback_data);
|
|
|
|
private:
|
|
VkDebugUtilsMessengerEXT vk_debug_utils_messenger = nullptr;
|
|
Set<int32_t> vk_message_id_number_ignored;
|
|
std::mutex ignore_mutex;
|
|
void add_group(int32_t id_number);
|
|
void remove_group(int32_t id_number);
|
|
};
|
|
|
|
void object_label(VkObjectType vk_object_type, uint64_t object_handle, const char *name);
|
|
template<typename T> void object_label(T vk_object_type, const char *name)
|
|
{
|
|
if (!(G.debug & G_DEBUG_GPU)) {
|
|
return;
|
|
}
|
|
const size_t label_size = 64;
|
|
char label[label_size];
|
|
memset(label, 0, label_size);
|
|
static int stats = 0;
|
|
SNPRINTF(label, "%s_%d", name, stats++);
|
|
object_label(to_vk_object_type(vk_object_type), (uint64_t)vk_object_type, (const char *)label);
|
|
};
|
|
|
|
void push_marker(VkCommandBuffer vk_command_buffer, const char *name);
|
|
void set_marker(VkCommandBuffer vk_command_buffer, const char *name);
|
|
void pop_marker(VkCommandBuffer vk_command_buffer);
|
|
void push_marker(const VKDevice &device, const char *name);
|
|
void set_marker(const VKDevice &device, const char *name);
|
|
void pop_marker(const VKDevice &device);
|
|
/**
|
|
* How to use:
|
|
* \code{.cc}
|
|
* debug::raise_message(0xB41ca2, VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT,
|
|
* "This is a raise message. %llx", (uintptr_t)vk_object);
|
|
* \endcode
|
|
*/
|
|
void raise_message(int32_t id_number,
|
|
VkDebugUtilsMessageSeverityFlagBitsEXT vk_severity_flag_bits,
|
|
const char *fmt,
|
|
...);
|
|
} // namespace debug
|
|
} // namespace blender::gpu
|