VirtualBox

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

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

PDM: Call pfnInitComplete after both ring-0 and raw-mode is fully initialized. Used to call this immediately after the devices were initialized.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 106.7 KB
Line 
1/* $Id: PDM.cpp 60387 2016-04-08 08:32:13Z 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/mm.h>
259#include <VBox/vmm/pgm.h>
260#include <VBox/vmm/ssm.h>
261#include <VBox/vmm/hm.h>
262#include <VBox/vmm/vm.h>
263#include <VBox/vmm/uvm.h>
264#include <VBox/vmm/vmm.h>
265#include <VBox/param.h>
266#include <VBox/err.h>
267#include <VBox/sup.h>
268
269#include <VBox/log.h>
270#include <iprt/asm.h>
271#include <iprt/assert.h>
272#include <iprt/alloc.h>
273#include <iprt/ctype.h>
274#include <iprt/ldr.h>
275#include <iprt/path.h>
276#include <iprt/string.h>
277
278
279/*********************************************************************************************************************************
280* Defined Constants And Macros *
281*********************************************************************************************************************************/
282/** The PDM saved state version. */
283#define PDM_SAVED_STATE_VERSION 5
284/** Before the PDM audio architecture was introduced there was an "AudioSniffer"
285 * device which took care of multiplexing input/output audio data from/to various places.
286 * Thus this device is not needed/used anymore. */
287#define PDM_SAVED_STATE_VERSION_PRE_PDM_AUDIO 4
288#define PDM_SAVED_STATE_VERSION_PRE_NMI_FF 3
289
290/** The number of nanoseconds a suspend callback needs to take before
291 * PDMR3Suspend warns about it taking too long. */
292#define PDMSUSPEND_WARN_AT_NS UINT64_C(1200000000)
293
294/** The number of nanoseconds a suspend callback needs to take before
295 * PDMR3PowerOff warns about it taking too long. */
296#define PDMPOWEROFF_WARN_AT_NS UINT64_C( 900000000)
297
298
299/*********************************************************************************************************************************
300* Structures and Typedefs *
301*********************************************************************************************************************************/
302/**
303 * Statistics of asynchronous notification tasks - used by reset, suspend and
304 * power off.
305 */
306typedef struct PDMNOTIFYASYNCSTATS
307{
308 /** The start timestamp. */
309 uint64_t uStartNsTs;
310 /** When to log the next time. */
311 uint64_t cNsElapsedNextLog;
312 /** The loop counter. */
313 uint32_t cLoops;
314 /** The number of pending asynchronous notification tasks. */
315 uint32_t cAsync;
316 /** The name of the operation (log prefix). */
317 const char *pszOp;
318 /** The current list buffer position. */
319 size_t offList;
320 /** String containing a list of the pending tasks. */
321 char szList[1024];
322} PDMNOTIFYASYNCSTATS;
323/** Pointer to the stats of pending asynchronous notification tasks. */
324typedef PDMNOTIFYASYNCSTATS *PPDMNOTIFYASYNCSTATS;
325
326
327/*********************************************************************************************************************************
328* Internal Functions *
329*********************************************************************************************************************************/
330static DECLCALLBACK(int) pdmR3LiveExec(PVM pVM, PSSMHANDLE pSSM, uint32_t uPass);
331static DECLCALLBACK(int) pdmR3SaveExec(PVM pVM, PSSMHANDLE pSSM);
332static DECLCALLBACK(int) pdmR3LoadExec(PVM pVM, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
333static DECLCALLBACK(int) pdmR3LoadPrep(PVM pVM, PSSMHANDLE pSSM);
334
335static FNDBGFHANDLERINT pdmR3InfoTracingIds;
336
337
338/**
339 * Initializes the PDM part of the UVM.
340 *
341 * This doesn't really do much right now but has to be here for the sake
342 * of completeness.
343 *
344 * @returns VBox status code.
345 * @param pUVM Pointer to the user mode VM structure.
346 */
347VMMR3_INT_DECL(int) PDMR3InitUVM(PUVM pUVM)
348{
349 AssertCompile(sizeof(pUVM->pdm.s) <= sizeof(pUVM->pdm.padding));
350 AssertRelease(sizeof(pUVM->pdm.s) <= sizeof(pUVM->pdm.padding));
351 pUVM->pdm.s.pModules = NULL;
352 pUVM->pdm.s.pCritSects = NULL;
353 pUVM->pdm.s.pRwCritSects = NULL;
354 return RTCritSectInit(&pUVM->pdm.s.ListCritSect);
355}
356
357
358/**
359 * Initializes the PDM.
360 *
361 * @returns VBox status code.
362 * @param pVM The cross context VM structure.
363 */
364VMMR3_INT_DECL(int) PDMR3Init(PVM pVM)
365{
366 LogFlow(("PDMR3Init\n"));
367
368 /*
369 * Assert alignment and sizes.
370 */
371 AssertRelease(!(RT_OFFSETOF(VM, pdm.s) & 31));
372 AssertRelease(sizeof(pVM->pdm.s) <= sizeof(pVM->pdm.padding));
373 AssertCompileMemberAlignment(PDM, CritSect, sizeof(uintptr_t));
374
375 /*
376 * Init the structure.
377 */
378 pVM->pdm.s.GCPhysVMMDevHeap = NIL_RTGCPHYS;
379 //pVM->pdm.s.idTracingDev = 0;
380 pVM->pdm.s.idTracingOther = 1024;
381
382 /*
383 * Initialize critical sections first.
384 */
385 int rc = pdmR3CritSectBothInitStats(pVM);
386 if (RT_SUCCESS(rc))
387 rc = PDMR3CritSectInit(pVM, &pVM->pdm.s.CritSect, RT_SRC_POS, "PDM");
388 if (RT_SUCCESS(rc))
389 {
390 rc = PDMR3CritSectInit(pVM, &pVM->pdm.s.NopCritSect, RT_SRC_POS, "NOP");
391 if (RT_SUCCESS(rc))
392 pVM->pdm.s.NopCritSect.s.Core.fFlags |= RTCRITSECT_FLAGS_NOP;
393 }
394
395 /*
396 * Initialize sub components.
397 */
398 if (RT_SUCCESS(rc))
399 rc = pdmR3LdrInitU(pVM->pUVM);
400#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
401 if (RT_SUCCESS(rc))
402 rc = pdmR3AsyncCompletionInit(pVM);
403#endif
404#ifdef VBOX_WITH_NETSHAPER
405 if (RT_SUCCESS(rc))
406 rc = pdmR3NetShaperInit(pVM);
407#endif
408 if (RT_SUCCESS(rc))
409 rc = pdmR3BlkCacheInit(pVM);
410 if (RT_SUCCESS(rc))
411 rc = pdmR3DrvInit(pVM);
412 if (RT_SUCCESS(rc))
413 rc = pdmR3DevInit(pVM);
414 if (RT_SUCCESS(rc))
415 {
416 /*
417 * Register the saved state data unit.
418 */
419 rc = SSMR3RegisterInternal(pVM, "pdm", 1, PDM_SAVED_STATE_VERSION, 128,
420 NULL, pdmR3LiveExec, NULL,
421 NULL, pdmR3SaveExec, NULL,
422 pdmR3LoadPrep, pdmR3LoadExec, NULL);
423 if (RT_SUCCESS(rc))
424 {
425 /*
426 * Register the info handlers.
427 */
428 DBGFR3InfoRegisterInternal(pVM, "pdmtracingids",
429 "Displays the tracing IDs assigned by PDM to devices, USB device, drivers and more.",
430 pdmR3InfoTracingIds);
431
432 LogFlow(("PDM: Successfully initialized\n"));
433 return rc;
434 }
435 }
436
437 /*
438 * Cleanup and return failure.
439 */
440 PDMR3Term(pVM);
441 LogFlow(("PDMR3Init: returns %Rrc\n", rc));
442 return rc;
443}
444
445
446/**
447 * Init phase completed callback.
448 *
449 * We use this for calling PDMDEVREG::pfnInitComplete callback after everything
450 * else has been initialized.
451 *
452 * @returns VBox status code.
453 * @param pVM The cross context VM structure.
454 * @param enmWhat The phase that was completed.
455 */
456VMMR3_INT_DECL(int) PDMR3InitCompleted(PVM pVM, VMINITCOMPLETED enmWhat)
457{
458#ifdef VBOX_WITH_RAW_MODE
459 if (enmWhat == VMINITCOMPLETED_RC)
460#else
461 if (enmWhat == VMINITCOMPLETED_RING0)
462#endif
463 return pdmR3DevInitComplete(pVM);
464 return VINF_SUCCESS;
465}
466
467
468/**
469 * Applies relocations to data and code managed by this
470 * component. This function will be called at init and
471 * whenever the VMM need to relocate it self inside the GC.
472 *
473 * @param pVM The cross context VM structure.
474 * @param offDelta Relocation delta relative to old location.
475 * @remark The loader subcomponent is relocated by PDMR3LdrRelocate() very
476 * early in the relocation phase.
477 */
478VMMR3_INT_DECL(void) PDMR3Relocate(PVM pVM, RTGCINTPTR offDelta)
479{
480 LogFlow(("PDMR3Relocate\n"));
481
482 /*
483 * Queues.
484 */
485 pdmR3QueueRelocate(pVM, offDelta);
486 pVM->pdm.s.pDevHlpQueueRC = PDMQueueRCPtr(pVM->pdm.s.pDevHlpQueueR3);
487
488 /*
489 * Critical sections.
490 */
491 pdmR3CritSectBothRelocate(pVM);
492
493 /*
494 * The registered PIC.
495 */
496 if (pVM->pdm.s.Pic.pDevInsRC)
497 {
498 pVM->pdm.s.Pic.pDevInsRC += offDelta;
499 pVM->pdm.s.Pic.pfnSetIrqRC += offDelta;
500 pVM->pdm.s.Pic.pfnGetInterruptRC += offDelta;
501 }
502
503 /*
504 * The registered APIC.
505 */
506 if (pVM->pdm.s.Apic.pDevInsRC)
507 {
508 pVM->pdm.s.Apic.pDevInsRC += offDelta;
509 pVM->pdm.s.Apic.pfnGetInterruptRC += offDelta;
510 pVM->pdm.s.Apic.pfnHasPendingIrqRC += 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 * Worker for PDMR3Suspend that deals with one driver.
1627 *
1628 * @param pDrvIns The driver instance.
1629 * @param pAsync The structure for recording asynchronous
1630 * notification tasks.
1631 * @param pszDevName The parent device name.
1632 * @param iDevInstance The parent device instance number.
1633 * @param iLun The parent LUN number.
1634 */
1635DECLINLINE(bool) pdmR3SuspendDrv(PPDMDRVINS pDrvIns, PPDMNOTIFYASYNCSTATS pAsync,
1636 const char *pszDevName, uint32_t iDevInstance, uint32_t iLun)
1637{
1638 if (!pDrvIns->Internal.s.fVMSuspended)
1639 {
1640 pDrvIns->Internal.s.fVMSuspended = true;
1641 if (pDrvIns->pReg->pfnSuspend)
1642 {
1643 uint64_t cNsElapsed = RTTimeNanoTS();
1644
1645 if (!pDrvIns->Internal.s.pfnAsyncNotify)
1646 {
1647 LogFlow(("PDMR3Suspend: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1648 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1649 pDrvIns->pReg->pfnSuspend(pDrvIns);
1650 if (pDrvIns->Internal.s.pfnAsyncNotify)
1651 LogFlow(("PDMR3Suspend: Async notification started - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1652 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1653 }
1654 else if (pDrvIns->Internal.s.pfnAsyncNotify(pDrvIns))
1655 {
1656 LogFlow(("PDMR3Suspend: Async notification completed - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1657 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1658 pDrvIns->Internal.s.pfnAsyncNotify = NULL;
1659 }
1660
1661 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
1662 if (cNsElapsed >= PDMSUSPEND_WARN_AT_NS)
1663 LogRel(("PDMR3Suspend: Driver '%s'/%d on LUN#%d of device '%s'/%d took %'llu ns to suspend\n",
1664 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance, cNsElapsed));
1665
1666 if (pDrvIns->Internal.s.pfnAsyncNotify)
1667 {
1668 pDrvIns->Internal.s.fVMSuspended = false;
1669 pdmR3NotifyAsyncAddDrv(pAsync, pDrvIns->Internal.s.pDrv->pReg->szName, pDrvIns->iInstance, pszDevName, iDevInstance, iLun);
1670 return false;
1671 }
1672 }
1673 }
1674 return true;
1675}
1676
1677
1678/**
1679 * Worker for PDMR3Suspend that deals with one USB device instance.
1680 *
1681 * @param pUsbIns The USB device instance.
1682 * @param pAsync The structure for recording asynchronous
1683 * notification tasks.
1684 */
1685DECLINLINE(void) pdmR3SuspendUsb(PPDMUSBINS pUsbIns, PPDMNOTIFYASYNCSTATS pAsync)
1686{
1687 if (!pUsbIns->Internal.s.fVMSuspended)
1688 {
1689 pUsbIns->Internal.s.fVMSuspended = true;
1690 if (pUsbIns->pReg->pfnVMSuspend)
1691 {
1692 uint64_t cNsElapsed = RTTimeNanoTS();
1693
1694 if (!pUsbIns->Internal.s.pfnAsyncNotify)
1695 {
1696 LogFlow(("PDMR3Suspend: Notifying - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1697 pUsbIns->pReg->pfnVMSuspend(pUsbIns);
1698 if (pUsbIns->Internal.s.pfnAsyncNotify)
1699 LogFlow(("PDMR3Suspend: Async notification started - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1700 }
1701 else if (pUsbIns->Internal.s.pfnAsyncNotify(pUsbIns))
1702 {
1703 LogFlow(("PDMR3Suspend: Async notification completed - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1704 pUsbIns->Internal.s.pfnAsyncNotify = NULL;
1705 }
1706 if (pUsbIns->Internal.s.pfnAsyncNotify)
1707 {
1708 pUsbIns->Internal.s.fVMSuspended = false;
1709 pdmR3NotifyAsyncAdd(pAsync, pUsbIns->Internal.s.pUsbDev->pReg->szName, pUsbIns->iInstance);
1710 }
1711
1712 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
1713 if (cNsElapsed >= PDMSUSPEND_WARN_AT_NS)
1714 LogRel(("PDMR3Suspend: USB device '%s'/%d took %'llu ns to suspend\n",
1715 pUsbIns->pReg->szName, pUsbIns->iInstance, cNsElapsed));
1716 }
1717 }
1718}
1719
1720
1721/**
1722 * Worker for PDMR3Suspend that deals with one device instance.
1723 *
1724 * @param pDevIns The device instance.
1725 * @param pAsync The structure for recording asynchronous
1726 * notification tasks.
1727 */
1728DECLINLINE(void) pdmR3SuspendDev(PPDMDEVINS pDevIns, PPDMNOTIFYASYNCSTATS pAsync)
1729{
1730 if (!(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_SUSPENDED))
1731 {
1732 pDevIns->Internal.s.fIntFlags |= PDMDEVINSINT_FLAGS_SUSPENDED;
1733 if (pDevIns->pReg->pfnSuspend)
1734 {
1735 uint64_t cNsElapsed = RTTimeNanoTS();
1736 PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
1737
1738 if (!pDevIns->Internal.s.pfnAsyncNotify)
1739 {
1740 LogFlow(("PDMR3Suspend: Notifying - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1741 pDevIns->pReg->pfnSuspend(pDevIns);
1742 if (pDevIns->Internal.s.pfnAsyncNotify)
1743 LogFlow(("PDMR3Suspend: Async notification started - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1744 }
1745 else if (pDevIns->Internal.s.pfnAsyncNotify(pDevIns))
1746 {
1747 LogFlow(("PDMR3Suspend: Async notification completed - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1748 pDevIns->Internal.s.pfnAsyncNotify = NULL;
1749 }
1750 if (pDevIns->Internal.s.pfnAsyncNotify)
1751 {
1752 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
1753 pdmR3NotifyAsyncAdd(pAsync, pDevIns->Internal.s.pDevR3->pReg->szName, pDevIns->iInstance);
1754 }
1755
1756 PDMCritSectLeave(pDevIns->pCritSectRoR3);
1757 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
1758 if (cNsElapsed >= PDMSUSPEND_WARN_AT_NS)
1759 LogRel(("PDMR3Suspend: Device '%s'/%d took %'llu ns to suspend\n",
1760 pDevIns->pReg->szName, pDevIns->iInstance, cNsElapsed));
1761 }
1762 }
1763}
1764
1765
1766/**
1767 * This function will notify all the devices and their attached drivers about
1768 * the VM now being suspended.
1769 *
1770 * @param pVM The cross context VM structure.
1771 * @thread EMT(0)
1772 */
1773VMMR3_INT_DECL(void) PDMR3Suspend(PVM pVM)
1774{
1775 LogFlow(("PDMR3Suspend:\n"));
1776 VM_ASSERT_EMT0(pVM);
1777 uint64_t cNsElapsed = RTTimeNanoTS();
1778
1779 /*
1780 * The outer loop repeats until there are no more async requests.
1781 *
1782 * Note! We depend on the suspended indicators to be in the desired state
1783 * and we do not reset them before starting because this allows
1784 * PDMR3PowerOn and PDMR3Resume to use PDMR3Suspend for cleaning up
1785 * on failure.
1786 */
1787 PDMNOTIFYASYNCSTATS Async;
1788 pdmR3NotifyAsyncInit(&Async, "PDMR3Suspend");
1789 for (;;)
1790 {
1791 pdmR3NotifyAsyncBeginLoop(&Async);
1792
1793 /*
1794 * Iterate thru the device instances and USB device instances,
1795 * processing the drivers associated with those.
1796 *
1797 * The attached drivers are normally processed first. Some devices
1798 * (like DevAHCI) though needs to be notified before the drivers so
1799 * that it doesn't kick off any new requests after the drivers stopped
1800 * taking any. (DrvVD changes to read-only in this particular case.)
1801 */
1802 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
1803 {
1804 unsigned const cAsyncStart = Async.cAsync;
1805
1806 if (pDevIns->pReg->fFlags & PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION)
1807 pdmR3SuspendDev(pDevIns, &Async);
1808
1809 if (Async.cAsync == cAsyncStart)
1810 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
1811 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1812 if (!pdmR3SuspendDrv(pDrvIns, &Async, pDevIns->pReg->szName, pDevIns->iInstance, pLun->iLun))
1813 break;
1814
1815 if ( Async.cAsync == cAsyncStart
1816 && !(pDevIns->pReg->fFlags & PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION))
1817 pdmR3SuspendDev(pDevIns, &Async);
1818 }
1819
1820#ifdef VBOX_WITH_USB
1821 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1822 {
1823 unsigned const cAsyncStart = Async.cAsync;
1824
1825 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1826 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
1827 if (!pdmR3SuspendDrv(pDrvIns, &Async, pUsbIns->pReg->szName, pUsbIns->iInstance, pLun->iLun))
1828 break;
1829
1830 if (Async.cAsync == cAsyncStart)
1831 pdmR3SuspendUsb(pUsbIns, &Async);
1832 }
1833#endif
1834 if (!Async.cAsync)
1835 break;
1836 pdmR3NotifyAsyncLog(&Async);
1837 pdmR3NotifyAsyncWaitAndProcessRequests(&Async, pVM);
1838 }
1839
1840 /*
1841 * Suspend all threads.
1842 */
1843 pdmR3ThreadSuspendAll(pVM);
1844
1845 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
1846 LogRel(("PDMR3Suspend: %'llu ns run time\n", cNsElapsed));
1847}
1848
1849
1850/**
1851 * Worker for PDMR3Resume that deals with one driver.
1852 *
1853 * @param pDrvIns The driver instance.
1854 * @param pszDevName The parent device name.
1855 * @param iDevInstance The parent device instance number.
1856 * @param iLun The parent LUN number.
1857 */
1858DECLINLINE(int) pdmR3ResumeDrv(PPDMDRVINS pDrvIns, const char *pszDevName, uint32_t iDevInstance, uint32_t iLun)
1859{
1860 Assert(pDrvIns->Internal.s.fVMSuspended);
1861 if (pDrvIns->pReg->pfnResume)
1862 {
1863 LogFlow(("PDMR3Resume: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
1864 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
1865 int rc = VINF_SUCCESS; pDrvIns->pReg->pfnResume(pDrvIns);
1866 if (RT_FAILURE(rc))
1867 {
1868 LogRel(("PDMR3Resume: Driver '%s'/%d on LUN#%d of device '%s'/%d -> %Rrc\n",
1869 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance, rc));
1870 return rc;
1871 }
1872 }
1873 pDrvIns->Internal.s.fVMSuspended = false;
1874 return VINF_SUCCESS;
1875}
1876
1877
1878/**
1879 * Worker for PDMR3Resume that deals with one USB device instance.
1880 *
1881 * @returns VBox status code.
1882 * @param pUsbIns The USB device instance.
1883 */
1884DECLINLINE(int) pdmR3ResumeUsb(PPDMUSBINS pUsbIns)
1885{
1886 Assert(pUsbIns->Internal.s.fVMSuspended);
1887 if (pUsbIns->pReg->pfnVMResume)
1888 {
1889 LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1890 int rc = VINF_SUCCESS; pUsbIns->pReg->pfnVMResume(pUsbIns);
1891 if (RT_FAILURE(rc))
1892 {
1893 LogRel(("PDMR3Resume: Device '%s'/%d -> %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1894 return rc;
1895 }
1896 }
1897 pUsbIns->Internal.s.fVMSuspended = false;
1898 return VINF_SUCCESS;
1899}
1900
1901
1902/**
1903 * Worker for PDMR3Resume that deals with one device instance.
1904 *
1905 * @returns VBox status code.
1906 * @param pDevIns The device instance.
1907 */
1908DECLINLINE(int) pdmR3ResumeDev(PPDMDEVINS pDevIns)
1909{
1910 Assert(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_SUSPENDED);
1911 if (pDevIns->pReg->pfnResume)
1912 {
1913 LogFlow(("PDMR3Resume: Notifying - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
1914 PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
1915 int rc = VINF_SUCCESS; pDevIns->pReg->pfnResume(pDevIns);
1916 PDMCritSectLeave(pDevIns->pCritSectRoR3);
1917 if (RT_FAILURE(rc))
1918 {
1919 LogRel(("PDMR3Resume: Device '%s'/%d -> %Rrc\n", pDevIns->pReg->szName, pDevIns->iInstance, rc));
1920 return rc;
1921 }
1922 }
1923 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
1924 return VINF_SUCCESS;
1925}
1926
1927
1928/**
1929 * This function will notify all the devices and their
1930 * attached drivers about the VM now being resumed.
1931 *
1932 * @param pVM The cross context VM structure.
1933 */
1934VMMR3_INT_DECL(void) PDMR3Resume(PVM pVM)
1935{
1936 LogFlow(("PDMR3Resume:\n"));
1937
1938 /*
1939 * Iterate thru the device instances and USB device instances,
1940 * processing the drivers associated with those.
1941 */
1942 int rc = VINF_SUCCESS;
1943 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns && RT_SUCCESS(rc); pDevIns = pDevIns->Internal.s.pNextR3)
1944 {
1945 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun && RT_SUCCESS(rc); pLun = pLun->pNext)
1946 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns && RT_SUCCESS(rc); pDrvIns = pDrvIns->Internal.s.pDown)
1947 rc = pdmR3ResumeDrv(pDrvIns, pDevIns->pReg->szName, pDevIns->iInstance, pLun->iLun);
1948 if (RT_SUCCESS(rc))
1949 rc = pdmR3ResumeDev(pDevIns);
1950 }
1951
1952#ifdef VBOX_WITH_USB
1953 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns && RT_SUCCESS(rc); pUsbIns = pUsbIns->Internal.s.pNext)
1954 {
1955 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun && RT_SUCCESS(rc); pLun = pLun->pNext)
1956 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns && RT_SUCCESS(rc); pDrvIns = pDrvIns->Internal.s.pDown)
1957 rc = pdmR3ResumeDrv(pDrvIns, pUsbIns->pReg->szName, pUsbIns->iInstance, pLun->iLun);
1958 if (RT_SUCCESS(rc))
1959 rc = pdmR3ResumeUsb(pUsbIns);
1960 }
1961#endif
1962
1963 /*
1964 * Resume all threads.
1965 */
1966 if (RT_SUCCESS(rc))
1967 pdmR3ThreadResumeAll(pVM);
1968
1969 /*
1970 * Resume the block cache.
1971 */
1972 if (RT_SUCCESS(rc))
1973 pdmR3BlkCacheResume(pVM);
1974
1975 /*
1976 * On failure, clean up via PDMR3Suspend.
1977 */
1978 if (RT_FAILURE(rc))
1979 PDMR3Suspend(pVM);
1980
1981 LogFlow(("PDMR3Resume: returns %Rrc\n", rc));
1982 return /*rc*/;
1983}
1984
1985
1986/**
1987 * Worker for PDMR3PowerOff that deals with one driver.
1988 *
1989 * @param pDrvIns The driver instance.
1990 * @param pAsync The structure for recording asynchronous
1991 * notification tasks.
1992 * @param pszDevName The parent device name.
1993 * @param iDevInstance The parent device instance number.
1994 * @param iLun The parent LUN number.
1995 */
1996DECLINLINE(bool) pdmR3PowerOffDrv(PPDMDRVINS pDrvIns, PPDMNOTIFYASYNCSTATS pAsync,
1997 const char *pszDevName, uint32_t iDevInstance, uint32_t iLun)
1998{
1999 if (!pDrvIns->Internal.s.fVMSuspended)
2000 {
2001 pDrvIns->Internal.s.fVMSuspended = true;
2002 if (pDrvIns->pReg->pfnPowerOff)
2003 {
2004 uint64_t cNsElapsed = RTTimeNanoTS();
2005
2006 if (!pDrvIns->Internal.s.pfnAsyncNotify)
2007 {
2008 LogFlow(("PDMR3PowerOff: Notifying - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
2009 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
2010 pDrvIns->pReg->pfnPowerOff(pDrvIns);
2011 if (pDrvIns->Internal.s.pfnAsyncNotify)
2012 LogFlow(("PDMR3PowerOff: Async notification started - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
2013 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
2014 }
2015 else if (pDrvIns->Internal.s.pfnAsyncNotify(pDrvIns))
2016 {
2017 LogFlow(("PDMR3PowerOff: Async notification completed - driver '%s'/%d on LUN#%d of device '%s'/%d\n",
2018 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance));
2019 pDrvIns->Internal.s.pfnAsyncNotify = NULL;
2020 }
2021
2022 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
2023 if (cNsElapsed >= PDMPOWEROFF_WARN_AT_NS)
2024 LogRel(("PDMR3PowerOff: Driver '%s'/%d on LUN#%d of device '%s'/%d took %'llu ns to power off\n",
2025 pDrvIns->pReg->szName, pDrvIns->iInstance, iLun, pszDevName, iDevInstance, cNsElapsed));
2026
2027 if (pDrvIns->Internal.s.pfnAsyncNotify)
2028 {
2029 pDrvIns->Internal.s.fVMSuspended = false;
2030 pdmR3NotifyAsyncAddDrv(pAsync, pDrvIns->Internal.s.pDrv->pReg->szName, pDrvIns->iInstance,
2031 pszDevName, iDevInstance, iLun);
2032 return false;
2033 }
2034 }
2035 }
2036 return true;
2037}
2038
2039
2040/**
2041 * Worker for PDMR3PowerOff that deals with one USB device instance.
2042 *
2043 * @param pUsbIns The USB device instance.
2044 * @param pAsync The structure for recording asynchronous
2045 * notification tasks.
2046 */
2047DECLINLINE(void) pdmR3PowerOffUsb(PPDMUSBINS pUsbIns, PPDMNOTIFYASYNCSTATS pAsync)
2048{
2049 if (!pUsbIns->Internal.s.fVMSuspended)
2050 {
2051 pUsbIns->Internal.s.fVMSuspended = true;
2052 if (pUsbIns->pReg->pfnVMPowerOff)
2053 {
2054 uint64_t cNsElapsed = RTTimeNanoTS();
2055
2056 if (!pUsbIns->Internal.s.pfnAsyncNotify)
2057 {
2058 LogFlow(("PDMR3PowerOff: Notifying - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
2059 pUsbIns->pReg->pfnVMPowerOff(pUsbIns);
2060 if (pUsbIns->Internal.s.pfnAsyncNotify)
2061 LogFlow(("PDMR3PowerOff: Async notification started - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
2062 }
2063 else if (pUsbIns->Internal.s.pfnAsyncNotify(pUsbIns))
2064 {
2065 LogFlow(("PDMR3PowerOff: Async notification completed - USB device '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
2066 pUsbIns->Internal.s.pfnAsyncNotify = NULL;
2067 }
2068 if (pUsbIns->Internal.s.pfnAsyncNotify)
2069 {
2070 pUsbIns->Internal.s.fVMSuspended = false;
2071 pdmR3NotifyAsyncAdd(pAsync, pUsbIns->Internal.s.pUsbDev->pReg->szName, pUsbIns->iInstance);
2072 }
2073
2074 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
2075 if (cNsElapsed >= PDMPOWEROFF_WARN_AT_NS)
2076 LogRel(("PDMR3PowerOff: USB device '%s'/%d took %'llu ns to power off\n",
2077 pUsbIns->pReg->szName, pUsbIns->iInstance, cNsElapsed));
2078
2079 }
2080 }
2081}
2082
2083
2084/**
2085 * Worker for PDMR3PowerOff that deals with one device instance.
2086 *
2087 * @param pDevIns The device instance.
2088 * @param pAsync The structure for recording asynchronous
2089 * notification tasks.
2090 */
2091DECLINLINE(void) pdmR3PowerOffDev(PPDMDEVINS pDevIns, PPDMNOTIFYASYNCSTATS pAsync)
2092{
2093 if (!(pDevIns->Internal.s.fIntFlags & PDMDEVINSINT_FLAGS_SUSPENDED))
2094 {
2095 pDevIns->Internal.s.fIntFlags |= PDMDEVINSINT_FLAGS_SUSPENDED;
2096 if (pDevIns->pReg->pfnPowerOff)
2097 {
2098 uint64_t cNsElapsed = RTTimeNanoTS();
2099 PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);
2100
2101 if (!pDevIns->Internal.s.pfnAsyncNotify)
2102 {
2103 LogFlow(("PDMR3PowerOff: Notifying - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
2104 pDevIns->pReg->pfnPowerOff(pDevIns);
2105 if (pDevIns->Internal.s.pfnAsyncNotify)
2106 LogFlow(("PDMR3PowerOff: Async notification started - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
2107 }
2108 else if (pDevIns->Internal.s.pfnAsyncNotify(pDevIns))
2109 {
2110 LogFlow(("PDMR3PowerOff: Async notification completed - device '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
2111 pDevIns->Internal.s.pfnAsyncNotify = NULL;
2112 }
2113 if (pDevIns->Internal.s.pfnAsyncNotify)
2114 {
2115 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
2116 pdmR3NotifyAsyncAdd(pAsync, pDevIns->Internal.s.pDevR3->pReg->szName, pDevIns->iInstance);
2117 }
2118
2119 PDMCritSectLeave(pDevIns->pCritSectRoR3);
2120 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
2121 if (cNsElapsed >= PDMPOWEROFF_WARN_AT_NS)
2122 LogFlow(("PDMR3PowerOff: Device '%s'/%d took %'llu ns to power off\n",
2123 pDevIns->pReg->szName, pDevIns->iInstance, cNsElapsed));
2124 }
2125 }
2126}
2127
2128
2129/**
2130 * This function will notify all the devices and their
2131 * attached drivers about the VM being powered off.
2132 *
2133 * @param pVM The cross context VM structure.
2134 */
2135VMMR3DECL(void) PDMR3PowerOff(PVM pVM)
2136{
2137 LogFlow(("PDMR3PowerOff:\n"));
2138 uint64_t cNsElapsed = RTTimeNanoTS();
2139
2140 /*
2141 * Clear the suspended flags on all devices and drivers first because they
2142 * might have been set during a suspend but the power off callbacks should
2143 * be called in any case.
2144 */
2145 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2146 {
2147 pDevIns->Internal.s.fIntFlags &= ~PDMDEVINSINT_FLAGS_SUSPENDED;
2148
2149 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2150 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2151 pDrvIns->Internal.s.fVMSuspended = false;
2152 }
2153
2154#ifdef VBOX_WITH_USB
2155 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2156 {
2157 pUsbIns->Internal.s.fVMSuspended = false;
2158
2159 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2160 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2161 pDrvIns->Internal.s.fVMSuspended = false;
2162 }
2163#endif
2164
2165 /*
2166 * The outer loop repeats until there are no more async requests.
2167 */
2168 PDMNOTIFYASYNCSTATS Async;
2169 pdmR3NotifyAsyncInit(&Async, "PDMR3PowerOff");
2170 for (;;)
2171 {
2172 pdmR3NotifyAsyncBeginLoop(&Async);
2173
2174 /*
2175 * Iterate thru the device instances and USB device instances,
2176 * processing the drivers associated with those.
2177 *
2178 * The attached drivers are normally processed first. Some devices
2179 * (like DevAHCI) though needs to be notified before the drivers so
2180 * that it doesn't kick off any new requests after the drivers stopped
2181 * taking any. (DrvVD changes to read-only in this particular case.)
2182 */
2183 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2184 {
2185 unsigned const cAsyncStart = Async.cAsync;
2186
2187 if (pDevIns->pReg->fFlags & PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION)
2188 pdmR3PowerOffDev(pDevIns, &Async);
2189
2190 if (Async.cAsync == cAsyncStart)
2191 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2192 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2193 if (!pdmR3PowerOffDrv(pDrvIns, &Async, pDevIns->pReg->szName, pDevIns->iInstance, pLun->iLun))
2194 break;
2195
2196 if ( Async.cAsync == cAsyncStart
2197 && !(pDevIns->pReg->fFlags & PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION))
2198 pdmR3PowerOffDev(pDevIns, &Async);
2199 }
2200
2201#ifdef VBOX_WITH_USB
2202 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2203 {
2204 unsigned const cAsyncStart = Async.cAsync;
2205
2206 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2207 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2208 if (!pdmR3PowerOffDrv(pDrvIns, &Async, pUsbIns->pReg->szName, pUsbIns->iInstance, pLun->iLun))
2209 break;
2210
2211 if (Async.cAsync == cAsyncStart)
2212 pdmR3PowerOffUsb(pUsbIns, &Async);
2213 }
2214#endif
2215 if (!Async.cAsync)
2216 break;
2217 pdmR3NotifyAsyncLog(&Async);
2218 pdmR3NotifyAsyncWaitAndProcessRequests(&Async, pVM);
2219 }
2220
2221 /*
2222 * Suspend all threads.
2223 */
2224 pdmR3ThreadSuspendAll(pVM);
2225
2226 cNsElapsed = RTTimeNanoTS() - cNsElapsed;
2227 LogRel(("PDMR3PowerOff: %'llu ns run time\n", cNsElapsed));
2228}
2229
2230
2231/**
2232 * Queries the base interface of a device instance.
2233 *
2234 * The caller can use this to query other interfaces the device implements
2235 * and use them to talk to the device.
2236 *
2237 * @returns VBox status code.
2238 * @param pUVM The user mode VM handle.
2239 * @param pszDevice Device name.
2240 * @param iInstance Device instance.
2241 * @param ppBase Where to store the pointer to the base device interface on success.
2242 * @remark We're not doing any locking ATM, so don't try call this at times when the
2243 * device chain is known to be updated.
2244 */
2245VMMR3DECL(int) PDMR3QueryDevice(PUVM pUVM, const char *pszDevice, unsigned iInstance, PPDMIBASE *ppBase)
2246{
2247 LogFlow(("PDMR3DeviceQuery: pszDevice=%p:{%s} iInstance=%u ppBase=%p\n", pszDevice, pszDevice, iInstance, ppBase));
2248 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
2249 VM_ASSERT_VALID_EXT_RETURN(pUVM->pVM, VERR_INVALID_VM_HANDLE);
2250
2251 /*
2252 * Iterate registered devices looking for the device.
2253 */
2254 size_t cchDevice = strlen(pszDevice);
2255 for (PPDMDEV pDev = pUVM->pVM->pdm.s.pDevs; pDev; pDev = pDev->pNext)
2256 {
2257 if ( pDev->cchName == cchDevice
2258 && !memcmp(pDev->pReg->szName, pszDevice, cchDevice))
2259 {
2260 /*
2261 * Iterate device instances.
2262 */
2263 for (PPDMDEVINS pDevIns = pDev->pInstances; pDevIns; pDevIns = pDevIns->Internal.s.pPerDeviceNextR3)
2264 {
2265 if (pDevIns->iInstance == iInstance)
2266 {
2267 if (pDevIns->IBase.pfnQueryInterface)
2268 {
2269 *ppBase = &pDevIns->IBase;
2270 LogFlow(("PDMR3DeviceQuery: return VINF_SUCCESS and *ppBase=%p\n", *ppBase));
2271 return VINF_SUCCESS;
2272 }
2273
2274 LogFlow(("PDMR3DeviceQuery: returns VERR_PDM_DEVICE_INSTANCE_NO_IBASE\n"));
2275 return VERR_PDM_DEVICE_INSTANCE_NO_IBASE;
2276 }
2277 }
2278
2279 LogFlow(("PDMR3DeviceQuery: returns VERR_PDM_DEVICE_INSTANCE_NOT_FOUND\n"));
2280 return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND;
2281 }
2282 }
2283
2284 LogFlow(("PDMR3QueryDevice: returns VERR_PDM_DEVICE_NOT_FOUND\n"));
2285 return VERR_PDM_DEVICE_NOT_FOUND;
2286}
2287
2288
2289/**
2290 * Queries the base interface of a device LUN.
2291 *
2292 * This differs from PDMR3QueryLun by that it returns the interface on the
2293 * device and not the top level driver.
2294 *
2295 * @returns VBox status code.
2296 * @param pUVM The user mode VM handle.
2297 * @param pszDevice Device name.
2298 * @param iInstance Device instance.
2299 * @param iLun The Logical Unit to obtain the interface of.
2300 * @param ppBase Where to store the base interface pointer.
2301 * @remark We're not doing any locking ATM, so don't try call this at times when the
2302 * device chain is known to be updated.
2303 */
2304VMMR3DECL(int) PDMR3QueryDeviceLun(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
2305{
2306 LogFlow(("PDMR3QueryDeviceLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
2307 pszDevice, pszDevice, iInstance, iLun, ppBase));
2308 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
2309 VM_ASSERT_VALID_EXT_RETURN(pUVM->pVM, VERR_INVALID_VM_HANDLE);
2310
2311 /*
2312 * Find the LUN.
2313 */
2314 PPDMLUN pLun;
2315 int rc = pdmR3DevFindLun(pUVM->pVM, pszDevice, iInstance, iLun, &pLun);
2316 if (RT_SUCCESS(rc))
2317 {
2318 *ppBase = pLun->pBase;
2319 LogFlow(("PDMR3QueryDeviceLun: return VINF_SUCCESS and *ppBase=%p\n", *ppBase));
2320 return VINF_SUCCESS;
2321 }
2322 LogFlow(("PDMR3QueryDeviceLun: returns %Rrc\n", rc));
2323 return rc;
2324}
2325
2326
2327/**
2328 * Query the interface of the top level driver on a LUN.
2329 *
2330 * @returns VBox status code.
2331 * @param pUVM The user mode VM handle.
2332 * @param pszDevice Device name.
2333 * @param iInstance Device instance.
2334 * @param iLun The Logical Unit to obtain the interface of.
2335 * @param ppBase Where to store the base interface pointer.
2336 * @remark We're not doing any locking ATM, so don't try call this at times when the
2337 * device chain is known to be updated.
2338 */
2339VMMR3DECL(int) PDMR3QueryLun(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
2340{
2341 LogFlow(("PDMR3QueryLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
2342 pszDevice, pszDevice, iInstance, iLun, ppBase));
2343 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
2344 PVM pVM = pUVM->pVM;
2345 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
2346
2347 /*
2348 * Find the LUN.
2349 */
2350 PPDMLUN pLun;
2351 int rc = pdmR3DevFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
2352 if (RT_SUCCESS(rc))
2353 {
2354 if (pLun->pTop)
2355 {
2356 *ppBase = &pLun->pTop->IBase;
2357 LogFlow(("PDMR3QueryLun: return %Rrc and *ppBase=%p\n", VINF_SUCCESS, *ppBase));
2358 return VINF_SUCCESS;
2359 }
2360 rc = VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN;
2361 }
2362 LogFlow(("PDMR3QueryLun: returns %Rrc\n", rc));
2363 return rc;
2364}
2365
2366
2367/**
2368 * Query the interface of a named driver on a LUN.
2369 *
2370 * If the driver appears more than once in the driver chain, the first instance
2371 * is returned.
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 pszDriver The driver name.
2379 * @param ppBase Where to store the base interface pointer.
2380 *
2381 * @remark We're not doing any locking ATM, so don't try call this at times when the
2382 * device chain is known to be updated.
2383 */
2384VMMR3DECL(int) PDMR3QueryDriverOnLun(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, const char *pszDriver, PPPDMIBASE ppBase)
2385{
2386 LogFlow(("PDMR3QueryDriverOnLun: pszDevice=%p:{%s} iInstance=%u iLun=%u pszDriver=%p:{%s} ppBase=%p\n",
2387 pszDevice, pszDevice, iInstance, iLun, pszDriver, pszDriver, ppBase));
2388 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
2389 VM_ASSERT_VALID_EXT_RETURN(pUVM->pVM, VERR_INVALID_VM_HANDLE);
2390
2391 /*
2392 * Find the LUN.
2393 */
2394 PPDMLUN pLun;
2395 int rc = pdmR3DevFindLun(pUVM->pVM, pszDevice, iInstance, iLun, &pLun);
2396 if (RT_SUCCESS(rc))
2397 {
2398 if (pLun->pTop)
2399 {
2400 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2401 if (!strcmp(pDrvIns->pReg->szName, pszDriver))
2402 {
2403 *ppBase = &pDrvIns->IBase;
2404 LogFlow(("PDMR3QueryDriverOnLun: return %Rrc and *ppBase=%p\n", VINF_SUCCESS, *ppBase));
2405 return VINF_SUCCESS;
2406
2407 }
2408 rc = VERR_PDM_DRIVER_NOT_FOUND;
2409 }
2410 else
2411 rc = VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN;
2412 }
2413 LogFlow(("PDMR3QueryDriverOnLun: returns %Rrc\n", rc));
2414 return rc;
2415}
2416
2417/**
2418 * Executes pending DMA transfers.
2419 * Forced Action handler.
2420 *
2421 * @param pVM The cross context VM structure.
2422 */
2423VMMR3DECL(void) PDMR3DmaRun(PVM pVM)
2424{
2425 /* Note! Not really SMP safe; restrict it to VCPU 0. */
2426 if (VMMGetCpuId(pVM) != 0)
2427 return;
2428
2429 if (VM_FF_TEST_AND_CLEAR(pVM, VM_FF_PDM_DMA))
2430 {
2431 if (pVM->pdm.s.pDmac)
2432 {
2433 bool fMore = pVM->pdm.s.pDmac->Reg.pfnRun(pVM->pdm.s.pDmac->pDevIns);
2434 if (fMore)
2435 VM_FF_SET(pVM, VM_FF_PDM_DMA);
2436 }
2437 }
2438}
2439
2440
2441/**
2442 * Service a VMMCALLRING3_PDM_LOCK call.
2443 *
2444 * @returns VBox status code.
2445 * @param pVM The cross context VM structure.
2446 */
2447VMMR3_INT_DECL(int) PDMR3LockCall(PVM pVM)
2448{
2449 return PDMR3CritSectEnterEx(&pVM->pdm.s.CritSect, true /* fHostCall */);
2450}
2451
2452
2453/**
2454 * Registers the VMM device heap
2455 *
2456 * @returns VBox status code.
2457 * @param pVM The cross context VM structure.
2458 * @param GCPhys The physical address.
2459 * @param pvHeap Ring-3 pointer.
2460 * @param cbSize Size of the heap.
2461 */
2462VMMR3_INT_DECL(int) PDMR3VmmDevHeapRegister(PVM pVM, RTGCPHYS GCPhys, RTR3PTR pvHeap, unsigned cbSize)
2463{
2464 Assert(pVM->pdm.s.pvVMMDevHeap == NULL);
2465
2466 Log(("PDMR3VmmDevHeapRegister %RGp %RHv %x\n", GCPhys, pvHeap, cbSize));
2467 pVM->pdm.s.pvVMMDevHeap = pvHeap;
2468 pVM->pdm.s.GCPhysVMMDevHeap = GCPhys;
2469 pVM->pdm.s.cbVMMDevHeap = cbSize;
2470 pVM->pdm.s.cbVMMDevHeapLeft = cbSize;
2471 return VINF_SUCCESS;
2472}
2473
2474
2475/**
2476 * Unregisters the VMM device heap
2477 *
2478 * @returns VBox status code.
2479 * @param pVM The cross context VM structure.
2480 * @param GCPhys The physical address.
2481 */
2482VMMR3_INT_DECL(int) PDMR3VmmDevHeapUnregister(PVM pVM, RTGCPHYS GCPhys)
2483{
2484 Assert(pVM->pdm.s.GCPhysVMMDevHeap == GCPhys);
2485
2486 Log(("PDMR3VmmDevHeapUnregister %RGp\n", GCPhys));
2487 pVM->pdm.s.pvVMMDevHeap = NULL;
2488 pVM->pdm.s.GCPhysVMMDevHeap = NIL_RTGCPHYS;
2489 pVM->pdm.s.cbVMMDevHeap = 0;
2490 pVM->pdm.s.cbVMMDevHeapLeft = 0;
2491 return VINF_SUCCESS;
2492}
2493
2494
2495/**
2496 * Allocates memory from the VMM device heap
2497 *
2498 * @returns VBox status code.
2499 * @param pVM The cross context VM structure.
2500 * @param cbSize Allocation size.
2501 * @param ppv Ring-3 pointer. (out)
2502 */
2503VMMR3_INT_DECL(int) PDMR3VmmDevHeapAlloc(PVM pVM, size_t cbSize, RTR3PTR *ppv)
2504{
2505#ifdef DEBUG_bird
2506 if (!cbSize || cbSize > pVM->pdm.s.cbVMMDevHeapLeft)
2507 return VERR_NO_MEMORY;
2508#else
2509 AssertReturn(cbSize && cbSize <= pVM->pdm.s.cbVMMDevHeapLeft, VERR_NO_MEMORY);
2510#endif
2511
2512 Log(("PDMR3VMMDevHeapAlloc: %#zx\n", cbSize));
2513
2514 /** @todo Not a real heap as there's currently only one user. */
2515 *ppv = pVM->pdm.s.pvVMMDevHeap;
2516 pVM->pdm.s.cbVMMDevHeapLeft = 0;
2517 return VINF_SUCCESS;
2518}
2519
2520
2521/**
2522 * Frees memory from the VMM device heap
2523 *
2524 * @returns VBox status code.
2525 * @param pVM The cross context VM structure.
2526 * @param pv Ring-3 pointer.
2527 */
2528VMMR3_INT_DECL(int) PDMR3VmmDevHeapFree(PVM pVM, RTR3PTR pv)
2529{
2530 Log(("PDMR3VmmDevHeapFree: %RHv\n", pv));
2531
2532 /** @todo not a real heap as there's currently only one user. */
2533 pVM->pdm.s.cbVMMDevHeapLeft = pVM->pdm.s.cbVMMDevHeap;
2534 return VINF_SUCCESS;
2535}
2536
2537
2538/**
2539 * Worker for DBGFR3TraceConfig that checks if the given tracing group name
2540 * matches a device or driver name and applies the tracing config change.
2541 *
2542 * @returns VINF_SUCCESS or VERR_NOT_FOUND.
2543 * @param pVM The cross context VM structure.
2544 * @param pszName The tracing config group name. This is NULL if
2545 * the operation applies to every device and
2546 * driver.
2547 * @param cchName The length to match.
2548 * @param fEnable Whether to enable or disable the corresponding
2549 * trace points.
2550 * @param fApply Whether to actually apply the changes or just do
2551 * existence checks.
2552 */
2553VMMR3_INT_DECL(int) PDMR3TracingConfig(PVM pVM, const char *pszName, size_t cchName, bool fEnable, bool fApply)
2554{
2555 /** @todo This code is potentially racing driver attaching and detaching. */
2556
2557 /*
2558 * Applies to all.
2559 */
2560 if (pszName == NULL)
2561 {
2562 AssertReturn(fApply, VINF_SUCCESS);
2563
2564 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2565 {
2566 pDevIns->fTracing = fEnable;
2567 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2568 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2569 pDrvIns->fTracing = fEnable;
2570 }
2571
2572#ifdef VBOX_WITH_USB
2573 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2574 {
2575 pUsbIns->fTracing = fEnable;
2576 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2577 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2578 pDrvIns->fTracing = fEnable;
2579
2580 }
2581#endif
2582 return VINF_SUCCESS;
2583 }
2584
2585 /*
2586 * Specific devices, USB devices or drivers.
2587 * Decode prefix to figure which of these it applies to.
2588 */
2589 if (cchName <= 3)
2590 return VERR_NOT_FOUND;
2591
2592 uint32_t cMatches = 0;
2593 if (!strncmp("dev", pszName, 3))
2594 {
2595 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2596 {
2597 const char *pszDevName = pDevIns->Internal.s.pDevR3->pReg->szName;
2598 size_t cchDevName = strlen(pszDevName);
2599 if ( ( cchDevName == cchName
2600 && RTStrNICmp(pszName, pszDevName, cchDevName))
2601 || ( cchDevName == cchName - 3
2602 && RTStrNICmp(pszName + 3, pszDevName, cchDevName)) )
2603 {
2604 cMatches++;
2605 if (fApply)
2606 pDevIns->fTracing = fEnable;
2607 }
2608 }
2609 }
2610 else if (!strncmp("usb", pszName, 3))
2611 {
2612 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2613 {
2614 const char *pszUsbName = pUsbIns->Internal.s.pUsbDev->pReg->szName;
2615 size_t cchUsbName = strlen(pszUsbName);
2616 if ( ( cchUsbName == cchName
2617 && RTStrNICmp(pszName, pszUsbName, cchUsbName))
2618 || ( cchUsbName == cchName - 3
2619 && RTStrNICmp(pszName + 3, pszUsbName, cchUsbName)) )
2620 {
2621 cMatches++;
2622 if (fApply)
2623 pUsbIns->fTracing = fEnable;
2624 }
2625 }
2626 }
2627 else if (!strncmp("drv", pszName, 3))
2628 {
2629 AssertReturn(fApply, VINF_SUCCESS);
2630
2631 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2632 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2633 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2634 {
2635 const char *pszDrvName = pDrvIns->Internal.s.pDrv->pReg->szName;
2636 size_t cchDrvName = strlen(pszDrvName);
2637 if ( ( cchDrvName == cchName
2638 && RTStrNICmp(pszName, pszDrvName, cchDrvName))
2639 || ( cchDrvName == cchName - 3
2640 && RTStrNICmp(pszName + 3, pszDrvName, cchDrvName)) )
2641 {
2642 cMatches++;
2643 if (fApply)
2644 pDrvIns->fTracing = fEnable;
2645 }
2646 }
2647
2648#ifdef VBOX_WITH_USB
2649 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2650 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2651 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2652 {
2653 const char *pszDrvName = pDrvIns->Internal.s.pDrv->pReg->szName;
2654 size_t cchDrvName = strlen(pszDrvName);
2655 if ( ( cchDrvName == cchName
2656 && RTStrNICmp(pszName, pszDrvName, cchDrvName))
2657 || ( cchDrvName == cchName - 3
2658 && RTStrNICmp(pszName + 3, pszDrvName, cchDrvName)) )
2659 {
2660 cMatches++;
2661 if (fApply)
2662 pDrvIns->fTracing = fEnable;
2663 }
2664 }
2665#endif
2666 }
2667 else
2668 return VERR_NOT_FOUND;
2669
2670 return cMatches > 0 ? VINF_SUCCESS : VERR_NOT_FOUND;
2671}
2672
2673
2674/**
2675 * Worker for DBGFR3TraceQueryConfig that checks whether all drivers, devices,
2676 * and USB device have the same tracing settings.
2677 *
2678 * @returns true / false.
2679 * @param pVM The cross context VM structure.
2680 * @param fEnabled The tracing setting to check for.
2681 */
2682VMMR3_INT_DECL(bool) PDMR3TracingAreAll(PVM pVM, bool fEnabled)
2683{
2684 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2685 {
2686 if (pDevIns->fTracing != (uint32_t)fEnabled)
2687 return false;
2688
2689 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2690 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2691 if (pDrvIns->fTracing != (uint32_t)fEnabled)
2692 return false;
2693 }
2694
2695#ifdef VBOX_WITH_USB
2696 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2697 {
2698 if (pUsbIns->fTracing != (uint32_t)fEnabled)
2699 return false;
2700
2701 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2702 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2703 if (pDrvIns->fTracing != (uint32_t)fEnabled)
2704 return false;
2705 }
2706#endif
2707
2708 return true;
2709}
2710
2711
2712/**
2713 * Worker for PDMR3TracingQueryConfig that adds a prefixed name to the output
2714 * string.
2715 *
2716 * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW
2717 * @param ppszDst The pointer to the output buffer pointer.
2718 * @param pcbDst The pointer to the output buffer size.
2719 * @param fSpace Whether to add a space before the name.
2720 * @param pszPrefix The name prefix.
2721 * @param pszName The name.
2722 */
2723static int pdmR3TracingAdd(char **ppszDst, size_t *pcbDst, bool fSpace, const char *pszPrefix, const char *pszName)
2724{
2725 size_t const cchPrefix = strlen(pszPrefix);
2726 if (!RTStrNICmp(pszPrefix, pszName, cchPrefix))
2727 pszName += cchPrefix;
2728 size_t const cchName = strlen(pszName);
2729
2730 size_t const cchThis = cchName + cchPrefix + fSpace;
2731 if (cchThis >= *pcbDst)
2732 return VERR_BUFFER_OVERFLOW;
2733 if (fSpace)
2734 {
2735 **ppszDst = ' ';
2736 memcpy(*ppszDst + 1, pszPrefix, cchPrefix);
2737 memcpy(*ppszDst + 1 + cchPrefix, pszName, cchName + 1);
2738 }
2739 else
2740 {
2741 memcpy(*ppszDst, pszPrefix, cchPrefix);
2742 memcpy(*ppszDst + cchPrefix, pszName, cchName + 1);
2743 }
2744 *ppszDst += cchThis;
2745 *pcbDst -= cchThis;
2746 return VINF_SUCCESS;
2747}
2748
2749
2750/**
2751 * Worker for DBGFR3TraceQueryConfig use when not everything is either enabled
2752 * or disabled.
2753 *
2754 * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW
2755 * @param pVM The cross context VM structure.
2756 * @param pszConfig Where to store the config spec.
2757 * @param cbConfig The size of the output buffer.
2758 */
2759VMMR3_INT_DECL(int) PDMR3TracingQueryConfig(PVM pVM, char *pszConfig, size_t cbConfig)
2760{
2761 int rc;
2762 char *pszDst = pszConfig;
2763 size_t cbDst = cbConfig;
2764
2765 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2766 {
2767 if (pDevIns->fTracing)
2768 {
2769 rc = pdmR3TracingAdd(&pszDst, &cbDst, pszDst != pszConfig, "dev", pDevIns->Internal.s.pDevR3->pReg->szName);
2770 if (RT_FAILURE(rc))
2771 return rc;
2772 }
2773
2774 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2775 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2776 if (pDrvIns->fTracing)
2777 {
2778 rc = pdmR3TracingAdd(&pszDst, &cbDst, pszDst != pszConfig, "drv", pDrvIns->Internal.s.pDrv->pReg->szName);
2779 if (RT_FAILURE(rc))
2780 return rc;
2781 }
2782 }
2783
2784#ifdef VBOX_WITH_USB
2785 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2786 {
2787 if (pUsbIns->fTracing)
2788 {
2789 rc = pdmR3TracingAdd(&pszDst, &cbDst, pszDst != pszConfig, "usb", pUsbIns->Internal.s.pUsbDev->pReg->szName);
2790 if (RT_FAILURE(rc))
2791 return rc;
2792 }
2793
2794 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2795 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown)
2796 if (pDrvIns->fTracing)
2797 {
2798 rc = pdmR3TracingAdd(&pszDst, &cbDst, pszDst != pszConfig, "drv", pDrvIns->Internal.s.pDrv->pReg->szName);
2799 if (RT_FAILURE(rc))
2800 return rc;
2801 }
2802 }
2803#endif
2804
2805 return VINF_SUCCESS;
2806}
2807
2808
2809/**
2810 * Checks that a PDMDRVREG::szName, PDMDEVREG::szName or PDMUSBREG::szName
2811 * field contains only a limited set of ASCII characters.
2812 *
2813 * @returns true / false.
2814 * @param pszName The name to validate.
2815 */
2816bool pdmR3IsValidName(const char *pszName)
2817{
2818 char ch;
2819 while ( (ch = *pszName) != '\0'
2820 && ( RT_C_IS_ALNUM(ch)
2821 || ch == '-'
2822 || ch == ' ' /** @todo disallow this! */
2823 || ch == '_') )
2824 pszName++;
2825 return ch == '\0';
2826}
2827
2828
2829/**
2830 * Info handler for 'pdmtracingids'.
2831 *
2832 * @param pVM The cross context VM structure.
2833 * @param pHlp The output helpers.
2834 * @param pszArgs The optional user arguments.
2835 *
2836 * @remarks Can be called on most threads.
2837 */
2838static DECLCALLBACK(void) pdmR3InfoTracingIds(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs)
2839{
2840 /*
2841 * Parse the argument (optional).
2842 */
2843 if ( pszArgs
2844 && *pszArgs
2845 && strcmp(pszArgs, "all")
2846 && strcmp(pszArgs, "devices")
2847 && strcmp(pszArgs, "drivers")
2848 && strcmp(pszArgs, "usb"))
2849 {
2850 pHlp->pfnPrintf(pHlp, "Unable to grok '%s'\n", pszArgs);
2851 return;
2852 }
2853 bool fAll = !pszArgs || !*pszArgs || !strcmp(pszArgs, "all");
2854 bool fDevices = fAll || !strcmp(pszArgs, "devices");
2855 bool fUsbDevs = fAll || !strcmp(pszArgs, "usb");
2856 bool fDrivers = fAll || !strcmp(pszArgs, "drivers");
2857
2858 /*
2859 * Produce the requested output.
2860 */
2861/** @todo lock PDM lists! */
2862 /* devices */
2863 if (fDevices)
2864 {
2865 pHlp->pfnPrintf(pHlp, "Device tracing IDs:\n");
2866 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2867 pHlp->pfnPrintf(pHlp, "%05u %s\n", pDevIns->idTracing, pDevIns->Internal.s.pDevR3->pReg->szName);
2868 }
2869
2870 /* USB devices */
2871 if (fUsbDevs)
2872 {
2873 pHlp->pfnPrintf(pHlp, "USB device tracing IDs:\n");
2874 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2875 pHlp->pfnPrintf(pHlp, "%05u %s\n", pUsbIns->idTracing, pUsbIns->Internal.s.pUsbDev->pReg->szName);
2876 }
2877
2878 /* Drivers */
2879 if (fDrivers)
2880 {
2881 pHlp->pfnPrintf(pHlp, "Driver tracing IDs:\n");
2882 for (PPDMDEVINS pDevIns = pVM->pdm.s.pDevInstances; pDevIns; pDevIns = pDevIns->Internal.s.pNextR3)
2883 {
2884 for (PPDMLUN pLun = pDevIns->Internal.s.pLunsR3; pLun; pLun = pLun->pNext)
2885 {
2886 uint32_t iLevel = 0;
2887 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown, iLevel++)
2888 pHlp->pfnPrintf(pHlp, "%05u %s (level %u, lun %u, dev %s)\n",
2889 pDrvIns->idTracing, pDrvIns->Internal.s.pDrv->pReg->szName,
2890 iLevel, pLun->iLun, pDevIns->Internal.s.pDevR3->pReg->szName);
2891 }
2892 }
2893
2894 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
2895 {
2896 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
2897 {
2898 uint32_t iLevel = 0;
2899 for (PPDMDRVINS pDrvIns = pLun->pTop; pDrvIns; pDrvIns = pDrvIns->Internal.s.pDown, iLevel++)
2900 pHlp->pfnPrintf(pHlp, "%05u %s (level %u, lun %u, dev %s)\n",
2901 pDrvIns->idTracing, pDrvIns->Internal.s.pDrv->pReg->szName,
2902 iLevel, pLun->iLun, pUsbIns->Internal.s.pUsbDev->pReg->szName);
2903 }
2904 }
2905 }
2906}
2907
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