anv: implementation of VK_EXT_debug_report extension

Patch adds required functionality for extension to manage a list of
application provided callbacks and handle debug reporting from driver
and application side.

v2: remove useless helper anv_debug_report_call
    add locking around callbacks list
    use vk_alloc2, vk_free2
    refactor CreateDebugReportCallbackEXT
    fix bugs found with crucible testing

v3: provide ANV_FROM_HANDLE and use it
    misc fixes for issues Jason found
    use vk_find_struct_const for finding ctor_cb

Signed-off-by: Tapani Pälli <tapani.palli@intel.com>
Reviewed-by: Jason Ekstrand <jason@jlekstrand.net>
This commit is contained in:
Tapani Pälli
2017-08-23 11:25:57 +03:00
parent ab6f874439
commit 086cfa5652
5 changed files with 180 additions and 0 deletions

View File

@@ -205,6 +205,7 @@ VULKAN_FILES := \
vulkan/anv_batch_chain.c \
vulkan/anv_blorp.c \
vulkan/anv_cmd_buffer.c \
vulkan/anv_debug_report.c \
vulkan/anv_descriptor_set.c \
vulkan/anv_device.c \
vulkan/anv_dump.c \

View File

@@ -0,0 +1,119 @@
/*
* Copyright © 2017 Intel Corporation
*
* 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 (including the next
* paragraph) 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.
*/
#include "anv_private.h"
#include "vk_util.h"
/* This file contains implementation for VK_EXT_debug_report. */
VkResult
anv_CreateDebugReportCallbackEXT(VkInstance _instance,
const VkDebugReportCallbackCreateInfoEXT* pCreateInfo,
const VkAllocationCallbacks* pAllocator,
VkDebugReportCallbackEXT* pCallback)
{
ANV_FROM_HANDLE(anv_instance, instance, _instance);
struct anv_debug_report_callback *cb =
vk_alloc2(&instance->alloc, pAllocator,
sizeof(struct anv_debug_report_callback), 8,
VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
if (!cb)
return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY);
cb->flags = pCreateInfo->flags;
cb->callback = pCreateInfo->pfnCallback;
cb->data = pCreateInfo->pUserData;
pthread_mutex_lock(&instance->callbacks_mutex);
list_addtail(&cb->link, &instance->callbacks);
pthread_mutex_unlock(&instance->callbacks_mutex);
*pCallback = anv_debug_report_callback_to_handle(cb);
return VK_SUCCESS;
}
void
anv_DestroyDebugReportCallbackEXT(VkInstance _instance,
VkDebugReportCallbackEXT _callback,
const VkAllocationCallbacks* pAllocator)
{
ANV_FROM_HANDLE(anv_instance, instance, _instance);
ANV_FROM_HANDLE(anv_debug_report_callback, callback, _callback);
/* Remove from list and destroy given callback. */
pthread_mutex_lock(&instance->callbacks_mutex);
list_del(&callback->link);
vk_free2(&instance->alloc, pAllocator, callback);
pthread_mutex_unlock(&instance->callbacks_mutex);
}
void
anv_DebugReportMessageEXT(VkInstance _instance,
VkDebugReportFlagsEXT flags,
VkDebugReportObjectTypeEXT objectType,
uint64_t object,
size_t location,
int32_t messageCode,
const char* pLayerPrefix,
const char* pMessage)
{
ANV_FROM_HANDLE(anv_instance, instance, _instance);
anv_debug_report(instance, flags, objectType, object,
location, messageCode, pLayerPrefix, pMessage);
}
void
anv_debug_report(struct anv_instance *instance,
VkDebugReportFlagsEXT flags,
VkDebugReportObjectTypeEXT object_type,
uint64_t handle,
size_t location,
int32_t messageCode,
const char* pLayerPrefix,
const char *pMessage)
{
/* Allow NULL for convinience, return if no callbacks registered. */
if (!instance || list_empty(&instance->callbacks))
return;
pthread_mutex_lock(&instance->callbacks_mutex);
/* Section 33.2 of the Vulkan 1.0.59 spec says:
*
* "callback is an externally synchronized object and must not be
* used on more than one thread at a time. This means that
* vkDestroyDebugReportCallbackEXT must not be called when a callback
* is active."
*/
list_for_each_entry(struct anv_debug_report_callback, cb,
&instance->callbacks, link) {
if (cb->flags & flags)
cb->callback(flags, object_type, handle, location, messageCode,
pLayerPrefix, pMessage, cb->data);
}
pthread_mutex_unlock(&instance->callbacks_mutex);
}

View File

@@ -446,6 +446,13 @@ VkResult anv_CreateInstance(
assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO);
/* Check if user passed a debug report callback to be used during
* Create/Destroy of instance.
*/
const VkDebugReportCallbackCreateInfoEXT *ctor_cb =
vk_find_struct_const(pCreateInfo->pNext,
DEBUG_REPORT_CALLBACK_CREATE_INFO_EXT);
uint32_t client_version;
if (pCreateInfo->pApplicationInfo &&
pCreateInfo->pApplicationInfo->apiVersion != 0) {
@@ -456,6 +463,17 @@ VkResult anv_CreateInstance(
if (VK_MAKE_VERSION(1, 0, 0) > client_version ||
client_version > VK_MAKE_VERSION(1, 0, 0xfff)) {
if (ctor_cb && ctor_cb->flags & VK_DEBUG_REPORT_ERROR_BIT_EXT)
ctor_cb->pfnCallback(VK_DEBUG_REPORT_ERROR_BIT_EXT,
VK_DEBUG_REPORT_OBJECT_TYPE_INSTANCE_EXT,
VK_NULL_HANDLE, /* No handle available yet. */
__LINE__,
0,
"anv",
"incompatible driver version",
ctor_cb->pUserData);
return vk_errorf(VK_ERROR_INCOMPATIBLE_DRIVER,
"Client requested version %d.%d.%d",
VK_VERSION_MAJOR(client_version),
@@ -484,6 +502,20 @@ VkResult anv_CreateInstance(
instance->apiVersion = client_version;
instance->physicalDeviceCount = -1;
if (pthread_mutex_init(&instance->callbacks_mutex, NULL) != 0) {
vk_free2(&default_alloc, pAllocator, instance);
return vk_error(VK_ERROR_INITIALIZATION_FAILED);
}
list_inithead(&instance->callbacks);
/* Store report debug callback to be used during DestroyInstance. */
if (ctor_cb) {
instance->destroy_debug_cb.flags = ctor_cb->flags;
instance->destroy_debug_cb.callback = ctor_cb->pfnCallback;
instance->destroy_debug_cb.data = ctor_cb->pUserData;
}
_mesa_locale_init();
VG(VALGRIND_CREATE_MEMPOOL(instance, 0, false));
@@ -510,6 +542,8 @@ void anv_DestroyInstance(
VG(VALGRIND_DESTROY_MEMPOOL(instance));
pthread_mutex_destroy(&instance->callbacks_mutex);
_mesa_locale_fini();
vk_free(&instance->alloc, instance);

View File

@@ -75,6 +75,7 @@ EXTENSIONS = [
Extension('VK_KHR_xcb_surface', 6, 'VK_USE_PLATFORM_XCB_KHR'),
Extension('VK_KHR_xlib_surface', 6, 'VK_USE_PLATFORM_XLIB_KHR'),
Extension('VK_KHX_multiview', 1, True),
Extension('VK_EXT_debug_report', 8, True),
]
class VkVersion:

View File

@@ -61,6 +61,8 @@ typedef uint32_t xcb_window_t;
struct anv_buffer;
struct anv_buffer_view;
struct anv_image_view;
struct anv_instance;
struct anv_debug_report_callback;
struct gen_l3_config;
@@ -237,6 +239,15 @@ void __anv_perf_warn(const char *file, int line, const char *format, ...)
void anv_loge(const char *format, ...) anv_printflike(1, 2);
void anv_loge_v(const char *format, va_list va);
void anv_debug_report(struct anv_instance *instance,
VkDebugReportFlagsEXT flags,
VkDebugReportObjectTypeEXT object_type,
uint64_t handle,
size_t location,
int32_t messageCode,
const char* pLayerPrefix,
const char *pMessage);
/**
* Print a FINISHME message, including its source location.
*/
@@ -666,6 +677,14 @@ struct anv_physical_device {
int local_fd;
};
struct anv_debug_report_callback {
/* Link in the 'callbacks' list in anv_instance struct. */
struct list_head link;
VkDebugReportFlagsEXT flags;
PFN_vkDebugReportCallbackEXT callback;
void * data;
};
struct anv_instance {
VK_LOADER_DATA _loader_data;
@@ -674,6 +693,11 @@ struct anv_instance {
uint32_t apiVersion;
int physicalDeviceCount;
struct anv_physical_device physicalDevice;
/* VK_EXT_debug_report debug callbacks */
pthread_mutex_t callbacks_mutex;
struct list_head callbacks;
struct anv_debug_report_callback destroy_debug_cb;
};
VkResult anv_init_wsi(struct anv_physical_device *physical_device);
@@ -2493,6 +2517,7 @@ ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_render_pass, VkRenderPass)
ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_sampler, VkSampler)
ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_semaphore, VkSemaphore)
ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_shader_module, VkShaderModule)
ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_debug_report_callback, VkDebugReportCallbackEXT)
/* Gen-specific function declarations */
#ifdef genX