Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 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" |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 43 | #include "loader.h" |
Lepton Wu | 81c0e2a | 2020-07-09 11:49:33 -0700 | [diff] [blame] | 44 | #include "util/debug.h" |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 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 | } |
Mathias Fröhlich | c7617d8 | 2019-12-13 17:09:56 +0100 | [diff] [blame] | 69 | |
| 70 | free(dri2_surf->swrast_device_buffer); |
| 71 | dri2_surf->swrast_device_buffer = NULL; |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 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 * |
Eric Engestrom | 9c6fa94 | 2020-07-31 01:38:41 +0200 | [diff] [blame^] | 118 | dri2_device_create_surface(const _EGLDriver *drv, _EGLDisplay *disp, EGLint type, |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 119 | _EGLConfig *conf, 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 | |
Mathias Fröhlich | d32c458 | 2020-02-09 19:01:53 +0100 | [diff] [blame] | 148 | dri2_surf->visual = dri2_image_format_for_pbuffer_config(dri2_dpy, config); |
| 149 | if (dri2_surf->visual == __DRI_IMAGE_FORMAT_NONE) |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 150 | goto cleanup_surface; |
| 151 | |
Mathias Fröhlich | d32c458 | 2020-02-09 19:01:53 +0100 | [diff] [blame] | 152 | if (!dri2_create_drawable(dri2_dpy, config, dri2_surf, dri2_surf)) |
| 153 | goto cleanup_surface; |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 154 | |
| 155 | return &dri2_surf->base; |
| 156 | |
| 157 | cleanup_surface: |
| 158 | free(dri2_surf); |
| 159 | return NULL; |
| 160 | } |
| 161 | |
| 162 | static EGLBoolean |
Eric Engestrom | 9c6fa94 | 2020-07-31 01:38:41 +0200 | [diff] [blame^] | 163 | device_destroy_surface(const _EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf) |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 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 * |
Eric Engestrom | 9c6fa94 | 2020-07-31 01:38:41 +0200 | [diff] [blame^] | 178 | dri2_device_create_pbuffer_surface(const _EGLDriver *drv, _EGLDisplay *disp, |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 179 | _EGLConfig *conf, const EGLint *attrib_list) |
| 180 | { |
| 181 | return dri2_device_create_surface(drv, disp, EGL_PBUFFER_BIT, conf, |
| 182 | attrib_list); |
| 183 | } |
| 184 | |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 185 | static const struct dri2_egl_display_vtbl dri2_device_display_vtbl = { |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 186 | .create_pbuffer_surface = dri2_device_create_pbuffer_surface, |
| 187 | .destroy_surface = device_destroy_surface, |
| 188 | .create_image = dri2_create_image_khr, |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 189 | .get_dri_drawable = dri2_surface_get_dri_drawable, |
| 190 | }; |
| 191 | |
| 192 | static void |
| 193 | device_flush_front_buffer(__DRIdrawable *driDrawable, void *loaderPrivate) |
| 194 | { |
| 195 | } |
| 196 | |
| 197 | static const __DRIimageLoaderExtension image_loader_extension = { |
| 198 | .base = { __DRI_IMAGE_LOADER, 1 }, |
| 199 | .getBuffers = device_image_get_buffers, |
| 200 | .flushFrontBuffer = device_flush_front_buffer, |
| 201 | }; |
| 202 | |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 203 | static const __DRIextension *image_loader_extensions[] = { |
| 204 | &image_loader_extension.base, |
| 205 | &image_lookup_extension.base, |
| 206 | &use_invalidate.base, |
| 207 | NULL, |
| 208 | }; |
| 209 | |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 210 | static const __DRIextension *swrast_loader_extensions[] = { |
Eric Anholt | 6a8d39dc | 2019-07-23 13:18:21 -0700 | [diff] [blame] | 211 | &swrast_pbuffer_loader_extension.base, |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 212 | &image_lookup_extension.base, |
| 213 | &use_invalidate.base, |
| 214 | NULL, |
| 215 | }; |
| 216 | |
| 217 | static int |
| 218 | device_get_fd(_EGLDisplay *disp, _EGLDevice *dev) |
| 219 | { |
| 220 | #ifdef HAVE_LIBDRM |
| 221 | int fd = disp->Options.fd; |
| 222 | /* The fcntl() code in _eglGetDeviceDisplay() ensures that valid fd >= 3, |
| 223 | * and invalid one is 0. |
| 224 | */ |
| 225 | if (fd) { |
| 226 | /* According to the spec - if the FD does not match the EGLDevice |
| 227 | * behaviour is undefined. |
| 228 | * |
| 229 | * Add a trivial sanity check since it doesn't cost us anything. |
| 230 | */ |
| 231 | if (dev != _eglAddDevice(fd, false)) |
| 232 | return -1; |
| 233 | |
| 234 | /* No EGL_EXT_output* extensions are supported, hence no master perms |
| 235 | * are needed. Get the render one - otherwise drivers might error out. |
| 236 | */ |
| 237 | char *node = drmGetRenderDeviceNameFromFd(fd); |
| 238 | |
| 239 | /* Don't close the internal fd, get render node one based on it. */ |
| 240 | fd = loader_open_device(node); |
| 241 | free(node); |
| 242 | return fd; |
| 243 | } |
| 244 | const char *node = _eglGetDRMDeviceRenderNode(dev); |
| 245 | return loader_open_device(node); |
| 246 | #else |
| 247 | _eglLog(_EGL_FATAL, "Driver bug: Built without libdrm, yet using a HW device"); |
| 248 | return -1; |
| 249 | #endif |
| 250 | } |
| 251 | |
| 252 | static bool |
| 253 | device_probe_device(_EGLDisplay *disp) |
| 254 | { |
| 255 | struct dri2_egl_display *dri2_dpy = disp->DriverData; |
Lepton Wu | 81c0e2a | 2020-07-09 11:49:33 -0700 | [diff] [blame] | 256 | bool request_software = env_var_as_boolean("LIBGL_ALWAYS_SOFTWARE", false); |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 257 | |
Lepton Wu | 81c0e2a | 2020-07-09 11:49:33 -0700 | [diff] [blame] | 258 | if (request_software) |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 259 | _eglLog(_EGL_WARNING, "Not allowed to force software rendering when " |
| 260 | "API explicitly selects a hardware device."); |
| 261 | dri2_dpy->fd = device_get_fd(disp, disp->Device); |
| 262 | if (dri2_dpy->fd < 0) |
| 263 | return false; |
| 264 | |
| 265 | dri2_dpy->driver_name = loader_get_driver_for_fd(dri2_dpy->fd); |
| 266 | if (!dri2_dpy->driver_name) |
| 267 | goto err_name; |
| 268 | |
Lepton Wu | 81c0e2a | 2020-07-09 11:49:33 -0700 | [diff] [blame] | 269 | /* When doing software rendering, some times user still want to explicitly |
| 270 | * choose the render node device since cross node import doesn't work between |
| 271 | * vgem/virtio_gpu yet. It would be nice to have a new EXTENSION for this. |
| 272 | * For now, just fallback to kms_swrast. */ |
| 273 | if (disp->Options.ForceSoftware && !request_software && |
| 274 | (strcmp(dri2_dpy->driver_name, "vgem") == 0 || |
| 275 | strcmp(dri2_dpy->driver_name, "virtio_gpu") == 0)) { |
| 276 | free(dri2_dpy->driver_name); |
| 277 | _eglLog(_EGL_WARNING, "NEEDS EXTENSION: falling back to kms_swrast"); |
| 278 | dri2_dpy->driver_name = strdup("kms_swrast"); |
| 279 | } |
| 280 | |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 281 | if (!dri2_load_driver_dri3(disp)) |
| 282 | goto err_load; |
| 283 | |
| 284 | dri2_dpy->loader_extensions = image_loader_extensions; |
| 285 | return true; |
| 286 | |
| 287 | err_load: |
| 288 | free(dri2_dpy->driver_name); |
| 289 | dri2_dpy->driver_name = NULL; |
| 290 | |
| 291 | err_name: |
| 292 | close(dri2_dpy->fd); |
| 293 | dri2_dpy->fd = -1; |
| 294 | return false; |
| 295 | |
| 296 | } |
| 297 | |
| 298 | static bool |
| 299 | device_probe_device_sw(_EGLDisplay *disp) |
| 300 | { |
| 301 | struct dri2_egl_display *dri2_dpy = disp->DriverData; |
| 302 | |
| 303 | dri2_dpy->fd = -1; |
| 304 | dri2_dpy->driver_name = strdup("swrast"); |
| 305 | if (!dri2_dpy->driver_name) |
| 306 | return false; |
| 307 | |
| 308 | /* HACK: should be driver_swrast_null */ |
| 309 | if (!dri2_load_driver_swrast(disp)) { |
| 310 | free(dri2_dpy->driver_name); |
| 311 | dri2_dpy->driver_name = NULL; |
| 312 | return false; |
| 313 | } |
| 314 | |
| 315 | dri2_dpy->loader_extensions = swrast_loader_extensions; |
| 316 | return true; |
| 317 | } |
| 318 | |
| 319 | EGLBoolean |
Eric Engestrom | 9c6fa94 | 2020-07-31 01:38:41 +0200 | [diff] [blame^] | 320 | dri2_initialize_device(const _EGLDriver *drv, _EGLDisplay *disp) |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 321 | { |
| 322 | _EGLDevice *dev; |
| 323 | struct dri2_egl_display *dri2_dpy; |
| 324 | const char* err; |
| 325 | |
| 326 | dri2_dpy = calloc(1, sizeof *dri2_dpy); |
| 327 | if (!dri2_dpy) |
| 328 | return _eglError(EGL_BAD_ALLOC, "eglInitialize"); |
| 329 | |
| 330 | /* Extension requires a PlatformDisplay - the EGLDevice. */ |
| 331 | dev = disp->PlatformDisplay; |
| 332 | |
| 333 | dri2_dpy->fd = -1; |
| 334 | disp->Device = dev; |
| 335 | disp->DriverData = (void *) dri2_dpy; |
| 336 | err = "DRI2: failed to load driver"; |
| 337 | if (_eglDeviceSupports(dev, _EGL_DEVICE_DRM)) { |
| 338 | if (!device_probe_device(disp)) |
| 339 | goto cleanup; |
| 340 | } else if (_eglDeviceSupports(dev, _EGL_DEVICE_SOFTWARE)) { |
| 341 | if (!device_probe_device_sw(disp)) |
| 342 | goto cleanup; |
| 343 | } else { |
| 344 | _eglLog(_EGL_FATAL, "Driver bug: exposed device is neither DRM nor SOFTWARE one"); |
| 345 | return EGL_FALSE; |
| 346 | } |
| 347 | |
| 348 | if (!dri2_create_screen(disp)) { |
| 349 | err = "DRI2: failed to create screen"; |
| 350 | goto cleanup; |
| 351 | } |
| 352 | |
| 353 | if (!dri2_setup_extensions(disp)) { |
| 354 | err = "DRI2: failed to find required DRI extensions"; |
| 355 | goto cleanup; |
| 356 | } |
| 357 | |
| 358 | dri2_setup_screen(disp); |
| 359 | |
Mathias Fröhlich | f280c00 | 2020-02-16 11:13:43 +0100 | [diff] [blame] | 360 | if (!dri2_add_pbuffer_configs_for_visuals(drv, disp)) { |
Emil Velikov | d6edcce | 2019-05-16 18:01:40 +0100 | [diff] [blame] | 361 | err = "DRI2: failed to add configs"; |
| 362 | goto cleanup; |
| 363 | } |
| 364 | |
| 365 | /* Fill vtbl last to prevent accidentally calling virtual function during |
| 366 | * initialization. |
| 367 | */ |
| 368 | dri2_dpy->vtbl = &dri2_device_display_vtbl; |
| 369 | |
| 370 | return EGL_TRUE; |
| 371 | |
| 372 | cleanup: |
| 373 | dri2_display_destroy(disp); |
| 374 | return _eglError(EGL_NOT_INITIALIZED, err); |
| 375 | } |