1 # Copyright (c) 2019 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.
16 TODO: Support initialization with default values,
17 so that we do not need to have block of 6 "Add Unix" commands
18 in 7 various places of CSIT code.
23 from resources.libraries.python.ssh import exec_cmd_no_error
24 from resources.libraries.python.topology import NodeType
25 from resources.libraries.python.topology import Topology
26 from resources.libraries.python.VPPUtil import VPPUtil
28 __all__ = ['VppConfigGenerator']
31 def pci_dev_check(pci_dev):
32 """Check if provided PCI address is in correct format.
34 :param pci_dev: PCI address (expected format: xxxx:xx:xx.x).
36 :returns: True if PCI address is in correct format.
38 :raises ValueError: If PCI address is in incorrect format.
40 pattern = re.compile("^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:"
41 "[0-9A-Fa-f]{2}\\.[0-9A-Fa-f]$")
42 if not pattern.match(pci_dev):
43 raise ValueError('PCI address {addr} is not in valid format '
44 'xxxx:xx:xx.x'.format(addr=pci_dev))
48 class VppConfigGenerator(object):
49 """VPP Configuration File Generator."""
52 """Initialize library."""
53 # VPP Node to apply configuration on
59 # Serialized VPP Configuration
62 self._vpp_service_name = 'vpp'
63 # VPP Logfile location
64 self._vpp_logfile = '/tmp/vpe.log'
65 # VPP Startup config location
66 self._vpp_startup_conf = '/etc/vpp/startup.conf'
67 # VPP Startup config backup location
68 self._vpp_startup_conf_backup = None
70 def set_node(self, node):
73 :param node: Node to store configuration on.
75 :raises RuntimeError: If Node type is not DUT.
77 if node['type'] != NodeType.DUT:
78 raise RuntimeError('Startup config can only be applied to DUT'
81 self._hostname = Topology.get_node_hostname(node)
83 def set_vpp_logfile(self, logfile):
84 """Set VPP logfile location.
86 :param logfile: VPP logfile location.
89 self._vpp_logfile = logfile
91 def set_vpp_startup_conf_backup(self, backup='/etc/vpp/startup.backup'):
92 """Set VPP startup configuration backup.
94 :param backup: VPP logfile location.
97 self._vpp_startup_conf_backup = backup
99 def get_config_str(self):
100 """Get dumped startup configuration in VPP config format.
102 :returns: Startup configuration in VPP config format.
105 self.dump_config(self._nodeconfig)
106 return self._vpp_config
108 def add_config_item(self, config, value, path):
109 """Add startup configuration item.
111 :param config: Startup configuration of node.
112 :param value: Value to insert.
113 :param path: Path where to insert item.
119 config[path[0]] = value
121 if path[0] not in config:
123 elif isinstance(config[path[0]], str):
124 config[path[0]] = {} if config[path[0]] == '' \
125 else {config[path[0]]: ''}
126 self.add_config_item(config[path[0]], value, path[1:])
128 def dump_config(self, obj, level=-1):
129 """Dump the startup configuration in VPP config format.
131 :param obj: Python Object to print.
132 :param level: Nested level for indentation.
139 self._vpp_config += '{}{{\n'.format((level) * indent)
140 if isinstance(obj, dict):
141 for key, val in obj.items():
142 if hasattr(val, '__iter__'):
143 self._vpp_config += '{}{}\n'.format((level + 1) * indent,
145 self.dump_config(val, level + 1)
147 self._vpp_config += '{}{} {}\n'.format((level + 1) * indent,
151 self._vpp_config += '{}{}\n'.format((level + 1) * indent, val)
153 self._vpp_config += '{}}}\n'.format(level * indent)
155 def add_unix_log(self, value=None):
156 """Add UNIX log configuration.
158 :param value: Log file.
161 path = ['unix', 'log']
163 value = self._vpp_logfile
164 self.add_config_item(self._nodeconfig, value, path)
166 def add_unix_cli_listen(self, value='/run/vpp/cli.sock'):
167 """Add UNIX cli-listen configuration.
169 :param value: CLI listen address and port or path to CLI socket.
172 path = ['unix', 'cli-listen']
173 self.add_config_item(self._nodeconfig, value, path)
175 def add_unix_gid(self, value='vpp'):
176 """Add UNIX gid configuration.
181 path = ['unix', 'gid']
182 self.add_config_item(self._nodeconfig, value, path)
184 def add_unix_nodaemon(self):
185 """Add UNIX nodaemon configuration."""
186 path = ['unix', 'nodaemon']
187 self.add_config_item(self._nodeconfig, '', path)
189 def add_unix_coredump(self):
190 """Add UNIX full-coredump configuration."""
191 path = ['unix', 'full-coredump']
192 self.add_config_item(self._nodeconfig, '', path)
194 def add_unix_exec(self, value):
195 """Add UNIX exec configuration."""
196 path = ['unix', 'exec']
197 self.add_config_item(self._nodeconfig, value, path)
199 def add_socksvr(self, socket="default"):
200 """Add socksvr configuration."""
201 path = ['socksvr', socket]
202 self.add_config_item(self._nodeconfig, '', path)
204 def add_api_segment_gid(self, value='vpp'):
205 """Add API-SEGMENT gid configuration.
210 path = ['api-segment', 'gid']
211 self.add_config_item(self._nodeconfig, value, path)
213 def add_api_segment_global_size(self, value):
214 """Add API-SEGMENT global-size configuration.
216 :param value: Global size.
219 path = ['api-segment', 'global-size']
220 self.add_config_item(self._nodeconfig, value, path)
222 def add_api_segment_api_size(self, value):
223 """Add API-SEGMENT api-size configuration.
225 :param value: API size.
228 path = ['api-segment', 'api-size']
229 self.add_config_item(self._nodeconfig, value, path)
231 def add_buffers_per_numa(self, value):
232 """Increase number of buffers allocated.
234 :param value: Number of buffers allocated.
237 path = ['buffers', 'buffers-per-numa']
238 self.add_config_item(self._nodeconfig, value, path)
240 def add_dpdk_dev(self, *devices):
241 """Add DPDK PCI device configuration.
243 :param devices: PCI device(s) (format xxxx:xx:xx.x)
246 for device in devices:
247 if pci_dev_check(device):
248 path = ['dpdk', 'dev {0}'.format(device)]
249 self.add_config_item(self._nodeconfig, '', path)
251 def add_dpdk_dev_parameter(self, device, parameter, value):
252 """Add parameter for DPDK device.
254 :param device: PCI device (format xxxx:xx:xx.x).
255 :param parameter: Parameter name.
256 :param value: Parameter value.
261 if pci_dev_check(device):
262 path = ['dpdk', 'dev {0}'.format(device), parameter]
263 self.add_config_item(self._nodeconfig, value, path)
265 def add_dpdk_cryptodev(self, count):
266 """Add DPDK Crypto PCI device configuration.
268 :param count: Number of HW crypto devices to add.
271 cryptodev = Topology.get_cryptodev(self._node)
272 for i in range(count):
273 cryptodev_config = 'dev {0}'.format(
274 re.sub(r'\d.\d$', '1.'+str(i), cryptodev))
275 path = ['dpdk', cryptodev_config]
276 self.add_config_item(self._nodeconfig, '', path)
277 self.add_dpdk_uio_driver('vfio-pci')
279 def add_dpdk_sw_cryptodev(self, sw_pmd_type, socket_id, count):
280 """Add DPDK SW Crypto device configuration.
282 :param sw_pmd_type: Type of SW crypto device PMD to add.
283 :param socket_id: Socket ID.
284 :param count: Number of SW crypto devices to add.
285 :type sw_pmd_type: str
289 for _ in range(count):
290 cryptodev_config = 'vdev cryptodev_{0}_pmd,socket_id={1}'.\
291 format(sw_pmd_type, str(socket_id))
292 path = ['dpdk', cryptodev_config]
293 self.add_config_item(self._nodeconfig, '', path)
295 def add_dpdk_eth_bond_dev(self, ethbond_id, mode, xmit_policy, *slaves):
296 """Add DPDK Eth_bond device configuration.
298 :param ethbond_id: Eth_bond device ID.
299 :param mode: Link bonding mode.
300 :param xmit_policy: Transmission policy.
301 :param slaves: PCI device(s) to be bonded (format xxxx:xx:xx.x).
302 :type ethbond_id: str or int
303 :type mode: str or int
304 :type xmit_policy: str
307 slaves_config = ',slave=' + \
308 ',slave='.join(slave if pci_dev_check(slave) else ''
310 ethbond_config = 'vdev eth_bond{id},mode={mode}{slaves},' \
311 'xmit_policy={xmit_pol}'.format(id=ethbond_id,
313 slaves=slaves_config,
314 xmit_pol=xmit_policy)
315 path = ['dpdk', ethbond_config]
316 self.add_config_item(self._nodeconfig, '', path)
318 def add_dpdk_dev_default_rxq(self, value):
319 """Add DPDK dev default rxq configuration.
321 :param value: Default number of rxqs.
324 path = ['dpdk', 'dev default', 'num-rx-queues']
325 self.add_config_item(self._nodeconfig, value, path)
327 def add_dpdk_dev_default_txq(self, value):
328 """Add DPDK dev default txq configuration.
330 :param value: Default number of txqs.
333 path = ['dpdk', 'dev default', 'num-tx-queues']
334 self.add_config_item(self._nodeconfig, value, path)
336 def add_dpdk_dev_default_rxd(self, value):
337 """Add DPDK dev default rxd configuration.
339 :param value: Default number of rxds.
342 path = ['dpdk', 'dev default', 'num-rx-desc']
343 self.add_config_item(self._nodeconfig, value, path)
345 def add_dpdk_dev_default_txd(self, value):
346 """Add DPDK dev default txd configuration.
348 :param value: Default number of txds.
351 path = ['dpdk', 'dev default', 'num-tx-desc']
352 self.add_config_item(self._nodeconfig, value, path)
354 def add_dpdk_log_level(self, value):
355 """Add DPDK log-level configuration.
357 :param value: Log level.
360 path = ['dpdk', 'log-level']
361 self.add_config_item(self._nodeconfig, value, path)
363 def add_dpdk_no_pci(self):
364 """Add DPDK no-pci."""
365 path = ['dpdk', 'no-pci']
366 self.add_config_item(self._nodeconfig, '', path)
368 def add_dpdk_uio_driver(self, value=None):
369 """Add DPDK uio-driver configuration.
371 :param value: DPDK uio-driver configuration. By default, driver will be
372 loaded automatically from Topology file, still leaving
373 option to manually override by parameter.
377 value = Topology.get_uio_driver(self._node)
378 path = ['dpdk', 'uio-driver']
379 self.add_config_item(self._nodeconfig, value, path)
381 def add_cpu_main_core(self, value):
382 """Add CPU main core configuration.
384 :param value: Main core option.
387 path = ['cpu', 'main-core']
388 self.add_config_item(self._nodeconfig, value, path)
390 def add_cpu_corelist_workers(self, value):
391 """Add CPU corelist-workers configuration.
393 :param value: Corelist-workers option.
396 path = ['cpu', 'corelist-workers']
397 self.add_config_item(self._nodeconfig, value, path)
399 def add_heapsize(self, value):
400 """Add Heapsize configuration.
402 :param value: Amount of heapsize.
406 self.add_config_item(self._nodeconfig, value, path)
408 def add_api_trace(self):
409 """Add API trace configuration."""
410 path = ['api-trace', 'on']
411 self.add_config_item(self._nodeconfig, '', path)
413 def add_ip6_hash_buckets(self, value):
414 """Add IP6 hash buckets configuration.
416 :param value: Number of IP6 hash buckets.
419 path = ['ip6', 'hash-buckets']
420 self.add_config_item(self._nodeconfig, value, path)
422 def add_ip6_heap_size(self, value):
423 """Add IP6 heap-size configuration.
425 :param value: IP6 Heapsize amount.
428 path = ['ip6', 'heap-size']
429 self.add_config_item(self._nodeconfig, value, path)
431 def add_ip_heap_size(self, value):
432 """Add IP heap-size configuration.
434 :param value: IP Heapsize amount.
437 path = ['ip', 'heap-size']
438 self.add_config_item(self._nodeconfig, value, path)
440 def add_statseg_size(self, value):
441 """Add stats segment heap size configuration.
443 :param value: Stats heapsize amount.
446 path = ['statseg', 'size']
447 self.add_config_item(self._nodeconfig, value, path)
449 def add_statseg_per_node_counters(self, value):
450 """Add stats per-node-counters configuration.
452 :param value: "on" to switch the counters on.
455 path = ['statseg', 'per-node-counters']
456 self.add_config_item(self._nodeconfig, value, path)
458 def add_plugin(self, state, *plugins):
459 """Add plugin section for specific plugin(s).
461 :param state: State of plugin [enable|disable].
462 :param plugins: Plugin(s) to disable.
466 for plugin in plugins:
467 path = ['plugins', 'plugin {0}'.format(plugin), state]
468 self.add_config_item(self._nodeconfig, ' ', path)
470 def add_dpdk_no_multi_seg(self):
471 """Add DPDK no-multi-seg configuration."""
472 path = ['dpdk', 'no-multi-seg']
473 self.add_config_item(self._nodeconfig, '', path)
475 def add_dpdk_no_tx_checksum_offload(self):
476 """Add DPDK no-tx-checksum-offload configuration."""
477 path = ['dpdk', 'no-tx-checksum-offload']
478 self.add_config_item(self._nodeconfig, '', path)
480 def add_nat(self, value='deterministic'):
481 """Add NAT configuration.
483 :param value: NAT mode.
487 self.add_config_item(self._nodeconfig, value, path)
489 def add_tcp_preallocated_connections(self, value):
490 """Add TCP pre-allocated connections.
492 :param value: The number of pre-allocated connections.
495 path = ['tcp', 'preallocated-connections']
496 self.add_config_item(self._nodeconfig, value, path)
498 def add_tcp_preallocated_half_open_connections(self, value):
499 """Add TCP pre-allocated half open connections.
501 :param value: The number of pre-allocated half open connections.
504 path = ['tcp', 'preallocated-half-open-connections']
505 self.add_config_item(self._nodeconfig, value, path)
507 def add_session_event_queue_length(self, value):
508 """Add session event queue length.
510 :param value: Session event queue length.
513 path = ['session', 'event-queue-length']
514 self.add_config_item(self._nodeconfig, value, path)
516 def add_session_preallocated_sessions(self, value):
517 """Add the number of pre-allocated sessions.
519 :param value: Number of pre-allocated sessions.
522 path = ['session', 'preallocated-sessions']
523 self.add_config_item(self._nodeconfig, value, path)
525 def add_session_v4_session_table_buckets(self, value):
526 """Add number of v4 session table buckets to the config.
528 :param value: Number of v4 session table buckets.
531 path = ['session', 'v4-session-table-buckets']
532 self.add_config_item(self._nodeconfig, value, path)
534 def add_session_v4_session_table_memory(self, value):
535 """Add the size of v4 session table memory.
537 :param value: Size of v4 session table memory.
540 path = ['session', 'v4-session-table-memory']
541 self.add_config_item(self._nodeconfig, value, path)
543 def add_session_v4_halfopen_table_buckets(self, value):
544 """Add the number of v4 halfopen table buckets.
546 :param value: Number of v4 halfopen table buckets.
549 path = ['session', 'v4-halfopen-table-buckets']
550 self.add_config_item(self._nodeconfig, value, path)
552 def add_session_v4_halfopen_table_memory(self, value):
553 """Add the size of v4 halfopen table memory.
555 :param value: Size of v4 halfopen table memory.
558 path = ['session', 'v4-halfopen-table-memory']
559 self.add_config_item(self._nodeconfig, value, path)
561 def add_session_local_endpoints_table_buckets(self, value):
562 """Add the number of local endpoints table buckets.
564 :param value: Number of local endpoints table buckets.
567 path = ['session', 'local-endpoints-table-buckets']
568 self.add_config_item(self._nodeconfig, value, path)
570 def add_session_local_endpoints_table_memory(self, value):
571 """Add the size of local endpoints table memory.
573 :param value: Size of local endpoints table memory.
576 path = ['session', 'local-endpoints-table-memory']
577 self.add_config_item(self._nodeconfig, value, path)
579 def write_config(self, filename=None):
580 """Generate and write VPP startup configuration to file.
582 Use data from calls to this class to form a startup.conf file and
583 replace /etc/vpp/startup.conf with it on topology node.
585 :param filename: Startup configuration file name.
588 self.dump_config(self._nodeconfig)
591 filename = self._vpp_startup_conf
593 if self._vpp_startup_conf_backup is not None:
594 cmd = ('cp {src} {dest}'.format(
595 src=self._vpp_startup_conf, dest=self._vpp_startup_conf_backup))
597 self._node, cmd, sudo=True, message='Copy config file failed!')
599 cmd = ('echo "{config}" | sudo tee {filename}'.format(
600 config=self._vpp_config, filename=filename))
602 self._node, cmd, message='Writing config file failed!')
604 def apply_config(self, filename=None, verify_vpp=True):
605 """Generate and write VPP startup configuration to file and restart VPP.
607 Use data from calls to this class to form a startup.conf file and
608 replace /etc/vpp/startup.conf with it on topology node.
610 :param filename: Startup configuration file name.
611 :param verify_vpp: Verify VPP is running after restart.
613 :type verify_vpp: bool
615 self.write_config(filename=filename)
617 VPPUtil.restart_vpp_service(self._node)
619 VPPUtil.verify_vpp(self._node)
621 def restore_config(self):
622 """Restore VPP startup.conf from backup."""
623 cmd = ('cp {src} {dest}'.format(
624 src=self._vpp_startup_conf_backup, dest=self._vpp_startup_conf))
626 self._node, cmd, sudo=True, message='Copy config file failed!')