VirtualBox

source: vbox/trunk/src/VBox/VMM/PDMInternal.h@ 34906

Last change on this file since 34906 was 34347, checked in by vboxsync, 14 years ago

BlkCache: Suspend the VM if an error occurs during a write
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 45.7 KB
Line 
1/* $Id: PDMInternal.h 34347 2010-11-24 22:34:21Z vboxsync $ */
2/** @file
3 * PDM - Internal header file.
4 */
5
6/*
7 * Copyright (C) 2006-2010 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#ifndef ___PDMInternal_h
19#define ___PDMInternal_h
20
21#include <VBox/types.h>
22#include <VBox/param.h>
23#include <VBox/cfgm.h>
24#include <VBox/stam.h>
25#include <VBox/vusb.h>
26#include <VBox/pdmasynccompletion.h>
27#include <VBox/pdmblkcache.h>
28#include <VBox/pdmcommon.h>
29#include <iprt/assert.h>
30#include <iprt/critsect.h>
31#ifdef IN_RING3
32# include <iprt/thread.h>
33#endif
34
35RT_C_DECLS_BEGIN
36
37
38/** @defgroup grp_pdm_int Internal
39 * @ingroup grp_pdm
40 * @internal
41 * @{
42 */
43
44/** @def PDM_WITH_R3R0_CRIT_SECT
45 * Enables or disabled ring-3/ring-0 critical sections. */
46#if defined(DOXYGEN_RUNNING) || 1
47# define PDM_WITH_R3R0_CRIT_SECT
48#endif
49
50/** @def PDMCRITSECT_STRICT
51 * Enables/disables PDM critsect strictness like deadlock detection. */
52#if (defined(RT_LOCK_STRICT) && defined(IN_RING3)) || defined(DOXYGEN_RUNNING)
53# define PDMCRITSECT_STRICT
54#endif
55
56
57/*******************************************************************************
58* Structures and Typedefs *
59*******************************************************************************/
60
61/** Pointer to a PDM Device. */
62typedef struct PDMDEV *PPDMDEV;
63/** Pointer to a pointer to a PDM Device. */
64typedef PPDMDEV *PPPDMDEV;
65
66/** Pointer to a PDM USB Device. */
67typedef struct PDMUSB *PPDMUSB;
68/** Pointer to a pointer to a PDM USB Device. */
69typedef PPDMUSB *PPPDMUSB;
70
71/** Pointer to a PDM Driver. */
72typedef struct PDMDRV *PPDMDRV;
73/** Pointer to a pointer to a PDM Driver. */
74typedef PPDMDRV *PPPDMDRV;
75
76/** Pointer to a PDM Logical Unit. */
77typedef struct PDMLUN *PPDMLUN;
78/** Pointer to a pointer to a PDM Logical Unit. */
79typedef PPDMLUN *PPPDMLUN;
80
81/** Pointer to a PDM PCI Bus instance. */
82typedef struct PDMPCIBUS *PPDMPCIBUS;
83/** Pointer to a DMAC instance. */
84typedef struct PDMDMAC *PPDMDMAC;
85/** Pointer to a RTC instance. */
86typedef struct PDMRTC *PPDMRTC;
87
88/** Pointer to an USB HUB registration record. */
89typedef struct PDMUSBHUB *PPDMUSBHUB;
90
91/**
92 * Supported asynchronous completion endpoint classes.
93 */
94typedef enum PDMASYNCCOMPLETIONEPCLASSTYPE
95{
96 /** File class. */
97 PDMASYNCCOMPLETIONEPCLASSTYPE_FILE = 0,
98 /** Number of supported classes. */
99 PDMASYNCCOMPLETIONEPCLASSTYPE_MAX,
100 /** 32bit hack. */
101 PDMASYNCCOMPLETIONEPCLASSTYPE_32BIT_HACK = 0x7fffffff
102} PDMASYNCCOMPLETIONEPCLASSTYPE;
103
104/**
105 * Private device instance data.
106 */
107typedef struct PDMDEVINSINT
108{
109 /** Pointer to the next instance (HC Ptr).
110 * (Head is pointed to by PDM::pDevInstances.) */
111 R3PTRTYPE(PPDMDEVINS) pNextR3;
112 /** Pointer to the next per device instance (HC Ptr).
113 * (Head is pointed to by PDMDEV::pInstances.) */
114 R3PTRTYPE(PPDMDEVINS) pPerDeviceNextR3;
115 /** Pointer to device structure - HC Ptr. */
116 R3PTRTYPE(PPDMDEV) pDevR3;
117 /** Pointer to the list of logical units associated with the device. (FIFO) */
118 R3PTRTYPE(PPDMLUN) pLunsR3;
119 /** Pointer to the asynchronous notification callback set while in
120 * FNPDMDEVSUSPEND or FNPDMDEVPOWEROFF. */
121 R3PTRTYPE(PFNPDMDEVASYNCNOTIFY) pfnAsyncNotify;
122 /** Configuration handle to the instance node. */
123 R3PTRTYPE(PCFGMNODE) pCfgHandle;
124
125 /** R3 pointer to the VM this instance was created for. */
126 PVMR3 pVMR3;
127 /** R3 pointer to associated PCI device structure. */
128 R3PTRTYPE(struct PCIDevice *) pPciDeviceR3;
129 /** R3 pointer to associated PCI bus structure. */
130 R3PTRTYPE(PPDMPCIBUS) pPciBusR3;
131
132 /** R0 pointer to the VM this instance was created for. */
133 PVMR0 pVMR0;
134 /** R0 pointer to associated PCI device structure. */
135 R0PTRTYPE(struct PCIDevice *) pPciDeviceR0;
136 /** R0 pointer to associated PCI bus structure. */
137 R0PTRTYPE(PPDMPCIBUS) pPciBusR0;
138
139 /** RC pointer to the VM this instance was created for. */
140 PVMRC pVMRC;
141 /** RC pointer to associated PCI device structure. */
142 RCPTRTYPE(struct PCIDevice *) pPciDeviceRC;
143 /** RC pointer to associated PCI bus structure. */
144 RCPTRTYPE(PPDMPCIBUS) pPciBusRC;
145
146 /** Flags, see PDMDEVINSINT_FLAGS_XXX. */
147 uint32_t fIntFlags;
148} PDMDEVINSINT;
149
150/** @name PDMDEVINSINT::fIntFlags
151 * @{ */
152/** Used by pdmR3Load to mark device instances it found in the saved state. */
153#define PDMDEVINSINT_FLAGS_FOUND RT_BIT_32(0)
154/** Indicates that the device hasn't been powered on or resumed.
155 * This is used by PDMR3PowerOn, PDMR3Resume, PDMR3Suspend and PDMR3PowerOff
156 * to make sure each device gets exactly one notification for each of those
157 * events. PDMR3Resume and PDMR3PowerOn also makes use of it to bail out on
158 * a failure (already resumed/powered-on devices are suspended). */
159#define PDMDEVINSINT_FLAGS_SUSPENDED RT_BIT_32(1)
160/** Indicates that the device has been reset already. Used by PDMR3Reset. */
161#define PDMDEVINSINT_FLAGS_RESET RT_BIT_32(2)
162/** @} */
163
164
165/**
166 * Private USB device instance data.
167 */
168typedef struct PDMUSBINSINT
169{
170 /** The UUID of this instance. */
171 RTUUID Uuid;
172 /** Pointer to the next instance.
173 * (Head is pointed to by PDM::pUsbInstances.) */
174 R3PTRTYPE(PPDMUSBINS) pNext;
175 /** Pointer to the next per USB device instance.
176 * (Head is pointed to by PDMUSB::pInstances.) */
177 R3PTRTYPE(PPDMUSBINS) pPerDeviceNext;
178
179 /** Pointer to device structure. */
180 R3PTRTYPE(PPDMUSB) pUsbDev;
181
182 /** Pointer to the VM this instance was created for. */
183 PVMR3 pVM;
184 /** Pointer to the list of logical units associated with the device. (FIFO) */
185 R3PTRTYPE(PPDMLUN) pLuns;
186 /** The per instance device configuration. */
187 R3PTRTYPE(PCFGMNODE) pCfg;
188 /** Same as pCfg if the configuration should be deleted when detaching the device. */
189 R3PTRTYPE(PCFGMNODE) pCfgDelete;
190 /** The global device configuration. */
191 R3PTRTYPE(PCFGMNODE) pCfgGlobal;
192
193 /** Pointer to the USB hub this device is attached to.
194 * This is NULL if the device isn't connected to any HUB. */
195 R3PTRTYPE(PPDMUSBHUB) pHub;
196 /** The port number that we're connected to. */
197 uint32_t iPort;
198 /** Indicates that the USB device hasn't been powered on or resumed.
199 * See PDMDEVINSINT_FLAGS_SUSPENDED. */
200 bool fVMSuspended;
201 /** Indicates that the USB device has been reset. */
202 bool fVMReset;
203 /** Pointer to the asynchronous notification callback set while in
204 * FNPDMDEVSUSPEND or FNPDMDEVPOWEROFF. */
205 R3PTRTYPE(PFNPDMUSBASYNCNOTIFY) pfnAsyncNotify;
206} PDMUSBINSINT;
207
208
209/**
210 * Private driver instance data.
211 */
212typedef struct PDMDRVINSINT
213{
214 /** Pointer to the driver instance above.
215 * This is NULL for the topmost drive. */
216 R3PTRTYPE(PPDMDRVINS) pUp;
217 /** Pointer to the driver instance below.
218 * This is NULL for the bottommost driver. */
219 R3PTRTYPE(PPDMDRVINS) pDown;
220 /** Pointer to the logical unit this driver chained on. */
221 R3PTRTYPE(PPDMLUN) pLun;
222 /** Pointer to driver structure from which this was instantiated. */
223 R3PTRTYPE(PPDMDRV) pDrv;
224 /** Pointer to the VM this instance was created for, ring-3 context. */
225 PVMR3 pVMR3;
226 /** Pointer to the VM this instance was created for, ring-0 context. */
227 PVMR0 pVMR0;
228 /** Pointer to the VM this instance was created for, raw-mode context. */
229 PVMRC pVMRC;
230 /** Flag indicating that the driver is being detached and destroyed.
231 * (Helps detect potential recursive detaching.) */
232 bool fDetaching;
233 /** Indicates that the driver hasn't been powered on or resumed.
234 * See PDMDEVINSINT_FLAGS_SUSPENDED. */
235 bool fVMSuspended;
236 /** Indicates that the driver has been reset already. */
237 bool fVMReset;
238 /** Set if allocated on the hyper heap, false if on the ring-3 heap. */
239 bool fHyperHeap;
240 /** Pointer to the asynchronous notification callback set while in
241 * PDMUSBREG::pfnVMSuspend or PDMUSBREG::pfnVMPowerOff. */
242 R3PTRTYPE(PFNPDMDRVASYNCNOTIFY) pfnAsyncNotify;
243 /** Configuration handle to the instance node. */
244 R3PTRTYPE(PCFGMNODE) pCfgHandle;
245 /** Pointer to the ring-0 request handler function. */
246 PFNPDMDRVREQHANDLERR0 pfnReqHandlerR0;
247} PDMDRVINSINT;
248
249
250/**
251 * Private critical section data.
252 */
253typedef struct PDMCRITSECTINT
254{
255 /** The critical section core which is shared with IPRT. */
256 RTCRITSECT Core;
257 /** Pointer to the next critical section.
258 * This chain is used for relocating pVMRC and device cleanup. */
259 R3PTRTYPE(struct PDMCRITSECTINT *) pNext;
260 /** Owner identifier.
261 * This is pDevIns if the owner is a device. Similarly for a driver or service.
262 * PDMR3CritSectInit() sets this to point to the critsect itself. */
263 RTR3PTR pvKey;
264 /** Pointer to the VM - R3Ptr. */
265 PVMR3 pVMR3;
266 /** Pointer to the VM - R0Ptr. */
267 PVMR0 pVMR0;
268 /** Pointer to the VM - GCPtr. */
269 PVMRC pVMRC;
270 /** Alignment padding. */
271 uint32_t padding;
272 /** Event semaphore that is scheduled to be signaled upon leaving the
273 * critical section. This is Ring-3 only of course. */
274 RTSEMEVENT EventToSignal;
275 /** The lock name. */
276 R3PTRTYPE(const char *) pszName;
277 /** R0/RC lock contention. */
278 STAMCOUNTER StatContentionRZLock;
279 /** R0/RC unlock contention. */
280 STAMCOUNTER StatContentionRZUnlock;
281 /** R3 lock contention. */
282 STAMCOUNTER StatContentionR3;
283 /** Profiling the time the section is locked. */
284 STAMPROFILEADV StatLocked;
285} PDMCRITSECTINT;
286AssertCompileMemberAlignment(PDMCRITSECTINT, StatContentionRZLock, 8);
287/** Pointer to private critical section data. */
288typedef PDMCRITSECTINT *PPDMCRITSECTINT;
289
290/** Indicates that the critical section is queued for unlock.
291 * PDMCritSectIsOwner and PDMCritSectIsOwned optimizations. */
292#define PDMCRITSECT_FLAGS_PENDING_UNLOCK RT_BIT_32(17)
293
294
295/**
296 * The usual device/driver/internal/external stuff.
297 */
298typedef enum
299{
300 /** The usual invalid entry. */
301 PDMTHREADTYPE_INVALID = 0,
302 /** Device type. */
303 PDMTHREADTYPE_DEVICE,
304 /** USB Device type. */
305 PDMTHREADTYPE_USB,
306 /** Driver type. */
307 PDMTHREADTYPE_DRIVER,
308 /** Internal type. */
309 PDMTHREADTYPE_INTERNAL,
310 /** External type. */
311 PDMTHREADTYPE_EXTERNAL,
312 /** The usual 32-bit hack. */
313 PDMTHREADTYPE_32BIT_HACK = 0x7fffffff
314} PDMTHREADTYPE;
315
316
317/**
318 * The internal structure for the thread.
319 */
320typedef struct PDMTHREADINT
321{
322 /** The VM pointer. */
323 PVMR3 pVM;
324 /** The event semaphore the thread blocks on when not running. */
325 RTSEMEVENTMULTI BlockEvent;
326 /** The event semaphore the thread sleeps on while running. */
327 RTSEMEVENTMULTI SleepEvent;
328 /** Pointer to the next thread. */
329 R3PTRTYPE(struct PDMTHREAD *) pNext;
330 /** The thread type. */
331 PDMTHREADTYPE enmType;
332} PDMTHREADINT;
333
334
335
336/* Must be included after PDMDEVINSINT is defined. */
337#define PDMDEVINSINT_DECLARED
338#define PDMUSBINSINT_DECLARED
339#define PDMDRVINSINT_DECLARED
340#define PDMCRITSECTINT_DECLARED
341#define PDMTHREADINT_DECLARED
342#ifdef ___VBox_pdm_h
343# error "Invalid header PDM order. Include PDMInternal.h before VBox/pdm.h!"
344#endif
345RT_C_DECLS_END
346#include <VBox/pdm.h>
347RT_C_DECLS_BEGIN
348
349/**
350 * PDM Logical Unit.
351 *
352 * This typically the representation of a physical port on a
353 * device, like for instance the PS/2 keyboard port on the
354 * keyboard controller device. The LUNs are chained on the
355 * device the belong to (PDMDEVINSINT::pLunsR3).
356 */
357typedef struct PDMLUN
358{
359 /** The LUN - The Logical Unit Number. */
360 RTUINT iLun;
361 /** Pointer to the next LUN. */
362 PPDMLUN pNext;
363 /** Pointer to the top driver in the driver chain. */
364 PPDMDRVINS pTop;
365 /** Pointer to the bottom driver in the driver chain. */
366 PPDMDRVINS pBottom;
367 /** Pointer to the device instance which the LUN belongs to.
368 * Either this is set or pUsbIns is set. Both is never set at the same time. */
369 PPDMDEVINS pDevIns;
370 /** Pointer to the USB device instance which the LUN belongs to. */
371 PPDMUSBINS pUsbIns;
372 /** Pointer to the device base interface. */
373 PPDMIBASE pBase;
374 /** Description of this LUN. */
375 const char *pszDesc;
376} PDMLUN;
377
378
379/**
380 * PDM Device.
381 */
382typedef struct PDMDEV
383{
384 /** Pointer to the next device (R3 Ptr). */
385 R3PTRTYPE(PPDMDEV) pNext;
386 /** Device name length. (search optimization) */
387 RTUINT cchName;
388 /** Registration structure. */
389 R3PTRTYPE(const struct PDMDEVREG *) pReg;
390 /** Number of instances. */
391 uint32_t cInstances;
392 /** Pointer to chain of instances (R3 Ptr). */
393 PPDMDEVINSR3 pInstances;
394 /** The search path for raw-mode context modules (';' as separator). */
395 char *pszRCSearchPath;
396 /** The search path for ring-0 context modules (';' as separator). */
397 char *pszR0SearchPath;
398} PDMDEV;
399
400
401/**
402 * PDM USB Device.
403 */
404typedef struct PDMUSB
405{
406 /** Pointer to the next device (R3 Ptr). */
407 R3PTRTYPE(PPDMUSB) pNext;
408 /** Device name length. (search optimization) */
409 RTUINT cchName;
410 /** Registration structure. */
411 R3PTRTYPE(const struct PDMUSBREG *) pReg;
412 /** Next instance number. */
413 uint32_t iNextInstance;
414 /** Pointer to chain of instances (R3 Ptr). */
415 R3PTRTYPE(PPDMUSBINS) pInstances;
416} PDMUSB;
417
418
419/**
420 * PDM Driver.
421 */
422typedef struct PDMDRV
423{
424 /** Pointer to the next device. */
425 PPDMDRV pNext;
426 /** Registration structure. */
427 const struct PDMDRVREG * pReg;
428 /** Current number of instances. */
429 uint32_t cInstances;
430 /** The next instance number. */
431 uint32_t iNextInstance;
432 /** The search path for raw-mode context modules (';' as separator). */
433 char *pszRCSearchPath;
434 /** The search path for ring-0 context modules (';' as separator). */
435 char *pszR0SearchPath;
436} PDMDRV;
437
438
439/**
440 * PDM registered PIC device.
441 */
442typedef struct PDMPIC
443{
444 /** Pointer to the PIC device instance - R3. */
445 PPDMDEVINSR3 pDevInsR3;
446 /** @copydoc PDMPICREG::pfnSetIrqR3 */
447 DECLR3CALLBACKMEMBER(void, pfnSetIrqR3,(PPDMDEVINS pDevIns, int iIrq, int iLevel));
448 /** @copydoc PDMPICREG::pfnGetInterruptR3 */
449 DECLR3CALLBACKMEMBER(int, pfnGetInterruptR3,(PPDMDEVINS pDevIns));
450
451 /** Pointer to the PIC device instance - R0. */
452 PPDMDEVINSR0 pDevInsR0;
453 /** @copydoc PDMPICREG::pfnSetIrqR3 */
454 DECLR0CALLBACKMEMBER(void, pfnSetIrqR0,(PPDMDEVINS pDevIns, int iIrq, int iLevel));
455 /** @copydoc PDMPICREG::pfnGetInterruptR3 */
456 DECLR0CALLBACKMEMBER(int, pfnGetInterruptR0,(PPDMDEVINS pDevIns));
457
458 /** Pointer to the PIC device instance - RC. */
459 PPDMDEVINSRC pDevInsRC;
460 /** @copydoc PDMPICREG::pfnSetIrqR3 */
461 DECLRCCALLBACKMEMBER(void, pfnSetIrqRC,(PPDMDEVINS pDevIns, int iIrq, int iLevel));
462 /** @copydoc PDMPICREG::pfnGetInterruptR3 */
463 DECLRCCALLBACKMEMBER(int, pfnGetInterruptRC,(PPDMDEVINS pDevIns));
464 /** Alignment padding. */
465 RTRCPTR RCPtrPadding;
466} PDMPIC;
467
468
469/**
470 * PDM registered APIC device.
471 */
472typedef struct PDMAPIC
473{
474 /** Pointer to the APIC device instance - R3 Ptr. */
475 PPDMDEVINSR3 pDevInsR3;
476 /** @copydoc PDMAPICREG::pfnGetInterruptR3 */
477 DECLR3CALLBACKMEMBER(int, pfnGetInterruptR3,(PPDMDEVINS pDevIns));
478 /** @copydoc PDMAPICREG::pfnHasPendingIrqR3 */
479 DECLR3CALLBACKMEMBER(bool, pfnHasPendingIrqR3,(PPDMDEVINS pDevIns));
480 /** @copydoc PDMAPICREG::pfnSetBaseR3 */
481 DECLR3CALLBACKMEMBER(void, pfnSetBaseR3,(PPDMDEVINS pDevIns, uint64_t u64Base));
482 /** @copydoc PDMAPICREG::pfnGetBaseR3 */
483 DECLR3CALLBACKMEMBER(uint64_t, pfnGetBaseR3,(PPDMDEVINS pDevIns));
484 /** @copydoc PDMAPICREG::pfnSetTPRR3 */
485 DECLR3CALLBACKMEMBER(void, pfnSetTPRR3,(PPDMDEVINS pDevIns, VMCPUID idCpu, uint8_t u8TPR));
486 /** @copydoc PDMAPICREG::pfnGetTPRR3 */
487 DECLR3CALLBACKMEMBER(uint8_t, pfnGetTPRR3,(PPDMDEVINS pDevIns, VMCPUID idCpu));
488 /** @copydoc PDMAPICREG::pfnWriteMSRR3 */
489 DECLR3CALLBACKMEMBER(int, pfnWriteMSRR3, (PPDMDEVINS pDevIns, VMCPUID idCpu, uint32_t u32Reg, uint64_t u64Value));
490 /** @copydoc PDMAPICREG::pfnReadMSRR3 */
491 DECLR3CALLBACKMEMBER(int, pfnReadMSRR3, (PPDMDEVINS pDevIns, VMCPUID idCpu, uint32_t u32Reg, uint64_t *pu64Value));
492 /** @copydoc PDMAPICREG::pfnBusDeliverR3 */
493 DECLR3CALLBACKMEMBER(int, pfnBusDeliverR3,(PPDMDEVINS pDevIns, uint8_t u8Dest, uint8_t u8DestMode, uint8_t u8DeliveryMode,
494 uint8_t iVector, uint8_t u8Polarity, uint8_t u8TriggerMode));
495 /** @copydoc PDMAPICREG::pfnLocalInterruptR3 */
496 DECLR3CALLBACKMEMBER(int, pfnLocalInterruptR3,(PPDMDEVINS pDevIns, uint8_t u8Pin, uint8_t u8Level));
497
498 /** Pointer to the APIC device instance - R0 Ptr. */
499 PPDMDEVINSR0 pDevInsR0;
500 /** @copydoc PDMAPICREG::pfnGetInterruptR3 */
501 DECLR0CALLBACKMEMBER(int, pfnGetInterruptR0,(PPDMDEVINS pDevIns));
502 /** @copydoc PDMAPICREG::pfnHasPendingIrqR3 */
503 DECLR0CALLBACKMEMBER(bool, pfnHasPendingIrqR0,(PPDMDEVINS pDevIns));
504 /** @copydoc PDMAPICREG::pfnSetBaseR3 */
505 DECLR0CALLBACKMEMBER(void, pfnSetBaseR0,(PPDMDEVINS pDevIns, uint64_t u64Base));
506 /** @copydoc PDMAPICREG::pfnGetBaseR3 */
507 DECLR0CALLBACKMEMBER(uint64_t, pfnGetBaseR0,(PPDMDEVINS pDevIns));
508 /** @copydoc PDMAPICREG::pfnSetTPRR3 */
509 DECLR0CALLBACKMEMBER(void, pfnSetTPRR0,(PPDMDEVINS pDevIns, VMCPUID idCpu, uint8_t u8TPR));
510 /** @copydoc PDMAPICREG::pfnGetTPRR3 */
511 DECLR0CALLBACKMEMBER(uint8_t, pfnGetTPRR0,(PPDMDEVINS pDevIns, VMCPUID idCpu));
512 /** @copydoc PDMAPICREG::pfnWriteMSRR3 */
513 DECLR0CALLBACKMEMBER(uint32_t, pfnWriteMSRR0, (PPDMDEVINS pDevIns, VMCPUID idCpu, uint32_t u32Reg, uint64_t u64Value));
514 /** @copydoc PDMAPICREG::pfnReadMSRR3 */
515 DECLR0CALLBACKMEMBER(uint32_t, pfnReadMSRR0, (PPDMDEVINS pDevIns, VMCPUID idCpu, uint32_t u32Reg, uint64_t *pu64Value));
516 /** @copydoc PDMAPICREG::pfnBusDeliverR3 */
517 DECLR0CALLBACKMEMBER(int, pfnBusDeliverR0,(PPDMDEVINS pDevIns, uint8_t u8Dest, uint8_t u8DestMode, uint8_t u8DeliveryMode,
518 uint8_t iVector, uint8_t u8Polarity, uint8_t u8TriggerMode));
519 /** @copydoc PDMAPICREG::pfnLocalInterruptR3 */
520 DECLR0CALLBACKMEMBER(int, pfnLocalInterruptR0,(PPDMDEVINS pDevIns, uint8_t u8Pin, uint8_t u8Level));
521
522 /** Pointer to the APIC device instance - RC Ptr. */
523 PPDMDEVINSRC pDevInsRC;
524 /** @copydoc PDMAPICREG::pfnGetInterruptR3 */
525 DECLRCCALLBACKMEMBER(int, pfnGetInterruptRC,(PPDMDEVINS pDevIns));
526 /** @copydoc PDMAPICREG::pfnHasPendingIrqR3 */
527 DECLRCCALLBACKMEMBER(bool, pfnHasPendingIrqRC,(PPDMDEVINS pDevIns));
528 /** @copydoc PDMAPICREG::pfnSetBaseR3 */
529 DECLRCCALLBACKMEMBER(void, pfnSetBaseRC,(PPDMDEVINS pDevIns, uint64_t u64Base));
530 /** @copydoc PDMAPICREG::pfnGetBaseR3 */
531 DECLRCCALLBACKMEMBER(uint64_t, pfnGetBaseRC,(PPDMDEVINS pDevIns));
532 /** @copydoc PDMAPICREG::pfnSetTPRR3 */
533 DECLRCCALLBACKMEMBER(void, pfnSetTPRRC,(PPDMDEVINS pDevIns, VMCPUID idCpu, uint8_t u8TPR));
534 /** @copydoc PDMAPICREG::pfnGetTPRR3 */
535 DECLRCCALLBACKMEMBER(uint8_t, pfnGetTPRRC,(PPDMDEVINS pDevIns, VMCPUID idCpu));
536 /** @copydoc PDMAPICREG::pfnWriteMSRR3 */
537 DECLRCCALLBACKMEMBER(uint32_t, pfnWriteMSRRC, (PPDMDEVINS pDevIns, VMCPUID idCpu, uint32_t u32Reg, uint64_t u64Value));
538 /** @copydoc PDMAPICREG::pfnReadMSRR3 */
539 DECLRCCALLBACKMEMBER(uint32_t, pfnReadMSRRC, (PPDMDEVINS pDevIns, VMCPUID idCpu, uint32_t u32Reg, uint64_t *pu64Value));
540 /** @copydoc PDMAPICREG::pfnBusDeliverR3 */
541 DECLRCCALLBACKMEMBER(int, pfnBusDeliverRC,(PPDMDEVINS pDevIns, uint8_t u8Dest, uint8_t u8DestMode, uint8_t u8DeliveryMode,
542 uint8_t iVector, uint8_t u8Polarity, uint8_t u8TriggerMode));
543 /** @copydoc PDMAPICREG::pfnLocalInterruptR3 */
544 DECLRCCALLBACKMEMBER(int, pfnLocalInterruptRC,(PPDMDEVINS pDevIns, uint8_t u8Pin, uint8_t u8Level));
545 RTRCPTR RCPtrAlignment;
546
547} PDMAPIC;
548
549
550/**
551 * PDM registered I/O APIC device.
552 */
553typedef struct PDMIOAPIC
554{
555 /** Pointer to the APIC device instance - R3 Ptr. */
556 PPDMDEVINSR3 pDevInsR3;
557 /** @copydoc PDMIOAPICREG::pfnSetIrqR3 */
558 DECLR3CALLBACKMEMBER(void, pfnSetIrqR3,(PPDMDEVINS pDevIns, int iIrq, int iLevel));
559 /** @copydoc PDMIOAPICREG::pfnSendMsiR3 */
560 DECLR3CALLBACKMEMBER(void, pfnSendMsiR3,(PPDMDEVINS pDevIns, RTGCPHYS GCAddr, uint32_t uValue));
561
562 /** Pointer to the PIC device instance - R0. */
563 PPDMDEVINSR0 pDevInsR0;
564 /** @copydoc PDMIOAPICREG::pfnSetIrqR3 */
565 DECLR0CALLBACKMEMBER(void, pfnSetIrqR0,(PPDMDEVINS pDevIns, int iIrq, int iLevel));
566 /** @copydoc PDMIOAPICREG::pfnSendMsiR3 */
567 DECLR0CALLBACKMEMBER(void, pfnSendMsiR0,(PPDMDEVINS pDevIns, RTGCPHYS GCAddr, uint32_t uValue));
568
569 /** Pointer to the APIC device instance - RC Ptr. */
570 PPDMDEVINSRC pDevInsRC;
571 /** @copydoc PDMIOAPICREG::pfnSetIrqR3 */
572 DECLRCCALLBACKMEMBER(void, pfnSetIrqRC,(PPDMDEVINS pDevIns, int iIrq, int iLevel));
573 /** @copydoc PDMIOAPICREG::pfnSendMsiR3 */
574 DECLRCCALLBACKMEMBER(void, pfnSendMsiRC,(PPDMDEVINS pDevIns, RTGCPHYS GCAddr, uint32_t uValue));
575
576 uint8_t Alignment[4];
577} PDMIOAPIC;
578
579/** Maximum number of PCI busses for a VM. */
580#define PDM_PCI_BUSSES_MAX 8
581
582/**
583 * PDM PCI Bus instance.
584 */
585typedef struct PDMPCIBUS
586{
587 /** PCI bus number. */
588 RTUINT iBus;
589 RTUINT uPadding0; /**< Alignment padding.*/
590
591 /** Pointer to PCI Bus device instance. */
592 PPDMDEVINSR3 pDevInsR3;
593 /** @copydoc PDMPCIBUSREG::pfnSetIrqR3 */
594 DECLR3CALLBACKMEMBER(void, pfnSetIrqR3,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, int iIrq, int iLevel));
595 /** @copydoc PDMPCIBUSREG::pfnRegisterR3 */
596 DECLR3CALLBACKMEMBER(int, pfnRegisterR3,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, const char *pszName, int iDev));
597 /** @copydoc PDMPCIBUSREG::pfnPCIRegisterMsiR3 */
598 DECLR3CALLBACKMEMBER(int, pfnRegisterMsiR3,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, PPDMMSIREG pMsiReg));
599 /** @copydoc PDMPCIBUSREG::pfnIORegionRegisterR3 */
600 DECLR3CALLBACKMEMBER(int, pfnIORegionRegisterR3,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, int iRegion, uint32_t cbRegion,
601 PCIADDRESSSPACE enmType, PFNPCIIOREGIONMAP pfnCallback));
602 /** @copydoc PDMPCIBUSREG::pfnSetConfigCallbacksR3 */
603 DECLR3CALLBACKMEMBER(void, pfnSetConfigCallbacksR3,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, PFNPCICONFIGREAD pfnRead,
604 PPFNPCICONFIGREAD ppfnReadOld, PFNPCICONFIGWRITE pfnWrite, PPFNPCICONFIGWRITE ppfnWriteOld));
605 /** @copydoc PDMPCIBUSREG::pfnSaveExecR3 */
606 DECLR3CALLBACKMEMBER(int, pfnSaveExecR3,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, PSSMHANDLE pSSMHandle));
607 /** @copydoc PDMPCIBUSREG::pfnLoadExecR3 */
608 DECLR3CALLBACKMEMBER(int, pfnLoadExecR3,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, PSSMHANDLE pSSMHandle));
609 /** @copydoc PDMPCIBUSREG::pfnFakePCIBIOSR3 */
610 DECLR3CALLBACKMEMBER(int, pfnFakePCIBIOSR3,(PPDMDEVINS pDevIns));
611
612 /** Pointer to the PIC device instance - R0. */
613 R0PTRTYPE(PPDMDEVINS) pDevInsR0;
614 /** @copydoc PDMPCIBUSREG::pfnSetIrqR3 */
615 DECLR0CALLBACKMEMBER(void, pfnSetIrqR0,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, int iIrq, int iLevel));
616
617 /** Pointer to PCI Bus device instance. */
618 PPDMDEVINSRC pDevInsRC;
619 /** @copydoc PDMPCIBUSREG::pfnSetIrqR3 */
620 DECLRCCALLBACKMEMBER(void, pfnSetIrqRC,(PPDMDEVINS pDevIns, PPCIDEVICE pPciDev, int iIrq, int iLevel));
621} PDMPCIBUS;
622
623
624#ifdef IN_RING3
625/**
626 * PDM registered DMAC (DMA Controller) device.
627 */
628typedef struct PDMDMAC
629{
630 /** Pointer to the DMAC device instance. */
631 PPDMDEVINSR3 pDevIns;
632 /** Copy of the registration structure. */
633 PDMDMACREG Reg;
634} PDMDMAC;
635
636
637/**
638 * PDM registered RTC (Real Time Clock) device.
639 */
640typedef struct PDMRTC
641{
642 /** Pointer to the RTC device instance. */
643 PPDMDEVINSR3 pDevIns;
644 /** Copy of the registration structure. */
645 PDMRTCREG Reg;
646} PDMRTC;
647
648#endif /* IN_RING3 */
649
650/**
651 * Module type.
652 */
653typedef enum PDMMODTYPE
654{
655 /** Raw-mode (RC) context module. */
656 PDMMOD_TYPE_RC,
657 /** Ring-0 (host) context module. */
658 PDMMOD_TYPE_R0,
659 /** Ring-3 (host) context module. */
660 PDMMOD_TYPE_R3
661} PDMMODTYPE;
662
663
664/** The module name length including the terminator. */
665#define PDMMOD_NAME_LEN 32
666
667/**
668 * Loaded module instance.
669 */
670typedef struct PDMMOD
671{
672 /** Module name. This is used for referring to
673 * the module internally, sort of like a handle. */
674 char szName[PDMMOD_NAME_LEN];
675 /** Module type. */
676 PDMMODTYPE eType;
677 /** Loader module handle. Not used for R0 modules. */
678 RTLDRMOD hLdrMod;
679 /** Loaded address.
680 * This is the 'handle' for R0 modules. */
681 RTUINTPTR ImageBase;
682 /** Old loaded address.
683 * This is used during relocation of GC modules. Not used for R0 modules. */
684 RTUINTPTR OldImageBase;
685 /** Where the R3 HC bits are stored.
686 * This can be equal to ImageBase but doesn't have to. Not used for R0 modules. */
687 void *pvBits;
688
689 /** Pointer to next module. */
690 struct PDMMOD *pNext;
691 /** Module filename. */
692 char szFilename[1];
693} PDMMOD;
694/** Pointer to loaded module instance. */
695typedef PDMMOD *PPDMMOD;
696
697
698
699/** Extra space in the free array. */
700#define PDMQUEUE_FREE_SLACK 16
701
702/**
703 * Queue type.
704 */
705typedef enum PDMQUEUETYPE
706{
707 /** Device consumer. */
708 PDMQUEUETYPE_DEV = 1,
709 /** Driver consumer. */
710 PDMQUEUETYPE_DRV,
711 /** Internal consumer. */
712 PDMQUEUETYPE_INTERNAL,
713 /** External consumer. */
714 PDMQUEUETYPE_EXTERNAL
715} PDMQUEUETYPE;
716
717/** Pointer to a PDM Queue. */
718typedef struct PDMQUEUE *PPDMQUEUE;
719
720/**
721 * PDM Queue.
722 */
723typedef struct PDMQUEUE
724{
725 /** Pointer to the next queue in the list. */
726 R3PTRTYPE(PPDMQUEUE) pNext;
727 /** Type specific data. */
728 union
729 {
730 /** PDMQUEUETYPE_DEV */
731 struct
732 {
733 /** Pointer to consumer function. */
734 R3PTRTYPE(PFNPDMQUEUEDEV) pfnCallback;
735 /** Pointer to the device instance owning the queue. */
736 R3PTRTYPE(PPDMDEVINS) pDevIns;
737 } Dev;
738 /** PDMQUEUETYPE_DRV */
739 struct
740 {
741 /** Pointer to consumer function. */
742 R3PTRTYPE(PFNPDMQUEUEDRV) pfnCallback;
743 /** Pointer to the driver instance owning the queue. */
744 R3PTRTYPE(PPDMDRVINS) pDrvIns;
745 } Drv;
746 /** PDMQUEUETYPE_INTERNAL */
747 struct
748 {
749 /** Pointer to consumer function. */
750 R3PTRTYPE(PFNPDMQUEUEINT) pfnCallback;
751 } Int;
752 /** PDMQUEUETYPE_EXTERNAL */
753 struct
754 {
755 /** Pointer to consumer function. */
756 R3PTRTYPE(PFNPDMQUEUEEXT) pfnCallback;
757 /** Pointer to user argument. */
758 R3PTRTYPE(void *) pvUser;
759 } Ext;
760 } u;
761 /** Queue type. */
762 PDMQUEUETYPE enmType;
763 /** The interval between checking the queue for events.
764 * The realtime timer below is used to do the waiting.
765 * If 0, the queue will use the VM_FF_PDM_QUEUE forced action. */
766 uint32_t cMilliesInterval;
767 /** Interval timer. Only used if cMilliesInterval is non-zero. */
768 PTMTIMERR3 pTimer;
769 /** Pointer to the VM - R3. */
770 PVMR3 pVMR3;
771 /** LIFO of pending items - R3. */
772 R3PTRTYPE(PPDMQUEUEITEMCORE) volatile pPendingR3;
773 /** Pointer to the VM - R0. */
774 PVMR0 pVMR0;
775 /** LIFO of pending items - R0. */
776 R0PTRTYPE(PPDMQUEUEITEMCORE) volatile pPendingR0;
777 /** Pointer to the GC VM and indicator for GC enabled queue.
778 * If this is NULL, the queue cannot be used in GC.
779 */
780 PVMRC pVMRC;
781 /** LIFO of pending items - GC. */
782 RCPTRTYPE(PPDMQUEUEITEMCORE) volatile pPendingRC;
783
784 /** Item size (bytes). */
785 uint32_t cbItem;
786 /** Number of items in the queue. */
787 uint32_t cItems;
788 /** Index to the free head (where we insert). */
789 uint32_t volatile iFreeHead;
790 /** Index to the free tail (where we remove). */
791 uint32_t volatile iFreeTail;
792
793 /** Unique queue name. */
794 R3PTRTYPE(const char *) pszName;
795#if HC_ARCH_BITS == 32
796 RTR3PTR Alignment1;
797#endif
798 /** Stat: Times PDMQueueAlloc fails. */
799 STAMCOUNTER StatAllocFailures;
800 /** Stat: PDMQueueInsert calls. */
801 STAMCOUNTER StatInsert;
802 /** Stat: Queue flushes. */
803 STAMCOUNTER StatFlush;
804 /** Stat: Queue flushes with pending items left over. */
805 STAMCOUNTER StatFlushLeftovers;
806#ifdef VBOX_WITH_STATISTICS
807 /** State: Profiling the flushing. */
808 STAMPROFILE StatFlushPrf;
809 /** State: Pending items. */
810 uint32_t volatile cStatPending;
811 uint32_t volatile cAlignment;
812#endif
813
814 /** Array of pointers to free items. Variable size. */
815 struct PDMQUEUEFREEITEM
816 {
817 /** Pointer to the free item - HC Ptr. */
818 R3PTRTYPE(PPDMQUEUEITEMCORE) volatile pItemR3;
819 /** Pointer to the free item - HC Ptr. */
820 R0PTRTYPE(PPDMQUEUEITEMCORE) volatile pItemR0;
821 /** Pointer to the free item - GC Ptr. */
822 RCPTRTYPE(PPDMQUEUEITEMCORE) volatile pItemRC;
823#if HC_ARCH_BITS == 64
824 RTRCPTR Alignment0;
825#endif
826 } aFreeItems[1];
827} PDMQUEUE;
828
829/** @name PDM::fQueueFlushing
830 * @{ */
831/** Used to make sure only one EMT will flush the queues.
832 * Set when an EMT is flushing queues, clear otherwise. */
833#define PDM_QUEUE_FLUSH_FLAG_ACTIVE_BIT 0
834/** Indicating there are queues with items pending.
835 * This is make sure we don't miss inserts happening during flushing. The FF
836 * cannot be used for this since it has to be cleared immediately to prevent
837 * other EMTs from spinning. */
838#define PDM_QUEUE_FLUSH_FLAG_PENDING_BIT 1
839/** }@ */
840
841
842/**
843 * Queue device helper task operation.
844 */
845typedef enum PDMDEVHLPTASKOP
846{
847 /** The usual invalid 0 entry. */
848 PDMDEVHLPTASKOP_INVALID = 0,
849 /** ISASetIrq */
850 PDMDEVHLPTASKOP_ISA_SET_IRQ,
851 /** PCISetIrq */
852 PDMDEVHLPTASKOP_PCI_SET_IRQ,
853 /** PCISetIrq */
854 PDMDEVHLPTASKOP_IOAPIC_SET_IRQ,
855 /** The usual 32-bit hack. */
856 PDMDEVHLPTASKOP_32BIT_HACK = 0x7fffffff
857} PDMDEVHLPTASKOP;
858
859/**
860 * Queued Device Helper Task.
861 */
862typedef struct PDMDEVHLPTASK
863{
864 /** The queue item core (don't touch). */
865 PDMQUEUEITEMCORE Core;
866 /** Pointer to the device instance (R3 Ptr). */
867 PPDMDEVINSR3 pDevInsR3;
868 /** This operation to perform. */
869 PDMDEVHLPTASKOP enmOp;
870#if HC_ARCH_BITS == 64
871 uint32_t Alignment0;
872#endif
873 /** Parameters to the operation. */
874 union PDMDEVHLPTASKPARAMS
875 {
876 /**
877 * PDMDEVHLPTASKOP_ISA_SET_IRQ and PDMDEVHLPTASKOP_PCI_SET_IRQ.
878 */
879 struct PDMDEVHLPTASKSETIRQ
880 {
881 /** The IRQ */
882 int iIrq;
883 /** The new level. */
884 int iLevel;
885 } SetIRQ;
886 } u;
887} PDMDEVHLPTASK;
888/** Pointer to a queued Device Helper Task. */
889typedef PDMDEVHLPTASK *PPDMDEVHLPTASK;
890/** Pointer to a const queued Device Helper Task. */
891typedef const PDMDEVHLPTASK *PCPDMDEVHLPTASK;
892
893
894
895/**
896 * An USB hub registration record.
897 */
898typedef struct PDMUSBHUB
899{
900 /** The USB versions this hub support.
901 * Note that 1.1 hubs can take on 2.0 devices. */
902 uint32_t fVersions;
903 /** The number of ports on the hub. */
904 uint32_t cPorts;
905 /** The number of available ports (0..cPorts). */
906 uint32_t cAvailablePorts;
907 /** The driver instance of the hub. */
908 PPDMDRVINS pDrvIns;
909 /** Copy of the to the registration structure. */
910 PDMUSBHUBREG Reg;
911
912 /** Pointer to the next hub in the list. */
913 struct PDMUSBHUB *pNext;
914} PDMUSBHUB;
915
916/** Pointer to a const USB HUB registration record. */
917typedef const PDMUSBHUB *PCPDMUSBHUB;
918
919/** Pointer to a PDM Async I/O template. */
920typedef struct PDMASYNCCOMPLETIONTEMPLATE *PPDMASYNCCOMPLETIONTEMPLATE;
921
922/** Pointer to the main PDM Async completion endpoint class. */
923typedef struct PDMASYNCCOMPLETIONEPCLASS *PPDMASYNCCOMPLETIONEPCLASS;
924
925/** Pointer to the global block cache structure. */
926typedef struct PDMBLKCACHEGLOBAL *PPDMBLKCACHEGLOBAL;
927
928/**
929 * PDM VMCPU Instance data.
930 * Changes to this must checked against the padding of the cfgm union in VMCPU!
931 */
932typedef struct PDMCPU
933{
934 /** The number of entries in the apQueuedCritSectsLeaves table that's currently in use. */
935 uint32_t cQueuedCritSectLeaves;
936 uint32_t uPadding0; /**< Alignment padding.*/
937 /** Critical sections queued in RC/R0 because of contention preventing leave to complete. (R3 Ptrs)
938 * We will return to Ring-3 ASAP, so this queue doesn't have to be very long. */
939 R3PTRTYPE(PPDMCRITSECT) apQueuedCritSectsLeaves[8];
940} PDMCPU;
941
942/**
943 * Converts a PDM pointer into a VM pointer.
944 * @returns Pointer to the VM structure the PDM is part of.
945 * @param pPDM Pointer to PDM instance data.
946 */
947#define PDM2VM(pPDM) ( (PVM)((char*)pPDM - pPDM->offVM) )
948
949
950/**
951 * PDM VM Instance data.
952 * Changes to this must checked against the padding of the cfgm union in VM!
953 */
954typedef struct PDM
955{
956 /** Offset to the VM structure.
957 * See PDM2VM(). */
958 RTUINT offVM;
959 RTUINT uPadding0; /**< Alignment padding.*/
960
961 /** List of registered devices. (FIFO) */
962 R3PTRTYPE(PPDMDEV) pDevs;
963 /** List of devices instances. (FIFO) */
964 R3PTRTYPE(PPDMDEVINS) pDevInstances;
965 /** List of registered USB devices. (FIFO) */
966 R3PTRTYPE(PPDMUSB) pUsbDevs;
967 /** List of USB devices instances. (FIFO) */
968 R3PTRTYPE(PPDMUSBINS) pUsbInstances;
969 /** List of registered drivers. (FIFO) */
970 R3PTRTYPE(PPDMDRV) pDrvs;
971 /** PCI Buses. */
972 PDMPCIBUS aPciBuses[PDM_PCI_BUSSES_MAX];
973 /** The register PIC device. */
974 PDMPIC Pic;
975 /** The registered APIC device. */
976 PDMAPIC Apic;
977 /** The registered I/O APIC device. */
978 PDMIOAPIC IoApic;
979 /** The registered DMAC device. */
980 R3PTRTYPE(PPDMDMAC) pDmac;
981 /** The registered RTC device. */
982 R3PTRTYPE(PPDMRTC) pRtc;
983 /** The registered USB HUBs. (FIFO) */
984 R3PTRTYPE(PPDMUSBHUB) pUsbHubs;
985
986 /** Queue in which devhlp tasks are queued for R3 execution - R3 Ptr. */
987 R3PTRTYPE(PPDMQUEUE) pDevHlpQueueR3;
988 /** Queue in which devhlp tasks are queued for R3 execution - R0 Ptr. */
989 R0PTRTYPE(PPDMQUEUE) pDevHlpQueueR0;
990 /** Queue in which devhlp tasks are queued for R3 execution - RC Ptr. */
991 RCPTRTYPE(PPDMQUEUE) pDevHlpQueueRC;
992 /** Pointer to the queue which should be manually flushed - RC Ptr.
993 * Only touched by EMT. */
994 RCPTRTYPE(struct PDMQUEUE *) pQueueFlushRC;
995 /** Pointer to the queue which should be manually flushed - R0 Ptr.
996 * Only touched by EMT. */
997 R0PTRTYPE(struct PDMQUEUE *) pQueueFlushR0;
998 /** Bitmask controlling the queue flushing.
999 * See PDM_QUEUE_FLUSH_FLAG_ACTIVE and PDM_QUEUE_FLUSH_FLAG_PENDING. */
1000 uint32_t volatile fQueueFlushing;
1001 /** Alignment padding. */
1002 uint32_t u32Padding2;
1003
1004 /** @name VMM device heap
1005 * @{ */
1006 /** Pointer to the heap base (MMIO2 ring-3 mapping). NULL if not registered. */
1007 RTR3PTR pvVMMDevHeap;
1008 /** The heap size. */
1009 uint32_t cbVMMDevHeap;
1010 /** Free space. */
1011 uint32_t cbVMMDevHeapLeft;
1012 /** The current mapping. NIL_RTGCPHYS if not mapped or registered. */
1013 RTGCPHYS GCPhysVMMDevHeap;
1014 /** @} */
1015
1016 /** The PDM lock.
1017 * This is used to protect everything that deals with interrupts, i.e.
1018 * the PIC, APIC, IOAPIC and PCI devices plus some PDM functions. */
1019 PDMCRITSECT CritSect;
1020
1021 /** Number of times a critical section leave request needed to be queued for ring-3 execution. */
1022 STAMCOUNTER StatQueuedCritSectLeaves;
1023} PDM;
1024AssertCompileMemberAlignment(PDM, GCPhysVMMDevHeap, sizeof(RTGCPHYS));
1025AssertCompileMemberAlignment(PDM, CritSect, 8);
1026AssertCompileMemberAlignment(PDM, StatQueuedCritSectLeaves, 8);
1027/** Pointer to PDM VM instance data. */
1028typedef PDM *PPDM;
1029
1030
1031
1032/**
1033 * PDM data kept in the UVM.
1034 */
1035typedef struct PDMUSERPERVM
1036{
1037 /** @todo move more stuff over here. */
1038
1039 /** Linked list of timer driven PDM queues.
1040 * Currently serialized by PDM::CritSect. */
1041 R3PTRTYPE(struct PDMQUEUE *) pQueuesTimer;
1042 /** Linked list of force action driven PDM queues.
1043 * Currently serialized by PDM::CritSect. */
1044 R3PTRTYPE(struct PDMQUEUE *) pQueuesForced;
1045
1046 /** Lock protecting the lists below it. */
1047 RTCRITSECT ListCritSect;
1048 /** Pointer to list of loaded modules. */
1049 PPDMMOD pModules;
1050 /** List of initialized critical sections. (LIFO) */
1051 R3PTRTYPE(PPDMCRITSECTINT) pCritSects;
1052 /** Head of the PDM Thread list. (singly linked) */
1053 R3PTRTYPE(PPDMTHREAD) pThreads;
1054 /** Tail of the PDM Thread list. (singly linked) */
1055 R3PTRTYPE(PPDMTHREAD) pThreadsTail;
1056
1057 /** @name PDM Async Completion
1058 * @{ */
1059 /** Pointer to the array of supported endpoint classes. */
1060 PPDMASYNCCOMPLETIONEPCLASS apAsyncCompletionEndpointClass[PDMASYNCCOMPLETIONEPCLASSTYPE_MAX];
1061 /** Head of the templates. Singly linked, protected by ListCritSect. */
1062 R3PTRTYPE(PPDMASYNCCOMPLETIONTEMPLATE) pAsyncCompletionTemplates;
1063 /** @} */
1064
1065 R3PTRTYPE(PPDMBLKCACHEGLOBAL) pBlkCacheGlobal;
1066
1067} PDMUSERPERVM;
1068/** Pointer to the PDM data kept in the UVM. */
1069typedef PDMUSERPERVM *PPDMUSERPERVM;
1070
1071
1072
1073/*******************************************************************************
1074* Global Variables *
1075*******************************************************************************/
1076#ifdef IN_RING3
1077extern const PDMDRVHLPR3 g_pdmR3DrvHlp;
1078extern const PDMDEVHLPR3 g_pdmR3DevHlpTrusted;
1079extern const PDMDEVHLPR3 g_pdmR3DevHlpUnTrusted;
1080extern const PDMPICHLPR3 g_pdmR3DevPicHlp;
1081extern const PDMAPICHLPR3 g_pdmR3DevApicHlp;
1082extern const PDMIOAPICHLPR3 g_pdmR3DevIoApicHlp;
1083extern const PDMPCIHLPR3 g_pdmR3DevPciHlp;
1084extern const PDMDMACHLP g_pdmR3DevDmacHlp;
1085extern const PDMRTCHLP g_pdmR3DevRtcHlp;
1086extern const PDMHPETHLPR3 g_pdmR3DevHpetHlp;
1087#endif
1088
1089
1090/*******************************************************************************
1091* Defined Constants And Macros *
1092*******************************************************************************/
1093/** @def PDMDEV_ASSERT_DEVINS
1094 * Asserts the validity of the device instance.
1095 */
1096#ifdef VBOX_STRICT
1097# define PDMDEV_ASSERT_DEVINS(pDevIns) \
1098 do { \
1099 AssertPtr(pDevIns); \
1100 Assert(pDevIns->u32Version == PDM_DEVINS_VERSION); \
1101 Assert(pDevIns->CTX_SUFF(pvInstanceData) == (void *)&pDevIns->achInstanceData[0]); \
1102 } while (0)
1103#else
1104# define PDMDEV_ASSERT_DEVINS(pDevIns) do { } while (0)
1105#endif
1106
1107/** @def PDMDRV_ASSERT_DRVINS
1108 * Asserts the validity of the driver instance.
1109 */
1110#ifdef VBOX_STRICT
1111# define PDMDRV_ASSERT_DRVINS(pDrvIns) \
1112 do { \
1113 AssertPtr(pDrvIns); \
1114 Assert(pDrvIns->u32Version == PDM_DRVINS_VERSION); \
1115 Assert(pDrvIns->CTX_SUFF(pvInstanceData) == (void *)&pDrvIns->achInstanceData[0]); \
1116 } while (0)
1117#else
1118# define PDMDRV_ASSERT_DRVINS(pDrvIns) do { } while (0)
1119#endif
1120
1121
1122/*******************************************************************************
1123* Internal Functions *
1124*******************************************************************************/
1125#ifdef IN_RING3
1126int pdmR3CritSectInitStats(PVM pVM);
1127void pdmR3CritSectRelocate(PVM pVM);
1128int pdmR3CritSectInitDevice(PVM pVM, PPDMDEVINS pDevIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszNameFmt, va_list va);
1129int pdmR3CritSectDeleteDevice(PVM pVM, PPDMDEVINS pDevIns);
1130int pdmR3CritSectInitDriver(PVM pVM, PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszNameFmt, ...);
1131int pdmR3CritSectDeleteDriver(PVM pVM, PPDMDRVINS pDrvIns);
1132
1133int pdmR3DevInit(PVM pVM);
1134PPDMDEV pdmR3DevLookup(PVM pVM, const char *pszName);
1135int pdmR3DevFindLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMLUN *ppLun);
1136DECLCALLBACK(bool) pdmR3DevHlpQueueConsumer(PVM pVM, PPDMQUEUEITEMCORE pItem);
1137
1138int pdmR3UsbLoadModules(PVM pVM);
1139int pdmR3UsbInstantiateDevices(PVM pVM);
1140PPDMUSB pdmR3UsbLookup(PVM pVM, const char *pszName);
1141int pdmR3UsbFindLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMLUN *ppLun);
1142int pdmR3UsbRegisterHub(PVM pVM, PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp);
1143int pdmR3UsbVMInitComplete(PVM pVM);
1144
1145int pdmR3DrvInit(PVM pVM);
1146int pdmR3DrvInstantiate(PVM pVM, PCFGMNODE pNode, PPDMIBASE pBaseInterface, PPDMDRVINS pDrvAbove,
1147 PPDMLUN pLun, PPDMIBASE *ppBaseInterface);
1148int pdmR3DrvDetach(PPDMDRVINS pDrvIns, uint32_t fFlags);
1149void pdmR3DrvDestroyChain(PPDMDRVINS pDrvIns, uint32_t fFlags);
1150PPDMDRV pdmR3DrvLookup(PVM pVM, const char *pszName);
1151
1152int pdmR3LdrInitU(PUVM pUVM);
1153void pdmR3LdrTermU(PUVM pUVM);
1154char *pdmR3FileR3(const char *pszFile, bool fShared);
1155int pdmR3LoadR3U(PUVM pUVM, const char *pszFilename, const char *pszName);
1156
1157void pdmR3QueueRelocate(PVM pVM, RTGCINTPTR offDelta);
1158
1159int pdmR3ThreadCreateDevice(PVM pVM, PPDMDEVINS pDevIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDEV pfnThread,
1160 PFNPDMTHREADWAKEUPDEV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName);
1161int pdmR3ThreadCreateUsb(PVM pVM, PPDMDRVINS pUsbIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADUSB pfnThread,
1162 PFNPDMTHREADWAKEUPUSB pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName);
1163int pdmR3ThreadCreateDriver(PVM pVM, PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1164 PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName);
1165int pdmR3ThreadDestroyDevice(PVM pVM, PPDMDEVINS pDevIns);
1166int pdmR3ThreadDestroyUsb(PVM pVM, PPDMUSBINS pUsbIns);
1167int pdmR3ThreadDestroyDriver(PVM pVM, PPDMDRVINS pDrvIns);
1168void pdmR3ThreadDestroyAll(PVM pVM);
1169int pdmR3ThreadResumeAll(PVM pVM);
1170int pdmR3ThreadSuspendAll(PVM pVM);
1171
1172#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1173int pdmR3AsyncCompletionInit(PVM pVM);
1174int pdmR3AsyncCompletionTerm(PVM pVM);
1175void pdmR3AsyncCompletionResume(PVM pVM);
1176#endif
1177
1178int pdmR3BlkCacheInit(PVM pVM);
1179void pdmR3BlkCacheTerm(PVM pVM);
1180int pdmR3BlkCacheResume(PVM pVM);
1181
1182#endif /* IN_RING3 */
1183
1184void pdmLock(PVM pVM);
1185int pdmLockEx(PVM pVM, int rc);
1186void pdmUnlock(PVM pVM);
1187
1188/** @} */
1189
1190RT_C_DECLS_END
1191
1192#endif
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