PDMLdr.cpp@ 18851

Last change on this file since 18851 was 18431, checked in by vboxsync, 16 years ago
PDMLdr.cpp: Another annoying conversion warning, made the code paranoid while at it.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 38.2 KB

Line
1	/* $Id: PDMLdr.cpp 18431 2009-03-28 02:10:03Z vboxsync $ */
2	/** @file
3	* PDM - Pluggable Device Manager, module loader.
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 Sun Microsystems, Inc.
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	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18	* Clara, CA 95054 USA or visit http://www.sun.com if you need
19	* additional information or have any questions.
20	*/
21
22	//#define PDMLDR_FAKE_MODE
23
24	/*******************************************************************************
25	* Header Files *
26	*******************************************************************************/
27	#define LOG_GROUP LOG_GROUP_PDM_LDR
28	#include "PDMInternal.h"
29	#include <VBox/pdm.h>
30	#include <VBox/mm.h>
31	#include <VBox/vmm.h>
32	#include <VBox/vm.h>
33	#include <VBox/uvm.h>
34	#include <VBox/sup.h>
35	#include <VBox/param.h>
36	#include <VBox/err.h>
37	#include <VBox/hwaccm.h>
38
39	#include <VBox/log.h>
40	#include <iprt/assert.h>
41	#include <iprt/alloc.h>
42	#include <iprt/ldr.h>
43	#include <iprt/path.h>
44	#include <iprt/string.h>
45
46	#include <limits.h>
47
48
49	/*******************************************************************************
50	* Structures and Typedefs *
51	*******************************************************************************/
52	/**
53	* Structure which the user argument of the RTLdrGetBits() callback points to.
54	* @internal
55	*/
56	typedef struct PDMGETIMPORTARGS
57	{
58	PVM pVM;
59	PPDMMOD pModule;
60	} PDMGETIMPORTARGS, *PPDMGETIMPORTARGS;
61
62
63	/*******************************************************************************
64	* Internal Functions *
65	*******************************************************************************/
66	static DECLCALLBACK(int) pdmR3GetImportRC(RTLDRMOD hLdrMod, const char pszModule, const char pszSymbol, unsigned uSymbol, RTUINTPTR pValue, void pvUser);
67	static int pdmR3LoadR0U(PUVM pUVM, const char pszFilename, const char pszName);
68	static char * pdmR3FileRC(const char *pszFile);
69	static char * pdmR3FileR0(const char *pszFile);
70	static char * pdmR3File(const char pszFile, const char pszDefaultExt, bool fShared);
71	static DECLCALLBACK(int) pdmR3QueryModFromEIPEnumSymbols(RTLDRMOD hLdrMod, const char pszSymbol, unsigned uSymbol, RTUINTPTR Value, void pvUser);
72
73
74
75	/**
76	* Loads the VMMR0.r0 module early in the init process.
77	*
78	* @returns VBox status code.
79	* @param pUVM Pointer to the user mode VM structure.
80	*/
81	VMMR3DECL(int) PDMR3LdrLoadVMMR0U(PUVM pUVM)
82	{
83	return pdmR3LoadR0U(pUVM, NULL, VMMR0_MAIN_MODULE_NAME);
84	}
85
86
87	/**
88	* Init the module loader part of PDM.
89	*
90	* This routine will load the Host Context Ring-0 and Guest
91	* Context VMM modules.
92	*
93	* @returns VBox stutus code.
94	* @param pUVM Pointer to the user mode VM structure.
95	* @param pvVMMR0Mod The opqaue returned by PDMR3LdrLoadVMMR0.
96	*/
97	int pdmR3LdrInitU(PUVM pUVM)
98	{
99	#ifdef PDMLDR_FAKE_MODE
100	return VINF_SUCCESS;
101
102	#else
103
104	/*
105	* Load the mandatory GC module, the VMMR0.r0 is loaded before VM creation.
106	*/
107	return PDMR3LdrLoadRC(pUVM->pVM, NULL, VMMGC_MAIN_MODULE_NAME);
108	#endif
109	}
110
111
112	/**
113	* Terminate the module loader part of PDM.
114	*
115	* This will unload and free all modules.
116	*
117	* @param pVM The VM handle.
118	*
119	* @remarks This is normally called twice during termination.
120	*/
121	void pdmR3LdrTermU(PUVM pUVM)
122	{
123	/*
124	* Free the modules.
125	*/
126	PPDMMOD pModule = pUVM->pdm.s.pModules;
127	pUVM->pdm.s.pModules = NULL;
128	while (pModule)
129	{
130	/* free loader item. */
131	if (pModule->hLdrMod != NIL_RTLDRMOD)
132	{
133	int rc2 = RTLdrClose(pModule->hLdrMod);
134	AssertRC(rc2);
135	pModule->hLdrMod = NIL_RTLDRMOD;
136	}
137
138	/* free bits. */
139	switch (pModule->eType)
140	{
141	case PDMMOD_TYPE_R0:
142	{
143	Assert(pModule->ImageBase);
144	int rc2 = SUPFreeModule((void *)(uintptr_t)pModule->ImageBase);
145	AssertRC(rc2);
146	pModule->ImageBase = 0;
147	break;
148	}
149
150	case PDMMOD_TYPE_RC:
151	case PDMMOD_TYPE_R3:
152	/* MM will free this memory for us - it's alloc only memory. :-) */
153	break;
154
155	default:
156	AssertMsgFailed(("eType=%d\n", pModule->eType));
157	break;
158	}
159	pModule->pvBits = NULL;
160
161	void *pvFree = pModule;
162	pModule = pModule->pNext;
163	RTMemFree(pvFree);
164	}
165	}
166
167
168	/**
169	* Applies relocations to GC modules.
170	*
171	* This must be done very early in the relocation
172	* process so that components can resolve GC symbols during relocation.
173	*
174	* @param pUVM Pointer to the user mode VM structure.
175	* @param offDelta Relocation delta relative to old location.
176	*/
177	VMMR3DECL(void) PDMR3LdrRelocateU(PUVM pUVM, RTGCINTPTR offDelta)
178	{
179	LogFlow(("PDMR3LdrRelocate: offDelta=%RGv\n", offDelta));
180
181	/*
182	* GC Modules.
183	*/
184	if (pUVM->pdm.s.pModules)
185	{
186	/*
187	* The relocation have to be done in two passes so imports
188	* can be correctely resolved. The first pass will update
189	* the ImageBase saving the current value in OldImageBase.
190	* The second pass will do the actual relocation.
191	*/
192	/* pass 1 */
193	PPDMMOD pCur;
194	for (pCur = pUVM->pdm.s.pModules; pCur; pCur = pCur->pNext)
195	{
196	if (pCur->eType == PDMMOD_TYPE_RC)
197	{
198	pCur->OldImageBase = pCur->ImageBase;
199	pCur->ImageBase = MMHyperR3ToRC(pUVM->pVM, pCur->pvBits);
200	}
201	}
202
203	/* pass 2 */
204	for (pCur = pUVM->pdm.s.pModules; pCur; pCur = pCur->pNext)
205	{
206	if (pCur->eType == PDMMOD_TYPE_RC)
207	{
208	PDMGETIMPORTARGS Args;
209	Args.pVM = pUVM->pVM;
210	Args.pModule = pCur;
211	int rc = RTLdrRelocate(pCur->hLdrMod, pCur->pvBits, pCur->ImageBase, pCur->OldImageBase,
212	pdmR3GetImportRC, &Args);
213	AssertFatalMsgRC(rc, ("RTLdrRelocate failed, rc=%d\n", rc));
214	DBGFR3ModuleRelocate(pUVM->pVM, pCur->OldImageBase, pCur->ImageBase, RTLdrSize(pCur->hLdrMod),
215	pCur->szFilename, pCur->szName);
216	}
217	}
218	}
219	}
220
221
222	/**
223	* Loads a module into the host context ring-3.
224	*
225	* This is used by the driver and device init functions to load modules
226	* containing the drivers and devices. The function can be extended to
227	* load modules which are not native to the environment we're running in,
228	* but at the moment this is not required.
229	*
230	* No reference counting is kept, since we don't implement any facilities
231	* for unloading the module. But the module will naturally be released
232	* when the VM terminates.
233	*
234	* @returns VBox status code.
235	* @param pUVM Pointer to the user mode VM structure.
236	* @param pszFilename Filename of the module binary.
237	* @param pszName Module name. Case sensitive and the length is limited!
238	*/
239	int pdmR3LoadR3U(PUVM pUVM, const char pszFilename, const char pszName)
240	{
241	/*
242	* Validate input.
243	*/
244	AssertMsg(pUVM->pVM->pdm.s.offVM, ("bad init order!\n"));
245	Assert(pszFilename);
246	size_t cchFilename = strlen(pszFilename);
247	Assert(pszName);
248	size_t cchName = strlen(pszName);
249	PPDMMOD pCur;
250	if (cchName >= sizeof(pCur->szName))
251	{
252	AssertMsgFailed(("Name is too long, cchName=%d pszName='%s'\n", cchName, pszName));
253	return VERR_INVALID_PARAMETER;
254	}
255
256	/*
257	* Try lookup the name and see if the module exists.
258	*/
259	for (pCur = pUVM->pdm.s.pModules; pCur; pCur = pCur->pNext)
260	{
261	if (!strcmp(pCur->szName, pszName))
262	{
263	if (pCur->eType == PDMMOD_TYPE_R3)
264	return VINF_PDM_ALREADY_LOADED;
265	AssertMsgFailed(("We've already got a module '%s' loaded!\n", pszName));
266	return VERR_PDM_MODULE_NAME_CLASH;
267	}
268	}
269
270	/*
271	* Allocate the module list node and initialize it.
272	*/
273	const char *pszSuff = RTLdrGetSuff();
274	size_t cchSuff = RTPathHaveExt(pszFilename) ? 0 : strlen(pszSuff);
275	PPDMMOD pModule = (PPDMMOD)RTMemAllocZ(RT_OFFSETOF(PDMMOD, szFilename[cchFilename + cchSuff + 1]));
276	if (!pModule)
277	return VERR_NO_MEMORY;
278
279	pModule->eType = PDMMOD_TYPE_R3;
280	memcpy(pModule->szName, pszName, cchName); /* memory is zero'ed, no need to copy terminator :-) */
281	memcpy(pModule->szFilename, pszFilename, cchFilename);
282	memcpy(&pModule->szFilename[cchFilename], pszSuff, cchSuff);
283
284	/*
285	* Load the loader item.
286	*/
287	int rc = SUPR3HardenedVerifyFile(pModule->szFilename, "pdmR3LoadR3U", NULL);
288	if (RT_SUCCESS(rc))
289	rc = RTLdrLoad(pModule->szFilename, &pModule->hLdrMod);
290	if (RT_SUCCESS(rc))
291	{
292	pModule->pNext = pUVM->pdm.s.pModules;
293	pUVM->pdm.s.pModules = pModule;
294	return rc;
295	}
296
297	/* Something went wrong, most likely module not found. Don't consider other unlikely errors */
298	rc = VMSetError(pUVM->pVM, rc, RT_SRC_POS, N_("Unable to load R3 module %s (%s)"), pModule->szFilename, pszName);
299	RTMemFree(pModule);
300	return rc;
301	}
302
303
304	/**
305	* Resolve an external symbol during RTLdrGetBits() of a RC module.
306	*
307	* @returns VBox status code.
308	* @param hLdrMod The loader module handle.
309	* @param pszModule Module name.
310	* @param pszSymbol Symbol name, NULL if uSymbol should be used.
311	* @param uSymbol Symbol ordinal, ~0 if pszSymbol should be used.
312	* @param pValue Where to store the symbol value (address).
313	* @param pvUser User argument.
314	*/
315	static DECLCALLBACK(int) pdmR3GetImportRC(RTLDRMOD hLdrMod, const char pszModule, const char pszSymbol, unsigned uSymbol, RTUINTPTR pValue, void pvUser)
316	{
317	PVM pVM = ((PPDMGETIMPORTARGS)pvUser)->pVM;
318	PPDMMOD pModule = ((PPDMGETIMPORTARGS)pvUser)->pModule;
319
320	/*
321	* Adjust input.
322	*/
323	if (pszModule && !*pszModule)
324	pszModule = NULL;
325
326	/*
327	* Builtin module.
328	*/
329	if (!pszModule \|\| !strcmp(pszModule, "VMMGCBuiltin.gc"))
330	{
331	int rc = VINF_SUCCESS;
332	if (!strcmp(pszSymbol, "g_VM"))
333	*pValue = pVM->pVMRC;
334	else if (!strcmp(pszSymbol, "g_CPUM"))
335	*pValue = VM_RC_ADDR(pVM, &pVM->cpum);
336	else if (!strcmp(pszSymbol, "g_TRPM"))
337	*pValue = VM_RC_ADDR(pVM, &pVM->trpm);
338	else if ( !strncmp(pszSymbol, "VMM", 3)
339	\|\| !strcmp(pszSymbol, "g_Logger")
340	\|\| !strcmp(pszSymbol, "g_RelLogger"))
341	{
342	RTRCPTR RCPtr = 0;
343	rc = VMMR3GetImportRC(pVM, pszSymbol, &RCPtr);
344	if (RT_SUCCESS(rc))
345	*pValue = RCPtr;
346	}
347	else if ( !strncmp(pszSymbol, "TM", 2)
348	\|\| !strcmp(pszSymbol, "g_pSUPGlobalInfoPage"))
349	{
350	RTRCPTR RCPtr = 0;
351	rc = TMR3GetImportRC(pVM, pszSymbol, &RCPtr);
352	if (RT_SUCCESS(rc))
353	*pValue = RCPtr;
354	}
355	else
356	{
357	AssertMsg(!pszModule, ("Unknown builtin symbol '%s' for module '%s'!\n", pszSymbol, pModule->szName)); NOREF(pModule);
358	rc = VERR_SYMBOL_NOT_FOUND;
359	}
360	if (RT_SUCCESS(rc) \|\| pszModule)
361	return rc;
362	}
363
364	/*
365	* Search for module.
366	*/
367	PPDMMOD pCur = pVM->pUVM->pdm.s.pModules;
368	while (pCur)
369	{
370	if ( pCur->eType == PDMMOD_TYPE_RC
371	&& ( !pszModule
372	\|\| !strcmp(pCur->szName, pszModule))
373	)
374	{
375	/* Search for the symbol. */
376	int rc = RTLdrGetSymbolEx(pCur->hLdrMod, pCur->pvBits, pCur->ImageBase, pszSymbol, pValue);
377	if (RT_SUCCESS(rc))
378	{
379	AssertMsg(*pValue - pCur->ImageBase < RTLdrSize(pCur->hLdrMod),
380	("%RRv-%RRv %s %RRv\n", (RTRCPTR)pCur->ImageBase,
381	(RTRCPTR)(pCur->ImageBase + RTLdrSize(pCur->hLdrMod) - 1),
382	pszSymbol, (RTRCPTR)*pValue));
383	return rc;
384	}
385	if (pszModule)
386	{
387	AssertMsgFailed(("Couldn't find symbol '%s' in module '%s'!\n", pszSymbol, pszModule));
388	LogRel(("PDMLdr: Couldn't find symbol '%s' in module '%s'!\n", pszSymbol, pszModule));
389	return VERR_SYMBOL_NOT_FOUND;
390	}
391	}
392
393	/* next */
394	pCur = pCur->pNext;
395	}
396
397	AssertMsgFailed(("Couldn't find module '%s' for resolving symbol '%s'!\n", pszModule, pszSymbol));
398	return VERR_SYMBOL_NOT_FOUND;
399	}
400
401
402	/**
403	* Loads a module into the guest context (i.e. into the Hypervisor memory region).
404	*
405	* @returns VBox status code.
406	* @param pVM The VM to load it into.
407	* @param pszFilename Filename of the module binary.
408	* @param pszName Module name. Case sensitive and the length is limited!
409	*/
410	VMMR3DECL(int) PDMR3LdrLoadRC(PVM pVM, const char pszFilename, const char pszName)
411	{
412	/*
413	* Validate input.
414	*/
415	AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
416	PPDMMOD pCur = pVM->pUVM->pdm.s.pModules;
417	while (pCur)
418	{
419	if (!strcmp(pCur->szName, pszName))
420	{
421	AssertMsgFailed(("We've already got a module '%s' loaded!\n", pszName));
422	return VERR_PDM_MODULE_NAME_CLASH;
423	}
424	/* next */
425	pCur = pCur->pNext;
426	}
427
428	/*
429	* Find the file if not specified.
430	*/
431	char *pszFile = NULL;
432	if (!pszFilename)
433	pszFilename = pszFile = pdmR3FileRC(pszName);
434
435	/*
436	* Allocate the module list node.
437	*/
438	PPDMMOD pModule = (PPDMMOD)RTMemAllocZ(sizeof(*pModule) + strlen(pszFilename));
439	if (!pModule)
440	{
441	RTMemTmpFree(pszFile);
442	return VERR_NO_MEMORY;
443	}
444	AssertMsg(strlen(pszName) + 1 < sizeof(pModule->szName),
445	("pazName is too long (%d chars) max is %d chars.\n", strlen(pszName), sizeof(pModule->szName) - 1));
446	strcpy(pModule->szName, pszName);
447	pModule->eType = PDMMOD_TYPE_RC;
448	strcpy(pModule->szFilename, pszFilename);
449
450
451	/*
452	* Open the loader item.
453	*/
454	int rc = SUPR3HardenedVerifyFile(pszFilename, "PDMR3LdrLoadRC", NULL);
455	if (RT_SUCCESS(rc))
456	rc = RTLdrOpen(pszFilename, 0, RTLDRARCH_X86_32, &pModule->hLdrMod);
457	if (RT_SUCCESS(rc))
458	{
459	/*
460	* Allocate space in the hypervisor.
461	*/
462	size_t cb = RTLdrSize(pModule->hLdrMod);
463	cb = RT_ALIGN_Z(cb, PAGE_SIZE);
464	uint32_t cPages = (uint32_t)(cb >> PAGE_SHIFT);
465	if (((size_t)cPages << PAGE_SHIFT) == cb)
466	{
467	PSUPPAGE paPages = (PSUPPAGE)RTMemTmpAlloc(cPages * sizeof(paPages[0]));
468	if (paPages)
469	{
470	rc = SUPR3PageAllocEx(cPages, 0 /fFlags/, &pModule->pvBits, NULL /pR0Ptr/, paPages);
471	if (RT_SUCCESS(rc))
472	{
473	RTGCPTR GCPtr;
474	rc = MMR3HyperMapPages(pVM, pModule->pvBits, NIL_RTR0PTR,
475	cPages, paPages, pModule->szName, &GCPtr);
476	if (RT_SUCCESS(rc))
477	{
478	MMR3HyperReserve(pVM, PAGE_SIZE, "fence", NULL);
479
480	/*
481	* Get relocated image bits.
482	*/
483	Assert(MMHyperR3ToRC(pVM, pModule->pvBits) == GCPtr);
484	pModule->ImageBase = GCPtr;
485	PDMGETIMPORTARGS Args;
486	Args.pVM = pVM;
487	Args.pModule = pModule;
488	rc = RTLdrGetBits(pModule->hLdrMod, pModule->pvBits, pModule->ImageBase, pdmR3GetImportRC, &Args);
489	if (RT_SUCCESS(rc))
490	{
491	/*
492	* Insert the module.
493	*/
494	PUVM pUVM = pVM->pUVM;
495	if (pUVM->pdm.s.pModules)
496	{
497	/* we don't expect this list to be very long, so rather save the tail pointer. */
498	PPDMMOD pCur = pUVM->pdm.s.pModules;
499	while (pCur->pNext)
500	pCur = pCur->pNext;
501	pCur->pNext = pModule;
502	}
503	else
504	pUVM->pdm.s.pModules = pModule; /* (pNext is zeroed by alloc) */
505	Log(("PDM: RC Module at %RRv %s (%s)\n", (RTRCPTR)pModule->ImageBase, pszName, pszFilename));
506	RTMemTmpFree(pszFile);
507	RTMemTmpFree(paPages);
508	return VINF_SUCCESS;
509	}
510	}
511	else
512	{
513	AssertRC(rc);
514	SUPR3PageFreeEx(pModule->pvBits, cPages);
515	}
516	}
517	else
518	AssertMsgFailed(("SUPPageAlloc(%d,) -> %Rrc\n", cPages, rc));
519	RTMemTmpFree(paPages);
520	}
521	else
522	rc = VERR_NO_TMP_MEMORY;
523	}
524	else
525	rc = VERR_OUT_OF_RANGE;
526	int rc2 = RTLdrClose(pModule->hLdrMod);
527	AssertRC(rc2);
528	}
529	RTMemFree(pModule);
530	RTMemTmpFree(pszFile);
531
532	/* Don't consider VERR_PDM_MODULE_NAME_CLASH and VERR_NO_MEMORY above as these are very unlikely. */
533	if (RT_FAILURE(rc))
534	return VMSetError(pVM, rc, RT_SRC_POS, N_("Cannot load GC module %s"), pszFilename);
535	return rc;
536	}
537
538
539	/**
540	* Loads a module into the ring-0 context.
541	*
542	* @returns VBox status code.
543	* @param pUVM Pointer to the user mode VM structure.
544	* @param pszFilename Filename of the module binary.
545	* @param pszName Module name. Case sensitive and the length is limited!
546	*/
547	static int pdmR3LoadR0U(PUVM pUVM, const char pszFilename, const char pszName)
548	{
549	/*
550	* Validate input.
551	*/
552	PPDMMOD pCur = pUVM->pdm.s.pModules;
553	while (pCur)
554	{
555	if (!strcmp(pCur->szName, pszName))
556	{
557	AssertMsgFailed(("We've already got a module '%s' loaded!\n", pszName));
558	return VERR_PDM_MODULE_NAME_CLASH;
559	}
560	/* next */
561	pCur = pCur->pNext;
562	}
563
564	/*
565	* Find the file if not specified.
566	*/
567	char *pszFile = NULL;
568	if (!pszFilename)
569	pszFilename = pszFile = pdmR3FileR0(pszName);
570
571	/*
572	* Allocate the module list node.
573	*/
574	PPDMMOD pModule = (PPDMMOD)RTMemAllocZ(sizeof(*pModule) + strlen(pszFilename));
575	if (!pModule)
576	{
577	RTMemTmpFree(pszFile);
578	return VERR_NO_MEMORY;
579	}
580	AssertMsg(strlen(pszName) + 1 < sizeof(pModule->szName),
581	("pazName is too long (%d chars) max is %d chars.\n", strlen(pszName), sizeof(pModule->szName) - 1));
582	strcpy(pModule->szName, pszName);
583	pModule->eType = PDMMOD_TYPE_R0;
584	strcpy(pModule->szFilename, pszFilename);
585
586	/*
587	* Ask the support library to load it.
588	*/
589	void *pvImageBase;
590	int rc = SUPLoadModule(pszFilename, pszName, &pvImageBase);
591	if (RT_SUCCESS(rc))
592	{
593	pModule->hLdrMod = NIL_RTLDRMOD;
594	pModule->ImageBase = (uintptr_t)pvImageBase;
595
596	/*
597	* Insert the module.
598	*/
599	if (pUVM->pdm.s.pModules)
600	{
601	/* we don't expect this list to be very long, so rather save the tail pointer. */
602	PPDMMOD pCur = pUVM->pdm.s.pModules;
603	while (pCur->pNext)
604	pCur = pCur->pNext;
605	pCur->pNext = pModule;
606	}
607	else
608	pUVM->pdm.s.pModules = pModule; /* (pNext is zeroed by alloc) */
609	Log(("PDM: R0 Module at %RHv %s (%s)\n", (RTR0PTR)pModule->ImageBase, pszName, pszFilename));
610	RTMemTmpFree(pszFile);
611	return VINF_SUCCESS;
612	}
613
614	RTMemFree(pModule);
615	RTMemTmpFree(pszFile);
616	LogRel(("pdmR3LoadR0U: pszName=\"%s\" rc=%Rrc\n", pszName, rc));
617
618	/* Don't consider VERR_PDM_MODULE_NAME_CLASH and VERR_NO_MEMORY above as these are very unlikely. */
619	if (RT_FAILURE(rc) && pUVM->pVM) /** @todo VMR3SetErrorU. */
620	return VMSetError(pUVM->pVM, rc, RT_SRC_POS, N_("Cannot load R0 module %s"), pszFilename);
621	return rc;
622	}
623
624
625
626	/**
627	* Get the address of a symbol in a given HC ring 3 module.
628	*
629	* @returns VBox status code.
630	* @param pVM VM handle.
631	* @param pszModule Module name.
632	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
633	* ordinal value rather than a string pointer.
634	* @param ppvValue Where to store the symbol value.
635	*/
636	VMMR3DECL(int) PDMR3LdrGetSymbolR3(PVM pVM, const char pszModule, const char pszSymbol, void **ppvValue)
637	{
638	/*
639	* Validate input.
640	*/
641	AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
642
643	/*
644	* Find the module.
645	*/
646	for (PPDMMOD pModule = pVM->pUVM->pdm.s.pModules; pModule; pModule = pModule->pNext)
647	{
648	if ( pModule->eType == PDMMOD_TYPE_R3
649	&& !strcmp(pModule->szName, pszModule))
650	{
651	RTUINTPTR Value = 0;
652	int rc = RTLdrGetSymbolEx(pModule->hLdrMod, pModule->pvBits, pModule->ImageBase, pszSymbol, &Value);
653	if (RT_SUCCESS(rc))
654	{
655	ppvValue = (void )(uintptr_t)Value;
656	Assert((uintptr_t)*ppvValue == Value);
657	}
658	else
659	{
660	if ((uintptr_t)pszSymbol < 0x10000)
661	AssertMsg(rc, ("Couldn't symbol '%u' in module '%s'\n", (unsigned)(uintptr_t)pszSymbol, pszModule));
662	else
663	AssertMsg(rc, ("Couldn't symbol '%s' in module '%s'\n", pszSymbol, pszModule));
664	}
665	return rc;
666	}
667	}
668
669	AssertMsgFailed(("Couldn't locate module '%s'\n", pszModule));
670	return VERR_SYMBOL_NOT_FOUND;
671	}
672
673
674	/**
675	* Get the address of a symbol in a given HC ring 0 module.
676	*
677	* @returns VBox status code.
678	* @param pVM VM handle.
679	* @param pszModule Module name. If NULL the main R0 module (VMMR0.r0) is assumes.
680	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
681	* ordinal value rather than a string pointer.
682	* @param ppvValue Where to store the symbol value.
683	*/
684	VMMR3DECL(int) PDMR3LdrGetSymbolR0(PVM pVM, const char pszModule, const char pszSymbol, PRTR0PTR ppvValue)
685	{
686	#ifdef PDMLDR_FAKE_MODE
687	*ppvValue = 0xdeadbeef;
688	return VINF_SUCCESS;
689
690	#else
691	/*
692	* Validate input.
693	*/
694	AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
695	if (!pszModule)
696	pszModule = "VMMR0.r0";
697
698	/*
699	* Find the module.
700	*/
701	for (PPDMMOD pModule = pVM->pUVM->pdm.s.pModules; pModule; pModule = pModule->pNext)
702	{
703	if ( pModule->eType == PDMMOD_TYPE_R0
704	&& !strcmp(pModule->szName, pszModule))
705	{
706	int rc = SUPGetSymbolR0((void )(uintptr_t)pModule->ImageBase, pszSymbol, (void *)ppvValue);
707	if (RT_FAILURE(rc))
708	{
709	AssertMsgRC(rc, ("Couldn't find symbol '%s' in module '%s'\n", pszSymbol, pszModule));
710	LogRel(("PDMGetSymbol: Couldn't find symbol '%s' in module '%s'\n", pszSymbol, pszModule));
711	}
712	return rc;
713	}
714	}
715
716	AssertMsgFailed(("Couldn't locate module '%s'\n", pszModule));
717	return VERR_SYMBOL_NOT_FOUND;
718	#endif
719	}
720
721
722	/**
723	* Same as PDMR3LdrGetSymbolR0 except that the module will be attempted loaded if not found.
724	*
725	* @returns VBox status code.
726	* @param pVM VM handle.
727	* @param pszModule Module name. If NULL the main R0 module (VMMR0.r0) is assumed.
728	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
729	* ordinal value rather than a string pointer.
730	* @param ppvValue Where to store the symbol value.
731	*/
732	VMMR3DECL(int) PDMR3LdrGetSymbolR0Lazy(PVM pVM, const char pszModule, const char pszSymbol, PRTR0PTR ppvValue)
733	{
734	#ifdef PDMLDR_FAKE_MODE
735	*ppvValue = 0xdeadbeef;
736	return VINF_SUCCESS;
737
738	#else
739	/*
740	* Since we're lazy, we'll only check if the module is present
741	* and hand it over to PDMR3LdrGetSymbolR0 when that's done.
742	*/
743	AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
744	if (pszModule)
745	{
746	AssertMsgReturn(!strpbrk(pszModule, "/\\:\n\r\t"), ("pszModule=%s\n", pszModule), VERR_INVALID_PARAMETER);
747	PPDMMOD pModule;
748	for (pModule = pVM->pUVM->pdm.s.pModules; pModule; pModule = pModule->pNext)
749	if ( pModule->eType == PDMMOD_TYPE_R0
750	&& !strcmp(pModule->szName, pszModule))
751	break;
752	if (!pModule)
753	{
754	int rc = pdmR3LoadR0U(pVM->pUVM, NULL, pszModule);
755	AssertMsgRCReturn(rc, ("pszModule=%s rc=%Rrc\n", pszModule, rc), VERR_MODULE_NOT_FOUND);
756	}
757	}
758	return PDMR3LdrGetSymbolR0(pVM, pszModule, pszSymbol, ppvValue);
759	#endif
760	}
761
762
763	/**
764	* Get the address of a symbol in a given RC module.
765	*
766	* @returns VBox status code.
767	* @param pVM VM handle.
768	* @param pszModule Module name. If NULL the main R0 module (VMMGC.gc) is assumes.
769	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
770	* ordinal value rather than a string pointer.
771	* @param pRCPtrValue Where to store the symbol value.
772	*/
773	VMMR3DECL(int) PDMR3LdrGetSymbolRC(PVM pVM, const char pszModule, const char pszSymbol, PRTRCPTR pRCPtrValue)
774	{
775	#ifdef PDMLDR_FAKE_MODE
776	*pRCPtrValue = 0xfeedf00d;
777	return VINF_SUCCESS;
778
779	#else
780	/*
781	* Validate input.
782	*/
783	AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
784	if (!pszModule)
785	pszModule = "VMMGC.gc";
786
787	/*
788	* Find the module.
789	*/
790	for (PPDMMOD pModule = pVM->pUVM->pdm.s.pModules; pModule; pModule = pModule->pNext)
791	{
792	if ( pModule->eType == PDMMOD_TYPE_RC
793	&& !strcmp(pModule->szName, pszModule))
794	{
795	RTUINTPTR Value;
796	int rc = RTLdrGetSymbolEx(pModule->hLdrMod, pModule->pvBits, pModule->ImageBase, pszSymbol, &Value);
797	if (RT_SUCCESS(rc))
798	{
799	*pRCPtrValue = (RTGCPTR)Value;
800	Assert(*pRCPtrValue == Value);
801	}
802	else
803	{
804	if ((uintptr_t)pszSymbol < 0x10000)
805	AssertMsg(rc, ("Couldn't symbol '%u' in module '%s'\n", (unsigned)(uintptr_t)pszSymbol, pszModule));
806	else
807	AssertMsg(rc, ("Couldn't symbol '%s' in module '%s'\n", pszSymbol, pszModule));
808	}
809	return rc;
810	}
811	}
812
813	AssertMsgFailed(("Couldn't locate module '%s'\n", pszModule));
814	return VERR_SYMBOL_NOT_FOUND;
815	#endif
816	}
817
818
819	/**
820	* Same as PDMR3LdrGetSymbolRC except that the module will be attempted loaded if not found.
821	*
822	* @returns VBox status code.
823	* @param pVM VM handle.
824	* @param pszModule Module name. If NULL the main R0 module (VMMGC.gc) is assumes.
825	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
826	* ordinal value rather than a string pointer.
827	* @param pRCPtrValue Where to store the symbol value.
828	*/
829	VMMR3DECL(int) PDMR3LdrGetSymbolRCLazy(PVM pVM, const char pszModule, const char pszSymbol, PRTRCPTR pRCPtrValue)
830	{
831	#ifdef PDMLDR_FAKE_MODE
832	*pRCPtrValue = 0xfeedf00d;
833	return VINF_SUCCESS;
834
835	#else
836	/*
837	* Since we're lazy, we'll only check if the module is present
838	* and hand it over to PDMR3LdrGetSymbolRC when that's done.
839	*/
840	AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
841	if (pszModule)
842	{
843	AssertMsgReturn(!strpbrk(pszModule, "/\\:\n\r\t"), ("pszModule=%s\n", pszModule), VERR_INVALID_PARAMETER);
844	PPDMMOD pModule;
845	for (pModule = pVM->pUVM->pdm.s.pModules; pModule; pModule = pModule->pNext)
846	if ( pModule->eType == PDMMOD_TYPE_RC
847	&& !strcmp(pModule->szName, pszModule))
848	break;
849	if (!pModule)
850	{
851	char *pszFilename = pdmR3FileRC(pszModule);
852	AssertMsgReturn(pszFilename, ("pszModule=%s\n", pszModule), VERR_MODULE_NOT_FOUND);
853	int rc = PDMR3LdrLoadRC(pVM, pszFilename, pszModule);
854	RTMemTmpFree(pszFilename);
855	AssertMsgRCReturn(rc, ("pszModule=%s rc=%Rrc\n", pszModule, rc), VERR_MODULE_NOT_FOUND);
856	}
857	}
858	return PDMR3LdrGetSymbolRC(pVM, pszModule, pszSymbol, pRCPtrValue);
859	#endif
860	}
861
862
863	/**
864	* Constructs the full filename for a R3 image file.
865	*
866	* @returns Pointer to temporary memory containing the filename.
867	* Caller must free this using RTMemTmpFree().
868	* @returns NULL on failure.
869	*
870	* @param pszFile File name (no path).
871	*/
872	char pdmR3FileR3(const char pszFile, bool fShared)
873	{
874	return pdmR3File(pszFile, NULL, fShared);
875	}
876
877
878	/**
879	* Constructs the full filename for a R0 image file.
880	*
881	* @returns Pointer to temporary memory containing the filename.
882	* Caller must free this using RTMemTmpFree().
883	* @returns NULL on failure.
884	*
885	* @param pszFile File name (no path).
886	*/
887	char pdmR3FileR0(const char pszFile)
888	{
889	return pdmR3File(pszFile, NULL, /fShared=/false);
890	}
891
892
893	/**
894	* Constructs the full filename for a RC image file.
895	*
896	* @returns Pointer to temporary memory containing the filename.
897	* Caller must free this using RTMemTmpFree().
898	* @returns NULL on failure.
899	*
900	* @param pszFile File name (no path).
901	*/
902	char pdmR3FileRC(const char pszFile)
903	{
904	return pdmR3File(pszFile, NULL, /fShared=/false);
905	}
906
907
908	/**
909	* Worker for pdmR3File().
910	*
911	* @returns Pointer to temporary memory containing the filename.
912	* Caller must free this using RTMemTmpFree().
913	* @returns NULL on failure.
914	*
915	* @param pszDir Directory part
916	* @param pszFile File name part
917	* @param pszDefaultExt Extension part
918	*/
919	static char pdmR3FileConstruct(const char pszDir, const char pszFile, const char pszDefaultExt)
920	{
921	/*
922	* Allocate temp memory for return buffer.
923	*/
924	size_t cchDir = strlen(pszDir);
925	size_t cchFile = strlen(pszFile);
926	size_t cchDefaultExt;
927
928	/*
929	* Default extention?
930	*/
931	if (!pszDefaultExt \|\| strchr(pszFile, '.'))
932	cchDefaultExt = 0;
933	else
934	cchDefaultExt = strlen(pszDefaultExt);
935
936	size_t cchPath = cchDir + 1 + cchFile + cchDefaultExt + 1;
937	AssertMsgReturn(cchPath <= RTPATH_MAX, ("Path too long!\n"), NULL);
938
939	char pszRet = (char )RTMemTmpAlloc(cchDir + 1 + cchFile + cchDefaultExt + 1);
940	AssertMsgReturn(pszRet, ("Out of temporary memory!\n"), NULL);
941
942	/*
943	* Construct the filename.
944	*/
945	memcpy(pszRet, pszDir, cchDir);
946	pszRet[cchDir++] = '/'; /* this works everywhere */
947	memcpy(pszRet + cchDir, pszFile, cchFile + 1);
948	if (cchDefaultExt)
949	memcpy(pszRet + cchDir + cchFile, pszDefaultExt, cchDefaultExt + 1);
950
951	return pszRet;
952	}
953
954
955	/**
956	* Worker for pdmR3FileRC(), pdmR3FileR0() and pdmR3FileR3().
957	*
958	* @returns Pointer to temporary memory containing the filename.
959	* Caller must free this using RTMemTmpFree().
960	* @returns NULL on failure.
961	* @param pszFile File name (no path).
962	* @param pszDefaultExt The default extention, NULL if none.
963	* @param fShared If true, search in the shared directory (/usr/lib on Unix), else
964	* search in the private directory (/usr/lib/virtualbox on Unix).
965	* Ignored if VBOX_PATH_SHARED_LIBS is not defined.
966	* @todo We'll have this elsewhere than in the root later!
967	* @todo Remove the fShared hack again once we don't need to link against VBoxDD anymore!
968	*/
969	static char pdmR3File(const char pszFile, const char *pszDefaultExt, bool fShared)
970	{
971	char szPath[RTPATH_MAX];
972	int rc;
973
974	rc = fShared ? RTPathSharedLibs(szPath, sizeof(szPath))
975	: RTPathAppPrivateArch(szPath, sizeof(szPath));
976	if (!RT_SUCCESS(rc))
977	{
978	AssertMsgFailed(("RTPathProgram(,%d) failed rc=%d!\n", sizeof(szPath), rc));
979	return NULL;
980	}
981
982	return pdmR3FileConstruct(szPath, pszFile, pszDefaultExt);
983	}
984
985
986	/** @internal */
987	typedef struct QMFEIPARG
988	{
989	RTRCUINTPTR uPC;
990
991	char *pszNearSym1;
992	size_t cchNearSym1;
993	RTRCINTPTR offNearSym1;
994
995	char *pszNearSym2;
996	size_t cchNearSym2;
997	RTRCINTPTR offNearSym2;
998	} QMFEIPARG, *PQMFEIPARG;
999
1000	/**
1001	* Queries module information from an PC (eip/rip).
1002	*
1003	* This is typically used to locate a crash address.
1004	*
1005	* @returns VBox status code.
1006	*
1007	* @param pVM VM handle
1008	* @param uPC The program counter (eip/rip) to locate the module for.
1009	* @param pszModName Where to store the module name.
1010	* @param cchModName Size of the module name buffer.
1011	* @param pMod Base address of the module.
1012	* @param pszNearSym1 Name of the closes symbol from below.
1013	* @param cchNearSym1 Size of the buffer pointed to by pszNearSym1.
1014	* @param pNearSym1 The address of pszNearSym1.
1015	* @param pszNearSym2 Name of the closes symbol from below.
1016	* @param cchNearSym2 Size of the buffer pointed to by pszNearSym2.
1017	* @param pNearSym2 The address of pszNearSym2.
1018	*/
1019	VMMR3DECL(int) PDMR3LdrQueryRCModFromPC(PVM pVM, RTRCPTR uPC,
1020	char *pszModName, size_t cchModName, PRTRCPTR pMod,
1021	char *pszNearSym1, size_t cchNearSym1, PRTRCPTR pNearSym1,
1022	char *pszNearSym2, size_t cchNearSym2, PRTRCPTR pNearSym2)
1023	{
1024	int rc = VERR_MODULE_NOT_FOUND;
1025	PPDMMOD pCur;
1026	for (pCur = pVM->pUVM->pdm.s.pModules; pCur; pCur = pCur->pNext)
1027	{
1028	/* Skip anything which isn't in GC. */
1029	if (pCur->eType != PDMMOD_TYPE_RC)
1030	continue;
1031	if (uPC - pCur->ImageBase < RTLdrSize(pCur->hLdrMod))
1032	{
1033	if (pMod)
1034	*pMod = pCur->ImageBase;
1035	if (pszModName && cchModName)
1036	{
1037	*pszModName = '\0';
1038	strncat(pszModName, pCur->szName, cchModName);
1039	}
1040	if (pNearSym1) *pNearSym1 = 0;
1041	if (pNearSym2) *pNearSym2 = 0;
1042	if (pszNearSym1) *pszNearSym1 = '\0';
1043	if (pszNearSym2) *pszNearSym2 = '\0';
1044
1045	/*
1046	* Locate the nearest symbols.
1047	*/
1048	QMFEIPARG Args;
1049	Args.uPC = uPC;
1050	Args.pszNearSym1 = pszNearSym1;
1051	Args.cchNearSym1 = cchNearSym1;
1052	Args.offNearSym1 = RTRCINTPTR_MIN;
1053	Args.pszNearSym2 = pszNearSym2;
1054	Args.cchNearSym2 = cchNearSym2;
1055	Args.offNearSym2 = RTRCINTPTR_MAX;
1056
1057	rc = RTLdrEnumSymbols(pCur->hLdrMod, RTLDR_ENUM_SYMBOL_FLAGS_ALL, pCur->pvBits, pCur->ImageBase,
1058	pdmR3QueryModFromEIPEnumSymbols, &Args);
1059	if (pNearSym1 && Args.offNearSym1 != INT_MIN)
1060	*pNearSym1 = Args.offNearSym1 + uPC;
1061	if (pNearSym2 && Args.offNearSym2 != INT_MAX)
1062	*pNearSym2 = Args.offNearSym2 + uPC;
1063
1064	rc = VINF_SUCCESS;
1065	if (pCur->eType == PDMMOD_TYPE_RC)
1066	break;
1067	}
1068
1069	}
1070	return rc;
1071	}
1072
1073
1074	/**
1075	* Enumeration callback function used by RTLdrEnumSymbols().
1076	*
1077	* @returns VBox status code. Failure will stop the enumeration.
1078	* @param hLdrMod The loader module handle.
1079	* @param pszSymbol Symbol name. NULL if ordinal only.
1080	* @param uSymbol Symbol ordinal, ~0 if not used.
1081	* @param Value Symbol value.
1082	* @param pvUser The user argument specified to RTLdrEnumSymbols().
1083	*/
1084	static DECLCALLBACK(int) pdmR3QueryModFromEIPEnumSymbols(RTLDRMOD hLdrMod, const char pszSymbol, unsigned uSymbol, RTUINTPTR Value, void pvUser)
1085	{
1086	PQMFEIPARG pArgs = (PQMFEIPARG)pvUser;
1087
1088	RTINTPTR off = Value - pArgs->uPC;
1089	if (off <= 0) /* near1 is before or at same location. */
1090	{
1091	if (off > pArgs->offNearSym1)
1092	{
1093	pArgs->offNearSym1 = off;
1094	if (pArgs->pszNearSym1 && pArgs->cchNearSym1)
1095	{
1096	*pArgs->pszNearSym1 = '\0';
1097	if (pszSymbol)
1098	strncat(pArgs->pszNearSym1, pszSymbol, pArgs->cchNearSym1);
1099	else
1100	{
1101	char szOrd[32];
1102	RTStrPrintf(szOrd, sizeof(szOrd), "#%#x", uSymbol);
1103	strncat(pArgs->pszNearSym1, szOrd, pArgs->cchNearSym1);
1104	}
1105	}
1106	}
1107	}
1108	else /* near2 is after */
1109	{
1110	if (off < pArgs->offNearSym2)
1111	{
1112	pArgs->offNearSym2 = off;
1113	if (pArgs->pszNearSym2 && pArgs->cchNearSym2)
1114	{
1115	*pArgs->pszNearSym2 = '\0';
1116	if (pszSymbol)
1117	strncat(pArgs->pszNearSym2, pszSymbol, pArgs->cchNearSym2);
1118	else
1119	{
1120	char szOrd[32];
1121	RTStrPrintf(szOrd, sizeof(szOrd), "#%#x", uSymbol);
1122	strncat(pArgs->pszNearSym2, szOrd, pArgs->cchNearSym2);
1123	}
1124	}
1125	}
1126	}
1127
1128	return VINF_SUCCESS;
1129	}
1130
1131
1132	/**
1133	* Enumerate all PDM modules.
1134	*
1135	* @returns VBox status.
1136	* @param pVM VM Handle.
1137	* @param pfnCallback Function to call back for each of the modules.
1138	* @param pvArg User argument.
1139	*/
1140	VMMR3DECL(int) PDMR3LdrEnumModules(PVM pVM, PFNPDMR3ENUM pfnCallback, void *pvArg)
1141	{
1142	PPDMMOD pCur;
1143	for (pCur = pVM->pUVM->pdm.s.pModules; pCur; pCur = pCur->pNext)
1144	{
1145	int rc = pfnCallback(pVM,
1146	pCur->szFilename,
1147	pCur->szName,
1148	pCur->ImageBase,
1149	pCur->eType == PDMMOD_TYPE_RC ? RTLdrSize(pCur->hLdrMod) : 0,
1150	pCur->eType == PDMMOD_TYPE_RC,
1151	pvArg);
1152	if (RT_FAILURE(rc))
1153	return rc;
1154	}
1155	return VINF_SUCCESS;
1156	}
1157

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

source: vbox/trunk/src/VBox/VMM/PDMLdr.cpp@ 18851

Download in other formats: