2 * Functions for choosing and opening/loading device drivers.
10 #include "eglconfig.h"
11 #include "eglcontext.h"
12 #include "egldefines.h"
13 #include "egldisplay.h"
14 #include "egldriver.h"
15 #include "eglglobals.h"
19 #include "eglscreen.h"
20 #include "eglstring.h"
21 #include "eglsurface.h"
24 #if defined(_EGL_PLATFORM_POSIX)
26 #include <sys/types.h>
33 * Wrappers for dlopen/dlclose()
35 #if defined(_EGL_PLATFORM_WINDOWS)
38 /* XXX Need to decide how to do dynamic name lookup on Windows */
39 static const char DefaultDriverName
[] = "TBD";
41 typedef HMODULE lib_handle
;
44 open_library(const char *filename
)
46 return LoadLibrary(filename
);
50 close_library(HMODULE lib
)
63 #elif defined(_EGL_PLATFORM_POSIX)
66 static const char DefaultDriverName
[] = "egl_glx";
68 typedef void * lib_handle
;
71 open_library(const char *filename
)
73 return dlopen(filename
, RTLD_LAZY
);
77 close_library(void *lib
)
90 #else /* _EGL_PLATFORM_NO_OS */
93 static const char DefaultDriverName
[] = "builtin";
95 typedef void *lib_handle
;
98 open_library(const char *filename
)
100 return (void *) filename
;
104 close_library(void *lib
)
119 #define NUM_PROBE_CACHE_SLOTS 8
121 EGLint keys
[NUM_PROBE_CACHE_SLOTS
];
122 const void *values
[NUM_PROBE_CACHE_SLOTS
];
127 * Open the named driver and find its bootstrap function: _eglMain().
130 _eglOpenLibrary(const char *driverPath
, lib_handle
*handle
)
133 _EGLMain_t mainFunc
= NULL
;
134 const char *error
= "unknown error";
138 _eglLog(_EGL_DEBUG
, "dlopen(%s)", driverPath
);
139 lib
= open_library(driverPath
);
141 #if defined(_EGL_PLATFORM_WINDOWS)
144 mainFunc
= (_EGLMain_t
) GetProcAddress(lib
, "_eglMain");
145 #elif defined(_EGL_PLATFORM_POSIX)
151 /* direct cast gives a warning when compiled with -pedantic */
152 tmp
.ptr
= dlsym(lib
, "_eglMain");
160 #else /* _EGL_PLATFORM_NO_OS */
161 /* must be the default driver name */
162 if (strcmp(driverPath
, DefaultDriverName
) == 0)
163 mainFunc
= (_EGLMain_t
) _eglMain
;
165 error
= "not builtin driver";
169 _eglLog(_EGL_WARNING
, "Could not open driver %s (%s)",
171 if (!getenv("EGL_DRIVER"))
172 _eglLog(_EGL_WARNING
,
173 "The driver can be overridden by setting EGL_DRIVER");
178 _eglLog(_EGL_WARNING
, "_eglMain not found in %s (%s)",
191 * Load the named driver.
194 _eglLoadDriver(const char *path
, const char *args
)
198 _EGLDriver
*drv
= NULL
;
200 mainFunc
= _eglOpenLibrary(path
, &lib
);
204 drv
= mainFunc(args
);
212 _eglLog(_EGL_WARNING
, "Driver loaded from %s has no name", path
);
213 drv
->Name
= "UNNAMED";
216 drv
->Path
= _eglstrdup(path
);
217 drv
->Args
= (args
) ? _eglstrdup(args
) : NULL
;
218 if (!drv
->Path
|| (args
&& !drv
->Args
)) {
220 free((char *) drv
->Path
);
222 free((char *) drv
->Args
);
229 drv
->LibHandle
= lib
;
236 * Match a display to a preloaded driver.
238 * The matching is done by finding the driver with the highest score.
241 _eglMatchDriver(_EGLDisplay
*dpy
)
243 _EGLDriver
*best_drv
= NULL
;
244 EGLint best_score
= -1, i
;
247 * this function is called after preloading and the drivers never change
250 for (i
= 0; i
< _eglGlobal
.NumDrivers
; i
++) {
251 _EGLDriver
*drv
= _eglGlobal
.Drivers
[i
];
254 score
= (drv
->Probe
) ? drv
->Probe(drv
, dpy
) : 0;
255 if (score
> best_score
) {
257 _eglLog(_EGL_DEBUG
, "driver %s has higher score than %s",
258 drv
->Name
, best_drv
->Name
);
274 * A loader function for use with _eglPreloadForEach. The loader data is the
275 * filename of the driver. This function stops on the first valid driver.
278 _eglLoaderFile(const char *dir
, size_t len
, void *loader_data
)
282 const char *filename
= (const char *) loader_data
;
283 size_t flen
= strlen(filename
);
285 /* make a full path */
286 if (len
+ flen
+ 2 > sizeof(path
))
289 memcpy(path
, dir
, len
);
292 memcpy(path
+ len
, filename
, flen
);
296 if (library_suffix() == NULL
|| strstr(path
, library_suffix()))
297 drv
= _eglLoadDriver(path
, NULL
);
299 const char *suffix
= library_suffix();
300 size_t slen
= strlen(suffix
);
302 EGLBoolean need_suffix
;
304 p
= filename
+ flen
- slen
;
305 need_suffix
= (p
< filename
|| strcmp(p
, suffix
) != 0);
306 if (need_suffix
&& len
+ slen
+ 1 <= sizeof(path
)) {
307 strcpy(path
+ len
, suffix
);
308 drv
= _eglLoadDriver(path
, NULL
);
316 /* remember the driver and stop */
317 _eglGlobal
.Drivers
[_eglGlobal
.NumDrivers
++] = drv
;
323 * A loader function for use with _eglPreloadForEach. The loader data is the
324 * pattern (prefix) of the files to look for.
327 _eglLoaderPattern(const char *dir
, size_t len
, void *loader_data
)
329 #if defined(_EGL_PLATFORM_POSIX)
330 const char *prefix
, *suffix
;
331 size_t prefix_len
, suffix_len
;
333 struct dirent
*dirent
;
336 if (len
+ 2 > sizeof(path
))
339 memcpy(path
, dir
, len
);
344 dirp
= opendir(path
);
348 prefix
= (const char *) loader_data
;
349 prefix_len
= strlen(prefix
);
350 suffix
= library_suffix();
351 suffix_len
= (suffix
) ? strlen(suffix
) : 0;
353 while ((dirent
= readdir(dirp
))) {
355 size_t dirent_len
= strlen(dirent
->d_name
);
358 /* match the prefix */
359 if (strncmp(dirent
->d_name
, prefix
, prefix_len
) != 0)
361 /* match the suffix */
363 p
= dirent
->d_name
+ dirent_len
- suffix_len
;
364 if (p
< dirent
->d_name
|| strcmp(p
, suffix
) != 0)
368 /* make a full path and load the driver */
369 if (len
+ dirent_len
+ 1 <= sizeof(path
)) {
370 strcpy(path
+ len
, dirent
->d_name
);
371 drv
= _eglLoadDriver(path
, NULL
);
373 _eglGlobal
.Drivers
[_eglGlobal
.NumDrivers
++] = drv
;
380 #else /* _EGL_PLATFORM_POSIX */
381 /* stop immediately */
388 * Run the preload function on each driver directory and return the number of
391 * The process may end prematurely if the callback function returns false.
394 _eglPreloadForEach(const char *search_path
,
395 EGLBoolean (*loader
)(const char *, size_t, void *),
398 const char *cur
, *next
;
400 EGLint num_drivers
= _eglGlobal
.NumDrivers
;
404 next
= strchr(cur
, ':');
405 len
= (next
) ? next
- cur
: strlen(cur
);
407 if (!loader(cur
, len
, loader_data
))
410 cur
= (next
) ? next
+ 1 : NULL
;
413 return (_eglGlobal
.NumDrivers
- num_drivers
);
418 * Return a list of colon-separated driver directories.
421 _eglGetSearchPath(void)
423 static const char *search_path
;
425 #if defined(_EGL_PLATFORM_POSIX) || defined(_EGL_PLATFORM_WINDOWS)
427 static char buffer
[1024];
431 p
= getenv("EGL_DRIVERS_PATH");
432 #if defined(_EGL_PLATFORM_POSIX)
433 if (p
&& (geteuid() != getuid() || getegid() != getgid())) {
435 "ignore EGL_DRIVERS_PATH for setuid/setgid binaries");
438 #endif /* _EGL_PLATFORM_POSIX */
441 ret
= snprintf(buffer
, sizeof(buffer
),
442 "%s:%s", p
, _EGL_DRIVER_SEARCH_DIR
);
443 if (ret
> 0 && ret
< sizeof(buffer
))
444 search_path
= buffer
;
448 search_path
= _EGL_DRIVER_SEARCH_DIR
;
458 * Preload a user driver.
460 * A user driver can be specified by EGL_DRIVER.
463 _eglPreloadUserDriver(void)
465 const char *search_path
= _eglGetSearchPath();
468 env
= getenv("EGL_DRIVER");
469 #if defined(_EGL_PLATFORM_POSIX)
470 if (env
&& strchr(env
, '/')) {
472 if ((geteuid() != getuid() || getegid() != getgid())) {
474 "ignore EGL_DRIVER for setuid/setgid binaries");
478 #endif /* _EGL_PLATFORM_POSIX */
482 if (!_eglPreloadForEach(search_path
, _eglLoaderFile
, (void *) env
)) {
483 _eglLog(_EGL_WARNING
, "EGL_DRIVER is set to an invalid driver");
492 * Preload display drivers.
494 * Display drivers are a set of drivers that support a certain display system.
495 * The display system may be specified by EGL_DISPLAY.
497 * FIXME This makes libEGL a memory hog if an user driver is not specified and
498 * there are many display drivers.
501 _eglPreloadDisplayDrivers(void)
507 dpy
= getenv("EGL_DISPLAY");
509 dpy
= _EGL_DEFAULT_DISPLAY
;
513 ret
= snprintf(prefix
, sizeof(prefix
), "egl_%s_", dpy
);
514 if (ret
< 0 || ret
>= sizeof(prefix
))
517 return (_eglPreloadForEach(_eglGetSearchPath(),
518 _eglLoaderPattern
, (void *) prefix
) > 0);
523 * Preload the default driver.
526 _eglPreloadDefaultDriver(void)
528 return (_eglPreloadForEach(_eglGetSearchPath(),
529 _eglLoaderFile
, (void *) DefaultDriverName
) > 0);
536 * This function loads the driver modules and creates the corresponding
537 * _EGLDriver objects.
540 _eglPreloadDrivers(void)
544 /* protect the preloading process */
545 _eglLockMutex(_eglGlobal
.Mutex
);
547 /* already preloaded */
548 if (_eglGlobal
.NumDrivers
) {
549 _eglUnlockMutex(_eglGlobal
.Mutex
);
553 loaded
= (_eglPreloadUserDriver() ||
554 _eglPreloadDisplayDrivers() ||
555 _eglPreloadDefaultDriver());
557 _eglUnlockMutex(_eglGlobal
.Mutex
);
564 * Unload preloaded drivers.
567 _eglUnloadDrivers(void)
571 /* this is called at atexit time */
572 for (i
= 0; i
< _eglGlobal
.NumDrivers
; i
++) {
573 _EGLDriver
*drv
= _eglGlobal
.Drivers
[i
];
574 lib_handle handle
= drv
->LibHandle
;
577 free((char *) drv
->Path
);
579 free((char *) drv
->Args
);
586 close_library(handle
);
587 _eglGlobal
.Drivers
[i
] = NULL
;
590 _eglGlobal
.NumDrivers
= 0;
595 * Plug all the available fallback routines into the given driver's
599 _eglInitDriverFallbacks(_EGLDriver
*drv
)
601 /* If a pointer is set to NULL, then the device driver _really_ has
604 drv
->API
.Initialize
= NULL
;
605 drv
->API
.Terminate
= NULL
;
607 drv
->API
.GetConfigs
= _eglGetConfigs
;
608 drv
->API
.ChooseConfig
= _eglChooseConfig
;
609 drv
->API
.GetConfigAttrib
= _eglGetConfigAttrib
;
611 drv
->API
.CreateContext
= _eglCreateContext
;
612 drv
->API
.DestroyContext
= _eglDestroyContext
;
613 drv
->API
.MakeCurrent
= _eglMakeCurrent
;
614 drv
->API
.QueryContext
= _eglQueryContext
;
616 drv
->API
.CreateWindowSurface
= _eglCreateWindowSurface
;
617 drv
->API
.CreatePixmapSurface
= _eglCreatePixmapSurface
;
618 drv
->API
.CreatePbufferSurface
= _eglCreatePbufferSurface
;
619 drv
->API
.DestroySurface
= _eglDestroySurface
;
620 drv
->API
.QuerySurface
= _eglQuerySurface
;
621 drv
->API
.SurfaceAttrib
= _eglSurfaceAttrib
;
622 drv
->API
.BindTexImage
= _eglBindTexImage
;
623 drv
->API
.ReleaseTexImage
= _eglReleaseTexImage
;
624 drv
->API
.SwapInterval
= _eglSwapInterval
;
625 drv
->API
.SwapBuffers
= _eglSwapBuffers
;
626 drv
->API
.CopyBuffers
= _eglCopyBuffers
;
628 drv
->API
.QueryString
= _eglQueryString
;
629 drv
->API
.WaitClient
= _eglWaitClient
;
630 drv
->API
.WaitNative
= _eglWaitNative
;
632 #ifdef EGL_MESA_screen_surface
633 drv
->API
.ChooseModeMESA
= _eglChooseModeMESA
;
634 drv
->API
.GetModesMESA
= _eglGetModesMESA
;
635 drv
->API
.GetModeAttribMESA
= _eglGetModeAttribMESA
;
636 drv
->API
.GetScreensMESA
= _eglGetScreensMESA
;
637 drv
->API
.CreateScreenSurfaceMESA
= _eglCreateScreenSurfaceMESA
;
638 drv
->API
.ShowScreenSurfaceMESA
= _eglShowScreenSurfaceMESA
;
639 drv
->API
.ScreenPositionMESA
= _eglScreenPositionMESA
;
640 drv
->API
.QueryScreenMESA
= _eglQueryScreenMESA
;
641 drv
->API
.QueryScreenSurfaceMESA
= _eglQueryScreenSurfaceMESA
;
642 drv
->API
.QueryScreenModeMESA
= _eglQueryScreenModeMESA
;
643 drv
->API
.QueryModeStringMESA
= _eglQueryModeStringMESA
;
644 #endif /* EGL_MESA_screen_surface */
646 #ifdef EGL_VERSION_1_2
647 drv
->API
.CreatePbufferFromClientBuffer
= _eglCreatePbufferFromClientBuffer
;
648 #endif /* EGL_VERSION_1_2 */
650 #ifdef EGL_KHR_image_base
651 drv
->API
.CreateImageKHR
= _eglCreateImageKHR
;
652 drv
->API
.DestroyImageKHR
= _eglDestroyImageKHR
;
653 #endif /* EGL_KHR_image_base */
658 * Invoke a callback function on each EGL search path.
660 * The first argument of the callback function is the name of the search path.
661 * The second argument is the length of the name.
664 _eglSearchPathForEach(EGLBoolean (*callback
)(const char *, size_t, void *),
667 const char *search_path
= _eglGetSearchPath();
668 _eglPreloadForEach(search_path
, callback
, callback_data
);
673 * Set the probe cache at the given key.
675 * A key, instead of a _EGLDriver, is used to allow the probe cache to be share
676 * by multiple drivers.
679 _eglSetProbeCache(EGLint key
, const void *val
)
683 for (idx
= 0; idx
< NUM_PROBE_CACHE_SLOTS
; idx
++) {
684 if (!_eglProbeCache
.keys
[idx
] || _eglProbeCache
.keys
[idx
] == key
)
688 assert(idx
< NUM_PROBE_CACHE_SLOTS
);
690 _eglProbeCache
.keys
[idx
] = key
;
691 _eglProbeCache
.values
[idx
] = val
;
696 * Return the probe cache at the given key.
699 _eglGetProbeCache(EGLint key
)
703 for (idx
= 0; idx
< NUM_PROBE_CACHE_SLOTS
; idx
++) {
704 if (!_eglProbeCache
.keys
[idx
] || _eglProbeCache
.keys
[idx
] == key
)
708 return (idx
< NUM_PROBE_CACHE_SLOTS
&& _eglProbeCache
.keys
[idx
] == key
) ?
709 _eglProbeCache
.values
[idx
] : NULL
;