From 1f516303793096fe9e972c6f64630f620e3ba25b Mon Sep 17 00:00:00 2001
From: Renato Westphal <renato@opensourcerouting.org>
Date: Sat, 4 Nov 2023 19:25:10 -0300
Subject: [PATCH] routing: introduce support for opaque route attributes

This change allows protocol crates to install routes with opaque
attributes in the RIB. These attributes can be useful both for
implementing advanced routing policies as well as aiding in
network troubleshooting.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
---
 README.md                                     |  2 +-
 holo-ospf/src/northbound/yang.rs              | 12 -------
 holo-ospf/src/route.rs                        | 13 ++------
 holo-ospf/src/southbound/tx.rs                |  4 +++
 holo-rip/src/southbound/tx.rs                 |  5 ++-
 holo-routing/src/ibus.rs                      |  1 +
 holo-routing/src/northbound/configuration.rs  |  5 ++-
 holo-routing/src/northbound/state.rs          | 30 ++++++++++++++++-
 holo-routing/src/rib.rs                       |  7 +++-
 holo-utils/src/southbound.rs                  | 32 +++++++++++++++++++
 .../deviations/ietf-ospf-holo-deviations.yang | 12 -------
 11 files changed, 84 insertions(+), 39 deletions(-)

diff --git a/README.md b/README.md
index 3b7653ff..ad3a7b74 100644
--- a/README.md
+++ b/README.md
@@ -200,7 +200,7 @@ Holo supports the following IETF RFCs and Internet drafts:
 | ietf-mpls-ldp@2022-03-14 | 86.96% | 92.31% | 100.00% | 100.00% | [92.38%](http://westphal.com.br/holo/ietf-mpls-ldp.html) |
 | ietf-mpls@2020-12-18 | 0.00% | 57.14% | - | - | [35.29%](http://westphal.com.br/holo/ietf-mpls.html) |
 | ietf-ospf-sr@2023-07-09 | 25.00% | 53.95% | - | - | [52.81%](http://westphal.com.br/holo/ietf-ospf-sr.html) |
-| ietf-ospf@2022-10-19 | 75.00% | 59.36% | 100.00% | 41.94% | [59.33%](http://westphal.com.br/holo/ietf-ospf.html) |
+| ietf-ospf@2022-10-19 | 75.00% | 59.64% | 100.00% | 41.94% | [59.57%](http://westphal.com.br/holo/ietf-ospf.html) |
 | ietf-ospfv3-extended-lsa@2023-08-21 | 50.00% | 85.28% | - | - | [84.85%](http://westphal.com.br/holo/ietf-ospfv3-extended-lsa.html) |
 | ietf-rip@2020-02-20 | 27.91% | 93.33% | 100.00% | - | [55.41%](http://westphal.com.br/holo/ietf-rip.html) |
 | ietf-routing-policy@2021-10-11 | 100.00% | 0.00% | - | - | [98.11%](http://westphal.com.br/holo/ietf-routing-policy.html) |
diff --git a/holo-ospf/src/northbound/yang.rs b/holo-ospf/src/northbound/yang.rs
index 02473eb1..eb228c6d 100644
--- a/holo-ospf/src/northbound/yang.rs
+++ b/holo-ospf/src/northbound/yang.rs
@@ -19,7 +19,6 @@ use crate::packet::tlv::{
     AdjSidFlags, GrReason, PrefixSidFlags, RouterInfoCaps,
 };
 use crate::packet::PacketType;
-use crate::route::PathType;
 use crate::spf::SpfLogType;
 use crate::{ospfv2, ospfv3, spf};
 
@@ -97,17 +96,6 @@ impl ToYang for SpfLogType {
     }
 }
 
-impl ToYang for PathType {
-    fn to_yang(&self) -> String {
-        match self {
-            PathType::IntraArea => "intra-area".to_owned(),
-            PathType::InterArea => "inter-area".to_owned(),
-            PathType::Type1External => "external-1".to_owned(),
-            PathType::Type2External => "external-2".to_owned(),
-        }
-    }
-}
-
 impl ToYang for InterfaceCfgError {
     fn to_yang(&self) -> String {
         match self {
diff --git a/holo-ospf/src/route.rs b/holo-ospf/src/route.rs
index 9a7576e6..fac6c702 100644
--- a/holo-ospf/src/route.rs
+++ b/holo-ospf/src/route.rs
@@ -12,6 +12,7 @@ use bitflags::bitflags;
 use derive_new::new;
 use holo_utils::ip::IpAddrKind;
 use holo_utils::mpls::Label;
+use holo_utils::southbound::OspfRouteType;
 use holo_utils::sr::IgpAlgoType;
 
 use crate::area::Area;
@@ -84,15 +85,6 @@ pub struct SummaryRtr<V: Version> {
     pub metric: u32,
 }
 
-// OSPF path types in decreasing order of preference.
-#[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
-pub enum PathType {
-    IntraArea,
-    InterArea,
-    Type1External,
-    Type2External,
-}
-
 // Route nexthop key.
 #[derive(Clone, Copy, Debug, Eq, new, Ord, PartialEq, PartialOrd)]
 pub struct NexthopKey<I: IpAddrKind> {
@@ -116,8 +108,9 @@ pub struct Nexthop<I: IpAddrKind> {
     pub sr_label: Option<Label>,
 }
 
-// Ordered list of nexthops.
+// Type aliases.
 pub type Nexthops<I: IpAddrKind> = BTreeMap<NexthopKey<I>, Nexthop<I>>;
+pub type PathType = OspfRouteType;
 
 // ===== impl RouteNet =====
 
diff --git a/holo-ospf/src/southbound/tx.rs b/holo-ospf/src/southbound/tx.rs
index 386b2ed0..f2e4d0dd 100644
--- a/holo-ospf/src/southbound/tx.rs
+++ b/holo-ospf/src/southbound/tx.rs
@@ -11,6 +11,7 @@ use holo_utils::ibus::{IbusMsg, IbusSender};
 use holo_utils::mpls::Label;
 use holo_utils::southbound::{
     LabelInstallMsg, LabelUninstallMsg, Nexthop, RouteKeyMsg, RouteMsg,
+    RouteOpaqueAttrs,
 };
 
 use crate::collections::Arena;
@@ -66,6 +67,9 @@ pub(crate) fn route_install<V>(
         distance: distance.into(),
         metric: route.metric(),
         tag: route.tag,
+        opaque_attrs: RouteOpaqueAttrs::Ospf {
+            route_type: route.path_type,
+        },
         nexthops: nexthops.clone(),
     };
     let msg = IbusMsg::RouteIpAdd(msg);
diff --git a/holo-rip/src/southbound/tx.rs b/holo-rip/src/southbound/tx.rs
index 4a0c1067..b00dc27a 100644
--- a/holo-rip/src/southbound/tx.rs
+++ b/holo-rip/src/southbound/tx.rs
@@ -5,7 +5,9 @@
 //
 
 use holo_utils::ibus::{IbusMsg, IbusSender};
-use holo_utils::southbound::{Nexthop, RouteKeyMsg, RouteMsg};
+use holo_utils::southbound::{
+    Nexthop, RouteKeyMsg, RouteMsg, RouteOpaqueAttrs,
+};
 
 use crate::route::{Route, RouteType};
 use crate::version::Version;
@@ -31,6 +33,7 @@ pub(crate) fn route_install<V>(
         distance: distance.into(),
         metric: route.metric.get() as u32,
         tag: Some(route.tag.into()),
+        opaque_attrs: RouteOpaqueAttrs::None,
         nexthops: [Nexthop::Address {
             ifindex: route.ifindex,
             addr: route.nexthop.unwrap().into(),
diff --git a/holo-routing/src/ibus.rs b/holo-routing/src/ibus.rs
index 540236fa..ee3655f2 100644
--- a/holo-routing/src/ibus.rs
+++ b/holo-routing/src/ibus.rs
@@ -96,6 +96,7 @@ pub(crate) fn notify_redistribute_add(
         distance: route.distance,
         metric: route.metric,
         tag: route.tag,
+        opaque_attrs: route.opaque_attrs.clone(),
         nexthops: route.nexthops.clone(),
     };
     let msg = IbusMsg::RouteRedistributeAdd(msg);
diff --git a/holo-routing/src/northbound/configuration.rs b/holo-routing/src/northbound/configuration.rs
index 74ee4be2..99f271be 100644
--- a/holo-routing/src/northbound/configuration.rs
+++ b/holo-routing/src/northbound/configuration.rs
@@ -22,7 +22,9 @@ use holo_utils::ibus::{IbusMsg, SrCfgEvent};
 use holo_utils::ip::{AddressFamily, IpNetworkKind};
 use holo_utils::mpls::LabelRange;
 use holo_utils::protocol::Protocol;
-use holo_utils::southbound::{Nexthop, NexthopSpecial, RouteKeyMsg, RouteMsg};
+use holo_utils::southbound::{
+    Nexthop, NexthopSpecial, RouteKeyMsg, RouteMsg, RouteOpaqueAttrs,
+};
 use holo_utils::sr::{IgpAlgoType, SidLastHopBehavior, SrCfgPrefixSid};
 use holo_utils::yang::DataNodeRefExt;
 use holo_yang::TryFromYang;
@@ -821,6 +823,7 @@ impl Provider for Master {
                     distance: 1,
                     metric: 0,
                     tag: None,
+                    opaque_attrs: RouteOpaqueAttrs::None,
                     nexthops,
                 };
 
diff --git a/holo-routing/src/northbound/state.rs b/holo-routing/src/northbound/state.rs
index 7a936e13..40ea8edb 100644
--- a/holo-routing/src/northbound/state.rs
+++ b/holo-routing/src/northbound/state.rs
@@ -17,7 +17,8 @@ use holo_northbound::state::{
 };
 use holo_northbound::{CallbackKey, NbDaemonSender};
 use holo_utils::mpls::Label;
-use holo_utils::southbound::Nexthop;
+use holo_utils::protocol::Protocol;
+use holo_utils::southbound::{Nexthop, RouteOpaqueAttrs};
 use holo_yang::ToYang;
 use ipnetwork::{Ipv4Network, Ipv6Network};
 
@@ -348,6 +349,33 @@ fn load_callbacks() -> Callbacks<Master> {
             // TODO: implement me!
             None
         })
+        .path(ribs::rib::routes::route::metric::PATH)
+        .get_element_u32(|_master, args| {
+            let (_, route) = args.list_entry.as_route().unwrap();
+            if matches!(route.protocol, Protocol::OSPFV2 | Protocol::OSPFV3) {
+                Some(route.metric)
+            } else {
+                None
+            }
+        })
+        .path(ribs::rib::routes::route::tag::PATH)
+        .get_element_u32(|_master, args| {
+            let (_, route) = args.list_entry.as_route().unwrap();
+            if matches!(route.protocol, Protocol::OSPFV2 | Protocol::OSPFV3) {
+                route.tag
+            } else {
+                None
+            }
+        })
+        .path(ribs::rib::routes::route::route_type::PATH)
+        .get_element_string(|_master, args| {
+            let (_, route) = args.list_entry.as_route().unwrap();
+            if let RouteOpaqueAttrs::Ospf { route_type } = &route.opaque_attrs {
+                Some(route_type.to_yang())
+            } else {
+                None
+            }
+        })
         .build()
 }
 
diff --git a/holo-routing/src/rib.rs b/holo-routing/src/rib.rs
index 0a6ad154..aeed4136 100644
--- a/holo-routing/src/rib.rs
+++ b/holo-routing/src/rib.rs
@@ -16,7 +16,7 @@ use holo_utils::mpls::Label;
 use holo_utils::protocol::Protocol;
 use holo_utils::southbound::{
     AddressFlags, AddressMsg, LabelInstallMsg, LabelUninstallMsg, Nexthop,
-    NexthopSpecial, RouteKeyMsg, RouteMsg,
+    NexthopSpecial, RouteKeyMsg, RouteMsg, RouteOpaqueAttrs,
 };
 use holo_utils::{UnboundedReceiver, UnboundedSender};
 use ipnetwork::{IpNetwork, Ipv4Network, Ipv6Network};
@@ -41,6 +41,7 @@ pub struct Route {
     pub distance: u32,
     pub metric: u32,
     pub tag: Option<u32>,
+    pub opaque_attrs: RouteOpaqueAttrs,
     pub nexthops: BTreeSet<Nexthop>,
     pub last_updated: DateTime<Utc>,
     pub flags: RouteFlags,
@@ -88,6 +89,7 @@ impl Rib {
                     distance,
                     0,
                     None,
+                    RouteOpaqueAttrs::None,
                     Default::default(),
                     Utc::now(),
                     RouteFlags::empty(),
@@ -139,6 +141,7 @@ impl Rib {
                     msg.distance,
                     msg.metric,
                     msg.tag,
+                    msg.opaque_attrs,
                     msg.nexthops,
                     Utc::now(),
                     RouteFlags::empty(),
@@ -151,6 +154,7 @@ impl Rib {
                 route.distance = msg.distance;
                 route.metric = msg.metric;
                 route.tag = msg.tag;
+                route.opaque_attrs = msg.opaque_attrs;
                 route.nexthops = msg.nexthops;
                 route.last_updated = Utc::now();
                 route.flags.remove(RouteFlags::REMOVED);
@@ -188,6 +192,7 @@ impl Rib {
                     0,
                     0,
                     None,
+                    RouteOpaqueAttrs::None,
                     msg.nexthops.clone(),
                     Utc::now(),
                     RouteFlags::empty(),
diff --git a/holo-utils/src/southbound.rs b/holo-utils/src/southbound.rs
index 6d2ae96b..9d0b3311 100644
--- a/holo-utils/src/southbound.rs
+++ b/holo-utils/src/southbound.rs
@@ -83,6 +83,7 @@ pub struct RouteMsg {
     pub distance: u32,
     pub metric: u32,
     pub tag: Option<u32>,
+    pub opaque_attrs: RouteOpaqueAttrs,
     pub nexthops: BTreeSet<Nexthop>,
 }
 
@@ -112,6 +113,24 @@ pub struct LabelUninstallMsg {
     pub route: Option<(Protocol, IpNetwork)>,
 }
 
+// Route opaque attributes.
+#[derive(Clone, Debug)]
+#[derive(Deserialize, Serialize)]
+pub enum RouteOpaqueAttrs {
+    None,
+    Ospf { route_type: OspfRouteType },
+}
+
+// OSPF route types in decreasing order of preference.
+#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
+#[derive(Deserialize, Serialize)]
+pub enum OspfRouteType {
+    IntraArea,
+    InterArea,
+    Type1External,
+    Type2External,
+}
+
 // ===== impl Nexthop =====
 
 impl Nexthop {
@@ -192,3 +211,16 @@ impl TryFromYang for NexthopSpecial {
         }
     }
 }
+
+// ===== impl OspfRouteType =====
+
+impl ToYang for OspfRouteType {
+    fn to_yang(&self) -> String {
+        match self {
+            OspfRouteType::IntraArea => "intra-area".to_owned(),
+            OspfRouteType::InterArea => "inter-area".to_owned(),
+            OspfRouteType::Type1External => "external-1".to_owned(),
+            OspfRouteType::Type2External => "external-2".to_owned(),
+        }
+    }
+}
diff --git a/holo-yang/modules/deviations/ietf-ospf-holo-deviations.yang b/holo-yang/modules/deviations/ietf-ospf-holo-deviations.yang
index 6260e7c5..a581181e 100644
--- a/holo-yang/modules/deviations/ietf-ospf-holo-deviations.yang
+++ b/holo-yang/modules/deviations/ietf-ospf-holo-deviations.yang
@@ -3271,16 +3271,4 @@ module ietf-ospf-holo-deviations {
     deviate not-supported;
   }
   */
-
-  deviation "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route/ospf:metric" {
-    deviate not-supported;
-  }
-
-  deviation "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route/ospf:tag" {
-    deviate not-supported;
-  }
-
-  deviation "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route/ospf:route-type" {
-    deviate not-supported;
-  }
 }