VirtualBox

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

Last change on this file since 38547 was 38547, checked in by vboxsync, 14 years ago

IPRT: More debug info hacking.

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