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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
/* $Id: dbgmodldr.cpp $ */
/** @file
* IPRT - Debug Module Image Interpretation by RTLdr.
*/
/*
* Copyright (C) 2011-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#include <iprt/dbg.h>
#include "internal/iprt.h"
#include <iprt/assert.h>
#include <iprt/errcore.h>
#include <iprt/file.h>
#include <iprt/ldr.h>
#include <iprt/mem.h>
#include <iprt/param.h>
#include <iprt/path.h>
#include <iprt/string.h>
#include "internal/dbgmod.h"
#include "internal/ldr.h"
#include "internal/magics.h"
/*********************************************************************************************************************************
* Structures and Typedefs *
*********************************************************************************************************************************/
/**
* The instance data of the RTLdr based image reader.
*/
typedef struct RTDBGMODLDR
{
/** Magic value (RTDBGMODLDR_MAGIC). */
uint32_t u32Magic;
/** The loader handle. */
RTLDRMOD hLdrMod;
} RTDBGMODLDR;
/** Pointer to instance data NM map reader. */
typedef RTDBGMODLDR *PRTDBGMODLDR;
/** @interface_method_impl{RTDBGMODVTDBG,pfnUnwindFrame} */
static DECLCALLBACK(int) rtDbgModLdr_UnwindFrame(PRTDBGMODINT pMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTDBGUNWINDSTATE pState)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
return RTLdrUnwindFrame(pThis->hLdrMod, NULL, iSeg, off, pState);
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnQueryProp} */
static DECLCALLBACK(int) rtDbgModLdr_QueryProp(PRTDBGMODINT pMod, RTLDRPROP enmProp, void *pvBuf, size_t cbBuf, size_t *pcbRet)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
return RTLdrQueryPropEx(pThis->hLdrMod, enmProp, NULL /*pvBits*/, pvBuf, cbBuf, pcbRet);
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnGetArch} */
static DECLCALLBACK(RTLDRARCH) rtDbgModLdr_GetArch(PRTDBGMODINT pMod)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
return RTLdrGetArch(pThis->hLdrMod);
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnGetFormat} */
static DECLCALLBACK(RTLDRFMT) rtDbgModLdr_GetFormat(PRTDBGMODINT pMod)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
return RTLdrGetFormat(pThis->hLdrMod);
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnReadAt} */
static DECLCALLBACK(int) rtDbgModLdr_ReadAt(PRTDBGMODINT pMod, uint32_t iDbgInfoHint, RTFOFF off, void *pvBuf, size_t cb)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
RT_NOREF_PV(iDbgInfoHint);
return rtLdrReadAt(pThis->hLdrMod, pvBuf, UINT32_MAX /** @todo iDbgInfo*/, off, cb);
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnUnmapPart} */
static DECLCALLBACK(int) rtDbgModLdr_UnmapPart(PRTDBGMODINT pMod, size_t cb, void const **ppvMap)
{
Assert(((PRTDBGMODLDR)pMod->pvImgPriv)->u32Magic == RTDBGMODLDR_MAGIC);
NOREF(pMod); NOREF(cb);
RTMemFree((void *)*ppvMap);
*ppvMap = NULL;
return VINF_SUCCESS;
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnMapPart} */
static DECLCALLBACK(int) rtDbgModLdr_MapPart(PRTDBGMODINT pMod, uint32_t iDbgInfo, RTFOFF off, size_t cb, void const **ppvMap)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
void *pvMap = RTMemAlloc(cb);
if (!pvMap)
return VERR_NO_MEMORY;
int rc = rtLdrReadAt(pThis->hLdrMod, pvMap, iDbgInfo, off, cb);
if (RT_SUCCESS(rc))
*ppvMap = pvMap;
else
{
RTMemFree(pvMap);
*ppvMap = NULL;
}
return rc;
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnImageSize} */
static DECLCALLBACK(RTUINTPTR) rtDbgModLdr_ImageSize(PRTDBGMODINT pMod)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
return RTLdrSize(pThis->hLdrMod);
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnRvaToSegOffset} */
static DECLCALLBACK(int) rtDbgModLdr_RvaToSegOffset(PRTDBGMODINT pMod, RTLDRADDR Rva, PRTDBGSEGIDX piSeg, PRTLDRADDR poffSeg)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
return RTLdrRvaToSegOffset(pThis->hLdrMod, Rva, piSeg, poffSeg);
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnLinkAddressToSegOffset} */
static DECLCALLBACK(int) rtDbgModLdr_LinkAddressToSegOffset(PRTDBGMODINT pMod, RTLDRADDR LinkAddress,
PRTDBGSEGIDX piSeg, PRTLDRADDR poffSeg)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
return RTLdrLinkAddressToSegOffset(pThis->hLdrMod, LinkAddress, piSeg, poffSeg);
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnEnumSymbols} */
static DECLCALLBACK(int) rtDbgModLdr_EnumSymbols(PRTDBGMODINT pMod, uint32_t fFlags, RTLDRADDR BaseAddress,
PFNRTLDRENUMSYMS pfnCallback, void *pvUser)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
return RTLdrEnumSymbols(pThis->hLdrMod, fFlags, NULL /*pvBits*/, BaseAddress, pfnCallback, pvUser);
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnEnumSegments} */
static DECLCALLBACK(int) rtDbgModLdr_EnumSegments(PRTDBGMODINT pMod, PFNRTLDRENUMSEGS pfnCallback, void *pvUser)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
return RTLdrEnumSegments(pThis->hLdrMod, pfnCallback, pvUser);
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnEnumDbgInfo} */
static DECLCALLBACK(int) rtDbgModLdr_EnumDbgInfo(PRTDBGMODINT pMod, PFNRTLDRENUMDBG pfnCallback, void *pvUser)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
return RTLdrEnumDbgInfo(pThis->hLdrMod, NULL, pfnCallback, pvUser);
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnClose} */
static DECLCALLBACK(int) rtDbgModLdr_Close(PRTDBGMODINT pMod)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)pMod->pvImgPriv;
AssertPtr(pThis);
Assert(pThis->u32Magic == RTDBGMODLDR_MAGIC);
int rc = RTLdrClose(pThis->hLdrMod); AssertRC(rc);
pThis->hLdrMod = NIL_RTLDRMOD;
pThis->u32Magic = RTDBGMODLDR_MAGIC_DEAD;
RTMemFree(pThis);
return VINF_SUCCESS;
}
/** @interface_method_impl{RTDBGMODVTIMG,pfnTryOpen} */
static DECLCALLBACK(int) rtDbgModLdr_TryOpen(PRTDBGMODINT pMod, RTLDRARCH enmArch, uint32_t fLdrFlags)
{
RTLDRMOD hLdrMod;
int rc = RTLdrOpen(pMod->pszImgFile, RTLDR_O_FOR_DEBUG | fLdrFlags, enmArch, &hLdrMod);
if (RT_SUCCESS(rc))
{
rc = rtDbgModLdrOpenFromHandle(pMod, hLdrMod);
if (RT_FAILURE(rc))
RTLdrClose(hLdrMod);
}
return rc;
}
/** Virtual function table for the RTLdr based image reader. */
DECL_HIDDEN_CONST(RTDBGMODVTIMG) const g_rtDbgModVtImgLdr =
{
/*.u32Magic = */ RTDBGMODVTIMG_MAGIC,
/*.fReserved = */ 0,
/*.pszName = */ "RTLdr",
/*.pfnTryOpen = */ rtDbgModLdr_TryOpen,
/*.pfnClose = */ rtDbgModLdr_Close,
/*.pfnEnumDbgInfo = */ rtDbgModLdr_EnumDbgInfo,
/*.pfnEnumSegments = */ rtDbgModLdr_EnumSegments,
/*.pfnEnumSymbols = */ rtDbgModLdr_EnumSymbols,
/*.pfnImageSize = */ rtDbgModLdr_ImageSize,
/*.pfnLinkAddressToSegOffset = */ rtDbgModLdr_LinkAddressToSegOffset,
/*.pfnRvaToSegOffset= */ rtDbgModLdr_RvaToSegOffset,
/*.pfnMapPart = */ rtDbgModLdr_MapPart,
/*.pfnUnmapPart = */ rtDbgModLdr_UnmapPart,
/*.pfnReadAt = */ rtDbgModLdr_ReadAt,
/*.pfnGetFormat = */ rtDbgModLdr_GetFormat,
/*.pfnGetArch = */ rtDbgModLdr_GetArch,
/*.pfnQueryProp = */ rtDbgModLdr_QueryProp,
/*.pfnUnwindFrame = */ rtDbgModLdr_UnwindFrame,
/*.u32EndMagic = */ RTDBGMODVTIMG_MAGIC
};
/**
* Open PE-image trick.
*
* @returns IPRT status code
* @param pDbgMod The debug module instance.
* @param hLdrMod The module to open a image debug backend for.
*/
DECLHIDDEN(int) rtDbgModLdrOpenFromHandle(PRTDBGMODINT pDbgMod, RTLDRMOD hLdrMod)
{
PRTDBGMODLDR pThis = (PRTDBGMODLDR)RTMemAllocZ(sizeof(RTDBGMODLDR));
if (!pThis)
return VERR_NO_MEMORY;
pThis->u32Magic = RTDBGMODLDR_MAGIC;
pThis->hLdrMod = hLdrMod;
pDbgMod->pvImgPriv = pThis;
return VINF_SUCCESS;
}
|
