DevIoApic.cpp@ 89066

Last change on this file since 89066 was 89066, checked in by vboxsync, 4 years ago
Intel IOMMU: bugref:9967 DevIoApic: Add macros for checking PDM lock ownership and asserts to helper function pointers.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 74.6 KB

Line
1	/* $Id: DevIoApic.cpp 89066 2021-05-17 05:41:08Z vboxsync $ */
2	/** @file
3	* IO APIC - Input/Output Advanced Programmable Interrupt Controller.
4	*/
5
6	/*
7	* Copyright (C) 2016-2020 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	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#define LOG_GROUP LOG_GROUP_DEV_IOAPIC
23	#include <VBox/log.h>
24	#include <VBox/vmm/hm.h>
25	#include <VBox/msi.h>
26	#include <VBox/pci.h>
27	#include <VBox/vmm/pdmdev.h>
28
29	#include "VBoxDD.h"
30	#include <iprt/x86.h>
31	#include <iprt/string.h>
32
33
34	/*********************************************************************************************************************************
35	* Defined Constants And Macros *
36	*********************************************************************************************************************************/
37	/** The current IO APIC saved state version. */
38	#define IOAPIC_SAVED_STATE_VERSION 2
39	/** The saved state version used by VirtualBox 5.0 and
40	* earlier. */
41	#define IOAPIC_SAVED_STATE_VERSION_VBOX_50 1
42
43	/** Implementation specified by the "Intel I/O Controller Hub 9
44	* (ICH9) Family" */
45	#define IOAPIC_VERSION_ICH9 0x20
46	/** Implementation specified by the "82093AA I/O Advanced Programmable Interrupt
47	Controller" */
48	#define IOAPIC_VERSION_82093AA 0x11
49
50	/** The default MMIO base physical address. */
51	#define IOAPIC_MMIO_BASE_PHYSADDR UINT64_C(0xfec00000)
52	/** The size of the MMIO range. */
53	#define IOAPIC_MMIO_SIZE X86_PAGE_4K_SIZE
54	/** The mask for getting direct registers from physical address. */
55	#define IOAPIC_MMIO_REG_MASK 0xff
56
57	/** The number of interrupt input pins. */
58	#define IOAPIC_NUM_INTR_PINS 24
59	/** Maximum redirection entires. */
60	#define IOAPIC_MAX_RTE_INDEX (IOAPIC_NUM_INTR_PINS - 1)
61	/** Reduced RTEs used by SIO.A (82379AB). */
62	#define IOAPIC_REDUCED_MAX_RTE_INDEX (16 - 1)
63
64	/** Version register - Gets the version. */
65	#define IOAPIC_VER_GET_VER(a_Reg) ((a_Reg) & 0xff)
66	/** Version register - Gets the maximum redirection entry. */
67	#define IOAPIC_VER_GET_MRE(a_Reg) (((a_Reg) >> 16) & 0xff)
68	/** Version register - Gets whether Pin Assertion Register (PRQ) is
69	* supported. */
70	#define IOAPIC_VER_HAS_PRQ(a_Reg) RT_BOOL((a_Reg) & RT_BIT_32(15))
71
72	/** Index register - Valid write mask. */
73	#define IOAPIC_INDEX_VALID_WRITE_MASK UINT32_C(0xff)
74
75	/** Arbitration register - Gets the ID. */
76	#define IOAPIC_ARB_GET_ID(a_Reg) ((a_Reg) >> 24 & 0xf)
77
78	/** ID register - Gets the ID. */
79	#define IOAPIC_ID_GET_ID(a_Reg) ((a_Reg) >> 24 & 0xff)
80
81	/** Redirection table entry - Vector. */
82	#define IOAPIC_RTE_VECTOR UINT64_C(0xff)
83	/** Redirection table entry - Delivery mode. */
84	#define IOAPIC_RTE_DELIVERY_MODE (RT_BIT_64(8) \| RT_BIT_64(9) \| RT_BIT_64(10))
85	/** Redirection table entry - Destination mode. */
86	#define IOAPIC_RTE_DEST_MODE RT_BIT_64(11)
87	/** Redirection table entry - Delivery status. */
88	#define IOAPIC_RTE_DELIVERY_STATUS RT_BIT_64(12)
89	/** Redirection table entry - Interrupt input pin polarity. */
90	#define IOAPIC_RTE_POLARITY RT_BIT_64(13)
91	/** Redirection table entry - Remote IRR. */
92	#define IOAPIC_RTE_REMOTE_IRR RT_BIT_64(14)
93	/** Redirection table entry - Trigger Mode. */
94	#define IOAPIC_RTE_TRIGGER_MODE RT_BIT_64(15)
95	/** Redirection table entry - Number of bits to shift to get the Mask. */
96	#define IOAPIC_RTE_MASK_BIT 16
97	/** Redirection table entry - The Mask. */
98	#define IOAPIC_RTE_MASK RT_BIT_64(IOAPIC_RTE_MASK_BIT)
99	/** Redirection table entry - Extended Destination ID. */
100	#define IOAPIC_RTE_EXT_DEST_ID UINT64_C(0x00ff000000000000)
101	/** Redirection table entry - Destination. */
102	#define IOAPIC_RTE_DEST UINT64_C(0xff00000000000000)
103
104	/** Redirection table entry - Gets the destination. */
105	#define IOAPIC_RTE_GET_DEST(a_Reg) ((a_Reg) >> 56 & 0xff)
106	/** Redirection table entry - Gets the mask flag. */
107	#define IOAPIC_RTE_GET_MASK(a_Reg) (((a_Reg) >> IOAPIC_RTE_MASK_BIT) & 0x1)
108	/** Redirection table entry - Checks whether it's masked. */
109	#define IOAPIC_RTE_IS_MASKED(a_Reg) ((a_Reg) & IOAPIC_RTE_MASK)
110	/** Redirection table entry - Gets the trigger mode. */
111	#define IOAPIC_RTE_GET_TRIGGER_MODE(a_Reg) (((a_Reg) >> 15) & 0x1)
112	/** Redirection table entry - Gets the remote IRR flag. */
113	#define IOAPIC_RTE_GET_REMOTE_IRR(a_Reg) (((a_Reg) >> 14) & 0x1)
114	/** Redirection table entry - Gets the interrupt pin polarity. */
115	#define IOAPIC_RTE_GET_POLARITY(a_Reg) (((a_Reg) >> 13) & 0x1)
116	/** Redirection table entry - Gets the delivery status. */
117	#define IOAPIC_RTE_GET_DELIVERY_STATUS(a_Reg) (((a_Reg) >> 12) & 0x1)
118	/** Redirection table entry - Gets the destination mode. */
119	#define IOAPIC_RTE_GET_DEST_MODE(a_Reg) (((a_Reg) >> 11) & 0x1)
120	/** Redirection table entry - Gets the delivery mode. */
121	#define IOAPIC_RTE_GET_DELIVERY_MODE(a_Reg) (((a_Reg) >> 8) & 0x7)
122	/** Redirection table entry - Gets the vector. */
123	#define IOAPIC_RTE_GET_VECTOR(a_Reg) ((a_Reg) & IOAPIC_RTE_VECTOR)
124
125	/** @name DMAR variant interpretation of RTE fields.
126	* @{ */
127	/** Redirection table entry - Number of bits to shift to get Interrupt
128	* Index[14:0]. */
129	#define IOAPIC_RTE_INTR_INDEX_LO_BIT 49
130	/** Redirection table entry - Interrupt Index[14:0]. */
131	#define IOAPIC_RTE_INTR_INDEX_LO UINT64_C(0xfffe000000000000)
132	/** Redirection table entry - Number of bits to shift to get interrupt format. */
133	#define IOAPIC_RTE_INTR_FORMAT_BIT 48
134	/** Redirection table entry - Interrupt format. */
135	#define IOAPIC_RTE_INTR_FORMAT RT_BIT_64(IOAPIC_RTE_INTR_FORMAT_BIT)
136	/** Redirection table entry - Number of bits to shift to get Interrupt Index[15]. */
137	#define IOAPIC_RTE_INTR_INDEX_HI_BIT 11
138	/** Redirection table entry - Interrupt Index[15]. */
139	#define IOAPIC_RTE_INTR_INDEX_HI RT_BIT_64(11)
140
141	/** Redirection table entry - Gets the Interrupt Index[14:0]. */
142	#define IOAPIC_RTE_GET_INTR_INDEX_LO(a_Reg) ((a_Reg) >> IOAPIC_RTE_INTR_INDEX_LO_BIT)
143	/** Redirection table entry - Gets the Interrupt format. */
144	#define IOAPIC_RTE_GET_INTR_FORMAT(a_Reg) (((a_Reg) >> IOAPIC_RTE_INTR_FORMAT_BIT) & 0x1)
145	/** Redirection table entry - Gets the Interrupt Index[15]. */
146	#define IOAPIC_RTE_GET_INTR_INDEX_HI(a_Reg) (((a_Reg) >> IOAPIC_RTE_INTR_INDEX_HI_BIT) & 0x1)
147	/** @} */
148
149	/** Redirection table entry - Valid write mask for 82093AA. */
150	#define IOAPIC_RTE_VALID_WRITE_MASK_82093AA ( IOAPIC_RTE_DEST \| IOAPIC_RTE_MASK \| IOAPIC_RTE_TRIGGER_MODE \
151	\| IOAPIC_RTE_POLARITY \| IOAPIC_RTE_DEST_MODE \| IOAPIC_RTE_DELIVERY_MODE \
152	\| IOAPIC_RTE_VECTOR)
153	/** Redirection table entry - Valid read mask for 82093AA. */
154	#define IOAPIC_RTE_VALID_READ_MASK_82093AA ( IOAPIC_RTE_DEST \| IOAPIC_RTE_MASK \| IOAPIC_RTE_TRIGGER_MODE \
155	\| IOAPIC_RTE_REMOTE_IRR \| IOAPIC_RTE_POLARITY \| IOAPIC_RTE_DELIVERY_STATUS \
156	\| IOAPIC_RTE_DEST_MODE \| IOAPIC_RTE_DELIVERY_MODE \| IOAPIC_RTE_VECTOR)
157
158	/** Redirection table entry - Valid write mask for ICH9. */
159	/** @note The remote IRR bit has been reverted to read-only as it turns out the
160	* ICH9 spec. is wrong, see @bugref{8386#c46}. */
161	#define IOAPIC_RTE_VALID_WRITE_MASK_ICH9 ( IOAPIC_RTE_DEST \| IOAPIC_RTE_MASK \| IOAPIC_RTE_TRIGGER_MODE \
162	/\| IOAPIC_RTE_REMOTE_IRR /\| IOAPIC_RTE_POLARITY \| IOAPIC_RTE_DEST_MODE \
163	\| IOAPIC_RTE_DELIVERY_MODE \| IOAPIC_RTE_VECTOR)
164	/** Redirection table entry - Valid read mask (incl. ExtDestID) for ICH9. */
165	#define IOAPIC_RTE_VALID_READ_MASK_ICH9 ( IOAPIC_RTE_DEST \| IOAPIC_RTE_EXT_DEST_ID \| IOAPIC_RTE_MASK \
166	\| IOAPIC_RTE_TRIGGER_MODE \| IOAPIC_RTE_REMOTE_IRR \| IOAPIC_RTE_POLARITY \
167	\| IOAPIC_RTE_DELIVERY_STATUS \| IOAPIC_RTE_DEST_MODE \| IOAPIC_RTE_DELIVERY_MODE \
168	\| IOAPIC_RTE_VECTOR)
169
170	/** Redirection table entry - Valid write mask for DMAR variant. */
171	#define IOAPIC_RTE_VALID_WRITE_MASK_DMAR ( IOAPIC_RTE_INTR_INDEX_LO \| IOAPIC_RTE_INTR_FORMAT \| IOAPIC_RTE_MASK \
172	\| IOAPIC_RTE_TRIGGER_MODE \| IOAPIC_RTE_POLARITY \| IOAPIC_RTE_INTR_INDEX_HI \
173	\| IOAPIC_RTE_DELIVERY_MODE \| IOAPIC_RTE_VECTOR)
174	/** Redirection table entry - Valid read mask for DMAR variant. */
175	#define IOAPIC_RTE_VALID_READ_MASK_DMAR ( IOAPIC_RTE_INTR_INDEX_LO \| IOAPIC_RTE_INTR_FORMAT \| IOAPIC_RTE_MASK \
176	\| IOAPIC_RTE_TRIGGER_MODE \| IOAPIC_RTE_REMOTE_IRR \| IOAPIC_RTE_POLARITY \
177	\| IOAPIC_RTE_DELIVERY_STATUS \| IOAPIC_RTE_INTR_INDEX_HI \| IOAPIC_RTE_DELIVERY_MODE \
178	\| IOAPIC_RTE_VECTOR)
179
180	/** Redirection table entry - Trigger mode edge. */
181	#define IOAPIC_RTE_TRIGGER_MODE_EDGE 0
182	/** Redirection table entry - Trigger mode level. */
183	#define IOAPIC_RTE_TRIGGER_MODE_LEVEL 1
184	/** Redirection table entry - Destination mode physical. */
185	#define IOAPIC_RTE_DEST_MODE_PHYSICAL 0
186	/** Redirection table entry - Destination mode logical. */
187	#define IOAPIC_RTE_DEST_MODE_LOGICAL 1
188
189
190	/** Index of indirect registers in the I/O APIC register table. */
191	#define IOAPIC_INDIRECT_INDEX_ID 0x0
192	#define IOAPIC_INDIRECT_INDEX_VERSION 0x1
193	#define IOAPIC_INDIRECT_INDEX_ARB 0x2 /* Older I/O APIC only. */
194	#define IOAPIC_INDIRECT_INDEX_REDIR_TBL_START 0x10 /* First valid RTE register index. */
195	#define IOAPIC_INDIRECT_INDEX_RTE_END 0x3F /* Last valid RTE register index (24 RTEs). */
196	#define IOAPIC_REDUCED_INDIRECT_INDEX_RTE_END 0x2F /* Last valid RTE register index (16 RTEs). */
197
198	/** Offset of direct registers in the I/O APIC MMIO space. */
199	#define IOAPIC_DIRECT_OFF_INDEX 0x00
200	#define IOAPIC_DIRECT_OFF_DATA 0x10
201	#define IOAPIC_DIRECT_OFF_EOI 0x40 /* Newer I/O APIC only. */
202
203	/* Use PDM critsect for now for I/O APIC locking, see @bugref{8245#c121}. */
204	#define IOAPIC_WITH_PDM_CRITSECT
205	#ifdef IOAPIC_WITH_PDM_CRITSECT
206	# define IOAPIC_LOCK(a_pDevIns, a_pThis, a_pThisCC, rcBusy) (a_pThisCC)->pIoApicHlp->pfnLock((a_pDevIns), (rcBusy))
207	# define IOAPIC_UNLOCK(a_pDevIns, a_pThis, a_pThisCC) (a_pThisCC)->pIoApicHlp->pfnUnlock((a_pDevIns))
208	# define IOAPIC_LOCK_IS_OWNER(a_pDevIns, a_pThis, a_pThisCC) (a_pThisCC)->pIoApicHlp->pfnLockIsOwner((a_pDevIns))
209	#else
210	# define IOAPIC_LOCK(a_pDevIns, a_pThis, a_pThisCC, rcBusy) PDMDevHlpCritSectEnter((a_pDevIns), &(a_pThis)->CritSect, (rcBusy))
211	# define IOAPIC_UNLOCK(a_pDevIns, a_pThis, a_pThisCC) PDMDevHlpCritSectLeave((a_pDevIns), &(a_pThis)->CritSect)
212	# define IOAPIC_LOCK_IS_OWNER(a_pDevIns, a_pThis, a_pThisCC) PDMDevHlpCritSectIsOwner((a_pDevIns), &(a_pThis)->CritSect)
213	#endif
214
215
216	/*********************************************************************************************************************************
217	* Structures and Typedefs *
218	*********************************************************************************************************************************/
219	/**
220	* I/O APIC chipset (and variants) we support.
221	*/
222	typedef enum IOAPICTYPE
223	{
224	IOAPICTYPE_ICH9 = 1,
225	IOAPICTYPE_DMAR,
226	IOAPICTYPE_82093AA,
227	IOAPICTYPE_82379AB,
228	IOAPICTYPE_32BIT_HACK = 0x7fffffff
229	} IOAPICTYPE;
230	AssertCompileSize(IOAPICTYPE, 4);
231
232	/**
233	* The shared I/O APIC device state.
234	*/
235	typedef struct IOAPIC
236	{
237	/** The ID register. */
238	uint8_t volatile u8Id;
239	/** The index register. */
240	uint8_t volatile u8Index;
241	/** Number of CPUs. */
242	uint8_t cCpus;
243	/** I/O APIC version. */
244	uint8_t u8ApicVer;
245	/** I/O APIC ID mask. */
246	uint8_t u8IdMask;
247	/** Maximum Redirection Table Entry (RTE) Entry. */
248	uint8_t u8MaxRte;
249	/** Last valid RTE indirect register index. */
250	uint8_t u8LastRteRegIdx;
251	/* Alignment padding. */
252	uint8_t u8Padding0[1];
253	/** Redirection table entry - Valid write mask. */
254	uint64_t u64RteWriteMask;
255	/** Redirection table entry - Valid read mask. */
256	uint64_t u64RteReadMask;
257
258	/** The redirection table registers. */
259	uint64_t au64RedirTable[IOAPIC_NUM_INTR_PINS];
260	/** The IRQ tags and source IDs for each pin (tracing purposes). */
261	uint32_t au32TagSrc[IOAPIC_NUM_INTR_PINS];
262
263	/** The internal IRR reflecting state of the interrupt lines. */
264	uint32_t uIrr;
265	/** The I/O APIC chipset type. */
266	IOAPICTYPE enmType;
267
268	#ifndef IOAPIC_WITH_PDM_CRITSECT
269	/** The critsect for updating to the RTEs. */
270	PDMCRITSECT CritSect;
271	#endif
272
273	/** The MMIO region. */
274	IOMMMIOHANDLE hMmio;
275
276	#ifdef VBOX_WITH_STATISTICS
277	/** Number of MMIO reads in RZ. */
278	STAMCOUNTER StatMmioReadRZ;
279	/** Number of MMIO reads in R3. */
280	STAMCOUNTER StatMmioReadR3;
281
282	/** Number of MMIO writes in RZ. */
283	STAMCOUNTER StatMmioWriteRZ;
284	/** Number of MMIO writes in R3. */
285	STAMCOUNTER StatMmioWriteR3;
286
287	/** Number of SetIrq calls in RZ. */
288	STAMCOUNTER StatSetIrqRZ;
289	/** Number of SetIrq calls in R3. */
290	STAMCOUNTER StatSetIrqR3;
291
292	/** Number of SetEoi calls in RZ. */
293	STAMCOUNTER StatSetEoiRZ;
294	/** Number of SetEoi calls in R3. */
295	STAMCOUNTER StatSetEoiR3;
296
297	/** Number of redundant edge-triggered interrupts. */
298	STAMCOUNTER StatRedundantEdgeIntr;
299	/** Number of redundant level-triggered interrupts. */
300	STAMCOUNTER StatRedundantLevelIntr;
301	/** Number of suppressed level-triggered interrupts (by remote IRR). */
302	STAMCOUNTER StatSuppressedLevelIntr;
303	/** Number of IOMMU remapped interrupts (signaled by RTE). */
304	STAMCOUNTER StatIommuRemappedIntr;
305	/** Number of IOMMU discarded interrupts (signaled by RTE). */
306	STAMCOUNTER StatIommuDiscardedIntr;
307	/** Number of IOMMU remapped MSIs. */
308	STAMCOUNTER StatIommuRemappedMsi;
309	/** Number of IOMMU denied or failed MSIs. */
310	STAMCOUNTER StatIommuDiscardedMsi;
311	/** Number of returns to ring-3 due to EOI broadcast lock contention. */
312	STAMCOUNTER StatEoiContention;
313	/** Number of returns to ring-3 due to Set RTE lock contention. */
314	STAMCOUNTER StatSetRteContention;
315	/** Number of level-triggered interrupts dispatched to the local APIC(s). */
316	STAMCOUNTER StatLevelIrqSent;
317	/** Number of EOIs received for level-triggered interrupts from the local
318	* APIC(s). */
319	STAMCOUNTER StatEoiReceived;
320	#endif
321	/** Per-vector stats. */
322	STAMCOUNTER aStatVectors[256];
323	} IOAPIC;
324	AssertCompileMemberAlignment(IOAPIC, au64RedirTable, 8);
325	/** Pointer to shared IOAPIC data. */
326	typedef IOAPIC *PIOAPIC;
327	/** Pointer to const shared IOAPIC data. */
328	typedef IOAPIC const *PCIOAPIC;
329
330
331	/**
332	* The I/O APIC device state for ring-3.
333	*/
334	typedef struct IOAPICR3
335	{
336	/** The IOAPIC helpers. */
337	R3PTRTYPE(PCPDMIOAPICHLP) pIoApicHlp;
338	} IOAPICR3;
339	/** Pointer to the I/O APIC device state for ring-3. */
340	typedef IOAPICR3 *PIOAPICR3;
341
342
343	/**
344	* The I/O APIC device state for ring-0.
345	*/
346	typedef struct IOAPICR0
347	{
348	/** The IOAPIC helpers. */
349	R0PTRTYPE(PCPDMIOAPICHLP) pIoApicHlp;
350	} IOAPICR0;
351	/** Pointer to the I/O APIC device state for ring-0. */
352	typedef IOAPICR0 *PIOAPICR0;
353
354
355	/**
356	* The I/O APIC device state for raw-mode.
357	*/
358	typedef struct IOAPICRC
359	{
360	/** The IOAPIC helpers. */
361	RCPTRTYPE(PCPDMIOAPICHLP) pIoApicHlp;
362	} IOAPICRC;
363	/** Pointer to the I/O APIC device state for raw-mode. */
364	typedef IOAPICRC *PIOAPICRC;
365
366
367	/** The I/O APIC device state for the current context. */
368	typedef CTX_SUFF(IOAPIC) IOAPICCC;
369	/** Pointer to the I/O APIC device state for the current context. */
370	typedef CTX_SUFF(PIOAPIC) PIOAPICCC;
371
372
373	/**
374	* xAPIC interrupt.
375	*/
376	typedef struct XAPICINTR
377	{
378	/** The interrupt vector. */
379	uint8_t u8Vector;
380	/** The destination (mask or ID). */
381	uint8_t u8Dest;
382	/** The destination mode. */
383	uint8_t u8DestMode;
384	/** Delivery mode. */
385	uint8_t u8DeliveryMode;
386	/** Trigger mode. */
387	uint8_t u8TriggerMode;
388	/** Redirection hint. */
389	uint8_t u8RedirHint;
390	/** Polarity. */
391	uint8_t u8Polarity;
392	/** Padding. */
393	uint8_t abPadding0;
394	} XAPICINTR;
395	/** Pointer to an I/O xAPIC interrupt struct. */
396	typedef XAPICINTR *PXAPICINTR;
397	/** Pointer to a const xAPIC interrupt struct. */
398	typedef XAPICINTR const *PCXAPICINTR;
399
400
401	#ifndef VBOX_DEVICE_STRUCT_TESTCASE
402
403	/**
404	* Gets the arbitration register.
405	*
406	* @returns The arbitration.
407	*/
408	DECLINLINE(uint32_t) ioapicGetArb(void)
409	{
410	Log2(("IOAPIC: ioapicGetArb: returns 0\n"));
411	return 0;
412	}
413
414
415	/**
416	* Gets the version register.
417	*
418	* @returns The version.
419	*/
420	DECLINLINE(uint32_t) ioapicGetVersion(PCIOAPIC pThis)
421	{
422	uint32_t uValue = RT_MAKE_U32(pThis->u8ApicVer, pThis->u8MaxRte);
423	Log2(("IOAPIC: ioapicGetVersion: returns %#RX32\n", uValue));
424	return uValue;
425	}
426
427
428	/**
429	* Sets the ID register.
430	*
431	* @param pThis The shared I/O APIC device state.
432	* @param uValue The value to set.
433	*/
434	DECLINLINE(void) ioapicSetId(PIOAPIC pThis, uint32_t uValue)
435	{
436	Log2(("IOAPIC: ioapicSetId: uValue=%#RX32\n", uValue));
437	ASMAtomicWriteU8(&pThis->u8Id, (uValue >> 24) & pThis->u8IdMask);
438	}
439
440
441	/**
442	* Gets the ID register.
443	*
444	* @returns The ID.
445	* @param pThis The shared I/O APIC device state.
446	*/
447	DECLINLINE(uint32_t) ioapicGetId(PCIOAPIC pThis)
448	{
449	uint32_t uValue = (uint32_t)pThis->u8Id << 24;
450	Log2(("IOAPIC: ioapicGetId: returns %#RX32\n", uValue));
451	return uValue;
452	}
453
454
455	/**
456	* Sets the index register.
457	*
458	* @param pThis The shared I/O APIC device state.
459	* @param uValue The value to set.
460	*/
461	DECLINLINE(void) ioapicSetIndex(PIOAPIC pThis, uint32_t uValue)
462	{
463	LogFlow(("IOAPIC: ioapicSetIndex: uValue=%#RX32\n", uValue));
464	ASMAtomicWriteU8(&pThis->u8Index, uValue & IOAPIC_INDEX_VALID_WRITE_MASK);
465	}
466
467
468	/**
469	* Gets the index register.
470	*
471	* @returns The index value.
472	*/
473	DECLINLINE(uint32_t) ioapicGetIndex(PCIOAPIC pThis)
474	{
475	uint32_t const uValue = pThis->u8Index;
476	LogFlow(("IOAPIC: ioapicGetIndex: returns %#x\n", uValue));
477	return uValue;
478	}
479
480
481	/**
482	* Converts an MSI message to an APIC interrupt.
483	*
484	* @param pMsi The MSI message to convert.
485	* @param pIntr Where to store the APIC interrupt.
486	*/
487	DECLINLINE(void) ioapicGetApicIntrFromMsi(PCMSIMSG pMsi, PXAPICINTR pIntr)
488	{
489	/*
490	* Parse the message from the physical address and data.
491	* Do -not- zero out other fields in the APIC interrupt.
492	*
493	* See Intel spec. 10.11.1 "Message Address Register Format".
494	* See Intel spec. 10.11.2 "Message Data Register Format".
495	*/
496	pIntr->u8Dest = pMsi->Addr.n.u8DestId;
497	pIntr->u8DestMode = pMsi->Addr.n.u1DestMode;
498	pIntr->u8RedirHint = pMsi->Addr.n.u1RedirHint;
499
500	pIntr->u8Vector = pMsi->Data.n.u8Vector;
501	pIntr->u8TriggerMode = pMsi->Data.n.u1TriggerMode;
502	pIntr->u8DeliveryMode = pMsi->Data.n.u3DeliveryMode;
503	}
504
505
506	#if defined(VBOX_WITH_IOMMU_AMD) \|\| defined(VBOX_WITH_IOMMU_INTEL)
507	/**
508	* Convert an RTE into an MSI message.
509	*
510	* @param u64Rte The RTE to convert.
511	* @param enmType The I/O APIC chipset type.
512	* @param pMsi Where to store the MSI message.
513	*/
514	DECLINLINE(void) ioapicGetMsiFromRte(uint64_t u64Rte, IOAPICTYPE enmType, PMSIMSG pMsi)
515	{
516	bool const fRemappable = IOAPIC_RTE_GET_INTR_FORMAT(u64Rte);
517	if (!fRemappable)
518	{
519	pMsi->Addr.n.u12Addr = VBOX_MSI_ADDR_BASE >> VBOX_MSI_ADDR_SHIFT;
520	pMsi->Addr.n.u8DestId = IOAPIC_RTE_GET_DEST(u64Rte);
521	pMsi->Addr.n.u1RedirHint = 0;
522	pMsi->Addr.n.u1DestMode = IOAPIC_RTE_GET_DEST_MODE(u64Rte);
523
524	pMsi->Data.n.u8Vector = IOAPIC_RTE_GET_VECTOR(u64Rte);
525	pMsi->Data.n.u3DeliveryMode = IOAPIC_RTE_GET_DELIVERY_MODE(u64Rte);
526	pMsi->Data.n.u1TriggerMode = IOAPIC_RTE_GET_TRIGGER_MODE(u64Rte);
527	/* pMsi->Data.n.u1Level = ??? */
528	/** @todo r=ramshankar: Level triggered MSIs don't make much sense though
529	* possible in theory? Maybe document this more explicitly... */
530	}
531	else
532	{
533	Assert(enmType == IOAPICTYPE_DMAR);
534	NOREF(enmType);
535
536	/*
537	* The spec. mentions that SHV will be 0 when delivery mode is 0 (fixed), but
538	* not what SHV will be if delivery mode is not 0. I ASSUME copying delivery
539	* mode into SHV here is what hardware actually does.
540	*
541	* See Intel VT-d spec. 5.1.5.1 "I/OxAPIC Programming".
542	*/
543	pMsi->Addr.dmar_remap.u12Addr = VBOX_MSI_ADDR_BASE >> VBOX_MSI_ADDR_SHIFT;
544	pMsi->Addr.dmar_remap.u14IntrIndexLo = IOAPIC_RTE_GET_INTR_INDEX_LO(u64Rte);
545	pMsi->Addr.dmar_remap.fIntrFormat = 1;
546	pMsi->Addr.dmar_remap.fShv = IOAPIC_RTE_GET_DELIVERY_MODE(u64Rte);
547	pMsi->Addr.dmar_remap.u1IntrIndexHi = IOAPIC_RTE_GET_INTR_INDEX_HI(u64Rte);
548
549	pMsi->Data.dmar_remap.u16SubHandle = 0;
550	}
551	}
552	#endif
553
554
555	/**
556	* Signals the next pending interrupt for the specified Redirection Table Entry
557	* (RTE).
558	*
559	* @param pDevIns The device instance.
560	* @param pThis The shared I/O APIC device state.
561	* @param pThisCC The I/O APIC device state for the current context.
562	* @param idxRte The index of the RTE (validated).
563	*
564	* @remarks It is the responsibility of the caller to verify that an interrupt is
565	* pending for the pin corresponding to the RTE before calling this
566	* function.
567	*/
568	static void ioapicSignalIntrForRte(PPDMDEVINS pDevIns, PIOAPIC pThis, PIOAPICCC pThisCC, uint8_t idxRte)
569	{
570	#ifndef IOAPIC_WITH_PDM_CRITSECT
571	Assert(PDMCritSectIsOwner(&pThis->CritSect));
572	#endif
573
574	/*
575	* Ensure the interrupt isn't masked.
576	*/
577	uint64_t const u64Rte = pThis->au64RedirTable[idxRte];
578	if (!IOAPIC_RTE_IS_MASKED(u64Rte))
579	{ /* likely */ }
580	else
581	return;
582
583	/* We cannot accept another level-triggered interrupt until remote IRR has been cleared. */
584	uint8_t const u8TriggerMode = IOAPIC_RTE_GET_TRIGGER_MODE(u64Rte);
585	if (u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_LEVEL)
586	{
587	uint8_t const u8RemoteIrr = IOAPIC_RTE_GET_REMOTE_IRR(u64Rte);
588	if (u8RemoteIrr)
589	{
590	STAM_COUNTER_INC(&pThis->StatSuppressedLevelIntr);
591	return;
592	}
593	}
594
595	XAPICINTR ApicIntr;
596	RT_ZERO(ApicIntr);
597	ApicIntr.u8Vector = IOAPIC_RTE_GET_VECTOR(u64Rte);
598	ApicIntr.u8Dest = IOAPIC_RTE_GET_DEST(u64Rte);
599	ApicIntr.u8DestMode = IOAPIC_RTE_GET_DEST_MODE(u64Rte);
600	ApicIntr.u8DeliveryMode = IOAPIC_RTE_GET_DELIVERY_MODE(u64Rte);
601	ApicIntr.u8Polarity = IOAPIC_RTE_GET_POLARITY(u64Rte);
602	ApicIntr.u8TriggerMode = u8TriggerMode;
603	//ApicIntr.u8RedirHint = 0;
604
605	/** @todo We might be able to release the IOAPIC(PDM) lock here and re-acquire it
606	* before setting the remote IRR bit below. The APIC and IOMMU should not
607	* require the caller to hold the PDM lock. */
608
609	#if defined(VBOX_WITH_IOMMU_AMD) \|\| defined(VBOX_WITH_IOMMU_INTEL)
610	/*
611	* The interrupt may need to be remapped (or discarded) if an IOMMU is present.
612	* For line-based interrupts we must use the southbridge I/O APIC's BDF as
613	* the origin of the interrupt, see @bugref{9654#c74}.
614	*/
615	MSIMSG MsiIn;
616	RT_ZERO(MsiIn);
617	ioapicGetMsiFromRte(u64Rte, pThis->enmType, &MsiIn);
618
619	MSIMSG MsiOut;
620	int const rcRemap = pThisCC->pIoApicHlp->pfnIommuMsiRemap(pDevIns, VBOX_PCI_BDF_SB_IOAPIC, &MsiIn, &MsiOut);
621	if ( rcRemap == VERR_IOMMU_NOT_PRESENT
622	\|\| rcRemap == VERR_IOMMU_CANNOT_CALL_SELF)
623	{ /* likely - assuming majority of VMs don't have IOMMU configured. */ }
624	else if (RT_SUCCESS(rcRemap))
625	{
626	/* Update the APIC interrupt with the remapped data. */
627	ioapicGetApicIntrFromMsi(&MsiOut, &ApicIntr);
628
629	/* Ensure polarity hasn't changed (trigger mode might change with Intel IOMMUs). */
630	Assert(ApicIntr.u8Polarity == IOAPIC_RTE_GET_POLARITY(u64Rte));
631	STAM_COUNTER_INC(&pThis->StatIommuRemappedIntr);
632	}
633	else
634	{
635	STAM_COUNTER_INC(&pThis->StatIommuDiscardedIntr);
636	return;
637	}
638	#endif
639
640	uint32_t const u32TagSrc = pThis->au32TagSrc[idxRte];
641	Log2(("IOAPIC: Signaling %s-triggered interrupt. Dest=%#x DestMode=%s Vector=%#x (%u)\n",
642	ApicIntr.u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_EDGE ? "edge" : "level", ApicIntr.u8Dest,
643	ApicIntr.u8DestMode == IOAPIC_RTE_DEST_MODE_PHYSICAL ? "physical" : "logical",
644	ApicIntr.u8Vector, ApicIntr.u8Vector));
645
646	/*
647	* Deliver to the local APIC via the system/3-wire-APIC bus.
648	*/
649	int rc = pThisCC->pIoApicHlp->pfnApicBusDeliver(pDevIns,
650	ApicIntr.u8Dest,
651	ApicIntr.u8DestMode,
652	ApicIntr.u8DeliveryMode,
653	ApicIntr.u8Vector,
654	ApicIntr.u8Polarity,
655	ApicIntr.u8TriggerMode,
656	u32TagSrc);
657	/* Can't reschedule to R3. */
658	Assert(rc == VINF_SUCCESS \|\| rc == VERR_APIC_INTR_DISCARDED);
659	#ifdef DEBUG_ramshankar
660	if (rc == VERR_APIC_INTR_DISCARDED)
661	AssertMsgFailed(("APIC: Interrupt discarded u8Vector=%#x (%u) u64Rte=%#RX64\n", u8Vector, u8Vector, u64Rte));
662	#endif
663
664	/*
665	* For level-triggered interrupts, we set the remote IRR bit to indicate
666	* the local APIC has accepted the interrupt.
667	*
668	* For edge-triggered interrupts, we should not clear the IRR bit as it
669	* should remain intact to reflect the state of the interrupt line.
670	* The device will explicitly transition to inactive state via the
671	* ioapicSetIrq() callback.
672	*/
673	if ( u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_LEVEL
674	&& rc == VINF_SUCCESS)
675	{
676	Assert(u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_LEVEL);
677	pThis->au64RedirTable[idxRte] \|= IOAPIC_RTE_REMOTE_IRR;
678	STAM_COUNTER_INC(&pThis->StatLevelIrqSent);
679	}
680	}
681
682
683	/**
684	* Gets the redirection table entry.
685	*
686	* @returns The redirection table entry.
687	* @param pThis The shared I/O APIC device state.
688	* @param uIndex The index value.
689	*/
690	DECLINLINE(uint32_t) ioapicGetRedirTableEntry(PCIOAPIC pThis, uint32_t uIndex)
691	{
692	uint8_t const idxRte = (uIndex - IOAPIC_INDIRECT_INDEX_REDIR_TBL_START) >> 1;
693	AssertMsgReturn(idxRte < RT_ELEMENTS(pThis->au64RedirTable),
694	("Invalid index %u, expected < %u\n", idxRte, RT_ELEMENTS(pThis->au64RedirTable)),
695	UINT32_MAX);
696	uint32_t uValue;
697	if (!(uIndex & 1))
698	uValue = RT_LO_U32(pThis->au64RedirTable[idxRte]) & RT_LO_U32(pThis->u64RteReadMask);
699	else
700	uValue = RT_HI_U32(pThis->au64RedirTable[idxRte]) & RT_HI_U32(pThis->u64RteReadMask);
701
702	LogFlow(("IOAPIC: ioapicGetRedirTableEntry: uIndex=%#RX32 idxRte=%u returns %#RX32\n", uIndex, idxRte, uValue));
703	return uValue;
704	}
705
706
707	/**
708	* Sets the redirection table entry.
709	*
710	* @returns Strict VBox status code (VINF_IOM_R3_MMIO_WRITE / VINF_SUCCESS).
711	* @param pDevIns The device instance.
712	* @param pThis The shared I/O APIC device state.
713	* @param pThisCC The I/O APIC device state for the current context.
714	* @param uIndex The index value.
715	* @param uValue The value to set.
716	*/
717	static VBOXSTRICTRC ioapicSetRedirTableEntry(PPDMDEVINS pDevIns, PIOAPIC pThis, PIOAPICCC pThisCC,
718	uint32_t uIndex, uint32_t uValue)
719	{
720	uint8_t const idxRte = (uIndex - IOAPIC_INDIRECT_INDEX_REDIR_TBL_START) >> 1;
721	AssertMsgReturn(idxRte < RT_ELEMENTS(pThis->au64RedirTable),
722	("Invalid index %u, expected < %u\n", idxRte, RT_ELEMENTS(pThis->au64RedirTable)),
723	VINF_SUCCESS);
724
725	VBOXSTRICTRC rc = IOAPIC_LOCK(pDevIns, pThis, pThisCC, VINF_IOM_R3_MMIO_WRITE);
726	if (rc == VINF_SUCCESS)
727	{
728	/*
729	* Write the low or high 32-bit value into the specified 64-bit RTE register,
730	* update only the valid, writable bits.
731	*
732	* We need to preserve the read-only bits as it can have dire consequences
733	* otherwise, see @bugref{8386#c24}.
734	*/
735	uint64_t const u64Rte = pThis->au64RedirTable[idxRte];
736	if (!(uIndex & 1))
737	{
738	uint32_t const u32RtePreserveLo = RT_LO_U32(u64Rte) & ~RT_LO_U32(pThis->u64RteWriteMask);
739	uint32_t const u32RteNewLo = (uValue & RT_LO_U32(pThis->u64RteWriteMask)) \| u32RtePreserveLo;
740	uint64_t const u64RteHi = u64Rte & UINT64_C(0xffffffff00000000);
741	pThis->au64RedirTable[idxRte] = u64RteHi \| u32RteNewLo;
742	}
743	else
744	{
745	uint32_t const u32RtePreserveHi = RT_HI_U32(u64Rte) & ~RT_HI_U32(pThis->u64RteWriteMask);
746	uint32_t const u32RteLo = RT_LO_U32(u64Rte);
747	uint64_t const u64RteNewHi = ((uint64_t)((uValue & RT_HI_U32(pThis->u64RteWriteMask)) \| u32RtePreserveHi) << 32);
748	pThis->au64RedirTable[idxRte] = u64RteNewHi \| u32RteLo;
749	}
750
751	LogFlow(("IOAPIC: ioapicSetRedirTableEntry: uIndex=%#RX32 idxRte=%u uValue=%#RX32\n", uIndex, idxRte, uValue));
752
753	/*
754	* Signal the next pending interrupt for this RTE.
755	*/
756	uint32_t const uPinMask = UINT32_C(1) << idxRte;
757	if (pThis->uIrr & uPinMask)
758	{
759	LogFlow(("IOAPIC: ioapicSetRedirTableEntry: Signalling pending interrupt. idxRte=%u\n", idxRte));
760	ioapicSignalIntrForRte(pDevIns, pThis, pThisCC, idxRte);
761	}
762
763	IOAPIC_UNLOCK(pDevIns, pThis, pThisCC);
764	}
765	else
766	STAM_COUNTER_INC(&pThis->StatSetRteContention);
767
768	return rc;
769	}
770
771
772	/**
773	* Gets the data register.
774	*
775	* @returns The data value.
776	* @param pThis The shared I/O APIC device state.
777	*/
778	static uint32_t ioapicGetData(PCIOAPIC pThis)
779	{
780	uint8_t const uIndex = pThis->u8Index;
781	RT_UNTRUSTED_NONVOLATILE_COPY_FENCE();
782	if ( uIndex >= IOAPIC_INDIRECT_INDEX_REDIR_TBL_START
783	&& uIndex <= pThis->u8LastRteRegIdx)
784	return ioapicGetRedirTableEntry(pThis, uIndex);
785
786	uint32_t uValue;
787	switch (uIndex)
788	{
789	case IOAPIC_INDIRECT_INDEX_ID:
790	uValue = ioapicGetId(pThis);
791	break;
792
793	case IOAPIC_INDIRECT_INDEX_VERSION:
794	uValue = ioapicGetVersion(pThis);
795	break;
796
797	case IOAPIC_INDIRECT_INDEX_ARB:
798	if (pThis->u8ApicVer == IOAPIC_VERSION_82093AA)
799	{
800	uValue = ioapicGetArb();
801	break;
802	}
803	RT_FALL_THRU();
804
805	default:
806	uValue = UINT32_C(0xffffffff);
807	Log2(("IOAPIC: Attempt to read register at invalid index %#x\n", uIndex));
808	break;
809	}
810	return uValue;
811	}
812
813
814	/**
815	* Sets the data register.
816	*
817	* @returns Strict VBox status code.
818	* @param pDevIns The device instance.
819	* @param pThis The shared I/O APIC device state.
820	* @param pThisCC The I/O APIC device state for the current context.
821	* @param uValue The value to set.
822	*/
823	static VBOXSTRICTRC ioapicSetData(PPDMDEVINS pDevIns, PIOAPIC pThis, PIOAPICCC pThisCC, uint32_t uValue)
824	{
825	uint8_t const uIndex = pThis->u8Index;
826	RT_UNTRUSTED_NONVOLATILE_COPY_FENCE();
827	LogFlow(("IOAPIC: ioapicSetData: uIndex=%#x uValue=%#RX32\n", uIndex, uValue));
828
829	if ( uIndex >= IOAPIC_INDIRECT_INDEX_REDIR_TBL_START
830	&& uIndex <= pThis->u8LastRteRegIdx)
831	return ioapicSetRedirTableEntry(pDevIns, pThis, pThisCC, uIndex, uValue);
832
833	if (uIndex == IOAPIC_INDIRECT_INDEX_ID)
834	ioapicSetId(pThis, uValue);
835	else
836	Log2(("IOAPIC: ioapicSetData: Invalid index %#RX32, ignoring write request with uValue=%#RX32\n", uIndex, uValue));
837
838	return VINF_SUCCESS;
839	}
840
841
842	/**
843	* @interface_method_impl{PDMIOAPICREG,pfnSetEoi}
844	*/
845	static DECLCALLBACK(VBOXSTRICTRC) ioapicSetEoi(PPDMDEVINS pDevIns, uint8_t u8Vector)
846	{
847	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
848	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
849	STAM_COUNTER_INC(&pThis->CTX_SUFF_Z(StatSetEoi));
850	LogFlow(("IOAPIC: ioapicSetEoi: u8Vector=%#x (%u)\n", u8Vector, u8Vector));
851
852	bool fRemoteIrrCleared = false;
853	VBOXSTRICTRC rc = IOAPIC_LOCK(pDevIns, pThis, pThisCC, VINF_IOM_R3_MMIO_WRITE);
854	if (rc == VINF_SUCCESS)
855	{
856	for (uint8_t idxRte = 0; idxRte < RT_ELEMENTS(pThis->au64RedirTable); idxRte++)
857	{
858	uint64_t const u64Rte = pThis->au64RedirTable[idxRte];
859	if (IOAPIC_RTE_GET_VECTOR(u64Rte) == u8Vector)
860	{
861	#ifdef DEBUG_ramshankar
862	/* This assertion may trigger when restoring saved-states created using the old, incorrect I/O APIC code. */
863	Assert(IOAPIC_RTE_GET_REMOTE_IRR(u64Rte));
864	#endif
865	pThis->au64RedirTable[idxRte] &= ~IOAPIC_RTE_REMOTE_IRR;
866	fRemoteIrrCleared = true;
867	STAM_COUNTER_INC(&pThis->StatEoiReceived);
868	Log2(("IOAPIC: ioapicSetEoi: Cleared remote IRR, idxRte=%u vector=%#x (%u)\n", idxRte, u8Vector, u8Vector));
869
870	/*
871	* Signal the next pending interrupt for this RTE.
872	*/
873	uint32_t const uPinMask = UINT32_C(1) << idxRte;
874	if (pThis->uIrr & uPinMask)
875	ioapicSignalIntrForRte(pDevIns, pThis, pThisCC, idxRte);
876	}
877	}
878
879	IOAPIC_UNLOCK(pDevIns, pThis, pThisCC);
880	#ifndef VBOX_WITH_IOMMU_AMD
881	AssertMsg(fRemoteIrrCleared, ("Failed to clear remote IRR for vector %#x (%u)\n", u8Vector, u8Vector));
882	#endif
883	}
884	else
885	STAM_COUNTER_INC(&pThis->StatEoiContention);
886
887	return rc;
888	}
889
890
891	/**
892	* @interface_method_impl{PDMIOAPICREG,pfnSetIrq}
893	*/
894	static DECLCALLBACK(void) ioapicSetIrq(PPDMDEVINS pDevIns, PCIBDF uBusDevFn, int iIrq, int iLevel, uint32_t uTagSrc)
895	{
896	RT_NOREF(uBusDevFn); /** @todo r=ramshankar: Remove this argument if it's also unnecessary with Intel IOMMU. */
897	#define IOAPIC_ASSERT_IRQ(a_uBusDevFn, a_idxRte, a_PinMask) do { \
898	pThis->au32TagSrc[(a_idxRte)] = !pThis->au32TagSrc[(a_idxRte)] ? uTagSrc : RT_BIT_32(31); \
899	pThis->uIrr \|= a_PinMask; \
900	ioapicSignalIntrForRte(pDevIns, pThis, pThisCC, (a_idxRte)); \
901	} while (0)
902
903	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
904	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
905	LogFlow(("IOAPIC: ioapicSetIrq: iIrq=%d iLevel=%d uTagSrc=%#x\n", iIrq, iLevel, uTagSrc));
906
907	STAM_COUNTER_INC(&pThis->CTX_SUFF_Z(StatSetIrq));
908
909	if (RT_LIKELY((unsigned)iIrq < RT_ELEMENTS(pThis->au64RedirTable)))
910	{
911	int rc = IOAPIC_LOCK(pDevIns, pThis, pThisCC, VINF_SUCCESS);
912	AssertRC(rc);
913
914	uint8_t const idxRte = iIrq;
915	uint32_t const uPinMask = UINT32_C(1) << idxRte;
916	uint32_t const u32RteLo = RT_LO_U32(pThis->au64RedirTable[idxRte]);
917	uint8_t const u8TriggerMode = IOAPIC_RTE_GET_TRIGGER_MODE(u32RteLo);
918
919	bool fActive = RT_BOOL(iLevel & 1);
920	/** @todo Polarity is busted elsewhere, we need to fix that
921	* first. See @bugref{8386#c7}. */
922	#if 0
923	uint8_t const u8Polarity = IOAPIC_RTE_GET_POLARITY(u32RteLo);
924	fActive ^= u8Polarity; */
925	#endif
926	if (!fActive)
927	{
928	pThis->uIrr &= ~uPinMask;
929	IOAPIC_UNLOCK(pDevIns, pThis, pThisCC);
930	return;
931	}
932
933	bool const fFlipFlop = ((iLevel & PDM_IRQ_LEVEL_FLIP_FLOP) == PDM_IRQ_LEVEL_FLIP_FLOP);
934	uint32_t const uPrevIrr = pThis->uIrr & uPinMask;
935	if (!fFlipFlop)
936	{
937	if (u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_EDGE)
938	{
939	/*
940	* For edge-triggered interrupts, we need to act only on a low to high edge transition.
941	* See ICH9 spec. 13.5.7 "REDIR_TBL: Redirection Table (LPC I/F-D31:F0)".
942	*/
943	if (!uPrevIrr)
944	IOAPIC_ASSERT_IRQ(uBusDevFn, idxRte, uPinMask);
945	else
946	{
947	STAM_COUNTER_INC(&pThis->StatRedundantEdgeIntr);
948	Log2(("IOAPIC: Redundant edge-triggered interrupt %#x (%u)\n", idxRte, idxRte));
949	}
950	}
951	else
952	{
953	Assert(u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_LEVEL);
954
955	/*
956	* For level-triggered interrupts, redundant interrupts are not a problem
957	* and will eventually be delivered anyway after an EOI, but our PDM devices
958	* should not typically call us with no change to the level.
959	*/
960	if (!uPrevIrr)
961	{ /* likely */ }
962	else
963	{
964	STAM_COUNTER_INC(&pThis->StatRedundantLevelIntr);
965	Log2(("IOAPIC: Redundant level-triggered interrupt %#x (%u)\n", idxRte, idxRte));
966	}
967
968	IOAPIC_ASSERT_IRQ(uBusDevFn, idxRte, uPinMask);
969	}
970	}
971	else
972	{
973	/*
974	* The device is flip-flopping the interrupt line, which implies we should de-assert
975	* and assert the interrupt line. The interrupt line is left in the asserted state
976	* after a flip-flop request. The de-assert is a NOP wrts to signaling an interrupt
977	* hence just the assert is done.
978	*/
979	IOAPIC_ASSERT_IRQ(uBusDevFn, idxRte, uPinMask);
980	}
981
982	IOAPIC_UNLOCK(pDevIns, pThis, pThisCC);
983	}
984	#undef IOAPIC_ASSERT_IRQ
985	}
986
987
988	/**
989	* @interface_method_impl{PDMIOAPICREG,pfnSendMsi}
990	*/
991	static DECLCALLBACK(void) ioapicSendMsi(PPDMDEVINS pDevIns, PCIBDF uBusDevFn, PCMSIMSG pMsi, uint32_t uTagSrc)
992	{
993	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
994	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
995	LogFlow(("IOAPIC: ioapicSendMsi: uBusDevFn=%#x Addr=%#RX64 Data=%#RX32\n", uBusDevFn, pMsi->Addr.u64, pMsi->Data.u32));
996
997	XAPICINTR ApicIntr;
998	RT_ZERO(ApicIntr);
999
1000	#if defined(VBOX_WITH_IOMMU_AMD) \|\| defined(VBOX_WITH_IOMMU_INTEL)
1001	/*
1002	* The MSI may need to be remapped (or discarded) if an IOMMU is present.
1003	*
1004	* If the Bus:Dev:Fn isn't valid, it is ASSUMED the device generating the
1005	* MSI is the IOMMU itself and hence isn't subjected to remapping. This
1006	* is the case with Intel IOMMUs.
1007	*
1008	* AMD IOMMUs are full fledged PCI devices, hence the BDF will be a
1009	* valid PCI slot, but interrupts generated by the IOMMU will be handled
1010	* by VERR_IOMMU_CANNOT_CALL_SELF case.
1011	*/
1012	if (PCIBDF_IS_VALID(uBusDevFn))
1013	{
1014	MSIMSG MsiOut;
1015	int const rcRemap = pThisCC->pIoApicHlp->pfnIommuMsiRemap(pDevIns, uBusDevFn, pMsi, &MsiOut);
1016	if ( rcRemap == VERR_IOMMU_NOT_PRESENT
1017	\|\| rcRemap == VERR_IOMMU_CANNOT_CALL_SELF)
1018	{ /* likely - assuming majority of VMs don't have IOMMU configured. */ }
1019	else if (RT_SUCCESS(rcRemap))
1020	{
1021	STAM_COUNTER_INC(&pThis->StatIommuRemappedMsi);
1022	pMsi = &MsiOut;
1023	}
1024	else
1025	{
1026	STAM_COUNTER_INC(&pThis->StatIommuDiscardedMsi);
1027	return;
1028	}
1029	}
1030	#else
1031	NOREF(uBusDevFn);
1032	#endif
1033
1034	ioapicGetApicIntrFromMsi(pMsi, &ApicIntr);
1035
1036	/*
1037	* Deliver to the local APIC via the system/3-wire-APIC bus.
1038	*/
1039	STAM_REL_COUNTER_INC(&pThis->aStatVectors[ApicIntr.u8Vector]);
1040
1041	int rc = pThisCC->pIoApicHlp->pfnApicBusDeliver(pDevIns,
1042	ApicIntr.u8Dest,
1043	ApicIntr.u8DestMode,
1044	ApicIntr.u8DeliveryMode,
1045	ApicIntr.u8Vector,
1046	0 /* u8Polarity - N/A */,
1047	ApicIntr.u8TriggerMode,
1048	uTagSrc);
1049	/* Can't reschedule to R3. */
1050	Assert(rc == VINF_SUCCESS \|\| rc == VERR_APIC_INTR_DISCARDED); NOREF(rc);
1051	}
1052
1053
1054	/**
1055	* @callback_method_impl{FNIOMMMIONEWREAD}
1056	*/
1057	static DECLCALLBACK(VBOXSTRICTRC) ioapicMmioRead(PPDMDEVINS pDevIns, void pvUser, RTGCPHYS off, void pv, unsigned cb)
1058	{
1059	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1060	STAM_COUNTER_INC(&pThis->CTX_SUFF_Z(StatMmioRead));
1061	Assert(cb == 4); RT_NOREF_PV(cb); /* registered for dwords only */
1062	RT_NOREF_PV(pvUser);
1063
1064	VBOXSTRICTRC rc = VINF_SUCCESS;
1065	uint32_t puValue = (uint32_t )pv;
1066	uint32_t offReg = off & IOAPIC_MMIO_REG_MASK;
1067	switch (offReg)
1068	{
1069	case IOAPIC_DIRECT_OFF_INDEX:
1070	*puValue = ioapicGetIndex(pThis);
1071	break;
1072
1073	case IOAPIC_DIRECT_OFF_DATA:
1074	*puValue = ioapicGetData(pThis);
1075	break;
1076
1077	default:
1078	Log2(("IOAPIC: ioapicMmioRead: Invalid offset. off=%#RGp offReg=%#x\n", off, offReg));
1079	rc = VINF_IOM_MMIO_UNUSED_FF;
1080	break;
1081	}
1082
1083	LogFlow(("IOAPIC: ioapicMmioRead: offReg=%#x, returns %#RX32\n", offReg, *puValue));
1084	return rc;
1085	}
1086
1087
1088	/**
1089	* @callback_method_impl{FNIOMMMIONEWWRITE}
1090	*/
1091	static DECLCALLBACK(VBOXSTRICTRC) ioapicMmioWrite(PPDMDEVINS pDevIns, void pvUser, RTGCPHYS off, void const pv, unsigned cb)
1092	{
1093	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1094	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
1095	RT_NOREF_PV(pvUser);
1096
1097	STAM_COUNTER_INC(&pThis->CTX_SUFF_Z(StatMmioWrite));
1098
1099	Assert(!(off & 3));
1100	Assert(cb == 4); RT_NOREF_PV(cb); /* registered for dwords only */
1101
1102	VBOXSTRICTRC rc = VINF_SUCCESS;
1103	uint32_t const uValue = (uint32_t const )pv;
1104	uint32_t const offReg = off & IOAPIC_MMIO_REG_MASK;
1105
1106	LogFlow(("IOAPIC: ioapicMmioWrite: pThis=%p off=%#RGp cb=%u uValue=%#RX32\n", pThis, off, cb, uValue));
1107	switch (offReg)
1108	{
1109	case IOAPIC_DIRECT_OFF_INDEX:
1110	ioapicSetIndex(pThis, uValue);
1111	break;
1112
1113	case IOAPIC_DIRECT_OFF_DATA:
1114	rc = ioapicSetData(pDevIns, pThis, pThisCC, uValue);
1115	break;
1116
1117	case IOAPIC_DIRECT_OFF_EOI:
1118	if (pThis->u8ApicVer == IOAPIC_VERSION_ICH9)
1119	rc = ioapicSetEoi(pDevIns, uValue);
1120	else
1121	Log(("IOAPIC: ioapicMmioWrite: Write to EOI register ignored!\n"));
1122	break;
1123
1124	default:
1125	Log2(("IOAPIC: ioapicMmioWrite: Invalid offset. off=%#RGp offReg=%#x\n", off, offReg));
1126	break;
1127	}
1128
1129	return rc;
1130	}
1131
1132
1133	#ifdef IN_RING3
1134
1135	/** @interface_method_impl{DBGFREGDESC,pfnGet} */
1136	static DECLCALLBACK(int) ioapicR3DbgReg_GetIndex(void *pvUser, PCDBGFREGDESC pDesc, PDBGFREGVAL pValue)
1137	{
1138	RT_NOREF(pDesc);
1139	pValue->u32 = ioapicGetIndex(PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PCIOAPIC));
1140	return VINF_SUCCESS;
1141	}
1142
1143
1144	/** @interface_method_impl{DBGFREGDESC,pfnSet} */
1145	static DECLCALLBACK(int) ioapicR3DbgReg_SetIndex(void *pvUser, PCDBGFREGDESC pDesc, PCDBGFREGVAL pValue, PCDBGFREGVAL pfMask)
1146	{
1147	RT_NOREF(pDesc, pfMask);
1148	ioapicSetIndex(PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PIOAPIC), pValue->u8);
1149	return VINF_SUCCESS;
1150	}
1151
1152
1153	/** @interface_method_impl{DBGFREGDESC,pfnGet} */
1154	static DECLCALLBACK(int) ioapicR3DbgReg_GetData(void *pvUser, PCDBGFREGDESC pDesc, PDBGFREGVAL pValue)
1155	{
1156	RT_NOREF(pDesc);
1157	pValue->u32 = ioapicGetData((PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PCIOAPIC)));
1158	return VINF_SUCCESS;
1159	}
1160
1161
1162	/** @interface_method_impl{DBGFREGDESC,pfnSet} */
1163	static DECLCALLBACK(int) ioapicR3DbgReg_SetData(void *pvUser, PCDBGFREGDESC pDesc, PCDBGFREGVAL pValue, PCDBGFREGVAL pfMask)
1164	{
1165	PPDMDEVINS pDevIns = (PPDMDEVINS)pvUser;
1166	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1167	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
1168	RT_NOREF(pDesc, pfMask);
1169	return VBOXSTRICTRC_VAL(ioapicSetData(pDevIns, pThis, pThisCC, pValue->u32));
1170	}
1171
1172
1173	/** @interface_method_impl{DBGFREGDESC,pfnGet} */
1174	static DECLCALLBACK(int) ioapicR3DbgReg_GetVersion(void *pvUser, PCDBGFREGDESC pDesc, PDBGFREGVAL pValue)
1175	{
1176	PCIOAPIC pThis = PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PCIOAPIC);
1177	RT_NOREF(pDesc);
1178	pValue->u32 = ioapicGetVersion(pThis);
1179	return VINF_SUCCESS;
1180	}
1181
1182
1183	/** @interface_method_impl{DBGFREGDESC,pfnGet} */
1184	static DECLCALLBACK(int) ioapicR3DbgReg_GetArb(void *pvUser, PCDBGFREGDESC pDesc, PDBGFREGVAL pValue)
1185	{
1186	RT_NOREF(pvUser, pDesc);
1187	pValue->u32 = ioapicGetArb();
1188	return VINF_SUCCESS;
1189	}
1190
1191
1192	/** @interface_method_impl{DBGFREGDESC,pfnGet} */
1193	static DECLCALLBACK(int) ioapicR3DbgReg_GetRte(void *pvUser, PCDBGFREGDESC pDesc, PDBGFREGVAL pValue)
1194	{
1195	PCIOAPIC pThis = PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PCIOAPIC);
1196	Assert(pDesc->offRegister < RT_ELEMENTS(pThis->au64RedirTable));
1197	pValue->u64 = pThis->au64RedirTable[pDesc->offRegister];
1198	return VINF_SUCCESS;
1199	}
1200
1201
1202	/** @interface_method_impl{DBGFREGDESC,pfnSet} */
1203	static DECLCALLBACK(int) ioapicR3DbgReg_SetRte(void *pvUser, PCDBGFREGDESC pDesc, PCDBGFREGVAL pValue, PCDBGFREGVAL pfMask)
1204	{
1205	RT_NOREF(pfMask);
1206	PIOAPIC pThis = PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PIOAPIC);
1207	/* No locks, no checks, just do it. */
1208	Assert(pDesc->offRegister < RT_ELEMENTS(pThis->au64RedirTable));
1209	pThis->au64RedirTable[pDesc->offRegister] = pValue->u64;
1210	return VINF_SUCCESS;
1211	}
1212
1213
1214	/** IOREDTBLn sub fields. */
1215	static DBGFREGSUBFIELD const g_aRteSubs[] =
1216	{
1217	{ "vector", 0, 8, 0, 0, NULL, NULL },
1218	{ "dlvr_mode", 8, 3, 0, 0, NULL, NULL },
1219	{ "dest_mode", 11, 1, 0, 0, NULL, NULL },
1220	{ "dlvr_status", 12, 1, 0, DBGFREGSUBFIELD_FLAGS_READ_ONLY, NULL, NULL },
1221	{ "polarity", 13, 1, 0, 0, NULL, NULL },
1222	{ "remote_irr", 14, 1, 0, DBGFREGSUBFIELD_FLAGS_READ_ONLY, NULL, NULL },
1223	{ "trigger_mode", 15, 1, 0, 0, NULL, NULL },
1224	{ "mask", 16, 1, 0, 0, NULL, NULL },
1225	{ "ext_dest_id", 48, 8, 0, DBGFREGSUBFIELD_FLAGS_READ_ONLY, NULL, NULL },
1226	{ "dest", 56, 8, 0, 0, NULL, NULL },
1227	DBGFREGSUBFIELD_TERMINATOR()
1228	};
1229
1230
1231	/** Register descriptors for DBGF. */
1232	static DBGFREGDESC const g_aRegDesc[] =
1233	{
1234	{ "index", DBGFREG_END, DBGFREGVALTYPE_U8, 0, 0, ioapicR3DbgReg_GetIndex, ioapicR3DbgReg_SetIndex, NULL, NULL },
1235	{ "data", DBGFREG_END, DBGFREGVALTYPE_U32, 0, 0, ioapicR3DbgReg_GetData, ioapicR3DbgReg_SetData, NULL, NULL },
1236	{ "version", DBGFREG_END, DBGFREGVALTYPE_U32, DBGFREG_FLAGS_READ_ONLY, 0, ioapicR3DbgReg_GetVersion, NULL, NULL, NULL },
1237	{ "arb", DBGFREG_END, DBGFREGVALTYPE_U32, DBGFREG_FLAGS_READ_ONLY, 0, ioapicR3DbgReg_GetArb, NULL, NULL, NULL },
1238	{ "rte0", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 0, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1239	{ "rte1", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 1, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1240	{ "rte2", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 2, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1241	{ "rte3", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 3, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1242	{ "rte4", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 4, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1243	{ "rte5", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 5, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1244	{ "rte6", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 6, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1245	{ "rte7", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 7, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1246	{ "rte8", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 8, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1247	{ "rte9", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 9, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1248	{ "rte10", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 10, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1249	{ "rte11", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 11, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1250	{ "rte12", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 12, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1251	{ "rte13", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 13, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1252	{ "rte14", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 14, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1253	{ "rte15", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 15, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1254	{ "rte16", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 16, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1255	{ "rte17", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 17, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1256	{ "rte18", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 18, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1257	{ "rte19", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 19, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1258	{ "rte20", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 20, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1259	{ "rte21", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 21, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1260	{ "rte22", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 22, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1261	{ "rte23", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 23, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1262	DBGFREGDESC_TERMINATOR()
1263	};
1264
1265
1266	/**
1267	* @callback_method_impl{FNDBGFHANDLERDEV}
1268	*/
1269	static DECLCALLBACK(void) ioapicR3DbgInfo(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
1270	{
1271	RT_NOREF(pszArgs);
1272	PCIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1273	LogFlow(("IOAPIC: ioapicR3DbgInfo: pThis=%p pszArgs=%s\n", pThis, pszArgs));
1274
1275	bool const fLegacy = RTStrCmp(pszArgs, "legacy") == 0;
1276
1277	static const char * const s_apszDeliveryModes[] =
1278	{
1279	" fixed",
1280	"lowpri",
1281	" smi",
1282	" rsvd",
1283	" nmi",
1284	" init",
1285	" rsvd",
1286	"extint"
1287	};
1288	static const char * const s_apszDestMode[] = { "phys", "log " };
1289	static const char * const s_apszTrigMode[] = { " edge", "level" };
1290	static const char * const s_apszPolarity[] = { "acthi", "actlo" };
1291	static const char * const s_apszDeliveryStatus[] = { "idle", "pend" };
1292
1293	pHlp->pfnPrintf(pHlp, "I/O APIC at %#010x:\n", IOAPIC_MMIO_BASE_PHYSADDR);
1294
1295	uint32_t const uId = ioapicGetId(pThis);
1296	pHlp->pfnPrintf(pHlp, " ID = %#RX32\n", uId);
1297	pHlp->pfnPrintf(pHlp, " ID = %#x\n", IOAPIC_ID_GET_ID(uId));
1298
1299	uint32_t const uVer = ioapicGetVersion(pThis);
1300	pHlp->pfnPrintf(pHlp, " Version = %#RX32\n", uVer);
1301	pHlp->pfnPrintf(pHlp, " Version = %#x\n", IOAPIC_VER_GET_VER(uVer));
1302	pHlp->pfnPrintf(pHlp, " Pin Assert Reg. Support = %RTbool\n", IOAPIC_VER_HAS_PRQ(uVer));
1303	pHlp->pfnPrintf(pHlp, " Max. Redirection Entry = %u\n", IOAPIC_VER_GET_MRE(uVer));
1304
1305	if (pThis->u8ApicVer == IOAPIC_VERSION_82093AA)
1306	{
1307	uint32_t const uArb = ioapicGetArb();
1308	pHlp->pfnPrintf(pHlp, " Arbitration = %#RX32\n", uArb);
1309	pHlp->pfnPrintf(pHlp, " Arbitration ID = %#x\n", IOAPIC_ARB_GET_ID(uArb));
1310	}
1311
1312	pHlp->pfnPrintf(pHlp, " Current index = %#x\n", ioapicGetIndex(pThis));
1313
1314	pHlp->pfnPrintf(pHlp, " I/O Redirection Table and IRR:\n");
1315	if ( pThis->enmType != IOAPICTYPE_DMAR
1316	\|\| fLegacy)
1317	{
1318	pHlp->pfnPrintf(pHlp, " idx dst_mode dst_addr mask irr trigger rirr polar dlvr_st dlvr_mode vector rte\n");
1319	pHlp->pfnPrintf(pHlp, " ---------------------------------------------------------------------------------------------\n");
1320
1321	uint8_t const idxMaxRte = RT_MIN(pThis->u8MaxRte, RT_ELEMENTS(pThis->au64RedirTable) - 1);
1322	for (uint8_t idxRte = 0; idxRte <= idxMaxRte; idxRte++)
1323	{
1324	const uint64_t u64Rte = pThis->au64RedirTable[idxRte];
1325	const char *pszDestMode = s_apszDestMode[IOAPIC_RTE_GET_DEST_MODE(u64Rte)];
1326	const uint8_t uDest = IOAPIC_RTE_GET_DEST(u64Rte);
1327	const uint8_t uMask = IOAPIC_RTE_GET_MASK(u64Rte);
1328	const char *pszTriggerMode = s_apszTrigMode[IOAPIC_RTE_GET_TRIGGER_MODE(u64Rte)];
1329	const uint8_t uRemoteIrr = IOAPIC_RTE_GET_REMOTE_IRR(u64Rte);
1330	const char *pszPolarity = s_apszPolarity[IOAPIC_RTE_GET_POLARITY(u64Rte)];
1331	const char *pszDeliveryStatus = s_apszDeliveryStatus[IOAPIC_RTE_GET_DELIVERY_STATUS(u64Rte)];
1332	const uint8_t uDeliveryMode = IOAPIC_RTE_GET_DELIVERY_MODE(u64Rte);
1333	Assert(uDeliveryMode < RT_ELEMENTS(s_apszDeliveryModes));
1334	const char *pszDeliveryMode = s_apszDeliveryModes[uDeliveryMode];
1335	const uint8_t uVector = IOAPIC_RTE_GET_VECTOR(u64Rte);
1336
1337	pHlp->pfnPrintf(pHlp, " %02d %s %02x %u %u %s %u %s %s %s %3u (%016llx)\n",
1338	idxRte,
1339	pszDestMode,
1340	uDest,
1341	uMask,
1342	(pThis->uIrr >> idxRte) & 1,
1343	pszTriggerMode,
1344	uRemoteIrr,
1345	pszPolarity,
1346	pszDeliveryStatus,
1347	pszDeliveryMode,
1348	uVector,
1349	u64Rte);
1350	}
1351	}
1352	else
1353	{
1354	pHlp->pfnPrintf(pHlp, " idx intr_idx fmt mask irr trigger rirr polar dlvr_st dlvr_mode vector rte\n");
1355	pHlp->pfnPrintf(pHlp, " ----------------------------------------------------------------------------------------\n");
1356
1357	uint8_t const idxMaxRte = RT_MIN(pThis->u8MaxRte, RT_ELEMENTS(pThis->au64RedirTable) - 1);
1358	for (uint8_t idxRte = 0; idxRte <= idxMaxRte; idxRte++)
1359	{
1360	const uint64_t u64Rte = pThis->au64RedirTable[idxRte];
1361	const uint16_t idxIntrLo = IOAPIC_RTE_GET_INTR_INDEX_LO(u64Rte);
1362	const uint8_t fIntrFormat = IOAPIC_RTE_GET_INTR_FORMAT(u64Rte);
1363	const uint8_t uMask = IOAPIC_RTE_GET_MASK(u64Rte);
1364	const char *pszTriggerMode = s_apszTrigMode[IOAPIC_RTE_GET_TRIGGER_MODE(u64Rte)];
1365	const uint8_t uRemoteIrr = IOAPIC_RTE_GET_REMOTE_IRR(u64Rte);
1366	const char *pszPolarity = s_apszPolarity[IOAPIC_RTE_GET_POLARITY(u64Rte)];
1367	const char *pszDeliveryStatus = s_apszDeliveryStatus[IOAPIC_RTE_GET_DELIVERY_STATUS(u64Rte)];
1368	const uint8_t uDeliveryMode = IOAPIC_RTE_GET_DELIVERY_MODE(u64Rte);
1369	Assert(uDeliveryMode < RT_ELEMENTS(s_apszDeliveryModes));
1370	const char *pszDeliveryMode = s_apszDeliveryModes[uDeliveryMode];
1371	const uint16_t idxIntrHi = IOAPIC_RTE_GET_INTR_INDEX_HI(u64Rte);
1372	const uint8_t uVector = IOAPIC_RTE_GET_VECTOR(u64Rte);
1373	const uint16_t idxIntr = idxIntrLo \| (idxIntrHi << 15);
1374	pHlp->pfnPrintf(pHlp, " %02d %4u %u %u %u %s %u %s %s %s %3u (%016llx)\n",
1375	idxRte,
1376	idxIntr,
1377	fIntrFormat,
1378	uMask,
1379	(pThis->uIrr >> idxRte) & 1,
1380	pszTriggerMode,
1381	uRemoteIrr,
1382	pszPolarity,
1383	pszDeliveryStatus,
1384	pszDeliveryMode,
1385	uVector,
1386	u64Rte);
1387	}
1388	}
1389	}
1390
1391
1392	/**
1393	* @copydoc FNSSMDEVSAVEEXEC
1394	*/
1395	static DECLCALLBACK(int) ioapicR3SaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
1396	{
1397	PCIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PCIOAPIC);
1398	PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
1399	LogFlow(("IOAPIC: ioapicR3SaveExec\n"));
1400
1401	pHlp->pfnSSMPutU32(pSSM, pThis->uIrr);
1402	pHlp->pfnSSMPutU8(pSSM, pThis->u8Id);
1403	pHlp->pfnSSMPutU8(pSSM, pThis->u8Index);
1404	for (uint8_t idxRte = 0; idxRte < RT_ELEMENTS(pThis->au64RedirTable); idxRte++)
1405	pHlp->pfnSSMPutU64(pSSM, pThis->au64RedirTable[idxRte]);
1406
1407	return VINF_SUCCESS;
1408	}
1409
1410
1411	/**
1412	* @copydoc FNSSMDEVLOADEXEC
1413	*/
1414	static DECLCALLBACK(int) ioapicR3LoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
1415	{
1416	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1417	PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
1418	LogFlow(("APIC: apicR3LoadExec: uVersion=%u uPass=%#x\n", uVersion, uPass));
1419
1420	Assert(uPass == SSM_PASS_FINAL);
1421	NOREF(uPass);
1422
1423	/* Weed out invalid versions. */
1424	if ( uVersion != IOAPIC_SAVED_STATE_VERSION
1425	&& uVersion != IOAPIC_SAVED_STATE_VERSION_VBOX_50)
1426	{
1427	LogRel(("IOAPIC: ioapicR3LoadExec: Invalid/unrecognized saved-state version %u (%#x)\n", uVersion, uVersion));
1428	return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
1429	}
1430
1431	if (uVersion == IOAPIC_SAVED_STATE_VERSION)
1432	pHlp->pfnSSMGetU32(pSSM, &pThis->uIrr);
1433
1434	pHlp->pfnSSMGetU8V(pSSM, &pThis->u8Id);
1435	pHlp->pfnSSMGetU8V(pSSM, &pThis->u8Index);
1436	for (uint8_t idxRte = 0; idxRte < RT_ELEMENTS(pThis->au64RedirTable); idxRte++)
1437	pHlp->pfnSSMGetU64(pSSM, &pThis->au64RedirTable[idxRte]);
1438
1439	return VINF_SUCCESS;
1440	}
1441
1442
1443	/**
1444	* @interface_method_impl{PDMDEVREG,pfnReset}
1445	*/
1446	static DECLCALLBACK(void) ioapicR3Reset(PPDMDEVINS pDevIns)
1447	{
1448	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1449	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
1450	LogFlow(("IOAPIC: ioapicR3Reset: pThis=%p\n", pThis));
1451
1452	/* There might be devices threads calling ioapicSetIrq() in parallel, hence the lock. */
1453	IOAPIC_LOCK(pDevIns, pThis, pThisCC, VERR_IGNORED);
1454
1455	pThis->uIrr = 0;
1456	pThis->u8Index = 0;
1457	pThis->u8Id = 0;
1458
1459	for (uint8_t idxRte = 0; idxRte < RT_ELEMENTS(pThis->au64RedirTable); idxRte++)
1460	{
1461	pThis->au64RedirTable[idxRte] = IOAPIC_RTE_MASK;
1462	pThis->au32TagSrc[idxRte] = 0;
1463	}
1464
1465	IOAPIC_UNLOCK(pDevIns, pThis, pThisCC);
1466	}
1467
1468
1469	/**
1470	* @interface_method_impl{PDMDEVREG,pfnRelocate}
1471	*/
1472	static DECLCALLBACK(void) ioapicR3Relocate(PPDMDEVINS pDevIns, RTGCINTPTR offDelta)
1473	{
1474	PIOAPICRC pThisRC = PDMINS_2_DATA_RC(pDevIns, PIOAPICRC);
1475	LogFlow(("IOAPIC: ioapicR3Relocate: pThis=%p offDelta=%RGi\n", PDMDEVINS_2_DATA(pDevIns, PIOAPIC), offDelta));
1476
1477	pThisRC->pIoApicHlp += offDelta;
1478	}
1479
1480
1481	/**
1482	* @interface_method_impl{PDMDEVREG,pfnDestruct}
1483	*/
1484	static DECLCALLBACK(int) ioapicR3Destruct(PPDMDEVINS pDevIns)
1485	{
1486	PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
1487	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1488	LogFlow(("IOAPIC: ioapicR3Destruct: pThis=%p\n", pThis));
1489
1490	# ifndef IOAPIC_WITH_PDM_CRITSECT
1491	/*
1492	* Destroy the RTE critical section.
1493	*/
1494	if (PDMCritSectIsInitialized(&pThis->CritSect))
1495	PDMR3CritSectDelete(&pThis->CritSect);
1496	# else
1497	RT_NOREF_PV(pThis);
1498	# endif
1499
1500	return VINF_SUCCESS;
1501	}
1502
1503
1504	/**
1505	* @interface_method_impl{PDMDEVREG,pfnConstruct}
1506	*/
1507	static DECLCALLBACK(int) ioapicR3Construct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
1508	{
1509	PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
1510	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1511	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
1512	PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
1513	LogFlow(("IOAPIC: ioapicR3Construct: pThis=%p iInstance=%d\n", pThis, iInstance));
1514	Assert(iInstance == 0); RT_NOREF(iInstance);
1515
1516	/*
1517	* Validate and read the configuration.
1518	*/
1519	PDMDEV_VALIDATE_CONFIG_RETURN(pDevIns, "NumCPUs\|ChipType", "");
1520
1521	/* The number of CPUs is currently unused, but left in CFGM and saved-state in case an ID of 0
1522	upsets some guest which we haven't yet been tested. */
1523	uint32_t cCpus;
1524	int rc = pHlp->pfnCFGMQueryU32Def(pCfg, "NumCPUs", &cCpus, 1);
1525	if (RT_FAILURE(rc))
1526	return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to query integer value \"NumCPUs\""));
1527	pThis->cCpus = (uint8_t)cCpus;
1528
1529	char szChipType[16];
1530	rc = pHlp->pfnCFGMQueryStringDef(pCfg, "ChipType", &szChipType[0], sizeof(szChipType), "ICH9");
1531	if (RT_FAILURE(rc))
1532	return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to query string value \"ChipType\""));
1533
1534	if (!strcmp(szChipType, "ICH9"))
1535	{
1536	/* Newer 2007-ish I/O APIC integrated into ICH southbridges. */
1537	pThis->enmType = IOAPICTYPE_ICH9;
1538	pThis->u8ApicVer = IOAPIC_VERSION_ICH9;
1539	pThis->u8IdMask = 0xff;
1540	pThis->u8MaxRte = IOAPIC_MAX_RTE_INDEX;
1541	pThis->u8LastRteRegIdx = IOAPIC_INDIRECT_INDEX_RTE_END;
1542	pThis->u64RteWriteMask = IOAPIC_RTE_VALID_WRITE_MASK_ICH9;
1543	pThis->u64RteReadMask = IOAPIC_RTE_VALID_READ_MASK_ICH9;
1544	}
1545	else if (!strcmp(szChipType, "DMAR"))
1546	{
1547	/* Intel DMAR compatible I/O APIC integrated into ICH southbridges. */
1548	/* Identical to ICH9, but interprets RTEs and MSI address and data fields differently. */
1549	pThis->enmType = IOAPICTYPE_DMAR;
1550	pThis->u8ApicVer = IOAPIC_VERSION_ICH9;
1551	pThis->u8IdMask = 0xff;
1552	pThis->u8MaxRte = IOAPIC_MAX_RTE_INDEX;
1553	pThis->u8LastRteRegIdx = IOAPIC_INDIRECT_INDEX_RTE_END;
1554	pThis->u64RteWriteMask = IOAPIC_RTE_VALID_WRITE_MASK_DMAR;
1555	pThis->u64RteReadMask = IOAPIC_RTE_VALID_READ_MASK_DMAR;
1556	}
1557	else if (!strcmp(szChipType, "82093AA"))
1558	{
1559	/* Older 1995-ish discrete I/O APIC, used in P6 class systems. */
1560	pThis->enmType = IOAPICTYPE_82093AA;
1561	pThis->u8ApicVer = IOAPIC_VERSION_82093AA;
1562	pThis->u8IdMask = 0x0f;
1563	pThis->u8MaxRte = IOAPIC_MAX_RTE_INDEX;
1564	pThis->u8LastRteRegIdx = IOAPIC_INDIRECT_INDEX_RTE_END;
1565	pThis->u64RteWriteMask = IOAPIC_RTE_VALID_WRITE_MASK_82093AA;
1566	pThis->u64RteReadMask = IOAPIC_RTE_VALID_READ_MASK_82093AA;
1567	}
1568	else if (!strcmp(szChipType, "82379AB"))
1569	{
1570	/* Even older 1993-ish I/O APIC built into SIO.A, used in EISA and early PCI systems. */
1571	/* Exact same version and behavior as 82093AA, only the number of RTEs is different. */
1572	pThis->enmType = IOAPICTYPE_82379AB;
1573	pThis->u8ApicVer = IOAPIC_VERSION_82093AA;
1574	pThis->u8IdMask = 0x0f;
1575	pThis->u8MaxRte = IOAPIC_REDUCED_MAX_RTE_INDEX;
1576	pThis->u8LastRteRegIdx = IOAPIC_REDUCED_INDIRECT_INDEX_RTE_END;
1577	pThis->u64RteWriteMask = IOAPIC_RTE_VALID_WRITE_MASK_82093AA;
1578	pThis->u64RteReadMask = IOAPIC_RTE_VALID_READ_MASK_82093AA;
1579	}
1580	else
1581	return PDMDevHlpVMSetError(pDevIns, VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES, RT_SRC_POS,
1582	N_("I/O APIC configuration error: The \"ChipType\" value \"%s\" is unsupported"), szChipType);
1583	Log2(("IOAPIC: cCpus=%u fRZEnabled=%RTbool szChipType=%s\n", cCpus, pDevIns->fR0Enabled \| pDevIns->fRCEnabled, szChipType));
1584
1585	/*
1586	* We will use our own critical section for the IOAPIC device.
1587	*/
1588	rc = PDMDevHlpSetDeviceCritSect(pDevIns, PDMDevHlpCritSectGetNop(pDevIns));
1589	AssertRCReturn(rc, rc);
1590
1591	# ifndef IOAPIC_WITH_PDM_CRITSECT
1592	/*
1593	* Setup the critical section to protect concurrent writes to the RTEs.
1594	*/
1595	rc = PDMDevHlpCritSectInit(pDevIns, &pThis->CritSect, RT_SRC_POS, "IOAPIC");
1596	AssertRCReturn(rc, rc);
1597	# endif
1598
1599	/*
1600	* Register the IOAPIC.
1601	*/
1602	PDMIOAPICREG IoApicReg;
1603	IoApicReg.u32Version = PDM_IOAPICREG_VERSION;
1604	IoApicReg.pfnSetIrq = ioapicSetIrq;
1605	IoApicReg.pfnSendMsi = ioapicSendMsi;
1606	IoApicReg.pfnSetEoi = ioapicSetEoi;
1607	IoApicReg.u32TheEnd = PDM_IOAPICREG_VERSION;
1608	rc = PDMDevHlpIoApicRegister(pDevIns, &IoApicReg, &pThisCC->pIoApicHlp);
1609	AssertRCReturn(rc, rc);
1610	AssertPtr(pThisCC->pIoApicHlp->pfnApicBusDeliver);
1611	AssertPtr(pThisCC->pIoApicHlp->pfnLock);
1612	AssertPtr(pThisCC->pIoApicHlp->pfnUnlock);
1613	AssertPtr(pThisCC->pIoApicHlp->pfnIsLockOwner);
1614	AssertPtr(pThisCC->pIoApicHlp->pfnIommuMsiRemap);
1615
1616	/*
1617	* Register MMIO region.
1618	*/
1619	rc = PDMDevHlpMmioCreateAndMap(pDevIns, IOAPIC_MMIO_BASE_PHYSADDR, IOAPIC_MMIO_SIZE, ioapicMmioWrite, ioapicMmioRead,
1620	IOMMMIO_FLAGS_READ_DWORD \| IOMMMIO_FLAGS_WRITE_DWORD_ZEROED, "I/O APIC", &pThis->hMmio);
1621	AssertRCReturn(rc, rc);
1622
1623	/*
1624	* Register the saved state.
1625	*/
1626	rc = PDMDevHlpSSMRegister(pDevIns, IOAPIC_SAVED_STATE_VERSION, sizeof(*pThis), ioapicR3SaveExec, ioapicR3LoadExec);
1627	AssertRCReturn(rc, rc);
1628
1629	/*
1630	* Register debugger info item.
1631	*/
1632	rc = PDMDevHlpDBGFInfoRegister(pDevIns, "ioapic", "Display IO APIC state.", ioapicR3DbgInfo);
1633	AssertRCReturn(rc, rc);
1634
1635	/*
1636	* Register debugger register access.
1637	*/
1638	rc = PDMDevHlpDBGFRegRegister(pDevIns, g_aRegDesc);
1639	AssertRCReturn(rc, rc);
1640
1641	# ifdef VBOX_WITH_STATISTICS
1642	/*
1643	* Statistics.
1644	*/
1645	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatMmioReadRZ, STAMTYPE_COUNTER, "RZ/MmioRead", STAMUNIT_OCCURENCES, "Number of IOAPIC MMIO reads in RZ.");
1646	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatMmioWriteRZ, STAMTYPE_COUNTER, "RZ/MmioWrite", STAMUNIT_OCCURENCES, "Number of IOAPIC MMIO writes in RZ.");
1647	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetIrqRZ, STAMTYPE_COUNTER, "RZ/SetIrq", STAMUNIT_OCCURENCES, "Number of IOAPIC SetIrq calls in RZ.");
1648	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetEoiRZ, STAMTYPE_COUNTER, "RZ/SetEoi", STAMUNIT_OCCURENCES, "Number of IOAPIC SetEoi calls in RZ.");
1649
1650	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatMmioReadR3, STAMTYPE_COUNTER, "R3/MmioRead", STAMUNIT_OCCURENCES, "Number of IOAPIC MMIO reads in R3");
1651	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatMmioWriteR3, STAMTYPE_COUNTER, "R3/MmioWrite", STAMUNIT_OCCURENCES, "Number of IOAPIC MMIO writes in R3.");
1652	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetIrqR3, STAMTYPE_COUNTER, "R3/SetIrq", STAMUNIT_OCCURENCES, "Number of IOAPIC SetIrq calls in R3.");
1653	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetEoiR3, STAMTYPE_COUNTER, "R3/SetEoi", STAMUNIT_OCCURENCES, "Number of IOAPIC SetEoi calls in R3.");
1654
1655	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatRedundantEdgeIntr, STAMTYPE_COUNTER, "RedundantEdgeIntr", STAMUNIT_OCCURENCES, "Number of redundant edge-triggered interrupts (no IRR change).");
1656	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatRedundantLevelIntr, STAMTYPE_COUNTER, "RedundantLevelIntr", STAMUNIT_OCCURENCES, "Number of redundant level-triggered interrupts (no IRR change).");
1657	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSuppressedLevelIntr, STAMTYPE_COUNTER, "SuppressedLevelIntr", STAMUNIT_OCCURENCES, "Number of suppressed level-triggered interrupts by remote IRR.");
1658
1659	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatIommuRemappedIntr, STAMTYPE_COUNTER, "Iommu/RemappedIntr", STAMUNIT_OCCURENCES, "Number of interrupts remapped by the IOMMU.");
1660	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatIommuRemappedMsi, STAMTYPE_COUNTER, "Iommu/RemappedMsi", STAMUNIT_OCCURENCES, "Number of MSIs remapped by the IOMMU.");
1661	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatIommuDiscardedIntr, STAMTYPE_COUNTER, "Iommu/DiscardedIntr", STAMUNIT_OCCURENCES, "Number of interrupts discarded by the IOMMU.");
1662	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatIommuDiscardedMsi, STAMTYPE_COUNTER, "Iommu/DiscardedMsi", STAMUNIT_OCCURENCES, "Number of MSIs discarded by the IOMMU.");
1663
1664	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatEoiContention, STAMTYPE_COUNTER, "CritSect/ContentionSetEoi", STAMUNIT_OCCURENCES, "Number of times the critsect is busy during EOI writes causing trips to R3.");
1665	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetRteContention, STAMTYPE_COUNTER, "CritSect/ContentionSetRte", STAMUNIT_OCCURENCES, "Number of times the critsect is busy during RTE writes causing trips to R3.");
1666
1667	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatLevelIrqSent, STAMTYPE_COUNTER, "LevelIntr/Sent", STAMUNIT_OCCURENCES, "Number of level-triggered interrupts sent to the local APIC(s).");
1668	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatEoiReceived, STAMTYPE_COUNTER, "LevelIntr/Recv", STAMUNIT_OCCURENCES, "Number of EOIs received for level-triggered interrupts from the local APIC(s).");
1669	# endif
1670	for (size_t i = 0; i < RT_ELEMENTS(pThis->aStatVectors); i++)
1671	PDMDevHlpSTAMRegisterF(pDevIns, &pThis->aStatVectors[i], STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_OCCURENCES,
1672	"Number of ioapicSendMsi/pfnApicBusDeliver calls for the vector.", "Vectors/%02x", i);
1673
1674	/*
1675	* Init. the device state.
1676	*/
1677	LogRel(("IOAPIC: Version=%d.%d ChipType=%s\n", pThis->u8ApicVer >> 4, pThis->u8ApicVer & 0x0f, szChipType));
1678	ioapicR3Reset(pDevIns);
1679
1680	return VINF_SUCCESS;
1681	}
1682
1683	#else /* !IN_RING3 */
1684
1685	/**
1686	* @callback_method_impl{PDMDEVREGR0,pfnConstruct}
1687	*/
1688	static DECLCALLBACK(int) ioapicRZConstruct(PPDMDEVINS pDevIns)
1689	{
1690	PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
1691	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1692	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
1693
1694	int rc = PDMDevHlpSetDeviceCritSect(pDevIns, PDMDevHlpCritSectGetNop(pDevIns));
1695	AssertRCReturn(rc, rc);
1696
1697	PDMIOAPICREG IoApicReg;
1698	IoApicReg.u32Version = PDM_IOAPICREG_VERSION;
1699	IoApicReg.pfnSetIrq = ioapicSetIrq;
1700	IoApicReg.pfnSendMsi = ioapicSendMsi;
1701	IoApicReg.pfnSetEoi = ioapicSetEoi;
1702	IoApicReg.u32TheEnd = PDM_IOAPICREG_VERSION;
1703	rc = PDMDevHlpIoApicSetUpContext(pDevIns, &IoApicReg, &pThisCC->pIoApicHlp);
1704	AssertRCReturn(rc, rc);
1705	AssertPtr(pThisCC->pIoApicHlp->pfnApicBusDeliver);
1706	AssertPtr(pThisCC->pIoApicHlp->pfnLock);
1707	AssertPtr(pThisCC->pIoApicHlp->pfnUnlock);
1708	AssertPtr(pThisCC->pIoApicHlp->pfnIsLockOwner);
1709	AssertPtr(pThisCC->pIoApicHlp->pfnIommuMsiRemap);
1710
1711	rc = PDMDevHlpMmioSetUpContext(pDevIns, pThis->hMmio, ioapicMmioWrite, ioapicMmioRead, NULL /pvUser/);
1712	AssertRCReturn(rc, rc);
1713
1714	return VINF_SUCCESS;
1715	}
1716
1717	#endif /* !IN_RING3 */
1718
1719	/**
1720	* IO APIC device registration structure.
1721	*/
1722	const PDMDEVREG g_DeviceIOAPIC =
1723	{
1724	/* .u32Version = */ PDM_DEVREG_VERSION,
1725	/* .uReserved0 = */ 0,
1726	/* .szName = */ "ioapic",
1727	/* .fFlags = */ PDM_DEVREG_FLAGS_DEFAULT_BITS \| PDM_DEVREG_FLAGS_RZ \| PDM_DEVREG_FLAGS_NEW_STYLE
1728	\| PDM_DEVREG_FLAGS_REQUIRE_R0 \| PDM_DEVREG_FLAGS_REQUIRE_RC,
1729	/* .fClass = */ PDM_DEVREG_CLASS_PIC,
1730	/* .cMaxInstances = */ 1,
1731	/* .uSharedVersion = */ 42,
1732	/* .cbInstanceShared = */ sizeof(IOAPIC),
1733	/* .cbInstanceCC = */ sizeof(IOAPICCC),
1734	/* .cbInstanceRC = */ sizeof(IOAPICRC),
1735	/* .cMaxPciDevices = */ 0,
1736	/* .cMaxMsixVectors = */ 0,
1737	/* .pszDescription = */ "I/O Advanced Programmable Interrupt Controller (IO-APIC) Device",
1738	#if defined(IN_RING3)
1739	/* .pszRCMod = */ "VBoxDDRC.rc",
1740	/* .pszR0Mod = */ "VBoxDDR0.r0",
1741	/* .pfnConstruct = */ ioapicR3Construct,
1742	/* .pfnDestruct = */ ioapicR3Destruct,
1743	/* .pfnRelocate = */ ioapicR3Relocate,
1744	/* .pfnMemSetup = */ NULL,
1745	/* .pfnPowerOn = */ NULL,
1746	/* .pfnReset = */ ioapicR3Reset,
1747	/* .pfnSuspend = */ NULL,
1748	/* .pfnResume = */ NULL,
1749	/* .pfnAttach = */ NULL,
1750	/* .pfnDetach = */ NULL,
1751	/* .pfnQueryInterface = */ NULL,
1752	/* .pfnInitComplete = */ NULL,
1753	/* .pfnPowerOff = */ NULL,
1754	/* .pfnSoftReset = */ NULL,
1755	/* .pfnReserved0 = */ NULL,
1756	/* .pfnReserved1 = */ NULL,
1757	/* .pfnReserved2 = */ NULL,
1758	/* .pfnReserved3 = */ NULL,
1759	/* .pfnReserved4 = */ NULL,
1760	/* .pfnReserved5 = */ NULL,
1761	/* .pfnReserved6 = */ NULL,
1762	/* .pfnReserved7 = */ NULL,
1763	#elif defined(IN_RING0)
1764	/* .pfnEarlyConstruct = */ NULL,
1765	/* .pfnConstruct = */ ioapicRZConstruct,
1766	/* .pfnDestruct = */ NULL,
1767	/* .pfnFinalDestruct = */ NULL,
1768	/* .pfnRequest = */ NULL,
1769	/* .pfnReserved0 = */ NULL,
1770	/* .pfnReserved1 = */ NULL,
1771	/* .pfnReserved2 = */ NULL,
1772	/* .pfnReserved3 = */ NULL,
1773	/* .pfnReserved4 = */ NULL,
1774	/* .pfnReserved5 = */ NULL,
1775	/* .pfnReserved6 = */ NULL,
1776	/* .pfnReserved7 = */ NULL,
1777	#elif defined(IN_RC)
1778	/* .pfnConstruct = */ ioapicRZConstruct,
1779	/* .pfnReserved0 = */ NULL,
1780	/* .pfnReserved1 = */ NULL,
1781	/* .pfnReserved2 = */ NULL,
1782	/* .pfnReserved3 = */ NULL,
1783	/* .pfnReserved4 = */ NULL,
1784	/* .pfnReserved5 = */ NULL,
1785	/* .pfnReserved6 = */ NULL,
1786	/* .pfnReserved7 = */ NULL,
1787	#else
1788	# error "Not in IN_RING3, IN_RING0 or IN_RC!"
1789	#endif
1790	/* .u32VersionEnd = */ PDM_DEVREG_VERSION
1791	};
1792
1793
1794	#endif /* !VBOX_DEVICE_STRUCT_TESTCASE */
1795

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/PC/DevIoApic.cpp@ 89066

Download in other formats: