VirtualBox

source: vbox/trunk/src/VBox/VMM/VMMAll/APICAll.cpp@ 81909

Last change on this file since 81909 was 81909, checked in by vboxsync, 5 years ago

VMM,DevPIC: Refactored the PIC registration. bugreF:9218

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 126.5 KB
Line 
1/* $Id: APICAll.cpp 81909 2019-11-17 18:23:56Z vboxsync $ */
2/** @file
3 * APIC - Advanced Programmable Interrupt Controller - All Contexts.
4 */
5
6/*
7 * Copyright (C) 2016-2019 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_APIC
23#include "APICInternal.h"
24#include <VBox/vmm/pdmdev.h>
25#include <VBox/vmm/pdmapi.h>
26#include <VBox/vmm/vmcc.h>
27#include <VBox/vmm/vmm.h>
28#include <VBox/vmm/vmcpuset.h>
29#ifdef IN_RING0
30# include <VBox/vmm/gvmm.h>
31#endif
32
33
34/*********************************************************************************************************************************
35* Internal Functions *
36*********************************************************************************************************************************/
37static void apicSetInterruptFF(PVMCPUCC pVCpu, PDMAPICIRQ enmType);
38static void apicStopTimer(PVMCPUCC pVCpu);
39
40
41/*********************************************************************************************************************************
42* Global Variables *
43*********************************************************************************************************************************/
44#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
45/** An ordered array of valid LVT masks. */
46static const uint32_t g_au32LvtValidMasks[] =
47{
48 XAPIC_LVT_TIMER_VALID,
49 XAPIC_LVT_THERMAL_VALID,
50 XAPIC_LVT_PERF_VALID,
51 XAPIC_LVT_LINT_VALID, /* LINT0 */
52 XAPIC_LVT_LINT_VALID, /* LINT1 */
53 XAPIC_LVT_ERROR_VALID
54};
55#endif
56
57#if 0
58/** @todo CMCI */
59static const uint32_t g_au32LvtExtValidMask[] =
60{
61 XAPIC_LVT_CMCI_VALID
62};
63#endif
64
65
66/**
67 * Checks if a vector is set in an APIC 256-bit sparse register.
68 *
69 * @returns true if the specified vector is set, false otherwise.
70 * @param pApicReg The APIC 256-bit spare register.
71 * @param uVector The vector to check if set.
72 */
73DECLINLINE(bool) apicTestVectorInReg(const volatile XAPIC256BITREG *pApicReg, uint8_t uVector)
74{
75 const volatile uint8_t *pbBitmap = (const volatile uint8_t *)&pApicReg->u[0];
76 return ASMBitTest(pbBitmap + XAPIC_REG256_VECTOR_OFF(uVector), XAPIC_REG256_VECTOR_BIT(uVector));
77}
78
79
80/**
81 * Sets the vector in an APIC 256-bit sparse register.
82 *
83 * @param pApicReg The APIC 256-bit spare register.
84 * @param uVector The vector to set.
85 */
86DECLINLINE(void) apicSetVectorInReg(volatile XAPIC256BITREG *pApicReg, uint8_t uVector)
87{
88 volatile uint8_t *pbBitmap = (volatile uint8_t *)&pApicReg->u[0];
89 ASMAtomicBitSet(pbBitmap + XAPIC_REG256_VECTOR_OFF(uVector), XAPIC_REG256_VECTOR_BIT(uVector));
90}
91
92
93/**
94 * Clears the vector in an APIC 256-bit sparse register.
95 *
96 * @param pApicReg The APIC 256-bit spare register.
97 * @param uVector The vector to clear.
98 */
99DECLINLINE(void) apicClearVectorInReg(volatile XAPIC256BITREG *pApicReg, uint8_t uVector)
100{
101 volatile uint8_t *pbBitmap = (volatile uint8_t *)&pApicReg->u[0];
102 ASMAtomicBitClear(pbBitmap + XAPIC_REG256_VECTOR_OFF(uVector), XAPIC_REG256_VECTOR_BIT(uVector));
103}
104
105
106#if 0 /* unused */
107/**
108 * Checks if a vector is set in an APIC Pending-Interrupt Bitmap (PIB).
109 *
110 * @returns true if the specified vector is set, false otherwise.
111 * @param pvPib Opaque pointer to the PIB.
112 * @param uVector The vector to check if set.
113 */
114DECLINLINE(bool) apicTestVectorInPib(volatile void *pvPib, uint8_t uVector)
115{
116 return ASMBitTest(pvPib, uVector);
117}
118#endif /* unused */
119
120
121/**
122 * Atomically sets the PIB notification bit.
123 *
124 * @returns non-zero if the bit was already set, 0 otherwise.
125 * @param pApicPib Pointer to the PIB.
126 */
127DECLINLINE(uint32_t) apicSetNotificationBitInPib(PAPICPIB pApicPib)
128{
129 return ASMAtomicXchgU32(&pApicPib->fOutstandingNotification, RT_BIT_32(31));
130}
131
132
133/**
134 * Atomically tests and clears the PIB notification bit.
135 *
136 * @returns non-zero if the bit was already set, 0 otherwise.
137 * @param pApicPib Pointer to the PIB.
138 */
139DECLINLINE(uint32_t) apicClearNotificationBitInPib(PAPICPIB pApicPib)
140{
141 return ASMAtomicXchgU32(&pApicPib->fOutstandingNotification, UINT32_C(0));
142}
143
144
145/**
146 * Sets the vector in an APIC Pending-Interrupt Bitmap (PIB).
147 *
148 * @param pvPib Opaque pointer to the PIB.
149 * @param uVector The vector to set.
150 */
151DECLINLINE(void) apicSetVectorInPib(volatile void *pvPib, uint8_t uVector)
152{
153 ASMAtomicBitSet(pvPib, uVector);
154}
155
156#if 0 /* unused */
157/**
158 * Clears the vector in an APIC Pending-Interrupt Bitmap (PIB).
159 *
160 * @param pvPib Opaque pointer to the PIB.
161 * @param uVector The vector to clear.
162 */
163DECLINLINE(void) apicClearVectorInPib(volatile void *pvPib, uint8_t uVector)
164{
165 ASMAtomicBitClear(pvPib, uVector);
166}
167#endif /* unused */
168
169#if 0 /* unused */
170/**
171 * Atomically OR's a fragment (32 vectors) into an APIC 256-bit sparse
172 * register.
173 *
174 * @param pApicReg The APIC 256-bit spare register.
175 * @param idxFragment The index of the 32-bit fragment in @a
176 * pApicReg.
177 * @param u32Fragment The 32-bit vector fragment to OR.
178 */
179DECLINLINE(void) apicOrVectorsToReg(volatile XAPIC256BITREG *pApicReg, size_t idxFragment, uint32_t u32Fragment)
180{
181 Assert(idxFragment < RT_ELEMENTS(pApicReg->u));
182 ASMAtomicOrU32(&pApicReg->u[idxFragment].u32Reg, u32Fragment);
183}
184#endif /* unused */
185
186
187#if 0 /* unused */
188/**
189 * Atomically AND's a fragment (32 vectors) into an APIC
190 * 256-bit sparse register.
191 *
192 * @param pApicReg The APIC 256-bit spare register.
193 * @param idxFragment The index of the 32-bit fragment in @a
194 * pApicReg.
195 * @param u32Fragment The 32-bit vector fragment to AND.
196 */
197DECLINLINE(void) apicAndVectorsToReg(volatile XAPIC256BITREG *pApicReg, size_t idxFragment, uint32_t u32Fragment)
198{
199 Assert(idxFragment < RT_ELEMENTS(pApicReg->u));
200 ASMAtomicAndU32(&pApicReg->u[idxFragment].u32Reg, u32Fragment);
201}
202#endif /* unused */
203
204
205/**
206 * Reports and returns appropriate error code for invalid MSR accesses.
207 *
208 * @returns VERR_CPUM_RAISE_GP_0
209 *
210 * @param pVCpu The cross context virtual CPU structure.
211 * @param u32Reg The MSR being accessed.
212 * @param enmAccess The invalid-access type.
213 */
214static int apicMsrAccessError(PVMCPUCC pVCpu, uint32_t u32Reg, APICMSRACCESS enmAccess)
215{
216 static struct
217 {
218 const char *pszBefore; /* The error message before printing the MSR index */
219 const char *pszAfter; /* The error message after printing the MSR index */
220 } const s_aAccess[] =
221 {
222 /* enmAccess pszBefore pszAfter */
223 /* 0 */ { "read MSR", " while not in x2APIC mode" },
224 /* 1 */ { "write MSR", " while not in x2APIC mode" },
225 /* 2 */ { "read reserved/unknown MSR", "" },
226 /* 3 */ { "write reserved/unknown MSR", "" },
227 /* 4 */ { "read write-only MSR", "" },
228 /* 5 */ { "write read-only MSR", "" },
229 /* 6 */ { "read reserved bits of MSR", "" },
230 /* 7 */ { "write reserved bits of MSR", "" },
231 /* 8 */ { "write an invalid value to MSR", "" },
232 /* 9 */ { "write MSR", " disallowed by configuration" },
233 /* 10 */ { "read MSR", " disallowed by configuration" },
234 };
235 AssertCompile(RT_ELEMENTS(s_aAccess) == APICMSRACCESS_COUNT);
236
237 size_t const i = enmAccess;
238 Assert(i < RT_ELEMENTS(s_aAccess));
239 if (pVCpu->apic.s.cLogMaxAccessError++ < 5)
240 LogRel(("APIC%u: Attempt to %s (%#x)%s -> #GP(0)\n", pVCpu->idCpu, s_aAccess[i].pszBefore, u32Reg, s_aAccess[i].pszAfter));
241 return VERR_CPUM_RAISE_GP_0;
242}
243
244
245/**
246 * Gets the descriptive APIC mode.
247 *
248 * @returns The name.
249 * @param enmMode The xAPIC mode.
250 */
251const char *apicGetModeName(APICMODE enmMode)
252{
253 switch (enmMode)
254 {
255 case APICMODE_DISABLED: return "Disabled";
256 case APICMODE_XAPIC: return "xAPIC";
257 case APICMODE_X2APIC: return "x2APIC";
258 default: break;
259 }
260 return "Invalid";
261}
262
263
264/**
265 * Gets the descriptive destination format name.
266 *
267 * @returns The destination format name.
268 * @param enmDestFormat The destination format.
269 */
270const char *apicGetDestFormatName(XAPICDESTFORMAT enmDestFormat)
271{
272 switch (enmDestFormat)
273 {
274 case XAPICDESTFORMAT_FLAT: return "Flat";
275 case XAPICDESTFORMAT_CLUSTER: return "Cluster";
276 default: break;
277 }
278 return "Invalid";
279}
280
281
282/**
283 * Gets the descriptive delivery mode name.
284 *
285 * @returns The delivery mode name.
286 * @param enmDeliveryMode The delivery mode.
287 */
288const char *apicGetDeliveryModeName(XAPICDELIVERYMODE enmDeliveryMode)
289{
290 switch (enmDeliveryMode)
291 {
292 case XAPICDELIVERYMODE_FIXED: return "Fixed";
293 case XAPICDELIVERYMODE_LOWEST_PRIO: return "Lowest-priority";
294 case XAPICDELIVERYMODE_SMI: return "SMI";
295 case XAPICDELIVERYMODE_NMI: return "NMI";
296 case XAPICDELIVERYMODE_INIT: return "INIT";
297 case XAPICDELIVERYMODE_STARTUP: return "SIPI";
298 case XAPICDELIVERYMODE_EXTINT: return "ExtINT";
299 default: break;
300 }
301 return "Invalid";
302}
303
304
305/**
306 * Gets the descriptive destination mode name.
307 *
308 * @returns The destination mode name.
309 * @param enmDestMode The destination mode.
310 */
311const char *apicGetDestModeName(XAPICDESTMODE enmDestMode)
312{
313 switch (enmDestMode)
314 {
315 case XAPICDESTMODE_PHYSICAL: return "Physical";
316 case XAPICDESTMODE_LOGICAL: return "Logical";
317 default: break;
318 }
319 return "Invalid";
320}
321
322
323/**
324 * Gets the descriptive trigger mode name.
325 *
326 * @returns The trigger mode name.
327 * @param enmTriggerMode The trigger mode.
328 */
329const char *apicGetTriggerModeName(XAPICTRIGGERMODE enmTriggerMode)
330{
331 switch (enmTriggerMode)
332 {
333 case XAPICTRIGGERMODE_EDGE: return "Edge";
334 case XAPICTRIGGERMODE_LEVEL: return "Level";
335 default: break;
336 }
337 return "Invalid";
338}
339
340
341/**
342 * Gets the destination shorthand name.
343 *
344 * @returns The destination shorthand name.
345 * @param enmDestShorthand The destination shorthand.
346 */
347const char *apicGetDestShorthandName(XAPICDESTSHORTHAND enmDestShorthand)
348{
349 switch (enmDestShorthand)
350 {
351 case XAPICDESTSHORTHAND_NONE: return "None";
352 case XAPICDESTSHORTHAND_SELF: return "Self";
353 case XAPIDDESTSHORTHAND_ALL_INCL_SELF: return "All including self";
354 case XAPICDESTSHORTHAND_ALL_EXCL_SELF: return "All excluding self";
355 default: break;
356 }
357 return "Invalid";
358}
359
360
361/**
362 * Gets the timer mode name.
363 *
364 * @returns The timer mode name.
365 * @param enmTimerMode The timer mode.
366 */
367const char *apicGetTimerModeName(XAPICTIMERMODE enmTimerMode)
368{
369 switch (enmTimerMode)
370 {
371 case XAPICTIMERMODE_ONESHOT: return "One-shot";
372 case XAPICTIMERMODE_PERIODIC: return "Periodic";
373 case XAPICTIMERMODE_TSC_DEADLINE: return "TSC deadline";
374 default: break;
375 }
376 return "Invalid";
377}
378
379
380/**
381 * Gets the APIC mode given the base MSR value.
382 *
383 * @returns The APIC mode.
384 * @param uApicBaseMsr The APIC Base MSR value.
385 */
386APICMODE apicGetMode(uint64_t uApicBaseMsr)
387{
388 uint32_t const uMode = (uApicBaseMsr >> 10) & UINT64_C(3);
389 APICMODE const enmMode = (APICMODE)uMode;
390#ifdef VBOX_STRICT
391 /* Paranoia. */
392 switch (uMode)
393 {
394 case APICMODE_DISABLED:
395 case APICMODE_INVALID:
396 case APICMODE_XAPIC:
397 case APICMODE_X2APIC:
398 break;
399 default:
400 AssertMsgFailed(("Invalid mode"));
401 }
402#endif
403 return enmMode;
404}
405
406
407/**
408 * Returns whether the APIC is hardware enabled or not.
409 *
410 * @returns true if enabled, false otherwise.
411 * @param pVCpu The cross context virtual CPU structure.
412 */
413VMM_INT_DECL(bool) APICIsEnabled(PCVMCPUCC pVCpu)
414{
415 PCAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
416 return RT_BOOL(pApicCpu->uApicBaseMsr & MSR_IA32_APICBASE_EN);
417}
418
419
420/**
421 * Finds the most significant set bit in an APIC 256-bit sparse register.
422 *
423 * @returns @a rcNotFound if no bit was set, 0-255 otherwise.
424 * @param pReg The APIC 256-bit sparse register.
425 * @param rcNotFound What to return when no bit is set.
426 */
427static int apicGetHighestSetBitInReg(volatile const XAPIC256BITREG *pReg, int rcNotFound)
428{
429 ssize_t const cFragments = RT_ELEMENTS(pReg->u);
430 unsigned const uFragmentShift = 5;
431 AssertCompile(1 << uFragmentShift == sizeof(pReg->u[0].u32Reg) * 8);
432 for (ssize_t i = cFragments - 1; i >= 0; i--)
433 {
434 uint32_t const uFragment = pReg->u[i].u32Reg;
435 if (uFragment)
436 {
437 unsigned idxSetBit = ASMBitLastSetU32(uFragment);
438 --idxSetBit;
439 idxSetBit |= i << uFragmentShift;
440 return idxSetBit;
441 }
442 }
443 return rcNotFound;
444}
445
446
447/**
448 * Reads a 32-bit register at a specified offset.
449 *
450 * @returns The value at the specified offset.
451 * @param pXApicPage The xAPIC page.
452 * @param offReg The offset of the register being read.
453 */
454DECLINLINE(uint32_t) apicReadRaw32(PCXAPICPAGE pXApicPage, uint16_t offReg)
455{
456 Assert(offReg < sizeof(*pXApicPage) - sizeof(uint32_t));
457 uint8_t const *pbXApic = (const uint8_t *)pXApicPage;
458 uint32_t const uValue = *(const uint32_t *)(pbXApic + offReg);
459 return uValue;
460}
461
462
463/**
464 * Writes a 32-bit register at a specified offset.
465 *
466 * @param pXApicPage The xAPIC page.
467 * @param offReg The offset of the register being written.
468 * @param uReg The value of the register.
469 */
470DECLINLINE(void) apicWriteRaw32(PXAPICPAGE pXApicPage, uint16_t offReg, uint32_t uReg)
471{
472 Assert(offReg < sizeof(*pXApicPage) - sizeof(uint32_t));
473 uint8_t *pbXApic = (uint8_t *)pXApicPage;
474 *(uint32_t *)(pbXApic + offReg) = uReg;
475}
476
477
478/**
479 * Sets an error in the internal ESR of the specified APIC.
480 *
481 * @param pVCpu The cross context virtual CPU structure.
482 * @param uError The error.
483 * @thread Any.
484 */
485DECLINLINE(void) apicSetError(PVMCPUCC pVCpu, uint32_t uError)
486{
487 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
488 ASMAtomicOrU32(&pApicCpu->uEsrInternal, uError);
489}
490
491
492/**
493 * Clears all errors in the internal ESR.
494 *
495 * @returns The value of the internal ESR before clearing.
496 * @param pVCpu The cross context virtual CPU structure.
497 */
498DECLINLINE(uint32_t) apicClearAllErrors(PVMCPUCC pVCpu)
499{
500 VMCPU_ASSERT_EMT(pVCpu);
501 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
502 return ASMAtomicXchgU32(&pApicCpu->uEsrInternal, 0);
503}
504
505
506/**
507 * Signals the guest if a pending interrupt is ready to be serviced.
508 *
509 * @param pVCpu The cross context virtual CPU structure.
510 */
511static void apicSignalNextPendingIntr(PVMCPUCC pVCpu)
512{
513 VMCPU_ASSERT_EMT_OR_NOT_RUNNING(pVCpu);
514
515 PCXAPICPAGE pXApicPage = VMCPU_TO_CXAPICPAGE(pVCpu);
516 if (pXApicPage->svr.u.fApicSoftwareEnable)
517 {
518 int const irrv = apicGetHighestSetBitInReg(&pXApicPage->irr, -1 /* rcNotFound */);
519 if (irrv >= 0)
520 {
521 Assert(irrv <= (int)UINT8_MAX);
522 uint8_t const uVector = irrv;
523 uint8_t const uPpr = pXApicPage->ppr.u8Ppr;
524 if ( !uPpr
525 || XAPIC_PPR_GET_PP(uVector) > XAPIC_PPR_GET_PP(uPpr))
526 {
527 Log2(("APIC%u: apicSignalNextPendingIntr: Signalling pending interrupt. uVector=%#x\n", pVCpu->idCpu, uVector));
528 apicSetInterruptFF(pVCpu, PDMAPICIRQ_HARDWARE);
529 }
530 else
531 {
532 Log2(("APIC%u: apicSignalNextPendingIntr: Nothing to signal. uVector=%#x uPpr=%#x uTpr=%#x\n", pVCpu->idCpu,
533 uVector, uPpr, pXApicPage->tpr.u8Tpr));
534 }
535 }
536 }
537 else
538 {
539 Log2(("APIC%u: apicSignalNextPendingIntr: APIC software-disabled, clearing pending interrupt\n", pVCpu->idCpu));
540 apicClearInterruptFF(pVCpu, PDMAPICIRQ_HARDWARE);
541 }
542}
543
544
545/**
546 * Sets the Spurious-Interrupt Vector Register (SVR).
547 *
548 * @returns VINF_SUCCESS or VERR_CPUM_RAISE_GP_0.
549 * @param pVCpu The cross context virtual CPU structure.
550 * @param uSvr The SVR value.
551 */
552static int apicSetSvr(PVMCPUCC pVCpu, uint32_t uSvr)
553{
554 VMCPU_ASSERT_EMT(pVCpu);
555
556 uint32_t uValidMask = XAPIC_SVR_VALID;
557 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
558 if (pXApicPage->version.u.fEoiBroadcastSupression)
559 uValidMask |= XAPIC_SVR_SUPRESS_EOI_BROADCAST;
560
561 if ( XAPIC_IN_X2APIC_MODE(pVCpu)
562 && (uSvr & ~uValidMask))
563 return apicMsrAccessError(pVCpu, MSR_IA32_X2APIC_SVR, APICMSRACCESS_WRITE_RSVD_BITS);
564
565 Log2(("APIC%u: apicSetSvr: uSvr=%#RX32\n", pVCpu->idCpu, uSvr));
566 apicWriteRaw32(pXApicPage, XAPIC_OFF_SVR, uSvr);
567 if (!pXApicPage->svr.u.fApicSoftwareEnable)
568 {
569 /** @todo CMCI. */
570 pXApicPage->lvt_timer.u.u1Mask = 1;
571#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
572 pXApicPage->lvt_thermal.u.u1Mask = 1;
573#endif
574 pXApicPage->lvt_perf.u.u1Mask = 1;
575 pXApicPage->lvt_lint0.u.u1Mask = 1;
576 pXApicPage->lvt_lint1.u.u1Mask = 1;
577 pXApicPage->lvt_error.u.u1Mask = 1;
578 }
579
580 apicSignalNextPendingIntr(pVCpu);
581 return VINF_SUCCESS;
582}
583
584
585/**
586 * Sends an interrupt to one or more APICs.
587 *
588 * @returns Strict VBox status code.
589 * @param pVM The cross context VM structure.
590 * @param pVCpu The cross context virtual CPU structure, can be
591 * NULL if the source of the interrupt is not an
592 * APIC (for e.g. a bus).
593 * @param uVector The interrupt vector.
594 * @param enmTriggerMode The trigger mode.
595 * @param enmDeliveryMode The delivery mode.
596 * @param pDestCpuSet The destination CPU set.
597 * @param pfIntrAccepted Where to store whether this interrupt was
598 * accepted by the target APIC(s) or not.
599 * Optional, can be NULL.
600 * @param uSrcTag The interrupt source tag (debugging).
601 * @param rcRZ The return code if the operation cannot be
602 * performed in the current context.
603 */
604static VBOXSTRICTRC apicSendIntr(PVMCC pVM, PVMCPUCC pVCpu, uint8_t uVector, XAPICTRIGGERMODE enmTriggerMode,
605 XAPICDELIVERYMODE enmDeliveryMode, PCVMCPUSET pDestCpuSet, bool *pfIntrAccepted,
606 uint32_t uSrcTag, int rcRZ)
607{
608 VBOXSTRICTRC rcStrict = VINF_SUCCESS;
609 VMCPUID const cCpus = pVM->cCpus;
610 bool fAccepted = false;
611 switch (enmDeliveryMode)
612 {
613 case XAPICDELIVERYMODE_FIXED:
614 {
615 for (VMCPUID idCpu = 0; idCpu < cCpus; idCpu++)
616 if (VMCPUSET_IS_PRESENT(pDestCpuSet, idCpu))
617 {
618 PVMCPUCC pItVCpu = pVM->CTX_SUFF(apCpus)[idCpu];
619 if (APICIsEnabled(pItVCpu))
620 fAccepted = apicPostInterrupt(pItVCpu, uVector, enmTriggerMode, uSrcTag);
621 }
622 break;
623 }
624
625 case XAPICDELIVERYMODE_LOWEST_PRIO:
626 {
627 VMCPUID const idCpu = VMCPUSET_FIND_FIRST_PRESENT(pDestCpuSet);
628 AssertMsgBreak(idCpu < pVM->cCpus, ("APIC: apicSendIntr: No CPU found for lowest-priority delivery mode! idCpu=%u\n", idCpu));
629 PVMCPUCC pVCpuDst = pVM->CTX_SUFF(apCpus)[idCpu];
630 if (APICIsEnabled(pVCpuDst))
631 fAccepted = apicPostInterrupt(pVCpuDst, uVector, enmTriggerMode, uSrcTag);
632 else
633 AssertMsgFailed(("APIC: apicSendIntr: Target APIC not enabled in lowest-priority delivery mode! idCpu=%u\n", idCpu));
634 break;
635 }
636
637 case XAPICDELIVERYMODE_SMI:
638 {
639 for (VMCPUID idCpu = 0; idCpu < cCpus; idCpu++)
640 if (VMCPUSET_IS_PRESENT(pDestCpuSet, idCpu))
641 {
642 Log2(("APIC: apicSendIntr: Raising SMI on VCPU%u\n", idCpu));
643 apicSetInterruptFF(pVM->CTX_SUFF(apCpus)[idCpu], PDMAPICIRQ_SMI);
644 fAccepted = true;
645 }
646 break;
647 }
648
649 case XAPICDELIVERYMODE_NMI:
650 {
651 for (VMCPUID idCpu = 0; idCpu < cCpus; idCpu++)
652 if (VMCPUSET_IS_PRESENT(pDestCpuSet, idCpu))
653 {
654 PVMCPUCC pItVCpu = pVM->CTX_SUFF(apCpus)[idCpu];
655 if (APICIsEnabled(pItVCpu))
656 {
657 Log2(("APIC: apicSendIntr: Raising NMI on VCPU%u\n", idCpu));
658 apicSetInterruptFF(pItVCpu, PDMAPICIRQ_NMI);
659 fAccepted = true;
660 }
661 }
662 break;
663 }
664
665 case XAPICDELIVERYMODE_INIT:
666 {
667#ifdef IN_RING3
668 for (VMCPUID idCpu = 0; idCpu < cCpus; idCpu++)
669 if (VMCPUSET_IS_PRESENT(pDestCpuSet, idCpu))
670 {
671 Log2(("APIC: apicSendIntr: Issuing INIT to VCPU%u\n", idCpu));
672 VMMR3SendInitIpi(pVM, idCpu);
673 fAccepted = true;
674 }
675#else
676 /* We need to return to ring-3 to deliver the INIT. */
677 rcStrict = rcRZ;
678 fAccepted = true;
679#endif
680 break;
681 }
682
683 case XAPICDELIVERYMODE_STARTUP:
684 {
685#ifdef IN_RING3
686 for (VMCPUID idCpu = 0; idCpu < cCpus; idCpu++)
687 if (VMCPUSET_IS_PRESENT(pDestCpuSet, idCpu))
688 {
689 Log2(("APIC: apicSendIntr: Issuing SIPI to VCPU%u\n", idCpu));
690 VMMR3SendStartupIpi(pVM, idCpu, uVector);
691 fAccepted = true;
692 }
693#else
694 /* We need to return to ring-3 to deliver the SIPI. */
695 rcStrict = rcRZ;
696 fAccepted = true;
697 Log2(("APIC: apicSendIntr: SIPI issued, returning to RZ. rc=%Rrc\n", rcRZ));
698#endif
699 break;
700 }
701
702 case XAPICDELIVERYMODE_EXTINT:
703 {
704 for (VMCPUID idCpu = 0; idCpu < cCpus; idCpu++)
705 if (VMCPUSET_IS_PRESENT(pDestCpuSet, idCpu))
706 {
707 Log2(("APIC: apicSendIntr: Raising EXTINT on VCPU%u\n", idCpu));
708 apicSetInterruptFF(pVM->CTX_SUFF(apCpus)[idCpu], PDMAPICIRQ_EXTINT);
709 fAccepted = true;
710 }
711 break;
712 }
713
714 default:
715 {
716 AssertMsgFailed(("APIC: apicSendIntr: Unsupported delivery mode %#x (%s)\n", enmDeliveryMode,
717 apicGetDeliveryModeName(enmDeliveryMode)));
718 break;
719 }
720 }
721
722 /*
723 * If an illegal vector is programmed, set the 'send illegal vector' error here if the
724 * interrupt is being sent by an APIC.
725 *
726 * The 'receive illegal vector' will be set on the target APIC when the interrupt
727 * gets generated, see apicPostInterrupt().
728 *
729 * See Intel spec. 10.5.3 "Error Handling".
730 */
731 if ( rcStrict != rcRZ
732 && pVCpu)
733 {
734 /*
735 * Flag only errors when the delivery mode is fixed and not others.
736 *
737 * Ubuntu 10.04-3 amd64 live CD with 2 VCPUs gets upset as it sends an SIPI to the
738 * 2nd VCPU with vector 6 and checks the ESR for no errors, see @bugref{8245#c86}.
739 */
740 /** @todo The spec says this for LVT, but not explcitly for ICR-lo
741 * but it probably is true. */
742 if (enmDeliveryMode == XAPICDELIVERYMODE_FIXED)
743 {
744 if (RT_UNLIKELY(uVector <= XAPIC_ILLEGAL_VECTOR_END))
745 apicSetError(pVCpu, XAPIC_ESR_SEND_ILLEGAL_VECTOR);
746 }
747 }
748
749 if (pfIntrAccepted)
750 *pfIntrAccepted = fAccepted;
751
752 return rcStrict;
753}
754
755
756/**
757 * Checks if this APIC belongs to a logical destination.
758 *
759 * @returns true if the APIC belongs to the logical
760 * destination, false otherwise.
761 * @param pVCpu The cross context virtual CPU structure.
762 * @param fDest The destination mask.
763 *
764 * @thread Any.
765 */
766static bool apicIsLogicalDest(PVMCPUCC pVCpu, uint32_t fDest)
767{
768 if (XAPIC_IN_X2APIC_MODE(pVCpu))
769 {
770 /*
771 * Flat logical mode is not supported in x2APIC mode.
772 * In clustered logical mode, the 32-bit logical ID in the LDR is interpreted as follows:
773 * - High 16 bits is the cluster ID.
774 * - Low 16 bits: each bit represents a unique APIC within the cluster.
775 */
776 PCX2APICPAGE pX2ApicPage = VMCPU_TO_CX2APICPAGE(pVCpu);
777 uint32_t const u32Ldr = pX2ApicPage->ldr.u32LogicalApicId;
778 if (X2APIC_LDR_GET_CLUSTER_ID(u32Ldr) == (fDest & X2APIC_LDR_CLUSTER_ID))
779 return RT_BOOL(u32Ldr & fDest & X2APIC_LDR_LOGICAL_ID);
780 return false;
781 }
782
783#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
784 /*
785 * In both flat and clustered logical mode, a destination mask of all set bits indicates a broadcast.
786 * See AMD spec. 16.6.1 "Receiving System and IPI Interrupts".
787 */
788 Assert(!XAPIC_IN_X2APIC_MODE(pVCpu));
789 if ((fDest & XAPIC_LDR_FLAT_LOGICAL_ID) == XAPIC_LDR_FLAT_LOGICAL_ID)
790 return true;
791
792 PCXAPICPAGE pXApicPage = VMCPU_TO_CXAPICPAGE(pVCpu);
793 XAPICDESTFORMAT enmDestFormat = (XAPICDESTFORMAT)pXApicPage->dfr.u.u4Model;
794 if (enmDestFormat == XAPICDESTFORMAT_FLAT)
795 {
796 /* The destination mask is interpreted as a bitmap of 8 unique logical APIC IDs. */
797 uint8_t const u8Ldr = pXApicPage->ldr.u.u8LogicalApicId;
798 return RT_BOOL(u8Ldr & fDest & XAPIC_LDR_FLAT_LOGICAL_ID);
799 }
800
801 /*
802 * In clustered logical mode, the 8-bit logical ID in the LDR is interpreted as follows:
803 * - High 4 bits is the cluster ID.
804 * - Low 4 bits: each bit represents a unique APIC within the cluster.
805 */
806 Assert(enmDestFormat == XAPICDESTFORMAT_CLUSTER);
807 uint8_t const u8Ldr = pXApicPage->ldr.u.u8LogicalApicId;
808 if (XAPIC_LDR_CLUSTERED_GET_CLUSTER_ID(u8Ldr) == (fDest & XAPIC_LDR_CLUSTERED_CLUSTER_ID))
809 return RT_BOOL(u8Ldr & fDest & XAPIC_LDR_CLUSTERED_LOGICAL_ID);
810 return false;
811#else
812# error "Implement Pentium and P6 family APIC architectures"
813#endif
814}
815
816
817/**
818 * Figures out the set of destination CPUs for a given destination mode, format
819 * and delivery mode setting.
820 *
821 * @param pVM The cross context VM structure.
822 * @param fDestMask The destination mask.
823 * @param fBroadcastMask The broadcast mask.
824 * @param enmDestMode The destination mode.
825 * @param enmDeliveryMode The delivery mode.
826 * @param pDestCpuSet The destination CPU set to update.
827 */
828static void apicGetDestCpuSet(PVMCC pVM, uint32_t fDestMask, uint32_t fBroadcastMask, XAPICDESTMODE enmDestMode,
829 XAPICDELIVERYMODE enmDeliveryMode, PVMCPUSET pDestCpuSet)
830{
831 VMCPUSET_EMPTY(pDestCpuSet);
832
833 /*
834 * Physical destination mode only supports either a broadcast or a single target.
835 * - Broadcast with lowest-priority delivery mode is not supported[1], we deliver it
836 * as a regular broadcast like in fixed delivery mode.
837 * - For a single target, lowest-priority delivery mode makes no sense. We deliver
838 * to the target like in fixed delivery mode.
839 *
840 * [1] See Intel spec. 10.6.2.1 "Physical Destination Mode".
841 */
842 if ( enmDestMode == XAPICDESTMODE_PHYSICAL
843 && enmDeliveryMode == XAPICDELIVERYMODE_LOWEST_PRIO)
844 {
845 AssertMsgFailed(("APIC: Lowest-priority delivery using physical destination mode!"));
846 enmDeliveryMode = XAPICDELIVERYMODE_FIXED;
847 }
848
849 uint32_t const cCpus = pVM->cCpus;
850 if (enmDeliveryMode == XAPICDELIVERYMODE_LOWEST_PRIO)
851 {
852 Assert(enmDestMode == XAPICDESTMODE_LOGICAL);
853#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
854 VMCPUID idCpuLowestTpr = NIL_VMCPUID;
855 uint8_t u8LowestTpr = UINT8_C(0xff);
856 for (VMCPUID idCpu = 0; idCpu < cCpus; idCpu++)
857 {
858 PVMCPUCC pVCpuDst = pVM->CTX_SUFF(apCpus)[idCpu];
859 if (apicIsLogicalDest(pVCpuDst, fDestMask))
860 {
861 PCXAPICPAGE pXApicPage = VMCPU_TO_CXAPICPAGE(pVCpuDst);
862 uint8_t const u8Tpr = pXApicPage->tpr.u8Tpr; /* PAV */
863
864 /*
865 * If there is a tie for lowest priority, the local APIC with the highest ID is chosen.
866 * Hence the use of "<=" in the check below.
867 * See AMD spec. 16.6.2 "Lowest Priority Messages and Arbitration".
868 */
869 if (u8Tpr <= u8LowestTpr)
870 {
871 u8LowestTpr = u8Tpr;
872 idCpuLowestTpr = idCpu;
873 }
874 }
875 }
876 if (idCpuLowestTpr != NIL_VMCPUID)
877 VMCPUSET_ADD(pDestCpuSet, idCpuLowestTpr);
878#else
879# error "Implement Pentium and P6 family APIC architectures"
880#endif
881 return;
882 }
883
884 /*
885 * x2APIC:
886 * - In both physical and logical destination mode, a destination mask of 0xffffffff implies a broadcast[1].
887 * xAPIC:
888 * - In physical destination mode, a destination mask of 0xff implies a broadcast[2].
889 * - In both flat and clustered logical mode, a destination mask of 0xff implies a broadcast[3].
890 *
891 * [1] See Intel spec. 10.12.9 "ICR Operation in x2APIC Mode".
892 * [2] See Intel spec. 10.6.2.1 "Physical Destination Mode".
893 * [2] See AMD spec. 16.6.1 "Receiving System and IPI Interrupts".
894 */
895 if ((fDestMask & fBroadcastMask) == fBroadcastMask)
896 {
897 VMCPUSET_FILL(pDestCpuSet);
898 return;
899 }
900
901 if (enmDestMode == XAPICDESTMODE_PHYSICAL)
902 {
903 /* The destination mask is interpreted as the physical APIC ID of a single target. */
904#if 1
905 /* Since our physical APIC ID is read-only to software, set the corresponding bit in the CPU set. */
906 if (RT_LIKELY(fDestMask < cCpus))
907 VMCPUSET_ADD(pDestCpuSet, fDestMask);
908#else
909 /* The physical APIC ID may not match our VCPU ID, search through the list of targets. */
910 for (VMCPUID idCpu = 0; idCpu < cCpus; idCpu++)
911 {
912 PVMCPUCC pVCpuDst = &pVM->aCpus[idCpu];
913 if (XAPIC_IN_X2APIC_MODE(pVCpuDst))
914 {
915 PCX2APICPAGE pX2ApicPage = VMCPU_TO_CX2APICPAGE(pVCpuDst);
916 if (pX2ApicPage->id.u32ApicId == fDestMask)
917 VMCPUSET_ADD(pDestCpuSet, pVCpuDst->idCpu);
918 }
919 else
920 {
921 PCXAPICPAGE pXApicPage = VMCPU_TO_CXAPICPAGE(pVCpuDst);
922 if (pXApicPage->id.u8ApicId == (uint8_t)fDestMask)
923 VMCPUSET_ADD(pDestCpuSet, pVCpuDst->idCpu);
924 }
925 }
926#endif
927 }
928 else
929 {
930 Assert(enmDestMode == XAPICDESTMODE_LOGICAL);
931
932 /* A destination mask of all 0's implies no target APICs (since it's interpreted as a bitmap or partial bitmap). */
933 if (RT_UNLIKELY(!fDestMask))
934 return;
935
936 /* The destination mask is interpreted as a bitmap of software-programmable logical APIC ID of the target APICs. */
937 for (VMCPUID idCpu = 0; idCpu < cCpus; idCpu++)
938 {
939 PVMCPUCC pVCpuDst = pVM->CTX_SUFF(apCpus)[idCpu];
940 if (apicIsLogicalDest(pVCpuDst, fDestMask))
941 VMCPUSET_ADD(pDestCpuSet, pVCpuDst->idCpu);
942 }
943 }
944}
945
946
947/**
948 * Sends an Interprocessor Interrupt (IPI) using values from the Interrupt
949 * Command Register (ICR).
950 *
951 * @returns VBox status code.
952 * @param pVCpu The cross context virtual CPU structure.
953 * @param rcRZ The return code if the operation cannot be
954 * performed in the current context.
955 */
956DECLINLINE(VBOXSTRICTRC) apicSendIpi(PVMCPUCC pVCpu, int rcRZ)
957{
958 VMCPU_ASSERT_EMT(pVCpu);
959
960 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
961 XAPICDELIVERYMODE const enmDeliveryMode = (XAPICDELIVERYMODE)pXApicPage->icr_lo.u.u3DeliveryMode;
962 XAPICDESTMODE const enmDestMode = (XAPICDESTMODE)pXApicPage->icr_lo.u.u1DestMode;
963 XAPICINITLEVEL const enmInitLevel = (XAPICINITLEVEL)pXApicPage->icr_lo.u.u1Level;
964 XAPICTRIGGERMODE const enmTriggerMode = (XAPICTRIGGERMODE)pXApicPage->icr_lo.u.u1TriggerMode;
965 XAPICDESTSHORTHAND const enmDestShorthand = (XAPICDESTSHORTHAND)pXApicPage->icr_lo.u.u2DestShorthand;
966 uint8_t const uVector = pXApicPage->icr_lo.u.u8Vector;
967
968 PX2APICPAGE pX2ApicPage = VMCPU_TO_X2APICPAGE(pVCpu);
969 uint32_t const fDest = XAPIC_IN_X2APIC_MODE(pVCpu) ? pX2ApicPage->icr_hi.u32IcrHi : pXApicPage->icr_hi.u.u8Dest;
970
971#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
972 /*
973 * INIT Level De-assert is not support on Pentium 4 and Xeon processors.
974 * Apparently, this also applies to NMI, SMI, lowest-priority and fixed delivery modes,
975 * see @bugref{8245#c116}.
976 *
977 * See AMD spec. 16.5 "Interprocessor Interrupts (IPI)" for a table of valid ICR combinations.
978 */
979 if ( enmTriggerMode == XAPICTRIGGERMODE_LEVEL
980 && enmInitLevel == XAPICINITLEVEL_DEASSERT
981 && ( enmDeliveryMode == XAPICDELIVERYMODE_FIXED
982 || enmDeliveryMode == XAPICDELIVERYMODE_LOWEST_PRIO
983 || enmDeliveryMode == XAPICDELIVERYMODE_SMI
984 || enmDeliveryMode == XAPICDELIVERYMODE_NMI
985 || enmDeliveryMode == XAPICDELIVERYMODE_INIT))
986 {
987 Log2(("APIC%u: %s level de-assert unsupported, ignoring!\n", pVCpu->idCpu, apicGetDeliveryModeName(enmDeliveryMode)));
988 return VINF_SUCCESS;
989 }
990#else
991# error "Implement Pentium and P6 family APIC architectures"
992#endif
993
994 /*
995 * The destination and delivery modes are ignored/by-passed when a destination shorthand is specified.
996 * See Intel spec. 10.6.2.3 "Broadcast/Self Delivery Mode".
997 */
998 VMCPUSET DestCpuSet;
999 switch (enmDestShorthand)
1000 {
1001 case XAPICDESTSHORTHAND_NONE:
1002 {
1003 PVMCC pVM = pVCpu->CTX_SUFF(pVM);
1004 uint32_t const fBroadcastMask = XAPIC_IN_X2APIC_MODE(pVCpu) ? X2APIC_ID_BROADCAST_MASK : XAPIC_ID_BROADCAST_MASK;
1005 apicGetDestCpuSet(pVM, fDest, fBroadcastMask, enmDestMode, enmDeliveryMode, &DestCpuSet);
1006 break;
1007 }
1008
1009 case XAPICDESTSHORTHAND_SELF:
1010 {
1011 VMCPUSET_EMPTY(&DestCpuSet);
1012 VMCPUSET_ADD(&DestCpuSet, pVCpu->idCpu);
1013 break;
1014 }
1015
1016 case XAPIDDESTSHORTHAND_ALL_INCL_SELF:
1017 {
1018 VMCPUSET_FILL(&DestCpuSet);
1019 break;
1020 }
1021
1022 case XAPICDESTSHORTHAND_ALL_EXCL_SELF:
1023 {
1024 VMCPUSET_FILL(&DestCpuSet);
1025 VMCPUSET_DEL(&DestCpuSet, pVCpu->idCpu);
1026 break;
1027 }
1028 }
1029
1030 return apicSendIntr(pVCpu->CTX_SUFF(pVM), pVCpu, uVector, enmTriggerMode, enmDeliveryMode, &DestCpuSet,
1031 NULL /* pfIntrAccepted */, 0 /* uSrcTag */, rcRZ);
1032}
1033
1034
1035/**
1036 * Sets the Interrupt Command Register (ICR) high dword.
1037 *
1038 * @returns Strict VBox status code.
1039 * @param pVCpu The cross context virtual CPU structure.
1040 * @param uIcrHi The ICR high dword.
1041 */
1042static VBOXSTRICTRC apicSetIcrHi(PVMCPUCC pVCpu, uint32_t uIcrHi)
1043{
1044 VMCPU_ASSERT_EMT(pVCpu);
1045 Assert(!XAPIC_IN_X2APIC_MODE(pVCpu));
1046
1047 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1048 pXApicPage->icr_hi.all.u32IcrHi = uIcrHi & XAPIC_ICR_HI_DEST;
1049 STAM_COUNTER_INC(&pVCpu->apic.s.StatIcrHiWrite);
1050 Log2(("APIC%u: apicSetIcrHi: uIcrHi=%#RX32\n", pVCpu->idCpu, pXApicPage->icr_hi.all.u32IcrHi));
1051
1052 return VINF_SUCCESS;
1053}
1054
1055
1056/**
1057 * Sets the Interrupt Command Register (ICR) low dword.
1058 *
1059 * @returns Strict VBox status code.
1060 * @param pVCpu The cross context virtual CPU structure.
1061 * @param uIcrLo The ICR low dword.
1062 * @param rcRZ The return code if the operation cannot be performed
1063 * in the current context.
1064 * @param fUpdateStat Whether to update the ICR low write statistics
1065 * counter.
1066 */
1067static VBOXSTRICTRC apicSetIcrLo(PVMCPUCC pVCpu, uint32_t uIcrLo, int rcRZ, bool fUpdateStat)
1068{
1069 VMCPU_ASSERT_EMT(pVCpu);
1070
1071 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1072 pXApicPage->icr_lo.all.u32IcrLo = uIcrLo & XAPIC_ICR_LO_WR_VALID;
1073 Log2(("APIC%u: apicSetIcrLo: uIcrLo=%#RX32\n", pVCpu->idCpu, pXApicPage->icr_lo.all.u32IcrLo));
1074
1075 if (fUpdateStat)
1076 STAM_COUNTER_INC(&pVCpu->apic.s.StatIcrLoWrite);
1077 RT_NOREF(fUpdateStat);
1078
1079 return apicSendIpi(pVCpu, rcRZ);
1080}
1081
1082
1083/**
1084 * Sets the Interrupt Command Register (ICR).
1085 *
1086 * @returns Strict VBox status code.
1087 * @param pVCpu The cross context virtual CPU structure.
1088 * @param u64Icr The ICR (High and Low combined).
1089 * @param rcRZ The return code if the operation cannot be performed
1090 * in the current context.
1091 *
1092 * @remarks This function is used by both x2APIC interface and the Hyper-V
1093 * interface, see APICHvSetIcr. The Hyper-V spec isn't clear what
1094 * happens when invalid bits are set. For the time being, it will
1095 * \#GP like a regular x2APIC access.
1096 */
1097static VBOXSTRICTRC apicSetIcr(PVMCPUCC pVCpu, uint64_t u64Icr, int rcRZ)
1098{
1099 VMCPU_ASSERT_EMT(pVCpu);
1100
1101 /* Validate. */
1102 uint32_t const uLo = RT_LO_U32(u64Icr);
1103 if (RT_LIKELY(!(uLo & ~XAPIC_ICR_LO_WR_VALID)))
1104 {
1105 /* Update high dword first, then update the low dword which sends the IPI. */
1106 PX2APICPAGE pX2ApicPage = VMCPU_TO_X2APICPAGE(pVCpu);
1107 pX2ApicPage->icr_hi.u32IcrHi = RT_HI_U32(u64Icr);
1108 STAM_COUNTER_INC(&pVCpu->apic.s.StatIcrFullWrite);
1109 return apicSetIcrLo(pVCpu, uLo, rcRZ, false /* fUpdateStat */);
1110 }
1111 return apicMsrAccessError(pVCpu, MSR_IA32_X2APIC_ICR, APICMSRACCESS_WRITE_RSVD_BITS);
1112}
1113
1114
1115/**
1116 * Sets the Error Status Register (ESR).
1117 *
1118 * @returns VINF_SUCCESS or VERR_CPUM_RAISE_GP_0.
1119 * @param pVCpu The cross context virtual CPU structure.
1120 * @param uEsr The ESR value.
1121 */
1122static int apicSetEsr(PVMCPUCC pVCpu, uint32_t uEsr)
1123{
1124 VMCPU_ASSERT_EMT(pVCpu);
1125
1126 Log2(("APIC%u: apicSetEsr: uEsr=%#RX32\n", pVCpu->idCpu, uEsr));
1127
1128 if ( XAPIC_IN_X2APIC_MODE(pVCpu)
1129 && (uEsr & ~XAPIC_ESR_WO_VALID))
1130 return apicMsrAccessError(pVCpu, MSR_IA32_X2APIC_ESR, APICMSRACCESS_WRITE_RSVD_BITS);
1131
1132 /*
1133 * Writes to the ESR causes the internal state to be updated in the register,
1134 * clearing the original state. See AMD spec. 16.4.6 "APIC Error Interrupts".
1135 */
1136 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1137 pXApicPage->esr.all.u32Errors = apicClearAllErrors(pVCpu);
1138 return VINF_SUCCESS;
1139}
1140
1141
1142/**
1143 * Updates the Processor Priority Register (PPR).
1144 *
1145 * @param pVCpu The cross context virtual CPU structure.
1146 */
1147static void apicUpdatePpr(PVMCPUCC pVCpu)
1148{
1149 VMCPU_ASSERT_EMT(pVCpu);
1150
1151 /* See Intel spec 10.8.3.1 "Task and Processor Priorities". */
1152 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1153 uint8_t const uIsrv = apicGetHighestSetBitInReg(&pXApicPage->isr, 0 /* rcNotFound */);
1154 uint8_t uPpr;
1155 if (XAPIC_TPR_GET_TP(pXApicPage->tpr.u8Tpr) >= XAPIC_PPR_GET_PP(uIsrv))
1156 uPpr = pXApicPage->tpr.u8Tpr;
1157 else
1158 uPpr = XAPIC_PPR_GET_PP(uIsrv);
1159 pXApicPage->ppr.u8Ppr = uPpr;
1160}
1161
1162
1163/**
1164 * Gets the Processor Priority Register (PPR).
1165 *
1166 * @returns The PPR value.
1167 * @param pVCpu The cross context virtual CPU structure.
1168 */
1169static uint8_t apicGetPpr(PVMCPUCC pVCpu)
1170{
1171 VMCPU_ASSERT_EMT(pVCpu);
1172 STAM_COUNTER_INC(&pVCpu->apic.s.StatTprRead);
1173
1174 /*
1175 * With virtualized APIC registers or with TPR virtualization, the hardware may
1176 * update ISR/TPR transparently. We thus re-calculate the PPR which may be out of sync.
1177 * See Intel spec. 29.2.2 "Virtual-Interrupt Delivery".
1178 *
1179 * In all other instances, whenever the TPR or ISR changes, we need to update the PPR
1180 * as well (e.g. like we do manually in apicR3InitIpi and by calling apicUpdatePpr).
1181 */
1182 PCAPIC pApic = VM_TO_APIC(pVCpu->CTX_SUFF(pVM));
1183 if (pApic->fVirtApicRegsEnabled) /** @todo re-think this */
1184 apicUpdatePpr(pVCpu);
1185 PCXAPICPAGE pXApicPage = VMCPU_TO_CXAPICPAGE(pVCpu);
1186 return pXApicPage->ppr.u8Ppr;
1187}
1188
1189
1190/**
1191 * Sets the Task Priority Register (TPR).
1192 *
1193 * @returns VINF_SUCCESS or VERR_CPUM_RAISE_GP_0.
1194 * @param pVCpu The cross context virtual CPU structure.
1195 * @param uTpr The TPR value.
1196 * @param fForceX2ApicBehaviour Pretend the APIC is in x2APIC mode during
1197 * this write.
1198 */
1199static int apicSetTprEx(PVMCPUCC pVCpu, uint32_t uTpr, bool fForceX2ApicBehaviour)
1200{
1201 VMCPU_ASSERT_EMT(pVCpu);
1202
1203 Log2(("APIC%u: apicSetTprEx: uTpr=%#RX32\n", pVCpu->idCpu, uTpr));
1204 STAM_COUNTER_INC(&pVCpu->apic.s.StatTprWrite);
1205
1206 bool const fX2ApicMode = XAPIC_IN_X2APIC_MODE(pVCpu) || fForceX2ApicBehaviour;
1207 if ( fX2ApicMode
1208 && (uTpr & ~XAPIC_TPR_VALID))
1209 return apicMsrAccessError(pVCpu, MSR_IA32_X2APIC_TPR, APICMSRACCESS_WRITE_RSVD_BITS);
1210
1211 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1212 pXApicPage->tpr.u8Tpr = uTpr;
1213 apicUpdatePpr(pVCpu);
1214 apicSignalNextPendingIntr(pVCpu);
1215 return VINF_SUCCESS;
1216}
1217
1218
1219/**
1220 * Sets the End-Of-Interrupt (EOI) register.
1221 *
1222 * @returns Strict VBox status code.
1223 * @param pVCpu The cross context virtual CPU structure.
1224 * @param uEoi The EOI value.
1225 * @param rcBusy The busy return code when the write cannot
1226 * be completed successfully in this context.
1227 * @param fForceX2ApicBehaviour Pretend the APIC is in x2APIC mode during
1228 * this write.
1229 */
1230static VBOXSTRICTRC apicSetEoi(PVMCPUCC pVCpu, uint32_t uEoi, int rcBusy, bool fForceX2ApicBehaviour)
1231{
1232 VMCPU_ASSERT_EMT(pVCpu);
1233
1234 Log2(("APIC%u: apicSetEoi: uEoi=%#RX32\n", pVCpu->idCpu, uEoi));
1235 STAM_COUNTER_INC(&pVCpu->apic.s.StatEoiWrite);
1236
1237 bool const fX2ApicMode = XAPIC_IN_X2APIC_MODE(pVCpu) || fForceX2ApicBehaviour;
1238 if ( fX2ApicMode
1239 && (uEoi & ~XAPIC_EOI_WO_VALID))
1240 return apicMsrAccessError(pVCpu, MSR_IA32_X2APIC_EOI, APICMSRACCESS_WRITE_RSVD_BITS);
1241
1242 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1243 int isrv = apicGetHighestSetBitInReg(&pXApicPage->isr, -1 /* rcNotFound */);
1244 if (isrv >= 0)
1245 {
1246 /*
1247 * Broadcast the EOI to the I/O APIC(s).
1248 *
1249 * We'll handle the EOI broadcast first as there is tiny chance we get rescheduled to
1250 * ring-3 due to contention on the I/O APIC lock. This way we don't mess with the rest
1251 * of the APIC state and simply restart the EOI write operation from ring-3.
1252 */
1253 Assert(isrv <= (int)UINT8_MAX);
1254 uint8_t const uVector = isrv;
1255 bool const fLevelTriggered = apicTestVectorInReg(&pXApicPage->tmr, uVector);
1256 if (fLevelTriggered)
1257 {
1258 int rc = PDMIoApicBroadcastEoi(pVCpu->CTX_SUFF(pVM), uVector);
1259 if (rc == VINF_SUCCESS)
1260 { /* likely */ }
1261 else
1262 return rcBusy;
1263
1264 /*
1265 * Clear the vector from the TMR.
1266 *
1267 * The broadcast to I/O APIC can re-trigger new interrupts to arrive via the bus. However,
1268 * APICUpdatePendingInterrupts() which updates TMR can only be done from EMT which we
1269 * currently are on, so no possibility of concurrent updates.
1270 */
1271 apicClearVectorInReg(&pXApicPage->tmr, uVector);
1272
1273 /*
1274 * Clear the remote IRR bit for level-triggered, fixed mode LINT0 interrupt.
1275 * The LINT1 pin does not support level-triggered interrupts.
1276 * See Intel spec. 10.5.1 "Local Vector Table".
1277 */
1278 uint32_t const uLvtLint0 = pXApicPage->lvt_lint0.all.u32LvtLint0;
1279 if ( XAPIC_LVT_GET_REMOTE_IRR(uLvtLint0)
1280 && XAPIC_LVT_GET_VECTOR(uLvtLint0) == uVector
1281 && XAPIC_LVT_GET_DELIVERY_MODE(uLvtLint0) == XAPICDELIVERYMODE_FIXED)
1282 {
1283 ASMAtomicAndU32((volatile uint32_t *)&pXApicPage->lvt_lint0.all.u32LvtLint0, ~XAPIC_LVT_REMOTE_IRR);
1284 Log2(("APIC%u: apicSetEoi: Cleared remote-IRR for LINT0. uVector=%#x\n", pVCpu->idCpu, uVector));
1285 }
1286
1287 Log2(("APIC%u: apicSetEoi: Cleared level triggered interrupt from TMR. uVector=%#x\n", pVCpu->idCpu, uVector));
1288 }
1289
1290 /*
1291 * Mark interrupt as serviced, update the PPR and signal pending interrupts.
1292 */
1293 Log2(("APIC%u: apicSetEoi: Clearing interrupt from ISR. uVector=%#x\n", pVCpu->idCpu, uVector));
1294 apicClearVectorInReg(&pXApicPage->isr, uVector);
1295 apicUpdatePpr(pVCpu);
1296 apicSignalNextPendingIntr(pVCpu);
1297 }
1298 else
1299 {
1300#ifdef DEBUG_ramshankar
1301 /** @todo Figure out if this is done intentionally by guests or is a bug
1302 * in our emulation. Happened with Win10 SMP VM during reboot after
1303 * installation of guest additions with 3D support. */
1304 AssertMsgFailed(("APIC%u: apicSetEoi: Failed to find any ISR bit\n", pVCpu->idCpu));
1305#endif
1306 }
1307
1308 return VINF_SUCCESS;
1309}
1310
1311
1312/**
1313 * Sets the Logical Destination Register (LDR).
1314 *
1315 * @returns Strict VBox status code.
1316 * @param pVCpu The cross context virtual CPU structure.
1317 * @param uLdr The LDR value.
1318 *
1319 * @remarks LDR is read-only in x2APIC mode.
1320 */
1321static VBOXSTRICTRC apicSetLdr(PVMCPUCC pVCpu, uint32_t uLdr)
1322{
1323 VMCPU_ASSERT_EMT(pVCpu);
1324 PCAPIC pApic = VM_TO_APIC(pVCpu->CTX_SUFF(pVM));
1325 Assert(!XAPIC_IN_X2APIC_MODE(pVCpu) || pApic->fHyperVCompatMode); RT_NOREF_PV(pApic);
1326
1327 Log2(("APIC%u: apicSetLdr: uLdr=%#RX32\n", pVCpu->idCpu, uLdr));
1328
1329 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1330 apicWriteRaw32(pXApicPage, XAPIC_OFF_LDR, uLdr & XAPIC_LDR_VALID);
1331 return VINF_SUCCESS;
1332}
1333
1334
1335/**
1336 * Sets the Destination Format Register (DFR).
1337 *
1338 * @returns Strict VBox status code.
1339 * @param pVCpu The cross context virtual CPU structure.
1340 * @param uDfr The DFR value.
1341 *
1342 * @remarks DFR is not available in x2APIC mode.
1343 */
1344static VBOXSTRICTRC apicSetDfr(PVMCPUCC pVCpu, uint32_t uDfr)
1345{
1346 VMCPU_ASSERT_EMT(pVCpu);
1347 Assert(!XAPIC_IN_X2APIC_MODE(pVCpu));
1348
1349 uDfr &= XAPIC_DFR_VALID;
1350 uDfr |= XAPIC_DFR_RSVD_MB1;
1351
1352 Log2(("APIC%u: apicSetDfr: uDfr=%#RX32\n", pVCpu->idCpu, uDfr));
1353
1354 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1355 apicWriteRaw32(pXApicPage, XAPIC_OFF_DFR, uDfr);
1356 return VINF_SUCCESS;
1357}
1358
1359
1360/**
1361 * Sets the Timer Divide Configuration Register (DCR).
1362 *
1363 * @returns Strict VBox status code.
1364 * @param pVCpu The cross context virtual CPU structure.
1365 * @param uTimerDcr The timer DCR value.
1366 */
1367static VBOXSTRICTRC apicSetTimerDcr(PVMCPUCC pVCpu, uint32_t uTimerDcr)
1368{
1369 VMCPU_ASSERT_EMT(pVCpu);
1370 if ( XAPIC_IN_X2APIC_MODE(pVCpu)
1371 && (uTimerDcr & ~XAPIC_TIMER_DCR_VALID))
1372 return apicMsrAccessError(pVCpu, MSR_IA32_X2APIC_TIMER_DCR, APICMSRACCESS_WRITE_RSVD_BITS);
1373
1374 Log2(("APIC%u: apicSetTimerDcr: uTimerDcr=%#RX32\n", pVCpu->idCpu, uTimerDcr));
1375
1376 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1377 apicWriteRaw32(pXApicPage, XAPIC_OFF_TIMER_DCR, uTimerDcr);
1378 return VINF_SUCCESS;
1379}
1380
1381
1382/**
1383 * Gets the timer's Current Count Register (CCR).
1384 *
1385 * @returns VBox status code.
1386 * @param pVCpu The cross context virtual CPU structure.
1387 * @param rcBusy The busy return code for the timer critical section.
1388 * @param puValue Where to store the LVT timer CCR.
1389 */
1390static VBOXSTRICTRC apicGetTimerCcr(PVMCPUCC pVCpu, int rcBusy, uint32_t *puValue)
1391{
1392 VMCPU_ASSERT_EMT(pVCpu);
1393 Assert(puValue);
1394
1395 PCXAPICPAGE pXApicPage = VMCPU_TO_CXAPICPAGE(pVCpu);
1396 *puValue = 0;
1397
1398 /* In TSC-deadline mode, CCR returns 0, see Intel spec. 10.5.4.1 "TSC-Deadline Mode". */
1399 if (pXApicPage->lvt_timer.u.u2TimerMode == XAPIC_TIMER_MODE_TSC_DEADLINE)
1400 return VINF_SUCCESS;
1401
1402 /* If the initial-count register is 0, CCR returns 0 as it cannot exceed the ICR. */
1403 uint32_t const uInitialCount = pXApicPage->timer_icr.u32InitialCount;
1404 if (!uInitialCount)
1405 return VINF_SUCCESS;
1406
1407 /*
1408 * Reading the virtual-sync clock requires locking its timer because it's not
1409 * a simple atomic operation, see tmVirtualSyncGetEx().
1410 *
1411 * We also need to lock before reading the timer CCR, see apicR3TimerCallback().
1412 */
1413 PCAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
1414 PTMTIMER pTimer = pApicCpu->CTX_SUFF(pTimer);
1415
1416 int rc = TMTimerLock(pTimer, rcBusy);
1417 if (rc == VINF_SUCCESS)
1418 {
1419 /* If the current-count register is 0, it implies the timer expired. */
1420 uint32_t const uCurrentCount = pXApicPage->timer_ccr.u32CurrentCount;
1421 if (uCurrentCount)
1422 {
1423 uint64_t const cTicksElapsed = TMTimerGet(pApicCpu->CTX_SUFF(pTimer)) - pApicCpu->u64TimerInitial;
1424 TMTimerUnlock(pTimer);
1425 uint8_t const uTimerShift = apicGetTimerShift(pXApicPage);
1426 uint64_t const uDelta = cTicksElapsed >> uTimerShift;
1427 if (uInitialCount > uDelta)
1428 *puValue = uInitialCount - uDelta;
1429 }
1430 else
1431 TMTimerUnlock(pTimer);
1432 }
1433 return rc;
1434}
1435
1436
1437/**
1438 * Sets the timer's Initial-Count Register (ICR).
1439 *
1440 * @returns Strict VBox status code.
1441 * @param pVCpu The cross context virtual CPU structure.
1442 * @param rcBusy The busy return code for the timer critical section.
1443 * @param uInitialCount The timer ICR.
1444 */
1445static VBOXSTRICTRC apicSetTimerIcr(PVMCPUCC pVCpu, int rcBusy, uint32_t uInitialCount)
1446{
1447 VMCPU_ASSERT_EMT(pVCpu);
1448
1449 PAPIC pApic = VM_TO_APIC(pVCpu->CTX_SUFF(pVM));
1450 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
1451 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1452 PTMTIMER pTimer = pApicCpu->CTX_SUFF(pTimer);
1453
1454 Log2(("APIC%u: apicSetTimerIcr: uInitialCount=%#RX32\n", pVCpu->idCpu, uInitialCount));
1455 STAM_COUNTER_INC(&pApicCpu->StatTimerIcrWrite);
1456
1457 /* In TSC-deadline mode, timer ICR writes are ignored, see Intel spec. 10.5.4.1 "TSC-Deadline Mode". */
1458 if ( pApic->fSupportsTscDeadline
1459 && pXApicPage->lvt_timer.u.u2TimerMode == XAPIC_TIMER_MODE_TSC_DEADLINE)
1460 return VINF_SUCCESS;
1461
1462 /*
1463 * The timer CCR may be modified by apicR3TimerCallback() in parallel,
1464 * so obtain the lock -before- updating it here to be consistent with the
1465 * timer ICR. We rely on CCR being consistent in apicGetTimerCcr().
1466 */
1467 int rc = TMTimerLock(pTimer, rcBusy);
1468 if (rc == VINF_SUCCESS)
1469 {
1470 pXApicPage->timer_icr.u32InitialCount = uInitialCount;
1471 pXApicPage->timer_ccr.u32CurrentCount = uInitialCount;
1472 if (uInitialCount)
1473 apicStartTimer(pVCpu, uInitialCount);
1474 else
1475 apicStopTimer(pVCpu);
1476 TMTimerUnlock(pTimer);
1477 }
1478 return rc;
1479}
1480
1481
1482/**
1483 * Sets an LVT entry.
1484 *
1485 * @returns Strict VBox status code.
1486 * @param pVCpu The cross context virtual CPU structure.
1487 * @param offLvt The LVT entry offset in the xAPIC page.
1488 * @param uLvt The LVT value to set.
1489 */
1490static VBOXSTRICTRC apicSetLvtEntry(PVMCPUCC pVCpu, uint16_t offLvt, uint32_t uLvt)
1491{
1492 VMCPU_ASSERT_EMT(pVCpu);
1493
1494#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
1495 AssertMsg( offLvt == XAPIC_OFF_LVT_TIMER
1496 || offLvt == XAPIC_OFF_LVT_THERMAL
1497 || offLvt == XAPIC_OFF_LVT_PERF
1498 || offLvt == XAPIC_OFF_LVT_LINT0
1499 || offLvt == XAPIC_OFF_LVT_LINT1
1500 || offLvt == XAPIC_OFF_LVT_ERROR,
1501 ("APIC%u: apicSetLvtEntry: invalid offset, offLvt=%#RX16, uLvt=%#RX32\n", pVCpu->idCpu, offLvt, uLvt));
1502
1503 /*
1504 * If TSC-deadline mode isn't support, ignore the bit in xAPIC mode
1505 * and raise #GP(0) in x2APIC mode.
1506 */
1507 PCAPIC pApic = VM_TO_APIC(pVCpu->CTX_SUFF(pVM));
1508 if (offLvt == XAPIC_OFF_LVT_TIMER)
1509 {
1510 if ( !pApic->fSupportsTscDeadline
1511 && (uLvt & XAPIC_LVT_TIMER_TSCDEADLINE))
1512 {
1513 if (XAPIC_IN_X2APIC_MODE(pVCpu))
1514 return apicMsrAccessError(pVCpu, XAPIC_GET_X2APIC_MSR(offLvt), APICMSRACCESS_WRITE_RSVD_BITS);
1515 uLvt &= ~XAPIC_LVT_TIMER_TSCDEADLINE;
1516 /** @todo TSC-deadline timer mode transition */
1517 }
1518 }
1519
1520 /*
1521 * Validate rest of the LVT bits.
1522 */
1523 uint16_t const idxLvt = (offLvt - XAPIC_OFF_LVT_START) >> 4;
1524 AssertReturn(idxLvt < RT_ELEMENTS(g_au32LvtValidMasks), VERR_OUT_OF_RANGE);
1525
1526 /*
1527 * For x2APIC, disallow setting of invalid/reserved bits.
1528 * For xAPIC, mask out invalid/reserved bits (i.e. ignore them).
1529 */
1530 if ( XAPIC_IN_X2APIC_MODE(pVCpu)
1531 && (uLvt & ~g_au32LvtValidMasks[idxLvt]))
1532 return apicMsrAccessError(pVCpu, XAPIC_GET_X2APIC_MSR(offLvt), APICMSRACCESS_WRITE_RSVD_BITS);
1533
1534 uLvt &= g_au32LvtValidMasks[idxLvt];
1535
1536 /*
1537 * In the software-disabled state, LVT mask-bit must remain set and attempts to clear the mask
1538 * bit must be ignored. See Intel spec. 10.4.7.2 "Local APIC State After It Has Been Software Disabled".
1539 */
1540 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1541 if (!pXApicPage->svr.u.fApicSoftwareEnable)
1542 uLvt |= XAPIC_LVT_MASK;
1543
1544 /*
1545 * It is unclear whether we should signal a 'send illegal vector' error here and ignore updating
1546 * the LVT entry when the delivery mode is 'fixed'[1] or update it in addition to signalling the
1547 * error or not signal the error at all. For now, we'll allow setting illegal vectors into the LVT
1548 * but set the 'send illegal vector' error here. The 'receive illegal vector' error will be set if
1549 * the interrupt for the vector happens to be generated, see apicPostInterrupt().
1550 *
1551 * [1] See Intel spec. 10.5.2 "Valid Interrupt Vectors".
1552 */
1553 if (RT_UNLIKELY( XAPIC_LVT_GET_VECTOR(uLvt) <= XAPIC_ILLEGAL_VECTOR_END
1554 && XAPIC_LVT_GET_DELIVERY_MODE(uLvt) == XAPICDELIVERYMODE_FIXED))
1555 apicSetError(pVCpu, XAPIC_ESR_SEND_ILLEGAL_VECTOR);
1556
1557 Log2(("APIC%u: apicSetLvtEntry: offLvt=%#RX16 uLvt=%#RX32\n", pVCpu->idCpu, offLvt, uLvt));
1558
1559 apicWriteRaw32(pXApicPage, offLvt, uLvt);
1560 return VINF_SUCCESS;
1561#else
1562# error "Implement Pentium and P6 family APIC architectures"
1563#endif /* XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4 */
1564}
1565
1566
1567#if 0
1568/**
1569 * Sets an LVT entry in the extended LVT range.
1570 *
1571 * @returns VBox status code.
1572 * @param pVCpu The cross context virtual CPU structure.
1573 * @param offLvt The LVT entry offset in the xAPIC page.
1574 * @param uValue The LVT value to set.
1575 */
1576static int apicSetLvtExtEntry(PVMCPUCC pVCpu, uint16_t offLvt, uint32_t uLvt)
1577{
1578 VMCPU_ASSERT_EMT(pVCpu);
1579 AssertMsg(offLvt == XAPIC_OFF_CMCI, ("APIC%u: apicSetLvt1Entry: invalid offset %#RX16\n", pVCpu->idCpu, offLvt));
1580
1581 /** @todo support CMCI. */
1582 return VERR_NOT_IMPLEMENTED;
1583}
1584#endif
1585
1586
1587/**
1588 * Hints TM about the APIC timer frequency.
1589 *
1590 * @param pApicCpu The APIC CPU state.
1591 * @param uInitialCount The new initial count.
1592 * @param uTimerShift The new timer shift.
1593 * @thread Any.
1594 */
1595void apicHintTimerFreq(PAPICCPU pApicCpu, uint32_t uInitialCount, uint8_t uTimerShift)
1596{
1597 Assert(pApicCpu);
1598
1599 if ( pApicCpu->uHintedTimerInitialCount != uInitialCount
1600 || pApicCpu->uHintedTimerShift != uTimerShift)
1601 {
1602 uint32_t uHz;
1603 if (uInitialCount)
1604 {
1605 uint64_t cTicksPerPeriod = (uint64_t)uInitialCount << uTimerShift;
1606 uHz = TMTimerGetFreq(pApicCpu->CTX_SUFF(pTimer)) / cTicksPerPeriod;
1607 }
1608 else
1609 uHz = 0;
1610
1611 TMTimerSetFrequencyHint(pApicCpu->CTX_SUFF(pTimer), uHz);
1612 pApicCpu->uHintedTimerInitialCount = uInitialCount;
1613 pApicCpu->uHintedTimerShift = uTimerShift;
1614 }
1615}
1616
1617
1618/**
1619 * Gets the Interrupt Command Register (ICR), without performing any interface
1620 * checks.
1621 *
1622 * @returns The ICR value.
1623 * @param pVCpu The cross context virtual CPU structure.
1624 */
1625DECLINLINE(uint64_t) apicGetIcrNoCheck(PVMCPUCC pVCpu)
1626{
1627 PCX2APICPAGE pX2ApicPage = VMCPU_TO_CX2APICPAGE(pVCpu);
1628 uint64_t const uHi = pX2ApicPage->icr_hi.u32IcrHi;
1629 uint64_t const uLo = pX2ApicPage->icr_lo.all.u32IcrLo;
1630 uint64_t const uIcr = RT_MAKE_U64(uLo, uHi);
1631 return uIcr;
1632}
1633
1634
1635/**
1636 * Reads an APIC register.
1637 *
1638 * @returns VBox status code.
1639 * @param pApicDev The APIC device instance.
1640 * @param pVCpu The cross context virtual CPU structure.
1641 * @param offReg The offset of the register being read.
1642 * @param puValue Where to store the register value.
1643 */
1644DECLINLINE(VBOXSTRICTRC) apicReadRegister(PAPICDEV pApicDev, PVMCPUCC pVCpu, uint16_t offReg, uint32_t *puValue)
1645{
1646 VMCPU_ASSERT_EMT(pVCpu);
1647 Assert(offReg <= XAPIC_OFF_MAX_VALID);
1648
1649 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1650 uint32_t uValue = 0;
1651 VBOXSTRICTRC rc = VINF_SUCCESS;
1652 switch (offReg)
1653 {
1654 case XAPIC_OFF_ID:
1655 case XAPIC_OFF_VERSION:
1656 case XAPIC_OFF_TPR:
1657 case XAPIC_OFF_EOI:
1658 case XAPIC_OFF_RRD:
1659 case XAPIC_OFF_LDR:
1660 case XAPIC_OFF_DFR:
1661 case XAPIC_OFF_SVR:
1662 case XAPIC_OFF_ISR0: case XAPIC_OFF_ISR1: case XAPIC_OFF_ISR2: case XAPIC_OFF_ISR3:
1663 case XAPIC_OFF_ISR4: case XAPIC_OFF_ISR5: case XAPIC_OFF_ISR6: case XAPIC_OFF_ISR7:
1664 case XAPIC_OFF_TMR0: case XAPIC_OFF_TMR1: case XAPIC_OFF_TMR2: case XAPIC_OFF_TMR3:
1665 case XAPIC_OFF_TMR4: case XAPIC_OFF_TMR5: case XAPIC_OFF_TMR6: case XAPIC_OFF_TMR7:
1666 case XAPIC_OFF_IRR0: case XAPIC_OFF_IRR1: case XAPIC_OFF_IRR2: case XAPIC_OFF_IRR3:
1667 case XAPIC_OFF_IRR4: case XAPIC_OFF_IRR5: case XAPIC_OFF_IRR6: case XAPIC_OFF_IRR7:
1668 case XAPIC_OFF_ESR:
1669 case XAPIC_OFF_ICR_LO:
1670 case XAPIC_OFF_ICR_HI:
1671 case XAPIC_OFF_LVT_TIMER:
1672#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
1673 case XAPIC_OFF_LVT_THERMAL:
1674#endif
1675 case XAPIC_OFF_LVT_PERF:
1676 case XAPIC_OFF_LVT_LINT0:
1677 case XAPIC_OFF_LVT_LINT1:
1678 case XAPIC_OFF_LVT_ERROR:
1679 case XAPIC_OFF_TIMER_ICR:
1680 case XAPIC_OFF_TIMER_DCR:
1681 {
1682 Assert( !XAPIC_IN_X2APIC_MODE(pVCpu)
1683 || ( offReg != XAPIC_OFF_DFR
1684 && offReg != XAPIC_OFF_ICR_HI
1685 && offReg != XAPIC_OFF_EOI));
1686 uValue = apicReadRaw32(pXApicPage, offReg);
1687 Log2(("APIC%u: apicReadRegister: offReg=%#x uValue=%#x\n", pVCpu->idCpu, offReg, uValue));
1688 break;
1689 }
1690
1691 case XAPIC_OFF_PPR:
1692 {
1693 uValue = apicGetPpr(pVCpu);
1694 break;
1695 }
1696
1697 case XAPIC_OFF_TIMER_CCR:
1698 {
1699 Assert(!XAPIC_IN_X2APIC_MODE(pVCpu));
1700 rc = apicGetTimerCcr(pVCpu, VINF_IOM_R3_MMIO_READ, &uValue);
1701 break;
1702 }
1703
1704 case XAPIC_OFF_APR:
1705 {
1706#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
1707 /* Unsupported on Pentium 4 and Xeon CPUs, invalid in x2APIC mode. */
1708 Assert(!XAPIC_IN_X2APIC_MODE(pVCpu));
1709#else
1710# error "Implement Pentium and P6 family APIC architectures"
1711#endif
1712 break;
1713 }
1714
1715 default:
1716 {
1717 Assert(!XAPIC_IN_X2APIC_MODE(pVCpu));
1718 rc = PDMDevHlpDBGFStop(pApicDev->CTX_SUFF(pDevIns), RT_SRC_POS, "VCPU[%u]: offReg=%#RX16\n", pVCpu->idCpu,
1719 offReg);
1720 apicSetError(pVCpu, XAPIC_ESR_ILLEGAL_REG_ADDRESS);
1721 break;
1722 }
1723 }
1724
1725 *puValue = uValue;
1726 return rc;
1727}
1728
1729
1730/**
1731 * Writes an APIC register.
1732 *
1733 * @returns Strict VBox status code.
1734 * @param pApicDev The APIC device instance.
1735 * @param pVCpu The cross context virtual CPU structure.
1736 * @param offReg The offset of the register being written.
1737 * @param uValue The register value.
1738 */
1739DECLINLINE(VBOXSTRICTRC) apicWriteRegister(PAPICDEV pApicDev, PVMCPUCC pVCpu, uint16_t offReg, uint32_t uValue)
1740{
1741 VMCPU_ASSERT_EMT(pVCpu);
1742 Assert(offReg <= XAPIC_OFF_MAX_VALID);
1743 Assert(!XAPIC_IN_X2APIC_MODE(pVCpu));
1744
1745 VBOXSTRICTRC rcStrict = VINF_SUCCESS;
1746 switch (offReg)
1747 {
1748 case XAPIC_OFF_TPR:
1749 {
1750 rcStrict = apicSetTprEx(pVCpu, uValue, false /* fForceX2ApicBehaviour */);
1751 break;
1752 }
1753
1754 case XAPIC_OFF_LVT_TIMER:
1755#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
1756 case XAPIC_OFF_LVT_THERMAL:
1757#endif
1758 case XAPIC_OFF_LVT_PERF:
1759 case XAPIC_OFF_LVT_LINT0:
1760 case XAPIC_OFF_LVT_LINT1:
1761 case XAPIC_OFF_LVT_ERROR:
1762 {
1763 rcStrict = apicSetLvtEntry(pVCpu, offReg, uValue);
1764 break;
1765 }
1766
1767 case XAPIC_OFF_TIMER_ICR:
1768 {
1769 rcStrict = apicSetTimerIcr(pVCpu, VINF_IOM_R3_MMIO_WRITE, uValue);
1770 break;
1771 }
1772
1773 case XAPIC_OFF_EOI:
1774 {
1775 rcStrict = apicSetEoi(pVCpu, uValue, VINF_IOM_R3_MMIO_WRITE, false /* fForceX2ApicBehaviour */);
1776 break;
1777 }
1778
1779 case XAPIC_OFF_LDR:
1780 {
1781 rcStrict = apicSetLdr(pVCpu, uValue);
1782 break;
1783 }
1784
1785 case XAPIC_OFF_DFR:
1786 {
1787 rcStrict = apicSetDfr(pVCpu, uValue);
1788 break;
1789 }
1790
1791 case XAPIC_OFF_SVR:
1792 {
1793 rcStrict = apicSetSvr(pVCpu, uValue);
1794 break;
1795 }
1796
1797 case XAPIC_OFF_ICR_LO:
1798 {
1799 rcStrict = apicSetIcrLo(pVCpu, uValue, VINF_IOM_R3_MMIO_WRITE, true /* fUpdateStat */);
1800 break;
1801 }
1802
1803 case XAPIC_OFF_ICR_HI:
1804 {
1805 rcStrict = apicSetIcrHi(pVCpu, uValue);
1806 break;
1807 }
1808
1809 case XAPIC_OFF_TIMER_DCR:
1810 {
1811 rcStrict = apicSetTimerDcr(pVCpu, uValue);
1812 break;
1813 }
1814
1815 case XAPIC_OFF_ESR:
1816 {
1817 rcStrict = apicSetEsr(pVCpu, uValue);
1818 break;
1819 }
1820
1821 case XAPIC_OFF_APR:
1822 case XAPIC_OFF_RRD:
1823 {
1824#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
1825 /* Unsupported on Pentium 4 and Xeon CPUs but writes do -not- set an illegal register access error. */
1826#else
1827# error "Implement Pentium and P6 family APIC architectures"
1828#endif
1829 break;
1830 }
1831
1832 /* Read-only, write ignored: */
1833 case XAPIC_OFF_VERSION:
1834 case XAPIC_OFF_ID:
1835 break;
1836
1837 /* Unavailable/reserved in xAPIC mode: */
1838 case X2APIC_OFF_SELF_IPI:
1839 /* Read-only registers: */
1840 case XAPIC_OFF_PPR:
1841 case XAPIC_OFF_ISR0: case XAPIC_OFF_ISR1: case XAPIC_OFF_ISR2: case XAPIC_OFF_ISR3:
1842 case XAPIC_OFF_ISR4: case XAPIC_OFF_ISR5: case XAPIC_OFF_ISR6: case XAPIC_OFF_ISR7:
1843 case XAPIC_OFF_TMR0: case XAPIC_OFF_TMR1: case XAPIC_OFF_TMR2: case XAPIC_OFF_TMR3:
1844 case XAPIC_OFF_TMR4: case XAPIC_OFF_TMR5: case XAPIC_OFF_TMR6: case XAPIC_OFF_TMR7:
1845 case XAPIC_OFF_IRR0: case XAPIC_OFF_IRR1: case XAPIC_OFF_IRR2: case XAPIC_OFF_IRR3:
1846 case XAPIC_OFF_IRR4: case XAPIC_OFF_IRR5: case XAPIC_OFF_IRR6: case XAPIC_OFF_IRR7:
1847 case XAPIC_OFF_TIMER_CCR:
1848 default:
1849 {
1850 rcStrict = PDMDevHlpDBGFStop(pApicDev->CTX_SUFF(pDevIns), RT_SRC_POS, "APIC%u: offReg=%#RX16\n", pVCpu->idCpu,
1851 offReg);
1852 apicSetError(pVCpu, XAPIC_ESR_ILLEGAL_REG_ADDRESS);
1853 break;
1854 }
1855 }
1856
1857 return rcStrict;
1858}
1859
1860
1861/**
1862 * Reads an APIC MSR.
1863 *
1864 * @returns Strict VBox status code.
1865 * @param pVCpu The cross context virtual CPU structure.
1866 * @param u32Reg The MSR being read.
1867 * @param pu64Value Where to store the read value.
1868 */
1869VMM_INT_DECL(VBOXSTRICTRC) APICReadMsr(PVMCPUCC pVCpu, uint32_t u32Reg, uint64_t *pu64Value)
1870{
1871 /*
1872 * Validate.
1873 */
1874 VMCPU_ASSERT_EMT(pVCpu);
1875 Assert(u32Reg >= MSR_IA32_X2APIC_ID && u32Reg <= MSR_IA32_X2APIC_SELF_IPI);
1876 Assert(pu64Value);
1877
1878 /*
1879 * Is the APIC enabled?
1880 */
1881 PCAPIC pApic = VM_TO_APIC(pVCpu->CTX_SUFF(pVM));
1882 if (APICIsEnabled(pVCpu))
1883 { /* likely */ }
1884 else
1885 {
1886 return apicMsrAccessError(pVCpu, u32Reg, pApic->enmMaxMode == PDMAPICMODE_NONE ?
1887 APICMSRACCESS_READ_DISALLOWED_CONFIG : APICMSRACCESS_READ_RSVD_OR_UNKNOWN);
1888 }
1889
1890#ifndef IN_RING3
1891 if (pApic->fRZEnabled)
1892 { /* likely */}
1893 else
1894 return VINF_CPUM_R3_MSR_READ;
1895#endif
1896
1897 STAM_COUNTER_INC(&pVCpu->apic.s.CTX_SUFF_Z(StatMsrRead));
1898
1899 VBOXSTRICTRC rcStrict = VINF_SUCCESS;
1900 if (RT_LIKELY( XAPIC_IN_X2APIC_MODE(pVCpu)
1901 || pApic->fHyperVCompatMode))
1902 {
1903 switch (u32Reg)
1904 {
1905 /* Special handling for x2APIC: */
1906 case MSR_IA32_X2APIC_ICR:
1907 {
1908 *pu64Value = apicGetIcrNoCheck(pVCpu);
1909 break;
1910 }
1911
1912 /* Special handling, compatible with xAPIC: */
1913 case MSR_IA32_X2APIC_TIMER_CCR:
1914 {
1915 uint32_t uValue;
1916 rcStrict = apicGetTimerCcr(pVCpu, VINF_CPUM_R3_MSR_READ, &uValue);
1917 *pu64Value = uValue;
1918 break;
1919 }
1920
1921 /* Special handling, compatible with xAPIC: */
1922 case MSR_IA32_X2APIC_PPR:
1923 {
1924 *pu64Value = apicGetPpr(pVCpu);
1925 break;
1926 }
1927
1928 /* Raw read, compatible with xAPIC: */
1929 case MSR_IA32_X2APIC_ID:
1930 case MSR_IA32_X2APIC_VERSION:
1931 case MSR_IA32_X2APIC_TPR:
1932 case MSR_IA32_X2APIC_LDR:
1933 case MSR_IA32_X2APIC_SVR:
1934 case MSR_IA32_X2APIC_ISR0: case MSR_IA32_X2APIC_ISR1: case MSR_IA32_X2APIC_ISR2: case MSR_IA32_X2APIC_ISR3:
1935 case MSR_IA32_X2APIC_ISR4: case MSR_IA32_X2APIC_ISR5: case MSR_IA32_X2APIC_ISR6: case MSR_IA32_X2APIC_ISR7:
1936 case MSR_IA32_X2APIC_TMR0: case MSR_IA32_X2APIC_TMR1: case MSR_IA32_X2APIC_TMR2: case MSR_IA32_X2APIC_TMR3:
1937 case MSR_IA32_X2APIC_TMR4: case MSR_IA32_X2APIC_TMR5: case MSR_IA32_X2APIC_TMR6: case MSR_IA32_X2APIC_TMR7:
1938 case MSR_IA32_X2APIC_IRR0: case MSR_IA32_X2APIC_IRR1: case MSR_IA32_X2APIC_IRR2: case MSR_IA32_X2APIC_IRR3:
1939 case MSR_IA32_X2APIC_IRR4: case MSR_IA32_X2APIC_IRR5: case MSR_IA32_X2APIC_IRR6: case MSR_IA32_X2APIC_IRR7:
1940 case MSR_IA32_X2APIC_ESR:
1941 case MSR_IA32_X2APIC_LVT_TIMER:
1942 case MSR_IA32_X2APIC_LVT_THERMAL:
1943 case MSR_IA32_X2APIC_LVT_PERF:
1944 case MSR_IA32_X2APIC_LVT_LINT0:
1945 case MSR_IA32_X2APIC_LVT_LINT1:
1946 case MSR_IA32_X2APIC_LVT_ERROR:
1947 case MSR_IA32_X2APIC_TIMER_ICR:
1948 case MSR_IA32_X2APIC_TIMER_DCR:
1949 {
1950 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
1951 uint16_t const offReg = X2APIC_GET_XAPIC_OFF(u32Reg);
1952 *pu64Value = apicReadRaw32(pXApicPage, offReg);
1953 break;
1954 }
1955
1956 /* Write-only MSRs: */
1957 case MSR_IA32_X2APIC_SELF_IPI:
1958 case MSR_IA32_X2APIC_EOI:
1959 {
1960 rcStrict = apicMsrAccessError(pVCpu, u32Reg, APICMSRACCESS_READ_WRITE_ONLY);
1961 break;
1962 }
1963
1964 /*
1965 * Windows guest using Hyper-V x2APIC MSR compatibility mode tries to read the "high"
1966 * LDR bits, which is quite absurd (as it's a 32-bit register) using this invalid MSR
1967 * index (0x80E), see @bugref{8382#c175}.
1968 */
1969 case MSR_IA32_X2APIC_LDR + 1:
1970 {
1971 if (pApic->fHyperVCompatMode)
1972 *pu64Value = 0;
1973 else
1974 rcStrict = apicMsrAccessError(pVCpu, u32Reg, APICMSRACCESS_READ_RSVD_OR_UNKNOWN);
1975 break;
1976 }
1977
1978 /* Reserved MSRs: */
1979 case MSR_IA32_X2APIC_LVT_CMCI:
1980 default:
1981 {
1982 rcStrict = apicMsrAccessError(pVCpu, u32Reg, APICMSRACCESS_READ_RSVD_OR_UNKNOWN);
1983 break;
1984 }
1985 }
1986 }
1987 else
1988 rcStrict = apicMsrAccessError(pVCpu, u32Reg, APICMSRACCESS_INVALID_READ_MODE);
1989
1990 return rcStrict;
1991}
1992
1993
1994/**
1995 * Writes an APIC MSR.
1996 *
1997 * @returns Strict VBox status code.
1998 * @param pVCpu The cross context virtual CPU structure.
1999 * @param u32Reg The MSR being written.
2000 * @param u64Value The value to write.
2001 */
2002VMM_INT_DECL(VBOXSTRICTRC) APICWriteMsr(PVMCPUCC pVCpu, uint32_t u32Reg, uint64_t u64Value)
2003{
2004 /*
2005 * Validate.
2006 */
2007 VMCPU_ASSERT_EMT(pVCpu);
2008 Assert(u32Reg >= MSR_IA32_X2APIC_ID && u32Reg <= MSR_IA32_X2APIC_SELF_IPI);
2009
2010 /*
2011 * Is the APIC enabled?
2012 */
2013 PCAPIC pApic = VM_TO_APIC(pVCpu->CTX_SUFF(pVM));
2014 if (APICIsEnabled(pVCpu))
2015 { /* likely */ }
2016 else
2017 {
2018 return apicMsrAccessError(pVCpu, u32Reg, pApic->enmMaxMode == PDMAPICMODE_NONE ?
2019 APICMSRACCESS_WRITE_DISALLOWED_CONFIG : APICMSRACCESS_WRITE_RSVD_OR_UNKNOWN);
2020 }
2021
2022#ifndef IN_RING3
2023 if (pApic->fRZEnabled)
2024 { /* likely */ }
2025 else
2026 return VINF_CPUM_R3_MSR_WRITE;
2027#endif
2028
2029 STAM_COUNTER_INC(&pVCpu->apic.s.CTX_SUFF_Z(StatMsrWrite));
2030
2031 /*
2032 * In x2APIC mode, we need to raise #GP(0) for writes to reserved bits, unlike MMIO
2033 * accesses where they are ignored. Hence, we need to validate each register before
2034 * invoking the generic/xAPIC write functions.
2035 *
2036 * Bits 63:32 of all registers except the ICR are reserved, we'll handle this common
2037 * case first and handle validating the remaining bits on a per-register basis.
2038 * See Intel spec. 10.12.1.2 "x2APIC Register Address Space".
2039 */
2040 if ( u32Reg != MSR_IA32_X2APIC_ICR
2041 && RT_HI_U32(u64Value))
2042 return apicMsrAccessError(pVCpu, u32Reg, APICMSRACCESS_WRITE_RSVD_BITS);
2043
2044 uint32_t u32Value = RT_LO_U32(u64Value);
2045 VBOXSTRICTRC rcStrict = VINF_SUCCESS;
2046 if (RT_LIKELY( XAPIC_IN_X2APIC_MODE(pVCpu)
2047 || pApic->fHyperVCompatMode))
2048 {
2049 switch (u32Reg)
2050 {
2051 case MSR_IA32_X2APIC_TPR:
2052 {
2053 rcStrict = apicSetTprEx(pVCpu, u32Value, false /* fForceX2ApicBehaviour */);
2054 break;
2055 }
2056
2057 case MSR_IA32_X2APIC_ICR:
2058 {
2059 rcStrict = apicSetIcr(pVCpu, u64Value, VINF_CPUM_R3_MSR_WRITE);
2060 break;
2061 }
2062
2063 case MSR_IA32_X2APIC_SVR:
2064 {
2065 rcStrict = apicSetSvr(pVCpu, u32Value);
2066 break;
2067 }
2068
2069 case MSR_IA32_X2APIC_ESR:
2070 {
2071 rcStrict = apicSetEsr(pVCpu, u32Value);
2072 break;
2073 }
2074
2075 case MSR_IA32_X2APIC_TIMER_DCR:
2076 {
2077 rcStrict = apicSetTimerDcr(pVCpu, u32Value);
2078 break;
2079 }
2080
2081 case MSR_IA32_X2APIC_LVT_TIMER:
2082 case MSR_IA32_X2APIC_LVT_THERMAL:
2083 case MSR_IA32_X2APIC_LVT_PERF:
2084 case MSR_IA32_X2APIC_LVT_LINT0:
2085 case MSR_IA32_X2APIC_LVT_LINT1:
2086 case MSR_IA32_X2APIC_LVT_ERROR:
2087 {
2088 rcStrict = apicSetLvtEntry(pVCpu, X2APIC_GET_XAPIC_OFF(u32Reg), u32Value);
2089 break;
2090 }
2091
2092 case MSR_IA32_X2APIC_TIMER_ICR:
2093 {
2094 rcStrict = apicSetTimerIcr(pVCpu, VINF_CPUM_R3_MSR_WRITE, u32Value);
2095 break;
2096 }
2097
2098 /* Write-only MSRs: */
2099 case MSR_IA32_X2APIC_SELF_IPI:
2100 {
2101 uint8_t const uVector = XAPIC_SELF_IPI_GET_VECTOR(u32Value);
2102 apicPostInterrupt(pVCpu, uVector, XAPICTRIGGERMODE_EDGE, 0 /* uSrcTag */);
2103 rcStrict = VINF_SUCCESS;
2104 break;
2105 }
2106
2107 case MSR_IA32_X2APIC_EOI:
2108 {
2109 rcStrict = apicSetEoi(pVCpu, u32Value, VINF_CPUM_R3_MSR_WRITE, false /* fForceX2ApicBehaviour */);
2110 break;
2111 }
2112
2113 /*
2114 * Windows guest using Hyper-V x2APIC MSR compatibility mode tries to write the "high"
2115 * LDR bits, which is quite absurd (as it's a 32-bit register) using this invalid MSR
2116 * index (0x80E). The write value was 0xffffffff on a Windows 8.1 64-bit guest. We can
2117 * safely ignore this nonsense, See @bugref{8382#c7}.
2118 */
2119 case MSR_IA32_X2APIC_LDR + 1:
2120 {
2121 if (pApic->fHyperVCompatMode)
2122 rcStrict = VINF_SUCCESS;
2123 else
2124 rcStrict = apicMsrAccessError(pVCpu, u32Reg, APICMSRACCESS_WRITE_RSVD_OR_UNKNOWN);
2125 break;
2126 }
2127
2128 /* Special-treament (read-only normally, but not with Hyper-V) */
2129 case MSR_IA32_X2APIC_LDR:
2130 {
2131 if (pApic->fHyperVCompatMode)
2132 {
2133 rcStrict = apicSetLdr(pVCpu, u32Value);
2134 break;
2135 }
2136 }
2137 RT_FALL_THRU();
2138 /* Read-only MSRs: */
2139 case MSR_IA32_X2APIC_ID:
2140 case MSR_IA32_X2APIC_VERSION:
2141 case MSR_IA32_X2APIC_PPR:
2142 case MSR_IA32_X2APIC_ISR0: case MSR_IA32_X2APIC_ISR1: case MSR_IA32_X2APIC_ISR2: case MSR_IA32_X2APIC_ISR3:
2143 case MSR_IA32_X2APIC_ISR4: case MSR_IA32_X2APIC_ISR5: case MSR_IA32_X2APIC_ISR6: case MSR_IA32_X2APIC_ISR7:
2144 case MSR_IA32_X2APIC_TMR0: case MSR_IA32_X2APIC_TMR1: case MSR_IA32_X2APIC_TMR2: case MSR_IA32_X2APIC_TMR3:
2145 case MSR_IA32_X2APIC_TMR4: case MSR_IA32_X2APIC_TMR5: case MSR_IA32_X2APIC_TMR6: case MSR_IA32_X2APIC_TMR7:
2146 case MSR_IA32_X2APIC_IRR0: case MSR_IA32_X2APIC_IRR1: case MSR_IA32_X2APIC_IRR2: case MSR_IA32_X2APIC_IRR3:
2147 case MSR_IA32_X2APIC_IRR4: case MSR_IA32_X2APIC_IRR5: case MSR_IA32_X2APIC_IRR6: case MSR_IA32_X2APIC_IRR7:
2148 case MSR_IA32_X2APIC_TIMER_CCR:
2149 {
2150 rcStrict = apicMsrAccessError(pVCpu, u32Reg, APICMSRACCESS_WRITE_READ_ONLY);
2151 break;
2152 }
2153
2154 /* Reserved MSRs: */
2155 case MSR_IA32_X2APIC_LVT_CMCI:
2156 default:
2157 {
2158 rcStrict = apicMsrAccessError(pVCpu, u32Reg, APICMSRACCESS_WRITE_RSVD_OR_UNKNOWN);
2159 break;
2160 }
2161 }
2162 }
2163 else
2164 rcStrict = apicMsrAccessError(pVCpu, u32Reg, APICMSRACCESS_INVALID_WRITE_MODE);
2165
2166 return rcStrict;
2167}
2168
2169
2170/**
2171 * Resets the APIC base MSR.
2172 *
2173 * @param pVCpu The cross context virtual CPU structure.
2174 */
2175static void apicResetBaseMsr(PVMCPUCC pVCpu)
2176{
2177 /*
2178 * Initialize the APIC base MSR. The APIC enable-bit is set upon power-up or reset[1].
2179 *
2180 * A Reset (in xAPIC and x2APIC mode) brings up the local APIC in xAPIC mode.
2181 * An INIT IPI does -not- cause a transition between xAPIC and x2APIC mode[2].
2182 *
2183 * [1] See AMD spec. 14.1.3 "Processor Initialization State"
2184 * [2] See Intel spec. 10.12.5.1 "x2APIC States".
2185 */
2186 VMCPU_ASSERT_EMT_OR_NOT_RUNNING(pVCpu);
2187
2188 /* Construct. */
2189 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
2190 PAPIC pApic = VM_TO_APIC(pVCpu->CTX_SUFF(pVM));
2191 uint64_t uApicBaseMsr = MSR_IA32_APICBASE_ADDR;
2192 if (pVCpu->idCpu == 0)
2193 uApicBaseMsr |= MSR_IA32_APICBASE_BSP;
2194
2195 /* If the VM was configured with no APIC, don't enable xAPIC mode, obviously. */
2196 if (pApic->enmMaxMode != PDMAPICMODE_NONE)
2197 {
2198 uApicBaseMsr |= MSR_IA32_APICBASE_EN;
2199
2200 /*
2201 * While coming out of a reset the APIC is enabled and in xAPIC mode. If software had previously
2202 * disabled the APIC (which results in the CPUID bit being cleared as well) we re-enable it here.
2203 * See Intel spec. 10.12.5.1 "x2APIC States".
2204 */
2205 if (CPUMSetGuestCpuIdPerCpuApicFeature(pVCpu, true /*fVisible*/) == false)
2206 LogRel(("APIC%u: Resetting mode to xAPIC\n", pVCpu->idCpu));
2207 }
2208
2209 /* Commit. */
2210 ASMAtomicWriteU64(&pApicCpu->uApicBaseMsr, uApicBaseMsr);
2211}
2212
2213
2214/**
2215 * Initializes per-VCPU APIC to the state following an INIT reset
2216 * ("Wait-for-SIPI" state).
2217 *
2218 * @param pVCpu The cross context virtual CPU structure.
2219 */
2220void apicInitIpi(PVMCPUCC pVCpu)
2221{
2222 VMCPU_ASSERT_EMT_OR_NOT_RUNNING(pVCpu);
2223 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
2224
2225 /*
2226 * See Intel spec. 10.4.7.3 "Local APIC State After an INIT Reset (Wait-for-SIPI State)"
2227 * and AMD spec 16.3.2 "APIC Registers".
2228 *
2229 * The reason we don't simply zero out the entire APIC page and only set the non-zero members
2230 * is because there are some registers that are not touched by the INIT IPI (e.g. version)
2231 * operation and this function is only a subset of the reset operation.
2232 */
2233 RT_ZERO(pXApicPage->irr);
2234 RT_ZERO(pXApicPage->irr);
2235 RT_ZERO(pXApicPage->isr);
2236 RT_ZERO(pXApicPage->tmr);
2237 RT_ZERO(pXApicPage->icr_hi);
2238 RT_ZERO(pXApicPage->icr_lo);
2239 RT_ZERO(pXApicPage->ldr);
2240 RT_ZERO(pXApicPage->tpr);
2241 RT_ZERO(pXApicPage->ppr);
2242 RT_ZERO(pXApicPage->timer_icr);
2243 RT_ZERO(pXApicPage->timer_ccr);
2244 RT_ZERO(pXApicPage->timer_dcr);
2245
2246 pXApicPage->dfr.u.u4Model = XAPICDESTFORMAT_FLAT;
2247 pXApicPage->dfr.u.u28ReservedMb1 = UINT32_C(0xfffffff);
2248
2249 /** @todo CMCI. */
2250
2251 RT_ZERO(pXApicPage->lvt_timer);
2252 pXApicPage->lvt_timer.u.u1Mask = 1;
2253
2254#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
2255 RT_ZERO(pXApicPage->lvt_thermal);
2256 pXApicPage->lvt_thermal.u.u1Mask = 1;
2257#endif
2258
2259 RT_ZERO(pXApicPage->lvt_perf);
2260 pXApicPage->lvt_perf.u.u1Mask = 1;
2261
2262 RT_ZERO(pXApicPage->lvt_lint0);
2263 pXApicPage->lvt_lint0.u.u1Mask = 1;
2264
2265 RT_ZERO(pXApicPage->lvt_lint1);
2266 pXApicPage->lvt_lint1.u.u1Mask = 1;
2267
2268 RT_ZERO(pXApicPage->lvt_error);
2269 pXApicPage->lvt_error.u.u1Mask = 1;
2270
2271 RT_ZERO(pXApicPage->svr);
2272 pXApicPage->svr.u.u8SpuriousVector = 0xff;
2273
2274 /* The self-IPI register is reset to 0. See Intel spec. 10.12.5.1 "x2APIC States" */
2275 PX2APICPAGE pX2ApicPage = VMCPU_TO_X2APICPAGE(pVCpu);
2276 RT_ZERO(pX2ApicPage->self_ipi);
2277
2278 /* Clear the pending-interrupt bitmaps. */
2279 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
2280 RT_BZERO(&pApicCpu->ApicPibLevel, sizeof(APICPIB));
2281 RT_BZERO(pApicCpu->CTX_SUFF(pvApicPib), sizeof(APICPIB));
2282
2283 /* Clear the interrupt line states for LINT0 and LINT1 pins. */
2284 pApicCpu->fActiveLint0 = false;
2285 pApicCpu->fActiveLint1 = false;
2286}
2287
2288
2289/**
2290 * Initializes per-VCPU APIC to the state following a power-up or hardware
2291 * reset.
2292 *
2293 * @param pVCpu The cross context virtual CPU structure.
2294 * @param fResetApicBaseMsr Whether to reset the APIC base MSR.
2295 */
2296void apicResetCpu(PVMCPUCC pVCpu, bool fResetApicBaseMsr)
2297{
2298 VMCPU_ASSERT_EMT_OR_NOT_RUNNING(pVCpu);
2299
2300 LogFlow(("APIC%u: apicR3ResetCpu: fResetApicBaseMsr=%RTbool\n", pVCpu->idCpu, fResetApicBaseMsr));
2301
2302#ifdef VBOX_STRICT
2303 /* Verify that the initial APIC ID reported via CPUID matches our VMCPU ID assumption. */
2304 uint32_t uEax, uEbx, uEcx, uEdx;
2305 uEax = uEbx = uEcx = uEdx = UINT32_MAX;
2306 CPUMGetGuestCpuId(pVCpu, 1, 0, &uEax, &uEbx, &uEcx, &uEdx);
2307 Assert(((uEbx >> 24) & 0xff) == pVCpu->idCpu);
2308#endif
2309
2310 /*
2311 * The state following a power-up or reset is a superset of the INIT state.
2312 * See Intel spec. 10.4.7.3 "Local APIC State After an INIT Reset ('Wait-for-SIPI' State)"
2313 */
2314 apicInitIpi(pVCpu);
2315
2316 /*
2317 * The APIC version register is read-only, so just initialize it here.
2318 * It is not clear from the specs, where exactly it is initialized.
2319 * The version determines the number of LVT entries and size of the APIC ID (8 bits for P4).
2320 */
2321 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
2322#if XAPIC_HARDWARE_VERSION == XAPIC_HARDWARE_VERSION_P4
2323 pXApicPage->version.u.u8MaxLvtEntry = XAPIC_MAX_LVT_ENTRIES_P4 - 1;
2324 pXApicPage->version.u.u8Version = XAPIC_HARDWARE_VERSION_P4;
2325 AssertCompile(sizeof(pXApicPage->id.u8ApicId) >= XAPIC_APIC_ID_BIT_COUNT_P4 / 8);
2326#else
2327# error "Implement Pentium and P6 family APIC architectures"
2328#endif
2329
2330 /** @todo It isn't clear in the spec. where exactly the default base address
2331 * is (re)initialized, atm we do it here in Reset. */
2332 if (fResetApicBaseMsr)
2333 apicResetBaseMsr(pVCpu);
2334
2335 /*
2336 * Initialize the APIC ID register to xAPIC format.
2337 */
2338 ASMMemZero32(&pXApicPage->id, sizeof(pXApicPage->id));
2339 pXApicPage->id.u8ApicId = pVCpu->idCpu;
2340}
2341
2342
2343/**
2344 * Sets the APIC base MSR.
2345 *
2346 * @returns VBox status code - no informational ones, esp. not
2347 * VINF_CPUM_R3_MSR_WRITE. Only the following two:
2348 * @retval VINF_SUCCESS
2349 * @retval VERR_CPUM_RAISE_GP_0
2350 *
2351 * @param pVCpu The cross context virtual CPU structure.
2352 * @param u64BaseMsr The value to set.
2353 */
2354VMM_INT_DECL(int) APICSetBaseMsr(PVMCPUCC pVCpu, uint64_t u64BaseMsr)
2355{
2356 Assert(pVCpu);
2357
2358 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
2359 PAPIC pApic = VM_TO_APIC(pVCpu->CTX_SUFF(pVM));
2360 APICMODE enmOldMode = apicGetMode(pApicCpu->uApicBaseMsr);
2361 APICMODE enmNewMode = apicGetMode(u64BaseMsr);
2362 uint64_t uBaseMsr = pApicCpu->uApicBaseMsr;
2363
2364 Log2(("APIC%u: ApicSetBaseMsr: u64BaseMsr=%#RX64 enmNewMode=%s enmOldMode=%s\n", pVCpu->idCpu, u64BaseMsr,
2365 apicGetModeName(enmNewMode), apicGetModeName(enmOldMode)));
2366
2367 /*
2368 * We do not support re-mapping the APIC base address because:
2369 * - We'll have to manage all the mappings ourselves in the APIC (reference counting based unmapping etc.)
2370 * i.e. we can only unmap the MMIO region if no other APIC is mapped on that location.
2371 * - It's unclear how/if IOM can fallback to handling regions as regular memory (if the MMIO
2372 * region remains mapped but doesn't belong to the called VCPU's APIC).
2373 */
2374 /** @todo Handle per-VCPU APIC base relocation. */
2375 if (MSR_IA32_APICBASE_GET_ADDR(uBaseMsr) != MSR_IA32_APICBASE_ADDR)
2376 {
2377 if (pVCpu->apic.s.cLogMaxSetApicBaseAddr++ < 5)
2378 LogRel(("APIC%u: Attempt to relocate base to %#RGp, unsupported -> #GP(0)\n", pVCpu->idCpu,
2379 MSR_IA32_APICBASE_GET_ADDR(uBaseMsr)));
2380 return VERR_CPUM_RAISE_GP_0;
2381 }
2382
2383 /* Don't allow enabling xAPIC/x2APIC if the VM is configured with the APIC disabled. */
2384 if (pApic->enmMaxMode == PDMAPICMODE_NONE)
2385 {
2386 LogRel(("APIC%u: Disallowing APIC base MSR write as the VM is configured with APIC disabled!\n", pVCpu->idCpu));
2387 return apicMsrAccessError(pVCpu, MSR_IA32_APICBASE, APICMSRACCESS_WRITE_DISALLOWED_CONFIG);
2388 }
2389
2390 /*
2391 * Act on state transition.
2392 */
2393 if (enmNewMode != enmOldMode)
2394 {
2395 switch (enmNewMode)
2396 {
2397 case APICMODE_DISABLED:
2398 {
2399 /*
2400 * The APIC state needs to be reset (especially the APIC ID as x2APIC APIC ID bit layout
2401 * is different). We can start with a clean slate identical to the state after a power-up/reset.
2402 *
2403 * See Intel spec. 10.4.3 "Enabling or Disabling the Local APIC".
2404 *
2405 * We'll also manually manage the APIC base MSR here. We want a single-point of commit
2406 * at the end of this function rather than updating it in apicR3ResetCpu. This means we also
2407 * need to update the CPUID leaf ourselves.
2408 */
2409 apicResetCpu(pVCpu, false /* fResetApicBaseMsr */);
2410 uBaseMsr &= ~(MSR_IA32_APICBASE_EN | MSR_IA32_APICBASE_EXTD);
2411 CPUMSetGuestCpuIdPerCpuApicFeature(pVCpu, false /*fVisible*/);
2412 LogRel(("APIC%u: Switched mode to disabled\n", pVCpu->idCpu));
2413 break;
2414 }
2415
2416 case APICMODE_XAPIC:
2417 {
2418 if (enmOldMode != APICMODE_DISABLED)
2419 {
2420 LogRel(("APIC%u: Can only transition to xAPIC state from disabled state\n", pVCpu->idCpu));
2421 return apicMsrAccessError(pVCpu, MSR_IA32_APICBASE, APICMSRACCESS_WRITE_INVALID);
2422 }
2423
2424 uBaseMsr |= MSR_IA32_APICBASE_EN;
2425 CPUMSetGuestCpuIdPerCpuApicFeature(pVCpu, true /*fVisible*/);
2426 LogRel(("APIC%u: Switched mode to xAPIC\n", pVCpu->idCpu));
2427 break;
2428 }
2429
2430 case APICMODE_X2APIC:
2431 {
2432 if (pApic->enmMaxMode != PDMAPICMODE_X2APIC)
2433 {
2434 LogRel(("APIC%u: Disallowing transition to x2APIC mode as the VM is configured with the x2APIC disabled!\n",
2435 pVCpu->idCpu));
2436 return apicMsrAccessError(pVCpu, MSR_IA32_APICBASE, APICMSRACCESS_WRITE_INVALID);
2437 }
2438
2439 if (enmOldMode != APICMODE_XAPIC)
2440 {
2441 LogRel(("APIC%u: Can only transition to x2APIC state from xAPIC state\n", pVCpu->idCpu));
2442 return apicMsrAccessError(pVCpu, MSR_IA32_APICBASE, APICMSRACCESS_WRITE_INVALID);
2443 }
2444
2445 uBaseMsr |= MSR_IA32_APICBASE_EN | MSR_IA32_APICBASE_EXTD;
2446
2447 /*
2448 * The APIC ID needs updating when entering x2APIC mode.
2449 * Software written APIC ID in xAPIC mode isn't preserved.
2450 * The APIC ID becomes read-only to software in x2APIC mode.
2451 *
2452 * See Intel spec. 10.12.5.1 "x2APIC States".
2453 */
2454 PX2APICPAGE pX2ApicPage = VMCPU_TO_X2APICPAGE(pVCpu);
2455 ASMMemZero32(&pX2ApicPage->id, sizeof(pX2ApicPage->id));
2456 pX2ApicPage->id.u32ApicId = pVCpu->idCpu;
2457
2458 /*
2459 * LDR initialization occurs when entering x2APIC mode.
2460 * See Intel spec. 10.12.10.2 "Deriving Logical x2APIC ID from the Local x2APIC ID".
2461 */
2462 pX2ApicPage->ldr.u32LogicalApicId = ((pX2ApicPage->id.u32ApicId & UINT32_C(0xffff0)) << 16)
2463 | (UINT32_C(1) << pX2ApicPage->id.u32ApicId & UINT32_C(0xf));
2464
2465 LogRel(("APIC%u: Switched mode to x2APIC\n", pVCpu->idCpu));
2466 break;
2467 }
2468
2469 case APICMODE_INVALID:
2470 default:
2471 {
2472 Log(("APIC%u: Invalid state transition attempted\n", pVCpu->idCpu));
2473 return apicMsrAccessError(pVCpu, MSR_IA32_APICBASE, APICMSRACCESS_WRITE_INVALID);
2474 }
2475 }
2476 }
2477
2478 ASMAtomicWriteU64(&pApicCpu->uApicBaseMsr, uBaseMsr);
2479 return VINF_SUCCESS;
2480}
2481
2482
2483/**
2484 * Gets the APIC base MSR (no checks are performed wrt APIC hardware or its
2485 * state).
2486 *
2487 * @returns The base MSR value.
2488 * @param pVCpu The cross context virtual CPU structure.
2489 */
2490VMM_INT_DECL(uint64_t) APICGetBaseMsrNoCheck(PCVMCPUCC pVCpu)
2491{
2492 VMCPU_ASSERT_EMT_OR_NOT_RUNNING(pVCpu);
2493 PCAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
2494 return pApicCpu->uApicBaseMsr;
2495}
2496
2497
2498/**
2499 * Gets the APIC base MSR.
2500 *
2501 * @returns Strict VBox status code.
2502 * @param pVCpu The cross context virtual CPU structure.
2503 * @param pu64Value Where to store the MSR value.
2504 */
2505VMM_INT_DECL(VBOXSTRICTRC) APICGetBaseMsr(PVMCPUCC pVCpu, uint64_t *pu64Value)
2506{
2507 VMCPU_ASSERT_EMT_OR_NOT_RUNNING(pVCpu);
2508
2509 PCAPIC pApic = VM_TO_APIC(pVCpu->CTX_SUFF(pVM));
2510 if (pApic->enmMaxMode != PDMAPICMODE_NONE)
2511 {
2512 *pu64Value = APICGetBaseMsrNoCheck(pVCpu);
2513 return VINF_SUCCESS;
2514 }
2515
2516 if (pVCpu->apic.s.cLogMaxGetApicBaseAddr++ < 5)
2517 LogRel(("APIC%u: Reading APIC base MSR (%#x) when there is no APIC -> #GP(0)\n", pVCpu->idCpu, MSR_IA32_APICBASE));
2518 return VERR_CPUM_RAISE_GP_0;
2519}
2520
2521
2522/**
2523 * Sets the TPR (Task Priority Register).
2524 *
2525 * @retval VINF_SUCCESS
2526 * @retval VERR_CPUM_RAISE_GP_0
2527 * @retval VERR_PDM_NO_APIC_INSTANCE
2528 *
2529 * @param pVCpu The cross context virtual CPU structure.
2530 * @param u8Tpr The TPR value to set.
2531 */
2532VMMDECL(int) APICSetTpr(PVMCPUCC pVCpu, uint8_t u8Tpr)
2533{
2534 if (APICIsEnabled(pVCpu))
2535 return apicSetTprEx(pVCpu, u8Tpr, false /* fForceX2ApicBehaviour */);
2536 return VERR_PDM_NO_APIC_INSTANCE;
2537}
2538
2539
2540/**
2541 * Gets the highest priority pending interrupt.
2542 *
2543 * @returns true if any interrupt is pending, false otherwise.
2544 * @param pVCpu The cross context virtual CPU structure.
2545 * @param pu8PendingIntr Where to store the interrupt vector if the
2546 * interrupt is pending (optional, can be NULL).
2547 */
2548static bool apicGetHighestPendingInterrupt(PCVMCPUCC pVCpu, uint8_t *pu8PendingIntr)
2549{
2550 PCXAPICPAGE pXApicPage = VMCPU_TO_CXAPICPAGE(pVCpu);
2551 int const irrv = apicGetHighestSetBitInReg(&pXApicPage->irr, -1);
2552 if (irrv >= 0)
2553 {
2554 Assert(irrv <= (int)UINT8_MAX);
2555 if (pu8PendingIntr)
2556 *pu8PendingIntr = (uint8_t)irrv;
2557 return true;
2558 }
2559 return false;
2560}
2561
2562
2563/**
2564 * Gets the APIC TPR (Task Priority Register).
2565 *
2566 * @returns VBox status code.
2567 * @param pVCpu The cross context virtual CPU structure.
2568 * @param pu8Tpr Where to store the TPR.
2569 * @param pfPending Where to store whether there is a pending interrupt
2570 * (optional, can be NULL).
2571 * @param pu8PendingIntr Where to store the highest-priority pending
2572 * interrupt (optional, can be NULL).
2573 */
2574VMMDECL(int) APICGetTpr(PCVMCPUCC pVCpu, uint8_t *pu8Tpr, bool *pfPending, uint8_t *pu8PendingIntr)
2575{
2576 VMCPU_ASSERT_EMT(pVCpu);
2577 if (APICIsEnabled(pVCpu))
2578 {
2579 PCXAPICPAGE pXApicPage = VMCPU_TO_CXAPICPAGE(pVCpu);
2580 if (pfPending)
2581 {
2582 /*
2583 * Just return whatever the highest pending interrupt is in the IRR.
2584 * The caller is responsible for figuring out if it's masked by the TPR etc.
2585 */
2586 *pfPending = apicGetHighestPendingInterrupt(pVCpu, pu8PendingIntr);
2587 }
2588
2589 *pu8Tpr = pXApicPage->tpr.u8Tpr;
2590 return VINF_SUCCESS;
2591 }
2592
2593 *pu8Tpr = 0;
2594 return VERR_PDM_NO_APIC_INSTANCE;
2595}
2596
2597
2598/**
2599 * Gets the APIC timer frequency.
2600 *
2601 * @returns Strict VBox status code.
2602 * @param pVM The cross context VM structure.
2603 * @param pu64Value Where to store the timer frequency.
2604 */
2605VMM_INT_DECL(int) APICGetTimerFreq(PVMCC pVM, uint64_t *pu64Value)
2606{
2607 /*
2608 * Validate.
2609 */
2610 Assert(pVM);
2611 AssertPtrReturn(pu64Value, VERR_INVALID_PARAMETER);
2612
2613 PVMCPUCC pVCpu = pVM->CTX_SUFF(apCpus)[0];
2614 if (APICIsEnabled(pVCpu))
2615 {
2616 PCAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
2617 *pu64Value = TMTimerGetFreq(pApicCpu->CTX_SUFF(pTimer));
2618 return VINF_SUCCESS;
2619 }
2620 return VERR_PDM_NO_APIC_INSTANCE;
2621}
2622
2623
2624/**
2625 * Delivers an interrupt message via the system bus.
2626 *
2627 * @returns VBox status code.
2628 * @param pVM The cross context VM structure.
2629 * @param uDest The destination mask.
2630 * @param uDestMode The destination mode.
2631 * @param uDeliveryMode The delivery mode.
2632 * @param uVector The interrupt vector.
2633 * @param uPolarity The interrupt line polarity.
2634 * @param uTriggerMode The trigger mode.
2635 * @param uSrcTag The interrupt source tag (debugging).
2636 */
2637VMM_INT_DECL(int) APICBusDeliver(PVMCC pVM, uint8_t uDest, uint8_t uDestMode, uint8_t uDeliveryMode, uint8_t uVector,
2638 uint8_t uPolarity, uint8_t uTriggerMode, uint32_t uSrcTag)
2639{
2640 NOREF(uPolarity);
2641
2642 /*
2643 * If the APIC isn't enabled, do nothing and pretend success.
2644 */
2645 if (APICIsEnabled(pVM->CTX_SUFF(apCpus)[0]))
2646 { /* likely */ }
2647 else
2648 return VINF_SUCCESS;
2649
2650 /*
2651 * The destination field (mask) in the IO APIC redirectable table entry is 8-bits.
2652 * Hence, the broadcast mask is 0xff.
2653 * See IO APIC spec. 3.2.4. "IOREDTBL[23:0] - I/O Redirectable Table Registers".
2654 */
2655 XAPICTRIGGERMODE enmTriggerMode = (XAPICTRIGGERMODE)uTriggerMode;
2656 XAPICDELIVERYMODE enmDeliveryMode = (XAPICDELIVERYMODE)uDeliveryMode;
2657 XAPICDESTMODE enmDestMode = (XAPICDESTMODE)uDestMode;
2658 uint32_t fDestMask = uDest;
2659 uint32_t fBroadcastMask = UINT32_C(0xff);
2660
2661 Log2(("APIC: apicBusDeliver: fDestMask=%#x enmDestMode=%s enmTriggerMode=%s enmDeliveryMode=%s uVector=%#x\n", fDestMask,
2662 apicGetDestModeName(enmDestMode), apicGetTriggerModeName(enmTriggerMode), apicGetDeliveryModeName(enmDeliveryMode),
2663 uVector));
2664
2665 bool fIntrAccepted;
2666 VMCPUSET DestCpuSet;
2667 apicGetDestCpuSet(pVM, fDestMask, fBroadcastMask, enmDestMode, enmDeliveryMode, &DestCpuSet);
2668 VBOXSTRICTRC rcStrict = apicSendIntr(pVM, NULL /* pVCpu */, uVector, enmTriggerMode, enmDeliveryMode, &DestCpuSet,
2669 &fIntrAccepted, uSrcTag, VINF_SUCCESS /* rcRZ */);
2670 if (fIntrAccepted)
2671 return VBOXSTRICTRC_VAL(rcStrict);
2672 return VERR_APIC_INTR_DISCARDED;
2673}
2674
2675
2676/**
2677 * Assert/de-assert the local APIC's LINT0/LINT1 interrupt pins.
2678 *
2679 * @returns Strict VBox status code.
2680 * @param pVCpu The cross context virtual CPU structure.
2681 * @param u8Pin The interrupt pin (0 for LINT0 or 1 for LINT1).
2682 * @param u8Level The level (0 for low or 1 for high).
2683 * @param rcRZ The return code if the operation cannot be performed in
2684 * the current context.
2685 *
2686 * @note All callers totally ignores the status code!
2687 */
2688VMM_INT_DECL(VBOXSTRICTRC) APICLocalInterrupt(PVMCPUCC pVCpu, uint8_t u8Pin, uint8_t u8Level, int rcRZ)
2689{
2690 AssertReturn(u8Pin <= 1, VERR_INVALID_PARAMETER);
2691 AssertReturn(u8Level <= 1, VERR_INVALID_PARAMETER);
2692
2693 VBOXSTRICTRC rcStrict = VINF_SUCCESS;
2694
2695 /* If the APIC is enabled, the interrupt is subject to LVT programming. */
2696 if (APICIsEnabled(pVCpu))
2697 {
2698 PCXAPICPAGE pXApicPage = VMCPU_TO_CXAPICPAGE(pVCpu);
2699
2700 /* Pick the LVT entry corresponding to the interrupt pin. */
2701 static const uint16_t s_au16LvtOffsets[] =
2702 {
2703 XAPIC_OFF_LVT_LINT0,
2704 XAPIC_OFF_LVT_LINT1
2705 };
2706 Assert(u8Pin < RT_ELEMENTS(s_au16LvtOffsets));
2707 uint16_t const offLvt = s_au16LvtOffsets[u8Pin];
2708 uint32_t const uLvt = apicReadRaw32(pXApicPage, offLvt);
2709
2710 /* If software hasn't masked the interrupt in the LVT entry, proceed interrupt processing. */
2711 if (!XAPIC_LVT_IS_MASKED(uLvt))
2712 {
2713 XAPICDELIVERYMODE const enmDeliveryMode = XAPIC_LVT_GET_DELIVERY_MODE(uLvt);
2714 XAPICTRIGGERMODE enmTriggerMode = XAPIC_LVT_GET_TRIGGER_MODE(uLvt);
2715
2716 switch (enmDeliveryMode)
2717 {
2718 case XAPICDELIVERYMODE_INIT:
2719 {
2720 /** @todo won't work in R0/RC because callers don't care about rcRZ. */
2721 AssertMsgFailed(("INIT through LINT0/LINT1 is not yet supported\n"));
2722 }
2723 RT_FALL_THRU();
2724 case XAPICDELIVERYMODE_FIXED:
2725 {
2726 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
2727 uint8_t const uVector = XAPIC_LVT_GET_VECTOR(uLvt);
2728 bool fActive = RT_BOOL(u8Level & 1);
2729 bool volatile *pfActiveLine = u8Pin == 0 ? &pApicCpu->fActiveLint0 : &pApicCpu->fActiveLint1;
2730 /** @todo Polarity is busted elsewhere, we need to fix that
2731 * first. See @bugref{8386#c7}. */
2732#if 0
2733 uint8_t const u8Polarity = XAPIC_LVT_GET_POLARITY(uLvt);
2734 fActive ^= u8Polarity; */
2735#endif
2736 if (!fActive)
2737 {
2738 ASMAtomicCmpXchgBool(pfActiveLine, false, true);
2739 break;
2740 }
2741
2742 /* Level-sensitive interrupts are not supported for LINT1. See Intel spec. 10.5.1 "Local Vector Table". */
2743 if (offLvt == XAPIC_OFF_LVT_LINT1)
2744 enmTriggerMode = XAPICTRIGGERMODE_EDGE;
2745 /** @todo figure out what "If the local APIC is not used in conjunction with an I/O APIC and fixed
2746 delivery mode is selected; the Pentium 4, Intel Xeon, and P6 family processors will always
2747 use level-sensitive triggering, regardless if edge-sensitive triggering is selected."
2748 means. */
2749
2750 bool fSendIntr;
2751 if (enmTriggerMode == XAPICTRIGGERMODE_EDGE)
2752 {
2753 /* Recognize and send the interrupt only on an edge transition. */
2754 fSendIntr = ASMAtomicCmpXchgBool(pfActiveLine, true, false);
2755 }
2756 else
2757 {
2758 /* For level-triggered interrupts, redundant interrupts are not a problem. */
2759 Assert(enmTriggerMode == XAPICTRIGGERMODE_LEVEL);
2760 ASMAtomicCmpXchgBool(pfActiveLine, true, false);
2761
2762 /* Only when the remote IRR isn't set, set it and send the interrupt. */
2763 if (!(pXApicPage->lvt_lint0.all.u32LvtLint0 & XAPIC_LVT_REMOTE_IRR))
2764 {
2765 Assert(offLvt == XAPIC_OFF_LVT_LINT0);
2766 ASMAtomicOrU32((volatile uint32_t *)&pXApicPage->lvt_lint0.all.u32LvtLint0, XAPIC_LVT_REMOTE_IRR);
2767 fSendIntr = true;
2768 }
2769 else
2770 fSendIntr = false;
2771 }
2772
2773 if (fSendIntr)
2774 {
2775 VMCPUSET DestCpuSet;
2776 VMCPUSET_EMPTY(&DestCpuSet);
2777 VMCPUSET_ADD(&DestCpuSet, pVCpu->idCpu);
2778 rcStrict = apicSendIntr(pVCpu->CTX_SUFF(pVM), pVCpu, uVector, enmTriggerMode, enmDeliveryMode,
2779 &DestCpuSet, NULL /* pfIntrAccepted */, 0 /* uSrcTag */, rcRZ);
2780 }
2781 break;
2782 }
2783
2784 case XAPICDELIVERYMODE_SMI:
2785 case XAPICDELIVERYMODE_NMI:
2786 {
2787 VMCPUSET DestCpuSet;
2788 VMCPUSET_EMPTY(&DestCpuSet);
2789 VMCPUSET_ADD(&DestCpuSet, pVCpu->idCpu);
2790 uint8_t const uVector = XAPIC_LVT_GET_VECTOR(uLvt);
2791 rcStrict = apicSendIntr(pVCpu->CTX_SUFF(pVM), pVCpu, uVector, enmTriggerMode, enmDeliveryMode, &DestCpuSet,
2792 NULL /* pfIntrAccepted */, 0 /* uSrcTag */, rcRZ);
2793 break;
2794 }
2795
2796 case XAPICDELIVERYMODE_EXTINT:
2797 {
2798 Log2(("APIC%u: apicLocalInterrupt: %s ExtINT through LINT%u\n", pVCpu->idCpu,
2799 u8Level ? "Raising" : "Lowering", u8Pin));
2800 if (u8Level)
2801 apicSetInterruptFF(pVCpu, PDMAPICIRQ_EXTINT);
2802 else
2803 apicClearInterruptFF(pVCpu, PDMAPICIRQ_EXTINT);
2804 break;
2805 }
2806
2807 /* Reserved/unknown delivery modes: */
2808 case XAPICDELIVERYMODE_LOWEST_PRIO:
2809 case XAPICDELIVERYMODE_STARTUP:
2810 default:
2811 {
2812 AssertMsgFailed(("APIC%u: LocalInterrupt: Invalid delivery mode %#x (%s) on LINT%d\n", pVCpu->idCpu,
2813 enmDeliveryMode, apicGetDeliveryModeName(enmDeliveryMode), u8Pin));
2814 rcStrict = VERR_INTERNAL_ERROR_3;
2815 break;
2816 }
2817 }
2818 }
2819 }
2820 else
2821 {
2822 /* The APIC is hardware disabled. The CPU behaves as though there is no on-chip APIC. */
2823 if (u8Pin == 0)
2824 {
2825 /* LINT0 behaves as an external interrupt pin. */
2826 Log2(("APIC%u: apicLocalInterrupt: APIC hardware-disabled, %s INTR\n", pVCpu->idCpu,
2827 u8Level ? "raising" : "lowering"));
2828 if (u8Level)
2829 apicSetInterruptFF(pVCpu, PDMAPICIRQ_EXTINT);
2830 else
2831 apicClearInterruptFF(pVCpu, PDMAPICIRQ_EXTINT);
2832 }
2833 else
2834 {
2835 /* LINT1 behaves as NMI. */
2836 Log2(("APIC%u: apicLocalInterrupt: APIC hardware-disabled, raising NMI\n", pVCpu->idCpu));
2837 apicSetInterruptFF(pVCpu, PDMAPICIRQ_NMI);
2838 }
2839 }
2840
2841 return rcStrict;
2842}
2843
2844
2845/**
2846 * Gets the next highest-priority interrupt from the APIC, marking it as an
2847 * "in-service" interrupt.
2848 *
2849 * @returns VBox status code.
2850 * @param pVCpu The cross context virtual CPU structure.
2851 * @param pu8Vector Where to store the vector.
2852 * @param puSrcTag Where to store the interrupt source tag (debugging).
2853 */
2854VMM_INT_DECL(int) APICGetInterrupt(PVMCPUCC pVCpu, uint8_t *pu8Vector, uint32_t *puSrcTag)
2855{
2856 VMCPU_ASSERT_EMT(pVCpu);
2857 Assert(pu8Vector);
2858
2859 LogFlow(("APIC%u: apicGetInterrupt:\n", pVCpu->idCpu));
2860
2861 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
2862 bool const fApicHwEnabled = APICIsEnabled(pVCpu);
2863 if ( fApicHwEnabled
2864 && pXApicPage->svr.u.fApicSoftwareEnable)
2865 {
2866 int const irrv = apicGetHighestSetBitInReg(&pXApicPage->irr, -1);
2867 if (RT_LIKELY(irrv >= 0))
2868 {
2869 Assert(irrv <= (int)UINT8_MAX);
2870 uint8_t const uVector = irrv;
2871
2872 /*
2873 * This can happen if the APIC receives an interrupt when the CPU has interrupts
2874 * disabled but the TPR is raised by the guest before re-enabling interrupts.
2875 */
2876 uint8_t const uTpr = pXApicPage->tpr.u8Tpr;
2877 if ( uTpr > 0
2878 && XAPIC_TPR_GET_TP(uVector) <= XAPIC_TPR_GET_TP(uTpr))
2879 {
2880 Log2(("APIC%u: apicGetInterrupt: Interrupt masked. uVector=%#x uTpr=%#x SpuriousVector=%#x\n", pVCpu->idCpu,
2881 uVector, uTpr, pXApicPage->svr.u.u8SpuriousVector));
2882 *pu8Vector = uVector;
2883 *puSrcTag = 0;
2884 STAM_COUNTER_INC(&pVCpu->apic.s.StatMaskedByTpr);
2885 return VERR_APIC_INTR_MASKED_BY_TPR;
2886 }
2887
2888 /*
2889 * The PPR should be up-to-date at this point through apicSetEoi().
2890 * We're on EMT so no parallel updates possible.
2891 * Subject the pending vector to PPR prioritization.
2892 */
2893 uint8_t const uPpr = pXApicPage->ppr.u8Ppr;
2894 if ( !uPpr
2895 || XAPIC_PPR_GET_PP(uVector) > XAPIC_PPR_GET_PP(uPpr))
2896 {
2897 apicClearVectorInReg(&pXApicPage->irr, uVector);
2898 apicSetVectorInReg(&pXApicPage->isr, uVector);
2899 apicUpdatePpr(pVCpu);
2900 apicSignalNextPendingIntr(pVCpu);
2901
2902 /* Retrieve the interrupt source tag associated with this interrupt. */
2903 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
2904 AssertCompile(RT_ELEMENTS(pApicCpu->auSrcTags) > UINT8_MAX);
2905 *puSrcTag = pApicCpu->auSrcTags[uVector];
2906 pApicCpu->auSrcTags[uVector] = 0;
2907
2908 Log2(("APIC%u: apicGetInterrupt: Valid Interrupt. uVector=%#x\n", pVCpu->idCpu, uVector));
2909 *pu8Vector = uVector;
2910 return VINF_SUCCESS;
2911 }
2912 else
2913 {
2914 STAM_COUNTER_INC(&pVCpu->apic.s.StatMaskedByPpr);
2915 Log2(("APIC%u: apicGetInterrupt: Interrupt's priority is not higher than the PPR. uVector=%#x PPR=%#x\n",
2916 pVCpu->idCpu, uVector, uPpr));
2917 }
2918 }
2919 else
2920 Log2(("APIC%u: apicGetInterrupt: No pending bits in IRR\n", pVCpu->idCpu));
2921 }
2922 else
2923 Log2(("APIC%u: apicGetInterrupt: APIC %s disabled\n", pVCpu->idCpu, !fApicHwEnabled ? "hardware" : "software"));
2924
2925 *pu8Vector = 0;
2926 *puSrcTag = 0;
2927 return VERR_APIC_INTR_NOT_PENDING;
2928}
2929
2930
2931/**
2932 * @callback_method_impl{FNIOMMMIOREAD}
2933 */
2934APICBOTHCBDECL(int) apicReadMmio(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS GCPhysAddr, void *pv, unsigned cb)
2935{
2936 NOREF(pvUser);
2937 Assert(!(GCPhysAddr & 0xf));
2938 Assert(cb == 4); RT_NOREF_PV(cb);
2939
2940 PAPICDEV pApicDev = PDMDEVINS_2_DATA(pDevIns, PAPICDEV);
2941 PVMCPUCC pVCpu = PDMDevHlpGetVMCPU(pDevIns);
2942 uint16_t offReg = GCPhysAddr & 0xff0;
2943 uint32_t uValue = 0;
2944
2945 STAM_COUNTER_INC(&pVCpu->apic.s.CTX_SUFF_Z(StatMmioRead));
2946
2947 int rc = VBOXSTRICTRC_VAL(apicReadRegister(pApicDev, pVCpu, offReg, &uValue));
2948 *(uint32_t *)pv = uValue;
2949
2950 Log2(("APIC%u: apicReadMmio: offReg=%#RX16 uValue=%#RX32\n", pVCpu->idCpu, offReg, uValue));
2951 return rc;
2952}
2953
2954
2955/**
2956 * @callback_method_impl{FNIOMMMIOWRITE}
2957 */
2958APICBOTHCBDECL(int) apicWriteMmio(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS GCPhysAddr, void const *pv, unsigned cb)
2959{
2960 NOREF(pvUser);
2961 Assert(!(GCPhysAddr & 0xf));
2962 Assert(cb == 4); RT_NOREF_PV(cb);
2963
2964 PAPICDEV pApicDev = PDMDEVINS_2_DATA(pDevIns, PAPICDEV);
2965 PVMCPUCC pVCpu = PDMDevHlpGetVMCPU(pDevIns);
2966 uint16_t offReg = GCPhysAddr & 0xff0;
2967 uint32_t uValue = *(uint32_t *)pv;
2968
2969 STAM_COUNTER_INC(&pVCpu->apic.s.CTX_SUFF_Z(StatMmioWrite));
2970
2971 Log2(("APIC%u: apicWriteMmio: offReg=%#RX16 uValue=%#RX32\n", pVCpu->idCpu, offReg, uValue));
2972
2973 int rc = VBOXSTRICTRC_VAL(apicWriteRegister(pApicDev, pVCpu, offReg, uValue));
2974 return rc;
2975}
2976
2977
2978/**
2979 * Sets the interrupt pending force-flag and pokes the EMT if required.
2980 *
2981 * @param pVCpu The cross context virtual CPU structure.
2982 * @param enmType The IRQ type.
2983 */
2984static void apicSetInterruptFF(PVMCPUCC pVCpu, PDMAPICIRQ enmType)
2985{
2986#ifdef IN_RING3
2987 /* IRQ state should be loaded as-is by "LoadExec". Changes can be made from LoadDone. */
2988 Assert(pVCpu->pVMR3->enmVMState != VMSTATE_LOADING || PDMR3HasLoadedState(pVCpu->pVMR3));
2989#endif
2990
2991 switch (enmType)
2992 {
2993 case PDMAPICIRQ_HARDWARE:
2994 VMCPU_ASSERT_EMT_OR_NOT_RUNNING(pVCpu);
2995 VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_APIC);
2996 break;
2997 case PDMAPICIRQ_UPDATE_PENDING: VMCPU_FF_SET(pVCpu, VMCPU_FF_UPDATE_APIC); break;
2998 case PDMAPICIRQ_NMI: VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_NMI); break;
2999 case PDMAPICIRQ_SMI: VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_SMI); break;
3000 case PDMAPICIRQ_EXTINT: VMCPU_FF_SET(pVCpu, VMCPU_FF_INTERRUPT_PIC); break;
3001 default:
3002 AssertMsgFailed(("enmType=%d\n", enmType));
3003 break;
3004 }
3005
3006 /*
3007 * We need to wake up the target CPU if we're not on EMT.
3008 */
3009#if defined(IN_RING0)
3010 PVMCC pVM = pVCpu->CTX_SUFF(pVM);
3011 VMCPUID idCpu = pVCpu->idCpu;
3012 if ( enmType != PDMAPICIRQ_HARDWARE
3013 && VMMGetCpuId(pVM) != idCpu)
3014 {
3015 switch (VMCPU_GET_STATE(pVCpu))
3016 {
3017 case VMCPUSTATE_STARTED_EXEC:
3018 GVMMR0SchedPokeNoGVMNoLock(pVM, idCpu);
3019 break;
3020
3021 case VMCPUSTATE_STARTED_HALTED:
3022 GVMMR0SchedWakeUpNoGVMNoLock(pVM, idCpu);
3023 break;
3024
3025 default:
3026 break; /* nothing to do in other states. */
3027 }
3028 }
3029#elif defined(IN_RING3)
3030 if (enmType != PDMAPICIRQ_HARDWARE)
3031 VMR3NotifyCpuFFU(pVCpu->pUVCpu, VMNOTIFYFF_FLAGS_DONE_REM | VMNOTIFYFF_FLAGS_POKE);
3032#endif
3033}
3034
3035
3036/**
3037 * Clears the interrupt pending force-flag.
3038 *
3039 * @param pVCpu The cross context virtual CPU structure.
3040 * @param enmType The IRQ type.
3041 */
3042VMM_INT_DECL(void) apicClearInterruptFF(PVMCPUCC pVCpu, PDMAPICIRQ enmType)
3043{
3044#ifdef IN_RING3
3045 /* IRQ state should be loaded as-is by "LoadExec". Changes can be made from LoadDone. */
3046 Assert(pVCpu->pVMR3->enmVMState != VMSTATE_LOADING || PDMR3HasLoadedState(pVCpu->pVMR3));
3047#endif
3048
3049 /* NMI/SMI can't be cleared. */
3050 switch (enmType)
3051 {
3052 case PDMAPICIRQ_HARDWARE: VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_APIC); break;
3053 case PDMAPICIRQ_EXTINT: VMCPU_FF_CLEAR(pVCpu, VMCPU_FF_INTERRUPT_PIC); break;
3054 default:
3055 AssertMsgFailed(("enmType=%d\n", enmType));
3056 break;
3057 }
3058}
3059
3060
3061/**
3062 * Posts an interrupt to a target APIC.
3063 *
3064 * This function handles interrupts received from the system bus or
3065 * interrupts generated locally from the LVT or via a self IPI.
3066 *
3067 * Don't use this function to try and deliver ExtINT style interrupts.
3068 *
3069 * @returns true if the interrupt was accepted, false otherwise.
3070 * @param pVCpu The cross context virtual CPU structure.
3071 * @param uVector The vector of the interrupt to be posted.
3072 * @param enmTriggerMode The trigger mode of the interrupt.
3073 * @param uSrcTag The interrupt source tag (debugging).
3074 *
3075 * @thread Any.
3076 */
3077VMM_INT_DECL(bool) apicPostInterrupt(PVMCPUCC pVCpu, uint8_t uVector, XAPICTRIGGERMODE enmTriggerMode, uint32_t uSrcTag)
3078{
3079 Assert(pVCpu);
3080 Assert(uVector > XAPIC_ILLEGAL_VECTOR_END);
3081
3082 PVMCC pVM = pVCpu->CTX_SUFF(pVM);
3083 PCAPIC pApic = VM_TO_APIC(pVM);
3084 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
3085 bool fAccepted = true;
3086
3087 STAM_PROFILE_START(&pApicCpu->StatPostIntr, a);
3088
3089 /*
3090 * Only post valid interrupt vectors.
3091 * See Intel spec. 10.5.2 "Valid Interrupt Vectors".
3092 */
3093 if (RT_LIKELY(uVector > XAPIC_ILLEGAL_VECTOR_END))
3094 {
3095 /*
3096 * If the interrupt is already pending in the IRR we can skip the
3097 * potential expensive operation of poking the guest EMT out of execution.
3098 */
3099 PCXAPICPAGE pXApicPage = VMCPU_TO_CXAPICPAGE(pVCpu);
3100 if (!apicTestVectorInReg(&pXApicPage->irr, uVector)) /* PAV */
3101 {
3102 /* Update the interrupt source tag (debugging). */
3103 if (!pApicCpu->auSrcTags[uVector])
3104 pApicCpu->auSrcTags[uVector] = uSrcTag;
3105 else
3106 pApicCpu->auSrcTags[uVector] |= RT_BIT_32(31);
3107
3108 Log2(("APIC: apicPostInterrupt: SrcCpu=%u TargetCpu=%u uVector=%#x\n", VMMGetCpuId(pVM), pVCpu->idCpu, uVector));
3109 if (enmTriggerMode == XAPICTRIGGERMODE_EDGE)
3110 {
3111 if (pApic->fPostedIntrsEnabled)
3112 { /** @todo posted-interrupt call to hardware */ }
3113 else
3114 {
3115 apicSetVectorInPib(pApicCpu->CTX_SUFF(pvApicPib), uVector);
3116 uint32_t const fAlreadySet = apicSetNotificationBitInPib((PAPICPIB)pApicCpu->CTX_SUFF(pvApicPib));
3117 if (!fAlreadySet)
3118 {
3119 Log2(("APIC: apicPostInterrupt: Setting UPDATE_APIC FF for edge-triggered intr. uVector=%#x\n", uVector));
3120 apicSetInterruptFF(pVCpu, PDMAPICIRQ_UPDATE_PENDING);
3121 }
3122 }
3123 }
3124 else
3125 {
3126 /*
3127 * Level-triggered interrupts requires updating of the TMR and thus cannot be
3128 * delivered asynchronously.
3129 */
3130 apicSetVectorInPib(&pApicCpu->ApicPibLevel, uVector);
3131 uint32_t const fAlreadySet = apicSetNotificationBitInPib(&pApicCpu->ApicPibLevel);
3132 if (!fAlreadySet)
3133 {
3134 Log2(("APIC: apicPostInterrupt: Setting UPDATE_APIC FF for level-triggered intr. uVector=%#x\n", uVector));
3135 apicSetInterruptFF(pVCpu, PDMAPICIRQ_UPDATE_PENDING);
3136 }
3137 }
3138 }
3139 else
3140 {
3141 Log2(("APIC: apicPostInterrupt: SrcCpu=%u TargetCpu=%u. Vector %#x Already in IRR, skipping\n", VMMGetCpuId(pVM),
3142 pVCpu->idCpu, uVector));
3143 STAM_COUNTER_INC(&pApicCpu->StatPostIntrAlreadyPending);
3144 }
3145 }
3146 else
3147 {
3148 fAccepted = false;
3149 apicSetError(pVCpu, XAPIC_ESR_RECV_ILLEGAL_VECTOR);
3150 }
3151
3152 STAM_PROFILE_STOP(&pApicCpu->StatPostIntr, a);
3153 return fAccepted;
3154}
3155
3156
3157/**
3158 * Starts the APIC timer.
3159 *
3160 * @param pVCpu The cross context virtual CPU structure.
3161 * @param uInitialCount The timer's Initial-Count Register (ICR), must be >
3162 * 0.
3163 * @thread Any.
3164 */
3165VMM_INT_DECL(void) apicStartTimer(PVMCPUCC pVCpu, uint32_t uInitialCount)
3166{
3167 Assert(pVCpu);
3168 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
3169 Assert(TMTimerIsLockOwner(pApicCpu->CTX_SUFF(pTimer)));
3170 Assert(uInitialCount > 0);
3171
3172 PCXAPICPAGE pXApicPage = APICCPU_TO_CXAPICPAGE(pApicCpu);
3173 uint8_t const uTimerShift = apicGetTimerShift(pXApicPage);
3174 uint64_t const cTicksToNext = (uint64_t)uInitialCount << uTimerShift;
3175
3176 Log2(("APIC%u: apicStartTimer: uInitialCount=%#RX32 uTimerShift=%u cTicksToNext=%RU64\n", pVCpu->idCpu, uInitialCount,
3177 uTimerShift, cTicksToNext));
3178
3179 /*
3180 * The assumption here is that the timer doesn't tick during this call
3181 * and thus setting a relative time to fire next is accurate. The advantage
3182 * however is updating u64TimerInitial 'atomically' while setting the next
3183 * tick.
3184 */
3185 PTMTIMER pTimer = pApicCpu->CTX_SUFF(pTimer);
3186 TMTimerSetRelative(pTimer, cTicksToNext, &pApicCpu->u64TimerInitial);
3187 apicHintTimerFreq(pApicCpu, uInitialCount, uTimerShift);
3188}
3189
3190
3191/**
3192 * Stops the APIC timer.
3193 *
3194 * @param pVCpu The cross context virtual CPU structure.
3195 * @thread Any.
3196 */
3197static void apicStopTimer(PVMCPUCC pVCpu)
3198{
3199 Assert(pVCpu);
3200 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
3201 Assert(TMTimerIsLockOwner(pApicCpu->CTX_SUFF(pTimer)));
3202
3203 Log2(("APIC%u: apicStopTimer\n", pVCpu->idCpu));
3204
3205 PTMTIMER pTimer = pApicCpu->CTX_SUFF(pTimer);
3206 TMTimerStop(pTimer); /* This will reset the hint, no need to explicitly call TMTimerSetFrequencyHint(). */
3207 pApicCpu->uHintedTimerInitialCount = 0;
3208 pApicCpu->uHintedTimerShift = 0;
3209}
3210
3211
3212/**
3213 * Queues a pending interrupt as in-service.
3214 *
3215 * This function should only be needed without virtualized APIC
3216 * registers. With virtualized APIC registers, it's sufficient to keep
3217 * the interrupts pending in the IRR as the hardware takes care of
3218 * virtual interrupt delivery.
3219 *
3220 * @returns true if the interrupt was queued to in-service interrupts,
3221 * false otherwise.
3222 * @param pVCpu The cross context virtual CPU structure.
3223 * @param u8PendingIntr The pending interrupt to queue as
3224 * in-service.
3225 *
3226 * @remarks This assumes the caller has done the necessary checks and
3227 * is ready to take actually service the interrupt (TPR,
3228 * interrupt shadow etc.)
3229 */
3230VMM_INT_DECL(bool) APICQueueInterruptToService(PVMCPUCC pVCpu, uint8_t u8PendingIntr)
3231{
3232 VMCPU_ASSERT_EMT(pVCpu);
3233
3234 PVMCC pVM = pVCpu->CTX_SUFF(pVM);
3235 PAPIC pApic = VM_TO_APIC(pVM);
3236 Assert(!pApic->fVirtApicRegsEnabled);
3237 NOREF(pApic);
3238
3239 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
3240 bool const fIsPending = apicTestVectorInReg(&pXApicPage->irr, u8PendingIntr);
3241 if (fIsPending)
3242 {
3243 apicClearVectorInReg(&pXApicPage->irr, u8PendingIntr);
3244 apicSetVectorInReg(&pXApicPage->isr, u8PendingIntr);
3245 apicUpdatePpr(pVCpu);
3246 return true;
3247 }
3248 return false;
3249}
3250
3251
3252/**
3253 * De-queues a pending interrupt from in-service.
3254 *
3255 * This undoes APICQueueInterruptToService() for premature VM-exits before event
3256 * injection.
3257 *
3258 * @param pVCpu The cross context virtual CPU structure.
3259 * @param u8PendingIntr The pending interrupt to de-queue from
3260 * in-service.
3261 */
3262VMM_INT_DECL(void) APICDequeueInterruptFromService(PVMCPUCC pVCpu, uint8_t u8PendingIntr)
3263{
3264 VMCPU_ASSERT_EMT(pVCpu);
3265
3266 PVMCC pVM = pVCpu->CTX_SUFF(pVM);
3267 PAPIC pApic = VM_TO_APIC(pVM);
3268 Assert(!pApic->fVirtApicRegsEnabled);
3269 NOREF(pApic);
3270
3271 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
3272 bool const fInService = apicTestVectorInReg(&pXApicPage->isr, u8PendingIntr);
3273 if (fInService)
3274 {
3275 apicClearVectorInReg(&pXApicPage->isr, u8PendingIntr);
3276 apicSetVectorInReg(&pXApicPage->irr, u8PendingIntr);
3277 apicUpdatePpr(pVCpu);
3278 }
3279}
3280
3281
3282/**
3283 * Updates pending interrupts from the pending-interrupt bitmaps to the IRR.
3284 *
3285 * @param pVCpu The cross context virtual CPU structure.
3286 *
3287 * @note NEM/win is ASSUMING the an up to date TPR is not required here.
3288 */
3289VMMDECL(void) APICUpdatePendingInterrupts(PVMCPUCC pVCpu)
3290{
3291 VMCPU_ASSERT_EMT_OR_NOT_RUNNING(pVCpu);
3292
3293 PAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
3294 PXAPICPAGE pXApicPage = VMCPU_TO_XAPICPAGE(pVCpu);
3295 bool fHasPendingIntrs = false;
3296
3297 Log3(("APIC%u: APICUpdatePendingInterrupts:\n", pVCpu->idCpu));
3298 STAM_PROFILE_START(&pApicCpu->StatUpdatePendingIntrs, a);
3299
3300 /* Update edge-triggered pending interrupts. */
3301 PAPICPIB pPib = (PAPICPIB)pApicCpu->CTX_SUFF(pvApicPib);
3302 for (;;)
3303 {
3304 uint32_t const fAlreadySet = apicClearNotificationBitInPib((PAPICPIB)pApicCpu->CTX_SUFF(pvApicPib));
3305 if (!fAlreadySet)
3306 break;
3307
3308 AssertCompile(RT_ELEMENTS(pXApicPage->irr.u) == 2 * RT_ELEMENTS(pPib->au64VectorBitmap));
3309 for (size_t idxPib = 0, idxReg = 0; idxPib < RT_ELEMENTS(pPib->au64VectorBitmap); idxPib++, idxReg += 2)
3310 {
3311 uint64_t const u64Fragment = ASMAtomicXchgU64(&pPib->au64VectorBitmap[idxPib], 0);
3312 if (u64Fragment)
3313 {
3314 uint32_t const u32FragmentLo = RT_LO_U32(u64Fragment);
3315 uint32_t const u32FragmentHi = RT_HI_U32(u64Fragment);
3316
3317 pXApicPage->irr.u[idxReg].u32Reg |= u32FragmentLo;
3318 pXApicPage->irr.u[idxReg + 1].u32Reg |= u32FragmentHi;
3319
3320 pXApicPage->tmr.u[idxReg].u32Reg &= ~u32FragmentLo;
3321 pXApicPage->tmr.u[idxReg + 1].u32Reg &= ~u32FragmentHi;
3322 fHasPendingIntrs = true;
3323 }
3324 }
3325 }
3326
3327 /* Update level-triggered pending interrupts. */
3328 pPib = (PAPICPIB)&pApicCpu->ApicPibLevel;
3329 for (;;)
3330 {
3331 uint32_t const fAlreadySet = apicClearNotificationBitInPib((PAPICPIB)&pApicCpu->ApicPibLevel);
3332 if (!fAlreadySet)
3333 break;
3334
3335 AssertCompile(RT_ELEMENTS(pXApicPage->irr.u) == 2 * RT_ELEMENTS(pPib->au64VectorBitmap));
3336 for (size_t idxPib = 0, idxReg = 0; idxPib < RT_ELEMENTS(pPib->au64VectorBitmap); idxPib++, idxReg += 2)
3337 {
3338 uint64_t const u64Fragment = ASMAtomicXchgU64(&pPib->au64VectorBitmap[idxPib], 0);
3339 if (u64Fragment)
3340 {
3341 uint32_t const u32FragmentLo = RT_LO_U32(u64Fragment);
3342 uint32_t const u32FragmentHi = RT_HI_U32(u64Fragment);
3343
3344 pXApicPage->irr.u[idxReg].u32Reg |= u32FragmentLo;
3345 pXApicPage->irr.u[idxReg + 1].u32Reg |= u32FragmentHi;
3346
3347 pXApicPage->tmr.u[idxReg].u32Reg |= u32FragmentLo;
3348 pXApicPage->tmr.u[idxReg + 1].u32Reg |= u32FragmentHi;
3349 fHasPendingIntrs = true;
3350 }
3351 }
3352 }
3353
3354 STAM_PROFILE_STOP(&pApicCpu->StatUpdatePendingIntrs, a);
3355 Log3(("APIC%u: APICUpdatePendingInterrupts: fHasPendingIntrs=%RTbool\n", pVCpu->idCpu, fHasPendingIntrs));
3356
3357 if ( fHasPendingIntrs
3358 && !VMCPU_FF_IS_SET(pVCpu, VMCPU_FF_INTERRUPT_APIC))
3359 apicSignalNextPendingIntr(pVCpu);
3360}
3361
3362
3363/**
3364 * Gets the highest priority pending interrupt.
3365 *
3366 * @returns true if any interrupt is pending, false otherwise.
3367 * @param pVCpu The cross context virtual CPU structure.
3368 * @param pu8PendingIntr Where to store the interrupt vector if the
3369 * interrupt is pending.
3370 */
3371VMM_INT_DECL(bool) APICGetHighestPendingInterrupt(PVMCPUCC pVCpu, uint8_t *pu8PendingIntr)
3372{
3373 VMCPU_ASSERT_EMT(pVCpu);
3374 return apicGetHighestPendingInterrupt(pVCpu, pu8PendingIntr);
3375}
3376
3377
3378/**
3379 * Posts an interrupt to a target APIC, Hyper-V interface.
3380 *
3381 * @returns true if the interrupt was accepted, false otherwise.
3382 * @param pVCpu The cross context virtual CPU structure.
3383 * @param uVector The vector of the interrupt to be posted.
3384 * @param fAutoEoi Whether this interrupt has automatic EOI
3385 * treatment.
3386 * @param enmTriggerMode The trigger mode of the interrupt.
3387 *
3388 * @thread Any.
3389 */
3390VMM_INT_DECL(void) APICHvSendInterrupt(PVMCPUCC pVCpu, uint8_t uVector, bool fAutoEoi, XAPICTRIGGERMODE enmTriggerMode)
3391{
3392 Assert(pVCpu);
3393 Assert(!fAutoEoi); /** @todo AutoEOI. */
3394 RT_NOREF(fAutoEoi);
3395 apicPostInterrupt(pVCpu, uVector, enmTriggerMode, 0 /* uSrcTag */);
3396}
3397
3398
3399/**
3400 * Sets the Task Priority Register (TPR), Hyper-V interface.
3401 *
3402 * @returns Strict VBox status code.
3403 * @param pVCpu The cross context virtual CPU structure.
3404 * @param uTpr The TPR value to set.
3405 *
3406 * @remarks Validates like in x2APIC mode.
3407 */
3408VMM_INT_DECL(VBOXSTRICTRC) APICHvSetTpr(PVMCPUCC pVCpu, uint8_t uTpr)
3409{
3410 Assert(pVCpu);
3411 VMCPU_ASSERT_EMT(pVCpu);
3412 return apicSetTprEx(pVCpu, uTpr, true /* fForceX2ApicBehaviour */);
3413}
3414
3415
3416/**
3417 * Gets the Task Priority Register (TPR), Hyper-V interface.
3418 *
3419 * @returns The TPR value.
3420 * @param pVCpu The cross context virtual CPU structure.
3421 */
3422VMM_INT_DECL(uint8_t) APICHvGetTpr(PVMCPUCC pVCpu)
3423{
3424 Assert(pVCpu);
3425 VMCPU_ASSERT_EMT(pVCpu);
3426
3427 /*
3428 * The APIC could be operating in xAPIC mode and thus we should not use the apicReadMsr()
3429 * interface which validates the APIC mode and will throw a #GP(0) if not in x2APIC mode.
3430 * We could use the apicReadRegister() MMIO interface, but why bother getting the PDMDEVINS
3431 * pointer, so just directly read the APIC page.
3432 */
3433 PCXAPICPAGE pXApicPage = VMCPU_TO_CXAPICPAGE(pVCpu);
3434 return apicReadRaw32(pXApicPage, XAPIC_OFF_TPR);
3435}
3436
3437
3438/**
3439 * Sets the Interrupt Command Register (ICR), Hyper-V interface.
3440 *
3441 * @returns Strict VBox status code.
3442 * @param pVCpu The cross context virtual CPU structure.
3443 * @param uIcr The ICR value to set.
3444 */
3445VMM_INT_DECL(VBOXSTRICTRC) APICHvSetIcr(PVMCPUCC pVCpu, uint64_t uIcr)
3446{
3447 Assert(pVCpu);
3448 VMCPU_ASSERT_EMT(pVCpu);
3449 return apicSetIcr(pVCpu, uIcr, VINF_CPUM_R3_MSR_WRITE);
3450}
3451
3452
3453/**
3454 * Gets the Interrupt Command Register (ICR), Hyper-V interface.
3455 *
3456 * @returns The ICR value.
3457 * @param pVCpu The cross context virtual CPU structure.
3458 */
3459VMM_INT_DECL(uint64_t) APICHvGetIcr(PVMCPUCC pVCpu)
3460{
3461 Assert(pVCpu);
3462 VMCPU_ASSERT_EMT(pVCpu);
3463 return apicGetIcrNoCheck(pVCpu);
3464}
3465
3466
3467/**
3468 * Sets the End-Of-Interrupt (EOI) register, Hyper-V interface.
3469 *
3470 * @returns Strict VBox status code.
3471 * @param pVCpu The cross context virtual CPU structure.
3472 * @param uEoi The EOI value.
3473 */
3474VMM_INT_DECL(VBOXSTRICTRC) APICHvSetEoi(PVMCPUCC pVCpu, uint32_t uEoi)
3475{
3476 Assert(pVCpu);
3477 VMCPU_ASSERT_EMT_OR_NOT_RUNNING(pVCpu);
3478 return apicSetEoi(pVCpu, uEoi, VINF_CPUM_R3_MSR_WRITE, true /* fForceX2ApicBehaviour */);
3479}
3480
3481
3482/**
3483 * Gets the APIC page pointers for the specified VCPU.
3484 *
3485 * @returns VBox status code.
3486 * @param pVCpu The cross context virtual CPU structure.
3487 * @param pHCPhys Where to store the host-context physical address.
3488 * @param pR0Ptr Where to store the ring-0 address.
3489 * @param pR3Ptr Where to store the ring-3 address (optional).
3490 */
3491VMM_INT_DECL(int) APICGetApicPageForCpu(PCVMCPUCC pVCpu, PRTHCPHYS pHCPhys, PRTR0PTR pR0Ptr, PRTR3PTR pR3Ptr)
3492{
3493 AssertReturn(pVCpu, VERR_INVALID_PARAMETER);
3494 AssertReturn(pHCPhys, VERR_INVALID_PARAMETER);
3495 AssertReturn(pR0Ptr, VERR_INVALID_PARAMETER);
3496
3497 Assert(PDMHasApic(pVCpu->CTX_SUFF(pVM)));
3498
3499 PCAPICCPU pApicCpu = VMCPU_TO_APICCPU(pVCpu);
3500 *pHCPhys = pApicCpu->HCPhysApicPage;
3501 *pR0Ptr = pApicCpu->pvApicPageR0;
3502 if (pR3Ptr)
3503 *pR3Ptr = pApicCpu->pvApicPageR3;
3504 return VINF_SUCCESS;
3505}
3506
3507
3508/**
3509 * APIC device registration structure.
3510 */
3511const PDMDEVREG g_DeviceAPIC =
3512{
3513 /* .u32Version = */ PDM_DEVREG_VERSION,
3514 /* .uReserved0 = */ 0,
3515 /* .szName = */ "apic",
3516 /* .fFlags = */ PDM_DEVREG_FLAGS_DEFAULT_BITS | PDM_DEVREG_FLAGS_RZ,
3517 /* .fClass = */ PDM_DEVREG_CLASS_PIC,
3518 /* .cMaxInstances = */ 1,
3519 /* .uSharedVersion = */ 42,
3520 /* .cbInstanceShared = */ sizeof(APICDEV),
3521 /* .cbInstanceCC = */ 0,
3522 /* .cbInstanceRC = */ 0,
3523 /* .cMaxPciDevices = */ 0,
3524 /* .cMaxMsixVectors = */ 0,
3525 /* .pszDescription = */ "Advanced Programmable Interrupt Controller",
3526#if defined(IN_RING3)
3527 /* .szRCMod = */ "VMMRC.rc",
3528 /* .szR0Mod = */ "VMMR0.r0",
3529 /* .pfnConstruct = */ apicR3Construct,
3530 /* .pfnDestruct = */ apicR3Destruct,
3531 /* .pfnRelocate = */ apicR3Relocate,
3532 /* .pfnMemSetup = */ NULL,
3533 /* .pfnPowerOn = */ NULL,
3534 /* .pfnReset = */ apicR3Reset,
3535 /* .pfnSuspend = */ NULL,
3536 /* .pfnResume = */ NULL,
3537 /* .pfnAttach = */ NULL,
3538 /* .pfnDetach = */ NULL,
3539 /* .pfnQueryInterface = */ NULL,
3540 /* .pfnInitComplete = */ apicR3InitComplete,
3541 /* .pfnPowerOff = */ NULL,
3542 /* .pfnSoftReset = */ NULL,
3543 /* .pfnReserved0 = */ NULL,
3544 /* .pfnReserved1 = */ NULL,
3545 /* .pfnReserved2 = */ NULL,
3546 /* .pfnReserved3 = */ NULL,
3547 /* .pfnReserved4 = */ NULL,
3548 /* .pfnReserved5 = */ NULL,
3549 /* .pfnReserved6 = */ NULL,
3550 /* .pfnReserved7 = */ NULL,
3551#elif defined(IN_RING0)
3552 /* .pfnEarlyConstruct = */ NULL,
3553 /* .pfnConstruct = */ NULL,
3554 /* .pfnDestruct = */ NULL,
3555 /* .pfnFinalDestruct = */ NULL,
3556 /* .pfnRequest = */ NULL,
3557 /* .pfnReserved0 = */ NULL,
3558 /* .pfnReserved1 = */ NULL,
3559 /* .pfnReserved2 = */ NULL,
3560 /* .pfnReserved3 = */ NULL,
3561 /* .pfnReserved4 = */ NULL,
3562 /* .pfnReserved5 = */ NULL,
3563 /* .pfnReserved6 = */ NULL,
3564 /* .pfnReserved7 = */ NULL,
3565#elif defined(IN_RC)
3566 /* .pfnConstruct = */ NULL,
3567 /* .pfnReserved0 = */ NULL,
3568 /* .pfnReserved1 = */ NULL,
3569 /* .pfnReserved2 = */ NULL,
3570 /* .pfnReserved3 = */ NULL,
3571 /* .pfnReserved4 = */ NULL,
3572 /* .pfnReserved5 = */ NULL,
3573 /* .pfnReserved6 = */ NULL,
3574 /* .pfnReserved7 = */ NULL,
3575#else
3576# error "Not in IN_RING3, IN_RING0 or IN_RC!"
3577#endif
3578 /* .u32VersionEnd = */ PDM_DEVREG_VERSION
3579};
3580
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