resources/libraries/python/VppConfigGenerator.py

   1 # Copyright (c) 2016 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """VPP Configuration File Generator library."""
  15
  16 import re
  17 import time
  18
  19 from resources.libraries.python.ssh import SSH
  20 from resources.libraries.python.topology import NodeType
  21 from resources.libraries.python.topology import Topology
  22
  23 __all__ = ['VppConfigGenerator']
  24
  25
  26 class VppConfigGenerator(object):
  27     """VPP Configuration File Generator."""
  28
  29     def __init__(self):
  30         """Initialize library."""
  31         # VPP Node to apply configuration on
  32         self._node = ''
  33         # VPP Hostname
  34         self._hostname = ''
  35         # VPP Configuration
  36         self._nodeconfig = {}
  37         # Serialized VPP Configuration
  38         self._vpp_config = ''
  39         # VPP Service name
  40         self._vpp_service_name = 'vpp'
  41         # VPP Logfile location
  42         self._vpp_logfile = '/tmp/vpe.log'
  43         # VPP Startup config location
  44         self._vpp_startup_conf = '/etc/vpp/startup.conf'
  45         # VPP Startup config backup location
  46         self._vpp_startup_conf_backup = None
  47
  48     def set_node(self, node):
  49         """Set DUT node.
  50
  51         :param node: Node to store configuration on.
  52         :type node: dict
  53         :raises RuntimeError: If Node type is not DUT.
  54         """
  55         if node['type'] != NodeType.DUT:
  56             raise RuntimeError('Startup config can only be applied to DUT'
  57                                'node.')
  58         self._node = node
  59         self._hostname = Topology.get_node_hostname(node)
  60
  61     def set_vpp_logfile(self, logfile):
  62         """Set VPP logfile location.
  63
  64         :param logfile: VPP logfile location.
  65         :type logfile: str
  66         """
  67         self._vpp_logfile = logfile
  68
  69     def set_vpp_startup_conf_backup(self, backup='/etc/vpp/startup.backup'):
  70         """Set VPP startup configuration backup.
  71
  72         :param backup: VPP logfile location.
  73         :type backup: str
  74         """
  75         self._vpp_startup_conf_backup = backup
  76
  77     def get_config_str(self):
  78         """Get dumped startup configuration in VPP config format.
  79
  80         :returns: Startup configuration in VPP config format.
  81         :rtype: str
  82         """
  83         self.dump_config(self._nodeconfig)
  84         return self._vpp_config
  85
  86     def add_config_item(self, config, value, path):
  87         """Add startup configuration item.
  88
  89         :param config: Startup configuration of node.
  90         :param value: Value to insert.
  91         :param path: Path where to insert item.
  92         :type config: dict
  93         :type value: str
  94         :type path: list
  95         """
  96         if len(path) == 1:
  97             config[path[0]] = value
  98             return
  99         if path[0] not in config:
 100             config[path[0]] = {}
 101         self.add_config_item(config[path[0]], value, path[1:])
 102
 103     def dump_config(self, obj, level=-1):
 104         """Dump the startup configuration in VPP config format.
 105
 106         :param obj: Python Object to print.
 107         :param level: Nested level for indentation.
 108         :type obj: Obj
 109         :type level: int
 110         :returns: nothing
 111         """
 112         indent = '  '
 113         if level >= 0:
 114             self._vpp_config += '{}{{\n'.format((level) * indent)
 115         if isinstance(obj, dict):
 116             for key, val in obj.items():
 117                 if hasattr(val, '__iter__'):
 118                     self._vpp_config += '{}{}\n'.format((level + 1) * indent,
 119                                                         key)
 120                     self.dump_config(val, level + 1)
 121                 else:
 122                     self._vpp_config += '{}{} {}\n'.format((level + 1) * indent,
 123                                                            key, val)
 124         else:
 125             for val in obj:
 126                 self._vpp_config += '{}{}\n'.format((level + 1) * indent, val)
 127         if level >= 0:
 128             self._vpp_config += '{}}}\n'.format(level * indent)
 129
 130     def add_unix_log(self, value=None):
 131         """Add UNIX log configuration.
 132
 133         :param value: Log file.
 134         :type value: str
 135         """
 136         path = ['unix', 'log']
 137         if value is None:
 138             value = self._vpp_logfile
 139         self.add_config_item(self._nodeconfig, value, path)
 140
 141     def add_unix_cli_listen(self, value='localhost:5002'):
 142         """Add UNIX cli-listen configuration.
 143
 144         :param value: CLI listen address and port or path to CLI socket.
 145         :type value: str
 146         """
 147         path = ['unix', 'cli-listen']
 148         self.add_config_item(self._nodeconfig, value, path)
 149
 150     def add_unix_gid(self, value='vpp'):
 151         """Add UNIX gid configuration.
 152
 153         :param value: Gid.
 154         :type value: str
 155         """
 156         path = ['unix', 'gid']
 157         self.add_config_item(self._nodeconfig, value, path)
 158
 159     def add_unix_nodaemon(self):
 160         """Add UNIX nodaemon configuration."""
 161         path = ['unix', 'nodaemon']
 162         self.add_config_item(self._nodeconfig, '', path)
 163
 164     def add_unix_coredump(self):
 165         """Add UNIX full-coredump configuration."""
 166         path = ['unix', 'full-coredump']
 167         self.add_config_item(self._nodeconfig, '', path)
 168
 169     def add_unix_exec(self, value):
 170         """Add UNIX exec configuration."""
 171         path = ['unix', 'exec']
 172         self.add_config_item(self._nodeconfig, value, path)
 173
 174     def add_api_segment_gid(self, value='vpp'):
 175         """Add API-SEGMENT gid configuration.
 176
 177         :param value: Gid.
 178         :type value: str
 179         """
 180         path = ['api-segment', 'gid']
 181         self.add_config_item(self._nodeconfig, value, path)
 182
 183     def add_dpdk_dev(self, *devices):
 184         """Add DPDK PCI device configuration.
 185
 186         :param devices: PCI device(s) (format xxxx:xx:xx.x)
 187         :type devices: tuple
 188         :raises ValueError: If PCI address format is not valid.
 189         """
 190         pattern = re.compile("^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:"
 191                              "[0-9A-Fa-f]{2}\\.[0-9A-Fa-f]$")
 192         for device in devices:
 193             if not pattern.match(device):
 194                 raise ValueError('PCI address {} to be added to host {} '
 195                                  'is not in valid format xxxx:xx:xx.x'.
 196                                  format(device, self._hostname))
 197             path = ['dpdk', 'dev {0}'.format(device)]
 198             self.add_config_item(self._nodeconfig, '', path)
 199
 200     def add_dpdk_cryptodev(self, count):
 201         """Add DPDK Crypto PCI device configuration.
 202
 203         :param count: Number of HW crypto devices to add.
 204         :type count: int
 205         """
 206         cryptodev = Topology.get_cryptodev(self._node)
 207         for i in range(count):
 208             cryptodev_config = 'dev {0}'.format(
 209                 re.sub(r'\d.\d$', '1.'+str(i), cryptodev))
 210             path = ['dpdk', cryptodev_config]
 211             self.add_config_item(self._nodeconfig, '', path)
 212         self.add_dpdk_uio_driver('igb_uio')
 213
 214     def add_dpdk_sw_cryptodev(self, sw_pmd_type, socket_id, count):
 215         """Add DPDK SW Crypto device configuration.
 216
 217         :param sw_pmd_type: Type of SW crypto device PMD to add.
 218         :param socket_id: Socket ID.
 219         :param count: Number of SW crypto devices to add.
 220         :type sw_pmd_type: str
 221         :type socket_id: int
 222         :type count: int
 223         """
 224         for _ in range(count):
 225             cryptodev_config = 'vdev cryptodev_{0}_pmd,socket_id={1}'.\
 226                 format(sw_pmd_type, str(socket_id))
 227             path = ['dpdk', cryptodev_config]
 228             self.add_config_item(self._nodeconfig, '', path)
 229
 230     def add_dpdk_dev_default_rxq(self, value):
 231         """Add DPDK dev default rxq configuration.
 232
 233         :param value: Default number of rxqs.
 234         :type value: str
 235         """
 236         path = ['dpdk', 'dev default', 'num-rx-queues']
 237         self.add_config_item(self._nodeconfig, value, path)
 238
 239     def add_dpdk_dev_default_txq(self, value):
 240         """Add DPDK dev default txq configuration.
 241
 242         :param value: Default number of txqs.
 243         :type value: str
 244         """
 245         path = ['dpdk', 'dev default', 'num-tx-queues']
 246         self.add_config_item(self._nodeconfig, value, path)
 247
 248     def add_dpdk_dev_default_rxd(self, value):
 249         """Add DPDK dev default rxd configuration.
 250
 251         :param value: Default number of rxds.
 252         :type value: str
 253         """
 254         path = ['dpdk', 'dev default', 'num-rx-desc']
 255         self.add_config_item(self._nodeconfig, value, path)
 256
 257     def add_dpdk_dev_default_txd(self, value):
 258         """Add DPDK dev default txd configuration.
 259
 260         :param value: Default number of txds.
 261         :type value: str
 262         """
 263         path = ['dpdk', 'dev default', 'num-tx-desc']
 264         self.add_config_item(self._nodeconfig, value, path)
 265
 266     def add_dpdk_socketmem(self, value):
 267         """Add DPDK socket memory configuration.
 268
 269         :param value: Socket memory size.
 270         :type value: str
 271         """
 272         path = ['dpdk', 'socket-mem']
 273         self.add_config_item(self._nodeconfig, value, path)
 274
 275     def add_dpdk_uio_driver(self, value):
 276         """Add DPDK uio-driver configuration.
 277
 278         :param value: DPDK uio-driver configuration.
 279         :type value: str
 280         """
 281         path = ['dpdk', 'uio-driver']
 282         self.add_config_item(self._nodeconfig, value, path)
 283
 284     def add_cpu_main_core(self, value):
 285         """Add CPU main core configuration.
 286
 287         :param value: Main core option.
 288         :type value: str
 289         """
 290         path = ['cpu', 'main-core']
 291         self.add_config_item(self._nodeconfig, value, path)
 292
 293     def add_cpu_corelist_workers(self, value):
 294         """Add CPU corelist-workers configuration.
 295
 296         :param value: Corelist-workers option.
 297         :type value: str
 298         """
 299         path = ['cpu', 'corelist-workers']
 300         self.add_config_item(self._nodeconfig, value, path)
 301
 302     def add_heapsize(self, value):
 303         """Add Heapsize configuration.
 304
 305         :param value: Amount of heapsize.
 306         :type value: str
 307         """
 308         path = ['heapsize']
 309         self.add_config_item(self._nodeconfig, value, path)
 310
 311     def add_api_trace(self):
 312         """Add API trace configuration."""
 313         path = ['api-trace', 'on']
 314         self.add_config_item(self._nodeconfig, '', path)
 315
 316     def add_ip6_hash_buckets(self, value):
 317         """Add IP6 hash buckets configuration.
 318
 319         :param value: Number of IP6 hash buckets.
 320         :type value: str
 321         """
 322         path = ['ip6', 'hash-buckets']
 323         self.add_config_item(self._nodeconfig, value, path)
 324
 325     def add_ip6_heap_size(self, value):
 326         """Add IP6 heap-size configuration.
 327
 328         :param value: IP6 Heapsize amount.
 329         :type value: str
 330         """
 331         path = ['ip6', 'heap-size']
 332         self.add_config_item(self._nodeconfig, value, path)
 333
 334     def add_plugin_disable(self, *plugins):
 335         """Add plugin disable for specific plugin.
 336
 337         :param plugins: Plugin(s) to disable.
 338         :type plugins: list
 339         """
 340         for plugin in plugins:
 341             path = ['plugins', 'plugin {0}'.format(plugin), 'disable']
 342             self.add_config_item(self._nodeconfig, ' ', path)
 343
 344     def add_dpdk_no_multi_seg(self):
 345         """Add DPDK no-multi-seg configuration."""
 346         path = ['dpdk', 'no-multi-seg']
 347         self.add_config_item(self._nodeconfig, '', path)
 348
 349     def add_nat(self, value='deterministic'):
 350         """Add NAT configuration.
 351
 352         :param value: NAT mode.
 353         :type value: str
 354         """
 355         path = ['nat']
 356         self.add_config_item(self._nodeconfig, value, path)
 357
 358     def apply_config(self, filename=None, waittime=5,
 359                      retries=12, restart_vpp=True):
 360         """Generate and apply VPP configuration for node.
 361
 362         Use data from calls to this class to form a startup.conf file and
 363         replace /etc/vpp/startup.conf with it on node.
 364
 365         :param filename: Startup configuration file name.
 366         :param waittime: Time to wait for VPP to restart (default 5 seconds).
 367         :param retries: Number of times (default 12) to re-try waiting.
 368         :param restart_vpp: Whether to restart VPP.
 369         :type filename: str
 370         :type waittime: int
 371         :type retries: int
 372         :type restart_vpp: bool.
 373         :raises RuntimeError: If writing config file failed or restart of VPP
 374             failed or backup of VPP startup.conf failed.
 375         """
 376         self.dump_config(self._nodeconfig)
 377
 378         ssh = SSH()
 379         ssh.connect(self._node)
 380
 381         if filename is None:
 382             filename = self._vpp_startup_conf
 383
 384         if self._vpp_startup_conf_backup is not None:
 385             (ret, _, _) = \
 386                 ssh.exec_command('sudo cp {0} {1}'.
 387                                  format(self._vpp_startup_conf,
 388                                         self._vpp_startup_conf_backup))
 389             if ret != 0:
 390                 raise RuntimeError('Backup of config file failed on node {}'.
 391                                    format(self._hostname))
 392
 393         (ret, _, _) = \
 394             ssh.exec_command('echo "{config}" | sudo tee {filename}'.
 395                              format(config=self._vpp_config,
 396                                     filename=filename))
 397
 398         if ret != 0:
 399             raise RuntimeError('Writing config file failed to node {}'.
 400                                format(self._hostname))
 401
 402         if restart_vpp:
 403             # Instead of restarting, we'll do separate start and stop
 404             # actions. This way we don't care whether VPP was running
 405             # to begin with.
 406             ssh.exec_command('sudo service {} stop'
 407                              .format(self._vpp_service_name))
 408             (ret, _, _) = \
 409                 ssh.exec_command('sudo service {} start'
 410                                  .format(self._vpp_service_name))
 411             if ret != 0:
 412                 raise RuntimeError('Restarting VPP failed on node {}'.
 413                                    format(self._hostname))
 414
 415             # Sleep <waittime> seconds, up to <retry> times,
 416             # and verify if VPP is running.
 417             for _ in range(retries):
 418                 time.sleep(waittime)
 419                 (ret, stdout, _) = \
 420                     ssh.exec_command('echo show hardware-interfaces | '
 421                                      'nc 0 5002 || echo "VPP not yet running"')
 422                 if ret == 0 and stdout != 'VPP not yet running':
 423                     break
 424             else:
 425                 raise RuntimeError('VPP failed to restart on node {}'.
 426                                    format(self._hostname))
 427
 428     def restore_config(self):
 429         """Restore VPP startup.conf from backup.
 430
 431         :raises RuntimeError: When restoration of startup.conf file failed.
 432         """
 433
 434         ssh = SSH()
 435         ssh.connect(self._node)
 436
 437         (ret, _, _) = ssh.exec_command('sudo cp {0} {1}'.
 438                                        format(self._vpp_startup_conf_backup,
 439                                               self._vpp_startup_conf))
 440         if ret != 0:
 441             raise RuntimeError('Restoration of config file failed on node {}'.
 442                                format(self._hostname))