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)
72 """Execute a CLI, calling the before/after hooks appropriately
74 :param cli: CLI to execute
78 self.hook.before_cli(cli)
80 r = vpp_papi.cli_inband(len(cli), cli)
81 self.hook.after_cli(cli)
82 if(hasattr(r, 'reply')):
83 return r.reply[0].decode().rstrip('\x00')
85 def show_version(self):
87 return vpp_papi.show_version()
89 def pg_create_interface(self, pg_index):
95 return self.api(vpp_papi.pg_create_interface, (pg_index, ))
97 def sw_interface_dump(self, filter=None):
100 :param filter: (Default value = None)
103 if filter is not None:
107 return self.api(vpp_papi.sw_interface_dump, args)
109 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
111 Set the IPvX Table-id for the Interface
118 return self.api(vpp_papi.sw_interface_set_table,
119 (sw_if_index, is_ipv6, table_id))
121 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
122 is_ipv6=0, is_add=1, del_all=0):
125 :param addr: param is_ipv6: (Default value = 0)
128 :param is_ipv6: (Default value = 0)
129 :param is_add: (Default value = 1)
130 :param del_all: (Default value = 0)
133 return self.api(vpp_papi.sw_interface_add_del_address,
134 (sw_if_index, is_add, is_ipv6, del_all, addr_len, addr))
136 def sw_interface_enable_disable_mpls(self, sw_if_index,
139 Enable/Disable MPLS on the interface
141 :param is_enable: (Default value = 1)
144 return self.api(vpp_papi.sw_interface_set_mpls_enable,
145 (sw_if_index, is_enable))
147 def sw_interface_ra_suppress(self, sw_if_index):
162 return self.api(vpp_papi.sw_interface_ip6nd_ra_config,
163 (sw_if_index, suppress, managed, other,
164 ll_option, send_unicast, cease, is_no,
165 default_router, max_interval, min_interval,
166 lifetime, initial_count, initial_interval, async))
168 def vxlan_add_del_tunnel(
175 decap_next_index=0xFFFFFFFF,
181 :param is_add: (Default value = 1)
182 :param is_ipv6: (Default value = 0)
183 :param encap_vrf_id: (Default value = 0)
184 :param decap_next_index: (Default value = 0xFFFFFFFF)
185 :param vni: (Default value = 0)
188 return self.api(vpp_papi.vxlan_add_del_tunnel,
189 (is_add, is_ipv6, src_addr, dst_addr, encap_vrf_id,
190 decap_next_index, vni))
192 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
193 shg=0, bvi=0, enable=1):
198 :param shg: (Default value = 0)
199 :param bvi: (Default value = 0)
200 :param enable: (Default value = 1)
203 return self.api(vpp_papi.sw_interface_set_l2_bridge,
204 (sw_if_index, bd_id, shg, bvi, enable))
206 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
208 """Create or delete unidirectional cross-connect from Tx interface to
211 :param rx_sw_if_index: Software interface index of Rx interface.
212 :param tx_sw_if_index: Software interface index of Tx interface.
213 :param enable: Create cross-connect if equal to 1, delete cross-connect
215 :type rx_sw_if_index: str or int
216 :type rx_sw_if_index: str or int
220 return self.api(vpp_papi.sw_interface_set_l2_xconnect,
221 (rx_sw_if_index, tx_sw_if_index, enable))
223 def sw_interface_set_flags(self, sw_if_index, admin_up_down,
224 link_up_down=0, deleted=0):
227 :param admin_up_down:
229 :param link_up_down: (Default value = 0)
230 :param deleted: (Default value = 0)
233 return self.api(vpp_papi.sw_interface_set_flags,
234 (sw_if_index, admin_up_down, link_up_down, deleted))
236 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
237 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
238 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
239 """Create subinterface
240 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
242 :param sub_id: param inner_vlan:
246 :param no_tags: (Default value = 0)
247 :param one_tag: (Default value = 0)
248 :param two_tags: (Default value = 0)
249 :param dot1ad: (Default value = 0)
250 :param exact_match: (Default value = 0)
251 :param default_sub: (Default value = 0)
252 :param outer_vlan_id_any: (Default value = 0)
253 :param inner_vlan_id_any: (Default value = 0)
257 vpp_papi.create_subif,
271 def create_vlan_subif(self, sw_if_index, vlan):
278 return self.api(vpp_papi.create_vlan_subif, (sw_if_index, vlan))
280 def ip_add_del_route(
285 next_hop_sw_if_index=0xFFFFFFFF,
288 classify_table_index=0xFFFFFFFF,
289 next_hop_out_label=MPLS_LABEL_INVALID,
291 create_vrf_if_needed=0,
302 is_resolve_attached=0,
307 :param dst_address_length:
308 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
310 :param next_hop_address:
311 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
312 :param vrf_id: (Default value = 0)
313 :param lookup_in_vrf: (Default value = 0)
314 :param resolve_attempts: (Default value = 0)
315 :param classify_table_index: (Default value = 0xFFFFFFFF)
316 :param create_vrf_if_needed: (Default value = 0)
317 :param resolve_if_needed: (Default value = 0)
318 :param is_add: (Default value = 1)
319 :param is_drop: (Default value = 0)
320 :param is_ipv6: (Default value = 0)
321 :param is_local: (Default value = 0)
322 :param is_classify: (Default value = 0)
323 :param is_multipath: (Default value = 0)
324 :param is_resolve_host: (Default value = 0)
325 :param is_resolve_attached: (Default value = 0)
326 :param not_last: (Default value = 0)
327 :param next_hop_weight: (Default value = 1)
331 vpp_papi.ip_add_del_route,
332 (next_hop_sw_if_index,
335 classify_table_index,
338 create_vrf_if_needed,