PDMDevice.cpp@ 81150

Last change on this file since 81150 was 81150, checked in by vboxsync, 5 years ago
VMM,/Makefile.kmk: Kicked out more recompiler related code. bugref:9576
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 45.1 KB

Line
1	/* $Id: PDMDevice.cpp 81150 2019-10-08 12:53:47Z vboxsync $ */
2	/** @file
3	* PDM - Pluggable Device and Driver Manager, Device parts.
4	*/
5
6	/*
7	* Copyright (C) 2006-2019 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#define LOG_GROUP LOG_GROUP_PDM_DEVICE
23	#define PDMPCIDEV_INCLUDE_PRIVATE /* Hack to get pdmpcidevint.h included at the right point. */
24	#include "PDMInternal.h"
25	#include <VBox/vmm/pdm.h>
26	#include <VBox/vmm/apic.h>
27	#include <VBox/vmm/cfgm.h>
28	#include <VBox/vmm/dbgf.h>
29	#include <VBox/vmm/hm.h>
30	#include <VBox/vmm/mm.h>
31	#include <VBox/vmm/iom.h>
32	#include <VBox/vmm/pgm.h>
33	#include <VBox/vmm/vm.h>
34	#include <VBox/vmm/uvm.h>
35	#include <VBox/vmm/vmm.h>
36
37	#include <VBox/version.h>
38	#include <VBox/log.h>
39	#include <VBox/msi.h>
40	#include <VBox/err.h>
41	#include <iprt/alloc.h>
42	#include <iprt/alloca.h>
43	#include <iprt/asm.h>
44	#include <iprt/assert.h>
45	#include <iprt/path.h>
46	#include <iprt/semaphore.h>
47	#include <iprt/string.h>
48	#include <iprt/thread.h>
49
50
51	/*********************************************************************************************************************************
52	* Structures and Typedefs *
53	*********************************************************************************************************************************/
54	/**
55	* Internal callback structure pointer.
56	* The main purpose is to define the extra data we associate
57	* with PDMDEVREGCB so we can find the VM instance and so on.
58	*/
59	typedef struct PDMDEVREGCBINT
60	{
61	/** The callback structure. */
62	PDMDEVREGCB Core;
63	/** A bit of padding. */
64	uint32_t u32[4];
65	/** VM Handle. */
66	PVM pVM;
67	/** Pointer to the configuration node the registrations should be
68	* associated with. Can be NULL. */
69	PCFGMNODE pCfgNode;
70	} PDMDEVREGCBINT;
71	/** Pointer to a PDMDEVREGCBINT structure. */
72	typedef PDMDEVREGCBINT *PPDMDEVREGCBINT;
73	/** Pointer to a const PDMDEVREGCBINT structure. */
74	typedef const PDMDEVREGCBINT *PCPDMDEVREGCBINT;
75
76
77	/*********************************************************************************************************************************
78	* Internal Functions *
79	*********************************************************************************************************************************/
80	static DECLCALLBACK(int) pdmR3DevReg_Register(PPDMDEVREGCB pCallbacks, PCPDMDEVREG pReg);
81	static int pdmR3DevLoadModules(PVM pVM);
82	static int pdmR3DevLoad(PVM pVM, PPDMDEVREGCBINT pRegCB, const char pszFilename, const char pszName);
83
84
85
86
87	/**
88	* This function will initialize the devices for this VM instance.
89	*
90	*
91	* First of all this mean loading the builtin device and letting them
92	* register themselves. Beyond that any additional device modules are
93	* loaded and called for registration.
94	*
95	* Then the device configuration is enumerated, the instantiation order
96	* is determined, and finally they are instantiated.
97	*
98	* After all devices have been successfully instantiated the primary
99	* PCI Bus device is called to emulate the PCI BIOS, i.e. making the
100	* resource assignments. If there is no PCI device, this step is of course
101	* skipped.
102	*
103	* Finally the init completion routines of the instantiated devices
104	* are called.
105	*
106	* @returns VBox status code.
107	* @param pVM The cross context VM structure.
108	*/
109	int pdmR3DevInit(PVM pVM)
110	{
111	LogFlow(("pdmR3DevInit:\n"));
112
113	AssertRelease(!(RT_UOFFSETOF(PDMDEVINS, achInstanceData) & 15));
114	AssertRelease(sizeof(pVM->pdm.s.pDevInstances->Internal.s) <= sizeof(pVM->pdm.s.pDevInstances->Internal.padding));
115
116	/*
117	* Load device modules.
118	*/
119	int rc = pdmR3DevLoadModules(pVM);
120	if (RT_FAILURE(rc))
121	return rc;
122
123	#ifdef VBOX_WITH_USB
124	/* ditto for USB Devices. */
125	rc = pdmR3UsbLoadModules(pVM);
126	if (RT_FAILURE(rc))
127	return rc;
128	#endif
129
130	/*
131	* Get the RC & R0 devhlps and create the devhlp R3 task queue.
132	*/
133	rc = PDMR3QueueCreateInternal(pVM, sizeof(PDMDEVHLPTASK), 8, 0, pdmR3DevHlpQueueConsumer, true, "DevHlp",
134	&pVM->pdm.s.pDevHlpQueueR3);
135	AssertRCReturn(rc, rc);
136	pVM->pdm.s.pDevHlpQueueR0 = PDMQueueR0Ptr(pVM->pdm.s.pDevHlpQueueR3);
137	pVM->pdm.s.pDevHlpQueueRC = PDMQueueRCPtr(pVM->pdm.s.pDevHlpQueueR3);
138
139
140	/*
141	*
142	* Enumerate the device instance configurations
143	* and come up with a instantiation order.
144	*
145	*/
146	/* Switch to /Devices, which contains the device instantiations. */
147	PCFGMNODE pDevicesNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "Devices");
148
149	/*
150	* Count the device instances.
151	*/
152	PCFGMNODE pCur;
153	PCFGMNODE pInstanceNode;
154	unsigned cDevs = 0;
155	for (pCur = CFGMR3GetFirstChild(pDevicesNode); pCur; pCur = CFGMR3GetNextChild(pCur))
156	for (pInstanceNode = CFGMR3GetFirstChild(pCur); pInstanceNode; pInstanceNode = CFGMR3GetNextChild(pInstanceNode))
157	cDevs++;
158	if (!cDevs)
159	{
160	Log(("PDM: No devices were configured!\n"));
161	return VINF_SUCCESS;
162	}
163	Log2(("PDM: cDevs=%u\n", cDevs));
164
165	/*
166	* Collect info on each device instance.
167	*/
168	struct DEVORDER
169	{
170	/** Configuration node. */
171	PCFGMNODE pNode;
172	/** Pointer to device. */
173	PPDMDEV pDev;
174	/** Init order. */
175	uint32_t u32Order;
176	/** VBox instance number. */
177	uint32_t iInstance;
178	} paDevs = (struct DEVORDER )alloca(sizeof(paDevs[0]) * (cDevs + 1)); /* (One extra for swapping) */
179	Assert(paDevs);
180	unsigned i = 0;
181	for (pCur = CFGMR3GetFirstChild(pDevicesNode); pCur; pCur = CFGMR3GetNextChild(pCur))
182	{
183	/* Get the device name. */
184	char szName[sizeof(paDevs[0].pDev->pReg->szName)];
185	rc = CFGMR3GetName(pCur, szName, sizeof(szName));
186	AssertMsgRCReturn(rc, ("Configuration error: device name is too long (or something)! rc=%Rrc\n", rc), rc);
187
188	/* Find the device. */
189	PPDMDEV pDev = pdmR3DevLookup(pVM, szName);
190	AssertLogRelMsgReturn(pDev, ("Configuration error: device '%s' not found!\n", szName), VERR_PDM_DEVICE_NOT_FOUND);
191
192	/* Configured priority or use default based on device class? */
193	uint32_t u32Order;
194	rc = CFGMR3QueryU32(pCur, "Priority", &u32Order);
195	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
196	{
197	uint32_t u32 = pDev->pReg->fClass;
198	for (u32Order = 1; !(u32 & u32Order); u32Order <<= 1)
199	/* nop */;
200	}
201	else
202	AssertMsgRCReturn(rc, ("Configuration error: reading \"Priority\" for the '%s' device failed rc=%Rrc!\n", szName, rc), rc);
203
204	/* Enumerate the device instances. */
205	uint32_t const iStart = i;
206	for (pInstanceNode = CFGMR3GetFirstChild(pCur); pInstanceNode; pInstanceNode = CFGMR3GetNextChild(pInstanceNode))
207	{
208	paDevs[i].pNode = pInstanceNode;
209	paDevs[i].pDev = pDev;
210	paDevs[i].u32Order = u32Order;
211
212	/* Get the instance number. */
213	char szInstance[32];
214	rc = CFGMR3GetName(pInstanceNode, szInstance, sizeof(szInstance));
215	AssertMsgRCReturn(rc, ("Configuration error: instance name is too long (or something)! rc=%Rrc\n", rc), rc);
216	char *pszNext = NULL;
217	rc = RTStrToUInt32Ex(szInstance, &pszNext, 0, &paDevs[i].iInstance);
218	AssertMsgRCReturn(rc, ("Configuration error: RTStrToInt32Ex failed on the instance name '%s'! rc=%Rrc\n", szInstance, rc), rc);
219	AssertMsgReturn(!*pszNext, ("Configuration error: the instance name '%s' isn't all digits. (%s)\n", szInstance, pszNext), VERR_INVALID_PARAMETER);
220
221	/* next instance */
222	i++;
223	}
224
225	/* check the number of instances */
226	if (i - iStart > pDev->pReg->cMaxInstances)
227	AssertLogRelMsgFailedReturn(("Configuration error: Too many instances of %s was configured: %u, max %u\n",
228	szName, i - iStart, pDev->pReg->cMaxInstances),
229	VERR_PDM_TOO_MANY_DEVICE_INSTANCES);
230	} /* devices */
231	Assert(i == cDevs);
232
233	/*
234	* Sort (bubble) the device array ascending on u32Order and instance number
235	* for a device.
236	*/
237	unsigned c = cDevs - 1;
238	while (c)
239	{
240	unsigned j = 0;
241	for (i = 0; i < c; i++)
242	if ( paDevs[i].u32Order > paDevs[i + 1].u32Order
243	\|\| ( paDevs[i].u32Order == paDevs[i + 1].u32Order
244	&& paDevs[i].iInstance > paDevs[i + 1].iInstance
245	&& paDevs[i].pDev == paDevs[i + 1].pDev) )
246	{
247	paDevs[cDevs] = paDevs[i + 1];
248	paDevs[i + 1] = paDevs[i];
249	paDevs[i] = paDevs[cDevs];
250	j = i;
251	}
252	c = j;
253	}
254
255
256	/*
257	*
258	* Instantiate the devices.
259	*
260	*/
261	for (i = 0; i < cDevs; i++)
262	{
263	PDMDEVREGR3 const * const pReg = paDevs[i].pDev->pReg;
264
265	/*
266	* Gather a bit of config.
267	*/
268	/* trusted */
269	bool fTrusted;
270	rc = CFGMR3QueryBool(paDevs[i].pNode, "Trusted", &fTrusted);
271	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
272	fTrusted = false;
273	else if (RT_FAILURE(rc))
274	{
275	AssertMsgFailed(("configuration error: failed to query boolean \"Trusted\", rc=%Rrc\n", rc));
276	return rc;
277	}
278
279	/* RZEnabled, R0Enabled, RCEnabled*/
280	bool fR0Enabled = false;
281	bool fRCEnabled = false;
282	if (pReg->fFlags & (PDM_DEVREG_FLAGS_R0 \| PDM_DEVREG_FLAGS_RC))
283	{
284	if (pReg->fFlags & PDM_DEVREG_FLAGS_R0)
285	{
286	if (pReg->fFlags & PDM_DEVREG_FLAGS_REQUIRE_R0)
287	fR0Enabled = true;
288	else
289	{
290	rc = CFGMR3QueryBoolDef(paDevs[i].pNode, "R0Enabled", &fR0Enabled,
291	!(pReg->fFlags & PDM_DEVREG_FLAGS_OPT_IN_R0));
292	AssertLogRelRCReturn(rc, rc);
293	}
294	}
295
296	if (pReg->fFlags & PDM_DEVREG_FLAGS_RC)
297	{
298	if (pReg->fFlags & PDM_DEVREG_FLAGS_REQUIRE_RC)
299	fRCEnabled = true;
300	else
301	{
302	rc = CFGMR3QueryBoolDef(paDevs[i].pNode, "RCEnabled", &fRCEnabled,
303	!(pReg->fFlags & PDM_DEVREG_FLAGS_OPT_IN_RC));
304	AssertLogRelRCReturn(rc, rc);
305	}
306	fRCEnabled = false;
307	}
308	}
309
310	/* config node */
311	PCFGMNODE pConfigNode = CFGMR3GetChild(paDevs[i].pNode, "Config");
312	if (!pConfigNode)
313	{
314	rc = CFGMR3InsertNode(paDevs[i].pNode, "Config", &pConfigNode);
315	if (RT_FAILURE(rc))
316	{
317	AssertMsgFailed(("Failed to create Config node! rc=%Rrc\n", rc));
318	return rc;
319	}
320	}
321	CFGMR3SetRestrictedRoot(pConfigNode);
322
323	/*
324	* Allocate the device instance and critical section.
325	*/
326	AssertLogRelReturn(paDevs[i].pDev->cInstances < pReg->cMaxInstances,
327	VERR_PDM_TOO_MANY_DEVICE_INSTANCES);
328	PPDMDEVINS pDevIns;
329	PPDMCRITSECT pCritSect;
330	if (fR0Enabled \|\| fRCEnabled)
331	{
332	AssertLogRel(fR0Enabled /* not possible to just enabled raw-mode atm. */);
333
334	rc = PDMR3LdrLoadR0(pVM->pUVM, pReg->pszR0Mod, paDevs[i].pDev->pszR0SearchPath);
335	if (RT_FAILURE(rc))
336	return VMR3SetError(pVM->pUVM, rc, RT_SRC_POS, "Failed to load ring-0 module '%s' for device '%s'",
337	pReg->pszR0Mod, pReg->szName);
338
339	PDMDEVICECREATEREQ Req;
340	Req.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
341	Req.Hdr.cbReq = sizeof(Req);
342	Req.pDevInsR3 = NULL;
343	Req.fFlags = pReg->fFlags;
344	Req.fClass = pReg->fClass;
345	Req.cMaxInstances = pReg->cMaxInstances;
346	Req.uSharedVersion = pReg->uSharedVersion;
347	Req.cbInstanceShared = pReg->cbInstanceShared;
348	Req.cbInstanceR3 = pReg->cbInstanceCC;
349	Req.cbInstanceRC = pReg->cbInstanceRC;
350	Req.cMaxPciDevices = pReg->cMaxPciDevices;
351	Req.cMaxMsixVectors = pReg->cMaxMsixVectors;
352	Req.iInstance = paDevs[i].iInstance;
353	Req.fRCEnabled = fRCEnabled;
354	Req.afReserved[0] = false;
355	Req.afReserved[1] = false;
356	Req.afReserved[2] = false;
357	rc = RTStrCopy(Req.szDevName, sizeof(Req.szDevName), pReg->szName);
358	AssertLogRelRCReturn(rc, rc);
359	rc = RTStrCopy(Req.szModName, sizeof(Req.szModName), pReg->pszR0Mod);
360	AssertLogRelRCReturn(rc, rc);
361	rc = VMMR3CallR0Emt(pVM, pVM->apCpusR3[0], VMMR0_DO_PDM_DEVICE_CREATE, 0, &Req.Hdr);
362	AssertLogRelMsgRCReturn(rc, ("VMMR0_DO_PDM_DEVICE_CREATE for %s failed: %Rrc\n", pReg->szName, rc), rc);
363	pDevIns = Req.pDevInsR3;
364	pCritSect = pDevIns->pCritSectRoR3;
365	Assert(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_R0_ENABLED);
366	}
367	else
368	{
369	/* The code in this else branch works by the same rules as the PDMR0Device.cpp
370	code, except there is only the ring-3 components of the device instance.
371	Changes here may need to be reflected in PDMR0DEvice.cpp and vice versa! */
372	uint32_t cb = RT_UOFFSETOF_DYN(PDMDEVINS, achInstanceData[pReg->cbInstanceCC]);
373	cb = RT_ALIGN_32(cb, 64);
374	uint32_t const offShared = cb;
375	cb += RT_ALIGN_32(pReg->cbInstanceShared, 64);
376	uint32_t const cbCritSect = RT_ALIGN_32(sizeof(*pCritSect), 64);
377	cb += cbCritSect;
378	uint32_t const cbMsixState = RT_ALIGN_32(pReg->cMaxMsixVectors * 16 + (pReg->cMaxMsixVectors + 7) / 8, _4K);
379	uint32_t const cbPciDev = RT_ALIGN_32(RT_UOFFSETOF_DYN(PDMPCIDEV, abMsixState[cbMsixState]), 64);
380	uint32_t const cPciDevs = RT_MIN(pReg->cMaxPciDevices, 1024);
381	uint32_t const cbPciDevs = cbPciDev * cPciDevs;
382	cb += cbPciDevs;
383
384	rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_DEVICE, cb, (void **)&pDevIns);
385	AssertLogRelMsgRCReturn(rc, ("Failed to allocate %zu bytes of instance data for device '%s'. rc=%Rrc\n",
386	cb, pReg->szName, rc), rc);
387
388	/* Initialize it: */
389	pDevIns->u32Version = PDM_DEVINSR3_VERSION;
390	pDevIns->iInstance = paDevs[i].iInstance;
391	pDevIns->cbRing3 = cb;
392	//pDevIns->fR0Enabled = false;
393	//pDevIns->fRCEnabled = false;
394	pDevIns->pvInstanceDataR3 = (uint8_t *)pDevIns + offShared;
395	pDevIns->pvInstanceDataForR3 = &pDevIns->achInstanceData[0];
396	pCritSect = (PPDMCRITSECT)((uint8_t *)pDevIns + offShared + RT_ALIGN_32(pReg->cbInstanceShared, 64));
397	pDevIns->pCritSectRoR3 = pCritSect;
398	pDevIns->cbPciDev = cbPciDev;
399	pDevIns->cPciDevs = cPciDevs;
400	for (uint32_t iPciDev = 0; iPciDev < cPciDevs; iPciDev++)
401	{
402	PPDMPCIDEV pPciDev = (PPDMPCIDEV)((uint8_t )pDevIns->pCritSectRoR3 + cbCritSect + cbPciDev iPciDev);
403	if (iPciDev < RT_ELEMENTS(pDevIns->apPciDevs))
404	pDevIns->apPciDevs[iPciDev] = pPciDev;
405	pPciDev->cbConfig = _4K;
406	pPciDev->cbMsixState = cbMsixState;
407	pPciDev->idxSubDev = (uint16_t)iPciDev;
408	pPciDev->Int.s.idxSubDev = (uint16_t)iPciDev;
409	pPciDev->u32Magic = PDMPCIDEV_MAGIC;
410	}
411	}
412
413	pDevIns->pHlpR3 = fTrusted ? &g_pdmR3DevHlpTrusted : &g_pdmR3DevHlpUnTrusted;
414	pDevIns->pReg = pReg;
415	pDevIns->pCfg = pConfigNode;
416	//pDevIns->IBase.pfnQueryInterface = NULL;
417	//pDevIns->fTracing = 0;
418	pDevIns->idTracing = ++pVM->pdm.s.idTracingDev;
419
420	//pDevIns->Internal.s.pNextR3 = NULL;
421	//pDevIns->Internal.s.pPerDeviceNextR3 = NULL;
422	pDevIns->Internal.s.pDevR3 = paDevs[i].pDev;
423	//pDevIns->Internal.s.pLunsR3 = NULL;
424	//pDevIns->Internal.s.pfnAsyncNotify = NULL;
425	pDevIns->Internal.s.pCfgHandle = paDevs[i].pNode;
426	pDevIns->Internal.s.pVMR3 = pVM;
427	//pDevIns->Internal.s.pHeadPciDevR3 = NULL;
428	pDevIns->Internal.s.fIntFlags \|= PDMDEVINSINT_FLAGS_SUSPENDED;
429	//pDevIns->Internal.s.uLastIrqTag = 0;
430
431	rc = pdmR3CritSectInitDeviceAuto(pVM, pDevIns, pCritSect, RT_SRC_POS,
432	"%s#%uAuto", pDevIns->pReg->szName, pDevIns->iInstance);
433	AssertLogRelRCReturn(rc, rc);
434
435	/*
436	* Link it into all the lists.
437	*/
438	/* The global instance FIFO. */
439	PPDMDEVINS pPrev1 = pVM->pdm.s.pDevInstances;
440	if (!pPrev1)
441	pVM->pdm.s.pDevInstances = pDevIns;
442	else
443	{
444	while (pPrev1->Internal.s.pNextR3)
445	pPrev1 = pPrev1->Internal.s.pNextR3;
446	pPrev1->Internal.s.pNextR3 = pDevIns;
447	}
448
449	/* The per device instance FIFO. */
450	PPDMDEVINS pPrev2 = paDevs[i].pDev->pInstances;
451	if (!pPrev2)
452	paDevs[i].pDev->pInstances = pDevIns;
453	else
454	{
455	while (pPrev2->Internal.s.pPerDeviceNextR3)
456	pPrev2 = pPrev2->Internal.s.pPerDeviceNextR3;
457	pPrev2->Internal.s.pPerDeviceNextR3 = pDevIns;
458	}
459
460	/*
461	* Call the constructor.
462	*/
463	paDevs[i].pDev->cInstances++;
464	Log(("PDM: Constructing device '%s' instance %d...\n", pDevIns->pReg->szName, pDevIns->iInstance));
465	rc = pDevIns->pReg->pfnConstruct(pDevIns, pDevIns->iInstance, pDevIns->pCfg);
466	if (RT_FAILURE(rc))
467	{
468	LogRel(("PDM: Failed to construct '%s'/%d! %Rra\n", pDevIns->pReg->szName, pDevIns->iInstance, rc));
469	paDevs[i].pDev->cInstances--;
470	/* Because we're damn lazy, the destructor will be called even if
471	the constructor fails. So, no unlinking. */
472	return rc == VERR_VERSION_MISMATCH ? VERR_PDM_DEVICE_VERSION_MISMATCH : rc;
473	}
474
475	/*
476	* Call the ring-0 constructor if applicable.
477	*/
478	if (fR0Enabled)
479	{
480	PDMDEVICEGENCALLREQ Req;
481	Req.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
482	Req.Hdr.cbReq = sizeof(Req);
483	Req.enmCall = PDMDEVICEGENCALL_CONSTRUCT;
484	Req.idxR0Device = pDevIns->Internal.s.idxR0Device;
485	Req.pDevInsR3 = pDevIns;
486	rc = VMMR3CallR0Emt(pVM, pVM->apCpusR3[0], VMMR0_DO_PDM_DEVICE_GEN_CALL, 0, &Req.Hdr);
487	pDevIns->Internal.s.fIntFlags \|= PDMDEVINSINT_FLAGS_R0_CONTRUCT;
488	if (RT_FAILURE(rc))
489	{
490	LogRel(("PDM: Failed to construct (ring-0) '%s'/%d! %Rra\n", pDevIns->pReg->szName, pDevIns->iInstance, rc));
491	paDevs[i].pDev->cInstances--;
492	return rc == VERR_VERSION_MISMATCH ? VERR_PDM_DEVICE_VERSION_MISMATCH : rc;
493	}
494	}
495
496	} /* for device instances */
497
498	#ifdef VBOX_WITH_USB
499	/* ditto for USB Devices. */
500	rc = pdmR3UsbInstantiateDevices(pVM);
501	if (RT_FAILURE(rc))
502	return rc;
503	#endif
504
505	LogFlow(("pdmR3DevInit: returns %Rrc\n", VINF_SUCCESS));
506	return VINF_SUCCESS;
507	}
508
509
510	/**
511	* Performs the init complete callback after ring-0 and raw-mode has been
512	* initialized.
513	*
514	* @returns VBox status code.
515	* @param pVM The cross context VM structure.
516	*/
517	int pdmR3DevInitComplete(PVM pVM)
518	{
519	int rc;
520
521	/*
522	* Iterate thru the device instances and work the callback.
523	*/
524	for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
525	{
526	if (pDevIns->pReg->pfnInitComplete)
527	{
528	PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
529	rc = pDevIns->pReg->pfnInitComplete(pDevIns);
530	PDMCritSectLeave(pDevIns->pCritSectRoR3);
531	if (RT_FAILURE(rc))
532	{
533	AssertMsgFailed(("InitComplete on device '%s'/%d failed with rc=%Rrc\n",
534	pDevIns->pReg->szName, pDevIns->iInstance, rc));
535	return rc;
536	}
537	}
538	}
539
540	#ifdef VBOX_WITH_USB
541	rc = pdmR3UsbVMInitComplete(pVM);
542	if (RT_FAILURE(rc))
543	{
544	Log(("pdmR3DevInit: returns %Rrc\n", rc));
545	return rc;
546	}
547	#endif
548
549	LogFlow(("pdmR3DevInit: returns %Rrc\n", VINF_SUCCESS));
550	return VINF_SUCCESS;
551	}
552
553
554	/**
555	* Lookups a device structure by name.
556	* @internal
557	*/
558	PPDMDEV pdmR3DevLookup(PVM pVM, const char *pszName)
559	{
560	size_t cchName = strlen(pszName);
561	for (PPDMDEV pDev = pVM->pdm.s.pDevs; pDev; pDev = pDev->pNext)
562	if ( pDev->cchName == cchName
563	&& !strcmp(pDev->pReg->szName, pszName))
564	return pDev;
565	return NULL;
566	}
567
568
569	/**
570	* Loads the device modules.
571	*
572	* @returns VBox status code.
573	* @param pVM The cross context VM structure.
574	*/
575	static int pdmR3DevLoadModules(PVM pVM)
576	{
577	/*
578	* Initialize the callback structure.
579	*/
580	PDMDEVREGCBINT RegCB;
581	RegCB.Core.u32Version = PDM_DEVREG_CB_VERSION;
582	RegCB.Core.pfnRegister = pdmR3DevReg_Register;
583	RegCB.pVM = pVM;
584	RegCB.pCfgNode = NULL;
585
586	/*
587	* Register the internal VMM APIC device.
588	*/
589	int rc = pdmR3DevReg_Register(&RegCB.Core, &g_DeviceAPIC);
590	AssertRCReturn(rc, rc);
591
592	/*
593	* Load the builtin module.
594	*/
595	PCFGMNODE pDevicesNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "PDM/Devices");
596	bool fLoadBuiltin;
597	rc = CFGMR3QueryBool(pDevicesNode, "LoadBuiltin", &fLoadBuiltin);
598	if (rc == VERR_CFGM_VALUE_NOT_FOUND \|\| rc == VERR_CFGM_NO_PARENT)
599	fLoadBuiltin = true;
600	else if (RT_FAILURE(rc))
601	{
602	AssertMsgFailed(("Configuration error: Querying boolean \"LoadBuiltin\" failed with %Rrc\n", rc));
603	return rc;
604	}
605	if (fLoadBuiltin)
606	{
607	/* make filename */
608	char pszFilename = pdmR3FileR3("VBoxDD", true /fShared*/);
609	if (!pszFilename)
610	return VERR_NO_TMP_MEMORY;
611	rc = pdmR3DevLoad(pVM, &RegCB, pszFilename, "VBoxDD");
612	RTMemTmpFree(pszFilename);
613	if (RT_FAILURE(rc))
614	return rc;
615
616	/* make filename */
617	pszFilename = pdmR3FileR3("VBoxDD2", true /fShared/);
618	if (!pszFilename)
619	return VERR_NO_TMP_MEMORY;
620	rc = pdmR3DevLoad(pVM, &RegCB, pszFilename, "VBoxDD2");
621	RTMemTmpFree(pszFilename);
622	if (RT_FAILURE(rc))
623	return rc;
624	}
625
626	/*
627	* Load additional device modules.
628	*/
629	PCFGMNODE pCur;
630	for (pCur = CFGMR3GetFirstChild(pDevicesNode); pCur; pCur = CFGMR3GetNextChild(pCur))
631	{
632	/*
633	* Get the name and path.
634	*/
635	char szName[PDMMOD_NAME_LEN];
636	rc = CFGMR3GetName(pCur, &szName[0], sizeof(szName));
637	if (rc == VERR_CFGM_NOT_ENOUGH_SPACE)
638	{
639	AssertMsgFailed(("configuration error: The module name is too long, cchName=%zu.\n", CFGMR3GetNameLen(pCur)));
640	return VERR_PDM_MODULE_NAME_TOO_LONG;
641	}
642	else if (RT_FAILURE(rc))
643	{
644	AssertMsgFailed(("CFGMR3GetName -> %Rrc.\n", rc));
645	return rc;
646	}
647
648	/* the path is optional, if no path the module name + path is used. */
649	char szFilename[RTPATH_MAX];
650	rc = CFGMR3QueryString(pCur, "Path", &szFilename[0], sizeof(szFilename));
651	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
652	strcpy(szFilename, szName);
653	else if (RT_FAILURE(rc))
654	{
655	AssertMsgFailed(("configuration error: Failure to query the module path, rc=%Rrc.\n", rc));
656	return rc;
657	}
658
659	/* prepend path? */
660	if (!RTPathHavePath(szFilename))
661	{
662	char psz = pdmR3FileR3(szFilename, false /fShared*/);
663	if (!psz)
664	return VERR_NO_TMP_MEMORY;
665	size_t cch = strlen(psz) + 1;
666	if (cch > sizeof(szFilename))
667	{
668	RTMemTmpFree(psz);
669	AssertMsgFailed(("Filename too long! cch=%d '%s'\n", cch, psz));
670	return VERR_FILENAME_TOO_LONG;
671	}
672	memcpy(szFilename, psz, cch);
673	RTMemTmpFree(psz);
674	}
675
676	/*
677	* Load the module and register it's devices.
678	*/
679	RegCB.pCfgNode = pCur;
680	rc = pdmR3DevLoad(pVM, &RegCB, szFilename, szName);
681	if (RT_FAILURE(rc))
682	return rc;
683	}
684
685	return VINF_SUCCESS;
686	}
687
688
689	/**
690	* Loads one device module and call the registration entry point.
691	*
692	* @returns VBox status code.
693	* @param pVM The cross context VM structure.
694	* @param pRegCB The registration callback stuff.
695	* @param pszFilename Module filename.
696	* @param pszName Module name.
697	*/
698	static int pdmR3DevLoad(PVM pVM, PPDMDEVREGCBINT pRegCB, const char pszFilename, const char pszName)
699	{
700	/*
701	* Load it.
702	*/
703	int rc = pdmR3LoadR3U(pVM->pUVM, pszFilename, pszName);
704	if (RT_SUCCESS(rc))
705	{
706	/*
707	* Get the registration export and call it.
708	*/
709	FNPDMVBOXDEVICESREGISTER *pfnVBoxDevicesRegister;
710	rc = PDMR3LdrGetSymbolR3(pVM, pszName, "VBoxDevicesRegister", (void **)&pfnVBoxDevicesRegister);
711	if (RT_SUCCESS(rc))
712	{
713	Log(("PDM: Calling VBoxDevicesRegister (%p) of %s (%s)\n", pfnVBoxDevicesRegister, pszName, pszFilename));
714	rc = pfnVBoxDevicesRegister(&pRegCB->Core, VBOX_VERSION);
715	if (RT_SUCCESS(rc))
716	Log(("PDM: Successfully loaded device module %s (%s).\n", pszName, pszFilename));
717	else
718	AssertMsgFailed(("VBoxDevicesRegister failed with rc=%Rrc for module %s (%s)\n", rc, pszName, pszFilename));
719	}
720	else
721	{
722	AssertMsgFailed(("Failed to locate 'VBoxDevicesRegister' in %s (%s) rc=%Rrc\n", pszName, pszFilename, rc));
723	if (rc == VERR_SYMBOL_NOT_FOUND)
724	rc = VERR_PDM_NO_REGISTRATION_EXPORT;
725	}
726	}
727	else
728	AssertMsgFailed(("Failed to load %s %s!\n", pszFilename, pszName));
729	return rc;
730	}
731
732
733	/**
734	* @interface_method_impl{PDMDEVREGCB,pfnRegister}
735	*/
736	static DECLCALLBACK(int) pdmR3DevReg_Register(PPDMDEVREGCB pCallbacks, PCPDMDEVREG pReg)
737	{
738	/*
739	* Validate the registration structure.
740	*/
741	Assert(pReg);
742	AssertMsgReturn(pReg->u32Version == PDM_DEVREG_VERSION,
743	("Unknown struct version %#x!\n", pReg->u32Version),
744	VERR_PDM_UNKNOWN_DEVREG_VERSION);
745
746	AssertMsgReturn( pReg->szName[0]
747	&& strlen(pReg->szName) < sizeof(pReg->szName)
748	&& pdmR3IsValidName(pReg->szName),
749	("Invalid name '%.*s'\n", sizeof(pReg->szName), pReg->szName),
750	VERR_PDM_INVALID_DEVICE_REGISTRATION);
751	AssertMsgReturn( !(pReg->fFlags & PDM_DEVREG_FLAGS_RC)
752	\|\| ( pReg->pszRCMod[0]
753	&& strlen(pReg->pszRCMod) < RT_SIZEOFMEMB(PDMDEVICECREATEREQ, szModName)),
754	("Invalid GC module name '%s' - (Device %s)\n", pReg->pszRCMod, pReg->szName),
755	VERR_PDM_INVALID_DEVICE_REGISTRATION);
756	AssertMsgReturn( !(pReg->fFlags & PDM_DEVREG_FLAGS_R0)
757	\|\| ( pReg->pszR0Mod[0]
758	&& strlen(pReg->pszR0Mod) < RT_SIZEOFMEMB(PDMDEVICECREATEREQ, szModName)),
759	("Invalid R0 module name '%s' - (Device %s)\n", pReg->pszR0Mod, pReg->szName),
760	VERR_PDM_INVALID_DEVICE_REGISTRATION);
761	AssertMsgReturn((pReg->fFlags & PDM_DEVREG_FLAGS_HOST_BITS_MASK) == PDM_DEVREG_FLAGS_HOST_BITS_DEFAULT,
762	("Invalid host bits flags! fFlags=%#x (Device %s)\n", pReg->fFlags, pReg->szName),
763	VERR_PDM_INVALID_DEVICE_HOST_BITS);
764	AssertMsgReturn((pReg->fFlags & PDM_DEVREG_FLAGS_GUEST_BITS_MASK),
765	("Invalid guest bits flags! fFlags=%#x (Device %s)\n", pReg->fFlags, pReg->szName),
766	VERR_PDM_INVALID_DEVICE_REGISTRATION);
767	AssertMsgReturn(pReg->fClass,
768	("No class! (Device %s)\n", pReg->szName),
769	VERR_PDM_INVALID_DEVICE_REGISTRATION);
770	AssertMsgReturn(pReg->cMaxInstances > 0,
771	("Max instances %u! (Device %s)\n", pReg->cMaxInstances, pReg->szName),
772	VERR_PDM_INVALID_DEVICE_REGISTRATION);
773	AssertMsgReturn(pReg->cbInstanceShared <= (uint32_t)(pReg->fFlags & (PDM_DEVREG_FLAGS_RC \| PDM_DEVREG_FLAGS_R0) ? 96 * _1K : _1M),
774	("Instance size %d bytes! (Device %s)\n", pReg->cbInstanceShared, pReg->szName),
775	VERR_PDM_INVALID_DEVICE_REGISTRATION);
776	AssertMsgReturn(pReg->cbInstanceCC <= _2M, ("Instance size %d bytes! (Device %s)\n", pReg->cbInstanceCC, pReg->szName),
777	VERR_PDM_INVALID_DEVICE_REGISTRATION);
778	AssertMsgReturn(pReg->pfnConstruct,
779	("No constructor! (Device %s)\n", pReg->szName),
780	VERR_PDM_INVALID_DEVICE_REGISTRATION);
781	AssertLogRelMsgReturn((pReg->fFlags & PDM_DEVREG_FLAGS_GUEST_BITS_MASK) == PDM_DEVREG_FLAGS_GUEST_BITS_DEFAULT,
782	("PDM: Rejected device '%s' because it didn't match the guest bits.\n", pReg->szName),
783	VERR_PDM_INVALID_DEVICE_GUEST_BITS);
784	AssertLogRelMsg(pReg->u32VersionEnd == PDM_DEVREG_VERSION,
785	("u32VersionEnd=%#x, expected %#x. (szName=%s)\n",
786	pReg->u32VersionEnd, PDM_DEVREG_VERSION, pReg->szName));
787	AssertLogRelMsgReturn(pReg->cMaxPciDevices <= 8, ("%#x (szName=%s)\n", pReg->cMaxPciDevices, pReg->szName),
788	VERR_PDM_INVALID_DEVICE_REGISTRATION);
789	AssertLogRelMsgReturn(pReg->cMaxMsixVectors <= VBOX_MSIX_MAX_ENTRIES,
790	("%#x (szName=%s)\n", pReg->cMaxMsixVectors, pReg->szName),
791	VERR_PDM_INVALID_DEVICE_REGISTRATION);
792
793	/*
794	* Check for duplicate and find FIFO entry at the same time.
795	*/
796	PCPDMDEVREGCBINT pRegCB = (PCPDMDEVREGCBINT)pCallbacks;
797	PPDMDEV pDevPrev = NULL;
798	PPDMDEV pDev = pRegCB->pVM->pdm.s.pDevs;
799	for (; pDev; pDevPrev = pDev, pDev = pDev->pNext)
800	AssertMsgReturn(strcmp(pDev->pReg->szName, pReg->szName),
801	("Device '%s' already exists\n", pReg->szName),
802	VERR_PDM_DEVICE_NAME_CLASH);
803
804	/*
805	* Allocate new device structure, initialize and insert it into the list.
806	*/
807	int rc;
808	pDev = (PPDMDEV)MMR3HeapAlloc(pRegCB->pVM, MM_TAG_PDM_DEVICE, sizeof(*pDev));
809	if (pDev)
810	{
811	pDev->pNext = NULL;
812	pDev->cInstances = 0;
813	pDev->pInstances = NULL;
814	pDev->pReg = pReg;
815	pDev->cchName = (uint32_t)strlen(pReg->szName);
816	rc = CFGMR3QueryStringAllocDef( pRegCB->pCfgNode, "RCSearchPath", &pDev->pszRCSearchPath, NULL);
817	if (RT_SUCCESS(rc))
818	rc = CFGMR3QueryStringAllocDef(pRegCB->pCfgNode, "R0SearchPath", &pDev->pszR0SearchPath, NULL);
819	if (RT_SUCCESS(rc))
820	{
821	if (pDevPrev)
822	pDevPrev->pNext = pDev;
823	else
824	pRegCB->pVM->pdm.s.pDevs = pDev;
825	Log(("PDM: Registered device '%s'\n", pReg->szName));
826	return VINF_SUCCESS;
827	}
828
829	MMR3HeapFree(pDev);
830	}
831	else
832	rc = VERR_NO_MEMORY;
833	return rc;
834	}
835
836
837	/**
838	* Locates a LUN.
839	*
840	* @returns VBox status code.
841	* @param pVM The cross context VM structure.
842	* @param pszDevice Device name.
843	* @param iInstance Device instance.
844	* @param iLun The Logical Unit to obtain the interface of.
845	* @param ppLun Where to store the pointer to the LUN if found.
846	* @thread Try only do this in EMT...
847	*/
848	int pdmR3DevFindLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPPDMLUN ppLun)
849	{
850	/*
851	* Iterate registered devices looking for the device.
852	*/
853	size_t cchDevice = strlen(pszDevice);
854	for (PPDMDEV pDev = pVM->pdm.s.pDevs; pDev; pDev = pDev->pNext)
855	{
856	if ( pDev->cchName == cchDevice
857	&& !memcmp(pDev->pReg->szName, pszDevice, cchDevice))
858	{
859	/*
860	* Iterate device instances.
861	*/
862	for (PPDMDEVINS pDevIns = pDev->pInstances; pDevIns; pDevIns = pDevIns->Internal.s.pPerDeviceNextR3)
863	{
864	if (pDevIns->iInstance == iInstance)
865	{
866	/*
867	* Iterate luns.
868	*/
869	for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
870	{
871	if (pLun->iLun == iLun)
872	{
873	*ppLun = pLun;
874	return VINF_SUCCESS;
875	}
876	}
877	return VERR_PDM_LUN_NOT_FOUND;
878	}
879	}
880	return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND;
881	}
882	}
883	return VERR_PDM_DEVICE_NOT_FOUND;
884	}
885
886
887	/**
888	* Attaches a preconfigured driver to an existing device instance.
889	*
890	* This is used to change drivers and suchlike at runtime.
891	*
892	* @returns VBox status code.
893	* @param pUVM The user mode VM handle.
894	* @param pszDevice Device name.
895	* @param iInstance Device instance.
896	* @param iLun The Logical Unit to obtain the interface of.
897	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
898	* @param ppBase Where to store the base interface pointer. Optional.
899	* @thread EMT
900	*/
901	VMMR3DECL(int) PDMR3DeviceAttach(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, uint32_t fFlags, PPPDMIBASE ppBase)
902	{
903	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
904	PVM pVM = pUVM->pVM;
905	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
906	VM_ASSERT_EMT(pVM);
907	LogFlow(("PDMR3DeviceAttach: pszDevice=%p:{%s} iInstance=%d iLun=%d fFlags=%#x ppBase=%p\n",
908	pszDevice, pszDevice, iInstance, iLun, fFlags, ppBase));
909
910	/*
911	* Find the LUN in question.
912	*/
913	PPDMLUN pLun;
914	int rc = pdmR3DevFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
915	if (RT_SUCCESS(rc))
916	{
917	/*
918	* Can we attach anything at runtime?
919	*/
920	PPDMDEVINS pDevIns = pLun->pDevIns;
921	if (pDevIns->pReg->pfnAttach)
922	{
923	if (!pLun->pTop)
924	{
925	PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
926	rc = pDevIns->pReg->pfnAttach(pDevIns, iLun, fFlags);
927	PDMCritSectLeave(pDevIns->pCritSectRoR3);
928	}
929	else
930	rc = VERR_PDM_DRIVER_ALREADY_ATTACHED;
931	}
932	else
933	rc = VERR_PDM_DEVICE_NO_RT_ATTACH;
934
935	if (ppBase)
936	*ppBase = pLun->pTop ? &pLun->pTop->IBase : NULL;
937	}
938	else if (ppBase)
939	*ppBase = NULL;
940
941	if (ppBase)
942	LogFlow(("PDMR3DeviceAttach: returns %Rrc ppBase=%p\n", rc, ppBase));
943	else
944	LogFlow(("PDMR3DeviceAttach: returns %Rrc\n", rc));
945	return rc;
946	}
947
948
949	/**
950	* Detaches a driver chain from an existing device instance.
951	*
952	* This is used to change drivers and suchlike at runtime.
953	*
954	* @returns VBox status code.
955	* @param pUVM The user mode VM handle.
956	* @param pszDevice Device name.
957	* @param iInstance Device instance.
958	* @param iLun The Logical Unit to obtain the interface of.
959	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
960	* @thread EMT
961	*/
962	VMMR3DECL(int) PDMR3DeviceDetach(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, uint32_t fFlags)
963	{
964	return PDMR3DriverDetach(pUVM, pszDevice, iInstance, iLun, NULL, 0, fFlags);
965	}
966
967
968	/**
969	* References the critical section associated with a device for the use by a
970	* timer or similar created by the device.
971	*
972	* @returns Pointer to the critical section.
973	* @param pVM The cross context VM structure.
974	* @param pDevIns The device instance in question.
975	*
976	* @internal
977	*/
978	VMMR3_INT_DECL(PPDMCRITSECT) PDMR3DevGetCritSect(PVM pVM, PPDMDEVINS pDevIns)
979	{
980	VM_ASSERT_EMT(pVM); RT_NOREF_PV(pVM);
981	VM_ASSERT_STATE(pVM, VMSTATE_CREATING);
982	AssertPtr(pDevIns);
983
984	PPDMCRITSECT pCritSect = pDevIns->pCritSectRoR3;
985	AssertPtr(pCritSect);
986	pCritSect->s.fUsedByTimerOrSimilar = true;
987
988	return pCritSect;
989	}
990
991
992	/**
993	* Attaches a preconfigured driver to an existing device or driver instance.
994	*
995	* This is used to change drivers and suchlike at runtime. The driver or device
996	* at the end of the chain will be told to attach to whatever is configured
997	* below it.
998	*
999	* @returns VBox status code.
1000	* @param pUVM The user mode VM handle.
1001	* @param pszDevice Device name.
1002	* @param iInstance Device instance.
1003	* @param iLun The Logical Unit to obtain the interface of.
1004	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
1005	* @param ppBase Where to store the base interface pointer. Optional.
1006	*
1007	* @thread EMT
1008	*/
1009	VMMR3DECL(int) PDMR3DriverAttach(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, uint32_t fFlags, PPPDMIBASE ppBase)
1010	{
1011	LogFlow(("PDMR3DriverAttach: pszDevice=%p:{%s} iInstance=%d iLun=%d fFlags=%#x ppBase=%p\n",
1012	pszDevice, pszDevice, iInstance, iLun, fFlags, ppBase));
1013	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1014	PVM pVM = pUVM->pVM;
1015	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1016	VM_ASSERT_EMT(pVM);
1017
1018	if (ppBase)
1019	*ppBase = NULL;
1020
1021	/*
1022	* Find the LUN in question.
1023	*/
1024	PPDMLUN pLun;
1025	int rc = pdmR3DevFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
1026	if (RT_SUCCESS(rc))
1027	{
1028	/*
1029	* Anything attached to the LUN?
1030	*/
1031	PPDMDRVINS pDrvIns = pLun->pTop;
1032	if (!pDrvIns)
1033	{
1034	/* No, ask the device to attach to the new stuff. */
1035	PPDMDEVINS pDevIns = pLun->pDevIns;
1036	if (pDevIns->pReg->pfnAttach)
1037	{
1038	PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
1039	rc = pDevIns->pReg->pfnAttach(pDevIns, iLun, fFlags);
1040	if (RT_SUCCESS(rc) && ppBase)
1041	*ppBase = pLun->pTop ? &pLun->pTop->IBase : NULL;
1042	PDMCritSectLeave(pDevIns->pCritSectRoR3);
1043	}
1044	else
1045	rc = VERR_PDM_DEVICE_NO_RT_ATTACH;
1046	}
1047	else
1048	{
1049	/* Yes, find the bottom most driver and ask it to attach to the new stuff. */
1050	while (pDrvIns->Internal.s.pDown)
1051	pDrvIns = pDrvIns->Internal.s.pDown;
1052	if (pDrvIns->pReg->pfnAttach)
1053	{
1054	rc = pDrvIns->pReg->pfnAttach(pDrvIns, fFlags);
1055	if (RT_SUCCESS(rc) && ppBase)
1056	*ppBase = pDrvIns->Internal.s.pDown
1057	? &pDrvIns->Internal.s.pDown->IBase
1058	: NULL;
1059	}
1060	else
1061	rc = VERR_PDM_DRIVER_NO_RT_ATTACH;
1062	}
1063	}
1064
1065	if (ppBase)
1066	LogFlow(("PDMR3DriverAttach: returns %Rrc ppBase=%p\n", rc, ppBase));
1067	else
1068	LogFlow(("PDMR3DriverAttach: returns %Rrc\n", rc));
1069	return rc;
1070	}
1071
1072
1073	/**
1074	* Detaches the specified driver instance.
1075	*
1076	* This is used to replumb drivers at runtime for simulating hot plugging and
1077	* media changes.
1078	*
1079	* This is a superset of PDMR3DeviceDetach. It allows detaching drivers from
1080	* any driver or device by specifying the driver to start detaching at. The
1081	* only prerequisite is that the driver or device above implements the
1082	* pfnDetach callback (PDMDRVREG / PDMDEVREG).
1083	*
1084	* @returns VBox status code.
1085	* @param pUVM The user mode VM handle.
1086	* @param pszDevice Device name.
1087	* @param iDevIns Device instance.
1088	* @param iLun The Logical Unit in which to look for the driver.
1089	* @param pszDriver The name of the driver which to detach. If NULL
1090	* then the entire driver chain is detatched.
1091	* @param iOccurrence The occurrence of that driver in the chain. This is
1092	* usually 0.
1093	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
1094	* @thread EMT
1095	*/
1096	VMMR3DECL(int) PDMR3DriverDetach(PUVM pUVM, const char *pszDevice, unsigned iDevIns, unsigned iLun,
1097	const char *pszDriver, unsigned iOccurrence, uint32_t fFlags)
1098	{
1099	LogFlow(("PDMR3DriverDetach: pszDevice=%p:{%s} iDevIns=%u iLun=%u pszDriver=%p:{%s} iOccurrence=%u fFlags=%#x\n",
1100	pszDevice, pszDevice, iDevIns, iLun, pszDriver, pszDriver, iOccurrence, fFlags));
1101	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1102	PVM pVM = pUVM->pVM;
1103	VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1104	VM_ASSERT_EMT(pVM);
1105	AssertPtr(pszDevice);
1106	AssertPtrNull(pszDriver);
1107	Assert(iOccurrence == 0 \|\| pszDriver);
1108	Assert(!(fFlags & ~(PDM_TACH_FLAGS_NOT_HOT_PLUG)));
1109
1110	/*
1111	* Find the LUN in question.
1112	*/
1113	PPDMLUN pLun;
1114	int rc = pdmR3DevFindLun(pVM, pszDevice, iDevIns, iLun, &pLun);
1115	if (RT_SUCCESS(rc))
1116	{
1117	/*
1118	* Locate the driver.
1119	*/
1120	PPDMDRVINS pDrvIns = pLun->pTop;
1121	if (pDrvIns)
1122	{
1123	if (pszDriver)
1124	{
1125	while (pDrvIns)
1126	{
1127	if (!strcmp(pDrvIns->pReg->szName, pszDriver))
1128	{
1129	if (iOccurrence == 0)
1130	break;
1131	iOccurrence--;
1132	}
1133	pDrvIns = pDrvIns->Internal.s.pDown;
1134	}
1135	}
1136	if (pDrvIns)
1137	rc = pdmR3DrvDetach(pDrvIns, fFlags);
1138	else
1139	rc = VERR_PDM_DRIVER_INSTANCE_NOT_FOUND;
1140	}
1141	else
1142	rc = VINF_PDM_NO_DRIVER_ATTACHED_TO_LUN;
1143	}
1144
1145	LogFlow(("PDMR3DriverDetach: returns %Rrc\n", rc));
1146	return rc;
1147	}
1148
1149
1150	/**
1151	* Runtime detach and reattach of a new driver chain or sub chain.
1152	*
1153	* This is intended to be called on a non-EMT thread, this will instantiate the
1154	* new driver (sub-)chain, and then the EMTs will do the actual replumbing. The
1155	* destruction of the old driver chain will be taken care of on the calling
1156	* thread.
1157	*
1158	* @returns VBox status code.
1159	* @param pUVM The user mode VM handle.
1160	* @param pszDevice Device name.
1161	* @param iDevIns Device instance.
1162	* @param iLun The Logical Unit in which to look for the driver.
1163	* @param pszDriver The name of the driver which to detach and replace.
1164	* If NULL then the entire driver chain is to be
1165	* reattached.
1166	* @param iOccurrence The occurrence of that driver in the chain. This is
1167	* usually 0.
1168	* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
1169	* @param pCfg The configuration of the new driver chain that is
1170	* going to be attached. The subtree starts with the
1171	* node containing a Driver key, a Config subtree and
1172	* optionally an AttachedDriver subtree.
1173	* If this parameter is NULL, then this call will work
1174	* like at a non-pause version of PDMR3DriverDetach.
1175	* @param ppBase Where to store the base interface pointer to the new
1176	* driver. Optional.
1177	*
1178	* @thread Any thread. The EMTs will be involved at some point though.
1179	*/
1180	VMMR3DECL(int) PDMR3DriverReattach(PUVM pUVM, const char *pszDevice, unsigned iDevIns, unsigned iLun,
1181	const char *pszDriver, unsigned iOccurrence, uint32_t fFlags,
1182	PCFGMNODE pCfg, PPPDMIBASE ppBase)
1183	{
1184	NOREF(pUVM); NOREF(pszDevice); NOREF(iDevIns); NOREF(iLun); NOREF(pszDriver); NOREF(iOccurrence);
1185	NOREF(fFlags); NOREF(pCfg); NOREF(ppBase);
1186	return VERR_NOT_IMPLEMENTED;
1187	}
1188

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

source: vbox/trunk/src/VBox/VMM/VMMR3/PDMDevice.cpp@ 81150

Download in other formats: