test/vpp_papi_provider.py

   1 # NB NB NB NB NB NB NB NB NB NB NB
   2 #
   3 # NOTE: The API binary wrappers in this file are in the process of being
   4 # deprecated. DO NOT ADD NEW WRAPPERS HERE. Call the functions using
   5 # named arguments directly instead.
   6 #
   7
   8 import os
   9 import time
  10 from collections import deque
  11
  12 from six import moves, iteritems
  13 from vpp_papi import VPPApiClient, mac_pton
  14 from hook import Hook
  15 from vpp_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID
  16
  17
  18 #
  19 # Dictionary keyed on message name to override default values for
  20 # named parameters
  21 #
  22 defaultmapping = {
  23
  24     'acl_interface_add_del': {'is_add': 1, 'is_input': 1},
  25     'bd_ip_mac_add_del': {'is_add': 1, },
  26     'bfd_udp_add': {'is_authenticated': False, 'bfd_key_id': None,
  27                     'conf_key_id': None},
  28     'bfd_udp_auth_activate': {'bfd_key_id': None, 'conf_key_id': None,
  29                               'is_delayed': False},
  30     'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1,
  31                                 'is_add': 1, },
  32     'bier_disp_table_add_del': {'is_add': 1, },
  33     'bier_imp_add': {'is_add': 1, },
  34     'bier_route_add_del': {'is_add': 1, },
  35     'bier_table_add_del': {'is_add': 1, },
  36     'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1,
  37                               'learn': 1, 'is_add': 1, },
  38     'bvi_delete': {},
  39     'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, },
  40     'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
  41                               'decap_next_index': 4294967295, },
  42     'input_acl_set_interface': {'ip4_table_index': 4294967295,
  43                                 'ip6_table_index': 4294967295,
  44                                 'l2_table_index': 4294967295, },
  45     'ip6_add_del_address_using_prefix': {'is_add': 1, },
  46     'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, },
  47     'ip_add_del_route': {'next_hop_sw_if_index': 4294967295,
  48                          'next_hop_weight': 1, 'next_hop_via_label': 1048576,
  49                          'classify_table_index': 4294967295, 'is_add': 1, },
  50     'ip_mroute_add_del': {'is_add': 1, },
  51     'ip_neighbor_add_del': {'is_add': 1, },
  52     'ip_route_add_del': {'is_add': 1, },
  53     'ipsec_interface_add_del_spd': {'is_add': 1, },
  54     'ipsec_spd_add_del': {'is_add': 1, },
  55     'ipsec_spd_dump': {'sa_id': 4294967295, },
  56     'ipsec_spd_entry_add_del': {'local_port_stop': 65535,
  57                                 'remote_port_stop': 65535, 'priority': 100,
  58                                 'is_outbound': 1,
  59                                 'is_add': 1, },
  60     'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, },
  61     'l2_emulation': {'enable': 1, },
  62     'l2fib_add_del': {'is_add': 1, },
  63     'lisp_add_del_adjacency': {'is_add': 1, },
  64     'lisp_add_del_local_eid': {'is_add': 1, },
  65     'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, },
  66     'lisp_add_del_locator_set': {'is_add': 1, },
  67     'lisp_add_del_remote_mapping': {'is_add': 1, },
  68     'macip_acl_interface_add_del': {'is_add': 1, },
  69     'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, },
  70     'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295,
  71                            'mr_next_hop_weight': 1,
  72                            'mr_next_hop_via_label': 1048576,
  73                            'mr_is_add': 1,
  74                            'mr_classify_table_index': 4294967295, },
  75     'mpls_table_add_del': {'is_add': 1, },
  76     'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295,
  77                             'next_hop_weight': 1,
  78                             'next_hop_via_label': 1048576,
  79                             'is_add': 1, },
  80     'output_acl_set_interface': {'ip4_table_index': 4294967295,
  81                                  'ip6_table_index': 4294967295,
  82                                  'l2_table_index': 4294967295, },
  83     'pppoe_add_del_session': {'is_add': 1, },
  84     'policer_add_del': {'is_add': 1, 'conform_action': {'type': 1}, },
  85     'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1,
  86                          'proto': 1, },
  87     'set_ipfix_exporter': {'collector_port': 4739, },
  88     'sr_policy_add': {'weight': 1, 'is_encap': 1, },
  89     'sw_interface_add_del_address': {'is_add': 1, },
  90     'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295,
  91                                      'pref_lifetime': 4294967295, },
  92     'sw_interface_set_ip_directed_broadcast': {'enable': 1, },
  93     'sw_interface_set_l2_bridge': {'enable': 1, },
  94     'sw_interface_set_mpls_enable': {'enable': 1, },
  95     'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], },
  96     'sw_interface_set_unnumbered': {'is_add': 1, },
  97     'sw_interface_span_enable_disable': {'state': 1, },
  98     'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
  99                              'decap_next_index': 4294967295,
 100                              'instance': 4294967295, },
 101     'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1,
 102                                  'protocol': 3, },
 103     'want_bfd_events': {'enable_disable': 1, },
 104     'want_igmp_events': {'enable': 1, },
 105     'want_interface_events': {'enable_disable': 1, },
 106     'want_l2_macs_events': {'enable_disable': 1, 'pid': os.getpid(), },
 107     'want_l2_macs_events2': {'enable_disable': 1, 'pid': os.getpid(), },
 108 }
 109
 110
 111 def as_fn_signature(d):
 112     return ", ".join(f"{k}={v}" for k, v in d.items())
 113
 114
 115 class CliFailedCommandError(Exception):
 116     """ cli command failed."""
 117
 118
 119 class CliSyntaxError(Exception):
 120     """ cli command had a syntax error."""
 121
 122
 123 class UnexpectedApiReturnValueError(Exception):
 124     """ exception raised when the API return value is unexpected """
 125     pass
 126
 127
 128 class VppPapiProvider(object):
 129     """VPP-api provider using vpp-papi
 130
 131     @property hook: hook object providing before and after api/cli hooks
 132     """
 133
 134     _zero, _negative = range(2)
 135
 136     def __init__(self, name, shm_prefix, test_class, read_timeout):
 137         self.hook = Hook(test_class)
 138         self.name = name
 139         self.shm_prefix = shm_prefix
 140         self.test_class = test_class
 141         self._expect_api_retval = self._zero
 142         self._expect_stack = []
 143
 144         # install_dir is a class attribute. We need to set it before
 145         # calling the constructor.
 146         VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH')
 147
 148         use_socket = False
 149         try:
 150             if os.environ['SOCKET'] == '1':
 151                 use_socket = True
 152         except KeyError:
 153             pass
 154
 155         self.vpp = VPPApiClient(logger=test_class.logger,
 156                                 read_timeout=read_timeout,
 157                                 use_socket=use_socket,
 158                                 server_address=test_class.api_sock)
 159         self._events = deque()
 160
 161     def __enter__(self):
 162         return self
 163
 164     def assert_negative_api_retval(self):
 165         """ Expect API failure - used with with, e.g.:
 166             with self.vapi.assert_negative_api_retval():
 167                 self.vapi.<api call expected to fail>
 168         """
 169         self._expect_stack.append(self._expect_api_retval)
 170         self._expect_api_retval = self._negative
 171         return self
 172
 173     def assert_zero_api_retval(self):
 174         """ Expect API success - used with with, e.g.:
 175             with self.vapi.assert_negative_api_retval():
 176                 self.vapi.<api call expected to succeed>
 177
 178             note: this is useful only inside another with block
 179                   as success is the default expected value
 180         """
 181         self._expect_stack.append(self._expect_api_retval)
 182         self._expect_api_retval = self._zero
 183         return self
 184
 185     def __exit__(self, exc_type, exc_value, traceback):
 186         self._expect_api_retval = self._expect_stack.pop()
 187
 188     def register_hook(self, hook):
 189         """Replace hook registration with new hook
 190
 191         :param hook:
 192
 193         """
 194         self.hook = hook
 195
 196     def collect_events(self):
 197         """ Collect all events from the internal queue and clear the queue. """
 198         e = self._events
 199         self._events = deque()
 200         return e
 201
 202     def wait_for_event(self, timeout, name=None):
 203         """ Wait for and return next event. """
 204         if name:
 205             self.test_class.logger.debug("Expecting event '%s' within %ss",
 206                                          name, timeout)
 207         else:
 208             self.test_class.logger.debug("Expecting event within %ss",
 209                                          timeout)
 210         if self._events:
 211             self.test_class.logger.debug("Not waiting, event already queued")
 212         limit = time.time() + timeout
 213         while time.time() < limit:
 214             if self._events:
 215                 e = self._events.popleft()
 216                 if name and type(e).__name__ != name:
 217                     raise Exception(
 218                         "Unexpected event received: %s, expected: %s" %
 219                         (type(e).__name__, name))
 220                 self.test_class.logger.debug("Returning event %s:%s" %
 221                                              (name, e))
 222                 return e
 223             self.test_class.sleep(0)  # yield
 224         raise Exception("Event did not occur within timeout")
 225
 226     def __call__(self, name, event):
 227         """ Enqueue event in the internal event queue. """
 228         # FIXME use the name instead of relying on type(e).__name__ ?
 229         # FIXME #2 if this throws, it is eaten silently, Ole?
 230         self.test_class.logger.debug("New event: %s: %s" % (name, event))
 231         self._events.append(event)
 232
 233     def factory(self, name, apifn):
 234         def f(*a, **ka):
 235             fields = apifn._func.msg.fields
 236
 237             # add positional and kw arguments
 238             d = ka
 239             for i, o in enumerate(fields[3:]):
 240                 try:
 241                     d[o] = a[i]
 242                 except BaseException:
 243                     break
 244
 245             # Default override
 246             if name in defaultmapping:
 247                 for k, v in iteritems(defaultmapping[name]):
 248                     if k in d:
 249                         continue
 250                     d[k] = v
 251             return self.api(apifn, d)
 252
 253         return f
 254
 255     def __getattribute__(self, name):
 256         try:
 257             method = super(VppPapiProvider, self).__getattribute__(name)
 258         except AttributeError:
 259             method = self.factory(name, getattr(self.papi, name))
 260             # lazily load the method so we don't need to call factory
 261             # again for this name.
 262             setattr(self, name, method)
 263         return method
 264
 265     def connect(self):
 266         """Connect the API to VPP"""
 267         self.vpp.connect(self.name, self.shm_prefix)
 268         self.papi = self.vpp.api
 269         self.vpp.register_event_callback(self)
 270
 271     def disconnect(self):
 272         """Disconnect the API from VPP"""
 273         self.vpp.disconnect()
 274
 275     def api(self, api_fn, api_args, expected_retval=0):
 276         """ Call API function and check it's return value.
 277         Call the appropriate hooks before and after the API call
 278
 279         :param api_fn: API function to call
 280         :param api_args: tuple of API function arguments
 281         :param expected_retval: Expected return value (Default value = 0)
 282         :returns: reply from the API
 283
 284         """
 285         self.hook.before_api(api_fn.__name__, api_args)
 286         reply = api_fn(**api_args)
 287         if self._expect_api_retval == self._negative:
 288             if hasattr(reply, 'retval') and reply.retval >= 0:
 289                 msg = "%s(%s) passed unexpectedly: expected negative " \
 290                       "return value instead of %d in %s" % \
 291                       (api_fn.__name__, as_fn_signature(api_args),
 292                        reply.retval,
 293                        moves.reprlib.repr(reply))
 294                 self.test_class.logger.info(msg)
 295                 raise UnexpectedApiReturnValueError(msg)
 296         elif self._expect_api_retval == self._zero:
 297             if hasattr(reply, 'retval') and reply.retval != expected_retval:
 298                 msg = "%s(%s) failed, expected %d return value instead " \
 299                       "of %d in %s" % (api_fn.__name__,
 300                                        as_fn_signature(api_args),
 301                                        expected_retval, reply.retval,
 302                                        repr(reply))
 303                 self.test_class.logger.info(msg)
 304                 raise UnexpectedApiReturnValueError(msg)
 305         else:
 306             raise Exception("Internal error, unexpected value for "
 307                             "self._expect_api_retval %s" %
 308                             self._expect_api_retval)
 309         self.hook.after_api(api_fn.__name__, api_args)
 310         return reply
 311
 312     def cli_return_response(self, cli):
 313         """ Execute a CLI, calling the before/after hooks appropriately.
 314         Return the reply without examining it
 315
 316         :param cli: CLI to execute
 317         :returns: response object
 318
 319         """
 320         self.hook.before_cli(cli)
 321         cli += '\n'
 322         r = self.papi.cli_inband(cmd=cli)
 323         self.hook.after_cli(cli)
 324         return r
 325
 326     def cli(self, cli):
 327         """ Execute a CLI, calling the before/after hooks appropriately.
 328
 329         :param cli: CLI to execute
 330         :returns: CLI output
 331
 332         """
 333         r = self.cli_return_response(cli)
 334         if r.retval == -156:
 335             raise CliSyntaxError(r.reply)
 336         if r.retval != 0:
 337             raise CliFailedCommandError(r.reply)
 338         if hasattr(r, 'reply'):
 339             return r.reply
 340
 341     def ppcli(self, cli):
 342         """ Helper method to print CLI command in case of info logging level.
 343
 344         :param cli: CLI to execute
 345         :returns: CLI output
 346         """
 347         return cli + "\n" + self.cli(cli)
 348
 349     def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
 350                                        mrc=0, mrd=0):
 351         return self.api(self.papi.ip6nd_send_router_solicitation,
 352                         {'irt': irt,
 353                          'mrt': mrt,
 354                          'mrc': mrc,
 355                          'mrd': mrd,
 356                          'sw_if_index': sw_if_index})
 357
 358     def want_interface_events(self, enable_disable=1):
 359         return self.api(self.papi.want_interface_events,
 360                         {'enable_disable': enable_disable,
 361                          'pid': os.getpid(), })
 362
 363     def sw_interface_set_mac_address(self, sw_if_index, mac):
 364         return self.api(self.papi.sw_interface_set_mac_address,
 365                         {'sw_if_index': sw_if_index,
 366                          'mac_address': mac})
 367
 368     def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
 369         """Create p2p ethernet subinterface
 370
 371         :param sw_if_index: main (parent) interface
 372         :param remote_mac: client (remote) mac address
 373
 374         """
 375         return self.api(
 376             self.papi.p2p_ethernet_add,
 377             {'parent_if_index': sw_if_index,
 378              'remote_mac': remote_mac,
 379              'subif_id': subif_id})
 380
 381     def p2p_ethernet_del(self, sw_if_index, remote_mac):
 382         """Delete p2p ethernet subinterface
 383
 384         :param sw_if_index: main (parent) interface
 385         :param remote_mac: client (remote) mac address
 386
 387         """
 388         return self.api(
 389             self.papi.p2p_ethernet_del,
 390             {'parent_if_index': sw_if_index,
 391              'remote_mac': remote_mac})
 392
 393     def create_vlan_subif(self, sw_if_index, vlan):
 394         """
 395
 396         :param vlan:
 397         :param sw_if_index:
 398
 399         """
 400         return self.api(self.papi.create_vlan_subif,
 401                         {'sw_if_index': sw_if_index,
 402                          'vlan_id': vlan})
 403
 404     def create_loopback(self, mac=''):
 405         """
 406
 407         :param mac: (Optional)
 408         """
 409         return self.api(self.papi.create_loopback,
 410                         {'mac_address': mac})
 411
 412     def ip_route_dump(self, table_id, is_ip6=False):
 413         return self.api(self.papi.ip_route_dump,
 414                         {'table': {
 415                             'table_id': table_id,
 416                             'is_ip6': is_ip6
 417                         }})
 418
 419     def ip_neighbor_add_del(self,
 420                             sw_if_index,
 421                             mac_address,
 422                             ip_address,
 423                             is_add=1,
 424                             flags=0):
 425         """ Add neighbor MAC to IPv4 or IPv6 address.
 426
 427         :param sw_if_index:
 428         :param mac_address:
 429         :param dst_address:
 430         :param is_add:  (Default value = 1)
 431         :param flags:  (Default value = 0/NONE)
 432         """
 433         return self.api(
 434             self.papi.ip_neighbor_add_del,
 435             {
 436                 'is_add': is_add,
 437                 'neighbor': {
 438                     'sw_if_index': sw_if_index,
 439                     'flags': flags,
 440                     'mac_address': mac_address,
 441                     'ip_address': ip_address
 442                 }
 443             }
 444         )
 445
 446     def udp_encap_add(self,
 447                       src_ip,
 448                       dst_ip,
 449                       src_port,
 450                       dst_port,
 451                       table_id=0):
 452         """ Add a GRE tunnel
 453         :param src_ip:
 454         :param dst_ip:
 455         :param src_port:
 456         :param dst_port:
 457         :param outer_fib_id:  (Default value = 0)
 458         """
 459
 460         return self.api(
 461             self.papi.udp_encap_add,
 462             {
 463                 'udp_encap': {
 464                     'src_ip': src_ip,
 465                     'dst_ip': dst_ip,
 466                     'src_port': src_port,
 467                     'dst_port': dst_port,
 468                     'table_id': table_id
 469                 }
 470             })
 471
 472     def udp_encap_del(self, id):
 473         return self.api(self.papi.udp_encap_del, {'id': id})
 474
 475     def udp_encap_dump(self):
 476         return self.api(self.papi.udp_encap_dump, {})
 477
 478     def want_udp_encap_stats(self, enable=1):
 479         return self.api(self.papi.want_udp_encap_stats,
 480                         {'enable': enable,
 481                          'pid': os.getpid()})
 482
 483     def mpls_route_dump(self, table_id):
 484         return self.api(self.papi.mpls_route_dump,
 485                         {'table': {
 486                             'mt_table_id': table_id
 487                         }})
 488
 489     def mpls_table_dump(self):
 490         return self.api(self.papi.mpls_table_dump, {})
 491
 492     def mpls_table_add_del(
 493             self,
 494             table_id,
 495             is_add=1):
 496         """
 497
 498         :param table_id
 499         :param is_add:  (Default value = 1)
 500
 501         """
 502
 503         return self.api(
 504             self.papi.mpls_table_add_del,
 505             {'mt_table':
 506              {
 507                  'mt_table_id': table_id,
 508              },
 509              'mt_is_add': is_add})
 510
 511     def mpls_route_add_del(self,
 512                            table_id,
 513                            label,
 514                            eos,
 515                            eos_proto,
 516                            is_multicast,
 517                            paths,
 518                            is_add,
 519                            is_multipath):
 520         """ MPLS Route add/del """
 521         return self.api(
 522             self.papi.mpls_route_add_del,
 523             {'mr_route':
 524              {
 525                  'mr_table_id': table_id,
 526                  'mr_label': label,
 527                  'mr_eos': eos,
 528                  'mr_eos_proto': eos_proto,
 529                  'mr_is_multicast': is_multicast,
 530                  'mr_n_paths': len(paths),
 531                  'mr_paths': paths,
 532              },
 533              'mr_is_add': is_add,
 534              'mr_is_multipath': is_multipath})
 535
 536     def mpls_ip_bind_unbind(
 537             self,
 538             label,
 539             prefix,
 540             table_id=0,
 541             ip_table_id=0,
 542             is_bind=1):
 543         """
 544         """
 545         return self.api(
 546             self.papi.mpls_ip_bind_unbind,
 547             {'mb_mpls_table_id': table_id,
 548              'mb_label': label,
 549              'mb_ip_table_id': ip_table_id,
 550              'mb_is_bind': is_bind,
 551              'mb_prefix': prefix})
 552
 553     def mpls_tunnel_add_del(
 554             self,
 555             tun_sw_if_index,
 556             paths,
 557             is_add=1,
 558             l2_only=0,
 559             is_multicast=0):
 560         """
 561         """
 562         return self.api(
 563             self.papi.mpls_tunnel_add_del,
 564             {'mt_is_add': is_add,
 565              'mt_tunnel':
 566              {
 567                  'mt_sw_if_index': tun_sw_if_index,
 568                  'mt_l2_only': l2_only,
 569                  'mt_is_multicast': is_multicast,
 570                  'mt_n_paths': len(paths),
 571                  'mt_paths': paths,
 572              }})
 573
 574     def input_acl_set_interface(
 575             self,
 576             is_add,
 577             sw_if_index,
 578             ip4_table_index=0xFFFFFFFF,
 579             ip6_table_index=0xFFFFFFFF,
 580             l2_table_index=0xFFFFFFFF):
 581         """
 582         :param is_add:
 583         :param sw_if_index:
 584         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
 585         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
 586         :param l2_table_index:  (Default value = 0xFFFFFFFF)
 587         """
 588
 589         return self.api(
 590             self.papi.input_acl_set_interface,
 591             {'sw_if_index': sw_if_index,
 592              'ip4_table_index': ip4_table_index,
 593              'ip6_table_index': ip6_table_index,
 594              'l2_table_index': l2_table_index,
 595              'is_add': is_add})
 596
 597     def output_acl_set_interface(
 598             self,
 599             is_add,
 600             sw_if_index,
 601             ip4_table_index=0xFFFFFFFF,
 602             ip6_table_index=0xFFFFFFFF,
 603             l2_table_index=0xFFFFFFFF):
 604         """
 605         :param is_add:
 606         :param sw_if_index:
 607         :param ip4_table_index:  (Default value = 0xFFFFFFFF)
 608         :param ip6_table_index:  (Default value = 0xFFFFFFFF)
 609         :param l2_table_index:  (Default value = 0xFFFFFFFF)
 610         """
 611
 612         return self.api(
 613             self.papi.output_acl_set_interface,
 614             {'sw_if_index': sw_if_index,
 615              'ip4_table_index': ip4_table_index,
 616              'ip6_table_index': ip6_table_index,
 617              'l2_table_index': l2_table_index,
 618              'is_add': is_add})
 619
 620     def set_ipfix_exporter(
 621             self,
 622             collector_address,
 623             src_address,
 624             path_mtu,
 625             template_interval,
 626             vrf_id=0,
 627             collector_port=4739,
 628             udp_checksum=0):
 629         return self.api(
 630             self.papi.set_ipfix_exporter,
 631             {
 632                 'collector_address': collector_address,
 633                 'collector_port': collector_port,
 634                 'src_address': src_address,
 635                 'vrf_id': vrf_id,
 636                 'path_mtu': path_mtu,
 637                 'template_interval': template_interval,
 638                 'udp_checksum': udp_checksum,
 639             })
 640
 641     def mfib_signal_dump(self):
 642         return self.api(self.papi.mfib_signal_dump, {})
 643
 644     def ip_mroute_dump(self, table_id, is_ip6=False):
 645         return self.api(self.papi.ip_mroute_dump,
 646                         {'table': {
 647                             'table_id': table_id,
 648                             'is_ip6': is_ip6
 649                         }})
 650
 651     def vxlan_gpe_add_del_tunnel(
 652             self,
 653             src_addr,
 654             dst_addr,
 655             mcast_sw_if_index=0xFFFFFFFF,
 656             is_add=1,
 657             is_ipv6=0,
 658             encap_vrf_id=0,
 659             decap_vrf_id=0,
 660             protocol=3,
 661             vni=0):
 662         """
 663
 664         :param local:
 665         :param remote:
 666         :param is_add:  (Default value = 1)
 667         :param is_ipv6:  (Default value = 0)
 668         :param encap_vrf_id:  (Default value = 0)
 669         :param decap_vrf_id:  (Default value = 0)
 670         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
 671         :param protocol:  (Default value = 3)
 672         :param vni:  (Default value = 0)
 673
 674         """
 675         return self.api(self.papi.vxlan_gpe_add_del_tunnel,
 676                         {'is_add': is_add,
 677                          'is_ipv6': is_ipv6,
 678                          'local': src_addr,
 679                          'remote': dst_addr,
 680                          'mcast_sw_if_index': mcast_sw_if_index,
 681                          'encap_vrf_id': encap_vrf_id,
 682                          'decap_vrf_id': decap_vrf_id,
 683                          'protocol': protocol,
 684                          'vni': vni})
 685
 686     def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff):
 687         return self.api(self.papi.vxlan_gbp_tunnel_dump,
 688                         {'sw_if_index': sw_if_index})
 689
 690     def pppoe_add_del_session(
 691             self,
 692             client_ip,
 693             client_mac,
 694             session_id=0,
 695             is_add=1,
 696             decap_vrf_id=0):
 697         """
 698
 699         :param is_add:  (Default value = 1)
 700         :param is_ipv6:  (Default value = 0)
 701         :param client_ip:
 702         :param session_id:  (Default value = 0)
 703         :param client_mac:
 704         :param decap_vrf_id:  (Default value = 0)
 705
 706         """
 707         return self.api(self.papi.pppoe_add_del_session,
 708                         {'is_add': is_add,
 709                          'session_id': session_id,
 710                          'client_ip': client_ip,
 711                          'decap_vrf_id': decap_vrf_id,
 712                          'client_mac': client_mac})
 713
 714     def sr_mpls_policy_add(self, bsid, weight, type, segments):
 715         return self.api(self.papi.sr_mpls_policy_add,
 716                         {'bsid': bsid,
 717                          'weight': weight,
 718                          'is_spray': type,
 719                          'n_segments': len(segments),
 720                          'segments': segments})
 721
 722     def sr_mpls_policy_del(self, bsid):
 723         return self.api(self.papi.sr_mpls_policy_del,
 724                         {'bsid': bsid})
 725
 726     def bier_table_add_del(self,
 727                            bti,
 728                            mpls_label,
 729                            is_add=1):
 730         """ BIER Table add/del """
 731         return self.api(
 732             self.papi.bier_table_add_del,
 733             {'bt_tbl_id': {"bt_set": bti.set_id,
 734                            "bt_sub_domain": bti.sub_domain_id,
 735                            "bt_hdr_len_id": bti.hdr_len_id},
 736              'bt_label': mpls_label,
 737              'bt_is_add': is_add})
 738
 739     def bier_table_dump(self):
 740         return self.api(self.papi.bier_table_dump, {})
 741
 742     def bier_route_add_del(self,
 743                            bti,
 744                            bp,
 745                            paths,
 746                            is_add=1,
 747                            is_replace=0):
 748         """ BIER Route add/del """
 749         return self.api(
 750             self.papi.bier_route_add_del,
 751             {
 752                 'br_route': {
 753                     'br_tbl_id': {"bt_set": bti.set_id,
 754                                   "bt_sub_domain": bti.sub_domain_id,
 755                                   "bt_hdr_len_id": bti.hdr_len_id},
 756                     'br_bp': bp,
 757                     'br_n_paths': len(paths),
 758                     'br_paths': paths,
 759                 },
 760                 'br_is_add': is_add,
 761                 'br_is_replace': is_replace
 762             })
 763
 764     def bier_route_dump(self, bti):
 765         return self.api(
 766             self.papi.bier_route_dump,
 767             {'br_tbl_id': {"bt_set": bti.set_id,
 768                            "bt_sub_domain": bti.sub_domain_id,
 769                            "bt_hdr_len_id": bti.hdr_len_id}})
 770
 771     def bier_imp_add(self,
 772                      bti,
 773                      src,
 774                      ibytes,
 775                      is_add=1):
 776         """ BIER Imposition Add """
 777         return self.api(
 778             self.papi.bier_imp_add,
 779             {'bi_tbl_id': {"bt_set": bti.set_id,
 780                            "bt_sub_domain": bti.sub_domain_id,
 781                            "bt_hdr_len_id": bti.hdr_len_id},
 782              'bi_src': src,
 783              'bi_n_bytes': len(ibytes),
 784              'bi_bytes': ibytes})
 785
 786     def bier_imp_del(self, bi_index):
 787         """ BIER Imposition del """
 788         return self.api(
 789             self.papi.bier_imp_del,
 790             {'bi_index': bi_index})
 791
 792     def bier_imp_dump(self):
 793         return self.api(self.papi.bier_imp_dump, {})
 794
 795     def bier_disp_table_add_del(self,
 796                                 bdti,
 797                                 is_add=1):
 798         """ BIER Disposition Table add/del """
 799         return self.api(
 800             self.papi.bier_disp_table_add_del,
 801             {'bdt_tbl_id': bdti,
 802              'bdt_is_add': is_add})
 803
 804     def bier_disp_table_dump(self):
 805         return self.api(self.papi.bier_disp_table_dump, {})
 806
 807     def bier_disp_entry_add_del(self,
 808                                 bdti,
 809                                 bp,
 810                                 payload_proto,
 811                                 next_hop_afi,
 812                                 next_hop,
 813                                 next_hop_tbl_id=0,
 814                                 next_hop_rpf_id=~0,
 815                                 next_hop_is_ip4=1,
 816                                 is_add=1):
 817         """ BIER Route add/del """
 818         lstack = []
 819         while (len(lstack) < 16):
 820             lstack.append({})
 821         return self.api(
 822             self.papi.bier_disp_entry_add_del,
 823             {'bde_tbl_id': bdti,
 824              'bde_bp': bp,
 825              'bde_payload_proto': payload_proto,
 826              'bde_n_paths': 1,
 827              'bde_paths': [{'table_id': next_hop_tbl_id,
 828                             'rpf_id': next_hop_rpf_id,
 829                             'n_labels': 0,
 830                             'label_stack': lstack}],
 831              'bde_is_add': is_add})
 832
 833     def bier_disp_entry_dump(self, bdti):
 834         return self.api(
 835             self.papi.bier_disp_entry_dump,
 836             {'bde_tbl_id': bdti})
 837
 838     def ipsec_spd_add_del(self, spd_id, is_add=1):
 839         """ SPD add/del - Wrapper to add or del ipsec SPD
 840         Sample CLI : 'ipsec spd add 1'
 841
 842         :param spd_id - SPD ID to be created in the vpp . mandatory
 843         :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
 844               optional
 845         :returns: reply from the API
 846         """
 847         return self.api(
 848             self.papi.ipsec_spd_add_del, {
 849                 'spd_id': spd_id, 'is_add': is_add})
 850
 851     def ipsec_spds_dump(self):
 852         return self.api(self.papi.ipsec_spds_dump, {})
 853
 854     def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
 855         """ IPSEC interface SPD add/del - \
 856              Wrapper to associate/disassociate SPD to interface in VPP
 857         Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
 858
 859         :param spd_id - SPD ID to associate with the interface . mandatory
 860         :param sw_if_index - Interface Index which needs to ipsec \
 861             association mandatory
 862         :param is_add - add(1) or del(0) association with interface \
 863                 (Default 1 - add) . optional
 864         :returns: reply from the API
 865         """
 866         return self.api(
 867             self.papi.ipsec_interface_add_del_spd,
 868             {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
 869
 870     def ipsec_spd_interface_dump(self, spd_index=None):
 871         return self.api(self.papi.ipsec_spd_interface_dump,
 872                         {'spd_index': spd_index if spd_index else 0,
 873                          'spd_index_valid': 1 if spd_index else 0})
 874
 875     def ipsec_spd_entry_add_del(self,
 876                                 spd_id,
 877                                 sa_id,
 878                                 local_address_start,
 879                                 local_address_stop,
 880                                 remote_address_start,
 881                                 remote_address_stop,
 882                                 local_port_start=0,
 883                                 local_port_stop=65535,
 884                                 remote_port_start=0,
 885                                 remote_port_stop=65535,
 886                                 protocol=0,
 887                                 policy=0,
 888                                 priority=100,
 889                                 is_outbound=1,
 890                                 is_add=1,
 891                                 is_ipv6=0,
 892                                 is_ip_any=0):
 893         """ IPSEC policy SPD add/del   -
 894                     Wrapper to configure ipsec SPD policy entries in VPP
 895         :param spd_id: SPD ID for the policy
 896         :param local_address_start: local-ip-range start address
 897         :param local_address_stop : local-ip-range stop address
 898         :param remote_address_start: remote-ip-range start address
 899         :param remote_address_stop : remote-ip-range stop address
 900         :param local_port_start: (Default value = 0)
 901         :param local_port_stop: (Default value = 65535)
 902         :param remote_port_start: (Default value = 0)
 903         :param remote_port_stop: (Default value = 65535)
 904         :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0)
 905         :param sa_id: Security Association ID for mapping it to SPD
 906         :param policy: bypass(0), discard(1), resolve(2) or protect(3) action
 907                (Default value = 0)
 908         :param priority: value for the spd action (Default value = 100)
 909         :param is_outbound: flag for inbound(0) or outbound(1)
 910                (Default value = 1)
 911         :param is_add: (Default value = 1)
 912         """
 913         return self.api(
 914             self.papi.ipsec_spd_entry_add_del,
 915             {
 916                 'is_add': is_add,
 917                 'entry':
 918                     {
 919                         'spd_id': spd_id,
 920                         'sa_id': sa_id,
 921                         'local_address_start': local_address_start,
 922                         'local_address_stop': local_address_stop,
 923                         'remote_address_start': remote_address_start,
 924                         'remote_address_stop': remote_address_stop,
 925                         'local_port_start': local_port_start,
 926                         'local_port_stop': local_port_stop,
 927                         'remote_port_start': remote_port_start,
 928                         'remote_port_stop': remote_port_stop,
 929                         'protocol': protocol,
 930                         'policy': policy,
 931                         'priority': priority,
 932                         'is_outbound': is_outbound,
 933                     }
 934             })
 935
 936     def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
 937         return self.api(self.papi.ipsec_spd_dump,
 938                         {'spd_id': spd_id,
 939                          'sa_id': sa_id})
 940
 941     def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
 942                                 remote_spi, crypto_alg, local_crypto_key,
 943                                 remote_crypto_key, integ_alg, local_integ_key,
 944                                 remote_integ_key, is_add=1, esn=0, salt=0,
 945                                 anti_replay=1, renumber=0,
 946                                 udp_encap=0, show_instance=0xffffffff):
 947         return self.api(
 948             self.papi.ipsec_tunnel_if_add_del,
 949             {
 950                 'local_ip': local_ip,
 951                 'remote_ip': remote_ip,
 952                 'local_spi': local_spi,
 953                 'remote_spi': remote_spi,
 954                 'crypto_alg': crypto_alg,
 955                 'local_crypto_key_len': len(local_crypto_key),
 956                 'local_crypto_key': local_crypto_key,
 957                 'remote_crypto_key_len': len(remote_crypto_key),
 958                 'remote_crypto_key': remote_crypto_key,
 959                 'integ_alg': integ_alg,
 960                 'local_integ_key_len': len(local_integ_key),
 961                 'local_integ_key': local_integ_key,
 962                 'remote_integ_key_len': len(remote_integ_key),
 963                 'remote_integ_key': remote_integ_key,
 964                 'is_add': is_add,
 965                 'esn': esn,
 966                 'anti_replay': anti_replay,
 967                 'renumber': renumber,
 968                 'show_instance': show_instance,
 969                 'udp_encap': udp_encap,
 970                 'salt': salt
 971             })
 972
 973     def ipsec_select_backend(self, protocol, index):
 974         return self.api(self.papi.ipsec_select_backend,
 975                         {'protocol': protocol, 'index': index})
 976
 977     def ipsec_backend_dump(self):
 978         return self.api(self.papi.ipsec_backend_dump, {})
 979
 980     def punt_socket_register(self, reg, pathname,
 981                              header_version=1):
 982         """ Register punt socket """
 983         return self.api(self.papi.punt_socket_register,
 984                         {'header_version': header_version,
 985                          'punt': reg,
 986                          'pathname': pathname})
 987
 988     def punt_socket_deregister(self, reg):
 989         """ Unregister punt socket """
 990         return self.api(self.papi.punt_socket_deregister,
 991                         {'punt': reg})
 992
 993     def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags,
 994                          tun_src, tun_dst):
 995         """ GBP endpoint Add """
 996         return self.api(self.papi.gbp_endpoint_add,
 997                         {'endpoint': {
 998                             'sw_if_index': sw_if_index,
 999                             'ips': ips,
1000                             'n_ips': len(ips),
1001                             'mac': mac,
1002                             'sclass': sclass,
1003                             'flags': flags,
1004                             'tun': {
1005                                 'src': tun_src,
1006                                 'dst': tun_dst,
1007                             }}})
1008
1009     def gbp_endpoint_del(self, handle):
1010         """ GBP endpoint Del """
1011         return self.api(self.papi.gbp_endpoint_del,
1012                         {'handle': handle})
1013
1014     def gbp_endpoint_dump(self):
1015         """ GBP endpoint Dump """
1016         return self.api(self.papi.gbp_endpoint_dump, {})
1017
1018     def gbp_endpoint_group_add(self, vnid, sclass, bd,
1019                                rd, uplink_sw_if_index,
1020                                retention):
1021         """ GBP endpoint group Add """
1022         return self.api(self.papi.gbp_endpoint_group_add,
1023                         {'epg':
1024                             {
1025                                 'uplink_sw_if_index': uplink_sw_if_index,
1026                                 'bd_id': bd,
1027                                 'rd_id': rd,
1028                                 'vnid': vnid,
1029                                 'sclass': sclass,
1030                                 'retention': retention
1031                             }})
1032
1033     def gbp_endpoint_group_del(self, sclass):
1034         """ GBP endpoint group Del """
1035         return self.api(self.papi.gbp_endpoint_group_del,
1036                         {'sclass': sclass})
1037
1038     def gbp_bridge_domain_add(self, bd_id, rd_id, flags,
1039                               bvi_sw_if_index,
1040                               uu_fwd_sw_if_index,
1041                               bm_flood_sw_if_index):
1042         """ GBP bridge-domain Add """
1043         return self.api(self.papi.gbp_bridge_domain_add,
1044                         {'bd':
1045                             {
1046                                 'flags': flags,
1047                                 'bvi_sw_if_index': bvi_sw_if_index,
1048                                 'uu_fwd_sw_if_index': uu_fwd_sw_if_index,
1049                                 'bm_flood_sw_if_index': bm_flood_sw_if_index,
1050                                 'bd_id': bd_id,
1051                                 'rd_id': rd_id
1052                             }})
1053
1054     def gbp_bridge_domain_del(self, bd_id):
1055         """ GBP bridge-domain Del """
1056         return self.api(self.papi.gbp_bridge_domain_del,
1057                         {'bd_id': bd_id})
1058
1059     def gbp_route_domain_add(self, rd_id,
1060                              scope,
1061                              ip4_table_id,
1062                              ip6_table_id,
1063                              ip4_uu_sw_if_index,
1064                              ip6_uu_sw_if_index):
1065         """ GBP route-domain Add """
1066         return self.api(self.papi.gbp_route_domain_add,
1067                         {'rd':
1068                             {
1069                                 'scope': scope,
1070                                 'ip4_table_id': ip4_table_id,
1071                                 'ip6_table_id': ip6_table_id,
1072                                 'ip4_uu_sw_if_index': ip4_uu_sw_if_index,
1073                                 'ip6_uu_sw_if_index': ip6_uu_sw_if_index,
1074                                 'rd_id': rd_id
1075                             }})
1076
1077     def gbp_route_domain_del(self, rd_id):
1078         """ GBP route-domain Del """
1079         return self.api(self.papi.gbp_route_domain_del,
1080                         {'rd_id': rd_id})
1081
1082     def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext):
1083         """ GBP recirc Add/Del """
1084         return self.api(self.papi.gbp_recirc_add_del,
1085                         {'is_add': is_add,
1086                          'recirc': {
1087                              'is_ext': is_ext,
1088                              'sw_if_index': sw_if_index,
1089                              'sclass': sclass}})
1090
1091     def gbp_recirc_dump(self):
1092         """ GBP recirc Dump """
1093         return self.api(self.papi.gbp_recirc_dump, {})
1094
1095     def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags):
1096         """ GBP recirc Add/Del """
1097         return self.api(self.papi.gbp_ext_itf_add_del,
1098                         {'is_add': is_add,
1099                          'ext_itf': {
1100                              'sw_if_index': sw_if_index,
1101                              'bd_id': bd_id,
1102                              'rd_id': rd_id,
1103                              'flags': flags}})
1104
1105     def gbp_ext_itf_dump(self):
1106         """ GBP recirc Dump """
1107         return self.api(self.papi.gbp_ext_itf_dump, {})
1108
1109     def gbp_subnet_add_del(self, is_add, rd_id,
1110                            prefix, type,
1111                            sw_if_index=0xffffffff,
1112                            sclass=0xffff):
1113         """ GBP Subnet Add/Del """
1114         return self.api(self.papi.gbp_subnet_add_del,
1115                         {'is_add': is_add,
1116                          'subnet': {
1117                              'type': type,
1118                              'sw_if_index': sw_if_index,
1119                              'sclass': sclass,
1120                              'prefix': prefix,
1121                              'rd_id': rd_id}})
1122
1123     def gbp_subnet_dump(self):
1124         """ GBP Subnet Dump """
1125         return self.api(self.papi.gbp_subnet_dump, {})
1126
1127     def gbp_contract_dump(self):
1128         """ GBP contract Dump """
1129         return self.api(self.papi.gbp_contract_dump, {})
1130
1131     def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src):
1132         """ GBP VXLAN tunnel add """
1133         return self.api(self.papi.gbp_vxlan_tunnel_add,
1134                         {
1135                             'tunnel': {
1136                                 'vni': vni,
1137                                 'mode': mode,
1138                                 'bd_rd_id': bd_rd_id,
1139                                 'src': src
1140                             }
1141                         })
1142
1143     def gbp_vxlan_tunnel_del(self, vni):
1144         """ GBP VXLAN tunnel del """
1145         return self.api(self.papi.gbp_vxlan_tunnel_del,
1146                         {
1147                             'vni': vni,
1148                         })
1149
1150     def gbp_vxlan_tunnel_dump(self):
1151         """ GBP VXLAN tunnel add/del """
1152         return self.api(self.papi.gbp_vxlan_tunnel_dump, {})
1153
1154     def igmp_enable_disable(self, sw_if_index, enable, host):
1155         """ Enable/disable IGMP on a given interface """
1156         return self.api(self.papi.igmp_enable_disable,
1157                         {'enable': enable,
1158                          'mode': host,
1159                          'sw_if_index': sw_if_index})
1160
1161     def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add):
1162         """ Add/del IGMP proxy device """
1163         return self.api(self.papi.igmp_proxy_device_add_del,
1164                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1165                          'add': add})
1166
1167     def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add):
1168         """ Add/del interface to/from IGMP proxy device """
1169         return self.api(self.papi.igmp_proxy_device_add_del_interface,
1170                         {'vrf_id': vrf_id, 'sw_if_index': sw_if_index,
1171                          'add': add})
1172
1173     def igmp_listen(self, filter, sw_if_index, saddrs, gaddr):
1174         """ Listen for new (S,G) on specified interface
1175
1176         :param enable: add/del
1177         :param sw_if_index: interface sw index
1178         :param saddr: source ip4 addr
1179         :param gaddr: group ip4 addr
1180         """
1181         return self.api(self.papi.igmp_listen,
1182                         {
1183                             'group':
1184                                 {
1185                                     'filter': filter,
1186                                     'sw_if_index': sw_if_index,
1187                                     'n_srcs': len(saddrs),
1188                                     'saddrs': saddrs,
1189                                     'gaddr': gaddr
1190                                 }
1191                         })
1192
1193     def igmp_clear_interface(self, sw_if_index):
1194         """ Remove all (S,G)s from specified interface
1195             doesn't send IGMP report!
1196         """
1197         return self.api(
1198             self.papi.igmp_clear_interface, {
1199                 'sw_if_index': sw_if_index})
1200
1201     def want_igmp_events(self, enable=1):
1202         return self.api(self.papi.want_igmp_events, {'enable': enable,
1203                                                      'pid': os.getpid()})