PDMLdr.cpp@ 12998

Last change on this file since 12998 was 12989, checked in by vboxsync, 16 years ago
VMM + VBox/cdefs.h: consolidated all the XYZDECLS of the VMM into VMMDECL. Removed dead DECL and IN_XYZ* macros.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 37.4 KB

Line
1	/* $Id: PDMLdr.cpp 12989 2008-10-06 02:15:39Z 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=%VGv\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 (VBOX_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->pVMGC;
334	else if (!strcmp(pszSymbol, "g_CPUM"))
335	*pValue = VM_GUEST_ADDR(pVM, &pVM->cpum);
336	else if (!strcmp(pszSymbol, "g_TRPM"))
337	*pValue = VM_GUEST_ADDR(pVM, &pVM->trpm);
338	else if ( !strncmp(pszSymbol, "VMM", 3)
339	\|\| !strcmp(pszSymbol, "g_Logger")
340	\|\| !strcmp(pszSymbol, "g_RelLogger"))
341	{
342	RTGCPTR GCPtr = 0;
343	rc = VMMR3GetImportGC(pVM, pszSymbol, &GCPtr);
344	if (VBOX_SUCCESS(rc))
345	*pValue = GCPtr;
346	}
347	else if ( !strncmp(pszSymbol, "TM", 2)
348	\|\| !strcmp(pszSymbol, "g_pSUPGlobalInfoPage"))
349	{
350	RTGCPTR GCPtr = 0;
351	rc = TMR3GetImportGC(pVM, pszSymbol, &GCPtr);
352	if (VBOX_SUCCESS(rc))
353	*pValue = GCPtr;
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 (VBOX_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 (VBOX_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, &pModule->hLdrMod);
457	if (VBOX_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	rc = SUPPageAlloc(cb >> PAGE_SHIFT, &pModule->pvBits);
465	if (VBOX_SUCCESS(rc))
466	{
467	RTGCPTR GCPtr;
468	rc = MMR3HyperMapHCRam(pVM, pModule->pvBits, cb, true, pModule->szName, &GCPtr);
469	if (VBOX_SUCCESS(rc))
470	{
471	MMR3HyperReserve(pVM, PAGE_SIZE, "fence", NULL);
472
473	/*
474	* Get relocated image bits.
475	*/
476	Assert(MMHyperR3ToRC(pVM, pModule->pvBits) == GCPtr);
477	pModule->ImageBase = GCPtr;
478	PDMGETIMPORTARGS Args;
479	Args.pVM = pVM;
480	Args.pModule = pModule;
481	rc = RTLdrGetBits(pModule->hLdrMod, pModule->pvBits, pModule->ImageBase, pdmR3GetImportRC, &Args);
482	if (VBOX_SUCCESS(rc))
483	{
484	/*
485	* Insert the module.
486	*/
487	PUVM pUVM = pVM->pUVM;
488	if (pUVM->pdm.s.pModules)
489	{
490	/* we don't expect this list to be very long, so rather save the tail pointer. */
491	PPDMMOD pCur = pUVM->pdm.s.pModules;
492	while (pCur->pNext)
493	pCur = pCur->pNext;
494	pCur->pNext = pModule;
495	}
496	else
497	pUVM->pdm.s.pModules = pModule; /* (pNext is zeroed by alloc) */
498	Log(("PDM: RC Module at %RRv %s (%s)\n", (RTRCPTR)pModule->ImageBase, pszName, pszFilename));
499	RTMemTmpFree(pszFile);
500	return VINF_SUCCESS;
501	}
502	}
503	else
504	{
505	AssertRC(rc);
506	SUPPageFree(pModule->pvBits, cb >> PAGE_SHIFT);
507	}
508	}
509	else
510	AssertMsgFailed(("SUPPageAlloc(%d,) -> %Vrc\n", cb >> PAGE_SHIFT, rc));
511	int rc2 = RTLdrClose(pModule->hLdrMod);
512	AssertRC(rc2);
513	}
514	RTMemFree(pModule);
515	RTMemTmpFree(pszFile);
516
517	/* Don't consider VERR_PDM_MODULE_NAME_CLASH and VERR_NO_MEMORY above as these are very unlikely. */
518	if (VBOX_FAILURE(rc))
519	return VMSetError(pVM, rc, RT_SRC_POS, N_("Cannot load GC module %s"), pszFilename);
520	return rc;
521	}
522
523
524	/**
525	* Loads a module into the ring-0 context.
526	*
527	* @returns VBox status code.
528	* @param pUVM Pointer to the user mode VM structure.
529	* @param pszFilename Filename of the module binary.
530	* @param pszName Module name. Case sensitive and the length is limited!
531	*/
532	static int pdmR3LoadR0U(PUVM pUVM, const char pszFilename, const char pszName)
533	{
534	/*
535	* Validate input.
536	*/
537	PPDMMOD pCur = pUVM->pdm.s.pModules;
538	while (pCur)
539	{
540	if (!strcmp(pCur->szName, pszName))
541	{
542	AssertMsgFailed(("We've already got a module '%s' loaded!\n", pszName));
543	return VERR_PDM_MODULE_NAME_CLASH;
544	}
545	/* next */
546	pCur = pCur->pNext;
547	}
548
549	/*
550	* Find the file if not specified.
551	*/
552	char *pszFile = NULL;
553	if (!pszFilename)
554	pszFilename = pszFile = pdmR3FileR0(pszName);
555
556	/*
557	* Allocate the module list node.
558	*/
559	PPDMMOD pModule = (PPDMMOD)RTMemAllocZ(sizeof(*pModule) + strlen(pszFilename));
560	if (!pModule)
561	{
562	RTMemTmpFree(pszFile);
563	return VERR_NO_MEMORY;
564	}
565	AssertMsg(strlen(pszName) + 1 < sizeof(pModule->szName),
566	("pazName is too long (%d chars) max is %d chars.\n", strlen(pszName), sizeof(pModule->szName) - 1));
567	strcpy(pModule->szName, pszName);
568	pModule->eType = PDMMOD_TYPE_R0;
569	strcpy(pModule->szFilename, pszFilename);
570
571	/*
572	* Ask the support library to load it.
573	*/
574	void *pvImageBase;
575	int rc = SUPLoadModule(pszFilename, pszName, &pvImageBase);
576	if (VBOX_SUCCESS(rc))
577	{
578	pModule->hLdrMod = NIL_RTLDRMOD;
579	pModule->ImageBase = (uintptr_t)pvImageBase;
580
581	/*
582	* Insert the module.
583	*/
584	if (pUVM->pdm.s.pModules)
585	{
586	/* we don't expect this list to be very long, so rather save the tail pointer. */
587	PPDMMOD pCur = pUVM->pdm.s.pModules;
588	while (pCur->pNext)
589	pCur = pCur->pNext;
590	pCur->pNext = pModule;
591	}
592	else
593	pUVM->pdm.s.pModules = pModule; /* (pNext is zeroed by alloc) */
594	Log(("PDM: GC Module at %VGvx %s (%s)\n", (RTGCPTR)pModule->ImageBase, pszName, pszFilename));
595	RTMemTmpFree(pszFile);
596	return VINF_SUCCESS;
597	}
598
599	RTMemFree(pModule);
600	RTMemTmpFree(pszFile);
601	LogRel(("pdmR3LoadR0U: pszName=\"%s\" rc=%Vrc\n", pszName, rc));
602
603	/* Don't consider VERR_PDM_MODULE_NAME_CLASH and VERR_NO_MEMORY above as these are very unlikely. */
604	if (VBOX_FAILURE(rc) && pUVM->pVM) /** @todo VMR3SetErrorU. */
605	return VMSetError(pUVM->pVM, rc, RT_SRC_POS, N_("Cannot load R0 module %s"), pszFilename);
606	return rc;
607	}
608
609
610
611	/**
612	* Get the address of a symbol in a given HC ring 3 module.
613	*
614	* @returns VBox status code.
615	* @param pVM VM handle.
616	* @param pszModule Module name.
617	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
618	* ordinal value rather than a string pointer.
619	* @param ppvValue Where to store the symbol value.
620	*/
621	VMMR3DECL(int) PDMR3LdrGetSymbolR3(PVM pVM, const char pszModule, const char pszSymbol, void **ppvValue)
622	{
623	/*
624	* Validate input.
625	*/
626	AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
627
628	/*
629	* Find the module.
630	*/
631	for (PPDMMOD pModule = pVM->pUVM->pdm.s.pModules; pModule; pModule = pModule->pNext)
632	{
633	if ( pModule->eType == PDMMOD_TYPE_R3
634	&& !strcmp(pModule->szName, pszModule))
635	{
636	RTUINTPTR Value = 0;
637	int rc = RTLdrGetSymbolEx(pModule->hLdrMod, pModule->pvBits, pModule->ImageBase, pszSymbol, &Value);
638	if (VBOX_SUCCESS(rc))
639	{
640	ppvValue = (void )(uintptr_t)Value;
641	Assert((uintptr_t)*ppvValue == Value);
642	}
643	else
644	{
645	if (pszSymbol < (const char )(void )0x10000)
646	AssertMsg(rc, ("Couldn't symbol '%u' in module '%s'\n", (unsigned)(uintptr_t)pszSymbol, pszModule));
647	else
648	AssertMsg(rc, ("Couldn't symbol '%s' in module '%s'\n", pszSymbol, pszModule));
649	}
650	return rc;
651	}
652	}
653
654	AssertMsgFailed(("Couldn't locate module '%s'\n", pszModule));
655	return VERR_SYMBOL_NOT_FOUND;
656	}
657
658
659	/**
660	* Get the address of a symbol in a given HC ring 0 module.
661	*
662	* @returns VBox status code.
663	* @param pVM VM handle.
664	* @param pszModule Module name. If NULL the main R0 module (VMMR0.r0) is assumes.
665	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
666	* ordinal value rather than a string pointer.
667	* @param ppvValue Where to store the symbol value.
668	*/
669	VMMR3DECL(int) PDMR3LdrGetSymbolR0(PVM pVM, const char pszModule, const char pszSymbol, PRTR0PTR ppvValue)
670	{
671	#ifdef PDMLDR_FAKE_MODE
672	*ppvValue = 0xdeadbeef;
673	return VINF_SUCCESS;
674
675	#else
676	/*
677	* Validate input.
678	*/
679	AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
680	if (!pszModule)
681	pszModule = "VMMR0.r0";
682
683	/*
684	* Find the module.
685	*/
686	for (PPDMMOD pModule = pVM->pUVM->pdm.s.pModules; pModule; pModule = pModule->pNext)
687	{
688	if ( pModule->eType == PDMMOD_TYPE_R0
689	&& !strcmp(pModule->szName, pszModule))
690	{
691	int rc = SUPGetSymbolR0((void )(uintptr_t)pModule->ImageBase, pszSymbol, (void *)ppvValue);
692	if (VBOX_FAILURE(rc))
693	{
694	AssertMsgRC(rc, ("Couldn't find symbol '%s' in module '%s'\n", pszSymbol, pszModule));
695	LogRel(("PDMGetSymbol: Couldn't find symbol '%s' in module '%s'\n", pszSymbol, pszModule));
696	}
697	return rc;
698	}
699	}
700
701	AssertMsgFailed(("Couldn't locate module '%s'\n", pszModule));
702	return VERR_SYMBOL_NOT_FOUND;
703	#endif
704	}
705
706
707	/**
708	* Same as PDMR3LdrGetSymbolR0 except that the module will be attempted loaded if not found.
709	*
710	* @returns VBox status code.
711	* @param pVM VM handle.
712	* @param pszModule Module name. If NULL the main R0 module (VMMR0.r0) is assumed.
713	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
714	* ordinal value rather than a string pointer.
715	* @param ppvValue Where to store the symbol value.
716	*/
717	VMMR3DECL(int) PDMR3LdrGetSymbolR0Lazy(PVM pVM, const char pszModule, const char pszSymbol, PRTR0PTR ppvValue)
718	{
719	#ifdef PDMLDR_FAKE_MODE
720	*ppvValue = 0xdeadbeef;
721	return VINF_SUCCESS;
722
723	#else
724	/*
725	* Since we're lazy, we'll only check if the module is present
726	* and hand it over to PDMR3LdrGetSymbolR0 when that's done.
727	*/
728	AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
729	if (pszModule)
730	{
731	AssertMsgReturn(!strpbrk(pszModule, "/\\:\n\r\t"), ("pszModule=%s\n", pszModule), VERR_INVALID_PARAMETER);
732	PPDMMOD pModule;
733	for (pModule = pVM->pUVM->pdm.s.pModules; pModule; pModule = pModule->pNext)
734	if ( pModule->eType == PDMMOD_TYPE_R0
735	&& !strcmp(pModule->szName, pszModule))
736	break;
737	if (!pModule)
738	{
739	int rc = pdmR3LoadR0U(pVM->pUVM, NULL, pszModule);
740	AssertMsgRCReturn(rc, ("pszModule=%s rc=%Vrc\n", pszModule, rc), VERR_MODULE_NOT_FOUND);
741	}
742	}
743	return PDMR3LdrGetSymbolR0(pVM, pszModule, pszSymbol, ppvValue);
744	#endif
745	}
746
747
748	/**
749	* Get the address of a symbol in a given RC module.
750	*
751	* @returns VBox status code.
752	* @param pVM VM handle.
753	* @param pszModule Module name. If NULL the main R0 module (VMMGC.gc) is assumes.
754	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
755	* ordinal value rather than a string pointer.
756	* @param pRCPtrValue Where to store the symbol value.
757	*/
758	VMMR3DECL(int) PDMR3LdrGetSymbolRC(PVM pVM, const char pszModule, const char pszSymbol, PRTGCPTR32 pRCPtrValue)
759	{
760	#ifdef PDMLDR_FAKE_MODE
761	*pRCPtrValue = 0xfeedf00d;
762	return VINF_SUCCESS;
763
764	#else
765	/*
766	* Validate input.
767	*/
768	AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
769	if (!pszModule)
770	pszModule = "VMMGC.gc";
771
772	/*
773	* Find the module.
774	*/
775	for (PPDMMOD pModule = pVM->pUVM->pdm.s.pModules; pModule; pModule = pModule->pNext)
776	{
777	if ( pModule->eType == PDMMOD_TYPE_RC
778	&& !strcmp(pModule->szName, pszModule))
779	{
780	RTUINTPTR Value;
781	int rc = RTLdrGetSymbolEx(pModule->hLdrMod, pModule->pvBits, pModule->ImageBase, pszSymbol, &Value);
782	if (VBOX_SUCCESS(rc))
783	{
784	*pRCPtrValue = (RTGCPTR)Value;
785	Assert(*pRCPtrValue == Value);
786	}
787	else
788	{
789	if (pszSymbol < (const char)(void)0x10000)
790	AssertMsg(rc, ("Couldn't symbol '%u' in module '%s'\n", (unsigned)(uintptr_t)pszSymbol, pszModule));
791	else
792	AssertMsg(rc, ("Couldn't symbol '%s' in module '%s'\n", pszSymbol, pszModule));
793	}
794	return rc;
795	}
796	}
797
798	AssertMsgFailed(("Couldn't locate module '%s'\n", pszModule));
799	return VERR_SYMBOL_NOT_FOUND;
800	#endif
801	}
802
803
804	/**
805	* Same as PDMR3LdrGetSymbolRC except that the module will be attempted loaded if not found.
806	*
807	* @returns VBox status code.
808	* @param pVM VM handle.
809	* @param pszModule Module name. If NULL the main R0 module (VMMGC.gc) is assumes.
810	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
811	* ordinal value rather than a string pointer.
812	* @param pRCPtrValue Where to store the symbol value.
813	*/
814	VMMR3DECL(int) PDMR3LdrGetSymbolRCLazy(PVM pVM, const char pszModule, const char pszSymbol, PRTGCPTR32 pRCPtrValue)
815	{
816	#ifdef PDMLDR_FAKE_MODE
817	*pRCPtrValue = 0xfeedf00d;
818	return VINF_SUCCESS;
819
820	#else
821	/*
822	* Since we're lazy, we'll only check if the module is present
823	* and hand it over to PDMR3LdrGetSymbolRC when that's done.
824	*/
825	AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
826	if (pszModule)
827	{
828	AssertMsgReturn(!strpbrk(pszModule, "/\\:\n\r\t"), ("pszModule=%s\n", pszModule), VERR_INVALID_PARAMETER);
829	PPDMMOD pModule;
830	for (pModule = pVM->pUVM->pdm.s.pModules; pModule; pModule = pModule->pNext)
831	if ( pModule->eType == PDMMOD_TYPE_RC
832	&& !strcmp(pModule->szName, pszModule))
833	break;
834	if (!pModule)
835	{
836	char *pszFilename = pdmR3FileRC(pszModule);
837	AssertMsgReturn(pszFilename, ("pszModule=%s\n", pszModule), VERR_MODULE_NOT_FOUND);
838	int rc = PDMR3LdrLoadRC(pVM, pszFilename, pszModule);
839	RTMemTmpFree(pszFilename);
840	AssertMsgRCReturn(rc, ("pszModule=%s rc=%Vrc\n", pszModule, rc), VERR_MODULE_NOT_FOUND);
841	}
842	}
843	return PDMR3LdrGetSymbolRC(pVM, pszModule, pszSymbol, pRCPtrValue);
844	#endif
845	}
846
847
848	/**
849	* Constructs the full filename for a R3 image file.
850	*
851	* @returns Pointer to temporary memory containing the filename.
852	* Caller must free this using RTMemTmpFree().
853	* @returns NULL on failure.
854	*
855	* @param pszFile File name (no path).
856	*/
857	char pdmR3FileR3(const char pszFile, bool fShared)
858	{
859	return pdmR3File(pszFile, NULL, fShared);
860	}
861
862
863	/**
864	* Constructs the full filename for a R0 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 pdmR3FileR0(const char pszFile)
873	{
874	return pdmR3File(pszFile, NULL, /fShared=/false);
875	}
876
877
878	/**
879	* Constructs the full filename for a RC 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 pdmR3FileRC(const char pszFile)
888	{
889	return pdmR3File(pszFile, NULL, /fShared=/false);
890	}
891
892
893	/**
894	* Worker for pdmR3File().
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 pszDir Directory part
901	* @param pszFile File name part
902	* @param pszDefaultExt Extension part
903	*/
904	static char pdmR3FileConstruct(const char pszDir, const char pszFile, const char pszDefaultExt)
905	{
906	/*
907	* Allocate temp memory for return buffer.
908	*/
909	unsigned cchDir = strlen(pszDir);
910	unsigned cchFile = strlen(pszFile);
911	unsigned cchDefaultExt;
912
913	/*
914	* Default extention?
915	*/
916	if (!pszDefaultExt \|\| strchr(pszFile, '.'))
917	cchDefaultExt = 0;
918	else
919	cchDefaultExt = strlen(pszDefaultExt);
920
921	unsigned cchPath = cchDir + 1 + cchFile + cchDefaultExt + 1;
922	if (cchPath > RTPATH_MAX)
923	{
924	AssertMsgFailed(("Path too long!\n"));
925	return NULL;
926	}
927
928	char pszRet = (char )RTMemTmpAlloc(cchDir + 1 + cchFile + cchDefaultExt + 1);
929	if (!pszRet)
930	{
931	AssertMsgFailed(("Out of temporary memory!\n"));
932	return NULL;
933	}
934
935	/*
936	* Construct the filename.
937	*/
938	memcpy(pszRet, pszDir, cchDir);
939	pszRet[cchDir++] = '/'; /* this works everywhere */
940	memcpy(pszRet + cchDir, pszFile, cchFile + 1);
941	if (cchDefaultExt)
942	memcpy(pszRet + cchDir + cchFile, pszDefaultExt, cchDefaultExt + 1);
943
944	return pszRet;
945	}
946
947
948	/**
949	* Worker for pdmR3FileRC(), pdmR3FileR0() and pdmR3FileR3().
950	*
951	* @returns Pointer to temporary memory containing the filename.
952	* Caller must free this using RTMemTmpFree().
953	* @returns NULL on failure.
954	* @param pszFile File name (no path).
955	* @param pszDefaultExt The default extention, NULL if none.
956	* @param fShared If true, search in the shared directory (/usr/lib on Unix), else
957	* search in the private directory (/usr/lib/virtualbox on Unix).
958	* Ignored if VBOX_PATH_SHARED_LIBS is not defined.
959	* @todo We'll have this elsewhere than in the root later!
960	* @todo Remove the fShared hack again once we don't need to link against VBoxDD anymore!
961	*/
962	static char pdmR3File(const char pszFile, const char *pszDefaultExt, bool fShared)
963	{
964	char szPath[RTPATH_MAX];
965	int rc;
966
967	rc = fShared ? RTPathSharedLibs(szPath, sizeof(szPath))
968	: RTPathAppPrivateArch(szPath, sizeof(szPath));
969	if (!VBOX_SUCCESS(rc))
970	{
971	AssertMsgFailed(("RTPathProgram(,%d) failed rc=%d!\n", sizeof(szPath), rc));
972	return NULL;
973	}
974
975	return pdmR3FileConstruct(szPath, pszFile, pszDefaultExt);
976	}
977
978
979	/** @internal */
980	typedef struct QMFEIPARG
981	{
982	RTRCUINTPTR uPC;
983
984	char *pszNearSym1;
985	unsigned cchNearSym1;
986	RTRCINTPTR offNearSym1;
987
988	char *pszNearSym2;
989	unsigned cchNearSym2;
990	RTRCINTPTR offNearSym2;
991	} QMFEIPARG, *PQMFEIPARG;
992
993	/**
994	* Queries module information from an PC (eip/rip).
995	*
996	* This is typically used to locate a crash address.
997	*
998	* @returns VBox status code.
999	*
1000	* @param pVM VM handle
1001	* @param uPC The program counter (eip/rip) to locate the module for.
1002	* @param pszModName Where to store the module name.
1003	* @param cchModName Size of the module name buffer.
1004	* @param pMod Base address of the module.
1005	* @param pszNearSym1 Name of the closes symbol from below.
1006	* @param cchNearSym1 Size of the buffer pointed to by pszNearSym1.
1007	* @param pNearSym1 The address of pszNearSym1.
1008	* @param pszNearSym2 Name of the closes symbol from below.
1009	* @param cchNearSym2 Size of the buffer pointed to by pszNearSym2.
1010	* @param pNearSym2 The address of pszNearSym2.
1011	*/
1012	VMMR3DECL(int) PDMR3LdrQueryRCModFromPC(PVM pVM, RTRCPTR uPC,
1013	char *pszModName, size_t cchModName, PRTRCPTR pMod,
1014	char *pszNearSym1, size_t cchNearSym1, PRTRCPTR pNearSym1,
1015	char *pszNearSym2, size_t cchNearSym2, PRTRCPTR pNearSym2)
1016	{
1017	int rc = VERR_MODULE_NOT_FOUND;
1018	PPDMMOD pCur;
1019	for (pCur = pVM->pUVM->pdm.s.pModules; pCur; pCur = pCur->pNext)
1020	{
1021	/* Skip anything which isn't in GC. */
1022	if (pCur->eType != PDMMOD_TYPE_RC)
1023	continue;
1024	if (uPC - pCur->ImageBase < RTLdrSize(pCur->hLdrMod))
1025	{
1026	if (pMod)
1027	*pMod = pCur->ImageBase;
1028	if (pszModName && cchModName)
1029	{
1030	*pszModName = '\0';
1031	strncat(pszModName, pCur->szName, cchModName);
1032	}
1033	if (pNearSym1) *pNearSym1 = 0;
1034	if (pNearSym2) *pNearSym2 = 0;
1035	if (pszNearSym1) *pszNearSym1 = '\0';
1036	if (pszNearSym2) *pszNearSym2 = '\0';
1037
1038	/*
1039	* Locate the nearest symbols.
1040	*/
1041	QMFEIPARG Args;
1042	Args.uPC = uPC;
1043	Args.pszNearSym1 = pszNearSym1;
1044	Args.cchNearSym1 = cchNearSym1;
1045	Args.offNearSym1 = RTRCINTPTR_MIN;
1046	Args.pszNearSym2 = pszNearSym2;
1047	Args.cchNearSym2 = cchNearSym2;
1048	Args.offNearSym2 = RTRCINTPTR_MAX;
1049
1050	rc = RTLdrEnumSymbols(pCur->hLdrMod, RTLDR_ENUM_SYMBOL_FLAGS_ALL, pCur->pvBits, pCur->ImageBase,
1051	pdmR3QueryModFromEIPEnumSymbols, &Args);
1052	if (pNearSym1 && Args.offNearSym1 != INT_MIN)
1053	*pNearSym1 = Args.offNearSym1 + uPC;
1054	if (pNearSym2 && Args.offNearSym2 != INT_MAX)
1055	*pNearSym2 = Args.offNearSym2 + uPC;
1056
1057	rc = VINF_SUCCESS;
1058	if (pCur->eType == PDMMOD_TYPE_RC)
1059	break;
1060	}
1061
1062	}
1063	return rc;
1064	}
1065
1066
1067	/**
1068	* Enumeration callback function used by RTLdrEnumSymbols().
1069	*
1070	* @returns VBox status code. Failure will stop the enumeration.
1071	* @param hLdrMod The loader module handle.
1072	* @param pszSymbol Symbol name. NULL if ordinal only.
1073	* @param uSymbol Symbol ordinal, ~0 if not used.
1074	* @param Value Symbol value.
1075	* @param pvUser The user argument specified to RTLdrEnumSymbols().
1076	*/
1077	static DECLCALLBACK(int) pdmR3QueryModFromEIPEnumSymbols(RTLDRMOD hLdrMod, const char pszSymbol, unsigned uSymbol, RTUINTPTR Value, void pvUser)
1078	{
1079	PQMFEIPARG pArgs = (PQMFEIPARG)pvUser;
1080
1081	RTINTPTR off = Value - pArgs->uPC;
1082	if (off <= 0) /* near1 is before or at same location. */
1083	{
1084	if (off > pArgs->offNearSym1)
1085	{
1086	pArgs->offNearSym1 = off;
1087	if (pArgs->pszNearSym1 && pArgs->cchNearSym1)
1088	{
1089	*pArgs->pszNearSym1 = '\0';
1090	if (pszSymbol)
1091	strncat(pArgs->pszNearSym1, pszSymbol, pArgs->cchNearSym1);
1092	else
1093	{
1094	char szOrd[32];
1095	RTStrPrintf(szOrd, sizeof(szOrd), "#%#x", uSymbol);
1096	strncat(pArgs->pszNearSym1, szOrd, pArgs->cchNearSym1);
1097	}
1098	}
1099	}
1100	}
1101	else /* near2 is after */
1102	{
1103	if (off < pArgs->offNearSym2)
1104	{
1105	pArgs->offNearSym2 = off;
1106	if (pArgs->pszNearSym2 && pArgs->cchNearSym2)
1107	{
1108	*pArgs->pszNearSym2 = '\0';
1109	if (pszSymbol)
1110	strncat(pArgs->pszNearSym2, pszSymbol, pArgs->cchNearSym2);
1111	else
1112	{
1113	char szOrd[32];
1114	RTStrPrintf(szOrd, sizeof(szOrd), "#%#x", uSymbol);
1115	strncat(pArgs->pszNearSym2, szOrd, pArgs->cchNearSym2);
1116	}
1117	}
1118	}
1119	}
1120
1121	return VINF_SUCCESS;
1122	}
1123
1124
1125	/**
1126	* Enumerate all PDM modules.
1127	*
1128	* @returns VBox status.
1129	* @param pVM VM Handle.
1130	* @param pfnCallback Function to call back for each of the modules.
1131	* @param pvArg User argument.
1132	*/
1133	VMMR3DECL(int) PDMR3LdrEnumModules(PVM pVM, PFNPDMR3ENUM pfnCallback, void *pvArg)
1134	{
1135	PPDMMOD pCur;
1136	for (pCur = pVM->pUVM->pdm.s.pModules; pCur; pCur = pCur->pNext)
1137	{
1138	int rc = pfnCallback(pVM,
1139	pCur->szFilename,
1140	pCur->szName,
1141	pCur->ImageBase,
1142	pCur->eType == PDMMOD_TYPE_RC ? RTLdrSize(pCur->hLdrMod) : 0,
1143	pCur->eType == PDMMOD_TYPE_RC);
1144	if (VBOX_FAILURE(rc))
1145	return rc;
1146	}
1147	return VINF_SUCCESS;
1148	}
1149

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

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

Download in other formats: