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 "egl_dri2_fallbacks.h"
  37 #include "platform_x11_dri3.h"
  38
  39 #include "loader.h"
  40 #include "loader_dri3_helper.h"
  41
  42 static struct dri3_egl_surface *
  43 loader_drawable_to_egl_surface(struct loader_dri3_drawable *draw) {
  44    size_t offset = offsetof(struct dri3_egl_surface, loader_drawable);
  45    return (struct dri3_egl_surface *)(((void*) draw) - offset);
  46 }
  47
  48 static void
  49 egl_dri3_set_drawable_size(struct loader_dri3_drawable *draw,
  50                            int width, int height)
  51 {
  52    struct dri3_egl_surface *dri3_surf = loader_drawable_to_egl_surface(draw);
  53
  54    dri3_surf->surf.base.Width = width;
  55    dri3_surf->surf.base.Height = height;
  56 }
  57
  58 static bool
  59 egl_dri3_in_current_context(struct loader_dri3_drawable *draw)
  60 {
  61    struct dri3_egl_surface *dri3_surf = loader_drawable_to_egl_surface(draw);
  62    _EGLContext *ctx = _eglGetCurrentContext();
  63
  64    return ctx->Resource.Display == dri3_surf->surf.base.Resource.Display;
  65 }
  66
  67 static __DRIcontext *
  68 egl_dri3_get_dri_context(struct loader_dri3_drawable *draw)
  69 {
  70    _EGLContext *ctx = _eglGetCurrentContext();
  71    struct dri2_egl_context *dri2_ctx;
  72    if (!ctx)
  73       return NULL;
  74    dri2_ctx = dri2_egl_context(ctx);
  75    return dri2_ctx->dri_context;
  76 }
  77
  78 static __DRIscreen *
  79 egl_dri3_get_dri_screen(void)
  80 {
  81    _EGLContext *ctx = _eglGetCurrentContext();
  82    struct dri2_egl_context *dri2_ctx;
  83    if (!ctx)
  84       return NULL;
  85    dri2_ctx = dri2_egl_context(ctx);
  86    return dri2_egl_display(dri2_ctx->base.Resource.Display)->dri_screen;
  87 }
  88
  89 static void
  90 egl_dri3_flush_drawable(struct loader_dri3_drawable *draw, unsigned flags)
  91 {
  92    struct dri3_egl_surface *dri3_surf = loader_drawable_to_egl_surface(draw);
  93    _EGLDisplay *disp = dri3_surf->surf.base.Resource.Display;
  94
  95    dri2_flush_drawable_for_swapbuffers(disp, &dri3_surf->surf.base);
  96 }
  97
  98 static const struct loader_dri3_vtable egl_dri3_vtable = {
  99    .set_drawable_size = egl_dri3_set_drawable_size,
 100    .in_current_context = egl_dri3_in_current_context,
 101    .get_dri_context = egl_dri3_get_dri_context,
 102    .get_dri_screen = egl_dri3_get_dri_screen,
 103    .flush_drawable = egl_dri3_flush_drawable,
 104    .show_fps = NULL,
 105 };
 106
 107 static EGLBoolean
 108 dri3_destroy_surface(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf)
 109 {
 110    struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
 111
 112    (void) drv;
 113
 114    loader_dri3_drawable_fini(&dri3_surf->loader_drawable);
 115
 116    dri2_fini_surface(surf);
 117    free(surf);
 118
 119    return EGL_TRUE;
 120 }
 121
 122 static EGLBoolean
 123 dri3_set_swap_interval(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf,
 124                        EGLint interval)
 125 {
 126    struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
 127
 128    dri3_surf->surf.base.SwapInterval = interval;
 129    loader_dri3_set_swap_interval(&dri3_surf->loader_drawable, interval);
 130
 131    return EGL_TRUE;
 132 }
 133
 134 static _EGLSurface *
 135 dri3_create_surface(_EGLDriver *drv, _EGLDisplay *disp, EGLint type,
 136                     _EGLConfig *conf, void *native_surface,
 137                     const EGLint *attrib_list)
 138 {
 139    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 140    struct dri2_egl_config *dri2_conf = dri2_egl_config(conf);
 141    struct dri3_egl_surface *dri3_surf;
 142    const __DRIconfig *dri_config;
 143    xcb_drawable_t drawable;
 144
 145    (void) drv;
 146
 147    dri3_surf = calloc(1, sizeof *dri3_surf);
 148    if (!dri3_surf) {
 149       _eglError(EGL_BAD_ALLOC, "dri3_create_surface");
 150       return NULL;
 151    }
 152
 153    if (!dri2_init_surface(&dri3_surf->surf.base, disp, type, conf, attrib_list, false))
 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 (loader_dri3_drawable_init(dri2_dpy->conn, drawable,
 170                                  dri2_dpy->dri_screen,
 171                                  dri2_dpy->is_different_gpu, dri_config,
 172                                  &dri2_dpy->loader_dri3_ext,
 173                                  &egl_dri3_vtable,
 174                                  &dri3_surf->loader_drawable)) {
 175       _eglError(EGL_BAD_ALLOC, "dri3_surface_create");
 176       goto cleanup_pixmap;
 177    }
 178
 179    return &dri3_surf->surf.base;
 180
 181  cleanup_pixmap:
 182    if (type == EGL_PBUFFER_BIT)
 183       xcb_free_pixmap(dri2_dpy->conn, drawable);
 184  cleanup_surf:
 185    free(dri3_surf);
 186
 187    return NULL;
 188 }
 189
 190 static int
 191 dri3_authenticate(_EGLDisplay *disp, uint32_t id)
 192 {
 193 #ifdef HAVE_WAYLAND_PLATFORM
 194    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 195
 196    if (dri2_dpy->device_name) {
 197       _eglLog(_EGL_WARNING,
 198               "Wayland client render node authentication is unnecessary");
 199       return 0;
 200    }
 201
 202    _eglLog(_EGL_WARNING,
 203            "Wayland client primary node authentication isn't supported");
 204 #endif
 205
 206    return -1;
 207 }
 208
 209 /**
 210  * Called via eglCreateWindowSurface(), drv->API.CreateWindowSurface().
 211  */
 212 static _EGLSurface *
 213 dri3_create_window_surface(_EGLDriver *drv, _EGLDisplay *disp,
 214                            _EGLConfig *conf, void *native_window,
 215                            const EGLint *attrib_list)
 216 {
 217    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 218    _EGLSurface *surf;
 219
 220    surf = dri3_create_surface(drv, disp, EGL_WINDOW_BIT, conf,
 221                               native_window, attrib_list);
 222    if (surf != NULL)
 223       dri3_set_swap_interval(drv, disp, surf, dri2_dpy->default_swap_interval);
 224
 225    return surf;
 226 }
 227
 228 static _EGLSurface *
 229 dri3_create_pixmap_surface(_EGLDriver *drv, _EGLDisplay *disp,
 230                            _EGLConfig *conf, void *native_pixmap,
 231                            const EGLint *attrib_list)
 232 {
 233    return dri3_create_surface(drv, disp, EGL_PIXMAP_BIT, conf,
 234                               native_pixmap, attrib_list);
 235 }
 236
 237 static _EGLSurface *
 238 dri3_create_pbuffer_surface(_EGLDriver *drv, _EGLDisplay *disp,
 239                                 _EGLConfig *conf, const EGLint *attrib_list)
 240 {
 241    return dri3_create_surface(drv, disp, EGL_PBUFFER_BIT, conf,
 242                               NULL, attrib_list);
 243 }
 244
 245 static EGLBoolean
 246 dri3_get_sync_values(_EGLDisplay *display, _EGLSurface *surface,
 247                      EGLuint64KHR *ust, EGLuint64KHR *msc,
 248                      EGLuint64KHR *sbc)
 249 {
 250    struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surface);
 251
 252    return loader_dri3_wait_for_msc(&dri3_surf->loader_drawable, 0, 0, 0,
 253                                    (int64_t *) ust, (int64_t *) msc,
 254                                    (int64_t *) sbc) ? EGL_TRUE : EGL_FALSE;
 255 }
 256
 257 static _EGLImage *
 258 dri3_create_image_khr_pixmap(_EGLDisplay *disp, _EGLContext *ctx,
 259                              EGLClientBuffer buffer, const EGLint *attr_list)
 260 {
 261    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 262    struct dri2_egl_image *dri2_img;
 263    xcb_drawable_t drawable;
 264    xcb_dri3_buffer_from_pixmap_cookie_t bp_cookie;
 265    xcb_dri3_buffer_from_pixmap_reply_t  *bp_reply;
 266    unsigned int format;
 267
 268    drawable = (xcb_drawable_t) (uintptr_t) buffer;
 269    bp_cookie = xcb_dri3_buffer_from_pixmap(dri2_dpy->conn, drawable);
 270    bp_reply = xcb_dri3_buffer_from_pixmap_reply(dri2_dpy->conn,
 271                                                 bp_cookie, NULL);
 272    if (!bp_reply) {
 273       _eglError(EGL_BAD_ALLOC, "xcb_dri3_buffer_from_pixmap");
 274       return NULL;
 275    }
 276
 277    switch (bp_reply->depth) {
 278    case 16:
 279       format = __DRI_IMAGE_FORMAT_RGB565;
 280       break;
 281    case 24:
 282       format = __DRI_IMAGE_FORMAT_XRGB8888;
 283       break;
 284    case 30:
 285       format = __DRI_IMAGE_FORMAT_XRGB2101010;
 286       break;
 287    case 32:
 288       format = __DRI_IMAGE_FORMAT_ARGB8888;
 289       break;
 290    default:
 291       _eglError(EGL_BAD_PARAMETER,
 292                 "dri3_create_image_khr: unsupported pixmap depth");
 293       free(bp_reply);
 294       return EGL_NO_IMAGE_KHR;
 295    }
 296
 297    dri2_img = malloc(sizeof *dri2_img);
 298    if (!dri2_img) {
 299       _eglError(EGL_BAD_ALLOC, "dri3_create_image_khr");
 300       free(bp_reply);
 301       return EGL_NO_IMAGE_KHR;
 302    }
 303
 304    _eglInitImage(&dri2_img->base, disp);
 305
 306    dri2_img->dri_image = loader_dri3_create_image(dri2_dpy->conn,
 307                                                   bp_reply,
 308                                                   format,
 309                                                   dri2_dpy->dri_screen,
 310                                                   dri2_dpy->image,
 311                                                   dri2_img);
 312
 313    free(bp_reply);
 314
 315    return &dri2_img->base;
 316 }
 317
 318 static _EGLImage *
 319 dri3_create_image_khr(_EGLDriver *drv, _EGLDisplay *disp,
 320                       _EGLContext *ctx, EGLenum target,
 321                       EGLClientBuffer buffer, const EGLint *attr_list)
 322 {
 323    switch (target) {
 324    case EGL_NATIVE_PIXMAP_KHR:
 325       return dri3_create_image_khr_pixmap(disp, ctx, buffer, attr_list);
 326    default:
 327       return dri2_create_image_khr(drv, disp, ctx, target, buffer, attr_list);
 328    }
 329 }
 330
 331 /**
 332  * Called by the driver when it needs to update the real front buffer with the
 333  * contents of its fake front buffer.
 334  */
 335 static void
 336 dri3_flush_front_buffer(__DRIdrawable *driDrawable, void *loaderPrivate)
 337 {
 338    /* There does not seem to be any kind of consensus on whether we should
 339     * support front-buffer rendering or not:
 340     * http://lists.freedesktop.org/archives/mesa-dev/2013-June/040129.html
 341     */
 342    _eglLog(_EGL_WARNING, "FIXME: egl/x11 doesn't support front buffer rendering.");
 343    (void) driDrawable;
 344    (void) loaderPrivate;
 345 }
 346
 347 const __DRIimageLoaderExtension dri3_image_loader_extension = {
 348    .base = { __DRI_IMAGE_LOADER, 1 },
 349
 350    .getBuffers          = loader_dri3_get_buffers,
 351    .flushFrontBuffer    = dri3_flush_front_buffer,
 352 };
 353
 354 static EGLBoolean
 355 dri3_swap_buffers(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *draw)
 356 {
 357    struct dri3_egl_surface *dri3_surf = dri3_egl_surface(draw);
 358
 359    /* No-op for a pixmap or pbuffer surface */
 360    if (draw->Type == EGL_PIXMAP_BIT || draw->Type == EGL_PBUFFER_BIT)
 361       return EGL_FALSE;
 362
 363    return loader_dri3_swap_buffers_msc(&dri3_surf->loader_drawable,
 364                                        0, 0, 0, 0,
 365                                        draw->SwapBehavior == EGL_BUFFER_PRESERVED) != -1;
 366 }
 367
 368 static EGLBoolean
 369 dri3_copy_buffers(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf,
 370                   void *native_pixmap_target)
 371 {
 372    struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
 373    xcb_pixmap_t target;
 374
 375    STATIC_ASSERT(sizeof(uintptr_t) == sizeof(native_pixmap_target));
 376    target = (uintptr_t) native_pixmap_target;
 377
 378    loader_dri3_copy_drawable(&dri3_surf->loader_drawable, target,
 379                              dri3_surf->loader_drawable.drawable);
 380
 381    return EGL_TRUE;
 382 }
 383
 384 static int
 385 dri3_query_buffer_age(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf)
 386 {
 387    struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
 388
 389    return loader_dri3_query_buffer_age(&dri3_surf->loader_drawable);
 390 }
 391
 392 static EGLBoolean
 393 dri3_query_surface(_EGLDriver *drv, _EGLDisplay *dpy,
 394                    _EGLSurface *surf, EGLint attribute,
 395                    EGLint *value)
 396 {
 397    struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
 398
 399    switch (attribute) {
 400    case EGL_WIDTH:
 401    case EGL_HEIGHT:
 402       loader_dri3_update_drawable_geometry(&dri3_surf->loader_drawable);
 403       break;
 404    default:
 405       break;
 406    }
 407
 408    return _eglQuerySurface(drv, dpy, surf, attribute, value);
 409 }
 410
 411 static __DRIdrawable *
 412 dri3_get_dri_drawable(_EGLSurface *surf)
 413 {
 414    struct dri3_egl_surface *dri3_surf = dri3_egl_surface(surf);
 415
 416    return dri3_surf->loader_drawable.dri_drawable;
 417 }
 418
 419 static void
 420 dri3_close_screen_notify(_EGLDisplay *dpy)
 421 {
 422    struct dri2_egl_display *dri2_dpy = dri2_egl_display(dpy);
 423
 424    loader_dri3_close_screen(dri2_dpy->dri_screen);
 425 }
 426
 427 struct dri2_egl_display_vtbl dri3_x11_display_vtbl = {
 428    .authenticate = dri3_authenticate,
 429    .create_window_surface = dri3_create_window_surface,
 430    .create_pixmap_surface = dri3_create_pixmap_surface,
 431    .create_pbuffer_surface = dri3_create_pbuffer_surface,
 432    .destroy_surface = dri3_destroy_surface,
 433    .create_image = dri3_create_image_khr,
 434    .swap_interval = dri3_set_swap_interval,
 435    .swap_buffers = dri3_swap_buffers,
 436    .swap_buffers_with_damage = dri2_fallback_swap_buffers_with_damage,
 437    .swap_buffers_region = dri2_fallback_swap_buffers_region,
 438    .set_damage_region = dri2_fallback_set_damage_region,
 439    .post_sub_buffer = dri2_fallback_post_sub_buffer,
 440    .copy_buffers = dri3_copy_buffers,
 441    .query_buffer_age = dri3_query_buffer_age,
 442    .query_surface = dri3_query_surface,
 443    .create_wayland_buffer_from_image = dri2_fallback_create_wayland_buffer_from_image,
 444    .get_sync_values = dri3_get_sync_values,
 445    .get_dri_drawable = dri3_get_dri_drawable,
 446    .close_screen_notify = dri3_close_screen_notify,
 447 };
 448
 449 EGLBoolean
 450 dri3_x11_connect(struct dri2_egl_display *dri2_dpy)
 451 {
 452    xcb_dri3_query_version_reply_t *dri3_query;
 453    xcb_dri3_query_version_cookie_t dri3_query_cookie;
 454    xcb_present_query_version_reply_t *present_query;
 455    xcb_present_query_version_cookie_t present_query_cookie;
 456    xcb_generic_error_t *error;
 457    const xcb_query_extension_reply_t *extension;
 458
 459    xcb_prefetch_extension_data (dri2_dpy->conn, &xcb_dri3_id);
 460    xcb_prefetch_extension_data (dri2_dpy->conn, &xcb_present_id);
 461
 462    extension = xcb_get_extension_data(dri2_dpy->conn, &xcb_dri3_id);
 463    if (!(extension && extension->present))
 464       return EGL_FALSE;
 465
 466    extension = xcb_get_extension_data(dri2_dpy->conn, &xcb_present_id);
 467    if (!(extension && extension->present))
 468       return EGL_FALSE;
 469
 470    dri3_query_cookie = xcb_dri3_query_version(dri2_dpy->conn,
 471                                               XCB_DRI3_MAJOR_VERSION,
 472                                               XCB_DRI3_MINOR_VERSION);
 473
 474    present_query_cookie = xcb_present_query_version(dri2_dpy->conn,
 475                                                     XCB_PRESENT_MAJOR_VERSION,
 476                                                     XCB_PRESENT_MINOR_VERSION);
 477
 478    dri3_query =
 479       xcb_dri3_query_version_reply(dri2_dpy->conn, dri3_query_cookie, &error);
 480    if (dri3_query == NULL || error != NULL) {
 481       _eglLog(_EGL_WARNING, "DRI3: failed to query the version");
 482       free(dri3_query);
 483       free(error);
 484       return EGL_FALSE;
 485    }
 486    free(dri3_query);
 487
 488    present_query =
 489       xcb_present_query_version_reply(dri2_dpy->conn,
 490                                       present_query_cookie, &error);
 491    if (present_query == NULL || error != NULL) {
 492       _eglLog(_EGL_WARNING, "DRI3: failed to query Present version");
 493       free(present_query);
 494       free(error);
 495       return EGL_FALSE;
 496    }
 497    free(present_query);
 498
 499    dri2_dpy->fd = loader_dri3_open(dri2_dpy->conn, dri2_dpy->screen->root, 0);
 500    if (dri2_dpy->fd < 0) {
 501       int conn_error = xcb_connection_has_error(dri2_dpy->conn);
 502       _eglLog(_EGL_WARNING, "DRI3: Screen seems not DRI3 capable");
 503
 504       if (conn_error)
 505          _eglLog(_EGL_WARNING, "DRI3: Failed to initialize");
 506
 507       return EGL_FALSE;
 508    }
 509
 510    dri2_dpy->fd = loader_get_user_preferred_fd(dri2_dpy->fd, &dri2_dpy->is_different_gpu);
 511
 512    dri2_dpy->driver_name = loader_get_driver_for_fd(dri2_dpy->fd);
 513    if (!dri2_dpy->driver_name) {
 514       _eglLog(_EGL_WARNING, "DRI3: No driver found");
 515       close(dri2_dpy->fd);
 516       return EGL_FALSE;
 517    }
 518
 519 #ifdef HAVE_WAYLAND_PLATFORM
 520    /* Only try to get a render device name since dri3 doesn't provide a
 521     * mechanism for authenticating client opened device node fds. If this
 522     * fails then don't advertise the extension. */
 523    dri2_dpy->device_name = drmGetRenderDeviceNameFromFd(dri2_dpy->fd);
 524 #endif
 525
 526    return EGL_TRUE;
 527 }