text: /*
   * Vulkan
   *
   * Copyright (C) 2015 Valve, Inc.
   * Copyright (C) 2016 Google, Inc.
   *
   * 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.
   */
  #include <stdio.h>
  #include <stdlib.h>
  #include <string.h>
  #include <unordered_map>
  #include <list>
  
  #include "vk_loader_platform.h"
  #include "vulkan/vk_layer.h"
  #include "vk_layer_config.h"
  #include "vk_layer_extension_utils.h"
  #include "vk_layer_utils.h"
  #include "vk_layer_table.h"
  #include "vk_layer_logging.h"
  #include "threading.h"
  #include "vk_dispatch_table_helper.h"
  #include "vk_enum_string_helper.h"
  #include "vk_layer_data.h"
  #include "vk_layer_utils.h"
  
  #include "thread_check.h"
  
  namespace threading {
  
  static uint32_t loader_layer_if_version = CURRENT_LOADER_LAYER_INTERFACE_VERSION;
  
  static void initThreading(layer_data *my_data, const VkAllocationCallbacks *pAllocator) {
      layer_debug_actions(my_data->report_data, my_data->logging_callback, pAllocator, "google_threading");
  }
  
  VKAPI_ATTR VkResult VKAPI_CALL CreateInstance(const VkInstanceCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
                                                VkInstance *pInstance) {
      VkLayerInstanceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
  
      assert(chain_info->u.pLayerInfo);
      PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
      PFN_vkCreateInstance fpCreateInstance = (PFN_vkCreateInstance)fpGetInstanceProcAddr(NULL, "vkCreateInstance");
      if (fpCreateInstance == NULL) {
          return VK_ERROR_INITIALIZATION_FAILED;
      }
  
      // Advance the link info for the next element on the chain
      chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
  
      VkResult result = fpCreateInstance(pCreateInfo, pAllocator, pInstance);
      if (result != VK_SUCCESS) return result;
  
      layer_data *my_data = GetLayerDataPtr(get_dispatch_key(*pInstance), layer_data_map);
      my_data->instance = *pInstance;
      my_data->instance_dispatch_table = new VkLayerInstanceDispatchTable;
      layer_init_instance_dispatch_table(*pInstance, my_data->instance_dispatch_table, fpGetInstanceProcAddr);
  
      my_data->report_data = debug_report_create_instance(my_data->instance_dispatch_table, *pInstance,
                                                          pCreateInfo->enabledExtensionCount, pCreateInfo->ppEnabledExtensionNames);
      initThreading(my_data, pAllocator);
  
      // Look for one or more debug report create info structures, and copy the
      // callback(s) for each one found (for use by vkDestroyInstance)
      layer_copy_tmp_callbacks(pCreateInfo->pNext, &my_data->num_tmp_callbacks, &my_data->tmp_dbg_create_infos,
                               &my_data->tmp_callbacks);
      return result;
  }
  
  VKAPI_ATTR void VKAPI_CALL DestroyInstance(VkInstance instance, const VkAllocationCallbacks *pAllocator) {
      dispatch_key key = get_dispatch_key(instance);
      layer_data *my_data = GetLayerDataPtr(key, layer_data_map);
      VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
  
      // Enable the temporary callback(s) here to catch cleanup issues:
      bool callback_setup = false;
      if (my_data->num_tmp_callbacks > 0) {
          if (!layer_enable_tmp_callbacks(my_data->report_data, my_data->num_tmp_callbacks, my_data->tmp_dbg_create_infos,
                                          my_data->tmp_callbacks)) {
              callback_setup = true;
          }
      }
  
      bool threadChecks = startMultiThread();
      if (threadChecks) {
          startWriteObject(my_data, instance);
      }
      pTable->DestroyInstance(instance, pAllocator);
      if (threadChecks) {
          finishWriteObject(my_data, instance);
      } else {
          finishMultiThread();
      }
  
      // Disable and cleanup the temporary callback(s):
      if (callback_setup) {
          layer_disable_tmp_callbacks(my_data->report_data, my_data->num_tmp_callbacks, my_data->tmp_callbacks);
      }
      if (my_data->num_tmp_callbacks > 0) {
          layer_free_tmp_callbacks(my_data->tmp_dbg_create_infos, my_data->tmp_callbacks);
          my_data->num_tmp_callbacks = 0;
      }
  
      // Clean up logging callback, if any
      while (my_data->logging_callback.size() > 0) {
          VkDebugReportCallbackEXT callback = my_data->logging_callback.back();
          layer_destroy_msg_callback(my_data->report_data, callback, pAllocator);
          my_data->logging_callback.pop_back();
      }
  
      layer_debug_report_destroy_instance(my_data->report_data);
      delete my_data->instance_dispatch_table;
      FreeLayerDataPtr(key, layer_data_map);
  }
  
  VKAPI_ATTR VkResult VKAPI_CALL CreateDevice(VkPhysicalDevice gpu, const VkDeviceCreateInfo *pCreateInfo,
                                              const VkAllocationCallbacks *pAllocator, VkDevice *pDevice) {
      layer_data *my_instance_data = GetLayerDataPtr(get_dispatch_key(gpu), layer_data_map);
      VkLayerDeviceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
  
      assert(chain_info->u.pLayerInfo);
      PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
      PFN_vkGetDeviceProcAddr fpGetDeviceProcAddr = chain_info->u.pLayerInfo->pfnNextGetDeviceProcAddr;
      PFN_vkCreateDevice fpCreateDevice = (PFN_vkCreateDevice)fpGetInstanceProcAddr(my_instance_data->instance, "vkCreateDevice");
      if (fpCreateDevice == NULL) {
          return VK_ERROR_INITIALIZATION_FAILED;
      }
  
      // Advance the link info for the next element on the chain
      chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext;
  
      VkResult result = fpCreateDevice(gpu, pCreateInfo, pAllocator, pDevice);
      if (result != VK_SUCCESS) {
          return result;
      }
  
      layer_data *my_device_data = GetLayerDataPtr(get_dispatch_key(*pDevice), layer_data_map);
  
      // Setup device dispatch table
      my_device_data->device_dispatch_table = new VkLayerDispatchTable;
      layer_init_device_dispatch_table(*pDevice, my_device_data->device_dispatch_table, fpGetDeviceProcAddr);
  
      my_device_data->report_data = layer_debug_report_create_device(my_instance_data->report_data, *pDevice);
      return result;
  }
  
  VKAPI_ATTR void VKAPI_CALL DestroyDevice(VkDevice device, const VkAllocationCallbacks *pAllocator) {
      dispatch_key key = get_dispatch_key(device);
      layer_data *dev_data = GetLayerDataPtr(key, layer_data_map);
      bool threadChecks = startMultiThread();
      if (threadChecks) {
          startWriteObject(dev_data, device);
      }
      dev_data->device_dispatch_table->DestroyDevice(device, pAllocator);
      if (threadChecks) {
          finishWriteObject(dev_data, device);
      } else {
          finishMultiThread();
      }
  
      delete dev_data->device_dispatch_table;
      FreeLayerDataPtr(key, layer_data_map);
  }
  
  VKAPI_ATTR VkResult VKAPI_CALL GetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, uint32_t *pSwapchainImageCount,
                                                       VkImage *pSwapchainImages) {
      dispatch_key key = get_dispatch_key(device);
      layer_data *my_data = GetLayerDataPtr(key, layer_data_map);
      VkLayerDispatchTable *pTable = my_data->device_dispatch_table;
      VkResult result;
      bool threadChecks = startMultiThread();
      if (threadChecks) {
          startReadObject(my_data, device);
          startReadObject(my_data, swapchain);
      }
      result = pTable->GetSwapchainImagesKHR(device, swapchain, pSwapchainImageCount, pSwapchainImages);
      if (threadChecks) {
          finishReadObject(my_data, device);
          finishReadObject(my_data, swapchain);
      } else {
          finishMultiThread();
      }
      return result;
  }
  
  static const VkExtensionProperties threading_extensions[] = {
      {VK_EXT_DEBUG_REPORT_EXTENSION_NAME, VK_EXT_DEBUG_REPORT_SPEC_VERSION}};
  
  static const VkLayerProperties layerProps = {
      "VK_LAYER_GOOGLE_threading",
      VK_LAYER_API_VERSION,  // specVersion
      1,
      "Google Validation Layer",
  };
  
  VKAPI_ATTR VkResult VKAPI_CALL EnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) {
      return util_GetLayerProperties(1, &layerProps, pCount, pProperties);
  }
  
  VKAPI_ATTR VkResult VKAPI_CALL EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount,
                                                                VkLayerProperties *pProperties) {
      return util_GetLayerProperties(1, &layerProps, pCount, pProperties);
  }
  
  VKAPI_ATTR VkResult VKAPI_CALL EnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount,
                                                                      VkExtensionProperties *pProperties) {
      if (pLayerName && !strcmp(pLayerName, layerProps.layerName))
          return util_GetExtensionProperties(1, threading_extensions, pCount, pProperties);
  
      return VK_ERROR_LAYER_NOT_PRESENT;
  }
  
  VKAPI_ATTR VkResult VKAPI_CALL EnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, const char *pLayerName,
                                                                    uint32_t *pCount, VkExtensionProperties *pProperties) {
      // Threading layer does not have any device extensions
      if (pLayerName && !strcmp(pLayerName, layerProps.layerName))
          return util_GetExtensionProperties(0, nullptr, pCount, pProperties);
  
      assert(physicalDevice);
  
      dispatch_key key = get_dispatch_key(physicalDevice);
      layer_data *my_data = GetLayerDataPtr(key, layer_data_map);
      return my_data->instance_dispatch_table->EnumerateDeviceExtensionProperties(physicalDevice, NULL, pCount, pProperties);
  }
  
  // Need to prototype this call because it's internal and does not show up in vk.xml
  VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetPhysicalDeviceProcAddr(VkInstance instance, const char *funcName);
  
  VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetDeviceProcAddr(VkDevice device, const char *funcName) {
      const auto item = name_to_funcptr_map.find(funcName);
      if (item != name_to_funcptr_map.end()) {
          return reinterpret_cast<PFN_vkVoidFunction>(item->second);
      }
  
      layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
      auto &table = device_data->device_dispatch_table;
      if (!table->GetDeviceProcAddr) return nullptr;
      return table->GetDeviceProcAddr(device, funcName);
  }
  
  VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetInstanceProcAddr(VkInstance instance, const char *funcName) {
      const auto item = name_to_funcptr_map.find(funcName);
      if (item != name_to_funcptr_map.end()) {
          return reinterpret_cast<PFN_vkVoidFunction>(item->second);
      }
  
      auto instance_data = GetLayerDataPtr(get_dispatch_key(instance), layer_data_map);
      auto &table = instance_data->instance_dispatch_table;
      if (!table->GetInstanceProcAddr) return nullptr;
      return table->GetInstanceProcAddr(instance, funcName);
  }
  
  VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetPhysicalDeviceProcAddr(VkInstance instance, const char *funcName) {
      assert(instance);
  
      layer_data *my_data;
      my_data = GetLayerDataPtr(get_dispatch_key(instance), layer_data_map);
      VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table;
  
      if (pTable->GetPhysicalDeviceProcAddr == NULL) return NULL;
      return pTable->GetPhysicalDeviceProcAddr(instance, funcName);
  }
  
  VKAPI_ATTR VkResult VKAPI_CALL CreateDebugReportCallbackEXT(VkInstance instance,
                                                              const VkDebugReportCallbackCreateInfoEXT *pCreateInfo,
                                                              const VkAllocationCallbacks *pAllocator,
                                                              VkDebugReportCallbackEXT *pMsgCallback) {
      layer_data *my_data = GetLayerDataPtr(get_dispatch_key(instance), layer_data_map);
      bool threadChecks = startMultiThread();
      if (threadChecks) {
          startReadObject(my_data, instance);
      }
      VkResult result =
          my_data->instance_dispatch_table->CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback);
      if (VK_SUCCESS == result) {
          result = layer_create_msg_callback(my_data->report_data, false, pCreateInfo, pAllocator, pMsgCallback);
      }
      if (threadChecks) {
          finishReadObject(my_data, instance);
      } else {
          finishMultiThread();
      }
      return result;
  }
  
  VKAPI_ATTR void VKAPI_CALL DestroyDebugReportCallbackEXT(VkInstance instance, VkDebugReportCallbackEXT callback,
                                                           const VkAllocationCallbacks *pAllocator) {
      layer_data *my_data = GetLayerDataPtr(get_dispatch_key(instance), layer_data_map);
      bool threadChecks = startMultiThread();
      if (threadChecks) {
          startReadObject(my_data, instance);
          startWriteObject(my_data, callback);
      }
      my_data->instance_dispatch_table->DestroyDebugReportCallbackEXT(instance, callback, pAllocator);
      layer_destroy_msg_callback(my_data->report_data, callback, pAllocator);
      if (threadChecks) {
          finishReadObject(my_data, instance);
          finishWriteObject(my_data, callback);
      } else {
          finishMultiThread();
      }
  }
  
  VKAPI_ATTR VkResult VKAPI_CALL AllocateCommandBuffers(VkDevice device, const VkCommandBufferAllocateInfo *pAllocateInfo,
                                                        VkCommandBuffer *pCommandBuffers) {
      dispatch_key key = get_dispatch_key(device);
      layer_data *my_data = GetLayerDataPtr(key, layer_data_map);
      VkLayerDispatchTable *pTable = my_data->device_dispatch_table;
      VkResult result;
      bool threadChecks = startMultiThread();
      if (threadChecks) {
          startReadObject(my_data, device);
          startWriteObject(my_data, pAllocateInfo->commandPool);
      }
  
      result = pTable->AllocateCommandBuffers(device, pAllocateInfo, pCommandBuffers);
      if (threadChecks) {
          finishReadObject(my_data, device);
          finishWriteObject(my_data, pAllocateInfo->commandPool);
      } else {
          finishMultiThread();
      }
  
      // Record mapping from command buffer to command pool
      if (VK_SUCCESS == result) {
          for (uint32_t index = 0; index < pAllocateInfo->commandBufferCount; index++) {
              std::lock_guard<std::mutex> lock(command_pool_lock);
              command_pool_map[pCommandBuffers[index]] = pAllocateInfo->commandPool;
          }
      }
  
      return result;
  }
  
  VKAPI_ATTR VkResult VKAPI_CALL AllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo *pAllocateInfo,
                                                        VkDescriptorSet *pDescriptorSets) {
      dispatch_key key = get_dispatch_key(device);
      layer_data *my_data = GetLayerDataPtr(key, layer_data_map);
      VkLayerDispatchTable *pTable = my_data->device_dispatch_table;
      VkResult result;
      bool threadChecks = startMultiThread();
      if (threadChecks) {
          startReadObject(my_data, device);
          startWriteObject(my_data, pAllocateInfo->descriptorPool);
          // Host access to pAllocateInfo::descriptorPool must be externally synchronized
      }
      result = pTable->AllocateDescriptorSets(device, pAllocateInfo, pDescriptorSets);
      if (threadChecks) {
          finishReadObject(my_data, device);
          finishWriteObject(my_data, pAllocateInfo->descriptorPool);
          // Host access to pAllocateInfo::descriptorPool must be externally synchronized
      } else {
          finishMultiThread();
      }
      return result;
  }
  
  VKAPI_ATTR void VKAPI_CALL FreeCommandBuffers(VkDevice device, VkCommandPool commandPool, uint32_t commandBufferCount,
                                                const VkCommandBuffer *pCommandBuffers) {
      dispatch_key key = get_dispatch_key(device);
      layer_data *my_data = GetLayerDataPtr(key, layer_data_map);
      VkLayerDispatchTable *pTable = my_data->device_dispatch_table;
      const bool lockCommandPool = false;  // pool is already directly locked
      bool threadChecks = startMultiThread();
      if (threadChecks) {
          startReadObject(my_data, device);
          startWriteObject(my_data, commandPool);
          for (uint32_t index = 0; index < commandBufferCount; index++) {
              startWriteObject(my_data, pCommandBuffers[index], lockCommandPool);
          }
          // The driver may immediately reuse command buffers in another thread.
          // These updates need to be done before calling down to the driver.
          for (uint32_t index = 0; index < commandBufferCount; index++) {
              finishWriteObject(my_data, pCommandBuffers[index], lockCommandPool);
              std::lock_guard<std::mutex> lock(command_pool_lock);
              command_pool_map.erase(pCommandBuffers[index]);
          }
      }
  
      pTable->FreeCommandBuffers(device, commandPool, commandBufferCount, pCommandBuffers);
      if (threadChecks) {
          finishReadObject(my_data, device);
          finishWriteObject(my_data, commandPool);
      } else {
          finishMultiThread();
      }
  }
  
  }  // namespace threading
  
  // vk_layer_logging.h expects these to be defined
  
  VKAPI_ATTR VkResult VKAPI_CALL vkCreateDebugReportCallbackEXT(VkInstance instance,
                                                                const VkDebugReportCallbackCreateInfoEXT *pCreateInfo,
                                                                const VkAllocationCallbacks *pAllocator,
                                                                VkDebugReportCallbackEXT *pMsgCallback) {
      return threading::CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pMsgCallback);
  }
  
  VKAPI_ATTR void VKAPI_CALL vkDestroyDebugReportCallbackEXT(VkInstance instance, VkDebugReportCallbackEXT msgCallback,
                                                             const VkAllocationCallbacks *pAllocator) {
      threading::DestroyDebugReportCallbackEXT(instance, msgCallback, pAllocator);
  }
  
  VKAPI_ATTR void VKAPI_CALL vkDebugReportMessageEXT(VkInstance instance, VkDebugReportFlagsEXT flags,
                                                     VkDebugReportObjectTypeEXT objType, uint64_t object, size_t location,
                                                     int32_t msgCode, const char *pLayerPrefix, const char *pMsg) {
      threading::DebugReportMessageEXT(instance, flags, objType, object, location, msgCode, pLayerPrefix, pMsg);
  }
  
  // loader-layer interface v0, just wrappers since there is only a layer
  
  VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount,
                                                                                        VkExtensionProperties *pProperties) {
      return threading::EnumerateInstanceExtensionProperties(pLayerName, pCount, pProperties);
  }
  
  VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceLayerProperties(uint32_t *pCount,
                                                                                    VkLayerProperties *pProperties) {
      return threading::EnumerateInstanceLayerProperties(pCount, pProperties);
  }
  
  VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount,
                                                                                  VkLayerProperties *pProperties) {
      // the layer command handles VK_NULL_HANDLE just fine internally
      assert(physicalDevice == VK_NULL_HANDLE);
      return threading::EnumerateDeviceLayerProperties(VK_NULL_HANDLE, pCount, pProperties);
  }
  
  VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice,
                                                                                      const char *pLayerName, uint32_t *pCount,
                                                                                      VkExtensionProperties *pProperties) {
      // the layer command handles VK_NULL_HANDLE just fine internally
      assert(physicalDevice == VK_NULL_HANDLE);
      return threading::EnumerateDeviceExtensionProperties(VK_NULL_HANDLE, pLayerName, pCount, pProperties);
  }
  
  VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) {
      return threading::GetDeviceProcAddr(dev, funcName);
  }
  
  VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) {
      return threading::GetInstanceProcAddr(instance, funcName);
  }
  
  VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vk_layerGetPhysicalDeviceProcAddr(VkInstance instance,
                                                                                             const char *funcName) {
      return threading::GetPhysicalDeviceProcAddr(instance, funcName);
  }
  
  VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkNegotiateLoaderLayerInterfaceVersion(VkNegotiateLayerInterface *pVersionStruct) {
      assert(pVersionStruct != NULL);
      assert(pVersionStruct->sType == LAYER_NEGOTIATE_INTERFACE_STRUCT);
  
      // Fill in the function pointers if our version is at least capable of having the structure contain them.
      if (pVersionStruct->loaderLayerInterfaceVersion >= 2) {
          pVersionStruct->pfnGetInstanceProcAddr = vkGetInstanceProcAddr;
          pVersionStruct->pfnGetDeviceProcAddr = vkGetDeviceProcAddr;
          pVersionStruct->pfnGetPhysicalDeviceProcAddr = vk_layerGetPhysicalDeviceProcAddr;
      }
  
      if (pVersionStruct->loaderLayerInterfaceVersion < CURRENT_LOADER_LAYER_INTERFACE_VERSION) {
          threading::loader_layer_if_version = pVersionStruct->loaderLayerInterfaceVersion;
      } else if (pVersionStruct->loaderLayerInterfaceVersion > CURRENT_LOADER_LAYER_INTERFACE_VERSION) {
          pVersionStruct->loaderLayerInterfaceVersion = CURRENT_LOADER_LAYER_INTERFACE_VERSION;
      }
  
      return VK_SUCCESS;
  }
  