VirtualBox

source: vbox/trunk/src/VBox/Runtime/common/ldr/ldrNative.cpp@ 75410

Last change on this file since 75410 was 73494, checked in by vboxsync, 6 years ago

IPRT: Added single stack frame unwind function to RTDbgMod and RTLdr, copying over the PoC from DBGFRStack.cpp. bugref:3897
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 9.9 KB
Line 
1/* $Id: ldrNative.cpp 73494 2018-08-04 19:41:30Z vboxsync $ */
2/** @file
3 * IPRT - Binary Image Loader, Native interface.
4 */
5
6/*
7 * Copyright (C) 2006-2017 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27
28/*********************************************************************************************************************************
29* Header Files *
30*********************************************************************************************************************************/
31#define LOG_GROUP RTLOGGROUP_LDR
32#include <iprt/ldr.h>
33#include "internal/iprt.h"
34
35#include <iprt/alloc.h>
36#include <iprt/assert.h>
37#include <iprt/log.h>
38#include <iprt/param.h>
39#include <iprt/path.h>
40#include <iprt/string.h>
41#include <iprt/err.h>
42#include "internal/ldr.h"
43
44
45/** @copydoc RTLDROPS::pfnEnumSymbols */
46static DECLCALLBACK(int) rtldrNativeEnumSymbols(PRTLDRMODINTERNAL pMod, unsigned fFlags, const void *pvBits,
47 RTUINTPTR BaseAddress, PFNRTLDRENUMSYMS pfnCallback, void *pvUser)
48{
49 NOREF(pMod); NOREF(fFlags); NOREF(pvBits); NOREF(BaseAddress); NOREF(pfnCallback); NOREF(pvUser);
50 return VERR_NOT_SUPPORTED;
51}
52
53
54/** @copydoc RTLDROPS::pfnDone */
55static DECLCALLBACK(int) rtldrNativeDone(PRTLDRMODINTERNAL pMod)
56{
57 NOREF(pMod);
58 return VINF_SUCCESS;
59}
60
61
62/**
63 * Operations for a native module.
64 */
65static const RTLDROPS g_rtldrNativeOps =
66{
67 "native",
68 rtldrNativeClose,
69 rtldrNativeGetSymbol,
70 rtldrNativeDone,
71 rtldrNativeEnumSymbols,
72 /* ext: */
73 NULL,
74 NULL,
75 NULL,
76 NULL,
77 NULL /*pfnQueryForwarderInfo*/,
78 NULL,
79 NULL,
80 NULL,
81 NULL,
82 NULL,
83 NULL,
84 NULL,
85 NULL,
86 NULL,
87 NULL,
88 NULL /*pfnUnwindFrame*/,
89 42
90};
91
92
93
94/**
95 * Loads a dynamic load library (/shared object) image file using native
96 * OS facilities.
97 *
98 * The filename will be appended the default DLL/SO extension of
99 * the platform if it have been omitted. This means that it's not
100 * possible to load DLLs/SOs with no extension using this interface,
101 * but that's not a bad tradeoff.
102 *
103 * If no path is specified in the filename, the OS will usually search it's library
104 * path to find the image file.
105 *
106 * @returns iprt status code.
107 * @param pszFilename Image filename.
108 * @param phLdrMod Where to store the handle to the loaded module.
109 */
110RTDECL(int) RTLdrLoad(const char *pszFilename, PRTLDRMOD phLdrMod)
111{
112 return RTLdrLoadEx(pszFilename, phLdrMod, RTLDRLOAD_FLAGS_LOCAL, NULL);
113}
114RT_EXPORT_SYMBOL(RTLdrLoad);
115
116
117RTDECL(int) RTLdrLoadEx(const char *pszFilename, PRTLDRMOD phLdrMod, uint32_t fFlags, PRTERRINFO pErrInfo)
118{
119 LogFlow(("RTLdrLoadEx: pszFilename=%p:{%s} phLdrMod=%p fFlags=%#x pErrInfo=%p\n", pszFilename, pszFilename, phLdrMod, fFlags, pErrInfo));
120
121 /*
122 * Validate and massage the input.
123 */
124 RTErrInfoClear(pErrInfo);
125 AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
126 AssertPtrReturn(phLdrMod, VERR_INVALID_POINTER);
127 AssertReturn(!(fFlags & ~RTLDRLOAD_FLAGS_VALID_MASK), VERR_INVALID_PARAMETER);
128
129 /*
130 * Allocate and initialize module structure.
131 */
132 int rc = VERR_NO_MEMORY;
133 PRTLDRMODNATIVE pMod = (PRTLDRMODNATIVE)RTMemAlloc(sizeof(*pMod));
134 if (pMod)
135 {
136 pMod->Core.u32Magic = RTLDRMOD_MAGIC;
137 pMod->Core.eState = LDR_STATE_LOADED;
138 pMod->Core.pOps = &g_rtldrNativeOps;
139 pMod->Core.pReader = NULL;
140 pMod->Core.enmFormat = RTLDRFMT_NATIVE;
141 pMod->Core.enmType = RTLDRTYPE_SHARED_LIBRARY_RELOCATABLE; /* approx */
142#ifdef RT_BIG_ENDIAN
143 pMod->Core.enmEndian = RTLDRENDIAN_BIG;
144#else
145 pMod->Core.enmEndian = RTLDRENDIAN_LITTLE;
146#endif
147#ifdef RT_ARCH_AMD64
148 pMod->Core.enmArch = RTLDRARCH_AMD64;
149#elif defined(RT_ARCH_X86)
150 pMod->Core.enmArch = RTLDRARCH_X86_32;
151#else
152 pMod->Core.enmArch = RTLDRARCH_HOST;
153#endif
154 pMod->hNative = ~(uintptr_t)0;
155 pMod->fFlags = fFlags;
156
157 /*
158 * Attempt to open the module.
159 */
160 rc = rtldrNativeLoad(pszFilename, &pMod->hNative, fFlags, pErrInfo);
161 if (RT_SUCCESS(rc))
162 {
163 *phLdrMod = &pMod->Core;
164 LogFlow(("RTLdrLoad: returns %Rrc *phLdrMod=%RTldrm\n", rc, *phLdrMod));
165 return rc;
166 }
167
168 RTMemFree(pMod);
169 }
170 else
171 RTErrInfoSetF(pErrInfo, rc, "Failed to allocate %zu bytes for the module handle", sizeof(*pMod));
172 *phLdrMod = NIL_RTLDRMOD;
173 LogFlow(("RTLdrLoad: returns %Rrc\n", rc));
174 return rc;
175}
176RT_EXPORT_SYMBOL(RTLdrLoadEx);
177
178
179RTDECL(int) RTLdrLoadSystem(const char *pszFilename, bool fNoUnload, PRTLDRMOD phLdrMod)
180{
181 LogFlow(("RTLdrLoadSystem: pszFilename=%p:{%s} fNoUnload=%RTbool phLdrMod=%p\n",
182 pszFilename, pszFilename, fNoUnload, phLdrMod));
183
184 /*
185 * Validate input.
186 */
187 AssertPtrReturn(phLdrMod, VERR_INVALID_PARAMETER);
188 *phLdrMod = NIL_RTLDRMOD;
189 AssertPtrReturn(pszFilename, VERR_INVALID_PARAMETER);
190 AssertMsgReturn(!RTPathHasPath(pszFilename), ("%s\n", pszFilename), VERR_INVALID_PARAMETER);
191
192 /*
193 * Check the filename.
194 */
195 size_t cchFilename = strlen(pszFilename);
196 AssertMsgReturn(cchFilename < (RTPATH_MAX / 4) * 3, ("%zu\n", cchFilename), VERR_INVALID_PARAMETER);
197
198 const char *pszSuffix = "";
199 if (!RTPathHasSuffix(pszFilename))
200 pszSuffix = RTLdrGetSuff();
201
202 /*
203 * Let the platform specific code do the rest.
204 */
205 int rc = rtldrNativeLoadSystem(pszFilename, pszSuffix, fNoUnload ? RTLDRLOAD_FLAGS_NO_UNLOAD : 0, phLdrMod);
206 LogFlow(("RTLdrLoadSystem: returns %Rrc\n", rc));
207 return rc;
208}
209
210
211RTDECL(void *) RTLdrGetSystemSymbol(const char *pszFilename, const char *pszSymbol)
212{
213 void *pvRet = NULL;
214 RTLDRMOD hLdrMod;
215 int rc = RTLdrLoadSystem(pszFilename, true /*fNoUnload*/, &hLdrMod);
216 if (RT_SUCCESS(rc))
217 {
218 rc = RTLdrGetSymbol(hLdrMod, pszSymbol, &pvRet);
219 if (RT_FAILURE(rc))
220 pvRet = NULL; /* paranoia */
221 RTLdrClose(hLdrMod);
222 }
223 return pvRet;
224}
225
226
227/**
228 * Loads a dynamic load library (/shared object) image file residing in the
229 * RTPathAppPrivateArch() directory.
230 *
231 * Suffix is not required.
232 *
233 * @returns iprt status code.
234 * @param pszFilename Image filename. No path.
235 * @param phLdrMod Where to store the handle to the loaded module.
236 */
237RTDECL(int) RTLdrLoadAppPriv(const char *pszFilename, PRTLDRMOD phLdrMod)
238{
239 LogFlow(("RTLdrLoadAppPriv: pszFilename=%p:{%s} phLdrMod=%p\n", pszFilename, pszFilename, phLdrMod));
240
241 /*
242 * Validate input.
243 */
244 AssertPtrReturn(phLdrMod, VERR_INVALID_PARAMETER);
245 *phLdrMod = NIL_RTLDRMOD;
246 AssertPtrReturn(pszFilename, VERR_INVALID_PARAMETER);
247 AssertMsgReturn(!RTPathHasPath(pszFilename), ("%s\n", pszFilename), VERR_INVALID_PARAMETER);
248
249 /*
250 * Check the filename.
251 */
252 size_t cchFilename = strlen(pszFilename);
253 AssertMsgReturn(cchFilename < (RTPATH_MAX / 4) * 3, ("%zu\n", cchFilename), VERR_INVALID_PARAMETER);
254
255 const char *pszSuffix = "";
256 size_t cchSuffix = 0;
257 if (!RTPathHasSuffix(pszFilename))
258 {
259 pszSuffix = RTLdrGetSuff();
260 cchSuffix = strlen(pszSuffix);
261 }
262
263 /*
264 * Construct the private arch path and check if the file exists.
265 */
266 char szPath[RTPATH_MAX];
267 int rc = RTPathAppPrivateArch(szPath, sizeof(szPath) - 1 - cchSuffix - cchFilename);
268 AssertRCReturn(rc, rc);
269
270 char *psz = strchr(szPath, '\0');
271 *psz++ = RTPATH_SLASH;
272 memcpy(psz, pszFilename, cchFilename);
273 psz += cchFilename;
274 memcpy(psz, pszSuffix, cchSuffix + 1);
275
276 if (!RTPathExists(szPath))
277 {
278 LogRel(("RTLdrLoadAppPriv: \"%s\" not found\n", szPath));
279 return VERR_FILE_NOT_FOUND;
280 }
281
282 /*
283 * Pass it on to RTLdrLoad.
284 */
285 rc = RTLdrLoad(szPath, phLdrMod);
286
287 LogFlow(("RTLdrLoadAppPriv: returns %Rrc\n", rc));
288 return rc;
289}
290RT_EXPORT_SYMBOL(RTLdrLoadAppPriv);
291
292
293/**
294 * Gets the default file suffix for DLL/SO/DYLIB/whatever.
295 *
296 * @returns The stuff (readonly).
297 */
298RTDECL(const char *) RTLdrGetSuff(void)
299{
300#if defined(RT_OS_OS2) || defined(RT_OS_WINDOWS)
301 static const char s_szSuff[] = ".DLL";
302#elif defined(RT_OS_L4)
303 static const char s_szSuff[] = ".s.so";
304#elif defined(RT_OS_DARWIN)
305 static const char s_szSuff[] = ".dylib";
306#else
307 static const char s_szSuff[] = ".so";
308#endif
309
310 return s_szSuff;
311}
312RT_EXPORT_SYMBOL(RTLdrGetSuff);
313
314
315RTDECL(uintptr_t) RTLdrGetNativeHandle(RTLDRMOD hLdrMod)
316{
317 PRTLDRMODNATIVE pThis = (PRTLDRMODNATIVE)hLdrMod;
318 AssertPtrReturn(pThis, ~(uintptr_t)0);
319 AssertReturn(pThis->Core.u32Magic == RTLDRMOD_MAGIC, ~(uintptr_t)0);
320 AssertReturn(pThis->Core.pOps == &g_rtldrNativeOps, ~(uintptr_t)0);
321 return pThis->hNative;
322}
323RT_EXPORT_SYMBOL(RTLdrGetNativeHandle);
324
325
326RTDECL(bool) RTLdrIsLoadable(const char *pszFilename)
327{
328 /*
329 * Try to load the library.
330 */
331 RTLDRMOD hLib;
332 int rc = RTLdrLoad(pszFilename, &hLib);
333 if (RT_SUCCESS(rc))
334 {
335 RTLdrClose(hLib);
336 return true;
337 }
338 return false;
339}
340RT_EXPORT_SYMBOL(RTLdrIsLoadable);
341
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette