X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FSRv6.py;h=eca22a2b1744457bd9b4258a9996f38ab3d1cc31;hp=03a55a41ed3acd41f21bfdf4535d5c061e40421c;hb=b6606e7625e308a66bdfb9d5a9c065b58e429a99;hpb=95998a67270ffd72f09ce6f3d43235c723edf36b diff --git a/resources/libraries/python/SRv6.py b/resources/libraries/python/SRv6.py index 03a55a41ed..eca22a2b17 100644 --- a/resources/libraries/python/SRv6.py +++ b/resources/libraries/python/SRv6.py @@ -1,4 +1,4 @@ -# Copyright (c) 2018 Cisco and/or its affiliates. +# Copyright (c) 2021 Cisco and/or its affiliates. # 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: @@ -11,38 +11,75 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Segment Routing over IPv6 dataplane utilities library.""" - -from resources.libraries.python.VatExecutor import VatTerminal -from resources.libraries.python.topology import Topology - - -# SRv6 LocalSID supported functions. -# Endpoint function -SRV6BEHAVIOUR_END = 'end' -# Endpoint function with Layer-3 cross-connect -SRV6BEHAVIOUR_END_X = 'end.x' -# Endpoint with decapsulation and Layer-2 cross-connect -SRV6BEHAVIOUR_END_DX2 = 'end.dx2' -# Endpoint with decapsulation and IPv4 cross-connect -SRV6BEHAVIOUR_END_DX4 = 'end.dx4' -# Endpoint with decapsulation and IPv4 table lookup -SRV6BEHAVIOUR_END_DT4 = 'end.dt4' -# Endpoint with decapsulation and IPv6 cross-connect -SRV6BEHAVIOUR_END_DX6 = 'end.dx6' -# Endpoint with decapsulation and IPv6 table lookup -SRV6BEHAVIOUR_END_DT6 = 'end.dt6' +"""Segment Routing over IPv6 data plane utilities library.""" + +from enum import IntEnum + +from ipaddress import ip_address, IPv6Address + +from resources.libraries.python.Constants import Constants +from resources.libraries.python.InterfaceUtil import InterfaceUtil +from resources.libraries.python.IPAddress import IPAddress +from resources.libraries.python.IPUtil import IPUtil +from resources.libraries.python.PapiExecutor import PapiSocketExecutor + + +class SRv6Behavior(IntEnum): + """SRv6 LocalSID supported functions.""" + # Endpoint function + END = 1 + # Endpoint function with Layer-3 cross-connect + END_X = 2 + # Endpoint with decapsulation and Layer-2 cross-connect + END_DX2 = 5 + # Endpoint with decapsulation and IPv6 cross-connect + END_DX6 = 6 + # Endpoint with decapsulation and IPv4 cross-connect + END_DX4 = 7 + # Endpoint with decapsulation and IPv6 table lookup + END_DT6 = 8 + # Endpoint with decapsulation and IPv4 table lookup + END_DT4 = 9 + # Endpoint to SR-unaware appliance via static proxy + END_AS = 20 + # Endpoint to SR-unaware appliance via dynamic proxy + END_AD = 21 + # Endpoint to SR-unaware appliance via masquerading + END_AM = 22 + + +class SRv6PolicySteeringTypes(IntEnum): + """SRv6 steering types.""" + SR_STEER_L2 = 2 + SR_STEER_IPV4 = 4 + SR_STEER_IPV6 = 6 + + +class SRv6: + """SRv6 class.""" + @staticmethod + def create_srv6_sid_list(sids): + """Create SRv6 SID list object. -class SRv6(object): - """SRv6 class.""" + :param sids: SID IPv6 addresses. + :type sids: list + :returns: SRv6 SID list object. + :rtype: dict + """ + sid_list = [IPv6Address(sid).packed for sid in sids] - def __init__(self): - pass + return dict( + num_sids=len(sid_list), + weight=1, + sids=sid_list + (16 - len(sid_list)) * [IPv6Address(0).packed] + ) @staticmethod - def configure_sr_localsid(node, local_sid, behavior, interface=None, - next_hop=None, fib_table=None): + def configure_sr_localsid( + node, local_sid, behavior, interface=None, next_hop=None, + fib_table=None, out_if=None, in_if=None, src_addr=None, + sid_list=None): """Create SRv6 LocalSID and binds it to a particular behaviour on the given node. @@ -55,63 +92,112 @@ class SRv6(object): xconnects). :param fib_table: FIB table for IPv4/IPv6 lookup (Optional, required for L3 routing). + :param out_if: Interface name of local interface for sending traffic + towards the Service Function (Optional, required for SRv6 endpoint + to SR-unaware appliance). + :param in_if: Interface name of local interface receiving the traffic + coming back from the Service Function (Optional, required for SRv6 + endpoint to SR-unaware appliance). + :param src_addr: Source address on the packets coming back on in_if + interface (Optional, required for SRv6 endpoint to SR-unaware + appliance via static proxy). + :param sid_list: SID list (Optional, required for SRv6 endpoint to + SR-unaware appliance via static proxy). :type node: dict :type local_sid: str :type behavior: str :type interface: str - :type next_hop: int + :type next_hop: str :type fib_table: str - :raises ValueError: If unsupported SRv6 LocalSID function used or - required parameter is missing. + :type out_if: str + :type in_if: str + :type src_addr: str + :type sid_list: list + :raises ValueError: If required parameter is missing. """ - if behavior == SRV6BEHAVIOUR_END: - params = '' - elif behavior in [SRV6BEHAVIOUR_END_X, SRV6BEHAVIOUR_END_DX4, - SRV6BEHAVIOUR_END_DX6]: + beh = behavior.replace(u".", u"_").upper() + # There is no SRv6Behaviour enum defined for functions from SRv6 plugins + # so we need to use CLI command to configure it. + if beh in (getattr(SRv6Behavior, u"END_AD").name, + getattr(SRv6Behavior, u"END_AS").name, + getattr(SRv6Behavior, u"END_AM").name): + if beh == getattr(SRv6Behavior, u"END_AS").name: + if next_hop is None or out_if is None or in_if is None or \ + src_addr is None or sid_list is None: + raise ValueError( + f"Required parameter(s) missing.\n" + f"next_hop:{next_hop}\n " + f"out_if:{out_if}\n" + f"in_if:{in_if}\n" + f"src_addr:{src_addr}\n" + f"sid_list:{sid_list}" + ) + sid_conf = f"next {u' next '.join(sid_list)}" + params = f"nh {next_hop} oif {out_if} iif {in_if} " \ + f"src {src_addr} {sid_conf}" + else: + if next_hop is None or out_if is None or in_if is None: + raise ValueError( + f"Required parameter(s) missing.\n" + f"next_hop:{next_hop}\n" + f"out_if:{out_if}\n" + f"in_if:{in_if}" + ) + params = f"nh {next_hop} oif {out_if} iif {in_if}" + + cli_cmd = f"sr localsid address {local_sid} behavior {behavior} " \ + f"{params}" + + PapiSocketExecutor.run_cli_cmd(node, cli_cmd) + return + + cmd = u"sr_localsid_add_del" + args = dict( + is_del=False, + localsid=IPv6Address(local_sid).packed, + end_psp=False, + behavior=getattr(SRv6Behavior, beh).value, + sw_if_index=Constants.BITWISE_NON_ZERO, + vlan_index=0, + fib_table=0, + nh_addr=0 + ) + err_msg = f"Failed to add SR localSID {local_sid} " \ + f"host {node[u'host']}" + if beh in (getattr(SRv6Behavior, u"END_X").name, + getattr(SRv6Behavior, u"END_DX4").name, + getattr(SRv6Behavior, u"END_DX6").name): if interface is None or next_hop is None: - raise ValueError('Required data missing.\ninterface:{0}\n' - 'next_hop:{1}'.format(interface, next_hop)) - interface_name = Topology.get_interface_name(node, interface) - params = '{0} {1}'.format(interface_name, next_hop) - elif behavior == SRV6BEHAVIOUR_END_DX2: + raise ValueError( + f"Required parameter(s) missing.\n" + f"interface:{interface}\n" + f"next_hop:{next_hop}" + ) + args[u"sw_if_index"] = InterfaceUtil.get_interface_index( + node, interface + ) + args[u"nh_addr"] = IPAddress.create_ip_address_object( + ip_address(next_hop) + ) + elif beh == getattr(SRv6Behavior, u"END_DX2").name: if interface is None: - raise ValueError('Required data missing.\ninterface:{0}\n'. - format(interface)) - params = '{0}'.format(interface) - elif behavior in [SRV6BEHAVIOUR_END_DT4, SRV6BEHAVIOUR_END_DT6]: + raise ValueError( + f"Required parameter missing.\ninterface: {interface}" + ) + args[u"sw_if_index"] = InterfaceUtil.get_interface_index( + node, interface + ) + elif beh in (getattr(SRv6Behavior, u"END_DT4").name, + getattr(SRv6Behavior, u"END_DT6").name): if fib_table is None: - raise ValueError('Required data missing.\nfib_table:{0}\n'. - format(fib_table)) - params = '{0}'.format(fib_table) - else: - raise ValueError('Unsupported SRv6 LocalSID function: {0}'. - format(behavior)) + raise ValueError( + f"Required parameter missing.\n" + f"fib_table: {fib_table}" + ) + args[u"fib_table"] = fib_table - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template( - 'srv6/sr_localsid_add.vat', local_sid=local_sid, - behavior=behavior, params=params) - - if "exec error: Misc" in vat.vat_stdout: - raise RuntimeError('Create SRv6 LocalSID {0} failed on node {1}'. - format(local_sid, node['host'])) - - @staticmethod - def delete_sr_localsid(node, local_sid): - """Delete SRv6 LocalSID on the given node. - - :param node: Given node to delete localSID on. - :param local_sid: LocalSID IPv6 address. - :type node: dict - :type local_sid: str - """ - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template( - 'srv6/sr_localsid_del.vat', local_sid=local_sid) - - if "exec error: Misc" in vat.vat_stdout: - raise RuntimeError('Delete SRv6 LocalSID {0} failed on node {1}'. - format(local_sid, node['host'])) + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) @staticmethod def show_sr_localsids(node): @@ -120,12 +206,11 @@ class SRv6(object): :param node: Given node to show localSIDs on. :type node: dict """ - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template( - 'srv6/sr_localsids_show.vat') + cmd = u"sr_localsids_dump" + PapiSocketExecutor.dump_and_log(node, (cmd,)) @staticmethod - def configure_sr_policy(node, bsid, sid_list, mode='encap'): + def configure_sr_policy(node, bsid, sid_list, mode=u"encap"): """Create SRv6 policy on the given node. :param node: Given node to create SRv6 policy on. @@ -137,33 +222,19 @@ class SRv6(object): :type sid_list: list :type mode: str """ - sid_conf = 'next ' + ' next '.join(sid_list) - - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template( - 'srv6/sr_policy_add.vat', bsid=bsid, - sid_conf=sid_conf, mode=mode) - - if "exec error: Misc" in vat.vat_stdout: - raise RuntimeError('Create SRv6 policy for BindingSID {0} failed on' - ' node {1}'.format(bsid, node['host'])) - - @staticmethod - def delete_sr_policy(node, bsid): - """Delete SRv6 policy on the given node. - - :param node: Given node to delete SRv6 policy on. - :param bsid: BindingSID IPv6 address. - :type node: dict - :type bsid: str - """ - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template( - 'srv6/sr_policy_del.vat', bsid=bsid) - - if "exec error: Misc" in vat.vat_stdout: - raise RuntimeError('Delete SRv6 policy for BindingSID {0} failed on' - ' node {1}'.format(bsid, node['host'])) + cmd = u"sr_policy_add" + args = dict( + bsid_addr=IPv6Address(bsid).packed, + weight=1, + is_encap=bool(mode == u"encap"), + is_spray=False, + sids=SRv6.create_srv6_sid_list(sid_list) + ) + err_msg = f"Failed to add SR policy for BindingSID {bsid} " \ + f"on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) @staticmethod def show_sr_policies(node): @@ -172,18 +243,17 @@ class SRv6(object): :param node: Given node to show SRv6 policies on. :type node: dict """ - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template( - 'srv6/sr_policies_show.vat') + cmd = u"sr_policies_dump" + PapiSocketExecutor.dump_and_log(node, (cmd,)) @staticmethod - def configure_sr_steer(node, mode, bsid, interface=None, ip_addr=None, - prefix=None): - """Create SRv6 steering policy on the given node. + def _get_sr_steer_policy_args( + node, mode, interface=None, ip_addr=None, prefix=None): + """Return values of sw_if_index, mask_width, prefix_addr and + traffic_type for sr_steering_add_del API. - :param node: Given node to create steering policy on. + :param node: Given node to create/delete steering policy on. :param mode: Mode of operation - L2 or L3. - :param bsid: BindingSID - local SID IPv6 address. :param interface: Interface name (Optional, required in case of L2 mode). :param ip_addr: IPv4/IPv6 address (Optional, required in case of L3 @@ -192,79 +262,88 @@ class SRv6(object): mode). :type node: dict :type mode: str - :type bsid: str :type interface: str :type ip_addr: str :type prefix: int + :returns: Values for sw_if_index, prefix and traffic_type + :rtype: tuple :raises ValueError: If unsupported mode used or required parameter is missing. """ - if mode.lower() == 'l2': + if mode.lower() == u"l2": if interface is None: - raise ValueError('Required data missing.\ninterface:{0}\n'. - format(interface)) - interface_name = Topology.get_interface_name(node, interface) - params = 'l2 {0}'.format(interface_name) - elif mode.lower() == 'l3': + raise ValueError( + f"Required data missing.\n" + f"interface: {interface}" + ) + sw_if_index = InterfaceUtil.get_interface_index(node, interface) + prefix = 0 + traffic_type = getattr( + SRv6PolicySteeringTypes, u"SR_STEER_L2" + ).value + elif mode.lower() == u"l3": if ip_addr is None or prefix is None: - raise ValueError('Required data missing.\nIP address:{0}\n' - 'mask:{1}'.format(ip_addr, prefix)) - params = 'l3 {0}/{1}'.format(ip_addr, prefix) + raise ValueError( + f"Required data missing.\n" + f"IP address:{ip_addr}\n" + f"mask:{prefix}" + ) + sw_if_index = Constants.BITWISE_NON_ZERO + ip_addr = ip_address(ip_addr) + prefix = IPUtil.create_prefix_object(ip_addr, int(prefix)) + traffic_type = getattr( + SRv6PolicySteeringTypes, u"SR_STEER_IPV4" + ).value if ip_addr.version == 4 else getattr( + SRv6PolicySteeringTypes, u"SR_STEER_IPV6" + ).value else: - raise ValueError('Unsupported mode: {0}'.format(mode)) - - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template( - 'srv6/sr_steer_add_del.vat', params=params, bsid=bsid) + raise ValueError(f"Unsupported mode: {mode}") - if "exec error: Misc" in vat.vat_stdout: - raise RuntimeError('Create SRv6 steering policy for BindingSID {0}' - ' failed on node {1}'.format(bsid, node['host'])) + return sw_if_index, prefix, traffic_type + # TODO: Bring L1 names, arguments and defaults closer to PAPI ones. @staticmethod - def delete_sr_steer(node, mode, bsid, interface=None, ip_addr=None, - mask=None): - """Delete SRv6 steering policy on the given node. + def configure_sr_steer( + node, mode, bsid, interface=None, ip_addr=None, prefix=None): + """Create SRv6 steering policy on the given node. - :param node: Given node to delete steering policy on. + :param node: Given node to create steering policy on. :param mode: Mode of operation - L2 or L3. :param bsid: BindingSID - local SID IPv6 address. :param interface: Interface name (Optional, required in case of L2 mode). :param ip_addr: IPv4/IPv6 address (Optional, required in case of L3 mode). - :param mask: IP address mask (Optional, required in case of L3 mode). + :param prefix: IP address prefix (Optional, required in case of L3 + mode). :type node: dict :type mode: str :type bsid: str :type interface: str - :type ip_addr: int - :type mask: int + :type ip_addr: str + :type prefix: int :raises ValueError: If unsupported mode used or required parameter is missing. """ - params = 'del' - if mode == 'l2': - if interface is None: - raise ValueError('Required data missing.\ninterface:{0}\n'. - format(interface)) - interface_name = Topology.get_interface_name(node, interface) - params += 'l2 {0}'.format(interface_name) - elif mode == 'l3': - if ip_addr is None or mask is None: - raise ValueError('Required data missing.\nIP address:{0}\n' - 'mask:{1}'.format(ip_addr, mask)) - params += '{0}/{1}'.format(ip_addr, mask) - else: - raise ValueError('Unsupported mode: {0}'.format(mode)) - - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template( - 'srv6/sr_steer_add_del.vat', params=params, bsid=bsid) - - if "exec error: Misc" in vat.vat_stdout: - raise RuntimeError('Delete SRv6 policy for bsid {0} failed on node' - ' {1}'.format(bsid, node['host'])) + sw_if_index, prefix, traffic_type = SRv6._get_sr_steer_policy_args( + node, mode, interface, ip_addr, prefix + ) + + cmd = u"sr_steering_add_del" + args = dict( + is_del=False, + bsid_addr=IPv6Address(str(bsid)).packed, + sr_policy_index=0, + table_id=0, + prefix=prefix, + sw_if_index=sw_if_index, + traffic_type=traffic_type + ) + err_msg = f"Failed to add SRv6 steering policy for BindingSID {bsid} " \ + f"on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) @staticmethod def show_sr_steering_policies(node): @@ -273,9 +352,8 @@ class SRv6(object): :param node: Given node to show SRv6 steering policies on. :type node: dict """ - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template( - 'srv6/sr_steer_policies_show.vat') + cmd = u"sr_steering_pol_dump" + PapiSocketExecutor.dump_and_log(node, (cmd,)) @staticmethod def set_sr_encaps_source_address(node, ip6_addr): @@ -286,6 +364,12 @@ class SRv6(object): :type node: dict :type ip6_addr: str """ - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template( - 'srv6/sr_set_encaps_source.vat', ip6_addr=ip6_addr) + cmd = u"sr_set_encap_source" + args = dict( + encaps_source=IPv6Address(ip6_addr).packed + ) + err_msg = f"Failed to set SRv6 encapsulation source address " \ + f"{ip6_addr} on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg)