#!/usr/bin/env python
# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtimport socket
import unittest
from scapy.layers.l2 import Ether
from scapy.layers.inet import IP, ICMP
from framework import VppTestCase, VppTestRunner
from framework import tag_run_solo
from remote_test import RemoteClass, RemoteVppTestCase
from vpp_memif import remove_all_memif_vpp_config, VppSocketFilename, VppMemif
from vpp_ip_route import VppIpRoute, VppRoutePath
from vpp_papi import VppEnum
@tag_run_solo
class TestMemif(VppTestCase):
"""Memif Test Case"""
remote_class = RemoteVppTestCase
@classmethod
def get_cpus_required(cls):
return super().get_cpus_required() + cls.remote_class.get_cpus_required()
@classmethod
def assign_cpus(cls, cpus):
remote_cpus = cpus[: cls.remote_class.get_cpus_required()]
my_cpus = cpus[cls.remote_class.get_cpus_required() :]
cls.remote_class.assign_cpus(remote_cpus)
super().assign_cpus(my_cpus)
@classmethod
def setUpClass(cls):
# fork new process before client connects to VPP
cls.remote_test = RemoteClass(cls.remote_class)
cls.remote_test.start_remote()
cls.remote_test.set_request_timeout(10)
super(TestMemif, cls).setUpClass()
cls.remote_test.setUpClass(cls.tempdir)
cls.create_pg_interfaces(range(1))
for pg in cls.pg_interfaces:
pg.config_ip4()
pg.admin_up()
pg.resolve_arp()
@classmethod
def tearDownClass(cls):
cls.remote_test.tearDownClass()
cls.remote_test.quit_remote()
for pg in cls.pg_interfaces:
pg.unconfig_ip4()
pg.set_table_ip4(0)
pg.admin_down()
super(TestMemif, cls).tearDownClass()
def tearDown(self):
remove_all_memif_vpp_config(self)
remove_all_memif_vpp_config(self.remote_test)
super(TestMemif, self).tearDown()
def _check_socket_filename(self, dump, socket_id, filename):
for d in dump:
if (d.socket_id == socket_id) and (d.socket_filename == filename):
return True
return False
def test_memif_socket_filename_add_del(self):
"""Memif socket filename add/del"""
# dump default socket filename
dump = self.vapi.memif_socket_filename_dump()
self.assertTrue(
self._check_socket_filename(dump, 0, "%s/memif.sock" % self.tempdir)
)
memif_sockets = []
# existing path
memif_sockets.append(
VppSocketFilename(self, 1, "%s/memif1.sock" % self.tempdir)
)
# default path (test tempdir)
memif_sockets.append(
VppSocketFilename(self, 2, "memif2.sock", add_default_folder=True)
)
# create new folder in default folder
memif_sockets.append(
VppSocketFilename(self, 3, "sock/memif3.sock", add_default_folder=True)
)
for sock in memif_sockets:
sock.add_vpp_config()
dump = sock.query_vpp_config()
self.assertTrue(
self._check_socket_filename(dump, sock.socket_id, sock.socket_filename)
)
for sock in memif_sockets:
sock.remove_vpp_config()
dump = self.vapi.memif_socket_filename_dump()
self.assertTrue(
self._check_socket_filename(dump, 0, "%s/memif.sock" % self.tempdir)
)
def _create_delete_test_one_interface(self, memif):
memif.add_vpp_config()
dump = memif.query_vpp_config()
self.assertTrue(dump)
self.assertEqual(dump.sw_if_index, memif.sw_if_index)
self.assertEqual(dump.role, memif.role)
self.assertEqual(dump.mode, memif.mode)
if memif.socket_id is not None:
self.assertEqual(dump.socket_id, memif.socket_id)
memif.remove_vpp_config()
dump = memif.query_vpp_config()
self.assertFalse(dump)
def _connect_test_one_interface(self, memif):
self.assertTrue(memif.wait_for_link_up(5))
dump = memif.query_vpp_config()
if memif.role == VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE:
self.assertEqual(dump.ring_size, memif.ring_size)
self.assertEqual(dump.buffer_size, memif.buffer_size)
else:
self.assertEqual(dump.ring_size, 1)
self.assertEqual(dump.buffer_size, 0)
def _connect_test_interface_pair(self, memif0, memif1):
memif0.add_vpp_config()
memif1.add_vpp_config()
memif0.admin_up()
memif1.admin_up()
self._connect_test_one_interface(memif0)
self._connect_test_one_interface(memif1)
memif0.remove_vpp_config()
memif1.remove_vpp_config()
def test_memif_create_delete(self):
"""Memif create/delete interface"""
memif = VppMemif(
self,
VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
)
self._create_delete_test_one_interface(memif)
memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER
self._create_delete_test_one_interface(memif)
def test_memif_create_custom_socket(self):
"""Memif create with non-default socket filename"""
memif_sockets = []
# existing path
memif_sockets.append(
VppSocketFilename(self, 1, "%s/memif1.sock" % self.tempdir)
)
# default path (test tempdir)
memif_sockets.append(
VppSocketFilename(self, 2, "memif2.sock", add_default_folder=True)
)
# create new folder in default folder
memif_sockets.append(
VppSocketFilename(self, 3, "sock/memif3.sock", add_default_folder=True)
)
memif = VppMemif(
self,
VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
)
for sock in memif_sockets:
sock.add_vpp_config()
memif.socket_id = sock.socket_id
memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE
self._create_delete_test_one_interface(memif)
memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER
self._create_delete_test_one_interface(memif)
def test_memif_connect(self):
"""Memif connect"""
memif = VppMemif(
self,
VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
ring_size=1024,
buffer_size=2048,
secret="abc",
)
remote_socket = VppSocketFilename(
self.remote_test, 1, "%s/memif.sock" % self.tempdir
)
remote_socket.add_vpp_config()
remote_memif = VppMemif(
self.remote_test,
VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER,
VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
socket_id=1,
ring_size=1024,
buffer_size=2048,
secret="abc",
)
self._connect_test_interface_pair(memif, remote_memif)
memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER
remote_memif.role = VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE
self._connect_test_interface_pair(memif, remote_memif)
def _create_icmp(self, pg, memif, num):
pkts = []
for i in range(num):
pkt = (
Ether(dst=pg.local_mac, src=pg.remote_mac)
/ IP(src=pg.remote_ip4, dst=str(memif.ip_prefix.network_address))
/ ICMP(id=memif.if_id, type="echo-request", seq=i)
)
pkts.append(pkt)
return pkts
def _verify_icmp(self, pg, memif, rx, seq):
ip = rx[IP]
self.assertEqual(ip.src, str(memif.ip_prefix.network_address))
self.assertEqual(ip.dst, pg.remote_ip4)
self.assertEqual(ip.proto, 1)
icmp = rx[ICMP]
self.assertEqual(icmp.type, 0) # echo-reply
self.assertEqual(icmp.id, memif.if_id)
self.assertEqual(icmp.seq, seq)
def test_memif_ping(self):
"""Memif ping"""
memif = VppMemif(
self,
VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
)
remote_socket = VppSocketFilename(
self.remote_test, 1, "%s/memif.sock" % self.tempdir
)
remote_socket.add_vpp_config()
remote_memif = VppMemif(
self.remote_test,
VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER,
VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
socket_id=1,
)
memif.add_vpp_config()
memif.config_ip4()
memif.admin_up()
remote_memif.add_vpp_config()
remote_memif.config_ip4()
remote_memif.admin_up()
self.assertTrue(memif.wait_for_link_up(5))
self.assertTrue(remote_memif.wait_for_link_up(5))
# add routing to remote vpp
route = VppIpRoute(
self.remote_test,
self.pg0._local_ip4_subnet,
24,
[VppRoutePath(memif.ip_prefix.network_address, 0xFFFFFFFF)],
register=False,
)
route.add_vpp_config()
# create ICMP echo-request from local pg to remote memif
packet_num = 10
pkts = self._create_icmp(self.pg0, remote_memif, packet_num)
self.pg0.add_stream(pkts)
self.pg_enable_capture(self.pg_interfaces)
self.pg_start()
capture = self.pg0.get_capture(packet_num, timeout=2)
seq = 0
for c in capture:
self._verify_icmp(self.pg0, remote_memif, c, seq)
seq += 1
route.remove_vpp_config()
def test_memif_admin_up_down_up(self):
"""Memif admin up/down/up"""
memif = VppMemif(
self,
VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_SLAVE,
VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
ring_size=1024,
buffer_size=2048,
secret="abc",
)
remote_socket = VppSocketFilename(
self.remote_test, 1, "%s/memif.sock" % self.tempdir
)
remote_socket.add_vpp_config()
remote_memif = VppMemif(
self.remote_test,
VppEnum.vl_api_memif_role_t.MEMIF_ROLE_API_MASTER,
VppEnum.vl_api_memif_mode_t.MEMIF_MODE_API_ETHERNET,
socket_id=1,
ring_size=1024,
buffer_size=2048,
secret="abc",
)
memif.add_vpp_config()
remote_memif.add_vpp_config()
memif.admin_up()
remote_memif.admin_up()
memif.admin_down()
remote_memif.admin_down()
memif.admin_up()
remote_memif.admin_up()
self._connect_test_one_interface(memif)
self._connect_test_one_interface(remote_memif)
memif.remove_vpp_config()
remote_memif.remove_vpp_config()
remote_socket.remove_vpp_config()
if __name__ == "__main__":
unittest.main(testRunner=VppTestRunner)
