VirtualBox

source: vbox/trunk/src/VBox/Runtime/tools/RTLdrFlt.cpp@ 45994

Last change on this file since 45994 was 45994, checked in by vboxsync, 12 years ago

RTDbgModCreateFromPeImage: Mostly implemented.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.9 KB
Line 
1/* $Id: RTLdrFlt.cpp 45994 2013-05-12 19:16:16Z vboxsync $ */
2/** @file
3 * IPRT - Utility for translating addresses into symbols+offset.
4 */
5
6/*
7 * Copyright (C) 2006-2012 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/mem.h>
32#include <iprt/assert.h>
33#include <iprt/ctype.h>
34#include <iprt/dbg.h>
35#include <iprt/err.h>
36#include <iprt/getopt.h>
37#include <iprt/initterm.h>
38#include <iprt/message.h>
39#include <iprt/path.h>
40#include <iprt/stream.h>
41#include <iprt/string.h>
42
43
44
45/**
46 * Tries to parse out an address at the head of the string.
47 *
48 * @returns true if found address, false if not.
49 * @param psz Where to start parsing.
50 * @param pcchAddress Where to store the address length.
51 * @param pu64Address Where to store the address value.
52 */
53static bool TryParseAddress(const char *psz, size_t *pcchAddress, uint64_t *pu64Address)
54{
55 const char *pszStart = psz;
56
57 /*
58 * Hex prefix?
59 */
60 if (psz[0] == '0' && (psz[1] == 'x' || psz[1] == 'X'))
61 psz += 2;
62
63 /*
64 * How many hex digits? We want at least 4 and at most 16.
65 */
66 size_t off = 0;
67 while (RT_C_IS_XDIGIT(psz[off]))
68 off++;
69 if (off < 4 || off > 16)
70 return false;
71
72 /*
73 * Check for separator (xxxxxxxx'yyyyyyyy).
74 */
75 bool fHave64bitSep = off <= 8
76 && psz[off] == '\''
77 && RT_C_IS_XDIGIT(psz[off + 1])
78 && RT_C_IS_XDIGIT(psz[off + 2])
79 && RT_C_IS_XDIGIT(psz[off + 3])
80 && RT_C_IS_XDIGIT(psz[off + 4])
81 && RT_C_IS_XDIGIT(psz[off + 5])
82 && RT_C_IS_XDIGIT(psz[off + 6])
83 && RT_C_IS_XDIGIT(psz[off + 7])
84 && RT_C_IS_XDIGIT(psz[off + 8])
85 && !RT_C_IS_XDIGIT(psz[off + 9]);
86 if (fHave64bitSep)
87 {
88 uint32_t u32High;
89 int rc = RTStrToUInt32Ex(psz, NULL, 16, &u32High);
90 if (rc != VWRN_TRAILING_CHARS)
91 return false;
92
93 uint32_t u32Low;
94 rc = RTStrToUInt32Ex(&psz[off + 1], NULL, 16, &u32Low);
95 if ( rc != VINF_SUCCESS
96 && rc != VWRN_TRAILING_SPACES
97 && rc != VWRN_TRAILING_CHARS)
98 return false;
99
100 *pu64Address = RT_MAKE_U64(u32Low, u32High);
101 off += 1 + 8;
102 }
103 else
104 {
105 int rc = RTStrToUInt64Ex(psz, NULL, 16, pu64Address);
106 if ( rc != VINF_SUCCESS
107 && rc != VWRN_TRAILING_SPACES
108 && rc != VWRN_TRAILING_CHARS)
109 return false;
110 }
111
112 *pcchAddress = psz + off - pszStart;
113 return true;
114}
115
116
117int main(int argc, char **argv)
118{
119 int rc = RTR3InitExe(argc, &argv, 0);
120 if (RT_FAILURE(rc))
121 return RTMsgInitFailure(rc);
122
123 /*
124 * Create an empty address space that we can load modules and stuff into
125 * as we parse the parameters.
126 */
127 RTDBGAS hDbgAs;
128 rc = RTDbgAsCreate(&hDbgAs, 0, RTUINTPTR_MAX, "");
129 if (RT_FAILURE(rc))
130 return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTDBgAsCreate -> %Rrc", rc);
131
132 /*
133 * Create a debugging configuration instance to work with so that we can
134 * make use of (i.e. test) path searching and such.
135 */
136 RTDBGCFG hDbgCfg;
137 rc = RTDbgCfgCreate(&hDbgCfg, "IPRT");
138 if (RT_FAILURE(rc))
139 return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTDbgCfgCreate -> %Rrc", rc);
140
141 /*
142 * Parse arguments.
143 */
144 static const RTGETOPTDEF s_aOptions[] =
145 {
146 { "--input", 'i', RTGETOPT_REQ_STRING },
147 { "--pe-image", 'p', RTGETOPT_REQ_NOTHING },
148 { "--verbose", 'v', RTGETOPT_REQ_NOTHING },
149 };
150
151 PRTSTREAM pInput = g_pStdIn;
152 PRTSTREAM pOutput = g_pStdOut;
153 unsigned cVerbosityLevel = 0;
154 enum {
155 kOpenMethod_FromImage,
156 kOpenMethod_FromPeImage,
157 } enmOpenMethod = kOpenMethod_FromImage;
158
159 RTGETOPTUNION ValueUnion;
160 RTGETOPTSTATE GetState;
161 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, 0);
162 while ((rc = RTGetOpt(&GetState, &ValueUnion)))
163 {
164 switch (rc)
165 {
166 case 'i':
167 rc = RTStrmOpen(ValueUnion.psz, "r", &pInput);
168 if (RT_FAILURE(rc))
169 return RTMsgErrorExit(RTEXITCODE_FAILURE, "Failed to open '%s' for reading: %Rrc", ValueUnion.psz, rc);
170 break;
171
172 case 'p':
173 enmOpenMethod = kOpenMethod_FromPeImage;
174 break;
175
176 case 'v':
177 cVerbosityLevel++;
178 break;
179
180 case 'h':
181 RTPrintf("Usage: %s [options] <module> <address> [<module> <address> [..]]\n"
182 "\n"
183 "Options:\n"
184 " -i,--input=file\n"
185 " Specify a input file instead of standard input.\n"
186 " --pe-image\n"
187 " Use RTDbgModCreateFromPeImage to open the file."
188 " -v, --verbose\n"
189 " Display the address space before doing the filtering.\n"
190 " -h, -?, --help\n"
191 " Display this help text and exit successfully.\n"
192 " -V, --version\n"
193 " Display the revision and exit successfully.\n"
194 , RTPathFilename(argv[0]));
195 return RTEXITCODE_SUCCESS;
196
197 case 'V':
198 RTPrintf("$Revision: 45994 $\n");
199 return RTEXITCODE_SUCCESS;
200
201 case VINF_GETOPT_NOT_OPTION:
202 {
203 /* <module> <address> */
204 const char *pszModule = ValueUnion.psz;
205
206 rc = RTGetOptFetchValue(&GetState, &ValueUnion, RTGETOPT_REQ_UINT64 | RTGETOPT_FLAG_HEX);
207 if (RT_FAILURE(rc))
208 return RTGetOptPrintError(rc, &ValueUnion);
209 uint64_t u64Address = ValueUnion.u64;
210
211 RTDBGMOD hMod;
212 if (enmOpenMethod == kOpenMethod_FromImage)
213 rc = RTDbgModCreateFromImage(&hMod, pszModule, NULL, hDbgCfg);
214 else
215 rc = RTDbgModCreateFromPeImage(&hMod, pszModule, NULL, 0, 0, hDbgCfg);
216 if (RT_FAILURE(rc))
217 return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTDbgModCreateFromImage(,%s,,) -> %Rrc", pszModule, rc);
218
219 rc = RTDbgAsModuleLink(hDbgAs, hMod, u64Address, 0 /* fFlags */);
220 if (RT_FAILURE(rc))
221 return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTDbgAsModuleLink(,%s,%llx,) -> %Rrc", pszModule, u64Address, rc);
222 break;
223 }
224
225 default:
226 return RTGetOptPrintError(rc, &ValueUnion);
227 }
228 }
229
230 /*
231 * Display the address space.
232 */
233 if (cVerbosityLevel)
234 {
235 RTPrintf("*** Address Space Dump ***\n");
236 uint32_t cModules = RTDbgAsModuleCount(hDbgAs);
237 for (uint32_t iModule = 0; iModule < cModules; iModule++)
238 {
239 RTDBGMOD hDbgMod = RTDbgAsModuleByIndex(hDbgAs, iModule);
240 RTPrintf("Module #%u: %s\n", iModule, RTDbgModName(hDbgMod));
241
242 RTDBGASMAPINFO aMappings[128];
243 uint32_t cMappings = RT_ELEMENTS(aMappings);
244 rc = RTDbgAsModuleQueryMapByIndex(hDbgAs, iModule, &aMappings[0], &cMappings, 0 /*fFlags*/);
245 if (RT_SUCCESS(rc))
246 {
247 for (uint32_t iMapping = 0; iMapping < cMappings; iMapping++)
248 {
249 if (aMappings[iMapping].iSeg == NIL_RTDBGSEGIDX)
250 RTPrintf(" mapping #%u: %RTptr-%RTptr\n",
251 iMapping,
252 aMappings[iMapping].Address,
253 aMappings[iMapping].Address + RTDbgModImageSize(hDbgMod) - 1);
254 else
255 {
256 RTDBGSEGMENT SegInfo;
257 rc = RTDbgModSegmentByIndex(hDbgMod, aMappings[iMapping].iSeg, &SegInfo);
258 if (RT_SUCCESS(rc))
259 RTPrintf(" mapping #%u: %RTptr-%RTptr (segment #%u - '%s')",
260 iMapping,
261 aMappings[iMapping].Address,
262 aMappings[iMapping].Address + SegInfo.cb,
263 SegInfo.iSeg, SegInfo.szName);
264 else
265 RTPrintf(" mapping #%u: %RTptr-???????? (segment #%u)", iMapping, aMappings[iMapping].Address);
266 }
267
268 if (cVerbosityLevel > 1)
269 {
270 uint32_t cSymbols = RTDbgModSymbolCount(hDbgMod);
271 RTPrintf(" %u symbols\n", cSymbols);
272 for (uint32_t iSymbol = 0; iSymbol < cSymbols; iSymbol++)
273 {
274 RTDBGSYMBOL SymInfo;
275 rc = RTDbgModSymbolByOrdinal(hDbgMod, iSymbol, &SymInfo);
276 if (RT_SUCCESS(rc))
277 RTPrintf(" #%04u at %08x:%RTptr %05llx %s\n",
278 SymInfo.iOrdinal, SymInfo.iSeg, SymInfo.offSeg,
279 (uint64_t)SymInfo.cb, SymInfo.szName);
280 }
281 }
282 }
283 }
284 else
285 RTMsgError("RTDbgAsModuleQueryMapByIndex failed: %Rrc", rc);
286 RTDbgModRelease(hDbgMod);
287 }
288 RTPrintf("*** End of Address Space Dump ***\n");
289 }
290
291 /*
292 * Read text from standard input and see if there is anything we can translate.
293 */
294 for (;;)
295 {
296 /* Get a line. */
297 char szLine[_64K];
298 rc = RTStrmGetLine(pInput, szLine, sizeof(szLine));
299 if (rc == VERR_EOF)
300 break;
301 if (RT_FAILURE(rc))
302 return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTStrmGetLine() -> %Rrc\n", rc);
303
304 /*
305 * Search the line for potential addresses and replace them with
306 * symbols+offset.
307 */
308 const char *pszStart = szLine;
309 const char *psz = szLine;
310 char ch;
311 while ((ch = *psz) != '\0')
312 {
313 size_t cchAddress;
314 uint64_t u64Address;
315
316 if ( ( ch == '0'
317 && (psz[1] == 'x' || psz[1] == 'X')
318 && TryParseAddress(psz, &cchAddress, &u64Address))
319 || ( RT_C_IS_XDIGIT(ch)
320 && TryParseAddress(psz, &cchAddress, &u64Address))
321 )
322 {
323 /* Print. */
324 psz += cchAddress;
325 if (pszStart != psz)
326 RTStrmWrite(pOutput, pszStart, psz - pszStart);
327 pszStart = psz;
328
329 /* Try get the module. */
330 RTUINTPTR uAddr;
331 RTDBGSEGIDX iSeg;
332 RTDBGMOD hDbgMod;
333 rc = RTDbgAsModuleByAddr(hDbgAs, u64Address, &hDbgMod, &uAddr, &iSeg);
334 if (RT_SUCCESS(rc))
335 {
336 if (iSeg != UINT32_MAX)
337 RTStrmPrintf(pOutput, "=[%s:%u", RTDbgModName(hDbgMod), iSeg);
338 else
339 RTStrmPrintf(pOutput, "=[%s", RTDbgModName(hDbgMod), iSeg);
340
341 /*
342 * Do we have symbols?
343 */
344 RTDBGSYMBOL Symbol;
345 RTINTPTR offSym;
346 rc = RTDbgAsSymbolByAddr(hDbgAs, u64Address, RTDBGSYMADDR_FLAGS_LESS_OR_EQUAL, &offSym, &Symbol, NULL);
347 if (RT_SUCCESS(rc))
348 {
349 if (!offSym)
350 RTStrmPrintf(pOutput, "!%s", Symbol.szName);
351 else if (offSym > 0)
352 RTStrmPrintf(pOutput, "!%s+%#llx", Symbol.szName, offSym);
353 else
354 RTStrmPrintf(pOutput, "!%s-%#llx", Symbol.szName, -offSym);
355 }
356 else
357 RTStrmPrintf(pOutput, "+%#llx", u64Address - uAddr);
358
359 /*
360 * Do we have line numbers?
361 */
362 RTDBGLINE Line;
363 RTINTPTR offLine;
364 rc = RTDbgAsLineByAddr(hDbgAs, u64Address, &offLine, &Line);
365 if (RT_SUCCESS(rc))
366 RTStrmPrintf(pOutput, " %Rbn(%u)", Line.szFilename, Line.uLineNo);
367
368 RTStrmPrintf(pOutput, "]");
369 RTDbgModRelease(hDbgMod);
370 }
371 }
372 else
373 psz++;
374 }
375
376 if (pszStart != psz)
377 RTStrmWrite(pOutput, pszStart, psz - pszStart);
378 RTStrmPutCh(pOutput, '\n');
379
380 }
381
382 return RTEXITCODE_SUCCESS;
383}
384
Note: See TracBrowser for help on using the repository browser.

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