VirtualBox

source: vbox/trunk/src/VBox/VMM/PDM.cpp@ 24730

Last change on this file since 24730 was 24730, checked in by vboxsync, 15 years ago

PDM: Implemented making device/driver/usb-device suspend and poweroff notifications asynchronous when needed. Also prepped the way for failing poweron and resume.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 65.7 KB
Line 
1/* $Id: PDM.cpp 24730 2009-11-17 16:51:03Z vboxsync $ */
2/** @file
3 * PDM - Pluggable Device Manager.
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/** @page pg_pdm PDM - The Pluggable Device & Driver Manager
24 *
25 * VirtualBox is designed to be very configurable, i.e. the ability to select
26 * virtual devices and configure them uniquely for a VM. For this reason
27 * virtual devices are not statically linked with the VMM but loaded, linked and
28 * instantiated at runtime by PDM using the information found in the
29 * Configuration Manager (CFGM).
30 *
31 * While the chief purpose of PDM is to manager of devices their drivers, it
32 * also serves as somewhere to put usful things like cross context queues, cross
33 * context synchronization (like critsect), VM centric thread management,
34 * asynchronous I/O framework, and so on.
35 *
36 * @see grp_pdm
37 *
38 *
39 * @section sec_pdm_dev The Pluggable Devices
40 *
41 * Devices register themselves when the module containing them is loaded. PDM
42 * will call the entry point 'VBoxDevicesRegister' when loading a device module.
43 * The device module will then use the supplied callback table to check the VMM
44 * version and to register its devices. Each device have an unique (for the
45 * configured VM) name. The name is not only used in PDM but also in CFGM (to
46 * organize device and device instance settings) and by anyone who wants to talk
47 * to a specific device instance.
48 *
49 * When all device modules have been successfully loaded PDM will instantiate
50 * those devices which are configured for the VM. Note that a device may have
51 * more than one instance, see network adaptors for instance. When
52 * instantiating a device PDM provides device instance memory and a callback
53 * table (aka Device Helpers / DevHlp) with the VM APIs which the device
54 * instance is trusted with.
55 *
56 * Some devices are trusted devices, most are not. The trusted devices are an
57 * integrated part of the VM and can obtain the VM handle from their device
58 * instance handles, thus enabling them to call any VM api. Untrusted devices
59 * can only use the callbacks provided during device instantiation.
60 *
61 * The main purpose in having DevHlps rather than just giving all the devices
62 * the VM handle and let them call the internal VM APIs directly, is both to
63 * create a binary interface that can be supported accross releases and to
64 * create a barrier between devices and the VM. (The trusted / untrusted bit
65 * hasn't turned out to be of much use btw., but it's easy to maintain so there
66 * isn't any point in removing it.)
67 *
68 * A device can provide a ring-0 and/or a raw-mode context extension to improve
69 * the VM performance by handling exits and traps (respectively) without
70 * requiring context switches (to ring-3). Callbacks for MMIO and I/O ports can
71 * needs to be registered specifically for the additional contexts for this to
72 * make sense. Also, the device has to be trusted to be loaded into R0/RC
73 * because of the extra privilege it entails. Note that raw-mode code and data
74 * will be subject to relocation.
75 *
76 *
77 * @section sec_pdm_special_devs Special Devices
78 *
79 * Several kinds of devices interacts with the VMM and/or other device and PDM
80 * will work like a mediator for these. The typical pattern is that the device
81 * calls a special registration device helper with a set of callbacks, PDM
82 * responds by copying this and providing a pointer to a set helper callbacks
83 * for that particular kind of device. Unlike interfaces where the callback
84 * table pointer is used a 'this' pointer, these arrangements will use the
85 * device instance pointer (PPDMDEVINS) as a kind of 'this' pointer.
86 *
87 * For an example of this kind of setup, see the PIC. The PIC registers itself
88 * by calling PDMDEVHLPR3::pfnPICRegister. PDM saves the device instance,
89 * copies the callback tables (PDMPICREG), resolving the ring-0 and raw-mode
90 * addresses in the process, and hands back the pointer to a set of helper
91 * methods (PDMPICHLPR3). The PCI device then queries the ring-0 and raw-mode
92 * helpers using PDMPICHLPR3::pfnGetR0Helpers and PDMPICHLPR3::pfnGetRCHelpers.
93 * The PCI device repeates ths pfnGetRCHelpers call in it's relocation method
94 * since the address changes when RC is relocated.
95 *
96 * @see grp_pdm_device
97 *
98 *
99 * @section sec_pdm_usbdev The Pluggable USB Devices
100 *
101 * USB devices are handled a little bit differently than other devices. The
102 * general concepts wrt. pluggability are mostly the same, but the details
103 * varies. The registration entry point is 'VBoxUsbRegister', the device
104 * instance is PDMUSBINS and the callbacks helpers are different. Also, USB
105 * device are restricted to ring-3 and cannot have any ring-0 or raw-mode
106 * extensions (at least not yet).
107 *
108 * The way USB devices work differs greatly from other devices though since they
109 * aren't attaches directly to the PCI/ISA/whatever system buses but via a
110 * USB host control (OHCI, UHCI or EHCI). USB devices handles USB requests
111 * (URBs) and does not register I/O ports, MMIO ranges or PCI bus
112 * devices/functions.
113 *
114 * @see grp_pdm_usbdev
115 *
116 *
117 * @section sec_pdm_drv The Pluggable Drivers
118 *
119 * The VM devices are often accessing host hardware or OS facilities. For most
120 * devices these facilities can be abstracted in one or more levels. These
121 * abstractions are called drivers.
122 *
123 * For instance take a DVD/CD drive. This can be connected to a SCSI
124 * controller, an ATA controller or a SATA controller. The basics of the DVD/CD
125 * drive implementation remains the same - eject, insert, read, seek, and such.
126 * (For the scsi case, you might wanna speak SCSI directly to, but that can of
127 * course be fixed - see SCSI passthru.) So, it
128 * makes much sense to have a generic CD/DVD driver which implements this.
129 *
130 * Then the media 'inserted' into the DVD/CD drive can be a ISO image, or it can
131 * be read from a real CD or DVD drive (there are probably other custom formats
132 * someone could desire to read or construct too). So, it would make sense to
133 * have abstracted interfaces for dealing with this in a generic way so the
134 * cdrom unit doesn't have to implement it all. Thus we have created the
135 * CDROM/DVD media driver family.
136 *
137 * So, for this example the IDE controller #1 (i.e. secondary) will have
138 * the DVD/CD Driver attached to it's LUN #0 (master). When a media is mounted
139 * the DVD/CD Driver will have a ISO, HostDVD or RAW (media) Driver attached.
140 *
141 * It is possible to configure many levels of drivers inserting filters, loggers,
142 * or whatever you desire into the chain. We're using this for network sniffing
143 * for instance.
144 *
145 * The drivers are loaded in a similar manner to that of the device, namely by
146 * iterating a keyspace in CFGM, load the modules listed there and call
147 * 'VBoxDriversRegister' with a callback table.
148 *
149 * @see grp_pdm_driver
150 *
151 *
152 * @section sec_pdm_ifs Interfaces
153 *
154 * The pluggable drivers and devices exposes one standard interface (callback
155 * table) which is used to construct, destruct, attach, detach,( ++,) and query
156 * other interfaces. A device will query the interfaces required for it's
157 * operation during init and hotplug. PDM may query some interfaces during
158 * runtime mounting too.
159 *
160 * An interface here means a function table contained within the device or
161 * driver instance data. Its method are invoked with the function table pointer
162 * as the first argument and they will calculate the address of the device or
163 * driver instance data from it. (This is one of the aspects which *might* have
164 * been better done in C++.)
165 *
166 * @see grp_pdm_interfaces
167 *
168 *
169 * @section sec_pdm_utils Utilities
170 *
171 * As mentioned earlier, PDM is the location of any usful constrcts that doesn't
172 * quite fit into IPRT. The next subsections will discuss these.
173 *
174 * One thing these APIs all have in common is that resources will be associated
175 * with a device / driver and automatically freed after it has been destroyed if
176 * the destructor didn't do this.
177 *
178 *
179 * @subsection sec_pdm_async_completion Async I/O
180 *
181 * The PDM Async I/O API provides a somewhat platform agnostic interface for
182 * asynchronous I/O. For reasons of performance and complexcity this does not
183 * build upon any IPRT API.
184 *
185 * @todo more details.
186 *
187 * @see grp_pdm_async_completion
188 *
189 *
190 * @subsection sec_pdm_async_task Async Task - not implemented
191 *
192 * @todo implement and describe
193 *
194 * @see grp_pdm_async_task
195 *
196 *
197 * @subsection sec_pdm_critsect Critical Section
198 *
199 * The PDM Critical Section API is currently building on the IPRT API with the
200 * same name. It adds the posibility to use critical sections in ring-0 and
201 * raw-mode as well as in ring-3. There are certain restrictions on the RC and
202 * R0 usage though since we're not able to wait on it, nor wake up anyone that
203 * is waiting on it. These restrictions origins with the use of a ring-3 event
204 * semaphore. In a later incarnation we plan to replace the ring-3 event
205 * semaphore with a ring-0 one, thus enabling us to wake up waiters while
206 * exectuing in ring-0 and making the hardware assisted execution mode more
207 * efficient. (Raw-mode won't benefit much from this, naturally.)
208 *
209 * @see grp_pdm_critsect
210 *
211 *
212 * @subsection sec_pdm_queue Queue
213 *
214 * The PDM Queue API is for queuing one or more tasks for later consumption in
215 * ring-3 by EMT, and optinally forcing a delayed or ASAP return to ring-3. The
216 * queues can also be run on a timer basis as an alternative to the ASAP thing.
217 * The queue will be flushed at forced action time.
218 *
219 * A queue can also be used by another thread (a I/O worker for instance) to
220 * send work / events over to the EMT.
221 *
222 * @see grp_pdm_queue
223 *
224 *
225 * @subsection sec_pdm_task Task - not implemented yet
226 *
227 * The PDM Task API is for flagging a task for execution at a later point when
228 * we're back in ring-3, optionally forcing the ring-3 return to happen ASAP.
229 * As you can see the concept is similar to queues only simpler.
230 *
231 * A task can also be scheduled by another thread (a I/O worker for instance) as
232 * a mean of getting something done in EMT.
233 *
234 * @see grp_pdm_task
235 *
236 *
237 * @subsection sec_pdm_thread Thread
238 *
239 * The PDM Thread API is there to help devices and drivers manage their threads
240 * correctly wrt. power on, suspend, resume, power off and destruction.
241 *
242 * The general usage pattern for threads in the employ of devices and drivers is
243 * that they shuffle data or requests while the VM is running and stop doing
244 * this when the VM is paused or powered down. Rogue threads running while the
245 * VM is paused can cause the state to change during saving or have other
246 * unwanted side effects. The PDM Threads API ensures that this won't happen.
247 *
248 * @see grp_pdm_thread
249 *
250 */
251
252
253/*******************************************************************************
254* Header Files *
255*******************************************************************************/
256#define LOG_GROUP LOG_GROUP_PDM
257#include "PDMInternal.h"
258#include <VBox/pdm.h>
259#include <VBox/mm.h>
260#include <VBox/pgm.h>
261#include <VBox/ssm.h>
262#include <VBox/vm.h>
263#include <VBox/uvm.h>
264#include <VBox/vmm.h>
265#include <VBox/param.h>
266#include <VBox/err.h>
267#include <VBox/sup.h>
268
269#include <VBox/log.h>
270#include <iprt/asm.h>
271#include <iprt/assert.h>
272#include <iprt/alloc.h>
273#include <iprt/ldr.h>
274#include <iprt/path.h>
275#include <iprt/string.h>
276
277
278/*******************************************************************************
279* Defined Constants And Macros *
280*******************************************************************************/
281/** The PDM saved state version. */
282#define PDM_SAVED_STATE_VERSION 4
283#define PDM_SAVED_STATE_VERSION_PRE_NMI_FF 3
284
285
286/*******************************************************************************
287* Internal Functions *
288*******************************************************************************/
289static DECLCALLBACK(int) pdmR3LiveExec(PVM pVM, PSSMHANDLE pSSM, uint32_t uPass);
290static DECLCALLBACK(int) pdmR3SaveExec(PVM pVM, PSSMHANDLE pSSM);
291static DECLCALLBACK(int) pdmR3LoadExec(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
292static DECLCALLBACK(int) pdmR3LoadPrep(PVM pVM, PSSMHANDLE pSSM);
293
294
295
296/**
297 * Initializes the PDM part of the UVM.
298 *
299 * This doesn't really do much right now but has to be here for the sake
300 * of completeness.
301 *
302 * @returns VBox status code.
303 * @param pUVM Pointer to the user mode VM structure.
304 */
305VMMR3DECL(int) PDMR3InitUVM(PUVM pUVM)
306{
307 AssertCompile(sizeof(pUVM->pdm.s) <= sizeof(pUVM->pdm.padding));
308 AssertRelease(sizeof(pUVM->pdm.s) <= sizeof(pUVM->pdm.padding));
309 pUVM->pdm.s.pModules = NULL;
310 return VINF_SUCCESS;
311}
312
313
314/**
315 * Initializes the PDM.
316 *
317 * @returns VBox status code.
318 * @param pVM The VM to operate on.
319 */
320VMMR3DECL(int) PDMR3Init(PVM pVM)
321{
322 LogFlow(("PDMR3Init\n"));
323
324 /*
325 * Assert alignment and sizes.
326 */
327 AssertRelease(!(RT_OFFSETOF(VM, pdm.s) & 31));
328 AssertRelease(sizeof(pVM->pdm.s) <= sizeof(pVM->pdm.padding));
329 AssertCompileMemberAlignment(PDM, CritSect, sizeof(uintptr_t));
330 /*
331 * Init the structure.
332 */
333 pVM->pdm.s.offVM = RT_OFFSETOF(VM, pdm.s);
334 pVM->pdm.s.GCPhysVMMDevHeap = NIL_RTGCPHYS;
335
336 /*
337 * Initialize sub compontents.
338 */
339 int rc = RTCritSectInit(&pVM->pdm.s.MiscCritSect);
340 if (RT_SUCCESS(rc))
341 rc = pdmR3CritSectInit(pVM);
342 if (RT_SUCCESS(rc))
343 rc = PDMR3CritSectInit(pVM, &pVM->pdm.s.CritSect, "PDM");
344 if (RT_SUCCESS(rc))
345 rc = pdmR3LdrInitU(pVM->pUVM);
346#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
347 if (RT_SUCCESS(rc))
348 rc = pdmR3AsyncCompletionInit(pVM);
349#endif
350 if (RT_SUCCESS(rc))
351 rc = pdmR3DrvInit(pVM);
352 if (RT_SUCCESS(rc))
353 rc = pdmR3DevInit(pVM);
354 if (RT_SUCCESS(rc))
355 {
356 /*
357 * Register the saved state data unit.
358 */
359 rc = SSMR3RegisterInternal(pVM, "pdm", 1, PDM_SAVED_STATE_VERSION, 128,
360 NULL, pdmR3LiveExec, NULL,
361 NULL, pdmR3SaveExec, NULL,
362 pdmR3LoadPrep, pdmR3LoadExec, NULL);
363 if (RT_SUCCESS(rc))
364 {
365 LogFlow(("PDM: Successfully initialized\n"));
366 return rc;
367 }
368 }
369
370 /*
371 * Cleanup and return failure.
372 */
373 PDMR3Term(pVM);
374 LogFlow(("PDMR3Init: returns %Rrc\n", rc));
375 return rc;
376}
377
378
379/**
380 * Applies relocations to data and code managed by this
381 * component. This function will be called at init and
382 * whenever the VMM need to relocate it self inside the GC.
383 *
384 * @param pVM VM handle.
385 * @param offDelta Relocation delta relative to old location.
386 * @remark The loader subcomponent is relocated by PDMR3LdrRelocate() very
387 * early in the relocation phase.
388 */
389VMMR3DECL(void) PDMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
390{
391 LogFlow(("PDMR3Relocate\n"));
392
393 /*
394 * Queues.
395 */
396 pdmR3QueueRelocate(pVM, offDelta);
397 pVM->pdm.s.pDevHlpQueueRC = PDMQueueRCPtr(pVM->pdm.s.pDevHlpQueueR3);
398
399 /*
400 * Critical sections.
401 */
402 pdmR3CritSectRelocate(pVM);
403
404 /*
405 * The registered PIC.
406 */
407 if (pVM->pdm.s.Pic.pDevInsRC)
408 {
409 pVM->pdm.s.Pic.pDevInsRC += offDelta;
410 pVM->pdm.s.Pic.pfnSetIrqRC += offDelta;
411 pVM->pdm.s.Pic.pfnGetInterruptRC += offDelta;
412 }
413
414 /*
415 * The registered APIC.
416 */
417 if (pVM->pdm.s.Apic.pDevInsRC)
418 {
419 pVM->pdm.s.Apic.pDevInsRC += offDelta;
420 pVM->pdm.s.Apic.pfnGetInterruptRC += offDelta;
421 pVM->pdm.s.Apic.pfnSetBaseRC += offDelta;
422 pVM->pdm.s.Apic.pfnGetBaseRC += offDelta;
423 pVM->pdm.s.Apic.pfnSetTPRRC += offDelta;
424 pVM->pdm.s.Apic.pfnGetTPRRC += offDelta;
425 pVM->pdm.s.Apic.pfnBusDeliverRC += offDelta;
426 if (pVM->pdm.s.Apic.pfnLocalInterruptRC)
427 pVM->pdm.s.Apic.pfnLocalInterruptRC += offDelta;
428 pVM->pdm.s.Apic.pfnWriteMSRRC += offDelta;
429 pVM->pdm.s.Apic.pfnReadMSRRC += offDelta;
430 }
431
432 /*
433 * The registered I/O APIC.
434 */
435 if (pVM->pdm.s.IoApic.pDevInsRC)
436 {
437 pVM->pdm.s.IoApic.pDevInsRC += offDelta;
438 pVM->pdm.s.IoApic.pfnSetIrqRC += offDelta;
439 }
440
441 /*
442 * The register PCI Buses.
443 */
444 for (unsigned i = 0; i < RT_ELEMENTS(pVM->pdm.s.aPciBuses); i++)
445 {
446 if (pVM->pdm.s.aPciBuses[i].pDevInsRC)
447 {
448 pVM->pdm.s.aPciBuses[i].pDevInsRC += offDelta;
449 pVM->pdm.s.aPciBuses[i].pfnSetIrqRC += offDelta;
450 }
451 }
452
453 /*
454 * Devices.
455 */
456 PCPDMDEVHLPRC pDevHlpRC;
457 int rc = PDMR3LdrGetSymbolRC(pVM, NULL, "g_pdmRCDevHlp", &pDevHlpRC);
458 AssertReleaseMsgRC(rc, ("rc=%Rrc when resolving g_pdmRCDevHlp\n", rc));
459 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
460 {
461 if (pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_RC)
462 {
463 pDevIns->pDevHlpRC = pDevHlpRC;
464 pDevIns->pvInstanceDataRC = MMHyperR3ToRC(pVM, pDevIns->pvInstanceDataR3);
465 pDevIns->Internal.s.pVMRC = pVM->pVMRC;
466 if (pDevIns->Internal.s.pPciBusR3)
467 pDevIns->Internal.s.pPciBusRC = MMHyperR3ToRC(pVM, pDevIns->Internal.s.pPciBusR3);
468 if (pDevIns->Internal.s.pPciDeviceR3)
469 pDevIns->Internal.s.pPciDeviceRC = MMHyperR3ToRC(pVM, pDevIns->Internal.s.pPciDeviceR3);
470 if (pDevIns->pDevReg->pfnRelocate)
471 {
472 LogFlow(("PDMR3Relocate: Relocating device '%s'/%d\n",
473 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
474 pDevIns->pDevReg->pfnRelocate(pDevIns, offDelta);
475 }
476 }
477 }
478}
479
480
481/**
482 * Worker for pdmR3Term that terminates a LUN chain.
483 *
484 * @param pVM Pointer to the shared VM structure.
485 * @param pLun The head of the chain.
486 * @param pszDevice The name of the device (for logging).
487 * @param iInstance The device instance number (for logging).
488 */
489static void pdmR3TermLuns(PVM pVM, PPDMLUN pLun, const char *pszDevice, unsigned iInstance)
490{
491 for (; pLun; pLun = pLun->pNext)
492 {
493 /*
494 * Destroy them one at a time from the bottom up.
495 * (The serial device/drivers depends on this - bad.)
496 */
497 PPDMDRVINS pDrvIns = pLun->pBottom;
498 pLun->pBottom = pLun->pTop = NULL;
499 while (pDrvIns)
500 {
501 PPDMDRVINS pDrvNext = pDrvIns->Internal.s.pUp;
502
503 if (pDrvIns->pDrvReg->pfnDestruct)
504 {
505 LogFlow(("pdmR3DevTerm: Destroying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
506 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pszDevice, iInstance));
507 pDrvIns->pDrvReg->pfnDestruct(pDrvIns);
508 }
509
510 TMR3TimerDestroyDriver(pVM, pDrvIns);
511 //PDMR3QueueDestroyDriver(pVM, pDrvIns);
512 //pdmR3ThreadDestroyDriver(pVM, pDrvIns);
513 SSMR3DeregisterDriver(pVM, pDrvIns, NULL, 0);
514
515 pDrvIns = pDrvNext;
516 }
517 }
518}
519
520
521/**
522 * Terminates the PDM.
523 *
524 * Termination means cleaning up and freeing all resources,
525 * the VM it self is at this point powered off or suspended.
526 *
527 * @returns VBox status code.
528 * @param pVM The VM to operate on.
529 */
530VMMR3DECL(int) PDMR3Term(PVM pVM)
531{
532 LogFlow(("PDMR3Term:\n"));
533 AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
534
535 /*
536 * Iterate the device instances and attach drivers, doing
537 * relevant destruction processing.
538 *
539 * N.B. There is no need to mess around freeing memory allocated
540 * from any MM heap since MM will do that in its Term function.
541 */
542 /* usb ones first. */
543 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
544 {
545 pdmR3TermLuns(pVM, pUsbIns->Internal.s.pLuns, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance);
546
547 if (pUsbIns->pUsbReg->pfnDestruct)
548 {
549 LogFlow(("pdmR3DevTerm: Destroying - device '%s'/%d\n",
550 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
551 pUsbIns->pUsbReg->pfnDestruct(pUsbIns);
552 }
553
554 //TMR3TimerDestroyUsb(pVM, pUsbIns);
555 //SSMR3DeregisterUsb(pVM, pUsbIns, NULL, 0);
556 pdmR3ThreadDestroyUsb(pVM, pUsbIns);
557 }
558
559 /* then the 'normal' ones. */
560 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
561 {
562 pdmR3TermLuns(pVM, pDevIns->Internal.s.pLunsR3, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance);
563
564 if (pDevIns->pDevReg->pfnDestruct)
565 {
566 LogFlow(("pdmR3DevTerm: Destroying - device '%s'/%d\n",
567 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
568 pDevIns->pDevReg->pfnDestruct(pDevIns);
569 }
570
571 TMR3TimerDestroyDevice(pVM, pDevIns);
572 //SSMR3DeregisterDriver(pVM, pDevIns, NULL, 0);
573 pdmR3CritSectDeleteDevice(pVM, pDevIns);
574 //pdmR3ThreadDestroyDevice(pVM, pDevIns);
575 //PDMR3QueueDestroyDevice(pVM, pDevIns);
576 PGMR3PhysMMIO2Deregister(pVM, pDevIns, UINT32_MAX);
577 }
578
579 /*
580 * Destroy all threads.
581 */
582 pdmR3ThreadDestroyAll(pVM);
583
584#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
585 /*
586 * Free async completion managers.
587 */
588 pdmR3AsyncCompletionTerm(pVM);
589#endif
590
591 /*
592 * Free modules.
593 */
594 pdmR3LdrTermU(pVM->pUVM);
595
596 /*
597 * Destroy the PDM lock.
598 */
599 PDMR3CritSectDelete(&pVM->pdm.s.CritSect);
600 /* The MiscCritSect is deleted by PDMR3CritSectTerm. */
601
602 LogFlow(("PDMR3Term: returns %Rrc\n", VINF_SUCCESS));
603 return VINF_SUCCESS;
604}
605
606
607/**
608 * Terminates the PDM part of the UVM.
609 *
610 * This will unload any modules left behind.
611 *
612 * @param pUVM Pointer to the user mode VM structure.
613 */
614VMMR3DECL(void) PDMR3TermUVM(PUVM pUVM)
615{
616 /*
617 * In the normal cause of events we will now call pdmR3LdrTermU for
618 * the second time. In the case of init failure however, this might
619 * the first time, which is why we do it.
620 */
621 pdmR3LdrTermU(pUVM);
622}
623
624
625/**
626 * Bits that are saved in pass 0 and in the final pass.
627 *
628 * @param pVM The VM handle.
629 * @param pSSM The saved state handle.
630 */
631static void pdmR3SaveBoth(PVM pVM, PSSMHANDLE pSSM)
632{
633 /*
634 * Save the list of device instances so we can check that they're all still
635 * there when we load the state and that nothing new has been added.
636 */
637 uint32_t i = 0;
638 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3, i++)
639 {
640 SSMR3PutU32(pSSM, i);
641 SSMR3PutStrZ(pSSM, pDevIns->pDevReg->szDeviceName);
642 SSMR3PutU32(pSSM, pDevIns->iInstance);
643 }
644 SSMR3PutU32(pSSM, UINT32_MAX); /* terminator */
645}
646
647
648/**
649 * Live save.
650 *
651 * @returns VBox status code.
652 * @param pVM The VM handle.
653 * @param pSSM The saved state handle.
654 * @param uPass The pass.
655 */
656static DECLCALLBACK(int) pdmR3LiveExec(PVM pVM, PSSMHANDLE pSSM, uint32_t uPass)
657{
658 LogFlow(("pdmR3LiveExec:\n"));
659 AssertReturn(uPass == 0, VERR_INTERNAL_ERROR_4);
660 pdmR3SaveBoth(pVM, pSSM);
661 return VINF_SSM_DONT_CALL_AGAIN;
662}
663
664
665/**
666 * Execute state save operation.
667 *
668 * @returns VBox status code.
669 * @param pVM The VM handle.
670 * @param pSSM The saved state handle.
671 */
672static DECLCALLBACK(int) pdmR3SaveExec(PVM pVM, PSSMHANDLE pSSM)
673{
674 LogFlow(("pdmR3SaveExec:\n"));
675
676 /*
677 * Save interrupt and DMA states.
678 */
679 for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
680 {
681 PVMCPU pVCpu = &pVM->aCpus[idCpu];
682 SSMR3PutUInt(pSSM, VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_APIC));
683 SSMR3PutUInt(pSSM, VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_PIC));
684 SSMR3PutUInt(pSSM, VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_NMI));
685 SSMR3PutUInt(pSSM, VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_SMI));
686 }
687 SSMR3PutUInt(pSSM, VM_FF_ISSET(pVM, VM_FF_PDM_DMA));
688
689 pdmR3SaveBoth(pVM, pSSM);
690 return VINF_SUCCESS;
691}
692
693
694/**
695 * Prepare state load operation.
696 *
697 * This will dispatch pending operations and clear the FFs governed by PDM and its devices.
698 *
699 * @returns VBox status code.
700 * @param pVM The VM handle.
701 * @param pSSM The SSM handle.
702 */
703static DECLCALLBACK(int) pdmR3LoadPrep(PVM pVM, PSSMHANDLE pSSM)
704{
705 LogFlow(("pdmR3LoadPrep: %s%s\n",
706 VM_FF_ISSET(pVM, VM_FF_PDM_QUEUES) ? " VM_FF_PDM_QUEUES" : "",
707 VM_FF_ISSET(pVM, VM_FF_PDM_DMA) ? " VM_FF_PDM_DMA" : ""));
708#ifdef LOG_ENABLED
709 for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
710 {
711 PVMCPU pVCpu = &pVM->aCpus[idCpu];
712 LogFlow(("pdmR3LoadPrep: VCPU %u %s%s\n", idCpu,
713 VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_APIC) ? " VMCPU_FF_INTERRUPT_APIC" : "",
714 VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_PIC) ? " VMCPU_FF_INTERRUPT_PIC" : ""));
715 }
716#endif
717
718 /*
719 * In case there is work pending that will raise an interrupt,
720 * start a DMA transfer, or release a lock. (unlikely)
721 */
722 if (VM_FF_ISSET(pVM, VM_FF_PDM_QUEUES))
723 PDMR3QueueFlushAll(pVM);
724
725 /* Clear the FFs. */
726 for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
727 {
728 PVMCPU pVCpu = &pVM->aCpus[idCpu];
729 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_APIC);
730 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_PIC);
731 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_NMI);
732 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_SMI);
733 }
734 VM_FF_CLEAR(pVM, VM_FF_PDM_DMA);
735
736 return VINF_SUCCESS;
737}
738
739
740/**
741 * Execute state load operation.
742 *
743 * @returns VBox status code.
744 * @param pVM VM Handle.
745 * @param pSSM SSM operation handle.
746 * @param uVersion Data layout version.
747 * @param uPass The data pass.
748 */
749static DECLCALLBACK(int) pdmR3LoadExec(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
750{
751 int rc;
752
753 LogFlow(("pdmR3LoadExec: uPass=%#x\n", uPass));
754
755 /*
756 * Validate version.
757 */
758 if ( uVersion != PDM_SAVED_STATE_VERSION
759 && uVersion != PDM_SAVED_STATE_VERSION_PRE_NMI_FF)
760 {
761 AssertMsgFailed(("Invalid version uVersion=%d!\n", uVersion));
762 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
763 }
764
765 if (uPass == SSM_PASS_FINAL)
766 {
767 /*
768 * Load the interrupt and DMA states.
769 */
770 for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
771 {
772 PVMCPU pVCpu = &pVM->aCpus[idCpu];
773
774 /* APIC interrupt */
775 RTUINT fInterruptPending = 0;
776 rc = SSMR3GetUInt(pSSM, &fInterruptPending);
777 if (RT_FAILURE(rc))
778 return rc;
779 if (fInterruptPending & ~1)
780 {
781 AssertMsgFailed(("fInterruptPending=%#x (APIC)\n", fInterruptPending));
782 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
783 }
784 AssertRelease(!VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_APIC));
785 if (fInterruptPending)
786 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_APIC);
787
788 /* PIC interrupt */
789 fInterruptPending = 0;
790 rc = SSMR3GetUInt(pSSM, &fInterruptPending);
791 if (RT_FAILURE(rc))
792 return rc;
793 if (fInterruptPending & ~1)
794 {
795 AssertMsgFailed(("fInterruptPending=%#x (PIC)\n", fInterruptPending));
796 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
797 }
798 AssertRelease(!VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_PIC));
799 if (fInterruptPending)
800 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_PIC);
801
802 if (uVersion > PDM_SAVED_STATE_VERSION_PRE_NMI_FF)
803 {
804 /* NMI interrupt */
805 RTUINT fInterruptPending = 0;
806 rc = SSMR3GetUInt(pSSM, &fInterruptPending);
807 if (RT_FAILURE(rc))
808 return rc;
809 if (fInterruptPending & ~1)
810 {
811 AssertMsgFailed(("fInterruptPending=%#x (NMI)\n", fInterruptPending));
812 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
813 }
814 AssertRelease(!VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_NMI));
815 if (fInterruptPending)
816 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_NMI);
817
818 /* SMI interrupt */
819 fInterruptPending = 0;
820 rc = SSMR3GetUInt(pSSM, &fInterruptPending);
821 if (RT_FAILURE(rc))
822 return rc;
823 if (fInterruptPending & ~1)
824 {
825 AssertMsgFailed(("fInterruptPending=%#x (SMI)\n", fInterruptPending));
826 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
827 }
828 AssertRelease(!VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_SMI));
829 if (fInterruptPending)
830 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_SMI);
831 }
832 }
833
834 /* DMA pending */
835 RTUINT fDMAPending = 0;
836 rc = SSMR3GetUInt(pSSM, &fDMAPending);
837 if (RT_FAILURE(rc))
838 return rc;
839 if (fDMAPending & ~1)
840 {
841 AssertMsgFailed(("fDMAPending=%#x\n", fDMAPending));
842 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
843 }
844 if (fDMAPending)
845 VM_FF_SET(pVM, VM_FF_PDM_DMA);
846 Log(("pdmR3LoadExec: VM_FF_PDM_DMA=%RTbool\n", VM_FF_ISSET(pVM, VM_FF_PDM_DMA)));
847 }
848
849 /*
850 * Load the list of devices and verify that they are all there.
851 */
852 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
853 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_FOUND;
854
855 for (uint32_t i = 0; ; i++)
856 {
857 /* Get the sequence number / terminator. */
858 uint32_t u32Sep;
859 int rc = SSMR3GetU32(pSSM, &u32Sep);
860 if (RT_FAILURE(rc))
861 return rc;
862 if (u32Sep == UINT32_MAX)
863 break;
864 if (u32Sep != i)
865 AssertMsgFailedReturn(("Out of seqence. u32Sep=%#x i=%#x\n", u32Sep, i), VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
866
867 /* Get the name and instance number. */
868 char szDeviceName[RT_SIZEOFMEMB(PDMDEVREG, szDeviceName)];
869 rc = SSMR3GetStrZ(pSSM, szDeviceName, sizeof(szDeviceName));
870 if (RT_FAILURE(rc))
871 return rc;
872 RTUINT iInstance;
873 rc = SSMR3GetUInt(pSSM, &iInstance);
874 if (RT_FAILURE(rc))
875 return rc;
876
877 /* Try locate it. */
878 PPDMDEVINS pDevIns;
879 for (pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
880 if ( !strcmp(szDeviceName, pDevIns->pDevReg->szDeviceName)
881 && pDevIns->iInstance == iInstance)
882 {
883 AssertLogRelMsgReturn(!(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_FOUND),
884 ("%s/#%u\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance),
885 VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
886 pDevIns->Internal.s.fIntFlags |= PDMDEVINSINT_FLAGS_FOUND;
887 break;
888 }
889 if (!pDevIns)
890 {
891 LogRel(("Device '%s'/%d not found in current config\n", szDeviceName, iInstance));
892 if (SSMR3HandleGetAfter(pSSM) != SSMAFTER_DEBUG_IT)
893 return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Device '%s'/%d not found in current config"), szDeviceName, iInstance);
894 }
895 }
896
897 /*
898 * Check that no additional devices were configured.
899 */
900 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
901 if (!(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_FOUND))
902 {
903 LogRel(("Device '%s'/%d not found in the saved state\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
904 if (SSMR3HandleGetAfter(pSSM) != SSMAFTER_DEBUG_IT)
905 return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Device '%s'/%d not found in the saved state"),
906 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance);
907 }
908
909 return VINF_SUCCESS;
910}
911
912
913/**
914 * Worker for PDMR3PowerOn that deals with one driver.
915 *
916 * @param pDrvIns The driver instance.
917 * @param pszDeviceName The parent device name.
918 * @param iDevInstance The parent device instance number.
919 * @param iLun The parent LUN number.
920 */
921DECLINLINE(bool) pdmR3PowerOnDrv(PPDMDRVINS pDrvIns, const char *pszDeviceName, uint32_t iDevInstance, uint32_t iLun)
922{
923 Assert(pDrvIns->Internal.s.fVMSuspended);
924 if (pDrvIns->pDrvReg->pfnPowerOn)
925 {
926 LogFlow(("PDMR3PowerOn: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
927 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, iLun, pszDeviceName, iDevInstance));
928 int rc = VINF_SUCCESS; pDrvIns->pDrvReg->pfnPowerOn(pDrvIns);
929 if (RT_FAILURE(rc))
930 {
931 LogRel(("PDMR3PowerOn: driver '%s'/%d on LUN#%d of device '%s'/%d -> %Rrc\n",
932 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, iLun, pszDeviceName, iDevInstance, rc));
933 return rc;
934 }
935 }
936 pDrvIns->Internal.s.fVMSuspended = false;
937 return VINF_SUCCESS;
938}
939
940
941/**
942 * Worker for PDMR3PowerOn that deals with one USB device instance.
943 *
944 * @returns VBox status code.
945 * @param pUsbIns The USB device instance.
946 */
947DECLINLINE(int) pdmR3PowerOnUsb(PPDMUSBINS pUsbIns)
948{
949 Assert(pUsbIns->Internal.s.fVMSuspended);
950 if (pUsbIns->pUsbReg->pfnVMPowerOn)
951 {
952 LogFlow(("PDMR3PowerOn: Notifying - device '%s'/%d\n", pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
953 int rc = VINF_SUCCESS; pUsbIns->pUsbReg->pfnVMPowerOn(pUsbIns);
954 if (RT_FAILURE(rc))
955 {
956 LogRel(("PDMR3PowerOn: device '%s'/%d -> %Rrc\n", pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance, rc));
957 return rc;
958 }
959 }
960 pUsbIns->Internal.s.fVMSuspended = false;
961 return VINF_SUCCESS;
962}
963
964
965/**
966 * Worker for PDMR3PowerOn that deals with one device instance.
967 *
968 * @returns VBox status code.
969 * @param pDevIns The device instance.
970 */
971DECLINLINE(int) pdmR3PowerOnDev(PPDMDEVINS pDevIns)
972{
973 Assert(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_SUSPENDED);
974 if (pDevIns->pDevReg->pfnPowerOn)
975 {
976 LogFlow(("PDMR3PowerOn: Notifying - device '%s'/%d\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
977 int rc = VINF_SUCCESS; pDevIns->pDevReg->pfnPowerOn(pDevIns);
978 if (RT_FAILURE(rc))
979 {
980 LogRel(("PDMR3PowerOn: device '%s'/%d -> %Rrc\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance, rc));
981 return rc;
982 }
983 }
984 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
985 return VINF_SUCCESS;
986}
987
988
989/**
990 * This function will notify all the devices and their
991 * attached drivers about the VM now being powered on.
992 *
993 * @param pVM VM Handle.
994 */
995VMMR3DECL(void) PDMR3PowerOn(PVM pVM)
996{
997 LogFlow(("PDMR3PowerOn:\n"));
998
999 /*
1000 * Iterate thru the device instances and USB device instances,
1001 * processing the drivers associated with those.
1002 */
1003 int rc = VINF_SUCCESS;
1004 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns && RT_SUCCESS(rc); pDevIns = pDevIns->Internal.s.pNextR3)
1005 {
1006 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun && RT_SUCCESS(rc); pLun = pLun->pNext)
1007 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns && RT_SUCCESS(rc); pDrvIns = pDrvIns->Internal.s.pDown)
1008 rc = pdmR3PowerOnDrv(pDrvIns, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance, pLun->iLun);
1009 if (RT_SUCCESS(rc))
1010 rc = pdmR3PowerOnDev(pDevIns);
1011 }
1012
1013#ifdef VBOX_WITH_USB
1014 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns && RT_SUCCESS(rc); pUsbIns = pUsbIns->Internal.s.pNext)
1015 {
1016 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun && RT_SUCCESS(rc); pLun = pLun->pNext)
1017 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns && RT_SUCCESS(rc); pDrvIns = pDrvIns->Internal.s.pDown)
1018 rc = pdmR3PowerOnDrv(pDrvIns, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance, pLun->iLun);
1019 if (RT_SUCCESS(rc))
1020 rc = pdmR3PowerOnUsb(pUsbIns);
1021 }
1022#endif
1023
1024 /*
1025 * Resume all threads.
1026 */
1027 if (RT_SUCCESS(rc))
1028 pdmR3ThreadResumeAll(pVM);
1029
1030 /*
1031 * On failure, clean up via PDMR3Suspend.
1032 */
1033 if (RT_FAILURE(rc))
1034 PDMR3Suspend(pVM);
1035
1036 LogFlow(("PDMR3PowerOn: returns %Rrc\n", rc));
1037 return /*rc*/;
1038}
1039
1040
1041
1042
1043/**
1044 * This function will notify all the devices and their
1045 * attached drivers about the VM now being reset.
1046 *
1047 * @param pVM VM Handle.
1048 */
1049VMMR3DECL(void) PDMR3Reset(PVM pVM)
1050{
1051 LogFlow(("PDMR3Reset:\n"));
1052
1053 /*
1054 * Clear all pending interrupts and DMA operations.
1055 */
1056 for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
1057 {
1058 PVMCPU pVCpu = &pVM->aCpus[idCpu];
1059 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_APIC);
1060 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_PIC);
1061 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_NMI);
1062 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_SMI);
1063 }
1064 VM_FF_CLEAR(pVM, VM_FF_PDM_DMA);
1065
1066 /*
1067 * Iterate the device instances.
1068 * The attached drivers are processed first.
1069 */
1070 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1071 {
1072 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1073 /** @todo Inverse the order here? */
1074 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1075 if (pDrvIns->pDrvReg->pfnReset)
1076 {
1077 LogFlow(("PDMR3Reset: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1078 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1079 pDrvIns->pDrvReg->pfnReset(pDrvIns);
1080 }
1081
1082 if (pDevIns->pDevReg->pfnReset)
1083 {
1084 LogFlow(("PDMR3Reset: Notifying - device '%s'/%d\n",
1085 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1086 pDevIns->pDevReg->pfnReset(pDevIns);
1087 }
1088 }
1089
1090#ifdef VBOX_WITH_USB
1091 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1092 {
1093 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1094 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1095 if (pDrvIns->pDrvReg->pfnReset)
1096 {
1097 LogFlow(("PDMR3Reset: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
1098 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1099 pDrvIns->pDrvReg->pfnReset(pDrvIns);
1100 }
1101
1102 if (pUsbIns->pUsbReg->pfnVMReset)
1103 {
1104 LogFlow(("PDMR3Reset: Notifying - device '%s'/%d\n",
1105 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1106 pUsbIns->pUsbReg->pfnVMReset(pUsbIns);
1107 }
1108 }
1109#endif
1110
1111 LogFlow(("PDMR3Reset: returns void\n"));
1112}
1113
1114
1115/**
1116 * Worker for PDMR3Suspend that deals with one driver.
1117 *
1118 * @param pDrvIns The driver instance.
1119 * @param pcAsync The asynchronous suspend notification counter.
1120 * @param pszDeviceName The parent device name.
1121 * @param iDevInstance The parent device instance number.
1122 * @param iLun The parent LUN number.
1123 */
1124DECLINLINE(bool) pdmR3SuspendDrv(PPDMDRVINS pDrvIns, unsigned *pcAsync,
1125 const char *pszDeviceName, uint32_t iDevInstance, uint32_t iLun)
1126{
1127 if (!pDrvIns->Internal.s.fVMSuspended)
1128 {
1129 pDrvIns->Internal.s.fVMSuspended = true;
1130 if (pDrvIns->pDrvReg->pfnSuspend)
1131 {
1132 if (!pDrvIns->Internal.s.pfnAsyncNotify)
1133 {
1134 LogFlow(("PDMR3Suspend: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1135 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, iLun, pszDeviceName, iDevInstance));
1136 pDrvIns->pDrvReg->pfnSuspend(pDrvIns);
1137 }
1138 else if (pDrvIns->Internal.s.pfnAsyncNotify(pDrvIns))
1139 {
1140 pDrvIns->Internal.s.pfnAsyncNotify = false;
1141 LogFlow(("PDMR3Suspend: Async notification completed - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1142 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, iLun, pszDeviceName, iDevInstance));
1143 }
1144 if (pDrvIns->Internal.s.pfnAsyncNotify)
1145 {
1146 pDrvIns->Internal.s.fVMSuspended = false;
1147 (*pcAsync)++;
1148 return false;
1149 }
1150 }
1151 }
1152 return true;
1153}
1154
1155
1156/**
1157 * Worker for PDMR3Suspend that deals with one USB device instance.
1158 *
1159 * @param pUsbIns The USB device instance.
1160 * @param pcAsync The asynchronous suspend notification counter.
1161 */
1162DECLINLINE(void) pdmR3SuspendUsb(PPDMUSBINS pUsbIns, unsigned *pcAsync)
1163{
1164 if (!pUsbIns->Internal.s.fVMSuspended)
1165 {
1166 pUsbIns->Internal.s.fVMSuspended = true;
1167 if (pUsbIns->pUsbReg->pfnVMSuspend)
1168 {
1169 if (!pUsbIns->Internal.s.pfnAsyncNotify)
1170 {
1171 LogFlow(("PDMR3Suspend: Notifying - device '%s'/%d\n", pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1172 pUsbIns->pUsbReg->pfnVMSuspend(pUsbIns);
1173 }
1174 else if (pUsbIns->Internal.s.pfnAsyncNotify(pUsbIns))
1175 {
1176 LogFlow(("PDMR3Suspend: Async notification completed - device '%s'/%d\n", pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1177 pUsbIns->Internal.s.pfnAsyncNotify = NULL;
1178 }
1179 if (pUsbIns->Internal.s.pfnAsyncNotify)
1180 {
1181 pUsbIns->Internal.s.fVMSuspended = false;
1182 (*pcAsync)++;
1183 }
1184 }
1185 }
1186}
1187
1188
1189/**
1190 * Worker for PDMR3Suspend that deals with one device instance.
1191 *
1192 * @param pDevIns The device instance.
1193 * @param pcAsync The asynchronous suspend notification counter.
1194 */
1195DECLINLINE(void) pdmR3SuspendDev(PPDMDEVINS pDevIns, unsigned *pcAsync)
1196{
1197 if (!(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_SUSPENDED))
1198 {
1199 pDevIns->Internal.s.fIntFlags |= PDMDEVINSINT_FLAGS_SUSPENDED;
1200 if (pDevIns->pDevReg->pfnSuspend)
1201 {
1202 if (!pDevIns->Internal.s.pfnAsyncNotify)
1203 {
1204 LogFlow(("PDMR3Suspend: Notifying - device '%s'/%d\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1205 pDevIns->pDevReg->pfnSuspend(pDevIns);
1206 }
1207 else if (pDevIns->Internal.s.pfnAsyncNotify(pDevIns))
1208 {
1209 LogFlow(("PDMR3Suspend: Async notification completed - device '%s'/%d\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1210 pDevIns->Internal.s.pfnAsyncNotify = NULL;
1211 }
1212 if (pDevIns->Internal.s.pfnAsyncNotify)
1213 {
1214 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
1215 (*pcAsync)++;
1216 }
1217 }
1218 }
1219}
1220
1221
1222/**
1223 * This function will notify all the devices and their attached drivers about
1224 * the VM now being suspended.
1225 *
1226 * @param pVM The VM Handle.
1227 * @thread EMT(0)
1228 */
1229VMMR3DECL(void) PDMR3Suspend(PVM pVM)
1230{
1231 LogFlow(("PDMR3Suspend:\n"));
1232 VM_ASSERT_EMT0(pVM);
1233
1234 /*
1235 * The outer loop repeats until there are no more async requests.
1236 *
1237 * Note! We depend on the suspended indicators to be in the desired state
1238 * and we do not reset them before starting because this allows
1239 * PDMR3PowerOn and PDMR3Resume to use PDMR3Suspend for cleaning up
1240 * on failure.
1241 */
1242 unsigned cAsync;
1243 for (;;)
1244 {
1245 /*
1246 * Iterate thru the device instances and USB device instances,
1247 * processing the drivers associated with those.
1248 *
1249 * The attached drivers are normally processed first. Some devices
1250 * (like DevAHCI) though needs to be notified before the drivers so
1251 * that it doesn't kick off any new requests after the drivers stopped
1252 * taking any. (DrvVD changes to read-only in this particular case.)
1253 */
1254 cAsync = 0;
1255 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1256 {
1257 unsigned const cAsyncStart = cAsync;
1258
1259 if (pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION)
1260 pdmR3SuspendDev(pDevIns, &cAsync);
1261
1262 if (cAsync == cAsyncStart)
1263 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1264 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1265 if (!pdmR3SuspendDrv(pDrvIns, &cAsync, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance, pLun->iLun))
1266 break;
1267
1268 if ( cAsync == cAsyncStart
1269 && !(pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION))
1270 pdmR3SuspendDev(pDevIns, &cAsync);
1271 }
1272
1273#ifdef VBOX_WITH_USB
1274 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1275 {
1276 unsigned const cAsyncStart = cAsync;
1277
1278 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1279 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1280 if (!pdmR3SuspendDrv(pDrvIns, &cAsync, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance, pLun->iLun))
1281 break;
1282
1283 if (cAsync == cAsyncStart)
1284 pdmR3SuspendUsb(pUsbIns, &cAsync);
1285 }
1286#endif
1287 if (!cAsync)
1288 break;
1289
1290 /*
1291 * Process requests.
1292 */
1293 /** @todo This is utterly nuts and completely unsafe... will get back to it in a
1294 * bit I hope... */
1295 int rc = VMR3ReqProcessU(pVM->pUVM, VMCPUID_ANY);
1296 AssertReleaseRC(rc == VINF_SUCCESS);
1297 }
1298
1299 /*
1300 * Suspend all threads.
1301 */
1302 pdmR3ThreadSuspendAll(pVM);
1303
1304 LogFlow(("PDMR3Suspend: returns void\n"));
1305}
1306
1307
1308/**
1309 * Worker for PDMR3Resume that deals with one driver.
1310 *
1311 * @param pDrvIns The driver instance.
1312 * @param pszDeviceName The parent device name.
1313 * @param iDevInstance The parent device instance number.
1314 * @param iLun The parent LUN number.
1315 */
1316DECLINLINE(bool) pdmR3ResumeDrv(PPDMDRVINS pDrvIns, const char *pszDeviceName, uint32_t iDevInstance, uint32_t iLun)
1317{
1318 Assert(pDrvIns->Internal.s.fVMSuspended);
1319 if (pDrvIns->pDrvReg->pfnResume)
1320 {
1321 LogFlow(("PDMR3Resume: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1322 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, iLun, pszDeviceName, iDevInstance));
1323 int rc = VINF_SUCCESS; pDrvIns->pDrvReg->pfnResume(pDrvIns);
1324 if (RT_FAILURE(rc))
1325 {
1326 LogRel(("PDMR3Resume: driver '%s'/%d on LUN#%d of device '%s'/%d -> %Rrc\n",
1327 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, iLun, pszDeviceName, iDevInstance, rc));
1328 return rc;
1329 }
1330 }
1331 pDrvIns->Internal.s.fVMSuspended = false;
1332 return VINF_SUCCESS;
1333}
1334
1335
1336/**
1337 * Worker for PDMR3Resume that deals with one USB device instance.
1338 *
1339 * @returns VBox status code.
1340 * @param pUsbIns The USB device instance.
1341 */
1342DECLINLINE(int) pdmR3ResumeUsb(PPDMUSBINS pUsbIns)
1343{
1344 Assert(pUsbIns->Internal.s.fVMSuspended);
1345 if (pUsbIns->pUsbReg->pfnVMResume)
1346 {
1347 LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n", pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1348 int rc = VINF_SUCCESS; pUsbIns->pUsbReg->pfnVMResume(pUsbIns);
1349 if (RT_FAILURE(rc))
1350 {
1351 LogRel(("PDMR3Resume: device '%s'/%d -> %Rrc\n", pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance, rc));
1352 return rc;
1353 }
1354 }
1355 pUsbIns->Internal.s.fVMSuspended = false;
1356 return VINF_SUCCESS;
1357}
1358
1359
1360/**
1361 * Worker for PDMR3Resume that deals with one device instance.
1362 *
1363 * @returns VBox status code.
1364 * @param pDevIns The device instance.
1365 */
1366DECLINLINE(int) pdmR3ResumeDev(PPDMDEVINS pDevIns)
1367{
1368 Assert(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_SUSPENDED);
1369 if (pDevIns->pDevReg->pfnResume)
1370 {
1371 LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1372 int rc = VINF_SUCCESS; pDevIns->pDevReg->pfnResume(pDevIns);
1373 if (RT_FAILURE(rc))
1374 {
1375 LogRel(("PDMR3Resume: device '%s'/%d -> %Rrc\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance, rc));
1376 return rc;
1377 }
1378 }
1379 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
1380 return VINF_SUCCESS;
1381}
1382
1383
1384/**
1385 * This function will notify all the devices and their
1386 * attached drivers about the VM now being resumed.
1387 *
1388 * @param pVM VM Handle.
1389 */
1390VMMR3DECL(void) PDMR3Resume(PVM pVM)
1391{
1392 LogFlow(("PDMR3Resume:\n"));
1393
1394 /*
1395 * Iterate thru the device instances and USB device instances,
1396 * processing the drivers associated with those.
1397 */
1398 int rc = VINF_SUCCESS;
1399 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns && RT_SUCCESS(rc); pDevIns = pDevIns->Internal.s.pNextR3)
1400 {
1401 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun && RT_SUCCESS(rc); pLun = pLun->pNext)
1402 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns && RT_SUCCESS(rc); pDrvIns = pDrvIns->Internal.s.pDown)
1403 rc = pdmR3ResumeDrv(pDrvIns, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance, pLun->iLun);
1404 if (RT_SUCCESS(rc))
1405 rc = pdmR3ResumeDev(pDevIns);
1406 }
1407
1408#ifdef VBOX_WITH_USB
1409 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns && RT_SUCCESS(rc); pUsbIns = pUsbIns->Internal.s.pNext)
1410 {
1411 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun && RT_SUCCESS(rc); pLun = pLun->pNext)
1412 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns && RT_SUCCESS(rc); pDrvIns = pDrvIns->Internal.s.pDown)
1413 rc = pdmR3ResumeDrv(pDrvIns, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance, pLun->iLun);
1414 if (RT_SUCCESS(rc))
1415 rc = pdmR3ResumeUsb(pUsbIns);
1416 }
1417#endif
1418
1419 /*
1420 * Resume all threads.
1421 */
1422 if (RT_SUCCESS(rc))
1423 pdmR3ThreadResumeAll(pVM);
1424
1425 /*
1426 * On failure, clean up via PDMR3Suspend.
1427 */
1428 if (RT_FAILURE(rc))
1429 PDMR3Suspend(pVM);
1430
1431 LogFlow(("PDMR3Resume: returns %Rrc\n", rc));
1432 return /*rc*/;
1433}
1434
1435
1436/**
1437 * Worker for PDMR3PowerOff that deals with one driver.
1438 *
1439 * @param pDrvIns The driver instance.
1440 * @param pcAsync The asynchronous power off notification counter.
1441 * @param pszDeviceName The parent device name.
1442 * @param iDevInstance The parent device instance number.
1443 * @param iLun The parent LUN number.
1444 */
1445DECLINLINE(bool) pdmR3PowerOffDrv(PPDMDRVINS pDrvIns, unsigned *pcAsync,
1446 const char *pszDeviceName, uint32_t iDevInstance, uint32_t iLun)
1447{
1448 if (!pDrvIns->Internal.s.fVMSuspended)
1449 {
1450 pDrvIns->Internal.s.fVMSuspended = true;
1451 if (pDrvIns->pDrvReg->pfnSuspend)
1452 {
1453 if (!pDrvIns->Internal.s.pfnAsyncNotify)
1454 {
1455 LogFlow(("PDMR3PowerOff: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1456 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, iLun, pszDeviceName, iDevInstance));
1457 pDrvIns->pDrvReg->pfnPowerOff(pDrvIns);
1458 }
1459 else if (pDrvIns->Internal.s.pfnAsyncNotify(pDrvIns))
1460 {
1461 pDrvIns->Internal.s.pfnAsyncNotify = false;
1462 LogFlow(("PDMR3PowerOff: Async notification completed - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1463 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, iLun, pszDeviceName, iDevInstance));
1464 }
1465 if (pDrvIns->Internal.s.pfnAsyncNotify)
1466 {
1467 pDrvIns->Internal.s.fVMSuspended = false;
1468 (*pcAsync)++;
1469 return false;
1470 }
1471 }
1472 }
1473 return true;
1474}
1475
1476
1477/**
1478 * Worker for PDMR3PowerOff that deals with one USB device instance.
1479 *
1480 * @param pUsbIns The USB device instance.
1481 * @param pcAsync The asynchronous power off notification counter.
1482 */
1483DECLINLINE(void) pdmR3PowerOffUsb(PPDMUSBINS pUsbIns, unsigned *pcAsync)
1484{
1485 if (!pUsbIns->Internal.s.fVMSuspended)
1486 {
1487 pUsbIns->Internal.s.fVMSuspended = true;
1488 if (pUsbIns->pUsbReg->pfnVMPowerOff)
1489 {
1490 if (!pUsbIns->Internal.s.pfnAsyncNotify)
1491 {
1492 LogFlow(("PDMR3PowerOff: Notifying - device '%s'/%d\n", pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1493 pUsbIns->pUsbReg->pfnVMPowerOff(pUsbIns);
1494 }
1495 else if (pUsbIns->Internal.s.pfnAsyncNotify(pUsbIns))
1496 {
1497 LogFlow(("PDMR3PowerOff: Async notification completed - device '%s'/%d\n", pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1498 pUsbIns->Internal.s.pfnAsyncNotify = NULL;
1499 }
1500 if (pUsbIns->Internal.s.pfnAsyncNotify)
1501 {
1502 pUsbIns->Internal.s.fVMSuspended = false;
1503 (*pcAsync)++;
1504 }
1505 }
1506 }
1507}
1508
1509
1510/**
1511 * Worker for PDMR3PowerOff that deals with one device instance.
1512 *
1513 * @param pDevIns The device instance.
1514 * @param pcAsync The asynchronous power off notification counter.
1515 */
1516DECLINLINE(void) pdmR3PowerOffDev(PPDMDEVINS pDevIns, unsigned *pcAsync)
1517{
1518 if (!(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_SUSPENDED))
1519 {
1520 pDevIns->Internal.s.fIntFlags |= PDMDEVINSINT_FLAGS_SUSPENDED;
1521 if (pDevIns->pDevReg->pfnSuspend)
1522 {
1523 if (!pDevIns->Internal.s.pfnAsyncNotify)
1524 {
1525 LogFlow(("PDMR3PowerOff: Notifying - device '%s'/%d\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1526 pDevIns->pDevReg->pfnPowerOff(pDevIns);
1527 }
1528 else if (pDevIns->Internal.s.pfnAsyncNotify(pDevIns))
1529 {
1530 LogFlow(("PDMR3PowerOff: Async notification completed - device '%s'/%d\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1531 pDevIns->Internal.s.pfnAsyncNotify = NULL;
1532 }
1533 if (pDevIns->Internal.s.pfnAsyncNotify)
1534 {
1535 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
1536 (*pcAsync)++;
1537 }
1538 }
1539 }
1540}
1541
1542
1543/**
1544 * This function will notify all the devices and their
1545 * attached drivers about the VM being powered off.
1546 *
1547 * @param pVM VM Handle.
1548 */
1549VMMR3DECL(void) PDMR3PowerOff(PVM pVM)
1550{
1551 LogFlow(("PDMR3PowerOff:\n"));
1552
1553 /*
1554 * The outer loop repeats until there are no more async requests.
1555 */
1556 unsigned cAsync;
1557 for (;;)
1558 {
1559 /*
1560 * Iterate thru the device instances and USB device instances,
1561 * processing the drivers associated with those.
1562 *
1563 * The attached drivers are normally processed first. Some devices
1564 * (like DevAHCI) though needs to be notified before the drivers so
1565 * that it doesn't kick off any new requests after the drivers stopped
1566 * taking any. (DrvVD changes to read-only in this particular case.)
1567 */
1568 cAsync = 0;
1569 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1570 {
1571 unsigned const cAsyncStart = cAsync;
1572
1573 if (pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION)
1574 pdmR3PowerOffDev(pDevIns, &cAsync);
1575
1576 if (cAsync == cAsyncStart)
1577 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1578 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1579 if (!pdmR3PowerOffDrv(pDrvIns, &cAsync, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance, pLun->iLun))
1580 break;
1581
1582 if ( cAsync == cAsyncStart
1583 && !(pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION))
1584 pdmR3PowerOffDev(pDevIns, &cAsync);
1585 }
1586
1587#ifdef VBOX_WITH_USB
1588 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1589 {
1590 unsigned const cAsyncStart = cAsync;
1591
1592 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1593 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1594 if (!pdmR3PowerOffDrv(pDrvIns, &cAsync, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance, pLun->iLun))
1595 break;
1596
1597 if (cAsync == cAsyncStart)
1598 pdmR3PowerOffUsb(pUsbIns, &cAsync);
1599 }
1600#endif
1601 if (!cAsync)
1602 break;
1603
1604 /*
1605 * Process requests.
1606 */
1607 /** @todo This is utterly nuts and completely unsafe... will get back to it in a
1608 * bit I hope... */
1609 int rc = VMR3ReqProcessU(pVM->pUVM, VMCPUID_ANY);
1610 AssertReleaseRC(rc == VINF_SUCCESS);
1611 }
1612
1613 /*
1614 * Suspend all threads.
1615 */
1616 pdmR3ThreadSuspendAll(pVM);
1617
1618 LogFlow(("PDMR3PowerOff: returns void\n"));
1619}
1620
1621
1622/**
1623 * Queries the base interace of a device instance.
1624 *
1625 * The caller can use this to query other interfaces the device implements
1626 * and use them to talk to the device.
1627 *
1628 * @returns VBox status code.
1629 * @param pVM VM handle.
1630 * @param pszDevice Device name.
1631 * @param iInstance Device instance.
1632 * @param ppBase Where to store the pointer to the base device interface on success.
1633 * @remark We're not doing any locking ATM, so don't try call this at times when the
1634 * device chain is known to be updated.
1635 */
1636VMMR3DECL(int) PDMR3QueryDevice(PVM pVM, const char *pszDevice, unsigned iInstance, PPDMIBASE *ppBase)
1637{
1638 LogFlow(("PDMR3DeviceQuery: pszDevice=%p:{%s} iInstance=%u ppBase=%p\n", pszDevice, pszDevice, iInstance, ppBase));
1639
1640 /*
1641 * Iterate registered devices looking for the device.
1642 */
1643 size_t cchDevice = strlen(pszDevice);
1644 for (PPDMDEV pDev = pVM->pdm.s.pDevs; pDev; pDev = pDev->pNext)
1645 {
1646 if ( pDev->cchName == cchDevice
1647 && !memcmp(pDev->pDevReg->szDeviceName, pszDevice, cchDevice))
1648 {
1649 /*
1650 * Iterate device instances.
1651 */
1652 for (PPDMDEVINS pDevIns = pDev->pInstances; pDevIns; pDevIns = pDevIns->Internal.s.pPerDeviceNextR3)
1653 {
1654 if (pDevIns->iInstance == iInstance)
1655 {
1656 if (pDevIns->IBase.pfnQueryInterface)
1657 {
1658 *ppBase = &pDevIns->IBase;
1659 LogFlow(("PDMR3DeviceQuery: return VINF_SUCCESS and *ppBase=%p\n", *ppBase));
1660 return VINF_SUCCESS;
1661 }
1662
1663 LogFlow(("PDMR3DeviceQuery: returns VERR_PDM_DEVICE_INSTANCE_NO_IBASE\n"));
1664 return VERR_PDM_DEVICE_INSTANCE_NO_IBASE;
1665 }
1666 }
1667
1668 LogFlow(("PDMR3DeviceQuery: returns VERR_PDM_DEVICE_INSTANCE_NOT_FOUND\n"));
1669 return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND;
1670 }
1671 }
1672
1673 LogFlow(("PDMR3QueryDevice: returns VERR_PDM_DEVICE_NOT_FOUND\n"));
1674 return VERR_PDM_DEVICE_NOT_FOUND;
1675}
1676
1677
1678/**
1679 * Queries the base interface of a device LUN.
1680 *
1681 * This differs from PDMR3QueryLun by that it returns the interface on the
1682 * device and not the top level driver.
1683 *
1684 * @returns VBox status code.
1685 * @param pVM VM Handle.
1686 * @param pszDevice Device name.
1687 * @param iInstance Device instance.
1688 * @param iLun The Logical Unit to obtain the interface of.
1689 * @param ppBase Where to store the base interface pointer.
1690 * @remark We're not doing any locking ATM, so don't try call this at times when the
1691 * device chain is known to be updated.
1692 */
1693VMMR3DECL(int) PDMR3QueryDeviceLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
1694{
1695 LogFlow(("PDMR3QueryLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
1696 pszDevice, pszDevice, iInstance, iLun, ppBase));
1697
1698 /*
1699 * Find the LUN.
1700 */
1701 PPDMLUN pLun;
1702 int rc = pdmR3DevFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
1703 if (RT_SUCCESS(rc))
1704 {
1705 *ppBase = pLun->pBase;
1706 LogFlow(("PDMR3QueryDeviceLun: return VINF_SUCCESS and *ppBase=%p\n", *ppBase));
1707 return VINF_SUCCESS;
1708 }
1709 LogFlow(("PDMR3QueryDeviceLun: returns %Rrc\n", rc));
1710 return rc;
1711}
1712
1713
1714/**
1715 * Query the interface of the top level driver on a LUN.
1716 *
1717 * @returns VBox status code.
1718 * @param pVM VM Handle.
1719 * @param pszDevice Device name.
1720 * @param iInstance Device instance.
1721 * @param iLun The Logical Unit to obtain the interface of.
1722 * @param ppBase Where to store the base interface pointer.
1723 * @remark We're not doing any locking ATM, so don't try call this at times when the
1724 * device chain is known to be updated.
1725 */
1726VMMR3DECL(int) PDMR3QueryLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
1727{
1728 LogFlow(("PDMR3QueryLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
1729 pszDevice, pszDevice, iInstance, iLun, ppBase));
1730
1731 /*
1732 * Find the LUN.
1733 */
1734 PPDMLUN pLun;
1735 int rc = pdmR3DevFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
1736 if (RT_SUCCESS(rc))
1737 {
1738 if (pLun->pTop)
1739 {
1740 *ppBase = &pLun->pTop->IBase;
1741 LogFlow(("PDMR3QueryLun: return %Rrc and *ppBase=%p\n", VINF_SUCCESS, *ppBase));
1742 return VINF_SUCCESS;
1743 }
1744 rc = VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN;
1745 }
1746 LogFlow(("PDMR3QueryLun: returns %Rrc\n", rc));
1747 return rc;
1748}
1749
1750/**
1751 * Executes pending DMA transfers.
1752 * Forced Action handler.
1753 *
1754 * @param pVM VM handle.
1755 */
1756VMMR3DECL(void) PDMR3DmaRun(PVM pVM)
1757{
1758 /* Note! Not really SMP safe; restrict it to VCPU 0. */
1759 if (VMMGetCpuId(pVM) != 0)
1760 return;
1761
1762 if (VM_FF_TESTANDCLEAR(pVM, VM_FF_PDM_DMA))
1763 {
1764 if (pVM->pdm.s.pDmac)
1765 {
1766 bool fMore = pVM->pdm.s.pDmac->Reg.pfnRun(pVM->pdm.s.pDmac->pDevIns);
1767 if (fMore)
1768 VM_FF_SET(pVM, VM_FF_PDM_DMA);
1769 }
1770 }
1771}
1772
1773
1774/**
1775 * Service a VMMCALLRING3_PDM_LOCK call.
1776 *
1777 * @returns VBox status code.
1778 * @param pVM The VM handle.
1779 */
1780VMMR3DECL(int) PDMR3LockCall(PVM pVM)
1781{
1782 return PDMR3CritSectEnterEx(&pVM->pdm.s.CritSect, true /* fHostCall */);
1783}
1784
1785
1786/**
1787 * Registers the VMM device heap
1788 *
1789 * @returns VBox status code.
1790 * @param pVM VM handle.
1791 * @param GCPhys The physical address.
1792 * @param pvHeap Ring-3 pointer.
1793 * @param cbSize Size of the heap.
1794 */
1795VMMR3DECL(int) PDMR3RegisterVMMDevHeap(PVM pVM, RTGCPHYS GCPhys, RTR3PTR pvHeap, unsigned cbSize)
1796{
1797 Assert(pVM->pdm.s.pvVMMDevHeap == NULL);
1798
1799 Log(("PDMR3RegisterVMMDevHeap %RGp %RHv %x\n", GCPhys, pvHeap, cbSize));
1800 pVM->pdm.s.pvVMMDevHeap = pvHeap;
1801 pVM->pdm.s.GCPhysVMMDevHeap = GCPhys;
1802 pVM->pdm.s.cbVMMDevHeap = cbSize;
1803 pVM->pdm.s.cbVMMDevHeapLeft = cbSize;
1804 return VINF_SUCCESS;
1805}
1806
1807
1808/**
1809 * Unregisters the VMM device heap
1810 *
1811 * @returns VBox status code.
1812 * @param pVM VM handle.
1813 * @param GCPhys The physical address.
1814 */
1815VMMR3DECL(int) PDMR3UnregisterVMMDevHeap(PVM pVM, RTGCPHYS GCPhys)
1816{
1817 Assert(pVM->pdm.s.GCPhysVMMDevHeap == GCPhys);
1818
1819 Log(("PDMR3UnregisterVMMDevHeap %RGp\n", GCPhys));
1820 pVM->pdm.s.pvVMMDevHeap = NULL;
1821 pVM->pdm.s.GCPhysVMMDevHeap = NIL_RTGCPHYS;
1822 pVM->pdm.s.cbVMMDevHeap = 0;
1823 pVM->pdm.s.cbVMMDevHeapLeft = 0;
1824 return VINF_SUCCESS;
1825}
1826
1827
1828/**
1829 * Allocates memory from the VMM device heap
1830 *
1831 * @returns VBox status code.
1832 * @param pVM VM handle.
1833 * @param cbSize Allocation size.
1834 * @param pv Ring-3 pointer. (out)
1835 */
1836VMMR3DECL(int) PDMR3VMMDevHeapAlloc(PVM pVM, unsigned cbSize, RTR3PTR *ppv)
1837{
1838#ifdef DEBUG_bird
1839 if (!cbSize || cbSize > pVM->pdm.s.cbVMMDevHeapLeft)
1840 return VERR_NO_MEMORY;
1841#else
1842 AssertReturn(cbSize && cbSize <= pVM->pdm.s.cbVMMDevHeapLeft, VERR_NO_MEMORY);
1843#endif
1844
1845 Log(("PDMR3VMMDevHeapAlloc %x\n", cbSize));
1846
1847 /** @todo not a real heap as there's currently only one user. */
1848 *ppv = pVM->pdm.s.pvVMMDevHeap;
1849 pVM->pdm.s.cbVMMDevHeapLeft = 0;
1850 return VINF_SUCCESS;
1851}
1852
1853
1854/**
1855 * Frees memory from the VMM device heap
1856 *
1857 * @returns VBox status code.
1858 * @param pVM VM handle.
1859 * @param pv Ring-3 pointer.
1860 */
1861VMMR3DECL(int) PDMR3VMMDevHeapFree(PVM pVM, RTR3PTR pv)
1862{
1863 Log(("PDMR3VMMDevHeapFree %RHv\n", pv));
1864
1865 /** @todo not a real heap as there's currently only one user. */
1866 pVM->pdm.s.cbVMMDevHeapLeft = pVM->pdm.s.cbVMMDevHeap;
1867 return VINF_SUCCESS;
1868}
1869
1870/**
1871 * Release the PDM lock if owned by the current VCPU
1872 *
1873 * @param pVM The VM to operate on.
1874 */
1875VMMR3DECL(void) PDMR3ReleaseOwnedLocks(PVM pVM)
1876{
1877 while (PDMCritSectIsOwner(&pVM->pdm.s.CritSect))
1878 PDMCritSectLeave(&pVM->pdm.s.CritSect);
1879}
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