test/test_vxlan.py

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