1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/******************************************************************************
*
* Project: Common Portability Library
* Purpose: Fetch a function pointer from a shared library / DLL.
* Author: Frank Warmerdam, warmerdam@pobox.com
*
******************************************************************************
* Copyright (c) 1999, Frank Warmerdam
* Copyright (c) 2009-2013, Even Rouault <even dot rouault at spatialys.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
****************************************************************************/
#include "cpl_port.h"
#include "cpl_conv.h"
#include <cstddef>
#include "cpl_config.h"
#include "cpl_error.h"
#include "cpl_string.h"
/* ==================================================================== */
/* Unix Implementation */
/* ==================================================================== */
/* MinGW32 might define HAVE_DLFCN_H, so skip the unix implementation */
#if defined(HAVE_DLFCN_H) && !defined(WIN32)
#define GOT_GETSYMBOL
#include <dlfcn.h>
/************************************************************************/
/* CPLGetSymbol() */
/************************************************************************/
/**
* Fetch a function pointer from a shared library / DLL.
*
* This function is meant to abstract access to shared libraries and
* DLLs and performs functions similar to dlopen()/dlsym() on Unix and
* LoadLibrary() / GetProcAddress() on Windows.
*
* If no support for loading entry points from a shared library is available
* this function will always return NULL. Rules on when this function
* issues a CPLError() or not are not currently well defined, and will have
* to be resolved in the future.
*
* Currently CPLGetSymbol() doesn't try to:
* <ul>
* <li> prevent the reference count on the library from going up
* for every request, or given any opportunity to unload
* the library.
* <li> Attempt to look for the library in non-standard
* locations.
* <li> Attempt to try variations on the symbol name, like
* pre-pending or post-pending an underscore.
* </ul>
*
* Some of these issues may be worked on in the future.
*
* @param pszLibrary the name of the shared library or DLL containing
* the function. May contain path to file. If not system supplies search
* paths will be used.
* @param pszSymbolName the name of the function to fetch a pointer to.
* @return A pointer to the function if found, or NULL if the function isn't
* found, or the shared library can't be loaded.
*/
void *CPLGetSymbol(const char *pszLibrary, const char *pszSymbolName)
{
void *pLibrary = dlopen(pszLibrary, RTLD_LAZY);
if (pLibrary == nullptr)
{
CPLError(CE_Failure, CPLE_AppDefined, "%s", dlerror());
return nullptr;
}
void *pSymbol = dlsym(pLibrary, pszSymbolName);
#if (defined(__APPLE__) && defined(__MACH__))
/* On mach-o systems, C symbols have a leading underscore and depending
* on how dlcompat is configured it may or may not add the leading
* underscore. If dlsym() fails, add an underscore and try again.
*/
if (pSymbol == nullptr)
{
char withUnder[256] = {};
snprintf(withUnder, sizeof(withUnder), "_%s", pszSymbolName);
pSymbol = dlsym(pLibrary, withUnder);
}
#endif
if (pSymbol == nullptr)
{
CPLError(CE_Failure, CPLE_AppDefined, "%s", dlerror());
// Do not call dlclose here. misc.py:misc_6() demonstrates the crash.
// coverity[leaked_storage]
return nullptr;
}
// coverity[leaked_storage] It is not safe to call dlclose.
return (pSymbol);
}
#endif /* def __unix__ && defined(HAVE_DLFCN_H) */
/* ==================================================================== */
/* Windows Implementation */
/* ==================================================================== */
#if defined(WIN32)
#define GOT_GETSYMBOL
#include <windows.h>
/************************************************************************/
/* CPLGetSymbol() */
/************************************************************************/
void *CPLGetSymbol(const char *pszLibrary, const char *pszSymbolName)
{
void *pLibrary = nullptr;
void *pSymbol = nullptr;
// Avoid error boxes to pop up (#5211, #5525).
UINT uOldErrorMode =
SetErrorMode(SEM_NOOPENFILEERRORBOX | SEM_FAILCRITICALERRORS);
#if defined(_MSC_VER) || __MSVCRT_VERSION__ >= 0x0601
if (CPLTestBool(CPLGetConfigOption("GDAL_FILENAME_IS_UTF8", "YES")))
{
wchar_t *pwszFilename =
CPLRecodeToWChar(pszLibrary, CPL_ENC_UTF8, CPL_ENC_UCS2);
pLibrary = LoadLibraryW(pwszFilename);
CPLFree(pwszFilename);
}
else
#endif
{
pLibrary = LoadLibraryA(pszLibrary);
}
if (pLibrary <= (void *)HINSTANCE_ERROR)
{
LPVOID lpMsgBuf = nullptr;
int nLastError = GetLastError();
// Restore old error mode.
SetErrorMode(uOldErrorMode);
FormatMessage(
FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM |
FORMAT_MESSAGE_IGNORE_INSERTS,
nullptr, nLastError, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
reinterpret_cast<LPTSTR>(&lpMsgBuf), 0, nullptr);
CPLError(CE_Failure, CPLE_AppDefined,
"Can't load requested DLL: %s\n%d: %s", pszLibrary, nLastError,
static_cast<const char *>(lpMsgBuf));
return nullptr;
}
// Restore old error mode.
SetErrorMode(uOldErrorMode);
pSymbol = reinterpret_cast<void *>(
GetProcAddress(static_cast<HINSTANCE>(pLibrary), pszSymbolName));
if (pSymbol == nullptr)
{
CPLError(CE_Failure, CPLE_AppDefined,
"Can't find requested entry point: %s", pszSymbolName);
return nullptr;
}
return (pSymbol);
}
#endif // def _WIN32
/* ==================================================================== */
/* Dummy implementation. */
/* ==================================================================== */
#ifndef GOT_GETSYMBOL
/************************************************************************/
/* CPLGetSymbol() */
/* */
/* Dummy implementation. */
/************************************************************************/
void *CPLGetSymbol(const char *pszLibrary, const char *pszEntryPoint)
{
CPLDebug("CPL",
"CPLGetSymbol(%s,%s) called. Failed as this is stub"
" implementation.",
pszLibrary, pszEntryPoint);
return nullptr;
}
#endif
|
