bgpsim 0.20.4

A network control-plane simulator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

// BgpSim: BGP Network Simulator written in Rust
// Copyright 2022-2024 Tibor Schneider <sctibor@ethz.ch>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

//! Static Route process of an internal router.

use crate::{
    formatter::NetworkFormatter,
    ospf::{IgpTarget, OspfImpl},
    types::{IntoIpv4Prefix, Ipv4Prefix, Prefix, PrefixMap, RouterId},
};
use itertools::Itertools;
use serde::{Deserialize, Serialize};

/// Static Routing Process.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct SrProcess<P: Prefix> {
    /// Static Routes for Prefixes
    pub(crate) static_routes: P::Map<StaticRoute>,
}

impl<P: Prefix> IntoIpv4Prefix for SrProcess<P> {
    type T = SrProcess<Ipv4Prefix>;

    fn into_ipv4_prefix(self) -> Self::T {
        SrProcess {
            static_routes: self
                .static_routes
                .into_iter()
                .map(|(p, sr)| (p.into_ipv4_prefix(), sr))
                .collect(),
        }
    }
}

impl<P: Prefix> SrProcess<P> {
    /// Return a new Static Route process
    pub(super) fn new() -> Self {
        Self {
            static_routes: Default::default(),
        }
    }

    /// Configure a specific static route (or remove an old entry). This function will return the
    /// previously set value
    pub(crate) fn set(&mut self, prefix: P, route: Option<StaticRoute>) -> Option<StaticRoute> {
        if let Some(route) = route {
            self.static_routes.insert(prefix, route)
        } else {
            self.static_routes.remove(&prefix)
        }
    }

    /// Get a static route if given for a given prefix. This operation will perform a longest-prefix
    /// match.
    pub fn get(&self, prefix: P) -> Option<StaticRoute> {
        self.static_routes.get_lpm(&prefix).map(|(_, sr)| *sr)
    }

    /// Get a static route if given for a given prefix. This operation will perform exact matching.
    pub fn get_exact(&self, prefix: P) -> Option<StaticRoute> {
        self.static_routes.get_lpm(&prefix).map(|(_, sr)| *sr)
    }

    /// Get a reference to the entire static route table
    pub fn get_table(&self) -> &P::Map<StaticRoute> {
        &self.static_routes
    }
}

impl<'n, P: Prefix, Q, Ospf: OspfImpl> NetworkFormatter<'n, P, Q, Ospf> for SrProcess<P> {
    fn fmt(&self, net: &'n crate::network::Network<P, Q, Ospf>) -> String {
        self.static_routes
            .iter()
            .map(|(p, sr)| format!("{p} -> {}", sr.fmt(net)))
            .join("\n")
    }
}

/// Static route description that can either point to the direct link to the target, or to use the
/// IGP for getting the path to the target.
#[derive(Debug, Clone, Hash, PartialEq, Eq, Copy, Serialize, Deserialize)]
pub enum StaticRoute {
    /// Use the direct edge. If the edge no longer exists, then a black-hole will be created.
    Direct(RouterId),
    /// Use IGP to route traffic towards that target.
    Indirect(RouterId),
    /// Drop all traffic for the given destination
    Drop,
}

impl From<StaticRoute> for IgpTarget {
    fn from(value: StaticRoute) -> Self {
        match value {
            StaticRoute::Direct(r) => IgpTarget::Neighbor(r),
            StaticRoute::Indirect(r) => IgpTarget::Ospf(r),
            StaticRoute::Drop => IgpTarget::Drop,
        }
    }
}

impl StaticRoute {
    /// Get the target router (or None in case of `Self::Drop`)
    pub fn router(&self) -> Option<RouterId> {
        match self {
            StaticRoute::Direct(r) | StaticRoute::Indirect(r) => Some(*r),
            StaticRoute::Drop => None,
        }
    }
}