VirtualBox

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

Last change on this file since 38636 was 38636, checked in by vboxsync, 13 years ago

*,IPRT: Redid the ring-3 init to always convert the arguments to UTF-8.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.0 KB
Line 
1/* $Id: RTLdrFlt.cpp 38636 2011-09-05 13:49:45Z vboxsync $ */
2/** @file
3 * IPRT - Utility for translating addresses into symbols+offset.
4 */
5
6/*
7 * Copyright (C) 2006-2011 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 /*
134 * Parse arguments.
135 */
136 static const RTGETOPTDEF s_aOptions[] =
137 {
138 { "--input", 'i', RTGETOPT_REQ_STRING },
139 { "--verbose", 'v', RTGETOPT_REQ_NOTHING },
140 };
141
142 PRTSTREAM pInput = g_pStdIn;
143 PRTSTREAM pOutput = g_pStdOut;
144 unsigned cVerbosityLevel = 0;
145
146 RTGETOPTUNION ValueUnion;
147 RTGETOPTSTATE GetState;
148 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, 0);
149 while ((rc = RTGetOpt(&GetState, &ValueUnion)))
150 {
151 switch (rc)
152 {
153 case 'i':
154 rc = RTStrmOpen(ValueUnion.psz, "r", &pInput);
155 if (RT_FAILURE(rc))
156 return RTMsgErrorExit(RTEXITCODE_FAILURE, "Failed to open '%s' for reading: %Rrc", ValueUnion.psz, rc);
157 break;
158
159 case 'v':
160 cVerbosityLevel++;
161 break;
162
163 case 'h':
164 RTPrintf("Usage: %s [options] <module> <address> [<module> <address> [..]]\n"
165 "\n"
166 "Options:\n"
167 " -i,--input=file\n"
168 " Specify a input file instead of standard input.\n"
169 " -v, --verbose\n"
170 " Display the address space before doing the filtering.\n"
171 " -h, -?, --help\n"
172 " Display this help text and exit successfully.\n"
173 " -V, --version\n"
174 " Display the revision and exit successfully.\n"
175 , RTPathFilename(argv[0]));
176 return RTEXITCODE_SUCCESS;
177
178 case 'V':
179 RTPrintf("$Revision: 38636 $\n");
180 return RTEXITCODE_SUCCESS;
181
182 case VINF_GETOPT_NOT_OPTION:
183 {
184 /* <module> <address> */
185 const char *pszModule = ValueUnion.psz;
186
187 rc = RTGetOptFetchValue(&GetState, &ValueUnion, RTGETOPT_REQ_UINT64 | RTGETOPT_FLAG_HEX);
188 if (RT_FAILURE(rc))
189 return RTGetOptPrintError(rc, &ValueUnion);
190 uint64_t u64Address = ValueUnion.u64;
191
192 RTDBGMOD hMod;
193 rc = RTDbgModCreateFromImage(&hMod, pszModule, NULL, 0 /*fFlags*/);
194 if (RT_FAILURE(rc))
195 return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTDbgModCreateFromImage(,%s,,) -> %Rrc", pszModule, rc);
196
197 rc = RTDbgAsModuleLink(hDbgAs, hMod, u64Address, 0 /* fFlags */);
198 if (RT_FAILURE(rc))
199 return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTDbgAsModuleLink(,%s,%llx,) -> %Rrc", pszModule, u64Address, rc);
200 break;
201 }
202
203 default:
204 return RTGetOptPrintError(rc, &ValueUnion);
205 }
206 }
207
208 /*
209 * Display the address space.
210 */
211 if (cVerbosityLevel)
212 {
213 RTPrintf("*** Address Space Dump ***\n");
214 uint32_t cModules = RTDbgAsModuleCount(hDbgAs);
215 for (uint32_t iModule = 0; iModule < cModules; iModule++)
216 {
217 RTDBGMOD hDbgMod = RTDbgAsModuleByIndex(hDbgAs, iModule);
218 RTPrintf("Module #%u: %s\n", iModule, RTDbgModName(hDbgMod));
219
220 RTDBGASMAPINFO aMappings[128];
221 uint32_t cMappings = RT_ELEMENTS(aMappings);
222 rc = RTDbgAsModuleQueryMapByIndex(hDbgAs, iModule, &aMappings[0], &cMappings, 0 /*fFlags*/);
223 if (RT_SUCCESS(rc))
224 {
225 for (uint32_t iMapping = 0; iMapping < cMappings; iMapping++)
226 {
227 if (aMappings[iMapping].iSeg == NIL_RTDBGSEGIDX)
228 RTPrintf(" mapping #%u: %RTptr-%RTptr\n",
229 iMapping,
230 aMappings[iMapping].Address,
231 aMappings[iMapping].Address + RTDbgModImageSize(hDbgMod) - 1);
232 else
233 {
234 RTDBGSEGMENT SegInfo;
235 rc = RTDbgModSegmentByIndex(hDbgMod, aMappings[iMapping].iSeg, &SegInfo);
236 if (RT_SUCCESS(rc))
237 RTPrintf(" mapping #%u: %RTptr-%RTptr (segment #%u - '%s')",
238 iMapping,
239 aMappings[iMapping].Address,
240 aMappings[iMapping].Address + SegInfo.cb,
241 SegInfo.iSeg, SegInfo.szName);
242 else
243 RTPrintf(" mapping #%u: %RTptr-???????? (segment #%u)", iMapping, aMappings[iMapping].Address);
244 }
245
246 if (cVerbosityLevel > 1)
247 {
248 uint32_t cSymbols = RTDbgModSymbolCount(hDbgMod);
249 RTPrintf(" %u symbols\n", cSymbols);
250 for (uint32_t iSymbol = 0; iSymbol < cSymbols; iSymbol++)
251 {
252 RTDBGSYMBOL SymInfo;
253 rc = RTDbgModSymbolByOrdinal(hDbgMod, iSymbol, &SymInfo);
254 if (RT_SUCCESS(rc))
255 RTPrintf(" #%04u at %08x:%RTptr %05llx %s\n",
256 SymInfo.iOrdinal, SymInfo.iSeg, SymInfo.offSeg,
257 (uint64_t)SymInfo.cb, SymInfo.szName);
258 }
259 }
260 }
261 }
262 else
263 RTMsgError("RTDbgAsModuleQueryMapByIndex failed: %Rrc", rc);
264 RTDbgModRelease(hDbgMod);
265 }
266 RTPrintf("*** End of Address Space Dump ***\n");
267 }
268
269 /*
270 * Read text from standard input and see if there is anything we can translate.
271 */
272 for (;;)
273 {
274 /* Get a line. */
275 char szLine[_64K];
276 rc = RTStrmGetLine(pInput, szLine, sizeof(szLine));
277 if (rc == VERR_EOF)
278 break;
279 if (RT_FAILURE(rc))
280 return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTStrmGetLine() -> %Rrc\n", rc);
281
282 /*
283 * Search the line for potential addresses and replace them with
284 * symbols+offset.
285 */
286 const char *pszStart = szLine;
287 const char *psz = szLine;
288 char ch;
289 while ((ch = *psz) != '\0')
290 {
291 size_t cchAddress;
292 uint64_t u64Address;
293
294 if ( ( ch == '0'
295 && (psz[1] == 'x' || psz[1] == 'X')
296 && TryParseAddress(psz, &cchAddress, &u64Address))
297 || ( RT_C_IS_XDIGIT(ch)
298 && TryParseAddress(psz, &cchAddress, &u64Address))
299 )
300 {
301 /* Print. */
302 psz += cchAddress;
303 if (pszStart != psz)
304 RTStrmWrite(pOutput, pszStart, psz - pszStart);
305 pszStart = psz;
306
307 /* Try get the module. */
308 RTUINTPTR uAddr;
309 RTDBGSEGIDX iSeg;
310 RTDBGMOD hDbgMod;
311 rc = RTDbgAsModuleByAddr(hDbgAs, u64Address, &hDbgMod, &uAddr, &iSeg);
312 if (RT_SUCCESS(rc))
313 {
314 if (iSeg != UINT32_MAX)
315 RTStrmPrintf(pOutput, "=[%s:%u", RTDbgModName(hDbgMod), iSeg);
316 else
317 RTStrmPrintf(pOutput, "=[%s", RTDbgModName(hDbgMod), iSeg);
318
319 /*
320 * Do we have symbols?
321 */
322 RTDBGSYMBOL Symbol;
323 RTINTPTR offSym;
324 rc = RTDbgAsSymbolByAddr(hDbgAs, u64Address, &offSym, &Symbol, NULL);
325 if (RT_SUCCESS(rc))
326 {
327 if (!offSym)
328 RTStrmPrintf(pOutput, "!%s", Symbol.szName);
329 else if (offSym > 0)
330 RTStrmPrintf(pOutput, "!%s+%#llx", Symbol.szName, offSym);
331 else
332 RTStrmPrintf(pOutput, "!%s-%#llx", Symbol.szName, -offSym);
333 }
334 else
335 RTStrmPrintf(pOutput, "+%#llx", u64Address - uAddr);
336
337 /*
338 * Do we have line numbers?
339 */
340 RTDBGLINE Line;
341 RTINTPTR offLine;
342 rc = RTDbgAsLineByAddr(hDbgAs, u64Address, &offLine, &Line);
343 if (RT_SUCCESS(rc))
344 RTStrmPrintf(pOutput, " %Rbn(%u)", Line.szFilename, Line.uLineNo);
345
346 RTStrmPrintf(pOutput, "]");
347 RTDbgModRelease(hDbgMod);
348 }
349 }
350 else
351 psz++;
352 }
353
354 if (pszStart != psz)
355 RTStrmWrite(pOutput, pszStart, psz - pszStart);
356 RTStrmPutCh(pOutput, '\n');
357
358 }
359
360 return RTEXITCODE_SUCCESS;
361}
362
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