VirtualBox

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

Last change on this file since 5999 was 5999, checked in by vboxsync, 17 years ago

The Giant CDDL Dual-License Header Change.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 41.0 KB
Line 
1/* $Id: PDMDriver.cpp 5999 2007-12-07 15:05:06Z vboxsync $ */
2/** @file
3 * PDM - Pluggable Device and Driver Manager, Driver parts.
4 */
5
6/*
7 * Copyright (C) 2006-2007 innotek GmbH
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_DRIVER
23#include "PDMInternal.h"
24#include <VBox/pdm.h>
25#include <VBox/mm.h>
26#include <VBox/cfgm.h>
27#include <VBox/vmm.h>
28#include <VBox/sup.h>
29#include <VBox/vm.h>
30#include <VBox/version.h>
31#include <VBox/err.h>
32
33#include <VBox/log.h>
34#include <iprt/assert.h>
35#include <iprt/thread.h>
36#include <iprt/string.h>
37#include <iprt/asm.h>
38#include <iprt/alloc.h>
39#include <iprt/path.h>
40
41
42/*******************************************************************************
43* Structures and Typedefs *
44*******************************************************************************/
45/**
46 * Internal callback structure pointer.
47 *
48 * The main purpose is to define the extra data we associate
49 * with PDMDRVREGCB so we can find the VM instance and so on.
50 */
51typedef struct PDMDRVREGCBINT
52{
53 /** The callback structure. */
54 PDMDRVREGCB Core;
55 /** A bit of padding. */
56 uint32_t u32[4];
57 /** VM Handle. */
58 PVM pVM;
59} PDMDRVREGCBINT, *PPDMDRVREGCBINT;
60typedef const PDMDRVREGCBINT *PCPDMDRVREGCBINT;
61
62
63/*******************************************************************************
64* Internal Functions *
65*******************************************************************************/
66/** @name Driver Helpers
67 * @{
68 */
69static DECLCALLBACK(int) pdmR3DrvHlp_Attach(PPDMDRVINS pDrvIns, PPDMIBASE *ppBaseInterface);
70static DECLCALLBACK(int) pdmR3DrvHlp_Detach(PPDMDRVINS pDrvIns);
71static DECLCALLBACK(int) pdmR3DrvHlp_DetachSelf(PPDMDRVINS pDrvIns);
72static DECLCALLBACK(int) pdmR3DrvHlp_MountPrepare(PPDMDRVINS pDrvIns, const char *pszFilename, const char *pszCoreDriver);
73static DECLCALLBACK(int) pdmR3DrvHlp_VMSetError(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...);
74static DECLCALLBACK(int) pdmR3DrvHlp_VMSetErrorV(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va);
75static DECLCALLBACK(int) pdmR3DrvHlp_VMSetRuntimeError(PPDMDRVINS pDrvIns, bool fFatal, const char *pszErrorID, const char *pszFormat, ...);
76static DECLCALLBACK(int) pdmR3DrvHlp_VMSetRuntimeErrorV(PPDMDRVINS pDrvIns, bool fFatal, const char *pszErrorID, const char *pszFormat, va_list va);
77static DECLCALLBACK(bool) pdmR3DrvHlp_AssertEMT(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction);
78static DECLCALLBACK(bool) pdmR3DrvHlp_AssertOther(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction);
79static DECLCALLBACK(int) pdmR3DrvHlp_PDMQueueCreate(PPDMDRVINS pDrvIns, RTUINT cbItem, RTUINT cItems, uint32_t cMilliesInterval, PFNPDMQUEUEDRV pfnCallback, PPDMQUEUE *ppQueue);
80static DECLCALLBACK(int) pdmR3DrvHlp_PDMPollerRegister(PPDMDRVINS pDrvIns, PFNPDMDRVPOLLER pfnPoller);
81static DECLCALLBACK(uint64_t) pdmR3DrvHlp_TMGetVirtualFreq(PPDMDRVINS pDrvIns);
82static DECLCALLBACK(uint64_t) pdmR3DrvHlp_TMGetVirtualTime(PPDMDRVINS pDrvIns);
83static DECLCALLBACK(int) pdmR3DrvHlp_TMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, const char *pszDesc, PPTMTIMERR3 ppTimer);
84static DECLCALLBACK(int) pdmR3DrvHlp_SSMRegister(PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance, uint32_t u32Version, size_t cbGuess,
85 PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
86 PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone);
87static DECLCALLBACK(int) pdmR3DrvHlp_SSMDeregister(PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance);
88static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegister(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, const char *pszName, STAMUNIT enmUnit, const char *pszDesc);
89static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit, const char *pszDesc, const char *pszName, ...);
90static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegisterV(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit, const char *pszDesc, const char *pszName, va_list args);
91static DECLCALLBACK(int) pdmR3DrvHlp_SUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg);
92static DECLCALLBACK(int) pdmR3DrvHlp_USBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp);
93static DECLCALLBACK(int) pdmR3DrvHlp_PDMThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
94 PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName);
95
96/** @def PDMDRV_ASSERT_DRVINS
97 * Asserts the validity of the driver instance.
98 */
99#ifdef VBOX_STRICT
100# define PDMDRV_ASSERT_DRVINS(pDrvIns) do { Assert(pDrvIns); Assert(pDrvIns->u32Version == PDM_DRVINS_VERSION); Assert(pDrvIns->pvInstanceData == (void *)&pDrvIns->achInstanceData[0]); } while (0)
101#else
102# define PDMDRV_ASSERT_DRVINS(pDrvIns) do { } while (0)
103#endif
104/** @} */
105
106static DECLCALLBACK(int) pdmR3DrvRegister(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pDrvReg);
107static int pdmR3DrvLoad(PVM pVM, PPDMDRVREGCBINT pRegCB, const char *pszFilename, const char *pszName);
108
109
110/*******************************************************************************
111* Global Variables *
112*******************************************************************************/
113/**
114 * The driver helper structure.
115 */
116const PDMDRVHLP g_pdmR3DrvHlp =
117{
118 PDM_DRVHLP_VERSION,
119 pdmR3DrvHlp_Attach,
120 pdmR3DrvHlp_Detach,
121 pdmR3DrvHlp_DetachSelf,
122 pdmR3DrvHlp_MountPrepare,
123 pdmR3DrvHlp_AssertEMT,
124 pdmR3DrvHlp_AssertOther,
125 pdmR3DrvHlp_VMSetError,
126 pdmR3DrvHlp_VMSetErrorV,
127 pdmR3DrvHlp_VMSetRuntimeError,
128 pdmR3DrvHlp_VMSetRuntimeErrorV,
129 pdmR3DrvHlp_PDMQueueCreate,
130 pdmR3DrvHlp_PDMPollerRegister,
131 pdmR3DrvHlp_TMGetVirtualFreq,
132 pdmR3DrvHlp_TMGetVirtualTime,
133 pdmR3DrvHlp_TMTimerCreate,
134 pdmR3DrvHlp_SSMRegister,
135 pdmR3DrvHlp_SSMDeregister,
136 pdmR3DrvHlp_STAMRegister,
137 pdmR3DrvHlp_STAMRegisterF,
138 pdmR3DrvHlp_STAMRegisterV,
139 pdmR3DrvHlp_SUPCallVMMR0Ex,
140 pdmR3DrvHlp_USBRegisterHub,
141 pdmR3DrvHlp_PDMThreadCreate,
142 0 /* the end */
143};
144
145
146/**
147 * Register external drivers
148 *
149 * @returns VBox status code.
150 * @param pVM The VM to operate on.
151 * @param pfnCallback Driver registration callback
152 */
153PDMR3DECL(int) PDMR3RegisterDrivers(PVM pVM, FNPDMVBOXDRIVERSREGISTER pfnCallback)
154{
155 /*
156 * The registration callbacks.
157 */
158 PDMDRVREGCBINT RegCB;
159 RegCB.Core.u32Version = PDM_DRVREG_CB_VERSION;
160 RegCB.Core.pfnRegister = pdmR3DrvRegister;
161 RegCB.pVM = pVM;
162
163 int rc = pfnCallback(&RegCB.Core, VBOX_VERSION);
164 if (VBOX_FAILURE(rc))
165 AssertMsgFailed(("VBoxDriversRegister failed with rc=%Vrc\n"));
166
167 return rc;
168}
169
170/**
171 * This function will initialize the drivers for this VM instance.
172 *
173 * First of all this mean loading the builtin drivers and letting them
174 * register themselves. Beyond that any additional driver modules are
175 * loaded and called for registration.
176 *
177 * @returns VBox status code.
178 * @param pVM VM Handle.
179 */
180int pdmR3DrvInit(PVM pVM)
181{
182 LogFlow(("pdmR3DrvInit:\n"));
183
184 AssertRelease(!(RT_OFFSETOF(PDMDRVINS, achInstanceData) & 15));
185 PPDMDRVINS pDrvInsAssert;
186 AssertRelease(sizeof(pDrvInsAssert->Internal.s) <= sizeof(pDrvInsAssert->Internal.padding));
187
188 /*
189 * The registration callbacks.
190 */
191 PDMDRVREGCBINT RegCB;
192 RegCB.Core.u32Version = PDM_DRVREG_CB_VERSION;
193 RegCB.Core.pfnRegister = pdmR3DrvRegister;
194 RegCB.pVM = pVM;
195
196 /*
197 * Load the builtin module
198 */
199 PCFGMNODE pDriversNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "PDM/Drivers");
200 bool fLoadBuiltin;
201 int rc = CFGMR3QueryBool(pDriversNode, "LoadBuiltin", &fLoadBuiltin);
202 if (rc == VERR_CFGM_VALUE_NOT_FOUND || rc == VERR_CFGM_NO_PARENT)
203 fLoadBuiltin = true;
204 else if (VBOX_FAILURE(rc))
205 {
206 AssertMsgFailed(("Configuration error: Querying boolean \"LoadBuiltin\" failed with %Vrc\n", rc));
207 return rc;
208 }
209 if (fLoadBuiltin)
210 {
211 /* make filename */
212 char *pszFilename = pdmR3FileR3("VBoxDD", /*fShared=*/true);
213 if (!pszFilename)
214 return VERR_NO_TMP_MEMORY;
215 rc = pdmR3DrvLoad(pVM, &RegCB, pszFilename, "VBoxDD");
216 RTMemTmpFree(pszFilename);
217 if (VBOX_FAILURE(rc))
218 return rc;
219 }
220
221 /*
222 * Load additional driver modules.
223 */
224 for (PCFGMNODE pCur = CFGMR3GetFirstChild(pDriversNode); pCur; pCur = CFGMR3GetNextChild(pCur))
225 {
226 /*
227 * Get the name and path.
228 */
229 char szName[PDMMOD_NAME_LEN];
230 rc = CFGMR3GetName(pCur, &szName[0], sizeof(szName));
231 if (rc == VERR_CFGM_NOT_ENOUGH_SPACE)
232 {
233 AssertMsgFailed(("configuration error: The module name is too long, cchName=%d.\n", CFGMR3GetNameLen(pCur)));
234 return VERR_PDM_MODULE_NAME_TOO_LONG;
235 }
236 else if (VBOX_FAILURE(rc))
237 {
238 AssertMsgFailed(("CFGMR3GetName -> %Vrc.\n", rc));
239 return rc;
240 }
241
242 /* the path is optional, if no path the module name + path is used. */
243 char szFilename[RTPATH_MAX];
244 rc = CFGMR3QueryString(pCur, "Path", &szFilename[0], sizeof(szFilename));
245 if (rc == VERR_CFGM_VALUE_NOT_FOUND || rc == VERR_CFGM_NO_PARENT)
246 strcpy(szFilename, szName);
247 else if (VBOX_FAILURE(rc))
248 {
249 AssertMsgFailed(("configuration error: Failure to query the module path, rc=%Vrc.\n", rc));
250 return rc;
251 }
252
253 /* prepend path? */
254 if (!RTPathHavePath(szFilename))
255 {
256 char *psz = pdmR3FileR3(szFilename);
257 if (!psz)
258 return VERR_NO_TMP_MEMORY;
259 size_t cch = strlen(psz) + 1;
260 if (cch > sizeof(szFilename))
261 {
262 RTMemTmpFree(psz);
263 AssertMsgFailed(("Filename too long! cch=%d '%s'\n", cch, psz));
264 return VERR_FILENAME_TOO_LONG;
265 }
266 memcpy(szFilename, psz, cch);
267 RTMemTmpFree(psz);
268 }
269
270 /*
271 * Load the module and register it's drivers.
272 */
273 rc = pdmR3DrvLoad(pVM, &RegCB, szFilename, szName);
274 if (VBOX_FAILURE(rc))
275 return rc;
276 }
277
278 LogFlow(("pdmR3DrvInit: returns VINF_SUCCESS\n"));
279 return VINF_SUCCESS;
280}
281
282
283/**
284 * Loads one driver module and call the registration entry point.
285 *
286 * @returns VBox status code.
287 * @param pVM VM handle.
288 * @param pRegCB The registration callback stuff.
289 * @param pszFilename Module filename.
290 * @param pszName Module name.
291 */
292static int pdmR3DrvLoad(PVM pVM, PPDMDRVREGCBINT pRegCB, const char *pszFilename, const char *pszName)
293{
294 /*
295 * Load it.
296 */
297 int rc = pdmR3LoadR3(pVM, pszFilename, pszName);
298 if (VBOX_SUCCESS(rc))
299 {
300 /*
301 * Get the registration export and call it.
302 */
303 FNPDMVBOXDRIVERSREGISTER *pfnVBoxDriversRegister;
304 rc = PDMR3GetSymbolR3(pVM, pszName, "VBoxDriversRegister", (void **)&pfnVBoxDriversRegister);
305 if (VBOX_SUCCESS(rc))
306 {
307 Log(("PDM: Calling VBoxDriversRegister (%p) of %s (%s)\n", pfnVBoxDriversRegister, pszName, pszFilename));
308 rc = pfnVBoxDriversRegister(&pRegCB->Core, VBOX_VERSION);
309 if (VBOX_SUCCESS(rc))
310 Log(("PDM: Successfully loaded driver module %s (%s).\n", pszName, pszFilename));
311 else
312 AssertMsgFailed(("VBoxDriversRegister failed with rc=%Vrc\n"));
313 }
314 else
315 {
316 AssertMsgFailed(("Failed to locate 'VBoxDriversRegister' in %s (%s) rc=%Vrc\n", pszName, pszFilename, rc));
317 if (rc == VERR_SYMBOL_NOT_FOUND)
318 rc = VERR_PDM_NO_REGISTRATION_EXPORT;
319 }
320 }
321 else
322 AssertMsgFailed(("Failed to load %s (%s) rc=%Vrc!\n", pszName, pszFilename, rc));
323 return rc;
324}
325
326
327/** @copydoc PDMDRVREGCB::pfnRegister */
328static DECLCALLBACK(int) pdmR3DrvRegister(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pDrvReg)
329{
330 /*
331 * Validate the registration structure.
332 */
333 Assert(pDrvReg);
334 if (pDrvReg->u32Version != PDM_DRVREG_VERSION)
335 {
336 AssertMsgFailed(("Unknown struct version %#x!\n", pDrvReg->u32Version));
337 return VERR_PDM_UNKNOWN_DRVREG_VERSION;
338 }
339 if ( !pDrvReg->szDriverName[0]
340 || strlen(pDrvReg->szDriverName) >= sizeof(pDrvReg->szDriverName))
341 {
342 AssertMsgFailed(("Invalid name '%s'\n", pDrvReg->szDriverName));
343 return VERR_PDM_INVALID_DRIVER_REGISTRATION;
344 }
345 if ((pDrvReg->fFlags & PDM_DRVREG_FLAGS_HOST_BITS_MASK) != PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT)
346 {
347 AssertMsgFailed(("Invalid host bits flags! fFlags=%#x (Driver %s)\n", pDrvReg->fFlags, pDrvReg->szDriverName));
348 return VERR_PDM_INVALID_DRIVER_HOST_BITS;
349 }
350 if (pDrvReg->cMaxInstances <= 0)
351 {
352 AssertMsgFailed(("Max instances %u! (Driver %s)\n", pDrvReg->cMaxInstances, pDrvReg->szDriverName));
353 return VERR_PDM_INVALID_DRIVER_REGISTRATION;
354 }
355 if (pDrvReg->cbInstance > _1M)
356 {
357 AssertMsgFailed(("Instance size above 1MB, %d bytes! (Driver %s)\n", pDrvReg->cbInstance, pDrvReg->szDriverName));
358 return VERR_PDM_INVALID_DRIVER_REGISTRATION;
359 }
360 if (!pDrvReg->pfnConstruct)
361 {
362 AssertMsgFailed(("No constructore! (Driver %s)\n", pDrvReg->szDriverName));
363 return VERR_PDM_INVALID_DRIVER_REGISTRATION;
364 }
365
366 /*
367 * Check for duplicate and find FIFO entry at the same time.
368 */
369 PCPDMDRVREGCBINT pRegCB = (PCPDMDRVREGCBINT)pCallbacks;
370 PPDMDRV pDrvPrev = NULL;
371 PPDMDRV pDrv = pRegCB->pVM->pdm.s.pDrvs;
372 for (; pDrv; pDrvPrev = pDrv, pDrv = pDrv->pNext)
373 {
374 if (!strcmp(pDrv->pDrvReg->szDriverName, pDrvReg->szDriverName))
375 {
376 AssertMsgFailed(("Driver '%s' already exists\n", pDrvReg->szDriverName));
377 return VERR_PDM_DRIVER_NAME_CLASH;
378 }
379 }
380
381 /*
382 * Allocate new driver structure and insert it into the list.
383 */
384 pDrv = (PPDMDRV)MMR3HeapAlloc(pRegCB->pVM, MM_TAG_PDM_DRIVER, sizeof(*pDrv));
385 if (pDrv)
386 {
387 pDrv->pNext = NULL;
388 pDrv->cInstances = 0;
389 pDrv->pDrvReg = pDrvReg;
390
391 if (pDrvPrev)
392 pDrvPrev->pNext = pDrv;
393 else
394 pRegCB->pVM->pdm.s.pDrvs = pDrv;
395 Log(("PDM: Registered driver '%s'\n", pDrvReg->szDriverName));
396 return VINF_SUCCESS;
397 }
398 return VERR_NO_MEMORY;
399}
400
401
402/**
403 * Lookups a driver structure by name.
404 * @internal
405 */
406PPDMDRV pdmR3DrvLookup(PVM pVM, const char *pszName)
407{
408 for (PPDMDRV pDrv = pVM->pdm.s.pDrvs; pDrv; pDrv = pDrv->pNext)
409 if (!strcmp(pDrv->pDrvReg->szDriverName, pszName))
410 return pDrv;
411 return NULL;
412}
413
414
415/**
416 * Detaches a driver from whatever it's attached to.
417 * This will of course lead to the destruction of the driver and all drivers below it in the chain.
418 *
419 * @returns VINF_SUCCESS
420 * @param pDrvIns The driver instance to detach.
421 */
422int pdmR3DrvDetach(PPDMDRVINS pDrvIns)
423{
424 PDMDRV_ASSERT_DRVINS(pDrvIns);
425 LogFlow(("pdmR3DrvDetach: pDrvIns=%p '%s'/%d\n", pDrvIns, pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance));
426 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
427
428 /*
429 * Check that we're not doing this recursively, that could have unwanted sideeffects!
430 */
431 if (pDrvIns->Internal.s.fDetaching)
432 {
433 AssertMsgFailed(("Recursive detach! '%s'/%d\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance));
434 return VINF_SUCCESS;
435 }
436
437 /*
438 * Check that we actually can detach this instance.
439 * The requirement is that the driver/device above has a detach method.
440 */
441 if (pDrvIns->Internal.s.pUp
442 ? !pDrvIns->Internal.s.pUp->pDrvReg->pfnDetach
443 : !pDrvIns->Internal.s.pLun->pDevIns->pDevReg->pfnDetach)
444 {
445 AssertMsgFailed(("Cannot detach driver instance because the driver/device above doesn't support it!\n"));
446 return VERR_PDM_DRIVER_DETACH_NOT_POSSIBLE;
447 }
448
449 /*
450 * Join paths with pdmR3DrvDestroyChain.
451 */
452 pdmR3DrvDestroyChain(pDrvIns);
453 return VINF_SUCCESS;
454}
455
456
457/**
458 * Destroys a driver chain starting with the specified driver.
459 *
460 * This is used when unplugging a device at run time.
461 *
462 * @param pDrvIns Pointer to the driver instance to start with.
463 */
464void pdmR3DrvDestroyChain(PPDMDRVINS pDrvIns)
465{
466 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
467
468 /*
469 * Detach the bottommost driver until we've detached pDrvIns.
470 */
471 pDrvIns->Internal.s.fDetaching = true;
472 PPDMDRVINS pCur;
473 do
474 {
475 /* find the driver to detach. */
476 pCur = pDrvIns;
477 while (pCur->Internal.s.pDown)
478 pCur = pCur->Internal.s.pDown;
479 LogFlow(("pdmR3DrvDetach: pCur=%p '%s'/%d\n", pCur, pCur->pDrvReg->szDriverName, pCur->iInstance));
480
481 /*
482 * Unlink it and notify parent.
483 */
484 pCur->Internal.s.fDetaching = true;
485
486 PPDMLUN pLun = pCur->Internal.s.pLun;
487 Assert(pLun->pBottom == pCur);
488 pLun->pBottom = pCur->Internal.s.pUp;
489
490 if (pCur->Internal.s.pUp)
491 {
492 /* driver parent */
493 PPDMDRVINS pParent = pCur->Internal.s.pUp;
494 pCur->Internal.s.pUp = NULL;
495 pParent->Internal.s.pDown = NULL;
496
497 if (pParent->pDrvReg->pfnDetach)
498 pParent->pDrvReg->pfnDetach(pParent);
499
500 pParent->pDownBase = NULL;
501 }
502 else
503 {
504 /* device parent */
505 Assert(pLun->pTop == pCur);
506 pLun->pTop = NULL;
507 if (pLun->pDevIns->pDevReg->pfnDetach)
508 pLun->pDevIns->pDevReg->pfnDetach(pLun->pDevIns, pLun->iLun);
509 }
510
511 /*
512 * Call destructor.
513 */
514 pCur->pUpBase = NULL;
515 if (pCur->pDrvReg->pfnDestruct)
516 pCur->pDrvReg->pfnDestruct(pCur);
517
518 /*
519 * Free all resources allocated by the driver.
520 */
521 /* Queues. */
522 int rc = PDMR3QueueDestroyDriver(pCur->Internal.s.pVM, pCur);
523 AssertRC(rc);
524 /* Timers. */
525 rc = TMR3TimerDestroyDriver(pCur->Internal.s.pVM, pCur);
526 AssertRC(rc);
527 /* SSM data units. */
528 rc = SSMR3DeregisterDriver(pCur->Internal.s.pVM, pCur, NULL, 0);
529 AssertRC(rc);
530 /* PDM threads. */
531 rc = pdmR3ThreadDestroyDriver(pCur->Internal.s.pVM, pCur);
532 AssertRC(rc);
533 /* Finally, the driver it self. */
534 ASMMemFill32(pCur, RT_OFFSETOF(PDMDRVINS, achInstanceData[pCur->pDrvReg->cbInstance]), 0xdeadd0d0);
535 MMR3HeapFree(pCur);
536
537 } while (pCur != pDrvIns);
538}
539
540
541/** @copydoc PDMDRVHLP::pfnAttach */
542static DECLCALLBACK(int) pdmR3DrvHlp_Attach(PPDMDRVINS pDrvIns, PPDMIBASE *ppBaseInterface)
543{
544 PDMDRV_ASSERT_DRVINS(pDrvIns);
545 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
546 LogFlow(("pdmR3DrvHlp_Attach: caller='%s'/%d:\n",
547 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance));
548
549 /*
550 * Check that there isn't anything attached already.
551 */
552 int rc;
553 if (!pDrvIns->Internal.s.pDown)
554 {
555 Assert(pDrvIns->Internal.s.pLun->pBottom == pDrvIns);
556
557 /*
558 * Get the attached driver configuration.
559 */
560 PCFGMNODE pNode = CFGMR3GetChild(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver");
561 if (pNode)
562 {
563 char *pszName;
564 rc = CFGMR3QueryStringAlloc(pNode, "Driver", &pszName);
565 if (VBOX_SUCCESS(rc))
566 {
567 /*
568 * Find the driver and allocate instance data.
569 */
570 PVM pVM = pDrvIns->Internal.s.pVM;
571 PPDMDRV pDrv = pdmR3DrvLookup(pVM, pszName);
572 if (pDrv)
573 {
574 /* config node */
575 PCFGMNODE pConfigNode = CFGMR3GetChild(pNode, "Config");
576 if (!pConfigNode)
577 rc = CFGMR3InsertNode(pNode, "Config", &pConfigNode);
578 if (VBOX_SUCCESS(rc))
579 {
580 CFGMR3SetRestrictedRoot(pConfigNode);
581
582 size_t cb = RT_OFFSETOF(PDMDRVINS, achInstanceData[pDrv->pDrvReg->cbInstance]);
583 cb = RT_ALIGN_Z(cb, 16);
584 PPDMDRVINS pNew = (PPDMDRVINS)MMR3HeapAllocZ(pVM, MM_TAG_PDM_DRIVER, cb);
585 if (pNew)
586 {
587 /*
588 * Initialize the instance structure (declaration order).
589 */
590 pNew->u32Version = PDM_DRVINS_VERSION;
591 pNew->Internal.s.pUp = pDrvIns;
592 pNew->Internal.s.pDown = NULL;
593 pNew->Internal.s.pLun = pDrvIns->Internal.s.pLun;
594 pNew->Internal.s.pDrv = pDrv;
595 pNew->Internal.s.pVM = pVM;
596 pNew->Internal.s.fDetaching = false;
597 pNew->Internal.s.pCfgHandle = pNode;
598 pNew->pDrvHlp = &g_pdmR3DrvHlp;
599 pNew->pDrvReg = pDrv->pDrvReg;
600 pNew->pCfgHandle = pConfigNode;
601 pNew->iInstance = pDrv->cInstances++;
602 pNew->pUpBase = &pDrvIns->IBase; /* This ain't safe, you can calc the pDrvIns of the up/down driver! */
603 pNew->pDownBase = NULL;
604 pNew->IBase.pfnQueryInterface = NULL;
605 pNew->pvInstanceData = &pNew->achInstanceData[0];
606
607 /*
608 * Hook it onto the chain and call the constructor.
609 */
610 pDrvIns->Internal.s.pDown = pNew;
611 pDrvIns->Internal.s.pLun->pBottom = pNew;
612
613 Log(("PDM: Constructing driver '%s' instance %d...\n", pNew->pDrvReg->szDriverName, pNew->iInstance));
614 rc = pDrv->pDrvReg->pfnConstruct(pNew, pNew->pCfgHandle);
615 if (VBOX_SUCCESS(rc))
616 {
617 *ppBaseInterface = &pNew->IBase;
618 rc = VINF_SUCCESS;
619 }
620 else
621 {
622 /*
623 * Unlink and free the data.
624 */
625 Assert(pDrvIns->Internal.s.pLun->pBottom == pNew);
626 pDrvIns->Internal.s.pLun->pBottom = pDrvIns;
627 pDrvIns->Internal.s.pDown = NULL;
628 ASMMemFill32(pNew, cb, 0xdeadd0d0);
629 MMR3HeapFree(pNew);
630 pDrv->cInstances--;
631 }
632 }
633 else
634 {
635 AssertMsgFailed(("Failed to allocate %d bytes for instantiating driver '%s'\n", cb, pszName));
636 rc = VERR_NO_MEMORY;
637 }
638 }
639 else
640 AssertMsgFailed(("Failed to create Config node! rc=%Vrc\n", rc));
641 }
642 else
643 {
644 AssertMsgFailed(("Driver '%s' wasn't found!\n", pszName));
645 rc = VERR_PDM_DRIVER_NOT_FOUND;
646 }
647 MMR3HeapFree(pszName);
648 }
649 else
650 {
651 AssertMsgFailed(("Query for string value of \"Driver\" -> %Vrc\n", rc));
652 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
653 rc = VERR_PDM_CFG_MISSING_DRIVER_NAME;
654 }
655 }
656 else
657 rc = VERR_PDM_NO_ATTACHED_DRIVER;
658 }
659 else
660 {
661 AssertMsgFailed(("Already got a driver attached. The driver should keep track of such things!\n"));
662 rc = VERR_PDM_DRIVER_ALREADY_ATTACHED;
663 }
664
665 LogFlow(("pdmR3DrvHlp_Attach: caller='%s'/%d: return %Vrc\n",
666 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
667 return rc;
668}
669
670
671/** @copydoc PDMDRVHLP::pfnDetach */
672static DECLCALLBACK(int) pdmR3DrvHlp_Detach(PPDMDRVINS pDrvIns)
673{
674 PDMDRV_ASSERT_DRVINS(pDrvIns);
675 LogFlow(("pdmR3DrvHlp_Detach: caller='%s'/%d:\n",
676 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance));
677 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
678
679 /*
680 * Anything attached?
681 */
682 int rc;
683 if (pDrvIns->Internal.s.pDown)
684 {
685 rc = pdmR3DrvDetach(pDrvIns->Internal.s.pDown);
686 }
687 else
688 {
689 AssertMsgFailed(("Nothing attached!\n"));
690 rc = VERR_PDM_NO_DRIVER_ATTACHED;
691 }
692
693 LogFlow(("pdmR3DrvHlp_Detach: caller='%s'/%d: returns %Vrc\n",
694 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
695 return rc;
696}
697
698
699/** @copydoc PDMDRVHLP::pfnDetachSelf */
700static DECLCALLBACK(int) pdmR3DrvHlp_DetachSelf(PPDMDRVINS pDrvIns)
701{
702 PDMDRV_ASSERT_DRVINS(pDrvIns);
703 LogFlow(("pdmR3DrvHlp_DetachSelf: caller='%s'/%d:\n",
704 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance));
705 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
706
707 int rc = pdmR3DrvDetach(pDrvIns);
708
709 LogFlow(("pdmR3DrvHlp_Detach: returns %Vrc\n", rc)); /* pDrvIns is freed by now. */
710 return rc;
711}
712
713
714/** @copydoc PDMDRVHLP::pfnMountPrepare */
715static DECLCALLBACK(int) pdmR3DrvHlp_MountPrepare(PPDMDRVINS pDrvIns, const char *pszFilename, const char *pszCoreDriver)
716{
717 PDMDRV_ASSERT_DRVINS(pDrvIns);
718 LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: pszFilename=%p:{%s} pszCoreDriver=%p:{%s}\n",
719 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pszFilename, pszFilename, pszCoreDriver, pszCoreDriver));
720 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
721
722 /*
723 * Do the caller have anything attached below itself?
724 */
725 if (pDrvIns->Internal.s.pDown)
726 {
727 AssertMsgFailed(("Cannot prepare a mount when something's attached to you!\n"));
728 return VERR_PDM_DRIVER_ALREADY_ATTACHED;
729 }
730
731 /*
732 * We're asked to prepare, so we'll start off by nuking the
733 * attached configuration tree.
734 */
735 PCFGMNODE pNode = CFGMR3GetChild(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver");
736 if (pNode)
737 CFGMR3RemoveNode(pNode);
738
739 /*
740 * If there is no core driver, we'll have to probe for it.
741 */
742 if (!pszCoreDriver)
743 {
744 /** @todo implement image probing. */
745 AssertReleaseMsgFailed(("Not implemented!\n"));
746 return VERR_NOT_IMPLEMENTED;
747 }
748
749 /*
750 * Construct the basic attached driver configuration.
751 */
752 int rc = CFGMR3InsertNode(pDrvIns->Internal.s.pCfgHandle, "AttachedDriver", &pNode);
753 if (VBOX_SUCCESS(rc))
754 {
755 rc = CFGMR3InsertString(pNode, "Driver", pszCoreDriver);
756 if (VBOX_SUCCESS(rc))
757 {
758 PCFGMNODE pCfg;
759 rc = CFGMR3InsertNode(pNode, "Config", &pCfg);
760 if (VBOX_SUCCESS(rc))
761 {
762 rc = CFGMR3InsertString(pCfg, "Path", pszFilename);
763 if (VBOX_SUCCESS(rc))
764 {
765 LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: returns %Vrc (Driver=%s)\n",
766 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc, pszCoreDriver));
767 return rc;
768 }
769 else
770 AssertMsgFailed(("Path string insert failed, rc=%Vrc\n", rc));
771 }
772 else
773 AssertMsgFailed(("Config node failed, rc=%Vrc\n", rc));
774 }
775 else
776 AssertMsgFailed(("Driver string insert failed, rc=%Vrc\n", rc));
777 CFGMR3RemoveNode(pNode);
778 }
779 else
780 AssertMsgFailed(("AttachedDriver node insert failed, rc=%Vrc\n", rc));
781
782 LogFlow(("pdmR3DrvHlp_MountPrepare: caller='%s'/%d: returns %Vrc\n",
783 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
784 return rc;
785}
786
787
788/** @copydoc PDMDRVHLP::pfnAssertEMT */
789static DECLCALLBACK(bool) pdmR3DrvHlp_AssertEMT(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction)
790{
791 PDMDRV_ASSERT_DRVINS(pDrvIns);
792 if (VM_IS_EMT(pDrvIns->Internal.s.pVM))
793 return true;
794
795 char szMsg[100];
796 RTStrPrintf(szMsg, sizeof(szMsg), "AssertEMT '%s'/%d\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance);
797 AssertMsg1(szMsg, iLine, pszFile, pszFunction);
798 AssertBreakpoint();
799 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
800 return false;
801}
802
803
804/** @copydoc PDMDRVHLP::pfnAssertOther */
805static DECLCALLBACK(bool) pdmR3DrvHlp_AssertOther(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction)
806{
807 PDMDRV_ASSERT_DRVINS(pDrvIns);
808 if (!VM_IS_EMT(pDrvIns->Internal.s.pVM))
809 return true;
810
811 char szMsg[100];
812 RTStrPrintf(szMsg, sizeof(szMsg), "AssertOther '%s'/%d\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance);
813 AssertMsg1(szMsg, iLine, pszFile, pszFunction);
814 AssertBreakpoint();
815 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
816 return false;
817}
818
819
820/** @copydoc PDMDRVHLP::pfnVMSetError */
821static DECLCALLBACK(int) pdmR3DrvHlp_VMSetError(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
822{
823 PDMDRV_ASSERT_DRVINS(pDrvIns);
824 va_list args;
825 va_start(args, pszFormat);
826 int rc2 = VMSetErrorV(pDrvIns->Internal.s.pVM, rc, RT_SRC_POS_ARGS, pszFormat, args); Assert(rc2 == rc); NOREF(rc2);
827 va_end(args);
828 return rc;
829}
830
831
832/** @copydoc PDMDRVHLP::pfnVMSetErrorV */
833static DECLCALLBACK(int) pdmR3DrvHlp_VMSetErrorV(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va)
834{
835 PDMDRV_ASSERT_DRVINS(pDrvIns);
836 int rc2 = VMSetErrorV(pDrvIns->Internal.s.pVM, rc, RT_SRC_POS_ARGS, pszFormat, va); Assert(rc2 == rc); NOREF(rc2);
837 return rc;
838}
839
840
841/** @copydoc PDMDRVHLP::pfnVMSetRuntimeError */
842static DECLCALLBACK(int) pdmR3DrvHlp_VMSetRuntimeError(PPDMDRVINS pDrvIns, bool fFatal, const char *pszErrorID, const char *pszFormat, ...)
843{
844 PDMDRV_ASSERT_DRVINS(pDrvIns);
845 va_list args;
846 va_start(args, pszFormat);
847 int rc = VMSetRuntimeErrorV(pDrvIns->Internal.s.pVM, fFatal, pszErrorID, pszFormat, args);
848 va_end(args);
849 return rc;
850}
851
852
853/** @copydoc PDMDRVHLP::pfnVMSetRuntimeErrorV */
854static DECLCALLBACK(int) pdmR3DrvHlp_VMSetRuntimeErrorV(PPDMDRVINS pDrvIns, bool fFatal, const char *pszErrorID, const char *pszFormat, va_list va)
855{
856 PDMDRV_ASSERT_DRVINS(pDrvIns);
857 int rc = VMSetRuntimeErrorV(pDrvIns->Internal.s.pVM, fFatal, pszErrorID, pszFormat, va);
858 return rc;
859}
860
861
862/** @copydoc PDMDRVHLP::pfnPDMQueueCreate */
863static DECLCALLBACK(int) pdmR3DrvHlp_PDMQueueCreate(PPDMDRVINS pDrvIns, RTUINT cbItem, RTUINT cItems, uint32_t cMilliesInterval, PFNPDMQUEUEDRV pfnCallback, PPDMQUEUE *ppQueue)
864{
865 PDMDRV_ASSERT_DRVINS(pDrvIns);
866 LogFlow(("pdmR3DrvHlp_PDMQueueCreate: caller='%s'/%d: cbItem=%d cItems=%d cMilliesInterval=%d pfnCallback=%p ppQueue=%p\n",
867 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, cbItem, cItems, cMilliesInterval, pfnCallback, ppQueue, ppQueue));
868 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
869
870 int rc = PDMR3QueueCreateDriver(pDrvIns->Internal.s.pVM, pDrvIns, cbItem, cItems, cMilliesInterval, pfnCallback, ppQueue);
871
872 LogFlow(("pdmR3DrvHlp_PDMQueueCreate: caller='%s'/%d: returns %Vrc *ppQueue=%p\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc, *ppQueue));
873 return rc;
874}
875
876
877
878/** @copydoc PDMDRVHLP::pfnPDMPollerRegister */
879static DECLCALLBACK(int) pdmR3DrvHlp_PDMPollerRegister(PPDMDRVINS pDrvIns, PFNPDMDRVPOLLER pfnPoller)
880{
881 PDMDRV_ASSERT_DRVINS(pDrvIns);
882 LogFlow(("pdmR3DrvHlp_PDMPollerRegister: caller='%s'/%d: pfnPoller=%p\n",
883 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pfnPoller));
884 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
885
886 int rc = VINF_SUCCESS;
887 PVM pVM = pDrvIns->Internal.s.pVM;
888 if (pVM->pdm.s.cPollers < ELEMENTS(pVM->pdm.s.apfnPollers))
889 {
890 pVM->pdm.s.apfnPollers[pVM->pdm.s.cPollers] = pfnPoller;
891 pVM->pdm.s.aDrvInsPollers[pVM->pdm.s.cPollers] = pDrvIns;
892 pVM->pdm.s.cPollers++;
893 if (pVM->pdm.s.cPollers == 1)
894 TMTimerSetMillies(pVM->pdm.s.pTimerPollers, 5);
895 }
896 else
897 {
898 AssertMsgFailed(("Too many pollers!\n"));
899 rc = VERR_INTERNAL_ERROR;
900 }
901
902 LogFlow(("pdmR3DrvHlp_PDMPollerRegister: caller='%s'/%d: returns %Vrc\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
903 return rc;
904}
905
906
907/** @copydoc PDMDRVHLP::pfnTMGetVirtualFreq */
908static DECLCALLBACK(uint64_t) pdmR3DrvHlp_TMGetVirtualFreq(PPDMDRVINS pDrvIns)
909{
910 PDMDRV_ASSERT_DRVINS(pDrvIns);
911
912 return TMVirtualGetFreq(pDrvIns->Internal.s.pVM);
913}
914
915
916/** @copydoc PDMDRVHLP::pfnTMGetVirtualTime */
917static DECLCALLBACK(uint64_t) pdmR3DrvHlp_TMGetVirtualTime(PPDMDRVINS pDrvIns)
918{
919 PDMDRV_ASSERT_DRVINS(pDrvIns);
920
921 return TMVirtualGet(pDrvIns->Internal.s.pVM);
922}
923
924/** @copydoc PDMDRVHLP::pfnTMTimerCreate */
925static DECLCALLBACK(int) pdmR3DrvHlp_TMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, const char *pszDesc, PPTMTIMERR3 ppTimer)
926{
927 PDMDRV_ASSERT_DRVINS(pDrvIns);
928 LogFlow(("pdmR3DrvHlp_TMTimerCreate: caller='%s'/%d: enmClock=%d pfnCallback=%p pszDesc=%p:{%s} ppTimer=%p\n",
929 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, enmClock, pfnCallback, pszDesc, pszDesc, ppTimer));
930
931 int rc = TMR3TimerCreateDriver(pDrvIns->Internal.s.pVM, pDrvIns, enmClock, pfnCallback, pszDesc, ppTimer);
932
933 LogFlow(("pdmR3DrvHlp_TMTimerCreate: caller='%s'/%d: returns %Vrc *ppTimer=%p\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc, *ppTimer));
934 return rc;
935}
936
937
938
939/** @copydoc PDMDRVHLP::pfnSSMRegister */
940static DECLCALLBACK(int) pdmR3DrvHlp_SSMRegister(PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance, uint32_t u32Version, size_t cbGuess,
941 PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
942 PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
943{
944 PDMDRV_ASSERT_DRVINS(pDrvIns);
945 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
946 LogFlow(("pdmR3DrvHlp_SSMRegister: caller='%s'/%d: pszName=%p:{%s} u32Instance=%#x u32Version=#x cbGuess=%#x pfnSavePrep=%p pfnSaveExec=%p pfnSaveDone=%p pszLoadPrep=%p pfnLoadExec=%p pfnLoaddone=%p\n",
947 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pszName, pszName, u32Instance, u32Version, cbGuess, pfnSavePrep, pfnSaveExec, pfnSaveDone, pfnLoadPrep, pfnLoadExec, pfnLoadDone));
948
949 int rc = SSMR3RegisterDriver(pDrvIns->Internal.s.pVM, pDrvIns, pszName, u32Instance, u32Version, cbGuess,
950 pfnSavePrep, pfnSaveExec, pfnSaveDone,
951 pfnLoadPrep, pfnLoadExec, pfnLoadDone);
952
953 LogFlow(("pdmR3DrvHlp_SSMRegister: caller='%s'/%d: returns %Vrc\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
954 return rc;
955}
956
957
958/** @copydoc PDMDRVHLP::pfnSSMDeregister */
959static DECLCALLBACK(int) pdmR3DrvHlp_SSMDeregister(PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance)
960{
961 PDMDRV_ASSERT_DRVINS(pDrvIns);
962 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
963 LogFlow(("pdmR3DrvHlp_SSMDeregister: caller='%s'/%d: pszName=%p:{%s} u32Instance=%#x\n",
964 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pszName, pszName, u32Instance));
965
966 int rc = SSMR3DeregisterDriver(pDrvIns->Internal.s.pVM, pDrvIns, pszName, u32Instance);
967
968 LogFlow(("pdmR3DrvHlp_SSMDeregister: caller='%s'/%d: returns %Vrc\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
969 return rc;
970}
971
972
973/** @copydoc PDMDRVHLP::pfnSTAMRegister */
974static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegister(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
975{
976 PDMDRV_ASSERT_DRVINS(pDrvIns);
977 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
978
979 STAM_REG(pDrvIns->Internal.s.pVM, pvSample, enmType, pszName, enmUnit, pszDesc);
980 /** @todo track the samples so they can be dumped & deregistered when the driver instance is destroyed.
981 * For now we just have to be careful not to use this call for drivers which can be unloaded. */
982}
983
984
985/** @copydoc PDMDRVHLP::pfnSTAMRegisterF */
986static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
987 STAMUNIT enmUnit, const char *pszDesc, const char *pszName, ...)
988{
989 PDMDRV_ASSERT_DRVINS(pDrvIns);
990 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
991
992 va_list args;
993 va_start(args, pszName);
994 int rc = STAMR3RegisterV(pDrvIns->Internal.s.pVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
995 va_end(args);
996 AssertRC(rc);
997}
998
999
1000/** @copydoc PDMDRVHLP::pfnSTAMRegisterV */
1001static DECLCALLBACK(void) pdmR3DrvHlp_STAMRegisterV(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1002 STAMUNIT enmUnit, const char *pszDesc, const char *pszName, va_list args)
1003{
1004 PDMDRV_ASSERT_DRVINS(pDrvIns);
1005 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
1006
1007 int rc = STAMR3RegisterV(pDrvIns->Internal.s.pVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
1008 AssertRC(rc);
1009}
1010
1011
1012/** @copydoc PDMDRVHLP::pfnSUPCallVMMR0Ex */
1013static DECLCALLBACK(int) pdmR3DrvHlp_SUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
1014{
1015 PDMDRV_ASSERT_DRVINS(pDrvIns);
1016 LogFlow(("pdmR3DrvHlp_SSMCallVMMR0Ex: caller='%s'/%d: uOperation=%u pvArg=%p cbArg=%d\n",
1017 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, uOperation, pvArg, cbArg));
1018 int rc;
1019 if ( uOperation >= VMMR0_DO_SRV_START
1020 && uOperation < VMMR0_DO_SRV_END)
1021 rc = SUPCallVMMR0Ex(pDrvIns->Internal.s.pVM->pVMR0, uOperation, 0, (PSUPVMMR0REQHDR)pvArg);
1022 else
1023 {
1024 AssertMsgFailed(("Invalid uOperation=%u\n", uOperation));
1025 rc = VERR_INVALID_PARAMETER;
1026 }
1027
1028 LogFlow(("pdmR3DrvHlp_SUPCallVMMR0Ex: caller='%s'/%d: returns %Vrc\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
1029 return rc;
1030}
1031
1032
1033/** @copydoc PDMDRVHLP::pfnUSBRegisterHub */
1034static DECLCALLBACK(int) pdmR3DrvHlp_USBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
1035{
1036 PDMDRV_ASSERT_DRVINS(pDrvIns);
1037 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
1038 LogFlow(("pdmR3DrvHlp_USBRegisterHub: caller='%s'/%d: fVersions=%#x cPorts=%#x pUsbHubReg=%p ppUsbHubHlp=%p\n",
1039 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp));
1040
1041#ifdef VBOX_WITH_USB
1042 int rc = pdmR3UsbRegisterHub(pDrvIns->Internal.s.pVM, pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
1043#else
1044 int rc = VERR_NOT_SUPPORTED;
1045#endif
1046
1047 LogFlow(("pdmR3DrvHlp_USBRegisterHub: caller='%s'/%d: returns %Vrc\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, rc));
1048 return rc;
1049}
1050
1051
1052/** @copydoc PDMDRVHLP::pfnPDMThreadCreate */
1053static DECLCALLBACK(int) pdmR3DrvHlp_PDMThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1054 PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
1055{
1056 PDMDRV_ASSERT_DRVINS(pDrvIns);
1057 VM_ASSERT_EMT(pDrvIns->Internal.s.pVM);
1058 LogFlow(("pdmR3DrvHlp_PDMThreadCreate: caller='%s'/%d: ppThread=%p pvUser=%p pfnThread=%p pfnWakeup=%p cbStack=%#zx enmType=%d pszName=%p:{%s}\n",
1059 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName, pszName));
1060
1061 int rc = pdmR3ThreadCreateDriver(pDrvIns->Internal.s.pVM, pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
1062
1063 LogFlow(("pdmR3DrvHlp_PDMThreadCreate: caller='%s'/%d: returns %Vrc *ppThread=%RTthrd\n", pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance,
1064 rc, *ppThread));
1065 return rc;
1066}
1067
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette