egl: Let the caller of dri2_create_drawable decide about loaderPrivate.
[mesa.git] / 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 "egl_dri2_fallbacks.h"
44 #include "loader.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
71 static int
72 device_image_get_buffers(__DRIdrawable *driDrawable,
73 unsigned int format,
74 uint32_t *stamp,
75 void *loaderPrivate,
76 uint32_t buffer_mask,
77 struct __DRIimageList *buffers)
78 {
79 struct dri2_egl_surface *dri2_surf = loaderPrivate;
80 struct dri2_egl_display *dri2_dpy =
81 dri2_egl_display(dri2_surf->base.Resource.Display);
82
83 buffers->image_mask = 0;
84 buffers->front = NULL;
85 buffers->back = NULL;
86
87 /* The EGL 1.5 spec states that pbuffers are single-buffered. Specifically,
88 * the spec states that they have a back buffer but no front buffer, in
89 * contrast to pixmaps, which have a front buffer but no back buffer.
90 *
91 * Single-buffered surfaces with no front buffer confuse Mesa; so we deviate
92 * from the spec, following the precedent of Mesa's EGL X11 platform. The
93 * X11 platform correctly assigns pbuffers to single-buffered configs, but
94 * assigns the pbuffer a front buffer instead of a back buffer.
95 *
96 * Pbuffers in the X11 platform mostly work today, so let's just copy its
97 * behavior instead of trying to fix (and hence potentially breaking) the
98 * world.
99 */
100
101 if (buffer_mask & __DRI_IMAGE_BUFFER_FRONT) {
102
103 if (!dri2_surf->front)
104 dri2_surf->front =
105 device_alloc_image(dri2_dpy, dri2_surf);
106
107 buffers->image_mask |= __DRI_IMAGE_BUFFER_FRONT;
108 buffers->front = dri2_surf->front;
109 }
110
111 return 1;
112 }
113
114 static _EGLSurface *
115 dri2_device_create_surface(_EGLDriver *drv, _EGLDisplay *disp, EGLint type,
116 _EGLConfig *conf, const EGLint *attrib_list)
117 {
118 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
119 struct dri2_egl_config *dri2_conf = dri2_egl_config(conf);
120 struct dri2_egl_surface *dri2_surf;
121 const __DRIconfig *config;
122
123 /* Make sure to calloc so all pointers
124 * are originally NULL.
125 */
126 dri2_surf = calloc(1, sizeof *dri2_surf);
127
128 if (!dri2_surf) {
129 _eglError(EGL_BAD_ALLOC, "eglCreatePbufferSurface");
130 return NULL;
131 }
132
133 if (!dri2_init_surface(&dri2_surf->base, disp, type, conf, attrib_list,
134 false, NULL))
135 goto cleanup_surface;
136
137 config = dri2_get_dri_config(dri2_conf, type,
138 dri2_surf->base.GLColorspace);
139
140 if (!config) {
141 _eglError(EGL_BAD_MATCH, "Unsupported surfacetype/colorspace configuration");
142 goto cleanup_surface;
143 }
144
145 if (!dri2_create_drawable(dri2_dpy, config, dri2_surf, dri2_surf))
146 goto cleanup_surface;
147
148 if (conf->RedSize == 5)
149 dri2_surf->visual = __DRI_IMAGE_FORMAT_RGB565;
150 else if (conf->AlphaSize == 0)
151 dri2_surf->visual = __DRI_IMAGE_FORMAT_XRGB8888;
152 else
153 dri2_surf->visual = __DRI_IMAGE_FORMAT_ARGB8888;
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(_EGLDriver *drv, _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(_EGLDriver *drv, _EGLDisplay *disp,
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
185 static EGLBoolean
186 device_add_configs_for_visuals(_EGLDriver *drv, _EGLDisplay *disp)
187 {
188 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
189 static const struct {
190 const char *format_name;
191 unsigned int rgba_masks[4];
192 } visuals[] = {
193 { "ARGB8888", { 0xff0000, 0xff00, 0xff, 0xff000000 } },
194 { "RGB888", { 0xff0000, 0xff00, 0xff, 0x0 } },
195 { "RGB565", { 0x00f800, 0x07e0, 0x1f, 0x0 } },
196 };
197 unsigned int format_count[ARRAY_SIZE(visuals)] = { 0 };
198 unsigned int config_count = 0;
199
200 for (unsigned i = 0; dri2_dpy->driver_configs[i] != NULL; i++) {
201 for (unsigned j = 0; j < ARRAY_SIZE(visuals); j++) {
202 struct dri2_egl_config *dri2_conf;
203
204 dri2_conf = dri2_add_config(disp, dri2_dpy->driver_configs[i],
205 config_count + 1, EGL_PBUFFER_BIT, NULL,
206 visuals[j].rgba_masks);
207
208 if (dri2_conf) {
209 if (dri2_conf->base.ConfigID == config_count + 1)
210 config_count++;
211 format_count[j]++;
212 }
213 }
214 }
215
216 for (unsigned i = 0; i < ARRAY_SIZE(format_count); i++) {
217 if (!format_count[i]) {
218 _eglLog(_EGL_DEBUG, "No DRI config supports native format %s",
219 visuals[i].format_name);
220 }
221 }
222
223 return (config_count != 0);
224 }
225
226 static const struct dri2_egl_display_vtbl dri2_device_display_vtbl = {
227 .create_pixmap_surface = dri2_fallback_create_pixmap_surface,
228 .create_pbuffer_surface = dri2_device_create_pbuffer_surface,
229 .destroy_surface = device_destroy_surface,
230 .create_image = dri2_create_image_khr,
231 .swap_buffers_region = dri2_fallback_swap_buffers_region,
232 .set_damage_region = dri2_fallback_set_damage_region,
233 .post_sub_buffer = dri2_fallback_post_sub_buffer,
234 .copy_buffers = dri2_fallback_copy_buffers,
235 .query_buffer_age = dri2_fallback_query_buffer_age,
236 .create_wayland_buffer_from_image = dri2_fallback_create_wayland_buffer_from_image,
237 .get_sync_values = dri2_fallback_get_sync_values,
238 .get_dri_drawable = dri2_surface_get_dri_drawable,
239 };
240
241 static void
242 device_flush_front_buffer(__DRIdrawable *driDrawable, void *loaderPrivate)
243 {
244 }
245
246 static const __DRIimageLoaderExtension image_loader_extension = {
247 .base = { __DRI_IMAGE_LOADER, 1 },
248 .getBuffers = device_image_get_buffers,
249 .flushFrontBuffer = device_flush_front_buffer,
250 };
251
252 static void
253 device_get_drawable_info(__DRIdrawable * draw,
254 int *x, int *y, int *w, int *h,
255 void *loaderPrivate)
256 {
257 struct dri2_egl_surface *dri2_surf = loaderPrivate;
258
259 *x = *y = 0;
260 *w = dri2_surf->base.Width;
261 *h = dri2_surf->base.Height;
262 }
263
264 /* HACK: technically we should have swrast_null, instead of these. We
265 * get away since only pbuffers are supported, thus the callbacks are
266 * unused.
267 */
268 static const __DRIswrastLoaderExtension swrast_loader_extension = {
269 .base = { __DRI_SWRAST_LOADER, 1 },
270 .getDrawableInfo = device_get_drawable_info,
271 .putImage = NULL,
272 .getImage = NULL,
273 };
274
275 static const __DRIextension *image_loader_extensions[] = {
276 &image_loader_extension.base,
277 &image_lookup_extension.base,
278 &use_invalidate.base,
279 NULL,
280 };
281
282 /* HACK: second part of the hack above. */
283 static const __DRIextension *swrast_loader_extensions[] = {
284 &swrast_loader_extension.base,
285 &image_lookup_extension.base,
286 &use_invalidate.base,
287 NULL,
288 };
289
290 static int
291 device_get_fd(_EGLDisplay *disp, _EGLDevice *dev)
292 {
293 #ifdef HAVE_LIBDRM
294 int fd = disp->Options.fd;
295 /* The fcntl() code in _eglGetDeviceDisplay() ensures that valid fd >= 3,
296 * and invalid one is 0.
297 */
298 if (fd) {
299 /* According to the spec - if the FD does not match the EGLDevice
300 * behaviour is undefined.
301 *
302 * Add a trivial sanity check since it doesn't cost us anything.
303 */
304 if (dev != _eglAddDevice(fd, false))
305 return -1;
306
307 /* No EGL_EXT_output* extensions are supported, hence no master perms
308 * are needed. Get the render one - otherwise drivers might error out.
309 */
310 char *node = drmGetRenderDeviceNameFromFd(fd);
311
312 /* Don't close the internal fd, get render node one based on it. */
313 fd = loader_open_device(node);
314 free(node);
315 return fd;
316 }
317 const char *node = _eglGetDRMDeviceRenderNode(dev);
318 return loader_open_device(node);
319 #else
320 _eglLog(_EGL_FATAL, "Driver bug: Built without libdrm, yet using a HW device");
321 return -1;
322 #endif
323 }
324
325 static bool
326 device_probe_device(_EGLDisplay *disp)
327 {
328 struct dri2_egl_display *dri2_dpy = disp->DriverData;
329
330 if (disp->Options.ForceSoftware)
331 _eglLog(_EGL_WARNING, "Not allowed to force software rendering when "
332 "API explicitly selects a hardware device.");
333 dri2_dpy->fd = device_get_fd(disp, disp->Device);
334 if (dri2_dpy->fd < 0)
335 return false;
336
337 dri2_dpy->driver_name = loader_get_driver_for_fd(dri2_dpy->fd);
338 if (!dri2_dpy->driver_name)
339 goto err_name;
340
341 if (!dri2_load_driver_dri3(disp))
342 goto err_load;
343
344 dri2_dpy->loader_extensions = image_loader_extensions;
345 return true;
346
347 err_load:
348 free(dri2_dpy->driver_name);
349 dri2_dpy->driver_name = NULL;
350
351 err_name:
352 close(dri2_dpy->fd);
353 dri2_dpy->fd = -1;
354 return false;
355
356 }
357
358 static bool
359 device_probe_device_sw(_EGLDisplay *disp)
360 {
361 struct dri2_egl_display *dri2_dpy = disp->DriverData;
362
363 dri2_dpy->fd = -1;
364 dri2_dpy->driver_name = strdup("swrast");
365 if (!dri2_dpy->driver_name)
366 return false;
367
368 /* HACK: should be driver_swrast_null */
369 if (!dri2_load_driver_swrast(disp)) {
370 free(dri2_dpy->driver_name);
371 dri2_dpy->driver_name = NULL;
372 return false;
373 }
374
375 dri2_dpy->loader_extensions = swrast_loader_extensions;
376 return true;
377 }
378
379 EGLBoolean
380 dri2_initialize_device(_EGLDriver *drv, _EGLDisplay *disp)
381 {
382 _EGLDevice *dev;
383 struct dri2_egl_display *dri2_dpy;
384 const char* err;
385
386 dri2_dpy = calloc(1, sizeof *dri2_dpy);
387 if (!dri2_dpy)
388 return _eglError(EGL_BAD_ALLOC, "eglInitialize");
389
390 /* Extension requires a PlatformDisplay - the EGLDevice. */
391 dev = disp->PlatformDisplay;
392
393 dri2_dpy->fd = -1;
394 disp->Device = dev;
395 disp->DriverData = (void *) dri2_dpy;
396 err = "DRI2: failed to load driver";
397 if (_eglDeviceSupports(dev, _EGL_DEVICE_DRM)) {
398 if (!device_probe_device(disp))
399 goto cleanup;
400 } else if (_eglDeviceSupports(dev, _EGL_DEVICE_SOFTWARE)) {
401 if (!device_probe_device_sw(disp))
402 goto cleanup;
403 } else {
404 _eglLog(_EGL_FATAL, "Driver bug: exposed device is neither DRM nor SOFTWARE one");
405 return EGL_FALSE;
406 }
407
408 if (!dri2_create_screen(disp)) {
409 err = "DRI2: failed to create screen";
410 goto cleanup;
411 }
412
413 if (!dri2_setup_extensions(disp)) {
414 err = "DRI2: failed to find required DRI extensions";
415 goto cleanup;
416 }
417
418 dri2_setup_screen(disp);
419
420 if (!device_add_configs_for_visuals(drv, disp)) {
421 err = "DRI2: failed to add configs";
422 goto cleanup;
423 }
424
425 /* Fill vtbl last to prevent accidentally calling virtual function during
426 * initialization.
427 */
428 dri2_dpy->vtbl = &dri2_device_display_vtbl;
429
430 return EGL_TRUE;
431
432 cleanup:
433 dri2_display_destroy(disp);
434 return _eglError(EGL_NOT_INITIALIZED, err);
435 }