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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
// Copyright (C) 2021 Red Hat, Inc. All rights reserved.
// SPDX-License-Identifier: Apache-2.0 or BSD-3-Clause
//! Trait to control vhost-vdpa backend drivers.
use vmm_sys_util::eventfd::EventFd;
use crate::backend::VhostBackend;
use crate::Result;
/// vhost vdpa IOVA range
pub struct VhostVdpaIovaRange {
/// First address that can be mapped by vhost-vDPA.
pub first: u64,
/// Last address that can be mapped by vhost-vDPA.
pub last: u64,
}
/// Trait to control vhost-vdpa backend drivers.
///
/// vDPA (virtio Data Path Acceleration) devices has datapath compliant with the
/// virtio specification and the control path is vendor specific.
/// vDPA devices can be both physically located on the hardware or emulated
/// by software.
///
/// Compared to vhost acceleration, vDPA offers more control over the device
/// lifecycle.
/// For this reason, the vhost-vdpa interface extends the vhost API, offering
/// additional APIs for controlling the device (e.g. changing the state or
/// accessing the configuration space
pub trait VhostVdpa: VhostBackend {
/// Get the device id.
/// The device ids follow the same definition of the device id defined in virtio-spec.
fn get_device_id(&self) -> Result<u32>;
/// Get the status.
/// The status bits follow the same definition of the device status defined in virtio-spec.
fn get_status(&self) -> Result<u8>;
/// Set the status.
/// The status bits follow the same definition of the device status defined in virtio-spec.
///
/// # Arguments
/// * `status` - Status bits to set
fn set_status(&self, status: u8) -> Result<()>;
/// Get the device configuration.
///
/// # Arguments
/// * `offset` - Offset in the device configuration space
/// * `buffer` - Buffer for configuration data
fn get_config(&self, offset: u32, buffer: &mut [u8]) -> Result<()>;
/// Set the device configuration.
///
/// # Arguments
/// * `offset` - Offset in the device configuration space
/// * `buffer` - Buffer for configuration data
fn set_config(&self, offset: u32, buffer: &[u8]) -> Result<()>;
/// Set the status for a given vring.
///
/// # Arguments
/// * `queue_index` - Index of the queue to enable/disable.
/// * `enabled` - true to enable the vring, false to disable it.
fn set_vring_enable(&self, queue_index: usize, enabled: bool) -> Result<()>;
/// Get the maximum number of descriptors in the vring supported by the device.
fn get_vring_num(&self) -> Result<u16>;
/// Set the eventfd to trigger when device configuration change.
///
/// # Arguments
/// * `fd` - EventFd to trigger.
fn set_config_call(&self, fd: &EventFd) -> Result<()>;
/// Get the valid I/O virtual addresses range supported by the device.
fn get_iova_range(&self) -> Result<VhostVdpaIovaRange>;
/// Get the config size
fn get_config_size(&self) -> Result<u32>;
/// Get the count of all virtqueues
fn get_vqs_count(&self) -> Result<u32>;
/// Get the number of virtqueue groups
fn get_group_num(&self) -> Result<u32>;
/// Get the number of address spaces
fn get_as_num(&self) -> Result<u32>;
/// Get the group for a virtqueue.
/// The virtqueue index is stored in the index field of
/// vhost_vring_state. The group for this specific virtqueue is
/// returned via num field of vhost_vring_state.
fn get_vring_group(&self, queue_index: u32) -> Result<u32>;
/// Set the ASID for a virtqueue group. The group index is stored in
/// the index field of vhost_vring_state, the ASID associated with this
/// group is stored at num field of vhost_vring_state.
fn set_group_asid(&self, group_index: u32, asid: u32) -> Result<()>;
/// Suspend a device so it does not process virtqueue requests anymore
///
/// After the return of ioctl the device must preserve all the necessary state
/// (the virtqueue vring base plus the possible device specific states) that is
/// required for restoring in the future. The device must not change its
/// configuration after that point.
fn suspend(&self) -> Result<()>;
/// Map DMA region.
///
/// # Arguments
/// * `iova` - I/O virtual address.
/// * `size` - Size of the I/O mapping.
/// * `vaddr` - Virtual address in the current process.
/// * `readonly` - true if the region is read-only, false if reads and writes are allowed.
fn dma_map(&self, iova: u64, size: u64, vaddr: *const u8, readonly: bool) -> Result<()>;
/// Unmap DMA region.
///
/// # Arguments
/// * `iova` - I/O virtual address.
/// * `size` - Size of the I/O mapping.
fn dma_unmap(&self, iova: u64, size: u64) -> Result<()>;
}
|
