test/test_vxlan.py

   1 #!/usr/bin/env python3
   2
   3 import socket
   4 from util import ip4_range, reassemble4
   5 import unittest
   6 from framework import VppTestCase, VppTestRunner
   7 from template_bd import BridgeDomain
   8
   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
  14 import util
  15 from vpp_ip_route import VppIpRoute, VppRoutePath
  16 from vpp_vxlan_tunnel import VppVxlanTunnel
  17 from vpp_ip import INVALID_INDEX
  18
  19
  20 class TestVxlan(BridgeDomain, VppTestCase):
  21     """ VXLAN Test Case """
  22
  23     def __init__(self, *args):
  24         BridgeDomain.__init__(self)
  25         VppTestCase.__init__(self, *args)
  26
  27     def encapsulate(self, pkt, vni):
  28         """
  29         Encapsulate the original payload frame by adding VXLAN header with its
  30         UDP, IP and Ethernet fields
  31         """
  32         return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
  33                 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
  34                 UDP(sport=self.dport, dport=self.dport, chksum=0) /
  35                 VXLAN(vni=vni, flags=self.flags) /
  36                 pkt)
  37
  38     def ip_range(self, start, end):
  39         """ range of remote ip's """
  40         return ip4_range(self.pg0.remote_ip4, start, end)
  41
  42     def encap_mcast(self, pkt, src_ip, src_mac, vni):
  43         """
  44         Encapsulate the original payload frame by adding VXLAN header with its
  45         UDP, IP and Ethernet fields
  46         """
  47         return (Ether(src=src_mac, dst=self.mcast_mac) /
  48                 IP(src=src_ip, dst=self.mcast_ip4) /
  49                 UDP(sport=self.dport, dport=self.dport, chksum=0) /
  50                 VXLAN(vni=vni, flags=self.flags) /
  51                 pkt)
  52
  53     def decapsulate(self, pkt):
  54         """
  55         Decapsulate the original payload frame by removing VXLAN header
  56         """
  57         # check if is set I flag
  58         self.assertEqual(pkt[VXLAN].flags, int('0x8', 16))
  59         return pkt[VXLAN].payload
  60
  61     # Method for checking VXLAN encapsulation.
  62     #
  63     def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
  64         # TODO: add error messages
  65         # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
  66         #  by VPP using ARP.
  67         self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
  68         if not local_only:
  69             if not mcast_pkt:
  70                 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
  71             else:
  72                 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
  73         # Verify VXLAN tunnel source IP is VPP_IP and destination IP is MY_IP.
  74         self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
  75         if not local_only:
  76             if not mcast_pkt:
  77                 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
  78             else:
  79                 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
  80         # Verify UDP destination port is VXLAN 4789, source UDP port could be
  81         #  arbitrary.
  82         self.assertEqual(pkt[UDP].dport, type(self).dport)
  83         # Verify UDP checksum
  84         self.assert_udp_checksum_valid(pkt)
  85         # Verify VNI
  86         self.assertEqual(pkt[VXLAN].vni, vni)
  87
  88     @classmethod
  89     def create_vxlan_flood_test_bd(cls, vni, n_ucast_tunnels):
  90         # Create 10 ucast vxlan tunnels under bd
  91         ip_range_start = 10
  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,
  95                                   ip_range_end):
  96             # add host route so dest_ip4 will not be resolved
  97             rip = VppIpRoute(cls, dest_ip4, 32,
  98                              [VppRoutePath(next_hop_address,
  99                                            INVALID_INDEX)],
 100                              register=False)
 101             rip.add_vpp_config()
 102
 103             r = VppVxlanTunnel(cls, src=cls.pg0.local_ip4,
 104                                dst=dest_ip4, vni=vni)
 105             r.add_vpp_config()
 106             cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index, bd_id=vni)
 107
 108     @classmethod
 109     def add_del_shared_mcast_dst_load(cls, is_add):
 110         """
 111         add or del tunnels sharing the same mcast dst
 112         to test vxlan ref_count mechanism
 113         """
 114         n_shared_dst_tunnels = 20
 115         vni_start = 10000
 116         vni_end = vni_start + n_shared_dst_tunnels
 117         for vni in range(vni_start, vni_end):
 118             r = VppVxlanTunnel(cls, src=cls.pg0.local_ip4,
 119                                dst=cls.mcast_ip4, mcast_sw_if_index=1, vni=vni)
 120             if is_add:
 121                 r.add_vpp_config()
 122                 if r.sw_if_index == 0xffffffff:
 123                     raise ValueError("bad sw_if_index: ~0")
 124             else:
 125                 r.remove_vpp_config()
 126
 127     @classmethod
 128     def add_shared_mcast_dst_load(cls):
 129         cls.add_del_shared_mcast_dst_load(is_add=1)
 130
 131     @classmethod
 132     def del_shared_mcast_dst_load(cls):
 133         cls.add_del_shared_mcast_dst_load(is_add=0)
 134
 135     @classmethod
 136     def add_del_mcast_tunnels_load(cls, is_add):
 137         """
 138         add or del tunnels to test vxlan stability
 139         """
 140         n_distinct_dst_tunnels = 200
 141         ip_range_start = 10
 142         ip_range_end = ip_range_start + n_distinct_dst_tunnels
 143         for dest_ip4 in ip4_range(cls.mcast_ip4, ip_range_start,
 144                                   ip_range_end):
 145             vni = bytearray(socket.inet_pton(socket.AF_INET, dest_ip4))[3]
 146             r = VppVxlanTunnel(cls, src=cls.pg0.local_ip4,
 147                                dst=dest_ip4, mcast_sw_if_index=1, vni=vni)
 148             if is_add:
 149                 r.add_vpp_config()
 150             else:
 151                 r.remove_vpp_config()
 152
 153     @classmethod
 154     def add_mcast_tunnels_load(cls):
 155         cls.add_del_mcast_tunnels_load(is_add=1)
 156
 157     @classmethod
 158     def del_mcast_tunnels_load(cls):
 159         cls.add_del_mcast_tunnels_load(is_add=0)
 160
 161     # Class method to start the VXLAN test case.
 162     #  Overrides setUpClass method in VppTestCase class.
 163     #  Python try..except statement is used to ensure that the tear down of
 164     #  the class will be executed even if exception is raised.
 165     #  @param cls The class pointer.
 166     @classmethod
 167     def setUpClass(cls):
 168         super(TestVxlan, cls).setUpClass()
 169
 170         try:
 171             cls.dport = 4789
 172             cls.flags = 0x8
 173
 174             # Create 2 pg interfaces.
 175             cls.create_pg_interfaces(range(4))
 176             for pg in cls.pg_interfaces:
 177                 pg.admin_up()
 178
 179             # Configure IPv4 addresses on VPP pg0.
 180             cls.pg0.config_ip4()
 181
 182             # Resolve MAC address for VPP's IP address on pg0.
 183             cls.pg0.resolve_arp()
 184
 185             # Our Multicast address
 186             cls.mcast_ip4 = '239.1.1.1'
 187             cls.mcast_mac = util.mcast_ip_to_mac(cls.mcast_ip4)
 188         except Exception:
 189             cls.tearDownClass()
 190             raise
 191
 192     @classmethod
 193     def tearDownClass(cls):
 194         super(TestVxlan, cls).tearDownClass()
 195
 196     def setUp(self):
 197         super(TestVxlan, self).setUp()
 198         # Create VXLAN VTEP on VPP pg0, and put vxlan_tunnel0 and pg1
 199         #  into BD.
 200         self.single_tunnel_vni = 0x12345
 201         self.single_tunnel_bd = 1
 202         r = VppVxlanTunnel(self, src=self.pg0.local_ip4,
 203                            dst=self.pg0.remote_ip4,
 204                            vni=self.single_tunnel_vni)
 205         r.add_vpp_config()
 206         self.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
 207                                              bd_id=self.single_tunnel_bd)
 208         self.vapi.sw_interface_set_l2_bridge(
 209             rx_sw_if_index=self.pg1.sw_if_index, bd_id=self.single_tunnel_bd)
 210
 211         # Setup vni 2 to test multicast flooding
 212         self.n_ucast_tunnels = 10
 213         self.mcast_flood_bd = 2
 214         self.create_vxlan_flood_test_bd(self.mcast_flood_bd,
 215                                         self.n_ucast_tunnels)
 216         r = VppVxlanTunnel(self, src=self.pg0.local_ip4, dst=self.mcast_ip4,
 217                            mcast_sw_if_index=1, vni=self.mcast_flood_bd)
 218         r.add_vpp_config()
 219         self.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
 220                                              bd_id=self.mcast_flood_bd)
 221         self.vapi.sw_interface_set_l2_bridge(
 222             rx_sw_if_index=self.pg2.sw_if_index, bd_id=self.mcast_flood_bd)
 223
 224         # Add and delete mcast tunnels to check stability
 225         self.add_shared_mcast_dst_load()
 226         self.add_mcast_tunnels_load()
 227         self.del_shared_mcast_dst_load()
 228         self.del_mcast_tunnels_load()
 229
 230         # Setup vni 3 to test unicast flooding
 231         self.ucast_flood_bd = 3
 232         self.create_vxlan_flood_test_bd(self.ucast_flood_bd,
 233                                         self.n_ucast_tunnels)
 234         self.vapi.sw_interface_set_l2_bridge(
 235             rx_sw_if_index=self.pg3.sw_if_index, bd_id=self.ucast_flood_bd)
 236
 237     def test_decap(self):
 238         """ Decapsulation test
 239         from BridgeDoman
 240         """
 241         super(TestVxlan, self).test_decap()
 242
 243     def test_encap_big_packet(self):
 244         """ Encapsulation test send big frame from pg1
 245         Verify receipt of encapsulated frames on pg0
 246         """
 247
 248         self.vapi.sw_interface_set_mtu(self.pg0.sw_if_index, [1500, 0, 0, 0])
 249
 250         frame = (Ether(src='00:00:00:00:00:02', dst='00:00:00:00:00:01') /
 251                  IP(src='4.3.2.1', dst='1.2.3.4') /
 252                  UDP(sport=20000, dport=10000) /
 253                  Raw(b'\xa5' * 1450))
 254
 255         self.pg1.add_stream([frame])
 256
 257         self.pg0.enable_capture()
 258
 259         self.pg_start()
 260
 261         # Pick first received frame and check if it's correctly encapsulated.
 262         out = self.pg0.get_capture(2)
 263         ether = out[0]
 264         pkt = reassemble4(out)
 265         pkt = ether / pkt
 266         self.check_encapsulation(pkt, self.single_tunnel_vni)
 267
 268         payload = self.decapsulate(pkt)
 269         # TODO: Scapy bug?
 270         # self.assert_eq_pkts(payload, frame)
 271
 272     # Method to define VPP actions before tear down of the test case.
 273     #  Overrides tearDown method in VppTestCase class.
 274     #  @param self The object pointer.
 275     def tearDown(self):
 276         super(TestVxlan, self).tearDown()
 277
 278     def show_commands_at_teardown(self):
 279         self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
 280         self.logger.info(self.vapi.cli("show bridge-domain 2 detail"))
 281         self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
 282         self.logger.info(self.vapi.cli("show vxlan tunnel"))
 283
 284
 285 class TestVxlan2(VppTestCase):
 286     """ VXLAN Test Case """
 287     def setUp(self):
 288         super(TestVxlan2, self).setUp()
 289
 290         # Create 2 pg interfaces.
 291         self.create_pg_interfaces(range(4))
 292         for pg in self.pg_interfaces:
 293             pg.admin_up()
 294
 295         # Configure IPv4 addresses on VPP pg0.
 296         self.pg0.config_ip4()
 297         self.pg0.resolve_arp()
 298
 299     def tearDown(self):
 300         super(TestVxlan2, self).tearDown()
 301
 302     def test_xconnect(self):
 303         """ VXLAN source address not local """
 304
 305         #
 306         # test the broken configuration of a VXLAN tunnel whose
 307         # source address is not local ot the box. packets sent
 308         # through the tunnel should be dropped
 309         #
 310         t = VppVxlanTunnel(self,
 311                            src="10.0.0.5",
 312                            dst=self.pg0.local_ip4,
 313                            vni=1000)
 314         t.add_vpp_config()
 315         t.admin_up()
 316
 317         self.vapi.sw_interface_set_l2_xconnect(t.sw_if_index,
 318                                                self.pg1.sw_if_index,
 319                                                enable=1)
 320         self.vapi.sw_interface_set_l2_xconnect(self.pg1.sw_if_index,
 321                                                t.sw_if_index,
 322                                                enable=1)
 323
 324         p = (Ether(src="00:11:22:33:44:55",
 325                    dst="00:00:00:11:22:33") /
 326              IP(src="4.3.2.1", dst="1.2.3.4") /
 327              UDP(sport=20000, dport=10000) /
 328              Raw(b'\xa5' * 1450))
 329
 330         rx = self.send_and_assert_no_replies(self.pg1, [p])
 331
 332
 333 if __name__ == '__main__':
 334     unittest.main(testRunner=VppTestRunner)