PDMDriver.cpp@ 25966

最後變更在這個檔案從25966是 25966,由 vboxsync 提交於 15 年前
PDMIBASE refactoring; use UUID as interface IDs.
屬性 svn:eol-style 設為 `native` 屬性 svn:keywords 設為 `Id`
檔案大小: 47.9 KB

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

注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

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

以其他格式下載: