DragonOS/kernel/src/arch/x86_64/vm/vmx/exit.rs

use bitfield_struct::bitfield;
use system_error::SystemError;
use x86::vmx::vmcs::{guest, ro};

use crate::{
    arch::vm::asm::{IntrInfo, VmxAsm},
    virt::vm::kvm_host::{vcpu::VirtCpu, Vm},
};

use super::{ept::EptViolationExitQual, vmx_info, PageFaultErr};
extern crate num_traits;

#[bitfield(u32)]
pub struct VmxExitReason {
    pub basic: u16,
    pub reserved16: bool,
    pub reserved17: bool,
    pub reserved18: bool,
    pub reserved19: bool,
    pub reserved20: bool,
    pub reserved21: bool,
    pub reserved22: bool,
    pub reserved23: bool,
    pub reserved24: bool,
    pub reserved25: bool,
    pub bus_lock_detected: bool,
    pub enclave_mode: bool,
    pub smi_pending_mtf: bool,
    pub smi_from_vmx_root: bool,
    pub reserved30: bool,
    pub failed_vmentry: bool,
}

//#define VMX_EXIT_REASONS
#[derive(FromPrimitive, PartialEq, Clone, Copy)]
#[allow(non_camel_case_types)]
pub enum VmxExitReasonBasic {
    EXCEPTION_OR_NMI = 0,
    EXTERNAL_INTERRUPT = 1,
    TRIPLE_FAULT = 2,
    INIT_SIGNAL = 3,
    SIPI = 4,
    IO_SMI = 5,
    OTHER_SMI = 6,
    INTERRUPT_WINDOW = 7,
    NMI_WINDOW = 8,
    TASK_SWITCH = 9,
    CPUID = 10,
    GETSEC = 11,
    HLT = 12,
    INVD = 13,
    INVLPG = 14,
    RDPMC = 15,
    RDTSC = 16,
    RSM = 17,
    VMCALL = 18,
    VMCLEAR = 19,
    VMLAUNCH = 20,
    VMPTRLD = 21,
    VMPTRST = 22,
    VMREAD = 23,
    VMRESUME = 24,
    VMWRITE = 25,
    VMXOFF = 26,
    VMXON = 27,
    CR_ACCESS = 28,
    DR_ACCESS = 29,
    IO_INSTRUCTION = 30,
    RDMSR = 31,
    WRMSR = 32,
    VM_ENTRY_FAILURE_INVALID_GUEST_STATE = 33,
    VM_ENTRY_FAILURE_MSR_LOADING = 34,
    MWAIT = 36,
    MONITOR_TRAP_FLAG = 37,
    MONITOR = 39,
    PAUSE = 40,
    VM_ENTRY_FAILURE_MACHINE_CHECK_EVENT = 41,
    TPR_BELOW_THRESHOLD = 43,
    APIC_ACCESS = 44,
    VIRTUALIZED_EOI = 45, // "EOI_INDUCED"
    ACCESS_GDTR_OR_IDTR = 46,
    ACCESS_LDTR_OR_TR = 47,
    EPT_VIOLATION = 48,
    EPT_MISCONFIG = 49,
    INVEPT = 50,
    RDTSCP = 51,
    VMX_PREEMPTION_TIMER_EXPIRED = 52,
    INVVPID = 53,
    WBINVD = 54,
    XSETBV = 55,
    APIC_WRITE = 56,
    RDRAND = 57,
    INVPCID = 58,
    VMFUNC = 59,
    ENCLS = 60,
    RDSEED = 61,
    PML_FULL = 62,
    XSAVES = 63,
    XRSTORS = 64,

    UMWAIT = 67,
    TPAUSE = 68,
    BUS_LOCK = 74,
    NOTIFY = 75,

    UNKNOWN,
}

impl From<u16> for VmxExitReasonBasic {
    fn from(num: u16) -> Self {
        match num {
            0 => VmxExitReasonBasic::EXCEPTION_OR_NMI,
            1 => VmxExitReasonBasic::EXTERNAL_INTERRUPT,
            2 => VmxExitReasonBasic::TRIPLE_FAULT,
            3 => VmxExitReasonBasic::INIT_SIGNAL,
            4 => VmxExitReasonBasic::SIPI,
            5 => VmxExitReasonBasic::IO_SMI,
            6 => VmxExitReasonBasic::OTHER_SMI,
            7 => VmxExitReasonBasic::INTERRUPT_WINDOW,
            8 => VmxExitReasonBasic::NMI_WINDOW,
            9 => VmxExitReasonBasic::TASK_SWITCH,
            10 => VmxExitReasonBasic::CPUID,
            11 => VmxExitReasonBasic::GETSEC,
            12 => VmxExitReasonBasic::HLT,
            13 => VmxExitReasonBasic::INVD,
            14 => VmxExitReasonBasic::INVLPG,
            15 => VmxExitReasonBasic::RDPMC,
            16 => VmxExitReasonBasic::RDTSC,
            17 => VmxExitReasonBasic::RSM,
            18 => VmxExitReasonBasic::VMCALL,
            19 => VmxExitReasonBasic::VMCLEAR,
            20 => VmxExitReasonBasic::VMLAUNCH,
            21 => VmxExitReasonBasic::VMPTRLD,
            22 => VmxExitReasonBasic::VMPTRST,
            23 => VmxExitReasonBasic::VMREAD,
            24 => VmxExitReasonBasic::VMRESUME,
            25 => VmxExitReasonBasic::VMWRITE,
            26 => VmxExitReasonBasic::VMXOFF,
            27 => VmxExitReasonBasic::VMXON,
            28 => VmxExitReasonBasic::CR_ACCESS,
            29 => VmxExitReasonBasic::DR_ACCESS,
            30 => VmxExitReasonBasic::IO_INSTRUCTION,
            31 => VmxExitReasonBasic::RDMSR,
            32 => VmxExitReasonBasic::WRMSR,
            33 => VmxExitReasonBasic::VM_ENTRY_FAILURE_INVALID_GUEST_STATE,
            34 => VmxExitReasonBasic::VM_ENTRY_FAILURE_MSR_LOADING,
            36 => VmxExitReasonBasic::MWAIT,
            37 => VmxExitReasonBasic::MONITOR_TRAP_FLAG,
            39 => VmxExitReasonBasic::MONITOR,
            40 => VmxExitReasonBasic::PAUSE,
            41 => VmxExitReasonBasic::VM_ENTRY_FAILURE_MACHINE_CHECK_EVENT,
            43 => VmxExitReasonBasic::TPR_BELOW_THRESHOLD,
            44 => VmxExitReasonBasic::APIC_ACCESS,
            45 => VmxExitReasonBasic::VIRTUALIZED_EOI,
            46 => VmxExitReasonBasic::ACCESS_GDTR_OR_IDTR,
            47 => VmxExitReasonBasic::ACCESS_LDTR_OR_TR,
            48 => VmxExitReasonBasic::EPT_VIOLATION,
            49 => VmxExitReasonBasic::EPT_MISCONFIG,
            50 => VmxExitReasonBasic::INVEPT,
            51 => VmxExitReasonBasic::RDTSCP,
            52 => VmxExitReasonBasic::VMX_PREEMPTION_TIMER_EXPIRED,
            53 => VmxExitReasonBasic::INVVPID,
            54 => VmxExitReasonBasic::WBINVD,
            55 => VmxExitReasonBasic::XSETBV,
            56 => VmxExitReasonBasic::APIC_WRITE,
            57 => VmxExitReasonBasic::RDRAND,
            58 => VmxExitReasonBasic::INVPCID,
            59 => VmxExitReasonBasic::VMFUNC,
            60 => VmxExitReasonBasic::ENCLS,
            61 => VmxExitReasonBasic::RDSEED,
            62 => VmxExitReasonBasic::PML_FULL,
            63 => VmxExitReasonBasic::XSAVES,
            64 => VmxExitReasonBasic::XRSTORS,

            67 => VmxExitReasonBasic::UMWAIT,
            68 => VmxExitReasonBasic::TPAUSE,
            74 => VmxExitReasonBasic::BUS_LOCK,
            75 => VmxExitReasonBasic::NOTIFY,
            _ => VmxExitReasonBasic::UNKNOWN,
        }
    }
}

#[derive(Debug, PartialEq)]
#[allow(dead_code)]
pub enum ExitFastpathCompletion {
    None,
    ReenterGuest,
    ExitHandled,
}
pub struct VmxExitHandlers {}
//     //name 代表暂时不懂含义的(name linux=name DragonOS)
//     ExceptionNmi = VmxExitReasonBasic::EXCEPTION_OR_NMI as isize,
//     ExternalInterrupt = VmxExitReasonBasic::EXTERNAL_INTERRUPT as isize,
//     TripleFault = VmxExitReasonBasic::TRIPLE_FAULT as isize,
//     NmiWindow = VmxExitReasonBasic::NMI_WINDOW as isize,
//     IoInstruction = VmxExitReasonBasic::IO_INSTRUCTION as isize,
//     CrAccess = VmxExitReasonBasic::CR_ACCESS as isize,
//     DrAccess = VmxExitReasonBasic::DR_ACCESS as isize,
//     Cpuid = VmxExitReasonBasic::CPUID as isize,
//     MsrRead = VmxExitReasonBasic::RDMSR as isize,
//     MsrWrite = VmxExitReasonBasic::WRMSR as isize,
//     InterruptWindow = VmxExitReasonBasic::INTERRUPT_WINDOW as isize,
//     Hlt = VmxExitReasonBasic::HLT as isize,
//     Invd = VmxExitReasonBasic::INVD as isize,
//     Invlpg = VmxExitReasonBasic::INVLPG as isize,
//     Rdpmc = VmxExitReasonBasic::RDPMC as isize,
//     Vmcall = VmxExitReasonBasic::VMCALL as isize,
//     Vmclear = VmxExitReasonBasic::VMCLEAR as isize,
//     Vmlaunch = VmxExitReasonBasic::VMLAUNCH as isize,
//     Vmptrld = VmxExitReasonBasic::VMPTRLD as isize,
//     Vmptrst = VmxExitReasonBasic::VMPTRST as isize,
//     Vmread = VmxExitReasonBasic::VMREAD as isize,
//     Vmresume = VmxExitReasonBasic::VMRESUME as isize,
//     Vmwrite = VmxExitReasonBasic::VMWRITE as isize,
//     Vmoff = VmxExitReasonBasic::VMXOFF as isize,
//     Vmon = VmxExitReasonBasic::VMXON as isize,
//     TprBelowThreshold = VmxExitReasonBasic::TPR_BELOW_THRESHOLD as isize,
//     ApicAccess = VmxExitReasonBasic::APIC_ACCESS as isize,
//     ApicWrite = VmxExitReasonBasic::APIC_WRITE as isize,
//     EoiInduced = VmxExitReasonBasic::VIRTUALIZED_EOI as isize, //name
//     Wbinvd = VmxExitReasonBasic::WBINVD as isize,
//     Xsetbv = VmxExitReasonBasic::XSETBV as isize,
//     TaskSwitch = VmxExitReasonBasic::TASK_SWITCH as isize,
//     MceDuringVmentry = VmxExitReasonBasic::VM_ENTRY_FAILURE_MACHINE_CHECK_EVENT as isize, //name
//     GdtrIdtr = VmxExitReasonBasic::ACCESS_GDTR_OR_IDTR as isize,
//     LdtrTr = VmxExitReasonBasic::ACCESS_LDTR_OR_TR as isize,
//     EptViolation = VmxExitReasonBasic::EPT_VIOLATION as isize,
//     EptMisconfig = VmxExitReasonBasic::EPT_MISCONFIG as isize,
//     PauseInstruction = VmxExitReasonBasic::PAUSE as isize,
//     MwaitInstruction = VmxExitReasonBasic::MWAIT as isize,
//     MonitorTrapFlag = VmxExitReasonBasic::MONITOR_TRAP_FLAG as isize,
//     MonitorInstruction = VmxExitReasonBasic::MONITOR as isize,
//     Invept = VmxExitReasonBasic::INVEPT as isize,
//     Invvpid = VmxExitReasonBasic::INVVPID as isize,
//     Rdrand = VmxExitReasonBasic::RDRAND as isize,
//     Rdseed = VmxExitReasonBasic::RDSEED as isize,
//     PmlFull = VmxExitReasonBasic::PML_FULL as isize,
//     Invpcid = VmxExitReasonBasic::INVPCID as isize,
//     Vmfunc = VmxExitReasonBasic::VMFUNC as isize,
//     PreemptionTimer = VmxExitReasonBasic::VMX_PREEMPTION_TIMER_EXPIRED as isize,
//     Encls = VmxExitReasonBasic::ENCLS as isize,
//     BusLock = VmxExitReasonBasic::BUS_LOCK as isize,
//     Notify = VmxExitReasonBasic::NOTIFY as isize,
//     Unknown,

impl VmxExitHandlers {
    #[inline(never)]
    pub fn try_handle_exit(
        vcpu: &mut VirtCpu,
        vm: &Vm,
        basic: VmxExitReasonBasic,
    ) -> Option<Result<i32, SystemError>> {
        // let exit_reason = vmx_vmread(VmcsFields::VMEXIT_EXIT_REASON as u32).unwrap() as u32;
        // let exit_basic_reason = exit_reason & 0x0000_ffff;
        // let guest_rip = vmx_vmread(VmcsFields::GUEST_RIP as u32).unwrap();
        // let _guest_rflags = vmx_vmread(VmcsFields::GUEST_RFLAGS as u32).unwrap();
        match basic {
            VmxExitReasonBasic::IO_INSTRUCTION => {
                return Some(Self::handle_io(vcpu));
            }
            VmxExitReasonBasic::EPT_VIOLATION => {
                let r = Some(Self::handle_ept_violation(vcpu, vm));
                debug();
                r
            }
            VmxExitReasonBasic::EXTERNAL_INTERRUPT => {
                return Some(Self::handle_external_interrupt(vcpu));
            }
            VmxExitReasonBasic::EXCEPTION_OR_NMI => {
                todo!()
            }
            _ => None,
        }
    }

    fn handle_io(_vcpu: &mut VirtCpu) -> Result<i32, SystemError> {
        todo!();
    }

    fn handle_external_interrupt(vcpu: &mut VirtCpu) -> Result<i32, SystemError> {
        vcpu.stat.irq_exits += 1;
        Ok(1)
    }

    fn handle_ept_violation(vcpu: &mut VirtCpu, vm: &Vm) -> Result<i32, SystemError> {
        let exit_qualification = vcpu.get_exit_qual(); //0x184
                                                       // EPT 违规发生在从 NMI 执行 iret 时，
                                                       // 在下一次 VM 进入之前必须设置 "blocked by NMI" 位。
                                                       // 有一些错误可能会导致该位未被设置：
                                                       // AAK134, BY25。
        let vmx = vcpu.vmx();
        if vmx.idt_vectoring_info.bits() & IntrInfo::INTR_INFO_VALID_MASK.bits() != 0
            && vmx_info().enable_vnmi
            && exit_qualification & IntrInfo::INTR_INFO_UNBLOCK_NMI.bits() as u64 != 0
        {
            VmxAsm::vmx_vmwrite(guest::INTERRUPTIBILITY_STATE, 0x8); //GUEST_INTR_STATE_NMI
        }
        let gpa = VmxAsm::vmx_vmread(ro::GUEST_PHYSICAL_ADDR_FULL);
        //let exit_qualification = VmxAsm::vmx_vmread(ro::EXIT_QUALIFICATION);
        // trace_kvm_page_fault(vcpu, gpa, exit_qualification);//

        // 根据故障类型确定错误代码
        let mut error_code = if exit_qualification & (EptViolationExitQual::ACC_READ.bits()) != 0 {
            //debug!("error_code::ACC_READ");
            PageFaultErr::PFERR_USER.bits()
        } else {
            0
        };
        error_code |= if exit_qualification & (EptViolationExitQual::ACC_WRITE.bits()) != 0 {
            //debug!("error_code::ACC_WRITE");
            PageFaultErr::PFERR_WRITE.bits()
        } else {
            0
        };
        error_code |= if exit_qualification & (EptViolationExitQual::ACC_INSTR.bits()) != 0 {
            //actice
            //debug!("error_code::ACC_INSTR");
            PageFaultErr::PFERR_FETCH.bits()
        } else {
            0
        };
        error_code |= if exit_qualification & (EptViolationExitQual::RWX_MASK.bits()) != 0 {
            //debug!("error_code::RWX_MASK");
            PageFaultErr::PFERR_PRESENT.bits()
        } else {
            0
        };
        if exit_qualification & (EptViolationExitQual::GVA_IS_VALID.bits()) != 0 {
            //调试用
            //debug!("GVA is valid");
        } else {
            //debug!("GVA is invalid");
        }
        error_code |= if exit_qualification & (EptViolationExitQual::GVA_TRANSLATED.bits()) != 0 {
            //debug!("error_code:GVA GVA_TRANSLATED");
            PageFaultErr::PFERR_GUEST_FINAL.bits() //active
        } else {
            PageFaultErr::PFERR_GUEST_PAGE.bits()
        };
        //fixme:: 此时error_code为0x100000011

        vcpu.arch.exit_qual = exit_qualification;

        // 检查 GPA 是否超出物理内存限制，因为这是一个客户机页面错误。
        // 我们必须在这里模拟指令，因为如果非法地址是分页结构的地址，
        // 则会设置 EPT_VIOLATION_ACC_WRITE 位。
        // 或者，如果支持，我们还可以使用 EPT 违规的高级 VM 退出信息来重建页面错误代码。
        // if allow_smaller_maxphyaddr && kvm_vcpu_is_illegal_gpa(vcpu, gpa) {
        //     return kvm_emulate_instruction(vcpu, 0);
        // }
        //debug!("EPT violation: error_code={:#x}", error_code);
        vcpu.page_fault(vm, gpa, error_code, None, 0)
    }
}
fn debug() {
    //     // 3
    //     let info = VmxAsm::vmx_vmread(VmcsFields::VMEXIT_INSTR_LEN as u32);
    //     debug!("vmexit handler: VMEXIT_INSTR_LEN: 0x{:x}!", info);

    //     //0
    //     let info = VmxAsm::vmx_vmread(VmcsFields::VMEXIT_INSTR_INFO as u32);
    //     debug!("vmexit handler: VMEXIT_INSTR_INFO: 0x{:x}!", info);

    //     //0x64042
    //     /*0x64042：

    //     将其转换为二进制：0x64042 的二进制表示是 110010000001000010。
    //     每个位代表一个异常向量（例如，除以零，调试，不可屏蔽中断，断点等）。

    // 从 vmx_update_exception_bitmap 函数中，我们看到设置的特定异常：

    //     PF_VECTOR：页面错误
    //     UD_VECTOR：未定义操作码
    //     MC_VECTOR：机器检查
    //     DB_VECTOR：调试
    //     AC_VECTOR：对齐检查

    // 值 0x64042 设置了与这些异常相对应的位，这意味着当这些异常在来宾中发生时将导致 VM 退出。 */
    //     let info = VmxAsm::vmx_vmread(control::EXCEPTION_BITMAP);
    //     debug!("vmexit handler: EXCEPTION_BITMAP: 0x{:x}!", info);

    //     //9
    //     let info = VmxAsm::vmx_vmread(control::PAGE_FAULT_ERR_CODE_MASK);
    //     debug!("vmexit handler: PAGE_FAULT_ERR_CODE_MASK: 0x{:x}!", info);

    //     //1
    //     let info = VmxAsm::vmx_vmread(control::PAGE_FAULT_ERR_CODE_MATCH);
    //     debug!("vmexit handler: PAGE_FAULT_ERR_CODE_MATCH: 0x{:x}!", info);

    //     //0
    //     let info = VmxAsm::vmx_vmread(control::EPTP_LIST_ADDR_FULL);
    //     debug!("vmexit handler: EPTP_LIST_ADDR_FULL: 0x{:x}!", info);

    //     let info = VmxAsm::vmx_vmread(ro::VM_INSTRUCTION_ERROR);
    //     debug!("vmexit handler: VM_INSTRUCTION_ERROR: 0x{:x}!", info);

    // let info = VmxAsm::vmx_vmread(ro::EXIT_REASON);
    // debug!("vmexit handler: EXIT_REASON:0x{:x}!", info);//EPT VIOLATION

    // let info = VmxAsm::vmx_vmread(ro::VMEXIT_INTERRUPTION_INFO);
    // debug!("vmexit handler: VMEXIT_INTERRUPTION_INFO: 0x{:x}!", info);

    // let info = VmxAsm::vmx_vmread(ro::VMEXIT_INTERRUPTION_ERR_CODE);
    // debug!("vmexit handler: VMEXIT_INTERRUPTION_ERR_CODE: 0x{:x}!", info);

    // let info = VmxAsm::vmx_vmread(ro::IDT_VECTORING_INFO);
    // debug!("vmexit handler: IDT_VECTORING_INFO: 0x{:x}!", info);

    // let info = VmxAsm::vmx_vmread(ro::IDT_VECTORING_ERR_CODE);
    // debug!("vmexit handler: IDT_VECTORING_ERR_CODE: 0x{:x}!", info);

    // let info = VmxAsm::vmx_vmread(ro::VMEXIT_INSTRUCTION_LEN);
    // debug!("vmexit handler: VMEXIT_INSTRUCTION_LEN: 0x{:x}!", info);

    // let info = VmxAsm::vmx_vmread(ro::VMEXIT_INSTRUCTION_INFO);
    // debug!("vmexit handler: VMEXIT_INSTRUCTION_INFO: 0x{:x}!", info);

    //panic
    // let info = VmxAsm::vmx_vmread(control::EPTP_INDEX);
    // debug!("vmexit handler: EPTP_INDEX: 0x{:x}!", info);

    //panic
    // let info = VmxAsm::vmx_vmread(control::VIRT_EXCEPTION_INFO_ADDR_FULL);
    // debug!("vmexit handler: VIRT_EXCEPTION_INFO_ADDR_FULL: 0x{:x}!", info);
}