PDMDriver.cpp@ 22544

Last change on this file since 22544 was 22480, checked in by vboxsync, 15 years ago
SSM,VMM,Devices,Main,VBoxBFE: Live snapshot/migration SSM API adjustments.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 39.8 KB

Line
1	/* $Id: PDMDriver.cpp 22480 2009-08-26 17:14:13Z 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	/** @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->pvInstanceData == (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, ("%#x\n", pDrvReg->u32Version), VERR_PDM_UNKNOWN_DRVREG_VERSION);
279	AssertReturn(pDrvReg->szDriverName[0], VERR_PDM_INVALID_DRIVER_REGISTRATION);
280	AssertMsgReturn(memchr(pDrvReg->szDriverName, '\0', sizeof(pDrvReg->szDriverName)),
281	(".*s\n", sizeof(pDrvReg->szDriverName), pDrvReg->szDriverName),
282	VERR_PDM_INVALID_DRIVER_REGISTRATION);
283	AssertMsgReturn((pDrvReg->fFlags & PDM_DRVREG_FLAGS_HOST_BITS_MASK) == PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
284	("%s: fFlags=%#x\n", pDrvReg->szDriverName, pDrvReg->fFlags),
285	VERR_PDM_INVALID_DRIVER_HOST_BITS);
286	AssertMsgReturn(pDrvReg->cMaxInstances > 0, ("%s: %#x\n", pDrvReg->szDriverName, pDrvReg->cMaxInstances),
287	VERR_PDM_INVALID_DRIVER_REGISTRATION);
288	AssertMsgReturn(pDrvReg->cbInstance <= _1M, ("%s: %#x\n", pDrvReg->szDriverName, pDrvReg->cbInstance),
289	VERR_PDM_INVALID_DRIVER_REGISTRATION);
290	AssertMsgReturn(VALID_PTR(pDrvReg->pfnConstruct), ("%s: %p\n", pDrvReg->szDriverName, pDrvReg->pfnConstruct),
291	VERR_PDM_INVALID_DRIVER_REGISTRATION);
292	AssertMsgReturn(pDrvReg->pfnSoftReset == NULL, ("%s: %p\n", pDrvReg->szDriverName, pDrvReg->pfnSoftReset),
293	VERR_PDM_INVALID_DRIVER_REGISTRATION);
294	AssertMsgReturn(pDrvReg->u32VersionEnd == PDM_DRVREG_VERSION, ("%s: #x\n", pDrvReg->szDriverName, pDrvReg->u32VersionEnd),
295	VERR_PDM_INVALID_DRIVER_REGISTRATION);
296
297	/*
298	* Check for duplicate and find FIFO entry at the same time.
299	*/
300	PCPDMDRVREGCBINT pRegCB = (PCPDMDRVREGCBINT)pCallbacks;
301	PPDMDRV pDrvPrev = NULL;
302	PPDMDRV pDrv = pRegCB->pVM->pdm.s.pDrvs;
303	for (; pDrv; pDrvPrev = pDrv, pDrv = pDrv->pNext)
304	{
305	if (!strcmp(pDrv->pDrvReg->szDriverName, pDrvReg->szDriverName))
306	{
307	AssertMsgFailed(("Driver '%s' already exists\n", pDrvReg->szDriverName));
308	return VERR_PDM_DRIVER_NAME_CLASH;
309	}
310	}
311
312	/*
313	* Allocate new driver structure and insert it into the list.
314	*/
315	pDrv = (PPDMDRV)MMR3HeapAlloc(pRegCB->pVM, MM_TAG_PDM_DRIVER, sizeof(*pDrv));
316	if (pDrv)
317	{
318	pDrv->pNext = NULL;
319	pDrv->cInstances = 0;
320	pDrv->pDrvReg = pDrvReg;
321
322	if (pDrvPrev)
323	pDrvPrev->pNext = pDrv;
324	else
325	pRegCB->pVM->pdm.s.pDrvs = pDrv;
326	Log(("PDM: Registered driver '%s'\n", pDrvReg->szDriverName));
327	return VINF_SUCCESS;
328	}
329	return VERR_NO_MEMORY;
330	}
331
332
333	/**
334	* Lookups a driver structure by name.
335	* @internal
336	*/
337	PPDMDRV pdmR3DrvLookup(PVM pVM, const char *pszName)
338	{
339	for (PPDMDRV pDrv = pVM->pdm.s.pDrvs; pDrv; pDrv = pDrv->pNext)
340	if (!strcmp(pDrv->pDrvReg->szDriverName, pszName))
341	return pDrv;
342	return NULL;
343	}
344
345
346	/**
347	* Detaches a driver from whatever it's attached to.
348	* This will of course lead to the destruction of the driver and all drivers below it in the chain.
349	*
350	* @returns VINF_SUCCESS
351	* @param pDrvIns The driver instance to detach.
352	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
353	*/
354	int pdmR3DrvDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
355	{
356	PDMDRV_ASSERT_DRVINS(pDrvIns);
357	LogFlow(("pdmR3DrvDetach: pDrvIns=%p '%s'/%d\n", pDrvIns, pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance));
358	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
359
360	/*
361	* Check that we're not doing this recursively, that could have unwanted sideeffects!
362	*/
363	if (pDrvIns->Internal.s.fDetaching)
364	{
365	AssertMsgFailed(("Recursive detach! '%s'/%d\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance));
366	return VINF_SUCCESS;
367	}
368
369	/*
370	* Check that we actually can detach this instance.
371	* The requirement is that the driver/device above has a detach method.
372	*/
373	if (pDrvIns->Internal.s.pUp
374	? !pDrvIns->Internal.s.pUp->pDrvReg->pfnDetach
375	: !pDrvIns->Internal.s.pLun->pDevIns->pDevReg->pfnDetach)
376	{
377	AssertMsgFailed(("Cannot detach driver instance because the driver/device above doesn't support it!\n"));
378	return VERR_PDM_DRIVER_DETACH_NOT_POSSIBLE;
379	}
380
381	/*
382	* Join paths with pdmR3DrvDestroyChain.
383	*/
384	pdmR3DrvDestroyChain(pDrvIns, fFlags);
385	return VINF_SUCCESS;
386	}
387
388
389	/**
390	* Destroys a driver chain starting with the specified driver.
391	*
392	* This is used when unplugging a device at run time.
393	*
394	* @param pDrvIns Pointer to the driver instance to start with.
395	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
396	*/
397	void pdmR3DrvDestroyChain(PPDMDRVINS pDrvIns, uint32_t fFlags)
398	{
399	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
400
401	/*
402	* Detach the bottommost driver until we've detached pDrvIns.
403	*/
404	pDrvIns->Internal.s.fDetaching = true;
405	PPDMDRVINS pCur;
406	do
407	{
408	/* find the driver to detach. */
409	pCur = pDrvIns;
410	while (pCur->Internal.s.pDown)
411	pCur = pCur->Internal.s.pDown;
412	LogFlow(("pdmR3DrvDetach: pCur=%p '%s'/%d\n", pCur, pCur->pDrvReg->szDriverName, pCur->iInstance));
413
414	/*
415	* Unlink it and notify parent.
416	*/
417	pCur->Internal.s.fDetaching = true;
418
419	PPDMLUN pLun = pCur->Internal.s.pLun;
420	Assert(pLun->pBottom == pCur);
421	pLun->pBottom = pCur->Internal.s.pUp;
422
423	if (pCur->Internal.s.pUp)
424	{
425	/* driver parent */
426	PPDMDRVINS pParent = pCur->Internal.s.pUp;
427	pCur->Internal.s.pUp = NULL;
428	pParent->Internal.s.pDown = NULL;
429
430	if (pParent->pDrvReg->pfnDetach)
431	pParent->pDrvReg->pfnDetach(pParent, fFlags);
432
433	pParent->pDownBase = NULL;
434	}
435	else
436	{
437	/* device parent */
438	Assert(pLun->pTop == pCur);
439	pLun->pTop = NULL;
440	if (pLun->pDevIns->pDevReg->pfnDetach)
441	pLun->pDevIns->pDevReg->pfnDetach(pLun->pDevIns, pLun->iLun, fFlags);
442	}
443
444	/*
445	* Call destructor.
446	*/
447	pCur->pUpBase = NULL;
448	if (pCur->pDrvReg->pfnDestruct)
449	pCur->pDrvReg->pfnDestruct(pCur);
450
451	/*
452	* Free all resources allocated by the driver.
453	*/
454	/* Queues. */
455	int rc = PDMR3QueueDestroyDriver(pCur->Internal.s.pVM, pCur);
456	AssertRC(rc);
457	/* Timers. */
458	rc = TMR3TimerDestroyDriver(pCur->Internal.s.pVM, pCur);
459	AssertRC(rc);
460	/* SSM data units. */
461	rc = SSMR3DeregisterDriver(pCur->Internal.s.pVM, pCur, NULL, 0);
462	AssertRC(rc);
463	/* PDM threads. */
464	rc = pdmR3ThreadDestroyDriver(pCur->Internal.s.pVM, pCur);
465	AssertRC(rc);
466	/* Finally, the driver it self. */
467	ASMMemFill32(pCur, RT_OFFSETOF(PDMDRVINS, achInstanceData[pCur->pDrvReg->cbInstance]), 0xdeadd0d0);
468	MMR3HeapFree(pCur);
469
470	} while (pCur != pDrvIns);
471	}
472
473
474
475
476	/** @name Driver Helpers
477	* @{
478	*/
479
480	/** @copydoc PDMDRVHLP::pfnAttach */
481	static DECLCALLBACK(int) pdmR3DrvHlp_Attach(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface)
482	{
483	PDMDRV_ASSERT_DRVINS(pDrvIns);
484	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
485	LogFlow(("pdmR3DrvHlp_Attach: caller='%s'/%d:\n",
486	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance));
487	Assert(!(fFlags & ~(PDM_TACH_FLAGS_NOT_HOT_PLUG)));
488
489	/*
490	* Check that there isn't anything attached already.
491	*/
492	int rc;
493	if (!pDrvIns->Internal.s.pDown)
494	{
495	Assert(pDrvIns->Internal.s.pLun->pBottom == pDrvIns);
496
497	/*
498	* Get the attached driver configuration.
499	*/
500	PCFGMNODE pNode = CFGMR3GetChild(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver");
501	if (pNode)
502	{
503	char *pszName;
504	rc = CFGMR3QueryStringAlloc(pNode, "Driver", &pszName);
505	if (RT_SUCCESS(rc))
506	{
507	/*
508	* Find the driver and allocate instance data.
509	*/
510	PVM pVM = pDrvIns->Internal.s.pVM;
511	PPDMDRV pDrv = pdmR3DrvLookup(pVM, pszName);
512	if (pDrv)
513	{
514	/* config node */
515	PCFGMNODE pConfigNode = CFGMR3GetChild(pNode, "Config");
516	if (!pConfigNode)
517	rc = CFGMR3InsertNode(pNode, "Config", &pConfigNode);
518	if (RT_SUCCESS(rc))
519	{
520	CFGMR3SetRestrictedRoot(pConfigNode);
521
522	size_t cb = RT_OFFSETOF(PDMDRVINS, achInstanceData[pDrv->pDrvReg->cbInstance]);
523	cb = RT_ALIGN_Z(cb, 16);
524	PPDMDRVINS pNew = (PPDMDRVINS)MMR3HeapAllocZ(pVM, MM_TAG_PDM_DRIVER, cb);
525	if (pNew)
526	{
527	/*
528	* Initialize the instance structure (declaration order).
529	*/
530	pNew->u32Version = PDM_DRVINS_VERSION;
531	pNew->Internal.s.pUp = pDrvIns;
532	pNew->Internal.s.pDown = NULL;
533	pNew->Internal.s.pLun = pDrvIns->Internal.s.pLun;
534	pNew->Internal.s.pDrv = pDrv;
535	pNew->Internal.s.pVM = pVM;
536	pNew->Internal.s.fDetaching = false;
537	pNew->Internal.s.pCfgHandle = pNode;
538	pNew->pDrvHlp = &g_pdmR3DrvHlp;
539	pNew->pDrvReg = pDrv->pDrvReg;
540	pNew->pCfgHandle = pConfigNode;
541	pNew->iInstance = pDrv->cInstances++;
542	pNew->pUpBase = &pDrvIns->IBase; /* This ain't safe, you can calc the pDrvIns of the up/down driver! */
543	pNew->pDownBase = NULL;
544	pNew->IBase.pfnQueryInterface = NULL;
545	pNew->pvInstanceData = &pNew->achInstanceData[0];
546
547	/*
548	* Hook it onto the chain and call the constructor.
549	*/
550	pDrvIns->Internal.s.pDown = pNew;
551	pDrvIns->Internal.s.pLun->pBottom = pNew;
552
553	Log(("PDM: Constructing driver '%s' instance %d...\n", pNew->pDrvReg->szDriverName, pNew->iInstance));
554	rc = pDrv->pDrvReg->pfnConstruct(pNew, pNew->pCfgHandle, 0 /fFlags/);
555	if (RT_SUCCESS(rc))
556	{
557	*ppBaseInterface = &pNew->IBase;
558	rc = VINF_SUCCESS;
559	}
560	else
561	{
562	/*
563	* Unlink and free the data.
564	*/
565	Assert(pDrvIns->Internal.s.pLun->pBottom == pNew);
566	pDrvIns->Internal.s.pLun->pBottom = pDrvIns;
567	pDrvIns->Internal.s.pDown = NULL;
568	ASMMemFill32(pNew, cb, 0xdeadd0d0);
569	MMR3HeapFree(pNew);
570	pDrv->cInstances--;
571	}
572	}
573	else
574	{
575	AssertMsgFailed(("Failed to allocate %d bytes for instantiating driver '%s'\n", cb, pszName));
576	rc = VERR_NO_MEMORY;
577	}
578	}
579	else
580	AssertMsgFailed(("Failed to create Config node! rc=%Rrc\n", rc));
581	}
582	else
583	{
584	AssertMsgFailed(("Driver '%s' wasn't found!\n", pszName));
585	rc = VERR_PDM_DRIVER_NOT_FOUND;
586	}
587	MMR3HeapFree(pszName);
588	}
589	else
590	{
591	AssertMsgFailed(("Query for string value of \"Driver\" -> %Rrc\n", rc));
592	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
593	rc = VERR_PDM_CFG_MISSING_DRIVER_NAME;
594	}
595	}
596	else
597	rc = VERR_PDM_NO_ATTACHED_DRIVER;
598	}
599	else
600	{
601	AssertMsgFailed(("Already got a driver attached. The driver should keep track of such things!\n"));
602	rc = VERR_PDM_DRIVER_ALREADY_ATTACHED;
603	}
604
605	LogFlow(("pdmR3DrvHlp_Attach: caller='%s'/%d: return %Rrc\n",
606	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
607	return rc;
608	}
609
610
611	/** @copydoc PDMDRVHLP::pfnDetach */
612	static DECLCALLBACK(int) pdmR3DrvHlp_Detach(PPDMDRVINS pDrvIns, uint32_t fFlags)
613	{
614	PDMDRV_ASSERT_DRVINS(pDrvIns);
615	LogFlow(("pdmR3DrvHlp_Detach: caller='%s'/%d: fFlags=%#x\n",
616	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, fFlags));
617	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
618
619	/*
620	* Anything attached?
621	*/
622	int rc;
623	if (pDrvIns->Internal.s.pDown)
624	rc = pdmR3DrvDetach(pDrvIns->Internal.s.pDown, fFlags);
625	else
626	{
627	AssertMsgFailed(("Nothing attached!\n"));
628	rc = VERR_PDM_NO_DRIVER_ATTACHED;
629	}
630
631	LogFlow(("pdmR3DrvHlp_Detach: caller='%s'/%d: returns %Rrc\n",
632	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
633	return rc;
634	}
635
636
637	/** @copydoc PDMDRVHLP::pfnDetachSelf */
638	static DECLCALLBACK(int) pdmR3DrvHlp_DetachSelf(PPDMDRVINS pDrvIns, uint32_t fFlags)
639	{
640	PDMDRV_ASSERT_DRVINS(pDrvIns);
641	LogFlow(("pdmR3DrvHlp_DetachSelf: caller='%s'/%d: fFlags=%#x\n",
642	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, fFlags));
643	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
644
645	int rc = pdmR3DrvDetach(pDrvIns, fFlags);
646
647	LogFlow(("pdmR3DrvHlp_Detach: returns %Rrc\n", rc)); /* pDrvIns is freed by now. */
648	return rc;
649	}
650
651
652	/** @copydoc PDMDRVHLP::pfnMountPrepare */
653	static DECLCALLBACK(int) pdmR3DrvHlp_MountPrepare(PPDMDRVINS pDrvIns, const char pszFilename, const char pszCoreDriver)
654	{
655	PDMDRV_ASSERT_DRVINS(pDrvIns);
656	LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: pszFilename=%p:{%s} pszCoreDriver=%p:{%s}\n",
657	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pszFilename, pszFilename, pszCoreDriver, pszCoreDriver));
658	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
659
660	/*
661	* Do the caller have anything attached below itself?
662	*/
663	if (pDrvIns->Internal.s.pDown)
664	{
665	AssertMsgFailed(("Cannot prepare a mount when something's attached to you!\n"));
666	return VERR_PDM_DRIVER_ALREADY_ATTACHED;
667	}
668
669	/*
670	* We're asked to prepare, so we'll start off by nuking the
671	* attached configuration tree.
672	*/
673	PCFGMNODE pNode = CFGMR3GetChild(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver");
674	if (pNode)
675	CFGMR3RemoveNode(pNode);
676
677	/*
678	* If there is no core driver, we'll have to probe for it.
679	*/
680	if (!pszCoreDriver)
681	{
682	/** @todo implement image probing. */
683	AssertReleaseMsgFailed(("Not implemented!\n"));
684	return VERR_NOT_IMPLEMENTED;
685	}
686
687	/*
688	* Construct the basic attached driver configuration.
689	*/
690	int rc = CFGMR3InsertNode(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver", &pNode);
691	if (RT_SUCCESS(rc))
692	{
693	rc = CFGMR3InsertString(pNode, "Driver", pszCoreDriver);
694	if (RT_SUCCESS(rc))
695	{
696	PCFGMNODE pCfg;
697	rc = CFGMR3InsertNode(pNode, "Config", &pCfg);
698	if (RT_SUCCESS(rc))
699	{
700	rc = CFGMR3InsertString(pCfg, "Path", pszFilename);
701	if (RT_SUCCESS(rc))
702	{
703	LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: returns %Rrc (Driver=%s)\n",
704	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc, pszCoreDriver));
705	return rc;
706	}
707	else
708	AssertMsgFailed(("Path string insert failed, rc=%Rrc\n", rc));
709	}
710	else
711	AssertMsgFailed(("Config node failed, rc=%Rrc\n", rc));
712	}
713	else
714	AssertMsgFailed(("Driver string insert failed, rc=%Rrc\n", rc));
715	CFGMR3RemoveNode(pNode);
716	}
717	else
718	AssertMsgFailed(("AttachedDriver node insert failed, rc=%Rrc\n", rc));
719
720	LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: returns %Rrc\n",
721	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
722	return rc;
723	}
724
725
726	/** @copydoc PDMDRVHLP::pfnAssertEMT */
727	static DECLCALLBACK(bool) pdmR3DrvHlp_AssertEMT(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction)
728	{
729	PDMDRV_ASSERT_DRVINS(pDrvIns);
730	if (VM_IS_EMT(pDrvIns->Internal.s.pVM))
731	return true;
732
733	char szMsg[100];
734	RTStrPrintf(szMsg, sizeof(szMsg), "AssertEMT '%s'/%d\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance);
735	AssertMsg1(szMsg, iLine, pszFile, pszFunction);
736	AssertBreakpoint();
737	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
738	return false;
739	}
740
741
742	/** @copydoc PDMDRVHLP::pfnAssertOther */
743	static DECLCALLBACK(bool) pdmR3DrvHlp_AssertOther(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction)
744	{
745	PDMDRV_ASSERT_DRVINS(pDrvIns);
746	if (!VM_IS_EMT(pDrvIns->Internal.s.pVM))
747	return true;
748
749	char szMsg[100];
750	RTStrPrintf(szMsg, sizeof(szMsg), "AssertOther '%s'/%d\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance);
751	AssertMsg1(szMsg, iLine, pszFile, pszFunction);
752	AssertBreakpoint();
753	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
754	return false;
755	}
756
757
758	/** @copydoc PDMDRVHLP::pfnVMSetError */
759	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetError(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
760	{
761	PDMDRV_ASSERT_DRVINS(pDrvIns);
762	va_list args;
763	va_start(args, pszFormat);
764	int rc2 = VMSetErrorV(pDrvIns->Internal.s.pVM, rc, RT_SRC_POS_ARGS, pszFormat, args); Assert(rc2 == rc); NOREF(rc2);
765	va_end(args);
766	return rc;
767	}
768
769
770	/** @copydoc PDMDRVHLP::pfnVMSetErrorV */
771	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetErrorV(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va)
772	{
773	PDMDRV_ASSERT_DRVINS(pDrvIns);
774	int rc2 = VMSetErrorV(pDrvIns->Internal.s.pVM, rc, RT_SRC_POS_ARGS, pszFormat, va); Assert(rc2 == rc); NOREF(rc2);
775	return rc;
776	}
777
778
779	/** @copydoc PDMDRVHLP::pfnVMSetRuntimeError */
780	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetRuntimeError(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, ...)
781	{
782	PDMDRV_ASSERT_DRVINS(pDrvIns);
783	va_list args;
784	va_start(args, pszFormat);
785	int rc = VMSetRuntimeErrorV(pDrvIns->Internal.s.pVM, fFlags, pszErrorId, pszFormat, args);
786	va_end(args);
787	return rc;
788	}
789
790
791	/** @copydoc PDMDRVHLP::pfnVMSetRuntimeErrorV */
792	static DECLCALLBACK(int) pdmR3DrvHlp_VMSetRuntimeErrorV(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list va)
793	{
794	PDMDRV_ASSERT_DRVINS(pDrvIns);
795	int rc = VMSetRuntimeErrorV(pDrvIns->Internal.s.pVM, fFlags, pszErrorId, pszFormat, va);
796	return rc;
797	}
798
799
800	/** @copydoc PDMDRVHLP::pfnPDMQueueCreate */
801	static DECLCALLBACK(int) pdmR3DrvHlp_PDMQueueCreate(PPDMDRVINS pDrvIns, RTUINT cbItem, RTUINT cItems, uint32_t cMilliesInterval,
802	PFNPDMQUEUEDRV pfnCallback, const char pszName, PPDMQUEUE ppQueue)
803	{
804	PDMDRV_ASSERT_DRVINS(pDrvIns);
805	LogFlow(("pdmR3DrvHlp_PDMQueueCreate: caller='%s'/%d: cbItem=%d cItems=%d cMilliesInterval=%d pfnCallback=%p pszName=%p:{%s} ppQueue=%p\n",
806	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, pszName, ppQueue, ppQueue));
807	PVM pVM = pDrvIns->Internal.s.pVM;
808	VM_ASSERT_EMT(pVM);
809
810	if (pDrvIns->iInstance > 0)
811	{
812	pszName = MMR3HeapAPrintf(pVM, MM_TAG_PDM_DRIVER_DESC, "%s_%u", pszName, pDrvIns->iInstance);
813	AssertLogRelReturn(pszName, VERR_NO_MEMORY);
814	}
815
816	int rc = PDMR3QueueCreateDriver(pVM, pDrvIns, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, ppQueue);
817
818	LogFlow(("pdmR3DrvHlp_PDMQueueCreate: caller='%s'/%d: returns %Rrc ppQueue=%p\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc, ppQueue));
819	return rc;
820	}
821
822
823	/** @copydoc PDMDRVHLP::pfnTMGetVirtualFreq */
824	static DECLCALLBACK(uint64_t) pdmR3DrvHlp_TMGetVirtualFreq(PPDMDRVINS pDrvIns)
825	{
826	PDMDRV_ASSERT_DRVINS(pDrvIns);
827
828	return TMVirtualGetFreq(pDrvIns->Internal.s.pVM);
829	}
830
831
832	/** @copydoc PDMDRVHLP::pfnTMGetVirtualTime */
833	static DECLCALLBACK(uint64_t) pdmR3DrvHlp_TMGetVirtualTime(PPDMDRVINS pDrvIns)
834	{
835	PDMDRV_ASSERT_DRVINS(pDrvIns);
836
837	return TMVirtualGet(pDrvIns->Internal.s.pVM);
838	}
839
840
841	/** @copydoc PDMDRVHLP::pfnTMTimerCreate */
842	static DECLCALLBACK(int) pdmR3DrvHlp_TMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void pvUser, uint32_t fFlags, const char pszDesc, PPTMTIMERR3 ppTimer)
843	{
844	PDMDRV_ASSERT_DRVINS(pDrvIns);
845	LogFlow(("pdmR3DrvHlp_TMTimerCreate: caller='%s'/%d: enmClock=%d pfnCallback=%p pvUser=%p fFlags=%#x pszDesc=%p:{%s} ppTimer=%p\n",
846	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, enmClock, pfnCallback, pvUser, fFlags, pszDesc, pszDesc, ppTimer));
847
848	int rc = TMR3TimerCreateDriver(pDrvIns->Internal.s.pVM, pDrvIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer);
849
850	LogFlow(("pdmR3DrvHlp_TMTimerCreate: caller='%s'/%d: returns %Rrc ppTimer=%p\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc, ppTimer));
851	return rc;
852	}
853
854
855
856	/** @copydoc PDMDRVHLP::pfnSSMRegister */
857	static DECLCALLBACK(int) pdmR3DrvHlp_SSMRegister(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
858	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
859	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
860	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
861	{
862	PDMDRV_ASSERT_DRVINS(pDrvIns);
863	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
864	LogFlow(("pdmR3DrvHlp_SSMRegister: caller='%s'/%d: uVersion=#x cbGuess=%#x \n"
865	" pfnLivePrep=%p pfnLiveExec=%p pfnLiveVote=%p pfnSavePrep=%p pfnSaveExec=%p pfnSaveDone=%p pszLoadPrep=%p pfnLoadExec=%p pfnLoaddone=%p\n",
866	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, uVersion, cbGuess,
867	pfnLivePrep, pfnLiveExec, pfnLiveVote,
868	pfnSavePrep, pfnSaveExec, pfnSaveDone, pfnLoadPrep, pfnLoadExec, pfnLoadDone));
869
870	int rc = SSMR3RegisterDriver(pDrvIns->Internal.s.pVM, pDrvIns, pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance,
871	uVersion, cbGuess,
872	pfnLivePrep, pfnLiveExec, pfnLiveVote,
873	pfnSavePrep, pfnSaveExec, pfnSaveDone,
874	pfnLoadPrep, pfnLoadExec, pfnLoadDone);
875
876	LogFlow(("pdmR3DrvHlp_SSMRegister: caller='%s'/%d: returns %Rrc\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
877	return rc;
878	}
879
880
881	/** @copydoc PDMDRVHLP::pfnSSMDeregister */
882	static DECLCALLBACK(int) pdmR3DrvHlp_SSMDeregister(PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance)
883	{
884	PDMDRV_ASSERT_DRVINS(pDrvIns);
885	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
886	LogFlow(("pdmR3DrvHlp_SSMDeregister: caller='%s'/%d: pszName=%p:{%s} u32Instance=%#x\n",
887	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pszName, pszName, u32Instance));
888
889	int rc = SSMR3DeregisterDriver(pDrvIns->Internal.s.pVM, pDrvIns, pszName, u32Instance);
890
891	LogFlow(("pdmR3DrvHlp_SSMDeregister: caller='%s'/%d: returns %Rrc\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
892	return rc;
893	}
894
895
896	/** @copydoc PDMDRVHLP::pfnSTAMRegister */
897	static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegister(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName, STAMUNIT enmUnit, const char *pszDesc)
898	{
899	PDMDRV_ASSERT_DRVINS(pDrvIns);
900	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
901
902	STAM_REG(pDrvIns->Internal.s.pVM, pvSample, enmType, pszName, enmUnit, pszDesc);
903	/** @todo track the samples so they can be dumped & deregistered when the driver instance is destroyed.
904	* For now we just have to be careful not to use this call for drivers which can be unloaded. */
905	}
906
907
908	/** @copydoc PDMDRVHLP::pfnSTAMRegisterF */
909	static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
910	STAMUNIT enmUnit, const char pszDesc, const char pszName, ...)
911	{
912	PDMDRV_ASSERT_DRVINS(pDrvIns);
913	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
914
915	va_list args;
916	va_start(args, pszName);
917	int rc = STAMR3RegisterV(pDrvIns->Internal.s.pVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
918	va_end(args);
919	AssertRC(rc);
920	}
921
922
923	/** @copydoc PDMDRVHLP::pfnSTAMRegisterV */
924	static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegisterV(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
925	STAMUNIT enmUnit, const char pszDesc, const char pszName, va_list args)
926	{
927	PDMDRV_ASSERT_DRVINS(pDrvIns);
928	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
929
930	int rc = STAMR3RegisterV(pDrvIns->Internal.s.pVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
931	AssertRC(rc);
932	}
933
934
935	/** @copydoc PDMDRVHLP::pfnSTAMDeregister */
936	static DECLCALLBACK(int) pdmR3DrvHlp_STAMDeregister(PPDMDRVINS pDrvIns, void *pvSample)
937	{
938	PDMDRV_ASSERT_DRVINS(pDrvIns);
939	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
940
941	int rc = STAMR3DeregisterU(pDrvIns->Internal.s.pVM->pUVM, pvSample);
942	AssertRC(rc);
943	return rc;
944	}
945
946
947	/** @copydoc PDMDRVHLP::pfnSUPCallVMMR0Ex */
948	static DECLCALLBACK(int) pdmR3DrvHlp_SUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
949	{
950	PDMDRV_ASSERT_DRVINS(pDrvIns);
951	LogFlow(("pdmR3DrvHlp_SSMCallVMMR0Ex: caller='%s'/%d: uOperation=%u pvArg=%p cbArg=%d\n",
952	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, uOperation, pvArg, cbArg));
953	int rc;
954	if ( uOperation >= VMMR0_DO_SRV_START
955	&& uOperation < VMMR0_DO_SRV_END)
956	rc = SUPR3CallVMMR0Ex(pDrvIns->Internal.s.pVM->pVMR0, NIL_VMCPUID, uOperation, 0, (PSUPVMMR0REQHDR)pvArg);
957	else
958	{
959	AssertMsgFailed(("Invalid uOperation=%u\n", uOperation));
960	rc = VERR_INVALID_PARAMETER;
961	}
962
963	LogFlow(("pdmR3DrvHlp_SUPCallVMMR0Ex: caller='%s'/%d: returns %Rrc\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
964	return rc;
965	}
966
967
968	/** @copydoc PDMDRVHLP::pfnUSBRegisterHub */
969	static DECLCALLBACK(int) pdmR3DrvHlp_USBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
970	{
971	PDMDRV_ASSERT_DRVINS(pDrvIns);
972	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
973	LogFlow(("pdmR3DrvHlp_USBRegisterHub: caller='%s'/%d: fVersions=%#x cPorts=%#x pUsbHubReg=%p ppUsbHubHlp=%p\n",
974	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp));
975
976	#ifdef VBOX_WITH_USB
977	int rc = pdmR3UsbRegisterHub(pDrvIns->Internal.s.pVM, pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
978	#else
979	int rc = VERR_NOT_SUPPORTED;
980	#endif
981
982	LogFlow(("pdmR3DrvHlp_USBRegisterHub: caller='%s'/%d: returns %Rrc\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
983	return rc;
984	}
985
986
987	/** @copydoc PDMDRVHLP::pfnPDMThreadCreate */
988	static DECLCALLBACK(int) pdmR3DrvHlp_PDMThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
989	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
990	{
991	PDMDRV_ASSERT_DRVINS(pDrvIns);
992	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
993	LogFlow(("pdmR3DrvHlp_PDMThreadCreate: caller='%s'/%d: ppThread=%p pvUser=%p pfnThread=%p pfnWakeup=%p cbStack=%#zx enmType=%d pszName=%p:{%s}\n",
994	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName, pszName));
995
996	int rc = pdmR3ThreadCreateDriver(pDrvIns->Internal.s.pVM, pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
997
998	LogFlow(("pdmR3DrvHlp_PDMThreadCreate: caller='%s'/%d: returns %Rrc *ppThread=%RTthrd\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance,
999	rc, *ppThread));
1000	return rc;
1001	}
1002
1003
1004	/** @copydoc PDMDEVHLPR3::pfnVMState */
1005	static DECLCALLBACK(VMSTATE) pdmR3DrvHlp_VMState(PPDMDRVINS pDrvIns)
1006	{
1007	PDMDRV_ASSERT_DRVINS(pDrvIns);
1008
1009	VMSTATE enmVMState = VMR3GetState(pDrvIns->Internal.s.pVM);
1010
1011	LogFlow(("pdmR3DrvHlp_VMState: caller='%s'/%d: returns %d (%s)\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance,
1012	enmVMState, VMR3GetStateName(enmVMState)));
1013	return enmVMState;
1014	}
1015
1016
1017	#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1018	/** @copydoc PDMDRVHLP::pfnPDMAsyncCompletionTemplateCreate */
1019	static DECLCALLBACK(int) pdmR3DrvHlp_PDMAsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1020	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser,
1021	const char *pszDesc)
1022	{
1023	PDMDRV_ASSERT_DRVINS(pDrvIns);
1024	VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
1025	LogFlow(("pdmR3DrvHlp_PDMAsyncCompletionTemplateCreate: caller='%s'/%d: ppTemplate=%p pfnCompleted=%p pszDesc=%p:{%s}\n",
1026	pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, ppTemplate, pfnCompleted, pszDesc, pszDesc));
1027
1028	int rc = PDMR3AsyncCompletionTemplateCreateDriver(pDrvIns->Internal.s.pVM, pDrvIns, ppTemplate, pfnCompleted, pvTemplateUser, pszDesc);
1029
1030	LogFlow(("pdmR3DrvHlp_PDMAsyncCompletionTemplateCreate: caller='%s'/%d: returns %Rrc *ppThread=%p\n", pDrvIns->pDrvReg->szDriverName,
1031	pDrvIns->iInstance, rc, *ppTemplate));
1032	return rc;
1033	}
1034	#endif
1035
1036
1037	/**
1038	* The driver helper structure.
1039	*/
1040	const PDMDRVHLP g_pdmR3DrvHlp =
1041	{
1042	PDM_DRVHLP_VERSION,
1043	pdmR3DrvHlp_Attach,
1044	pdmR3DrvHlp_Detach,
1045	pdmR3DrvHlp_DetachSelf,
1046	pdmR3DrvHlp_MountPrepare,
1047	pdmR3DrvHlp_AssertEMT,
1048	pdmR3DrvHlp_AssertOther,
1049	pdmR3DrvHlp_VMSetError,
1050	pdmR3DrvHlp_VMSetErrorV,
1051	pdmR3DrvHlp_VMSetRuntimeError,
1052	pdmR3DrvHlp_VMSetRuntimeErrorV,
1053	pdmR3DrvHlp_PDMQueueCreate,
1054	pdmR3DrvHlp_TMGetVirtualFreq,
1055	pdmR3DrvHlp_TMGetVirtualTime,
1056	pdmR3DrvHlp_TMTimerCreate,
1057	pdmR3DrvHlp_SSMRegister,
1058	pdmR3DrvHlp_SSMDeregister,
1059	pdmR3DrvHlp_STAMRegister,
1060	pdmR3DrvHlp_STAMRegisterF,
1061	pdmR3DrvHlp_STAMRegisterV,
1062	pdmR3DrvHlp_STAMDeregister,
1063	pdmR3DrvHlp_SUPCallVMMR0Ex,
1064	pdmR3DrvHlp_USBRegisterHub,
1065	pdmR3DrvHlp_PDMThreadCreate,
1066	pdmR3DrvHlp_VMState,
1067	#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1068	pdmR3DrvHlp_PDMAsyncCompletionTemplateCreate,
1069	#endif
1070	PDM_DRVHLP_VERSION /* u32TheEnd */
1071	};
1072
1073	/** @} */

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

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

Download in other formats: