all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Gabriel Goller <g.goller@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH proxmox-ve-rs 11/17] frr: add serializer for all FRR types
Date: Fri, 28 Mar 2025 18:13:00 +0100	[thread overview]
Message-ID: <20250328171340.885413-13-g.goller@proxmox.com> (raw)
In-Reply-To: <20250328171340.885413-1-g.goller@proxmox.com>

This custom serializer will serialize all the FRR types into a string,
which is the FRR config.

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

diff --git a/proxmox-frr/src/lib.rs b/proxmox-frr/src/lib.rs
index 08abdd371653..5b2bdc2c9d72 100644
--- a/proxmox-frr/src/lib.rs
+++ b/proxmox-frr/src/lib.rs
@@ -1,6 +1,8 @@
 pub mod openfabric;
 pub mod ospf;
 pub mod route_map;
+pub mod serializer;
+
 use std::{collections::BTreeMap, fmt::Display, str::FromStr};
 
 use route_map::{AccessList, AccessListName, ProtocolRouteMap, RouteMap};
diff --git a/proxmox-frr/src/serializer.rs b/proxmox-frr/src/serializer.rs
new file mode 100644
index 000000000000..631956aeb099
--- /dev/null
+++ b/proxmox-frr/src/serializer.rs
@@ -0,0 +1,192 @@
+use std::fmt::{self, Write};
+
+use crate::{
+    openfabric::{OpenFabricInterface, OpenFabricRouter},
+    ospf::{OspfInterface, OspfRouter},
+    route_map::{AccessList, AccessListName, ProtocolRouteMap, RouteMap},
+    FrrConfig, Interface, InterfaceName, Router, RouterName,
+};
+
+pub struct FrrConfigBlob<'a> {
+    buf: &'a mut (dyn Write + 'a),
+}
+
+impl Write for FrrConfigBlob<'_> {
+    fn write_str(&mut self, s: &str) -> Result<(), fmt::Error> {
+        self.buf.write_str(s)
+    }
+}
+
+pub trait FrrSerializer {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result;
+}
+
+pub fn to_raw_config(frr_config: &FrrConfig) -> Result<Vec<String>, anyhow::Error> {
+    let mut out = String::new();
+    let mut blob = FrrConfigBlob { buf: &mut out };
+    frr_config.serialize(&mut blob)?;
+
+    Ok(out.as_str().lines().map(String::from).collect())
+}
+
+pub fn dump(config: &FrrConfig) -> Result<String, anyhow::Error> {
+    let mut out = String::new();
+    let mut blob = FrrConfigBlob { buf: &mut out };
+    config.serialize(&mut blob)?;
+    Ok(out)
+}
+
+impl FrrSerializer for &FrrConfig {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        self.router().try_for_each(|router| router.serialize(f))?;
+        self.interfaces()
+            .try_for_each(|interface| interface.serialize(f))?;
+        self.access_lists().try_for_each(|list| list.serialize(f))?;
+        self.routemaps().try_for_each(|map| map.serialize(f))?;
+        self.protocol_routemaps()
+            .try_for_each(|pm| pm.serialize(f))?;
+        Ok(())
+    }
+}
+
+impl FrrSerializer for (&RouterName, &Router) {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        let router_name = self.0;
+        let router = self.1;
+        writeln!(f, "router {router_name}")?;
+        router.serialize(f)?;
+        writeln!(f, "exit")?;
+        writeln!(f, "!")?;
+        Ok(())
+    }
+}
+
+impl FrrSerializer for (&InterfaceName, &Interface) {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        let interface_name = self.0;
+        let interface = self.1;
+        writeln!(f, "interface {interface_name}")?;
+        interface.serialize(f)?;
+        writeln!(f, "exit")?;
+        writeln!(f, "!")?;
+        Ok(())
+    }
+}
+
+impl FrrSerializer for (&AccessListName, &AccessList) {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        self.1.serialize(f)?;
+        writeln!(f, "!")
+    }
+}
+
+impl FrrSerializer for Interface {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        match self {
+            Interface::OpenFabric(openfabric_interface) => openfabric_interface.serialize(f)?,
+            Interface::Ospf(ospf_interface) => ospf_interface.serialize(f)?,
+        }
+        Ok(())
+    }
+}
+
+impl FrrSerializer for OpenFabricInterface {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        if self.is_ipv6 {
+            writeln!(f, " ipv6 router {}", self.fabric_id())?;
+        } else {
+            writeln!(f, " ip router {}", self.fabric_id())?;
+        }
+        if self.passive() == Some(true) {
+            writeln!(f, " openfabric passive")?;
+        }
+        if let Some(interval) = self.hello_interval() {
+            writeln!(f, " openfabric hello-interval {interval}",)?;
+        }
+        if let Some(multiplier) = self.hello_multiplier() {
+            writeln!(f, " openfabric hello-multiplier {multiplier}",)?;
+        }
+        if let Some(interval) = self.csnp_interval() {
+            writeln!(f, " openfabric csnp-interval {interval}",)?;
+        }
+        Ok(())
+    }
+}
+
+impl FrrSerializer for OspfInterface {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        writeln!(f, " ip ospf {}", self.area())?;
+        if *self.passive() == Some(true) {
+            writeln!(f, " ip ospf passive")?;
+        }
+        if let Some(network_type) = self.network_type() {
+            writeln!(f, " ip ospf network {network_type}")?;
+        }
+        Ok(())
+    }
+}
+
+impl FrrSerializer for &Router {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        match self {
+            Router::OpenFabric(open_fabric_router) => open_fabric_router.serialize(f),
+            Router::Ospf(ospf_router) => ospf_router.serialize(f),
+        }
+    }
+}
+
+impl FrrSerializer for &OpenFabricRouter {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        writeln!(f, " net {}", self.net())?;
+        Ok(())
+    }
+}
+
+impl FrrSerializer for &OspfRouter {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        writeln!(f, " ospf router-id {}", self.router_id())?;
+        Ok(())
+    }
+}
+
+impl FrrSerializer for &AccessList {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        for i in &self.rules {
+            if i.network.is_ipv6() {
+                write!(f, "ipv6 ")?;
+            }
+            write!(f, "access-list {} ", self.name)?;
+            if let Some(seq) = i.seq {
+                write!(f, "seq {seq} ")?;
+            }
+            write!(f, "{} ", i.action)?;
+            writeln!(f, "{}", i.network)?;
+        }
+        Ok(())
+    }
+}
+
+impl FrrSerializer for &RouteMap {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        writeln!(f, "route-map {} {} {}", self.name, self.action, self.seq)?;
+        for i in &self.matches {
+            writeln!(f, " {}", i)?;
+        }
+        for i in &self.sets {
+            writeln!(f, " {}", i)?;
+        }
+        writeln!(f, "exit")?;
+        writeln!(f, "!")
+    }
+}
+
+impl FrrSerializer for &ProtocolRouteMap {
+    fn serialize(&self, f: &mut FrrConfigBlob<'_>) -> fmt::Result {
+        writeln!(
+            f,
+            "ip protocol {} route-map {}",
+            self.protocol, self.routemap_name
+        )?;
+        Ok(())
+    }
+}
-- 
2.39.5



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


  parent reply	other threads:[~2025-03-28 17:17 UTC|newest]

Thread overview: 96+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-28 17:12 [pve-devel] [PATCH cluster/docs/manager/network/proxmox{, -ve-rs, -firewall, -perl-rs} 00/52] Add SDN Fabrics Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox 1/1] serde: add string_as_bool module for boolean string parsing Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 01/17] add proxmox-network-types crate Gabriel Goller
2025-03-31 14:09   ` Thomas Lamprecht
2025-03-31 14:38     ` Stefan Hanreich
2025-03-31 16:20       ` Thomas Lamprecht
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 02/17] network-types: add common hostname and openfabric types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 03/17] network-types: add openfabric NET type Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 04/17] network-types: move Ipv4Cidr and Ipv6Cidr types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 05/17] frr: create proxmox-frr crate Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 06/17] frr: add common frr types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 07/17] frr: add openfabric types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 08/17] frr: add ospf types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 09/17] frr: add route-map types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 10/17] frr: add generic types over openfabric and ospf Gabriel Goller
2025-03-28 17:13 ` Gabriel Goller [this message]
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 12/17] ve-config: add openfabric section-config Gabriel Goller
2025-03-31 13:48   ` Christoph Heiss
2025-03-31 15:04     ` Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 13/17] ve-config: add ospf section-config Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 14/17] ve-config: add FRR conversion helpers for openfabric and ospf Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 15/17] ve-config: add validation for section-config Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 16/17] ve-config: add section-config to frr types conversion Gabriel Goller
2025-03-31 13:51   ` Christoph Heiss
2025-03-31 14:31     ` Stefan Hanreich
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 17/17] ve-config: add integrations tests Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-firewall 1/1] firewall: nftables: migrate to proxmox-network-types Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 1/7] perl-rs: sdn: initial fabric infrastructure Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 2/7] perl-rs: sdn: add CRUD helpers for OpenFabric fabric management Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 3/7] perl-rs: sdn: OpenFabric perlmod methods Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 4/7] perl-rs: sdn: implement OSPF interface file configuration generation Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 5/7] perl-rs: sdn: add CRUD helpers for OSPF fabric management Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 6/7] perl-rs: sdn: OSPF perlmod methods Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 7/7] perl-rs: sdn: implement OSPF interface file configuration generation Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-cluster 1/1] cluster: add sdn fabrics config files Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 01/17] sdn: fix value returned by pending_config Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 02/17] debian: add dependency to proxmox-perl-rs Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 03/17] fabrics: add fabrics module Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 04/17] refactor: controller: move frr methods into helper Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 05/17] controllers: implement new api for frr config generation Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 06/17] sdn: add frr config generation helper Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 07/17] test: isis: add test for standalone configuration Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 08/17] sdn: frr: add daemon status to frr helper Gabriel Goller
2025-04-02 10:41   ` Fabian Grünbichler
2025-04-02 10:50     ` Stefan Hanreich
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 09/17] sdn: running: apply fabrics config Gabriel Goller
2025-04-02 10:41   ` Fabian Grünbichler
2025-04-02 12:26     ` Stefan Hanreich
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 10/17] fabrics: generate ifupdown configuration Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 11/17] api: add fabrics subfolder Gabriel Goller
2025-04-02 10:41   ` Fabian Grünbichler
2025-04-02 12:20     ` Stefan Hanreich
2025-04-02 12:29       ` Fabian Grünbichler
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 12/17] api: fabrics: add common helpers Gabriel Goller
2025-04-02 10:41   ` Fabian Grünbichler
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 13/17] fabric: openfabric: add api endpoints Gabriel Goller
2025-04-02 10:37   ` Fabian Grünbichler
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 14/17] fabric: ospf: " Gabriel Goller
2025-04-02 10:37   ` Fabian Grünbichler
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 15/17] test: fabrics: add test cases for ospf and openfabric + evpn Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 16/17] frr: bump frr config version to 10.2.1 Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 17/17] frr: fix reloading frr configuration Gabriel Goller
2025-04-02 10:37   ` Fabian Grünbichler
2025-04-02 10:42     ` Stefan Hanreich
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 1/7] api: use new generalized frr and etc network config helper functions Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 2/7] fabrics: add common interface panel Gabriel Goller
2025-04-02  9:26   ` Friedrich Weber
2025-04-02 10:04     ` Gabriel Goller
2025-04-02 10:10       ` Friedrich Weber
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 3/7] fabrics: add additional interface fields for openfabric and ospf Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 4/7] fabrics: add FabricEdit components Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 5/7] fabrics: add NodeEdit components Gabriel Goller
2025-04-03  9:16   ` Christoph Heiss
2025-04-04 15:45     ` Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 6/7] fabrics: Add main FabricView Gabriel Goller
2025-04-02  9:26   ` Friedrich Weber
2025-04-02  9:50   ` Christoph Heiss
2025-04-02 10:40     ` Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 7/7] utils: avoid line-break in pending changes message Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-docs 1/1] fabrics: add initial documentation for sdn fabrics Gabriel Goller
2025-03-31  8:44   ` Shannon Sterz
2025-03-31 12:24     ` Gabriel Goller
2025-04-02  8:43       ` Gabriel Goller
2025-04-02  8:49   ` Christoph Heiss
2025-04-02  9:09     ` Gabriel Goller
2025-04-02  9:16       ` Christoph Heiss
2025-04-03  8:30 ` [pve-devel] [PATCH cluster/docs/manager/network/proxmox{, -ve-rs, -firewall, -perl-rs} 00/52] Add SDN Fabrics Friedrich Weber
2025-04-03 10:21   ` Gabriel Goller
2025-04-03 13:44     ` Friedrich Weber
2025-04-03 14:03       ` Stefan Hanreich
2025-04-03 14:20         ` Friedrich Weber
2025-04-04  7:53           ` Stefan Hanreich
2025-04-04 10:55 ` Hannes Duerr
2025-04-04 12:48   ` Gabriel Goller
2025-04-04 12:53     ` Hannes Duerr
2025-04-04 14:26       ` Gabriel Goller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250328171340.885413-13-g.goller@proxmox.com \
    --to=g.goller@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal