src/vulkan/wsi/wsi_common_wayland.c

   1 /*
   2  * Copyright © 2015 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #include <wayland-client.h>
  25
  26 #include <assert.h>
  27 #include <stdlib.h>
  28 #include <stdio.h>
  29 #include <unistd.h>
  30 #include <errno.h>
  31 #include <string.h>
  32 #include <pthread.h>
  33
  34 #include <drm_fourcc.h>
  35
  36 #include "vk_util.h"
  37 #include "wsi_common_private.h"
  38 #include "wsi_common_wayland.h"
  39 #include "wayland-drm-client-protocol.h"
  40 #include "linux-dmabuf-unstable-v1-client-protocol.h"
  41
  42 #include <util/hash_table.h>
  43 #include <util/u_vector.h>
  44
  45 #define typed_memcpy(dest, src, count) ({ \
  46    STATIC_ASSERT(sizeof(*src) == sizeof(*dest)); \
  47    memcpy((dest), (src), (count) * sizeof(*(src))); \
  48 })
  49
  50 struct wsi_wayland;
  51
  52 struct wsi_wl_display {
  53    /* The real wl_display */
  54    struct wl_display *                          wl_display;
  55    /* Actually a proxy wrapper around the event queue */
  56    struct wl_display *                          wl_display_wrapper;
  57    struct wl_event_queue *                      queue;
  58    struct wl_drm *                              drm;
  59    struct zwp_linux_dmabuf_v1 *                 dmabuf;
  60
  61    struct wsi_wayland *wsi_wl;
  62    /* Vector of VkFormats supported */
  63    struct u_vector                            formats;
  64
  65    struct {
  66       struct u_vector                           argb8888;
  67       struct u_vector                           xrgb8888;
  68    } modifiers;
  69
  70    uint32_t                                     capabilities;
  71
  72    /* Only used for displays created by wsi_wl_display_create */
  73    uint32_t                                     refcount;
  74 };
  75
  76 struct wsi_wayland {
  77    struct wsi_interface                     base;
  78
  79    struct wsi_device *wsi;
  80
  81    const VkAllocationCallbacks *alloc;
  82    VkPhysicalDevice physical_device;
  83 };
  84
  85 static void
  86 wsi_wl_display_add_vk_format(struct wsi_wl_display *display, VkFormat format)
  87 {
  88    /* Don't add a format that's already in the list */
  89    VkFormat *f;
  90    u_vector_foreach(f, &display->formats)
  91       if (*f == format)
  92          return;
  93
  94    /* Don't add formats that aren't renderable. */
  95    VkFormatProperties props;
  96
  97    display->wsi_wl->wsi->GetPhysicalDeviceFormatProperties(display->wsi_wl->physical_device,
  98                                                            format, &props);
  99    if (!(props.optimalTilingFeatures & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT))
 100       return;
 101
 102    f = u_vector_add(&display->formats);
 103    if (f)
 104       *f = format;
 105 }
 106
 107 static void
 108 drm_handle_device(void *data, struct wl_drm *drm, const char *name)
 109 {
 110 }
 111
 112 static uint32_t
 113 wl_drm_format_for_vk_format(VkFormat vk_format, bool alpha)
 114 {
 115    switch (vk_format) {
 116    /* TODO: Figure out what all the formats mean and make this table
 117     * correct.
 118     */
 119 #if 0
 120    case VK_FORMAT_R4G4B4A4_UNORM:
 121       return alpha ? WL_DRM_FORMAT_ABGR4444 : WL_DRM_FORMAT_XBGR4444;
 122    case VK_FORMAT_R5G6B5_UNORM:
 123       return WL_DRM_FORMAT_BGR565;
 124    case VK_FORMAT_R5G5B5A1_UNORM:
 125       return alpha ? WL_DRM_FORMAT_ABGR1555 : WL_DRM_FORMAT_XBGR1555;
 126    case VK_FORMAT_R8G8B8_UNORM:
 127       return WL_DRM_FORMAT_XBGR8888;
 128    case VK_FORMAT_R8G8B8A8_UNORM:
 129       return alpha ? WL_DRM_FORMAT_ABGR8888 : WL_DRM_FORMAT_XBGR8888;
 130    case VK_FORMAT_R10G10B10A2_UNORM:
 131       return alpha ? WL_DRM_FORMAT_ABGR2101010 : WL_DRM_FORMAT_XBGR2101010;
 132    case VK_FORMAT_B4G4R4A4_UNORM:
 133       return alpha ? WL_DRM_FORMAT_ARGB4444 : WL_DRM_FORMAT_XRGB4444;
 134    case VK_FORMAT_B5G6R5_UNORM:
 135       return WL_DRM_FORMAT_RGB565;
 136    case VK_FORMAT_B5G5R5A1_UNORM:
 137       return alpha ? WL_DRM_FORMAT_XRGB1555 : WL_DRM_FORMAT_XRGB1555;
 138 #endif
 139    case VK_FORMAT_B8G8R8_UNORM:
 140    case VK_FORMAT_B8G8R8_SRGB:
 141       return WL_DRM_FORMAT_BGRX8888;
 142    case VK_FORMAT_B8G8R8A8_UNORM:
 143    case VK_FORMAT_B8G8R8A8_SRGB:
 144       return alpha ? WL_DRM_FORMAT_ARGB8888 : WL_DRM_FORMAT_XRGB8888;
 145 #if 0
 146    case VK_FORMAT_B10G10R10A2_UNORM:
 147       return alpha ? WL_DRM_FORMAT_ARGB2101010 : WL_DRM_FORMAT_XRGB2101010;
 148 #endif
 149
 150    default:
 151       assert(!"Unsupported Vulkan format");
 152       return 0;
 153    }
 154 }
 155
 156 static void
 157 drm_handle_format(void *data, struct wl_drm *drm, uint32_t wl_format)
 158 {
 159    struct wsi_wl_display *display = data;
 160    if (display->formats.element_size == 0)
 161       return;
 162
 163    switch (wl_format) {
 164 #if 0
 165    case WL_DRM_FORMAT_ABGR4444:
 166    case WL_DRM_FORMAT_XBGR4444:
 167       wsi_wl_display_add_vk_format(display, VK_FORMAT_R4G4B4A4_UNORM);
 168       break;
 169    case WL_DRM_FORMAT_BGR565:
 170       wsi_wl_display_add_vk_format(display, VK_FORMAT_R5G6B5_UNORM);
 171       break;
 172    case WL_DRM_FORMAT_ABGR1555:
 173    case WL_DRM_FORMAT_XBGR1555:
 174       wsi_wl_display_add_vk_format(display, VK_FORMAT_R5G5B5A1_UNORM);
 175       break;
 176    case WL_DRM_FORMAT_XBGR8888:
 177       wsi_wl_display_add_vk_format(display, VK_FORMAT_R8G8B8_UNORM);
 178       /* fallthrough */
 179    case WL_DRM_FORMAT_ABGR8888:
 180       wsi_wl_display_add_vk_format(display, VK_FORMAT_R8G8B8A8_UNORM);
 181       break;
 182    case WL_DRM_FORMAT_ABGR2101010:
 183    case WL_DRM_FORMAT_XBGR2101010:
 184       wsi_wl_display_add_vk_format(display, VK_FORMAT_R10G10B10A2_UNORM);
 185       break;
 186    case WL_DRM_FORMAT_ARGB4444:
 187    case WL_DRM_FORMAT_XRGB4444:
 188       wsi_wl_display_add_vk_format(display, VK_FORMAT_B4G4R4A4_UNORM);
 189       break;
 190    case WL_DRM_FORMAT_RGB565:
 191       wsi_wl_display_add_vk_format(display, VK_FORMAT_B5G6R5_UNORM);
 192       break;
 193    case WL_DRM_FORMAT_ARGB1555:
 194    case WL_DRM_FORMAT_XRGB1555:
 195       wsi_wl_display_add_vk_format(display, VK_FORMAT_B5G5R5A1_UNORM);
 196       break;
 197 #endif
 198    case WL_DRM_FORMAT_XRGB8888:
 199       wsi_wl_display_add_vk_format(display, VK_FORMAT_B8G8R8_SRGB);
 200       wsi_wl_display_add_vk_format(display, VK_FORMAT_B8G8R8_UNORM);
 201       /* fallthrough */
 202    case WL_DRM_FORMAT_ARGB8888:
 203       wsi_wl_display_add_vk_format(display, VK_FORMAT_B8G8R8A8_SRGB);
 204       wsi_wl_display_add_vk_format(display, VK_FORMAT_B8G8R8A8_UNORM);
 205       break;
 206 #if 0
 207    case WL_DRM_FORMAT_ARGB2101010:
 208    case WL_DRM_FORMAT_XRGB2101010:
 209       wsi_wl_display_add_vk_format(display, VK_FORMAT_B10G10R10A2_UNORM);
 210       break;
 211 #endif
 212    }
 213 }
 214
 215 static void
 216 drm_handle_authenticated(void *data, struct wl_drm *drm)
 217 {
 218 }
 219
 220 static void
 221 drm_handle_capabilities(void *data, struct wl_drm *drm, uint32_t capabilities)
 222 {
 223    struct wsi_wl_display *display = data;
 224
 225    display->capabilities = capabilities;
 226 }
 227
 228 static const struct wl_drm_listener drm_listener = {
 229    drm_handle_device,
 230    drm_handle_format,
 231    drm_handle_authenticated,
 232    drm_handle_capabilities,
 233 };
 234
 235 static void
 236 dmabuf_handle_format(void *data, struct zwp_linux_dmabuf_v1 *dmabuf,
 237                      uint32_t format)
 238 {
 239    /* Formats are implicitly advertised by the modifier event, so we ignore
 240     * them here. */
 241 }
 242
 243 static void
 244 dmabuf_handle_modifier(void *data, struct zwp_linux_dmabuf_v1 *dmabuf,
 245                        uint32_t format, uint32_t modifier_hi,
 246                        uint32_t modifier_lo)
 247 {
 248    struct wsi_wl_display *display = data;
 249    uint64_t *mod = NULL;
 250
 251    /* If we're not fetching formats, don't fetch modifiers either. */
 252    if (display->formats.element_size == 0)
 253       return;
 254
 255    if (modifier_hi == (DRM_FORMAT_MOD_INVALID >> 32) &&
 256        modifier_lo == (DRM_FORMAT_MOD_INVALID & 0xffffffff))
 257       return;
 258
 259    switch (format) {
 260    case WL_DRM_FORMAT_ARGB8888:
 261       mod = u_vector_add(&display->modifiers.argb8888);
 262       break;
 263    case WL_DRM_FORMAT_XRGB8888:
 264       mod = u_vector_add(&display->modifiers.xrgb8888);
 265       break;
 266    default:
 267       break;
 268    }
 269
 270    if (!mod)
 271       return;
 272
 273    *mod = (uint64_t) modifier_hi << 32;
 274    *mod |= (uint64_t) (modifier_lo & 0xffffffff);
 275 }
 276
 277 static const struct zwp_linux_dmabuf_v1_listener dmabuf_listener = {
 278    dmabuf_handle_format,
 279    dmabuf_handle_modifier,
 280 };
 281
 282 static void
 283 registry_handle_global(void *data, struct wl_registry *registry,
 284                        uint32_t name, const char *interface, uint32_t version)
 285 {
 286    struct wsi_wl_display *display = data;
 287
 288    if (strcmp(interface, "wl_drm") == 0) {
 289       assert(display->drm == NULL);
 290
 291       assert(version >= 2);
 292       display->drm = wl_registry_bind(registry, name, &wl_drm_interface, 2);
 293
 294       if (display->drm)
 295          wl_drm_add_listener(display->drm, &drm_listener, display);
 296    } else if (strcmp(interface, "zwp_linux_dmabuf_v1") == 0 && version >= 3) {
 297       display->dmabuf =
 298          wl_registry_bind(registry, name, &zwp_linux_dmabuf_v1_interface, 3);
 299       zwp_linux_dmabuf_v1_add_listener(display->dmabuf, &dmabuf_listener,
 300                                        display);
 301    }
 302 }
 303
 304 static void
 305 registry_handle_global_remove(void *data, struct wl_registry *registry,
 306                               uint32_t name)
 307 { /* No-op */ }
 308
 309 static const struct wl_registry_listener registry_listener = {
 310    registry_handle_global,
 311    registry_handle_global_remove
 312 };
 313
 314 static void
 315 wsi_wl_display_finish(struct wsi_wl_display *display)
 316 {
 317    assert(display->refcount == 0);
 318
 319    u_vector_finish(&display->formats);
 320    u_vector_finish(&display->modifiers.argb8888);
 321    u_vector_finish(&display->modifiers.xrgb8888);
 322    if (display->drm)
 323       wl_drm_destroy(display->drm);
 324    if (display->dmabuf)
 325       zwp_linux_dmabuf_v1_destroy(display->dmabuf);
 326    if (display->wl_display_wrapper)
 327       wl_proxy_wrapper_destroy(display->wl_display_wrapper);
 328    if (display->queue)
 329       wl_event_queue_destroy(display->queue);
 330 }
 331
 332 static VkResult
 333 wsi_wl_display_init(struct wsi_wayland *wsi_wl,
 334                     struct wsi_wl_display *display,
 335                     struct wl_display *wl_display,
 336                     bool get_format_list)
 337 {
 338    VkResult result = VK_SUCCESS;
 339    memset(display, 0, sizeof(*display));
 340
 341    display->wsi_wl = wsi_wl;
 342    display->wl_display = wl_display;
 343
 344    if (get_format_list) {
 345       if (!u_vector_init(&display->formats, sizeof(VkFormat), 8) ||
 346           !u_vector_init(&display->modifiers.argb8888, sizeof(uint64_t), 32) ||
 347           !u_vector_init(&display->modifiers.xrgb8888, sizeof(uint64_t), 32)) {
 348          result = VK_ERROR_OUT_OF_HOST_MEMORY;
 349          goto fail;
 350       }
 351    }
 352
 353    display->queue = wl_display_create_queue(wl_display);
 354    if (!display->queue) {
 355       result = VK_ERROR_OUT_OF_HOST_MEMORY;
 356       goto fail;
 357    }
 358
 359    display->wl_display_wrapper = wl_proxy_create_wrapper(wl_display);
 360    if (!display->wl_display_wrapper) {
 361       result = VK_ERROR_OUT_OF_HOST_MEMORY;
 362       goto fail;
 363    }
 364
 365    wl_proxy_set_queue((struct wl_proxy *) display->wl_display_wrapper,
 366                       display->queue);
 367
 368    struct wl_registry *registry =
 369       wl_display_get_registry(display->wl_display_wrapper);
 370    if (!registry) {
 371       result = VK_ERROR_OUT_OF_HOST_MEMORY;
 372       goto fail;
 373    }
 374
 375    wl_registry_add_listener(registry, &registry_listener, display);
 376
 377    /* Round-trip to get the wl_drm global */
 378    wl_display_roundtrip_queue(display->wl_display, display->queue);
 379
 380    if (!display->drm) {
 381       result = VK_ERROR_SURFACE_LOST_KHR;
 382       goto fail_registry;
 383    }
 384
 385    /* Round-trip to get wl_drm formats and capabilities */
 386    wl_display_roundtrip_queue(display->wl_display, display->queue);
 387
 388    /* We need prime support */
 389    if (!(display->capabilities & WL_DRM_CAPABILITY_PRIME)) {
 390       result = VK_ERROR_SURFACE_LOST_KHR;
 391       goto fail_registry;
 392    }
 393
 394    /* We don't need this anymore */
 395    wl_registry_destroy(registry);
 396
 397    display->refcount = 0;
 398
 399    return VK_SUCCESS;
 400
 401 fail_registry:
 402    if (registry)
 403       wl_registry_destroy(registry);
 404
 405 fail:
 406    wsi_wl_display_finish(display);
 407    return result;
 408 }
 409
 410 static VkResult
 411 wsi_wl_display_create(struct wsi_wayland *wsi, struct wl_display *wl_display,
 412                       struct wsi_wl_display **display_out)
 413 {
 414    struct wsi_wl_display *display =
 415       vk_alloc(wsi->alloc, sizeof(*display), 8,
 416                VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
 417    if (!display)
 418       return VK_ERROR_OUT_OF_HOST_MEMORY;
 419
 420    VkResult result = wsi_wl_display_init(wsi, display, wl_display, true);
 421    if (result != VK_SUCCESS) {
 422       vk_free(wsi->alloc, display);
 423       return result;
 424    }
 425
 426    display->refcount++;
 427    *display_out = display;
 428
 429    return result;
 430 }
 431
 432 static struct wsi_wl_display *
 433 wsi_wl_display_ref(struct wsi_wl_display *display)
 434 {
 435    display->refcount++;
 436    return display;
 437 }
 438
 439 static void
 440 wsi_wl_display_unref(struct wsi_wl_display *display)
 441 {
 442    if (display->refcount-- > 1)
 443       return;
 444
 445    struct wsi_wayland *wsi = display->wsi_wl;
 446    wsi_wl_display_finish(display);
 447    vk_free(wsi->alloc, display);
 448 }
 449
 450 VkBool32
 451 wsi_wl_get_presentation_support(struct wsi_device *wsi_device,
 452                                 struct wl_display *wl_display)
 453 {
 454    struct wsi_wayland *wsi =
 455       (struct wsi_wayland *)wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND];
 456
 457    struct wsi_wl_display display;
 458    int ret = wsi_wl_display_init(wsi, &display, wl_display, false);
 459    wsi_wl_display_finish(&display);
 460
 461    return ret == 0;
 462 }
 463
 464 static VkResult
 465 wsi_wl_surface_get_support(VkIcdSurfaceBase *surface,
 466                            struct wsi_device *wsi_device,
 467                            const VkAllocationCallbacks *alloc,
 468                            uint32_t queueFamilyIndex,
 469                            int local_fd,
 470                            VkBool32* pSupported)
 471 {
 472    *pSupported = true;
 473
 474    return VK_SUCCESS;
 475 }
 476
 477 static const VkPresentModeKHR present_modes[] = {
 478    VK_PRESENT_MODE_MAILBOX_KHR,
 479    VK_PRESENT_MODE_FIFO_KHR,
 480 };
 481
 482 static VkResult
 483 wsi_wl_surface_get_capabilities(VkIcdSurfaceBase *surface,
 484                                 VkSurfaceCapabilitiesKHR* caps)
 485 {
 486    /* For true mailbox mode, we need at least 4 images:
 487     *  1) One to scan out from
 488     *  2) One to have queued for scan-out
 489     *  3) One to be currently held by the Wayland compositor
 490     *  4) One to render to
 491     */
 492    caps->minImageCount = 4;
 493    /* There is no real maximum */
 494    caps->maxImageCount = 0;
 495
 496    caps->currentExtent = (VkExtent2D) { -1, -1 };
 497    caps->minImageExtent = (VkExtent2D) { 1, 1 };
 498    /* This is the maximum supported size on Intel */
 499    caps->maxImageExtent = (VkExtent2D) { 1 << 14, 1 << 14 };
 500    caps->supportedTransforms = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
 501    caps->currentTransform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
 502    caps->maxImageArrayLayers = 1;
 503
 504    caps->supportedCompositeAlpha =
 505       VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR |
 506       VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR;
 507
 508    caps->supportedUsageFlags =
 509       VK_IMAGE_USAGE_TRANSFER_SRC_BIT |
 510       VK_IMAGE_USAGE_SAMPLED_BIT |
 511       VK_IMAGE_USAGE_TRANSFER_DST_BIT |
 512       VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
 513
 514    return VK_SUCCESS;
 515 }
 516
 517 static VkResult
 518 wsi_wl_surface_get_capabilities2(VkIcdSurfaceBase *surface,
 519                                  const void *info_next,
 520                                  VkSurfaceCapabilities2KHR* caps)
 521 {
 522    assert(caps->sType == VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR);
 523
 524    return wsi_wl_surface_get_capabilities(surface, &caps->surfaceCapabilities);
 525 }
 526
 527 static VkResult
 528 wsi_wl_surface_get_formats(VkIcdSurfaceBase *icd_surface,
 529                            struct wsi_device *wsi_device,
 530                            uint32_t* pSurfaceFormatCount,
 531                            VkSurfaceFormatKHR* pSurfaceFormats)
 532 {
 533    VkIcdSurfaceWayland *surface = (VkIcdSurfaceWayland *)icd_surface;
 534    struct wsi_wayland *wsi =
 535       (struct wsi_wayland *)wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND];
 536
 537    struct wsi_wl_display display;
 538    if (wsi_wl_display_init(wsi, &display, surface->display, true))
 539       return VK_ERROR_SURFACE_LOST_KHR;
 540
 541    VK_OUTARRAY_MAKE(out, pSurfaceFormats, pSurfaceFormatCount);
 542
 543    VkFormat *disp_fmt;
 544    u_vector_foreach(disp_fmt, &display.formats) {
 545       vk_outarray_append(&out, out_fmt) {
 546          out_fmt->format = *disp_fmt;
 547          out_fmt->colorSpace = VK_COLORSPACE_SRGB_NONLINEAR_KHR;
 548       }
 549    }
 550
 551    wsi_wl_display_finish(&display);
 552
 553    return vk_outarray_status(&out);
 554 }
 555
 556 static VkResult
 557 wsi_wl_surface_get_formats2(VkIcdSurfaceBase *icd_surface,
 558                             struct wsi_device *wsi_device,
 559                             const void *info_next,
 560                             uint32_t* pSurfaceFormatCount,
 561                             VkSurfaceFormat2KHR* pSurfaceFormats)
 562 {
 563    VkIcdSurfaceWayland *surface = (VkIcdSurfaceWayland *)icd_surface;
 564    struct wsi_wayland *wsi =
 565       (struct wsi_wayland *)wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND];
 566
 567    struct wsi_wl_display display;
 568    if (wsi_wl_display_init(wsi, &display, surface->display, true))
 569       return VK_ERROR_SURFACE_LOST_KHR;
 570
 571    VK_OUTARRAY_MAKE(out, pSurfaceFormats, pSurfaceFormatCount);
 572
 573    VkFormat *disp_fmt;
 574    u_vector_foreach(disp_fmt, &display.formats) {
 575       vk_outarray_append(&out, out_fmt) {
 576          out_fmt->surfaceFormat.format = *disp_fmt;
 577          out_fmt->surfaceFormat.colorSpace = VK_COLORSPACE_SRGB_NONLINEAR_KHR;
 578       }
 579    }
 580
 581    wsi_wl_display_finish(&display);
 582
 583    return vk_outarray_status(&out);
 584 }
 585
 586 static VkResult
 587 wsi_wl_surface_get_present_modes(VkIcdSurfaceBase *surface,
 588                                  uint32_t* pPresentModeCount,
 589                                  VkPresentModeKHR* pPresentModes)
 590 {
 591    if (pPresentModes == NULL) {
 592       *pPresentModeCount = ARRAY_SIZE(present_modes);
 593       return VK_SUCCESS;
 594    }
 595
 596    *pPresentModeCount = MIN2(*pPresentModeCount, ARRAY_SIZE(present_modes));
 597    typed_memcpy(pPresentModes, present_modes, *pPresentModeCount);
 598
 599    if (*pPresentModeCount < ARRAY_SIZE(present_modes))
 600       return VK_INCOMPLETE;
 601    else
 602       return VK_SUCCESS;
 603 }
 604
 605 VkResult wsi_create_wl_surface(const VkAllocationCallbacks *pAllocator,
 606                                const VkWaylandSurfaceCreateInfoKHR *pCreateInfo,
 607                                VkSurfaceKHR *pSurface)
 608 {
 609    VkIcdSurfaceWayland *surface;
 610
 611    surface = vk_alloc(pAllocator, sizeof *surface, 8,
 612                       VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
 613    if (surface == NULL)
 614       return VK_ERROR_OUT_OF_HOST_MEMORY;
 615
 616    surface->base.platform = VK_ICD_WSI_PLATFORM_WAYLAND;
 617    surface->display = pCreateInfo->display;
 618    surface->surface = pCreateInfo->surface;
 619
 620    *pSurface = VkIcdSurfaceBase_to_handle(&surface->base);
 621
 622    return VK_SUCCESS;
 623 }
 624
 625 struct wsi_wl_image {
 626    struct wsi_image                             base;
 627    struct wl_buffer *                           buffer;
 628    bool                                         busy;
 629 };
 630
 631 struct wsi_wl_swapchain {
 632    struct wsi_swapchain                        base;
 633
 634    struct wsi_wl_display                        *display;
 635
 636    struct wl_surface *                          surface;
 637    uint32_t                                     surface_version;
 638    struct wl_drm *                              drm_wrapper;
 639    struct wl_callback *                         frame;
 640
 641    VkExtent2D                                   extent;
 642    VkFormat                                     vk_format;
 643    uint32_t                                     drm_format;
 644
 645    VkPresentModeKHR                             present_mode;
 646    bool                                         fifo_ready;
 647
 648    struct wsi_wl_image                          images[0];
 649 };
 650
 651 static struct wsi_image *
 652 wsi_wl_swapchain_get_wsi_image(struct wsi_swapchain *wsi_chain,
 653                                uint32_t image_index)
 654 {
 655    struct wsi_wl_swapchain *chain = (struct wsi_wl_swapchain *)wsi_chain;
 656    return &chain->images[image_index].base;
 657 }
 658
 659 static VkResult
 660 wsi_wl_swapchain_acquire_next_image(struct wsi_swapchain *wsi_chain,
 661                                     const VkAcquireNextImageInfoKHR *info,
 662                                     uint32_t *image_index)
 663 {
 664    struct wsi_wl_swapchain *chain = (struct wsi_wl_swapchain *)wsi_chain;
 665
 666    int ret = wl_display_dispatch_queue_pending(chain->display->wl_display,
 667                                                chain->display->queue);
 668    /* XXX: I'm not sure if out-of-date is the right error here.  If
 669     * wl_display_dispatch_queue_pending fails it most likely means we got
 670     * kicked by the server so this seems more-or-less correct.
 671     */
 672    if (ret < 0)
 673       return VK_ERROR_OUT_OF_DATE_KHR;
 674
 675    while (1) {
 676       for (uint32_t i = 0; i < chain->base.image_count; i++) {
 677          if (!chain->images[i].busy) {
 678             /* We found a non-busy image */
 679             *image_index = i;
 680             chain->images[i].busy = true;
 681             return VK_SUCCESS;
 682          }
 683       }
 684
 685       /* This time we do a blocking dispatch because we can't go
 686        * anywhere until we get an event.
 687        */
 688       int ret = wl_display_roundtrip_queue(chain->display->wl_display,
 689                                            chain->display->queue);
 690       if (ret < 0)
 691          return VK_ERROR_OUT_OF_DATE_KHR;
 692    }
 693 }
 694
 695 static void
 696 frame_handle_done(void *data, struct wl_callback *callback, uint32_t serial)
 697 {
 698    struct wsi_wl_swapchain *chain = data;
 699
 700    chain->frame = NULL;
 701    chain->fifo_ready = true;
 702
 703    wl_callback_destroy(callback);
 704 }
 705
 706 static const struct wl_callback_listener frame_listener = {
 707    frame_handle_done,
 708 };
 709
 710 static VkResult
 711 wsi_wl_swapchain_queue_present(struct wsi_swapchain *wsi_chain,
 712                                uint32_t image_index,
 713                                const VkPresentRegionKHR *damage)
 714 {
 715    struct wsi_wl_swapchain *chain = (struct wsi_wl_swapchain *)wsi_chain;
 716
 717    if (chain->base.present_mode == VK_PRESENT_MODE_FIFO_KHR) {
 718       while (!chain->fifo_ready) {
 719          int ret = wl_display_dispatch_queue(chain->display->wl_display,
 720                                              chain->display->queue);
 721          if (ret < 0)
 722             return VK_ERROR_OUT_OF_DATE_KHR;
 723       }
 724    }
 725
 726    assert(image_index < chain->base.image_count);
 727    wl_surface_attach(chain->surface, chain->images[image_index].buffer, 0, 0);
 728
 729    if (chain->surface_version >= 4 && damage &&
 730        damage->pRectangles && damage->rectangleCount > 0) {
 731       for (unsigned i = 0; i < damage->rectangleCount; i++) {
 732          const VkRectLayerKHR *rect = &damage->pRectangles[i];
 733          assert(rect->layer == 0);
 734          wl_surface_damage_buffer(chain->surface,
 735                                   rect->offset.x, rect->offset.y,
 736                                   rect->extent.width, rect->extent.height);
 737       }
 738    } else {
 739       wl_surface_damage(chain->surface, 0, 0, INT32_MAX, INT32_MAX);
 740    }
 741
 742    if (chain->base.present_mode == VK_PRESENT_MODE_FIFO_KHR) {
 743       chain->frame = wl_surface_frame(chain->surface);
 744       wl_callback_add_listener(chain->frame, &frame_listener, chain);
 745       chain->fifo_ready = false;
 746    }
 747
 748    chain->images[image_index].busy = true;
 749    wl_surface_commit(chain->surface);
 750    wl_display_flush(chain->display->wl_display);
 751
 752    return VK_SUCCESS;
 753 }
 754
 755 static void
 756 buffer_handle_release(void *data, struct wl_buffer *buffer)
 757 {
 758    struct wsi_wl_image *image = data;
 759
 760    assert(image->buffer == buffer);
 761
 762    image->busy = false;
 763 }
 764
 765 static const struct wl_buffer_listener buffer_listener = {
 766    buffer_handle_release,
 767 };
 768
 769 static VkResult
 770 wsi_wl_image_init(struct wsi_wl_swapchain *chain,
 771                   struct wsi_wl_image *image,
 772                   const VkSwapchainCreateInfoKHR *pCreateInfo,
 773                   const VkAllocationCallbacks* pAllocator)
 774 {
 775    struct wsi_wl_display *display = chain->display;
 776    const uint64_t *modifiers = NULL;
 777    uint32_t num_modifiers = 0;
 778    VkResult result;
 779
 780    if (display->dmabuf && chain->base.wsi->supports_modifiers) {
 781       switch (chain->drm_format) {
 782       case WL_DRM_FORMAT_ARGB8888:
 783          modifiers = u_vector_tail(&display->modifiers.argb8888);
 784          num_modifiers = u_vector_length(&display->modifiers.argb8888);
 785          break;
 786       case WL_DRM_FORMAT_XRGB8888:
 787          modifiers = u_vector_tail(&display->modifiers.xrgb8888);
 788          num_modifiers = u_vector_length(&display->modifiers.xrgb8888);
 789          break;
 790       default:
 791          break;
 792       }
 793    }
 794
 795    result = wsi_create_native_image(&chain->base, pCreateInfo,
 796                                     num_modifiers > 0 ? 1 : 0,
 797                                     &num_modifiers, &modifiers,
 798                                     &image->base);
 799
 800    if (result != VK_SUCCESS)
 801       return result;
 802
 803    if (image->base.drm_modifier != DRM_FORMAT_MOD_INVALID) {
 804       /* Only request modifiers if we have dmabuf, else it must be implicit. */
 805       assert(display->dmabuf);
 806
 807       struct zwp_linux_buffer_params_v1 *params =
 808          zwp_linux_dmabuf_v1_create_params(display->dmabuf);
 809       wl_proxy_set_queue((struct wl_proxy *) params, chain->display->queue);
 810
 811       for (int i = 0; i < image->base.num_planes; i++) {
 812          zwp_linux_buffer_params_v1_add(params,
 813                                         image->base.fds[i],
 814                                         i,
 815                                         image->base.offsets[i],
 816                                         image->base.row_pitches[i],
 817                                         image->base.drm_modifier >> 32,
 818                                         image->base.drm_modifier & 0xffffffff);
 819          close(image->base.fds[i]);
 820       }
 821
 822       image->buffer =
 823          zwp_linux_buffer_params_v1_create_immed(params,
 824                                                  chain->extent.width,
 825                                                  chain->extent.height,
 826                                                  chain->drm_format,
 827                                                  0);
 828       zwp_linux_buffer_params_v1_destroy(params);
 829    } else {
 830       /* Without passing modifiers, we can't have multi-plane RGB images. */
 831       assert(image->base.num_planes == 1);
 832
 833       image->buffer =
 834          wl_drm_create_prime_buffer(chain->drm_wrapper,
 835                                     image->base.fds[0], /* name */
 836                                     chain->extent.width,
 837                                     chain->extent.height,
 838                                     chain->drm_format,
 839                                     image->base.offsets[0],
 840                                     image->base.row_pitches[0],
 841                                     0, 0, 0, 0 /* unused */);
 842       close(image->base.fds[0]);
 843    }
 844
 845    if (!image->buffer)
 846       goto fail_image;
 847
 848    wl_buffer_add_listener(image->buffer, &buffer_listener, image);
 849
 850    return VK_SUCCESS;
 851
 852 fail_image:
 853    wsi_destroy_image(&chain->base, &image->base);
 854
 855    return result;
 856 }
 857
 858 static VkResult
 859 wsi_wl_swapchain_destroy(struct wsi_swapchain *wsi_chain,
 860                          const VkAllocationCallbacks *pAllocator)
 861 {
 862    struct wsi_wl_swapchain *chain = (struct wsi_wl_swapchain *)wsi_chain;
 863
 864    for (uint32_t i = 0; i < chain->base.image_count; i++) {
 865       if (chain->images[i].buffer) {
 866          wl_buffer_destroy(chain->images[i].buffer);
 867          wsi_destroy_image(&chain->base, &chain->images[i].base);
 868       }
 869    }
 870
 871    if (chain->frame)
 872       wl_callback_destroy(chain->frame);
 873    if (chain->surface)
 874       wl_proxy_wrapper_destroy(chain->surface);
 875    if (chain->drm_wrapper)
 876       wl_proxy_wrapper_destroy(chain->drm_wrapper);
 877
 878    if (chain->display)
 879       wsi_wl_display_unref(chain->display);
 880
 881    wsi_swapchain_finish(&chain->base);
 882
 883    vk_free(pAllocator, chain);
 884
 885    return VK_SUCCESS;
 886 }
 887
 888 static VkResult
 889 wsi_wl_surface_create_swapchain(VkIcdSurfaceBase *icd_surface,
 890                                 VkDevice device,
 891                                 struct wsi_device *wsi_device,
 892                                 int local_fd,
 893                                 const VkSwapchainCreateInfoKHR* pCreateInfo,
 894                                 const VkAllocationCallbacks* pAllocator,
 895                                 struct wsi_swapchain **swapchain_out)
 896 {
 897    VkIcdSurfaceWayland *surface = (VkIcdSurfaceWayland *)icd_surface;
 898    struct wsi_wayland *wsi =
 899       (struct wsi_wayland *)wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND];
 900    struct wsi_wl_swapchain *chain;
 901    VkResult result;
 902
 903    assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR);
 904
 905    int num_images = pCreateInfo->minImageCount;
 906
 907    size_t size = sizeof(*chain) + num_images * sizeof(chain->images[0]);
 908    chain = vk_alloc(pAllocator, size, 8,
 909                       VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
 910    if (chain == NULL)
 911       return VK_ERROR_OUT_OF_HOST_MEMORY;
 912
 913    result = wsi_swapchain_init(wsi_device, &chain->base, device,
 914                                pCreateInfo, pAllocator);
 915    if (result != VK_SUCCESS) {
 916       vk_free(pAllocator, chain);
 917       return result;
 918    }
 919
 920    /* Mark a bunch of stuff as NULL.  This way we can just call
 921     * destroy_swapchain for cleanup.
 922     */
 923    for (uint32_t i = 0; i < num_images; i++)
 924       chain->images[i].buffer = NULL;
 925    chain->surface = NULL;
 926    chain->drm_wrapper = NULL;
 927    chain->frame = NULL;
 928
 929    bool alpha = pCreateInfo->compositeAlpha ==
 930                       VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR;
 931
 932    chain->base.destroy = wsi_wl_swapchain_destroy;
 933    chain->base.get_wsi_image = wsi_wl_swapchain_get_wsi_image;
 934    chain->base.acquire_next_image = wsi_wl_swapchain_acquire_next_image;
 935    chain->base.queue_present = wsi_wl_swapchain_queue_present;
 936    chain->base.present_mode = pCreateInfo->presentMode;
 937    chain->base.image_count = num_images;
 938    chain->extent = pCreateInfo->imageExtent;
 939    chain->vk_format = pCreateInfo->imageFormat;
 940    chain->drm_format = wl_drm_format_for_vk_format(chain->vk_format, alpha);
 941
 942    if (pCreateInfo->oldSwapchain) {
 943       /* If we have an oldSwapchain parameter, copy the display struct over
 944        * from the old one so we don't have to fully re-initialize it.
 945        */
 946       struct wsi_wl_swapchain *old_chain = (void *)pCreateInfo->oldSwapchain;
 947       chain->display = wsi_wl_display_ref(old_chain->display);
 948    } else {
 949       chain->display = NULL;
 950       result = wsi_wl_display_create(wsi, surface->display, &chain->display);
 951       if (result != VK_SUCCESS)
 952          goto fail;
 953    }
 954
 955    chain->surface = wl_proxy_create_wrapper(surface->surface);
 956    if (!chain->surface) {
 957       result = VK_ERROR_OUT_OF_HOST_MEMORY;
 958       goto fail;
 959    }
 960    wl_proxy_set_queue((struct wl_proxy *) chain->surface,
 961                       chain->display->queue);
 962    chain->surface_version = wl_proxy_get_version((void *)surface->surface);
 963
 964    chain->drm_wrapper = wl_proxy_create_wrapper(chain->display->drm);
 965    if (!chain->drm_wrapper) {
 966       result = VK_ERROR_OUT_OF_HOST_MEMORY;
 967       goto fail;
 968    }
 969    wl_proxy_set_queue((struct wl_proxy *) chain->drm_wrapper,
 970                       chain->display->queue);
 971
 972    chain->fifo_ready = true;
 973
 974    for (uint32_t i = 0; i < chain->base.image_count; i++) {
 975       result = wsi_wl_image_init(chain, &chain->images[i],
 976                                  pCreateInfo, pAllocator);
 977       if (result != VK_SUCCESS)
 978          goto fail;
 979       chain->images[i].busy = false;
 980    }
 981
 982    *swapchain_out = &chain->base;
 983
 984    return VK_SUCCESS;
 985
 986 fail:
 987    wsi_wl_swapchain_destroy(&chain->base, pAllocator);
 988
 989    return result;
 990 }
 991
 992 VkResult
 993 wsi_wl_init_wsi(struct wsi_device *wsi_device,
 994                 const VkAllocationCallbacks *alloc,
 995                 VkPhysicalDevice physical_device)
 996 {
 997    struct wsi_wayland *wsi;
 998    VkResult result;
 999
1000    wsi = vk_alloc(alloc, sizeof(*wsi), 8,
1001                    VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
1002    if (!wsi) {
1003       result = VK_ERROR_OUT_OF_HOST_MEMORY;
1004       goto fail;
1005    }
1006
1007    wsi->physical_device = physical_device;
1008    wsi->alloc = alloc;
1009    wsi->wsi = wsi_device;
1010
1011    wsi->base.get_support = wsi_wl_surface_get_support;
1012    wsi->base.get_capabilities2 = wsi_wl_surface_get_capabilities2;
1013    wsi->base.get_formats = wsi_wl_surface_get_formats;
1014    wsi->base.get_formats2 = wsi_wl_surface_get_formats2;
1015    wsi->base.get_present_modes = wsi_wl_surface_get_present_modes;
1016    wsi->base.create_swapchain = wsi_wl_surface_create_swapchain;
1017
1018    wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND] = &wsi->base;
1019
1020    return VK_SUCCESS;
1021
1022 fail:
1023    wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND] = NULL;
1024
1025    return result;
1026 }
1027
1028 void
1029 wsi_wl_finish_wsi(struct wsi_device *wsi_device,
1030                   const VkAllocationCallbacks *alloc)
1031 {
1032    struct wsi_wayland *wsi =
1033       (struct wsi_wayland *)wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND];
1034    if (!wsi)
1035       return;
1036
1037    vk_free(alloc, wsi);
1038 }