vmi-utils 0.5.1

Utilities for VMI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! Architecture-specific adapters for reading bridge packets from VMI
//! events and writing responses back into guest registers.

#[cfg(feature = "arch-amd64")]
mod amd64;

use vmi_core::{Architecture, VmiEvent, arch::GpRegisters};

use super::BridgePacket;

/// Architecture-specific adapter for the bridge protocol.
///
/// Converts VMI events into [`BridgePacket`]s by extracting register values
/// according to the architecture's calling convention.
pub trait ArchAdapter: Architecture + Sized + 'static {
    /// Reads a [`BridgePacket`] from a VMI event's registers.
    ///
    /// # Architecture-specific
    ///
    /// - **AMD64 (x64, VMCALL)**: magic from `RCX`, request+method from
    ///   `RDX`, values from `R8`-`R11`.
    /// - **AMD64 (x86, VMCALL)**: magic from `EBP`, request+method from
    ///   `EDX`, only 2 value slots (`ESI`, `EDI`) due to the Xen
    ///   hypercall ABI consuming `EAX`, `EBX`, `ECX`.
    /// - **AMD64 (x64, CPUID)**: magic from `leaf` (EAX), request+method from
    ///   `subleaf` (ECX), values from `R8`-`R11`.
    /// - **AMD64 (x86, CPUID)**: magic from `leaf` (EAX), request+method from
    ///   `subleaf` (ECX), values from `EBX`, `EDX`, `ESI`, `EDI`.
    fn read_packet(event: &VmiEvent<Self>) -> BridgePacket;
}

/// Adapter for writing bridge response values back into general-purpose
/// registers.
///
/// Each architecture maps the four response values to specific registers.
///
/// # Architecture-specific
///
/// **AMD64**: `RAX`, `RBX`, `RCX` and `RDX`.
pub trait GpRegistersAdapter: GpRegisters + Sized + 'static {
    /// Writes response values into the register set.
    ///
    /// `None` values leave the corresponding register unchanged.
    fn write_response(
        &mut self,
        value1: Option<u64>,
        value2: Option<u64>,
        value3: Option<u64>,
        value4: Option<u64>,
    );
}