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