test/vpp_papi_provider.py

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