Skip to content

Commit

Permalink
bgp: add skeleton code
Browse files Browse the repository at this point in the history
Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
  • Loading branch information
rwestphal committed Nov 10, 2023
1 parent 521975f commit 1704b04
Show file tree
Hide file tree
Showing 35 changed files with 8,390 additions and 2 deletions.
1 change: 1 addition & 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
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,31 @@ 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 4456 - BGP Route Reflection: An Alternative to Full Mesh Internal BGP (IBGP)
* RFC 4486 - Subcodes for BGP Cease Notification Message
* RFC 4760 - Multiprotocol Extensions for BGP-4
* 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 7313 - Enhanced Route Refresh Capability for BGP-4
* 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 +217,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
43 changes: 43 additions & 0 deletions holo-bgp/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[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
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
socket2.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"] }

[features]
default = []
testing = []
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.
85 changes: 85 additions & 0 deletions holo-bgp/src/debug.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
//
// Copyright (c) The Holo Core Contributors
//
// SPDX-License-Identifier: MIT
//

use tracing::debug;

// BGP debug messages.
#[derive(Debug)]
pub enum Debug<'a> {
InstanceCreate,
InstanceDelete,
InstanceStart,
InstanceStop(InstanceInactiveReason),
InstanceStatusCheck(&'a str),
}

// 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);
}
}
}
}

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")
}
}
}
}

// ===== 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")
}
}
}
}
141 changes: 141 additions & 0 deletions holo-bgp/src/error.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
//
// Copyright (c) The Holo Core Contributors
//
// SPDX-License-Identifier: MIT
//

use serde::{Deserialize, Serialize};
use tracing::{error, warn};

// BGP errors.
#[derive(Debug, Deserialize, Serialize)]
pub enum Error {
// I/O errors
#[serde(skip)]
IoError(IoError),
InstanceStartError(Box<Error>),
}

// BGP I/O errors.
#[derive(Debug)]
pub enum IoError {
TcpSocketError(std::io::Error),
TcpAcceptError(std::io::Error),
TcpConnectError(std::io::Error),
TcpInfoError(std::io::Error),
TcpAuthError(std::io::Error),
TcpRecvError(std::io::Error),
TcpSendError(std::io::Error),
}

// ===== impl Error =====

impl Error {
pub(crate) fn log(&self) {
match self {
Error::IoError(error) => {
error.log();
}
Error::InstanceStartError(error) => {
error!(error = %with_source(error), "{}", self);
}
}
}
}

impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Error::IoError(error) => error.fmt(f),
Error::InstanceStartError(..) => {
write!(f, "failed to start instance")
}
}
}
}

impl std::error::Error for Error {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
Error::IoError(error) => Some(error),
Error::InstanceStartError(error) => Some(error),
//_ => None,
}
}
}

impl From<IoError> for Error {
fn from(error: IoError) -> Error {
Error::IoError(error)
}
}

// ===== impl IoError =====

impl IoError {
pub(crate) fn log(&self) {
match self {
IoError::TcpSocketError(error)
| IoError::TcpAcceptError(error)
| IoError::TcpConnectError(error)
| IoError::TcpAuthError(error)
| IoError::TcpInfoError(error)
| IoError::TcpRecvError(error)
| IoError::TcpSendError(error) => {
warn!(error = %with_source(error), "{}", self);
}
}
}
}

impl std::fmt::Display for IoError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
IoError::TcpSocketError(..) => {
write!(f, "failed to create TCP socket")
}
IoError::TcpAcceptError(..) => {
write!(f, "failed to accept connection request")
}
IoError::TcpConnectError(..) => {
write!(f, "failed to establish TCP connection")
}
IoError::TcpAuthError(..) => {
write!(f, "failed to set TCP authentication option")
}
IoError::TcpInfoError(..) => {
write!(f, "failed to fetch address and port information from the socket")
}
IoError::TcpRecvError(..) => {
write!(f, "failed to read TCP data")
}
IoError::TcpSendError(..) => {
write!(f, "failed to send TCP data")
}
}
}
}

impl std::error::Error for IoError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
IoError::TcpSocketError(error)
| IoError::TcpAcceptError(error)
| IoError::TcpConnectError(error)
| IoError::TcpAuthError(error)
| IoError::TcpInfoError(error)
| IoError::TcpRecvError(error)
| IoError::TcpSendError(error) => Some(error),
}
}
}

// ===== global functions =====

fn with_source<E: std::error::Error>(error: E) -> String {
if let Some(source) = error.source() {
format!("{} ({})", error, with_source(source))
} else {
error.to_string()
}
}
15 changes: 15 additions & 0 deletions holo-bgp/src/events.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
//
// Copyright (c) The Holo Core Contributors
//
// SPDX-License-Identifier: MIT
//

use holo_utils::socket::TcpStream;

use crate::instance::Instance;

// ===== TCP connection request =====

pub(crate) fn process_tcp_accept(_instance: &mut Instance, _stream: TcpStream) {
// TODO
}
Loading

0 comments on commit 1704b04

Please sign in to comment.