Add support to insert virtio-net devices

This PR gives the users two ways to insert virtio-net devices:

1. Insert before VMM launched. The parameter is
    `--virnets '[{"iface_id":"eth0","host_dev_name":"tap0","num_queues":2,"queue_size":0,"allow_duplicate_mac":true}]'`.
2. Insert hotplug devices after VMM launched. The parameter is
    `--hotplug-virnets '[{"iface_id":"eth0","host_dev_name":"tap0","num_queues":2,"queue_size":0,"allow_duplicate_mac":true}]'`

Both of these parameters receive an array of VirtioNetDeviceConfigInfo in the
format of JSON to make them more configurable.

Fixes: #15

Signed-off-by: Xuewei Niu <niuxuewei.nxw@antgroup.com>

Author: justxuewei

Cargo.lock

@@ -6,7 +6,13 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-dragonball = { git = "https://github.com/kata-containers/kata-containers", branch = "main", features=["virtio-blk", "virtio-vsock", "hotplug", "dbs-upcall" ] }
+dragonball = { git = "https://github.com/kata-containers/kata-containers", branch = "main", features = [
+    "virtio-blk",
+    "virtio-vsock",
+    "virtio-net",
+    "hotplug",
+    "dbs-upcall",
+] }
 clap = { version = "4.0.27", features = ["derive"] }
 serde = "1.0.27"
 serde_derive = "1.0.27"
@@ -26,4 +32,3 @@ slog-scope = "4.4.0"
 slog-stdlog = "4.1.1"
 serde_json = "1.0.89"
 crossbeam-channel = "0.5.6"
-

Cargo.toml

@@ -74,6 +74,21 @@ Create a virtio-vsock tunnel for Guest-to-Host communication.
   --vsock /tmp/vsock.sock create;
 ```
 
+Create virtio-net devices.
+
+> The type of the `--virnets` receives an array of VirtioNetDeviceConfigInfo in the
+> format of JSON.
+
+```
+./dbs-cli \
+  --log-file dbs-cli.log --log-level ERROR \
+  --kernel-path ~/path/to/kernel/vmlinux.bin \
+  --rootfs ~/path/to/rootfs/bionic.rootfs.ext4 \
+  --boot-args "console=ttyS0 tty0 reboot=k debug panic=1 pci=off root=/dev/vda1" \
+  --virnets "[{\"iface_id\":\"eth0\",\"host_dev_name\":\"tap0\",\"num_queues\":2,\"queue_size\":0,\"guest_mac\":\"43:2D:9C:13:71:48\",\"allow_duplicate_mac\":true}]" \
+  create;
+```
+
 # 2. Usage
 
 ## 1. Create API Server and Update VM
@@ -85,6 +100,19 @@ After api socket created, you could use `./dbs-cli --api-sock-path [socket path]
 Right now, we have only one command for cpu resizing, and here is the command example.
 
 `sudo ./dbs-cli  --api-sock-path [socket path] --vcpu-resize 2 update`
+
+Create hot-plug virtio-net devices via API Server.
+
+> The type of the `--hotplug-virnets` receives an array of
+> VirtioNetDeviceConfigInfo in the format of JSON.
+
+```
+sudo ./dbs-cli  \
+  --api-sock-path [socket path]
+  --hotplug-virnets "[{\"iface_id\":\"eth0\",\"host_dev_name\":\"tap0\",\"num_queues\":2,\"queue_size\":0,\"guest_mac\":\"43:2D:9C:13:71:48\",\"allow_duplicate_mac\":true}]" \
+  update
+```
+
 ## 2. Exit vm
 
 > If you want to exit vm, just input `reboot` in vm's console.

README.md

@@ -10,12 +10,14 @@ use serde_json::{json, Value};
 use crate::parser::DBSArgs;
 
 pub fn run_api_client(args: DBSArgs) -> Result<()> {
-    let request;
     if let Some(vcpu_resize_num) = args.update_args.vcpu_resize {
-        request = request_cpu_resize(vcpu_resize_num);
-        send_request(request, args.api_sock_path)?;
+        let request = request_cpu_resize(vcpu_resize_num);
+        send_request(request, &args.api_sock_path)?;
+    }
+    if let Some(config) = args.update_args.hotplug_virnets {
+        let request = request_virtio_net(&config);
+        send_request(request, &args.api_sock_path)?;
     }
-
     Ok(())
 }
 
@@ -26,7 +28,15 @@ fn request_cpu_resize(vcpu_resize_num: usize) -> Value {
     })
 }
 
-fn send_request(request: Value, api_sock_path: String) -> Result<()> {
+/// Insert virtio-net devices
+fn request_virtio_net(virtio_net_config: &str) -> Value {
+    json!({
+        "action": "insert_virnets",
+        "config": virtio_net_config,
+    })
+}
+
+fn send_request(request: Value, api_sock_path: &str) -> Result<()> {
     let mut unix_stream = UnixStream::connect(api_sock_path).context("Could not create stream")?;
 
     unix_stream

src/api_client.rs

@@ -8,7 +8,8 @@ use std::sync::{Arc, Mutex};
 use std::io::prelude::*;
 use std::os::unix::net::{UnixListener, UnixStream};
 
-use anyhow::{Context, Result};
+use anyhow::{anyhow, Context, Result};
+use dragonball::device_manager::virtio_net_dev_mgr::VirtioNetDeviceConfigInfo;
 
 use crate::vmm_comm_trait::VMMComm;
 use dragonball::api::v1::{VmmRequest, VmmResponse};
@@ -79,6 +80,18 @@ impl ApiServer {
                 };
                 return self.resize_vcpu(resize_vcpu_cfg);
             }
+            Some("insert_virnets") => {
+                let config_json = match v["config"].as_str() {
+                    Some(config_json) => config_json,
+                    None => return Err(anyhow!("The config of virtio-net device is required")),
+                };
+                let configs: Vec<VirtioNetDeviceConfigInfo> = serde_json::from_str(config_json)
+                    .context("Parse virtio-net device config from json")?;
+                for config in configs.iter() {
+                    self.insert_virnet(config.clone())
+                        .context("Insert a virtio-net device to the Dragonball")?;
+                }
+            }
             _ => {
                 println!("Unknown Actions");
             }

src/api_server.rs

@@ -20,6 +20,7 @@ use dragonball::{
         BlockDeviceConfigInfo, BootSourceConfig, InstanceInfo, VmmRequest, VmmResponse,
         VsockDeviceConfigInfo,
     },
+    device_manager::virtio_net_dev_mgr::VirtioNetDeviceConfigInfo,
     vm::{CpuTopology, VmConfigInfo},
 };
 
@@ -154,6 +155,16 @@ impl CliInstance {
                 .expect("failed to set vsock socket path");
         }
 
+        if !args.create_args.virnets.is_empty() {
+            let configs: Vec<VirtioNetDeviceConfigInfo> =
+                serde_json::from_str(&args.create_args.virnets)
+                    .expect("failed to parse virtio-net devices from JSON");
+            for config in configs.into_iter() {
+                self.insert_virnet(config)
+                    .expect("failed to insert a virtio-net device");
+            }
+        }
+
         // start micro-vm
         self.instance_start().expect("failed to start micro-vm");
 

src/cli_instance.rs

@@ -206,6 +206,17 @@ pub struct CreateArgs {
         display_order = 2
     )]
     pub vsock: String,
+
+    #[clap(
+        long,
+        value_parser,
+        default_value = "",
+        help = r#"Insert virtio-net devices into the Dragonball. 
+The type of it is an array of VirtioNetDeviceConfigInfo, e.g.
+    --virnets '[{"iface_id":"eth0","host_dev_name":"tap0","num_queues":2,"queue_size":0,"allow_duplicate_mac":true}]'"#,
+        display_order = 2
+    )]
+    pub virnets: String,
 }
 
 /// Config boot source including rootfs file path
@@ -255,4 +266,13 @@ pub struct UpdateArgs {
         display_order = 2
     )]
     pub vcpu_resize: Option<usize>,
+    #[clap(
+        long,
+        value_parser,
+        help = r#"Insert hotplug virtio-net devices into the Dragonball. 
+The type of it is an array of VirtioNetDeviceConfigInfo, e.g.
+    --hotplug-virnets '[{"iface_id":"eth0","host_dev_name":"tap0","num_queues":2,"queue_size":0,"allow_duplicate_mac":true}]'"#,
+        display_order = 2
+    )]
+    pub hotplug_virnets: Option<String>,
 }

src/parser/args.rs

@@ -9,6 +9,7 @@ use dragonball::{
         BlockDeviceConfigInfo, BootSourceConfig, VmmAction, VmmActionError, VmmData, VmmRequest,
         VmmResponse, VsockDeviceConfigInfo,
     },
+    device_manager::virtio_net_dev_mgr::VirtioNetDeviceConfigInfo,
     vcpu::VcpuResizeInfo,
     vm::VmConfigInfo,
 };
@@ -132,4 +133,10 @@ pub trait VMMComm {
         .with_context(|| format!("Failed to resize vcpu {resize_vcpu_cfg:?}"))?;
         Ok(())
     }
+
+    fn insert_virnet(&self, config: VirtioNetDeviceConfigInfo) -> Result<()> {
+        self.handle_request(Request::Sync(VmmAction::InsertNetworkDevice(config)))
+            .context("Request to insert a virtio-net device")?;
+        Ok(())
+    }
 }