X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FVppConfigGenerator.py;h=5b2e883b973983406e37dcdbf3f697f85a1fed21;hb=HEAD;hp=d4ef04e65c3309ad0bb86dc3efb7dc7b24e13989;hpb=19afb923ce31fa51291d12b79d8b63cfce09ab14;p=csit.git diff --git a/resources/libraries/python/VppConfigGenerator.py b/resources/libraries/python/VppConfigGenerator.py index d4ef04e65c..fb3df2fc16 100644 --- a/resources/libraries/python/VppConfigGenerator.py +++ b/resources/libraries/python/VppConfigGenerator.py @@ -1,4 +1,4 @@ -# Copyright (c) 2016 Cisco and/or its affiliates. +# Copyright (c) 2024 Cisco and/or its affiliates. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at: @@ -11,458 +11,841 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""VPP Configuration File Generator library""" +"""VPP Configuration File Generator library.""" import re -import time -from robot.api import logger - -from resources.libraries.python.ssh import SSH +from resources.libraries.python.Constants import Constants +from resources.libraries.python.ssh import exec_cmd_no_error from resources.libraries.python.topology import NodeType from resources.libraries.python.topology import Topology +from resources.libraries.python.VPPUtil import VPPUtil -__all__ = ['VppConfigGenerator'] +__all__ = ["VppConfigGenerator", "VppInitConfig"] -# -# VPP configuration template. -# TODO: Do we need a better place for this? Somewhere in an external -# (template) file? -# Note: We're going to pass this through Python string Formatter, so -# any literal curly braces need to be escaped. -# -VPP_SERVICE_NAME = "vpp" -VPP_CONFIG_FILENAME = "/etc/vpp/startup.conf" -DEFAULT_SOCKETMEM_CONFIG = "1024,1024" -VPP_CONFIG_TEMPLATE = """ -unix {{ - nodaemon - log /tmp/vpe.log - cli-listen localhost:5002 - full-coredump -}} - -api-trace {{ - on -}} -{heapsizeconfig} -cpu {{ -{cpuconfig} -}} - -dpdk {{ - socket-mem {socketmemconfig} - dev default {{ - {rxqueuesconfig} - {txqueuesconfig} - }} -{pciconfig} -{nomultiseg} -{enablevhostuser} -}} - -ip6 {{ - hash-buckets 2000000 - heap-size 1G -}} - -""" -# End VPP configuration template. - - -class VppConfigGenerator(object): - """VPP Configuration File Generator""" - def __init__(self): - self._nodeconfig = {} +def pci_dev_check(pci_dev): + """Check if provided PCI address is in correct format. + + :param pci_dev: PCI address (expected format: xxxx:xx:xx.x). + :type pci_dev: str + :returns: True if PCI address is in correct format. + :rtype: bool + :raises ValueError: If PCI address is in incorrect format. + """ + pattern = re.compile( + r"^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}\.[0-9A-Fa-f]$" + ) + if not re.match(pattern, pci_dev): + raise ValueError( + f"PCI address {pci_dev} is not in valid format xxxx:xx:xx.x" + ) + return True + - def add_pci_all_devices(self, node): - """Add all PCI devices from topology file to startup config +class VppConfigGenerator: + """VPP Configuration File Generator.""" - :param node: DUT node + def __init__(self): + """Initialize library.""" + # VPP Node to apply configuration on + self._node = "" + # Topology node key + self._node_key = "" + # VPP Configuration + self._nodeconfig = dict() + # Serialized VPP Configuration + self._vpp_config = "" + # VPP Service name + self._vpp_service_name = "vpp" + # VPP Startup config location + self._vpp_startup_conf = "/etc/vpp/startup.conf" + + def set_node(self, node, node_key=None): + """Set DUT node. + + :param node: Node to store configuration on. + :param node_key: Topology node key. :type node: dict - :return: nothing + :type node_key: str + :raises RuntimeError: If Node type is not DUT. + """ + if node["type"] != NodeType.DUT: + raise RuntimeError( + "Startup config can only be applied to DUTnode." + ) + self._node = node + self._node_key = node_key + + def get_config_str(self): + """Get dumped startup configuration in VPP config format. + + :returns: Startup configuration in VPP config format. + :rtype: str + """ + self.dump_config(self._nodeconfig) + return self._vpp_config + + def add_config_item(self, config, value, path): + """Add startup configuration item. + + :param config: Startup configuration of node. + :param value: Value to insert. + :param path: Path where to insert item. + :type config: dict + :type value: str + :type path: list + """ + if len(path) == 1: + config[path[0]] = value + return + if path[0] not in config: + config[path[0]] = dict() + elif isinstance(config[path[0]], str): + config[path[0]] = dict() if config[path[0]] == "" \ + else {config[path[0]]: ""} + self.add_config_item(config[path[0]], value, path[1:]) + + def dump_config(self, obj, level=-1): + """Dump the startup configuration in VPP config format. + + :param obj: Python Object to print. + :param level: Nested level for indentation. + :type obj: Obj + :type level: int + :returns: nothing + """ + indent = " " + if level >= 0: + self._vpp_config += f"{level * indent}{{\n" + if isinstance(obj, dict): + for key, val in obj.items(): + if hasattr(val, u"__iter__") and not isinstance(val, str): + self._vpp_config += f"{(level + 1) * indent}{key}\n" + self.dump_config(val, level + 1) + else: + self._vpp_config += f"{(level + 1) * indent}{key} {val}\n" + else: + for val in obj: + self._vpp_config += f"{(level + 1) * indent}{val}\n" + if level >= 0: + self._vpp_config += f"{level * indent}}}\n" + + def add_unix_log(self, value="/var/log/vpp/vpp.log"): + """Add UNIX log configuration. + + :param value: Log file. + :type value: str """ - for port in node['interfaces'].keys(): - pci_addr = Topology.get_interface_pci_addr(node, port) - if pci_addr: - self.add_pci_device(node, pci_addr) + path = ["unix", "log"] + self.add_config_item(self._nodeconfig, value, path) + def add_unix_cli_listen(self, value="/run/vpp/cli.sock"): + """Add UNIX cli-listen configuration. - def add_pci_device(self, node, *pci_devices): - """Add PCI device configuration for node. + :param value: CLI listen address and port or path to CLI socket. + :type value: str + """ + path = ["unix", "cli-listen"] + self.add_config_item(self._nodeconfig, value, path) - :param node: DUT node. - :param pci_device: PCI devices (format 0000:00:00.0 or 00:00.0) - :type node: dict - :type pci_devices: tuple - :return: nothing - """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - - # Specific device was given. - hostname = Topology.get_node_hostname(node) - - pattern = re.compile("^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:" - "[0-9A-Fa-f]{2}\\.[0-9A-Fa-f]$") - for pci_device in pci_devices: - if not pattern.match(pci_device): - raise ValueError('PCI address {} to be added to host {} ' - 'is not in valid format xxxx:xx:xx.x'. - format(pci_device, hostname)) - - if hostname not in self._nodeconfig: - self._nodeconfig[hostname] = {} - if 'pci_addrs' not in self._nodeconfig[hostname]: - self._nodeconfig[hostname]['pci_addrs'] = [] - self._nodeconfig[hostname]['pci_addrs'].append(pci_device) - logger.debug('Adding PCI device {1} to {0}'.format(hostname, - pci_device)) - - def add_cpu_config(self, node, cpu_config): - """Add CPU configuration for node. - - :param node: DUT node. - :param cpu_config: CPU configuration option, as a string. - :type node: dict - :type cpu_config: str - :return: nothing - """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if hostname not in self._nodeconfig: - self._nodeconfig[hostname] = {} - if 'cpu_config' not in self._nodeconfig[hostname]: - self._nodeconfig[hostname]['cpu_config'] = [] - self._nodeconfig[hostname]['cpu_config'].append(cpu_config) - logger.debug('Adding {} to hostname {} CPU config'.format(hostname, - cpu_config)) - - def add_socketmem_config(self, node, socketmem_config): - """Add Socket Memory configuration for node. - - :param node: DUT node. - :param socketmem_config: Socket Memory configuration option, - as a string. - :type node: dict - :type socketmem_config: str - :return: nothing - """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if hostname not in self._nodeconfig: - self._nodeconfig[hostname] = {} - self._nodeconfig[hostname]['socketmem_config'] = socketmem_config - logger.debug('Setting hostname {} Socket Memory config to {}'. - format(hostname, socketmem_config)) - - def add_heapsize_config(self, node, heapsize_config): - """Add Heap Size configuration for node. - - :param node: DUT node. - :param heapsize_config: Heap Size configuration, as a string. - :type node: dict - :type heapsize_config: str - :return: nothing - """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if hostname not in self._nodeconfig: - self._nodeconfig[hostname] = {} - self._nodeconfig[hostname]['heapsize_config'] = heapsize_config - logger.debug('Setting hostname {} Heap Size config to {}'. - format(hostname, heapsize_config)) - - def add_rxqueues_config(self, node, rxqueues_config): - """Add Rx Queues configuration for node. - - :param node: DUT node. - :param rxqueues_config: Rxqueues configuration, as a string. - :type node: dict - :type rxqueues_config: str - :return: nothing - """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if not hostname in self._nodeconfig: - self._nodeconfig[hostname] = {} - if not 'rxqueues_config' in self._nodeconfig[hostname]: - self._nodeconfig[hostname]['rxqueues_config'] = [] - self._nodeconfig[hostname]['rxqueues_config'].append(rxqueues_config) - logger.debug('Setting hostname {} rxqueues config to {}'.\ - format(hostname, rxqueues_config)) - - def add_no_multi_seg_config(self, node): - """Add No Multi Seg configuration for node. - - :param node: DUT node. - :type node: dict - :return: nothing - """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if not hostname in self._nodeconfig: - self._nodeconfig[hostname] = {} - if not 'no_multi_seg_config' in self._nodeconfig[hostname]: - self._nodeconfig[hostname]['no_multi_seg_config'] = [] - self._nodeconfig[hostname]['no_multi_seg_config'].append( - "no-multi-seg") - logger.debug('Setting hostname {} config with {}'.\ - format(hostname, "no-multi-seg")) - - def add_enable_vhost_user_config(self, node): - """Add enable-vhost-user configuration for node. - - :param node: DUT node. - :type node: dict - :return: nothing - """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if not hostname in self._nodeconfig: - self._nodeconfig[hostname] = {} - if not 'enable_vhost_user' in self._nodeconfig[hostname]: - self._nodeconfig[hostname]['enable_vhost_user'] = [] - self._nodeconfig[hostname]['enable_vhost_user'].append( - "enable-vhost-user") - logger.debug('Setting hostname {} config with {}'.\ - format(hostname, "enable-vhost-user")) - - def remove_all_pci_devices(self, node): - """Remove PCI device configuration from node. - - :param node: DUT node. - :type node: dict - :return: nothing + def add_unix_cli_no_pager(self): + """Add UNIX cli-no-pager configuration.""" + path = ["unix", "cli-no-pager"] + self.add_config_item(self._nodeconfig, "", path) + + def add_unix_gid(self, value="vpp"): + """Add UNIX gid configuration. + + :param value: Gid. + :type value: str + """ + path = ["unix", "gid"] + self.add_config_item(self._nodeconfig, value, path) + + def add_unix_nodaemon(self): + """Add UNIX nodaemon configuration.""" + path = ["unix", "nodaemon"] + self.add_config_item(self._nodeconfig, "", path) + + def add_unix_coredump(self): + """Add UNIX full-coredump configuration.""" + path = ["unix", "full-coredump"] + self.add_config_item(self._nodeconfig, "", path) + + def add_unix_exec(self, value): + """Add UNIX exec configuration.""" + path = ["unix", "exec"] + self.add_config_item(self._nodeconfig, value, path) + + def add_socksvr(self, socket=Constants.SOCKSVR_PATH): + """Add socksvr configuration.""" + path = ["socksvr", "socket-name"] + self.add_config_item(self._nodeconfig, socket, path) + + def add_graph_node_variant(self, variant=Constants.GRAPH_NODE_VARIANT): + """Add default graph node variant. + + :param value: Graph node variant default value. + :type value: str + """ + if variant == "": + return + variant_list = ["hsw", "skx", "icl"] + if variant not in variant_list: + raise ValueError("Invalid graph node variant value") + path = ["node", "default", "variant"] + self.add_config_item(self._nodeconfig, variant, path) + + def add_api_segment_gid(self, value="vpp"): + """Add api-segment gid configuration. + + :param value: Gid. + :type value: str """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if hostname in self._nodeconfig: - self._nodeconfig[hostname]['pci_addrs'] = [] - logger.debug('Clearing all PCI devices for hostname {}.'. - format(hostname)) + path = ["api-segment", "gid"] + self.add_config_item(self._nodeconfig, value, path) - def remove_all_cpu_config(self, node): - """Remove CPU configuration from node. + def add_api_segment_global_size(self, value): + """Add api-segment global-size configuration. - :param node: DUT node. - :type node: dict - :return: nothing + :param value: Global size. + :type value: str """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if hostname in self._nodeconfig: - self._nodeconfig[hostname]['cpu_config'] = [] - logger.debug('Clearing all CPU config for hostname {}.'. - format(hostname)) + path = ["api-segment", "global-size"] + self.add_config_item(self._nodeconfig, value, path) - def remove_socketmem_config(self, node): - """Remove Socket Memory configuration from node. + def add_api_segment_prefix(self, value="vpp"): + """Add api-segment prefix configuration. - :param node: DUT node. - :type node: dict - :return: nothing + :param value: Gid. + :type value: str """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if hostname in self._nodeconfig: - self._nodeconfig[hostname].pop('socketmem_config', None) - logger.debug('Clearing Socket Memory config for hostname {}.'. - format(hostname)) + path = ["api-segment", "prefix"] + self.add_config_item(self._nodeconfig, value, path) - def remove_heapsize_config(self, node): - """Remove Heap Size configuration from node. + def add_api_segment_api_size(self, value): + """Add api-segment api-size configuration. - :param node: DUT node. - :type node: dict - :return: nothing + :param value: API size. + :type value: str """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if hostname in self._nodeconfig: - self._nodeconfig[hostname].pop('heapsize_config', None) - logger.debug('Clearing Heap Size config for hostname {}.'. - format(hostname)) + path = ["api-segment", "api-size"] + self.add_config_item(self._nodeconfig, value, path) - def remove_rxqueues_config(self, node): - """Remove Rxqueues configuration from node. + def add_buffers_per_numa(self, value): + """Increase number of buffers allocated. - :param node: DUT node. - :type node: dict - :return: nothing + :param value: Number of buffers allocated. + :type value: int """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if hostname in self._nodeconfig: - self._nodeconfig[hostname]['rxqueues_config'] = [] - logger.debug('Clearing rxqueues config for hostname {}.'.\ - format(hostname)) + path = ["buffers", "buffers-per-numa"] + self.add_config_item(self._nodeconfig, value, path) - def remove_no_multi_seg_config(self, node): - """Remove No Multi Seg configuration from node. + def add_buffers_default_data_size(self, value): + """Increase buffers data-size allocated. - :param node: DUT node. - :type node: dict - :return: nothing + :param value: Buffers data-size allocated. + :type value: int """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if hostname in self._nodeconfig: - self._nodeconfig[hostname]['no_multi_seg_config'] = [] - logger.debug('Clearing No Multi Seg config for hostname {}.'.\ - format(hostname)) + path = ["buffers", "default data-size"] + self.add_config_item(self._nodeconfig, value, path) - def remove_enable_vhost_user_config(self, node): - """Remove enable-vhost-user configuration from node. + def add_dpdk_dev(self, *devices): + """Add DPDK PCI device configuration. - :param node: DUT node. - :type node: dict - :return: nothing + :param devices: PCI device(s) (format xxxx:xx:xx.x) + :type devices: tuple + """ + for device in devices: + if pci_dev_check(device): + path = ["dpdk", f"dev {device}"] + self.add_config_item(self._nodeconfig, "", path) + + def add_dpdk_cryptodev(self, count, num_rx_queues=1): + """Add DPDK Crypto PCI device configuration. + + :param count: Number of HW crypto devices to add. + :param num_rx_queues: Number of RX queues per QAT interface. + :type count: int + :type num_rx_queues: int + """ + cryptodevs = Topology.get_cryptodev(self._node) + for device in cryptodevs.values(): + for i in range(int(count/len(cryptodevs))): + numvfs = device["numvfs"] + computed = f"{(i+1)//numvfs}.{(i+1)%numvfs}" + addr = re.sub(r"\d.\d$", computed, device["pci_address"]) + path = ["dpdk", f"dev {addr}", "num-rx-queues"] + self.add_config_item(self._nodeconfig, num_rx_queues, path) + self.add_dpdk_uio_driver("vfio-pci") + + def add_dpdk_sw_cryptodev(self, sw_pmd_type, socket_id, count): + """Add DPDK SW Crypto device configuration. + + :param sw_pmd_type: Type of SW crypto device PMD to add. + :param socket_id: Socket ID. + :param count: Number of SW crypto devices to add. + :type sw_pmd_type: str + :type socket_id: int + :type count: int """ - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - if hostname in self._nodeconfig: - self._nodeconfig[hostname]['enable_vhost_user'] = [] - logger.debug('Clearing enable-vhost-user config for hostname {}.'.\ - format(hostname)) + for _ in range(count): + cryptodev_config = f"vdev cryptodev_{sw_pmd_type}_pmd," \ + f"socket_id={str(socket_id)}" + path = ["dpdk", cryptodev_config] + self.add_config_item(self._nodeconfig, "", path) + + def add_dpdk_dev_default_devargs(self, value): + """Add DPDK dev default devargs configuration. + + :param value: DPDK devargs to pass to interface. + :type value: str + """ + path = ["dpdk", "dev default", "devargs"] + self.add_config_item(self._nodeconfig, value, path) + + def add_dpdk_dev_default_rxq(self, value): + """Add DPDK dev default rxq configuration. + + :param value: Default number of rxqs. + :type value: str + """ + path = ["dpdk", "dev default", "num-rx-queues"] + self.add_config_item(self._nodeconfig, value, path) + + def add_dpdk_dev_default_txq(self, value): + """Add DPDK dev default txq configuration. + + :param value: Default number of txqs. + :type value: str + """ + path = ["dpdk", "dev default", "num-tx-queues"] + self.add_config_item(self._nodeconfig, value, path) + + def add_dpdk_dev_default_rxd(self, value): + """Add DPDK dev default rxd configuration. - def apply_config(self, node, waittime=5, retries=12): - """Generate and apply VPP configuration for node. + :param value: Default number of rxds. + :type value: str + """ + path = ["dpdk", "dev default", "num-rx-desc"] + self.add_config_item(self._nodeconfig, value, path) + + def add_dpdk_dev_default_txd(self, value): + """Add DPDK dev default txd configuration. + + :param value: Default number of txds. + :type value: str + """ + path = ["dpdk", "dev default", "num-tx-desc"] + self.add_config_item(self._nodeconfig, value, path) + + def add_dpdk_dev_default_tso(self): + """Add DPDK dev default tso configuration.""" + path = ["dpdk", "dev default", "tso"] + self.add_config_item(self._nodeconfig, "on", path) + + def add_dpdk_log_level(self, value): + """Add DPDK log-level configuration. + + :param value: Log level. + :type value: str + """ + path = ["dpdk", "log-level"] + self.add_config_item(self._nodeconfig, value, path) + + def add_dpdk_no_pci(self): + """Add DPDK no-pci.""" + path = ["dpdk", "no-pci"] + self.add_config_item(self._nodeconfig, "", path) + + def add_dpdk_uio_driver(self, value=None): + """Add DPDK uio-driver configuration. + + :param value: DPDK uio-driver configuration. By default, driver will be + loaded automatically from Topology file, still leaving option + to manually override by parameter. + :type value: str + """ + if value is None: + value = Topology.get_uio_driver(self._node) + path = ["dpdk", "uio-driver"] + self.add_config_item(self._nodeconfig, value, path) + + def add_dpdk_max_simd_bitwidth(self, variant=Constants.GRAPH_NODE_VARIANT): + """Add DPDK max-simd-bitwidth configuration. + + :param value: Graph node variant default value. + :type value: str + """ + if variant == "icl": + value = 512 + elif variant in ["skx", "hsw"]: + value = 256 + else: + return + + path = ["dpdk", "max-simd-bitwidth"] + self.add_config_item(self._nodeconfig, value, path) + + def add_dpdk_enable_tcp_udp_checksum(self): + """Add DPDK enable-tcp-udp-checksum configuration.""" + path = ["dpdk", "enable-tcp-udp-checksum"] + self.add_config_item(self._nodeconfig, u"", path) + + def add_cpu_main_core(self, value): + """Add CPU main core configuration. + + :param value: Main core option. + :type value: str + """ + path = ["cpu", "main-core"] + self.add_config_item(self._nodeconfig, value, path) + + def add_cpu_corelist_workers(self, value): + """Add CPU corelist-workers configuration. + + :param value: Corelist-workers option. + :type value: str + """ + path = ["cpu", "corelist-workers"] + self.add_config_item(self._nodeconfig, value, path) + + def add_main_heap_size(self, value): + """Add Main Heap Size configuration. + + :param value: Amount of heap. + :type value: str + """ + path = ["memory", "main-heap-size"] + self.add_config_item(self._nodeconfig, value, path) + + def add_main_heap_page_size(self, value): + """Add Main Heap Page Size configuration. + + :param value: Heap page size. + :type value: str + """ + path = ["memory", "main-heap-page-size"] + self.add_config_item(self._nodeconfig, value, path) + + def add_default_hugepage_size(self, value=Constants.DEFAULT_HUGEPAGE_SIZE): + """Add Default Hugepage Size configuration. + + :param value: Hugepage size. + :type value: str + """ + path = ["memory", "default-hugepage-size"] + self.add_config_item(self._nodeconfig, value, path) + + def add_api_trace(self): + """Add API trace configuration.""" + path = ["api-trace", "on"] + self.add_config_item(self._nodeconfig, "", path) + + def add_ip6_hash_buckets(self, value): + """Add IP6 hash buckets configuration. + + :param value: Number of IP6 hash buckets. + :type value: str + """ + path = ["ip6", "hash-buckets"] + self.add_config_item(self._nodeconfig, value, path) + + def add_ip6_heap_size(self, value): + """Add IP6 heap-size configuration. + + :param value: IP6 Heapsize amount. + :type value: str + """ + path = ["ip6", "heap-size"] + self.add_config_item(self._nodeconfig, value, path) + + def add_ipsec_spd_flow_cache_ipv4_inbound(self, value): + """Add IPsec spd flow cache for IP4 inbound. + + :param value: "on" to enable spd flow cache. + :type value: str + """ + path = ["ipsec", "ipv4-inbound-spd-flow-cache"] + self.add_config_item(self._nodeconfig, value, path) + + def add_ipsec_spd_flow_cache_ipv4_outbound(self, value): + """Add IPsec spd flow cache for IP4 outbound. + + :param value: "on" to enable spd flow cache. + :type value: str + """ + path = ["ipsec", "ipv4-outbound-spd-flow-cache"] + self.add_config_item(self._nodeconfig, value, path) + + def add_ipsec_spd_fast_path_ipv4_inbound(self, value): + """Add IPsec spd fast path for IP4 inbound. + + :param value: "on" to enable spd fast path. + :type value: str + """ + path = ["ipsec", "ipv4-inbound-spd-fast-path"] + self.add_config_item(self._nodeconfig, value, path) + + def add_ipsec_spd_fast_path_ipv4_outbound(self, value): + """Add IPsec spd fast path for IP4 outbound. + + :param value: "on" to enable spd fast path. + :type value: str + """ + path = ["ipsec", "ipv4-outbound-spd-fast-path"] + self.add_config_item(self._nodeconfig, value, path) + + def add_ipsec_spd_fast_path_num_buckets(self, value): + """Add num buckets for IPsec spd fast path. + + :param value: Number of buckets. + :type value: int + """ + path = ["ipsec", "spd-fast-path-num-buckets"] + self.add_config_item(self._nodeconfig, value, path) + + def add_statseg_size(self, value): + """Add Stats Heap Size configuration. + + :param value: Stats heapsize amount. + :type value: str + """ + path = ["statseg", "size"] + self.add_config_item(self._nodeconfig, value, path) + + def add_statseg_page_size(self, value): + """Add Stats Heap Page Size configuration. + + :param value: Stats heapsize amount. + :type value: str + """ + path = ["statseg", "page-size"] + self.add_config_item(self._nodeconfig, value, path) + + def add_statseg_per_node_counters(self, value): + """Add stats per-node-counters configuration. + + :param value: "on" to switch the counters on. + :type value: str + """ + path = ["statseg", "per-node-counters"] + self.add_config_item(self._nodeconfig, value, path) + + def add_plugin(self, state, *plugins): + """Add plugin section for specific plugin(s). + + :param state: State of plugin [enable|disable]. + :param plugins: Plugin(s) to disable. + :type state: str + :type plugins: list + """ + for plugin in plugins: + path = ["plugins", f"plugin {plugin}", state] + self.add_config_item(self._nodeconfig, " ", path) + + def add_dpdk_no_multi_seg(self): + """Add DPDK no-multi-seg configuration.""" + path = ["dpdk", "no-multi-seg"] + self.add_config_item(self._nodeconfig, "", path) + + def add_dpdk_enable_tcp_udp_checksum(self): + """Add DPDK enable-tcp-udp-checksum configuration.""" + path = ["dpdk", "enable-tcp-udp-checksum"] + self.add_config_item(self._nodeconfig, "", path) + + def add_dpdk_no_tx_checksum_offload(self): + """Add DPDK no-tx-checksum-offload configuration.""" + path = ["dpdk", "no-tx-checksum-offload"] + self.add_config_item(self._nodeconfig, "", path) + + def add_nat(self, value="deterministic"): + """Add NAT mode configuration. + + :param value: NAT mode. + :type value: str + """ + path = ["nat", value] + self.add_config_item(self._nodeconfig, "", path) + + def add_nat_max_translations_per_thread(self, value): + """Add NAT max. translations per thread number configuration. + + :param value: NAT mode. + :type value: str + """ + path = ["nat", "max translations per thread"] + self.add_config_item(self._nodeconfig, value, path) + + def add_nsim_poll_main_thread(self): + """Add NSIM poll-main-thread configuration.""" + path = ["nsim", "poll-main-thread"] + self.add_config_item(self._nodeconfig, "", path) + + def add_tcp_congestion_control_algorithm(self, value="cubic"): + """Add TCP congestion control algorithm. + + :param value: The congestion control algorithm to use. Example: cubic + :type value: str + """ + path = ["tcp", "cc-algo"] + self.add_config_item(self._nodeconfig, value, path) + + def add_tcp_preallocated_connections(self, value): + """Add TCP pre-allocated connections. + + :param value: The number of pre-allocated connections. + :type value: int + """ + path = ["tcp", "preallocated-connections"] + self.add_config_item(self._nodeconfig, value, path) + + def add_tcp_preallocated_half_open_connections(self, value): + """Add TCP pre-allocated half open connections. + + :param value: The number of pre-allocated half open connections. + :type value: int + """ + path = ["tcp", "preallocated-half-open-connections"] + self.add_config_item(self._nodeconfig, value, path) + + def add_tcp_tso(self): + """Add TCP tso configuration.""" + path = ["tcp", "tso"] + self.add_config_item(self._nodeconfig, "", path) + + def add_session_enable(self): + """Add session enable.""" + path = ["session", "enable"] + self.add_config_item(self._nodeconfig, "", path) + + def add_session_app_socket_api(self): + """Use session app socket api.""" + path = ["session", "use-app-socket-api"] + self.add_config_item(self._nodeconfig, "", path) + + def add_session_event_queues_memfd_segment(self): + """Add session event queue memfd segment.""" + path = ["session", "evt_qs_memfd_seg"] + self.add_config_item(self._nodeconfig, "", path) + + def add_session_event_queue_length(self, value): + """Add session event queue length. + + :param value: Session event queue length. + :type value: int + """ + path = ["session", "event-queue-length"] + self.add_config_item(self._nodeconfig, value, path) + + def add_session_event_queues_segment_size(self, value): + """Add session event queue length. + + :param value: Session event queue segment size. + :type value: str + """ + path = ["session", "evt_qs_seg_size"] + self.add_config_item(self._nodeconfig, value, path) + + def add_session_preallocated_sessions(self, value): + """Add the number of pre-allocated sessions. + + :param value: Number of pre-allocated sessions. + :type value: int + """ + path = ["session", "preallocated-sessions"] + self.add_config_item(self._nodeconfig, value, path) + + def add_session_v4_session_table_buckets(self, value): + """Add number of v4 session table buckets to the config. + + :param value: Number of v4 session table buckets. + :type value: int + """ + path = ["session", "v4-session-table-buckets"] + self.add_config_item(self._nodeconfig, value, path) + + def add_session_v4_session_table_memory(self, value): + """Add the size of v4 session table memory. + + :param value: Size of v4 session table memory. + :type value: str + """ + path = ["session", "v4-session-table-memory"] + self.add_config_item(self._nodeconfig, value, path) + + def add_session_v4_halfopen_table_buckets(self, value): + """Add the number of v4 halfopen table buckets. + + :param value: Number of v4 halfopen table buckets. + :type value: int + """ + path = ["session", "v4-halfopen-table-buckets"] + self.add_config_item(self._nodeconfig, value, path) + + def add_session_v4_halfopen_table_memory(self, value): + """Add the size of v4 halfopen table memory. + + :param value: Size of v4 halfopen table memory. + :type value: str + """ + path = ["session", "v4-halfopen-table-memory"] + self.add_config_item(self._nodeconfig, value, path) + + def add_session_local_endpoints_table_buckets(self, value): + """Add the number of local endpoints table buckets. + + :param value: Number of local endpoints table buckets. + :type value: int + """ + path = ["session", "local-endpoints-table-buckets"] + self.add_config_item(self._nodeconfig, value, path) + + def add_session_local_endpoints_table_memory(self, value): + """Add the size of local endpoints table memory. + + :param value: Size of local endpoints table memory. + :type value: str + """ + path = ["session", "local-endpoints-table-memory"] + self.add_config_item(self._nodeconfig, value, path) + + def add_session_use_dma(self): + """Add session use-dma configuration.""" + path = [u"session", u"use-dma"] + self.add_config_item(self._nodeconfig, u"", path) + + def add_dma_dev(self, devices): + """Add DMA devices configuration. + + :param devices: DMA devices or work queues. + :type devices: list + """ + for device in devices: + path = ["dsa", f"dev {device}"] + self.add_config_item(self._nodeconfig, "", path) + + def add_logging_default_syslog_log_level(self, value="debug"): + """Add default logging level for syslog. + + :param value: Log level. + :type value: str + """ + path = ["logging", "default-syslog-log-level"] + self.add_config_item(self._nodeconfig, value, path) + + def write_config(self, filename=None): + """Generate and write VPP startup configuration to file. + + Use data from calls to this class to form a startup.conf file and + replace /etc/vpp/startup.conf with it on topology node. + + :param filename: Startup configuration file name. + :type filename: str + """ + self.dump_config(self._nodeconfig) + + if filename is None: + filename = self._vpp_startup_conf + + cmd = f"echo \"{self._vpp_config}\" | sudo tee {filename}" + exec_cmd_no_error( + self._node, cmd, message="Writing config file failed!" + ) + + def apply_config(self, filename=None, verify_vpp=True): + """Generate and write VPP startup configuration to file and restart VPP. Use data from calls to this class to form a startup.conf file and - replace /etc/vpp/startup.conf with it on node. + replace /etc/vpp/startup.conf with it on topology node. + + :param filename: Startup configuration file name. + :param verify_vpp: Verify VPP is running after restart. + :type filename: str + :type verify_vpp: bool + """ + self.write_config(filename=filename) - :param node: DUT node. - :param waittime: Time to wait for VPP to restart (default 5 seconds). - :param retries: Number of times (default 12) to re-try waiting. + VPPUtil.restart_vpp_service(self._node, self._node_key) + if verify_vpp: + VPPUtil.verify_vpp(self._node) + + +class VppInitConfig: + """VPP Initial Configuration.""" + @staticmethod + def init_vpp_startup_configuration_on_all_duts(nodes): + """Apply initial VPP startup configuration on all DUTs. + + :param nodes: Nodes in the topology. + :type nodes: dict + """ + huge_size = Constants.DEFAULT_HUGEPAGE_SIZE + for node in nodes.values(): + if node["type"] == NodeType.DUT: + vpp_config = VppConfigGenerator() + vpp_config.set_node(node) + vpp_config.add_unix_log() + vpp_config.add_unix_cli_listen() + vpp_config.add_unix_cli_no_pager() + vpp_config.add_unix_gid() + vpp_config.add_unix_coredump() + vpp_config.add_socksvr(socket=Constants.SOCKSVR_PATH) + vpp_config.add_main_heap_size("2G") + vpp_config.add_main_heap_page_size(huge_size) + vpp_config.add_default_hugepage_size(huge_size) + vpp_config.add_statseg_size("2G") + vpp_config.add_statseg_page_size(huge_size) + vpp_config.add_statseg_per_node_counters("on") + vpp_config.add_plugin("disable", "default") + vpp_config.add_plugin("enable", "dpdk_plugin.so") + vpp_config.add_dpdk_dev( + *[node["interfaces"][interface].get("pci_address") \ + for interface in node["interfaces"]] + ) + vpp_config.add_ip6_hash_buckets(2000000) + vpp_config.add_ip6_heap_size("4G") + vpp_config.apply_config() + + @staticmethod + def create_vpp_startup_configuration_container(node, cpuset_cpus=None): + """Create base startup configuration of VPP on container. + + :param node: Node in the topology. + :param cpuset_cpus: List of CPU cores to allocate. :type node: dict - :type waittime: int - :type retries: int - """ - - if node['type'] != NodeType.DUT: - raise ValueError('Node type is not a DUT') - hostname = Topology.get_node_hostname(node) - - cpuconfig = "" - pciconfig = "" - socketmemconfig = DEFAULT_SOCKETMEM_CONFIG - heapsizeconfig = "" - rxqueuesconfig = "" - txqueuesconfig = "" - nomultiseg = "" - enablevhostuser = "" - - if hostname in self._nodeconfig: - cfg = self._nodeconfig[hostname] - if 'cpu_config' in cfg: - cpuconfig = " " + "\n ".join(cfg['cpu_config']) - - if 'pci_addrs' in cfg: - pciconfig = " dev " + "\n dev ".join(cfg['pci_addrs']) - - if 'socketmem_config' in cfg: - socketmemconfig = cfg['socketmem_config'] - - if 'heapsize_config' in cfg: - heapsizeconfig = "\nheapsize {}\n".\ - format(cfg['heapsize_config']) - - if 'rxqueues_config' in cfg: - rxqueuesconfig = " " + "\n ".join(cfg['rxqueues_config']) - - if 'no_multi_seg_config' in cfg: - nomultiseg = " " + "\n ".join(cfg['no_multi_seg_config']) - - if 'enable_vhost_user' in cfg: - enablevhostuser = " " + "\n ".join(cfg['enable_vhost_user']) - - vppconfig = VPP_CONFIG_TEMPLATE.format(cpuconfig=cpuconfig, - pciconfig=pciconfig, - socketmemconfig=socketmemconfig, - heapsizeconfig=heapsizeconfig, - rxqueuesconfig=rxqueuesconfig, - txqueuesconfig=txqueuesconfig, - nomultiseg=nomultiseg, - enablevhostuser=enablevhostuser) - - logger.debug('Writing VPP config to host {}: "{}"'.format(hostname, - vppconfig)) - - ssh = SSH() - ssh.connect(node) - - # We're using this "| sudo tee" construct because redirecting - # a sudo'd outut ("sudo echo xxx > /path/to/file") does not - # work on most platforms... - (ret, stdout, stderr) = \ - ssh.exec_command('echo "{0}" | sudo tee {1}'. - format(vppconfig, VPP_CONFIG_FILENAME)) - - if ret != 0: - logger.debug('Writing config file failed to node {}'. - format(hostname)) - logger.debug('stdout: {}'.format(stdout)) - logger.debug('stderr: {}'.format(stderr)) - raise RuntimeError('Writing config file failed to node {}'. - format(hostname)) - - # Instead of restarting, we'll do separate start and stop - # actions. This way we don't care whether VPP was running - # to begin with. - ssh.exec_command('sudo initctl stop {}'.format(VPP_SERVICE_NAME)) - (ret, stdout, stderr) = \ - ssh.exec_command('sudo initctl start {}'.format(VPP_SERVICE_NAME)) - if ret != 0: - logger.debug('Restarting VPP failed on node {}'. - format(hostname)) - logger.debug('stdout: {}'.format(stdout)) - logger.debug('stderr: {}'.format(stderr)) - raise RuntimeError('Restarting VPP failed on node {}'. - format(hostname)) - - # Sleep seconds, up to times, - # and verify if VPP is running. - vpp_is_running = False - retries_left = retries - while (not vpp_is_running) and (retries_left > 0): - time.sleep(waittime) - retries_left -= 1 - - # FIXME: Need to find a good way to check if VPP is operational. - # - # If VatTerminal/VatExecutor is anything like vppctl or - # vpp_api_test, then in case VPP is NOT running it will block for - # 30 seconds or so and not even return if VPP becomes alive during - # that time. This makes it unsuitable in this case. We either need - # a call that returns immediately, indicating whether VPP is - # healthy or not, or a call that waits (up to a defined length - # of time) and returns immediately if VPP is or becomes healthy. - (ret, stdout, stderr) = \ - ssh.exec_command('echo show hardware-interfaces | ' - 'nc 0 5002') - - if ret == 0: - vpp_is_running = True - else: - logger.debug('VPP not yet running, {} retries left'. - format(retries_left)) - if retries_left == 0: - raise RuntimeError('VPP failed to restart on node {}'. - format(hostname)) - logger.debug('VPP interfaces found on node {}'. - format(stdout)) + :type cpuset_cpus: list. + :returns: Base VPP startup configuration for container. + :rtype: VppConfigGenerator + """ + huge_size = Constants.DEFAULT_HUGEPAGE_SIZE + + vpp_config = VppConfigGenerator() + vpp_config.set_node(node) + vpp_config.add_unix_log() + vpp_config.add_unix_cli_listen() + vpp_config.add_unix_cli_no_pager() + vpp_config.add_unix_exec("/tmp/running.exec") + vpp_config.add_socksvr(socket=Constants.SOCKSVR_PATH) + if cpuset_cpus: + # We will pop the first core from the list to be a main core + vpp_config.add_cpu_main_core(str(cpuset_cpus.pop(0))) + # If more cores in the list, the rest will be used as workers. + corelist_workers = ",".join(str(cpu) for cpu in cpuset_cpus) + vpp_config.add_cpu_corelist_workers(corelist_workers) + vpp_config.add_buffers_per_numa(215040) + vpp_config.add_plugin("disable", "default") + vpp_config.add_plugin("enable", "memif_plugin.so") + vpp_config.add_plugin("enable", "perfmon_plugin.so") + vpp_config.add_main_heap_size("2G") + vpp_config.add_main_heap_page_size(huge_size) + vpp_config.add_default_hugepage_size(huge_size) + vpp_config.add_statseg_size("2G") + vpp_config.add_statseg_page_size(huge_size) + vpp_config.add_statseg_per_node_counters("on") + vpp_config.add_ip6_hash_buckets(2000000) + vpp_config.add_ip6_heap_size("4G") + + return vpp_config