2 from logging import error
5 # from vnet/vnet/mpls/mpls_types.h
6 MPLS_IETF_MAX_LABEL = 0xfffff
7 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
10 class VppPapiProvider(object):
11 """VPP-api provider using vpp-papi
13 @property hook: hook object providing before and after api/cli hooks
18 def __init__(self, name, shm_prefix):
21 self.shm_prefix = shm_prefix
23 def register_hook(self, hook):
24 """Replace hook registration with new hook
32 """Connect the API to VPP"""
33 vpp_papi.connect(self.name, self.shm_prefix)
36 """Disconnect the API from VPP"""
39 def api(self, api_fn, api_args, expected_retval=0):
40 """Call API function and check it's return value
41 Call the appropriate hooks before and after the API call
43 :param api_fn: API function to call
44 :param api_args: tuple of API function arguments
45 :param expected_retval: Expected return value (Default value = 0)
46 :returns: reply from the API
49 self.hook.before_api(api_fn.__name__, api_args)
50 reply = api_fn(*api_args)
51 if hasattr(reply, 'retval') and reply.retval != expected_retval:
52 msg = "API call failed, expected retval == %d, got %s" % (
53 expected_retval, repr(reply))
56 self.hook.after_api(api_fn.__name__, api_args)
60 """Execute a CLI, calling the before/after hooks appropriately
62 :param cli: CLI to execute
66 self.hook.before_cli(cli)
68 r = vpp_papi.cli_inband(len(cli), cli)
69 self.hook.after_cli(cli)
70 if(hasattr(r, 'reply')):
71 return r.reply[0].decode().rstrip('\x00')
73 def show_version(self):
75 return vpp_papi.show_version()
77 def pg_create_interface(self, pg_index):
83 return self.api(vpp_papi.pg_create_interface, (pg_index, ))
85 def sw_interface_dump(self, filter=None):
88 :param filter: (Default value = None)
91 if filter is not None:
95 return self.api(vpp_papi.sw_interface_dump, args)
97 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
98 is_ipv6=0, is_add=1, del_all=0):
101 :param addr: param is_ipv6: (Default value = 0)
104 :param is_ipv6: (Default value = 0)
105 :param is_add: (Default value = 1)
106 :param del_all: (Default value = 0)
109 return self.api(vpp_papi.sw_interface_add_del_address,
110 (sw_if_index, is_add, is_ipv6, del_all, addr_len, addr))
112 def sw_interface_ra_suppress(self, sw_if_index):
127 return self.api(vpp_papi.sw_interface_ip6nd_ra_config,
128 (sw_if_index, suppress, managed, other,
129 ll_option, send_unicast, cease, is_no,
130 default_router, max_interval, min_interval,
131 lifetime, initial_count, initial_interval, async))
134 def vxlan_add_del_tunnel(
141 decap_next_index=0xFFFFFFFF,
147 :param is_add: (Default value = 1)
148 :param is_ipv6: (Default value = 0)
149 :param encap_vrf_id: (Default value = 0)
150 :param decap_next_index: (Default value = 0xFFFFFFFF)
151 :param vni: (Default value = 0)
154 return self.api(vpp_papi.vxlan_add_del_tunnel,
155 (is_add, is_ipv6, src_addr, dst_addr, encap_vrf_id,
156 decap_next_index, vni))
158 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
159 shg=0, bvi=0, enable=1):
164 :param shg: (Default value = 0)
165 :param bvi: (Default value = 0)
166 :param enable: (Default value = 1)
169 return self.api(vpp_papi.sw_interface_set_l2_bridge,
170 (sw_if_index, bd_id, shg, bvi, enable))
172 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
174 """Create or delete unidirectional cross-connect from Tx interface to
177 :param rx_sw_if_index: Software interface index of Rx interface.
178 :param tx_sw_if_index: Software interface index of Tx interface.
179 :param enable: Create cross-connect if equal to 1, delete cross-connect
181 :type rx_sw_if_index: str or int
182 :type rx_sw_if_index: str or int
186 return self.api(vpp_papi.sw_interface_set_l2_xconnect,
187 (rx_sw_if_index, tx_sw_if_index, enable))
189 def sw_interface_set_flags(self, sw_if_index, admin_up_down,
190 link_up_down=0, deleted=0):
193 :param admin_up_down:
195 :param link_up_down: (Default value = 0)
196 :param deleted: (Default value = 0)
199 return self.api(vpp_papi.sw_interface_set_flags,
200 (sw_if_index, admin_up_down, link_up_down, deleted))
202 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
203 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
204 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
205 """Create subinterface
206 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
208 :param sub_id: param inner_vlan:
212 :param no_tags: (Default value = 0)
213 :param one_tag: (Default value = 0)
214 :param two_tags: (Default value = 0)
215 :param dot1ad: (Default value = 0)
216 :param exact_match: (Default value = 0)
217 :param default_sub: (Default value = 0)
218 :param outer_vlan_id_any: (Default value = 0)
219 :param inner_vlan_id_any: (Default value = 0)
223 vpp_papi.create_subif,
237 def create_vlan_subif(self, sw_if_index, vlan):
244 return self.api(vpp_papi.create_vlan_subif, (sw_if_index, vlan))
246 def ip_add_del_route(
251 next_hop_sw_if_index=0xFFFFFFFF,
254 classify_table_index=0xFFFFFFFF,
255 next_hop_out_label=MPLS_LABEL_INVALID,
257 create_vrf_if_needed=0,
266 is_resolve_attached=0,
271 :param dst_address_length:
272 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
274 :param next_hop_address:
275 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
276 :param vrf_id: (Default value = 0)
277 :param lookup_in_vrf: (Default value = 0)
278 :param resolve_attempts: (Default value = 0)
279 :param classify_table_index: (Default value = 0xFFFFFFFF)
280 :param create_vrf_if_needed: (Default value = 0)
281 :param resolve_if_needed: (Default value = 0)
282 :param is_add: (Default value = 1)
283 :param is_drop: (Default value = 0)
284 :param is_ipv6: (Default value = 0)
285 :param is_local: (Default value = 0)
286 :param is_classify: (Default value = 0)
287 :param is_multipath: (Default value = 0)
288 :param is_resolve_host: (Default value = 0)
289 :param is_resolve_attached: (Default value = 0)
290 :param not_last: (Default value = 0)
291 :param next_hop_weight: (Default value = 1)
295 vpp_papi.ip_add_del_route,
296 (next_hop_sw_if_index,
299 classify_table_index,
302 create_vrf_if_needed,