Added snapshot feature for vhost-device-vsock.

There is a hang issue during snapshot disable
vring, my solution is to check vring enable/disable
status but it requires a new function get_enabled
from vring.

Signed-off-by: Wei-Chung Hsu <[email protected]>

Author: WeiChungHsu

vhost-device-vsock/src/vhu_vsock.rs

@@ -2,14 +2,18 @@
 
 use std::{
     collections::{HashMap, HashSet},
-    io::{self, Result as IoResult},
+    io::{self, Result as IoResult, BufReader, Read},
     path::PathBuf,
     sync::{Arc, Mutex, RwLock},
+    fs::File,
+    thread::{self, JoinHandle},
 };
 
 use log::warn;
 use thiserror::Error as ThisError;
-use vhost::vhost_user::message::{VhostUserProtocolFeatures, VhostUserVirtioFeatures};
+use vhost::vhost_user::message::{
+    VhostTransferStateDirection, VhostTransferStatePhase, VhostUserProtocolFeatures, VhostUserVirtioFeatures
+};
 use vhost_user_backend::{VhostUserBackend, VringRwLock};
 use virtio_bindings::bindings::{
     virtio_config::VIRTIO_F_NOTIFY_ON_EMPTY, virtio_config::VIRTIO_F_VERSION_1,
@@ -252,12 +256,27 @@ struct VirtioVsockConfig {
 // reading its content from byte array.
 unsafe impl ByteValued for VirtioVsockConfig {}
 
+pub(crate) struct HandlerThread {
+    pub handle: Option<JoinHandle<()>>,
+    pub created: bool,
+}
+
+impl HandlerThread {
+    pub fn new(handle: Option<JoinHandle<()>>, created: bool) -> Result<Self> {
+        Ok(Self {
+            handle: handle,
+            created: created,
+        })
+    }
+}
+
 pub(crate) struct VhostUserVsockBackend {
     config: VirtioVsockConfig,
     queue_size: usize,
     pub threads: Vec<Mutex<VhostUserVsockThread>>,
     queues_per_thread: Vec<u64>,
     pub exit_event: EventFd,
+    pub handler_thread: Mutex<HandlerThread>,
 }
 
 impl VhostUserVsockBackend {
@@ -279,6 +298,7 @@ impl VhostUserVsockBackend {
             threads: vec![thread],
             queues_per_thread,
             exit_event: EventFd::new(EFD_NONBLOCK).map_err(Error::EventFdCreate)?,
+            handler_thread: Mutex::new(HandlerThread::new(None, false)?),
         })
     }
 }
@@ -303,7 +323,54 @@ impl VhostUserBackend for VhostUserVsockBackend {
     }
 
     fn protocol_features(&self) -> VhostUserProtocolFeatures {
-        VhostUserProtocolFeatures::MQ | VhostUserProtocolFeatures::CONFIG
+        VhostUserProtocolFeatures::MQ | VhostUserProtocolFeatures::CONFIG | VhostUserProtocolFeatures::DEVICE_STATE
+    }
+
+    fn set_device_state_fd(
+        &self,
+        direction: VhostTransferStateDirection,
+        phase: VhostTransferStatePhase,
+        file: File,
+    ) -> IoResult<Option<File>> {
+        self.handler_thread.lock().unwrap().created = true;
+        let handle = thread::spawn(move || {
+            match direction {
+                SAVE => {
+                    // save
+                    // No device state to save yet, just close the FD.
+                    drop(file);
+                }
+                LOAD => {
+                    // load
+                    // No device state to load yet, just verify it is empty.
+                    let mut data = Vec::new();
+                    let mut reader = BufReader::new(file);
+                    if reader.read_to_end(&mut data).is_err() {
+                        println!("vhost-device-vsock loaded device state read failed");
+                        return;
+                    }
+
+                    if data.len() > 0 {
+                        println!("vhost-device-vsock loaded device state is non-empty. BUG!");
+                        return;
+                    }
+                }
+                _ => {
+                    println!("invalid transfer_direction");
+                    return;
+                }
+            }
+        });
+        self.handler_thread.lock().unwrap().handle = Some(handle);
+        return Ok(None);
+    }
+
+    fn check_device_state(&self) -> IoResult<()> {
+        if (self.handler_thread.lock().unwrap().created) {
+            self.handler_thread.lock().unwrap().created = false;
+            self.handler_thread.lock().unwrap().handle.take().unwrap().join().unwrap();
+        }
+        return Ok(());
     }
 
     fn set_event_idx(&self, enabled: bool) {

vhost-device-vsock/src/vhu_vsock_thread.rs

@@ -586,6 +586,10 @@ impl VhostUserVsockThread {
 
         let mut vring_mut = vring.get_mut();
 
+        if !vring_mut.get_enabled() {
+            return Ok(true);
+        }
+
         let queue = vring_mut.get_queue_mut();
 
         while let Some(mut avail_desc) = queue
@@ -657,6 +661,8 @@ impl VhostUserVsockThread {
             loop {
                 if !self.thread_backend.pending_rx() {
                     break;
+                } else if !vring.get_enabled() {
+                    break;
                 }
                 vring.disable_notification().unwrap();
 
@@ -677,6 +683,8 @@ impl VhostUserVsockThread {
             loop {
                 if !self.thread_backend.pending_raw_pkts() {
                     break;
+                } else if !vring.get_enabled() {
+                    break;
                 }
                 vring.disable_notification().unwrap();
 
@@ -722,8 +730,12 @@ impl VhostUserVsockThread {
             None => return Err(Error::NoMemoryConfigured),
         };
 
-        while let Some(mut avail_desc) = vring
-            .get_mut()
+        let mut vring_mut = vring.get_mut();
+        if !vring_mut.get_enabled() {
+            return Ok(true);
+        }
+
+        while let Some(mut avail_desc) = vring_mut
             .get_queue_mut()
             .iter(atomic_mem.memory())
             .map_err(|_| Error::IterateQueue)?