src/plugins/gtpu/test/test_gtpu.py

   1 #!/usr/bin/env python3
   2
   3 import socket
   4 from util import ip4n_range, ip4_range
   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.inet6 import IPv6
  13 from scapy.contrib.gtp import GTP_U_Header
  14 from scapy.utils import atol
  15 from vpp_ip_route import VppIpRoute, VppRoutePath
  16 from vpp_ip import INVALID_INDEX
  17
  18
  19 class TestGtpuUDP(VppTestCase):
  20     """ GTPU UDP ports Test Case """
  21
  22     def setUp(self):
  23         super(TestGtpuUDP, self).setUp()
  24
  25         self.dport = 2152
  26
  27         self.ip4_err = 0
  28         self.ip6_err = 0
  29
  30         self.create_pg_interfaces(range(1))
  31         for pg in self.pg_interfaces:
  32             pg.admin_up()
  33         self.pg0.config_ip4()
  34         self.pg0.config_ip6()
  35
  36     def _check_udp_port_ip4(self, enabled=True):
  37
  38         pkt = (Ether(src=self.pg0.local_mac, dst=self.pg0.remote_mac) /
  39                IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
  40                UDP(sport=self.dport, dport=self.dport, chksum=0))
  41
  42         self.pg0.add_stream(pkt)
  43         self.pg_start()
  44
  45         err = self.statistics.get_counter(
  46             '/err/ip4-udp-lookup/no listener for dst port')[0]
  47
  48         if enabled:
  49             self.assertEqual(err, self.ip4_err)
  50         else:
  51             self.assertEqual(err, self.ip4_err + 1)
  52
  53         self.ip4_err = err
  54
  55     def _check_udp_port_ip6(self, enabled=True):
  56
  57         pkt = (Ether(src=self.pg0.local_mac, dst=self.pg0.remote_mac) /
  58                IPv6(src=self.pg0.remote_ip6, dst=self.pg0.local_ip6) /
  59                UDP(sport=self.dport, dport=self.dport, chksum=0))
  60
  61         self.pg0.add_stream(pkt)
  62         self.pg_start()
  63
  64         err = self.statistics.get_counter(
  65             '/err/ip6-udp-lookup/no listener for dst port')[0]
  66
  67         if enabled:
  68             self.assertEqual(err, self.ip6_err)
  69         else:
  70             self.assertEqual(err, self.ip6_err + 1)
  71
  72         self.ip6_err = err
  73
  74     def test_udp_port(self):
  75         """ test UDP ports
  76         Check if there are no udp listeners before gtpu is enabled
  77         """
  78         # UDP ports should be disabled unless a tunnel is configured
  79         self._check_udp_port_ip4(False)
  80         self._check_udp_port_ip6(False)
  81
  82         r = self.vapi.gtpu_add_del_tunnel(is_add=True,
  83                                           mcast_sw_if_index=0xFFFFFFFF,
  84                                           decap_next_index=0xFFFFFFFF,
  85                                           src_address=self.pg0.local_ip4,
  86                                           dst_address=self.pg0.remote_ip4)
  87
  88         # UDP port 2152 enabled for ip4
  89         self._check_udp_port_ip4()
  90
  91         r = self.vapi.gtpu_add_del_tunnel(is_add=True,
  92                                           mcast_sw_if_index=0xFFFFFFFF,
  93                                           decap_next_index=0xFFFFFFFF,
  94                                           src_address=self.pg0.local_ip6,
  95                                           dst_address=self.pg0.remote_ip6)
  96
  97         # UDP port 2152 enabled for ip6
  98         self._check_udp_port_ip6()
  99
 100         r = self.vapi.gtpu_add_del_tunnel(is_add=False,
 101                                           mcast_sw_if_index=0xFFFFFFFF,
 102                                           decap_next_index=0xFFFFFFFF,
 103                                           src_address=self.pg0.local_ip4,
 104                                           dst_address=self.pg0.remote_ip4)
 105
 106         r = self.vapi.gtpu_add_del_tunnel(is_add=False,
 107                                           mcast_sw_if_index=0xFFFFFFFF,
 108                                           decap_next_index=0xFFFFFFFF,
 109                                           src_address=self.pg0.local_ip6,
 110                                           dst_address=self.pg0.remote_ip6)
 111
 112
 113 class TestGtpu(BridgeDomain, VppTestCase):
 114     """ GTPU Test Case """
 115
 116     def __init__(self, *args):
 117         BridgeDomain.__init__(self)
 118         VppTestCase.__init__(self, *args)
 119
 120     def encapsulate(self, pkt, vni):
 121         """
 122         Encapsulate the original payload frame by adding GTPU header with its
 123         UDP, IP and Ethernet fields
 124         """
 125         return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
 126                 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
 127                 UDP(sport=self.dport, dport=self.dport, chksum=0) /
 128                 GTP_U_Header(teid=vni, gtp_type=self.gtp_type, length=150) /
 129                 pkt)
 130
 131     def ip_range(self, start, end):
 132         """ range of remote ip's """
 133         return ip4_range(self.pg0.remote_ip4, start, end)
 134
 135     def encap_mcast(self, pkt, src_ip, src_mac, vni):
 136         """
 137         Encapsulate the original payload frame by adding GTPU header with its
 138         UDP, IP and Ethernet fields
 139         """
 140         return (Ether(src=src_mac, dst=self.mcast_mac) /
 141                 IP(src=src_ip, dst=self.mcast_ip4) /
 142                 UDP(sport=self.dport, dport=self.dport, chksum=0) /
 143                 GTP_U_Header(teid=vni, gtp_type=self.gtp_type, length=150) /
 144                 pkt)
 145
 146     def decapsulate(self, pkt):
 147         """
 148         Decapsulate the original payload frame by removing GTPU header
 149         """
 150         return pkt[GTP_U_Header].payload
 151
 152     # Method for checking GTPU encapsulation.
 153     #
 154     def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
 155         # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
 156         #  by VPP using ARP.
 157         self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
 158         if not local_only:
 159             if not mcast_pkt:
 160                 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
 161             else:
 162                 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
 163         # Verify GTPU tunnel source IP is VPP_IP and destination IP is MY_IP.
 164         self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
 165         if not local_only:
 166             if not mcast_pkt:
 167                 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
 168             else:
 169                 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
 170         # Verify UDP destination port is GTPU 2152, source UDP port could be
 171         #  arbitrary.
 172         self.assertEqual(pkt[UDP].dport, type(self).dport)
 173         # Verify teid
 174         self.assertEqual(pkt[GTP_U_Header].teid, vni)
 175
 176     def test_encap(self):
 177         """ Encapsulation test
 178         Send frames from pg1
 179         Verify receipt of encapsulated frames on pg0
 180         """
 181         self.pg1.add_stream([self.frame_reply])
 182
 183         self.pg0.enable_capture()
 184
 185         self.pg_start()
 186
 187         # Pick first received frame and check if it's correctly encapsulated.
 188         out = self.pg0.get_capture(1)
 189         pkt = out[0]
 190         self.check_encapsulation(pkt, self.single_tunnel_bd)
 191
 192         # payload = self.decapsulate(pkt)
 193         # self.assert_eq_pkts(payload, self.frame_reply)
 194
 195     def test_ucast_flood(self):
 196         """ Unicast flood test
 197         Send frames from pg3
 198         Verify receipt of encapsulated frames on pg0
 199         """
 200         self.pg3.add_stream([self.frame_reply])
 201
 202         self.pg0.enable_capture()
 203
 204         self.pg_start()
 205
 206         # Get packet from each tunnel and assert it's correctly encapsulated.
 207         out = self.pg0.get_capture(self.n_ucast_tunnels)
 208         for pkt in out:
 209             self.check_encapsulation(pkt, self.ucast_flood_bd, True)
 210             # payload = self.decapsulate(pkt)
 211             # self.assert_eq_pkts(payload, self.frame_reply)
 212
 213     def test_mcast_flood(self):
 214         """ Multicast flood test
 215         Send frames from pg2
 216         Verify receipt of encapsulated frames on pg0
 217         """
 218         self.pg2.add_stream([self.frame_reply])
 219
 220         self.pg0.enable_capture()
 221
 222         self.pg_start()
 223
 224         # Pick first received frame and check if it's correctly encapsulated.
 225         out = self.pg0.get_capture(1)
 226         pkt = out[0]
 227         self.check_encapsulation(pkt, self.mcast_flood_bd,
 228                                  local_only=False, mcast_pkt=True)
 229
 230         # payload = self.decapsulate(pkt)
 231         # self.assert_eq_pkts(payload, self.frame_reply)
 232
 233     @classmethod
 234     def create_gtpu_flood_test_bd(cls, teid, n_ucast_tunnels):
 235         # Create 10 ucast gtpu tunnels under bd
 236         ip_range_start = 10
 237         ip_range_end = ip_range_start + n_ucast_tunnels
 238         next_hop_address = cls.pg0.remote_ip4
 239         for dest_ip4 in ip4_range(next_hop_address, ip_range_start,
 240                                   ip_range_end):
 241             # add host route so dest_ip4n will not be resolved
 242             rip = VppIpRoute(cls, dest_ip4, 32,
 243                              [VppRoutePath(next_hop_address,
 244                                            INVALID_INDEX)],
 245                              register=False)
 246             rip.add_vpp_config()
 247             r = cls.vapi.gtpu_add_del_tunnel(
 248                 is_add=True,
 249                 mcast_sw_if_index=0xFFFFFFFF,
 250                 decap_next_index=0xFFFFFFFF,
 251                 src_address=cls.pg0.local_ip4,
 252                 dst_address=dest_ip4,
 253                 teid=teid)
 254             cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
 255                                                 bd_id=teid)
 256
 257     @classmethod
 258     def add_del_shared_mcast_dst_load(cls, is_add):
 259         """
 260         add or del tunnels sharing the same mcast dst
 261         to test gtpu ref_count mechanism
 262         """
 263         n_shared_dst_tunnels = 20
 264         teid_start = 1000
 265         teid_end = teid_start + n_shared_dst_tunnels
 266         for teid in range(teid_start, teid_end):
 267             r = cls.vapi.gtpu_add_del_tunnel(
 268                 decap_next_index=0xFFFFFFFF,
 269                 src_address=cls.pg0.local_ip4,
 270                 dst_address=cls.mcast_ip4,
 271                 mcast_sw_if_index=1,
 272                 teid=teid,
 273                 is_add=is_add)
 274             if r.sw_if_index == 0xffffffff:
 275                 raise ValueError("bad sw_if_index: ~0")
 276
 277     @classmethod
 278     def add_shared_mcast_dst_load(cls):
 279         cls.add_del_shared_mcast_dst_load(is_add=1)
 280
 281     @classmethod
 282     def del_shared_mcast_dst_load(cls):
 283         cls.add_del_shared_mcast_dst_load(is_add=0)
 284
 285     @classmethod
 286     def add_del_mcast_tunnels_load(cls, is_add):
 287         """
 288         add or del tunnels to test gtpu stability
 289         """
 290         n_distinct_dst_tunnels = 20
 291         ip_range_start = 10
 292         ip_range_end = ip_range_start + n_distinct_dst_tunnels
 293         for dest_ip4 in ip4_range(cls.mcast_ip4, ip_range_start,
 294                                   ip_range_end):
 295             teid = int(dest_ip4.split('.')[3])
 296             cls.vapi.gtpu_add_del_tunnel(
 297                 decap_next_index=0xFFFFFFFF,
 298                 src_address=cls.pg0.local_ip4,
 299                 dst_address=dest_ip4,
 300                 mcast_sw_if_index=1,
 301                 teid=teid,
 302                 is_add=is_add)
 303
 304     @classmethod
 305     def add_mcast_tunnels_load(cls):
 306         cls.add_del_mcast_tunnels_load(is_add=1)
 307
 308     @classmethod
 309     def del_mcast_tunnels_load(cls):
 310         cls.add_del_mcast_tunnels_load(is_add=0)
 311
 312     # Class method to start the GTPU test case.
 313     #  Overrides setUpClass method in VppTestCase class.
 314     #  Python try..except statement is used to ensure that the tear down of
 315     #  the class will be executed even if exception is raised.
 316     #  @param cls The class pointer.
 317     @classmethod
 318     def setUpClass(cls):
 319         super(TestGtpu, cls).setUpClass()
 320
 321         try:
 322             cls.dport = 2152
 323             cls.gtp_type = 0xff
 324
 325             # Create 2 pg interfaces.
 326             cls.create_pg_interfaces(range(4))
 327             for pg in cls.pg_interfaces:
 328                 pg.admin_up()
 329
 330             # Configure IPv4 addresses on VPP pg0.
 331             cls.pg0.config_ip4()
 332
 333             # Resolve MAC address for VPP's IP address on pg0.
 334             cls.pg0.resolve_arp()
 335
 336             # Our Multicast address
 337             cls.mcast_ip4 = '239.1.1.1'
 338             cls.mcast_ip4n = socket.inet_pton(socket.AF_INET, cls.mcast_ip4)
 339             iplong = atol(cls.mcast_ip4)
 340             cls.mcast_mac = "01:00:5e:%02x:%02x:%02x" % (
 341                 (iplong >> 16) & 0x7F, (iplong >> 8) & 0xFF, iplong & 0xFF)
 342
 343             # Create GTPU VTEP on VPP pg0, and put gtpu_tunnel0 and pg1
 344             #  into BD.
 345             cls.single_tunnel_bd = 11
 346             r = cls.vapi.gtpu_add_del_tunnel(
 347                 is_add=True,
 348                 mcast_sw_if_index=0xFFFFFFFF,
 349                 decap_next_index=0xFFFFFFFF,
 350                 src_address=cls.pg0.local_ip4,
 351                 dst_address=cls.pg0.remote_ip4,
 352                 teid=cls.single_tunnel_bd)
 353             cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
 354                                                 bd_id=cls.single_tunnel_bd)
 355             cls.vapi.sw_interface_set_l2_bridge(
 356                 rx_sw_if_index=cls.pg1.sw_if_index, bd_id=cls.single_tunnel_bd)
 357
 358             # Setup teid 2 to test multicast flooding
 359             cls.n_ucast_tunnels = 10
 360             cls.mcast_flood_bd = 12
 361             cls.create_gtpu_flood_test_bd(cls.mcast_flood_bd,
 362                                           cls.n_ucast_tunnels)
 363             r = cls.vapi.gtpu_add_del_tunnel(
 364                 is_add=True,
 365                 src_address=cls.pg0.local_ip4,
 366                 dst_address=cls.mcast_ip4,
 367                 mcast_sw_if_index=1,
 368                 decap_next_index=0xFFFFFFFF,
 369                 teid=cls.mcast_flood_bd)
 370             cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
 371                                                 bd_id=cls.mcast_flood_bd)
 372             cls.vapi.sw_interface_set_l2_bridge(
 373                 rx_sw_if_index=cls.pg2.sw_if_index, bd_id=cls.mcast_flood_bd)
 374
 375             # Add and delete mcast tunnels to check stability
 376             cls.add_shared_mcast_dst_load()
 377             cls.add_mcast_tunnels_load()
 378             cls.del_shared_mcast_dst_load()
 379             cls.del_mcast_tunnels_load()
 380
 381             # Setup teid 3 to test unicast flooding
 382             cls.ucast_flood_bd = 13
 383             cls.create_gtpu_flood_test_bd(cls.ucast_flood_bd,
 384                                           cls.n_ucast_tunnels)
 385             cls.vapi.sw_interface_set_l2_bridge(
 386                 rx_sw_if_index=cls.pg3.sw_if_index, bd_id=cls.ucast_flood_bd)
 387         except Exception:
 388             super(TestGtpu, cls).tearDownClass()
 389             raise
 390
 391     @classmethod
 392     def tearDownClass(cls):
 393         super(TestGtpu, cls).tearDownClass()
 394
 395     # Method to define VPP actions before tear down of the test case.
 396     #  Overrides tearDown method in VppTestCase class.
 397     #  @param self The object pointer.
 398     def tearDown(self):
 399         super(TestGtpu, self).tearDown()
 400
 401     def show_commands_at_teardown(self):
 402         self.logger.info(self.vapi.cli("show bridge-domain 11 detail"))
 403         self.logger.info(self.vapi.cli("show bridge-domain 12 detail"))
 404         self.logger.info(self.vapi.cli("show bridge-domain 13 detail"))
 405         self.logger.info(self.vapi.cli("show int"))
 406         self.logger.info(self.vapi.cli("show gtpu tunnel"))
 407         self.logger.info(self.vapi.cli("show trace"))
 408
 409
 410 if __name__ == '__main__':
 411     unittest.main(testRunner=VppTestRunner)