1 from abc import abstractmethod, ABCMeta
4 from util import Host, mk_ll_addr, mactobinary
7 class VppInterface(object):
8 """Generic VPP interface."""
9 __metaclass__ = ABCMeta
12 def sw_if_index(self):
13 """Interface index assigned by VPP."""
14 return self._sw_if_index
18 """MAC-address of the remote interface "connected" to this interface"""
19 return self._remote_hosts[0].mac
23 """MAC-address of the VPP interface."""
24 return self._local_mac
28 return self._local_addr
31 def remote_addr(self):
32 return self._remote_addr
35 def local_addr_n(self):
36 return self._local_addr_n
39 def remote_addr_n(self):
40 return self._remote_addr_n
44 """Local IPv4 address on VPP interface (string)."""
45 return self._local_ip4
49 """Local IPv4 address - raw, suitable as API parameter."""
50 return socket.inet_pton(socket.AF_INET, self._local_ip4)
54 """IPv4 address of remote peer "connected" to this interface."""
55 return self._remote_hosts[0].ip4
58 def remote_ip4n(self):
59 """IPv4 address of remote peer - raw, suitable as API parameter."""
60 return socket.inet_pton(socket.AF_INET, self.remote_ip4)
64 """Local IPv6 address on VPP interface (string)."""
65 return self._local_ip6
69 """Local IPv6 address - raw, suitable as API parameter."""
70 return socket.inet_pton(socket.AF_INET6, self.local_ip6)
74 """IPv6 address of remote peer "connected" to this interface."""
75 return self._remote_hosts[0].ip6
78 def remote_ip6n(self):
79 """IPv6 address of remote peer - raw, suitable as API parameter"""
80 return socket.inet_pton(socket.AF_INET6, self.remote_ip6)
83 def local_ip6_ll(self):
84 """Local IPv6 link-local address on VPP interface (string)."""
85 return self._local_ip6_ll
88 def local_ip6n_ll(self):
89 """Local IPv6 link-local address - raw, suitable as API parameter."""
90 return self._local_ip6n_ll
93 def remote_ip6_ll(self):
94 """Link-local IPv6 address of remote peer
95 "connected" to this interface."""
96 return self._remote_ip6_ll
99 def remote_ip6n_ll(self):
100 """Link-local IPv6 address of remote peer
101 - raw, suitable as API parameter"""
102 return self._remote_ip6n_ll
106 """Name of the interface."""
111 """RAW result of sw_interface_dump for this interface."""
116 """Test case creating this interface."""
120 def remote_hosts(self):
121 """Remote hosts list"""
122 return self._remote_hosts
125 def remote_hosts(self, value):
127 :param list value: List of remote hosts.
129 self._remote_hosts = value
130 self._hosts_by_mac = {}
131 self._hosts_by_ip4 = {}
132 self._hosts_by_ip6 = {}
133 for host in self._remote_hosts:
134 self._hosts_by_mac[host.mac] = host
135 self._hosts_by_ip4[host.ip4] = host
136 self._hosts_by_ip6[host.ip6] = host
138 def host_by_mac(self, mac):
140 :param mac: MAC address to find host by.
141 :return: Host object assigned to interface.
143 return self._hosts_by_mac[mac]
145 def host_by_ip4(self, ip):
147 :param ip: IPv4 address to find host by.
148 :return: Host object assigned to interface.
150 return self._hosts_by_ip4[ip]
152 def host_by_ip6(self, ip):
154 :param ip: IPv6 address to find host by.
155 :return: Host object assigned to interface.
157 return self._hosts_by_ip6[ip]
159 def generate_remote_hosts(self, count=1):
160 """Generate and add remote hosts for the interface.
162 :param int count: Number of generated remote hosts.
164 self._remote_hosts = []
165 self._hosts_by_mac = {}
166 self._hosts_by_ip4 = {}
167 self._hosts_by_ip6 = {}
169 2, count + 2): # 0: network address, 1: local vpp address
170 mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i)
171 ip4 = "172.16.%u.%u" % (self.sw_if_index, i)
172 ip6 = "fd01:%x::%x" % (self.sw_if_index, i)
173 ip6_ll = mk_ll_addr(mac)
174 host = Host(mac, ip4, ip6, ip6_ll)
175 self._remote_hosts.append(host)
176 self._hosts_by_mac[mac] = host
177 self._hosts_by_ip4[ip4] = host
178 self._hosts_by_ip6[ip6] = host
181 def __init__(self, test):
184 self._remote_hosts = []
185 self._hosts_by_mac = {}
186 self._hosts_by_ip4 = {}
187 self._hosts_by_ip6 = {}
189 def set_mac(self, mac):
190 self._local_mac = mac
191 self._local_ip6_ll = mk_ll_addr(mac)
192 self.test.vapi.sw_interface_set_mac_address(
194 mactobinary(self._local_mac))
196 def set_sw_if_index(self, sw_if_index):
197 self._sw_if_index = sw_if_index
199 self.generate_remote_hosts()
201 self._local_ip4 = "172.16.%u.1" % self.sw_if_index
202 self._local_ip4n = socket.inet_pton(socket.AF_INET, self.local_ip4)
203 self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index
204 self._local_ip4n_subnet = socket.inet_pton(socket.AF_INET,
205 self._local_ip4_subnet)
206 self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index
207 self._local_ip4n_bcast = socket.inet_pton(socket.AF_INET,
208 self._local_ip4_bcast)
209 self.local_ip4_prefix_len = 24
210 self.has_ip4_config = False
211 self.ip4_table_id = 0
213 self._local_ip6 = "fd01:%x::1" % self.sw_if_index
214 self._local_ip6n = socket.inet_pton(socket.AF_INET6, self.local_ip6)
215 self.local_ip6_prefix_len = 64
216 self.has_ip6_config = False
217 self.ip6_table_id = 0
219 self._local_addr = {socket.AF_INET: self.local_ip4,
220 socket.AF_INET6: self.local_ip6}
221 self._local_addr_n = {socket.AF_INET: self.local_ip4n,
222 socket.AF_INET6: self.local_ip6n}
223 self._remote_addr = {socket.AF_INET: self.remote_ip4,
224 socket.AF_INET6: self.remote_ip6}
225 self._remote_addr_n = {socket.AF_INET: self.remote_ip4n,
226 socket.AF_INET6: self.remote_ip6n}
228 r = self.test.vapi.sw_interface_dump()
230 if intf.sw_if_index == self.sw_if_index:
231 self._name = intf.interface_name.split(b'\0', 1)[0]
233 ':'.join(intf.l2_address.encode('hex')[i:i + 2]
234 for i in range(0, 12, 2))
239 "Could not find interface with sw_if_index %d "
240 "in interface dump %s" %
241 (self.sw_if_index, repr(r)))
242 self._local_ip6_ll = mk_ll_addr(self.local_mac)
243 self._local_ip6n_ll = socket.inet_pton(socket.AF_INET6,
245 self._remote_ip6_ll = mk_ll_addr(self.remote_mac)
246 self._remote_ip6n_ll = socket.inet_pton(socket.AF_INET6,
249 def config_ip4(self):
250 """Configure IPv4 address on the VPP interface."""
251 self.test.vapi.sw_interface_add_del_address(
252 self.sw_if_index, self.local_ip4n, self.local_ip4_prefix_len)
253 self.has_ip4_config = True
255 def unconfig_ip4(self):
256 """Remove IPv4 address on the VPP interface."""
258 if self.has_ip4_config:
259 self.test.vapi.sw_interface_add_del_address(
262 self.local_ip4_prefix_len,
264 except AttributeError:
265 self.has_ip4_config = False
266 self.has_ip4_config = False
268 def configure_ipv4_neighbors(self):
269 """For every remote host assign neighbor's MAC to IPv4 addresses.
271 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
273 for host in self._remote_hosts:
274 macn = host.mac.replace(":", "").decode('hex')
276 self.test.vapi.ip_neighbor_add_del(
277 self.sw_if_index, macn, ipn)
279 def config_ip6(self):
280 """Configure IPv6 address on the VPP interface."""
281 self.test.vapi.sw_interface_add_del_address(
282 self.sw_if_index, self._local_ip6n, self.local_ip6_prefix_len,
284 self.has_ip6_config = True
286 def unconfig_ip6(self):
287 """Remove IPv6 address on the VPP interface."""
289 if self.has_ip6_config:
290 self.test.vapi.sw_interface_add_del_address(
293 self.local_ip6_prefix_len,
295 except AttributeError:
296 self.has_ip6_config = False
297 self.has_ip6_config = False
299 def configure_ipv6_neighbors(self):
300 """For every remote host assign neighbor's MAC to IPv6 addresses.
302 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
304 for host in self._remote_hosts:
305 macn = host.mac.replace(":", "").decode('hex')
307 self.test.vapi.ip_neighbor_add_del(
308 self.sw_if_index, macn, ipn, is_ipv6=1)
311 """Unconfigure IPv6 and IPv4 address on the VPP interface."""
315 def set_table_ip4(self, table_id):
316 """Set the interface in a IPv4 Table.
318 .. note:: Must be called before configuring IP4 addresses.
320 self.ip4_table_id = table_id
321 self.test.vapi.sw_interface_set_table(
322 self.sw_if_index, 0, self.ip4_table_id)
324 def set_table_ip6(self, table_id):
325 """Set the interface in a IPv6 Table.
327 .. note:: Must be called before configuring IP6 addresses.
329 self.ip6_table_id = table_id
330 self.test.vapi.sw_interface_set_table(
331 self.sw_if_index, 1, self.ip6_table_id)
333 def disable_ipv6_ra(self):
334 """Configure IPv6 RA suppress on the VPP interface."""
335 self.test.vapi.sw_interface_ra_suppress(self.sw_if_index)
337 def ip6_ra_config(self, no=0, suppress=0, send_unicast=0):
338 """Configure IPv6 RA suppress on the VPP interface."""
339 self.test.vapi.ip6_sw_interface_ra_config(self.sw_if_index,
344 def ip6_ra_prefix(self, address, address_length, is_no=0,
345 off_link=0, no_autoconfig=0, use_default=0):
346 """Configure IPv6 RA suppress on the VPP interface."""
347 self.test.vapi.ip6_sw_interface_ra_prefix(self.sw_if_index,
352 no_autoconfig=no_autoconfig,
353 use_default=use_default)
356 """Put interface ADMIN-UP."""
357 self.test.vapi.sw_interface_set_flags(self.sw_if_index,
360 def admin_down(self):
361 """Put interface ADMIN-down."""
362 self.test.vapi.sw_interface_set_flags(self.sw_if_index,
365 def ip6_enable(self):
366 """IPv6 Enable interface"""
367 self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
370 def ip6_disable(self):
371 """Put interface ADMIN-DOWN."""
372 self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
375 def add_sub_if(self, sub_if):
376 """Register a sub-interface with this interface.
378 :param sub_if: sub-interface
380 if not hasattr(self, 'sub_if'):
383 if isinstance(self.sub_if, list):
384 self.sub_if.append(sub_if)
388 def enable_mpls(self):
389 """Enable MPLS on the VPP interface."""
390 self.test.vapi.sw_interface_enable_disable_mpls(
393 def disable_mpls(self):
394 """Enable MPLS on the VPP interface."""
395 self.test.vapi.sw_interface_enable_disable_mpls(
398 def is_ip4_entry_in_fib_dump(self, dump):
400 if i.address == self.local_ip4n and \
401 i.address_length == self.local_ip4_prefix_len and \
402 i.table_id == self.ip4_table_id:
406 def set_unnumbered(self, ip_sw_if_index):
407 """ Set the interface to unnumbered via ip_sw_if_index """
408 self.test.vapi.sw_interface_set_unnumbered(
412 def unset_unnumbered(self, ip_sw_if_index):
413 """ Unset the interface to unnumbered via ip_sw_if_index """
414 self.test.vapi.sw_interface_set_unnumbered(
419 def set_proxy_arp(self, enable=1):
420 """ Set the interface to enable/disable Proxy ARP """
421 self.test.vapi.proxy_arp_intfc_enable_disable(
425 def query_vpp_config(self):
426 dump = self.test.vapi.sw_interface_dump()
427 return self.is_interface_config_in_dump(dump)
429 def get_interface_config_from_dump(self, dump):
431 if i.interface_name.rstrip(' \t\r\n\0') == self.name and \
432 i.sw_if_index == self.sw_if_index:
437 def is_interface_config_in_dump(self, dump):
438 return self.get_interface_config_from_dump(dump) is not None
440 def assert_interface_state(self, admin_up_down, link_up_down,
443 event = self.test.vapi.wait_for_event(timeout=1,
444 name='sw_interface_event')
445 self.test.assert_equal(event.sw_if_index, self.sw_if_index,
447 self.test.assert_equal(event.admin_up_down, admin_up_down,
449 self.test.assert_equal(event.link_up_down, link_up_down,
451 dump = self.test.vapi.sw_interface_dump()
452 if_state = self.get_interface_config_from_dump(dump)
453 self.test.assert_equal(if_state.admin_up_down, admin_up_down,
455 self.test.assert_equal(if_state.link_up_down, link_up_down,