Self-review

Author: FelixMcFelix

lib/opte/src/engine/port/meta.rs

@@ -100,7 +100,7 @@ impl ActionMeta {
         self.inner.get(key).map(|v| &**v)
     }
 
-    /// Get a reference to the value at a well known key key, or `None`
+    /// Get a reference to the value at a well known key for `T`, or `None`
     /// if no such entry exists.
     pub fn get_typed<T: ActionMetaValue>(
         &self,

lib/oxide-vpc/src/api.rs

@@ -141,7 +141,7 @@ pub struct AttachedSubnetConfig {
     pub is_external: bool,
 }
 
-/// Configuration for an exceptions to source/destination address filtering.
+/// Configuration for an exception to source/destination address filtering.
 #[derive(Debug, Clone, Serialize, Deserialize, Default)]
 pub struct TransitIpConfig {
     /// Allow inbound traffic with a destination IP in the target CIDR.
@@ -299,7 +299,7 @@ pub struct VpcCfg {
     /// sourced to a single IPv6 address.
     pub phys_ip: Ipv6Addr,
 
-    /// Configuration for DHCP responses created by OPTE
+    /// Configuration for DHCP responses created by OPTE.
     pub dhcp: DhcpCfg,
 }
 

lib/oxide-vpc/src/cfg.rs

@@ -108,7 +108,7 @@ pub struct VpcCfg {
     /// sourced to a single IPv6 address.
     pub phys_ip: Ipv6Addr,
 
-    /// Configuration for DHCP responses created by OPTE
+    /// Configuration for DHCP responses created by OPTE.
     pub dhcp: DhcpCfg,
 }
 

lib/oxide-vpc/src/engine/gateway/arp.rs

@@ -16,7 +16,7 @@ use opte::engine::predicate::Predicate;
 use opte::engine::rule::Action;
 use opte::engine::rule::Rule;
 
-pub(crate) fn setup(ctx: &mut BuildCtx) -> Result<(), OpteError> {
+pub(super) fn setup(ctx: &mut BuildCtx) -> Result<(), OpteError> {
     // ================================================================
     // Outbound ARP Request for Gateway, from Guest
     //

lib/oxide-vpc/src/engine/gateway/dhcp.rs

@@ -19,7 +19,7 @@ use opte::engine::ip::v4::Ipv4Cidr;
 use opte::engine::rule::Action;
 use opte::engine::rule::Rule;
 
-pub(crate) fn setup(
+pub(super) fn setup(
     ctx: &mut BuildCtx,
     ip_cfg: &Ipv4Cfg,
 ) -> Result<(), OpteError> {

lib/oxide-vpc/src/engine/gateway/dhcpv6.rs

@@ -15,7 +15,7 @@ use opte::engine::dhcpv6::LeasedAddress;
 use opte::engine::rule::Action;
 use opte::engine::rule::Rule;
 
-pub(crate) fn setup(ctx: &mut BuildCtx) -> Result<(), OpteError> {
+pub(super) fn setup(ctx: &mut BuildCtx) -> Result<(), OpteError> {
     let ip_cfg = match ctx.cfg.ipv6_cfg() {
         None => return Ok(()),
         Some(ip_cfg) => ip_cfg,

lib/oxide-vpc/src/engine/gateway/icmp.rs

@@ -14,7 +14,7 @@ use opte::engine::icmp::v4::IcmpEchoReply;
 use opte::engine::rule::Action;
 use opte::engine::rule::Rule;
 
-pub(crate) fn setup(
+pub(super) fn setup(
     ctx: &mut BuildCtx,
     ip_cfg: &Ipv4Cfg,
 ) -> Result<(), OpteError> {

lib/oxide-vpc/src/engine/gateway/icmpv6.rs

@@ -32,7 +32,7 @@ use smoltcp::wire::Icmpv6Message;
 // - Respond to NDP Neighbor Solicitations from the guest to the gateway. This
 // includes solicitations unicast to the gateway, and also delivered to the
 // solicited-node multicast group.
-pub(crate) fn setup(
+pub(super) fn setup(
     ctx: &mut BuildCtx,
     ip_cfg: &Ipv6Cfg,
 ) -> Result<(), OpteError> {

lib/oxide-vpc/src/engine/gateway/mod.rs

@@ -112,7 +112,7 @@ use super::VpcNetwork;
 
 pub const NAME: &str = "gateway";
 
-pub(crate) struct BuildCtx<'a> {
+struct BuildCtx<'a> {
     in_rules: Vec<Rule<Finalized>>,
     out_rules: Vec<Rule<Finalized>>,
     cfg: &'a VpcCfg,
@@ -397,7 +397,7 @@ fn setup_ipv6(ctx: &mut BuildCtx, ip_cfg: &Ipv6Cfg) -> Result<(), OpteError> {
 ///
 /// This allows the outbound side of firewall layer to filter based on
 /// VPC.
-pub(crate) struct VpcMeta {
+struct VpcMeta {
     vpc_mappings: Arc<VpcMappings>,
 }
 

lib/oxide-vpc/src/engine/gateway/transit.rs

@@ -18,7 +18,7 @@ use opte::api::NoResp;
 use opte::engine::port::Port;
 use opte::engine::rule::Finalized;
 
-pub(crate) fn make_holepunch_rule(
+pub(super) fn make_holepunch_rule(
     guest_mac: MacAddr,
     gateway_mac: MacAddr,
     dest: IpCidr,
@@ -50,8 +50,7 @@ pub(crate) fn make_holepunch_rule(
             cidr_in.finalize()
         }
         Direction::Out => {
-            let vpc_meta = vpc_meta.clone();
-            let mut cidr_out = Rule::new(1000, Action::Meta(vpc_meta));
+            let mut cidr_out = Rule::new(1000, Action::Meta(vpc_meta.clone()));
             cidr_out.add_predicate(Predicate::InnerEtherSrc(vec![
                 EtherAddrMatch::Exact(guest_mac),
             ]));