979dca0784c30af0892b57b07ba12f4d476e2612
[mesa.git] / 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 #include <fcntl.h>
37 #include <poll.h>
38 #include <xf86drm.h>
39 #include "drm-uapi/drm_fourcc.h"
40 #include "util/hash_table.h"
41 #include "util/xmlconfig.h"
42
43 #include "vk_util.h"
44 #include "vk_enum_to_str.h"
45 #include "wsi_common_private.h"
46 #include "wsi_common_x11.h"
47 #include "wsi_common_queue.h"
48
49 #define typed_memcpy(dest, src, count) ({ \
50 STATIC_ASSERT(sizeof(*src) == sizeof(*dest)); \
51 memcpy((dest), (src), (count) * sizeof(*(src))); \
52 })
53
54 struct wsi_x11_connection {
55 bool has_dri3;
56 bool has_dri3_modifiers;
57 bool has_present;
58 bool is_proprietary_x11;
59 };
60
61 struct wsi_x11 {
62 struct wsi_interface base;
63
64 pthread_mutex_t mutex;
65 /* Hash table of xcb_connection -> wsi_x11_connection mappings */
66 struct hash_table *connections;
67 };
68
69
70 /** wsi_dri3_open
71 *
72 * Wrapper around xcb_dri3_open
73 */
74 static int
75 wsi_dri3_open(xcb_connection_t *conn,
76 xcb_window_t root,
77 uint32_t provider)
78 {
79 xcb_dri3_open_cookie_t cookie;
80 xcb_dri3_open_reply_t *reply;
81 int fd;
82
83 cookie = xcb_dri3_open(conn,
84 root,
85 provider);
86
87 reply = xcb_dri3_open_reply(conn, cookie, NULL);
88 if (!reply)
89 return -1;
90
91 if (reply->nfd != 1) {
92 free(reply);
93 return -1;
94 }
95
96 fd = xcb_dri3_open_reply_fds(conn, reply)[0];
97 free(reply);
98 fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
99
100 return fd;
101 }
102
103 static bool
104 wsi_x11_check_dri3_compatible(const struct wsi_device *wsi_dev,
105 xcb_connection_t *conn)
106 {
107 xcb_screen_iterator_t screen_iter =
108 xcb_setup_roots_iterator(xcb_get_setup(conn));
109 xcb_screen_t *screen = screen_iter.data;
110
111 int dri3_fd = wsi_dri3_open(conn, screen->root, None);
112 if (dri3_fd == -1)
113 return true;
114
115 bool match = wsi_device_matches_drm_fd(wsi_dev, dri3_fd);
116
117 close(dri3_fd);
118
119 return match;
120 }
121
122 static struct wsi_x11_connection *
123 wsi_x11_connection_create(struct wsi_device *wsi_dev,
124 xcb_connection_t *conn)
125 {
126 xcb_query_extension_cookie_t dri3_cookie, pres_cookie, amd_cookie, nv_cookie;
127 xcb_query_extension_reply_t *dri3_reply, *pres_reply, *amd_reply, *nv_reply;
128 bool has_dri3_v1_2 = false;
129 bool has_present_v1_2 = false;
130
131 struct wsi_x11_connection *wsi_conn =
132 vk_alloc(&wsi_dev->instance_alloc, sizeof(*wsi_conn), 8,
133 VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
134 if (!wsi_conn)
135 return NULL;
136
137 dri3_cookie = xcb_query_extension(conn, 4, "DRI3");
138 pres_cookie = xcb_query_extension(conn, 7, "Present");
139
140 /* We try to be nice to users and emit a warning if they try to use a
141 * Vulkan application on a system without DRI3 enabled. However, this ends
142 * up spewing the warning when a user has, for example, both Intel
143 * integrated graphics and a discrete card with proprietary drivers and are
144 * running on the discrete card with the proprietary DDX. In this case, we
145 * really don't want to print the warning because it just confuses users.
146 * As a heuristic to detect this case, we check for a couple of proprietary
147 * X11 extensions.
148 */
149 amd_cookie = xcb_query_extension(conn, 11, "ATIFGLRXDRI");
150 nv_cookie = xcb_query_extension(conn, 10, "NV-CONTROL");
151
152 dri3_reply = xcb_query_extension_reply(conn, dri3_cookie, NULL);
153 pres_reply = xcb_query_extension_reply(conn, pres_cookie, NULL);
154 amd_reply = xcb_query_extension_reply(conn, amd_cookie, NULL);
155 nv_reply = xcb_query_extension_reply(conn, nv_cookie, NULL);
156 if (!dri3_reply || !pres_reply) {
157 free(dri3_reply);
158 free(pres_reply);
159 free(amd_reply);
160 free(nv_reply);
161 vk_free(&wsi_dev->instance_alloc, wsi_conn);
162 return NULL;
163 }
164
165 wsi_conn->has_dri3 = dri3_reply->present != 0;
166 #ifdef HAVE_DRI3_MODIFIERS
167 if (wsi_conn->has_dri3) {
168 xcb_dri3_query_version_cookie_t ver_cookie;
169 xcb_dri3_query_version_reply_t *ver_reply;
170
171 ver_cookie = xcb_dri3_query_version(conn, 1, 2);
172 ver_reply = xcb_dri3_query_version_reply(conn, ver_cookie, NULL);
173 has_dri3_v1_2 =
174 (ver_reply->major_version > 1 || ver_reply->minor_version >= 2);
175 free(ver_reply);
176 }
177 #endif
178
179 wsi_conn->has_present = pres_reply->present != 0;
180 #ifdef HAVE_DRI3_MODIFIERS
181 if (wsi_conn->has_present) {
182 xcb_present_query_version_cookie_t ver_cookie;
183 xcb_present_query_version_reply_t *ver_reply;
184
185 ver_cookie = xcb_present_query_version(conn, 1, 2);
186 ver_reply = xcb_present_query_version_reply(conn, ver_cookie, NULL);
187 has_present_v1_2 =
188 (ver_reply->major_version > 1 || ver_reply->minor_version >= 2);
189 free(ver_reply);
190 }
191 #endif
192
193 wsi_conn->has_dri3_modifiers = has_dri3_v1_2 && has_present_v1_2;
194 wsi_conn->is_proprietary_x11 = false;
195 if (amd_reply && amd_reply->present)
196 wsi_conn->is_proprietary_x11 = true;
197 if (nv_reply && nv_reply->present)
198 wsi_conn->is_proprietary_x11 = true;
199
200 free(dri3_reply);
201 free(pres_reply);
202 free(amd_reply);
203 free(nv_reply);
204
205 return wsi_conn;
206 }
207
208 static void
209 wsi_x11_connection_destroy(struct wsi_device *wsi_dev,
210 struct wsi_x11_connection *conn)
211 {
212 vk_free(&wsi_dev->instance_alloc, conn);
213 }
214
215 static bool
216 wsi_x11_check_for_dri3(struct wsi_x11_connection *wsi_conn)
217 {
218 if (wsi_conn->has_dri3)
219 return true;
220 if (!wsi_conn->is_proprietary_x11) {
221 fprintf(stderr, "vulkan: No DRI3 support detected - required for presentation\n"
222 "Note: you can probably enable DRI3 in your Xorg config\n");
223 }
224 return false;
225 }
226
227 static struct wsi_x11_connection *
228 wsi_x11_get_connection(struct wsi_device *wsi_dev,
229 xcb_connection_t *conn)
230 {
231 struct wsi_x11 *wsi =
232 (struct wsi_x11 *)wsi_dev->wsi[VK_ICD_WSI_PLATFORM_XCB];
233
234 pthread_mutex_lock(&wsi->mutex);
235
236 struct hash_entry *entry = _mesa_hash_table_search(wsi->connections, conn);
237 if (!entry) {
238 /* We're about to make a bunch of blocking calls. Let's drop the
239 * mutex for now so we don't block up too badly.
240 */
241 pthread_mutex_unlock(&wsi->mutex);
242
243 struct wsi_x11_connection *wsi_conn =
244 wsi_x11_connection_create(wsi_dev, conn);
245 if (!wsi_conn)
246 return NULL;
247
248 pthread_mutex_lock(&wsi->mutex);
249
250 entry = _mesa_hash_table_search(wsi->connections, conn);
251 if (entry) {
252 /* Oops, someone raced us to it */
253 wsi_x11_connection_destroy(wsi_dev, wsi_conn);
254 } else {
255 entry = _mesa_hash_table_insert(wsi->connections, conn, wsi_conn);
256 }
257 }
258
259 pthread_mutex_unlock(&wsi->mutex);
260
261 return entry->data;
262 }
263
264 static const VkFormat formats[] = {
265 VK_FORMAT_B8G8R8A8_SRGB,
266 VK_FORMAT_B8G8R8A8_UNORM,
267 };
268
269 static const VkPresentModeKHR present_modes[] = {
270 VK_PRESENT_MODE_IMMEDIATE_KHR,
271 VK_PRESENT_MODE_MAILBOX_KHR,
272 VK_PRESENT_MODE_FIFO_KHR,
273 };
274
275 static xcb_screen_t *
276 get_screen_for_root(xcb_connection_t *conn, xcb_window_t root)
277 {
278 xcb_screen_iterator_t screen_iter =
279 xcb_setup_roots_iterator(xcb_get_setup(conn));
280
281 for (; screen_iter.rem; xcb_screen_next (&screen_iter)) {
282 if (screen_iter.data->root == root)
283 return screen_iter.data;
284 }
285
286 return NULL;
287 }
288
289 static xcb_visualtype_t *
290 screen_get_visualtype(xcb_screen_t *screen, xcb_visualid_t visual_id,
291 unsigned *depth)
292 {
293 xcb_depth_iterator_t depth_iter =
294 xcb_screen_allowed_depths_iterator(screen);
295
296 for (; depth_iter.rem; xcb_depth_next (&depth_iter)) {
297 xcb_visualtype_iterator_t visual_iter =
298 xcb_depth_visuals_iterator (depth_iter.data);
299
300 for (; visual_iter.rem; xcb_visualtype_next (&visual_iter)) {
301 if (visual_iter.data->visual_id == visual_id) {
302 if (depth)
303 *depth = depth_iter.data->depth;
304 return visual_iter.data;
305 }
306 }
307 }
308
309 return NULL;
310 }
311
312 static xcb_visualtype_t *
313 connection_get_visualtype(xcb_connection_t *conn, xcb_visualid_t visual_id,
314 unsigned *depth)
315 {
316 xcb_screen_iterator_t screen_iter =
317 xcb_setup_roots_iterator(xcb_get_setup(conn));
318
319 /* For this we have to iterate over all of the screens which is rather
320 * annoying. Fortunately, there is probably only 1.
321 */
322 for (; screen_iter.rem; xcb_screen_next (&screen_iter)) {
323 xcb_visualtype_t *visual = screen_get_visualtype(screen_iter.data,
324 visual_id, depth);
325 if (visual)
326 return visual;
327 }
328
329 return NULL;
330 }
331
332 static xcb_visualtype_t *
333 get_visualtype_for_window(xcb_connection_t *conn, xcb_window_t window,
334 unsigned *depth)
335 {
336 xcb_query_tree_cookie_t tree_cookie;
337 xcb_get_window_attributes_cookie_t attrib_cookie;
338 xcb_query_tree_reply_t *tree;
339 xcb_get_window_attributes_reply_t *attrib;
340
341 tree_cookie = xcb_query_tree(conn, window);
342 attrib_cookie = xcb_get_window_attributes(conn, window);
343
344 tree = xcb_query_tree_reply(conn, tree_cookie, NULL);
345 attrib = xcb_get_window_attributes_reply(conn, attrib_cookie, NULL);
346 if (attrib == NULL || tree == NULL) {
347 free(attrib);
348 free(tree);
349 return NULL;
350 }
351
352 xcb_window_t root = tree->root;
353 xcb_visualid_t visual_id = attrib->visual;
354 free(attrib);
355 free(tree);
356
357 xcb_screen_t *screen = get_screen_for_root(conn, root);
358 if (screen == NULL)
359 return NULL;
360
361 return screen_get_visualtype(screen, visual_id, depth);
362 }
363
364 static bool
365 visual_has_alpha(xcb_visualtype_t *visual, unsigned depth)
366 {
367 uint32_t rgb_mask = visual->red_mask |
368 visual->green_mask |
369 visual->blue_mask;
370
371 uint32_t all_mask = 0xffffffff >> (32 - depth);
372
373 /* Do we have bits left over after RGB? */
374 return (all_mask & ~rgb_mask) != 0;
375 }
376
377 VkBool32 wsi_get_physical_device_xcb_presentation_support(
378 struct wsi_device *wsi_device,
379 uint32_t queueFamilyIndex,
380 xcb_connection_t* connection,
381 xcb_visualid_t visual_id)
382 {
383 struct wsi_x11_connection *wsi_conn =
384 wsi_x11_get_connection(wsi_device, connection);
385
386 if (!wsi_conn)
387 return false;
388
389 if (!wsi_x11_check_for_dri3(wsi_conn))
390 return false;
391
392 unsigned visual_depth;
393 if (!connection_get_visualtype(connection, visual_id, &visual_depth))
394 return false;
395
396 if (visual_depth != 24 && visual_depth != 32)
397 return false;
398
399 return true;
400 }
401
402 static xcb_connection_t*
403 x11_surface_get_connection(VkIcdSurfaceBase *icd_surface)
404 {
405 if (icd_surface->platform == VK_ICD_WSI_PLATFORM_XLIB)
406 return XGetXCBConnection(((VkIcdSurfaceXlib *)icd_surface)->dpy);
407 else
408 return ((VkIcdSurfaceXcb *)icd_surface)->connection;
409 }
410
411 static xcb_window_t
412 x11_surface_get_window(VkIcdSurfaceBase *icd_surface)
413 {
414 if (icd_surface->platform == VK_ICD_WSI_PLATFORM_XLIB)
415 return ((VkIcdSurfaceXlib *)icd_surface)->window;
416 else
417 return ((VkIcdSurfaceXcb *)icd_surface)->window;
418 }
419
420 static VkResult
421 x11_surface_get_support(VkIcdSurfaceBase *icd_surface,
422 struct wsi_device *wsi_device,
423 uint32_t queueFamilyIndex,
424 VkBool32* pSupported)
425 {
426 xcb_connection_t *conn = x11_surface_get_connection(icd_surface);
427 xcb_window_t window = x11_surface_get_window(icd_surface);
428
429 struct wsi_x11_connection *wsi_conn =
430 wsi_x11_get_connection(wsi_device, conn);
431 if (!wsi_conn)
432 return VK_ERROR_OUT_OF_HOST_MEMORY;
433
434 if (!wsi_x11_check_for_dri3(wsi_conn)) {
435 *pSupported = false;
436 return VK_SUCCESS;
437 }
438
439 unsigned visual_depth;
440 if (!get_visualtype_for_window(conn, window, &visual_depth)) {
441 *pSupported = false;
442 return VK_SUCCESS;
443 }
444
445 if (visual_depth != 24 && visual_depth != 32) {
446 *pSupported = false;
447 return VK_SUCCESS;
448 }
449
450 *pSupported = true;
451 return VK_SUCCESS;
452 }
453
454 static uint32_t
455 x11_get_min_image_count(struct wsi_device *wsi_device)
456 {
457 if (wsi_device->x11.override_minImageCount)
458 return wsi_device->x11.override_minImageCount;
459
460 /* For IMMEDIATE and FIFO, most games work in a pipelined manner where the
461 * can produce frames at a rate of 1/MAX(CPU duration, GPU duration), but
462 * the render latency is CPU duration + GPU duration.
463 *
464 * This means that with scanout from pageflipping we need 3 frames to run
465 * full speed:
466 * 1) CPU rendering work
467 * 2) GPU rendering work
468 * 3) scanout
469 *
470 * Once we have a nonblocking acquire that returns a semaphore we can merge
471 * 1 and 3. Hence the ideal implementation needs only 2 images, but games
472 * cannot tellwe currently do not have an ideal implementation and that
473 * hence they need to allocate 3 images. So let us do it for them.
474 *
475 * This is a tradeoff as it uses more memory than needed for non-fullscreen
476 * and non-performance intensive applications.
477 */
478 return 3;
479 }
480
481 static VkResult
482 x11_surface_get_capabilities(VkIcdSurfaceBase *icd_surface,
483 struct wsi_device *wsi_device,
484 VkSurfaceCapabilitiesKHR *caps)
485 {
486 xcb_connection_t *conn = x11_surface_get_connection(icd_surface);
487 xcb_window_t window = x11_surface_get_window(icd_surface);
488 xcb_get_geometry_cookie_t geom_cookie;
489 xcb_generic_error_t *err;
490 xcb_get_geometry_reply_t *geom;
491 unsigned visual_depth;
492
493 geom_cookie = xcb_get_geometry(conn, window);
494
495 /* This does a round-trip. This is why we do get_geometry first and
496 * wait to read the reply until after we have a visual.
497 */
498 xcb_visualtype_t *visual =
499 get_visualtype_for_window(conn, window, &visual_depth);
500
501 if (!visual)
502 return VK_ERROR_SURFACE_LOST_KHR;
503
504 geom = xcb_get_geometry_reply(conn, geom_cookie, &err);
505 if (geom) {
506 VkExtent2D extent = { geom->width, geom->height };
507 caps->currentExtent = extent;
508 caps->minImageExtent = extent;
509 caps->maxImageExtent = extent;
510 } else {
511 /* This can happen if the client didn't wait for the configure event
512 * to come back from the compositor. In that case, we don't know the
513 * size of the window so we just return valid "I don't know" stuff.
514 */
515 caps->currentExtent = (VkExtent2D) { -1, -1 };
516 caps->minImageExtent = (VkExtent2D) { 1, 1 };
517 caps->maxImageExtent = (VkExtent2D) {
518 wsi_device->maxImageDimension2D,
519 wsi_device->maxImageDimension2D,
520 };
521 }
522 free(err);
523 free(geom);
524
525 if (visual_has_alpha(visual, visual_depth)) {
526 caps->supportedCompositeAlpha = VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR |
527 VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR;
528 } else {
529 caps->supportedCompositeAlpha = VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR |
530 VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR;
531 }
532
533 caps->minImageCount = x11_get_min_image_count(wsi_device);
534 /* There is no real maximum */
535 caps->maxImageCount = 0;
536
537 caps->supportedTransforms = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
538 caps->currentTransform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
539 caps->maxImageArrayLayers = 1;
540 caps->supportedUsageFlags =
541 VK_IMAGE_USAGE_TRANSFER_SRC_BIT |
542 VK_IMAGE_USAGE_SAMPLED_BIT |
543 VK_IMAGE_USAGE_TRANSFER_DST_BIT |
544 VK_IMAGE_USAGE_STORAGE_BIT |
545 VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
546
547 return VK_SUCCESS;
548 }
549
550 static VkResult
551 x11_surface_get_capabilities2(VkIcdSurfaceBase *icd_surface,
552 struct wsi_device *wsi_device,
553 const void *info_next,
554 VkSurfaceCapabilities2KHR *caps)
555 {
556 assert(caps->sType == VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR);
557
558 VkResult result =
559 x11_surface_get_capabilities(icd_surface, wsi_device,
560 &caps->surfaceCapabilities);
561
562 vk_foreach_struct(ext, caps->pNext) {
563 switch (ext->sType) {
564 case VK_STRUCTURE_TYPE_SURFACE_PROTECTED_CAPABILITIES_KHR: {
565 VkSurfaceProtectedCapabilitiesKHR *protected = (void *)ext;
566 protected->supportsProtected = VK_FALSE;
567 break;
568 }
569
570 default:
571 /* Ignored */
572 break;
573 }
574 }
575
576 return result;
577 }
578
579 static void
580 get_sorted_vk_formats(struct wsi_device *wsi_device, VkFormat *sorted_formats)
581 {
582 memcpy(sorted_formats, formats, sizeof(formats));
583
584 if (wsi_device->force_bgra8_unorm_first) {
585 for (unsigned i = 0; i < ARRAY_SIZE(formats); i++) {
586 if (sorted_formats[i] == VK_FORMAT_B8G8R8A8_UNORM) {
587 sorted_formats[i] = sorted_formats[0];
588 sorted_formats[0] = VK_FORMAT_B8G8R8A8_UNORM;
589 break;
590 }
591 }
592 }
593 }
594
595 static VkResult
596 x11_surface_get_formats(VkIcdSurfaceBase *surface,
597 struct wsi_device *wsi_device,
598 uint32_t *pSurfaceFormatCount,
599 VkSurfaceFormatKHR *pSurfaceFormats)
600 {
601 VK_OUTARRAY_MAKE(out, pSurfaceFormats, pSurfaceFormatCount);
602
603 VkFormat sorted_formats[ARRAY_SIZE(formats)];
604 get_sorted_vk_formats(wsi_device, sorted_formats);
605
606 for (unsigned i = 0; i < ARRAY_SIZE(sorted_formats); i++) {
607 vk_outarray_append(&out, f) {
608 f->format = sorted_formats[i];
609 f->colorSpace = VK_COLORSPACE_SRGB_NONLINEAR_KHR;
610 }
611 }
612
613 return vk_outarray_status(&out);
614 }
615
616 static VkResult
617 x11_surface_get_formats2(VkIcdSurfaceBase *surface,
618 struct wsi_device *wsi_device,
619 const void *info_next,
620 uint32_t *pSurfaceFormatCount,
621 VkSurfaceFormat2KHR *pSurfaceFormats)
622 {
623 VK_OUTARRAY_MAKE(out, pSurfaceFormats, pSurfaceFormatCount);
624
625 VkFormat sorted_formats[ARRAY_SIZE(formats)];
626 get_sorted_vk_formats(wsi_device, sorted_formats);
627
628 for (unsigned i = 0; i < ARRAY_SIZE(sorted_formats); i++) {
629 vk_outarray_append(&out, f) {
630 assert(f->sType == VK_STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR);
631 f->surfaceFormat.format = sorted_formats[i];
632 f->surfaceFormat.colorSpace = VK_COLORSPACE_SRGB_NONLINEAR_KHR;
633 }
634 }
635
636 return vk_outarray_status(&out);
637 }
638
639 static VkResult
640 x11_surface_get_present_modes(VkIcdSurfaceBase *surface,
641 uint32_t *pPresentModeCount,
642 VkPresentModeKHR *pPresentModes)
643 {
644 if (pPresentModes == NULL) {
645 *pPresentModeCount = ARRAY_SIZE(present_modes);
646 return VK_SUCCESS;
647 }
648
649 *pPresentModeCount = MIN2(*pPresentModeCount, ARRAY_SIZE(present_modes));
650 typed_memcpy(pPresentModes, present_modes, *pPresentModeCount);
651
652 return *pPresentModeCount < ARRAY_SIZE(present_modes) ?
653 VK_INCOMPLETE : VK_SUCCESS;
654 }
655
656 static bool
657 x11_surface_is_local_to_gpu(struct wsi_device *wsi_dev,
658 xcb_connection_t *conn)
659 {
660 struct wsi_x11_connection *wsi_conn =
661 wsi_x11_get_connection(wsi_dev, conn);
662
663 if (!wsi_conn)
664 return false;
665
666 if (!wsi_x11_check_for_dri3(wsi_conn))
667 return false;
668
669 if (!wsi_x11_check_dri3_compatible(wsi_dev, conn))
670 return false;
671
672 return true;
673 }
674
675 static VkResult
676 x11_surface_get_present_rectangles(VkIcdSurfaceBase *icd_surface,
677 struct wsi_device *wsi_device,
678 uint32_t* pRectCount,
679 VkRect2D* pRects)
680 {
681 xcb_connection_t *conn = x11_surface_get_connection(icd_surface);
682 xcb_window_t window = x11_surface_get_window(icd_surface);
683 VK_OUTARRAY_MAKE(out, pRects, pRectCount);
684
685 if (x11_surface_is_local_to_gpu(wsi_device, conn)) {
686 vk_outarray_append(&out, rect) {
687 xcb_generic_error_t *err = NULL;
688 xcb_get_geometry_cookie_t geom_cookie = xcb_get_geometry(conn, window);
689 xcb_get_geometry_reply_t *geom =
690 xcb_get_geometry_reply(conn, geom_cookie, &err);
691 free(err);
692 if (geom) {
693 *rect = (VkRect2D) {
694 .offset = { 0, 0 },
695 .extent = { geom->width, geom->height },
696 };
697 } else {
698 /* This can happen if the client didn't wait for the configure event
699 * to come back from the compositor. In that case, we don't know the
700 * size of the window so we just return valid "I don't know" stuff.
701 */
702 *rect = (VkRect2D) {
703 .offset = { 0, 0 },
704 .extent = { -1, -1 },
705 };
706 }
707 free(geom);
708 }
709 }
710
711 return vk_outarray_status(&out);
712 }
713
714 VkResult wsi_create_xcb_surface(const VkAllocationCallbacks *pAllocator,
715 const VkXcbSurfaceCreateInfoKHR *pCreateInfo,
716 VkSurfaceKHR *pSurface)
717 {
718 VkIcdSurfaceXcb *surface;
719
720 surface = vk_alloc(pAllocator, sizeof *surface, 8,
721 VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
722 if (surface == NULL)
723 return VK_ERROR_OUT_OF_HOST_MEMORY;
724
725 surface->base.platform = VK_ICD_WSI_PLATFORM_XCB;
726 surface->connection = pCreateInfo->connection;
727 surface->window = pCreateInfo->window;
728
729 *pSurface = VkIcdSurfaceBase_to_handle(&surface->base);
730 return VK_SUCCESS;
731 }
732
733 VkResult wsi_create_xlib_surface(const VkAllocationCallbacks *pAllocator,
734 const VkXlibSurfaceCreateInfoKHR *pCreateInfo,
735 VkSurfaceKHR *pSurface)
736 {
737 VkIcdSurfaceXlib *surface;
738
739 surface = vk_alloc(pAllocator, sizeof *surface, 8,
740 VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
741 if (surface == NULL)
742 return VK_ERROR_OUT_OF_HOST_MEMORY;
743
744 surface->base.platform = VK_ICD_WSI_PLATFORM_XLIB;
745 surface->dpy = pCreateInfo->dpy;
746 surface->window = pCreateInfo->window;
747
748 *pSurface = VkIcdSurfaceBase_to_handle(&surface->base);
749 return VK_SUCCESS;
750 }
751
752 struct x11_image {
753 struct wsi_image base;
754 xcb_pixmap_t pixmap;
755 bool busy;
756 struct xshmfence * shm_fence;
757 uint32_t sync_fence;
758 };
759
760 struct x11_swapchain {
761 struct wsi_swapchain base;
762
763 bool has_dri3_modifiers;
764
765 xcb_connection_t * conn;
766 xcb_window_t window;
767 xcb_gc_t gc;
768 uint32_t depth;
769 VkExtent2D extent;
770
771 xcb_present_event_t event_id;
772 xcb_special_event_t * special_event;
773 uint64_t send_sbc;
774 uint64_t last_present_msc;
775 uint32_t stamp;
776
777 bool has_present_queue;
778 bool has_acquire_queue;
779 VkResult status;
780 xcb_present_complete_mode_t last_present_mode;
781 struct wsi_queue present_queue;
782 struct wsi_queue acquire_queue;
783 pthread_t queue_manager;
784
785 struct x11_image images[0];
786 };
787 VK_DEFINE_NONDISP_HANDLE_CASTS(x11_swapchain, base.base, VkSwapchainKHR,
788 VK_OBJECT_TYPE_SWAPCHAIN_KHR)
789
790 /**
791 * Update the swapchain status with the result of an operation, and return
792 * the combined status. The chain status will eventually be returned from
793 * AcquireNextImage and QueuePresent.
794 *
795 * We make sure to 'stick' more pessimistic statuses: an out-of-date error
796 * is permanent once seen, and every subsequent call will return this. If
797 * this has not been seen, success will be returned.
798 */
799 static VkResult
800 _x11_swapchain_result(struct x11_swapchain *chain, VkResult result,
801 const char *file, int line)
802 {
803 /* Prioritise returning existing errors for consistency. */
804 if (chain->status < 0)
805 return chain->status;
806
807 /* If we have a new error, mark it as permanent on the chain and return. */
808 if (result < 0) {
809 #ifndef NDEBUG
810 fprintf(stderr, "%s:%d: Swapchain status changed to %s\n",
811 file, line, vk_Result_to_str(result));
812 #endif
813 chain->status = result;
814 return result;
815 }
816
817 /* Return temporary errors, but don't persist them. */
818 if (result == VK_TIMEOUT || result == VK_NOT_READY)
819 return result;
820
821 /* Suboptimal isn't an error, but is a status which sticks to the swapchain
822 * and is always returned rather than success.
823 */
824 if (result == VK_SUBOPTIMAL_KHR) {
825 #ifndef NDEBUG
826 if (chain->status != VK_SUBOPTIMAL_KHR) {
827 fprintf(stderr, "%s:%d: Swapchain status changed to %s\n",
828 file, line, vk_Result_to_str(result));
829 }
830 #endif
831 chain->status = result;
832 return result;
833 }
834
835 /* No changes, so return the last status. */
836 return chain->status;
837 }
838 #define x11_swapchain_result(chain, result) \
839 _x11_swapchain_result(chain, result, __FILE__, __LINE__)
840
841 static struct wsi_image *
842 x11_get_wsi_image(struct wsi_swapchain *wsi_chain, uint32_t image_index)
843 {
844 struct x11_swapchain *chain = (struct x11_swapchain *)wsi_chain;
845 return &chain->images[image_index].base;
846 }
847
848 /**
849 * Process an X11 Present event. Does not update chain->status.
850 */
851 static VkResult
852 x11_handle_dri3_present_event(struct x11_swapchain *chain,
853 xcb_present_generic_event_t *event)
854 {
855 switch (event->evtype) {
856 case XCB_PRESENT_CONFIGURE_NOTIFY: {
857 xcb_present_configure_notify_event_t *config = (void *) event;
858
859 if (config->width != chain->extent.width ||
860 config->height != chain->extent.height)
861 return VK_ERROR_OUT_OF_DATE_KHR;
862
863 break;
864 }
865
866 case XCB_PRESENT_EVENT_IDLE_NOTIFY: {
867 xcb_present_idle_notify_event_t *idle = (void *) event;
868
869 for (unsigned i = 0; i < chain->base.image_count; i++) {
870 if (chain->images[i].pixmap == idle->pixmap) {
871 chain->images[i].busy = false;
872 if (chain->has_acquire_queue)
873 wsi_queue_push(&chain->acquire_queue, i);
874 break;
875 }
876 }
877
878 break;
879 }
880
881 case XCB_PRESENT_EVENT_COMPLETE_NOTIFY: {
882 xcb_present_complete_notify_event_t *complete = (void *) event;
883 if (complete->kind == XCB_PRESENT_COMPLETE_KIND_PIXMAP)
884 chain->last_present_msc = complete->msc;
885
886 VkResult result = VK_SUCCESS;
887
888 /* The winsys is now trying to flip directly and cannot due to our
889 * configuration. Request the user reallocate.
890 */
891 #ifdef HAVE_DRI3_MODIFIERS
892 if (complete->mode == XCB_PRESENT_COMPLETE_MODE_SUBOPTIMAL_COPY &&
893 chain->last_present_mode != XCB_PRESENT_COMPLETE_MODE_SUBOPTIMAL_COPY)
894 result = VK_SUBOPTIMAL_KHR;
895 #endif
896
897 /* When we go from flipping to copying, the odds are very likely that
898 * we could reallocate in a more optimal way if we didn't have to care
899 * about scanout, so we always do this.
900 */
901 if (complete->mode == XCB_PRESENT_COMPLETE_MODE_COPY &&
902 chain->last_present_mode == XCB_PRESENT_COMPLETE_MODE_FLIP)
903 result = VK_SUBOPTIMAL_KHR;
904
905 chain->last_present_mode = complete->mode;
906 return result;
907 }
908
909 default:
910 break;
911 }
912
913 return VK_SUCCESS;
914 }
915
916
917 static uint64_t wsi_get_absolute_timeout(uint64_t timeout)
918 {
919 uint64_t current_time = wsi_common_get_current_time();
920
921 timeout = MIN2(UINT64_MAX - current_time, timeout);
922
923 return current_time + timeout;
924 }
925
926 static VkResult
927 x11_acquire_next_image_poll_x11(struct x11_swapchain *chain,
928 uint32_t *image_index, uint64_t timeout)
929 {
930 xcb_generic_event_t *event;
931 struct pollfd pfds;
932 uint64_t atimeout;
933 while (1) {
934 for (uint32_t i = 0; i < chain->base.image_count; i++) {
935 if (!chain->images[i].busy) {
936 /* We found a non-busy image */
937 xshmfence_await(chain->images[i].shm_fence);
938 *image_index = i;
939 chain->images[i].busy = true;
940 return x11_swapchain_result(chain, VK_SUCCESS);
941 }
942 }
943
944 xcb_flush(chain->conn);
945
946 if (timeout == UINT64_MAX) {
947 event = xcb_wait_for_special_event(chain->conn, chain->special_event);
948 if (!event)
949 return x11_swapchain_result(chain, VK_ERROR_OUT_OF_DATE_KHR);
950 } else {
951 event = xcb_poll_for_special_event(chain->conn, chain->special_event);
952 if (!event) {
953 int ret;
954 if (timeout == 0)
955 return x11_swapchain_result(chain, VK_NOT_READY);
956
957 atimeout = wsi_get_absolute_timeout(timeout);
958
959 pfds.fd = xcb_get_file_descriptor(chain->conn);
960 pfds.events = POLLIN;
961 ret = poll(&pfds, 1, timeout / 1000 / 1000);
962 if (ret == 0)
963 return x11_swapchain_result(chain, VK_TIMEOUT);
964 if (ret == -1)
965 return x11_swapchain_result(chain, VK_ERROR_OUT_OF_DATE_KHR);
966
967 /* If a non-special event happens, the fd will still
968 * poll. So recalculate the timeout now just in case.
969 */
970 uint64_t current_time = wsi_common_get_current_time();
971 if (atimeout > current_time)
972 timeout = atimeout - current_time;
973 else
974 timeout = 0;
975 continue;
976 }
977 }
978
979 /* Update the swapchain status here. We may catch non-fatal errors here,
980 * in which case we need to update the status and continue.
981 */
982 VkResult result = x11_handle_dri3_present_event(chain, (void *)event);
983 free(event);
984 if (result < 0)
985 return x11_swapchain_result(chain, result);
986 }
987 }
988
989 static VkResult
990 x11_acquire_next_image_from_queue(struct x11_swapchain *chain,
991 uint32_t *image_index_out, uint64_t timeout)
992 {
993 assert(chain->has_acquire_queue);
994
995 uint32_t image_index;
996 VkResult result = wsi_queue_pull(&chain->acquire_queue,
997 &image_index, timeout);
998 if (result < 0 || result == VK_TIMEOUT) {
999 /* On error, the thread has shut down, so safe to update chain->status.
1000 * Calling x11_swapchain_result with VK_TIMEOUT won't modify
1001 * chain->status so that is also safe.
1002 */
1003 return x11_swapchain_result(chain, result);
1004 } else if (chain->status < 0) {
1005 return chain->status;
1006 }
1007
1008 assert(image_index < chain->base.image_count);
1009 xshmfence_await(chain->images[image_index].shm_fence);
1010
1011 *image_index_out = image_index;
1012
1013 return chain->status;
1014 }
1015
1016 static VkResult
1017 x11_present_to_x11(struct x11_swapchain *chain, uint32_t image_index,
1018 uint32_t target_msc)
1019 {
1020 struct x11_image *image = &chain->images[image_index];
1021
1022 assert(image_index < chain->base.image_count);
1023
1024 uint32_t options = XCB_PRESENT_OPTION_NONE;
1025
1026 int64_t divisor = 0;
1027 int64_t remainder = 0;
1028
1029 if (chain->base.present_mode == VK_PRESENT_MODE_IMMEDIATE_KHR)
1030 options |= XCB_PRESENT_OPTION_ASYNC;
1031
1032 #ifdef HAVE_DRI3_MODIFIERS
1033 if (chain->has_dri3_modifiers)
1034 options |= XCB_PRESENT_OPTION_SUBOPTIMAL;
1035 #endif
1036
1037 /* Poll for any available event and update the swapchain status. This could
1038 * update the status of the swapchain to SUBOPTIMAL or OUT_OF_DATE if the
1039 * associated X11 surface has been resized.
1040 */
1041 xcb_generic_event_t *event;
1042 while ((event = xcb_poll_for_special_event(chain->conn, chain->special_event))) {
1043 VkResult result = x11_handle_dri3_present_event(chain, (void *)event);
1044 free(event);
1045 if (result < 0)
1046 return x11_swapchain_result(chain, result);
1047 x11_swapchain_result(chain, result);
1048 }
1049
1050 xshmfence_reset(image->shm_fence);
1051
1052 ++chain->send_sbc;
1053 xcb_void_cookie_t cookie =
1054 xcb_present_pixmap(chain->conn,
1055 chain->window,
1056 image->pixmap,
1057 (uint32_t) chain->send_sbc,
1058 0, /* valid */
1059 0, /* update */
1060 0, /* x_off */
1061 0, /* y_off */
1062 XCB_NONE, /* target_crtc */
1063 XCB_NONE,
1064 image->sync_fence,
1065 options,
1066 target_msc,
1067 divisor,
1068 remainder, 0, NULL);
1069 xcb_discard_reply(chain->conn, cookie.sequence);
1070
1071 xcb_flush(chain->conn);
1072
1073 return x11_swapchain_result(chain, VK_SUCCESS);
1074 }
1075
1076 static VkResult
1077 x11_acquire_next_image(struct wsi_swapchain *anv_chain,
1078 const VkAcquireNextImageInfoKHR *info,
1079 uint32_t *image_index)
1080 {
1081 struct x11_swapchain *chain = (struct x11_swapchain *)anv_chain;
1082 uint64_t timeout = info->timeout;
1083
1084 /* If the swapchain is in an error state, don't go any further. */
1085 if (chain->status < 0)
1086 return chain->status;
1087
1088 if (chain->has_acquire_queue) {
1089 return x11_acquire_next_image_from_queue(chain, image_index, timeout);
1090 } else {
1091 return x11_acquire_next_image_poll_x11(chain, image_index, timeout);
1092 }
1093 }
1094
1095 static VkResult
1096 x11_queue_present(struct wsi_swapchain *anv_chain,
1097 uint32_t image_index,
1098 const VkPresentRegionKHR *damage)
1099 {
1100 struct x11_swapchain *chain = (struct x11_swapchain *)anv_chain;
1101
1102 /* If the swapchain is in an error state, don't go any further. */
1103 if (chain->status < 0)
1104 return chain->status;
1105
1106 chain->images[image_index].busy = true;
1107 if (chain->has_present_queue) {
1108 wsi_queue_push(&chain->present_queue, image_index);
1109 return chain->status;
1110 } else {
1111 return x11_present_to_x11(chain, image_index, 0);
1112 }
1113 }
1114
1115 static void *
1116 x11_manage_fifo_queues(void *state)
1117 {
1118 struct x11_swapchain *chain = state;
1119 VkResult result = VK_SUCCESS;
1120
1121 assert(chain->has_present_queue);
1122 while (chain->status >= 0) {
1123 /* It should be safe to unconditionally block here. Later in the loop
1124 * we blocks until the previous present has landed on-screen. At that
1125 * point, we should have received IDLE_NOTIFY on all images presented
1126 * before that point so the client should be able to acquire any image
1127 * other than the currently presented one.
1128 */
1129 uint32_t image_index = 0;
1130 result = wsi_queue_pull(&chain->present_queue, &image_index, INT64_MAX);
1131 assert(result != VK_TIMEOUT);
1132 if (result < 0) {
1133 goto fail;
1134 } else if (chain->status < 0) {
1135 /* The status can change underneath us if the swapchain is destroyed
1136 * from another thread.
1137 */
1138 return NULL;
1139 }
1140
1141 if (chain->base.present_mode == VK_PRESENT_MODE_MAILBOX_KHR) {
1142 result = chain->base.wsi->WaitForFences(chain->base.device, 1,
1143 &chain->base.fences[image_index],
1144 true, UINT64_MAX);
1145 if (result != VK_SUCCESS) {
1146 result = VK_ERROR_OUT_OF_DATE_KHR;
1147 goto fail;
1148 }
1149 }
1150
1151 uint64_t target_msc = 0;
1152 if (chain->has_acquire_queue)
1153 target_msc = chain->last_present_msc + 1;
1154
1155 result = x11_present_to_x11(chain, image_index, target_msc);
1156 if (result < 0)
1157 goto fail;
1158
1159 if (chain->has_acquire_queue) {
1160 while (chain->last_present_msc < target_msc) {
1161 xcb_generic_event_t *event =
1162 xcb_wait_for_special_event(chain->conn, chain->special_event);
1163 if (!event) {
1164 result = VK_ERROR_OUT_OF_DATE_KHR;
1165 goto fail;
1166 }
1167
1168 result = x11_handle_dri3_present_event(chain, (void *)event);
1169 free(event);
1170 if (result < 0)
1171 goto fail;
1172 }
1173 }
1174 }
1175
1176 fail:
1177 x11_swapchain_result(chain, result);
1178 if (chain->has_acquire_queue)
1179 wsi_queue_push(&chain->acquire_queue, UINT32_MAX);
1180
1181 return NULL;
1182 }
1183
1184 static VkResult
1185 x11_image_init(VkDevice device_h, struct x11_swapchain *chain,
1186 const VkSwapchainCreateInfoKHR *pCreateInfo,
1187 const VkAllocationCallbacks* pAllocator,
1188 const uint64_t *const *modifiers,
1189 const uint32_t *num_modifiers,
1190 int num_tranches, struct x11_image *image)
1191 {
1192 xcb_void_cookie_t cookie;
1193 VkResult result;
1194 uint32_t bpp = 32;
1195
1196 if (chain->base.use_prime_blit) {
1197 bool use_modifier = num_tranches > 0;
1198 result = wsi_create_prime_image(&chain->base, pCreateInfo, use_modifier, &image->base);
1199 } else {
1200 result = wsi_create_native_image(&chain->base, pCreateInfo,
1201 num_tranches, num_modifiers, modifiers,
1202 &image->base);
1203 }
1204 if (result < 0)
1205 return result;
1206
1207 image->pixmap = xcb_generate_id(chain->conn);
1208
1209 #ifdef HAVE_DRI3_MODIFIERS
1210 if (image->base.drm_modifier != DRM_FORMAT_MOD_INVALID) {
1211 /* If the image has a modifier, we must have DRI3 v1.2. */
1212 assert(chain->has_dri3_modifiers);
1213
1214 cookie =
1215 xcb_dri3_pixmap_from_buffers_checked(chain->conn,
1216 image->pixmap,
1217 chain->window,
1218 image->base.num_planes,
1219 pCreateInfo->imageExtent.width,
1220 pCreateInfo->imageExtent.height,
1221 image->base.row_pitches[0],
1222 image->base.offsets[0],
1223 image->base.row_pitches[1],
1224 image->base.offsets[1],
1225 image->base.row_pitches[2],
1226 image->base.offsets[2],
1227 image->base.row_pitches[3],
1228 image->base.offsets[3],
1229 chain->depth, bpp,
1230 image->base.drm_modifier,
1231 image->base.fds);
1232 } else
1233 #endif
1234 {
1235 /* Without passing modifiers, we can't have multi-plane RGB images. */
1236 assert(image->base.num_planes == 1);
1237
1238 cookie =
1239 xcb_dri3_pixmap_from_buffer_checked(chain->conn,
1240 image->pixmap,
1241 chain->window,
1242 image->base.sizes[0],
1243 pCreateInfo->imageExtent.width,
1244 pCreateInfo->imageExtent.height,
1245 image->base.row_pitches[0],
1246 chain->depth, bpp,
1247 image->base.fds[0]);
1248 }
1249
1250 xcb_discard_reply(chain->conn, cookie.sequence);
1251
1252 /* XCB has now taken ownership of the FDs. */
1253 for (int i = 0; i < image->base.num_planes; i++)
1254 image->base.fds[i] = -1;
1255
1256 int fence_fd = xshmfence_alloc_shm();
1257 if (fence_fd < 0)
1258 goto fail_pixmap;
1259
1260 image->shm_fence = xshmfence_map_shm(fence_fd);
1261 if (image->shm_fence == NULL)
1262 goto fail_shmfence_alloc;
1263
1264 image->sync_fence = xcb_generate_id(chain->conn);
1265 xcb_dri3_fence_from_fd(chain->conn,
1266 image->pixmap,
1267 image->sync_fence,
1268 false,
1269 fence_fd);
1270
1271 image->busy = false;
1272 xshmfence_trigger(image->shm_fence);
1273
1274 return VK_SUCCESS;
1275
1276 fail_shmfence_alloc:
1277 close(fence_fd);
1278
1279 fail_pixmap:
1280 cookie = xcb_free_pixmap(chain->conn, image->pixmap);
1281 xcb_discard_reply(chain->conn, cookie.sequence);
1282
1283 wsi_destroy_image(&chain->base, &image->base);
1284
1285 return result;
1286 }
1287
1288 static void
1289 x11_image_finish(struct x11_swapchain *chain,
1290 const VkAllocationCallbacks* pAllocator,
1291 struct x11_image *image)
1292 {
1293 xcb_void_cookie_t cookie;
1294
1295 cookie = xcb_sync_destroy_fence(chain->conn, image->sync_fence);
1296 xcb_discard_reply(chain->conn, cookie.sequence);
1297 xshmfence_unmap_shm(image->shm_fence);
1298
1299 cookie = xcb_free_pixmap(chain->conn, image->pixmap);
1300 xcb_discard_reply(chain->conn, cookie.sequence);
1301
1302 wsi_destroy_image(&chain->base, &image->base);
1303 }
1304
1305 static void
1306 wsi_x11_get_dri3_modifiers(struct wsi_x11_connection *wsi_conn,
1307 xcb_connection_t *conn, xcb_window_t window,
1308 uint8_t depth, uint8_t bpp,
1309 VkCompositeAlphaFlagsKHR vk_alpha,
1310 uint64_t **modifiers_in, uint32_t *num_modifiers_in,
1311 uint32_t *num_tranches_in,
1312 const VkAllocationCallbacks *pAllocator)
1313 {
1314 if (!wsi_conn->has_dri3_modifiers)
1315 goto out;
1316
1317 #ifdef HAVE_DRI3_MODIFIERS
1318 xcb_generic_error_t *error = NULL;
1319 xcb_dri3_get_supported_modifiers_cookie_t mod_cookie =
1320 xcb_dri3_get_supported_modifiers(conn, window, depth, bpp);
1321 xcb_dri3_get_supported_modifiers_reply_t *mod_reply =
1322 xcb_dri3_get_supported_modifiers_reply(conn, mod_cookie, &error);
1323 free(error);
1324
1325 if (!mod_reply || (mod_reply->num_window_modifiers == 0 &&
1326 mod_reply->num_screen_modifiers == 0)) {
1327 free(mod_reply);
1328 goto out;
1329 }
1330
1331 uint32_t n = 0;
1332 uint32_t counts[2];
1333 uint64_t *modifiers[2];
1334
1335 if (mod_reply->num_window_modifiers) {
1336 counts[n] = mod_reply->num_window_modifiers;
1337 modifiers[n] = vk_alloc(pAllocator,
1338 counts[n] * sizeof(uint64_t),
1339 8, VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
1340 if (!modifiers[n]) {
1341 free(mod_reply);
1342 goto out;
1343 }
1344
1345 memcpy(modifiers[n],
1346 xcb_dri3_get_supported_modifiers_window_modifiers(mod_reply),
1347 counts[n] * sizeof(uint64_t));
1348 n++;
1349 }
1350
1351 if (mod_reply->num_screen_modifiers) {
1352 counts[n] = mod_reply->num_screen_modifiers;
1353 modifiers[n] = vk_alloc(pAllocator,
1354 counts[n] * sizeof(uint64_t),
1355 8, VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
1356 if (!modifiers[n]) {
1357 if (n > 0)
1358 vk_free(pAllocator, modifiers[0]);
1359 free(mod_reply);
1360 goto out;
1361 }
1362
1363 memcpy(modifiers[n],
1364 xcb_dri3_get_supported_modifiers_screen_modifiers(mod_reply),
1365 counts[n] * sizeof(uint64_t));
1366 n++;
1367 }
1368
1369 for (int i = 0; i < n; i++) {
1370 modifiers_in[i] = modifiers[i];
1371 num_modifiers_in[i] = counts[i];
1372 }
1373 *num_tranches_in = n;
1374
1375 free(mod_reply);
1376 return;
1377 #endif
1378 out:
1379 *num_tranches_in = 0;
1380 }
1381
1382 static VkResult
1383 x11_swapchain_destroy(struct wsi_swapchain *anv_chain,
1384 const VkAllocationCallbacks *pAllocator)
1385 {
1386 struct x11_swapchain *chain = (struct x11_swapchain *)anv_chain;
1387 xcb_void_cookie_t cookie;
1388
1389 if (chain->has_present_queue) {
1390 chain->status = VK_ERROR_OUT_OF_DATE_KHR;
1391 /* Push a UINT32_MAX to wake up the manager */
1392 wsi_queue_push(&chain->present_queue, UINT32_MAX);
1393 pthread_join(chain->queue_manager, NULL);
1394
1395 if (chain->has_acquire_queue)
1396 wsi_queue_destroy(&chain->acquire_queue);
1397 wsi_queue_destroy(&chain->present_queue);
1398 }
1399
1400 for (uint32_t i = 0; i < chain->base.image_count; i++)
1401 x11_image_finish(chain, pAllocator, &chain->images[i]);
1402
1403 xcb_unregister_for_special_event(chain->conn, chain->special_event);
1404 cookie = xcb_present_select_input_checked(chain->conn, chain->event_id,
1405 chain->window,
1406 XCB_PRESENT_EVENT_MASK_NO_EVENT);
1407 xcb_discard_reply(chain->conn, cookie.sequence);
1408
1409 wsi_swapchain_finish(&chain->base);
1410
1411 vk_free(pAllocator, chain);
1412
1413 return VK_SUCCESS;
1414 }
1415
1416 static void
1417 wsi_x11_set_adaptive_sync_property(xcb_connection_t *conn,
1418 xcb_drawable_t drawable,
1419 uint32_t state)
1420 {
1421 static char const name[] = "_VARIABLE_REFRESH";
1422 xcb_intern_atom_cookie_t cookie;
1423 xcb_intern_atom_reply_t* reply;
1424 xcb_void_cookie_t check;
1425
1426 cookie = xcb_intern_atom(conn, 0, strlen(name), name);
1427 reply = xcb_intern_atom_reply(conn, cookie, NULL);
1428 if (reply == NULL)
1429 return;
1430
1431 if (state)
1432 check = xcb_change_property_checked(conn, XCB_PROP_MODE_REPLACE,
1433 drawable, reply->atom,
1434 XCB_ATOM_CARDINAL, 32, 1, &state);
1435 else
1436 check = xcb_delete_property_checked(conn, drawable, reply->atom);
1437
1438 xcb_discard_reply(conn, check.sequence);
1439 free(reply);
1440 }
1441
1442
1443 static VkResult
1444 x11_surface_create_swapchain(VkIcdSurfaceBase *icd_surface,
1445 VkDevice device,
1446 struct wsi_device *wsi_device,
1447 const VkSwapchainCreateInfoKHR *pCreateInfo,
1448 const VkAllocationCallbacks* pAllocator,
1449 struct wsi_swapchain **swapchain_out)
1450 {
1451 struct x11_swapchain *chain;
1452 xcb_void_cookie_t cookie;
1453 VkResult result;
1454 VkPresentModeKHR present_mode = wsi_swapchain_get_present_mode(wsi_device, pCreateInfo);
1455
1456 assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR);
1457
1458 unsigned num_images = pCreateInfo->minImageCount;
1459 if (wsi_device->x11.strict_imageCount)
1460 num_images = pCreateInfo->minImageCount;
1461 else if (present_mode == VK_PRESENT_MODE_MAILBOX_KHR)
1462 num_images = MAX2(num_images, 5);
1463 else if (wsi_device->x11.ensure_minImageCount)
1464 num_images = MAX2(num_images, x11_get_min_image_count(wsi_device));
1465
1466 xcb_connection_t *conn = x11_surface_get_connection(icd_surface);
1467 struct wsi_x11_connection *wsi_conn =
1468 wsi_x11_get_connection(wsi_device, conn);
1469 if (!wsi_conn)
1470 return VK_ERROR_OUT_OF_HOST_MEMORY;
1471
1472 /* Check for whether or not we have a window up-front */
1473 xcb_window_t window = x11_surface_get_window(icd_surface);
1474 xcb_get_geometry_reply_t *geometry =
1475 xcb_get_geometry_reply(conn, xcb_get_geometry(conn, window), NULL);
1476 if (geometry == NULL)
1477 return VK_ERROR_SURFACE_LOST_KHR;
1478 const uint32_t bit_depth = geometry->depth;
1479 free(geometry);
1480
1481 size_t size = sizeof(*chain) + num_images * sizeof(chain->images[0]);
1482 chain = vk_alloc(pAllocator, size, 8,
1483 VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
1484 if (chain == NULL)
1485 return VK_ERROR_OUT_OF_HOST_MEMORY;
1486
1487 result = wsi_swapchain_init(wsi_device, &chain->base, device,
1488 pCreateInfo, pAllocator);
1489 if (result != VK_SUCCESS)
1490 goto fail_alloc;
1491
1492 chain->base.destroy = x11_swapchain_destroy;
1493 chain->base.get_wsi_image = x11_get_wsi_image;
1494 chain->base.acquire_next_image = x11_acquire_next_image;
1495 chain->base.queue_present = x11_queue_present;
1496 chain->base.present_mode = present_mode;
1497 chain->base.image_count = num_images;
1498 chain->conn = conn;
1499 chain->window = window;
1500 chain->depth = bit_depth;
1501 chain->extent = pCreateInfo->imageExtent;
1502 chain->send_sbc = 0;
1503 chain->last_present_msc = 0;
1504 chain->has_acquire_queue = false;
1505 chain->has_present_queue = false;
1506 chain->status = VK_SUCCESS;
1507 chain->has_dri3_modifiers = wsi_conn->has_dri3_modifiers;
1508
1509 /* If we are reallocating from an old swapchain, then we inherit its
1510 * last completion mode, to ensure we don't get into reallocation
1511 * cycles. If we are starting anew, we set 'COPY', as that is the only
1512 * mode which provokes reallocation when anything changes, to make
1513 * sure we have the most optimal allocation.
1514 */
1515 VK_FROM_HANDLE(x11_swapchain, old_chain, pCreateInfo->oldSwapchain);
1516 if (old_chain)
1517 chain->last_present_mode = old_chain->last_present_mode;
1518 else
1519 chain->last_present_mode = XCB_PRESENT_COMPLETE_MODE_COPY;
1520
1521 if (!wsi_x11_check_dri3_compatible(wsi_device, conn))
1522 chain->base.use_prime_blit = true;
1523
1524 chain->event_id = xcb_generate_id(chain->conn);
1525 xcb_present_select_input(chain->conn, chain->event_id, chain->window,
1526 XCB_PRESENT_EVENT_MASK_CONFIGURE_NOTIFY |
1527 XCB_PRESENT_EVENT_MASK_COMPLETE_NOTIFY |
1528 XCB_PRESENT_EVENT_MASK_IDLE_NOTIFY);
1529
1530 /* Create an XCB event queue to hold present events outside of the usual
1531 * application event queue
1532 */
1533 chain->special_event =
1534 xcb_register_for_special_xge(chain->conn, &xcb_present_id,
1535 chain->event_id, NULL);
1536
1537 chain->gc = xcb_generate_id(chain->conn);
1538 if (!chain->gc) {
1539 /* FINISHME: Choose a better error. */
1540 result = VK_ERROR_OUT_OF_HOST_MEMORY;
1541 goto fail_register;
1542 }
1543
1544 cookie = xcb_create_gc(chain->conn,
1545 chain->gc,
1546 chain->window,
1547 XCB_GC_GRAPHICS_EXPOSURES,
1548 (uint32_t []) { 0 });
1549 xcb_discard_reply(chain->conn, cookie.sequence);
1550
1551 uint64_t *modifiers[2] = {NULL, NULL};
1552 uint32_t num_modifiers[2] = {0, 0};
1553 uint32_t num_tranches = 0;
1554 if (wsi_device->supports_modifiers)
1555 wsi_x11_get_dri3_modifiers(wsi_conn, conn, window, chain->depth, 32,
1556 pCreateInfo->compositeAlpha,
1557 modifiers, num_modifiers, &num_tranches,
1558 pAllocator);
1559
1560 uint32_t image = 0;
1561 for (; image < chain->base.image_count; image++) {
1562 result = x11_image_init(device, chain, pCreateInfo, pAllocator,
1563 (const uint64_t *const *)modifiers,
1564 num_modifiers, num_tranches,
1565 &chain->images[image]);
1566 if (result != VK_SUCCESS)
1567 goto fail_init_images;
1568 }
1569
1570 if (chain->base.present_mode == VK_PRESENT_MODE_FIFO_KHR ||
1571 chain->base.present_mode == VK_PRESENT_MODE_MAILBOX_KHR) {
1572 chain->has_present_queue = true;
1573
1574 /* Initialize our queues. We make them base.image_count + 1 because we will
1575 * occasionally use UINT32_MAX to signal the other thread that an error
1576 * has occurred and we don't want an overflow.
1577 */
1578 int ret;
1579 ret = wsi_queue_init(&chain->present_queue, chain->base.image_count + 1);
1580 if (ret) {
1581 goto fail_init_images;
1582 }
1583
1584 if (chain->base.present_mode == VK_PRESENT_MODE_FIFO_KHR) {
1585 chain->has_acquire_queue = true;
1586
1587 ret = wsi_queue_init(&chain->acquire_queue, chain->base.image_count + 1);
1588 if (ret) {
1589 wsi_queue_destroy(&chain->present_queue);
1590 goto fail_init_images;
1591 }
1592
1593 for (unsigned i = 0; i < chain->base.image_count; i++)
1594 wsi_queue_push(&chain->acquire_queue, i);
1595 }
1596
1597 ret = pthread_create(&chain->queue_manager, NULL,
1598 x11_manage_fifo_queues, chain);
1599 if (ret) {
1600 wsi_queue_destroy(&chain->present_queue);
1601 if (chain->has_acquire_queue)
1602 wsi_queue_destroy(&chain->acquire_queue);
1603
1604 goto fail_init_images;
1605 }
1606 }
1607
1608 assert(chain->has_present_queue || !chain->has_acquire_queue);
1609
1610 for (int i = 0; i < ARRAY_SIZE(modifiers); i++)
1611 vk_free(pAllocator, modifiers[i]);
1612
1613 /* It is safe to set it here as only one swapchain can be associated with
1614 * the window, and swapchain creation does the association. At this point
1615 * we know the creation is going to succeed. */
1616 wsi_x11_set_adaptive_sync_property(conn, window,
1617 wsi_device->enable_adaptive_sync);
1618
1619 *swapchain_out = &chain->base;
1620
1621 return VK_SUCCESS;
1622
1623 fail_init_images:
1624 for (uint32_t j = 0; j < image; j++)
1625 x11_image_finish(chain, pAllocator, &chain->images[j]);
1626
1627 for (int i = 0; i < ARRAY_SIZE(modifiers); i++)
1628 vk_free(pAllocator, modifiers[i]);
1629
1630 fail_register:
1631 xcb_unregister_for_special_event(chain->conn, chain->special_event);
1632
1633 wsi_swapchain_finish(&chain->base);
1634
1635 fail_alloc:
1636 vk_free(pAllocator, chain);
1637
1638 return result;
1639 }
1640
1641 VkResult
1642 wsi_x11_init_wsi(struct wsi_device *wsi_device,
1643 const VkAllocationCallbacks *alloc,
1644 const struct driOptionCache *dri_options)
1645 {
1646 struct wsi_x11 *wsi;
1647 VkResult result;
1648
1649 wsi = vk_alloc(alloc, sizeof(*wsi), 8,
1650 VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
1651 if (!wsi) {
1652 result = VK_ERROR_OUT_OF_HOST_MEMORY;
1653 goto fail;
1654 }
1655
1656 int ret = pthread_mutex_init(&wsi->mutex, NULL);
1657 if (ret != 0) {
1658 if (ret == ENOMEM) {
1659 result = VK_ERROR_OUT_OF_HOST_MEMORY;
1660 } else {
1661 /* FINISHME: Choose a better error. */
1662 result = VK_ERROR_OUT_OF_HOST_MEMORY;
1663 }
1664
1665 goto fail_alloc;
1666 }
1667
1668 wsi->connections = _mesa_hash_table_create(NULL, _mesa_hash_pointer,
1669 _mesa_key_pointer_equal);
1670 if (!wsi->connections) {
1671 result = VK_ERROR_OUT_OF_HOST_MEMORY;
1672 goto fail_mutex;
1673 }
1674
1675 if (dri_options) {
1676 if (driCheckOption(dri_options, "vk_x11_override_min_image_count", DRI_INT)) {
1677 wsi_device->x11.override_minImageCount =
1678 driQueryOptioni(dri_options, "vk_x11_override_min_image_count");
1679 }
1680 if (driCheckOption(dri_options, "vk_x11_strict_image_count", DRI_BOOL)) {
1681 wsi_device->x11.strict_imageCount =
1682 driQueryOptionb(dri_options, "vk_x11_strict_image_count");
1683 }
1684 if (driCheckOption(dri_options, "vk_x11_ensure_min_image_count", DRI_BOOL)) {
1685 wsi_device->x11.ensure_minImageCount =
1686 driQueryOptionb(dri_options, "vk_x11_ensure_min_image_count");
1687 }
1688
1689 }
1690
1691 wsi->base.get_support = x11_surface_get_support;
1692 wsi->base.get_capabilities2 = x11_surface_get_capabilities2;
1693 wsi->base.get_formats = x11_surface_get_formats;
1694 wsi->base.get_formats2 = x11_surface_get_formats2;
1695 wsi->base.get_present_modes = x11_surface_get_present_modes;
1696 wsi->base.get_present_rectangles = x11_surface_get_present_rectangles;
1697 wsi->base.create_swapchain = x11_surface_create_swapchain;
1698
1699 wsi_device->wsi[VK_ICD_WSI_PLATFORM_XCB] = &wsi->base;
1700 wsi_device->wsi[VK_ICD_WSI_PLATFORM_XLIB] = &wsi->base;
1701
1702 return VK_SUCCESS;
1703
1704 fail_mutex:
1705 pthread_mutex_destroy(&wsi->mutex);
1706 fail_alloc:
1707 vk_free(alloc, wsi);
1708 fail:
1709 wsi_device->wsi[VK_ICD_WSI_PLATFORM_XCB] = NULL;
1710 wsi_device->wsi[VK_ICD_WSI_PLATFORM_XLIB] = NULL;
1711
1712 return result;
1713 }
1714
1715 void
1716 wsi_x11_finish_wsi(struct wsi_device *wsi_device,
1717 const VkAllocationCallbacks *alloc)
1718 {
1719 struct wsi_x11 *wsi =
1720 (struct wsi_x11 *)wsi_device->wsi[VK_ICD_WSI_PLATFORM_XCB];
1721
1722 if (wsi) {
1723 hash_table_foreach(wsi->connections, entry)
1724 wsi_x11_connection_destroy(wsi_device, entry->data);
1725
1726 _mesa_hash_table_destroy(wsi->connections, NULL);
1727
1728 pthread_mutex_destroy(&wsi->mutex);
1729
1730 vk_free(alloc, wsi);
1731 }
1732 }