[sled-hardware-types] Move I/O logic out of types crate (#10028)

sled-hardware-types depended on illumos-utils and omicron-common because
`BootstrapInterface::ip()` performed I/O via `Dladm::get_mac()`. We
don't really want those dependencies here, particularly for downstream
crates that only need the type definitions (e.g. ddm-admin-client,
wicketd).

Extract `BoostrapInterface::ip()` as a free function `bootstrap_ip()` in
sled-hardware::underlay, which already depends on illumos-utils and
omicron-common. `BootstrapInterface`, `BOOTSTRAP_PREFIX` and
`BOOTSTRAP_MASK` remain in sled-hardware-types.

Author: mergeconflict

Cargo.lock

@@ -19,7 +19,7 @@ use omicron_common::backoff::retry_notify;
 use omicron_common::backoff::retry_policy_internal_service_aggressive;
 use omicron_ddm_admin_client::Client as DdmAdminClient;
 use sled_hardware::underlay;
-use sled_hardware_types::underlay::BootstrapInterface;
+use sled_hardware::underlay::BootstrapInterface;
 use slog::Logger;
 use slog::info;
 use slog_error_chain::InlineErrorChain;
@@ -70,9 +70,11 @@ pub(crate) async fn bootstrap_sled(
             .context("failed to ensure bootstrap etherstub vnic existence")?;
 
     // Use the mac address of the first link to derive our bootstrap address.
-    let ip = BootstrapInterface::GlobalZone.ip(&links[0]).await.with_context(
-        || format!("failed to derive a bootstrap prefix from {:?}", links[0]),
-    )?;
+    let ip = underlay::bootstrap_ip(BootstrapInterface::GlobalZone, &links[0])
+        .await
+        .with_context(|| {
+            format!("failed to derive a bootstrap prefix from {:?}", links[0])
+        })?;
 
     Zones::ensure_has_global_zone_v6_address(
         bootstrap_etherstub_vnic,

installinator/src/bootstrap.rs

@@ -39,7 +39,7 @@ use sled_agent_config_reconciler::ConfigReconcilerSpawnToken;
 use sled_hardware::DendriteAsic;
 use sled_hardware::SledMode;
 use sled_hardware::underlay;
-use sled_hardware_types::underlay::BootstrapInterface;
+use sled_hardware::underlay::BootstrapInterface;
 use slog::Drain;
 use slog::Logger;
 use std::net::IpAddr;
@@ -348,10 +348,12 @@ impl BootstrapNetworking {
     async fn setup(config: &Config) -> Result<Self, StartError> {
         let link_for_mac =
             config.get_link().await.map_err(StartError::ConfigLink)?;
-        let global_zone_bootstrap_ip = BootstrapInterface::GlobalZone
-            .ip(&link_for_mac)
-            .await
-            .map_err(StartError::BootstrapLinkMac)?;
+        let global_zone_bootstrap_ip = underlay::bootstrap_ip(
+            BootstrapInterface::GlobalZone,
+            &link_for_mac,
+        )
+        .await
+        .map_err(StartError::BootstrapLinkMac)?;
 
         let bootstrap_etherstub =
             Dladm::ensure_etherstub(dladm::BOOTSTRAP_ETHERSTUB_NAME)
@@ -388,10 +390,12 @@ impl BootstrapNetworking {
                 IpAddr::V6(addr) => addr,
             };
 
-        let switch_zone_bootstrap_ip = BootstrapInterface::SwitchZone
-            .ip(&link_for_mac)
-            .await
-            .map_err(StartError::BootstrapLinkMac)?;
+        let switch_zone_bootstrap_ip = underlay::bootstrap_ip(
+            BootstrapInterface::SwitchZone,
+            &link_for_mac,
+        )
+        .await
+        .map_err(StartError::BootstrapLinkMac)?;
 
         let underlay_etherstub =
             Dladm::ensure_etherstub(dladm::UNDERLAY_ETHERSTUB_NAME)

sled-agent/src/bootstrap/pre_server.rs

@@ -2,18 +2,30 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-//! Finding the underlay network physical links and address objects.
+//! Finding the underlay network physical links and address objects,
+//! and deriving bootstrap IP addresses.
+
+use std::net::Ipv6Addr;
 
 use crate::is_oxide_sled;
 use illumos_utils::addrobj;
 use illumos_utils::addrobj::AddrObject;
+use illumos_utils::dladm;
 use illumos_utils::dladm::CHELSIO_LINK_PREFIX;
 use illumos_utils::dladm::Dladm;
 use illumos_utils::dladm::FindPhysicalLinkError;
 use illumos_utils::dladm::GetLinkpropError;
 use illumos_utils::dladm::PhysicalLink;
 use illumos_utils::dladm::SetLinkpropError;
 use illumos_utils::zone::Zones;
+use omicron_common::api::external::MacAddr;
+
+#[doc(inline)]
+pub use sled_hardware_types::underlay::BOOTSTRAP_MASK;
+#[doc(inline)]
+pub use sled_hardware_types::underlay::BOOTSTRAP_PREFIX;
+#[doc(inline)]
+pub use sled_hardware_types::underlay::BootstrapInterface;
 
 #[derive(thiserror::Error, Debug)]
 pub enum Error {
@@ -99,3 +111,47 @@ pub async fn ensure_links_have_global_zone_link_local_v6_addresses(
 
     Ok(addr_objs)
 }
+
+// TODO(https://github.com/oxidecomputer/omicron/issues/945): This address
+// could be randomly generated when it no longer needs to be durable.
+/// Derive the bootstrap IP address for the given interface by reading
+/// the MAC address of the given physical link.
+pub async fn bootstrap_ip(
+    interface: BootstrapInterface,
+    link: &PhysicalLink,
+) -> Result<Ipv6Addr, dladm::GetMacError> {
+    let mac = Dladm::get_mac(link).await?;
+    Ok(mac_to_bootstrap_ip(mac, interface.interface_id()))
+}
+
+fn mac_to_bootstrap_ip(mac: MacAddr, interface_id: u64) -> Ipv6Addr {
+    let mac_bytes = mac.into_array();
+    assert_eq!(6, mac_bytes.len());
+
+    Ipv6Addr::new(
+        BOOTSTRAP_PREFIX,
+        (u16::from(mac_bytes[0]) << 8) | u16::from(mac_bytes[1]),
+        (u16::from(mac_bytes[2]) << 8) | u16::from(mac_bytes[3]),
+        (u16::from(mac_bytes[4]) << 8) | u16::from(mac_bytes[5]),
+        ((interface_id >> 48) & 0xffff).try_into().unwrap(),
+        ((interface_id >> 32) & 0xffff).try_into().unwrap(),
+        ((interface_id >> 16) & 0xffff).try_into().unwrap(),
+        (interface_id & 0xffff).try_into().unwrap(),
+    )
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use macaddr::MacAddr6;
+
+    #[test]
+    fn test_mac_to_bootstrap_ip() {
+        let mac = MacAddr("a8:40:25:10:00:01".parse::<MacAddr6>().unwrap());
+
+        assert_eq!(
+            mac_to_bootstrap_ip(mac, 1),
+            "fdb0:a840:2510:1::1".parse::<Ipv6Addr>().unwrap(),
+        );
+    }
+}

sled-hardware/src/underlay.rs

@@ -9,8 +9,6 @@ workspace = true
 
 [dependencies]
 daft.workspace = true
-illumos-utils.workspace = true
-omicron-common.workspace = true
 schemars.workspace = true
 serde.workspace = true
 slog.workspace = true
@@ -20,7 +18,6 @@ test-strategy = { workspace = true, optional = true }
 proptest = { workspace = true, optional = true }
 
 [dev-dependencies]
-macaddr.workspace = true
 proptest.workspace = true
 test-strategy.workspace = true
 

sled-hardware/types/Cargo.toml

@@ -2,12 +2,6 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-use illumos_utils::dladm;
-use illumos_utils::dladm::Dladm;
-use illumos_utils::dladm::PhysicalLink;
-use omicron_common::api::external::MacAddr;
-use std::net::Ipv6Addr;
-
 /// Initial octet of IPv6 for bootstrap addresses.
 pub const BOOTSTRAP_PREFIX: u16 = 0xfdb0;
 
@@ -27,46 +21,4 @@ impl BootstrapInterface {
             BootstrapInterface::SwitchZone => 2,
         }
     }
-
-    // TODO(https://github.com/oxidecomputer/omicron/issues/945): This address
-    // could be randomly generated when it no longer needs to be durable.
-    pub async fn ip(
-        self,
-        link: &PhysicalLink,
-    ) -> Result<Ipv6Addr, dladm::GetMacError> {
-        let mac = Dladm::get_mac(link).await?;
-        Ok(mac_to_bootstrap_ip(mac, self.interface_id()))
-    }
-}
-
-fn mac_to_bootstrap_ip(mac: MacAddr, interface_id: u64) -> Ipv6Addr {
-    let mac_bytes = mac.into_array();
-    assert_eq!(6, mac_bytes.len());
-
-    Ipv6Addr::new(
-        BOOTSTRAP_PREFIX,
-        (u16::from(mac_bytes[0]) << 8) | u16::from(mac_bytes[1]),
-        (u16::from(mac_bytes[2]) << 8) | u16::from(mac_bytes[3]),
-        (u16::from(mac_bytes[4]) << 8) | u16::from(mac_bytes[5]),
-        ((interface_id >> 48) & 0xffff).try_into().unwrap(),
-        ((interface_id >> 32) & 0xffff).try_into().unwrap(),
-        ((interface_id >> 16) & 0xffff).try_into().unwrap(),
-        (interface_id & 0xfff).try_into().unwrap(),
-    )
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use macaddr::MacAddr6;
-
-    #[test]
-    fn test_mac_to_bootstrap_ip() {
-        let mac = MacAddr("a8:40:25:10:00:01".parse::<MacAddr6>().unwrap());
-
-        assert_eq!(
-            mac_to_bootstrap_ip(mac, 1),
-            "fdb0:a840:2510:1::1".parse::<Ipv6Addr>().unwrap(),
-        );
-    }
 }