Struct memflow::mem::phys_mem::middleware::metrics::PhysicalMemoryMetrics

pub struct PhysicalMemoryMetrics<T> { /* private fields */ }

The metrics middleware collects metrics data (latency and number of bytes) for all read and write operations. Additionally metrics are outputted via ::log::info in regular intervals.

Since this middleware implements PhysicalMemory it can be used as a replacement in all structs and functions that require the PhysicalMemory trait.

Implementations

impl<T: PhysicalMemory> PhysicalMemoryMetrics<T>

pub fn new(mem: T) -> Self

Constructs a new middleware.

pub fn into_inner(self) -> T

Consumes self and returns the containing memory object.

This function can be useful in case the ownership over the memory object has been given to the cache when it was being constructed. It will destroy the self and return back the ownership of the underlying memory object.

Examples

use memflow::architecture::x86::x64;
use memflow::mem::{PhysicalMemory, PhysicalMemoryMetrics, MemoryView};

fn build<T: PhysicalMemory>(mem: T) -> T {
    let mut middleware = PhysicalMemoryMetrics::new(mem);

    // use the middleware...
    let value: u64 = middleware.phys_view().read(0.into()).unwrap();
    assert_eq!(value, MAGIC_VALUE);

    // retrieve ownership of mem and return it back
    middleware.into_inner()
}

Trait Implementations

impl<T> Clone for PhysicalMemoryMetrics<T>

where T: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'cglue_a, CGlueInst: Deref<Target = PhysicalMemoryMetrics<T>>, CGlueCtx: ContextBounds, T: PhysicalMemory> ConnectorInstanceVtableFiller<'cglue_a, CGlueInst, CGlueCtx> for PhysicalMemoryMetrics<T>

fn fill_table( table: ConnectorInstanceVtables<'cglue_a, CGlueInst, CGlueCtx> ) -> ConnectorInstanceVtables<'cglue_a, CGlueInst, CGlueCtx>

impl<T: PhysicalMemory> PhysicalMemory for PhysicalMemoryMetrics<T>

fn phys_read_raw_iter( &mut self, _: PhysicalReadMemOps<'_, '_, '_, '_> ) -> Result<()>

fn phys_write_raw_iter( &mut self, _: PhysicalWriteMemOps<'_, '_, '_, '_> ) -> Result<()>

fn metadata(&self) -> PhysicalMemoryMetadata

Retrieve metadata about the physical memory

fn set_mem_map(&mut self, mem_map: &[PhysicalMemoryMapping])

Sets the memory mapping for the physical memory

fn phys_read_into<T: Pod + ?Sized>( &mut self, addr: PhysicalAddress, out: &mut T ) -> Result<()>

where Self: Sized,

fn phys_write<T: Pod + ?Sized>( &mut self, addr: PhysicalAddress, data: &T ) -> Result<()>

where Self: Sized,

fn into_phys_view(self) -> PhysicalMemoryView<Self>

where Self: Sized,

fn phys_view(&mut self) -> PhysicalMemoryView<Fwd<&mut Self>>

where Self: Sized,

fn into_mem_view(self) -> PhysicalMemoryView<Self>

where Self: Sized,

fn mem_view(&mut self) -> PhysicalMemoryView<Fwd<&mut Self>>

where Self: Sized,