test/vpp_papi_provider.py

   1 import os
   2 from logging import error
   3 from hook import Hook
   4
   5 do_import = True
   6 try:
   7     no_vpp_papi = os.getenv("NO_VPP_PAPI")
   8     if no_vpp_papi == "1":
   9         do_import = False
  10 except:
  11     pass
  12
  13 if do_import:
  14     import vpp_papi
  15
  16
  17 # from vnet/vnet/mpls/mpls_types.h
  18 MPLS_IETF_MAX_LABEL = 0xfffff
  19 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
  20
  21
  22 class VppPapiProvider(object):
  23     """VPP-api provider using vpp-papi
  24
  25     @property hook: hook object providing before and after api/cli hooks
  26
  27
  28     """
  29
  30     def __init__(self, name, shm_prefix):
  31         self.hook = Hook("vpp-papi-provider")
  32         self.name = name
  33         self.shm_prefix = shm_prefix
  34
  35     def register_hook(self, hook):
  36         """Replace hook registration with new hook
  37
  38         :param hook:
  39
  40         """
  41         self.hook = hook
  42
  43     def connect(self):
  44         """Connect the API to VPP"""
  45         vpp_papi.connect(self.name, self.shm_prefix)
  46
  47     def disconnect(self):
  48         """Disconnect the API from VPP"""
  49         vpp_papi.disconnect()
  50
  51     def api(self, api_fn, api_args, expected_retval=0):
  52         """Call API function and check it's return value
  53         Call the appropriate hooks before and after the API call
  54
  55         :param api_fn: API function to call
  56         :param api_args: tuple of API function arguments
  57         :param expected_retval: Expected return value (Default value = 0)
  58         :returns: reply from the API
  59
  60         """
  61         self.hook.before_api(api_fn.__name__, api_args)
  62         reply = api_fn(*api_args)
  63         if hasattr(reply, 'retval') and reply.retval != expected_retval:
  64             msg = "API call failed, expected retval == %d, got %s" % (
  65                 expected_retval, repr(reply))
  66             error(msg)
  67             raise Exception(msg)
  68         self.hook.after_api(api_fn.__name__, api_args)
  69         return reply
  70
  71     def cli(self, cli):
  72         """Execute a CLI, calling the before/after hooks appropriately
  73
  74         :param cli: CLI to execute
  75         :returns: CLI output
  76
  77         """
  78         self.hook.before_cli(cli)
  79         cli += '\n'
  80         r = vpp_papi.cli_inband(len(cli), cli)
  81         self.hook.after_cli(cli)
  82         if(hasattr(r, 'reply')):
  83             return r.reply[0].decode().rstrip('\x00')
  84
  85     def show_version(self):
  86         """ """
  87         return vpp_papi.show_version()
  88
  89     def pg_create_interface(self, pg_index):
  90         """
  91
  92         :param pg_index:
  93
  94         """
  95         return self.api(vpp_papi.pg_create_interface, (pg_index, ))
  96
  97     def sw_interface_dump(self, filter=None):
  98         """
  99
 100         :param filter:  (Default value = None)
 101
 102         """
 103         if filter is not None:
 104             args = (1, filter)
 105         else:
 106             args = (0, b'')
 107         return self.api(vpp_papi.sw_interface_dump, args)
 108
 109     def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
 110                                      is_ipv6=0, is_add=1, del_all=0):
 111         """
 112
 113         :param addr: param is_ipv6:  (Default value = 0)
 114         :param sw_if_index:
 115         :param addr_len:
 116         :param is_ipv6:  (Default value = 0)
 117         :param is_add:  (Default value = 1)
 118         :param del_all:  (Default value = 0)
 119
 120         """
 121         return self.api(vpp_papi.sw_interface_add_del_address,
 122                         (sw_if_index, is_add, is_ipv6, del_all, addr_len, addr))
 123
 124     def sw_interface_ra_suppress(self, sw_if_index):
 125         suppress = 1
 126         managed = 0
 127         other = 0
 128         ll_option = 0
 129         send_unicast = 0
 130         cease = 0
 131         is_no = 0
 132         default_router = 0
 133         max_interval = 0
 134         min_interval = 0
 135         lifetime = 0
 136         initial_count = 0
 137         initial_interval = 0
 138         async = False
 139         return self.api(vpp_papi.sw_interface_ip6nd_ra_config,
 140                         (sw_if_index, suppress, managed, other,
 141                          ll_option, send_unicast, cease, is_no,
 142                          default_router, max_interval, min_interval,
 143                          lifetime, initial_count, initial_interval, async))
 144
 145     def vxlan_add_del_tunnel(
 146             self,
 147             src_addr,
 148             dst_addr,
 149             is_add=1,
 150             is_ipv6=0,
 151             encap_vrf_id=0,
 152             decap_next_index=0xFFFFFFFF,
 153             vni=0):
 154         """
 155
 156         :param dst_addr:
 157         :param src_addr:
 158         :param is_add:  (Default value = 1)
 159         :param is_ipv6:  (Default value = 0)
 160         :param encap_vrf_id:  (Default value = 0)
 161         :param decap_next_index:  (Default value = 0xFFFFFFFF)
 162         :param vni:  (Default value = 0)
 163
 164         """
 165         return self.api(vpp_papi.vxlan_add_del_tunnel,
 166                         (is_add, is_ipv6, src_addr, dst_addr, encap_vrf_id,
 167                          decap_next_index, vni))
 168
 169     def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
 170                                    shg=0, bvi=0, enable=1):
 171         """
 172
 173         :param bd_id:
 174         :param sw_if_index:
 175         :param shg:  (Default value = 0)
 176         :param bvi:  (Default value = 0)
 177         :param enable:  (Default value = 1)
 178
 179         """
 180         return self.api(vpp_papi.sw_interface_set_l2_bridge,
 181                         (sw_if_index, bd_id, shg, bvi, enable))
 182
 183     def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
 184                                      enable):
 185         """Create or delete unidirectional cross-connect from Tx interface to
 186         Rx interface.
 187
 188         :param rx_sw_if_index: Software interface index of Rx interface.
 189         :param tx_sw_if_index: Software interface index of Tx interface.
 190         :param enable: Create cross-connect if equal to 1, delete cross-connect
 191                        if equal to 0.
 192         :type rx_sw_if_index: str or int
 193         :type rx_sw_if_index: str or int
 194         :type enable: int
 195
 196         """
 197         return self.api(vpp_papi.sw_interface_set_l2_xconnect,
 198                         (rx_sw_if_index, tx_sw_if_index, enable))
 199
 200     def sw_interface_set_flags(self, sw_if_index, admin_up_down,
 201                                link_up_down=0, deleted=0):
 202         """
 203
 204         :param admin_up_down:
 205         :param sw_if_index:
 206         :param link_up_down:  (Default value = 0)
 207         :param deleted:  (Default value = 0)
 208
 209         """
 210         return self.api(vpp_papi.sw_interface_set_flags,
 211                         (sw_if_index, admin_up_down, link_up_down, deleted))
 212
 213     def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
 214                      no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
 215                      default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
 216         """Create subinterface
 217         from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
 218
 219         :param sub_id: param inner_vlan:
 220         :param sw_if_index:
 221         :param outer_vlan:
 222         :param inner_vlan:
 223         :param no_tags:  (Default value = 0)
 224         :param one_tag:  (Default value = 0)
 225         :param two_tags:  (Default value = 0)
 226         :param dot1ad:  (Default value = 0)
 227         :param exact_match:  (Default value = 0)
 228         :param default_sub:  (Default value = 0)
 229         :param outer_vlan_id_any:  (Default value = 0)
 230         :param inner_vlan_id_any:  (Default value = 0)
 231
 232         """
 233         return self.api(
 234             vpp_papi.create_subif,
 235             (sw_if_index,
 236              sub_id,
 237              no_tags,
 238              one_tag,
 239              two_tags,
 240              dot1ad,
 241              exact_match,
 242              default_sub,
 243              outer_vlan_id_any,
 244              inner_vlan_id_any,
 245              outer_vlan,
 246              inner_vlan))
 247
 248     def create_vlan_subif(self, sw_if_index, vlan):
 249         """
 250
 251         :param vlan:
 252         :param sw_if_index:
 253
 254         """
 255         return self.api(vpp_papi.create_vlan_subif, (sw_if_index, vlan))
 256
 257     def ip_add_del_route(
 258             self,
 259             dst_address,
 260             dst_address_length,
 261             next_hop_address,
 262             next_hop_sw_if_index=0xFFFFFFFF,
 263             table_id=0,
 264             resolve_attempts=0,
 265             classify_table_index=0xFFFFFFFF,
 266             next_hop_out_label=MPLS_LABEL_INVALID,
 267             next_hop_table_id=0,
 268             create_vrf_if_needed=0,
 269             resolve_if_needed=0,
 270             is_add=1,
 271             is_drop=0,
 272             is_unreach=0,
 273             is_prohibit=0,
 274             is_ipv6=0,
 275             is_local=0,
 276             is_classify=0,
 277             is_multipath=0,
 278             is_resolve_host=0,
 279             is_resolve_attached=0,
 280             not_last=0,
 281             next_hop_weight=1):
 282         """
 283
 284         :param dst_address_length:
 285         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 286         :param dst_address:
 287         :param next_hop_address:
 288         :param next_hop_sw_if_index:  (Default value = 0xFFFFFFFF)
 289         :param vrf_id:  (Default value = 0)
 290         :param lookup_in_vrf:  (Default value = 0)
 291         :param resolve_attempts:  (Default value = 0)
 292         :param classify_table_index:  (Default value = 0xFFFFFFFF)
 293         :param create_vrf_if_needed:  (Default value = 0)
 294         :param resolve_if_needed:  (Default value = 0)
 295         :param is_add:  (Default value = 1)
 296         :param is_drop:  (Default value = 0)
 297         :param is_ipv6:  (Default value = 0)
 298         :param is_local:  (Default value = 0)
 299         :param is_classify:  (Default value = 0)
 300         :param is_multipath:  (Default value = 0)
 301         :param is_resolve_host:  (Default value = 0)
 302         :param is_resolve_attached:  (Default value = 0)
 303         :param not_last:  (Default value = 0)
 304         :param next_hop_weight:  (Default value = 1)
 305
 306         """
 307         return self.api(
 308             vpp_papi.ip_add_del_route,
 309             (next_hop_sw_if_index,
 310              table_id,
 311              resolve_attempts,
 312              classify_table_index,
 313              next_hop_out_label,
 314              next_hop_table_id,
 315              create_vrf_if_needed,
 316              resolve_if_needed,
 317              is_add,
 318              is_drop,
 319              is_unreach,
 320              is_prohibit,
 321              is_ipv6,
 322              is_local,
 323              is_classify,
 324              is_multipath,
 325              is_resolve_host,
 326              is_resolve_attached,
 327              not_last,
 328              next_hop_weight,
 329              dst_address_length,
 330              dst_address,
 331              next_hop_address))