2 * Copyright (c) 2011 NetApp, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
34 #include <sys/kernel.h>
35 #include <sys/malloc.h>
36 #include <sys/mutex.h>
37 #include <sys/systm.h>
40 #include <x86/specialreg.h>
41 #include <x86/apicreg.h>
43 #include <machine/clock.h>
44 #include <machine/smp.h>
46 #include <machine/vmm.h>
49 #include "vmm_lapic.h"
54 #include "vlapic_priv.h"
57 #define VLAPIC_CTR0(vlapic, format) \
58 VCPU_CTR0((vlapic)->vm, (vlapic)->vcpuid, format)
60 #define VLAPIC_CTR1(vlapic, format, p1) \
61 VCPU_CTR1((vlapic)->vm, (vlapic)->vcpuid, format, p1)
63 #define VLAPIC_CTR2(vlapic, format, p1, p2) \
64 VCPU_CTR2((vlapic)->vm, (vlapic)->vcpuid, format, p1, p2)
66 #define VLAPIC_CTR_IRR(vlapic, msg) \
68 uint32_t *irrptr = &(vlapic)->apic_page->irr0; \
69 irrptr[0] = irrptr[0]; /* silence compiler */ \
70 VLAPIC_CTR1((vlapic), msg " irr0 0x%08x", irrptr[0 << 2]); \
71 VLAPIC_CTR1((vlapic), msg " irr1 0x%08x", irrptr[1 << 2]); \
72 VLAPIC_CTR1((vlapic), msg " irr2 0x%08x", irrptr[2 << 2]); \
73 VLAPIC_CTR1((vlapic), msg " irr3 0x%08x", irrptr[3 << 2]); \
74 VLAPIC_CTR1((vlapic), msg " irr4 0x%08x", irrptr[4 << 2]); \
75 VLAPIC_CTR1((vlapic), msg " irr5 0x%08x", irrptr[5 << 2]); \
76 VLAPIC_CTR1((vlapic), msg " irr6 0x%08x", irrptr[6 << 2]); \
77 VLAPIC_CTR1((vlapic), msg " irr7 0x%08x", irrptr[7 << 2]); \
80 #define VLAPIC_CTR_ISR(vlapic, msg) \
82 uint32_t *isrptr = &(vlapic)->apic_page->isr0; \
83 isrptr[0] = isrptr[0]; /* silence compiler */ \
84 VLAPIC_CTR1((vlapic), msg " isr0 0x%08x", isrptr[0 << 2]); \
85 VLAPIC_CTR1((vlapic), msg " isr1 0x%08x", isrptr[1 << 2]); \
86 VLAPIC_CTR1((vlapic), msg " isr2 0x%08x", isrptr[2 << 2]); \
87 VLAPIC_CTR1((vlapic), msg " isr3 0x%08x", isrptr[3 << 2]); \
88 VLAPIC_CTR1((vlapic), msg " isr4 0x%08x", isrptr[4 << 2]); \
89 VLAPIC_CTR1((vlapic), msg " isr5 0x%08x", isrptr[5 << 2]); \
90 VLAPIC_CTR1((vlapic), msg " isr6 0x%08x", isrptr[6 << 2]); \
91 VLAPIC_CTR1((vlapic), msg " isr7 0x%08x", isrptr[7 << 2]); \
94 #define PRIO(x) ((x) >> 4)
96 #define VLAPIC_VERSION (16)
97 #define VLAPIC_MAXLVT_ENTRIES (APIC_LVT_CMCI)
99 #define x2apic(vlapic) (((vlapic)->msr_apicbase & APICBASE_X2APIC) ? 1 : 0)
102 * The 'vlapic->timer_mtx' is used to provide mutual exclusion between the
103 * vlapic_callout_handler() and vcpu accesses to the following registers:
104 * - initial count register aka icr_timer
105 * - current count register aka ccr_timer
106 * - divide config register aka dcr_timer
107 * - timer LVT register
109 * Note that the vlapic_callout_handler() does not write to any of these
110 * registers so they can be safely read from the vcpu context without locking.
112 #define VLAPIC_TIMER_LOCK(vlapic) mtx_lock_spin(&((vlapic)->timer_mtx))
113 #define VLAPIC_TIMER_UNLOCK(vlapic) mtx_unlock_spin(&((vlapic)->timer_mtx))
114 #define VLAPIC_TIMER_LOCKED(vlapic) mtx_owned(&((vlapic)->timer_mtx))
116 #define VLAPIC_BUS_FREQ tsc_freq
118 static __inline uint32_t
119 vlapic_get_id(struct vlapic *vlapic)
123 return (vlapic->vcpuid);
125 return (vlapic->vcpuid << 24);
128 static __inline uint32_t
129 vlapic_get_ldr(struct vlapic *vlapic)
135 lapic = vlapic->apic_page;
136 if (x2apic(vlapic)) {
137 apicid = vlapic_get_id(vlapic);
138 ldr = 1 << (apicid & 0xf);
139 ldr |= (apicid & 0xffff0) << 12;
145 static __inline uint32_t
146 vlapic_get_dfr(struct vlapic *vlapic)
150 lapic = vlapic->apic_page;
158 vlapic_set_dfr(struct vlapic *vlapic, uint32_t data)
163 if (x2apic(vlapic)) {
164 VM_CTR1(vlapic->vm, "write to DFR in x2apic mode: %#x", data);
168 lapic = vlapic->apic_page;
169 dfr = (lapic->dfr & APIC_DFR_RESERVED) | (data & APIC_DFR_MODEL_MASK);
170 if ((dfr & APIC_DFR_MODEL_MASK) == APIC_DFR_MODEL_FLAT)
171 VLAPIC_CTR0(vlapic, "vlapic DFR in Flat Model");
172 else if ((dfr & APIC_DFR_MODEL_MASK) == APIC_DFR_MODEL_CLUSTER)
173 VLAPIC_CTR0(vlapic, "vlapic DFR in Cluster Model");
175 VLAPIC_CTR1(vlapic, "vlapic DFR in Unknown Model %#x", dfr);
181 vlapic_set_ldr(struct vlapic *vlapic, uint32_t data)
185 /* LDR is read-only in x2apic mode */
186 if (x2apic(vlapic)) {
187 VLAPIC_CTR1(vlapic, "write to LDR in x2apic mode: %#x", data);
191 lapic = vlapic->apic_page;
192 lapic->ldr = data & ~APIC_LDR_RESERVED;
193 VLAPIC_CTR1(vlapic, "vlapic LDR set to %#x", lapic->ldr);
197 vlapic_timer_divisor(uint32_t dcr)
217 panic("vlapic_timer_divisor: invalid dcr 0x%08x", dcr);
222 vlapic_mask_lvts(uint32_t *lvts, int num_lvt)
225 for (i = 0; i < num_lvt; i++) {
233 vlapic_dump_lvt(uint32_t offset, uint32_t *lvt)
235 printf("Offset %x: lvt %08x (V:%02x DS:%x M:%x)\n", offset,
236 *lvt, *lvt & APIC_LVTT_VECTOR, *lvt & APIC_LVTT_DS,
242 vlapic_get_ccr(struct vlapic *vlapic)
244 struct bintime bt_now, bt_rem;
249 lapic = vlapic->apic_page;
251 VLAPIC_TIMER_LOCK(vlapic);
252 if (callout_active(&vlapic->callout)) {
254 * If the timer is scheduled to expire in the future then
255 * compute the value of 'ccr' based on the remaining time.
258 if (bintime_cmp(&vlapic->timer_fire_bt, &bt_now, >)) {
259 bt_rem = vlapic->timer_fire_bt;
260 bintime_sub(&bt_rem, &bt_now);
261 ccr += bt_rem.sec * BT2FREQ(&vlapic->timer_freq_bt);
262 ccr += bt_rem.frac / vlapic->timer_freq_bt.frac;
265 KASSERT(ccr <= lapic->icr_timer, ("vlapic_get_ccr: invalid ccr %#x, "
266 "icr_timer is %#x", ccr, lapic->icr_timer));
267 VLAPIC_CTR2(vlapic, "vlapic ccr_timer = %#x, icr_timer = %#x",
268 ccr, lapic->icr_timer);
269 VLAPIC_TIMER_UNLOCK(vlapic);
274 vlapic_set_dcr(struct vlapic *vlapic, uint32_t dcr)
279 lapic = vlapic->apic_page;
280 VLAPIC_TIMER_LOCK(vlapic);
282 lapic->dcr_timer = dcr;
283 divisor = vlapic_timer_divisor(dcr);
284 VLAPIC_CTR2(vlapic, "vlapic dcr_timer=%#x, divisor=%d", dcr, divisor);
287 * Update the timer frequency and the timer period.
289 * XXX changes to the frequency divider will not take effect until
290 * the timer is reloaded.
292 FREQ2BT(VLAPIC_BUS_FREQ / divisor, &vlapic->timer_freq_bt);
293 vlapic->timer_period_bt = vlapic->timer_freq_bt;
294 bintime_mul(&vlapic->timer_period_bt, lapic->icr_timer);
296 VLAPIC_TIMER_UNLOCK(vlapic);
300 vlapic_update_errors(struct vlapic *vlapic)
304 lapic = vlapic->apic_page;
305 lapic->esr = vlapic->esr_pending;
306 vlapic->esr_pending = 0;
310 vlapic_reset(struct vlapic *vlapic)
314 lapic = vlapic->apic_page;
315 bzero(lapic, sizeof(struct LAPIC));
317 lapic->version = VLAPIC_VERSION;
318 lapic->version |= (VLAPIC_MAXLVT_ENTRIES << MAXLVTSHIFT);
319 lapic->dfr = 0xffffffff;
320 lapic->svr = APIC_SVR_VECTOR;
321 vlapic_mask_lvts(&lapic->lvt_timer, 6);
322 vlapic_mask_lvts(&lapic->lvt_cmci, 1);
323 vlapic_set_dcr(vlapic, 0);
325 if (vlapic->vcpuid == 0)
326 vlapic->boot_state = BS_RUNNING; /* BSP */
328 vlapic->boot_state = BS_INIT; /* AP */
332 vlapic_set_intr_ready(struct vlapic *vlapic, int vector, bool level)
334 struct LAPIC *lapic = vlapic->apic_page;
335 uint32_t *irrptr, *tmrptr, mask;
338 if (vector < 0 || vector >= 256)
339 panic("vlapic_set_intr_ready: invalid vector %d\n", vector);
341 if (!(lapic->svr & APIC_SVR_ENABLE)) {
342 VLAPIC_CTR1(vlapic, "vlapic is software disabled, ignoring "
343 "interrupt %d", vector);
348 vlapic_set_error(vlapic, APIC_ESR_RECEIVE_ILLEGAL_VECTOR);
352 idx = (vector / 32) * 4;
353 mask = 1 << (vector % 32);
355 irrptr = &lapic->irr0;
356 atomic_set_int(&irrptr[idx], mask);
359 * Upon acceptance of an interrupt into the IRR the corresponding
360 * TMR bit is cleared for edge-triggered interrupts and set for
361 * level-triggered interrupts.
363 tmrptr = &lapic->tmr0;
365 atomic_set_int(&tmrptr[idx], mask);
367 atomic_clear_int(&tmrptr[idx], mask);
369 VLAPIC_CTR_IRR(vlapic, "vlapic_set_intr_ready");
372 static __inline uint32_t *
373 vlapic_get_lvtptr(struct vlapic *vlapic, uint32_t offset)
375 struct LAPIC *lapic = vlapic->apic_page;
379 case APIC_OFFSET_CMCI_LVT:
380 return (&lapic->lvt_cmci);
381 case APIC_OFFSET_TIMER_LVT ... APIC_OFFSET_ERROR_LVT:
382 i = (offset - APIC_OFFSET_TIMER_LVT) >> 2;
383 return ((&lapic->lvt_timer) + i);;
385 panic("vlapic_get_lvt: invalid LVT\n");
389 static __inline uint32_t
390 vlapic_get_lvt(struct vlapic *vlapic, uint32_t offset)
393 return (*vlapic_get_lvtptr(vlapic, offset));
397 vlapic_set_lvt(struct vlapic *vlapic, uint32_t offset, uint32_t val)
399 uint32_t *lvtptr, mask;
402 lapic = vlapic->apic_page;
403 lvtptr = vlapic_get_lvtptr(vlapic, offset);
405 if (offset == APIC_OFFSET_TIMER_LVT)
406 VLAPIC_TIMER_LOCK(vlapic);
408 if (!(lapic->svr & APIC_SVR_ENABLE))
410 mask = APIC_LVT_M | APIC_LVT_DS | APIC_LVT_VECTOR;
412 case APIC_OFFSET_TIMER_LVT:
413 mask |= APIC_LVTT_TM;
415 case APIC_OFFSET_ERROR_LVT:
417 case APIC_OFFSET_LINT0_LVT:
418 case APIC_OFFSET_LINT1_LVT:
419 mask |= APIC_LVT_TM | APIC_LVT_RIRR | APIC_LVT_IIPP;
425 *lvtptr = val & mask;
427 if (offset == APIC_OFFSET_TIMER_LVT)
428 VLAPIC_TIMER_UNLOCK(vlapic);
432 vlapic_fire_lvt(struct vlapic *vlapic, uint32_t lvt)
436 if (lvt & APIC_LVT_M)
439 vec = lvt & APIC_LVT_VECTOR;
440 mode = lvt & APIC_LVT_DM;
443 case APIC_LVT_DM_FIXED:
445 vlapic_set_error(vlapic, APIC_ESR_SEND_ILLEGAL_VECTOR);
448 vlapic_set_intr_ready(vlapic, vec, false);
449 vcpu_notify_event(vlapic->vm, vlapic->vcpuid, true);
451 case APIC_LVT_DM_NMI:
452 vm_inject_nmi(vlapic->vm, vlapic->vcpuid);
455 // Other modes ignored
463 dump_isrvec_stk(struct vlapic *vlapic)
468 isrptr = &vlapic->apic_page->isr0;
469 for (i = 0; i < 8; i++)
470 printf("ISR%d 0x%08x\n", i, isrptr[i * 4]);
472 for (i = 0; i <= vlapic->isrvec_stk_top; i++)
473 printf("isrvec_stk[%d] = %d\n", i, vlapic->isrvec_stk[i]);
478 * Algorithm adopted from section "Interrupt, Task and Processor Priority"
479 * in Intel Architecture Manual Vol 3a.
482 vlapic_update_ppr(struct vlapic *vlapic)
484 int isrvec, tpr, ppr;
487 * Note that the value on the stack at index 0 is always 0.
489 * This is a placeholder for the value of ISRV when none of the
490 * bits is set in the ISRx registers.
492 isrvec = vlapic->isrvec_stk[vlapic->isrvec_stk_top];
493 tpr = vlapic->apic_page->tpr;
497 int i, lastprio, curprio, vector, idx;
500 if (vlapic->isrvec_stk_top == 0 && isrvec != 0)
501 panic("isrvec_stk is corrupted: %d", isrvec);
504 * Make sure that the priority of the nested interrupts is
508 for (i = 1; i <= vlapic->isrvec_stk_top; i++) {
509 curprio = PRIO(vlapic->isrvec_stk[i]);
510 if (curprio <= lastprio) {
511 dump_isrvec_stk(vlapic);
512 panic("isrvec_stk does not satisfy invariant");
518 * Make sure that each bit set in the ISRx registers has a
519 * corresponding entry on the isrvec stack.
522 isrptr = &vlapic->apic_page->isr0;
523 for (vector = 0; vector < 256; vector++) {
524 idx = (vector / 32) * 4;
525 if (isrptr[idx] & (1 << (vector % 32))) {
526 if (i > vlapic->isrvec_stk_top ||
527 vlapic->isrvec_stk[i] != vector) {
528 dump_isrvec_stk(vlapic);
529 panic("ISR and isrvec_stk out of sync");
537 if (PRIO(tpr) >= PRIO(isrvec))
542 vlapic->apic_page->ppr = ppr;
543 VLAPIC_CTR1(vlapic, "vlapic_update_ppr 0x%02x", ppr);
547 vlapic_process_eoi(struct vlapic *vlapic)
549 struct LAPIC *lapic = vlapic->apic_page;
550 uint32_t *isrptr, *tmrptr;
551 int i, idx, bitpos, vector;
553 isrptr = &lapic->isr0;
554 tmrptr = &lapic->tmr0;
557 * The x86 architecture reserves the the first 32 vectors for use
560 for (i = 7; i > 0; i--) {
562 bitpos = fls(isrptr[idx]);
564 if (vlapic->isrvec_stk_top <= 0) {
565 panic("invalid vlapic isrvec_stk_top %d",
566 vlapic->isrvec_stk_top);
568 isrptr[idx] &= ~(1 << bitpos);
569 VLAPIC_CTR_ISR(vlapic, "vlapic_process_eoi");
570 vlapic->isrvec_stk_top--;
571 vlapic_update_ppr(vlapic);
572 if ((tmrptr[idx] & (1 << bitpos)) != 0) {
573 vector = i * 32 + bitpos;
574 vioapic_process_eoi(vlapic->vm, vlapic->vcpuid,
583 vlapic_get_lvt_field(uint32_t lvt, uint32_t mask)
590 vlapic_periodic_timer(struct vlapic *vlapic)
594 lvt = vlapic_get_lvt(vlapic, APIC_OFFSET_TIMER_LVT);
596 return (vlapic_get_lvt_field(lvt, APIC_LVTT_TM_PERIODIC));
599 static VMM_STAT(VLAPIC_INTR_ERROR, "error interrupts generated by vlapic");
602 vlapic_set_error(struct vlapic *vlapic, uint32_t mask)
606 vlapic->esr_pending |= mask;
607 if (vlapic->esr_firing)
609 vlapic->esr_firing = 1;
611 // The error LVT always uses the fixed delivery mode.
612 lvt = vlapic_get_lvt(vlapic, APIC_OFFSET_ERROR_LVT);
613 if (vlapic_fire_lvt(vlapic, lvt | APIC_LVT_DM_FIXED)) {
614 vmm_stat_incr(vlapic->vm, vlapic->vcpuid, VLAPIC_INTR_ERROR, 1);
616 vlapic->esr_firing = 0;
619 static VMM_STAT(VLAPIC_INTR_TIMER, "timer interrupts generated by vlapic");
622 vlapic_fire_timer(struct vlapic *vlapic)
626 KASSERT(VLAPIC_TIMER_LOCKED(vlapic), ("vlapic_fire_timer not locked"));
628 // The timer LVT always uses the fixed delivery mode.
629 lvt = vlapic_get_lvt(vlapic, APIC_OFFSET_TIMER_LVT);
630 if (vlapic_fire_lvt(vlapic, lvt | APIC_LVT_DM_FIXED)) {
631 vmm_stat_incr(vlapic->vm, vlapic->vcpuid, VLAPIC_INTR_TIMER, 1);
635 static VMM_STAT(VLAPIC_INTR_CMC,
636 "corrected machine check interrupts generated by vlapic");
639 vlapic_fire_cmci(struct vlapic *vlapic)
643 lvt = vlapic_get_lvt(vlapic, APIC_OFFSET_CMCI_LVT);
644 if (vlapic_fire_lvt(vlapic, lvt)) {
645 vmm_stat_incr(vlapic->vm, vlapic->vcpuid, VLAPIC_INTR_CMC, 1);
649 static VMM_STAT_ARRAY(LVTS_TRIGGERRED, VLAPIC_MAXLVT_ENTRIES,
653 vlapic_trigger_lvt(struct vlapic *vlapic, int vector)
659 lvt = vlapic_get_lvt(vlapic, APIC_OFFSET_LINT0_LVT);
662 lvt = vlapic_get_lvt(vlapic, APIC_OFFSET_LINT1_LVT);
665 lvt = vlapic_get_lvt(vlapic, APIC_OFFSET_TIMER_LVT);
666 lvt |= APIC_LVT_DM_FIXED;
669 lvt = vlapic_get_lvt(vlapic, APIC_OFFSET_ERROR_LVT);
670 lvt |= APIC_LVT_DM_FIXED;
673 lvt = vlapic_get_lvt(vlapic, APIC_OFFSET_PERF_LVT);
675 case APIC_LVT_THERMAL:
676 lvt = vlapic_get_lvt(vlapic, APIC_OFFSET_THERM_LVT);
679 lvt = vlapic_get_lvt(vlapic, APIC_OFFSET_CMCI_LVT);
684 if (vlapic_fire_lvt(vlapic, lvt)) {
685 vmm_stat_array_incr(vlapic->vm, vlapic->vcpuid,
686 LVTS_TRIGGERRED, vector, 1);
692 vlapic_callout_handler(void *arg)
694 struct vlapic *vlapic;
695 struct bintime bt, btnow;
700 VLAPIC_TIMER_LOCK(vlapic);
701 if (callout_pending(&vlapic->callout)) /* callout was reset */
704 if (!callout_active(&vlapic->callout)) /* callout was stopped */
707 callout_deactivate(&vlapic->callout);
709 KASSERT(vlapic->apic_page->icr_timer != 0, ("timer is disabled"));
711 vlapic_fire_timer(vlapic);
713 if (vlapic_periodic_timer(vlapic)) {
715 KASSERT(bintime_cmp(&btnow, &vlapic->timer_fire_bt, >=),
716 ("vlapic callout at %#lx.%#lx, expected at %#lx.#%lx",
717 btnow.sec, btnow.frac, vlapic->timer_fire_bt.sec,
718 vlapic->timer_fire_bt.frac));
721 * Compute the delta between when the timer was supposed to
722 * fire and the present time.
725 bintime_sub(&bt, &vlapic->timer_fire_bt);
727 rem_sbt = bttosbt(vlapic->timer_period_bt);
728 if (bintime_cmp(&bt, &vlapic->timer_period_bt, <)) {
730 * Adjust the time until the next countdown downward
731 * to account for the lost time.
733 rem_sbt -= bttosbt(bt);
736 * If the delta is greater than the timer period then
737 * just reset our time base instead of trying to catch
740 vlapic->timer_fire_bt = btnow;
741 VLAPIC_CTR2(vlapic, "vlapic timer lagging by %lu "
742 "usecs, period is %lu usecs - resetting time base",
743 bttosbt(bt) / SBT_1US,
744 bttosbt(vlapic->timer_period_bt) / SBT_1US);
747 bintime_add(&vlapic->timer_fire_bt, &vlapic->timer_period_bt);
748 callout_reset_sbt(&vlapic->callout, rem_sbt, 0,
749 vlapic_callout_handler, vlapic, 0);
752 VLAPIC_TIMER_UNLOCK(vlapic);
756 vlapic_set_icr_timer(struct vlapic *vlapic, uint32_t icr_timer)
761 VLAPIC_TIMER_LOCK(vlapic);
763 lapic = vlapic->apic_page;
764 lapic->icr_timer = icr_timer;
766 vlapic->timer_period_bt = vlapic->timer_freq_bt;
767 bintime_mul(&vlapic->timer_period_bt, icr_timer);
769 if (icr_timer != 0) {
770 binuptime(&vlapic->timer_fire_bt);
771 bintime_add(&vlapic->timer_fire_bt, &vlapic->timer_period_bt);
773 sbt = bttosbt(vlapic->timer_period_bt);
774 callout_reset_sbt(&vlapic->callout, sbt, 0,
775 vlapic_callout_handler, vlapic, 0);
777 callout_stop(&vlapic->callout);
779 VLAPIC_TIMER_UNLOCK(vlapic);
783 * This function populates 'dmask' with the set of vcpus that match the
784 * addressing specified by the (dest, phys, lowprio) tuple.
786 * 'x2apic_dest' specifies whether 'dest' is interpreted as x2APIC (32-bit)
787 * or xAPIC (8-bit) destination field.
790 vlapic_calcdest(struct vm *vm, cpuset_t *dmask, uint32_t dest, bool phys,
791 bool lowprio, bool x2apic_dest)
793 struct vlapic *vlapic;
794 uint32_t dfr, ldr, ldest, cluster;
795 uint32_t mda_flat_ldest, mda_cluster_ldest, mda_ldest, mda_cluster_id;
799 if ((x2apic_dest && dest == 0xffffffff) ||
800 (!x2apic_dest && dest == 0xff)) {
802 * Broadcast in both logical and physical modes.
804 *dmask = vm_active_cpus(vm);
810 * Physical mode: destination is APIC ID.
813 vcpuid = vm_apicid2vcpuid(vm, dest);
814 if (vcpuid < VM_MAXCPU)
815 CPU_SET(vcpuid, dmask);
818 * In the "Flat Model" the MDA is interpreted as an 8-bit wide
819 * bitmask. This model is only avilable in the xAPIC mode.
821 mda_flat_ldest = dest & 0xff;
824 * In the "Cluster Model" the MDA is used to identify a
825 * specific cluster and a set of APICs in that cluster.
828 mda_cluster_id = dest >> 16;
829 mda_cluster_ldest = dest & 0xffff;
831 mda_cluster_id = (dest >> 4) & 0xf;
832 mda_cluster_ldest = dest & 0xf;
836 * Logical mode: match each APIC that has a bit set
837 * in it's LDR that matches a bit in the ldest.
840 amask = vm_active_cpus(vm);
841 while ((vcpuid = CPU_FFS(&amask)) != 0) {
843 CPU_CLR(vcpuid, &amask);
845 vlapic = vm_lapic(vm, vcpuid);
846 dfr = vlapic_get_dfr(vlapic);
847 ldr = vlapic_get_ldr(vlapic);
849 if ((dfr & APIC_DFR_MODEL_MASK) ==
850 APIC_DFR_MODEL_FLAT) {
852 mda_ldest = mda_flat_ldest;
853 } else if ((dfr & APIC_DFR_MODEL_MASK) ==
854 APIC_DFR_MODEL_CLUSTER) {
855 if (x2apic(vlapic)) {
857 ldest = ldr & 0xffff;
860 ldest = (ldr >> 24) & 0xf;
862 if (cluster != mda_cluster_id)
864 mda_ldest = mda_cluster_ldest;
867 * Guest has configured a bad logical
868 * model for this vcpu - skip it.
870 VLAPIC_CTR1(vlapic, "vlapic has bad logical "
871 "model %x - cannot deliver interrupt", dfr);
875 if ((mda_ldest & ldest) != 0) {
876 CPU_SET(vcpuid, dmask);
884 static VMM_STAT_ARRAY(IPIS_SENT, VM_MAXCPU, "ipis sent to vcpu");
887 lapic_process_icr(struct vlapic *vlapic, uint64_t icrval, bool *retu)
892 uint32_t dest, vec, mode;
893 struct vlapic *vlapic2;
894 struct vm_exit *vmexit;
899 dest = icrval >> (32 + 24);
900 vec = icrval & APIC_VECTOR_MASK;
901 mode = icrval & APIC_DELMODE_MASK;
903 if (mode == APIC_DELMODE_FIXED && vec < 16) {
904 vlapic_set_error(vlapic, APIC_ESR_SEND_ILLEGAL_VECTOR);
908 if (mode == APIC_DELMODE_FIXED || mode == APIC_DELMODE_NMI) {
909 switch (icrval & APIC_DEST_MASK) {
910 case APIC_DEST_DESTFLD:
911 phys = ((icrval & APIC_DESTMODE_LOG) == 0);
912 vlapic_calcdest(vlapic->vm, &dmask, dest, phys, false,
916 CPU_SETOF(vlapic->vcpuid, &dmask);
918 case APIC_DEST_ALLISELF:
919 dmask = vm_active_cpus(vlapic->vm);
921 case APIC_DEST_ALLESELF:
922 dmask = vm_active_cpus(vlapic->vm);
923 CPU_CLR(vlapic->vcpuid, &dmask);
926 CPU_ZERO(&dmask); /* satisfy gcc */
930 while ((i = CPU_FFS(&dmask)) != 0) {
933 if (mode == APIC_DELMODE_FIXED) {
934 lapic_intr_edge(vlapic->vm, i, vec);
935 vmm_stat_array_incr(vlapic->vm, vlapic->vcpuid,
938 vm_inject_nmi(vlapic->vm, i);
941 return (0); /* handled completely in the kernel */
944 if (mode == APIC_DELMODE_INIT) {
945 if ((icrval & APIC_LEVEL_MASK) == APIC_LEVEL_DEASSERT)
948 if (vlapic->vcpuid == 0 && dest != 0 && dest < VM_MAXCPU) {
949 vlapic2 = vm_lapic(vlapic->vm, dest);
951 /* move from INIT to waiting-for-SIPI state */
952 if (vlapic2->boot_state == BS_INIT) {
953 vlapic2->boot_state = BS_SIPI;
960 if (mode == APIC_DELMODE_STARTUP) {
961 if (vlapic->vcpuid == 0 && dest != 0 && dest < VM_MAXCPU) {
962 vlapic2 = vm_lapic(vlapic->vm, dest);
965 * Ignore SIPIs in any state other than wait-for-SIPI
967 if (vlapic2->boot_state != BS_SIPI)
971 * XXX this assumes that the startup IPI always succeeds
973 vlapic2->boot_state = BS_RUNNING;
974 vm_activate_cpu(vlapic2->vm, dest);
977 vmexit = vm_exitinfo(vlapic->vm, vlapic->vcpuid);
978 vmexit->exitcode = VM_EXITCODE_SPINUP_AP;
979 vmexit->u.spinup_ap.vcpu = dest;
980 vmexit->u.spinup_ap.rip = vec << PAGE_SHIFT;
987 * This will cause a return to userland.
993 vlapic_pending_intr(struct vlapic *vlapic)
995 struct LAPIC *lapic = vlapic->apic_page;
996 int idx, i, bitpos, vector;
997 uint32_t *irrptr, val;
999 irrptr = &lapic->irr0;
1002 * The x86 architecture reserves the the first 32 vectors for use
1005 for (i = 7; i > 0; i--) {
1007 val = atomic_load_acq_int(&irrptr[idx]);
1010 vector = i * 32 + (bitpos - 1);
1011 if (PRIO(vector) > PRIO(lapic->ppr)) {
1012 VLAPIC_CTR1(vlapic, "pending intr %d", vector);
1022 vlapic_intr_accepted(struct vlapic *vlapic, int vector)
1024 struct LAPIC *lapic = vlapic->apic_page;
1025 uint32_t *irrptr, *isrptr;
1029 * clear the ready bit for vector being accepted in irr
1030 * and set the vector as in service in isr.
1032 idx = (vector / 32) * 4;
1034 irrptr = &lapic->irr0;
1035 atomic_clear_int(&irrptr[idx], 1 << (vector % 32));
1036 VLAPIC_CTR_IRR(vlapic, "vlapic_intr_accepted");
1038 isrptr = &lapic->isr0;
1039 isrptr[idx] |= 1 << (vector % 32);
1040 VLAPIC_CTR_ISR(vlapic, "vlapic_intr_accepted");
1045 vlapic->isrvec_stk_top++;
1047 stk_top = vlapic->isrvec_stk_top;
1048 if (stk_top >= ISRVEC_STK_SIZE)
1049 panic("isrvec_stk_top overflow %d", stk_top);
1051 vlapic->isrvec_stk[stk_top] = vector;
1052 vlapic_update_ppr(vlapic);
1056 lapic_set_svr(struct vlapic *vlapic, uint32_t new)
1058 struct LAPIC *lapic;
1059 uint32_t old, changed;
1061 lapic = vlapic->apic_page;
1063 changed = old ^ new;
1064 if ((changed & APIC_SVR_ENABLE) != 0) {
1065 if ((new & APIC_SVR_ENABLE) == 0) {
1067 * The apic is now disabled so stop the apic timer.
1069 VLAPIC_CTR0(vlapic, "vlapic is software-disabled");
1070 VLAPIC_TIMER_LOCK(vlapic);
1071 callout_stop(&vlapic->callout);
1072 VLAPIC_TIMER_UNLOCK(vlapic);
1075 * The apic is now enabled so restart the apic timer
1076 * if it is configured in periodic mode.
1078 VLAPIC_CTR0(vlapic, "vlapic is software-enabled");
1079 if (vlapic_periodic_timer(vlapic))
1080 vlapic_set_icr_timer(vlapic, lapic->icr_timer);
1087 vlapic_read(struct vlapic *vlapic, uint64_t offset, uint64_t *data, bool *retu)
1089 struct LAPIC *lapic = vlapic->apic_page;
1093 if (offset > sizeof(*lapic)) {
1101 case APIC_OFFSET_ID:
1102 *data = vlapic_get_id(vlapic);
1104 case APIC_OFFSET_VER:
1105 *data = lapic->version;
1107 case APIC_OFFSET_TPR:
1110 case APIC_OFFSET_APR:
1113 case APIC_OFFSET_PPR:
1116 case APIC_OFFSET_EOI:
1119 case APIC_OFFSET_LDR:
1120 *data = vlapic_get_ldr(vlapic);
1122 case APIC_OFFSET_DFR:
1123 *data = vlapic_get_dfr(vlapic);
1125 case APIC_OFFSET_SVR:
1128 case APIC_OFFSET_ISR0 ... APIC_OFFSET_ISR7:
1129 i = (offset - APIC_OFFSET_ISR0) >> 2;
1133 case APIC_OFFSET_TMR0 ... APIC_OFFSET_TMR7:
1134 i = (offset - APIC_OFFSET_TMR0) >> 2;
1138 case APIC_OFFSET_IRR0 ... APIC_OFFSET_IRR7:
1139 i = (offset - APIC_OFFSET_IRR0) >> 2;
1141 *data = atomic_load_acq_int(reg + i);
1143 case APIC_OFFSET_ESR:
1146 case APIC_OFFSET_ICR_LOW:
1147 *data = lapic->icr_lo;
1149 case APIC_OFFSET_ICR_HI:
1150 *data = lapic->icr_hi;
1152 case APIC_OFFSET_CMCI_LVT:
1153 case APIC_OFFSET_TIMER_LVT ... APIC_OFFSET_ERROR_LVT:
1154 *data = vlapic_get_lvt(vlapic, offset);
1156 case APIC_OFFSET_TIMER_ICR:
1157 *data = lapic->icr_timer;
1159 case APIC_OFFSET_TIMER_CCR:
1160 *data = vlapic_get_ccr(vlapic);
1162 case APIC_OFFSET_TIMER_DCR:
1163 *data = lapic->dcr_timer;
1165 case APIC_OFFSET_RRR:
1171 VLAPIC_CTR2(vlapic, "vlapic read offset %#x, data %#lx", offset, *data);
1176 vlapic_write(struct vlapic *vlapic, uint64_t offset, uint64_t data, bool *retu)
1178 struct LAPIC *lapic = vlapic->apic_page;
1181 VLAPIC_CTR2(vlapic, "vlapic write offset %#x, data %#lx", offset, data);
1183 if (offset > sizeof(*lapic)) {
1191 case APIC_OFFSET_ID:
1193 case APIC_OFFSET_TPR:
1194 lapic->tpr = data & 0xff;
1195 vlapic_update_ppr(vlapic);
1197 case APIC_OFFSET_EOI:
1198 vlapic_process_eoi(vlapic);
1200 case APIC_OFFSET_LDR:
1201 vlapic_set_ldr(vlapic, data);
1203 case APIC_OFFSET_DFR:
1204 vlapic_set_dfr(vlapic, data);
1206 case APIC_OFFSET_SVR:
1207 lapic_set_svr(vlapic, data);
1209 case APIC_OFFSET_ICR_LOW:
1210 if (!x2apic(vlapic)) {
1212 data |= (uint64_t)lapic->icr_hi << 32;
1214 retval = lapic_process_icr(vlapic, data, retu);
1216 case APIC_OFFSET_ICR_HI:
1217 if (!x2apic(vlapic)) {
1219 lapic->icr_hi = data;
1222 case APIC_OFFSET_CMCI_LVT:
1223 case APIC_OFFSET_TIMER_LVT ... APIC_OFFSET_ERROR_LVT:
1224 vlapic_set_lvt(vlapic, offset, data);
1226 case APIC_OFFSET_TIMER_ICR:
1227 vlapic_set_icr_timer(vlapic, data);
1230 case APIC_OFFSET_TIMER_DCR:
1231 vlapic_set_dcr(vlapic, data);
1234 case APIC_OFFSET_ESR:
1235 vlapic_update_errors(vlapic);
1237 case APIC_OFFSET_VER:
1238 case APIC_OFFSET_APR:
1239 case APIC_OFFSET_PPR:
1240 case APIC_OFFSET_RRR:
1241 case APIC_OFFSET_ISR0 ... APIC_OFFSET_ISR7:
1242 case APIC_OFFSET_TMR0 ... APIC_OFFSET_TMR7:
1243 case APIC_OFFSET_IRR0 ... APIC_OFFSET_IRR7:
1244 case APIC_OFFSET_TIMER_CCR:
1254 vlapic_init(struct vlapic *vlapic)
1256 KASSERT(vlapic->vm != NULL, ("vlapic_init: vm is not initialized"));
1257 KASSERT(vlapic->vcpuid >= 0 && vlapic->vcpuid < VM_MAXCPU,
1258 ("vlapic_init: vcpuid is not initialized"));
1259 KASSERT(vlapic->apic_page != NULL, ("vlapic_init: apic_page is not "
1263 * If the vlapic is configured in x2apic mode then it will be
1264 * accessed in the critical section via the MSR emulation code.
1266 * Therefore the timer mutex must be a spinlock because blockable
1267 * mutexes cannot be acquired in a critical section.
1269 mtx_init(&vlapic->timer_mtx, "vlapic timer mtx", NULL, MTX_SPIN);
1270 callout_init(&vlapic->callout, 1);
1272 vlapic->msr_apicbase = DEFAULT_APIC_BASE | APICBASE_ENABLED;
1274 if (vlapic->vcpuid == 0)
1275 vlapic->msr_apicbase |= APICBASE_BSP;
1277 vlapic_reset(vlapic);
1281 vlapic_cleanup(struct vlapic *vlapic)
1284 callout_drain(&vlapic->callout);
1288 vlapic_get_apicbase(struct vlapic *vlapic)
1291 return (vlapic->msr_apicbase);
1295 vlapic_set_apicbase(struct vlapic *vlapic, uint64_t val)
1298 enum x2apic_state state;
1300 err = vm_get_x2apic_state(vlapic->vm, vlapic->vcpuid, &state);
1302 panic("vlapic_set_apicbase: err %d fetching x2apic state", err);
1304 if (state == X2APIC_DISABLED)
1305 val &= ~APICBASE_X2APIC;
1307 vlapic->msr_apicbase = val;
1311 vlapic_set_x2apic_state(struct vm *vm, int vcpuid, enum x2apic_state state)
1313 struct vlapic *vlapic;
1315 vlapic = vm_lapic(vm, vcpuid);
1317 if (state == X2APIC_DISABLED)
1318 vlapic->msr_apicbase &= ~APICBASE_X2APIC;
1322 vlapic_deliver_intr(struct vm *vm, bool level, uint32_t dest, bool phys,
1323 int delmode, int vec)
1329 if (delmode != APIC_DELMODE_FIXED && delmode != APIC_DELMODE_LOWPRIO) {
1330 VM_CTR1(vm, "vlapic intr invalid delmode %#x", delmode);
1333 lowprio = (delmode == APIC_DELMODE_LOWPRIO);
1336 * We don't provide any virtual interrupt redirection hardware so
1337 * all interrupts originating from the ioapic or MSI specify the
1338 * 'dest' in the legacy xAPIC format.
1340 vlapic_calcdest(vm, &dmask, dest, phys, lowprio, false);
1342 while ((vcpuid = CPU_FFS(&dmask)) != 0) {
1344 CPU_CLR(vcpuid, &dmask);
1345 lapic_set_intr(vm, vcpuid, vec, level);
1350 vlapic_post_intr(struct vlapic *vlapic, int hostcpu)
1353 * Post an interrupt to the vcpu currently running on 'hostcpu'.
1355 * This is done by leveraging features like Posted Interrupts (Intel)
1356 * Doorbell MSR (AMD AVIC) that avoid a VM exit.
1358 * If neither of these features are available then fallback to
1359 * sending an IPI to 'hostcpu'.
1361 ipi_cpu(hostcpu, vmm_ipinum);
1365 vlapic_enabled(struct vlapic *vlapic)
1367 struct LAPIC *lapic = vlapic->apic_page;
1369 if ((vlapic->msr_apicbase & APICBASE_ENABLED) != 0 &&
1370 (lapic->svr & APIC_SVR_ENABLE) != 0)