1 # Copyright (c) 2021 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.Constants import Constants
24 from resources.libraries.python.ssh import exec_cmd_no_error
25 from resources.libraries.python.topology import NodeType
26 from resources.libraries.python.topology import Topology
27 from resources.libraries.python.VPPUtil import VPPUtil
29 __all__ = [u"VppConfigGenerator"]
32 def pci_dev_check(pci_dev):
33 """Check if provided PCI address is in correct format.
35 :param pci_dev: PCI address (expected format: xxxx:xx:xx.x).
37 :returns: True if PCI address is in correct format.
39 :raises ValueError: If PCI address is in incorrect format.
42 r"^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}\.[0-9A-Fa-f]$"
44 if not re.match(pattern, pci_dev):
46 f"PCI address {pci_dev} is not in valid format xxxx:xx:xx.x"
51 class VppConfigGenerator:
52 """VPP Configuration File Generator."""
55 """Initialize library."""
56 # VPP Node to apply configuration on
61 self._nodeconfig = dict()
62 # Serialized VPP Configuration
63 self._vpp_config = u""
65 self._vpp_service_name = u"vpp"
66 # VPP Logfile location
67 self._vpp_logfile = u"/tmp/vpe.log"
68 # VPP Startup config location
69 self._vpp_startup_conf = u"/etc/vpp/startup.conf"
70 # VPP Startup config backup location
71 self._vpp_startup_conf_backup = None
73 def set_node(self, node, node_key=None):
76 :param node: Node to store configuration on.
77 :param node_key: Topology node key.
80 :raises RuntimeError: If Node type is not DUT.
82 if node[u"type"] != NodeType.DUT:
84 u"Startup config can only be applied to DUTnode."
87 self._node_key = node_key
89 def set_vpp_logfile(self, logfile):
90 """Set VPP logfile location.
92 :param logfile: VPP logfile location.
95 self._vpp_logfile = logfile
97 def set_vpp_startup_conf_backup(self, backup=u"/etc/vpp/startup.backup"):
98 """Set VPP startup configuration backup.
100 :param backup: VPP logfile location.
103 self._vpp_startup_conf_backup = backup
105 def get_config_str(self):
106 """Get dumped startup configuration in VPP config format.
108 :returns: Startup configuration in VPP config format.
111 self.dump_config(self._nodeconfig)
112 return self._vpp_config
114 def add_config_item(self, config, value, path):
115 """Add startup configuration item.
117 :param config: Startup configuration of node.
118 :param value: Value to insert.
119 :param path: Path where to insert item.
125 config[path[0]] = value
127 if path[0] not in config:
128 config[path[0]] = dict()
129 elif isinstance(config[path[0]], str):
130 config[path[0]] = dict() if config[path[0]] == u"" \
131 else {config[path[0]]: u""}
132 self.add_config_item(config[path[0]], value, path[1:])
134 def dump_config(self, obj, level=-1):
135 """Dump the startup configuration in VPP config format.
137 :param obj: Python Object to print.
138 :param level: Nested level for indentation.
145 self._vpp_config += f"{level * indent}{{\n"
146 if isinstance(obj, dict):
147 for key, val in obj.items():
148 if hasattr(val, u"__iter__") and not isinstance(val, str):
149 self._vpp_config += f"{(level + 1) * indent}{key}\n"
150 self.dump_config(val, level + 1)
152 self._vpp_config += f"{(level + 1) * indent}{key} {val}\n"
155 self._vpp_config += f"{(level + 1) * indent}{val}\n"
157 self._vpp_config += f"{level * indent}}}\n"
159 def add_unix_log(self, value=None):
160 """Add UNIX log configuration.
162 :param value: Log file.
165 path = [u"unix", u"log"]
167 value = self._vpp_logfile
168 self.add_config_item(self._nodeconfig, value, path)
170 def add_unix_cli_listen(self, value=u"/run/vpp/cli.sock"):
171 """Add UNIX cli-listen configuration.
173 :param value: CLI listen address and port or path to CLI socket.
176 path = [u"unix", u"cli-listen"]
177 self.add_config_item(self._nodeconfig, value, path)
179 def add_unix_gid(self, value=u"vpp"):
180 """Add UNIX gid configuration.
185 path = [u"unix", u"gid"]
186 self.add_config_item(self._nodeconfig, value, path)
188 def add_unix_nodaemon(self):
189 """Add UNIX nodaemon configuration."""
190 path = [u"unix", u"nodaemon"]
191 self.add_config_item(self._nodeconfig, u"", path)
193 def add_unix_coredump(self):
194 """Add UNIX full-coredump configuration."""
195 path = [u"unix", u"full-coredump"]
196 self.add_config_item(self._nodeconfig, u"", path)
198 def add_unix_exec(self, value):
199 """Add UNIX exec configuration."""
200 path = [u"unix", u"exec"]
201 self.add_config_item(self._nodeconfig, value, path)
203 def add_socksvr(self, socket=Constants.SOCKSVR_PATH):
204 """Add socksvr configuration."""
205 path = [u"socksvr", u"socket-name"]
206 self.add_config_item(self._nodeconfig, socket, path)
208 def add_graph_node_variant(self, variant=Constants.GRAPH_NODE_VARIANT):
209 """Add default graph node variant.
211 :param value: Graph node variant default value.
216 variant_list = [u"hsw", u"skx", u"icl"]
217 if variant not in variant_list:
218 raise ValueError("Invalid graph node variant value")
219 path = [u"node", u"default", u"variant"]
220 self.add_config_item(self._nodeconfig, variant, path)
222 def add_api_segment_gid(self, value=u"vpp"):
223 """Add API-SEGMENT gid configuration.
228 path = [u"api-segment", u"gid"]
229 self.add_config_item(self._nodeconfig, value, path)
231 def add_api_segment_global_size(self, value):
232 """Add API-SEGMENT global-size configuration.
234 :param value: Global size.
237 path = [u"api-segment", u"global-size"]
238 self.add_config_item(self._nodeconfig, value, path)
240 def add_api_segment_api_size(self, value):
241 """Add API-SEGMENT api-size configuration.
243 :param value: API size.
246 path = [u"api-segment", u"api-size"]
247 self.add_config_item(self._nodeconfig, value, path)
249 def add_buffers_per_numa(self, value):
250 """Increase number of buffers allocated.
252 :param value: Number of buffers allocated.
255 path = [u"buffers", u"buffers-per-numa"]
256 self.add_config_item(self._nodeconfig, value, path)
258 def add_buffers_default_data_size(self, value):
259 """Increase buffers data-size allocated.
261 :param value: Buffers data-size allocated.
264 path = [u"buffers", u"default data-size"]
265 self.add_config_item(self._nodeconfig, value, path)
267 def add_dpdk_dev(self, *devices):
268 """Add DPDK PCI device configuration.
270 :param devices: PCI device(s) (format xxxx:xx:xx.x)
273 for device in devices:
274 if pci_dev_check(device):
275 path = [u"dpdk", f"dev {device}"]
276 self.add_config_item(self._nodeconfig, u"", path)
278 def add_dpdk_dev_parameter(self, device, parameter, value):
279 """Add parameter for DPDK device.
281 :param device: PCI device (format xxxx:xx:xx.x).
282 :param parameter: Parameter name.
283 :param value: Parameter value.
288 if pci_dev_check(device):
289 path = [u"dpdk", f"dev {device}", parameter]
290 self.add_config_item(self._nodeconfig, value, path)
292 def add_dpdk_cryptodev(self, count):
293 """Add DPDK Crypto PCI device configuration.
295 :param count: Number of HW crypto devices to add.
298 cryptodev = Topology.get_cryptodev(self._node)
299 for i in range(count):
300 cryptodev_config = re.sub(r"\d.\d$", f"1.{str(i)}", cryptodev)
301 path = [u"dpdk", f"dev {cryptodev_config}"]
302 self.add_config_item(self._nodeconfig, u"", path)
303 self.add_dpdk_uio_driver(u"vfio-pci")
305 def add_dpdk_sw_cryptodev(self, sw_pmd_type, socket_id, count):
306 """Add DPDK SW Crypto device configuration.
308 :param sw_pmd_type: Type of SW crypto device PMD to add.
309 :param socket_id: Socket ID.
310 :param count: Number of SW crypto devices to add.
311 :type sw_pmd_type: str
315 for _ in range(count):
316 cryptodev_config = f"vdev cryptodev_{sw_pmd_type}_pmd," \
317 f"socket_id={str(socket_id)}"
318 path = [u"dpdk", cryptodev_config]
319 self.add_config_item(self._nodeconfig, u"", path)
321 def add_dpdk_dev_default_rxq(self, value):
322 """Add DPDK dev default rxq configuration.
324 :param value: Default number of rxqs.
327 path = [u"dpdk", u"dev default", u"num-rx-queues"]
328 self.add_config_item(self._nodeconfig, value, path)
330 def add_dpdk_dev_default_txq(self, value):
331 """Add DPDK dev default txq configuration.
333 :param value: Default number of txqs.
336 path = [u"dpdk", u"dev default", u"num-tx-queues"]
337 self.add_config_item(self._nodeconfig, value, path)
339 def add_dpdk_dev_default_rxd(self, value):
340 """Add DPDK dev default rxd configuration.
342 :param value: Default number of rxds.
345 path = [u"dpdk", u"dev default", u"num-rx-desc"]
346 self.add_config_item(self._nodeconfig, value, path)
348 def add_dpdk_dev_default_txd(self, value):
349 """Add DPDK dev default txd configuration.
351 :param value: Default number of txds.
354 path = [u"dpdk", u"dev default", u"num-tx-desc"]
355 self.add_config_item(self._nodeconfig, value, path)
357 def add_dpdk_log_level(self, value):
358 """Add DPDK log-level configuration.
360 :param value: Log level.
363 path = [u"dpdk", u"log-level"]
364 self.add_config_item(self._nodeconfig, value, path)
366 def add_dpdk_no_pci(self):
367 """Add DPDK no-pci."""
368 path = [u"dpdk", u"no-pci"]
369 self.add_config_item(self._nodeconfig, u"", path)
371 def add_dpdk_uio_driver(self, value=None):
372 """Add DPDK uio-driver configuration.
374 :param value: DPDK uio-driver configuration. By default, driver will be
375 loaded automatically from Topology file, still leaving option
376 to manually override by parameter.
380 value = Topology.get_uio_driver(self._node)
381 path = [u"dpdk", u"uio-driver"]
382 self.add_config_item(self._nodeconfig, value, path)
384 def add_dpdk_max_simd_bitwidth(self, variant=Constants.GRAPH_NODE_VARIANT):
385 """Add DPDK max-simd-bitwidth configuration.
387 :param value: Graph node variant default value.
390 if variant == u"icl":
392 elif variant in [u"skx", u"hsw"]:
397 path = [u"dpdk", u"max-simd-bitwidth"]
398 self.add_config_item(self._nodeconfig, value, path)
400 def add_cpu_main_core(self, value):
401 """Add CPU main core configuration.
403 :param value: Main core option.
406 path = [u"cpu", u"main-core"]
407 self.add_config_item(self._nodeconfig, value, path)
409 def add_cpu_corelist_workers(self, value):
410 """Add CPU corelist-workers configuration.
412 :param value: Corelist-workers option.
415 path = [u"cpu", u"corelist-workers"]
416 self.add_config_item(self._nodeconfig, value, path)
418 def add_main_heap_size(self, value):
419 """Add Main Heap Size configuration.
421 :param value: Amount of heap.
424 path = [u"memory", u"main-heap-size"]
425 self.add_config_item(self._nodeconfig, value, path)
427 def add_main_heap_page_size(self, value):
428 """Add Main Heap Page Size configuration.
430 :param value: Heap page size.
433 path = [u"memory", u"main-heap-page-size"]
434 self.add_config_item(self._nodeconfig, value, path)
436 def add_api_trace(self):
437 """Add API trace configuration."""
438 path = [u"api-trace", u"on"]
439 self.add_config_item(self._nodeconfig, u"", path)
441 def add_ip6_hash_buckets(self, value):
442 """Add IP6 hash buckets configuration.
444 :param value: Number of IP6 hash buckets.
447 path = [u"ip6", u"hash-buckets"]
448 self.add_config_item(self._nodeconfig, value, path)
450 def add_ip6_heap_size(self, value):
451 """Add IP6 heap-size configuration.
453 :param value: IP6 Heapsize amount.
456 path = [u"ip6", u"heap-size"]
457 self.add_config_item(self._nodeconfig, value, path)
459 def add_spd_flow_cache_ipv4_outbound(self):
460 """Add SPD flow cache for IP4 outbound traffic"""
461 path = [u"ipsec", u"ipv4-outbound-spd-flow-cache"]
462 self.add_config_item(self._nodeconfig, "on", path)
464 def add_statseg_size(self, value):
465 """Add Stats Heap Size configuration.
467 :param value: Stats heapsize amount.
470 path = [u"statseg", u"size"]
471 self.add_config_item(self._nodeconfig, value, path)
473 def add_statseg_page_size(self, value):
474 """Add Stats Heap Page Size configuration.
476 :param value: Stats heapsize amount.
479 path = [u"statseg", u"page-size"]
480 self.add_config_item(self._nodeconfig, value, path)
482 def add_statseg_per_node_counters(self, value):
483 """Add stats per-node-counters configuration.
485 :param value: "on" to switch the counters on.
488 path = [u"statseg", u"per-node-counters"]
489 self.add_config_item(self._nodeconfig, value, path)
491 def add_plugin(self, state, *plugins):
492 """Add plugin section for specific plugin(s).
494 :param state: State of plugin [enable|disable].
495 :param plugins: Plugin(s) to disable.
499 for plugin in plugins:
500 path = [u"plugins", f"plugin {plugin}", state]
501 self.add_config_item(self._nodeconfig, u" ", path)
503 def add_dpdk_no_multi_seg(self):
504 """Add DPDK no-multi-seg configuration."""
505 path = [u"dpdk", u"no-multi-seg"]
506 self.add_config_item(self._nodeconfig, u"", path)
508 def add_dpdk_no_tx_checksum_offload(self):
509 """Add DPDK no-tx-checksum-offload configuration."""
510 path = [u"dpdk", u"no-tx-checksum-offload"]
511 self.add_config_item(self._nodeconfig, u"", path)
513 def add_nat(self, value=u"deterministic"):
514 """Add NAT mode configuration.
516 :param value: NAT mode.
519 path = [u"nat", value]
520 self.add_config_item(self._nodeconfig, u"", path)
522 def add_nat_max_translations_per_thread(self, value):
523 """Add NAT max. translations per thread number configuration.
525 :param value: NAT mode.
528 path = [u"nat", u"max translations per thread"]
529 self.add_config_item(self._nodeconfig, value, path)
531 def add_nsim_poll_main_thread(self):
532 """Add NSIM poll-main-thread configuration."""
533 path = [u"nsim", u"poll-main-thread"]
534 self.add_config_item(self._nodeconfig, u"", path)
536 def add_tcp_congestion_control_algorithm(self, value=u"cubic"):
537 """Add TCP congestion control algorithm.
539 :param value: The congestion control algorithm to use. Example: cubic
542 path = [u"tcp", u"cc-algo"]
543 self.add_config_item(self._nodeconfig, value, path)
545 def add_tcp_preallocated_connections(self, value):
546 """Add TCP pre-allocated connections.
548 :param value: The number of pre-allocated connections.
551 path = [u"tcp", u"preallocated-connections"]
552 self.add_config_item(self._nodeconfig, value, path)
554 def add_tcp_preallocated_half_open_connections(self, value):
555 """Add TCP pre-allocated half open connections.
557 :param value: The number of pre-allocated half open connections.
560 path = [u"tcp", u"preallocated-half-open-connections"]
561 self.add_config_item(self._nodeconfig, value, path)
563 def add_session_enable(self):
564 """Add session enable."""
565 path = [u"session", u"enable"]
566 self.add_config_item(self._nodeconfig, u"", path)
568 def add_session_event_queues_memfd_segment(self):
569 """Add session event queue memfd segment."""
570 path = [u"session", u"evt_qs_memfd_seg"]
571 self.add_config_item(self._nodeconfig, u"", path)
573 def add_session_event_queue_length(self, value):
574 """Add session event queue length.
576 :param value: Session event queue length.
579 path = [u"session", u"event-queue-length"]
580 self.add_config_item(self._nodeconfig, value, path)
582 def add_session_event_queues_segment_size(self, value):
583 """Add session event queue length.
585 :param value: Session event queue segment size.
588 path = [u"session", u"evt_qs_seg_size"]
589 self.add_config_item(self._nodeconfig, value, path)
591 def add_session_preallocated_sessions(self, value):
592 """Add the number of pre-allocated sessions.
594 :param value: Number of pre-allocated sessions.
597 path = [u"session", u"preallocated-sessions"]
598 self.add_config_item(self._nodeconfig, value, path)
600 def add_session_v4_session_table_buckets(self, value):
601 """Add number of v4 session table buckets to the config.
603 :param value: Number of v4 session table buckets.
606 path = [u"session", u"v4-session-table-buckets"]
607 self.add_config_item(self._nodeconfig, value, path)
609 def add_session_v4_session_table_memory(self, value):
610 """Add the size of v4 session table memory.
612 :param value: Size of v4 session table memory.
615 path = [u"session", u"v4-session-table-memory"]
616 self.add_config_item(self._nodeconfig, value, path)
618 def add_session_v4_halfopen_table_buckets(self, value):
619 """Add the number of v4 halfopen table buckets.
621 :param value: Number of v4 halfopen table buckets.
624 path = [u"session", u"v4-halfopen-table-buckets"]
625 self.add_config_item(self._nodeconfig, value, path)
627 def add_session_v4_halfopen_table_memory(self, value):
628 """Add the size of v4 halfopen table memory.
630 :param value: Size of v4 halfopen table memory.
633 path = [u"session", u"v4-halfopen-table-memory"]
634 self.add_config_item(self._nodeconfig, value, path)
636 def add_session_local_endpoints_table_buckets(self, value):
637 """Add the number of local endpoints table buckets.
639 :param value: Number of local endpoints table buckets.
642 path = [u"session", u"local-endpoints-table-buckets"]
643 self.add_config_item(self._nodeconfig, value, path)
645 def add_session_local_endpoints_table_memory(self, value):
646 """Add the size of local endpoints table memory.
648 :param value: Size of local endpoints table memory.
651 path = [u"session", u"local-endpoints-table-memory"]
652 self.add_config_item(self._nodeconfig, value, path)
654 def write_config(self, filename=None):
655 """Generate and write VPP startup configuration to file.
657 Use data from calls to this class to form a startup.conf file and
658 replace /etc/vpp/startup.conf with it on topology node.
660 :param filename: Startup configuration file name.
663 self.dump_config(self._nodeconfig)
666 filename = self._vpp_startup_conf
668 if self._vpp_startup_conf_backup is not None:
669 cmd = f"cp {self._vpp_startup_conf} {self._vpp_startup_conf_backup}"
671 self._node, cmd, sudo=True, message=u"Copy config file failed!"
674 cmd = f"echo \"{self._vpp_config}\" | sudo tee {filename}"
676 self._node, cmd, message=u"Writing config file failed!"
679 def apply_config(self, filename=None, verify_vpp=True):
680 """Generate and write VPP startup configuration to file and restart VPP.
682 Use data from calls to this class to form a startup.conf file and
683 replace /etc/vpp/startup.conf with it on topology node.
685 :param filename: Startup configuration file name.
686 :param verify_vpp: Verify VPP is running after restart.
688 :type verify_vpp: bool
690 self.write_config(filename=filename)
692 VPPUtil.restart_vpp_service(self._node, self._node_key)
694 VPPUtil.verify_vpp(self._node)
696 def restore_config(self):
697 """Restore VPP startup.conf from backup."""
698 cmd = f"cp {self._vpp_startup_conf_backup} {self._vpp_startup_conf}"
700 self._node, cmd, sudo=True, message=u"Copy config file failed!"