Struct GuestMode 

pub struct GuestMode { /* private fields */ }

An execution mode for isolated guests.

Self::execute runs a guest vCPU until a VM exit or kernel event needs handling outside OSTD.

Examples

use ostd::{
    arch::vm::GuestContext,
    prelude::*,
    vm::{GuestMode, GuestModeHooks, GuestPhysMemSpace},
};

fn run_guest(
    context: &mut GuestContext,
    guest_mem: &GuestPhysMemSpace,
    hooks: &impl GuestModeHooks,
) -> Result<()> {
    let guest_mode = GuestMode::new()?;

    loop {
        let return_reason = guest_mode.execute(context, guest_mem, hooks)?;
        // Handle VM exit according to the exit reason recorded in `return_reason`.
        handle_vm_exit(return_reason);
    }
}

Implementations

impl GuestMode

pub fn new() -> Result<Self>

Creates a guest execution object without entering a guest.

Panics

Panics if called in atomic mode.

pub fn execute<H: GuestModeHooks + ?Sized>( &self, context: &mut GuestContext, guest_mem: &GuestPhysMemSpace, hooks: &H, ) -> Result<GuestReturnReason>

Runs the guest until a VM exit or kernel event needs handling by the kernel client.

The hooks inspect and update guest state before and after each guest-entry attempt. They also provide pending interrupt requests and timer deadlines through that state.

Panics

Must be called in task context with local IRQs and preemption enabled.