vulkan-wsi-layer/wsi/display/surface_properties.cpp
Iason Paraskevopoulos b02e682d30 Update present timing types
Updates the present timing implementation and types to be aligned with
the latest commit.

Fixes an issue, where the queue used for the presentation feedback
events was destroyed before getting the last events.

Signed-off-by: Iason Paraskevopoulos <iason.paraskevopoulos@arm.com>
Change-Id: I1dba2fd0e4ad9ec8c02d71c58c93edceaa75d07e
2025-09-04 17:48:10 +01:00

606 lines
No EOL
22 KiB
C++

/*
* Copyright (c) 2024-2025 Arm Limited.
*
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#include <cstring>
#include <algorithm>
#include "surface_properties.hpp"
#include "surface.hpp"
#include "util/macros.hpp"
namespace wsi
{
namespace display
{
constexpr int max_core_1_0_formats = VK_FORMAT_ASTC_12x12_SRGB_BLOCK + 1;
void surface_properties::populate_present_mode_compatibilities()
{
std::array<present_mode_compatibility, 1> compatible_present_modes_list = { present_mode_compatibility{
VK_PRESENT_MODE_FIFO_KHR, 1, { VK_PRESENT_MODE_FIFO_KHR } } };
m_compatible_present_modes = compatible_present_modes<1>(compatible_present_modes_list);
}
surface_properties::surface_properties(surface *wsi_surface)
: m_specific_surface(wsi_surface)
, m_supported_modes({ VK_PRESENT_MODE_FIFO_KHR })
{
populate_present_mode_compatibilities();
}
surface_properties::surface_properties()
: surface_properties(nullptr)
{
}
VkResult surface_properties::get_surface_capabilities(VkPhysicalDevice physical_device,
VkSurfaceCapabilitiesKHR *pSurfaceCapabilities)
{
get_surface_capabilities_common(physical_device, pSurfaceCapabilities);
if (m_specific_surface != nullptr)
{
pSurfaceCapabilities->currentExtent = m_specific_surface->get_extent();
pSurfaceCapabilities->minImageExtent = m_specific_surface->get_extent();
pSurfaceCapabilities->maxImageExtent = m_specific_surface->get_extent();
}
/* Image count limits */
pSurfaceCapabilities->minImageCount = 2;
pSurfaceCapabilities->maxImageCount = 3;
/* Composite alpha */
pSurfaceCapabilities->supportedCompositeAlpha =
static_cast<VkCompositeAlphaFlagBitsKHR>(VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR | VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR);
return VK_SUCCESS;
}
VkResult surface_properties::get_surface_capabilities(VkPhysicalDevice physical_device,
const VkPhysicalDeviceSurfaceInfo2KHR *pSurfaceInfo,
VkSurfaceCapabilities2KHR *pSurfaceCapabilities)
{
TRY(check_surface_present_mode_query_is_supported(pSurfaceInfo, m_supported_modes));
/* Image count limits */
get_surface_capabilities(physical_device, &pSurfaceCapabilities->surfaceCapabilities);
m_compatible_present_modes.get_surface_present_mode_compatibility_common(pSurfaceInfo, pSurfaceCapabilities);
auto surface_scaling_capabilities = util::find_extension<VkSurfacePresentScalingCapabilitiesEXT>(
VK_STRUCTURE_TYPE_SURFACE_PRESENT_SCALING_CAPABILITIES_EXT, pSurfaceCapabilities);
if (surface_scaling_capabilities != nullptr)
{
get_surface_present_scaling_and_gravity(surface_scaling_capabilities);
surface_scaling_capabilities->minScaledImageExtent = pSurfaceCapabilities->surfaceCapabilities.minImageExtent;
surface_scaling_capabilities->maxScaledImageExtent = pSurfaceCapabilities->surfaceCapabilities.maxImageExtent;
}
auto present_id2_surface_cap = util::find_extension<VkSurfaceCapabilitiesPresentId2KHR>(
VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_PRESENT_ID_2_KHR, pSurfaceCapabilities->pNext);
if (present_id2_surface_cap != nullptr)
{
present_id2_surface_cap->presentId2Supported = VK_TRUE;
}
#if VULKAN_WSI_LAYER_EXPERIMENTAL
auto present_wait2_surface_cap = util::find_extension<VkSurfaceCapabilitiesPresentWait2KHR>(
VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_PRESENT_WAIT_2_KHR, pSurfaceCapabilities->pNext);
if (present_wait2_surface_cap != nullptr)
{
present_wait2_surface_cap->presentWait2Supported = VK_TRUE;
}
#endif
return VK_SUCCESS;
}
VkResult surface_properties::get_surface_formats(VkPhysicalDevice physical_device, uint32_t *surfaceFormatCount,
VkSurfaceFormatKHR *surfaceFormats,
VkSurfaceFormat2KHR *extended_surface_formats)
{
auto &display = drm_display::get_display();
if (!display.has_value())
{
return VK_ERROR_SURFACE_LOST_KHR;
}
auto display_formats = display->get_supported_formats();
uint32_t format_count = 0;
assert(display_formats->size() > 0);
assert(display_formats->size() <= max_core_1_0_formats);
std::array<surface_format_properties, max_core_1_0_formats> formats{};
for (const auto &drm_format : *display_formats)
{
auto vk_format = util::drm::drm_to_vk_format(drm_format.fourcc);
if (VK_FORMAT_UNDEFINED != vk_format)
{
formats[format_count] = surface_format_properties{ vk_format };
VkPhysicalDeviceImageFormatInfo2KHR format_info = { VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2_KHR,
nullptr,
vk_format,
VK_IMAGE_TYPE_2D,
VK_IMAGE_TILING_OPTIMAL,
VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
0 };
VkResult res = formats[format_count].check_device_support(physical_device, format_info);
if (VK_SUCCESS == res)
{
if (layer::instance_private_data::get(physical_device).has_image_compression_support(physical_device))
{
formats[format_count].add_device_compression_support(physical_device, format_info);
}
format_count++;
}
}
/* Certain 8-bit UNORM formats can be interpreted as both UNORM and sRGB by Vulkan, so expose both formats.
* The colorSpace value is how the presentation engine interprets the format.
* The linearity of VkFormat and the display format may be different.
*/
auto vk_srgb_format = util::drm::drm_to_vk_srgb_format(drm_format.fourcc);
if (VK_FORMAT_UNDEFINED != vk_srgb_format)
{
formats[format_count] = surface_format_properties{ vk_srgb_format };
VkPhysicalDeviceImageFormatInfo2KHR format_info = { VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2_KHR,
nullptr,
vk_format,
VK_IMAGE_TYPE_2D,
VK_IMAGE_TILING_OPTIMAL,
VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT,
0 };
VkResult res = formats[format_count].check_device_support(physical_device, format_info);
if (VK_SUCCESS == res)
{
if (layer::instance_private_data::get(physical_device).has_image_compression_support(physical_device))
{
formats[format_count].add_device_compression_support(physical_device, format_info);
}
format_count++;
}
}
}
return surface_properties_formats_helper(formats.begin(), formats.begin() + format_count, surfaceFormatCount,
surfaceFormats, extended_surface_formats);
}
VkResult surface_properties::get_surface_present_modes(VkPhysicalDevice physical_device, VkSurfaceKHR surface,
uint32_t *pPresentModeCount, VkPresentModeKHR *pPresentModes)
{
UNUSED(physical_device);
UNUSED(surface);
return get_surface_present_modes_common(pPresentModeCount, pPresentModes, m_supported_modes);
}
VWL_VKAPI_CALL(VkResult)
CreateDisplayModeKHR(VkPhysicalDevice physicalDevice, VkDisplayKHR display,
const VkDisplayModeCreateInfoKHR *pCreateInfo, const VkAllocationCallbacks *pAllocator,
VkDisplayModeKHR *pMode)
{
UNUSED(physicalDevice);
UNUSED(pAllocator);
assert(display != VK_NULL_HANDLE);
assert(pMode != nullptr);
assert(pCreateInfo != nullptr);
assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR);
assert(pCreateInfo->pNext == NULL);
assert(pCreateInfo->flags == 0);
drm_display *dpy = reinterpret_cast<drm_display *>(display);
const VkDisplayModeParametersKHR *params = &pCreateInfo->parameters;
if (params->visibleRegion.width == 0 || params->visibleRegion.height == 0 || params->refreshRate == 0)
{
return VK_ERROR_INITIALIZATION_FAILED;
}
auto *mode = std::find_if(dpy->get_display_modes_begin(), dpy->get_display_modes_end(), [params](auto &mode) {
return mode.get_width() == params->visibleRegion.width && mode.get_height() == params->visibleRegion.height &&
mode.get_refresh_rate() == params->refreshRate;
});
if (mode != dpy->get_display_modes_end())
{
*pMode = reinterpret_cast<VkDisplayModeKHR>(mode);
return VK_SUCCESS;
}
return VK_ERROR_INITIALIZATION_FAILED;
}
VWL_VKAPI_CALL(VkResult)
CreateDisplayPlaneSurfaceKHR(VkInstance instance, const VkDisplaySurfaceCreateInfoKHR *pCreateInfo,
const VkAllocationCallbacks *pAllocator, VkSurfaceKHR *pSurface)
{
auto &instance_data = layer::instance_private_data::get(instance);
util::allocator allocator{ instance_data.get_allocator(), VK_SYSTEM_ALLOCATION_SCOPE_OBJECT, pAllocator };
drm_display_mode *display_mode = reinterpret_cast<drm_display_mode *>(pCreateInfo->displayMode);
VkResult res = instance_data.disp.CreateDisplayPlaneSurfaceKHR(instance, pCreateInfo, pAllocator, pSurface);
if (res == VK_SUCCESS)
{
auto wsi_surface = allocator.make_unique<surface>(display_mode, pCreateInfo->imageExtent);
if (wsi_surface == nullptr)
{
return VK_ERROR_OUT_OF_HOST_MEMORY;
}
auto surface_base = util::unique_ptr<wsi::surface>(std::move(wsi_surface));
res = instance_data.add_surface(*pSurface, surface_base);
if (res != VK_SUCCESS)
{
instance_data.disp.DestroySurfaceKHR(instance, *pSurface, pAllocator);
}
}
return res;
}
VWL_VKAPI_CALL(VkResult)
GetDisplayModePropertiesKHR(VkPhysicalDevice physicalDevice, VkDisplayKHR display, uint32_t *pPropertyCount,
VkDisplayModePropertiesKHR *pProperties)
{
UNUSED(physicalDevice);
assert(display != VK_NULL_HANDLE);
assert(pPropertyCount != nullptr);
drm_display *dpy = reinterpret_cast<drm_display *>(display);
assert(dpy != nullptr);
drm_display_mode *modes{ dpy->get_display_modes_begin() };
size_t num_modes{ dpy->get_num_display_modes() };
if (pProperties == nullptr)
{
*pPropertyCount = num_modes;
return VK_SUCCESS;
}
uint32_t nr_properties = std::min(*pPropertyCount, static_cast<uint32_t>(num_modes));
*pPropertyCount = 0;
std::for_each(modes, modes + nr_properties, [&pProperties, &pPropertyCount](auto &mode) {
VkDisplayModePropertiesKHR properties = {};
VkDisplayModeKHR display_mode = reinterpret_cast<VkDisplayModeKHR>(&mode);
properties.displayMode = display_mode;
VkDisplayModeParametersKHR parameters{};
parameters.visibleRegion = { mode.get_width(), mode.get_height() };
parameters.refreshRate = mode.get_refresh_rate();
properties.parameters = parameters;
pProperties[*pPropertyCount] = properties;
*pPropertyCount += 1;
});
if (*pPropertyCount < static_cast<uint32_t>(num_modes))
{
return VK_INCOMPLETE;
}
return VK_SUCCESS;
}
VWL_VKAPI_CALL(VkResult)
GetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode, uint32_t planeIndex,
VkDisplayPlaneCapabilitiesKHR *pCapabilities)
{
UNUSED(physicalDevice);
UNUSED(planeIndex);
assert(physicalDevice != VK_NULL_HANDLE);
assert(mode != VK_NULL_HANDLE);
assert(pCapabilities != nullptr);
drm_display_mode *display_mode = reinterpret_cast<drm_display_mode *>(mode);
assert(display_mode != nullptr);
auto &display = drm_display::get_display();
if (!display.has_value())
{
WSI_LOG_ERROR("DRM display not available.");
return VK_ERROR_OUT_OF_HOST_MEMORY;
}
/* Implementation supports only one plane for presenting
* images. Therefore plane index must be 0. */
assert(planeIndex == 0);
auto valid_mode =
std::find_if(display->get_display_modes_begin(), display->get_display_modes_end(), [&display_mode](auto &mode) {
return (display_mode->get_width() == mode.get_width()) && (display_mode->get_height() == mode.get_height()) &&
(display_mode->get_refresh_rate() == mode.get_refresh_rate());
});
assert(valid_mode != display->get_display_modes_end());
UNUSED(valid_mode);
VkDisplayPlaneCapabilitiesKHR planeCapabilities{};
planeCapabilities.supportedAlpha = VK_DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR;
planeCapabilities.minSrcPosition = { 0, 0 };
planeCapabilities.maxSrcPosition = { 0, 0 };
/* Implementation allows swapchains to be a subset of the display area. */
planeCapabilities.minSrcExtent = { 0, 0 };
planeCapabilities.maxSrcExtent = { display_mode->get_width(), display_mode->get_height() };
planeCapabilities.minDstPosition = { 0, 0 };
planeCapabilities.maxDstPosition = { 0, 0 };
planeCapabilities.minDstExtent = { display_mode->get_width(), display_mode->get_height() };
planeCapabilities.maxDstExtent = { display_mode->get_width(), display_mode->get_height() };
*pCapabilities = planeCapabilities;
return VK_SUCCESS;
}
VWL_VKAPI_CALL(VkResult)
GetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, uint32_t planeIndex, uint32_t *pDisplayCount,
VkDisplayKHR *pDisplays)
{
UNUSED(physicalDevice);
UNUSED(planeIndex);
assert(physicalDevice != VK_NULL_HANDLE);
assert(pDisplayCount != nullptr);
auto &display = drm_display::get_display();
if (!display.has_value())
{
WSI_LOG_ERROR("DRM display not available.");
return VK_ERROR_OUT_OF_HOST_MEMORY;
}
/* Implementation supports only one plane for presenting
* images. Therefore plane index must be 0. */
assert(planeIndex == 0);
if (pDisplays == nullptr)
{
/* Implementation will expose just one (the main)
* plane for the application to use. */
*pDisplayCount = 1;
return VK_SUCCESS;
}
if (*pDisplayCount == 0)
{
return VK_INCOMPLETE;
}
*pDisplays = reinterpret_cast<VkDisplayKHR>(&display.value());
*pDisplayCount = 1;
return VK_SUCCESS;
}
VWL_VKAPI_CALL(VkResult)
GetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice, uint32_t *pPropertyCount,
VkDisplayPlanePropertiesKHR *pProperties)
{
UNUSED(physicalDevice);
assert(physicalDevice != VK_NULL_HANDLE);
assert(pPropertyCount != nullptr);
auto &display = drm_display::get_display();
if (!display.has_value())
{
*pPropertyCount = 0;
return VK_SUCCESS;
}
if (pProperties == nullptr)
{
/* Implementation will expose just one (the main)
* plane for the application to use. */
*pPropertyCount = 1;
return VK_SUCCESS;
}
if (*pPropertyCount == 0)
{
return VK_INCOMPLETE;
}
VkDisplayPlanePropertiesKHR planeProperties{};
planeProperties.currentDisplay = reinterpret_cast<VkDisplayKHR>(&display.value());
/* Since the implementation is exposing just one plane the value for
* the current stack index must be 0.*/
planeProperties.currentStackIndex = 0;
*pProperties = planeProperties;
*pPropertyCount = 1;
return VK_SUCCESS;
}
VWL_VKAPI_CALL(VkResult)
GetPhysicalDeviceDisplayPropertiesKHR(VkPhysicalDevice physicalDevice, uint32_t *pPropertyCount,
VkDisplayPropertiesKHR *pProperties)
{
UNUSED(physicalDevice);
assert(physicalDevice != VK_NULL_HANDLE);
assert(pPropertyCount != nullptr);
auto &display = drm_display::get_display();
if (!display.has_value())
{
*pPropertyCount = 0;
return VK_SUCCESS;
}
if (pProperties == nullptr)
{
*pPropertyCount = 1;
return VK_SUCCESS;
}
if (*pPropertyCount == 0)
{
return VK_INCOMPLETE;
}
*pPropertyCount = 1;
VkDisplayPropertiesKHR display_properties = {};
display_properties.display = reinterpret_cast<VkDisplayKHR>(&display.value());
display_properties.displayName = "DRM display";
display_properties.physicalDimensions = { display->get_connector()->mmWidth, display->get_connector()->mmHeight };
display_properties.physicalResolution = { display->get_max_width(), display->get_max_height() };
display_properties.supportedTransforms = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
display_properties.planeReorderPossible = VK_FALSE;
display_properties.persistentContent = VK_FALSE;
*pProperties = display_properties;
return VK_SUCCESS;
}
PFN_vkVoidFunction surface_properties::get_proc_addr(const char *name)
{
if (strcmp(name, "vkCreateDisplayModeKHR") == 0)
{
return reinterpret_cast<PFN_vkVoidFunction>(CreateDisplayModeKHR);
}
else if (strcmp(name, "vkCreateDisplayPlaneSurfaceKHR") == 0)
{
return reinterpret_cast<PFN_vkVoidFunction>(CreateDisplayPlaneSurfaceKHR);
}
else if (strcmp(name, "vkGetDisplayModePropertiesKHR") == 0)
{
return reinterpret_cast<PFN_vkVoidFunction>(GetDisplayModePropertiesKHR);
}
else if (strcmp(name, "vkGetDisplayPlaneCapabilitiesKHR") == 0)
{
return reinterpret_cast<PFN_vkVoidFunction>(GetDisplayPlaneCapabilitiesKHR);
}
else if (strcmp(name, "vkGetDisplayPlaneSupportedDisplaysKHR") == 0)
{
return reinterpret_cast<PFN_vkVoidFunction>(GetDisplayPlaneSupportedDisplaysKHR);
}
else if (strcmp(name, "vkGetPhysicalDeviceDisplayPlanePropertiesKHR") == 0)
{
return reinterpret_cast<PFN_vkVoidFunction>(GetPhysicalDeviceDisplayPlanePropertiesKHR);
}
else if (strcmp(name, "vkGetPhysicalDeviceDisplayPropertiesKHR") == 0)
{
return reinterpret_cast<PFN_vkVoidFunction>(GetPhysicalDeviceDisplayPropertiesKHR);
}
return nullptr;
}
VkResult surface_properties::get_required_instance_extensions(util::extension_list &extension_list,
const uint32_t api_version)
{
VkResult result = VK_SUCCESS;
/* Enable extensions that were promoted to core in Vulkan 1.1 when using API versions < 1.1 */
if (api_version < VK_API_VERSION_1_1)
{
const std::array required_extensions_pre_vulkan_1_1{
VK_KHR_GET_PHYSICAL_DEVICE_PROPERTIES_2_EXTENSION_NAME,
};
result = extension_list.add(required_extensions_pre_vulkan_1_1.data(), required_extensions_pre_vulkan_1_1.size());
}
return result;
}
VkResult surface_properties::get_required_device_extensions(util::extension_list &extension_list,
const uint32_t api_version)
{
VkResult result = VK_SUCCESS;
const std::array required_device_extensions{
VK_KHR_EXTERNAL_MEMORY_FD_EXTENSION_NAME,
};
result = extension_list.add(required_device_extensions.data(), required_device_extensions.size());
if (result != VK_SUCCESS)
{
return result;
}
/* Enable extensions that were promoted to core in Vulkan 1.1 when using API versions < 1.1 */
if (api_version < VK_API_VERSION_1_1)
{
const std::array required_extensions_pre_vulkan_1_1{
VK_KHR_BIND_MEMORY_2_EXTENSION_NAME,
};
result = extension_list.add(required_extensions_pre_vulkan_1_1.data(), required_extensions_pre_vulkan_1_1.size());
}
return result;
}
bool surface_properties::is_surface_extension_enabled(const layer::instance_private_data &instance_data)
{
return instance_data.is_instance_extension_enabled(VK_KHR_SURFACE_EXTENSION_NAME);
}
#if VULKAN_WSI_LAYER_EXPERIMENTAL
VkResult surface_properties::get_present_timing_surface_caps(
VkPhysicalDevice, VkPresentTimingSurfaceCapabilitiesEXT *present_timing_surface_caps)
{
present_timing_surface_caps->presentTimingSupported = VK_FALSE;
present_timing_surface_caps->presentAtAbsoluteTimeSupported = VK_FALSE;
present_timing_surface_caps->presentAtRelativeTimeSupported = VK_FALSE;
present_timing_surface_caps->presentStageQueries = 0;
return VK_SUCCESS;
}
#endif
surface_properties &surface_properties::get_instance()
{
static surface_properties instance;
return instance;
}
void surface_properties::get_surface_present_scaling_and_gravity(
VkSurfacePresentScalingCapabilitiesEXT *scaling_capabilities)
{
scaling_capabilities->supportedPresentScaling = VK_PRESENT_SCALING_ONE_TO_ONE_BIT_EXT;
scaling_capabilities->supportedPresentGravityX = VK_PRESENT_GRAVITY_MIN_BIT_EXT;
scaling_capabilities->supportedPresentGravityY = VK_PRESENT_GRAVITY_MIN_BIT_EXT;
}
bool surface_properties::is_compatible_present_modes(VkPresentModeKHR present_mode_a, VkPresentModeKHR present_mode_b)
{
return m_compatible_present_modes.is_compatible_present_modes(present_mode_a, present_mode_b);
}
} /* namespace display */
} /* namespace wsi */