X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FVppConfigGenerator.py;h=e92d6745073802e6bdb26ab22266fe376e2e24ec;hp=819224f485056fe72fd514a7035beed482b70755;hb=3c863def2096b573832499985e3a12bbccf82ea8;hpb=07a840aaa516d4560dddd916c23593e711ec08fb diff --git a/resources/libraries/python/VppConfigGenerator.py b/resources/libraries/python/VppConfigGenerator.py index 819224f485..e92d674507 100644 --- a/resources/libraries/python/VppConfigGenerator.py +++ b/resources/libraries/python/VppConfigGenerator.py @@ -1,4 +1,4 @@ -# Copyright (c) 2018 Cisco and/or its affiliates. +# Copyright (c) 2019 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: @@ -14,15 +14,32 @@ """VPP Configuration File Generator library.""" import re -import time -from resources.libraries.python.ssh import SSH +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'] +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("^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:" + "[0-9A-Fa-f]{2}\\.[0-9A-Fa-f]$") + if not pattern.match(pci_dev): + raise ValueError('PCI address {addr} is not in valid format ' + 'xxxx:xx:xx.x'.format(addr=pci_dev)) + return True + + class VppConfigGenerator(object): """VPP Configuration File Generator.""" @@ -98,6 +115,9 @@ class VppConfigGenerator(object): return if path[0] not in config: config[path[0]] = {} + elif isinstance(config[path[0]], str): + config[path[0]] = {} 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): @@ -138,7 +158,7 @@ class VppConfigGenerator(object): 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='/run/vpp/cli.sock'): """Add UNIX cli-listen configuration. :param value: CLI listen address and port or path to CLI socket. @@ -198,22 +218,39 @@ class VppConfigGenerator(object): path = ['api-segment', '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 = ['buffers', 'buffers-per-numa'] + self.add_config_item(self._nodeconfig, value, path) + def add_dpdk_dev(self, *devices): """Add DPDK PCI device configuration. :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 = ['dpdk', 'dev {0}'.format(device)] + self.add_config_item(self._nodeconfig, '', 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 = ['dpdk', 'dev {0}'.format(device), parameter] + self.add_config_item(self._nodeconfig, value, path) def add_dpdk_cryptodev(self, count): """Add DPDK Crypto PCI device configuration. @@ -227,7 +264,7 @@ class VppConfigGenerator(object): 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') + 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. @@ -245,6 +282,29 @@ class VppConfigGenerator(object): path = ['dpdk', cryptodev_config] self.add_config_item(self._nodeconfig, '', path) + def add_dpdk_eth_bond_dev(self, ethbond_id, mode, xmit_policy, *slaves): + """Add DPDK Eth_bond device configuration. + + :param ethbond_id: Eth_bond device ID. + :param mode: Link bonding mode. + :param xmit_policy: Transmission policy. + :param slaves: PCI device(s) to be bonded (format xxxx:xx:xx.x). + :type ethbond_id: str or int + :type mode: str or int + :type xmit_policy: str + :type slaves: list + """ + slaves_config = ',slave=' + \ + ',slave='.join(slave if pci_dev_check(slave) else '' + for slave in slaves) + ethbond_config = 'vdev eth_bond{id},mode={mode}{slaves},' \ + 'xmit_policy={xmit_pol}'.format(id=ethbond_id, + mode=mode, + slaves=slaves_config, + xmit_pol=xmit_policy) + path = ['dpdk', ethbond_config] + self.add_config_item(self._nodeconfig, '', path) + def add_dpdk_dev_default_rxq(self, value): """Add DPDK dev default rxq configuration. @@ -281,21 +341,30 @@ class VppConfigGenerator(object): path = ['dpdk', 'dev default', 'num-tx-desc'] self.add_config_item(self._nodeconfig, value, path) - def add_dpdk_socketmem(self, value): - """Add DPDK socket memory configuration. + def add_dpdk_log_level(self, value): + """Add DPDK log-level configuration. - :param value: Socket memory size. + :param value: Log level. :type value: str """ - path = ['dpdk', 'socket-mem'] + path = ['dpdk', '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 = ['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. + :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) @@ -358,14 +427,34 @@ class VppConfigGenerator(object): path = ['ip', 'heap-size'] self.add_config_item(self._nodeconfig, value, path) - def add_plugin_disable(self, *plugins): - """Add plugin disable for specific plugin. + def add_statseg_size(self, value): + """Add stats segment 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_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', 'plugin {0}'.format(plugin), 'disable'] + path = ['plugins', 'plugin {0}'.format(plugin), state] self.add_config_item(self._nodeconfig, ' ', path) def add_dpdk_no_multi_seg(self): @@ -477,85 +566,51 @@ class VppConfigGenerator(object): path = ['session', 'local-endpoints-table-memory'] self.add_config_item(self._nodeconfig, value, path) - def apply_config(self, filename=None, retries=60, restart_vpp=True): - """Generate and apply VPP configuration for node. + 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. + replace /etc/vpp/startup.conf with it on topology node. :param filename: Startup configuration file name. - :param retries: Number of times (default 60) to re-try waiting. - :param restart_vpp: Whether to restart VPP. :type filename: str - :type retries: int - :type restart_vpp: bool. - :raises RuntimeError: If writing config file failed or restart of VPP - failed or backup of VPP startup.conf failed. """ self.dump_config(self._nodeconfig) - ssh = SSH() - ssh.connect(self._node) - if filename is None: filename = self._vpp_startup_conf if self._vpp_startup_conf_backup is not None: - (ret, _, _) = \ - ssh.exec_command('sudo cp {0} {1}'. - format(self._vpp_startup_conf, - self._vpp_startup_conf_backup)) - if ret != 0: - raise RuntimeError('Backup of config file failed on node {}'. - format(self._hostname)) - - (ret, _, _) = \ - ssh.exec_command('echo "{config}" | sudo tee {filename}'. - format(config=self._vpp_config, - filename=filename)) - - if ret != 0: - raise RuntimeError('Writing config file failed to node {}'. - format(self._hostname)) - - if restart_vpp: - # 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(1) - (ret, stdout, _) = \ - ssh.exec_command('echo show hardware-interfaces | ' - 'nc 0 5002 || echo "VPP not yet running"') - if ret == 0 and 'VPP not yet running' not in stdout: - break - else: - raise RuntimeError('VPP failed to restart on node {}'. - format(self._hostname)) + cmd = ('cp {src} {dest}'.format( + src=self._vpp_startup_conf, dest=self._vpp_startup_conf_backup)) + exec_cmd_no_error( + self._node, cmd, sudo=True, message='Copy config file failed!') - def restore_config(self): - """Restore VPP startup.conf from backup. + cmd = ('echo "{config}" | sudo tee {filename}'.format( + config=self._vpp_config, filename=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 topology node. - :raises RuntimeError: When restoration of startup.conf file failed. + :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) - ssh = SSH() - ssh.connect(self._node) + VPPUtil.restart_vpp_service(self._node) + if verify_vpp: + VPPUtil.verify_vpp(self._node) - (ret, _, _) = ssh.exec_command('sudo cp {0} {1}'. - format(self._vpp_startup_conf_backup, - self._vpp_startup_conf)) - if ret != 0: - raise RuntimeError('Restoration of config file failed on node {}'. - format(self._hostname)) + def restore_config(self): + """Restore VPP startup.conf from backup.""" + cmd = ('cp {src} {dest}'.format( + src=self._vpp_startup_conf_backup, dest=self._vpp_startup_conf)) + exec_cmd_no_error( + self._node, cmd, sudo=True, message='Copy config file failed!')