Mark Young | 6ba8abe | 2017-11-09 10:37:04 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2015-2017 The Khronos Group Inc. |
| 3 | * Copyright (c) 2015-2017 Valve Corporation |
| 4 | * Copyright (c) 2015-2017 LunarG, Inc. |
| 5 | * Copyright (C) 2015-2016 Google Inc. |
| 6 | * |
| 7 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 8 | * you may not use this file except in compliance with the License. |
| 9 | * You may obtain a copy of the License at |
| 10 | * |
| 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | * |
| 13 | * Unless required by applicable law or agreed to in writing, software |
| 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | * See the License for the specific language governing permissions and |
| 17 | * limitations under the License. |
| 18 | * |
| 19 | * Author: Courtney Goeltzenleuchter <courtney@LunarG.com> |
| 20 | * Author: Jon Ashburn <jon@LunarG.com> |
| 21 | * Author: Mark Young <marky@lunarg.com> |
| 22 | * |
| 23 | */ |
| 24 | |
| 25 | #define _GNU_SOURCE |
| 26 | #include <stdio.h> |
| 27 | #include <string.h> |
| 28 | #include <stdlib.h> |
| 29 | #include <inttypes.h> |
| 30 | #ifndef WIN32 |
| 31 | #include <signal.h> |
| 32 | #else |
| 33 | #endif |
| 34 | #include "vk_loader_platform.h" |
| 35 | #include "debug_utils.h" |
| 36 | #include "vulkan/vk_layer.h" |
| 37 | #include "vk_object_types.h" |
| 38 | |
| 39 | // VK_EXT_debug_report related items |
| 40 | |
| 41 | VkResult util_CreateDebugUtilsMessenger(struct loader_instance *inst, const VkDebugUtilsMessengerCreateInfoEXT *pCreateInfo, |
| 42 | const VkAllocationCallbacks *pAllocator, VkDebugUtilsMessengerEXT messenger) { |
| 43 | VkLayerDbgFunctionNode *pNewDbgFuncNode = NULL; |
| 44 | |
| 45 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 46 | { |
| 47 | #else |
| 48 | if (pAllocator != NULL) { |
| 49 | pNewDbgFuncNode = (VkLayerDbgFunctionNode *)pAllocator->pfnAllocation(pAllocator->pUserData, sizeof(VkLayerDbgFunctionNode), |
| 50 | sizeof(int *), VK_SYSTEM_ALLOCATION_SCOPE_OBJECT); |
| 51 | } else { |
| 52 | #endif |
| 53 | pNewDbgFuncNode = (VkLayerDbgFunctionNode *)loader_instance_heap_alloc(inst, sizeof(VkLayerDbgFunctionNode), |
| 54 | VK_SYSTEM_ALLOCATION_SCOPE_OBJECT); |
| 55 | } |
| 56 | if (!pNewDbgFuncNode) { |
| 57 | return VK_ERROR_OUT_OF_HOST_MEMORY; |
| 58 | } |
| 59 | memset(pNewDbgFuncNode, 0, sizeof(VkLayerDbgFunctionNode)); |
| 60 | |
| 61 | pNewDbgFuncNode->is_messenger = true; |
| 62 | pNewDbgFuncNode->messenger.messenger = messenger; |
| 63 | pNewDbgFuncNode->messenger.pfnUserCallback = pCreateInfo->pfnUserCallback; |
| 64 | pNewDbgFuncNode->messenger.messageSeverity = pCreateInfo->messageSeverity; |
| 65 | pNewDbgFuncNode->messenger.messageType = pCreateInfo->messageType; |
| 66 | pNewDbgFuncNode->pUserData = pCreateInfo->pUserData; |
| 67 | pNewDbgFuncNode->pNext = inst->DbgFunctionHead; |
| 68 | inst->DbgFunctionHead = pNewDbgFuncNode; |
| 69 | |
| 70 | return VK_SUCCESS; |
| 71 | } |
| 72 | |
| 73 | static VKAPI_ATTR VkResult VKAPI_CALL |
| 74 | debug_utils_CreateDebugUtilsMessengerEXT(VkInstance instance, const VkDebugUtilsMessengerCreateInfoEXT *pCreateInfo, |
| 75 | const VkAllocationCallbacks *pAllocator, VkDebugUtilsMessengerEXT *pMessenger) { |
| 76 | struct loader_instance *inst = loader_get_instance(instance); |
| 77 | loader_platform_thread_lock_mutex(&loader_lock); |
| 78 | VkResult result = inst->disp->layer_inst_disp.CreateDebugUtilsMessengerEXT(instance, pCreateInfo, pAllocator, pMessenger); |
| 79 | loader_platform_thread_unlock_mutex(&loader_lock); |
| 80 | return result; |
| 81 | } |
| 82 | |
| 83 | VkBool32 util_SubmitDebugUtilsMessageEXT(const struct loader_instance *inst, VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity, |
| 84 | VkDebugUtilsMessageTypeFlagsEXT messageTypes, |
| 85 | const VkDebugUtilsMessengerCallbackDataEXT *pCallbackData) { |
| 86 | VkBool32 bail = false; |
| 87 | |
| 88 | if (NULL != pCallbackData && NULL != pCallbackData->pObjects && 0 < pCallbackData->objectCount) { |
| 89 | VkLayerDbgFunctionNode *pTrav = inst->DbgFunctionHead; |
| 90 | VkDebugReportObjectTypeEXT object_type; |
| 91 | VkDebugReportFlagsEXT object_flags = 0; |
| 92 | uint64_t object_handle; |
| 93 | |
| 94 | debug_utils_AnnotFlagsToReportFlags(messageSeverity, messageTypes, &object_flags); |
| 95 | debug_utils_AnnotObjectToDebugReportObject(pCallbackData->pObjects, &object_type, &object_handle); |
| 96 | |
| 97 | while (pTrav) { |
| 98 | if (pTrav->is_messenger && (pTrav->messenger.messageSeverity & messageSeverity) && |
| 99 | (pTrav->messenger.messageType & messageTypes)) { |
| 100 | if (pTrav->messenger.pfnUserCallback(messageSeverity, messageTypes, pCallbackData, pTrav->pUserData)) { |
| 101 | bail = true; |
| 102 | } |
| 103 | } |
| 104 | if (!pTrav->is_messenger && pTrav->report.msgFlags & object_flags) { |
| 105 | if (pTrav->report.pfnMsgCallback(object_flags, object_type, object_handle, 0, pCallbackData->messageIdNumber, |
| 106 | pCallbackData->pMessageIdName, pCallbackData->pMessage, pTrav->pUserData)) { |
| 107 | bail = true; |
| 108 | } |
| 109 | } |
| 110 | |
| 111 | pTrav = pTrav->pNext; |
| 112 | } |
| 113 | } |
| 114 | |
| 115 | return bail; |
| 116 | } |
| 117 | |
| 118 | void util_DestroyDebugUtilsMessenger(struct loader_instance *inst, VkDebugUtilsMessengerEXT messenger, |
| 119 | const VkAllocationCallbacks *pAllocator) { |
| 120 | VkLayerDbgFunctionNode *pTrav = inst->DbgFunctionHead; |
| 121 | VkLayerDbgFunctionNode *pPrev = pTrav; |
| 122 | |
| 123 | while (pTrav) { |
| 124 | if (pTrav->is_messenger && pTrav->messenger.messenger == messenger) { |
| 125 | pPrev->pNext = pTrav->pNext; |
| 126 | if (inst->DbgFunctionHead == pTrav) inst->DbgFunctionHead = pTrav->pNext; |
| 127 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 128 | { |
| 129 | #else |
| 130 | if (pAllocator != NULL) { |
| 131 | pAllocator->pfnFree(pAllocator->pUserData, pTrav); |
| 132 | } else { |
| 133 | #endif |
| 134 | loader_instance_heap_free(inst, pTrav); |
| 135 | } |
| 136 | break; |
| 137 | } |
| 138 | pPrev = pTrav; |
| 139 | pTrav = pTrav->pNext; |
| 140 | } |
| 141 | } |
| 142 | |
| 143 | // This utility (used by vkInstanceCreateInfo(), looks at a pNext chain. It |
| 144 | // counts any VkDebugUtilsMessengerCreateInfoEXT structs that it finds. It |
| 145 | // then allocates array that can hold that many structs, as well as that many |
| 146 | // VkDebugUtilsMessengerEXT handles. It then copies each |
| 147 | // VkDebugUtilsMessengerCreateInfoEXT, and initializes each handle. |
| 148 | VkResult util_CopyDebugUtilsMessengerCreateInfos(const void *pChain, const VkAllocationCallbacks *pAllocator, |
| 149 | uint32_t *num_messengers, VkDebugUtilsMessengerCreateInfoEXT **infos, |
| 150 | VkDebugUtilsMessengerEXT **messengers) { |
| 151 | uint32_t n = *num_messengers = 0; |
| 152 | VkDebugUtilsMessengerCreateInfoEXT *pInfos = NULL; |
| 153 | VkDebugUtilsMessengerEXT *pMessengers = NULL; |
| 154 | |
| 155 | const void *pNext = pChain; |
| 156 | while (pNext) { |
| 157 | // 1st, count the number VkDebugUtilsMessengerCreateInfoEXT: |
| 158 | if (((VkDebugUtilsMessengerCreateInfoEXT *)pNext)->sType == VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT) { |
| 159 | n++; |
| 160 | } |
| 161 | pNext = (void *)((VkDebugUtilsMessengerCreateInfoEXT *)pNext)->pNext; |
| 162 | } |
| 163 | if (n == 0) { |
| 164 | return VK_SUCCESS; |
| 165 | } |
| 166 | |
| 167 | // 2nd, allocate memory for each VkDebugUtilsMessengerCreateInfoEXT: |
| 168 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 169 | { |
| 170 | #else |
| 171 | if (pAllocator != NULL) { |
| 172 | pInfos = *infos = ((VkDebugUtilsMessengerCreateInfoEXT *)pAllocator->pfnAllocation( |
| 173 | pAllocator->pUserData, n * sizeof(VkDebugUtilsMessengerCreateInfoEXT), sizeof(void *), |
| 174 | VK_SYSTEM_ALLOCATION_SCOPE_OBJECT)); |
| 175 | } else { |
| 176 | #endif |
| 177 | pInfos = *infos = ((VkDebugUtilsMessengerCreateInfoEXT *)malloc(n * sizeof(VkDebugUtilsMessengerCreateInfoEXT))); |
| 178 | } |
| 179 | if (!pInfos) { |
| 180 | return VK_ERROR_OUT_OF_HOST_MEMORY; |
| 181 | } |
| 182 | // 3rd, allocate memory for a unique handle for each callback: |
| 183 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 184 | { |
| 185 | #else |
| 186 | if (pAllocator != NULL) { |
| 187 | pMessengers = *messengers = ((VkDebugUtilsMessengerEXT *)pAllocator->pfnAllocation( |
| 188 | pAllocator->pUserData, n * sizeof(VkDebugUtilsMessengerEXT), sizeof(void *), VK_SYSTEM_ALLOCATION_SCOPE_OBJECT)); |
| 189 | if (NULL == pMessengers) { |
| 190 | pAllocator->pfnFree(pAllocator->pUserData, pInfos); |
| 191 | return VK_ERROR_OUT_OF_HOST_MEMORY; |
| 192 | } |
| 193 | } else { |
| 194 | #endif |
| 195 | pMessengers = *messengers = ((VkDebugUtilsMessengerEXT *)malloc(n * sizeof(VkDebugUtilsMessengerEXT))); |
| 196 | if (NULL == pMessengers) { |
| 197 | free(pInfos); |
| 198 | return VK_ERROR_OUT_OF_HOST_MEMORY; |
| 199 | } |
| 200 | } |
| 201 | // 4th, copy each VkDebugUtilsMessengerCreateInfoEXT for use by |
| 202 | // vkDestroyInstance, and assign a unique handle to each messenger (just |
| 203 | // use the address of the copied VkDebugUtilsMessengerCreateInfoEXT): |
| 204 | pNext = pChain; |
| 205 | while (pNext) { |
| 206 | if (((VkInstanceCreateInfo *)pNext)->sType == VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT) { |
| 207 | memcpy(pInfos, pNext, sizeof(VkDebugUtilsMessengerCreateInfoEXT)); |
| 208 | *pMessengers++ = (VkDebugUtilsMessengerEXT)(uintptr_t)pInfos++; |
| 209 | } |
| 210 | pNext = (void *)((VkInstanceCreateInfo *)pNext)->pNext; |
| 211 | } |
| 212 | |
| 213 | *num_messengers = n; |
| 214 | return VK_SUCCESS; |
| 215 | } |
| 216 | |
| 217 | void util_FreeDebugUtilsMessengerCreateInfos(const VkAllocationCallbacks *pAllocator, VkDebugUtilsMessengerCreateInfoEXT *infos, |
| 218 | VkDebugUtilsMessengerEXT *messengers) { |
| 219 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 220 | { |
| 221 | #else |
| 222 | if (pAllocator != NULL) { |
| 223 | pAllocator->pfnFree(pAllocator->pUserData, infos); |
| 224 | pAllocator->pfnFree(pAllocator->pUserData, messengers); |
| 225 | } else { |
| 226 | #endif |
| 227 | free(infos); |
| 228 | free(messengers); |
| 229 | } |
| 230 | } |
| 231 | |
| 232 | VkResult util_CreateDebugUtilsMessengers(struct loader_instance *inst, const VkAllocationCallbacks *pAllocator, |
| 233 | uint32_t num_messengers, VkDebugUtilsMessengerCreateInfoEXT *infos, |
| 234 | VkDebugUtilsMessengerEXT *messengers) { |
| 235 | VkResult rtn = VK_SUCCESS; |
| 236 | for (uint32_t i = 0; i < num_messengers; i++) { |
| 237 | rtn = util_CreateDebugUtilsMessenger(inst, &infos[i], pAllocator, messengers[i]); |
| 238 | if (rtn != VK_SUCCESS) { |
| 239 | for (uint32_t j = 0; j < i; j++) { |
| 240 | util_DestroyDebugUtilsMessenger(inst, messengers[j], pAllocator); |
| 241 | } |
| 242 | return rtn; |
| 243 | } |
| 244 | } |
| 245 | return rtn; |
| 246 | } |
| 247 | |
| 248 | void util_DestroyDebugUtilsMessengers(struct loader_instance *inst, const VkAllocationCallbacks *pAllocator, |
| 249 | uint32_t num_messengers, VkDebugUtilsMessengerEXT *messengers) { |
| 250 | for (uint32_t i = 0; i < num_messengers; i++) { |
| 251 | util_DestroyDebugUtilsMessenger(inst, messengers[i], pAllocator); |
| 252 | } |
| 253 | } |
| 254 | |
| 255 | static VKAPI_ATTR void VKAPI_CALL debug_utils_SubmitDebugUtilsMessageEXT( |
| 256 | VkInstance instance, VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity, VkDebugUtilsMessageTypeFlagsEXT messageTypes, |
| 257 | const VkDebugUtilsMessengerCallbackDataEXT *pCallbackData) { |
| 258 | struct loader_instance *inst = loader_get_instance(instance); |
| 259 | |
| 260 | inst->disp->layer_inst_disp.SubmitDebugUtilsMessageEXT(instance, messageSeverity, messageTypes, pCallbackData); |
| 261 | } |
| 262 | |
| 263 | static VKAPI_ATTR void VKAPI_CALL debug_utils_DestroyDebugUtilsMessengerEXT(VkInstance instance, VkDebugUtilsMessengerEXT messenger, |
| 264 | const VkAllocationCallbacks *pAllocator) { |
| 265 | struct loader_instance *inst = loader_get_instance(instance); |
| 266 | loader_platform_thread_lock_mutex(&loader_lock); |
| 267 | |
| 268 | inst->disp->layer_inst_disp.DestroyDebugUtilsMessengerEXT(instance, messenger, pAllocator); |
| 269 | |
| 270 | util_DestroyDebugUtilsMessenger(inst, messenger, pAllocator); |
| 271 | |
| 272 | loader_platform_thread_unlock_mutex(&loader_lock); |
| 273 | } |
| 274 | |
| 275 | // This is the instance chain terminator function for CreateDebugUtilsMessenger |
| 276 | VKAPI_ATTR VkResult VKAPI_CALL terminator_CreateDebugUtilsMessengerEXT(VkInstance instance, |
| 277 | const VkDebugUtilsMessengerCreateInfoEXT *pCreateInfo, |
| 278 | const VkAllocationCallbacks *pAllocator, |
| 279 | VkDebugUtilsMessengerEXT *pMessenger) { |
| 280 | VkDebugUtilsMessengerEXT *icd_info = NULL; |
| 281 | const struct loader_icd_term *icd_term; |
| 282 | struct loader_instance *inst = (struct loader_instance *)instance; |
| 283 | VkResult res = VK_SUCCESS; |
| 284 | uint32_t storage_idx; |
| 285 | VkLayerDbgFunctionNode *pNewDbgFuncNode = NULL; |
| 286 | |
| 287 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 288 | { |
| 289 | #else |
| 290 | if (pAllocator != NULL) { |
| 291 | icd_info = ((VkDebugUtilsMessengerEXT *)pAllocator->pfnAllocation(pAllocator->pUserData, |
| 292 | inst->total_icd_count * sizeof(VkDebugUtilsMessengerEXT), |
| 293 | sizeof(void *), VK_SYSTEM_ALLOCATION_SCOPE_OBJECT)); |
| 294 | if (icd_info) { |
| 295 | memset(icd_info, 0, inst->total_icd_count * sizeof(VkDebugUtilsMessengerEXT)); |
| 296 | } |
| 297 | } else { |
| 298 | #endif |
| 299 | icd_info = calloc(sizeof(VkDebugUtilsMessengerEXT), inst->total_icd_count); |
| 300 | } |
| 301 | if (!icd_info) { |
| 302 | res = VK_ERROR_OUT_OF_HOST_MEMORY; |
| 303 | goto out; |
| 304 | } |
| 305 | |
| 306 | storage_idx = 0; |
| 307 | for (icd_term = inst->icd_terms; icd_term; icd_term = icd_term->next) { |
| 308 | if (!icd_term->dispatch.CreateDebugUtilsMessengerEXT) { |
| 309 | continue; |
| 310 | } |
| 311 | |
| 312 | res = icd_term->dispatch.CreateDebugUtilsMessengerEXT(icd_term->instance, pCreateInfo, pAllocator, &icd_info[storage_idx]); |
| 313 | |
| 314 | if (res != VK_SUCCESS) { |
| 315 | goto out; |
| 316 | } |
| 317 | storage_idx++; |
| 318 | } |
| 319 | |
| 320 | // Setup the debug report callback in the terminator since a layer may want |
| 321 | // to grab the information itself (RenderDoc) and then return back to the |
| 322 | // user callback a sub-set of the messages. |
| 323 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 0) |
| 324 | if (pAllocator != NULL) { |
| 325 | pNewDbgFuncNode = (VkLayerDbgFunctionNode *)pAllocator->pfnAllocation(pAllocator->pUserData, sizeof(VkLayerDbgFunctionNode), |
| 326 | sizeof(int *), VK_SYSTEM_ALLOCATION_SCOPE_OBJECT); |
| 327 | } else { |
| 328 | #else |
| 329 | { |
| 330 | #endif |
| 331 | pNewDbgFuncNode = (VkLayerDbgFunctionNode *)loader_instance_heap_alloc(inst, sizeof(VkLayerDbgFunctionNode), |
| 332 | VK_SYSTEM_ALLOCATION_SCOPE_OBJECT); |
| 333 | } |
| 334 | if (!pNewDbgFuncNode) { |
| 335 | res = VK_ERROR_OUT_OF_HOST_MEMORY; |
| 336 | goto out; |
| 337 | } |
| 338 | memset(pNewDbgFuncNode, 0, sizeof(VkLayerDbgFunctionNode)); |
| 339 | |
| 340 | pNewDbgFuncNode->is_messenger = true; |
| 341 | pNewDbgFuncNode->messenger.pfnUserCallback = pCreateInfo->pfnUserCallback; |
| 342 | pNewDbgFuncNode->messenger.messageSeverity = pCreateInfo->messageSeverity; |
| 343 | pNewDbgFuncNode->messenger.messageType = pCreateInfo->messageType; |
| 344 | pNewDbgFuncNode->pUserData = pCreateInfo->pUserData; |
| 345 | pNewDbgFuncNode->pNext = inst->DbgFunctionHead; |
| 346 | inst->DbgFunctionHead = pNewDbgFuncNode; |
| 347 | |
| 348 | *(VkDebugUtilsMessengerEXT **)pMessenger = icd_info; |
| 349 | pNewDbgFuncNode->messenger.messenger = *pMessenger; |
| 350 | |
| 351 | out: |
| 352 | |
| 353 | // Roll back on errors |
| 354 | if (VK_SUCCESS != res) { |
| 355 | storage_idx = 0; |
| 356 | for (icd_term = inst->icd_terms; icd_term; icd_term = icd_term->next) { |
| 357 | if (NULL == icd_term->dispatch.DestroyDebugUtilsMessengerEXT) { |
| 358 | continue; |
| 359 | } |
| 360 | |
| 361 | if (icd_info && icd_info[storage_idx]) { |
| 362 | icd_term->dispatch.DestroyDebugUtilsMessengerEXT(icd_term->instance, icd_info[storage_idx], pAllocator); |
| 363 | } |
| 364 | storage_idx++; |
| 365 | } |
| 366 | |
| 367 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 368 | { |
| 369 | #else |
| 370 | if (pAllocator != NULL) { |
| 371 | if (NULL != pNewDbgFuncNode) { |
| 372 | pAllocator->pfnFree(pAllocator->pUserData, pNewDbgFuncNode); |
| 373 | } |
| 374 | if (NULL != icd_info) { |
| 375 | pAllocator->pfnFree(pAllocator->pUserData, icd_info); |
| 376 | } |
| 377 | } else { |
| 378 | #endif |
| 379 | if (NULL != pNewDbgFuncNode) { |
| 380 | free(pNewDbgFuncNode); |
| 381 | } |
| 382 | if (NULL != icd_info) { |
| 383 | free(icd_info); |
| 384 | } |
| 385 | } |
| 386 | } |
| 387 | |
| 388 | return res; |
| 389 | } |
| 390 | |
| 391 | // This is the instance chain terminator function for DestroyDebugUtilsMessenger |
| 392 | VKAPI_ATTR void VKAPI_CALL terminator_DestroyDebugUtilsMessengerEXT(VkInstance instance, VkDebugUtilsMessengerEXT messenger, |
| 393 | const VkAllocationCallbacks *pAllocator) { |
| 394 | uint32_t storage_idx; |
| 395 | VkDebugUtilsMessengerEXT *icd_info; |
| 396 | const struct loader_icd_term *icd_term; |
| 397 | |
| 398 | struct loader_instance *inst = (struct loader_instance *)instance; |
| 399 | icd_info = *(VkDebugUtilsMessengerEXT **)&messenger; |
| 400 | storage_idx = 0; |
| 401 | for (icd_term = inst->icd_terms; icd_term; icd_term = icd_term->next) { |
| 402 | if (NULL == icd_term->dispatch.DestroyDebugUtilsMessengerEXT) { |
| 403 | continue; |
| 404 | } |
| 405 | |
| 406 | if (icd_info[storage_idx]) { |
| 407 | icd_term->dispatch.DestroyDebugUtilsMessengerEXT(icd_term->instance, icd_info[storage_idx], pAllocator); |
| 408 | } |
| 409 | storage_idx++; |
| 410 | } |
| 411 | |
| 412 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 413 | { |
| 414 | #else |
| 415 | if (pAllocator != NULL) { |
| 416 | pAllocator->pfnFree(pAllocator->pUserData, icd_info); |
| 417 | } else { |
| 418 | #endif |
| 419 | free(icd_info); |
| 420 | } |
| 421 | } |
| 422 | |
| 423 | // This is the instance chain terminator function for SubmitDebugUtilsMessageEXT |
| 424 | VKAPI_ATTR void VKAPI_CALL terminator_SubmitDebugUtilsMessageEXT(VkInstance instance, |
| 425 | VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity, |
| 426 | VkDebugUtilsMessageTypeFlagsEXT messageTypes, |
| 427 | const VkDebugUtilsMessengerCallbackDataEXT *pCallbackData) { |
| 428 | const struct loader_icd_term *icd_term; |
| 429 | |
| 430 | struct loader_instance *inst = (struct loader_instance *)instance; |
| 431 | |
| 432 | loader_platform_thread_lock_mutex(&loader_lock); |
| 433 | for (icd_term = inst->icd_terms; icd_term; icd_term = icd_term->next) { |
| 434 | if (icd_term->dispatch.SubmitDebugUtilsMessageEXT != NULL) { |
| 435 | icd_term->dispatch.SubmitDebugUtilsMessageEXT(icd_term->instance, messageSeverity, messageTypes, pCallbackData); |
| 436 | } |
| 437 | } |
| 438 | |
| 439 | // Now that all ICDs have seen the message, call the necessary callbacks. Ignoring "bail" return value |
| 440 | // as there is nothing to bail from at this point. |
| 441 | |
| 442 | util_SubmitDebugUtilsMessageEXT(inst, messageSeverity, messageTypes, pCallbackData); |
| 443 | |
| 444 | loader_platform_thread_unlock_mutex(&loader_lock); |
| 445 | } |
| 446 | |
| 447 | // VK_EXT_debug_report related items |
| 448 | |
| 449 | VkResult util_CreateDebugReportCallback(struct loader_instance *inst, VkDebugReportCallbackCreateInfoEXT *pCreateInfo, |
| 450 | const VkAllocationCallbacks *pAllocator, VkDebugReportCallbackEXT callback) { |
| 451 | VkLayerDbgFunctionNode *pNewDbgFuncNode = NULL; |
| 452 | |
| 453 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 454 | { |
| 455 | #else |
| 456 | if (pAllocator != NULL) { |
| 457 | pNewDbgFuncNode = (VkLayerDbgFunctionNode *)pAllocator->pfnAllocation(pAllocator->pUserData, sizeof(VkLayerDbgFunctionNode), |
| 458 | sizeof(int *), VK_SYSTEM_ALLOCATION_SCOPE_OBJECT); |
| 459 | } else { |
| 460 | #endif |
| 461 | pNewDbgFuncNode = (VkLayerDbgFunctionNode *)loader_instance_heap_alloc(inst, sizeof(VkLayerDbgFunctionNode), |
| 462 | VK_SYSTEM_ALLOCATION_SCOPE_OBJECT); |
| 463 | } |
| 464 | if (!pNewDbgFuncNode) { |
| 465 | return VK_ERROR_OUT_OF_HOST_MEMORY; |
| 466 | } |
| 467 | memset(pNewDbgFuncNode, 0, sizeof(VkLayerDbgFunctionNode)); |
| 468 | |
| 469 | pNewDbgFuncNode->is_messenger = false; |
| 470 | pNewDbgFuncNode->report.msgCallback = callback; |
| 471 | pNewDbgFuncNode->report.pfnMsgCallback = pCreateInfo->pfnCallback; |
| 472 | pNewDbgFuncNode->report.msgFlags = pCreateInfo->flags; |
| 473 | pNewDbgFuncNode->pUserData = pCreateInfo->pUserData; |
| 474 | pNewDbgFuncNode->pNext = inst->DbgFunctionHead; |
| 475 | inst->DbgFunctionHead = pNewDbgFuncNode; |
| 476 | |
| 477 | return VK_SUCCESS; |
| 478 | } |
| 479 | |
| 480 | static VKAPI_ATTR VkResult VKAPI_CALL |
| 481 | debug_utils_CreateDebugReportCallbackEXT(VkInstance instance, const VkDebugReportCallbackCreateInfoEXT *pCreateInfo, |
| 482 | const VkAllocationCallbacks *pAllocator, VkDebugReportCallbackEXT *pCallback) { |
| 483 | struct loader_instance *inst = loader_get_instance(instance); |
| 484 | loader_platform_thread_lock_mutex(&loader_lock); |
| 485 | VkResult result = inst->disp->layer_inst_disp.CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback); |
| 486 | loader_platform_thread_unlock_mutex(&loader_lock); |
| 487 | return result; |
| 488 | } |
| 489 | |
| 490 | // Utility function to handle reporting |
| 491 | VkBool32 util_DebugReportMessage(const struct loader_instance *inst, VkFlags msgFlags, VkDebugReportObjectTypeEXT objectType, |
| 492 | uint64_t srcObject, size_t location, int32_t msgCode, const char *pLayerPrefix, const char *pMsg) { |
| 493 | VkBool32 bail = false; |
| 494 | VkLayerDbgFunctionNode *pTrav = inst->DbgFunctionHead; |
| 495 | VkDebugUtilsMessageSeverityFlagBitsEXT severity; |
| 496 | VkDebugUtilsMessageTypeFlagsEXT types; |
| 497 | VkDebugUtilsMessengerCallbackDataEXT callback_data; |
| 498 | VkDebugUtilsObjectNameInfoEXT object_name; |
| 499 | |
| 500 | debug_utils_ReportFlagsToAnnotFlags(msgFlags, false, &severity, &types); |
| 501 | debug_utils_ReportObjectToAnnotObject(objectType, srcObject, &object_name); |
| 502 | |
| 503 | callback_data.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CALLBACK_DATA_EXT; |
| 504 | callback_data.pNext = NULL; |
| 505 | callback_data.flags = 0; |
| 506 | callback_data.pMessageIdName = pLayerPrefix; |
| 507 | callback_data.messageIdNumber = msgCode; |
| 508 | callback_data.pMessage = pMsg; |
| 509 | callback_data.cmdBufLabelCount = 0; |
| 510 | callback_data.pCmdBufLabels = NULL; |
| 511 | callback_data.queueLabelCount = 0; |
| 512 | callback_data.pQueueLabels = NULL; |
| 513 | callback_data.objectCount = 1; |
| 514 | callback_data.pObjects = &object_name; |
| 515 | |
| 516 | while (pTrav) { |
| 517 | if (!pTrav->is_messenger && pTrav->report.msgFlags & msgFlags) { |
| 518 | if (pTrav->report.pfnMsgCallback(msgFlags, objectType, srcObject, location, msgCode, pLayerPrefix, pMsg, |
| 519 | pTrav->pUserData)) { |
| 520 | bail = true; |
| 521 | } |
| 522 | } |
| 523 | if (pTrav->is_messenger && (pTrav->messenger.messageSeverity & severity) && (pTrav->messenger.messageType & types)) { |
| 524 | if (pTrav->messenger.pfnUserCallback(severity, types, &callback_data, pTrav->pUserData)) { |
| 525 | bail = true; |
| 526 | } |
| 527 | } |
| 528 | |
| 529 | pTrav = pTrav->pNext; |
| 530 | } |
| 531 | |
| 532 | return bail; |
| 533 | } |
| 534 | |
| 535 | void util_DestroyDebugReportCallback(struct loader_instance *inst, VkDebugReportCallbackEXT callback, |
| 536 | const VkAllocationCallbacks *pAllocator) { |
| 537 | VkLayerDbgFunctionNode *pTrav = inst->DbgFunctionHead; |
| 538 | VkLayerDbgFunctionNode *pPrev = pTrav; |
| 539 | |
| 540 | while (pTrav) { |
| 541 | if (!pTrav->is_messenger && pTrav->report.msgCallback == callback) { |
| 542 | pPrev->pNext = pTrav->pNext; |
| 543 | if (inst->DbgFunctionHead == pTrav) inst->DbgFunctionHead = pTrav->pNext; |
| 544 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 545 | { |
| 546 | #else |
| 547 | if (pAllocator != NULL) { |
| 548 | pAllocator->pfnFree(pAllocator->pUserData, pTrav); |
| 549 | } else { |
| 550 | #endif |
| 551 | loader_instance_heap_free(inst, pTrav); |
| 552 | } |
| 553 | break; |
| 554 | } |
| 555 | pPrev = pTrav; |
| 556 | pTrav = pTrav->pNext; |
| 557 | } |
| 558 | } |
| 559 | |
| 560 | // This utility (used by vkInstanceCreateInfo(), looks at a pNext chain. It |
| 561 | // counts any VkDebugReportCallbackCreateInfoEXT structs that it finds. It |
| 562 | // then allocates array that can hold that many structs, as well as that many |
| 563 | // VkDebugReportCallbackEXT handles. It then copies each |
| 564 | // VkDebugReportCallbackCreateInfoEXT, and initializes each handle. |
| 565 | VkResult util_CopyDebugReportCreateInfos(const void *pChain, const VkAllocationCallbacks *pAllocator, uint32_t *num_callbacks, |
| 566 | VkDebugReportCallbackCreateInfoEXT **infos, VkDebugReportCallbackEXT **callbacks) { |
| 567 | uint32_t n = *num_callbacks = 0; |
| 568 | VkDebugReportCallbackCreateInfoEXT *pInfos = NULL; |
| 569 | VkDebugReportCallbackEXT *pCallbacks = NULL; |
| 570 | |
| 571 | const void *pNext = pChain; |
| 572 | while (pNext) { |
| 573 | // 1st, count the number VkDebugReportCallbackCreateInfoEXT: |
| 574 | if (((VkDebugReportCallbackCreateInfoEXT *)pNext)->sType == VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT) { |
| 575 | n++; |
| 576 | } |
| 577 | pNext = (void *)((VkDebugReportCallbackCreateInfoEXT *)pNext)->pNext; |
| 578 | } |
| 579 | if (n == 0) { |
| 580 | return VK_SUCCESS; |
| 581 | } |
| 582 | |
| 583 | // 2nd, allocate memory for each VkDebugReportCallbackCreateInfoEXT: |
| 584 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 585 | { |
| 586 | #else |
| 587 | if (pAllocator != NULL) { |
| 588 | pInfos = *infos = ((VkDebugReportCallbackCreateInfoEXT *)pAllocator->pfnAllocation( |
| 589 | pAllocator->pUserData, n * sizeof(VkDebugReportCallbackCreateInfoEXT), sizeof(void *), |
| 590 | VK_SYSTEM_ALLOCATION_SCOPE_OBJECT)); |
| 591 | } else { |
| 592 | #endif |
| 593 | pInfos = *infos = ((VkDebugReportCallbackCreateInfoEXT *)malloc(n * sizeof(VkDebugReportCallbackCreateInfoEXT))); |
| 594 | } |
| 595 | if (!pInfos) { |
| 596 | return VK_ERROR_OUT_OF_HOST_MEMORY; |
| 597 | } |
| 598 | // 3rd, allocate memory for a unique handle for each callback: |
| 599 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 600 | { |
| 601 | #else |
| 602 | if (pAllocator != NULL) { |
| 603 | pCallbacks = *callbacks = ((VkDebugReportCallbackEXT *)pAllocator->pfnAllocation( |
| 604 | pAllocator->pUserData, n * sizeof(VkDebugReportCallbackEXT), sizeof(void *), VK_SYSTEM_ALLOCATION_SCOPE_OBJECT)); |
| 605 | if (!pCallbacks) { |
| 606 | pAllocator->pfnFree(pAllocator->pUserData, pInfos); |
| 607 | return VK_ERROR_OUT_OF_HOST_MEMORY; |
| 608 | } |
| 609 | } else { |
| 610 | #endif |
| 611 | pCallbacks = *callbacks = ((VkDebugReportCallbackEXT *)malloc(n * sizeof(VkDebugReportCallbackEXT))); |
| 612 | if (!pCallbacks) { |
| 613 | free(pInfos); |
| 614 | return VK_ERROR_OUT_OF_HOST_MEMORY; |
| 615 | } |
| 616 | } |
| 617 | // 4th, copy each VkDebugReportCallbackCreateInfoEXT for use by |
| 618 | // vkDestroyInstance, and assign a unique handle to each callback (just |
| 619 | // use the address of the copied VkDebugReportCallbackCreateInfoEXT): |
| 620 | pNext = pChain; |
| 621 | while (pNext) { |
| 622 | if (((VkInstanceCreateInfo *)pNext)->sType == VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT) { |
| 623 | memcpy(pInfos, pNext, sizeof(VkDebugReportCallbackCreateInfoEXT)); |
| 624 | *pCallbacks++ = (VkDebugReportCallbackEXT)(uintptr_t)pInfos++; |
| 625 | } |
| 626 | pNext = (void *)((VkInstanceCreateInfo *)pNext)->pNext; |
| 627 | } |
| 628 | |
| 629 | *num_callbacks = n; |
| 630 | return VK_SUCCESS; |
| 631 | } |
| 632 | |
| 633 | void util_FreeDebugReportCreateInfos(const VkAllocationCallbacks *pAllocator, VkDebugReportCallbackCreateInfoEXT *infos, |
| 634 | VkDebugReportCallbackEXT *callbacks) { |
| 635 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 636 | { |
| 637 | #else |
| 638 | if (pAllocator != NULL) { |
| 639 | pAllocator->pfnFree(pAllocator->pUserData, infos); |
| 640 | pAllocator->pfnFree(pAllocator->pUserData, callbacks); |
| 641 | } else { |
| 642 | #endif |
| 643 | free(infos); |
| 644 | free(callbacks); |
| 645 | } |
| 646 | } |
| 647 | |
| 648 | VkResult util_CreateDebugReportCallbacks(struct loader_instance *inst, const VkAllocationCallbacks *pAllocator, |
| 649 | uint32_t num_callbacks, VkDebugReportCallbackCreateInfoEXT *infos, |
| 650 | VkDebugReportCallbackEXT *callbacks) { |
| 651 | VkResult rtn = VK_SUCCESS; |
| 652 | for (uint32_t i = 0; i < num_callbacks; i++) { |
| 653 | rtn = util_CreateDebugReportCallback(inst, &infos[i], pAllocator, callbacks[i]); |
| 654 | if (rtn != VK_SUCCESS) { |
| 655 | for (uint32_t j = 0; j < i; j++) { |
| 656 | util_DestroyDebugReportCallback(inst, callbacks[j], pAllocator); |
| 657 | } |
| 658 | return rtn; |
| 659 | } |
| 660 | } |
| 661 | return rtn; |
| 662 | } |
| 663 | |
| 664 | void util_DestroyDebugReportCallbacks(struct loader_instance *inst, const VkAllocationCallbacks *pAllocator, uint32_t num_callbacks, |
| 665 | VkDebugReportCallbackEXT *callbacks) { |
| 666 | for (uint32_t i = 0; i < num_callbacks; i++) { |
| 667 | util_DestroyDebugReportCallback(inst, callbacks[i], pAllocator); |
| 668 | } |
| 669 | } |
| 670 | |
| 671 | static VKAPI_ATTR void VKAPI_CALL debug_utils_DestroyDebugReportCallbackEXT(VkInstance instance, VkDebugReportCallbackEXT callback, |
| 672 | const VkAllocationCallbacks *pAllocator) { |
| 673 | struct loader_instance *inst = loader_get_instance(instance); |
| 674 | loader_platform_thread_lock_mutex(&loader_lock); |
| 675 | |
| 676 | inst->disp->layer_inst_disp.DestroyDebugReportCallbackEXT(instance, callback, pAllocator); |
| 677 | |
| 678 | util_DestroyDebugReportCallback(inst, callback, pAllocator); |
| 679 | |
| 680 | loader_platform_thread_unlock_mutex(&loader_lock); |
| 681 | } |
| 682 | |
| 683 | static VKAPI_ATTR void VKAPI_CALL debug_utils_DebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags, |
| 684 | VkDebugReportObjectTypeEXT objType, uint64_t object, |
| 685 | size_t location, int32_t msgCode, const char *pLayerPrefix, |
| 686 | const char *pMsg) { |
| 687 | struct loader_instance *inst = loader_get_instance(instance); |
| 688 | |
| 689 | inst->disp->layer_inst_disp.DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix, pMsg); |
| 690 | } |
| 691 | |
| 692 | // This is the instance chain terminator function |
| 693 | // for CreateDebugReportCallback |
| 694 | VKAPI_ATTR VkResult VKAPI_CALL terminator_CreateDebugReportCallbackEXT(VkInstance instance, |
| 695 | const VkDebugReportCallbackCreateInfoEXT *pCreateInfo, |
| 696 | const VkAllocationCallbacks *pAllocator, |
| 697 | VkDebugReportCallbackEXT *pCallback) { |
| 698 | VkDebugReportCallbackEXT *icd_info = NULL; |
| 699 | const struct loader_icd_term *icd_term; |
| 700 | struct loader_instance *inst = (struct loader_instance *)instance; |
| 701 | VkResult res = VK_SUCCESS; |
| 702 | uint32_t storage_idx; |
| 703 | VkLayerDbgFunctionNode *pNewDbgFuncNode = NULL; |
| 704 | |
| 705 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 706 | { |
| 707 | #else |
| 708 | if (pAllocator != NULL) { |
| 709 | icd_info = ((VkDebugReportCallbackEXT *)pAllocator->pfnAllocation(pAllocator->pUserData, |
| 710 | inst->total_icd_count * sizeof(VkDebugReportCallbackEXT), |
| 711 | sizeof(void *), VK_SYSTEM_ALLOCATION_SCOPE_OBJECT)); |
| 712 | if (icd_info) { |
| 713 | memset(icd_info, 0, inst->total_icd_count * sizeof(VkDebugReportCallbackEXT)); |
| 714 | } |
| 715 | } else { |
| 716 | #endif |
| 717 | icd_info = calloc(sizeof(VkDebugReportCallbackEXT), inst->total_icd_count); |
| 718 | } |
| 719 | if (!icd_info) { |
| 720 | res = VK_ERROR_OUT_OF_HOST_MEMORY; |
| 721 | goto out; |
| 722 | } |
| 723 | |
| 724 | storage_idx = 0; |
| 725 | for (icd_term = inst->icd_terms; icd_term; icd_term = icd_term->next) { |
| 726 | if (!icd_term->dispatch.CreateDebugReportCallbackEXT) { |
| 727 | continue; |
| 728 | } |
| 729 | |
| 730 | res = icd_term->dispatch.CreateDebugReportCallbackEXT(icd_term->instance, pCreateInfo, pAllocator, &icd_info[storage_idx]); |
| 731 | |
| 732 | if (res != VK_SUCCESS) { |
| 733 | goto out; |
| 734 | } |
| 735 | storage_idx++; |
| 736 | } |
| 737 | |
| 738 | // Setup the debug report callback in the terminator since a layer may want |
| 739 | // to grab the information itself (RenderDoc) and then return back to the |
| 740 | // user callback a sub-set of the messages. |
| 741 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 0) |
| 742 | if (pAllocator != NULL) { |
| 743 | pNewDbgFuncNode = (VkLayerDbgFunctionNode *)pAllocator->pfnAllocation(pAllocator->pUserData, sizeof(VkLayerDbgFunctionNode), |
| 744 | sizeof(int *), VK_SYSTEM_ALLOCATION_SCOPE_OBJECT); |
| 745 | } else { |
| 746 | #else |
| 747 | { |
| 748 | #endif |
| 749 | pNewDbgFuncNode = (VkLayerDbgFunctionNode *)loader_instance_heap_alloc(inst, sizeof(VkLayerDbgFunctionNode), |
| 750 | VK_SYSTEM_ALLOCATION_SCOPE_OBJECT); |
| 751 | } |
| 752 | if (!pNewDbgFuncNode) { |
| 753 | res = VK_ERROR_OUT_OF_HOST_MEMORY; |
| 754 | goto out; |
| 755 | } |
| 756 | memset(pNewDbgFuncNode, 0, sizeof(VkLayerDbgFunctionNode)); |
| 757 | |
| 758 | pNewDbgFuncNode->is_messenger = false; |
| 759 | pNewDbgFuncNode->report.pfnMsgCallback = pCreateInfo->pfnCallback; |
| 760 | pNewDbgFuncNode->report.msgFlags = pCreateInfo->flags; |
| 761 | pNewDbgFuncNode->pUserData = pCreateInfo->pUserData; |
| 762 | pNewDbgFuncNode->pNext = inst->DbgFunctionHead; |
| 763 | inst->DbgFunctionHead = pNewDbgFuncNode; |
| 764 | |
| 765 | *(VkDebugReportCallbackEXT **)pCallback = icd_info; |
| 766 | pNewDbgFuncNode->report.msgCallback = *pCallback; |
| 767 | |
| 768 | out: |
| 769 | |
| 770 | // Roll back on errors |
| 771 | if (VK_SUCCESS != res) { |
| 772 | storage_idx = 0; |
| 773 | for (icd_term = inst->icd_terms; icd_term; icd_term = icd_term->next) { |
| 774 | if (NULL == icd_term->dispatch.DestroyDebugReportCallbackEXT) { |
| 775 | continue; |
| 776 | } |
| 777 | |
| 778 | if (icd_info && icd_info[storage_idx]) { |
| 779 | icd_term->dispatch.DestroyDebugReportCallbackEXT(icd_term->instance, icd_info[storage_idx], pAllocator); |
| 780 | } |
| 781 | storage_idx++; |
| 782 | } |
| 783 | |
| 784 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 785 | { |
| 786 | #else |
| 787 | if (pAllocator != NULL) { |
| 788 | if (NULL != pNewDbgFuncNode) { |
| 789 | pAllocator->pfnFree(pAllocator->pUserData, pNewDbgFuncNode); |
| 790 | } |
| 791 | if (NULL != icd_info) { |
| 792 | pAllocator->pfnFree(pAllocator->pUserData, icd_info); |
| 793 | } |
| 794 | } else { |
| 795 | #endif |
| 796 | if (NULL != pNewDbgFuncNode) { |
| 797 | free(pNewDbgFuncNode); |
| 798 | } |
| 799 | if (NULL != icd_info) { |
| 800 | free(icd_info); |
| 801 | } |
| 802 | } |
| 803 | } |
| 804 | |
| 805 | return res; |
| 806 | } |
| 807 | |
| 808 | // This is the instance chain terminator function for DestroyDebugReportCallback |
| 809 | VKAPI_ATTR void VKAPI_CALL terminator_DestroyDebugReportCallbackEXT(VkInstance instance, VkDebugReportCallbackEXT callback, |
| 810 | const VkAllocationCallbacks *pAllocator) { |
| 811 | uint32_t storage_idx; |
| 812 | VkDebugReportCallbackEXT *icd_info; |
| 813 | const struct loader_icd_term *icd_term; |
| 814 | |
| 815 | struct loader_instance *inst = (struct loader_instance *)instance; |
| 816 | icd_info = *(VkDebugReportCallbackEXT **)&callback; |
| 817 | storage_idx = 0; |
| 818 | for (icd_term = inst->icd_terms; icd_term; icd_term = icd_term->next) { |
| 819 | if (NULL == icd_term->dispatch.DestroyDebugReportCallbackEXT) { |
| 820 | continue; |
| 821 | } |
| 822 | |
| 823 | if (icd_info[storage_idx]) { |
| 824 | icd_term->dispatch.DestroyDebugReportCallbackEXT(icd_term->instance, icd_info[storage_idx], pAllocator); |
| 825 | } |
| 826 | storage_idx++; |
| 827 | } |
| 828 | |
| 829 | #if (DEBUG_DISABLE_APP_ALLOCATORS == 1) |
| 830 | { |
| 831 | #else |
| 832 | if (pAllocator != NULL) { |
| 833 | pAllocator->pfnFree(pAllocator->pUserData, icd_info); |
| 834 | } else { |
| 835 | #endif |
| 836 | free(icd_info); |
| 837 | } |
| 838 | } |
| 839 | |
| 840 | // This is the instance chain terminator function for DebugReportMessage |
| 841 | VKAPI_ATTR void VKAPI_CALL terminator_DebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags, |
| 842 | VkDebugReportObjectTypeEXT objType, uint64_t object, size_t location, |
| 843 | int32_t msgCode, const char *pLayerPrefix, const char *pMsg) { |
| 844 | const struct loader_icd_term *icd_term; |
| 845 | |
| 846 | struct loader_instance *inst = (struct loader_instance *)instance; |
| 847 | |
| 848 | loader_platform_thread_lock_mutex(&loader_lock); |
| 849 | for (icd_term = inst->icd_terms; icd_term; icd_term = icd_term->next) { |
| 850 | if (icd_term->dispatch.DebugReportMessageEXT != NULL) { |
| 851 | icd_term->dispatch.DebugReportMessageEXT(icd_term->instance, flags, objType, object, location, msgCode, pLayerPrefix, |
| 852 | pMsg); |
| 853 | } |
| 854 | } |
| 855 | |
| 856 | // Now that all ICDs have seen the message, call the necessary callbacks. Ignoring "bail" return value |
| 857 | // as there is nothing to bail from at this point. |
| 858 | |
| 859 | util_DebugReportMessage(inst, flags, objType, object, location, msgCode, pLayerPrefix, pMsg); |
| 860 | |
| 861 | loader_platform_thread_unlock_mutex(&loader_lock); |
| 862 | } |
| 863 | |
| 864 | // General utilities |
| 865 | |
| 866 | static const VkExtensionProperties debug_utils_extension_info[] = { |
| 867 | {VK_EXT_DEBUG_REPORT_EXTENSION_NAME, VK_EXT_DEBUG_REPORT_SPEC_VERSION}, |
| 868 | {VK_EXT_DEBUG_UTILS_EXTENSION_NAME, VK_EXT_DEBUG_UTILS_SPEC_VERSION}, |
| 869 | }; |
| 870 | |
| 871 | void debug_utils_AddInstanceExtensions(const struct loader_instance *inst, struct loader_extension_list *ext_list) { |
| 872 | loader_add_to_ext_list(inst, ext_list, sizeof(debug_utils_extension_info) / sizeof(VkExtensionProperties), |
| 873 | debug_utils_extension_info); |
| 874 | } |
| 875 | |
| 876 | void debug_utils_CreateInstance(struct loader_instance *ptr_instance, const VkInstanceCreateInfo *pCreateInfo) { |
| 877 | ptr_instance->enabled_known_extensions.ext_debug_report = 0; |
| 878 | ptr_instance->enabled_known_extensions.ext_debug_utils = 0; |
| 879 | |
| 880 | for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) { |
| 881 | if (strcmp(pCreateInfo->ppEnabledExtensionNames[i], VK_EXT_DEBUG_REPORT_EXTENSION_NAME) == 0) { |
| 882 | ptr_instance->enabled_known_extensions.ext_debug_report = 1; |
| 883 | } else if (strcmp(pCreateInfo->ppEnabledExtensionNames[i], VK_EXT_DEBUG_UTILS_EXTENSION_NAME) == 0) { |
| 884 | ptr_instance->enabled_known_extensions.ext_debug_utils = 1; |
| 885 | } |
| 886 | } |
| 887 | } |
| 888 | |
| 889 | bool debug_utils_InstanceGpa(struct loader_instance *ptr_instance, const char *name, void **addr) { |
| 890 | bool ret_type = false; |
| 891 | |
| 892 | *addr = NULL; |
| 893 | |
Lenny Komow | dbc866a | 2018-02-22 11:54:18 -0700 | [diff] [blame] | 894 | if (!strcmp("vkCreateDebugReportCallbackEXT", name)) { |
| 895 | *addr = ptr_instance->enabled_known_extensions.ext_debug_report == 1 ? (void *)debug_utils_CreateDebugReportCallbackEXT : NULL; |
| 896 | ret_type = true; |
| 897 | } else if (!strcmp("vkDestroyDebugReportCallbackEXT", name)) { |
| 898 | *addr = ptr_instance->enabled_known_extensions.ext_debug_report == 1 ? (void *)debug_utils_DestroyDebugReportCallbackEXT : NULL; |
| 899 | ret_type = true; |
| 900 | } else if (!strcmp("vkDebugReportMessageEXT", name)) { |
| 901 | *addr = ptr_instance->enabled_known_extensions.ext_debug_report == 1 ? (void *)debug_utils_DebugReportMessageEXT : NULL; |
| 902 | return true; |
Mark Young | 6ba8abe | 2017-11-09 10:37:04 -0700 | [diff] [blame] | 903 | } |
Lenny Komow | dbc866a | 2018-02-22 11:54:18 -0700 | [diff] [blame] | 904 | if (!strcmp("vkCreateDebugUtilsMessengerEXT", name)) { |
| 905 | *addr = ptr_instance->enabled_known_extensions.ext_debug_utils == 1 ? (void *)debug_utils_CreateDebugUtilsMessengerEXT : NULL; |
| 906 | ret_type = true; |
| 907 | } else if (!strcmp("vkDestroyDebugUtilsMessengerEXT", name)) { |
| 908 | *addr = ptr_instance->enabled_known_extensions.ext_debug_utils == 1 ? (void *)debug_utils_DestroyDebugUtilsMessengerEXT : NULL; |
| 909 | ret_type = true; |
| 910 | } else if (!strcmp("vkSubmitDebugUtilsMessageEXT", name)) { |
| 911 | *addr = ptr_instance->enabled_known_extensions.ext_debug_utils == 1 ? (void *)debug_utils_SubmitDebugUtilsMessageEXT : NULL; |
| 912 | ret_type = true; |
Mark Young | 6ba8abe | 2017-11-09 10:37:04 -0700 | [diff] [blame] | 913 | } |
| 914 | |
| 915 | return ret_type; |
| 916 | } |
| 917 | |
| 918 | bool debug_utils_ReportFlagsToAnnotFlags(VkDebugReportFlagsEXT dr_flags, bool default_flag_is_spec, |
| 919 | VkDebugUtilsMessageSeverityFlagBitsEXT *da_severity, |
| 920 | VkDebugUtilsMessageTypeFlagsEXT *da_type) { |
| 921 | bool type_set = false; |
| 922 | if (NULL == da_severity || NULL == da_type) { |
| 923 | return false; |
| 924 | } |
| 925 | *da_type = 0; |
| 926 | |
| 927 | if ((dr_flags & VK_DEBUG_REPORT_INFORMATION_BIT_EXT) != 0) { |
| 928 | *da_severity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT; |
| 929 | *da_type |= VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT; |
| 930 | type_set = true; |
| 931 | } else if ((dr_flags & (VK_DEBUG_REPORT_WARNING_BIT_EXT | VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT)) != 0) { |
| 932 | *da_severity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT; |
| 933 | } else if ((dr_flags & VK_DEBUG_REPORT_ERROR_BIT_EXT) != 0) { |
| 934 | *da_severity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT; |
| 935 | } else if ((dr_flags & VK_DEBUG_REPORT_DEBUG_BIT_EXT) != 0) { |
| 936 | *da_severity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT; |
| 937 | *da_type |= VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT; |
| 938 | type_set = true; |
| 939 | } |
| 940 | |
| 941 | if ((dr_flags & VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT) != 0) { |
| 942 | *da_type |= VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT; |
| 943 | } else if (!type_set) { |
| 944 | if (default_flag_is_spec) { |
| 945 | *da_type |= VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT; |
| 946 | } else { |
| 947 | *da_type |= VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT; |
| 948 | } |
| 949 | } |
| 950 | |
| 951 | return true; |
| 952 | } |
| 953 | |
| 954 | bool debug_utils_AnnotFlagsToReportFlags(VkDebugUtilsMessageSeverityFlagBitsEXT da_severity, |
| 955 | VkDebugUtilsMessageTypeFlagsEXT da_type, VkDebugReportFlagsEXT *dr_flags) { |
| 956 | if (NULL == dr_flags) { |
| 957 | return false; |
| 958 | } |
| 959 | |
| 960 | *dr_flags = 0; |
| 961 | |
| 962 | if ((da_severity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT) != 0) { |
| 963 | *dr_flags |= VK_DEBUG_REPORT_ERROR_BIT_EXT; |
| 964 | } else if ((da_severity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT) != 0) { |
| 965 | if ((da_type & VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT) != 0) { |
| 966 | *dr_flags |= VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT; |
| 967 | } else { |
| 968 | *dr_flags |= VK_DEBUG_REPORT_WARNING_BIT_EXT; |
| 969 | } |
| 970 | } else if ((da_severity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT) != 0) { |
| 971 | *dr_flags |= VK_DEBUG_REPORT_INFORMATION_BIT_EXT; |
| 972 | } else if ((da_severity & VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT) != 0) { |
| 973 | *dr_flags |= VK_DEBUG_REPORT_DEBUG_BIT_EXT; |
| 974 | } |
| 975 | |
| 976 | return true; |
| 977 | } |
| 978 | |
| 979 | bool debug_utils_ReportObjectToAnnotObject(VkDebugReportObjectTypeEXT dr_object_type, uint64_t object_handle, |
| 980 | VkDebugUtilsObjectNameInfoEXT *da_object_name_info) { |
| 981 | if (NULL == da_object_name_info) { |
| 982 | return false; |
| 983 | } |
| 984 | da_object_name_info->sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT; |
| 985 | da_object_name_info->pNext = NULL; |
| 986 | da_object_name_info->objectHandle = (uint64_t)(uintptr_t)object_handle; |
| 987 | da_object_name_info->pObjectName = NULL; |
| 988 | da_object_name_info->objectType = convertDebugReportObjectToCoreObject(dr_object_type); |
| 989 | return true; |
| 990 | } |
| 991 | |
| 992 | bool debug_utils_AnnotObjectToDebugReportObject(const VkDebugUtilsObjectNameInfoEXT *da_object_name_info, |
| 993 | VkDebugReportObjectTypeEXT *dr_object_type, uint64_t *dr_object_handle) { |
| 994 | if (NULL == da_object_name_info || NULL == dr_object_type || NULL == dr_object_handle) { |
| 995 | return false; |
| 996 | } |
| 997 | *dr_object_type = convertCoreObjectToDebugReportObject(da_object_name_info->objectType); |
| 998 | *dr_object_handle = da_object_name_info->objectHandle; |
| 999 | return true; |
| 1000 | } |