1 # Copyright (c) 2016 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 """DUT setup library."""
16 from robot.api import logger
18 from resources.libraries.python.topology import NodeType
19 from resources.libraries.python.topology import Topology
20 from resources.libraries.python.ssh import SSH
21 from resources.libraries.python.constants import Constants
22 from resources.libraries.python.VatExecutor import VatExecutor
25 class DUTSetup(object):
26 """Contains methods for setting up DUTs."""
28 def start_vpp_service_on_all_duts(nodes):
29 """Start up the VPP service on all nodes."""
31 for node in nodes.values():
32 if node['type'] == NodeType.DUT:
34 (ret_code, stdout, stderr) = \
35 ssh.exec_command_sudo('service vpp restart', timeout=120)
36 if int(ret_code) != 0:
37 logger.debug('stdout: {0}'.format(stdout))
38 logger.debug('stderr: {0}'.format(stderr))
39 raise Exception('DUT {0} failed to start VPP service'.
43 def vpp_show_version_verbose(node):
44 """Run "show version verbose" CLI command.
46 :param node: Node to run command on.
50 vat.execute_script("show_version_verbose.vat", node, json_out=False)
53 def vpp_api_trace_save(node):
54 """Run "api trace save" CLI command.
56 :param node: Node to run command on.
60 vat.execute_script("api_trace_save.vat", node, json_out=False)
63 def vpp_api_trace_dump(node):
64 """Run "api trace custom-dump" CLI command.
66 :param node: Node to run command on.
70 vat.execute_script("api_trace_dump.vat", node, json_out=False)
73 def setup_all_duts(nodes):
74 """Prepare all DUTs in given topology for test execution."""
75 for node in nodes.values():
76 if node['type'] == NodeType.DUT:
77 DUTSetup.setup_dut(node)
81 """Run script over SSH to setup the DUT node.
83 :param node: DUT node to set up.
86 :raises Exception: If the DUT setup fails.
91 (ret_code, stdout, stderr) = \
92 ssh.exec_command('sudo -Sn bash {0}/{1}/dut_setup.sh'.
93 format(Constants.REMOTE_FW_DIR,
94 Constants.RESOURCES_LIB_SH), timeout=120)
97 if int(ret_code) != 0:
98 logger.debug('DUT {0} setup script failed: "{1}"'.
99 format(node['host'], stdout + stderr))
100 raise Exception('DUT test setup script failed at node {}'.
101 format(node['host']))
104 def get_vpp_pid(node):
105 """Get PID of running VPP process.
107 :param node: DUT node.
111 :raises RuntimeError if it is not possible to get the PID.
118 logger.trace('Try {}: Get VPP PID'.format(i))
119 ret_code, stdout, stderr = ssh.exec_command('pidof vpp')
121 if int(ret_code) != 0:
122 raise RuntimeError('Not possible to get PID of VPP process '
123 'on node: {0}\n {1}'.
124 format(node['host'], stdout + stderr))
126 if len(stdout.splitlines()) == 1:
128 elif len(stdout.splitlines()) == 0:
129 logger.debug("No VPP PID found on node {0}".
130 format(node['host']))
133 logger.debug("More then one VPP PID found on node {0}".
134 format(node['host']))
136 for line in stdout.splitlines():
137 ret_list.append(int(line))
143 def get_vpp_pids(nodes):
144 """Get PID of running VPP process on all DUTs.
146 :param nodes: DUT nodes.
153 for node in nodes.values():
154 if node['type'] == NodeType.DUT:
155 pids[node['host']] = DUTSetup.get_vpp_pid(node)
159 def vpp_show_crypto_device_mapping(node):
160 """Run "show crypto device mapping" CLI command.
162 :param node: Node to run command on.
166 vat.execute_script("show_crypto_device_mapping.vat", node,
170 def crypto_device_verify(node, force_init=False, numvfs=32):
171 """Verify if Crypto QAT device virtual functions are initialized on all
172 DUTs. If parameter force initialization is set to True, then try to
173 initialize or disable QAT.
175 :param node: DUT node.
176 :param force_init: If True then try to initialize to specific value.
177 :param numvfs: Number of VFs to initialize, 0 - disable the VFs.
179 :type force_init: bool
182 :raises RuntimeError: If QAT is not initialized or failed to initialize.
188 cryptodev = Topology.get_cryptodev(node)
189 cmd = 'cat /sys/bus/pci/devices/{}/sriov_numvfs'.format(
190 cryptodev.replace(':', r'\:'))
192 # Try to read number of VFs from PCI address of QAT device
194 ret_code, stdout, _ = ssh.exec_command(cmd)
195 if int(ret_code) == 0:
197 sriov_numvfs = int(stdout)
199 logger.trace('Reading sriov_numvfs info failed on: {}'\
200 .format(node['host']))
202 if sriov_numvfs != numvfs:
204 # QAT is not initialized and we want to initialize
206 DUTSetup.crypto_device_init(node, numvfs)
208 raise RuntimeError('QAT device {} is not '\
209 'initialized to {} on host: {}'.format(\
210 cryptodev, numvfs, node['host']))
214 def crypto_device_init(node, numvfs):
215 """Init Crypto QAT device virtual functions on DUT.
217 :param node: DUT node.
218 :param numvfs: Number of VFs to initialize, 0 - disable the VFs.
222 :raises RuntimeError: If QAT failed to initialize.
228 cryptodev = Topology.get_cryptodev(node)
230 # QAT device must be bind to kernel driver before initialization
231 DUTSetup.pci_driver_unbind(node, cryptodev)
232 DUTSetup.pci_driver_bind(node, cryptodev, "dh895xcc")
235 ret_code, _, _ = ssh.exec_command(
236 "sudo sh -c 'echo {} | tee /sys/bus/pci/devices/{}/sriov_numvfs'"
237 .format(numvfs, cryptodev.replace(':', r'\:')))
239 if int(ret_code) != 0:
240 raise RuntimeError('Failed to initialize {} VFs on QAT device on '
241 'host: {}'.format(numvfs, node['host']))
244 def pci_driver_unbind(node, pci_addr):
245 """Unbind PCI device from current driver on node.
247 :param node: DUT node.
248 :param pci_addr: PCI device address.
252 :raises RuntimeError: If PCI device unbind failed.
258 ret_code, _, _ = ssh.exec_command(
259 "sudo sh -c 'echo {} | tee /sys/bus/pci/devices/{}/driver/unbind'"
260 .format(pci_addr, pci_addr.replace(':', r'\:')))
262 if int(ret_code) != 0:
263 raise RuntimeError('Failed to unbind PCI device from driver on '
264 'host: {}'.format(node['host']))
267 def pci_driver_bind(node, pci_addr, driver):
268 """Bind PCI device to driver on node.
270 :param node: DUT node.
271 :param pci_addr: PCI device address.
272 :param driver: Driver to bind.
277 :raises RuntimeError: If PCI device bind failed.
283 ret_code, _, _ = ssh.exec_command(
284 "sudo sh -c 'echo {} | tee /sys/bus/pci/drivers/{}/bind'"
285 .format(pci_addr, driver))
287 if int(ret_code) != 0:
288 raise RuntimeError('Failed to bind PCI device to {} driver on '
289 'host: {}'.format(driver, node['host']))
292 def kernel_module_verify(node, module, force_load=False):
293 """Verify if kernel module is loaded on all DUTs. If parameter force
294 load is set to True, then try to load the modules.
296 :param node: DUT node.
297 :param module: Module to verify.
298 :param force_load: If True then try to load module.
301 :type force_init: bool
303 :raises RuntimeError: If module is not loaded or failed to load.
309 cmd = 'grep -w {} /proc/modules'.format(module)
310 ret_code, _, _ = ssh.exec_command(cmd)
312 if int(ret_code) != 0:
314 # Module is not loaded and we want to load it
315 DUTSetup.kernel_module_load(node, module)
317 raise RuntimeError('Kernel module {} is not loaded on host: '\
318 '{}'.format(module, node['host']))
321 def kernel_module_load(node, module):
322 """Load kernel module on node.
324 :param node: DUT node.
325 :param module: Module to load.
329 :raises RuntimeError: If loading failed.
335 ret_code, _, _ = ssh.exec_command_sudo("modprobe {}".format(module))
337 if int(ret_code) != 0:
338 raise RuntimeError('Failed to load {} kernel module on host: '\
339 '{}'.format(module, node['host']))