1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/*
* Copyright 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef LIBVULKAN_DEBUG_REPORT_H
#define LIBVULKAN_DEBUG_REPORT_H 1
#include <stdarg.h>
#include <shared_mutex>
#include <vulkan/vulkan.h>
namespace vulkan {
namespace driver {
// clang-format off
VKAPI_ATTR VkResult CreateDebugReportCallbackEXT(VkInstance instance, const VkDebugReportCallbackCreateInfoEXT* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkDebugReportCallbackEXT* pCallback);
VKAPI_ATTR void DestroyDebugReportCallbackEXT(VkInstance instance, VkDebugReportCallbackEXT callback, const VkAllocationCallbacks* pAllocator);
VKAPI_ATTR void DebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objectType, uint64_t object, size_t location, int32_t messageCode, const char* pLayerPrefix, const char* pMessage);
// clang-format on
class DebugReportCallbackList {
private:
// forward declaration
struct Node;
public:
DebugReportCallbackList()
: head_{nullptr, 0, nullptr, nullptr, VK_NULL_HANDLE} {}
DebugReportCallbackList(const DebugReportCallbackList&) = delete;
DebugReportCallbackList& operator=(const DebugReportCallbackList&) = delete;
~DebugReportCallbackList() = default;
Node* AddCallback(const VkDebugReportCallbackCreateInfoEXT& info,
VkDebugReportCallbackEXT driver_handle,
const VkAllocationCallbacks& allocator);
void RemoveCallback(Node* node, const VkAllocationCallbacks& allocator);
void Message(VkDebugReportFlagsEXT flags,
VkDebugReportObjectTypeEXT object_type,
uint64_t object,
size_t location,
int32_t message_code,
const char* layer_prefix,
const char* message) const;
static Node* FromHandle(VkDebugReportCallbackEXT handle) {
return reinterpret_cast<Node*>(uintptr_t(handle));
}
static VkDebugReportCallbackEXT GetHandle(const Node* node) {
return VkDebugReportCallbackEXT(reinterpret_cast<uintptr_t>(node));
}
static VkDebugReportCallbackEXT GetDriverHandle(const Node* node) {
return node->driver_handle;
}
private:
struct Node {
Node* next;
VkDebugReportFlagsEXT flags;
PFN_vkDebugReportCallbackEXT callback;
void* user_data;
VkDebugReportCallbackEXT driver_handle;
};
// TODO(b/143295577): use std::shared_mutex when available in libc++
mutable std::shared_timed_mutex rwmutex_;
Node head_;
};
class DebugReportLogger {
public:
explicit DebugReportLogger(const VkInstanceCreateInfo& info)
: instance_pnext_(info.pNext), callbacks_(nullptr) {}
explicit DebugReportLogger(const DebugReportCallbackList& callbacks)
: instance_pnext_(nullptr), callbacks_(&callbacks) {}
void Message(VkDebugReportFlagsEXT flags,
VkDebugReportObjectTypeEXT object_type,
uint64_t object,
size_t location,
int32_t message_code,
const char* layer_prefix,
const char* message) const;
#define DEBUG_REPORT_LOGGER_PRINTF(fmt, args) \
__attribute__((format(printf, (fmt) + 1, (args) + 1)))
template <typename ObjectType>
void Info(ObjectType object, const char* format, ...) const
DEBUG_REPORT_LOGGER_PRINTF(2, 3) {
va_list ap;
va_start(ap, format);
PrintV(VK_DEBUG_REPORT_INFORMATION_BIT_EXT, GetObjectType(object),
GetObjectUInt64(object), format, ap);
va_end(ap);
}
template <typename ObjectType>
void Warn(ObjectType object, const char* format, ...) const
DEBUG_REPORT_LOGGER_PRINTF(2, 3) {
va_list ap;
va_start(ap, format);
PrintV(VK_DEBUG_REPORT_WARNING_BIT_EXT, GetObjectType(object),
GetObjectUInt64(object), format, ap);
va_end(ap);
}
template <typename ObjectType>
void Err(ObjectType object, const char* format, ...) const
DEBUG_REPORT_LOGGER_PRINTF(2, 3) {
va_list ap;
va_start(ap, format);
PrintV(VK_DEBUG_REPORT_ERROR_BIT_EXT, GetObjectType(object),
GetObjectUInt64(object), format, ap);
va_end(ap);
}
private:
template <typename ObjectType>
static VkDebugReportObjectTypeEXT GetObjectType(ObjectType) {
if (std::is_same<ObjectType, VkInstance>::value)
return VK_DEBUG_REPORT_OBJECT_TYPE_INSTANCE_EXT;
else if (std::is_same<ObjectType, VkPhysicalDevice>::value)
return VK_DEBUG_REPORT_OBJECT_TYPE_PHYSICAL_DEVICE_EXT;
else if (std::is_same<ObjectType, VkDevice>::value)
return VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT;
else
return VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
}
template <typename ObjectType>
static uint64_t GetObjectUInt64(ObjectType object) {
return uint64_t(object);
}
#define DEBUG_REPORT_LOGGER_VPRINTF(fmt) \
__attribute__((format(printf, (fmt) + 1, 0)))
void PrintV(VkDebugReportFlagsEXT flags,
VkDebugReportObjectTypeEXT object_type,
uint64_t object,
const char* format,
va_list ap) const DEBUG_REPORT_LOGGER_VPRINTF(4);
const void* const instance_pnext_;
const DebugReportCallbackList* const callbacks_;
};
} // namespace driver
} // namespace vulkan
#endif // LIBVULKAN_DEBUG_REPORT_H
|
