2 from logging import error
7 no_vpp_papi = os.getenv("NO_VPP_PAPI")
17 # from vnet/vnet/mpls/mpls_types.h
18 MPLS_IETF_MAX_LABEL = 0xfffff
19 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
22 class VppPapiProvider(object):
23 """VPP-api provider using vpp-papi
25 @property hook: hook object providing before and after api/cli hooks
30 def __init__(self, name, shm_prefix):
31 self.hook = Hook("vpp-papi-provider")
33 self.shm_prefix = shm_prefix
35 def register_hook(self, hook):
36 """Replace hook registration with new hook
44 """Connect the API to VPP"""
45 vpp_papi.connect(self.name, self.shm_prefix)
48 """Disconnect the API from VPP"""
51 def api(self, api_fn, api_args, expected_retval=0):
52 """Call API function and check it's return value
53 Call the appropriate hooks before and after the API call
55 :param api_fn: API function to call
56 :param api_args: tuple of API function arguments
57 :param expected_retval: Expected return value (Default value = 0)
58 :returns: reply from the API
61 self.hook.before_api(api_fn.__name__, api_args)
62 reply = api_fn(*api_args)
63 if hasattr(reply, 'retval') and reply.retval != expected_retval:
64 msg = "API call failed, expected retval == %d, got %s" % (
65 expected_retval, repr(reply))
68 self.hook.after_api(api_fn.__name__, api_args)
73 Execute a CLI, calling the before/after hooks appropriately.
75 :param cli: CLI to execute
79 self.hook.before_cli(cli)
81 r = vpp_papi.cli_inband(len(cli), cli)
82 self.hook.after_cli(cli)
83 if hasattr(r, 'reply'):
84 return r.reply[0].decode().rstrip('\x00')
88 Helping method to print CLI command in case of info logging level.
90 :param cli: CLI to execute
93 return cli + "\n" + self.cli(cli)
95 def show_version(self):
97 return vpp_papi.show_version()
99 def pg_create_interface(self, pg_index):
105 return self.api(vpp_papi.pg_create_interface, (pg_index, ))
107 def sw_interface_dump(self, filter=None):
110 :param filter: (Default value = None)
113 if filter is not None:
117 return self.api(vpp_papi.sw_interface_dump, args)
119 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
121 Set the IPvX Table-id for the Interface
128 return self.api(vpp_papi.sw_interface_set_table,
129 (sw_if_index, is_ipv6, table_id))
131 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
132 is_ipv6=0, is_add=1, del_all=0):
135 :param addr: param is_ipv6: (Default value = 0)
138 :param is_ipv6: (Default value = 0)
139 :param is_add: (Default value = 1)
140 :param del_all: (Default value = 0)
143 return self.api(vpp_papi.sw_interface_add_del_address,
144 (sw_if_index, is_add, is_ipv6, del_all, addr_len, addr))
146 def sw_interface_enable_disable_mpls(self, sw_if_index,
149 Enable/Disable MPLS on the interface
151 :param is_enable: (Default value = 1)
154 return self.api(vpp_papi.sw_interface_set_mpls_enable,
155 (sw_if_index, is_enable))
157 def sw_interface_ra_suppress(self, sw_if_index):
172 return self.api(vpp_papi.sw_interface_ip6nd_ra_config,
173 (sw_if_index, suppress, managed, other,
174 ll_option, send_unicast, cease, is_no,
175 default_router, max_interval, min_interval,
176 lifetime, initial_count, initial_interval, async))
178 def vxlan_add_del_tunnel(
185 decap_next_index=0xFFFFFFFF,
191 :param is_add: (Default value = 1)
192 :param is_ipv6: (Default value = 0)
193 :param encap_vrf_id: (Default value = 0)
194 :param decap_next_index: (Default value = 0xFFFFFFFF)
195 :param vni: (Default value = 0)
198 return self.api(vpp_papi.vxlan_add_del_tunnel,
199 (is_add, is_ipv6, src_addr, dst_addr, encap_vrf_id,
200 decap_next_index, vni))
202 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
203 shg=0, bvi=0, enable=1):
208 :param shg: (Default value = 0)
209 :param bvi: (Default value = 0)
210 :param enable: (Default value = 1)
213 return self.api(vpp_papi.sw_interface_set_l2_bridge,
214 (sw_if_index, bd_id, shg, bvi, enable))
216 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
218 """Create or delete unidirectional cross-connect from Tx interface to
221 :param rx_sw_if_index: Software interface index of Rx interface.
222 :param tx_sw_if_index: Software interface index of Tx interface.
223 :param enable: Create cross-connect if equal to 1, delete cross-connect
225 :type rx_sw_if_index: str or int
226 :type rx_sw_if_index: str or int
230 return self.api(vpp_papi.sw_interface_set_l2_xconnect,
231 (rx_sw_if_index, tx_sw_if_index, enable))
233 def sw_interface_set_flags(self, sw_if_index, admin_up_down,
234 link_up_down=0, deleted=0):
237 :param admin_up_down:
239 :param link_up_down: (Default value = 0)
240 :param deleted: (Default value = 0)
243 return self.api(vpp_papi.sw_interface_set_flags,
244 (sw_if_index, admin_up_down, link_up_down, deleted))
246 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
247 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
248 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
249 """Create subinterface
250 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
252 :param sub_id: param inner_vlan:
256 :param no_tags: (Default value = 0)
257 :param one_tag: (Default value = 0)
258 :param two_tags: (Default value = 0)
259 :param dot1ad: (Default value = 0)
260 :param exact_match: (Default value = 0)
261 :param default_sub: (Default value = 0)
262 :param outer_vlan_id_any: (Default value = 0)
263 :param inner_vlan_id_any: (Default value = 0)
267 vpp_papi.create_subif,
281 def create_vlan_subif(self, sw_if_index, vlan):
288 return self.api(vpp_papi.create_vlan_subif, (sw_if_index, vlan))
290 def create_loopback(self, mac=''):
293 :param mac: (Optional)
295 return self.api(vpp_papi.create_loopback, (mac,))
297 def ip_add_del_route(
302 next_hop_sw_if_index=0xFFFFFFFF,
305 classify_table_index=0xFFFFFFFF,
306 next_hop_out_label=MPLS_LABEL_INVALID,
308 create_vrf_if_needed=0,
319 is_resolve_attached=0,
324 :param dst_address_length:
325 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
327 :param next_hop_address:
328 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
329 :param vrf_id: (Default value = 0)
330 :param lookup_in_vrf: (Default value = 0)
331 :param resolve_attempts: (Default value = 0)
332 :param classify_table_index: (Default value = 0xFFFFFFFF)
333 :param create_vrf_if_needed: (Default value = 0)
334 :param resolve_if_needed: (Default value = 0)
335 :param is_add: (Default value = 1)
336 :param is_drop: (Default value = 0)
337 :param is_ipv6: (Default value = 0)
338 :param is_local: (Default value = 0)
339 :param is_classify: (Default value = 0)
340 :param is_multipath: (Default value = 0)
341 :param is_resolve_host: (Default value = 0)
342 :param is_resolve_attached: (Default value = 0)
343 :param not_last: (Default value = 0)
344 :param next_hop_weight: (Default value = 1)
348 vpp_papi.ip_add_del_route,
349 (next_hop_sw_if_index,
352 classify_table_index,
355 create_vrf_if_needed,
373 def ip_neighbor_add_del(self,
382 """ Add neighbor MAC to IPv4 or IPv6 address.
387 :param vrf_id: (Default value = 0)
388 :param is_add: (Default value = 1)
389 :param is_ipv6: (Default value = 0)
390 :param is_static: (Default value = 0)
394 vpp_papi.ip_neighbor_add_del,