BGPSpeaker/info_base: Add tables for IPv6 Flow Spec

Signed-off-by: Satoshi Fujimoto <satoshi.fujimoto7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>

3 files changed, 219 insertions, 0 deletions

diff --git a/ryu/services/protocols/bgp/info_base/ipv6fs.py b/ryu/services/protocols/bgp/info_base/ipv6fs.py
new file mode 100644
index 00000000..6a51c923
--- /dev/null
+++ b/ryu/services/protocols/bgp/info_base/ipv6fs.py
@@ -0,0 +1,93 @@
+# Copyright (C) 2017 Nippon Telegraph and Telephone Corporation.
+#
+# 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.
+
+"""
+ Defines data types and models required specifically
+ for Ipv6 Flow Specification support.
+"""
+
+import logging
+
+from ryu.lib.packet.bgp import FlowSpecIPv6NLRI
+from ryu.lib.packet.bgp import RF_IPv6_FLOWSPEC
+
+from ryu.services.protocols.bgp.info_base.base import Path
+from ryu.services.protocols.bgp.info_base.base import Table
+from ryu.services.protocols.bgp.info_base.base import Destination
+from ryu.services.protocols.bgp.info_base.base import NonVrfPathProcessingMixin
+
+LOG = logging.getLogger('bgpspeaker.info_base.ipv6fs')
+
+
+class IPv6FlowSpecDest(Destination, NonVrfPathProcessingMixin):
+    """IPv6 Flow Specification Destination
+
+    Store Flow Specification Paths.
+    """
+    ROUTE_FAMILY = RF_IPv6_FLOWSPEC
+
+    def _best_path_lost(self):
+        old_best_path = self._best_path
+        NonVrfPathProcessingMixin._best_path_lost(self)
+        self._core_service._signal_bus.best_path_changed(old_best_path, True)
+
+    def _new_best_path(self, best_path):
+        NonVrfPathProcessingMixin._new_best_path(self, best_path)
+        self._core_service._signal_bus.best_path_changed(best_path, False)
+
+
+class IPv6FlowSpecTable(Table):
+    """Global table to store IPv6 Flow Specification routing information.
+
+    Uses `FlowSpecIpv6Dest` to store destination information for each known
+    Flow Specification paths.
+    """
+    ROUTE_FAMILY = RF_IPv6_FLOWSPEC
+    VPN_DEST_CLASS = IPv6FlowSpecDest
+
+    def __init__(self, core_service, signal_bus):
+        super(IPv6FlowSpecTable, self).__init__(None, core_service, signal_bus)
+
+    def _table_key(self, nlri):
+        """Return a key that will uniquely identify this NLRI inside
+        this table.
+        """
+        return nlri.prefix
+
+    def _create_dest(self, nlri):
+        return self.VPN_DEST_CLASS(self, nlri)
+
+    def __str__(self):
+        return '%s(scope_id: %s, rf: %s)' % (
+            self.__class__.__name__, self.scope_id, self.route_family
+        )
+
+
+class IPv6FlowSpecPath(Path):
+    """Represents a way of reaching an IPv6 Flow Specification destination."""
+    ROUTE_FAMILY = RF_IPv6_FLOWSPEC
+    VRF_PATH_CLASS = None  # defined in init - anti cyclic import hack
+    NLRI_CLASS = FlowSpecIPv6NLRI
+
+    def __init__(self, *args, **kwargs):
+        # Set dummy IP address.
+        kwargs['nexthop'] = '::'
+        super(IPv6FlowSpecPath, self).__init__(*args, **kwargs)
+        from ryu.services.protocols.bgp.info_base.vrf6fs import (
+            Vrf6FlowSpecPath)
+        self.VRF_PATH_CLASS = Vrf6FlowSpecPath
+        # Because the IPv6 Flow Specification does not require nexthop,
+        # initialize with None.
+        self._nexthop = None
diff --git a/ryu/services/protocols/bgp/info_base/vpnv6fs.py b/ryu/services/protocols/bgp/info_base/vpnv6fs.py
new file mode 100644
index 00000000..8f2a5dc3
--- /dev/null
+++ b/ryu/services/protocols/bgp/info_base/vpnv6fs.py
@@ -0,0 +1,66 @@
+# Copyright (C) 2017 Nippon Telegraph and Telephone Corporation.
+#
+# 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.
+
+"""
+ Defines data types and models required specifically for
+ VPNv6 Flow Specification support.
+"""
+
+import logging
+
+from ryu.lib.packet.bgp import FlowSpecVPNv6NLRI
+from ryu.lib.packet.bgp import RF_VPNv6_FLOWSPEC
+
+from ryu.services.protocols.bgp.info_base.vpn import VpnDest
+from ryu.services.protocols.bgp.info_base.vpn import VpnPath
+from ryu.services.protocols.bgp.info_base.vpn import VpnTable
+
+LOG = logging.getLogger('bgpspeaker.info_base.vpnv6fs')
+
+
+class VPNv6FlowSpecDest(VpnDest):
+    """VPNv6 Flow Specification Destination
+
+    Store Flow Specification Paths.
+    """
+    ROUTE_FAMILY = RF_VPNv6_FLOWSPEC
+
+
+class VPNv6FlowSpecTable(VpnTable):
+    """Global table to store VPNv6 Flow Specification routing information.
+
+    Uses `VPNv6FlowSpecDest` to store destination information for each known
+    Flow Specification paths.
+    """
+    ROUTE_FAMILY = RF_VPNv6_FLOWSPEC
+    VPN_DEST_CLASS = VPNv6FlowSpecDest
+
+
+class VPNv6FlowSpecPath(VpnPath):
+    """Represents a way of reaching an VPNv6 Flow Specification destination."""
+    ROUTE_FAMILY = RF_VPNv6_FLOWSPEC
+    VRF_PATH_CLASS = None  # defined in init - anti cyclic import hack
+    NLRI_CLASS = FlowSpecVPNv6NLRI
+
+    def __init__(self, *args, **kwargs):
+        # Set dummy IP address.
+        kwargs['nexthop'] = '::'
+        super(VPNv6FlowSpecPath, self).__init__(*args, **kwargs)
+        from ryu.services.protocols.bgp.info_base.vrf6fs import(
+            Vrf6FlowSpecPath)
+        self.VRF_PATH_CLASS = Vrf6FlowSpecPath
+        # Because the IPv6 Flow Specification does not require nexthop,
+        # initialize with None.
+        self._nexthop = None
diff --git a/ryu/services/protocols/bgp/info_base/vrf6fs.py b/ryu/services/protocols/bgp/info_base/vrf6fs.py
new file mode 100644
index 00000000..17b8ce57
--- /dev/null
+++ b/ryu/services/protocols/bgp/info_base/vrf6fs.py
@@ -0,0 +1,60 @@
+# Copyright (C) 2017 Nippon Telegraph and Telephone Corporation.
+#
+# 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.
+
+"""
+ Defines data types and models required specifically
+ for VRF (for IPv6 Flow Specification) support.
+ Represents data structures for VRF not VPN/global.
+ (Inside VRF you have IPv6 Flow Specification prefixes
+ and inside VPN you have VPNV6 Flow Specification prefixes)
+"""
+
+import logging
+
+from ryu.lib.packet.bgp import RF_IPv6_FLOWSPEC
+from ryu.lib.packet.bgp import RF_VPNv6_FLOWSPEC
+from ryu.lib.packet.bgp import FlowSpecIPv6NLRI
+from ryu.lib.packet.bgp import FlowSpecVPNv6NLRI
+
+from ryu.services.protocols.bgp.info_base.vpnv6fs import VPNv6FlowSpecPath
+from ryu.services.protocols.bgp.info_base.vrffs import VRFFlowSpecDest
+from ryu.services.protocols.bgp.info_base.vrffs import VRFFlowSpecPath
+from ryu.services.protocols.bgp.info_base.vrffs import VRFFlowSpecTable
+
+LOG = logging.getLogger('bgpspeaker.info_base.vrf6fs')
+
+
+class Vrf6FlowSpecPath(VRFFlowSpecPath):
+    """Represents a way of reaching an IP destination with
+    a VPN Flow Specification.
+    """
+    ROUTE_FAMILY = RF_IPv6_FLOWSPEC
+    VPN_PATH_CLASS = VPNv6FlowSpecPath
+    VPN_NLRI_CLASS = FlowSpecVPNv6NLRI
+
+
+class Vrf6FlowSpecDest(VRFFlowSpecDest):
+    ROUTE_FAMILY = RF_IPv6_FLOWSPEC
+
+
+class Vrf6FlowSpecTable(VRFFlowSpecTable):
+    """Virtual Routing and Forwarding information base
+    for IPv6 Flow Specification.
+    """
+    ROUTE_FAMILY = RF_IPv6_FLOWSPEC
+    VPN_ROUTE_FAMILY = RF_VPNv6_FLOWSPEC
+    NLRI_CLASS = FlowSpecIPv6NLRI
+    VRF_PATH_CLASS = Vrf6FlowSpecPath
+    VRF_DEST_CLASS = Vrf6FlowSpecDest