import support of instance debug messages

This commit is contained in:
Greg Wells
2025-05-23 09:45:18 -04:00
parent 4489a530c0
commit 68eb59b6f6
9 changed files with 200 additions and 32 deletions

View File

@@ -4,7 +4,7 @@
struct GLFWwindow;
struct gnPlatformInstance {
typedef struct gnPlatformInstance_t {
NS::View* metalContentView;
MTL::RenderPipelineState* framebufferRenderer, *testSquareRenderer;
};
} gnPlatformInstance;

View File

@@ -0,0 +1,7 @@
#include "vulkan_debugger.h"
void populateDebugMessengerCreateInfo(VkDebugUtilsMessengerCreateInfoEXT* createInfo) {
createInfo->sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
createInfo->messageSeverity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT;
createInfo->messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;
}

View File

@@ -1,6 +1,7 @@
#include "vulkan_debugger.h"
#include "instance/vulkan_instance.h"
#include "iostream"
#include "vector"
#include <math.h>
bool checkValidationLayerSupport(std::vector<std::string> layers_to_validate) {
uint32_t layerCount;
@@ -75,13 +76,6 @@ VkResult vk_createDebugUtilsMessengerEXT(VkInstance instance, const VkDebugUtils
return VK_ERROR_EXTENSION_NOT_PRESENT;
}
void populateDebugMessengerCreateInfo(VkDebugUtilsMessengerCreateInfoEXT& createInfo) {
createInfo = {};
createInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
createInfo.messageSeverity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT;
createInfo.messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;
}
void vk_destroyDebugUtilsMessengerEXT(VkInstance instance, VkDebugUtilsMessengerEXT debugMessenger, const VkAllocationCallbacks* pAllocator) {
PFN_vkDestroyDebugUtilsMessengerEXT vkDestroyDebugUtilsMessengerEXT = (PFN_vkDestroyDebugUtilsMessengerEXT) vkGetInstanceProcAddr(instance, "vkDestroyDebugUtilsMessengerEXT");
if (vkDestroyDebugUtilsMessengerEXT != nullptr) {
@@ -92,30 +86,61 @@ void vk_destroyDebugUtilsMessengerEXT(VkInstance instance, VkDebugUtilsMessenger
GN_EXPORT gnReturnCode gnCreateDebuggerFn(gnDebugger* debugger, gnInstance* instance, const gnDebuggerInfo_t info) {
debugger->debugger = new gnPlatformDebugger();
if (instance->valid == gnFalse) {
printf("Instance message count: %i\n", instance->instance->instanceMessageCount);
for (int i = 0; i < instance->instance->instanceMessageCount; i++) {
info.callback(
instance->instance->instanceMessages[i].severity,
instance->instance->instanceMessages[i].type,
instance->instance->instanceMessages[i].data,
info.userData
);
}
return GN_INVALID_INSTANCE;
} else {
for (int i = 0; i < instance->instance->instanceMessageCount; i++) {
info.callback(
instance->instance->instanceMessages[i].severity,
instance->instance->instanceMessages[i].type,
instance->instance->instanceMessages[i].data,
info.userData
);
}
}
if (!checkValidationLayerSupport({"VK_LAYER_KHRONOS_validation"}))
return GN_FAILED_TO_CREATE_DEBUGGER;
VkDebugUtilsMessengerCreateInfoEXT createInfo;
vk_userData_t* userData = (vk_userData_t*)malloc(sizeof(vk_userData_t));
userData->debuggerCallback = info.callback;
userData->userData = info.userData;
populateDebugMessengerCreateInfo(createInfo);
VkDebugUtilsMessengerCreateInfoEXT createInfo;
createInfo = (VkDebugUtilsMessengerCreateInfoEXT){};
populateDebugMessengerCreateInfo(&createInfo);
createInfo.pUserData = (void*)userData;
createInfo.pfnUserCallback = vk_debuggerDebugCallback;
for (int i = 0; i < instance->instance->instanceMessages.size(); i++) {
VkResult result = vk_createDebugUtilsMessengerEXT(instance->instance->vk_instance, &createInfo, nullptr, &debugger->debugger->debugMessenger);
if (result != VK_SUCCESS) {
gnMessageSeverity severity = GN_MESSAGE_ERROR;
gnMessageType type = GN_DEBUG_MESSAGE_VALIDATION;
gnMessageData data = {
.message = gnCombineStrings(
gnCreateString("Failed to create gnDebuggerObject with api vulkan\n"),
gnCombineStrings(gnCreateString("Returned with a vulkan error code of: "), std::to_string(result).c_str())
)
};
info.callback(
instance->instance->instanceMessages[i].severity,
instance->instance->instanceMessages[i].type,
instance->instance->instanceMessages[i].data,
severity,
type,
data,
info.userData
);
}
if (vk_createDebugUtilsMessengerEXT(instance->instance->vk_instance, &createInfo, nullptr, &debugger->debugger->debugMessenger) != VK_SUCCESS)
return GN_FAILED_TO_CREATE_DEBUGGER;
}
return GN_SUCCESS;
}

View File

@@ -2,9 +2,15 @@
#include <vulkan/vulkan.h>
#include <core/debugger/gryphn_debugger.h>
struct gnPlatformDebugger {
typedef struct gnPlatformDebugger_t {
VkDebugUtilsMessengerEXT debugMessenger;
VkInstance* instance;
};
} gnPlatformDebugger;
void populateDebugMessengerCreateInfo(VkDebugUtilsMessengerCreateInfoEXT& createInfo);
#ifdef __cplusplus
extern "C" {
#endif
void populateDebugMessengerCreateInfo(VkDebugUtilsMessengerCreateInfoEXT* createInfo);
#ifdef __cplusplus
}
#endif

View File

@@ -0,0 +1,126 @@
#include "vulkan_instance.h"
#include <debugger/vulkan_debugger.h>
#include <stdio.h>
static VKAPI_ATTR VkBool32 VKAPI_CALL vk_debuggerDebugCallback(
VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity,
VkDebugUtilsMessageTypeFlagsEXT messageType,
const VkDebugUtilsMessengerCallbackDataEXT* pCallbackData,
void* pUserData) {
gnMessageSeverity severity;
gnMessageType type;
gnMessageData data = {
.message = gnCreateString(pCallbackData->pMessage)
};
switch (messageSeverity) {
default: break;
case VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT: severity = GN_MESSAGE_VERBOSE; break;
case VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT: severity = GN_MESSAGE_INFO; break;
case VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT: severity = GN_MESSAGE_WARNING; break;
case VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT: severity = GN_MESSAGE_ERROR; break;
}
switch (messageType) {
default: break;
case VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT: type = GN_DEBUG_MESSAGE_GENERAL; break;
case VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT: type = GN_DEBUG_MESSAGE_VALIDATION; break;
case VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT: type = GN_DEBUG_MESSAGE_PERFORMANCE; break;
}
gnInstance* instance = (gnInstance*)pUserData;
instance->instance->instanceMessageCount++;
if (instance->instance->instanceMessageCount == 1) {
instance->instance->instanceMessages = malloc(sizeof(struct gnInstanceMessage) * instance->instance->instanceMessageCount);
}
else {
instance->instance->instanceMessages = realloc(instance->instance->instanceMessages, sizeof(struct gnInstanceMessage) * instance->instance->instanceMessageCount);
}
instance->instance->instanceMessages[instance->instance->instanceMessageCount - 1] = (struct gnInstanceMessage){
.data = data,
.severity = severity,
.type = type
};
return VK_FALSE;
}
gnReturnCode gnCreateInstanceFn(gnInstance* instance, gnInstanceInfo instanceInfo) {
instance->instance = malloc(sizeof(gnPlatformInstance));
#ifdef GN_PLATFORM_LINUX
#ifdef GN_WINDOW_X11
uint32_t extensionCount = 3;
const char* extensions[] = {
"VK_KHR_xlib_surface",
"VK_KHR_surface",
VK_EXT_DEBUG_UTILS_EXTENSION_NAME
};
#endif
#ifdef GN_WINFDOW_WAYLAND
uint32_t extensionCount = 3;
const char* extensions[] = {
"VK_KHR_wayland_surface",
"VK_KHR_surface",
VK_EXT_DEBUG_UTILS_EXTENSION_NAME
};
#endif
#endif
#ifdef GN_PLATFORM_WINDOWS
uint32_t extensionCount = 3;
const char* extensions[] = {
"VK_KHR_win32_surface",
"VK_KHR_surface",
VK_EXT_DEBUG_UTILS_EXTENSION_NAME
};
#endif
#ifdef GN_PLATFORM_MACOS
uint32_t extensionCount = 4;
const char* extensions[] = {
"VK_KHR_portability_enumeration",
"VK_EXT_metal_surface",
"VK_KHR_surface",
VK_EXT_DEBUG_UTILS_EXTENSION_NAME
};
#endif
VkApplicationInfo appInfo = {
.sType = VK_STRUCTURE_TYPE_APPLICATION_INFO,
.pApplicationName = gnToCString(instanceInfo.applicationName),
.applicationVersion = instanceInfo.applicationVersion,
.pEngineName = gnToCString(instanceInfo.engineName),
.engineVersion = instanceInfo.engineVersion,
.apiVersion = VK_API_VERSION_1_3,
};
VkInstanceCreateInfo createInfo = {};
createInfo.sType = VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO;
createInfo.pApplicationInfo = &appInfo;
createInfo.flags = VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR;
const char* validation_layers[1] = { "VK_LAYER_KHRONOS_validation" };
createInfo.enabledLayerCount = 1;
createInfo.ppEnabledLayerNames = validation_layers;
VkDebugUtilsMessengerCreateInfoEXT debugCreateInfo = {};
populateDebugMessengerCreateInfo(&debugCreateInfo);
debugCreateInfo.pfnUserCallback = vk_debuggerDebugCallback;
debugCreateInfo.pUserData = instance;
createInfo.pNext = &debugCreateInfo;
createInfo.enabledExtensionCount = extensionCount;
createInfo.ppEnabledExtensionNames = extensions;
VkResult result = vkCreateInstance(&createInfo, NULL, &instance->instance->vk_instance);
if (result != VK_SUCCESS)
return GN_FAILED_CREATE_INSTANCE;
instance->valid = gnTrue;
return GN_SUCCESS;
}
void gnDestroyInstanceFn(gnInstance* instance) {
instance->valid = gnFalse;
vkDestroyInstance(instance->instance->vk_instance, NULL);
}

View File

@@ -1,6 +1,5 @@
#pragma once
#include <vulkan/vulkan.h>
#include "vector"
#include "core/debugger/gryphn_debugger.h"
struct gnInstanceMessage {
@@ -9,11 +8,14 @@ struct gnInstanceMessage {
gnMessageData data;
};
struct gnPlatformInstance {
typedef struct gnPlatformInstance_t {
VkInstance vk_instance;
VkApplicationInfo appInfo;
// VkSurfaceKHR window_surface;
std::vector<const char*> extensions;
std::vector<gnInstanceMessage> instanceMessages;
};
// uint16_t extensionCount;
// const char** extensions;
uint16_t instanceMessageCount;
struct gnInstanceMessage* instanceMessages;
} gnPlatformInstance;

View File

@@ -3,7 +3,7 @@
#include "utils/gryphn_error_code.h"
#include "core/instance/gryphn_instance.h"
struct gnPlatformDebugger;
struct gnPlatformDebugger_t;
typedef enum gnMessageSeverity_e {
GN_MESSAGE_VERBOSE = 0x00000001,
@@ -45,7 +45,7 @@ typedef struct gnDebuggerInfo_t {
} gnDebuggerInfo;
typedef struct gnDebugger_t {
struct gnPlatformDebugger* debugger;
struct gnPlatformDebugger_t* debugger;
gnInstance* instance;
} gnDebugger;

View File

@@ -2,7 +2,7 @@
#include <gryphn/gryphn_utils.h>
#include "core/gryphn_rendering_api.h"
struct gnPlatformInstance;
struct gnPlatformInstance_t;
struct gnFunctions_t;
struct gnDynamicLibrary_t;
@@ -17,7 +17,7 @@ typedef struct gnInstanceInfo_t {
} gnInstanceInfo;
typedef struct gnInstance_t {
struct gnPlatformInstance* instance;
struct gnPlatformInstance_t* instance;
gnBool valid;
struct gnFunctions_t* functions;

View File

@@ -8,7 +8,8 @@ typedef enum gnReturnCode_t {
GN_FAILED_CREATE_INSTANCE,
GN_FAILED_TO_CREATE_DEBUGGER,
GN_FAILED_TO_CREATE_DEVICE,
GN_FAILED_TO_ATTACH_WINDOW
GN_FAILED_TO_ATTACH_WINDOW,
GN_INVALID_INSTANCE
// GN_UNKNOWN_ERROR,
// GN_UNKNOWN_FRAMEBUFFER_ATTACHMENT,
@@ -37,5 +38,6 @@ static const char* gnErrorCodeToCString(enum gnReturnCode_t returnCode) {
case GN_FAILED_CREATE_INSTANCE: return "GN_FAILED_CREATE_INSTANCE";
case GN_FAILED_TO_CREATE_DEBUGGER: return "GN_FAILED_TO_CREATE_DEBUGGER";
case GN_FAILED_TO_CREATE_DEVICE: return "GN_FAILED_TO_CREATE_DEVICE";
case GN_INVALID_INSTANCE: return "GN_INVALID_INSTANCE";
}
}