1 # Copyright (c) 2024 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."""
18 from resources.libraries.python.Constants import Constants
19 from resources.libraries.python.ssh import exec_cmd_no_error
20 from resources.libraries.python.topology import NodeType
21 from resources.libraries.python.topology import Topology
22 from resources.libraries.python.VPPUtil import VPPUtil
24 __all__ = ["VppConfigGenerator", "VppInitConfig"]
27 def pci_dev_check(pci_dev):
28 """Check if provided PCI address is in correct format.
30 :param pci_dev: PCI address (expected format: xxxx:xx:xx.x).
32 :returns: True if PCI address is in correct format.
34 :raises ValueError: If PCI address is in incorrect format.
37 r"^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}\.[0-9A-Fa-f]$"
39 if not re.match(pattern, pci_dev):
41 f"PCI address {pci_dev} is not in valid format xxxx:xx:xx.x"
46 class VppConfigGenerator:
47 """VPP Configuration File Generator."""
50 """Initialize library."""
51 # VPP Node to apply configuration on
56 self._nodeconfig = dict()
57 # Serialized VPP Configuration
60 self._vpp_service_name = "vpp"
61 # VPP Startup config location
62 self._vpp_startup_conf = "/etc/vpp/startup.conf"
64 def set_node(self, node, node_key=None):
67 :param node: Node to store configuration on.
68 :param node_key: Topology node key.
71 :raises RuntimeError: If Node type is not DUT.
73 if node["type"] != NodeType.DUT:
75 "Startup config can only be applied to DUTnode."
78 self._node_key = node_key
80 def get_config_str(self):
81 """Get dumped startup configuration in VPP config format.
83 :returns: Startup configuration in VPP config format.
86 self.dump_config(self._nodeconfig)
87 return self._vpp_config
89 def add_config_item(self, config, value, path):
90 """Add startup configuration item.
92 :param config: Startup configuration of node.
93 :param value: Value to insert.
94 :param path: Path where to insert item.
100 config[path[0]] = value
102 if path[0] not in config:
103 config[path[0]] = dict()
104 elif isinstance(config[path[0]], str):
105 config[path[0]] = dict() if config[path[0]] == "" \
106 else {config[path[0]]: ""}
107 self.add_config_item(config[path[0]], value, path[1:])
109 def dump_config(self, obj, level=-1):
110 """Dump the startup configuration in VPP config format.
112 :param obj: Python Object to print.
113 :param level: Nested level for indentation.
120 self._vpp_config += f"{level * indent}{{\n"
121 if isinstance(obj, dict):
122 for key, val in obj.items():
123 if hasattr(val, u"__iter__") and not isinstance(val, str):
124 self._vpp_config += f"{(level + 1) * indent}{key}\n"
125 self.dump_config(val, level + 1)
127 self._vpp_config += f"{(level + 1) * indent}{key} {val}\n"
130 self._vpp_config += f"{(level + 1) * indent}{val}\n"
132 self._vpp_config += f"{level * indent}}}\n"
134 def add_unix_log(self, value="/var/log/vpp/vpp.log"):
135 """Add UNIX log configuration.
137 :param value: Log file.
140 path = ["unix", "log"]
141 self.add_config_item(self._nodeconfig, value, path)
143 def add_unix_cli_listen(self, value="/run/vpp/cli.sock"):
144 """Add UNIX cli-listen configuration.
146 :param value: CLI listen address and port or path to CLI socket.
149 path = ["unix", "cli-listen"]
150 self.add_config_item(self._nodeconfig, value, path)
152 def add_unix_cli_no_pager(self):
153 """Add UNIX cli-no-pager configuration."""
154 path = ["unix", "cli-no-pager"]
155 self.add_config_item(self._nodeconfig, "", path)
157 def add_unix_gid(self, value="vpp"):
158 """Add UNIX gid configuration.
163 path = ["unix", "gid"]
164 self.add_config_item(self._nodeconfig, value, path)
166 def add_unix_nodaemon(self):
167 """Add UNIX nodaemon configuration."""
168 path = ["unix", "nodaemon"]
169 self.add_config_item(self._nodeconfig, "", path)
171 def add_unix_coredump(self):
172 """Add UNIX full-coredump configuration."""
173 path = ["unix", "full-coredump"]
174 self.add_config_item(self._nodeconfig, "", path)
176 def add_unix_exec(self, value):
177 """Add UNIX exec configuration."""
178 path = ["unix", "exec"]
179 self.add_config_item(self._nodeconfig, value, path)
181 def add_socksvr(self, socket=Constants.SOCKSVR_PATH):
182 """Add socksvr configuration."""
183 path = ["socksvr", "socket-name"]
184 self.add_config_item(self._nodeconfig, socket, path)
186 def add_graph_node_variant(self, variant=Constants.GRAPH_NODE_VARIANT):
187 """Add default graph node variant.
189 :param value: Graph node variant default value.
194 variant_list = ["hsw", "skx", "icl"]
195 if variant not in variant_list:
196 raise ValueError("Invalid graph node variant value")
197 path = ["node", "default", "variant"]
198 self.add_config_item(self._nodeconfig, variant, path)
200 def add_api_segment_gid(self, value="vpp"):
201 """Add api-segment gid configuration.
206 path = ["api-segment", "gid"]
207 self.add_config_item(self._nodeconfig, value, path)
209 def add_api_segment_global_size(self, value):
210 """Add api-segment global-size configuration.
212 :param value: Global size.
215 path = ["api-segment", "global-size"]
216 self.add_config_item(self._nodeconfig, value, path)
218 def add_api_segment_prefix(self, value="vpp"):
219 """Add api-segment prefix configuration.
224 path = ["api-segment", "prefix"]
225 self.add_config_item(self._nodeconfig, value, path)
227 def add_api_segment_api_size(self, value):
228 """Add api-segment api-size configuration.
230 :param value: API size.
233 path = ["api-segment", "api-size"]
234 self.add_config_item(self._nodeconfig, value, path)
236 def add_buffers_per_numa(self, value):
237 """Increase number of buffers allocated.
239 :param value: Number of buffers allocated.
242 path = ["buffers", "buffers-per-numa"]
243 self.add_config_item(self._nodeconfig, value, path)
245 def add_buffers_default_data_size(self, value):
246 """Increase buffers data-size allocated.
248 :param value: Buffers data-size allocated.
251 path = ["buffers", "default data-size"]
252 self.add_config_item(self._nodeconfig, value, path)
254 def add_dpdk_dev(self, *devices):
255 """Add DPDK PCI device configuration.
257 :param devices: PCI device(s) (format xxxx:xx:xx.x)
260 for device in devices:
261 if pci_dev_check(device):
262 path = ["dpdk", f"dev {device}"]
263 self.add_config_item(self._nodeconfig, "", path)
265 def add_dpdk_cryptodev(self, count, num_rx_queues=1):
266 """Add DPDK Crypto PCI device configuration.
268 :param count: Number of HW crypto devices to add.
269 :param num_rx_queues: Number of RX queues per QAT interface.
271 :type num_rx_queues: int
273 cryptodevs = Topology.get_cryptodev(self._node)
274 for device in cryptodevs.values():
275 for i in range(int(count/len(cryptodevs))):
276 numvfs = device["numvfs"]
277 computed = f"{(i+1)//numvfs}.{(i+1)%numvfs}"
278 addr = re.sub(r"\d.\d$", computed, device["pci_address"])
279 path = ["dpdk", f"dev {addr}", "num-rx-queues"]
280 self.add_config_item(self._nodeconfig, num_rx_queues, path)
281 self.add_dpdk_uio_driver("vfio-pci")
283 def add_dpdk_sw_cryptodev(self, sw_pmd_type, socket_id, count):
284 """Add DPDK SW Crypto device configuration.
286 :param sw_pmd_type: Type of SW crypto device PMD to add.
287 :param socket_id: Socket ID.
288 :param count: Number of SW crypto devices to add.
289 :type sw_pmd_type: str
293 for _ in range(count):
294 cryptodev_config = f"vdev cryptodev_{sw_pmd_type}_pmd," \
295 f"socket_id={str(socket_id)}"
296 path = ["dpdk", cryptodev_config]
297 self.add_config_item(self._nodeconfig, "", path)
299 def add_dpdk_dev_default_rxq(self, value):
300 """Add DPDK dev default rxq configuration.
302 :param value: Default number of rxqs.
305 path = ["dpdk", "dev default", "num-rx-queues"]
306 self.add_config_item(self._nodeconfig, value, path)
308 def add_dpdk_dev_default_txq(self, value):
309 """Add DPDK dev default txq configuration.
311 :param value: Default number of txqs.
314 path = ["dpdk", "dev default", "num-tx-queues"]
315 self.add_config_item(self._nodeconfig, value, path)
317 def add_dpdk_dev_default_rxd(self, value):
318 """Add DPDK dev default rxd configuration.
320 :param value: Default number of rxds.
323 path = ["dpdk", "dev default", "num-rx-desc"]
324 self.add_config_item(self._nodeconfig, value, path)
326 def add_dpdk_dev_default_txd(self, value):
327 """Add DPDK dev default txd configuration.
329 :param value: Default number of txds.
332 path = ["dpdk", "dev default", "num-tx-desc"]
333 self.add_config_item(self._nodeconfig, value, path)
335 def add_dpdk_log_level(self, value):
336 """Add DPDK log-level configuration.
338 :param value: Log level.
341 path = ["dpdk", "log-level"]
342 self.add_config_item(self._nodeconfig, value, path)
344 def add_dpdk_no_pci(self):
345 """Add DPDK no-pci."""
346 path = ["dpdk", "no-pci"]
347 self.add_config_item(self._nodeconfig, "", path)
349 def add_dpdk_uio_driver(self, value=None):
350 """Add DPDK uio-driver configuration.
352 :param value: DPDK uio-driver configuration. By default, driver will be
353 loaded automatically from Topology file, still leaving option
354 to manually override by parameter.
358 value = Topology.get_uio_driver(self._node)
359 path = ["dpdk", "uio-driver"]
360 self.add_config_item(self._nodeconfig, value, path)
362 def add_dpdk_max_simd_bitwidth(self, variant=Constants.GRAPH_NODE_VARIANT):
363 """Add DPDK max-simd-bitwidth configuration.
365 :param value: Graph node variant default value.
370 elif variant in ["skx", "hsw"]:
375 path = ["dpdk", "max-simd-bitwidth"]
376 self.add_config_item(self._nodeconfig, value, path)
378 def add_cpu_main_core(self, value):
379 """Add CPU main core configuration.
381 :param value: Main core option.
384 path = ["cpu", "main-core"]
385 self.add_config_item(self._nodeconfig, value, path)
387 def add_cpu_corelist_workers(self, value):
388 """Add CPU corelist-workers configuration.
390 :param value: Corelist-workers option.
393 path = ["cpu", "corelist-workers"]
394 self.add_config_item(self._nodeconfig, value, path)
396 def add_main_heap_size(self, value):
397 """Add Main Heap Size configuration.
399 :param value: Amount of heap.
402 path = ["memory", "main-heap-size"]
403 self.add_config_item(self._nodeconfig, value, path)
405 def add_main_heap_page_size(self, value):
406 """Add Main Heap Page Size configuration.
408 :param value: Heap page size.
411 path = ["memory", "main-heap-page-size"]
412 self.add_config_item(self._nodeconfig, value, path)
414 def add_default_hugepage_size(self, value=Constants.DEFAULT_HUGEPAGE_SIZE):
415 """Add Default Hugepage Size configuration.
417 :param value: Hugepage size.
420 path = ["memory", "default-hugepage-size"]
421 self.add_config_item(self._nodeconfig, value, path)
423 def add_api_trace(self):
424 """Add API trace configuration."""
425 path = ["api-trace", "on"]
426 self.add_config_item(self._nodeconfig, "", path)
428 def add_ip6_hash_buckets(self, value):
429 """Add IP6 hash buckets configuration.
431 :param value: Number of IP6 hash buckets.
434 path = ["ip6", "hash-buckets"]
435 self.add_config_item(self._nodeconfig, value, path)
437 def add_ip6_heap_size(self, value):
438 """Add IP6 heap-size configuration.
440 :param value: IP6 Heapsize amount.
443 path = ["ip6", "heap-size"]
444 self.add_config_item(self._nodeconfig, value, path)
446 def add_ipsec_spd_flow_cache_ipv4_inbound(self, value):
447 """Add IPsec spd flow cache for IP4 inbound.
449 :param value: "on" to enable spd flow cache.
452 path = ["ipsec", "ipv4-inbound-spd-flow-cache"]
453 self.add_config_item(self._nodeconfig, value, path)
455 def add_ipsec_spd_flow_cache_ipv4_outbound(self, value):
456 """Add IPsec spd flow cache for IP4 outbound.
458 :param value: "on" to enable spd flow cache.
461 path = ["ipsec", "ipv4-outbound-spd-flow-cache"]
462 self.add_config_item(self._nodeconfig, value, path)
464 def add_ipsec_spd_fast_path_ipv4_inbound(self, value):
465 """Add IPsec spd fast path for IP4 inbound.
467 :param value: "on" to enable spd fast path.
470 path = [u"ipsec", u"ipv4-inbound-spd-fast-path"]
471 self.add_config_item(self._nodeconfig, value, path)
473 def add_ipsec_spd_fast_path_ipv4_outbound(self, value):
474 """Add IPsec spd fast path for IP4 outbound.
476 :param value: "on" to enable spd fast path.
479 path = ["ipsec", "ipv4-outbound-spd-fast-path"]
480 self.add_config_item(self._nodeconfig, value, path)
482 def add_ipsec_spd_fast_path_num_buckets(self, value):
483 """Add num buckets for IPsec spd fast path.
485 :param value: Number of buckets.
488 path = ["ipsec", "spd-fast-path-num-buckets"]
489 self.add_config_item(self._nodeconfig, value, path)
491 def add_statseg_size(self, value):
492 """Add Stats Heap Size configuration.
494 :param value: Stats heapsize amount.
497 path = ["statseg", "size"]
498 self.add_config_item(self._nodeconfig, value, path)
500 def add_statseg_page_size(self, value):
501 """Add Stats Heap Page Size configuration.
503 :param value: Stats heapsize amount.
506 path = ["statseg", "page-size"]
507 self.add_config_item(self._nodeconfig, value, path)
509 def add_statseg_per_node_counters(self, value):
510 """Add stats per-node-counters configuration.
512 :param value: "on" to switch the counters on.
515 path = ["statseg", "per-node-counters"]
516 self.add_config_item(self._nodeconfig, value, path)
518 def add_plugin(self, state, *plugins):
519 """Add plugin section for specific plugin(s).
521 :param state: State of plugin [enable|disable].
522 :param plugins: Plugin(s) to disable.
526 for plugin in plugins:
527 path = ["plugins", f"plugin {plugin}", state]
528 self.add_config_item(self._nodeconfig, " ", path)
530 def add_dpdk_no_multi_seg(self):
531 """Add DPDK no-multi-seg configuration."""
532 path = ["dpdk", "no-multi-seg"]
533 self.add_config_item(self._nodeconfig, "", path)
535 def add_dpdk_no_tx_checksum_offload(self):
536 """Add DPDK no-tx-checksum-offload configuration."""
537 path = ["dpdk", "no-tx-checksum-offload"]
538 self.add_config_item(self._nodeconfig, "", path)
540 def add_nat(self, value="deterministic"):
541 """Add NAT mode configuration.
543 :param value: NAT mode.
546 path = ["nat", value]
547 self.add_config_item(self._nodeconfig, "", path)
549 def add_nat_max_translations_per_thread(self, value):
550 """Add NAT max. translations per thread number configuration.
552 :param value: NAT mode.
555 path = ["nat", "max translations per thread"]
556 self.add_config_item(self._nodeconfig, value, path)
558 def add_nsim_poll_main_thread(self):
559 """Add NSIM poll-main-thread configuration."""
560 path = ["nsim", "poll-main-thread"]
561 self.add_config_item(self._nodeconfig, "", path)
563 def add_tcp_congestion_control_algorithm(self, value="cubic"):
564 """Add TCP congestion control algorithm.
566 :param value: The congestion control algorithm to use. Example: cubic
569 path = ["tcp", "cc-algo"]
570 self.add_config_item(self._nodeconfig, value, path)
572 def add_tcp_preallocated_connections(self, value):
573 """Add TCP pre-allocated connections.
575 :param value: The number of pre-allocated connections.
578 path = ["tcp", "preallocated-connections"]
579 self.add_config_item(self._nodeconfig, value, path)
581 def add_tcp_preallocated_half_open_connections(self, value):
582 """Add TCP pre-allocated half open connections.
584 :param value: The number of pre-allocated half open connections.
587 path = ["tcp", "preallocated-half-open-connections"]
588 self.add_config_item(self._nodeconfig, value, path)
590 def add_session_enable(self):
591 """Add session enable."""
592 path = ["session", "enable"]
593 self.add_config_item(self._nodeconfig, "", path)
595 def add_session_app_socket_api(self):
596 """Use session app socket api."""
597 path = ["session", "use-app-socket-api"]
598 self.add_config_item(self._nodeconfig, "", path)
600 def add_session_event_queues_memfd_segment(self):
601 """Add session event queue memfd segment."""
602 path = ["session", "evt_qs_memfd_seg"]
603 self.add_config_item(self._nodeconfig, "", path)
605 def add_session_event_queue_length(self, value):
606 """Add session event queue length.
608 :param value: Session event queue length.
611 path = ["session", "event-queue-length"]
612 self.add_config_item(self._nodeconfig, value, path)
614 def add_session_event_queues_segment_size(self, value):
615 """Add session event queue length.
617 :param value: Session event queue segment size.
620 path = ["session", "evt_qs_seg_size"]
621 self.add_config_item(self._nodeconfig, value, path)
623 def add_session_preallocated_sessions(self, value):
624 """Add the number of pre-allocated sessions.
626 :param value: Number of pre-allocated sessions.
629 path = ["session", "preallocated-sessions"]
630 self.add_config_item(self._nodeconfig, value, path)
632 def add_session_v4_session_table_buckets(self, value):
633 """Add number of v4 session table buckets to the config.
635 :param value: Number of v4 session table buckets.
638 path = ["session", "v4-session-table-buckets"]
639 self.add_config_item(self._nodeconfig, value, path)
641 def add_session_v4_session_table_memory(self, value):
642 """Add the size of v4 session table memory.
644 :param value: Size of v4 session table memory.
647 path = ["session", "v4-session-table-memory"]
648 self.add_config_item(self._nodeconfig, value, path)
650 def add_session_v4_halfopen_table_buckets(self, value):
651 """Add the number of v4 halfopen table buckets.
653 :param value: Number of v4 halfopen table buckets.
656 path = ["session", "v4-halfopen-table-buckets"]
657 self.add_config_item(self._nodeconfig, value, path)
659 def add_session_v4_halfopen_table_memory(self, value):
660 """Add the size of v4 halfopen table memory.
662 :param value: Size of v4 halfopen table memory.
665 path = ["session", "v4-halfopen-table-memory"]
666 self.add_config_item(self._nodeconfig, value, path)
668 def add_session_local_endpoints_table_buckets(self, value):
669 """Add the number of local endpoints table buckets.
671 :param value: Number of local endpoints table buckets.
674 path = ["session", "local-endpoints-table-buckets"]
675 self.add_config_item(self._nodeconfig, value, path)
677 def add_session_local_endpoints_table_memory(self, value):
678 """Add the size of local endpoints table memory.
680 :param value: Size of local endpoints table memory.
683 path = ["session", "local-endpoints-table-memory"]
684 self.add_config_item(self._nodeconfig, value, path)
686 def add_dma_dev(self, devices):
687 """Add DMA devices configuration.
689 :param devices: DMA devices or work queues.
692 for device in devices:
693 path = ["dsa", f"dev {device}"]
694 self.add_config_item(self._nodeconfig, "", path)
696 def add_logging_default_syslog_log_level(self, value="debug"):
697 """Add default logging level for syslog.
699 :param value: Log level.
702 path = ["logging", "default-syslog-log-level"]
703 self.add_config_item(self._nodeconfig, value, path)
705 def write_config(self, filename=None):
706 """Generate and write VPP startup configuration to file.
708 Use data from calls to this class to form a startup.conf file and
709 replace /etc/vpp/startup.conf with it on topology node.
711 :param filename: Startup configuration file name.
714 self.dump_config(self._nodeconfig)
717 filename = self._vpp_startup_conf
719 cmd = f"echo \"{self._vpp_config}\" | sudo tee {filename}"
721 self._node, cmd, message="Writing config file failed!"
724 def apply_config(self, filename=None, verify_vpp=True):
725 """Generate and write VPP startup configuration to file and restart VPP.
727 Use data from calls to this class to form a startup.conf file and
728 replace /etc/vpp/startup.conf with it on topology node.
730 :param filename: Startup configuration file name.
731 :param verify_vpp: Verify VPP is running after restart.
733 :type verify_vpp: bool
735 self.write_config(filename=filename)
737 VPPUtil.restart_vpp_service(self._node, self._node_key)
739 VPPUtil.verify_vpp(self._node)
743 """VPP Initial Configuration."""
745 def init_vpp_startup_configuration_on_all_duts(nodes):
746 """Apply initial VPP startup configuration on all DUTs.
748 :param nodes: Nodes in the topology.
751 huge_size = Constants.DEFAULT_HUGEPAGE_SIZE
752 for node in nodes.values():
753 if node["type"] == NodeType.DUT:
754 vpp_config = VppConfigGenerator()
755 vpp_config.set_node(node)
756 vpp_config.add_unix_log()
757 vpp_config.add_unix_cli_listen()
758 vpp_config.add_unix_cli_no_pager()
759 vpp_config.add_unix_gid()
760 vpp_config.add_unix_coredump()
761 vpp_config.add_socksvr(socket=Constants.SOCKSVR_PATH)
762 vpp_config.add_main_heap_size("2G")
763 vpp_config.add_main_heap_page_size(huge_size)
764 vpp_config.add_default_hugepage_size(huge_size)
765 vpp_config.add_statseg_size("2G")
766 vpp_config.add_statseg_page_size(huge_size)
767 vpp_config.add_statseg_per_node_counters("on")
768 vpp_config.add_plugin("disable", "default")
769 vpp_config.add_plugin("enable", "dpdk_plugin.so")
770 vpp_config.add_dpdk_dev(
771 *[node["interfaces"][interface].get("pci_address") \
772 for interface in node["interfaces"]]
774 vpp_config.add_ip6_hash_buckets(2000000)
775 vpp_config.add_ip6_heap_size("4G")
776 vpp_config.apply_config()