X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FVppConfigGenerator.py;h=def23712e5e4b392a66795c4b8bcb116a88c93f3;hp=dac8bae6bbe71f9d61792fa6f53b3793bbb65fca;hb=0ba508f0eac819c1985e825857f584b3d1537ffe;hpb=2bdb1dc59ba736546a6663cbaf55b6edbcac6eab diff --git a/resources/libraries/python/VppConfigGenerator.py b/resources/libraries/python/VppConfigGenerator.py index dac8bae6bb..def23712e5 100644 --- a/resources/libraries/python/VppConfigGenerator.py +++ b/resources/libraries/python/VppConfigGenerator.py @@ -22,10 +22,12 @@ from resources.libraries.python.topology import Topology __all__ = ['VppConfigGenerator'] + class VppConfigGenerator(object): """VPP Configuration File Generator.""" def __init__(self): + """Initialize library.""" # VPP Node to apply configuration on self._node = '' # VPP Hostname @@ -36,8 +38,12 @@ class VppConfigGenerator(object): self._vpp_config = '' # VPP Service name self._vpp_service_name = 'vpp' - # VPP Configuration file path - self._vpp_config_filename = '/etc/vpp/startup.conf' + # VPP Logfile location + self._vpp_logfile = '/tmp/vpe.log' + # VPP Startup config location + self._vpp_startup_conf = '/etc/vpp/startup.conf' + # VPP Startup config backup location + self._vpp_startup_conf_backup = None def set_node(self, node): """Set DUT node. @@ -46,20 +52,36 @@ class VppConfigGenerator(object): :type node: dict :raises RuntimeError: If Node type is not DUT. """ - if node['type'] != NodeType.DUT: raise RuntimeError('Startup config can only be applied to DUT' 'node.') self._node = node self._hostname = Topology.get_node_hostname(node) - 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='/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,11 +93,10 @@ 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]): + if path[0] not in config: config[path[0]] = {} self.add_config_item(config[path[0]], value, path[1:]) @@ -83,9 +104,9 @@ class VppConfigGenerator(object): """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 = ' ' @@ -106,34 +127,59 @@ class VppConfigGenerator(object): if level >= 0: self._vpp_config += '{}}}\n'.format(level * indent) - 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'] + 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'): """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'] self.add_config_item(self._nodeconfig, value, 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_api_segment_gid(self, value='vpp'): + """Add API-SEGMENT gid configuration. + + :param value: Gid. + :type value: str + """ + path = ['api-segment', 'gid'] + self.add_config_item(self._nodeconfig, value, path) + def add_dpdk_dev(self, *devices): """Add DPDK PCI device configuration. @@ -141,7 +187,6 @@ class VppConfigGenerator(object): :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: @@ -155,7 +200,7 @@ class VppConfigGenerator(object): 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) @@ -166,6 +211,22 @@ class VppConfigGenerator(object): self.add_config_item(self._nodeconfig, '', path) self.add_dpdk_uio_driver('igb_uio') + 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 = 'vdev cryptodev_{0}_pmd,socket_id={1}'.\ + format(sw_pmd_type, str(socket_id)) + path = ['dpdk', cryptodev_config] + self.add_config_item(self._nodeconfig, '', path) + def add_dpdk_dev_default_rxq(self, value): """Add DPDK dev default rxq configuration. @@ -202,7 +263,6 @@ 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. @@ -295,115 +355,88 @@ class VppConfigGenerator(object): path = ['nat'] self.add_config_item(self._nodeconfig, value, path) - def apply_config(self, waittime=5, retries=12): + def apply_config(self, filename=None, waittime=5, + retries=12, restart_vpp=True): """Generate and apply VPP configuration for node. Use data from calls to this class to form a startup.conf file and replace /etc/vpp/startup.conf with it on node. + :param filename: Startup configuration file name. :param waittime: Time to wait for VPP to restart (default 5 seconds). :param retries: Number of times (default 12) to re-try waiting. + :param restart_vpp: Whether to restart VPP. + :type filename: str :type waittime: int :type retries: int - :raises RuntimeError: If writing config file failed, or restarting of - VPP failed. + :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) - # 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... + 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 "{0}" | sudo tee {1}'. - format(self._vpp_config, - self._vpp_config_filename)) + 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)) - # 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' + 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)) - 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 apply_config_lxc(self, lxc_name, waittime=5, retries=12): - """Generate and apply VPP configuration for node in a container. - - 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. - - :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. + 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, stdout, _) = \ + ssh.exec_command('echo show hardware-interfaces | ' + 'nc 0 5002 || echo "VPP not yet running"') + if ret == 0 and stdout != 'VPP not yet running': + break + else: + raise RuntimeError('VPP failed to restart on node {}'. + format(self._hostname)) + + def restore_config(self): + """Restore VPP startup.conf from backup. + + :raises RuntimeError: When restoration of startup.conf file failed. """ - 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) + (ret, _, _) = ssh.exec_command('sudo cp {0} {1}'. + format(self._vpp_startup_conf_backup, + self._vpp_startup_conf)) 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)) + raise RuntimeError('Restoration of config file failed on node {}'. + format(self._hostname))