1 # Copyright (c) 2019 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Memif interface library."""
17 from enum import IntEnum
18 from robot.api import logger
20 from resources.libraries.python.topology import NodeType, Topology
21 from resources.libraries.python.PapiExecutor import PapiSocketExecutor
22 from resources.libraries.python.L2Util import L2Util
25 class MemifRole(IntEnum):
26 """Memif interface roles"""
32 """Memif interface class"""
38 def _memif_details(node):
39 """Get the memif dump details on the given node.
41 :param node: Given node to get Memif dump from.
43 :returns: List of memif interfaces extracted from Papi response.
46 with PapiSocketExecutor(node) as papi_exec:
47 details = papi_exec.add("memif_dump").get_details()
50 memif["if_name"] = memif["if_name"].rstrip('\x00')
51 memif["hw_addr"] = L2Util.bin_to_mac(memif["hw_addr"])
53 logger.debug("MEMIF details:\n{details}".format(details=details))
58 def _memif_socket_filename_add_del(node, is_add, filename, sid):
59 """Create Memif socket on the given node.
61 :param node: Given node to create Memif socket on.
62 :param is_add: If True, socket is added, otherwise deleted.
63 :param filename: Memif interface socket filename.
64 :param sid: Socket ID.
69 :returns: Verified data from PAPI response. In this case, the response
73 cmd = 'memif_socket_filename_add_del'
74 err_msg = 'Failed to create memif socket on host {host}'.format(
79 socket_filename=str('/tmp/' + filename)
81 with PapiSocketExecutor(node) as papi_exec:
82 return papi_exec.add(cmd, **args).get_reply(err_msg)
85 def _memif_create(node, mid, sid, rxq=1, txq=1, role=1):
86 """Create Memif interface on the given node, return its sw_if_index.
88 :param node: Given node to create Memif interface on.
89 :param mid: Memif interface ID.
90 :param sid: Socket ID.
91 :param rxq: Number of RX queues; 0 means do not set.
92 :param txq: Number of TX queues; 0 means do not set.
93 :param role: Memif interface role [master=0|slave=1]. Default is slave.
100 :returns: sw_if_index
104 err_msg = 'Failed to create memif interface on host {host}'.format(
113 with PapiSocketExecutor(node) as papi_exec:
114 return papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
117 def create_memif_interface(node, filename, mid, sid, rxq=1, txq=1,
119 """Create Memif interface on the given node.
121 :param node: Given node to create Memif interface on.
122 :param filename: Memif interface socket filename.
123 :param mid: Memif interface ID.
124 :param sid: Socket ID.
125 :param rxq: Number of RX queues; 0 means do not set.
126 :param txq: Number of TX queues; 0 means do not set.
127 :param role: Memif interface role [master=0|slave=1]. Default is master.
135 :returns: SW interface index.
137 :raises ValueError: If command 'create memif' fails.
140 role = getattr(MemifRole, role.upper()).value
143 Memif._memif_socket_filename_add_del(node, True, filename, sid)
146 sw_if_index = Memif._memif_create(
147 node, mid, sid, rxq=rxq, txq=txq, role=role)
150 if_key = Topology.add_new_port(node, 'memif')
151 Topology.update_interface_sw_if_index(node, if_key, sw_if_index)
153 ifc_name = Memif.vpp_get_memif_interface_name(node, sw_if_index)
154 Topology.update_interface_name(node, if_key, ifc_name)
156 ifc_mac = Memif.vpp_get_memif_interface_mac(node, sw_if_index)
157 Topology.update_interface_mac_address(node, if_key, ifc_mac)
159 Topology.update_interface_memif_socket(node, if_key, '/tmp/' + filename)
160 Topology.update_interface_memif_id(node, if_key, mid)
161 Topology.update_interface_memif_role(node, if_key, str(role))
166 def show_memif(node):
167 """Show Memif data for the given node.
169 :param node: Given node to show Memif data on.
173 Memif._memif_details(node)
176 def show_memif_on_all_duts(nodes):
177 """Show Memif data on all DUTs.
179 :param nodes: Topology nodes.
182 for node in nodes.values():
183 if node['type'] == NodeType.DUT:
184 Memif.show_memif(node)
187 def vpp_get_memif_interface_name(node, sw_if_index):
188 """Get Memif interface name from Memif interfaces dump.
190 :param node: DUT node.
191 :param sw_if_index: DUT node.
193 :type sw_if_index: int
194 :returns: Memif interface name, or None if not found.
198 details = Memif._memif_details(node)
200 for memif in details:
201 if memif["sw_if_index"] == sw_if_index:
202 return memif["if_name"]
206 def vpp_get_memif_interface_mac(node, sw_if_index):
207 """Get Memif interface MAC address from Memif interfaces dump.
209 :param node: DUT node.
210 :param sw_if_index: DUT node.
212 :type sw_if_index: int
213 :returns: Memif interface MAC address, or None if not found.
217 details = Memif._memif_details(node)
219 for memif in details:
220 if memif["sw_if_index"] == sw_if_index:
221 return memif["hw_addr"]