Struct devices::proxy::ProxyDevice

pub struct ProxyDevice {
    child_proc_intf: ChildProcIntf,
}

Wraps an inner BusDevice that is run inside a child process via fork.

The forked device process will automatically be terminated when this is dropped.

Fields

child_proc_intf: ChildProcIntf

Implementations

impl ProxyDevice

pub fn new<D: BusDevice, P: PrepareFork>( device: D, jail: Minijail, keep_rds: Vec<RawDescriptor>, swap_prepare_fork: &mut Option<P> ) -> Result<ProxyDevice, Error>

Takes the given device and isolates it into another process via fork before returning.

Because forks are very unfriendly to destructors and all memory mappings and file descriptors are inherited, this should be used as early as possible in the main process. ProxyDevice::new shall not be used for hotplugging. Call ChildProcIntf::new on jail warden process, send using serde, then cast into ProxyDevice instead.

Arguments

• device - The device to isolate to another process.
• jail - The jail to use for isolating the given device.
• keep_rds - File descriptors that will be kept open in the child.

pub fn pid(&self) -> pid_t

fn send_no_result(&self, cmd: &Command)

Send a command that does not expect a response from the child device process.

fn sync_send(&self, cmd: &Command) -> Option<CommandResult>

Send a command and read its response from the child device process.

Trait Implementations

impl BusDevice for ProxyDevice

fn device_id(&self) -> DeviceId

Returns a unique id per device type suitable for metrics gathering.

fn debug_label(&self) -> String

Returns a label suitable for debug output.

fn config_register_write( &mut self, reg_idx: usize, offset: u64, data: &[u8] ) -> ConfigWriteResult

Sets a register in the configuration space. Only used by PCI.

fn config_register_read(&self, reg_idx: usize) -> u32

Gets a register from the configuration space. Only used by PCI.

fn init_pci_config_mapping( &mut self, shmem: &SharedMemory, base: usize, len: usize ) -> bool

Provides a memory region to back MMIO access to the configuration space. If the device can keep the memory region up to date, then it should return true, after which no more calls to config_register_read will be made. Otherwise the device should return false.

fn virtual_config_register_write(&mut self, reg_idx: usize, value: u32)

Sets a register in the virtual config space. Only used by PCI.

fn virtual_config_register_read(&self, reg_idx: usize) -> u32

Gets a register from the virtual config space. Only used by PCI.

fn read(&mut self, info: BusAccessInfo, data: &mut [u8])

Reads at offset from this device

fn write(&mut self, info: BusAccessInfo, data: &[u8])

Writes at offset into this device

fn get_ranges(&self) -> Vec<(BusRange, BusType)>

Gets a list of all ranges registered by this BusDevice.

fn destroy_device(&mut self)

Invoked when the device is destroyed

fn on_sandboxed(&mut self)

Invoked when the device is sandboxed.

fn is_bridge(&self) -> Option<u8>

Returns the secondary bus number if this bus device is pci bridge

impl Drop for ProxyDevice

fn drop(&mut self)

Executes the destructor for this type.

impl Suspendable for ProxyDevice

fn snapshot(&mut self) -> Result<Value>

Save the device state in an image that can be restored.

fn restore(&mut self, data: Value) -> Result<()>

Load a saved snapshot of an image.

fn sleep(&mut self) -> Result<()>

Stop all threads related to the device. Sleep should be idempotent.

fn wake(&mut self) -> Result<()>

Create/Resume all threads related to the device. Wake should be idempotent.

impl TryFrom<ChildProcIntf> for ProxyDevice

type Error = Error

The type returned in the event of a conversion error.

fn try_from(child_proc_intf: ChildProcIntf) -> Result<Self, Error>

Performs the conversion.