| /* |
| * |
| * Copyright (C) 2015 Valve Corporation |
| * Copyright (C) 2015 Google Inc. |
| * |
| * Permission is hereby granted, free of charge, to any person obtaining a |
| * copy of this software and associated documentation files (the "Software"), |
| * to deal in the Software without restriction, including without limitation |
| * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| * and/or sell copies of the Software, and to permit persons to whom the |
| * Software is furnished to do so, subject to the following conditions: |
| * |
| * The above copyright notice and this permission notice shall be included |
| * in all copies or substantial portions of the Software. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| * DEALINGS IN THE SOFTWARE. |
| * |
| * Author: Courtney Goeltzenleuchter <courtney@LunarG.com> |
| * |
| */ |
| |
| #define _GNU_SOURCE |
| #include <stdio.h> |
| #include <string.h> |
| #include <stdlib.h> |
| #include <inttypes.h> |
| #ifndef WIN32 |
| #include <signal.h> |
| #else |
| #endif |
| #include "vk_loader_platform.h" |
| #include "debug_report.h" |
| #include "vulkan/vk_layer.h" |
| |
| typedef void (VKAPI_PTR *PFN_stringCallback)(char *message); |
| |
| static const VkExtensionProperties debug_report_extension_info = { |
| .extensionName = VK_EXT_DEBUG_REPORT_EXTENSION_NAME, |
| .specVersion = VK_EXT_DEBUG_REPORT_REVISION, |
| }; |
| |
| void debug_report_add_instance_extensions( |
| const struct loader_instance *inst, |
| struct loader_extension_list *ext_list) |
| { |
| loader_add_to_ext_list(inst, ext_list, 1, &debug_report_extension_info); |
| } |
| |
| void debug_report_create_instance( |
| struct loader_instance *ptr_instance, |
| const VkInstanceCreateInfo *pCreateInfo) |
| { |
| ptr_instance->debug_report_enabled = false; |
| |
| for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) { |
| if (strcmp(pCreateInfo->ppEnabledExtensionNames[i], VK_EXT_DEBUG_REPORT_EXTENSION_NAME) == 0) { |
| ptr_instance->debug_report_enabled = true; |
| return; |
| } |
| } |
| } |
| |
| VkResult util_CreateDebugReportCallback( |
| struct loader_instance *inst, |
| VkDebugReportCallbackCreateInfoEXT *pCreateInfo, |
| const VkAllocationCallbacks *pAllocator, |
| VkDebugReportCallbackEXT callback) |
| { |
| VkLayerDbgFunctionNode *pNewDbgFuncNode; |
| if (pAllocator != NULL) { |
| pNewDbgFuncNode = (VkLayerDbgFunctionNode *) pAllocator->pfnAllocation(pAllocator->pUserData, sizeof(VkLayerDbgFunctionNode), sizeof(int *), VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE); |
| } else { |
| pNewDbgFuncNode = (VkLayerDbgFunctionNode *) loader_heap_alloc(inst, sizeof(VkLayerDbgFunctionNode), VK_SYSTEM_ALLOCATION_SCOPE_OBJECT); |
| } |
| if (!pNewDbgFuncNode) |
| return VK_ERROR_OUT_OF_HOST_MEMORY; |
| |
| pNewDbgFuncNode->msgCallback = callback; |
| pNewDbgFuncNode->pfnMsgCallback = pCreateInfo->pfnCallback; |
| pNewDbgFuncNode->msgFlags = pCreateInfo->flags; |
| pNewDbgFuncNode->pUserData = pCreateInfo->pUserData; |
| pNewDbgFuncNode->pNext = inst->DbgFunctionHead; |
| inst->DbgFunctionHead = pNewDbgFuncNode; |
| |
| return VK_SUCCESS; |
| } |
| |
| static VKAPI_ATTR VkResult VKAPI_CALL debug_report_CreateDebugReportCallback( |
| VkInstance instance, |
| VkDebugReportCallbackCreateInfoEXT *pCreateInfo, |
| VkAllocationCallbacks *pAllocator, |
| VkDebugReportCallbackEXT* pCallback) |
| { |
| struct loader_instance *inst = loader_get_instance(instance); |
| loader_platform_thread_lock_mutex(&loader_lock); |
| VkResult result = inst->disp->CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback); |
| if (result == VK_SUCCESS) { |
| result = util_CreateDebugReportCallback(inst, pCreateInfo, pAllocator, *pCallback); |
| } |
| loader_platform_thread_unlock_mutex(&loader_lock); |
| return result; |
| } |
| |
| // Utility function to handle reporting |
| VkBool32 util_DebugReportMessage( |
| const struct loader_instance* inst, |
| VkFlags msgFlags, |
| VkDebugReportObjectTypeEXT objectType, |
| uint64_t srcObject, |
| size_t location, |
| int32_t msgCode, |
| const char* pLayerPrefix, |
| const char* pMsg) |
| { |
| VkBool32 bail = false; |
| VkLayerDbgFunctionNode *pTrav = inst->DbgFunctionHead; |
| while (pTrav) { |
| if (pTrav->msgFlags & msgFlags) { |
| if (pTrav->pfnMsgCallback(msgFlags, |
| objectType, srcObject, |
| location, |
| msgCode, |
| pLayerPrefix, |
| pMsg, |
| pTrav->pUserData)) { |
| bail = true; |
| } |
| } |
| pTrav = pTrav->pNext; |
| } |
| |
| return bail; |
| } |
| |
| void util_DestroyDebugReportCallback( |
| struct loader_instance *inst, |
| VkDebugReportCallbackEXT callback, |
| const VkAllocationCallbacks *pAllocator) |
| { |
| VkLayerDbgFunctionNode *pTrav = inst->DbgFunctionHead; |
| VkLayerDbgFunctionNode *pPrev = pTrav; |
| |
| while (pTrav) { |
| if (pTrav->msgCallback == callback) { |
| pPrev->pNext = pTrav->pNext; |
| if (inst->DbgFunctionHead == pTrav) |
| inst->DbgFunctionHead = pTrav->pNext; |
| if (pAllocator != NULL) { |
| pAllocator->pfnFree(pAllocator->pUserData, pTrav); |
| } else { |
| loader_heap_free(inst, pTrav); |
| } |
| break; |
| } |
| pPrev = pTrav; |
| pTrav = pTrav->pNext; |
| } |
| } |
| |
| static VKAPI_ATTR void VKAPI_CALL debug_report_DestroyDebugReportCallback( |
| VkInstance instance, |
| VkDebugReportCallbackEXT callback, |
| VkAllocationCallbacks *pAllocator) |
| { |
| struct loader_instance *inst = loader_get_instance(instance); |
| loader_platform_thread_lock_mutex(&loader_lock); |
| |
| inst->disp->DestroyDebugReportCallbackEXT(instance, callback, pAllocator); |
| |
| util_DestroyDebugReportCallback(inst, callback, pAllocator); |
| |
| loader_platform_thread_unlock_mutex(&loader_lock); |
| } |
| |
| static VKAPI_ATTR void VKAPI_CALL debug_report_DebugReportMessage( |
| VkInstance instance, |
| VkDebugReportFlagsEXT flags, |
| VkDebugReportObjectTypeEXT objType, |
| uint64_t object, |
| size_t location, |
| int32_t msgCode, |
| const char* pLayerPrefix, |
| const char* pMsg) |
| { |
| struct loader_instance *inst = loader_get_instance(instance); |
| |
| inst->disp->DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix, pMsg); |
| |
| } |
| |
| /* |
| * This is the instance chain terminator function |
| * for CreateDebugReportCallback |
| */ |
| |
| VKAPI_ATTR VkResult VKAPI_CALL loader_CreateDebugReportCallback( |
| VkInstance instance, |
| const VkDebugReportCallbackCreateInfoEXT *pCreateInfo, |
| const VkAllocationCallbacks *pAllocator, |
| VkDebugReportCallbackEXT *pCallback) |
| { |
| VkDebugReportCallbackEXT *icd_info; |
| const struct loader_icd *icd; |
| struct loader_instance *inst = (struct loader_instance *) instance; |
| VkResult res; |
| uint32_t storage_idx; |
| |
| icd_info = calloc(sizeof(VkDebugReportCallbackEXT), inst->total_icd_count); |
| if (!icd_info) { |
| return VK_ERROR_OUT_OF_HOST_MEMORY; |
| } |
| |
| storage_idx = 0; |
| for (icd = inst->icds; icd; icd = icd->next) { |
| if (!icd->CreateDebugReportCallbackEXT) { |
| continue; |
| } |
| |
| res = icd->CreateDebugReportCallbackEXT( |
| icd->instance, |
| pCreateInfo, |
| pAllocator, |
| &icd_info[storage_idx]); |
| |
| if (res != VK_SUCCESS) { |
| break; |
| } |
| storage_idx++; |
| } |
| |
| /* roll back on errors */ |
| if (icd) { |
| storage_idx = 0; |
| for (icd = inst->icds; icd; icd = icd->next) { |
| if (icd_info[storage_idx]) { |
| icd->DestroyDebugReportCallbackEXT( |
| icd->instance, |
| icd_info[storage_idx], |
| pAllocator); |
| } |
| storage_idx++; |
| } |
| |
| return res; |
| } |
| |
| *(VkDebugReportCallbackEXT **)pCallback = icd_info; |
| |
| return VK_SUCCESS; |
| } |
| |
| /* |
| * This is the instance chain terminator function |
| * for DestroyDebugReportCallback |
| */ |
| VKAPI_ATTR void loader_DestroyDebugReportCallback(VkInstance instance, |
| VkDebugReportCallbackEXT callback, const VkAllocationCallbacks *pAllocator) |
| { |
| uint32_t storage_idx; |
| VkDebugReportCallbackEXT *icd_info; |
| const struct loader_icd *icd; |
| |
| struct loader_instance *inst = (struct loader_instance *) instance; |
| icd_info = *(VkDebugReportCallbackEXT **) &callback; |
| storage_idx = 0; |
| for (icd = inst->icds; icd; icd = icd->next) { |
| if (icd_info[storage_idx]) { |
| icd->DestroyDebugReportCallbackEXT( |
| icd->instance, |
| icd_info[storage_idx], |
| pAllocator); |
| } |
| storage_idx++; |
| } |
| } |
| |
| |
| /* |
| * This is the instance chain terminator function |
| * for DebugReportMessage |
| */ |
| VKAPI_ATTR void VKAPI_CALL loader_DebugReportMessage( |
| VkInstance instance, |
| VkDebugReportFlagsEXT flags, |
| VkDebugReportObjectTypeEXT objType, |
| uint64_t object, |
| size_t location, |
| int32_t msgCode, |
| const char* pLayerPrefix, |
| const char* pMsg) |
| { |
| const struct loader_icd *icd; |
| |
| |
| struct loader_instance *inst = (struct loader_instance *) instance; |
| |
| loader_platform_thread_lock_mutex(&loader_lock); |
| for (icd = inst->icds; icd; icd = icd->next) { |
| if (icd->DebugReportMessageEXT != NULL) { |
| icd->DebugReportMessageEXT(icd->instance, flags, objType, object, location, msgCode, pLayerPrefix, pMsg); |
| } |
| } |
| |
| /* |
| * Now that all ICDs have seen the message, call the necessary callbacks. |
| * Ignoring "bail" return value as there is nothing to bail from at this point. |
| */ |
| |
| util_DebugReportMessage(inst, flags, objType, object, location, msgCode, pLayerPrefix, pMsg); |
| |
| loader_platform_thread_unlock_mutex(&loader_lock); |
| } |
| |
| bool debug_report_instance_gpa( |
| struct loader_instance *ptr_instance, |
| const char* name, |
| void **addr) |
| { |
| // debug_report is currently advertised to be supported by the loader, |
| // so always return the entry points if name matches and it's enabled |
| *addr = NULL; |
| |
| if (!strcmp("vkCreateDebugReportCallbackEXT", name)) { |
| *addr = ptr_instance->debug_report_enabled ? (void *) debug_report_CreateDebugReportCallback : NULL; |
| return true; |
| } |
| if (!strcmp("vkDestroyDebugReportCallbackEXT", name)) { |
| *addr = ptr_instance->debug_report_enabled ? (void *) debug_report_DestroyDebugReportCallback : NULL; |
| return true; |
| } |
| if (!strcmp("vkDebugReportMessageEXT", name)) { |
| *addr = ptr_instance->debug_report_enabled ? (void *) debug_report_DebugReportMessage : NULL; |
| return true; |
| } |
| return false; |
| } |