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