1 from abc import abstractmethod, ABCMeta
3 from logging import info, error
4 from scapy.layers.l2 import Ether, ARP
6 from scapy.layers.inet6 import IPv6, ICMPv6ND_NS, ICMPv6ND_NA, ICMPv6NDOptSrcLLAddr, ICMPv6NDOptDstLLAddr
9 class VppInterface(object):
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_mac
27 """MAC-address of the VPP interface"""
28 return self._local_mac
32 """Local IPv4 address on VPP interface (string)"""
33 return self._local_ip4
37 """Local IPv4 address - raw, suitable as API parameter"""
38 return self._local_ip4n
42 """IPv4 address of remote peer "connected" to this interface"""
43 return self._remote_ip4
46 def remote_ip4n(self):
47 """IPv4 address of remote peer - raw, suitable as API parameter"""
48 return self._remote_ip4n
52 """Local IPv6 address on VPP interface (string)"""
53 return self._local_ip6
57 """Local IPv6 address - raw, suitable as API parameter"""
58 return self._local_ip6n
62 """IPv6 address of remote peer "connected" to this interface"""
63 return self._remote_ip6
66 def remote_ip6n(self):
67 """IPv6 address of remote peer - raw, suitable as API parameter"""
68 return self._remote_ip6n
72 """Name of the interface"""
77 """Raw result of sw_interface_dump for this interface"""
82 """Test case creating this interface"""
85 def post_init_setup(self):
86 """Additional setup run after creating an interface object"""
87 self._remote_mac = "02:00:00:00:ff:%02x" % self.sw_if_index
89 self._local_ip4 = "172.16.%u.1" % self.sw_if_index
90 self._local_ip4n = socket.inet_pton(socket.AF_INET, self.local_ip4)
91 self._remote_ip4 = "172.16.%u.2" % self.sw_if_index
92 self._remote_ip4n = socket.inet_pton(socket.AF_INET, self.remote_ip4)
94 self._local_ip6 = "fd01:%u::1" % self.sw_if_index
95 self._local_ip6n = socket.inet_pton(socket.AF_INET6, self.local_ip6)
96 self._remote_ip6 = "fd01:%u::2" % self.sw_if_index
97 self._remote_ip6n = socket.inet_pton(socket.AF_INET6, self.remote_ip6)
99 r = self.test.vapi.sw_interface_dump()
101 if intf.sw_if_index == self.sw_if_index:
102 self._name = intf.interface_name.split(b'\0', 1)[0]
103 self._local_mac = ':'.join(intf.l2_address.encode('hex')[i:i + 2]
104 for i in range(0, 12, 2))
109 "Could not find interface with sw_if_index %d "
110 "in interface dump %s" %
111 (self.sw_if_index, repr(r)))
114 def __init__(self, test, index):
116 self.post_init_setup()
117 info("New %s, MAC=%s, remote_ip4=%s, local_ip4=%s" %
118 (self.__name__, self.remote_mac, self.remote_ip4, self.local_ip4))
120 def config_ip4(self):
121 """Configure IPv4 address on the VPP interface"""
122 addr = self.local_ip4n
124 self.test.vapi.sw_interface_add_del_address(
125 self.sw_if_index, addr, addr_len)
127 def config_ip6(self):
128 """Configure IPv6 address on the VPP interface"""
129 addr = self._local_ip6n
131 self.test.vapi.sw_interface_add_del_address(
132 self.sw_if_index, addr, addr_len, is_ipv6=1)
134 def set_table_ip4(self, table_id):
135 """Set the interface in a IPv4 Table.
136 Must be called before configuring IP4 addresses"""
137 self.test.vapi.sw_interface_set_table(
138 self.sw_if_index, 0, table_id)
140 def set_table_ip6(self, table_id):
141 """Set the interface in a IPv6 Table.
142 Must be called before configuring IP6 addresses"""
143 self.test.vapi.sw_interface_set_table(
144 self.sw_if_index, 1, table_id)
146 def disable_ipv6_ra(self):
147 """Configure IPv6 RA suppress on the VPP interface"""
148 self.test.vapi.sw_interface_ra_suppress(self.sw_if_index)
150 def create_arp_req(self):
151 """Create ARP request applicable for this interface"""
152 return (Ether(dst="ff:ff:ff:ff:ff:ff", src=self.remote_mac) /
153 ARP(op=ARP.who_has, pdst=self.local_ip4,
154 psrc=self.remote_ip4, hwsrc=self.remote_mac))
156 def create_ndp_req(self):
157 return (Ether(dst="ff:ff:ff:ff:ff:ff", src=self.remote_mac) /
158 IPv6(src=self.remote_ip6, dst=self.local_ip6) /
159 ICMPv6ND_NS(tgt=self.local_ip6) /
160 ICMPv6NDOptSrcLLAddr(lladdr=self.remote_mac))
162 def resolve_arp(self, pg_interface=None):
163 """Resolve ARP using provided packet-generator interface
165 :param pg_interface: interface used to resolve, if None then this
169 if pg_interface is None:
171 info("Sending ARP request for %s on port %s" %
172 (self.local_ip4, pg_interface.name))
173 arp_req = self.create_arp_req()
174 pg_interface.add_stream(arp_req)
175 pg_interface.enable_capture()
177 info(self.test.vapi.cli("show trace"))
178 arp_reply = pg_interface.get_capture()
179 if arp_reply is None or len(arp_reply) == 0:
180 info("No ARP received on port %s" % pg_interface.name)
182 arp_reply = arp_reply[0]
183 # Make Dot1AD packet content recognizable to scapy
184 if arp_reply.type == 0x88a8:
185 arp_reply.type = 0x8100
186 arp_reply = Ether(str(arp_reply))
188 if arp_reply[ARP].op == ARP.is_at:
189 info("VPP %s MAC address is %s " %
190 (self.name, arp_reply[ARP].hwsrc))
191 self._local_mac = arp_reply[ARP].hwsrc
193 info("No ARP received on port %s" % pg_interface.name)
195 error("Unexpected response to ARP request:")
196 error(arp_reply.show())
199 def resolve_ndp(self, pg_interface=None):
200 """Resolve NDP using provided packet-generator interface
202 :param pg_interface: interface used to resolve, if None then this
206 if pg_interface is None:
208 info("Sending NDP request for %s on port %s" %
209 (self.local_ip6, pg_interface.name))
210 ndp_req = self.create_ndp_req()
211 pg_interface.add_stream(ndp_req)
212 pg_interface.enable_capture()
214 info(self.test.vapi.cli("show trace"))
215 ndp_reply = pg_interface.get_capture()
216 if ndp_reply is None or len(ndp_reply) == 0:
217 info("No NDP received on port %s" % pg_interface.name)
219 ndp_reply = ndp_reply[0]
220 # Make Dot1AD packet content recognizable to scapy
221 if ndp_reply.type == 0x88a8:
222 ndp_reply.type = 0x8100
223 ndp_reply = Ether(str(ndp_reply))
225 ndp_na = ndp_reply[ICMPv6ND_NA]
226 opt = ndp_na[ICMPv6NDOptDstLLAddr]
227 info("VPP %s MAC address is %s " %
228 (self.name, opt.lladdr))
229 self._local_mac = opt.lladdr
231 error("Unexpected response to NDP request:")
232 error(ndp_reply.show())
236 """ Put interface ADMIN-UP """
237 self.test.vapi.sw_interface_set_flags(self.sw_if_index, admin_up_down=1)
239 def add_sub_if(self, sub_if):
241 Register a sub-interface with this interface
243 :param sub_if: sub-interface
246 if not hasattr(self, 'sub_if'):
249 if isinstance(self.sub_if, list):
250 self.sub_if.append(sub_if)
254 def enable_mpls(self):
255 """Enable MPLS on the VPP interface"""
256 self.test.vapi.sw_interface_enable_disable_mpls(