VirtualBox

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

Last change on this file since 18617 was 18616, checked in by vboxsync, 16 years ago

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