Trait VmiDriver

pub trait VmiDriver {
    type Architecture: Architecture + ?Sized;

    // Required methods
    fn info(&self) -> Result<VmiInfo, VmiError>;
    fn pause(&self) -> Result<(), VmiError>;
    fn resume(&self) -> Result<(), VmiError>;
    fn registers(
        &self,
        vcpu: VcpuId,
    ) -> Result<<Self::Architecture as Architecture>::Registers, VmiError>;
    fn set_registers(
        &self,
        vcpu: VcpuId,
        registers: <Self::Architecture as Architecture>::Registers,
    ) -> Result<(), VmiError>;
    fn memory_access(
        &self,
        gfn: Gfn,
        view: View,
    ) -> Result<MemoryAccess, VmiError>;
    fn set_memory_access(
        &self,
        gfn: Gfn,
        view: View,
        access: MemoryAccess,
    ) -> Result<(), VmiError>;
    fn read_page(&self, gfn: Gfn) -> Result<VmiMappedPage, VmiError>;
    fn write_page(
        &self,
        gfn: Gfn,
        offset: u64,
        content: &[u8],
    ) -> Result<VmiMappedPage, VmiError>;
    fn allocate_gfn(&self, gfn: Gfn) -> Result<(), VmiError>;
    fn free_gfn(&self, gfn: Gfn) -> Result<(), VmiError>;
    fn default_view(&self) -> View;
    fn create_view(
        &self,
        default_access: MemoryAccess,
    ) -> Result<View, VmiError>;
    fn destroy_view(&self, view: View) -> Result<(), VmiError>;
    fn switch_to_view(&self, view: View) -> Result<(), VmiError>;
    fn change_view_gfn(
        &self,
        view: View,
        old_gfn: Gfn,
        new_gfn: Gfn,
    ) -> Result<(), VmiError>;
    fn reset_view_gfn(&self, view: View, gfn: Gfn) -> Result<(), VmiError>;
    fn monitor_enable(
        &self,
        option: <Self::Architecture as Architecture>::EventMonitor,
    ) -> Result<(), VmiError>;
    fn monitor_disable(
        &self,
        option: <Self::Architecture as Architecture>::EventMonitor,
    ) -> Result<(), VmiError>;
    fn inject_interrupt(
        &self,
        vcpu: VcpuId,
        interrupt: <Self::Architecture as Architecture>::Interrupt,
    ) -> Result<(), VmiError>;
    fn events_pending(&self) -> usize;
    fn event_processing_overhead(&self) -> Duration;
    fn wait_for_event<'a>(
        &'a self,
        timeout: Duration,
        handler: Box<VmiEventCallback<'a, Self::Architecture>>,
    ) -> Result<(), VmiError>;
    fn reset_state(&self) -> Result<(), VmiError>;
}

A trait for implementing a VMI driver.

Required Associated Types

type Architecture: Architecture + ?Sized

The architecture supported by the driver.

Required Methods

fn info(&self) -> Result<VmiInfo, VmiError>

Retrieves information about the virtual machine.

fn pause(&self) -> Result<(), VmiError>

Pauses the virtual machine.

fn resume(&self) -> Result<(), VmiError>

Resumes the virtual machine.

fn registers( &self, vcpu: VcpuId, ) -> Result<<Self::Architecture as Architecture>::Registers, VmiError>

Retrieves the registers of a specific virtual CPU.

fn set_registers( &self, vcpu: VcpuId, registers: <Self::Architecture as Architecture>::Registers, ) -> Result<(), VmiError>

Sets the registers of a specific virtual CPU.

fn memory_access(&self, gfn: Gfn, view: View) -> Result<MemoryAccess, VmiError>

Retrieves the memory access permissions for a specific GFN.

fn set_memory_access( &self, gfn: Gfn, view: View, access: MemoryAccess, ) -> Result<(), VmiError>

Sets the memory access permissions for a specific GFN.

fn read_page(&self, gfn: Gfn) -> Result<VmiMappedPage, VmiError>

Reads a page of memory from the virtual machine.

fn write_page( &self, gfn: Gfn, offset: u64, content: &[u8], ) -> Result<VmiMappedPage, VmiError>

Writes data to a page of memory in the virtual machine.

fn allocate_gfn(&self, gfn: Gfn) -> Result<(), VmiError>

Allocates a specific GFN.

fn free_gfn(&self, gfn: Gfn) -> Result<(), VmiError>

Frees a previously allocated GFN.

fn default_view(&self) -> View

Returns the default view for the virtual machine.

fn create_view(&self, default_access: MemoryAccess) -> Result<View, VmiError>

Creates a new view with the specified default access permissions.

fn destroy_view(&self, view: View) -> Result<(), VmiError>

Destroys a previously created view.

fn switch_to_view(&self, view: View) -> Result<(), VmiError>

Switches to a different view.

fn change_view_gfn( &self, view: View, old_gfn: Gfn, new_gfn: Gfn, ) -> Result<(), VmiError>

Changes the mapping of a GFN in a specific view.

fn reset_view_gfn(&self, view: View, gfn: Gfn) -> Result<(), VmiError>

Resets the mapping of a GFN in a specific view to its original state.

fn monitor_enable( &self, option: <Self::Architecture as Architecture>::EventMonitor, ) -> Result<(), VmiError>

Enables monitoring of specific events.

fn monitor_disable( &self, option: <Self::Architecture as Architecture>::EventMonitor, ) -> Result<(), VmiError>

Disables monitoring of specific events.

fn inject_interrupt( &self, vcpu: VcpuId, interrupt: <Self::Architecture as Architecture>::Interrupt, ) -> Result<(), VmiError>

Injects an interrupt into a specific virtual CPU.

fn events_pending(&self) -> usize

Returns the number of pending events.

fn event_processing_overhead(&self) -> Duration

Returns the time spent processing events.

fn wait_for_event<'a>( &'a self, timeout: Duration, handler: Box<VmiEventCallback<'a, Self::Architecture>>, ) -> Result<(), VmiError>

Waits for an event to occur and processes it with the provided handler.

fn reset_state(&self) -> Result<(), VmiError>

Resets the state of the VMI system.

Implementors