1 # Copyright (c) 2018 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:
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
14 """VPP Configuration File Generator library."""
19 from resources.libraries.python.ssh import SSH
20 from resources.libraries.python.topology import NodeType
21 from resources.libraries.python.topology import Topology
23 __all__ = ['VppConfigGenerator']
26 class VppConfigGenerator(object):
27 """VPP Configuration File Generator."""
30 """Initialize library."""
31 # VPP Node to apply configuration on
37 # Serialized VPP Configuration
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
48 def set_node(self, node):
51 :param node: Node to store configuration on.
53 :raises RuntimeError: If Node type is not DUT.
55 if node['type'] != NodeType.DUT:
56 raise RuntimeError('Startup config can only be applied to DUT'
59 self._hostname = Topology.get_node_hostname(node)
61 def set_vpp_logfile(self, logfile):
62 """Set VPP logfile location.
64 :param logfile: VPP logfile location.
67 self._vpp_logfile = logfile
69 def set_vpp_startup_conf_backup(self, backup='/etc/vpp/startup.backup'):
70 """Set VPP startup configuration backup.
72 :param backup: VPP logfile location.
75 self._vpp_startup_conf_backup = backup
77 def get_config_str(self):
78 """Get dumped startup configuration in VPP config format.
80 :returns: Startup configuration in VPP config format.
83 self.dump_config(self._nodeconfig)
84 return self._vpp_config
86 def add_config_item(self, config, value, path):
87 """Add startup configuration item.
89 :param config: Startup configuration of node.
90 :param value: Value to insert.
91 :param path: Path where to insert item.
97 config[path[0]] = value
99 if path[0] not in config:
101 self.add_config_item(config[path[0]], value, path[1:])
103 def dump_config(self, obj, level=-1):
104 """Dump the startup configuration in VPP config format.
106 :param obj: Python Object to print.
107 :param level: Nested level for indentation.
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,
120 self.dump_config(val, level + 1)
122 self._vpp_config += '{}{} {}\n'.format((level + 1) * indent,
126 self._vpp_config += '{}{}\n'.format((level + 1) * indent, val)
128 self._vpp_config += '{}}}\n'.format(level * indent)
130 def add_unix_log(self, value=None):
131 """Add UNIX log configuration.
133 :param value: Log file.
136 path = ['unix', 'log']
138 value = self._vpp_logfile
139 self.add_config_item(self._nodeconfig, value, path)
141 def add_unix_cli_listen(self, value='localhost:5002'):
142 """Add UNIX cli-listen configuration.
144 :param value: CLI listen address and port or path to CLI socket.
147 path = ['unix', 'cli-listen']
148 self.add_config_item(self._nodeconfig, value, path)
150 def add_unix_gid(self, value='vpp'):
151 """Add UNIX gid configuration.
156 path = ['unix', 'gid']
157 self.add_config_item(self._nodeconfig, value, path)
159 def add_unix_nodaemon(self):
160 """Add UNIX nodaemon configuration."""
161 path = ['unix', 'nodaemon']
162 self.add_config_item(self._nodeconfig, '', path)
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)
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)
174 def add_api_segment_gid(self, value='vpp'):
175 """Add API-SEGMENT gid configuration.
180 path = ['api-segment', 'gid']
181 self.add_config_item(self._nodeconfig, value, path)
183 def add_api_segment_global_size(self, value):
184 """Add API-SEGMENT global-size configuration.
186 :param value: Global size.
189 path = ['api-segment', 'global-size']
190 self.add_config_item(self._nodeconfig, value, path)
192 def add_api_segment_api_size(self, value):
193 """Add API-SEGMENT api-size configuration.
195 :param value: API size.
198 path = ['api-segment', 'api-size']
199 self.add_config_item(self._nodeconfig, value, path)
201 def add_dpdk_dev(self, *devices):
202 """Add DPDK PCI device configuration.
204 :param devices: PCI device(s) (format xxxx:xx:xx.x)
206 :raises ValueError: If PCI address format is not valid.
208 pattern = re.compile("^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:"
209 "[0-9A-Fa-f]{2}\\.[0-9A-Fa-f]$")
210 for device in devices:
211 if not pattern.match(device):
212 raise ValueError('PCI address {} to be added to host {} '
213 'is not in valid format xxxx:xx:xx.x'.
214 format(device, self._hostname))
215 path = ['dpdk', 'dev {0}'.format(device)]
216 self.add_config_item(self._nodeconfig, '', path)
218 def add_dpdk_cryptodev(self, count):
219 """Add DPDK Crypto PCI device configuration.
221 :param count: Number of HW crypto devices to add.
224 cryptodev = Topology.get_cryptodev(self._node)
225 for i in range(count):
226 cryptodev_config = 'dev {0}'.format(
227 re.sub(r'\d.\d$', '1.'+str(i), cryptodev))
228 path = ['dpdk', cryptodev_config]
229 self.add_config_item(self._nodeconfig, '', path)
230 self.add_dpdk_uio_driver('igb_uio')
232 def add_dpdk_sw_cryptodev(self, sw_pmd_type, socket_id, count):
233 """Add DPDK SW Crypto device configuration.
235 :param sw_pmd_type: Type of SW crypto device PMD to add.
236 :param socket_id: Socket ID.
237 :param count: Number of SW crypto devices to add.
238 :type sw_pmd_type: str
242 for _ in range(count):
243 cryptodev_config = 'vdev cryptodev_{0}_pmd,socket_id={1}'.\
244 format(sw_pmd_type, str(socket_id))
245 path = ['dpdk', cryptodev_config]
246 self.add_config_item(self._nodeconfig, '', path)
248 def add_dpdk_dev_default_rxq(self, value):
249 """Add DPDK dev default rxq configuration.
251 :param value: Default number of rxqs.
254 path = ['dpdk', 'dev default', 'num-rx-queues']
255 self.add_config_item(self._nodeconfig, value, path)
257 def add_dpdk_dev_default_txq(self, value):
258 """Add DPDK dev default txq configuration.
260 :param value: Default number of txqs.
263 path = ['dpdk', 'dev default', 'num-tx-queues']
264 self.add_config_item(self._nodeconfig, value, path)
266 def add_dpdk_dev_default_rxd(self, value):
267 """Add DPDK dev default rxd configuration.
269 :param value: Default number of rxds.
272 path = ['dpdk', 'dev default', 'num-rx-desc']
273 self.add_config_item(self._nodeconfig, value, path)
275 def add_dpdk_dev_default_txd(self, value):
276 """Add DPDK dev default txd configuration.
278 :param value: Default number of txds.
281 path = ['dpdk', 'dev default', 'num-tx-desc']
282 self.add_config_item(self._nodeconfig, value, path)
284 def add_dpdk_socketmem(self, value):
285 """Add DPDK socket memory configuration.
287 :param value: Socket memory size.
290 path = ['dpdk', 'socket-mem']
291 self.add_config_item(self._nodeconfig, value, path)
293 def add_dpdk_uio_driver(self, value):
294 """Add DPDK uio-driver configuration.
296 :param value: DPDK uio-driver configuration.
299 path = ['dpdk', 'uio-driver']
300 self.add_config_item(self._nodeconfig, value, path)
302 def add_cpu_main_core(self, value):
303 """Add CPU main core configuration.
305 :param value: Main core option.
308 path = ['cpu', 'main-core']
309 self.add_config_item(self._nodeconfig, value, path)
311 def add_cpu_corelist_workers(self, value):
312 """Add CPU corelist-workers configuration.
314 :param value: Corelist-workers option.
317 path = ['cpu', 'corelist-workers']
318 self.add_config_item(self._nodeconfig, value, path)
320 def add_heapsize(self, value):
321 """Add Heapsize configuration.
323 :param value: Amount of heapsize.
327 self.add_config_item(self._nodeconfig, value, path)
329 def add_api_trace(self):
330 """Add API trace configuration."""
331 path = ['api-trace', 'on']
332 self.add_config_item(self._nodeconfig, '', path)
334 def add_ip6_hash_buckets(self, value):
335 """Add IP6 hash buckets configuration.
337 :param value: Number of IP6 hash buckets.
340 path = ['ip6', 'hash-buckets']
341 self.add_config_item(self._nodeconfig, value, path)
343 def add_ip6_heap_size(self, value):
344 """Add IP6 heap-size configuration.
346 :param value: IP6 Heapsize amount.
349 path = ['ip6', 'heap-size']
350 self.add_config_item(self._nodeconfig, value, path)
352 def add_ip_heap_size(self, value):
353 """Add IP heap-size configuration.
355 :param value: IP Heapsize amount.
358 path = ['ip', 'heap-size']
359 self.add_config_item(self._nodeconfig, value, path)
361 def add_plugin(self, state, *plugins):
362 """Add plugin section for specific plugin(s).
364 :param state: State of plugin [enable|disable].
365 :param plugins: Plugin(s) to disable.
369 for plugin in plugins:
370 path = ['plugins', 'plugin {0}'.format(plugin), state]
371 self.add_config_item(self._nodeconfig, ' ', path)
373 def add_dpdk_no_multi_seg(self):
374 """Add DPDK no-multi-seg configuration."""
375 path = ['dpdk', 'no-multi-seg']
376 self.add_config_item(self._nodeconfig, '', path)
378 def add_dpdk_no_tx_checksum_offload(self):
379 """Add DPDK no-tx-checksum-offload configuration."""
380 path = ['dpdk', 'no-tx-checksum-offload']
381 self.add_config_item(self._nodeconfig, '', path)
383 def add_nat(self, value='deterministic'):
384 """Add NAT configuration.
386 :param value: NAT mode.
390 self.add_config_item(self._nodeconfig, value, path)
392 def add_tcp_preallocated_connections(self, value):
393 """Add TCP pre-allocated connections.
395 :param value: The number of pre-allocated connections.
398 path = ['tcp', 'preallocated-connections']
399 self.add_config_item(self._nodeconfig, value, path)
401 def add_tcp_preallocated_half_open_connections(self, value):
402 """Add TCP pre-allocated half open connections.
404 :param value: The number of pre-allocated half open connections.
407 path = ['tcp', 'preallocated-half-open-connections']
408 self.add_config_item(self._nodeconfig, value, path)
410 def add_session_event_queue_length(self, value):
411 """Add session event queue length.
413 :param value: Session event queue length.
416 path = ['session', 'event-queue-length']
417 self.add_config_item(self._nodeconfig, value, path)
419 def add_session_preallocated_sessions(self, value):
420 """Add the number of pre-allocated sessions.
422 :param value: Number of pre-allocated sessions.
425 path = ['session', 'preallocated-sessions']
426 self.add_config_item(self._nodeconfig, value, path)
428 def add_session_v4_session_table_buckets(self, value):
429 """Add number of v4 session table buckets to the config.
431 :param value: Number of v4 session table buckets.
434 path = ['session', 'v4-session-table-buckets']
435 self.add_config_item(self._nodeconfig, value, path)
437 def add_session_v4_session_table_memory(self, value):
438 """Add the size of v4 session table memory.
440 :param value: Size of v4 session table memory.
443 path = ['session', 'v4-session-table-memory']
444 self.add_config_item(self._nodeconfig, value, path)
446 def add_session_v4_halfopen_table_buckets(self, value):
447 """Add the number of v4 halfopen table buckets.
449 :param value: Number of v4 halfopen table buckets.
452 path = ['session', 'v4-halfopen-table-buckets']
453 self.add_config_item(self._nodeconfig, value, path)
455 def add_session_v4_halfopen_table_memory(self, value):
456 """Add the size of v4 halfopen table memory.
458 :param value: Size of v4 halfopen table memory.
461 path = ['session', 'v4-halfopen-table-memory']
462 self.add_config_item(self._nodeconfig, value, path)
464 def add_session_local_endpoints_table_buckets(self, value):
465 """Add the number of local endpoints table buckets.
467 :param value: Number of local endpoints table buckets.
470 path = ['session', 'local-endpoints-table-buckets']
471 self.add_config_item(self._nodeconfig, value, path)
473 def add_session_local_endpoints_table_memory(self, value):
474 """Add the size of local endpoints table memory.
476 :param value: Size of local endpoints table memory.
479 path = ['session', 'local-endpoints-table-memory']
480 self.add_config_item(self._nodeconfig, value, path)
482 def apply_config(self, filename=None, retries=60, restart_vpp=True):
483 """Generate and apply VPP configuration for node.
485 Use data from calls to this class to form a startup.conf file and
486 replace /etc/vpp/startup.conf with it on node.
488 :param filename: Startup configuration file name.
489 :param retries: Number of times (default 60) to re-try waiting.
490 :param restart_vpp: Whether to restart VPP.
493 :type restart_vpp: bool.
494 :raises RuntimeError: If writing config file failed or restart of VPP
495 failed or backup of VPP startup.conf failed.
497 self.dump_config(self._nodeconfig)
500 ssh.connect(self._node)
503 filename = self._vpp_startup_conf
505 if self._vpp_startup_conf_backup is not None:
507 ssh.exec_command('sudo cp {0} {1}'.
508 format(self._vpp_startup_conf,
509 self._vpp_startup_conf_backup))
511 raise RuntimeError('Backup of config file failed on node {}'.
512 format(self._hostname))
515 ssh.exec_command('echo "{config}" | sudo tee {filename}'.
516 format(config=self._vpp_config,
520 raise RuntimeError('Writing config file failed to node {}'.
521 format(self._hostname))
524 # Instead of restarting, we'll do separate start and stop
525 # actions. This way we don't care whether VPP was running
527 ssh.exec_command('sudo service {} stop'
528 .format(self._vpp_service_name))
530 ssh.exec_command('sudo service {} start'
531 .format(self._vpp_service_name))
533 raise RuntimeError('Restarting VPP failed on node {}'.
534 format(self._hostname))
536 # Sleep <waittime> seconds, up to <retry> times,
537 # and verify if VPP is running.
538 for _ in range(retries):
541 ssh.exec_command('echo show hardware-interfaces | '
542 'nc 0 5002 || echo "VPP not yet running"')
543 if ret == 0 and 'VPP not yet running' not in stdout:
546 raise RuntimeError('VPP failed to restart on node {}'.
547 format(self._hostname))
549 def restore_config(self):
550 """Restore VPP startup.conf from backup.
552 :raises RuntimeError: When restoration of startup.conf file failed.
556 ssh.connect(self._node)
558 (ret, _, _) = ssh.exec_command('sudo cp {0} {1}'.
559 format(self._vpp_startup_conf_backup,
560 self._vpp_startup_conf))
562 raise RuntimeError('Restoration of config file failed on node {}'.
563 format(self._hostname))