1 /* 2 * Vulkan 3 * 4 * Copyright (C) 2015 Valve, Inc. 5 * Copyright (C) 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 #include <stdio.h> 20 #include <stdlib.h> 21 #include <string.h> 22 #include <unordered_map> 23 #include <list> 24 25 #include "vk_loader_platform.h" 26 #include "vulkan/vk_layer.h" 27 #include "vk_layer_config.h" 28 #include "vk_layer_extension_utils.h" 29 #include "vk_layer_utils.h" 30 #include "vk_enum_validate_helper.h" 31 #include "vk_struct_validate_helper.h" 32 #include "vk_layer_table.h" 33 #include "vk_layer_logging.h" 34 #include "threading.h" 35 #include "vk_dispatch_table_helper.h" 36 #include "vk_struct_string_helper_cpp.h" 37 #include "vk_layer_data.h" 38 #include "vk_layer_utils.h" 39 40 #include "thread_check.h" 41 42 namespace threading { 43 44 static void initThreading(layer_data *my_data, const VkAllocationCallbacks *pAllocator) { 45 46 layer_debug_actions(my_data->report_data, my_data->logging_callback, pAllocator, "google_threading"); 47 } 48 49 VKAPI_ATTR VkResult VKAPI_CALL 50 CreateInstance(const VkInstanceCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkInstance *pInstance) { 51 VkLayerInstanceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO); 52 53 assert(chain_info->u.pLayerInfo); 54 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr; 55 PFN_vkCreateInstance fpCreateInstance = (PFN_vkCreateInstance)fpGetInstanceProcAddr(NULL, "vkCreateInstance"); 56 if (fpCreateInstance == NULL) { 57 return VK_ERROR_INITIALIZATION_FAILED; 58 } 59 60 // Advance the link info for the next element on the chain 61 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext; 62 63 VkResult result = fpCreateInstance(pCreateInfo, pAllocator, pInstance); 64 if (result != VK_SUCCESS) 65 return result; 66 67 layer_data *my_data = get_my_data_ptr(get_dispatch_key(*pInstance), layer_data_map); 68 my_data->instance = *pInstance; 69 my_data->instance_dispatch_table = new VkLayerInstanceDispatchTable; 70 layer_init_instance_dispatch_table(*pInstance, my_data->instance_dispatch_table, fpGetInstanceProcAddr); 71 72 my_data->report_data = debug_report_create_instance(my_data->instance_dispatch_table, *pInstance, 73 pCreateInfo->enabledExtensionCount, pCreateInfo->ppEnabledExtensionNames); 74 initThreading(my_data, pAllocator); 75 76 // Look for one or more debug report create info structures, and copy the 77 // callback(s) for each one found (for use by vkDestroyInstance) 78 layer_copy_tmp_callbacks(pCreateInfo->pNext, &my_data->num_tmp_callbacks, &my_data->tmp_dbg_create_infos, 79 &my_data->tmp_callbacks); 80 return result; 81 } 82 83 VKAPI_ATTR void VKAPI_CALL DestroyInstance(VkInstance instance, const VkAllocationCallbacks *pAllocator) { 84 dispatch_key key = get_dispatch_key(instance); 85 layer_data *my_data = get_my_data_ptr(key, layer_data_map); 86 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table; 87 88 // Enable the temporary callback(s) here to catch cleanup issues: 89 bool callback_setup = false; 90 if (my_data->num_tmp_callbacks > 0) { 91 if (!layer_enable_tmp_callbacks(my_data->report_data, my_data->num_tmp_callbacks, my_data->tmp_dbg_create_infos, 92 my_data->tmp_callbacks)) { 93 callback_setup = true; 94 } 95 } 96 97 startWriteObject(my_data, instance); 98 pTable->DestroyInstance(instance, pAllocator); 99 finishWriteObject(my_data, instance); 100 101 // Disable and cleanup the temporary callback(s): 102 if (callback_setup) { 103 layer_disable_tmp_callbacks(my_data->report_data, my_data->num_tmp_callbacks, my_data->tmp_callbacks); 104 } 105 if (my_data->num_tmp_callbacks > 0) { 106 layer_free_tmp_callbacks(my_data->tmp_dbg_create_infos, my_data->tmp_callbacks); 107 my_data->num_tmp_callbacks = 0; 108 } 109 110 // Clean up logging callback, if any 111 while (my_data->logging_callback.size() > 0) { 112 VkDebugReportCallbackEXT callback = my_data->logging_callback.back(); 113 layer_destroy_msg_callback(my_data->report_data, callback, pAllocator); 114 my_data->logging_callback.pop_back(); 115 } 116 117 layer_debug_report_destroy_instance(my_data->report_data); 118 delete my_data->instance_dispatch_table; 119 layer_data_map.erase(key); 120 } 121 122 VKAPI_ATTR VkResult VKAPI_CALL CreateDevice(VkPhysicalDevice gpu, const VkDeviceCreateInfo *pCreateInfo, 123 const VkAllocationCallbacks *pAllocator, VkDevice *pDevice) { 124 layer_data *my_instance_data = get_my_data_ptr(get_dispatch_key(gpu), layer_data_map); 125 VkLayerDeviceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO); 126 127 assert(chain_info->u.pLayerInfo); 128 PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr; 129 PFN_vkGetDeviceProcAddr fpGetDeviceProcAddr = chain_info->u.pLayerInfo->pfnNextGetDeviceProcAddr; 130 PFN_vkCreateDevice fpCreateDevice = (PFN_vkCreateDevice)fpGetInstanceProcAddr(my_instance_data->instance, "vkCreateDevice"); 131 if (fpCreateDevice == NULL) { 132 return VK_ERROR_INITIALIZATION_FAILED; 133 } 134 135 // Advance the link info for the next element on the chain 136 chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext; 137 138 VkResult result = fpCreateDevice(gpu, pCreateInfo, pAllocator, pDevice); 139 if (result != VK_SUCCESS) { 140 return result; 141 } 142 143 layer_data *my_device_data = get_my_data_ptr(get_dispatch_key(*pDevice), layer_data_map); 144 145 // Setup device dispatch table 146 my_device_data->device_dispatch_table = new VkLayerDispatchTable; 147 layer_init_device_dispatch_table(*pDevice, my_device_data->device_dispatch_table, fpGetDeviceProcAddr); 148 149 my_device_data->report_data = layer_debug_report_create_device(my_instance_data->report_data, *pDevice); 150 return result; 151 } 152 153 VKAPI_ATTR void VKAPI_CALL DestroyDevice(VkDevice device, const VkAllocationCallbacks *pAllocator) { 154 dispatch_key key = get_dispatch_key(device); 155 layer_data *dev_data = get_my_data_ptr(key, layer_data_map); 156 startWriteObject(dev_data, device); 157 dev_data->device_dispatch_table->DestroyDevice(device, pAllocator); 158 finishWriteObject(dev_data, device); 159 layer_data_map.erase(key); 160 } 161 162 static const VkExtensionProperties threading_extensions[] = { 163 {VK_EXT_DEBUG_REPORT_EXTENSION_NAME, VK_EXT_DEBUG_REPORT_SPEC_VERSION}}; 164 165 static const VkLayerProperties layerProps = { 166 "VK_LAYER_GOOGLE_threading", 167 VK_LAYER_API_VERSION, // specVersion 168 1, "Google Validation Layer", 169 }; 170 171 static inline PFN_vkVoidFunction layer_intercept_proc(const char *name) { 172 for (int i = 0; i < sizeof(procmap) / sizeof(procmap[0]); i++) { 173 if (!strcmp(name, procmap[i].name)) 174 return procmap[i].pFunc; 175 } 176 return NULL; 177 } 178 179 VKAPI_ATTR VkResult VKAPI_CALL EnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, 180 const char *pLayerName, uint32_t *pCount, 181 VkExtensionProperties *pProperties) { 182 // Threading layer does not have any device extensions 183 if (pLayerName && !strcmp(pLayerName, layerProps.layerName)) 184 return util_GetExtensionProperties(0, nullptr, pCount, pProperties); 185 186 assert(physicalDevice); 187 188 dispatch_key key = get_dispatch_key(physicalDevice); 189 layer_data *my_data = get_my_data_ptr(key, layer_data_map); 190 return my_data->instance_dispatch_table->EnumerateDeviceExtensionProperties(physicalDevice, NULL, pCount, pProperties); 191 } 192 193 static inline PFN_vkVoidFunction layer_intercept_instance_proc(const char *name) { 194 if (!name || name[0] != 'v' || name[1] != 'k') 195 return NULL; 196 197 // we should never be queried for these commands 198 assert(strcmp(name, "vkEnumerateInstanceLayerProperties") && 199 strcmp(name, "vkEnumerateInstanceExtensionProperties") && 200 strcmp(name, "vkEnumerateDeviceLayerProperties")); 201 202 name += 2; 203 if (!strcmp(name, "CreateInstance")) 204 return (PFN_vkVoidFunction)CreateInstance; 205 if (!strcmp(name, "DestroyInstance")) 206 return (PFN_vkVoidFunction)DestroyInstance; 207 if (!strcmp(name, "EnumerateDeviceExtensionProperties")) 208 return (PFN_vkVoidFunction)EnumerateDeviceExtensionProperties; 209 if (!strcmp(name, "CreateDevice")) 210 return (PFN_vkVoidFunction)CreateDevice; 211 if (!strcmp(name, "GetInstanceProcAddr")) 212 return (PFN_vkVoidFunction)GetInstanceProcAddr; 213 214 return NULL; 215 } 216 217 VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetDeviceProcAddr(VkDevice device, const char *funcName) { 218 PFN_vkVoidFunction addr; 219 layer_data *dev_data; 220 221 assert(device); 222 223 addr = layer_intercept_proc(funcName); 224 if (addr) 225 return addr; 226 227 dev_data = get_my_data_ptr(get_dispatch_key(device), layer_data_map); 228 VkLayerDispatchTable *pTable = dev_data->device_dispatch_table; 229 230 if (pTable->GetDeviceProcAddr == NULL) 231 return NULL; 232 return pTable->GetDeviceProcAddr(device, funcName); 233 } 234 235 VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetInstanceProcAddr(VkInstance instance, const char *funcName) { 236 PFN_vkVoidFunction addr; 237 layer_data *my_data; 238 239 addr = layer_intercept_instance_proc(funcName); 240 if (!addr) 241 addr = layer_intercept_proc(funcName); 242 if (addr) { 243 return addr; 244 } 245 246 assert(instance); 247 248 my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map); 249 addr = debug_report_get_instance_proc_addr(my_data->report_data, funcName); 250 if (addr) { 251 return addr; 252 } 253 254 VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table; 255 if (pTable->GetInstanceProcAddr == NULL) { 256 return NULL; 257 } 258 return pTable->GetInstanceProcAddr(instance, funcName); 259 } 260 261 VKAPI_ATTR VkResult VKAPI_CALL 262 CreateDebugReportCallbackEXT(VkInstance instance, const VkDebugReportCallbackCreateInfoEXT *pCreateInfo, 263 const VkAllocationCallbacks *pAllocator, VkDebugReportCallbackEXT *pMsgCallback) { 264 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map); 265 startReadObject(my_data, instance); 266 VkResult result = 267 my_data->instance_dispatch_table->CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback); 268 if (VK_SUCCESS == result) { 269 result = layer_create_msg_callback(my_data->report_data, pCreateInfo, pAllocator, pMsgCallback); 270 } 271 finishReadObject(my_data, instance); 272 return result; 273 } 274 275 VKAPI_ATTR void VKAPI_CALL 276 DestroyDebugReportCallbackEXT(VkInstance instance, VkDebugReportCallbackEXT callback, const VkAllocationCallbacks *pAllocator) { 277 layer_data *my_data = get_my_data_ptr(get_dispatch_key(instance), layer_data_map); 278 startReadObject(my_data, instance); 279 startWriteObject(my_data, callback); 280 my_data->instance_dispatch_table->DestroyDebugReportCallbackEXT(instance, callback, pAllocator); 281 layer_destroy_msg_callback(my_data->report_data, callback, pAllocator); 282 finishReadObject(my_data, instance); 283 finishWriteObject(my_data, callback); 284 } 285 286 VKAPI_ATTR VkResult VKAPI_CALL 287 AllocateCommandBuffers(VkDevice device, const VkCommandBufferAllocateInfo *pAllocateInfo, VkCommandBuffer *pCommandBuffers) { 288 dispatch_key key = get_dispatch_key(device); 289 layer_data *my_data = get_my_data_ptr(key, layer_data_map); 290 VkLayerDispatchTable *pTable = my_data->device_dispatch_table; 291 VkResult result; 292 startReadObject(my_data, device); 293 startWriteObject(my_data, pAllocateInfo->commandPool); 294 295 result = pTable->AllocateCommandBuffers(device, pAllocateInfo, pCommandBuffers); 296 finishReadObject(my_data, device); 297 finishWriteObject(my_data, pAllocateInfo->commandPool); 298 299 // Record mapping from command buffer to command pool 300 if (VK_SUCCESS == result) { 301 for (uint32_t index = 0; index < pAllocateInfo->commandBufferCount; index++) { 302 std::lock_guard<std::mutex> lock(global_lock); 303 command_pool_map[pCommandBuffers[index]] = pAllocateInfo->commandPool; 304 } 305 } 306 307 return result; 308 } 309 310 VKAPI_ATTR void VKAPI_CALL FreeCommandBuffers(VkDevice device, VkCommandPool commandPool, uint32_t commandBufferCount, 311 const VkCommandBuffer *pCommandBuffers) { 312 dispatch_key key = get_dispatch_key(device); 313 layer_data *my_data = get_my_data_ptr(key, layer_data_map); 314 VkLayerDispatchTable *pTable = my_data->device_dispatch_table; 315 const bool lockCommandPool = false; // pool is already directly locked 316 startReadObject(my_data, device); 317 startWriteObject(my_data, commandPool); 318 for (uint32_t index = 0; index < commandBufferCount; index++) { 319 startWriteObject(my_data, pCommandBuffers[index], lockCommandPool); 320 } 321 322 pTable->FreeCommandBuffers(device, commandPool, commandBufferCount, pCommandBuffers); 323 finishReadObject(my_data, device); 324 finishWriteObject(my_data, commandPool); 325 for (uint32_t index = 0; index < commandBufferCount; index++) { 326 finishWriteObject(my_data, pCommandBuffers[index], lockCommandPool); 327 std::lock_guard<std::mutex> lock(global_lock); 328 command_pool_map.erase(pCommandBuffers[index]); 329 } 330 } 331 332 } // namespace threading 333 334 // vk_layer_logging.h expects these to be defined 335 336 VKAPI_ATTR VkResult VKAPI_CALL 337 vkCreateDebugReportCallbackEXT(VkInstance instance, const VkDebugReportCallbackCreateInfoEXT *pCreateInfo, 338 const VkAllocationCallbacks *pAllocator, VkDebugReportCallbackEXT *pMsgCallback) { 339 return threading::CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback); 340 } 341 342 VKAPI_ATTR void VKAPI_CALL vkDestroyDebugReportCallbackEXT(VkInstance instance, 343 VkDebugReportCallbackEXT msgCallback, 344 const VkAllocationCallbacks *pAllocator) { 345 threading::DestroyDebugReportCallbackEXT(instance, msgCallback, pAllocator); 346 } 347 348 VKAPI_ATTR void VKAPI_CALL 349 vkDebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objType, uint64_t object, 350 size_t location, int32_t msgCode, const char *pLayerPrefix, const char *pMsg) { 351 threading::DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix, pMsg); 352 } 353 354 // loader-layer interface v0 355 356 VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL 357 vkEnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, VkExtensionProperties *pProperties) { 358 return util_GetExtensionProperties(ARRAY_SIZE(threading::threading_extensions), threading::threading_extensions, pCount, pProperties); 359 } 360 361 VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) { 362 return util_GetLayerProperties(1, &threading::layerProps, pCount, pProperties); 363 } 364 365 VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL 366 vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, VkLayerProperties *pProperties) { 367 return util_GetLayerProperties(1, &threading::layerProps, pCount, pProperties); 368 } 369 370 VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, 371 const char *pLayerName, uint32_t *pCount, 372 VkExtensionProperties *pProperties) { 373 // the layer command handles VK_NULL_HANDLE just fine 374 return threading::EnumerateDeviceExtensionProperties(VK_NULL_HANDLE, pLayerName, pCount, pProperties); 375 } 376 377 VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) { 378 return threading::GetDeviceProcAddr(dev, funcName); 379 } 380 381 VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) { 382 if (!strcmp(funcName, "vkEnumerateInstanceLayerProperties")) 383 return reinterpret_cast<PFN_vkVoidFunction>(vkEnumerateInstanceLayerProperties); 384 if (!strcmp(funcName, "vkEnumerateDeviceLayerProperties")) 385 return reinterpret_cast<PFN_vkVoidFunction>(vkEnumerateDeviceLayerProperties); 386 if (!strcmp(funcName, "vkEnumerateInstanceExtensionProperties")) 387 return reinterpret_cast<PFN_vkVoidFunction>(vkEnumerateInstanceExtensionProperties); 388 if (!strcmp(funcName, "vkGetInstanceProcAddr")) 389 return reinterpret_cast<PFN_vkVoidFunction>(vkGetInstanceProcAddr); 390 391 return threading::GetInstanceProcAddr(instance, funcName); 392 } 393
