feat(net): extend metadata with PortIndex

* remove unused deprecated types
* define new type PortIndex for the purpose of identifying ports
  generically in a driver-agnostic way. Drivers should be able to
  build and understand the PortIndex type, and map it to
  driver-specific types/entities. This type should be opaque and
  not be used, except by ingress/egress for translation purposes.
* Add iport/oport PortIndex in metatdata so that the translation
  from PortIndex - InterfaceIndex can be done at egress/ingress,
  based on the configuration. We refrain from making such a
  translation in drivers for the moment, because that would
  require drivers have access to a translation table that may
  change depending on the configuration.

This commit does not add any new functionality.

Signed-off-by: Fredi Raspall <[email protected]>

Author: Fredi-raspall

net/src/packet/display.rs

@@ -15,7 +15,6 @@ use crate::udp::{Udp, UdpEncap};
 use crate::buffer::PacketBufferMut;
 use crate::checksum::Checksum;
 #[allow(deprecated)]
-use crate::packet::InterfaceId;
 use crate::packet::{BridgeDomain, DoneReason, InvalidPacket, Packet, PacketMeta};
 use std::fmt::{Display, Formatter};
 
@@ -223,12 +222,6 @@ fn fmt_opt<T: Display>(
         }
     }
 }
-#[allow(deprecated)]
-impl Display for InterfaceId {
-    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
-        write!(f, "{}", self.get_id())
-    }
-}
 impl Display for BridgeDomain {
     fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
         write!(f, "{}", self.get_id())
@@ -237,15 +230,11 @@ impl Display for BridgeDomain {
 impl Display for PacketMeta {
     fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
         writeln!(f, "  metadata:")?;
-        match self.iif {
-            None => {
-                write!(f, "    iif: None")?;
-            }
-            Some(iif) => {
-                write!(f, "    iif: {iif}")?;
-            }
-        }
-        fmt_opt(f, " oif", self.oif, true)?;
+        write!(f, "   ")?;
+        fmt_opt(f, " iport", self.iport, false)?;
+        fmt_opt(f, " iif", self.iif, false)?;
+        fmt_opt(f, " oif", self.oif, false)?;
+        fmt_opt(f, " oport", self.oport, true)?;
 
         writeln!(f, "    bcast: {}", self.is_l2bcast())?;
         fmt_opt(f, "    src-vpcd", self.src_vpcd, false)?;

net/src/packet/meta.rs

@@ -17,18 +17,20 @@ use tracing::error;
 /// Every VRF is univocally identified with a numerical VRF id
 pub type VrfId = u32;
 
-#[deprecated = "use InterfaceIndex from net"]
-#[derive(Debug, Default, Copy, Clone)]
-pub struct InterfaceId(u32);
-#[allow(deprecated)]
-impl InterfaceId {
+/// A driver-agnostic, opaque identifier for a port. This type
+/// should only be read / written by drivers and ingress / egress stages.
+#[derive(Clone, Copy, Debug, PartialEq, Hash, Eq)]
+#[repr(transparent)]
+pub struct PortIndex(u16);
+impl PortIndex {
     #[must_use]
-    pub fn new(val: u32) -> Self {
-        Self(val)
+    pub const fn new(value: u16) -> Self {
+        Self(value)
     }
-    #[must_use]
-    pub fn get_id(&self) -> u32 {
-        self.0
+}
+impl Display for PortIndex {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}", self.0)
     }
 }
 
@@ -133,10 +135,12 @@ bitflags! {
 #[derive(Debug, Default, Clone)]
 pub struct PacketMeta {
     flags: MetaFlags,
-    pub iif: Option<InterfaceIndex>, /* incoming interface - set early */
-    pub oif: Option<InterfaceIndex>, /* outgoing interface - set late */
-    pub nh_addr: Option<IpAddr>,     /* IP address of next-hop */
-    pub vrf: Option<VrfId>,          /* for IP packet, the VRF to use to route it */
+    pub iport: Option<PortIndex>, /* ingress port index - set on rx by driver, read by ingress */
+    pub iif: Option<InterfaceIndex>, /* incoming interface: set by ingress stage */
+    pub oif: Option<InterfaceIndex>, /* outgoing interface - set by IO manager for outgoing traffic or forwarding functions */
+    pub oport: Option<PortIndex>, /* egress port index - set by egress stage, read by driver for xmit */
+    pub nh_addr: Option<IpAddr>,  /* IP address of next-hop */
+    pub vrf: Option<VrfId>,       /* for IP packet, the VRF to use to route it */
     pub bridge: Option<BridgeDomain>, /* the bridge domain to forward the packet to */
     pub done: Option<DoneReason>, /* if Some, the reason why a packet was marked as done, including delivery to NF */
     pub src_vpcd: Option<VpcDiscriminant>, /* the vpc discriminant of a received encapsulated packet */