VirtualBox

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

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

Prevent future mistakes with VM_FF_TESTANDCLEAR
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 51.9 KB
Line 
1/* $Id: PDM.cpp 21144 2009-07-02 08:07:39Z vboxsync $ */
2/** @file
3 * PDM - Pluggable Device Manager.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18 * Clara, CA 95054 USA or visit http://www.sun.com if you need
19 * additional information or have any questions.
20 */
21
22
23/** @page pg_pdm PDM - The Pluggable Device & Driver Manager
24 *
25 * VirtualBox is designed to be very configurable, i.e. the ability to select
26 * virtual devices and configure them uniquely for a VM. For this reason
27 * virtual devices are not statically linked with the VMM but loaded, linked and
28 * instantiated at runtime by PDM using the information found in the
29 * Configuration Manager (CFGM).
30 *
31 * While the chief purpose of PDM is to manager of devices their drivers, it
32 * also serves as somewhere to put usful things like cross context queues, cross
33 * context synchronization (like critsect), VM centric thread management,
34 * asynchronous I/O framework, and so on.
35 *
36 * @see grp_pdm
37 *
38 *
39 * @section sec_pdm_dev The Pluggable Devices
40 *
41 * Devices register themselves when the module containing them is loaded. PDM
42 * will call the entry point 'VBoxDevicesRegister' when loading a device module.
43 * The device module will then use the supplied callback table to check the VMM
44 * version and to register its devices. Each device have an unique (for the
45 * configured VM) name. The name is not only used in PDM but also in CFGM (to
46 * organize device and device instance settings) and by anyone who wants to talk
47 * to a specific device instance.
48 *
49 * When all device modules have been successfully loaded PDM will instantiate
50 * those devices which are configured for the VM. Note that a device may have
51 * more than one instance, see network adaptors for instance. When
52 * instantiating a device PDM provides device instance memory and a callback
53 * table (aka Device Helpers / DevHlp) with the VM APIs which the device
54 * instance is trusted with.
55 *
56 * Some devices are trusted devices, most are not. The trusted devices are an
57 * integrated part of the VM and can obtain the VM handle from their device
58 * instance handles, thus enabling them to call any VM api. Untrusted devices
59 * can only use the callbacks provided during device instantiation.
60 *
61 * The main purpose in having DevHlps rather than just giving all the devices
62 * the VM handle and let them call the internal VM APIs directly, is both to
63 * create a binary interface that can be supported accross releases and to
64 * create a barrier between devices and the VM. (The trusted / untrusted bit
65 * hasn't turned out to be of much use btw., but it's easy to maintain so there
66 * isn't any point in removing it.)
67 *
68 * A device can provide a ring-0 and/or a raw-mode context extension to improve
69 * the VM performance by handling exits and traps (respectively) without
70 * requiring context switches (to ring-3). Callbacks for MMIO and I/O ports can
71 * needs to be registered specifically for the additional contexts for this to
72 * make sense. Also, the device has to be trusted to be loaded into R0/RC
73 * because of the extra privilege it entails. Note that raw-mode code and data
74 * will be subject to relocation.
75 *
76 *
77 * @section sec_pdm_special_devs Special Devices
78 *
79 * Several kinds of devices interacts with the VMM and/or other device and PDM
80 * will work like a mediator for these. The typical pattern is that the device
81 * calls a special registration device helper with a set of callbacks, PDM
82 * responds by copying this and providing a pointer to a set helper callbacks
83 * for that particular kind of device. Unlike interfaces where the callback
84 * table pointer is used a 'this' pointer, these arrangements will use the
85 * device instance pointer (PPDMDEVINS) as a kind of 'this' pointer.
86 *
87 * For an example of this kind of setup, see the PIC. The PIC registers itself
88 * by calling PDMDEVHLPR3::pfnPICRegister. PDM saves the device instance,
89 * copies the callback tables (PDMPICREG), resolving the ring-0 and raw-mode
90 * addresses in the process, and hands back the pointer to a set of helper
91 * methods (PDMPICHLPR3). The PCI device then queries the ring-0 and raw-mode
92 * helpers using PDMPICHLPR3::pfnGetR0Helpers and PDMPICHLPR3::pfnGetRCHelpers.
93 * The PCI device repeates ths pfnGetRCHelpers call in it's relocation method
94 * since the address changes when RC is relocated.
95 *
96 * @see grp_pdm_device
97 *
98 *
99 * @section sec_pdm_usbdev The Pluggable USB Devices
100 *
101 * USB devices are handled a little bit differently than other devices. The
102 * general concepts wrt. pluggability are mostly the same, but the details
103 * varies. The registration entry point is 'VBoxUsbRegister', the device
104 * instance is PDMUSBINS and the callbacks helpers are different. Also, USB
105 * device are restricted to ring-3 and cannot have any ring-0 or raw-mode
106 * extensions (at least not yet).
107 *
108 * The way USB devices work differs greatly from other devices though since they
109 * aren't attaches directly to the PCI/ISA/whatever system buses but via a
110 * USB host control (OHCI, UHCI or EHCI). USB devices handles USB requests
111 * (URBs) and does not register I/O ports, MMIO ranges or PCI bus
112 * devices/functions.
113 *
114 * @see grp_pdm_usbdev
115 *
116 *
117 * @section sec_pdm_drv The Pluggable Drivers
118 *
119 * The VM devices are often accessing host hardware or OS facilities. For most
120 * devices these facilities can be abstracted in one or more levels. These
121 * abstractions are called drivers.
122 *
123 * For instance take a DVD/CD drive. This can be connected to a SCSI
124 * controller, an ATA controller or a SATA controller. The basics of the DVD/CD
125 * drive implementation remains the same - eject, insert, read, seek, and such.
126 * (For the scsi case, you might wanna speak SCSI directly to, but that can of
127 * course be fixed - see SCSI passthru.) So, it
128 * makes much sense to have a generic CD/DVD driver which implements this.
129 *
130 * Then the media 'inserted' into the DVD/CD drive can be a ISO image, or it can
131 * be read from a real CD or DVD drive (there are probably other custom formats
132 * someone could desire to read or construct too). So, it would make sense to
133 * have abstracted interfaces for dealing with this in a generic way so the
134 * cdrom unit doesn't have to implement it all. Thus we have created the
135 * CDROM/DVD media driver family.
136 *
137 * So, for this example the IDE controller #1 (i.e. secondary) will have
138 * the DVD/CD Driver attached to it's LUN #0 (master). When a media is mounted
139 * the DVD/CD Driver will have a ISO, HostDVD or RAW (media) Driver attached.
140 *
141 * It is possible to configure many levels of drivers inserting filters, loggers,
142 * or whatever you desire into the chain. We're using this for network sniffing
143 * for instance.
144 *
145 * The drivers are loaded in a similar manner to that of the device, namely by
146 * iterating a keyspace in CFGM, load the modules listed there and call
147 * 'VBoxDriversRegister' with a callback table.
148 *
149 * @see grp_pdm_driver
150 *
151 *
152 * @section sec_pdm_ifs Interfaces
153 *
154 * The pluggable drivers and devices exposes one standard interface (callback
155 * table) which is used to construct, destruct, attach, detach,( ++,) and query
156 * other interfaces. A device will query the interfaces required for it's
157 * operation during init and hotplug. PDM may query some interfaces during
158 * runtime mounting too.
159 *
160 * An interface here means a function table contained within the device or
161 * driver instance data. Its method are invoked with the function table pointer
162 * as the first argument and they will calculate the address of the device or
163 * driver instance data from it. (This is one of the aspects which *might* have
164 * been better done in C++.)
165 *
166 * @see grp_pdm_interfaces
167 *
168 *
169 * @section sec_pdm_utils Utilities
170 *
171 * As mentioned earlier, PDM is the location of any usful constrcts that doesn't
172 * quite fit into IPRT. The next subsections will discuss these.
173 *
174 * One thing these APIs all have in common is that resources will be associated
175 * with a device / driver and automatically freed after it has been destroyed if
176 * the destructor didn't do this.
177 *
178 *
179 * @subsection sec_pdm_async_completion Async I/O
180 *
181 * The PDM Async I/O API provides a somewhat platform agnostic interface for
182 * asynchronous I/O. For reasons of performance and complexcity this does not
183 * build upon any IPRT API.
184 *
185 * @todo more details.
186 *
187 * @see grp_pdm_async_completion
188 *
189 *
190 * @subsection sec_pdm_async_task Async Task - not implemented
191 *
192 * @todo implement and describe
193 *
194 * @see grp_pdm_async_task
195 *
196 *
197 * @subsection sec_pdm_critsect Critical Section
198 *
199 * The PDM Critical Section API is currently building on the IPRT API with the
200 * same name. It adds the posibility to use critical sections in ring-0 and
201 * raw-mode as well as in ring-3. There are certain restrictions on the RC and
202 * R0 usage though since we're not able to wait on it, nor wake up anyone that
203 * is waiting on it. These restrictions origins with the use of a ring-3 event
204 * semaphore. In a later incarnation we plan to replace the ring-3 event
205 * semaphore with a ring-0 one, thus enabling us to wake up waiters while
206 * exectuing in ring-0 and making the hardware assisted execution mode more
207 * efficient. (Raw-mode won't benefit much from this, naturally.)
208 *
209 * @see grp_pdm_critsect
210 *
211 *
212 * @subsection sec_pdm_queue Queue
213 *
214 * The PDM Queue API is for queuing one or more tasks for later consumption in
215 * ring-3 by EMT, and optinally forcing a delayed or ASAP return to ring-3. The
216 * queues can also be run on a timer basis as an alternative to the ASAP thing.
217 * The queue will be flushed at forced action time.
218 *
219 * A queue can also be used by another thread (a I/O worker for instance) to
220 * send work / events over to the EMT.
221 *
222 * @see grp_pdm_queue
223 *
224 *
225 * @subsection sec_pdm_task Task - not implemented yet
226 *
227 * The PDM Task API is for flagging a task for execution at a later point when
228 * we're back in ring-3, optionally forcing the ring-3 return to happen ASAP.
229 * As you can see the concept is similar to queues only simpler.
230 *
231 * A task can also be scheduled by another thread (a I/O worker for instance) as
232 * a mean of getting something done in EMT.
233 *
234 * @see grp_pdm_task
235 *
236 *
237 * @subsection sec_pdm_thread Thread
238 *
239 * The PDM Thread API is there to help devices and drivers manage their threads
240 * correctly wrt. power on, suspend, resume, power off and destruction.
241 *
242 * The general usage pattern for threads in the employ of devices and drivers is
243 * that they shuffle data or requests while the VM is running and stop doing
244 * this when the VM is paused or powered down. Rogue threads running while the
245 * VM is paused can cause the state to change during saving or have other
246 * unwanted side effects. The PDM Threads API ensures that this won't happen.
247 *
248 * @see grp_pdm_thread
249 *
250 */
251
252
253/*******************************************************************************
254* Header Files *
255*******************************************************************************/
256#define LOG_GROUP LOG_GROUP_PDM
257#include "PDMInternal.h"
258#include <VBox/pdm.h>
259#include <VBox/mm.h>
260#include <VBox/pgm.h>
261#include <VBox/ssm.h>
262#include <VBox/vm.h>
263#include <VBox/uvm.h>
264#include <VBox/vmm.h>
265#include <VBox/param.h>
266#include <VBox/err.h>
267#include <VBox/sup.h>
268
269#include <VBox/log.h>
270#include <iprt/asm.h>
271#include <iprt/assert.h>
272#include <iprt/alloc.h>
273#include <iprt/ldr.h>
274#include <iprt/path.h>
275#include <iprt/string.h>
276
277
278/*******************************************************************************
279* Defined Constants And Macros *
280*******************************************************************************/
281/** The PDM saved state version. */
282#define PDM_SAVED_STATE_VERSION 4
283#define PDM_SAVED_STATE_VERSION_PRE_NMI_FF 3
284
285
286/*******************************************************************************
287* Internal Functions *
288*******************************************************************************/
289static DECLCALLBACK(int) pdmR3Save(PVM pVM, PSSMHANDLE pSSM);
290static DECLCALLBACK(int) pdmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t u32Version);
291static DECLCALLBACK(int) pdmR3LoadPrep(PVM pVM, PSSMHANDLE pSSM);
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 AssertCompileMemberAlignment(PDM, CritSect, sizeof(uintptr_t));
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 /*
336 * Initialize sub compontents.
337 */
338 int rc = RTCritSectInit(&pVM->pdm.s.MiscCritSect);
339 if (RT_SUCCESS(rc))
340 rc = pdmR3CritSectInit(pVM);
341 if (RT_SUCCESS(rc))
342 rc = PDMR3CritSectInit(pVM, &pVM->pdm.s.CritSect, "PDM");
343 if (RT_SUCCESS(rc))
344 rc = pdmR3LdrInitU(pVM->pUVM);
345#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
346 if (RT_SUCCESS(rc))
347 rc = pdmR3AsyncCompletionInit(pVM);
348#endif
349 if (RT_SUCCESS(rc))
350 rc = pdmR3DrvInit(pVM);
351 if (RT_SUCCESS(rc))
352 rc = pdmR3DevInit(pVM);
353 if (RT_SUCCESS(rc))
354 {
355 /*
356 * Register the saved state data unit.
357 */
358 rc = SSMR3RegisterInternal(pVM, "pdm", 1, PDM_SAVED_STATE_VERSION, 128,
359 NULL, pdmR3Save, NULL,
360 pdmR3LoadPrep, pdmR3Load, NULL);
361 if (RT_SUCCESS(rc))
362 {
363 LogFlow(("PDM: Successfully initialized\n"));
364 return rc;
365 }
366 }
367
368 /*
369 * Cleanup and return failure.
370 */
371 PDMR3Term(pVM);
372 LogFlow(("PDMR3Init: returns %Rrc\n", rc));
373 return rc;
374}
375
376
377/**
378 * Applies relocations to data and code managed by this
379 * component. This function will be called at init and
380 * whenever the VMM need to relocate it self inside the GC.
381 *
382 * @param pVM VM handle.
383 * @param offDelta Relocation delta relative to old location.
384 * @remark The loader subcomponent is relocated by PDMR3LdrRelocate() very
385 * early in the relocation phase.
386 */
387VMMR3DECL(void) PDMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
388{
389 LogFlow(("PDMR3Relocate\n"));
390
391 /*
392 * Queues.
393 */
394 pdmR3QueueRelocate(pVM, offDelta);
395 pVM->pdm.s.pDevHlpQueueRC = PDMQueueRCPtr(pVM->pdm.s.pDevHlpQueueR3);
396
397 /*
398 * Critical sections.
399 */
400 pdmR3CritSectRelocate(pVM);
401
402 /*
403 * The registered PIC.
404 */
405 if (pVM->pdm.s.Pic.pDevInsRC)
406 {
407 pVM->pdm.s.Pic.pDevInsRC += offDelta;
408 pVM->pdm.s.Pic.pfnSetIrqRC += offDelta;
409 pVM->pdm.s.Pic.pfnGetInterruptRC += offDelta;
410 }
411
412 /*
413 * The registered APIC.
414 */
415 if (pVM->pdm.s.Apic.pDevInsRC)
416 {
417 pVM->pdm.s.Apic.pDevInsRC += offDelta;
418 pVM->pdm.s.Apic.pfnGetInterruptRC += offDelta;
419 pVM->pdm.s.Apic.pfnSetBaseRC += offDelta;
420 pVM->pdm.s.Apic.pfnGetBaseRC += offDelta;
421 pVM->pdm.s.Apic.pfnSetTPRRC += offDelta;
422 pVM->pdm.s.Apic.pfnGetTPRRC += offDelta;
423 pVM->pdm.s.Apic.pfnBusDeliverRC += offDelta;
424 pVM->pdm.s.Apic.pfnWriteMSRRC += offDelta;
425 pVM->pdm.s.Apic.pfnReadMSRRC += offDelta;
426 }
427
428 /*
429 * The registered I/O APIC.
430 */
431 if (pVM->pdm.s.IoApic.pDevInsRC)
432 {
433 pVM->pdm.s.IoApic.pDevInsRC += offDelta;
434 pVM->pdm.s.IoApic.pfnSetIrqRC += offDelta;
435 }
436
437 /*
438 * The register PCI Buses.
439 */
440 for (unsigned i = 0; i < RT_ELEMENTS(pVM->pdm.s.aPciBuses); i++)
441 {
442 if (pVM->pdm.s.aPciBuses[i].pDevInsRC)
443 {
444 pVM->pdm.s.aPciBuses[i].pDevInsRC += offDelta;
445 pVM->pdm.s.aPciBuses[i].pfnSetIrqRC += offDelta;
446 }
447 }
448
449 /*
450 * Devices.
451 */
452 PCPDMDEVHLPRC pDevHlpRC;
453 int rc = PDMR3LdrGetSymbolRC(pVM, NULL, "g_pdmRCDevHlp", &pDevHlpRC);
454 AssertReleaseMsgRC(rc, ("rc=%Rrc when resolving g_pdmRCDevHlp\n", rc));
455 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
456 {
457 if (pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_RC)
458 {
459 pDevIns->pDevHlpRC = pDevHlpRC;
460 pDevIns->pvInstanceDataRC = MMHyperR3ToRC(pVM, pDevIns->pvInstanceDataR3);
461 pDevIns->Internal.s.pVMRC = pVM->pVMRC;
462 if (pDevIns->Internal.s.pPciBusR3)
463 pDevIns->Internal.s.pPciBusRC = MMHyperR3ToRC(pVM, pDevIns->Internal.s.pPciBusR3);
464 if (pDevIns->Internal.s.pPciDeviceR3)
465 pDevIns->Internal.s.pPciDeviceRC = MMHyperR3ToRC(pVM, pDevIns->Internal.s.pPciDeviceR3);
466 if (pDevIns->pDevReg->pfnRelocate)
467 {
468 LogFlow(("PDMR3Relocate: Relocating device '%s'/%d\n",
469 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
470 pDevIns->pDevReg->pfnRelocate(pDevIns, offDelta);
471 }
472 }
473 }
474}
475
476
477/**
478 * Worker for pdmR3Term that terminates a LUN chain.
479 *
480 * @param pVM Pointer to the shared VM structure.
481 * @param pLun The head of the chain.
482 * @param pszDevice The name of the device (for logging).
483 * @param iInstance The device instance number (for logging).
484 */
485static void pdmR3TermLuns(PVM pVM, PPDMLUN pLun, const char *pszDevice, unsigned iInstance)
486{
487 for (; pLun; pLun = pLun->pNext)
488 {
489 /*
490 * Destroy them one at a time from the bottom up.
491 * (The serial device/drivers depends on this - bad.)
492 */
493 PPDMDRVINS pDrvIns = pLun->pBottom;
494 pLun->pBottom = pLun->pTop = NULL;
495 while (pDrvIns)
496 {
497 PPDMDRVINS pDrvNext = pDrvIns->Internal.s.pUp;
498
499 if (pDrvIns->pDrvReg->pfnDestruct)
500 {
501 LogFlow(("pdmR3DevTerm: Destroying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
502 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pszDevice, iInstance));
503 pDrvIns->pDrvReg->pfnDestruct(pDrvIns);
504 }
505
506 TMR3TimerDestroyDriver(pVM, pDrvIns);
507 //PDMR3QueueDestroyDriver(pVM, pDrvIns);
508 //pdmR3ThreadDestroyDriver(pVM, pDrvIns);
509 SSMR3DeregisterDriver(pVM, pDrvIns, NULL, 0);
510
511 pDrvIns = pDrvNext;
512 }
513 }
514}
515
516
517/**
518 * Terminates the PDM.
519 *
520 * Termination means cleaning up and freeing all resources,
521 * the VM it self is at this point powered off or suspended.
522 *
523 * @returns VBox status code.
524 * @param pVM The VM to operate on.
525 */
526VMMR3DECL(int) PDMR3Term(PVM pVM)
527{
528 LogFlow(("PDMR3Term:\n"));
529 AssertMsg(pVM->pdm.s.offVM, ("bad init order!\n"));
530
531 /*
532 * Iterate the device instances and attach drivers, doing
533 * relevant destruction processing.
534 *
535 * N.B. There is no need to mess around freeing memory allocated
536 * from any MM heap since MM will do that in its Term function.
537 */
538 /* usb ones first. */
539 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
540 {
541 pdmR3TermLuns(pVM, pUsbIns->Internal.s.pLuns, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance);
542
543 if (pUsbIns->pUsbReg->pfnDestruct)
544 {
545 LogFlow(("pdmR3DevTerm: Destroying - device '%s'/%d\n",
546 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
547 pUsbIns->pUsbReg->pfnDestruct(pUsbIns);
548 }
549
550 //TMR3TimerDestroyUsb(pVM, pUsbIns);
551 //SSMR3DeregisterUsb(pVM, pUsbIns, NULL, 0);
552 pdmR3ThreadDestroyUsb(pVM, pUsbIns);
553 }
554
555 /* then the 'normal' ones. */
556 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
557 {
558 pdmR3TermLuns(pVM, pDevIns->Internal.s.pLunsR3, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance);
559
560 if (pDevIns->pDevReg->pfnDestruct)
561 {
562 LogFlow(("pdmR3DevTerm: Destroying - device '%s'/%d\n",
563 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
564 pDevIns->pDevReg->pfnDestruct(pDevIns);
565 }
566
567 TMR3TimerDestroyDevice(pVM, pDevIns);
568 //SSMR3DeregisterDriver(pVM, pDevIns, NULL, 0);
569 pdmR3CritSectDeleteDevice(pVM, pDevIns);
570 //pdmR3ThreadDestroyDevice(pVM, pDevIns);
571 //PDMR3QueueDestroyDevice(pVM, pDevIns);
572 PGMR3PhysMMIO2Deregister(pVM, pDevIns, UINT32_MAX);
573 }
574
575 /*
576 * Destroy all threads.
577 */
578 pdmR3ThreadDestroyAll(pVM);
579
580#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
581 /*
582 * Free async completion managers.
583 */
584 pdmR3AsyncCompletionTerm(pVM);
585#endif
586
587 /*
588 * Free modules.
589 */
590 pdmR3LdrTermU(pVM->pUVM);
591
592 /*
593 * Destroy the PDM lock.
594 */
595 PDMR3CritSectDelete(&pVM->pdm.s.CritSect);
596 /* The MiscCritSect is deleted by PDMR3CritSectTerm. */
597
598 LogFlow(("PDMR3Term: returns %Rrc\n", VINF_SUCCESS));
599 return VINF_SUCCESS;
600}
601
602
603/**
604 * Terminates the PDM part of the UVM.
605 *
606 * This will unload any modules left behind.
607 *
608 * @param pUVM Pointer to the user mode VM structure.
609 */
610VMMR3DECL(void) PDMR3TermUVM(PUVM pUVM)
611{
612 /*
613 * In the normal cause of events we will now call pdmR3LdrTermU for
614 * the second time. In the case of init failure however, this might
615 * the first time, which is why we do it.
616 */
617 pdmR3LdrTermU(pUVM);
618}
619
620
621
622
623
624/**
625 * Execute state save operation.
626 *
627 * @returns VBox status code.
628 * @param pVM VM Handle.
629 * @param pSSM SSM operation handle.
630 */
631static DECLCALLBACK(int) pdmR3Save(PVM pVM, PSSMHANDLE pSSM)
632{
633 LogFlow(("pdmR3Save:\n"));
634
635 /*
636 * Save interrupt and DMA states.
637 */
638 for (unsigned idCpu = 0; idCpu < pVM->cCPUs; idCpu++)
639 {
640 PVMCPU pVCpu = &pVM->aCpus[idCpu];
641 SSMR3PutUInt(pSSM, VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_APIC));
642 SSMR3PutUInt(pSSM, VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_PIC));
643 SSMR3PutUInt(pSSM, VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_NMI));
644 SSMR3PutUInt(pSSM, VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_SMI));
645 }
646 SSMR3PutUInt(pSSM, VM_FF_ISSET(pVM, VM_FF_PDM_DMA));
647
648 /*
649 * Save the list of device instances so we can check that
650 * they're all still there when we load the state and that
651 * nothing new have been added.
652 */
653 /** @todo We might have to filter out some device classes, like USB attached devices. */
654 uint32_t i = 0;
655 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3, i++)
656 {
657 SSMR3PutU32(pSSM, i);
658 SSMR3PutStrZ(pSSM, pDevIns->pDevReg->szDeviceName);
659 SSMR3PutU32(pSSM, pDevIns->iInstance);
660 }
661 return SSMR3PutU32(pSSM, ~0); /* terminator */
662}
663
664
665/**
666 * Prepare state load operation.
667 *
668 * This will dispatch pending operations and clear the FFs governed by PDM and its devices.
669 *
670 * @returns VBox status code.
671 * @param pVM The VM handle.
672 * @param pSSM The SSM handle.
673 */
674static DECLCALLBACK(int) pdmR3LoadPrep(PVM pVM, PSSMHANDLE pSSM)
675{
676 LogFlow(("pdmR3LoadPrep: %s%s%s%s\n",
677 VM_FF_ISSET(pVM, VM_FF_PDM_QUEUES) ? " VM_FF_PDM_QUEUES" : "",
678 VM_FF_ISSET(pVM, VM_FF_PDM_DMA) ? " VM_FF_PDM_DMA" : ""
679 ));
680#ifdef LOG_ENABLED
681 for (unsigned idCpu=0;idCpu<pVM->cCPUs;idCpu++)
682 {
683 PVMCPU pVCpu = &pVM->aCpus[idCpu];
684 LogFlow(("pdmR3LoadPrep: VCPU %d %s%s%s%s\n", idCpu,
685 VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_APIC) ? " VMCPU_FF_INTERRUPT_APIC" : "",
686 VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_PIC) ? " VMCPU_FF_INTERRUPT_PIC" : ""
687 ));
688 }
689#endif
690
691 /*
692 * In case there is work pending that will raise an interrupt,
693 * start a DMA transfer, or release a lock. (unlikely)
694 */
695 if (VM_FF_ISSET(pVM, VM_FF_PDM_QUEUES))
696 PDMR3QueueFlushAll(pVM);
697
698 /* Clear the FFs. */
699 for (unsigned idCpu=0;idCpu<pVM->cCPUs;idCpu++)
700 {
701 PVMCPU pVCpu = &pVM->aCpus[idCpu];
702 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_APIC);
703 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_PIC);
704 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_NMI);
705 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_SMI);
706 }
707 VM_FF_CLEAR(pVM, VM_FF_PDM_DMA);
708
709 return VINF_SUCCESS;
710}
711
712
713/**
714 * Execute state load operation.
715 *
716 * @returns VBox status code.
717 * @param pVM VM Handle.
718 * @param pSSM SSM operation handle.
719 * @param u32Version Data layout version.
720 */
721static DECLCALLBACK(int) pdmR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t u32Version)
722{
723 int rc;
724
725 LogFlow(("pdmR3Load:\n"));
726
727 /*
728 * Validate version.
729 */
730 if ( u32Version != PDM_SAVED_STATE_VERSION
731 && u32Version != PDM_SAVED_STATE_VERSION_PRE_NMI_FF)
732 {
733 AssertMsgFailed(("pdmR3Load: Invalid version u32Version=%d!\n", u32Version));
734 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
735 }
736
737 /*
738 * Load the interrupt and DMA states.
739 */
740 for (unsigned idCpu = 0; idCpu < pVM->cCPUs; idCpu++)
741 {
742 PVMCPU pVCpu = &pVM->aCpus[idCpu];
743
744 /* APIC interrupt */
745 RTUINT fInterruptPending = 0;
746 rc = SSMR3GetUInt(pSSM, &fInterruptPending);
747 if (RT_FAILURE(rc))
748 return rc;
749 if (fInterruptPending & ~1)
750 {
751 AssertMsgFailed(("fInterruptPending=%#x (APIC)\n", fInterruptPending));
752 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
753 }
754 AssertRelease(!VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_APIC));
755 if (fInterruptPending)
756 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_APIC);
757
758 /* PIC interrupt */
759 fInterruptPending = 0;
760 rc = SSMR3GetUInt(pSSM, &fInterruptPending);
761 if (RT_FAILURE(rc))
762 return rc;
763 if (fInterruptPending & ~1)
764 {
765 AssertMsgFailed(("fInterruptPending=%#x (PIC)\n", fInterruptPending));
766 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
767 }
768 AssertRelease(!VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_PIC));
769 if (fInterruptPending)
770 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_PIC);
771
772 if (u32Version > PDM_SAVED_STATE_VERSION_PRE_NMI_FF)
773 {
774 /* NMI interrupt */
775 RTUINT fInterruptPending = 0;
776 rc = SSMR3GetUInt(pSSM, &fInterruptPending);
777 if (RT_FAILURE(rc))
778 return rc;
779 if (fInterruptPending & ~1)
780 {
781 AssertMsgFailed(("fInterruptPending=%#x (NMI)\n", fInterruptPending));
782 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
783 }
784 AssertRelease(!VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_NMI));
785 if (fInterruptPending)
786 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_NMI);
787
788 /* SMI interrupt */
789 fInterruptPending = 0;
790 rc = SSMR3GetUInt(pSSM, &fInterruptPending);
791 if (RT_FAILURE(rc))
792 return rc;
793 if (fInterruptPending & ~1)
794 {
795 AssertMsgFailed(("fInterruptPending=%#x (SMI)\n", fInterruptPending));
796 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
797 }
798 AssertRelease(!VMCPU_FF_ISSET(pVCpu, VMCPU_FF_INTERRUPT_SMI));
799 if (fInterruptPending)
800 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_SMI);
801 }
802 }
803
804 /* DMA pending */
805 RTUINT fDMAPending = 0;
806 rc = SSMR3GetUInt(pSSM, &fDMAPending);
807 if (RT_FAILURE(rc))
808 return rc;
809 if (fDMAPending & ~1)
810 {
811 AssertMsgFailed(("fDMAPending=%#x\n", fDMAPending));
812 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
813 }
814 AssertRelease(!VM_FF_ISSET(pVM, VM_FF_PDM_DMA));
815 if (fDMAPending)
816 VM_FF_SET(pVM, VM_FF_PDM_DMA);
817
818 /*
819 * Load the list of devices and verify that they are all there.
820 *
821 * We boldly ASSUME that the order is fixed and that it's a good, this
822 * makes it way easier to validate...
823 */
824 uint32_t i = 0;
825 PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances;
826 for (;;pDevIns = pDevIns->Internal.s.pNextR3, i++)
827 {
828 /* Get the separator / terminator. */
829 uint32_t u32Sep;
830 int rc = SSMR3GetU32(pSSM, &u32Sep);
831 if (RT_FAILURE(rc))
832 return rc;
833 if (u32Sep == (uint32_t)~0)
834 break;
835 if (u32Sep != i)
836 AssertMsgFailedReturn(("Out of seqence. u32Sep=%#x i=%#x\n", u32Sep, i), VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
837
838 /* get the name and instance number. */
839 char szDeviceName[sizeof(pDevIns->pDevReg->szDeviceName)];
840 rc = SSMR3GetStrZ(pSSM, szDeviceName, sizeof(szDeviceName));
841 if (RT_FAILURE(rc))
842 return rc;
843 RTUINT iInstance;
844 rc = SSMR3GetUInt(pSSM, &iInstance);
845 if (RT_FAILURE(rc))
846 return rc;
847
848 /* compare */
849 if (!pDevIns)
850 {
851 LogRel(("Device '%s'/%d not found in current config\n", szDeviceName, iInstance));
852 if (SSMR3HandleGetAfter(pSSM) != SSMAFTER_DEBUG_IT)
853 AssertFailedReturn(VERR_SSM_LOAD_CONFIG_MISMATCH);
854 break;
855 }
856 if ( strcmp(szDeviceName, pDevIns->pDevReg->szDeviceName)
857 || pDevIns->iInstance != iInstance)
858 {
859 LogRel(("u32Sep=%d loaded '%s'/%d configured '%s'/%d\n",
860 u32Sep, szDeviceName, iInstance, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
861 if (SSMR3HandleGetAfter(pSSM) != SSMAFTER_DEBUG_IT)
862 AssertFailedReturn(VERR_SSM_LOAD_CONFIG_MISMATCH);
863 }
864 }
865
866 /*
867 * Too many devices?
868 */
869 if (pDevIns)
870 {
871 LogRel(("Device '%s'/%d not found in saved state\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
872 if (SSMR3HandleGetAfter(pSSM) != SSMAFTER_DEBUG_IT)
873 AssertFailedReturn(VERR_SSM_LOAD_CONFIG_MISMATCH);
874 }
875
876 return VINF_SUCCESS;
877}
878
879
880/**
881 * This function will notify all the devices and their
882 * attached drivers about the VM now being powered on.
883 *
884 * @param pVM VM Handle.
885 */
886VMMR3DECL(void) PDMR3PowerOn(PVM pVM)
887{
888 LogFlow(("PDMR3PowerOn:\n"));
889
890 /*
891 * Iterate the device instances.
892 * The attached drivers are processed first.
893 */
894 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
895 {
896 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
897 /** @todo Inverse the order here? */
898 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
899 if (pDrvIns->pDrvReg->pfnPowerOn)
900 {
901 LogFlow(("PDMR3PowerOn: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
902 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
903 pDrvIns->pDrvReg->pfnPowerOn(pDrvIns);
904 }
905
906 if (pDevIns->pDevReg->pfnPowerOn)
907 {
908 LogFlow(("PDMR3PowerOn: Notifying - device '%s'/%d\n",
909 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
910 pDevIns->pDevReg->pfnPowerOn(pDevIns);
911 }
912 }
913
914#ifdef VBOX_WITH_USB
915 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
916 {
917 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
918 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
919 if (pDrvIns->pDrvReg->pfnPowerOn)
920 {
921 LogFlow(("PDMR3PowerOn: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
922 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
923 pDrvIns->pDrvReg->pfnPowerOn(pDrvIns);
924 }
925
926 if (pUsbIns->pUsbReg->pfnVMPowerOn)
927 {
928 LogFlow(("PDMR3PowerOn: Notifying - device '%s'/%d\n",
929 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
930 pUsbIns->pUsbReg->pfnVMPowerOn(pUsbIns);
931 }
932 }
933#endif
934
935 /*
936 * Resume all threads.
937 */
938 pdmR3ThreadResumeAll(pVM);
939
940 LogFlow(("PDMR3PowerOn: returns void\n"));
941}
942
943
944
945
946/**
947 * This function will notify all the devices and their
948 * attached drivers about the VM now being reset.
949 *
950 * @param pVM VM Handle.
951 */
952VMMR3DECL(void) PDMR3Reset(PVM pVM)
953{
954 LogFlow(("PDMR3Reset:\n"));
955
956 /*
957 * Clear all pending interrupts and DMA operations.
958 */
959 for (unsigned idCpu=0;idCpu<pVM->cCPUs;idCpu++)
960 {
961 PVMCPU pVCpu = &pVM->aCpus[idCpu];
962 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_APIC);
963 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_PIC);
964 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_NMI);
965 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_SMI);
966 }
967 VM_FF_CLEAR(pVM, VM_FF_PDM_DMA);
968
969 /*
970 * Iterate the device instances.
971 * The attached drivers are processed first.
972 */
973 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
974 {
975 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
976 /** @todo Inverse the order here? */
977 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
978 if (pDrvIns->pDrvReg->pfnReset)
979 {
980 LogFlow(("PDMR3Reset: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
981 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
982 pDrvIns->pDrvReg->pfnReset(pDrvIns);
983 }
984
985 if (pDevIns->pDevReg->pfnReset)
986 {
987 LogFlow(("PDMR3Reset: Notifying - device '%s'/%d\n",
988 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
989 pDevIns->pDevReg->pfnReset(pDevIns);
990 }
991 }
992
993#ifdef VBOX_WITH_USB
994 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
995 {
996 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
997 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
998 if (pDrvIns->pDrvReg->pfnReset)
999 {
1000 LogFlow(("PDMR3Reset: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
1001 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1002 pDrvIns->pDrvReg->pfnReset(pDrvIns);
1003 }
1004
1005 if (pUsbIns->pUsbReg->pfnVMReset)
1006 {
1007 LogFlow(("PDMR3Reset: Notifying - device '%s'/%d\n",
1008 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1009 pUsbIns->pUsbReg->pfnVMReset(pUsbIns);
1010 }
1011 }
1012#endif
1013
1014 LogFlow(("PDMR3Reset: returns void\n"));
1015}
1016
1017
1018/**
1019 * This function will notify all the devices and their
1020 * attached drivers about the VM now being reset.
1021 *
1022 * @param pVM VM Handle.
1023 */
1024VMMR3DECL(void) PDMR3Suspend(PVM pVM)
1025{
1026 LogFlow(("PDMR3Suspend:\n"));
1027
1028 /*
1029 * Iterate the device instances.
1030 * The attached drivers are processed first.
1031 */
1032 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1033 {
1034 /*
1035 * Some devices need to be notified first that the VM is suspended to ensure that that there are no pending
1036 * requests from the guest which are still processed. Calling the drivers before these requests are finished
1037 * might lead to errors otherwise. One example is the SATA controller which might still have I/O requests
1038 * pending. But DrvVD sets the files into readonly mode and every request will fail then.
1039 */
1040 if (pDevIns->pDevReg->pfnSuspend && (pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION))
1041 {
1042 LogFlow(("PDMR3Suspend: Notifying - device '%s'/%d\n",
1043 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1044 pDevIns->pDevReg->pfnSuspend(pDevIns);
1045 }
1046
1047 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1048 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1049 if (pDrvIns->pDrvReg->pfnSuspend)
1050 {
1051 LogFlow(("PDMR3Suspend: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1052 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1053 pDrvIns->pDrvReg->pfnSuspend(pDrvIns);
1054 }
1055
1056 /* Don't call the suspend notification again if it was already called. */
1057 if (pDevIns->pDevReg->pfnSuspend && !(pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION))
1058 {
1059 LogFlow(("PDMR3Suspend: Notifying - device '%s'/%d\n",
1060 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1061 pDevIns->pDevReg->pfnSuspend(pDevIns);
1062 }
1063 }
1064
1065#ifdef VBOX_WITH_USB
1066 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1067 {
1068 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1069 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1070 if (pDrvIns->pDrvReg->pfnSuspend)
1071 {
1072 LogFlow(("PDMR3Suspend: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
1073 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1074 pDrvIns->pDrvReg->pfnSuspend(pDrvIns);
1075 }
1076
1077 if (pUsbIns->pUsbReg->pfnVMSuspend)
1078 {
1079 LogFlow(("PDMR3Suspend: Notifying - device '%s'/%d\n",
1080 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1081 pUsbIns->pUsbReg->pfnVMSuspend(pUsbIns);
1082 }
1083 }
1084#endif
1085
1086 /*
1087 * Suspend all threads.
1088 */
1089 pdmR3ThreadSuspendAll(pVM);
1090
1091 LogFlow(("PDMR3Suspend: returns void\n"));
1092}
1093
1094
1095/**
1096 * This function will notify all the devices and their
1097 * attached drivers about the VM now being resumed.
1098 *
1099 * @param pVM VM Handle.
1100 */
1101VMMR3DECL(void) PDMR3Resume(PVM pVM)
1102{
1103 LogFlow(("PDMR3Resume:\n"));
1104
1105 /*
1106 * Iterate the device instances.
1107 * The attached drivers are processed first.
1108 */
1109 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1110 {
1111 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1112 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1113 if (pDrvIns->pDrvReg->pfnResume)
1114 {
1115 LogFlow(("PDMR3Resume: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1116 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1117 pDrvIns->pDrvReg->pfnResume(pDrvIns);
1118 }
1119
1120 if (pDevIns->pDevReg->pfnResume)
1121 {
1122 LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n",
1123 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1124 pDevIns->pDevReg->pfnResume(pDevIns);
1125 }
1126 }
1127
1128#ifdef VBOX_WITH_USB
1129 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1130 {
1131 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1132 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1133 if (pDrvIns->pDrvReg->pfnResume)
1134 {
1135 LogFlow(("PDMR3Resume: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
1136 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1137 pDrvIns->pDrvReg->pfnResume(pDrvIns);
1138 }
1139
1140 if (pUsbIns->pUsbReg->pfnVMResume)
1141 {
1142 LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n",
1143 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1144 pUsbIns->pUsbReg->pfnVMResume(pUsbIns);
1145 }
1146 }
1147#endif
1148
1149 /*
1150 * Resume all threads.
1151 */
1152 pdmR3ThreadResumeAll(pVM);
1153
1154 LogFlow(("PDMR3Resume: returns void\n"));
1155}
1156
1157
1158/**
1159 * This function will notify all the devices and their
1160 * attached drivers about the VM being powered off.
1161 *
1162 * @param pVM VM Handle.
1163 */
1164VMMR3DECL(void) PDMR3PowerOff(PVM pVM)
1165{
1166 LogFlow(("PDMR3PowerOff:\n"));
1167
1168 /*
1169 * Iterate the device instances.
1170 * The attached drivers are processed first.
1171 */
1172 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1173 {
1174
1175 if (pDevIns->pDevReg->pfnPowerOff && (pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION))
1176 {
1177 LogFlow(("PDMR3PowerOff: Notifying - device '%s'/%d\n",
1178 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1179 pDevIns->pDevReg->pfnPowerOff(pDevIns);
1180 }
1181
1182 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1183 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1184 if (pDrvIns->pDrvReg->pfnPowerOff)
1185 {
1186 LogFlow(("PDMR3PowerOff: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1187 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1188 pDrvIns->pDrvReg->pfnPowerOff(pDrvIns);
1189 }
1190
1191 if (pDevIns->pDevReg->pfnPowerOff && !(pDevIns->pDevReg->fFlags & PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION))
1192 {
1193 LogFlow(("PDMR3PowerOff: Notifying - device '%s'/%d\n",
1194 pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
1195 pDevIns->pDevReg->pfnPowerOff(pDevIns);
1196 }
1197 }
1198
1199#ifdef VBOX_WITH_USB
1200 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1201 {
1202 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1203 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1204 if (pDrvIns->pDrvReg->pfnPowerOff)
1205 {
1206 LogFlow(("PDMR3PowerOff: Notifying - driver '%s'/%d on LUN#%d of usb device '%s'/%d\n",
1207 pDrvIns->pDrvReg->szDriverName, pDrvIns->iInstance, pLun->iLun, pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1208 pDrvIns->pDrvReg->pfnPowerOff(pDrvIns);
1209 }
1210
1211 if (pUsbIns->pUsbReg->pfnVMPowerOff)
1212 {
1213 LogFlow(("PDMR3PowerOff: Notifying - device '%s'/%d\n",
1214 pUsbIns->pUsbReg->szDeviceName, pUsbIns->iInstance));
1215 pUsbIns->pUsbReg->pfnVMPowerOff(pUsbIns);
1216 }
1217 }
1218#endif
1219
1220 /*
1221 * Suspend all threads.
1222 */
1223 pdmR3ThreadSuspendAll(pVM);
1224
1225 LogFlow(("PDMR3PowerOff: returns void\n"));
1226}
1227
1228
1229/**
1230 * Queries the base interace of a device instance.
1231 *
1232 * The caller can use this to query other interfaces the device implements
1233 * and use them to talk to the device.
1234 *
1235 * @returns VBox status code.
1236 * @param pVM VM handle.
1237 * @param pszDevice Device name.
1238 * @param iInstance Device instance.
1239 * @param ppBase Where to store the pointer to the base device interface on success.
1240 * @remark We're not doing any locking ATM, so don't try call this at times when the
1241 * device chain is known to be updated.
1242 */
1243VMMR3DECL(int) PDMR3QueryDevice(PVM pVM, const char *pszDevice, unsigned iInstance, PPDMIBASE *ppBase)
1244{
1245 LogFlow(("PDMR3DeviceQuery: pszDevice=%p:{%s} iInstance=%u ppBase=%p\n", pszDevice, pszDevice, iInstance, ppBase));
1246
1247 /*
1248 * Iterate registered devices looking for the device.
1249 */
1250 size_t cchDevice = strlen(pszDevice);
1251 for (PPDMDEV pDev = pVM->pdm.s.pDevs; pDev; pDev = pDev->pNext)
1252 {
1253 if ( pDev->cchName == cchDevice
1254 && !memcmp(pDev->pDevReg->szDeviceName, pszDevice, cchDevice))
1255 {
1256 /*
1257 * Iterate device instances.
1258 */
1259 for (PPDMDEVINS pDevIns = pDev->pInstances; pDevIns; pDevIns = pDevIns->Internal.s.pPerDeviceNextR3)
1260 {
1261 if (pDevIns->iInstance == iInstance)
1262 {
1263 if (pDevIns->IBase.pfnQueryInterface)
1264 {
1265 *ppBase = &pDevIns->IBase;
1266 LogFlow(("PDMR3DeviceQuery: return VINF_SUCCESS and *ppBase=%p\n", *ppBase));
1267 return VINF_SUCCESS;
1268 }
1269
1270 LogFlow(("PDMR3DeviceQuery: returns VERR_PDM_DEVICE_INSTANCE_NO_IBASE\n"));
1271 return VERR_PDM_DEVICE_INSTANCE_NO_IBASE;
1272 }
1273 }
1274
1275 LogFlow(("PDMR3DeviceQuery: returns VERR_PDM_DEVICE_INSTANCE_NOT_FOUND\n"));
1276 return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND;
1277 }
1278 }
1279
1280 LogFlow(("PDMR3QueryDevice: returns VERR_PDM_DEVICE_NOT_FOUND\n"));
1281 return VERR_PDM_DEVICE_NOT_FOUND;
1282}
1283
1284
1285/**
1286 * Queries the base interface of a device LUN.
1287 *
1288 * This differs from PDMR3QueryLun by that it returns the interface on the
1289 * device and not the top level driver.
1290 *
1291 * @returns VBox status code.
1292 * @param pVM VM Handle.
1293 * @param pszDevice Device name.
1294 * @param iInstance Device instance.
1295 * @param iLun The Logical Unit to obtain the interface of.
1296 * @param ppBase Where to store the base interface pointer.
1297 * @remark We're not doing any locking ATM, so don't try call this at times when the
1298 * device chain is known to be updated.
1299 */
1300VMMR3DECL(int) PDMR3QueryDeviceLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
1301{
1302 LogFlow(("PDMR3QueryLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
1303 pszDevice, pszDevice, iInstance, iLun, ppBase));
1304
1305 /*
1306 * Find the LUN.
1307 */
1308 PPDMLUN pLun;
1309 int rc = pdmR3DevFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
1310 if (RT_SUCCESS(rc))
1311 {
1312 *ppBase = pLun->pBase;
1313 LogFlow(("PDMR3QueryDeviceLun: return VINF_SUCCESS and *ppBase=%p\n", *ppBase));
1314 return VINF_SUCCESS;
1315 }
1316 LogFlow(("PDMR3QueryDeviceLun: returns %Rrc\n", rc));
1317 return rc;
1318}
1319
1320
1321/**
1322 * Query the interface of the top level driver on a LUN.
1323 *
1324 * @returns VBox status code.
1325 * @param pVM VM Handle.
1326 * @param pszDevice Device name.
1327 * @param iInstance Device instance.
1328 * @param iLun The Logical Unit to obtain the interface of.
1329 * @param ppBase Where to store the base interface pointer.
1330 * @remark We're not doing any locking ATM, so don't try call this at times when the
1331 * device chain is known to be updated.
1332 */
1333VMMR3DECL(int) PDMR3QueryLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
1334{
1335 LogFlow(("PDMR3QueryLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
1336 pszDevice, pszDevice, iInstance, iLun, ppBase));
1337
1338 /*
1339 * Find the LUN.
1340 */
1341 PPDMLUN pLun;
1342 int rc = pdmR3DevFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
1343 if (RT_SUCCESS(rc))
1344 {
1345 if (pLun->pTop)
1346 {
1347 *ppBase = &pLun->pTop->IBase;
1348 LogFlow(("PDMR3QueryLun: return %Rrc and *ppBase=%p\n", VINF_SUCCESS, *ppBase));
1349 return VINF_SUCCESS;
1350 }
1351 rc = VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN;
1352 }
1353 LogFlow(("PDMR3QueryLun: returns %Rrc\n", rc));
1354 return rc;
1355}
1356
1357/**
1358 * Executes pending DMA transfers.
1359 * Forced Action handler.
1360 *
1361 * @param pVM VM handle.
1362 */
1363VMMR3DECL(void) PDMR3DmaRun(PVM pVM)
1364{
1365 /* Note! Not really SMP safe; restrict it to VCPU 0. */
1366 if (VMMGetCpuId(pVM) != 0)
1367 return;
1368
1369 if (VM_FF_TESTANDCLEAR(pVM, VM_FF_PDM_DMA))
1370 {
1371 if (pVM->pdm.s.pDmac)
1372 {
1373 bool fMore = pVM->pdm.s.pDmac->Reg.pfnRun(pVM->pdm.s.pDmac->pDevIns);
1374 if (fMore)
1375 VM_FF_SET(pVM, VM_FF_PDM_DMA);
1376 }
1377 }
1378}
1379
1380
1381/**
1382 * Service a VMMCALLRING3_PDM_LOCK call.
1383 *
1384 * @returns VBox status code.
1385 * @param pVM The VM handle.
1386 */
1387VMMR3DECL(int) PDMR3LockCall(PVM pVM)
1388{
1389 return PDMR3CritSectEnterEx(&pVM->pdm.s.CritSect, true /* fHostCall */);
1390}
1391
1392
1393/**
1394 * Registers the VMM device heap
1395 *
1396 * @returns VBox status code.
1397 * @param pVM VM handle.
1398 * @param GCPhys The physical address.
1399 * @param pvHeap Ring-3 pointer.
1400 * @param cbSize Size of the heap.
1401 */
1402VMMR3DECL(int) PDMR3RegisterVMMDevHeap(PVM pVM, RTGCPHYS GCPhys, RTR3PTR pvHeap, unsigned cbSize)
1403{
1404 Assert(pVM->pdm.s.pvVMMDevHeap == NULL);
1405
1406 Log(("PDMR3RegisterVMMDevHeap %RGp %RHv %x\n", GCPhys, pvHeap, cbSize));
1407 pVM->pdm.s.pvVMMDevHeap = pvHeap;
1408 pVM->pdm.s.GCPhysVMMDevHeap = GCPhys;
1409 pVM->pdm.s.cbVMMDevHeap = cbSize;
1410 pVM->pdm.s.cbVMMDevHeapLeft = cbSize;
1411 return VINF_SUCCESS;
1412}
1413
1414
1415/**
1416 * Unregisters the VMM device heap
1417 *
1418 * @returns VBox status code.
1419 * @param pVM VM handle.
1420 * @param GCPhys The physical address.
1421 */
1422VMMR3DECL(int) PDMR3UnregisterVMMDevHeap(PVM pVM, RTGCPHYS GCPhys)
1423{
1424 Assert(pVM->pdm.s.GCPhysVMMDevHeap == GCPhys);
1425
1426 Log(("PDMR3UnregisterVMMDevHeap %RGp\n", GCPhys));
1427 pVM->pdm.s.pvVMMDevHeap = NULL;
1428 pVM->pdm.s.GCPhysVMMDevHeap = NIL_RTGCPHYS;
1429 pVM->pdm.s.cbVMMDevHeap = 0;
1430 pVM->pdm.s.cbVMMDevHeapLeft = 0;
1431 return VINF_SUCCESS;
1432}
1433
1434
1435/**
1436 * Allocates memory from the VMM device heap
1437 *
1438 * @returns VBox status code.
1439 * @param pVM VM handle.
1440 * @param cbSize Allocation size.
1441 * @param pv Ring-3 pointer. (out)
1442 */
1443VMMR3DECL(int) PDMR3VMMDevHeapAlloc(PVM pVM, unsigned cbSize, RTR3PTR *ppv)
1444{
1445#ifdef DEBUG_bird
1446 if (!cbSize || cbSize > pVM->pdm.s.cbVMMDevHeapLeft)
1447 return VERR_NO_MEMORY;
1448#else
1449 AssertReturn(cbSize && cbSize <= pVM->pdm.s.cbVMMDevHeapLeft, VERR_NO_MEMORY);
1450#endif
1451
1452 Log(("PDMR3VMMDevHeapAlloc %x\n", cbSize));
1453
1454 /** @todo not a real heap as there's currently only one user. */
1455 *ppv = pVM->pdm.s.pvVMMDevHeap;
1456 pVM->pdm.s.cbVMMDevHeapLeft = 0;
1457 return VINF_SUCCESS;
1458}
1459
1460
1461/**
1462 * Frees memory from the VMM device heap
1463 *
1464 * @returns VBox status code.
1465 * @param pVM VM handle.
1466 * @param pv Ring-3 pointer.
1467 */
1468VMMR3DECL(int) PDMR3VMMDevHeapFree(PVM pVM, RTR3PTR pv)
1469{
1470 Log(("PDMR3VMMDevHeapFree %RHv\n", pv));
1471
1472 /** @todo not a real heap as there's currently only one user. */
1473 pVM->pdm.s.cbVMMDevHeapLeft = pVM->pdm.s.cbVMMDevHeap;
1474 return VINF_SUCCESS;
1475}
1476
1477/**
1478 * Release the PDM lock if owned by the current VCPU
1479 *
1480 * @param pVM The VM to operate on.
1481 */
1482VMMR3DECL(void) PDMR3ReleaseOwnedLocks(PVM pVM)
1483{
1484 while (PDMCritSectIsOwner(&pVM->pdm.s.CritSect))
1485 PDMCritSectLeave(&pVM->pdm.s.CritSect);
1486}
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