UDP Encap counters
[vpp.git] / test / vpp_papi_provider.py
index db0f8e6..65cf766 100644 (file)
@@ -36,6 +36,13 @@ class L2_VTR_OP:
     L2_TRANSLATE_2_2 = 8
 
 
+class QOS_SOURCE:
+    EXT = 0
+    VLAN = 1
+    MPLS = 2
+    IP = 3
+
+
 class UnexpectedApiReturnValueError(Exception):
     """ exception raised when the API return value is unexpected """
     pass
@@ -362,7 +369,8 @@ class VppPapiProvider(object):
             is_ipv6=0,
             encap_vrf_id=0,
             decap_next_index=0xFFFFFFFF,
-            vni=0):
+            vni=0,
+            instance=0xFFFFFFFF):
         """
 
         :param dst_addr:
@@ -373,6 +381,7 @@ class VppPapiProvider(object):
         :param decap_next_index:  (Default value = 0xFFFFFFFF)
         :param mcast_sw_if_index:  (Default value = 0xFFFFFFFF)
         :param vni:  (Default value = 0)
+        :param instance:  (Default value = 0xFFFFFFFF)
 
         """
         return self.api(self.papi.vxlan_add_del_tunnel,
@@ -383,7 +392,8 @@ class VppPapiProvider(object):
                          'mcast_sw_if_index': mcast_sw_if_index,
                          'encap_vrf_id': encap_vrf_id,
                          'decap_next_index': decap_next_index,
-                         'vni': vni})
+                         'vni': vni,
+                         'instance': instance})
 
     def geneve_add_del_tunnel(
             self,
@@ -463,6 +473,27 @@ class VppPapiProvider(object):
                          'address': address,
                          'pid': os.getpid(), })
 
+    def want_ip6_ra_events(self, enable_disable=1):
+        return self.api(self.papi.want_ip6_ra_events,
+                        {'enable_disable': enable_disable,
+                         'pid': os.getpid(), })
+
+    def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120,
+                                       mrc=0, mrd=0):
+        return self.api(self.papi.ip6nd_send_router_solicitation,
+                        {'irt': irt,
+                         'mrt': mrt,
+                         'mrc': mrc,
+                         'mrd': mrd,
+                         'sw_if_index': sw_if_index})
+
+    def ip6_nd_address_autoconfig(self, sw_if_index, enable,
+                                  install_default_routes):
+        return self.api(self.papi.ip6_nd_address_autoconfig,
+                        {'sw_if_index': sw_if_index,
+                         'enable': enable,
+                         'install_default_routes': install_default_routes})
+
     def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
                                max_macs_in_event=0, learn_limit=0):
         return self.api(self.papi.want_l2_macs_events,
@@ -626,6 +657,21 @@ class VppPapiProvider(object):
                         {'sw_if_index': sw_if_index,
                          'admin_up_down': admin_up_down})
 
+    def sw_interface_set_mtu(self, sw_if_index, mtu):
+        """
+        :param sw_if_index:
+        :param mtu:
+
+        """
+        return self.api(self.papi.sw_interface_set_mtu,
+                        {'sw_if_index': sw_if_index,
+                         'mtu': mtu})
+
+    def sw_interface_set_mac_address(self, sw_if_index, mac):
+        return self.api(self.papi.sw_interface_set_mac_address,
+                        {'sw_if_index': sw_if_index,
+                         'mac_address': mac})
+
     def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
                      no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
                      default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
@@ -973,7 +1019,9 @@ class VppPapiProvider(object):
                            src_address,
                            dst_address,
                            outer_fib_id=0,
-                           is_teb=0,
+                           tunnel_type=0,
+                           instance=0xFFFFFFFF,
+                           session_id=0,
                            is_add=1,
                            is_ip6=0):
         """ Add a GRE tunnel
@@ -981,19 +1029,23 @@ class VppPapiProvider(object):
         :param src_address:
         :param dst_address:
         :param outer_fib_id:  (Default value = 0)
+        :param tunnel_type:  (Default value = 0)
+        :param instance:  (Default value = 0xFFFFFFFF)
+        :param session_id: (Defalt value = 0)
         :param is_add:  (Default value = 1)
         :param is_ipv6:  (Default value = 0)
-        :param is_teb:  (Default value = 0)
         """
 
         return self.api(
             self.papi.gre_add_del_tunnel,
             {'is_add': is_add,
              'is_ipv6': is_ip6,
-             'teb': is_teb,
+             'tunnel_type': tunnel_type,
+             'instance': instance,
              'src_address': src_address,
              'dst_address': dst_address,
-             'outer_fib_id': outer_fib_id}
+             'outer_fib_id': outer_fib_id,
+             'session_id': session_id}
         )
 
     def udp_encap_add_del(self,
@@ -1031,6 +1083,11 @@ class VppPapiProvider(object):
     def udp_encap_dump(self):
         return self.api(self.papi.udp_encap_dump, {})
 
+    def want_udp_encap_stats(self, enable=1):
+        return self.api(self.papi.want_udp_encap_stats,
+                        {'enable': enable,
+                         'pid': os.getpid()})
+
     def mpls_fib_dump(self):
         return self.api(self.papi.mpls_fib_dump, {})
 
@@ -1095,7 +1152,6 @@ class VppPapiProvider(object):
         :param next_hop_weight:  (Default value = 1)
 
         """
-
         return self.api(
             self.papi.mpls_route_add_del,
             {'mr_label': label,
@@ -1236,6 +1292,7 @@ class VppPapiProvider(object):
             protocol=0,
             twice_nat=0,
             out2in_only=0,
+            tag="",
             is_add=1):
         """Add/delete NAT44 static mapping
 
@@ -1249,6 +1306,7 @@ class VppPapiProvider(object):
         :param protocol: IP protocol (Default value = 0)
         :param twice_nat: 1 if translate external host address and port
         :param out2in_only: if 1 rule is matching only out2in direction
+        :param tag: Opaque string tag
         :param is_add: 1 if add, 0 if delete (Default value = 1)
         """
         return self.api(
@@ -1263,7 +1321,8 @@ class VppPapiProvider(object):
              'vrf_id': vrf_id,
              'protocol': protocol,
              'twice_nat': twice_nat,
-             'out2in_only': out2in_only})
+             'out2in_only': out2in_only,
+             'tag': tag})
 
     def nat44_add_del_identity_mapping(
             self,
@@ -1273,6 +1332,7 @@ class VppPapiProvider(object):
             addr_only=1,
             vrf_id=0,
             protocol=0,
+            tag='',
             is_add=1):
         """Add/delete NAT44 identity mapping
 
@@ -1282,6 +1342,7 @@ class VppPapiProvider(object):
         :param addr_only: 1 if address only mapping, 0 if address and port
         :param vrf_id: VRF ID
         :param protocol: IP protocol (Default value = 0)
+        :param tag: Opaque string tag
         :param is_add: 1 if add, 0 if delete (Default value = 1)
         """
         return self.api(
@@ -1292,6 +1353,7 @@ class VppPapiProvider(object):
              'port': port,
              'sw_if_index': sw_if_index,
              'vrf_id': vrf_id,
+             'tag': tag,
              'protocol': protocol})
 
     def nat44_add_del_address_range(
@@ -1424,12 +1486,14 @@ class VppPapiProvider(object):
             vrf_id=0,
             twice_nat=0,
             out2in_only=0,
+            tag='',
             local_num=0,
             locals=[],
             is_add=1):
         """Add/delete NAT44 load balancing static mapping
 
         :param twice_nat: 1 if translate external host address and port
+        :param tag: Opaque string tag
         :param is_add - 1 if add, 0 if delete
         """
         return self.api(
@@ -1441,6 +1505,7 @@ class VppPapiProvider(object):
              'vrf_id': vrf_id,
              'twice_nat': twice_nat,
              'out2in_only': out2in_only,
+             'tag': tag,
              'local_num': local_num,
              'locals': locals})
 
@@ -1851,6 +1916,54 @@ class VppPapiProvider(object):
              'end_addr': end_addr,
              'is_add': is_add})
 
+    def nat66_add_del_interface(
+            self,
+            sw_if_index,
+            is_inside=1,
+            is_add=1):
+        """Enable/disable NAT66 feature on the interface
+           :param sw_if_index: Index of the interface
+           :param is_inside: 1 if inside, 0 if outside (Default value = 1)
+           :param is_add: 1 if add, 0 if delete (Default value = 1)
+        """
+        return self.api(
+            self.papi.nat66_add_del_interface,
+            {'sw_if_index': sw_if_index,
+             'is_inside': is_inside,
+             'is_add': is_add})
+
+    def nat66_add_del_static_mapping(
+            self,
+            in_ip,
+            out_ip,
+            vrf_id=0,
+            is_add=1):
+        """Add/delete NAT66 static mapping
+
+        :param in_ip: Inside IPv6 address
+        :param out_ip: Outside IPv6 address
+        :param vrf_id: VRF ID (Default value = 0)
+        :param is_add: 1 if add, 0 if delete (Default value = 1)
+        """
+        return self.api(
+            self.papi.nat66_add_del_static_mapping,
+            {'local_ip_address': in_ip,
+             'external_ip_address': out_ip,
+             'vrf_id': vrf_id,
+             'is_add': is_add})
+
+    def nat66_interface_dump(self):
+        """Dump interfaces with NAT66 feature
+        :return: Dictionary of interfaces with NAT66 feature
+        """
+        return self.api(self.papi.nat66_interface_dump, {})
+
+    def nat66_static_mapping_dump(self):
+        """Dump NAT66 static mappings
+        :return: Dictionary of NAT66 static mappings
+        """
+        return self.api(self.papi.nat66_static_mapping_dump, {})
+
     def control_ping(self):
         self.api(self.papi.control_ping)
 
@@ -2068,6 +2181,29 @@ class VppPapiProvider(object):
              'l2_table_index': l2_table_index,
              'is_add': is_add})
 
+    def output_acl_set_interface(
+            self,
+            is_add,
+            sw_if_index,
+            ip4_table_index=0xFFFFFFFF,
+            ip6_table_index=0xFFFFFFFF,
+            l2_table_index=0xFFFFFFFF):
+        """
+        :param is_add:
+        :param sw_if_index:
+        :param ip4_table_index:  (Default value = 0xFFFFFFFF)
+        :param ip6_table_index:  (Default value = 0xFFFFFFFF)
+        :param l2_table_index:  (Default value = 0xFFFFFFFF)
+        """
+
+        return self.api(
+            self.papi.output_acl_set_interface,
+            {'sw_if_index': sw_if_index,
+             'ip4_table_index': ip4_table_index,
+             'ip6_table_index': ip6_table_index,
+             'l2_table_index': l2_table_index,
+             'is_add': is_add})
+
     def set_ipfix_exporter(
             self,
             collector_address,
@@ -2597,6 +2733,16 @@ class VppPapiProvider(object):
                          'acls': acls},
                         expected_retval=expected_retval)
 
+    def acl_interface_set_etype_whitelist(self, sw_if_index,
+                                          n_input, whitelist,
+                                          expected_retval=0):
+        return self.api(self.papi.acl_interface_set_etype_whitelist,
+                        {'sw_if_index': sw_if_index,
+                         'count': len(whitelist),
+                         'n_input': n_input,
+                         'whitelist': whitelist},
+                        expected_retval=expected_retval)
+
     def acl_interface_add_del(self,
                               sw_if_index,
                               acl_index,
@@ -2761,25 +2907,14 @@ class VppPapiProvider(object):
                            paths,
                            is_add=1):
         """ BIER Route add/del """
-        br_paths = []
-        for p in paths:
-            br_paths.append({'next_hop': p.nh_addr,
-                             'weight': 1,
-                             'afi': 0,
-                             'preference': 0,
-                             'table_id': p.nh_table_id,
-                             'next_hop_id': p.next_hop_id,
-                             'is_udp_encap': p.is_udp_encap,
-                             'n_labels': len(p.nh_labels),
-                             'label_stack': p.nh_labels})
         return self.api(
             self.papi.bier_route_add_del,
             {'br_tbl_id': {"bt_set": bti.set_id,
                            "bt_sub_domain": bti.sub_domain_id,
                            "bt_hdr_len_id": bti.hdr_len_id},
              'br_bp': bp,
-             'br_n_paths': len(br_paths),
-             'br_paths': br_paths,
+             'br_n_paths': len(paths),
+             'br_paths': paths,
              'br_is_add': is_add})
 
     def bier_route_dump(self, bti):
@@ -2829,12 +2964,16 @@ class VppPapiProvider(object):
                                 bdti,
                                 bp,
                                 payload_proto,
+                                next_hop_afi,
                                 next_hop,
                                 next_hop_tbl_id=0,
                                 next_hop_rpf_id=~0,
                                 next_hop_is_ip4=1,
                                 is_add=1):
         """ BIER Route add/del """
+        lstack = []
+        while (len(lstack) < 16):
+            lstack.append({})
         return self.api(
             self.papi.bier_disp_entry_add_del,
             {'bde_tbl_id': bdti,
@@ -2843,10 +2982,10 @@ class VppPapiProvider(object):
              'bde_n_paths': 1,
              'bde_paths': [{'next_hop': next_hop,
                             'table_id': next_hop_tbl_id,
-                            'afi': 0,
+                            'afi': next_hop_afi,
                             'rpf_id': next_hop_rpf_id,
                             'n_labels': 0,
-                            'label_stack': [0]}],
+                            'label_stack': lstack}],
              'bde_is_add': is_add})
 
     def bier_disp_entry_dump(self, bdti):
@@ -3045,3 +3184,160 @@ class VppPapiProvider(object):
              'ip6_fib_id': ip6_fib_id,
              'namespace_id': namespace_id,
              'namespace_id_len': len(namespace_id)})
+
+    def punt_socket_register(self, l4_port, pathname, header_version=1,
+                             is_ip4=1, l4_protocol=0x11):
+        """ Punt to socket """
+        return self.api(self.papi.punt_socket_register,
+                        {'is_ip4': is_ip4,
+                         'l4_protocol': l4_protocol,
+                         'l4_port': l4_port,
+                         'pathname': pathname,
+                         'header_version': header_version})
+
+    def ip_reassembly_set(self, timeout_ms, max_reassemblies,
+                          expire_walk_interval_ms, is_ip6=0):
+        """ Set IP reassembly parameters """
+        return self.api(self.papi.ip_reassembly_set,
+                        {'is_ip6': is_ip6,
+                         'timeout_ms': timeout_ms,
+                         'expire_walk_interval_ms': expire_walk_interval_ms,
+                         'max_reassemblies': max_reassemblies})
+
+    def ip_reassembly_get(self, is_ip6=0):
+        """ Get IP reassembly parameters """
+        return self.api(self.papi.ip_reassembly_get, {'is_ip6': is_ip6})
+
+    def ip_reassembly_enable_disable(self, sw_if_index, enable_ip4=False,
+                                     enable_ip6=False):
+        """ Enable/disable IP reassembly """
+        return self.api(self.papi.ip_reassembly_enable_disable,
+                        {'sw_if_index': sw_if_index,
+                         'enable_ip4': 1 if enable_ip4 else 0,
+                         'enable_ip6': 1 if enable_ip6 else 0,
+                         })
+
+    def gbp_endpoint_add_del(self, is_add, sw_if_index, addr, is_ip6, epg):
+        """ GBP endpoint Add/Del """
+        return self.api(self.papi.gbp_endpoint_add_del,
+                        {'is_add': is_add,
+                         'endpoint': {
+                             'is_ip6': is_ip6,
+                             'sw_if_index': sw_if_index,
+                             'address': addr,
+                             'epg_id': epg}})
+
+    def gbp_endpoint_dump(self):
+        """ GBP endpoint Dump """
+        return self.api(self.papi.gbp_endpoint_dump, {})
+
+    def gbp_contract_add_del(self, is_add, src_epg, dst_epg, acl_index):
+        """ GBP contract Add/Del """
+        return self.api(self.papi.gbp_contract_add_del,
+                        {'is_add': is_add,
+                         'contract': {
+                             'acl_index': acl_index,
+                             'src_epg': src_epg,
+                             'dst_epg': dst_epg}})
+
+    def gbp_contract_dump(self):
+        """ GBP contract Dump """
+        return self.api(self.papi.gbp_contract_dump, {})
+
+    def ipip_6rd_add_tunnel(self, fib_index, ip6_prefix, ip6_prefix_len,
+                            ip4_prefix, ip4_prefix_len, ip4_src,
+                            security_check):
+        """ 6RD tunnel Add """
+        return self.api(self.papi.ipip_6rd_add_tunnel,
+                        {'fib_index': fib_index,
+                         'ip6_prefix': ip6_prefix,
+                         'ip6_prefix_len': ip6_prefix_len,
+                         'ip4_prefix': ip4_prefix,
+                         'ip4_prefix_len': ip4_prefix_len,
+                         'ip4_src': ip4_src,
+                         'security_check': security_check})
+
+    def ipip_6rd_del_tunnel(self, sw_if_index):
+        """ 6RD tunnel Delete """
+        return self.api(self.papi.ipip_6rd_del_tunnel,
+                        {'sw_if_index': sw_if_index})
+
+    def ipip_add_tunnel(self, src_address, dst_address, is_ipv6=1,
+                        instance=0xFFFFFFFF, fib_index=0):
+        """ IPIP tunnel Add/Del """
+        return self.api(self.papi.ipip_add_tunnel,
+                        {'is_ipv6': is_ipv6,
+                         'instance': instance,
+                         'src_address': src_address,
+                         'dst_address': dst_address,
+                         'fib_index': fib_index})
+
+    def ipip_del_tunnel(self, sw_if_index):
+        """ IPIP tunnel Delete """
+        return self.api(self.papi.ipip_del_tunnel,
+                        {'sw_if_index': sw_if_index})
+
+    def qos_egress_map_update(self, id, outputs):
+        """ QOS egress map update """
+        return self.api(self.papi.qos_egress_map_update,
+                        {'map_id': id,
+                         'rows': outputs})
+
+    def qos_egress_map_delete(self, id):
+        """ QOS egress map delete """
+        return self.api(self.papi.qos_egress_map_delete,
+                        {'map_id': id})
+
+    def qos_mark_enable_disable(self, sw_if_index,
+                                output_source,
+                                map_id,
+                                enable):
+        """ QOS Mark Enable/Disable """
+        return self.api(self.papi.qos_mark_enable_disable,
+                        {'map_id': map_id,
+                         'sw_if_index': sw_if_index,
+                         'output_source': output_source,
+                         'enable': enable})
+
+    def qos_record_enable_disable(self, sw_if_index, input_source, enable):
+        """ IP QoS recording Enble/Disable """
+        return self.api(self.papi.qos_record_enable_disable,
+                        {'sw_if_index': sw_if_index,
+                         'input_source': input_source,
+                         'enable': enable})
+
+    def igmp_listen(self, enable, sw_if_index, saddr, gaddr):
+        """ Listen for new (S,G) on specified interface
+
+        :param enable: add/del
+        :param sw_if_index: interface sw index
+        :param saddr: source ip4 addr
+        :param gaddr: group ip4 addr
+        """
+        return self.api(self.papi.igmp_listen,
+                        {'enable': enable,
+                         'sw_if_index': sw_if_index,
+                         'saddr': saddr,
+                         'gaddr': gaddr})
+
+    def igmp_dump(self, sw_if_index=None):
+        """ Dump all (S,G) interface configurations """
+        if sw_if_index is None:
+            dump_all = 1
+            sw_if_index = 0
+        else:
+            dump_all = 0
+        return self.api(self.papi.igmp_dump, {'sw_if_index': sw_if_index,
+                                              'dump_all': dump_all})
+
+    def igmp_clear_interface(self, sw_if_index):
+        """ Remove all (S,G)s from specified interface
+            doesn't send IGMP report!
+        """
+        return self.api(
+            self.papi.igmp_clear_interface, {
+                'sw_if_index': sw_if_index})
+
+    def want_igmp_events(self, enable=1):
+        return self.api(self.papi.want_igmp_events, {'enable': enable,
+                                                     'pid': os.getpid()})