8 from util import Host, mk_ll_addr
9 from vpp_papi import mac_ntop
10 from ipaddress import IPv4Network
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 self._local_mac
39 return self._local_addr
42 def remote_addr(self):
43 return self._remote_addr
46 def local_addr_n(self):
47 return self._local_addr_n
50 def remote_addr_n(self):
51 return self._remote_addr_n
55 """Local IPv4 address on VPP interface (string)."""
56 return self._local_ip4
60 """Local IPv4 address - raw, suitable as API parameter."""
61 return socket.inet_pton(socket.AF_INET, self._local_ip4)
65 """IPv4 address of remote peer "connected" to this interface."""
66 return self._remote_hosts[0].ip4
69 def remote_ip4n(self):
70 """IPv4 address of remote peer - raw, suitable as API parameter."""
71 return socket.inet_pton(socket.AF_INET, self.remote_ip4)
75 """Local IPv6 address on VPP interface (string)."""
76 return self._local_ip6
80 """Local IPv6 address - raw, suitable as API parameter."""
81 return socket.inet_pton(socket.AF_INET6, self.local_ip6)
85 """IPv6 address of remote peer "connected" to this interface."""
86 return self._remote_hosts[0].ip6
89 def remote_ip6n(self):
90 """IPv6 address of remote peer - raw, suitable as API parameter"""
91 return socket.inet_pton(socket.AF_INET6, self.remote_ip6)
94 def local_ip6_ll(self):
95 """Local IPv6 link-local address on VPP interface (string)."""
96 return self._local_ip6_ll
99 def local_ip6n_ll(self):
100 """Local IPv6 link-local address - raw, suitable as API parameter."""
101 return self._local_ip6n_ll
104 def remote_ip6_ll(self):
105 """Link-local IPv6 address of remote peer
106 "connected" to this interface."""
107 return self._remote_ip6_ll
110 def remote_ip6n_ll(self):
111 """Link-local IPv6 address of remote peer
112 - raw, suitable as API parameter"""
113 return self._remote_ip6n_ll
117 """Name of the interface."""
122 """RAW result of sw_interface_dump for this interface."""
127 """Test case creating this interface."""
131 def remote_hosts(self):
132 """Remote hosts list"""
133 return self._remote_hosts
136 def remote_hosts(self, value):
138 :param list value: List of remote hosts.
140 self._remote_hosts = value
141 self._hosts_by_mac = {}
142 self._hosts_by_ip4 = {}
143 self._hosts_by_ip6 = {}
144 for host in self._remote_hosts:
145 self._hosts_by_mac[host.mac] = host
146 self._hosts_by_ip4[host.ip4] = host
147 self._hosts_by_ip6[host.ip6] = host
149 def host_by_mac(self, mac):
151 :param mac: MAC address to find host by.
152 :return: Host object assigned to interface.
154 return self._hosts_by_mac[mac]
156 def host_by_ip4(self, ip):
158 :param ip: IPv4 address to find host by.
159 :return: Host object assigned to interface.
161 return self._hosts_by_ip4[ip]
163 def host_by_ip6(self, ip):
165 :param ip: IPv6 address to find host by.
166 :return: Host object assigned to interface.
168 return self._hosts_by_ip6[ip]
170 def generate_remote_hosts(self, count=1):
171 """Generate and add remote hosts for the interface.
173 :param int count: Number of generated remote hosts.
175 self._remote_hosts = []
176 self._hosts_by_mac = {}
177 self._hosts_by_ip4 = {}
178 self._hosts_by_ip6 = {}
180 2, count + 2): # 0: network address, 1: local vpp address
181 mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i)
182 ip4 = "172.16.%u.%u" % (self.sw_if_index, i)
183 ip6 = "fd01:%x::%x" % (self.sw_if_index, i)
184 ip6_ll = mk_ll_addr(mac)
185 host = Host(mac, ip4, ip6, ip6_ll)
186 self._remote_hosts.append(host)
187 self._hosts_by_mac[mac] = host
188 self._hosts_by_ip4[ip4] = host
189 self._hosts_by_ip6[ip6] = host
192 def __init__(self, test):
195 self._remote_hosts = []
196 self._hosts_by_mac = {}
197 self._hosts_by_ip4 = {}
198 self._hosts_by_ip6 = {}
200 def set_mac(self, mac):
201 self._local_mac = str(mac)
202 self._local_ip6_ll = mk_ll_addr(self._local_mac)
203 self.test.vapi.sw_interface_set_mac_address(
204 self.sw_if_index, mac.packed)
206 def set_sw_if_index(self, sw_if_index):
207 self._sw_if_index = sw_if_index
209 self.generate_remote_hosts()
211 self._local_ip4 = "172.16.%u.1" % self.sw_if_index
212 self._local_ip4n = socket.inet_pton(socket.AF_INET, self.local_ip4)
213 self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index
214 self._local_ip4n_subnet = socket.inet_pton(socket.AF_INET,
215 self._local_ip4_subnet)
216 self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index
217 self._local_ip4n_bcast = socket.inet_pton(socket.AF_INET,
218 self._local_ip4_bcast)
219 self.local_ip4_prefix_len = 24
220 self.has_ip4_config = False
221 self.ip4_table_id = 0
223 self._local_ip6 = "fd01:%x::1" % self.sw_if_index
224 self._local_ip6n = socket.inet_pton(socket.AF_INET6, self.local_ip6)
225 self.local_ip6_prefix_len = 64
226 self.has_ip6_config = False
227 self.ip6_table_id = 0
229 self._local_addr = {socket.AF_INET: self.local_ip4,
230 socket.AF_INET6: self.local_ip6}
231 self._local_addr_n = {socket.AF_INET: self.local_ip4n,
232 socket.AF_INET6: self.local_ip6n}
233 self._remote_addr = {socket.AF_INET: self.remote_ip4,
234 socket.AF_INET6: self.remote_ip6}
235 self._remote_addr_n = {socket.AF_INET: self.remote_ip4n,
236 socket.AF_INET6: self.remote_ip6n}
238 r = self.test.vapi.sw_interface_dump(sw_if_index=self.sw_if_index)
240 if intf.sw_if_index == self.sw_if_index:
241 self._name = intf.interface_name.split(b'\0',
243 self._local_mac = mac_ntop(intf.l2_address)
248 "Could not find interface with sw_if_index %d "
249 "in interface dump %s" %
250 (self.sw_if_index, moves.reprlib.repr(r)))
251 self._local_ip6_ll = mk_ll_addr(self.local_mac)
252 self._local_ip6n_ll = socket.inet_pton(socket.AF_INET6,
254 self._remote_ip6_ll = mk_ll_addr(self.remote_mac)
255 self._remote_ip6n_ll = socket.inet_pton(socket.AF_INET6,
258 def config_ip4(self):
259 """Configure IPv4 address on the VPP interface."""
260 self.test.vapi.sw_interface_add_del_address(
261 sw_if_index=self.sw_if_index, address=self.local_ip4n,
262 address_length=self.local_ip4_prefix_len)
263 self.has_ip4_config = True
265 def unconfig_ip4(self):
266 """Remove IPv4 address on the VPP interface."""
268 if self.has_ip4_config:
269 self.test.vapi.sw_interface_add_del_address(
270 sw_if_index=self.sw_if_index, address=self.local_ip4n,
271 address_length=self.local_ip4_prefix_len, is_add=0)
272 except AttributeError:
273 self.has_ip4_config = False
274 self.has_ip4_config = False
276 def configure_ipv4_neighbors(self):
277 """For every remote host assign neighbor's MAC to IPv4 addresses.
279 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
281 for host in self._remote_hosts:
282 self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
286 def config_ip6(self):
287 """Configure IPv6 address on the VPP interface."""
288 self.test.vapi.sw_interface_add_del_address(
289 sw_if_index=self.sw_if_index, address=self._local_ip6n,
290 address_length=self.local_ip6_prefix_len, is_ipv6=1)
291 self.has_ip6_config = True
293 def unconfig_ip6(self):
294 """Remove IPv6 address on the VPP interface."""
296 if self.has_ip6_config:
297 self.test.vapi.sw_interface_add_del_address(
298 sw_if_index=self.sw_if_index, address=self.local_ip6n,
299 address_length=self.local_ip6_prefix_len, is_ipv6=1,
301 except AttributeError:
302 self.has_ip6_config = False
303 self.has_ip6_config = False
305 def configure_ipv6_neighbors(self):
306 """For every remote host assign neighbor's MAC to IPv6 addresses.
308 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
310 for host in self._remote_hosts:
311 self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
316 """Unconfigure IPv6 and IPv4 address on the VPP interface."""
320 def set_table_ip4(self, table_id):
321 """Set the interface in a IPv4 Table.
323 .. note:: Must be called before configuring IP4 addresses.
325 self.ip4_table_id = table_id
326 self.test.vapi.sw_interface_set_table(
327 self.sw_if_index, 0, self.ip4_table_id)
329 def set_table_ip6(self, table_id):
330 """Set the interface in a IPv6 Table.
332 .. note:: Must be called before configuring IP6 addresses.
334 self.ip6_table_id = table_id
335 self.test.vapi.sw_interface_set_table(
336 self.sw_if_index, 1, self.ip6_table_id)
338 def disable_ipv6_ra(self):
339 """Configure IPv6 RA suppress on the VPP interface."""
340 self.test.vapi.sw_interface_ip6nd_ra_config(
341 sw_if_index=self.sw_if_index,
344 def ip6_ra_config(self, no=0, suppress=0, send_unicast=0):
345 """Configure IPv6 RA suppress on the VPP interface."""
346 self.test.vapi.sw_interface_ip6nd_ra_config(
347 sw_if_index=self.sw_if_index,
350 send_unicast=send_unicast)
352 def ip6_ra_prefix(self, prefix, is_no=0,
353 off_link=0, no_autoconfig=0, use_default=0):
354 """Configure IPv6 RA suppress on the VPP interface.
356 prefix can be a string in the format of '<address>/<length_in_bits>'
357 or ipaddress.ipnetwork object (if strict.)"""
359 self.test.vapi.sw_interface_ip6nd_ra_prefix(
360 sw_if_index=self.sw_if_index,
362 use_default=use_default,
363 off_link=off_link, no_autoconfig=no_autoconfig,
367 """Put interface ADMIN-UP."""
368 self.test.vapi.sw_interface_set_flags(self.sw_if_index,
371 def admin_down(self):
372 """Put interface ADMIN-down."""
373 self.test.vapi.sw_interface_set_flags(self.sw_if_index,
377 """Put interface link-state-UP."""
378 self.test.vapi.cli("test interface link-state %s up" % self.name)
381 """Put interface link-state-down."""
382 self.test.vapi.cli("test interface link-state %s down" % self.name)
384 def ip6_enable(self):
385 """IPv6 Enable interface"""
386 self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index,
389 def ip6_disable(self):
390 """Put interface ADMIN-DOWN."""
391 self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index,
394 def add_sub_if(self, sub_if):
395 """Register a sub-interface with this interface.
397 :param sub_if: sub-interface
399 if not hasattr(self, 'sub_if'):
402 if isinstance(self.sub_if, list):
403 self.sub_if.append(sub_if)
407 def enable_mpls(self):
408 """Enable MPLS on the VPP interface."""
409 self.test.vapi.sw_interface_set_mpls_enable(self.sw_if_index)
411 def disable_mpls(self):
412 """Enable MPLS on the VPP interface."""
413 self.test.vapi.sw_interface_set_mpls_enable(self.sw_if_index, 0)
415 def is_ip4_entry_in_fib_dump(self, dump):
417 n = IPv4Network(text_type("%s/%d" % (self.local_ip4,
418 self.local_ip4_prefix_len)))
419 if i.route.prefix == n and \
420 i.route.table_id == self.ip4_table_id:
424 def set_unnumbered(self, ip_sw_if_index):
425 """ Set the interface to unnumbered via ip_sw_if_index """
426 self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
429 def unset_unnumbered(self, ip_sw_if_index):
430 """ Unset the interface to unnumbered via ip_sw_if_index """
431 self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
432 self.sw_if_index, is_add=0)
434 def set_proxy_arp(self, enable=1):
435 """ Set the interface to enable/disable Proxy ARP """
436 self.test.vapi.proxy_arp_intfc_enable_disable(
440 def query_vpp_config(self):
441 dump = self.test.vapi.sw_interface_dump(sw_if_index=self.sw_if_index)
442 return self.is_interface_config_in_dump(dump)
444 def get_interface_config_from_dump(self, dump):
446 if i.interface_name.rstrip(' \t\r\n\0') == self.name and \
447 i.sw_if_index == self.sw_if_index:
452 def is_interface_config_in_dump(self, dump):
453 return self.get_interface_config_from_dump(dump) is not None
455 def assert_interface_state(self, admin_up_down, link_up_down,
458 event = self.test.vapi.wait_for_event(timeout=1,
459 name='sw_interface_event')
460 self.test.assert_equal(event.sw_if_index, self.sw_if_index,
462 self.test.assert_equal(event.admin_up_down, admin_up_down,
464 self.test.assert_equal(event.link_up_down, link_up_down,
466 dump = self.test.vapi.sw_interface_dump()
467 if_state = self.get_interface_config_from_dump(dump)
468 self.test.assert_equal(if_state.admin_up_down, admin_up_down,
470 self.test.assert_equal(if_state.link_up_down, link_up_down,
476 def get_rx_stats(self):
477 c = self.test.statistics.get_counter("^/if/rx$")
478 return c[0][self.sw_if_index]
480 def get_tx_stats(self):
481 c = self.test.statistics.get_counter("^/if/tx$")
482 return c[0][self.sw_if_index]