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