kvm, arm: don't create interrupt events while saving GIC state
[gem5.git] / src / arch / arm / kvm / gic.cc
index 9010d8df8b8ecbd2fedd0df493b243a4224543e2..d490265b88fe716145784c738aec648d726a0a97 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 ARM Limited
+ * Copyright (c) 2015-2017 ARM Limited
  * All rights reserved
  *
  * The license below extends only to copyright in the software and shall
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  * Authors: Andreas Sandberg
+ *          Curtis Dunham
  */
 
 #include "arch/arm/kvm/gic.hh"
 
 #include <linux/kvm.h>
 
+#include "arch/arm/kvm/base_cpu.hh"
+#include "debug/GIC.hh"
 #include "debug/Interrupt.hh"
-#include "params/KvmGic.hh"
+#include "params/MuxingKvmGic.hh"
 
-KvmGic::KvmGic(const KvmGicParams *p)
-    : BaseGic(p),
-      system(*p->system),
-      vm(*p->kvmVM),
-      kdev(vm.createDevice(KVM_DEV_TYPE_ARM_VGIC_V2)),
-      distRange(RangeSize(p->dist_addr, KVM_VGIC_V2_DIST_SIZE)),
-      cpuRange(RangeSize(p->cpu_addr, KVM_VGIC_V2_CPU_SIZE)),
-      addrRanges{distRange, cpuRange}
+KvmKernelGicV2::KvmKernelGicV2(KvmVM &_vm, Addr cpu_addr, Addr dist_addr,
+                               unsigned it_lines)
+    : cpuRange(RangeSize(cpu_addr, KVM_VGIC_V2_CPU_SIZE)),
+      distRange(RangeSize(dist_addr, KVM_VGIC_V2_DIST_SIZE)),
+      vm(_vm),
+      kdev(vm.createDevice(KVM_DEV_TYPE_ARM_VGIC_V2))
 {
+    // Tell the VM that we will emulate the GIC in the kernel. This
+    // disables IRQ and FIQ handling in the KVM CPU model.
+    vm.enableKernelIRQChip();
+
     kdev.setAttr<uint64_t>(
-        KVM_DEV_ARM_VGIC_GRP_ADDR, KVM_VGIC_V2_ADDR_TYPE_DIST,
-        p->dist_addr);
+        KVM_DEV_ARM_VGIC_GRP_ADDR, KVM_VGIC_V2_ADDR_TYPE_DIST, dist_addr);
     kdev.setAttr<uint64_t>(
-        KVM_DEV_ARM_VGIC_GRP_ADDR, KVM_VGIC_V2_ADDR_TYPE_CPU,
-        p->cpu_addr);
+        KVM_DEV_ARM_VGIC_GRP_ADDR, KVM_VGIC_V2_ADDR_TYPE_CPU, cpu_addr);
+
+    kdev.setAttr<uint32_t>(KVM_DEV_ARM_VGIC_GRP_NR_IRQS, 0, it_lines);
+}
+
+KvmKernelGicV2::~KvmKernelGicV2()
+{
+}
+
+void
+KvmKernelGicV2::setSPI(unsigned spi)
+{
+    setIntState(KVM_ARM_IRQ_TYPE_SPI, 0, spi, true);
+}
+
+void
+KvmKernelGicV2::clearSPI(unsigned spi)
+{
+    setIntState(KVM_ARM_IRQ_TYPE_SPI, 0, spi, false);
+}
+
+void
+KvmKernelGicV2::setPPI(unsigned vcpu, unsigned ppi)
+{
+    setIntState(KVM_ARM_IRQ_TYPE_PPI, vcpu, ppi, true);
+}
+
+void
+KvmKernelGicV2::clearPPI(unsigned vcpu, unsigned ppi)
+{
+    setIntState(KVM_ARM_IRQ_TYPE_PPI, vcpu, ppi, false);
+}
+
+void
+KvmKernelGicV2::setIntState(unsigned type, unsigned vcpu, unsigned irq,
+                            bool high)
+{
+    assert(type <= KVM_ARM_IRQ_TYPE_MASK);
+    assert(vcpu <= KVM_ARM_IRQ_VCPU_MASK);
+    assert(irq <= KVM_ARM_IRQ_NUM_MASK);
+    const uint32_t line(
+        (type << KVM_ARM_IRQ_TYPE_SHIFT) |
+        (vcpu << KVM_ARM_IRQ_VCPU_SHIFT) |
+        (irq << KVM_ARM_IRQ_NUM_SHIFT));
+
+    vm.setIRQLine(line, high);
+}
+
+uint32_t
+KvmKernelGicV2::getGicReg(unsigned group, unsigned vcpu, unsigned offset)
+{
+    uint64_t reg;
+
+    assert(vcpu <= KVM_ARM_IRQ_VCPU_MASK);
+    const uint32_t attr(
+        (vcpu << KVM_DEV_ARM_VGIC_CPUID_SHIFT) |
+        (offset << KVM_DEV_ARM_VGIC_OFFSET_SHIFT));
+
+    kdev.getAttrPtr(group, attr, &reg);
+    return (uint32_t) reg;
+}
+
+void
+KvmKernelGicV2::setGicReg(unsigned group, unsigned vcpu, unsigned offset,
+                          unsigned value)
+{
+    uint64_t reg = value;
+
+    assert(vcpu <= KVM_ARM_IRQ_VCPU_MASK);
+    const uint32_t attr(
+        (vcpu << KVM_DEV_ARM_VGIC_CPUID_SHIFT) |
+        (offset << KVM_DEV_ARM_VGIC_OFFSET_SHIFT));
+
+    kdev.setAttrPtr(group, attr, &reg);
+}
+
+uint32_t
+KvmKernelGicV2::readDistributor(ContextID ctx, Addr daddr)
+{
+    auto vcpu = vm.contextIdToVCpuId(ctx);
+    return getGicReg(KVM_DEV_ARM_VGIC_GRP_DIST_REGS, vcpu, daddr);
+}
+
+uint32_t
+KvmKernelGicV2::readCpu(ContextID ctx, Addr daddr)
+{
+    auto vcpu = vm.contextIdToVCpuId(ctx);
+    return getGicReg(KVM_DEV_ARM_VGIC_GRP_CPU_REGS, vcpu, daddr);
+}
+
+void
+KvmKernelGicV2::writeDistributor(ContextID ctx, Addr daddr, uint32_t data)
+{
+    auto vcpu = vm.contextIdToVCpuId(ctx);
+    setGicReg(KVM_DEV_ARM_VGIC_GRP_DIST_REGS, vcpu, daddr, data);
+}
+
+void
+KvmKernelGicV2::writeCpu(ContextID ctx, Addr daddr, uint32_t data)
+{
+    auto vcpu = vm.contextIdToVCpuId(ctx);
+    setGicReg(KVM_DEV_ARM_VGIC_GRP_CPU_REGS, vcpu, daddr, data);
+}
+
+
+
+MuxingKvmGic::MuxingKvmGic(const MuxingKvmGicParams *p)
+    : Pl390(p),
+      system(*p->system),
+      kernelGic(nullptr),
+      usingKvm(false)
+{
+    if (auto vm = system.getKvmVM()) {
+        kernelGic = new KvmKernelGicV2(*vm, p->cpu_addr, p->dist_addr,
+                                       p->it_lines);
+    }
+}
+
+MuxingKvmGic::~MuxingKvmGic()
+{
+}
+
+void
+MuxingKvmGic::loadState(CheckpointIn &cp)
+{
+    Pl390::loadState(cp);
+}
+
+void
+MuxingKvmGic::startup()
+{
+    Pl390::startup();
+    usingKvm = (kernelGic != nullptr) && system.validKvmEnvironment();
+    if (usingKvm)
+        fromPl390ToKvm();
+}
+
+DrainState
+MuxingKvmGic::drain()
+{
+    if (usingKvm)
+        fromKvmToPl390();
+    return Pl390::drain();
 }
 
-KvmGic::~KvmGic()
+void
+MuxingKvmGic::drainResume()
 {
+    Pl390::drainResume();
+    bool use_kvm = (kernelGic != nullptr) && system.validKvmEnvironment();
+    if (use_kvm != usingKvm) {
+        // Should only occur due to CPU switches
+        if (use_kvm) // from simulation to KVM emulation
+            fromPl390ToKvm();
+        // otherwise, drain() already sync'd the state back to the Pl390
+
+        usingKvm = use_kvm;
+    }
 }
 
 void
-KvmGic::serialize(std::ostream &os)
+MuxingKvmGic::serialize(CheckpointOut &cp) const
 {
-    panic("Checkpointing unsupported\n");
+    // drain() already ensured Pl390 updated with KvmGic state if necessary
+    Pl390::serialize(cp);
 }
 
 void
-KvmGic::unserialize(Checkpoint *cp, const std::string &sec)
+MuxingKvmGic::unserialize(CheckpointIn &cp)
 {
-    panic("Checkpointing unsupported\n");
+    Pl390::unserialize(cp);
 }
 
 Tick
-KvmGic::read(PacketPtr pkt)
+MuxingKvmGic::read(PacketPtr pkt)
 {
-    panic("KvmGic: PIO from gem5 is currently unsupported\n");
+    if (!usingKvm)
+        return Pl390::read(pkt);
+
+    panic("MuxingKvmGic: PIO from gem5 is currently unsupported\n");
 }
 
 Tick
-KvmGic::write(PacketPtr pkt)
+MuxingKvmGic::write(PacketPtr pkt)
 {
-    panic("KvmGic: PIO from gem5 is currently unsupported\n");
+    if (!usingKvm)
+        return Pl390::write(pkt);
+
+    panic("MuxingKvmGic: PIO from gem5 is currently unsupported\n");
 }
 
 void
-KvmGic::sendInt(uint32_t num)
+MuxingKvmGic::sendInt(uint32_t num)
 {
+    if (!usingKvm)
+        return Pl390::sendInt(num);
+
     DPRINTF(Interrupt, "Set SPI %d\n", num);
-    setIntState(KVM_ARM_IRQ_TYPE_SPI, 0, num, true);
+    kernelGic->setSPI(num);
 }
 
 void
-KvmGic::clearInt(uint32_t num)
+MuxingKvmGic::clearInt(uint32_t num)
 {
+    if (!usingKvm)
+        return Pl390::clearInt(num);
+
     DPRINTF(Interrupt, "Clear SPI %d\n", num);
-    setIntState(KVM_ARM_IRQ_TYPE_SPI, 0, num, false);
+    kernelGic->clearSPI(num);
 }
 
 void
-KvmGic::sendPPInt(uint32_t num, uint32_t cpu)
+MuxingKvmGic::sendPPInt(uint32_t num, uint32_t cpu)
 {
+    if (!usingKvm)
+        return Pl390::sendPPInt(num, cpu);
     DPRINTF(Interrupt, "Set PPI %d:%d\n", cpu, num);
-    setIntState(KVM_ARM_IRQ_TYPE_PPI, cpu, num, true);
+    kernelGic->setPPI(cpu, num);
 }
 
 void
-KvmGic::clearPPInt(uint32_t num, uint32_t cpu)
+MuxingKvmGic::clearPPInt(uint32_t num, uint32_t cpu)
 {
+    if (!usingKvm)
+        return Pl390::clearPPInt(num, cpu);
+
     DPRINTF(Interrupt, "Clear PPI %d:%d\n", cpu, num);
-    setIntState(KVM_ARM_IRQ_TYPE_PPI, cpu, num, false);
+    kernelGic->clearPPI(cpu, num);
 }
 
 void
-KvmGic::verifyMemoryMode() const
+MuxingKvmGic::updateIntState(int hint)
 {
-    if (!(system.isAtomicMode() && system.bypassCaches())) {
-        fatal("The in-kernel KVM GIC can only be used with KVM CPUs, but the "
-              "current memory mode does not support KVM.\n");
-    }
+    // During Kvm->Pl390 state transfer, writes to the Pl390 will call
+    // updateIntState() which can post an interrupt.  Since we're only
+    // using the Pl390 model for holding state in this circumstance, we
+    // short-circuit this behavior, as the Pl390 is not actually active.
+    if (!usingKvm)
+        return Pl390::updateIntState(hint);
 }
 
 void
-KvmGic::setIntState(uint8_t type, uint8_t vcpu, uint16_t irq, bool high)
+MuxingKvmGic::copyDistRegister(BaseGicRegisters* from, BaseGicRegisters* to,
+                               ContextID ctx, Addr daddr)
 {
-    assert(type < KVM_ARM_IRQ_TYPE_MASK);
-    assert(vcpu < KVM_ARM_IRQ_VCPU_MASK);
-    assert(irq < KVM_ARM_IRQ_NUM_MASK);
-    const uint32_t line(
-        (type << KVM_ARM_IRQ_TYPE_SHIFT) |
-        (vcpu << KVM_ARM_IRQ_VCPU_SHIFT) |
-        (irq << KVM_ARM_IRQ_NUM_SHIFT));
+    auto val = from->readDistributor(ctx, daddr);
+    DPRINTF(GIC, "copy dist 0x%x 0x%08x\n", daddr, val);
+    to->writeDistributor(ctx, daddr, val);
+}
 
-    vm.setIRQLine(line, high);
+void
+MuxingKvmGic::copyCpuRegister(BaseGicRegisters* from, BaseGicRegisters* to,
+                               ContextID ctx, Addr daddr)
+{
+    auto val = from->readCpu(ctx, daddr);
+    DPRINTF(GIC, "copy cpu  0x%x 0x%08x\n", daddr, val);
+    to->writeCpu(ctx, daddr, val);
 }
 
+void
+MuxingKvmGic::copyBankedDistRange(BaseGicRegisters* from, BaseGicRegisters* to,
+                                  Addr daddr, size_t size)
+{
+    for (int ctx = 0; ctx < system._numContexts; ++ctx)
+        for (auto a = daddr; a < daddr + size; a += 4)
+            copyDistRegister(from, to, ctx, a);
+}
+
+void
+MuxingKvmGic::clearBankedDistRange(BaseGicRegisters* to,
+                                   Addr daddr, size_t size)
+{
+    for (int ctx = 0; ctx < system._numContexts; ++ctx)
+        for (auto a = daddr; a < daddr + size; a += 4)
+            to->writeDistributor(ctx, a, 0xFFFFFFFF);
+}
+
+void
+MuxingKvmGic::copyDistRange(BaseGicRegisters* from, BaseGicRegisters* to,
+                            Addr daddr, size_t size)
+{
+    for (auto a = daddr; a < daddr + size; a += 4)
+        copyDistRegister(from, to, 0, a);
+}
+
+void
+MuxingKvmGic::clearDistRange(BaseGicRegisters* to,
+                             Addr daddr, size_t size)
+{
+    for (auto a = daddr; a < daddr + size; a += 4)
+        to->writeDistributor(0, a, 0xFFFFFFFF);
+}
+
+void
+MuxingKvmGic::copyGicState(BaseGicRegisters* from, BaseGicRegisters* to)
+{
+    Addr set, clear;
+    size_t size;
+
+    /// CPU state (GICC_*)
+    // Copy CPU Interface Control Register (CTLR),
+    //      Interrupt Priority Mask Register (PMR), and
+    //      Binary Point Register (BPR)
+    for (int ctx = 0; ctx < system._numContexts; ++ctx) {
+        copyCpuRegister(from, to, ctx, GICC_CTLR);
+        copyCpuRegister(from, to, ctx, GICC_PMR);
+        copyCpuRegister(from, to, ctx, GICC_BPR);
+    }
+
+
+    /// Distributor state (GICD_*)
+    // Copy Distributor Control Register (CTLR)
+    copyDistRegister(from, to, 0, GICD_CTLR);
+
+    // Copy interrupt-enabled statuses (I[CS]ENABLERn; R0 is per-CPU banked)
+    set   = Pl390::GICD_ISENABLER.start();
+    clear = Pl390::GICD_ICENABLER.start();
+    size  = Pl390::itLines / 8;
+    clearBankedDistRange(to, clear, 4);
+    copyBankedDistRange(from, to, set, 4);
+
+    set += 4, clear += 4, size -= 4;
+    clearDistRange(to, clear, size);
+    copyDistRange(from, to, set, size);
+
+    // Copy pending interrupts (I[CS]PENDRn; R0 is per-CPU banked)
+    set   = Pl390::GICD_ISPENDR.start();
+    clear = Pl390::GICD_ICPENDR.start();
+    size  = Pl390::itLines / 8;
+    clearBankedDistRange(to, clear, 4);
+    copyBankedDistRange(from, to, set, 4);
+
+    set += 4, clear += 4, size -= 4;
+    clearDistRange(to, clear, size);
+    copyDistRange(from, to, set, size);
+
+    // Copy active interrupts (I[CS]ACTIVERn; R0 is per-CPU banked)
+    set   = Pl390::GICD_ISACTIVER.start();
+    clear = Pl390::GICD_ICACTIVER.start();
+    size  = Pl390::itLines / 8;
+    clearBankedDistRange(to, clear, 4);
+    copyBankedDistRange(from, to, set, 4);
+
+    set += 4, clear += 4, size -= 4;
+    clearDistRange(to, clear, size);
+    copyDistRange(from, to, set, size);
+
+    // Copy interrupt priorities (IPRIORITYRn; R0-7 are per-CPU banked)
+    set   = Pl390::GICD_IPRIORITYR.start();
+    copyBankedDistRange(from, to, set, 32);
+
+    set += 32;
+    size = Pl390::itLines - 32;
+    copyDistRange(from, to, set, size);
+
+    // Copy interrupt processor target regs (ITARGETRn; R0-7 are read-only)
+    set = Pl390::GICD_ITARGETSR.start() + 32;
+    size = Pl390::itLines - 32;
+    copyDistRange(from, to, set, size);
+
+    // Copy interrupt configuration registers (ICFGRn)
+    set = Pl390::GICD_ICFGR.start();
+    size = Pl390::itLines / 4;
+    copyDistRange(from, to, set, size);
+}
+
+void
+MuxingKvmGic::fromPl390ToKvm()
+{
+    copyGicState(static_cast<Pl390*>(this), kernelGic);
+}
+
+void
+MuxingKvmGic::fromKvmToPl390()
+{
+    copyGicState(kernelGic, static_cast<Pl390*>(this));
+
+    // the values read for the Interrupt Priority Mask Register (PMR)
+    // have been shifted by three bits due to its having been emulated by
+    // a VGIC with only 5 PMR bits in its VMCR register.  Presently the
+    // Linux kernel does not repair this inaccuracy, so we correct it here.
+    for (int cpu = 0; cpu < system._numContexts; ++cpu) {
+       cpuPriority[cpu] <<= 3;
+       assert((cpuPriority[cpu] & ~0xff) == 0);
+    }
+}
 
-KvmGic *
-KvmGicParams::create()
+MuxingKvmGic *
+MuxingKvmGicParams::create()
 {
-    return new KvmGic(this);
+    return new MuxingKvmGic(this);
 }