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