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 """Local IPv4 address on VPP interface (string)."""
29 return self._local_ip4
33 """Local IPv4 address - raw, suitable as API parameter."""
34 return socket.inet_pton(socket.AF_INET, self._local_ip4)
38 """IPv4 address of remote peer "connected" to this interface."""
39 return self._remote_hosts[0].ip4
42 def remote_ip4n(self):
43 """IPv4 address of remote peer - raw, suitable as API parameter."""
44 return socket.inet_pton(socket.AF_INET, self.remote_ip4)
48 """Local IPv6 address on VPP interface (string)."""
49 return self._local_ip6
53 """Local IPv6 address - raw, suitable as API parameter."""
54 return socket.inet_pton(socket.AF_INET6, self.local_ip6)
58 """IPv6 address of remote peer "connected" to this interface."""
59 return self._remote_hosts[0].ip6
62 def remote_ip6n(self):
63 """IPv6 address of remote peer - raw, suitable as API parameter"""
64 return socket.inet_pton(socket.AF_INET6, self.remote_ip6)
67 def local_ip6_ll(self):
68 """Local IPv6 linnk-local address on VPP interface (string)."""
69 return self._local_ip6_ll
72 def local_ip6n_ll(self):
73 """Local IPv6 link-local address - raw, suitable as API parameter."""
74 return self._local_ip6n_ll
77 def remote_ip6_ll(self):
78 """Link-local IPv6 address of remote peer
79 "connected" to this interface."""
80 return self._remote_ip6_ll
83 def remote_ip6n_ll(self):
84 """Link-local IPv6 address of remote peer
85 - raw, suitable as API parameter"""
86 return self._remote_ip6n_ll
90 """Name of the interface."""
95 """RAW result of sw_interface_dump for this interface."""
100 """Test case creating this interface."""
104 def remote_hosts(self):
105 """Remote hosts list"""
106 return self._remote_hosts
109 def remote_hosts(self, value):
111 :param list value: List of remote hosts.
113 self._remote_hosts = value
114 self._hosts_by_mac = {}
115 self._hosts_by_ip4 = {}
116 self._hosts_by_ip6 = {}
117 for host in self._remote_hosts:
118 self._hosts_by_mac[host.mac] = host
119 self._hosts_by_ip4[host.ip4] = host
120 self._hosts_by_ip6[host.ip6] = host
122 def host_by_mac(self, mac):
124 :param mac: MAC address to find host by.
125 :return: Host object assigned to interface.
127 return self._hosts_by_mac[mac]
129 def host_by_ip4(self, ip):
131 :param ip: IPv4 address to find host by.
132 :return: Host object assigned to interface.
134 return self._hosts_by_ip4[ip]
136 def host_by_ip6(self, ip):
138 :param ip: IPv6 address to find host by.
139 :return: Host object assigned to interface.
141 return self._hosts_by_ip6[ip]
143 def generate_remote_hosts(self, count=1):
144 """Generate and add remote hosts for the interface.
146 :param int count: Number of generated remote hosts.
148 self._remote_hosts = []
149 self._hosts_by_mac = {}
150 self._hosts_by_ip4 = {}
151 self._hosts_by_ip6 = {}
153 2, count + 2): # 0: network address, 1: local vpp address
154 mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i)
155 ip4 = "172.16.%u.%u" % (self.sw_if_index, i)
156 ip6 = "fd01:%x::%x" % (self.sw_if_index, i)
157 ip6_ll = mk_ll_addr(mac)
158 host = Host(mac, ip4, ip6, ip6_ll)
159 self._remote_hosts.append(host)
160 self._hosts_by_mac[mac] = host
161 self._hosts_by_ip4[ip4] = host
162 self._hosts_by_ip6[ip6] = host
165 def __init__(self, test):
168 self._remote_hosts = []
169 self._hosts_by_mac = {}
170 self._hosts_by_ip4 = {}
171 self._hosts_by_ip6 = {}
173 def set_mac(self, mac):
174 self._local_mac = mac
175 self._local_ip6_ll = mk_ll_addr(mac)
176 self.test.vapi.sw_interface_set_mac_address(
178 mactobinary(self._local_mac))
180 def set_sw_if_index(self, sw_if_index):
181 self._sw_if_index = sw_if_index
183 self.generate_remote_hosts()
185 self._local_ip4 = "172.16.%u.1" % self.sw_if_index
186 self._local_ip4n = socket.inet_pton(socket.AF_INET, self.local_ip4)
187 self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index
188 self._local_ip4n_subnet = socket.inet_pton(socket.AF_INET,
189 self._local_ip4_subnet)
190 self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index
191 self._local_ip4n_bcast = socket.inet_pton(socket.AF_INET,
192 self._local_ip4_bcast)
193 self.local_ip4_prefix_len = 24
194 self.has_ip4_config = False
195 self.ip4_table_id = 0
197 self._local_ip6 = "fd01:%x::1" % self.sw_if_index
198 self._local_ip6n = socket.inet_pton(socket.AF_INET6, self.local_ip6)
199 self.local_ip6_prefix_len = 64
200 self.has_ip6_config = False
201 self.ip6_table_id = 0
203 r = self.test.vapi.sw_interface_dump()
205 if intf.sw_if_index == self.sw_if_index:
206 self._name = intf.interface_name.split(b'\0', 1)[0]
208 ':'.join(intf.l2_address.encode('hex')[i:i + 2]
209 for i in range(0, 12, 2))
214 "Could not find interface with sw_if_index %d "
215 "in interface dump %s" %
216 (self.sw_if_index, repr(r)))
217 self._local_ip6_ll = mk_ll_addr(self.local_mac)
218 self._local_ip6n_ll = socket.inet_pton(socket.AF_INET6,
220 self._remote_ip6_ll = mk_ll_addr(self.remote_mac)
221 self._remote_ip6n_ll = socket.inet_pton(socket.AF_INET6,
224 def config_ip4(self):
225 """Configure IPv4 address on the VPP interface."""
226 self.test.vapi.sw_interface_add_del_address(
227 self.sw_if_index, self.local_ip4n, self.local_ip4_prefix_len)
228 self.has_ip4_config = True
230 def unconfig_ip4(self):
231 """Remove IPv4 address on the VPP interface."""
233 if self.has_ip4_config:
234 self.test.vapi.sw_interface_add_del_address(
237 self.local_ip4_prefix_len,
239 except AttributeError:
240 self.has_ip4_config = False
241 self.has_ip4_config = False
243 def configure_ipv4_neighbors(self):
244 """For every remote host assign neighbor's MAC to IPv4 addresses.
246 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
248 for host in self._remote_hosts:
249 macn = host.mac.replace(":", "").decode('hex')
251 self.test.vapi.ip_neighbor_add_del(
252 self.sw_if_index, macn, ipn)
254 def config_ip6(self):
255 """Configure IPv6 address on the VPP interface."""
256 self.test.vapi.sw_interface_add_del_address(
257 self.sw_if_index, self._local_ip6n, self.local_ip6_prefix_len,
259 self.has_ip6_config = True
261 def unconfig_ip6(self):
262 """Remove IPv6 address on the VPP interface."""
264 if self.has_ip6_config:
265 self.test.vapi.sw_interface_add_del_address(
268 self.local_ip6_prefix_len,
270 except AttributeError:
271 self.has_ip6_config = False
272 self.has_ip6_config = False
274 def configure_ipv6_neighbors(self):
275 """For every remote host assign neighbor's MAC to IPv6 addresses.
277 :param vrf_id: The FIB table / VRF ID. (Default value = 0)
279 for host in self._remote_hosts:
280 macn = host.mac.replace(":", "").decode('hex')
282 self.test.vapi.ip_neighbor_add_del(
283 self.sw_if_index, macn, ipn, is_ipv6=1)
286 """Unconfigure IPv6 and IPv4 address on the VPP interface."""
290 def set_table_ip4(self, table_id):
291 """Set the interface in a IPv4 Table.
293 .. note:: Must be called before configuring IP4 addresses.
295 self.ip4_table_id = table_id
296 self.test.vapi.sw_interface_set_table(
297 self.sw_if_index, 0, self.ip4_table_id)
299 def set_table_ip6(self, table_id):
300 """Set the interface in a IPv6 Table.
302 .. note:: Must be called before configuring IP6 addresses.
304 self.ip6_table_id = table_id
305 self.test.vapi.sw_interface_set_table(
306 self.sw_if_index, 1, self.ip6_table_id)
308 def disable_ipv6_ra(self):
309 """Configure IPv6 RA suppress on the VPP interface."""
310 self.test.vapi.sw_interface_ra_suppress(self.sw_if_index)
312 def ip6_ra_config(self, no=0, suppress=0, send_unicast=0):
313 """Configure IPv6 RA suppress on the VPP interface."""
314 self.test.vapi.ip6_sw_interface_ra_config(self.sw_if_index,
319 def ip6_ra_prefix(self, address, address_length, is_no=0,
320 off_link=0, no_autoconfig=0, use_default=0):
321 """Configure IPv6 RA suppress on the VPP interface."""
322 self.test.vapi.ip6_sw_interface_ra_prefix(self.sw_if_index,
327 no_autoconfig=no_autoconfig,
328 use_default=use_default)
331 """Put interface ADMIN-UP."""
332 self.test.vapi.sw_interface_set_flags(self.sw_if_index,
335 def admin_down(self):
336 """Put interface ADMIN-down."""
337 self.test.vapi.sw_interface_set_flags(self.sw_if_index,
340 def ip6_enable(self):
341 """IPv6 Enable interface"""
342 self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
345 def ip6_disable(self):
346 """Put interface ADMIN-DOWN."""
347 self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
350 def add_sub_if(self, sub_if):
351 """Register a sub-interface with this interface.
353 :param sub_if: sub-interface
355 if not hasattr(self, 'sub_if'):
358 if isinstance(self.sub_if, list):
359 self.sub_if.append(sub_if)
363 def enable_mpls(self):
364 """Enable MPLS on the VPP interface."""
365 self.test.vapi.sw_interface_enable_disable_mpls(
368 def disable_mpls(self):
369 """Enable MPLS on the VPP interface."""
370 self.test.vapi.sw_interface_enable_disable_mpls(
373 def is_ip4_entry_in_fib_dump(self, dump):
375 if i.address == self.local_ip4n and \
376 i.address_length == self.local_ip4_prefix_len and \
377 i.table_id == self.ip4_table_id:
381 def set_unnumbered(self, ip_sw_if_index):
382 """ Set the interface to unnumbered via ip_sw_if_index """
383 self.test.vapi.sw_interface_set_unnumbered(
387 def unset_unnumbered(self, ip_sw_if_index):
388 """ Unset the interface to unnumbered via ip_sw_if_index """
389 self.test.vapi.sw_interface_set_unnumbered(
394 def set_proxy_arp(self, enable=1):
395 """ Set the interface to enable/disable Proxy ARP """
396 self.test.vapi.proxy_arp_intfc_enable_disable(
400 def query_vpp_config(self):
401 dump = self.test.vapi.sw_interface_dump()
402 return self.is_interface_config_in_dump(dump)
404 def is_interface_config_in_dump(self, dump):
406 if i.interface_name.rstrip(' \t\r\n\0') == self.name and \
407 i.sw_if_index == self.sw_if_index: