3 from util import ip4_range
5 from framework import VppTestCase
6 from asfframework import VppTestRunner, tag_fixme_vpp_workers
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.inet6 import IPv6
12 from scapy.contrib.gtp import GTP_U_Header
15 from vpp_ip_route import VppIpRoute, VppRoutePath
16 from vpp_ip import INVALID_INDEX
19 @tag_fixme_vpp_workers
20 class TestGtpuUDP(VppTestCase):
21 """GTPU UDP ports Test Case"""
24 super(TestGtpuUDP, self).setUp()
31 self.create_pg_interfaces(range(1))
32 for pg in self.pg_interfaces:
37 def _check_udp_port_ip4(self, enabled=True):
39 Ether(src=self.pg0.local_mac, dst=self.pg0.remote_mac)
40 / IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4)
41 / UDP(sport=self.dport, dport=self.dport, chksum=0)
44 self.pg0.add_stream(pkt)
47 err = self.statistics.get_counter("/err/ip4-udp-lookup/no_listener")[0]
50 self.assertEqual(err, self.ip4_err)
52 self.assertEqual(err, self.ip4_err + 1)
56 def _check_udp_port_ip6(self, enabled=True):
58 Ether(src=self.pg0.local_mac, dst=self.pg0.remote_mac)
59 / IPv6(src=self.pg0.remote_ip6, dst=self.pg0.local_ip6)
60 / UDP(sport=self.dport, dport=self.dport, chksum=0)
63 self.pg0.add_stream(pkt)
66 err = self.statistics.get_counter("/err/ip6-udp-lookup/no_listener")[0]
69 self.assertEqual(err, self.ip6_err)
71 self.assertEqual(err, self.ip6_err + 1)
75 def test_udp_port(self):
77 Check if there are no udp listeners before gtpu is enabled
79 # UDP ports should be disabled unless a tunnel is configured
80 self._check_udp_port_ip4(False)
81 self._check_udp_port_ip6(False)
83 r = self.vapi.gtpu_add_del_tunnel(
85 mcast_sw_if_index=0xFFFFFFFF,
86 decap_next_index=0xFFFFFFFF,
87 src_address=self.pg0.local_ip4,
88 dst_address=self.pg0.remote_ip4,
91 # UDP port 2152 enabled for ip4
92 self._check_udp_port_ip4()
94 r = self.vapi.gtpu_add_del_tunnel(
96 mcast_sw_if_index=0xFFFFFFFF,
97 decap_next_index=0xFFFFFFFF,
98 src_address=self.pg0.local_ip6,
99 dst_address=self.pg0.remote_ip6,
102 # UDP port 2152 enabled for ip6
103 self._check_udp_port_ip6()
105 r = self.vapi.gtpu_add_del_tunnel(
107 mcast_sw_if_index=0xFFFFFFFF,
108 decap_next_index=0xFFFFFFFF,
109 src_address=self.pg0.local_ip4,
110 dst_address=self.pg0.remote_ip4,
113 r = self.vapi.gtpu_add_del_tunnel(
115 mcast_sw_if_index=0xFFFFFFFF,
116 decap_next_index=0xFFFFFFFF,
117 src_address=self.pg0.local_ip6,
118 dst_address=self.pg0.remote_ip6,
122 class TestGtpu(BridgeDomain, VppTestCase):
125 def __init__(self, *args):
126 BridgeDomain.__init__(self)
127 VppTestCase.__init__(self, *args)
129 def encapsulate(self, pkt, vni):
131 Encapsulate the original payload frame by adding GTPU header with its
132 UDP, IP and Ethernet fields
135 Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac)
136 / IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4)
137 / UDP(sport=self.dport, dport=self.dport, chksum=0)
138 / GTP_U_Header(teid=vni, gtp_type=self.gtp_type, length=150)
142 def ip_range(self, start, end):
143 """range of remote ip's"""
144 return ip4_range(self.pg0.remote_ip4, start, end)
146 def encap_mcast(self, pkt, src_ip, src_mac, vni):
148 Encapsulate the original payload frame by adding GTPU header with its
149 UDP, IP and Ethernet fields
152 Ether(src=src_mac, dst=self.mcast_mac)
153 / IP(src=src_ip, dst=self.mcast_ip4)
154 / UDP(sport=self.dport, dport=self.dport, chksum=0)
155 / GTP_U_Header(teid=vni, gtp_type=self.gtp_type, length=150)
159 def decapsulate(self, pkt):
161 Decapsulate the original payload frame by removing GTPU header
163 return pkt[GTP_U_Header].payload
165 # Method for checking GTPU encapsulation.
167 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
168 # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
170 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
173 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
175 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
176 # Verify GTPU tunnel source IP is VPP_IP and destination IP is MY_IP.
177 self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
180 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
182 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
183 # Verify UDP destination port is GTPU 2152, source UDP port could be
185 self.assertEqual(pkt[UDP].dport, type(self).dport)
187 self.assertEqual(pkt[GTP_U_Header].teid, vni)
189 def test_encap(self):
190 """Encapsulation test
192 Verify receipt of encapsulated frames on pg0
194 self.pg1.add_stream([self.frame_reply])
196 self.pg0.enable_capture()
200 # Pick first received frame and check if it's correctly encapsulated.
201 out = self.pg0.get_capture(1)
203 self.check_encapsulation(pkt, self.single_tunnel_vni)
205 # payload = self.decapsulate(pkt)
206 # self.assert_eq_pkts(payload, self.frame_reply)
208 def test_ucast_flood(self):
209 """Unicast flood test
211 Verify receipt of encapsulated frames on pg0
213 self.pg3.add_stream([self.frame_reply])
215 self.pg0.enable_capture()
219 # Get packet from each tunnel and assert it's correctly encapsulated.
220 out = self.pg0.get_capture(self.n_ucast_tunnels)
222 self.check_encapsulation(pkt, self.ucast_flood_bd, True)
223 # payload = self.decapsulate(pkt)
224 # self.assert_eq_pkts(payload, self.frame_reply)
226 def test_mcast_flood(self):
227 """Multicast flood test
229 Verify receipt of encapsulated frames on pg0
231 self.pg2.add_stream([self.frame_reply])
233 self.pg0.enable_capture()
237 # Pick first received frame and check if it's correctly encapsulated.
238 out = self.pg0.get_capture(1)
240 self.check_encapsulation(
241 pkt, self.mcast_flood_bd, local_only=False, mcast_pkt=True
244 # payload = self.decapsulate(pkt)
245 # self.assert_eq_pkts(payload, self.frame_reply)
248 def create_gtpu_flood_test_bd(cls, teid, n_ucast_tunnels):
249 # Create 10 ucast gtpu tunnels under bd
251 ip_range_end = ip_range_start + n_ucast_tunnels
252 next_hop_address = cls.pg0.remote_ip4
253 for dest_ip4 in ip4_range(next_hop_address, ip_range_start, ip_range_end):
254 # add host route so dest_ip4 will not be resolved
259 [VppRoutePath(next_hop_address, INVALID_INDEX)],
263 r = cls.vapi.gtpu_add_del_tunnel(
265 mcast_sw_if_index=0xFFFFFFFF,
266 decap_next_index=0xFFFFFFFF,
267 src_address=cls.pg0.local_ip4,
268 dst_address=dest_ip4,
271 cls.vapi.sw_interface_set_l2_bridge(
272 rx_sw_if_index=r.sw_if_index, bd_id=teid
276 def add_del_shared_mcast_dst_load(cls, is_add):
278 add or del tunnels sharing the same mcast dst
279 to test gtpu ref_count mechanism
281 n_shared_dst_tunnels = 20
283 teid_end = teid_start + n_shared_dst_tunnels
284 for teid in range(teid_start, teid_end):
285 r = cls.vapi.gtpu_add_del_tunnel(
286 decap_next_index=0xFFFFFFFF,
287 src_address=cls.pg0.local_ip4,
288 dst_address=cls.mcast_ip4,
293 if r.sw_if_index == 0xFFFFFFFF:
294 raise ValueError("bad sw_if_index: ~0")
297 def add_shared_mcast_dst_load(cls):
298 cls.add_del_shared_mcast_dst_load(is_add=1)
301 def del_shared_mcast_dst_load(cls):
302 cls.add_del_shared_mcast_dst_load(is_add=0)
305 def add_del_mcast_tunnels_load(cls, is_add):
307 add or del tunnels to test gtpu stability
309 n_distinct_dst_tunnels = 20
311 ip_range_end = ip_range_start + n_distinct_dst_tunnels
312 for dest_ip4 in ip4_range(cls.mcast_ip4, ip_range_start, ip_range_end):
313 teid = int(dest_ip4.split(".")[3])
314 cls.vapi.gtpu_add_del_tunnel(
315 decap_next_index=0xFFFFFFFF,
316 src_address=cls.pg0.local_ip4,
317 dst_address=dest_ip4,
324 def add_mcast_tunnels_load(cls):
325 cls.add_del_mcast_tunnels_load(is_add=1)
328 def del_mcast_tunnels_load(cls):
329 cls.add_del_mcast_tunnels_load(is_add=0)
331 # Class method to start the GTPU test case.
332 # Overrides setUpClass method in VppTestCase class.
333 # Python try..except statement is used to ensure that the tear down of
334 # the class will be executed even if exception is raised.
335 # @param cls The class pointer.
338 super(TestGtpu, cls).setUpClass()
344 # Create 2 pg interfaces.
345 cls.create_pg_interfaces(range(4))
346 for pg in cls.pg_interfaces:
349 # Configure IPv4 addresses on VPP pg0.
352 # Resolve MAC address for VPP's IP address on pg0.
353 cls.pg0.resolve_arp()
355 # Our Multicast address
356 cls.mcast_ip4 = "239.1.1.1"
357 cls.mcast_mac = util.mcast_ip_to_mac(cls.mcast_ip4)
359 # Create GTPU VTEP on VPP pg0, and put gtpu_tunnel0 and pg1
361 cls.single_tunnel_bd = 11
362 cls.single_tunnel_vni = 11
363 r = cls.vapi.gtpu_add_del_tunnel(
365 mcast_sw_if_index=0xFFFFFFFF,
366 decap_next_index=0xFFFFFFFF,
367 src_address=cls.pg0.local_ip4,
368 dst_address=cls.pg0.remote_ip4,
369 teid=cls.single_tunnel_vni,
371 cls.vapi.sw_interface_set_l2_bridge(
372 rx_sw_if_index=r.sw_if_index, bd_id=cls.single_tunnel_bd
374 cls.vapi.sw_interface_set_l2_bridge(
375 rx_sw_if_index=cls.pg1.sw_if_index, bd_id=cls.single_tunnel_bd
378 # Setup teid 2 to test multicast flooding
379 cls.n_ucast_tunnels = 10
380 cls.mcast_flood_bd = 12
381 cls.create_gtpu_flood_test_bd(cls.mcast_flood_bd, cls.n_ucast_tunnels)
382 r = cls.vapi.gtpu_add_del_tunnel(
384 src_address=cls.pg0.local_ip4,
385 dst_address=cls.mcast_ip4,
387 decap_next_index=0xFFFFFFFF,
388 teid=cls.mcast_flood_bd,
390 cls.vapi.sw_interface_set_l2_bridge(
391 rx_sw_if_index=r.sw_if_index, bd_id=cls.mcast_flood_bd
393 cls.vapi.sw_interface_set_l2_bridge(
394 rx_sw_if_index=cls.pg2.sw_if_index, bd_id=cls.mcast_flood_bd
397 # Add and delete mcast tunnels to check stability
398 cls.add_shared_mcast_dst_load()
399 cls.add_mcast_tunnels_load()
400 cls.del_shared_mcast_dst_load()
401 cls.del_mcast_tunnels_load()
403 # Setup teid 3 to test unicast flooding
404 cls.ucast_flood_bd = 13
405 cls.create_gtpu_flood_test_bd(cls.ucast_flood_bd, cls.n_ucast_tunnels)
406 cls.vapi.sw_interface_set_l2_bridge(
407 rx_sw_if_index=cls.pg3.sw_if_index, bd_id=cls.ucast_flood_bd
410 super(TestGtpu, cls).tearDownClass()
414 def tearDownClass(cls):
415 super(TestGtpu, cls).tearDownClass()
417 # Method to define VPP actions before tear down of the test case.
418 # Overrides tearDown method in VppTestCase class.
419 # @param self The object pointer.
421 super(TestGtpu, self).tearDown()
423 def show_commands_at_teardown(self):
424 self.logger.info(self.vapi.cli("show bridge-domain 11 detail"))
425 self.logger.info(self.vapi.cli("show bridge-domain 12 detail"))
426 self.logger.info(self.vapi.cli("show bridge-domain 13 detail"))
427 self.logger.info(self.vapi.cli("show int"))
428 self.logger.info(self.vapi.cli("show gtpu tunnel"))
429 self.logger.info(self.vapi.cli("show trace"))
432 if __name__ == "__main__":
433 unittest.main(testRunner=VppTestRunner)