[pve-devel] [PATCH proxmox-ve-rs v5 05/22] frr: add openfabric types

[Gabriel Goller <g.goller@proxmox.com>]

Implement OpenFabric-specific variants of common enums that
encapsulate protocol properties defined in proxmox-network-types. The
primary addition is OpenFabricInterface, which stores
protocol-specific timing parameters: HelloInterval (neighbor discovery
frequency), CsnpInterval (database synchronization frequency), and
HelloMultiplier (neighbor failure detection). Added `is_ipv6` flag to
support FRR's command prefixing requirements during serialization for
IPv6-specific commands (we need to add a 'ipv6' prefix to some
commands).

Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
---
 proxmox-frr/src/lib.rs        |  1 +
 proxmox-frr/src/openfabric.rs | 88 +++++++++++++++++++++++++++++++++++
 2 files changed, 89 insertions(+)
 create mode 100644 proxmox-frr/src/openfabric.rs

diff --git a/proxmox-frr/src/lib.rs b/proxmox-frr/src/lib.rs
index 3a66fea63e63..42c602663226 100644
--- a/proxmox-frr/src/lib.rs
+++ b/proxmox-frr/src/lib.rs
@@ -1,3 +1,4 @@
+pub mod openfabric;
 use std::{fmt::Display, str::FromStr};
 
 use thiserror::Error;
diff --git a/proxmox-frr/src/openfabric.rs b/proxmox-frr/src/openfabric.rs
new file mode 100644
index 000000000000..6e2a7200ab37
--- /dev/null
+++ b/proxmox-frr/src/openfabric.rs
@@ -0,0 +1,88 @@
+use std::fmt::Debug;
+use std::fmt::Display;
+
+use proxmox_sdn_types::net::Net;
+
+use thiserror::Error;
+
+use crate::FrrWord;
+use crate::FrrWordError;
+
+/// The name of a OpenFabric router. Is an FrrWord.
+#[derive(Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
+pub struct OpenfabricRouterName(FrrWord);
+
+impl From<FrrWord> for OpenfabricRouterName {
+    fn from(value: FrrWord) -> Self {
+        Self(value)
+    }
+}
+
+impl OpenfabricRouterName {
+    pub fn new(name: FrrWord) -> Self {
+        Self(name)
+    }
+}
+
+impl Display for OpenfabricRouterName {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "openfabric {}", self.0)
+    }
+}
+
+/// All the properties a OpenFabric router can hold.
+///
+/// These can serialized with a " " space prefix as they are in the `router openfabric` block.
+#[derive(Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
+pub struct OpenfabricRouter {
+    /// The NET address
+    pub net: Net,
+}
+
+impl OpenfabricRouter {
+    pub fn new(net: Net) -> Self {
+        Self { net }
+    }
+
+    pub fn net(&self) -> &Net {
+        &self.net
+    }
+}
+
+/// The OpenFabric properties.
+///
+/// This struct holds all the OpenFabric interface properties. The most important one here is the
+/// fabric_id, which ties the interface to a fabric. When serialized these properties all get
+/// prefixed with a space (" ") as they are inside the interface block. They serialize roughly to:
+///
+/// ```text
+/// interface ens20
+///  ip router openfabric <fabric_id>
+///  ipv6 router openfabric <fabric_id>
+///  openfabric hello-interval <value>
+///  openfabric hello-multiplier <value>
+///  openfabric csnp-interval <value>
+///  openfabric passive <value>
+/// ```
+///
+/// The is_ipv4 and is_ipv6 properties decide if we need to add `ip router openfabric`, `ipv6
+/// router openfabric`, or both. An interface can only be part of a single fabric.
+#[derive(Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
+pub struct OpenfabricInterface {
+    // Note: an interface can only be a part of a single fabric (so no vec needed here)
+    pub fabric_id: OpenfabricRouterName,
+    pub passive: Option<bool>,
+    pub hello_interval: Option<proxmox_sdn_types::openfabric::HelloInterval>,
+    pub csnp_interval: Option<proxmox_sdn_types::openfabric::CsnpInterval>,
+    pub hello_multiplier: Option<proxmox_sdn_types::openfabric::HelloMultiplier>,
+    pub is_ipv4: bool,
+    pub is_ipv6: bool,
+}
+
+#[derive(Error, Debug)]
+pub enum OpenfabricInterfaceError {
+    #[error("Unknown error converting to OpenFabricInterface")]
+    UnknownError,
+    #[error("Error parsing frr word")]
+    FrrWordParse(#[from] FrrWordError),
+}
-- 
2.39.5



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel