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