4 from util import ip4_range
6 from framework import VppTestCase, VppTestRunner, running_extended_tests
7 from template_bd import BridgeDomain
9 from scapy.layers.l2 import Ether
10 from scapy.packet import Raw
11 from scapy.layers.inet import IP, UDP
12 from scapy.layers.vxlan import VXLAN
15 from vpp_ip_route import VppIpRoute, VppRoutePath
17 from vpp_ip import INVALID_INDEX
20 @unittest.skipUnless(running_extended_tests, "part of extended tests")
21 class TestVxlanGpe(BridgeDomain, VppTestCase):
22 """ VXLAN-GPE Test Case """
24 def __init__(self, *args):
25 BridgeDomain.__init__(self)
26 VppTestCase.__init__(self, *args)
28 def encapsulate(self, pkt, vni):
30 Encapsulate the original payload frame by adding VXLAN-GPE header
31 with its UDP, IP and Ethernet fields
33 return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
34 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
35 UDP(sport=self.dport, dport=self.dport, chksum=0) /
36 VXLAN(vni=vni, flags=self.flags) /
39 def ip_range(self, start, end):
40 """ range of remote ip's """
41 return ip4_range(self.pg0.remote_ip4, start, end)
43 def encap_mcast(self, pkt, src_ip, src_mac, vni):
45 Encapsulate the original payload frame by adding VXLAN-GPE header
46 with its UDP, IP and Ethernet fields
48 return (Ether(src=src_mac, dst=self.mcast_mac) /
49 IP(src=src_ip, dst=self.mcast_ip4) /
50 UDP(sport=self.dport, dport=self.dport, chksum=0) /
51 VXLAN(vni=vni, flags=self.flags) /
54 def decapsulate(self, pkt):
56 Decapsulate the original payload frame by removing VXLAN-GPE header
58 # check if is set I and P flag
59 self.assertEqual(pkt[VXLAN].flags, 0x0c)
60 return pkt[VXLAN].payload
62 # Method for checking VXLAN-GPE encapsulation.
64 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
65 # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
67 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
70 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
72 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
73 # Verify VXLAN-GPE tunnel src IP is VPP_IP and dst IP is MY_IP.
74 self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
77 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
79 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
80 # Verify UDP destination port is VXLAN-GPE 4790, source UDP port
82 self.assertEqual(pkt[UDP].dport, type(self).dport)
84 self.assert_udp_checksum_valid(pkt)
86 self.assertEqual(pkt[VXLAN].vni, vni)
89 def create_vxlan_gpe_flood_test_bd(cls, vni, n_ucast_tunnels):
90 # Create 10 ucast vxlan tunnels under bd
92 ip_range_end = ip_range_start + n_ucast_tunnels
93 next_hop_address = cls.pg0.remote_ip4
94 for dest_ip4 in ip4_range(next_hop_address, ip_range_start,
96 # add host route so dest_ip4n will not be resolved
97 rip = VppIpRoute(cls, dest_ip4, 32,
98 [VppRoutePath(next_hop_address,
103 r = cls.vapi.vxlan_gpe_add_del_tunnel(
104 src_addr=cls.pg0.local_ip4,
107 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
111 def add_del_shared_mcast_dst_load(cls, is_add):
113 add or del tunnels sharing the same mcast dst
114 to test vxlan_gpe ref_count mechanism
116 n_shared_dst_tunnels = 20
118 vni_end = vni_start + n_shared_dst_tunnels
119 for vni in range(vni_start, vni_end):
120 r = cls.vapi.vxlan_gpe_add_del_tunnel(
121 local=cls.pg0.local_ip4,
122 remote=cls.mcast_ip4,
126 if r.sw_if_index == 0xffffffff:
127 raise ValueError("bad sw_if_index: ~0")
130 def add_shared_mcast_dst_load(cls):
131 cls.add_del_shared_mcast_dst_load(is_add=1)
134 def del_shared_mcast_dst_load(cls):
135 cls.add_del_shared_mcast_dst_load(is_add=0)
138 def add_del_mcast_tunnels_load(cls, is_add):
140 add or del tunnels to test vxlan_gpe stability
142 n_distinct_dst_tunnels = 20
144 ip_range_end = ip_range_start + n_distinct_dst_tunnels
145 for dest_ip4 in ip4_range(cls.mcast_ip4, ip_range_start,
147 vni = int(dest_ip4.split(".")[3])
148 cls.vapi.vxlan_gpe_add_del_tunnel(
149 src_addr=cls.pg0.local_ip4,
156 def add_mcast_tunnels_load(cls):
157 cls.add_del_mcast_tunnels_load(is_add=1)
160 def del_mcast_tunnels_load(cls):
161 cls.add_del_mcast_tunnels_load(is_add=0)
163 # Class method to start the VXLAN-GPE test case.
164 # Overrides setUpClass method in VppTestCase class.
165 # Python try..except statement is used to ensure that the tear down of
166 # the class will be executed even if exception is raised.
167 # @param cls The class pointer.
170 super(TestVxlanGpe, cls).setUpClass()
176 # Create 2 pg interfaces.
177 cls.create_pg_interfaces(range(4))
178 for pg in cls.pg_interfaces:
181 # Configure IPv4 addresses on VPP pg0.
184 # Resolve MAC address for VPP's IP address on pg0.
185 cls.pg0.resolve_arp()
187 # Our Multicast address
188 cls.mcast_ip4 = '239.1.1.1'
189 cls.mcast_mac = util.mcast_ip_to_mac(cls.mcast_ip4)
191 # Create VXLAN-GPE VTEP on VPP pg0, and put vxlan_gpe_tunnel0
193 cls.single_tunnel_vni = 0xabcde
194 cls.single_tunnel_bd = 11
195 r = cls.vapi.vxlan_gpe_add_del_tunnel(
196 src_addr=cls.pg0.local_ip4,
197 dst_addr=cls.pg0.remote_ip4,
198 vni=cls.single_tunnel_vni)
199 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
200 bd_id=cls.single_tunnel_bd)
201 cls.vapi.sw_interface_set_l2_bridge(
202 rx_sw_if_index=cls.pg1.sw_if_index, bd_id=cls.single_tunnel_bd)
204 # Setup vni 2 to test multicast flooding
205 cls.n_ucast_tunnels = 10
206 cls.mcast_flood_bd = 12
207 cls.create_vxlan_gpe_flood_test_bd(cls.mcast_flood_bd,
209 r = cls.vapi.vxlan_gpe_add_del_tunnel(
210 src_addr=cls.pg0.local_ip4,
211 dst_addr=cls.mcast_ip4,
213 vni=cls.mcast_flood_bd)
214 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
215 bd_id=cls.mcast_flood_bd)
216 cls.vapi.sw_interface_set_l2_bridge(
217 rx_sw_if_index=cls.pg2.sw_if_index, bd_id=cls.mcast_flood_bd)
219 # Add and delete mcast tunnels to check stability
220 cls.add_shared_mcast_dst_load()
221 cls.add_mcast_tunnels_load()
222 cls.del_shared_mcast_dst_load()
223 cls.del_mcast_tunnels_load()
225 # Setup vni 3 to test unicast flooding
226 cls.ucast_flood_bd = 13
227 cls.create_vxlan_gpe_flood_test_bd(cls.ucast_flood_bd,
229 cls.vapi.sw_interface_set_l2_bridge(
230 rx_sw_if_index=cls.pg3.sw_if_index, bd_id=cls.ucast_flood_bd)
232 super(TestVxlanGpe, cls).tearDownClass()
236 def tearDownClass(cls):
237 super(TestVxlanGpe, cls).tearDownClass()
239 @unittest.skip("test disabled for vxlan-gpe")
240 def test_mcast_flood(self):
241 """ inherited from BridgeDomain """
244 @unittest.skip("test disabled for vxlan-gpe")
245 def test_mcast_rcv(self):
246 """ inherited from BridgeDomain """
249 # Method to define VPP actions before tear down of the test case.
250 # Overrides tearDown method in VppTestCase class.
251 # @param self The object pointer.
253 super(TestVxlanGpe, self).tearDown()
255 def show_commands_at_teardown(self):
256 self.logger.info(self.vapi.cli("show bridge-domain 11 detail"))
257 self.logger.info(self.vapi.cli("show bridge-domain 12 detail"))
258 self.logger.info(self.vapi.cli("show bridge-domain 13 detail"))
259 self.logger.info(self.vapi.cli("show int"))
260 self.logger.info(self.vapi.cli("show vxlan-gpe"))
261 self.logger.info(self.vapi.cli("show trace"))
264 if __name__ == '__main__':
265 unittest.main(testRunner=VppTestRunner)