1 /**************************************************************************
3 * Copyright 2008 VMware, Inc.
4 * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
5 * Copyright 2010-2011 LunarG, Inc.
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sub license, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
16 * The above copyright notice and this permission notice (including the
17 * next paragraph) shall be included in all copies or substantial portions
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
25 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26 * DEALINGS IN THE SOFTWARE.
28 **************************************************************************/
32 * Functions related to EGLDisplay.
38 #include "c11/threads.h"
40 #include "eglcontext.h"
41 #include "eglcurrent.h"
42 #include "eglsurface.h"
43 #include "egldisplay.h"
44 #include "egldriver.h"
45 #include "eglglobals.h"
50 /* Includes for _eglNativePlatformDetectNativeDisplay */
55 #ifdef HAVE_WAYLAND_PLATFORM
56 #include <wayland-client.h>
58 #ifdef HAVE_DRM_PLATFORM
64 * Map --with-platforms names to platform types.
67 _EGLPlatformType platform
;
69 } egl_platforms
[_EGL_NUM_PLATFORMS
] = {
70 { _EGL_PLATFORM_X11
, "x11" },
71 { _EGL_PLATFORM_WAYLAND
, "wayland" },
72 { _EGL_PLATFORM_DRM
, "drm" },
73 { _EGL_PLATFORM_ANDROID
, "android" },
74 { _EGL_PLATFORM_HAIKU
, "haiku" },
75 { _EGL_PLATFORM_SURFACELESS
, "surfaceless" },
80 * Return the native platform by parsing EGL_PLATFORM.
82 static _EGLPlatformType
83 _eglGetNativePlatformFromEnv(void)
85 _EGLPlatformType plat
= _EGL_INVALID_PLATFORM
;
86 const char *plat_name
;
89 plat_name
= getenv("EGL_PLATFORM");
90 /* try deprecated env variable */
91 if (!plat_name
|| !plat_name
[0])
92 plat_name
= getenv("EGL_DISPLAY");
93 if (!plat_name
|| !plat_name
[0])
94 return _EGL_INVALID_PLATFORM
;
96 for (i
= 0; i
< _EGL_NUM_PLATFORMS
; i
++) {
97 if (strcmp(egl_platforms
[i
].name
, plat_name
) == 0) {
98 plat
= egl_platforms
[i
].platform
;
108 * Perform validity checks on a generic pointer.
111 _eglPointerIsDereferencable(void *p
)
114 uintptr_t addr
= (uintptr_t) p
;
115 unsigned char valid
= 0;
116 const long page_size
= getpagesize();
121 /* align addr to page_size */
122 addr
&= ~(page_size
- 1);
124 if (mincore((void *) addr
, page_size
, &valid
) < 0) {
125 _eglLog(_EGL_DEBUG
, "mincore failed: %m");
129 return (valid
& 0x01) == 0x01;
137 * Try detecting native platform with the help of native display characteristcs.
139 static _EGLPlatformType
140 _eglNativePlatformDetectNativeDisplay(void *nativeDisplay
)
142 if (nativeDisplay
== EGL_DEFAULT_DISPLAY
)
143 return _EGL_INVALID_PLATFORM
;
145 if (_eglPointerIsDereferencable(nativeDisplay
)) {
146 void *first_pointer
= *(void **) nativeDisplay
;
148 (void) first_pointer
; /* silence unused var warning */
150 #ifdef HAVE_WAYLAND_PLATFORM
151 /* wl_display is a wl_proxy, which is a wl_object.
152 * wl_object's first element points to the interfacetype. */
153 if (first_pointer
== &wl_display_interface
)
154 return _EGL_PLATFORM_WAYLAND
;
157 #ifdef HAVE_DRM_PLATFORM
158 /* gbm has a pointer to its constructor as first element. */
159 if (first_pointer
== gbm_create_device
)
160 return _EGL_PLATFORM_DRM
;
163 #ifdef HAVE_X11_PLATFORM
164 /* If not matched to any other platform, fallback to x11. */
165 return _EGL_PLATFORM_X11
;
168 #ifdef HAVE_HAIKU_PLATFORM
169 return _EGL_PLATFORM_HAIKU
;
173 return _EGL_INVALID_PLATFORM
;
178 * Return the native platform. It is the platform of the EGL native types.
181 _eglGetNativePlatform(void *nativeDisplay
)
183 static _EGLPlatformType native_platform
= _EGL_INVALID_PLATFORM
;
185 if (native_platform
== _EGL_INVALID_PLATFORM
) {
186 const char *detection_method
;
188 native_platform
= _eglGetNativePlatformFromEnv();
189 detection_method
= "environment overwrite";
191 if (native_platform
== _EGL_INVALID_PLATFORM
) {
192 native_platform
= _eglNativePlatformDetectNativeDisplay(nativeDisplay
);
193 detection_method
= "autodetected";
196 if (native_platform
== _EGL_INVALID_PLATFORM
) {
197 native_platform
= _EGL_NATIVE_PLATFORM
;
198 detection_method
= "build-time configuration";
201 _eglLog(_EGL_DEBUG
, "Native platform type: %s (%s)",
202 egl_platforms
[native_platform
].name
, detection_method
);
205 return native_platform
;
210 * Finish display management.
213 _eglFiniDisplay(void)
215 _EGLDisplay
*dpyList
, *dpy
;
217 /* atexit function is called with global mutex locked */
218 dpyList
= _eglGlobal
.DisplayList
;
224 dpyList
= dpyList
->Next
;
226 for (i
= 0; i
< _EGL_NUM_RESOURCES
; i
++) {
227 if (dpy
->ResourceLists
[i
]) {
228 _eglLog(_EGL_DEBUG
, "Display %p is destroyed with resources", dpy
);
235 _eglGlobal
.DisplayList
= NULL
;
240 * Find the display corresponding to the specified native display, or create a
244 _eglFindDisplay(_EGLPlatformType plat
, void *plat_dpy
)
248 if (plat
== _EGL_INVALID_PLATFORM
)
251 mtx_lock(_eglGlobal
.Mutex
);
253 /* search the display list first */
254 dpy
= _eglGlobal
.DisplayList
;
256 if (dpy
->Platform
== plat
&& dpy
->PlatformDisplay
== plat_dpy
)
261 /* create a new display */
263 dpy
= calloc(1, sizeof(_EGLDisplay
));
265 mtx_init(&dpy
->Mutex
, mtx_plain
);
266 dpy
->Platform
= plat
;
267 dpy
->PlatformDisplay
= plat_dpy
;
269 /* add to the display list */
270 dpy
->Next
= _eglGlobal
.DisplayList
;
271 _eglGlobal
.DisplayList
= dpy
;
275 mtx_unlock(_eglGlobal
.Mutex
);
282 * Destroy the contexts and surfaces that are linked to the display.
285 _eglReleaseDisplayResources(_EGLDriver
*drv
, _EGLDisplay
*display
)
289 list
= display
->ResourceLists
[_EGL_RESOURCE_CONTEXT
];
291 _EGLContext
*ctx
= (_EGLContext
*) list
;
294 _eglUnlinkContext(ctx
);
295 drv
->API
.DestroyContext(drv
, display
, ctx
);
297 assert(!display
->ResourceLists
[_EGL_RESOURCE_CONTEXT
]);
299 list
= display
->ResourceLists
[_EGL_RESOURCE_SURFACE
];
301 _EGLSurface
*surf
= (_EGLSurface
*) list
;
304 _eglUnlinkSurface(surf
);
305 drv
->API
.DestroySurface(drv
, display
, surf
);
307 assert(!display
->ResourceLists
[_EGL_RESOURCE_SURFACE
]);
309 list
= display
->ResourceLists
[_EGL_RESOURCE_IMAGE
];
311 _EGLImage
*image
= (_EGLImage
*) list
;
314 _eglUnlinkImage(image
);
315 drv
->API
.DestroyImageKHR(drv
, display
, image
);
317 assert(!display
->ResourceLists
[_EGL_RESOURCE_IMAGE
]);
319 list
= display
->ResourceLists
[_EGL_RESOURCE_SYNC
];
321 _EGLSync
*sync
= (_EGLSync
*) list
;
324 _eglUnlinkSync(sync
);
325 drv
->API
.DestroySyncKHR(drv
, display
, sync
);
327 assert(!display
->ResourceLists
[_EGL_RESOURCE_SYNC
]);
332 * Free all the data hanging of an _EGLDisplay object, but not
336 _eglCleanupDisplay(_EGLDisplay
*disp
)
339 _eglDestroyArray(disp
->Configs
, free
);
340 disp
->Configs
= NULL
;
348 * Return EGL_TRUE if the given handle is a valid handle to a display.
351 _eglCheckDisplayHandle(EGLDisplay dpy
)
355 mtx_lock(_eglGlobal
.Mutex
);
356 cur
= _eglGlobal
.DisplayList
;
358 if (cur
== (_EGLDisplay
*) dpy
)
362 mtx_unlock(_eglGlobal
.Mutex
);
363 return (cur
!= NULL
);
368 * Return EGL_TRUE if the given resource is valid. That is, the display does
372 _eglCheckResource(void *res
, _EGLResourceType type
, _EGLDisplay
*dpy
)
374 _EGLResource
*list
= dpy
->ResourceLists
[type
];
380 if (res
== (void *) list
) {
381 assert(list
->Display
== dpy
);
387 return (list
!= NULL
);
392 * Initialize a display resource. The size of the subclass object is
395 * This is supposed to be called from the initializers of subclasses, such as
396 * _eglInitContext or _eglInitSurface.
399 _eglInitResource(_EGLResource
*res
, EGLint size
, _EGLDisplay
*dpy
)
401 memset(res
, 0, size
);
408 * Increment reference count for the resource.
411 _eglGetResource(_EGLResource
*res
)
413 assert(res
&& res
->RefCount
> 0);
414 /* hopefully a resource is always manipulated with its display locked */
420 * Decrement reference count for the resource.
423 _eglPutResource(_EGLResource
*res
)
425 assert(res
&& res
->RefCount
> 0);
427 return (!res
->RefCount
);
432 * Link a resource to its display.
435 _eglLinkResource(_EGLResource
*res
, _EGLResourceType type
)
437 assert(res
->Display
);
439 res
->IsLinked
= EGL_TRUE
;
440 res
->Next
= res
->Display
->ResourceLists
[type
];
441 res
->Display
->ResourceLists
[type
] = res
;
442 _eglGetResource(res
);
447 * Unlink a linked resource from its display.
450 _eglUnlinkResource(_EGLResource
*res
, _EGLResourceType type
)
454 prev
= res
->Display
->ResourceLists
[type
];
457 if (prev
->Next
== res
)
462 prev
->Next
= res
->Next
;
465 res
->Display
->ResourceLists
[type
] = res
->Next
;
469 res
->IsLinked
= EGL_FALSE
;
470 _eglPutResource(res
);
472 /* We always unlink before destroy. The driver still owns a reference */
473 assert(res
->RefCount
);
476 #ifdef HAVE_X11_PLATFORM
478 _eglParseX11DisplayAttribList(_EGLDisplay
*display
, const EGLint
*attrib_list
)
482 if (attrib_list
== NULL
) {
486 for (i
= 0; attrib_list
[i
] != EGL_NONE
; i
+= 2) {
487 EGLint attrib
= attrib_list
[i
];
488 EGLint value
= attrib_list
[i
+ 1];
490 /* EGL_EXT_platform_x11 recognizes exactly one attribute,
491 * EGL_PLATFORM_X11_SCREEN_EXT, which is optional.
493 if (attrib
== EGL_PLATFORM_X11_SCREEN_EXT
) {
494 display
->Options
.Platform
= (void *)(uintptr_t)value
;
496 _eglError(EGL_BAD_ATTRIBUTE
, "eglGetPlatformDisplay");
505 _eglGetX11Display(Display
*native_display
,
506 const EGLint
*attrib_list
)
508 _EGLDisplay
*display
= _eglFindDisplay(_EGL_PLATFORM_X11
,
512 _eglError(EGL_BAD_ALLOC
, "eglGetPlatformDisplay");
516 if (!_eglParseX11DisplayAttribList(display
, attrib_list
)) {
522 #endif /* HAVE_X11_PLATFORM */
524 #ifdef HAVE_DRM_PLATFORM
526 _eglGetGbmDisplay(struct gbm_device
*native_display
,
527 const EGLint
*attrib_list
)
529 /* EGL_MESA_platform_gbm recognizes no attributes. */
530 if (attrib_list
!= NULL
&& attrib_list
[0] != EGL_NONE
) {
531 _eglError(EGL_BAD_ATTRIBUTE
, "eglGetPlatformDisplay");
535 return _eglFindDisplay(_EGL_PLATFORM_DRM
, native_display
);
537 #endif /* HAVE_DRM_PLATFORM */
539 #ifdef HAVE_WAYLAND_PLATFORM
541 _eglGetWaylandDisplay(struct wl_display
*native_display
,
542 const EGLint
*attrib_list
)
544 /* EGL_EXT_platform_wayland recognizes no attributes. */
545 if (attrib_list
!= NULL
&& attrib_list
[0] != EGL_NONE
) {
546 _eglError(EGL_BAD_ATTRIBUTE
, "eglGetPlatformDisplay");
550 return _eglFindDisplay(_EGL_PLATFORM_WAYLAND
, native_display
);
552 #endif /* HAVE_WAYLAND_PLATFORM */
554 #ifdef HAVE_SURFACELESS_PLATFORM
556 _eglGetSurfacelessDisplay(void *native_display
,
557 const EGLint
*attrib_list
)
559 /* This platform has no native display. */
560 if (native_display
!= NULL
) {
561 _eglError(EGL_BAD_PARAMETER
, "eglGetPlatformDisplay");
565 /* This platform recognizes no display attributes. */
566 if (attrib_list
!= NULL
&& attrib_list
[0] != EGL_NONE
) {
567 _eglError(EGL_BAD_ATTRIBUTE
, "eglGetPlatformDisplay");
571 return _eglFindDisplay(_EGL_PLATFORM_SURFACELESS
, native_display
);
573 #endif /* HAVE_SURFACELESS_PLATFORM */