src/egl/drivers/dri2/platform_device.c

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright 2018 Collabora
   5  *
   6  * Based on platform_surfaceless, which has:
   7  *
   8  * Copyright (c) 2014 The Chromium OS Authors.
   9  * Copyright © 2011 Intel Corporation
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a
  12  * copy of this software and associated documentation files (the "Software"),
  13  * to deal in the Software without restriction, including without limitation
  14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  15  * and/or sell copies of the Software, and to permit persons to whom the
  16  * Software is furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included
  19  * in all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  27  * DEALINGS IN THE SOFTWARE.
  28  */
  29 #ifdef HAVE_LIBDRM
  30 #include <xf86drm.h>
  31 #endif
  32
  33 #include <stdlib.h>
  34 #include <stdio.h>
  35 #include <string.h>
  36 #include <dlfcn.h>
  37 #include <sys/types.h>
  38 #include <sys/stat.h>
  39 #include <fcntl.h>
  40 #include <unistd.h>
  41
  42 #include "egl_dri2.h"
  43 #include "loader.h"
  44 #include "util/debug.h"
  45
  46 static __DRIimage*
  47 device_alloc_image(struct dri2_egl_display *dri2_dpy,
  48                    struct dri2_egl_surface *dri2_surf)
  49 {
  50    return dri2_dpy->image->createImage(
  51             dri2_dpy->dri_screen,
  52             dri2_surf->base.Width,
  53             dri2_surf->base.Height,
  54             dri2_surf->visual,
  55             0,
  56             NULL);
  57 }
  58
  59 static void
  60 device_free_images(struct dri2_egl_surface *dri2_surf)
  61 {
  62    struct dri2_egl_display *dri2_dpy =
  63       dri2_egl_display(dri2_surf->base.Resource.Display);
  64
  65    if (dri2_surf->front) {
  66       dri2_dpy->image->destroyImage(dri2_surf->front);
  67       dri2_surf->front = NULL;
  68    }
  69
  70    free(dri2_surf->swrast_device_buffer);
  71    dri2_surf->swrast_device_buffer = NULL;
  72 }
  73
  74 static int
  75 device_image_get_buffers(__DRIdrawable *driDrawable,
  76                          unsigned int format,
  77                          uint32_t *stamp,
  78                          void *loaderPrivate,
  79                          uint32_t buffer_mask,
  80                          struct __DRIimageList *buffers)
  81 {
  82    struct dri2_egl_surface *dri2_surf = loaderPrivate;
  83    struct dri2_egl_display *dri2_dpy =
  84       dri2_egl_display(dri2_surf->base.Resource.Display);
  85
  86    buffers->image_mask = 0;
  87    buffers->front = NULL;
  88    buffers->back = NULL;
  89
  90    /* The EGL 1.5 spec states that pbuffers are single-buffered. Specifically,
  91     * the spec states that they have a back buffer but no front buffer, in
  92     * contrast to pixmaps, which have a front buffer but no back buffer.
  93     *
  94     * Single-buffered surfaces with no front buffer confuse Mesa; so we deviate
  95     * from the spec, following the precedent of Mesa's EGL X11 platform. The
  96     * X11 platform correctly assigns pbuffers to single-buffered configs, but
  97     * assigns the pbuffer a front buffer instead of a back buffer.
  98     *
  99     * Pbuffers in the X11 platform mostly work today, so let's just copy its
 100     * behavior instead of trying to fix (and hence potentially breaking) the
 101     * world.
 102     */
 103
 104    if (buffer_mask & __DRI_IMAGE_BUFFER_FRONT) {
 105
 106       if (!dri2_surf->front)
 107          dri2_surf->front =
 108             device_alloc_image(dri2_dpy, dri2_surf);
 109
 110       buffers->image_mask |= __DRI_IMAGE_BUFFER_FRONT;
 111       buffers->front = dri2_surf->front;
 112    }
 113
 114    return 1;
 115 }
 116
 117 static _EGLSurface *
 118 dri2_device_create_surface(_EGLDisplay *disp, EGLint type, _EGLConfig *conf,
 119                            const EGLint *attrib_list)
 120 {
 121    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 122    struct dri2_egl_config *dri2_conf = dri2_egl_config(conf);
 123    struct dri2_egl_surface *dri2_surf;
 124    const __DRIconfig *config;
 125
 126    /* Make sure to calloc so all pointers
 127     * are originally NULL.
 128     */
 129    dri2_surf = calloc(1, sizeof *dri2_surf);
 130
 131    if (!dri2_surf) {
 132       _eglError(EGL_BAD_ALLOC, "eglCreatePbufferSurface");
 133       return NULL;
 134    }
 135
 136    if (!dri2_init_surface(&dri2_surf->base, disp, type, conf, attrib_list,
 137                           false, NULL))
 138       goto cleanup_surface;
 139
 140    config = dri2_get_dri_config(dri2_conf, type,
 141                                 dri2_surf->base.GLColorspace);
 142
 143    if (!config) {
 144       _eglError(EGL_BAD_MATCH, "Unsupported surfacetype/colorspace configuration");
 145       goto cleanup_surface;
 146    }
 147
 148    dri2_surf->visual = dri2_image_format_for_pbuffer_config(dri2_dpy, config);
 149    if (dri2_surf->visual == __DRI_IMAGE_FORMAT_NONE)
 150       goto cleanup_surface;
 151
 152    if (!dri2_create_drawable(dri2_dpy, config, dri2_surf, dri2_surf))
 153       goto cleanup_surface;
 154
 155    return &dri2_surf->base;
 156
 157    cleanup_surface:
 158       free(dri2_surf);
 159       return NULL;
 160 }
 161
 162 static EGLBoolean
 163 device_destroy_surface(_EGLDisplay *disp, _EGLSurface *surf)
 164 {
 165    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 166    struct dri2_egl_surface *dri2_surf = dri2_egl_surface(surf);
 167
 168    device_free_images(dri2_surf);
 169
 170    dri2_dpy->core->destroyDrawable(dri2_surf->dri_drawable);
 171
 172    dri2_fini_surface(surf);
 173    free(dri2_surf);
 174    return EGL_TRUE;
 175 }
 176
 177 static _EGLSurface *
 178 dri2_device_create_pbuffer_surface(_EGLDisplay *disp, _EGLConfig *conf,
 179                                    const EGLint *attrib_list)
 180 {
 181    return dri2_device_create_surface(disp, EGL_PBUFFER_BIT, conf, attrib_list);
 182 }
 183
 184 static const struct dri2_egl_display_vtbl dri2_device_display_vtbl = {
 185    .create_pbuffer_surface = dri2_device_create_pbuffer_surface,
 186    .destroy_surface = device_destroy_surface,
 187    .create_image = dri2_create_image_khr,
 188    .get_dri_drawable = dri2_surface_get_dri_drawable,
 189 };
 190
 191 static void
 192 device_flush_front_buffer(__DRIdrawable *driDrawable, void *loaderPrivate)
 193 {
 194 }
 195
 196 static const __DRIimageLoaderExtension image_loader_extension = {
 197    .base             = { __DRI_IMAGE_LOADER, 1 },
 198    .getBuffers       = device_image_get_buffers,
 199    .flushFrontBuffer = device_flush_front_buffer,
 200 };
 201
 202 static const __DRIextension *image_loader_extensions[] = {
 203    &image_loader_extension.base,
 204    &image_lookup_extension.base,
 205    &use_invalidate.base,
 206    NULL,
 207 };
 208
 209 static const __DRIextension *swrast_loader_extensions[] = {
 210    &swrast_pbuffer_loader_extension.base,
 211    &image_lookup_extension.base,
 212    &use_invalidate.base,
 213    NULL,
 214 };
 215
 216 static int
 217 device_get_fd(_EGLDisplay *disp, _EGLDevice *dev)
 218 {
 219 #ifdef HAVE_LIBDRM
 220    int fd = disp->Options.fd;
 221    /* The fcntl() code in _eglGetDeviceDisplay() ensures that valid fd >= 3,
 222     * and invalid one is 0.
 223     */
 224    if (fd) {
 225       /* According to the spec - if the FD does not match the EGLDevice
 226        * behaviour is undefined.
 227        *
 228        * Add a trivial sanity check since it doesn't cost us anything.
 229        */
 230       if (dev != _eglAddDevice(fd, false))
 231          return -1;
 232
 233       /* No EGL_EXT_output* extensions are supported, hence no master perms
 234        * are needed. Get the render one - otherwise drivers might error out.
 235        */
 236       char *node = drmGetRenderDeviceNameFromFd(fd);
 237
 238       /* Don't close the internal fd, get render node one based on it. */
 239       fd = loader_open_device(node);
 240       free(node);
 241       return fd;
 242    }
 243    const char *node = _eglGetDRMDeviceRenderNode(dev);
 244    return loader_open_device(node);
 245 #else
 246    _eglLog(_EGL_FATAL, "Driver bug: Built without libdrm, yet using a HW device");
 247    return -1;
 248 #endif
 249 }
 250
 251 static bool
 252 device_probe_device(_EGLDisplay *disp)
 253 {
 254    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 255    bool request_software = env_var_as_boolean("LIBGL_ALWAYS_SOFTWARE", false);
 256
 257    if (request_software)
 258       _eglLog(_EGL_WARNING, "Not allowed to force software rendering when "
 259                             "API explicitly selects a hardware device.");
 260    dri2_dpy->fd = device_get_fd(disp, disp->Device);
 261    if (dri2_dpy->fd < 0)
 262       return false;
 263
 264    dri2_dpy->driver_name = loader_get_driver_for_fd(dri2_dpy->fd);
 265    if (!dri2_dpy->driver_name)
 266       goto err_name;
 267
 268    /* When doing software rendering, some times user still want to explicitly
 269     * choose the render node device since cross node import doesn't work between
 270     * vgem/virtio_gpu yet. It would be nice to have a new EXTENSION for this.
 271     * For now, just fallback to kms_swrast. */
 272    if (disp->Options.ForceSoftware && !request_software &&
 273        (strcmp(dri2_dpy->driver_name, "vgem") == 0 ||
 274         strcmp(dri2_dpy->driver_name, "virtio_gpu") == 0)) {
 275       free(dri2_dpy->driver_name);
 276       _eglLog(_EGL_WARNING, "NEEDS EXTENSION: falling back to kms_swrast");
 277       dri2_dpy->driver_name = strdup("kms_swrast");
 278    }
 279
 280    if (!dri2_load_driver_dri3(disp))
 281       goto err_load;
 282
 283    dri2_dpy->loader_extensions = image_loader_extensions;
 284    return true;
 285
 286 err_load:
 287    free(dri2_dpy->driver_name);
 288    dri2_dpy->driver_name = NULL;
 289
 290 err_name:
 291    close(dri2_dpy->fd);
 292    dri2_dpy->fd = -1;
 293    return false;
 294
 295 }
 296
 297 static bool
 298 device_probe_device_sw(_EGLDisplay *disp)
 299 {
 300    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 301
 302    dri2_dpy->fd = -1;
 303    dri2_dpy->driver_name = strdup("swrast");
 304    if (!dri2_dpy->driver_name)
 305       return false;
 306
 307    /* HACK: should be driver_swrast_null */
 308    if (!dri2_load_driver_swrast(disp)) {
 309       free(dri2_dpy->driver_name);
 310       dri2_dpy->driver_name = NULL;
 311       return false;
 312    }
 313
 314    dri2_dpy->loader_extensions = swrast_loader_extensions;
 315    return true;
 316 }
 317
 318 EGLBoolean
 319 dri2_initialize_device(_EGLDisplay *disp)
 320 {
 321    _EGLDevice *dev;
 322    struct dri2_egl_display *dri2_dpy;
 323    const char* err;
 324
 325    dri2_dpy = calloc(1, sizeof *dri2_dpy);
 326    if (!dri2_dpy)
 327       return _eglError(EGL_BAD_ALLOC, "eglInitialize");
 328
 329    /* Extension requires a PlatformDisplay - the EGLDevice. */
 330    dev = disp->PlatformDisplay;
 331
 332    dri2_dpy->fd = -1;
 333    disp->Device = dev;
 334    disp->DriverData = (void *) dri2_dpy;
 335    err = "DRI2: failed to load driver";
 336    if (_eglDeviceSupports(dev, _EGL_DEVICE_DRM)) {
 337       if (!device_probe_device(disp))
 338          goto cleanup;
 339    } else if (_eglDeviceSupports(dev, _EGL_DEVICE_SOFTWARE)) {
 340       if (!device_probe_device_sw(disp))
 341          goto cleanup;
 342    } else {
 343       _eglLog(_EGL_FATAL, "Driver bug: exposed device is neither DRM nor SOFTWARE one");
 344       return EGL_FALSE;
 345    }
 346
 347    if (!dri2_create_screen(disp)) {
 348       err = "DRI2: failed to create screen";
 349       goto cleanup;
 350    }
 351
 352    if (!dri2_setup_extensions(disp)) {
 353       err = "DRI2: failed to find required DRI extensions";
 354       goto cleanup;
 355    }
 356
 357    dri2_setup_screen(disp);
 358
 359    if (!dri2_add_pbuffer_configs_for_visuals(disp)) {
 360       err = "DRI2: failed to add configs";
 361       goto cleanup;
 362    }
 363
 364    /* Fill vtbl last to prevent accidentally calling virtual function during
 365     * initialization.
 366     */
 367    dri2_dpy->vtbl = &dri2_device_display_vtbl;
 368
 369    return EGL_TRUE;
 370
 371 cleanup:
 372    dri2_display_destroy(disp);
 373    return _eglError(EGL_NOT_INITIALIZED, err);
 374 }