ce9f7d0f980ce279a60d88611b5c8a101ceaa0ad
[mesa.git] / 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 if (!dri2_create_drawable(dri2_dpy, config, dri2_surf))
140 goto cleanup_surface;
141
142 if (conf->RedSize == 5)
143 dri2_surf->visual = __DRI_IMAGE_FORMAT_RGB565;
144 else if (conf->AlphaSize == 0)
145 dri2_surf->visual = __DRI_IMAGE_FORMAT_XRGB8888;
146 else
147 dri2_surf->visual = __DRI_IMAGE_FORMAT_ARGB8888;
148
149 return &dri2_surf->base;
150
151 cleanup_surface:
152 free(dri2_surf);
153 return NULL;
154 }
155
156 static EGLBoolean
157 surfaceless_destroy_surface(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf)
158 {
159 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
160 struct dri2_egl_surface *dri2_surf = dri2_egl_surface(surf);
161
162 surfaceless_free_images(dri2_surf);
163
164 dri2_dpy->core->destroyDrawable(dri2_surf->dri_drawable);
165
166 dri2_fini_surface(surf);
167 free(dri2_surf);
168 return EGL_TRUE;
169 }
170
171 static _EGLSurface *
172 dri2_surfaceless_create_pbuffer_surface(_EGLDriver *drv, _EGLDisplay *disp,
173 _EGLConfig *conf, const EGLint *attrib_list)
174 {
175 return dri2_surfaceless_create_surface(drv, disp, EGL_PBUFFER_BIT, conf,
176 attrib_list);
177 }
178
179 static EGLBoolean
180 surfaceless_add_configs_for_visuals(_EGLDriver *drv, _EGLDisplay *disp)
181 {
182 struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
183 static const struct {
184 const char *format_name;
185 unsigned int rgba_masks[4];
186 } visuals[] = {
187 { "ARGB8888", { 0xff0000, 0xff00, 0xff, 0xff000000 } },
188 { "RGB888", { 0xff0000, 0xff00, 0xff, 0x0 } },
189 { "RGB565", { 0x00f800, 0x07e0, 0x1f, 0x0 } },
190 };
191 unsigned int format_count[ARRAY_SIZE(visuals)] = { 0 };
192 unsigned int config_count = 0;
193
194 for (unsigned i = 0; dri2_dpy->driver_configs[i] != NULL; i++) {
195 for (unsigned j = 0; j < ARRAY_SIZE(visuals); j++) {
196 struct dri2_egl_config *dri2_conf;
197
198 dri2_conf = dri2_add_config(disp, dri2_dpy->driver_configs[i],
199 config_count + 1, EGL_PBUFFER_BIT, NULL,
200 visuals[j].rgba_masks);
201
202 if (dri2_conf) {
203 if (dri2_conf->base.ConfigID == config_count + 1)
204 config_count++;
205 format_count[j]++;
206 }
207 }
208 }
209
210 for (unsigned i = 0; i < ARRAY_SIZE(format_count); i++) {
211 if (!format_count[i]) {
212 _eglLog(_EGL_DEBUG, "No DRI config supports native format %s",
213 visuals[i].format_name);
214 }
215 }
216
217 return (config_count != 0);
218 }
219
220 static const struct dri2_egl_display_vtbl dri2_surfaceless_display_vtbl = {
221 .create_pixmap_surface = dri2_fallback_create_pixmap_surface,
222 .create_pbuffer_surface = dri2_surfaceless_create_pbuffer_surface,
223 .destroy_surface = surfaceless_destroy_surface,
224 .create_image = dri2_create_image_khr,
225 .swap_buffers_region = dri2_fallback_swap_buffers_region,
226 .set_damage_region = dri2_fallback_set_damage_region,
227 .post_sub_buffer = dri2_fallback_post_sub_buffer,
228 .copy_buffers = dri2_fallback_copy_buffers,
229 .query_buffer_age = dri2_fallback_query_buffer_age,
230 .create_wayland_buffer_from_image = dri2_fallback_create_wayland_buffer_from_image,
231 .get_sync_values = dri2_fallback_get_sync_values,
232 .get_dri_drawable = dri2_surface_get_dri_drawable,
233 };
234
235 static void
236 surfaceless_flush_front_buffer(__DRIdrawable *driDrawable, void *loaderPrivate)
237 {
238 }
239
240 static const __DRIimageLoaderExtension image_loader_extension = {
241 .base = { __DRI_IMAGE_LOADER, 1 },
242 .getBuffers = surfaceless_image_get_buffers,
243 .flushFrontBuffer = surfaceless_flush_front_buffer,
244 };
245
246 static const __DRIswrastLoaderExtension swrast_loader_extension = {
247 .base = { __DRI_SWRAST_LOADER, 1 },
248 .getDrawableInfo = NULL,
249 .putImage = NULL,
250 .getImage = NULL,
251 };
252
253 static const __DRIextension *image_loader_extensions[] = {
254 &image_loader_extension.base,
255 &image_lookup_extension.base,
256 &use_invalidate.base,
257 NULL,
258 };
259
260 static const __DRIextension *swrast_loader_extensions[] = {
261 &swrast_loader_extension.base,
262 &image_loader_extension.base,
263 &image_lookup_extension.base,
264 &use_invalidate.base,
265 NULL,
266 };
267
268 static bool
269 surfaceless_probe_device(_EGLDisplay *disp, bool swrast)
270 {
271 #define MAX_DRM_DEVICES 64
272 const unsigned node_type = swrast ? DRM_NODE_PRIMARY : DRM_NODE_RENDER;
273 struct dri2_egl_display *dri2_dpy = disp->DriverData;
274 drmDevicePtr device, devices[MAX_DRM_DEVICES] = { NULL };
275 int i, num_devices;
276
277 num_devices = drmGetDevices2(0, devices, ARRAY_SIZE(devices));
278 if (num_devices < 0)
279 return false;
280
281 for (i = 0; i < num_devices; ++i) {
282 device = devices[i];
283
284 if (!(device->available_nodes & (1 << node_type)))
285 continue;
286
287 dri2_dpy->fd = loader_open_device(device->nodes[node_type]);
288 if (dri2_dpy->fd < 0)
289 continue;
290
291 disp->Device = _eglAddDevice(dri2_dpy->fd, swrast);
292 if (!disp->Device) {
293 close(dri2_dpy->fd);
294 dri2_dpy->fd = -1;
295 continue;
296 }
297
298 char *driver_name = loader_get_driver_for_fd(dri2_dpy->fd);
299 if (swrast) {
300 /* Use kms swrast only with vgem / virtio_gpu.
301 * virtio-gpu fallbacks to software rendering when 3D features
302 * are unavailable since 6c5ab, and kms_swrast is more
303 * feature complete than swrast.
304 */
305 if (strcmp(driver_name, "vgem") == 0 ||
306 strcmp(driver_name, "virtio_gpu") == 0)
307 dri2_dpy->driver_name = strdup("kms_swrast");
308 free(driver_name);
309 } else {
310 /* Use the given hardware driver */
311 dri2_dpy->driver_name = driver_name;
312 }
313
314 if (dri2_dpy->driver_name && dri2_load_driver_dri3(disp))
315 break;
316
317 free(dri2_dpy->driver_name);
318 dri2_dpy->driver_name = NULL;
319 close(dri2_dpy->fd);
320 dri2_dpy->fd = -1;
321 }
322 drmFreeDevices(devices, num_devices);
323
324 if (i == num_devices)
325 return false;
326
327 if (swrast)
328 dri2_dpy->loader_extensions = swrast_loader_extensions;
329 else
330 dri2_dpy->loader_extensions = image_loader_extensions;
331
332 return true;
333 }
334
335 static bool
336 surfaceless_probe_device_sw(_EGLDisplay *disp)
337 {
338 struct dri2_egl_display *dri2_dpy = disp->DriverData;
339
340 dri2_dpy->fd = -1;
341 disp->Device = _eglAddDevice(dri2_dpy->fd, true);
342 assert(disp->Device);
343
344 dri2_dpy->driver_name = strdup("swrast");
345 if (!dri2_dpy->driver_name)
346 return false;
347
348 if (!dri2_load_driver_swrast(disp)) {
349 free(dri2_dpy->driver_name);
350 dri2_dpy->driver_name = NULL;
351 return false;
352 }
353
354 dri2_dpy->loader_extensions = swrast_loader_extensions;
355 return true;
356 }
357
358 EGLBoolean
359 dri2_initialize_surfaceless(_EGLDriver *drv, _EGLDisplay *disp)
360 {
361 struct dri2_egl_display *dri2_dpy;
362 const char* err;
363 bool driver_loaded = false;
364
365 dri2_dpy = calloc(1, sizeof *dri2_dpy);
366 if (!dri2_dpy)
367 return _eglError(EGL_BAD_ALLOC, "eglInitialize");
368
369 dri2_dpy->fd = -1;
370 disp->DriverData = (void *) dri2_dpy;
371
372 if (!disp->Options.ForceSoftware) {
373 driver_loaded = surfaceless_probe_device(disp, false);
374 if (!driver_loaded)
375 _eglLog(_EGL_WARNING,
376 "No hardware driver found, falling back to software rendering");
377 }
378
379 if (!driver_loaded)
380 driver_loaded = surfaceless_probe_device(disp, true);
381
382 if (!driver_loaded) {
383 _eglLog(_EGL_DEBUG, "Falling back to surfaceless swrast without DRM.");
384 if (!surfaceless_probe_device_sw(disp)) {
385 err = "DRI2: failed to load driver";
386 goto cleanup;
387 }
388 }
389
390 if (!dri2_create_screen(disp)) {
391 err = "DRI2: failed to create screen";
392 goto cleanup;
393 }
394
395 if (!dri2_setup_extensions(disp)) {
396 err = "DRI2: failed to find required DRI extensions";
397 goto cleanup;
398 }
399
400 dri2_setup_screen(disp);
401
402 if (!surfaceless_add_configs_for_visuals(drv, disp)) {
403 err = "DRI2: failed to add configs";
404 goto cleanup;
405 }
406
407 /* Fill vtbl last to prevent accidentally calling virtual function during
408 * initialization.
409 */
410 dri2_dpy->vtbl = &dri2_surfaceless_display_vtbl;
411
412 return EGL_TRUE;
413
414 cleanup:
415 dri2_display_destroy(disp);
416 return _eglError(EGL_NOT_INITIALIZED, err);
417 }