Skip to content

Commit

Permalink
BGP WIP implementation
Browse files Browse the repository at this point in the history
Signed-off-by: Renato Westphal <[email protected]>
  • Loading branch information
rwestphal committed Jan 24, 2024
1 parent 1bff4ad commit 2189ccb
Show file tree
Hide file tree
Showing 54 changed files with 16,608 additions and 58 deletions.
2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[workspace]
members = [
"holo-bfd",
"holo-bgp",
"holo-cli",
"holo-daemon",
"holo-interface",
Expand Down Expand Up @@ -35,6 +36,7 @@ check_keyword = "0.2"
clap = "2.33"
chrono = { version = "0.4", features = ["serde"] }
criterion = "0.4"
crossbeam-channel = "0.5"
derive-new = "0.5"
enum-as-inner = "0.6"
futures = "0.3"
Expand Down
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,30 @@ Holo supports the following IETF RFCs and Internet drafts:
* RFC 5882 - Generic Application of Bidirectional Forwarding Detection (BFD)
* RFC 5883 - Bidirectional Forwarding Detection (BFD) for Multihop Paths

##### BGP

* RFC 1997 - BGP Communities Attribute
* RFC 2385 - Protection of BGP Sessions via the TCP MD5 Signature Option
* RFC 2545 - Use of BGP-4 Multiprotocol Extensions for IPv6 Inter-Domain Routing
* RFC 2918 - Route Refresh Capability for BGP-4
* RFC 4271 - A Border Gateway Protocol 4 (BGP-4)
* RFC 4360 - BGP Extended Communities Attribute
* RFC 4486 - Subcodes for BGP Cease Notification Message
* RFC 4760 - Multiprotocol Extensions for BGP-4
* RFC 5082 - The Generalized TTL Security Mechanism (GTSM)
* RFC 5492 - Capabilities Advertisement with BGP-4
* RFC 5668 - 4-Octet AS Specific BGP Extended Community
* RFC 5701 - IPv6 Address Specific BGP Extended Community Attribute
* RFC 6286 - Autonomous-System-Wide Unique BGP Identifier for BGP-4
* RFC 6608 - Subcodes for BGP Finite State Machine Error
* RFC 6793 - BGP Support for Four-Octet Autonomous System (AS) Number Space
* RFC 7606 - Revised Error Handling for BGP UPDATE Messages
* RFC 7607 - Codification of AS 0 Processing
* RFC 8092 - BGP Large Communities Attribute
* RFC 8212 - Default External BGP (EBGP) Route Propagation Behavior without Policies
* RFC 8642 - Policy Behavior for Well-Known BGP Communities
* RFC 9072 - Extended Optional Parameters Length for BGP OPEN Message

##### MPLS LDP

* RFC 5036 - LDP Specification
Expand Down Expand Up @@ -192,6 +216,8 @@ Holo supports the following IETF RFCs and Internet drafts:
| ietf-bfd-ip-mh@2022-09-22 | 100.00% | 100.00% | - | 100.00% | [100.00%](http://westphal.com.br/holo/ietf-bfd-ip-mh.html) |
| ietf-bfd-ip-sh@2022-09-22 | 100.00% | 100.00% | - | 100.00% | [100.00%](http://westphal.com.br/holo/ietf-bfd-ip-sh.html) |
| ietf-bfd@2022-09-22 | 100.00% | 100.00% | - | - | [100.00%](http://westphal.com.br/holo/ietf-bfd.html) |
| ietf-bgp-policy@2023-07-05 | 100.00% | - | - | - | [100.00%](http://westphal.com.br/holo/ietf-bgp-policy.html) |
| ietf-bgp@2023-07-05 | 39.43% | 93.33% | - | - | [67.62%](http://westphal.com.br/holo/ietf-bgp.html) |
| ietf-interfaces@2018-01-09 | 100.00% | 0.00% | - | - | [22.22%](http://westphal.com.br/holo/ietf-interfaces.html) |
| ietf-ip@2018-01-09 | 17.39% | 0.00% | - | - | [13.33%](http://westphal.com.br/holo/ietf-ip.html) |
| ietf-ipv4-unicast-routing@2018-03-13 | 100.00% | 100.00% | - | - | [100.00%](http://westphal.com.br/holo/ietf-ipv4-unicast-routing.html) |
Expand Down
54 changes: 54 additions & 0 deletions holo-bgp/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
[package]
name = "holo-bgp"
version.workspace = true
authors.workspace = true
license.workspace = true
edition.workspace = true

[dependencies]
async-trait.workspace = true
bitflags.workspace = true
bytes.workspace = true
chrono.workspace = true
crossbeam-channel.workspace = true
derive-new.workspace = true
enum-as-inner.workspace = true
generational-arena.workspace = true
ipnetwork.workspace = true
itertools.workspace = true
libc.workspace = true
num-derive.workspace = true
num-traits.workspace = true
rand.workspace = true
serde.workspace = true
serde_json.workspace = true
tokio.workspace = true
tracing.workspace = true
yang2.workspace = true

holo-northbound = { path = "../holo-northbound" }
holo-protocol = { path = "../holo-protocol" }
holo-utils = { path = "../holo-utils" }
holo-yang = { path = "../holo-yang" }

[dev-dependencies]
criterion.workspace = true

holo-bgp = { path = ".", features = ["testing"] }
holo-protocol = { path = "../holo-protocol", features = ["testing"] }
holo-utils = { path = "../holo-utils", features = ["testing"] }

[lints]
workspace = true

[features]
default = []
testing = []

[[bench]]
name = "msg_encoding"
harness = false

[[bench]]
name = "msg_decoding"
harness = false
19 changes: 19 additions & 0 deletions holo-bgp/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2023 The Holo Core Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
37 changes: 37 additions & 0 deletions holo-bgp/benches/msg_decoding.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#![feature(lazy_cell)]

use std::hint::black_box;

use criterion::{criterion_group, criterion_main, Criterion};
use holo_bgp::neighbor::PeerType;
use holo_bgp::packet::message::{Capability, DecodeCxt, Message};

fn msg_decode(n: u64) {
let cxt = DecodeCxt {
peer_type: PeerType::Internal,
peer_as: n as u32,
capabilities: [Capability::FourOctetAsNumber { asn: n as u32 }].into(),
};

let bytes = vec![
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
0xff, 0xff, 0xff, 0xff, 0x00, 0x3d, 0x01, 0x04, 0x00, 0x01, 0x00, 0xb4,
0x01, 0x01, 0x01, 0x01, 0x20, 0x02, 0x06, 0x01, 0x04, 0x00, 0x01, 0x00,
0x01, 0x02, 0x06, 0x01, 0x04, 0x00, 0x02, 0x00, 0x01, 0x02, 0x02, 0x02,
0x00, 0x02, 0x06, 0x41, 0x04, 0x00, 0x01, 0x00, 0x0e, 0x02, 0x02, 0x46,
0x00,
];

for _ in 0..n {
let _msg = Message::decode(&bytes, &cxt).unwrap();
}
}

fn criterion_benchmark(c: &mut Criterion) {
c.bench_function("Message decode", |b| {
b.iter(|| msg_decode(black_box(10000)))
});
}

criterion_group!(benches, criterion_benchmark);
criterion_main!(benches);
52 changes: 52 additions & 0 deletions holo-bgp/benches/msg_encoding.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
#![feature(lazy_cell)]

use std::hint::black_box;
use std::net::Ipv4Addr;
use std::str::FromStr;
use std::sync::LazyLock as Lazy;

use criterion::{criterion_group, criterion_main, Criterion};
use holo_bgp::packet::consts::{Afi, Safi, BGP_VERSION};
use holo_bgp::packet::message::{Capability, EncodeCxt, Message, OpenMsg};

static MESSAGE: Lazy<Message> = Lazy::new(|| {
Message::Open(OpenMsg {
version: BGP_VERSION,
my_as: 1,
holdtime: 180,
identifier: Ipv4Addr::from_str("1.1.1.1").unwrap(),
capabilities: [
Capability::MultiProtocol {
afi: Afi::Ipv4,
safi: Safi::Unicast,
},
Capability::MultiProtocol {
afi: Afi::Ipv6,
safi: Safi::Unicast,
},
Capability::FourOctetAsNumber { asn: 65550 },
Capability::RouteRefresh,
Capability::EnhancedRouteRefresh,
]
.into(),
})
});

fn msg_encode(n: u64) {
let cxt = EncodeCxt {
capabilities: [Capability::FourOctetAsNumber { asn: n as u32 }].into(),
};

for _ in 0..n {
MESSAGE.encode(&cxt);
}
}

fn criterion_benchmark(c: &mut Criterion) {
c.bench_function("Message encode", |b| {
b.iter(|| msg_encode(black_box(10000)))
});
}

criterion_group!(benches, criterion_benchmark);
criterion_main!(benches);
147 changes: 147 additions & 0 deletions holo-bgp/src/debug.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
//
// Copyright (c) The Holo Core Contributors
//
// SPDX-License-Identifier: MIT
//

use std::net::IpAddr;

use tracing::{debug, debug_span};

use crate::neighbor::fsm;
use crate::packet::consts::AttrType;
use crate::packet::error::AttrError;
use crate::packet::message::Message;

// BGP debug messages.
#[derive(Debug)]
pub enum Debug<'a> {
InstanceCreate,
InstanceDelete,
InstanceStart,
InstanceStop(InstanceInactiveReason),
InstanceStatusCheck(&'a str),
NbrFsmEvent(&'a IpAddr, &'a fsm::Event),
NbrFsmTransition(&'a IpAddr, &'a fsm::State, &'a fsm::State),
NbrMsgRx(&'a IpAddr, &'a Message),
NbrMsgTx(&'a IpAddr, &'a Message),
NbrAttrError(AttrType, AttrError),
}

// Reason why an BGP instance is inactive.
#[derive(Debug)]
pub enum InstanceInactiveReason {
AdminDown,
MissingRouterId,
}

// ===== impl Debug =====

impl<'a> Debug<'a> {
// Log debug message using the tracing API.
pub(crate) fn log(&self) {
match self {
Debug::InstanceCreate
| Debug::InstanceDelete
| Debug::InstanceStart => {
// Parent span(s): bgp-instance
debug!("{}", self);
}
Debug::InstanceStop(reason) => {
// Parent span(s): bgp-instance
debug!(%reason, "{}", self);
}
Debug::InstanceStatusCheck(status) => {
// Parent span(s): bgp-instance
debug!(%status, "{}", self);
}
Debug::NbrFsmEvent(nbr_addr, event) => {
// Parent span(s): bgp-instance
debug_span!("neighbor", %nbr_addr).in_scope(|| {
debug_span!("fsm").in_scope(|| {
debug!(?event, "{}", self);
})
});
}
Debug::NbrFsmTransition(nbr_addr, old_state, new_state) => {
// Parent span(s): bgp-instance
debug_span!("neighbor", %nbr_addr).in_scope(|| {
debug_span!("fsm").in_scope(|| {
debug!(?old_state, ?new_state, "{}", self);
})
});
}
Debug::NbrMsgRx(nbr_addr, msg) => {
// Parent span(s): bgp-instance
debug_span!("neighbor", %nbr_addr).in_scope(|| {
debug_span!("input").in_scope(|| {
let data = serde_json::to_string(&msg).unwrap();
debug!(%data, "{}", self);
})
});
}
Debug::NbrMsgTx(nbr_addr, msg) => {
// Parent span(s): bgp-instance
debug_span!("neighbor", %nbr_addr).in_scope(|| {
debug_span!("output").in_scope(|| {
let data = serde_json::to_string(&msg).unwrap();
debug!(%data, "{}", self);
})
});
}
Debug::NbrAttrError(attr_type, action) => {
// Parent span(s): bgp-instance
debug!(?attr_type, ?action, "{}", self);
}
}
}
}

impl<'a> std::fmt::Display for Debug<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Debug::InstanceCreate => {
write!(f, "instance created")
}
Debug::InstanceDelete => {
write!(f, "instance deleted")
}
Debug::InstanceStart => {
write!(f, "starting instance")
}
Debug::InstanceStop(..) => {
write!(f, "stopping instance")
}
Debug::InstanceStatusCheck(..) => {
write!(f, "checking instance status")
}
Debug::NbrFsmEvent(..) => {
write!(f, "event")
}
Debug::NbrFsmTransition(..) => {
write!(f, "state transition")
}
Debug::NbrMsgRx(..) | Debug::NbrMsgTx(..) => {
write!(f, "message")
}
Debug::NbrAttrError(..) => {
write!(f, "malformed attribute")
}
}
}
}

// ===== impl InstanceInactiveReason =====

impl std::fmt::Display for InstanceInactiveReason {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
InstanceInactiveReason::AdminDown => {
write!(f, "administrative status down")
}
InstanceInactiveReason::MissingRouterId => {
write!(f, "missing router-id")
}
}
}
}
Loading

0 comments on commit 2189ccb

Please sign in to comment.