wsi/wayland/surface_properties.cpp

   1 /*
   2  * Copyright (c) 2017-2019, 2021 Arm Limited.
   3  *
   4  * SPDX-License-Identifier: MIT
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to
   8  * deal in the Software without restriction, including without limitation the
   9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24
  25 #define VK_USE_PLATFORM_WAYLAND_KHR 1
  26
  27 #include <wayland-client.h>
  28 #include <linux-dmabuf-unstable-v1-client-protocol.h>
  29
  30 #include <cassert>
  31 #include <cstdlib>
  32 #include <algorithm>
  33 #include <array>
  34 #include <cstring>
  35 #include "surface_properties.hpp"
  36 #include "surface.hpp"
  37 #include "layer/private_data.hpp"
  38 #include "wl_helpers.hpp"
  39 #include "wl_object_owner.hpp"
  40 #include "util/drm/drm_utils.hpp"
  41 #include "util/log.hpp"
  42
  43 #define NELEMS(x) (sizeof(x) / sizeof(x[0]))
  44
  45 namespace wsi
  46 {
  47 namespace wayland
  48 {
  49
  50 surface_properties::surface_properties(surface &wsi_surface, const util::allocator &allocator)
  51    : specific_surface(&wsi_surface)
  52    , supported_formats(allocator)
  53 {
  54 }
  55
  56 surface_properties::surface_properties()
  57    : specific_surface(nullptr)
  58    , supported_formats(util::allocator::get_generic())
  59 {
  60 }
  61
  62 surface_properties &surface_properties::get_instance()
  63 {
  64    static surface_properties instance;
  65    return instance;
  66 }
  67
  68 VkResult surface_properties::get_surface_capabilities(VkPhysicalDevice physical_device, VkSurfaceKHR surface,
  69                                                       VkSurfaceCapabilitiesKHR *pSurfaceCapabilities)
  70 {
  71    /* Image count limits */
  72    pSurfaceCapabilities->minImageCount = 2;
  73    /* There is no maximum theoretically speaking */
  74    pSurfaceCapabilities->maxImageCount = UINT32_MAX;
  75
  76    /* Surface extents */
  77    pSurfaceCapabilities->currentExtent = { 0xffffffff, 0xffffffff };
  78    pSurfaceCapabilities->minImageExtent = { 1, 1 };
  79
  80    /* TODO: Ask the device for max - for now setting the max from the GPU, may be ask the display somehow*/
  81    VkPhysicalDeviceProperties dev_props;
  82    layer::instance_private_data::get(physical_device).disp.GetPhysicalDeviceProperties(physical_device, &dev_props);
  83
  84    pSurfaceCapabilities->maxImageExtent = { dev_props.limits.maxImageDimension2D,
  85                                             dev_props.limits.maxImageDimension2D };
  86    pSurfaceCapabilities->maxImageArrayLayers = 1;
  87
  88    /* Surface transforms */
  89    pSurfaceCapabilities->supportedTransforms = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
  90    pSurfaceCapabilities->currentTransform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
  91
  92    /* TODO: Composite alpha */
  93    pSurfaceCapabilities->supportedCompositeAlpha = static_cast<VkCompositeAlphaFlagBitsKHR>(
  94       VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR | VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR |
  95       VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR | VK_COMPOSITE_ALPHA_POST_MULTIPLIED_BIT_KHR);
  96
  97    /* Image usage flags */
  98    pSurfaceCapabilities->supportedUsageFlags =
  99       VK_IMAGE_USAGE_TRANSFER_SRC_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT | VK_IMAGE_USAGE_SAMPLED_BIT |
 100       VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
 101
 102    return VK_SUCCESS;
 103 }
 104
 105 static VkResult get_vk_supported_formats(const util::vector<drm_format_pair> &drm_supported_formats,
 106                                          vk_format_set &vk_supported_formats)
 107 {
 108    for (const auto &drm_format : drm_supported_formats)
 109    {
 110       const VkFormat vk_format = util::drm::drm_to_vk_format(drm_format.fourcc);
 111       if (vk_format != VK_FORMAT_UNDEFINED)
 112       {
 113          auto it = vk_supported_formats.try_insert(vk_format);
 114          if (!it.has_value())
 115          {
 116             return VK_ERROR_OUT_OF_HOST_MEMORY;
 117          }
 118       }
 119       const VkFormat srgb_vk_format = util::drm::drm_to_vk_srgb_format(drm_format.fourcc);
 120       if (srgb_vk_format != VK_FORMAT_UNDEFINED)
 121       {
 122          auto it = vk_supported_formats.try_insert(srgb_vk_format);
 123          if (!it.has_value())
 124          {
 125             return VK_ERROR_OUT_OF_HOST_MEMORY;
 126          }
 127       }
 128    }
 129    return VK_SUCCESS;
 130 }
 131
 132 VkResult surface_properties::get_surface_formats(VkPhysicalDevice physical_device, VkSurfaceKHR surface,
 133                                                  uint32_t *surfaceFormatCount, VkSurfaceFormatKHR *surfaceFormats)
 134 {
 135    auto &instance = layer::instance_private_data::get(physical_device);
 136
 137    assert(specific_surface);
 138    if (!supported_formats.size())
 139    {
 140       VkResult res = get_vk_supported_formats(specific_surface->get_formats(), supported_formats);
 141       if (res != VK_SUCCESS)
 142       {
 143          return res;
 144       }
 145    }
 146
 147    assert(surfaceFormatCount != nullptr);
 148    if (nullptr == surfaceFormats)
 149    {
 150       *surfaceFormatCount = supported_formats.size();
 151       return VK_SUCCESS;
 152    }
 153
 154    VkResult res = VK_SUCCESS;
 155
 156    if (supported_formats.size() > *surfaceFormatCount)
 157    {
 158       res = VK_INCOMPLETE;
 159    }
 160
 161    uint32_t format_count = 0;
 162    for (const auto &format : supported_formats)
 163    {
 164       if (format_count >= *surfaceFormatCount)
 165       {
 166          break;
 167       }
 168       surfaceFormats[format_count].format = format;
 169       surfaceFormats[format_count++].colorSpace = VK_COLORSPACE_SRGB_NONLINEAR_KHR;
 170    }
 171    *surfaceFormatCount = format_count;
 172
 173    return res;
 174 }
 175
 176 VkResult surface_properties::get_surface_present_modes(VkPhysicalDevice physical_device, VkSurfaceKHR surface,
 177                                                        uint32_t *pPresentModeCount, VkPresentModeKHR *pPresentModes)
 178 {
 179
 180    VkResult res = VK_SUCCESS;
 181
 182    static std::array<const VkPresentModeKHR, 2> modes = {
 183       VK_PRESENT_MODE_FIFO_KHR,
 184       VK_PRESENT_MODE_MAILBOX_KHR,
 185    };
 186
 187    assert(pPresentModeCount != nullptr);
 188
 189    if (nullptr == pPresentModes)
 190    {
 191       *pPresentModeCount = modes.size();
 192    }
 193    else
 194    {
 195       if (modes.size() > *pPresentModeCount)
 196       {
 197          res = VK_INCOMPLETE;
 198       }
 199       *pPresentModeCount = std::min(*pPresentModeCount, static_cast<uint32_t>(modes.size()));
 200       for (uint32_t i = 0; i < *pPresentModeCount; ++i)
 201       {
 202          pPresentModes[i] = modes[i];
 203       }
 204    }
 205
 206    return res;
 207 }
 208
 209 static const char *required_device_extensions[] = {
 210    VK_EXT_IMAGE_DRM_FORMAT_MODIFIER_EXTENSION_NAME,
 211    VK_KHR_BIND_MEMORY_2_EXTENSION_NAME,
 212    VK_KHR_IMAGE_FORMAT_LIST_EXTENSION_NAME,
 213    VK_KHR_SAMPLER_YCBCR_CONVERSION_EXTENSION_NAME,
 214    VK_KHR_MAINTENANCE1_EXTENSION_NAME,
 215    VK_KHR_GET_MEMORY_REQUIREMENTS_2_EXTENSION_NAME,
 216    VK_EXT_EXTERNAL_MEMORY_DMA_BUF_EXTENSION_NAME,
 217    VK_KHR_EXTERNAL_MEMORY_FD_EXTENSION_NAME,
 218    VK_KHR_EXTERNAL_MEMORY_EXTENSION_NAME,
 219 };
 220
 221 VkResult surface_properties::get_required_device_extensions(util::extension_list &extension_list)
 222 {
 223    return extension_list.add(required_device_extensions, NELEMS(required_device_extensions));
 224 }
 225
 226 /* TODO: Check for zwp_linux_dmabuf_v1 protocol in display */
 227 VkBool32 GetPhysicalDeviceWaylandPresentationSupportKHR(VkPhysicalDevice physical_device, uint32_t queue_index,
 228                                                         struct wl_display *display)
 229 {
 230    return VK_TRUE;
 231 }
 232
 233 extern "C" VkResult CreateWaylandSurfaceKHR(VkInstance instance, const VkWaylandSurfaceCreateInfoKHR *pCreateInfo,
 234                                             const VkAllocationCallbacks *pAllocator, VkSurfaceKHR *pSurface)
 235 {
 236    auto &instance_data = layer::instance_private_data::get(instance);
 237    util::allocator allocator{ instance_data.get_allocator(), VK_SYSTEM_ALLOCATION_SCOPE_OBJECT, pAllocator };
 238    auto wsi_surface = surface::make_surface(allocator, pCreateInfo->display, pCreateInfo->surface);
 239    if (wsi_surface == nullptr)
 240    {
 241       return VK_ERROR_OUT_OF_HOST_MEMORY;
 242    }
 243
 244    VkResult res = instance_data.disp.CreateWaylandSurfaceKHR(instance, pCreateInfo, pAllocator, pSurface);
 245    if (res == VK_SUCCESS)
 246    {
 247       auto surface_base = util::unique_ptr<wsi::surface>(std::move(wsi_surface));
 248       res = instance_data.add_surface(*pSurface, surface_base);
 249       if (res != VK_SUCCESS)
 250       {
 251          instance_data.disp.DestroySurfaceKHR(instance, *pSurface, pAllocator);
 252       }
 253    }
 254    return res;
 255 }
 256
 257 PFN_vkVoidFunction surface_properties::get_proc_addr(const char *name)
 258 {
 259    if (strcmp(name, "vkGetPhysicalDeviceWaylandPresentationSupportKHR") == 0)
 260    {
 261       return reinterpret_cast<PFN_vkVoidFunction>(GetPhysicalDeviceWaylandPresentationSupportKHR);
 262    }
 263    else if (strcmp(name, "vkCreateWaylandSurfaceKHR") == 0)
 264    {
 265       return reinterpret_cast<PFN_vkVoidFunction>(CreateWaylandSurfaceKHR);
 266    }
 267    return nullptr;
 268 }
 269
 270 } // namespace wayland
 271 } // namespace wsi