PDMDriver.cpp@ 26295

Last change on this file since 26295 was 26264, checked in by vboxsync, 15 years ago
VMM: More warnings.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 50.6 KB

Line
1	/* $Id: PDMDriver.cpp 26264 2010-02-05 02:51:28Z vboxsync $ */
2	/** @file
3	* PDM - Pluggable Device and Driver Manager, Driver parts.
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
23	/*******************************************************************************
24	* Header Files *
25	*******************************************************************************/
26	#define LOG_GROUP LOG_GROUP_PDM_DRIVER
27	#include "PDMInternal.h"
28	#include <VBox/pdm.h>
29	#include <VBox/mm.h>
30	#include <VBox/cfgm.h>
31	#include <VBox/vmm.h>
32	#include <VBox/sup.h>
33	#include <VBox/vm.h>
34	#include <VBox/version.h>
35	#include <VBox/err.h>
36
37	#include <VBox/log.h>
38	#include <iprt/assert.h>
39	#include <iprt/thread.h>
40	#include <iprt/string.h>
41	#include <iprt/asm.h>
42	#include <iprt/alloc.h>
43	#include <iprt/path.h>
44
45
46	/*******************************************************************************
47	* Structures and Typedefs *
48	*******************************************************************************/
49	/**
50	* Internal callback structure pointer.
51	*
52	* The main purpose is to define the extra data we associate
53	* with PDMDRVREGCB so we can find the VM instance and so on.
54	*/
55	typedef struct PDMDRVREGCBINT
56	{
57	/** The callback structure. */
58	PDMDRVREGCB Core;
59	/** A bit of padding. */
60	uint32_t u32[4];
61	/** VM Handle. */
62	PVM pVM;
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	/**
76	* Register external drivers
77	*
78	* @returns VBox status code.
79	* @param pVM The VM to operate on.
80	* @param pfnCallback Driver registration callback
81	*/
82	VMMR3DECL(int) PDMR3RegisterDrivers(PVM pVM, FNPDMVBOXDRIVERSREGISTER pfnCallback)
83	{
84	/*
85	* The registration callbacks.
86	*/
87	PDMDRVREGCBINT RegCB;
88	RegCB.Core.u32Version = PDM_DRVREG_CB_VERSION;
89	RegCB.Core.pfnRegister = pdmR3DrvRegister;
90	RegCB.pVM = pVM;
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	* This function will initialize the drivers for this VM instance.
101	*
102	* First of all this mean loading the builtin drivers and letting them
103	* register themselves. Beyond that any additional driver modules are
104	* loaded and called for registration.
105	*
106	* @returns VBox status code.
107	* @param pVM VM Handle.
108	*/
109	int pdmR3DrvInit(PVM pVM)
110	{
111	LogFlow(("pdmR3DrvInit:\n"));
112
113	AssertRelease(!(RT_OFFSETOF(PDMDRVINS, achInstanceData) & 15));
114	PPDMDRVINS pDrvInsAssert;
115	AssertRelease(sizeof(pDrvInsAssert->Internal.s) <= sizeof(pDrvInsAssert->Internal.padding));
116
117	/*
118	* The registration callbacks.
119	*/
120	PDMDRVREGCBINT RegCB;
121	RegCB.Core.u32Version = PDM_DRVREG_CB_VERSION;
122	RegCB.Core.pfnRegister = pdmR3DrvRegister;
123	RegCB.pVM = pVM;
124
125	/*
126	* Load the builtin module
127	*/
128	PCFGMNODE pDriversNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "PDM/Drivers");
129	bool fLoadBuiltin;
130	int rc = CFGMR3QueryBool(pDriversNode, "LoadBuiltin", &fLoadBuiltin);
131	if (rc == VERR_CFGM_VALUE_NOT_FOUND \|\| rc == VERR_CFGM_NO_PARENT)
132	fLoadBuiltin = true;
133	else if (RT_FAILURE(rc))
134	{
135	AssertMsgFailed(("Configuration error: Querying boolean \"LoadBuiltin\" failed with %Rrc\n", rc));
136	return rc;
137	}
138	if (fLoadBuiltin)
139	{
140	/* make filename */
141	char pszFilename = pdmR3FileR3("VBoxDD", /fShared=*/true);
142	if (!pszFilename)
143	return VERR_NO_TMP_MEMORY;
144	rc = pdmR3DrvLoad(pVM, &RegCB, pszFilename, "VBoxDD");
145	RTMemTmpFree(pszFilename);
146	if (RT_FAILURE(rc))
147	return rc;
148	}
149
150	/*
151	* Load additional driver modules.
152	*/
153	for (PCFGMNODE pCur = CFGMR3GetFirstChild(pDriversNode); pCur; pCur = CFGMR3GetNextChild(pCur))
154	{
155	/*
156	* Get the name and path.
157	*/
158	char szName[PDMMOD_NAME_LEN];
159	rc = CFGMR3GetName(pCur, &szName[0], sizeof(szName));
160	if (rc == VERR_CFGM_NOT_ENOUGH_SPACE)
161	{
162	AssertMsgFailed(("configuration error: The module name is too long, cchName=%zu.\n", CFGMR3GetNameLen(pCur)));
163	return VERR_PDM_MODULE_NAME_TOO_LONG;
164	}
165	else if (RT_FAILURE(rc))
166	{
167	AssertMsgFailed(("CFGMR3GetName -> %Rrc.\n", rc));
168	return rc;
169	}
170
171	/* the path is optional, if no path the module name + path is used. */
172	char szFilename[RTPATH_MAX];
173	rc = CFGMR3QueryString(pCur, "Path", &szFilename[0], sizeof(szFilename));
174	if (rc == VERR_CFGM_VALUE_NOT_FOUND \|\| rc == VERR_CFGM_NO_PARENT)
175	strcpy(szFilename, szName);
176	else if (RT_FAILURE(rc))
177	{
178	AssertMsgFailed(("configuration error: Failure to query the module path, rc=%Rrc.\n", rc));
179	return rc;
180	}
181
182	/* prepend path? */
183	if (!RTPathHavePath(szFilename))
184	{
185	char *psz = pdmR3FileR3(szFilename);
186	if (!psz)
187	return VERR_NO_TMP_MEMORY;
188	size_t cch = strlen(psz) + 1;
189	if (cch > sizeof(szFilename))
190	{
191	RTMemTmpFree(psz);
192	AssertMsgFailed(("Filename too long! cch=%d '%s'\n", cch, psz));
193	return VERR_FILENAME_TOO_LONG;
194	}
195	memcpy(szFilename, psz, cch);
196	RTMemTmpFree(psz);
197	}
198
199	/*
200	* Load the module and register it's drivers.
201	*/
202	rc = pdmR3DrvLoad(pVM, &RegCB, szFilename, szName);
203	if (RT_FAILURE(rc))
204	return rc;
205	}
206
207	LogFlow(("pdmR3DrvInit: returns VINF_SUCCESS\n"));
208	return VINF_SUCCESS;
209	}
210
211
212	/**
213	* Loads one driver module and call the registration entry point.
214	*
215	* @returns VBox status code.
216	* @param pVM VM handle.
217	* @param pRegCB The registration callback stuff.
218	* @param pszFilename Module filename.
219	* @param pszName Module name.
220	*/
221	static int pdmR3DrvLoad(PVM pVM, PPDMDRVREGCBINT pRegCB, const char pszFilename, const char pszName)
222	{
223	/*
224	* Load it.
225	*/
226	int rc = pdmR3LoadR3U(pVM->pUVM, pszFilename, pszName);
227	if (RT_SUCCESS(rc))
228	{
229	/*
230	* Get the registration export and call it.
231	*/
232	FNPDMVBOXDRIVERSREGISTER *pfnVBoxDriversRegister;
233	rc = PDMR3LdrGetSymbolR3(pVM, pszName, "VBoxDriversRegister", (void **)&pfnVBoxDriversRegister);
234	if (RT_SUCCESS(rc))
235	{
236	Log(("PDM: Calling VBoxDriversRegister (%p) of %s (%s)\n", pfnVBoxDriversRegister, pszName, pszFilename));
237	rc = pfnVBoxDriversRegister(&pRegCB->Core, VBOX_VERSION);
238	if (RT_SUCCESS(rc))
239	Log(("PDM: Successfully loaded driver module %s (%s).\n", pszName, pszFilename));
240	else
241	AssertMsgFailed(("VBoxDriversRegister failed with rc=%Rrc\n"));
242	}
243	else
244	{
245	AssertMsgFailed(("Failed to locate 'VBoxDriversRegister' in %s (%s) rc=%Rrc\n", pszName, pszFilename, rc));
246	if (rc == VERR_SYMBOL_NOT_FOUND)
247	rc = VERR_PDM_NO_REGISTRATION_EXPORT;
248	}
249	}
250	else
251	AssertMsgFailed(("Failed to load %s (%s) rc=%Rrc!\n", pszName, pszFilename, rc));
252	return rc;
253	}
254
255
256	/** @interface_method_impl{PDMDRVREGCB,pfnRegister} */
257	static DECLCALLBACK(int) pdmR3DrvRegister(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pReg)
258	{
259	/*
260	* Validate the registration structure.
261	*/
262	AssertPtrReturn(pReg, VERR_INVALID_POINTER);
263	AssertMsgReturn(pReg->u32Version == PDM_DRVREG_VERSION,
264	("%#x\n", pReg->u32Version),
265	VERR_PDM_UNKNOWN_DRVREG_VERSION);
266	AssertReturn(pReg->szName[0], VERR_PDM_INVALID_DRIVER_REGISTRATION);
267	AssertMsgReturn(memchr(pReg->szName, '\0', sizeof(pReg->szName)),
268	(".*s\n", sizeof(pReg->szName), pReg->szName),
269	VERR_PDM_INVALID_DRIVER_REGISTRATION);
270	AssertMsgReturn( !(pReg->fFlags & PDM_DRVREG_FLAGS_R0)
271	\|\| ( pReg->szR0Mod[0]
272	&& memchr(pReg->szR0Mod, '\0', sizeof(pReg->szR0Mod))),
273	("%s: %.*s\n", pReg->szName, sizeof(pReg->szR0Mod), pReg->szR0Mod),
274	VERR_PDM_INVALID_DRIVER_REGISTRATION);
275	AssertMsgReturn( !(pReg->fFlags & PDM_DRVREG_FLAGS_RC)
276	\|\| ( pReg->szRCMod[0]
277	&& memchr(pReg->szRCMod, '\0', sizeof(pReg->szRCMod))),
278	("%s: %.*s\n", pReg->szName, sizeof(pReg->szRCMod), pReg->szRCMod),
279	VERR_PDM_INVALID_DRIVER_REGISTRATION);
280	AssertMsgReturn(VALID_PTR(pReg->pszDescription),
281	("%s: %p\n", pReg->szName, pReg->pszDescription),
282	VERR_PDM_INVALID_DRIVER_REGISTRATION);
283	AssertMsgReturn(!(pReg->fFlags & ~(PDM_DRVREG_FLAGS_HOST_BITS_MASK \| PDM_DRVREG_FLAGS_R0 \| PDM_DRVREG_FLAGS_RC)),
284	("%s: %#x\n", pReg->szName, pReg->fFlags),
285	VERR_PDM_INVALID_DRIVER_REGISTRATION);
286	AssertMsgReturn((pReg->fFlags & PDM_DRVREG_FLAGS_HOST_BITS_MASK) == PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
287	("%s: %#x\n", pReg->szName, pReg->fFlags),
288	VERR_PDM_INVALID_DRIVER_HOST_BITS);
289	AssertMsgReturn(pReg->cMaxInstances > 0,
290	("%s: %#x\n", pReg->szName, pReg->cMaxInstances),
291	VERR_PDM_INVALID_DRIVER_REGISTRATION);
292	AssertMsgReturn(pReg->cbInstance <= _1M,
293	("%s: %#x\n", pReg->szName, pReg->cbInstance),
294	VERR_PDM_INVALID_DRIVER_REGISTRATION);
295	AssertMsgReturn(VALID_PTR(pReg->pfnConstruct),
296	("%s: %p\n", pReg->szName, pReg->pfnConstruct),
297	VERR_PDM_INVALID_DRIVER_REGISTRATION);
298	AssertMsgReturn(VALID_PTR(pReg->pfnRelocate) \|\| !(pReg->fFlags & PDM_DRVREG_FLAGS_RC),
299	("%s: %#x\n", pReg->szName, pReg->cbInstance),
300	VERR_PDM_INVALID_DRIVER_REGISTRATION);
301	AssertMsgReturn(pReg->pfnSoftReset == NULL,
302	("%s: %p\n", pReg->szName, pReg->pfnSoftReset),
303	VERR_PDM_INVALID_DRIVER_REGISTRATION);
304	AssertMsgReturn(pReg->u32VersionEnd == PDM_DRVREG_VERSION,
305	("%s: #x\n", pReg->szName, pReg->u32VersionEnd),
306	VERR_PDM_INVALID_DRIVER_REGISTRATION);
307
308	/*
309	* Check for duplicate and find FIFO entry at the same time.
310	*/
311	PCPDMDRVREGCBINT pRegCB = (PCPDMDRVREGCBINT)pCallbacks;
312	PPDMDRV pDrvPrev = NULL;
313	PPDMDRV pDrv = pRegCB->pVM->pdm.s.pDrvs;
314	for (; pDrv; pDrvPrev = pDrv, pDrv = pDrv->pNext)
315	{
316	if (!strcmp(pDrv->pReg->szName, pReg->szName))
317	{
318	AssertMsgFailed(("Driver '%s' already exists\n", pReg->szName));
319	return VERR_PDM_DRIVER_NAME_CLASH;
320	}
321	}
322
323	/*
324	* Allocate new driver structure and insert it into the list.
325	*/
326	pDrv = (PPDMDRV)MMR3HeapAlloc(pRegCB->pVM, MM_TAG_PDM_DRIVER, sizeof(*pDrv));
327	if (pDrv)
328	{
329	pDrv->pNext = NULL;
330	pDrv->cInstances = 0;
331	pDrv->iNextInstance = 0;
332	pDrv->pReg = pReg;
333
334	if (pDrvPrev)
335	pDrvPrev->pNext = pDrv;
336	else
337	pRegCB->pVM->pdm.s.pDrvs = pDrv;
338	Log(("PDM: Registered driver '%s'\n", pReg->szName));
339	return VINF_SUCCESS;
340	}
341	return VERR_NO_MEMORY;
342	}
343
344
345	/**
346	* Lookups a driver structure by name.
347	* @internal
348	*/
349	PPDMDRV pdmR3DrvLookup(PVM pVM, const char *pszName)
350	{
351	for (PPDMDRV pDrv = pVM->pdm.s.pDrvs; pDrv; pDrv = pDrv->pNext)
352	if (!strcmp(pDrv->pReg->szName, pszName))
353	return pDrv;
354	return NULL;
355	}
356
357
358	/**
359	* Instantiate a driver.
360	*
361	* @returns VBox status code, including informational statuses.
362	*
363	* @param pVM The VM handle.
364	* @param pNode The CFGM node for the driver.
365	* @param pBaseInterface The base interface.
366	* @param pDrvAbove The driver above it. NULL if it's the top-most
367	* driver.
368	* @param pLun The LUN the driver is being attached to. NULL
369	* if we're instantiating a driver chain before
370	* attaching it - untested.
371	* @param ppBaseInterface Where to return the pointer to the base
372	* interface of the newly created driver.
373	*
374	* @remarks Recursive calls to this function is normal as the drivers will
375	* attach to anything below them during the pfnContruct call.
376	*/
377	int pdmR3DrvInstantiate(PVM pVM, PCFGMNODE pNode, PPDMIBASE pBaseInterface, PPDMDRVINS pDrvAbove,
378	PPDMLUN pLun, PPDMIBASE *ppBaseInterface)
379	{
380	Assert(!pDrvAbove \|\| !pDrvAbove->Internal.s.pDown);
381	Assert(!pDrvAbove \|\| !pDrvAbove->pDownBase);
382
383	Assert(pBaseInterface->pfnQueryInterface(pBaseInterface, PDMIBASE_IID) == pBaseInterface);
384
385	/*
386	* Find the driver.
387	*/
388	char *pszName;
389	int rc = CFGMR3QueryStringAlloc(pNode, "Driver", &pszName);
390	if (RT_SUCCESS(rc))
391	{
392	PPDMDRV pDrv = pdmR3DrvLookup(pVM, pszName);
393	MMR3HeapFree(pszName);
394	if ( pDrv
395	&& pDrv->cInstances < pDrv->pReg->cMaxInstances)
396	{
397	/* config node */
398	PCFGMNODE pConfigNode = CFGMR3GetChild(pNode, "Config");
399	if (!pConfigNode)
400	rc = CFGMR3InsertNode(pNode, "Config", &pConfigNode);
401	if (RT_SUCCESS(rc))
402	{
403	CFGMR3SetRestrictedRoot(pConfigNode);
404
405	/*
406	* Allocate the driver instance.
407	*/
408	size_t cb = RT_OFFSETOF(PDMDRVINS, achInstanceData[pDrv->pReg->cbInstance]);
409	cb = RT_ALIGN_Z(cb, 16);
410	bool const fHyperHeap = !!(pDrv->pReg->fFlags & (PDM_DRVREG_FLAGS_R0 \| PDM_DRVREG_FLAGS_RC));
411	PPDMDRVINS pNew;
412	if (fHyperHeap)
413	rc = MMHyperAlloc(pVM, cb, 64, MM_TAG_PDM_DRIVER, (void **)&pNew);
414	else
415	rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_DRIVER, cb, (void **)&pNew);
416	if (pNew)
417	{
418	/*
419	* Initialize the instance structure (declaration order).
420	*/
421	pNew->u32Version = PDM_DRVINS_VERSION;
422	pNew->Internal.s.pUp = pDrvAbove ? pDrvAbove : NULL;
423	//pNew->Internal.s.pDown = NULL;
424	pNew->Internal.s.pLun = pLun;
425	pNew->Internal.s.pDrv = pDrv;
426	pNew->Internal.s.pVMR3 = pVM;
427	pNew->Internal.s.pVMR0 = pDrv->pReg->fFlags & PDM_DRVREG_FLAGS_R0 ? pVM->pVMR0 : NIL_RTR0PTR;
428	pNew->Internal.s.pVMRC = pDrv->pReg->fFlags & PDM_DRVREG_FLAGS_RC ? pVM->pVMRC : NIL_RTRCPTR;
429	//pNew->Internal.s.fDetaching = false;
430	pNew->Internal.s.fVMSuspended = true;
431	//pNew->Internal.s.fVMReset = false;
432	pNew->Internal.s.fHyperHeap = fHyperHeap;
433	//pNew->Internal.s.pfnAsyncNotify = NULL;
434	pNew->Internal.s.pCfgHandle = pNode;
435	pNew->pReg = pDrv->pReg;
436	pNew->pCfg = pConfigNode;
437	pNew->iInstance = pDrv->iNextInstance;
438	pNew->pUpBase = pBaseInterface;
439	Assert(!pDrvAbove \|\| pBaseInterface == &pDrvAbove->IBase);
440	//pNew->pDownBase = NULL;
441	//pNew->IBase.pfnQueryInterface = NULL;
442	pNew->pHlpR3 = &g_pdmR3DrvHlp;
443	pNew->pvInstanceDataR3 = &pNew->achInstanceData[0];
444	if (pDrv->pReg->fFlags & PDM_DRVREG_FLAGS_R0)
445	{
446	pNew->pvInstanceDataR0 = MMHyperR3ToR0(pVM, &pNew->achInstanceData[0]);
447	rc = PDMR3LdrGetSymbolR0(pVM, NULL, "g_pdmR0DrvHlp", &pNew->pHlpR0);
448	AssertReleaseRCReturn(rc, rc);
449
450	}
451	if (pDrv->pReg->fFlags & PDM_DRVREG_FLAGS_RC)
452	{
453	pNew->pvInstanceDataR0 = MMHyperR3ToRC(pVM, &pNew->achInstanceData[0]);
454	rc = PDMR3LdrGetSymbolRC(pVM, NULL, "g_pdmRCDrvHlp", &pNew->pHlpRC);
455	AssertReleaseRCReturn(rc, rc);
456	}
457
458	pDrv->iNextInstance++;
459	pDrv->cInstances++;
460
461	/*
462	* Link with it with the driver above / LUN.
463	*/
464	if (pDrvAbove)
465	{
466	pDrvAbove->pDownBase = &pNew->IBase;
467	pDrvAbove->Internal.s.pDown = pNew;
468	}
469	else if (pLun)
470	pLun->pTop = pNew;
471	if (pLun)
472	pLun->pBottom = pNew;
473
474	/*
475	* Invoke the constructor.
476	*/
477	rc = pDrv->pReg->pfnConstruct(pNew, pNew->pCfg, 0 /fFlags/);
478	if (RT_SUCCESS(rc))
479	{
480	AssertPtr(pNew->IBase.pfnQueryInterface);
481	Assert(pNew->IBase.pfnQueryInterface(&pNew->IBase, PDMIBASE_IID) == &pNew->IBase);
482
483	/* Success! */
484	*ppBaseInterface = &pNew->IBase;
485	if (pLun)
486	Log(("PDM: Attached driver %p:'%s'/%d to LUN#%d on device '%s'/%d, pDrvAbove=%p:'%s'/%d\n",
487	pNew, pDrv->pReg->szName, pNew->iInstance,
488	pLun->iLun,
489	pLun->pDevIns ? pLun->pDevIns->pReg->szName : pLun->pUsbIns->pReg->szName,
490	pLun->pDevIns ? pLun->pDevIns->iInstance : pLun->pUsbIns->iInstance,
491	pDrvAbove, pDrvAbove ? pDrvAbove->pReg->szName : "", pDrvAbove ? pDrvAbove->iInstance : UINT32_MAX));
492	else
493	Log(("PDM: Attached driver %p:'%s'/%d, pDrvAbove=%p:'%s'/%d\n",
494	pNew, pDrv->pReg->szName, pNew->iInstance,
495	pDrvAbove, pDrvAbove ? pDrvAbove->pReg->szName : "", pDrvAbove ? pDrvAbove->iInstance : UINT32_MAX));
496	}
497	else
498	pdmR3DrvDestroyChain(pNew, PDM_TACH_FLAGS_NO_CALLBACKS);
499	}
500	else
501	{
502	AssertMsgFailed(("Failed to allocate %d bytes for instantiating driver '%s'\n", cb, pszName));
503	rc = VERR_NO_MEMORY;
504	}
505	}
506	else
507	AssertMsgFailed(("Failed to create Config node! rc=%Rrc\n", rc));
508	}
509	else if (pDrv)
510	{
511	AssertMsgFailed(("Too many instances of driver '%s', max is %u\n", pszName, pDrv->pReg->cMaxInstances));
512	rc = VERR_PDM_TOO_MANY_DRIVER_INSTANCES;
513	}
514	else
515	{
516	AssertMsgFailed(("Driver '%s' wasn't found!\n", pszName));
517	rc = VERR_PDM_DRIVER_NOT_FOUND;
518	}
519	}
520	else
521	{
522	AssertMsgFailed(("Query for string value of \"Driver\" -> %Rrc\n", rc));
523	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
524	rc = VERR_PDM_CFG_MISSING_DRIVER_NAME;
525	}
526	return rc;
527	}
528
529
530	/**
531	* Detaches a driver from whatever it's attached to.
532	* This will of course lead to the destruction of the driver and all drivers below it in the chain.
533	*
534	* @returns VINF_SUCCESS
535	* @param pDrvIns The driver instance to detach.
536	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
537	*/
538	int pdmR3DrvDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
539	{
540	PDMDRV_ASSERT_DRVINS(pDrvIns);
541	LogFlow(("pdmR3DrvDetach: pDrvIns=%p '%s'/%d\n", pDrvIns, pDrvIns->pReg->szName, pDrvIns->iInstance));
542	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
543
544	/*
545	* Check that we're not doing this recursively, that could have unwanted sideeffects!
546	*/
547	if (pDrvIns->Internal.s.fDetaching)
548	{
549	AssertMsgFailed(("Recursive detach! '%s'/%d\n", pDrvIns->pReg->szName, pDrvIns->iInstance));
550	return VINF_SUCCESS; }
551
552	/*
553	* Check that we actually can detach this instance.
554	* The requirement is that the driver/device above has a detach method.
555	*/
556	if (pDrvIns->Internal.s.pUp
557	? !pDrvIns->Internal.s.pUp->pReg->pfnDetach
558	: !pDrvIns->Internal.s.pLun->pDevIns->pReg->pfnDetach)
559	{
560	AssertMsgFailed(("Cannot detach driver instance because the driver/device above doesn't support it!\n"));
561	return VERR_PDM_DRIVER_DETACH_NOT_POSSIBLE;
562	}
563
564	/*
565	* Join paths with pdmR3DrvDestroyChain.
566	*/
567	pdmR3DrvDestroyChain(pDrvIns, fFlags);
568	return VINF_SUCCESS;
569	}
570
571
572	/**
573	* Destroys a driver chain starting with the specified driver.
574	*
575	* This is used when unplugging a device at run time.
576	*
577	* @param pDrvIns Pointer to the driver instance to start with.
578	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG, PDM_TACH_FLAGS_NO_CALLBACKS
579	* or 0.
580	*/
581	void pdmR3DrvDestroyChain(PPDMDRVINS pDrvIns, uint32_t fFlags)
582	{
583	PVM pVM = pDrvIns->Internal.s.pVMR3;
584	VM_ASSERT_EMT(pVM);
585
586	/*
587	* Detach the bottommost driver until we've detached pDrvIns.
588	*/
589	pDrvIns->Internal.s.fDetaching = true;
590	PPDMDRVINS pCur;
591	do
592	{
593	/* find the driver to detach. */
594	pCur = pDrvIns;
595	while (pCur->Internal.s.pDown)
596	pCur = pCur->Internal.s.pDown;
597	LogFlow(("pdmR3DrvDestroyChain: pCur=%p '%s'/%d\n", pCur, pCur->pReg->szName, pCur->iInstance));
598
599	/*
600	* Unlink it and notify parent.
601	*/
602	pCur->Internal.s.fDetaching = true;
603
604	PPDMLUN pLun = pCur->Internal.s.pLun;
605	Assert(pLun->pBottom == pCur);
606	pLun->pBottom = pCur->Internal.s.pUp;
607
608	if (pCur->Internal.s.pUp)
609	{
610	/* driver parent */
611	PPDMDRVINS pParent = pCur->Internal.s.pUp;
612	pCur->Internal.s.pUp = NULL;
613	pParent->Internal.s.pDown = NULL;
614
615	if (!(fFlags & PDM_TACH_FLAGS_NO_CALLBACKS) && pParent->pReg->pfnDetach)
616	pParent->pReg->pfnDetach(pParent, fFlags);
617
618	pParent->pDownBase = NULL;
619	}
620	else
621	{
622	/* device parent */
623	Assert(pLun->pTop == pCur);
624	pLun->pTop = NULL;
625	if (!(fFlags & PDM_TACH_FLAGS_NO_CALLBACKS) && pLun->pDevIns->pReg->pfnDetach)
626	pLun->pDevIns->pReg->pfnDetach(pLun->pDevIns, pLun->iLun, fFlags);
627	}
628
629	/*
630	* Call destructor.
631	*/
632	pCur->pUpBase = NULL;
633	if (pCur->pReg->pfnDestruct)
634	pCur->pReg->pfnDestruct(pCur);
635	pCur->Internal.s.pDrv->cInstances--;
636
637	/*
638	* Free all resources allocated by the driver.
639	*/
640	/* Queues. */
641	int rc = PDMR3QueueDestroyDriver(pVM, pCur);
642	AssertRC(rc);
643
644	/* Timers. */
645	rc = TMR3TimerDestroyDriver(pVM, pCur);
646	AssertRC(rc);
647
648	/* SSM data units. */
649	rc = SSMR3DeregisterDriver(pVM, pCur, NULL, 0);
650	AssertRC(rc);
651
652	/* PDM threads. */
653	rc = pdmR3ThreadDestroyDriver(pVM, pCur);
654	AssertRC(rc);
655
656	/* Finally, the driver it self. */
657	bool fHyperHeap = pCur->Internal.s.fHyperHeap;
658	ASMMemFill32(pCur, RT_OFFSETOF(PDMDRVINS, achInstanceData[pCur->pReg->cbInstance]), 0xdeadd0d0);
659	if (fHyperHeap)
660	MMHyperFree(pVM, pCur);
661	else
662	MMR3HeapFree(pCur);
663
664	} while (pCur != pDrvIns);
665	}
666
667
668
669
670	/** @name Driver Helpers
671	* @{
672	*/
673
674	/** @interface_method_impl{PDMDRVHLP,pfnAttach} */
675	static DECLCALLBACK(int) pdmR3DrvHlp_Attach(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface)
676	{
677	PDMDRV_ASSERT_DRVINS(pDrvIns);
678	PVM pVM = pDrvIns->Internal.s.pVMR3;
679	VM_ASSERT_EMT(pVM);
680	LogFlow(("pdmR3DrvHlp_Attach: caller='%s'/%d: fFlags=%#x\n", pDrvIns->pReg->szName, pDrvIns->iInstance, fFlags));
681	Assert(!(fFlags & ~(PDM_TACH_FLAGS_NOT_HOT_PLUG)));
682
683	/*
684	* Check that there isn't anything attached already.
685	*/
686	int rc;
687	if (!pDrvIns->Internal.s.pDown)
688	{
689	Assert(pDrvIns->Internal.s.pLun->pBottom == pDrvIns);
690
691	/*
692	* Get the attached driver configuration.
693	*/
694	PCFGMNODE pNode = CFGMR3GetChild(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver");
695	if (pNode)
696	rc = pdmR3DrvInstantiate(pVM, pNode, &pDrvIns->IBase, pDrvIns, pDrvIns->Internal.s.pLun, ppBaseInterface);
697	else
698	rc = VERR_PDM_NO_ATTACHED_DRIVER;
699	}
700	else
701	{
702	AssertMsgFailed(("Already got a driver attached. The driver should keep track of such things!\n"));
703	rc = VERR_PDM_DRIVER_ALREADY_ATTACHED;
704	}
705
706	LogFlow(("pdmR3DrvHlp_Attach: caller='%s'/%d: return %Rrc\n",
707	pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
708	return rc;
709	}
710
711
712	/** @interface_method_impl{PDMDRVHLP,pfnDetach} */
713	static DECLCALLBACK(int) pdmR3DrvHlp_Detach(PPDMDRVINS pDrvIns, uint32_t fFlags)
714	{
715	PDMDRV_ASSERT_DRVINS(pDrvIns);
716	LogFlow(("pdmR3DrvHlp_Detach: caller='%s'/%d: fFlags=%#x\n",
717	pDrvIns->pReg->szName, pDrvIns->iInstance, fFlags));
718	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
719
720	/*
721	* Anything attached?
722	*/
723	int rc;
724	if (pDrvIns->Internal.s.pDown)
725	rc = pdmR3DrvDetach(pDrvIns->Internal.s.pDown, fFlags);
726	else
727	{
728	AssertMsgFailed(("Nothing attached!\n"));
729	rc = VERR_PDM_NO_DRIVER_ATTACHED;
730	}
731
732	LogFlow(("pdmR3DrvHlp_Detach: caller='%s'/%d: returns %Rrc\n",
733	pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
734	return rc;
735	}
736
737
738	/** @interface_method_impl{PDMDRVHLP,pfnDetachSelf} */
739	static DECLCALLBACK(int) pdmR3DrvHlp_DetachSelf(PPDMDRVINS pDrvIns, uint32_t fFlags)
740	{
741	PDMDRV_ASSERT_DRVINS(pDrvIns);
742	LogFlow(("pdmR3DrvHlp_DetachSelf: caller='%s'/%d: fFlags=%#x\n",
743	pDrvIns->pReg->szName, pDrvIns->iInstance, fFlags));
744	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
745
746	int rc = pdmR3DrvDetach(pDrvIns, fFlags);
747
748	LogFlow(("pdmR3DrvHlp_Detach: returns %Rrc\n", rc)); /* pDrvIns is freed by now. */
749	return rc;
750	}
751
752
753	/** @interface_method_impl{PDMDRVHLP,pfnMountPrepare} */
754	static DECLCALLBACK(int) pdmR3DrvHlp_MountPrepare(PPDMDRVINS pDrvIns, const char pszFilename, const char pszCoreDriver)
755	{
756	PDMDRV_ASSERT_DRVINS(pDrvIns);
757	LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: pszFilename=%p:{%s} pszCoreDriver=%p:{%s}\n",
758	pDrvIns->pReg->szName, pDrvIns->iInstance, pszFilename, pszFilename, pszCoreDriver, pszCoreDriver));
759	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
760
761	/*
762	* Do the caller have anything attached below itself?
763	*/
764	if (pDrvIns->Internal.s.pDown)
765	{
766	AssertMsgFailed(("Cannot prepare a mount when something's attached to you!\n"));
767	return VERR_PDM_DRIVER_ALREADY_ATTACHED;
768	}
769
770	/*
771	* We're asked to prepare, so we'll start off by nuking the
772	* attached configuration tree.
773	*/
774	PCFGMNODE pNode = CFGMR3GetChild(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver");
775	if (pNode)
776	CFGMR3RemoveNode(pNode);
777
778	/*
779	* If there is no core driver, we'll have to probe for it.
780	*/
781	if (!pszCoreDriver)
782	{
783	/** @todo implement image probing. */
784	AssertReleaseMsgFailed(("Not implemented!\n"));
785	return VERR_NOT_IMPLEMENTED;
786	}
787
788	/*
789	* Construct the basic attached driver configuration.
790	*/
791	int rc = CFGMR3InsertNode(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver", &pNode);
792	if (RT_SUCCESS(rc))
793	{
794	rc = CFGMR3InsertString(pNode, "Driver", pszCoreDriver);
795	if (RT_SUCCESS(rc))
796	{
797	PCFGMNODE pCfg;
798	rc = CFGMR3InsertNode(pNode, "Config", &pCfg);
799	if (RT_SUCCESS(rc))
800	{
801	rc = CFGMR3InsertString(pCfg, "Path", pszFilename);
802	if (RT_SUCCESS(rc))
803	{
804	LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: returns %Rrc (Driver=%s)\n",
805	pDrvIns->pReg->szName, pDrvIns->iInstance, rc, pszCoreDriver));
806	return rc;
807	}
808	else
809	AssertMsgFailed(("Path string insert failed, rc=%Rrc\n", rc));
810	}
811	else
812	AssertMsgFailed(("Config node failed, rc=%Rrc\n", rc));
813	}
814	else
815	AssertMsgFailed(("Driver string insert failed, rc=%Rrc\n", rc));
816	CFGMR3RemoveNode(pNode);
817	}
818	else
819	AssertMsgFailed(("AttachedDriver node insert failed, rc=%Rrc\n", rc));
820
821	LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: returns %Rrc\n",
822	pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
823	return rc;
824	}
825
826
827	/** @interface_method_impl{PDMDRVHLP,pfnAssertEMT} */
828	static DECLCALLBACK(bool) pdmR3DrvHlp_AssertEMT(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction)
829	{
830	PDMDRV_ASSERT_DRVINS(pDrvIns);
831	if (VM_IS_EMT(pDrvIns->Internal.s.pVMR3))
832	return true;
833
834	char szMsg[100];
835	RTStrPrintf(szMsg, sizeof(szMsg), "AssertEMT '%s'/%d\n", pDrvIns->pReg->szName, pDrvIns->iInstance);
836	RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
837	AssertBreakpoint();
838	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
839	return false;
840	}
841
842
843	/** @interface_method_impl{PDMDRVHLP,pfnAssertOther} */
844	static DECLCALLBACK(bool) pdmR3DrvHlp_AssertOther(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction)
845	{
846	PDMDRV_ASSERT_DRVINS(pDrvIns);
847	if (!VM_IS_EMT(pDrvIns->Internal.s.pVMR3))
848	return true;
849
850	char szMsg[100];
851	RTStrPrintf(szMsg, sizeof(szMsg), "AssertOther '%s'/%d\n", pDrvIns->pReg->szName, pDrvIns->iInstance);
852	RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
853	AssertBreakpoint();
854	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
855	return false;
856	}
857
858
859	/** @interface_method_impl{PDMDRVHLP,pfnVMSetError} */
860	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetError(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
861	{
862	PDMDRV_ASSERT_DRVINS(pDrvIns);
863	va_list args;
864	va_start(args, pszFormat);
865	int rc2 = VMSetErrorV(pDrvIns->Internal.s.pVMR3, rc, RT_SRC_POS_ARGS, pszFormat, args); Assert(rc2 == rc); NOREF(rc2);
866	va_end(args);
867	return rc;
868	}
869
870
871	/** @interface_method_impl{PDMDRVHLP,pfnVMSetErrorV} */
872	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetErrorV(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va)
873	{
874	PDMDRV_ASSERT_DRVINS(pDrvIns);
875	int rc2 = VMSetErrorV(pDrvIns->Internal.s.pVMR3, rc, RT_SRC_POS_ARGS, pszFormat, va); Assert(rc2 == rc); NOREF(rc2);
876	return rc;
877	}
878
879
880	/** @interface_method_impl{PDMDRVHLP,pfnVMSetRuntimeError} */
881	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetRuntimeError(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, ...)
882	{
883	PDMDRV_ASSERT_DRVINS(pDrvIns);
884	va_list args;
885	va_start(args, pszFormat);
886	int rc = VMSetRuntimeErrorV(pDrvIns->Internal.s.pVMR3, fFlags, pszErrorId, pszFormat, args);
887	va_end(args);
888	return rc;
889	}
890
891
892	/** @interface_method_impl{PDMDRVHLP,pfnVMSetRuntimeErrorV} */
893	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetRuntimeErrorV(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list va)
894	{
895	PDMDRV_ASSERT_DRVINS(pDrvIns);
896	int rc = VMSetRuntimeErrorV(pDrvIns->Internal.s.pVMR3, fFlags, pszErrorId, pszFormat, va);
897	return rc;
898	}
899
900
901	/** @interface_method_impl{PDMDEVHLPR3,pfnVMState} */
902	static DECLCALLBACK(VMSTATE) pdmR3DrvHlp_VMState(PPDMDRVINS pDrvIns)
903	{
904	PDMDRV_ASSERT_DRVINS(pDrvIns);
905
906	VMSTATE enmVMState = VMR3GetState(pDrvIns->Internal.s.pVMR3);
907
908	LogFlow(("pdmR3DrvHlp_VMState: caller='%s'/%d: returns %d (%s)\n", pDrvIns->pReg->szName, pDrvIns->iInstance,
909	enmVMState, VMR3GetStateName(enmVMState)));
910	return enmVMState;
911	}
912
913
914	/** @interface_method_impl{PDMDEVHLPR3,pfnVMTeleportedAndNotFullyResumedYet} */
915	static DECLCALLBACK(bool) pdmR3DrvHlp_VMTeleportedAndNotFullyResumedYet(PPDMDRVINS pDrvIns)
916	{
917	PDMDRV_ASSERT_DRVINS(pDrvIns);
918
919	bool fRc = VMR3TeleportedAndNotFullyResumedYet(pDrvIns->Internal.s.pVMR3);
920
921	LogFlow(("pdmR3DrvHlp_VMState: caller='%s'/%d: returns %RTbool)\n", pDrvIns->pReg->szName, pDrvIns->iInstance,
922	fRc));
923	return fRc;
924	}
925
926
927	/** @interface_method_impl{PDMDRVHLP,pfnPDMQueueCreate} */
928	static DECLCALLBACK(int) pdmR3DrvHlp_PDMQueueCreate(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
929	PFNPDMQUEUEDRV pfnCallback, const char pszName, PPDMQUEUE ppQueue)
930	{
931	PDMDRV_ASSERT_DRVINS(pDrvIns);
932	LogFlow(("pdmR3DrvHlp_PDMQueueCreate: caller='%s'/%d: cbItem=%d cItems=%d cMilliesInterval=%d pfnCallback=%p pszName=%p:{%s} ppQueue=%p\n",
933	pDrvIns->pReg->szName, pDrvIns->iInstance, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, pszName, ppQueue, ppQueue));
934	PVM pVM = pDrvIns->Internal.s.pVMR3;
935	VM_ASSERT_EMT(pVM);
936
937	if (pDrvIns->iInstance > 0)
938	{
939	pszName = MMR3HeapAPrintf(pVM, MM_TAG_PDM_DRIVER_DESC, "%s_%u", pszName, pDrvIns->iInstance);
940	AssertLogRelReturn(pszName, VERR_NO_MEMORY);
941	}
942
943	int rc = PDMR3QueueCreateDriver(pVM, pDrvIns, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, ppQueue);
944
945	LogFlow(("pdmR3DrvHlp_PDMQueueCreate: caller='%s'/%d: returns %Rrc ppQueue=%p\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc, ppQueue));
946	return rc;
947	}
948
949
950	/** @interface_method_impl{PDMDRVHLP,pfnTMGetVirtualFreq} */
951	static DECLCALLBACK(uint64_t) pdmR3DrvHlp_TMGetVirtualFreq(PPDMDRVINS pDrvIns)
952	{
953	PDMDRV_ASSERT_DRVINS(pDrvIns);
954
955	return TMVirtualGetFreq(pDrvIns->Internal.s.pVMR3);
956	}
957
958
959	/** @interface_method_impl{PDMDRVHLP,pfnTMGetVirtualTime} */
960	static DECLCALLBACK(uint64_t) pdmR3DrvHlp_TMGetVirtualTime(PPDMDRVINS pDrvIns)
961	{
962	PDMDRV_ASSERT_DRVINS(pDrvIns);
963
964	return TMVirtualGet(pDrvIns->Internal.s.pVMR3);
965	}
966
967
968	/** @interface_method_impl{PDMDRVHLP,pfnTMTimerCreate} */
969	static DECLCALLBACK(int) pdmR3DrvHlp_TMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void pvUser, uint32_t fFlags, const char pszDesc, PPTMTIMERR3 ppTimer)
970	{
971	PDMDRV_ASSERT_DRVINS(pDrvIns);
972	LogFlow(("pdmR3DrvHlp_TMTimerCreate: caller='%s'/%d: enmClock=%d pfnCallback=%p pvUser=%p fFlags=%#x pszDesc=%p:{%s} ppTimer=%p\n",
973	pDrvIns->pReg->szName, pDrvIns->iInstance, enmClock, pfnCallback, pvUser, fFlags, pszDesc, pszDesc, ppTimer));
974
975	int rc = TMR3TimerCreateDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer);
976
977	LogFlow(("pdmR3DrvHlp_TMTimerCreate: caller='%s'/%d: returns %Rrc ppTimer=%p\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc, ppTimer));
978	return rc;
979	}
980
981
982
983	/** @interface_method_impl{PDMDRVHLP,pfnSSMRegister} */
984	static DECLCALLBACK(int) pdmR3DrvHlp_SSMRegister(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
985	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
986	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
987	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
988	{
989	PDMDRV_ASSERT_DRVINS(pDrvIns);
990	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
991	LogFlow(("pdmR3DrvHlp_SSMRegister: caller='%s'/%d: uVersion=#x cbGuess=%#x \n"
992	" pfnLivePrep=%p pfnLiveExec=%p pfnLiveVote=%p pfnSavePrep=%p pfnSaveExec=%p pfnSaveDone=%p pszLoadPrep=%p pfnLoadExec=%p pfnLoaddone=%p\n",
993	pDrvIns->pReg->szName, pDrvIns->iInstance, uVersion, cbGuess,
994	pfnLivePrep, pfnLiveExec, pfnLiveVote,
995	pfnSavePrep, pfnSaveExec, pfnSaveDone, pfnLoadPrep, pfnLoadExec, pfnLoadDone));
996
997	int rc = SSMR3RegisterDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, pDrvIns->pReg->szName, pDrvIns->iInstance,
998	uVersion, cbGuess,
999	pfnLivePrep, pfnLiveExec, pfnLiveVote,
1000	pfnSavePrep, pfnSaveExec, pfnSaveDone,
1001	pfnLoadPrep, pfnLoadExec, pfnLoadDone);
1002
1003	LogFlow(("pdmR3DrvHlp_SSMRegister: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1004	return rc;
1005	}
1006
1007
1008	/** @interface_method_impl{PDMDRVHLP,pfnSSMDeregister} */
1009	static DECLCALLBACK(int) pdmR3DrvHlp_SSMDeregister(PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance)
1010	{
1011	PDMDRV_ASSERT_DRVINS(pDrvIns);
1012	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1013	LogFlow(("pdmR3DrvHlp_SSMDeregister: caller='%s'/%d: pszName=%p:{%s} u32Instance=%#x\n",
1014	pDrvIns->pReg->szName, pDrvIns->iInstance, pszName, pszName, u32Instance));
1015
1016	int rc = SSMR3DeregisterDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, pszName, u32Instance);
1017
1018	LogFlow(("pdmR3DrvHlp_SSMDeregister: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1019	return rc;
1020	}
1021
1022
1023	/** @interface_method_impl{PDMDRVHLP,pfnSTAMRegister} */
1024	static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegister(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName, STAMUNIT enmUnit, const char *pszDesc)
1025	{
1026	PDMDRV_ASSERT_DRVINS(pDrvIns);
1027	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1028
1029	STAM_REG(pDrvIns->Internal.s.pVMR3, pvSample, enmType, pszName, enmUnit, pszDesc);
1030	/** @todo track the samples so they can be dumped & deregistered when the driver instance is destroyed.
1031	* For now we just have to be careful not to use this call for drivers which can be unloaded. */
1032	}
1033
1034
1035	/** @interface_method_impl{PDMDRVHLP,pfnSTAMRegisterF} */
1036	static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1037	STAMUNIT enmUnit, const char pszDesc, const char pszName, ...)
1038	{
1039	PDMDRV_ASSERT_DRVINS(pDrvIns);
1040	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1041
1042	va_list args;
1043	va_start(args, pszName);
1044	int rc = STAMR3RegisterV(pDrvIns->Internal.s.pVMR3, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
1045	va_end(args);
1046	AssertRC(rc);
1047	}
1048
1049
1050	/** @interface_method_impl{PDMDRVHLP,pfnSTAMRegisterV} */
1051	static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegisterV(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1052	STAMUNIT enmUnit, const char pszDesc, const char pszName, va_list args)
1053	{
1054	PDMDRV_ASSERT_DRVINS(pDrvIns);
1055	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1056
1057	int rc = STAMR3RegisterV(pDrvIns->Internal.s.pVMR3, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
1058	AssertRC(rc);
1059	}
1060
1061
1062	/** @interface_method_impl{PDMDRVHLP,pfnSTAMDeregister} */
1063	static DECLCALLBACK(int) pdmR3DrvHlp_STAMDeregister(PPDMDRVINS pDrvIns, void *pvSample)
1064	{
1065	PDMDRV_ASSERT_DRVINS(pDrvIns);
1066	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1067
1068	int rc = STAMR3DeregisterU(pDrvIns->Internal.s.pVMR3->pUVM, pvSample);
1069	AssertRC(rc);
1070	return rc;
1071	}
1072
1073
1074	/** @interface_method_impl{PDMDRVHLP,pfnSUPCallVMMR0Ex} */
1075	static DECLCALLBACK(int) pdmR3DrvHlp_SUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
1076	{
1077	PDMDRV_ASSERT_DRVINS(pDrvIns);
1078	LogFlow(("pdmR3DrvHlp_SSMCallVMMR0Ex: caller='%s'/%d: uOperation=%u pvArg=%p cbArg=%d\n",
1079	pDrvIns->pReg->szName, pDrvIns->iInstance, uOperation, pvArg, cbArg));
1080	int rc;
1081	if ( uOperation >= VMMR0_DO_SRV_START
1082	&& uOperation < VMMR0_DO_SRV_END)
1083	rc = SUPR3CallVMMR0Ex(pDrvIns->Internal.s.pVMR3->pVMR0, NIL_VMCPUID, uOperation, 0, (PSUPVMMR0REQHDR)pvArg);
1084	else
1085	{
1086	AssertMsgFailed(("Invalid uOperation=%u\n", uOperation));
1087	rc = VERR_INVALID_PARAMETER;
1088	}
1089
1090	LogFlow(("pdmR3DrvHlp_SUPCallVMMR0Ex: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1091	return rc;
1092	}
1093
1094
1095	/** @interface_method_impl{PDMDRVHLP,pfnUSBRegisterHub} */
1096	static DECLCALLBACK(int) pdmR3DrvHlp_USBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
1097	{
1098	PDMDRV_ASSERT_DRVINS(pDrvIns);
1099	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1100	LogFlow(("pdmR3DrvHlp_USBRegisterHub: caller='%s'/%d: fVersions=%#x cPorts=%#x pUsbHubReg=%p ppUsbHubHlp=%p\n",
1101	pDrvIns->pReg->szName, pDrvIns->iInstance, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp));
1102
1103	#ifdef VBOX_WITH_USB
1104	int rc = pdmR3UsbRegisterHub(pDrvIns->Internal.s.pVMR3, pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
1105	#else
1106	int rc = VERR_NOT_SUPPORTED;
1107	#endif
1108
1109	LogFlow(("pdmR3DrvHlp_USBRegisterHub: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1110	return rc;
1111	}
1112
1113
1114	/** @interface_method_impl{PDMDRVHLP,pfnSetAsyncNotification} */
1115	static DECLCALLBACK(int) pdmR3DrvHlp_SetAsyncNotification(PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify)
1116	{
1117	PDMDRV_ASSERT_DRVINS(pDrvIns);
1118	VM_ASSERT_EMT0(pDrvIns->Internal.s.pVMR3);
1119	LogFlow(("pdmR3DrvHlp_SetAsyncNotification: caller='%s'/%d: pfnAsyncNotify=%p\n", pDrvIns->pReg->szName, pDrvIns->iInstance, pfnAsyncNotify));
1120
1121	int rc = VINF_SUCCESS;
1122	AssertStmt(pfnAsyncNotify, rc = VERR_INVALID_PARAMETER);
1123	AssertStmt(!pDrvIns->Internal.s.pfnAsyncNotify, rc = VERR_WRONG_ORDER);
1124	AssertStmt(pDrvIns->Internal.s.fVMSuspended \|\| pDrvIns->Internal.s.fVMReset, rc = VERR_WRONG_ORDER);
1125	VMSTATE enmVMState = VMR3GetState(pDrvIns->Internal.s.pVMR3);
1126	AssertStmt( enmVMState == VMSTATE_SUSPENDING
1127	\|\| enmVMState == VMSTATE_SUSPENDING_EXT_LS
1128	\|\| enmVMState == VMSTATE_SUSPENDING_LS
1129	\|\| enmVMState == VMSTATE_RESETTING
1130	\|\| enmVMState == VMSTATE_RESETTING_LS
1131	\|\| enmVMState == VMSTATE_POWERING_OFF
1132	\|\| enmVMState == VMSTATE_POWERING_OFF_LS,
1133	rc = VERR_INVALID_STATE);
1134
1135	if (RT_SUCCESS(rc))
1136	pDrvIns->Internal.s.pfnAsyncNotify = pfnAsyncNotify;
1137
1138	LogFlow(("pdmR3DrvHlp_SetAsyncNotification: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc));
1139	return rc;
1140	}
1141
1142
1143	/** @interface_method_impl{PDMDRVHLP,pfnAsyncNotificationCompleted} */
1144	static DECLCALLBACK(void) pdmR3DrvHlp_AsyncNotificationCompleted(PPDMDRVINS pDrvIns)
1145	{
1146	PDMDRV_ASSERT_DRVINS(pDrvIns);
1147	PVM pVM = pDrvIns->Internal.s.pVMR3;
1148
1149	VMSTATE enmVMState = VMR3GetState(pVM);
1150	if ( enmVMState == VMSTATE_SUSPENDING
1151	\|\| enmVMState == VMSTATE_SUSPENDING_EXT_LS
1152	\|\| enmVMState == VMSTATE_SUSPENDING_LS
1153	\|\| enmVMState == VMSTATE_RESETTING
1154	\|\| enmVMState == VMSTATE_RESETTING_LS
1155	\|\| enmVMState == VMSTATE_POWERING_OFF
1156	\|\| enmVMState == VMSTATE_POWERING_OFF_LS)
1157	{
1158	LogFlow(("pdmR3DrvHlp_AsyncNotificationCompleted: caller='%s'/%d:\n", pDrvIns->pReg->szName, pDrvIns->iInstance));
1159	VMR3AsyncPdmNotificationWakeupU(pVM->pUVM);
1160	}
1161	else
1162	LogFlow(("pdmR3DrvHlp_AsyncNotificationCompleted: caller='%s'/%d: enmVMState=%d\n", pDrvIns->pReg->szName, pDrvIns->iInstance, enmVMState));
1163	}
1164
1165
1166	/** @interface_method_impl{PDMDRVHLP,pfnPDMThreadCreate} */
1167	static DECLCALLBACK(int) pdmR3DrvHlp_PDMThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1168	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
1169	{
1170	PDMDRV_ASSERT_DRVINS(pDrvIns);
1171	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1172	LogFlow(("pdmR3DrvHlp_PDMThreadCreate: caller='%s'/%d: ppThread=%p pvUser=%p pfnThread=%p pfnWakeup=%p cbStack=%#zx enmType=%d pszName=%p:{%s}\n",
1173	pDrvIns->pReg->szName, pDrvIns->iInstance, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName, pszName));
1174
1175	int rc = pdmR3ThreadCreateDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
1176
1177	LogFlow(("pdmR3DrvHlp_PDMThreadCreate: caller='%s'/%d: returns %Rrc *ppThread=%RTthrd\n", pDrvIns->pReg->szName, pDrvIns->iInstance,
1178	rc, *ppThread));
1179	return rc;
1180	}
1181
1182
1183	/** @interface_method_impl{PDMDRVHLP,pfnPDMAsyncCompletionTemplateCreate} */
1184	static DECLCALLBACK(int) pdmR3DrvHlp_PDMAsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1185	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser,
1186	const char *pszDesc)
1187	{
1188	PDMDRV_ASSERT_DRVINS(pDrvIns);
1189	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1190	LogFlow(("pdmR3DrvHlp_PDMAsyncCompletionTemplateCreate: caller='%s'/%d: ppTemplate=%p pfnCompleted=%p pszDesc=%p:{%s}\n",
1191	pDrvIns->pReg->szName, pDrvIns->iInstance, ppTemplate, pfnCompleted, pszDesc, pszDesc));
1192
1193	int rc = PDMR3AsyncCompletionTemplateCreateDriver(pDrvIns->Internal.s.pVMR3, pDrvIns, ppTemplate, pfnCompleted, pvTemplateUser, pszDesc);
1194
1195	LogFlow(("pdmR3DrvHlp_PDMAsyncCompletionTemplateCreate: caller='%s'/%d: returns %Rrc *ppThread=%p\n", pDrvIns->pReg->szName,
1196	pDrvIns->iInstance, rc, *ppTemplate));
1197	return rc;
1198	}
1199
1200
1201	/** @interface_method_impl{PDMDRVHLP,pfnPDMLdrGetRCInterfaceSymbols} */
1202	static DECLCALLBACK(int) pdmR3DrvHlp_PDMLdrGetRCInterfaceSymbols(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1203	const char pszSymPrefix, const char pszSymList)
1204	{
1205	PDMDRV_ASSERT_DRVINS(pDrvIns);
1206	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1207	LogFlow(("pdmR3DrvHlp_PDMLdrGetRCInterfaceSymbols: caller='%s'/%d: pvInterface=%p cbInterface=%zu pszSymPrefix=%p:{%s} pszSymList=%p:{%s}\n",
1208	pDrvIns->pReg->szName, pDrvIns->iInstance, pvInterface, cbInterface, pszSymPrefix, pszSymPrefix, pszSymList, pszSymList));
1209
1210	int rc;
1211	if ( strncmp(pszSymPrefix, "drv", 3) == 0
1212	&& RTStrIStr(pszSymPrefix + 3, pDrvIns->pReg->szName) != NULL)
1213	{
1214	if (pDrvIns->pReg->fFlags & PDM_DRVREG_FLAGS_RC)
1215	rc = PDMR3LdrGetInterfaceSymbols(pDrvIns->Internal.s.pVMR3, pvInterface, cbInterface,
1216	pDrvIns->pReg->szName, pszSymPrefix, pszSymList,
1217	false /fRing0OrRC/);
1218	else
1219	{
1220	AssertMsgFailed(("Not a raw-mode enabled driver\n"));
1221	rc = VERR_PERMISSION_DENIED;
1222	}
1223	}
1224	else
1225	{
1226	AssertMsgFailed(("Invalid prefix '%s' for '%s'; must start with 'drv' and contain the driver name!\n",
1227	pszSymPrefix, pDrvIns->pReg->szName));
1228	rc = VERR_INVALID_NAME;
1229	}
1230
1231	LogFlow(("pdmR3DrvHlp_PDMLdrGetRCInterfaceSymbols: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName,
1232	pDrvIns->iInstance, rc));
1233	return rc;
1234	}
1235
1236
1237	/** @interface_method_impl{PDMDRVHLP,pfnPDMLdrGetR0InterfaceSymbols} */
1238	static DECLCALLBACK(int) pdmR3DrvHlp_PDMLdrGetR0InterfaceSymbols(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1239	const char pszSymPrefix, const char pszSymList)
1240	{
1241	PDMDRV_ASSERT_DRVINS(pDrvIns);
1242	VM_ASSERT_EMT(pDrvIns->Internal.s.pVMR3);
1243	LogFlow(("pdmR3DrvHlp_PDMLdrGetR0InterfaceSymbols: caller='%s'/%d: pvInterface=%p cbInterface=%zu pszSymPrefix=%p:{%s} pszSymList=%p:{%s}\n",
1244	pDrvIns->pReg->szName, pDrvIns->iInstance, pvInterface, cbInterface, pszSymPrefix, pszSymPrefix, pszSymList, pszSymList));
1245
1246	int rc;
1247	if ( strncmp(pszSymPrefix, "drv", 3) == 0
1248	&& RTStrIStr(pszSymPrefix + 3, pDrvIns->pReg->szName) != NULL)
1249	{
1250	if (pDrvIns->pReg->fFlags & PDM_DRVREG_FLAGS_R0)
1251	rc = PDMR3LdrGetInterfaceSymbols(pDrvIns->Internal.s.pVMR3, pvInterface, cbInterface,
1252	pDrvIns->pReg->szName, pszSymPrefix, pszSymList,
1253	true /fRing0OrRC/);
1254	else
1255	{
1256	AssertMsgFailed(("Not a ring-0 enabled driver\n"));
1257	rc = VERR_PERMISSION_DENIED;
1258	}
1259	}
1260	else
1261	{
1262	AssertMsgFailed(("Invalid prefix '%s' for '%s'; must start with 'drv' and contain the driver name!\n",
1263	pszSymPrefix, pDrvIns->pReg->szName));
1264	rc = VERR_INVALID_NAME;
1265	}
1266
1267	LogFlow(("pdmR3DrvHlp_PDMLdrGetR0InterfaceSymbols: caller='%s'/%d: returns %Rrc\n", pDrvIns->pReg->szName,
1268	pDrvIns->iInstance, rc));
1269	return rc;
1270	}
1271
1272
1273	/**
1274	* The driver helper structure.
1275	*/
1276	const PDMDRVHLPR3 g_pdmR3DrvHlp =
1277	{
1278	PDM_DRVHLPR3_VERSION,
1279	pdmR3DrvHlp_Attach,
1280	pdmR3DrvHlp_Detach,
1281	pdmR3DrvHlp_DetachSelf,
1282	pdmR3DrvHlp_MountPrepare,
1283	pdmR3DrvHlp_AssertEMT,
1284	pdmR3DrvHlp_AssertOther,
1285	pdmR3DrvHlp_VMSetError,
1286	pdmR3DrvHlp_VMSetErrorV,
1287	pdmR3DrvHlp_VMSetRuntimeError,
1288	pdmR3DrvHlp_VMSetRuntimeErrorV,
1289	pdmR3DrvHlp_VMState,
1290	pdmR3DrvHlp_VMTeleportedAndNotFullyResumedYet,
1291	pdmR3DrvHlp_PDMQueueCreate,
1292	pdmR3DrvHlp_TMGetVirtualFreq,
1293	pdmR3DrvHlp_TMGetVirtualTime,
1294	pdmR3DrvHlp_TMTimerCreate,
1295	pdmR3DrvHlp_SSMRegister,
1296	pdmR3DrvHlp_SSMDeregister,
1297	pdmR3DrvHlp_STAMRegister,
1298	pdmR3DrvHlp_STAMRegisterF,
1299	pdmR3DrvHlp_STAMRegisterV,
1300	pdmR3DrvHlp_STAMDeregister,
1301	pdmR3DrvHlp_SUPCallVMMR0Ex,
1302	pdmR3DrvHlp_USBRegisterHub,
1303	pdmR3DrvHlp_SetAsyncNotification,
1304	pdmR3DrvHlp_AsyncNotificationCompleted,
1305	pdmR3DrvHlp_PDMThreadCreate,
1306	pdmR3DrvHlp_PDMAsyncCompletionTemplateCreate,
1307	pdmR3DrvHlp_PDMLdrGetRCInterfaceSymbols,
1308	pdmR3DrvHlp_PDMLdrGetR0InterfaceSymbols,
1309	PDM_DRVHLPR3_VERSION /* u32TheEnd */
1310	};
1311
1312	/** @} */

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

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

Download in other formats: