blob: 1411dd6c0261452b1bc769950fa199064367c67b [file] [log] [blame]
Damjan Marionf56b77a2016-10-03 19:44:57 +02001#!/usr/bin/env python
2
Eyal Baric4aaee12016-12-20 18:36:46 +02003import socket
Eyal Baricef1e2a2018-06-18 13:01:59 +03004from util import ip4n_range, ip4_range
Damjan Marionf56b77a2016-10-03 19:44:57 +02005import unittest
6from framework import VppTestCase, VppTestRunner
Damjan Marionf56b77a2016-10-03 19:44:57 +02007from template_bd import BridgeDomain
8
9from scapy.layers.l2 import Ether
10from scapy.layers.inet import IP, UDP
Matej Klottondeb69842016-12-09 15:05:46 +010011from scapy.layers.vxlan import VXLAN
Eyal Baric4aaee12016-12-20 18:36:46 +020012from scapy.utils import atol
Damjan Marionf56b77a2016-10-03 19:44:57 +020013
14
Klement Sekeraf62ae122016-10-11 11:47:09 +020015class TestVxlan(BridgeDomain, VppTestCase):
Damjan Marionf56b77a2016-10-03 19:44:57 +020016 """ VXLAN Test Case """
17
Damjan Marionf56b77a2016-10-03 19:44:57 +020018 def __init__(self, *args):
19 BridgeDomain.__init__(self)
Damjan Marionf56b77a2016-10-03 19:44:57 +020020 VppTestCase.__init__(self, *args)
21
Eyal Baric4aaee12016-12-20 18:36:46 +020022 def encapsulate(self, pkt, vni):
Klement Sekeraf62ae122016-10-11 11:47:09 +020023 """
24 Encapsulate the original payload frame by adding VXLAN header with its
25 UDP, IP and Ethernet fields
26 """
27 return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
28 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
29 UDP(sport=self.dport, dport=self.dport, chksum=0) /
Eyal Baric4aaee12016-12-20 18:36:46 +020030 VXLAN(vni=vni, flags=self.flags) /
31 pkt)
32
Eyal Baricef1e2a2018-06-18 13:01:59 +030033 def ip_range(self, start, end):
34 """ range of remote ip's """
35 return ip4_range(self.pg0.remote_ip4, start, end)
36
Eyal Baric4aaee12016-12-20 18:36:46 +020037 def encap_mcast(self, pkt, src_ip, src_mac, vni):
38 """
39 Encapsulate the original payload frame by adding VXLAN header with its
40 UDP, IP and Ethernet fields
41 """
Eyal Barid81da8c2017-01-11 13:39:54 +020042 return (Ether(src=src_mac, dst=self.mcast_mac) /
Eyal Baric4aaee12016-12-20 18:36:46 +020043 IP(src=src_ip, dst=self.mcast_ip4) /
44 UDP(sport=self.dport, dport=self.dport, chksum=0) /
45 VXLAN(vni=vni, flags=self.flags) /
Damjan Marionf56b77a2016-10-03 19:44:57 +020046 pkt)
47
Damjan Marionf56b77a2016-10-03 19:44:57 +020048 def decapsulate(self, pkt):
Klement Sekeraf62ae122016-10-11 11:47:09 +020049 """
50 Decapsulate the original payload frame by removing VXLAN header
51 """
Matej Klottondeb69842016-12-09 15:05:46 +010052 # check if is set I flag
53 self.assertEqual(pkt[VXLAN].flags, int('0x8', 16))
Damjan Marionf56b77a2016-10-03 19:44:57 +020054 return pkt[VXLAN].payload
55
Klement Sekeraf62ae122016-10-11 11:47:09 +020056 # Method for checking VXLAN encapsulation.
Damjan Marionf56b77a2016-10-03 19:44:57 +020057 #
Eyal Bari6ae5ee72017-03-23 09:53:51 +020058 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
Damjan Marionf56b77a2016-10-03 19:44:57 +020059 # TODO: add error messages
Klement Sekeraf62ae122016-10-11 11:47:09 +020060 # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
Damjan Marionf56b77a2016-10-03 19:44:57 +020061 # by VPP using ARP.
Klement Sekeraf62ae122016-10-11 11:47:09 +020062 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
Eyal Baric4aaee12016-12-20 18:36:46 +020063 if not local_only:
Eyal Bari6ae5ee72017-03-23 09:53:51 +020064 if not mcast_pkt:
65 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
66 else:
67 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
Klement Sekeraf62ae122016-10-11 11:47:09 +020068 # Verify VXLAN tunnel source IP is VPP_IP and destination IP is MY_IP.
69 self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
Eyal Baric4aaee12016-12-20 18:36:46 +020070 if not local_only:
Eyal Bari6ae5ee72017-03-23 09:53:51 +020071 if not mcast_pkt:
72 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
73 else:
74 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
Klement Sekeraf62ae122016-10-11 11:47:09 +020075 # Verify UDP destination port is VXLAN 4789, source UDP port could be
Damjan Marionf56b77a2016-10-03 19:44:57 +020076 # arbitrary.
Klement Sekeraf62ae122016-10-11 11:47:09 +020077 self.assertEqual(pkt[UDP].dport, type(self).dport)
Damjan Marionf56b77a2016-10-03 19:44:57 +020078 # TODO: checksum check
Eyal Baric4aaee12016-12-20 18:36:46 +020079 # Verify VNI
80 self.assertEqual(pkt[VXLAN].vni, vni)
81
Eyal Baric4aaee12016-12-20 18:36:46 +020082 @classmethod
Eyal Barid81da8c2017-01-11 13:39:54 +020083 def create_vxlan_flood_test_bd(cls, vni, n_ucast_tunnels):
Eyal Baric4aaee12016-12-20 18:36:46 +020084 # Create 10 ucast vxlan tunnels under bd
85 ip_range_start = 10
Eyal Barid81da8c2017-01-11 13:39:54 +020086 ip_range_end = ip_range_start + n_ucast_tunnels
Eyal Baric4aaee12016-12-20 18:36:46 +020087 next_hop_address = cls.pg0.remote_ip4n
Eyal Barid81da8c2017-01-11 13:39:54 +020088 for dest_ip4n in ip4n_range(next_hop_address, ip_range_start,
89 ip_range_end):
90 # add host route so dest_ip4n will not be resolved
91 cls.vapi.ip_add_del_route(dest_ip4n, 32, next_hop_address)
Eyal Baric4aaee12016-12-20 18:36:46 +020092 r = cls.vapi.vxlan_add_del_tunnel(
93 src_addr=cls.pg0.local_ip4n,
Eyal Barid81da8c2017-01-11 13:39:54 +020094 dst_addr=dest_ip4n,
Eyal Baric4aaee12016-12-20 18:36:46 +020095 vni=vni)
96 cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index, bd_id=vni)
97
98 @classmethod
Eyal Bari4bce2902017-01-16 12:02:46 +020099 def add_del_shared_mcast_dst_load(cls, is_add):
100 """
101 add or del tunnels sharing the same mcast dst
102 to test vxlan ref_count mechanism
103 """
Gabriel Ganne7e665d62017-11-17 09:18:53 +0100104 n_shared_dst_tunnels = 20
Eyal Bari4bce2902017-01-16 12:02:46 +0200105 vni_start = 10000
106 vni_end = vni_start + n_shared_dst_tunnels
107 for vni in range(vni_start, vni_end):
Eyal Barid9278342017-04-06 03:31:00 +0300108 r = cls.vapi.vxlan_add_del_tunnel(
Eyal Bari4bce2902017-01-16 12:02:46 +0200109 src_addr=cls.pg0.local_ip4n,
110 dst_addr=cls.mcast_ip4n,
111 mcast_sw_if_index=1,
112 vni=vni,
113 is_add=is_add)
Eyal Barid9278342017-04-06 03:31:00 +0300114 if r.sw_if_index == 0xffffffff:
115 raise "bad sw_if_index"
Eyal Bari4bce2902017-01-16 12:02:46 +0200116
117 @classmethod
118 def add_shared_mcast_dst_load(cls):
119 cls.add_del_shared_mcast_dst_load(is_add=1)
120
121 @classmethod
122 def del_shared_mcast_dst_load(cls):
123 cls.add_del_shared_mcast_dst_load(is_add=0)
124
125 @classmethod
126 def add_del_mcast_tunnels_load(cls, is_add):
127 """
128 add or del tunnels to test vxlan stability
129 """
130 n_distinct_dst_tunnels = 200
Eyal Baric4aaee12016-12-20 18:36:46 +0200131 ip_range_start = 10
Eyal Bari4bce2902017-01-16 12:02:46 +0200132 ip_range_end = ip_range_start + n_distinct_dst_tunnels
Eyal Barid81da8c2017-01-11 13:39:54 +0200133 for dest_ip4n in ip4n_range(cls.mcast_ip4n, ip_range_start,
134 ip_range_end):
135 vni = bytearray(dest_ip4n)[3]
Eyal Baric4aaee12016-12-20 18:36:46 +0200136 cls.vapi.vxlan_add_del_tunnel(
137 src_addr=cls.pg0.local_ip4n,
Eyal Barid81da8c2017-01-11 13:39:54 +0200138 dst_addr=dest_ip4n,
Eyal Baric4aaee12016-12-20 18:36:46 +0200139 mcast_sw_if_index=1,
140 vni=vni,
141 is_add=is_add)
142
143 @classmethod
Eyal Bari4bce2902017-01-16 12:02:46 +0200144 def add_mcast_tunnels_load(cls):
145 cls.add_del_mcast_tunnels_load(is_add=1)
Eyal Baric4aaee12016-12-20 18:36:46 +0200146
147 @classmethod
Eyal Bari4bce2902017-01-16 12:02:46 +0200148 def del_mcast_tunnels_load(cls):
149 cls.add_del_mcast_tunnels_load(is_add=0)
Damjan Marionf56b77a2016-10-03 19:44:57 +0200150
Klement Sekeraf62ae122016-10-11 11:47:09 +0200151 # Class method to start the VXLAN test case.
Damjan Marionf56b77a2016-10-03 19:44:57 +0200152 # Overrides setUpClass method in VppTestCase class.
153 # Python try..except statement is used to ensure that the tear down of
154 # the class will be executed even if exception is raised.
155 # @param cls The class pointer.
156 @classmethod
157 def setUpClass(cls):
158 super(TestVxlan, cls).setUpClass()
Damjan Marionf56b77a2016-10-03 19:44:57 +0200159
Klement Sekeraf62ae122016-10-11 11:47:09 +0200160 try:
161 cls.dport = 4789
Matej Klottondeb69842016-12-09 15:05:46 +0100162 cls.flags = 0x8
Klement Sekeraf62ae122016-10-11 11:47:09 +0200163
164 # Create 2 pg interfaces.
Eyal Baric4aaee12016-12-20 18:36:46 +0200165 cls.create_pg_interfaces(range(4))
166 for pg in cls.pg_interfaces:
167 pg.admin_up()
Klement Sekeraf62ae122016-10-11 11:47:09 +0200168
169 # Configure IPv4 addresses on VPP pg0.
170 cls.pg0.config_ip4()
171
172 # Resolve MAC address for VPP's IP address on pg0.
173 cls.pg0.resolve_arp()
174
Eyal Baric4aaee12016-12-20 18:36:46 +0200175 # Our Multicast address
176 cls.mcast_ip4 = '239.1.1.1'
177 cls.mcast_ip4n = socket.inet_pton(socket.AF_INET, cls.mcast_ip4)
178 iplong = atol(cls.mcast_ip4)
Eyal Barid81da8c2017-01-11 13:39:54 +0200179 cls.mcast_mac = "01:00:5e:%02x:%02x:%02x" % (
Eyal Baric4aaee12016-12-20 18:36:46 +0200180 (iplong >> 16) & 0x7F, (iplong >> 8) & 0xFF, iplong & 0xFF)
181
Klement Sekeraf62ae122016-10-11 11:47:09 +0200182 # Create VXLAN VTEP on VPP pg0, and put vxlan_tunnel0 and pg1
Damjan Marionf56b77a2016-10-03 19:44:57 +0200183 # into BD.
Eyal Baric4aaee12016-12-20 18:36:46 +0200184 cls.single_tunnel_bd = 1
Klement Sekeraf62ae122016-10-11 11:47:09 +0200185 r = cls.vapi.vxlan_add_del_tunnel(
186 src_addr=cls.pg0.local_ip4n,
187 dst_addr=cls.pg0.remote_ip4n,
Eyal Baric4aaee12016-12-20 18:36:46 +0200188 vni=cls.single_tunnel_bd)
189 cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index,
190 bd_id=cls.single_tunnel_bd)
191 cls.vapi.sw_interface_set_l2_bridge(cls.pg1.sw_if_index,
192 bd_id=cls.single_tunnel_bd)
193
194 # Setup vni 2 to test multicast flooding
Eyal Barid81da8c2017-01-11 13:39:54 +0200195 cls.n_ucast_tunnels = 10
Eyal Baric4aaee12016-12-20 18:36:46 +0200196 cls.mcast_flood_bd = 2
Eyal Barid81da8c2017-01-11 13:39:54 +0200197 cls.create_vxlan_flood_test_bd(cls.mcast_flood_bd,
198 cls.n_ucast_tunnels)
Eyal Baric4aaee12016-12-20 18:36:46 +0200199 r = cls.vapi.vxlan_add_del_tunnel(
200 src_addr=cls.pg0.local_ip4n,
201 dst_addr=cls.mcast_ip4n,
202 mcast_sw_if_index=1,
203 vni=cls.mcast_flood_bd)
204 cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index,
205 bd_id=cls.mcast_flood_bd)
206 cls.vapi.sw_interface_set_l2_bridge(cls.pg2.sw_if_index,
207 bd_id=cls.mcast_flood_bd)
208
209 # Add and delete mcast tunnels to check stability
Eyal Bari4bce2902017-01-16 12:02:46 +0200210 cls.add_shared_mcast_dst_load()
211 cls.add_mcast_tunnels_load()
212 cls.del_shared_mcast_dst_load()
213 cls.del_mcast_tunnels_load()
Eyal Baric4aaee12016-12-20 18:36:46 +0200214
215 # Setup vni 3 to test unicast flooding
216 cls.ucast_flood_bd = 3
Eyal Barid81da8c2017-01-11 13:39:54 +0200217 cls.create_vxlan_flood_test_bd(cls.ucast_flood_bd,
218 cls.n_ucast_tunnels)
Eyal Baric4aaee12016-12-20 18:36:46 +0200219 cls.vapi.sw_interface_set_l2_bridge(cls.pg3.sw_if_index,
220 bd_id=cls.ucast_flood_bd)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200221 except Exception:
222 super(TestVxlan, cls).tearDownClass()
Damjan Marionf56b77a2016-10-03 19:44:57 +0200223 raise
224
Klement Sekeraf62ae122016-10-11 11:47:09 +0200225 # Method to define VPP actions before tear down of the test case.
Damjan Marionf56b77a2016-10-03 19:44:57 +0200226 # Overrides tearDown method in VppTestCase class.
227 # @param self The object pointer.
228 def tearDown(self):
229 super(TestVxlan, self).tearDown()
Klement Sekeraf62ae122016-10-11 11:47:09 +0200230 if not self.vpp_dead:
Klement Sekera7bb873a2016-11-18 07:38:42 +0100231 self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
Eyal Baric4aaee12016-12-20 18:36:46 +0200232 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 vxlan tunnel"))
Damjan Marionf56b77a2016-10-03 19:44:57 +0200235
Matej Klottondeb69842016-12-09 15:05:46 +0100236
Damjan Marionf56b77a2016-10-03 19:44:57 +0200237if __name__ == '__main__':
238 unittest.main(testRunner=VppTestRunner)