-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2019 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):
"""Utilities for DPDK."""
@staticmethod
- def dpdk_testpmd_start(node, **args):
- """Start DPDK testpmd app on VM node.
+ def get_eal_options(**kwargs):
+ """Create EAL parameters options (including -v).
- :param node: VM Node to start testpmd on.
- :param args: List of testpmd parameters.
- :type node: dict
- :type args: list
- :return: nothing
+ :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.
- eal_coremask = '-c {} '.format(args['eal_coremask'])\
- if args.get('eal_coremask', '') else ''
- # Set the number of memory channels to use.
- eal_mem_channels = '-n {} '.format(args['eal_mem_channels'])\
- if args.get('eal_mem_channels', '') else ''
- # Set the memory to allocate on specific sockets (comma separated).
- eal_socket_mem = '--socket-mem {} '.format(args['eal_socket_mem'])\
- if args.get('eal_socket_mem', '') else ''
+ 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.
- eal_driver = '-d /usr/lib/librte_pmd_virtio.so '
+ 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
+
+ @staticmethod
+ 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
- pmd_fwd_mode = '--forward-mode={} '.format(args['pmd_fwd_mode'])\
- if args.get('pmd_fwd_mode', '') else ''
+ options.add_equals_from_dict(
+ 'forward-mode', 'pmd_fwd_mode', kwargs, 'io')
# Set the number of packets per burst to N.
- pmd_burst = '--burst=64 '
+ options.add_equals('burst', 64)
# Set the number of descriptors in the TX rings to N.
- pmd_txd = '--txd=2048 '
+ options.add_equals_from_dict('txd', 'pmd_txd', kwargs, 1024)
# Set the number of descriptors in the RX rings to N.
- pmd_rxd = '--rxd=2048 '
- # Set the hexadecimal bitmask of TX queue flags.
- pmd_txqflags = '--txqflags=0xf00 '
+ 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.
- pmd_total_num_mbufs = '--total-num-mbufs=65536 '
- # Set the hexadecimal bitmask of the ports for forwarding.
- pmd_portmask = '--portmask=0x3 '
+ options.add_equals_from_dict('total-num-mbufs', 'pmd_num_mbufs', kwargs)
# Disable hardware VLAN.
- pmd_disable_hw_vlan = '--disable-hw-vlan '\
- if args.get('pmd_disable_hw_vlan', '') else ''
- # Disable RSS (Receive Side Scaling).
- pmd_disable_rss = '--disable-rss '\
- if args.get('pmd_disable_rss', '') else ''
- # Set the hexadecimal bitmask of the cores running forwarding. Master
- # lcore=0 is reserved, so highest bit is set to 0.
- pmd_coremask = '--coremask={} '.format(\
- hex(int(args['eal_coremask'], 0) & 0xFFFE))\
- if args.get('eal_coremask', '') else ''
+ 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.
- pmd_nb_cores = '--nb-cores={} '.format(\
- bin(int(args['eal_coremask'], 0) & 0xFFFE).count('1'))\
- if args.get('eal_coremask', '') else ''
- eal_options = '-v '\
- + eal_coremask\
- + eal_mem_channels\
- + eal_socket_mem\
- + eal_driver
- pmd_options = '-- '\
- + pmd_fwd_mode\
- + pmd_burst\
- + pmd_txd\
- + pmd_rxd\
- + pmd_txqflags\
- + pmd_total_num_mbufs\
- + pmd_portmask\
- + pmd_disable_hw_vlan\
- + pmd_disable_rss\
- + pmd_coremask\
- + pmd_nb_cores
- 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)
+ options.add_equals_from_dict('nb-cores', 'pmd_nb_cores', kwargs)
+ return options
+
+ @staticmethod
+ def get_testpmd_cmdline(**kwargs):
+ """Get DPDK testpmd command line arguments.
+
+ :param args: Key-value testpmd parameters.
+ :type args: dict
+ :returns: Command line string.
+ :rtype: OptionString
+ """
+ options = OptionString()
+ options.add('testpmd')
+ options.extend(DpdkUtil.get_eal_options(**kwargs))
+ options.add('--')
+ options.extend(DpdkUtil.get_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.
+ :type node: dict
+ :type kwargs: dict
+ """
+ cmd_options = OptionString()
+ cmd_options.add("/start-testpmd.sh")
+ cmd_options.extend(DpdkUtil.get_eal_options(**kwargs))
+ cmd_options.add('--')
+ cmd_options.extend(DpdkUtil.get_pmd_options(**kwargs))
+ exec_cmd_no_error(node, cmd_options, sudo=True, disconnect=True)
@staticmethod
def dpdk_testpmd_stop(node):
:param node: Node to stop testpmd on.
:type node: dict
- :return: nothing
+ :returns: nothing
"""
- ssh = SSH()
- ssh.connect(node)
- cmd = "/stop-testpmd.sh"
- exec_cmd_no_error(node, cmd, sudo=True)
- ssh.disconnect(node)
+ cmd = "/stop-testpmd.sh" # Completed string, simpler than OptionString.
+ exec_cmd_no_error(node, cmd, sudo=True, disconnect=True)
Code Review / csit.git / blobdiff