some minor fixes here and there

+ coverage score update caused by switching to
Rust 1.41.1.

Signed-off-by: Laura Loghin <[email protected]>

Author: lauralt

benches/main.rs

@@ -1,9 +1,6 @@
 // Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 //
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE-BSD-3-Clause file.
-//
-// SPDX-License-Identifier: Apache-2.0 AND BSD-3-Clause
+// SPDX-License-Identifier: Apache-2.0 OR BSD-3-Clause
 
 extern crate criterion;
 

benches/mmap/mod.rs

@@ -1,14 +1,10 @@
 // Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 //
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE-BSD-3-Clause file.
-//
-// SPDX-License-Identifier: Apache-2.0 AND BSD-3-Clause
+// SPDX-License-Identifier: Apache-2.0 OR BSD-3-Clause
 #![cfg(feature = "backend-mmap")]
 
 extern crate criterion;
 extern crate vm_memory;
-extern crate vmm_sys_util;
 
 use std::fs::{File, OpenOptions};
 use std::io::Cursor;
@@ -176,7 +172,7 @@ pub fn benchmark_for_mmap(c: &mut Criterion) {
             })
         });
 
-        c.bench_function(format!("write_exact_to_{:#0x}", offset).as_str(), |b| {
+        c.bench_function(format!("write_exact_to_{:#0X}", offset).as_str(), |b| {
             b.iter(|| {
                 black_box(
                     memory

coverage_config_x86_64.json

@@ -1,5 +1,5 @@
 {
-  "coverage_score": 85.2,
+  "coverage_score": 85.4,
   "exclude_path": "mmap_windows.rs",
   "crate_features": "backend-mmap,backend-atomic"
 }

src/guest_memory.rs

@@ -521,8 +521,8 @@ pub trait GuestMemory {
 
     /// Invokes callback `f` to handle data in the address range `[addr, addr + count)`.
     ///
-    /// /// The address range `[addr, addr + count)` may span more than one
-    /// [`GuestMemoryRegion`](trait.GuestMemoryRegion.html) objects, or even have holes in it.
+    /// The address range `[addr, addr + count)` may span more than one
+    /// [`GuestMemoryRegion`](trait.GuestMemoryRegion.html) object, or even have holes in it.
     /// So [`try_access()`](trait.GuestMemory.html#method.try_access) invokes the callback 'f'
     /// for each [`GuestMemoryRegion`](trait.GuestMemoryRegion.html) object involved and returns:
     /// - the error code returned by the callback 'f'
@@ -577,7 +577,7 @@ pub trait GuestMemory {
     /// concurrent accesses to the underlying guest memory.
     ///
     /// # Arguments
-    /// * `guest_addr` - Guest address to convert.
+    /// * `addr` - Guest address to convert.
     ///
     /// # Examples
     ///
@@ -640,14 +640,14 @@ impl<T: GuestMemory> Bytes<GuestAddress> for T {
     }
 
     /// # Examples
-    /// * Write a slice at guestaddress 0x200.
+    /// * Write a slice at guestaddress 0x1000.
     ///
     /// ```
     /// # #[cfg(feature = "backend-mmap")]
     /// # use vm_memory::{Bytes, GuestAddress, mmap::GuestMemoryMmap};
     ///
     /// # #[cfg(feature = "backend-mmap")]
-    /// # fn test_write_u64() {
+    /// # fn test_write_slice() {
     ///     let start_addr = GuestAddress(0x1000);
     ///     let mut gm =
     ///             GuestMemoryMmap::from_ranges(&vec![(start_addr, 0x400)])
@@ -657,7 +657,7 @@ impl<T: GuestMemory> Bytes<GuestAddress> for T {
     /// # }
     ///
     /// # #[cfg(feature = "backend-mmap")]
-    /// # test_write_u64();
+    /// # test_write_slice();
     /// ```
     fn write_slice(&self, buf: &[u8], addr: GuestAddress) -> Result<()> {
         let res = self.write(buf, addr)?;
@@ -671,14 +671,14 @@ impl<T: GuestMemory> Bytes<GuestAddress> for T {
     }
 
     /// # Examples
-    /// * Read a slice of length 16 at guestaddress 0x200.
+    /// * Read a slice of length 16 at guestaddress 0x1000.
     ///
     /// ```
     /// # #[cfg(feature = "backend-mmap")]
     /// # use vm_memory::{Bytes, GuestAddress, mmap::GuestMemoryMmap};
     ///
     /// # #[cfg(feature = "backend-mmap")]
-    /// # fn test_write_u64() {
+    /// # fn test_read_slice() {
     ///     let start_addr = GuestAddress(0x1000);
     ///     let mut gm =
     ///             GuestMemoryMmap::from_ranges(&vec![(start_addr, 0x400)])
@@ -689,7 +689,7 @@ impl<T: GuestMemory> Bytes<GuestAddress> for T {
     /// # }
     ///
     /// # #[cfg(feature = "backend-mmap")]
-    /// # test_write_u64()
+    /// # test_read_slice()
     /// ```
     fn read_slice(&self, buf: &mut [u8], addr: GuestAddress) -> Result<()> {
         let res = self.read(buf, addr)?;

src/lib.rs

@@ -8,7 +8,7 @@
 
 //! Traits for allocating, handling and interacting with the VM's physical memory.
 //!
-//! For a typical hypervisor, there are seveval components, such as boot loader, virtual device
+//! For a typical hypervisor, there are several components, such as boot loader, virtual device
 //! drivers, virtio backend drivers and vhost drivers etc, that need to access VM's physical memory.
 //! This crate aims to provide a set of stable traits to decouple VM memory consumers from VM
 //! memory providers. Based on these traits, VM memory consumers could access VM's physical memory