Update to vm-memory 0.13.1

Mostly this introduces the traits WriteVolatile and ReadVolatile. Since
these can deal more efficiently deal with the volatile semantics, some
old methods got deprecated.

Mostly that means replacing Read/Write with {Read,Write}Volatile.

Some code still requires Read/Write in order to do calls like .flush()
- which is not part of the {Read,Write}Volatile contract.

Signed-off-by: Erik Schilling <[email protected]>

Author: Erik Schilling

crates/devices/virtio-blk/Cargo.toml

@@ -13,13 +13,13 @@ edition = "2021"
 backend-stdio = []
 
 [dependencies]
-vm-memory = "0.12.0"
+vm-memory = "0.13.1"
 vmm-sys-util = "0.11.0"
 log = "0.4.17"
 virtio-queue = { path = "../../virtio-queue" }
 virtio-device = { path = "../../virtio-device" }
 virtio-bindings = { path = "../../virtio-bindings", version = "0.2.1" }
 
 [dev-dependencies]
-vm-memory = { version = "0.12.0", features = ["backend-mmap", "backend-atomic"] }
+vm-memory = { version = "0.13.1", features = ["backend-mmap", "backend-atomic"] }
 virtio-queue = { path = "../../virtio-queue", features = ["test-utils"] }

crates/devices/virtio-blk/src/stdio_executor.rs

@@ -17,19 +17,21 @@
 //! request via [`StdIoBackend::execute`](struct.StdIoBackend.html#method.execute) method.
 //! The `StdIoBackend` is wrapping the block device backend and keeps the number of sectors of the
 //! backing file and its negotiated features too. This backend has to be, at least for now,
-//! `io::Read` and `io::Write`. In the future, we might add some abstraction for the file access
-//! operations.
+//! `vm_memory::ReadVolatile` and `vm_memory::WriteVolatile`.
+//! In the future, we might add some abstraction for the file access operations.
 //!
 //! For more complex executors, that need asynchronous dispatch of requests for example, we can
 //! add separate modules for those abstractions as well.
 
 use std::fmt::{self, Display};
-use std::io::{Read, Seek, SeekFrom, Write};
+use std::io::{Seek, SeekFrom};
 use std::{io, mem, result};
 
 use log::{error, warn};
 
-use vm_memory::{Address, ByteValued, Bytes, GuestMemory, GuestMemoryError};
+use vm_memory::{
+    Address, ByteValued, Bytes, GuestMemory, GuestMemoryError, ReadVolatile, WriteVolatile,
+};
 use vmm_sys_util::file_traits::FileSync;
 use vmm_sys_util::write_zeroes::{PunchHole, WriteZeroesAt};
 
@@ -43,9 +45,12 @@ use virtio_bindings::bindings::virtio_blk::{
 
 /// Trait that keeps as supertraits the ones that are necessary for the `StdIoBackend` abstraction
 /// used for the virtio block request execution.
-pub trait Backend: Read + Write + Seek + FileSync + PunchHole + WriteZeroesAt {}
+pub trait Backend:
+    ReadVolatile + WriteVolatile + Seek + FileSync + PunchHole + WriteZeroesAt
+{
+}
 
-impl<B: Read + Write + Seek + FileSync + PunchHole + WriteZeroesAt> Backend for B {}
+impl<B: ReadVolatile + WriteVolatile + Seek + FileSync + PunchHole + WriteZeroesAt> Backend for B {}
 
 /// One or more `DiscardWriteZeroes` structs are used to describe the data for
 /// discard or write zeroes command.
@@ -326,7 +331,7 @@ impl<B: Backend> StdIoBackend<B> {
                     return Err(Error::InvalidDataLength);
                 }
                 for (data_addr, data_len) in request.data() {
-                    mem.read_exact_from(*data_addr, &mut self.inner, *data_len as usize)
+                    mem.read_exact_volatile_from(*data_addr, &mut self.inner, *data_len as usize)
                         .map_err(|e| {
                             if let GuestMemoryError::PartialBuffer {
                                 completed,
@@ -347,7 +352,7 @@ impl<B: Backend> StdIoBackend<B> {
             RequestType::Out => {
                 self.check_access(total_len / SECTOR_SIZE, request.sector())?;
                 for (data_addr, data_len) in request.data() {
-                    mem.write_all_to(*data_addr, &mut self.inner, *data_len as usize)
+                    mem.write_all_volatile_to(*data_addr, &mut self.inner, *data_len as usize)
                         .map_err(Error::Write)?;
                 }
             }
@@ -364,7 +369,7 @@ impl<B: Backend> StdIoBackend<B> {
                 for (data_addr, data_len) in request.data() {
                     // The device_id accesses are safe because we checked that the total data length
                     // is VIRTIO_BLK_ID_BYTES, which is the size of the id as well.
-                    mem.read_exact_from(
+                    mem.read_exact_volatile_from(
                         *data_addr,
                         &mut &device_id[bytes_to_mem as usize..(*data_len + bytes_to_mem) as usize],
                         *data_len as usize,
@@ -475,6 +480,8 @@ impl<B: Backend> StdIoBackend<B> {
 mod tests {
     use super::*;
 
+    use std::io::{Read, Write};
+
     use vm_memory::guest_memory::Error::{InvalidGuestAddress, PartialBuffer};
     use vm_memory::{GuestAddress, GuestMemoryMmap};
     use vmm_sys_util::tempfile::TempFile;

crates/devices/virtio-console/Cargo.toml

@@ -14,8 +14,8 @@ edition = "2021"
 [dependencies]
 virtio-bindings = { path = "../../virtio-bindings", version = "0.2.1" }
 virtio-queue = { path = "../../virtio-queue", version = "0.9.0" }
-vm-memory = "0.12.0"
+vm-memory = "0.13.1"
 
 [dev-dependencies]
 virtio-queue = { path = "../../virtio-queue", version = "0.9.0", features = ["test-utils"] }
-vm-memory = { version = "0.12.0", features = ["backend-mmap"] }
+vm-memory = { version = "0.13.1", features = ["backend-mmap"] }

crates/devices/virtio-console/src/console.rs

@@ -17,7 +17,7 @@ use std::io::{stdout, Stdout, Write};
 use std::ops::Deref;
 use std::sync::{Arc, Mutex};
 use virtio_queue::DescriptorChain;
-use vm_memory::{Bytes, GuestMemory, GuestMemoryError};
+use vm_memory::{Bytes, GuestMemory, GuestMemoryError, WriteVolatile};
 
 /// Console device errors.
 #[derive(Debug)]
@@ -81,7 +81,7 @@ impl Display for Error {
 
 /// Console struct that implements the abstraction of virtio console descriptor chain handling.
 #[derive(Clone, Debug)]
-pub struct Console<T: Write> {
+pub struct Console<T: Write + WriteVolatile> {
     /// Buffer that stores data to be sent to the driver.
     input_buffer: Arc<Mutex<Vec<u8>>>,
     /// Capacity of the input buffer.
@@ -110,7 +110,7 @@ impl Default for Console<Stdout> {
 
 impl<T> Console<T>
 where
-    T: Write,
+    T: Write + WriteVolatile,
 {
     /// Create new console object with the default `capacity`.
     ///
@@ -206,7 +206,7 @@ where
             }
             desc_chain
                 .memory()
-                .write_to(desc.addr(), &mut self.output, desc.len() as usize)
+                .write_volatile_to(desc.addr(), &mut self.output, desc.len() as usize)
                 .map_err(Error::WriteToOutputFailed)?;
 
             self.output.flush().map_err(Error::OutputSinkFlushFailed)?;

crates/devices/virtio-vsock/Cargo.toml

@@ -13,8 +13,8 @@ edition = "2021"
 # The `path` part gets stripped when publishing the crate.
 virtio-queue = { path = "../../virtio-queue", version = "0.9.0" }
 virtio-bindings = { path = "../../virtio-bindings", version = "0.2.1" }
-vm-memory = "0.12.0"
+vm-memory = "0.13.1"
 
 [dev-dependencies]
 virtio-queue = { path = "../../virtio-queue", version = "0.9.0", features = ["test-utils"] }
-vm-memory = { version = "0.12.0", features = ["backend-mmap", "backend-atomic"] }
+vm-memory = { version = "0.13.1", features = ["backend-mmap", "backend-atomic"] }

crates/virtio-device/Cargo.toml

@@ -10,10 +10,10 @@ license = "Apache-2.0 OR MIT"
 edition = "2021"
 
 [dependencies]
-vm-memory = "0.12.0"
+vm-memory = "0.13.1"
 log = "0.4.17"
 virtio-bindings = { path = "../virtio-bindings" }
 virtio-queue = { path = "../virtio-queue", version = "0.9.0"}
 
 [dev-dependencies]
-vm-memory = { version = "0.12.0", features = ["backend-mmap", "backend-atomic"] }
+vm-memory = { version = "0.13.1", features = ["backend-mmap", "backend-atomic"] }

crates/virtio-queue-ser/Cargo.toml

@@ -18,7 +18,7 @@ versionize_derive = "0.1.3"
 # and virtio-queue-ser releases. This is to prevent accidental changes
 # to the serializer output in a patch release of virtio-queue. 
 virtio-queue = { path = "../../crates/virtio-queue", version = "=0.9.0" }
-vm-memory = "0.12.0"
+vm-memory = "0.13.1"
 
 [dev-dependencies]
 virtio-queue = { path = "../../crates/virtio-queue", version = "=0.9.0", features = ["test-utils"] }

crates/virtio-queue/Cargo.toml

@@ -13,14 +13,14 @@ edition = "2021"
 test-utils = []
 
 [dependencies]
-vm-memory = "0.12.0"
+vm-memory = "0.13.1"
 vmm-sys-util = "0.11.0"
 log = "0.4.17"
 virtio-bindings = { path="../virtio-bindings", version = "0.2.1" }
 
 [dev-dependencies]
 criterion = "0.3.0"
-vm-memory = { version = "0.12.0", features = ["backend-mmap", "backend-atomic"] }
+vm-memory = { version = "0.13.1", features = ["backend-mmap", "backend-atomic"] }
 memoffset = "0.7.1"
 
 [[bench]]

fuzz/Cargo.toml

@@ -19,7 +19,7 @@ serde = "1.0.63"
 virtio-queue = { path = "../crates/virtio-queue", features = ["test-utils"] }
 virtio-vsock = { path = "../crates/devices/virtio-vsock" }
 virtio-queue-ser = { path = "../crates/virtio-queue-ser" }
-vm-memory = { version = "0.12.0", features = ["backend-mmap", "backend-atomic"] }
+vm-memory = { version = "0.13.1", features = ["backend-mmap", "backend-atomic"] }
 common = { path = "common" }
 
 [[bin]]

fuzz/common/Cargo.toml

@@ -12,4 +12,4 @@ virtio-bindings = { path = "../../crates/virtio-bindings" }
 virtio-queue = { path = "../../crates/virtio-queue", features = ["test-utils"] }
 virtio-vsock = { path = "../../crates/devices/virtio-vsock" }
 virtio-queue-ser = { path = "../../crates/virtio-queue-ser" }
-vm-memory = { version = "0.12.0", features = ["backend-mmap", "backend-atomic"] }
+vm-memory = { version = "0.13.1", features = ["backend-mmap", "backend-atomic"] }