1 # Copyright (c) 2023 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 time import sleep
17 from robot.api import logger
19 from resources.libraries.python.Constants import Constants
20 from resources.libraries.python.ssh import exec_cmd, exec_cmd_no_error
21 from resources.libraries.python.topology import NodeType, Topology
25 """Contains methods for setting up DUTs."""
28 def get_service_logs(node, service):
29 """Get specific service unit logs from node.
31 :param node: Node in the topology.
32 :param service: Service unit name.
36 if DUTSetup.running_in_container(node):
37 command = u"cat /var/log/vpp/vpp.log"
40 f"journalctl --no-pager _SYSTEMD_INVOCATION_ID=$(systemctl "
41 f"show -p InvocationID --value {service})"
43 message = f"Node {node[u'host']} failed to get logs from unit {service}"
46 node, command, timeout=30, sudo=True, message=message
50 def get_service_logs_on_all_duts(nodes, service):
51 """Get specific service unit logs from all DUTs.
53 :param nodes: Nodes in the topology.
54 :param service: Service unit name.
58 for node in nodes.values():
59 if node[u"type"] == NodeType.DUT:
60 DUTSetup.get_service_logs(node, service)
63 def restart_service(node, service):
64 """Restart the named service on node.
66 :param node: Node in the topology.
67 :param service: Service unit name.
71 if DUTSetup.running_in_container(node):
72 command = f"supervisorctl restart {service}"
74 command = f"systemctl restart {service}"
75 message = f"Node {node[u'host']} failed to restart service {service}"
78 node, command, timeout=180, sudo=True, message=message
81 DUTSetup.get_service_logs(node, service)
84 def restart_service_on_all_duts(nodes, service):
85 """Restart the named service on all DUTs.
87 :param nodes: Nodes in the topology.
88 :param service: Service unit name.
92 for node in nodes.values():
93 if node[u"type"] == NodeType.DUT:
94 DUTSetup.restart_service(node, service)
97 def start_service(node, service):
98 """Start up the named service on node.
100 :param node: Node in the topology.
101 :param service: Service unit name.
105 if DUTSetup.running_in_container(node):
106 command = f"supervisorctl restart {service}"
108 command = f"systemctl restart {service}"
109 message = f"Node {node[u'host']} failed to start service {service}"
112 node, command, timeout=180, sudo=True, message=message
115 DUTSetup.get_service_logs(node, service)
118 def start_service_on_all_duts(nodes, service):
119 """Start up the named service on all DUTs.
121 :param nodes: Nodes in the topology.
122 :param service: Service unit name.
126 for node in nodes.values():
127 if node[u"type"] == NodeType.DUT:
128 DUTSetup.start_service(node, service)
131 def stop_service(node, service):
132 """Stop the named service on node.
134 :param node: Node in the topology.
135 :param service: Service unit name.
139 DUTSetup.get_service_logs(node, service)
141 if DUTSetup.running_in_container(node):
142 command = f"supervisorctl stop {service}"
144 command = f"systemctl stop {service}"
145 message = f"Node {node[u'host']} failed to stop service {service}"
148 node, command, timeout=180, sudo=True, message=message
152 def stop_service_on_all_duts(nodes, service):
153 """Stop the named service on all DUTs.
155 :param nodes: Nodes in the topology.
156 :param service: Service unit name.
160 for node in nodes.values():
161 if node[u"type"] == NodeType.DUT:
162 DUTSetup.stop_service(node, service)
165 def kill_program(node, program, namespace=None):
166 """Kill program on the specified topology node.
168 :param node: Topology node.
169 :param program: Program name.
170 :param namespace: Namespace program is running in.
177 if namespace in (None, u"default"):
180 shell_cmd = f"ip netns exec {namespace} sh -c"
182 pgrep_cmd = f"{shell_cmd} \'pgrep -c {program}\'"
183 _, stdout, _ = exec_cmd(node, pgrep_cmd, timeout=cmd_timeout,
186 logger.trace(f"{program} is not running on {host}")
188 exec_cmd(node, f"{shell_cmd} \'pkill {program}\'",
189 timeout=cmd_timeout, sudo=True)
190 for attempt in range(5):
191 _, stdout, _ = exec_cmd(node, pgrep_cmd, timeout=cmd_timeout,
194 logger.trace(f"Attempt {attempt}: {program} is dead on {host}")
197 logger.trace(f"SIGKILLing {program} on {host}")
198 exec_cmd(node, f"{shell_cmd} \'pkill -9 {program}\'",
199 timeout=cmd_timeout, sudo=True)
202 def verify_program_installed(node, program):
203 """Verify that program is installed on the specified topology node.
205 :param node: Topology node.
206 :param program: Program name.
210 cmd = f"command -v {program}"
211 exec_cmd_no_error(node, cmd, message=f"{program} is not installed")
214 def get_pid(node, process, retries=3):
215 """Get PID of running process.
217 :param node: DUT node.
218 :param process: process name.
219 :param retries: How many times to retry on failure.
225 :raises RuntimeError: If it is not possible to get the PID.
227 cmd = f"pidof {process}"
228 stdout, _ = exec_cmd_no_error(
229 node, cmd, retries=retries,
230 message=f"No {process} PID found on node {node[u'host']}")
231 pid_list = stdout.split()
232 return [int(pid) for pid in pid_list]
235 def get_vpp_pids(nodes):
236 """Get PID of running VPP process on all DUTs.
238 :param nodes: DUT nodes.
244 for node in nodes.values():
245 if node[u"type"] == NodeType.DUT:
246 pids[node[u"host"]] = DUTSetup.get_pid(node, u"vpp")
250 def crypto_device_verify(node, crypto_type, numvfs, force_init=False):
251 """Verify if Crypto QAT device virtual functions are initialized on all
252 DUTs. If parameter force initialization is set to True, then try to
253 initialize or remove VFs on QAT.
255 :param node: DUT node.
256 :crypto_type: Crypto device type - HW_DH895xcc, HW_C3xxx or HW_C4xxx.
257 :param numvfs: Number of VFs to initialize, 0 - disable the VFs.
258 :param force_init: If True then try to initialize to specific value.
260 :type crypto_type: string
262 :type force_init: bool
264 :raises RuntimeError: If QAT VFs are not created and force init is set
267 pci_addr = Topology.get_cryptodev(node)
268 sriov_numvfs = DUTSetup.get_sriov_numvfs(node, pci_addr)
270 if sriov_numvfs != numvfs:
272 # QAT is not initialized and we want to initialize with numvfs
273 DUTSetup.crypto_device_init(node, crypto_type, numvfs)
276 f"QAT device failed to create VFs on {node[u'host']}"
280 def crypto_device_init(node, crypto_type, numvfs):
281 """Init Crypto QAT device virtual functions on DUT.
283 :param node: DUT node.
284 :crypto_type: Crypto device type - HW_DH895xcc, HW_C3xxx or HW_C4xxx.
285 :param numvfs: Number of VFs to initialize, 0 - disable the VFs.
287 :type crypto_type: string
290 :raises RuntimeError: If failed to stop VPP or QAT failed to initialize.
292 if crypto_type == u"HW_DH895xcc":
293 kernel_mod = u"qat_dh895xcc"
294 kernel_drv = u"dh895xcc"
295 elif crypto_type == u"HW_C3xxx":
296 kernel_mod = u"qat_c3xxx"
297 kernel_drv = u"c3xxx"
298 elif crypto_type == u"HW_C4xxx":
299 kernel_mod = u"qat_c4xxx"
300 kernel_drv = u"c4xxx"
303 f"Unsupported crypto device type on {node[u'host']}"
306 pci_addr = Topology.get_cryptodev(node)
308 # QAT device must be re-bound to kernel driver before initialization.
309 DUTSetup.verify_kernel_module(node, kernel_mod, force_load=True)
311 # Stop VPP to prevent deadlock.
312 DUTSetup.stop_service(node, Constants.VPP_UNIT)
314 current_driver = DUTSetup.get_pci_dev_driver(
315 node, pci_addr.replace(u":", r"\:")
317 if current_driver is not None:
318 DUTSetup.pci_driver_unbind(node, pci_addr)
320 # Bind to kernel driver.
321 DUTSetup.pci_driver_bind(node, pci_addr, kernel_drv)
323 # Initialize QAT VFs.
325 DUTSetup.set_sriov_numvfs(node, pci_addr, numvfs)
328 def get_virtfn_pci_addr(node, pf_pci_addr, vf_id):
329 """Get PCI address of Virtual Function.
331 :param node: DUT node.
332 :param pf_pci_addr: Physical Function PCI address.
333 :param vf_id: Virtual Function number.
335 :type pf_pci_addr: str
337 :returns: Virtual Function PCI address.
339 :raises RuntimeError: If failed to get Virtual Function PCI address.
341 command = f"sh -c \"basename $(readlink " \
342 f"/sys/bus/pci/devices/{pf_pci_addr}/virtfn{vf_id})\""
343 message = u"Failed to get virtual function PCI address."
345 stdout, _ = exec_cmd_no_error(
346 node, command, timeout=30, sudo=True, message=message
349 return stdout.strip()
352 def get_sriov_numvfs(node, pf_pci_addr):
353 """Get number of SR-IOV VFs.
355 :param node: DUT node.
356 :param pf_pci_addr: Physical Function PCI device address.
358 :type pf_pci_addr: str
359 :returns: Number of VFs.
361 :raises RuntimeError: If PCI device is not SR-IOV capable.
363 pci = pf_pci_addr.replace(u":", r"\:")
364 command = f"cat /sys/bus/pci/devices/{pci}/sriov_numvfs"
365 message = f"PCI device {pf_pci_addr} is not a SR-IOV device."
368 stdout, _ = exec_cmd_no_error(
369 node, command, timeout=30, sudo=True, message=message
372 sriov_numvfs = int(stdout)
375 f"Reading sriov_numvfs info failed on {node[u'host']}"
381 def set_sriov_numvfs(node, pf_pci_addr, numvfs=0):
382 """Init or reset SR-IOV virtual functions by setting its number on PCI
383 device on DUT. Setting to zero removes all VFs.
385 :param node: DUT node.
386 :param pf_pci_addr: Physical Function PCI device address.
387 :param numvfs: Number of VFs to initialize, 0 - removes the VFs.
389 :type pf_pci_addr: str
391 :raises RuntimeError: Failed to create VFs on PCI.
393 cmd = f"test -f /sys/bus/pci/devices/{pf_pci_addr}/sriov_numvfs"
394 sriov_unsupported, _, _ = exec_cmd(node, cmd)
395 # if sriov_numvfs doesn't exist, then sriov_unsupported != 0
396 if int(sriov_unsupported):
398 # sriov is not supported and we want 0 VFs
399 # no need to do anything
403 f"Can't configure {numvfs} VFs on {pf_pci_addr} device "
404 f"on {node[u'host']} since it doesn't support SR-IOV."
407 pci = pf_pci_addr.replace(u":", r"\:")
408 command = f"sh -c \"echo {numvfs} | " \
409 f"tee /sys/bus/pci/devices/{pci}/sriov_numvfs\""
410 message = f"Failed to create {numvfs} VFs on {pf_pci_addr} device " \
411 f"on {node[u'host']}"
414 node, command, timeout=120, sudo=True, message=message
418 def pci_driver_unbind(node, pci_addr):
419 """Unbind PCI device from current driver on node.
421 :param node: DUT node.
422 :param pci_addr: PCI device address.
425 :raises RuntimeError: If PCI device unbind failed.
427 pci = pci_addr.replace(u":", r"\:")
428 command = f"sh -c \"echo {pci_addr} | " \
429 f"tee /sys/bus/pci/devices/{pci}/driver/unbind\""
430 message = f"Failed to unbind PCI device {pci_addr} on {node[u'host']}"
433 node, command, timeout=120, sudo=True, message=message
437 def unbind_pci_devices_from_other_driver(node, driver, *pci_addrs):
438 """Unbind PCI devices from driver other than input driver on node.
440 :param node: DUT node.
441 :param driver: Driver to not unbind from. If None or empty string,
442 will attempt to unbind from the current driver.
443 :param pci_addrs: PCI device addresses.
446 :type pci_addrs: list
448 for pci_addr in pci_addrs:
449 cur_driver = DUTSetup.get_pci_dev_driver(node, pci_addr)
452 if not driver or cur_driver != driver:
453 DUTSetup.pci_driver_unbind(node, pci_addr)
456 def pci_driver_bind(node, pci_addr, driver):
457 """Bind PCI device to driver on node.
459 :param node: DUT node.
460 :param pci_addr: PCI device address.
461 :param driver: Driver to bind.
465 :raises RuntimeError: If PCI device bind failed.
467 message = f"Failed to bind PCI device {pci_addr} to {driver} " \
468 f"on host {node[u'host']}"
469 pci = pci_addr.replace(u":", r"\:")
470 command = f"sh -c \"echo {driver} | " \
471 f"tee /sys/bus/pci/devices/{pci}/driver_override\""
474 node, command, timeout=120, sudo=True, message=message
477 command = f"sh -c \"echo {pci_addr} | " \
478 f"tee /sys/bus/pci/drivers/{driver}/bind\""
481 node, command, timeout=120, sudo=True, message=message
484 command = f"sh -c \"echo | " \
485 f"tee /sys/bus/pci/devices/{pci}/driver_override\""
488 node, command, timeout=120, sudo=True, message=message
492 def pci_vf_driver_unbind(node, pf_pci_addr, vf_id):
493 """Unbind Virtual Function from driver on node.
495 :param node: DUT node.
496 :param pf_pci_addr: PCI device address.
497 :param vf_id: Virtual Function ID.
499 :type pf_pci_addr: str
501 :raises RuntimeError: If Virtual Function unbind failed.
503 vf_pci_addr = DUTSetup.get_virtfn_pci_addr(node, pf_pci_addr, vf_id)
504 pf_pci = pf_pci_addr.replace(u":", r"\:")
505 vf_path = f"/sys/bus/pci/devices/{pf_pci}/virtfn{vf_id}"
507 command = f"sh -c \"echo {vf_pci_addr} | tee {vf_path}/driver/unbind\""
508 message = f"Failed to unbind VF {vf_pci_addr} on {node[u'host']}"
511 node, command, timeout=120, sudo=True, message=message
515 def pci_vf_driver_bind(node, pf_pci_addr, vf_id, driver):
516 """Bind Virtual Function to driver on node.
518 :param node: DUT node.
519 :param pf_pci_addr: PCI device address.
520 :param vf_id: Virtual Function ID.
521 :param driver: Driver to bind.
523 :type pf_pci_addr: str
526 :raises RuntimeError: If PCI device bind failed.
528 vf_pci_addr = DUTSetup.get_virtfn_pci_addr(node, pf_pci_addr, vf_id)
529 pf_pci = pf_pci_addr.replace(u":", r'\:')
530 vf_path = f"/sys/bus/pci/devices/{pf_pci}/virtfn{vf_id}"
532 message = f"Failed to bind VF {vf_pci_addr} to {driver} " \
533 f"on {node[u'host']}"
534 command = f"sh -c \"echo {driver} | tee {vf_path}/driver_override\""
537 node, command, timeout=120, sudo=True, message=message
540 command = f"sh -c \"echo {vf_pci_addr} | " \
541 f"tee /sys/bus/pci/drivers/{driver}/bind\""
544 node, command, timeout=120, sudo=True, message=message
547 command = f"sh -c \"echo | tee {vf_path}/driver_override\""
550 node, command, timeout=120, sudo=True, message=message
554 def get_pci_dev_driver(node, pci_addr):
555 """Get current PCI device driver on node.
557 :param node: DUT node.
558 :param pci_addr: PCI device address.
561 :returns: Driver or None
562 :raises RuntimeError: If it is not possible to get the interface driver
563 information from the node.
565 driver_path = f"/sys/bus/pci/devices/{pci_addr}/driver"
566 cmd = f"test -d {driver_path}"
567 ret_code, ret_val, _ = exec_cmd(node, cmd)
569 # the directory doesn't exist which means the device is not bound
572 cmd = f"basename $(readlink -f {driver_path})"
573 ret_val, _ = exec_cmd_no_error(node, cmd)
574 return ret_val.strip()
577 def verify_kernel_module(node, module, force_load=False):
578 """Verify if kernel module is loaded on node. If parameter force
579 load is set to True, then try to load the modules.
582 :param module: Module to verify.
583 :param force_load: If True then try to load module.
586 :type force_load: bool
587 :raises RuntimeError: If module is not loaded or failed to load.
589 command = f"grep -w {module} /proc/modules"
590 message = f"Kernel module {module} is not loaded " \
591 f"on host {node[u'host']}"
595 node, command, timeout=30, sudo=False, message=message
599 # Module is not loaded and we want to load it
600 DUTSetup.load_kernel_module(node, module)
605 def verify_kernel_module_on_all_duts(nodes, module, force_load=False):
606 """Verify if kernel module is loaded on all DUTs. If parameter force
607 load is set to True, then try to load the modules.
609 :param nodes: DUT nodes.
610 :param module: Module to verify.
611 :param force_load: If True then try to load module.
614 :type force_load: bool
616 for node in nodes.values():
617 if node[u"type"] == NodeType.DUT:
618 DUTSetup.verify_kernel_module(node, module, force_load)
621 def verify_uio_driver_on_all_duts(nodes):
622 """Verify if uio driver kernel module is loaded on all DUTs. If module
623 is not present it will try to load it.
625 :param nodes: DUT nodes.
628 for node in nodes.values():
629 if node[u"type"] == NodeType.DUT:
630 uio_driver = Topology.get_uio_driver(node)
631 DUTSetup.verify_kernel_module(node, uio_driver, force_load=True)
634 def load_kernel_module(node, module):
635 """Load kernel module on node.
637 :param node: DUT node.
638 :param module: Module to load.
642 :raises RuntimeError: If loading failed.
644 command = f"modprobe {module}"
645 message = f"Failed to load {module} on host {node[u'host']}"
647 exec_cmd_no_error(node, command, timeout=30, sudo=True, message=message)
650 def running_in_container(node):
651 """This method tests if topology node is running inside container.
653 :param node: Topology node.
655 :returns: True if running in docker container, false if not or failed
659 command = "cat /.dockerenv"
661 exec_cmd_no_error(node, command, timeout=30)
667 def get_docker_mergeddir(node, uuid=None):
668 """Get Docker overlay for MergedDir diff.
670 :param node: DUT node.
671 :param uuid: Docker UUID.
674 :returns: Docker container MergedDir.
676 :raises RuntimeError: If getting output failed.
679 command = 'fgrep "hostname" /proc/self/mountinfo | cut -f 4 -d" "'
680 message = "Failed to get UUID!"
681 stdout, _ = exec_cmd_no_error(node, command, message=message)
682 uuid = stdout.split(sep="/")[-2]
685 f"--format='{{{{.GraphDriver.Data.MergedDir}}}}' {uuid}"
687 message = f"Failed to get directory of {uuid} on host {node[u'host']}"
689 stdout, _ = exec_cmd_no_error(node, command, sudo=True, message=message)
690 return stdout.strip()
693 def get_hugepages_info(node, hugesize=None):
694 """Get number of huge pages in system.
696 :param node: Node in the topology.
697 :param hugesize: Size of hugepages. Default system huge size if None.
700 :returns: Number of huge pages in system.
702 :raises RuntimeError: If reading failed.
705 hugesize = "$(grep Hugepagesize /proc/meminfo | awk '{ print $2 }')"
706 command = f"cat /sys/kernel/mm/hugepages/hugepages-{hugesize}kB/*"
707 stdout, _ = exec_cmd_no_error(node, command)
709 line = stdout.splitlines()
711 "free_hugepages": int(line[0]),
712 "nr_hugepages": int(line[1]),
713 "nr_hugepages_mempolicy": int(line[2]),
714 "nr_overcommit_hugepages": int(line[3]),
715 "resv_hugepages": int(line[4]),
716 "surplus_hugepages": int(line[5])
719 logger.trace(u"Reading huge pages information failed!")
723 node, huge_mnt, mem_size, hugesize=2048, allocate=False):
724 """Check if there is enough HugePages in system. If allocate is set to
725 true, try to allocate more HugePages.
727 :param node: Node in the topology.
728 :param huge_mnt: HugePage mount point.
729 :param mem_size: Reqeusted memory in MB.
730 :param hugesize: HugePage size in KB.
731 :param allocate: Whether to allocate more memory if not enough.
737 :raises RuntimeError: Mounting hugetlbfs failed or not enough HugePages
738 or increasing map count failed.
740 # Get huge pages information.
741 hugepages = DUTSetup.get_hugepages_info(node, hugesize=hugesize)
743 # Check if hugepages requested are available on node.
744 if hugepages[u"nr_overcommit_hugepages"]:
745 # If overcommit is used, we need to know how many additional pages
747 huge_available = hugepages[u"nr_overcommit_hugepages"] - \
748 hugepages[u"surplus_hugepages"]
750 # Fallbacking to free_hugepages which were used before to detect.
751 huge_available = hugepages[u"free_hugepages"]
753 if ((mem_size * 1024) // hugesize) > huge_available:
754 # If we want to allocate hugepage dynamically.
756 huge_needed = ((mem_size * 1024) // hugesize) - huge_available
757 huge_to_allocate = huge_needed + hugepages[u"nr_hugepages"]
758 max_map_count = huge_to_allocate * 4
759 # Check if huge pages mount point exist.
761 exec_cmd_no_error(node, u"fgrep 'hugetlbfs' /proc/mounts")
763 exec_cmd_no_error(node, f"mkdir -p {huge_mnt}", sudo=True)
766 f"mount -t hugetlbfs -o pagesize={hugesize}k none "
769 # Increase maximum number of memory map areas for process.
772 f"echo \"{max_map_count}\" | "
773 f"sudo tee /proc/sys/vm/max_map_count",
774 message=f"Increase map count failed on {node[u'host']}!"
776 # Increase hugepage count.
779 f"echo \"{huge_to_allocate}\" | "
780 f"sudo tee /proc/sys/vm/nr_hugepages",
781 message=f"Mount huge pages failed on {node[u'host']}!"
783 # If we do not want to allocate dynamically end with error.
786 f"Not enough availablehuge pages: {huge_available}!"