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):
92 self._local_ip6 = 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 if sw_if_index > 255:
241 raise RuntimeError("Don't support sw_if_index values "
243 self._sw_if_index = sw_if_index
245 self.generate_remote_hosts()
247 self._local_ip4 = "172.16.%u.1" % self.sw_if_index
248 self._local_ip4_len = 24
249 self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index
250 self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index
251 self.has_ip4_config = False
252 self.ip4_table_id = 0
254 self._local_ip6 = "fd01:%x::1" % self.sw_if_index
255 self._local_ip6_len = 64
256 self.has_ip6_config = False
257 self.ip6_table_id = 0
259 self._local_addr = {socket.AF_INET: self.local_ip4,
260 socket.AF_INET6: self.local_ip6}
261 self._remote_addr = {socket.AF_INET: self.remote_ip4,
262 socket.AF_INET6: self.remote_ip6}
264 r = self.test.vapi.sw_interface_dump(sw_if_index=self.sw_if_index)
266 if intf.sw_if_index == self.sw_if_index:
267 self._name = intf.interface_name
268 self._local_mac = intf.l2_address
273 "Could not find interface with sw_if_index %d "
274 "in interface dump %s" %
275 (self.sw_if_index, moves.reprlib.repr(r)))
276 self._local_ip6_ll = mk_ll_addr(self.local_mac)
277 self._remote_ip6_ll = mk_ll_addr(self.remote_mac)
279 def config_ip4(self):
280 """Configure IPv4 address on the VPP interface."""
281 self.test.vapi.sw_interface_add_del_address(
282 sw_if_index=self.sw_if_index, prefix=self.local_ip4_prefix)
283 self.has_ip4_config = True
285 def unconfig_ip4(self):
286 """Remove IPv4 address on the VPP interface."""
288 if self.has_ip4_config:
289 self.test.vapi.sw_interface_add_del_address(
290 sw_if_index=self.sw_if_index,
291 prefix=self.local_ip4_prefix, is_add=0)
292 except AttributeError:
293 self.has_ip4_config = False
294 self.has_ip4_config = False
296 def configure_ipv4_neighbors(self):
297 """For every remote host assign neighbor's MAC to IPv4 addresses.
299 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
301 for host in self._remote_hosts:
302 self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
306 def config_ip6(self):
307 """Configure IPv6 address on the VPP interface."""
308 self.test.vapi.sw_interface_add_del_address(
309 sw_if_index=self.sw_if_index, prefix=self.local_ip6_prefix)
310 self.has_ip6_config = True
312 def unconfig_ip6(self):
313 """Remove IPv6 address on the VPP interface."""
315 if self.has_ip6_config:
316 self.test.vapi.sw_interface_add_del_address(
317 sw_if_index=self.sw_if_index,
318 prefix=self.local_ip6_prefix, is_add=0)
319 except AttributeError:
320 self.has_ip6_config = False
321 self.has_ip6_config = False
323 def configure_ipv6_neighbors(self):
324 """For every remote host assign neighbor's MAC to IPv6 addresses.
326 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
328 for host in self._remote_hosts:
329 self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
334 """Unconfigure IPv6 and IPv4 address on the VPP interface."""
338 def set_table_ip4(self, table_id):
339 """Set the interface in a IPv4 Table.
341 .. note:: Must be called before configuring IP4 addresses.
343 self.ip4_table_id = table_id
344 self.test.vapi.sw_interface_set_table(
345 self.sw_if_index, 0, self.ip4_table_id)
347 def set_table_ip6(self, table_id):
348 """Set the interface in a IPv6 Table.
350 .. note:: Must be called before configuring IP6 addresses.
352 self.ip6_table_id = table_id
353 self.test.vapi.sw_interface_set_table(
354 self.sw_if_index, 1, self.ip6_table_id)
356 def disable_ipv6_ra(self):
357 """Configure IPv6 RA suppress on the VPP interface."""
358 self.test.vapi.sw_interface_ip6nd_ra_config(
359 sw_if_index=self.sw_if_index,
362 def ip6_ra_config(self, no=0, suppress=0, send_unicast=0):
363 """Configure IPv6 RA suppress on the VPP interface."""
364 self.test.vapi.sw_interface_ip6nd_ra_config(
365 sw_if_index=self.sw_if_index,
368 send_unicast=send_unicast)
370 def ip6_ra_prefix(self, prefix, is_no=0,
371 off_link=0, no_autoconfig=0, use_default=0):
372 """Configure IPv6 RA suppress on the VPP interface.
374 prefix can be a string in the format of '<address>/<length_in_bits>'
375 or ipaddress.ipnetwork object (if strict.)"""
377 self.test.vapi.sw_interface_ip6nd_ra_prefix(
378 sw_if_index=self.sw_if_index,
380 use_default=use_default,
381 off_link=off_link, no_autoconfig=no_autoconfig,
385 """Put interface ADMIN-UP."""
386 self.test.vapi.sw_interface_set_flags(
388 flags=VppEnum.vl_api_if_status_flags_t.IF_STATUS_API_FLAG_ADMIN_UP)
390 def admin_down(self):
391 """Put interface ADMIN-down."""
392 self.test.vapi.sw_interface_set_flags(self.sw_if_index,
396 """Put interface link-state-UP."""
397 self.test.vapi.cli("test interface link-state %s up" % self.name)
400 """Put interface link-state-down."""
401 self.test.vapi.cli("test interface link-state %s down" % self.name)
403 def ip6_enable(self):
404 """IPv6 Enable interface"""
405 self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index,
408 def ip6_disable(self):
409 """Put interface ADMIN-DOWN."""
410 self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index,
413 def add_sub_if(self, sub_if):
414 """Register a sub-interface with this interface.
416 :param sub_if: sub-interface
418 if not hasattr(self, 'sub_if'):
421 if isinstance(self.sub_if, list):
422 self.sub_if.append(sub_if)
426 def enable_mpls(self):
427 """Enable MPLS on the VPP interface."""
428 self.test.vapi.sw_interface_set_mpls_enable(self.sw_if_index)
430 def disable_mpls(self):
431 """Enable MPLS on the VPP interface."""
432 self.test.vapi.sw_interface_set_mpls_enable(self.sw_if_index, 0)
434 def is_ip4_entry_in_fib_dump(self, dump):
436 n = IPv4Network(text_type("%s/%d" % (self.local_ip4,
437 self.local_ip4_prefix_len)))
438 if i.route.prefix == n and \
439 i.route.table_id == self.ip4_table_id:
443 def set_unnumbered(self, ip_sw_if_index):
444 """ Set the interface to unnumbered via ip_sw_if_index """
445 self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
448 def unset_unnumbered(self, ip_sw_if_index):
449 """ Unset the interface to unnumbered via ip_sw_if_index """
450 self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
451 self.sw_if_index, is_add=0)
453 def set_proxy_arp(self, enable=1):
454 """ Set the interface to enable/disable Proxy ARP """
455 self.test.vapi.proxy_arp_intfc_enable_disable(
459 def query_vpp_config(self):
460 dump = self.test.vapi.sw_interface_dump(sw_if_index=self.sw_if_index)
461 return self.is_interface_config_in_dump(dump)
463 def get_interface_config_from_dump(self, dump):
465 if i.interface_name.rstrip(' \t\r\n\0') == self.name and \
466 i.sw_if_index == self.sw_if_index:
471 def is_interface_config_in_dump(self, dump):
472 return self.get_interface_config_from_dump(dump) is not None
474 def assert_interface_state(self, admin_up_down, link_up_down,
477 event = self.test.vapi.wait_for_event(timeout=1,
478 name='sw_interface_event')
479 self.test.assert_equal(event.sw_if_index, self.sw_if_index,
481 self.test.assert_equal((event.flags & 1), admin_up_down,
483 self.test.assert_equal((event.flags & 2), link_up_down,
485 dump = self.test.vapi.sw_interface_dump()
486 if_state = self.get_interface_config_from_dump(dump)
487 self.test.assert_equal((if_state.flags & 1), admin_up_down,
489 self.test.assert_equal((if_state.flags & 2), link_up_down,
495 def get_rx_stats(self):
496 c = self.test.statistics.get_counter("^/if/rx$")
497 return c[0][self.sw_if_index]
499 def get_tx_stats(self):
500 c = self.test.statistics.get_counter("^/if/tx$")
501 return c[0][self.sw_if_index]
503 def set_l3_mtu(self, mtu):
504 self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [mtu, 0, 0, 0])
506 def set_ip4_mtu(self, mtu):
507 self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [0, mtu, 0, 0])
509 def set_ip6_mtu(self, mtu):
510 self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [0, 0, mtu, 0])
512 def set_mpls_mtu(self, mtu):
513 self.test.vapi.sw_interface_set_mtu(self.sw_if_index, [0, 0, 0, mtu])