262 lines
10 KiB
C++
262 lines
10 KiB
C++
|
/*
|
||
|
|
* Vulkan examples debug wrapper
|
||
|
|
*
|
||
|
|
* Copyright (C) by Sascha Willems - www.saschawillems.de
|
||
|
|
*
|
||
|
|
* This code is licensed under the MIT license (MIT) (http://opensource.org/licenses/MIT)
|
||
|
|
*/
|
||
|
|
|
||
|
|
#include "VulkanDebug.h"
|
||
|
|
#include <iostream>
|
||
|
|
|
||
|
|
namespace vks
|
||
|
|
{
|
||
|
|
namespace debug
|
||
|
|
{
|
||
|
|
PFN_vkCreateDebugUtilsMessengerEXT vkCreateDebugUtilsMessengerEXT;
|
||
|
|
PFN_vkDestroyDebugUtilsMessengerEXT vkDestroyDebugUtilsMessengerEXT;
|
||
|
|
VkDebugUtilsMessengerEXT debugUtilsMessenger;
|
||
|
|
|
||
|
|
VKAPI_ATTR VkBool32 VKAPI_CALL debugUtilsMessengerCallback(
|
||
|
|
VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity,
|
||
|
|
VkDebugUtilsMessageTypeFlagsEXT messageType,
|
||
|
|
const VkDebugUtilsMessengerCallbackDataEXT* pCallbackData,
|
||
|
|
void* pUserData)
|
||
|
|
{
|
||
|
|
// Select prefix depending on flags passed to the callback
|
||
|
|
std::string prefix("");
|
||
|
|
|
||
|
|
if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT) {
|
||
|
|
prefix = "VERBOSE: ";
|
||
|
|
}
|
||
|
|
else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT) {
|
||
|
|
prefix = "INFO: ";
|
||
|
|
}
|
||
|
|
else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT) {
|
||
|
|
prefix = "WARNING: ";
|
||
|
|
}
|
||
|
|
else if (messageSeverity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT) {
|
||
|
|
prefix = "ERROR: ";
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// Display message to default output (console/logcat)
|
||
|
|
std::stringstream debugMessage;
|
||
|
|
debugMessage << prefix << "[" << pCallbackData->messageIdNumber << "][" << pCallbackData->pMessageIdName << "] : " << pCallbackData->pMessage;
|
||
|
|
|
||
|
|
#if defined(__ANDROID__)
|
||
|
|
if (messageSeverity >= VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT) {
|
||
|
|
LOGE("%s", debugMessage.str().c_str());
|
||
|
|
} else {
|
||
|
|
LOGD("%s", debugMessage.str().c_str());
|
||
|
|
}
|
||
|
|
#else
|
||
|
|
if (messageSeverity >= VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT) {
|
||
|
|
std::cerr << debugMessage.str() << "\n";
|
||
|
|
} else {
|
||
|
|
std::cout << debugMessage.str() << "\n";
|
||
|
|
}
|
||
|
|
fflush(stdout);
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
// The return value of this callback controls whether the Vulkan call that caused the validation message will be aborted or not
|
||
|
|
// We return VK_FALSE as we DON'T want Vulkan calls that cause a validation message to abort
|
||
|
|
// If you instead want to have calls abort, pass in VK_TRUE and the function will return VK_ERROR_VALIDATION_FAILED_EXT
|
||
|
|
return VK_FALSE;
|
||
|
|
}
|
||
|
|
|
||
|
|
void setupDebugging(VkInstance instance)
|
||
|
|
{
|
||
|
|
|
||
|
|
vkCreateDebugUtilsMessengerEXT = reinterpret_cast<PFN_vkCreateDebugUtilsMessengerEXT>(vkGetInstanceProcAddr(instance, "vkCreateDebugUtilsMessengerEXT"));
|
||
|
|
vkDestroyDebugUtilsMessengerEXT = reinterpret_cast<PFN_vkDestroyDebugUtilsMessengerEXT>(vkGetInstanceProcAddr(instance, "vkDestroyDebugUtilsMessengerEXT"));
|
||
|
|
|
||
|
|
VkDebugUtilsMessengerCreateInfoEXT debugUtilsMessengerCI{};
|
||
|
|
debugUtilsMessengerCI.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
|
||
|
|
debugUtilsMessengerCI.messageSeverity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT;
|
||
|
|
debugUtilsMessengerCI.messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT;
|
||
|
|
debugUtilsMessengerCI.pfnUserCallback = debugUtilsMessengerCallback;
|
||
|
|
VkResult result = vkCreateDebugUtilsMessengerEXT(instance, &debugUtilsMessengerCI, nullptr, &debugUtilsMessenger);
|
||
|
|
assert(result == VK_SUCCESS);
|
||
|
|
}
|
||
|
|
|
||
|
|
void freeDebugCallback(VkInstance instance)
|
||
|
|
{
|
||
|
|
if (debugUtilsMessenger != VK_NULL_HANDLE)
|
||
|
|
{
|
||
|
|
vkDestroyDebugUtilsMessengerEXT(instance, debugUtilsMessenger, nullptr);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
namespace debugmarker
|
||
|
|
{
|
||
|
|
bool active = false;
|
||
|
|
|
||
|
|
PFN_vkDebugMarkerSetObjectTagEXT pfnDebugMarkerSetObjectTag = VK_NULL_HANDLE;
|
||
|
|
PFN_vkDebugMarkerSetObjectNameEXT pfnDebugMarkerSetObjectName = VK_NULL_HANDLE;
|
||
|
|
PFN_vkCmdDebugMarkerBeginEXT pfnCmdDebugMarkerBegin = VK_NULL_HANDLE;
|
||
|
|
PFN_vkCmdDebugMarkerEndEXT pfnCmdDebugMarkerEnd = VK_NULL_HANDLE;
|
||
|
|
PFN_vkCmdDebugMarkerInsertEXT pfnCmdDebugMarkerInsert = VK_NULL_HANDLE;
|
||
|
|
|
||
|
|
void setup(VkDevice device)
|
||
|
|
{
|
||
|
|
pfnDebugMarkerSetObjectTag = reinterpret_cast<PFN_vkDebugMarkerSetObjectTagEXT>(vkGetDeviceProcAddr(device, "vkDebugMarkerSetObjectTagEXT"));
|
||
|
|
pfnDebugMarkerSetObjectName = reinterpret_cast<PFN_vkDebugMarkerSetObjectNameEXT>(vkGetDeviceProcAddr(device, "vkDebugMarkerSetObjectNameEXT"));
|
||
|
|
pfnCmdDebugMarkerBegin = reinterpret_cast<PFN_vkCmdDebugMarkerBeginEXT>(vkGetDeviceProcAddr(device, "vkCmdDebugMarkerBeginEXT"));
|
||
|
|
pfnCmdDebugMarkerEnd = reinterpret_cast<PFN_vkCmdDebugMarkerEndEXT>(vkGetDeviceProcAddr(device, "vkCmdDebugMarkerEndEXT"));
|
||
|
|
pfnCmdDebugMarkerInsert = reinterpret_cast<PFN_vkCmdDebugMarkerInsertEXT>(vkGetDeviceProcAddr(device, "vkCmdDebugMarkerInsertEXT"));
|
||
|
|
|
||
|
|
// Set flag if at least one function pointer is present
|
||
|
|
active = (pfnDebugMarkerSetObjectName != VK_NULL_HANDLE);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setObjectName(VkDevice device, uint64_t object, VkDebugReportObjectTypeEXT objectType, const char *name)
|
||
|
|
{
|
||
|
|
// Check for valid function pointer (may not be present if not running in a debugging application)
|
||
|
|
if (pfnDebugMarkerSetObjectName)
|
||
|
|
{
|
||
|
|
VkDebugMarkerObjectNameInfoEXT nameInfo = {};
|
||
|
|
nameInfo.sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT;
|
||
|
|
nameInfo.objectType = objectType;
|
||
|
|
nameInfo.object = object;
|
||
|
|
nameInfo.pObjectName = name;
|
||
|
|
pfnDebugMarkerSetObjectName(device, &nameInfo);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
void setObjectTag(VkDevice device, uint64_t object, VkDebugReportObjectTypeEXT objectType, uint64_t name, size_t tagSize, const void* tag)
|
||
|
|
{
|
||
|
|
// Check for valid function pointer (may not be present if not running in a debugging application)
|
||
|
|
if (pfnDebugMarkerSetObjectTag)
|
||
|
|
{
|
||
|
|
VkDebugMarkerObjectTagInfoEXT tagInfo = {};
|
||
|
|
tagInfo.sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_TAG_INFO_EXT;
|
||
|
|
tagInfo.objectType = objectType;
|
||
|
|
tagInfo.object = object;
|
||
|
|
tagInfo.tagName = name;
|
||
|
|
tagInfo.tagSize = tagSize;
|
||
|
|
tagInfo.pTag = tag;
|
||
|
|
pfnDebugMarkerSetObjectTag(device, &tagInfo);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
void beginRegion(VkCommandBuffer cmdbuffer, const char* pMarkerName, glm::vec4 color)
|
||
|
|
{
|
||
|
|
// Check for valid function pointer (may not be present if not running in a debugging application)
|
||
|
|
if (pfnCmdDebugMarkerBegin)
|
||
|
|
{
|
||
|
|
VkDebugMarkerMarkerInfoEXT markerInfo = {};
|
||
|
|
markerInfo.sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT;
|
||
|
|
memcpy(markerInfo.color, &color[0], sizeof(float) * 4);
|
||
|
|
markerInfo.pMarkerName = pMarkerName;
|
||
|
|
pfnCmdDebugMarkerBegin(cmdbuffer, &markerInfo);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
void insert(VkCommandBuffer cmdbuffer, std::string markerName, glm::vec4 color)
|
||
|
|
{
|
||
|
|
// Check for valid function pointer (may not be present if not running in a debugging application)
|
||
|
|
if (pfnCmdDebugMarkerInsert)
|
||
|
|
{
|
||
|
|
VkDebugMarkerMarkerInfoEXT markerInfo = {};
|
||
|
|
markerInfo.sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT;
|
||
|
|
memcpy(markerInfo.color, &color[0], sizeof(float) * 4);
|
||
|
|
markerInfo.pMarkerName = markerName.c_str();
|
||
|
|
pfnCmdDebugMarkerInsert(cmdbuffer, &markerInfo);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
void endRegion(VkCommandBuffer cmdBuffer)
|
||
|
|
{
|
||
|
|
// Check for valid function (may not be present if not running in a debugging application)
|
||
|
|
if (pfnCmdDebugMarkerEnd)
|
||
|
|
{
|
||
|
|
pfnCmdDebugMarkerEnd(cmdBuffer);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
void setCommandBufferName(VkDevice device, VkCommandBuffer cmdBuffer, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)cmdBuffer, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setQueueName(VkDevice device, VkQueue queue, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)queue, VK_DEBUG_REPORT_OBJECT_TYPE_QUEUE_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setImageName(VkDevice device, VkImage image, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)image, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setSamplerName(VkDevice device, VkSampler sampler, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)sampler, VK_DEBUG_REPORT_OBJECT_TYPE_SAMPLER_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setBufferName(VkDevice device, VkBuffer buffer, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)buffer, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setDeviceMemoryName(VkDevice device, VkDeviceMemory memory, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)memory, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setShaderModuleName(VkDevice device, VkShaderModule shaderModule, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)shaderModule, VK_DEBUG_REPORT_OBJECT_TYPE_SHADER_MODULE_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setPipelineName(VkDevice device, VkPipeline pipeline, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)pipeline, VK_DEBUG_REPORT_OBJECT_TYPE_PIPELINE_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setPipelineLayoutName(VkDevice device, VkPipelineLayout pipelineLayout, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)pipelineLayout, VK_DEBUG_REPORT_OBJECT_TYPE_PIPELINE_LAYOUT_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setRenderPassName(VkDevice device, VkRenderPass renderPass, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)renderPass, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setFramebufferName(VkDevice device, VkFramebuffer framebuffer, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)framebuffer, VK_DEBUG_REPORT_OBJECT_TYPE_FRAMEBUFFER_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setDescriptorSetLayoutName(VkDevice device, VkDescriptorSetLayout descriptorSetLayout, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)descriptorSetLayout, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setDescriptorSetName(VkDevice device, VkDescriptorSet descriptorSet, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)descriptorSet, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setSemaphoreName(VkDevice device, VkSemaphore semaphore, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)semaphore, VK_DEBUG_REPORT_OBJECT_TYPE_SEMAPHORE_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setFenceName(VkDevice device, VkFence fence, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)fence, VK_DEBUG_REPORT_OBJECT_TYPE_FENCE_EXT, name);
|
||
|
|
}
|
||
|
|
|
||
|
|
void setEventName(VkDevice device, VkEvent _event, const char * name)
|
||
|
|
{
|
||
|
|
setObjectName(device, (uint64_t)_event, VK_DEBUG_REPORT_OBJECT_TYPE_EVENT_EXT, name);
|
||
|
|
}
|
||
|
|
};
|
||
|
|
}
|
||
|
|
|