3 from abc import abstractmethod, ABCMeta
7 from util import Host, mk_ll_addr
8 from vpp_papi import mac_pton, mac_ntop
11 class VppInterface(object):
12 """Generic VPP interface."""
13 __metaclass__ = ABCMeta
16 def sw_if_index(self):
17 """Interface index assigned by VPP."""
18 return self._sw_if_index
22 """MAC-address of the remote interface "connected" to this interface"""
23 return self._remote_hosts[0].mac
27 """MAC-address of the VPP interface."""
28 return self._local_mac
32 return self._local_addr
35 def remote_addr(self):
36 return self._remote_addr
39 def local_addr_n(self):
40 return self._local_addr_n
43 def remote_addr_n(self):
44 return self._remote_addr_n
48 """Local IPv4 address on VPP interface (string)."""
49 return self._local_ip4
53 """Local IPv4 address - raw, suitable as API parameter."""
54 return socket.inet_pton(socket.AF_INET, self._local_ip4)
58 """IPv4 address of remote peer "connected" to this interface."""
59 return self._remote_hosts[0].ip4
62 def remote_ip4n(self):
63 """IPv4 address of remote peer - raw, suitable as API parameter."""
64 return socket.inet_pton(socket.AF_INET, self.remote_ip4)
68 """Local IPv6 address on VPP interface (string)."""
69 return self._local_ip6
73 """Local IPv6 address - raw, suitable as API parameter."""
74 return socket.inet_pton(socket.AF_INET6, self.local_ip6)
78 """IPv6 address of remote peer "connected" to this interface."""
79 return self._remote_hosts[0].ip6
82 def remote_ip6n(self):
83 """IPv6 address of remote peer - raw, suitable as API parameter"""
84 return socket.inet_pton(socket.AF_INET6, self.remote_ip6)
87 def local_ip6_ll(self):
88 """Local IPv6 link-local address on VPP interface (string)."""
89 return self._local_ip6_ll
92 def local_ip6n_ll(self):
93 """Local IPv6 link-local address - raw, suitable as API parameter."""
94 return self._local_ip6n_ll
97 def remote_ip6_ll(self):
98 """Link-local IPv6 address of remote peer
99 "connected" to this interface."""
100 return self._remote_ip6_ll
103 def remote_ip6n_ll(self):
104 """Link-local IPv6 address of remote peer
105 - raw, suitable as API parameter"""
106 return self._remote_ip6n_ll
110 """Name of the interface."""
115 """RAW result of sw_interface_dump for this interface."""
120 """Test case creating this interface."""
124 def remote_hosts(self):
125 """Remote hosts list"""
126 return self._remote_hosts
129 def remote_hosts(self, value):
131 :param list value: List of remote hosts.
133 self._remote_hosts = value
134 self._hosts_by_mac = {}
135 self._hosts_by_ip4 = {}
136 self._hosts_by_ip6 = {}
137 for host in self._remote_hosts:
138 self._hosts_by_mac[host.mac] = host
139 self._hosts_by_ip4[host.ip4] = host
140 self._hosts_by_ip6[host.ip6] = host
142 def host_by_mac(self, mac):
144 :param mac: MAC address to find host by.
145 :return: Host object assigned to interface.
147 return self._hosts_by_mac[mac]
149 def host_by_ip4(self, ip):
151 :param ip: IPv4 address to find host by.
152 :return: Host object assigned to interface.
154 return self._hosts_by_ip4[ip]
156 def host_by_ip6(self, ip):
158 :param ip: IPv6 address to find host by.
159 :return: Host object assigned to interface.
161 return self._hosts_by_ip6[ip]
163 def generate_remote_hosts(self, count=1):
164 """Generate and add remote hosts for the interface.
166 :param int count: Number of generated remote hosts.
168 self._remote_hosts = []
169 self._hosts_by_mac = {}
170 self._hosts_by_ip4 = {}
171 self._hosts_by_ip6 = {}
173 2, count + 2): # 0: network address, 1: local vpp address
174 mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i)
175 ip4 = "172.16.%u.%u" % (self.sw_if_index, i)
176 ip6 = "fd01:%x::%x" % (self.sw_if_index, i)
177 ip6_ll = mk_ll_addr(mac)
178 host = Host(mac, ip4, ip6, ip6_ll)
179 self._remote_hosts.append(host)
180 self._hosts_by_mac[mac] = host
181 self._hosts_by_ip4[ip4] = host
182 self._hosts_by_ip6[ip6] = host
185 def __init__(self, test):
188 self._remote_hosts = []
189 self._hosts_by_mac = {}
190 self._hosts_by_ip4 = {}
191 self._hosts_by_ip6 = {}
193 def set_mac(self, mac):
194 self._local_mac = str(mac)
195 self._local_ip6_ll = mk_ll_addr(self._local_mac)
196 self.test.vapi.sw_interface_set_mac_address(
197 self.sw_if_index, mac.packed)
199 def set_sw_if_index(self, sw_if_index):
200 self._sw_if_index = sw_if_index
202 self.generate_remote_hosts()
204 self._local_ip4 = "172.16.%u.1" % self.sw_if_index
205 self._local_ip4n = socket.inet_pton(socket.AF_INET, self.local_ip4)
206 self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index
207 self._local_ip4n_subnet = socket.inet_pton(socket.AF_INET,
208 self._local_ip4_subnet)
209 self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index
210 self._local_ip4n_bcast = socket.inet_pton(socket.AF_INET,
211 self._local_ip4_bcast)
212 self.local_ip4_prefix_len = 24
213 self.has_ip4_config = False
214 self.ip4_table_id = 0
216 self._local_ip6 = "fd01:%x::1" % self.sw_if_index
217 self._local_ip6n = socket.inet_pton(socket.AF_INET6, self.local_ip6)
218 self.local_ip6_prefix_len = 64
219 self.has_ip6_config = False
220 self.ip6_table_id = 0
222 self._local_addr = {socket.AF_INET: self.local_ip4,
223 socket.AF_INET6: self.local_ip6}
224 self._local_addr_n = {socket.AF_INET: self.local_ip4n,
225 socket.AF_INET6: self.local_ip6n}
226 self._remote_addr = {socket.AF_INET: self.remote_ip4,
227 socket.AF_INET6: self.remote_ip6}
228 self._remote_addr_n = {socket.AF_INET: self.remote_ip4n,
229 socket.AF_INET6: self.remote_ip6n}
231 r = self.test.vapi.sw_interface_dump()
233 if intf.sw_if_index == self.sw_if_index:
234 self._name = intf.interface_name.split(b'\0',
236 self._local_mac = mac_ntop(intf.l2_address)
241 "Could not find interface with sw_if_index %d "
242 "in interface dump %s" %
243 (self.sw_if_index, moves.reprlib.repr(r)))
244 self._local_ip6_ll = mk_ll_addr(self.local_mac)
245 self._local_ip6n_ll = socket.inet_pton(socket.AF_INET6,
247 self._remote_ip6_ll = mk_ll_addr(self.remote_mac)
248 self._remote_ip6n_ll = socket.inet_pton(socket.AF_INET6,
251 def config_ip4(self):
252 """Configure IPv4 address on the VPP interface."""
253 self.test.vapi.sw_interface_add_del_address(
254 self.sw_if_index, self.local_ip4n, self.local_ip4_prefix_len)
255 self.has_ip4_config = True
257 def unconfig_ip4(self):
258 """Remove IPv4 address on the VPP interface."""
260 if self.has_ip4_config:
261 self.test.vapi.sw_interface_add_del_address(
264 self.local_ip4_prefix_len,
266 except AttributeError:
267 self.has_ip4_config = False
268 self.has_ip4_config = False
270 def configure_ipv4_neighbors(self):
271 """For every remote host assign neighbor's MAC to IPv4 addresses.
273 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
275 for host in self._remote_hosts:
276 macn = mac_pton(host.mac)
278 self.test.vapi.ip_neighbor_add_del(
279 self.sw_if_index, macn, ipn)
281 def config_ip6(self):
282 """Configure IPv6 address on the VPP interface."""
283 self.test.vapi.sw_interface_add_del_address(
284 self.sw_if_index, self._local_ip6n, self.local_ip6_prefix_len,
286 self.has_ip6_config = True
288 def unconfig_ip6(self):
289 """Remove IPv6 address on the VPP interface."""
291 if self.has_ip6_config:
292 self.test.vapi.sw_interface_add_del_address(
295 self.local_ip6_prefix_len,
297 except AttributeError:
298 self.has_ip6_config = False
299 self.has_ip6_config = False
301 def configure_ipv6_neighbors(self):
302 """For every remote host assign neighbor's MAC to IPv6 addresses.
304 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
306 for host in self._remote_hosts:
307 macn = mac_pton(host.mac)
309 self.test.vapi.ip_neighbor_add_del(
310 self.sw_if_index, macn, ipn, is_ipv6=1)
313 """Unconfigure IPv6 and IPv4 address on the VPP interface."""
317 def set_table_ip4(self, table_id):
318 """Set the interface in a IPv4 Table.
320 .. note:: Must be called before configuring IP4 addresses.
322 self.ip4_table_id = table_id
323 self.test.vapi.sw_interface_set_table(
324 self.sw_if_index, 0, self.ip4_table_id)
326 def set_table_ip6(self, table_id):
327 """Set the interface in a IPv6 Table.
329 .. note:: Must be called before configuring IP6 addresses.
331 self.ip6_table_id = table_id
332 self.test.vapi.sw_interface_set_table(
333 self.sw_if_index, 1, self.ip6_table_id)
335 def disable_ipv6_ra(self):
336 """Configure IPv6 RA suppress on the VPP interface."""
337 self.test.vapi.sw_interface_ra_suppress(self.sw_if_index)
339 def ip6_ra_config(self, no=0, suppress=0, send_unicast=0):
340 """Configure IPv6 RA suppress on the VPP interface."""
341 self.test.vapi.ip6_sw_interface_ra_config(self.sw_if_index,
346 def ip6_ra_prefix(self, address, address_length, is_no=0,
347 off_link=0, no_autoconfig=0, use_default=0):
348 """Configure IPv6 RA suppress on the VPP interface."""
349 self.test.vapi.ip6_sw_interface_ra_prefix(self.sw_if_index,
354 no_autoconfig=no_autoconfig,
355 use_default=use_default)
358 """Put interface ADMIN-UP."""
359 self.test.vapi.sw_interface_set_flags(self.sw_if_index,
362 def admin_down(self):
363 """Put interface ADMIN-down."""
364 self.test.vapi.sw_interface_set_flags(self.sw_if_index,
367 def ip6_enable(self):
368 """IPv6 Enable interface"""
369 self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
372 def ip6_disable(self):
373 """Put interface ADMIN-DOWN."""
374 self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
377 def add_sub_if(self, sub_if):
378 """Register a sub-interface with this interface.
380 :param sub_if: sub-interface
382 if not hasattr(self, 'sub_if'):
385 if isinstance(self.sub_if, list):
386 self.sub_if.append(sub_if)
390 def enable_mpls(self):
391 """Enable MPLS on the VPP interface."""
392 self.test.vapi.sw_interface_enable_disable_mpls(
395 def disable_mpls(self):
396 """Enable MPLS on the VPP interface."""
397 self.test.vapi.sw_interface_enable_disable_mpls(
400 def is_ip4_entry_in_fib_dump(self, dump):
402 if i.address == self.local_ip4n and \
403 i.address_length == self.local_ip4_prefix_len and \
404 i.table_id == self.ip4_table_id:
408 def set_unnumbered(self, ip_sw_if_index):
409 """ Set the interface to unnumbered via ip_sw_if_index """
410 self.test.vapi.sw_interface_set_unnumbered(
414 def unset_unnumbered(self, ip_sw_if_index):
415 """ Unset the interface to unnumbered via ip_sw_if_index """
416 self.test.vapi.sw_interface_set_unnumbered(
421 def set_proxy_arp(self, enable=1):
422 """ Set the interface to enable/disable Proxy ARP """
423 self.test.vapi.proxy_arp_intfc_enable_disable(
427 def query_vpp_config(self):
428 dump = self.test.vapi.sw_interface_dump()
429 return self.is_interface_config_in_dump(dump)
431 def get_interface_config_from_dump(self, dump):
433 if i.interface_name.rstrip(' \t\r\n\0') == self.name and \
434 i.sw_if_index == self.sw_if_index:
439 def is_interface_config_in_dump(self, dump):
440 return self.get_interface_config_from_dump(dump) is not None
442 def assert_interface_state(self, admin_up_down, link_up_down,
445 event = self.test.vapi.wait_for_event(timeout=1,
446 name='sw_interface_event')
447 self.test.assert_equal(event.sw_if_index, self.sw_if_index,
449 self.test.assert_equal(event.admin_up_down, admin_up_down,
451 self.test.assert_equal(event.link_up_down, link_up_down,
453 dump = self.test.vapi.sw_interface_dump()
454 if_state = self.get_interface_config_from_dump(dump)
455 self.test.assert_equal(if_state.admin_up_down, admin_up_down,
457 self.test.assert_equal(if_state.link_up_down, link_up_down,