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.
116 ret_code, stdout, stderr = ssh.exec_command('pidof vpp')
121 if int(ret_code) != 0:
122 logger.debug('Not possible to get PID of VPP process on node: '
123 '{0}\n {1}'.format(node['host'], stdout + stderr))
124 raise RuntimeError('Not possible to get PID of VPP process on node:'
125 ' {}'.format(node['host']))
127 if len(stdout.splitlines()) == 1:
129 elif len(stdout.splitlines()) == 0:
130 logger.debug("No VPP PID found on node {0}".
131 format(node['host']))
134 logger.debug("More then one VPP PID found on node {0}".
135 format(node['host']))
137 for line in stdout.splitlines():
138 ret_list.append(int(line))
142 def get_vpp_pids(nodes):
143 """Get PID of running VPP process on all DUTs.
145 :param nodes: DUT nodes.
152 for node in nodes.values():
153 if node['type'] == NodeType.DUT:
154 pids[node['host']] = DUTSetup.get_vpp_pid(node)
158 def vpp_show_crypto_device_mapping(node):
159 """Run "show crypto device mapping" CLI command.
161 :param node: Node to run command on.
165 vat.execute_script("show_crypto_device_mapping.vat", node,
169 def crypto_device_verify(node, force_init=False, numvfs=32):
170 """Verify if Crypto QAT device virtual functions are initialized on all
171 DUTs. If parameter force initialization is set to True, then try to
172 initialize or disable QAT.
174 :param node: DUT node.
175 :param force_init: If True then try to initialize to specific value.
176 :param numvfs: Number of VFs to initialize, 0 - disable the VFs.
178 :type force_init: bool
181 :raises RuntimeError: If QAT is not initialized or failed to initialize.
187 cryptodev = Topology.get_cryptodev(node)
188 cmd = 'cat /sys/bus/pci/devices/{}/sriov_numvfs'.format(
189 cryptodev.replace(':', r'\:'))
191 # Try to read number of VFs from PCI address of QAT device
193 ret_code, stdout, _ = ssh.exec_command(cmd)
194 if int(ret_code) == 0:
196 sriov_numvfs = int(stdout)
198 logger.trace('Reading sriov_numvfs info failed on: {}'\
199 .format(node['host']))
201 if sriov_numvfs != numvfs:
203 # QAT is not initialized and we want to initialize
205 DUTSetup.crypto_device_init(node, numvfs)
207 raise RuntimeError('QAT device {} is not '\
208 'initialized to {} on host: {}'.format(\
209 cryptodev, numvfs, node['host']))
213 def crypto_device_init(node, numvfs):
214 """Init Crypto QAT device virtual functions on DUT.
216 :param node: DUT node.
217 :param numvfs: Number of VFs to initialize, 0 - disable the VFs.
221 :raises RuntimeError: If QAT failed to initialize.
227 cryptodev = Topology.get_cryptodev(node)
229 # QAT device must be bind to kernel driver before initialization
230 DUTSetup.pci_driver_unbind(node, cryptodev)
231 DUTSetup.pci_driver_bind(node, cryptodev, "dh895xcc")
234 ret_code, _, _ = ssh.exec_command(
235 "sudo sh -c 'echo {} | tee /sys/bus/pci/devices/{}/sriov_numvfs'"
236 .format(numvfs, cryptodev.replace(':', r'\:')))
238 if int(ret_code) != 0:
239 raise RuntimeError('Failed to initialize {} VFs on QAT device on '
240 'host: {}'.format(numvfs, node['host']))
243 def pci_driver_unbind(node, pci_addr):
244 """Unbind PCI device from current driver on node.
246 :param node: DUT node.
247 :param pci_addr: PCI device address.
251 :raises RuntimeError: If PCI device unbind failed.
257 ret_code, _, _ = ssh.exec_command(
258 "sudo sh -c 'echo {} | tee /sys/bus/pci/devices/{}/driver/unbind'"
259 .format(pci_addr, pci_addr.replace(':', r'\:')))
261 if int(ret_code) != 0:
262 raise RuntimeError('Failed to unbind PCI device from driver on '
263 'host: {}'.format(node['host']))
266 def pci_driver_bind(node, pci_addr, driver):
267 """Bind PCI device to driver on node.
269 :param node: DUT node.
270 :param pci_addr: PCI device address.
271 :param driver: Driver to bind.
276 :raises RuntimeError: If PCI device bind failed.
282 ret_code, _, _ = ssh.exec_command(
283 "sudo sh -c 'echo {} | tee /sys/bus/pci/drivers/{}/bind'"
284 .format(pci_addr, driver))
286 if int(ret_code) != 0:
287 raise RuntimeError('Failed to bind PCI device to {} driver on '
288 'host: {}'.format(driver, node['host']))
291 def kernel_module_verify(node, module, force_load=False):
292 """Verify if kernel module is loaded on all DUTs. If parameter force
293 load is set to True, then try to load the modules.
295 :param node: DUT node.
296 :param module: Module to verify.
297 :param force_load: If True then try to load module.
300 :type force_init: bool
302 :raises RuntimeError: If module is not loaded or failed to load.
308 cmd = 'grep -w {} /proc/modules'.format(module)
309 ret_code, _, _ = ssh.exec_command(cmd)
311 if int(ret_code) != 0:
313 # Module is not loaded and we want to load it
314 DUTSetup.kernel_module_load(node, module)
316 raise RuntimeError('Kernel module {} is not loaded on host: '\
317 '{}'.format(module, node['host']))
320 def kernel_module_load(node, module):
321 """Load kernel module on node.
323 :param node: DUT node.
324 :param module: Module to load.
328 :raises RuntimeError: If loading failed.
334 ret_code, _, _ = ssh.exec_command_sudo("modprobe {}".format(module))
336 if int(ret_code) != 0:
337 raise RuntimeError('Failed to load {} kernel module on host: '\
338 '{}'.format(module, node['host']))