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.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
19 class TestGtpuUDP(VppTestCase):
20 """ GTPU UDP ports Test Case """
23 super(TestGtpuUDP, self).setUp()
30 self.create_pg_interfaces(range(1))
31 for pg in self.pg_interfaces:
36 def _check_udp_port_ip4(self, enabled=True):
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))
42 self.pg0.add_stream(pkt)
45 err = self.statistics.get_counter(
46 '/err/ip4-udp-lookup/no listener for dst port')[0]
49 self.assertEqual(err, self.ip4_err)
51 self.assertEqual(err, self.ip4_err + 1)
55 def _check_udp_port_ip6(self, enabled=True):
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))
61 self.pg0.add_stream(pkt)
64 err = self.statistics.get_counter(
65 '/err/ip6-udp-lookup/no listener for dst port')[0]
68 self.assertEqual(err, self.ip6_err)
70 self.assertEqual(err, self.ip6_err + 1)
74 def test_udp_port(self):
76 Check if there are no udp listeners before gtpu is enabled
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)
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)
88 # UDP port 2152 enabled for ip4
89 self._check_udp_port_ip4()
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)
97 # UDP port 2152 enabled for ip6
98 self._check_udp_port_ip6()
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)
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)
113 class TestGtpu(BridgeDomain, VppTestCase):
114 """ GTPU Test Case """
116 def __init__(self, *args):
117 BridgeDomain.__init__(self)
118 VppTestCase.__init__(self, *args)
120 def encapsulate(self, pkt, vni):
122 Encapsulate the original payload frame by adding GTPU header with its
123 UDP, IP and Ethernet fields
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) /
131 def ip_range(self, start, end):
132 """ range of remote ip's """
133 return ip4_range(self.pg0.remote_ip4, start, end)
135 def encap_mcast(self, pkt, src_ip, src_mac, vni):
137 Encapsulate the original payload frame by adding GTPU header with its
138 UDP, IP and Ethernet fields
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) /
146 def decapsulate(self, pkt):
148 Decapsulate the original payload frame by removing GTPU header
150 return pkt[GTP_U_Header].payload
152 # Method for checking GTPU encapsulation.
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
157 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
160 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
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)
167 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
169 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
170 # Verify UDP destination port is GTPU 2152, source UDP port could be
172 self.assertEqual(pkt[UDP].dport, type(self).dport)
174 self.assertEqual(pkt[GTP_U_Header].teid, vni)
176 def test_encap(self):
177 """ Encapsulation test
179 Verify receipt of encapsulated frames on pg0
181 self.pg1.add_stream([self.frame_reply])
183 self.pg0.enable_capture()
187 # Pick first received frame and check if it's correctly encapsulated.
188 out = self.pg0.get_capture(1)
190 self.check_encapsulation(pkt, self.single_tunnel_bd)
192 # payload = self.decapsulate(pkt)
193 # self.assert_eq_pkts(payload, self.frame_reply)
195 def test_ucast_flood(self):
196 """ Unicast flood test
198 Verify receipt of encapsulated frames on pg0
200 self.pg3.add_stream([self.frame_reply])
202 self.pg0.enable_capture()
206 # Get packet from each tunnel and assert it's correctly encapsulated.
207 out = self.pg0.get_capture(self.n_ucast_tunnels)
209 self.check_encapsulation(pkt, self.ucast_flood_bd, True)
210 # payload = self.decapsulate(pkt)
211 # self.assert_eq_pkts(payload, self.frame_reply)
213 def test_mcast_flood(self):
214 """ Multicast flood test
216 Verify receipt of encapsulated frames on pg0
218 self.pg2.add_stream([self.frame_reply])
220 self.pg0.enable_capture()
224 # Pick first received frame and check if it's correctly encapsulated.
225 out = self.pg0.get_capture(1)
227 self.check_encapsulation(pkt, self.mcast_flood_bd,
228 local_only=False, mcast_pkt=True)
230 # payload = self.decapsulate(pkt)
231 # self.assert_eq_pkts(payload, self.frame_reply)
234 def create_gtpu_flood_test_bd(cls, teid, n_ucast_tunnels):
235 # Create 10 ucast gtpu tunnels under bd
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,
241 # add host route so dest_ip4n will not be resolved
242 rip = VppIpRoute(cls, dest_ip4, 32,
243 [VppRoutePath(next_hop_address,
247 r = cls.vapi.gtpu_add_del_tunnel(
249 mcast_sw_if_index=0xFFFFFFFF,
250 decap_next_index=0xFFFFFFFF,
251 src_address=cls.pg0.local_ip4,
252 dst_address=dest_ip4,
254 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
258 def add_del_shared_mcast_dst_load(cls, is_add):
260 add or del tunnels sharing the same mcast dst
261 to test gtpu ref_count mechanism
263 n_shared_dst_tunnels = 20
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,
274 if r.sw_if_index == 0xffffffff:
275 raise ValueError("bad sw_if_index: ~0")
278 def add_shared_mcast_dst_load(cls):
279 cls.add_del_shared_mcast_dst_load(is_add=1)
282 def del_shared_mcast_dst_load(cls):
283 cls.add_del_shared_mcast_dst_load(is_add=0)
286 def add_del_mcast_tunnels_load(cls, is_add):
288 add or del tunnels to test gtpu stability
290 n_distinct_dst_tunnels = 20
292 ip_range_end = ip_range_start + n_distinct_dst_tunnels
293 for dest_ip4 in ip4_range(cls.mcast_ip4, ip_range_start,
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,
305 def add_mcast_tunnels_load(cls):
306 cls.add_del_mcast_tunnels_load(is_add=1)
309 def del_mcast_tunnels_load(cls):
310 cls.add_del_mcast_tunnels_load(is_add=0)
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.
319 super(TestGtpu, cls).setUpClass()
325 # Create 2 pg interfaces.
326 cls.create_pg_interfaces(range(4))
327 for pg in cls.pg_interfaces:
330 # Configure IPv4 addresses on VPP pg0.
333 # Resolve MAC address for VPP's IP address on pg0.
334 cls.pg0.resolve_arp()
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)
343 # Create GTPU VTEP on VPP pg0, and put gtpu_tunnel0 and pg1
345 cls.single_tunnel_bd = 11
346 r = cls.vapi.gtpu_add_del_tunnel(
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)
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,
363 r = cls.vapi.gtpu_add_del_tunnel(
365 src_address=cls.pg0.local_ip4,
366 dst_address=cls.mcast_ip4,
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)
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()
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,
385 cls.vapi.sw_interface_set_l2_bridge(
386 rx_sw_if_index=cls.pg3.sw_if_index, bd_id=cls.ucast_flood_bd)
388 super(TestGtpu, cls).tearDownClass()
392 def tearDownClass(cls):
393 super(TestGtpu, cls).tearDownClass()
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.
399 super(TestGtpu, self).tearDown()
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"))
410 if __name__ == '__main__':
411 unittest.main(testRunner=VppTestRunner)