usbvfiod 0.1.0

A vfio-user server for USB pass-through.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

//! Implements the CLI interface.
//!
//! The main external constraint here is that we need to be compatible
//! to the vfio-user [Backend Program
//! Conventions](https://www.qemu.org/docs/master/interop/vfio-user.html#backend-program-conventions).
use std::{
    os::fd::RawFd,
    path::{Path, PathBuf},
};

use clap::Parser;

#[derive(Parser, Debug)]
#[command(
    name = env!("CARGO_PKG_NAME"),
    version = env!("CARGO_PKG_VERSION"),
    author = env!("CARGO_PKG_AUTHORS"),
    about = env!("CARGO_PKG_DESCRIPTION"),
    long_about = None
)]
pub struct Cli {
    /// Enable verbose logging. Can be specified multiple times to
    /// increase verbosity.
    #[arg(short, long, action = clap::ArgAction::Count)]
    pub verbose: u8,

    /// Provide the vfio-user socket as file descriptor.
    ///
    /// This option is mutually exclusive with --socket-path.
    #[arg(long, conflicts_with = "socket_path")]
    fd: Option<RawFd>,

    /// The path where to create a listening Unix domain socket.
    ///
    /// This is the path where Cloud Hypervisor will connect to
    /// usbvfiod. This option is mutually exclusive with --fd.
    #[arg(long, required_unless_present = "fd")]
    socket_path: Option<PathBuf>,

    /// Path to a USB device to be attached from VM boot. Can be
    /// specified multiple times to attach more devices. The path must
    /// point to a device in: /dev/bus/usb
    ///
    /// See the documentation for how to identify devices.
    #[arg(long = "device", value_name = "PATH")]
    pub devices: Vec<PathBuf>,

    /// The path where to create a listening Unix domain socket and listen
    /// for hotplug commands.
    #[arg(long, value_name = "PATH")]
    pub hotplug_socket_path: Option<PathBuf>,
}

/// The location of the server socket for the vfio-user client connection.
#[derive(Debug)]
pub enum ServerSocket<'a> {
    /// The socket is already open.
    #[allow(dead_code)]
    Fd(RawFd),

    /// We need to create the socket at this path.
    Path(&'a Path),
}

impl Cli {
    pub fn server_socket(&self) -> ServerSocket<'_> {
        self.socket_path.as_ref().map_or_else(
            || unreachable!(),
            |socket_path| ServerSocket::Path(socket_path),
        )
    }
}