RTLdrFlt.cpp@ 46083

Last change on this file since 46083 was 46083, checked in by vboxsync, 12 years ago
Made it possible to find symbols for windows nt using a image-in-guest-memory loader fallback.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 15.0 KB

Line
1	/* $Id: RTLdrFlt.cpp 46083 2013-05-14 23:39:28Z 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	*/
53	static 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
117	int 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", true /fNativePaths/);
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	{ "--local-file", 'l', RTGETOPT_REQ_NOTHING },
148	{ "--cache-file", 'c', RTGETOPT_REQ_NOTHING },
149	{ "--pe-image", 'p', RTGETOPT_REQ_NOTHING },
150	{ "--verbose", 'v', RTGETOPT_REQ_NOTHING },
151	};
152
153	PRTSTREAM pInput = g_pStdIn;
154	PRTSTREAM pOutput = g_pStdOut;
155	unsigned cVerbosityLevel = 0;
156	enum {
157	kOpenMethod_FromImage,
158	kOpenMethod_FromPeImage
159	} enmOpenMethod = kOpenMethod_FromImage;
160	bool fCacheFile = false;
161
162	RTGETOPTUNION ValueUnion;
163	RTGETOPTSTATE GetState;
164	RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, 0);
165	while ((rc = RTGetOpt(&GetState, &ValueUnion)))
166	{
167	switch (rc)
168	{
169	case 'i':
170	rc = RTStrmOpen(ValueUnion.psz, "r", &pInput);
171	if (RT_FAILURE(rc))
172	return RTMsgErrorExit(RTEXITCODE_FAILURE, "Failed to open '%s' for reading: %Rrc", ValueUnion.psz, rc);
173	break;
174
175	case 'c':
176	fCacheFile = true;
177	break;
178
179	case 'l':
180	fCacheFile = false;
181	break;
182
183	case 'p':
184	enmOpenMethod = kOpenMethod_FromPeImage;
185	break;
186
187	case 'v':
188	cVerbosityLevel++;
189	break;
190
191	case 'h':
192	RTPrintf("Usage: %s [options] <module> <address> [<module> <address> [..]]\n"
193	"\n"
194	"Options:\n"
195	" -i,--input=file\n"
196	" Specify a input file instead of standard input.\n"
197	" --pe-image\n"
198	" Use RTDbgModCreateFromPeImage to open the file."
199	" -v, --verbose\n"
200	" Display the address space before doing the filtering.\n"
201	" -h, -?, --help\n"
202	" Display this help text and exit successfully.\n"
203	" -V, --version\n"
204	" Display the revision and exit successfully.\n"
205	, RTPathFilename(argv[0]));
206	return RTEXITCODE_SUCCESS;
207
208	case 'V':
209	RTPrintf("$Revision: 46083 $\n");
210	return RTEXITCODE_SUCCESS;
211
212	case VINF_GETOPT_NOT_OPTION:
213	{
214	/* <module> <address> */
215	const char *pszModule = ValueUnion.psz;
216
217	rc = RTGetOptFetchValue(&GetState, &ValueUnion, RTGETOPT_REQ_UINT64 \| RTGETOPT_FLAG_HEX);
218	if (RT_FAILURE(rc))
219	return RTGetOptPrintError(rc, &ValueUnion);
220	uint64_t u64Address = ValueUnion.u64;
221
222	uint32_t cbImage = 0;
223	uint32_t uTimestamp = 0;
224	if (fCacheFile)
225	{
226	rc = RTGetOptFetchValue(&GetState, &ValueUnion, RTGETOPT_REQ_UINT32 \| RTGETOPT_FLAG_HEX);
227	if (RT_FAILURE(rc))
228	return RTGetOptPrintError(rc, &ValueUnion);
229	cbImage = ValueUnion.u32;
230
231	rc = RTGetOptFetchValue(&GetState, &ValueUnion, RTGETOPT_REQ_UINT32 \| RTGETOPT_FLAG_HEX);
232	if (RT_FAILURE(rc))
233	return RTGetOptPrintError(rc, &ValueUnion);
234	uTimestamp = ValueUnion.u32;
235	}
236
237	RTDBGMOD hMod;
238	if (enmOpenMethod == kOpenMethod_FromImage)
239	rc = RTDbgModCreateFromImage(&hMod, pszModule, NULL, hDbgCfg);
240	else
241	rc = RTDbgModCreateFromPeImage(&hMod, pszModule, NULL, NIL_RTLDRMOD, cbImage, uTimestamp, hDbgCfg);
242	if (RT_FAILURE(rc))
243	return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTDbgModCreateFromImage(,%s,,) -> %Rrc", pszModule, rc);
244
245	rc = RTDbgAsModuleLink(hDbgAs, hMod, u64Address, 0 /* fFlags */);
246	if (RT_FAILURE(rc))
247	return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTDbgAsModuleLink(,%s,%llx,) -> %Rrc", pszModule, u64Address, rc);
248	break;
249	}
250
251	default:
252	return RTGetOptPrintError(rc, &ValueUnion);
253	}
254	}
255
256	/*
257	* Display the address space.
258	*/
259	if (cVerbosityLevel)
260	{
261	RTPrintf("* Address Space Dump *\n");
262	uint32_t cModules = RTDbgAsModuleCount(hDbgAs);
263	for (uint32_t iModule = 0; iModule < cModules; iModule++)
264	{
265	RTDBGMOD hDbgMod = RTDbgAsModuleByIndex(hDbgAs, iModule);
266	RTPrintf("Module #%u: %s\n", iModule, RTDbgModName(hDbgMod));
267
268	RTDBGASMAPINFO aMappings[128];
269	uint32_t cMappings = RT_ELEMENTS(aMappings);
270	rc = RTDbgAsModuleQueryMapByIndex(hDbgAs, iModule, &aMappings[0], &cMappings, 0 /fFlags/);
271	if (RT_SUCCESS(rc))
272	{
273	for (uint32_t iMapping = 0; iMapping < cMappings; iMapping++)
274	{
275	if (aMappings[iMapping].iSeg == NIL_RTDBGSEGIDX)
276	RTPrintf(" mapping #%u: %RTptr-%RTptr\n",
277	iMapping,
278	aMappings[iMapping].Address,
279	aMappings[iMapping].Address + RTDbgModImageSize(hDbgMod) - 1);
280	else
281	{
282	RTDBGSEGMENT SegInfo;
283	rc = RTDbgModSegmentByIndex(hDbgMod, aMappings[iMapping].iSeg, &SegInfo);
284	if (RT_SUCCESS(rc))
285	RTPrintf(" mapping #%u: %RTptr-%RTptr (segment #%u - '%s')",
286	iMapping,
287	aMappings[iMapping].Address,
288	aMappings[iMapping].Address + SegInfo.cb,
289	SegInfo.iSeg, SegInfo.szName);
290	else
291	RTPrintf(" mapping #%u: %RTptr-???????? (segment #%u)", iMapping, aMappings[iMapping].Address);
292	}
293
294	if (cVerbosityLevel > 1)
295	{
296	uint32_t cSymbols = RTDbgModSymbolCount(hDbgMod);
297	RTPrintf(" %u symbols\n", cSymbols);
298	for (uint32_t iSymbol = 0; iSymbol < cSymbols; iSymbol++)
299	{
300	RTDBGSYMBOL SymInfo;
301	rc = RTDbgModSymbolByOrdinal(hDbgMod, iSymbol, &SymInfo);
302	if (RT_SUCCESS(rc))
303	RTPrintf(" #%04u at %08x:%RTptr %05llx %s\n",
304	SymInfo.iOrdinal, SymInfo.iSeg, SymInfo.offSeg,
305	(uint64_t)SymInfo.cb, SymInfo.szName);
306	}
307	}
308	}
309	}
310	else
311	RTMsgError("RTDbgAsModuleQueryMapByIndex failed: %Rrc", rc);
312	RTDbgModRelease(hDbgMod);
313	}
314	RTPrintf("* End of Address Space Dump *\n");
315	}
316
317	/*
318	* Read text from standard input and see if there is anything we can translate.
319	*/
320	for (;;)
321	{
322	/* Get a line. */
323	char szLine[_64K];
324	rc = RTStrmGetLine(pInput, szLine, sizeof(szLine));
325	if (rc == VERR_EOF)
326	break;
327	if (RT_FAILURE(rc))
328	return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTStrmGetLine() -> %Rrc\n", rc);
329
330	/*
331	* Search the line for potential addresses and replace them with
332	* symbols+offset.
333	*/
334	const char *pszStart = szLine;
335	const char *psz = szLine;
336	char ch;
337	while ((ch = *psz) != '\0')
338	{
339	size_t cchAddress;
340	uint64_t u64Address;
341
342	if ( ( ch == '0'
343	&& (psz[1] == 'x' \|\| psz[1] == 'X')
344	&& TryParseAddress(psz, &cchAddress, &u64Address))
345	\|\| ( RT_C_IS_XDIGIT(ch)
346	&& TryParseAddress(psz, &cchAddress, &u64Address))
347	)
348	{
349	/* Print. */
350	psz += cchAddress;
351	if (pszStart != psz)
352	RTStrmWrite(pOutput, pszStart, psz - pszStart);
353	pszStart = psz;
354
355	/* Try get the module. */
356	RTUINTPTR uAddr;
357	RTDBGSEGIDX iSeg;
358	RTDBGMOD hDbgMod;
359	rc = RTDbgAsModuleByAddr(hDbgAs, u64Address, &hDbgMod, &uAddr, &iSeg);
360	if (RT_SUCCESS(rc))
361	{
362	if (iSeg != UINT32_MAX)
363	RTStrmPrintf(pOutput, "=[%s:%u", RTDbgModName(hDbgMod), iSeg);
364	else
365	RTStrmPrintf(pOutput, "=[%s", RTDbgModName(hDbgMod), iSeg);
366
367	/*
368	* Do we have symbols?
369	*/
370	RTDBGSYMBOL Symbol;
371	RTINTPTR offSym;
372	rc = RTDbgAsSymbolByAddr(hDbgAs, u64Address, RTDBGSYMADDR_FLAGS_LESS_OR_EQUAL, &offSym, &Symbol, NULL);
373	if (RT_SUCCESS(rc))
374	{
375	if (!offSym)
376	RTStrmPrintf(pOutput, "!%s", Symbol.szName);
377	else if (offSym > 0)
378	RTStrmPrintf(pOutput, "!%s+%#llx", Symbol.szName, offSym);
379	else
380	RTStrmPrintf(pOutput, "!%s-%#llx", Symbol.szName, -offSym);
381	}
382	else
383	RTStrmPrintf(pOutput, "+%#llx", u64Address - uAddr);
384
385	/*
386	* Do we have line numbers?
387	*/
388	RTDBGLINE Line;
389	RTINTPTR offLine;
390	rc = RTDbgAsLineByAddr(hDbgAs, u64Address, &offLine, &Line);
391	if (RT_SUCCESS(rc))
392	RTStrmPrintf(pOutput, " %Rbn(%u)", Line.szFilename, Line.uLineNo);
393
394	RTStrmPrintf(pOutput, "]");
395	RTDbgModRelease(hDbgMod);
396	}
397	}
398	else
399	psz++;
400	}
401
402	if (pszStart != psz)
403	RTStrmWrite(pOutput, pszStart, psz - pszStart);
404	RTStrmPutCh(pOutput, '\n');
405
406	}
407
408	return RTEXITCODE_SUCCESS;
409	}
410

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: