-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2018 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:
import time
from resources.libraries.python.ssh import SSH
+from resources.libraries.python.constants import Constants
+from resources.libraries.python.DUTSetup import DUTSetup
from resources.libraries.python.topology import NodeType
from resources.libraries.python.topology import Topology
__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."""
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):
path = ['api-segment', '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 = ['api-segment', '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 = ['api-segment', 'api-size']
+ 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.
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.
path = ['dpdk', 'dev default', 'num-tx-desc']
self.add_config_item(self._nodeconfig, value, 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_socketmem(self, value):
"""Add DPDK socket memory configuration.
path = ['ip6', 'heap-size']
self.add_config_item(self._nodeconfig, value, path)
- def add_plugin_disable(self, *plugins):
- """Add plugin disable for specific plugin.
+ def add_ip_heap_size(self, value):
+ """Add IP heap-size configuration.
+
+ :param value: IP Heapsize amount.
+ :type value: str
+ """
+ path = ['ip', 'heap-size']
+ 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):
path = ['dpdk', 'no-multi-seg']
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 configuration.
path = ['nat']
self.add_config_item(self._nodeconfig, value, path)
- def apply_config(self, filename=None, waittime=5,
- retries=12, restart_vpp=True):
+ 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_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_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 apply_config(self, filename=None, retries=60, 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 retries: Number of times (default 60) to re-try waiting.
:param restart_vpp: Whether to restart VPP.
:type filename: str
- :type waittime: int
:type retries: int
:type restart_vpp: bool.
:raises RuntimeError: If writing config file failed or restart of VPP
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))
+ ret, _, _ = \
+ ssh.exec_command('sudo cp {src} {dest}'.
+ format(src=self._vpp_startup_conf,
+ dest=self._vpp_startup_conf_backup))
if ret != 0:
- raise RuntimeError('Backup of config file failed on node {}'.
- format(self._hostname))
+ raise RuntimeError('Backup of config file failed on node '
+ '{name}'.format(name=self._hostname))
- (ret, _, _) = \
+ 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))
+ raise RuntimeError('Writing config file failed to node {name}'.
+ format(name=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))
+ DUTSetup.start_service(self._node, Constants.VPP_UNIT)
# Sleep <waittime> seconds, up to <retry> 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':
+ time.sleep(1)
+ ret, stdout, _ = \
+ ssh.exec_command('echo show pci | 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))
+ raise RuntimeError('VPP failed to restart on node {name}'.
+ format(name=self._hostname))
def restore_config(self):
"""Restore VPP startup.conf from backup.
ssh = SSH()
ssh.connect(self._node)
- (ret, _, _) = ssh.exec_command('sudo cp {0} {1}'.
- format(self._vpp_startup_conf_backup,
- self._vpp_startup_conf))
+ ret, _, _ = ssh.exec_command('sudo cp {src} {dest}'.
+ format(src=self._vpp_startup_conf_backup,
+ dest=self._vpp_startup_conf))
if ret != 0:
- raise RuntimeError('Restoration of config file failed on node {}'.
- format(self._hostname))
+ raise RuntimeError('Restoration of config file failed on node '
+ '{name}'.format(name=self._hostname))
Code Review / csit.git / blobdiff