VirtualBox

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

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

PDM: Add new flags which will make the device notified first if the VM is suspended if set
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 50.0 KB
Line 
1/* $Id: PDM.cpp 16021 2009-01-19 00:34:50Z 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 3
283
284
285/*******************************************************************************
286* Internal Functions *
287*******************************************************************************/
288static DECLCALLBACK(int) pdmR3Save(PVM pVM, PSSMHANDLE pSSM);
289static DECLCALLBACK(int) pdmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t u32Version);
290static DECLCALLBACK(int) pdmR3LoadPrep(PVM pVM, PSSMHANDLE pSSM);
291static DECLCALLBACK(void) pdmR3PollerTimer(PVM pVM, PTMTIMER pTimer, void *pvUser);
292
293
294
295/**
296 * Initializes the PDM part of the UVM.
297 *
298 * This doesn't really do much right now but has to be here for the sake
299 * of completeness.
300 *
301 * @returns VBox status code.
302 * @param pUVM Pointer to the user mode VM structure.
303 */
304VMMR3DECL(int) PDMR3InitUVM(PUVM pUVM)
305{
306 AssertCompile(sizeof(pUVM->pdm.s) <= sizeof(pUVM->pdm.padding));
307 AssertRelease(sizeof(pUVM->pdm.s) <= sizeof(pUVM->pdm.padding));
308 pUVM->pdm.s.pModules = NULL;
309 return VINF_SUCCESS;
310}
311
312
313/**
314 * Initializes the PDM.
315 *
316 * @returns VBox status code.
317 * @param pVM The VM to operate on.
318 */
319VMMR3DECL(int) PDMR3Init(PVM pVM)
320{
321 LogFlow(("PDMR3Init\n"));
322
323 /*
324 * Assert alignment and sizes.
325 */
326 AssertRelease(!(RT_OFFSETOF(VM, pdm.s) & 31));
327 AssertRelease(sizeof(pVM->pdm.s) <= sizeof(pVM->pdm.padding));
328
329 /*
330 * Init the structure.
331 */
332 pVM->pdm.s.offVM = RT_OFFSETOF(VM, pdm.s);
333 pVM->pdm.s.GCPhysVMMDevHeap = NIL_RTGCPHYS;
334
335 int rc = TMR3TimerCreateInternal(pVM, TMCLOCK_VIRTUAL, pdmR3PollerTimer, NULL, "PDM Poller", &pVM->pdm.s.pTimerPollers);
336 AssertRC(rc);
337
338 /*
339 * Initialize sub compontents.
340 */
341 rc = pdmR3CritSectInit(pVM);
342 if (RT_SUCCESS(rc))
343 {
344 rc = PDMR3CritSectInit(pVM, &pVM->pdm.s.CritSect, "PDM");
345 if (RT_SUCCESS(rc))
346 rc = pdmR3LdrInitU(pVM->pUVM);
347 if (RT_SUCCESS(rc))
348 {
349 rc = pdmR3DrvInit(pVM);
350 if (RT_SUCCESS(rc))
351 {
352 rc = pdmR3DevInit(pVM);
353 if (RT_SUCCESS(rc))
354 {
355#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
356 rc = pdmR3AsyncCompletionInit(pVM);
357 if (RT_SUCCESS(rc))
358#endif
359 {
360 /*
361 * Register the saved state data unit.
362 */
363 rc = SSMR3RegisterInternal(pVM, "pdm", 1, PDM_SAVED_STATE_VERSION, 128,
364 NULL, pdmR3Save, NULL,
365 pdmR3LoadPrep, pdmR3Load, NULL);
366 if (RT_SUCCESS(rc))
367 {
368 LogFlow(("PDM: Successfully initialized\n"));
369 return rc;
370 }
371
372 }
373 }
374 }
375 }
376 }
377
378 /*
379 * Cleanup and return failure.
380 */
381 PDMR3Term(pVM);
382 LogFlow(("PDMR3Init: returns %Rrc\n", rc));
383 return rc;
384}
385
386
387/**
388 * Applies relocations to data and code managed by this
389 * component. This function will be called at init and
390 * whenever the VMM need to relocate it self inside the GC.
391 *
392 * @param pVM VM handle.
393 * @param offDelta Relocation delta relative to old location.
394 * @remark The loader subcomponent is relocated by PDMR3LdrRelocate() very
395 * early in the relocation phase.
396 */
397VMMR3DECL(void) PDMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
398{
399 LogFlow(("PDMR3Relocate\n"));
400
401 /*
402 * Queues.
403 */
404 pdmR3QueueRelocate(pVM, offDelta);
405 pVM->pdm.s.pDevHlpQueueRC = PDMQueueRCPtr(pVM->pdm.s.pDevHlpQueueR3);
406
407 /*
408 * Critical sections.
409 */
410 pdmR3CritSectRelocate(pVM);
411
412 /*
413 * The registered PIC.
414 */
415 if (pVM->pdm.s.Pic.pDevInsRC)
416 {
417 pVM->pdm.s.Pic.pDevInsRC += offDelta;
418 pVM->pdm.s.Pic.pfnSetIrqRC += offDelta;
419 pVM->pdm.s.Pic.pfnGetInterruptRC += offDelta;
420 }
421
422 /*
423 * The registered APIC.
424 */
425 if (pVM->pdm.s.Apic.pDevInsRC)
426 {
427 pVM->pdm.s.Apic.pDevInsRC += offDelta;
428 pVM->pdm.s.Apic.pfnGetInterruptRC += offDelta;
429 pVM->pdm.s.Apic.pfnSetBaseRC += offDelta;
430 pVM->pdm.s.Apic.pfnGetBaseRC += offDelta;
431 pVM->pdm.s.Apic.pfnSetTPRRC += offDelta;
432 pVM->pdm.s.Apic.pfnGetTPRRC += offDelta;
433 pVM->pdm.s.Apic.pfnBusDeliverRC += offDelta;
434 pVM->pdm.s.Apic.pfnWriteMSRRC += offDelta;
435 pVM->pdm.s.Apic.pfnReadMSRRC += offDelta;
436 }
437
438 /*
439 * The registered I/O APIC.
440 */
441 if (pVM->pdm.s.IoApic.pDevInsRC)
442 {
443 pVM->pdm.s.IoApic.pDevInsRC += offDelta;
444 pVM->pdm.s.IoApic.pfnSetIrqRC += offDelta;
445 }
446
447 /*
448 * The register PCI Buses.
449 */
450 for (unsigned i = 0; i < RT_ELEMENTS(pVM->pdm.s.aPciBuses); i++)
451 {
452 if (pVM->pdm.s.aPciBuses[i].pDevInsRC)
453 {
454 pVM->pdm.s.aPciBuses[i].pDevInsRC += offDelta;
455 pVM->pdm.s.aPciBuses[i].pfnSetIrqRC += offDelta;
456 }
457 }
458
459 /*
460 * Devices.
461 */
462 PCPDMDEVHLPRC pDevHlpRC;
463 int rc = PDMR3LdrGetSymbolRC(pVM, NULL, "g_pdmRCDevHlp", &pDevHlpRC);
464 AssertReleaseMsgRC(rc, ("rc=%Rrc when resolving g_pdmRCDevHlp\n", rc));
465 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
466 {
467 if (pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_RC)
468 {
469 pDevIns->pDevHlpRC = pDevHlpRC;
470 pDevIns->pvInstanceDataRC = MMHyperR3ToRC(pVM, pDevIns->pvInstanceDataR3);
471 pDevIns->Internal.s.pVMRC = pVM->pVMRC;
472 if (pDevIns->Internal.s.pPciBusR3)
473 pDevIns->Internal.s.pPciBusRC = MMHyperR3ToRC(pVM, pDevIns->Internal.s.pPciBusR3);
474 if (pDevIns->Internal.s.pPciDeviceR3)
475 pDevIns->Internal.s.pPciDeviceRC = MMHyperR3ToRC(pVM, pDevIns->Internal.s.pPciDeviceR3);
476 if (pDevIns->pDevReg->pfnRelocate)
477 {
478 LogFlow(("PDMR3Relocate: Relocating device '%s'/%d\n",
479 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
480 pDevIns->pDevReg->pfnRelocate(pDevIns, offDelta);
481 }
482 }
483 }
484}
485
486
487/**
488 * Worker for pdmR3Term that terminates a LUN chain.
489 *
490 * @param pVM Pointer to the shared VM structure.
491 * @param pLun The head of the chain.
492 * @param pszDevice The name of the device (for logging).
493 * @param iInstance The device instance number (for logging).
494 */
495static void pdmR3TermLuns(PVM pVM, PPDMLUN pLun, const char *pszDevice, unsigned iInstance)
496{
497 for (; pLun; pLun = pLun->pNext)
498 {
499 /*
500 * Destroy them one at a time from the bottom up.
501 * (The serial device/drivers depends on this - bad.)
502 */
503 PPDMDRVINS pDrvIns = pLun->pBottom;
504 pLun->pBottom = pLun->pTop = NULL;
505 while (pDrvIns)
506 {
507 PPDMDRVINS pDrvNext = pDrvIns->Internal.s.pUp;
508
509 if (pDrvIns->pDrvReg->pfnDestruct)
510 {
511 LogFlow(("pdmR3DevTerm: Destroying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
512 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pszDevice, iInstance));
513 pDrvIns->pDrvReg->pfnDestruct(pDrvIns);
514 }
515
516 TMR3TimerDestroyDriver(pVM, pDrvIns);
517 //PDMR3QueueDestroyDriver(pVM, pDrvIns);
518 //pdmR3ThreadDestroyDriver(pVM, pDrvIns);
519 SSMR3DeregisterDriver(pVM, pDrvIns, NULL, 0);
520
521 pDrvIns = pDrvNext;
522 }
523 }
524}
525
526
527/**
528 * Terminates the PDM.
529 *
530 * Termination means cleaning up and freeing all resources,
531 * the VM it self is at this point powered off or suspended.
532 *
533 * @returns VBox status code.
534 * @param pVM The VM to operate on.
535 */
536VMMR3DECL(int) PDMR3Term(PVM pVM)
537{
538 LogFlow(("PDMR3Term:\n"));
539 AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
540
541 /*
542 * Iterate the device instances and attach drivers, doing
543 * relevant destruction processing.
544 *
545 * N.B. There is no need to mess around freeing memory allocated
546 * from any MM heap since MM will do that in its Term function.
547 */
548 /* usb ones first. */
549 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
550 {
551 pdmR3TermLuns(pVM, pUsbIns->Internal.s.pLuns, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance);
552
553 if (pUsbIns->pUsbReg->pfnDestruct)
554 {
555 LogFlow(("pdmR3DevTerm: Destroying - device '%s'/%d\n",
556 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
557 pUsbIns->pUsbReg->pfnDestruct(pUsbIns);
558 }
559
560 //TMR3TimerDestroyUsb(pVM, pUsbIns);
561 //SSMR3DeregisterUsb(pVM, pUsbIns, NULL, 0);
562 pdmR3ThreadDestroyUsb(pVM, pUsbIns);
563 }
564
565 /* then the 'normal' ones. */
566 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
567 {
568 pdmR3TermLuns(pVM, pDevIns->Internal.s.pLunsR3, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance);
569
570 if (pDevIns->pDevReg->pfnDestruct)
571 {
572 LogFlow(("pdmR3DevTerm: Destroying - device '%s'/%d\n",
573 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
574 pDevIns->pDevReg->pfnDestruct(pDevIns);
575 }
576
577 TMR3TimerDestroyDevice(pVM, pDevIns);
578 //SSMR3DeregisterDriver(pVM, pDevIns, NULL, 0);
579 pdmR3CritSectDeleteDevice(pVM, pDevIns);
580 //pdmR3ThreadDestroyDevice(pVM, pDevIns);
581 //PDMR3QueueDestroyDevice(pVM, pDevIns);
582 PGMR3PhysMMIO2Deregister(pVM, pDevIns, UINT32_MAX);
583 }
584
585 /*
586 * Destroy all threads.
587 */
588 pdmR3ThreadDestroyAll(pVM);
589
590#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
591 /*
592 * Free async completion managers.
593 */
594 pdmR3AsyncCompletionTerm(pVM);
595#endif
596
597 /*
598 * Free modules.
599 */
600 pdmR3LdrTermU(pVM->pUVM);
601
602 /*
603 * Destroy the PDM lock.
604 */
605 PDMR3CritSectDelete(&pVM->pdm.s.CritSect);
606
607 LogFlow(("PDMR3Term: returns %Rrc\n", VINF_SUCCESS));
608 return VINF_SUCCESS;
609}
610
611
612/**
613 * Terminates the PDM part of the UVM.
614 *
615 * This will unload any modules left behind.
616 *
617 * @param pUVM Pointer to the user mode VM structure.
618 */
619VMMR3DECL(void) PDMR3TermUVM(PUVM pUVM)
620{
621 /*
622 * In the normal cause of events we will now call pdmR3LdrTermU for
623 * the second time. In the case of init failure however, this might
624 * the first time, which is why we do it.
625 */
626 pdmR3LdrTermU(pUVM);
627}
628
629
630
631
632
633/**
634 * Execute state save operation.
635 *
636 * @returns VBox status code.
637 * @param pVM VM Handle.
638 * @param pSSM SSM operation handle.
639 */
640static DECLCALLBACK(int) pdmR3Save(PVM pVM, PSSMHANDLE pSSM)
641{
642 LogFlow(("pdmR3Save:\n"));
643
644 /*
645 * Save interrupt and DMA states.
646 */
647 SSMR3PutUInt(pSSM, VM_FF_ISSET(pVM, VM_FF_INTERRUPT_APIC));
648 SSMR3PutUInt(pSSM, VM_FF_ISSET(pVM, VM_FF_INTERRUPT_PIC));
649 SSMR3PutUInt(pSSM, VM_FF_ISSET(pVM, VM_FF_PDM_DMA));
650
651 /*
652 * Save the list of device instances so we can check that
653 * they're all still there when we load the state and that
654 * nothing new have been added.
655 */
656 /** @todo We might have to filter out some device classes, like USB attached devices. */
657 uint32_t i = 0;
658 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3, i++)
659 {
660 SSMR3PutU32(pSSM, i);
661 SSMR3PutStrZ(pSSM, pDevIns->pDevReg->szDeviceName);
662 SSMR3PutU32(pSSM, pDevIns->iInstance);
663 }
664 return SSMR3PutU32(pSSM, ~0); /* terminator */
665}
666
667
668/**
669 * Prepare state load operation.
670 *
671 * This will dispatch pending operations and clear the FFs governed by PDM and its devices.
672 *
673 * @returns VBox status code.
674 * @param pVM The VM handle.
675 * @param pSSM The SSM handle.
676 */
677static DECLCALLBACK(int) pdmR3LoadPrep(PVM pVM, PSSMHANDLE pSSM)
678{
679 LogFlow(("pdmR3LoadPrep: %s%s%s%s\n",
680 VM_FF_ISSET(pVM, VM_FF_PDM_QUEUES) ? " VM_FF_PDM_QUEUES" : "",
681 VM_FF_ISSET(pVM, VM_FF_PDM_DMA) ? " VM_FF_PDM_DMA" : "",
682 VM_FF_ISSET(pVM, VM_FF_INTERRUPT_APIC) ? " VM_FF_INTERRUPT_APIC" : "",
683 VM_FF_ISSET(pVM, VM_FF_INTERRUPT_PIC) ? " VM_FF_INTERRUPT_PIC" : ""
684 ));
685
686 /*
687 * In case there is work pending that will raise an interrupt,
688 * start a DMA transfer, or release a lock. (unlikely)
689 */
690 if (VM_FF_ISSET(pVM, VM_FF_PDM_QUEUES))
691 PDMR3QueueFlushAll(pVM);
692
693 /* Clear the FFs. */
694 VM_FF_CLEAR(pVM, VM_FF_INTERRUPT_APIC);
695 VM_FF_CLEAR(pVM, VM_FF_INTERRUPT_PIC);
696 VM_FF_CLEAR(pVM, VM_FF_PDM_DMA);
697
698 return VINF_SUCCESS;
699}
700
701
702/**
703 * Execute state load operation.
704 *
705 * @returns VBox status code.
706 * @param pVM VM Handle.
707 * @param pSSM SSM operation handle.
708 * @param u32Version Data layout version.
709 */
710static DECLCALLBACK(int) pdmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t u32Version)
711{
712 LogFlow(("pdmR3Load:\n"));
713
714 /*
715 * Validate version.
716 */
717 if (u32Version != PDM_SAVED_STATE_VERSION)
718 {
719 AssertMsgFailed(("pdmR3Load: Invalid version u32Version=%d!\n", u32Version));
720 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
721 }
722
723 /*
724 * Load the interrupt and DMA states.
725 */
726 /* APIC interrupt */
727 RTUINT fInterruptPending = 0;
728 int rc = SSMR3GetUInt(pSSM, &fInterruptPending);
729 if (RT_FAILURE(rc))
730 return rc;
731 if (fInterruptPending & ~1)
732 {
733 AssertMsgFailed(("fInterruptPending=%#x (APIC)\n", fInterruptPending));
734 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
735 }
736 AssertRelease(!VM_FF_ISSET(pVM, VM_FF_INTERRUPT_APIC));
737 if (fInterruptPending)
738 VM_FF_SET(pVM, VM_FF_INTERRUPT_APIC);
739
740 /* PIC interrupt */
741 fInterruptPending = 0;
742 rc = SSMR3GetUInt(pSSM, &fInterruptPending);
743 if (RT_FAILURE(rc))
744 return rc;
745 if (fInterruptPending & ~1)
746 {
747 AssertMsgFailed(("fInterruptPending=%#x (PIC)\n", fInterruptPending));
748 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
749 }
750 AssertRelease(!VM_FF_ISSET(pVM, VM_FF_INTERRUPT_PIC));
751 if (fInterruptPending)
752 VM_FF_SET(pVM, VM_FF_INTERRUPT_PIC);
753
754 /* DMA pending */
755 RTUINT fDMAPending = 0;
756 rc = SSMR3GetUInt(pSSM, &fDMAPending);
757 if (RT_FAILURE(rc))
758 return rc;
759 if (fDMAPending & ~1)
760 {
761 AssertMsgFailed(("fDMAPending=%#x\n", fDMAPending));
762 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
763 }
764 AssertRelease(!VM_FF_ISSET(pVM, VM_FF_PDM_DMA));
765 if (fDMAPending)
766 VM_FF_SET(pVM, VM_FF_PDM_DMA);
767
768 /*
769 * Load the list of devices and verify that they are all there.
770 *
771 * We boldly ASSUME that the order is fixed and that it's a good, this
772 * makes it way easier to validate...
773 */
774 uint32_t i = 0;
775 PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances;
776 for (;;pDevIns = pDevIns->Internal.s.pNextR3, i++)
777 {
778 /* Get the separator / terminator. */
779 uint32_t u32Sep;
780 int rc = SSMR3GetU32(pSSM, &u32Sep);
781 if (RT_FAILURE(rc))
782 return rc;
783 if (u32Sep == (uint32_t)~0)
784 break;
785 if (u32Sep != i)
786 AssertMsgFailedReturn(("Out of seqence. u32Sep=%#x i=%#x\n", u32Sep, i), VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
787
788 /* get the name and instance number. */
789 char szDeviceName[sizeof(pDevIns->pDevReg->szDeviceName)];
790 rc = SSMR3GetStrZ(pSSM, szDeviceName, sizeof(szDeviceName));
791 if (RT_FAILURE(rc))
792 return rc;
793 RTUINT iInstance;
794 rc = SSMR3GetUInt(pSSM, &iInstance);
795 if (RT_FAILURE(rc))
796 return rc;
797
798 /* compare */
799 if (!pDevIns)
800 {
801 LogRel(("Device '%s'/%d not found in current config\n", szDeviceName, iInstance));
802 if (SSMR3HandleGetAfter(pSSM) != SSMAFTER_DEBUG_IT)
803 AssertFailedReturn(VERR_SSM_LOAD_CONFIG_MISMATCH);
804 break;
805 }
806 if ( strcmp(szDeviceName, pDevIns->pDevReg->szDeviceName)
807 || pDevIns->iInstance != iInstance)
808 {
809 LogRel(("u32Sep=%d loaded '%s'/%d configured '%s'/%d\n",
810 u32Sep, szDeviceName, iInstance, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
811 if (SSMR3HandleGetAfter(pSSM) != SSMAFTER_DEBUG_IT)
812 AssertFailedReturn(VERR_SSM_LOAD_CONFIG_MISMATCH);
813 }
814 }
815
816 /*
817 * Too many devices?
818 */
819 if (pDevIns)
820 {
821 LogRel(("Device '%s'/%d not found in saved state\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
822 if (SSMR3HandleGetAfter(pSSM) != SSMAFTER_DEBUG_IT)
823 AssertFailedReturn(VERR_SSM_LOAD_CONFIG_MISMATCH);
824 }
825
826 return VINF_SUCCESS;
827}
828
829
830/**
831 * This function will notify all the devices and their
832 * attached drivers about the VM now being powered on.
833 *
834 * @param pVM VM Handle.
835 */
836VMMR3DECL(void) PDMR3PowerOn(PVM pVM)
837{
838 LogFlow(("PDMR3PowerOn:\n"));
839
840 /*
841 * Iterate the device instances.
842 * The attached drivers are processed first.
843 */
844 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
845 {
846 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
847 /** @todo Inverse the order here? */
848 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
849 if (pDrvIns->pDrvReg->pfnPowerOn)
850 {
851 LogFlow(("PDMR3PowerOn: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
852 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
853 pDrvIns->pDrvReg->pfnPowerOn(pDrvIns);
854 }
855
856 if (pDevIns->pDevReg->pfnPowerOn)
857 {
858 LogFlow(("PDMR3PowerOn: Notifying - device '%s'/%d\n",
859 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
860 pDevIns->pDevReg->pfnPowerOn(pDevIns);
861 }
862 }
863
864#ifdef VBOX_WITH_USB
865 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
866 {
867 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
868 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
869 if (pDrvIns->pDrvReg->pfnPowerOn)
870 {
871 LogFlow(("PDMR3PowerOn: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
872 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
873 pDrvIns->pDrvReg->pfnPowerOn(pDrvIns);
874 }
875
876 if (pUsbIns->pUsbReg->pfnVMPowerOn)
877 {
878 LogFlow(("PDMR3PowerOn: Notifying - device '%s'/%d\n",
879 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
880 pUsbIns->pUsbReg->pfnVMPowerOn(pUsbIns);
881 }
882 }
883#endif
884
885 /*
886 * Resume all threads.
887 */
888 pdmR3ThreadResumeAll(pVM);
889
890 LogFlow(("PDMR3PowerOn: returns void\n"));
891}
892
893
894
895
896/**
897 * This function will notify all the devices and their
898 * attached drivers about the VM now being reset.
899 *
900 * @param pVM VM Handle.
901 */
902VMMR3DECL(void) PDMR3Reset(PVM pVM)
903{
904 LogFlow(("PDMR3Reset:\n"));
905
906 /*
907 * Clear all pending interrupts and DMA operations.
908 */
909 VM_FF_CLEAR(pVM, VM_FF_INTERRUPT_APIC);
910 VM_FF_CLEAR(pVM, VM_FF_INTERRUPT_PIC);
911 VM_FF_CLEAR(pVM, VM_FF_PDM_DMA);
912
913 /*
914 * Iterate the device instances.
915 * The attached drivers are processed first.
916 */
917 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
918 {
919 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
920 /** @todo Inverse the order here? */
921 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
922 if (pDrvIns->pDrvReg->pfnReset)
923 {
924 LogFlow(("PDMR3Reset: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
925 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
926 pDrvIns->pDrvReg->pfnReset(pDrvIns);
927 }
928
929 if (pDevIns->pDevReg->pfnReset)
930 {
931 LogFlow(("PDMR3Reset: Notifying - device '%s'/%d\n",
932 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
933 pDevIns->pDevReg->pfnReset(pDevIns);
934 }
935 }
936
937#ifdef VBOX_WITH_USB
938 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
939 {
940 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
941 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
942 if (pDrvIns->pDrvReg->pfnReset)
943 {
944 LogFlow(("PDMR3Reset: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
945 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
946 pDrvIns->pDrvReg->pfnReset(pDrvIns);
947 }
948
949 if (pUsbIns->pUsbReg->pfnVMReset)
950 {
951 LogFlow(("PDMR3Reset: Notifying - device '%s'/%d\n",
952 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
953 pUsbIns->pUsbReg->pfnVMReset(pUsbIns);
954 }
955 }
956#endif
957
958 LogFlow(("PDMR3Reset: returns void\n"));
959}
960
961
962/**
963 * This function will notify all the devices and their
964 * attached drivers about the VM now being reset.
965 *
966 * @param pVM VM Handle.
967 */
968VMMR3DECL(void) PDMR3Suspend(PVM pVM)
969{
970 LogFlow(("PDMR3Suspend:\n"));
971
972 /*
973 * Iterate the device instances.
974 * The attached drivers are processed first.
975 */
976 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
977 {
978 /*
979 * Some devices need to be notified first that the VM is suspended to ensure that that there are no pending
980 * requests from the guest which are still processed. Calling the drivers before these requests are finished
981 * might lead to errors otherwise. One example is the SATA controller which might still have I/O requests
982 * pending. But DrvVD sets the files into readonly mode and every request will fail then.
983 */
984 if (pDevIns->pDevReg->pfnSuspend && (pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION))
985 {
986 LogFlow(("PDMR3Suspend: Notifying - device '%s'/%d\n",
987 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
988 pDevIns->pDevReg->pfnSuspend(pDevIns);
989 }
990
991 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
992 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
993 if (pDrvIns->pDrvReg->pfnSuspend)
994 {
995 LogFlow(("PDMR3Suspend: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
996 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
997 pDrvIns->pDrvReg->pfnSuspend(pDrvIns);
998 }
999
1000 /* Don't call the suspend notification again if it was already called. */
1001 if (pDevIns->pDevReg->pfnSuspend && !(pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION))
1002 {
1003 LogFlow(("PDMR3Suspend: Notifying - device '%s'/%d\n",
1004 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1005 pDevIns->pDevReg->pfnSuspend(pDevIns);
1006 }
1007 }
1008
1009#ifdef VBOX_WITH_USB
1010 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1011 {
1012 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1013 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1014 if (pDrvIns->pDrvReg->pfnSuspend)
1015 {
1016 LogFlow(("PDMR3Suspend: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
1017 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1018 pDrvIns->pDrvReg->pfnSuspend(pDrvIns);
1019 }
1020
1021 if (pUsbIns->pUsbReg->pfnVMSuspend)
1022 {
1023 LogFlow(("PDMR3Suspend: Notifying - device '%s'/%d\n",
1024 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1025 pUsbIns->pUsbReg->pfnVMSuspend(pUsbIns);
1026 }
1027 }
1028#endif
1029
1030 /*
1031 * Suspend all threads.
1032 */
1033 pdmR3ThreadSuspendAll(pVM);
1034
1035 LogFlow(("PDMR3Suspend: returns void\n"));
1036}
1037
1038
1039/**
1040 * This function will notify all the devices and their
1041 * attached drivers about the VM now being resumed.
1042 *
1043 * @param pVM VM Handle.
1044 */
1045VMMR3DECL(void) PDMR3Resume(PVM pVM)
1046{
1047 LogFlow(("PDMR3Resume:\n"));
1048
1049 /*
1050 * Iterate the device instances.
1051 * The attached drivers are processed first.
1052 */
1053 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1054 {
1055 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1056 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1057 if (pDrvIns->pDrvReg->pfnResume)
1058 {
1059 LogFlow(("PDMR3Resume: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1060 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1061 pDrvIns->pDrvReg->pfnResume(pDrvIns);
1062 }
1063
1064 if (pDevIns->pDevReg->pfnResume)
1065 {
1066 LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n",
1067 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1068 pDevIns->pDevReg->pfnResume(pDevIns);
1069 }
1070 }
1071
1072#ifdef VBOX_WITH_USB
1073 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1074 {
1075 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1076 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1077 if (pDrvIns->pDrvReg->pfnResume)
1078 {
1079 LogFlow(("PDMR3Resume: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
1080 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1081 pDrvIns->pDrvReg->pfnResume(pDrvIns);
1082 }
1083
1084 if (pUsbIns->pUsbReg->pfnVMResume)
1085 {
1086 LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n",
1087 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1088 pUsbIns->pUsbReg->pfnVMResume(pUsbIns);
1089 }
1090 }
1091#endif
1092
1093 /*
1094 * Resume all threads.
1095 */
1096 pdmR3ThreadResumeAll(pVM);
1097
1098 LogFlow(("PDMR3Resume: returns void\n"));
1099}
1100
1101
1102/**
1103 * This function will notify all the devices and their
1104 * attached drivers about the VM being powered off.
1105 *
1106 * @param pVM VM Handle.
1107 */
1108VMMR3DECL(void) PDMR3PowerOff(PVM pVM)
1109{
1110 LogFlow(("PDMR3PowerOff:\n"));
1111
1112 /*
1113 * Iterate the device instances.
1114 * The attached drivers are processed first.
1115 */
1116 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1117 {
1118
1119 if (pDevIns->pDevReg->pfnPowerOff && (pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION))
1120 {
1121 LogFlow(("PDMR3PowerOff: Notifying - device '%s'/%d\n",
1122 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1123 pDevIns->pDevReg->pfnPowerOff(pDevIns);
1124 }
1125
1126 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1127 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1128 if (pDrvIns->pDrvReg->pfnPowerOff)
1129 {
1130 LogFlow(("PDMR3PowerOff: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1131 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1132 pDrvIns->pDrvReg->pfnPowerOff(pDrvIns);
1133 }
1134
1135 if (pDevIns->pDevReg->pfnPowerOff && !(pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION))
1136 {
1137 LogFlow(("PDMR3PowerOff: Notifying - device '%s'/%d\n",
1138 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1139 pDevIns->pDevReg->pfnPowerOff(pDevIns);
1140 }
1141 }
1142
1143#ifdef VBOX_WITH_USB
1144 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1145 {
1146 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1147 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1148 if (pDrvIns->pDrvReg->pfnPowerOff)
1149 {
1150 LogFlow(("PDMR3PowerOff: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
1151 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1152 pDrvIns->pDrvReg->pfnPowerOff(pDrvIns);
1153 }
1154
1155 if (pUsbIns->pUsbReg->pfnVMPowerOff)
1156 {
1157 LogFlow(("PDMR3PowerOff: Notifying - device '%s'/%d\n",
1158 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1159 pUsbIns->pUsbReg->pfnVMPowerOff(pUsbIns);
1160 }
1161 }
1162#endif
1163
1164 /*
1165 * Suspend all threads.
1166 */
1167 pdmR3ThreadSuspendAll(pVM);
1168
1169 LogFlow(("PDMR3PowerOff: returns void\n"));
1170}
1171
1172
1173/**
1174 * Queries the base interace of a device instance.
1175 *
1176 * The caller can use this to query other interfaces the device implements
1177 * and use them to talk to the device.
1178 *
1179 * @returns VBox status code.
1180 * @param pVM VM handle.
1181 * @param pszDevice Device name.
1182 * @param iInstance Device instance.
1183 * @param ppBase Where to store the pointer to the base device interface on success.
1184 * @remark We're not doing any locking ATM, so don't try call this at times when the
1185 * device chain is known to be updated.
1186 */
1187VMMR3DECL(int) PDMR3QueryDevice(PVM pVM, const char *pszDevice, unsigned iInstance, PPDMIBASE *ppBase)
1188{
1189 LogFlow(("PDMR3DeviceQuery: pszDevice=%p:{%s} iInstance=%u ppBase=%p\n", pszDevice, pszDevice, iInstance, ppBase));
1190
1191 /*
1192 * Iterate registered devices looking for the device.
1193 */
1194 size_t cchDevice = strlen(pszDevice);
1195 for (PPDMDEV pDev = pVM->pdm.s.pDevs; pDev; pDev = pDev->pNext)
1196 {
1197 if ( pDev->cchName == cchDevice
1198 && !memcmp(pDev->pDevReg->szDeviceName, pszDevice, cchDevice))
1199 {
1200 /*
1201 * Iterate device instances.
1202 */
1203 for (PPDMDEVINS pDevIns = pDev->pInstances; pDevIns; pDevIns = pDevIns->Internal.s.pPerDeviceNextR3)
1204 {
1205 if (pDevIns->iInstance == iInstance)
1206 {
1207 if (pDevIns->IBase.pfnQueryInterface)
1208 {
1209 *ppBase = &pDevIns->IBase;
1210 LogFlow(("PDMR3DeviceQuery: return VINF_SUCCESS and *ppBase=%p\n", *ppBase));
1211 return VINF_SUCCESS;
1212 }
1213
1214 LogFlow(("PDMR3DeviceQuery: returns VERR_PDM_DEVICE_INSTANCE_NO_IBASE\n"));
1215 return VERR_PDM_DEVICE_INSTANCE_NO_IBASE;
1216 }
1217 }
1218
1219 LogFlow(("PDMR3DeviceQuery: returns VERR_PDM_DEVICE_INSTANCE_NOT_FOUND\n"));
1220 return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND;
1221 }
1222 }
1223
1224 LogFlow(("PDMR3QueryDevice: returns VERR_PDM_DEVICE_NOT_FOUND\n"));
1225 return VERR_PDM_DEVICE_NOT_FOUND;
1226}
1227
1228
1229/**
1230 * Queries the base interface of a device LUN.
1231 *
1232 * This differs from PDMR3QueryLun by that it returns the interface on the
1233 * device and not the top level driver.
1234 *
1235 * @returns VBox status code.
1236 * @param pVM VM Handle.
1237 * @param pszDevice Device name.
1238 * @param iInstance Device instance.
1239 * @param iLun The Logical Unit to obtain the interface of.
1240 * @param ppBase Where to store the base interface pointer.
1241 * @remark We're not doing any locking ATM, so don't try call this at times when the
1242 * device chain is known to be updated.
1243 */
1244VMMR3DECL(int) PDMR3QueryDeviceLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
1245{
1246 LogFlow(("PDMR3QueryLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
1247 pszDevice, pszDevice, iInstance, iLun, ppBase));
1248
1249 /*
1250 * Find the LUN.
1251 */
1252 PPDMLUN pLun;
1253 int rc = pdmR3DevFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
1254 if (RT_SUCCESS(rc))
1255 {
1256 *ppBase = pLun->pBase;
1257 LogFlow(("PDMR3QueryDeviceLun: return VINF_SUCCESS and *ppBase=%p\n", *ppBase));
1258 return VINF_SUCCESS;
1259 }
1260 LogFlow(("PDMR3QueryDeviceLun: returns %Rrc\n", rc));
1261 return rc;
1262}
1263
1264
1265/**
1266 * Query the interface of the top level driver on a LUN.
1267 *
1268 * @returns VBox status code.
1269 * @param pVM VM Handle.
1270 * @param pszDevice Device name.
1271 * @param iInstance Device instance.
1272 * @param iLun The Logical Unit to obtain the interface of.
1273 * @param ppBase Where to store the base interface pointer.
1274 * @remark We're not doing any locking ATM, so don't try call this at times when the
1275 * device chain is known to be updated.
1276 */
1277VMMR3DECL(int) PDMR3QueryLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
1278{
1279 LogFlow(("PDMR3QueryLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
1280 pszDevice, pszDevice, iInstance, iLun, ppBase));
1281
1282 /*
1283 * Find the LUN.
1284 */
1285 PPDMLUN pLun;
1286 int rc = pdmR3DevFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
1287 if (RT_SUCCESS(rc))
1288 {
1289 if (pLun->pTop)
1290 {
1291 *ppBase = &pLun->pTop->IBase;
1292 LogFlow(("PDMR3QueryLun: return %Rrc and *ppBase=%p\n", VINF_SUCCESS, *ppBase));
1293 return VINF_SUCCESS;
1294 }
1295 rc = VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN;
1296 }
1297 LogFlow(("PDMR3QueryLun: returns %Rrc\n", rc));
1298 return rc;
1299}
1300
1301/**
1302 * Executes pending DMA transfers.
1303 * Forced Action handler.
1304 *
1305 * @param pVM VM handle.
1306 */
1307VMMR3DECL(void) PDMR3DmaRun(PVM pVM)
1308{
1309 VM_FF_CLEAR(pVM, VM_FF_PDM_DMA);
1310 if (pVM->pdm.s.pDmac)
1311 {
1312 bool fMore = pVM->pdm.s.pDmac->Reg.pfnRun(pVM->pdm.s.pDmac->pDevIns);
1313 if (fMore)
1314 VM_FF_SET(pVM, VM_FF_PDM_DMA);
1315 }
1316}
1317
1318
1319/**
1320 * Call polling function.
1321 *
1322 * @param pVM VM handle.
1323 */
1324VMMR3DECL(void) PDMR3Poll(PVM pVM)
1325{
1326 /* This is temporary hack and shall be removed ASAP! */
1327 unsigned iPoller = pVM->pdm.s.cPollers;
1328 if (iPoller)
1329 {
1330 while (iPoller-- > 0)
1331 pVM->pdm.s.apfnPollers[iPoller](pVM->pdm.s.aDrvInsPollers[iPoller]);
1332 TMTimerSetMillies(pVM->pdm.s.pTimerPollers, 3);
1333 }
1334}
1335
1336
1337/**
1338 * Internal timer callback function.
1339 *
1340 * @param pVM The VM.
1341 * @param pTimer The timer handle.
1342 * @param pvUser User argument specified upon timer creation.
1343 */
1344static DECLCALLBACK(void) pdmR3PollerTimer(PVM pVM, PTMTIMER pTimer, void *pvUser)
1345{
1346 PDMR3Poll(pVM);
1347}
1348
1349
1350/**
1351 * Service a VMMCALLHOST_PDM_LOCK call.
1352 *
1353 * @returns VBox status code.
1354 * @param pVM The VM handle.
1355 */
1356VMMR3DECL(int) PDMR3LockCall(PVM pVM)
1357{
1358 return PDMR3CritSectEnterEx(&pVM->pdm.s.CritSect, true /* fHostCall */);
1359}
1360
1361
1362/**
1363 * Registers the VMM device heap
1364 *
1365 * @returns VBox status code.
1366 * @param pVM VM handle.
1367 * @param GCPhys The physical address.
1368 * @param pvHeap Ring-3 pointer.
1369 * @param cbSize Size of the heap.
1370 */
1371VMMR3DECL(int) PDMR3RegisterVMMDevHeap(PVM pVM, RTGCPHYS GCPhys, RTR3PTR pvHeap, unsigned cbSize)
1372{
1373 Assert(pVM->pdm.s.pvVMMDevHeap == NULL);
1374
1375 Log(("PDMR3RegisterVMMDevHeap %RGp %RHv %x\n", GCPhys, pvHeap, cbSize));
1376 pVM->pdm.s.pvVMMDevHeap = pvHeap;
1377 pVM->pdm.s.GCPhysVMMDevHeap = GCPhys;
1378 pVM->pdm.s.cbVMMDevHeap = cbSize;
1379 pVM->pdm.s.cbVMMDevHeapLeft = cbSize;
1380 return VINF_SUCCESS;
1381}
1382
1383
1384/**
1385 * Unregisters the VMM device heap
1386 *
1387 * @returns VBox status code.
1388 * @param pVM VM handle.
1389 * @param GCPhys The physical address.
1390 */
1391VMMR3DECL(int) PDMR3UnregisterVMMDevHeap(PVM pVM, RTGCPHYS GCPhys)
1392{
1393 Assert(pVM->pdm.s.GCPhysVMMDevHeap == GCPhys);
1394
1395 Log(("PDMR3UnregisterVMMDevHeap %RGp\n", GCPhys));
1396 pVM->pdm.s.pvVMMDevHeap = NULL;
1397 pVM->pdm.s.GCPhysVMMDevHeap = NIL_RTGCPHYS;
1398 pVM->pdm.s.cbVMMDevHeap = 0;
1399 pVM->pdm.s.cbVMMDevHeapLeft = 0;
1400 return VINF_SUCCESS;
1401}
1402
1403
1404/**
1405 * Allocates memory from the VMM device heap
1406 *
1407 * @returns VBox status code.
1408 * @param pVM VM handle.
1409 * @param cbSize Allocation size.
1410 * @param pv Ring-3 pointer. (out)
1411 */
1412VMMR3DECL(int) PDMR3VMMDevHeapAlloc(PVM pVM, unsigned cbSize, RTR3PTR *ppv)
1413{
1414 AssertReturn(cbSize && cbSize <= pVM->pdm.s.cbVMMDevHeapLeft, VERR_NO_MEMORY);
1415
1416 Log(("PDMR3VMMDevHeapAlloc %x\n", cbSize));
1417
1418 /** @todo not a real heap as there's currently only one user. */
1419 *ppv = pVM->pdm.s.pvVMMDevHeap;
1420 pVM->pdm.s.cbVMMDevHeapLeft = 0;
1421 return VINF_SUCCESS;
1422}
1423
1424
1425/**
1426 * Frees memory from the VMM device heap
1427 *
1428 * @returns VBox status code.
1429 * @param pVM VM handle.
1430 * @param pv Ring-3 pointer.
1431 */
1432VMMR3DECL(int) PDMR3VMMDevHeapFree(PVM pVM, RTR3PTR pv)
1433{
1434 Log(("PDMR3VMMDevHeapFree %RHv\n", pv));
1435
1436 /** @todo not a real heap as there's currently only one user. */
1437 pVM->pdm.s.cbVMMDevHeapLeft = pVM->pdm.s.cbVMMDevHeap;
1438 return VINF_SUCCESS;
1439}
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use