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