PDMDriver.cpp@ 39944

Last change on this file since 39944 was 39858, checked in by vboxsync, 13 years ago
PDMDriver: Forgot.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 67.7 KB

Line
1	/* $Id: PDMDriver.cpp 39858 2012-01-24 16:43:12Z vboxsync $ */
2	/** @file
3	* PDM - Pluggable Device and Driver Manager, Driver parts.
4	*/
5
6	/*
7	* Copyright (C) 2006-2010 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
18
19	/*******************************************************************************
20	* Header Files *
21	*******************************************************************************/
22	#define LOG_GROUP LOG_GROUP_PDM_DRIVER
23	#include "PDMInternal.h"
24	#include <VBox/vmm/pdm.h>
25	#include <VBox/vmm/mm.h>
26	#include <VBox/vmm/cfgm.h>
27	#include <VBox/vmm/vmm.h>
28	#include <VBox/sup.h>
29	#include <VBox/vmm/vm.h>
30	#include <VBox/version.h>
31	#include <VBox/err.h>
32
33	#include <VBox/log.h>
34	#include <iprt/assert.h>
35	#include <iprt/asm.h>
36	#include <iprt/ctype.h>
37	#include <iprt/mem.h>
38	#include <iprt/thread.h>
39	#include <iprt/path.h>
40	#include <iprt/string.h>
41
42
43	/*******************************************************************************
44	* Structures and Typedefs *
45	*******************************************************************************/
46	/**
47	* Internal callback structure pointer.
48	*
49	* The main purpose is to define the extra data we associate
50	* with PDMDRVREGCB so we can find the VM instance and so on.
51	*/
52	typedef struct PDMDRVREGCBINT
53	{
54	/** The callback structure. */
55	PDMDRVREGCB Core;
56	/** A bit of padding. */
57	uint32_t u32[4];
58	/** VM Handle. */
59	PVM pVM;
60	/** Pointer to the configuration node the registrations should be
61	* associated with. Can be NULL. */
62	PCFGMNODE pCfgNode;
63	} PDMDRVREGCBINT, *PPDMDRVREGCBINT;
64	typedef const PDMDRVREGCBINT *PCPDMDRVREGCBINT;
65
66
67	/*******************************************************************************
68	* Internal Functions *
69	*******************************************************************************/
70	static DECLCALLBACK(int) pdmR3DrvRegister(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pReg);
71	static int pdmR3DrvLoad(PVM pVM, PPDMDRVREGCBINT pRegCB, const char pszFilename, const char pszName);
72
73
74	/**
75	* Register drivers in a statically linked environment.
76	*
77	* @returns VBox status code.
78	* @param pVM The VM to operate on.
79	* @param pfnCallback Driver registration callback
80	*/
81	VMMR3DECL(int) PDMR3DrvStaticRegistration(PVM pVM, FNPDMVBOXDRIVERSREGISTER pfnCallback)
82	{
83	/*
84	* The registration callbacks.
85	*/
86	PDMDRVREGCBINT RegCB;
87	RegCB.Core.u32Version = PDM_DRVREG_CB_VERSION;
88	RegCB.Core.pfnRegister = pdmR3DrvRegister;
89	RegCB.pVM = pVM;
90	RegCB.pCfgNode = NULL;
91
92	int rc = pfnCallback(&RegCB.Core, VBOX_VERSION);
93	if (RT_FAILURE(rc))
94	AssertMsgFailed(("VBoxDriversRegister failed with rc=%Rrc\n"));
95
96	return rc;
97	}
98
99
100	/**
101	* This function will initialize the drivers for this VM instance.
102	*
103	* First of all this mean loading the builtin drivers and letting them
104	* register themselves. Beyond that any additional driver modules are
105	* loaded and called for registration.
106	*
107	* @returns VBox status code.
108	* @param pVM VM Handle.
109	*/
110	int pdmR3DrvInit(PVM pVM)
111	{
112	LogFlow(("pdmR3DrvInit:\n"));
113
114	AssertRelease(!(RT_OFFSETOF(PDMDRVINS, achInstanceData) & 15));
115	PPDMDRVINS pDrvInsAssert; NOREF(pDrvInsAssert);
116	AssertCompile(sizeof(pDrvInsAssert->Internal.s) <= sizeof(pDrvInsAssert->Internal.padding));
117	AssertRelease(sizeof(pDrvInsAssert->Internal.s) <= sizeof(pDrvInsAssert->Internal.padding));
118
119	/*
120	* The registration callbacks.
121	*/
122	PDMDRVREGCBINT RegCB;
123	RegCB.Core.u32Version = PDM_DRVREG_CB_VERSION;
124	RegCB.Core.pfnRegister = pdmR3DrvRegister;
125	RegCB.pVM = pVM;
126	RegCB.pCfgNode = NULL;
127
128	/*
129	* Load the builtin module
130	*/
131	PCFGMNODE pDriversNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "PDM/Drivers");
132	bool fLoadBuiltin;
133	int rc = CFGMR3QueryBool(pDriversNode, "LoadBuiltin", &fLoadBuiltin);
134	if (rc == VERR_CFGM_VALUE_NOT_FOUND \|\| rc == VERR_CFGM_NO_PARENT)
135	fLoadBuiltin = true;
136	else if (RT_FAILURE(rc))
137	{
138	AssertMsgFailed(("Configuration error: Querying boolean \"LoadBuiltin\" failed with %Rrc\n", rc));
139	return rc;
140	}
141	if (fLoadBuiltin)
142	{
143	/* make filename */
144	char pszFilename = pdmR3FileR3("VBoxDD", true /fShared*/);
145	if (!pszFilename)
146	return VERR_NO_TMP_MEMORY;
147	rc = pdmR3DrvLoad(pVM, &RegCB, pszFilename, "VBoxDD");
148	RTMemTmpFree(pszFilename);
149	if (RT_FAILURE(rc))
150	return rc;
151	}
152
153	/*
154	* Load additional driver modules.
155	*/
156	for (PCFGMNODE pCur = CFGMR3GetFirstChild(pDriversNode); pCur; pCur = CFGMR3GetNextChild(pCur))
157	{
158	/*
159	* Get the name and path.
160	*/
161	char szName[PDMMOD_NAME_LEN];
162	rc = CFGMR3GetName(pCur, &szName[0], sizeof(szName));
163	if (rc == VERR_CFGM_NOT_ENOUGH_SPACE)
164	{
165	AssertMsgFailed(("configuration error: The module name is too long, cchName=%zu.\n", CFGMR3GetNameLen(pCur)));
166	return VERR_PDM_MODULE_NAME_TOO_LONG;
167	}
168	else if (RT_FAILURE(rc))
169	{
170	AssertMsgFailed(("CFGMR3GetName -> %Rrc.\n", rc));
171	return rc;
172	}
173
174	/* the path is optional, if no path the module name + path is used. */
175	char szFilename[RTPATH_MAX];
176	rc = CFGMR3QueryString(pCur, "Path", &szFilename[0], sizeof(szFilename));
177	if (rc == VERR_CFGM_VALUE_NOT_FOUND \|\| rc == VERR_CFGM_NO_PARENT)
178	strcpy(szFilename, szName);
179	else if (RT_FAILURE(rc))
180	{
181	AssertMsgFailed(("configuration error: Failure to query the module path, rc=%Rrc.\n", rc));
182	return rc;
183	}
184
185	/* prepend path? */
186	if (!RTPathHavePath(szFilename))
187	{
188	char psz = pdmR3FileR3(szFilename, false /fShared*/);
189	if (!psz)
190	return VERR_NO_TMP_MEMORY;
191	size_t cch = strlen(psz) + 1;
192	if (cch > sizeof(szFilename))
193	{
194	RTMemTmpFree(psz);
195	AssertMsgFailed(("Filename too long! cch=%d '%s'\n", cch, psz));
196	return VERR_FILENAME_TOO_LONG;
197	}
198	memcpy(szFilename, psz, cch);
199	RTMemTmpFree(psz);
200	}
201
202	/*
203	* Load the module and register it's drivers.
204	*/
205	RegCB.pCfgNode = pCur;
206	rc = pdmR3DrvLoad(pVM, &RegCB, szFilename, szName);
207	if (RT_FAILURE(rc))
208	return rc;
209	}
210
211	LogFlow(("pdmR3DrvInit: returns VINF_SUCCESS\n"));
212	return VINF_SUCCESS;
213	}
214
215
216	/**
217	* Loads one driver module and call the registration entry point.
218	*
219	* @returns VBox status code.
220	* @param pVM VM handle.
221	* @param pRegCB The registration callback stuff.
222	* @param pszFilename Module filename.
223	* @param pszName Module name.
224	*/
225	static int pdmR3DrvLoad(PVM pVM, PPDMDRVREGCBINT pRegCB, const char pszFilename, const char pszName)
226	{
227	/*
228	* Load it.
229	*/
230	int rc = pdmR3LoadR3U(pVM->pUVM, pszFilename, pszName);
231	if (RT_SUCCESS(rc))
232	{
233	/*
234	* Get the registration export and call it.
235	*/
236	FNPDMVBOXDRIVERSREGISTER *pfnVBoxDriversRegister;
237	rc = PDMR3LdrGetSymbolR3(pVM, pszName, "VBoxDriversRegister", (void **)&pfnVBoxDriversRegister);
238	if (RT_SUCCESS(rc))
239	{
240	Log(("PDM: Calling VBoxDriversRegister (%p) of %s (%s)\n", pfnVBoxDriversRegister, pszName, pszFilename));
241	rc = pfnVBoxDriversRegister(&pRegCB->Core, VBOX_VERSION);
242	if (RT_SUCCESS(rc))
243	Log(("PDM: Successfully loaded driver module %s (%s).\n", pszName, pszFilename));
244	else
245	AssertMsgFailed(("VBoxDriversRegister failed with rc=%Rrc\n"));
246	}
247	else
248	{
249	AssertMsgFailed(("Failed to locate 'VBoxDriversRegister' in %s (%s) rc=%Rrc\n", pszName, pszFilename, rc));
250	if (rc == VERR_SYMBOL_NOT_FOUND)
251	rc = VERR_PDM_NO_REGISTRATION_EXPORT;
252	}
253	}
254	else
255	AssertMsgFailed(("Failed to load %s (%s) rc=%Rrc!\n", pszName, pszFilename, rc));
256	return rc;
257	}
258
259
260	/** @interface_method_impl{PDMDRVREGCB,pfnRegister} */
261	static DECLCALLBACK(int) pdmR3DrvRegister(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pReg)
262	{
263	/*
264	* Validate the registration structure.
265	*/
266	AssertPtrReturn(pReg, VERR_INVALID_POINTER);
267	AssertMsgReturn(pReg->u32Version == PDM_DRVREG_VERSION,
268	("%#x\n", pReg->u32Version),
269	VERR_PDM_UNKNOWN_DRVREG_VERSION);
270	AssertReturn(pReg->szName[0], VERR_PDM_INVALID_DRIVER_REGISTRATION);
271	AssertMsgReturn(RTStrEnd(pReg->szName, sizeof(pReg->szName)),
272	("%.*s\n", sizeof(pReg->szName), pReg->szName),
273	VERR_PDM_INVALID_DRIVER_REGISTRATION);
274	AssertMsgReturn(pdmR3IsValidName(pReg->szName), ("%.*s\n", pReg->szName),
275	VERR_PDM_INVALID_DRIVER_REGISTRATION);
276	AssertMsgReturn( !(pReg->fFlags & PDM_DRVREG_FLAGS_R0)
277	\|\| ( pReg->szR0Mod[0]
278	&& RTStrEnd(pReg->szR0Mod, sizeof(pReg->szR0Mod))),
279	("%s: %.*s\n", pReg->szName, sizeof(pReg->szR0Mod), pReg->szR0Mod),
280	VERR_PDM_INVALID_DRIVER_REGISTRATION);
281	AssertMsgReturn( !(pReg->fFlags & PDM_DRVREG_FLAGS_RC)
282	\|\| ( pReg->szRCMod[0]
283	&& RTStrEnd(pReg->szRCMod, sizeof(pReg->szRCMod))),
284	("%s: %.*s\n", pReg->szName, sizeof(pReg->szRCMod), pReg->szRCMod),
285	VERR_PDM_INVALID_DRIVER_REGISTRATION);
286	AssertMsgReturn(VALID_PTR(pReg->pszDescription),
287	("%s: %p\n", pReg->szName, pReg->pszDescription),
288	VERR_PDM_INVALID_DRIVER_REGISTRATION);
289	AssertMsgReturn(!(pReg->fFlags & ~(PDM_DRVREG_FLAGS_HOST_BITS_MASK \| PDM_DRVREG_FLAGS_R0 \| PDM_DRVREG_FLAGS_RC)),
290	("%s: %#x\n", pReg->szName, pReg->fFlags),
291	VERR_PDM_INVALID_DRIVER_REGISTRATION);
292	AssertMsgReturn((pReg->fFlags & PDM_DRVREG_FLAGS_HOST_BITS_MASK) == PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
293	("%s: %#x\n", pReg->szName, pReg->fFlags),
294	VERR_PDM_INVALID_DRIVER_HOST_BITS);
295	AssertMsgReturn(pReg->cMaxInstances > 0,
296	("%s: %#x\n", pReg->szName, pReg->cMaxInstances),
297	VERR_PDM_INVALID_DRIVER_REGISTRATION);
298	AssertMsgReturn(pReg->cbInstance <= _1M,
299	("%s: %#x\n", pReg->szName, pReg->cbInstance),
300	VERR_PDM_INVALID_DRIVER_REGISTRATION);
301	AssertMsgReturn(VALID_PTR(pReg->pfnConstruct),
302	("%s: %p\n", pReg->szName, pReg->pfnConstruct),
303	VERR_PDM_INVALID_DRIVER_REGISTRATION);
304	AssertMsgReturn(VALID_PTR(pReg->pfnRelocate) \|\| !(pReg->fFlags & PDM_DRVREG_FLAGS_RC),
305	("%s: %#x\n", pReg->szName, pReg->cbInstance),
306	VERR_PDM_INVALID_DRIVER_REGISTRATION);
307	AssertMsgReturn(pReg->pfnSoftReset == NULL,
308	("%s: %p\n", pReg->szName, pReg->pfnSoftReset),
309	VERR_PDM_INVALID_DRIVER_REGISTRATION);
310	AssertMsgReturn(pReg->u32VersionEnd == PDM_DRVREG_VERSION,
311	("%s: #x\n", pReg->szName, pReg->u32VersionEnd),
312	VERR_PDM_INVALID_DRIVER_REGISTRATION);
313
314	/*
315	* Check for duplicate and find FIFO entry at the same time.
316	*/
317	PCPDMDRVREGCBINT pRegCB = (PCPDMDRVREGCBINT)pCallbacks;
318	PPDMDRV pDrvPrev = NULL;
319	PPDMDRV pDrv = pRegCB->pVM->pdm.s.pDrvs;
320	for (; pDrv; pDrvPrev = pDrv, pDrv = pDrv->pNext)
321	{
322	if (!strcmp(pDrv->pReg->szName, pReg->szName))
323	{
324	AssertMsgFailed(("Driver '%s' already exists\n", pReg->szName));
325	return VERR_PDM_DRIVER_NAME_CLASH;
326	}
327	}
328
329	/*
330	* Allocate new driver structure and insert it into the list.
331	*/
332	int rc;
333	pDrv = (PPDMDRV)MMR3HeapAlloc(pRegCB->pVM, MM_TAG_PDM_DRIVER, sizeof(*pDrv));
334	if (pDrv)
335	{
336	pDrv->pNext = NULL;
337	pDrv->cInstances = 0;
338	pDrv->iNextInstance = 0;
339	pDrv->pReg = pReg;
340	rc = CFGMR3QueryStringAllocDef( pRegCB->pCfgNode, "RCSearchPath", &pDrv->pszRCSearchPath, NULL);
341	if (RT_SUCCESS(rc))
342	rc = CFGMR3QueryStringAllocDef(pRegCB->pCfgNode, "R0SearchPath", &pDrv->pszR0SearchPath, NULL);
343	if (RT_SUCCESS(rc))
344	{
345	if (pDrvPrev)
346	pDrvPrev->pNext = pDrv;
347	else
348	pRegCB->pVM->pdm.s.pDrvs = pDrv;
349	Log(("PDM: Registered driver '%s'\n", pReg->szName));
350	return VINF_SUCCESS;
351	}
352	MMR3HeapFree(pDrv);
353	}
354	else
355	rc = VERR_NO_MEMORY;
356	return rc;
357	}
358
359
360	/**
361	* Lookups a driver structure by name.
362	* @internal
363	*/
364	PPDMDRV pdmR3DrvLookup(PVM pVM, const char *pszName)
365	{
366	for (PPDMDRV pDrv = pVM->pdm.s.pDrvs; pDrv; pDrv = pDrv->pNext)
367	if (!strcmp(pDrv->pReg->szName, pszName))
368	return pDrv;
369	return NULL;
370	}
371
372
373	/**
374	* Transforms the driver chain as it's being instantiated.
375	*
376	* Worker for pdmR3DrvInstantiate.
377	*
378	* @returns VBox status code.
379	* @param pVM The VM handle.
380	* @param pDrvAbove The driver above, NULL if top.
381	* @param pLun The LUN.
382	* @param ppNode The AttachedDriver node, replaced if any
383	* morphing took place.
384	*/
385	static int pdmR3DrvMaybeTransformChain(PVM pVM, PPDMDRVINS pDrvAbove, PPDMLUN pLun, PCFGMNODE *ppNode)
386	{
387	/*
388	* The typical state of affairs is that there are no injections.
389	*/
390	PCFGMNODE pCurTrans = CFGMR3GetFirstChild(CFGMR3GetChild(CFGMR3GetRoot(pVM), "PDM/DriverTransformations"));
391	if (!pCurTrans)
392	return VINF_SUCCESS;
393
394	/*
395	* Gather the attributes used in the matching process.
396	*/
397	const char *pszDevice = pLun->pDevIns->Internal.s.pDevR3->pReg->szName;
398	char szLun[32];
399	RTStrPrintf(szLun, sizeof(szLun), "%u", pLun->iLun);
400	const char *pszAbove = pDrvAbove ? pDrvAbove->Internal.s.pDrv->pReg->szName : "<top>";
401	char *pszThisDrv;
402	int rc = CFGMR3QueryStringAlloc(*ppNode, "Driver", &pszThisDrv);
403	AssertMsgRCReturn(rc, ("Query for string value of \"Driver\" -> %Rrc\n", rc),
404	rc == VERR_CFGM_VALUE_NOT_FOUND ? VERR_PDM_CFG_MISSING_DRIVER_NAME : rc);
405
406	uint64_t uInjectTransformationAbove = 0;
407	if (pDrvAbove)
408	{
409	rc = CFGMR3QueryIntegerDef(CFGMR3GetParent(*ppNode), "InjectTransformationPtr", &uInjectTransformationAbove, 0);
410	AssertLogRelRCReturn(rc, rc);
411	}
412
413
414	/*
415	* Enumerate possible driver chain transformations.
416	*/
417	unsigned cTransformations = 0;
418	for (; pCurTrans != NULL; pCurTrans = CFGMR3GetNextChild(pCurTrans))
419	{
420	char szCurTransNm[256];
421	rc = CFGMR3GetName(pCurTrans, szCurTransNm, sizeof(szCurTransNm));
422	AssertLogRelRCReturn(rc, rc);
423
424	/* Match against the driver multi pattern. */
425	char *pszMultiPat;
426	rc = CFGMR3QueryStringAllocDef(pCurTrans, "Driver", &pszMultiPat, "*");
427	AssertLogRelRCReturn(rc, rc);
428	bool fMatch = RTStrSimplePatternMultiMatch(pszMultiPat, RTSTR_MAX, pszDevice, RTSTR_MAX, NULL);
429	MMR3HeapFree(pszMultiPat);
430	if (!fMatch)
431	continue;
432
433	/* Match against the lun multi pattern. */
434	rc = CFGMR3QueryStringAllocDef(pCurTrans, "LUN", &pszMultiPat, "*");
435	AssertLogRelRCReturn(rc, rc);
436	fMatch = RTStrSimplePatternMultiMatch(pszMultiPat, RTSTR_MAX, szLun, RTSTR_MAX, NULL);
437	MMR3HeapFree(pszMultiPat);
438	if (!fMatch)
439	continue;
440
441	/* Match against the below-driver multi pattern. */
442	rc = CFGMR3QueryStringAllocDef(pCurTrans, "BelowDriver", &pszMultiPat, "*");
443	AssertLogRelRCReturn(rc, rc);
444	fMatch = RTStrSimplePatternMultiMatch(pszMultiPat, RTSTR_MAX, pszAbove, RTSTR_MAX, NULL);
445	MMR3HeapFree(pszMultiPat);
446	if (!fMatch)
447	continue;
448
449	/* Match against the above-driver multi pattern. */
450	rc = CFGMR3QueryStringAlloc(pCurTrans, "AboveDriver", &pszMultiPat);
451	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
452	rc = VINF_SUCCESS;
453	else
454	{
455	AssertLogRelRCReturn(rc, rc);
456	fMatch = RTStrSimplePatternMultiMatch(pszMultiPat, RTSTR_MAX, pszThisDrv, RTSTR_MAX, NULL);
457	MMR3HeapFree(pszMultiPat);
458	if (!fMatch)
459	continue;
460	if (uInjectTransformationAbove == (uintptr_t)pCurTrans)
461	continue;
462	}
463
464	/*
465	* We've got a match! Now, what are we supposed to do?
466	*/
467	char szAction[16];
468	rc = CFGMR3QueryStringDef(pCurTrans, "Action", szAction, sizeof(szAction), "inject");
469	AssertLogRelRCReturn(rc, rc);
470	AssertLogRelMsgReturn( !strcmp(szAction, "inject")
471	\|\| !strcmp(szAction, "mergeconfig")
472	\|\| !strcmp(szAction, "remove")
473	\|\| !strcmp(szAction, "removetree")
474	\|\| !strcmp(szAction, "replace")
475	\|\| !strcmp(szAction, "replacetree")
476	,
477	("Action='%s', valid values are 'inject', 'mergeconfig', 'replace', 'replacetree', 'remove', 'removetree'.\n", szAction),
478	VERR_PDM_MISCONFIGURED_DRV_TRANSFORMATION);
479	LogRel(("Applying '%s' to '%s'::[%s]...'%s': %s\n", szCurTransNm, pszDevice, szLun, pszThisDrv, szAction));
480	CFGMR3Dump(*ppNode);
481	CFGMR3Dump(pCurTrans);
482
483	/* Get the attached driver to inject. */
484	PCFGMNODE pTransAttDrv = NULL;
485	if (!strcmp(szAction, "inject") \|\| !strcmp(szAction, "replace") \|\| !strcmp(szAction, "replacetree"))
486	{
487	pTransAttDrv = CFGMR3GetChild(pCurTrans, "AttachedDriver");
488	AssertLogRelMsgReturn(pTransAttDrv,
489	("An %s transformation requires an AttachedDriver child node!\n", szAction),
490	VERR_PDM_MISCONFIGURED_DRV_TRANSFORMATION);
491	}
492
493
494	/*
495	* Remove the node.
496	*/
497	if (!strcmp(szAction, "remove") \|\| !strcmp(szAction, "removetree"))
498	{
499	PCFGMNODE pBelowThis = CFGMR3GetChild(*ppNode, "AttachedDriver");
500	if (!pBelowThis \|\| !strcmp(szAction, "removetree"))
501	{
502	CFGMR3RemoveNode(*ppNode);
503	*ppNode = NULL;
504	}
505	else
506	{
507	PCFGMNODE pBelowThisCopy;
508	rc = CFGMR3DuplicateSubTree(pBelowThis, &pBelowThisCopy);
509	AssertLogRelRCReturn(rc, rc);
510
511	rc = CFGMR3ReplaceSubTree(*ppNode, pBelowThisCopy);
512	if (RT_FAILURE(rc))
513	{
514	CFGMR3RemoveNode(pBelowThis);
515	AssertLogRelReturn(("rc=%Rrc\n", rc), rc);
516	}
517	}
518	}
519	/*
520	* Replace the driver about to be instantiated.
521	*/
522	else if (!strcmp(szAction, "replace") \|\| !strcmp(szAction, "replacetree"))
523	{
524	PCFGMNODE pTransCopy;
525	rc = CFGMR3DuplicateSubTree(pTransAttDrv, &pTransCopy);
526	AssertLogRelRCReturn(rc, rc);
527
528	PCFGMNODE pBelowThis = CFGMR3GetChild(*ppNode, "AttachedDriver");
529	if (!pBelowThis \|\| !strcmp(szAction, "replacetree"))
530	rc = VINF_SUCCESS;
531	else
532	{
533	PCFGMNODE pBelowThisCopy;
534	rc = CFGMR3DuplicateSubTree(pBelowThis, &pBelowThisCopy);
535	if (RT_SUCCESS(rc))
536	{
537	rc = CFGMR3InsertSubTree(pTransCopy, "AttachedDriver", pBelowThisCopy, NULL);
538	AssertLogRelRC(rc);
539	if (RT_FAILURE(rc))
540	CFGMR3RemoveNode(pBelowThisCopy);
541	}
542	}
543	if (RT_SUCCESS(rc))
544	rc = CFGMR3ReplaceSubTree(*ppNode, pTransCopy);
545	if (RT_FAILURE(rc))
546	CFGMR3RemoveNode(pTransCopy);
547	}
548	/*
549	* Inject a driver before the driver about to be instantiated.
550	*/
551	else if (!strcmp(szAction, "inject"))
552	{
553	PCFGMNODE pTransCopy;
554	rc = CFGMR3DuplicateSubTree(pTransAttDrv, &pTransCopy);
555	AssertLogRelRCReturn(rc, rc);
556
557	PCFGMNODE pThisCopy;
558	rc = CFGMR3DuplicateSubTree(*ppNode, &pThisCopy);
559	if (RT_SUCCESS(rc))
560	{
561	rc = CFGMR3InsertSubTree(pTransCopy, "AttachedDriver", pThisCopy, NULL);
562	if (RT_SUCCESS(rc))
563	{
564	rc = CFGMR3InsertInteger(pTransCopy, "InjectTransformationPtr", (uintptr_t)pCurTrans);
565	AssertLogRelRC(rc);
566	rc = CFGMR3InsertString(pTransCopy, "InjectTransformationNm", szCurTransNm);
567	AssertLogRelRC(rc);
568	if (RT_SUCCESS(rc))
569	rc = CFGMR3ReplaceSubTree(*ppNode, pTransCopy);
570	}
571	else
572	{
573	AssertLogRelRC(rc);
574	CFGMR3RemoveNode(pThisCopy);
575	}
576	}
577	if (RT_FAILURE(rc))
578	CFGMR3RemoveNode(pTransCopy);
579	}
580	/*
581	* Merge the Config node of the transformation with the one of the
582	* current driver.
583	*/
584	else if (!strcmp(szAction, "mergeconfig"))
585	{
586	PCFGMNODE pTransConfig = CFGMR3GetChild(pCurTrans, "Config");
587	AssertLogRelReturn(pTransConfig, VERR_PDM_MISCONFIGURED_DRV_TRANSFORMATION);
588
589	PCFGMNODE pDrvConfig = CFGMR3GetChild(*ppNode, "Config");
590	if (*ppNode)
591	CFGMR3InsertNode(*ppNode, "Config", &pDrvConfig);
592	AssertLogRelReturn(pDrvConfig, VERR_PDM_CANNOT_TRANSFORM_REMOVED_DRIVER);
593
594	rc = CFGMR3CopyTree(pDrvConfig, pTransConfig, CFGM_COPY_FLAGS_REPLACE_VALUES \| CFGM_COPY_FLAGS_MERGE_KEYS);
595	AssertLogRelRCReturn(rc, rc);
596	}
597	else
598	AssertFailed();
599
600	cTransformations++;
601	if (*ppNode)
602	CFGMR3Dump(*ppNode);
603	else
604	LogRel(("The transformation removed the driver.\n"));
605	}
606
607	/*
608	* Note what happened in the release log.
609	*/
610	if (cTransformations > 0)
611	LogRel(("Transformations done. Applied %u driver transformations.\n", cTransformations));
612
613	return rc;
614	}
615
616
617	/**
618	* Instantiate a driver.
619	*
620	* @returns VBox status code, including informational statuses.
621	*
622	* @param pVM The VM handle.
623	* @param pNode The CFGM node for the driver.
624	* @param pBaseInterface The base interface.
625	* @param pDrvAbove The driver above it. NULL if it's the top-most
626	* driver.
627	* @param pLun The LUN the driver is being attached to. NULL
628	* if we're instantiating a driver chain before
629	* attaching it - untested.
630	* @param ppBaseInterface Where to return the pointer to the base
631	* interface of the newly created driver.
632	*
633	* @remarks Recursive calls to this function is normal as the drivers will
634	* attach to anything below them during the pfnContruct call.
635	*
636	* @todo Need to extend this interface a bit so that the driver
637	* transformation feature can attach drivers to unconfigured LUNs and
638	* at the end of chains.
639	*/
640	int pdmR3DrvInstantiate(PVM pVM, PCFGMNODE pNode, PPDMIBASE pBaseInterface, PPDMDRVINS pDrvAbove,
641	PPDMLUN pLun, PPDMIBASE *ppBaseInterface)
642	{
643	Assert(!pDrvAbove \|\| !pDrvAbove->Internal.s.pDown);
644	Assert(!pDrvAbove \|\| !pDrvAbove->pDownBase);
645
646	Assert(pBaseInterface->pfnQueryInterface(pBaseInterface, PDMIBASE_IID) == pBaseInterface);
647
648	/*
649	* Do driver chain injections
650	*/
651	int rc = pdmR3DrvMaybeTransformChain(pVM, pDrvAbove, pLun, &pNode);
652	if (RT_FAILURE(rc))
653	return rc;
654	if (!pNode)
655	return VERR_PDM_NO_ATTACHED_DRIVER;
656
657	/*
658	* Find the driver.
659	*/
660	char *pszName;
661	rc = CFGMR3QueryStringAlloc(pNode, "Driver", &pszName);
662	if (RT_SUCCESS(rc))
663	{
664	PPDMDRV pDrv = pdmR3DrvLookup(pVM, pszName);
665	MMR3HeapFree(pszName);
666	if ( pDrv
667	&& pDrv->cInstances < pDrv->pReg->cMaxInstances)
668	{
669	/* config node */
670	PCFGMNODE pConfigNode = CFGMR3GetChild(pNode, "Config");
671	if (!pConfigNode)
672	rc = CFGMR3InsertNode(pNode, "Config", &pConfigNode);
673	if (RT_SUCCESS(rc))
674	{
675	CFGMR3SetRestrictedRoot(pConfigNode);
676
677	/*
678	* Allocate the driver instance.
679	*/
680	size_t cb = RT_OFFSETOF(PDMDRVINS, achInstanceData[pDrv->pReg->cbInstance]);
681	cb = RT_ALIGN_Z(cb, 16);
682	bool const fHyperHeap = !!(pDrv->pReg->fFlags & (PDM_DRVREG_FLAGS_R0 \| PDM_DRVREG_FLAGS_RC));
683	PPDMDRVINS pNew;
684	if (fHyperHeap)
685	rc = MMHyperAlloc(pVM, cb, 64, MM_TAG_PDM_DRIVER, (void **)&pNew);
686	else
687	rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_DRIVER, cb, (void **)&pNew);
688	if (pNew)
689	{
690	/*
691	* Initialize the instance structure (declaration order).
692	*/
693	pNew->u32Version = PDM_DRVINS_VERSION;
694	pNew->Internal.s.pUp = pDrvAbove ? pDrvAbove : NULL;
695	//pNew->Internal.s.pDown = NULL;
696	pNew->Internal.s.pLun = pLun;
697	pNew->Internal.s.pDrv = pDrv;
698	pNew->Internal.s.pVMR3 = pVM;
699	pNew->Internal.s.pVMR0 = pDrv->pReg->fFlags & PDM_DRVREG_FLAGS_R0 ? pVM->pVMR0 : NIL_RTR0PTR;
700	pNew->Internal.s.pVMRC = pDrv->pReg->fFlags & PDM_DRVREG_FLAGS_RC ? pVM->pVMRC : NIL_RTRCPTR;
701	//pNew->Internal.s.fDetaching = false;
702	pNew->Internal.s.fVMSuspended = true;
703	//pNew->Internal.s.fVMReset = false;
704	pNew->Internal.s.fHyperHeap = fHyperHeap;
705	//pNew->Internal.s.pfnAsyncNotify = NULL;
706	pNew->Internal.s.pCfgHandle = pNode;
707	pNew->pReg = pDrv->pReg;
708	pNew->pCfg = pConfigNode;
709	pNew->iInstance = pDrv->iNextInstance;
710	pNew->pUpBase = pBaseInterface;
711	Assert(!pDrvAbove \|\| pBaseInterface == &pDrvAbove->IBase);
712	//pNew->pDownBase = NULL;
713	//pNew->IBase.pfnQueryInterface = NULL;
714	pNew->pHlpR3 = &g_pdmR3DrvHlp;
715	pNew->pvInstanceDataR3 = &pNew->achInstanceData[0];
716	if (pDrv->pReg->fFlags & PDM_DRVREG_FLAGS_R0)
717	{
718	pNew->pvInstanceDataR0 = MMHyperR3ToR0(pVM, &pNew->achInstanceData[0]);
719	rc = PDMR3LdrGetSymbolR0(pVM, NULL, "g_pdmR0DrvHlp", &pNew->pHlpR0);
720	AssertReleaseRCReturn(rc, rc);
721
722	}
723	if (pDrv->pReg->fFlags & PDM_DRVREG_FLAGS_RC)
724	{
725	pNew->pvInstanceDataR0 = MMHyperR3ToRC(pVM, &pNew->achInstanceData[0]);
726	rc = PDMR3LdrGetSymbolRC(pVM, NULL, "g_pdmRCDrvHlp", &pNew->pHlpRC);
727	AssertReleaseRCReturn(rc, rc);
728	}
729
730	pDrv->iNextInstance++;
731	pDrv->cInstances++;
732
733	/*
734	* Link with it with the driver above / LUN.
735	*/
736	if (pDrvAbove)
737	{
738	pDrvAbove->pDownBase = &pNew->IBase;
739	pDrvAbove->Internal.s.pDown = pNew;
740	}
741	else if (pLun)
742	pLun->pTop = pNew;
743	if (pLun)
744	pLun->pBottom = pNew;
745
746	/*
747	* Invoke the constructor.
748	*/
749	rc = pDrv->pReg->pfnConstruct(pNew, pNew->pCfg, 0 /fFlags/);
750	if (RT_SUCCESS(rc))
751	{
752	AssertPtr(pNew->IBase.pfnQueryInterface);
753	Assert(pNew->IBase.pfnQueryInterface(&pNew->IBase, PDMIBASE_IID) == &pNew->IBase);
754
755	/* Success! */
756	*ppBaseInterface = &pNew->IBase;
757	if (pLun)
758	Log(("PDM: Attached driver %p:'%s'/%d to LUN#%d on device '%s'/%d, pDrvAbove=%p:'%s'/%d\n",
759	pNew, pDrv->pReg->szName, pNew->iInstance,
760	pLun->iLun,
761	pLun->pDevIns ? pLun->pDevIns->pReg->szName : pLun->pUsbIns->pReg->szName,
762	pLun->pDevIns ? pLun->pDevIns->iInstance : pLun->pUsbIns->iInstance,
763	pDrvAbove, pDrvAbove ? pDrvAbove->pReg->szName : "", pDrvAbove ? pDrvAbove->iInstance : UINT32_MAX));
764	else
765	Log(("PDM: Attached driver %p:'%s'/%d, pDrvAbove=%p:'%s'/%d\n",
766	pNew, pDrv->pReg->szName, pNew->iInstance,
767	pDrvAbove, pDrvAbove ? pDrvAbove->pReg->szName : "", pDrvAbove ? pDrvAbove->iInstance : UINT32_MAX));
768	}
769	else
770	{
771	pdmR3DrvDestroyChain(pNew, PDM_TACH_FLAGS_NO_CALLBACKS);
772	if (rc == VERR_VERSION_MISMATCH)
773	rc = VERR_PDM_DRIVER_VERSION_MISMATCH;
774	}
775	}
776	else
777	{
778	AssertMsgFailed(("Failed to allocate %d bytes for instantiating driver '%s'\n", cb, pszName));
779	rc = VERR_NO_MEMORY;
780	}
781	}
782	else
783	AssertMsgFailed(("Failed to create Config node! rc=%Rrc\n", rc));
784	}
785	else if (pDrv)
786	{
787	AssertMsgFailed(("Too many instances of driver '%s', max is %u\n", pszName, pDrv->pReg->cMaxInstances));
788	rc = VERR_PDM_TOO_MANY_DRIVER_INSTANCES;
789	}
790	else
791	{
792	AssertMsgFailed(("Driver '%s' wasn't found!\n", pszName));
793	rc = VERR_PDM_DRIVER_NOT_FOUND;
794	}
795	}
796	else
797	{
798	AssertMsgFailed(("Query for string value of \"Driver\" -> %Rrc\n", rc));
799	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
800	rc = VERR_PDM_CFG_MISSING_DRIVER_NAME;
801	}
802	return rc;
803	}
804
805
806	/**
807	* Detaches a driver from whatever it's attached to.
808	* This will of course lead to the destruction of the driver and all drivers below it in the chain.
809	*
810	* @returns VINF_SUCCESS
811	* @param pDrvIns The driver instance to detach.
812	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
813	*/
814	int pdmR3DrvDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
815	{
816	PDMDRV_ASSERT_DRVINS(pDrvIns);
817	LogFlow(("pdmR3DrvDetach: pDrvIns=%p '%s'/%d\n", pDrvIns, pDrvIns->pReg->szName, pDrvIns->iInstance));
818	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
819
820	/*
821	* Check that we're not doing this recursively, that could have unwanted sideeffects!
822	*/
823	if (pDrvIns->Internal.s.fDetaching)
824	{
825	AssertMsgFailed(("Recursive detach! '%s'/%d\n", pDrvIns->pReg->szName, pDrvIns->iInstance));
826	return VINF_SUCCESS; }
827
828	/*
829	* Check that we actually can detach this instance.
830	* The requirement is that the driver/device above has a detach method.
831	*/
832	if (pDrvIns->Internal.s.pUp
833	? !pDrvIns->Internal.s.pUp->pReg->pfnDetach
834	: !pDrvIns->Internal.s.pLun->pDevIns->pReg->pfnDetach)
835	{
836	AssertMsgFailed(("Cannot detach driver instance because the driver/device above doesn't support it!\n"));
837	return VERR_PDM_DRIVER_DETACH_NOT_POSSIBLE;
838	}
839
840	/*
841	* Join paths with pdmR3DrvDestroyChain.
842	*/
843	pdmR3DrvDestroyChain(pDrvIns, fFlags);
844	return VINF_SUCCESS;
845	}
846
847
848	/**
849	* Destroys a driver chain starting with the specified driver.
850	*
851	* This is used when unplugging a device at run time.
852	*
853	* @param pDrvIns Pointer to the driver instance to start with.
854	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG, PDM_TACH_FLAGS_NO_CALLBACKS
855	* or 0.
856	*/
857	void pdmR3DrvDestroyChain(PPDMDRVINS pDrvIns, uint32_t fFlags)
858	{
859	PVM pVM = pDrvIns->Internal.s.pVMR3;
860	VM_ASSERT_EMT(pVM);
861
862	/*
863	* Detach the bottommost driver until we've detached pDrvIns.
864	*/
865	pDrvIns->Internal.s.fDetaching = true;
866	PPDMDRVINS pCur;
867	do
868	{
869	/* find the driver to detach. */
870	pCur = pDrvIns;
871	while (pCur->Internal.s.pDown)
872	pCur = pCur->Internal.s.pDown;
873	LogFlow(("pdmR3DrvDestroyChain: pCur=%p '%s'/%d\n", pCur, pCur->pReg->szName, pCur->iInstance));
874
875	/*
876	* Unlink it and notify parent.
877	*/
878	pCur->Internal.s.fDetaching = true;
879
880	PPDMLUN pLun = pCur->Internal.s.pLun;
881	Assert(pLun->pBottom == pCur);
882	pLun->pBottom = pCur->Internal.s.pUp;
883
884	if (pCur->Internal.s.pUp)
885	{
886	/* driver parent */
887	PPDMDRVINS pParent = pCur->Internal.s.pUp;
888	pCur->Internal.s.pUp = NULL;
889	pParent->Internal.s.pDown = NULL;
890
891	if (!(fFlags & PDM_TACH_FLAGS_NO_CALLBACKS) && pParent->pReg->pfnDetach)
892	pParent->pReg->pfnDetach(pParent, fFlags);
893
894	pParent->pDownBase = NULL;
895	}
896	else
897	{
898	/* device parent */
899	Assert(pLun->pTop == pCur);
900	pLun->pTop = NULL;
901	if (!(fFlags & PDM_TACH_FLAGS_NO_CALLBACKS) && pLun->pDevIns->pReg->pfnDetach)
902	{
903	PDMCritSectEnter(pLun->pDevIns->pCritSectRoR3, VERR_IGNORED);
904	pLun->pDevIns->pReg->pfnDetach(pLun->pDevIns, pLun->iLun, fFlags);
905	PDMCritSectLeave(pLun->pDevIns->pCritSectRoR3);
906	}
907	}
908
909	/*
910	* Call destructor.
911	*/
912	pCur->pUpBase = NULL;
913	if (pCur->pReg->pfnDestruct)
914	pCur->pReg->pfnDestruct(pCur);
915	pCur->Internal.s.pDrv->cInstances--;
916
917	/*
918	* Free all resources allocated by the driver.
919	*/
920	/* Queues. */
921	int rc = PDMR3QueueDestroyDriver(pVM, pCur);
922	AssertRC(rc);
923
924	/* Timers. */
925	rc = TMR3TimerDestroyDriver(pVM, pCur);
926	AssertRC(rc);
927
928	/* SSM data units. */
929	rc = SSMR3DeregisterDriver(pVM, pCur, NULL, 0);
930	AssertRC(rc);
931
932	/* PDM threads. */
933	rc = pdmR3ThreadDestroyDriver(pVM, pCur);
934	AssertRC(rc);
935
936	/* Info handlers. */
937	rc = DBGFR3InfoDeregisterDriver(pVM, pCur, NULL);
938	AssertRC(rc);
939
940	/* PDM critsects. */
941	rc = pdmR3CritSectDeleteDriver(pVM, pCur);
942	AssertRC(rc);
943
944	/* Block caches. */
945	PDMR3BlkCacheReleaseDriver(pVM, pCur);
946
947	/* Finally, the driver it self. */
948	bool fHyperHeap = pCur->Internal.s.fHyperHeap;
949	ASMMemFill32(pCur, RT_OFFSETOF(PDMDRVINS, achInstanceData[pCur->pReg->cbInstance]), 0xdeadd0d0);
950	if (fHyperHeap)
951	MMHyperFree(pVM, pCur);
952	else
953	MMR3HeapFree(pCur);
954
955	} while (pCur != pDrvIns);
956	}
957
958
959
960
961	/** @name Driver Helpers
962	* @{
963	*/
964
965	/** @interface_method_impl{PDMDRVHLP,pfnAttach} */
966	static DECLCALLBACK(int) pdmR3DrvHlp_Attach(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface)
967	{
968	PDMDRV_ASSERT_DRVINS(pDrvIns);
969	PVM pVM = pDrvIns->Internal.s.pVMR3;
970	VM_ASSERT_EMT(pVM);
971	LogFlow(("pdmR3DrvHlp_Attach: caller='%s'/%d: fFlags=%#x\n", pDrvIns->pReg->szName, pDrvIns->iInstance, fFlags));
972	Assert(!(fFlags & ~(PDM_TACH_FLAGS_NOT_HOT_PLUG)));
973
974	/*
975	* Check that there isn't anything attached already.
976	*/
977	int rc;
978	if (!pDrvIns->Internal.s.pDown)
979	{
980	Assert(pDrvIns->Internal.s.pLun->pBottom == pDrvIns);
981
982	/*
983	* Get the attached driver configuration.
984	*/
985	PCFGMNODE pNode = CFGMR3GetChild(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver");
986	if (pNode)
987	rc = pdmR3DrvInstantiate(pVM, pNode, &pDrvIns->IBase, pDrvIns, pDrvIns->Internal.s.pLun, ppBaseInterface);
988	else
989	rc = VERR_PDM_NO_ATTACHED_DRIVER;
990	}
991	else
992	{
993	AssertMsgFailed(("Already got a driver attached. The driver should keep track of such things!\n"));
994	rc = VERR_PDM_DRIVER_ALREADY_ATTACHED;
995	}
996
997	LogFlow(("pdmR3DrvHlp_Attach: caller='%s'/%d: return %Rrc\n",
998	pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
999	return rc;
1000	}
1001
1002
1003	/** @interface_method_impl{PDMDRVHLP,pfnDetach} */
1004	static DECLCALLBACK(int) pdmR3DrvHlp_Detach(PPDMDRVINS pDrvIns, uint32_t fFlags)
1005	{
1006	PDMDRV_ASSERT_DRVINS(pDrvIns);
1007	LogFlow(("pdmR3DrvHlp_Detach: caller='%s'/%d: fFlags=%#x\n",
1008	pDrvIns->pReg->szName, pDrvIns->iInstance, fFlags));
1009	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1010
1011	/*
1012	* Anything attached?
1013	*/
1014	int rc;
1015	if (pDrvIns->Internal.s.pDown)
1016	rc = pdmR3DrvDetach(pDrvIns->Internal.s.pDown, fFlags);
1017	else
1018	{
1019	AssertMsgFailed(("Nothing attached!\n"));
1020	rc = VERR_PDM_NO_DRIVER_ATTACHED;
1021	}
1022
1023	LogFlow(("pdmR3DrvHlp_Detach: caller='%s'/%d: returns %Rrc\n",
1024	pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1025	return rc;
1026	}
1027
1028
1029	/** @interface_method_impl{PDMDRVHLP,pfnDetachSelf} */
1030	static DECLCALLBACK(int) pdmR3DrvHlp_DetachSelf(PPDMDRVINS pDrvIns, uint32_t fFlags)
1031	{
1032	PDMDRV_ASSERT_DRVINS(pDrvIns);
1033	LogFlow(("pdmR3DrvHlp_DetachSelf: caller='%s'/%d: fFlags=%#x\n",
1034	pDrvIns->pReg->szName, pDrvIns->iInstance, fFlags));
1035	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1036
1037	int rc = pdmR3DrvDetach(pDrvIns, fFlags);
1038
1039	LogFlow(("pdmR3DrvHlp_Detach: returns %Rrc\n", rc)); /* pDrvIns is freed by now. */
1040	return rc;
1041	}
1042
1043
1044	/** @interface_method_impl{PDMDRVHLP,pfnMountPrepare} */
1045	static DECLCALLBACK(int) pdmR3DrvHlp_MountPrepare(PPDMDRVINS pDrvIns, const char pszFilename, const char pszCoreDriver)
1046	{
1047	PDMDRV_ASSERT_DRVINS(pDrvIns);
1048	LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: pszFilename=%p:{%s} pszCoreDriver=%p:{%s}\n",
1049	pDrvIns->pReg->szName, pDrvIns->iInstance, pszFilename, pszFilename, pszCoreDriver, pszCoreDriver));
1050	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1051
1052	/*
1053	* Do the caller have anything attached below itself?
1054	*/
1055	if (pDrvIns->Internal.s.pDown)
1056	{
1057	AssertMsgFailed(("Cannot prepare a mount when something's attached to you!\n"));
1058	return VERR_PDM_DRIVER_ALREADY_ATTACHED;
1059	}
1060
1061	/*
1062	* We're asked to prepare, so we'll start off by nuking the
1063	* attached configuration tree.
1064	*/
1065	PCFGMNODE pNode = CFGMR3GetChild(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver");
1066	if (pNode)
1067	CFGMR3RemoveNode(pNode);
1068
1069	/*
1070	* If there is no core driver, we'll have to probe for it.
1071	*/
1072	if (!pszCoreDriver)
1073	{
1074	/** @todo implement image probing. */
1075	AssertReleaseMsgFailed(("Not implemented!\n"));
1076	return VERR_NOT_IMPLEMENTED;
1077	}
1078
1079	/*
1080	* Construct the basic attached driver configuration.
1081	*/
1082	int rc = CFGMR3InsertNode(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver", &pNode);
1083	if (RT_SUCCESS(rc))
1084	{
1085	rc = CFGMR3InsertString(pNode, "Driver", pszCoreDriver);
1086	if (RT_SUCCESS(rc))
1087	{
1088	PCFGMNODE pCfg;
1089	rc = CFGMR3InsertNode(pNode, "Config", &pCfg);
1090	if (RT_SUCCESS(rc))
1091	{
1092	rc = CFGMR3InsertString(pCfg, "Path", pszFilename);
1093	if (RT_SUCCESS(rc))
1094	{
1095	LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: returns %Rrc (Driver=%s)\n",
1096	pDrvIns->pReg->szName, pDrvIns->iInstance, rc, pszCoreDriver));
1097	return rc;
1098	}
1099	else
1100	AssertMsgFailed(("Path string insert failed, rc=%Rrc\n", rc));
1101	}
1102	else
1103	AssertMsgFailed(("Config node failed, rc=%Rrc\n", rc));
1104	}
1105	else
1106	AssertMsgFailed(("Driver string insert failed, rc=%Rrc\n", rc));
1107	CFGMR3RemoveNode(pNode);
1108	}
1109	else
1110	AssertMsgFailed(("AttachedDriver node insert failed, rc=%Rrc\n", rc));
1111
1112	LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: returns %Rrc\n",
1113	pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1114	return rc;
1115	}
1116
1117
1118	/** @interface_method_impl{PDMDRVHLP,pfnAssertEMT} */
1119	static DECLCALLBACK(bool) pdmR3DrvHlp_AssertEMT(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction)
1120	{
1121	PDMDRV_ASSERT_DRVINS(pDrvIns);
1122	if (VM_IS_EMT(pDrvIns->Internal.s.pVMR3))
1123	return true;
1124
1125	char szMsg[100];
1126	RTStrPrintf(szMsg, sizeof(szMsg), "AssertEMT '%s'/%d\n", pDrvIns->pReg->szName, pDrvIns->iInstance);
1127	RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
1128	AssertBreakpoint();
1129	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1130	return false;
1131	}
1132
1133
1134	/** @interface_method_impl{PDMDRVHLP,pfnAssertOther} */
1135	static DECLCALLBACK(bool) pdmR3DrvHlp_AssertOther(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction)
1136	{
1137	PDMDRV_ASSERT_DRVINS(pDrvIns);
1138	if (!VM_IS_EMT(pDrvIns->Internal.s.pVMR3))
1139	return true;
1140
1141	char szMsg[100];
1142	RTStrPrintf(szMsg, sizeof(szMsg), "AssertOther '%s'/%d\n", pDrvIns->pReg->szName, pDrvIns->iInstance);
1143	RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
1144	AssertBreakpoint();
1145	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1146	return false;
1147	}
1148
1149
1150	/** @interface_method_impl{PDMDRVHLP,pfnVMSetError} */
1151	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetError(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
1152	{
1153	PDMDRV_ASSERT_DRVINS(pDrvIns);
1154	va_list args;
1155	va_start(args, pszFormat);
1156	int rc2 = VMSetErrorV(pDrvIns->Internal.s.pVMR3, rc, RT_SRC_POS_ARGS, pszFormat, args); Assert(rc2 == rc); NOREF(rc2);
1157	va_end(args);
1158	return rc;
1159	}
1160
1161
1162	/** @interface_method_impl{PDMDRVHLP,pfnVMSetErrorV} */
1163	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetErrorV(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va)
1164	{
1165	PDMDRV_ASSERT_DRVINS(pDrvIns);
1166	int rc2 = VMSetErrorV(pDrvIns->Internal.s.pVMR3, rc, RT_SRC_POS_ARGS, pszFormat, va); Assert(rc2 == rc); NOREF(rc2);
1167	return rc;
1168	}
1169
1170
1171	/** @interface_method_impl{PDMDRVHLP,pfnVMSetRuntimeError} */
1172	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetRuntimeError(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, ...)
1173	{
1174	PDMDRV_ASSERT_DRVINS(pDrvIns);
1175	va_list args;
1176	va_start(args, pszFormat);
1177	int rc = VMSetRuntimeErrorV(pDrvIns->Internal.s.pVMR3, fFlags, pszErrorId, pszFormat, args);
1178	va_end(args);
1179	return rc;
1180	}
1181
1182
1183	/** @interface_method_impl{PDMDRVHLP,pfnVMSetRuntimeErrorV} */
1184	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetRuntimeErrorV(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list va)
1185	{
1186	PDMDRV_ASSERT_DRVINS(pDrvIns);
1187	int rc = VMSetRuntimeErrorV(pDrvIns->Internal.s.pVMR3, fFlags, pszErrorId, pszFormat, va);
1188	return rc;
1189	}
1190
1191
1192	/** @interface_method_impl{PDMDEVHLPR3,pfnVMState} */
1193	static DECLCALLBACK(VMSTATE) pdmR3DrvHlp_VMState(PPDMDRVINS pDrvIns)
1194	{
1195	PDMDRV_ASSERT_DRVINS(pDrvIns);
1196
1197	VMSTATE enmVMState = VMR3GetState(pDrvIns->Internal.s.pVMR3);
1198
1199	LogFlow(("pdmR3DrvHlp_VMState: caller='%s'/%d: returns %d (%s)\n", pDrvIns->pReg->szName, pDrvIns->iInstance,
1200	enmVMState, VMR3GetStateName(enmVMState)));
1201	return enmVMState;
1202	}
1203
1204
1205	/** @interface_method_impl{PDMDEVHLPR3,pfnVMTeleportedAndNotFullyResumedYet} */
1206	static DECLCALLBACK(bool) pdmR3DrvHlp_VMTeleportedAndNotFullyResumedYet(PPDMDRVINS pDrvIns)
1207	{
1208	PDMDRV_ASSERT_DRVINS(pDrvIns);
1209
1210	bool fRc = VMR3TeleportedAndNotFullyResumedYet(pDrvIns->Internal.s.pVMR3);
1211
1212	LogFlow(("pdmR3DrvHlp_VMState: caller='%s'/%d: returns %RTbool)\n", pDrvIns->pReg->szName, pDrvIns->iInstance,
1213	fRc));
1214	return fRc;
1215	}
1216
1217
1218	/** @interface_method_impl{PDMDEVHLPR3,pfnGetSupDrvSession} */
1219	static DECLCALLBACK(PSUPDRVSESSION) pdmR3DrvHlp_GetSupDrvSession(PPDMDRVINS pDrvIns)
1220	{
1221	PDMDRV_ASSERT_DRVINS(pDrvIns);
1222
1223	PSUPDRVSESSION pSession = pDrvIns->Internal.s.pVMR3->pSession;
1224	LogFlow(("pdmR3DrvHlp_GetSupDrvSession: caller='%s'/%d: returns %p)\n", pDrvIns->pReg->szName, pDrvIns->iInstance,
1225	pSession));
1226	return pSession;
1227	}
1228
1229
1230	/** @interface_method_impl{PDMDRVHLP,pfnQueueCreate} */
1231	static DECLCALLBACK(int) pdmR3DrvHlp_QueueCreate(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
1232	PFNPDMQUEUEDRV pfnCallback, const char pszName, PPDMQUEUE ppQueue)
1233	{
1234	PDMDRV_ASSERT_DRVINS(pDrvIns);
1235	LogFlow(("pdmR3DrvHlp_PDMQueueCreate: caller='%s'/%d: cbItem=%d cItems=%d cMilliesInterval=%d pfnCallback=%p pszName=%p:{%s} ppQueue=%p\n",
1236	pDrvIns->pReg->szName, pDrvIns->iInstance, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, pszName, ppQueue, ppQueue));
1237	PVM pVM = pDrvIns->Internal.s.pVMR3;
1238	VM_ASSERT_EMT(pVM);
1239
1240	if (pDrvIns->iInstance > 0)
1241	{
1242	pszName = MMR3HeapAPrintf(pVM, MM_TAG_PDM_DRIVER_DESC, "%s_%u", pszName, pDrvIns->iInstance);
1243	AssertLogRelReturn(pszName, VERR_NO_MEMORY);
1244	}
1245
1246	int rc = PDMR3QueueCreateDriver(pVM, pDrvIns, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, ppQueue);
1247
1248	LogFlow(("pdmR3DrvHlp_PDMQueueCreate: caller='%s'/%d: returns %Rrc ppQueue=%p\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc, ppQueue));
1249	return rc;
1250	}
1251
1252
1253	/** @interface_method_impl{PDMDRVHLP,pfnTMGetVirtualFreq} */
1254	static DECLCALLBACK(uint64_t) pdmR3DrvHlp_TMGetVirtualFreq(PPDMDRVINS pDrvIns)
1255	{
1256	PDMDRV_ASSERT_DRVINS(pDrvIns);
1257
1258	return TMVirtualGetFreq(pDrvIns->Internal.s.pVMR3);
1259	}
1260
1261
1262	/** @interface_method_impl{PDMDRVHLP,pfnTMGetVirtualTime} */
1263	static DECLCALLBACK(uint64_t) pdmR3DrvHlp_TMGetVirtualTime(PPDMDRVINS pDrvIns)
1264	{
1265	PDMDRV_ASSERT_DRVINS(pDrvIns);
1266
1267	return TMVirtualGet(pDrvIns->Internal.s.pVMR3);
1268	}
1269
1270
1271	/** @interface_method_impl{PDMDRVHLP,pfnTMTimerCreate} */
1272	static DECLCALLBACK(int) pdmR3DrvHlp_TMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void pvUser, uint32_t fFlags, const char pszDesc, PPTMTIMERR3 ppTimer)
1273	{
1274	PDMDRV_ASSERT_DRVINS(pDrvIns);
1275	LogFlow(("pdmR3DrvHlp_TMTimerCreate: caller='%s'/%d: enmClock=%d pfnCallback=%p pvUser=%p fFlags=%#x pszDesc=%p:{%s} ppTimer=%p\n",
1276	pDrvIns->pReg->szName, pDrvIns->iInstance, enmClock, pfnCallback, pvUser, fFlags, pszDesc, pszDesc, ppTimer));
1277
1278	int rc = TMR3TimerCreateDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer);
1279
1280	LogFlow(("pdmR3DrvHlp_TMTimerCreate: caller='%s'/%d: returns %Rrc ppTimer=%p\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc, ppTimer));
1281	return rc;
1282	}
1283
1284
1285
1286	/** @interface_method_impl{PDMDRVHLP,pfnSSMRegister} */
1287	static DECLCALLBACK(int) pdmR3DrvHlp_SSMRegister(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1288	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
1289	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
1290	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
1291	{
1292	PDMDRV_ASSERT_DRVINS(pDrvIns);
1293	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1294	LogFlow(("pdmR3DrvHlp_SSMRegister: caller='%s'/%d: uVersion=#x cbGuess=%#x \n"
1295	" pfnLivePrep=%p pfnLiveExec=%p pfnLiveVote=%p pfnSavePrep=%p pfnSaveExec=%p pfnSaveDone=%p pszLoadPrep=%p pfnLoadExec=%p pfnLoaddone=%p\n",
1296	pDrvIns->pReg->szName, pDrvIns->iInstance, uVersion, cbGuess,
1297	pfnLivePrep, pfnLiveExec, pfnLiveVote,
1298	pfnSavePrep, pfnSaveExec, pfnSaveDone, pfnLoadPrep, pfnLoadExec, pfnLoadDone));
1299
1300	int rc = SSMR3RegisterDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, pDrvIns->pReg->szName, pDrvIns->iInstance,
1301	uVersion, cbGuess,
1302	pfnLivePrep, pfnLiveExec, pfnLiveVote,
1303	pfnSavePrep, pfnSaveExec, pfnSaveDone,
1304	pfnLoadPrep, pfnLoadExec, pfnLoadDone);
1305
1306	LogFlow(("pdmR3DrvHlp_SSMRegister: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1307	return rc;
1308	}
1309
1310
1311	/** @interface_method_impl{PDMDRVHLP,pfnSSMDeregister} */
1312	static DECLCALLBACK(int) pdmR3DrvHlp_SSMDeregister(PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance)
1313	{
1314	PDMDRV_ASSERT_DRVINS(pDrvIns);
1315	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1316	LogFlow(("pdmR3DrvHlp_SSMDeregister: caller='%s'/%d: pszName=%p:{%s} u32Instance=%#x\n",
1317	pDrvIns->pReg->szName, pDrvIns->iInstance, pszName, pszName, u32Instance));
1318
1319	int rc = SSMR3DeregisterDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, pszName, u32Instance);
1320
1321	LogFlow(("pdmR3DrvHlp_SSMDeregister: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1322	return rc;
1323	}
1324
1325
1326	/** @interface_method_impl{PDMDEVHLP,pfnDBGFInfoRegister} */
1327	static DECLCALLBACK(int) pdmR3DrvHlp_DBGFInfoRegister(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1328	{
1329	PDMDRV_ASSERT_DRVINS(pDrvIns);
1330	LogFlow(("pdmR3DrvHlp_DBGFInfoRegister: caller='%s'/%d: pszName=%p:{%s} pszDesc=%p:{%s} pfnHandler=%p\n",
1331	pDrvIns->pReg->szName, pDrvIns->iInstance, pszName, pszName, pszDesc, pszDesc, pfnHandler));
1332
1333	int rc = DBGFR3InfoRegisterDriver(pDrvIns->Internal.s.pVMR3, pszName, pszDesc, pfnHandler, pDrvIns);
1334
1335	LogFlow(("pdmR3DrvHlp_DBGFInfoRegister: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1336	return rc;
1337	}
1338
1339
1340	/** @interface_method_impl{PDMDEVHLP,pfnDBGFInfoDeregister} */
1341	static DECLCALLBACK(int) pdmR3DrvHlp_DBGFInfoDeregister(PPDMDRVINS pDrvIns, const char *pszName)
1342	{
1343	PDMDRV_ASSERT_DRVINS(pDrvIns);
1344	LogFlow(("pdmR3DrvHlp_DBGFInfoDeregister: caller='%s'/%d: pszName=%p:{%s} pszDesc=%p:{%s} pfnHandler=%p\n",
1345	pDrvIns->pReg->szName, pDrvIns->iInstance, pszName));
1346
1347	int rc = DBGFR3InfoDeregisterDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, pszName);
1348
1349	LogFlow(("pdmR3DrvHlp_DBGFInfoDeregister: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1350
1351	return rc;
1352	}
1353
1354
1355	/** @interface_method_impl{PDMDRVHLP,pfnSTAMRegister} */
1356	static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegister(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName, STAMUNIT enmUnit, const char *pszDesc)
1357	{
1358	PDMDRV_ASSERT_DRVINS(pDrvIns);
1359	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1360
1361	STAM_REG(pDrvIns->Internal.s.pVMR3, pvSample, enmType, pszName, enmUnit, pszDesc);
1362	/** @todo track the samples so they can be dumped & deregistered when the driver instance is destroyed.
1363	* For now we just have to be careful not to use this call for drivers which can be unloaded. */
1364	}
1365
1366
1367	/** @interface_method_impl{PDMDRVHLP,pfnSTAMRegisterF} */
1368	static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1369	STAMUNIT enmUnit, const char pszDesc, const char pszName, ...)
1370	{
1371	PDMDRV_ASSERT_DRVINS(pDrvIns);
1372	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1373
1374	va_list args;
1375	va_start(args, pszName);
1376	int rc = STAMR3RegisterV(pDrvIns->Internal.s.pVMR3, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
1377	va_end(args);
1378	AssertRC(rc);
1379	}
1380
1381
1382	/** @interface_method_impl{PDMDRVHLP,pfnSTAMRegisterV} */
1383	static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegisterV(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1384	STAMUNIT enmUnit, const char pszDesc, const char pszName, va_list args)
1385	{
1386	PDMDRV_ASSERT_DRVINS(pDrvIns);
1387	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1388
1389	int rc = STAMR3RegisterV(pDrvIns->Internal.s.pVMR3, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
1390	AssertRC(rc);
1391	}
1392
1393
1394	/** @interface_method_impl{PDMDRVHLP,pfnSTAMDeregister} */
1395	static DECLCALLBACK(int) pdmR3DrvHlp_STAMDeregister(PPDMDRVINS pDrvIns, void *pvSample)
1396	{
1397	PDMDRV_ASSERT_DRVINS(pDrvIns);
1398	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1399
1400	int rc = STAMR3DeregisterU(pDrvIns->Internal.s.pVMR3->pUVM, pvSample);
1401	AssertRC(rc);
1402	return rc;
1403	}
1404
1405
1406	/** @interface_method_impl{PDMDRVHLP,pfnSUPCallVMMR0Ex} */
1407	static DECLCALLBACK(int) pdmR3DrvHlp_SUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
1408	{
1409	PDMDRV_ASSERT_DRVINS(pDrvIns);
1410	LogFlow(("pdmR3DrvHlp_SSMCallVMMR0Ex: caller='%s'/%d: uOperation=%u pvArg=%p cbArg=%d\n",
1411	pDrvIns->pReg->szName, pDrvIns->iInstance, uOperation, pvArg, cbArg));
1412	int rc;
1413	if ( uOperation >= VMMR0_DO_SRV_START
1414	&& uOperation < VMMR0_DO_SRV_END)
1415	rc = SUPR3CallVMMR0Ex(pDrvIns->Internal.s.pVMR3->pVMR0, NIL_VMCPUID, uOperation, 0, (PSUPVMMR0REQHDR)pvArg);
1416	else
1417	{
1418	AssertMsgFailed(("Invalid uOperation=%u\n", uOperation));
1419	rc = VERR_INVALID_PARAMETER;
1420	}
1421
1422	LogFlow(("pdmR3DrvHlp_SUPCallVMMR0Ex: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1423	return rc;
1424	}
1425
1426
1427	/** @interface_method_impl{PDMDRVHLP,pfnUSBRegisterHub} */
1428	static DECLCALLBACK(int) pdmR3DrvHlp_USBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
1429	{
1430	PDMDRV_ASSERT_DRVINS(pDrvIns);
1431	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1432	LogFlow(("pdmR3DrvHlp_USBRegisterHub: caller='%s'/%d: fVersions=%#x cPorts=%#x pUsbHubReg=%p ppUsbHubHlp=%p\n",
1433	pDrvIns->pReg->szName, pDrvIns->iInstance, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp));
1434
1435	#ifdef VBOX_WITH_USB
1436	int rc = pdmR3UsbRegisterHub(pDrvIns->Internal.s.pVMR3, pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
1437	#else
1438	int rc = VERR_NOT_SUPPORTED;
1439	#endif
1440
1441	LogFlow(("pdmR3DrvHlp_USBRegisterHub: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1442	return rc;
1443	}
1444
1445
1446	/** @interface_method_impl{PDMDRVHLP,pfnSetAsyncNotification} */
1447	static DECLCALLBACK(int) pdmR3DrvHlp_SetAsyncNotification(PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify)
1448	{
1449	PDMDRV_ASSERT_DRVINS(pDrvIns);
1450	VM_ASSERT_EMT0(pDrvIns->Internal.s.pVMR3);
1451	LogFlow(("pdmR3DrvHlp_SetAsyncNotification: caller='%s'/%d: pfnAsyncNotify=%p\n", pDrvIns->pReg->szName, pDrvIns->iInstance, pfnAsyncNotify));
1452
1453	int rc = VINF_SUCCESS;
1454	AssertStmt(pfnAsyncNotify, rc = VERR_INVALID_PARAMETER);
1455	AssertStmt(!pDrvIns->Internal.s.pfnAsyncNotify, rc = VERR_WRONG_ORDER);
1456	AssertStmt(pDrvIns->Internal.s.fVMSuspended \|\| pDrvIns->Internal.s.fVMReset, rc = VERR_WRONG_ORDER);
1457	VMSTATE enmVMState = VMR3GetState(pDrvIns->Internal.s.pVMR3);
1458	AssertStmt( enmVMState == VMSTATE_SUSPENDING
1459	\|\| enmVMState == VMSTATE_SUSPENDING_EXT_LS
1460	\|\| enmVMState == VMSTATE_SUSPENDING_LS
1461	\|\| enmVMState == VMSTATE_RESETTING
1462	\|\| enmVMState == VMSTATE_RESETTING_LS
1463	\|\| enmVMState == VMSTATE_POWERING_OFF
1464	\|\| enmVMState == VMSTATE_POWERING_OFF_LS,
1465	rc = VERR_INVALID_STATE);
1466
1467	if (RT_SUCCESS(rc))
1468	pDrvIns->Internal.s.pfnAsyncNotify = pfnAsyncNotify;
1469
1470	LogFlow(("pdmR3DrvHlp_SetAsyncNotification: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1471	return rc;
1472	}
1473
1474
1475	/** @interface_method_impl{PDMDRVHLP,pfnAsyncNotificationCompleted} */
1476	static DECLCALLBACK(void) pdmR3DrvHlp_AsyncNotificationCompleted(PPDMDRVINS pDrvIns)
1477	{
1478	PDMDRV_ASSERT_DRVINS(pDrvIns);
1479	PVM pVM = pDrvIns->Internal.s.pVMR3;
1480
1481	VMSTATE enmVMState = VMR3GetState(pVM);
1482	if ( enmVMState == VMSTATE_SUSPENDING
1483	\|\| enmVMState == VMSTATE_SUSPENDING_EXT_LS
1484	\|\| enmVMState == VMSTATE_SUSPENDING_LS
1485	\|\| enmVMState == VMSTATE_RESETTING
1486	\|\| enmVMState == VMSTATE_RESETTING_LS
1487	\|\| enmVMState == VMSTATE_POWERING_OFF
1488	\|\| enmVMState == VMSTATE_POWERING_OFF_LS)
1489	{
1490	LogFlow(("pdmR3DrvHlp_AsyncNotificationCompleted: caller='%s'/%d:\n", pDrvIns->pReg->szName, pDrvIns->iInstance));
1491	VMR3AsyncPdmNotificationWakeupU(pVM->pUVM);
1492	}
1493	else
1494	LogFlow(("pdmR3DrvHlp_AsyncNotificationCompleted: caller='%s'/%d: enmVMState=%d\n", pDrvIns->pReg->szName, pDrvIns->iInstance, enmVMState));
1495	}
1496
1497
1498	/** @interface_method_impl{PDMDRVHLP,pfnThreadCreate} */
1499	static DECLCALLBACK(int) pdmR3DrvHlp_ThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1500	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
1501	{
1502	PDMDRV_ASSERT_DRVINS(pDrvIns);
1503	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1504	LogFlow(("pdmR3DrvHlp_ThreadCreate: caller='%s'/%d: ppThread=%p pvUser=%p pfnThread=%p pfnWakeup=%p cbStack=%#zx enmType=%d pszName=%p:{%s}\n",
1505	pDrvIns->pReg->szName, pDrvIns->iInstance, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName, pszName));
1506
1507	int rc = pdmR3ThreadCreateDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
1508
1509	LogFlow(("pdmR3DrvHlp_ThreadCreate: caller='%s'/%d: returns %Rrc *ppThread=%RTthrd\n", pDrvIns->pReg->szName, pDrvIns->iInstance,
1510	rc, *ppThread));
1511	return rc;
1512	}
1513
1514
1515	/** @interface_method_impl{PDMDRVHLP,pfnAsyncCompletionTemplateCreate} */
1516	static DECLCALLBACK(int) pdmR3DrvHlp_AsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1517	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser,
1518	const char *pszDesc)
1519	{
1520	PDMDRV_ASSERT_DRVINS(pDrvIns);
1521	LogFlow(("pdmR3DrvHlp_AsyncCompletionTemplateCreate: caller='%s'/%d: ppTemplate=%p pfnCompleted=%p pszDesc=%p:{%s}\n",
1522	pDrvIns->pReg->szName, pDrvIns->iInstance, ppTemplate, pfnCompleted, pszDesc, pszDesc));
1523
1524	int rc = PDMR3AsyncCompletionTemplateCreateDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, ppTemplate, pfnCompleted, pvTemplateUser, pszDesc);
1525
1526	LogFlow(("pdmR3DrvHlp_AsyncCompletionTemplateCreate: caller='%s'/%d: returns %Rrc *ppThread=%p\n", pDrvIns->pReg->szName,
1527	pDrvIns->iInstance, rc, *ppTemplate));
1528	return rc;
1529	}
1530
1531
1532	/** @interface_method_impl{PDMDRVHLP,pfnLdrGetRCInterfaceSymbols} */
1533	static DECLCALLBACK(int) pdmR3DrvHlp_LdrGetRCInterfaceSymbols(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1534	const char pszSymPrefix, const char pszSymList)
1535	{
1536	PDMDRV_ASSERT_DRVINS(pDrvIns);
1537	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1538	LogFlow(("pdmR3DrvHlp_LdrGetRCInterfaceSymbols: caller='%s'/%d: pvInterface=%p cbInterface=%zu pszSymPrefix=%p:{%s} pszSymList=%p:{%s}\n",
1539	pDrvIns->pReg->szName, pDrvIns->iInstance, pvInterface, cbInterface, pszSymPrefix, pszSymPrefix, pszSymList, pszSymList));
1540
1541	int rc;
1542	if ( strncmp(pszSymPrefix, "drv", 3) == 0
1543	&& RTStrIStr(pszSymPrefix + 3, pDrvIns->pReg->szName) != NULL)
1544	{
1545	if (pDrvIns->pReg->fFlags & PDM_DRVREG_FLAGS_RC)
1546	rc = PDMR3LdrGetInterfaceSymbols(pDrvIns->Internal.s.pVMR3,
1547	pvInterface, cbInterface,
1548	pDrvIns->pReg->szRCMod, pDrvIns->Internal.s.pDrv->pszRCSearchPath,
1549	pszSymPrefix, pszSymList,
1550	false /fRing0OrRC/);
1551	else
1552	{
1553	AssertMsgFailed(("Not a raw-mode enabled driver\n"));
1554	rc = VERR_PERMISSION_DENIED;
1555	}
1556	}
1557	else
1558	{
1559	AssertMsgFailed(("Invalid prefix '%s' for '%s'; must start with 'drv' and contain the driver name!\n",
1560	pszSymPrefix, pDrvIns->pReg->szName));
1561	rc = VERR_INVALID_NAME;
1562	}
1563
1564	LogFlow(("pdmR3DrvHlp_LdrGetRCInterfaceSymbols: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName,
1565	pDrvIns->iInstance, rc));
1566	return rc;
1567	}
1568
1569
1570	/** @interface_method_impl{PDMDRVHLP,pfnLdrGetR0InterfaceSymbols} */
1571	static DECLCALLBACK(int) pdmR3DrvHlp_LdrGetR0InterfaceSymbols(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1572	const char pszSymPrefix, const char pszSymList)
1573	{
1574	PDMDRV_ASSERT_DRVINS(pDrvIns);
1575	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1576	LogFlow(("pdmR3DrvHlp_LdrGetR0InterfaceSymbols: caller='%s'/%d: pvInterface=%p cbInterface=%zu pszSymPrefix=%p:{%s} pszSymList=%p:{%s}\n",
1577	pDrvIns->pReg->szName, pDrvIns->iInstance, pvInterface, cbInterface, pszSymPrefix, pszSymPrefix, pszSymList, pszSymList));
1578
1579	int rc;
1580	if ( strncmp(pszSymPrefix, "drv", 3) == 0
1581	&& RTStrIStr(pszSymPrefix + 3, pDrvIns->pReg->szName) != NULL)
1582	{
1583	if (pDrvIns->pReg->fFlags & PDM_DRVREG_FLAGS_R0)
1584	rc = PDMR3LdrGetInterfaceSymbols(pDrvIns->Internal.s.pVMR3,
1585	pvInterface, cbInterface,
1586	pDrvIns->pReg->szR0Mod, pDrvIns->Internal.s.pDrv->pszR0SearchPath,
1587	pszSymPrefix, pszSymList,
1588	true /fRing0OrRC/);
1589	else
1590	{
1591	AssertMsgFailed(("Not a ring-0 enabled driver\n"));
1592	rc = VERR_PERMISSION_DENIED;
1593	}
1594	}
1595	else
1596	{
1597	AssertMsgFailed(("Invalid prefix '%s' for '%s'; must start with 'drv' and contain the driver name!\n",
1598	pszSymPrefix, pDrvIns->pReg->szName));
1599	rc = VERR_INVALID_NAME;
1600	}
1601
1602	LogFlow(("pdmR3DrvHlp_LdrGetR0InterfaceSymbols: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName,
1603	pDrvIns->iInstance, rc));
1604	return rc;
1605	}
1606
1607
1608	/** @interface_method_impl{PDMDRVHLP,pfnCritSectInit} */
1609	static DECLCALLBACK(int) pdmR3DrvHlp_CritSectInit(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect,
1610	RT_SRC_POS_DECL, const char *pszName)
1611	{
1612	PDMDRV_ASSERT_DRVINS(pDrvIns);
1613	PVM pVM = pDrvIns->Internal.s.pVMR3;
1614	VM_ASSERT_EMT(pVM);
1615	LogFlow(("pdmR3DrvHlp_CritSectInit: caller='%s'/%d: pCritSect=%p pszName=%s\n",
1616	pDrvIns->pReg->szName, pDrvIns->iInstance, pCritSect, pszName));
1617
1618	int rc = pdmR3CritSectInitDriver(pVM, pDrvIns, pCritSect, RT_SRC_POS_ARGS, "%s_%u", pszName, pDrvIns->iInstance);
1619
1620	LogFlow(("pdmR3DrvHlp_CritSectInit: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName,
1621	pDrvIns->iInstance, rc));
1622	return rc;
1623	}
1624
1625
1626	/** @interface_method_impl{PDMDRVHLP,pfnCallR0} */
1627	static DECLCALLBACK(int) pdmR3DrvHlp_CallR0(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg)
1628	{
1629	PDMDRV_ASSERT_DRVINS(pDrvIns);
1630	PVM pVM = pDrvIns->Internal.s.pVMR3;
1631	LogFlow(("pdmR3DrvHlp_CallR0: caller='%s'/%d: uOperation=%#x u64Arg=%#RX64\n",
1632	pDrvIns->pReg->szName, pDrvIns->iInstance, uOperation, u64Arg));
1633
1634	/*
1635	* Lazy resolve the ring-0 entry point.
1636	*/
1637	int rc = VINF_SUCCESS;
1638	PFNPDMDRVREQHANDLERR0 pfnReqHandlerR0 = pDrvIns->Internal.s.pfnReqHandlerR0;
1639	if (RT_UNLIKELY(pfnReqHandlerR0 == NIL_RTR0PTR))
1640	{
1641	if (pDrvIns->pReg->fFlags & PDM_DRVREG_FLAGS_R0)
1642	{
1643	char szSymbol[ sizeof("drvR0") + sizeof(pDrvIns->pReg->szName) + sizeof("ReqHandler")];
1644	strcat(strcat(strcpy(szSymbol, "drvR0"), pDrvIns->pReg->szName), "ReqHandler");
1645	szSymbol[sizeof("drvR0") - 1] = RT_C_TO_UPPER(szSymbol[sizeof("drvR0") - 1]);
1646
1647	rc = PDMR3LdrGetSymbolR0Lazy(pVM, pDrvIns->pReg->szR0Mod, pDrvIns->Internal.s.pDrv->pszR0SearchPath, szSymbol,
1648	&pfnReqHandlerR0);
1649	if (RT_SUCCESS(rc))
1650	pDrvIns->Internal.s.pfnReqHandlerR0 = pfnReqHandlerR0;
1651	else
1652	pfnReqHandlerR0 = NIL_RTR0PTR;
1653	}
1654	else
1655	rc = VERR_ACCESS_DENIED;
1656	}
1657	if (RT_LIKELY(pfnReqHandlerR0 != NIL_RTR0PTR))
1658	{
1659	/*
1660	* Make the ring-0 call.
1661	*/
1662	PDMDRIVERCALLREQHANDLERREQ Req;
1663	Req.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1664	Req.Hdr.cbReq = sizeof(Req);
1665	Req.pDrvInsR0 = PDMDRVINS_2_R0PTR(pDrvIns);
1666	Req.uOperation = uOperation;
1667	Req.u32Alignment = 0;
1668	Req.u64Arg = u64Arg;
1669	rc = SUPR3CallVMMR0Ex(pVM->pVMR0, NIL_VMCPUID, VMMR0_DO_PDM_DRIVER_CALL_REQ_HANDLER, 0, &Req.Hdr);
1670	}
1671
1672	LogFlow(("pdmR3DrvHlp_CallR0: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName,
1673	pDrvIns->iInstance, rc));
1674	return rc;
1675	}
1676
1677
1678	/** @interface_method_impl{PDMDRVHLP,pfnFTSetCheckpoint} */
1679	static DECLCALLBACK(int) pdmR3DrvHlp_FTSetCheckpoint(PPDMDRVINS pDrvIns, FTMCHECKPOINTTYPE enmType)
1680	{
1681	PDMDRV_ASSERT_DRVINS(pDrvIns);
1682	return FTMSetCheckpoint(pDrvIns->Internal.s.pVMR3, enmType);
1683	}
1684
1685
1686	/** @interface_method_impl{PDMDRVHLP,pfnBlkCacheRetain} */
1687	static DECLCALLBACK(int) pdmR3DrvHlp_BlkCacheRetain(PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1688	PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1689	PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1690	PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1691	const char *pcszId)
1692	{
1693	PDMDRV_ASSERT_DRVINS(pDrvIns);
1694	return PDMR3BlkCacheRetainDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, ppBlkCache,
1695	pfnXferComplete, pfnXferEnqueue, pfnXferEnqueueDiscard, pcszId);
1696	}
1697
1698
1699	/**
1700	* The driver helper structure.
1701	*/
1702	const PDMDRVHLPR3 g_pdmR3DrvHlp =
1703	{
1704	PDM_DRVHLPR3_VERSION,
1705	pdmR3DrvHlp_Attach,
1706	pdmR3DrvHlp_Detach,
1707	pdmR3DrvHlp_DetachSelf,
1708	pdmR3DrvHlp_MountPrepare,
1709	pdmR3DrvHlp_AssertEMT,
1710	pdmR3DrvHlp_AssertOther,
1711	pdmR3DrvHlp_VMSetError,
1712	pdmR3DrvHlp_VMSetErrorV,
1713	pdmR3DrvHlp_VMSetRuntimeError,
1714	pdmR3DrvHlp_VMSetRuntimeErrorV,
1715	pdmR3DrvHlp_VMState,
1716	pdmR3DrvHlp_VMTeleportedAndNotFullyResumedYet,
1717	pdmR3DrvHlp_GetSupDrvSession,
1718	pdmR3DrvHlp_QueueCreate,
1719	pdmR3DrvHlp_TMGetVirtualFreq,
1720	pdmR3DrvHlp_TMGetVirtualTime,
1721	pdmR3DrvHlp_TMTimerCreate,
1722	pdmR3DrvHlp_SSMRegister,
1723	pdmR3DrvHlp_SSMDeregister,
1724	pdmR3DrvHlp_DBGFInfoRegister,
1725	pdmR3DrvHlp_DBGFInfoDeregister,
1726	pdmR3DrvHlp_STAMRegister,
1727	pdmR3DrvHlp_STAMRegisterF,
1728	pdmR3DrvHlp_STAMRegisterV,
1729	pdmR3DrvHlp_STAMDeregister,
1730	pdmR3DrvHlp_SUPCallVMMR0Ex,
1731	pdmR3DrvHlp_USBRegisterHub,
1732	pdmR3DrvHlp_SetAsyncNotification,
1733	pdmR3DrvHlp_AsyncNotificationCompleted,
1734	pdmR3DrvHlp_ThreadCreate,
1735	pdmR3DrvHlp_AsyncCompletionTemplateCreate,
1736	pdmR3DrvHlp_LdrGetRCInterfaceSymbols,
1737	pdmR3DrvHlp_LdrGetR0InterfaceSymbols,
1738	pdmR3DrvHlp_CritSectInit,
1739	pdmR3DrvHlp_CallR0,
1740	pdmR3DrvHlp_FTSetCheckpoint,
1741	pdmR3DrvHlp_BlkCacheRetain,
1742	PDM_DRVHLPR3_VERSION /* u32TheEnd */
1743	};
1744
1745	/** @} */

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

source: vbox/trunk/src/VBox/VMM/VMMR3/PDMDriver.cpp@ 39944

Download in other formats: