xref: /aosp_15_r20/external/swiftshader/src/System/SharedLibrary.hpp (revision 03ce13f70fcc45d86ee91b7ee4cab1936a95046e)
1*03ce13f7SAndroid Build Coastguard Worker // Copyright 2016 The SwiftShader Authors. All Rights Reserved.
2*03ce13f7SAndroid Build Coastguard Worker //
3*03ce13f7SAndroid Build Coastguard Worker // Licensed under the Apache License, Version 2.0 (the "License");
4*03ce13f7SAndroid Build Coastguard Worker // you may not use this file except in compliance with the License.
5*03ce13f7SAndroid Build Coastguard Worker // You may obtain a copy of the License at
6*03ce13f7SAndroid Build Coastguard Worker //
7*03ce13f7SAndroid Build Coastguard Worker //    http://www.apache.org/licenses/LICENSE-2.0
8*03ce13f7SAndroid Build Coastguard Worker //
9*03ce13f7SAndroid Build Coastguard Worker // Unless required by applicable law or agreed to in writing, software
10*03ce13f7SAndroid Build Coastguard Worker // distributed under the License is distributed on an "AS IS" BASIS,
11*03ce13f7SAndroid Build Coastguard Worker // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*03ce13f7SAndroid Build Coastguard Worker // See the License for the specific language governing permissions and
13*03ce13f7SAndroid Build Coastguard Worker // limitations under the License.
14*03ce13f7SAndroid Build Coastguard Worker 
15*03ce13f7SAndroid Build Coastguard Worker #ifndef SharedLibrary_hpp
16*03ce13f7SAndroid Build Coastguard Worker #define SharedLibrary_hpp
17*03ce13f7SAndroid Build Coastguard Worker 
18*03ce13f7SAndroid Build Coastguard Worker #if defined(_WIN32)
19*03ce13f7SAndroid Build Coastguard Worker #	include <Windows.h>
20*03ce13f7SAndroid Build Coastguard Worker #else
21*03ce13f7SAndroid Build Coastguard Worker #	include <dlfcn.h>
22*03ce13f7SAndroid Build Coastguard Worker #endif
23*03ce13f7SAndroid Build Coastguard Worker 
24*03ce13f7SAndroid Build Coastguard Worker #include <string>
25*03ce13f7SAndroid Build Coastguard Worker 
26*03ce13f7SAndroid Build Coastguard Worker void *getLibraryHandle(const char *path);
27*03ce13f7SAndroid Build Coastguard Worker void *loadLibrary(const char *path);
28*03ce13f7SAndroid Build Coastguard Worker void freeLibrary(void *library);
29*03ce13f7SAndroid Build Coastguard Worker void *getProcAddress(void *library, const char *name);
30*03ce13f7SAndroid Build Coastguard Worker 
31*03ce13f7SAndroid Build Coastguard Worker template<int n>
loadLibrary(const std::string & libraryDirectory,const char * (& names)[n],const char * mustContainSymbol=nullptr)32*03ce13f7SAndroid Build Coastguard Worker void *loadLibrary(const std::string &libraryDirectory, const char *(&names)[n], const char *mustContainSymbol = nullptr)
33*03ce13f7SAndroid Build Coastguard Worker {
34*03ce13f7SAndroid Build Coastguard Worker 	for(const char *libraryName : names)
35*03ce13f7SAndroid Build Coastguard Worker 	{
36*03ce13f7SAndroid Build Coastguard Worker 		std::string libraryPath = libraryDirectory + libraryName;
37*03ce13f7SAndroid Build Coastguard Worker 		void *library = getLibraryHandle(libraryPath.c_str());
38*03ce13f7SAndroid Build Coastguard Worker 
39*03ce13f7SAndroid Build Coastguard Worker 		if(library)
40*03ce13f7SAndroid Build Coastguard Worker 		{
41*03ce13f7SAndroid Build Coastguard Worker 			if(!mustContainSymbol || getProcAddress(library, mustContainSymbol))
42*03ce13f7SAndroid Build Coastguard Worker 			{
43*03ce13f7SAndroid Build Coastguard Worker 				return library;
44*03ce13f7SAndroid Build Coastguard Worker 			}
45*03ce13f7SAndroid Build Coastguard Worker 
46*03ce13f7SAndroid Build Coastguard Worker 			freeLibrary(library);
47*03ce13f7SAndroid Build Coastguard Worker 		}
48*03ce13f7SAndroid Build Coastguard Worker 	}
49*03ce13f7SAndroid Build Coastguard Worker 
50*03ce13f7SAndroid Build Coastguard Worker 	for(const char *libraryName : names)
51*03ce13f7SAndroid Build Coastguard Worker 	{
52*03ce13f7SAndroid Build Coastguard Worker 		std::string libraryPath = libraryDirectory + libraryName;
53*03ce13f7SAndroid Build Coastguard Worker 		void *library = loadLibrary(libraryPath.c_str());
54*03ce13f7SAndroid Build Coastguard Worker 
55*03ce13f7SAndroid Build Coastguard Worker 		if(library)
56*03ce13f7SAndroid Build Coastguard Worker 		{
57*03ce13f7SAndroid Build Coastguard Worker 			if(!mustContainSymbol || getProcAddress(library, mustContainSymbol))
58*03ce13f7SAndroid Build Coastguard Worker 			{
59*03ce13f7SAndroid Build Coastguard Worker 				return library;
60*03ce13f7SAndroid Build Coastguard Worker 			}
61*03ce13f7SAndroid Build Coastguard Worker 
62*03ce13f7SAndroid Build Coastguard Worker 			freeLibrary(library);
63*03ce13f7SAndroid Build Coastguard Worker 		}
64*03ce13f7SAndroid Build Coastguard Worker 	}
65*03ce13f7SAndroid Build Coastguard Worker 
66*03ce13f7SAndroid Build Coastguard Worker 	return nullptr;
67*03ce13f7SAndroid Build Coastguard Worker }
68*03ce13f7SAndroid Build Coastguard Worker 
69*03ce13f7SAndroid Build Coastguard Worker #if defined(_WIN32)
loadLibrary(const char * path)70*03ce13f7SAndroid Build Coastguard Worker inline void *loadLibrary(const char *path)
71*03ce13f7SAndroid Build Coastguard Worker {
72*03ce13f7SAndroid Build Coastguard Worker 	return (void *)LoadLibrary(path);
73*03ce13f7SAndroid Build Coastguard Worker }
74*03ce13f7SAndroid Build Coastguard Worker 
getLibraryHandle(const char * path)75*03ce13f7SAndroid Build Coastguard Worker inline void *getLibraryHandle(const char *path)
76*03ce13f7SAndroid Build Coastguard Worker {
77*03ce13f7SAndroid Build Coastguard Worker 	HMODULE module = NULL;
78*03ce13f7SAndroid Build Coastguard Worker 	GetModuleHandleEx(0, path, &module);
79*03ce13f7SAndroid Build Coastguard Worker 	return (void *)module;
80*03ce13f7SAndroid Build Coastguard Worker }
81*03ce13f7SAndroid Build Coastguard Worker 
freeLibrary(void * library)82*03ce13f7SAndroid Build Coastguard Worker inline void freeLibrary(void *library)
83*03ce13f7SAndroid Build Coastguard Worker {
84*03ce13f7SAndroid Build Coastguard Worker 	FreeLibrary((HMODULE)library);
85*03ce13f7SAndroid Build Coastguard Worker }
86*03ce13f7SAndroid Build Coastguard Worker 
getProcAddress(void * library,const char * name)87*03ce13f7SAndroid Build Coastguard Worker inline void *getProcAddress(void *library, const char *name)
88*03ce13f7SAndroid Build Coastguard Worker {
89*03ce13f7SAndroid Build Coastguard Worker 	return (void *)GetProcAddress((HMODULE)library, name);
90*03ce13f7SAndroid Build Coastguard Worker }
91*03ce13f7SAndroid Build Coastguard Worker #else
loadLibrary(const char * path)92*03ce13f7SAndroid Build Coastguard Worker inline void *loadLibrary(const char *path)
93*03ce13f7SAndroid Build Coastguard Worker {
94*03ce13f7SAndroid Build Coastguard Worker 	return dlopen(path, RTLD_LAZY | RTLD_LOCAL);
95*03ce13f7SAndroid Build Coastguard Worker }
96*03ce13f7SAndroid Build Coastguard Worker 
getLibraryHandle(const char * path)97*03ce13f7SAndroid Build Coastguard Worker inline void *getLibraryHandle(const char *path)
98*03ce13f7SAndroid Build Coastguard Worker {
99*03ce13f7SAndroid Build Coastguard Worker #	ifdef __ANDROID__
100*03ce13f7SAndroid Build Coastguard Worker 	// bionic doesn't support RTLD_NOLOAD before L
101*03ce13f7SAndroid Build Coastguard Worker 	return dlopen(path, RTLD_NOW | RTLD_LOCAL);
102*03ce13f7SAndroid Build Coastguard Worker #	else
103*03ce13f7SAndroid Build Coastguard Worker 	void *resident = dlopen(path, RTLD_LAZY | RTLD_NOLOAD | RTLD_LOCAL);
104*03ce13f7SAndroid Build Coastguard Worker 
105*03ce13f7SAndroid Build Coastguard Worker 	if(resident)
106*03ce13f7SAndroid Build Coastguard Worker 	{
107*03ce13f7SAndroid Build Coastguard Worker 		return dlopen(path, RTLD_LAZY | RTLD_LOCAL);  // Increment reference count
108*03ce13f7SAndroid Build Coastguard Worker 	}
109*03ce13f7SAndroid Build Coastguard Worker 
110*03ce13f7SAndroid Build Coastguard Worker 	return nullptr;
111*03ce13f7SAndroid Build Coastguard Worker #	endif
112*03ce13f7SAndroid Build Coastguard Worker }
113*03ce13f7SAndroid Build Coastguard Worker 
freeLibrary(void * library)114*03ce13f7SAndroid Build Coastguard Worker inline void freeLibrary(void *library)
115*03ce13f7SAndroid Build Coastguard Worker {
116*03ce13f7SAndroid Build Coastguard Worker 	if(library)
117*03ce13f7SAndroid Build Coastguard Worker 	{
118*03ce13f7SAndroid Build Coastguard Worker 		dlclose(library);
119*03ce13f7SAndroid Build Coastguard Worker 	}
120*03ce13f7SAndroid Build Coastguard Worker }
121*03ce13f7SAndroid Build Coastguard Worker 
getProcAddress(void * library,const char * name)122*03ce13f7SAndroid Build Coastguard Worker inline void *getProcAddress(void *library, const char *name)
123*03ce13f7SAndroid Build Coastguard Worker {
124*03ce13f7SAndroid Build Coastguard Worker 	void *symbol = dlsym(library, name);
125*03ce13f7SAndroid Build Coastguard Worker 
126*03ce13f7SAndroid Build Coastguard Worker 	if(!symbol)
127*03ce13f7SAndroid Build Coastguard Worker 	{
128*03ce13f7SAndroid Build Coastguard Worker 		const char *reason = dlerror();  // Silence the error
129*03ce13f7SAndroid Build Coastguard Worker 		(void)reason;
130*03ce13f7SAndroid Build Coastguard Worker 	}
131*03ce13f7SAndroid Build Coastguard Worker 
132*03ce13f7SAndroid Build Coastguard Worker 	return symbol;
133*03ce13f7SAndroid Build Coastguard Worker }
134*03ce13f7SAndroid Build Coastguard Worker #endif
135*03ce13f7SAndroid Build Coastguard Worker 
136*03ce13f7SAndroid Build Coastguard Worker template<typename FunctionPointer>
getFuncAddress(void * library,const char * functionName,FunctionPointer * out)137*03ce13f7SAndroid Build Coastguard Worker inline void getFuncAddress(void *library, const char *functionName, FunctionPointer *out)
138*03ce13f7SAndroid Build Coastguard Worker {
139*03ce13f7SAndroid Build Coastguard Worker 	*out = reinterpret_cast<FunctionPointer>(getProcAddress(library, functionName));
140*03ce13f7SAndroid Build Coastguard Worker }
141*03ce13f7SAndroid Build Coastguard Worker 
142*03ce13f7SAndroid Build Coastguard Worker #endif  // SharedLibrary_hpp
143