4 from util import ip4_range
6 from framework import VppTestCase, VppTestRunner
7 from template_bd import BridgeDomain
9 from scapy.layers.l2 import Ether, ARP
10 from scapy.layers.inet import IP, UDP, ICMP
11 from scapy.contrib.geneve import GENEVE
14 from vpp_ip_route import VppIpRoute, VppRoutePath
15 from vpp_ip import INVALID_INDEX
18 class TestGeneve(BridgeDomain, VppTestCase):
19 """ GENEVE Test Case """
21 def __init__(self, *args):
22 BridgeDomain.__init__(self)
23 VppTestCase.__init__(self, *args)
25 def encapsulate(self, pkt, vni):
28 Encapsulate the original payload frame by adding GENEVE header with its
29 UDP, IP and Ethernet fields
31 return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
32 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
33 UDP(sport=self.dport, dport=self.dport, chksum=0) /
37 def ip_range(self, start, end):
38 """ range of remote ip's """
39 return ip4_range(self.pg0.remote_ip4, start, end)
41 def encap_mcast(self, pkt, src_ip, src_mac, vni):
43 Encapsulate the original payload frame by adding GENEVE header with its
44 UDP, IP and Ethernet fields
46 return (Ether(src=src_mac, dst=self.mcast_mac) /
47 IP(src=src_ip, dst=self.mcast_ip4) /
48 UDP(sport=self.dport, dport=self.dport, chksum=0) /
52 def decapsulate(self, pkt):
54 Decapsulate the original payload frame by removing GENEVE header
56 # check if is set I flag
57 # self.assertEqual(pkt[GENEVE].flags, int('0x8', 16))
58 return pkt[GENEVE].payload
60 # Method for checking GENEVE encapsulation.
62 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
63 # TODO: add error messages
64 # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
66 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
69 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
71 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
72 # Verify GENEVE tunnel source IP is VPP_IP and destination IP is MY_IP.
73 self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
76 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
78 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
79 # Verify UDP destination port is GENEVE 4789, source UDP port could be
81 self.assertEqual(pkt[UDP].dport, type(self).dport)
82 # TODO: checksum check
84 self.assertEqual(pkt[GENEVE].vni, vni)
87 def create_geneve_flood_test_bd(cls, vni, n_ucast_tunnels):
88 # Create 10 ucast geneve tunnels under bd
90 ip_range_end = ip_range_start + n_ucast_tunnels
91 next_hop_address = cls.pg0.remote_ip4
92 for dest_ip4 in ip4_range(next_hop_address, ip_range_start,
94 # add host route so dest_ip4 will not be resolved
95 rip = VppIpRoute(cls, dest_ip4, 32,
96 [VppRoutePath(next_hop_address,
100 r = cls.vapi.geneve_add_del_tunnel(
101 local_address=cls.pg0.local_ip4, remote_address=dest_ip4,
103 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
107 def add_del_shared_mcast_dst_load(cls, is_add):
109 add or del tunnels sharing the same mcast dst
110 to test geneve ref_count mechanism
112 n_shared_dst_tunnels = 10
114 vni_end = vni_start + n_shared_dst_tunnels
115 for vni in range(vni_start, vni_end):
116 r = cls.vapi.geneve_add_del_tunnel(
117 local_address=cls.pg0.local_ip4,
118 remote_address=cls.mcast_ip4, mcast_sw_if_index=1,
119 is_add=is_add, vni=vni)
120 if r.sw_if_index == 0xffffffff:
121 raise ValueError("bad sw_if_index: ~0")
124 def add_shared_mcast_dst_load(cls):
125 cls.add_del_shared_mcast_dst_load(is_add=1)
128 def del_shared_mcast_dst_load(cls):
129 cls.add_del_shared_mcast_dst_load(is_add=0)
132 def add_del_mcast_tunnels_load(cls, is_add):
134 add or del tunnels to test geneve stability
136 n_distinct_dst_tunnels = 10
138 ip_range_end = ip_range_start + n_distinct_dst_tunnels
139 for dest_ip4 in ip4_range(cls.mcast_ip4, ip_range_start,
141 vni = int(dest_ip4.split('.')[3])
142 cls.vapi.geneve_add_del_tunnel(local_address=cls.pg0.local_ip4,
143 remote_address=dest_ip4,
144 mcast_sw_if_index=1, is_add=is_add,
148 def add_mcast_tunnels_load(cls):
149 cls.add_del_mcast_tunnels_load(is_add=1)
152 def del_mcast_tunnels_load(cls):
153 cls.add_del_mcast_tunnels_load(is_add=0)
155 # Class method to start the GENEVE test case.
156 # Overrides setUpClass method in VppTestCase class.
157 # Python try..except statement is used to ensure that the tear down of
158 # the class will be executed even if exception is raised.
159 # @param cls The class pointer.
162 super(TestGeneve, cls).setUpClass()
167 # Create 2 pg interfaces.
168 cls.create_pg_interfaces(range(4))
169 for pg in cls.pg_interfaces:
172 # Configure IPv4 addresses on VPP pg0.
175 # Resolve MAC address for VPP's IP address on pg0.
176 cls.pg0.resolve_arp()
178 # Our Multicast address
179 cls.mcast_ip4 = '239.1.1.1'
180 cls.mcast_mac = util.mcast_ip_to_mac(cls.mcast_ip4)
182 # Create GENEVE VTEP on VPP pg0, and put geneve_tunnel0 and pg1
184 cls.single_tunnel_vni = 0xabcde
185 cls.single_tunnel_bd = 1
186 r = cls.vapi.geneve_add_del_tunnel(
187 local_address=cls.pg0.local_ip4,
188 remote_address=cls.pg0.remote_ip4, vni=cls.single_tunnel_vni)
189 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
190 bd_id=cls.single_tunnel_bd)
191 cls.vapi.sw_interface_set_l2_bridge(
192 rx_sw_if_index=cls.pg1.sw_if_index, bd_id=cls.single_tunnel_bd)
194 # Setup vni 2 to test multicast flooding
195 cls.n_ucast_tunnels = 10
196 cls.mcast_flood_bd = 2
197 cls.create_geneve_flood_test_bd(cls.mcast_flood_bd,
199 r = cls.vapi.geneve_add_del_tunnel(
200 local_address=cls.pg0.local_ip4,
201 remote_address=cls.mcast_ip4, mcast_sw_if_index=1,
202 vni=cls.mcast_flood_bd)
203 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
204 bd_id=cls.mcast_flood_bd)
205 cls.vapi.sw_interface_set_l2_bridge(
206 rx_sw_if_index=cls.pg2.sw_if_index, bd_id=cls.mcast_flood_bd)
208 # Add and delete mcast tunnels to check stability
209 cls.add_shared_mcast_dst_load()
210 cls.add_mcast_tunnels_load()
211 cls.del_shared_mcast_dst_load()
212 cls.del_mcast_tunnels_load()
214 # Setup vni 3 to test unicast flooding
215 cls.ucast_flood_bd = 3
216 cls.create_geneve_flood_test_bd(cls.ucast_flood_bd,
218 cls.vapi.sw_interface_set_l2_bridge(
219 rx_sw_if_index=cls.pg3.sw_if_index, bd_id=cls.ucast_flood_bd)
221 super(TestGeneve, cls).tearDownClass()
224 # Method to define VPP actions before tear down of the test case.
225 # Overrides tearDown method in VppTestCase class.
226 # @param self The object pointer.
228 super(TestGeneve, self).tearDown()
230 def show_commands_at_teardown(self):
231 self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
232 self.logger.info(self.vapi.cli("show bridge-domain 2 detail"))
233 self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
234 self.logger.info(self.vapi.cli("show geneve tunnel"))
237 class TestGeneveL3(VppTestCase):
238 """ GENEVE L3 Test Case """
242 super(TestGeneveL3, cls).setUpClass()
244 cls.create_pg_interfaces(range(2))
245 cls.interfaces = list(cls.pg_interfaces)
247 for i in cls.interfaces:
252 super(TestGeneveL3, cls).tearDownClass()
256 def tearDownClass(cls):
257 super(TestGeneveL3, cls).tearDownClass()
260 super(TestGeneveL3, self).tearDown()
262 def show_commands_at_teardown(self):
263 self.logger.info(self.vapi.cli("show geneve tunnel"))
264 self.logger.info(self.vapi.cli("show ip neighbor"))
266 def test_l3_packet(self):
268 r = self.vapi.add_node_next(node_name="geneve4-input",
269 next_name="ethernet-input")
270 r = self.vapi.geneve_add_del_tunnel2(
272 local_address=self.pg0.local_ip4,
273 remote_address=self.pg0.remote_ip4,
276 decap_next_index=r.next_index)
278 self.vapi.sw_interface_add_del_address(
279 sw_if_index=r.sw_if_index, prefix="10.0.0.1/24")
281 pkt = (Ether(src=self.pg0.remote_mac, dst="d0:0b:ee:d0:00:00") /
282 IP(src='10.0.0.2', dst='10.0.0.1') /
285 encap = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
286 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
287 UDP(sport=6081, dport=6081, chksum=0) /
290 arp = (Ether(src=self.pg0.remote_mac, dst="d0:0b:ee:d0:00:00") /
291 ARP(op="is-at", hwsrc=self.pg0.remote_mac,
292 hwdst="d0:0b:ee:d0:00:00", psrc="10.0.0.2",
295 rx = self.send_and_expect(self.pg0, encap/pkt*1, self.pg0)
296 rx = self.send_and_assert_no_replies(self.pg0, encap/arp*1, self.pg0)
297 rx = self.send_and_expect(self.pg0, encap/pkt*1, self.pg0)
298 self.assertEqual(rx[0][ICMP].type, 0) # echo reply
300 r = self.vapi.geneve_add_del_tunnel2(
302 local_address=self.pg0.local_ip4,
303 remote_address=self.pg0.remote_ip4,
306 if __name__ == '__main__':
307 unittest.main(testRunner=VppTestRunner)