1 /* Copyright (c) 2015-2016, 2020 The Khronos Group Inc.
2 * Copyright (c) 2015-2016, 2020 Valve Corporation
3 * Copyright (c) 2015-2016, 2020 LunarG, Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 * Author: Mark Lobodzinski <mark@lunarg.com>
18 * Author: Dave Houlton <daveh@lunarg.com>
19 *
20 */
21
22 #include "vk_layer_utils.h"
23
24 #include <string.h>
25 #include <string>
26 #include <map>
27 #include <vector>
28
29 #include "vulkan/vulkan.h"
30 #include "vk_layer_config.h"
31
32 static const uint8_t UTF8_ONE_BYTE_CODE = 0xC0;
33 static const uint8_t UTF8_ONE_BYTE_MASK = 0xE0;
34 static const uint8_t UTF8_TWO_BYTE_CODE = 0xE0;
35 static const uint8_t UTF8_TWO_BYTE_MASK = 0xF0;
36 static const uint8_t UTF8_THREE_BYTE_CODE = 0xF0;
37 static const uint8_t UTF8_THREE_BYTE_MASK = 0xF8;
38 static const uint8_t UTF8_DATA_BYTE_CODE = 0x80;
39 static const uint8_t UTF8_DATA_BYTE_MASK = 0xC0;
40
vk_string_validate(const int max_length,const char * utf8)41 VK_LAYER_EXPORT VkStringErrorFlags vk_string_validate(const int max_length, const char *utf8) {
42 VkStringErrorFlags result = VK_STRING_ERROR_NONE;
43 int num_char_bytes = 0;
44 int i, j;
45
46 for (i = 0; i <= max_length; i++) {
47 if (utf8[i] == 0) {
48 break;
49 } else if (i == max_length) {
50 result |= VK_STRING_ERROR_LENGTH;
51 break;
52 } else if ((utf8[i] >= 0xa) && (utf8[i] < 0x7f)) {
53 num_char_bytes = 0;
54 } else if ((utf8[i] & UTF8_ONE_BYTE_MASK) == UTF8_ONE_BYTE_CODE) {
55 num_char_bytes = 1;
56 } else if ((utf8[i] & UTF8_TWO_BYTE_MASK) == UTF8_TWO_BYTE_CODE) {
57 num_char_bytes = 2;
58 } else if ((utf8[i] & UTF8_THREE_BYTE_MASK) == UTF8_THREE_BYTE_CODE) {
59 num_char_bytes = 3;
60 } else {
61 result |= VK_STRING_ERROR_BAD_DATA;
62 break;
63 }
64
65 // Validate the following num_char_bytes of data
66 for (j = 0; (j < num_char_bytes) && (i < max_length); j++) {
67 if (++i == max_length) {
68 result |= VK_STRING_ERROR_LENGTH;
69 break;
70 }
71 if ((utf8[i] & UTF8_DATA_BYTE_MASK) != UTF8_DATA_BYTE_CODE) {
72 result |= VK_STRING_ERROR_BAD_DATA;
73 break;
74 }
75 }
76 if (result != VK_STRING_ERROR_NONE) break;
77 }
78 return result;
79 }
80
81 // Utility function for determining if a string is in a set of strings
white_list(const char * item,const std::set<std::string> & list)82 VK_LAYER_EXPORT bool white_list(const char *item, const std::set<std::string> &list) { return (list.find(item) != list.end()); }
83
84 // Debug callbacks get created in three ways:
85 // o Application-defined debug callbacks
86 // o Through settings in a vk_layer_settings.txt file
87 // o By default, if neither an app-defined debug callback nor a vk_layer_settings.txt file is present
88 //
89 // At layer initialization time, default logging callbacks are created to output layer error messages.
90 // If a vk_layer_settings.txt file is present its settings will override any default settings.
91 //
92 // If a vk_layer_settings.txt file is present and an application defines a debug callback, both callbacks
93 // will be active. If no vk_layer_settings.txt file is present, creating an application-defined debug
94 // callback will cause the default callbacks to be unregisterd and removed.
layer_debug_messenger_actions(debug_report_data * report_data,const VkAllocationCallbacks * pAllocator,const char * layer_identifier)95 VK_LAYER_EXPORT void layer_debug_messenger_actions(debug_report_data *report_data, const VkAllocationCallbacks *pAllocator,
96 const char *layer_identifier) {
97 VkDebugUtilsMessengerEXT messenger = VK_NULL_HANDLE;
98
99 std::string report_flags_key = layer_identifier;
100 std::string debug_action_key = layer_identifier;
101 std::string log_filename_key = layer_identifier;
102 report_flags_key.append(".report_flags");
103 debug_action_key.append(".debug_action");
104 log_filename_key.append(".log_filename");
105
106 // Initialize layer options
107 LogMessageTypeFlags report_flags = GetLayerOptionFlags(report_flags_key, log_msg_type_option_definitions, 0);
108 VkLayerDbgActionFlags debug_action = GetLayerOptionFlags(debug_action_key, debug_actions_option_definitions, 0);
109 // Flag as default if these settings are not from a vk_layer_settings.txt file
110 VkDebugUtilsMessengerCreateInfoEXT dbgCreateInfo;
111 memset(&dbgCreateInfo, 0, sizeof(dbgCreateInfo));
112 dbgCreateInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
113 dbgCreateInfo.messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT;
114 if (report_flags & kErrorBit) {
115 dbgCreateInfo.messageSeverity |= VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT;
116 }
117 if (report_flags & kWarningBit) {
118 dbgCreateInfo.messageSeverity |= VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT;
119 }
120 if (report_flags & kPerformanceWarningBit) {
121 dbgCreateInfo.messageSeverity |= VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT;
122 dbgCreateInfo.messageType |= VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;
123 }
124 if (report_flags & kInformationBit) {
125 dbgCreateInfo.messageSeverity |= VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT;
126 }
127 if (report_flags & kDebugBit) {
128 dbgCreateInfo.messageSeverity |= VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT;
129 }
130
131 if (debug_action & VK_DBG_LAYER_ACTION_LOG_MSG) {
132 const char *log_filename = getLayerOption(log_filename_key.c_str());
133 FILE *log_output = getLayerLogOutput(log_filename, layer_identifier);
134 dbgCreateInfo.pfnUserCallback = messenger_log_callback;
135 dbgCreateInfo.pUserData = (void *)log_output;
136 layer_create_messenger_callback(report_data, true, &dbgCreateInfo, pAllocator, &messenger);
137 }
138
139 messenger = VK_NULL_HANDLE;
140
141 if (debug_action & VK_DBG_LAYER_ACTION_DEBUG_OUTPUT) {
142 dbgCreateInfo.pfnUserCallback = messenger_win32_debug_output_msg;
143 dbgCreateInfo.pUserData = NULL;
144 layer_create_messenger_callback(report_data, true, &dbgCreateInfo, pAllocator, &messenger);
145 }
146
147 messenger = VK_NULL_HANDLE;
148
149 if (debug_action & VK_DBG_LAYER_ACTION_BREAK) {
150 dbgCreateInfo.pfnUserCallback = MessengerBreakCallback;
151 dbgCreateInfo.pUserData = NULL;
152 layer_create_messenger_callback(report_data, true, &dbgCreateInfo, pAllocator, &messenger);
153 }
154 }
155
156 // NOTE: This function has been deprecated, and the above function (layer_debug_messenger_actions) should be
157 // used in its place.
layer_debug_report_actions(debug_report_data * report_data,const VkAllocationCallbacks * pAllocator,const char * layer_identifier)158 VK_LAYER_EXPORT void layer_debug_report_actions(debug_report_data *report_data, const VkAllocationCallbacks *pAllocator,
159 const char *layer_identifier) {
160 VkDebugReportCallbackEXT callback = VK_NULL_HANDLE;
161
162 std::string report_flags_key = layer_identifier;
163 std::string debug_action_key = layer_identifier;
164 std::string log_filename_key = layer_identifier;
165 report_flags_key.append(".report_flags");
166 debug_action_key.append(".debug_action");
167 log_filename_key.append(".log_filename");
168
169 // Initialize layer options
170 VkDebugReportFlagsEXT report_flags = GetLayerOptionFlags(report_flags_key, report_flags_option_definitions, 0);
171 VkLayerDbgActionFlags debug_action = GetLayerOptionFlags(debug_action_key, debug_actions_option_definitions, 0);
172 // Flag as default if these settings are not from a vk_layer_settings.txt file
173 bool default_layer_callback = (debug_action & VK_DBG_LAYER_ACTION_DEFAULT) ? true : false;
174
175 if (debug_action & VK_DBG_LAYER_ACTION_LOG_MSG) {
176 const char *log_filename = getLayerOption(log_filename_key.c_str());
177 FILE *log_output = getLayerLogOutput(log_filename, layer_identifier);
178 VkDebugReportCallbackCreateInfoEXT dbgCreateInfo;
179 memset(&dbgCreateInfo, 0, sizeof(dbgCreateInfo));
180 dbgCreateInfo.sType = VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT;
181 dbgCreateInfo.flags = report_flags;
182 dbgCreateInfo.pfnCallback = report_log_callback;
183 dbgCreateInfo.pUserData = (void *)log_output;
184 layer_create_report_callback(report_data, default_layer_callback, &dbgCreateInfo, pAllocator, &callback);
185 }
186
187 callback = VK_NULL_HANDLE;
188
189 if (debug_action & VK_DBG_LAYER_ACTION_DEBUG_OUTPUT) {
190 VkDebugReportCallbackCreateInfoEXT dbgCreateInfo;
191 memset(&dbgCreateInfo, 0, sizeof(dbgCreateInfo));
192 dbgCreateInfo.sType = VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT;
193 dbgCreateInfo.flags = report_flags;
194 dbgCreateInfo.pfnCallback = report_win32_debug_output_msg;
195 dbgCreateInfo.pUserData = NULL;
196 layer_create_report_callback(report_data, default_layer_callback, &dbgCreateInfo, pAllocator, &callback);
197 }
198
199 callback = VK_NULL_HANDLE;
200
201 if (debug_action & VK_DBG_LAYER_ACTION_BREAK) {
202 VkDebugReportCallbackCreateInfoEXT dbgCreateInfo;
203 memset(&dbgCreateInfo, 0, sizeof(dbgCreateInfo));
204 dbgCreateInfo.sType = VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT;
205 dbgCreateInfo.flags = report_flags;
206 dbgCreateInfo.pfnCallback = DebugBreakCallback;
207 dbgCreateInfo.pUserData = NULL;
208 layer_create_report_callback(report_data, default_layer_callback, &dbgCreateInfo, pAllocator, &callback);
209 }
210 }
211
get_chain_info(const VkInstanceCreateInfo * pCreateInfo,VkLayerFunction func)212 VK_LAYER_EXPORT VkLayerInstanceCreateInfo *get_chain_info(const VkInstanceCreateInfo *pCreateInfo, VkLayerFunction func) {
213 VkLayerInstanceCreateInfo *chain_info = (VkLayerInstanceCreateInfo *)pCreateInfo->pNext;
214 while (chain_info && !(chain_info->sType == VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO && chain_info->function == func)) {
215 chain_info = (VkLayerInstanceCreateInfo *)chain_info->pNext;
216 }
217 assert(chain_info != NULL);
218 return chain_info;
219 }
220
get_chain_info(const VkDeviceCreateInfo * pCreateInfo,VkLayerFunction func)221 VK_LAYER_EXPORT VkLayerDeviceCreateInfo *get_chain_info(const VkDeviceCreateInfo *pCreateInfo, VkLayerFunction func) {
222 VkLayerDeviceCreateInfo *chain_info = (VkLayerDeviceCreateInfo *)pCreateInfo->pNext;
223 while (chain_info && !(chain_info->sType == VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO && chain_info->function == func)) {
224 chain_info = (VkLayerDeviceCreateInfo *)chain_info->pNext;
225 }
226 assert(chain_info != NULL);
227 return chain_info;
228 }
229