X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FVppConfigGenerator.py;h=b5f36c69a0c7506fe0d0cfe70b132f65e319802a;hp=dac8bae6bbe71f9d61792fa6f53b3793bbb65fca;hb=82863d5b8422b1b817d86bd6b1829a06a49feb02;hpb=2bdb1dc59ba736546a6663cbaf55b6edbcac6eab diff --git a/resources/libraries/python/VppConfigGenerator.py b/resources/libraries/python/VppConfigGenerator.py index dac8bae6bb..b5f36c69a0 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) 2021 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,55 +11,105 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""VPP Configuration File Generator library.""" +"""VPP Configuration File Generator library. + +TODO: Support initialization with default values, +so that we do not need to have block of 6 "Add Unix" commands +in 7 various places of CSIT code. +""" import re -import time -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__ = [u"VppConfigGenerator"] + + +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 -__all__ = ['VppConfigGenerator'] -class VppConfigGenerator(object): +class VppConfigGenerator: """VPP Configuration File Generator.""" def __init__(self): + """Initialize library.""" # VPP Node to apply configuration on - self._node = '' - # VPP Hostname - self._hostname = '' + self._node = u"" + # Topology node key + self._node_key = u"" # VPP Configuration - self._nodeconfig = {} + self._nodeconfig = dict() # Serialized VPP Configuration - self._vpp_config = '' + self._vpp_config = u"" # VPP Service name - self._vpp_service_name = 'vpp' - # VPP Configuration file path - self._vpp_config_filename = '/etc/vpp/startup.conf' - - def set_node(self, node): + self._vpp_service_name = u"vpp" + # VPP Logfile location + self._vpp_logfile = u"/tmp/vpe.log" + # VPP Startup config location + self._vpp_startup_conf = u"/etc/vpp/startup.conf" + # VPP Startup config backup location + self._vpp_startup_conf_backup = None + + 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 + :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 DUT' - 'node.') + if node[u"type"] != NodeType.DUT: + raise RuntimeError( + u"Startup config can only be applied to DUTnode." + ) self._node = node - self._hostname = Topology.get_node_hostname(node) + self._node_key = node_key - def set_config_filename(self, filename): - """Set startup configuration filename. + def set_vpp_logfile(self, logfile): + """Set VPP logfile location. - :param filename: Startup configuration filename. - :type filename: str + :param logfile: VPP logfile location. + :type logfile: str + """ + self._vpp_logfile = logfile + + def set_vpp_startup_conf_backup(self, backup=u"/etc/vpp/startup.backup"): + """Set VPP startup configuration backup. + + :param backup: VPP logfile location. + :type backup: str """ - self._vpp_config_filename = filename + self._vpp_startup_conf_backup = backup + + 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. @@ -71,67 +121,147 @@ class VppConfigGenerator(object): :type value: str :type path: list """ - if len(path) == 1: config[path[0]] = value return - if not config.has_key(path[0]): - config[path[0]] = {} + if path[0] not in config: + config[path[0]] = dict() + elif isinstance(config[path[0]], str): + config[path[0]] = dict() if config[path[0]] == u"" \ + else {config[path[0]]: u""} 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 nested_level: Nested level for indentation. + :param level: Nested level for indentation. :type obj: Obj - :type nested_level: int + :type level: int :returns: nothing """ - indent = ' ' + indent = u" " if level >= 0: - self._vpp_config += '{}{{\n'.format((level) * indent) + self._vpp_config += f"{level * indent}{{\n" if isinstance(obj, dict): for key, val in obj.items(): - if hasattr(val, '__iter__'): - self._vpp_config += '{}{}\n'.format((level + 1) * indent, - key) + 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 += '{}{} {}\n'.format((level + 1) * indent, - key, val) + self._vpp_config += f"{(level + 1) * indent}{key} {val}\n" else: for val in obj: - self._vpp_config += '{}{}\n'.format((level + 1) * indent, val) + self._vpp_config += f"{(level + 1) * indent}{val}\n" if level >= 0: - self._vpp_config += '{}}}\n'.format(level * indent) + self._vpp_config += f"{level * indent}}}\n" - def add_unix_log(self, value='/tmp/vpe.log'): + def add_unix_log(self, value=None): """Add UNIX log configuration. :param value: Log file. :type value: str """ - path = ['unix', 'log'] + path = [u"unix", u"log"] + if value is None: + value = self._vpp_logfile self.add_config_item(self._nodeconfig, value, path) - def add_unix_cli_listen(self, value='localhost:5002'): + def add_unix_cli_listen(self, value=u"/run/vpp/cli.sock"): """Add UNIX cli-listen configuration. - :param value: CLI listen address and port. + :param value: CLI listen address and port or path to CLI socket. :type value: str """ - path = ['unix', 'cli-listen'] + path = [u"unix", u"cli-listen"] + self.add_config_item(self._nodeconfig, value, path) + + def add_unix_gid(self, value=u"vpp"): + """Add UNIX gid configuration. + + :param value: Gid. + :type value: str + """ + path = [u"unix", u"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) + path = [u"unix", u"nodaemon"] + self.add_config_item(self._nodeconfig, u"", path) + + def add_unix_coredump(self): + """Add UNIX full-coredump configuration.""" + path = [u"unix", u"full-coredump"] + self.add_config_item(self._nodeconfig, u"", path) def add_unix_exec(self, value): """Add UNIX exec configuration.""" - path = ['unix', 'exec'] + path = [u"unix", u"exec"] + self.add_config_item(self._nodeconfig, value, path) + + def add_socksvr(self, socket=Constants.SOCKSVR_PATH): + """Add socksvr configuration.""" + path = [u"socksvr", u"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 == u"": + return + variant_list = [u"hsw", u"skx", u"icl"] + if variant not in variant_list: + raise ValueError("Invalid graph node variant value") + path = [u"node", u"default", u"variant"] + self.add_config_item(self._nodeconfig, variant, path) + + def add_api_segment_gid(self, value=u"vpp"): + """Add API-SEGMENT gid configuration. + + :param value: Gid. + :type value: str + """ + path = [u"api-segment", u"gid"] + self.add_config_item(self._nodeconfig, value, path) + + def add_api_segment_global_size(self, value): + """Add API-SEGMENT global-size configuration. + + :param value: Global size. + :type value: str + """ + path = [u"api-segment", u"global-size"] + self.add_config_item(self._nodeconfig, value, path) + + def add_api_segment_api_size(self, value): + """Add API-SEGMENT api-size configuration. + + :param value: API size. + :type value: str + """ + path = [u"api-segment", u"api-size"] + self.add_config_item(self._nodeconfig, value, path) + + def add_buffers_per_numa(self, value): + """Increase number of buffers allocated. + + :param value: Number of buffers allocated. + :type value: int + """ + path = [u"buffers", u"buffers-per-numa"] + self.add_config_item(self._nodeconfig, value, path) + + def add_buffers_default_data_size(self, value): + """Increase buffers data-size allocated. + + :param value: Buffers data-size allocated. + :type value: int + """ + path = [u"buffers", u"default data-size"] self.add_config_item(self._nodeconfig, value, path) def add_dpdk_dev(self, *devices): @@ -139,32 +269,54 @@ class VppConfigGenerator(object): :param devices: PCI device(s) (format xxxx:xx:xx.x) :type devices: tuple - :raises ValueError: If PCI address format is not valid. """ - - pattern = re.compile("^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:" - "[0-9A-Fa-f]{2}\\.[0-9A-Fa-f]$") for device in devices: - if not pattern.match(device): - raise ValueError('PCI address {} to be added to host {} ' - 'is not in valid format xxxx:xx:xx.x'. - format(device, self._hostname)) - path = ['dpdk', 'dev {0}'.format(device)] - self.add_config_item(self._nodeconfig, '', path) + if pci_dev_check(device): + path = [u"dpdk", f"dev {device}"] + self.add_config_item(self._nodeconfig, u"", path) + + def add_dpdk_dev_parameter(self, device, parameter, value): + """Add parameter for DPDK device. + + :param device: PCI device (format xxxx:xx:xx.x). + :param parameter: Parameter name. + :param value: Parameter value. + :type device: str + :type parameter: str + :type value: str + """ + if pci_dev_check(device): + path = [u"dpdk", f"dev {device}", parameter] + self.add_config_item(self._nodeconfig, value, path) def add_dpdk_cryptodev(self, count): """Add DPDK Crypto PCI device configuration. - :param count: Number of crypto devices to add. + :param count: Number of HW crypto devices to add. :type count: int """ cryptodev = Topology.get_cryptodev(self._node) for i in range(count): - cryptodev_config = 'dev {0}'.format( - re.sub(r'\d.\d$', '1.'+str(i), cryptodev)) - path = ['dpdk', cryptodev_config] - self.add_config_item(self._nodeconfig, '', path) - self.add_dpdk_uio_driver('igb_uio') + cryptodev_config = re.sub(r"\d.\d$", f"1.{str(i)}", cryptodev) + path = [u"dpdk", f"dev {cryptodev_config}"] + self.add_config_item(self._nodeconfig, u"", path) + self.add_dpdk_uio_driver(u"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 + """ + for _ in range(count): + cryptodev_config = f"vdev cryptodev_{sw_pmd_type}_pmd," \ + f"socket_id={str(socket_id)}" + path = [u"dpdk", cryptodev_config] + self.add_config_item(self._nodeconfig, u"", path) def add_dpdk_dev_default_rxq(self, value): """Add DPDK dev default rxq configuration. @@ -172,7 +324,7 @@ class VppConfigGenerator(object): :param value: Default number of rxqs. :type value: str """ - path = ['dpdk', 'dev default', 'num-rx-queues'] + path = [u"dpdk", u"dev default", u"num-rx-queues"] self.add_config_item(self._nodeconfig, value, path) def add_dpdk_dev_default_txq(self, value): @@ -181,7 +333,7 @@ class VppConfigGenerator(object): :param value: Default number of txqs. :type value: str """ - path = ['dpdk', 'dev default', 'num-tx-queues'] + path = [u"dpdk", u"dev default", u"num-tx-queues"] self.add_config_item(self._nodeconfig, value, path) def add_dpdk_dev_default_rxd(self, value): @@ -190,7 +342,7 @@ class VppConfigGenerator(object): :param value: Default number of rxds. :type value: str """ - path = ['dpdk', 'dev default', 'num-rx-desc'] + path = [u"dpdk", u"dev default", u"num-rx-desc"] self.add_config_item(self._nodeconfig, value, path) def add_dpdk_dev_default_txd(self, value): @@ -199,26 +351,50 @@ class VppConfigGenerator(object): :param value: Default number of txds. :type value: str """ - path = ['dpdk', 'dev default', 'num-tx-desc'] + path = [u"dpdk", u"dev default", u"num-tx-desc"] self.add_config_item(self._nodeconfig, value, path) + def add_dpdk_log_level(self, value): + """Add DPDK log-level configuration. - def add_dpdk_socketmem(self, value): - """Add DPDK socket memory configuration. - - :param value: Socket memory size. + :param value: Log level. :type value: str """ - path = ['dpdk', 'socket-mem'] + path = [u"dpdk", u"log-level"] self.add_config_item(self._nodeconfig, value, path) - def add_dpdk_uio_driver(self, value): + def add_dpdk_no_pci(self): + """Add DPDK no-pci.""" + path = [u"dpdk", u"no-pci"] + self.add_config_item(self._nodeconfig, u"", path) + + def add_dpdk_uio_driver(self, value=None): """Add DPDK uio-driver configuration. - :param value: 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 """ - path = ['dpdk', 'uio-driver'] + if value is None: + value = Topology.get_uio_driver(self._node) + path = [u"dpdk", u"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 == u"icl": + value = 512 + elif variant in [u"skx", u"hsw"]: + value = 256 + else: + return + + path = [u"dpdk", u"max-simd-bitwidth"] self.add_config_item(self._nodeconfig, value, path) def add_cpu_main_core(self, value): @@ -227,7 +403,7 @@ class VppConfigGenerator(object): :param value: Main core option. :type value: str """ - path = ['cpu', 'main-core'] + path = [u"cpu", u"main-core"] self.add_config_item(self._nodeconfig, value, path) def add_cpu_corelist_workers(self, value): @@ -236,22 +412,31 @@ class VppConfigGenerator(object): :param value: Corelist-workers option. :type value: str """ - path = ['cpu', 'corelist-workers'] + path = [u"cpu", u"corelist-workers"] self.add_config_item(self._nodeconfig, value, path) - def add_heapsize(self, value): - """Add Heapsize configuration. + def add_main_heap_size(self, value): + """Add Main Heap Size configuration. - :param value: Amount of heapsize. + :param value: Amount of heap. :type value: str """ - path = ['heapsize'] + path = [u"memory", u"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 = [u"memory", u"main-heap-page-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) + path = [u"api-trace", u"on"] + self.add_config_item(self._nodeconfig, u"", path) def add_ip6_hash_buckets(self, value): """Add IP6 hash buckets configuration. @@ -259,7 +444,7 @@ class VppConfigGenerator(object): :param value: Number of IP6 hash buckets. :type value: str """ - path = ['ip6', 'hash-buckets'] + path = [u"ip6", u"hash-buckets"] self.add_config_item(self._nodeconfig, value, path) def add_ip6_heap_size(self, value): @@ -268,142 +453,244 @@ class VppConfigGenerator(object): :param value: IP6 Heapsize amount. :type value: str """ - path = ['ip6', 'heap-size'] + path = [u"ip6", u"heap-size"] + 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 = [u"statseg", u"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 = [u"statseg", u"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 = [u"statseg", u"per-node-counters"] self.add_config_item(self._nodeconfig, value, path) - def add_plugin_disable(self, *plugins): - """Add plugin disable for specific plugin. + 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', 'plugin {0}'.format(plugin), 'disable'] - self.add_config_item(self._nodeconfig, ' ', path) + path = [u"plugins", f"plugin {plugin}", state] + self.add_config_item(self._nodeconfig, u" ", 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) + path = [u"dpdk", u"no-multi-seg"] + self.add_config_item(self._nodeconfig, u"", path) + + def add_dpdk_no_tx_checksum_offload(self): + """Add DPDK no-tx-checksum-offload configuration.""" + path = [u"dpdk", u"no-tx-checksum-offload"] + self.add_config_item(self._nodeconfig, u"", path) + + def add_nat(self, value=u"deterministic"): + """Add NAT mode configuration. - def add_nat(self, value='deterministic'): - """Add NAT configuration. + :param value: NAT mode. + :type value: str + """ + path = [u"nat", value] + self.add_config_item(self._nodeconfig, u"", 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'] + path = [u"nat", u"max translations per thread"] self.add_config_item(self._nodeconfig, value, path) - def apply_config(self, waittime=5, retries=12): - """Generate and apply VPP configuration for node. + def add_nsim_poll_main_thread(self): + """Add NSIM poll-main-thread configuration.""" + path = [u"nsim", u"poll-main-thread"] + self.add_config_item(self._nodeconfig, u"", path) - Use data from calls to this class to form a startup.conf file and - replace /etc/vpp/startup.conf with it on node. + def add_tcp_congestion_control_algorithm(self, value=u"cubic"): + """Add TCP congestion control algorithm. - :param waittime: Time to wait for VPP to restart (default 5 seconds). - :param retries: Number of times (default 12) to re-try waiting. - :type waittime: int - :type retries: int - :raises RuntimeError: If writing config file failed, or restarting of - VPP failed. + :param value: The congestion control algorithm to use. Example: cubic + :type value: str """ - self.dump_config(self._nodeconfig) + path = [u"tcp", u"cc-algo"] + self.add_config_item(self._nodeconfig, value, path) - ssh = SSH() - ssh.connect(self._node) - - # We're using this "| sudo tee" construct because redirecting - # a sudo's output ("sudo echo xxx > /path/to/file") does not - # work on most platforms... - (ret, _, _) = \ - ssh.exec_command('echo "{0}" | sudo tee {1}'. - format(self._vpp_config, - self._vpp_config_filename)) - - if ret != 0: - raise RuntimeError('Writing config file failed to node {}'. - format(self._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 service {} stop' - .format(self._vpp_service_name)) - (ret, _, _) = \ - ssh.exec_command('sudo service {} start' - .format(self._vpp_service_name)) - if ret != 0: - raise RuntimeError('Restarting VPP failed on node {}'. - format(self._hostname)) - - # Sleep seconds, up to times, - # and verify if VPP is running. - for _ in range(retries): - time.sleep(waittime) - (ret, _, _) = \ - ssh.exec_command('echo show hardware-interfaces | ' - 'nc 0 5002 || echo "VPP not yet running"') - if ret == 0: - break - else: - raise RuntimeError('VPP failed to restart on node {}'. - format(self._hostname)) + def add_tcp_preallocated_connections(self, value): + """Add TCP pre-allocated connections. + + :param value: The number of pre-allocated connections. + :type value: int + """ + path = [u"tcp", u"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 = [u"tcp", u"preallocated-half-open-connections"] + self.add_config_item(self._nodeconfig, value, path) + + def add_session_enable(self): + """Add session enable.""" + path = [u"session", u"enable"] + self.add_config_item(self._nodeconfig, u"", path) + + def add_session_event_queues_memfd_segment(self): + """Add session event queue memfd segment.""" + path = [u"session", u"evt_qs_memfd_seg"] + self.add_config_item(self._nodeconfig, u"", path) + + def add_session_event_queue_length(self, value): + """Add session event queue length. + + :param value: Session event queue length. + :type value: int + """ + path = [u"session", u"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 = [u"session", u"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 = [u"session", u"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 = [u"session", u"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 = [u"session", u"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 = [u"session", u"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 = [u"session", u"v4-halfopen-table-memory"] + self.add_config_item(self._nodeconfig, value, path) - def apply_config_lxc(self, lxc_name, waittime=5, retries=12): - """Generate and apply VPP configuration for node in a container. + 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 = [u"session", u"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 = [u"session", u"local-endpoints-table-memory"] + 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 node inside a container. + replace /etc/vpp/startup.conf with it on topology node. - :param lxc_name: LXC container name. - :param waittime: Time to wait for VPP to restart (default 5 seconds). - :param retries: Number of times (default 12) to re-try waiting. - :type lxc_name: str - :type waittime: int - :type retries: int - :raises RuntimeError: If writing config file failed, or restarting of - VPP failed. + :param filename: Startup configuration file name. + :type filename: str """ self.dump_config(self._nodeconfig) - ssh = SSH() - ssh.connect(self._node) - - # We're using this "| sudo tee" construct because redirecting - # a sudo's output ("sudo echo xxx > /path/to/file") does not - # work on most platforms... - (ret, _, _) = \ - ssh.exec_command_lxc('echo "{0}" | sudo tee {1}'. - format(self._vpp_config, - self._vpp_config_filename), lxc_name) - - if ret != 0: - raise RuntimeError('Writing config file failed in {0} to node {1}'. - format(lxc_name, self._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_lxc('service {0} stop'. - format(self._vpp_service_name), lxc_name) - (ret, _, _) = \ - ssh.exec_command_lxc('service {0} start'. - format(self._vpp_service_name), lxc_name) - if ret != 0: - raise RuntimeError('Restarting VPP failed in {0} on node {1}'. - format(lxc_name, self._hostname)) - - # Sleep seconds, up to times, - # and verify if VPP is running. - for _ in range(retries): - time.sleep(waittime) - (ret, _, _) = \ - ssh.exec_command_lxc('echo show hardware-interfaces | ' - 'nc 0 5002 || echo "VPP not yet running"', - lxc_name) - if ret == 0: - break - else: - raise RuntimeError('VPP failed to restart in {0} on node {1}'. - format(lxc_name, self._hostname)) + if filename is None: + filename = self._vpp_startup_conf + + if self._vpp_startup_conf_backup is not None: + cmd = f"cp {self._vpp_startup_conf} {self._vpp_startup_conf_backup}" + exec_cmd_no_error( + self._node, cmd, sudo=True, message=u"Copy config file failed!" + ) + + cmd = f"echo \"{self._vpp_config}\" | sudo tee {filename}" + exec_cmd_no_error( + self._node, cmd, message=u"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 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) + + VPPUtil.restart_vpp_service(self._node, self._node_key) + if verify_vpp: + VPPUtil.verify_vpp(self._node) + + def restore_config(self): + """Restore VPP startup.conf from backup.""" + cmd = f"cp {self._vpp_startup_conf_backup} {self._vpp_startup_conf}" + exec_cmd_no_error( + self._node, cmd, sudo=True, message=u"Copy config file failed!" + )