Struct Pmem 

pub struct Pmem {
    pub avail_features: u64,
    pub acked_features: u64,
    pub activate_event: EventFd,
    pub device_state: DeviceState,
    pub queues: Vec<Queue>,
    pub queue_events: Vec<EventFd>,
    pub config_space: ConfigSpace,
    pub file: File,
    pub file_len: u64,
    pub mmap_ptr: u64,
    pub metrics: Arc<PmemMetrics>,
    pub config: PmemConfig,
}

Fields

avail_features: u64

acked_features: u64

activate_event: EventFd

device_state: DeviceState

queues: Vec<Queue>

queue_events: Vec<EventFd>

config_space: ConfigSpace

file: File

file_len: u64

mmap_ptr: u64

metrics: Arc<PmemMetrics>

config: PmemConfig

Implementations

impl Pmem

pub const ALIGNMENT: u64

pub fn new(config: PmemConfig) -> Result<Self, PmemError>

Create a new Pmem device with a backing file at disk_image_path path.

pub fn new_with_queues( config: PmemConfig, queues: Vec<Queue>, ) -> Result<Self, PmemError>

Create a new Pmem device with a backing file at disk_image_path path using a pre-created set of queues.

pub fn alloc_region(&mut self, vm: &Vm)

Allocate memory in past_mmio64 memory region

pub fn set_mem_region(&mut self, vm: &Vm) -> Result<(), PmemError>

Set user memory region in KVM

pub fn handle_queue(&mut self) -> Result<(), PmemError>

pub fn process_queue(&mut self)

Trait Implementations

impl Debug for Pmem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Pmem

fn drop(&mut self)

Executes the destructor for this type.

impl MutEventSubscriber for Pmem

fn init(&mut self, ops: &mut EventOps<'_>)

Initialization called by the EventManager when the subscriber is registered.

fn process(&mut self, events: Events, ops: &mut EventOps<'_>)

Process events triggered in the event manager loop.

impl<'a> Persist<'a> for Pmem

type State = PmemState

The type of the object representing the state of the component.

type ConstructorArgs = PmemConstructorArgs<'a>

The type of the object holding the constructor arguments.

type Error = PmemPersistError

The type of the error that can occur while constructing the object.

fn save(&self) -> Self::State

Returns the current state of the component.

fn restore( constructor_args: Self::ConstructorArgs, state: &Self::State, ) -> Result<Self, Self::Error>

Constructs a component from a specified state.

impl VirtioDevice for Pmem

fn const_device_type() -> u32

The virtio device type (as a constant of the struct).

fn device_type(&self) -> u32

The virtio device type.

fn avail_features(&self) -> u64

Get the available features offered by device.

fn acked_features(&self) -> u64

Get acknowledged features of the driver.

fn set_acked_features(&mut self, acked_features: u64)

Set acknowledged features of the driver. This function must maintain the following invariant:

fn queues(&self) -> &[Queue]

Returns the device queues.

fn queues_mut(&mut self) -> &mut [Queue]

Returns a mutable reference to the device queues.

fn queue_events(&self) -> &[EventFd]

Returns the device queues event fds.

fn interrupt_trigger(&self) -> &dyn VirtioInterrupt

fn read_config(&self, offset: u64, data: &mut [u8])

Reads this device configuration space at offset.

fn write_config(&mut self, _offset: u64, _data: &[u8])

Writes to this device configuration space at offset.

fn activate( &mut self, mem: GuestMemoryMmap, interrupt: Arc<dyn VirtioInterrupt>, ) -> Result<(), ActivateError>

Performs the formal activation for a device, which can be verified also with is_activated.

fn is_activated(&self) -> bool

Checks if the resources of this device are activated.

fn kick(&mut self)

Kick the device, as if it had received external events.

fn has_feature(&self, feature: u64) -> bool

Check if virtio device has negotiated given feature.

fn interrupt_status(&self) -> Arc<AtomicU32>

Returns the current device interrupt status.

fn avail_features_by_page(&self, page: u32) -> u32

The set of feature bits shifted by page * 32.

fn ack_features_by_page(&mut self, page: u32, value: u32)

Acknowledges that this set of features should be enabled.

fn reset(&mut self) -> Option<(Arc<dyn VirtioInterrupt>, Vec<EventFd>)>

Optionally deactivates this device and returns ownership of the guest memory map, interrupt event, and queue events.

fn mark_queue_memory_dirty( &mut self, mem: &GuestMemoryMmap, ) -> Result<(), QueueError>

Mark pages used by queues as dirty.

fn as_cow_file_engine(&self) -> Option<&CowFileEngine>

Returns a COW file engine if the device exposes one (NYX extension).

fn nyx_handle_queue_event(&mut self, _queue_index: u16)

Handle a queue notification from an MMIO write (NYX extension).