-# Copyright (c) 2019 Cisco and/or its affiliates.
+# Copyright (c) 2021 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
"""Dpdk Utilities Library."""
-from resources.libraries.python.ssh import SSH, exec_cmd_no_error
+from resources.libraries.python.OptionString import OptionString
+from resources.libraries.python.ssh import exec_cmd_no_error
-class DpdkUtil(object):
+class DpdkUtil:
"""Utilities for DPDK."""
@staticmethod
- def get_eal_options(**args):
- """Create EAL parameters string.
+ def get_eal_options(**kwargs):
+ """Create EAL parameters options (including -v).
- :param args: List of testpmd parameters.
- :type args: dict
- :returns: EAL parameters string.
- :rtype: str
+ :param kwargs: Dict of testpmd parameters.
+ :type kwargs: dict
+ :returns: EAL parameters.
+ :rtype: OptionString
"""
- eal_version = '-v'
+ options = OptionString(prefix=u"-")
+ options.add(u"v")
# Set the hexadecimal bitmask of the cores to run on.
- eal_corelist = '-l {}'.format(
- args.get('eal_corelist', ''))\
- if args.get('eal_corelist', '') else ''
- # Set master core.
- eal_master_core = '--master-lcore 0'
+ options.add_with_value_from_dict(
+ u"l", u"eal_corelist", kwargs
+ )
+ # Add a PCI device in white list.
+ options.add_with_value_from_dict(
+ u"a", u"eal_pci_whitelist0", kwargs
+ )
+ options.add_with_value_from_dict(
+ u"a", u"eal_pci_whitelist1", kwargs
+ )
# Load an external driver. Multiple -d options are allowed.
- eal_driver = '-d /usr/lib/librte_pmd_virtio.so'\
- if args.get('eal_driver', True) else ''
- # Run in memory.
- eal_in_memory = '--in-memory'\
- if args.get('eal_in_memory', False) else ''
-
- return ' '.join([eal_version,
- eal_corelist,
- eal_master_core,
- eal_driver,
- eal_in_memory])
+ options.add_with_value_if_from_dict(
+ u"d", u"/usr/lib/librte_pmd_virtio.so", u"eal_driver", kwargs, True
+ )
+ options.add_if_from_dict(
+ u"-in-memory", u"eal_in_memory", kwargs, False
+ )
+ return options
@staticmethod
- def get_pmd_options(**args):
- """Create PMD parameters string.
+ def get_testpmd_pmd_options(**kwargs):
+ """Create PMD parameters options for testpmd (without --).
- :param args: List of testpmd parameters.
- :type args: dict
- :returns: PMD parameters string.
- :rtype: str
+ :param kwargs: List of testpmd parameters.
+ :type kwargs: dict
+ :returns: PMD parameters.
+ :rtype: OptionString
"""
+ options = OptionString(prefix=u"--")
# Set the forwarding mode: io, mac, mac_retry, mac_swap, flowgen,
# rxonly, txonly, csum, icmpecho, ieee1588
- pmd_fwd_mode = '--forward-mode={}'.format(
- args.get('pmd_fwd_mode', 'io')) \
- if args.get('pmd_fwd_mode', 'io') else ''
+ options.add_equals_from_dict(
+ u"forward-mode", u"pmd_fwd_mode", kwargs, u"io"
+ )
# Set the number of packets per burst to N.
- pmd_burst = '--burst=64'
+ options.add_equals(
+ u"burst", 64
+ )
# Set the number of descriptors in the TX rings to N.
- pmd_txd = '--txd={}'.format(
- args.get('pmd_txd', '1024')) \
- if args.get('pmd_txd', '1024') else ''
+ options.add_equals_from_dict(
+ u"txd", u"pmd_txd", kwargs, 1024
+ )
# Set the number of descriptors in the RX rings to N.
- pmd_rxd = '--rxd={}'.format(
- args.get('pmd_rxd', '1024')) \
- if args.get('pmd_rxd', '1024') else ''
+ options.add_equals_from_dict(
+ u"rxd", u"pmd_rxd", kwargs, 1024
+ )
# Set the number of queues in the TX to N.
- pmd_txq = '--txq={}'.format(
- args.get('pmd_txq', '1')) \
- if args.get('pmd_txq', '1') else ''
+ options.add_equals_from_dict(
+ u"txq", u"pmd_txq", kwargs, 1
+ )
# Set the number of queues in the RX to N.
- pmd_rxq = '--rxq={}'.format(
- args.get('pmd_rxq', '1')) \
- if args.get('pmd_rxq', '1') else ''
- # Set the hexadecimal bitmask of TX offloads.
- pmd_tx_offloads = '--txqflags=0xf00'\
- if args.get('pmd_tx_offloads', True) else ''
+ options.add_equals_from_dict(
+ u"rxq", u"pmd_rxq", kwargs, 1
+ )
+ # Set the hexadecimal bitmask of offloads.
+ options.add_equals_from_dict(
+ u"tx-offloads", u"pmd_tx_offloads", kwargs, u"0x0"
+ )
+ # Enables numa aware allocation of mbufs.
+ options.add_if_from_dict(
+ u"numa", u"pmd_numa", kwargs, True
+ )
+ # Run by default.
+ options.add_if_from_dict(
+ u"auto-start", u"pmd_auto_start", kwargs, True
+ )
# Set the number of mbufs to be allocated in the mbuf pools.
- pmd_total_num_mbufs = '--total-num-mbufs={}'.format(
- args.get('pmd_num_mbufs', '')) \
- if args.get('pmd_num_mbufs', '') else ''
- # Set the max packet length.
- pmd_max_pkt_len = '--max-pkt-len={}'.format(
- args.get("pmd_max_pkt_len", "")) \
- if args.get("pmd_max_pkt_len", "") else ""
- # Disable hardware VLAN.
- pmd_disable_hw_vlan = '--disable-hw-vlan'\
- if args.get('pmd_disable_hw_vlan', True) else ''
+ options.add_equals_from_dict(
+ u"total-num-mbufs", u"pmd_num_mbufs", kwargs
+ )
+ # Set the number of forwarding ports.
+ options.add_equals_from_dict(
+ u"nb-ports", u"pmd_nb_ports", kwargs
+ )
+ # Set the hexadecimal bitmask of the ports used by the packet
+ # forwarding test.
+ options.add_equals_from_dict(
+ u"portmask", u"pmd_portmask", kwargs
+ )
+ # Disable link status check.
+ options.add_if_from_dict(
+ u"disable-link-check", u"pmd_disable_link_check", kwargs, True
+ )
# Set the MAC address XX:XX:XX:XX:XX:XX of the peer port N
- pmd_eth_peer_0 = '--eth-peer={}'.format(
- args.get('pmd_eth_peer_0', ''))\
- if args.get('pmd_eth_peer_0', '') else ''
- pmd_eth_peer_1 = '--eth-peer={}'.format(
- args.get('pmd_eth_peer_1', ''))\
- if args.get('pmd_eth_peer_1', '') else ''
+ options.add_equals_from_dict(
+ u"eth-peer", u"pmd_eth_peer_0", kwargs
+ )
+ options.add_equals_from_dict(
+ u"eth-peer", u"pmd_eth_peer_1", kwargs
+ )
+ # Set the max packet length.
+ options.add_equals_from_dict(
+ u"max-pkt-len", u"pmd_max_pkt_len", kwargs
+ )
+ # Set the mbuf size.
+ options.add_equals_from_dict(
+ u"mbuf-size", u"pmd_mbuf_size", kwargs
+ )
# Set the number of forwarding cores based on coremask.
- pmd_nb_cores = '--nb-cores={}'.format(
- args.get('pmd_nb_cores', ''))\
- if args.get('pmd_nb_cores', '') else ''
-
- return ' '.join([pmd_fwd_mode,
- pmd_burst,
- pmd_txd,
- pmd_rxd,
- pmd_txq,
- pmd_rxq,
- pmd_tx_offloads,
- pmd_total_num_mbufs,
- pmd_disable_hw_vlan,
- pmd_eth_peer_0,
- pmd_eth_peer_1,
- pmd_max_pkt_len,
- pmd_nb_cores])
+ options.add_equals_from_dict(
+ u"nb-cores", u"pmd_nb_cores", kwargs
+ )
+ return options
@staticmethod
- def get_testpmd_cmdline(**kwargs):
+ def get_testpmd_args(**kwargs):
"""Get DPDK testpmd command line arguments.
- :param args: Key-value testpmd parameters.
- :type args: dict
+ :param kwargs: Key-value testpmd parameters.
+ :type kwargs: dict
:returns: Command line string.
- :rtype: str
+ :rtype: OptionString
"""
- eal_options = DpdkUtil.get_eal_options(**kwargs)
- pmd_options = DpdkUtil.get_pmd_options(**kwargs)
+ options = OptionString()
+ options.extend(DpdkUtil.get_eal_options(**kwargs))
+ options.add(u"--")
+ options.extend(DpdkUtil.get_testpmd_pmd_options(**kwargs))
+ return options
+
+ @staticmethod
+ def get_testpmd_cmdline(**kwargs):
+ """Get DPDK testpmd command line arguments with testpmd command.
- return 'testpmd {0} -- {1}'.format(eal_options, pmd_options)
+ :param kwargs: Key-value testpmd parameters.
+ :type kwargs: dict
+ :returns: Command line string.
+ :rtype: OptionString
+ """
+ options = OptionString()
+ options.add(u"dpdk-testpmd")
+ options.extend(DpdkUtil.get_eal_options(**kwargs))
+ options.add(u"--")
+ options.extend(DpdkUtil.get_testpmd_pmd_options(**kwargs))
+ return options
@staticmethod
def dpdk_testpmd_start(node, **kwargs):
"""Start DPDK testpmd app on VM node.
:param node: VM Node to start testpmd on.
- :param args: Key-value testpmd parameters.
+ :param kwargs: Key-value testpmd parameters.
:type node: dict
- :type args: dict
- :returns: nothing
+ :type kwargs: dict
"""
- eal_options = DpdkUtil.get_eal_options(**kwargs)
- pmd_options = DpdkUtil.get_pmd_options(**kwargs)
-
- ssh = SSH()
- ssh.connect(node)
- cmd = "/start-testpmd.sh {0} -- {1}".format(eal_options, pmd_options)
- exec_cmd_no_error(node, cmd, sudo=True)
- ssh.disconnect(node)
+ cmd_options = OptionString()
+ cmd_options.add(u"/start-testpmd.sh")
+ cmd_options.extend(DpdkUtil.get_eal_options(**kwargs))
+ cmd_options.add(u"--")
+ cmd_options.extend(DpdkUtil.get_testpmd_pmd_options(**kwargs))
+ exec_cmd_no_error(node, cmd_options, sudo=True, disconnect=True)
@staticmethod
def dpdk_testpmd_stop(node):
:type node: dict
:returns: nothing
"""
- ssh = SSH()
- ssh.connect(node)
- cmd = "/stop-testpmd.sh"
- exec_cmd_no_error(node, cmd, sudo=True)
- ssh.disconnect(node)
+ cmd = u"/stop-testpmd.sh" # Completed string, simple one.
+ exec_cmd_no_error(node, cmd, sudo=True, disconnect=True)
+
+ @staticmethod
+ def get_l3fwd_pmd_options(**kwargs):
+ """Create PMD parameters options for l3fwd (without --).
+
+ :param kwargs: List of l3fwd parameters.
+ :type kwargs: dict
+ :returns: PMD parameters.
+ :rtype: OptionString
+ """
+ options = OptionString(prefix=u"--")
+ # Set to use software to analyze packet type.
+ options.add_if_from_dict(
+ u"parse-ptype", u"pmd_parse_ptype", kwargs, True
+ )
+ # Set the MAC address XX:XX:XX:XX:XX:XX of the peer port N.
+ options.add_equals_from_dict(
+ u"eth-dest", u"pmd_eth_dest_0", kwargs
+ )
+ options.add_equals_from_dict(
+ u"eth-dest", u"pmd_eth_dest_1", kwargs
+ )
+ # Determines which queues from which ports are mapped to which cores.
+ options.add_equals_from_dict(
+ u"config", u"pmd_config", kwargs
+ )
+ # Set the max packet length.
+ options.add_with_value_if_from_dict(
+ u"max-pkt-len", u"9200", u"pmd_max_pkt_len", kwargs, False
+ )
+ return options
+
+ @staticmethod
+ def get_l3fwd_args(**kwargs):
+ """Get DPDK l3fwd command line arguments.
+
+ :param kwargs: Key-value l3fwd parameters.
+ :type kwargs: dict
+ :returns: Command line string.
+ :rtype: OptionString
+ """
+ options = OptionString()
+ options.extend(DpdkUtil.get_eal_options(**kwargs))
+ options.add(u"--")
+ options.extend(DpdkUtil.get_l3fwd_pmd_options(**kwargs))
+ return options