arcbox-vm 0.4.10

Guest-side Firecracker sandbox manager (frozen; see arcbox-vmm for host VMM).
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! Boot protocol types shared between the host-side sandbox orchestrator
//! and the guest-side `vmm-guest-agent`.
//!
//! These types define the contract passed through kernel boot parameters.
//! Both sides import from this module so the encoding is defined once.

use std::fmt;
use std::net::Ipv4Addr;
use std::str::FromStr;

/// Parsed representation of the Linux kernel `ip=` boot parameter.
///
/// Format: `ip=<client>::<gateway>:<netmask>::eth0:off`
///
/// Constructed by [`SandboxManager`](crate::SandboxManager) when building
/// boot args, and parsed by `vmm-guest-agent` to derive the DNS nameserver
/// from the gateway.
///
/// [`Display`] and [`FromStr`] round-trip through the same format so the
/// encoding is defined exactly once.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct KernelIpParam {
    /// Guest IP address (the `<client>` field).
    pub client: Ipv4Addr,
    /// Gateway IP (also serves as the guest DNS nameserver).
    pub gateway: Ipv4Addr,
    /// Subnet mask derived from the network prefix length.
    pub netmask: Ipv4Addr,
}

impl fmt::Display for KernelIpParam {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "ip={}::{}:{}::eth0:off",
            self.client, self.gateway, self.netmask,
        )
    }
}

impl FromStr for KernelIpParam {
    type Err = String;

    /// Parse a kernel `ip=` token (e.g. `ip=172.20.0.2::172.20.0.1:255.255.0.0::eth0:off`).
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let value = s.strip_prefix("ip=").ok_or("missing ip= prefix")?;
        let mut fields = value.split(':');

        let client = fields
            .next()
            .filter(|s| !s.is_empty())
            .ok_or("missing client field")?
            .parse::<Ipv4Addr>()
            .map_err(|e| format!("invalid client IP: {e}"))?;

        // Skip <server> (always empty in our usage).
        fields.next();

        let gateway = fields
            .next()
            .filter(|s| !s.is_empty())
            .ok_or("missing gateway field")?
            .parse::<Ipv4Addr>()
            .map_err(|e| format!("invalid gateway IP: {e}"))?;

        let netmask = fields
            .next()
            .filter(|s| !s.is_empty())
            .ok_or("missing netmask field")?
            .parse::<Ipv4Addr>()
            .map_err(|e| format!("invalid netmask: {e}"))?;

        Ok(Self {
            client,
            gateway,
            netmask,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn roundtrip() {
        let param = KernelIpParam {
            client: Ipv4Addr::new(172, 20, 0, 2),
            gateway: Ipv4Addr::new(172, 20, 0, 1),
            netmask: Ipv4Addr::new(255, 255, 0, 0),
        };
        let s = param.to_string();
        assert_eq!(s, "ip=172.20.0.2::172.20.0.1:255.255.0.0::eth0:off");
        assert_eq!(s.parse::<KernelIpParam>().unwrap(), param);
    }

    #[test]
    fn rejects_invalid() {
        assert!("no-prefix".parse::<KernelIpParam>().is_err());
        assert!("ip=".parse::<KernelIpParam>().is_err());
        assert!(
            "ip=bogus::1.2.3.4:255.0.0.0::eth0:off"
                .parse::<KernelIpParam>()
                .is_err()
        );
    }
}