egl: drop unused _EGLDriver from QuerySurface()
[mesa.git] / src / egl / drivers / dri2 / platform_x11_dri3.c
1 /*
2 * Copyright © 2015 Boyan Ding
3 *
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that copyright
7 * notice and this permission notice appear in supporting documentation, and
8 * that the name of the copyright holders not be used in advertising or
9 * publicity pertaining to distribution of the software without specific,
10 * written prior permission. The copyright holders make no representations
11 * about the suitability of this software for any purpose. It is provided "as
12 * is" without express or implied warranty.
13 *
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
20 * OF THIS SOFTWARE.
21 */
22
23 #include <stdbool.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <unistd.h>
27
28 #include <xcb/xcb.h>
29 #include <xcb/dri3.h>
30 #include <xcb/present.h>
31
32 #include <xf86drm.h>
33 #include "util/macros.h"
34
35 #include "egl_dri2.h"
36 #include "platform_x11_dri3.h"
37
38 #include "loader.h"
39 #include "loader_dri3_helper.h"
40
41 static struct dri3_egl_surface *
42 loader_drawable_to_egl_surface(struct loader_dri3_drawable *draw) {
43 size_t offset = offsetof(struct dri3_egl_surface, loader_drawable);
44 return (struct dri3_egl_surface *)(((void*) draw) - offset);
45 }
46
47 static void
48 egl_dri3_set_drawable_size(struct loader_dri3_drawable *draw,
49 int width, int height)
50 {
51 struct dri3_egl_surface *dri3_surf = loader_drawable_to_egl_surface(draw);
52
53 dri3_surf->surf.base.Width = width;
54 dri3_surf->surf.base.Height = height;
55 }
56
57 static bool
58 egl_dri3_in_current_context(struct loader_dri3_drawable *draw)
59 {
60 struct dri3_egl_surface *dri3_surf = loader_drawable_to_egl_surface(draw);
61 _EGLContext *ctx = _eglGetCurrentContext();
62
63 return ctx->Resource.Display == dri3_surf->surf.base.Resource.Display;
64 }
65
66 static __DRIcontext *
67 egl_dri3_get_dri_context(struct loader_dri3_drawable *draw)
68 {
69 _EGLContext *ctx = _eglGetCurrentContext();
70 struct dri2_egl_context *dri2_ctx;
71 if (!ctx)
72 return NULL;
73 dri2_ctx = dri2_egl_context(ctx);
74 return dri2_ctx->dri_context;
75 }
76
77 static __DRIscreen *
78 egl_dri3_get_dri_screen(void)
79 {
80 _EGLContext *ctx = _eglGetCurrentContext();
81 struct dri2_egl_context *dri2_ctx;
82 if (!ctx)
83 return NULL;
84 dri2_ctx = dri2_egl_context(ctx);
85 return dri2_egl_display(dri2_ctx->base.Resource.Display)->dri_screen;
86 }
87
88 static void
89 egl_dri3_flush_drawable(struct loader_dri3_drawable *draw, unsigned flags)
90 {
91 struct dri3_egl_surface *dri3_surf = loader_drawable_to_egl_surface(draw);
92 _EGLDisplay *disp = dri3_surf->surf.base.Resource.Display;
93
94 dri2_flush_drawable_for_swapbuffers(disp, &dri3_surf->surf.base);
95 }
96
97 static const struct loader_dri3_vtable egl_dri3_vtable = {
98 .set_drawable_size = egl_dri3_set_drawable_size,
99 .in_current_context = egl_dri3_in_current_context,
100 .get_dri_context = egl_dri3_get_dri_context,
101 .get_dri_screen = egl_dri3_get_dri_screen,
102 .flush_drawable = egl_dri3_flush_drawable,
103 .show_fps = NULL,
104 };
105
106 static EGLBoolean
107 dri3_destroy_surface(_EGLDisplay *disp, _EGLSurface *surf)
108 {
109 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
110 struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
111 xcb_drawable_t drawable = dri3_surf->loader_drawable.drawable;
112
113 loader_dri3_drawable_fini(&dri3_surf->loader_drawable);
114
115 if (surf->Type == EGL_PBUFFER_BIT)
116 xcb_free_pixmap (dri2_dpy->conn, drawable);
117
118 dri2_fini_surface(surf);
119 free(surf);
120
121 return EGL_TRUE;
122 }
123
124 static EGLBoolean
125 dri3_set_swap_interval(const _EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf,
126 EGLint interval)
127 {
128 struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
129
130 dri3_surf->surf.base.SwapInterval = interval;
131 loader_dri3_set_swap_interval(&dri3_surf->loader_drawable, interval);
132
133 return EGL_TRUE;
134 }
135
136 static _EGLSurface *
137 dri3_create_surface(_EGLDisplay *disp, EGLint type, _EGLConfig *conf,
138 void *native_surface, const EGLint *attrib_list)
139 {
140 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
141 struct dri2_egl_config *dri2_conf = dri2_egl_config(conf);
142 struct dri3_egl_surface *dri3_surf;
143 const __DRIconfig *dri_config;
144 xcb_drawable_t drawable;
145
146 dri3_surf = calloc(1, sizeof *dri3_surf);
147 if (!dri3_surf) {
148 _eglError(EGL_BAD_ALLOC, "dri3_create_surface");
149 return NULL;
150 }
151
152 if (!dri2_init_surface(&dri3_surf->surf.base, disp, type, conf,
153 attrib_list, false, native_surface))
154 goto cleanup_surf;
155
156 if (type == EGL_PBUFFER_BIT) {
157 drawable = xcb_generate_id(dri2_dpy->conn);
158 xcb_create_pixmap(dri2_dpy->conn, conf->BufferSize,
159 drawable, dri2_dpy->screen->root,
160 dri3_surf->surf.base.Width, dri3_surf->surf.base.Height);
161 } else {
162 STATIC_ASSERT(sizeof(uintptr_t) == sizeof(native_surface));
163 drawable = (uintptr_t) native_surface;
164 }
165
166 dri_config = dri2_get_dri_config(dri2_conf, type,
167 dri3_surf->surf.base.GLColorspace);
168
169 if (!dri_config) {
170 _eglError(EGL_BAD_MATCH, "Unsupported surfacetype/colorspace configuration");
171 goto cleanup_pixmap;
172 }
173
174 if (loader_dri3_drawable_init(dri2_dpy->conn, drawable,
175 dri2_dpy->dri_screen,
176 dri2_dpy->is_different_gpu,
177 dri2_dpy->multibuffers_available,
178 dri_config,
179 &dri2_dpy->loader_dri3_ext,
180 &egl_dri3_vtable,
181 &dri3_surf->loader_drawable)) {
182 _eglError(EGL_BAD_ALLOC, "dri3_surface_create");
183 goto cleanup_pixmap;
184 }
185
186 return &dri3_surf->surf.base;
187
188 cleanup_pixmap:
189 if (type == EGL_PBUFFER_BIT)
190 xcb_free_pixmap(dri2_dpy->conn, drawable);
191 cleanup_surf:
192 free(dri3_surf);
193
194 return NULL;
195 }
196
197 static int
198 dri3_authenticate(_EGLDisplay *disp, uint32_t id)
199 {
200 #ifdef HAVE_WAYLAND_PLATFORM
201 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
202
203 if (dri2_dpy->device_name) {
204 _eglLog(_EGL_WARNING,
205 "Wayland client render node authentication is unnecessary");
206 return 0;
207 }
208
209 _eglLog(_EGL_WARNING,
210 "Wayland client primary node authentication isn't supported");
211 #endif
212
213 return -1;
214 }
215
216 /**
217 * Called via eglCreateWindowSurface(), drv->CreateWindowSurface().
218 */
219 static _EGLSurface *
220 dri3_create_window_surface(_EGLDisplay *disp, _EGLConfig *conf,
221 void *native_window, const EGLint *attrib_list)
222 {
223 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
224 _EGLSurface *surf;
225
226 surf = dri3_create_surface(disp, EGL_WINDOW_BIT, conf,
227 native_window, attrib_list);
228 if (surf != NULL)
229 dri3_set_swap_interval(disp->Driver, disp, surf, dri2_dpy->default_swap_interval);
230
231 return surf;
232 }
233
234 static _EGLSurface *
235 dri3_create_pixmap_surface(_EGLDisplay *disp, _EGLConfig *conf,
236 void *native_pixmap, const EGLint *attrib_list)
237 {
238 return dri3_create_surface(disp, EGL_PIXMAP_BIT, conf,
239 native_pixmap, attrib_list);
240 }
241
242 static _EGLSurface *
243 dri3_create_pbuffer_surface(_EGLDisplay *disp, _EGLConfig *conf,
244 const EGLint *attrib_list)
245 {
246 return dri3_create_surface(disp, EGL_PBUFFER_BIT, conf,
247 NULL, attrib_list);
248 }
249
250 static EGLBoolean
251 dri3_get_sync_values(_EGLDisplay *display, _EGLSurface *surface,
252 EGLuint64KHR *ust, EGLuint64KHR *msc,
253 EGLuint64KHR *sbc)
254 {
255 struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surface);
256
257 return loader_dri3_wait_for_msc(&dri3_surf->loader_drawable, 0, 0, 0,
258 (int64_t *) ust, (int64_t *) msc,
259 (int64_t *) sbc) ? EGL_TRUE : EGL_FALSE;
260 }
261
262 static _EGLImage *
263 dri3_create_image_khr_pixmap(_EGLDisplay *disp, _EGLContext *ctx,
264 EGLClientBuffer buffer, const EGLint *attr_list)
265 {
266 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
267 struct dri2_egl_image *dri2_img;
268 xcb_drawable_t drawable;
269 xcb_dri3_buffer_from_pixmap_cookie_t bp_cookie;
270 xcb_dri3_buffer_from_pixmap_reply_t *bp_reply;
271 unsigned int format;
272
273 drawable = (xcb_drawable_t) (uintptr_t) buffer;
274 bp_cookie = xcb_dri3_buffer_from_pixmap(dri2_dpy->conn, drawable);
275 bp_reply = xcb_dri3_buffer_from_pixmap_reply(dri2_dpy->conn,
276 bp_cookie, NULL);
277 if (!bp_reply) {
278 _eglError(EGL_BAD_ALLOC, "xcb_dri3_buffer_from_pixmap");
279 return NULL;
280 }
281
282 format = dri2_format_for_depth(dri2_dpy, bp_reply->depth);
283 if (format == __DRI_IMAGE_FORMAT_NONE) {
284 _eglError(EGL_BAD_PARAMETER,
285 "dri3_create_image_khr: unsupported pixmap depth");
286 free(bp_reply);
287 return EGL_NO_IMAGE_KHR;
288 }
289
290 dri2_img = malloc(sizeof *dri2_img);
291 if (!dri2_img) {
292 _eglError(EGL_BAD_ALLOC, "dri3_create_image_khr");
293 free(bp_reply);
294 return EGL_NO_IMAGE_KHR;
295 }
296
297 _eglInitImage(&dri2_img->base, disp);
298
299 dri2_img->dri_image = loader_dri3_create_image(dri2_dpy->conn,
300 bp_reply,
301 format,
302 dri2_dpy->dri_screen,
303 dri2_dpy->image,
304 dri2_img);
305
306 free(bp_reply);
307
308 return &dri2_img->base;
309 }
310
311 #ifdef HAVE_DRI3_MODIFIERS
312 static _EGLImage *
313 dri3_create_image_khr_pixmap_from_buffers(_EGLDisplay *disp, _EGLContext *ctx,
314 EGLClientBuffer buffer,
315 const EGLint *attr_list)
316 {
317 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
318 struct dri2_egl_image *dri2_img;
319 xcb_dri3_buffers_from_pixmap_cookie_t bp_cookie;
320 xcb_dri3_buffers_from_pixmap_reply_t *bp_reply;
321 xcb_drawable_t drawable;
322 unsigned int format;
323
324 drawable = (xcb_drawable_t) (uintptr_t) buffer;
325 bp_cookie = xcb_dri3_buffers_from_pixmap(dri2_dpy->conn, drawable);
326 bp_reply = xcb_dri3_buffers_from_pixmap_reply(dri2_dpy->conn,
327 bp_cookie, NULL);
328
329 if (!bp_reply) {
330 _eglError(EGL_BAD_ATTRIBUTE, "dri3_create_image_khr");
331 return EGL_NO_IMAGE_KHR;
332 }
333
334 format = dri2_format_for_depth(dri2_dpy, bp_reply->depth);
335 if (format == __DRI_IMAGE_FORMAT_NONE) {
336 _eglError(EGL_BAD_PARAMETER,
337 "dri3_create_image_khr: unsupported pixmap depth");
338 free(bp_reply);
339 return EGL_NO_IMAGE_KHR;
340 }
341
342 dri2_img = malloc(sizeof *dri2_img);
343 if (!dri2_img) {
344 _eglError(EGL_BAD_ALLOC, "dri3_create_image_khr");
345 free(bp_reply);
346 return EGL_NO_IMAGE_KHR;
347 }
348
349 _eglInitImage(&dri2_img->base, disp);
350
351 dri2_img->dri_image = loader_dri3_create_image_from_buffers(dri2_dpy->conn,
352 bp_reply,
353 format,
354 dri2_dpy->dri_screen,
355 dri2_dpy->image,
356 dri2_img);
357 free(bp_reply);
358
359 if (!dri2_img->dri_image) {
360 _eglError(EGL_BAD_ATTRIBUTE, "dri3_create_image_khr");
361 free(dri2_img);
362 return EGL_NO_IMAGE_KHR;
363 }
364
365 return &dri2_img->base;
366 }
367 #endif
368
369 static _EGLImage *
370 dri3_create_image_khr(const _EGLDriver *drv, _EGLDisplay *disp,
371 _EGLContext *ctx, EGLenum target,
372 EGLClientBuffer buffer, const EGLint *attr_list)
373 {
374 #ifdef HAVE_DRI3_MODIFIERS
375 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
376 #endif
377
378 switch (target) {
379 case EGL_NATIVE_PIXMAP_KHR:
380 #ifdef HAVE_DRI3_MODIFIERS
381 if (dri2_dpy->multibuffers_available)
382 return dri3_create_image_khr_pixmap_from_buffers(disp, ctx, buffer,
383 attr_list);
384 #endif
385 return dri3_create_image_khr_pixmap(disp, ctx, buffer, attr_list);
386 default:
387 return dri2_create_image_khr(drv, disp, ctx, target, buffer, attr_list);
388 }
389 }
390
391 /**
392 * Called by the driver when it needs to update the real front buffer with the
393 * contents of its fake front buffer.
394 */
395 static void
396 dri3_flush_front_buffer(__DRIdrawable *driDrawable, void *loaderPrivate)
397 {
398 struct loader_dri3_drawable *draw = loaderPrivate;
399 (void) driDrawable;
400
401 /* There does not seem to be any kind of consensus on whether we should
402 * support front-buffer rendering or not:
403 * http://lists.freedesktop.org/archives/mesa-dev/2013-June/040129.html
404 */
405 if (!draw->is_pixmap)
406 _eglLog(_EGL_WARNING, "FIXME: egl/x11 doesn't support front buffer rendering.");
407 }
408
409 const __DRIimageLoaderExtension dri3_image_loader_extension = {
410 .base = { __DRI_IMAGE_LOADER, 1 },
411
412 .getBuffers = loader_dri3_get_buffers,
413 .flushFrontBuffer = dri3_flush_front_buffer,
414 };
415
416 static EGLBoolean
417 dri3_swap_buffers(const _EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *draw)
418 {
419 struct dri3_egl_surface *dri3_surf = dri3_egl_surface(draw);
420
421 return loader_dri3_swap_buffers_msc(&dri3_surf->loader_drawable,
422 0, 0, 0, 0,
423 draw->SwapBehavior == EGL_BUFFER_PRESERVED) != -1;
424 }
425
426 static EGLBoolean
427 dri3_copy_buffers(const _EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf,
428 void *native_pixmap_target)
429 {
430 struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
431 xcb_pixmap_t target;
432
433 STATIC_ASSERT(sizeof(uintptr_t) == sizeof(native_pixmap_target));
434 target = (uintptr_t) native_pixmap_target;
435
436 loader_dri3_copy_drawable(&dri3_surf->loader_drawable, target,
437 dri3_surf->loader_drawable.drawable);
438
439 return EGL_TRUE;
440 }
441
442 static int
443 dri3_query_buffer_age(const _EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf)
444 {
445 struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
446
447 return loader_dri3_query_buffer_age(&dri3_surf->loader_drawable);
448 }
449
450 static EGLBoolean
451 dri3_query_surface(_EGLDisplay *disp, _EGLSurface *surf,
452 EGLint attribute, EGLint *value)
453 {
454 struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
455
456 switch (attribute) {
457 case EGL_WIDTH:
458 case EGL_HEIGHT:
459 loader_dri3_update_drawable_geometry(&dri3_surf->loader_drawable);
460 break;
461 default:
462 break;
463 }
464
465 return _eglQuerySurface(disp, surf, attribute, value);
466 }
467
468 static __DRIdrawable *
469 dri3_get_dri_drawable(_EGLSurface *surf)
470 {
471 struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
472
473 return dri3_surf->loader_drawable.dri_drawable;
474 }
475
476 static void
477 dri3_close_screen_notify(_EGLDisplay *disp)
478 {
479 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
480
481 loader_dri3_close_screen(dri2_dpy->dri_screen);
482 }
483
484 struct dri2_egl_display_vtbl dri3_x11_display_vtbl = {
485 .authenticate = dri3_authenticate,
486 .create_window_surface = dri3_create_window_surface,
487 .create_pixmap_surface = dri3_create_pixmap_surface,
488 .create_pbuffer_surface = dri3_create_pbuffer_surface,
489 .destroy_surface = dri3_destroy_surface,
490 .create_image = dri3_create_image_khr,
491 .swap_interval = dri3_set_swap_interval,
492 .swap_buffers = dri3_swap_buffers,
493 .copy_buffers = dri3_copy_buffers,
494 .query_buffer_age = dri3_query_buffer_age,
495 .query_surface = dri3_query_surface,
496 .get_sync_values = dri3_get_sync_values,
497 .get_dri_drawable = dri3_get_dri_drawable,
498 .close_screen_notify = dri3_close_screen_notify,
499 };
500
501 /* Only request versions of these protocols which we actually support. */
502 #define DRI3_SUPPORTED_MAJOR 1
503 #define PRESENT_SUPPORTED_MAJOR 1
504
505 #ifdef HAVE_DRI3_MODIFIERS
506 #define DRI3_SUPPORTED_MINOR 2
507 #define PRESENT_SUPPORTED_MINOR 2
508 #else
509 #define PRESENT_SUPPORTED_MINOR 0
510 #define DRI3_SUPPORTED_MINOR 0
511 #endif
512
513 EGLBoolean
514 dri3_x11_connect(struct dri2_egl_display *dri2_dpy)
515 {
516 xcb_dri3_query_version_reply_t *dri3_query;
517 xcb_dri3_query_version_cookie_t dri3_query_cookie;
518 xcb_present_query_version_reply_t *present_query;
519 xcb_present_query_version_cookie_t present_query_cookie;
520 xcb_generic_error_t *error;
521 const xcb_query_extension_reply_t *extension;
522
523 xcb_prefetch_extension_data (dri2_dpy->conn, &xcb_dri3_id);
524 xcb_prefetch_extension_data (dri2_dpy->conn, &xcb_present_id);
525
526 extension = xcb_get_extension_data(dri2_dpy->conn, &xcb_dri3_id);
527 if (!(extension && extension->present))
528 return EGL_FALSE;
529
530 extension = xcb_get_extension_data(dri2_dpy->conn, &xcb_present_id);
531 if (!(extension && extension->present))
532 return EGL_FALSE;
533
534 dri3_query_cookie = xcb_dri3_query_version(dri2_dpy->conn,
535 DRI3_SUPPORTED_MAJOR,
536 DRI3_SUPPORTED_MINOR);
537
538 present_query_cookie = xcb_present_query_version(dri2_dpy->conn,
539 PRESENT_SUPPORTED_MAJOR,
540 PRESENT_SUPPORTED_MINOR);
541
542 dri3_query =
543 xcb_dri3_query_version_reply(dri2_dpy->conn, dri3_query_cookie, &error);
544 if (dri3_query == NULL || error != NULL) {
545 _eglLog(_EGL_WARNING, "DRI3: failed to query the version");
546 free(dri3_query);
547 free(error);
548 return EGL_FALSE;
549 }
550
551 dri2_dpy->dri3_major_version = dri3_query->major_version;
552 dri2_dpy->dri3_minor_version = dri3_query->minor_version;
553 free(dri3_query);
554
555 present_query =
556 xcb_present_query_version_reply(dri2_dpy->conn,
557 present_query_cookie, &error);
558 if (present_query == NULL || error != NULL) {
559 _eglLog(_EGL_WARNING, "DRI3: failed to query Present version");
560 free(present_query);
561 free(error);
562 return EGL_FALSE;
563 }
564
565 dri2_dpy->present_major_version = present_query->major_version;
566 dri2_dpy->present_minor_version = present_query->minor_version;
567 free(present_query);
568
569 dri2_dpy->fd = loader_dri3_open(dri2_dpy->conn, dri2_dpy->screen->root, 0);
570 if (dri2_dpy->fd < 0) {
571 int conn_error = xcb_connection_has_error(dri2_dpy->conn);
572 _eglLog(_EGL_WARNING, "DRI3: Screen seems not DRI3 capable");
573
574 if (conn_error)
575 _eglLog(_EGL_WARNING, "DRI3: Failed to initialize");
576
577 return EGL_FALSE;
578 }
579
580 dri2_dpy->fd = loader_get_user_preferred_fd(dri2_dpy->fd, &dri2_dpy->is_different_gpu);
581
582 dri2_dpy->driver_name = loader_get_driver_for_fd(dri2_dpy->fd);
583 if (!dri2_dpy->driver_name) {
584 _eglLog(_EGL_WARNING, "DRI3: No driver found");
585 close(dri2_dpy->fd);
586 return EGL_FALSE;
587 }
588
589 #ifdef HAVE_WAYLAND_PLATFORM
590 /* Only try to get a render device name since dri3 doesn't provide a
591 * mechanism for authenticating client opened device node fds. If this
592 * fails then don't advertise the extension. */
593 dri2_dpy->device_name = drmGetRenderDeviceNameFromFd(dri2_dpy->fd);
594 #endif
595
596 return EGL_TRUE;
597 }