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