vhost: Add VhostUserMemoryRegionInfo::new() for tests

A lot of tests are creating objects of this structure directly, it would
be better if they all use a function instead to do so.

This will also be beneficial for future commits where more fields will
be added to this structure.

Signed-off-by: Viresh Kumar <[email protected]>

Author: vireshk

crates/vhost-user-backend/Cargo.toml

@@ -19,6 +19,6 @@ vmm-sys-util = "0.11.0"
 
 [dev-dependencies]
 nix = "0.26"
-vhost = { path = "../vhost", version = "0.7", features = ["vhost-user-master", "vhost-user-slave"] }
+vhost = { path = "../vhost", version = "0.7", features = ["test-utils", "vhost-user-master", "vhost-user-slave"] }
 vm-memory = { version = "0.11.0", features = ["backend-mmap", "backend-atomic", "backend-bitmap"] }
 tempfile = "3.2.0"

crates/vhost-user-backend/tests/vhost-user-server.rs

@@ -166,13 +166,13 @@ fn vhost_user_client(path: &Path, barrier: Arc<Barrier>) {
     let addr = mem.get_host_address(GuestAddress(0x100000)).unwrap() as u64;
     let reg = mem.find_region(GuestAddress(0x100000)).unwrap();
     let fd = reg.file_offset().unwrap();
-    let regions = [VhostUserMemoryRegionInfo {
-        guest_phys_addr: 0x100000,
-        memory_size: 0x100000,
-        userspace_addr: addr,
-        mmap_offset: 0,
-        mmap_handle: fd.file().as_raw_fd(),
-    }];
+    let regions = [VhostUserMemoryRegionInfo::new(
+        0x100000,
+        0x100000,
+        addr,
+        0,
+        fd.file().as_raw_fd(),
+    )];
     master.set_mem_table(&regions).unwrap();
 
     master.set_vring_num(0, 256).unwrap();
@@ -210,13 +210,7 @@ fn vhost_user_client(path: &Path, barrier: Arc<Barrier>) {
     master.set_vring_base(0, state as u16).unwrap();
 
     assert_eq!(master.get_max_mem_slots().unwrap(), 32);
-    let region = VhostUserMemoryRegionInfo {
-        guest_phys_addr: 0x800000,
-        memory_size: 0x100000,
-        userspace_addr: addr,
-        mmap_offset: 0,
-        mmap_handle: fd.file().as_raw_fd(),
-    };
+    let region = VhostUserMemoryRegionInfo::new(0x800000, 0x100000, addr, 0, fd.file().as_raw_fd());
     master.add_mem_region(&region).unwrap();
     master.remove_mem_region(&region).unwrap();
 }

crates/vhost/Cargo.toml

@@ -15,6 +15,7 @@ all-features = true
 
 [features]
 default = []
+test-utils = []
 vhost-vsock = []
 vhost-kern = []
 vhost-vdpa = ["vhost-kern"]

crates/vhost/src/backend.rs

@@ -443,6 +443,27 @@ impl<T: VhostBackendMut> VhostBackend for RefCell<T> {
         self.borrow_mut().set_vring_err(queue_index, fd)
     }
 }
+
+#[cfg(any(test, feature = "test-utils"))]
+impl VhostUserMemoryRegionInfo {
+    /// creates instance of `VhostUserMemoryRegionInfo`.
+    pub fn new(
+        guest_phys_addr: u64,
+        memory_size: u64,
+        userspace_addr: u64,
+        mmap_offset: u64,
+        mmap_handle: RawFd,
+    ) -> Self {
+        Self {
+            guest_phys_addr,
+            memory_size,
+            userspace_addr,
+            mmap_offset,
+            mmap_handle,
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

crates/vhost/src/vhost_kern/net.rs

@@ -130,13 +130,13 @@ mod tests {
 
         net.set_mem_table(&[]).unwrap_err();
 
-        let region = VhostUserMemoryRegionInfo {
-            guest_phys_addr: 0x0,
-            memory_size: 0x10_0000,
-            userspace_addr: m.get_host_address(GuestAddress(0x0)).unwrap() as u64,
-            mmap_offset: 0,
-            mmap_handle: -1,
-        };
+        let region = VhostUserMemoryRegionInfo::new(
+            0x0,
+            0x10_0000,
+            m.get_host_address(GuestAddress(0x0)).unwrap() as u64,
+            0,
+            -1,
+        );
         net.set_mem_table(&[region]).unwrap();
 
         net.set_log_base(

crates/vhost/src/vhost_kern/vdpa.rs

@@ -436,13 +436,13 @@ mod tests {
 
         vdpa.set_mem_table(&[]).unwrap_err();
 
-        let region = VhostUserMemoryRegionInfo {
-            guest_phys_addr: 0x0,
-            memory_size: 0x10_0000,
-            userspace_addr: m.get_host_address(GuestAddress(0x0)).unwrap() as u64,
-            mmap_offset: 0,
-            mmap_handle: -1,
-        };
+        let region = VhostUserMemoryRegionInfo::new(
+            0x0,
+            0x10_0000,
+            m.get_host_address(GuestAddress(0x0)).unwrap() as u64,
+            0,
+            -1,
+        );
         vdpa.set_mem_table(&[region]).unwrap();
 
         let device_id = vdpa.get_device_id().unwrap();

crates/vhost/src/vhost_kern/vsock.rs

@@ -148,13 +148,13 @@ mod tests {
         vsock.set_mem_table(&[region]).unwrap_err();
          */
 
-        let region = VhostUserMemoryRegionInfo {
-            guest_phys_addr: 0x0,
-            memory_size: 0x10_0000,
-            userspace_addr: m.get_host_address(GuestAddress(0x0)).unwrap() as u64,
-            mmap_offset: 0,
-            mmap_handle: -1,
-        };
+        let region = VhostUserMemoryRegionInfo::new(
+            0x0,
+            0x10_0000,
+            m.get_host_address(GuestAddress(0x0)).unwrap() as u64,
+            0,
+            -1,
+        );
         vsock.set_mem_table(&[region]).unwrap();
 
         vsock

crates/vhost/src/vhost_user/mod.rs

@@ -424,13 +424,13 @@ mod tests {
         assert_eq!(num, 2);
 
         let eventfd = vmm_sys_util::eventfd::EventFd::new(0).unwrap();
-        let mem = [VhostUserMemoryRegionInfo {
-            guest_phys_addr: 0,
-            memory_size: 0x10_0000,
-            userspace_addr: 0,
-            mmap_offset: 0,
-            mmap_handle: eventfd.as_raw_fd(),
-        }];
+        let mem = [VhostUserMemoryRegionInfo::new(
+            0,
+            0x10_0000,
+            0,
+            0,
+            eventfd.as_raw_fd(),
+        )];
         master.set_mem_table(&mem).unwrap();
 
         master
@@ -479,13 +479,8 @@ mod tests {
         assert_eq!(max_mem_slots, 32);
 
         let region_file: File = TempFile::new().unwrap().into_file();
-        let region = VhostUserMemoryRegionInfo {
-            guest_phys_addr: 0x10_0000,
-            memory_size: 0x10_0000,
-            userspace_addr: 0,
-            mmap_offset: 0,
-            mmap_handle: region_file.as_raw_fd(),
-        };
+        let region =
+            VhostUserMemoryRegionInfo::new(0x10_0000, 0x10_0000, 0, 0, region_file.as_raw_fd());
         master.add_mem_region(&region).unwrap();
 
         master.remove_mem_region(&region).unwrap();