VirtualBox

source: vbox/trunk/src/VBox/Runtime/common/ldr/ldrMemory.cpp@ 57974

Last change on this file since 57974 was 57974, checked in by vboxsync, 9 years ago

IPRT: Some more doxygen fixes.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.5 KB
Line 
1
2/* $Id: ldrMemory.cpp 57974 2015-09-30 18:27:04Z vboxsync $ */
3/** @file
4 * IPRT - Binary Image Loader, The Memory/Debugger Oriented Parts.
5 */
6
7/*
8 * Copyright (C) 2006-2015 Oracle Corporation
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 *
18 * The contents of this file may alternatively be used under the terms
19 * of the Common Development and Distribution License Version 1.0
20 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
21 * VirtualBox OSE distribution, in which case the provisions of the
22 * CDDL are applicable instead of those of the GPL.
23 *
24 * You may elect to license modified versions of this file under the
25 * terms and conditions of either the GPL or the CDDL or both.
26 */
27
28
29/*********************************************************************************************************************************
30* Header Files *
31*********************************************************************************************************************************/
32#define LOG_GROUP RTLOGGROUP_LDR
33#include <iprt/ldr.h>
34#include "internal/iprt.h"
35
36#include <iprt/alloc.h>
37#include <iprt/assert.h>
38#include <iprt/log.h>
39#include <iprt/err.h>
40#include <iprt/string.h>
41#include "internal/ldr.h"
42
43
44/*********************************************************************************************************************************
45* Structures and Typedefs *
46*********************************************************************************************************************************/
47/**
48 * Memory reader (for debuggers) instance.
49 */
50typedef struct RTLDRRDRMEM
51{
52 /** The core. */
53 RTLDRREADER Core;
54 /** The size of the image. */
55 size_t cbImage;
56 /** The current offset. */
57 size_t offCur;
58
59 /** User parameter for the reader and destructor functions.*/
60 void *pvUser;
61 /** Read function. */
62 PFNRTLDRRDRMEMREAD pfnRead;
63 /** Destructor callback. */
64 PFNRTLDRRDRMEMDTOR pfnDtor;
65
66 /** Mapping of the file. */
67 void *pvMapping;
68 /** Mapping usage counter. */
69 uint32_t cMappings;
70
71 /** The fake filename (variable size). */
72 char szName[1];
73} RTLDRRDRMEM;
74/** Memory based loader reader instance data. */
75typedef RTLDRRDRMEM *PRTLDRRDRMEM;
76
77
78/**
79 * @callback_method_impl{FNRTLDRRDRMEMDTOR,
80 * Default destructor - pvUser points to the image memory block}
81 */
82static DECLCALLBACK(void) rtldrRdrMemDefaultDtor(void *pvUser)
83{
84 RTMemFree(pvUser);
85}
86
87
88/**
89 * @callback_method_impl{FNRTLDRRDRMEMREAD,
90 * Default memory reader - pvUser points to the image memory block}
91 */
92static DECLCALLBACK(int) rtldrRdrMemDefaultReader(void *pvBuf, size_t cb, size_t off, void *pvUser)
93{
94 memcpy(pvBuf, (uint8_t *)pvUser + off, cb);
95 return VINF_SUCCESS;
96}
97
98
99/** @interface_method_impl{RTLDRREADER,pfnRead} */
100static DECLCALLBACK(int) rtldrRdrMem_Read(PRTLDRREADER pReader, void *pvBuf, size_t cb, RTFOFF off)
101{
102 PRTLDRRDRMEM pThis = (PRTLDRRDRMEM)pReader;
103
104 AssertReturn(off >= 0, VERR_INVALID_PARAMETER);
105 if ( cb > pThis->cbImage
106 || off > (RTFOFF)pThis->cbImage
107 || off + (RTFOFF)cb > (RTFOFF)pThis->cbImage)
108 {
109 pThis->offCur = pThis->cbImage;
110 return VERR_EOF;
111 }
112
113 int rc = pThis->pfnRead(pvBuf, cb, (size_t)off, pThis->pvUser);
114 if (RT_SUCCESS(rc))
115 pThis->offCur = (size_t)off + cb;
116 else
117 pThis->offCur = ~(size_t)0;
118 return rc;
119}
120
121
122/** @interface_method_impl{RTLDRREADER,pfnTell} */
123static DECLCALLBACK(RTFOFF) rtldrRdrMem_Tell(PRTLDRREADER pReader)
124{
125 PRTLDRRDRMEM pThis = (PRTLDRRDRMEM)pReader;
126 return pThis->offCur;
127}
128
129
130/** @interface_method_impl{RTLDRREADER,pfnSize} */
131static DECLCALLBACK(RTFOFF) rtldrRdrMem_Size(PRTLDRREADER pReader)
132{
133 PRTLDRRDRMEM pThis = (PRTLDRRDRMEM)pReader;
134 return pThis->cbImage;
135}
136
137
138/** @interface_method_impl{RTLDRREADER,pfnLogName} */
139static DECLCALLBACK(const char *) rtldrRdrMem_LogName(PRTLDRREADER pReader)
140{
141 PRTLDRRDRMEM pThis = (PRTLDRRDRMEM)pReader;
142 return pThis->szName;
143}
144
145
146/** @interface_method_impl{RTLDRREADER,pfnMap} */
147static DECLCALLBACK(int) rtldrRdrMem_Map(PRTLDRREADER pReader, const void **ppvBits)
148{
149 PRTLDRRDRMEM pThis = (PRTLDRRDRMEM)pReader;
150
151 /*
152 * Already mapped?
153 */
154 if (pThis->pvMapping)
155 {
156 pThis->cMappings++;
157 *ppvBits = pThis->pvMapping;
158 return VINF_SUCCESS;
159 }
160
161 /*
162 * Allocate memory.
163 */
164 pThis->pvMapping = RTMemAlloc(pThis->cbImage);
165 if (!pThis->pvMapping)
166 return VERR_NO_MEMORY;
167 int rc = rtldrRdrMem_Read(pReader, pThis->pvMapping, pThis->cbImage, 0);
168 if (RT_SUCCESS(rc))
169 {
170 pThis->cMappings = 1;
171 *ppvBits = pThis->pvMapping;
172 }
173 else
174 {
175 RTMemFree(pThis->pvMapping);
176 pThis->pvMapping = NULL;
177 }
178
179 return rc;
180}
181
182
183/** @interface_method_impl{RTLDRREADER,pfnUnmap} */
184static DECLCALLBACK(int) rtldrRdrMem_Unmap(PRTLDRREADER pReader, const void *pvBits)
185{
186 PRTLDRRDRMEM pThis = (PRTLDRRDRMEM)pReader;
187 AssertReturn(pThis->cMappings > 0, VERR_INVALID_PARAMETER);
188
189 if (!--pThis->cMappings)
190 {
191 RTMemFree(pThis->pvMapping);
192 pThis->pvMapping = NULL;
193 }
194
195 NOREF(pvBits);
196 return VINF_SUCCESS;
197}
198
199
200/** @interface_method_impl{RTLDRREADER,pfnDestroy} */
201static DECLCALLBACK(int) rtldrRdrMem_Destroy(PRTLDRREADER pReader)
202{
203 PRTLDRRDRMEM pThis = (PRTLDRRDRMEM)pReader;
204 pThis->pfnDtor(pThis->pvUser);
205 RTMemFree(pThis);
206 return VINF_SUCCESS;
207}
208
209
210/**
211 * Opens a memory based loader reader.
212 *
213 * @returns iprt status code.
214 * @param ppReader Where to store the reader instance on success.
215 * @param pszName The name to give the image.
216 * @param cbImage The image size.
217 * @param pfnRead The reader function. If NULL, a default reader is
218 * used that assumes pvUser points to a memory buffer
219 * of at least @a cbImage size.
220 * @param pfnDtor The destructor. If NULL, a default destructore is
221 * used that will call RTMemFree on @a pvUser.
222 * @param pvUser User argument. If either @a pfnRead or @a pfnDtor
223 * is NULL, this must be a pointer to readable memory
224 * (see above).
225 */
226static int rtldrRdrMem_Create(PRTLDRREADER *ppReader, const char *pszName, size_t cbImage,
227 PFNRTLDRRDRMEMREAD pfnRead, PFNRTLDRRDRMEMDTOR pfnDtor, void *pvUser)
228{
229#if ARCH_BITS > 32 /* 'ing gcc. */
230 AssertReturn(cbImage < RTFOFF_MAX, VERR_INVALID_PARAMETER);
231#endif
232 AssertReturn((RTFOFF)cbImage > 0, VERR_INVALID_PARAMETER);
233
234 size_t cchName = strlen(pszName);
235 int rc = VERR_NO_MEMORY;
236 PRTLDRRDRMEM pThis = (PRTLDRRDRMEM)RTMemAlloc(sizeof(*pThis) + cchName);
237 if (pThis)
238 {
239 memcpy(pThis->szName, pszName, cchName + 1);
240 pThis->cbImage = cbImage;
241 pThis->pvUser = pvUser;
242 pThis->offCur = 0;
243 pThis->pvUser = pvUser;
244 pThis->pfnRead = pfnRead ? pfnRead : rtldrRdrMemDefaultReader;
245 pThis->pfnDtor = pfnDtor ? pfnDtor : rtldrRdrMemDefaultDtor;
246 pThis->pvMapping = NULL;
247 pThis->cMappings = 0;
248 pThis->Core.uMagic = RTLDRREADER_MAGIC;
249 pThis->Core.pfnRead = rtldrRdrMem_Read;
250 pThis->Core.pfnTell = rtldrRdrMem_Tell;
251 pThis->Core.pfnSize = rtldrRdrMem_Size;
252 pThis->Core.pfnLogName = rtldrRdrMem_LogName;
253 pThis->Core.pfnMap = rtldrRdrMem_Map;
254 pThis->Core.pfnUnmap = rtldrRdrMem_Unmap;
255 pThis->Core.pfnDestroy = rtldrRdrMem_Destroy;
256 *ppReader = &pThis->Core;
257 return VINF_SUCCESS;
258 }
259
260 *ppReader = NULL;
261 return rc;
262}
263
264
265RTDECL(int) RTLdrOpenInMemory(const char *pszName, uint32_t fFlags, RTLDRARCH enmArch, size_t cbImage,
266 PFNRTLDRRDRMEMREAD pfnRead, PFNRTLDRRDRMEMDTOR pfnDtor, void *pvUser,
267 PRTLDRMOD phLdrMod)
268{
269 LogFlow(("RTLdrOpenInMemory: pszName=%p:{%s} fFlags=%#x enmArch=%d cbImage=%#zx pfnRead=%p pfnDtor=%p pvUser=%p phLdrMod=%p\n",
270 pszName, pszName, fFlags, enmArch, cbImage, pfnRead, pfnDtor, pvUser, phLdrMod));
271
272 if (!pfnRead || !pfnDtor)
273 AssertPtrReturn(pvUser, VERR_INVALID_POINTER);
274 if (!pfnDtor)
275 pfnDtor = rtldrRdrMemDefaultDtor;
276 else
277 AssertPtrReturn(pfnRead, VERR_INVALID_POINTER);
278
279 /* The rest of the validations will call the destructor. */
280 AssertMsgReturnStmt(!(fFlags & ~RTLDR_O_VALID_MASK), ("%#x\n", fFlags),
281 pfnDtor(pvUser), VERR_INVALID_PARAMETER);
282 AssertMsgReturnStmt(enmArch > RTLDRARCH_INVALID && enmArch < RTLDRARCH_END, ("%d\n", enmArch),
283 pfnDtor(pvUser), VERR_INVALID_PARAMETER);
284 if (!pfnRead)
285 pfnRead = rtldrRdrMemDefaultReader;
286 else
287 AssertReturnStmt(RT_VALID_PTR(pfnRead), pfnDtor(pvUser), VERR_INVALID_POINTER);
288 AssertReturnStmt(cbImage > 0, pfnDtor(pvUser), VERR_INVALID_PARAMETER);
289
290 /*
291 * Resolve RTLDRARCH_HOST.
292 */
293 if (enmArch == RTLDRARCH_HOST)
294#if defined(RT_ARCH_AMD64)
295 enmArch = RTLDRARCH_AMD64;
296#elif defined(RT_ARCH_X86)
297 enmArch = RTLDRARCH_X86_32;
298#else
299 enmArch = RTLDRARCH_WHATEVER;
300#endif
301
302 /*
303 * Create file reader & invoke worker which identifies and calls the image interpreter.
304 */
305 PRTLDRREADER pReader = NULL; /* gcc may be wrong */
306 int rc = rtldrRdrMem_Create(&pReader, pszName, cbImage, pfnRead, pfnDtor, pvUser);
307 if (RT_SUCCESS(rc))
308 {
309 rc = RTLdrOpenWithReader(pReader, fFlags, enmArch, phLdrMod, NULL);
310 if (RT_SUCCESS(rc))
311 {
312 LogFlow(("RTLdrOpen: return %Rrc *phLdrMod=%p\n", rc, *phLdrMod));
313 return rc;
314 }
315
316 pReader->pfnDestroy(pReader);
317 }
318 else
319 pfnDtor(pvUser);
320 *phLdrMod = NIL_RTLDRMOD;
321
322 LogFlow(("RTLdrOpen: return %Rrc\n", rc));
323 return rc;
324}
325RT_EXPORT_SYMBOL(RTLdrOpenInMemory);
326
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