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