VirtualBox

source: vbox/trunk/src/VBox/Runtime/common/dbg/dbgmodldr.cpp@ 95841

Last change on this file since 95841 was 93115, checked in by vboxsync, 3 years ago

scm --update-copyright-year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.0 KB
Line 
1/* $Id: dbgmodldr.cpp 93115 2022-01-01 11:31:46Z vboxsync $ */
2/** @file
3 * IPRT - Debug Module Image Interpretation by RTLdr.
4 */
5
6/*
7 * Copyright (C) 2011-2022 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#include <iprt/dbg.h>
32#include "internal/iprt.h"
33
34#include <iprt/assert.h>
35#include <iprt/errcore.h>
36#include <iprt/file.h>
37#include <iprt/ldr.h>
38#include <iprt/mem.h>
39#include <iprt/param.h>
40#include <iprt/path.h>
41#include <iprt/string.h>
42#include "internal/dbgmod.h"
43#include "internal/ldr.h"
44#include "internal/magics.h"
45
46
47/*********************************************************************************************************************************
48* Structures and Typedefs *
49*********************************************************************************************************************************/
50/**
51 * The instance data of the RTLdr based image reader.
52 */
53typedef struct RTDBGMODLDR
54{
55 /** Magic value (RTDBGMODLDR_MAGIC). */
56 uint32_t u32Magic;
57 /** The loader handle. */
58 RTLDRMOD hLdrMod;
59} RTDBGMODLDR;
60/** Pointer to instance data NM map reader. */
61typedef RTDBGMODLDR *PRTDBGMODLDR;
62
63
64
65/** @interface_method_impl{RTDBGMODVTDBG,pfnUnwindFrame} */
66static DECLCALLBACK(int) rtDbgModLdr_UnwindFrame(PRTDBGMODINT pMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTDBGUNWINDSTATE pState)
67{
68 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
69 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
70 return RTLdrUnwindFrame(pThis->hLdrMod, NULL, iSeg, off, pState);
71}
72
73
74/** @interface_method_impl{RTDBGMODVTIMG,pfnQueryProp} */
75static DECLCALLBACK(int) rtDbgModLdr_QueryProp(PRTDBGMODINT pMod, RTLDRPROP enmProp, void *pvBuf, size_t cbBuf, size_t *pcbRet)
76{
77 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
78 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
79 return RTLdrQueryPropEx(pThis->hLdrMod, enmProp, NULL /*pvBits*/, pvBuf, cbBuf, pcbRet);
80}
81
82
83/** @interface_method_impl{RTDBGMODVTIMG,pfnGetArch} */
84static DECLCALLBACK(RTLDRARCH) rtDbgModLdr_GetArch(PRTDBGMODINT pMod)
85{
86 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
87 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
88 return RTLdrGetArch(pThis->hLdrMod);
89}
90
91
92/** @interface_method_impl{RTDBGMODVTIMG,pfnGetFormat} */
93static DECLCALLBACK(RTLDRFMT) rtDbgModLdr_GetFormat(PRTDBGMODINT pMod)
94{
95 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
96 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
97 return RTLdrGetFormat(pThis->hLdrMod);
98}
99
100
101/** @interface_method_impl{RTDBGMODVTIMG,pfnReadAt} */
102static DECLCALLBACK(int) rtDbgModLdr_ReadAt(PRTDBGMODINT pMod, uint32_t iDbgInfoHint, RTFOFF off, void *pvBuf, size_t cb)
103{
104 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
105 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
106 RT_NOREF_PV(iDbgInfoHint);
107 return rtLdrReadAt(pThis->hLdrMod, pvBuf, UINT32_MAX /** @todo iDbgInfo*/, off, cb);
108}
109
110
111/** @interface_method_impl{RTDBGMODVTIMG,pfnUnmapPart} */
112static DECLCALLBACK(int) rtDbgModLdr_UnmapPart(PRTDBGMODINT pMod, size_t cb, void const **ppvMap)
113{
114 Assert(((PRTDBGMODLDR)pMod->pvImgPriv)->u32Magic == RTDBGMODLDR_MAGIC);
115 NOREF(pMod); NOREF(cb);
116 RTMemFree((void *)*ppvMap);
117 *ppvMap = NULL;
118 return VINF_SUCCESS;
119}
120
121
122/** @interface_method_impl{RTDBGMODVTIMG,pfnMapPart} */
123static DECLCALLBACK(int) rtDbgModLdr_MapPart(PRTDBGMODINT pMod, uint32_t iDbgInfo, RTFOFF off, size_t cb, void const **ppvMap)
124{
125 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
126 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
127
128 void *pvMap = RTMemAlloc(cb);
129 if (!pvMap)
130 return VERR_NO_MEMORY;
131
132 int rc = rtLdrReadAt(pThis->hLdrMod, pvMap, iDbgInfo, off, cb);
133 if (RT_SUCCESS(rc))
134 *ppvMap = pvMap;
135 else
136 {
137 RTMemFree(pvMap);
138 *ppvMap = NULL;
139 }
140 return rc;
141}
142
143
144/** @interface_method_impl{RTDBGMODVTIMG,pfnImageSize} */
145static DECLCALLBACK(RTUINTPTR) rtDbgModLdr_ImageSize(PRTDBGMODINT pMod)
146{
147 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
148 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
149 return RTLdrSize(pThis->hLdrMod);
150}
151
152
153/** @interface_method_impl{RTDBGMODVTIMG,pfnRvaToSegOffset} */
154static DECLCALLBACK(int) rtDbgModLdr_RvaToSegOffset(PRTDBGMODINT pMod, RTLDRADDR Rva, PRTDBGSEGIDX piSeg, PRTLDRADDR poffSeg)
155{
156 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
157 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
158 return RTLdrRvaToSegOffset(pThis->hLdrMod, Rva, piSeg, poffSeg);
159}
160
161
162/** @interface_method_impl{RTDBGMODVTIMG,pfnLinkAddressToSegOffset} */
163static DECLCALLBACK(int) rtDbgModLdr_LinkAddressToSegOffset(PRTDBGMODINT pMod, RTLDRADDR LinkAddress,
164 PRTDBGSEGIDX piSeg, PRTLDRADDR poffSeg)
165{
166 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
167 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
168 return RTLdrLinkAddressToSegOffset(pThis->hLdrMod, LinkAddress, piSeg, poffSeg);
169}
170
171
172/** @interface_method_impl{RTDBGMODVTIMG,pfnEnumSymbols} */
173static DECLCALLBACK(int) rtDbgModLdr_EnumSymbols(PRTDBGMODINT pMod, uint32_t fFlags, RTLDRADDR BaseAddress,
174 PFNRTLDRENUMSYMS pfnCallback, void *pvUser)
175{
176 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
177 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
178 return RTLdrEnumSymbols(pThis->hLdrMod, fFlags, NULL /*pvBits*/, BaseAddress, pfnCallback, pvUser);
179}
180
181
182/** @interface_method_impl{RTDBGMODVTIMG,pfnEnumSegments} */
183static DECLCALLBACK(int) rtDbgModLdr_EnumSegments(PRTDBGMODINT pMod, PFNRTLDRENUMSEGS pfnCallback, void *pvUser)
184{
185 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
186 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
187 return RTLdrEnumSegments(pThis->hLdrMod, pfnCallback, pvUser);
188}
189
190
191/** @interface_method_impl{RTDBGMODVTIMG,pfnEnumDbgInfo} */
192static DECLCALLBACK(int) rtDbgModLdr_EnumDbgInfo(PRTDBGMODINT pMod, PFNRTLDRENUMDBG pfnCallback, void *pvUser)
193{
194 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
195 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
196 return RTLdrEnumDbgInfo(pThis->hLdrMod, NULL, pfnCallback, pvUser);
197}
198
199
200/** @interface_method_impl{RTDBGMODVTIMG,pfnClose} */
201static DECLCALLBACK(int) rtDbgModLdr_Close(PRTDBGMODINT pMod)
202{
203 PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
204 AssertPtr(pThis);
205 Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
206
207 int rc = RTLdrClose(pThis->hLdrMod); AssertRC(rc);
208 pThis->hLdrMod = NIL_RTLDRMOD;
209 pThis->u32Magic = RTDBGMODLDR_MAGIC_DEAD;
210
211 RTMemFree(pThis);
212
213 return VINF_SUCCESS;
214}
215
216
217/** @interface_method_impl{RTDBGMODVTIMG,pfnTryOpen} */
218static DECLCALLBACK(int) rtDbgModLdr_TryOpen(PRTDBGMODINT pMod, RTLDRARCH enmArch, uint32_t fLdrFlags)
219{
220 RTLDRMOD hLdrMod;
221 int rc = RTLdrOpen(pMod->pszImgFile, RTLDR_O_FOR_DEBUG | fLdrFlags, enmArch, &hLdrMod);
222 if (RT_SUCCESS(rc))
223 {
224 rc = rtDbgModLdrOpenFromHandle(pMod, hLdrMod);
225 if (RT_FAILURE(rc))
226 RTLdrClose(hLdrMod);
227 }
228 return rc;
229}
230
231
232/** Virtual function table for the RTLdr based image reader. */
233DECL_HIDDEN_CONST(RTDBGMODVTIMG) const g_rtDbgModVtImgLdr =
234{
235 /*.u32Magic = */ RTDBGMODVTIMG_MAGIC,
236 /*.fReserved = */ 0,
237 /*.pszName = */ "RTLdr",
238 /*.pfnTryOpen = */ rtDbgModLdr_TryOpen,
239 /*.pfnClose = */ rtDbgModLdr_Close,
240 /*.pfnEnumDbgInfo = */ rtDbgModLdr_EnumDbgInfo,
241 /*.pfnEnumSegments = */ rtDbgModLdr_EnumSegments,
242 /*.pfnEnumSymbols = */ rtDbgModLdr_EnumSymbols,
243 /*.pfnImageSize = */ rtDbgModLdr_ImageSize,
244 /*.pfnLinkAddressToSegOffset = */ rtDbgModLdr_LinkAddressToSegOffset,
245 /*.pfnRvaToSegOffset= */ rtDbgModLdr_RvaToSegOffset,
246 /*.pfnMapPart = */ rtDbgModLdr_MapPart,
247 /*.pfnUnmapPart = */ rtDbgModLdr_UnmapPart,
248 /*.pfnReadAt = */ rtDbgModLdr_ReadAt,
249 /*.pfnGetFormat = */ rtDbgModLdr_GetFormat,
250 /*.pfnGetArch = */ rtDbgModLdr_GetArch,
251 /*.pfnQueryProp = */ rtDbgModLdr_QueryProp,
252 /*.pfnUnwindFrame = */ rtDbgModLdr_UnwindFrame,
253
254 /*.u32EndMagic = */ RTDBGMODVTIMG_MAGIC
255};
256
257
258/**
259 * Open PE-image trick.
260 *
261 * @returns IPRT status code
262 * @param pDbgMod The debug module instance.
263 * @param hLdrMod The module to open a image debug backend for.
264 */
265DECLHIDDEN(int) rtDbgModLdrOpenFromHandle(PRTDBGMODINT pDbgMod, RTLDRMOD hLdrMod)
266{
267 PRTDBGMODLDR pThis = (PRTDBGMODLDR)RTMemAllocZ(sizeof(RTDBGMODLDR));
268 if (!pThis)
269 return VERR_NO_MEMORY;
270
271 pThis->u32Magic = RTDBGMODLDR_MAGIC;
272 pThis->hLdrMod = hLdrMod;
273 pDbgMod->pvImgPriv = pThis;
274 return VINF_SUCCESS;
275}
276
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