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.
40 #include "c11/threads.h"
41 #include "util/macros.h"
42 #include "util/u_atomic.h"
44 #include "eglcontext.h"
45 #include "eglcurrent.h"
46 #include "eglsurface.h"
47 #include "egldevice.h"
48 #include "egldisplay.h"
49 #include "egldriver.h"
50 #include "eglglobals.h"
55 /* Includes for _eglNativePlatformDetectNativeDisplay */
56 #ifdef HAVE_WAYLAND_PLATFORM
57 #include <wayland-client.h>
59 #ifdef HAVE_DRM_PLATFORM
65 * Map build-system platform names to platform types.
68 _EGLPlatformType platform
;
71 { _EGL_PLATFORM_X11
, "x11" },
72 { _EGL_PLATFORM_WAYLAND
, "wayland" },
73 { _EGL_PLATFORM_DRM
, "drm" },
74 { _EGL_PLATFORM_ANDROID
, "android" },
75 { _EGL_PLATFORM_HAIKU
, "haiku" },
76 { _EGL_PLATFORM_SURFACELESS
, "surfaceless" },
77 { _EGL_PLATFORM_DEVICE
, "device" },
82 * Return the native platform by parsing EGL_PLATFORM.
84 static _EGLPlatformType
85 _eglGetNativePlatformFromEnv(void)
87 _EGLPlatformType plat
= _EGL_INVALID_PLATFORM
;
88 const char *plat_name
;
91 static_assert(ARRAY_SIZE(egl_platforms
) == _EGL_NUM_PLATFORMS
,
94 plat_name
= getenv("EGL_PLATFORM");
95 /* try deprecated env variable */
96 if (!plat_name
|| !plat_name
[0])
97 plat_name
= getenv("EGL_DISPLAY");
98 if (!plat_name
|| !plat_name
[0])
99 return _EGL_INVALID_PLATFORM
;
101 for (i
= 0; i
< ARRAY_SIZE(egl_platforms
); i
++) {
102 if (strcmp(egl_platforms
[i
].name
, plat_name
) == 0) {
103 plat
= egl_platforms
[i
].platform
;
108 if (plat
== _EGL_INVALID_PLATFORM
)
109 _eglLog(_EGL_WARNING
, "invalid EGL_PLATFORM given");
116 * Try detecting native platform with the help of native display characteristcs.
118 static _EGLPlatformType
119 _eglNativePlatformDetectNativeDisplay(void *nativeDisplay
)
121 if (nativeDisplay
== EGL_DEFAULT_DISPLAY
)
122 return _EGL_INVALID_PLATFORM
;
124 if (_eglPointerIsDereferencable(nativeDisplay
)) {
125 void *first_pointer
= *(void **) nativeDisplay
;
127 (void) first_pointer
; /* silence unused var warning */
129 #ifdef HAVE_WAYLAND_PLATFORM
130 /* wl_display is a wl_proxy, which is a wl_object.
131 * wl_object's first element points to the interfacetype. */
132 if (first_pointer
== &wl_display_interface
)
133 return _EGL_PLATFORM_WAYLAND
;
136 #ifdef HAVE_DRM_PLATFORM
137 /* gbm has a pointer to its constructor as first element. */
138 if (first_pointer
== gbm_create_device
)
139 return _EGL_PLATFORM_DRM
;
143 return _EGL_INVALID_PLATFORM
;
148 * Return the native platform. It is the platform of the EGL native types.
151 _eglGetNativePlatform(void *nativeDisplay
)
153 _EGLPlatformType detected_platform
= _eglGetNativePlatformFromEnv();
154 const char *detection_method
= "environment";
156 if (detected_platform
== _EGL_INVALID_PLATFORM
) {
157 detected_platform
= _eglNativePlatformDetectNativeDisplay(nativeDisplay
);
158 detection_method
= "autodetected";
161 if (detected_platform
== _EGL_INVALID_PLATFORM
) {
162 detected_platform
= _EGL_NATIVE_PLATFORM
;
163 detection_method
= "build-time configuration";
166 _eglLog(_EGL_DEBUG
, "Native platform type: %s (%s)",
167 egl_platforms
[detected_platform
].name
, detection_method
);
169 return detected_platform
;
174 * Finish display management.
177 _eglFiniDisplay(void)
179 _EGLDisplay
*dispList
, *disp
;
181 /* atexit function is called with global mutex locked */
182 dispList
= _eglGlobal
.DisplayList
;
188 dispList
= dispList
->Next
;
190 for (i
= 0; i
< _EGL_NUM_RESOURCES
; i
++) {
191 if (disp
->ResourceLists
[i
]) {
192 _eglLog(_EGL_DEBUG
, "Display %p is destroyed with resources", disp
);
198 /* The fcntl() code in _eglGetDeviceDisplay() ensures that valid fd >= 3,
199 * and invalid one is 0.
201 if (disp
->Options
.fd
)
202 close(disp
->Options
.fd
);
204 free(disp
->Options
.Attribs
);
207 _eglGlobal
.DisplayList
= NULL
;
211 _eglSameAttribs(const EGLAttrib
*a
, const EGLAttrib
*b
)
213 size_t na
= _eglNumAttribs(a
);
214 size_t nb
= _eglNumAttribs(b
);
216 /* different numbers of attributes must be different */
220 /* both lists NULL are the same */
224 /* otherwise, compare the lists */
225 return memcmp(a
, b
, na
* sizeof(a
[0])) == 0 ? EGL_TRUE
: EGL_FALSE
;
229 * Find the display corresponding to the specified native display, or create a
230 * new one. EGL 1.5 says:
232 * Multiple calls made to eglGetPlatformDisplay with the same parameters
233 * will return the same EGLDisplay handle.
235 * We read this extremely strictly, and treat a call with NULL attribs as
236 * different from a call with attribs only equal to { EGL_NONE }. Similarly
237 * we do not sort the attribute list, so even if all attribute _values_ are
238 * identical, different attribute orders will be considered different
242 _eglFindDisplay(_EGLPlatformType plat
, void *plat_dpy
,
243 const EGLAttrib
*attrib_list
)
248 if (plat
== _EGL_INVALID_PLATFORM
)
251 mtx_lock(_eglGlobal
.Mutex
);
253 /* search the display list first */
254 for (disp
= _eglGlobal
.DisplayList
; disp
; disp
= disp
->Next
) {
255 if (disp
->Platform
== plat
&& disp
->PlatformDisplay
== plat_dpy
&&
256 _eglSameAttribs(disp
->Options
.Attribs
, attrib_list
))
260 /* create a new display */
262 disp
= calloc(1, sizeof(_EGLDisplay
));
264 mtx_init(&disp
->Mutex
, mtx_plain
);
265 disp
->Platform
= plat
;
266 disp
->PlatformDisplay
= plat_dpy
;
267 num_attribs
= _eglNumAttribs(attrib_list
);
269 disp
->Options
.Attribs
= calloc(num_attribs
, sizeof(EGLAttrib
));
270 if (!disp
->Options
.Attribs
) {
275 memcpy(disp
->Options
.Attribs
, attrib_list
,
276 num_attribs
* sizeof(EGLAttrib
));
278 /* add to the display list */
279 disp
->Next
= _eglGlobal
.DisplayList
;
280 _eglGlobal
.DisplayList
= disp
;
285 mtx_unlock(_eglGlobal
.Mutex
);
292 * Destroy the contexts and surfaces that are linked to the display.
295 _eglReleaseDisplayResources(_EGLDriver
*drv
, _EGLDisplay
*display
)
299 list
= display
->ResourceLists
[_EGL_RESOURCE_CONTEXT
];
301 _EGLContext
*ctx
= (_EGLContext
*) list
;
304 _eglUnlinkContext(ctx
);
305 drv
->API
.DestroyContext(drv
, display
, ctx
);
307 assert(!display
->ResourceLists
[_EGL_RESOURCE_CONTEXT
]);
309 list
= display
->ResourceLists
[_EGL_RESOURCE_SURFACE
];
311 _EGLSurface
*surf
= (_EGLSurface
*) list
;
314 _eglUnlinkSurface(surf
);
315 drv
->API
.DestroySurface(drv
, display
, surf
);
317 assert(!display
->ResourceLists
[_EGL_RESOURCE_SURFACE
]);
319 list
= display
->ResourceLists
[_EGL_RESOURCE_IMAGE
];
321 _EGLImage
*image
= (_EGLImage
*) list
;
324 _eglUnlinkImage(image
);
325 drv
->API
.DestroyImageKHR(drv
, display
, image
);
327 assert(!display
->ResourceLists
[_EGL_RESOURCE_IMAGE
]);
329 list
= display
->ResourceLists
[_EGL_RESOURCE_SYNC
];
331 _EGLSync
*sync
= (_EGLSync
*) list
;
334 _eglUnlinkSync(sync
);
335 drv
->API
.DestroySyncKHR(drv
, display
, sync
);
337 assert(!display
->ResourceLists
[_EGL_RESOURCE_SYNC
]);
342 * Free all the data hanging of an _EGLDisplay object, but not
346 _eglCleanupDisplay(_EGLDisplay
*disp
)
349 _eglDestroyArray(disp
->Configs
, free
);
350 disp
->Configs
= NULL
;
358 * Return EGL_TRUE if the given handle is a valid handle to a display.
361 _eglCheckDisplayHandle(EGLDisplay dpy
)
365 mtx_lock(_eglGlobal
.Mutex
);
366 cur
= _eglGlobal
.DisplayList
;
368 if (cur
== (_EGLDisplay
*) dpy
)
372 mtx_unlock(_eglGlobal
.Mutex
);
373 return (cur
!= NULL
);
378 * Return EGL_TRUE if the given resource is valid. That is, the display does
382 _eglCheckResource(void *res
, _EGLResourceType type
, _EGLDisplay
*disp
)
384 _EGLResource
*list
= disp
->ResourceLists
[type
];
390 if (res
== (void *) list
) {
391 assert(list
->Display
== disp
);
397 return (list
!= NULL
);
402 * Initialize a display resource. The size of the subclass object is
405 * This is supposed to be called from the initializers of subclasses, such as
406 * _eglInitContext or _eglInitSurface.
409 _eglInitResource(_EGLResource
*res
, EGLint size
, _EGLDisplay
*disp
)
411 memset(res
, 0, size
);
418 * Increment reference count for the resource.
421 _eglGetResource(_EGLResource
*res
)
423 assert(res
&& res
->RefCount
> 0);
424 /* hopefully a resource is always manipulated with its display locked */
430 * Decrement reference count for the resource.
433 _eglPutResource(_EGLResource
*res
)
435 assert(res
&& res
->RefCount
> 0);
437 return (!res
->RefCount
);
442 * Link a resource to its display.
445 _eglLinkResource(_EGLResource
*res
, _EGLResourceType type
)
447 assert(res
->Display
);
449 res
->IsLinked
= EGL_TRUE
;
450 res
->Next
= res
->Display
->ResourceLists
[type
];
451 res
->Display
->ResourceLists
[type
] = res
;
452 _eglGetResource(res
);
457 * Unlink a linked resource from its display.
460 _eglUnlinkResource(_EGLResource
*res
, _EGLResourceType type
)
464 prev
= res
->Display
->ResourceLists
[type
];
467 if (prev
->Next
== res
)
472 prev
->Next
= res
->Next
;
475 res
->Display
->ResourceLists
[type
] = res
->Next
;
479 res
->IsLinked
= EGL_FALSE
;
480 _eglPutResource(res
);
482 /* We always unlink before destroy. The driver still owns a reference */
483 assert(res
->RefCount
);
486 #ifdef HAVE_X11_PLATFORM
488 _eglGetX11Display(Display
*native_display
,
489 const EGLAttrib
*attrib_list
)
491 /* EGL_EXT_platform_x11 recognizes exactly one attribute,
492 * EGL_PLATFORM_X11_SCREEN_EXT, which is optional.
494 if (attrib_list
!= NULL
) {
495 for (int i
= 0; attrib_list
[i
] != EGL_NONE
; i
+= 2) {
496 if (attrib_list
[i
] != EGL_PLATFORM_X11_SCREEN_EXT
) {
497 _eglError(EGL_BAD_ATTRIBUTE
, "eglGetPlatformDisplay");
502 return _eglFindDisplay(_EGL_PLATFORM_X11
, native_display
, attrib_list
);
504 #endif /* HAVE_X11_PLATFORM */
506 #ifdef HAVE_DRM_PLATFORM
508 _eglGetGbmDisplay(struct gbm_device
*native_display
,
509 const EGLAttrib
*attrib_list
)
511 /* EGL_MESA_platform_gbm recognizes no attributes. */
512 if (attrib_list
!= NULL
&& attrib_list
[0] != EGL_NONE
) {
513 _eglError(EGL_BAD_ATTRIBUTE
, "eglGetPlatformDisplay");
517 return _eglFindDisplay(_EGL_PLATFORM_DRM
, native_display
, attrib_list
);
519 #endif /* HAVE_DRM_PLATFORM */
521 #ifdef HAVE_WAYLAND_PLATFORM
523 _eglGetWaylandDisplay(struct wl_display
*native_display
,
524 const EGLAttrib
*attrib_list
)
526 /* EGL_EXT_platform_wayland recognizes no attributes. */
527 if (attrib_list
!= NULL
&& attrib_list
[0] != EGL_NONE
) {
528 _eglError(EGL_BAD_ATTRIBUTE
, "eglGetPlatformDisplay");
532 return _eglFindDisplay(_EGL_PLATFORM_WAYLAND
, native_display
, attrib_list
);
534 #endif /* HAVE_WAYLAND_PLATFORM */
536 #ifdef HAVE_SURFACELESS_PLATFORM
538 _eglGetSurfacelessDisplay(void *native_display
,
539 const EGLAttrib
*attrib_list
)
541 /* This platform has no native display. */
542 if (native_display
!= NULL
) {
543 _eglError(EGL_BAD_PARAMETER
, "eglGetPlatformDisplay");
547 /* This platform recognizes no display attributes. */
548 if (attrib_list
!= NULL
&& attrib_list
[0] != EGL_NONE
) {
549 _eglError(EGL_BAD_ATTRIBUTE
, "eglGetPlatformDisplay");
553 return _eglFindDisplay(_EGL_PLATFORM_SURFACELESS
, native_display
,
556 #endif /* HAVE_SURFACELESS_PLATFORM */
558 #ifdef HAVE_ANDROID_PLATFORM
560 _eglGetAndroidDisplay(void *native_display
,
561 const EGLAttrib
*attrib_list
)
564 /* This platform recognizes no display attributes. */
565 if (attrib_list
!= NULL
&& attrib_list
[0] != EGL_NONE
) {
566 _eglError(EGL_BAD_ATTRIBUTE
, "eglGetPlatformDisplay");
570 return _eglFindDisplay(_EGL_PLATFORM_ANDROID
, native_display
,
573 #endif /* HAVE_ANDROID_PLATFORM */
576 _eglGetDeviceDisplay(void *native_display
,
577 const EGLAttrib
*attrib_list
)
580 _EGLDisplay
*display
;
583 dev
= _eglLookupDevice(native_display
);
585 _eglError(EGL_BAD_PARAMETER
, "eglGetPlatformDisplay");
590 for (int i
= 0; attrib_list
[i
] != EGL_NONE
; i
+= 2) {
591 EGLAttrib attrib
= attrib_list
[i
];
592 EGLAttrib value
= attrib_list
[i
+ 1];
594 /* EGL_EXT_platform_device does not recognize any attributes,
595 * EGL_EXT_device_drm adds the optional EGL_DRM_MASTER_FD_EXT.
598 if (!_eglDeviceSupports(dev
, _EGL_DEVICE_DRM
) ||
599 attrib
!= EGL_DRM_MASTER_FD_EXT
) {
600 _eglError(EGL_BAD_ATTRIBUTE
, "eglGetPlatformDisplay");
608 display
= _eglFindDisplay(_EGL_PLATFORM_DEVICE
, native_display
, attrib_list
);
610 _eglError(EGL_BAD_ALLOC
, "eglGetPlatformDisplay");
614 /* If the fd is explicitly provided and we did not dup() it yet, do so.
615 * The spec mandates that we do so, since we'll need it past the
616 * eglGetPlatformDispay call.
618 * The new fd is guaranteed to be 3 or greater.
620 if (fd
!= -1 && display
->Options
.fd
== 0) {
621 display
->Options
.fd
= fcntl(fd
, F_DUPFD_CLOEXEC
, 3);
622 if (display
->Options
.fd
== -1) {
623 /* Do not (really) need to teardown the display */
624 _eglError(EGL_BAD_ALLOC
, "eglGetPlatformDisplay");