def get_eal_options(**kwargs):
"""Create EAL parameters options (including -v).
:param kwargs: Dict of testpmd parameters.
:type kwargs: dict
:returns: EAL parameters.
:rtype: OptionString
"""
options = OptionString(prefix='-')
options.add('v')
# Set the hexadecimal bitmask of the cores to run on.
options.add_with_value_from_dict('l', 'eal_corelist', kwargs)
# Set master core.
options.add_with_value('-master-lcore', '0')
# Load an external driver. Multiple -d options are allowed.
options.add_with_value_if_from_dict('d',
'/usr/lib/librte_pmd_virtio.so',
'eal_driver', kwargs, True)
options.add_if_from_dict('-in-memory', 'eal_in_memory', kwargs, False)
return options
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
def get_pmd_options(**kwargs):
"""Create PMD parameters options (without --).
:param kwargs: List of testpmd parameters.
:type kwargs: dict
:returns: PMD parameters.
:rtype: OptionString
"""
options = OptionString(prefix='--')
# Set the forwarding mode: io, mac, mac_retry, mac_swap, flowgen,
# rxonly, txonly, csum, icmpecho, ieee1588
options.add_equals_from_dict('forward-mode', 'pmd_fwd_mode', kwargs,
'io')
# Set the number of packets per burst to N.
options.add_equals('burst', 64)
# Set the number of descriptors in the TX rings to N.
options.add_equals_from_dict('txd', 'pmd_txd', kwargs, 1024)
# Set the number of descriptors in the RX rings to N.
options.add_equals_from_dict('rxd', 'pmd_rxd', kwargs, 1024)
# Set the number of queues in the TX to N.
options.add_equals_from_dict('txq', 'pmd_txq', kwargs, 1)
# Set the number of queues in the RX to N.
options.add_equals_from_dict('rxq', 'pmd_rxq', kwargs, 1)
# Set the hexadecimal bitmask of offloads.
options.add_equals_if_from_dict('txqflags', '0xf00', 'pmd_tx_offloads',
kwargs, True)
# Set the number of mbufs to be allocated in the mbuf pools.
options.add_equals_from_dict('total-num-mbufs', 'pmd_num_mbufs',
kwargs)
# Disable hardware VLAN.
options.add_if_from_dict('disable-hw-vlan', 'pmd_disable_hw_vlan',
kwargs, True)
# Set the MAC address XX:XX:XX:XX:XX:XX of the peer port N
options.add_equals_from_dict('eth-peer', 'pmd_eth_peer_0', kwargs)
options.add_equals_from_dict('eth-peer', 'pmd_eth_peer_1', kwargs)
# Set the max packet length.
options.add_equals_from_dict('max-pkt-len', 'pmd_max_pkt_len', kwargs)
# Set the number of forwarding cores based on coremask.
options.add_equals_from_dict('nb-cores', 'pmd_nb_cores', kwargs)
return options
def get_eal_options(**kwargs):
"""Create EAL parameters options (including -v).
:param kwargs: Dict of testpmd parameters.
:type kwargs: dict
:returns: EAL parameters.
:rtype: OptionString
"""
options = OptionString(prefix=u"-")
options.add(u"v")
# Set the hexadecimal bitmask of the cores to run on.
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.
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
def get_testpmd_pmd_options(**kwargs):
"""Create PMD parameters options for testpmd (without --).
: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
options.add_equals_from_dict(u"forward-mode", u"pmd_fwd_mode", kwargs,
u"io")
# Set the number of packets per burst to N.
options.add_equals(u"burst", 64)
# Set the number of descriptors in the TX rings to N.
options.add_equals_from_dict(u"txd", u"pmd_txd", kwargs, 1024)
# Set the number of descriptors in the RX rings to N.
options.add_equals_from_dict(u"rxd", u"pmd_rxd", kwargs, 1024)
# Set the number of queues in the TX to N.
options.add_equals_from_dict(u"txq", u"pmd_txq", kwargs, 1)
# Set the number of queues in the RX to N.
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.
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
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 max packet length.
options.add_equals_from_dict(u"mbuf-size", u"pmd_mbuf_size", kwargs)
# Set the number of forwarding cores based on coremask.
options.add_equals_from_dict(u"nb-cores", u"pmd_nb_cores", kwargs)
return options
def iperf3_cmdline(**kwargs):
"""Get iPerf3 server command line.
:param kwargs: List of iPerf3 server parameters.
:type kwargs: dict
:returns: iPerf3 server command line.
:rtype: OptionString
"""
cmd = OptionString()
if kwargs['namespace']:
cmd.add(f"ip netns exec {kwargs['namespace']}")
cmd.add(f"iperf3")
cmd_options = OptionString(prefix=u"--")
# Run iPerf in server mode. (This will only allow one iperf connection
# at a time)
cmd_options.add(u"server")
# Run the server in background as a daemon.
cmd_options.add_if_from_dict(u"daemon", u"daemon", kwargs, True)
# Write a file with the process ID, most useful when running as a
# daemon.
cmd_options.add_with_value_from_dict(u"pidfile", u"pidfile", kwargs,
f"/tmp/iperf3_server.pid")
# Send output to a log file.
cmd_options.add_with_value_from_dict(u"logfile", u"logfile", kwargs,
f"/tmp/iperf3.log")
# The server port for the server to listen on and the client to
# connect to. This should be the same in both client and server.
# Default is 5201.
cmd_options.add_with_value_from_dict(u"port", u"port", kwargs, 5201)
# Set the CPU affinity, if possible (Linux and FreeBSD only).
cmd_options.add_with_value_from_dict(u"affinity", u"affinity", kwargs)
# Output in JSON format.
cmd_options.add_if_from_dict(u"json", u"json", kwargs, True)
# Give more detailed output.
cmd_options.add_if_from_dict(u"verbose", u"verbose", kwargs, True)
return cmd.extend(cmd_options)
def iperf3_cmdline(**kwargs):
"""Get iperf_client driver command line.
:param kwargs: List of iperf_client driver parameters.
:type kwargs: dict
:returns: iperf_client driver command line.
:rtype: OptionString
"""
cmd = OptionString()
cmd.add(u"python3")
dirname = f"{Constants.REMOTE_FW_DIR}/resources/tools/iperf"
cmd.add(f"'{dirname}/iperf_client.py'")
cmd_options = OptionString(prefix=u"--")
# Namespace to execute iPerf3 client on.
cmd_options.add_with_value_from_dict(u"namespace", u"namespace",
kwargs)
# Client connecting to an iPerf3 server running on host.
cmd_options.add_with_value_from_dict(u"host", u"host", kwargs)
# Client bind IP address.
cmd_options.add_with_value_from_dict(u"bind", u"bind", kwargs)
# Use UDP rather than TCP.
cmd_options.add_if_from_dict(u"udp", u"udp", kwargs, False)
# Set the CPU affinity, if possible.
cmd_options.add_with_value_from_dict(u"affinity", u"affinity", kwargs)
# Time expressed in seconds for how long to send traffic.
cmd_options.add_with_value_from_dict(u"duration", u"duration", kwargs)
# Send bi- (2) or uni- (1) directional traffic.
cmd_options.add_with_value_from_dict(u"traffic_directions",
u"traffic_directions", kwargs, 1)
# Traffic warm-up time in seconds, (0=disable).
cmd_options.add_with_value_from_dict(u"warmup_time", u"warmup_time",
kwargs, 5.0)
# L2 frame size to send (without padding and IPG).
cmd_options.add_with_value_from_dict(u"frame_size", u"frame_size",
kwargs)
# Traffic rate expressed with units.
cmd_options.add_with_value_from_dict(u"rate", u"rate", kwargs)
# If enabled then don't wait for all incoming traffic.
cmd_options.add_if_from_dict(u"async_start", u"async_call", kwargs,
False)
# Number of iPerf3 client parallel instances.
cmd_options.add_with_value_from_dict(u"instances", u"instances",
kwargs, 1)
# Number of iPerf3 client parallel flows.
cmd_options.add_with_value_from_dict(u"parallel", u"parallel", kwargs,
8)
return cmd.extend(cmd_options)
