PDMDevice.cpp@ 92341

Last change on this file since 92341 was 91895, checked in by vboxsync, 3 years ago
VMM: Removed raw-mode stuff from PDMQueue. bugref:9517
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 49.1 KB

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

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

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

Download in other formats: