Atmosphere/thermosphere/src/irq.c

/*
 * Copyright (c) 2019 Atmosphère-NX
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "irq.h"
#include "core_ctx.h"
#include "debug_log.h"
#include "vgic.h"
#include "timer.h"
#include "guest_timers.h"
#include "transport_interface.h"
#include "debug_manager.h"

IrqManager g_irqManager = {0};

static void initGic(void)
{
    // Reinits the GICD and GICC (for non-secure mode, obviously)
    if (currentCoreCtx->isBootCore && !currentCoreCtx->warmboot) {
        // Disable interrupt handling & global interrupt distribution
        gicd->ctlr = 0;

        // Get some info
        g_irqManager.numSharedInterrupts = 32 * (gicd->typer & 0x1F); // number of interrupt lines / 32

        // unimplemented priority bits (lowest significant) are RAZ/WI
        gicd->ipriorityr[0] = 0xFF;
        g_irqManager.priorityShift = 8 - __builtin_popcount(gicd->ipriorityr[0]);
        g_irqManager.numPriorityLevels = (u8)BIT(__builtin_popcount(gicd->ipriorityr[0]));

        g_irqManager.numCpuInterfaces = (u8)(1 + ((gicd->typer >> 5) & 7));
        g_irqManager.numListRegisters = (u8)(1 + (gich->vtr & 0x3F));
    }

    // Only one core will reset the GIC state for the shared peripheral interrupts

    u32 numInterrupts = 32;
    if (currentCoreCtx->isBootCore) {
        numInterrupts += g_irqManager.numSharedInterrupts;
    }

    // Filter all interrupts
    gicc->pmr = 0;

    // Disable interrupt preemption
    gicc->bpr = 7;

    // Note: the GICD I...n regs are banked for private interrupts

    // Disable all interrupts, clear active status, clear pending status
    for (u32 i = 0; i < numInterrupts / 32; i++) {
        gicd->icenabler[i] = 0xFFFFFFFF;
        gicd->icactiver[i] = 0xFFFFFFFF;
        gicd->icpendr[i] = 0xFFFFFFFF;
    }

    // Set priorities to lowest
    for (u32 i = 0; i < numInterrupts; i++) {
        gicd->ipriorityr[i] = 0xFF;
    }

    // Reset icfgr, itargetsr for shared peripheral interrupts
    for (u32 i = 32 / 16; i < numInterrupts / 16; i++) {
        gicd->icfgr[i] = 0x55555555;
    }

    for (u32 i = 32; i < numInterrupts; i++) {
        gicd->itargetsr[i] = 0;
    }

    // Now, reenable interrupts

    // Enable the distributor
    if (currentCoreCtx->isBootCore) {
        gicd->ctlr = 1;
    }

    // Enable the CPU interface. Set EOIModeNS=1 (split prio drop & deactivate priority)
    gicc->ctlr = BIT(9) | 1;

    // Disable interrupt filtering
    gicc->pmr = 0xFF;

    currentCoreCtx->gicInterfaceMask = gicd->itargetsr[0];
}

static inline bool checkRescheduleEmulatedPtimer(ExceptionStackFrame *frame)
{
    // Evaluate if the timer has really expired in the PoV of the guest kernel.
    // If not, reschedule (add missed time delta) it & exit early
    u64 cval = currentCoreCtx->emulPtimerCval;
    u64 vct  = computeCntvct(frame);

    if (cval > vct) {
        // It has not: reschedule the timer
        // Note: this isn't 100% precise esp. on QEMU so it may take a few tries...
        writeEmulatedPhysicalCompareValue(frame, cval);
        return false;
    }

    return true;
}


static inline bool checkGuestTimerInterrupts(ExceptionStackFrame *frame, u16 irqId)
{
    // A thing that might have happened is losing the race vs disabling the guest interrupts
    // Another thing is that the virtual timer might have fired before us updating voff when executing a top half?
    if (irqId == TIMER_IRQID(NS_VIRT_TIMER)) {
        u64 cval = GET_SYSREG(cntp_cval_el0);
        return cval <= computeCntvct(frame);
    } else if (irqId == TIMER_IRQID(NS_PHYS_TIMER)) {
        return checkRescheduleEmulatedPtimer(frame);
    } else {
        return true;
    }
}

static void doConfigureInterrupt(u16 id, u8 prio, bool isLevelSensitive)
{
    gicd->icenabler[id / 32] = BIT(id % 32);

    if (id >= 32) {
        u32 cfgr = gicd->icfgr[id / 16];
        cfgr &= ~(3 << IRQ_CFGR_SHIFT(id));
        cfgr |= (!isLevelSensitive ? 3 : 1) << IRQ_CFGR_SHIFT(id);
        gicd->icfgr[id / 16] = cfgr;
        gicd->itargetsr[id]  = 0xFF; // all cpu interfaces
    }
    gicd->icpendr[id / 32]      = BIT(id % 32);
    gicd->ipriorityr[id]        = (prio << g_irqManager.priorityShift) & 0xFF;
    gicd->isenabler[id / 32]    = BIT(id % 32);
}

void initIrq(void)
{
    u64 flags = recursiveSpinlockLockMaskIrq(&g_irqManager.lock);

    initGic();
    vgicInit();

    // Configure the interrupts we use here
    for (u32 i = 0; i < ThermosphereSgi_Max; i++) {
        doConfigureInterrupt(i, IRQ_PRIORITY_HOST, false);
    }

    doConfigureInterrupt(GIC_IRQID_MAINTENANCE, IRQ_PRIORITY_HOST, true);

    recursiveSpinlockUnlockRestoreIrq(&g_irqManager.lock, flags);
}

void configureInterrupt(u16 id, u8 prio, bool isLevelSensitive)
{
    u64 flags = recursiveSpinlockLockMaskIrq(&g_irqManager.lock);
    doConfigureInterrupt(id, prio, isLevelSensitive);
    recursiveSpinlockUnlockRestoreIrq(&g_irqManager.lock, flags);
}

void irqSetAffinity(u16 id, u8 affinity)
{
    u64 flags = recursiveSpinlockLockMaskIrq(&g_irqManager.lock);
    gicd->itargetsr[id] = affinity;
    recursiveSpinlockUnlockRestoreIrq(&g_irqManager.lock, flags);
}

bool irqIsGuest(u16 id)
{
    if (id >= 32 + g_irqManager.numSharedInterrupts) {
        DEBUG("vgic: %u not supported by physical distributor\n", (u32)id);
        return false;
    }

    bool ret = true;
    ret = ret && id != GIC_IRQID_MAINTENANCE;
    ret = ret && id != GIC_IRQID_NS_PHYS_HYP_TIMER;

    // If the following interrupts don't exist, that's fine, they're defined as GIC_IRQID_SPURIOUS in that case
    // (for which the function isn't called, anyway)
    ret = ret && id != GIC_IRQID_NS_VIRT_HYP_TIMER;
    ret = ret && id != GIC_IRQID_SEC_PHYS_HYP_TIMER;
    ret = ret && id != GIC_IRQID_SEC_VIRT_HYP_TIMER;

    ret = ret && transportInterfaceFindByIrqId(id) == NULL;
    return ret;
}

void handleIrqException(ExceptionStackFrame *frame, bool isLowerEl, bool isA32)
{
    (void)isLowerEl;
    (void)isA32;

    // Acknowledge the interrupt. Interrupt goes from pending to active.
    u32 iar = gicc->iar;
    u32 irqId = iar & 0x3FF;
    u32 srcCore = (iar >> 10) & 7;

    //DEBUG("EL2 [core %d]: Received irq %x\n", (int)currentCoreCtx->coreId, irqId);

    if (irqId == GIC_IRQID_SPURIOUS) {
        // Spurious interrupt received
        return;
    } else if (!checkGuestTimerInterrupts(frame, irqId)) {
        // Deactivate the interrupt, return early
        gicc->eoir = iar;
        gicc->dir  = iar;
        return;
    }

    bool isGuestInterrupt = false;
    bool isMaintenanceInterrupt = false;
    bool isPaused = false;
    bool hasDebugEvent = false;

    switch (irqId) {
        case ThermosphereSgi_ExecuteFunction:
            executeFunctionInterruptHandler(srcCore);
            break;
        case ThermosphereSgi_VgicUpdate:
            // Nothing in particular to do here
            break;
        case ThermosphereSgi_DebugPause:
            debugManagerPauseSgiHandler();
            break;
        case ThermosphereSgi_ReportDebuggerBreak:
        case ThermosphereSgi_DebuggerContinue:
            // See bottom halves
            // Because exceptions (other debug events) are handling w/ interrupts off, if
            // we get there, there's no race condition possible with debugManagerReportEvent
            break;
        case GIC_IRQID_MAINTENANCE:
            isMaintenanceInterrupt = true;
            break;
        case TIMER_IRQID(CURRENT_TIMER):
            timerInterruptHandler();
            break;
        default:
            isGuestInterrupt = irqId >= 16;
            break;
    }

    TransportInterface *transportIface = irqId >= 32 ? transportInterfaceIrqHandlerTopHalf(irqId) : NULL;

    // Priority drop
    gicc->eoir = iar;

    isGuestInterrupt = isGuestInterrupt && transportIface == NULL && irqIsGuest(irqId);

    recursiveSpinlockLock(&g_irqManager.lock);

    if (!isGuestInterrupt) {
        if (isMaintenanceInterrupt) {
            vgicMaintenanceInterruptHandler();
        }
        // Deactivate the interrupt
        gicc->dir = iar;
    } else {
        vgicEnqueuePhysicalIrq(irqId);
    }

    // Update vgic state
    vgicUpdateState();

    recursiveSpinlockUnlock(&g_irqManager.lock);

    isPaused = debugManagerIsCorePaused(currentCoreCtx->coreId);
    hasDebugEvent = debugManagerHasDebugEvent(currentCoreCtx->coreId);
    if (irqId == ThermosphereSgi_ReportDebuggerBreak) DEBUG("debug event=%d\n", (int)debugManagerGetDebugEvent(currentCoreCtx->coreId)->type);
    // Bottom half part
    if (transportIface != NULL) {
        exceptionEnterInterruptibleHypervisorCode();
        unmaskIrq();
        transportInterfaceIrqHandlerBottomHalf(transportIface);
    } else if (irqId == ThermosphereSgi_ReportDebuggerBreak && !hasDebugEvent) {
        debugManagerReportEvent(DBGEVENT_DEBUGGER_BREAK);
    } else if (irqId == ThermosphereSgi_DebuggerContinue && isPaused) {
        debugManagerUnpauseCores(BIT(currentCoreCtx->coreId));
    }

}