2019-09-02 11:00:35 +00:00
|
|
|
// Copyright 2019 Intel Corporation. All Rights Reserved.
|
|
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
|
2019-12-31 10:49:11 +00:00
|
|
|
use super::super::{ActivateError, ActivateResult, Queue, VirtioDevice, VirtioDeviceType};
|
|
|
|
use super::handler::*;
|
|
|
|
use super::vu_common_ctrl::*;
|
|
|
|
use super::Error as DeviceError;
|
|
|
|
use super::{Error, Result};
|
|
|
|
use crate::VirtioInterrupt;
|
|
|
|
use arc_swap::ArcSwap;
|
2019-09-02 11:00:35 +00:00
|
|
|
use libc;
|
|
|
|
use libc::EFD_NONBLOCK;
|
|
|
|
use std::cmp;
|
|
|
|
use std::io::Write;
|
2019-12-31 10:49:11 +00:00
|
|
|
use std::mem;
|
2019-09-02 11:00:35 +00:00
|
|
|
use std::ptr::null;
|
2019-12-02 20:08:53 +00:00
|
|
|
use std::result;
|
|
|
|
use std::sync::atomic::{AtomicBool, Ordering};
|
2019-12-31 10:49:11 +00:00
|
|
|
use std::sync::Arc;
|
2019-09-02 11:00:35 +00:00
|
|
|
use std::thread;
|
|
|
|
use std::vec::Vec;
|
|
|
|
use vhost_rs::vhost_user::message::VhostUserConfigFlags;
|
|
|
|
use vhost_rs::vhost_user::message::{VhostUserProtocolFeatures, VhostUserVirtioFeatures};
|
|
|
|
use vhost_rs::vhost_user::{Master, VhostUserMaster, VhostUserMasterReqHandler};
|
|
|
|
use vhost_rs::VhostBackend;
|
|
|
|
use virtio_bindings::bindings::virtio_blk::*;
|
2019-12-31 10:49:11 +00:00
|
|
|
use vm_device::{Migratable, MigratableError, Pausable, Snapshotable};
|
|
|
|
use vm_memory::GuestMemoryMmap;
|
|
|
|
use vmm_sys_util::eventfd::EventFd;
|
2019-09-02 11:00:35 +00:00
|
|
|
|
|
|
|
macro_rules! offset_of {
|
|
|
|
($ty:ty, $field:ident) => {
|
|
|
|
unsafe { &(*(null() as *const $ty)).$field as *const _ as usize }
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
struct SlaveReqHandler {}
|
|
|
|
impl VhostUserMasterReqHandler for SlaveReqHandler {}
|
|
|
|
|
|
|
|
pub struct Blk {
|
|
|
|
vhost_user_blk: Master,
|
2019-09-19 16:14:55 +00:00
|
|
|
kill_evt: Option<EventFd>,
|
2019-12-02 20:08:53 +00:00
|
|
|
pause_evt: Option<EventFd>,
|
2019-09-02 11:00:35 +00:00
|
|
|
avail_features: u64,
|
|
|
|
acked_features: u64,
|
|
|
|
config_space: Vec<u8>,
|
|
|
|
queue_sizes: Vec<u16>,
|
2019-09-19 16:14:55 +00:00
|
|
|
queue_evts: Option<Vec<EventFd>>,
|
2020-01-13 17:52:19 +00:00
|
|
|
interrupt_cb: Option<Arc<dyn VirtioInterrupt>>,
|
2020-01-27 13:14:56 +00:00
|
|
|
epoll_threads: Option<Vec<thread::JoinHandle<result::Result<(), DeviceError>>>>,
|
2019-12-02 20:08:53 +00:00
|
|
|
paused: Arc<AtomicBool>,
|
2019-09-02 11:00:35 +00:00
|
|
|
}
|
|
|
|
|
2019-09-23 17:42:52 +00:00
|
|
|
impl Blk {
|
2019-09-02 11:00:35 +00:00
|
|
|
/// Create a new vhost-user-blk device
|
2019-09-23 17:42:52 +00:00
|
|
|
pub fn new(wce: bool, vu_cfg: VhostUserConfig) -> Result<Blk> {
|
|
|
|
let mut vhost_user_blk = Master::connect(&vu_cfg.sock, vu_cfg.num_queues as u64)
|
2019-09-02 11:00:35 +00:00
|
|
|
.map_err(Error::VhostUserCreateMaster)?;
|
|
|
|
|
|
|
|
// Filling device and vring features VMM supports.
|
|
|
|
let mut avail_features = 1 << VIRTIO_BLK_F_SEG_MAX
|
|
|
|
| 1 << VIRTIO_BLK_F_RO
|
|
|
|
| 1 << VIRTIO_BLK_F_BLK_SIZE
|
|
|
|
| 1 << VIRTIO_BLK_F_FLUSH
|
|
|
|
| 1 << VIRTIO_BLK_F_TOPOLOGY
|
|
|
|
| 1 << VIRTIO_F_VERSION_1
|
|
|
|
| VhostUserVirtioFeatures::PROTOCOL_FEATURES.bits();
|
|
|
|
|
2019-09-05 07:39:57 +00:00
|
|
|
if wce {
|
|
|
|
avail_features |= 1 << VIRTIO_BLK_F_CONFIG_WCE;
|
|
|
|
}
|
|
|
|
|
2019-09-02 11:00:35 +00:00
|
|
|
// Set vhost-user owner.
|
|
|
|
vhost_user_blk
|
|
|
|
.set_owner()
|
|
|
|
.map_err(Error::VhostUserSetOwner)?;
|
|
|
|
|
|
|
|
// Get features from backend, do negotiation to get a feature collection which
|
|
|
|
// both VMM and backend support.
|
|
|
|
let backend_features = vhost_user_blk
|
|
|
|
.get_features()
|
|
|
|
.map_err(Error::VhostUserGetFeatures)?;
|
|
|
|
avail_features &= backend_features;
|
|
|
|
// Set features back is required by the vhost crate mechanism, since the
|
|
|
|
// later vhost call will check if features is filled in master before execution.
|
|
|
|
vhost_user_blk
|
|
|
|
.set_features(avail_features)
|
|
|
|
.map_err(Error::VhostUserSetFeatures)?;
|
|
|
|
|
|
|
|
// Identify if protocol features are supported by the slave.
|
|
|
|
let mut acked_features = 0;
|
|
|
|
if avail_features & VhostUserVirtioFeatures::PROTOCOL_FEATURES.bits() != 0 {
|
|
|
|
acked_features |= VhostUserVirtioFeatures::PROTOCOL_FEATURES.bits();
|
|
|
|
|
|
|
|
let mut protocol_features = vhost_user_blk
|
|
|
|
.get_protocol_features()
|
|
|
|
.map_err(Error::VhostUserGetProtocolFeatures)?;
|
|
|
|
protocol_features |= VhostUserProtocolFeatures::MQ;
|
|
|
|
protocol_features &= !VhostUserProtocolFeatures::INFLIGHT_SHMFD;
|
|
|
|
vhost_user_blk
|
|
|
|
.set_protocol_features(protocol_features)
|
|
|
|
.map_err(Error::VhostUserSetProtocolFeatures)?;
|
|
|
|
}
|
|
|
|
|
|
|
|
let config_len = mem::size_of::<virtio_blk_config>();
|
2019-09-11 03:22:48 +00:00
|
|
|
let config_space: Vec<u8> = vec![0u8; config_len as usize];
|
|
|
|
|
|
|
|
let (_, mut config_space) = vhost_user_blk
|
|
|
|
.get_config(
|
|
|
|
0,
|
|
|
|
config_len as u32,
|
|
|
|
VhostUserConfigFlags::WRITABLE,
|
|
|
|
config_space.as_slice(),
|
|
|
|
)
|
|
|
|
.unwrap();
|
2019-09-02 11:00:35 +00:00
|
|
|
|
|
|
|
let queue_num_offset = offset_of!(virtio_blk_config, num_queues);
|
2019-09-11 03:22:48 +00:00
|
|
|
// Only set num_queues value(u16).
|
|
|
|
let num_queues_slice = (vu_cfg.num_queues as u16).to_le_bytes();
|
|
|
|
config_space[queue_num_offset..queue_num_offset + mem::size_of::<u16>()]
|
|
|
|
.copy_from_slice(&num_queues_slice);
|
2019-09-02 11:00:35 +00:00
|
|
|
|
|
|
|
Ok(Blk {
|
|
|
|
vhost_user_blk,
|
2019-09-19 16:14:55 +00:00
|
|
|
kill_evt: None,
|
2019-12-02 20:08:53 +00:00
|
|
|
pause_evt: None,
|
2019-09-02 11:00:35 +00:00
|
|
|
avail_features,
|
|
|
|
acked_features,
|
|
|
|
config_space,
|
|
|
|
queue_sizes: vec![vu_cfg.queue_size; vu_cfg.num_queues],
|
2019-09-19 16:14:55 +00:00
|
|
|
queue_evts: None,
|
|
|
|
interrupt_cb: None,
|
2020-01-27 13:14:56 +00:00
|
|
|
epoll_threads: None,
|
2019-12-02 20:08:53 +00:00
|
|
|
paused: Arc::new(AtomicBool::new(false)),
|
2019-09-02 11:00:35 +00:00
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Drop for Blk {
|
|
|
|
fn drop(&mut self) {
|
2019-09-19 16:14:55 +00:00
|
|
|
if let Some(kill_evt) = self.kill_evt.take() {
|
|
|
|
if let Err(e) = kill_evt.write(1) {
|
|
|
|
error!("failed to kill vhost-user-blk: {:?}", e);
|
|
|
|
}
|
2019-09-02 11:00:35 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl VirtioDevice for Blk {
|
|
|
|
fn device_type(&self) -> u32 {
|
|
|
|
VirtioDeviceType::TYPE_BLOCK as u32
|
|
|
|
}
|
|
|
|
|
|
|
|
fn queue_max_sizes(&self) -> &[u16] {
|
|
|
|
&self.queue_sizes
|
|
|
|
}
|
|
|
|
|
|
|
|
fn features(&self, page: u32) -> u32 {
|
|
|
|
match page {
|
|
|
|
0 => self.avail_features as u32,
|
|
|
|
1 => (self.avail_features >> 32) as u32,
|
|
|
|
_ => {
|
|
|
|
warn!("Received request for unknown features page: {}", page);
|
|
|
|
0u32
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
fn ack_features(&mut self, page: u32, value: u32) {
|
|
|
|
let mut v = match page {
|
|
|
|
0 => u64::from(value),
|
|
|
|
1 => u64::from(value) << 32,
|
|
|
|
_ => {
|
|
|
|
warn!("Cannot acknowledge unknown features page: {}", page);
|
|
|
|
0u64
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
// Check if the guest is ACK'ing a feature that we didn't claim to have.
|
|
|
|
let unrequested_features = v & !self.avail_features;
|
|
|
|
if unrequested_features != 0 {
|
|
|
|
warn!("Received acknowledge request for unknown feature: {:x}", v);
|
|
|
|
// Don't count these features as acked.
|
|
|
|
v &= !unrequested_features;
|
|
|
|
}
|
|
|
|
self.acked_features |= v;
|
|
|
|
}
|
|
|
|
|
|
|
|
fn read_config(&self, offset: u64, mut data: &mut [u8]) {
|
|
|
|
let config_len = self.config_space.len() as u64;
|
|
|
|
if offset >= config_len {
|
|
|
|
error!("Failed to read config space");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if let Some(end) = offset.checked_add(data.len() as u64) {
|
|
|
|
// This write can't fail, offset and end are checked against config_len.
|
|
|
|
data.write_all(&self.config_space[offset as usize..cmp::min(end, config_len) as usize])
|
|
|
|
.unwrap();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
fn write_config(&mut self, offset: u64, data: &[u8]) {
|
|
|
|
let data_len = data.len() as u64;
|
|
|
|
let config_len = self.config_space.len() as u64;
|
|
|
|
if offset + data_len > config_len {
|
|
|
|
error!("Failed to write config space");
|
|
|
|
return;
|
|
|
|
}
|
2019-09-05 07:39:57 +00:00
|
|
|
// In fact, write_config() only handle wce value in vhost-user-blk.
|
|
|
|
// so, we can only set wce value here.
|
|
|
|
if self.config_space[offset as usize] == data[0] {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
self.vhost_user_blk
|
|
|
|
.set_config(offset as u32, VhostUserConfigFlags::WRITABLE, data)
|
|
|
|
.expect("Failed to set config");
|
|
|
|
self.config_space[offset as usize] = data[0];
|
2019-09-02 11:00:35 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
fn activate(
|
|
|
|
&mut self,
|
2019-12-31 10:49:11 +00:00
|
|
|
mem: Arc<ArcSwap<GuestMemoryMmap>>,
|
2020-01-13 17:52:19 +00:00
|
|
|
interrupt_cb: Arc<dyn VirtioInterrupt>,
|
2019-09-02 11:00:35 +00:00
|
|
|
queues: Vec<Queue>,
|
|
|
|
queue_evts: Vec<EventFd>,
|
|
|
|
) -> ActivateResult {
|
2019-12-02 20:08:53 +00:00
|
|
|
let (self_kill_evt, kill_evt) = EventFd::new(EFD_NONBLOCK)
|
|
|
|
.and_then(|e| Ok((e.try_clone()?, e)))
|
|
|
|
.map_err(|e| {
|
|
|
|
error!("failed creating kill EventFd pair: {}", e);
|
|
|
|
ActivateError::BadActivate
|
|
|
|
})?;
|
2019-09-19 16:14:55 +00:00
|
|
|
self.kill_evt = Some(self_kill_evt);
|
|
|
|
|
2019-12-02 20:08:53 +00:00
|
|
|
let (self_pause_evt, pause_evt) = EventFd::new(EFD_NONBLOCK)
|
|
|
|
.and_then(|e| Ok((e.try_clone()?, e)))
|
|
|
|
.map_err(|e| {
|
|
|
|
error!("failed creating pause EventFd pair: {}", e);
|
|
|
|
ActivateError::BadActivate
|
|
|
|
})?;
|
|
|
|
self.pause_evt = Some(self_pause_evt);
|
|
|
|
|
2019-09-19 16:14:55 +00:00
|
|
|
// Save the interrupt EventFD as we need to return it on reset
|
|
|
|
// but clone it to pass into the thread.
|
|
|
|
self.interrupt_cb = Some(interrupt_cb.clone());
|
|
|
|
|
|
|
|
let mut tmp_queue_evts: Vec<EventFd> = Vec::new();
|
|
|
|
for queue_evt in queue_evts.iter() {
|
|
|
|
// Save the queue EventFD as we need to return it on reset
|
|
|
|
// but clone it to pass into the thread.
|
|
|
|
tmp_queue_evts.push(queue_evt.try_clone().map_err(|e| {
|
|
|
|
error!("failed to clone queue EventFd: {}", e);
|
|
|
|
ActivateError::BadActivate
|
|
|
|
})?);
|
|
|
|
}
|
|
|
|
self.queue_evts = Some(tmp_queue_evts);
|
2019-09-02 11:00:35 +00:00
|
|
|
|
|
|
|
let vu_interrupt_list = setup_vhost_user(
|
|
|
|
&mut self.vhost_user_blk,
|
2019-12-31 10:49:11 +00:00
|
|
|
mem.load().as_ref(),
|
2019-09-02 11:00:35 +00:00
|
|
|
queues,
|
|
|
|
queue_evts,
|
2020-01-14 07:18:35 +00:00
|
|
|
&interrupt_cb,
|
2019-09-02 11:00:35 +00:00
|
|
|
self.acked_features,
|
|
|
|
)
|
|
|
|
.map_err(ActivateError::VhostUserBlkSetup)?;
|
|
|
|
|
|
|
|
let mut handler = VhostUserEpollHandler::<SlaveReqHandler>::new(VhostUserEpollConfig {
|
|
|
|
interrupt_cb,
|
2019-09-19 16:14:55 +00:00
|
|
|
kill_evt,
|
2019-12-02 20:08:53 +00:00
|
|
|
pause_evt,
|
2019-09-02 11:00:35 +00:00
|
|
|
vu_interrupt_list,
|
|
|
|
slave_req_handler: None,
|
|
|
|
});
|
|
|
|
|
2019-12-02 20:08:53 +00:00
|
|
|
let paused = self.paused.clone();
|
2020-01-27 12:56:05 +00:00
|
|
|
let mut epoll_threads = Vec::new();
|
2019-12-02 20:08:53 +00:00
|
|
|
thread::Builder::new()
|
2019-09-02 11:00:35 +00:00
|
|
|
.name("vhost_user_blk".to_string())
|
2019-12-02 20:08:53 +00:00
|
|
|
.spawn(move || handler.run(paused))
|
2020-01-27 12:56:05 +00:00
|
|
|
.map(|thread| epoll_threads.push(thread))
|
2019-12-02 20:08:53 +00:00
|
|
|
.map_err(|e| {
|
|
|
|
error!("failed to clone virtio epoll thread: {}", e);
|
|
|
|
ActivateError::BadActivate
|
|
|
|
})?;
|
|
|
|
|
2020-01-27 13:14:56 +00:00
|
|
|
self.epoll_threads = Some(epoll_threads);
|
2020-01-27 12:56:05 +00:00
|
|
|
|
2019-09-02 11:00:35 +00:00
|
|
|
Ok(())
|
|
|
|
}
|
2019-09-19 16:14:55 +00:00
|
|
|
|
2020-01-13 17:52:19 +00:00
|
|
|
fn reset(&mut self) -> Option<(Arc<dyn VirtioInterrupt>, Vec<EventFd>)> {
|
2019-12-02 20:08:53 +00:00
|
|
|
// We first must resume the virtio thread if it was paused.
|
|
|
|
if self.pause_evt.take().is_some() {
|
|
|
|
self.resume().ok()?;
|
|
|
|
}
|
|
|
|
|
2019-09-19 16:14:55 +00:00
|
|
|
if let Err(e) = reset_vhost_user(&mut self.vhost_user_blk, self.queue_sizes.len()) {
|
|
|
|
error!("Failed to reset vhost-user daemon: {:?}", e);
|
|
|
|
return None;
|
|
|
|
}
|
|
|
|
|
|
|
|
if let Some(kill_evt) = self.kill_evt.take() {
|
|
|
|
// Ignore the result because there is nothing we can do about it.
|
|
|
|
let _ = kill_evt.write(1);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Return the interrupt and queue EventFDs
|
|
|
|
Some((
|
|
|
|
self.interrupt_cb.take().unwrap(),
|
|
|
|
self.queue_evts.take().unwrap(),
|
|
|
|
))
|
|
|
|
}
|
2019-09-02 11:00:35 +00:00
|
|
|
}
|
2019-12-02 20:08:53 +00:00
|
|
|
|
|
|
|
virtio_pausable!(Blk);
|
|
|
|
impl Snapshotable for Blk {}
|
|
|
|
impl Migratable for Blk {}
|