resources/libraries/python/VppConfigGenerator.py

   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:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   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.
  13
  14 """VPP Configuration File Generator library."""
  15
  16 import re
  17
  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
  23
  24 __all__ = ["VppConfigGenerator", "VppInitConfig"]
  25
  26
  27 def pci_dev_check(pci_dev):
  28     """Check if provided PCI address is in correct format.
  29
  30     :param pci_dev: PCI address (expected format: xxxx:xx:xx.x).
  31     :type pci_dev: str
  32     :returns: True if PCI address is in correct format.
  33     :rtype: bool
  34     :raises ValueError: If PCI address is in incorrect format.
  35     """
  36     pattern = re.compile(
  37         r"^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}\.[0-9A-Fa-f]$"
  38     )
  39     if not re.match(pattern, pci_dev):
  40         raise ValueError(
  41             f"PCI address {pci_dev} is not in valid format xxxx:xx:xx.x"
  42         )
  43     return True
  44
  45
  46 class VppConfigGenerator:
  47     """VPP Configuration File Generator."""
  48
  49     def __init__(self):
  50         """Initialize library."""
  51         # VPP Node to apply configuration on
  52         self._node = ""
  53         # Topology node key
  54         self._node_key = ""
  55         # VPP Configuration
  56         self._nodeconfig = dict()
  57         # Serialized VPP Configuration
  58         self._vpp_config = ""
  59         # VPP Service name
  60         self._vpp_service_name = "vpp"
  61         # VPP Startup config location
  62         self._vpp_startup_conf = "/etc/vpp/startup.conf"
  63
  64     def set_node(self, node, node_key=None):
  65         """Set DUT node.
  66
  67         :param node: Node to store configuration on.
  68         :param node_key: Topology node key.
  69         :type node: dict
  70         :type node_key: str
  71         :raises RuntimeError: If Node type is not DUT.
  72         """
  73         if node["type"] != NodeType.DUT:
  74             raise RuntimeError(
  75                 "Startup config can only be applied to DUTnode."
  76             )
  77         self._node = node
  78         self._node_key = node_key
  79
  80     def get_config_str(self):
  81         """Get dumped startup configuration in VPP config format.
  82
  83         :returns: Startup configuration in VPP config format.
  84         :rtype: str
  85         """
  86         self.dump_config(self._nodeconfig)
  87         return self._vpp_config
  88
  89     def add_config_item(self, config, value, path):
  90         """Add startup configuration item.
  91
  92         :param config: Startup configuration of node.
  93         :param value: Value to insert.
  94         :param path: Path where to insert item.
  95         :type config: dict
  96         :type value: str
  97         :type path: list
  98         """
  99         if len(path) == 1:
 100             config[path[0]] = value
 101             return
 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:])
 108
 109     def dump_config(self, obj, level=-1):
 110         """Dump the startup configuration in VPP config format.
 111
 112         :param obj: Python Object to print.
 113         :param level: Nested level for indentation.
 114         :type obj: Obj
 115         :type level: int
 116         :returns: nothing
 117         """
 118         indent = "  "
 119         if level >= 0:
 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)
 126                 else:
 127                     self._vpp_config += f"{(level + 1) * indent}{key} {val}\n"
 128         else:
 129             for val in obj:
 130                 self._vpp_config += f"{(level + 1) * indent}{val}\n"
 131         if level >= 0:
 132             self._vpp_config += f"{level * indent}}}\n"
 133
 134     def add_unix_log(self, value="/var/log/vpp/vpp.log"):
 135         """Add UNIX log configuration.
 136
 137         :param value: Log file.
 138         :type value: str
 139         """
 140         path = ["unix", "log"]
 141         self.add_config_item(self._nodeconfig, value, path)
 142
 143     def add_unix_cli_listen(self, value="/run/vpp/cli.sock"):
 144         """Add UNIX cli-listen configuration.
 145
 146         :param value: CLI listen address and port or path to CLI socket.
 147         :type value: str
 148         """
 149         path = ["unix", "cli-listen"]
 150         self.add_config_item(self._nodeconfig, value, path)
 151
 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)
 156
 157     def add_unix_gid(self, value="vpp"):
 158         """Add UNIX gid configuration.
 159
 160         :param value: Gid.
 161         :type value: str
 162         """
 163         path = ["unix", "gid"]
 164         self.add_config_item(self._nodeconfig, value, path)
 165
 166     def add_unix_nodaemon(self):
 167         """Add UNIX nodaemon configuration."""
 168         path = ["unix", "nodaemon"]
 169         self.add_config_item(self._nodeconfig, "", path)
 170
 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)
 175
 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)
 180
 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)
 185
 186     def add_graph_node_variant(self, variant=Constants.GRAPH_NODE_VARIANT):
 187         """Add default graph node variant.
 188
 189         :param value: Graph node variant default value.
 190         :type value: str
 191         """
 192         if variant == "":
 193             return
 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)
 199
 200     def add_api_segment_gid(self, value="vpp"):
 201         """Add api-segment gid configuration.
 202
 203         :param value: Gid.
 204         :type value: str
 205         """
 206         path = ["api-segment", "gid"]
 207         self.add_config_item(self._nodeconfig, value, path)
 208
 209     def add_api_segment_global_size(self, value):
 210         """Add api-segment global-size configuration.
 211
 212         :param value: Global size.
 213         :type value: str
 214         """
 215         path = ["api-segment", "global-size"]
 216         self.add_config_item(self._nodeconfig, value, path)
 217
 218     def add_api_segment_prefix(self, value="vpp"):
 219         """Add api-segment prefix configuration.
 220
 221         :param value: Gid.
 222         :type value: str
 223         """
 224         path = ["api-segment", "prefix"]
 225         self.add_config_item(self._nodeconfig, value, path)
 226
 227     def add_api_segment_api_size(self, value):
 228         """Add api-segment api-size configuration.
 229
 230         :param value: API size.
 231         :type value: str
 232         """
 233         path = ["api-segment", "api-size"]
 234         self.add_config_item(self._nodeconfig, value, path)
 235
 236     def add_buffers_per_numa(self, value):
 237         """Increase number of buffers allocated.
 238
 239         :param value: Number of buffers allocated.
 240         :type value: int
 241         """
 242         path = ["buffers", "buffers-per-numa"]
 243         self.add_config_item(self._nodeconfig, value, path)
 244
 245     def add_buffers_default_data_size(self, value):
 246         """Increase buffers data-size allocated.
 247
 248         :param value: Buffers data-size allocated.
 249         :type value: int
 250         """
 251         path = ["buffers", "default data-size"]
 252         self.add_config_item(self._nodeconfig, value, path)
 253
 254     def add_dpdk_dev(self, *devices):
 255         """Add DPDK PCI device configuration.
 256
 257         :param devices: PCI device(s) (format xxxx:xx:xx.x)
 258         :type devices: tuple
 259         """
 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)
 264
 265     def add_dpdk_cryptodev(self, count, num_rx_queues=1):
 266         """Add DPDK Crypto PCI device configuration.
 267
 268         :param count: Number of HW crypto devices to add.
 269         :param num_rx_queues: Number of RX queues per QAT interface.
 270         :type count: int
 271         :type num_rx_queues: int
 272         """
 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")
 282
 283     def add_dpdk_sw_cryptodev(self, sw_pmd_type, socket_id, count):
 284         """Add DPDK SW Crypto device configuration.
 285
 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
 290         :type socket_id: int
 291         :type count: int
 292         """
 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)
 298
 299     def add_dpdk_dev_default_rxq(self, value):
 300         """Add DPDK dev default rxq configuration.
 301
 302         :param value: Default number of rxqs.
 303         :type value: str
 304         """
 305         path = ["dpdk", "dev default", "num-rx-queues"]
 306         self.add_config_item(self._nodeconfig, value, path)
 307
 308     def add_dpdk_dev_default_txq(self, value):
 309         """Add DPDK dev default txq configuration.
 310
 311         :param value: Default number of txqs.
 312         :type value: str
 313         """
 314         path = ["dpdk", "dev default", "num-tx-queues"]
 315         self.add_config_item(self._nodeconfig, value, path)
 316
 317     def add_dpdk_dev_default_rxd(self, value):
 318         """Add DPDK dev default rxd configuration.
 319
 320         :param value: Default number of rxds.
 321         :type value: str
 322         """
 323         path = ["dpdk", "dev default", "num-rx-desc"]
 324         self.add_config_item(self._nodeconfig, value, path)
 325
 326     def add_dpdk_dev_default_txd(self, value):
 327         """Add DPDK dev default txd configuration.
 328
 329         :param value: Default number of txds.
 330         :type value: str
 331         """
 332         path = ["dpdk", "dev default", "num-tx-desc"]
 333         self.add_config_item(self._nodeconfig, value, path)
 334
 335     def add_dpdk_dev_default_tso(self):
 336         """Add DPDK dev default tso configuration."""
 337         path = [u"dpdk", u"dev default", u"tso"]
 338         self.add_config_item(self._nodeconfig, "on", path)
 339
 340     def add_dpdk_log_level(self, value):
 341         """Add DPDK log-level configuration.
 342
 343         :param value: Log level.
 344         :type value: str
 345         """
 346         path = ["dpdk", "log-level"]
 347         self.add_config_item(self._nodeconfig, value, path)
 348
 349     def add_dpdk_no_pci(self):
 350         """Add DPDK no-pci."""
 351         path = ["dpdk", "no-pci"]
 352         self.add_config_item(self._nodeconfig, "", path)
 353
 354     def add_dpdk_uio_driver(self, value=None):
 355         """Add DPDK uio-driver configuration.
 356
 357         :param value: DPDK uio-driver configuration. By default, driver will be
 358             loaded automatically from Topology file, still leaving option
 359             to manually override by parameter.
 360         :type value: str
 361         """
 362         if value is None:
 363             value = Topology.get_uio_driver(self._node)
 364         path = ["dpdk", "uio-driver"]
 365         self.add_config_item(self._nodeconfig, value, path)
 366
 367     def add_dpdk_max_simd_bitwidth(self, variant=Constants.GRAPH_NODE_VARIANT):
 368         """Add DPDK max-simd-bitwidth configuration.
 369
 370         :param value: Graph node variant default value.
 371         :type value: str
 372         """
 373         if variant == "icl":
 374             value = 512
 375         elif variant in ["skx", "hsw"]:
 376             value = 256
 377         else:
 378             return
 379
 380         path = ["dpdk", "max-simd-bitwidth"]
 381         self.add_config_item(self._nodeconfig, value, path)
 382
 383     def add_dpdk_enable_tcp_udp_checksum(self):
 384         """Add DPDK enable-tcp-udp-checksum configuration."""
 385         path = [u"dpdk", u"enable-tcp-udp-checksum"]
 386         self.add_config_item(self._nodeconfig, u"", path)
 387
 388     def add_cpu_main_core(self, value):
 389         """Add CPU main core configuration.
 390
 391         :param value: Main core option.
 392         :type value: str
 393         """
 394         path = ["cpu", "main-core"]
 395         self.add_config_item(self._nodeconfig, value, path)
 396
 397     def add_cpu_corelist_workers(self, value):
 398         """Add CPU corelist-workers configuration.
 399
 400         :param value: Corelist-workers option.
 401         :type value: str
 402         """
 403         path = ["cpu", "corelist-workers"]
 404         self.add_config_item(self._nodeconfig, value, path)
 405
 406     def add_main_heap_size(self, value):
 407         """Add Main Heap Size configuration.
 408
 409         :param value: Amount of heap.
 410         :type value: str
 411         """
 412         path = ["memory", "main-heap-size"]
 413         self.add_config_item(self._nodeconfig, value, path)
 414
 415     def add_main_heap_page_size(self, value):
 416         """Add Main Heap Page Size configuration.
 417
 418         :param value: Heap page size.
 419         :type value: str
 420         """
 421         path = ["memory", "main-heap-page-size"]
 422         self.add_config_item(self._nodeconfig, value, path)
 423
 424     def add_default_hugepage_size(self, value=Constants.DEFAULT_HUGEPAGE_SIZE):
 425         """Add Default Hugepage Size configuration.
 426
 427         :param value: Hugepage size.
 428         :type value: str
 429         """
 430         path = ["memory", "default-hugepage-size"]
 431         self.add_config_item(self._nodeconfig, value, path)
 432
 433     def add_api_trace(self):
 434         """Add API trace configuration."""
 435         path = ["api-trace", "on"]
 436         self.add_config_item(self._nodeconfig, "", path)
 437
 438     def add_ip6_hash_buckets(self, value):
 439         """Add IP6 hash buckets configuration.
 440
 441         :param value: Number of IP6 hash buckets.
 442         :type value: str
 443         """
 444         path = ["ip6", "hash-buckets"]
 445         self.add_config_item(self._nodeconfig, value, path)
 446
 447     def add_ip6_heap_size(self, value):
 448         """Add IP6 heap-size configuration.
 449
 450         :param value: IP6 Heapsize amount.
 451         :type value: str
 452         """
 453         path = ["ip6", "heap-size"]
 454         self.add_config_item(self._nodeconfig, value, path)
 455
 456     def add_ipsec_spd_flow_cache_ipv4_inbound(self, value):
 457         """Add IPsec spd flow cache for IP4 inbound.
 458
 459         :param value: "on" to enable spd flow cache.
 460         :type value: str
 461         """
 462         path = ["ipsec", "ipv4-inbound-spd-flow-cache"]
 463         self.add_config_item(self._nodeconfig, value, path)
 464
 465     def add_ipsec_spd_flow_cache_ipv4_outbound(self, value):
 466         """Add IPsec spd flow cache for IP4 outbound.
 467
 468         :param value: "on" to enable spd flow cache.
 469         :type value: str
 470         """
 471         path = ["ipsec", "ipv4-outbound-spd-flow-cache"]
 472         self.add_config_item(self._nodeconfig, value, path)
 473
 474     def add_ipsec_spd_fast_path_ipv4_inbound(self, value):
 475         """Add IPsec spd fast path for IP4 inbound.
 476
 477         :param value: "on" to enable spd fast path.
 478         :type value: str
 479         """
 480         path = [u"ipsec", u"ipv4-inbound-spd-fast-path"]
 481         self.add_config_item(self._nodeconfig, value, path)
 482
 483     def add_ipsec_spd_fast_path_ipv4_outbound(self, value):
 484         """Add IPsec spd fast path for IP4 outbound.
 485
 486         :param value: "on" to enable spd fast path.
 487         :type value: str
 488         """
 489         path = ["ipsec", "ipv4-outbound-spd-fast-path"]
 490         self.add_config_item(self._nodeconfig, value, path)
 491
 492     def add_ipsec_spd_fast_path_num_buckets(self, value):
 493         """Add num buckets for IPsec spd fast path.
 494
 495         :param value: Number of buckets.
 496         :type value: int
 497         """
 498         path = ["ipsec", "spd-fast-path-num-buckets"]
 499         self.add_config_item(self._nodeconfig, value, path)
 500
 501     def add_statseg_size(self, value):
 502         """Add Stats Heap Size configuration.
 503
 504         :param value: Stats heapsize amount.
 505         :type value: str
 506         """
 507         path = ["statseg", "size"]
 508         self.add_config_item(self._nodeconfig, value, path)
 509
 510     def add_statseg_page_size(self, value):
 511         """Add Stats Heap Page Size configuration.
 512
 513         :param value: Stats heapsize amount.
 514         :type value: str
 515         """
 516         path = ["statseg", "page-size"]
 517         self.add_config_item(self._nodeconfig, value, path)
 518
 519     def add_statseg_per_node_counters(self, value):
 520         """Add stats per-node-counters configuration.
 521
 522         :param value: "on" to switch the counters on.
 523         :type value: str
 524         """
 525         path = ["statseg", "per-node-counters"]
 526         self.add_config_item(self._nodeconfig, value, path)
 527
 528     def add_plugin(self, state, *plugins):
 529         """Add plugin section for specific plugin(s).
 530
 531         :param state: State of plugin [enable|disable].
 532         :param plugins: Plugin(s) to disable.
 533         :type state: str
 534         :type plugins: list
 535         """
 536         for plugin in plugins:
 537             path = ["plugins", f"plugin {plugin}", state]
 538             self.add_config_item(self._nodeconfig, " ", path)
 539
 540     def add_dpdk_no_multi_seg(self):
 541         """Add DPDK no-multi-seg configuration."""
 542         path = ["dpdk", "no-multi-seg"]
 543         self.add_config_item(self._nodeconfig, "", path)
 544
 545     def add_dpdk_no_tx_checksum_offload(self):
 546         """Add DPDK no-tx-checksum-offload configuration."""
 547         path = ["dpdk", "no-tx-checksum-offload"]
 548         self.add_config_item(self._nodeconfig, "", path)
 549
 550     def add_nat(self, value="deterministic"):
 551         """Add NAT mode configuration.
 552
 553         :param value: NAT mode.
 554         :type value: str
 555         """
 556         path = ["nat", value]
 557         self.add_config_item(self._nodeconfig, "", path)
 558
 559     def add_nat_max_translations_per_thread(self, value):
 560         """Add NAT max. translations per thread number configuration.
 561
 562         :param value: NAT mode.
 563         :type value: str
 564         """
 565         path = ["nat", "max translations per thread"]
 566         self.add_config_item(self._nodeconfig, value, path)
 567
 568     def add_nsim_poll_main_thread(self):
 569         """Add NSIM poll-main-thread configuration."""
 570         path = ["nsim", "poll-main-thread"]
 571         self.add_config_item(self._nodeconfig, "", path)
 572
 573     def add_tcp_congestion_control_algorithm(self, value="cubic"):
 574         """Add TCP congestion control algorithm.
 575
 576         :param value: The congestion control algorithm to use. Example: cubic
 577         :type value: str
 578         """
 579         path = ["tcp", "cc-algo"]
 580         self.add_config_item(self._nodeconfig, value, path)
 581
 582     def add_tcp_preallocated_connections(self, value):
 583         """Add TCP pre-allocated connections.
 584
 585         :param value: The number of pre-allocated connections.
 586         :type value: int
 587         """
 588         path = ["tcp", "preallocated-connections"]
 589         self.add_config_item(self._nodeconfig, value, path)
 590
 591     def add_tcp_preallocated_half_open_connections(self, value):
 592         """Add TCP pre-allocated half open connections.
 593
 594         :param value: The number of pre-allocated half open connections.
 595         :type value: int
 596         """
 597         path = ["tcp", "preallocated-half-open-connections"]
 598         self.add_config_item(self._nodeconfig, value, path)
 599
 600     def add_tcp_tso(self):
 601         """Add TCP tso configuration."""
 602         path = [u"tcp", u"tso"]
 603         self.add_config_item(self._nodeconfig, u"", path)
 604
 605     def add_session_enable(self):
 606         """Add session enable."""
 607         path = ["session", "enable"]
 608         self.add_config_item(self._nodeconfig, "", path)
 609
 610     def add_session_app_socket_api(self):
 611         """Use session app socket api."""
 612         path = ["session", "use-app-socket-api"]
 613         self.add_config_item(self._nodeconfig, "", path)
 614
 615     def add_session_event_queues_memfd_segment(self):
 616         """Add session event queue memfd segment."""
 617         path = ["session", "evt_qs_memfd_seg"]
 618         self.add_config_item(self._nodeconfig, "", path)
 619
 620     def add_session_event_queue_length(self, value):
 621         """Add session event queue length.
 622
 623         :param value: Session event queue length.
 624         :type value: int
 625         """
 626         path = ["session", "event-queue-length"]
 627         self.add_config_item(self._nodeconfig, value, path)
 628
 629     def add_session_event_queues_segment_size(self, value):
 630         """Add session event queue length.
 631
 632         :param value: Session event queue segment size.
 633         :type value: str
 634         """
 635         path = ["session", "evt_qs_seg_size"]
 636         self.add_config_item(self._nodeconfig, value, path)
 637
 638     def add_session_preallocated_sessions(self, value):
 639         """Add the number of pre-allocated sessions.
 640
 641         :param value: Number of pre-allocated sessions.
 642         :type value: int
 643         """
 644         path = ["session", "preallocated-sessions"]
 645         self.add_config_item(self._nodeconfig, value, path)
 646
 647     def add_session_v4_session_table_buckets(self, value):
 648         """Add number of v4 session table buckets to the config.
 649
 650         :param value: Number of v4 session table buckets.
 651         :type value: int
 652         """
 653         path = ["session", "v4-session-table-buckets"]
 654         self.add_config_item(self._nodeconfig, value, path)
 655
 656     def add_session_v4_session_table_memory(self, value):
 657         """Add the size of v4 session table memory.
 658
 659         :param value: Size of v4 session table memory.
 660         :type value: str
 661         """
 662         path = ["session", "v4-session-table-memory"]
 663         self.add_config_item(self._nodeconfig, value, path)
 664
 665     def add_session_v4_halfopen_table_buckets(self, value):
 666         """Add the number of v4 halfopen table buckets.
 667
 668         :param value: Number of v4 halfopen table buckets.
 669         :type value: int
 670         """
 671         path = ["session", "v4-halfopen-table-buckets"]
 672         self.add_config_item(self._nodeconfig, value, path)
 673
 674     def add_session_v4_halfopen_table_memory(self, value):
 675         """Add the size of v4 halfopen table memory.
 676
 677         :param value: Size of v4 halfopen table memory.
 678         :type value: str
 679         """
 680         path = ["session", "v4-halfopen-table-memory"]
 681         self.add_config_item(self._nodeconfig, value, path)
 682
 683     def add_session_local_endpoints_table_buckets(self, value):
 684         """Add the number of local endpoints table buckets.
 685
 686         :param value: Number of local endpoints table buckets.
 687         :type value: int
 688         """
 689         path = ["session", "local-endpoints-table-buckets"]
 690         self.add_config_item(self._nodeconfig, value, path)
 691
 692     def add_session_local_endpoints_table_memory(self, value):
 693         """Add the size of local endpoints table memory.
 694
 695         :param value: Size of local endpoints table memory.
 696         :type value: str
 697         """
 698         path = ["session", "local-endpoints-table-memory"]
 699         self.add_config_item(self._nodeconfig, value, path)
 700
 701     def add_session_use_dma(self):
 702         """Add session use-dma configuration."""
 703         path = [u"session", u"use-dma"]
 704         self.add_config_item(self._nodeconfig, u"", path)
 705
 706     def add_dma_dev(self, devices):
 707         """Add DMA devices configuration.
 708
 709         :param devices: DMA devices or work queues.
 710         :type devices: list
 711         """
 712         for device in devices:
 713             path = ["dsa", f"dev {device}"]
 714             self.add_config_item(self._nodeconfig, "", path)
 715
 716     def add_logging_default_syslog_log_level(self, value="debug"):
 717         """Add default logging level for syslog.
 718
 719         :param value: Log level.
 720         :type value: str
 721         """
 722         path = ["logging", "default-syslog-log-level"]
 723         self.add_config_item(self._nodeconfig, value, path)
 724
 725     def write_config(self, filename=None):
 726         """Generate and write VPP startup configuration to file.
 727
 728         Use data from calls to this class to form a startup.conf file and
 729         replace /etc/vpp/startup.conf with it on topology node.
 730
 731         :param filename: Startup configuration file name.
 732         :type filename: str
 733         """
 734         self.dump_config(self._nodeconfig)
 735
 736         if filename is None:
 737             filename = self._vpp_startup_conf
 738
 739         cmd = f"echo \"{self._vpp_config}\" | sudo tee {filename}"
 740         exec_cmd_no_error(
 741             self._node, cmd, message="Writing config file failed!"
 742         )
 743
 744     def apply_config(self, filename=None, verify_vpp=True):
 745         """Generate and write VPP startup configuration to file and restart VPP.
 746
 747         Use data from calls to this class to form a startup.conf file and
 748         replace /etc/vpp/startup.conf with it on topology node.
 749
 750         :param filename: Startup configuration file name.
 751         :param verify_vpp: Verify VPP is running after restart.
 752         :type filename: str
 753         :type verify_vpp: bool
 754         """
 755         self.write_config(filename=filename)
 756
 757         VPPUtil.restart_vpp_service(self._node, self._node_key)
 758         if verify_vpp:
 759             VPPUtil.verify_vpp(self._node)
 760
 761
 762 class VppInitConfig:
 763     """VPP Initial Configuration."""
 764     @staticmethod
 765     def init_vpp_startup_configuration_on_all_duts(nodes):
 766         """Apply initial VPP startup configuration on all DUTs.
 767
 768         :param nodes: Nodes in the topology.
 769         :type nodes: dict
 770         """
 771         huge_size = Constants.DEFAULT_HUGEPAGE_SIZE
 772         for node in nodes.values():
 773             if node["type"] == NodeType.DUT:
 774                 vpp_config = VppConfigGenerator()
 775                 vpp_config.set_node(node)
 776                 vpp_config.add_unix_log()
 777                 vpp_config.add_unix_cli_listen()
 778                 vpp_config.add_unix_cli_no_pager()
 779                 vpp_config.add_unix_gid()
 780                 vpp_config.add_unix_coredump()
 781                 vpp_config.add_socksvr(socket=Constants.SOCKSVR_PATH)
 782                 vpp_config.add_main_heap_size("2G")
 783                 vpp_config.add_main_heap_page_size(huge_size)
 784                 vpp_config.add_default_hugepage_size(huge_size)
 785                 vpp_config.add_statseg_size("2G")
 786                 vpp_config.add_statseg_page_size(huge_size)
 787                 vpp_config.add_statseg_per_node_counters("on")
 788                 vpp_config.add_plugin("disable", "default")
 789                 vpp_config.add_plugin("enable", "dpdk_plugin.so")
 790                 vpp_config.add_dpdk_dev(
 791                     *[node["interfaces"][interface].get("pci_address") \
 792                         for interface in node["interfaces"]]
 793                 )
 794                 vpp_config.add_ip6_hash_buckets(2000000)
 795                 vpp_config.add_ip6_heap_size("4G")
 796                 vpp_config.apply_config()