VirtualBox

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

Last change on this file since 61072 was 60716, checked in by vboxsync, 9 years ago

VMM: Fixed TPR thresholding and related PDM interfaces.
Cleaned up the PDM interface and merged apicHasPendingIrq with apicGetTpr.
Fixed raw-mode with the new APIC code due to busted GC mapping relocation.

This finally fixes the NT4 VM boot-up issue with the new APIC code.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 108.2 KB
Line 
1/* $Id: PDM.cpp 60716 2016-04-27 13:11:46Z vboxsync $ */
2/** @file
3 * PDM - Pluggable Device Manager.
4 */
5
6/*
7 * Copyright (C) 2006-2015 Oracle Corporation
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
18
19/** @page pg_pdm PDM - The Pluggable Device & Driver Manager
20 *
21 * The PDM handles devices and their drivers in a flexible and dynamic manner.
22 *
23 * VirtualBox is designed to be very configurable, i.e. the ability to select
24 * virtual devices and configure them uniquely for a VM. For this reason
25 * virtual devices are not statically linked with the VMM but loaded, linked and
26 * instantiated at runtime by PDM using the information found in the
27 * Configuration Manager (CFGM).
28 *
29 * While the chief purpose of PDM is to manager of devices their drivers, it
30 * also serves as somewhere to put usful things like cross context queues, cross
31 * context synchronization (like critsect), VM centric thread management,
32 * asynchronous I/O framework, and so on.
33 *
34 * @sa @ref grp_pdm
35 * @subpage pg_pdm_block_cache
36 *
37 *
38 * @section sec_pdm_dev The Pluggable Devices
39 *
40 * Devices register themselves when the module containing them is loaded. PDM
41 * will call the entry point 'VBoxDevicesRegister' when loading a device module.
42 * The device module will then use the supplied callback table to check the VMM
43 * version and to register its devices. Each device has an unique (for the
44 * configured VM) name. The name is not only used in PDM but also in CFGM (to
45 * organize device and device instance settings) and by anyone who wants to talk
46 * to a specific device instance.
47 *
48 * When all device modules have been successfully loaded PDM will instantiate
49 * those devices which are configured for the VM. Note that a device may have
50 * more than one instance, see network adaptors for instance. When
51 * instantiating a device PDM provides device instance memory and a callback
52 * table (aka Device Helpers / DevHlp) with the VM APIs which the device
53 * instance is trusted with.
54 *
55 * Some devices are trusted devices, most are not. The trusted devices are an
56 * integrated part of the VM and can obtain the VM handle from their device
57 * instance handles, thus enabling them to call any VM API. Untrusted devices
58 * can only use the callbacks provided during device instantiation.
59 *
60 * The main purpose in having DevHlps rather than just giving all the devices
61 * the VM handle and let them call the internal VM APIs directly, is both to
62 * create a binary interface that can be supported across releases and to
63 * create a barrier between devices and the VM. (The trusted / untrusted bit
64 * hasn't turned out to be of much use btw., but it's easy to maintain so there
65 * isn't any point in removing it.)
66 *
67 * A device can provide a ring-0 and/or a raw-mode context extension to improve
68 * the VM performance by handling exits and traps (respectively) without
69 * requiring context switches (to ring-3). Callbacks for MMIO and I/O ports
70 * need to be registered specifically for the additional contexts for this to
71 * make sense. Also, the device has to be trusted to be loaded into R0/RC
72 * because of the extra privilege it entails. Note that raw-mode code and data
73 * will be subject to relocation.
74 *
75 *
76 * @section sec_pdm_special_devs Special Devices
77 *
78 * Several kinds of devices interacts with the VMM and/or other device and PDM
79 * will work like a mediator for these. The typical pattern is that the device
80 * calls a special registration device helper with a set of callbacks, PDM
81 * responds by copying this and providing a pointer to a set helper callbacks
82 * for that particular kind of device. Unlike interfaces where the callback
83 * table pointer is used a 'this' pointer, these arrangements will use the
84 * device instance pointer (PPDMDEVINS) as a kind of 'this' pointer.
85 *
86 * For an example of this kind of setup, see the PIC. The PIC registers itself
87 * by calling PDMDEVHLPR3::pfnPICRegister. PDM saves the device instance,
88 * copies the callback tables (PDMPICREG), resolving the ring-0 and raw-mode
89 * addresses in the process, and hands back the pointer to a set of helper
90 * methods (PDMPICHLPR3). The PCI device then queries the ring-0 and raw-mode
91 * helpers using PDMPICHLPR3::pfnGetR0Helpers and PDMPICHLPR3::pfnGetRCHelpers.
92 * The PCI device repeats ths pfnGetRCHelpers call in it's relocation method
93 * since the address changes when RC is relocated.
94 *
95 * @see grp_pdm_device
96 *
97 *
98 * @section sec_pdm_usbdev The Pluggable USB Devices
99 *
100 * USB devices are handled a little bit differently than other devices. The
101 * general concepts wrt. pluggability are mostly the same, but the details
102 * varies. The registration entry point is 'VBoxUsbRegister', the device
103 * instance is PDMUSBINS and the callbacks helpers are different. Also, USB
104 * device are restricted to ring-3 and cannot have any ring-0 or raw-mode
105 * extensions (at least not yet).
106 *
107 * The way USB devices work differs greatly from other devices though since they
108 * aren't attaches directly to the PCI/ISA/whatever system buses but via a
109 * USB host control (OHCI, UHCI or EHCI). USB devices handle USB requests
110 * (URBs) and does not register I/O ports, MMIO ranges or PCI bus
111 * devices/functions.
112 *
113 * @see grp_pdm_usbdev
114 *
115 *
116 * @section sec_pdm_drv The Pluggable Drivers
117 *
118 * The VM devices are often accessing host hardware or OS facilities. For most
119 * devices these facilities can be abstracted in one or more levels. These
120 * abstractions are called drivers.
121 *
122 * For instance take a DVD/CD drive. This can be connected to a SCSI
123 * controller, an ATA controller or a SATA controller. The basics of the DVD/CD
124 * drive implementation remains the same - eject, insert, read, seek, and such.
125 * (For the scsi SCSCI, you might want to speak SCSI directly to, but that can of
126 * course be fixed - see SCSI passthru.) So, it
127 * makes much sense to have a generic CD/DVD driver which implements this.
128 *
129 * Then the media 'inserted' into the DVD/CD drive can be a ISO image, or it can
130 * be read from a real CD or DVD drive (there are probably other custom formats
131 * someone could desire to read or construct too). So, it would make sense to
132 * have abstracted interfaces for dealing with this in a generic way so the
133 * cdrom unit doesn't have to implement it all. Thus we have created the
134 * CDROM/DVD media driver family.
135 *
136 * So, for this example the IDE controller #1 (i.e. secondary) will have
137 * the DVD/CD Driver attached to it's LUN #0 (master). When a media is mounted
138 * the DVD/CD Driver will have a ISO, HostDVD or RAW (media) Driver attached.
139 *
140 * It is possible to configure many levels of drivers inserting filters, loggers,
141 * or whatever you desire into the chain. We're using this for network sniffing,
142 * for instance.
143 *
144 * The drivers are loaded in a similar manner to that of a device, namely by
145 * iterating a keyspace in CFGM, load the modules listed there and call
146 * 'VBoxDriversRegister' with a callback table.
147 *
148 * @see grp_pdm_driver
149 *
150 *
151 * @section sec_pdm_ifs Interfaces
152 *
153 * The pluggable drivers and devices expose one standard interface (callback
154 * table) which is used to construct, destruct, attach, detach,( ++,) and query
155 * other interfaces. A device will query the interfaces required for it's
156 * operation during init and hot-plug. PDM may query some interfaces during
157 * runtime mounting too.
158 *
159 * An interface here means a function table contained within the device or
160 * driver instance data. Its methods are invoked with the function table pointer
161 * as the first argument and they will calculate the address of the device or
162 * driver instance data from it. (This is one of the aspects which *might* have
163 * been better done in C++.)
164 *
165 * @see grp_pdm_interfaces
166 *
167 *
168 * @section sec_pdm_utils Utilities
169 *
170 * As mentioned earlier, PDM is the location of any usful constructs that doesn't
171 * quite fit into IPRT. The next subsections will discuss these.
172 *
173 * One thing these APIs all have in common is that resources will be associated
174 * with a device / driver and automatically freed after it has been destroyed if
175 * the destructor didn't do this.
176 *
177 *
178 * @subsection sec_pdm_async_completion Async I/O
179 *
180 * The PDM Async I/O API provides a somewhat platform agnostic interface for
181 * asynchronous I/O. For reasons of performance and complexity this does not
182 * build upon any IPRT API.
183 *
184 * @todo more details.
185 *
186 * @see grp_pdm_async_completion
187 *
188 *
189 * @subsection sec_pdm_async_task Async Task - not implemented
190 *
191 * @todo implement and describe
192 *
193 * @see grp_pdm_async_task
194 *
195 *
196 * @subsection sec_pdm_critsect Critical Section
197 *
198 * The PDM Critical Section API is currently building on the IPRT API with the
199 * same name. It adds the possibility to use critical sections in ring-0 and
200 * raw-mode as well as in ring-3. There are certain restrictions on the RC and
201 * R0 usage though since we're not able to wait on it, nor wake up anyone that
202 * is waiting on it. These restrictions origins with the use of a ring-3 event
203 * semaphore. In a later incarnation we plan to replace the ring-3 event
204 * semaphore with a ring-0 one, thus enabling us to wake up waiters while
205 * exectuing in ring-0 and making the hardware assisted execution mode more
206 * efficient. (Raw-mode won't benefit much from this, naturally.)
207 *
208 * @see grp_pdm_critsect
209 *
210 *
211 * @subsection sec_pdm_queue Queue
212 *
213 * The PDM Queue API is for queuing one or more tasks for later consumption in
214 * ring-3 by EMT, and optionally forcing a delayed or ASAP return to ring-3. The
215 * queues can also be run on a timer basis as an alternative to the ASAP thing.
216 * The queue will be flushed at forced action time.
217 *
218 * A queue can also be used by another thread (a I/O worker for instance) to
219 * send work / events over to the EMT.
220 *
221 * @see grp_pdm_queue
222 *
223 *
224 * @subsection sec_pdm_task Task - not implemented yet
225 *
226 * The PDM Task API is for flagging a task for execution at a later point when
227 * we're back in ring-3, optionally forcing the ring-3 return to happen ASAP.
228 * As you can see the concept is similar to queues only simpler.
229 *
230 * A task can also be scheduled by another thread (a I/O worker for instance) as
231 * a mean of getting something done in EMT.
232 *
233 * @see grp_pdm_task
234 *
235 *
236 * @subsection sec_pdm_thread Thread
237 *
238 * The PDM Thread API is there to help devices and drivers manage their threads
239 * correctly wrt. power on, suspend, resume, power off and destruction.
240 *
241 * The general usage pattern for threads in the employ of devices and drivers is
242 * that they shuffle data or requests while the VM is running and stop doing
243 * this when the VM is paused or powered down. Rogue threads running while the
244 * VM is paused can cause the state to change during saving or have other
245 * unwanted side effects. The PDM Threads API ensures that this won't happen.
246 *
247 * @see grp_pdm_thread
248 *
249 */
250
251
252/*********************************************************************************************************************************
253* Header Files *
254*********************************************************************************************************************************/
255#define LOG_GROUP LOG_GROUP_PDM
256#include "PDMInternal.h"
257#include <VBox/vmm/pdm.h>
258#include <VBox/vmm/em.h>
259#include <VBox/vmm/mm.h>
260#include <VBox/vmm/pgm.h>
261#include <VBox/vmm/ssm.h>
262#include <VBox/vmm/hm.h>
263#include <VBox/vmm/vm.h>
264#include <VBox/vmm/uvm.h>
265#include <VBox/vmm/vmm.h>
266#include <VBox/param.h>
267#include <VBox/err.h>
268#include <VBox/sup.h>
269
270#include <VBox/log.h>
271#include <iprt/asm.h>
272#include <iprt/assert.h>
273#include <iprt/alloc.h>
274#include <iprt/ctype.h>
275#include <iprt/ldr.h>
276#include <iprt/path.h>
277#include <iprt/string.h>
278
279
280/*********************************************************************************************************************************
281* Defined Constants And Macros *
282*********************************************************************************************************************************/
283/** The PDM saved state version. */
284#define PDM_SAVED_STATE_VERSION 5
285/** Before the PDM audio architecture was introduced there was an "AudioSniffer"
286 * device which took care of multiplexing input/output audio data from/to various places.
287 * Thus this device is not needed/used anymore. */
288#define PDM_SAVED_STATE_VERSION_PRE_PDM_AUDIO 4
289#define PDM_SAVED_STATE_VERSION_PRE_NMI_FF 3
290
291/** The number of nanoseconds a suspend callback needs to take before
292 * PDMR3Suspend warns about it taking too long. */
293#define PDMSUSPEND_WARN_AT_NS UINT64_C(1200000000)
294
295/** The number of nanoseconds a suspend callback needs to take before
296 * PDMR3PowerOff warns about it taking too long. */
297#define PDMPOWEROFF_WARN_AT_NS UINT64_C( 900000000)
298
299
300/*********************************************************************************************************************************
301* Structures and Typedefs *
302*********************************************************************************************************************************/
303/**
304 * Statistics of asynchronous notification tasks - used by reset, suspend and
305 * power off.
306 */
307typedef struct PDMNOTIFYASYNCSTATS
308{
309 /** The start timestamp. */
310 uint64_t uStartNsTs;
311 /** When to log the next time. */
312 uint64_t cNsElapsedNextLog;
313 /** The loop counter. */
314 uint32_t cLoops;
315 /** The number of pending asynchronous notification tasks. */
316 uint32_t cAsync;
317 /** The name of the operation (log prefix). */
318 const char *pszOp;
319 /** The current list buffer position. */
320 size_t offList;
321 /** String containing a list of the pending tasks. */
322 char szList[1024];
323} PDMNOTIFYASYNCSTATS;
324/** Pointer to the stats of pending asynchronous notification tasks. */
325typedef PDMNOTIFYASYNCSTATS *PPDMNOTIFYASYNCSTATS;
326
327
328/*********************************************************************************************************************************
329* Internal Functions *
330*********************************************************************************************************************************/
331static DECLCALLBACK(int) pdmR3LiveExec(PVM pVM, PSSMHANDLE pSSM, uint32_t uPass);
332static DECLCALLBACK(int) pdmR3SaveExec(PVM pVM, PSSMHANDLE pSSM);
333static DECLCALLBACK(int) pdmR3LoadExec(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
334static DECLCALLBACK(int) pdmR3LoadPrep(PVM pVM, PSSMHANDLE pSSM);
335
336static FNDBGFHANDLERINT pdmR3InfoTracingIds;
337
338
339/**
340 * Initializes the PDM part of the UVM.
341 *
342 * This doesn't really do much right now but has to be here for the sake
343 * of completeness.
344 *
345 * @returns VBox status code.
346 * @param pUVM Pointer to the user mode VM structure.
347 */
348VMMR3_INT_DECL(int) PDMR3InitUVM(PUVM pUVM)
349{
350 AssertCompile(sizeof(pUVM->pdm.s) <= sizeof(pUVM->pdm.padding));
351 AssertRelease(sizeof(pUVM->pdm.s) <= sizeof(pUVM->pdm.padding));
352 pUVM->pdm.s.pModules = NULL;
353 pUVM->pdm.s.pCritSects = NULL;
354 pUVM->pdm.s.pRwCritSects = NULL;
355 return RTCritSectInit(&pUVM->pdm.s.ListCritSect);
356}
357
358
359/**
360 * Initializes the PDM.
361 *
362 * @returns VBox status code.
363 * @param pVM The cross context VM structure.
364 */
365VMMR3_INT_DECL(int) PDMR3Init(PVM pVM)
366{
367 LogFlow(("PDMR3Init\n"));
368
369 /*
370 * Assert alignment and sizes.
371 */
372 AssertRelease(!(RT_OFFSETOF(VM, pdm.s) & 31));
373 AssertRelease(sizeof(pVM->pdm.s) <= sizeof(pVM->pdm.padding));
374 AssertCompileMemberAlignment(PDM, CritSect, sizeof(uintptr_t));
375
376 /*
377 * Init the structure.
378 */
379 pVM->pdm.s.GCPhysVMMDevHeap = NIL_RTGCPHYS;
380 //pVM->pdm.s.idTracingDev = 0;
381 pVM->pdm.s.idTracingOther = 1024;
382
383 /*
384 * Initialize critical sections first.
385 */
386 int rc = pdmR3CritSectBothInitStats(pVM);
387 if (RT_SUCCESS(rc))
388 rc = PDMR3CritSectInit(pVM, &pVM->pdm.s.CritSect, RT_SRC_POS, "PDM");
389 if (RT_SUCCESS(rc))
390 {
391 rc = PDMR3CritSectInit(pVM, &pVM->pdm.s.NopCritSect, RT_SRC_POS, "NOP");
392 if (RT_SUCCESS(rc))
393 pVM->pdm.s.NopCritSect.s.Core.fFlags |= RTCRITSECT_FLAGS_NOP;
394 }
395
396 /*
397 * Initialize sub components.
398 */
399 if (RT_SUCCESS(rc))
400 rc = pdmR3LdrInitU(pVM->pUVM);
401#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
402 if (RT_SUCCESS(rc))
403 rc = pdmR3AsyncCompletionInit(pVM);
404#endif
405#ifdef VBOX_WITH_NETSHAPER
406 if (RT_SUCCESS(rc))
407 rc = pdmR3NetShaperInit(pVM);
408#endif
409 if (RT_SUCCESS(rc))
410 rc = pdmR3BlkCacheInit(pVM);
411 if (RT_SUCCESS(rc))
412 rc = pdmR3DrvInit(pVM);
413 if (RT_SUCCESS(rc))
414 rc = pdmR3DevInit(pVM);
415 if (RT_SUCCESS(rc))
416 {
417 /*
418 * Register the saved state data unit.
419 */
420 rc = SSMR3RegisterInternal(pVM, "pdm", 1, PDM_SAVED_STATE_VERSION, 128,
421 NULL, pdmR3LiveExec, NULL,
422 NULL, pdmR3SaveExec, NULL,
423 pdmR3LoadPrep, pdmR3LoadExec, NULL);
424 if (RT_SUCCESS(rc))
425 {
426 /*
427 * Register the info handlers.
428 */
429 DBGFR3InfoRegisterInternal(pVM, "pdmtracingids",
430 "Displays the tracing IDs assigned by PDM to devices, USB device, drivers and more.",
431 pdmR3InfoTracingIds);
432
433 LogFlow(("PDM: Successfully initialized\n"));
434 return rc;
435 }
436 }
437
438 /*
439 * Cleanup and return failure.
440 */
441 PDMR3Term(pVM);
442 LogFlow(("PDMR3Init: returns %Rrc\n", rc));
443 return rc;
444}
445
446
447/**
448 * Init phase completed callback.
449 *
450 * We use this for calling PDMDEVREG::pfnInitComplete callback after everything
451 * else has been initialized.
452 *
453 * @returns VBox status code.
454 * @param pVM The cross context VM structure.
455 * @param enmWhat The phase that was completed.
456 */
457VMMR3_INT_DECL(int) PDMR3InitCompleted(PVM pVM, VMINITCOMPLETED enmWhat)
458{
459#ifdef VBOX_WITH_RAW_MODE
460 if (enmWhat == VMINITCOMPLETED_RC)
461#else
462 if (enmWhat == VMINITCOMPLETED_RING0)
463#endif
464 return pdmR3DevInitComplete(pVM);
465 return VINF_SUCCESS;
466}
467
468
469/**
470 * Applies relocations to data and code managed by this
471 * component. This function will be called at init and
472 * whenever the VMM need to relocate it self inside the GC.
473 *
474 * @param pVM The cross context VM structure.
475 * @param offDelta Relocation delta relative to old location.
476 * @remark The loader subcomponent is relocated by PDMR3LdrRelocate() very
477 * early in the relocation phase.
478 */
479VMMR3_INT_DECL(void) PDMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
480{
481 LogFlow(("PDMR3Relocate\n"));
482
483 /*
484 * Queues.
485 */
486 pdmR3QueueRelocate(pVM, offDelta);
487 pVM->pdm.s.pDevHlpQueueRC = PDMQueueRCPtr(pVM->pdm.s.pDevHlpQueueR3);
488
489 /*
490 * Critical sections.
491 */
492 pdmR3CritSectBothRelocate(pVM);
493
494 /*
495 * The registered PIC.
496 */
497 if (pVM->pdm.s.Pic.pDevInsRC)
498 {
499 pVM->pdm.s.Pic.pDevInsRC += offDelta;
500 pVM->pdm.s.Pic.pfnSetIrqRC += offDelta;
501 pVM->pdm.s.Pic.pfnGetInterruptRC += offDelta;
502 }
503
504 /*
505 * The registered APIC.
506 */
507 if (pVM->pdm.s.Apic.pDevInsRC)
508 {
509 pVM->pdm.s.Apic.pDevInsRC += offDelta;
510 pVM->pdm.s.Apic.pfnGetInterruptRC += offDelta;
511 pVM->pdm.s.Apic.pfnSetBaseMsrRC += offDelta;
512 pVM->pdm.s.Apic.pfnGetBaseMsrRC += offDelta;
513 pVM->pdm.s.Apic.pfnSetTprRC += offDelta;
514 pVM->pdm.s.Apic.pfnGetTprRC += offDelta;
515 pVM->pdm.s.Apic.pfnWriteMsrRC += offDelta;
516 pVM->pdm.s.Apic.pfnReadMsrRC += offDelta;
517 pVM->pdm.s.Apic.pfnBusDeliverRC += offDelta;
518 if (pVM->pdm.s.Apic.pfnLocalInterruptRC)
519 pVM->pdm.s.Apic.pfnLocalInterruptRC += offDelta;
520 pVM->pdm.s.Apic.pfnGetTimerFreqRC += offDelta;
521 }
522
523 /*
524 * The registered I/O APIC.
525 */
526 if (pVM->pdm.s.IoApic.pDevInsRC)
527 {
528 pVM->pdm.s.IoApic.pDevInsRC += offDelta;
529 pVM->pdm.s.IoApic.pfnSetIrqRC += offDelta;
530 if (pVM->pdm.s.IoApic.pfnSendMsiRC)
531 pVM->pdm.s.IoApic.pfnSendMsiRC += offDelta;
532 }
533
534 /*
535 * The register PCI Buses.
536 */
537 for (unsigned i = 0; i < RT_ELEMENTS(pVM->pdm.s.aPciBuses); i++)
538 {
539 if (pVM->pdm.s.aPciBuses[i].pDevInsRC)
540 {
541 pVM->pdm.s.aPciBuses[i].pDevInsRC += offDelta;
542 pVM->pdm.s.aPciBuses[i].pfnSetIrqRC += offDelta;
543 }
544 }
545
546 /*
547 * Devices & Drivers.
548 */
549 int rc;
550 PCPDMDEVHLPRC pDevHlpRC = NIL_RTRCPTR;
551 if (!HMIsEnabled(pVM))
552 {
553 rc = PDMR3LdrGetSymbolRC(pVM, NULL, "g_pdmRCDevHlp", &pDevHlpRC);
554 AssertReleaseMsgRC(rc, ("rc=%Rrc when resolving g_pdmRCDevHlp\n", rc));
555 }
556
557 PCPDMDRVHLPRC pDrvHlpRC = NIL_RTRCPTR;
558 if (!HMIsEnabled(pVM))
559 {
560 rc = PDMR3LdrGetSymbolRC(pVM, NULL, "g_pdmRCDevHlp", &pDrvHlpRC);
561 AssertReleaseMsgRC(rc, ("rc=%Rrc when resolving g_pdmRCDevHlp\n", rc));
562 }
563
564 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
565 {
566 if (pDevIns->pReg->fFlags & PDM_DEVREG_FLAGS_RC)
567 {
568 pDevIns->pHlpRC = pDevHlpRC;
569 pDevIns->pvInstanceDataRC = MMHyperR3ToRC(pVM, pDevIns->pvInstanceDataR3);
570 if (pDevIns->pCritSectRoR3)
571 pDevIns->pCritSectRoRC = MMHyperR3ToRC(pVM, pDevIns->pCritSectRoR3);
572 pDevIns->Internal.s.pVMRC = pVM->pVMRC;
573 if (pDevIns->Internal.s.pPciBusR3)
574 pDevIns->Internal.s.pPciBusRC = MMHyperR3ToRC(pVM, pDevIns->Internal.s.pPciBusR3);
575 if (pDevIns->Internal.s.pPciDeviceR3)
576 pDevIns->Internal.s.pPciDeviceRC = MMHyperR3ToRC(pVM, pDevIns->Internal.s.pPciDeviceR3);
577 if (pDevIns->pReg->pfnRelocate)
578 {
579 LogFlow(("PDMR3Relocate: Relocating device '%s'/%d\n",
580 pDevIns->pReg->szName, pDevIns->iInstance));
581 pDevIns->pReg->pfnRelocate(pDevIns, offDelta);
582 }
583 }
584
585 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
586 {
587 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
588 {
589 if (pDrvIns->pReg->fFlags & PDM_DRVREG_FLAGS_RC)
590 {
591 pDrvIns->pHlpRC = pDrvHlpRC;
592 pDrvIns->pvInstanceDataRC = MMHyperR3ToRC(pVM, pDrvIns->pvInstanceDataR3);
593 pDrvIns->Internal.s.pVMRC = pVM->pVMRC;
594 if (pDrvIns->pReg->pfnRelocate)
595 {
596 LogFlow(("PDMR3Relocate: Relocating driver '%s'/%u attached to '%s'/%d/%u\n",
597 pDrvIns->pReg->szName, pDrvIns->iInstance,
598 pDevIns->pReg->szName, pDevIns->iInstance, pLun->iLun));
599 pDrvIns->pReg->pfnRelocate(pDrvIns, offDelta);
600 }
601 }
602 }
603 }
604
605 }
606}
607
608
609/**
610 * Worker for pdmR3Term that terminates a LUN chain.
611 *
612 * @param pVM The cross context VM structure.
613 * @param pLun The head of the chain.
614 * @param pszDevice The name of the device (for logging).
615 * @param iInstance The device instance number (for logging).
616 */
617static void pdmR3TermLuns(PVM pVM, PPDMLUN pLun, const char *pszDevice, unsigned iInstance)
618{
619 for (; pLun; pLun = pLun->pNext)
620 {
621 /*
622 * Destroy them one at a time from the bottom up.
623 * (The serial device/drivers depends on this - bad.)
624 */
625 PPDMDRVINS pDrvIns = pLun->pBottom;
626 pLun->pBottom = pLun->pTop = NULL;
627 while (pDrvIns)
628 {
629 PPDMDRVINS pDrvNext = pDrvIns->Internal.s.pUp;
630
631 if (pDrvIns->pReg->pfnDestruct)
632 {
633 LogFlow(("pdmR3DevTerm: Destroying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
634 pDrvIns->pReg->szName, pDrvIns->iInstance, pLun->iLun, pszDevice, iInstance));
635 pDrvIns->pReg->pfnDestruct(pDrvIns);
636 }
637 pDrvIns->Internal.s.pDrv->cInstances--;
638
639 /* Order of resource freeing like in pdmR3DrvDestroyChain, but
640 * not all need to be done as they are done globally later. */
641 //PDMR3QueueDestroyDriver(pVM, pDrvIns);
642 TMR3TimerDestroyDriver(pVM, pDrvIns);
643 SSMR3DeregisterDriver(pVM, pDrvIns, NULL, 0);
644 //pdmR3ThreadDestroyDriver(pVM, pDrvIns);
645 //DBGFR3InfoDeregisterDriver(pVM, pDrvIns, NULL);
646 //pdmR3CritSectBothDeleteDriver(pVM, pDrvIns);
647 //PDMR3BlkCacheReleaseDriver(pVM, pDrvIns);
648#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
649 //pdmR3AsyncCompletionTemplateDestroyDriver(pVM, pDrvIns);
650#endif
651
652 /* Clear the driver struture to catch sloppy code. */
653 ASMMemFill32(pDrvIns, RT_OFFSETOF(PDMDRVINS, achInstanceData[pDrvIns->pReg->cbInstance]), 0xdeadd0d0);
654
655 pDrvIns = pDrvNext;
656 }
657 }
658}
659
660
661/**
662 * Terminates the PDM.
663 *
664 * Termination means cleaning up and freeing all resources,
665 * the VM it self is at this point powered off or suspended.
666 *
667 * @returns VBox status code.
668 * @param pVM The cross context VM structure.
669 */
670VMMR3_INT_DECL(int) PDMR3Term(PVM pVM)
671{
672 LogFlow(("PDMR3Term:\n"));
673 AssertMsg(PDMCritSectIsInitialized(&pVM->pdm.s.CritSect), ("bad init order!\n"));
674
675 /*
676 * Iterate the device instances and attach drivers, doing
677 * relevant destruction processing.
678 *
679 * N.B. There is no need to mess around freeing memory allocated
680 * from any MM heap since MM will do that in its Term function.
681 */
682 /* usb ones first. */
683 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
684 {
685 pdmR3TermLuns(pVM, pUsbIns->Internal.s.pLuns, pUsbIns->pReg->szName, pUsbIns->iInstance);
686
687 /*
688 * Detach it from the HUB (if it's actually attached to one) so the HUB has
689 * a chance to stop accessing any data.
690 */
691 PPDMUSBHUB pHub = pUsbIns->Internal.s.pHub;
692 if (pHub)
693 {
694 int rc = pHub->Reg.pfnDetachDevice(pHub->pDrvIns, pUsbIns, pUsbIns->Internal.s.iPort);
695 if (RT_FAILURE(rc))
696 {
697 LogRel(("PDM: Failed to detach USB device '%s' instance %d from %p: %Rrc\n",
698 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub, rc));
699 }
700 else
701 {
702 pHub->cAvailablePorts++;
703 Assert(pHub->cAvailablePorts > 0 && pHub->cAvailablePorts <= pHub->cPorts);
704 pUsbIns->Internal.s.pHub = NULL;
705 }
706 }
707
708 if (pUsbIns->pReg->pfnDestruct)
709 {
710 LogFlow(("pdmR3DevTerm: Destroying - device '%s'/%d\n",
711 pUsbIns->pReg->szName, pUsbIns->iInstance));
712 pUsbIns->pReg->pfnDestruct(pUsbIns);
713 }
714
715 //TMR3TimerDestroyUsb(pVM, pUsbIns);
716 //SSMR3DeregisterUsb(pVM, pUsbIns, NULL, 0);
717 pdmR3ThreadDestroyUsb(pVM, pUsbIns);
718 }
719
720 /* then the 'normal' ones. */
721 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
722 {
723 pdmR3TermLuns(pVM, pDevIns->Internal.s.pLunsR3, pDevIns->pReg->szName, pDevIns->iInstance);
724
725 if (pDevIns->pReg->pfnDestruct)
726 {
727 LogFlow(("pdmR3DevTerm: Destroying - device '%s'/%d\n",
728 pDevIns->pReg->szName, pDevIns->iInstance));
729 pDevIns->pReg->pfnDestruct(pDevIns);
730 }
731
732 TMR3TimerDestroyDevice(pVM, pDevIns);
733 SSMR3DeregisterDevice(pVM, pDevIns, NULL, 0);
734 pdmR3CritSectBothDeleteDevice(pVM, pDevIns);
735 pdmR3ThreadDestroyDevice(pVM, pDevIns);
736 PDMR3QueueDestroyDevice(pVM, pDevIns);
737 PGMR3PhysMMIO2Deregister(pVM, pDevIns, UINT32_MAX);
738#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
739 pdmR3AsyncCompletionTemplateDestroyDevice(pVM, pDevIns);
740#endif
741 DBGFR3InfoDeregisterDevice(pVM, pDevIns, NULL);
742 }
743
744 /*
745 * Destroy all threads.
746 */
747 pdmR3ThreadDestroyAll(pVM);
748
749 /*
750 * Destroy the block cache.
751 */
752 pdmR3BlkCacheTerm(pVM);
753
754#ifdef VBOX_WITH_NETSHAPER
755 /*
756 * Destroy network bandwidth groups.
757 */
758 pdmR3NetShaperTerm(pVM);
759#endif
760#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
761 /*
762 * Free async completion managers.
763 */
764 pdmR3AsyncCompletionTerm(pVM);
765#endif
766
767 /*
768 * Free modules.
769 */
770 pdmR3LdrTermU(pVM->pUVM);
771
772 /*
773 * Destroy the PDM lock.
774 */
775 PDMR3CritSectDelete(&pVM->pdm.s.CritSect);
776 /* The MiscCritSect is deleted by PDMR3CritSectBothTerm later. */
777
778 LogFlow(("PDMR3Term: returns %Rrc\n", VINF_SUCCESS));
779 return VINF_SUCCESS;
780}
781
782
783/**
784 * Terminates the PDM part of the UVM.
785 *
786 * This will unload any modules left behind.
787 *
788 * @param pUVM Pointer to the user mode VM structure.
789 */
790VMMR3_INT_DECL(void) PDMR3TermUVM(PUVM pUVM)
791{
792 /*
793 * In the normal cause of events we will now call pdmR3LdrTermU for
794 * the second time. In the case of init failure however, this might
795 * the first time, which is why we do it.
796 */
797 pdmR3LdrTermU(pUVM);
798
799 Assert(pUVM->pdm.s.pCritSects == NULL);
800 Assert(pUVM->pdm.s.pRwCritSects == NULL);
801 RTCritSectDelete(&pUVM->pdm.s.ListCritSect);
802}
803
804
805/**
806 * Bits that are saved in pass 0 and in the final pass.
807 *
808 * @param pVM The cross context VM structure.
809 * @param pSSM The saved state handle.
810 */
811static void pdmR3SaveBoth(PVM pVM, PSSMHANDLE pSSM)
812{
813 /*
814 * Save the list of device instances so we can check that they're all still
815 * there when we load the state and that nothing new has been added.
816 */
817 uint32_t i = 0;
818 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3, i++)
819 {
820 SSMR3PutU32(pSSM, i);
821 SSMR3PutStrZ(pSSM, pDevIns->pReg->szName);
822 SSMR3PutU32(pSSM, pDevIns->iInstance);
823 }
824 SSMR3PutU32(pSSM, UINT32_MAX); /* terminator */
825}
826
827
828/**
829 * Live save.
830 *
831 * @returns VBox status code.
832 * @param pVM The cross context VM structure.
833 * @param pSSM The saved state handle.
834 * @param uPass The pass.
835 */
836static DECLCALLBACK(int) pdmR3LiveExec(PVM pVM, PSSMHANDLE pSSM, uint32_t uPass)
837{
838 LogFlow(("pdmR3LiveExec:\n"));
839 AssertReturn(uPass == 0, VERR_SSM_UNEXPECTED_PASS);
840 pdmR3SaveBoth(pVM, pSSM);
841 return VINF_SSM_DONT_CALL_AGAIN;
842}
843
844
845/**
846 * Execute state save operation.
847 *
848 * @returns VBox status code.
849 * @param pVM The cross context VM structure.
850 * @param pSSM The saved state handle.
851 */
852static DECLCALLBACK(int) pdmR3SaveExec(PVM pVM, PSSMHANDLE pSSM)
853{
854 LogFlow(("pdmR3SaveExec:\n"));
855
856 /*
857 * Save interrupt and DMA states.
858 */
859 for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
860 {
861 PVMCPU pVCpu = &pVM->aCpus[idCpu];
862 SSMR3PutU32(pSSM, VMCPU_FF_IS_SET(pVCpu, VMCPU_FF_INTERRUPT_APIC));
863 SSMR3PutU32(pSSM, VMCPU_FF_IS_SET(pVCpu, VMCPU_FF_INTERRUPT_PIC));
864 SSMR3PutU32(pSSM, VMCPU_FF_IS_SET(pVCpu, VMCPU_FF_INTERRUPT_NMI));
865 SSMR3PutU32(pSSM, VMCPU_FF_IS_SET(pVCpu, VMCPU_FF_INTERRUPT_SMI));
866 }
867 SSMR3PutU32(pSSM, VM_FF_IS_SET(pVM, VM_FF_PDM_DMA));
868
869 pdmR3SaveBoth(pVM, pSSM);
870 return VINF_SUCCESS;
871}
872
873
874/**
875 * Prepare state load operation.
876 *
877 * This will dispatch pending operations and clear the FFs governed by PDM and its devices.
878 *
879 * @returns VBox status code.
880 * @param pVM The cross context VM structure.
881 * @param pSSM The SSM handle.
882 */
883static DECLCALLBACK(int) pdmR3LoadPrep(PVM pVM, PSSMHANDLE pSSM)
884{
885 LogFlow(("pdmR3LoadPrep: %s%s\n",
886 VM_FF_IS_SET(pVM, VM_FF_PDM_QUEUES) ? " VM_FF_PDM_QUEUES" : "",
887 VM_FF_IS_SET(pVM, VM_FF_PDM_DMA) ? " VM_FF_PDM_DMA" : ""));
888#ifdef LOG_ENABLED
889 for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
890 {
891 PVMCPU pVCpu = &pVM->aCpus[idCpu];
892 LogFlow(("pdmR3LoadPrep: VCPU %u %s%s\n", idCpu,
893 VMCPU_FF_IS_SET(pVCpu, VMCPU_FF_INTERRUPT_APIC) ? " VMCPU_FF_INTERRUPT_APIC" : "",
894 VMCPU_FF_IS_SET(pVCpu, VMCPU_FF_INTERRUPT_PIC) ? " VMCPU_FF_INTERRUPT_PIC" : ""));
895 }
896#endif
897 NOREF(pSSM);
898
899 /*
900 * In case there is work pending that will raise an interrupt,
901 * start a DMA transfer, or release a lock. (unlikely)
902 */
903 if (VM_FF_IS_SET(pVM, VM_FF_PDM_QUEUES))
904 PDMR3QueueFlushAll(pVM);
905
906 /* Clear the FFs. */
907 for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
908 {
909 PVMCPU pVCpu = &pVM->aCpus[idCpu];
910 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_APIC);
911 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_PIC);
912 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_NMI);
913 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_SMI);
914 }
915 VM_FF_CLEAR(pVM, VM_FF_PDM_DMA);
916
917 return VINF_SUCCESS;
918}
919
920
921/**
922 * Execute state load operation.
923 *
924 * @returns VBox status code.
925 * @param pVM The cross context VM structure.
926 * @param pSSM SSM operation handle.
927 * @param uVersion Data layout version.
928 * @param uPass The data pass.
929 */
930static DECLCALLBACK(int) pdmR3LoadExec(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
931{
932 int rc;
933
934 LogFlow(("pdmR3LoadExec: uPass=%#x\n", uPass));
935
936 /*
937 * Validate version.
938 */
939 if ( uVersion != PDM_SAVED_STATE_VERSION
940 && uVersion != PDM_SAVED_STATE_VERSION_PRE_NMI_FF
941 && uVersion != PDM_SAVED_STATE_VERSION_PRE_PDM_AUDIO)
942 {
943 AssertMsgFailed(("Invalid version uVersion=%d!\n", uVersion));
944 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
945 }
946
947 if (uPass == SSM_PASS_FINAL)
948 {
949 /*
950 * Load the interrupt and DMA states.
951 */
952 for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
953 {
954 PVMCPU pVCpu = &pVM->aCpus[idCpu];
955
956 /* APIC interrupt */
957 uint32_t fInterruptPending = 0;
958 rc = SSMR3GetU32(pSSM, &fInterruptPending);
959 if (RT_FAILURE(rc))
960 return rc;
961 if (fInterruptPending & ~1)
962 {
963 AssertMsgFailed(("fInterruptPending=%#x (APIC)\n", fInterruptPending));
964 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
965 }
966 AssertRelease(!VMCPU_FF_IS_SET(pVCpu, VMCPU_FF_INTERRUPT_APIC));
967 if (fInterruptPending)
968 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_APIC);
969
970 /* PIC interrupt */
971 fInterruptPending = 0;
972 rc = SSMR3GetU32(pSSM, &fInterruptPending);
973 if (RT_FAILURE(rc))
974 return rc;
975 if (fInterruptPending & ~1)
976 {
977 AssertMsgFailed(("fInterruptPending=%#x (PIC)\n", fInterruptPending));
978 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
979 }
980 AssertRelease(!VMCPU_FF_IS_SET(pVCpu, VMCPU_FF_INTERRUPT_PIC));
981 if (fInterruptPending)
982 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_PIC);
983
984 if (uVersion > PDM_SAVED_STATE_VERSION_PRE_NMI_FF)
985 {
986 /* NMI interrupt */
987 fInterruptPending = 0;
988 rc = SSMR3GetU32(pSSM, &fInterruptPending);
989 if (RT_FAILURE(rc))
990 return rc;
991 if (fInterruptPending & ~1)
992 {
993 AssertMsgFailed(("fInterruptPending=%#x (NMI)\n", fInterruptPending));
994 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
995 }
996 AssertRelease(!VMCPU_FF_IS_SET(pVCpu, VMCPU_FF_INTERRUPT_NMI));
997 if (fInterruptPending)
998 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_NMI);
999
1000 /* SMI interrupt */
1001 fInterruptPending = 0;
1002 rc = SSMR3GetU32(pSSM, &fInterruptPending);
1003 if (RT_FAILURE(rc))
1004 return rc;
1005 if (fInterruptPending & ~1)
1006 {
1007 AssertMsgFailed(("fInterruptPending=%#x (SMI)\n", fInterruptPending));
1008 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
1009 }
1010 AssertRelease(!VMCPU_FF_IS_SET(pVCpu, VMCPU_FF_INTERRUPT_SMI));
1011 if (fInterruptPending)
1012 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_SMI);
1013 }
1014 }
1015
1016 /* DMA pending */
1017 uint32_t fDMAPending = 0;
1018 rc = SSMR3GetU32(pSSM, &fDMAPending);
1019 if (RT_FAILURE(rc))
1020 return rc;
1021 if (fDMAPending & ~1)
1022 {
1023 AssertMsgFailed(("fDMAPending=%#x\n", fDMAPending));
1024 return VERR_SSM_DATA_UNIT_FORMAT_CHANGED;
1025 }
1026 if (fDMAPending)
1027 VM_FF_SET(pVM, VM_FF_PDM_DMA);
1028 Log(("pdmR3LoadExec: VM_FF_PDM_DMA=%RTbool\n", VM_FF_IS_SET(pVM, VM_FF_PDM_DMA)));
1029 }
1030
1031 /*
1032 * Load the list of devices and verify that they are all there.
1033 */
1034 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1035 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_FOUND;
1036
1037 for (uint32_t i = 0; ; i++)
1038 {
1039 /* Get the sequence number / terminator. */
1040 uint32_t u32Sep;
1041 rc = SSMR3GetU32(pSSM, &u32Sep);
1042 if (RT_FAILURE(rc))
1043 return rc;
1044 if (u32Sep == UINT32_MAX)
1045 break;
1046 if (u32Sep != i)
1047 AssertMsgFailedReturn(("Out of sequence. u32Sep=%#x i=%#x\n", u32Sep, i), VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
1048
1049 /* Get the name and instance number. */
1050 char szName[RT_SIZEOFMEMB(PDMDEVREG, szName)];
1051 rc = SSMR3GetStrZ(pSSM, szName, sizeof(szName));
1052 if (RT_FAILURE(rc))
1053 return rc;
1054 uint32_t iInstance;
1055 rc = SSMR3GetU32(pSSM, &iInstance);
1056 if (RT_FAILURE(rc))
1057 return rc;
1058
1059 /* Try locate it. */
1060 PPDMDEVINS pDevIns;
1061 for (pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1062 if ( !RTStrCmp(szName, pDevIns->pReg->szName)
1063 && pDevIns->iInstance == iInstance)
1064 {
1065 AssertLogRelMsgReturn(!(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_FOUND),
1066 ("%s/#%u\n", pDevIns->pReg->szName, pDevIns->iInstance),
1067 VERR_SSM_DATA_UNIT_FORMAT_CHANGED);
1068 pDevIns->Internal.s.fIntFlags |= PDMDEVINSINT_FLAGS_FOUND;
1069 break;
1070 }
1071
1072 if (!pDevIns)
1073 {
1074 bool fSkip = false;
1075
1076 /* Skip the non-existing (deprecated) "AudioSniffer" device stored in the saved state. */
1077 if ( uVersion <= PDM_SAVED_STATE_VERSION_PRE_PDM_AUDIO
1078 && !RTStrCmp(szName, "AudioSniffer"))
1079 fSkip = true;
1080
1081 if (!fSkip)
1082 {
1083 LogRel(("Device '%s'/%d not found in current config\n", szName, iInstance));
1084 if (SSMR3HandleGetAfter(pSSM) != SSMAFTER_DEBUG_IT)
1085 return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Device '%s'/%d not found in current config"), szName, iInstance);
1086 }
1087 }
1088 }
1089
1090 /*
1091 * Check that no additional devices were configured.
1092 */
1093 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1094 if (!(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_FOUND))
1095 {
1096 LogRel(("Device '%s'/%d not found in the saved state\n", pDevIns->pReg->szName, pDevIns->iInstance));
1097 if (SSMR3HandleGetAfter(pSSM) != SSMAFTER_DEBUG_IT)
1098 return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("Device '%s'/%d not found in the saved state"),
1099 pDevIns->pReg->szName, pDevIns->iInstance);
1100 }
1101
1102 return VINF_SUCCESS;
1103}
1104
1105
1106/**
1107 * Worker for PDMR3PowerOn that deals with one driver.
1108 *
1109 * @param pDrvIns The driver instance.
1110 * @param pszDevName The parent device name.
1111 * @param iDevInstance The parent device instance number.
1112 * @param iLun The parent LUN number.
1113 */
1114DECLINLINE(int) pdmR3PowerOnDrv(PPDMDRVINS pDrvIns, const char *pszDevName, uint32_t iDevInstance, uint32_t iLun)
1115{
1116 Assert(pDrvIns->Internal.s.fVMSuspended);
1117 if (pDrvIns->pReg->pfnPowerOn)
1118 {
1119 LogFlow(("PDMR3PowerOn: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1120 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1121 int rc = VINF_SUCCESS; pDrvIns->pReg->pfnPowerOn(pDrvIns);
1122 if (RT_FAILURE(rc))
1123 {
1124 LogRel(("PDMR3PowerOn: Driver '%s'/%d on LUN#%d of device '%s'/%d -> %Rrc\n",
1125 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance, rc));
1126 return rc;
1127 }
1128 }
1129 pDrvIns->Internal.s.fVMSuspended = false;
1130 return VINF_SUCCESS;
1131}
1132
1133
1134/**
1135 * Worker for PDMR3PowerOn that deals with one USB device instance.
1136 *
1137 * @returns VBox status code.
1138 * @param pUsbIns The USB device instance.
1139 */
1140DECLINLINE(int) pdmR3PowerOnUsb(PPDMUSBINS pUsbIns)
1141{
1142 Assert(pUsbIns->Internal.s.fVMSuspended);
1143 if (pUsbIns->pReg->pfnVMPowerOn)
1144 {
1145 LogFlow(("PDMR3PowerOn: Notifying - device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1146 int rc = VINF_SUCCESS; pUsbIns->pReg->pfnVMPowerOn(pUsbIns);
1147 if (RT_FAILURE(rc))
1148 {
1149 LogRel(("PDMR3PowerOn: Device '%s'/%d -> %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1150 return rc;
1151 }
1152 }
1153 pUsbIns->Internal.s.fVMSuspended = false;
1154 return VINF_SUCCESS;
1155}
1156
1157
1158/**
1159 * Worker for PDMR3PowerOn that deals with one device instance.
1160 *
1161 * @returns VBox status code.
1162 * @param pDevIns The device instance.
1163 */
1164DECLINLINE(int) pdmR3PowerOnDev(PPDMDEVINS pDevIns)
1165{
1166 Assert(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_SUSPENDED);
1167 if (pDevIns->pReg->pfnPowerOn)
1168 {
1169 LogFlow(("PDMR3PowerOn: Notifying - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1170 PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
1171 int rc = VINF_SUCCESS; pDevIns->pReg->pfnPowerOn(pDevIns);
1172 PDMCritSectLeave(pDevIns->pCritSectRoR3);
1173 if (RT_FAILURE(rc))
1174 {
1175 LogRel(("PDMR3PowerOn: Device '%s'/%d -> %Rrc\n", pDevIns->pReg->szName, pDevIns->iInstance, rc));
1176 return rc;
1177 }
1178 }
1179 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
1180 return VINF_SUCCESS;
1181}
1182
1183
1184/**
1185 * This function will notify all the devices and their
1186 * attached drivers about the VM now being powered on.
1187 *
1188 * @param pVM The cross context VM structure.
1189 */
1190VMMR3DECL(void) PDMR3PowerOn(PVM pVM)
1191{
1192 LogFlow(("PDMR3PowerOn:\n"));
1193
1194 /*
1195 * Iterate thru the device instances and USB device instances,
1196 * processing the drivers associated with those.
1197 */
1198 int rc = VINF_SUCCESS;
1199 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns && RT_SUCCESS(rc); pDevIns = pDevIns->Internal.s.pNextR3)
1200 {
1201 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun && RT_SUCCESS(rc); pLun = pLun->pNext)
1202 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns && RT_SUCCESS(rc); pDrvIns = pDrvIns->Internal.s.pDown)
1203 rc = pdmR3PowerOnDrv(pDrvIns, pDevIns->pReg->szName, pDevIns->iInstance, pLun->iLun);
1204 if (RT_SUCCESS(rc))
1205 rc = pdmR3PowerOnDev(pDevIns);
1206 }
1207
1208#ifdef VBOX_WITH_USB
1209 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns && RT_SUCCESS(rc); pUsbIns = pUsbIns->Internal.s.pNext)
1210 {
1211 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun && RT_SUCCESS(rc); pLun = pLun->pNext)
1212 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns && RT_SUCCESS(rc); pDrvIns = pDrvIns->Internal.s.pDown)
1213 rc = pdmR3PowerOnDrv(pDrvIns, pUsbIns->pReg->szName, pUsbIns->iInstance, pLun->iLun);
1214 if (RT_SUCCESS(rc))
1215 rc = pdmR3PowerOnUsb(pUsbIns);
1216 }
1217#endif
1218
1219#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1220 pdmR3AsyncCompletionResume(pVM);
1221#endif
1222
1223 /*
1224 * Resume all threads.
1225 */
1226 if (RT_SUCCESS(rc))
1227 pdmR3ThreadResumeAll(pVM);
1228
1229 /*
1230 * On failure, clean up via PDMR3Suspend.
1231 */
1232 if (RT_FAILURE(rc))
1233 PDMR3Suspend(pVM);
1234
1235 LogFlow(("PDMR3PowerOn: returns %Rrc\n", rc));
1236 return /*rc*/;
1237}
1238
1239
1240/**
1241 * Initializes the asynchronous notifi stats structure.
1242 *
1243 * @param pThis The asynchronous notifification stats.
1244 * @param pszOp The name of the operation.
1245 */
1246static void pdmR3NotifyAsyncInit(PPDMNOTIFYASYNCSTATS pThis, const char *pszOp)
1247{
1248 pThis->uStartNsTs = RTTimeNanoTS();
1249 pThis->cNsElapsedNextLog = 0;
1250 pThis->cLoops = 0;
1251 pThis->cAsync = 0;
1252 pThis->pszOp = pszOp;
1253 pThis->offList = 0;
1254 pThis->szList[0] = '\0';
1255}
1256
1257
1258/**
1259 * Begin a new loop, prepares to gather new stats.
1260 *
1261 * @param pThis The asynchronous notifification stats.
1262 */
1263static void pdmR3NotifyAsyncBeginLoop(PPDMNOTIFYASYNCSTATS pThis)
1264{
1265 pThis->cLoops++;
1266 pThis->cAsync = 0;
1267 pThis->offList = 0;
1268 pThis->szList[0] = '\0';
1269}
1270
1271
1272/**
1273 * Records a device or USB device with a pending asynchronous notification.
1274 *
1275 * @param pThis The asynchronous notifification stats.
1276 * @param pszName The name of the thing.
1277 * @param iInstance The instance number.
1278 */
1279static void pdmR3NotifyAsyncAdd(PPDMNOTIFYASYNCSTATS pThis, const char *pszName, uint32_t iInstance)
1280{
1281 pThis->cAsync++;
1282 if (pThis->offList < sizeof(pThis->szList) - 4)
1283 pThis->offList += RTStrPrintf(&pThis->szList[pThis->offList], sizeof(pThis->szList) - pThis->offList,
1284 pThis->offList == 0 ? "%s/%u" : ", %s/%u",
1285 pszName, iInstance);
1286}
1287
1288
1289/**
1290 * Records the asynchronous completition of a reset, suspend or power off.
1291 *
1292 * @param pThis The asynchronous notifification stats.
1293 * @param pszDrvName The driver name.
1294 * @param iDrvInstance The driver instance number.
1295 * @param pszDevName The device or USB device name.
1296 * @param iDevInstance The device or USB device instance number.
1297 * @param iLun The LUN.
1298 */
1299static void pdmR3NotifyAsyncAddDrv(PPDMNOTIFYASYNCSTATS pThis, const char *pszDrvName, uint32_t iDrvInstance,
1300 const char *pszDevName, uint32_t iDevInstance, uint32_t iLun)
1301{
1302 pThis->cAsync++;
1303 if (pThis->offList < sizeof(pThis->szList) - 8)
1304 pThis->offList += RTStrPrintf(&pThis->szList[pThis->offList], sizeof(pThis->szList) - pThis->offList,
1305 pThis->offList == 0 ? "%s/%u/%u/%s/%u" : ", %s/%u/%u/%s/%u",
1306 pszDevName, iDevInstance, iLun, pszDrvName, iDrvInstance);
1307}
1308
1309
1310/**
1311 * Log the stats.
1312 *
1313 * @param pThis The asynchronous notifification stats.
1314 */
1315static void pdmR3NotifyAsyncLog(PPDMNOTIFYASYNCSTATS pThis)
1316{
1317 /*
1318 * Return if we shouldn't log at this point.
1319 * We log with an internval increasing from 0 sec to 60 sec.
1320 */
1321 if (!pThis->cAsync)
1322 return;
1323
1324 uint64_t cNsElapsed = RTTimeNanoTS() - pThis->uStartNsTs;
1325 if (cNsElapsed < pThis->cNsElapsedNextLog)
1326 return;
1327
1328 if (pThis->cNsElapsedNextLog == 0)
1329 pThis->cNsElapsedNextLog = RT_NS_1SEC;
1330 else if (pThis->cNsElapsedNextLog >= RT_NS_1MIN / 2)
1331 pThis->cNsElapsedNextLog = RT_NS_1MIN;
1332 else
1333 pThis->cNsElapsedNextLog *= 2;
1334
1335 /*
1336 * Do the logging.
1337 */
1338 LogRel(("%s: after %5llu ms, %u loops: %u async tasks - %s\n",
1339 pThis->pszOp, cNsElapsed / RT_NS_1MS, pThis->cLoops, pThis->cAsync, pThis->szList));
1340}
1341
1342
1343/**
1344 * Wait for events and process pending requests.
1345 *
1346 * @param pThis The asynchronous notifification stats.
1347 * @param pVM The cross context VM structure.
1348 */
1349static void pdmR3NotifyAsyncWaitAndProcessRequests(PPDMNOTIFYASYNCSTATS pThis, PVM pVM)
1350{
1351 VM_ASSERT_EMT0(pVM);
1352 int rc = VMR3AsyncPdmNotificationWaitU(&pVM->pUVM->aCpus[0]);
1353 AssertReleaseMsg(rc == VINF_SUCCESS, ("%Rrc - %s - %s\n", rc, pThis->pszOp, pThis->szList));
1354
1355 rc = VMR3ReqProcessU(pVM->pUVM, VMCPUID_ANY, true /*fPriorityOnly*/);
1356 AssertReleaseMsg(rc == VINF_SUCCESS, ("%Rrc - %s - %s\n", rc, pThis->pszOp, pThis->szList));
1357 rc = VMR3ReqProcessU(pVM->pUVM, 0/*idDstCpu*/, true /*fPriorityOnly*/);
1358 AssertReleaseMsg(rc == VINF_SUCCESS, ("%Rrc - %s - %s\n", rc, pThis->pszOp, pThis->szList));
1359}
1360
1361
1362/**
1363 * Worker for PDMR3Reset that deals with one driver.
1364 *
1365 * @param pDrvIns The driver instance.
1366 * @param pAsync The structure for recording asynchronous
1367 * notification tasks.
1368 * @param pszDevName The parent device name.
1369 * @param iDevInstance The parent device instance number.
1370 * @param iLun The parent LUN number.
1371 */
1372DECLINLINE(bool) pdmR3ResetDrv(PPDMDRVINS pDrvIns, PPDMNOTIFYASYNCSTATS pAsync,
1373 const char *pszDevName, uint32_t iDevInstance, uint32_t iLun)
1374{
1375 if (!pDrvIns->Internal.s.fVMReset)
1376 {
1377 pDrvIns->Internal.s.fVMReset = true;
1378 if (pDrvIns->pReg->pfnReset)
1379 {
1380 if (!pDrvIns->Internal.s.pfnAsyncNotify)
1381 {
1382 LogFlow(("PDMR3Reset: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1383 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1384 pDrvIns->pReg->pfnReset(pDrvIns);
1385 if (pDrvIns->Internal.s.pfnAsyncNotify)
1386 LogFlow(("PDMR3Reset: Async notification started - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1387 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1388 }
1389 else if (pDrvIns->Internal.s.pfnAsyncNotify(pDrvIns))
1390 {
1391 LogFlow(("PDMR3Reset: Async notification completed - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1392 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1393 pDrvIns->Internal.s.pfnAsyncNotify = NULL;
1394 }
1395 if (pDrvIns->Internal.s.pfnAsyncNotify)
1396 {
1397 pDrvIns->Internal.s.fVMReset = false;
1398 pdmR3NotifyAsyncAddDrv(pAsync, pDrvIns->Internal.s.pDrv->pReg->szName, pDrvIns->iInstance,
1399 pszDevName, iDevInstance, iLun);
1400 return false;
1401 }
1402 }
1403 }
1404 return true;
1405}
1406
1407
1408/**
1409 * Worker for PDMR3Reset that deals with one USB device instance.
1410 *
1411 * @param pUsbIns The USB device instance.
1412 * @param pAsync The structure for recording asynchronous
1413 * notification tasks.
1414 */
1415DECLINLINE(void) pdmR3ResetUsb(PPDMUSBINS pUsbIns, PPDMNOTIFYASYNCSTATS pAsync)
1416{
1417 if (!pUsbIns->Internal.s.fVMReset)
1418 {
1419 pUsbIns->Internal.s.fVMReset = true;
1420 if (pUsbIns->pReg->pfnVMReset)
1421 {
1422 if (!pUsbIns->Internal.s.pfnAsyncNotify)
1423 {
1424 LogFlow(("PDMR3Reset: Notifying - device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1425 pUsbIns->pReg->pfnVMReset(pUsbIns);
1426 if (pUsbIns->Internal.s.pfnAsyncNotify)
1427 LogFlow(("PDMR3Reset: Async notification started - device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1428 }
1429 else if (pUsbIns->Internal.s.pfnAsyncNotify(pUsbIns))
1430 {
1431 LogFlow(("PDMR3Reset: Async notification completed - device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1432 pUsbIns->Internal.s.pfnAsyncNotify = NULL;
1433 }
1434 if (pUsbIns->Internal.s.pfnAsyncNotify)
1435 {
1436 pUsbIns->Internal.s.fVMReset = false;
1437 pdmR3NotifyAsyncAdd(pAsync, pUsbIns->Internal.s.pUsbDev->pReg->szName, pUsbIns->iInstance);
1438 }
1439 }
1440 }
1441}
1442
1443
1444/**
1445 * Worker for PDMR3Reset that deals with one device instance.
1446 *
1447 * @param pDevIns The device instance.
1448 * @param pAsync The structure for recording asynchronous
1449 * notification tasks.
1450 */
1451DECLINLINE(void) pdmR3ResetDev(PPDMDEVINS pDevIns, PPDMNOTIFYASYNCSTATS pAsync)
1452{
1453 if (!(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_RESET))
1454 {
1455 pDevIns->Internal.s.fIntFlags |= PDMDEVINSINT_FLAGS_RESET;
1456 if (pDevIns->pReg->pfnReset)
1457 {
1458 uint64_t cNsElapsed = RTTimeNanoTS();
1459 PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
1460
1461 if (!pDevIns->Internal.s.pfnAsyncNotify)
1462 {
1463 LogFlow(("PDMR3Reset: Notifying - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1464 pDevIns->pReg->pfnReset(pDevIns);
1465 if (pDevIns->Internal.s.pfnAsyncNotify)
1466 LogFlow(("PDMR3Reset: Async notification started - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1467 }
1468 else if (pDevIns->Internal.s.pfnAsyncNotify(pDevIns))
1469 {
1470 LogFlow(("PDMR3Reset: Async notification completed - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1471 pDevIns->Internal.s.pfnAsyncNotify = NULL;
1472 }
1473 if (pDevIns->Internal.s.pfnAsyncNotify)
1474 {
1475 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_RESET;
1476 pdmR3NotifyAsyncAdd(pAsync, pDevIns->Internal.s.pDevR3->pReg->szName, pDevIns->iInstance);
1477 }
1478
1479 PDMCritSectLeave(pDevIns->pCritSectRoR3);
1480 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
1481 if (cNsElapsed >= PDMSUSPEND_WARN_AT_NS)
1482 LogRel(("PDMR3Reset: Device '%s'/%d took %'llu ns to reset\n",
1483 pDevIns->pReg->szName, pDevIns->iInstance, cNsElapsed));
1484 }
1485 }
1486}
1487
1488
1489/**
1490 * Resets a virtual CPU.
1491 *
1492 * Used by PDMR3Reset and CPU hot plugging.
1493 *
1494 * @param pVCpu The cross context virtual CPU structure.
1495 */
1496VMMR3_INT_DECL(void) PDMR3ResetCpu(PVMCPU pVCpu)
1497{
1498 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_APIC);
1499 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_PIC);
1500 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_NMI);
1501 VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_SMI);
1502}
1503
1504
1505/**
1506 * This function will notify all the devices and their attached drivers about
1507 * the VM now being reset.
1508 *
1509 * @param pVM The cross context VM structure.
1510 */
1511VMMR3_INT_DECL(void) PDMR3Reset(PVM pVM)
1512{
1513 LogFlow(("PDMR3Reset:\n"));
1514
1515 /*
1516 * Clear all the reset flags.
1517 */
1518 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1519 {
1520 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_RESET;
1521 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1522 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1523 pDrvIns->Internal.s.fVMReset = false;
1524 }
1525#ifdef VBOX_WITH_USB
1526 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1527 {
1528 pUsbIns->Internal.s.fVMReset = false;
1529 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1530 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1531 pDrvIns->Internal.s.fVMReset = false;
1532 }
1533#endif
1534
1535 /*
1536 * The outer loop repeats until there are no more async requests.
1537 */
1538 PDMNOTIFYASYNCSTATS Async;
1539 pdmR3NotifyAsyncInit(&Async, "PDMR3Reset");
1540 for (;;)
1541 {
1542 pdmR3NotifyAsyncBeginLoop(&Async);
1543
1544 /*
1545 * Iterate thru the device instances and USB device instances,
1546 * processing the drivers associated with those.
1547 */
1548 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1549 {
1550 unsigned const cAsyncStart = Async.cAsync;
1551
1552 if (pDevIns->pReg->fFlags & PDM_DEVREG_FLAGS_FIRST_RESET_NOTIFICATION)
1553 pdmR3ResetDev(pDevIns, &Async);
1554
1555 if (Async.cAsync == cAsyncStart)
1556 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1557 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1558 if (!pdmR3ResetDrv(pDrvIns, &Async, pDevIns->pReg->szName, pDevIns->iInstance, pLun->iLun))
1559 break;
1560
1561 if ( Async.cAsync == cAsyncStart
1562 && !(pDevIns->pReg->fFlags & PDM_DEVREG_FLAGS_FIRST_RESET_NOTIFICATION))
1563 pdmR3ResetDev(pDevIns, &Async);
1564 }
1565
1566#ifdef VBOX_WITH_USB
1567 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1568 {
1569 unsigned const cAsyncStart = Async.cAsync;
1570
1571 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1572 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1573 if (!pdmR3ResetDrv(pDrvIns, &Async, pUsbIns->pReg->szName, pUsbIns->iInstance, pLun->iLun))
1574 break;
1575
1576 if (Async.cAsync == cAsyncStart)
1577 pdmR3ResetUsb(pUsbIns, &Async);
1578 }
1579#endif
1580 if (!Async.cAsync)
1581 break;
1582 pdmR3NotifyAsyncLog(&Async);
1583 pdmR3NotifyAsyncWaitAndProcessRequests(&Async, pVM);
1584 }
1585
1586 /*
1587 * Clear all pending interrupts and DMA operations.
1588 */
1589 for (VMCPUID idCpu = 0; idCpu < pVM->cCpus; idCpu++)
1590 PDMR3ResetCpu(&pVM->aCpus[idCpu]);
1591 VM_FF_CLEAR(pVM, VM_FF_PDM_DMA);
1592
1593 LogFlow(("PDMR3Reset: returns void\n"));
1594}
1595
1596
1597/**
1598 * This function will tell all the devices to setup up their memory structures
1599 * after VM construction and after VM reset.
1600 *
1601 * @param pVM The cross context VM structure.
1602 * @param fAtReset Indicates the context, after reset if @c true or after
1603 * construction if @c false.
1604 */
1605VMMR3_INT_DECL(void) PDMR3MemSetup(PVM pVM, bool fAtReset)
1606{
1607 LogFlow(("PDMR3MemSetup: fAtReset=%RTbool\n", fAtReset));
1608 PDMDEVMEMSETUPCTX const enmCtx = fAtReset ? PDMDEVMEMSETUPCTX_AFTER_RESET : PDMDEVMEMSETUPCTX_AFTER_CONSTRUCTION;
1609
1610 /*
1611 * Iterate thru the device instances and work the callback.
1612 */
1613 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1614 if (pDevIns->pReg->pfnMemSetup)
1615 {
1616 PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
1617 pDevIns->pReg->pfnMemSetup(pDevIns, enmCtx);
1618 PDMCritSectLeave(pDevIns->pCritSectRoR3);
1619 }
1620
1621 LogFlow(("PDMR3MemSetup: returns void\n"));
1622}
1623
1624
1625/**
1626 * Retrieves and resets the info left behind by PDMDevHlpVMReset.
1627 *
1628 * @returns True if hard reset, false if soft reset.
1629 * @param pVM The cross context VM structure.
1630 * @param fOverride If non-zero, the override flags will be used instead
1631 * of the reset flags kept by PDM. (For triple faults.)
1632 * @param pfResetFlags Where to return the reset flags (PDMVMRESET_F_XXX).
1633 * @thread EMT
1634 */
1635VMMR3_INT_DECL(bool) PDMR3GetResetInfo(PVM pVM, uint32_t fOverride, uint32_t *pfResetFlags)
1636{
1637 VM_ASSERT_EMT(pVM);
1638
1639 /*
1640 * Get the reset flags.
1641 */
1642 uint32_t fResetFlags;
1643 fResetFlags = ASMAtomicXchgU32(&pVM->pdm.s.fResetFlags, 0);
1644 if (fOverride)
1645 fResetFlags = fOverride;
1646 *pfResetFlags = fResetFlags;
1647
1648 /*
1649 * To try avoid trouble, we never ever do soft/warm resets on SMP systems
1650 * with more than CPU #0 active. However, if only one CPU is active we
1651 * will ask the firmware what it wants us to do (because the firmware may
1652 * depend on the VMM doing a lot of what is normally its responsibility,
1653 * like clearing memory).
1654 */
1655 bool fOtherCpusActive = false;
1656 VMCPUID iCpu = pVM->cCpus;
1657 while (iCpu-- > 1)
1658 {
1659 EMSTATE enmState = EMGetState(&pVM->aCpus[iCpu]);
1660 if ( enmState != EMSTATE_WAIT_SIPI
1661 && enmState != EMSTATE_NONE)
1662 {
1663 fOtherCpusActive = true;
1664 break;
1665 }
1666 }
1667
1668 bool fHardReset = fOtherCpusActive
1669 || (fResetFlags & PDMVMRESET_F_SRC_MASK) < PDMVMRESET_F_LAST_ALWAYS_HARD
1670 || !pVM->pdm.s.pFirmware
1671 || pVM->pdm.s.pFirmware->Reg.pfnIsHardReset(pVM->pdm.s.pFirmware->pDevIns, fResetFlags);
1672
1673 Log(("PDMR3GetResetInfo: returns fHardReset=%RTbool fResetFlags=%#x\n", fHardReset, fResetFlags));
1674 return fHardReset;
1675}
1676
1677
1678/**
1679 * Performs a soft reset of devices.
1680 *
1681 * @param pVM The cross context VM structure.
1682 * @param fResetFlags PDMVMRESET_F_XXX.
1683 */
1684VMMR3_INT_DECL(void) PDMR3SoftReset(PVM pVM, uint32_t fResetFlags)
1685{
1686 LogFlow(("PDMR3SoftReset: fResetFlags=%#x\n", fResetFlags));
1687
1688 /*
1689 * Iterate thru the device instances and work the callback.
1690 */
1691 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1692 if (pDevIns->pReg->pfnSoftReset)
1693 {
1694 PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
1695 pDevIns->pReg->pfnSoftReset(pDevIns, fResetFlags);
1696 PDMCritSectLeave(pDevIns->pCritSectRoR3);
1697 }
1698
1699 LogFlow(("PDMR3SoftReset: returns void\n"));
1700}
1701
1702
1703/**
1704 * Worker for PDMR3Suspend that deals with one driver.
1705 *
1706 * @param pDrvIns The driver instance.
1707 * @param pAsync The structure for recording asynchronous
1708 * notification tasks.
1709 * @param pszDevName The parent device name.
1710 * @param iDevInstance The parent device instance number.
1711 * @param iLun The parent LUN number.
1712 */
1713DECLINLINE(bool) pdmR3SuspendDrv(PPDMDRVINS pDrvIns, PPDMNOTIFYASYNCSTATS pAsync,
1714 const char *pszDevName, uint32_t iDevInstance, uint32_t iLun)
1715{
1716 if (!pDrvIns->Internal.s.fVMSuspended)
1717 {
1718 pDrvIns->Internal.s.fVMSuspended = true;
1719 if (pDrvIns->pReg->pfnSuspend)
1720 {
1721 uint64_t cNsElapsed = RTTimeNanoTS();
1722
1723 if (!pDrvIns->Internal.s.pfnAsyncNotify)
1724 {
1725 LogFlow(("PDMR3Suspend: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1726 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1727 pDrvIns->pReg->pfnSuspend(pDrvIns);
1728 if (pDrvIns->Internal.s.pfnAsyncNotify)
1729 LogFlow(("PDMR3Suspend: Async notification started - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1730 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1731 }
1732 else if (pDrvIns->Internal.s.pfnAsyncNotify(pDrvIns))
1733 {
1734 LogFlow(("PDMR3Suspend: Async notification completed - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1735 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1736 pDrvIns->Internal.s.pfnAsyncNotify = NULL;
1737 }
1738
1739 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
1740 if (cNsElapsed >= PDMSUSPEND_WARN_AT_NS)
1741 LogRel(("PDMR3Suspend: Driver '%s'/%d on LUN#%d of device '%s'/%d took %'llu ns to suspend\n",
1742 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance, cNsElapsed));
1743
1744 if (pDrvIns->Internal.s.pfnAsyncNotify)
1745 {
1746 pDrvIns->Internal.s.fVMSuspended = false;
1747 pdmR3NotifyAsyncAddDrv(pAsync, pDrvIns->Internal.s.pDrv->pReg->szName, pDrvIns->iInstance, pszDevName, iDevInstance, iLun);
1748 return false;
1749 }
1750 }
1751 }
1752 return true;
1753}
1754
1755
1756/**
1757 * Worker for PDMR3Suspend that deals with one USB device instance.
1758 *
1759 * @param pUsbIns The USB device instance.
1760 * @param pAsync The structure for recording asynchronous
1761 * notification tasks.
1762 */
1763DECLINLINE(void) pdmR3SuspendUsb(PPDMUSBINS pUsbIns, PPDMNOTIFYASYNCSTATS pAsync)
1764{
1765 if (!pUsbIns->Internal.s.fVMSuspended)
1766 {
1767 pUsbIns->Internal.s.fVMSuspended = true;
1768 if (pUsbIns->pReg->pfnVMSuspend)
1769 {
1770 uint64_t cNsElapsed = RTTimeNanoTS();
1771
1772 if (!pUsbIns->Internal.s.pfnAsyncNotify)
1773 {
1774 LogFlow(("PDMR3Suspend: Notifying - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1775 pUsbIns->pReg->pfnVMSuspend(pUsbIns);
1776 if (pUsbIns->Internal.s.pfnAsyncNotify)
1777 LogFlow(("PDMR3Suspend: Async notification started - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1778 }
1779 else if (pUsbIns->Internal.s.pfnAsyncNotify(pUsbIns))
1780 {
1781 LogFlow(("PDMR3Suspend: Async notification completed - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1782 pUsbIns->Internal.s.pfnAsyncNotify = NULL;
1783 }
1784 if (pUsbIns->Internal.s.pfnAsyncNotify)
1785 {
1786 pUsbIns->Internal.s.fVMSuspended = false;
1787 pdmR3NotifyAsyncAdd(pAsync, pUsbIns->Internal.s.pUsbDev->pReg->szName, pUsbIns->iInstance);
1788 }
1789
1790 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
1791 if (cNsElapsed >= PDMSUSPEND_WARN_AT_NS)
1792 LogRel(("PDMR3Suspend: USB device '%s'/%d took %'llu ns to suspend\n",
1793 pUsbIns->pReg->szName, pUsbIns->iInstance, cNsElapsed));
1794 }
1795 }
1796}
1797
1798
1799/**
1800 * Worker for PDMR3Suspend that deals with one device instance.
1801 *
1802 * @param pDevIns The device instance.
1803 * @param pAsync The structure for recording asynchronous
1804 * notification tasks.
1805 */
1806DECLINLINE(void) pdmR3SuspendDev(PPDMDEVINS pDevIns, PPDMNOTIFYASYNCSTATS pAsync)
1807{
1808 if (!(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_SUSPENDED))
1809 {
1810 pDevIns->Internal.s.fIntFlags |= PDMDEVINSINT_FLAGS_SUSPENDED;
1811 if (pDevIns->pReg->pfnSuspend)
1812 {
1813 uint64_t cNsElapsed = RTTimeNanoTS();
1814 PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
1815
1816 if (!pDevIns->Internal.s.pfnAsyncNotify)
1817 {
1818 LogFlow(("PDMR3Suspend: Notifying - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1819 pDevIns->pReg->pfnSuspend(pDevIns);
1820 if (pDevIns->Internal.s.pfnAsyncNotify)
1821 LogFlow(("PDMR3Suspend: Async notification started - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1822 }
1823 else if (pDevIns->Internal.s.pfnAsyncNotify(pDevIns))
1824 {
1825 LogFlow(("PDMR3Suspend: Async notification completed - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1826 pDevIns->Internal.s.pfnAsyncNotify = NULL;
1827 }
1828 if (pDevIns->Internal.s.pfnAsyncNotify)
1829 {
1830 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
1831 pdmR3NotifyAsyncAdd(pAsync, pDevIns->Internal.s.pDevR3->pReg->szName, pDevIns->iInstance);
1832 }
1833
1834 PDMCritSectLeave(pDevIns->pCritSectRoR3);
1835 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
1836 if (cNsElapsed >= PDMSUSPEND_WARN_AT_NS)
1837 LogRel(("PDMR3Suspend: Device '%s'/%d took %'llu ns to suspend\n",
1838 pDevIns->pReg->szName, pDevIns->iInstance, cNsElapsed));
1839 }
1840 }
1841}
1842
1843
1844/**
1845 * This function will notify all the devices and their attached drivers about
1846 * the VM now being suspended.
1847 *
1848 * @param pVM The cross context VM structure.
1849 * @thread EMT(0)
1850 */
1851VMMR3_INT_DECL(void) PDMR3Suspend(PVM pVM)
1852{
1853 LogFlow(("PDMR3Suspend:\n"));
1854 VM_ASSERT_EMT0(pVM);
1855 uint64_t cNsElapsed = RTTimeNanoTS();
1856
1857 /*
1858 * The outer loop repeats until there are no more async requests.
1859 *
1860 * Note! We depend on the suspended indicators to be in the desired state
1861 * and we do not reset them before starting because this allows
1862 * PDMR3PowerOn and PDMR3Resume to use PDMR3Suspend for cleaning up
1863 * on failure.
1864 */
1865 PDMNOTIFYASYNCSTATS Async;
1866 pdmR3NotifyAsyncInit(&Async, "PDMR3Suspend");
1867 for (;;)
1868 {
1869 pdmR3NotifyAsyncBeginLoop(&Async);
1870
1871 /*
1872 * Iterate thru the device instances and USB device instances,
1873 * processing the drivers associated with those.
1874 *
1875 * The attached drivers are normally processed first. Some devices
1876 * (like DevAHCI) though needs to be notified before the drivers so
1877 * that it doesn't kick off any new requests after the drivers stopped
1878 * taking any. (DrvVD changes to read-only in this particular case.)
1879 */
1880 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1881 {
1882 unsigned const cAsyncStart = Async.cAsync;
1883
1884 if (pDevIns->pReg->fFlags & PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION)
1885 pdmR3SuspendDev(pDevIns, &Async);
1886
1887 if (Async.cAsync == cAsyncStart)
1888 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1889 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1890 if (!pdmR3SuspendDrv(pDrvIns, &Async, pDevIns->pReg->szName, pDevIns->iInstance, pLun->iLun))
1891 break;
1892
1893 if ( Async.cAsync == cAsyncStart
1894 && !(pDevIns->pReg->fFlags & PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION))
1895 pdmR3SuspendDev(pDevIns, &Async);
1896 }
1897
1898#ifdef VBOX_WITH_USB
1899 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1900 {
1901 unsigned const cAsyncStart = Async.cAsync;
1902
1903 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1904 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1905 if (!pdmR3SuspendDrv(pDrvIns, &Async, pUsbIns->pReg->szName, pUsbIns->iInstance, pLun->iLun))
1906 break;
1907
1908 if (Async.cAsync == cAsyncStart)
1909 pdmR3SuspendUsb(pUsbIns, &Async);
1910 }
1911#endif
1912 if (!Async.cAsync)
1913 break;
1914 pdmR3NotifyAsyncLog(&Async);
1915 pdmR3NotifyAsyncWaitAndProcessRequests(&Async, pVM);
1916 }
1917
1918 /*
1919 * Suspend all threads.
1920 */
1921 pdmR3ThreadSuspendAll(pVM);
1922
1923 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
1924 LogRel(("PDMR3Suspend: %'llu ns run time\n", cNsElapsed));
1925}
1926
1927
1928/**
1929 * Worker for PDMR3Resume that deals with one driver.
1930 *
1931 * @param pDrvIns The driver instance.
1932 * @param pszDevName The parent device name.
1933 * @param iDevInstance The parent device instance number.
1934 * @param iLun The parent LUN number.
1935 */
1936DECLINLINE(int) pdmR3ResumeDrv(PPDMDRVINS pDrvIns, const char *pszDevName, uint32_t iDevInstance, uint32_t iLun)
1937{
1938 Assert(pDrvIns->Internal.s.fVMSuspended);
1939 if (pDrvIns->pReg->pfnResume)
1940 {
1941 LogFlow(("PDMR3Resume: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1942 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1943 int rc = VINF_SUCCESS; pDrvIns->pReg->pfnResume(pDrvIns);
1944 if (RT_FAILURE(rc))
1945 {
1946 LogRel(("PDMR3Resume: Driver '%s'/%d on LUN#%d of device '%s'/%d -> %Rrc\n",
1947 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance, rc));
1948 return rc;
1949 }
1950 }
1951 pDrvIns->Internal.s.fVMSuspended = false;
1952 return VINF_SUCCESS;
1953}
1954
1955
1956/**
1957 * Worker for PDMR3Resume that deals with one USB device instance.
1958 *
1959 * @returns VBox status code.
1960 * @param pUsbIns The USB device instance.
1961 */
1962DECLINLINE(int) pdmR3ResumeUsb(PPDMUSBINS pUsbIns)
1963{
1964 Assert(pUsbIns->Internal.s.fVMSuspended);
1965 if (pUsbIns->pReg->pfnVMResume)
1966 {
1967 LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1968 int rc = VINF_SUCCESS; pUsbIns->pReg->pfnVMResume(pUsbIns);
1969 if (RT_FAILURE(rc))
1970 {
1971 LogRel(("PDMR3Resume: Device '%s'/%d -> %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1972 return rc;
1973 }
1974 }
1975 pUsbIns->Internal.s.fVMSuspended = false;
1976 return VINF_SUCCESS;
1977}
1978
1979
1980/**
1981 * Worker for PDMR3Resume that deals with one device instance.
1982 *
1983 * @returns VBox status code.
1984 * @param pDevIns The device instance.
1985 */
1986DECLINLINE(int) pdmR3ResumeDev(PPDMDEVINS pDevIns)
1987{
1988 Assert(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_SUSPENDED);
1989 if (pDevIns->pReg->pfnResume)
1990 {
1991 LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1992 PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
1993 int rc = VINF_SUCCESS; pDevIns->pReg->pfnResume(pDevIns);
1994 PDMCritSectLeave(pDevIns->pCritSectRoR3);
1995 if (RT_FAILURE(rc))
1996 {
1997 LogRel(("PDMR3Resume: Device '%s'/%d -> %Rrc\n", pDevIns->pReg->szName, pDevIns->iInstance, rc));
1998 return rc;
1999 }
2000 }
2001 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
2002 return VINF_SUCCESS;
2003}
2004
2005
2006/**
2007 * This function will notify all the devices and their
2008 * attached drivers about the VM now being resumed.
2009 *
2010 * @param pVM The cross context VM structure.
2011 */
2012VMMR3_INT_DECL(void) PDMR3Resume(PVM pVM)
2013{
2014 LogFlow(("PDMR3Resume:\n"));
2015
2016 /*
2017 * Iterate thru the device instances and USB device instances,
2018 * processing the drivers associated with those.
2019 */
2020 int rc = VINF_SUCCESS;
2021 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns && RT_SUCCESS(rc); pDevIns = pDevIns->Internal.s.pNextR3)
2022 {
2023 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun && RT_SUCCESS(rc); pLun = pLun->pNext)
2024 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns && RT_SUCCESS(rc); pDrvIns = pDrvIns->Internal.s.pDown)
2025 rc = pdmR3ResumeDrv(pDrvIns, pDevIns->pReg->szName, pDevIns->iInstance, pLun->iLun);
2026 if (RT_SUCCESS(rc))
2027 rc = pdmR3ResumeDev(pDevIns);
2028 }
2029
2030#ifdef VBOX_WITH_USB
2031 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns && RT_SUCCESS(rc); pUsbIns = pUsbIns->Internal.s.pNext)
2032 {
2033 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun && RT_SUCCESS(rc); pLun = pLun->pNext)
2034 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns && RT_SUCCESS(rc); pDrvIns = pDrvIns->Internal.s.pDown)
2035 rc = pdmR3ResumeDrv(pDrvIns, pUsbIns->pReg->szName, pUsbIns->iInstance, pLun->iLun);
2036 if (RT_SUCCESS(rc))
2037 rc = pdmR3ResumeUsb(pUsbIns);
2038 }
2039#endif
2040
2041 /*
2042 * Resume all threads.
2043 */
2044 if (RT_SUCCESS(rc))
2045 pdmR3ThreadResumeAll(pVM);
2046
2047 /*
2048 * Resume the block cache.
2049 */
2050 if (RT_SUCCESS(rc))
2051 pdmR3BlkCacheResume(pVM);
2052
2053 /*
2054 * On failure, clean up via PDMR3Suspend.
2055 */
2056 if (RT_FAILURE(rc))
2057 PDMR3Suspend(pVM);
2058
2059 LogFlow(("PDMR3Resume: returns %Rrc\n", rc));
2060 return /*rc*/;
2061}
2062
2063
2064/**
2065 * Worker for PDMR3PowerOff that deals with one driver.
2066 *
2067 * @param pDrvIns The driver instance.
2068 * @param pAsync The structure for recording asynchronous
2069 * notification tasks.
2070 * @param pszDevName The parent device name.
2071 * @param iDevInstance The parent device instance number.
2072 * @param iLun The parent LUN number.
2073 */
2074DECLINLINE(bool) pdmR3PowerOffDrv(PPDMDRVINS pDrvIns, PPDMNOTIFYASYNCSTATS pAsync,
2075 const char *pszDevName, uint32_t iDevInstance, uint32_t iLun)
2076{
2077 if (!pDrvIns->Internal.s.fVMSuspended)
2078 {
2079 pDrvIns->Internal.s.fVMSuspended = true;
2080 if (pDrvIns->pReg->pfnPowerOff)
2081 {
2082 uint64_t cNsElapsed = RTTimeNanoTS();
2083
2084 if (!pDrvIns->Internal.s.pfnAsyncNotify)
2085 {
2086 LogFlow(("PDMR3PowerOff: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
2087 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
2088 pDrvIns->pReg->pfnPowerOff(pDrvIns);
2089 if (pDrvIns->Internal.s.pfnAsyncNotify)
2090 LogFlow(("PDMR3PowerOff: Async notification started - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
2091 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
2092 }
2093 else if (pDrvIns->Internal.s.pfnAsyncNotify(pDrvIns))
2094 {
2095 LogFlow(("PDMR3PowerOff: Async notification completed - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
2096 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
2097 pDrvIns->Internal.s.pfnAsyncNotify = NULL;
2098 }
2099
2100 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
2101 if (cNsElapsed >= PDMPOWEROFF_WARN_AT_NS)
2102 LogRel(("PDMR3PowerOff: Driver '%s'/%d on LUN#%d of device '%s'/%d took %'llu ns to power off\n",
2103 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance, cNsElapsed));
2104
2105 if (pDrvIns->Internal.s.pfnAsyncNotify)
2106 {
2107 pDrvIns->Internal.s.fVMSuspended = false;
2108 pdmR3NotifyAsyncAddDrv(pAsync, pDrvIns->Internal.s.pDrv->pReg->szName, pDrvIns->iInstance,
2109 pszDevName, iDevInstance, iLun);
2110 return false;
2111 }
2112 }
2113 }
2114 return true;
2115}
2116
2117
2118/**
2119 * Worker for PDMR3PowerOff that deals with one USB device instance.
2120 *
2121 * @param pUsbIns The USB device instance.
2122 * @param pAsync The structure for recording asynchronous
2123 * notification tasks.
2124 */
2125DECLINLINE(void) pdmR3PowerOffUsb(PPDMUSBINS pUsbIns, PPDMNOTIFYASYNCSTATS pAsync)
2126{
2127 if (!pUsbIns->Internal.s.fVMSuspended)
2128 {
2129 pUsbIns->Internal.s.fVMSuspended = true;
2130 if (pUsbIns->pReg->pfnVMPowerOff)
2131 {
2132 uint64_t cNsElapsed = RTTimeNanoTS();
2133
2134 if (!pUsbIns->Internal.s.pfnAsyncNotify)
2135 {
2136 LogFlow(("PDMR3PowerOff: Notifying - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
2137 pUsbIns->pReg->pfnVMPowerOff(pUsbIns);
2138 if (pUsbIns->Internal.s.pfnAsyncNotify)
2139 LogFlow(("PDMR3PowerOff: Async notification started - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
2140 }
2141 else if (pUsbIns->Internal.s.pfnAsyncNotify(pUsbIns))
2142 {
2143 LogFlow(("PDMR3PowerOff: Async notification completed - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
2144 pUsbIns->Internal.s.pfnAsyncNotify = NULL;
2145 }
2146 if (pUsbIns->Internal.s.pfnAsyncNotify)
2147 {
2148 pUsbIns->Internal.s.fVMSuspended = false;
2149 pdmR3NotifyAsyncAdd(pAsync, pUsbIns->Internal.s.pUsbDev->pReg->szName, pUsbIns->iInstance);
2150 }
2151
2152 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
2153 if (cNsElapsed >= PDMPOWEROFF_WARN_AT_NS)
2154 LogRel(("PDMR3PowerOff: USB device '%s'/%d took %'llu ns to power off\n",
2155 pUsbIns->pReg->szName, pUsbIns->iInstance, cNsElapsed));
2156
2157 }
2158 }
2159}
2160
2161
2162/**
2163 * Worker for PDMR3PowerOff that deals with one device instance.
2164 *
2165 * @param pDevIns The device instance.
2166 * @param pAsync The structure for recording asynchronous
2167 * notification tasks.
2168 */
2169DECLINLINE(void) pdmR3PowerOffDev(PPDMDEVINS pDevIns, PPDMNOTIFYASYNCSTATS pAsync)
2170{
2171 if (!(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_SUSPENDED))
2172 {
2173 pDevIns->Internal.s.fIntFlags |= PDMDEVINSINT_FLAGS_SUSPENDED;
2174 if (pDevIns->pReg->pfnPowerOff)
2175 {
2176 uint64_t cNsElapsed = RTTimeNanoTS();
2177 PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
2178
2179 if (!pDevIns->Internal.s.pfnAsyncNotify)
2180 {
2181 LogFlow(("PDMR3PowerOff: Notifying - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
2182 pDevIns->pReg->pfnPowerOff(pDevIns);
2183 if (pDevIns->Internal.s.pfnAsyncNotify)
2184 LogFlow(("PDMR3PowerOff: Async notification started - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
2185 }
2186 else if (pDevIns->Internal.s.pfnAsyncNotify(pDevIns))
2187 {
2188 LogFlow(("PDMR3PowerOff: Async notification completed - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
2189 pDevIns->Internal.s.pfnAsyncNotify = NULL;
2190 }
2191 if (pDevIns->Internal.s.pfnAsyncNotify)
2192 {
2193 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
2194 pdmR3NotifyAsyncAdd(pAsync, pDevIns->Internal.s.pDevR3->pReg->szName, pDevIns->iInstance);
2195 }
2196
2197 PDMCritSectLeave(pDevIns->pCritSectRoR3);
2198 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
2199 if (cNsElapsed >= PDMPOWEROFF_WARN_AT_NS)
2200 LogFlow(("PDMR3PowerOff: Device '%s'/%d took %'llu ns to power off\n",
2201 pDevIns->pReg->szName, pDevIns->iInstance, cNsElapsed));
2202 }
2203 }
2204}
2205
2206
2207/**
2208 * This function will notify all the devices and their
2209 * attached drivers about the VM being powered off.
2210 *
2211 * @param pVM The cross context VM structure.
2212 */
2213VMMR3DECL(void) PDMR3PowerOff(PVM pVM)
2214{
2215 LogFlow(("PDMR3PowerOff:\n"));
2216 uint64_t cNsElapsed = RTTimeNanoTS();
2217
2218 /*
2219 * Clear the suspended flags on all devices and drivers first because they
2220 * might have been set during a suspend but the power off callbacks should
2221 * be called in any case.
2222 */
2223 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2224 {
2225 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
2226
2227 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2228 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2229 pDrvIns->Internal.s.fVMSuspended = false;
2230 }
2231
2232#ifdef VBOX_WITH_USB
2233 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2234 {
2235 pUsbIns->Internal.s.fVMSuspended = false;
2236
2237 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2238 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2239 pDrvIns->Internal.s.fVMSuspended = false;
2240 }
2241#endif
2242
2243 /*
2244 * The outer loop repeats until there are no more async requests.
2245 */
2246 PDMNOTIFYASYNCSTATS Async;
2247 pdmR3NotifyAsyncInit(&Async, "PDMR3PowerOff");
2248 for (;;)
2249 {
2250 pdmR3NotifyAsyncBeginLoop(&Async);
2251
2252 /*
2253 * Iterate thru the device instances and USB device instances,
2254 * processing the drivers associated with those.
2255 *
2256 * The attached drivers are normally processed first. Some devices
2257 * (like DevAHCI) though needs to be notified before the drivers so
2258 * that it doesn't kick off any new requests after the drivers stopped
2259 * taking any. (DrvVD changes to read-only in this particular case.)
2260 */
2261 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2262 {
2263 unsigned const cAsyncStart = Async.cAsync;
2264
2265 if (pDevIns->pReg->fFlags & PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION)
2266 pdmR3PowerOffDev(pDevIns, &Async);
2267
2268 if (Async.cAsync == cAsyncStart)
2269 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2270 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2271 if (!pdmR3PowerOffDrv(pDrvIns, &Async, pDevIns->pReg->szName, pDevIns->iInstance, pLun->iLun))
2272 break;
2273
2274 if ( Async.cAsync == cAsyncStart
2275 && !(pDevIns->pReg->fFlags & PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION))
2276 pdmR3PowerOffDev(pDevIns, &Async);
2277 }
2278
2279#ifdef VBOX_WITH_USB
2280 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2281 {
2282 unsigned const cAsyncStart = Async.cAsync;
2283
2284 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2285 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2286 if (!pdmR3PowerOffDrv(pDrvIns, &Async, pUsbIns->pReg->szName, pUsbIns->iInstance, pLun->iLun))
2287 break;
2288
2289 if (Async.cAsync == cAsyncStart)
2290 pdmR3PowerOffUsb(pUsbIns, &Async);
2291 }
2292#endif
2293 if (!Async.cAsync)
2294 break;
2295 pdmR3NotifyAsyncLog(&Async);
2296 pdmR3NotifyAsyncWaitAndProcessRequests(&Async, pVM);
2297 }
2298
2299 /*
2300 * Suspend all threads.
2301 */
2302 pdmR3ThreadSuspendAll(pVM);
2303
2304 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
2305 LogRel(("PDMR3PowerOff: %'llu ns run time\n", cNsElapsed));
2306}
2307
2308
2309/**
2310 * Queries the base interface of a device instance.
2311 *
2312 * The caller can use this to query other interfaces the device implements
2313 * and use them to talk to the device.
2314 *
2315 * @returns VBox status code.
2316 * @param pUVM The user mode VM handle.
2317 * @param pszDevice Device name.
2318 * @param iInstance Device instance.
2319 * @param ppBase Where to store the pointer to the base device interface on success.
2320 * @remark We're not doing any locking ATM, so don't try call this at times when the
2321 * device chain is known to be updated.
2322 */
2323VMMR3DECL(int) PDMR3QueryDevice(PUVM pUVM, const char *pszDevice, unsigned iInstance, PPDMIBASE *ppBase)
2324{
2325 LogFlow(("PDMR3DeviceQuery: pszDevice=%p:{%s} iInstance=%u ppBase=%p\n", pszDevice, pszDevice, iInstance, ppBase));
2326 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
2327 VM_ASSERT_VALID_EXT_RETURN(pUVM->pVM, VERR_INVALID_VM_HANDLE);
2328
2329 /*
2330 * Iterate registered devices looking for the device.
2331 */
2332 size_t cchDevice = strlen(pszDevice);
2333 for (PPDMDEV pDev = pUVM->pVM->pdm.s.pDevs; pDev; pDev = pDev->pNext)
2334 {
2335 if ( pDev->cchName == cchDevice
2336 && !memcmp(pDev->pReg->szName, pszDevice, cchDevice))
2337 {
2338 /*
2339 * Iterate device instances.
2340 */
2341 for (PPDMDEVINS pDevIns = pDev->pInstances; pDevIns; pDevIns = pDevIns->Internal.s.pPerDeviceNextR3)
2342 {
2343 if (pDevIns->iInstance == iInstance)
2344 {
2345 if (pDevIns->IBase.pfnQueryInterface)
2346 {
2347 *ppBase = &pDevIns->IBase;
2348 LogFlow(("PDMR3DeviceQuery: return VINF_SUCCESS and *ppBase=%p\n", *ppBase));
2349 return VINF_SUCCESS;
2350 }
2351
2352 LogFlow(("PDMR3DeviceQuery: returns VERR_PDM_DEVICE_INSTANCE_NO_IBASE\n"));
2353 return VERR_PDM_DEVICE_INSTANCE_NO_IBASE;
2354 }
2355 }
2356
2357 LogFlow(("PDMR3DeviceQuery: returns VERR_PDM_DEVICE_INSTANCE_NOT_FOUND\n"));
2358 return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND;
2359 }
2360 }
2361
2362 LogFlow(("PDMR3QueryDevice: returns VERR_PDM_DEVICE_NOT_FOUND\n"));
2363 return VERR_PDM_DEVICE_NOT_FOUND;
2364}
2365
2366
2367/**
2368 * Queries the base interface of a device LUN.
2369 *
2370 * This differs from PDMR3QueryLun by that it returns the interface on the
2371 * device and not the top level driver.
2372 *
2373 * @returns VBox status code.
2374 * @param pUVM The user mode VM handle.
2375 * @param pszDevice Device name.
2376 * @param iInstance Device instance.
2377 * @param iLun The Logical Unit to obtain the interface of.
2378 * @param ppBase Where to store the base interface pointer.
2379 * @remark We're not doing any locking ATM, so don't try call this at times when the
2380 * device chain is known to be updated.
2381 */
2382VMMR3DECL(int) PDMR3QueryDeviceLun(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
2383{
2384 LogFlow(("PDMR3QueryDeviceLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
2385 pszDevice, pszDevice, iInstance, iLun, ppBase));
2386 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
2387 VM_ASSERT_VALID_EXT_RETURN(pUVM->pVM, VERR_INVALID_VM_HANDLE);
2388
2389 /*
2390 * Find the LUN.
2391 */
2392 PPDMLUN pLun;
2393 int rc = pdmR3DevFindLun(pUVM->pVM, pszDevice, iInstance, iLun, &pLun);
2394 if (RT_SUCCESS(rc))
2395 {
2396 *ppBase = pLun->pBase;
2397 LogFlow(("PDMR3QueryDeviceLun: return VINF_SUCCESS and *ppBase=%p\n", *ppBase));
2398 return VINF_SUCCESS;
2399 }
2400 LogFlow(("PDMR3QueryDeviceLun: returns %Rrc\n", rc));
2401 return rc;
2402}
2403
2404
2405/**
2406 * Query the interface of the top level driver on a LUN.
2407 *
2408 * @returns VBox status code.
2409 * @param pUVM The user mode VM handle.
2410 * @param pszDevice Device name.
2411 * @param iInstance Device instance.
2412 * @param iLun The Logical Unit to obtain the interface of.
2413 * @param ppBase Where to store the base interface pointer.
2414 * @remark We're not doing any locking ATM, so don't try call this at times when the
2415 * device chain is known to be updated.
2416 */
2417VMMR3DECL(int) PDMR3QueryLun(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
2418{
2419 LogFlow(("PDMR3QueryLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
2420 pszDevice, pszDevice, iInstance, iLun, ppBase));
2421 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
2422 PVM pVM = pUVM->pVM;
2423 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
2424
2425 /*
2426 * Find the LUN.
2427 */
2428 PPDMLUN pLun;
2429 int rc = pdmR3DevFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
2430 if (RT_SUCCESS(rc))
2431 {
2432 if (pLun->pTop)
2433 {
2434 *ppBase = &pLun->pTop->IBase;
2435 LogFlow(("PDMR3QueryLun: return %Rrc and *ppBase=%p\n", VINF_SUCCESS, *ppBase));
2436 return VINF_SUCCESS;
2437 }
2438 rc = VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN;
2439 }
2440 LogFlow(("PDMR3QueryLun: returns %Rrc\n", rc));
2441 return rc;
2442}
2443
2444
2445/**
2446 * Query the interface of a named driver on a LUN.
2447 *
2448 * If the driver appears more than once in the driver chain, the first instance
2449 * is returned.
2450 *
2451 * @returns VBox status code.
2452 * @param pUVM The user mode VM handle.
2453 * @param pszDevice Device name.
2454 * @param iInstance Device instance.
2455 * @param iLun The Logical Unit to obtain the interface of.
2456 * @param pszDriver The driver name.
2457 * @param ppBase Where to store the base interface pointer.
2458 *
2459 * @remark We're not doing any locking ATM, so don't try call this at times when the
2460 * device chain is known to be updated.
2461 */
2462VMMR3DECL(int) PDMR3QueryDriverOnLun(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, const char *pszDriver, PPPDMIBASE ppBase)
2463{
2464 LogFlow(("PDMR3QueryDriverOnLun: pszDevice=%p:{%s} iInstance=%u iLun=%u pszDriver=%p:{%s} ppBase=%p\n",
2465 pszDevice, pszDevice, iInstance, iLun, pszDriver, pszDriver, ppBase));
2466 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
2467 VM_ASSERT_VALID_EXT_RETURN(pUVM->pVM, VERR_INVALID_VM_HANDLE);
2468
2469 /*
2470 * Find the LUN.
2471 */
2472 PPDMLUN pLun;
2473 int rc = pdmR3DevFindLun(pUVM->pVM, pszDevice, iInstance, iLun, &pLun);
2474 if (RT_SUCCESS(rc))
2475 {
2476 if (pLun->pTop)
2477 {
2478 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2479 if (!strcmp(pDrvIns->pReg->szName, pszDriver))
2480 {
2481 *ppBase = &pDrvIns->IBase;
2482 LogFlow(("PDMR3QueryDriverOnLun: return %Rrc and *ppBase=%p\n", VINF_SUCCESS, *ppBase));
2483 return VINF_SUCCESS;
2484
2485 }
2486 rc = VERR_PDM_DRIVER_NOT_FOUND;
2487 }
2488 else
2489 rc = VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN;
2490 }
2491 LogFlow(("PDMR3QueryDriverOnLun: returns %Rrc\n", rc));
2492 return rc;
2493}
2494
2495/**
2496 * Executes pending DMA transfers.
2497 * Forced Action handler.
2498 *
2499 * @param pVM The cross context VM structure.
2500 */
2501VMMR3DECL(void) PDMR3DmaRun(PVM pVM)
2502{
2503 /* Note! Not really SMP safe; restrict it to VCPU 0. */
2504 if (VMMGetCpuId(pVM) != 0)
2505 return;
2506
2507 if (VM_FF_TEST_AND_CLEAR(pVM, VM_FF_PDM_DMA))
2508 {
2509 if (pVM->pdm.s.pDmac)
2510 {
2511 bool fMore = pVM->pdm.s.pDmac->Reg.pfnRun(pVM->pdm.s.pDmac->pDevIns);
2512 if (fMore)
2513 VM_FF_SET(pVM, VM_FF_PDM_DMA);
2514 }
2515 }
2516}
2517
2518
2519/**
2520 * Service a VMMCALLRING3_PDM_LOCK call.
2521 *
2522 * @returns VBox status code.
2523 * @param pVM The cross context VM structure.
2524 */
2525VMMR3_INT_DECL(int) PDMR3LockCall(PVM pVM)
2526{
2527 return PDMR3CritSectEnterEx(&pVM->pdm.s.CritSect, true /* fHostCall */);
2528}
2529
2530
2531/**
2532 * Allocates memory from the VMM device heap.
2533 *
2534 * @returns VBox status code.
2535 * @param pVM The cross context VM structure.
2536 * @param cbSize Allocation size.
2537 * @param pfnNotify Mapping/unmapping notification callback.
2538 * @param ppv Ring-3 pointer. (out)
2539 */
2540VMMR3_INT_DECL(int) PDMR3VmmDevHeapAlloc(PVM pVM, size_t cbSize, PFNPDMVMMDEVHEAPNOTIFY pfnNotify, RTR3PTR *ppv)
2541{
2542#ifdef DEBUG_bird
2543 if (!cbSize || cbSize > pVM->pdm.s.cbVMMDevHeapLeft)
2544 return VERR_NO_MEMORY;
2545#else
2546 AssertReturn(cbSize && cbSize <= pVM->pdm.s.cbVMMDevHeapLeft, VERR_NO_MEMORY);
2547#endif
2548
2549 Log(("PDMR3VMMDevHeapAlloc: %#zx\n", cbSize));
2550
2551 /** @todo Not a real heap as there's currently only one user. */
2552 *ppv = pVM->pdm.s.pvVMMDevHeap;
2553 pVM->pdm.s.cbVMMDevHeapLeft = 0;
2554 pVM->pdm.s.pfnVMMDevHeapNotify = pfnNotify;
2555 return VINF_SUCCESS;
2556}
2557
2558
2559/**
2560 * Frees memory from the VMM device heap
2561 *
2562 * @returns VBox status code.
2563 * @param pVM The cross context VM structure.
2564 * @param pv Ring-3 pointer.
2565 */
2566VMMR3_INT_DECL(int) PDMR3VmmDevHeapFree(PVM pVM, RTR3PTR pv)
2567{
2568 Log(("PDMR3VmmDevHeapFree: %RHv\n", pv));
2569
2570 /** @todo not a real heap as there's currently only one user. */
2571 pVM->pdm.s.cbVMMDevHeapLeft = pVM->pdm.s.cbVMMDevHeap;
2572 pVM->pdm.s.pfnVMMDevHeapNotify = NULL;
2573 return VINF_SUCCESS;
2574}
2575
2576
2577/**
2578 * Worker for DBGFR3TraceConfig that checks if the given tracing group name
2579 * matches a device or driver name and applies the tracing config change.
2580 *
2581 * @returns VINF_SUCCESS or VERR_NOT_FOUND.
2582 * @param pVM The cross context VM structure.
2583 * @param pszName The tracing config group name. This is NULL if
2584 * the operation applies to every device and
2585 * driver.
2586 * @param cchName The length to match.
2587 * @param fEnable Whether to enable or disable the corresponding
2588 * trace points.
2589 * @param fApply Whether to actually apply the changes or just do
2590 * existence checks.
2591 */
2592VMMR3_INT_DECL(int) PDMR3TracingConfig(PVM pVM, const char *pszName, size_t cchName, bool fEnable, bool fApply)
2593{
2594 /** @todo This code is potentially racing driver attaching and detaching. */
2595
2596 /*
2597 * Applies to all.
2598 */
2599 if (pszName == NULL)
2600 {
2601 AssertReturn(fApply, VINF_SUCCESS);
2602
2603 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2604 {
2605 pDevIns->fTracing = fEnable;
2606 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2607 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2608 pDrvIns->fTracing = fEnable;
2609 }
2610
2611#ifdef VBOX_WITH_USB
2612 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2613 {
2614 pUsbIns->fTracing = fEnable;
2615 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2616 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2617 pDrvIns->fTracing = fEnable;
2618
2619 }
2620#endif
2621 return VINF_SUCCESS;
2622 }
2623
2624 /*
2625 * Specific devices, USB devices or drivers.
2626 * Decode prefix to figure which of these it applies to.
2627 */
2628 if (cchName <= 3)
2629 return VERR_NOT_FOUND;
2630
2631 uint32_t cMatches = 0;
2632 if (!strncmp("dev", pszName, 3))
2633 {
2634 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2635 {
2636 const char *pszDevName = pDevIns->Internal.s.pDevR3->pReg->szName;
2637 size_t cchDevName = strlen(pszDevName);
2638 if ( ( cchDevName == cchName
2639 && RTStrNICmp(pszName, pszDevName, cchDevName))
2640 || ( cchDevName == cchName - 3
2641 && RTStrNICmp(pszName + 3, pszDevName, cchDevName)) )
2642 {
2643 cMatches++;
2644 if (fApply)
2645 pDevIns->fTracing = fEnable;
2646 }
2647 }
2648 }
2649 else if (!strncmp("usb", pszName, 3))
2650 {
2651 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2652 {
2653 const char *pszUsbName = pUsbIns->Internal.s.pUsbDev->pReg->szName;
2654 size_t cchUsbName = strlen(pszUsbName);
2655 if ( ( cchUsbName == cchName
2656 && RTStrNICmp(pszName, pszUsbName, cchUsbName))
2657 || ( cchUsbName == cchName - 3
2658 && RTStrNICmp(pszName + 3, pszUsbName, cchUsbName)) )
2659 {
2660 cMatches++;
2661 if (fApply)
2662 pUsbIns->fTracing = fEnable;
2663 }
2664 }
2665 }
2666 else if (!strncmp("drv", pszName, 3))
2667 {
2668 AssertReturn(fApply, VINF_SUCCESS);
2669
2670 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2671 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2672 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2673 {
2674 const char *pszDrvName = pDrvIns->Internal.s.pDrv->pReg->szName;
2675 size_t cchDrvName = strlen(pszDrvName);
2676 if ( ( cchDrvName == cchName
2677 && RTStrNICmp(pszName, pszDrvName, cchDrvName))
2678 || ( cchDrvName == cchName - 3
2679 && RTStrNICmp(pszName + 3, pszDrvName, cchDrvName)) )
2680 {
2681 cMatches++;
2682 if (fApply)
2683 pDrvIns->fTracing = fEnable;
2684 }
2685 }
2686
2687#ifdef VBOX_WITH_USB
2688 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2689 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2690 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2691 {
2692 const char *pszDrvName = pDrvIns->Internal.s.pDrv->pReg->szName;
2693 size_t cchDrvName = strlen(pszDrvName);
2694 if ( ( cchDrvName == cchName
2695 && RTStrNICmp(pszName, pszDrvName, cchDrvName))
2696 || ( cchDrvName == cchName - 3
2697 && RTStrNICmp(pszName + 3, pszDrvName, cchDrvName)) )
2698 {
2699 cMatches++;
2700 if (fApply)
2701 pDrvIns->fTracing = fEnable;
2702 }
2703 }
2704#endif
2705 }
2706 else
2707 return VERR_NOT_FOUND;
2708
2709 return cMatches > 0 ? VINF_SUCCESS : VERR_NOT_FOUND;
2710}
2711
2712
2713/**
2714 * Worker for DBGFR3TraceQueryConfig that checks whether all drivers, devices,
2715 * and USB device have the same tracing settings.
2716 *
2717 * @returns true / false.
2718 * @param pVM The cross context VM structure.
2719 * @param fEnabled The tracing setting to check for.
2720 */
2721VMMR3_INT_DECL(bool) PDMR3TracingAreAll(PVM pVM, bool fEnabled)
2722{
2723 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2724 {
2725 if (pDevIns->fTracing != (uint32_t)fEnabled)
2726 return false;
2727
2728 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2729 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2730 if (pDrvIns->fTracing != (uint32_t)fEnabled)
2731 return false;
2732 }
2733
2734#ifdef VBOX_WITH_USB
2735 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2736 {
2737 if (pUsbIns->fTracing != (uint32_t)fEnabled)
2738 return false;
2739
2740 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2741 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2742 if (pDrvIns->fTracing != (uint32_t)fEnabled)
2743 return false;
2744 }
2745#endif
2746
2747 return true;
2748}
2749
2750
2751/**
2752 * Worker for PDMR3TracingQueryConfig that adds a prefixed name to the output
2753 * string.
2754 *
2755 * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW
2756 * @param ppszDst The pointer to the output buffer pointer.
2757 * @param pcbDst The pointer to the output buffer size.
2758 * @param fSpace Whether to add a space before the name.
2759 * @param pszPrefix The name prefix.
2760 * @param pszName The name.
2761 */
2762static int pdmR3TracingAdd(char **ppszDst, size_t *pcbDst, bool fSpace, const char *pszPrefix, const char *pszName)
2763{
2764 size_t const cchPrefix = strlen(pszPrefix);
2765 if (!RTStrNICmp(pszPrefix, pszName, cchPrefix))
2766 pszName += cchPrefix;
2767 size_t const cchName = strlen(pszName);
2768
2769 size_t const cchThis = cchName + cchPrefix + fSpace;
2770 if (cchThis >= *pcbDst)
2771 return VERR_BUFFER_OVERFLOW;
2772 if (fSpace)
2773 {
2774 **ppszDst = ' ';
2775 memcpy(*ppszDst + 1, pszPrefix, cchPrefix);
2776 memcpy(*ppszDst + 1 + cchPrefix, pszName, cchName + 1);
2777 }
2778 else
2779 {
2780 memcpy(*ppszDst, pszPrefix, cchPrefix);
2781 memcpy(*ppszDst + cchPrefix, pszName, cchName + 1);
2782 }
2783 *ppszDst += cchThis;
2784 *pcbDst -= cchThis;
2785 return VINF_SUCCESS;
2786}
2787
2788
2789/**
2790 * Worker for DBGFR3TraceQueryConfig use when not everything is either enabled
2791 * or disabled.
2792 *
2793 * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW
2794 * @param pVM The cross context VM structure.
2795 * @param pszConfig Where to store the config spec.
2796 * @param cbConfig The size of the output buffer.
2797 */
2798VMMR3_INT_DECL(int) PDMR3TracingQueryConfig(PVM pVM, char *pszConfig, size_t cbConfig)
2799{
2800 int rc;
2801 char *pszDst = pszConfig;
2802 size_t cbDst = cbConfig;
2803
2804 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2805 {
2806 if (pDevIns->fTracing)
2807 {
2808 rc = pdmR3TracingAdd(&pszDst, &cbDst, pszDst != pszConfig, "dev", pDevIns->Internal.s.pDevR3->pReg->szName);
2809 if (RT_FAILURE(rc))
2810 return rc;
2811 }
2812
2813 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2814 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2815 if (pDrvIns->fTracing)
2816 {
2817 rc = pdmR3TracingAdd(&pszDst, &cbDst, pszDst != pszConfig, "drv", pDrvIns->Internal.s.pDrv->pReg->szName);
2818 if (RT_FAILURE(rc))
2819 return rc;
2820 }
2821 }
2822
2823#ifdef VBOX_WITH_USB
2824 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2825 {
2826 if (pUsbIns->fTracing)
2827 {
2828 rc = pdmR3TracingAdd(&pszDst, &cbDst, pszDst != pszConfig, "usb", pUsbIns->Internal.s.pUsbDev->pReg->szName);
2829 if (RT_FAILURE(rc))
2830 return rc;
2831 }
2832
2833 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2834 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2835 if (pDrvIns->fTracing)
2836 {
2837 rc = pdmR3TracingAdd(&pszDst, &cbDst, pszDst != pszConfig, "drv", pDrvIns->Internal.s.pDrv->pReg->szName);
2838 if (RT_FAILURE(rc))
2839 return rc;
2840 }
2841 }
2842#endif
2843
2844 return VINF_SUCCESS;
2845}
2846
2847
2848/**
2849 * Checks that a PDMDRVREG::szName, PDMDEVREG::szName or PDMUSBREG::szName
2850 * field contains only a limited set of ASCII characters.
2851 *
2852 * @returns true / false.
2853 * @param pszName The name to validate.
2854 */
2855bool pdmR3IsValidName(const char *pszName)
2856{
2857 char ch;
2858 while ( (ch = *pszName) != '\0'
2859 && ( RT_C_IS_ALNUM(ch)
2860 || ch == '-'
2861 || ch == ' ' /** @todo disallow this! */
2862 || ch == '_') )
2863 pszName++;
2864 return ch == '\0';
2865}
2866
2867
2868/**
2869 * Info handler for 'pdmtracingids'.
2870 *
2871 * @param pVM The cross context VM structure.
2872 * @param pHlp The output helpers.
2873 * @param pszArgs The optional user arguments.
2874 *
2875 * @remarks Can be called on most threads.
2876 */
2877static DECLCALLBACK(void) pdmR3InfoTracingIds(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
2878{
2879 /*
2880 * Parse the argument (optional).
2881 */
2882 if ( pszArgs
2883 && *pszArgs
2884 && strcmp(pszArgs, "all")
2885 && strcmp(pszArgs, "devices")
2886 && strcmp(pszArgs, "drivers")
2887 && strcmp(pszArgs, "usb"))
2888 {
2889 pHlp->pfnPrintf(pHlp, "Unable to grok '%s'\n", pszArgs);
2890 return;
2891 }
2892 bool fAll = !pszArgs || !*pszArgs || !strcmp(pszArgs, "all");
2893 bool fDevices = fAll || !strcmp(pszArgs, "devices");
2894 bool fUsbDevs = fAll || !strcmp(pszArgs, "usb");
2895 bool fDrivers = fAll || !strcmp(pszArgs, "drivers");
2896
2897 /*
2898 * Produce the requested output.
2899 */
2900/** @todo lock PDM lists! */
2901 /* devices */
2902 if (fDevices)
2903 {
2904 pHlp->pfnPrintf(pHlp, "Device tracing IDs:\n");
2905 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2906 pHlp->pfnPrintf(pHlp, "%05u %s\n", pDevIns->idTracing, pDevIns->Internal.s.pDevR3->pReg->szName);
2907 }
2908
2909 /* USB devices */
2910 if (fUsbDevs)
2911 {
2912 pHlp->pfnPrintf(pHlp, "USB device tracing IDs:\n");
2913 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2914 pHlp->pfnPrintf(pHlp, "%05u %s\n", pUsbIns->idTracing, pUsbIns->Internal.s.pUsbDev->pReg->szName);
2915 }
2916
2917 /* Drivers */
2918 if (fDrivers)
2919 {
2920 pHlp->pfnPrintf(pHlp, "Driver tracing IDs:\n");
2921 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2922 {
2923 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2924 {
2925 uint32_t iLevel = 0;
2926 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown, iLevel++)
2927 pHlp->pfnPrintf(pHlp, "%05u %s (level %u, lun %u, dev %s)\n",
2928 pDrvIns->idTracing, pDrvIns->Internal.s.pDrv->pReg->szName,
2929 iLevel, pLun->iLun, pDevIns->Internal.s.pDevR3->pReg->szName);
2930 }
2931 }
2932
2933 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2934 {
2935 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2936 {
2937 uint32_t iLevel = 0;
2938 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown, iLevel++)
2939 pHlp->pfnPrintf(pHlp, "%05u %s (level %u, lun %u, dev %s)\n",
2940 pDrvIns->idTracing, pDrvIns->Internal.s.pDrv->pReg->szName,
2941 iLevel, pLun->iLun, pUsbIns->Internal.s.pUsbDev->pReg->szName);
2942 }
2943 }
2944 }
2945}
2946
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