8 from util import Host, mk_ll_addr
9 from vpp_papi import mac_ntop, VppEnum
10 from ipaddress import IPv4Network, IPv6Network
18 @six.add_metaclass(abc.ABCMeta)
19 class VppInterface(object):
20 """Generic VPP interface."""
23 def sw_if_index(self):
24 """Interface index assigned by VPP."""
25 return self._sw_if_index
29 """MAC-address of the remote interface "connected" to this interface"""
30 return self._remote_hosts[0].mac
34 """MAC-address of the VPP interface."""
35 return str(self._local_mac)
39 return self._local_addr
42 def remote_addr(self):
43 return self._remote_addr
47 """Local IPv4 address on VPP interface (string)."""
48 return self._local_ip4
51 def local_ip4(self, value):
52 self._local_ip4 = value
55 def local_ip4_prefix_len(self):
56 """Local IPv4 prefix length """
57 return self._local_ip4_len
59 @local_ip4_prefix_len.setter
60 def local_ip4_prefix_len(self, value):
61 self._local_ip4_len = value
64 def local_ip4_prefix(self):
65 """Local IPv4 prefix """
66 return ("%s/%d" % (self._local_ip4, self._local_ip4_len))
71 """Local IPv4 address - raw, suitable as API parameter."""
72 return socket.inet_pton(socket.AF_INET, self._local_ip4)
76 """IPv4 address of remote peer "connected" to this interface."""
77 return self._remote_hosts[0].ip4
80 def remote_ip4n(self):
82 """Local IPv6 address - raw, suitable as API parameter."""
83 return socket.inet_pton(socket.AF_INET, self._remote_hosts[0].ip4)
87 """Local IPv6 address on VPP interface (string)."""
88 return self._local_ip6
91 def local_ip6(self, value):
95 def local_ip6_prefix_len(self):
96 """Local IPv6 prefix length """
97 return self._local_ip6_len
99 @local_ip6_prefix_len.setter
100 def local_ip6_prefix_len(self, value):
101 self._local_ip6_len = value
104 def local_ip6_prefix(self):
105 """Local IPv4 prefix """
106 return ("%s/%d" % (self._local_ip6, self._local_ip6_len))
109 def local_ip6n(self):
111 """Local IPv6 address - raw, suitable as API parameter."""
112 return socket.inet_pton(socket.AF_INET6, self._local_ip6)
115 def remote_ip6(self):
116 """IPv6 address of remote peer "connected" to this interface."""
117 return self._remote_hosts[0].ip6
120 def remote_ip6n(self):
122 """Local IPv6 address - raw, suitable as API parameter."""
123 return socket.inet_pton(socket.AF_INET6, self._remote_hosts[0].ip6)
126 def local_ip6_ll(self):
127 """Local IPv6 link-local address on VPP interface (string)."""
128 return self._local_ip6_ll
131 def local_ip6n_ll(self):
133 """Local IPv6 link-local address on VPP interface (string)."""
134 return socket.inet_pton(socket.AF_INET6, self._local_ip6_ll.address)
137 def remote_ip6_ll(self):
138 """Link-local IPv6 address of remote peer
139 "connected" to this interface."""
140 return self._remote_ip6_ll
143 def remote_ip6n_ll(self):
145 """Local IPv6 link-local address on VPP interface (string)."""
146 return socket.inet_pton(socket.AF_INET6, self._remote_ip6_ll)
150 """Name of the interface."""
155 """RAW result of sw_interface_dump for this interface."""
160 """Test case creating this interface."""
164 def remote_hosts(self):
165 """Remote hosts list"""
166 return self._remote_hosts
169 def remote_hosts(self, value):
171 :param list value: List of remote hosts.
173 self._remote_hosts = value
174 self._hosts_by_mac = {}
175 self._hosts_by_ip4 = {}
176 self._hosts_by_ip6 = {}
177 for host in self._remote_hosts:
178 self._hosts_by_mac[host.mac] = host
179 self._hosts_by_ip4[host.ip4] = host
180 self._hosts_by_ip6[host.ip6] = host
182 def host_by_mac(self, mac):
184 :param mac: MAC address to find host by.
185 :return: Host object assigned to interface.
187 return self._hosts_by_mac[mac]
189 def host_by_ip4(self, ip):
191 :param ip: IPv4 address to find host by.
192 :return: Host object assigned to interface.
194 return self._hosts_by_ip4[ip]
196 def host_by_ip6(self, ip):
198 :param ip: IPv6 address to find host by.
199 :return: Host object assigned to interface.
201 return self._hosts_by_ip6[ip]
203 def generate_remote_hosts(self, count=1):
204 """Generate and add remote hosts for the interface.
206 :param int count: Number of generated remote hosts.
208 self._remote_hosts = []
209 self._hosts_by_mac = {}
210 self._hosts_by_ip4 = {}
211 self._hosts_by_ip6 = {}
213 2, count + 2): # 0: network address, 1: local vpp address
214 mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i)
215 ip4 = "172.16.%u.%u" % (self.sw_if_index, i)
216 ip6 = "fd01:%x::%x" % (self.sw_if_index, i)
217 ip6_ll = mk_ll_addr(mac)
218 host = Host(mac, ip4, ip6, ip6_ll)
219 self._remote_hosts.append(host)
220 self._hosts_by_mac[mac] = host
221 self._hosts_by_ip4[ip4] = host
222 self._hosts_by_ip6[ip6] = host
225 def __init__(self, test):
228 self._remote_hosts = []
229 self._hosts_by_mac = {}
230 self._hosts_by_ip4 = {}
231 self._hosts_by_ip6 = {}
233 def set_mac(self, mac):
234 self._local_mac = str(mac)
235 self._local_ip6_ll = mk_ll_addr(self._local_mac)
236 self.test.vapi.sw_interface_set_mac_address(
237 self.sw_if_index, mac.packed)
239 def set_sw_if_index(self, sw_if_index):
240 self._sw_if_index = sw_if_index
242 self.generate_remote_hosts()
244 self._local_ip4 = "172.16.%u.1" % self.sw_if_index
245 self._local_ip4_len = 24
246 self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index
247 self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index
248 self.has_ip4_config = False
249 self.ip4_table_id = 0
251 self._local_ip6 = "fd01:%x::1" % self.sw_if_index
252 self._local_ip6_len = 64
253 self.has_ip6_config = False
254 self.ip6_table_id = 0
256 self._local_addr = {socket.AF_INET: self.local_ip4,
257 socket.AF_INET6: self.local_ip6}
258 self._remote_addr = {socket.AF_INET: self.remote_ip4,
259 socket.AF_INET6: self.remote_ip6}
261 r = self.test.vapi.sw_interface_dump(sw_if_index=self.sw_if_index)
263 if intf.sw_if_index == self.sw_if_index:
264 self._name = intf.interface_name
265 self._local_mac = intf.l2_address
270 "Could not find interface with sw_if_index %d "
271 "in interface dump %s" %
272 (self.sw_if_index, moves.reprlib.repr(r)))
273 self._local_ip6_ll = mk_ll_addr(self.local_mac)
274 self._remote_ip6_ll = mk_ll_addr(self.remote_mac)
276 def config_ip4(self):
277 """Configure IPv4 address on the VPP interface."""
278 self.test.vapi.sw_interface_add_del_address(
279 sw_if_index=self.sw_if_index, prefix=self.local_ip4_prefix)
280 self.has_ip4_config = True
282 def unconfig_ip4(self):
283 """Remove IPv4 address on the VPP interface."""
285 if self.has_ip4_config:
286 self.test.vapi.sw_interface_add_del_address(
287 sw_if_index=self.sw_if_index,
288 prefix=self.local_ip4_prefix, is_add=0)
289 except AttributeError:
290 self.has_ip4_config = False
291 self.has_ip4_config = False
293 def configure_ipv4_neighbors(self):
294 """For every remote host assign neighbor's MAC to IPv4 addresses.
296 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
298 for host in self._remote_hosts:
299 self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
303 def config_ip6(self):
304 """Configure IPv6 address on the VPP interface."""
305 self.test.vapi.sw_interface_add_del_address(
306 sw_if_index=self.sw_if_index, prefix=self.local_ip6_prefix)
307 self.has_ip6_config = True
309 def unconfig_ip6(self):
310 """Remove IPv6 address on the VPP interface."""
312 if self.has_ip6_config:
313 self.test.vapi.sw_interface_add_del_address(
314 sw_if_index=self.sw_if_index,
315 prefix=self.local_ip6_prefix, is_add=0)
316 except AttributeError:
317 self.has_ip6_config = False
318 self.has_ip6_config = False
320 def configure_ipv6_neighbors(self):
321 """For every remote host assign neighbor's MAC to IPv6 addresses.
323 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
325 for host in self._remote_hosts:
326 self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
331 """Unconfigure IPv6 and IPv4 address on the VPP interface."""
335 def set_table_ip4(self, table_id):
336 """Set the interface in a IPv4 Table.
338 .. note:: Must be called before configuring IP4 addresses.
340 self.ip4_table_id = table_id
341 self.test.vapi.sw_interface_set_table(
342 self.sw_if_index, 0, self.ip4_table_id)
344 def set_table_ip6(self, table_id):
345 """Set the interface in a IPv6 Table.
347 .. note:: Must be called before configuring IP6 addresses.
349 self.ip6_table_id = table_id
350 self.test.vapi.sw_interface_set_table(
351 self.sw_if_index, 1, self.ip6_table_id)
353 def disable_ipv6_ra(self):
354 """Configure IPv6 RA suppress on the VPP interface."""
355 self.test.vapi.sw_interface_ip6nd_ra_config(
356 sw_if_index=self.sw_if_index,
359 def ip6_ra_config(self, no=0, suppress=0, send_unicast=0):
360 """Configure IPv6 RA suppress on the VPP interface."""
361 self.test.vapi.sw_interface_ip6nd_ra_config(
362 sw_if_index=self.sw_if_index,
365 send_unicast=send_unicast)
367 def ip6_ra_prefix(self, prefix, is_no=0,
368 off_link=0, no_autoconfig=0, use_default=0):
369 """Configure IPv6 RA suppress on the VPP interface.
371 prefix can be a string in the format of '<address>/<length_in_bits>'
372 or ipaddress.ipnetwork object (if strict.)"""
374 self.test.vapi.sw_interface_ip6nd_ra_prefix(
375 sw_if_index=self.sw_if_index,
377 use_default=use_default,
378 off_link=off_link, no_autoconfig=no_autoconfig,
382 """Put interface ADMIN-UP."""
383 self.test.vapi.sw_interface_set_flags(
385 flags=VppEnum.vl_api_if_status_flags_t.IF_STATUS_API_FLAG_ADMIN_UP)
387 def admin_down(self):
388 """Put interface ADMIN-down."""
389 self.test.vapi.sw_interface_set_flags(self.sw_if_index,
393 """Put interface link-state-UP."""
394 self.test.vapi.cli("test interface link-state %s up" % self.name)
397 """Put interface link-state-down."""
398 self.test.vapi.cli("test interface link-state %s down" % self.name)
400 def ip6_enable(self):
401 """IPv6 Enable interface"""
402 self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index,
405 def ip6_disable(self):
406 """Put interface ADMIN-DOWN."""
407 self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index,
410 def add_sub_if(self, sub_if):
411 """Register a sub-interface with this interface.
413 :param sub_if: sub-interface
415 if not hasattr(self, 'sub_if'):
418 if isinstance(self.sub_if, list):
419 self.sub_if.append(sub_if)
423 def enable_mpls(self):
424 """Enable MPLS on the VPP interface."""
425 self.test.vapi.sw_interface_set_mpls_enable(self.sw_if_index)
427 def disable_mpls(self):
428 """Enable MPLS on the VPP interface."""
429 self.test.vapi.sw_interface_set_mpls_enable(self.sw_if_index, 0)
431 def is_ip4_entry_in_fib_dump(self, dump):
433 n = IPv4Network(text_type("%s/%d" % (self.local_ip4,
434 self.local_ip4_prefix_len)))
435 if i.route.prefix == n and \
436 i.route.table_id == self.ip4_table_id:
440 def set_unnumbered(self, ip_sw_if_index):
441 """ Set the interface to unnumbered via ip_sw_if_index """
442 self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
445 def unset_unnumbered(self, ip_sw_if_index):
446 """ Unset the interface to unnumbered via ip_sw_if_index """
447 self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
448 self.sw_if_index, is_add=0)
450 def set_proxy_arp(self, enable=1):
451 """ Set the interface to enable/disable Proxy ARP """
452 self.test.vapi.proxy_arp_intfc_enable_disable(
456 def query_vpp_config(self):
457 dump = self.test.vapi.sw_interface_dump(sw_if_index=self.sw_if_index)
458 return self.is_interface_config_in_dump(dump)
460 def get_interface_config_from_dump(self, dump):
462 if i.interface_name.rstrip(' \t\r\n\0') == self.name and \
463 i.sw_if_index == self.sw_if_index:
468 def is_interface_config_in_dump(self, dump):
469 return self.get_interface_config_from_dump(dump) is not None
471 def assert_interface_state(self, admin_up_down, link_up_down,
474 event = self.test.vapi.wait_for_event(timeout=1,
475 name='sw_interface_event')
476 self.test.assert_equal(event.sw_if_index, self.sw_if_index,
478 self.test.assert_equal((event.flags & 1), admin_up_down,
480 self.test.assert_equal((event.flags & 2), link_up_down,
482 dump = self.test.vapi.sw_interface_dump()
483 if_state = self.get_interface_config_from_dump(dump)
484 self.test.assert_equal((if_state.flags & 1), admin_up_down,
486 self.test.assert_equal((if_state.flags & 2), link_up_down,
492 def get_rx_stats(self):
493 c = self.test.statistics.get_counter("^/if/rx$")
494 return c[0][self.sw_if_index]
496 def get_tx_stats(self):
497 c = self.test.statistics.get_counter("^/if/tx$")
498 return c[0][self.sw_if_index]
500 def set_l3_mtu(self, mtu):
501 self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [mtu, 0, 0, 0])
503 def set_ip4_mtu(self, mtu):
504 self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [0, mtu, 0, 0])
506 def set_ip6_mtu(self, mtu):
507 self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [0, 0, mtu, 0])
509 def set_mpls_mtu(self, mtu):
510 self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [0, 0, 0, mtu])