Struct devices::virtio::gpu::Gpu

pub struct Gpu {

    exit_evt_wrtube: SendTube,
    pub gpu_control_tube: Option<Tube>,
    mapper: Arc<Mutex<Option<Box<dyn SharedMemoryMapper>>>>,
    resource_bridges: Option<ResourceBridges>,
    event_devices: Option<Vec<EventDevice>>,
    worker_suspend_evt: Option<Event>,
    worker_request_sender: Option<Sender<WorkerRequest>>,
    worker_response_receiver: Option<Receiver<Result<WorkerResponse>>>,
    worker_state: WorkerState,
    worker_thread: Option<WorkerThread<()>>,
    display_backends: Vec<DisplayBackend>,
    display_params: Vec<GpuDisplayParameters>,
    display_event: Arc<AtomicBool>,
    rutabaga_builder: RutabagaBuilder,
    pci_address: Option<PciAddress>,
    pci_bar_size: u64,
    external_blob: bool,
    fixed_blob_mapping: bool,
    rutabaga_component: RutabagaComponentType,
    base_features: u64,
    udmabuf: bool,
    rutabaga_server_descriptor: Option<SafeDescriptor>,
    capset_mask: u64,
    gpu_cgroup_path: Option<PathBuf>,
}

Fields

exit_evt_wrtube: SendTube

gpu_control_tube: Option<Tube>

mapper: Arc<Mutex<Option<Box<dyn SharedMemoryMapper>>>>

resource_bridges: Option<ResourceBridges>

event_devices: Option<Vec<EventDevice>>

worker_suspend_evt: Option<Event>

worker_request_sender: Option<Sender<WorkerRequest>>

worker_response_receiver: Option<Receiver<Result<WorkerResponse>>>

worker_state: WorkerState

worker_thread: Option<WorkerThread<()>>

display_backends: Vec<DisplayBackend>

display_params: Vec<GpuDisplayParameters>

display_event: Arc<AtomicBool>

rutabaga_builder: RutabagaBuilder

pci_address: Option<PciAddress>

pci_bar_size: u64

external_blob: bool

fixed_blob_mapping: bool

rutabaga_component: RutabagaComponentType

base_features: u64

udmabuf: bool

rutabaga_server_descriptor: Option<SafeDescriptor>

capset_mask: u64

gpu_cgroup_path: Option<PathBuf>

Implementations

impl Gpu

pub fn new( exit_evt_wrtube: SendTube, gpu_control_tube: Tube, resource_bridges: Vec<Tube>, display_backends: Vec<DisplayBackend>, gpu_parameters: &GpuParameters, rutabaga_server_descriptor: Option<SafeDescriptor>, event_devices: Vec<EventDevice>, base_features: u64, channels: &BTreeMap<String, PathBuf>, gpu_cgroup_path: Option<&PathBuf> ) -> Gpu

pub fn initialize_frontend( &mut self, fence_state: Arc<Mutex<FenceState>>, fence_handler: RutabagaFenceHandler, mapper: Arc<Mutex<Option<Box<dyn SharedMemoryMapper>>>> ) -> Option<Frontend>

Initializes the internal device state so that it can begin processing virtqueues.

Only used by vhost-user GPU.

fn start_worker_thread(&mut self)

fn stop_worker_thread(&mut self)

fn get_config(&self) -> virtio_gpu_config

pub fn send_exit_evt(&self) -> Result<()>

Send a request to exit the process to VMM.

Trait Implementations

impl Drop for Gpu

fn drop(&mut self)

Executes the destructor for this type.

impl VirtioDevice for Gpu

fn keep_rds(&self) -> Vec<RawDescriptor>

A vector of device-specific file descriptors that must be kept open after jailing. Must be called before the process is jailed.

fn device_type(&self) -> DeviceType

The virtio device type.

fn queue_max_sizes(&self) -> &[u16]

The maximum size of each queue that this device supports.

fn features(&self) -> u64

The set of feature bits that this device supports in addition to the base features.

fn ack_features(&mut self, value: u64)

Acknowledges that this set of features should be enabled.

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 on_device_sandboxed(&mut self)

Invoked when the device is sandboxed.

fn activate( &mut self, mem: GuestMemory, interrupt: Interrupt, queues: BTreeMap<usize, Queue> ) -> Result<()>

Activates this device for real usage.

fn pci_address(&self) -> Option<PciAddress>

Returns the PCI address where the device will be allocated. Returns None if any address is good for the device.

fn get_shared_memory_region(&self) -> Option<SharedMemoryRegion>

Returns the device’s shared memory region if present.

fn set_shared_memory_mapper(&mut self, mapper: Box<dyn SharedMemoryMapper>)

Provides the trait object used to map files into the device’s shared memory region.

fn expose_shmem_descriptors_with_viommu(&self) -> bool

If true, VFIO passthrough devices can access descriptors mapped into this region by mapping the corresponding addresses from this device’s PCI bar into their IO address space with virtio-iommu.

fn get_shared_memory_prepare_type(&mut self) -> SharedMemoryPrepareType

Queries the implementation whether a single prepared hypervisor memory mapping with explicit caching type should be setup lazily on first mapping request, or whether to dynamically setup a hypervisor mapping with every request’s caching type.

fn virtio_sleep(&mut self) -> Result<Option<BTreeMap<usize, Queue>>>

Pause all processing.

fn virtio_wake( &mut self, queues_state: Option<(GuestMemory, Interrupt, BTreeMap<usize, Queue>)> ) -> Result<()>

Resume all processing.

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

Snapshot current state. Device must be asleep.

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

Restore device state from a snapshot. TODO(b/280607404): Vhost user will need fds passed to the device process.

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

Optionally deactivates this device. If the reset method is not able to reset the virtio device, or the virtio device model doesn’t implement the reset method, an Err value is returned to indicate the reset is not successful. Otherwise Ok(()) should be returned.

fn debug_label(&self) -> String

Returns a label suitable for debug output.

fn num_interrupts(&self) -> usize

The number of interrupts used by this device.

fn get_device_bars(&mut self, _address: PciAddress) -> Vec<PciBarConfiguration>

Returns any additional BAR configuration required by the device.

fn get_device_caps(&self) -> Vec<Box<dyn PciCapability>>

Returns any additional capabiltiies required by the device.

fn control_notify(&self, _behavior: MsixStatus)

fn generate_acpi( &mut self, _pci_address: &Option<PciAddress>, sdts: Vec<SDT> ) -> Option<Vec<SDT>>

fn read_bar(&mut self, _bar_index: PciBarIndex, _offset: u64, _data: &mut [u8])

Reads from a BAR region mapped in to the device.

fn write_bar(&mut self, _bar_index: PciBarIndex, _offset: u64, _data: &[u8])

Writes to a BAR region mapped in to the device.

fn transport_type(&self) -> VirtioTransportType

Returns the Virtio transport type: PCI (default for crosvm) or MMIO.

fn set_shared_memory_region_base(&mut self, _addr: GuestAddress)

Provides the base address of the shared memory region, if one is present. Will be called before activate.

fn bootorder_fw_cfg(&self, _pci_address: u8) -> Option<(Vec<u8>, usize)>