4 from scapy.layers.l2 import Ether
5 from scapy.layers.inet import IP, ICMP
7 from framework import VppTestCase, VppTestRunner
8 from framework import tag_run_solo, tag_fixme_debian11, is_distro_debian11
9 from asf.remote_test import RemoteClass, RemoteVppTestCase
10 from vpp_memif import remove_all_memif_vpp_config, VppSocketFilename, VppMemif
11 from vpp_ip_route import VppIpRoute, VppRoutePath
12 from vpp_papi import VppEnum
17 class TestMemif(VppTestCase):
20 remote_class = RemoteVppTestCase
23 def get_cpus_required(cls):
24 return super().get_cpus_required() + cls.remote_class.get_cpus_required()
27 def assign_cpus(cls, cpus):
28 remote_cpus = cpus[: cls.remote_class.get_cpus_required()]
29 my_cpus = cpus[cls.remote_class.get_cpus_required() :]
30 cls.remote_class.assign_cpus(remote_cpus)
31 super().assign_cpus(my_cpus)
35 # fork new process before client connects to VPP
36 cls.remote_test = RemoteClass(cls.remote_class)
37 cls.remote_test.start_remote()
38 cls.remote_test.set_request_timeout(10)
39 super(TestMemif, cls).setUpClass()
40 if is_distro_debian11 == True and not hasattr(cls, "vpp"):
41 cls.remote_test.quit_remote()
43 cls.remote_test.setUpClass(cls.tempdir)
44 cls.create_pg_interfaces(range(1))
45 for pg in cls.pg_interfaces:
51 def tearDownClass(cls):
52 cls.remote_test.tearDownClass()
53 cls.remote_test.quit_remote()
54 for pg in cls.pg_interfaces:
58 super(TestMemif, cls).tearDownClass()
61 remove_all_memif_vpp_config(self)
62 remove_all_memif_vpp_config(self.remote_test)
63 super(TestMemif, self).tearDown()
65 def _check_socket_filename(self, dump, socket_id, filename):
67 if (d.socket_id == socket_id) and (d.socket_filename == filename):
71 def test_memif_socket_filename_add_del(self):
72 """Memif socket filename add/del"""
74 # dump default socket filename
75 dump = self.vapi.memif_socket_filename_dump()
77 self._check_socket_filename(dump, 0, "%s/memif.sock" % self.tempdir)
83 VppSocketFilename(self, 1, "%s/memif1.sock" % self.tempdir)
85 # default path (test tempdir)
87 VppSocketFilename(self, 2, "memif2.sock", add_default_folder=True)
89 # create new folder in default folder
91 VppSocketFilename(self, 3, "sock/memif3.sock", add_default_folder=True)
94 for sock in memif_sockets:
96 dump = sock.query_vpp_config()
98 self._check_socket_filename(dump, sock.socket_id, sock.socket_filename)
101 for sock in memif_sockets:
102 sock.remove_vpp_config()
104 dump = self.vapi.memif_socket_filename_dump()
106 self._check_socket_filename(dump, 0, "%s/memif.sock" % self.tempdir)
109 def _create_delete_test_one_interface(self, memif):
110 memif.add_vpp_config()
112 dump = memif.query_vpp_config()
114 self.assertTrue(dump)
115 self.assertEqual(dump.sw_if_index, memif.sw_if_index)
116 self.assertEqual(dump.role, memif.role)
117 self.assertEqual(dump.mode, memif.mode)
118 if memif.socket_id is not None:
119 self.assertEqual(dump.socket_id, memif.socket_id)
121 memif.remove_vpp_config()
123 dump = memif.query_vpp_config()
125 self.assertFalse(dump)
127 def _connect_test_one_interface(self, memif):
128 self.assertTrue(memif.wait_for_link_up(5))
129 dump = memif.query_vpp_config()
131 if memif.role == VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE:
132 self.assertEqual(dump.ring_size, memif.ring_size)
133 self.assertEqual(dump.buffer_size, memif.buffer_size)
135 self.assertEqual(dump.ring_size, 1)
136 self.assertEqual(dump.buffer_size, 0)
138 def _connect_test_interface_pair(self, memif0, memif1):
139 memif0.add_vpp_config()
140 memif1.add_vpp_config()
145 self._connect_test_one_interface(memif0)
146 self._connect_test_one_interface(memif1)
148 memif0.remove_vpp_config()
149 memif1.remove_vpp_config()
151 def test_memif_create_delete(self):
152 """Memif create/delete interface"""
156 VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
157 VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
159 self._create_delete_test_one_interface(memif)
160 memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER
161 self._create_delete_test_one_interface(memif)
163 def test_memif_create_custom_socket(self):
164 """Memif create with non-default socket filename"""
168 memif_sockets.append(
169 VppSocketFilename(self, 1, "%s/memif1.sock" % self.tempdir)
171 # default path (test tempdir)
172 memif_sockets.append(
173 VppSocketFilename(self, 2, "memif2.sock", add_default_folder=True)
175 # create new folder in default folder
176 memif_sockets.append(
177 VppSocketFilename(self, 3, "sock/memif3.sock", add_default_folder=True)
182 VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
183 VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
186 for sock in memif_sockets:
187 sock.add_vpp_config()
188 memif.socket_id = sock.socket_id
189 memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE
190 self._create_delete_test_one_interface(memif)
191 memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER
192 self._create_delete_test_one_interface(memif)
194 def test_memif_connect(self):
198 VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
199 VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
205 remote_socket = VppSocketFilename(
206 self.remote_test, 1, "%s/memif.sock" % self.tempdir
208 remote_socket.add_vpp_config()
210 remote_memif = VppMemif(
212 VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER,
213 VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
220 self._connect_test_interface_pair(memif, remote_memif)
222 memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER
223 remote_memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE
225 self._connect_test_interface_pair(memif, remote_memif)
227 def _create_icmp(self, pg, memif, num):
231 Ether(dst=pg.local_mac, src=pg.remote_mac)
232 / IP(src=pg.remote_ip4, dst=str(memif.ip_prefix.network_address))
233 / ICMP(id=memif.if_id, type="echo-request", seq=i)
238 def _verify_icmp(self, pg, memif, rx, seq):
240 self.assertEqual(ip.src, str(memif.ip_prefix.network_address))
241 self.assertEqual(ip.dst, pg.remote_ip4)
242 self.assertEqual(ip.proto, 1)
244 self.assertEqual(icmp.type, 0) # echo-reply
245 self.assertEqual(icmp.id, memif.if_id)
246 self.assertEqual(icmp.seq, seq)
248 def test_memif_ping(self):
253 VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
254 VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
257 remote_socket = VppSocketFilename(
258 self.remote_test, 1, "%s/memif.sock" % self.tempdir
260 remote_socket.add_vpp_config()
262 remote_memif = VppMemif(
264 VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER,
265 VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
269 memif.add_vpp_config()
273 remote_memif.add_vpp_config()
274 remote_memif.config_ip4()
275 remote_memif.admin_up()
277 self.assertTrue(memif.wait_for_link_up(5))
278 self.assertTrue(remote_memif.wait_for_link_up(5))
280 # add routing to remote vpp
283 self.pg0._local_ip4_subnet,
285 [VppRoutePath(memif.ip_prefix.network_address, 0xFFFFFFFF)],
289 route.add_vpp_config()
291 # create ICMP echo-request from local pg to remote memif
293 pkts = self._create_icmp(self.pg0, remote_memif, packet_num)
295 self.pg0.add_stream(pkts)
296 self.pg_enable_capture(self.pg_interfaces)
298 capture = self.pg0.get_capture(packet_num, timeout=2)
301 self._verify_icmp(self.pg0, remote_memif, c, seq)
304 route.remove_vpp_config()
306 def test_memif_admin_up_down_up(self):
307 """Memif admin up/down/up"""
310 VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
311 VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
317 remote_socket = VppSocketFilename(
318 self.remote_test, 1, "%s/memif.sock" % self.tempdir
320 remote_socket.add_vpp_config()
322 remote_memif = VppMemif(
324 VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER,
325 VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
332 memif.add_vpp_config()
333 remote_memif.add_vpp_config()
336 remote_memif.admin_up()
338 remote_memif.admin_down()
340 remote_memif.admin_up()
342 self._connect_test_one_interface(memif)
343 self._connect_test_one_interface(remote_memif)
345 memif.remove_vpp_config()
346 remote_memif.remove_vpp_config()
347 remote_socket.remove_vpp_config()
350 if __name__ == "__main__":
351 unittest.main(testRunner=VppTestRunner)