4 from util import ip4n_range, ip4_range
6 from framework import VppTestCase, VppTestRunner
7 from template_bd import BridgeDomain
9 from scapy.layers.l2 import Ether
10 from scapy.layers.inet import IP, UDP
11 from scapy.layers.geneve import GENEVE
12 from scapy.utils import atol
15 class TestGeneve(BridgeDomain, VppTestCase):
16 """ GENEVE Test Case """
18 def __init__(self, *args):
19 BridgeDomain.__init__(self)
20 VppTestCase.__init__(self, *args)
22 def encapsulate(self, pkt, vni):
25 Encapsulate the original payload frame by adding GENEVE header with its
26 UDP, IP and Ethernet fields
28 return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
29 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
30 UDP(sport=self.dport, dport=self.dport, chksum=0) /
34 def ip_range(self, start, end):
35 """ range of remote ip's """
36 return ip4_range(self.pg0.remote_ip4, start, end)
38 def encap_mcast(self, pkt, src_ip, src_mac, vni):
40 Encapsulate the original payload frame by adding GENEVE header with its
41 UDP, IP and Ethernet fields
43 return (Ether(src=src_mac, dst=self.mcast_mac) /
44 IP(src=src_ip, dst=self.mcast_ip4) /
45 UDP(sport=self.dport, dport=self.dport, chksum=0) /
49 def decapsulate(self, pkt):
51 Decapsulate the original payload frame by removing GENEVE header
53 # check if is set I flag
54 # self.assertEqual(pkt[GENEVE].flags, int('0x8', 16))
55 return pkt[GENEVE].payload
57 # Method for checking GENEVE encapsulation.
59 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
60 # TODO: add error messages
61 # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
63 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
66 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
68 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
69 # Verify GENEVE tunnel source IP is VPP_IP and destination IP is MY_IP.
70 self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
73 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
75 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
76 # Verify UDP destination port is GENEVE 4789, source UDP port could be
78 self.assertEqual(pkt[UDP].dport, type(self).dport)
79 # TODO: checksum check
81 self.assertEqual(pkt[GENEVE].vni, vni)
84 def create_geneve_flood_test_bd(cls, vni, n_ucast_tunnels):
85 # Create 10 ucast geneve tunnels under bd
87 ip_range_end = ip_range_start + n_ucast_tunnels
88 next_hop_address = cls.pg0.remote_ip4n
89 for dest_ip4n in ip4n_range(next_hop_address, ip_range_start,
91 # add host route so dest_ip4n will not be resolved
92 cls.vapi.ip_add_del_route(dst_address=dest_ip4n,
93 dst_address_length=32,
94 next_hop_address=next_hop_address)
95 r = cls.vapi.geneve_add_del_tunnel(
96 local_address=cls.pg0.local_ip4n, remote_address=dest_ip4n,
98 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
102 def add_del_shared_mcast_dst_load(cls, is_add):
104 add or del tunnels sharing the same mcast dst
105 to test geneve ref_count mechanism
107 n_shared_dst_tunnels = 10
109 vni_end = vni_start + n_shared_dst_tunnels
110 for vni in range(vni_start, vni_end):
111 r = cls.vapi.geneve_add_del_tunnel(
112 local_address=cls.pg0.local_ip4n,
113 remote_address=cls.mcast_ip4n, mcast_sw_if_index=1,
114 is_add=is_add, vni=vni)
115 if r.sw_if_index == 0xffffffff:
116 raise ValueError("bad sw_if_index: ~0")
119 def add_shared_mcast_dst_load(cls):
120 cls.add_del_shared_mcast_dst_load(is_add=1)
123 def del_shared_mcast_dst_load(cls):
124 cls.add_del_shared_mcast_dst_load(is_add=0)
127 def add_del_mcast_tunnels_load(cls, is_add):
129 add or del tunnels to test geneve stability
131 n_distinct_dst_tunnels = 10
133 ip_range_end = ip_range_start + n_distinct_dst_tunnels
134 for dest_ip4n in ip4n_range(cls.mcast_ip4n, ip_range_start,
136 vni = bytearray(dest_ip4n)[3]
137 cls.vapi.geneve_add_del_tunnel(local_address=cls.pg0.local_ip4n,
138 remote_address=dest_ip4n,
139 mcast_sw_if_index=1, is_add=is_add,
143 def add_mcast_tunnels_load(cls):
144 cls.add_del_mcast_tunnels_load(is_add=1)
147 def del_mcast_tunnels_load(cls):
148 cls.add_del_mcast_tunnels_load(is_add=0)
150 # Class method to start the GENEVE test case.
151 # Overrides setUpClass method in VppTestCase class.
152 # Python try..except statement is used to ensure that the tear down of
153 # the class will be executed even if exception is raised.
154 # @param cls The class pointer.
157 super(TestGeneve, cls).setUpClass()
162 # Create 2 pg interfaces.
163 cls.create_pg_interfaces(range(4))
164 for pg in cls.pg_interfaces:
167 # Configure IPv4 addresses on VPP pg0.
170 # Resolve MAC address for VPP's IP address on pg0.
171 cls.pg0.resolve_arp()
173 # Our Multicast address
174 cls.mcast_ip4 = '239.1.1.1'
175 cls.mcast_ip4n = socket.inet_pton(socket.AF_INET, cls.mcast_ip4)
176 iplong = atol(cls.mcast_ip4)
177 cls.mcast_mac = "01:00:5e:%02x:%02x:%02x" % (
178 (iplong >> 16) & 0x7F, (iplong >> 8) & 0xFF, iplong & 0xFF)
180 # Create GENEVE VTEP on VPP pg0, and put geneve_tunnel0 and pg1
182 cls.single_tunnel_bd = 1
183 r = cls.vapi.geneve_add_del_tunnel(
184 local_address=cls.pg0.local_ip4n,
185 remote_address=cls.pg0.remote_ip4n, vni=cls.single_tunnel_bd)
186 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
187 bd_id=cls.single_tunnel_bd)
188 cls.vapi.sw_interface_set_l2_bridge(
189 rx_sw_if_index=cls.pg1.sw_if_index, bd_id=cls.single_tunnel_bd)
191 # Setup vni 2 to test multicast flooding
192 cls.n_ucast_tunnels = 10
193 cls.mcast_flood_bd = 2
194 cls.create_geneve_flood_test_bd(cls.mcast_flood_bd,
196 r = cls.vapi.geneve_add_del_tunnel(
197 local_address=cls.pg0.local_ip4n,
198 remote_address=cls.mcast_ip4n, mcast_sw_if_index=1,
199 vni=cls.mcast_flood_bd)
200 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
201 bd_id=cls.mcast_flood_bd)
202 cls.vapi.sw_interface_set_l2_bridge(
203 rx_sw_if_index=cls.pg2.sw_if_index, bd_id=cls.mcast_flood_bd)
205 # Add and delete mcast tunnels to check stability
206 cls.add_shared_mcast_dst_load()
207 cls.add_mcast_tunnels_load()
208 cls.del_shared_mcast_dst_load()
209 cls.del_mcast_tunnels_load()
211 # Setup vni 3 to test unicast flooding
212 cls.ucast_flood_bd = 3
213 cls.create_geneve_flood_test_bd(cls.ucast_flood_bd,
215 cls.vapi.sw_interface_set_l2_bridge(
216 rx_sw_if_index=cls.pg3.sw_if_index, bd_id=cls.ucast_flood_bd)
218 super(TestGeneve, cls).tearDownClass()
221 # Method to define VPP actions before tear down of the test case.
222 # Overrides tearDown method in VppTestCase class.
223 # @param self The object pointer.
225 super(TestGeneve, self).tearDown()
226 if not self.vpp_dead:
227 self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
228 self.logger.info(self.vapi.cli("show bridge-domain 2 detail"))
229 self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
230 self.logger.info(self.vapi.cli("show geneve tunnel"))
233 if __name__ == '__main__':
234 unittest.main(testRunner=VppTestRunner)