4 from util import ip4n_range, ip4_range, reassemble4
6 from framework import VppTestCase, VppTestRunner
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
13 from scapy.utils import atol
14 from vpp_ip_route import VppIpRoute, VppRoutePath
15 from vpp_ip import INVALID_INDEX
18 class TestVxlan(BridgeDomain, VppTestCase):
19 """ VXLAN Test Case """
21 def __init__(self, *args):
22 BridgeDomain.__init__(self)
23 VppTestCase.__init__(self, *args)
25 def encapsulate(self, pkt, vni):
27 Encapsulate the original payload frame by adding VXLAN header with its
28 UDP, IP and Ethernet fields
30 return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
31 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
32 UDP(sport=self.dport, dport=self.dport, chksum=0) /
33 VXLAN(vni=vni, flags=self.flags) /
36 def ip_range(self, start, end):
37 """ range of remote ip's """
38 return ip4_range(self.pg0.remote_ip4, start, end)
40 def encap_mcast(self, pkt, src_ip, src_mac, vni):
42 Encapsulate the original payload frame by adding VXLAN header with its
43 UDP, IP and Ethernet fields
45 return (Ether(src=src_mac, dst=self.mcast_mac) /
46 IP(src=src_ip, dst=self.mcast_ip4) /
47 UDP(sport=self.dport, dport=self.dport, chksum=0) /
48 VXLAN(vni=vni, flags=self.flags) /
51 def decapsulate(self, pkt):
53 Decapsulate the original payload frame by removing VXLAN header
55 # check if is set I flag
56 self.assertEqual(pkt[VXLAN].flags, int('0x8', 16))
57 return pkt[VXLAN].payload
59 # Method for checking VXLAN encapsulation.
61 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
62 # TODO: add error messages
63 # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
65 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
68 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
70 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
71 # Verify VXLAN tunnel source IP is VPP_IP and destination IP is MY_IP.
72 self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
75 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
77 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
78 # Verify UDP destination port is VXLAN 4789, source UDP port could be
80 self.assertEqual(pkt[UDP].dport, type(self).dport)
81 # TODO: checksum check
83 self.assertEqual(pkt[VXLAN].vni, vni)
86 def create_vxlan_flood_test_bd(cls, vni, n_ucast_tunnels):
87 # Create 10 ucast vxlan tunnels under bd
89 ip_range_end = ip_range_start + n_ucast_tunnels
90 next_hop_address = cls.pg0.remote_ip4
91 for dest_ip4 in ip4_range(next_hop_address, ip_range_start,
93 # add host route so dest_ip4n will not be resolved
94 rip = VppIpRoute(cls, dest_ip4, 32,
95 [VppRoutePath(next_hop_address,
99 dest_ip4n = socket.inet_pton(socket.AF_INET, dest_ip4)
101 r = cls.vapi.vxlan_add_del_tunnel(src_address=cls.pg0.local_ip4n,
102 dst_address=dest_ip4n, vni=vni)
103 cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index, bd_id=vni)
106 def add_del_shared_mcast_dst_load(cls, is_add):
108 add or del tunnels sharing the same mcast dst
109 to test vxlan ref_count mechanism
111 n_shared_dst_tunnels = 20
113 vni_end = vni_start + n_shared_dst_tunnels
114 for vni in range(vni_start, vni_end):
115 r = cls.vapi.vxlan_add_del_tunnel(src_address=cls.pg0.local_ip4n,
116 dst_address=cls.mcast_ip4n,
118 is_add=is_add, vni=vni)
119 if r.sw_if_index == 0xffffffff:
120 raise ValueError("bad sw_if_index: ~0")
123 def add_shared_mcast_dst_load(cls):
124 cls.add_del_shared_mcast_dst_load(is_add=1)
127 def del_shared_mcast_dst_load(cls):
128 cls.add_del_shared_mcast_dst_load(is_add=0)
131 def add_del_mcast_tunnels_load(cls, is_add):
133 add or del tunnels to test vxlan stability
135 n_distinct_dst_tunnels = 200
137 ip_range_end = ip_range_start + n_distinct_dst_tunnels
138 for dest_ip4n in ip4n_range(cls.mcast_ip4n, ip_range_start,
140 vni = bytearray(dest_ip4n)[3]
141 cls.vapi.vxlan_add_del_tunnel(src_address=cls.pg0.local_ip4n,
142 dst_address=dest_ip4n,
143 mcast_sw_if_index=1, is_add=is_add,
147 def add_mcast_tunnels_load(cls):
148 cls.add_del_mcast_tunnels_load(is_add=1)
151 def del_mcast_tunnels_load(cls):
152 cls.add_del_mcast_tunnels_load(is_add=0)
154 # Class method to start the VXLAN test case.
155 # Overrides setUpClass method in VppTestCase class.
156 # Python try..except statement is used to ensure that the tear down of
157 # the class will be executed even if exception is raised.
158 # @param cls The class pointer.
161 super(TestVxlan, 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_ip4n = socket.inet_pton(socket.AF_INET, cls.mcast_ip4)
181 iplong = atol(cls.mcast_ip4)
182 cls.mcast_mac = "01:00:5e:%02x:%02x:%02x" % (
183 (iplong >> 16) & 0x7F, (iplong >> 8) & 0xFF, iplong & 0xFF)
185 # Create VXLAN VTEP on VPP pg0, and put vxlan_tunnel0 and pg1
187 cls.single_tunnel_bd = 1
188 r = cls.vapi.vxlan_add_del_tunnel(src_address=cls.pg0.local_ip4n,
189 dst_address=cls.pg0.remote_ip4n,
190 vni=cls.single_tunnel_bd)
191 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
192 bd_id=cls.single_tunnel_bd)
193 cls.vapi.sw_interface_set_l2_bridge(
194 rx_sw_if_index=cls.pg1.sw_if_index, bd_id=cls.single_tunnel_bd)
196 # Setup vni 2 to test multicast flooding
197 cls.n_ucast_tunnels = 10
198 cls.mcast_flood_bd = 2
199 cls.create_vxlan_flood_test_bd(cls.mcast_flood_bd,
201 r = cls.vapi.vxlan_add_del_tunnel(src_address=cls.pg0.local_ip4n,
202 dst_address=cls.mcast_ip4n,
204 vni=cls.mcast_flood_bd)
205 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
206 bd_id=cls.mcast_flood_bd)
207 cls.vapi.sw_interface_set_l2_bridge(
208 rx_sw_if_index=cls.pg2.sw_if_index, bd_id=cls.mcast_flood_bd)
210 # Add and delete mcast tunnels to check stability
211 cls.add_shared_mcast_dst_load()
212 cls.add_mcast_tunnels_load()
213 cls.del_shared_mcast_dst_load()
214 cls.del_mcast_tunnels_load()
216 # Setup vni 3 to test unicast flooding
217 cls.ucast_flood_bd = 3
218 cls.create_vxlan_flood_test_bd(cls.ucast_flood_bd,
220 cls.vapi.sw_interface_set_l2_bridge(
221 rx_sw_if_index=cls.pg3.sw_if_index, bd_id=cls.ucast_flood_bd)
223 super(TestVxlan, cls).tearDownClass()
227 def tearDownClass(cls):
228 super(TestVxlan, cls).tearDownClass()
230 def test_encap_big_packet(self):
231 """ Encapsulation test send big frame from pg1
232 Verify receipt of encapsulated frames on pg0
235 self.vapi.sw_interface_set_mtu(self.pg0.sw_if_index, [1500, 0, 0, 0])
237 frame = (Ether(src='00:00:00:00:00:02', dst='00:00:00:00:00:01') /
238 IP(src='4.3.2.1', dst='1.2.3.4') /
239 UDP(sport=20000, dport=10000) /
242 self.pg1.add_stream([frame])
244 self.pg0.enable_capture()
248 # Pick first received frame and check if it's correctly encapsulated.
249 out = self.pg0.get_capture(2)
251 pkt = reassemble4(out)
253 self.check_encapsulation(pkt, self.single_tunnel_bd)
255 payload = self.decapsulate(pkt)
257 # self.assert_eq_pkts(payload, frame)
259 # Method to define VPP actions before tear down of the test case.
260 # Overrides tearDown method in VppTestCase class.
261 # @param self The object pointer.
263 super(TestVxlan, self).tearDown()
265 def show_commands_at_teardown(self):
266 self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
267 self.logger.info(self.vapi.cli("show bridge-domain 2 detail"))
268 self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
269 self.logger.info(self.vapi.cli("show vxlan tunnel"))
272 if __name__ == '__main__':
273 unittest.main(testRunner=VppTestRunner)