src/vulkan/wsi/wsi_common_x11.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 <X11/Xlib-xcb.h>
  25 #include <X11/xshmfence.h>
  26 #include <xcb/xcb.h>
  27 #include <xcb/dri3.h>
  28 #include <xcb/present.h>
  29
  30 #include "util/macros.h"
  31 #include <stdlib.h>
  32 #include <stdio.h>
  33 #include <unistd.h>
  34 #include <errno.h>
  35 #include <string.h>
  36
  37 #include <poll.h>
  38 #include "util/hash_table.h"
  39
  40 #include "wsi_common.h"
  41 #include "wsi_common_x11.h"
  42
  43 #define typed_memcpy(dest, src, count) ({ \
  44    static_assert(sizeof(*src) == sizeof(*dest), ""); \
  45    memcpy((dest), (src), (count) * sizeof(*(src))); \
  46 })
  47
  48 struct wsi_x11_connection {
  49    bool has_dri3;
  50    bool has_present;
  51 };
  52
  53 struct wsi_x11 {
  54    struct wsi_interface base;
  55
  56    pthread_mutex_t                              mutex;
  57    /* Hash table of xcb_connection -> wsi_x11_connection mappings */
  58    struct hash_table *connections;
  59 };
  60
  61 static struct wsi_x11_connection *
  62 wsi_x11_connection_create(const VkAllocationCallbacks *alloc,
  63                           xcb_connection_t *conn)
  64 {
  65    xcb_query_extension_cookie_t dri3_cookie, pres_cookie;
  66    xcb_query_extension_reply_t *dri3_reply, *pres_reply;
  67
  68    struct wsi_x11_connection *wsi_conn =
  69       vk_alloc(alloc, sizeof(*wsi_conn), 8,
  70                 VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
  71    if (!wsi_conn)
  72       return NULL;
  73
  74    dri3_cookie = xcb_query_extension(conn, 4, "DRI3");
  75    pres_cookie = xcb_query_extension(conn, 7, "PRESENT");
  76
  77    dri3_reply = xcb_query_extension_reply(conn, dri3_cookie, NULL);
  78    pres_reply = xcb_query_extension_reply(conn, pres_cookie, NULL);
  79    if (dri3_reply == NULL || pres_reply == NULL) {
  80       free(dri3_reply);
  81       free(pres_reply);
  82       vk_free(alloc, wsi_conn);
  83       return NULL;
  84    }
  85
  86    wsi_conn->has_dri3 = dri3_reply->present != 0;
  87    wsi_conn->has_present = pres_reply->present != 0;
  88
  89    free(dri3_reply);
  90    free(pres_reply);
  91
  92    return wsi_conn;
  93 }
  94
  95 static void
  96 wsi_x11_connection_destroy(const VkAllocationCallbacks *alloc,
  97                            struct wsi_x11_connection *conn)
  98 {
  99    vk_free(alloc, conn);
 100 }
 101
 102 static struct wsi_x11_connection *
 103 wsi_x11_get_connection(struct wsi_device *wsi_dev,
 104                        const VkAllocationCallbacks *alloc,
 105                        xcb_connection_t *conn)
 106 {
 107    struct wsi_x11 *wsi =
 108       (struct wsi_x11 *)wsi_dev->wsi[VK_ICD_WSI_PLATFORM_XCB];
 109
 110    pthread_mutex_lock(&wsi->mutex);
 111
 112    struct hash_entry *entry = _mesa_hash_table_search(wsi->connections, conn);
 113    if (!entry) {
 114       /* We're about to make a bunch of blocking calls.  Let's drop the
 115        * mutex for now so we don't block up too badly.
 116        */
 117       pthread_mutex_unlock(&wsi->mutex);
 118
 119       struct wsi_x11_connection *wsi_conn =
 120          wsi_x11_connection_create(alloc, conn);
 121
 122       pthread_mutex_lock(&wsi->mutex);
 123
 124       entry = _mesa_hash_table_search(wsi->connections, conn);
 125       if (entry) {
 126          /* Oops, someone raced us to it */
 127          wsi_x11_connection_destroy(alloc, wsi_conn);
 128       } else {
 129          entry = _mesa_hash_table_insert(wsi->connections, conn, wsi_conn);
 130       }
 131    }
 132
 133    pthread_mutex_unlock(&wsi->mutex);
 134
 135    return entry->data;
 136 }
 137
 138 static const VkSurfaceFormatKHR formats[] = {
 139    { .format = VK_FORMAT_B8G8R8A8_SRGB, },
 140    { .format = VK_FORMAT_B8G8R8A8_UNORM, },
 141 };
 142
 143 static const VkPresentModeKHR present_modes[] = {
 144    VK_PRESENT_MODE_IMMEDIATE_KHR,
 145    VK_PRESENT_MODE_MAILBOX_KHR,
 146 };
 147
 148 static xcb_screen_t *
 149 get_screen_for_root(xcb_connection_t *conn, xcb_window_t root)
 150 {
 151    xcb_screen_iterator_t screen_iter =
 152       xcb_setup_roots_iterator(xcb_get_setup(conn));
 153
 154    for (; screen_iter.rem; xcb_screen_next (&screen_iter)) {
 155       if (screen_iter.data->root == root)
 156          return screen_iter.data;
 157    }
 158
 159    return NULL;
 160 }
 161
 162 static xcb_visualtype_t *
 163 screen_get_visualtype(xcb_screen_t *screen, xcb_visualid_t visual_id,
 164                       unsigned *depth)
 165 {
 166    xcb_depth_iterator_t depth_iter =
 167       xcb_screen_allowed_depths_iterator(screen);
 168
 169    for (; depth_iter.rem; xcb_depth_next (&depth_iter)) {
 170       xcb_visualtype_iterator_t visual_iter =
 171          xcb_depth_visuals_iterator (depth_iter.data);
 172
 173       for (; visual_iter.rem; xcb_visualtype_next (&visual_iter)) {
 174          if (visual_iter.data->visual_id == visual_id) {
 175             if (depth)
 176                *depth = depth_iter.data->depth;
 177             return visual_iter.data;
 178          }
 179       }
 180    }
 181
 182    return NULL;
 183 }
 184
 185 static xcb_visualtype_t *
 186 connection_get_visualtype(xcb_connection_t *conn, xcb_visualid_t visual_id,
 187                           unsigned *depth)
 188 {
 189    xcb_screen_iterator_t screen_iter =
 190       xcb_setup_roots_iterator(xcb_get_setup(conn));
 191
 192    /* For this we have to iterate over all of the screens which is rather
 193     * annoying.  Fortunately, there is probably only 1.
 194     */
 195    for (; screen_iter.rem; xcb_screen_next (&screen_iter)) {
 196       xcb_visualtype_t *visual = screen_get_visualtype(screen_iter.data,
 197                                                        visual_id, depth);
 198       if (visual)
 199          return visual;
 200    }
 201
 202    return NULL;
 203 }
 204
 205 static xcb_visualtype_t *
 206 get_visualtype_for_window(xcb_connection_t *conn, xcb_window_t window,
 207                           unsigned *depth)
 208 {
 209    xcb_query_tree_cookie_t tree_cookie;
 210    xcb_get_window_attributes_cookie_t attrib_cookie;
 211    xcb_query_tree_reply_t *tree;
 212    xcb_get_window_attributes_reply_t *attrib;
 213
 214    tree_cookie = xcb_query_tree(conn, window);
 215    attrib_cookie = xcb_get_window_attributes(conn, window);
 216
 217    tree = xcb_query_tree_reply(conn, tree_cookie, NULL);
 218    attrib = xcb_get_window_attributes_reply(conn, attrib_cookie, NULL);
 219    if (attrib == NULL || tree == NULL) {
 220       free(attrib);
 221       free(tree);
 222       return NULL;
 223    }
 224
 225    xcb_window_t root = tree->root;
 226    xcb_visualid_t visual_id = attrib->visual;
 227    free(attrib);
 228    free(tree);
 229
 230    xcb_screen_t *screen = get_screen_for_root(conn, root);
 231    if (screen == NULL)
 232       return NULL;
 233
 234    return screen_get_visualtype(screen, visual_id, depth);
 235 }
 236
 237 static bool
 238 visual_has_alpha(xcb_visualtype_t *visual, unsigned depth)
 239 {
 240    uint32_t rgb_mask = visual->red_mask |
 241                        visual->green_mask |
 242                        visual->blue_mask;
 243
 244    uint32_t all_mask = 0xffffffff >> (32 - depth);
 245
 246    /* Do we have bits left over after RGB? */
 247    return (all_mask & ~rgb_mask) != 0;
 248 }
 249
 250 VkBool32 wsi_get_physical_device_xcb_presentation_support(
 251     struct wsi_device *wsi_device,
 252     VkAllocationCallbacks *alloc,
 253     uint32_t                                    queueFamilyIndex,
 254     xcb_connection_t*                           connection,
 255     xcb_visualid_t                              visual_id)
 256 {
 257    struct wsi_x11_connection *wsi_conn =
 258       wsi_x11_get_connection(wsi_device, alloc, connection);
 259
 260    if (!wsi_conn->has_dri3) {
 261       fprintf(stderr, "vulkan: No DRI3 support\n");
 262       return false;
 263    }
 264
 265    unsigned visual_depth;
 266    if (!connection_get_visualtype(connection, visual_id, &visual_depth))
 267       return false;
 268
 269    if (visual_depth != 24 && visual_depth != 32)
 270       return false;
 271
 272    return true;
 273 }
 274
 275 static xcb_connection_t*
 276 x11_surface_get_connection(VkIcdSurfaceBase *icd_surface)
 277 {
 278    if (icd_surface->platform == VK_ICD_WSI_PLATFORM_XLIB)
 279       return XGetXCBConnection(((VkIcdSurfaceXlib *)icd_surface)->dpy);
 280    else
 281       return ((VkIcdSurfaceXcb *)icd_surface)->connection;
 282 }
 283
 284 static xcb_window_t
 285 x11_surface_get_window(VkIcdSurfaceBase *icd_surface)
 286 {
 287    if (icd_surface->platform == VK_ICD_WSI_PLATFORM_XLIB)
 288       return ((VkIcdSurfaceXlib *)icd_surface)->window;
 289    else
 290       return ((VkIcdSurfaceXcb *)icd_surface)->window;
 291 }
 292
 293 static VkResult
 294 x11_surface_get_support(VkIcdSurfaceBase *icd_surface,
 295                         struct wsi_device *wsi_device,
 296                         const VkAllocationCallbacks *alloc,
 297                         uint32_t queueFamilyIndex,
 298                         VkBool32* pSupported)
 299 {
 300    xcb_connection_t *conn = x11_surface_get_connection(icd_surface);
 301    xcb_window_t window = x11_surface_get_window(icd_surface);
 302
 303    struct wsi_x11_connection *wsi_conn =
 304       wsi_x11_get_connection(wsi_device, alloc, conn);
 305    if (!wsi_conn)
 306       return VK_ERROR_OUT_OF_HOST_MEMORY;
 307
 308    if (!wsi_conn->has_dri3) {
 309       fprintf(stderr, "vulkan: No DRI3 support\n");
 310       *pSupported = false;
 311       return VK_SUCCESS;
 312    }
 313
 314    unsigned visual_depth;
 315    if (!get_visualtype_for_window(conn, window, &visual_depth)) {
 316       *pSupported = false;
 317       return VK_SUCCESS;
 318    }
 319
 320    if (visual_depth != 24 && visual_depth != 32) {
 321       *pSupported = false;
 322       return VK_SUCCESS;
 323    }
 324
 325    *pSupported = true;
 326    return VK_SUCCESS;
 327 }
 328
 329 static VkResult
 330 x11_surface_get_capabilities(VkIcdSurfaceBase *icd_surface,
 331                              VkSurfaceCapabilitiesKHR *caps)
 332 {
 333    xcb_connection_t *conn = x11_surface_get_connection(icd_surface);
 334    xcb_window_t window = x11_surface_get_window(icd_surface);
 335    xcb_get_geometry_cookie_t geom_cookie;
 336    xcb_generic_error_t *err;
 337    xcb_get_geometry_reply_t *geom;
 338    unsigned visual_depth;
 339
 340    geom_cookie = xcb_get_geometry(conn, window);
 341
 342    /* This does a round-trip.  This is why we do get_geometry first and
 343     * wait to read the reply until after we have a visual.
 344     */
 345    xcb_visualtype_t *visual =
 346       get_visualtype_for_window(conn, window, &visual_depth);
 347
 348    geom = xcb_get_geometry_reply(conn, geom_cookie, &err);
 349    if (geom) {
 350       VkExtent2D extent = { geom->width, geom->height };
 351       caps->currentExtent = extent;
 352       caps->minImageExtent = extent;
 353       caps->maxImageExtent = extent;
 354    } else {
 355       /* This can happen if the client didn't wait for the configure event
 356        * to come back from the compositor.  In that case, we don't know the
 357        * size of the window so we just return valid "I don't know" stuff.
 358        */
 359       caps->currentExtent = (VkExtent2D) { -1, -1 };
 360       caps->minImageExtent = (VkExtent2D) { 1, 1 };
 361       caps->maxImageExtent = (VkExtent2D) { INT16_MAX, INT16_MAX };
 362    }
 363    free(err);
 364    free(geom);
 365
 366    if (visual_has_alpha(visual, visual_depth)) {
 367       caps->supportedCompositeAlpha = VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR |
 368                                       VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR;
 369    } else {
 370       caps->supportedCompositeAlpha = VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR |
 371                                       VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR;
 372    }
 373
 374    caps->minImageCount = 2;
 375    caps->maxImageCount = 4;
 376    caps->supportedTransforms = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
 377    caps->currentTransform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
 378    caps->maxImageArrayLayers = 1;
 379    caps->supportedUsageFlags =
 380       VK_IMAGE_USAGE_TRANSFER_SRC_BIT |
 381       VK_IMAGE_USAGE_SAMPLED_BIT |
 382       VK_IMAGE_USAGE_TRANSFER_DST_BIT |
 383       VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
 384
 385    return VK_SUCCESS;
 386 }
 387
 388 static VkResult
 389 x11_surface_get_formats(VkIcdSurfaceBase *surface,
 390                         struct wsi_device *wsi_device,
 391                         uint32_t *pSurfaceFormatCount,
 392                         VkSurfaceFormatKHR *pSurfaceFormats)
 393 {
 394    if (pSurfaceFormats == NULL) {
 395       *pSurfaceFormatCount = ARRAY_SIZE(formats);
 396       return VK_SUCCESS;
 397    }
 398
 399    *pSurfaceFormatCount = MIN2(*pSurfaceFormatCount, ARRAY_SIZE(formats));
 400    typed_memcpy(pSurfaceFormats, formats, *pSurfaceFormatCount);
 401
 402    return *pSurfaceFormatCount < ARRAY_SIZE(formats) ?
 403       VK_INCOMPLETE : VK_SUCCESS;
 404 }
 405
 406 static VkResult
 407 x11_surface_get_present_modes(VkIcdSurfaceBase *surface,
 408                               uint32_t *pPresentModeCount,
 409                               VkPresentModeKHR *pPresentModes)
 410 {
 411    if (pPresentModes == NULL) {
 412       *pPresentModeCount = ARRAY_SIZE(present_modes);
 413       return VK_SUCCESS;
 414    }
 415
 416    *pPresentModeCount = MIN2(*pPresentModeCount, ARRAY_SIZE(present_modes));
 417    typed_memcpy(pPresentModes, present_modes, *pPresentModeCount);
 418
 419    return *pPresentModeCount < ARRAY_SIZE(present_modes) ?
 420       VK_INCOMPLETE : VK_SUCCESS;
 421 }
 422
 423 VkResult wsi_create_xcb_surface(const VkAllocationCallbacks *pAllocator,
 424                                 const VkXcbSurfaceCreateInfoKHR *pCreateInfo,
 425                                 VkSurfaceKHR *pSurface)
 426 {
 427    VkIcdSurfaceXcb *surface;
 428
 429    surface = vk_alloc(pAllocator, sizeof *surface, 8,
 430                       VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
 431    if (surface == NULL)
 432       return VK_ERROR_OUT_OF_HOST_MEMORY;
 433
 434    surface->base.platform = VK_ICD_WSI_PLATFORM_XCB;
 435    surface->connection = pCreateInfo->connection;
 436    surface->window = pCreateInfo->window;
 437
 438    *pSurface = _VkIcdSurfaceBase_to_handle(&surface->base);
 439    return VK_SUCCESS;
 440 }
 441
 442 VkResult wsi_create_xlib_surface(const VkAllocationCallbacks *pAllocator,
 443                                  const VkXlibSurfaceCreateInfoKHR *pCreateInfo,
 444                                  VkSurfaceKHR *pSurface)
 445 {
 446    VkIcdSurfaceXlib *surface;
 447
 448    surface = vk_alloc(pAllocator, sizeof *surface, 8,
 449                       VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
 450    if (surface == NULL)
 451       return VK_ERROR_OUT_OF_HOST_MEMORY;
 452
 453    surface->base.platform = VK_ICD_WSI_PLATFORM_XLIB;
 454    surface->dpy = pCreateInfo->dpy;
 455    surface->window = pCreateInfo->window;
 456
 457    *pSurface = _VkIcdSurfaceBase_to_handle(&surface->base);
 458    return VK_SUCCESS;
 459 }
 460
 461 struct x11_image {
 462    VkImage image;
 463    VkDeviceMemory memory;
 464    xcb_pixmap_t                              pixmap;
 465    bool                                      busy;
 466    struct xshmfence *                        shm_fence;
 467    uint32_t                                  sync_fence;
 468 };
 469
 470 struct x11_swapchain {
 471    struct wsi_swapchain                        base;
 472
 473    xcb_connection_t *                           conn;
 474    xcb_window_t                                 window;
 475    xcb_gc_t                                     gc;
 476    uint32_t                                     depth;
 477    VkExtent2D                                   extent;
 478    uint32_t                                     image_count;
 479
 480    xcb_present_event_t                          event_id;
 481    xcb_special_event_t *                        special_event;
 482    uint64_t                                     send_sbc;
 483    uint32_t                                     stamp;
 484
 485    struct x11_image                             images[0];
 486 };
 487
 488 static VkResult
 489 x11_get_images(struct wsi_swapchain *anv_chain,
 490                uint32_t* pCount, VkImage *pSwapchainImages)
 491 {
 492    struct x11_swapchain *chain = (struct x11_swapchain *)anv_chain;
 493
 494    if (pSwapchainImages == NULL) {
 495       *pCount = chain->image_count;
 496       return VK_SUCCESS;
 497    }
 498
 499    assert(chain->image_count <= *pCount);
 500    for (uint32_t i = 0; i < chain->image_count; i++)
 501       pSwapchainImages[i] = chain->images[i].image;
 502
 503    *pCount = chain->image_count;
 504
 505    return VK_SUCCESS;
 506 }
 507
 508 static VkResult
 509 x11_handle_dri3_present_event(struct x11_swapchain *chain,
 510                               xcb_present_generic_event_t *event)
 511 {
 512    switch (event->evtype) {
 513    case XCB_PRESENT_CONFIGURE_NOTIFY: {
 514       xcb_present_configure_notify_event_t *config = (void *) event;
 515
 516       if (config->width != chain->extent.width ||
 517           config->height != chain->extent.height)
 518          return VK_ERROR_OUT_OF_DATE_KHR;
 519
 520       break;
 521    }
 522
 523    case XCB_PRESENT_EVENT_IDLE_NOTIFY: {
 524       xcb_present_idle_notify_event_t *idle = (void *) event;
 525
 526       for (unsigned i = 0; i < chain->image_count; i++) {
 527          if (chain->images[i].pixmap == idle->pixmap) {
 528             chain->images[i].busy = false;
 529             break;
 530          }
 531       }
 532
 533       break;
 534    }
 535
 536    case XCB_PRESENT_COMPLETE_NOTIFY:
 537    default:
 538       break;
 539    }
 540
 541    return VK_SUCCESS;
 542 }
 543
 544
 545 static uint64_t wsi_get_current_time(void)
 546 {
 547    uint64_t current_time;
 548    struct timespec tv;
 549
 550    clock_gettime(CLOCK_MONOTONIC, &tv);
 551    current_time = tv.tv_nsec + tv.tv_sec*1000000000ull;
 552    return current_time;
 553 }
 554
 555 static uint64_t wsi_get_absolute_timeout(uint64_t timeout)
 556 {
 557    uint64_t current_time = wsi_get_current_time();
 558
 559    timeout = MIN2(UINT64_MAX - current_time, timeout);
 560
 561    return current_time + timeout;
 562 }
 563
 564 static VkResult
 565 x11_acquire_next_image(struct wsi_swapchain *anv_chain,
 566                        uint64_t timeout,
 567                        VkSemaphore semaphore,
 568                        uint32_t *image_index)
 569 {
 570    struct x11_swapchain *chain = (struct x11_swapchain *)anv_chain;
 571    xcb_generic_event_t *event;
 572    struct pollfd pfds;
 573    uint64_t atimeout;
 574    while (1) {
 575       for (uint32_t i = 0; i < chain->image_count; i++) {
 576          if (!chain->images[i].busy) {
 577             /* We found a non-busy image */
 578             xshmfence_await(chain->images[i].shm_fence);
 579             *image_index = i;
 580             chain->images[i].busy = true;
 581             return VK_SUCCESS;
 582          }
 583       }
 584
 585       xcb_flush(chain->conn);
 586
 587       if (timeout == UINT64_MAX) {
 588          event = xcb_wait_for_special_event(chain->conn, chain->special_event);
 589          if (!event)
 590             return VK_ERROR_OUT_OF_DATE_KHR;
 591       } else {
 592          event = xcb_poll_for_special_event(chain->conn, chain->special_event);
 593          if (!event) {
 594             int ret;
 595             if (timeout == 0)
 596                return VK_NOT_READY;
 597
 598             atimeout = wsi_get_absolute_timeout(timeout);
 599
 600             pfds.fd = xcb_get_file_descriptor(chain->conn);
 601             pfds.events = POLLIN;
 602             ret = poll(&pfds, 1, timeout / 1000 / 1000);
 603             if (ret == 0)
 604                return VK_TIMEOUT;
 605             if (ret == -1)
 606                return VK_ERROR_OUT_OF_DATE_KHR;
 607
 608             /* If a non-special event happens, the fd will still
 609              * poll. So recalculate the timeout now just in case.
 610              */
 611             uint64_t current_time = wsi_get_current_time();
 612             if (atimeout > current_time)
 613                timeout = atimeout - current_time;
 614             else
 615                timeout = 0;
 616             continue;
 617          }
 618       }
 619
 620       VkResult result = x11_handle_dri3_present_event(chain, (void *)event);
 621       free(event);
 622       if (result != VK_SUCCESS)
 623          return result;
 624    }
 625 }
 626
 627 static VkResult
 628 x11_queue_present(struct wsi_swapchain *anv_chain,
 629                   uint32_t image_index)
 630 {
 631    struct x11_swapchain *chain = (struct x11_swapchain *)anv_chain;
 632    struct x11_image *image = &chain->images[image_index];
 633
 634    assert(image_index < chain->image_count);
 635
 636    uint32_t options = XCB_PRESENT_OPTION_NONE;
 637
 638    int64_t target_msc = 0;
 639    int64_t divisor = 0;
 640    int64_t remainder = 0;
 641
 642    if (chain->base.present_mode == VK_PRESENT_MODE_IMMEDIATE_KHR)
 643       options |= XCB_PRESENT_OPTION_ASYNC;
 644
 645    xshmfence_reset(image->shm_fence);
 646
 647    ++chain->send_sbc;
 648    xcb_void_cookie_t cookie =
 649       xcb_present_pixmap(chain->conn,
 650                          chain->window,
 651                          image->pixmap,
 652                          (uint32_t) chain->send_sbc,
 653                          0,                                    /* valid */
 654                          0,                                    /* update */
 655                          0,                                    /* x_off */
 656                          0,                                    /* y_off */
 657                          XCB_NONE,                             /* target_crtc */
 658                          XCB_NONE,
 659                          image->sync_fence,
 660                          options,
 661                          target_msc,
 662                          divisor,
 663                          remainder, 0, NULL);
 664    xcb_discard_reply(chain->conn, cookie.sequence);
 665    image->busy = true;
 666
 667    xcb_flush(chain->conn);
 668
 669    return VK_SUCCESS;
 670 }
 671
 672 static VkResult
 673 x11_image_init(VkDevice device_h, struct x11_swapchain *chain,
 674                const VkSwapchainCreateInfoKHR *pCreateInfo,
 675                const VkAllocationCallbacks* pAllocator,
 676                struct x11_image *image)
 677 {
 678    xcb_void_cookie_t cookie;
 679    VkResult result;
 680    uint32_t row_pitch;
 681    uint32_t offset;
 682    uint32_t bpp = 32;
 683    int fd;
 684    uint32_t size;
 685
 686    result = chain->base.image_fns->create_wsi_image(device_h,
 687                                                     pCreateInfo,
 688                                                     pAllocator,
 689                                                     &image->image,
 690                                                     &image->memory,
 691                                                     &size,
 692                                                     &offset,
 693                                                     &row_pitch,
 694                                                     &fd);
 695    if (result != VK_SUCCESS)
 696       return result;
 697
 698    image->pixmap = xcb_generate_id(chain->conn);
 699
 700    cookie =
 701       xcb_dri3_pixmap_from_buffer_checked(chain->conn,
 702                                           image->pixmap,
 703                                           chain->window,
 704                                           size,
 705                                           pCreateInfo->imageExtent.width,
 706                                           pCreateInfo->imageExtent.height,
 707                                           row_pitch,
 708                                           chain->depth, bpp, fd);
 709    xcb_discard_reply(chain->conn, cookie.sequence);
 710
 711    int fence_fd = xshmfence_alloc_shm();
 712    if (fence_fd < 0)
 713       goto fail_pixmap;
 714
 715    image->shm_fence = xshmfence_map_shm(fence_fd);
 716    if (image->shm_fence == NULL)
 717       goto fail_shmfence_alloc;
 718
 719    image->sync_fence = xcb_generate_id(chain->conn);
 720    xcb_dri3_fence_from_fd(chain->conn,
 721                           image->pixmap,
 722                           image->sync_fence,
 723                           false,
 724                           fence_fd);
 725
 726    image->busy = false;
 727    xshmfence_trigger(image->shm_fence);
 728
 729    return VK_SUCCESS;
 730
 731 fail_shmfence_alloc:
 732    close(fence_fd);
 733
 734 fail_pixmap:
 735    cookie = xcb_free_pixmap(chain->conn, image->pixmap);
 736    xcb_discard_reply(chain->conn, cookie.sequence);
 737
 738    chain->base.image_fns->free_wsi_image(device_h, pAllocator,
 739                                         image->image, image->memory);
 740
 741    return result;
 742 }
 743
 744 static void
 745 x11_image_finish(struct x11_swapchain *chain,
 746                  const VkAllocationCallbacks* pAllocator,
 747                  struct x11_image *image)
 748 {
 749    xcb_void_cookie_t cookie;
 750
 751    cookie = xcb_sync_destroy_fence(chain->conn, image->sync_fence);
 752    xcb_discard_reply(chain->conn, cookie.sequence);
 753    xshmfence_unmap_shm(image->shm_fence);
 754
 755    cookie = xcb_free_pixmap(chain->conn, image->pixmap);
 756    xcb_discard_reply(chain->conn, cookie.sequence);
 757
 758    chain->base.image_fns->free_wsi_image(chain->base.device, pAllocator,
 759                                         image->image, image->memory);
 760 }
 761
 762 static VkResult
 763 x11_swapchain_destroy(struct wsi_swapchain *anv_chain,
 764                       const VkAllocationCallbacks *pAllocator)
 765 {
 766    struct x11_swapchain *chain = (struct x11_swapchain *)anv_chain;
 767    for (uint32_t i = 0; i < chain->image_count; i++)
 768       x11_image_finish(chain, pAllocator, &chain->images[i]);
 769
 770    xcb_unregister_for_special_event(chain->conn, chain->special_event);
 771
 772    vk_free(pAllocator, chain);
 773
 774    return VK_SUCCESS;
 775 }
 776
 777 static VkResult
 778 x11_surface_create_swapchain(VkIcdSurfaceBase *icd_surface,
 779                              VkDevice device,
 780                              struct wsi_device *wsi_device,
 781                              const VkSwapchainCreateInfoKHR *pCreateInfo,
 782                              const VkAllocationCallbacks* pAllocator,
 783                              const struct wsi_image_fns *image_fns,
 784                              struct wsi_swapchain **swapchain_out)
 785 {
 786    struct x11_swapchain *chain;
 787    xcb_void_cookie_t cookie;
 788    VkResult result;
 789
 790    assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR);
 791
 792    int num_images = pCreateInfo->minImageCount;
 793
 794    /* For true mailbox mode, we need at least 4 images:
 795     *  1) One to scan out from
 796     *  2) One to have queued for scan-out
 797     *  3) One to be currently held by the Wayland compositor
 798     *  4) One to render to
 799     */
 800    if (pCreateInfo->presentMode == VK_PRESENT_MODE_MAILBOX_KHR)
 801       num_images = MAX2(num_images, 4);
 802
 803    size_t size = sizeof(*chain) + num_images * sizeof(chain->images[0]);
 804    chain = vk_alloc(pAllocator, size, 8,
 805                       VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
 806    if (chain == NULL)
 807       return VK_ERROR_OUT_OF_HOST_MEMORY;
 808
 809    xcb_connection_t *conn = x11_surface_get_connection(icd_surface);
 810    xcb_window_t window = x11_surface_get_window(icd_surface);
 811    xcb_get_geometry_reply_t *geometry =
 812       xcb_get_geometry_reply(conn, xcb_get_geometry(conn, window), NULL);
 813
 814    if (geometry == NULL)
 815       return VK_ERROR_SURFACE_LOST_KHR;
 816
 817    chain->base.device = device;
 818    chain->base.destroy = x11_swapchain_destroy;
 819    chain->base.get_images = x11_get_images;
 820    chain->base.acquire_next_image = x11_acquire_next_image;
 821    chain->base.queue_present = x11_queue_present;
 822    chain->base.image_fns = image_fns;
 823    chain->base.present_mode = pCreateInfo->presentMode;
 824    chain->conn = conn;
 825    chain->window = window;
 826    chain->depth = geometry->depth;
 827    chain->extent = pCreateInfo->imageExtent;
 828    chain->image_count = num_images;
 829    chain->send_sbc = 0;
 830
 831    free(geometry);
 832
 833    chain->event_id = xcb_generate_id(chain->conn);
 834    xcb_present_select_input(chain->conn, chain->event_id, chain->window,
 835                             XCB_PRESENT_EVENT_MASK_CONFIGURE_NOTIFY |
 836                             XCB_PRESENT_EVENT_MASK_COMPLETE_NOTIFY |
 837                             XCB_PRESENT_EVENT_MASK_IDLE_NOTIFY);
 838
 839    /* Create an XCB event queue to hold present events outside of the usual
 840     * application event queue
 841     */
 842    chain->special_event =
 843       xcb_register_for_special_xge(chain->conn, &xcb_present_id,
 844                                    chain->event_id, NULL);
 845
 846    chain->gc = xcb_generate_id(chain->conn);
 847    if (!chain->gc) {
 848       /* FINISHME: Choose a better error. */
 849       result = VK_ERROR_OUT_OF_HOST_MEMORY;
 850       goto fail_register;
 851    }
 852
 853    cookie = xcb_create_gc(chain->conn,
 854                           chain->gc,
 855                           chain->window,
 856                           XCB_GC_GRAPHICS_EXPOSURES,
 857                           (uint32_t []) { 0 });
 858    xcb_discard_reply(chain->conn, cookie.sequence);
 859
 860    uint32_t image = 0;
 861    for (; image < chain->image_count; image++) {
 862       result = x11_image_init(device, chain, pCreateInfo, pAllocator,
 863                               &chain->images[image]);
 864       if (result != VK_SUCCESS)
 865          goto fail_init_images;
 866    }
 867
 868    *swapchain_out = &chain->base;
 869
 870    return VK_SUCCESS;
 871
 872 fail_init_images:
 873    for (uint32_t j = 0; j < image; j++)
 874       x11_image_finish(chain, pAllocator, &chain->images[j]);
 875
 876 fail_register:
 877    xcb_unregister_for_special_event(chain->conn, chain->special_event);
 878
 879    vk_free(pAllocator, chain);
 880
 881    return result;
 882 }
 883
 884 VkResult
 885 wsi_x11_init_wsi(struct wsi_device *wsi_device,
 886                  const VkAllocationCallbacks *alloc)
 887 {
 888    struct wsi_x11 *wsi;
 889    VkResult result;
 890
 891    wsi = vk_alloc(alloc, sizeof(*wsi), 8,
 892                    VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
 893    if (!wsi) {
 894       result = VK_ERROR_OUT_OF_HOST_MEMORY;
 895       goto fail;
 896    }
 897
 898    int ret = pthread_mutex_init(&wsi->mutex, NULL);
 899    if (ret != 0) {
 900       if (ret == ENOMEM) {
 901          result = VK_ERROR_OUT_OF_HOST_MEMORY;
 902       } else {
 903          /* FINISHME: Choose a better error. */
 904          result = VK_ERROR_OUT_OF_HOST_MEMORY;
 905       }
 906
 907       goto fail_alloc;
 908    }
 909
 910    wsi->connections = _mesa_hash_table_create(NULL, _mesa_hash_pointer,
 911                                               _mesa_key_pointer_equal);
 912    if (!wsi->connections) {
 913       result = VK_ERROR_OUT_OF_HOST_MEMORY;
 914       goto fail_mutex;
 915    }
 916
 917    wsi->base.get_support = x11_surface_get_support;
 918    wsi->base.get_capabilities = x11_surface_get_capabilities;
 919    wsi->base.get_formats = x11_surface_get_formats;
 920    wsi->base.get_present_modes = x11_surface_get_present_modes;
 921    wsi->base.create_swapchain = x11_surface_create_swapchain;
 922
 923    wsi_device->wsi[VK_ICD_WSI_PLATFORM_XCB] = &wsi->base;
 924    wsi_device->wsi[VK_ICD_WSI_PLATFORM_XLIB] = &wsi->base;
 925
 926    return VK_SUCCESS;
 927
 928 fail_mutex:
 929    pthread_mutex_destroy(&wsi->mutex);
 930 fail_alloc:
 931    vk_free(alloc, wsi);
 932 fail:
 933    wsi_device->wsi[VK_ICD_WSI_PLATFORM_XCB] = NULL;
 934    wsi_device->wsi[VK_ICD_WSI_PLATFORM_XLIB] = NULL;
 935
 936    return result;
 937 }
 938
 939 void
 940 wsi_x11_finish_wsi(struct wsi_device *wsi_device,
 941                    const VkAllocationCallbacks *alloc)
 942 {
 943    struct wsi_x11 *wsi =
 944       (struct wsi_x11 *)wsi_device->wsi[VK_ICD_WSI_PLATFORM_XCB];
 945
 946    if (wsi) {
 947       _mesa_hash_table_destroy(wsi->connections, NULL);
 948
 949       pthread_mutex_destroy(&wsi->mutex);
 950
 951       vk_free(alloc, wsi);
 952    }
 953 }