// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <lib/magma/platform/platform_semaphore.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include <array>
#include <thread>
#include <vector>

#include <gtest/gtest.h>
#include <vulkan/vulkan.h>

#include "src/graphics/tests/common/utils.h"
#include "vulkan/vulkan_core.h"

#define PRINT_STDERR(format, ...) \
  fprintf(stderr, "%s:%d " format "\n", __FILE__, __LINE__, ##__VA_ARGS__)

namespace {

class VulkanTest {
 public:
  explicit VulkanTest();

  ~VulkanTest();

  bool Initialize();
  static bool Exec(VulkanTest* t1, VulkanTest* t2, bool temporary);
  static bool ExecUsingQueue(VulkanTest* t1, VulkanTest* t2, bool temporary);

  // TODO(https://fxbug.dev/322210019): use this to skip tests that are currently broken on
  // Lavapipe.  Eventually all tests should also pass with Lavapipe; delete this when tests pass.
  bool IsLavapipe() const { return is_lavapipe_; }

 private:
  static constexpr uint32_t kSemaphoreCount = 2;

  bool InitVulkan();
  bool InitImage();
  void VerifyZirconEventSemaphoresAreAvailable() const;
  static bool Export(VulkanTest* t,
                     std::array<zx_handle_t, kSemaphoreCount>* exported_event_handles);

  bool is_initialized_ = false;

  VkInstance vk_instance_{};
  PFN_vkGetPhysicalDeviceExternalSemaphorePropertiesKHR
      vkGetPhysicalDeviceExternalSemaphorePropertiesKHR_;
  PFN_vkImportSemaphoreZirconHandleFUCHSIA vkImportSemaphoreZirconHandleFUCHSIA_;
  PFN_vkGetSemaphoreZirconHandleFUCHSIA vkGetSemaphoreZirconHandleFUCHSIA_;

  VkPhysicalDevice vk_physical_device_{};
  VkDevice vk_device_{};
  VkQueue vk_queue_{};

  std::array<VkSemaphore, kSemaphoreCount> vk_semaphores_{};
  bool is_lavapipe_ = false;
};

VulkanTest::VulkanTest() {}

VulkanTest::~VulkanTest() {
  for (auto& semaphore : vk_semaphores_) {
    if (semaphore) {
      vkDestroySemaphore(vk_device_, semaphore, nullptr);
      semaphore = VK_NULL_HANDLE;
    }
  }
  if (vk_device_) {
    vkDestroyDevice(vk_device_, nullptr);
    vk_device_ = VK_NULL_HANDLE;
  }

  if (vk_instance_) {
    vkDestroyInstance(vk_instance_, nullptr);
    vk_instance_ = VK_NULL_HANDLE;
  }
}

bool VulkanTest::Initialize() {
  if (is_initialized_)
    return false;

  if (!InitVulkan()) {
    PRINT_STDERR("failed to initialize Vulkan");
    return false;
  }

  is_initialized_ = true;

  return true;
}

bool VulkanTest::InitVulkan() {
  VkResult result;

  // Count instance extension properties.
  uint32_t extension_count;
  result = vkEnumerateInstanceExtensionProperties(nullptr, &extension_count, nullptr);
  RTN_IF_VK_ERR(false, result, "vkEnumerateInstanceExtensionProperties");

  // Retrieve instance extension properties into |extension_properties|.
  std::vector<VkExtensionProperties> extension_properties(extension_count);
  result = vkEnumerateInstanceExtensionProperties(nullptr, &extension_count,
                                                  extension_properties.data());
  RTN_IF_VK_ERR(false, result, "vkEnumerateInstanceExtensionProperties");

  // Specify required instance extensions to search for.
  std::array<const char*, 2> instance_extensions{
      VK_KHR_EXTERNAL_SEMAPHORE_CAPABILITIES_EXTENSION_NAME,
      VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME};

  // Verify that all required instance extensions are present.
  uint32_t found_count = 0;
  for (auto& prop : extension_properties) {
    for (uint32_t i = 0; i < instance_extensions.size(); i++) {
      if ((strcmp(prop.extensionName, instance_extensions[i]) == 0))
        found_count++;
    }
  }
  RTN_IF_MSG(false, (found_count != instance_extensions.size()),
             "failed to find instance extensions");

  // Request validation layer if available.
  uint32_t layer_count;
  result = vkEnumerateInstanceLayerProperties(&layer_count, nullptr);
  RTN_IF_VK_ERR(false, result, "vkEnumerateInstanceLayerProperties");

  std::vector<VkLayerProperties> layer_properties(layer_count);
  result = vkEnumerateInstanceLayerProperties(&layer_count, layer_properties.data());

  std::vector<const char*> layers;
  bool found_khr_validation = false;

  for (const auto& property : layer_properties) {
    found_khr_validation =
        found_khr_validation || (strcmp(property.layerName, "VK_LAYER_KHRONOS_validation") == 0);
  }

  // Vulkan loader is needed for loading layers.
  if (found_khr_validation) {
    layers.push_back("VK_LAYER_KHRONOS_validation");
  }

  VkInstanceCreateInfo instance_create_info{
      VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO,  // VkStructureType             sType;
      nullptr,                                 // const void*                 pNext;
      0,                                       // VkInstanceCreateFlags       flags;
      nullptr,                                 // const VkApplicationInfo*    pApplicationInfo;
      static_cast<uint32_t>(layers.size()),    // uint32_t                    enabledLayerCount;
      layers.data(),                           // const char* const*          ppEnabledLayerNames;
      static_cast<uint32_t>(instance_extensions.size()),
      instance_extensions.data(),
  };
  VkAllocationCallbacks* allocation_callbacks = nullptr;
  VkInstance instance;

  // Create instance.
  RTN_IF_VK_ERR(false, vkCreateInstance(&instance_create_info, allocation_callbacks, &instance),
                "vkCreateInstance");

  vk_instance_ = instance;

  // Retrieve available physical devices.
  uint32_t physical_device_count = 0;
  RTN_IF_VK_ERR(false, vkEnumeratePhysicalDevices(instance, &physical_device_count, nullptr),
                "vkEnumeratePhysicalDevices");
  RTN_IF_MSG(false, (physical_device_count < 1), "unexpected physical_device_count %d",
             physical_device_count);

  std::vector<VkPhysicalDevice> physical_devices(physical_device_count);
  RTN_IF_VK_ERR(
      false, vkEnumeratePhysicalDevices(instance, &physical_device_count, physical_devices.data()),
      "vkEnumeratePhysicalDevices");

  // TODO(https://fxbug.dev/322210019): use this to skip tests that are currently broken on
  // Lavapipe.  Eventually all tests should also pass with Lavapipe; delete this when tests pass.
  VkPhysicalDeviceProperties device_properties;
  vkGetPhysicalDeviceProperties(physical_devices[0], &device_properties);
  is_lavapipe_ = 0 == strncmp("llvmpipe", device_properties.deviceName, strlen("llvmpipe"));

  // Always select the first physical device retrieved by default.
  // Select a graphics queue compatible family.
  uint32_t queue_family_count = 0;
  vkGetPhysicalDeviceQueueFamilyProperties(physical_devices[0], &queue_family_count, nullptr);
  RTN_IF_MSG(false, (queue_family_count < 1), "invalid queue_family_count %d", queue_family_count);

  std::vector<VkQueueFamilyProperties> queue_family_properties(queue_family_count);
  vkGetPhysicalDeviceQueueFamilyProperties(physical_devices[0], &queue_family_count,
                                           queue_family_properties.data());

  int32_t queue_family_index = -1;
  for (uint32_t i = 0; i < queue_family_count; i++) {
    if (queue_family_properties[i].queueFlags & VK_QUEUE_GRAPHICS_BIT) {
      queue_family_index = i;
      break;
    }
  }
  RTN_IF_MSG(false, (queue_family_index < 0), "couldn't find an appropriate queue");

  // Empty and reuse |extension_properties| - this time for device extensions.
  extension_properties.clear();

  // Verify that the external semaphore device extensions are available.  If not, bail.
  std::array<const char*, 2> device_extensions{VK_KHR_EXTERNAL_SEMAPHORE_EXTENSION_NAME,
                                               VK_FUCHSIA_EXTERNAL_SEMAPHORE_EXTENSION_NAME};
  result =
      vkEnumerateDeviceExtensionProperties(physical_devices[0], nullptr, &extension_count, nullptr);
  RTN_IF_VK_ERR(false, result, "vkEnumerateDeviceExtensionProperties");

  extension_properties.resize(extension_count);
  result = vkEnumerateDeviceExtensionProperties(physical_devices[0], nullptr, &extension_count,
                                                extension_properties.data());
  RTN_IF_VK_ERR(false, result, "vkEnumerateDeviceExtensionProperties");

  found_count = 0;
  for (const auto& prop : extension_properties) {
    for (uint32_t i = 0; i < device_extensions.size(); i++) {
      if ((strcmp(prop.extensionName, device_extensions[i]) == 0))
        found_count++;
    }
  }
  RTN_IF_MSG(false, (found_count != device_extensions.size()), "failed to find device extensions");

  // Create the device.
  float queue_priorities[1] = {0.0};

  VkDeviceQueueCreateInfo queue_create_info = {.sType = VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO,
                                               .pNext = nullptr,
                                               .flags = 0,
                                               .queueFamilyIndex = 0,
                                               .queueCount = 1,
                                               .pQueuePriorities = queue_priorities};
  VkDeviceCreateInfo device_create_info = {
      .sType = VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO,
      .pNext = nullptr,
      .flags = 0,
      .queueCreateInfoCount = 1,
      .pQueueCreateInfos = &queue_create_info,
      .enabledLayerCount = 0,
      .ppEnabledLayerNames = nullptr,
      .enabledExtensionCount = static_cast<uint32_t>(device_extensions.size()),
      .ppEnabledExtensionNames = device_extensions.data(),
      .pEnabledFeatures = nullptr};
  VkDevice vkdevice;

  result = vkCreateDevice(physical_devices[0], &device_create_info,
                          nullptr /* allocationcallbacks */, &vkdevice);
  RTN_IF_VK_ERR(false, result, "vkCreateDevice");

  vk_physical_device_ = physical_devices[0];
  vk_device_ = vkdevice;

  vkGetDeviceQueue(vkdevice, queue_family_index, 0, &vk_queue_);

  // Get extension function pointers.
  vkGetPhysicalDeviceExternalSemaphorePropertiesKHR_ =
      reinterpret_cast<PFN_vkGetPhysicalDeviceExternalSemaphorePropertiesKHR>(
          vkGetInstanceProcAddr(instance, "vkGetPhysicalDeviceExternalSemaphorePropertiesKHR"));
  RTN_IF_MSG(false, (!vkGetPhysicalDeviceExternalSemaphorePropertiesKHR_),
             "Couldn't find vkGetPhysicalDeviceExternalSemaphorePropertiesKHR");

  vkImportSemaphoreZirconHandleFUCHSIA_ =
      reinterpret_cast<PFN_vkImportSemaphoreZirconHandleFUCHSIA>(
          vkGetDeviceProcAddr(vk_device_, "vkImportSemaphoreZirconHandleFUCHSIA"));
  RTN_IF_MSG(false, (!vkImportSemaphoreZirconHandleFUCHSIA_),
             "Couldn't find vkImportSemaphoreZirconHandleFUCHSIA");

  vkGetSemaphoreZirconHandleFUCHSIA_ = reinterpret_cast<PFN_vkGetSemaphoreZirconHandleFUCHSIA>(
      vkGetDeviceProcAddr(vk_device_, "vkGetSemaphoreZirconHandleFUCHSIA"));
  RTN_IF_MSG(false, (!vkGetSemaphoreZirconHandleFUCHSIA_),
             "Couldn't find vkGetSemaphoreZirconHandleFUCHSIA");

  VerifyZirconEventSemaphoresAreAvailable();

  // Create semaphores configured for export.
  for (uint32_t i = 0; i < kSemaphoreCount; i++) {
    VkExportSemaphoreCreateInfo export_create_info = {
        .sType = VK_STRUCTURE_TYPE_EXPORT_SEMAPHORE_CREATE_INFO_KHR,
        .pNext = nullptr,
        .handleTypes = VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_ZIRCON_EVENT_BIT_FUCHSIA};

    VkSemaphoreCreateInfo semaphore_create_info = {
        .sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO,
        .pNext = &export_create_info,
        .flags = 0,
    };

    VkSemaphore semaphore;
    result = vkCreateSemaphore(vk_device_, &semaphore_create_info, nullptr, &semaphore);
    RTN_IF_VK_ERR(false, result, "vkCreateSemaphore");

    vk_semaphores_[i] = semaphore;
  }

  return true;
}

void VulkanTest::VerifyZirconEventSemaphoresAreAvailable() const {
  // Verify that Zircon event based semaphores are available.
  VkExternalSemaphorePropertiesKHR external_semaphore_properties = {
      .sType = VK_STRUCTURE_TYPE_EXTERNAL_SEMAPHORE_PROPERTIES_KHR,
  };
  VkPhysicalDeviceExternalSemaphoreInfo external_semaphore_info = {
      .sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_SEMAPHORE_INFO_KHR,
      .pNext = nullptr,
      .handleType = VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_ZIRCON_EVENT_BIT_FUCHSIA};
  vkGetPhysicalDeviceExternalSemaphorePropertiesKHR_(vk_physical_device_, &external_semaphore_info,
                                                     &external_semaphore_properties);

  EXPECT_EQ(external_semaphore_properties.compatibleHandleTypes,
            VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_ZIRCON_EVENT_BIT_FUCHSIA);
  EXPECT_EQ(external_semaphore_properties.externalSemaphoreFeatures,
            0u | VK_EXTERNAL_SEMAPHORE_FEATURE_EXPORTABLE_BIT_KHR |
                VK_EXTERNAL_SEMAPHORE_FEATURE_IMPORTABLE_BIT_KHR);
}

bool VulkanTest::Export(VulkanTest* t,
                        std::array<zx_handle_t, kSemaphoreCount>* exported_event_handles) {
  // Create and take ownership of Zircon event handles from the semaphores under |t|
  // that were configured for export.
  for (uint32_t i = 0; i < kSemaphoreCount; i++) {
    VkSemaphoreGetZirconHandleInfoFUCHSIA info{
        .sType = VK_STRUCTURE_TYPE_SEMAPHORE_GET_ZIRCON_HANDLE_INFO_FUCHSIA,
        .pNext = nullptr,
        .semaphore = t->vk_semaphores_[i],
        .handleType = VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_ZIRCON_EVENT_BIT_FUCHSIA,
    };
    VkResult result =
        t->vkGetSemaphoreZirconHandleFUCHSIA_(t->vk_device_, &info, &(*exported_event_handles)[i]);
    RTN_IF_VK_ERR(false, result, "vkGetSemaphoreZirconHandleFUCHSIA");
  }

  return true;
}

bool VulkanTest::Exec(VulkanTest* t1, VulkanTest* t2, bool temporary) {
  std::array<zx_handle_t, kSemaphoreCount> exported_event_handles;
  if (!Export(t1, &exported_event_handles))
    return false;

  // Transfer the ownership of the exported semaphore event handles
  // (the exported semaphore's payload) to Vulkan by importing them into |t2->vk_semaphores_|.
  VkResult result;
  std::vector<std::unique_ptr<magma::PlatformSemaphore>> platform_semaphore_exports;
  for (uint32_t i = 0; i < kSemaphoreCount; i++) {
    platform_semaphore_exports.emplace_back(
        magma::PlatformSemaphore::Import(exported_event_handles[i], 0 /* flags */));
    uint32_t import_handle;
    EXPECT_TRUE(platform_semaphore_exports.back()->duplicate_handle(&import_handle));
    uint32_t flags = temporary ? VK_SEMAPHORE_IMPORT_TEMPORARY_BIT_KHR : 0;
    VkImportSemaphoreZirconHandleInfoFUCHSIA import_info = {
        .sType = VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_ZIRCON_HANDLE_INFO_FUCHSIA,
        .pNext = nullptr,
        .semaphore = t2->vk_semaphores_[i],
        .flags = flags,
        .handleType = VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_ZIRCON_EVENT_BIT_FUCHSIA,
        .zirconHandle = import_handle};

    result = t1->vkImportSemaphoreZirconHandleFUCHSIA_(t2->vk_device_, &import_info);
    RTN_IF_VK_ERR(false, result, "vkImportSemaphoreZirconHandleFUCHSIA");
  }

  // Test semaphores.
  std::fill(exported_event_handles.begin(), exported_event_handles.end(), ZX_HANDLE_INVALID);
  if (!Export(t2, &exported_event_handles))
    return false;

  for (uint32_t i = 0; i < kSemaphoreCount; i++) {
    auto& platform_semaphore_export = platform_semaphore_exports[i];

    // Transfer handle ownership into magma::PlatformSemaphore (zx_event wrapper).
    std::shared_ptr<magma::PlatformSemaphore> platform_semaphore_import =
        magma::PlatformSemaphore::Import(exported_event_handles[i], 0 /* flags */);

    EXPECT_EQ(platform_semaphore_export->id(), platform_semaphore_import->id());

    // Set semaphore state to unsignalled.
    platform_semaphore_export->Reset();

    std::thread thread(
        [platform_semaphore_import] { EXPECT_TRUE(platform_semaphore_import->Wait(2000)); });

    platform_semaphore_export->Signal();
    thread.join();
  }

  return true;
}

bool VulkanTest::ExecUsingQueue(VulkanTest* t1, VulkanTest* t2, bool temporary) {
  VkResult result;

  std::array<zx_handle_t, kSemaphoreCount> exported_event_handles;
  if (!Export(t1, &exported_event_handles))
    return false;

  // Create and take ownership of Zircon event handles from the semaphores under |t1|
  // Transfer the ownership of the exported semaphore event handles
  // (the exported semaphore's payload) to Vulkan by importing them into |t2->vk_semaphores_|.
  for (uint32_t i = 0; i < kSemaphoreCount; i++) {
    uint32_t flags = temporary ? VK_SEMAPHORE_IMPORT_TEMPORARY_BIT_KHR : 0;
    VkImportSemaphoreZirconHandleInfoFUCHSIA import_info = {
        .sType = VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_ZIRCON_HANDLE_INFO_FUCHSIA,
        .pNext = nullptr,
        .semaphore = t2->vk_semaphores_[i],
        .flags = flags,
        .handleType = VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_ZIRCON_EVENT_BIT_FUCHSIA,
        .zirconHandle = exported_event_handles[i]};

    result = t2->vkImportSemaphoreZirconHandleFUCHSIA_(t2->vk_device_, &import_info);
    RTN_IF_VK_ERR(false, result, "vkImportSemaphoreZirconHandleFUCHSIA");
  }

  VkSubmitInfo submit_info1 = {.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO,
                               .signalSemaphoreCount = 1,
                               .pSignalSemaphores = &t1->vk_semaphores_[0]};
  result = vkQueueSubmit(t1->vk_queue_, 1, &submit_info1, VK_NULL_HANDLE);
  RTN_IF_VK_ERR(false, result, "vkQueueSubmit");

  VkPipelineStageFlags stage_flags = VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT;
  VkSubmitInfo submit_info2 = {.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO,
                               .waitSemaphoreCount = 1,
                               .pWaitSemaphores = &t2->vk_semaphores_[0],
                               .pWaitDstStageMask = &stage_flags,
                               .signalSemaphoreCount = 1,
                               .pSignalSemaphores = &t2->vk_semaphores_[1]};
  result = vkQueueSubmit(t2->vk_queue_, 1, &submit_info2, VK_NULL_HANDLE);
  RTN_IF_VK_ERR(false, result, "vkQueueSubmit");

  VkSubmitInfo submit_info3 = {.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO,
                               .waitSemaphoreCount = 1,
                               .pWaitSemaphores = &t1->vk_semaphores_[1],
                               .pWaitDstStageMask = &stage_flags};
  vkQueueSubmit(t1->vk_queue_, 1, &submit_info3, VK_NULL_HANDLE);
  RTN_IF_VK_ERR(false, result, "vkQueueSubmit");

  result = vkQueueWaitIdle(t1->vk_queue_);
  RTN_IF_VK_ERR(false, result, "vkQueueWaitIdle");

  result = vkQueueWaitIdle(t2->vk_queue_);
  RTN_IF_VK_ERR(false, result, "vkQueueWaitIdle");

  return true;
}

TEST(VulkanExtension, ExternalSemaphoreFuchsia) {
  VulkanTest t1;
  VulkanTest t2;
  ASSERT_TRUE(t1.Initialize());
  ASSERT_TRUE(t2.Initialize());
  EXPECT_TRUE(VulkanTest::Exec(&t1, &t2, false));
}

TEST(VulkanExtension, TemporaryExternalSemaphoreFuchsia) {
  VulkanTest t1, t2;
  ASSERT_TRUE(t1.Initialize());
  ASSERT_TRUE(t2.Initialize());
  EXPECT_TRUE(VulkanTest::Exec(&t1, &t2, true));
}

TEST(VulkanExtension, QueueExternalSemaphoreFuchsia) {
  VulkanTest t1, t2;
  ASSERT_TRUE(t1.Initialize());
  ASSERT_TRUE(t2.Initialize());

  // TODO(https://fxbug.dev/42086544)
  if (t1.IsLavapipe()) {
    GTEST_SKIP();
  }

  EXPECT_TRUE(VulkanTest::ExecUsingQueue(&t1, &t2, false));
}

TEST(VulkanExtension, QueueTemporaryExternalSemaphoreFuchsia) {
  VulkanTest t1, t2;
  ASSERT_TRUE(t1.Initialize());
  ASSERT_TRUE(t2.Initialize());

  // TODO(https://fxbug.dev/42086544)
  if (t1.IsLavapipe()) {
    GTEST_SKIP();
  }

  EXPECT_TRUE(VulkanTest::ExecUsingQueue(&t1, &t2, true));
}

}  // namespace