src/egl/drivers/dri2/platform_surfaceless.c

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (c) 2014 The Chromium OS Authors.
   5  * Copyright © 2011 Intel Corporation
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23  * DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 #include <stdlib.h>
  27 #include <stdio.h>
  28 #include <string.h>
  29 #include <xf86drm.h>
  30 #include <dlfcn.h>
  31 #include <sys/types.h>
  32 #include <sys/stat.h>
  33 #include <fcntl.h>
  34 #include <unistd.h>
  35
  36 #include "egl_dri2.h"
  37 #include "egl_dri2_fallbacks.h"
  38 #include "loader.h"
  39
  40 static __DRIimage*
  41 surfaceless_alloc_image(struct dri2_egl_display *dri2_dpy,
  42                      struct dri2_egl_surface *dri2_surf)
  43 {
  44    return dri2_dpy->image->createImage(
  45             dri2_dpy->dri_screen,
  46             dri2_surf->base.Width,
  47             dri2_surf->base.Height,
  48             dri2_surf->visual,
  49             0,
  50             NULL);
  51 }
  52
  53 static void
  54 surfaceless_free_images(struct dri2_egl_surface *dri2_surf)
  55 {
  56    struct dri2_egl_display *dri2_dpy =
  57       dri2_egl_display(dri2_surf->base.Resource.Display);
  58
  59    if (dri2_surf->front) {
  60       dri2_dpy->image->destroyImage(dri2_surf->front);
  61       dri2_surf->front = NULL;
  62    }
  63 }
  64
  65 static int
  66 surfaceless_image_get_buffers(__DRIdrawable *driDrawable,
  67                         unsigned int format,
  68                         uint32_t *stamp,
  69                         void *loaderPrivate,
  70                         uint32_t buffer_mask,
  71                         struct __DRIimageList *buffers)
  72 {
  73    struct dri2_egl_surface *dri2_surf = loaderPrivate;
  74    struct dri2_egl_display *dri2_dpy =
  75       dri2_egl_display(dri2_surf->base.Resource.Display);
  76
  77    buffers->image_mask = 0;
  78    buffers->front = NULL;
  79    buffers->back = NULL;
  80
  81    /* The EGL 1.5 spec states that pbuffers are single-buffered. Specifically,
  82     * the spec states that they have a back buffer but no front buffer, in
  83     * contrast to pixmaps, which have a front buffer but no back buffer.
  84     *
  85     * Single-buffered surfaces with no front buffer confuse Mesa; so we deviate
  86     * from the spec, following the precedent of Mesa's EGL X11 platform. The
  87     * X11 platform correctly assigns pbuffers to single-buffered configs, but
  88     * assigns the pbuffer a front buffer instead of a back buffer.
  89     *
  90     * Pbuffers in the X11 platform mostly work today, so let's just copy its
  91     * behavior instead of trying to fix (and hence potentially breaking) the
  92     * world.
  93     */
  94
  95    if (buffer_mask & __DRI_IMAGE_BUFFER_FRONT) {
  96
  97       if (!dri2_surf->front)
  98          dri2_surf->front =
  99             surfaceless_alloc_image(dri2_dpy, dri2_surf);
 100
 101       buffers->image_mask |= __DRI_IMAGE_BUFFER_FRONT;
 102       buffers->front = dri2_surf->front;
 103    }
 104
 105    return 1;
 106 }
 107
 108 static _EGLSurface *
 109 dri2_surfaceless_create_surface(_EGLDriver *drv, _EGLDisplay *disp, EGLint type,
 110                         _EGLConfig *conf, const EGLint *attrib_list)
 111 {
 112    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 113    struct dri2_egl_config *dri2_conf = dri2_egl_config(conf);
 114    struct dri2_egl_surface *dri2_surf;
 115    const __DRIconfig *config;
 116
 117    /* Make sure to calloc so all pointers
 118     * are originally NULL.
 119     */
 120    dri2_surf = calloc(1, sizeof *dri2_surf);
 121
 122    if (!dri2_surf) {
 123       _eglError(EGL_BAD_ALLOC, "eglCreatePbufferSurface");
 124       return NULL;
 125    }
 126
 127    if (!dri2_init_surface(&dri2_surf->base, disp, type, conf, attrib_list,
 128                           false, NULL))
 129       goto cleanup_surface;
 130
 131    config = dri2_get_dri_config(dri2_conf, type,
 132                                 dri2_surf->base.GLColorspace);
 133
 134    if (!config) {
 135       _eglError(EGL_BAD_MATCH, "Unsupported surfacetype/colorspace configuration");
 136       goto cleanup_surface;
 137    }
 138
 139    dri2_surf->dri_drawable =
 140       dri2_dpy->image_driver->createNewDrawable(dri2_dpy->dri_screen, config,
 141                                                 dri2_surf);
 142    if (dri2_surf->dri_drawable == NULL) {
 143       _eglError(EGL_BAD_ALLOC, "image->createNewDrawable");
 144       goto cleanup_surface;
 145     }
 146
 147    if (conf->RedSize == 5)
 148       dri2_surf->visual = __DRI_IMAGE_FORMAT_RGB565;
 149    else if (conf->AlphaSize == 0)
 150       dri2_surf->visual = __DRI_IMAGE_FORMAT_XRGB8888;
 151    else
 152       dri2_surf->visual = __DRI_IMAGE_FORMAT_ARGB8888;
 153
 154    return &dri2_surf->base;
 155
 156    cleanup_surface:
 157       free(dri2_surf);
 158       return NULL;
 159 }
 160
 161 static EGLBoolean
 162 surfaceless_destroy_surface(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf)
 163 {
 164    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 165    struct dri2_egl_surface *dri2_surf = dri2_egl_surface(surf);
 166
 167    surfaceless_free_images(dri2_surf);
 168
 169    dri2_dpy->core->destroyDrawable(dri2_surf->dri_drawable);
 170
 171    dri2_fini_surface(surf);
 172    free(dri2_surf);
 173    return EGL_TRUE;
 174 }
 175
 176 static _EGLSurface *
 177 dri2_surfaceless_create_pbuffer_surface(_EGLDriver *drv, _EGLDisplay *disp,
 178                                 _EGLConfig *conf, const EGLint *attrib_list)
 179 {
 180    return dri2_surfaceless_create_surface(drv, disp, EGL_PBUFFER_BIT, conf,
 181                                   attrib_list);
 182 }
 183
 184 static EGLBoolean
 185 surfaceless_add_configs_for_visuals(_EGLDriver *drv, _EGLDisplay *disp)
 186 {
 187    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 188    static const struct {
 189       const char *format_name;
 190       unsigned int rgba_masks[4];
 191    } visuals[] = {
 192       { "ARGB8888", { 0xff0000, 0xff00, 0xff, 0xff000000 } },
 193       { "RGB888",   { 0xff0000, 0xff00, 0xff, 0x0 } },
 194       { "RGB565",   { 0x00f800, 0x07e0, 0x1f, 0x0 } },
 195    };
 196    unsigned int format_count[ARRAY_SIZE(visuals)] = { 0 };
 197    unsigned int config_count = 0;
 198
 199    for (unsigned i = 0; dri2_dpy->driver_configs[i] != NULL; i++) {
 200       for (unsigned j = 0; j < ARRAY_SIZE(visuals); j++) {
 201          struct dri2_egl_config *dri2_conf;
 202
 203          dri2_conf = dri2_add_config(disp, dri2_dpy->driver_configs[i],
 204                config_count + 1, EGL_PBUFFER_BIT, NULL,
 205                visuals[j].rgba_masks);
 206
 207          if (dri2_conf) {
 208             if (dri2_conf->base.ConfigID == config_count + 1)
 209                config_count++;
 210             format_count[j]++;
 211          }
 212       }
 213    }
 214
 215    for (unsigned i = 0; i < ARRAY_SIZE(format_count); i++) {
 216       if (!format_count[i]) {
 217          _eglLog(_EGL_DEBUG, "No DRI config supports native format %s",
 218                visuals[i].format_name);
 219       }
 220    }
 221
 222    return (config_count != 0);
 223 }
 224
 225 static const struct dri2_egl_display_vtbl dri2_surfaceless_display_vtbl = {
 226    .create_pixmap_surface = dri2_fallback_create_pixmap_surface,
 227    .create_pbuffer_surface = dri2_surfaceless_create_pbuffer_surface,
 228    .destroy_surface = surfaceless_destroy_surface,
 229    .create_image = dri2_create_image_khr,
 230    .swap_buffers_region = dri2_fallback_swap_buffers_region,
 231    .set_damage_region = dri2_fallback_set_damage_region,
 232    .post_sub_buffer = dri2_fallback_post_sub_buffer,
 233    .copy_buffers = dri2_fallback_copy_buffers,
 234    .query_buffer_age = dri2_fallback_query_buffer_age,
 235    .create_wayland_buffer_from_image = dri2_fallback_create_wayland_buffer_from_image,
 236    .get_sync_values = dri2_fallback_get_sync_values,
 237    .get_dri_drawable = dri2_surface_get_dri_drawable,
 238 };
 239
 240 static void
 241 surfaceless_flush_front_buffer(__DRIdrawable *driDrawable, void *loaderPrivate)
 242 {
 243 }
 244
 245 static const __DRIimageLoaderExtension image_loader_extension = {
 246    .base             = { __DRI_IMAGE_LOADER, 1 },
 247    .getBuffers       = surfaceless_image_get_buffers,
 248    .flushFrontBuffer = surfaceless_flush_front_buffer,
 249 };
 250
 251 static const __DRIswrastLoaderExtension swrast_loader_extension = {
 252    .base            = { __DRI_SWRAST_LOADER, 1 },
 253    .getDrawableInfo = NULL,
 254    .putImage        = NULL,
 255    .getImage        = NULL,
 256 };
 257
 258 static const __DRIextension *image_loader_extensions[] = {
 259    &image_loader_extension.base,
 260    &image_lookup_extension.base,
 261    &use_invalidate.base,
 262    NULL,
 263 };
 264
 265 static const __DRIextension *swrast_loader_extensions[] = {
 266    &swrast_loader_extension.base,
 267    &image_loader_extension.base,
 268    &image_lookup_extension.base,
 269    &use_invalidate.base,
 270    NULL,
 271 };
 272
 273 static bool
 274 surfaceless_probe_device(_EGLDisplay *disp, bool swrast)
 275 {
 276 #define MAX_DRM_DEVICES 64
 277    const unsigned node_type = swrast ? DRM_NODE_PRIMARY : DRM_NODE_RENDER;
 278    struct dri2_egl_display *dri2_dpy = disp->DriverData;
 279    drmDevicePtr device, devices[MAX_DRM_DEVICES] = { NULL };
 280    int i, num_devices;
 281
 282    num_devices = drmGetDevices2(0, devices, ARRAY_SIZE(devices));
 283    if (num_devices < 0)
 284       return false;
 285
 286    for (i = 0; i < num_devices; ++i) {
 287       device = devices[i];
 288
 289       if (!(device->available_nodes & (1 << node_type)))
 290          continue;
 291
 292       dri2_dpy->fd = loader_open_device(device->nodes[node_type]);
 293       if (dri2_dpy->fd < 0)
 294          continue;
 295
 296       disp->Device = _eglAddDevice(dri2_dpy->fd, swrast);
 297       if (!disp->Device) {
 298          close(dri2_dpy->fd);
 299          dri2_dpy->fd = -1;
 300          continue;
 301       }
 302
 303       char *driver_name = loader_get_driver_for_fd(dri2_dpy->fd);
 304       if (swrast) {
 305          /* Use kms swrast only with vgem / virtio_gpu.
 306           * virtio-gpu fallbacks to software rendering when 3D features
 307           * are unavailable since 6c5ab, and kms_swrast is more
 308           * feature complete than swrast.
 309           */
 310          if (strcmp(driver_name, "vgem") == 0 ||
 311              strcmp(driver_name, "virtio_gpu") == 0)
 312             dri2_dpy->driver_name = strdup("kms_swrast");
 313          free(driver_name);
 314       } else {
 315          /* Use the given hardware driver */
 316          dri2_dpy->driver_name = driver_name;
 317       }
 318
 319       if (dri2_dpy->driver_name && dri2_load_driver_dri3(disp))
 320          break;
 321
 322       free(dri2_dpy->driver_name);
 323       dri2_dpy->driver_name = NULL;
 324       close(dri2_dpy->fd);
 325       dri2_dpy->fd = -1;
 326    }
 327    drmFreeDevices(devices, num_devices);
 328
 329    if (i == num_devices)
 330       return false;
 331
 332    if (swrast)
 333       dri2_dpy->loader_extensions = swrast_loader_extensions;
 334    else
 335       dri2_dpy->loader_extensions = image_loader_extensions;
 336
 337    return true;
 338 }
 339
 340 static bool
 341 surfaceless_probe_device_sw(_EGLDisplay *disp)
 342 {
 343    struct dri2_egl_display *dri2_dpy = disp->DriverData;
 344
 345    dri2_dpy->fd = -1;
 346    disp->Device = _eglAddDevice(dri2_dpy->fd, true);
 347    assert(disp->Device);
 348
 349    dri2_dpy->driver_name = strdup("swrast");
 350    if (!dri2_dpy->driver_name)
 351       return false;
 352
 353    if (!dri2_load_driver_swrast(disp)) {
 354       free(dri2_dpy->driver_name);
 355       dri2_dpy->driver_name = NULL;
 356       return false;
 357    }
 358
 359    dri2_dpy->loader_extensions = swrast_loader_extensions;
 360    return true;
 361 }
 362
 363 EGLBoolean
 364 dri2_initialize_surfaceless(_EGLDriver *drv, _EGLDisplay *disp)
 365 {
 366    struct dri2_egl_display *dri2_dpy;
 367    const char* err;
 368    bool driver_loaded = false;
 369
 370    dri2_dpy = calloc(1, sizeof *dri2_dpy);
 371    if (!dri2_dpy)
 372       return _eglError(EGL_BAD_ALLOC, "eglInitialize");
 373
 374    dri2_dpy->fd = -1;
 375    disp->DriverData = (void *) dri2_dpy;
 376
 377    if (!disp->Options.ForceSoftware) {
 378       driver_loaded = surfaceless_probe_device(disp, false);
 379       if (!driver_loaded)
 380          _eglLog(_EGL_WARNING,
 381                  "No hardware driver found, falling back to software rendering");
 382    }
 383
 384    if (!driver_loaded)
 385       driver_loaded = surfaceless_probe_device(disp, true);
 386
 387    if (!driver_loaded) {
 388       _eglLog(_EGL_DEBUG, "Falling back to surfaceless swrast without DRM.");
 389       if (!surfaceless_probe_device_sw(disp)) {
 390          err = "DRI2: failed to load driver";
 391          goto cleanup;
 392       }
 393    }
 394
 395    if (!dri2_create_screen(disp)) {
 396       err = "DRI2: failed to create screen";
 397       goto cleanup;
 398    }
 399
 400    if (!dri2_setup_extensions(disp)) {
 401       err = "DRI2: failed to find required DRI extensions";
 402       goto cleanup;
 403    }
 404
 405    dri2_setup_screen(disp);
 406
 407    if (!surfaceless_add_configs_for_visuals(drv, disp)) {
 408       err = "DRI2: failed to add configs";
 409       goto cleanup;
 410    }
 411
 412    /* Fill vtbl last to prevent accidentally calling virtual function during
 413     * initialization.
 414     */
 415    dri2_dpy->vtbl = &dri2_surfaceless_display_vtbl;
 416
 417    return EGL_TRUE;
 418
 419 cleanup:
 420    dri2_display_destroy(disp);
 421    return _eglError(EGL_NOT_INITIALIZED, err);
 422 }