fac343040442e8ce682e683b8f47a1d614ff3713
[mesa.git] / 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-uapi/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 VkResult ret = wsi_wl_display_init(wsi, &display, wl_display, false);
459 if (ret == VK_SUCCESS)
460 wsi_wl_display_finish(&display);
461
462 return ret == VK_SUCCESS;
463 }
464
465 static VkResult
466 wsi_wl_surface_get_support(VkIcdSurfaceBase *surface,
467 struct wsi_device *wsi_device,
468 uint32_t queueFamilyIndex,
469 VkBool32* pSupported)
470 {
471 *pSupported = true;
472
473 return VK_SUCCESS;
474 }
475
476 static const VkPresentModeKHR present_modes[] = {
477 VK_PRESENT_MODE_MAILBOX_KHR,
478 VK_PRESENT_MODE_FIFO_KHR,
479 };
480
481 static VkResult
482 wsi_wl_surface_get_capabilities(VkIcdSurfaceBase *surface,
483 struct wsi_device *wsi_device,
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 caps->maxImageExtent = (VkExtent2D) {
499 wsi_device->maxImageDimension2D,
500 wsi_device->maxImageDimension2D,
501 };
502
503 caps->supportedTransforms = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
504 caps->currentTransform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
505 caps->maxImageArrayLayers = 1;
506
507 caps->supportedCompositeAlpha =
508 VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR |
509 VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR;
510
511 caps->supportedUsageFlags =
512 VK_IMAGE_USAGE_TRANSFER_SRC_BIT |
513 VK_IMAGE_USAGE_SAMPLED_BIT |
514 VK_IMAGE_USAGE_TRANSFER_DST_BIT |
515 VK_IMAGE_USAGE_STORAGE_BIT |
516 VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
517
518 return VK_SUCCESS;
519 }
520
521 static VkResult
522 wsi_wl_surface_get_capabilities2(VkIcdSurfaceBase *surface,
523 struct wsi_device *wsi_device,
524 const void *info_next,
525 VkSurfaceCapabilities2KHR* caps)
526 {
527 assert(caps->sType == VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR);
528
529 return wsi_wl_surface_get_capabilities(surface, wsi_device,
530 &caps->surfaceCapabilities);
531 }
532
533 static VkResult
534 wsi_wl_surface_get_formats(VkIcdSurfaceBase *icd_surface,
535 struct wsi_device *wsi_device,
536 uint32_t* pSurfaceFormatCount,
537 VkSurfaceFormatKHR* pSurfaceFormats)
538 {
539 VkIcdSurfaceWayland *surface = (VkIcdSurfaceWayland *)icd_surface;
540 struct wsi_wayland *wsi =
541 (struct wsi_wayland *)wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND];
542
543 struct wsi_wl_display display;
544 if (wsi_wl_display_init(wsi, &display, surface->display, true))
545 return VK_ERROR_SURFACE_LOST_KHR;
546
547 VK_OUTARRAY_MAKE(out, pSurfaceFormats, pSurfaceFormatCount);
548
549 VkFormat *disp_fmt;
550 u_vector_foreach(disp_fmt, &display.formats) {
551 vk_outarray_append(&out, out_fmt) {
552 out_fmt->format = *disp_fmt;
553 out_fmt->colorSpace = VK_COLORSPACE_SRGB_NONLINEAR_KHR;
554 }
555 }
556
557 wsi_wl_display_finish(&display);
558
559 return vk_outarray_status(&out);
560 }
561
562 static VkResult
563 wsi_wl_surface_get_formats2(VkIcdSurfaceBase *icd_surface,
564 struct wsi_device *wsi_device,
565 const void *info_next,
566 uint32_t* pSurfaceFormatCount,
567 VkSurfaceFormat2KHR* pSurfaceFormats)
568 {
569 VkIcdSurfaceWayland *surface = (VkIcdSurfaceWayland *)icd_surface;
570 struct wsi_wayland *wsi =
571 (struct wsi_wayland *)wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND];
572
573 struct wsi_wl_display display;
574 if (wsi_wl_display_init(wsi, &display, surface->display, true))
575 return VK_ERROR_SURFACE_LOST_KHR;
576
577 VK_OUTARRAY_MAKE(out, pSurfaceFormats, pSurfaceFormatCount);
578
579 VkFormat *disp_fmt;
580 u_vector_foreach(disp_fmt, &display.formats) {
581 vk_outarray_append(&out, out_fmt) {
582 out_fmt->surfaceFormat.format = *disp_fmt;
583 out_fmt->surfaceFormat.colorSpace = VK_COLORSPACE_SRGB_NONLINEAR_KHR;
584 }
585 }
586
587 wsi_wl_display_finish(&display);
588
589 return vk_outarray_status(&out);
590 }
591
592 static VkResult
593 wsi_wl_surface_get_present_modes(VkIcdSurfaceBase *surface,
594 uint32_t* pPresentModeCount,
595 VkPresentModeKHR* pPresentModes)
596 {
597 if (pPresentModes == NULL) {
598 *pPresentModeCount = ARRAY_SIZE(present_modes);
599 return VK_SUCCESS;
600 }
601
602 *pPresentModeCount = MIN2(*pPresentModeCount, ARRAY_SIZE(present_modes));
603 typed_memcpy(pPresentModes, present_modes, *pPresentModeCount);
604
605 if (*pPresentModeCount < ARRAY_SIZE(present_modes))
606 return VK_INCOMPLETE;
607 else
608 return VK_SUCCESS;
609 }
610
611 static VkResult
612 wsi_wl_surface_get_present_rectangles(VkIcdSurfaceBase *surface,
613 struct wsi_device *wsi_device,
614 uint32_t* pRectCount,
615 VkRect2D* pRects)
616 {
617 VK_OUTARRAY_MAKE(out, pRects, pRectCount);
618
619 vk_outarray_append(&out, rect) {
620 /* We don't know a size so just return the usual "I don't know." */
621 *rect = (VkRect2D) {
622 .offset = { 0, 0 },
623 .extent = { -1, -1 },
624 };
625 }
626
627 return vk_outarray_status(&out);
628 }
629
630 VkResult wsi_create_wl_surface(const VkAllocationCallbacks *pAllocator,
631 const VkWaylandSurfaceCreateInfoKHR *pCreateInfo,
632 VkSurfaceKHR *pSurface)
633 {
634 VkIcdSurfaceWayland *surface;
635
636 surface = vk_alloc(pAllocator, sizeof *surface, 8,
637 VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
638 if (surface == NULL)
639 return VK_ERROR_OUT_OF_HOST_MEMORY;
640
641 surface->base.platform = VK_ICD_WSI_PLATFORM_WAYLAND;
642 surface->display = pCreateInfo->display;
643 surface->surface = pCreateInfo->surface;
644
645 *pSurface = VkIcdSurfaceBase_to_handle(&surface->base);
646
647 return VK_SUCCESS;
648 }
649
650 struct wsi_wl_image {
651 struct wsi_image base;
652 struct wl_buffer * buffer;
653 bool busy;
654 };
655
656 struct wsi_wl_swapchain {
657 struct wsi_swapchain base;
658
659 struct wsi_wl_display *display;
660
661 struct wl_surface * surface;
662 uint32_t surface_version;
663 struct wl_drm * drm_wrapper;
664 struct wl_callback * frame;
665
666 VkExtent2D extent;
667 VkFormat vk_format;
668 uint32_t drm_format;
669
670 VkPresentModeKHR present_mode;
671 bool fifo_ready;
672
673 struct wsi_wl_image images[0];
674 };
675
676 static struct wsi_image *
677 wsi_wl_swapchain_get_wsi_image(struct wsi_swapchain *wsi_chain,
678 uint32_t image_index)
679 {
680 struct wsi_wl_swapchain *chain = (struct wsi_wl_swapchain *)wsi_chain;
681 return &chain->images[image_index].base;
682 }
683
684 static VkResult
685 wsi_wl_swapchain_acquire_next_image(struct wsi_swapchain *wsi_chain,
686 const VkAcquireNextImageInfoKHR *info,
687 uint32_t *image_index)
688 {
689 struct wsi_wl_swapchain *chain = (struct wsi_wl_swapchain *)wsi_chain;
690
691 int ret = wl_display_dispatch_queue_pending(chain->display->wl_display,
692 chain->display->queue);
693 /* XXX: I'm not sure if out-of-date is the right error here. If
694 * wl_display_dispatch_queue_pending fails it most likely means we got
695 * kicked by the server so this seems more-or-less correct.
696 */
697 if (ret < 0)
698 return VK_ERROR_OUT_OF_DATE_KHR;
699
700 while (1) {
701 for (uint32_t i = 0; i < chain->base.image_count; i++) {
702 if (!chain->images[i].busy) {
703 /* We found a non-busy image */
704 *image_index = i;
705 chain->images[i].busy = true;
706 return VK_SUCCESS;
707 }
708 }
709
710 /* This time we do a blocking dispatch because we can't go
711 * anywhere until we get an event.
712 */
713 int ret = wl_display_roundtrip_queue(chain->display->wl_display,
714 chain->display->queue);
715 if (ret < 0)
716 return VK_ERROR_OUT_OF_DATE_KHR;
717 }
718 }
719
720 static void
721 frame_handle_done(void *data, struct wl_callback *callback, uint32_t serial)
722 {
723 struct wsi_wl_swapchain *chain = data;
724
725 chain->frame = NULL;
726 chain->fifo_ready = true;
727
728 wl_callback_destroy(callback);
729 }
730
731 static const struct wl_callback_listener frame_listener = {
732 frame_handle_done,
733 };
734
735 static VkResult
736 wsi_wl_swapchain_queue_present(struct wsi_swapchain *wsi_chain,
737 uint32_t image_index,
738 const VkPresentRegionKHR *damage)
739 {
740 struct wsi_wl_swapchain *chain = (struct wsi_wl_swapchain *)wsi_chain;
741
742 if (chain->base.present_mode == VK_PRESENT_MODE_FIFO_KHR) {
743 while (!chain->fifo_ready) {
744 int ret = wl_display_dispatch_queue(chain->display->wl_display,
745 chain->display->queue);
746 if (ret < 0)
747 return VK_ERROR_OUT_OF_DATE_KHR;
748 }
749 }
750
751 assert(image_index < chain->base.image_count);
752 wl_surface_attach(chain->surface, chain->images[image_index].buffer, 0, 0);
753
754 if (chain->surface_version >= 4 && damage &&
755 damage->pRectangles && damage->rectangleCount > 0) {
756 for (unsigned i = 0; i < damage->rectangleCount; i++) {
757 const VkRectLayerKHR *rect = &damage->pRectangles[i];
758 assert(rect->layer == 0);
759 wl_surface_damage_buffer(chain->surface,
760 rect->offset.x, rect->offset.y,
761 rect->extent.width, rect->extent.height);
762 }
763 } else {
764 wl_surface_damage(chain->surface, 0, 0, INT32_MAX, INT32_MAX);
765 }
766
767 if (chain->base.present_mode == VK_PRESENT_MODE_FIFO_KHR) {
768 chain->frame = wl_surface_frame(chain->surface);
769 wl_callback_add_listener(chain->frame, &frame_listener, chain);
770 chain->fifo_ready = false;
771 }
772
773 chain->images[image_index].busy = true;
774 wl_surface_commit(chain->surface);
775 wl_display_flush(chain->display->wl_display);
776
777 return VK_SUCCESS;
778 }
779
780 static void
781 buffer_handle_release(void *data, struct wl_buffer *buffer)
782 {
783 struct wsi_wl_image *image = data;
784
785 assert(image->buffer == buffer);
786
787 image->busy = false;
788 }
789
790 static const struct wl_buffer_listener buffer_listener = {
791 buffer_handle_release,
792 };
793
794 static VkResult
795 wsi_wl_image_init(struct wsi_wl_swapchain *chain,
796 struct wsi_wl_image *image,
797 const VkSwapchainCreateInfoKHR *pCreateInfo,
798 const VkAllocationCallbacks* pAllocator)
799 {
800 struct wsi_wl_display *display = chain->display;
801 const uint64_t *modifiers = NULL;
802 uint32_t num_modifiers = 0;
803 VkResult result;
804
805 if (display->dmabuf && chain->base.wsi->supports_modifiers) {
806 switch (chain->drm_format) {
807 case WL_DRM_FORMAT_ARGB8888:
808 modifiers = u_vector_tail(&display->modifiers.argb8888);
809 num_modifiers = u_vector_length(&display->modifiers.argb8888);
810 break;
811 case WL_DRM_FORMAT_XRGB8888:
812 modifiers = u_vector_tail(&display->modifiers.xrgb8888);
813 num_modifiers = u_vector_length(&display->modifiers.xrgb8888);
814 break;
815 default:
816 break;
817 }
818 }
819
820 result = wsi_create_native_image(&chain->base, pCreateInfo,
821 num_modifiers > 0 ? 1 : 0,
822 &num_modifiers, &modifiers,
823 &image->base);
824
825 if (result != VK_SUCCESS)
826 return result;
827
828 if (image->base.drm_modifier != DRM_FORMAT_MOD_INVALID) {
829 /* Only request modifiers if we have dmabuf, else it must be implicit. */
830 assert(display->dmabuf);
831
832 struct zwp_linux_buffer_params_v1 *params =
833 zwp_linux_dmabuf_v1_create_params(display->dmabuf);
834 wl_proxy_set_queue((struct wl_proxy *) params, chain->display->queue);
835
836 for (int i = 0; i < image->base.num_planes; i++) {
837 zwp_linux_buffer_params_v1_add(params,
838 image->base.fds[i],
839 i,
840 image->base.offsets[i],
841 image->base.row_pitches[i],
842 image->base.drm_modifier >> 32,
843 image->base.drm_modifier & 0xffffffff);
844 close(image->base.fds[i]);
845 }
846
847 image->buffer =
848 zwp_linux_buffer_params_v1_create_immed(params,
849 chain->extent.width,
850 chain->extent.height,
851 chain->drm_format,
852 0);
853 zwp_linux_buffer_params_v1_destroy(params);
854 } else {
855 /* Without passing modifiers, we can't have multi-plane RGB images. */
856 assert(image->base.num_planes == 1);
857
858 image->buffer =
859 wl_drm_create_prime_buffer(chain->drm_wrapper,
860 image->base.fds[0], /* name */
861 chain->extent.width,
862 chain->extent.height,
863 chain->drm_format,
864 image->base.offsets[0],
865 image->base.row_pitches[0],
866 0, 0, 0, 0 /* unused */);
867 close(image->base.fds[0]);
868 }
869
870 if (!image->buffer)
871 goto fail_image;
872
873 wl_buffer_add_listener(image->buffer, &buffer_listener, image);
874
875 return VK_SUCCESS;
876
877 fail_image:
878 wsi_destroy_image(&chain->base, &image->base);
879
880 return result;
881 }
882
883 static VkResult
884 wsi_wl_swapchain_destroy(struct wsi_swapchain *wsi_chain,
885 const VkAllocationCallbacks *pAllocator)
886 {
887 struct wsi_wl_swapchain *chain = (struct wsi_wl_swapchain *)wsi_chain;
888
889 for (uint32_t i = 0; i < chain->base.image_count; i++) {
890 if (chain->images[i].buffer) {
891 wl_buffer_destroy(chain->images[i].buffer);
892 wsi_destroy_image(&chain->base, &chain->images[i].base);
893 }
894 }
895
896 if (chain->frame)
897 wl_callback_destroy(chain->frame);
898 if (chain->surface)
899 wl_proxy_wrapper_destroy(chain->surface);
900 if (chain->drm_wrapper)
901 wl_proxy_wrapper_destroy(chain->drm_wrapper);
902
903 if (chain->display)
904 wsi_wl_display_unref(chain->display);
905
906 wsi_swapchain_finish(&chain->base);
907
908 vk_free(pAllocator, chain);
909
910 return VK_SUCCESS;
911 }
912
913 static VkResult
914 wsi_wl_surface_create_swapchain(VkIcdSurfaceBase *icd_surface,
915 VkDevice device,
916 struct wsi_device *wsi_device,
917 const VkSwapchainCreateInfoKHR* pCreateInfo,
918 const VkAllocationCallbacks* pAllocator,
919 struct wsi_swapchain **swapchain_out)
920 {
921 VkIcdSurfaceWayland *surface = (VkIcdSurfaceWayland *)icd_surface;
922 struct wsi_wayland *wsi =
923 (struct wsi_wayland *)wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND];
924 struct wsi_wl_swapchain *chain;
925 VkResult result;
926
927 assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR);
928
929 int num_images = pCreateInfo->minImageCount;
930
931 size_t size = sizeof(*chain) + num_images * sizeof(chain->images[0]);
932 chain = vk_alloc(pAllocator, size, 8,
933 VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
934 if (chain == NULL)
935 return VK_ERROR_OUT_OF_HOST_MEMORY;
936
937 result = wsi_swapchain_init(wsi_device, &chain->base, device,
938 pCreateInfo, pAllocator);
939 if (result != VK_SUCCESS) {
940 vk_free(pAllocator, chain);
941 return result;
942 }
943
944 /* Mark a bunch of stuff as NULL. This way we can just call
945 * destroy_swapchain for cleanup.
946 */
947 for (uint32_t i = 0; i < num_images; i++)
948 chain->images[i].buffer = NULL;
949 chain->surface = NULL;
950 chain->drm_wrapper = NULL;
951 chain->frame = NULL;
952
953 bool alpha = pCreateInfo->compositeAlpha ==
954 VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR;
955
956 chain->base.destroy = wsi_wl_swapchain_destroy;
957 chain->base.get_wsi_image = wsi_wl_swapchain_get_wsi_image;
958 chain->base.acquire_next_image = wsi_wl_swapchain_acquire_next_image;
959 chain->base.queue_present = wsi_wl_swapchain_queue_present;
960 chain->base.present_mode = pCreateInfo->presentMode;
961 chain->base.image_count = num_images;
962 chain->extent = pCreateInfo->imageExtent;
963 chain->vk_format = pCreateInfo->imageFormat;
964 chain->drm_format = wl_drm_format_for_vk_format(chain->vk_format, alpha);
965
966 if (pCreateInfo->oldSwapchain) {
967 /* If we have an oldSwapchain parameter, copy the display struct over
968 * from the old one so we don't have to fully re-initialize it.
969 */
970 struct wsi_wl_swapchain *old_chain = (void *)pCreateInfo->oldSwapchain;
971 chain->display = wsi_wl_display_ref(old_chain->display);
972 } else {
973 chain->display = NULL;
974 result = wsi_wl_display_create(wsi, surface->display, &chain->display);
975 if (result != VK_SUCCESS)
976 goto fail;
977 }
978
979 chain->surface = wl_proxy_create_wrapper(surface->surface);
980 if (!chain->surface) {
981 result = VK_ERROR_OUT_OF_HOST_MEMORY;
982 goto fail;
983 }
984 wl_proxy_set_queue((struct wl_proxy *) chain->surface,
985 chain->display->queue);
986 chain->surface_version = wl_proxy_get_version((void *)surface->surface);
987
988 chain->drm_wrapper = wl_proxy_create_wrapper(chain->display->drm);
989 if (!chain->drm_wrapper) {
990 result = VK_ERROR_OUT_OF_HOST_MEMORY;
991 goto fail;
992 }
993 wl_proxy_set_queue((struct wl_proxy *) chain->drm_wrapper,
994 chain->display->queue);
995
996 chain->fifo_ready = true;
997
998 for (uint32_t i = 0; i < chain->base.image_count; i++) {
999 result = wsi_wl_image_init(chain, &chain->images[i],
1000 pCreateInfo, pAllocator);
1001 if (result != VK_SUCCESS)
1002 goto fail;
1003 chain->images[i].busy = false;
1004 }
1005
1006 *swapchain_out = &chain->base;
1007
1008 return VK_SUCCESS;
1009
1010 fail:
1011 wsi_wl_swapchain_destroy(&chain->base, pAllocator);
1012
1013 return result;
1014 }
1015
1016 VkResult
1017 wsi_wl_init_wsi(struct wsi_device *wsi_device,
1018 const VkAllocationCallbacks *alloc,
1019 VkPhysicalDevice physical_device)
1020 {
1021 struct wsi_wayland *wsi;
1022 VkResult result;
1023
1024 wsi = vk_alloc(alloc, sizeof(*wsi), 8,
1025 VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE);
1026 if (!wsi) {
1027 result = VK_ERROR_OUT_OF_HOST_MEMORY;
1028 goto fail;
1029 }
1030
1031 wsi->physical_device = physical_device;
1032 wsi->alloc = alloc;
1033 wsi->wsi = wsi_device;
1034
1035 wsi->base.get_support = wsi_wl_surface_get_support;
1036 wsi->base.get_capabilities2 = wsi_wl_surface_get_capabilities2;
1037 wsi->base.get_formats = wsi_wl_surface_get_formats;
1038 wsi->base.get_formats2 = wsi_wl_surface_get_formats2;
1039 wsi->base.get_present_modes = wsi_wl_surface_get_present_modes;
1040 wsi->base.get_present_rectangles = wsi_wl_surface_get_present_rectangles;
1041 wsi->base.create_swapchain = wsi_wl_surface_create_swapchain;
1042
1043 wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND] = &wsi->base;
1044
1045 return VK_SUCCESS;
1046
1047 fail:
1048 wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND] = NULL;
1049
1050 return result;
1051 }
1052
1053 void
1054 wsi_wl_finish_wsi(struct wsi_device *wsi_device,
1055 const VkAllocationCallbacks *alloc)
1056 {
1057 struct wsi_wayland *wsi =
1058 (struct wsi_wayland *)wsi_device->wsi[VK_ICD_WSI_PLATFORM_WAYLAND];
1059 if (!wsi)
1060 return;
1061
1062 vk_free(alloc, wsi);
1063 }