ibus: add derive_more crate

Add derive_more crate. Simplifies the calling of the IbusMsg messages. Signed-off-by: Paul Wekesa <[email protected]>
holo-routing · Nov 7, 2024 · 625e839 · 625e839
1 parent db0417c
commit 625e839
Show file tree

Hide file tree

Showing 22 changed files with 166 additions and 191 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -40,6 +40,7 @@ chrono = { version = "0.4", features = ["serde"] }
 convert_case = "0.6"
 criterion = "0.4"
 crossbeam-channel = "0.5"
+derive_more = { version="1.0.0", features = ["from"] }
 derive-new = "0.5"
 enum-as-inner = "0.6"
 fletcher = "1.0"

diff --git a/holo-bfd/src/master.rs b/holo-bfd/src/master.rs
@@ -144,7 +144,7 @@ impl ProtocolInstance for Master {
 
     async fn init(&mut self) {
         // Request information about all interfaces.
-        let _ = self.tx.ibus.send(IbusMsg::Interface(InterfaceMsg::Dump));
+        let _ = self.tx.ibus.send(InterfaceMsg::Dump.into());
     }
 
     async fn process_ibus_msg(&mut self, msg: IbusMsg) {

diff --git a/holo-bfd/src/session.rs b/holo-bfd/src/session.rs
@@ -15,7 +15,7 @@ use generational_arena::{Arena, Index};
 use holo_northbound::yang::control_plane_protocol::bfd;
 use holo_protocol::InstanceChannelsTx;
 use holo_utils::bfd::{ClientCfg, ClientId, SessionKey, State};
-use holo_utils::ibus::{BfdSessionMsg, IbusMsg};
+use holo_utils::ibus::BfdSessionMsg;
 use holo_utils::ip::{IpAddrExt, IpAddrKind};
 use holo_utils::socket::{UdpSocket, TTL_MAX};
 use holo_utils::task::{IntervalTask, TimeoutTask};
@@ -141,11 +141,11 @@ impl Session {
 
         // Notify protocol clients about the state transition if necessary.
         if self.should_notify_clients(old_state) && !self.clients.is_empty() {
-            let msg = IbusMsg::BfdSession(BfdSessionMsg::Update {
+            let msg = BfdSessionMsg::Update {
                 sess_key: self.key.clone(),
                 state,
-            });
-            let _ = tx.ibus.send(msg);
+            };
+            let _ = tx.ibus.send(msg.into());
         }
 
         // Send YANG notification.

diff --git a/holo-bgp/src/northbound/configuration.rs b/holo-bgp/src/northbound/configuration.rs
@@ -18,7 +18,7 @@ use holo_northbound::configuration::{
 };
 use holo_northbound::yang::control_plane_protocol::bgp;
 use holo_utils::bgp::AfiSafi;
-use holo_utils::ibus::{IbusMsg, RouteRedistributeMsg};
+use holo_utils::ibus::RouteRedistributeMsg;
 use holo_utils::ip::{AddressFamily, IpAddrKind};
 use holo_utils::policy::{ApplyPolicyCfg, DefaultPolicyType};
 use holo_utils::protocol::Protocol;
@@ -1363,12 +1363,13 @@ impl Provider for Instance {
                 }
             }
             Event::RedistributeRequest(protocol, af) => {
-                let _ = self.tx.ibus.send(IbusMsg::RouteRedistribute(
+                let _ = self.tx.ibus.send(
                     RouteRedistributeMsg::Dump {
                         protocol,
                         af: Some(af),
-                    },
-                ));
+                    }
+                    .into(),
+                );
             }
             Event::RedistributeDelete(protocol, afi_safi) => {
                 let Some((mut instance, _)) = self.as_up() else {

diff --git a/holo-bgp/src/southbound/tx.rs b/holo-bgp/src/southbound/tx.rs
@@ -7,9 +7,7 @@
 use std::collections::BTreeSet;
 use std::net::IpAddr;
 
-use holo_utils::ibus::{
-    IbusMsg, IbusSender, NexthopMsg, RouteIpMsg, RouterIdMsg,
-};
+use holo_utils::ibus::{IbusSender, NexthopMsg, RouteIpMsg, RouterIdMsg};
 use holo_utils::protocol::Protocol;
 use holo_utils::southbound::{
     Nexthop, RouteKeyMsg, RouteMsg, RouteOpaqueAttrs,
@@ -21,7 +19,7 @@ use crate::rib::LocalRoute;
 // ===== global functions =====
 
 pub(crate) fn router_id_query(ibus_tx: &IbusSender) {
-    let _ = ibus_tx.send(IbusMsg::RouterId(RouterIdMsg::Query));
+    let _ = ibus_tx.send(RouterIdMsg::Query.into());
 }
 
 pub(crate) fn route_install(
@@ -43,38 +41,36 @@ pub(crate) fn route_install(
         .collect::<BTreeSet<_>>();
 
     // Install route.
-    let msg = RouteMsg {
+    let msg = RouteIpMsg::Add(RouteMsg {
         protocol: Protocol::BGP,
         prefix: prefix.into(),
         distance: distance.into(),
         metric: route.attrs.base.value.med.unwrap_or(0),
         tag: None,
         opaque_attrs: RouteOpaqueAttrs::None,
         nexthops: nexthops.clone(),
-    };
-    let msg = IbusMsg::RouteIp(RouteIpMsg::Add(msg));
-    let _ = ibus_tx.send(msg);
+    });
+    let _ = ibus_tx.send(msg.into());
 }
 
 pub(crate) fn route_uninstall(
     ibus_tx: &IbusSender,
     prefix: impl Into<IpNetwork>,
 ) {
     // Uninstall route.
-    let msg = RouteKeyMsg {
+    let msg = RouteIpMsg::Delete(RouteKeyMsg {
         protocol: Protocol::BGP,
         prefix: prefix.into(),
-    };
-    let msg = IbusMsg::RouteIp(RouteIpMsg::Delete(msg));
-    let _ = ibus_tx.send(msg);
+    });
+    let _ = ibus_tx.send(msg.into());
 }
 
 pub(crate) fn nexthop_track(ibus_tx: &IbusSender, addr: IpAddr) {
-    let msg = IbusMsg::Nexthop(NexthopMsg::Track(addr));
-    let _ = ibus_tx.send(msg);
+    let msg = NexthopMsg::Track(addr);
+    let _ = ibus_tx.send(msg.into());
 }
 
 pub(crate) fn nexthop_untrack(ibus_tx: &IbusSender, addr: IpAddr) {
-    let msg = IbusMsg::Nexthop(NexthopMsg::Untrack(addr));
-    let _ = ibus_tx.send(msg);
+    let msg = NexthopMsg::Untrack(addr);
+    let _ = ibus_tx.send(msg.into());
 }
diff --git a/holo-interface/src/ibus.rs b/holo-interface/src/ibus.rs
@@ -74,8 +74,8 @@ pub(crate) fn notify_router_id_update(
     ibus_tx: &IbusSender,
     router_id: Option<Ipv4Addr>,
 ) {
-    let msg = IbusMsg::RouterId(RouterIdMsg::Update(router_id));
-    notify(ibus_tx, msg);
+    let msg = RouterIdMsg::Update(router_id);
+    notify(ibus_tx, msg.into());
 }
 
 pub(crate) fn notify_interface_update(ibus_tx: &IbusSender, iface: &Interface) {
@@ -86,14 +86,14 @@ pub(crate) fn notify_interface_update(ibus_tx: &IbusSender, iface: &Interface) {
         flags: iface.flags,
         mac_address: iface.mac_address,
     };
-    let msg = IbusMsg::Interface(InterfaceMsg::Update(update_msg));
+    let msg = InterfaceMsg::Update(update_msg);
 
-    notify(ibus_tx, msg);
+    notify(ibus_tx, msg.into());
 }
 
 pub(crate) fn notify_interface_del(ibus_tx: &IbusSender, ifname: String) {
-    let msg = IbusMsg::Interface(InterfaceMsg::Delete(ifname));
-    notify(ibus_tx, msg);
+    let msg = InterfaceMsg::Delete(ifname);
+    notify(ibus_tx, msg.into());
 }
 
 pub(crate) fn notify_addr_add(
@@ -107,8 +107,8 @@ pub(crate) fn notify_addr_add(
         addr,
         flags,
     };
-    let msg = IbusMsg::InterfaceAddress(InterfaceAddressMsg::Add(addr_msg));
-    notify(ibus_tx, msg);
+    let msg = InterfaceAddressMsg::Add(addr_msg);
+    notify(ibus_tx, msg.into());
 }
 
 pub(crate) fn notify_addr_del(
@@ -117,13 +117,12 @@ pub(crate) fn notify_addr_del(
     addr: IpNetwork,
     flags: AddressFlags,
 ) {
-    let msg =
-        IbusMsg::InterfaceAddress(InterfaceAddressMsg::Delete(AddressMsg {
-            ifname,
-            addr,
-            flags,
-        }));
-    notify(ibus_tx, msg);
+    let msg = InterfaceAddressMsg::Delete(AddressMsg {
+        ifname,
+        addr,
+        flags,
+    });
+    notify(ibus_tx, msg.into());
 }
 
 // ===== helper functions =====

diff --git a/holo-isis/src/interface.rs b/holo-isis/src/interface.rs
@@ -13,7 +13,7 @@ use std::sync::Arc;
 
 use chrono::{DateTime, Utc};
 use holo_protocol::InstanceChannelsTx;
-use holo_utils::ibus::{IbusMsg, IbusSender, InterfaceMsg};
+use holo_utils::ibus::{IbusSender, InterfaceMsg};
 use holo_utils::ip::AddressFamily;
 use holo_utils::socket::{AsyncFd, Socket, SocketExt};
 use holo_utils::southbound::InterfaceFlags;
@@ -643,10 +643,11 @@ impl Interface {
     // Sends a southbound request for interface system information, such as
     // operational status and IP addresses.
     pub(crate) fn query_southbound(&self, ibus_tx: &IbusSender) {
-        let _ = ibus_tx.send(IbusMsg::Interface(InterfaceMsg::Query {
+        let msg = InterfaceMsg::Query {
             ifname: self.name.clone(),
             af: None,
-        }));
+        };
+        let _ = ibus_tx.send(msg.into());
     }
 }
 

diff --git a/holo-isis/src/southbound/tx.rs b/holo-isis/src/southbound/tx.rs
@@ -7,10 +7,10 @@
 // See: https://nlnet.nl/NGI0
 //
 
-use holo_utils::ibus::{IbusMsg, IbusSender, RouterIdMsg};
+use holo_utils::ibus::{IbusSender, RouterIdMsg};
 
 // ===== global functions =====
 
 pub(crate) fn router_id_query(ibus_tx: &IbusSender) {
-    let _ = ibus_tx.send(IbusMsg::RouterId(RouterIdMsg::Query));
+    let _ = ibus_tx.send(RouterIdMsg::Query.into());
 }
diff --git a/holo-keychain/src/northbound/configuration.rs b/holo-keychain/src/northbound/configuration.rs
@@ -15,7 +15,7 @@ use holo_northbound::configuration::{
 };
 use holo_northbound::yang::key_chains;
 use holo_utils::crypto::CryptoAlgo;
-use holo_utils::ibus::{IbusMsg, KeychainMsg};
+use holo_utils::ibus::KeychainMsg;
 use holo_utils::keychain::{Key, Keychain, KeychainKey};
 use holo_utils::yang::DataNodeRefExt;
 use holo_yang::TryFromYang;
@@ -443,13 +443,13 @@ impl Provider for Master {
                 let keychain = Arc::new(keychain.clone());
 
                 // Notify protocols that the keychain has been updated.
-                let msg = IbusMsg::Keychain(KeychainMsg::Update(keychain));
-                let _ = self.ibus_tx.send(msg);
+                let msg = KeychainMsg::Update(keychain);
+                let _ = self.ibus_tx.send(msg.into());
             }
             Event::KeychainDelete(name) => {
                 // Notify protocols that the keychain has been deleted.
-                let msg = IbusMsg::Keychain(KeychainMsg::Delete(name));
-                let _ = self.ibus_tx.send(msg);
+                let msg = KeychainMsg::Delete(name);
+                let _ = self.ibus_tx.send(msg.into());
             }
         }
     }

diff --git a/holo-ldp/src/northbound/configuration.rs b/holo-ldp/src/northbound/configuration.rs
@@ -15,7 +15,7 @@ use holo_northbound::configuration::{
     ValidationCallbacksBuilder,
 };
 use holo_northbound::yang::control_plane_protocol::mpls_ldp;
-use holo_utils::ibus::{IbusMsg, InterfaceMsg};
+use holo_utils::ibus::InterfaceMsg;
 use holo_utils::ip::AddressFamily;
 use holo_utils::yang::DataNodeRefExt;
 
@@ -471,12 +471,11 @@ impl Provider for Instance {
             }
             Event::InterfaceQuerySouthbound(ifname) => {
                 if let Some((instance, _, _)) = self.as_up() {
-                    let _ = instance.tx.ibus.send(IbusMsg::Interface(
-                        InterfaceMsg::Query {
-                            ifname,
-                            af: Some(AddressFamily::Ipv4),
-                        },
-                    ));
+                    let msg = InterfaceMsg::Query {
+                        ifname,
+                        af: Some(AddressFamily::Ipv4),
+                    };
+                    let _ = instance.tx.ibus.send(msg.into());
                 }
             }
             Event::TargetedNbrUpdate(tnbr_idx) => {

diff --git a/holo-ldp/src/southbound/tx.rs b/holo-ldp/src/southbound/tx.rs
@@ -4,7 +4,7 @@
 // SPDX-License-Identifier: MIT
 //
 
-use holo_utils::ibus::{IbusMsg, IbusSender, RouteMplsMsg, RouterIdMsg};
+use holo_utils::ibus::{IbusSender, RouteMplsMsg, RouterIdMsg};
 use holo_utils::protocol::Protocol;
 use holo_utils::southbound::{self, LabelInstallMsg, LabelUninstallMsg};
 
@@ -13,7 +13,7 @@ use crate::fec::{FecInner, Nexthop};
 // ===== global functions =====
 
 pub(crate) fn router_id_query(ibus_tx: &IbusSender) {
-    let _ = ibus_tx.send(IbusMsg::RouterId(RouterIdMsg::Query));
+    let _ = ibus_tx.send(RouterIdMsg::Query.into());
 }
 
 pub(crate) fn label_install(
@@ -35,7 +35,7 @@ pub(crate) fn label_install(
     let protocol = fec.protocol.unwrap();
 
     // Fill-in message.
-    let msg = LabelInstallMsg {
+    let msg = RouteMplsMsg::Add(LabelInstallMsg {
         protocol: Protocol::LDP,
         label: local_label,
         nexthops: [southbound::Nexthop::Address {
@@ -46,11 +46,10 @@ pub(crate) fn label_install(
         .into(),
         route: Some((protocol, *fec.prefix)),
         replace: false,
-    };
+    });
 
     // Send message.
-    let msg = IbusMsg::RouteMpls(RouteMplsMsg::Add(msg));
-    let _ = ibus_tx.send(msg);
+    let _ = ibus_tx.send(msg.into());
 }
 
 pub(crate) fn label_uninstall(
@@ -72,7 +71,7 @@ pub(crate) fn label_uninstall(
     let protocol = fec.protocol.unwrap();
 
     // Fill-in message.
-    let msg = LabelUninstallMsg {
+    let msg = RouteMplsMsg::Delete(LabelUninstallMsg {
         protocol: Protocol::LDP,
         label: local_label,
         nexthops: [southbound::Nexthop::Address {
@@ -82,9 +81,8 @@ pub(crate) fn label_uninstall(
         }]
         .into(),
         route: Some((protocol, *fec.prefix)),
-    };
+    });
 
     // Send message.
-    let msg = IbusMsg::RouteMpls(RouteMplsMsg::Delete(msg));
-    let _ = ibus_tx.send(msg);
+    let _ = ibus_tx.send(msg.into());
 }
diff --git a/holo-ospf/src/neighbor.rs b/holo-ospf/src/neighbor.rs
@@ -10,7 +10,7 @@ use std::sync::Arc;
 
 use chrono::{DateTime, Utc};
 use holo_utils::bfd;
-use holo_utils::ibus::IbusMsg;
+use holo_utils::ibus::BfdSessionMsg;
 use holo_utils::task::{IntervalTask, TimeoutTask};
 use nsm::{Event, State};
 use rand::RngCore;
@@ -553,14 +553,12 @@ where
     ) {
         Debug::<V>::NeighborBfdReg(self.router_id).log();
 
-        let msg = IbusMsg::BfdSession(
-            holo_utils::ibus::BfdSessionMsg::Registration {
-                sess_key: self.bfd_session_key(iface),
-                client_id: self.bfd_client_id(instance),
-                client_config: Some(iface.config.bfd_params),
-            },
-        );
-        let _ = instance.tx.ibus.send(msg);
+        let msg = BfdSessionMsg::Registration {
+            sess_key: self.bfd_session_key(iface),
+            client_id: self.bfd_client_id(instance),
+            client_config: Some(iface.config.bfd_params),
+        };
+        let _ = instance.tx.ibus.send(msg.into());
     }
 
     pub(crate) fn bfd_unregister(
@@ -570,13 +568,11 @@ where
     ) {
         Debug::<V>::NeighborBfdUnreg(self.router_id).log();
 
-        let msg = IbusMsg::BfdSession(
-            holo_utils::ibus::BfdSessionMsg::Unregistration {
-                sess_key: self.bfd_session_key(iface),
-                client_id: self.bfd_client_id(instance),
-            },
-        );
-        let _ = instance.tx.ibus.send(msg);
+        let msg = BfdSessionMsg::Unregistration {
+            sess_key: self.bfd_session_key(iface),
+            client_id: self.bfd_client_id(instance),
+        };
+        let _ = instance.tx.ibus.send(msg.into());
     }
 
     fn bfd_session_key(&self, iface: &Interface<V>) -> bfd::SessionKey {