hidpipe: merge hidpipe project into muvm

Merge hidpipe project into muvm, with hidpipe-server operating as a
thread inside the main muvm binary, and hidpipe-client getting renamed
to muvm-hidpipe (and it's still autostarted by muvm-guest).

This simplifies the lifecycle management for hidpipe, ensuring it's tied
to the microVM lifetime.

Co-developed-by: Sasha Finkelstein <[email protected]>
Signed-off-by: Sergio Lopez <[email protected]>

Author: slp

.github/workflows/code_quality.yml

@@ -29,7 +29,7 @@ jobs:
             components: rustfmt, clippy
 
       - name: Install packages
-        run: sudo apt-get update && sudo apt-get -y install libclang-dev
+        run: sudo apt-get update && sudo apt-get -y install libclang-dev libudev-dev
 
       - name: Download libkrun.h
         run: sudo curl -o /usr/include/libkrun.h https://raw.githubusercontent.com/containers/libkrun/refs/heads/main/include/libkrun.h

Cargo.lock

@@ -13,6 +13,8 @@ anyhow = { version = "1.0.82", default-features = false, features = ["std"] }
 bpaf = { version = "0.9.11", default-features = false, features = [] }
 byteorder = { version = "1.5.0", default-features = false, features = ["std"] }
 env_logger = { version = "0.11.3", default-features = false, features = ["auto-color", "humantime", "unstable-kv"] }
+input-linux = { version = "0.7.0", default-features = false, features = [] }
+input-linux-sys = { version = "0.9.0", default-features = false, features = [] }
 krun-sys = { path = "../krun-sys", version = "1.9.1", default-features = false, features = [] }
 log = { version = "0.4.21", default-features = false, features = ["kv"] }
 nix = { version = "0.29.0", default-features = false, features = ["user"] }
@@ -23,6 +25,7 @@ serde_json = { version = "1.0.117", default-features = false, features = ["std"]
 tempfile = { version = "3.10.1", default-features = false, features = [] }
 tokio = { version = "1.38.0", default-features = false, features = ["io-util", "macros", "net", "process", "rt-multi-thread", "sync"] }
 tokio-stream = { version = "0.1.15", default-features = false, features = ["net", "sync"] }
+udev = { version = "0.9.0", default-features = false, features = [] }
 uuid = { version = "1.10.0", default-features = false, features = ["serde", "std", "v7"] }
 
 [features]
@@ -37,6 +40,10 @@ path = "src/bin/muvm.rs"
 name = "muvm-guest"
 path = "src/guest/bin/muvm-guest.rs"
 
+[[bin]]
+name = "muvm-hidpipe"
+path = "src/hidpipe/bin/muvm-hidpipe.rs"
+
 [[bin]]
 name = "muvm-server"
 path = "src/server/bin/muvm-server.rs"

crates/muvm/Cargo.toml

@@ -15,6 +15,7 @@ use log::debug;
 use muvm::cli_options::options;
 use muvm::cpu::{get_fallback_cores, get_performance_cores};
 use muvm::env::{find_muvm_exec, prepare_env_vars};
+use muvm::hidpipe_server::spawn_hidpipe_server;
 use muvm::launch::{launch_or_lock, LaunchResult};
 use muvm::monitor::spawn_monitor;
 use muvm::net::{connect_to_passt, start_passt};
@@ -297,19 +298,19 @@ fn main() -> Result<()> {
             }
         }
         let hidpipe_path = Path::new(&run_path).join("hidpipe");
-        if hidpipe_path.exists() {
-            let hidpipe_path = CString::new(
-                hidpipe_path
-                    .to_str()
-                    .expect("hidpipe_path should not contain invalid UTF-8"),
-            )
-            .context("Failed to process `hidpipe` path as it contains NUL character")?;
-            // SAFETY: `hidpipe_path` is a pointer to a `CString` with long enough lifetime.
-            let err = unsafe { krun_add_vsock_port(ctx_id, 3334, hidpipe_path.as_ptr()) };
-            if err < 0 {
-                let err = Errno::from_raw_os_error(-err);
-                return Err(err).context("Failed to configure vsock for hidpipe socket");
-            }
+        spawn_hidpipe_server(hidpipe_path.clone()).context("Failed to spawn hidpipe thread")?;
+        let hidpipe_path = CString::new(
+            hidpipe_path
+                .to_str()
+                .expect("hidpipe_path should not contain invalid UTF-8"),
+        )
+        .context("Failed to process `hidpipe` path as it contains NUL character")?;
+
+        // SAFETY: `hidpipe_path` is a pointer to a `CString` with long enough lifetime.
+        let err = unsafe { krun_add_vsock_port(ctx_id, 3334, hidpipe_path.as_ptr()) };
+        if err < 0 {
+            let err = Errno::from_raw_os_error(-err);
+            return Err(err).context("Failed to configure vsock for hidpipe socket");
         }
     }
 

crates/muvm/src/bin/muvm.rs

@@ -14,7 +14,6 @@ use muvm::guest::sommelier::exec_sommelier;
 use muvm::guest::user::setup_user;
 #[cfg(feature = "x11bridge")]
 use muvm::guest::x11::setup_x11_forwarding;
-use muvm::utils::env::find_in_path;
 use rustix::process::{getrlimit, setrlimit, Resource};
 
 fn main() -> Result<()> {
@@ -57,11 +56,10 @@ fn main() -> Result<()> {
 
     configure_network()?;
 
-    if let Some(hidpipe_client_path) = find_in_path("hidpipe-client")? {
-        Command::new(hidpipe_client_path)
-            .arg(format!("{}", options.uid))
-            .spawn()?;
-    }
+    Command::new("muvm-hidpipe")
+        .arg(format!("{}", options.uid))
+        .spawn()
+        .context("Failed to execute `muvm-hidpipe` as child process")?;
 
     // Before switching to the user, start another instance of muvm-server to serve
     // launch requests as root.