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
58 self._vpp_config = u""
60 self._vpp_service_name = u"vpp"
61 # VPP Startup config location
62 self._vpp_startup_conf = u"/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[u"type"] != NodeType.DUT:
75 u"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]] == u"" \
106 else {config[path[0]]: u""}
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 = [u"unix", u"log"]
141 self.add_config_item(self._nodeconfig, value, path)
143 def add_unix_cli_listen(self, value=u"/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 = [u"unix", u"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 = [u"unix", u"cli-no-pager"]
155 self.add_config_item(self._nodeconfig, u"", path)
157 def add_unix_gid(self, value=u"vpp"):
158 """Add UNIX gid configuration.
163 path = [u"unix", u"gid"]
164 self.add_config_item(self._nodeconfig, value, path)
166 def add_unix_nodaemon(self):
167 """Add UNIX nodaemon configuration."""
168 path = [u"unix", u"nodaemon"]
169 self.add_config_item(self._nodeconfig, u"", path)
171 def add_unix_coredump(self):
172 """Add UNIX full-coredump configuration."""
173 path = [u"unix", u"full-coredump"]
174 self.add_config_item(self._nodeconfig, u"", path)
176 def add_unix_exec(self, value):
177 """Add UNIX exec configuration."""
178 path = [u"unix", u"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 = [u"socksvr", u"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 = [u"hsw", u"skx", u"icl"]
195 if variant not in variant_list:
196 raise ValueError("Invalid graph node variant value")
197 path = [u"node", u"default", u"variant"]
198 self.add_config_item(self._nodeconfig, variant, path)
200 def add_api_segment_gid(self, value=u"vpp"):
201 """Add API-SEGMENT gid configuration.
206 path = [u"api-segment", u"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 = [u"api-segment", u"global-size"]
216 self.add_config_item(self._nodeconfig, value, path)
218 def add_api_segment_api_size(self, value):
219 """Add API-SEGMENT api-size configuration.
221 :param value: API size.
224 path = [u"api-segment", u"api-size"]
225 self.add_config_item(self._nodeconfig, value, path)
227 def add_buffers_per_numa(self, value):
228 """Increase number of buffers allocated.
230 :param value: Number of buffers allocated.
233 path = [u"buffers", u"buffers-per-numa"]
234 self.add_config_item(self._nodeconfig, value, path)
236 def add_buffers_default_data_size(self, value):
237 """Increase buffers data-size allocated.
239 :param value: Buffers data-size allocated.
242 path = [u"buffers", u"default data-size"]
243 self.add_config_item(self._nodeconfig, value, path)
245 def add_dpdk_dev(self, *devices):
246 """Add DPDK PCI device configuration.
248 :param devices: PCI device(s) (format xxxx:xx:xx.x)
251 for device in devices:
252 if pci_dev_check(device):
253 path = [u"dpdk", f"dev {device}"]
254 self.add_config_item(self._nodeconfig, u"", path)
256 def add_dpdk_cryptodev(self, count, num_rx_queues=1):
257 """Add DPDK Crypto PCI device configuration.
259 :param count: Number of HW crypto devices to add.
260 :param num_rx_queues: Number of RX queues per QAT interface.
262 :type num_rx_queues: int
264 cryptodevs = Topology.get_cryptodev(self._node)
265 for device in cryptodevs.values():
266 for i in range(int(count/len(cryptodevs))):
267 numvfs = device["numvfs"]
268 computed = f"{(i+1)//numvfs}.{(i+1)%numvfs}"
269 addr = re.sub(r"\d.\d$", computed, device["pci_address"])
270 path = ["dpdk", f"dev {addr}", "num-rx-queues"]
271 self.add_config_item(self._nodeconfig, num_rx_queues, path)
272 self.add_dpdk_uio_driver("vfio-pci")
274 def add_dpdk_sw_cryptodev(self, sw_pmd_type, socket_id, count):
275 """Add DPDK SW Crypto device configuration.
277 :param sw_pmd_type: Type of SW crypto device PMD to add.
278 :param socket_id: Socket ID.
279 :param count: Number of SW crypto devices to add.
280 :type sw_pmd_type: str
284 for _ in range(count):
285 cryptodev_config = f"vdev cryptodev_{sw_pmd_type}_pmd," \
286 f"socket_id={str(socket_id)}"
287 path = [u"dpdk", cryptodev_config]
288 self.add_config_item(self._nodeconfig, u"", path)
290 def add_dpdk_dev_default_rxq(self, value):
291 """Add DPDK dev default rxq configuration.
293 :param value: Default number of rxqs.
296 path = [u"dpdk", u"dev default", u"num-rx-queues"]
297 self.add_config_item(self._nodeconfig, value, path)
299 def add_dpdk_dev_default_txq(self, value):
300 """Add DPDK dev default txq configuration.
302 :param value: Default number of txqs.
305 path = [u"dpdk", u"dev default", u"num-tx-queues"]
306 self.add_config_item(self._nodeconfig, value, path)
308 def add_dpdk_dev_default_rxd(self, value):
309 """Add DPDK dev default rxd configuration.
311 :param value: Default number of rxds.
314 path = [u"dpdk", u"dev default", u"num-rx-desc"]
315 self.add_config_item(self._nodeconfig, value, path)
317 def add_dpdk_dev_default_txd(self, value):
318 """Add DPDK dev default txd configuration.
320 :param value: Default number of txds.
323 path = [u"dpdk", u"dev default", u"num-tx-desc"]
324 self.add_config_item(self._nodeconfig, value, path)
326 def add_dpdk_log_level(self, value):
327 """Add DPDK log-level configuration.
329 :param value: Log level.
332 path = [u"dpdk", u"log-level"]
333 self.add_config_item(self._nodeconfig, value, path)
335 def add_dpdk_no_pci(self):
336 """Add DPDK no-pci."""
337 path = [u"dpdk", u"no-pci"]
338 self.add_config_item(self._nodeconfig, u"", path)
340 def add_dpdk_uio_driver(self, value=None):
341 """Add DPDK uio-driver configuration.
343 :param value: DPDK uio-driver configuration. By default, driver will be
344 loaded automatically from Topology file, still leaving option
345 to manually override by parameter.
349 value = Topology.get_uio_driver(self._node)
350 path = [u"dpdk", u"uio-driver"]
351 self.add_config_item(self._nodeconfig, value, path)
353 def add_dpdk_max_simd_bitwidth(self, variant=Constants.GRAPH_NODE_VARIANT):
354 """Add DPDK max-simd-bitwidth configuration.
356 :param value: Graph node variant default value.
359 if variant == u"icl":
361 elif variant in [u"skx", u"hsw"]:
366 path = [u"dpdk", u"max-simd-bitwidth"]
367 self.add_config_item(self._nodeconfig, value, path)
369 def add_cpu_main_core(self, value):
370 """Add CPU main core configuration.
372 :param value: Main core option.
375 path = [u"cpu", u"main-core"]
376 self.add_config_item(self._nodeconfig, value, path)
378 def add_cpu_corelist_workers(self, value):
379 """Add CPU corelist-workers configuration.
381 :param value: Corelist-workers option.
384 path = [u"cpu", u"corelist-workers"]
385 self.add_config_item(self._nodeconfig, value, path)
387 def add_main_heap_size(self, value):
388 """Add Main Heap Size configuration.
390 :param value: Amount of heap.
393 path = [u"memory", u"main-heap-size"]
394 self.add_config_item(self._nodeconfig, value, path)
396 def add_main_heap_page_size(self, value):
397 """Add Main Heap Page Size configuration.
399 :param value: Heap page size.
402 path = [u"memory", u"main-heap-page-size"]
403 self.add_config_item(self._nodeconfig, value, path)
405 def add_default_hugepage_size(self, value=Constants.DEFAULT_HUGEPAGE_SIZE):
406 """Add Default Hugepage Size configuration.
408 :param value: Hugepage size.
411 path = [u"memory", u"default-hugepage-size"]
412 self.add_config_item(self._nodeconfig, value, path)
414 def add_api_trace(self):
415 """Add API trace configuration."""
416 path = [u"api-trace", u"on"]
417 self.add_config_item(self._nodeconfig, u"", path)
419 def add_ip6_hash_buckets(self, value):
420 """Add IP6 hash buckets configuration.
422 :param value: Number of IP6 hash buckets.
425 path = [u"ip6", u"hash-buckets"]
426 self.add_config_item(self._nodeconfig, value, path)
428 def add_ip6_heap_size(self, value):
429 """Add IP6 heap-size configuration.
431 :param value: IP6 Heapsize amount.
434 path = [u"ip6", u"heap-size"]
435 self.add_config_item(self._nodeconfig, value, path)
437 def add_ipsec_spd_flow_cache_ipv4_inbound(self, value):
438 """Add IPsec spd flow cache for IP4 inbound.
440 :param value: "on" to enable spd flow cache.
443 path = [u"ipsec", u"ipv4-inbound-spd-flow-cache"]
444 self.add_config_item(self._nodeconfig, value, path)
446 def add_ipsec_spd_flow_cache_ipv4_outbound(self, value):
447 """Add IPsec spd flow cache for IP4 outbound.
449 :param value: "on" to enable spd flow cache.
452 path = [u"ipsec", u"ipv4-outbound-spd-flow-cache"]
453 self.add_config_item(self._nodeconfig, value, path)
455 def add_ipsec_spd_fast_path_ipv4_inbound(self, value):
456 """Add IPsec spd fast path for IP4 inbound.
458 :param value: "on" to enable spd fast path.
461 path = [u"ipsec", u"ipv4-inbound-spd-fast-path"]
462 self.add_config_item(self._nodeconfig, value, path)
464 def add_ipsec_spd_fast_path_ipv4_outbound(self, value):
465 """Add IPsec spd fast path for IP4 outbound.
467 :param value: "on" to enable spd fast path.
470 path = [u"ipsec", u"ipv4-outbound-spd-fast-path"]
471 self.add_config_item(self._nodeconfig, value, path)
473 def add_ipsec_spd_fast_path_num_buckets(self, value):
474 """Add num buckets for IPsec spd fast path.
476 :param value: Number of buckets.
479 path = [u"ipsec", u"spd-fast-path-num-buckets"]
480 self.add_config_item(self._nodeconfig, value, path)
482 def add_statseg_size(self, value):
483 """Add Stats Heap Size configuration.
485 :param value: Stats heapsize amount.
488 path = [u"statseg", u"size"]
489 self.add_config_item(self._nodeconfig, value, path)
491 def add_statseg_page_size(self, value):
492 """Add Stats Heap Page Size configuration.
494 :param value: Stats heapsize amount.
497 path = [u"statseg", u"page-size"]
498 self.add_config_item(self._nodeconfig, value, path)
500 def add_statseg_per_node_counters(self, value):
501 """Add stats per-node-counters configuration.
503 :param value: "on" to switch the counters on.
506 path = [u"statseg", u"per-node-counters"]
507 self.add_config_item(self._nodeconfig, value, path)
509 def add_plugin(self, state, *plugins):
510 """Add plugin section for specific plugin(s).
512 :param state: State of plugin [enable|disable].
513 :param plugins: Plugin(s) to disable.
517 for plugin in plugins:
518 path = [u"plugins", f"plugin {plugin}", state]
519 self.add_config_item(self._nodeconfig, u" ", path)
521 def add_dpdk_no_multi_seg(self):
522 """Add DPDK no-multi-seg configuration."""
523 path = [u"dpdk", u"no-multi-seg"]
524 self.add_config_item(self._nodeconfig, u"", path)
526 def add_dpdk_no_tx_checksum_offload(self):
527 """Add DPDK no-tx-checksum-offload configuration."""
528 path = [u"dpdk", u"no-tx-checksum-offload"]
529 self.add_config_item(self._nodeconfig, u"", path)
531 def add_nat(self, value=u"deterministic"):
532 """Add NAT mode configuration.
534 :param value: NAT mode.
537 path = [u"nat", value]
538 self.add_config_item(self._nodeconfig, u"", path)
540 def add_nat_max_translations_per_thread(self, value):
541 """Add NAT max. translations per thread number configuration.
543 :param value: NAT mode.
546 path = [u"nat", u"max translations per thread"]
547 self.add_config_item(self._nodeconfig, value, path)
549 def add_nsim_poll_main_thread(self):
550 """Add NSIM poll-main-thread configuration."""
551 path = [u"nsim", u"poll-main-thread"]
552 self.add_config_item(self._nodeconfig, u"", path)
554 def add_tcp_congestion_control_algorithm(self, value=u"cubic"):
555 """Add TCP congestion control algorithm.
557 :param value: The congestion control algorithm to use. Example: cubic
560 path = [u"tcp", u"cc-algo"]
561 self.add_config_item(self._nodeconfig, value, path)
563 def add_tcp_preallocated_connections(self, value):
564 """Add TCP pre-allocated connections.
566 :param value: The number of pre-allocated connections.
569 path = [u"tcp", u"preallocated-connections"]
570 self.add_config_item(self._nodeconfig, value, path)
572 def add_tcp_preallocated_half_open_connections(self, value):
573 """Add TCP pre-allocated half open connections.
575 :param value: The number of pre-allocated half open connections.
578 path = [u"tcp", u"preallocated-half-open-connections"]
579 self.add_config_item(self._nodeconfig, value, path)
581 def add_session_enable(self):
582 """Add session enable."""
583 path = [u"session", u"enable"]
584 self.add_config_item(self._nodeconfig, u"", path)
586 def add_session_app_socket_api(self):
587 """Use session app socket api."""
588 path = [u"session", u"use-app-socket-api"]
589 self.add_config_item(self._nodeconfig, u"", path)
591 def add_session_event_queues_memfd_segment(self):
592 """Add session event queue memfd segment."""
593 path = [u"session", u"evt_qs_memfd_seg"]
594 self.add_config_item(self._nodeconfig, u"", path)
596 def add_session_event_queue_length(self, value):
597 """Add session event queue length.
599 :param value: Session event queue length.
602 path = [u"session", u"event-queue-length"]
603 self.add_config_item(self._nodeconfig, value, path)
605 def add_session_event_queues_segment_size(self, value):
606 """Add session event queue length.
608 :param value: Session event queue segment size.
611 path = [u"session", u"evt_qs_seg_size"]
612 self.add_config_item(self._nodeconfig, value, path)
614 def add_session_preallocated_sessions(self, value):
615 """Add the number of pre-allocated sessions.
617 :param value: Number of pre-allocated sessions.
620 path = [u"session", u"preallocated-sessions"]
621 self.add_config_item(self._nodeconfig, value, path)
623 def add_session_v4_session_table_buckets(self, value):
624 """Add number of v4 session table buckets to the config.
626 :param value: Number of v4 session table buckets.
629 path = [u"session", u"v4-session-table-buckets"]
630 self.add_config_item(self._nodeconfig, value, path)
632 def add_session_v4_session_table_memory(self, value):
633 """Add the size of v4 session table memory.
635 :param value: Size of v4 session table memory.
638 path = [u"session", u"v4-session-table-memory"]
639 self.add_config_item(self._nodeconfig, value, path)
641 def add_session_v4_halfopen_table_buckets(self, value):
642 """Add the number of v4 halfopen table buckets.
644 :param value: Number of v4 halfopen table buckets.
647 path = [u"session", u"v4-halfopen-table-buckets"]
648 self.add_config_item(self._nodeconfig, value, path)
650 def add_session_v4_halfopen_table_memory(self, value):
651 """Add the size of v4 halfopen table memory.
653 :param value: Size of v4 halfopen table memory.
656 path = [u"session", u"v4-halfopen-table-memory"]
657 self.add_config_item(self._nodeconfig, value, path)
659 def add_session_local_endpoints_table_buckets(self, value):
660 """Add the number of local endpoints table buckets.
662 :param value: Number of local endpoints table buckets.
665 path = [u"session", u"local-endpoints-table-buckets"]
666 self.add_config_item(self._nodeconfig, value, path)
668 def add_session_local_endpoints_table_memory(self, value):
669 """Add the size of local endpoints table memory.
671 :param value: Size of local endpoints table memory.
674 path = [u"session", u"local-endpoints-table-memory"]
675 self.add_config_item(self._nodeconfig, value, path)
677 def add_dma_dev(self, devices):
678 """Add DMA devices configuration.
680 :param devices: DMA devices or work queues.
683 for device in devices:
684 path = [u"dsa", f"dev {device}"]
685 self.add_config_item(self._nodeconfig, u"", path)
687 def write_config(self, filename=None):
688 """Generate and write VPP startup configuration to file.
690 Use data from calls to this class to form a startup.conf file and
691 replace /etc/vpp/startup.conf with it on topology node.
693 :param filename: Startup configuration file name.
696 self.dump_config(self._nodeconfig)
699 filename = self._vpp_startup_conf
701 cmd = f"echo \"{self._vpp_config}\" | sudo tee {filename}"
703 self._node, cmd, message=u"Writing config file failed!"
706 def apply_config(self, filename=None, verify_vpp=True):
707 """Generate and write VPP startup configuration to file and restart VPP.
709 Use data from calls to this class to form a startup.conf file and
710 replace /etc/vpp/startup.conf with it on topology node.
712 :param filename: Startup configuration file name.
713 :param verify_vpp: Verify VPP is running after restart.
715 :type verify_vpp: bool
717 self.write_config(filename=filename)
719 VPPUtil.restart_vpp_service(self._node, self._node_key)
721 VPPUtil.verify_vpp(self._node)
725 """VPP Initial Configuration."""
727 def init_vpp_startup_configuration_on_all_duts(nodes):
728 """Apply initial VPP startup configuration on all DUTs.
730 :param nodes: Nodes in the topology.
733 huge_size = Constants.DEFAULT_HUGEPAGE_SIZE
734 for node in nodes.values():
735 if node[u"type"] == NodeType.DUT:
736 vpp_config = VppConfigGenerator()
737 vpp_config.set_node(node)
738 vpp_config.add_unix_log()
739 vpp_config.add_unix_cli_listen()
740 vpp_config.add_unix_cli_no_pager()
741 vpp_config.add_unix_gid()
742 vpp_config.add_unix_coredump()
743 vpp_config.add_socksvr(socket=Constants.SOCKSVR_PATH)
744 vpp_config.add_main_heap_size("2G")
745 vpp_config.add_main_heap_page_size(huge_size)
746 vpp_config.add_default_hugepage_size(huge_size)
747 vpp_config.add_statseg_size("2G")
748 vpp_config.add_statseg_page_size(huge_size)
749 vpp_config.add_statseg_per_node_counters("on")
750 vpp_config.add_plugin("disable", "default")
751 vpp_config.add_plugin("enable", "dpdk_plugin.so")
752 vpp_config.add_dpdk_dev(
753 *[node["interfaces"][interface].get("pci_address") \
754 for interface in node[u"interfaces"]]
756 vpp_config.add_ip6_hash_buckets(2000000)
757 vpp_config.add_ip6_heap_size("4G")
758 vpp_config.apply_config()